@namiml/web-sdk 0.0.1-alpha.5

package/README.md

@@ -0,0 +1,52 @@
+# sdk-web
+
+Nami SDK for Web Source
+
+## Build SDK
+
+### Install dependecies
+
+```
+npm install || yarn install
+```
+
+### Build SDK
+
+```
+npm run build-sdk || yarn build-sdk
+```
+
+---
+
+## To enable pre-commit hook
+
+```
+git config core.hooksPath .githooks
+```
+
+## To see the Lit Example:
+
+In one terminal, have microbundle watch your code for changes
+```
+yarn watch-modern-sdk
+```
+
+In another terminal:
+- Go to the `examples/lit` directory
+- Create a `nami-dist` folder (if it doesn't exist)
+- Create a symlink to the built SDK 
+- Start the Web Dev Server
+
+```
+cd examples/lit
+mkdir nami-dist
+ln -s ../../dist/nami.modern.mjs ./nami-dist/nami.modern.mjs
+yarn serve
+``` 
+
+## Demo APPs
+
+- [Vanilla JS](https://github.com/namiml/sdk-web/blob/main/examples/vanilla-js-demo/README.md)
+- [React](https://github.com/namiml/sdk-web/blob/main/examples/react-demo/README.md)
+- [Vue](https://github.com/namiml/sdk-web/blob/main/examples/vue-demo/README.md)
+- [Lit](https://github.com/namiml/sdk-web/blob/main/examples/lit/README.md)

package/dist/components/ContextConsumer.d.ts

@@ -0,0 +1,11 @@
+import { ReactiveController, ReactiveControllerHost } from 'lit';
+import { TPaywallContext } from 'src/types/paywall';
+declare class ContextConsumer implements ReactiveController {
+    host: ReactiveControllerHost;
+    state: TPaywallContext;
+    constructor(host: ReactiveControllerHost);
+    handleStateChange(): void;
+    hostConnected(): void;
+    hostDisconnected(): void;
+}
+export default ContextConsumer;

package/dist/components/ContextProvider.d.ts

@@ -0,0 +1,45 @@
+import { ReactiveController, ReactiveControllerHost } from 'lit';
+import { IPaywall, TPaywallContext } from 'src/types/paywall';
+export declare const initialState: {
+    paywallId: string;
+    livePaywalls: any[];
+    selectedPaywall: any;
+    campaignRules: any[];
+    anySkuHasTrialOffer: boolean;
+    anySkuHasIntroOffer: boolean;
+    anySkuHasPromoOffer: boolean;
+    isLoggedIn: boolean;
+    darkMode: boolean;
+    safeAreaTop: number;
+    groups: any[];
+    selectedProducts: {
+        [currentGroupId: string]: string;
+    };
+    currentPage: string;
+    currentGroupId: string;
+    fullScreenPresentation: boolean;
+    launch: {
+        productGroups: any[];
+        customAttributes: {};
+    };
+    sku: {};
+};
+type Callback = () => void;
+declare class ContextProvider implements ReactiveController {
+    host: ReactiveControllerHost | null;
+    state: TPaywallContext;
+    subscribers: Set<Callback>;
+    constructor();
+    subscribe(callback: Callback): Callback;
+    unsubscribe(callback: Callback): void;
+    private setState;
+    setPaywallState(paywall: IPaywall): void;
+    hostConnected(): void;
+    hostDisconnected(): void;
+    private currentSku;
+    private checkAnySkuHasTrialOffer;
+    private checkAnySkuHasPromoOffer;
+    private filterSkus;
+}
+declare const contextProvider: ContextProvider;
+export default contextProvider;

package/dist/components/NamiElement.d.ts

@@ -0,0 +1,8 @@
+import { CSSResult, LitElement } from "lit";
+import ContextConsumer from "./ContextConsumer";
+export declare class NamiElement extends LitElement {
+    contextConsumer: ContextConsumer;
+    protected styles(): CSSResult;
+    createRenderRoot(): HTMLElement | DocumentFragment;
+    disconnectedCallback(): void;
+}

package/dist/components/Paywall.d.ts

@@ -0,0 +1,11 @@
+import { IPaywall } from 'src/types/paywall';
+import { TDevice } from 'src/types/device';
+import { NamiElement } from './NamiElement';
+import { TemplateResult } from 'lit';
+declare class PaywallComponent extends NamiElement {
+    private formFactor;
+    constructor(paywall: IPaywall, formFactor: TDevice);
+    private getTemplate;
+    render(): TemplateResult;
+}
+export { PaywallComponent };

package/dist/components/TemplateComponent.d.ts

@@ -0,0 +1,3 @@
+import { TComponent } from "src/types/components";
+export declare function registerComponent(name: string, component: any): void;
+export declare function TemplateComponent(component: TComponent): any;

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

@@ -0,0 +1,12 @@
+import { TContainer } from "src/types/components";
+import { NamiElement } from "../NamiElement";
+import { CSSResult } from "lit";
+import { TDevice } from "src/types/device";
+export declare class NamiBackgroundContainer extends NamiElement {
+    component: TContainer;
+    device: TDevice;
+    zIndex: number;
+    fullscreen: boolean;
+    protected styles(): CSSResult;
+    render(): any[];
+}

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

@@ -0,0 +1,10 @@
+import { CSSResult } from 'lit';
+import { TContainer } from 'src/types/components';
+import { NamiElement } from '../NamiElement';
+import { TProductContainer } from 'src/types/components/containers';
+export declare class NamiContainer extends NamiElement {
+    component: TContainer | TProductContainer;
+    constructor(component: TContainer);
+    protected styles(): CSSResult;
+    render(): any[];
+}

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

@@ -0,0 +1,11 @@
+import { CSSResult } from "lit";
+import { NamiElement } from "../NamiElement";
+import { TContainer } from "src/types/components";
+export declare class NamiContentContainer extends NamiElement {
+    component: TContainer;
+    zIndex: number;
+    device: string;
+    inFocusedState: boolean;
+    protected styles(): CSSResult;
+    render(): any[];
+}

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

@@ -0,0 +1,9 @@
+import { CSSResult } from 'lit';
+import { NamiElement } from '../NamiElement';
+import { THeaderFooter } from 'src/types/components/containers';
+export declare class NamiFooter extends NamiElement {
+    components: THeaderFooter;
+    zIndex: string;
+    protected styles(): CSSResult;
+    render(): any[];
+}

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

@@ -0,0 +1,11 @@
+import { CSSResult } from 'lit';
+import { NamiElement } from '../NamiElement';
+import { THeaderFooter } from 'src/types/components/containers';
+export declare class NamiHeader extends NamiElement {
+    components: THeaderFooter;
+    zIndex: string;
+    device: string;
+    inFullScreen: boolean;
+    protected styles(): CSSResult;
+    render(): any[];
+}

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

@@ -0,0 +1,9 @@
+import { CSSResult } from 'lit';
+import { NamiElement } from '../NamiElement';
+import { TProductContainer } from 'src/types/components/containers';
+export declare class NamiProductContainer extends NamiElement {
+    component: TProductContainer;
+    constructor(component: TProductContainer);
+    protected styles(): CSSResult;
+    render(): any[];
+}

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

@@ -0,0 +1,9 @@
+import { CSSResult } from 'lit';
+import { TButtonContainer } from 'src/types/components/containers';
+import { NamiElement } from '../NamiElement';
+export declare class NamiButton extends NamiElement {
+    component: TButtonContainer;
+    constructor(component: TButtonContainer);
+    protected styles(): CSSResult;
+    render(): any[];
+}

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

@@ -0,0 +1,9 @@
+import { TImageComponent } from "src/types/components/elements";
+import { NamiElement } from "../NamiElement";
+import { CSSResult, TemplateResult } from "lit";
+export declare class NamiImage extends NamiElement {
+    component: TImageComponent;
+    constructor(component: TImageComponent);
+    protected styles(): CSSResult;
+    protected render(): TemplateResult;
+}

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

@@ -0,0 +1,9 @@
+import { CSSResult, TemplateResult } from 'lit';
+import { NamiElement } from '../NamiElement';
+import { TSpacerComponent } from 'src/types/components/elements';
+export declare class NamiSpacer extends NamiElement {
+    component: TSpacerComponent;
+    constructor(component: TSpacerComponent);
+    protected styles(): CSSResult;
+    render(): TemplateResult;
+}

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

@@ -0,0 +1,27 @@
+import { TemplateResult, CSSResult } from 'lit';
+import { TTextComponent, TTextLikeComponent, TTextListComponent } from 'src/types/components/elements';
+import { NamiElement } from '../NamiElement';
+export declare class NamiText extends NamiElement {
+    component: TTextComponent;
+    constructor(component: TTextComponent);
+    protected styles(): CSSResult;
+    render(): TemplateResult;
+}
+export declare class TextListItemWrapper extends NamiElement {
+    component: TTextListComponent;
+    constructor(component: TTextListComponent);
+    protected styles(): CSSResult;
+    render(): TemplateResult;
+}
+export declare class NamiSymbol extends NamiElement {
+    component: TTextLikeComponent;
+    constructor(component: TTextLikeComponent);
+    protected styles(): CSSResult;
+    render(): TemplateResult;
+}
+export declare class NamiTextList extends NamiElement {
+    component: TTextListComponent;
+    constructor(component: TTextListComponent);
+    protected styles(): CSSResult;
+    render(): TemplateResult;
+}

package/dist/components/index.d.ts

@@ -0,0 +1,25 @@
+import { NamiSpacer } from "./elements/Spacer";
+import { NamiButton } from "./elements/Button";
+import { NamiHeader } from "./containers/Header";
+import { NamiFooter } from "./containers/Footer";
+import { NamiText } from "./elements/Text";
+import { NamiContainer } from "./containers/Container";
+import { NamiProductContainer } from "./containers/ProductContainer";
+import { NamiImage } from "./elements/Image";
+import { NamiBackgroundContainer } from "./containers/BackgroundContainer";
+import { NamiContentContainer } from "./containers/Content";
+declare global {
+    interface HTMLElementTagNameMap {
+        "nami-spacer": NamiSpacer;
+        "nami-button": NamiButton;
+        "nami-text": NamiText;
+        "nami-header": NamiHeader;
+        "nami-footer": NamiFooter;
+        "nami-container": NamiContainer;
+        "nami-product-container": NamiProductContainer;
+        "nami-image": NamiImage;
+        "nami-background-container": NamiBackgroundContainer;
+        "nami-content-container": NamiContentContainer;
+    }
+}
+export { NamiSpacer, NamiButton, NamiHeader, NamiFooter, NamiText, NamiContainer, NamiProductContainer, NamiImage, NamiBackgroundContainer, NamiContentContainer, };

package/dist/components/productDetails.d.ts

@@ -0,0 +1 @@
+export declare const getProductDetail: (skuName: string, variableName: string) => unknown;

package/dist/components/styles/reset.d.ts

@@ -0,0 +1,2 @@
+import { CSSResult } from "lit";
+export declare const cssReset: CSSResult;

package/dist/components/utils.d.ts

@@ -0,0 +1,46 @@
+import { TBaseComponent, TComponent, TContainerPosition, TTestObject } from "src/types/components";
+import { TButtonContainer, TProductContainer } from "src/types/components/containers";
+import { TConditionalComponent, TTextLikeComponent } from "src/types/components/elements";
+import { SelectableItemType, TPaywallMedia } from "src/types/paywall";
+export declare function parseSize(value: string | number): string;
+export declare function backgroundColor(value: string): string;
+export declare function pickAndApplyBackgroundColor(component: TBaseComponent, inFocusedState?: boolean): string;
+export declare function flexDirection({ direction }: TBaseComponent): string;
+export declare function applyTextOverflow(component: TTextLikeComponent): string;
+export declare function transition(): string;
+export declare function grow({ grow }: TBaseComponent): string;
+export declare function paddingAndMargin(component: TBaseComponent): string;
+export declare function transform({ moveX, moveY, }: TBaseComponent): string;
+export declare function borders(component: TBaseComponent, inFocusedState?: boolean): string;
+export declare function alignItems({ alignment, }: TBaseComponent): string;
+export declare function justifyContent({ alignment, }: TBaseComponent): string;
+export declare function widthAndHeight(component: TBaseComponent): string;
+export declare function zIndex({ zIndex }: TBaseComponent): string;
+export declare function dropShadow(component: TBaseComponent): string;
+export declare function textStrikethrough(value: boolean | undefined): string;
+export declare function font({ fontName }: TTextLikeComponent): string;
+export declare function applyStyles(component: TBaseComponent, inFocusedState?: boolean): string;
+type ReplacementsType = {
+    [type: string]: any extends Array<any> ? never : any;
+};
+type TMediaVarOptions = {
+    convertToUrl?: boolean;
+};
+export declare function getInterpolatedButtonComponents(component: TButtonContainer): TComponent[];
+export declare function getAttr(object: any, ...attrs: Array<string | number>): any;
+export declare function interpolateString(value: string, replacements: ReplacementsType): any;
+export declare function interpolate<T>(value: T, replacements: ReplacementsType): T;
+export declare function buildMediaVariables(mediaList: {
+    [mediaName: string]: Pick<TPaywallMedia, 'content'>;
+}, { convertToUrl }?: TMediaVarOptions): {
+    [mediaName: string]: string | Blob | null;
+};
+export declare function getSkuButtonComponents(items: SelectableItemType[], component: TProductContainer, mediaList?: {
+    [mediaName: string]: Pick<TPaywallMedia, 'content'>;
+}, additionalVariableStates?: object): [boolean, TComponent[]][];
+export declare function parsePosition(position?: TContainerPosition): string;
+export declare function conditionComponentMatches(condition: TConditionalComponent): boolean;
+export declare function testObjectMatches({ value, expected, operator, }: TTestObject): boolean;
+export declare function valueFromSmartText<T>(value: T): T;
+export declare function withOverrides<T extends TBaseComponent>({ conditionAttributes, ...component }: T): T;
+export {};

package/dist/core/api.d.ts

@@ -0,0 +1,12 @@
+interface ApiServiceOptions {
+    baseURL?: string;
+    platformID: string;
+}
+export declare class ApiService {
+    private baseURL;
+    private platformID;
+    constructor(options: ApiServiceOptions);
+    fetchAPI<T>(path: string): Promise<T>;
+    requestBodyAPI<T, U>(path: string, bodyData: T, method?: string): Promise<U>;
+}
+export {};

package/dist/core/errors.d.ts

@@ -0,0 +1,19 @@
+export declare class RetryLimitExceededError extends Error {
+    statusCode: number;
+    status: number;
+    constructor(statusCode: number, message: string);
+}
+export declare class BadRequestError extends Error {
+    constructor(message: string);
+}
+export declare class NotFoundError extends Error {
+    constructor(message: string);
+}
+export declare class ClientError extends Error {
+    statusCode: number;
+    constructor(statusCode: number, message: string);
+}
+export declare class InternalServerError extends Error {
+    constructor(message: string);
+}
+export declare const handleErrors: (status: number, path: string) => void;

package/dist/core/withRetry.d.ts

@@ -0,0 +1 @@
+export declare function withRetry<T>(url: string, options?: RequestInit, retries?: number): Promise<T>;

package/dist/decorators/index.d.ts

@@ -0,0 +1,2 @@
+export declare function requirePlatformID(target: any, propertyKey: string, descriptor: PropertyDescriptor): PropertyDescriptor;
+export declare function requireDeviceID(target: any, propertyKey: string, descriptor: PropertyDescriptor): PropertyDescriptor;

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+export { Nami } from "./nami";
+export { NamiCampaignManager } from "./nami/campaign";
+export { NamiCustomerManager } from "./nami/customer";
+export { NamiPaywallManager } from "./nami/paywalls";
+export { NamiConfiguration } from "./types/config";
+export { NamiLanguageCode } from "./types/languages";
+export { CampaignRule as NamiCampaign } from "./types/campaign";
+import "./components";

package/dist/nami/api.d.ts

@@ -0,0 +1,14 @@
+import { NamiConfiguration } from "src/types/config";
+import { LoginResponse } from "src/types/api";
+export declare class NamiAPI {
+    static instance: NamiAPI;
+    private baseURL;
+    private platformID;
+    private get deviceID();
+    static configure(config: NamiConfiguration): void;
+    private configure;
+    login(externalId: string): Promise<LoginResponse>;
+    logout(): Promise<Record<string, never>>;
+    private fetchAPI;
+    private requestBodyAPI;
+}

package/dist/nami/campaign.d.ts

@@ -0,0 +1,19 @@
+/// <reference types="node" />
+import { AvailableCampaignsResponseHandler, CampaignRule } from "src/types/campaign";
+import { EventEmitter } from "events";
+import { CampaignRuleRepository } from "src/repositories/campaignRule.repository";
+import { PaywallRepository } from "src/repositories/paywall.repository";
+import { PaywallComponent } from "src/components/Paywall";
+export declare class NamiCampaignManager {
+    static instance: NamiCampaignManager;
+    emitter: EventEmitter<[never]>;
+    private sdkInitialized;
+    private campaignRuleRepository;
+    private paywallRepository;
+    _init(campaignRepo: CampaignRuleRepository, paywallRepo: PaywallRepository, sdkInitialized?: boolean): void;
+    static allCampaigns(): CampaignRule[];
+    static isCampaignAvailable(type: string, value: string): boolean;
+    static refresh(refreshCallback: (campaign?: CampaignRule[]) => void): Promise<void>;
+    static registerAvailableCampaignsHandler(handler: AvailableCampaignsResponseHandler): void;
+    static launch(type: string, value?: string): PaywallComponent;
+}

package/dist/nami/customer.d.ts

@@ -0,0 +1,96 @@
+type AccountStateHandler = (action: AccountStateAction, success: boolean, error?: Error) => void;
+type Callback = () => void;
+/**
+ * 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"
+}
+/**
+ * NamiCustomerManager provides methods for managing customer-related functionality.
+ */
+export declare class NamiCustomerManager {
+    static instance: NamiCustomerManager;
+    private emitter;
+    /**
+     * Checks if the customer is logged in.
+     *
+     * @returns {boolean} Returns true if the customer is logged in, false otherwise.
+     */
+    static isLoggedIn(): boolean;
+    /**
+     * Returns the external ID of the currently logged in user.
+     *
+     * @returns The external ID of the logged in user.
+    */
+    static loggedInId(): string | undefined;
+    /**
+     * Logs in a customer with the specified ID.
+     *
+     * @param id - The ID of the customer to log in. Must be a SHA256 hash or UUID.
+     * @returns A Promise that resolves when the login is successful.
+    */
+    static login(externalId: string): Promise<void>;
+    static logout(): Promise<void>;
+    static setCustomerDataPlatformId(id: string): Promise<void>;
+    static clearCustomerDataPlatformId(): Promise<void>;
+    /**
+     * Registers a callback function to handle changes in the account state.
+     *
+     * @param callback - The callback function to be registered.
+     * @returns A function that can be used to unregister the original callback.
+     */
+    static registerAccountStateHandler(callback: AccountStateHandler): Callback;
+    /**
+     * Sets the anonymous mode for the customer.
+     *
+     * @param enabled - A boolean value indicating whether the anonymous mode should be enabled or disabled.
+     * @returns A Promise that resolves when the anonymous mode is set.
+     */
+    static setAnonymousMode(enabled: boolean): void;
+    /**
+     * Sets an optional customer attributes that can be used to personalize your Nami paywalls.
+     *
+     * @param key - The name of the attribute. For example: `firstName`.
+     * @param value - The value of the customer attribute. For example: `Joe`.
+     */
+    static setCustomerAttribute(key: string, value: string): void;
+    /**
+     * Retrieves the value for a given key in the on-device customer attribute key/value store.
+     *
+     * @param key - The name of the attribute. For example: `firstName`
+     * @returns The value of the customer attribute.
+     */
+    static getCustomerAttribute(key: string): string;
+    /**
+     * Clears a value of the given key in the on-device key/value store.
+     *
+     * @param key - The key of the customer attribute to clear.
+     */
+    static clearCustomerAttribute(key: string): void;
+    /**
+     * Clear all customer attributes from the on-device key/value store.
+     *
+     */
+    static clearAllCustomerAttributes(): void;
+    /**
+     * Private Static Methods
+     */
+    private static invokeStateHandler;
+    /**
+     * Private Instance Methods
+     */
+    private get isSDKInitialized();
+}
+export {};

package/dist/nami/index.d.ts

@@ -0,0 +1,8 @@
+import { NamiConfiguration, NamiConfigurationState } from "src/types/config";
+export declare class Nami {
+    #private;
+    static instance: Nami;
+    get isInitialized(): boolean;
+    static configure(options: NamiConfiguration, requestCallback?: (result: NamiConfigurationState) => void): Promise<void>;
+    private initializeSDK;
+}

package/dist/nami/namiRefs.d.ts

@@ -0,0 +1,7 @@
+import { NamiConfiguration } from "src/types/config";
+export declare class NamiRefs {
+    static instance: NamiRefs;
+    init(config: NamiConfiguration): Promise<void>;
+    private storeInitialValues;
+    private initAndFetchRequiredData;
+}

package/dist/nami/paywalls.d.ts

@@ -0,0 +1,14 @@
+import { IPaywall } from "src/types/paywall";
+export declare class NamiPaywallManager {
+    static instance: NamiPaywallManager;
+    private sdkInitialized;
+    _init(sdkInitialized?: boolean): void;
+    static allPaywalls(): IPaywall[];
+    static setProductDetails(): void;
+    static registerSignInHandler(): void;
+    static registerCloseHandler(): void;
+    static registerDeeplinkActionHandler(): void;
+    static registerBuySkuHandler(): void;
+    static buySkuComplete(): void;
+    static buySkuCancel(): void;
+}

package/dist/nami/profile.d.ts

@@ -0,0 +1,12 @@
+export declare class NamiProfileManager {
+    static instance: NamiProfileManager;
+    private externalId?;
+    constructor();
+    setExternalId(externalId: string | undefined): NamiProfileManager;
+    getExternalId(): string | undefined;
+    isLoggedIn(): boolean;
+    private save;
+    private load;
+    login(externalId: string): Promise<void>;
+    logout(): Promise<void>;
+}