temp-disposable-email 1.2.0 → 1.6.0

package/CHANGELOG.md

@@ -1,28 +1,45 @@
-# [1.2.0](https://github.com/pirasanthan-jesugeevegan/temp-disposable-email/compare/v1.1.0...v1.2.0) (2024-11-28)
+# [1.6.0](https://github.com/pirasanthan-jesugeevegan/temp-disposable-email/compare/v1.5.0...v1.6.0) (2024-11-28)
 
 
 ### Features
 
-* update main entry point to TypeScript source file ([3332c21](https://github.com/pirasanthan-jesugeevegan/temp-disposable-email/commit/3332c2147b825384ed52b068b95172f4fa3e94bd))
+* update package version to 1.4.0, add tslib dependency, and modify tsconfig settings ([a6fc115](https://github.com/pirasanthan-jesugeevegan/temp-disposable-email/commit/a6fc115fa263909fbe346f0f86ae95c18b1bea08))
 
 
 
-# [1.1.0](https://github.com/pirasanthan-jesugeevegan/temp-disposable-email/compare/d886b69f54169b24654ea60de37985a522058ac8...v1.1.0) (2024-11-28)
+# [1.5.0](https://github.com/pirasanthan-jesugeevegan/temp-disposable-email/compare/v1.4.0...v1.5.0) (2024-11-28)
 
 
 ### Features
 
-* account and authentication services with dotenv support ([d886b69](https://github.com/pirasanthan-jesugeevegan/temp-disposable-email/commit/d886b69f54169b24654ea60de37985a522058ac8))
-* add GitHub Actions workflows for NPM publishing and release management ([4a4ac8f](https://github.com/pirasanthan-jesugeevegan/temp-disposable-email/commit/4a4ac8f980604ef80b3ae6a542c70da233816390))
-* add Jest configuration and GitHub Actions workflow for CI, along with comprehensive tests for services and utilities ([e110b58](https://github.com/pirasanthan-jesugeevegan/temp-disposable-email/commit/e110b583b60f2d9f5c4c048535ea1e266ff93ae4))
-* add TypeScript dependency to package.json and package-lock.json ([f709340](https://github.com/pirasanthan-jesugeevegan/temp-disposable-email/commit/f709340ec77ad7900877c7c89ad36a4d654df73c))
-* add verification code extraction utility and update ignore files ([bd0f6a9](https://github.com/pirasanthan-jesugeevegan/temp-disposable-email/commit/bd0f6a9a82f8569f40b1d8e3826610359e41076c))
-* enhance message service by exporting additional interfaces and updating options parameter ([a161235](https://github.com/pirasanthan-jesugeevegan/temp-disposable-email/commit/a1612354648e611c43c449131569fc40b3ef508f))
-* implement message retrieval and deletion services with API integration ([d898bcf](https://github.com/pirasanthan-jesugeevegan/temp-disposable-email/commit/d898bcf01de4ba8ed5da4bf8aa23e669dc84e5db))
-* update GitHub Actions release workflow to use GITHUB_TOKEN instead of PA_TOKEN ([7d0cce7](https://github.com/pirasanthan-jesugeevegan/temp-disposable-email/commit/7d0cce7f462be80e8af81697138af5bad32c69e8))
-* update GitHub Actions workflow to support Node.js 18.x ([2f56cad](https://github.com/pirasanthan-jesugeevegan/temp-disposable-email/commit/2f56cad1e705b25e7b7555c8dd289605046b7920))
-* update release workflow to trigger on master branch ([79bc990](https://github.com/pirasanthan-jesugeevegan/temp-disposable-email/commit/79bc9909cc21a8e537886ae7cd77ed5a4f597d0a))
-* update release workflow to use PA_TOKEN for GitHub Actions ([d3e8883](https://github.com/pirasanthan-jesugeevegan/temp-disposable-email/commit/d3e888365ed55813db309ea7fd547d32ad373cf6))
+* change TypeScript module to 'nodenext' in tsconfig.json ([f62b842](https://github.com/pirasanthan-jesugeevegan/temp-disposable-email/commit/f62b842afe237c5c63a0931568ad46552f92d936))
+
+
+
+# [1.4.0](https://github.com/pirasanthan-jesugeevegan/temp-disposable-email/compare/v1.3.0...v1.4.0) (2024-11-28)
+
+
+### Features
+
+* update TypeScript target to ES6 in tsconfig.json ([0edc477](https://github.com/pirasanthan-jesugeevegan/temp-disposable-email/commit/0edc477af52df30c15b251239d6befcb757f2ed3))
+
+
+
+# [1.3.0](https://github.com/pirasanthan-jesugeevegan/temp-disposable-email/compare/v1.2.0...v1.3.0) (2024-11-28)
+
+
+### Features
+
+* update TypeScript configuration to use ESNext module and add skipLibCheck option ([0ffa53a](https://github.com/pirasanthan-jesugeevegan/temp-disposable-email/commit/0ffa53aa3851d622b3a0bad5b2024b797966be8d))
+
+
+
+# [1.2.0](https://github.com/pirasanthan-jesugeevegan/temp-disposable-email/compare/v1.1.0...v1.2.0) (2024-11-28)
+
+
+### Features
+
+* update main entry point to TypeScript source file ([3332c21](https://github.com/pirasanthan-jesugeevegan/temp-disposable-email/commit/3332c2147b825384ed52b068b95172f4fa3e94bd))
 
 
 

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { createInbox, deleteAccount } from './services/accountService';
+export { getRecentEmail, deleteMessage, MessageContent, GetEmailOptions, } from './services/messageService';
+export { getVerificationCode } from './utils/getVerificationCode';

package/dist/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getVerificationCode = exports.deleteMessage = exports.getRecentEmail = exports.deleteAccount = exports.createInbox = void 0;
+var accountService_1 = require("./services/accountService");
+Object.defineProperty(exports, "createInbox", { enumerable: true, get: function () { return accountService_1.createInbox; } });
+Object.defineProperty(exports, "deleteAccount", { enumerable: true, get: function () { return accountService_1.deleteAccount; } });
+var messageService_1 = require("./services/messageService");
+Object.defineProperty(exports, "getRecentEmail", { enumerable: true, get: function () { return messageService_1.getRecentEmail; } });
+Object.defineProperty(exports, "deleteMessage", { enumerable: true, get: function () { return messageService_1.deleteMessage; } });
+var getVerificationCode_1 = require("./utils/getVerificationCode");
+Object.defineProperty(exports, "getVerificationCode", { enumerable: true, get: function () { return getVerificationCode_1.getVerificationCode; } });

package/dist/services/accountService.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Creates a new email inbox with a unique address.
+ *
+ * This function selects an available domain, generates an email
+ * address, and attempts to create an account on the Mail.tm service.
+ * If account creation is rate-limited, the function retries with a
+ * delay. Upon successful creation, it authenticates the account and
+ * stores the token and account ID for future API calls.
+ *
+ * @param {string} [username] - Optional username; a random one is generated if not provided.
+ * @returns {Promise<string>} The generated email address.
+ *
+ * @throws {Error} If no domains are available or account creation fails.
+ *
+ * @example
+ * const email = await createInbox("customUser");
+ * console.log(email); // Outputs: "customUser@mail.tm"
+ */
+export declare const createInbox: (username?: string) => Promise<string>;
+/**
+ * Deletes the account created during `createInbox`.
+ *
+ * This function removes the email account from the Mail.tm service
+ * and clears the stored authentication token and account ID.
+ * Subsequent API calls requiring authentication will fail until a
+ * new account is created.
+ *
+ * @returns {Promise<void>} Resolves when the account is successfully deleted.
+ *
+ * @throws {Error} If no account is authenticated or deletion fails.
+ *
+ * @example
+ * await deleteAccount();
+ * console.log("Account deleted successfully.");
+ */
+export declare const deleteAccount: () => Promise<void>;

package/dist/services/accountService.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteAccount = exports.createInbox = void 0;
+const tslib_1 = require("tslib");
+const axios_1 = tslib_1.__importDefault(require("axios"));
+const authService_1 = require("./authService");
+const generateRandomName_1 = require("../utils/generateRandomName");
+const delay_1 = require("../utils/delay");
+const constant_1 = require("../utils/constant");
+let accountId = null;
+/**
+ * Creates a new email inbox with a unique address.
+ *
+ * This function selects an available domain, generates an email
+ * address, and attempts to create an account on the Mail.tm service.
+ * If account creation is rate-limited, the function retries with a
+ * delay. Upon successful creation, it authenticates the account and
+ * stores the token and account ID for future API calls.
+ *
+ * @param {string} [username] - Optional username; a random one is generated if not provided.
+ * @returns {Promise<string>} The generated email address.
+ *
+ * @throws {Error} If no domains are available or account creation fails.
+ *
+ * @example
+ * const email = await createInbox("customUser");
+ * console.log(email); // Outputs: "customUser@mail.tm"
+ */
+const createInbox = async (username) => {
+    const domainsResponse = await axios_1.default.get(`${constant_1.BASE_URL}/domains`, {
+        headers: { accept: 'application/ld+json' },
+    });
+    const domains = domainsResponse.data['hydra:member'].map((domain) => domain.domain);
+    if (domains.length === 0)
+        throw new Error('No available domains.');
+    const emailAddress = `${username || (0, generateRandomName_1.generateRandomName)()}@${domains[0]}`;
+    const password = (0, generateRandomName_1.generateRandomName)();
+    let attempts = 0;
+    const maxRetries = 5;
+    while (attempts < maxRetries) {
+        try {
+            const accountResponse = await axios_1.default.post(`${constant_1.BASE_URL}/accounts`, { address: emailAddress, password }, {
+                headers: {
+                    accept: 'application/json',
+                    'Content-Type': 'application/json',
+                },
+            });
+            accountId = accountResponse.data.id;
+            await (0, authService_1.authenticate)(emailAddress, password);
+            return emailAddress;
+        }
+        catch (error) {
+            if (error.response?.status === 429) {
+                attempts++;
+                const retryAfter = error.response.headers['retry-after']
+                    ? parseInt(error.response.headers['retry-after'])
+                    : 5;
+                await (0, delay_1.delay)(retryAfter * 1000);
+            }
+            else {
+                throw error;
+            }
+        }
+    }
+    throw new Error('Failed to create account after multiple retries.');
+};
+exports.createInbox = createInbox;
+/**
+ * Deletes the account created during `createInbox`.
+ *
+ * This function removes the email account from the Mail.tm service
+ * and clears the stored authentication token and account ID.
+ * Subsequent API calls requiring authentication will fail until a
+ * new account is created.
+ *
+ * @returns {Promise<void>} Resolves when the account is successfully deleted.
+ *
+ * @throws {Error} If no account is authenticated or deletion fails.
+ *
+ * @example
+ * await deleteAccount();
+ * console.log("Account deleted successfully.");
+ */
+const deleteAccount = async () => {
+    const token = (0, authService_1.getToken)();
+    if (!token || !accountId) {
+        throw new Error('Account information missing. Create and authenticate an account first.');
+    }
+    await axios_1.default.delete(`${constant_1.BASE_URL}/accounts/${accountId}`, {
+        headers: {
+            accept: '*/*',
+            Authorization: `Bearer ${token}`,
+        },
+    });
+    accountId = null;
+};
+exports.deleteAccount = deleteAccount;

package/dist/services/authService.d.ts

@@ -0,0 +1,2 @@
+export declare const authenticate: (email: string, password: string) => Promise<void>;
+export declare const getToken: () => string | null;

package/dist/services/authService.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getToken = exports.authenticate = void 0;
+const tslib_1 = require("tslib");
+const axios_1 = tslib_1.__importDefault(require("axios"));
+const constant_1 = require("../utils/constant");
+let token = null;
+const authenticate = async (email, password) => {
+    const response = await axios_1.default.post(`${constant_1.BASE_URL}/token`, { address: email, password }, {
+        headers: {
+            accept: 'application/json',
+            'Content-Type': 'application/json',
+        },
+    });
+    token = response.data.token;
+};
+exports.authenticate = authenticate;
+const getToken = () => token;
+exports.getToken = getToken;

package/dist/services/messageService.d.ts

@@ -0,0 +1,53 @@
+export interface MessageContent {
+    from: {
+        address: string;
+    };
+    to: {
+        address: string;
+    }[];
+    subject: string;
+    intro: string;
+    text: string;
+    html: string;
+}
+export interface GetEmailOptions {
+    maxWaitTime?: number;
+    waitInterval?: number;
+    logPolling?: boolean;
+    deleteAfterRead?: boolean;
+}
+/**
+ * Retrieves the latest message from the inbox.
+ *
+ * If messages are available, this function fetches the first one and
+ * returns its details. Polling options can be specified to wait for
+ * messages if the inbox is empty. Optionally, the message can be
+ * deleted after reading.
+ *
+ * @param {GetEmailOptions} [options] - Optional settings for polling and deletion.
+ * @returns {Promise<MessageContent | null>} The email content (sender, recipient, subject, text, HTML), or `null` if no messages are found.
+ *
+ * @throws {Error} If no messages are available within the polling timeout or authentication fails.
+ *
+ * @example
+ * const message = await getRecentEmail({ maxWaitTime: 5000, waitInterval: 1000, logPolling: true });
+ * console.log(message.subject); // Outputs: "Hello!"
+ */
+export declare const getRecentEmail: (options?: GetEmailOptions) => Promise<MessageContent | null>;
+/**
+ * Deletes a message by its unique ID from the Mail.tm inbox.
+ *
+ * This function requires a valid authentication token. If the
+ * token is not set, an error is thrown. The message is deleted
+ * using the Mail.tm API, and a success or failure message is logged.
+ *
+ * @param {string} messageId - The unique ID of the message to delete.
+ * @returns {Promise<void>} Resolves after the message is deleted.
+ *
+ * @throws {Error} If authentication is missing or the deletion fails.
+ *
+ * @example
+ * await deleteMessage("12345");
+ * console.log("Message deleted successfully.");
+ */
+export declare const deleteMessage: (messageId: string) => Promise<void>;

package/dist/services/messageService.js

@@ -0,0 +1,119 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteMessage = exports.getRecentEmail = void 0;
+const tslib_1 = require("tslib");
+const axios_1 = tslib_1.__importDefault(require("axios"));
+const authService_1 = require("./authService");
+const constant_1 = require("../utils/constant");
+const api_1 = require("../utils/api");
+/**
+ * Retrieves the latest message from the inbox.
+ *
+ * If messages are available, this function fetches the first one and
+ * returns its details. Polling options can be specified to wait for
+ * messages if the inbox is empty. Optionally, the message can be
+ * deleted after reading.
+ *
+ * @param {GetEmailOptions} [options] - Optional settings for polling and deletion.
+ * @returns {Promise<MessageContent | null>} The email content (sender, recipient, subject, text, HTML), or `null` if no messages are found.
+ *
+ * @throws {Error} If no messages are available within the polling timeout or authentication fails.
+ *
+ * @example
+ * const message = await getRecentEmail({ maxWaitTime: 5000, waitInterval: 1000, logPolling: true });
+ * console.log(message.subject); // Outputs: "Hello!"
+ */
+const getRecentEmail = async (options) => {
+    const token = (0, authService_1.getToken)();
+    const { maxWaitTime = 30000, waitInterval = 2000, logPolling = false, deleteAfterRead = false, } = options || {};
+    if (!token)
+        throw new Error('Authentication required. Call createInbox() first.');
+    if (!options) {
+        const messages = await (0, api_1.fetchMessages)();
+        if (messages.length === 0)
+            throw new Error('No messages available');
+        const messageId = messages[0].id;
+        const { from, to, subject, intro, text, html } = await (0, api_1.fetchMessageContent)(messageId);
+        if (deleteAfterRead) {
+            await (0, exports.deleteMessage)(messageId);
+        }
+        return {
+            from: from.address,
+            to: to[0].address,
+            subject,
+            intro,
+            text,
+            html,
+        };
+    }
+    const startTime = Date.now();
+    if (logPolling) {
+        console.log(`Polling started with a timeout of ${maxWaitTime / 1000}sec and interval of ${waitInterval / 1000}sec.`);
+    }
+    while (Date.now() - startTime < maxWaitTime) {
+        const messages = await (0, api_1.fetchMessages)();
+        if (messages.length > 0) {
+            if (logPolling) {
+                console.log(`Found ${messages.length} message(s), fetching details...`);
+            }
+            const messageId = messages[0].id;
+            if (logPolling) {
+                console.log(`Message retrieved: ${messageId}`);
+            }
+            const { from, to, subject, intro, text, html } = await (0, api_1.fetchMessageContent)(messageId);
+            if (deleteAfterRead) {
+                await (0, exports.deleteMessage)(messageId);
+            }
+            return {
+                from: from.address,
+                to: to[0].address,
+                subject,
+                intro,
+                text,
+                html,
+            };
+        }
+        await new Promise((resolve) => setTimeout(resolve, waitInterval));
+        if (logPolling) {
+            console.log(`No messages found, waiting for ${waitInterval / 1000} seconds...`);
+        }
+    }
+    if (logPolling) {
+        console.log(`Waiting timeout of ${maxWaitTime / 1000} seconds reached. No messages found.`);
+    }
+    throw new Error(`No messages available within ${maxWaitTime / 1000} seconds timeout`);
+};
+exports.getRecentEmail = getRecentEmail;
+/**
+ * Deletes a message by its unique ID from the Mail.tm inbox.
+ *
+ * This function requires a valid authentication token. If the
+ * token is not set, an error is thrown. The message is deleted
+ * using the Mail.tm API, and a success or failure message is logged.
+ *
+ * @param {string} messageId - The unique ID of the message to delete.
+ * @returns {Promise<void>} Resolves after the message is deleted.
+ *
+ * @throws {Error} If authentication is missing or the deletion fails.
+ *
+ * @example
+ * await deleteMessage("12345");
+ * console.log("Message deleted successfully.");
+ */
+const deleteMessage = async (messageId) => {
+    const token = (0, authService_1.getToken)();
+    if (!token)
+        throw new Error('Authentication required. Call createInbox() first.');
+    try {
+        await axios_1.default.delete(`${constant_1.BASE_URL}/messages/${messageId}`, {
+            headers: {
+                accept: '*/*',
+                Authorization: `Bearer ${token}`,
+            },
+        });
+    }
+    catch (error) {
+        console.error(`Failed to delete message with ID ${messageId}: ${error}`);
+    }
+};
+exports.deleteMessage = deleteMessage;

package/dist/utils/api.d.ts

@@ -0,0 +1,6 @@
+export declare const getAuthHeaders: () => {
+    accept: string;
+    Authorization: string;
+};
+export declare const fetchMessages: () => Promise<any[]>;
+export declare const fetchMessageContent: (messageId: string) => Promise<any>;

package/dist/utils/api.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchMessageContent = exports.fetchMessages = exports.getAuthHeaders = void 0;
+const tslib_1 = require("tslib");
+const axios_1 = tslib_1.__importDefault(require("axios"));
+const constant_1 = require("./constant");
+const authService_1 = require("../services/authService");
+const getAuthHeaders = () => {
+    const token = (0, authService_1.getToken)();
+    if (!token) {
+        throw new Error('Authentication required. Token not found.');
+    }
+    return {
+        accept: 'application/json',
+        Authorization: `Bearer ${token}`,
+    };
+};
+exports.getAuthHeaders = getAuthHeaders;
+const fetchMessages = async () => {
+    try {
+        const res = await axios_1.default.get(`${constant_1.BASE_URL}/messages`, {
+            headers: (0, exports.getAuthHeaders)(),
+        });
+        console.log(JSON.stringify(res.data));
+        return res.data;
+    }
+    catch (error) {
+        console.error('Error fetching messages:', error);
+        throw new Error('Failed to fetch messages. Please try again later.');
+    }
+};
+exports.fetchMessages = fetchMessages;
+const fetchMessageContent = async (messageId) => {
+    try {
+        const res = await axios_1.default.get(`${constant_1.BASE_URL}/messages/${messageId}`, {
+            headers: (0, exports.getAuthHeaders)(),
+        });
+        return res.data;
+    }
+    catch (error) {
+        console.error(`Error fetching message content for ID ${messageId}:`, error);
+        throw new Error('Failed to fetch message content. Please try again later.');
+    }
+};
+exports.fetchMessageContent = fetchMessageContent;

package/dist/utils/constant.d.ts

@@ -0,0 +1 @@
+export declare const BASE_URL: string;

package/dist/utils/constant.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BASE_URL = void 0;
+const tslib_1 = require("tslib");
+const dotenv = tslib_1.__importStar(require("dotenv"));
+dotenv.config();
+exports.BASE_URL = process.env?.['BASE_URL'] || '';

package/dist/utils/delay.d.ts

@@ -0,0 +1 @@
+export declare const delay: (ms: number) => Promise<void>;

package/dist/utils/delay.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.delay = void 0;
+const delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+exports.delay = delay;

package/dist/utils/generateRandomName.d.ts

@@ -0,0 +1 @@
+export declare const generateRandomName: () => string;

package/dist/utils/generateRandomName.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateRandomName = void 0;
+const generateRandomName = () => Math.random().toString(36).substring(2, 15);
+exports.generateRandomName = generateRandomName;

package/dist/utils/getVerificationCode.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Extracts a verification code from the provided email content.
+ *
+ * This function scans the given text for a sequence of 5 or more
+ * consecutive digits and returns the first valid verification code.
+ * If no valid sequence is found, the function returns `null`.
+ *
+ * @param {string} text - The content of the email, typically the body.
+ * @returns {Promise<string | null>} The first verification code found, or `null` if no valid code exists.
+ *
+ * @example
+ * const emailContent = "Your code is 123456.";
+ * const verificationCode = await getVerificationCode(emailContent);
+ * console.log(verificationCode); // Output: "123456"
+ */
+export declare const getVerificationCode: (text: string) => Promise<string | null>;

package/dist/utils/getVerificationCode.js

@@ -0,0 +1,28 @@
+"use strict";
+/**
+ * Extracts a verification code from the provided email content.
+ *
+ * This function scans the given text for a sequence of 5 or more
+ * consecutive digits and returns the first valid verification code.
+ * If no valid sequence is found, the function returns `null`.
+ *
+ * @param {string} text - The content of the email, typically the body.
+ * @returns {Promise<string | null>} The first verification code found, or `null` if no valid code exists.
+ *
+ * @example
+ * const emailContent = "Your code is 123456.";
+ * const verificationCode = await getVerificationCode(emailContent);
+ * console.log(verificationCode); // Output: "123456"
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getVerificationCode = void 0;
+const getVerificationCode = async (text) => {
+    console.log('Extracting the verification code from the email content...');
+    const matches = text.match(/\b\d{5,}\b/);
+    if (matches) {
+        return matches[0];
+    }
+    console.warn('No verification code found in the provided email content.');
+    return null;
+};
+exports.getVerificationCode = getVerificationCode;

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "temp-disposable-email",
-  "version": "1.2.0",
+  "version": "1.6.0",
   "description": "",
-  "main": "src/index.ts",
+  "type": "module",
+  "main": "dist/index.js",
   "scripts": {
     "build": "tsc",
     "test": "jest",
@@ -31,7 +32,8 @@
   "homepage": "https://github.com/pirasanthan-jesugeevegan/temp-disposable-email#readme",
   "dependencies": {
     "axios": "^1.7.8",
-    "dotenv": "^16.4.5"
+    "dotenv": "^16.4.5",
+    "tslib": "^2.8.1"
   },
   "devDependencies": {
     "@types/jest": "^29.5.14",

package/src/utils/constant.ts

@@ -1,4 +1,4 @@
 import * as dotenv from 'dotenv';
 dotenv.config();
 
-export const BASE_URL = process.env.BASE_URL;
+export const BASE_URL = process.env?.['BASE_URL'] || '';

package/tsconfig.json

@@ -1,12 +1,39 @@
 {
   "compilerOptions": {
-    "target": "ES6",
-    "module": "CommonJS",
+    "target": "ES2021",
+    "module": "commonjs",
     "declaration": true,
     "outDir": "./dist",
-    "strict": true,
-    "esModuleInterop": true,
-    "emitDeclarationOnly": true
+    "importHelpers": true,
+    "preserveValueImports": false,
+    "allowSyntheticDefaultImports": true /* Allow 'import x from y' when a module doesn't have a default export. */,
+    "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */,
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
+    /* Type Checking */
+    "strict": true /* Enable all strict type-checking options. */,
+    "noImplicitAny": false /* Enable error reporting for expressions and declarations with an implied `any` type.. */,
+    "strictNullChecks": true /* When type checking, take into account `null` and `undefined`. */,
+    "strictFunctionTypes": true /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */,
+    "strictBindCallApply": true /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */,
+    "strictPropertyInitialization": true /* Check for class properties that are declared but not set in the constructor. */,
+    "noImplicitThis": true /* Enable error reporting when `this` is given the type `any`. */,
+    "useUnknownInCatchVariables": true /* Type catch clause variables as 'unknown' instead of 'any'. */,
+    "alwaysStrict": true /* Ensure 'use strict' is always emitted. */,
+    "noUnusedLocals": true /* Enable error reporting when a local variables aren't read. */,
+    "noUnusedParameters": true /* Raise an error when a function parameter isn't read */,
+    "exactOptionalPropertyTypes": true /* Interpret optional property types as written, rather than adding 'undefined'. */,
+    "noImplicitReturns": true /* Enable error reporting for codepaths that do not explicitly return in a function. */,
+    "noFallthroughCasesInSwitch": true /* Enable error reporting for fallthrough cases in switch statements. */,
+    "noUncheckedIndexedAccess": true /* Include 'undefined' in index signature results */,
+    "noImplicitOverride": true /* Ensure overriding members in derived classes are marked with an override modifier. */,
+    "noPropertyAccessFromIndexSignature": true /* Enforces using indexed accessors for keys declared using an indexed type */,
+    "allowUnusedLabels": false /* Disable error reporting for unused labels. */,
+    "allowUnreachableCode": false /* Disable error reporting for unreachable code. */,
+
+    /* Completeness */
+    "skipDefaultLibCheck": true /* Skip type checking .d.ts files that are included with TypeScript. */,
+    "skipLibCheck": true /* Skip type checking all .d.ts files. */
   },
   "include": ["src/**/*"],
   "exclude": ["node_modules", "tests"]