talkyzap-wapp-api 1.0.0

package/dist/wppconnect-wa.js.LICENSE.txt

@@ -0,0 +1,90 @@
+/*!
+ * Compressor.js v1.2.1
+ * https://fengyuanchen.github.io/compressorjs
+ *
+ * Copyright 2018-present Chen Fengyuan
+ * Released under the MIT license
+ *
+ * Date: 2023-02-28T14:09:41.732Z
+ */
+
+/*!
+ * Copyright 2021 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.
+ */
+
+/*!
+ * Copyright 2022 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.
+ */
+
+/*!
+ * Copyright 2023 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.
+ */
+
+/*!
+ * 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.
+ */
+
+/*!
+ * EventEmitter2
+ * https://github.com/hij1nx/EventEmitter2
+ *
+ * Copyright (c) 2013 hij1nx
+ * Licensed under the MIT license.
+ */
+
+/*!
+ * The buffer module from node.js, for the browser.
+ *
+ * @author   Feross Aboukhadijeh <https://feross.org>
+ * @license  MIT
+ */
+
+/*! ieee754. BSD-3-Clause License. Feross Aboukhadijeh <https://feross.org/opensource> */

package/package.json

@@ -0,0 +1,91 @@
+{
+  "name": "talkyzap-wapp-api",
+  "version": "1.0.0",
+  "description": "WPPConnect/WA-JS is an open-source project with the aim of exporting functions from WhatsApp Web",
+  "license": "Apache-2.0",
+  "author": {
+    "name": "Edgard Messias",
+    "email": "edgardmessias@gmail.com",
+    "url": "https://github.com/edgardmessias"
+  },
+  "exports": {
+    ".": "./dist/wppconnect-wa.js"
+  },
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build:dev": "webpack --devtool inline-source-map --mode development",
+    "build:prd": "webpack",
+    "changelog:last": "conventional-changelog -p angular -r 2",
+    "changelog:preview": "conventional-changelog -p angular -u",
+    "changelog:update": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0",
+    "clean": "shx rm -rf dist",
+    "commit": "cz",
+    "docs:build": "npm run docs:clean && typedoc --gitRevision main",
+    "docs:clean": "shx rm -rf docs",
+    "launch:attach": "ts-node ./src/tools/launchAttach.ts",
+    "launch:local": "ts-node ./src/tools/launchLocal.ts",
+    "launch:protocol-log": "ts-node ./src/tools/launchProtocolLog.ts",
+    "lint": "npx eslint --ext .ts src",
+    "prepare": "husky install && npm run clean && npm run build:prd",
+    "release": "release-it",
+    "test": "playwright test --project tests",
+    "test:prepare": "playwright test --project prepare --headed",
+    "update-models-attributes": "ts-node ./src/tools/updateModelsAttributes.ts",
+    "update-module-id": "ts-node ./src/tools/updateModuleID.ts",
+    "wa-source": "npm run wa-source:clean && npm run wa-source:download",
+    "wa-source:clean": "shx rm -rf wa-source",
+    "wa-source:download": "ts-node ./src/tools/extractWhatsappSource.ts",
+    "wa-source:format": "prettier --write ./wa-source",
+    "watch": "webpack watch --devtool inline-source-map --mode development"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^19.2.1",
+    "@commitlint/config-conventional": "^19.1.0",
+    "@commitlint/prompt-cli": "^19.2.0",
+    "@playwright/test": "^1.42.1",
+    "@types/debug": "^4.1.12",
+    "@types/node": "^16.18.93",
+    "@types/node-fetch": "^2.6.11",
+    "@types/parse-data-url": "^3.0.2",
+    "@types/prettier": "^2.7.3",
+    "@types/shelljs": "^0.8.15",
+    "@typescript-eslint/eslint-plugin": "^7.4.0",
+    "@typescript-eslint/parser": "^7.4.0",
+    "@wppconnect/wa-version": "^1.4.27",
+    "buffer": "^6.0.3",
+    "compare-versions": "^6.1.0",
+    "compressorjs": "^1.2.1",
+    "conventional-changelog-angular": "^7.0.0",
+    "conventional-changelog-cli": "^4.1.0",
+    "debug": "^4.3.4",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-header": "^3.1.1",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-prettier": "^5.1.3",
+    "eslint-plugin-simple-import-sort": "^12.0.0",
+    "eventemitter2": "^6.4.9",
+    "file-type": "~16.5.4",
+    "husky": "^9.0.11",
+    "lint-staged": "^15.2.2",
+    "node-fetch": "^2.7.0",
+    "parse-data-url": "^6.0.0",
+    "playwright-chromium": "^1.42.1",
+    "prettier": "^3.2.5",
+    "release-it": "^17.1.1",
+    "shx": "^0.3.4",
+    "ts-loader": "^9.5.1",
+    "ts-morph": "^22.0.0",
+    "ts-node": "^10.9.2",
+    "typedoc": "^0.25.12",
+    "typedoc-plugin-mdn-links": "^3.1.19",
+    "typedoc-plugin-missing-exports": "^2.2.0",
+    "typescript": "^5.4.3",
+    "typescript-debounce-decorator": "^0.0.18",
+    "webpack": "^5.91.0",
+    "webpack-cli": "^5.1.4"
+  },
+  "engines": {
+    "whatsapp-web": ">=2.2326.10-beta"
+  }
+}

package/playwright.config.ts

@@ -0,0 +1,39 @@
+/*!
+ * Copyright 2021 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.
+ */
+
+import { devices, PlaywrightTestConfig } from '@playwright/test';
+
+const config: PlaywrightTestConfig = {
+  timeout: 300000, // 5 minutes
+  forbidOnly: !!process.env.CI,
+  retries: process.env.CI ? 2 : 0,
+  workers: 1,
+  use: {
+    trace: 'on-first-retry',
+  },
+  projects: [
+    {
+      name: 'prepare',
+      testMatch: /prepare\.ts/,
+      use: { ...devices['Desktop Chrome'] },
+    },
+    {
+      name: 'tests',
+      use: { ...devices['Desktop Chrome'] },
+    },
+  ],
+};
+export default config;

package/storageState.json

@@ -0,0 +1,4 @@
+{
+  "cookies": [],
+  "origins": []
+}

package/tests/check-auth.ts

@@ -0,0 +1,39 @@
+/*!
+ * Copyright 2021 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.
+ */
+
+import { expect, test } from './wpp-test';
+
+test('chech is not logged test', async ({ page }) => {
+  const title = page.locator('title');
+
+  await expect(title).toHaveText('WhatsApp');
+
+  const isAuthenticated = await page.evaluate(() => WPP.conn.isAuthenticated());
+
+  expect(isAuthenticated).toBe(false);
+});
+
+test('chech is logged test', async ({ loggedPage: cleanPage }) => {
+  const title = cleanPage.locator('title');
+
+  await expect(title).toHaveText('WhatsApp');
+
+  const isAuthenticated = await cleanPage.evaluate(() =>
+    WPP.conn.isAuthenticated()
+  );
+
+  expect(isAuthenticated).toBe(true);
+});

package/tests/global.d.ts

@@ -0,0 +1,24 @@
+/*!
+ * Copyright 2021 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.
+ */
+
+import type * as wajs from '../dist';
+
+declare global {
+  interface Window {
+    WPP: typeof wajs;
+  }
+  const WPP: typeof wajs;
+}

package/tests/prepare.ts

@@ -0,0 +1,40 @@
+/*!
+ * Copyright 2021 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.
+ */
+
+import { expect, test } from './wpp-test';
+
+test('basic setup', async ({ loggedPage }) => {
+  const title = loggedPage.locator('title');
+
+  await expect(title).toHaveText('WhatsApp');
+
+  let isAuthenticated = await loggedPage.evaluate(() =>
+    WPP.conn.isAuthenticated()
+  );
+
+  if (isAuthenticated) {
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    return test.skip(isAuthenticated, 'Already connected');
+  }
+
+  expect(isAuthenticated).toBe(false);
+
+  await loggedPage.waitForFunction(() => WPP.conn.isAuthenticated());
+
+  isAuthenticated = await loggedPage.evaluate(() => WPP.conn.isAuthenticated());
+
+  expect(isAuthenticated).toBe(true);
+});

package/tests/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "./"
+  },
+  "include": ["**/*.ts"]
+}

package/tests/wpp-test.ts

@@ -0,0 +1,78 @@
+/*!
+ * Copyright 2021 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.
+ */
+
+import {
+  BrowserContext,
+  chromium,
+  firefox,
+  Page,
+  test as base,
+  webkit,
+} from '@playwright/test';
+import * as os from 'os';
+import * as path from 'path';
+
+export { expect } from '@playwright/test';
+
+export type TestOptions = {
+  loggedContext: BrowserContext;
+  loggedPage: Page;
+};
+
+const prepareWhatsAppPage = async (page: Page) => {
+  page.on('domcontentloaded', async () => {
+    await page.addScriptTag({
+      path: path.join(__dirname, '../dist/wppconnect-wa.js'),
+    });
+  });
+
+  await page.goto('https://web.whatsapp.com/', {
+    waitUntil: 'domcontentloaded',
+  });
+
+  await page.waitForFunction(() => WPP && WPP.isReady);
+};
+
+export const test = base.extend<TestOptions>({
+  page: async ({ page }, use) => {
+    await prepareWhatsAppPage(page);
+
+    await use(page);
+  },
+  loggedContext: async ({ browserName, contextOptions }, use) => {
+    const userDataDir = path.join(os.tmpdir(), `wa-js-test-${browserName}`);
+
+    const browsers = { chromium, firefox, webkit };
+
+    const loggedContext = await browsers[browserName].launchPersistentContext(
+      userDataDir,
+      contextOptions
+    );
+
+    await use(loggedContext);
+    await loggedContext.close();
+  },
+  loggedPage: async ({ loggedContext: cleanContext }, use) => {
+    const cleanPage = cleanContext.pages().length
+      ? cleanContext.pages()[0]
+      : await cleanContext.newPage();
+
+    await prepareWhatsAppPage(cleanPage);
+
+    await use(cleanPage);
+    await cleanPage.close();
+  },
+});