@namiml/web-sdk 0.0.1-alpha.5

package/dist/nami-web.d.ts

@@ -0,0 +1,559 @@
+/// <reference types="node" />
+import { EventEmitter } from "events";
+import { CSSResult, LitElement, ReactiveController, ReactiveControllerHost, TemplateResult } from "lit";
+interface CampaignRule {
+    rule: string;
+    name: string;
+    paywall: string;
+    segment: string;
+    form_factors: FormFactor[];
+    type: string;
+    external_segment_id: string;
+    value: null;
+}
+interface FormFactor {
+    form_factor: string;
+    supports_portrait: boolean;
+    supports_landscape: boolean;
+}
+type AvailableCampaignsResponseHandler = (campaigns: CampaignRule[]) => void;
+type TDevice = "phone" | "tablet" | "television" | "desktop";
+type NamiLanguageCode = "af" | "ar" | "ar-dz" | "ast" | "az" | "bg" | "be" | "bn" | "br" | "bs" | "ca" | "cs" | "cy" | "da" | "de" | "dsb" | "el" | "en" | "en-au" | "en-gb" | "eo" | "es" | "es-ar" | "es-co" | "es-mx" | "es-ni" | "es-ve" | "et" | "eu" | "fa" | "fi" | "fr" | "fy" | "ga" | "gd" | "gl" | "he" | "hi" | "hr" | "hsb" | "hu" | "hy" | "ia" | "id" | "ig" | "io" | "is" | "it" | "ja" | "ka" | "kab" | "kk" | "km" | "kn" | "ko" | "ky" | "lb" | "lt" | "lv" | "mk" | "ml" | "mn" | "mr" | "my" | "nb" | "ne" | "nl" | "nn" | "os" | "pa" | "pl" | "pt" | "pt-br" | "ro" | "ru" | "sk" | "sl" | "sq" | "sr" | "sr-latn" | "sv" | "sw" | "ta" | "te" | "tg" | "th" | "tk" | "tr" | "tt" | "udm" | "uk" | "ur" | "uz" | "vi" | "zh-hans" | "zh-hant";
+type NamiLogLevel = "error" | "warn" | "info" | "debug";
+// image
+type TImageComponent = TBaseComponent & {
+    component: "image";
+    url?: string | null;
+    aspectRatio?: number;
+    imageCropping?: "fill" | "fit";
+};
+// spacer
+type TSpacerComponent = TBaseComponent & {
+    component: "spacer";
+};
+// svgImage
+type TSvgImageComponent = TBaseComponent & {
+    component: "svgImage";
+    url?: string | null;
+    fontColor?: string;
+};
+// Symbol
+type TSymbolComponent = Omit<TTextComponent, "component" | "textType" | "text"> & {
+    component: "symbol";
+    // currently hardcoded, need to be updated
+    name: string;
+};
+// text
+type TTextComponent = TBaseComponent & {
+    component: "text";
+    textType: "title" | "body" | "legal";
+    androidFontSize?: number;
+    fontSize?: number;
+    fontColor?: string;
+    fontName?: string;
+    text: string;
+    strikethrough?: boolean;
+    linkColor?: string;
+};
+// text-list
+type TTextListComponent = Omit<TTextComponent, "component" | "text"> & {
+    component: "text-list";
+    texts: string[];
+    bulletComponent?: TSymbolComponent;
+};
+// condition
+type TConditionalComponent = TBaseComponent & {
+    component: "condition";
+    components?: TComponent[];
+    assertions?: TTestObject[];
+    orAssertions?: TTestObject[] | undefined;
+};
+// button
+type TButtonContainer = TBaseComponent & {
+    component: "button";
+    actionTap: string;
+    onTap?: {
+        function: string;
+    };
+    components: Array<TTextComponent | TTextListComponent | TSpacerComponent | TImageComponent>;
+};
+// carouselContainer
+type TCarouselContainer = Omit<TContainer, "component"> & {
+    component: "carouselContainer";
+    indicatorColor: string;
+    activeIndicatorColor: string;
+    autoplay: boolean;
+    autoplaySeconds: number;
+};
+type TCarouselSlidesState = {
+    [groupId: string]: {
+        [carouselName: string]: TCarouselSlide[];
+    };
+};
+type TCarouselSlide = {
+    id: string;
+    title: string;
+    [slideAttr: string]: any;
+};
+// flexProductContainer
+type TFlexProductContainer = Omit<TContainer, "component"> & {
+    component: "flexProductContainer";
+    products: "all" | "subset";
+    flexDirection: FlexDirectionObject;
+    subsetGroup?: string;
+    productFeaturedComponents: TContainer[];
+    productBaseComponents: TContainer[];
+};
+type FlexDirectionObject = {
+    small: "vertical" | "horizontal";
+    medium: "vertical" | "horizontal";
+    large: "vertical" | "horizontal";
+    xlarge: "vertical" | "horizontal";
+};
+// productContainer
+type TProductContainer = Omit<TContainer, "component"> & {
+    component: "productContainer";
+    products: "all" | "subset";
+    subsetGroup?: string;
+    productFeaturedComponents: TContainer[];
+    productBaseComponents: TContainer[];
+};
+// stack
+type TStack = Omit<TContainer, "component"> & {
+    component: "stack";
+};
+// type TBaseComponentMapped = {
+//   [K in keyof TBaseComponent]: TBaseComponent[K] extends number
+//     ? number | string
+//     : TBaseComponent[K];
+// };
+interface TBaseComponent {
+    component: string;
+    grow?: boolean;
+    flag?: null | string;
+    context?: {
+        [key: string]: any;
+    };
+    moveX?: number | string;
+    moveY?: string | number;
+    direction?: DirectionType;
+    spacing?: number;
+    alignment?: AlignmentType;
+    leftPadding?: number;
+    rightPadding?: number;
+    topPadding?: number;
+    bottomPadding?: number;
+    leftMargin?: number;
+    rightMargin?: number;
+    topMargin?: number | string;
+    bottomMargin?: number;
+    fillColor?: string;
+    borderWidth?: number;
+    borderRadius?: number;
+    borderColor?: string;
+    borders?: Array<BorderSideType>;
+    focusedBorders?: Array<BorderSideType>;
+    focusedFillColor?: string;
+    focusedFontColor?: string;
+    focusedBorderColor?: string;
+    focusedBorderWidth?: number;
+    focusedBorderRadius?: number;
+    roundBorders?: Array<BorderLocationType>;
+    focusedRoundBorders?: Array<BorderLocationType>;
+    zIndex?: number;
+    conditionAttributes?: TConditionalAttributes;
+    height?: number | string;
+    width?: number | string;
+    dropShadow?: string;
+    refId?: string;
+    // TODO: Deprecate the attributes below
+    _fields?: {
+        [attribute: string]: TFieldSettings;
+    } & {
+        _group: string;
+        _label: string;
+        _toggleAttr: string | null;
+        _toggleValue: any;
+        _collapsible: boolean;
+        _hint: string | null;
+    };
+    _fieldGroupLabel?: string;
+    _fieldLabel?: string;
+    _fieldHint?: string;
+    _fieldReadOnly?: boolean;
+    _fieldPlaceholder?: string;
+    _fieldDescription?: string;
+    _fieldOmit?: string[];
+    fixedHeight?: number;
+    fixedWidth?: number | "fitContent";
+}
+type TComponent = TButtonContainer | TContainer | TTextListComponent | TTextComponent | TSpacerComponent | TImageComponent | TSvgImageComponent | TSymbolComponent | TCarouselContainer | TProductContainer | TFlexProductContainer | TStack | TConditionalComponent;
+type DirectionType = "vertical" | "horizontal";
+type AlignmentType = "center" | "right" | "left" | "top" | "bottom";
+type BorderLocationType = "upperLeft" | "upperRight" | "lowerLeft" | "lowerRight";
+type BorderSideType = "left" | "right" | "top" | "bottom";
+type TContainerPosition = `${"center" | "start" | "end"}-${"top" | "bottom" | "left" | "right"}`;
+type TTestObject = {
+    value: any;
+    expected: any;
+    operator: "equals" | "contains" | "notEquals" | "set" | "notSet";
+};
+type TConditionalAttributes = Array<Omit<TConditionalComponent, "components"> & {
+    attributes: Partial<TBaseComponent>;
+}>;
+type TField = "image" | "listContainerComponent" | "text" | "url" | "textArea" | "fontSelect" | "splitTextArea" | "color" | "colorGradient" | "number" | "alignment" | "carouselSlides" | "option" | "iconSelect" | "toggle";
+type TContainer = TBaseComponent & {
+    component: "container";
+    position?: TContainerPosition;
+    fillColor?: string;
+    fillImage?: string | null;
+    components: TComponent[];
+    loopVariable?: string;
+    loopSource?: any[];
+};
+// export type TContainerPosition = string;
+type TFieldSettings = {
+    type: TField;
+    label: string;
+    hint: string | null;
+    description: string | null;
+    placeholder: string | null;
+    variable: string;
+    readOnly: boolean;
+    markdownHint: boolean;
+    options: {
+        label: string;
+        value: any;
+    }[] | null;
+    maxLimit: number | null;
+    minLimit: number | null;
+    aspectRatio: number | null;
+    newSlide?: TCarouselSlide;
+    carousel?: string;
+    darkModeVariable?: string;
+    conditions?: TTestObject[];
+    showOpacity?: boolean;
+    newRow?: any;
+};
+type TPaywallContext = TInitialState & {
+    paywallId: string;
+    livePaywalls: IPaywall[];
+    selectedPaywall: IPaywall | undefined;
+    campaignRules: CampaignRule[];
+    anySkuHasTrialOffer: boolean;
+    anySkuHasIntroOffer: boolean;
+    anySkuHasPromoOffer: boolean;
+    safeAreaTop: number;
+    slides?: TCarouselSlidesState;
+    currentPage: string;
+    fullScreenPresentation?: boolean;
+    isLoggedIn?: boolean;
+    darkMode?: boolean;
+    [key: string]: any;
+    groups: {
+        id: string;
+        displayName: string;
+        ref: string;
+    }[];
+    currentGroupId: string;
+    selectedProducts: {
+        [currentGroupId: string]: string;
+    };
+    launch: {
+        productGroups: string[];
+        customAttributes: {
+            [key: string]: any;
+        };
+    };
+    sku: {
+        [key: string]: any;
+    };
+};
+interface IPaywall {
+    id: string;
+    name: string;
+    paywall_type: string;
+    sku_menus: ISkuMenu[];
+    template: TPaywallTemplate;
+    fonts: FontCollection;
+}
+interface ISkuMenu {
+    id: string;
+    name: string;
+    display_name: string;
+    ref: string;
+    products: IProducts[];
+}
+interface IProducts {
+    id: string;
+    featured: boolean;
+    name: string;
+    sku_ref_id: string;
+    display_text: string;
+    sub_display_text: string;
+    entitlements: IEntitlements[];
+    variables?: {
+        [key: string]: any;
+    };
+    sku_type: string;
+    _isSelected?: boolean; // local prop maybe will be removed
+}
+interface IEntitlements {
+    id: string;
+    entitlement_ref_id: string;
+    name: string;
+    description: string | null;
+    type: string;
+}
+type FontCollection = {
+    [fontName: string]: FontDetails;
+};
+type FontDetails = {
+    id: string;
+    family: string;
+    style: string;
+    file: string;
+};
+type TPaywallTemplate = {
+    id: string;
+    orgs?: string | null;
+    media?: {
+        [key: string]: string;
+    };
+    pages: TPages[];
+    ready?: boolean;
+    version: string | number;
+    codename: string;
+    doc_link: string;
+    thumbnail?: string;
+    skuContexts?: {
+        [skuId: string]: {
+            [key: string]: any;
+        };
+    };
+    initialState: TInitialState;
+    min_sdk_version: string;
+};
+type TPages = {
+    name: string;
+    header: Array<TButtonContainer | TSpacerComponent | TTextComponent | TContainer>;
+    contentContainer: TContainer | null;
+    footer: TComponent[] | null;
+    backgroundContainer: TContainer | null;
+};
+type TInitialState = {
+    slides?: TCarouselSlidesState;
+    currentPage: string;
+    fullScreenPresentation?: boolean;
+    isLoggedIn?: boolean;
+    [key: string]: any;
+    groups: {
+        id: string;
+        displayName: string;
+        ref: string;
+    }[];
+    currentGroupId: string;
+    selectedProducts: {
+        [currentGroupId: string]: string;
+    };
+};
+interface IConfig {
+    id: string;
+    capabilities: string[];
+    marketplace_app_id: string;
+}
+type NamiConfiguration = {
+    appPlatformId: string;
+    logLevel?: NamiLogLevel;
+    languageCode?: NamiLanguageCode;
+    namiCommands?: string[];
+    initialConfig?: InitialConfig;
+    formFactor?: TDevice;
+};
+type InitialConfig = {
+    appConfig: IConfig;
+    products: IProducts[];
+    paywalls: IPaywall[];
+    campaign_rules: CampaignRule[];
+};
+type NamiConfigurationState = {
+    sdkInitialized: boolean;
+    configureState: string;
+};
+declare class Nami {
+    #private;
+    static instance: Nami;
+    get isInitialized(): boolean;
+    static configure(options: NamiConfiguration, requestCallback?: (result: NamiConfigurationState) => void): Promise<void>;
+    private initializeSDK;
+}
+interface ApiServiceOptions {
+    baseURL?: string;
+    platformID: string;
+}
+declare class ApiService {
+    private baseURL;
+    private platformID;
+    constructor(options: ApiServiceOptions);
+    fetchAPI<T>(path: string): Promise<T>;
+    requestBodyAPI<T, U>(path: string, bodyData: T, method?: string): Promise<U>;
+}
+declare class CampaignRuleRepository {
+    private apiService;
+    currentFormFactor: TDevice;
+    constructor(apiService: ApiService, cFormFactor: TDevice);
+    fetchCampaignRules(paywalls: IPaywall[]): Promise<CampaignRule[]>;
+    invokeAvailableCampaignsResponseHandler(campaigns: CampaignRule[]): void;
+    private fallbackData;
+}
+declare class PaywallRepository {
+    private apiService;
+    constructor(apiService: ApiService);
+    fetchPaywalls(): Promise<IPaywall[]>;
+    private fallbackData;
+}
+declare class ContextConsumer implements ReactiveController {
+    host: ReactiveControllerHost;
+    state: TPaywallContext;
+    constructor(host: ReactiveControllerHost);
+    handleStateChange(): void;
+    // Implementing ReactiveController interface methods
+    hostConnected(): void;
+    hostDisconnected(): void;
+}
+declare class NamiElement extends LitElement {
+    contextConsumer: ContextConsumer;
+    protected styles(): CSSResult;
+    createRenderRoot(): HTMLElement | DocumentFragment;
+    disconnectedCallback(): void;
+}
+declare class PaywallComponent extends NamiElement {
+    private formFactor;
+    constructor(paywall: IPaywall, formFactor: TDevice);
+    private getTemplate;
+    render(): TemplateResult;
+}
+declare class NamiCampaignManager {
+    static instance: NamiCampaignManager;
+    emitter: EventEmitter<[
+        never
+    ]>;
+    private sdkInitialized;
+    private campaignRuleRepository;
+    private paywallRepository;
+    _init(campaignRepo: CampaignRuleRepository, paywallRepo: PaywallRepository, sdkInitialized?: boolean): void;
+    static allCampaigns(): CampaignRule[];
+    static isCampaignAvailable(type: string, value: string): boolean;
+    static refresh(refreshCallback: (campaign?: CampaignRule[]) => void): Promise<void>;
+    static registerAvailableCampaignsHandler(handler: AvailableCampaignsResponseHandler): void;
+    static launch(type: string, value?: string): PaywallComponent;
+}
+type AccountStateHandler = (action: AccountStateAction, success: boolean, error?: Error) => void;
+type Callback = () => void;
+/**
+ * Represents the possible actions that can be performed on the account state.
+ */
+declare enum AccountStateAction {
+    LOGIN = "login",
+    LOGOUT = "logout",
+    ADVERTISING_ID_SET = "advertising_id_set",
+    ADVERTISING_ID_CLEARED = "advertising_id_cleared",
+    VENDOR_ID_SET = "vendor_id_set",
+    VENDOR_ID_CLEARED = "vendor_id_cleared",
+    CUSTOMER_DATA_PLATFORM_ID_SET = "customer_data_platform_id_set",
+    CUSTOMER_DATA_PLATFORM_ID_CLEARED = "customer_data_platform_id_cleared",
+    ANONYMOUS_MODE_ON = "anonymous_mode_on",
+    ANONYMOUS_MODE_OFF = "anonymous_mode_off",
+    NAMI_DEVICE_ID_SET = "nami_device_id_set",
+    NAMI_DEVICE_ID_CLEARED = "nami_device_id_cleared"
+}
+/**
+ * NamiCustomerManager provides methods for managing customer-related functionality.
+ */
+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): void;
+    /**
+     * 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;
+    /**
+     * 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();
+}
+declare class NamiPaywallManager {
+    static instance: NamiPaywallManager;
+    private sdkInitialized;
+    _init(sdkInitialized?: boolean): void;
+    static allPaywalls(): IPaywall[];
+    static setProductDetails(): void;
+    static registerSignInHandler(): void;
+    static registerCloseHandler(): void;
+    static registerDeeplinkActionHandler(): void;
+    static registerBuySkuHandler(): void;
+    static buySkuComplete(): void;
+    static buySkuCancel(): void;
+}
+export { Nami, NamiCampaignManager, NamiCustomerManager, NamiPaywallManager, NamiConfiguration, NamiLanguageCode, CampaignRule as NamiCampaign };