@jolibox/sdk 1.1.2 → 1.1.4-beta.0

package/dist/index.d.cts

@@ -1,342 +0,0 @@
-import { JoliboxRuntime, JoliboxCloudStorage } from '@jolibox/web-sync-sdk';
-
-declare global {
-    interface Window {
-        JOLIBOX_ENV: "WEB" | "IOS" | "ANDROID" | "WINDOWS" | "MACOS" | "LINUX";
-        JoliboxSDKLoader: typeof JoliboxSDKLoader;
-    }
-}
-interface IVersionMetadata {
-    version: string;
-    syncScriptUrl?: string;
-    asyncScriptUrl?: string;
-}
-interface IJoliboxSDKLoaderConfig {
-    loaderMetadata?: IVersionMetadata;
-}
-declare class JoliboxSDKLoader {
-    loaderMetadata: IVersionMetadata;
-    constructor({ loaderMetadata }?: IJoliboxSDKLoaderConfig);
-    private get currentVersion();
-    private get defaultMetadata();
-    computeLoaderMetaData: () => IVersionMetadata;
-    loadScript: () => void;
-    fetchUpdateLoaderMetadata: (installedSDKVersion?: string, localSDKVersion?: string, env?: "WEB" | "IOS" | "ANDROID" | "WINDOWS" | "MACOS" | "LINUX") => Promise<void>;
-}
-
-declare global {
-    interface Window {
-        JoliboxAds: typeof JoliboxAds;
-    }
-}
-interface IAdsInitParams {
-    /**
-     * (OPTIONAL) Game ID provided by Jolibox
-     */
-    gameId?: string;
-}
-interface IAdConfigParams {
-    /**
-     * (OPTIONAL) Whether ads should always be preloaded before the first call to adBreak()
-     *
-     * The default value of auto leaves the decision up to the Ad Placement API. preloadAdBreaks can be set only once with adConfig(), and further values passed to preloadAdBreaks have no effect.
-     *
-     * Setting preloadAdBreaks after the first call to adBreak() has no effect.
-     */
-    preloadAdBreaks?: "on" | "auto";
-    /**
-     * (OPTIONAL) Whether the game is currently playing sound.
-     *
-     * This call specifies whether your game is capable of sound, and whether the sound was enabled (ie unmuted) before the call to adBreak(). This helps the Ad Placement API to select the right kind of ad for your game.
-     *
-     * Call this function as soon as the sound state of your game changes, as the Ad Placement API may have to request new creatives, and this gives it the maximum amount of time to do so.
-     *
-     * The default value is sound on. So most games will need to make a call to adConfig() when they start to declare that they have sound enabled.
-     */
-    sound?: "on" | "off";
-    /**
-     * (OPTIONAL) Called when the API has initialized and has finished preloading ads (if you requested preloading using the preloadAdBreaks above).
-     * @returns
-     */
-    onReady?: () => void;
-}
-/**
- * PlacementInfo object passed by **adBreakDone** function
- */
-interface IPlacementInfo {
-    /**
-     * the type argument passed to adBreak()
-     */
-    breakType: string;
-    /**
-     * the name argument passed to adBreak()
-     */
-    breakName: string;
-    breakFormat: "interstitial" | "reward";
-    /**
-     * the status of this placement and can be one of the following values:
-     *
-     * | breakStatus | Reason |
-     * | -------- | ------- |
-     * | 'notReady'	| The Ad Placement API had not initialised |
-     * | 'timeout' | A placement timed out because the Ad Placement API took too long to respond |
-     * | 'invalid' | The placement was invalid and was ignored–for instance there should only be one preroll placement per page load, subsequent prerolls are failed with this status |
-     * | 'error' | There was a JavaScript error in a callback |
-     * | 'noAdPreloaded' |	An ad had not been preloaded yet so this placement was skipped |
-     * | 'frequencyCapped' |	An ad wasn't shown because the frequency cap was applied to this placement |
-     * | 'ignored' |	The user didn't click on a reward prompt before they reached the next placement, that is showAdFn() wasn't called before the next adBreak(). |
-     * | 'other' |	The ad was not shown for another reason. (e.g., The ad was still being fetched, or a previously cached ad was disposed because the screen was resized/rotated.) |
-     * | 'dismissed' |	The user dismissed a rewarded ad before viewing it to completion |
-     * | 'viewed' |	The ad was viewed by the user |
-     */
-    breakStatus: "notReady" | "timeout" | "error" | "noAdPreloaded" | "frequencyCapped" | "ignored" | "other" | "dismissed" | "viewed";
-}
-/**
- * Parameter when calling adBreak
- */
-type IAdBreakParams = IPrerollParams | IInterstitialsParams | IRewardParams;
-/**
- * Parameter when calling preroll type adBreak
- */
-interface IPrerollParams {
-    /**
-     * 'preroll' before the game loads (before UI has rendered)
-     */
-    type: "preroll";
-    /**
-     * (OPTIONAL) Always called as the last step in an adBreak(), even if there was no ad shown. Function takes as argument a placementInfo object
-     * @param placementInfo
-     * @returns
-     */
-    adBreakDone?: (placementInfo: IPlacementInfo) => void;
-}
-interface IInterstitialsParams {
-    /**
-     * 'start' before the gameplay starts (after UI has rendered)
-     * 'pause' the player pauses the game
-     * 'next' player navigates to the next level
-     * 'browse' the player explores options outside of the gameplay
-     */
-    type: "start" | "pause" | "next" | "browse";
-    /**
-     * (OPTIONAL) a name for this particular ad placement within your game. It is an internal identifier, and is not shown to the player. In future releases this identifier may be used to enable additional reporting and optimization features.
-     *
-     * We recommend you name all of your placements.
-     */
-    name?: string;
-    /**
-     * (OPTIONAL) Called before the ad is displayed. The game should pause and mute the sound. These actions must be done synchronously. The ad will be displayed immediately after this callback finishes.
-     *
-     * @returns
-     */
-    beforeAd?: () => void;
-    /**
-     * (OPTIONAL) Called after the ad is finished (for any reason). For rewarded ads, it is called after either adDismissed or adViewed, depending on player actions. This function should be used to resume game flow. For example, use to unmute the sound and start the next level.
-     * @returns
-     */
-    afterAd?: () => void;
-    /**
-     * (OPTIONAL) Always called as the last step in an adBreak(), even if there was no ad shown. Function takes as argument a placementInfo object
-     *
-     * @param placementInfo
-     * @returns
-     */
-    adBreakDone?: (placementInfo: IPlacementInfo) => void;
-}
-interface IRewardParams {
-    /**
-     * 'reward' a rewarded ad
-     */
-    type: "reward";
-    /**
-     * (OPTIONAL) a name for this particular ad placement within your game. It is an internal identifier, and is not shown to the player. In future releases this identifier may be used to enable additional reporting and optimization features.
-     *
-     * We recommend you name all of your placements.
-     */
-    name?: string;
-    /**
-     * (OPTIONAL) Called before the ad is displayed. The game should pause and mute the sound. These actions must be done synchronously. The ad will be displayed immediately after this callback finishes.
-     * @returns
-     */
-    beforeAd?: () => void;
-    /**
-     * (OPTIONAL) Called after the ad is finished (for any reason). For rewarded ads, it is called after either adDismissed or adViewed, depending on player actions. This function should be used to resume game flow. For example, use to unmute the sound and start the next level.
-     * @returns
-     */
-    afterAd?: () => void;
-    /**
-     * (OPTIONAL) Always called as the last step in an adBreak(), even if there was no ad shown. Function takes as argument a placementInfo object defined
-     * @param placementInfo
-     * @returns
-     */
-    adBreakDone?: (placementInfo: IPlacementInfo) => void;
-    /**
-     * Called if a rewarded ad is available. The function should take a single argument–showAdFn() which must be called to display the rewarded ad.
-     * @param showAdFn
-     * @returns
-     */
-    beforeReward: (showAdFn: () => void) => void;
-    /**
-     * Called only for rewarded ads when the player dismisses the ad. It is only called if the player dismisses the ad before it completes. In this case the reward should not be granted.
-     * @returns
-     */
-    adDismissed: () => void;
-    /**
-     * Called only for rewarded ads when the player completes the ad and should be granted the reward.
-     * @returns
-     */
-    adViewed: () => void;
-}
-/**
- * Ad unit format, can be 'rectangle', 'vertical', 'horizontal'
- */
-type AdUnitFormat = "rectangle" | "vertical" | "horizontal";
-interface IAdUnitParams {
-    /**
-     * The element to attach the ad unit to, either an HTMLElement or a string selector. Should be the parent element of the ad unit (<ins> tag).
-     */
-    el: HTMLElement | string;
-    /**
-     * (OPTIONAL) Reserved for future usage. The slot ID of the ad unit. Currently the slot ID is automatically set by the SDK.
-     */
-    slot?: string;
-    /**
-     * (OPTIONAL) Ad format for the ad unit. Can be 'auto' or a single format or an array of formats. Default is 'auto'. If passed as an array, the array will be joined by ', ' and pass to the data-ad-format attribute.
-     */
-    adFormat?: "auto" | AdUnitFormat | AdUnitFormat[];
-    /**
-     * (OPTIONAL) Whether the ad unit should be full width and responsive. Default is false.
-     */
-    fullWidthResponsive?: "true" | "false";
-    /**
-     * (OPTIONAL) Custom style for the ad unit. Default is empty.
-     */
-    style?: string;
-}
-/**
- * Jolibox Ads SDK
- */
-declare class JoliboxAds {
-    /**
-     * Internal constructor, should not be called directly
-     */
-    constructor();
-    /**
-     * Init JoliboxAds. Must be called before any other ads functions.
-     * @param config
-     * @returns
-     */
-    init: (config?: IAdsInitParams) => void;
-    /**
-     * The adConfig() call communicates the game's current configuration to the Ad Placement API. The Ad Placement API can use this to tune the way it preloads ads and to filter the kinds of ads it requests so they're suitable (eg. video ads that require sound).
-     * @param params
-     */
-    adConfig: (params: IAdConfigParams) => void;
-    /**
-     * adBreak() is the key function for placing ads within your game. It defines an ad placement and takes an object called a placement config that specifies everything required to show an ad.
-     *
-     * The adBreak() function defines a placement where an ad could be shown. Whether an ad actually shows depends on factors such as the following:
-     *
-     * - The type of ad placement that you declared
-     *   - Is this ad at the start of the game? Between levels? At a moment when the player has paused the game?
-     * - Whether a suitable ad exists for the current player
-     *   - Is this ad relevant to them?
-     *   - Is it consistent with their data privacy and consent settings?
-     * - The number of ads the player has seen recently
-     * - The control settings—for example, ad frequency, you've configured for this game
-     *   - Either as hints in the tag, or,
-     *   - Within AdSense—note that the controls available in AdSense will evolve over time.
-     *
-     * The kind of ad that shows also depends on similar factors.
-     *
-     * Note that a call to adBreak() might not show an ad at all. It simply declares a place where an ad could be shown.
-     *
-     * This is unlike traditional APIs in which your code always knows if an ad is available, and you decide within the game whether to show it. This approach of letting the Ad Placement API decide if an ad shows in a particular placement is a pattern that is sometimes referred to as "inversion of control".
-     *
-     * The reason we're transitioning our games API to this model is firstly, it shortens the code you have to write within your game. Secondly, it makes it easier to deliver policy compliant placements with a great user experience, which in turn has allowed us to deliver some of our highest performing formats to games publishers. Lastly, it more cleanly separates the process of placing ads in your game from the monetization decisions about the type and number of ads to show.
-     *
-     * We want you to be able to change your monetization settings and control the user experience without having to edit and release a new version of your game, initially by specifying hints in the tag. But in future releases, we will be able to provide controls directly in the AdSense and AdMob frontends.
-     * @param params
-     */
-    adBreak: (params: IAdBreakParams) => void;
-    /**
-     * adUnit() is a function that creates an ad unit and attaches it to a parent element. The ad unit is a single ad placement that can be used to show ads.
-     *
-     * Currently we only provide support for creating ad units as `<ins>` tags with the class 'adsbygoogle'. This is the standard way to create ad units with Google AdSense.
-     *
-     * After calling this method, the ad unit is attached to the parent element you specify as el in the params object.
-     *
-     * By default, the client ID and channel ID are automatically set by the SDK. And the slot name is set to the position of the ad unit. You can override these values by passing the slot and channelId in the params object.
-     *
-     * @param params
-     * @returns
-     */
-    adUnit: (params: IAdUnitParams) => Promise<void>;
-}
-
-declare global {
-    interface Window {
-        JoliboxAnalytics: typeof JoliboxAnalytics;
-    }
-}
-/**
- * Jolibox Analytics SDK
- */
-declare class JoliboxAnalytics {
-    constructor();
-    /**
-     * Track an event, will be sent to the analytics server
-     * Currently not open to the public
-     *
-     * @param eventName event name, must be a string
-     * @param extra (OPTIONAL) extra data, must be an object or null or undefined, must not have nested objects
-     */
-    private trackEvent;
-}
-
-declare global {
-    interface IJoliboxSDK extends JoliboxSDK {
-        _commandPipe: ICommandPipe[];
-    }
-    interface Window {
-        __JOLIBOX_LOCAL_SDK_VERSION__: string;
-        joliboxenv?: {
-            joliboxEnv: "staging" | "production";
-            testAdsMode: boolean;
-            apiBaseURL: string;
-        };
-        joliboxsdk: IJoliboxSDK;
-        JoliboxSDK: typeof JoliboxSDK;
-    }
-    interface ImportMeta {
-        env: {
-            JOLIBOX_SDK_VERSION: string;
-        };
-    }
-}
-/**
- * Jolibox SDK Constructor Config
- */
-interface IJoliboxConfig {
-    useRuntimeSDK?: boolean;
-    loaderConfig?: IJoliboxSDKLoaderConfig;
-    joliboxEnv?: "staging" | "production";
-    testAdsMode?: boolean;
-    apiBaseURL?: string;
-}
-interface ICommandPipe {
-    cmd: string;
-    params: any;
-}
-declare class JoliboxSDK {
-    private loader;
-    ads: JoliboxAds;
-    private anaytics;
-    runtime: JoliboxRuntime;
-    storage: JoliboxCloudStorage;
-    private hostToApiMap;
-    private setJoliboxEnv;
-    constructor({ useRuntimeSDK, loaderConfig, joliboxEnv, testAdsMode, apiBaseURL, }?: IJoliboxConfig);
-}
-
-export { type IJoliboxConfig, JoliboxSDK, JoliboxSDK as default };