feat: Added WPP.privacy.setAbout function

src/privacy/functions/setAbout.ts

@@ -0,0 +1,87 @@
+/*!
+ * Copyright 2024 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Set who can see your about.
+ *
+ * @example
+ * ```javascript
+ * Set value for who can see your about like 'all'
+ * await WPP.privacy.setAbout('all');
+ *
+ * Set value for who can see your about  like 'none'
+ * await WPP.privacy.setAbout('none');
+ *
+ * Set value for who can see your about like 'only your contacts'
+ * await WPP.privacy.setAbout('contacts');
+ *
+ * Set value for who can see your about like 'your contacts', but with excepts
+ * await WPP.privacy.setAbout('contact_blacklist', [
+ *   { id: '[number]@c.us', action: 'add' },
+ *   { id: '[number]@c.us', action: 'remove' }
+ * ]);
+ * ```
+ *
+ * @category Privacy
+ */
+
+import { WPPError } from '../../util';
+import {
+  getUserPrivacySettings,
+  PrivacyDisallowedListType,
+  setPrivacyForOneCategory,
+} from '../../whatsapp/functions';
+import { prepareDisallowedList } from './prepareDisallowedList';
+
+export enum setAboutTypes {
+  all = 'all',
+  contacts = 'contacts',
+  none = 'none',
+  contact_blacklist = 'contact_blacklist',
+}
+export async function setAbout(
+  value: setAboutTypes,
+  disallowedList?: { id: string; action: 'add' | 'remove' }[]
+): Promise<setAboutTypes> {
+  if (
+    typeof value !== 'string' ||
+    !Object.values(setAboutTypes).includes(value)
+  ) {
+    throw new WPPError(
+      'incorrect_type',
+      `Incorrect type ${value || '<empty>'} for set about privacy`,
+      {
+        value,
+      }
+    );
+  }
+  const disallowed = await prepareDisallowedList(
+    PrivacyDisallowedListType.About,
+    value,
+    disallowedList
+  );
+  await setPrivacyForOneCategory(
+    {
+      name: PrivacyDisallowedListType.About,
+      value: value,
+      dhash: value === 'contact_blacklist' ? disallowed.dhash : null,
+      users:
+        value === 'contact_blacklist' ? disallowed.idsFormatted : undefined,
+    },
+    value === 'contact_blacklist' ? disallowed.allUsers : undefined
+  );
+  return getUserPrivacySettings().about as any;
+}