@namiml/web-sdk 1.3.2 → 1.5.0

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

@@ -1,6 +1,6 @@
-import { IPaywall } from "src/types/paywall";
-import { TDevice } from "src/types/device";
-import { NamiCampaign } from "src/types/externals/campaign";
+import { IPaywall } from "../types/paywall";
+import { TDevice } from "../types/device";
+import { NamiCampaign } from "../types/externals/campaign";
 export declare class CampaignRuleRepository {
     currentFormFactor: TDevice;
     static instance: CampaignRuleRepository;

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

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

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

@@ -0,0 +1,5 @@
+import { CustomerJourneyState } from "src/types/externals/customer";
+export declare class CustomerJourneyRepository {
+    static instance: CustomerJourneyRepository;
+    fetchCustomerJourneyState(): Promise<CustomerJourneyState | null>;
+}

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

@@ -1,4 +1,4 @@
-import { Device, DevicePayload } from "src/types/device";
+import { Device, DevicePayload } from "../types/device";
 export declare class DeviceRepository {
     static instance: DeviceRepository;
     createOrUpdateDevice(deviceData: DevicePayload): Promise<Device | null>;

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

@@ -1,4 +1,4 @@
-import { IEntitlements } from "src/types/entitlements";
+import { IEntitlements } from "../types/entitlements";
 export declare class EntitlementRepository {
     static instance: EntitlementRepository;
     constructor();

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

@@ -1,4 +1,4 @@
-import { IPaywall } from "src/types/paywall";
+import { IPaywall } from "../types/paywall";
 export declare class PaywallRepository {
     static instance: PaywallRepository;
     fetchPaywalls(): Promise<IPaywall[]>;

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

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

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

@@ -1,4 +1,4 @@
-import { NamiLogLevel } from "src/types/loglevel";
+import { NamiLogLevel } from "../types/externals/loglevel";
 declare class Logger {
     private currentLogLevel;
     setLogger: (level?: NamiLogLevel) => void;

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

@@ -3,8 +3,9 @@ import { IConfig, NamiConfiguration } from "src/types/config";
 import { IPaywall } from "src/types/paywall";
 import { NamiCampaign } from "src/types/externals/campaign";
 import { NamiProfile } from "src/types/profile";
-import { IEntitlements, NamiEntitlement } from "src/types/entitlements";
+import { IEntitlements, NamiEntitlement } from "../types/entitlements";
 import { SKU } from "src/types/sku";
+import { CustomerJourneyState } from "src/types/externals/customer";
 declare class StorageService {
     setDevice(device: Device): void;
     getDevice(): Device | null;
@@ -14,6 +15,8 @@ declare class StorageService {
     clearAnonymousMode(): void;
     setAppConfig(key: string, config: IConfig): void;
     getAppConfig(key: string): IConfig | null;
+    setLanguageCode(code?: string): void;
+    getLanguageCode(): string;
     setCampaignRules(key: string, campaignRules: NamiCampaign[]): void;
     getCampaignRules(key: string): NamiCampaign[] | null;
     setPaywalls(key: string, paywalls: IPaywall[]): void;
@@ -29,11 +32,14 @@ declare class StorageService {
     setCustomerAttribute<T>(attribute: string, value: T): void;
     getCustomerAttribute<T>(attribute: string): T | null;
     getAllCustomerAttributes(): string[];
+    getAllCustomerAttributesKeys(): string[];
     clearCustomerAttribute(attribute: string): boolean;
     clearAllCustomerAttributes(): void;
     setNamiProfile(profileData: NamiProfile): void;
     getNamiProfile(): NamiProfile | null;
     removeNamiProfile(): void;
+    setCustomerJourneyState(state: CustomerJourneyState): void;
+    getCustomerJourneyState(): CustomerJourneyState | null;
     setSessionCounter(): void;
     setLastImpressionId(id: string): void;
     getLastImpressionId(): string;

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

@@ -0,0 +1,17 @@
+import { NamiPaywallAction } from "src/types/externals/paywall";
+export declare class VideoService {
+    video: HTMLVideoElement;
+    playing: boolean;
+    muted: boolean;
+    muteByDefault: boolean;
+    loopVideo: boolean;
+    autoplayVideo: boolean;
+    videoComponentName: string;
+    videoComponentId: string;
+    static instance: VideoService;
+    constructor(video: HTMLVideoElement, muteByDefault: boolean, loopVideo: boolean, autoplayVideo: boolean, name?: string, id?: string);
+    togglePlayVideo(): void;
+    toggleMuteVideo(): void;
+    videoPlayingAction(): NamiPaywallAction.VIDEO_STARTED | NamiPaywallAction.VIDEO_PAUSED | NamiPaywallAction.VIDEO_RESUMED | NamiPaywallAction.VIDEO_ENDED | NamiPaywallAction.UNKNOWN;
+    handlePlayerAnalytics(action?: NamiPaywallAction): void;
+}

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

@@ -1,14 +1,30 @@
-import { NamiSKU } from "src/types/externals/sku";
+import { NamiSKU } from "../../types/externals/sku";
 import { TBaseComponent, TComponent, TContainer, TTestObject } from ".";
 import { TImageComponent, TSpacerComponent, TTextComponent, TTextListComponent } from "./elements";
 export type THeaderFooter = (TContainer | TButtonContainer | TSpacerComponent | TTextComponent)[];
-export type TButtonContainer = TBaseComponent & {
+type Button = TBaseComponent & {
     id?: string;
-    component: "button";
     sku?: NamiSKU;
     components: Array<TTextComponent | TTextListComponent | TSpacerComponent | TImageComponent>;
     screenreaderText?: string;
 };
+export type TButtonContainer = Button & {
+    component: "button";
+};
+export type TPlayPauseButton = Button & {
+    component: "playPauseButton";
+    pausedOnTap: UserAction;
+    playingOnTap: UserAction;
+    pausedComponents: TComponent[];
+    playingComponents: TComponent[];
+};
+export type TVolumeButton = Button & {
+    component: "volumeButton";
+    mutedComponents: TComponent[];
+    volumeComponents: TComponent[];
+    mutedOnTap: UserAction;
+    volumeOnTap: UserAction;
+};
 export type UserAction = {
     function: string;
     parameters?: UserActionParameters;
@@ -21,13 +37,20 @@ export type UserActionParameters = {
     confirmationMessage?: string;
     confirmBeforePurchase?: TTestObject[];
 };
-export type Callback = (sku?: NamiSKU) => void;
+export type SKUActionHandler = (sku: NamiSKU) => void;
+export type DeepLinkUrlHandler = (url: string) => void;
+export type CloseHandler = (body?: any) => void;
+export type Callback = () => void;
 export type TCarouselContainer = Omit<TContainer, "component"> & {
     component: "carouselContainer";
     indicatorColor: string;
     activeIndicatorColor: string;
     autoplay: boolean;
     autoplaySeconds: number;
+    loopSource?: any[];
+    loopVariable?: string;
+    loopSourceConditions: TTestObject[];
+    showIndicators?: boolean;
 };
 export type TCarouselSlidesState = {
     [groupId: string]: {
@@ -69,3 +92,11 @@ export type TCollapseContainer = TBaseComponent & {
     components: TComponent[];
     open: "collapse" | "open";
 };
+export type TResponsiveGrid = TBaseComponent & {
+    component: "responsiveGrid";
+    components: any;
+    loopVariable?: string;
+    loopSource?: any[];
+    loopSourceConditions: TTestObject[];
+};
+export {};

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

@@ -56,6 +56,7 @@ export type TTextComponent = TBaseComponent & {
     text: string;
     strikethrough?: boolean | string;
     linkColor?: string;
+    dateTimeFormat?: string;
 };
 export type TTextLikeComponent = TTextComponent | TTextListComponent | TSymbolComponent;
 export type TTextListComponent = Omit<TTextComponent, "component" | "text"> & {

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

@@ -1,4 +1,4 @@
-import { TButtonContainer, TCarouselContainer, TCarouselSlide, TCollapseContainer, TFlexProductContainer, TProductContainer, TStack, UserAction } from "./containers";
+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";
 export interface TBaseComponent {
     id?: string;
@@ -15,6 +15,8 @@ export interface TBaseComponent {
     direction?: DirectionType;
     spacing?: number;
     alignment?: AlignmentType;
+    horizontalAlignment?: AlignmentType;
+    verticalAlignment?: AlignmentType;
     leftPadding?: number;
     rightPadding?: number;
     topPadding?: number;
@@ -64,7 +66,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;
+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 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,7 +1,7 @@
-import { NamiCampaign } from "src/types/externals/campaign";
+import { NamiCampaign } from "../types/externals/campaign";
 import { TDevice } from "./device";
 import { NamiLanguageCodes } from "./externals/languages";
-import { NamiLogLevel } from "./loglevel";
+import { NamiLogLevel } from "./externals/loglevel";
 import { IPaywall } from "./paywall";
 import { PaywallSKU } from "./sku";
 export interface IConfig {

package/dist/types/customer.d.ts

@@ -0,0 +1,2 @@
+import { CustomerJourneyState } from "./externals";
+export type NamiCustomerJourneyStateHandler = (customerJourneyState: CustomerJourneyState) => void;

package/dist/types/entitlements.d.ts

@@ -6,6 +6,7 @@ export type IEntitlements = {
     name: string;
     description: string | null;
     type: string;
+    expires?: string;
 };
 export type NamiEntitlement = {
     activePurchases: NamiPurchase[];
@@ -15,5 +16,6 @@ export type NamiEntitlement = {
     purchasedSkus: NamiSKU[];
     referenceId: string;
     relatedSkus: NamiSKU[];
+    expires?: number;
 };
 export type NamiActiveEntitlementsHandler = (entitlement: NamiEntitlement[]) => void;

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

@@ -1,4 +1,8 @@
 import { CampaignRuleConversionEventType, FormFactor } from "../campaign";
+/**
+ * @type NamiCampaign
+ * Represents the campaign in Nami.
+ */
 export interface NamiCampaign {
     rule: string;
     name: string;
@@ -7,10 +11,14 @@ export interface NamiCampaign {
     type: string | NamiCampaignRuleType;
     value?: string | null;
     form_factors: FormFactor[];
-    external_segment_id: string | null;
+    external_segment: string | null;
     conversion_event_type?: CampaignRuleConversionEventType;
     conversion_event_url?: string;
 }
+/**
+ * @enum NamiCampaignRuleType
+ * Types of Nami campaigns
+ */
 export declare enum NamiCampaignRuleType {
     DEFAULT = "default",
     LABEL = "label",

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

@@ -1,10 +1,16 @@
 import { IConfig } from "../config";
 import { TDevice } from "../device";
 import { NamiLanguageCodes } from "./languages";
-import { NamiLogLevel } from "../loglevel";
+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;
@@ -12,6 +18,26 @@ export type NamiInitialConfig = {
     paywalls?: IPaywall[];
     campaign_rules?: NamiCampaign[];
 };
+/**
+ * @type NamiConfiguration
+ * This is needed to configure and initialize the SDK via [Nami.configure]
+ * method
+ *
+ * @param appPlatformID A UUID for the app. You can find the Nami App Platform ID in the App
+ * Settings screen on the Platforms tab in the Nami Control Center.
+ * @param logLevel Optional preferable [NamiLogLevel] to set within SDK to get appropriate
+ * logging information. Make sure to either not set this param in release build, or set
+ * to [NamiLogLevel.ERROR] if you would like Nami error logs to be shown in your release/production
+ * app build. Default is set to [NamiLogLevel.WARN]
+ * @param namiCommands provides set of external commands useful for SDK.
+ * @param initialConfig contains initial configuration, useful in offline mode.
+ * @param namiLanguageCode sets the language to be used for paywalls on the device. Select from
+ * [NamiLanguageCode]
+ * <p>
+ * Default is set to `false`. Note that this should be set to `true` only from `debug` or
+ * `non-production` version of the app. Setting this to `true` in a `production` build can
+ * potentially have unwanted consequences.
+ */
 export type NamiConfiguration = {
     appPlatformID: string;
     logLevel: NamiLogLevel;

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

@@ -0,0 +1,18 @@
+/**
+ * This data class represents a customer's subscription journey state
+ */
+export type CustomerJourneyState = {
+    former_subscriber: boolean;
+    in_grace_period: boolean;
+    in_trial_period: boolean;
+    in_intro_offer_period: boolean;
+    is_cancelled: boolean;
+    in_pause: boolean;
+    in_account_hold: boolean;
+};
+/**
+ * This data class represents a device's profile
+ */
+export type DeviceProfile = {
+    customer_journey_state: CustomerJourneyState;
+};

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

@@ -1,11 +1,38 @@
 import { NamiPurchase } from "./purchase";
 import { NamiSKU } from "./sku";
+/**
+ * @type NamiEntitlement
+ * Represents what features a device has access to in an app.
+ */
 export type NamiEntitlement = {
+    /**
+     * The last known Purchase that unlocked this entitlement. There must be a corresponding
+     * NamiSKU associated to this NamiPurchase. That NamiSKU must reside in purchasedSKUs.
+     */
     activePurchases: NamiPurchase[];
+    /**
+     * Description of entitlement
+     */
     desc: string;
+    /**
+     * Friendly name of entitlement
+     */
     name: string;
+    /**
+     * Internal ID for use by the Nami SDK
+     */
     namiId: string;
+    /**
+     * NamiSKUs purchased by the user that actually unlock this entitlement
+     */
     purchasedSkus: NamiSKU[];
+    /**
+     * The unique ID of the entitlement defined in the Nami Control Center, use this to refer
+     * to the system when referencing an entitlement.
+     */
     referenceId: string;
+    /**
+     * The list of possible NamiSKU objects that would unlock this entitlement
+     */
     relatedSkus: NamiSKU[];
 };

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

@@ -6,3 +6,6 @@ export * from "./product";
 export * from "./purchase";
 export * from "./languages";
 export * from "./entitlement";
+export * from "./errors";
+export * from "./customer";
+export * from "./loglevel";

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

@@ -1 +1,197 @@
-export type NamiLanguageCodes = "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 NamiLanguageCodes
+ * Languages supported by Nami paywalls
+ */
+export type NamiLanguageCodes = 
+/** Language Afrikaans **/
+"af"
+/** Language Arabic **/
+ | "ar"
+/** Language Algerian **/
+ | "ar-dz"
+/** Language Asturian **/
+ | "ast"
+/** Language Azerbaijani **/
+ | "az"
+/** Language Bulgarian **/
+ | "bg"
+/** Language Belarusian **/
+ | "be"
+/** Language Bengali **/
+ | "bn"
+/** Language Breton **/
+ | "br"
+/** Language Bosnian **/
+ | "bs"
+/** Language Catalan **/
+ | "ca"
+/** Language Czech **/
+ | "cs"
+/** Language Welsh **/
+ | "cy"
+/** Language Danish **/
+ | "da"
+/** Language German **/
+ | "de"
+/** Language Lower Sorbian **/
+ | "dsb"
+/** Language Greek **/
+ | "el"
+/** Language English **/
+ | "en"
+/** Language Australian English **/
+ | "en-au"
+/** Language British English **/
+ | "en-gb"
+/** Language Esperanto **/
+ | "eo"
+/** Language Spanish **/
+ | "es"
+/** Language Argentinian Spanish **/
+ | "es-ar"
+/** Language Colombian Spanish **/
+ | "es-co"
+/** Language Mexican Spanish **/
+ | "es-mx"
+/** Language Nicaraguan Spanish **/
+ | "es-ni"
+/** Language Venezuelan Spanish **/
+ | "es-ve"
+/** Language Estonian **/
+ | "et"
+/** Language Basque **/
+ | "eu"
+/** Language Persian **/
+ | "fa"
+/** Language Finnish **/
+ | "fi"
+/** Language French **/
+ | "fr"
+/** Language Frisian **/
+ | "fy"
+/** Language Irish **/
+ | "ga"
+/** Language Scottish Gaelic **/
+ | "gd"
+/** Language Galician **/
+ | "gl"
+/** Language Hebrew **/
+ | "he"
+/** Language Hindi **/
+ | "hi"
+/** Language Croatian **/
+ | "hr"
+/** Language Upper Sorbian **/
+ | "hsb"
+/** Language Hungarian **/
+ | "hu"
+/** Language Armenian **/
+ | "hy"
+/** Language Interlingua **/
+ | "ia"
+/** Language Indonesian **/
+ | "id"
+/** Language Igbo **/
+ | "ig"
+/** Language Ido **/
+ | "io"
+/** Language Icelandic **/
+ | "is"
+/** Language Italian **/
+ | "it"
+/** Language Japanese **/
+ | "ja"
+/** Language Georgian **/
+ | "ka"
+/** Language Kabyle **/
+ | "kab"
+/** Language Kazakh **/
+ | "kk"
+/** Language Khmer **/
+ | "km"
+/** Language Kannada **/
+ | "kn"
+/** Language Korean **/
+ | "ko"
+/** Language Kyrgyz **/
+ | "ky"
+/** Language Luxembourgish **/
+ | "lb"
+/** Language Lithuanian **/
+ | "lt"
+/** Language Latvian **/
+ | "lv"
+/** Language Macedonian **/
+ | "mk"
+/** Language Malayalam **/
+ | "ml"
+/** Language Mongolian **/
+ | "mn"
+/** Language Marathi **/
+ | "mr"
+/** Language Burmese **/
+ | "my"
+/** Language Norwegian Bokmål **/
+ | "nb"
+/** Language Nepali **/
+ | "ne"
+/** Language Dutch **/
+ | "nl"
+/** Language Norwegian Nynorsk **/
+ | "nn"
+/** Language Ossetic **/
+ | "os"
+/** Language Punjabi **/
+ | "pa"
+/** Language Polish **/
+ | "pl"
+/** Language Portuguese **/
+ | "pt"
+/** Language Brazilian Portuguese **/
+ | "pt-br"
+/** Language Romanian **/
+ | "ro"
+/** Language Russian **/
+ | "ru"
+/** Language Slovak **/
+ | "sk"
+/** Language Slovenian **/
+ | "sl"
+/** Language Albanian **/
+ | "sq"
+/** Language Serbian **/
+ | "sr"
+/** Language Serbian Latin **/
+ | "sr-latn"
+/** Language Swedish **/
+ | "sv"
+/** Language Swahili **/
+ | "sw"
+/** Language Tamil **/
+ | "ta"
+/** Language Telugu **/
+ | "te"
+/** Language Tajik **/
+ | "tg"
+/** Language Thai **/
+ | "th"
+/** Language Turkmen **/
+ | "tk"
+/** Language Turkish **/
+ | "tr"
+/** Language Tatar **/
+ | "tt"
+/** Language Udmurt **/
+ | "udm"
+/** Language Ukrainian **/
+ | "uk"
+/** Language Urdu **/
+ | "ur"
+/** Language Uzbek **/
+ | "uz"
+/** Language Vietnamese **/
+ | "vi"
+/** Language Simplified Chinese **/
+ | "zh-hans"
+/** Language Traditional Chinese **/
+ | "zh-hant";

package/dist/types/{loglevel.d.ts → externals/loglevel.d.ts}

@@ -1,3 +1,6 @@
+/**
+ * Set the level of logs to print while running the SDK
+ */
 export type NamiLogLevel = "error" | "warn" | "info" | "debug";
 export declare enum LogLevel {
     DEBUG = 1,

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

@@ -1,5 +1,9 @@
 import { NamiPurchase } from "./purchase";
 import { NamiSKU } from "./sku";
+/**
+ * @enum NamiPaywallAction
+ * Types of actions paywall will have
+ */
 export declare enum NamiPaywallAction {
     BUY_SKU = "BUY_SKU",
     SELECT_SKU = "SELECT_SKU",
@@ -29,7 +33,14 @@ export declare enum NamiPaywallAction {
     VIDEO_UNMUTED = "VIDEO_UNMUTED",
     UNKNOWN = "UNKNOWN"
 }
+/**
+ * @type NamiPaywallEvent
+ * Represents the events(actions) triggered by rendered paywall
+ */
 export type NamiPaywallEvent = {
+    /**
+     * Any action from [NamiPaywallAction]
+     */
     action: NamiPaywallAction;
     sku?: NamiSKU;
     campaignId?: string;
@@ -40,14 +51,29 @@ export type NamiPaywallEvent = {
     paywallId?: string;
     paywallName?: string;
     componentChange?: NamiPaywallComponentChange;
+    /**
+     * segment from [NamiCampaign]
+     */
     segmentId?: string;
+    /**
+     * external_segment from [NamiCampaign]
+     */
     externalSegmentId: string | null;
     deeplinkUrl?: string;
     purchaseError?: string;
     purchases?: NamiPurchase[];
+    /**
+     * Total time user has spent on paywall page,
+     * From rendering paywall to clicking on close button of paywall
+     */
     timeSpentOnPaywall?: number;
+    videoMetaData?: NamiPaywallEventVideoMetadata;
 };
 export type NamiPaywallActionHandler = (event: NamiPaywallEvent) => void;
+/**
+ * @type NamiPaywallLaunchContext
+ * Will be used to pass custom context while launching paywall
+ */
 export type NamiPaywallLaunchContext = {
     productGroups?: string[];
     customAttributes: {
@@ -57,10 +83,16 @@ export type NamiPaywallLaunchContext = {
         [key: string]: any;
     };
 };
+/**
+ * @type NamiPaywallComponentChange
+ */
 export type NamiPaywallComponentChange = {
     id?: string;
     name?: string;
 };
+/**
+ * @type NamiPaywallEventVideoMetadata
+ */
 export type NamiPaywallEventVideoMetadata = {
     id?: string;
     name?: string;

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

@@ -1,4 +1,8 @@
 import { NamiSKUType } from "../externals/sku";
+/**
+ * @type NamiProductDetails
+ * minimal required product details formed from actual product details
+ */
 export interface NamiProductDetails {
     name?: string;
     description?: string;