@pushpushgo/react-native-push 0.4.0

package/lib/typescript/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAG9C,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;AAElC,MAAM,WAAW,kBAAkB;IACjC,eAAe,EAAE,MAAM,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;IACpD,wBAAwB,EAAE,MAAM,OAAO,CAAC,YAAY,CAAC,CAAC;IACtD,4BAA4B,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAClD,UAAU,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/C;AAED,eAAO,MAAM,iBAAiB,EAAE,kBAwC/B,CAAC;AAEF,OAAO,EACL,MAAM,EACN,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,GACzB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC"}

package/lib/typescript/src/specs/NativePushNotifications.d.ts

@@ -0,0 +1,22 @@
+import type { TurboModule } from 'react-native';
+import type { BeaconTag } from '../beacon/BeaconTag';
+export type SubscriberId = string;
+interface SpecBeacon {
+    selectors: {
+        [key: string]: string | number | boolean;
+    };
+    tags: BeaconTag[];
+    tagsToDelete: BeaconTag[];
+    customId: string | null;
+    assignToGroup: string | null;
+    unassignFromGroup: string | null;
+}
+export interface Spec extends TurboModule {
+    getSubscriberId: () => Promise<SubscriberId | null>;
+    subscribeToNotifications: () => Promise<SubscriberId>;
+    unsubscribeFromNotifications: () => Promise<void>;
+    sendBeacon: (beacon: SpecBeacon) => Promise<void>;
+}
+declare const _default: Spec;
+export default _default;
+//# sourceMappingURL=NativePushNotifications.d.ts.map

package/lib/typescript/src/specs/NativePushNotifications.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NativePushNotifications.d.ts","sourceRoot":"","sources":["../../../../src/specs/NativePushNotifications.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAErD,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;AAElC,UAAU,UAAU;IAClB,SAAS,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IACxD,IAAI,EAAE,SAAS,EAAE,CAAC;IAClB,YAAY,EAAE,SAAS,EAAE,CAAC;IAC1B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC;AAED,MAAM,WAAW,IAAK,SAAQ,WAAW;IACvC,eAAe,EAAE,MAAM,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;IACpD,wBAAwB,EAAE,MAAM,OAAO,CAAC,YAAY,CAAC,CAAC;IACtD,4BAA4B,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAClD,UAAU,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACnD;;AAED,wBAEE"}

package/package.json

@@ -0,0 +1,168 @@
+{
+  "name": "@pushpushgo/react-native-push",
+  "version": "0.4.0",
+  "description": "PushPushGo Push Notifications SDK for React Native",
+  "main": "./lib/module/index.js",
+  "types": "./lib/typescript/src/index.d.ts",
+  "exports": {
+    ".": {
+      "source": "./src/index.tsx",
+      "types": "./lib/typescript/src/index.d.ts",
+      "default": "./lib/module/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "src",
+    "lib",
+    "android",
+    "ios",
+    "*.podspec",
+    "react-native.config.js",
+    "!ios/build",
+    "!android/build",
+    "!android/gradle",
+    "!android/gradlew",
+    "!android/gradlew.bat",
+    "!android/local.properties",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__",
+    "!**/.*"
+  ],
+  "scripts": {
+    "example": "yarn workspace @pushpushgo/react-native-push-example",
+    "test": "jest",
+    "typecheck": "tsc",
+    "lint": "eslint \"**/*.{js,ts,tsx}\"",
+    "clean": "del-cli android/build example/android/build example/android/app/build example/ios/build lib",
+    "prepare": "bob build",
+    "release": "release-it --only-version"
+  },
+  "keywords": [
+    "react-native",
+    "ios",
+    "android"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ppgco/react-native-sdk.git"
+  },
+  "author": "PushPushGo <mobile-dev@pushpushgo.com> (https://github.com/ppgco)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/ppgco/react-native-sdk/issues"
+  },
+  "homepage": "https://github.com/ppgco/react-native-sdk#readme",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "@commitlint/config-conventional": "^19.8.1",
+    "@eslint/compat": "^1.3.2",
+    "@eslint/eslintrc": "^3.3.1",
+    "@eslint/js": "^9.35.0",
+    "@evilmartians/lefthook": "^1.12.3",
+    "@react-native-community/cli": "20.0.1",
+    "@react-native/babel-preset": "0.81.1",
+    "@react-native/eslint-config": "^0.81.1",
+    "@release-it/conventional-changelog": "^10.0.1",
+    "@types/jest": "^29.5.14",
+    "@types/react": "^19.1.0",
+    "commitlint": "^19.8.1",
+    "del-cli": "^6.0.0",
+    "eslint": "^9.35.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.4",
+    "jest": "^29.7.0",
+    "prettier": "^3.6.2",
+    "react": "19.1.0",
+    "react-native": "0.81.1",
+    "react-native-builder-bob": "^0.40.13",
+    "release-it": "^19.0.4",
+    "turbo": "^2.5.6",
+    "typescript": "^5.9.2"
+  },
+  "peerDependencies": {
+    "react": ">=18",
+    "react-native": ">=0.72"
+  },
+  "workspaces": [
+    "example"
+  ],
+  "packageManager": "yarn@3.6.1",
+  "jest": {
+    "preset": "react-native",
+    "modulePathIgnorePatterns": [
+      "<rootDir>/example/node_modules",
+      "<rootDir>/lib/"
+    ]
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "release-it": {
+    "git": {
+      "commitMessage": "chore: release ${version}",
+      "tagName": "v${version}"
+    },
+    "npm": {
+      "publish": true
+    },
+    "github": {
+      "release": false
+    },
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "preset": {
+          "name": "angular"
+        }
+      }
+    }
+  },
+  "prettier": {
+    "quoteProps": "consistent",
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "es5",
+    "useTabs": false
+  },
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      [
+        "module",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "typescript",
+        {
+          "project": "tsconfig.build.json"
+        }
+      ]
+    ]
+  },
+  "codegenConfig": {
+    "name": "PushNotificationsSpec",
+    "type": "modules",
+    "jsSrcsDir": "src/specs",
+    "android": {
+      "javaPackageName": "com.pushpushgo.bridge.reactnative.push"
+    },
+    "ios": {
+      "modulesProvider": {
+        "PushPushGoPushNotifications": "PushNotificationsModule"
+      }
+    }
+  },
+  "create-react-native-library": {
+    "languages": "kotlin-objc",
+    "type": "turbo-module",
+    "version": "0.54.3"
+  }
+}

package/src/beacon/Beacon.ts

@@ -0,0 +1,84 @@
+import type { BeaconTag } from './BeaconTag';
+
+export type BeaconSelectorKey = string;
+export type BeaconSelectorValue = string | number | boolean;
+
+export interface IBeacon {
+  selectors: Map<BeaconSelectorKey, BeaconSelectorValue>;
+  tags: BeaconTag[];
+  tagsToDelete: BeaconTag[];
+  customId: string | null;
+  assignToGroup: string | null;
+  unassignFromGroup: string | null;
+}
+
+class BeaconBuilder {
+  private selectors = new Map<BeaconSelectorKey, BeaconSelectorValue>();
+  private tags: BeaconTag[] = [];
+  private tagsToDelete: BeaconTag[] = [];
+  private customId: string | null = null;
+  private _assignToGroup: string | null = null;
+  private _unassignFromGroup: string | null = null;
+
+  set(key: BeaconSelectorKey, value: BeaconSelectorValue): BeaconBuilder {
+    this.selectors.set(key, value);
+
+    return this;
+  }
+
+  appendTag(tag: BeaconTag): BeaconBuilder {
+    this.tags.push(tag);
+
+    return this;
+  }
+
+  removeTag(tag: BeaconTag): BeaconBuilder {
+    this.tagsToDelete.push(tag);
+
+    return this;
+  }
+
+  setCustomId(id: string | null): BeaconBuilder {
+    this.customId = id;
+
+    return this;
+  }
+
+  assignToGroup(groupId: string): BeaconBuilder {
+    this._assignToGroup = groupId;
+
+    return this;
+  }
+
+  unassignFromGroup(groupId: string): BeaconBuilder {
+    this._unassignFromGroup = groupId;
+
+    return this;
+  }
+
+  build(): Beacon {
+    return new Beacon(
+      this.selectors,
+      this.tags,
+      this.tagsToDelete,
+      this.customId,
+      this._assignToGroup,
+      this._unassignFromGroup
+    );
+  }
+}
+
+export class Beacon implements IBeacon {
+  constructor(
+    readonly selectors: Map<BeaconSelectorKey, BeaconSelectorValue>,
+    readonly tags: BeaconTag[],
+    readonly tagsToDelete: BeaconTag[],
+    readonly customId: string | null,
+    readonly assignToGroup: string | null,
+    readonly unassignFromGroup: string | null
+  ) {}
+
+  static builder(): BeaconBuilder {
+    return new BeaconBuilder();
+  }
+}

package/src/beacon/BeaconTag.ts

@@ -0,0 +1,52 @@
+export enum BeaconTagStrategy {
+  APPEND = 'append',
+  REWRITE = 'rewrite',
+}
+
+export interface IBeaconTag {
+  tag: string;
+  label: string;
+  strategy: BeaconTagStrategy;
+  ttl: number;
+}
+
+interface IBeaconTagProps {
+  /** Tag name */
+  tag: string;
+
+  /** Optional tag label */
+  label?: string;
+
+  /** Strategy dictating whether the tags assigned to the given label should be accumulated (APPEND) or overwritten (REWRITE) */
+  strategy?: BeaconTagStrategy;
+
+  /** Time-to-live for the tag in seconds (0 means no expiration) */
+  ttl?: number;
+}
+
+export class BeaconTag implements IBeaconTag {
+  readonly tag: string;
+  readonly label: string;
+  readonly strategy: BeaconTagStrategy;
+  readonly ttl: number;
+
+  constructor({
+    tag,
+    label = 'default',
+    strategy = BeaconTagStrategy.APPEND,
+    ttl = 0,
+  }: IBeaconTagProps) {
+    this.tag = tag;
+    this.label = label;
+    this.strategy = strategy;
+    this.ttl = ttl;
+  }
+
+  static fromTag(tag: string): BeaconTag {
+    return new BeaconTag({ tag });
+  }
+
+  static fromTagAndLabel(tag: string, label: string) {
+    return new BeaconTag({ tag, label });
+  }
+}

package/src/index.tsx

@@ -0,0 +1,62 @@
+import { PermissionsAndroid, Platform } from 'react-native';
+import type { Beacon } from './beacon/Beacon';
+import NativePushNotifications from './specs/NativePushNotifications';
+
+export type SubscriberId = string;
+
+export interface IPushNotifications {
+  getSubscriberId: () => Promise<SubscriberId | null>;
+  subscribeToNotifications: () => Promise<SubscriberId>;
+  unsubscribeFromNotifications: () => Promise<void>;
+  sendBeacon: (beacon: Beacon) => Promise<void>;
+}
+
+export const PushNotifications: IPushNotifications = {
+  getSubscriberId: async () => {
+    return await NativePushNotifications.getSubscriberId();
+  },
+
+  subscribeToNotifications: async () => {
+    if (Platform.OS === 'android' && Platform.Version >= 33) {
+      const hasNotificationsPermission = await PermissionsAndroid.check(
+        PermissionsAndroid.PERMISSIONS.POST_NOTIFICATIONS
+      );
+
+      if (!hasNotificationsPermission) {
+        const hasGrantedNotificationsPermission =
+          await PermissionsAndroid.request(
+            PermissionsAndroid.PERMISSIONS.POST_NOTIFICATIONS
+          );
+
+        if (!hasGrantedNotificationsPermission) {
+          throw new Error('Cannot subscribe to notifications: no permission');
+        }
+      }
+    }
+
+    return await NativePushNotifications.subscribeToNotifications();
+  },
+
+  unsubscribeFromNotifications: async () => {
+    await NativePushNotifications.unsubscribeFromNotifications();
+  },
+
+  sendBeacon: async (beacon) => {
+    await NativePushNotifications.sendBeacon({
+      selectors: Object.fromEntries(beacon.selectors.entries()),
+      tags: beacon.tags,
+      tagsToDelete: beacon.tagsToDelete,
+      customId: beacon.customId,
+      assignToGroup: beacon.assignToGroup,
+      unassignFromGroup: beacon.unassignFromGroup,
+    });
+  },
+};
+
+export {
+  Beacon,
+  type BeaconSelectorKey,
+  type BeaconSelectorValue,
+} from './beacon/Beacon';
+
+export { BeaconTag, BeaconTagStrategy } from './beacon/BeaconTag';

package/src/specs/NativePushNotifications.ts

@@ -0,0 +1,25 @@
+import { TurboModuleRegistry } from 'react-native';
+import type { TurboModule } from 'react-native';
+import type { BeaconTag } from '../beacon/BeaconTag';
+
+export type SubscriberId = string;
+
+interface SpecBeacon {
+  selectors: { [key: string]: string | number | boolean };
+  tags: BeaconTag[];
+  tagsToDelete: BeaconTag[];
+  customId: string | null;
+  assignToGroup: string | null;
+  unassignFromGroup: string | null;
+}
+
+export interface Spec extends TurboModule {
+  getSubscriberId: () => Promise<SubscriberId | null>;
+  subscribeToNotifications: () => Promise<SubscriberId>;
+  unsubscribeFromNotifications: () => Promise<void>;
+  sendBeacon: (beacon: SpecBeacon) => Promise<void>;
+}
+
+export default TurboModuleRegistry.getEnforcing<Spec>(
+  'PushPushGoPushNotifications'
+);