@telemetryos/sdk 1.2.0 → 1.4.0

package/dist/overrides.d.ts

@@ -1,7 +1,46 @@
 import { Client } from './client.js';
+/**
+ * Provides control methods for managing content overrides.
+ *
+ * Overrides allow applications to temporarily modify device behavior or content
+ * display. Applications can set named overrides to trigger specific behaviors
+ * and clear them when no longer needed.
+ */
 export declare class Overrides {
     _client: Client;
     constructor(client: Client);
+    /**
+     * Activates a named override on the device.
+     *
+     * Overrides can be used to temporarily change device behavior, such as
+     * displaying special content, triggering alerts, or modifying the playback schedule.
+     *
+     * @param name The name/identifier of the override to activate
+     * @returns A promise that resolves to true if successful
+     * @example
+     * // Activate an emergency alert override
+     * await overrides().setOverride('emergency-alert');
+     *
+     * @example
+     * // Activate a promotional content override
+     * await overrides().setOverride('promo-mode');
+     */
     setOverride(name: string): Promise<boolean>;
+    /**
+     * Deactivates a named override on the device.
+     *
+     * This removes a previously set override, returning the device to normal operation
+     * or allowing other overrides to take effect.
+     *
+     * @param name The name/identifier of the override to deactivate
+     * @returns A promise that resolves to true if successful
+     * @example
+     * // Clear an emergency alert override
+     * await overrides().clearOverride('emergency-alert');
+     *
+     * @example
+     * // Clear promotional mode when no longer needed
+     * await overrides().clearOverride('promo-mode');
+     */
     clearOverride(name: string): Promise<boolean>;
 }

package/dist/playlist.d.ts

@@ -1,8 +1,49 @@
 import { Client } from './client.js';
+/**
+ * Provides control methods for applications embedded within playlists.
+ *
+ * This API allows embedded applications to control the playlist they are running in,
+ * such as advancing to the next page, returning to the previous page, or changing
+ * the current page's display duration.
+ */
 export declare class Playlist {
     _client: Client;
     constructor(client: Client);
+    /**
+     * Advances to the next page in the current playlist.
+     *
+     * @returns A promise that resolves to true if successful
+     * @example
+     * // Move to the next page
+     * await playlist().nextPage();
+     */
     nextPage(): Promise<boolean>;
+    /**
+     * Returns to the previous page in the current playlist.
+     *
+     * @returns A promise that resolves to true if successful
+     * @example
+     * // Move to the previous page
+     * await playlist().previousPage();
+     */
     previousPage(): Promise<boolean>;
+    /**
+     * Sets the display duration for the current page.
+     *
+     * This allows the embedded application to dynamically adjust how long
+     * the current page is displayed before advancing to the next page.
+     *
+     * @param duration The duration in milliseconds
+     * @returns A promise that resolves to true if successful
+     * @example
+     * // Set page duration to 10 seconds
+     * await playlist().setDuration(10000);
+     *
+     * @example
+     * // Extend duration based on content
+     * if (hasMoreContent) {
+     *   await playlist().setDuration(30000); // 30 seconds
+     * }
+     */
     setDuration(duration: number): Promise<boolean>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@telemetryos/sdk",
-  "version": "1.2.0",
+  "version": "1.4.0",
   "description": "The official TelemetryOS application API package. Use it to build applications that run on the TelemetryOS platform",
   "type": "module",
   "main": "dist/index.cjs",
@@ -35,7 +35,7 @@
   "license": "",
   "repository": "github:TelemetryTV/Application-API",
   "dependencies": {
-    "@telemetryos/root-sdk": "^1.2.0",
+    "@telemetryos/root-sdk": "^1.4.0",
     "zod": "^3.24.4"
   },
   "devDependencies": {