@kontextso/sdk-react-native 3.0.7-rc.3 → 4.0.0-rc.0

package/dist/index.d.mts

@@ -1,8 +1,171 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { FormatProps, AdsProviderProps } from '@kontextso/sdk-react';
+import { Message, SDK } from '@kontextso/sdk-common';
 
-declare const InlineAd: ({ code, messageId, wrapper, ...props }: FormatProps) => react_jsx_runtime.JSX.Element;
+type Regulatory = {
+    /** Flag that indicates whether or not the request is subject to GDPR regulations 0 = No, 1 = Yes, omission indicates Unknown */
+    gdpr?: 0 | 1;
+    /** When GDPR regulations are in effect this attribute contains the Transparency and Consent Framework's Consent String data structure */
+    gdprConsent?: string;
+    /** Flag indicating if this request is subject to the COPPA regulations established by the USA FTC, where 0 = no, 1 = yes, omission indicates Unknown */
+    coppa?: 0 | 1;
+    /** Contains the Global Privacy Platform's consent string. See IAB-GPP spec for more details */
+    gpp?: string;
+    /** List of the section(s) of the GPP string which should be applied for this transaction */
+    gppSid?: number[];
+    /** Communicates signals regarding consumer privacy under US privacy regulation under CCPA and LSPA */
+    usPrivacy?: string;
+};
+interface Character {
+    /** Unique ID of the character */
+    id: string;
+    /** Name of the character */
+    name: string;
+    /** URL of the character’s avatar */
+    avatarUrl?: string;
+    /** Greeting of the character */
+    greeting?: string;
+    /** Description of the character’s personality */
+    persona?: string;
+    /** Tags of the character  */
+    tags?: string[];
+    /** Whether the character is NSFW */
+    isNsfw?: boolean;
+    [key: string]: string | string[] | boolean | undefined;
+}
+interface ConfigOptions {
+    /** Your publisher token. This token is not secret and is visible in the browser’s developer console. */
+    publisherToken: string;
+    /** The SDK can be temporarily disabled by setting it to false (no ads will be rendered). */
+    userId: string;
+    /** Unique identifier of the conversation. */
+    conversationId: string;
+    /** Character information. */
+    character?: Character;
+    /** A list of allowed placement codes. */
+    placementCode?: string;
+    /** A variant ID that helps determine which type of ad to render. */
+    variantId?: string;
+    /**  Device-specific identifier provided by the operating systems (IDFA/GAID) */
+    /** Regulatory features. */
+    regulatory?: Regulatory;
+    /** Local and remote logging settings. */
+    logLevel?: 'debug' | 'info' | 'log' | 'warn' | 'error' | 'silent';
+    /** The email of the user. */
+    userEmail?: string;
+    /** We can set a different server URL (usually used for testing).  */
+    adServerUrl?: string;
+}
+declare class Configuration {
+    private config;
+    constructor(config: ConfigOptions);
+    get publisherToken(): string;
+    get userId(): string;
+    get conversationId(): string;
+    get character(): Character | undefined;
+    get placementCode(): string;
+    get variantId(): string | undefined;
+    get regulatory(): Regulatory | undefined;
+    get logLevel(): "info" | "debug" | "log" | "warn" | "error" | "silent";
+    get userEmail(): string | undefined;
+    get adServerUrl(): string;
+}
 
-declare const AdsProvider: (props: AdsProviderProps) => react_jsx_runtime.JSX.Element;
+type LogLevel = 'debug' | 'info' | 'log' | 'warn' | 'error' | 'silent';
+declare class Logger {
+    private localLevel;
+    private remoteLevel;
+    private remoteConfig;
+    private levels;
+    getLocalLevel(): LogLevel;
+    setLocalLevel(level: LogLevel): void;
+    getRemoteLevel(): LogLevel;
+    setRemoteLevel(level: LogLevel): void;
+    configureRemote(url: string, params: Record<string, any>): void;
+    private shouldLog;
+    private logToConsole;
+    private logToRemote;
+    debug(...args: any[]): void;
+    info(...args: any[]): void;
+    log(...args: any[]): void;
+    warn(...args: any[]): void;
+    error(...args: any[]): void;
+}
 
-export { AdsProvider, InlineAd };
+type Bid = {
+    bidId: string;
+    code: string;
+};
+declare class Preload {
+    readonly session: Session;
+    private messages;
+    private abortController;
+    private running;
+    private bid;
+    constructor(session: Session, messages: Message[]);
+    private setMessages;
+    hasBid(): boolean;
+    getBid(): Bid | null;
+    private setBid;
+    cancel(): void;
+    isRunning(): boolean;
+    private getPreloadBody;
+    private canRequestAd;
+    requestAd(): Promise<{
+        status: string;
+        message: string;
+    } | {
+        status: string;
+    }>;
+}
+
+interface SDKConfig {
+    name: Exclude<SDK, 'sdk'>;
+    platform: 'ios' | 'android' | 'web';
+    version: string;
+}
+
+declare class Session {
+    readonly config: Configuration;
+    readonly logger: Logger;
+    readonly sdk: SDKConfig;
+    private sessionId;
+    private sessionDisabled;
+    private messages;
+    private bids;
+    private onUpdateBidsCallback;
+    private preloadInstance;
+    constructor(config: Configuration, { sdk }: {
+        sdk: SDKConfig;
+    });
+    setOnUpdateBids(callback: () => void): void;
+    isSessionDisabled(): boolean;
+    setSessionDisabled(disabled: boolean): void;
+    getSessionId(): string | null;
+    setSessionId(sessionId: string): void;
+    addMessage(message: Message): void;
+    getMessages(): Message[];
+    updateBids(): void;
+    preload(): Preload;
+    getLastBid(): {
+        bidId: string;
+        messageId: string;
+    } | undefined;
+}
+
+interface InlineAdProps {
+    messageId: string;
+    session: Session;
+    onDebugEvent: (name: string, data?: any) => void;
+}
+declare const InlineAd: ({ messageId, session, onDebugEvent }: InlineAdProps) => react_jsx_runtime.JSX.Element | null;
+
+type GlobalConfig = Pick<ConfigOptions, 'publisherToken' | 'userId' | 'userEmail' | 'adServerUrl' | 'logLevel' | 'placementCode'>;
+type SessionConfig = Pick<ConfigOptions, 'conversationId' | 'character' | 'variantId' | 'regulatory'>;
+declare const KontextAds: (config: GlobalConfig) => {
+    createSession: (sessionConfig: SessionConfig) => {
+        addMessage: (message: Message) => void;
+        getInstance: () => Session;
+    };
+};
+
+export { InlineAd, KontextAds };

package/dist/index.d.ts

@@ -1,8 +1,171 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { FormatProps, AdsProviderProps } from '@kontextso/sdk-react';
+import { Message, SDK } from '@kontextso/sdk-common';
 
-declare const InlineAd: ({ code, messageId, wrapper, ...props }: FormatProps) => react_jsx_runtime.JSX.Element;
+type Regulatory = {
+    /** Flag that indicates whether or not the request is subject to GDPR regulations 0 = No, 1 = Yes, omission indicates Unknown */
+    gdpr?: 0 | 1;
+    /** When GDPR regulations are in effect this attribute contains the Transparency and Consent Framework's Consent String data structure */
+    gdprConsent?: string;
+    /** Flag indicating if this request is subject to the COPPA regulations established by the USA FTC, where 0 = no, 1 = yes, omission indicates Unknown */
+    coppa?: 0 | 1;
+    /** Contains the Global Privacy Platform's consent string. See IAB-GPP spec for more details */
+    gpp?: string;
+    /** List of the section(s) of the GPP string which should be applied for this transaction */
+    gppSid?: number[];
+    /** Communicates signals regarding consumer privacy under US privacy regulation under CCPA and LSPA */
+    usPrivacy?: string;
+};
+interface Character {
+    /** Unique ID of the character */
+    id: string;
+    /** Name of the character */
+    name: string;
+    /** URL of the character’s avatar */
+    avatarUrl?: string;
+    /** Greeting of the character */
+    greeting?: string;
+    /** Description of the character’s personality */
+    persona?: string;
+    /** Tags of the character  */
+    tags?: string[];
+    /** Whether the character is NSFW */
+    isNsfw?: boolean;
+    [key: string]: string | string[] | boolean | undefined;
+}
+interface ConfigOptions {
+    /** Your publisher token. This token is not secret and is visible in the browser’s developer console. */
+    publisherToken: string;
+    /** The SDK can be temporarily disabled by setting it to false (no ads will be rendered). */
+    userId: string;
+    /** Unique identifier of the conversation. */
+    conversationId: string;
+    /** Character information. */
+    character?: Character;
+    /** A list of allowed placement codes. */
+    placementCode?: string;
+    /** A variant ID that helps determine which type of ad to render. */
+    variantId?: string;
+    /**  Device-specific identifier provided by the operating systems (IDFA/GAID) */
+    /** Regulatory features. */
+    regulatory?: Regulatory;
+    /** Local and remote logging settings. */
+    logLevel?: 'debug' | 'info' | 'log' | 'warn' | 'error' | 'silent';
+    /** The email of the user. */
+    userEmail?: string;
+    /** We can set a different server URL (usually used for testing).  */
+    adServerUrl?: string;
+}
+declare class Configuration {
+    private config;
+    constructor(config: ConfigOptions);
+    get publisherToken(): string;
+    get userId(): string;
+    get conversationId(): string;
+    get character(): Character | undefined;
+    get placementCode(): string;
+    get variantId(): string | undefined;
+    get regulatory(): Regulatory | undefined;
+    get logLevel(): "info" | "debug" | "log" | "warn" | "error" | "silent";
+    get userEmail(): string | undefined;
+    get adServerUrl(): string;
+}
 
-declare const AdsProvider: (props: AdsProviderProps) => react_jsx_runtime.JSX.Element;
+type LogLevel = 'debug' | 'info' | 'log' | 'warn' | 'error' | 'silent';
+declare class Logger {
+    private localLevel;
+    private remoteLevel;
+    private remoteConfig;
+    private levels;
+    getLocalLevel(): LogLevel;
+    setLocalLevel(level: LogLevel): void;
+    getRemoteLevel(): LogLevel;
+    setRemoteLevel(level: LogLevel): void;
+    configureRemote(url: string, params: Record<string, any>): void;
+    private shouldLog;
+    private logToConsole;
+    private logToRemote;
+    debug(...args: any[]): void;
+    info(...args: any[]): void;
+    log(...args: any[]): void;
+    warn(...args: any[]): void;
+    error(...args: any[]): void;
+}
 
-export { AdsProvider, InlineAd };
+type Bid = {
+    bidId: string;
+    code: string;
+};
+declare class Preload {
+    readonly session: Session;
+    private messages;
+    private abortController;
+    private running;
+    private bid;
+    constructor(session: Session, messages: Message[]);
+    private setMessages;
+    hasBid(): boolean;
+    getBid(): Bid | null;
+    private setBid;
+    cancel(): void;
+    isRunning(): boolean;
+    private getPreloadBody;
+    private canRequestAd;
+    requestAd(): Promise<{
+        status: string;
+        message: string;
+    } | {
+        status: string;
+    }>;
+}
+
+interface SDKConfig {
+    name: Exclude<SDK, 'sdk'>;
+    platform: 'ios' | 'android' | 'web';
+    version: string;
+}
+
+declare class Session {
+    readonly config: Configuration;
+    readonly logger: Logger;
+    readonly sdk: SDKConfig;
+    private sessionId;
+    private sessionDisabled;
+    private messages;
+    private bids;
+    private onUpdateBidsCallback;
+    private preloadInstance;
+    constructor(config: Configuration, { sdk }: {
+        sdk: SDKConfig;
+    });
+    setOnUpdateBids(callback: () => void): void;
+    isSessionDisabled(): boolean;
+    setSessionDisabled(disabled: boolean): void;
+    getSessionId(): string | null;
+    setSessionId(sessionId: string): void;
+    addMessage(message: Message): void;
+    getMessages(): Message[];
+    updateBids(): void;
+    preload(): Preload;
+    getLastBid(): {
+        bidId: string;
+        messageId: string;
+    } | undefined;
+}
+
+interface InlineAdProps {
+    messageId: string;
+    session: Session;
+    onDebugEvent: (name: string, data?: any) => void;
+}
+declare const InlineAd: ({ messageId, session, onDebugEvent }: InlineAdProps) => react_jsx_runtime.JSX.Element | null;
+
+type GlobalConfig = Pick<ConfigOptions, 'publisherToken' | 'userId' | 'userEmail' | 'adServerUrl' | 'logLevel' | 'placementCode'>;
+type SessionConfig = Pick<ConfigOptions, 'conversationId' | 'character' | 'variantId' | 'regulatory'>;
+declare const KontextAds: (config: GlobalConfig) => {
+    createSession: (sessionConfig: SessionConfig) => {
+        addMessage: (message: Message) => void;
+        getInstance: () => Session;
+    };
+};
+
+export { InlineAd, KontextAds };