pushwave-client 0.3.9 → 0.3.10

package/dist/identify/identify.d.ts

@@ -1,2 +1,5 @@
 import { IdentifyOptions, IdentifyResponse } from "./identify.dto";
+/**
+ * Link a userId to the current installation. Requires a successful registerPushWave/init call.
+ */
 export declare function identify({ userId }: IdentifyOptions): Promise<IdentifyResponse>;

package/dist/identify/identify.js

@@ -8,6 +8,9 @@ const fetch_1 = require("../utils/fetch");
 const pwLogger_1 = require("../utils/pwLogger");
 const installationId_1 = require("../utils/installationId");
 const getApiKey_1 = require("../utils/getApiKey");
+/**
+ * Link a userId to the current installation. Requires a successful registerPushWave/init call.
+ */
 async function identify({ userId }) {
     const response = { success: false };
     if (!register_1.IS_INITIALIZED) {

package/dist/index.d.ts

@@ -3,10 +3,32 @@ import { IdentifyOptions, IdentifyResponse } from "./identify";
 import { LogoutResponse } from "./logout";
 import { GetUserAttributesResponse, SetUserAttributes, SetUserAttributesResponse } from "./userAttributes";
 export interface PushWaveClientType {
+    /**
+     * Initialize PushWave for this installation. Must be called once at app startup.
+     * - Requests push permissions + Expo push token.
+     * - Collects device/app metadata and attestation.
+     * - Caches the API key (SecureStore when available) and marks the client initialized.
+     */
     init(options: RegisterPushWaveClient): Promise<RegisterPushWaveResponse>;
+    /**
+     * Attach a userId to the current installation for targeting/analytics.
+     * Requires `init` to have run successfully in this session.
+     */
     identify(options: IdentifyOptions): Promise<IdentifyResponse>;
+    /**
+     * Unlink the current installation from the backend (e.g., on logout).
+     * Requires `init` to have run successfully in this session.
+     */
     logout(): Promise<LogoutResponse>;
+    /**
+     * Set custom attributes for the current user/installation.
+     * Requires `init` to have run successfully in this session.
+     */
     setUserAttributes(options: SetUserAttributes): Promise<SetUserAttributesResponse>;
+    /**
+     * Fetch stored attributes for the current user/installation.
+     * Requires `init` to have run successfully in this session.
+     */
     getUserAttributes(): Promise<GetUserAttributesResponse>;
 }
 declare const PushWaveClient: PushWaveClientType;

package/dist/logout/logout.d.ts

@@ -1,2 +1,5 @@
 import { LogoutResponse } from "./logout.dto";
+/**
+ * Unregister the current installation (e.g., on user logout). Requires a successful init.
+ */
 export declare function logout(): Promise<LogoutResponse>;

package/dist/logout/logout.js

@@ -8,6 +8,9 @@ const installationId_1 = require("../utils/installationId");
 const pwLogger_1 = require("../utils/pwLogger");
 const fetch_1 = require("../utils/fetch");
 const getApiKey_1 = require("../utils/getApiKey");
+/**
+ * Unregister the current installation (e.g., on user logout). Requires a successful init.
+ */
 async function logout() {
     const response = { success: false };
     if (!register_1.IS_INITIALIZED) {

package/dist/register/registerPushWave.d.ts

@@ -2,4 +2,9 @@ import { RegisterPushWaveClient, RegisterPushWaveResponse } from "./registerPush
 export declare var IS_INITIALIZED: boolean;
 export declare const API_STORAGE_KEY = "pushwave-api-storage-key";
 export declare var CACHE_API_KEY: string | false;
+/**
+ * Initialize PushWave for this installation: retrieves the Expo push token, collects
+ * attestation + device metadata, persists the API key when SecureStore is available,
+ * and caches initialization state for subsequent calls.
+ */
 export declare function registerPushWave({ apiKey }: RegisterPushWaveClient): Promise<RegisterPushWaveResponse>;

package/dist/register/registerPushWave.js

@@ -14,6 +14,11 @@ const loadSecureStore_1 = require("../utils/loadSecureStore");
 exports.IS_INITIALIZED = false;
 exports.API_STORAGE_KEY = "pushwave-api-storage-key";
 exports.CACHE_API_KEY = false;
+/**
+ * Initialize PushWave for this installation: retrieves the Expo push token, collects
+ * attestation + device metadata, persists the API key when SecureStore is available,
+ * and caches initialization state for subsequent calls.
+ */
 async function registerPushWave({ apiKey }) {
     const OS = react_native_1.Platform.OS;
     if ((0, apiKeyCheck_1.isSecretKey)(apiKey)) {

package/dist/userAttributes/userAttributes.d.ts

@@ -1,3 +1,9 @@
 import { GetUserAttributesResponse, SetUserAttributes, SetUserAttributesResponse } from "./userAttributes.dto";
+/**
+ * Set custom attributes for the current user/installation. Requires a successful init.
+ */
 export declare function setUserAttributes(attributes: SetUserAttributes): Promise<SetUserAttributesResponse>;
+/**
+ * Retrieve attributes for the current user/installation. Requires a successful init.
+ */
 export declare function getUserAttributes(): Promise<GetUserAttributesResponse>;

package/dist/userAttributes/userAttributes.js

@@ -9,6 +9,9 @@ const getApiKey_1 = require("../utils/getApiKey");
 const installationId_1 = require("../utils/installationId");
 const pwLogger_1 = require("../utils/pwLogger");
 const fetch_1 = require("../utils/fetch");
+/**
+ * Set custom attributes for the current user/installation. Requires a successful init.
+ */
 async function setUserAttributes(attributes) {
     const response = { success: false };
     if (!register_1.IS_INITIALIZED) {
@@ -50,6 +53,9 @@ async function setUserAttributes(attributes) {
         };
     }
 }
+/**
+ * Retrieve attributes for the current user/installation. Requires a successful init.
+ */
 async function getUserAttributes() {
     if (!register_1.IS_INITIALIZED) {
         const msg = `PushWaveClient.init({ apiKey }) must be called before PushWaveClient.getUserAttributes`;

package/package.json

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