@onesignal/node-onesignal 5.7.0 → 5.9.0

package/dist/apis/baseapi.js

@@ -1,19 +1,4 @@
 "use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RequiredError = exports.BaseAPIRequestFactory = exports.COLLECTION_FORMATS = void 0;
 exports.COLLECTION_FORMATS = {
@@ -22,25 +7,21 @@ exports.COLLECTION_FORMATS = {
     tsv: "\t",
     pipes: "|",
 };
-var BaseAPIRequestFactory = (function () {
-    function BaseAPIRequestFactory(configuration) {
+class BaseAPIRequestFactory {
+    constructor(configuration) {
         this.configuration = configuration;
     }
-    return BaseAPIRequestFactory;
-}());
+}
 exports.BaseAPIRequestFactory = BaseAPIRequestFactory;
 ;
-var RequiredError = (function (_super) {
-    __extends(RequiredError, _super);
-    function RequiredError(api, method, field) {
-        var _this = _super.call(this, "Required parameter " + field + " was null or undefined when calling " + api + "." + method + ".") || this;
-        _this.api = api;
-        _this.method = method;
-        _this.field = field;
-        _this.name = "RequiredError";
-        return _this;
+class RequiredError extends Error {
+    constructor(api, method, field) {
+        super("Required parameter " + field + " was null or undefined when calling " + api + "." + method + ".");
+        this.api = api;
+        this.method = method;
+        this.field = field;
+        this.name = "RequiredError";
     }
-    return RequiredError;
-}(Error));
+}
 exports.RequiredError = RequiredError;
 //# sourceMappingURL=baseapi.js.map

package/dist/apis/exception.d.ts

@@ -7,4 +7,5 @@ export declare class ApiException<T> extends Error {
     constructor(code: number, message: string, body: T, headers: {
         [key: string]: string;
     });
+    get errorMessages(): string[];
 }

package/dist/apis/exception.js

@@ -1,32 +1,58 @@
 "use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiException = void 0;
-var ApiException = (function (_super) {
-    __extends(ApiException, _super);
-    function ApiException(code, message, body, headers) {
-        var _this = _super.call(this, "HTTP-Code: " + code + "\nMessage: " + message + "\nBody: " + JSON.stringify(body) + "\nHeaders: " +
-            JSON.stringify(headers)) || this;
-        _this.code = code;
-        _this.body = body;
-        _this.headers = headers;
-        return _this;
+class ApiException extends Error {
+    constructor(code, message, body, headers) {
+        super("HTTP-Code: " + code + "\nMessage: " + message + "\nBody: " + JSON.stringify(body) + "\nHeaders: " +
+            JSON.stringify(headers));
+        this.code = code;
+        this.body = body;
+        this.headers = headers;
+        Object.setPrototypeOf(this, ApiException.prototype);
     }
-    return ApiException;
-}(Error));
+    get errorMessages() {
+        let parsed = this.body;
+        if (typeof parsed === "string") {
+            try {
+                parsed = JSON.parse(parsed);
+            }
+            catch {
+                return [];
+            }
+        }
+        if (parsed === null || typeof parsed !== "object") {
+            return [];
+        }
+        const errors = parsed.errors;
+        if (typeof errors === "string") {
+            return [errors];
+        }
+        if (Array.isArray(errors)) {
+            return errors
+                .map((e) => {
+                if (typeof e === "string") {
+                    return e;
+                }
+                if (e !== null && typeof e === "object") {
+                    const title = typeof e.title === "string" ? e.title : undefined;
+                    const code = typeof e.code === "string" ? e.code : (e.code != null ? String(e.code) : undefined);
+                    return title || code;
+                }
+                return undefined;
+            })
+                .filter((m) => typeof m === "string");
+        }
+        if (errors !== null && typeof errors === "object") {
+            return Object.keys(errors)
+                .map((key) => {
+                const value = errors[key];
+                const rendered = typeof value === "string" ? value : JSON.stringify(value);
+                return key + ": " + rendered;
+            })
+                .sort();
+        }
+        return [];
+    }
+}
 exports.ApiException = ApiException;
 //# sourceMappingURL=exception.js.map

package/dist/auth/auth.js

@@ -1,98 +1,32 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.configureAuthMethods = exports.RestApiKeyAuthentication = exports.OrganizationApiKeyAuthentication = void 0;
-var OrganizationApiKeyAuthentication = (function () {
-    function OrganizationApiKeyAuthentication(tokenProvider) {
+class OrganizationApiKeyAuthentication {
+    constructor(tokenProvider) {
         this.tokenProvider = tokenProvider;
     }
-    OrganizationApiKeyAuthentication.prototype.getName = function () {
+    getName() {
         return "organization_api_key";
-    };
-    OrganizationApiKeyAuthentication.prototype.applySecurityAuthentication = function (context) {
-        return __awaiter(this, void 0, void 0, function () {
-            var _a, _b, _c, _d;
-            return __generator(this, function (_e) {
-                switch (_e.label) {
-                    case 0:
-                        _b = (_a = context).setHeaderParam;
-                        _c = ["Authorization"];
-                        _d = "Key ";
-                        return [4, this.tokenProvider.getToken()];
-                    case 1:
-                        _b.apply(_a, _c.concat([_d + (_e.sent())]));
-                        return [2];
-                }
-            });
-        });
-    };
-    return OrganizationApiKeyAuthentication;
-}());
+    }
+    async applySecurityAuthentication(context) {
+        context.setHeaderParam("Authorization", "Key " + await this.tokenProvider.getToken());
+    }
+}
 exports.OrganizationApiKeyAuthentication = OrganizationApiKeyAuthentication;
-var RestApiKeyAuthentication = (function () {
-    function RestApiKeyAuthentication(tokenProvider) {
+class RestApiKeyAuthentication {
+    constructor(tokenProvider) {
         this.tokenProvider = tokenProvider;
     }
-    RestApiKeyAuthentication.prototype.getName = function () {
+    getName() {
         return "rest_api_key";
-    };
-    RestApiKeyAuthentication.prototype.applySecurityAuthentication = function (context) {
-        return __awaiter(this, void 0, void 0, function () {
-            var _a, _b, _c, _d;
-            return __generator(this, function (_e) {
-                switch (_e.label) {
-                    case 0:
-                        _b = (_a = context).setHeaderParam;
-                        _c = ["Authorization"];
-                        _d = "Key ";
-                        return [4, this.tokenProvider.getToken()];
-                    case 1:
-                        _b.apply(_a, _c.concat([_d + (_e.sent())]));
-                        return [2];
-                }
-            });
-        });
-    };
-    return RestApiKeyAuthentication;
-}());
+    }
+    async applySecurityAuthentication(context) {
+        context.setHeaderParam("Authorization", "Key " + await this.tokenProvider.getToken());
+    }
+}
 exports.RestApiKeyAuthentication = RestApiKeyAuthentication;
 function configureAuthMethods(config) {
-    var authMethods = {};
+    let authMethods = {};
     if (!config) {
         return authMethods;
     }

package/dist/configuration.js

@@ -1,31 +1,31 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createConfiguration = void 0;
-var middleware_1 = require("./middleware");
-var isomorphic_fetch_1 = require("./http/isomorphic-fetch");
-var servers_1 = require("./servers");
-var auth_1 = require("./auth/auth");
+const middleware_1 = require("./middleware");
+const isomorphic_fetch_1 = require("./http/isomorphic-fetch");
+const servers_1 = require("./servers");
+const auth_1 = require("./auth/auth");
 function createConfiguration(conf) {
-    var authMethods = {
+    const authMethods = {
         'organization_api_key': {
             tokenProvider: {
-                getToken: function () { return conf.organizationApiKey || ''; }
+                getToken: () => conf.organizationApiKey || ''
             }
         },
         'rest_api_key': {
             tokenProvider: {
-                getToken: function () { return conf.restApiKey || ''; }
+                getToken: () => conf.restApiKey || ''
             }
         },
     };
-    var configuration = {
+    const configuration = {
         baseServer: conf.baseServer !== undefined ? conf.baseServer : servers_1.server1,
         httpApi: conf.httpApi || new isomorphic_fetch_1.IsomorphicFetchHttpLibrary(),
         middleware: conf.middleware || [],
         authMethods: (0, auth_1.configureAuthMethods)(Object.assign(authMethods, conf.authMethods || {}))
     };
     if (conf.promiseMiddleware) {
-        conf.promiseMiddleware.forEach(function (m) { return configuration.middleware.push(new middleware_1.PromiseMiddlewareWrapper(m)); });
+        conf.promiseMiddleware.forEach(m => configuration.middleware.push(new middleware_1.PromiseMiddlewareWrapper(m)));
     }
     return configuration;
 }

package/dist/errors.d.ts

@@ -0,0 +1,8 @@
+export declare const OneSignalErrors: {
+    readonly INVALID_API_KEY: "Access denied.  Please include an 'Authorization: ...' header with a valid API key (https://documentation.onesignal.com/docs/en/keys-and-ids#api-keys).";
+    readonly NOTIFICATION_NOT_FOUND: "Notification not found";
+    readonly NO_SUBSCRIBERS: "All included players are not subscribed";
+    readonly NO_TARGETING_SPECIFIED: "You must include which players, segments, or tags you wish to send this notification to.";
+    readonly SERVICE_UNAVAILABLE: "Service temporarily unavailable";
+};
+export type OneSignalErrorMessage = typeof OneSignalErrors[keyof typeof OneSignalErrors];

package/dist/errors.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OneSignalErrors = void 0;
+exports.OneSignalErrors = {
+    INVALID_API_KEY: "Access denied.  Please include an 'Authorization: ...' header with a valid API key (https://documentation.onesignal.com/docs/en/keys-and-ids#api-keys).",
+    NOTIFICATION_NOT_FOUND: "Notification not found",
+    NO_SUBSCRIBERS: "All included players are not subscribed",
+    NO_TARGETING_SPECIFIED: "You must include which players, segments, or tags you wish to send this notification to.",
+    SERVICE_UNAVAILABLE: "Service temporarily unavailable",
+};
+//# sourceMappingURL=errors.js.map

package/dist/helpers.d.ts

@@ -0,0 +1,12 @@
+import { Configuration } from './configuration';
+import { Notification } from './models/Notification';
+import { CreateNotificationSuccessResponse } from './models/CreateNotificationSuccessResponse';
+export interface CreateNotificationWithRetryOptions {
+    maxRetries?: number;
+    baseDelayMs?: number;
+}
+export interface CreateNotificationWithRetryResult {
+    response: CreateNotificationSuccessResponse;
+    wasReplayed: boolean;
+}
+export declare function createNotificationWithRetry(configuration: Configuration, notification: Notification, options?: CreateNotificationWithRetryOptions): Promise<CreateNotificationWithRetryResult>;

package/dist/helpers.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createNotificationWithRetry = void 0;
+const crypto_1 = require("crypto");
+const DefaultApi_1 = require("./apis/DefaultApi");
+const RETRYABLE_STATUSES = [429, 503];
+const MIN_BASE_DELAY_MS = 1000;
+const MAX_BASE_DELAY_MS = 60000;
+async function createNotificationWithRetry(configuration, notification, options) {
+    const maxRetries = options && options.maxRetries !== undefined ? options.maxRetries : 3;
+    const requestedBaseDelayMs = options && typeof options.baseDelayMs === 'number' && isFinite(options.baseDelayMs)
+        ? options.baseDelayMs
+        : MIN_BASE_DELAY_MS;
+    const baseDelayMs = Math.min(MAX_BASE_DELAY_MS, Math.max(MIN_BASE_DELAY_MS, requestedBaseDelayMs));
+    if (!notification.idempotency_key) {
+        notification.idempotency_key = generateUuidV4();
+    }
+    const requestFactory = new DefaultApi_1.DefaultApiRequestFactory(configuration);
+    const responseProcessor = new DefaultApi_1.DefaultApiResponseProcessor();
+    let attempt = 0;
+    while (true) {
+        let response;
+        try {
+            const requestContext = await requestFactory.createNotification(notification, configuration);
+            response = await configuration.httpApi.send(requestContext).toPromise();
+        }
+        catch (e) {
+            if (attempt >= maxRetries) {
+                throw e;
+            }
+            await sleep(baseDelayMs * Math.pow(2, attempt));
+            attempt++;
+            continue;
+        }
+        if (RETRYABLE_STATUSES.indexOf(response.httpStatusCode) !== -1 && attempt < maxRetries) {
+            await sleep(retryDelayMs(response.headers, attempt, baseDelayMs));
+            attempt++;
+            continue;
+        }
+        const body = await responseProcessor.createNotification(response);
+        return { response: body, wasReplayed: isReplayed(response.headers) };
+    }
+}
+exports.createNotificationWithRetry = createNotificationWithRetry;
+function headerValue(headers, name) {
+    const target = name.toLowerCase();
+    for (const key in headers) {
+        if (Object.prototype.hasOwnProperty.call(headers, key) && key.toLowerCase() === target) {
+            return headers[key];
+        }
+    }
+    return undefined;
+}
+function isReplayed(headers) {
+    const value = headerValue(headers, 'idempotent-replayed');
+    return value !== undefined && value.trim().toLowerCase() === 'true';
+}
+function retryDelayMs(headers, attempt, baseDelayMs) {
+    const retryAfter = headerValue(headers, 'retry-after');
+    if (retryAfter !== undefined && /^\d+$/.test(retryAfter.trim())) {
+        return parseInt(retryAfter.trim(), 10) * 1000;
+    }
+    return baseDelayMs * Math.pow(2, attempt);
+}
+function generateUuidV4() {
+    const bytes = (0, crypto_1.randomBytes)(16);
+    bytes[6] = (bytes[6] & 0x0f) | 0x40;
+    bytes[8] = (bytes[8] & 0x3f) | 0x80;
+    const hex = bytes.toString('hex');
+    return (hex.substring(0, 8) + '-' +
+        hex.substring(8, 12) + '-' +
+        hex.substring(12, 16) + '-' +
+        hex.substring(16, 20) + '-' +
+        hex.substring(20));
+}
+function sleep(ms) {
+    return new Promise((resolve) => setTimeout(resolve, ms));
+}
+//# sourceMappingURL=helpers.js.map