pushwave-client 0.2.4 → 0.2.6

package/README.md

@@ -0,0 +1,107 @@
+# pushwave-client (alpha)
+
+PushWave is a lightweight Expo-first SDK to get push notifications running without building your own backend or wrestling with native setup. It fetches the Expo push token and prepares app attestation (Android Play Integrity / iOS DeviceCheck) so you can secure delivery. The SaaS dashboard (scheduling, targeting, templates, cron-like sends) is coming soon. **Consider this an early-stage project**.
+
+---
+
+## Why PushWave?
+
+- **No backend needed**: token storage, targeting logic, scheduling, and sending are all handled by PushWave’s cloud. Forget cron jobs and custom endpoints.
+- **Expo-first design**: auto-linking, config plugin, no manual Gradle/Pod edits. Works seamlessly with EAS, dev clients, and Expo Router.
+- **Native attestation (roadmap)**: Play Integrity on Android + DeviceCheck on iOS to reduce spoofed APKs, fake tokens, and leaked API keys.
+- **One-line setup**: `PushWaveClient.init({ apiKey })` retrieves the Expo token, performs attestation when required, and logs enhanced debug info under `__DEV__`.
+- **Dashboard-first workflow (roadmap)**: audiences, groups, segments, templates, one-off or recurring pushes without touching Firebase or APNs directly.
+- **Minimal external config**: for Android you still upload your FCM credentials to Expo (required by the platform), but PushWave handles the rest.
+
+---
+
+## Quick install
+
+1) Install the [SDK](https://www.npmjs.com/package/pushwave-client) and [Expo notifications](https://docs.expo.dev/versions/latest/sdk/notifications/) (peer requirement):
+```bash
+npm install pushwave-client
+npx expo install expo-notifications
+```
+
+2) Add the config plugin to your app.json / app.config.*:
+```json
+{
+  "expo": {
+    "plugins": ["pushwave-client"]
+  }
+}
+```
+
+3) Build native (EAS or dev client). Expo Go is not supported once native code is involved:
+```bash
+eas build -p android --profile development
+eas build -p ios --profile development
+```
+
+---
+
+## Minimal usage
+
+```tsx
+import { useEffect } from "react";
+import { Alert } from "react-native";
+import PushWaveClient from "pushwave-client";
+
+export default function App() {
+  useEffect(() => {
+    (async () => {
+      const res = await PushWaveClient.init({ apiKey: "pw_dev_xxx" });
+      if (!res.success) {
+        Alert.alert("PushWave", res.message ?? "Init failed");
+      }
+    })();
+  }, []);
+
+  return /* …your UI… */;
+}
+```
+
+- `PushWaveClient.init` is async and returns `{ success: boolean; message?: string }`.
+- Call it **once** at app startup (e.g., in `App.tsx` or a root component `useEffect`). Recalling it later is unnecessary.
+- In `__DEV__`, the SDK may log additional info/errors (e.g., failed API calls) to help debugging.
+
+---
+
+## Notifications (expo-notifications)
+
+- The SDK retrieves the user’s Expo push token. If the user denies notification permission, no push will be delivered and the token may not be available depending on platform/permission.
+- On iOS, user permission is required to obtain a push token.
+- On Android, Expo handles permission/channel setup; if the user refuses, no push is delivered.
+- You still need to provide FCM credentials to Expo for Android push (standard Expo requirement).
+
+---
+
+## Attestation (current status)
+
+- Backend validation is not live yet; it will arrive with the PushWave SaaS.
+- Android (Play Integrity): will require a build distributed via the Play Store (internal/closed track) with Play App Signing + Play Integrity API enabled. No support for Expo Go / sideload.
+- iOS (DeviceCheck): will require a real build (dev client or TestFlight), not Expo Go.
+- For now, consider attestation non-blocking (the SDK may return a `disabled` flag until the SaaS is active).
+
+---
+
+## Compatibility
+
+- Tested on the latest Expo SDK (54). No guarantees on earlier versions.
+- Requires a native build (EAS or dev client).
+
+---
+
+## Links
+
+- NPM: https://www.npmjs.com/package/pushwave-client
+- GitHub: https://github.com/luruk-hai/pushwave-client#readme
+
+---
+
+## Roadmap (with SaaS)
+
+- Server-side validation of Play Integrity / DeviceCheck tokens.
+- Full attestation docs and Play Store setup (enable Integrity API, internal track).
+- Dashboard for targeting, templates, scheduling (one-off and cron-like).
+- Complete registration flow with the PushWave backend.

package/dist/attestation/attestation.types.d.ts

@@ -0,0 +1,22 @@
+export interface AndroidAttestationPayload {
+    status: "ok";
+    platform: "android";
+    nonce: string;
+    timestamp: number;
+    integrityToken: string;
+}
+export interface IosAttestationPayload {
+    status: "ok";
+    platform: "ios";
+    nonce: string;
+    timestamp: number;
+    deviceCheckToken: string;
+}
+export interface DisabledAttestation {
+    status: "disabled";
+    reason: string;
+}
+export interface SkippedAttestation {
+    status: "skipped";
+}
+export type ApplicationAttestation = AndroidAttestationPayload | IosAttestationPayload | DisabledAttestation | SkippedAttestation;

package/dist/attestation/attestation.types.js

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

package/dist/attestation/getApplicationAttestation.d.ts

@@ -1,23 +1,2 @@
-export interface AndroidAttestationPayload {
-    status: "ok";
-    platform: "android";
-    nonce: string;
-    timestamp: number;
-    integrityToken: string;
-}
-export interface IosAttestationPayload {
-    status: "ok";
-    platform: "ios";
-    nonce: string;
-    timestamp: number;
-    deviceCheckToken: string;
-}
-export interface DisabledAttestation {
-    status: "disabled";
-    reason: string;
-}
-export interface SkippedAttestation {
-    status: "skipped";
-}
-export type ApplicationAttestation = AndroidAttestationPayload | IosAttestationPayload | DisabledAttestation | SkippedAttestation;
-export default function getApplicationAttestation(apiKey: string): Promise<ApplicationAttestation>;
+import { ApplicationAttestation } from "./index";
+export declare function getApplicationAttestation(apiKey: string): Promise<ApplicationAttestation>;

package/dist/attestation/getApplicationAttestation.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = getApplicationAttestation;
+exports.getApplicationAttestation = getApplicationAttestation;
 const buffer_1 = require("buffer");
 const react_native_1 = require("react-native");
 const native_1 = require("./native");

package/dist/attestation/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./attestation.types";
+export * from "./getApplicationAttestation";

package/dist/attestation/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (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" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./attestation.types"), exports);
+__exportStar(require("./getApplicationAttestation"), exports);

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { RegisterPushWaveClient, RegisterPushWaveResponse } from "./registerPushWave";
+import { RegisterPushWaveClient, RegisterPushWaveResponse } from "./register";
 export interface PushWaveClientType {
     init(options: RegisterPushWaveClient): Promise<RegisterPushWaveResponse>;
 }

package/dist/index.js

@@ -1,12 +1,9 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-const registerPushWave_1 = __importDefault(require("./registerPushWave"));
+const register_1 = require("./register");
 const PushWaveClient = {
     init(options) {
-        return (0, registerPushWave_1.default)(options);
+        return (0, register_1.registerPushWave)(options);
     },
 };
 exports.default = PushWaveClient;

package/dist/register/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./registerPushWave";
+export * from "./registerPushWave.dto";

package/dist/register/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (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" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./registerPushWave"), exports);
+__exportStar(require("./registerPushWave.dto"), exports);

package/dist/register/registerPushWave.d.ts

@@ -0,0 +1,2 @@
+import { RegisterPushWaveClient, RegisterPushWaveResponse } from "./registerPushWave.dto";
+export declare function registerPushWave({ apiKey }: RegisterPushWaveClient): Promise<RegisterPushWaveResponse>;

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

@@ -0,0 +1,14 @@
+export interface RegisterPushWaveClient {
+    apiKey: string;
+}
+export interface RegisterPushWaveResponse {
+    success: boolean;
+    message?: string;
+}
+export interface RegisterPushWaveDTO {
+    apiKey: string;
+    expoToken: string;
+    platform: string;
+    appAttestation?: any;
+    environment: "development" | "production";
+}

package/dist/register/registerPushWave.dto.js

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

package/dist/register/registerPushWave.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerPushWave = registerPushWave;
+const fetch_1 = require("../utils/fetch");
+const expoToken_1 = require("../utils/expoToken");
+const react_native_1 = require("react-native");
+const pwLogger_1 = require("../utils/pwLogger");
+const apiKeyCheck_1 = require("../utils/apiKeyCheck");
+const index_1 = require("../attestation/index");
+async function registerPushWave({ apiKey }) {
+    if ((0, apiKeyCheck_1.isSecretKey)(apiKey)) {
+        const warn = `\x1b[0m You are using your SECRET API key in a client environment. This key must NEVER be embedded in a mobile app.`;
+        pwLogger_1.PWLogger.warn(warn);
+    }
+    const expoToken = await (0, expoToken_1.getExpoToken)();
+    if (!expoToken) {
+        const message = "could not get ExpoToken";
+        pwLogger_1.PWLogger.error(message);
+        return {
+            success: false,
+            message: "[PushWaveClient] Error: " + message
+        };
+    }
+    const appAttestation = await (0, index_1.getApplicationAttestation)(apiKey);
+    if (appAttestation.status === "disabled")
+        pwLogger_1.PWLogger.warn(`(${react_native_1.Platform.OS}) could not get attestation: ${appAttestation.reason}`);
+    const path = "/v1/expo-tokens";
+    const options = {
+        apiKey: apiKey,
+        expoToken: expoToken,
+        platform: react_native_1.Platform.OS,
+        appAttestation: appAttestation,
+        environment: __DEV__ ? "development" : "production"
+    };
+    try {
+        const res = await (0, fetch_1.fetchApi)(path, options);
+        return {
+            success: true,
+            message: res.message,
+        };
+    }
+    catch (err) {
+        const e = err;
+        pwLogger_1.PWLogger.error(e.message);
+        return {
+            success: false,
+            message: e.message,
+        };
+    }
+}

package/dist/registerPushWave.d.ts

@@ -5,10 +5,11 @@ export interface RegisterPushWaveResponse {
     success: boolean;
     message?: string;
 }
-export interface RegisterPushWaveOptions {
+export interface RegisterPushWaveDTO {
     apiKey: string;
     expoToken: string;
     platform: string;
     appAttestation?: any;
+    environment: "development" | "production";
 }
 export default function registerPushWave({ apiKey }: RegisterPushWaveClient): Promise<RegisterPushWaveResponse>;

package/dist/registerPushWave.js

@@ -32,7 +32,8 @@ async function registerPushWave({ apiKey }) {
         apiKey: apiKey,
         expoToken: expoToken,
         platform: react_native_1.Platform.OS,
-        appAttestation: appAttestation
+        appAttestation: appAttestation,
+        environment: __DEV__ ? "development" : "production"
     };
     try {
         const res = await (0, fetch_1.fetchApi)(path, options);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pushwave-client",
-  "version": "0.2.4",
+  "version": "0.2.6",
   "description": "PushWave Client, Expo Push Notifications SaaS SDK",
   "homepage": "https://github.com/luruk-hai/pushwave-client#readme",
   "bugs": {

package/src/attestation/attestation.types.ts

@@ -0,0 +1,30 @@
+export interface AndroidAttestationPayload {
+    status: "ok";
+    platform: "android";
+    nonce: string;
+    timestamp: number;
+    integrityToken: string;
+}
+
+export interface IosAttestationPayload {
+    status: "ok";
+    platform: "ios";
+    nonce: string;
+    timestamp: number;
+    deviceCheckToken: string;
+}
+
+export interface DisabledAttestation {
+    status: "disabled";
+    reason: string;
+}
+
+export interface SkippedAttestation {
+    status: "skipped";
+}
+
+export type ApplicationAttestation =
+    | AndroidAttestationPayload
+    | IosAttestationPayload
+    | DisabledAttestation
+    | SkippedAttestation;

package/src/attestation/getApplicationAttestation.ts

@@ -1,39 +1,9 @@
 import { Buffer } from "buffer";
 import { Platform } from "react-native";
 import { getAndroidIntegrityToken, getDeviceCheckToken } from "./native";
+import { ApplicationAttestation, AndroidAttestationPayload, DisabledAttestation, IosAttestationPayload } from "./index";
 
-export interface AndroidAttestationPayload {
-    status: "ok";
-    platform: "android";
-    nonce: string;
-    timestamp: number;
-    integrityToken: string;
-}
-
-export interface IosAttestationPayload {
-    status: "ok";
-    platform: "ios";
-    nonce: string;
-    timestamp: number;
-    deviceCheckToken: string;
-}
-
-export interface DisabledAttestation {
-    status: "disabled";
-    reason: string;
-}
-
-export interface SkippedAttestation {
-    status: "skipped";
-}
-
-export type ApplicationAttestation =
-    | AndroidAttestationPayload
-    | IosAttestationPayload
-    | DisabledAttestation
-    | SkippedAttestation;
-
-export default async function getApplicationAttestation(apiKey: string): Promise<ApplicationAttestation> {
+export async function getApplicationAttestation(apiKey: string): Promise<ApplicationAttestation> {
     if (!requiresAttestation(apiKey)) return { status: "skipped" };
 
     const { nonce, timestamp } = createNonce();

package/src/attestation/index.ts

@@ -0,0 +1,2 @@
+export * from "./attestation.types";
+export * from "./getApplicationAttestation";

package/src/index.ts

@@ -1,7 +1,4 @@
-import registerPushWave, {
-    RegisterPushWaveClient,
-  RegisterPushWaveResponse,
-} from "./registerPushWave";
+import { registerPushWave, RegisterPushWaveClient, RegisterPushWaveResponse } from "./register";
 
 export interface PushWaveClientType {
   init(options: RegisterPushWaveClient): Promise<RegisterPushWaveResponse>;

package/src/register/index.ts

@@ -0,0 +1,2 @@
+export * from "./registerPushWave";
+export * from "./registerPushWave.dto";

package/src/register/registerPushWave.dto.ts

@@ -0,0 +1,16 @@
+export interface RegisterPushWaveClient {
+    apiKey: string;
+}
+
+export interface RegisterPushWaveResponse {
+    success: boolean;
+    message?: string;
+}
+
+export interface RegisterPushWaveDTO {
+    apiKey: string;
+    expoToken: string;
+    platform: string;
+    appAttestation?: any;
+    environment: "development" | "production"
+}

package/src/{registerPushWave.ts → register/registerPushWave.ts}

@@ -1,28 +1,12 @@
-import { fetchApi } from "./utils/fetch";
-import { getExpoToken } from "./utils/expoToken";
-import getApplicationAttestation from "./attestation/getApplicationAttestation";
+import { fetchApi } from "../utils/fetch";
+import { getExpoToken } from "../utils/expoToken";
 import { Platform } from "react-native";
-import { PWLogger } from "./utils/pwLogger";
-import { isSecretKey } from "./utils/apiKeyCheck";
+import { PWLogger } from "../utils/pwLogger";
+import { isSecretKey } from "../utils/apiKeyCheck";
+import { RegisterPushWaveClient, RegisterPushWaveDTO, RegisterPushWaveResponse } from "./registerPushWave.dto";
+import { getApplicationAttestation } from "../attestation/index";
 
-export interface RegisterPushWaveClient {
-    apiKey: string;
-}
-
-export interface RegisterPushWaveResponse {
-    success: boolean;
-    message?: string;
-}
-
-export interface RegisterPushWaveOptions {
-    apiKey: string;
-    expoToken: string;
-    platform: string;
-    appAttestation?: any;
-    environment: "development" | "production"
-}
-
-export default async function registerPushWave(
+export async function registerPushWave(
     { apiKey }: RegisterPushWaveClient
 ): Promise<RegisterPushWaveResponse> {
 
@@ -52,7 +36,7 @@ export default async function registerPushWave(
 
     const path = "/v1/expo-tokens"
 
-    const options: RegisterPushWaveOptions = {
+    const options: RegisterPushWaveDTO = {
         apiKey: apiKey,
         expoToken: expoToken,
         platform: Platform.OS,

package/src/utils/fetch.ts

@@ -33,4 +33,4 @@ export async function fetchApi<TResponse>(
   }
 
   return json as TResponse;
-}
+}