@gapi/onesignal-notifications 1.8.122

package/dist/constants.d.ts

@@ -0,0 +1,7 @@
+export declare const Constants: {
+    API_ROOT: string;
+    /** PATHS **/
+    NOTIFICATIONS_PATH: string;
+    APPS_PATH: string;
+    DEVICES_PATH: string;
+};

package/dist/constants.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Constants = void 0;
+exports.Constants = {
+    API_ROOT: 'https://onesignal.com/api/v1',
+    /** PATHS **/
+    NOTIFICATIONS_PATH: '/notifications',
+    APPS_PATH: '/apps',
+    DEVICES_PATH: '/players',
+};

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+import { ModuleWithServices } from '@rxdi/core';
+import { OneSignalConfig } from './onesignal.config';
+export declare class OneSignalModule {
+    static forRoot(config: OneSignalConfig): ModuleWithServices;
+}
+export * from './notification';
+export * from './client';
+export * from './interfaces/index';

package/dist/index.js

@@ -0,0 +1,37 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
+};
+var OneSignalModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OneSignalModule = void 0;
+const core_1 = require("@rxdi/core");
+const client_1 = require("./client");
+let OneSignalModule = OneSignalModule_1 = class OneSignalModule {
+    static forRoot(config) {
+        core_1.Container.set(client_1.OneSignalClientService, new client_1.OneSignalClientService(config));
+        return {
+            module: OneSignalModule_1,
+        };
+    }
+};
+OneSignalModule = OneSignalModule_1 = __decorate([
+    core_1.Module()
+], OneSignalModule);
+exports.OneSignalModule = OneSignalModule;
+__exportStar(require("./notification"), exports);
+__exportStar(require("./client"), exports);
+__exportStar(require("./interfaces/index"), exports);

package/dist/interfaces/client.d.ts

@@ -0,0 +1,19 @@
+import { SendNotificationResponse } from './notificationResponse';
+export interface OneSignalClient {
+    setRootUrl(rootUrl: string): void;
+    setApp(app: any): void;
+    sendNotification(notification: any, callback?: any): Promise<SendNotificationResponse>;
+    cancelNotification(notificationId: any, callback: any): Promise<any>;
+    viewNotification(notificationId: any, callback: any): Promise<any>;
+    viewNotifications(query: any, callback: any): Promise<any>;
+    viewApps(callback: any): Promise<any>;
+    viewApp(appId: any, callback: any): Promise<any>;
+    createApp(body: any, callback: any): Promise<any>;
+    updateApp(body: any, callback: any): Promise<any>;
+    viewDevices(query: any, callback: any): Promise<any>;
+    viewDevice(deviceId: any, callback: any): Promise<any>;
+    addDevice(body: any, callback: any): Promise<any>;
+    editDevice(deviceId: any, body: any, callback: any): Promise<any>;
+    trackOpen(notificationId: any, body: any, callback: any): Promise<any>;
+    csvExport(body: any, callback: any): Promise<any>;
+}

package/dist/interfaces/client.js

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

package/dist/interfaces/index.d.ts

@@ -0,0 +1,4 @@
+export * from './client';
+export * from './notificationDataResponse';
+export * from './notificationHttpResponse';
+export * from './notificationResponse';

package/dist/interfaces/index.js

@@ -0,0 +1,16 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (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" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./client"), exports);
+__exportStar(require("./notificationDataResponse"), exports);
+__exportStar(require("./notificationHttpResponse"), exports);
+__exportStar(require("./notificationResponse"), exports);

package/dist/interfaces/notificationDataResponse.d.ts

@@ -0,0 +1,4 @@
+export interface SendNotificationDataResponse {
+    id: string;
+    recipients: number;
+}

package/dist/interfaces/notificationDataResponse.js

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

package/dist/interfaces/notificationHttpResponse.d.ts

@@ -0,0 +1,42 @@
+/// <reference types="node" />
+import { Domain } from 'domain';
+import { ClientRequest } from 'http';
+import { TLSSocket } from 'tls';
+import { SendNotificationDataResponse } from './notificationDataResponse';
+export interface SendNotificationHttpResponse {
+    _consuming: boolean;
+    _dumped: boolean;
+    _events: any;
+    _eventsCount: number;
+    _maxListeners: number;
+    _readableState: any;
+    body: SendNotificationDataResponse;
+    caseless: {
+        dict: Record<string, any>;
+    };
+    client: TLSSocket;
+    complete: true;
+    connection: TLSSocket;
+    destroyed: boolean;
+    domain: Domain;
+    headers: Record<string, any>;
+    httpVersion: string;
+    httpVersionMajor: number;
+    httpVersionMinor: number;
+    method: any;
+    rawHeaders: Array<{
+        [key: string]: string;
+    }>;
+    rawTrailers: Array<any>;
+    read: Function;
+    readable: boolean;
+    req: ClientRequest;
+    request: Request;
+    socket: TLSSocket;
+    statusCode: number;
+    statusMessage: string;
+    toJSON: Function;
+    trailers: Record<string, any>;
+    upgrade: boolean;
+    url: string;
+}

package/dist/interfaces/notificationHttpResponse.js

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

package/dist/interfaces/notificationResponse.d.ts

@@ -0,0 +1,6 @@
+import { SendNotificationDataResponse } from './notificationDataResponse';
+import { SendNotificationHttpResponse } from './notificationHttpResponse';
+export interface SendNotificationResponse {
+    data: SendNotificationDataResponse;
+    httpResponse: SendNotificationHttpResponse;
+}

package/dist/interfaces/notificationResponse.js

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

package/dist/notification.d.ts

@@ -0,0 +1,34 @@
+export interface PostBody {
+    contents: {
+        [key: string]: string;
+    };
+    data: any;
+    content_available: any;
+    template_id: any;
+    included_segments: any;
+    excluded_segments: any;
+    filters: any;
+    app_ids: any;
+    app_id: any;
+    include_player_ids: string[];
+}
+export declare class Notification {
+    initialBody: {
+        contents?: any;
+        content_available?: any;
+        template_id?: any;
+    };
+    postBody: PostBody;
+    allowed_fields: string[];
+    constructor(initialBody: {
+        contents?: any;
+        content_available?: any;
+        template_id?: any;
+    });
+    setParameter(name: string, value: any): this;
+    setContent(contents: any): this;
+    setIncludedSegments<T>(included_segments: T[]): this;
+    setExcludedSegments<T>(excluded_segments: T[]): this;
+    setFilters(filters: any): this;
+    setTargetDevices(include_player_ids: string[]): this;
+}

package/dist/notification.js

@@ -0,0 +1,124 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Notification = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const ALLOWED_FIELDS = [
+    'contents',
+    'included_segments',
+    'excluded_segments',
+    'filters',
+    'include_player_ids',
+    'app_id',
+    'app_ids',
+    'headings',
+    'subtitle',
+    'template_id',
+    'content_available',
+    'mutable_content',
+    'data',
+    'url',
+    'ios_attachments',
+    'big_picture',
+    'adm_big_picture',
+    'chrome_big_picture',
+    'buttons',
+    'web_buttons',
+    'ios_category',
+    'android_background_layout',
+    'small_icon',
+    'large_icon',
+    'adm_small_icon',
+    'adm_large_icon',
+    'chrome_web_icon',
+    'chrome_web_image',
+    'firefox_icon',
+    'chrome_icon',
+    'ios_sound',
+    'android_sound',
+    'android_led_color',
+    'android_accent_color',
+    'android_visibility',
+    'adm_sound',
+    'ios_badgeType',
+    'ios_badgeCount',
+    'collapse_id',
+    'send_after',
+    'delayed_option',
+    'delivery_time_of_day',
+    'ttl',
+    'priority',
+    'android_group',
+    'android_group_message',
+    'adm_group',
+    'adm_group_message',
+    'isIos',
+    'isAndroid',
+    'isAnyWeb',
+    'isChromeWeb',
+    'isFirefox',
+    'isSafari',
+    'isWP',
+    'isWP_WNS',
+    'isAdm',
+    'isChrome',
+    'android_channel_id',
+    'existing_android_channel_id',
+];
+class Notification {
+    constructor(initialBody) {
+        this.allowed_fields = ALLOWED_FIELDS;
+        this.initialBody = initialBody;
+        this.postBody = {};
+        if (initialBody.constructor !== Object) {
+            throw new Error('Body must be a JSON object');
+        }
+        if ('contents' in initialBody) {
+            this.postBody.contents = this.initialBody.contents;
+            return;
+        }
+        if ('content_available' in initialBody) {
+            this.postBody.content_available = this.initialBody.content_available;
+            return;
+        }
+        if ('template_id' in initialBody) {
+            this.postBody.template_id = this.initialBody.template_id;
+            return;
+        }
+        throw new Error('Body must include one of the following fields: contents, content_available, template_id');
+    }
+    setParameter(name, value) {
+        if (name && name[0] === '!') {
+            name = name.substring(1);
+        }
+        else if (ALLOWED_FIELDS.indexOf(name) === -1) {
+            throw new Error('"' +
+                name +
+                '" is not present in documentation. You should add a ' +
+                'exclamation mark to the begging of the name, if you want to set it : !' +
+                name);
+        }
+        this.postBody[name] = value;
+        return this;
+    }
+    setContent(contents) {
+        this.postBody.contents = contents;
+        return this;
+    }
+    setIncludedSegments(included_segments) {
+        this.postBody.included_segments = included_segments;
+        return this;
+    }
+    setExcludedSegments(excluded_segments) {
+        this.postBody.excluded_segments = excluded_segments;
+        return this;
+    }
+    setFilters(filters) {
+        this.postBody.filters = filters;
+        return this;
+    }
+    setTargetDevices(include_player_ids) {
+        this.postBody.include_player_ids = include_player_ids;
+        return this;
+    }
+}
+exports.Notification = Notification;

package/dist/onesignal.config.d.ts

@@ -0,0 +1,7 @@
+export declare class OneSignalConfig {
+    userAuthKey: string;
+    app: {
+        appAuthKey: string;
+        appId: string;
+    };
+}

package/dist/onesignal.config.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OneSignalConfig = void 0;
+class OneSignalConfig {
+}
+exports.OneSignalConfig = OneSignalConfig;

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@gapi/onesignal-notifications",
+  "version": "1.8.122",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Stradivario/onesignal-notifications.git"
+  },
+  "scripts": {
+    "patch": "npm run build && npm version patch && npm publish --update-readme --access public && npm run delete-dist",
+    "delete-dist": "rm -rf dist",
+    "clean": "git clean -dxf",
+    "lint": "npx eslint . --ext .ts",
+    "lint-fix": "npx eslint . --fix --ext .ts",
+    "build": "rm -rf dist && tsc || true"
+  },
+  "author": {
+    "name": "Kristian Tachev(Stradivario)",
+    "email": "kristiqn.tachev@gmail.com"
+  },
+  "keywords": [
+    "graphql",
+    "gapi",
+    "node"
+  ],
+  "license": "MIT",
+  "bugs": {
+    "url": "http://gitlab.youvolio.com/gapi/onesignal-notifications/issues"
+  },
+  "dependencies": {
+    "request": "^2.88.0"
+  },
+  "devDependencies": {
+    "@rxdi/core": "^0.7.114",
+    "@types/node": "^13.11.1",
+    "@types/request": "^2.48.1"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "module": "./dist/index.js",
+  "typings": "./dist/index.d.ts"
+}

package/src/client.ts

@@ -0,0 +1,358 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { Service } from '@rxdi/core';
+import * as request from 'request';
+
+import { Constants } from './constants';
+import { OneSignalClient } from './interfaces/client';
+import { SendNotificationResponse } from './interfaces/notificationResponse';
+import { Notification } from './notification';
+import { OneSignalConfig } from './onesignal.config';
+
+function checkCredential(credentialName, credential): boolean {
+  const ALLOWED_CREDENTIALS: any = [
+    { name: 'userAuthKey', type: 'string' },
+    { name: 'app', type: 'object', requiredFields: ['appAuthKey', 'appId'] },
+    { name: 'apps', type: 'object' },
+  ];
+  for (let i = 0; i < ALLOWED_CREDENTIALS.length; i++) {
+    if (ALLOWED_CREDENTIALS[i].name === credentialName) {
+      if (typeof credential !== ALLOWED_CREDENTIALS[i].type) {
+        throw new Error(
+          credentialName + ' must be a ' + ALLOWED_CREDENTIALS[i].type
+        );
+      }
+      if (ALLOWED_CREDENTIALS[i].requiredFields) {
+        for (let j = 0; j < ALLOWED_CREDENTIALS[i].requiredFields.length; j++) {
+          if (!(ALLOWED_CREDENTIALS[i].requiredFields[j] in credential)) {
+            throw new Error(
+              credentialName +
+                ' must contain ' +
+                ALLOWED_CREDENTIALS[i].requiredFields[j]
+            );
+          }
+        }
+      }
+      return true;
+    }
+  }
+  return false;
+}
+
+export interface DevicesData<T> {
+  players: Player<T>[];
+}
+
+export interface Player<T> {
+  id: string;
+  identifier: string;
+  session_count: number;
+  language: string;
+  timezone: number;
+  game_version: string;
+  device_os: string;
+  device_type: number;
+  device_model: string;
+  ad_id: string;
+  tags: T;
+  last_active: number;
+  playtime: number;
+  amount_spend: number;
+  created_at: number;
+  invalid_identifier: boolean;
+  badge_count: number;
+  sdk: string;
+  test_type: any;
+  ip: any;
+}
+
+@Service()
+export class OneSignalClientService implements OneSignalClient {
+  API_URI: string;
+  app: any;
+  apps: any;
+  userAuthKey: string;
+
+  constructor(credentials: OneSignalConfig) {
+    if (typeof credentials !== 'object') {
+      throw new Error('credentials parameter must be a JSON object');
+    }
+
+    this.API_URI = Constants.API_ROOT;
+
+    for (const key in credentials) {
+      if (
+        credentials.hasOwnProperty(key) &&
+        checkCredential(key, credentials[key])
+      ) {
+        this[key] = credentials[key];
+      }
+    }
+  }
+
+  basicRequest(
+    url: string,
+    apiKey: string,
+    method: 'PUT' | 'POST' | 'GET' | 'DELETE',
+    body
+  ): Promise<any> {
+    const options = {
+      url: url,
+      method: method,
+    } as any;
+    if (apiKey) {
+      options.headers = {
+        'Content-Type': 'application/json; charset=utf-8',
+        Authorization: 'Basic ' + apiKey,
+      };
+    }
+    if (body) {
+      options.body = body;
+      options.json = true;
+    }
+
+    return new Promise(function (resolve, reject) {
+      request(options, function (err, httpResponse, data) {
+        if (err) {
+          return reject(err);
+        }
+        return resolve({ httpResponse: httpResponse, data: data });
+      });
+    });
+  }
+  setRootUrl(rootUrl: string) {
+    if (!rootUrl) {
+      throw new Error('You must set a valid rootUsrl.');
+    }
+    this.API_URI = rootUrl;
+  }
+
+  setApp(app) {
+    checkCredential('app', app);
+    this.app = app;
+  }
+
+  async sendNotification(
+    notification: Notification
+  ): Promise<SendNotificationResponse> {
+    if (!notification || !notification.postBody) {
+      throw new Error(
+        'notification parameter must be a typeof Notification object.'
+      );
+    }
+    const postBody = notification.postBody;
+    if (this.apps && this.apps.length > 0) {
+      postBody.app_ids = this.apps;
+      return await this.basicRequest(
+        this.API_URI + Constants.NOTIFICATIONS_PATH,
+        this.userAuthKey,
+        'POST',
+        postBody
+      );
+    }
+    if (this.app) {
+      postBody.app_id = this.app.appId;
+      return await this.basicRequest(
+        this.API_URI + Constants.NOTIFICATIONS_PATH,
+        this.app.appAuthKey,
+        'POST',
+        postBody
+      );
+    }
+    throw new Error('You must set either an "app" or "apps" on Client');
+  }
+
+  async cancelNotification(notificationId: string): Promise<any> {
+    if (!this.app) {
+      throw new Error('You must define an "app" object.');
+    }
+    const notificationUri =
+      this.API_URI +
+      Constants.NOTIFICATIONS_PATH +
+      '/' +
+      notificationId +
+      '?app_id=' +
+      this.app.appId;
+    return await this.basicRequest(
+      notificationUri,
+      this.app.appAuthKey,
+      'DELETE',
+      null
+    );
+  }
+
+  async viewNotification(notificationId: string): Promise<any> {
+    if (!this.app) {
+      throw new Error('You must define an "app" object.');
+    }
+    const notificationUri =
+      this.API_URI +
+      Constants.NOTIFICATIONS_PATH +
+      '/' +
+      notificationId +
+      '?app_id=' +
+      this.app.appId;
+    return await this.basicRequest(
+      notificationUri,
+      this.app.appAuthKey,
+      'GET',
+      null
+    );
+  }
+
+  async viewNotifications(query: {
+    limit: number;
+    offset: number;
+  }): Promise<any> {
+    if (!this.app) {
+      throw new Error('You must define an "app" object.');
+    }
+    const appUri =
+      this.API_URI +
+      Constants.NOTIFICATIONS_PATH +
+      '?app_id=' +
+      this.app.appId +
+      '&' +
+      query;
+    return await this.basicRequest(appUri, this.app.appAuthKey, 'GET', null);
+  }
+
+  async viewApps(): Promise<any> {
+    if (!this.userAuthKey) {
+      throw new Error('You must define "userAuthKey" on Client');
+    }
+    return await this.basicRequest(
+      this.API_URI + Constants.APPS_PATH,
+      this.userAuthKey,
+      'GET',
+      null
+    );
+  }
+
+  async viewApp(appId: string): Promise<any> {
+    if (!this.userAuthKey) {
+      throw new Error('You must define "userAuthKey" on Client');
+    }
+    return await this.basicRequest(
+      this.API_URI + Constants.APPS_PATH + '/' + appId,
+      this.userAuthKey,
+      'GET',
+      null
+    );
+  }
+
+  async createApp(body): Promise<any> {
+    if (!body.name) {
+      throw new Error('You must specify a name in body');
+    }
+    if (!this.userAuthKey) {
+      throw new Error('You must define "userAuthKey" on Client');
+    }
+    return await this.basicRequest(
+      this.API_URI + Constants.APPS_PATH,
+      this.userAuthKey,
+      'POST',
+      body
+    );
+  }
+
+  async updateApp(body): Promise<any> {
+    if (!this.app) {
+      throw new Error('You must define an "app" object.');
+    }
+    if (!this.userAuthKey) {
+      throw new Error('You must define "userAuthKey" on Client');
+    }
+    return await this.basicRequest(
+      this.API_URI + Constants.APPS_PATH + '/' + this.app.appId,
+      this.userAuthKey,
+      'PUT',
+      body
+    );
+  }
+
+  async viewDevices<T>(query: {
+    limit: number;
+    offset: number;
+  }): Promise<{ data: DevicesData<T> }> {
+    if (!this.app) {
+      throw new Error('You must define an "app" object.');
+    }
+    const viewUri =
+      this.API_URI +
+      Constants.DEVICES_PATH +
+      '?app_id=' +
+      this.app.appId +
+      '&' +
+      query;
+    return await this.basicRequest(viewUri, this.app.appAuthKey, 'GET', null);
+  }
+
+  async viewDevice(deviceId: string): Promise<any> {
+    if (!this.app) {
+      throw new Error('You must define an "app" object.');
+    }
+    const viewUri =
+      this.API_URI +
+      Constants.DEVICES_PATH +
+      '/' +
+      deviceId +
+      '?app_id=' +
+      this.app.appId;
+    return await this.basicRequest(viewUri, this.app.appAuthKey, 'GET', null);
+  }
+
+  async addDevice(body): Promise<any> {
+    if (!this.app) {
+      throw new Error('You must define an "app" object.');
+    }
+    if (!('app_id' in body)) {
+      body.app_id = this.app.appId;
+    }
+    return await this.basicRequest(
+      this.API_URI + Constants.DEVICES_PATH,
+      this.app.appAuthKey,
+      'POST',
+      body
+    );
+  }
+
+  async editDevice(deviceId: string, body): Promise<any> {
+    if (!this.app) {
+      throw new Error('You must define an "app" object.');
+    }
+    return await this.basicRequest(
+      this.API_URI + Constants.DEVICES_PATH + '/' + deviceId,
+      this.app.appAuthKey,
+      'PUT',
+      body
+    );
+  }
+
+  async trackOpen(notificationId: string, body): Promise<any> {
+    if (!this.app) {
+      throw new Error('You must define an "app" object.');
+    }
+    if (!('app_id' in body)) {
+      body.app_id = this.app.appId;
+    }
+    return await this.basicRequest(
+      this.API_URI + Constants.NOTIFICATIONS_PATH + '/' + notificationId,
+      this.app.appAuthKey,
+      'PUT',
+      body
+    );
+  }
+
+  async csvExport(body): Promise<any> {
+    if (!this.app) {
+      throw new Error('You must define an "app" object.');
+    }
+    const csvUri =
+      this.API_URI +
+      Constants.DEVICES_PATH +
+      '/csv_export' +
+      '?app_id=' +
+      this.app.appId;
+    return await this.basicRequest(csvUri, this.app.appAuthKey, 'POST', body);
+  }
+}