react-native-nami-sdk 3.2.0-beta.1 → 3.2.1-beta.2

package/src/NamiPaywallManager.ts

@@ -50,6 +50,7 @@ export interface INamiPaywallManager {
   isHidden: () => Promise<boolean>;
   isPaywallOpen: () => Promise<boolean>;
   setProductDetails: (productDetails: string, allowOffers: boolean) => void;
+  setAppSuppliedVideoDetails: (url: string, name?: string) => void;
 }
 
 const { NamiPaywallManagerBridge, RNNamiPaywallManager } = NativeModules;
@@ -161,13 +162,10 @@ export const NamiPaywallManager: INamiPaywallManager = {
   isPaywallOpen: () => {
     return RNNamiPaywallManager.isPaywallOpen();
   },
-  setProductDetails: (
-    productDetails: string,
-    allowOffers: boolean
-  ) => {
-    RNNamiPaywallManager.setProductDetails(
-      productDetails,
-      allowOffers,
-    );
+  setProductDetails: (productDetails: string, allowOffers: boolean) => {
+    RNNamiPaywallManager.setProductDetails(productDetails, allowOffers);
+  },
+  setAppSuppliedVideoDetails: (url: string, name?: string) => {
+    RNNamiPaywallManager.setAppSuppliedVideoDetails(url, name);
   },
 };

package/src/NamiPurchaseManager.d.ts

@@ -1,61 +1,20 @@
+import { NativeEventEmitter } from 'react-native';
 import { EmitterSubscription } from 'react-native';
-import { NamiSKU } from './types';
-
-export const NamiPurchaseManager: {
-  allPurchases: () => NamiPurchase[];
-  anySkuPurchased: (skuIds: string[]) => boolean;
-  consumePurchasedSku: (skuId: string) => void;
-  presentCodeRedemptionSheet: () => void;
-  restorePurchases: (
-    callback: (
-      purchaseState: NamiPurchasesState,
-      purchases: NamiPurchase[],
-      error: string,
-    ) => void,
-  ) => EmitterSubscription['remove'];
-  skuPurchased: (skuId: string) => boolean;
-  registerPurchasesChangedHandler: (
-    callback: (
-      purchaseState: NamiPurchasesState,
-      purchases: NamiPurchase[],
-      error: string,
-    ) => void,
-  ) => EmitterSubscription['remove'];
-  registerRestorePurchasesHandler: (
-    callback: (
-      state: NamiRestorePurchasesState,
-      newPurchases: NamiPurchase[],
-      oldPurchases: NamiPurchase[],
-    ) => void,
-  ) => EmitterSubscription['remove'];
-};
-
-export type NamiPurchase = {
-  sku?: NamiSKU;
-  skuId: string;
-  transactionIdentifier?: string;
-  expires?: Date;
-  purchaseInitiatedTimestamp: Date;
-  purchaseSource?: 'CAMPAIGN' | 'MARKETPLACE' | 'UNKNOWN';
-};
-
-export enum NamiPurchaseState {
-  PURCHASED = 'PURCHASED',
-  FAILED = 'FAILED',
-  CANCELLED = 'CANCELLEDd',
-  PENDING = 'PENDING',
-  UNKNOWN = 'UNKNOWN',
+import { NamiPurchase, NamiPurchasesState, NamiRestorePurchasesState } from './types';
+export declare const NamiPurchaseManagerBridge: any, RNNamiPurchaseManager: any;
+export declare enum NamiPurchaseManagerEvents {
+    PurchasesChanged = "PurchasesChanged",
+    RestorePurchasesStateChanged = "RestorePurchasesStateChanged"
 }
-
-export type NamiRestorePurchasesState = 'started' | 'finished' | 'error';
-
-export type NamiPurchasesState =
-  | 'pending'
-  | 'purchased'
-  | 'consumed'
-  | 'resubscribed'
-  | 'unsubscribed'
-  | 'deferred'
-  | 'failed'
-  | 'cancelled'
-  | 'unknown';
+export interface INamiPurchaseManager {
+    emitter: NativeEventEmitter;
+    allPurchases: () => NamiPurchase[];
+    anySkuPurchased: (skuIds: string[]) => boolean;
+    consumePurchasedSku: (skuId: string) => void;
+    presentCodeRedemptionSheet: () => void;
+    restorePurchases: (callback: (purchaseState: NamiPurchasesState, purchases: NamiPurchase[], error: string) => void) => EmitterSubscription['remove'];
+    skuPurchased: (skuId: string) => boolean;
+    registerPurchasesChangedHandler: (callback: (purchaseState: NamiPurchasesState, purchases: NamiPurchase[], error: string) => void) => EmitterSubscription['remove'];
+    registerRestorePurchasesHandler: (callback: (state: NamiRestorePurchasesState, newPurchases: NamiPurchase[], oldPurchases: NamiPurchase[]) => void) => EmitterSubscription['remove'];
+}
+export declare const NamiPurchaseManager: INamiPurchaseManager;

package/src/types.d.ts

@@ -0,0 +1,199 @@
+export type NamiConfiguration = {
+    'appPlatformID-apple': string;
+    'appPlatformID-android': string;
+    logLevel: string;
+    namiCommands?: string[];
+    namiLanguageCode?: NamiLanguageCodes;
+    initialConfig?: string;
+};
+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';
+export type NamiSKU = {
+    id: string;
+    name?: string;
+    skuId: string;
+    appleProduct?: AppleProduct;
+    googleProduct?: GoogleProduct;
+    amazonProduct?: AmazonProduct;
+    type: NamiSKUType;
+    promoId?: string | null;
+    promoToken?: string | null;
+};
+export declare enum NamiPurchaseState {
+    PENDING = "pending",
+    PURCHASED = "purchased",
+    CONSUMED = "consumed",
+    RESUBSCRIBED = "resubscribed",
+    UNSUBSCRIBED = "unsubscribed",
+    DEFERRED = "deferred",
+    FAILED = "failed",
+    CANCELLED = "cancelled",
+    UNKNOWN = "unknown"
+}
+export declare enum NamiRestorePurchasesState {
+    STARTED = "started",
+    FINISHED = "finished",
+    ERROR = "error"
+}
+export type NamiSKUType = 'unknown' | 'one_time_purchase' | 'subscription';
+export type AppleProduct = {
+    localizedDescription: string;
+    localizedMultipliedPrice: string;
+    localizedPrice: string;
+    localizedTitle: string;
+    price: string;
+    priceCurrency: string;
+    priceLanguage: string;
+};
+export type GoogleProduct = {};
+export type AmazonProduct = {};
+export type NamiCampaign = {
+    id: string;
+    rule: string;
+    segment: string;
+    paywall: string;
+    type: NamiCampaignRuleType;
+    value?: string | null;
+};
+export declare enum NamiCampaignRuleType {
+    DEFAULT = "default",
+    LABEL = "label",
+    UNKNOWN = "unknown",
+    URL = "url"
+}
+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
+}
+export declare enum LaunchCampaignResultAction {
+    FAILURE = "FAILURE",
+    SUCCESS = "SUCCESS"
+}
+export type FailureResultObject = {
+    error: string;
+};
+export type PaywallLaunchContext = {
+    productGroups?: string[];
+    customAttributes: {
+        [key: string]: string;
+    };
+    customObject?: {
+        [key: string]: any;
+    };
+};
+export type CustomerJourneyState = {
+    formerSubscriber: boolean;
+    inGracePeriod: boolean;
+    inTrialPeriod: boolean;
+    inIntroOfferPeriod: boolean;
+    isCancelled: boolean;
+    inPause: boolean;
+    inAccountHold: boolean;
+};
+export type AccountStateAction = 'login' | 'logout' | 'advertising_id_set' | 'vendor_id_set' | 'customer_data_platform_id_set' | 'nami_device_id_set' | 'advertising_id_cleared' | 'vendor_id_cleared' | 'customer_data_platform_id_cleared' | 'nami_device_id_cleared' | 'anonymous_mode_on' | 'anonymous_mode_off';
+export type NamiEntitlement = {
+    activePurchases: NamiPurchase[];
+    desc: string;
+    name: string;
+    namiId: string;
+    purchasedSkus: NamiSKU[];
+    referenceId: string;
+    relatedSkus: NamiSKU[];
+};
+export type NamiPurchaseSuccessApple = {
+    product: NamiSKU;
+    transactionID: string;
+    originalTransactionID: string;
+    price: string;
+    currencyCode: string;
+};
+export type NamiPurchaseSuccessGooglePlay = {
+    product: NamiSKU;
+    orderId: string;
+    purchaseToken: string;
+};
+export type NamiPurchaseSuccessAmazon = {
+    product: NamiSKU;
+    receiptId: string;
+    localizedPrice: string;
+    userId: string;
+    marketplace: string;
+};
+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",
+    DEEPLINK = "DEEPLINK",
+    TOGGLE_CHANGE = "TOGGLE_CHANGE",
+    PAGE_CHANGE = "PAGE_CHANGE",
+    SLIDE_CHANGE = "SLIDE_CHANGE",
+    COLLAPSIBLE_DRAWER_OPEN = "COLLAPSIBLE_DRAWER_OPEN",
+    COLLAPSIBLE_DRAWER_CLOSE = "COLLAPSIBLE_DRAWER_CLOSE",
+    VIDEO_STARTED = "VIDEO_STARTED",
+    VIDEO_PAUSED = "VIDEO_PAUSED",
+    VIDEO_RESUMED = "VIDEO_RESUMED",
+    VIDEO_ENDED = "VIDEO_ENDED",
+    VIDEO_CHANGED = "VIDEO_CHANGED",
+    VIDEO_MUTED = "VIDEO_MUTED",
+    VIDEO_UNMUTED = "VIDEO_UNMUTED",
+    UNKNOWN = "UNKNOWN"
+}
+export type NamiPurchase = {
+    sku?: NamiSKU;
+    skuId: string;
+    transactionIdentifier?: string;
+    expires?: Date;
+    purchaseInitiatedTimestamp: Date;
+    purchaseSource?: 'CAMPAIGN' | 'MARKETPLACE' | 'UNKNOWN';
+};
+export type NamiPurchasesState = 'pending' | 'purchased' | 'consumed' | 'resubscribed' | 'unsubscribed' | 'deferred' | 'failed' | 'cancelled' | 'unknown';
+export type NamiPaywallEvent = {
+    action: NamiPaywallAction;
+    campaignId?: string;
+    campaignName?: string;
+    campaignType?: string;
+    campaignLabel?: string;
+    campaignUrl?: string;
+    paywallId?: string;
+    paywallName?: string;
+    componentChange?: NamiPaywallComponentChange;
+    segmentId?: string;
+    externalSegmentId?: string;
+    deeplinkUrl?: string;
+    sku?: NamiSKU;
+    purchaseError?: string;
+    purchases?: NamiPurchase[];
+    videoMetadata?: NamiPaywallEventVideoMetadata;
+    timeSpentOnPaywall?: number;
+};
+export type NamiPaywallActionHandler = (event: NamiPaywallEvent) => void;
+export type NamiPaywallComponentChange = {
+    id?: string;
+    name?: string;
+};
+export type NamiPaywallEventVideoMetadata = {
+    id?: string;
+    name?: string;
+    url?: string;
+    loopVideo: boolean;
+    muteByDefault: boolean;
+    autoplayVideo: boolean;
+    contentTimecode?: number;
+    contentDuration?: number;
+};

package/src/types.ts

@@ -151,7 +151,7 @@ export type GoogleProduct = {};
 
 export type AmazonProduct = {};
 
-// NameCampaignManager
+// NamiCampaignManager
 export type NamiCampaign = {
   id: string;
   rule: string;
@@ -177,7 +177,7 @@ export enum LaunchCampaignError {
   PAYWALL_COULD_NOT_DISPLAY = 5,
   URL_CAMPAIGN_NOT_FOUND = 6,
   PRODUCT_DATA_NOT_FOUND = 7,
-  PRODUCT_GROUPS_NOT_FOUND = 8
+  PRODUCT_GROUPS_NOT_FOUND = 8,
 }
 
 export enum LaunchCampaignResultAction {
@@ -196,6 +196,10 @@ export type PaywallLaunchContext = {
   customAttributes: {
     [key: string]: string;
   };
+  // Custom object used as data source for advanced paywall components
+  customObject?: {
+    [key: string]: any;
+  };
 };
 
 export type CustomerJourneyState = {
@@ -274,6 +278,15 @@ export enum NamiPaywallAction {
   TOGGLE_CHANGE = 'TOGGLE_CHANGE',
   PAGE_CHANGE = 'PAGE_CHANGE',
   SLIDE_CHANGE = 'SLIDE_CHANGE',
+  COLLAPSIBLE_DRAWER_OPEN = 'COLLAPSIBLE_DRAWER_OPEN',
+  COLLAPSIBLE_DRAWER_CLOSE = 'COLLAPSIBLE_DRAWER_CLOSE',
+  VIDEO_STARTED = 'VIDEO_STARTED',
+  VIDEO_PAUSED = 'VIDEO_PAUSED',
+  VIDEO_RESUMED = 'VIDEO_RESUMED',
+  VIDEO_ENDED = 'VIDEO_ENDED',
+  VIDEO_CHANGED = 'VIDEO_CHANGED',
+  VIDEO_MUTED = 'VIDEO_MUTED',
+  VIDEO_UNMUTED = 'VIDEO_UNMUTED',
   UNKNOWN = 'UNKNOWN',
 }
 
@@ -297,3 +310,41 @@ export type NamiPurchasesState =
   | 'failed'
   | 'cancelled'
   | 'unknown';
+
+export type NamiPaywallEvent = {
+  action: NamiPaywallAction;
+  campaignId?: string;
+  campaignName?: string;
+  campaignType?: string;
+  campaignLabel?: string;
+  campaignUrl?: string;
+  paywallId?: string;
+  paywallName?: string;
+  componentChange?: NamiPaywallComponentChange;
+  segmentId?: string;
+  externalSegmentId?: string;
+  deeplinkUrl?: string;
+  sku?: NamiSKU;
+  purchaseError?: string;
+  purchases?: NamiPurchase[];
+  videoMetadata?: NamiPaywallEventVideoMetadata;
+  timeSpentOnPaywall?: number;
+};
+
+export type NamiPaywallActionHandler = (event: NamiPaywallEvent) => void;
+
+export type NamiPaywallComponentChange = {
+  id?: string;
+  name?: string;
+};
+
+export type NamiPaywallEventVideoMetadata = {
+  id?: string;
+  name?: string;
+  url?: string;
+  loopVideo: boolean;
+  muteByDefault: boolean;
+  autoplayVideo: boolean;
+  contentTimecode?: number;
+  contentDuration?: number;
+};

package/tsconfig.json

@@ -9,10 +9,12 @@
     "declaration": true,                   /* Generates corresponding '.d.ts' file. */
     // "sourceMap": true,                     /* Generates corresponding '.map' file. */
     // "outFile": "./",                       /* Concatenate and emit output to single file. */
+    "declarationDir": "src",                   /* Output directory for generated declaration files. */
      "outDir": "dist",                        /* Redirect output structure to the directory. */
      "rootDir": "src",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
     // "removeComments": true,                /* Do not emit comments to output. */
-    "noEmit": true,                           /* Do not emit outputs. */
+    "emitDeclarationOnly": true,              /* Only output d.ts files and not js files */
+    // "noEmit": true,                           /* Do not emit outputs. */
     // "incremental": true,                   /* Enable incremental compilation */
     // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
     // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
@@ -57,8 +59,7 @@
     // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
   },
   "include": [
-    "./src",
-    ".eslintrc.js"
+    "./src"
   ],
   "exclude": [
     "node_modules",