@namiml/web-sdk 1.3.2 → 1.5.0

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

@@ -1,12 +1,36 @@
 import { NamiPurchaseSource } from "../purchase";
 import { NamiSKU } from "./sku";
+/**
+ * @type NamiPurchase
+ * This object represents a completed purchase in the SDK. A device purchases a NamiSKU and that
+ * purchase makes available a set of NamiEntitlements
+ */
 export type NamiPurchase = {
     sku?: NamiSKU;
+    /**
+     * The store sku reference identifier for this NamiPurchase
+     */
     skuId: string;
+    /**
+     * The purchase order ID record or receipt ID associated to this purchase
+     */
     transactionIdentifier?: string;
+    /**
+     * For bypass store purchases only, indicates when this purchase will cease to back
+     * an entitlement rendering it as inactive.
+     */
     expires?: Date;
+    /**
+     * The source a purchase comes from - either on Google Play (marketplace), through a paywall (campaign).
+     */
     purchaseToken?: string;
+    /**
+     * The date and time when the purchase was initiated
+     */
     purchaseInitiatedTimestamp?: Date;
+    /**
+     * The source a purchase comes from - either on Google Play (marketplace), through a paywall (campaign).
+     */
     purchaseSource?: NamiPurchaseSource;
 };
 export type NamiPurchasesState = 'pending' | 'purchased' | 'consumed' | 'resubscribed' | 'unsubscribed' | 'deferred' | 'failed' | 'cancelled' | 'unknown';

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

@@ -1,6 +1,16 @@
 import { IEntitlements } from "../paywall";
 import { AmazonProduct, AppleProduct, GoogleProduct } from "../sku";
 import { NamiProductDetails } from "./product";
+/**
+ * @type NamiSKU
+ * This object represents a specific in-app purchase SKU available on a specific platform.
+ *
+ * It contains some general meta-data about specific SKU and associated [ProductDetails] object from
+ * Google Play Billing.
+ *
+ * Note that in certain cases, depending on cached state of the SDK, [ProductDetails] might not
+ * be fully complete object (potentially generated temporarily with minimum required information)
+ */
 export type NamiSKU = {
     id: string;
     name?: string;
@@ -14,4 +24,8 @@ export type NamiSKU = {
     productDetails?: NamiProductDetails | null;
     entitlements: IEntitlements[];
 };
+/**
+ * @type NamiSKUType
+ * Types of products from Nami
+ */
 export type NamiSKUType = 'unknown' | 'one_time_purchase' | 'subscription';

package/dist/types/paywall.d.ts

@@ -1,4 +1,4 @@
-import { NamiCampaign } from "src/types/externals/campaign";
+import { NamiCampaign } from "../types/externals/campaign";
 import { TComponent, TContainer } from "./components";
 import { TButtonContainer, TCarouselSlidesState } from "./components/containers";
 import { TSpacerComponent, TTextComponent } from "./components/elements";
@@ -6,8 +6,8 @@ import { TDeviceOrientation } from "./device";
 import { PaywallSKU } from "./sku";
 import { NamiPurchase } from "./externals/purchase";
 import { Optional } from "./utils";
-import { LaunchCampaignError } from "./errors";
-import { NamiPaywallAction, NamiPaywallComponentChange, NamiPaywallLaunchContext } from "./externals/paywall";
+import { LaunchCampaignError } from "./externals/errors";
+import { NamiPaywallAction, NamiPaywallComponentChange, NamiPaywallEventVideoMetadata, NamiPaywallLaunchContext } from "./externals/paywall";
 import { NamiSKU } from "./externals/sku";
 export type TPaywallContext = TInitialState & {
     paywallId: string;
@@ -173,6 +173,7 @@ export declare enum PaywallManagerEvents {
 export type PaywallActionEvent = {
     action: NamiPaywallAction;
     sku?: NamiSKU;
+    videoMetaData: NamiPaywallEventVideoMetadata;
     timeSpentOnPaywall?: number;
     componentChange?: NamiPaywallComponentChange;
     purchaseError?: string;

package/dist/types/profile.d.ts

@@ -2,7 +2,8 @@ export type NamiProfile = {
     externalId: string;
 };
 /**
- * Represents the possible actions that can be performed on the account state.
+ * Represents the possible account actions states that can be returned by callback registered from
+ * [NamiCustomerManager.registerAccountStateHandler]
  */
 export declare enum AccountStateAction {
     LOGIN = "login",

package/dist/utils/config.d.ts

@@ -1,5 +1,6 @@
-import { ExtendedPlatformInfo } from "src/types/config";
+import { ExtendedPlatformInfo } 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;

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, 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, 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, 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, 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, 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, SKU_TEXT_REGEX: RegExp, VAR_REGEX: RegExp, 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, 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, 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;

package/dist/utils/device.d.ts

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

package/dist/utils/fonts.d.ts

@@ -1,4 +1,4 @@
-import { FontDetails } from "src/types/paywall";
+import { FontDetails } from "../types/paywall";
 export declare function prepareAndLoadFonts(fontsObject: {
     [key: string]: any;
 }): Promise<FontFaceSet>;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@namiml/web-sdk",
   "type": "module",
-  "version": "1.3.2",
+  "version": "1.5.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",
+    "test": "yarn clear-test-cache && TZ=UTC jest --coverage -i --forceExit",
     "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",
@@ -71,7 +71,6 @@
     "prettier": "3.2.5",
     "rollup": "^4.18.0",
     "rollup-plugin-dts": "^6.1.1",
-    "rollup-plugin-ts": "^3.4.5",
     "ts-jest": "^29.1.2",
     "ts-node": "^10.9.2",
     "tslib": "^2.6.3",
@@ -82,9 +81,12 @@
   "dependencies": {
     "@lit-labs/ssr-dom-shim": "^1.2.0",
     "bowser": "^2.11.0",
+    "date-fns-tz": "^3.1.3",
+    "hls.js": "^1.5.15",
     "lit": "^3.1.3",
     "lodash-es": "^4.17.21",
-    "marked": "^12.0.2"
+    "marked": "^12.0.2",
+    "swiper": "^11.1.12"
   },
   "homepage": "https://www.namiml.com",
   "bugs": {