@open-wa/wa-automate-types-only 4.33.5 → 4.33.8

package/dist/api/Client.d.ts

@@ -1023,7 +1023,7 @@ export declare class Client {
      * @param {boolean} isHidden Whether or not the product is shown publicly in your catalog
      * @returns product object
      */
-    createNewProduct(name: string, price: number, currency: string, images: DataURL[], description: string, url?: string, internalId?: string, isHidden?: boolean): Promise<Product>;
+    createNewProduct(name: string, price: number, currency: string, images: string[], description: string, url?: string, internalId?: string, isHidden?: boolean): Promise<Product>;
     /**
      * [REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)
      *

package/dist/utils/tools.d.ts

@@ -10,9 +10,25 @@ export declare const timeout: (ms: any) => Promise<unknown>;
  */
 export declare const smartUserAgent: (ua: string, version?: string) => string;
 export declare const getConfigFromProcessEnv: any;
+/**
+ * Remove the key from the object and return the rest of the object.
+ * @param {JsonObject} obj - The object to be filtered.
+ * @param {string} key - The key to discard.
+ * @returns The object without the key.
+ */
 export declare const without: any;
 export declare const camelize: (str: string) => string;
+/**
+ * Check if a string is Base64
+ * @param str string
+ * @returns
+ */
 export declare const isBase64: (str: string) => boolean;
+/**
+ * Check if a string is a DataURL
+ * @param s string
+ * @returns
+ */
 export declare const isDataURL: (s: string) => boolean;
 /**
  * @internal
@@ -26,9 +42,45 @@ export declare const getDUrl: (url: string, optionsOverride?: AxiosRequestConfig
  * Use this to extract the mime type from a [[DataURL]]
  */
 export declare const base64MimeType: (dUrl: DataURL) => string;
+/**
+ * If process.send is defined, send the message three times
+ * @param {string} message - The message to send to the parent process.
+ * @returns Nothing.
+ */
 export declare const processSend: (message: string) => void;
+/**
+ * Return the performance object if it is available, otherwise return the Date object
+ */
 export declare const perf: () => DateConstructor | import("perf_hooks").Performance;
+/**
+ * Return the current time in milliseconds
+ */
 export declare const now: () => number;
+/**
+ * `timePromise` returns a promise that resolves to the time it took to run the function passed to it
+ * @param fn - the function to be timed.
+ * @returns A string.
+ */
 export declare function timePromise(fn: () => Promise<any>): Promise<string>;
+/**
+ * It sends a message to the parent process.
+ * @param {any} data - The data to be sent to the parent process.
+ * @returns Nothing.
+ */
 export declare const processSendData: (data?: any) => void;
+/**
+ * It generates a link to the GitHub issue template for the current session
+ * @param {ConfigObject} config - the config object
+ * @param {SessionInfo} sessionInfo - The sessionInfo object from the CLI
+ * @param {any} extras - any
+ * @returns A link to the issue tracker for the current session.
+ */
 export declare const generateGHIssueLink: (config: ConfigObject, sessionInfo: SessionInfo, extras?: any) => string;
+/**
+ * If the file is a DataURL, return it. If it's a file, convert it to a DataURL. If it's a URL,
+ * download it and convert it to a DataURL. If Base64, returns it.
+ * @param {string} file - The file to be converted to a DataURL.
+ * @param {AxiosRequestConfig} requestConfig - AxiosRequestConfig = {}
+ * @returns A DataURL
+ */
+export declare const ensureDUrl: (file: string, requestConfig?: AxiosRequestConfig) => Promise<string>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@open-wa/wa-automate-types-only",
-    "version": "4.33.5",
+    "version": "4.33.8",
     "description": "Types generated from the @open-wa/wa-automate package",
     "scripts": {
         "build": "tsc",