@namiml/web-sdk 1.3.2 → 1.4.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## 1.4.0 (September 5, 2024)
+
+## New Features
+- Support for HLS in Video component
+- Support for Responsive Grid component
+- Add `NamiCustomerManager.deviceId`
+- Add `NamiCustomerManager.registerJourneyStateHandler`, `journeyState` (subscription management-only)
+- Add `NamiEntitlementManager.clearProvisionalEntitlementGrants` (subscription management-only)
+
+## Enhancements
+- Allow passing product groups to paywall via campaign launch
+
+## Bug Fixes
+- Find product by id rather than name
+- Fix text component spacing issue
+
+## Improvements
+- Modify type definitions for `NamiPaywallManager.registerSignInHandler`, `NamiPaywallManager.registerCloseHandler`, `NamiPaywallManager.registerBuySkuHandler`, `NamiPaywallManager.registerDeeplinkActionHandler`, `NamiCustomerManager.registerAccountStateHandler`, `NamiCampaignManager.launch` handlers to match Nami React Native SDK
+
 ## 1.3.2 (August 14, 2024)
 
 ### Bug Fixes

package/dist/components/ContextConsumer.d.ts

@@ -1,5 +1,5 @@
 import { ReactiveController, ReactiveControllerHost } from 'lit';
-import { TPaywallContext } from 'src/types/paywall';
+import { TPaywallContext } from '../types/paywall';
 declare class ContextConsumer implements ReactiveController {
     host: ReactiveControllerHost;
     state: TPaywallContext;

package/dist/components/ContextProvider.d.ts

@@ -1,11 +1,11 @@
 import { ReactiveController, ReactiveControllerHost } from 'lit';
-import { IPaywall, NamiAppSuppliedVideoDetails, TPaywallContext, TPaywallLaunchContext, TPaywallMedia } from 'src/types/paywall';
-import { NamiProductDetails } from 'src/types/externals/product';
-import { NamiSKU } from 'src/types/externals/sku';
-import { NamiCampaign } from 'src/types/externals/campaign';
-import { TDevice } from 'src/types/device';
+import { IPaywall, NamiAppSuppliedVideoDetails, TPaywallContext, TPaywallLaunchContext, TPaywallMedia } from '../types/paywall';
+import { NamiProductDetails } from '../types/externals/product';
+import { NamiSKU } from '../types/externals/sku';
+import { NamiCampaign } from '../types/externals/campaign';
+import { TDevice } from '../types/device';
+import { Callback } from '../types/components/containers';
 export declare const initialState: TPaywallContext;
-type Callback = () => void;
 declare class ContextProvider implements ReactiveController {
     host: ReactiveControllerHost | null;
     state: TPaywallContext;
@@ -20,7 +20,7 @@ declare class ContextProvider implements ReactiveController {
     setProductDetails(details: NamiProductDetails[]): void;
     getProductDetails(): NamiProductDetails[];
     setCurrentGroupId(currentGroupId: string): void;
-    currentGroupId(): string;
+    getCurrentGroupId(): string;
     setSelectedProdcuts(products: {
         [currentGroupId: string]: string;
     }): void;

package/dist/components/Paywall.d.ts

@@ -1,9 +1,9 @@
-import { IPaywall, TPaywallLaunchContext } from 'src/types/paywall';
-import { TDevice } from 'src/types/device';
+import { IPaywall, TPaywallLaunchContext } from '../types/paywall';
+import { TDevice } from '../types/device';
 import { NamiElement } from './NamiElement';
 import { TemplateResult } from 'lit';
-import { NamiCampaign } from 'src/types/externals/campaign';
-import { NamiPaywallEvent } from 'src/types/externals/paywall';
+import { NamiCampaign } from '../types/externals/campaign';
+import { NamiPaywallEvent } from '../types/externals/paywall';
 declare class PaywallComponent extends NamiElement {
     formFactor: TDevice;
     campaign: NamiCampaign;

package/dist/components/TemplateComponent.d.ts

@@ -1,2 +1,2 @@
-import { TComponent } from "src/types/components";
+import { TComponent } from "../types/components";
 export declare function TemplateComponent(component: TComponent, inFocusedState?: boolean): any;

package/dist/components/containers/BackgroundContainer.d.ts

@@ -1,4 +1,4 @@
-import { TContainer } from "src/types/components";
+import { TContainer } from "../../types/components";
 import { NamiElement } from "../NamiElement";
 import { CSSResult } from "lit";
 export declare class NamiBackgroundContainer extends NamiElement {
@@ -6,5 +6,6 @@ export declare class NamiBackgroundContainer extends NamiElement {
     fullscreen: boolean;
     inFocusedState: boolean;
     protected styles(): CSSResult;
+    protected updated(): void;
     render(): any[];
 }

package/dist/components/containers/CollapseContainer.d.ts

@@ -1,6 +1,6 @@
 import { CSSResult } from 'lit';
 import { NamiElement } from '../NamiElement';
-import { TCollapseContainer } from 'src/types/components/containers';
+import { TCollapseContainer } from '../../types/components/containers';
 export declare class NamiCollapseContainer extends NamiElement {
     component: TCollapseContainer;
     inFocusedState: boolean;

package/dist/components/containers/Container.d.ts

@@ -1,10 +1,14 @@
 import { CSSResult } from 'lit';
-import { TContainer } from 'src/types/components';
+import { TContainer } from '../../types/components';
 import { NamiElement } from '../NamiElement';
-import { TProductContainer } from 'src/types/components/containers';
+import { TProductContainer } from '../../types/components/containers';
 export declare class NamiContainer extends NamiElement {
     component: TContainer | TProductContainer;
     inFocusedState: boolean;
+    constructor();
+    private _handleFocusChanged;
+    private _handleFocus;
+    private _handleBlur;
     protected styles(): CSSResult;
     render(): any[];
 }

package/dist/components/containers/Content.d.ts

@@ -1,6 +1,6 @@
 import { CSSResult } from "lit";
 import { NamiElement } from "../NamiElement";
-import { TContainer } from "src/types/components";
+import { TContainer } from "../../types/components";
 export declare class NamiContentContainer extends NamiElement {
     component: TContainer;
     zIndex: number;

package/dist/components/containers/Footer.d.ts

@@ -1,6 +1,6 @@
 import { CSSResult } from 'lit';
 import { NamiElement } from '../NamiElement';
-import { THeaderFooter } from 'src/types/components/containers';
+import { THeaderFooter } from '../../types/components/containers';
 export declare class NamiFooter extends NamiElement {
     components: THeaderFooter;
     zIndex: string;

package/dist/components/containers/Header.d.ts

@@ -1,6 +1,6 @@
 import { CSSResult } from 'lit';
 import { NamiElement } from '../NamiElement';
-import { THeaderFooter } from 'src/types/components/containers';
+import { THeaderFooter } from '../../types/components/containers';
 export declare class NamiHeader extends NamiElement {
     components: THeaderFooter;
     zIndex: string;

package/dist/components/containers/ProductContainer.d.ts

@@ -1,6 +1,6 @@
 import { CSSResult } from 'lit';
 import { NamiElement } from '../NamiElement';
-import { TProductContainer } from 'src/types/components/containers';
+import { TProductContainer } from '../../types/components/containers';
 export declare class NamiProductContainer extends NamiElement {
     component: TProductContainer;
     inFocusedState: boolean;

package/dist/components/containers/ResponsiveGrid.d.ts

@@ -0,0 +1,9 @@
+import { CSSResult } from 'lit';
+import { NamiElement } from '../NamiElement';
+import { TResponsiveGrid } from '../../types/components/containers';
+export declare class NamiResponsiveGrid extends NamiElement {
+    component: TResponsiveGrid;
+    inFocusedState: boolean;
+    protected styles(): CSSResult;
+    render(): any[][];
+}

package/dist/components/elements/Button.d.ts

@@ -1,10 +1,13 @@
 import { CSSResult } from 'lit';
-import { TButtonContainer } from 'src/types/components/containers';
+import { TButtonContainer } from '../../types/components/containers';
 import { NamiElement } from '../NamiElement';
 export declare class NamiButton extends NamiElement {
     component: TButtonContainer;
     inFocusedState: boolean;
     constructor();
+    updated(): void;
+    private _handleFocus;
+    private _handleBlur;
     private _handleClick;
     protected styles(): CSSResult;
     render(): any[] | import("lit-html").TemplateResult<1>;

package/dist/components/elements/Image.d.ts

@@ -1,4 +1,4 @@
-import { TImageComponent } from "src/types/components/elements";
+import { TImageComponent } from "../../types/components/elements";
 import { NamiElement } from "../NamiElement";
 import { CSSResult, TemplateResult } from "lit";
 export declare class NamiImage extends NamiElement {

package/dist/components/elements/SegmentPicker.d.ts

@@ -1,5 +1,5 @@
 import { CSSResult } from 'lit';
-import { TSegmentPicker } from 'src/types/components/elements';
+import { TSegmentPicker } from '../../types/components/elements';
 import { NamiElement } from '../NamiElement';
 export declare class NamiSegmentPicker extends NamiElement {
     component: TSegmentPicker;

package/dist/components/elements/SegmentPickerItem.d.ts

@@ -1,5 +1,5 @@
 import { CSSResult } from 'lit';
-import { TSegmentPickerItem } from 'src/types/components/elements';
+import { TSegmentPickerItem } from '../../types/components/elements';
 import { NamiElement } from '../NamiElement';
 export declare class NamiSegmentPickerItem extends NamiElement {
     component: TSegmentPickerItem;

package/dist/components/elements/Spacer.d.ts

@@ -1,6 +1,6 @@
 import { CSSResult, TemplateResult } from 'lit';
 import { NamiElement } from '../NamiElement';
-import { TSpacerComponent } from 'src/types/components/elements';
+import { TSpacerComponent } from '../../types/components/elements';
 export declare class NamiSpacer extends NamiElement {
     component: TSpacerComponent;
     inFocusedState: boolean;

package/dist/components/elements/Text.d.ts

@@ -1,5 +1,5 @@
 import { TemplateResult, CSSResult } from 'lit';
-import { TSymbolComponent, TTextComponent, TTextListComponent } from 'src/types/components/elements';
+import { TSymbolComponent, TTextComponent, TTextListComponent } from '../../types/components/elements';
 import { NamiElement } from '../NamiElement';
 export declare class NamiText extends NamiElement {
     component: TTextComponent;

package/dist/components/elements/Video.d.ts

@@ -1,10 +1,11 @@
-import { TVideoComponent } from "src/types/components/elements";
+import { TVideoComponent } from "../../types/components/elements";
 import { NamiElement } from "../NamiElement";
 import { CSSResult, TemplateResult } from "lit";
 export declare class NamiVideo extends NamiElement {
     component: TVideoComponent;
     inFocusedState: boolean;
     protected styles(): CSSResult;
+    loadMediaSrc(video: HTMLVideoElement): void;
     updated(): void;
     protected render(): TemplateResult;
 }

package/dist/components/index.d.ts

@@ -12,6 +12,7 @@ import { NamiSegmentPicker } from "./elements/SegmentPicker";
 import { NamiSegmentPickerItem } from "./elements/SegmentPickerItem";
 import { NamiVideo } from "./elements/Video";
 import { NamiCollapseContainer } from "./containers/CollapseContainer";
+import { NamiResponsiveGrid } from "./containers/ResponsiveGrid";
 declare global {
     interface HTMLElementTagNameMap {
         "nami-spacer": NamiSpacer;
@@ -29,6 +30,7 @@ declare global {
         "nami-symbol": NamiSymbol;
         "nami-video": NamiVideo;
         "nami-collapse-container": NamiCollapseContainer;
+        "nami-responsive-grid": NamiResponsiveGrid;
     }
 }
-export { NamiSpacer, NamiButton, NamiHeader, NamiFooter, NamiText, NamiSegmentPicker, NamiSegmentPickerItem, NamiContainer, NamiProductContainer, NamiImage, NamiBackgroundContainer, NamiContentContainer, NamiSymbol, NamiVideo, NamiCollapseContainer };
+export { NamiSpacer, NamiButton, NamiHeader, NamiFooter, NamiText, NamiSegmentPicker, NamiSegmentPickerItem, NamiContainer, NamiProductContainer, NamiImage, NamiBackgroundContainer, NamiContentContainer, NamiSymbol, NamiVideo, NamiCollapseContainer, NamiResponsiveGrid };

package/dist/components/productDetails.d.ts

@@ -1,3 +1,3 @@
-import { NamiProductDetails } from "src/types/externals/product";
-import { PaywallSKU } from "src/types/sku";
+import { NamiProductDetails } from "../types/externals/product";
+import { PaywallSKU } from "../types/sku";
 export declare const getProductDetail: (variableName: string, product?: NamiProductDetails | null, referenceId?: string, skus?: PaywallSKU[]) => unknown;

package/dist/components/utils/actionTap.d.ts

@@ -1,5 +1,5 @@
-import { UserAction } from "src/types/components/containers";
-import { NamiSKU } from "src/types/externals/sku";
+import { UserAction } from "../../types/components/containers";
+import { NamiSKU } from "../../types/externals/sku";
 export declare const handleAction: (onTap?: UserAction, sku?: NamiSKU) => void;
 export declare const closePaywallHandler: () => void;
 export declare const restorePurchase: () => void;

package/dist/components/utils/dateTIme.d.ts

@@ -0,0 +1,3 @@
+export declare const formatDate: (text: string, dateFormat: string) => string;
+export declare const isValidISODate: (isoDate: string) => boolean;
+export declare const convertLocale: (locale: string) => string;

package/dist/components/utils/helpers.d.ts

@@ -1,8 +1,8 @@
-import { TBaseComponent, TComponent } from "src/types/components";
-import { TButtonContainer, TProductContainer } from "src/types/components/containers";
-import { TConditionalComponent } from "src/types/components/elements";
-import { TPaywallMedia } from "src/types/paywall";
-import { PaywallSKU } from "src/types/sku";
+import { TBaseComponent, TComponent } from "../../types/components";
+import { TButtonContainer, TProductContainer, TResponsiveGrid } from "../../types/components/containers";
+import { TConditionalComponent } from "../../types/components/elements";
+import { TPaywallMedia } from "../../types/paywall";
+import { PaywallSKU } from "../../types/sku";
 type ReplacementsType = {
     [type: string]: any extends Array<any> ? never : any;
 };
@@ -11,6 +11,7 @@ export declare function getInterpolatedButtonComponents(component: TButtonContai
 export declare function getSkuButtonComponents(items: PaywallSKU[], component: TProductContainer, mediaList?: {
     [mediaName: string]: Pick<TPaywallMedia, 'content'>;
 }, additionalVariableStates?: object): [boolean, TComponent[]][];
+export declare function getRepeatingListComponents(component: TResponsiveGrid): TComponent[][];
 export declare function conditionComponentMatches(condition: TConditionalComponent): boolean;
 export declare function withOverrides<T extends TBaseComponent>({ conditionAttributes, ...component }: T): T;
 export declare function valueFromSmartText<T>(value: T, sku?: PaywallSKU): T;

package/dist/components/utils/impression.d.ts

@@ -1,4 +1,4 @@
-import { Impression } from "src/types/api";
-import { TransactionRequest } from "src/types/purchase";
+import { Impression } from "../../types/api";
+import { TransactionRequest } from "../../types/purchase";
 export declare const postImpression: (options: Impression) => Promise<void>;
 export declare const postConversion: (transactionInfo: TransactionRequest) => Promise<void>;

package/dist/components/utils/products.d.ts

@@ -1,6 +1,7 @@
-import { NamiProductDetails, NamiProductOffer, NamiSubscriptionPeriod } from "src/types/externals/product";
-import { PricingPhase } from "src/types/products";
-import { PaywallSKU } from "src/types/sku";
+import { NamiProductDetails, NamiProductOffer, NamiSubscriptionPeriod } from "../../types/externals/product";
+import { PricingPhase } from "../../types/products";
+import { PaywallSKU } from "../../types/sku";
+export declare const isSubscription: (productType?: string) => productType is "subscription";
 export declare function getStandardBillingPeriod(product: NamiProductDetails): string | undefined;
 export declare function getFreeTrialPeriod(product: NamiProductDetails): string | undefined;
 export declare function getFreeTrialOffer(product: NamiProductDetails): NamiProductOffer | undefined;

package/dist/components/utils/state.d.ts

@@ -1,7 +1,7 @@
-import { InitiateStateGroup, ISkuMenu, TInitialState } from "src/types/paywall";
-import { NamiProductDetails } from "src/types/externals/product";
-import { PaywallSKU } from "src/types/sku";
-import { NamiPaywallLaunchContext } from "src/nami-web";
+import { InitiateStateGroup, ISkuMenu, TInitialState } from "../../types/paywall";
+import { NamiProductDetails } from "../../types/externals/product";
+import { PaywallSKU } from "../../types/sku";
+import { NamiPaywallLaunchContext } from "../../nami-web";
 export declare function currentSku(productDetails: NamiProductDetails[], initialState: TInitialState, skuMenus: ISkuMenu[], skus: PaywallSKU[]): {
     [key: string]: any;
 };
@@ -11,5 +11,5 @@ export declare function getSkuSmartTextValue(productDetail?: NamiProductDetails
 };
 export declare function checkAnySkuHasTrialOffer(productDetails: NamiProductDetails[], skuMenus: ISkuMenu[], productGroups: string[]): boolean;
 export declare function checkAnySkuHasPromoOffer(productDetails: NamiProductDetails[], skuMenus: ISkuMenu[], productGroups: string[]): boolean;
-export declare function productDetail(details: NamiProductDetails[] | undefined, skuName: string): NamiProductDetails | null;
-export declare function launchContext(groups: InitiateStateGroup[], stateLaunch: NamiPaywallLaunchContext, context?: NamiPaywallLaunchContext): NamiPaywallLaunchContext;
+export declare function productDetail(details: NamiProductDetails[] | undefined, refId: string): NamiProductDetails | null;
+export declare function launchContext(groups: InitiateStateGroup[], context?: NamiPaywallLaunchContext): NamiPaywallLaunchContext;

package/dist/components/utils/styles.d.ts

@@ -1,5 +1,5 @@
-import { TBaseComponent, TContainerPosition } from "src/types/components";
-import { TSegmentPickerItem, TTextLikeComponent } from "src/types/components/elements";
+import { TBaseComponent, TContainerPosition } from "../../types/components";
+import { TSegmentPickerItem, TTextLikeComponent } from "../../types/components/elements";
 export declare function parseSize(value: string | number): string;
 export declare function backgroundColor(value: string): string;
 export declare function pickAndApplyBackgroundColor(component: TBaseComponent, inFocusedState?: boolean): string;
@@ -18,8 +18,9 @@ export declare function dropShadow(component: TBaseComponent): string;
 export declare function textStrikethrough(value: boolean | undefined): string;
 export declare function font({ fontName }: TTextLikeComponent): string;
 export declare function applyStyles(component: TBaseComponent, inFocusedState?: boolean): string;
+export declare function applyGridStyles(component: TBaseComponent, inFocusedState?: boolean): string;
 export declare function parsePosition(position?: TContainerPosition): string;
 export declare function getComponentStyles(prefix: string, component: TSegmentPickerItem): TSegmentPickerItem;
 export declare function formatKey(key: string, prefix: string): string;
 export declare function applySegmentStyles(styles: any, inFocusedState: boolean): string;
-export declare function appySegmentFontStyles(styles: any): string;
+export declare function applySegmentFontStyles(styles: any): string;

package/dist/nami/api.d.ts

@@ -1,11 +1,12 @@
-import { NamiConfiguration } from "src/types/config";
-import { Impression, LoginResponse } from "src/types/api";
-import { PurchaseValidationRequest, TransactionRequest } from "src/types/purchase";
+import { NamiConfiguration } from "../types/config";
+import { Impression, LoginResponse } from "../types/api";
+import { PurchaseValidationRequest, TransactionRequest } from "../types/purchase";
 export declare class NamiAPI {
     static instance: NamiAPI;
     private baseURL;
     private platformID;
     private get deviceID();
+    constructor();
     static configure(config: NamiConfiguration): void;
     protected configure(config: NamiConfiguration): void;
     login(externalId: string): Promise<LoginResponse>;

package/dist/nami/campaign.d.ts

@@ -1,38 +1,64 @@
-import { AvailableCampaignsResponseHandler } from "src/types/campaign";
-import { TPaywallLaunchContext, PaywallResultHandler } from "src/types/paywall";
-import { PaywallComponent } from "src/components/Paywall";
-import { Callback } from "src/types/components/containers";
-import { NamiPaywallActionHandler } from "src/types/externals/paywall";
-import { NamiCampaign } from "src/types/externals/campaign";
+import { AvailableCampaignsResponseHandler } from "../types/campaign";
+import { TPaywallLaunchContext, PaywallResultHandler } from "../types/paywall";
+import { PaywallComponent } from "../components/Paywall";
+import { Callback } from "../types/components/containers";
+import { NamiPaywallActionHandler } from "../types/externals/paywall";
+import { NamiCampaign } from "../types/externals/campaign";
+/**
+ * @class NamiCampaignManager
+ * Provides methods for managing all aspects of a campaign.
+ */
 export declare class NamiCampaignManager {
     static instance: NamiCampaignManager;
     private emitter;
+    /**
+     * @returns {NamiCampaign[]} A list of NamiCampaign
+     */
     static allCampaigns(): NamiCampaign[];
     /**
      * Checks if a campaign is available for a given argument.
      * The argument can be a label string, or a deeplink URL.
      *
      * @param label - The argument to check. Can be a label string, or a deeplink URL.
-     * @returns True if the campaign is available, false otherwise.
+     * @returns {boolean} True if the campaign is available, False otherwise.
      */
     static isCampaignAvailable(label: string): boolean;
     /**
-     * Asks Nami to fetch the latest active campaigns for this device
+     * Fetches the latest active campaigns for the current device.
      *
-     * @returns list of campaigns
+     * @returns {Promise<NamiCampaign[]>} A promise that resolves to a list of active campaigns.
      */
     static refresh(): Promise<NamiCampaign[]>;
+    /**
+     * Registers a handler that will be called whenever there is an update
+     * in the list of active campaigns. The Nami SDK will trigger this callback
+     * with the updated list of active campaigns.
+     *
+     * The handler will receive an array of `NamiCampaign` objects representing
+     * the current active campaigns.
+     *
+     * @param {AvailableCampaignsResponseHandler} 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 registerAvailableCampaignsHandler(handler: AvailableCampaignsResponseHandler): Callback;
     /**
      * Launches a campaign with a given label.
      * @param label - The label of the campaign to launch.
      * @param withUrl - The deeplink URL of the campaign to launch.
      * @param actionCallback - Optional handler for paywall actions.
-     * @returns - The launched paywall web component.
+     * @returns {PaywallComponent | void} The launched paywall web component.
      */
     static launch(label?: string, withUrl?: string, context?: TPaywallLaunchContext, resultCallback?: PaywallResultHandler, actionCallback?: NamiPaywallActionHandler): PaywallComponent | void;
+    /**
+      * Provide the list of product groups supported by the provided placement label or URL.
+      * @param label Campaign placement label defined in Nami Control Center for launching a specific campaign.
+      * @param uri Campaign placement URI defined in Nami Control Center for launching a specific campaign.
+      * @return List of product groups associated with the specified campaign placement.
+      */
+    static getProductGroups(label?: string, withUrl?: string): string[];
     /**
      * Private Instance Methods
      */
     private get sdkInitialized();
+    private campaignTypeAndLabel;
 }

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;
 }