@wppconnect/wa-js 1.0.16 → 1.1.3

package/CHANGELOG.md

@@ -1,3 +1,29 @@
+## 1.1.3 (2022-01-08)
+
+
+### Bug Fixes
+
+* Fixed WPP.chat.downloadMedia for Videos in Chromium ([ba07dfc](https://github.com/wppconnect-team/wa-js/commit/ba07dfcf7d11dda6d379766932bdd43adc9cd319))
+
+
+
+## 1.1.2 (2022-01-08)
+
+
+
+## [1.1.1](https://github.com/wppconnect-team/wa-js/compare/v1.1.0...v1.1.1) (2022-01-08)
+
+
+
+# 1.1.0 (2022-01-08)
+
+
+### Bug Fixes
+
+* Fixed WPP.contact.queryExists (fix wppconnect-team/wppconnect[#725](https://github.com/wppconnect-team/wa-js/issues/725)) ([0c2b50c](https://github.com/wppconnect-team/wa-js/commit/0c2b50c4994d81d0e0d5debdfea7a3e96e333d50))
+
+
+
 ## 1.0.16 (2021-12-08)
 
 

package/README.md

@@ -56,6 +56,74 @@ npm run build:prd # or build:dev for development
 
 # lauch a local browser with automatic injection
 npm run launch:local
+
+# or only run in VSCode
+```
+
+## How to use this project
+
+Basicaly, you need to inject the `wppconnect-wa.js` file into the browser after WhatsApp page load.
+
+### TamperMonkey or GreaseMonkey
+
+```javascript
+// ==UserScript==
+// @name         WA-JS Teste
+// @namespace    http://tampermonkey.net/
+// @version      0.1
+// @description  Simple example of WA-JS
+// @author       You
+// @match        https://web.whatsapp.com/*
+// @icon         https://www.google.com/s2/favicons?domain=whatsapp.com
+// @require      https://github.com/wppconnect-team/wa-js/releases/download/nightly/wppconnect-wa.js
+// @grant        none
+// ==/UserScript==
+
+/* globals WPP */
+
+(function () {
+  'use strict';
+
+  WPP.webpack.onReady(function () {
+    alert('Ready to use WPPConnect WA-JS');
+  });
+
+  // Your code here...
+})();
+```
+
+### Playwright
+
+```typescript
+import * as playwright from 'playwright-chromium';
+
+async function start() {
+  const browser = await playwright.chromium.launch();
+  const page = browser.newPage();
+
+  await page.goto('https://web.whatsapp.com/');
+
+  await page.addScriptTag({
+    path: require.resolve('@wppconnect/wa-js'),
+  });
+
+  // Wait WA-JS load
+  await page.waitForFunction(() => window.WPP?.isReady);
+
+  // Evaluating code: See https://playwright.dev/docs/evaluating/
+  const isAuthenticated: string = await page.evaluate(() =>
+    WPP.auth.isAuthenticated()
+  );
+
+  // Sending message: See https://playwright.dev/docs/evaluating/
+  const sendResult: string = await page.evaluate(
+    (to, message) => WPP.chat.sendTextMessage(to, message),
+    to,
+    message
+  );
+}
+
+start();
 ```
 
 ## License

package/dist/auth/eventEmitter.d.ts

@@ -0,0 +1,52 @@
+/*!
+ * 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 Emittery from 'emittery';
+import { AuthCode } from '.';
+export declare type UnsubscribeFn = () => void;
+export interface EventTypes {
+    change: AuthCode;
+    idle: undefined;
+    logout: undefined;
+}
+export declare const eventEmitter: Emittery<EventTypes, EventTypes, "idle" | "logout">;
+/**
+ * Subscribe to one event.
+ * @event
+ * @returns An unsubscribe method.
+ */
+export declare function on<Name extends keyof EventTypes>(eventName: Name, listener: (eventData: EventTypes[Name]) => void | Promise<void>): UnsubscribeFn;
+/**
+ * Subscribe to one or more events only once. It will be unsubscribed after the first event.
+ * @event
+ */
+export declare function once<Name extends keyof EventTypes>(eventName: Name): Promise<EventTypes[Name]>;
+/**
+ * @event
+ */
+export declare function off<Name extends keyof EventTypes>(eventName: Name, listener: (eventData: EventTypes[Name]) => void | Promise<void>): void;
+/**
+ * Clear all event listeners on the instance.
+ *
+ * If `eventName` is given, only the listeners for that event are cleared.
+ *
+ * @event
+ */
+export declare function clearListeners<Name extends keyof EventTypes>(eventName?: Name | Name[]): void;
+/**
+ * The number of listeners for the `eventName` or all events if not specified.
+ * @event
+ */
+export declare function listenerCount<Name extends keyof EventTypes>(eventName?: Name | Name[]): number;

package/dist/{blocklist/Blocklist.d.ts → auth/events/index.d.ts}

@@ -13,14 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import Emittery from 'emittery';
-import { Wid } from '../whatsapp';
-import { BlocklistEventTypes, BlocklistResult } from '.';
-export declare class Blocklist extends Emittery<BlocklistEventTypes> {
-    constructor();
-    initialize(): Promise<void>;
-    all(): Wid[];
-    isBlocked(chatId: string | Wid): boolean;
-    blockContact(chatId: string | Wid): Promise<BlocklistResult>;
-    unblockContact(chatId: string | Wid): Promise<BlocklistResult>;
-}
+import './registerChangeEvent';
+import './registerIdleEvent';
+import './registerLogoutEvent';

package/dist/{contact/types.d.ts → auth/events/registerChangeEvent.d.ts}

@@ -13,6 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export interface ContactEventTypes {
-    idle: undefined;
-}
+export {};

package/dist/auth/events/registerIdleEvent.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * 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.
+ */
+export {};

package/dist/auth/events/registerLogoutEvent.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * 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.
+ */
+export {};

package/dist/auth/functions/getAuthCode.d.ts

@@ -0,0 +1,22 @@
+/*!
+ * 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 { AuthCode } from '..';
+/**
+ * Return the current auth code
+ *
+ * @return  {Promise<AuthCode>}[return description]
+ */
+export declare function getAuthCode(): Promise<AuthCode | null>;

package/dist/{contact/Contact.d.ts → auth/functions/index.d.ts}

@@ -13,14 +13,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import Emittery from 'emittery';
-import { Wid } from '../whatsapp';
-import { ContactEventTypes } from './types';
-export declare class Contact extends Emittery<ContactEventTypes> {
-    constructor();
-    initialize(): Promise<void>;
-    queryExists(contactId: string | Wid): Promise<{
-        wid: Wid;
-        biz: boolean;
-    } | null>;
-}
+export { getAuthCode } from './getAuthCode';
+export { isAuthenticated } from './isAuthenticated';
+export { isIdle } from './isIdle';
+export { isMultiDevice } from './isMultiDevice';
+export { logout } from './logout';
+export { poke } from './poke';
+export { setMultiDevice } from './setMultiDevice';

package/dist/auth/functions/isAuthenticated.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * 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.
+ */
+export declare function isAuthenticated(): boolean;

package/dist/auth/functions/isIdle.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * 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.
+ */
+export declare function isIdle(): boolean;

package/dist/auth/functions/isMultiDevice.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * 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.
+ */
+export declare function isMultiDevice(): boolean;

package/dist/auth/functions/logout.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * 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.
+ */
+export declare function logout(): Promise<boolean>;

package/dist/auth/functions/poke.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * 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.
+ */
+export declare function poke(): void;

package/dist/auth/functions/setMultiDevice.d.ts

@@ -0,0 +1,23 @@
+/*!
+ * 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.
+ */
+/**
+ * @param md If it's true, WhatsApp WEB will switch to MD. If it's false, WhatsApp WEB will switch to Legacy.
+ * @example
+ * ```javascript
+ * WPP.auth.setMultiDevice(true)
+ * ```
+ */
+export declare function setMultiDevice(md?: boolean): boolean;

package/dist/auth/index.d.ts

@@ -13,8 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Auth } from './Auth';
-export * from './Auth';
+import './events';
+export { clearListeners, EventTypes, listenerCount, off, on, once, UnsubscribeFn, } from './eventEmitter';
+export * from './functions';
 export * from './types';
-declare const _default: Auth;
-export default _default;

package/dist/auth/types.d.ts

@@ -29,8 +29,3 @@ export interface AuthCodeMultiDevice {
     fullCode: string;
 }
 export declare type AuthCode = AuthCodeSingleDevice | AuthCodeMultiDevice;
-export interface AuthEventTypes {
-    change: AuthCode;
-    idle: undefined;
-    logout: undefined;
-}

package/dist/blocklist/eventEmitter.d.ts

@@ -0,0 +1,49 @@
+/*!
+ * 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 Emittery from 'emittery';
+export declare type UnsubscribeFn = () => void;
+export interface EventTypes {
+    sync: undefined;
+}
+export declare const eventEmitter: Emittery<EventTypes, EventTypes, "sync">;
+/**
+ * Subscribe to one event.
+ * @event
+ * @returns An unsubscribe method.
+ */
+export declare function on<Name extends keyof EventTypes>(eventName: Name, listener: (eventData: EventTypes[Name]) => void | Promise<void>): UnsubscribeFn;
+/**
+ * Subscribe to one or more events only once. It will be unsubscribed after the first event.
+ * @event
+ */
+export declare function once<Name extends keyof EventTypes>(eventName: Name): Promise<EventTypes[Name]>;
+/**
+ * @event
+ */
+export declare function off<Name extends keyof EventTypes>(eventName: Name, listener: (eventData: EventTypes[Name]) => void | Promise<void>): void;
+/**
+ * Clear all event listeners on the instance.
+ *
+ * If `eventName` is given, only the listeners for that event are cleared.
+ *
+ * @event
+ */
+export declare function clearListeners<Name extends keyof EventTypes>(eventName?: Name | Name[]): void;
+/**
+ * The number of listeners for the `eventName` or all events if not specified.
+ * @event
+ */
+export declare function listenerCount<Name extends keyof EventTypes>(eventName?: Name | Name[]): number;

package/dist/blocklist/events/index.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * 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 './registerSyncedEvent';

package/dist/blocklist/events/registerSyncedEvent.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * 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.
+ */
+export {};

package/dist/blocklist/functions/all.d.ts

@@ -0,0 +1,17 @@
+/*!
+ * 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 { Wid } from '../../whatsapp';
+export declare function all(): Wid[];

package/dist/blocklist/functions/blockContact.d.ts

@@ -0,0 +1,18 @@
+/*!
+ * 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 { Wid } from '../../whatsapp';
+import { BlocklistResult } from '../types';
+export declare function blockContact(chatId: string | Wid): Promise<BlocklistResult>;

package/dist/blocklist/functions/index.d.ts

@@ -0,0 +1,19 @@
+/*!
+ * 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.
+ */
+export { all } from './all';
+export { blockContact } from './blockContact';
+export { isBlocked } from './isBlocked';
+export { unblockContact } from './unblockContact';

package/dist/blocklist/functions/isBlocked.d.ts

@@ -0,0 +1,17 @@
+/*!
+ * 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 { Wid } from '../../whatsapp';
+export declare function isBlocked(chatId: string | Wid): boolean;

package/dist/blocklist/functions/unblockContact.d.ts

@@ -0,0 +1,18 @@
+/*!
+ * 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 { Wid } from '../../whatsapp';
+import { BlocklistResult } from '../types';
+export declare function unblockContact(chatId: string | Wid): Promise<BlocklistResult>;

package/dist/blocklist/index.d.ts

@@ -13,8 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Blocklist } from './Blocklist';
-export * from './Blocklist';
-export * from './types';
-declare const _default: Blocklist;
-export default _default;
+import './events';
+export { clearListeners, EventTypes, listenerCount, off, on, once, UnsubscribeFn, } from './eventEmitter';
+export * from './functions';

package/dist/blocklist/types.d.ts

@@ -14,9 +14,6 @@
  * limitations under the License.
  */
 import { Wid } from '../whatsapp';
-export interface BlocklistEventTypes {
-    sync: undefined;
-}
 export interface BlocklistResult {
     wid: Wid;
     isBlocked: boolean;

package/dist/chat/defaultSendMessageOptions.d.ts

@@ -0,0 +1,19 @@
+/*!
+ * 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 { LinkPreviewOptions, MessageButtonsOptions, SendMessageOptions } from '.';
+import { ListMessageOptions } from './functions/sendListMessage';
+export declare type AllMessageOptions = SendMessageOptions & LinkPreviewOptions & MessageButtonsOptions & Partial<ListMessageOptions>;
+export declare const defaultSendMessageOptions: AllMessageOptions;