@jolibox/sdk 1.1.27 → 1.1.28

package/dist/index.js

@@ -1268,18 +1268,21 @@ function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r
   var onCustomEvent = (event, callback) => {
     if (!supportedEvents.includes(event)) {
       reportError(new ce(`[onCustomEvent] Unsupported event: ${event}`, 2e3));
+      return;
     }
     Mt.on(event, callback);
   };
   var offCustomEvent = (event, callback) => {
     if (!supportedEvents.includes(event)) {
       reportError(new ce(`[offCustomEvent] Unsupported event: ${event}`, 2e3));
+      return;
     }
     Mt.off(event, callback);
   };
   var onceCustomEvent = (event, callback) => {
     if (!supportedEvents.includes(event)) {
       reportError(new ce(`[onceCustomEvent] Unsupported event: ${event}`, 2e3));
+      return;
     }
     Mt.once(event, callback);
   };
@@ -1312,7 +1315,15 @@ function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r
   // src/sdks/sdk.ts
   var BaseSDK = class {
     constructor() {
+      /**
+       * @private
+       * Instance for executing commands. Intended for internal SDK use.
+       */
       this.commands = cr();
+      /**
+       * @private
+       * Event emitter instance for handling internal events. Intended for internal SDK use.
+       */
       this._emitter = new I();
     }
     addEventListener(event, callback) {
@@ -1342,6 +1353,13 @@ function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r
     constructor() {
       super();
     }
+    /**
+     * @public
+     * Registers a callback to be invoked when the Jolibox environment is ready.
+     * This typically signifies that the main application or game can start its operations.
+     * @param callback - A function to call when the environment is ready. It may receive host user information as a parameter.
+     * @event LifecycleSDK.onReady Dispatched after the provided callback is executed, with host user info.
+     */
     onReady(callback) {
       const wrappedOnReady = info => {
         callback.call(this, info);
@@ -1349,6 +1367,15 @@ function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r
       };
       this.commands.executeCommand("LifecycleSDK.onReady", wrappedOnReady.bind(this));
     }
+    /**
+     * @private
+     * Initiates the process to exit the Jolibox application or game.
+     * Allows registering a callback to be executed before the exit occurs.
+     * @param params - An object containing:
+     *   - `onBeforeExit`: A function to call before the application exits.
+     *   - `shouldStay` (optional): A boolean indicating if the application should attempt to prevent the exit. The exact behavior may depend on the host environment.
+     * @returns {object | undefined} An error object if the 'lifeCycle.exit' capability is not available, otherwise undefined.
+     */
     exit(params) {
       const errMsg = this.canIUseIfThrow("lifeCycle.exit");
       if (errMsg) {
@@ -1356,20 +1383,44 @@ function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r
       }
       this.commands.executeCommand("LifecycleSDK.exit", params.onBeforeExit, params.shouldStay);
     }
-    onJoliboxHide(params) {
-      this.commands.executeCommand("LifecycleSDK.onJoliboxHide", params.bind(this));
+    /**
+     * @public
+     * Registers a callback to be invoked when the Jolibox application is hidden (e.g., moved to the background).
+     * @param callback - A function to call when the application is hidden.
+     */
+    onJoliboxHide(callback) {
+      this.commands.executeCommand("LifecycleSDK.onJoliboxHide", callback.bind(this));
     }
-    onJoliboxShow(params) {
-      this.commands.executeCommand("LifecycleSDK.onJoliboxShow", params.bind(this));
+    /**
+     * @public
+     * Registers a callback to be invoked when the Jolibox application is shown (e.g., brought to the foreground).
+     * @param callback - A function to call when the application is shown.
+     */
+    onJoliboxShow(callback) {
+      this.commands.executeCommand("LifecycleSDK.onJoliboxShow", callback.bind(this));
     }
   };
 
   // src/sdks/storage.ts
   var StorageSDK = class extends BaseSDK {
+    /**
+     * @public
+     * Retrieves an item from storage based on its key.
+     * @param key - The key of the item to retrieve.
+     * @returns A promise that resolves with the value of the item, or null if the key is not found. The specific structure of the resolved value (e.g., if wrapped in StandardResponse) depends on the command execution result.
+     */
     async getItem(key) {
       const result = await this.commands.executeCommand("StorageSDK.getItem", key);
       return result;
     }
+    /**
+     * @public
+     * Sets an item in storage with a given key and value.
+     * There are limitations on the length of the key and the combined length of key and value.
+     * @param key - The key for the item. Should be less than 128 characters.
+     * @param value - The value to store. Can be a number, string, or boolean. It will be converted to a string for storage.
+     * @returns A promise that resolves with a StandardResponse. It might contain an error object if validation fails (e.g., key/value length exceeded).
+     */
     async setItem(key, value) {
       if (key.length > 128) {
         return {
@@ -1384,11 +1435,22 @@ function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r
           message: "[SDK] cloud storage setItem error: length of key and value should be less than 1024"
         };
       }
-      return await this.commands.executeCommand("StorageSDK.setItem", key, value);
+      return await this.commands.executeCommand("StorageSDK.setItem", key, valueToStore);
     }
+    /**
+     * @public
+     * Removes an item from storage based on its key.
+     * @param key - The key of the item to remove.
+     * @returns A promise that resolves with a StandardResponse (or the direct result of command execution).
+     */
     async removeItem(key) {
       return this.commands.executeCommand("StorageSDK.removeItem", key);
     }
+    /**
+     * @public
+     * Clears all items from the storage.
+     * @returns A promise that resolves with a StandardResponse (or the direct result of command execution).
+     */
     async clear() {
       return this.commands.executeCommand("StorageSDK.clear");
     }
@@ -1411,12 +1473,18 @@ function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r
         this.commands.executeCommand("AdsSDK.adUnit", params);
       };
     }
+    /**
+     * Initializes a new ad unit.
+     * @param unitId - The ID of the ad unit.
+     * @returns A promise that resolves when the ad is loaded.
+     */
+    async initAd(unitId) {}
   };
 
   // src/sdks/keyboard.ts
   var KeyboardSDK = class extends BaseSDK {
     /**
-     * 显示键盘
+     * Show the keyboard
      * @param params
      * @returns
      */
@@ -1428,7 +1496,7 @@ function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r
       this.commands.executeCommand("KeyboardSDK.showKeyboard", params);
     }
     /**
-     * 更新键盘
+     * Update the keyboard
      * @param value
      * @returns
      */
@@ -1442,7 +1510,7 @@ function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r
       });
     }
     /**
-     * 隐藏键盘
+     * Hide the keyboard
      * @returns
      */
     hideKeyboard() {
@@ -1557,6 +1625,13 @@ function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r
   // src/sdks/router.ts
   var NavigateToNativePageTypeTypes = ["openHistory"];
   var RouterSDK = class extends BaseSDK {
+    /**
+     * @public
+     * Opens a given schema URL.
+     * This is often used for deep linking or triggering specific actions within the host application or other apps.
+     * @param schema - The schema URL string to open (e.g., 'yourapp://action?param=value').
+     * @returns A promise that resolves with a StandardResponse, or an error object if the capability is not available.
+     */
     async openSchema(schema) {
       const errMsg = this.canIUseIfThrow("router.openSchema");
       if (errMsg) {
@@ -1564,6 +1639,12 @@ function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r
       }
       return await this.commands.executeCommand("RouterSDK.openSchema", schema);
     }
+    /**
+     * @public
+     * Opens a web page in a new view (e.g., an in-app browser or a new tab).
+     * @param url - The URL of the web page to open.
+     * @returns A promise that resolves with a StandardResponse containing the webviewId, or an error object if the capability is not available.
+     */
     async openPage(url) {
       const errMsg = this.canIUseIfThrow("router.openPage");
       if (errMsg) {
@@ -1571,6 +1652,12 @@ function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r
       }
       return await this.commands.executeCommand("RouterSDK.openPage", url);
     }
+    /**
+     * @public
+     * Closes a previously opened web page/view, identified by its webviewId.
+     * @param webviewId - The ID of the webview to close.
+     * @returns A promise that resolves with a StandardResponse, or an error object if the capability is not available.
+     */
     async closePage(webviewId) {
       const errMsg = this.canIUseIfThrow("router.closePage");
       if (errMsg) {
@@ -1578,6 +1665,12 @@ function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r
       }
       return await this.commands.executeCommand("RouterSDK.closePage", webviewId);
     }
+    /**
+     * @public
+     * Intercepts the system's back button or exit gesture.
+     * @param intercept - A boolean indicating whether to intercept the exit (true) or allow default behavior (false).
+     * @returns A promise that resolves with a StandardResponse, or an error object if the capability is not available.
+     */
     async interceptSystemExit(intercept) {
       const errMsg = this.canIUseIfThrow("router.interceptSystemExit");
       if (errMsg) {
@@ -1585,6 +1678,13 @@ function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r
       }
       return await this.commands.executeCommand("RouterSDK.interceptSystemExit", intercept);
     }
+    /**
+     * @public
+     * Navigates to a specific native page within the host application.
+     * @param path - The identifier for the native page to navigate to. Currently, only 'openHistory' is explicitly supported by this client-side check.
+     * @param params - A record of parameters to pass to the native page.
+     * @returns A promise that resolves with a StandardResponse, or an error object if the capability is not available or the path is invalid.
+     */
     async navigateToNativePage(path, params) {
       const errMsg = this.canIUseIfThrow("router.navigateToNativePage");
       if (errMsg) {
@@ -1602,23 +1702,134 @@ function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r
 
   // src/index.ts
   var JoliboxSDK = (_JoliboxSDK2 = class _JoliboxSDK {
+    /**
+     * @public
+     * Constructs a new JoliboxSDK instance or returns the existing singleton instance.
+     */
     constructor() {
+      /**
+       * @public
+       * @readonly
+       * The current version of the Jolibox JSSDK.
+       */
       this.jssdkVersion = "__JOLIBOX_LOCAL_SDK_VERSION__";
+      /**
+       * @public
+       * @readonly
+       * Access to the Runtime SDK module.
+       * @see {@link RuntimeSDK} for more details.
+       * @type {RuntimeSDK}
+       */
       this.runtime = new RuntimeSDK();
+      /**
+       * @public
+       * @readonly
+       * Access to the Ads SDK module.
+       * @see {@link JoliboxAds} for more details.
+       * @type {JoliboxAds}
+       */
       this.ads = new JoliboxAds();
+      /**
+       * @public
+       * @readonly
+       * Access to the Lifecycle SDK module.
+       * @see {@link LifecycleSDK} for more details.
+       * @type {LifecycleSDK}
+       */
       this.lifecycle = new LifecycleSDK();
+      /**
+       * @private
+       * @readonly
+       * Access to the Storage SDK module.
+       * @see {@link StorageSDK} for more details.
+       * @type {StorageSDK}
+       */
       this.storage = new StorageSDK();
+      /**
+       * @private
+       * @readonly
+       * Access to the Keyboard SDK module.
+       * @see {@link KeyboardSDK} for more details.
+       * @type {KeyboardSDK}
+       */
       this.keyboard = new KeyboardSDK();
+      /**
+       * @public
+       * @readonly
+       * Access to the Task Tracker SDK module.
+       * @see {@link TaskTrackerSDK} for more details.
+       * @type {TaskTrackerSDK}
+       */
       this.task = new TaskTrackerSDK();
+      /**
+       * @private
+       * @readonly
+       * Access to the Router SDK module.
+       * @see {@link RouterSDK} for more details.
+       * @type {RouterSDK}
+       */
       this.router = new RouterSDK();
       //global API
+      /**
+       * @public
+       * Synchronously gets system information.
+       * @see {@link getSystemInfoSync} for more details.
+       * @returns {ISystemInfo} The system information.
+       */
       this.getSystemInfoSync = getSystemInfoSync.bind(this);
+      /**
+       * @public
+       * Checks if a specific API, component, or capability is available in the current environment.
+       * @see {@link canIUse} for more details.
+       * @param {string} schema - The schema string to check (e.g., "component.button", "api.request").
+       * @returns {boolean} True if available, false otherwise.
+       */
       this.canIUse = canIUse.bind(this);
+      /**
+       * @public
+       * Initiates the login process.
+       * @see {@link login} for more details.
+       * @returns {Promise<ILoginSuccessData>} A promise that resolves with login success data.
+       */
       this.login = login.bind(this);
+      /**
+       * @public
+       * Checks the current session status.
+       * @see {@link checkSession} for more details.
+       * @returns {Promise<ICheckSessionSuccessData>} A promise that resolves with session status data.
+       */
       this.checkSession = checkSession.bind(this);
+      /**
+       * @private
+       * Makes an HTTP request.
+       * @see {@link request} for more details.
+       * @param {IRequestParams} params - Parameters for the HTTP request.
+       * @returns {Promise<IRequestSuccessData>} A promise that resolves with the request response.
+       */
       this.request = request.bind(this);
+      /**
+       * @public
+       * Registers a listener for a custom event.
+       * @see {@link onCustomEvent} for more details.
+       * @param {string} eventName - The name of the event to listen for.
+       * @param {(data: any) => void} callback - The callback function to execute when the event is triggered.
+       */
       this.on = onCustomEvent.bind(this);
+      /**
+       * @public
+       * Unregisters a listener for a custom event.
+       * @see {@link offCustomEvent} for more details.
+       * @param {string} eventName - The name of the event.
+       * @param {(data: any) => void} [callback] - The specific callback to remove. If not provided, all listeners for the event are removed.
+       */
       this.off = offCustomEvent.bind(this);
+      /**
+       * @public
+       * Registers a one-time listener for a custom event. The listener is automatically removed after being invoked once.
+       * @see {@link onceCustomEvent} for more details.
+       * @param {string} eventName - The name of the event to listen for.
+       * @param {(data: any) => void} callback - The callback function to execute.
+       */
       this.once = onceCustomEvent.bind(this);
       if (_JoliboxSDK.instance) {
         return _JoliboxSDK.instance;
@@ -1635,7 +1846,11 @@ function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r
       _JoliboxSDK.instance = this;
       console.log(`JoliboxSDK ${this.jssdkVersion} init`);
     }
-    // 添加静态方法获取实例
+    /**
+     * @public
+     * Gets the singleton instance of the JoliboxSDK.
+     * @returns {JoliboxSDK} The singleton JoliboxSDK instance.
+     */
     static getInstance() {
       if (!_JoliboxSDK.instance) {
         _JoliboxSDK.instance = new _JoliboxSDK();

package/dist/sdks/ads.d.ts

@@ -1,11 +1,20 @@
 import type { IAdBreakParams, IAdConfigParams, IAdsInitParams, IAdUnitParams, JoliboxAds as IJoliboxAds } from '@jolibox/types/dist/sdks/ads';
 import { BaseSDK, BaseSDKEventMap } from './sdk';
-type JoliboxAdsEventMap = BaseSDKEventMap;
+export type JoliboxAdsEventMap = BaseSDKEventMap;
+/**
+ * @public
+ * Manages advertising functionalities within the Jolibox ecosystem.
+ */
 export declare class JoliboxAds extends BaseSDK<JoliboxAdsEventMap> implements IJoliboxAds {
     constructor();
     init: (config?: IAdsInitParams) => void;
     adConfig: (params: IAdConfigParams) => void;
     adBreak: (params: IAdBreakParams) => void;
     adUnit: (params: IAdUnitParams) => void;
+    /**
+     * Initializes a new ad unit.
+     * @param unitId - The ID of the ad unit.
+     * @returns A promise that resolves when the ad is loaded.
+     */
+    initAd(unitId: string): Promise<void>;
 }
-export {};

package/dist/sdks/keyboard.d.ts

@@ -1,8 +1,12 @@
 import { BaseSDK } from './sdk';
 import { Keyboard, ResponseType } from '@jolibox/types';
+/**
+ * @private
+ * Manages keyboard functionalities within the Jolibox ecosystem. Only Support in Native App
+ */
 export declare class KeyboardSDK extends BaseSDK implements Keyboard {
     /**
-     * 显示键盘
+     * Show the keyboard
      * @param params
      * @returns
      */
@@ -15,7 +19,7 @@ export declare class KeyboardSDK extends BaseSDK implements Keyboard {
         message: string;
     } | undefined;
     /**
-     * 更新键盘
+     * Update the keyboard
      * @param value
      * @returns
      */
@@ -24,7 +28,7 @@ export declare class KeyboardSDK extends BaseSDK implements Keyboard {
         message: string;
     } | undefined;
     /**
-     * 隐藏键盘
+     * Hide the keyboard
      * @returns
      */
     hideKeyboard(): {

package/dist/sdks/lifecycle.d.ts

@@ -1,12 +1,37 @@
 import { Env, Lifecycle } from '@jolibox/types';
 import { BaseSDK, BaseSDKEventMap } from './sdk';
 declare const LIFECYCLE_ON_READY = "LifecycleSDK.onReady";
+/**
+ * @internal
+ * Defines the event map specific to the LifecycleSDK, extending BaseSDKEventMap.
+ */
 interface LifecycleSDKEventMap extends BaseSDKEventMap {
     [LIFECYCLE_ON_READY]: Env['hostUserInfo'] | undefined;
 }
+/**
+ * @public
+ * Manages lifecycle events and functionalities within the Jolibox SDK.
+ * This includes handling application readiness, exit procedures, and visibility changes.
+ */
 export declare class LifecycleSDK extends BaseSDK<LifecycleSDKEventMap> implements Lifecycle {
     constructor();
+    /**
+     * @public
+     * Registers a callback to be invoked when the Jolibox environment is ready.
+     * This typically signifies that the main application or game can start its operations.
+     * @param callback - A function to call when the environment is ready. It may receive host user information as a parameter.
+     * @event LifecycleSDK.onReady Dispatched after the provided callback is executed, with host user info.
+     */
     onReady(callback: (info?: Env['hostUserInfo']) => void): void;
+    /**
+     * @private
+     * Initiates the process to exit the Jolibox application or game.
+     * Allows registering a callback to be executed before the exit occurs.
+     * @param params - An object containing:
+     *   - `onBeforeExit`: A function to call before the application exits.
+     *   - `shouldStay` (optional): A boolean indicating if the application should attempt to prevent the exit. The exact behavior may depend on the host environment.
+     * @returns {object | undefined} An error object if the 'lifeCycle.exit' capability is not available, otherwise undefined.
+     */
     exit(params: {
         onBeforeExit: () => void;
         shouldStay?: boolean;
@@ -14,7 +39,17 @@ export declare class LifecycleSDK extends BaseSDK<LifecycleSDKEventMap> implemen
         code: import("@jolibox/types").ResponseType;
         message: string;
     } | undefined;
-    onJoliboxHide(params: () => void): void;
-    onJoliboxShow(params: () => void): void;
+    /**
+     * @public
+     * Registers a callback to be invoked when the Jolibox application is hidden (e.g., moved to the background).
+     * @param callback - A function to call when the application is hidden.
+     */
+    onJoliboxHide(callback: () => void): void;
+    /**
+     * @public
+     * Registers a callback to be invoked when the Jolibox application is shown (e.g., brought to the foreground).
+     * @param callback - A function to call when the application is shown.
+     */
+    onJoliboxShow(callback: () => void): void;
 }
 export {};

package/dist/sdks/router.d.ts

@@ -1,22 +1,63 @@
 import { BaseSDK } from './sdk';
-import { Router, ResponseType, StandardResponse } from '@jolibox/types';
+import { Router, StandardResponse, ResponseType } from '@jolibox/types';
+/**
+ * @private
+ * Provides routing and navigation functionalities within the Jolibox SDK.
+ * This includes opening schemas, web pages, and navigating to native application pages.
+ * @implements {Router}
+ */
 export declare class RouterSDK extends BaseSDK implements Router {
-    openSchema(schema: string): Promise<{
+    /**
+     * @public
+     * Opens a given schema URL.
+     * This is often used for deep linking or triggering specific actions within the host application or other apps.
+     * @param schema - The schema URL string to open (e.g., 'yourapp://action?param=value').
+     * @returns A promise that resolves with a StandardResponse, or an error object if the capability is not available.
+     */
+    openSchema(schema: string): Promise<StandardResponse<void> | {
         code: ResponseType;
         message: string;
     }>;
+    /**
+     * @public
+     * Opens a web page in a new view (e.g., an in-app browser or a new tab).
+     * @param url - The URL of the web page to open.
+     * @returns A promise that resolves with a StandardResponse containing the webviewId, or an error object if the capability is not available.
+     */
     openPage(url: string): Promise<StandardResponse<{
         webviewId: number;
-    }>>;
-    closePage(webviewId: number): Promise<{
+    }> | {
         code: ResponseType;
         message: string;
     }>;
-    interceptSystemExit(intercept: boolean): Promise<{
+    /**
+     * @public
+     * Closes a previously opened web page/view, identified by its webviewId.
+     * @param webviewId - The ID of the webview to close.
+     * @returns A promise that resolves with a StandardResponse, or an error object if the capability is not available.
+     */
+    closePage(webviewId: number): Promise<StandardResponse<void> | {
         code: ResponseType;
         message: string;
     }>;
-    navigateToNativePage(path: string, params: Record<string, unknown>): Promise<{
+    /**
+     * @public
+     * Intercepts the system's back button or exit gesture.
+     * @param intercept - A boolean indicating whether to intercept the exit (true) or allow default behavior (false).
+     * @returns A promise that resolves with a StandardResponse, or an error object if the capability is not available.
+     */
+    interceptSystemExit(intercept: boolean): Promise<StandardResponse<void> | {
+        code: ResponseType;
+        message: string;
+    }>;
+    /**
+     * @public
+     * Navigates to a specific native page within the host application.
+     * @param path - The identifier for the native page to navigate to. Currently, only 'openHistory' is explicitly supported by this client-side check.
+     * @param params - A record of parameters to pass to the native page.
+     * @returns A promise that resolves with a StandardResponse, or an error object if the capability is not available or the path is invalid.
+     */
+    navigateToNativePage(path: string, params: Record<string, unknown>): Promise<StandardResponse<void> | {
         code: ResponseType;
         message: string;
     }>;

package/dist/sdks/runtime.d.ts

@@ -13,9 +13,10 @@ export declare enum JoliboxRuntimeEvents {
     LOAD_PROGRESS = "JOLIBOX_RUNTIME_LOAD_PROGRESS"
 }
 /**
+ * @public
  * Default implementation of JoliboxRuntime, in case the JoliboxRuntime is not available
  */
-declare class FallbackJoliboxRuntime {
+export declare class FallbackJoliboxRuntime {
     /**
      * Notify the end of the loading, will close the loading splash screen
      */
@@ -32,4 +33,3 @@ declare global {
     }
 }
 export declare const RuntimeSDK: typeof FallbackJoliboxRuntime;
-export {};

package/dist/sdks/sdk.d.ts

@@ -4,7 +4,15 @@ export interface BaseSDKEventMap {
     _baseSDKMarker?: never;
 }
 export declare abstract class BaseSDK<T = BaseSDKEventMap> {
+    /**
+     * @private
+     * Instance for executing commands. Intended for internal SDK use.
+     */
     readonly commands: import("@jolibox/common").Commands;
+    /**
+     * @private
+     * Event emitter instance for handling internal events. Intended for internal SDK use.
+     */
     readonly _emitter: EventEmitter<Record<string, unknown[]>, string>;
     addEventListener<K extends keyof T & string>(event: K, callback: (data: T[K]) => void): void;
     triggerEvent<K extends keyof T & string>(event: K, params: T[K]): void;

package/dist/sdks/storage.d.ts

@@ -1,8 +1,39 @@
 import { BaseSDK } from './sdk';
 import { StandardResponse, Storage } from '@jolibox/types';
+/**
+ * @private
+ * Provides functionalities for persistent key-value storage within the Jolibox SDK.
+ * Allows setting, getting, removing items, and clearing the entire storage.
+ * @implements {Storage}
+ */
 export declare class StorageSDK extends BaseSDK implements Storage {
-    getItem(key: string): Promise<StandardResponse<string | null, unknown>>;
+    /**
+     * @public
+     * Retrieves an item from storage based on its key.
+     * @param key - The key of the item to retrieve.
+     * @returns A promise that resolves with the value of the item, or null if the key is not found. The specific structure of the resolved value (e.g., if wrapped in StandardResponse) depends on the command execution result.
+     */
+    getItem(key: string): Promise<StandardResponse<string | null>>;
+    /**
+     * @public
+     * Sets an item in storage with a given key and value.
+     * There are limitations on the length of the key and the combined length of key and value.
+     * @param key - The key for the item. Should be less than 128 characters.
+     * @param value - The value to store. Can be a number, string, or boolean. It will be converted to a string for storage.
+     * @returns A promise that resolves with a StandardResponse. It might contain an error object if validation fails (e.g., key/value length exceeded).
+     */
     setItem(key: string, value: number | string | boolean): Promise<StandardResponse<void>>;
-    removeItem(key: string): Promise<StandardResponse<void, unknown>>;
-    clear(): Promise<StandardResponse<void, unknown>>;
+    /**
+     * @public
+     * Removes an item from storage based on its key.
+     * @param key - The key of the item to remove.
+     * @returns A promise that resolves with a StandardResponse (or the direct result of command execution).
+     */
+    removeItem(key: string): Promise<StandardResponse<void>>;
+    /**
+     * @public
+     * Clears all items from the storage.
+     * @returns A promise that resolves with a StandardResponse (or the direct result of command execution).
+     */
+    clear(): Promise<StandardResponse<void>>;
 }

package/dist/sdks/task.d.ts

@@ -1,5 +1,11 @@
 import { BaseSDK } from './sdk';
 import { TaskTracker, TaskResponse } from '@jolibox/types';
+/**
+ * @public
+ * Provides functionalities for task tracking within the Jolibox SDK.
+ * Allows tracking of game levels, gameplay sessions, and level upgrades.
+ * @implements {TaskTracker}
+ */
 export declare class TaskTrackerSDK extends BaseSDK implements TaskTracker {
     /**
      * Handles completion of a game level by sending analytics data to the backend