@namiml/web-sdk 1.0.0 → 1.2.0

package/dist/types/paywall.d.ts

@@ -0,0 +1,222 @@
+import { CampaignRule } from "./campaign";
+import { TComponent, TContainer } from "./components";
+import { TButtonContainer, TCarouselSlidesState } from "./components/containers";
+import { TSpacerComponent, TTextComponent } from "./components/elements";
+import { TDeviceOrientation } from "./device";
+import { NamiSKU, PaywallSKU } from "./sku";
+import { NamiPurchase } from "./purchase";
+import { Optional } from "./utils";
+import { LaunchCampaignError } from "./errors";
+export 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;
+    orientation: TDeviceOrientation;
+    focusedState: boolean;
+    platformId: string;
+    mediaList: {
+        [key: string]: any;
+    };
+    customer: {
+        [key: string]: any;
+    };
+    hasNotch: boolean;
+    skuItems: PaywallSKU[];
+    groups: {
+        id: string;
+        displayName: string;
+        ref: string;
+    }[];
+    currentGroupId: string;
+    selectedProducts: {
+        [currentGroupId: string]: string;
+    };
+    launch: TPaywallLaunchContext;
+    sku: {
+        [key: string]: any;
+    };
+    purchaseInProgress: boolean;
+    productBeingPurchased?: NamiSKU;
+    timeSpentOnPaywall?: number;
+};
+export type TPaywallLaunchContext = {
+    productGroups: string[];
+    customAttributes: {
+        [key: string]: any;
+    };
+    customObject?: {
+        [key: string]: any;
+    };
+};
+export type ProductGroup = {
+    id: string;
+    products: PaywallSKU[];
+    ref: string;
+};
+export interface IPaywall {
+    id: string;
+    name: string;
+    paywall_type: string;
+    sku_menus: ISkuMenu[];
+    template: TPaywallTemplate;
+    fonts: FontCollection;
+}
+export interface ISkuMenu {
+    id: string;
+    name: string;
+    display_name: string;
+    ref: string;
+    products: PaywallSKU[];
+}
+export interface IEntitlements {
+    id: string;
+    entitlement_ref_id: string;
+    name: string;
+    description: string | null;
+    type: string;
+}
+export interface IProductsWithComponents extends PaywallSKU {
+    components: TComponent;
+}
+export type FontCollection = {
+    [fontName: string]: FontDetails;
+};
+export type FontDetails = {
+    id: string;
+    family: string;
+    style: string;
+    file: string;
+};
+export type TPaywallTemplate = {
+    id: string;
+    orgs?: string | null;
+    org_id?: string;
+    changelog?: string;
+    userHasAccess?: boolean;
+    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;
+};
+export type TPages = {
+    name: string;
+    header: Array<TButtonContainer | TSpacerComponent | TTextComponent | TContainer>;
+    contentContainer: TContainer | null;
+    footer: TComponent[] | null;
+    backgroundContainer: TContainer | null;
+};
+export 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;
+    };
+};
+export type TPaywallMedia = {
+    id: string;
+    content: string | null;
+    paywall: string;
+    name: string;
+};
+export type TProductGroup = {
+    id: string;
+    display_name: string;
+    display_order: number;
+    default: boolean;
+    paywall: string;
+    ref: string;
+};
+export type TMediaTypes = {
+    [name: string]: Optional<TPaywallMedia, 'id'>;
+};
+export type TOffer = {
+    freeTrialEligible: boolean;
+    introEligible: boolean;
+    promoEligible: boolean;
+};
+export declare enum PaywallManagerEvents {
+    REGISTER_BUY_SKU = "RegisterBuySKU",
+    PAYWALL_CLOSE_REQUESTED = "PaywallCloseRequested",
+    PAYWALL_SIGNIN_REQUESTED = "PaywallSignInRequested",
+    PAYWALL_RESTORE_REQUESTED = "PaywallRestoreRequested",
+    PAYWALL_DEEPLINK_ACTION = "PaywallDeeplinkAction"
+}
+export declare enum NamiPaywallAction {
+    BUY_SKU = "BUY_SKU",
+    SELECT_SKU = "SELECT_SKU",
+    RESTORE_PURCHASES = "RESTORE_PURCHASES",
+    SIGN_IN = "SIGN_IN",
+    CLOSE_PAYWALL = "CLOSE_PAYWALL",
+    SHOW_PAYWALL = "SHOW_PAYWALL",
+    PURCHASE_SELECTED_SKU = "PURCHASE_SELECTED_SKU",
+    PURCHASE_SUCCESS = "PURCHASE_SUCCESS",
+    PURCHASE_FAILED = "PURCHASE_FAILED",
+    PURCHASE_CANCELLED = "PURCHASE_CANCELLED",
+    PURCHASE_PENDING = "PURCHASE_PENDING",
+    PURCHASE_UNKNOWN = "PURCHASE_UNKNOWN",
+    PURCHASE_DEFERRED = "PURCHASE_DEFERRED",
+    EMPTY = ""
+}
+export type NamiPaywallEvent = {
+    action: NamiPaywallAction;
+    sku?: NamiSKU;
+    campaignId?: string;
+    campaignName?: string;
+    campaignType?: string;
+    campaignLabel?: string;
+    campaignUrl?: string;
+    paywallId?: string;
+    paywallName?: string;
+    componentChange?: NamiPaywallComponentChange;
+    segmentId?: string;
+    externalSegmentId?: string;
+    deeplinkUrl?: string;
+    purchaseError?: string;
+    purchases?: NamiPurchase[];
+    timeSpentOnPaywall?: number;
+};
+export type NamiPaywallComponentChange = {
+    id?: string;
+    name?: string;
+};
+export type PaywallActionEvent = {
+    action: NamiPaywallAction;
+    sku?: NamiSKU;
+    timeSpentOnPaywall?: number;
+    componentChange?: NamiPaywallComponentChange;
+    purchaseError?: string;
+    purchases?: NamiPurchase[];
+};
+export type NamiPaywallActionHandler = (event: NamiPaywallEvent) => void;
+export type PaywallResultHandler = (success: boolean, error?: LaunchCampaignError) => void;

package/dist/types/products.d.ts

@@ -0,0 +1,34 @@
+export interface NamiProductDetails {
+    name?: string;
+    description?: string;
+    product_ref_id: string;
+    product_type: ProductType;
+    subscription_period?: NamiSubscriptionPeriod;
+    offers: NamiProductOffer[];
+}
+export type NamiProductOffer = NamiOfferPrice & {
+    offer_ref_id?: string;
+    offer_type: 'promo' | 'default';
+    promo_period?: NamiOfferPeriod;
+    promo_price?: NamiOfferPrice;
+};
+type NamiOfferPrice = {
+    price: number;
+    currency: string;
+};
+export type NamiSubscriptionPeriod = {
+    type: SubscriptionInterval;
+    count: number;
+    period_start?: number;
+    period_end?: number;
+};
+type NamiOfferPeriod = NamiSubscriptionPeriod;
+export type SubscriptionInterval = 'day' | 'week' | 'month' | 'year' | 'unknown';
+export type ProductType = 'subscription' | 'one_time_purchase' | 'unknown';
+export type PricingPhase = {
+    priceAmountMicros: number;
+    priceCurrencyCode: string;
+    billingPeriod: string;
+    formattedPrice: string;
+};
+export {};

package/dist/types/profile.d.ts

@@ -0,0 +1,20 @@
+export type NamiProfile = {
+    externalId: string;
+};
+/**
+ * Represents the possible actions that can be performed on the account state.
+ */
+export 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"
+}

package/dist/types/purchase.d.ts

@@ -0,0 +1,45 @@
+import { NamiSKU } from "./sku";
+export type NamiPurchaseSource = "campaign" | "marketplace" | "unknown";
+export type NamiPurchaseState = "purchased" | "failed" | "cancelled" | "pending" | "unknown";
+export interface Purchase {
+    orderId: string;
+    productId: string;
+    purchaseTime: number;
+    purchaseState: NamiPurchaseState;
+    purchaseToken: string;
+    autoRenewing: boolean;
+    acknowledged: boolean;
+    sku: NamiSKU;
+    type: "inapp" | "subs" | "unknown";
+}
+export type NamiPurchase = {
+    purchase_initiated_timestamp: number;
+    purchase_source: NamiPurchaseSource;
+    sku_id: string;
+    sku_UUID: string;
+    transaction_identifier?: string;
+    purchase_token?: string;
+};
+export type TransactionRequest = {
+    quantity?: string;
+    currency?: string;
+    purchase_env: string;
+    amount: string;
+    impression?: string;
+    session: string;
+    original_transaction_id?: string;
+    transaction_id?: string;
+    source?: string;
+    sku?: string;
+    localized_description?: string;
+    subscription_interval?: string;
+    subscription_interval_count: number;
+    purchase_date?: string;
+    original_purchase_date?: string;
+    app_env?: string;
+};
+export type PurchaseValidationRequest = {
+    app_env: string;
+    payload: string;
+    sku: string;
+};

package/dist/types/sku.d.ts

@@ -0,0 +1,35 @@
+import { IEntitlements } from "./paywall";
+import { NamiProductDetails, ProductType } from "./products";
+export interface SKU {
+    id: string;
+    name: string;
+    sku_ref_id: string;
+    entitlements: IEntitlements[];
+    sku_type: ProductType;
+}
+export interface PaywallSKU extends SKU {
+    display_text?: string;
+    sub_display_text?: string;
+    featured?: boolean;
+    variables?: {
+        [key: string]: any;
+    };
+    product_details?: NamiProductDetails | null;
+}
+export type NamiSKU = {
+    id: string;
+    name?: string;
+    skuId: string;
+    appleProduct?: AppleProduct;
+    googleProduct?: GoogleProduct;
+    amazonProduct?: AmazonProduct;
+    type: ProductType;
+    promoId?: string | null;
+    promoToken?: string | null;
+    productDetails?: NamiProductDetails | null;
+    entitlements: IEntitlements[];
+};
+type AppleProduct = unknown;
+type GoogleProduct = unknown;
+type AmazonProduct = unknown;
+export {};

package/dist/types/utils.d.ts

@@ -0,0 +1 @@
+export type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;

package/dist/utils/config.d.ts

@@ -0,0 +1,5 @@
+import { ExtendedPlatformInfo } from "src/types/config";
+export declare const getBaseUrl: (namiCommands?: string[]) => string;
+export declare const getExtendedClientInfo: (namiCommands: string[]) => ExtendedPlatformInfo;
+export declare const hasCapability: (capability: string) => boolean;
+export declare const hasPurchaseManagement: (messagePrefix?: string) => boolean;

package/dist/utils/const.d.ts

@@ -0,0 +1 @@
+export declare const NAMI_SDK_VERSION: string, PRODUCTION: string, DEVELOPMENT: string, PLATFORM_ID_REQUIRED: string, DEVICE_ID_REQUIRED: string, EXTERNAL_ID_REQUIRED: string, SDK_NOT_INITIALIZED: string, CAMPAIGN_NOT_AVAILABLE: string, UNABLE_TO_UPDATE_CDP_ID: string, ANONYMOUS_MODE_ALREADY_ON: string, ANONYMOUS_MODE_ALREADY_OFF: string, ANONYMOUS_MODE_LOGIN_NOT_ALLOWED: string, SESSION_REQUIRED: string, AUTH_DEVICE: string, NAMI_CONFIGURATION: string, NAMI_PROFILE: string, API_CONFIG: string, API_CAMPAIGN_RULES: string, API_PAYWALLS: string, API_PRODUCTS: string, INITIAL_APP_CONFIG: string, INITIAL_CAMPAIGN_RULES: string, INITIAL_PAYWALLS: string, INITIAL_PRODUCTS: string, CUSTOMER_ATTRIBUTES_KEY_PREFIX: string, ANONYMOUS_MODE: string, KEY_SESSION_COUNTER: string, INITIAL_SESSION_COUNTER_VALUE: number, NAMI_LAST_IMPRESSION_ID: string, NAMI_SESSION_ID: string, API_VERSION: any, BASE_URL_PATH: string, BASE_URL: string, BASE_STAGING_URL: string, CUSTOM_HOST_PREFIX: string, USE_STAGING_API: string, EXTENDED_CLIENT_INFO_PREFIX: string, EXTENDED_CLIENT_INFO_DELIMITER: string, EXTENDED_PLATFORM: string, EXTENDED_PLATFORM_VERSION: string, API_MAX_CALLS_LIMIT: number, API_RETRY_DELAY_SEC: number, DEVICE_API_TIMEOUT_LIMIT: number, STATUS_SUCCESS: number, STATUS_BAD_REQUEST: number, STATUS_NOT_FOUND: number, STATUS_INTERNAL_SERVER_ERROR: number, INITIAL_SUCCESS: string, RECONFIG_SUCCESS: string, ALREADY_CONFIGURED: string, AVAILABLE_CAMPAIGNS_CHANGED: string, PAYWALL_ACTION_EVENT: string, SKU_TEXT_REGEX: RegExp, VAR_REGEX: RegExp, CORS_PROXY_URL: string, CORS_PROXY_URL_LOCAL: string;

package/dist/utils/device.d.ts

@@ -0,0 +1,3 @@
+import { DevicePayload, TDevice } from "src/types/device";
+export declare const getDeviceData: (namiCommands?: string[]) => DevicePayload;
+export declare const getDeviceFormFactor: () => TDevice;

package/dist/utils/events.d.ts

@@ -0,0 +1,30 @@
+export function once(emitter: any, name: any): Promise<any>;
+export default EventEmitter;
+declare function EventEmitter(): void;
+declare class EventEmitter {
+    _events: any;
+    _eventsCount: number | undefined;
+    _maxListeners: number | undefined;
+    setMaxListeners(n: any): this;
+    getMaxListeners(): any;
+    emit(type: any, ...args: any[]): boolean;
+    addListener(type: any, listener: any): any;
+    on: any;
+    prependListener(type: any, listener: any): any;
+    once(type: any, listener: any): this;
+    prependOnceListener(type: any, listener: any): this;
+    removeListener(type: any, listener: any): this;
+    off: any;
+    removeAllListeners(type: any, ...args: any[]): this;
+    listeners(type: any): any[];
+    rawListeners(type: any): any[];
+    listenerCount: typeof listenerCount;
+    eventNames(): any;
+}
+declare namespace EventEmitter {
+    export { EventEmitter };
+    export let defaultMaxListeners: number;
+    export function init(): void;
+    export function listenerCount(emitter: any, type: any): any;
+}
+declare function listenerCount(type: any): any;

package/dist/utils/fonts.d.ts

@@ -0,0 +1,7 @@
+import { FontDetails } from "src/types/paywall";
+export declare function prepareAndLoadFonts(fontsObject: {
+    [key: string]: any;
+}): Promise<FontFaceSet>;
+export declare const loadFonts: (fonts: FontDetails[]) => Promise<FontFaceSet>;
+export declare function buildFontFaceFamily(font: FontDetails): string;
+export declare function sanitizeFontName(value: string): string;

package/dist/utils/ssr-shim.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@namiml/web-sdk",
   "type": "module",
-  "version": "1.0.0",
-  "source": "src/index.ts",
+  "version": "1.2.0",
+  "source": "src/nami-web.ts",
   "description": "Nami Web SDK makes subscriptions & in-app purchases easy, with powerful built-in paywalls and A/B testing",
   "scripts": {
     "clear-test-cache": "jest --clearCache",
     "test": "yarn clear-test-cache && jest --coverage -i --forceExit",
-    "build-sdk": "rm -rf dist && tsc && rollup -c",
-    "watch-modern-sdk": "microbundle --tsconfig tsconfig.json --no-sourcemap --output ./dist/nami.mjs --watch --no-compress --format modern --define NAMI_SDK_ENV='development'",
+    "build-sdk": "rm -rf dist && rollup -c",
+    "watch": "microbundle --tsconfig tsconfig.dev.json --output ./dist/nami-web.mjs --watch --no-compress --format modern --define NAMI_SDK_ENV='development'",
     "build:dev": "yarn build-sdk --environment NAMI_SDK_ENV:development",
     "build:prod": "yarn build-sdk --environment NAMI_SDK_ENV:production",
     "react-dev": "yarn build:dev && yarn copy-react && cd examples/react-demo && yarn start",
@@ -63,7 +63,6 @@
     "@types/jest": "^29.5.12",
     "@types/lodash-es": "^4.17.4",
     "eslint": "^9.2.0",
-    "globals": "^15.1.0",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
     "jest-fetch-mock": "^3.0.3",
@@ -75,13 +74,25 @@
     "ts-jest": "^29.1.2",
     "ts-node": "^10.9.2",
     "typescript": "^5.4.5",
-    "typescript-eslint": "^7.8.0"
+    "typescript-eslint": "^7.8.0",
+    "wrangler": "^3.66.0"
   },
   "dependencies": {
+    "@lit-labs/ssr-dom-shim": "^1.2.0",
     "bowser": "^2.11.0",
     "lit": "^3.1.3",
     "lodash-es": "^4.17.21",
     "marked": "^12.0.2"
   },
-  "homepage": "https://www.namiml.com"
+  "homepage": "https://www.namiml.com",
+  "bugs": {
+    "url": "https://github.com/namiml/nami-web-sdk/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/namiml/nami-web-sdk.git"
+  },
+  "resolutions": {
+    "@esm-bundle/chai": "4.3.4-fix.0"
+  }
 }