@namiml/web-sdk 1.3.2 → 1.5.0

package/dist/nami/customer.d.ts

@@ -1,8 +1,11 @@
-import { Callback } from "src/types/components/containers";
-import { AccountStateAction } from "src/types/profile";
+import { Callback } from "../types/components/containers";
+import { AccountStateAction } from "../types/profile";
+import { NamiCustomerJourneyStateHandler } from "../types/customer";
+import { CustomerJourneyState } from "../types/externals/customer";
 type AccountStateHandler = (action: AccountStateAction, success: boolean, error?: Error) => void;
 /**
- * NamiCustomerManager provides methods for managing customer-related functionality.
+ * @class NamiCustomerManager
+ * Provides methods for managing customer-related functionality.
  */
 export declare class NamiCustomerManager {
     static instance: NamiCustomerManager;
@@ -16,35 +19,53 @@ export declare class NamiCustomerManager {
     /**
      * Returns the external ID of the currently logged in user.
      *
-     * @returns The external ID of the logged in user.
+     * @returns {string | undefined} The external ID of the logged in user.
     */
     static loggedInId(): string | undefined;
     /**
      * Logs in a customer with the specified ID.
      *
      * @param id - The ID of the customer to log in. Must be a SHA256 hash or UUID.
-     * @returns A Promise that resolves when the login is successful.
+     * @returns {Promise<void>} A Promise that resolves when the login is successful.
     */
     static login(externalId: string): Promise<void>;
+    /**
+     * This method detaches the whole platform account from the signed in user
+     * @returns {Promise<void>} A Promise that resolves when the logout is successful.
+     */
     static logout(): Promise<void>;
+    /**
+     * This method for connecting the device to a Customer Data Platform identifier
+     *
+     * Advanced use case. Make sure you have user consent.
+     *
+     * @param id a value supplied from your CDP platform
+     * @returns {Promise<void>} A Promise that resolves when CustomerDataPlatformId will be set.
+     */
     static setCustomerDataPlatformId(id: string): Promise<void>;
+    /**
+     * This method for clearing the Customer Data Platform identifier linked to this device
+     *
+     * Advanced use case.
+     * @returns {Promise<void>} A Promise that resolves when CustomerDataPlatformId will be cleared.
+     */
     static clearCustomerDataPlatformId(): Promise<void>;
     /**
      * Registers a callback function to handle changes in the account state.
      *
      * @param callback - The callback function to be registered.
-     * @returns A function that can be used to unregister the original callback.
+     * @returns {Callback} A function that can be used to unregister the original callback.
      */
-    static registerAccountStateHandler(callback: AccountStateHandler): Callback;
+    static registerAccountStateHandler(handler: AccountStateHandler): Callback;
     /**
      * Sets the anonymous mode for the customer.
      *
      * @param enabled - A boolean value indicating whether the anonymous mode should be enabled or disabled.
-     * @returns A Promise that resolves when the anonymous mode is set.
+     * @returns {Promise<void>} A Promise that resolves when the anonymous mode is set.
      */
     static setAnonymousMode(enabled: boolean): Promise<void>;
     /**
-     * Returns whether or not the SDK is currently operating in anonymous mode
+     * @returns {boolean} whether or not the SDK is currently operating in anonymous mode
      */
     static inAnonymousMode(): boolean;
     /**
@@ -58,9 +79,15 @@ export declare class NamiCustomerManager {
      * Retrieves the value for a given key in the on-device customer attribute key/value store.
      *
      * @param key - The name of the attribute. For example: `firstName`
-     * @returns The value of the customer attribute.
+     * @returns {string | null} The value of the customer attribute.
      */
     static getCustomerAttribute(key: string): string | null;
+    /**
+    * Retrieves all the customer attribute key/value store.
+    *
+    * @returns {string | null} The value of the customer attribute.
+    */
+    static getAllCustomerAttributes(): string[];
     /**
      * Clears a value of the given key in the on-device key/value store.
      *
@@ -69,9 +96,26 @@ export declare class NamiCustomerManager {
     static clearCustomerAttribute(key: string): void;
     /**
      * Clear all customer attributes from the on-device key/value store.
-     *
      */
     static clearAllCustomerAttributes(): void;
+    /**
+     * @return current customer's journey state.
+     */
+    static journeyState(): CustomerJourneyState | null;
+    /**
+     * @return the unique identifier Nami users to identify this device. Please note
+     * you should not depend on the device identifier persisting across app re-installs.
+     */
+    static deviceId(): string;
+    /**
+     * When there has been an update received to the active entitlements,
+     * the Nami SDK will provide notification of that event through
+     * this callback with list of active [NamiEntitlement]
+     *
+     * @param {NamiCustomerJourneyStateHandler} handler - The callback function that will be invoked when the campaign list is updated.
+     * @returns {Callback} A function that can be called to unregister the handler.
+     */
+    static registerJourneyStateHandler(handler: NamiCustomerJourneyStateHandler): Callback | undefined;
     /**
      * Private Static Methods
      */
@@ -82,9 +126,9 @@ export declare class NamiCustomerManager {
     private get isSDKInitialized();
     private static updateCustomerDataPlatformId;
     /**
-   * Returns whether or not the configured app platform id belongs to an anonymous mode
-   * capable Nami account.
-   */
+     * @returns whether or not the configured app platform id belongs to an anonymous mode
+     * capable Nami account.
+     */
     private static anonymousModeCapability;
     private static refetchConfig;
 }

package/dist/nami/emitter.d.ts

@@ -7,6 +7,7 @@ export declare class NamiEventEmitter {
     emit(eventName: string, ...args: any[]): void;
     addListener(eventName: string, listener: (...args: any[]) => void): void;
     removeListener(eventName: string, listener: (...args: any[]) => void): void;
+    removeAllListeners(eventName?: string): void;
     listeners(eventName: string): any[];
     listenerCount(eventName: string): number;
 }

package/dist/nami/entitlement.d.ts

@@ -1,10 +1,14 @@
-import { NamiActiveEntitlementsHandler, NamiEntitlement } from "src/types/entitlements";
-import { Callback } from "src/types/components/containers";
+import { NamiActiveEntitlementsHandler, NamiEntitlement } from "../types/entitlements";
+import { Callback } from "../types/components/containers";
+/**
+ * @class NamiEntitlementManager
+ * Contains all methods and objects to work with entitlements in the SDK.
+ */
 export declare class NamiEntitlementManager {
     static instance: NamiEntitlementManager;
     private emitter;
     /**
-     * @returns list of currently active entitlements
+     * @returns {NamiEntitlement[]} A list of currently active entitlements
      */
     static active(): NamiEntitlement[];
     /**
@@ -12,16 +16,29 @@ export declare class NamiEntitlementManager {
      * and it's not expired.
      *
      * @param referenceId - entitlement referenceId
-     * @returns True if the entitlement is active for given referenceId, false otherwise.
+     * @returns {boolean} True if the entitlement is active for given referenceId, false otherwise.
      */
     static isEntitlementActive(referenceId: string): boolean;
     /**
      * Asks Nami to fetch the latest active entitlements
      *
-     * @returns list of NamiEntitlement
+     * @returns {Promise<NamiEntitlement[]>} A promise that resolves to a list of NamiEntitlement
      */
     static refresh(): Promise<NamiEntitlement[]>;
+    /**
+     * When there has been an update received to the active entitlements,
+     * the Nami SDK will provide notification of that event through
+     * this callback with list of active [NamiEntitlement]
+     *
+     * @param {NamiActiveEntitlementsHandler} handler - The callback function that will be invoked when the campaign list is updated.
+     * @returns {Callback} A function that can be called to unregister the handler.
+     */
     static registerActiveEntitlementsHandler(handler: NamiActiveEntitlementsHandler): Callback | undefined;
+    /**
+     *  Clear any provisional entitlement grants, which are entitlements issued on-device only.
+     *  Useful for development and purchase testing. Not recommended to be called in production.
+     */
+    static clearProvisionalEntitlementGrants(): void;
     /**
      * Private Instance Methods
      */

package/dist/nami/index.d.ts

@@ -1,8 +1,14 @@
-import { NamiConfiguration, NamiConfigurationState } from "src/types/config";
+import { NamiConfiguration, NamiConfigurationState } from "../types/config";
 export declare class Nami {
     #private;
     static instance: Nami;
     get isInitialized(): boolean;
+    /**
+     * Configures and initializes the SDK.
+     * This method must be called as the first thing before interacting with the SDK.
+     * @param with A [NamiConfiguration] object with required values
+     * @returns {Promise<NamiConfigurationState>}
+     */
     static configure(options: NamiConfiguration): Promise<NamiConfigurationState>;
     private static setInitialConfig;
     private initializeSDK;

package/dist/nami/namiRefs.d.ts

@@ -1,4 +1,4 @@
-import { NamiConfiguration } from "src/types/config";
+import { NamiConfiguration } from "../types/config";
 export declare class NamiRefs {
     static instance: NamiRefs;
     init(config: NamiConfiguration): Promise<void>;

package/dist/nami/paywalls.d.ts

@@ -1,34 +1,65 @@
-import { IPaywall } from "src/types/paywall";
-import { NamiProductDetails } from "src/types/externals/product";
-import { Callback } from "src/types/components/containers";
-import { NamiPurchaseDetails } from "src/types/externals/purchase";
+import { IPaywall } from "../types/paywall";
+import { NamiProductDetails } from "../types/externals/product";
+import { Callback, CloseHandler, DeepLinkUrlHandler, SKUActionHandler } from "../types/components/containers";
+import { NamiPurchaseDetails } from "../types/externals/purchase";
+/**
+ * @class NamiPaywallManager
+ * Provides methods for managing all aspects of a paywall in the Nami SDK.
+ */
 export declare class NamiPaywallManager {
     static instance: NamiPaywallManager;
     private emitter;
     productDetails: NamiProductDetails[];
+    /**
+     * @returns {IPaywall[]} a list of Paywall
+     */
     static allPaywalls(): IPaywall[];
+    /**
+     * Used to set product details when store products are unavailable. For advanced use cases only.
+     */
     static setProductDetails(productDetails: NamiProductDetails[]): void;
+    /**
+     * Register a callback which would be invoked when user will sign-in
+     */
     static registerSignInHandler(handler: Callback): Callback;
-    static registerCloseHandler(handler: Callback): Callback;
-    static registerDeeplinkActionHandler(handler: Callback): Callback;
-    static registerBuySkuHandler(handler: Callback): Callback;
+    /**
+     * Register a callback which would be invoked when user close a paywall raised by Nami system
+     */
+    static registerCloseHandler(handler: CloseHandler): Callback;
+    /**
+     * Register a callback which would be invoked when user will take action on deeplink
+     */
+    static registerDeeplinkActionHandler(handler: DeepLinkUrlHandler): Callback;
+    /**
+     * Register a [NamiBuySkuHandler] which would be invoked when a user triggers
+     * a buy sku action on a paywall.
+     *
+     * Only available for plans where Nami is not handling subscription & IAP management.
+     */
+    static registerBuySkuHandler(handler: SKUActionHandler): Callback;
+    /**
+     * Register a callback which would be invoked when user restore a product
+     */
     static registerRestoreHandler(handler: Callback): Callback;
     /**
-      * Notify the NamiPaywallManager that a purchase initiated from the
-      * [NamiBuySkuHandler] is complete. Only available for plans where Nami is
-      * not handling subscription & IAP management.
-      */
+     * Notify the NamiPaywallManager that a purchase initiated from the
+     * [NamiBuySkuHandler] is complete.
+     *
+     * Only available for plans where Nami is not handling subscription & IAP management.
+     *
+     * @returns {Promise<void>} A Promise that resolves when buying SKU will be complete.
+     */
     static buySkuComplete(purchase: NamiPurchaseDetails): Promise<void>;
     /**
-       Notify the NamiPaywallManager that purchase flow handled by you is cancelled.
-       Used to disable product purchase-in-progress loading indicators
-    */
+     * Notify the NamiPaywallManager that purchase flow handled by you is cancelled.
+     * Used to disable product purchase-in-progress loading indicators
+     */
     static buySkuCancel(): void;
     /**
-      * Set the video details for the app supplied video
-      * @param url The URL of the video
-      * @param name The name of the video
-      */
+     * Set the video details for the app supplied video
+     * @param url The URL of the video
+     * @param name The name of the video
+     */
     static setAppSuppliedVideoDetails(url: string, name?: string): void;
     /**
      * Private Instance Methods

package/dist/nami/purchase.d.ts

@@ -1,4 +1,8 @@
-import { NamiPurchase } from "src/types/externals/purchase";
+import { NamiPurchase } from "../types/externals/purchase";
+/**
+ * @class NamiPurchaseManager
+ * Provides methods for managing all aspects of a purchase in the Nami SDK.
+ */
 export declare class NamiPurchaseManager {
     static instance: NamiPurchaseManager;
     static allPurchases(): NamiPurchase[];

package/dist/nami/utils/campaign.d.ts

@@ -1,5 +1,5 @@
-import { NamiCampaign } from "src/types/externals/campaign";
-import { IPaywall } from "src/types/paywall";
+import { NamiCampaign } from "../../types/externals/campaign";
+import { IPaywall } from "../../types/paywall";
 export declare const isValidUrl: (label: string) => boolean;
 export declare const allCampaigns: () => NamiCampaign[];
 export declare const getPaywallDataFromLabel: (value: string, type?: string) => {

package/dist/nami/utils/entitlement.d.ts

@@ -1,7 +1,7 @@
-import { IEntitlements, NamiEntitlement } from "src/types/entitlements";
-import { NamiPurchase } from "src/types/externals/purchase";
-import { PaywallSKU, SKU } from "src/types/sku";
-import { NamiSKU } from "src/types/externals/sku";
+import { IEntitlements, NamiEntitlement } from "../../types/entitlements";
+import { NamiPurchase } from "../../types/externals/purchase";
+import { PaywallSKU, SKU } from "../../types/sku";
+import { NamiSKU } from "../../types/externals/sku";
 export declare class EntitlementUtils {
     static instance: EntitlementUtils;
     refIdToPurchasedSKUs: {

package/dist/nami/utils/paywall.d.ts

@@ -1,2 +1,2 @@
-import { IPaywall } from "src/types/paywall";
+import { IPaywall } from "../../types/paywall";
 export declare const allPaywalls: () => IPaywall[];

package/dist/nami/utils/purchase.d.ts

@@ -1,4 +1,4 @@
-import { NamiPurchaseCompleteResult } from "src/types/purchase";
-import { NamiPurchaseDetails, NamiPurchase } from "src/types/externals/purchase";
+import { NamiPurchaseCompleteResult } from "../../types/purchase";
+import { NamiPurchaseDetails, NamiPurchase } from "../../types/externals/purchase";
 export declare function toNamiPurchase(purchase: NamiPurchaseDetails): NamiPurchase;
 export declare function namiBuySKU(skuRefId: string): NamiPurchaseCompleteResult | undefined;