@namiml/web-sdk 1.1.0 → 1.2.0

package/dist/repositories/campaignRule.repository.d.ts

@@ -0,0 +1,13 @@
+import { IPaywall } from "src/types/paywall";
+import { CampaignRule } from "src/types/campaign";
+import { TDevice } from "src/types/device";
+export declare class CampaignRuleRepository {
+    currentFormFactor: TDevice;
+    static instance: CampaignRuleRepository;
+    constructor(cFormFactor: TDevice);
+    fetchCampaignRules(paywalls: IPaywall[]): Promise<CampaignRule[]>;
+    invokeAvailableCampaignsResponseHandler(campaigns?: CampaignRule[]): void;
+    private getAnonymousCampaigns;
+    private getCampaigns;
+    private fallbackData;
+}

package/dist/repositories/config.repository.d.ts

@@ -0,0 +1,5 @@
+import { IConfig } from "src/types/config";
+export declare class ConfigRepository {
+    static instance: ConfigRepository;
+    fetchConfig(): Promise<IConfig | null>;
+}

package/dist/repositories/device.repository.d.ts

@@ -0,0 +1,10 @@
+import { Device, DevicePayload } from "src/types/device";
+export declare class DeviceRepository {
+    static instance: DeviceRepository;
+    createOrUpdateDevice(deviceData: DevicePayload): Promise<Device | null>;
+    createDevice(deviceData: DevicePayload): Promise<Device | null>;
+    updateDevice(currentDeviceId: string, deviceData: DevicePayload): Promise<Device | null>;
+    updateDeviceField<T>(key: string, value: T): Promise<Device | null>;
+    private requestAPIData;
+    private isEqualDevices;
+}

package/dist/repositories/paywall.repository.d.ts

@@ -0,0 +1,8 @@
+import { IPaywall } from "src/types/paywall";
+export declare class PaywallRepository {
+    static instance: PaywallRepository;
+    fetchPaywalls(): Promise<IPaywall[]>;
+    private getAnonymousPaywalls;
+    private getPaywalls;
+    private fallbackData;
+}

package/dist/repositories/products.repository.d.ts

@@ -0,0 +1,6 @@
+import { SKU } from "src/types/sku";
+export declare class ProductRepository {
+    static instance: ProductRepository;
+    fetchProducts(): Promise<SKU[]>;
+    private fallbackData;
+}

package/dist/services/logger.service.d.ts

@@ -0,0 +1,13 @@
+import { NamiLogLevel } from "src/types/loglevel";
+declare class Logger {
+    private currentLogLevel;
+    setLogger: (level?: NamiLogLevel) => void;
+    debug<T>(message: T, ...args: unknown[]): void;
+    info<T>(message: T, ...args: unknown[]): void;
+    warn<T>(message: T, ...args: unknown[]): void;
+    error<T>(message: T, ...args: unknown[]): void;
+    private shouldLog;
+    private formatMessage;
+}
+export declare const logger: Logger;
+export {};

package/dist/services/session.service.d.ts

@@ -0,0 +1,4 @@
+export declare class SessionService {
+    static instance: SessionService;
+    startSession(): Promise<void>;
+}

package/dist/services/storage.service.d.ts

@@ -0,0 +1,61 @@
+import { Device } from "src/types/device";
+import { IConfig, NamiConfiguration } from "src/types/config";
+import { IPaywall } from "src/types/paywall";
+import { CampaignRule } from "src/types/campaign";
+import { NamiProfile } from "src/types/profile";
+import { SKU } from "src/types/sku";
+declare class StorageService {
+    setDevice(device: Device): void;
+    getDevice(): Device | null;
+    resetDevice(): void;
+    getAnonymousMode(): boolean;
+    setAnonymousMode(mode: boolean): void;
+    clearAnonymousMode(): void;
+    setAppConfig(key: string, config: IConfig): void;
+    getAppConfig(key: string): IConfig | null;
+    setCampaignRules(key: string, campaignRules: CampaignRule[]): void;
+    getCampaignRules(key: string): CampaignRule[] | null;
+    setPaywalls(key: string, paywalls: IPaywall[]): void;
+    getPaywalls(key: string): IPaywall[] | null;
+    setProducts(key: string, products: SKU[]): void;
+    getProducts(key: string): SKU[] | null;
+    setNamiConfig(config: NamiConfiguration): void;
+    getNamiConfig(): NamiConfiguration | null;
+    setCustomerAttribute<T>(attribute: string, value: T): void;
+    getCustomerAttribute<T>(attribute: string): T | null;
+    getAllCustomerAttributes(): string[];
+    clearCustomerAttribute(attribute: string): boolean;
+    clearAllCustomerAttributes(): void;
+    setNamiProfile(profileData: NamiProfile): void;
+    getNamiProfile(): NamiProfile | null;
+    removeNamiProfile(): void;
+    setSessionCounter(): void;
+    setLastImpressionId(id?: string): void;
+    getLastImpressionId(): string;
+    setSessionId(id?: string): void;
+    getSessionId(): string | null;
+    clearSessionId(): void;
+    /**
+     * Set an item in localStorage.
+     * @param {string} key - The key under which to store the data.
+     * @param {T} value - The data to store.
+     */
+    private setItem;
+    /**
+     * Get an item from localStorage.
+     * @param {string} key - The key of the item to retrieve.
+     * @returns {T | null} The stored data, or null if not found.
+     */
+    private getItem;
+    /**
+     * Remove an item from localStorage.
+     * @param {string} key - The key of the item to remove.
+     */
+    private resetItem;
+    /**
+     * Clear all items from localStorage.
+     */
+    clear(): void;
+}
+export declare const storageService: StorageService;
+export {};

package/dist/types/api.d.ts

@@ -0,0 +1,28 @@
+export interface ApiResponse<T> {
+    count: number;
+    next: number;
+    page_number: number;
+    previous: null;
+    results: T;
+    total_pages: number;
+}
+export type LoginPayload = {
+    external_id: string;
+};
+export type LoginResponse = {
+    external_id: string;
+    user_id: string;
+};
+export type Session = {
+    id?: string;
+    app_env?: string;
+    start_time?: Date;
+    end_time?: Date;
+};
+export type Impression = {
+    id?: string;
+    session?: string;
+    segment?: string;
+    call_to_action?: string;
+    app_env?: string;
+};

package/dist/types/campaign.d.ts

@@ -0,0 +1,21 @@
+export interface CampaignRule {
+    rule: string;
+    name: string;
+    paywall: string;
+    segment: string;
+    form_factors: FormFactor[];
+    type: string;
+    external_segment_id: string;
+    value: string;
+}
+export interface FormFactor {
+    form_factor: string;
+    supports_portrait: boolean;
+    supports_landscape: boolean;
+}
+export type AvailableCampaignsResponseHandler = (campaigns: CampaignRule[]) => void;
+export declare enum CampaignRuleType {
+    DEFAULT = "default",
+    LABEL = "label",
+    URL = "url"
+}

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

@@ -0,0 +1,67 @@
+import { TBaseComponent, TContainer, TTestObject } from ".";
+import { NamiSKU } from "../sku";
+import { TImageComponent, TSpacerComponent, TTextComponent, TTextListComponent } from "./elements";
+export type THeaderFooter = (TContainer | TButtonContainer | TSpacerComponent | TTextComponent)[];
+export type TButtonContainer = TBaseComponent & {
+    id?: string;
+    component: "button";
+    actionTap?: string;
+    onTap?: UserAction;
+    sku?: NamiSKU;
+    components: Array<TTextComponent | TTextListComponent | TSpacerComponent | TImageComponent>;
+    screenreaderText?: string;
+};
+export type UserAction = {
+    function: string;
+    parameters?: UserActionParameters;
+};
+export type UserActionParameters = {
+    partialState?: Record<string, any>;
+    url?: string;
+    screen?: string;
+    promo?: string;
+    confirmationMessage?: string;
+    confirmBeforePurchase?: TTestObject[];
+};
+export type Callback = (sku?: NamiSKU) => void;
+export type TCarouselContainer = Omit<TContainer, "component"> & {
+    component: "carouselContainer";
+    indicatorColor: string;
+    activeIndicatorColor: string;
+    autoplay: boolean;
+    autoplaySeconds: number;
+};
+export type TCarouselSlidesState = {
+    [groupId: string]: {
+        [carouselName: string]: TCarouselSlide[];
+    };
+};
+export type TCarouselSlide = {
+    id: string;
+    title: string;
+    [slideAttr: string]: any;
+};
+export type TFlexProductContainer = Omit<TContainer, "component"> & {
+    component: "flexProductContainer";
+    products: "all" | "subset";
+    flexDirection: FlexDirectionObject;
+    subsetGroup?: string;
+    productFeaturedComponents?: TContainer[];
+    productBaseComponents?: TContainer[];
+};
+export type FlexDirectionObject = {
+    small: "vertical" | "horizontal";
+    medium: "vertical" | "horizontal";
+    large: "vertical" | "horizontal";
+    xlarge: "vertical" | "horizontal";
+};
+export type TProductContainer = Omit<TContainer, "component"> & {
+    component: "productContainer";
+    products: "all" | "subset";
+    subsetGroup?: string;
+    productFeaturedComponents?: TContainer[];
+    productBaseComponents?: TContainer[];
+};
+export type TStack = Omit<TContainer, "component"> & {
+    component: "stack";
+};

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

@@ -0,0 +1,79 @@
+import { AlignmentType, BorderLocationType, TBaseComponent, TComponent, TTestObject } from ".";
+import { UserAction } from "./containers";
+export type TImageComponent = TBaseComponent & {
+    component: "image";
+    url?: string | null;
+    aspectRatio?: number;
+    imageCropping?: "fill" | "fit";
+};
+export type TSegmentPicker = TBaseComponent & {
+    component: "segmentPicker";
+    components: TSegmentPickerItem[];
+    onTap?: UserAction;
+};
+export type TSegmentPickerItem = TBaseComponent & {
+    component: "segmentPickerItem";
+    ref?: any;
+    text?: string;
+    alignment?: AlignmentType;
+    activeFillColor?: string;
+    activeBorderColor?: string;
+    activeBorderRadius?: number;
+    activeBorderWidth?: number;
+    activeRoundBorders?: Array<BorderLocationType>;
+    activeFontSize?: number;
+    activeFontColor?: string;
+    activeFontName?: string;
+    inactiveBorderRadius?: number;
+    inactiveBorderColor?: string;
+    inactiveBorderWidth?: number;
+    inactiveRoundBorders?: Array<BorderLocationType>;
+    inactiveFontSize?: number;
+    inactiveFontName?: string;
+    inactiveFontColor?: string;
+    leftPadding?: number;
+    rightPadding?: number;
+    topPadding?: number;
+    bottomPadding?: number;
+};
+export type TSpacerComponent = TBaseComponent & {
+    component: "spacer";
+};
+export type TSvgImageComponent = TBaseComponent & {
+    component: "svgImage";
+    url?: string | null;
+    fontColor?: string;
+};
+export type TSymbolComponent = Omit<TTextComponent, "component" | "textType" | "text"> & {
+    component: "symbol";
+    name: string;
+};
+export type TTextComponent = TBaseComponent & {
+    component: "text";
+    textType: "title" | "body" | "legal" | "text";
+    androidFontSize?: number;
+    fontSize?: number;
+    fontColor?: string;
+    fontName?: string;
+    text: string;
+    strikethrough?: boolean | string;
+    linkColor?: string;
+};
+export type TTextLikeComponent = TTextComponent | TTextListComponent | TSymbolComponent;
+export type TTextListComponent = Omit<TTextComponent, "component" | "text"> & {
+    component: "text-list";
+    texts: string[];
+    bulletComponent?: TSymbolComponent;
+};
+export type TVideoComponent = TBaseComponent & {
+    component: "videoUrl";
+    url?: string | null;
+    aspectRatio?: number;
+    imageCropping?: "fill" | "fit";
+};
+export type TConditionalComponent = TBaseComponent & {
+    component: "condition";
+    components?: TComponent[];
+    assertions?: TTestObject[];
+    orAssertions?: TTestObject[] | undefined;
+};

package/dist/types/components/index.d.ts

@@ -0,0 +1,117 @@
+import { TButtonContainer, TCarouselContainer, TCarouselSlide, TFlexProductContainer, TProductContainer, TStack } from "./containers";
+import { TConditionalComponent, TImageComponent, TSegmentPicker, TSegmentPickerItem, TSpacerComponent, TSvgImageComponent, TSymbolComponent, TTextComponent, TTextListComponent } from "./elements";
+export interface TBaseComponent {
+    id?: string;
+    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;
+    _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";
+}
+export type TComponent = TButtonContainer | TContainer | TTextListComponent | TTextComponent | TSpacerComponent | TImageComponent | TSvgImageComponent | TSymbolComponent | TCarouselContainer | TProductContainer | TFlexProductContainer | TStack | TConditionalComponent | TSegmentPicker | TSegmentPickerItem;
+export type DirectionType = "vertical" | "horizontal";
+export type AlignmentType = "center" | "right" | "left" | "top" | "bottom";
+export type BorderLocationType = "upperLeft" | "upperRight" | "lowerLeft" | "lowerRight";
+export type BorderSideType = 'left' | 'right' | 'top' | 'bottom';
+export type TContainerPosition = `${'center' | 'start' | 'end'}-${'top' | 'bottom' | 'left' | 'right'}`;
+export declare const BorderMap: Record<BorderLocationType, string>;
+export declare const BorderSideMap: Record<BorderSideType, string>;
+export type TTestObject = {
+    value: any;
+    expected: any;
+    operator: "equals" | "contains" | "notEquals" | "set" | "notSet" | "notContains";
+};
+type TransformToString<T> = {
+    [P in keyof T]: T[P] extends number | boolean ? T[P] | string : T[P];
+};
+export type TConditionalAttributes = Array<Omit<TConditionalComponent, "components"> & {
+    attributes: Partial<TransformToString<TBaseComponent>> & {
+        text?: string;
+    };
+}>;
+export type TField = "image" | "listContainerComponent" | "text" | "url" | "textArea" | "fontSelect" | "splitTextArea" | "color" | "colorGradient" | "number" | "alignment" | "carouselSlides" | "option" | "iconSelect" | "toggle";
+export type TContainer = TBaseComponent & {
+    component: "container";
+    position?: TContainerPosition;
+    fillColor?: string;
+    fillImage?: string | null;
+    components: TComponent[];
+    loopVariable?: string;
+    loopSource?: any[];
+};
+export 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;
+};
+export {};

package/dist/types/config.d.ts

@@ -0,0 +1,43 @@
+import { CampaignRule } from "./campaign";
+import { TDevice } from "./device";
+import { NamiLanguageCode } from "./languages";
+import { NamiLogLevel } from "./loglevel";
+import { IPaywall } from "./paywall";
+import { PaywallSKU } from "./sku";
+export interface IConfig {
+    id: string;
+    capabilities: string[];
+    marketplace_app_id?: string | null;
+}
+export type NamiConfiguration = {
+    appPlatformId: string;
+    logLevel?: NamiLogLevel;
+    languageCode?: NamiLanguageCode;
+    namiCommands?: string[];
+    initialConfig?: string | InitialConfig;
+    formFactor?: TDevice;
+};
+export type InitialConfig = {
+    appConfig?: IConfig;
+    platform_config?: IConfig;
+    products?: PaywallSKU[];
+    paywalls?: IPaywall[];
+    campaign_rules?: CampaignRule[];
+};
+export type NamiConfigurationState = {
+    sdkInitialized: boolean;
+    configureState: string;
+};
+export type ExtendedPlatformInfo = {
+    platform: string;
+    version: string;
+};
+export declare enum Capabilities {
+    SDK = "sdk",
+    ML = "ml",
+    THIRD_PARTY_ANALYTICS = "third_party_analytics",
+    THIRD_PARTY_TRANSACTIONS = "third_party_transactions",
+    PAYWALL_PERSONALIZATION = "paywall_personalization",
+    ANONYMOUS_MODE_CAPABILITY = "anonymous_allowed",
+    LANGUAGE_MANAGEMENT = "language_management"
+}

package/dist/types/device.d.ts

@@ -0,0 +1,35 @@
+export interface Device {
+    id: string;
+    advertising_id: string;
+    app_env: string;
+    app_version: string;
+    country: string;
+    customer_data_platform_id: string;
+    device_model: string;
+    extended_framework_version: string;
+    extended_platform_version: string;
+    extended_platform: string;
+    form_factor: TDevice;
+    language: string;
+    marketplace_country: string;
+    os_name: string;
+    os_version: string;
+    sdk_client: string;
+    sdk_version: string;
+    vendor_id: string;
+}
+export interface DevicePayload {
+    os_version: string;
+    os_name: string;
+    browser_name: string;
+    browser_version: string;
+    sdk_client: string;
+    device_model?: string;
+    form_factor?: string;
+    sdk_version: string;
+    language: string;
+    extended_platform_version?: string;
+    extended_platform?: string;
+}
+export type TDevice = 'phone' | 'tablet' | 'television' | 'desktop';
+export type TDeviceOrientation = 'landscape' | 'portrait';

package/dist/types/errors.d.ts

@@ -0,0 +1,11 @@
+export declare enum LaunchCampaignError {
+    DEFAULT_CAMPAIGN_NOT_FOUND = 0,
+    LABELED_CAMPAIGN_NOT_FOUND = 1,
+    CAMPAIGN_DATA_NOT_FOUND = 2,
+    PAYWALL_ALREADY_DISPLAYED = 3,
+    SDK_NOT_INITIALIZED = 4,
+    PAYWALL_COULD_NOT_DISPLAY = 5,
+    URL_CAMPAIGN_NOT_FOUND = 6,
+    PRODUCT_DATA_NOT_FOUND = 7,
+    PRODUCT_GROUPS_NOT_FOUND = 8
+}

package/dist/types/languages.d.ts

@@ -0,0 +1 @@
+export 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";

package/dist/types/loglevel.d.ts

@@ -0,0 +1,7 @@
+export type NamiLogLevel = "error" | "warn" | "info" | "debug";
+export declare enum LogLevel {
+    DEBUG = 1,
+    INFO = 2,
+    WARN = 3,
+    ERROR = 4
+}