dymo-api 1.0.53 → 1.0.55

package/dist/cjs/dymo-api.js

@@ -269,6 +269,3 @@ class DymoAPI {
         return await PublicAPI.newURLEncrypt(data);
     }
 }
-exports.default = DymoAPI;
-//@ts-ignore
-module.exports = DymoAPI;

package/dist/esm/dymo-api.js

@@ -269,6 +269,3 @@ class DymoAPI {
         return await PublicAPI.newURLEncrypt(data);
     }
 }
-exports.default = DymoAPI;
-//@ts-ignore
-module.exports = DymoAPI;

package/dist/types/dymo-api.d.ts

@@ -1,188 +1 @@
-interface ServerEmailConfig {
-    host: string;
-    port: number;
-    secure: boolean;
-    auth: {
-        user: string;
-        pass: string;
-    };
-    dkim?: {
-        domainName: string;
-        keySelector: string;
-        privateKey: string;
-    };
-}
-declare class DymoAPI {
-    private rootApiKey;
-    private apiKey;
-    private tokensResponse;
-    private lastFetchTime;
-    private serverEmailConfig?;
-    private local;
-    /**
-     * @param {Object} options - Options to create the DymoAPI instance.
-     * @param {string} [options.rootApiKey] - The root API key.
-     * @param {string} [options.apiKey] - The API key.
-     * @param {boolean} [options.local] - Whether to use a local server instead of the cloud server.
-     * @param {Object} [options.serverEmailConfig] - The server email config.
-     * @description
-     * This is the main class to interact with the Dymo API. It should be
-     * instantiated with the root API key and the API key. The root API key is
-     * used to fetch the tokens and the API key is used to authenticate the
-     * requests.
-     * @example
-     * const dymoApi = new DymoAPI({
-     *     rootApiKey: "6bfb7675-6b69-4f8d-9f43-5a6f7f02c6c5",
-     *     apiKey: "4c8b7675-6b69-4f8d-9f43-5a6f7f02c6c5",
-     *     local: true
-     * });
-     */
-    constructor({ rootApiKey, apiKey, local, serverEmailConfig }: {
-        rootApiKey?: string | null;
-        apiKey?: string | null;
-        local?: boolean;
-        serverEmailConfig?: ServerEmailConfig;
-    });
-    /**
-     * Retrieves and caches authentication tokens.
-     *
-     * This method checks if cached tokens are available and valid. If so, it returns
-     * the cached tokens. Otherwise, it generates new tokens using the provided API keys
-     * and caches them. The tokens are fetched from the server using a POST request.
-     *
-     * The method also handles validation of root and API tokens, throwing errors if
-     * any of the tokens are invalid. Cached tokens are considered valid for 5 minutes.
-     *
-     * @returns {Promise<Object|undefined>} A promise that resolves to the tokens response
-     * if successful, or undefined if no tokens are available.
-     * @throws Will throw an error if token validation fails, or if there is an issue
-     * with the token retrieval process.
-     */
-    private getTokens;
-    /**
-     * Initializes the tokens response by calling getTokens().
-     *
-     * This method is called in the constructor and will throw an error if the
-     * initialization process fails.
-     *
-     * @throws Will throw an error if there is an issue with the token retrieval
-     * process.
-     */
-    private initializeTokens;
-    /**
-     * Checks for updates and logs a message if a new version is available.
-     *
-     * This method is called in the constructor and will throw an error if the
-     * update check fails.
-     *
-     * @throws Will throw an error if there is an issue with the update check
-     * process.
-     */
-    private autoupdate;
-    /**
-     * Validates the given data against the configured validation settings.
-     *
-     * This method requires either the root API key or the API key to be set.
-     * If neither is set, it will throw an error.
-     *
-     * @param {Object} data - The data to be validated.
-     * @returns {Promise<Object>} A promise that resolves to the response from the server.
-     * @throws Will throw an error if there is an issue with the validation process.
-     */
-    isValidData(data: any): Promise<any>;
-    /**
-     * Sends an email using the configured email client settings.
-     *
-     * This method requires either the root API key or the server email config to be set.
-     * If neither is set, it will throw an error.
-     *
-     * @param {Object} data - The email data to be sent.
-     * @param {string} data.from - The email address from which the email will be sent.
-     * @param {string} data.to - The email address to which the email will be sent.
-     * @param {string} data.subject - The subject of the email.
-     * @param {string} [data.html] - The HTML content of the email.
-     * @param {React.ReactElement} [data.react] - The React component to be rendered as the email content.
-     * @param {Object} [data.options] - Content configuration options.
-     * @param {"high" | "normal" | "low" | undefined} [data.options.priority="normal"] - Email priority (default: normal).
-     * @param {boolean} [data.options.waitToResponse=true] - Wait until the email is sent (default: true).
-     * @param {boolean} [data.options.composeTailwindClasses] - Whether to compose tailwind classes.
-     * @param {Attachment[]} [data.attachments] - An array of attachments to be included in the email.
-     * @param {string} data.attachments[].filename - The name of the attached file.
-     * @param {string} [data.attachments[].path] - The path or URL of the attached file. Either this or `content` must be provided.
-     * @param {Buffer} [data.attachments[].content] - The content of the attached file as a Buffer. Either this or `path` must be provided.
-     * @param {string} [data.attachments[].cid] - The CID (Content-ID) of the attached file, used for inline images.
-     * @returns {Promise<Object>} A promise that resolves to the response from the server.
-     * @throws Will throw an error if there is an issue with the email sending process.
-     */
-    sendEmail(data: any): Promise<any>;
-    /**
-     * Generates a random number between the provided min and max values.
-     *
-     * This method requires either the root API key or the API key to be set.
-     * If neither is set, it will throw an error.
-     *
-     * @param {Object} data - The data to be sent.
-     * @param {number} data.min - The minimum value of the range.
-     * @param {number} data.max - The maximum value of the range.
-     * @returns {Promise<Object>} A promise that resolves to the response from the server.
-     * @throws Will throw an error if there is an issue with the random number generation process.
-     */
-    getRandom(data: any): Promise<any>;
-    /**
-     * Retrieves the prayer times for the given location.
-     *
-     * This method requires a latitude and longitude to be provided in the
-     * data object. If either of these are not provided, it will throw an error.
-     *
-     * @param {Object} data - The data to be sent.
-     * @param {number} data.lat - The latitude of the location.
-     * @param {number} data.lon - The longitude of the location.
-     * @returns {Promise<Object>} A promise that resolves to the response from the server.
-     * @throws Will throw an error if there is an issue with the prayer times retrieval process.
-     */
-    getPrayerTimes(data: any): Promise<any>;
-    /**
-     * Satinizes the input, replacing any special characters with their HTML
-     * entities.
-     *
-     * @param {Object} data - The data to be sent.
-     * @param {string} data.input - The input to be satinized.
-     * @returns {Promise<Object>} A promise that resolves to the response from the server.
-     * @throws Will throw an error if there is an issue with the satinization process.
-     */
-    satinizer(data: any): Promise<any>;
-    /**
-     * Validates a password based on the given parameters.
-     *
-     * This method requires the password to be provided in the data object.
-     * If the password is not provided, it will throw an error. The method
-     * will validate the password against the following rules:
-     *  - The password must be at least 8 characters long.
-     *  - The password must be at most 32 characters long.
-     *  - The password must contain at least one uppercase letter.
-     *  - The password must contain at least one lowercase letter.
-     *  - The password must contain at least one number.
-     *  - The password must contain at least one special character.
-     *  - The password must not contain any of the given banned words.
-     *
-     * @param {Object} data - The data to be sent.
-     * @param {string} data.password - The password to be validated.
-     * @param {string[]} [data.bannedWords] - The list of banned words that the password must not contain.
-     * @returns {Promise<Object>} A promise that resolves to the response from the server.
-     * @throws Will throw an error if there is an issue with the password validation process.
-     */
-    isValidPwd(data: any): Promise<any>;
-    /**
-     * Encrypts a URL using the configured encryption settings.
-     *
-     * This method requires the URL to be provided in the data object.
-     * If the URL is not provided, it will throw an error.
-     *
-     * @param {Object} data - The data to be sent.
-     * @param {string} data.url - The URL to be encrypted.
-     * @returns {Promise<Object>} A promise that resolves to the response from the server.
-     * @throws Will throw an error if there is an issue with the URL encryption process.
-     */
-    newURLEncrypt(data: any): Promise<any>;
-}
-export default DymoAPI;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dymo-api",
-  "version": "1.0.53",
+  "version": "1.0.55",
   "description": "Flow system for Dymo API.",
   "main": "dist/cjs/dymo-api.js",
   "module": "dist/esm/dymo-api.js",