@namiml/web-sdk 1.6.1 → 1.6.2

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

@@ -3,6 +3,7 @@ import { TDevice } from "../types/device";
 import { NamiCampaign } from "../types/externals/campaign";
 export declare class CampaignRuleRepository {
     currentFormFactor: TDevice;
+    splitPosition: number;
     static instance: CampaignRuleRepository;
     constructor(cFormFactor: TDevice);
     fetchCampaignRules(paywalls: IPaywall[]): Promise<NamiCampaign[]>;

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

@@ -7,4 +7,6 @@ export declare class DeviceRepository {
     updateDeviceField<T>(key: string, value: T): Promise<Device | null>;
     private requestAPIData;
     private isEqualDevices;
+    getOrCreateAnonymousUUID(): string;
+    private getAnonymousUUID;
 }

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

@@ -54,6 +54,9 @@ export declare class StorageService {
     clearSessionId(): void;
     setPurchaseChannel(channel?: string): void;
     getPurchaseChannel(): string | null;
+    getAnonymousUUID(): string | null;
+    setAnonymousUUID(uuid: string): void;
+    clearAnonymousUUID(): void;
     /**
      * Set an item in localStorage.
      * @param {string} key - The key under which to store the data.

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

@@ -60,6 +60,7 @@ export type TTextComponent = TBaseComponent & {
     linkColor?: string;
     dateTimeFormat?: string;
     blur?: number | null;
+    capitalize?: boolean;
 };
 export type TTextLikeComponent = TTextComponent | TTextListComponent | TSymbolComponent;
 export type TTextListComponent = Omit<TTextComponent, "component" | "text"> & {
@@ -85,3 +86,13 @@ export type TConditionalComponent = TBaseComponent & {
     assertions?: TTestObject[];
     orAssertions?: TTestObject[] | undefined;
 };
+export type TQRCodeComponent = TBaseComponent & {
+    component: "qrCode";
+    url: string;
+    height: number | string;
+    width: number | string;
+    color?: string;
+    fillColor?: string;
+    borderWidth?: number;
+    borderColor?: string;
+};

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

@@ -1,5 +1,5 @@
 import { TButtonContainer, TCarouselContainer, TCarouselSlide, TCollapseContainer, TFlexProductContainer, TPlayPauseButton, TProductContainer, TResponsiveGrid, TStack, TVolumeButton, UserAction } from "./containers";
-import { TConditionalComponent, TImageComponent, TSegmentPicker, TSegmentPickerItem, TSpacerComponent, TSvgImageComponent, TSymbolComponent, TTextComponent, TTextListComponent, TVideoComponent } from "./elements";
+import { TConditionalComponent, TImageComponent, TQRCodeComponent, TSegmentPicker, TSegmentPickerItem, TSpacerComponent, TSvgImageComponent, TSymbolComponent, TTextComponent, TTextListComponent, TVideoComponent } from "./elements";
 export interface TBaseComponent {
     id?: string;
     title?: string;
@@ -68,7 +68,7 @@ export interface TBaseComponent {
     fixedWidth?: number | "fitContent";
     hidden?: boolean;
 }
-export type TComponent = TButtonContainer | TContainer | TTextListComponent | TTextComponent | TSpacerComponent | TImageComponent | TSvgImageComponent | TSymbolComponent | TCarouselContainer | TProductContainer | TFlexProductContainer | TStack | TConditionalComponent | TSegmentPicker | TSegmentPickerItem | TVideoComponent | TCollapseContainer | TResponsiveGrid | TVolumeButton | TPlayPauseButton;
+export type TComponent = TButtonContainer | TContainer | TTextListComponent | TTextComponent | TSpacerComponent | TImageComponent | TSvgImageComponent | TSymbolComponent | TCarouselContainer | TProductContainer | TFlexProductContainer | TStack | TConditionalComponent | TSegmentPicker | TSegmentPickerItem | TVideoComponent | TCollapseContainer | TResponsiveGrid | TVolumeButton | TPlayPauseButton | TQRCodeComponent;
 export type DirectionType = "vertical" | "horizontal";
 export type AlignmentType = "center" | "right" | "left" | "top" | "bottom";
 export type BorderLocationType = "upperLeft" | "upperRight" | "lowerLeft" | "lowerRight";

package/dist/types/config.d.ts

@@ -1,4 +1,4 @@
-import { NamiCampaign } from "../types/externals/campaign";
+import { NamiAnonymousCampaign } from "../types/externals/campaign";
 import { IPaywall } from "./paywall";
 import { PaywallSKU } from "./sku";
 export interface IConfig {
@@ -11,8 +11,12 @@ export type InitialConfig = {
     platform_config?: IConfig;
     products?: PaywallSKU[];
     paywalls?: IPaywall[];
-    campaign_rules?: NamiCampaign[];
+    campaign_rules?: NamiAnonymousCampaign[];
 };
+export type InitialConfigCompressed = {
+    initial_config: string;
+};
+export declare const isInitialConfigCompressed: (config: InitialConfig | InitialConfigCompressed) => config is InitialConfigCompressed;
 export type NamiConfigurationState = {
     sdkInitialized: boolean;
     configureState: string;

package/dist/types/device.d.ts

@@ -19,6 +19,7 @@ export interface Device {
     vendor_id: string;
 }
 export interface DevicePayload {
+    id?: string;
     os_version: string;
     os_name: string;
     browser_name: string;

package/dist/types/externals/campaign.d.ts

@@ -1,5 +1,30 @@
 import { CampaignRuleConversionEventType, FormFactor } from "../campaign";
 import { NamiFlowDTO, NamiFlowWithObject } from "../flow";
+/**
+ * @type NamiCampaignSegment
+ * Represents a segment within a campaign.
+ */
+export interface NamiCampaignSegment {
+    form_factors: FormFactor[];
+    paywall?: string | null;
+    flow?: NamiFlowDTO | null;
+    segment: string;
+    split: number;
+    conversion_event_type?: CampaignRuleConversionEventType | null;
+    conversion_event_url?: string | null;
+}
+/**
+ * @type NamiAnonymousCampaign
+ * Represents the anonymous campaign in Nami.
+ */
+export interface NamiAnonymousCampaign {
+    rule: string;
+    name: string;
+    type: string | NamiCampaignRuleType;
+    value?: string | null;
+    external_segment: string | null;
+    segments: NamiCampaignSegment[];
+}
 /**
  * @type NamiCampaign
  * Represents the campaign in Nami.

package/dist/types/externals/config.d.ts

@@ -1,22 +1,13 @@
-import { IConfig } from "../config";
+import { InitialConfig, InitialConfigCompressed } from "../config";
 import { NamiLanguageCodes } from "./languages";
 import { NamiLogLevel } from "./loglevel";
-import { IPaywall } from "../paywall";
-import { PaywallSKU } from "../sku";
-import { NamiCampaign } from "./campaign";
 /**
  * @type NamiInitialConfig
  *
  * Defines the structure of the initial configuration that can be provided
  * when setting up the Nami SDK.
  */
-export type NamiInitialConfig = {
-    appConfig?: IConfig;
-    platform_config?: IConfig;
-    products?: PaywallSKU[];
-    paywalls?: IPaywall[];
-    campaign_rules?: NamiCampaign[];
-};
+export type NamiInitialConfig = InitialConfig | InitialConfigCompressed;
 /**
  * @type NamiConfiguration
  * This is needed to configure and initialize the SDK via [Nami.configure]

package/dist/types/externals/flow.d.ts

@@ -30,4 +30,16 @@ export declare const NamiFlowManager: {
      * It signals to continue to the next step in the flow sequence.
      */
     resume: any;
+    /**
+     * Finishes the current flow programmatically.
+     *
+     * This can be used to end the flow at any point, typically after a handoff or custom logic.
+     */
+    finish: any;
+    /**
+     * Checks if a flow is currently open.
+     *
+     * @returns {boolean} - True if a flow is open, false otherwise.
+     */
+    isFlowOpen: any;
 };

package/dist/types/sku.d.ts

@@ -16,6 +16,10 @@ export interface PaywallSKU extends SKU {
         [key: string]: any;
     };
     product_details?: NamiProductDetails | null;
+    offer_id?: string | null;
+    offer_type?: string | null;
+    offer_ref_id?: string | null;
+    computed_signature?: string | null;
 }
 export type AppleProduct = unknown;
 export type GoogleProduct = unknown;

package/dist/utils/config.d.ts

@@ -1,6 +1,8 @@
-import { ExtendedPlatformInfo } from "../types/config";
+import { ExtendedPlatformInfo, InitialConfig, InitialConfigCompressed } from "../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;
 export declare const shouldValidateProductGroups: () => boolean;
+export declare function tryParseJson(str: string): InitialConfig | InitialConfigCompressed | undefined;
+export declare function tryParseB64Gzip(str: string): InitialConfig | undefined;

package/dist/utils/const.d.ts

@@ -1 +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, FLOW_SCREENS_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, DEVICE_ID_NOT_SET: string, AUTH_DEVICE: string, NAMI_CONFIGURATION: string, NAMI_PROFILE: string, API_CONFIG: string, API_CAMPAIGN_RULES: string, API_PAYWALLS: string, API_PRODUCTS: string, API_ACTIVE_ENTITLEMENTS: string, SERVER_NAMI_ENTITLEMENTS: string, INITIAL_APP_CONFIG: string, INITIAL_CAMPAIGN_RULES: string, INITIAL_PAYWALLS: string, INITIAL_PRODUCTS: string, LOCAL_NAMI_ENTITLEMENTS: string, CUSTOMER_ATTRIBUTES_KEY_PREFIX: string, NAMI_CUSTOMER_JOURNEY_STATE: string, ANONYMOUS_MODE: string, KEY_SESSION_COUNTER: string, INITIAL_SESSION_COUNTER_VALUE: number, NAMI_LAST_IMPRESSION_ID: string, NAMI_PURCHASE_IMPRESSION_ID: string, NAMI_SESSION_ID: string, NAMI_LANGUAGE_CODE: string, NAMI_PURCHASE_CHANNEL: 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, VALIDATE_PRODUCT_GROUPS: string, EXTENDED_PLATFORM: string, EXTENDED_PLATFORM_VERSION: string, API_MAX_CALLS_LIMIT: number, API_RETRY_DELAY_SEC: number, API_TIMEOUT_LIMIT: 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, AVAILABLE_ACTIVE_ENTITLEMENTS_CHANGED: string, CUSTOMER_JOURNEY_STATE_CHANGED: string, SKU_TEXT_REGEX: RegExp, VAR_REGEX: RegExp, HTML_REGEX: RegExp, SMART_TEXT_PATTERN: string, CORS_PROXY_URL: string, CORS_PROXY_URL_LOCAL: string;
+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, FLOW_SCREENS_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, DEVICE_ID_NOT_SET: string, AUTH_DEVICE: string, NAMI_CONFIGURATION: string, NAMI_PROFILE: string, API_CONFIG: string, API_CAMPAIGN_RULES: string, API_PAYWALLS: string, API_PRODUCTS: string, API_ACTIVE_ENTITLEMENTS: string, SERVER_NAMI_ENTITLEMENTS: string, INITIAL_APP_CONFIG: string, INITIAL_CAMPAIGN_RULES: string, INITIAL_PAYWALLS: string, INITIAL_PRODUCTS: string, LOCAL_NAMI_ENTITLEMENTS: string, CUSTOMER_ATTRIBUTES_KEY_PREFIX: string, NAMI_CUSTOMER_JOURNEY_STATE: string, ANONYMOUS_MODE: string, ANONYMOUS_UUID: string, KEY_SESSION_COUNTER: string, INITIAL_SESSION_COUNTER_VALUE: number, NAMI_LAST_IMPRESSION_ID: string, NAMI_PURCHASE_IMPRESSION_ID: string, NAMI_SESSION_ID: string, NAMI_LANGUAGE_CODE: string, NAMI_PURCHASE_CHANNEL: 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, VALIDATE_PRODUCT_GROUPS: string, EXTENDED_PLATFORM: string, EXTENDED_PLATFORM_VERSION: string, API_MAX_CALLS_LIMIT: number, API_RETRY_DELAY_SEC: number, API_TIMEOUT_LIMIT: number, DEVICE_API_TIMEOUT_LIMIT: number, STATUS_SUCCESS: number, STATUS_BAD_REQUEST: number, STATUS_NOT_FOUND: number, STATUS_CONFLICT: number, STATUS_INTERNAL_SERVER_ERROR: number, INITIAL_SUCCESS: string, RECONFIG_SUCCESS: string, ALREADY_CONFIGURED: string, AVAILABLE_CAMPAIGNS_CHANGED: string, PAYWALL_ACTION_EVENT: string, AVAILABLE_ACTIVE_ENTITLEMENTS_CHANGED: string, CUSTOMER_JOURNEY_STATE_CHANGED: string, SKU_TEXT_REGEX: RegExp, VAR_REGEX: RegExp, HTML_REGEX: RegExp, SMART_TEXT_PATTERN: string, CORS_PROXY_URL: string, CORS_PROXY_URL_LOCAL: string;

package/dist/utils/device.d.ts

@@ -2,3 +2,5 @@ import { DevicePayload, TDevice } from "../types/device";
 export declare const getDeviceData: (namiCommands?: string[]) => DevicePayload;
 export declare const getDeviceFormFactor: () => TDevice;
 export declare function getDeviceScaleFactor(formFactor?: string): number;
+export declare function generateUUID(): string;
+export declare function audienceSplitPosition(uuid: string): number;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@namiml/web-sdk",
   "type": "module",
-  "version": "1.6.1",
+  "version": "1.6.2",
   "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": {
@@ -56,6 +56,7 @@
   "devDependencies": {
     "@eslint/js": "^9.2.0",
     "@open-wc/testing": "^4.0.0",
+    "@rollup/plugin-commonjs": "^28.0.6",
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@rollup/plugin-replace": "^5.0.5",
     "@rollup/plugin-terser": "^0.4.4",
@@ -63,6 +64,9 @@
     "@types/jest": "^29.5.12",
     "@types/lodash-es": "^4.17.4",
     "@types/node": "^22.2.0",
+    "@types/pako": "^2",
+    "@types/qrcode": "^1",
+    "buffer": "^6.0.3",
     "eslint": "^9.2.0",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
@@ -86,6 +90,8 @@
     "lit": "^3.1.3",
     "lodash-es": "^4.17.21",
     "marked": "^12.0.2",
+    "pako": "^2.1.0",
+    "qrcode": "^1.5.4",
     "swiper": "^11.1.12"
   },
   "homepage": "https://www.namiml.com",