@rocketman-streamkit/types 1.0.0 → 1.0.3

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
@@ -59,6 +71,17 @@ Alternatively, reference the package types field directly:
 
 Do **not** add `@types/node` — addon workers are not Node.js processes.
 
+Do **not** include `"DOM"` in `compilerOptions.lib` — sandbox globals such as `URL`, `console`, and `status` intentionally replace browser typings.
+
+The npm package ships `tsconfig.json`; you can extend it in your addon project:
+
+```json
+{
+  "extends": "./node_modules/@rocketman-streamkit/types/tsconfig.json",
+  "include": ["./**/*.ts"]
+}
+```
+
 ---
 
 ## Examples
@@ -102,6 +125,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

@@ -1,5 +1,6 @@
 // AUTO-GENERATED — do not edit manually
 // Source: backend/addons/list/integrations/index.ts -> GenerateContext()
+// Typecheck with lib: ["ES2020"] only (no DOM) — see tsconfig.json in this folder.
 
 declare global {
   type URLSearchParamsInit = | string
@@ -8,7 +9,7 @@ declare global {
     | ReadonlyArray<[string, string]>
     | URLSearchParams;
 
-  declare class URLSearchParams {
+  class URLSearchParams {
     constructor(init?: URLSearchParamsInit);
     static from(native: URLSearchParams): URLSearchParams;
     append(name: string, value: string): void;
@@ -27,7 +28,7 @@ declare global {
     size: number;
   }
 
-  declare class UrlCustom {
+  class UrlCustom {
     constructor(url: string | UrlCustom, base?: string | UrlCustom);
     static canParse(url: string, base?: string | UrlCustom): boolean;
     static parse(url: string, base?: string | UrlCustom): UrlCustom | null;
@@ -185,6 +186,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,10 +1,11 @@
 {
   "name": "@rocketman-streamkit/types",
-  "version": "1.0.0",
+  "version": "1.0.3",
   "description": "TypeScript declarations for the StreamKit+ integration addon sandbox API",
   "types": "addon.d.ts",
   "files": [
     "addon.d.ts",
+    "tsconfig.json",
     "README.md"
   ],
   "keywords": [

package/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "types": [],
+    "lib": ["ES2020"],
+    "noEmit": true,
+    "strict": true,
+    "skipLibCheck": true
+  },
+  "include": ["addon.d.ts"]
+}