talkyzap-wapp-api 1.0.0

package/dist/community/index.d.ts

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

package/dist/config/Config.d.ts

@@ -0,0 +1,74 @@
+/*!
+ * 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.
+ */
+/**
+ * Define some global configurations
+ *
+ * @example
+ * ```javascript
+ * // Global variable before injection
+ * WPPConfig = {
+ *   deviceName: 'WPPConnect',
+ *   liveLocationLimit: 10,
+ *   disableGoogleAnalytics: false,
+ *   googleAnalyticsId: 'G-XXXXXXXXXX',
+ *   sendStatusToDevice: true
+ * };
+ * ```
+ */
+export interface Config {
+    [key: string | symbol]: any;
+    /**
+     * Set the device name connected, false to disable
+     * @default 'WPPConnect'
+     */
+    deviceName: string | false;
+    /**
+     * Number of last chats to check live location after a page reload
+     */
+    liveLocationLimit: number;
+    /**
+     * Disable Google Analytics tracking
+     */
+    disableGoogleAnalytics: boolean;
+    /**
+     * Google Analytics Id
+     */
+    googleAnalyticsId: string | null;
+    /**
+     * Google Analytics Id
+     */
+    googleAnalyticsUserProperty: {
+        [key: string]: string | number | boolean;
+    };
+    /**
+     * Link Preview API servers
+     */
+    linkPreviewApiServers: string[] | null;
+    /**
+     * Project name for google analytics
+     */
+    poweredBy: string | null;
+    /**
+     * Send the status to your device, set it to false to avoid WhatsApp crashing
+     * @default false
+     */
+    sendStatusToDevice: boolean;
+    /**
+     * Option to disable status sync
+     * @default false
+     */
+    syncAllStatus: boolean;
+}

package/dist/config/defaultConfig.d.ts

@@ -0,0 +1,17 @@
+/*!
+ * 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.
+ */
+import { Config } from './Config';
+export declare const defaultConfig: Config;

package/dist/config/eventTypes.d.ts

@@ -0,0 +1,25 @@
+/*!
+ * 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.
+ */
+import { Config } from './Config';
+export interface ConfigEventTypes {
+    'config.update': {
+        config: Config;
+        key: string | number | symbol;
+        path: (string | number | symbol)[];
+        target: any;
+        value: any;
+    };
+}

package/dist/config/index.d.ts

@@ -0,0 +1,23 @@
+/*!
+ * 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.
+ */
+import { Config } from './Config';
+export { Config } from './Config';
+declare global {
+    interface Window {
+        WPPConfig: Config;
+    }
+}
+export declare const config: Config;

package/dist/conn/events/eventTypes.d.ts

@@ -0,0 +1,92 @@
+/*!
+ * 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 '../types';
+export interface ConnEventTypes {
+    'conn.auth_code_change': AuthCode | null;
+    /**
+     * Triggered afted a success QR code scan
+     *
+     * @example
+     * ```javascript
+     * WPP.on('conn.authenticated', () => {
+     *   // Your code
+     * });
+     * ```
+     */
+    'conn.authenticated': undefined;
+    'conn.logout': undefined;
+    /**
+     * Triggered when the interface is booting
+     *
+     * @example
+     * ```javascript
+     * WPP.on('conn.main_init', () => {
+     *   // Your code
+     * });
+     * ```
+     */
+    'conn.main_init': undefined;
+    /**
+     * Triggered when the main interface is loaded, but is syncing
+     *
+     * @example
+     * ```javascript
+     * WPP.on('conn.main_loaded', () => {
+     *   // Your code
+     * });
+     * ```
+     */
+    'conn.main_loaded': undefined;
+    /**
+     * Triggered when the main interface is loaded, authenticated and ready to send message
+     *
+     * @example
+     * ```javascript
+     * WPP.on('conn.main_ready', () => {
+     *   // Your code
+     * });
+     * ```
+     */
+    'conn.main_ready': undefined;
+    /**
+     * Triggered when a whatsapp web update is requested
+     *
+     * @example
+     * ```javascript
+     * WPP.on('conn.needs_update', () => {
+     *   // Your code
+     * });
+     * ```
+     */
+    'conn.needs_update': undefined;
+    /**
+     * Triggered when the online change to online or offline
+     *
+     * @example
+     * ```javascript
+     * WPP.on('conn.online', (online) => {
+     *   if (online) {
+     *     console.log('You are online');
+     *   } else {
+     *     console.log('You are offline');
+     *   }
+     * });
+     * ```
+     */
+    'conn.online': boolean;
+    'conn.qrcode_idle': undefined;
+    'conn.require_auth': undefined;
+}

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

@@ -0,0 +1,25 @@
+/*!
+ * 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 './registerAuthCodeChangeEvent';
+import './registerAuthenticatedEvent';
+import './registerLogoutEvent';
+import './registerMainInit';
+import './registerMainLoadedEvent';
+import './registerMainReadyEvent';
+import './registerNeedsUpdateEvent';
+import './registerOnlineEvent';
+import './registerQRCodeIdleEvent';
+import './registerRequireAuthEvent';

package/dist/conn/events/registerAuthCodeChangeEvent.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/conn/events/registerAuthenticatedEvent.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/conn/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/conn/events/registerMainInit.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/conn/events/registerMainLoadedEvent.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/conn/events/registerMainReadyEvent.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/conn/events/registerNeedsUpdateEvent.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/conn/events/registerOnlineEvent.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/conn/events/registerQRCodeIdleEvent.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/conn/events/registerRequireAuthEvent.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/conn/functions/genLinkDeviceCodeForPhoneNumber.d.ts

@@ -0,0 +1,30 @@
+/*!
+ * 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.
+ */
+/**
+ * Alternative login method using code
+ * Get the Link Device Code for Authentication using the phone number
+ *
+ * @example
+ * ```javascript
+ * const code = await WPP.conn.genLinkDeviceCodeForPhoneNumber('[number]');
+ *
+ * // Disable push notification
+ * const code = await WPP.conn.genLinkDeviceCodeForPhoneNumber('[number]', false);
+ * ```
+ *
+ * @category Conn
+ */
+export declare function genLinkDeviceCodeForPhoneNumber(phone: string, sendPushNotification?: boolean): Promise<string>;

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

@@ -0,0 +1,28 @@
+/*!
+ * 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
+ *
+ * @example
+ * ```javascript
+ * const authCode = await WPP.conn.getAuthCode();
+ * console.log(authCode.fullCode); // Output: a long string to generate a QRCode
+ * ```
+ *
+ * @return  {Promise<AuthCode>}[return description]
+ */
+export declare function getAuthCode(): Promise<AuthCode | null>;

package/dist/conn/functions/getHistorySyncProgress.d.ts

@@ -0,0 +1,32 @@
+/*!
+ * 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 interface HistorySyncProgress {
+    progress: number | null;
+    paused: boolean;
+    inProgress: boolean;
+}
+/**
+ * Return the current state of syncing old messages progress
+ *
+ * @example
+ * ```javascript
+ * const info = WPP.conn.getHistorySyncProgress();
+ * console.log(info.progress); // Output: 50
+ * console.log(info.paused); // Output: false0
+ * console.log(info.inProgress); // Output: true
+ * ```
+ */
+export declare function getHistorySyncProgress(): HistorySyncProgress;

package/dist/conn/functions/getMyDeviceId.d.ts

@@ -0,0 +1,26 @@
+/*!
+ * 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';
+/**
+ * Return the current logged user ID with device id
+ *
+ * @example
+ * ```javascript
+ * const wid = WPP.conn.getMyDeviceId();
+ * console.log(wid.toString()); // Output: 123:4@c.us
+ * ```
+ */
+export declare function getMyDeviceId(): Wid | undefined;

package/dist/conn/functions/getMyUserId.d.ts

@@ -0,0 +1,26 @@
+/*!
+ * 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';
+/**
+ * Return the current logged user ID without device id
+ *
+ * @example
+ * ```javascript
+ * const wid = WPP.conn.getMyUserId();
+ * console.log(wid.toString()); // Output: 123@c.us
+ * ```
+ */
+export declare function getMyUserId(): Wid | undefined;

package/dist/conn/functions/getPlatform.d.ts

@@ -0,0 +1,25 @@
+/*!
+ * 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.
+ */
+/**
+ * Check what's device platform is connected
+ * @returns android | iphone | wp
+ *
+ * @example
+ * ```javascript
+ * const getPlatform = WPP.conn.getPlatform();
+ * ```
+ */
+export declare function getPlatform(): any;

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

@@ -0,0 +1,37 @@
+/*!
+ * 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 { genLinkDeviceCodeForPhoneNumber } from './genLinkDeviceCodeForPhoneNumber';
+export { getAuthCode } from './getAuthCode';
+export { getHistorySyncProgress, HistorySyncProgress, } from './getHistorySyncProgress';
+export { getMyDeviceId } from './getMyDeviceId';
+export { getMyUserId } from './getMyUserId';
+export { getPlatform } from './getPlatform';
+export { isAuthenticated } from './isAuthenticated';
+export { isIdle } from './isIdle';
+export { isMainInit } from './isMainInit';
+export { isMainLoaded } from './isMainLoaded';
+export { isMainReady } from './isMainReady';
+export { isMultiDevice } from './isMultiDevice';
+export { isOnline } from './isOnline';
+export { isRegistered } from './isRegistered';
+export { joinWebBeta } from './joinWebBeta';
+export { logout } from './logout';
+export { markAvailable, markUnavailable } from './markAvailable';
+export { needsUpdate } from './needsUpdate';
+export { refreshQR } from './refreshQR';
+export { setKeepAlive } from './setKeepAlive';
+export { setLimit } from './setLimit';
+export { setMultiDevice } from './setMultiDevice';