@rocketman-streamkit/types 1.0.0 → 1.0.2

package/README.md

@@ -8,6 +8,18 @@ Use this package when developing worker addons outside the StreamKit+ repository
 
 ---
 
+## Documentation
+
+API reference, manifest format, permissions, and addon categories are published in a separate repository — one branch per StreamKit+ version:
+
+**[github.com/RocketMan-StreamKit/types](https://github.com/RocketMan-StreamKit/types)**
+
+Open the branch that matches your target app version (for example `1.0.0`) and start from [`index.md`](https://github.com/RocketMan-StreamKit/types/blob/1.0.0/index.md).
+
+This npm package provides **TypeScript typings only**; the docs repo is the full written guide.
+
+---
+
 ## Installation
 
 ```bash
@@ -102,6 +114,25 @@ await GenerateConfig([
 const params = await api.config.getParams<{ channel_id: string; enabled: boolean }>();
 ```
 
+### App UI locale (`LANG`)
+
+Read-only bridge to the user's language setting in StreamKit+ (`en`, `ru`, `uk`). No permission required:
+
+```typescript
+const labels = {
+  en: 'Connected',
+  ru: 'Подключено',
+  uk: 'Підключено',
+};
+
+status.Update({ current: 'online', message: { [LANG.current]: labels[LANG.current] } });
+
+const sub = LANG.onChangeLanguage((lang) => {
+  console.log('UI locale changed:', lang);
+});
+// later: sub.Destroy();
+```
+
 ### Outbound HTTP request
 
 Requires `NETWORK_REQUEST` permission in `manifest.json`:

package/addon.d.ts

@@ -27,6 +27,25 @@ declare global {
     size: number;
   }
 
+  declare class URLSearchParams {
+    constructor(init?: URLSearchParamsInit);
+    static from(native: URLSearchParams): URLSearchParams;
+    append(name: string, value: string): void;
+    delete(name: string, value?: string): void;
+    get(name: string): string | null;
+    getAll(name: string): string[];
+    has(name: string, value?: string): boolean;
+    set(name: string, value: string): void;
+    sort(): void;
+    toString(): string;
+    keys(): IterableIterator<string>;
+    values(): IterableIterator<string>;
+    entries(): IterableIterator<[string, string]>;
+    forEach(callback: (value: string, key: string, parent: URLSearchParams) => void, thisArg: unknown): void;
+    [Symbol.iterator](): IterableIterator<[string, string]>;
+    size: number;
+  }
+
   declare class UrlCustom {
     constructor(url: string | UrlCustom, base?: string | UrlCustom);
     static canParse(url: string, base?: string | UrlCustom): boolean;
@@ -60,6 +79,10 @@ declare global {
     Record<Exclude<AddonConfigLang, 'en'>, string>
   >;
 
+  type DashboardLocalizedString = | string
+    | [LangData, ...(string | number)[]]
+    | DashboardLocalizedText;
+
   type DashboardLocalizedString = | string
     | [LangData, ...(string | number)[]]
     | DashboardLocalizedText;
@@ -185,6 +208,27 @@ declare global {
 
   type AddonConfigSchema = AddonConfigSchemaEntry[];
 
+    /**
+     * Read-only bridge to the app UI locale (`en`, `ru`, or `uk`).
+    Use to pick strings from per-locale objects; does not expose app translation keys.
+     * @example const label = { en: 'Connected', ru: 'Подключено', uk: 'Підключено' };
+    status.Update({ current: 'online', message: { [LANG.current]: label[LANG.current] } });
+     * @example const sub = LANG.onChangeLanguage((lang) => {
+      console.log('UI locale changed to', lang);
+    });
+    // later: sub.Destroy();
+     */
+    var LANG: {
+      /**
+       * Current app UI locale key. Updated when the user changes language in settings.
+       */
+      current: "en" | "ru" | "uk";
+      /**
+       * Subscribe to app UI locale changes. Returns `{ Destroy }` to unsubscribe.
+       * @param cb - Called with the new locale key (`en`, `ru`, or `uk`).
+       */
+      onChangeLanguage: (cb: (lang: "en" | "ru" | "uk") => void) => { Destroy: () => void; };
+    };
     /**
      * The port of the local web server.
      * @example const port = WEB_SERVER_PORT;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rocketman-streamkit/types",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "TypeScript declarations for the StreamKit+ integration addon sandbox API",
   "types": "addon.d.ts",
   "files": [