@rocketman-streamkit/types 1.0.2 → 1.0.4

package/README.md

@@ -71,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

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,26 +28,7 @@ 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 {
+  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;
@@ -79,10 +61,6 @@ declare global {
     Record<Exclude<AddonConfigLang, 'en'>, string>
   >;
 
-  type DashboardLocalizedString = | string
-    | [LangData, ...(string | number)[]]
-    | DashboardLocalizedText;
-
   type DashboardLocalizedString = | string
     | [LangData, ...(string | number)[]]
     | DashboardLocalizedText;
@@ -243,6 +221,14 @@ declare global {
     }
      */
     var isDeveloperMode: boolean;
+    /**
+     * Check if proxy mode is enabled in application settings
+    Can be used for additional logging and debugging, or advanced configuration.
+     * @example if (isProxyMode) {
+      console.log('Proxy mode is enabled');
+    }
+     */
+    var isProxyMode: boolean;
     /**
      * Requires a module.
      * @param name Module name.
@@ -763,14 +749,14 @@ declare global {
          * @returns Absolute URL on the local web server.
          * @example return { redirect: ui.auth.generateSuccess('Twitch connected') };
          */
-        generateSuccess: (message: string | undefined) => string;
+        generateSuccess: (message: unknown) => string;
         /**
          * Builds a redirect URL for the OAuth failure page.
          * @param message Optional custom message shown via `?message=`.
          * @returns Absolute URL on the local web server.
          * @example return { redirect: ui.auth.generateFail('Invalid OAuth state') };
          */
-        generateFail: (message: string | undefined) => string;
+        generateFail: (message: unknown) => string;
       };
     };
     /**

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@rocketman-streamkit/types",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "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"]
+}