pushwave-client 0.3.5 → 0.3.7

package/README.md

@@ -24,6 +24,16 @@ npm install pushwave-client
 npx expo install expo-notifications
 ```
 
+Optional (recommended): install [expo-secure-store](https://docs.expo.dev/versions/latest/sdk/securestore/) to persist the SDK’s installationId across app restarts:
+```bash
+npx expo install expo-secure-store
+```
+
+Optional (for richer device metadata: version/build, model, locale/timezone): install:
+```bash
+npx expo install expo-application expo-device expo-localization
+```
+
 2) Add the config plugin to your app.json / app.config.*:
 ```json
 {
@@ -109,4 +119,4 @@ export default function App() {
 
 ---
 
-*Roadmap is no longer tracked in this README; check the dashboard or docs for current feature status.*
+*Roadmap is no longer tracked in this README; check the dashboard or docs for current feature status.*

package/dist/register/registerPushWave.dto.d.ts

@@ -11,4 +11,12 @@ export interface RegisterPushWaveDTO {
     platform: string;
     appAttestation?: any;
     environment: "development" | "production";
+    appVersion: string;
+    buildNumber: string;
+    installationId: string;
+    osVersion: string;
+    deviceModel: string;
+    locale: string;
+    timezone: string;
+    countryCode: string;
 }

package/dist/register/registerPushWave.js

@@ -7,6 +7,8 @@ const pwLogger_1 = require("../utils/pwLogger");
 const apiKeyCheck_1 = require("../utils/apiKeyCheck");
 const index_1 = require("../attestation/index");
 const fetch_1 = require("../utils/fetch");
+const installationId_1 = require("../utils/installationId");
+const collectDeviceMetaData_1 = require("../utils/collectDeviceMetaData");
 async function registerPushWave({ apiKey }) {
     const OS = react_native_1.Platform.OS;
     if ((0, apiKeyCheck_1.isSecretKey)(apiKey)) {
@@ -26,12 +28,22 @@ async function registerPushWave({ apiKey }) {
     if (appAttestation.status === "disabled")
         pwLogger_1.PWLogger.warn(`(${react_native_1.Platform.OS}) could not get attestation: ${appAttestation.reason}`);
     const path = "expo-tokens";
+    const installationId = await (0, installationId_1.getInstallationId)();
+    const { appVersion, buildNumber, countryCode, deviceModel, locale, osVersion, timezone } = (0, collectDeviceMetaData_1.collectDeviceMetaData)();
     const options = {
         apiKey: apiKey,
         expoToken: expoToken,
         platform: OS,
         appAttestation: appAttestation,
-        environment: __DEV__ ? "development" : "production"
+        environment: __DEV__ ? "development" : "production",
+        installationId,
+        appVersion,
+        buildNumber,
+        countryCode,
+        deviceModel,
+        locale,
+        osVersion,
+        timezone
     };
     try {
         const res = await (0, fetch_1.fetchApi)("PUT", path, { data: options });

package/dist/utils/collectDeviceMetaData.d.ts

@@ -0,0 +1,10 @@
+export type DeviceMetaData = {
+    appVersion: string;
+    buildNumber: string;
+    countryCode: string;
+    deviceModel: string;
+    locale: string;
+    osVersion: string;
+    timezone: string;
+};
+export declare const collectDeviceMetaData: () => DeviceMetaData;

package/dist/utils/collectDeviceMetaData.js

@@ -0,0 +1,75 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.collectDeviceMetaData = void 0;
+const react_native_1 = require("react-native");
+const expo_constants_1 = __importDefault(require("expo-constants"));
+const loadApplication = () => {
+    try {
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        return require("expo-application");
+    }
+    catch (err) {
+        return null;
+    }
+};
+const loadDevice = () => {
+    try {
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        return require("expo-device");
+    }
+    catch (err) {
+        return null;
+    }
+};
+const loadLocalization = () => {
+    try {
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        return require("expo-localization");
+    }
+    catch (err) {
+        return null;
+    }
+};
+const collectDeviceMetaData = () => {
+    const application = loadApplication();
+    const device = loadDevice();
+    const localization = loadLocalization();
+    const appVersion = application?.nativeApplicationVersion ??
+        (expo_constants_1.default.expoConfig?.version ?? "");
+    const buildNumber = application?.nativeBuildVersion ??
+        (expo_constants_1.default.expoConfig?.ios?.buildNumber ??
+            (expo_constants_1.default.expoConfig?.android?.versionCode
+                ? String(expo_constants_1.default.expoConfig?.android?.versionCode)
+                : ""));
+    const deviceModel = device?.modelName ?? (expo_constants_1.default.deviceName ?? "");
+    const osVersion = device?.osVersion ?? (react_native_1.Platform.Version ? String(react_native_1.Platform.Version) : "");
+    const locales = localization?.getLocales?.() ?? [];
+    const primaryLocale = locales[0];
+    const locale = primaryLocale?.languageTag ??
+        (typeof Intl !== "undefined"
+            ? Intl.DateTimeFormat().resolvedOptions().locale
+            : "");
+    const countryCode = primaryLocale?.regionCode ??
+        (() => {
+            const parts = locale?.split?.("-") ?? [];
+            return parts.length > 1 ? parts[parts.length - 1].toUpperCase() : "";
+        })();
+    const calendars = localization?.getCalendars?.() ?? [];
+    const timezone = calendars[0]?.timeZone ??
+        (typeof Intl !== "undefined"
+            ? Intl.DateTimeFormat().resolvedOptions().timeZone ?? ""
+            : "");
+    return {
+        appVersion: appVersion ?? "",
+        buildNumber: buildNumber ?? "",
+        countryCode: countryCode ?? "",
+        deviceModel: deviceModel ?? "",
+        locale: locale ?? "",
+        osVersion: osVersion ?? "",
+        timezone: timezone ?? ""
+    };
+};
+exports.collectDeviceMetaData = collectDeviceMetaData;

package/dist/utils/fetch.js

@@ -11,7 +11,6 @@ async function fetchApi(method, path, { params, data } = {}) {
             return acc;
         }, {})).toString()
         : "";
-    console.log("Go fetch !");
     const url = BASE_URL + path + (search ? `?${search}` : "");
     const headers = {};
     const body = data !== undefined && method !== "GET" ? JSON.stringify(data) : undefined;

package/dist/utils/installationId.d.ts

@@ -0,0 +1 @@
+export declare const getInstallationId: () => Promise<string>;

package/dist/utils/installationId.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getInstallationId = void 0;
+const pwLogger_1 = require("./pwLogger");
+const STORAGE_KEY = "pushwave-installation-id";
+let cachedId = null;
+let warnedMissingSecureStore = false;
+const generateId = () => {
+    if (typeof crypto !== "undefined" && typeof crypto.randomUUID === "function") {
+        return crypto.randomUUID();
+    }
+    // Fallback UUID-ish generator
+    const bytes = new Uint8Array(16);
+    if (typeof crypto !== "undefined" && typeof crypto.getRandomValues === "function") {
+        crypto.getRandomValues(bytes);
+    }
+    else {
+        for (let i = 0; i < bytes.length; i++) {
+            bytes[i] = Math.floor(Math.random() * 256);
+        }
+    }
+    const hex = Array.from(bytes, (b) => b.toString(16).padStart(2, "0")).join("");
+    return [
+        hex.slice(0, 8),
+        hex.slice(8, 12),
+        hex.slice(12, 16),
+        hex.slice(16, 20),
+        hex.slice(20)
+    ].join("-");
+};
+const loadSecureStore = () => {
+    try {
+        return require("expo-secure-store");
+    }
+    catch (err) {
+        return null;
+    }
+};
+const getInstallationId = async () => {
+    if (cachedId)
+        return cachedId;
+    const SecureStore = loadSecureStore();
+    if (SecureStore) {
+        try {
+            const existing = await SecureStore.getItemAsync(STORAGE_KEY);
+            if (existing) {
+                cachedId = existing;
+                return existing;
+            }
+        }
+        catch (err) {
+            pwLogger_1.PWLogger.warn("Failed reading installationId from SecureStore:", err);
+        }
+        const id = generateId();
+        try {
+            await SecureStore.setItemAsync(STORAGE_KEY, id);
+        }
+        catch (err) {
+            pwLogger_1.PWLogger.warn("Failed persisting installationId to SecureStore:", err);
+        }
+        cachedId = id;
+        return id;
+    }
+    if (!warnedMissingSecureStore) {
+        warnedMissingSecureStore = true;
+        pwLogger_1.PWLogger.warn("expo-secure-store not installed; installationId will not persist across app restarts. Install expo-secure-store for better targeting.");
+    }
+    // Non-persistent fallback
+    cachedId = generateId();
+    return cachedId;
+};
+exports.getInstallationId = getInstallationId;

package/dist/utils/pushwaveSettings.js

@@ -9,7 +9,6 @@ const pushwaveSettingsPromise = (async () => {
         return await (0, fetch_1.fetchApi)("GET", "pushwave-config", { params: { platform: react_native_1.Platform.OS } });
     }
     catch (e) {
-        // log si besoin
         pwLogger_1.PWLogger.warn(`Unable to load PushWave configuration: ${e}`);
         return {};
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pushwave-client",
-  "version": "0.3.5",
+  "version": "0.3.7",
   "description": "PushWave Client, Expo Push Notifications SaaS SDK",
   "homepage": "https://github.com/luruk-hai/pushwave-client#readme",
   "bugs": {
@@ -25,7 +25,25 @@
     "expo-constants": "*",
     "expo-notifications": "*",
     "react-native": "*",
-    "expo": "*"
+    "expo": "*",
+    "expo-secure-store": "*",
+    "expo-application": "*",
+    "expo-device": "*",
+    "expo-localization": "*"
+  },
+  "peerDependenciesMeta": {
+    "expo-secure-store": {
+      "optional": true
+    },
+    "expo-application": {
+      "optional": true
+    },
+    "expo-device": {
+      "optional": true
+    },
+    "expo-localization": {
+      "optional": true
+    }
   },
   "dependencies": {
     "cross-fetch": "^4.1.0",

package/src/register/registerPushWave.dto.ts

@@ -12,5 +12,13 @@ export interface RegisterPushWaveDTO {
     expoToken: string;
     platform: string;
     appAttestation?: any;
-    environment: "development" | "production"
+    environment: "development" | "production",
+    appVersion: string;
+    buildNumber: string;
+    installationId: string;
+    osVersion: string;
+    deviceModel: string;
+    locale: string;
+    timezone: string;
+    countryCode: string;
 }

package/src/register/registerPushWave.ts

@@ -5,6 +5,8 @@ import { isSecretKey } from "../utils/apiKeyCheck";
 import { RegisterPushWaveClient, RegisterPushWaveDTO, RegisterPushWaveResponse } from "./registerPushWave.dto";
 import { getApplicationAttestation } from "../attestation/index";
 import { fetchApi } from "../utils/fetch";
+import { getInstallationId } from "../utils/installationId";
+import { collectDeviceMetaData } from "../utils/collectDeviceMetaData";
 
 export async function registerPushWave(
     { apiKey }: RegisterPushWaveClient
@@ -37,12 +39,24 @@ export async function registerPushWave(
 
     const path = "expo-tokens"
 
+    const installationId = await getInstallationId();
+
+    const { appVersion, buildNumber, countryCode, deviceModel, locale, osVersion, timezone } = collectDeviceMetaData();
+
     const options: RegisterPushWaveDTO = {
         apiKey: apiKey,
         expoToken: expoToken,
         platform: OS,
         appAttestation: appAttestation,
-        environment: __DEV__ ? "development" : "production"
+        environment: __DEV__ ? "development" : "production",
+        installationId,
+        appVersion,
+        buildNumber,
+        countryCode,
+        deviceModel,
+        locale,
+        osVersion,
+        timezone
     }
 
     try {

package/src/utils/collectDeviceMetaData.ts

@@ -0,0 +1,111 @@
+import { Platform } from "react-native";
+import Constants from "expo-constants";
+
+export type DeviceMetaData = {
+  appVersion: string;
+  buildNumber: string;
+  countryCode: string;
+  deviceModel: string;
+  locale: string;
+  osVersion: string;
+  timezone: string;
+};
+
+type ApplicationModule = {
+  nativeApplicationVersion?: string | null;
+  nativeBuildVersion?: string | null;
+};
+
+type DeviceModule = {
+  modelName?: string | null;
+  osVersion?: string | null;
+};
+
+type LocalizationModule = {
+  getLocales?: () => Array<{
+    languageTag?: string;
+    regionCode?: string;
+  }>;
+  getCalendars?: () => Array<{
+    timeZone?: string;
+  }>;
+};
+
+const loadApplication = (): ApplicationModule | null => {
+  try {
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    return require("expo-application") as ApplicationModule;
+  } catch (err) {
+    return null;
+  }
+};
+
+const loadDevice = (): DeviceModule | null => {
+  try {
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    return require("expo-device") as DeviceModule;
+  } catch (err) {
+    return null;
+  }
+};
+
+const loadLocalization = (): LocalizationModule | null => {
+  try {
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    return require("expo-localization") as LocalizationModule;
+  } catch (err) {
+    return null;
+  }
+};
+
+export const collectDeviceMetaData = (): DeviceMetaData => {
+  const application = loadApplication();
+  const device = loadDevice();
+  const localization = loadLocalization();
+
+  const appVersion =
+    application?.nativeApplicationVersion ??
+    (Constants.expoConfig?.version ?? "");
+
+  const buildNumber =
+    application?.nativeBuildVersion ??
+    (Constants.expoConfig?.ios?.buildNumber ??
+      (Constants.expoConfig?.android?.versionCode
+        ? String(Constants.expoConfig?.android?.versionCode)
+        : ""));
+
+  const deviceModel = device?.modelName ?? (Constants.deviceName ?? "");
+  const osVersion = device?.osVersion ?? (Platform.Version ? String(Platform.Version) : "");
+
+  const locales = localization?.getLocales?.() ?? [];
+  const primaryLocale = locales[0];
+  const locale =
+    primaryLocale?.languageTag ??
+    (typeof Intl !== "undefined"
+      ? Intl.DateTimeFormat().resolvedOptions().locale
+      : "");
+
+  const countryCode =
+    primaryLocale?.regionCode ??
+    (() => {
+      const parts = locale?.split?.("-") ?? [];
+      return parts.length > 1 ? parts[parts.length - 1].toUpperCase() : "";
+    })();
+
+  const calendars = localization?.getCalendars?.() ?? [];
+  const timezone =
+    calendars[0]?.timeZone ??
+    (typeof Intl !== "undefined"
+      ? Intl.DateTimeFormat().resolvedOptions().timeZone ?? ""
+      : "");
+
+  return {
+    appVersion: appVersion ?? "",
+    buildNumber: buildNumber ?? "",
+    countryCode: countryCode ?? "",
+    deviceModel: deviceModel ?? "",
+    locale: locale ?? "",
+    osVersion: osVersion ?? "",
+    timezone: timezone ?? ""
+  };
+};

package/src/utils/fetch.ts

@@ -19,8 +19,6 @@ export async function fetchApi<TResponse>(
       ).toString()
     : "";
 
-    console.log("Go fetch !");
-
   const url = BASE_URL + path + (search ? `?${search}` : "");
 
   const headers: Record<string, string> = {};

package/src/utils/installationId.ts

@@ -0,0 +1,82 @@
+import { PWLogger } from "./pwLogger";
+
+const STORAGE_KEY = "pushwave-installation-id";
+
+let cachedId: string | null = null;
+let warnedMissingSecureStore = false;
+
+type SecureStoreModule = {
+    getItemAsync(key: string): Promise<string | null>;
+    setItemAsync(key: string, value: string): Promise<void>;
+};
+
+const generateId = (): string => {
+    if (typeof crypto !== "undefined" && typeof crypto.randomUUID === "function") {
+        return crypto.randomUUID();
+    }
+
+    // Fallback UUID-ish generator
+    const bytes = new Uint8Array(16);
+    if (typeof crypto !== "undefined" && typeof crypto.getRandomValues === "function") {
+        crypto.getRandomValues(bytes);
+    } else {
+        for (let i = 0; i < bytes.length; i++) {
+            bytes[i] = Math.floor(Math.random() * 256);
+        }
+    }
+
+    const hex = Array.from(bytes, (b) => b.toString(16).padStart(2, "0")).join("");
+    return [
+        hex.slice(0, 8),
+        hex.slice(8, 12),
+        hex.slice(12, 16),
+        hex.slice(16, 20),
+        hex.slice(20)
+    ].join("-");
+};
+
+const loadSecureStore = (): SecureStoreModule | null => {
+    try {
+        return require("expo-secure-store") as SecureStoreModule;
+    } catch (err) {
+        return null;
+    }
+};
+
+export const getInstallationId = async (): Promise<string> => {
+    if (cachedId) return cachedId;
+
+    const SecureStore = loadSecureStore();
+
+    if (SecureStore) {
+        try {
+            const existing = await SecureStore.getItemAsync(STORAGE_KEY);
+            if (existing) {
+                cachedId = existing;
+                return existing;
+            }
+        } catch (err) {
+            PWLogger.warn("Failed reading installationId from SecureStore:", err);
+        }
+
+        const id = generateId();
+        try {
+            await SecureStore.setItemAsync(STORAGE_KEY, id);
+        } catch (err) {
+            PWLogger.warn("Failed persisting installationId to SecureStore:", err);
+        }
+        cachedId = id;
+        return id;
+    }
+
+    if (!warnedMissingSecureStore) {
+        warnedMissingSecureStore = true;
+        PWLogger.warn(
+            "expo-secure-store not installed; installationId will not persist across app restarts. Install expo-secure-store for better targeting."
+        );
+    }
+
+    // Non-persistent fallback
+    cachedId = generateId();
+    return cachedId;
+};

package/src/utils/pushwaveSettings.ts

@@ -11,7 +11,6 @@ const pushwaveSettingsPromise: Promise<PushwaveSettings> = (async () => {
     try {
         return await fetchApi("GET", "pushwave-config", { params: { platform: Platform.OS } });
     } catch (e) {
-        // log si besoin
         PWLogger.warn(`Unable to load PushWave configuration: ${e}`)
         return {}
     }