@telemetryos/root-sdk 1.0.0

package/dist/index.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/media.d.ts

@@ -0,0 +1,71 @@
+import { Client } from './client.js';
+type MediaContentUser = {};
+type MediaContent = {
+    id: string;
+    contentFolderId: string;
+    contentType: string;
+    name: string;
+    description: string;
+    thumbnailUrl: string;
+    keys: string[];
+    publicUrls: string[];
+    hidden: boolean;
+    validFrom?: Date;
+    validTo?: Date;
+    createdBy?: MediaContentUser;
+    transcodedAt?: Date;
+    createdAt: Date;
+    updatedAt: Date;
+};
+type MediaFolder = {
+    id: string;
+    parentId: string;
+    name: string;
+    size: number;
+    default: boolean;
+    updatedAt: Date;
+    createdAt: Date;
+};
+export declare class Media {
+    _client: Client;
+    constructor(client: Client);
+    /**
+     * Queries for media folders based on folder properties.
+     *
+     * This method allows you to search for media folders that match specific criteria,
+     * such as name, ID, or other folder properties.
+     *
+     * @param query An object with partial MediaFolder properties to match against
+     * @returns A promise that resolves to an array of matching media folders
+     */
+    queryFolders(query: Partial<MediaFolder>): Promise<MediaFolder[]>;
+    /**
+     * Retrieves media folders that have been tagged with a specific tag.
+     *
+     * @param tagName The name of the tag to search for
+     * @returns A promise that resolves to an array of media folders with the specified tag
+     */
+    getFoldersByTag(tagName: string): Promise<MediaFolder[]>;
+    /**
+     * Retrieves a specific media folder by its ID.
+     *
+     * @param id The unique identifier of the folder to retrieve
+     * @returns A promise that resolves to the media folder with the specified ID
+     */
+    getFolderById(id: string): Promise<MediaFolder>;
+    /**
+     * Retrieves all media content items within a specific folder.
+     *
+     * @param folderId The unique identifier of the folder to get content from
+     * @returns A promise that resolves to an array of media content items in the folder
+     */
+    getMediaContentByFolderId(folderId: string): Promise<MediaContent[]>;
+    /**
+     * Retrieves a specific media content item by its ID.
+     *
+     * @param id The unique identifier of the media content to retrieve
+     * @returns A promise that resolves to the media content item with the specified ID
+     */
+    getMediaContentById(id: string): Promise<MediaContent>;
+}
+export {};

package/dist/root-settings-navigation.d.ts

@@ -0,0 +1,59 @@
+import { Store } from './store.js';
+type RootSettingsNavigationEntry = {
+    label: string;
+    path: string;
+    entities: RootSettingsNavigationSubEntry[];
+};
+type RootSettingsNavigationSubEntry = {
+    label: string;
+    path: string;
+};
+type RootSettingsNavigationOpts = {
+    entries: RootSettingsNavigationEntry[];
+};
+export type RootSettingsApplicationNavigationState = {
+    applicationId: string;
+    entries: RootSettingsNavigationEntry[];
+};
+type RootSettingsNavigationState = Record<string, RootSettingsApplicationNavigationState>;
+export declare class RootSettingsNavigation {
+    _store: Store;
+    /**
+     * Creates a new RootSettingsNavigation API instance.
+     *
+     * @param store The Store instance to use for persistence
+     * @throws {Error} If used by an application not mounted at the 'rootSettingsNavigation' mount point
+     */
+    constructor(store: Store);
+    /**
+     * Registers navigation entries for the root application in the TelemetryOS admin UI.
+     *
+     * This method allows a root application to define its sidebar navigation structure
+     * within the TelemetryOS administration UI. The navigation entries will appear in the
+     * sidebar menu, allowing users to navigate to different sections of the application.
+     *
+     * @param navigation An object containing the navigation entries to register
+     * @returns A promise that resolves when the navigation has been registered
+     */
+    setRootSettingsNavigation(navigation: RootSettingsNavigationOpts): Promise<void>;
+    /**
+     * Retrieves the current navigation entries for this root application.
+     *
+     * This method returns the navigation structure that was previously registered
+     * for this application using setRootSettingsNavigation().
+     *
+     * @returns A promise that resolves to the navigation state for this application
+     */
+    getRootSettingsNavigation(): Promise<RootSettingsApplicationNavigationState>;
+    /**
+     * Retrieves the navigation entries for all root applications.
+     *
+     * This method returns the navigation structures for all root applications registered
+     * in the TelemetryOS administration UI. This can be useful for coordination between
+     * different root applications.
+     *
+     * @returns A promise that resolves to the navigation state for all applications
+     */
+    getAllRootSettingsNavigation(): Promise<RootSettingsNavigationState>;
+}
+export {};

package/dist/store.d.ts

@@ -0,0 +1,129 @@
+import { Client, MessageHandler } from './client.js';
+export declare class Store {
+    _client: Client;
+    constructor(client: Client);
+    /**
+     * Provides access to the application store scope.
+     *
+     * Data stored in the application scope is shared across all instances of your application
+     * within the current account. Use this scope for application-wide settings, shared resources,
+     * or any data that should be consistent across all instances.
+     *
+     * @returns A StoreSlice instance for the application scope
+     */
+    get application(): StoreSlice;
+    /**
+     * Provides access to the instance store scope.
+     *
+     * Data stored in the instance scope is only available to the current instance of your
+     * application. This is ideal for instance-specific settings, UI state, temporary data,
+     * or any information that shouldn't be shared with other instances.
+     *
+     * The namespace for instance data includes both the application name and the instance ID.
+     *
+     * @returns A StoreSlice instance for the instance scope
+     */
+    get instance(): StoreSlice;
+    /**
+     * Provides access to the device store scope.
+     *
+     * Data stored in the device scope is only available to the application on the
+     * current physical device. This is useful for device-specific settings, caching, or
+     * any data that should persist across application instances but only on a single device.
+     *
+     * Note: This scope cannot be used for Settings-related mount points as the User
+     * Administration UI does not run on a device.
+     *
+     * @returns A StoreSlice instance for the device scope
+     */
+    get device(): StoreSlice;
+    /**
+     * Provides access to the shared store scope with a specified namespace.
+     *
+     * The shared scope enables data sharing between different applications within the
+     * same account. By specifying a common namespace, any two applications can exchange
+     * data and communicate with each other.
+     *
+     * This is particularly useful for application ecosystems where multiple applications
+     * need to coordinate or share configuration.
+     *
+     * @param namespace A string identifier for the shared data space
+     * @returns A StoreSlice instance for the specified shared namespace
+     */
+    shared(namespace: string): StoreSlice;
+}
+/**
+ * Provides methods for saving, retrieving, and subscribing to data in a specific store scope.
+ *
+ * StoreSlice is the concrete implementation for interacting with a particular storage scope
+ * (application, instance, device, or shared). It offers methods to set and get values, subscribe
+ * to changes, and delete data within its specific scope and namespace.
+ *
+ * This class is not typically instantiated directly by applications. Instead, use the
+ * properties and methods of the Store class to access the appropriate StoreSlice.
+ */
+declare class StoreSlice {
+    _kind: string;
+    _namespace: string;
+    _client: Client;
+    constructor(kind: string, namespace: string, client: Client);
+    /**
+     * Saves a value in the store.
+     *
+     * This method stores data under the specified key within the current store scope and namespace.
+     * The value must be serializable (can be converted to JSON). Complex objects like Date instances
+     * will be serialized and deserialize as regular objects, losing their prototype methods.
+     *
+     * @param key The key to save the value under
+     * @param value The value to store - must be JSON serializable
+     * @returns A promise that resolves to true if the value was saved successfully
+     */
+    set(key: string, value: any): Promise<boolean>;
+    /**
+     * Retrieves a value from the store.
+     *
+     * This method fetches data stored under the specified key within the current store scope
+     * and namespace. For real-time applications that need to respond to changes, consider
+     * using subscribe() instead.
+     *
+     * @template T The expected type of the stored value
+     * @param key The key to retrieve the value for
+     * @returns A promise that resolves to the stored value, or undefined if the key does not exist
+     */
+    get<T>(key: string): Promise<T>;
+    /**
+     * Subscribes to changes in the store for a specific key.
+     *
+     * This method sets up a subscription that will call the provided handler whenever
+     * the value associated with the specified key changes. This is the recommended way
+     * to access store data in long-running applications that need to stay responsive
+     * to data changes.
+     *
+     * @param key The key to subscribe to
+     * @param handler The callback function to call when the value changes
+     * @returns A promise that resolves to true if the subscription was successful
+     */
+    subscribe(key: string, handler: MessageHandler<any>): Promise<boolean>;
+    /**
+     * Unsubscribes from changes in the store for a specific key.
+     *
+     * This method removes a subscription previously created with subscribe(). It can
+     * either remove a specific handler or all handlers for the given key.
+     *
+     * @param key The key to unsubscribe from
+     * @param handler Optional. The specific handler to remove. If not provided, all handlers for this key will be removed.
+     * @returns A promise that resolves to true if the unsubscription was successful
+     */
+    unsubscribe(key: string, handler?: MessageHandler<any>): Promise<boolean>;
+    /**
+     * Deletes a value from the store.
+     *
+     * This method removes the data stored under the specified key within the
+     * current store scope and namespace.
+     *
+     * @param key The key to delete
+     * @returns A promise that resolves to true if the value was deleted successfully
+     */
+    delete(key: string): Promise<boolean>;
+}
+export {};

package/dist/test-setup.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/users.d.ts

@@ -0,0 +1,25 @@
+import { Client } from './index.js';
+type CurrentUser = {
+    id: string;
+};
+type GetCurrentUserResult = {
+    user: CurrentUser;
+};
+export declare class Users {
+    _client: Client;
+    constructor(client: Client);
+    /**
+     * Retrieves information about the user associated with the current session.
+     *
+     * This method allows an application to get details about the TelemetryOS user
+     * who is currently using the application.
+     *
+     * @returns A promise that resolves to the current user result object
+     * @example
+     * // Get the current user information
+     * const userResult = await users.getCurrent();
+     * console.log(`Current user ID: ${userResult.user.id}`);
+     */
+    getCurrent(): Promise<GetCurrentUserResult>;
+}
+export {};

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@telemetryos/root-sdk",
+  "version": "1.0.0",
+  "description": "The official TelemetryOS root application sdk package. Provides types and apis for building root TelemetryOS applications.",
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./bridge": {
+      "types": "./dist/bridge.d.ts",
+      "import": "./dist/bridge.js",
+      "require": "./dist/bridge.cjs"
+    }
+  },
+  "files": [
+    "dist/*.js",
+    "dist/*.cjs",
+    "dist/*.map",
+    "dist/*.d.ts",
+    "README.md",
+    "MIGRATION.md",
+    "CHANGELOG.md"
+  ],
+  "keywords": [
+    "TelemetryTV",
+    "interactive kiosk",
+    "digital signage",
+    "digital menu board",
+    "digital directory",
+    "display management",
+    "displays at scale"
+  ],
+  "author": "TelemetryTV <support@telemetrytv.com>",
+  "license": "",
+  "repository": "github:TelemetryTV/Application-API",
+  "dependencies": {
+    "zod": "^3.24.4"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.26.0",
+    "@rollup/plugin-typescript": "^12.1.2",
+    "@types/node": "^22.15.3",
+    "@typescript-eslint/eslint-plugin": "^8.32.0",
+    "@typescript-eslint/parser": "^8.32.0",
+    "eslint": "^9.26.0",
+    "eslint-config-prettier": "^10.1.2",
+    "eslint-plugin-prettier": "^5.4.0",
+    "globals": "^16.0.0",
+    "happy-dom": "^17.4.6",
+    "prettier": "^3.5.3",
+    "typescript": "^5.8.3",
+    "typescript-eslint": "^8.32.0",
+    "vite": "^6.3.5",
+    "vite-plugin-dts": "^4.5.3",
+    "vitest": "^3.1.3"
+  },
+  "scripts": {
+    "lint": "eslint ./src",
+    "test": "vitest run",
+    "build": "vite build",
+    "watch": "vite build -w"
+  }
+}