@jolibox/types 1.1.27 → 1.1.29-beta.1

package/dist/commands/api.d.ts

@@ -3,6 +3,10 @@ import { StandardResponse } from './response';
 export declare const API_GET_SYSTEM_INFO = "API.getSystemInfo";
 export declare const API_GET_SYSTEM_INFO_SYNC = "API.getSystemInfoSync";
 export declare const API_ENV = "API.env";
+/**
+ * @public
+ * Describes the system information of the device and application environment.
+ */
 export interface ISystemInfo {
     system: string;
     platform: 'h5' | 'android' | 'ios';

package/dist/env.d.ts

@@ -1,3 +1,8 @@
+/**
+ * @public
+ * Defines the structure of the environment information provided by the Jolibox SDK.
+ * This includes details about the device, host application, SDK versions, and user information.
+ */
 export interface Env {
     deviceInfo: {
         brand: string;

package/dist/events/index.d.ts

@@ -1,5 +1,11 @@
 import { LifeCycleEventParams } from './lifecycle';
 import { RumtimeEventParams } from './runtime';
 export * from './lifecycle';
+export * from './runtime';
+/**
+ * @public
+ * A map defining the parameters for various host events.
+ * It combines event parameters from different modules.
+ */
 export type HostEventParamsMap = LifeCycleEventParams & RumtimeEventParams;
 export type HostEventType = keyof HostEventParamsMap;

package/dist/index.d.ts

@@ -4,6 +4,7 @@ export * from './sdks/storage';
 export * from './sdks/task-tracker';
 export * from './sdks/native/keyboard';
 export * from './sdks/router';
+export * from './sdks/ads';
 export * from './events';
 export * from './commands';
 export * from './common';

package/dist/sdks/ads.d.ts

@@ -1,9 +1,17 @@
+/**
+ * @public
+ * Initialization parameters for the Ads SDK.
+ */
 export interface IAdsInitParams {
     /**
      * (OPTIONAL) Game ID provided by Jolibox
      */
     gameId?: string;
 }
+/**
+ * @public
+ * Configuration parameters for ads, used with `adConfig`.
+ */
 export interface IAdConfigParams {
     /**
      * (OPTIONAL) Whether ads should always be preloaded before the first call to adBreak()
@@ -30,7 +38,9 @@ export interface IAdConfigParams {
     onReady?: () => void;
 }
 /**
- * PlacementInfo object passed by **adBreakDone** function
+ * @public
+ * PlacementInfo object passed by the **adBreakDone** function.
+ * Contains details about an ad placement after an ad break attempt.
  */
 export interface IPlacementInfo {
     /**
@@ -61,11 +71,18 @@ export interface IPlacementInfo {
     breakStatus: 'notReady' | 'timeout' | 'error' | 'noAdPreloaded' | 'frequencyCapped' | 'ignored' | 'other' | 'dismissed' | 'viewed';
 }
 /**
- * Parameter when calling adBreak
+ * @public
+ * Represents the different sets of parameters that can be passed when calling `adBreak`.
+ * It's a union of parameters for preroll, interstitial, and rewarded ads.
+ * @see {@link IPrerollParams}
+ * @see {@link IInterstitialsParams}
+ * @see {@link IRewardParams}
  */
 export type IAdBreakParams = IPrerollParams | IInterstitialsParams | IRewardParams;
 /**
- * Parameter when calling preroll type adBreak
+ * @public
+ * Parameters for a 'preroll' type `adBreak`.
+ * Preroll ads are typically shown before the game loads.
  */
 export interface IPrerollParams {
     /**
@@ -79,6 +96,11 @@ export interface IPrerollParams {
      */
     adBreakDone?: (placementInfo: IPlacementInfo) => void;
 }
+/**
+ * @public
+ * Parameters for interstitial `adBreak` types (e.g., 'start', 'pause', 'next', 'browse').
+ * Interstitial ads are full-screen ads shown at natural transition points.
+ */
 export interface IInterstitialsParams {
     /**
      * 'start' before the gameplay starts (after UI has rendered)
@@ -112,6 +134,11 @@ export interface IInterstitialsParams {
      */
     adBreakDone?: (placementInfo: IPlacementInfo) => void;
 }
+/**
+ * @public
+ * Parameters for a 'reward' type `adBreak`.
+ * Rewarded ads offer users an in-game reward for watching an ad.
+ */
 export interface IRewardParams {
     /**
      * 'reward' a rewarded ad
@@ -157,9 +184,14 @@ export interface IRewardParams {
     adViewed: () => void;
 }
 /**
- * Ad unit format, can be 'rectangle', 'vertical', 'horizontal'
+ * @public
+ * Defines the possible formats for an ad unit.
  */
 export type AdUnitFormat = 'rectangle' | 'vertical' | 'horizontal';
+/**
+ * @public
+ * Parameters for creating and configuring an ad unit with `adUnit`.
+ */
 export 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).
@@ -183,7 +215,9 @@ export interface IAdUnitParams {
     style?: string;
 }
 /**
- * Jolibox Ads SDK
+ * @public
+ * Jolibox Ads SDK interface defining available ad operations.
+ * This interface is typically implemented by the Ads SDK module.
  */
 export interface JoliboxAds {
     /**
@@ -200,7 +234,7 @@ export interface JoliboxAds {
     /**
      * 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:
+     * This function determines if an ad should be shown based on various factors including:
      *
      * - 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?
@@ -231,8 +265,7 @@ export interface JoliboxAds {
      *
      * 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.
-     *
+     * By default, a 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
      */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@jolibox/types",
   "description": "This project is common types used for JS-SDk interfere & implement",
-  "version": "1.1.27",
+  "version": "1.1.29-beta.1",
   "typings": "dist/index.d.ts",
   "license": "MIT",
   "files": [
@@ -13,6 +13,12 @@
     "@jolibox/eslint-config": "1.0.0",
     "rimraf": "6.0.1"
   },
+  "typedocOptions": {
+    "entryPoints": [
+      "src/index.ts"
+    ],
+    "name": "Jolibox Types"
+  },
   "scripts": {
     "clean": "rimraf ./dist",
     "build": "npm run clean && tsc",