mailisk 2.1.1 → 2.2.1

package/private/node_modules/typescript/package.json

@@ -0,0 +1,120 @@
+{
+    "name": "typescript",
+    "author": "Microsoft Corp.",
+    "homepage": "https://www.typescriptlang.org/",
+    "version": "5.9.3",
+    "license": "Apache-2.0",
+    "description": "TypeScript is a language for application scale JavaScript development",
+    "keywords": [
+        "TypeScript",
+        "Microsoft",
+        "compiler",
+        "language",
+        "javascript"
+    ],
+    "bugs": {
+        "url": "https://github.com/microsoft/TypeScript/issues"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/microsoft/TypeScript.git"
+    },
+    "main": "./lib/typescript.js",
+    "typings": "./lib/typescript.d.ts",
+    "bin": {
+        "tsc": "./bin/tsc",
+        "tsserver": "./bin/tsserver"
+    },
+    "engines": {
+        "node": ">=14.17"
+    },
+    "files": [
+        "bin",
+        "lib",
+        "!lib/enu",
+        "LICENSE.txt",
+        "README.md",
+        "SECURITY.md",
+        "ThirdPartyNoticeText.txt",
+        "!**/.gitattributes"
+    ],
+    "devDependencies": {
+        "@dprint/formatter": "^0.4.1",
+        "@dprint/typescript": "0.93.4",
+        "@esfx/canceltoken": "^1.0.0",
+        "@eslint/js": "^9.20.0",
+        "@octokit/rest": "^21.1.1",
+        "@types/chai": "^4.3.20",
+        "@types/diff": "^7.0.1",
+        "@types/minimist": "^1.2.5",
+        "@types/mocha": "^10.0.10",
+        "@types/ms": "^0.7.34",
+        "@types/node": "latest",
+        "@types/source-map-support": "^0.5.10",
+        "@types/which": "^3.0.4",
+        "@typescript-eslint/rule-tester": "^8.24.1",
+        "@typescript-eslint/type-utils": "^8.24.1",
+        "@typescript-eslint/utils": "^8.24.1",
+        "azure-devops-node-api": "^14.1.0",
+        "c8": "^10.1.3",
+        "chai": "^4.5.0",
+        "chokidar": "^4.0.3",
+        "diff": "^7.0.0",
+        "dprint": "^0.49.0",
+        "esbuild": "^0.25.0",
+        "eslint": "^9.20.1",
+        "eslint-formatter-autolinkable-stylish": "^1.4.0",
+        "eslint-plugin-regexp": "^2.7.0",
+        "fast-xml-parser": "^4.5.2",
+        "glob": "^10.4.5",
+        "globals": "^15.15.0",
+        "hereby": "^1.10.0",
+        "jsonc-parser": "^3.3.1",
+        "knip": "^5.44.4",
+        "minimist": "^1.2.8",
+        "mocha": "^10.8.2",
+        "mocha-fivemat-progress-reporter": "^0.1.0",
+        "monocart-coverage-reports": "^2.12.1",
+        "ms": "^2.1.3",
+        "picocolors": "^1.1.1",
+        "playwright": "^1.50.1",
+        "source-map-support": "^0.5.21",
+        "tslib": "^2.8.1",
+        "typescript": "^5.7.3",
+        "typescript-eslint": "^8.24.1",
+        "which": "^3.0.1"
+    },
+    "overrides": {
+        "typescript@*": "$typescript"
+    },
+    "scripts": {
+        "test": "hereby runtests-parallel --light=false",
+        "test:eslint-rules": "hereby run-eslint-rules-tests",
+        "build": "npm run build:compiler && npm run build:tests",
+        "build:compiler": "hereby local",
+        "build:tests": "hereby tests",
+        "build:tests:notypecheck": "hereby tests --no-typecheck",
+        "clean": "hereby clean",
+        "gulp": "hereby",
+        "lint": "hereby lint",
+        "knip": "hereby knip",
+        "format": "dprint fmt",
+        "setup-hooks": "node scripts/link-hooks.mjs"
+    },
+    "browser": {
+        "fs": false,
+        "os": false,
+        "path": false,
+        "crypto": false,
+        "buffer": false,
+        "source-map-support": false,
+        "inspector": false,
+        "perf_hooks": false
+    },
+    "packageManager": "npm@8.19.4",
+    "volta": {
+        "node": "20.1.0",
+        "npm": "8.19.4"
+    },
+    "gitHead": "c63de15a992d37f0d6cec03ac7631872838602cb"
+}

package/private/package-lock.json

@@ -0,0 +1,53 @@
+{
+  "name": "private",
+  "version": "1.0.0",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "private",
+      "version": "1.0.0",
+      "license": "ISC",
+      "dependencies": {
+        "mailisk": "file:..",
+        "typescript": "^5.9.3"
+      }
+    },
+    "..": {
+      "name": "mailisk",
+      "version": "2.1.1",
+      "license": "ISC",
+      "dependencies": {
+        "axios": "^1.1.2",
+        "nodemailer": "^6.8.0"
+      },
+      "devDependencies": {
+        "@types/jest": "^29.5.14",
+        "@types/nodemailer": "^6.4.6",
+        "dotenv": "^16.4.7",
+        "jest": "^29.7.0",
+        "jest-mock-axios": "^4.8.0",
+        "ts-jest": "^29.2.6",
+        "tsup": "^6.2.3",
+        "typescript": "^4.9.5"
+      }
+    },
+    "node_modules/mailisk": {
+      "resolved": "..",
+      "link": true
+    },
+    "node_modules/typescript": {
+      "version": "5.9.3",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.9.3.tgz",
+      "integrity": "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw==",
+      "license": "Apache-2.0",
+      "bin": {
+        "tsc": "bin/tsc",
+        "tsserver": "bin/tsserver"
+      },
+      "engines": {
+        "node": ">=14.17"
+      }
+    }
+  }
+}

package/private/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "private",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "start": "tsc && node dist/private/index.js"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "type": "commonjs",
+  "dependencies": {
+    "mailisk": "file:..",
+    "typescript": "^5.9.3"
+  }
+}

package/private/tsconfig.json

@@ -0,0 +1,103 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "commonjs" /* Specify what module code is generated. */,
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    "sourceMap": true /* Create source map files for emitted JavaScript files. */,
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    "outDir": "./dist" /* Specify an output folder for all emitted files. */,
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "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": true,                            /* 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,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when 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,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "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": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* 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. */
+  }
+}

package/src/mailisk.interfaces.ts

@@ -49,6 +49,42 @@ export interface Email {
   attachments?: EmailAttachment[];
 }
 
+export interface SmsMessage {
+  /** Unique identifier for the message */
+  id: string;
+  /** Unique identifier for the SMS phone number */
+  sms_phone_number_id: string;
+  /** Body of the message */
+  body: string;
+  /** From number of the message */
+  from_number: string;
+  /** To number of the message */
+  to_number: string;
+  /** Provider message ID */
+  provider_message_id?: string;
+  /** Date and time the message was created */
+  created_at: string;
+  /** Direction of the message */
+  direction: "inbound" | "outbound";
+}
+
+export interface SmsNumber {
+  /** Unique identifier for the SMS number */
+  id: string;
+  /** Unique identifier for the organisation */
+  organisation_id: string;
+  /** Status of the SMS number */
+  status: "requested" | "active" | "disabled";
+  /** Country of the SMS number */
+  country: string;
+  /** SMS Phone number */
+  phone_number?: string;
+  /** Date and time the SMS number was created */
+  created_at: string;
+  /** Date and time the SMS number was updated */
+  updated_at: string;
+}
+
 export interface SearchInboxParams {
   /**
    * The maximum number of emails that can be returned in this request, used alongside `offset` for pagination.
@@ -128,12 +164,8 @@ export interface GetAttachmentResponse {
 }
 
 export interface ListNamespacesResponse {
-  data: [
-    {
-      id: string;
-      namespace: string;
-    }
-  ];
+  total_count: number;
+  data: { id: string; namespace: string }[];
 }
 
 export interface SendVirtualEmailParams {
@@ -156,3 +188,56 @@ export interface SendVirtualEmailParams {
   /** Attachments to the email */
   attachments?: Attachment[];
 }
+
+export interface SearchSmsMessagesParams {
+  /**
+   * The maximum number of SMS messages returned (1-100), used alongside `offset` for pagination.
+   */
+  limit?: number;
+  /**
+   * The number of SMS messages to skip/ignore, used alongside `limit` for pagination.
+   */
+  offset?: number;
+  /**
+   * Filter messages by body contents (case insensitive).
+   */
+  body?: string;
+  /**
+   * Filter messages by sender phone number prefix.
+   */
+  from_number?: string;
+  /**
+   * Filter messages created on or after this date.
+   * Provide an ISO 8601 timestamp string.
+   */
+  from_date?: string;
+  /**
+   * Filter messages created on or before this date.
+   * Provide an ISO 8601 timestamp string.
+   */
+  to_date?: string;
+  /**
+   * When true, keep the request open until at least one SMS is returned.
+   */
+  wait?: boolean;
+}
+
+export interface SearchSmsMessagesResponse {
+  total_count: number;
+  options: SearchSmsMessagesParams;
+  data: SmsMessage[];
+}
+
+export interface ListSmsNumbersResponse {
+  total_count: number;
+  data: SmsNumber[];
+}
+
+export interface SendVirtualSmsParams {
+  /** The phone number to send the SMS from */
+  from_number: string;
+  /** The phone number to send the SMS to */
+  to_number: string;
+  /** The body of the SMS message */
+  body: string;
+}

package/src/mailisk.ts

@@ -1,10 +1,14 @@
-import axios, { AxiosBasicCredentials, AxiosRequestConfig } from "axios";
+import axios, { AxiosBasicCredentials, AxiosInstance, AxiosRequestConfig } from "axios";
 import {
   GetAttachmentResponse,
   ListNamespacesResponse,
+  ListSmsNumbersResponse,
   SearchInboxParams,
   SearchInboxResponse,
+  SearchSmsMessagesParams,
+  SearchSmsMessagesResponse,
   SendVirtualEmailParams,
+  SendVirtualSmsParams,
   SmtpSettings,
 } from "./mailisk.interfaces";
 import nodemailer from "nodemailer";
@@ -20,7 +24,75 @@ export class MailiskClient {
     });
   }
 
-  private readonly axiosInstance;
+  private readonly axiosInstance: AxiosInstance;
+
+  /**
+   * Search SMS messages sent to a phone number.
+   *
+   * @example
+   * Search for SMS messages sent to a phone number
+   * ```typescript
+   * const { data: smsMessages } = await client.searchSmsMessages("1234567890");
+   * ```
+   */
+  async searchSmsMessages(
+    phoneNumber: string,
+    params?: SearchSmsMessagesParams,
+    config?: AxiosRequestConfig
+  ): Promise<SearchSmsMessagesResponse> {
+    let _params: SearchSmsMessagesParams = { ...params };
+
+    // default from timestamp, 15 minutes before starting this request
+    if (params?.from_date === undefined || params?.from_date === null) {
+      _params.from_date = new Date(Date.now() - 15 * 60 * 1000).toISOString();
+    }
+
+    // by default wait for sms
+    if (params?.wait !== false) {
+      _params.wait = true;
+    }
+
+    let _config = { ...config };
+
+    if (config?.maxRedirects === undefined) {
+      _config.maxRedirects = 99999;
+    }
+
+    // by default, wait 5 minutes for emails before timing out
+    if (_params.wait && config?.timeout === undefined) {
+      _config.timeout = 1000 * 60 * 5;
+    }
+
+    const requestParams = {
+      ..._params,
+      from_date: _params.from_date ?? undefined,
+      to_date: _params.to_date ?? undefined,
+    };
+
+    return (
+      await this.axiosInstance.get(`api/sms/${phoneNumber}/messages`, {
+        ..._config,
+        params: requestParams,
+      })
+    ).data;
+  }
+
+  /**
+   * List all SMS phone numbers associated with the current account.
+   *
+   * @example
+   * List all SMS phone numbers
+   * ```typescript
+   * const { data: smsNumbers } = await client.listSmsNumbers();
+   * ```
+   */
+  async listSmsNumbers(): Promise<ListSmsNumbersResponse> {
+    return (await this.axiosInstance.get("api/sms/numbers")).data;
+  }
+
+  async sendVirtualSms(params: SendVirtualSmsParams): Promise<void> {
+    return (await this.axiosInstance.post("api/sms/virtual", params)).data;
+  }
 
   /**
    * List all namespaces that belong to the current account (API key).
@@ -77,12 +149,12 @@ export class MailiskClient {
    * Search inbox of a namespace.
    *
    * By default, this calls the api using the `wait` flag. This means the call won't timeout until at least one email is received or 5 minutes pass.
-   * It also uses a default `from_timestamp` of **current timestamp - 5 seconds**. This means that older emails will be ignored.
+   * It also uses a default `from_timestamp` of **current timestamp - 15 minutes**. This means that older emails will be ignored.
    *
    * Both of these settings can be overriden by passing them in the `params` object.
    *
    * @example
-   * Get the latest emails in the namespace
+   * Get the latest emails
    * ```typescript
    * const { data: emails } = await client.searchInbox(namespace);
    * ```
@@ -91,7 +163,17 @@ export class MailiskClient {
    * Get the latest emails for a specific email address
    * ```typescript
    * const { data: emails } = await client.searchInbox(namespace, {
-   *  to_addr_prefix: 'john@mynamespace.mailisk.net'
+   *   to_addr_prefix: 'john@mynamespace.mailisk.net'
+   * });
+   * ```
+   *
+   * @example
+   * Get the last 20 emails in the namespace
+   * ```typescript
+   * const { data: emails } = await mailisk.searchInbox(namespace, {
+   *   wait: false,
+   *   from_timestamp: 0,
+   *   limit: 20
    * });
    * ```
    */
@@ -114,12 +196,12 @@ export class MailiskClient {
 
     let _config = { ...config };
 
-    if (!config?.maxRedirects) {
+    if (config?.maxRedirects === undefined) {
       _config.maxRedirects = 99999;
     }
 
     // by default, wait 5 minutes for emails before timing out
-    if (_params.wait && !config?.timeout) {
+    if (_params.wait && config?.timeout === undefined) {
       _config.timeout = 1000 * 60 * 5;
     }