dymo-api 1.0.86 → 1.0.88

package/dist/cjs/config/index.cjs

@@ -13,7 +13,10 @@ const config = {
 exports.default = config;
 let BASE_URL = config.env.baseUrl;
 exports.BASE_URL = BASE_URL;
-const setBaseUrl = (isLocal) => {
-    exports.BASE_URL = BASE_URL = isLocal ? "http://localhost:3050" : config.env.baseUrl;
+const setBaseUrl = (baseUrl) => {
+    if (/^(https:\/\/api\.tpeoficial\.com$|http:\/\/(localhost:\d+|dymoapi:\d+))$/.test(baseUrl))
+        exports.BASE_URL = BASE_URL = baseUrl;
+    else
+        throw new Error("[Dymo API] Invalid URL. It must be https://api.tpeoficial.com or start with http://localhost or http://dymoapi followed by a port.");
 };
 exports.setBaseUrl = setBaseUrl;

package/dist/cjs/dymo-api.cjs

@@ -36,7 +36,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const PublicAPI = __importStar(require("./branches/public.cjs"));
 const PrivateAPI = __importStar(require("./branches/private.cjs"));
 const config_1 = __importStar(require("./config/index.cjs"));
-const autoupdate_1 = require("./services/autoupdate.cjs");
 const customError = (code, message) => {
     return Object.assign(new Error(), { code, message: `[${config_1.default.lib.name}] ${message}` });
 };
@@ -45,7 +44,7 @@ class DymoAPI {
      * @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 {string} [options.baseUrl] - 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
@@ -55,34 +54,15 @@ class DymoAPI {
      * @example
      * const dymoApi = new DymoAPI({
      *     rootApiKey: "6bfb7675-6b69-4f8d-9f43-5a6f7f02c6c5",
-     *     apiKey: "4c8b7675-6b69-4f8d-9f43-5a6f7f02c6c5",
-     *     local: true
+     *     apiKey: "4c8b7675-6b69-4f8d-9f43-5a6f7f02c6c5"
      * });
      */
-    constructor({ rootApiKey = null, apiKey = null, local = false, serverEmailConfig = undefined } = {}) {
+    constructor({ rootApiKey = null, apiKey = null, baseUrl = "https://api.tpeoficial.com", serverEmailConfig = undefined } = {}) {
         this.rootApiKey = rootApiKey;
         this.apiKey = apiKey;
         this.serverEmailConfig = serverEmailConfig;
-        this.local = rootApiKey ? local : false; // Only allow setting local if rootApiKey is defined.
-        (0, config_1.setBaseUrl)(this.local);
-        this.autoupdate();
-    }
-    /**
-     * 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.
-     */
-    async autoupdate() {
-        try {
-            await (0, autoupdate_1.checkForUpdates)();
-        }
-        catch (error) {
-            console.error(`[${config_1.default.lib.name}] Error checking the latest version in npmjs: ${error.message}`);
-        }
+        this.baseUrl = baseUrl;
+        (0, config_1.setBaseUrl)(baseUrl);
     }
     // FUNCTIONS / Private.
     /**

package/dist/esm/config/index.js

@@ -9,7 +9,10 @@ const config = {
 };
 export default config;
 let BASE_URL = config.env.baseUrl;
-export const setBaseUrl = (isLocal) => {
-    BASE_URL = isLocal ? "http://localhost:3050" : config.env.baseUrl;
+export const setBaseUrl = (baseUrl) => {
+    if (/^(https:\/\/api\.tpeoficial\.com$|http:\/\/(localhost:\d+|dymoapi:\d+))$/.test(baseUrl))
+        BASE_URL = baseUrl;
+    else
+        throw new Error("[Dymo API] Invalid URL. It must be https://api.tpeoficial.com or start with http://localhost or http://dymoapi followed by a port.");
 };
 export { BASE_URL };

package/dist/esm/dymo-api.js

@@ -1,7 +1,6 @@
 import * as PublicAPI from "./branches/public.js";
 import * as PrivateAPI from "./branches/private.js";
 import config, { setBaseUrl } from "./config/index.js";
-import { checkForUpdates } from "./services/autoupdate.js";
 const customError = (code, message) => {
     return Object.assign(new Error(), { code, message: `[${config.lib.name}] ${message}` });
 };
@@ -10,7 +9,7 @@ class DymoAPI {
      * @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 {string} [options.baseUrl] - 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
@@ -20,34 +19,15 @@ class DymoAPI {
      * @example
      * const dymoApi = new DymoAPI({
      *     rootApiKey: "6bfb7675-6b69-4f8d-9f43-5a6f7f02c6c5",
-     *     apiKey: "4c8b7675-6b69-4f8d-9f43-5a6f7f02c6c5",
-     *     local: true
+     *     apiKey: "4c8b7675-6b69-4f8d-9f43-5a6f7f02c6c5"
      * });
      */
-    constructor({ rootApiKey = null, apiKey = null, local = false, serverEmailConfig = undefined } = {}) {
+    constructor({ rootApiKey = null, apiKey = null, baseUrl = "https://api.tpeoficial.com", serverEmailConfig = undefined } = {}) {
         this.rootApiKey = rootApiKey;
         this.apiKey = apiKey;
         this.serverEmailConfig = serverEmailConfig;
-        this.local = rootApiKey ? local : false; // Only allow setting local if rootApiKey is defined.
-        setBaseUrl(this.local);
-        this.autoupdate();
-    }
-    /**
-     * 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.
-     */
-    async autoupdate() {
-        try {
-            await checkForUpdates();
-        }
-        catch (error) {
-            console.error(`[${config.lib.name}] Error checking the latest version in npmjs: ${error.message}`);
-        }
+        this.baseUrl = baseUrl;
+        setBaseUrl(baseUrl);
     }
     // FUNCTIONS / Private.
     /**

package/dist/types/config/index.d.ts

@@ -9,5 +9,5 @@ declare const config: {
 };
 export default config;
 declare let BASE_URL: string;
-export declare const setBaseUrl: (isLocal: boolean) => void;
+export declare const setBaseUrl: (baseUrl: string) => void;
 export { BASE_URL };

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

@@ -3,12 +3,12 @@ declare class DymoAPI {
     private rootApiKey;
     private apiKey;
     private serverEmailConfig?;
-    private local;
+    private baseUrl;
     /**
      * @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 {string} [options.baseUrl] - 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
@@ -18,26 +18,15 @@ declare class DymoAPI {
      * @example
      * const dymoApi = new DymoAPI({
      *     rootApiKey: "6bfb7675-6b69-4f8d-9f43-5a6f7f02c6c5",
-     *     apiKey: "4c8b7675-6b69-4f8d-9f43-5a6f7f02c6c5",
-     *     local: true
+     *     apiKey: "4c8b7675-6b69-4f8d-9f43-5a6f7f02c6c5"
      * });
      */
-    constructor({ rootApiKey, apiKey, local, serverEmailConfig }?: {
+    constructor({ rootApiKey, apiKey, baseUrl, serverEmailConfig }?: {
         rootApiKey?: string | null;
         apiKey?: string | null;
-        local?: boolean;
+        baseUrl?: string;
         serverEmailConfig?: Interfaces.ServerEmailConfig;
     });
-    /**
-     * 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.
      *

package/package.json

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

package/dist/cjs/services/autoupdate.cjs

@@ -1,27 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkForUpdates = checkForUpdates;
-const axios_1 = __importDefault(require("axios"));
-//@ts-ignore
-const child_process_1 = require("child_process");
-const localVersion = (0, child_process_1.execSync)("npm list dymo-api --depth=0").toString().match(new RegExp("dymo-api@(\\d+\\.\\d+\\.\\d+)"))?.[1] || "0.0.0";
-async function checkForUpdates() {
-    try {
-        const response = await axios_1.default.get("https://registry.npmjs.org/dymo-api/latest");
-        const latestVersion = response.data.version;
-        if (localVersion !== latestVersion)
-            console.log(`[Dymo API] A new version of dymo-api is available: ${latestVersion}. You are using ${localVersion}. Consider updating.`);
-    }
-    catch (error) {
-        if (error.response)
-            console.error("[Dymo API] Error fetching the latest version:", error.response.data);
-        else if (error.request)
-            console.error("[Dymo API] No response received from the server:", error.request);
-        else
-            console.error("[Dymo API] An unknown error occurred:", error.message);
-    }
-}
-;

package/dist/esm/services/autoupdate.js

@@ -1,21 +0,0 @@
-import axios from "axios";
-//@ts-ignore
-import { execSync } from "child_process";
-const localVersion = execSync("npm list dymo-api --depth=0").toString().match(new RegExp("dymo-api@(\\d+\\.\\d+\\.\\d+)"))?.[1] || "0.0.0";
-export async function checkForUpdates() {
-    try {
-        const response = await axios.get("https://registry.npmjs.org/dymo-api/latest");
-        const latestVersion = response.data.version;
-        if (localVersion !== latestVersion)
-            console.log(`[Dymo API] A new version of dymo-api is available: ${latestVersion}. You are using ${localVersion}. Consider updating.`);
-    }
-    catch (error) {
-        if (error.response)
-            console.error("[Dymo API] Error fetching the latest version:", error.response.data);
-        else if (error.request)
-            console.error("[Dymo API] No response received from the server:", error.request);
-        else
-            console.error("[Dymo API] An unknown error occurred:", error.message);
-    }
-}
-;

package/dist/types/services/autoupdate.d.ts

@@ -1 +0,0 @@
-export declare function checkForUpdates(): Promise<void>;