@gapi/onesignal-notifications 1.8.122

package/src/constants.ts

@@ -0,0 +1,8 @@
+export const Constants = {
+  API_ROOT: 'https://onesignal.com/api/v1',
+
+  /** PATHS **/
+  NOTIFICATIONS_PATH: '/notifications',
+  APPS_PATH: '/apps',
+  DEVICES_PATH: '/players',
+};

package/src/index.ts

@@ -0,0 +1,18 @@
+import { Container, Module, ModuleWithServices } from '@rxdi/core';
+
+import { OneSignalClientService } from './client';
+import { OneSignalConfig } from './onesignal.config';
+
+@Module()
+export class OneSignalModule {
+  static forRoot(config: OneSignalConfig): ModuleWithServices {
+    Container.set(OneSignalClientService, new OneSignalClientService(config));
+    return {
+      module: OneSignalModule,
+    };
+  }
+}
+
+export * from './notification';
+export * from './client';
+export * from './interfaces/index';

package/src/interfaces/client.ts

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

package/src/interfaces/index.ts

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

package/src/interfaces/notificationDataResponse.ts

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

package/src/interfaces/notificationHttpResponse.ts

@@ -0,0 +1,40 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+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/src/interfaces/notificationResponse.ts

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

package/src/notification.ts

@@ -0,0 +1,171 @@
+/* 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',
+];
+
+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;
+  app_id;
+  include_player_ids: string[];
+}
+
+interface ClientNotification {
+  postBody: PostBody;
+  setContent(contents): void;
+  setExcludedSegments(excludedSegments: string[]): void;
+  setFilters(filters: string): void;
+  setIncludedSegments(includedSegments: string[]): void;
+  setParameter(name: string, value: any): void;
+  setTargetDevices(include_player_ids: string[]): void;
+}
+
+export class Notification {
+  public initialBody: {
+    contents?: any;
+    content_available?: any;
+    template_id?: any;
+  };
+  public postBody: PostBody;
+  public allowed_fields: string[] = ALLOWED_FIELDS;
+
+  constructor(initialBody: {
+    contents?: any;
+    content_available?: any;
+    template_id?: any;
+  }) {
+    this.initialBody = initialBody;
+    this.postBody = {} as never;
+
+    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: string, 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<T>(included_segments: T[]) {
+    this.postBody.included_segments = included_segments;
+    return this;
+  }
+
+  setExcludedSegments<T>(excluded_segments: T[]) {
+    this.postBody.excluded_segments = excluded_segments;
+    return this;
+  }
+
+  setFilters(filters: any) {
+    this.postBody.filters = filters;
+    return this;
+  }
+
+  setTargetDevices(include_player_ids: string[]) {
+    this.postBody.include_player_ids = include_player_ids;
+    return this;
+  }
+}

package/src/onesignal.config.ts

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

package/tsconfig.json

@@ -0,0 +1,39 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "module": "commonjs",
+    "target": "es6",
+    "baseUrl": ".",
+    "stripInternal": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "moduleResolution": "node",
+    "outDir": "dist",
+    "rootDir": "./src",
+    "lib": [
+      "es2017",
+      "es2016",
+      "es2015",
+      "es6",
+      "dom",
+      "esnext.asynciterable"
+    ],
+    "skipLibCheck": true,
+    "types": [
+      "node"
+    ],
+    "typeRoots": [
+      "node_modules/"
+    ]
+  },
+  "angularCompilerOptions": {
+    "annotateForClosureCompiler": true,
+    "strictMetadataEmit": true,
+    "skipTemplateCodegen": true,
+    "flatModuleOutFile": "gapi-amqp.js",
+    "flatModuleId": "gapi-amqp"
+  },
+  "files": [
+    "./src/index.ts"
+  ]
+}