@namiml/web-sdk 1.1.0 → 1.2.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 1.2.0 (July 26, 2024)
+
+### New Features
+- **NamiCampaignManager.launch** - Implemented `paywallLaunchContext` in `NamiCampaignManager.launch` in order to provide the paywall additional details.
+- **NamiPaywallManager.buySKUCancel** - Implemented `NamiPaywallManager.buySKUCancel` to let Nami know the user has canceled their paywall purchase.
+- **NamiPayallManager.buySKUComplete** - Implemented `NamiPaywallManager.buySKUComplete` to let Nami know the user has completed their paywall purchase.
+- **Impression / Conversion Reporting** - Implemented impression / conversion reporting for paywall analytics.
+- **Improved paywall load time** - Paywalls render signficantly faster when immediately displayed.
+
+### Bug Fixes
+- Provide consistent typing with other Nami SDKs.
+- Provide consistent APIs with other Nami SDKs.
+
 ## 1.1.0 (June 24, 2024)
 
 ### New Features

package/dist/components/ContextConsumer.d.ts

@@ -0,0 +1,11 @@
+import { ReactiveController, ReactiveControllerHost } from 'lit';
+import { TPaywallContext } from 'src/types/paywall';
+declare class ContextConsumer implements ReactiveController {
+    host: ReactiveControllerHost;
+    state: TPaywallContext;
+    constructor(host: ReactiveControllerHost);
+    handleStateChange(): void;
+    hostConnected(): void;
+    hostDisconnected(): void;
+}
+export default ContextConsumer;

package/dist/components/ContextProvider.d.ts

@@ -0,0 +1,45 @@
+import { ReactiveController, ReactiveControllerHost } from 'lit';
+import { IPaywall, TPaywallContext, TPaywallLaunchContext, TPaywallMedia } from 'src/types/paywall';
+import { NamiProductDetails } from 'src/types/products';
+import { NamiSKU } from 'src/types/sku';
+export declare const initialState: TPaywallContext;
+type Callback = () => void;
+declare class ContextProvider implements ReactiveController {
+    host: ReactiveControllerHost | null;
+    state: TPaywallContext;
+    subscribers: Set<Callback>;
+    productDetails: NamiProductDetails[];
+    constructor();
+    subscribe(callback: Callback): Callback;
+    unsubscribe(callback: Callback): void;
+    hostConnected(): void;
+    hostDisconnected(): void;
+    private setState;
+    setProductDetails(details: NamiProductDetails[]): void;
+    getProductDetails(): NamiProductDetails[];
+    setCurrentGroupId(currentGroupId: string): void;
+    currentGroupId(): string;
+    setSelectedProdcuts(products: {
+        [currentGroupId: string]: string;
+    }): void;
+    selectedProducts(): {
+        [currentGroupId: string]: string;
+    };
+    setPaywall(paywall: IPaywall, context?: TPaywallLaunchContext): void;
+    paywallId(): string;
+    setCurrentPage(page: string): void;
+    setCustomerAttribute(attributes: {
+        [key: string]: string;
+    }): void;
+    removeCustomerAttribute(key: string): void;
+    setIsLoggedIn(isLoggedIn: boolean): void;
+    setMediaList(media: TPaywallMedia[]): void;
+    setSafeAreaTop(safeAreaTop: number): void;
+    setFullScreenPresentation(fullScreenPresentation: boolean): void;
+    setFormFactor(formFactor: string): void;
+    setPurchaseInProgress(inProgress: boolean): void;
+    setPurchase(inProgress: boolean, product?: NamiSKU): void;
+    setTimeSpentOnPaywall(time: number): void;
+}
+declare const contextProvider: ContextProvider;
+export default contextProvider;

package/dist/components/NamiElement.d.ts

@@ -0,0 +1,10 @@
+import { CSSResult, LitElement, PropertyValueMap } from "lit";
+import ContextConsumer from "./ContextConsumer";
+export declare class NamiElement extends LitElement {
+    contextConsumer: ContextConsumer;
+    constructor();
+    protected styles(): CSSResult;
+    createRenderRoot(): HTMLElement | DocumentFragment;
+    protected willUpdate(_changedProperties: PropertyValueMap<any> | Map<PropertyKey, unknown>): void;
+    disconnectedCallback(): void;
+}

package/dist/components/Paywall.d.ts

@@ -0,0 +1,17 @@
+import { IPaywall, NamiPaywallEvent, TPaywallLaunchContext } from 'src/types/paywall';
+import { TDevice } from 'src/types/device';
+import { NamiElement } from './NamiElement';
+import { TemplateResult } from 'lit';
+import { CampaignRule } from 'src/types/campaign';
+declare class PaywallComponent extends NamiElement {
+    private formFactor;
+    private campaign;
+    private paywall;
+    private paywallEvent;
+    constructor(paywall: IPaywall, formFactor: TDevice, event: Partial<NamiPaywallEvent>, campaign?: CampaignRule, context?: TPaywallLaunchContext);
+    firstUpdated(): void;
+    private getTemplate;
+    styles(): import("lit").CSSResult;
+    render(): TemplateResult;
+}
+export { PaywallComponent };

package/dist/components/TemplateComponent.d.ts

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

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

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

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

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

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

@@ -0,0 +1,10 @@
+import { CSSResult } from "lit";
+import { NamiElement } from "../NamiElement";
+import { TContainer } from "src/types/components";
+export declare class NamiContentContainer extends NamiElement {
+    component: TContainer;
+    zIndex: number;
+    inFocusedState: boolean;
+    protected styles(): CSSResult;
+    render(): any[];
+}

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

@@ -0,0 +1,10 @@
+import { CSSResult } from 'lit';
+import { NamiElement } from '../NamiElement';
+import { THeaderFooter } from 'src/types/components/containers';
+export declare class NamiFooter extends NamiElement {
+    components: THeaderFooter;
+    zIndex: string;
+    inFocusedState: boolean;
+    protected styles(): CSSResult;
+    render(): any[];
+}

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

@@ -0,0 +1,11 @@
+import { CSSResult } from 'lit';
+import { NamiElement } from '../NamiElement';
+import { THeaderFooter } from 'src/types/components/containers';
+export declare class NamiHeader extends NamiElement {
+    components: THeaderFooter;
+    zIndex: string;
+    inFullScreen: boolean;
+    inFocusedState: boolean;
+    protected styles(): CSSResult;
+    render(): any[];
+}

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

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

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

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

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

@@ -0,0 +1,9 @@
+import { TImageComponent } from "src/types/components/elements";
+import { NamiElement } from "../NamiElement";
+import { CSSResult, TemplateResult } from "lit";
+export declare class NamiImage extends NamiElement {
+    component: TImageComponent;
+    inFocusedState: boolean;
+    protected styles(): CSSResult;
+    protected render(): TemplateResult;
+}

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

@@ -0,0 +1,11 @@
+import { CSSResult } from 'lit';
+import { TSegmentPicker } from 'src/types/components/elements';
+import { NamiElement } from '../NamiElement';
+export declare class NamiSegmentPicker extends NamiElement {
+    component: TSegmentPicker;
+    inFocusedState: boolean;
+    constructor();
+    private _handleClick;
+    protected styles(): CSSResult;
+    render(): any[];
+}

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

@@ -0,0 +1,15 @@
+import { CSSResult } from 'lit';
+import { TSegmentPickerItem } from 'src/types/components/elements';
+import { NamiElement } from '../NamiElement';
+export declare class NamiSegmentPickerItem extends NamiElement {
+    component: TSegmentPickerItem;
+    inFocusedState: boolean;
+    constructor();
+    private _handleClick;
+    private _handleHover;
+    private getComponentStyles;
+    private formatKey;
+    private applyStyles;
+    protected styles(): CSSResult;
+    render(): import("lit-html").TemplateResult<1>;
+}

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

@@ -0,0 +1,9 @@
+import { CSSResult, TemplateResult } from 'lit';
+import { NamiElement } from '../NamiElement';
+import { TSpacerComponent } from 'src/types/components/elements';
+export declare class NamiSpacer extends NamiElement {
+    component: TSpacerComponent;
+    inFocusedState: boolean;
+    protected styles(): CSSResult;
+    render(): TemplateResult;
+}

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

@@ -0,0 +1,27 @@
+import { TemplateResult, CSSResult } from 'lit';
+import { TSymbolComponent, TTextComponent, TTextListComponent } from 'src/types/components/elements';
+import { NamiElement } from '../NamiElement';
+export declare class NamiText extends NamiElement {
+    component: TTextComponent;
+    inFocusedState: boolean;
+    protected styles(): CSSResult;
+    render(): TemplateResult;
+}
+export declare class TextListItemWrapper extends NamiElement {
+    component: TTextListComponent;
+    inFocusedState: boolean;
+    protected styles(): CSSResult;
+    render(): TemplateResult;
+}
+export declare class NamiSymbol extends NamiElement {
+    component: TSymbolComponent;
+    inFocusedState: boolean;
+    protected styles(): CSSResult;
+    render(): TemplateResult;
+}
+export declare class NamiTextList extends NamiElement {
+    component: TTextListComponent;
+    inFocusedState: boolean;
+    protected styles(): CSSResult;
+    render(): TemplateResult;
+}

package/dist/components/index.d.ts

@@ -0,0 +1,30 @@
+import { NamiSpacer } from "./elements/Spacer";
+import { NamiButton } from "./elements/Button";
+import { NamiHeader } from "./containers/Header";
+import { NamiFooter } from "./containers/Footer";
+import { NamiSymbol, NamiText } from "./elements/Text";
+import { NamiContainer } from "./containers/Container";
+import { NamiProductContainer } from "./containers/ProductContainer";
+import { NamiImage } from "./elements/Image";
+import { NamiBackgroundContainer } from "./containers/BackgroundContainer";
+import { NamiContentContainer } from "./containers/Content";
+import { NamiSegmentPicker } from "./elements/SegmentPicker";
+import { NamiSegmentPickerItem } from "./elements/SegmentPickerItem";
+declare global {
+    interface HTMLElementTagNameMap {
+        "nami-spacer": NamiSpacer;
+        "nami-button": NamiButton;
+        "nami-text": NamiText;
+        "nami-segment-picker": NamiSegmentPicker;
+        "nami-segment-picker-item": NamiSegmentPickerItem;
+        "nami-header": NamiHeader;
+        "nami-footer": NamiFooter;
+        "nami-container": NamiContainer;
+        "nami-product-container": NamiProductContainer;
+        "nami-image": NamiImage;
+        "nami-background-container": NamiBackgroundContainer;
+        "nami-content-container": NamiContentContainer;
+        "nami-symbol": NamiSymbol;
+    }
+}
+export { NamiSpacer, NamiButton, NamiHeader, NamiFooter, NamiText, NamiSegmentPicker, NamiSegmentPickerItem, NamiContainer, NamiProductContainer, NamiImage, NamiBackgroundContainer, NamiContentContainer, NamiSymbol };

package/dist/components/productDetails.d.ts

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

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

@@ -0,0 +1,2 @@
+import { CSSResult } from "lit";
+export declare const cssReset: CSSResult;

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

@@ -0,0 +1,13 @@
+import { UserAction } from "src/types/components/containers";
+import { NamiSKU } from "src/types/sku";
+export declare const handleAction: (onTap?: UserAction, sku?: NamiSKU) => void;
+export declare const closePaywallHandler: () => void;
+export declare const restorePurchase: () => void;
+export declare const signIn: () => void;
+export declare const deepLink: (url?: string) => void;
+export declare const buySKU: (onTap: UserAction, sku: NamiSKU) => NamiSKU;
+export declare const navigateToScreen: (screen?: string) => void;
+export declare const setState: () => void;
+export declare const selectSKU: (sku: NamiSKU) => void;
+export declare const purchaseSelectedSKU: (sku: NamiSKU) => void;
+export declare const reloadProducts: () => void;

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

@@ -0,0 +1,5 @@
+export declare const 
+/**
+  * Constant value of action taps
+  */
+NAMI_CLOSE_PAYWALL: string, NAMI_RESTORE_PURCHASES: string, NAMI_SIGN_IN: string, NAMI_BUY_SKU: string, SET_STATE: string, NAMI_SELECT_SKU: string, NAMI_PURCHASE_SELECTED_SKU: string, NAMI_DEEP_LINK: string, NAMI_NAVIGATE_TO_SCREEN: string, NAMI_RELOAD_PRODUCTS: string, UNSUPPORTED: string, NAMI_PURCHASE_SUCCESS: string, NAMI_PURCHASE_CANCELLED: string, NAMI_PURCHASE_FAILED: string, NAMI_PURCHASE_PENDING: string, NAMI_PURCHASE_UNKNOWN: string, NAMI_SHOW_PAYWALL: string, NAMI_PAGE_CHANGE: string, NAMI_TOGGLE_CHANGE: string, NAMI_SLIDE_CHANGE: string;

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

@@ -0,0 +1,17 @@
+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";
+type ReplacementsType = {
+    [type: string]: any extends Array<any> ? never : any;
+};
+export declare function interpolate<T>(value: T, replacements: ReplacementsType): T;
+export declare function getInterpolatedButtonComponents(component: TButtonContainer): TComponent[];
+export declare function getSkuButtonComponents(items: PaywallSKU[], component: TProductContainer, mediaList?: {
+    [mediaName: string]: Pick<TPaywallMedia, 'content'>;
+}, additionalVariableStates?: object): [boolean, 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;
+export {};

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

@@ -0,0 +1 @@
+export declare function iconByName(name: string): any;

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

@@ -0,0 +1,4 @@
+import { Impression } from "src/types/api";
+import { TransactionRequest } from "src/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

@@ -0,0 +1,18 @@
+import { NamiProductDetails, NamiProductOffer, NamiSubscriptionPeriod, PricingPhase } from "src/types/products";
+import { PaywallSKU } from "src/types/sku";
+export declare function getStandardBillingPeriod(product: NamiProductDetails): string | undefined;
+export declare function getFreeTrialPeriod(product: NamiProductDetails): string | undefined;
+export declare function getFreeTrialOffer(product: NamiProductDetails): NamiProductOffer | undefined;
+export declare function extractStandardPricingPhases(product: NamiProductDetails): PricingPhase[];
+export declare function convertOfferToPricingPhase(offer: NamiProductOffer | null, subPeriod?: NamiSubscriptionPeriod): PricingPhase;
+export declare function convertISO8601PeriodToText(iso8601Period?: string, singular?: boolean, justPeriod?: boolean, justNumber?: boolean): string | null;
+export declare function getCurrencyFormat(priceCurrencyCode: string): Intl.NumberFormat;
+export declare const getPriceDifference: (currentSkuPricePerMonth?: number, referencedSkuPricePerMonth?: number, currencyFormat?: Intl.NumberFormat) => string | null;
+export declare const getPercentagePriceDifference: (currentSkuPrice?: number, currentSkuDurationInMonths?: number, referencedSkuPrice?: number, referencedSkuPeriodInMonths?: number) => string | null;
+export declare const getReferenceSku: (skus: PaywallSKU[], referenceId: string) => PaywallSKU | undefined;
+export declare const getPricePerMonth: (phase: PricingPhase) => number;
+export declare const getPeriodNumberInDays: (billingPeriod: string) => number;
+export declare const getPeriodNumberInWeeks: (billingPeriod: string) => number;
+export declare const getBillingPeriodNumber: (billingPeriod: string) => number;
+export declare const formattedPrice: (price: number) => number;
+export declare function toDouble(num: number): number;

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

@@ -0,0 +1,13 @@
+import { ISkuMenu, TInitialState } from "src/types/paywall";
+import { NamiProductDetails } from "src/types/products";
+import { PaywallSKU } from "src/types/sku";
+export declare function currentSku(productDetails: NamiProductDetails[], initialState: TInitialState, skuMenus: ISkuMenu[], skus: PaywallSKU[]): {
+    [key: string]: any;
+};
+export declare function skuItems(productDetails: NamiProductDetails[], skuMenus: ISkuMenu[], currentGroupId: string): PaywallSKU[];
+export declare function getSkuSmartTextValue(productDetail?: NamiProductDetails | null, sku?: PaywallSKU, skus?: PaywallSKU[]): {
+    [key: string]: any;
+};
+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;

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

@@ -0,0 +1,21 @@
+import { TBaseComponent, TContainerPosition } from "src/types/components";
+import { TTextLikeComponent } from "src/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;
+export declare function flexDirection({ direction }: TBaseComponent): string;
+export declare function applyTextOverflow(component: TTextLikeComponent): string;
+export declare function transition(): string;
+export declare function grow({ grow }: TBaseComponent): string;
+export declare function paddingAndMargin(component: TBaseComponent): string;
+export declare function transform({ moveX, moveY, }: TBaseComponent): string;
+export declare function borders(component: TBaseComponent, inFocusedState?: boolean): string;
+export declare function alignItems({ alignment, }: TBaseComponent): string;
+export declare function justifyContent({ alignment, }: TBaseComponent): string;
+export declare function widthAndHeight(component: TBaseComponent): string;
+export declare function zIndex({ zIndex }: TBaseComponent): string;
+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 parsePosition(position?: TContainerPosition): string;

package/dist/core/errors.d.ts

@@ -0,0 +1,46 @@
+export declare class RetryLimitExceededError extends Error {
+    statusCode: number;
+    status: number;
+    constructor(statusCode: number, message: string);
+}
+export declare class SDKNotInitializedError extends Error {
+    constructor();
+}
+export declare class PlatformIDRequiredError extends Error {
+    constructor();
+}
+export declare class DeviceIDRequiredError extends Error {
+    constructor();
+}
+export declare class ExternalIDRequiredError extends Error {
+    constructor();
+}
+export declare class CampaignNotAvailableError extends Error {
+    constructor();
+}
+export declare class AnonymousModeAlreadyOnError extends Error {
+    constructor();
+}
+export declare class AnonymousModeAlreadyOffError extends Error {
+    constructor();
+}
+export declare class AnonymousLoginError extends Error {
+    constructor();
+}
+export declare class AnonymousCDPError extends Error {
+    constructor();
+}
+export declare class BadRequestError extends Error {
+    constructor(message: string);
+}
+export declare class NotFoundError extends Error {
+    constructor(message: string);
+}
+export declare class ClientError extends Error {
+    statusCode: number;
+    constructor(statusCode: number, message: string);
+}
+export declare class InternalServerError extends Error {
+    constructor(message: string);
+}
+export declare const handleErrors: (status: number, path: string) => void;

package/dist/core/withRetry.d.ts

@@ -0,0 +1 @@
+export declare function withRetry<T>(url: string, options?: RequestInit, retries?: number): Promise<T>;

package/dist/decorators/index.d.ts

@@ -0,0 +1,2 @@
+export declare function requirePlatformID(target: any, propertyKey: string, descriptor: PropertyDescriptor): PropertyDescriptor;
+export declare function requireDeviceID(target: any, propertyKey: string, descriptor: PropertyDescriptor): PropertyDescriptor;

package/dist/nami/api.d.ts

@@ -0,0 +1,20 @@
+import { NamiConfiguration } from "src/types/config";
+import { Impression, LoginResponse } from "src/types/api";
+import { PurchaseValidationRequest, TransactionRequest } from "src/types/purchase";
+export declare class NamiAPI {
+    static instance: NamiAPI;
+    private baseURL;
+    private platformID;
+    private get deviceID();
+    static configure(config: NamiConfiguration): void;
+    protected configure(config: NamiConfiguration): void;
+    login(externalId: string): Promise<LoginResponse>;
+    logout(): Promise<Record<string, never>>;
+    startSession(sessionStartTime: Date): Promise<void>;
+    postImpression(options: Impression): Promise<void>;
+    postConversion(options: TransactionRequest): Promise<void>;
+    purchaseValidation(options: PurchaseValidationRequest): Promise<void>;
+    fetchAPI<T>(path: string): Promise<T>;
+    requestBodyAPI<T, U>(path: string, bodyData: T, method?: string, keepalive?: boolean, timeout?: number): Promise<U>;
+    timeoutRequest<T>(url: string, options: RequestInit, timeout: number): Promise<T>;
+}

package/dist/nami/campaign.d.ts

@@ -0,0 +1,47 @@
+import { AvailableCampaignsResponseHandler, CampaignRule } from "src/types/campaign";
+import { NamiPaywallActionHandler, TPaywallLaunchContext, PaywallResultHandler } from "src/types/paywall";
+import { PaywallComponent } from "src/components/Paywall";
+import { Callback } from "src/types/components/containers";
+export declare class NamiCampaignManager {
+    static instance: NamiCampaignManager;
+    private emitter;
+    static allCampaigns(): CampaignRule[];
+    /**
+     * Checks if a campaign is available for a given label.
+     *
+     * @param label - The label of the campaign to check.
+     * @returns True if the campaign is available, false otherwise.
+     */
+    static isCampaignAvailable(label: string): boolean;
+    /**
+     * Checks if a campaign is available for a given URL.
+     *
+     * @param url - The deeplink URL of the campaign to check.
+     * @returns True if the campaign is available, false otherwise.
+     */
+    static isCampaignAvailable(url: URL): boolean;
+    /**
+     * Checks if a campaign is available for a given type and value.
+     *
+     * @param params - An object containing the type and value of the campaign to check.
+     * @returns True if the campaign is available, false otherwise.
+     */
+    static isCampaignAvailable(params: {
+        type?: string;
+        value: string;
+    }): boolean;
+    static refresh(): Promise<CampaignRule[]>;
+    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.
+     */
+    static launch(label?: string, withUrl?: string, context?: TPaywallLaunchContext, resultCallback?: PaywallResultHandler, actionCallback?: NamiPaywallActionHandler): PaywallComponent | void;
+    /**
+     * Private Instance Methods
+     */
+    private get sdkInitialized();
+}

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