tnzapi-ts 3.0.0

package/dist/Functions/FileHandler.d.ts

@@ -0,0 +1,6 @@
+declare const FileHandler: {
+    fileExists: (file: string) => boolean;
+    getFileData: (file: string) => Promise<string>;
+    getBaseName: (file: string) => string;
+};
+export default FileHandler;

package/dist/Functions/FileHandler.js

@@ -0,0 +1,57 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs = __importStar(require("fs"));
+const util = __importStar(require("util"));
+const path = __importStar(require("path"));
+const read = util.promisify(fs.readFile);
+const FileHandler = {
+    fileExists: (file) => {
+        try {
+            return fs.existsSync(file);
+        }
+        catch (err) {
+            console.error(err);
+            return false;
+        }
+    },
+    getFileData: async (file) => {
+        return (await read(file)).toString("base64");
+    },
+    getBaseName: (file) => {
+        return path.basename(file);
+    }
+};
+exports.default = FileHandler;

package/dist/Functions/HttpRequest.d.ts

@@ -0,0 +1,10 @@
+interface HostDetails {
+    Port: number;
+    Host: string;
+    Path: string;
+    Protocol: string;
+}
+export declare const GetHostDetails: (url: string) => HostDetails | undefined;
+export declare const HttpRequest: (url: string, payload: any, authToken: string, method: string, callback: (data: any) => void) => void;
+export declare const HttpRequestAsync: (url: string, payload: any, authToken: string, method: string) => Promise<any>;
+export {};

package/dist/Functions/HttpRequest.js

@@ -0,0 +1,156 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpRequestAsync = exports.HttpRequest = exports.GetHostDetails = void 0;
+const https = __importStar(require("https"));
+const http = __importStar(require("http"));
+const UsefulStuff_1 = require("./UsefulStuff");
+const sslIgnoreAgent = new https.Agent({ rejectUnauthorized: false });
+const GetHostDetails = (url) => {
+    try {
+        const parsed = new URL(url);
+        const protocol = parsed.protocol.replace(':', ''); // 'https' or 'http'
+        if (protocol !== 'https' && protocol !== 'http') {
+            return undefined;
+        }
+        const defaultPort = protocol === 'https' ? 443 : 80;
+        return {
+            Host: parsed.hostname,
+            Port: parsed.port ? parseInt(parsed.port, 10) : defaultPort,
+            Path: parsed.pathname + parsed.search,
+            Protocol: protocol,
+        };
+    }
+    catch {
+        return undefined;
+    }
+};
+exports.GetHostDetails = GetHostDetails;
+const request = (options, callback) => {
+    const requester = options.protocol === 'https:' ? https.request : http.request;
+    return requester(options, (res) => {
+        let data = '';
+        res.setEncoding('utf8');
+        res.on('data', (chunk) => {
+            data += chunk;
+        });
+        res.on('end', () => {
+            try {
+                if (res.statusCode && (res.statusCode < 200 || res.statusCode >= 300)) {
+                    try {
+                        callback({ HttpStatusCode: res.statusCode, ...JSON.parse(data) });
+                    }
+                    catch {
+                        callback({ HttpStatusCode: res.statusCode, Result: "Error", ErrorMessage: [`Request failed with status code ${res.statusCode}: ${data}`] });
+                    }
+                }
+                else if (data === '') {
+                    callback({ HttpStatusCode: res.statusCode, Result: "Success" });
+                }
+                else {
+                    callback({ HttpStatusCode: res.statusCode, ...JSON.parse(data) });
+                }
+            }
+            catch (error) {
+                callback(null, new Error('Failed to parse response as JSON: ' + error.message));
+            }
+        });
+        res.on('error', (err) => {
+            callback(null, err);
+        });
+    });
+};
+const HttpRequest = (url, payload, authToken, method, callback) => {
+    const host = (0, exports.GetHostDetails)(url);
+    if (!host) {
+        callback({ Result: "Error", ErrorMessage: ["Invalid URL"] });
+        return;
+    }
+    const isGet = method.toUpperCase() === 'GET';
+    const postData = isGet ? '' : JSON.stringify(payload);
+    const headers = {
+        'Content-Type': 'application/json',
+        'Accept': 'application/json',
+        'Authorization': !(0, UsefulStuff_1.isEmpty)(authToken) ? `Bearer ${authToken}` : "",
+        'User-Agent': 'tnzapi-nodejs-ts/3.00'
+    };
+    if (!isGet) {
+        headers['Content-Length'] = Buffer.byteLength(postData, 'utf8');
+    }
+    const options = {
+        hostname: host.Host,
+        port: host.Port,
+        path: host.Path,
+        method: method,
+        protocol: `${host.Protocol}:`,
+        headers: headers,
+        ...(host.Protocol === 'https' && process.env.TNZ_IGNORE_SSL === 'true'
+            ? { agent: sslIgnoreAgent }
+            : {})
+    };
+    let callbackCalled = false;
+    const safeCallback = (data) => {
+        if (!callbackCalled) {
+            callbackCalled = true;
+            callback(data);
+        }
+    };
+    const req = request(options, (responseData, err) => {
+        if (err) {
+            safeCallback({ Result: "Error", ErrorMessage: [err.message] });
+            return;
+        }
+        safeCallback(responseData);
+    });
+    req.setTimeout(30000, () => {
+        req.destroy(new Error('Request timed out'));
+    });
+    req.on('error', (error) => {
+        safeCallback({ Result: "Error", ErrorMessage: [error.message] });
+    });
+    if (!isGet) {
+        req.write(postData);
+    }
+    req.end();
+};
+exports.HttpRequest = HttpRequest;
+const HttpRequestAsync = (url, payload, authToken, method) => {
+    return new Promise((resolve, reject) => {
+        (0, exports.HttpRequest)(url, payload, authToken, method, (data) => {
+            resolve(data);
+        });
+    });
+};
+exports.HttpRequestAsync = HttpRequestAsync;

package/dist/Functions/Mapper.d.ts

@@ -0,0 +1 @@
+export declare const Map: <T extends object>(obj: T, data: Partial<T> | object) => void;

package/dist/Functions/Mapper.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Map = void 0;
+const UsefulStuff_1 = require("./UsefulStuff");
+const Map = (obj, data) => {
+    if ((0, UsefulStuff_1.isEmpty)(data) || typeof obj !== 'object' || obj === null || typeof data !== 'object' || data === null) {
+        return;
+    }
+    for (const name in data) {
+        if (Object.prototype.hasOwnProperty.call(data, name)) {
+            const sourceProp = data[name];
+            const destProp = obj[name];
+            if (typeof sourceProp === 'object' && sourceProp !== null && !Array.isArray(sourceProp) &&
+                typeof destProp === 'object' && destProp !== null && !Array.isArray(destProp)) {
+                (0, exports.Map)(destProp, sourceProp);
+            }
+            else {
+                obj[name] = sourceProp;
+            }
+        }
+    }
+};
+exports.Map = Map;

package/dist/Functions/UsefulStuff.d.ts

@@ -0,0 +1,20 @@
+export declare function replaceAll(str: string, find: string, replace: string): string;
+export declare const isEmpty: (obj: any) => boolean;
+export declare const isEmail: (str: string) => boolean;
+export declare const isNumber: (num: any) => boolean;
+export declare const isDateTime: (date: string) => boolean;
+export declare const isPhoneNumber: (num: string) => boolean;
+export declare const isMobileNumber: (num: string) => boolean;
+/**
+ * Formats a phone number (landline or mobile) to E.164 numeric-only format.
+ * Attempts to parse as NZ first, then AU, then international.
+ * Returns an empty string if the number cannot be parsed as a valid number.
+ */
+export declare const formatPhoneNumber: (requested_number: string) => string;
+/**
+ * Formats a mobile number to E.164 numeric-only format.
+ * Attempts to parse as NZ first, then AU, then international.
+ * Returns an empty string if the number cannot be parsed as a valid mobile number.
+ */
+export declare const formatMobileNumber: (requested_number: string) => string;
+export declare const httpBuildQuery: (data: any) => string;

package/dist/Functions/UsefulStuff.js

@@ -0,0 +1,136 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.httpBuildQuery = exports.formatMobileNumber = exports.formatPhoneNumber = exports.isMobileNumber = exports.isPhoneNumber = exports.isDateTime = exports.isNumber = exports.isEmail = exports.isEmpty = void 0;
+exports.replaceAll = replaceAll;
+const google_libphonenumber_1 = require("google-libphonenumber");
+const phoneUtil = google_libphonenumber_1.PhoneNumberUtil.getInstance();
+function replaceAll(str, find, replace) {
+    return str.split(find).join(replace);
+}
+const isEmpty = (obj) => {
+    if (typeof obj === 'undefined' || obj === null || obj === '' || obj.length <= 0) {
+        return true;
+    }
+    return false;
+};
+exports.isEmpty = isEmpty;
+const isEmail = (str) => {
+    if (!str) {
+        return false;
+    }
+    const r = /^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$/;
+    return r.test(str);
+};
+exports.isEmail = isEmail;
+const isNumber = (num) => {
+    return typeof num === "number" && !isNaN(num);
+};
+exports.isNumber = isNumber;
+const isDateTime = (date) => {
+    if (!date) {
+        return false;
+    }
+    // Require at minimum YYYY-MM-DD prefix — prevents bare numbers like "2024" or "3"
+    if (!/^\d{4}-\d{2}-\d{2}/.test(date)) {
+        return false;
+    }
+    const testDate = new Date(date);
+    return testDate.toString() !== "Invalid Date";
+};
+exports.isDateTime = isDateTime;
+const isPhoneNumber = (num) => {
+    const phoneNumber = (0, exports.formatPhoneNumber)(num);
+    return !(0, exports.isEmpty)(phoneNumber);
+};
+exports.isPhoneNumber = isPhoneNumber;
+const isMobileNumber = (num) => {
+    const mobileNumber = (0, exports.formatMobileNumber)(num);
+    return !(0, exports.isEmpty)(mobileNumber);
+};
+exports.isMobileNumber = isMobileNumber;
+/**
+ * Formats a phone number (landline or mobile) to E.164 numeric-only format.
+ * Attempts to parse as NZ first, then AU, then international.
+ * Returns an empty string if the number cannot be parsed as a valid number.
+ */
+const formatPhoneNumber = (requested_number) => {
+    if (!requested_number) {
+        return "";
+    }
+    // Try NZ first, then AU, then treat as international (with leading +)
+    const candidateRegions = ['NZ', 'AU'];
+    for (const region of candidateRegions) {
+        try {
+            const parsed = phoneUtil.parse(requested_number, region);
+            if (phoneUtil.isValidNumber(parsed)) {
+                // Return E.164 without the leading '+'
+                return phoneUtil.format(parsed, google_libphonenumber_1.PhoneNumberFormat.E164).replace(/^\+/, '');
+            }
+        }
+        catch {
+            // try next region
+        }
+    }
+    // Attempt as an already-international number (e.g. +44...)
+    try {
+        const parsed = phoneUtil.parse(requested_number);
+        if (phoneUtil.isValidNumber(parsed)) {
+            return phoneUtil.format(parsed, google_libphonenumber_1.PhoneNumberFormat.E164).replace(/^\+/, '');
+        }
+    }
+    catch {
+        // fall through
+    }
+    return "";
+};
+exports.formatPhoneNumber = formatPhoneNumber;
+/**
+ * Formats a mobile number to E.164 numeric-only format.
+ * Attempts to parse as NZ first, then AU, then international.
+ * Returns an empty string if the number cannot be parsed as a valid mobile number.
+ */
+const formatMobileNumber = (requested_number) => {
+    if ((0, exports.isEmpty)(requested_number)) {
+        return "";
+    }
+    const candidateRegions = ['NZ', 'AU'];
+    for (const region of candidateRegions) {
+        try {
+            const parsed = phoneUtil.parse(requested_number, region);
+            if (phoneUtil.isValidNumber(parsed)) {
+                const numberType = phoneUtil.getNumberType(parsed);
+                // PhoneNumberType.MOBILE = 1, FIXED_LINE_OR_MOBILE = 2
+                if (numberType === 1 || numberType === 2) {
+                    return phoneUtil.format(parsed, google_libphonenumber_1.PhoneNumberFormat.E164).replace(/^\+/, '');
+                }
+            }
+        }
+        catch {
+            // try next region
+        }
+    }
+    // Attempt as an already-international number
+    try {
+        const parsed = phoneUtil.parse(requested_number);
+        if (phoneUtil.isValidNumber(parsed)) {
+            const numberType = phoneUtil.getNumberType(parsed);
+            if (numberType === 1 || numberType === 2) {
+                return phoneUtil.format(parsed, google_libphonenumber_1.PhoneNumberFormat.E164).replace(/^\+/, '');
+            }
+        }
+    }
+    catch {
+        // fall through
+    }
+    return "";
+};
+exports.formatMobileNumber = formatMobileNumber;
+const httpBuildQuery = (data) => {
+    return Object.keys(data).map((key) => {
+        if (Array.isArray(data[key])) {
+            return `${encodeURIComponent(key)}=${encodeURIComponent(data[key].map((item) => item).join(','))}`;
+        }
+        return `${encodeURIComponent(key)}=${encodeURIComponent(data[key])}`;
+    }).join('&');
+};
+exports.httpBuildQuery = httpBuildQuery;

package/dist/Functions/index.d.ts

@@ -0,0 +1,5 @@
+import { HttpRequest, HttpRequestAsync } from "./HttpRequest";
+import FileHandler from "./FileHandler";
+import * as UsefulStuff from "./UsefulStuff";
+import { Map } from "./Mapper";
+export { HttpRequest, HttpRequestAsync, FileHandler, UsefulStuff, Map };

package/dist/Functions/index.js

@@ -0,0 +1,48 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Map = exports.UsefulStuff = exports.FileHandler = exports.HttpRequestAsync = exports.HttpRequest = void 0;
+const HttpRequest_1 = require("./HttpRequest");
+Object.defineProperty(exports, "HttpRequest", { enumerable: true, get: function () { return HttpRequest_1.HttpRequest; } });
+Object.defineProperty(exports, "HttpRequestAsync", { enumerable: true, get: function () { return HttpRequest_1.HttpRequestAsync; } });
+const FileHandler_1 = __importDefault(require("./FileHandler"));
+exports.FileHandler = FileHandler_1.default;
+const UsefulStuff = __importStar(require("./UsefulStuff"));
+exports.UsefulStuff = UsefulStuff;
+const Mapper_1 = require("./Mapper");
+Object.defineProperty(exports, "Map", { enumerable: true, get: function () { return Mapper_1.Map; } });

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+import { Messaging } from './Api/Messaging';
+import { Reports } from './Api/Reports';
+import { Actions } from './Api/Actions';
+import { Addressbook } from './Api/Addressbook';
+import { OptOut } from './Api/OptOut';
+import { ITNZAuthArgs } from './interfaces';
+export * from './Common/enums/MessagingEnums';
+export { ErrorResponseDTO } from './Common/dtos';
+export type { ITNZAuthArgs };
+export declare class TNZAPI {
+    Messaging: Messaging;
+    Reports: Reports;
+    Actions: Actions;
+    Addressbook: Addressbook;
+    OptOut: OptOut;
+    constructor(args?: ITNZAuthArgs);
+}

package/dist/index.js

@@ -0,0 +1,43 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TNZAPI = exports.ErrorResponseDTO = void 0;
+const Messaging_1 = require("./Api/Messaging");
+const Reports_1 = require("./Api/Reports");
+const Actions_1 = require("./Api/Actions");
+const Addressbook_1 = require("./Api/Addressbook");
+const OptOut_1 = require("./Api/OptOut");
+__exportStar(require("./Common/enums/MessagingEnums"), exports);
+var dtos_1 = require("./Common/dtos");
+Object.defineProperty(exports, "ErrorResponseDTO", { enumerable: true, get: function () { return dtos_1.ErrorResponseDTO; } });
+class TNZAPI {
+    constructor(args) {
+        const authToken = args?.AuthToken || process.env.TNZ_AUTH_TOKEN;
+        if (!authToken) {
+            throw new Error('TNZ AuthToken is required. Pass it as AuthToken or set the TNZ_AUTH_TOKEN environment variable.');
+        }
+        const authArgs = {
+            AuthToken: authToken,
+            URL: args?.URL || process.env.TNZ_API_URL || "https://api.tnz.co.nz/api/v3.00"
+        };
+        this.Messaging = new Messaging_1.Messaging(authArgs);
+        this.Reports = new Reports_1.Reports(authArgs);
+        this.Actions = new Actions_1.Actions(authArgs);
+        this.Addressbook = new Addressbook_1.Addressbook(authArgs);
+        this.OptOut = new OptOut_1.OptOut(authArgs);
+    }
+}
+exports.TNZAPI = TNZAPI;

package/dist/interfaces.d.ts

@@ -0,0 +1,4 @@
+export interface ITNZAuthArgs {
+    AuthToken?: string;
+    URL?: string;
+}

package/dist/interfaces.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "tnzapi-ts",
+  "version": "3.0.0",
+  "description": "TypeScript Library for TNZ Group REST API v3.00 — SMS, Email, Fax, TTS, Voice, WhatsApp, Workflow, Addressbook, Opt-Out",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/tnzgroup/tnzapi-ts.git"
+  },
+  "bugs": {
+    "url": "https://github.com/tnzgroup/tnzapi-ts/issues"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "jest",
+    "test:unit": "jest --selectProjects unit",
+    "test:integration": "jest --selectProjects integration"
+  },
+  "keywords": [
+    "tnzapi",
+    "email",
+    "sms",
+    "fax",
+    "tts",
+    "voice",
+    "typescript"
+  ],
+  "author": "TNZ Group Limited",
+  "license": "MIT",
+  "homepage": "https://www.tnz.co.nz",
+  "devDependencies": {
+    "@types/google-libphonenumber": "^7.4.30",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^20.12.12",
+    "dotenv": "^17.2.2",
+    "jest": "^30.1.3",
+    "ts-jest": "^29.4.1",
+    "typescript": "^5.4.5"
+  },
+  "dependencies": {
+    "google-libphonenumber": "^3.2.44"
+  }
+}