@namiml/web-sdk 1.0.0 → 1.2.0

package/dist/nami/customer.d.ts

@@ -0,0 +1,91 @@
+import { Callback } from "src/types/components/containers";
+import { AccountStateAction } from "src/types/profile";
+type AccountStateHandler = (action: AccountStateAction, success: boolean, error?: Error) => void;
+/**
+ * NamiCustomerManager provides methods for managing customer-related functionality.
+ */
+export declare class NamiCustomerManager {
+    static instance: NamiCustomerManager;
+    private emitter;
+    /**
+     * Checks if the customer is logged in.
+     *
+     * @returns {boolean} Returns true if the customer is logged in, false otherwise.
+     */
+    static isLoggedIn(): boolean;
+    /**
+     * Returns the external ID of the currently logged in user.
+     *
+     * @returns 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.
+    */
+    static login(externalId: string): Promise<void>;
+    static logout(): Promise<void>;
+    static setCustomerDataPlatformId(id: string): Promise<void>;
+    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.
+     */
+    static registerAccountStateHandler(callback: 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.
+     */
+    static setAnonymousMode(enabled: boolean): Promise<void>;
+    /**
+     * Returns whether or not the SDK is currently operating in anonymous mode
+     */
+    static inAnonymousMode(): boolean;
+    /**
+     * Sets an optional customer attributes that can be used to personalize your Nami paywalls.
+     *
+     * @param key - The name of the attribute. For example: `firstName`.
+     * @param value - The value of the customer attribute. For example: `Joe`.
+     */
+    static setCustomerAttribute(key: string, value: string): void;
+    /**
+     * 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.
+     */
+    static getCustomerAttribute(key: string): string | null;
+    /**
+     * Clears a value of the given key in the on-device key/value store.
+     *
+     * @param key - The key of the customer attribute to clear.
+     */
+    static clearCustomerAttribute(key: string): void;
+    /**
+     * Clear all customer attributes from the on-device key/value store.
+     *
+     */
+    static clearAllCustomerAttributes(): void;
+    /**
+     * Private Static Methods
+     */
+    private static invokeStateHandler;
+    /**
+     * Private Instance Methods
+     */
+    private get isSDKInitialized();
+    private static updateCustomerDataPlatformId;
+    /**
+   * Returns whether or not the configured app platform id belongs to an anonymous mode
+   * capable Nami account.
+   */
+    private static anonymousModeCapability;
+    private static refetchConfig;
+}
+export {};

package/dist/nami/emitter.d.ts

@@ -0,0 +1,12 @@
+export declare class NamiEventEmitter {
+    private static instance;
+    private emitter;
+    static getInstance(): NamiEventEmitter;
+    on(eventName: string, listener: (...args: any[]) => void): void;
+    off(eventName: string, listener: (...args: any[]) => void): void;
+    emit(eventName: string, ...args: any[]): void;
+    addListener(eventName: string, listener: (...args: any[]) => void): void;
+    removeListener(eventName: string, listener: (...args: any[]) => void): void;
+    listeners(eventName: string): any[];
+    listenerCount(eventName: string): number;
+}

package/dist/nami/index.d.ts

@@ -0,0 +1,9 @@
+import { NamiConfiguration, NamiConfigurationState } from "src/types/config";
+export declare class Nami {
+    #private;
+    static instance: Nami;
+    get isInitialized(): boolean;
+    static configure(options: NamiConfiguration): Promise<NamiConfigurationState>;
+    private static setInitialConfig;
+    private initializeSDK;
+}

package/dist/nami/namiRefs.d.ts

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

package/dist/nami/paywalls.d.ts

@@ -0,0 +1,31 @@
+import { IPaywall } from "src/types/paywall";
+import { NamiProductDetails } from "src/types/products";
+import { Callback } from "src/types/components/containers";
+import { Purchase } from "src/types/purchase";
+export declare class NamiPaywallManager {
+    static instance: NamiPaywallManager;
+    private emitter;
+    productDetails: NamiProductDetails[];
+    static allPaywalls(): IPaywall[];
+    static setProductDetails(productDetails: NamiProductDetails[]): void;
+    static registerSignInHandler(handler: Callback): Callback;
+    static registerCloseHandler(handler: Callback): Callback;
+    static registerDeeplinkActionHandler(handler: Callback): Callback;
+    static registerBuySkuHandler(handler: Callback): Callback;
+    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.
+      */
+    static buySkuComplete(purchase: Purchase): Promise<void>;
+    /**
+       Notify the NamiPaywallManager that purchase flow handled by you is cancelled.
+       Used to disable product purchase-in-progress loading indicators
+    */
+    static buySkuCancel(): void;
+    /**
+     * Private Instance Methods
+     */
+    private get sdkInitialized();
+}

package/dist/nami/profile.d.ts

@@ -0,0 +1,12 @@
+export declare class NamiProfileManager {
+    static instance: NamiProfileManager;
+    private externalId?;
+    constructor();
+    setExternalId(externalId: string | undefined): NamiProfileManager;
+    getExternalId(): string | undefined;
+    isLoggedIn(): boolean;
+    private save;
+    private load;
+    login(externalId: string): Promise<void>;
+    logout(): Promise<void>;
+}

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

@@ -0,0 +1,3 @@
+import { NamiPurchase, Purchase, TransactionRequest } from "src/types/purchase";
+export declare function toNamiPurchase(purchase: Purchase): NamiPurchase;
+export declare function getTransactionInfo(purchase?: NamiPurchase): TransactionRequest | undefined;