obs-ws-sdk 0.0.1

package/dist/modules/ui.d.ts

@@ -0,0 +1,55 @@
+import { z } from "zod/v4";
+import { BaseModule } from "./base";
+declare const SetStudioModeEnabledRequestSchema: z.ZodObject<{
+    studioModeEnabled: z.ZodBoolean;
+}, z.core.$strip>;
+declare const OpenInputPropertiesDialogRequestSchema: z.ZodObject<{
+    inputName: z.ZodOptional<z.ZodString>;
+    inputUuid: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+declare const OpenInputFiltersDialogRequestSchema: z.ZodObject<{
+    inputName: z.ZodOptional<z.ZodString>;
+    inputUuid: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+declare const OpenInputInteractDialogRequestSchema: z.ZodObject<{
+    inputName: z.ZodOptional<z.ZodString>;
+    inputUuid: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+declare const OpenVideoMixProjectorRequestSchema: z.ZodObject<{
+    videoMixType: z.ZodString;
+    monitorIndex: z.ZodOptional<z.ZodNumber>;
+    projectorGeometry: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+declare const OpenSourceProjectorRequestSchema: z.ZodObject<{
+    canvasUuid: z.ZodOptional<z.ZodString>;
+    sourceName: z.ZodOptional<z.ZodString>;
+    sourceUuid: z.ZodOptional<z.ZodString>;
+    monitorIndex: z.ZodOptional<z.ZodNumber>;
+    projectorGeometry: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+declare const GetStudioModeEnabledResponseSchema: z.ZodObject<{
+    studioModeEnabled: z.ZodBoolean;
+}, z.core.$strip>;
+declare const GetMonitorListResponseSchema: z.ZodObject<{
+    monitors: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodJSONSchema>>;
+}, z.core.$strip>;
+export type GetStudioModeEnabledResponse = z.infer<typeof GetStudioModeEnabledResponseSchema>;
+export type SetStudioModeEnabledRequest = z.infer<typeof SetStudioModeEnabledRequestSchema>;
+export type OpenInputPropertiesDialogRequest = z.infer<typeof OpenInputPropertiesDialogRequestSchema>;
+export type OpenInputFiltersDialogRequest = z.infer<typeof OpenInputFiltersDialogRequestSchema>;
+export type OpenInputInteractDialogRequest = z.infer<typeof OpenInputInteractDialogRequestSchema>;
+export type GetMonitorListResponse = z.infer<typeof GetMonitorListResponseSchema>;
+export type OpenVideoMixProjectorRequest = z.infer<typeof OpenVideoMixProjectorRequestSchema>;
+export type OpenSourceProjectorRequest = z.infer<typeof OpenSourceProjectorRequestSchema>;
+export declare class UiModule extends BaseModule {
+    getStudioModeEnabled(): Promise<GetStudioModeEnabledResponse>;
+    setStudioModeEnabled(params: SetStudioModeEnabledRequest): Promise<void>;
+    openInputPropertiesDialog(params: OpenInputPropertiesDialogRequest): Promise<void>;
+    openInputFiltersDialog(params: OpenInputFiltersDialogRequest): Promise<void>;
+    openInputInteractDialog(params: OpenInputInteractDialogRequest): Promise<void>;
+    getMonitorList(): Promise<GetMonitorListResponse>;
+    openVideoMixProjector(params: OpenVideoMixProjectorRequest): Promise<void>;
+    openSourceProjector(params: OpenSourceProjectorRequest): Promise<void>;
+}
+export {};
+//# sourceMappingURL=ui.d.ts.map

package/dist/modules/ui.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ui.d.ts","sourceRoot":"","sources":["../../src/modules/ui.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAC;AAC3B,OAAO,EAAE,UAAU,EAAoB,MAAM,QAAQ,CAAC;AAMtD,QAAA,MAAM,iCAAiC;;iBAErC,CAAC;AAEH,QAAA,MAAM,sCAAsC;;;iBAG1C,CAAC;AAEH,QAAA,MAAM,mCAAmC;;;iBAGvC,CAAC;AAEH,QAAA,MAAM,oCAAoC;;;iBAGxC,CAAC;AAEH,QAAA,MAAM,kCAAkC;;;;iBAItC,CAAC;AAEH,QAAA,MAAM,gCAAgC;;;;;;iBAMpC,CAAC;AAMH,QAAA,MAAM,kCAAkC;;iBAEtC,CAAC;AAEH,QAAA,MAAM,4BAA4B;;iBAEhC,CAAC;AAMH,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAC;AAC9F,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iCAAiC,CAAC,CAAC;AAC5F,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sCAAsC,CAAC,CAAC;AACtG,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mCAAmC,CAAC,CAAC;AAChG,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oCAAoC,CAAC,CAAC;AAClG,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAClF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAC;AAC9F,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAC;AAM1F,qBAAa,QAAS,SAAQ,UAAU;IAChC,oBAAoB,IAAI,OAAO,CAAC,4BAA4B,CAAC;IAK7D,oBAAoB,CAAC,MAAM,EAAE,2BAA2B,GAAG,OAAO,CAAC,IAAI,CAAC;IAKxE,yBAAyB,CAAC,MAAM,EAAE,gCAAgC,GAAG,OAAO,CAAC,IAAI,CAAC;IAKlF,sBAAsB,CAAC,MAAM,EAAE,6BAA6B,GAAG,OAAO,CAAC,IAAI,CAAC;IAK5E,uBAAuB,CAAC,MAAM,EAAE,8BAA8B,GAAG,OAAO,CAAC,IAAI,CAAC;IAK9E,cAAc,IAAI,OAAO,CAAC,sBAAsB,CAAC;IAKjD,qBAAqB,CAAC,MAAM,EAAE,4BAA4B,GAAG,OAAO,CAAC,IAAI,CAAC;IAK1E,mBAAmB,CAAC,MAAM,EAAE,0BAA0B,GAAG,OAAO,CAAC,IAAI,CAAC;CAI7E"}

package/dist/modules/ui.js

@@ -0,0 +1,79 @@
+import { z } from "zod/v4";
+import { BaseModule, jsonObjectSchema } from "./base";
+// ========================
+// Request Schemas
+// ========================
+const SetStudioModeEnabledRequestSchema = z.object({
+    studioModeEnabled: z.boolean(),
+});
+const OpenInputPropertiesDialogRequestSchema = z.object({
+    inputName: z.string().optional(),
+    inputUuid: z.string().optional(),
+});
+const OpenInputFiltersDialogRequestSchema = z.object({
+    inputName: z.string().optional(),
+    inputUuid: z.string().optional(),
+});
+const OpenInputInteractDialogRequestSchema = z.object({
+    inputName: z.string().optional(),
+    inputUuid: z.string().optional(),
+});
+const OpenVideoMixProjectorRequestSchema = z.object({
+    videoMixType: z.string(),
+    monitorIndex: z.number().optional(),
+    projectorGeometry: z.string().optional(),
+});
+const OpenSourceProjectorRequestSchema = z.object({
+    canvasUuid: z.string().optional(),
+    sourceName: z.string().optional(),
+    sourceUuid: z.string().optional(),
+    monitorIndex: z.number().optional(),
+    projectorGeometry: z.string().optional(),
+});
+// ========================
+// Response Schemas
+// ========================
+const GetStudioModeEnabledResponseSchema = z.object({
+    studioModeEnabled: z.boolean(),
+});
+const GetMonitorListResponseSchema = z.object({
+    monitors: jsonObjectSchema.array(),
+});
+// ========================
+// Module
+// ========================
+export class UiModule extends BaseModule {
+    async getStudioModeEnabled() {
+        const res = await this.obs.call("GetStudioModeEnabled");
+        return GetStudioModeEnabledResponseSchema.parse(res);
+    }
+    async setStudioModeEnabled(params) {
+        SetStudioModeEnabledRequestSchema.parse(params);
+        await this.obs.call("SetStudioModeEnabled", params);
+    }
+    async openInputPropertiesDialog(params) {
+        OpenInputPropertiesDialogRequestSchema.parse(params);
+        await this.obs.call("OpenInputPropertiesDialog", params);
+    }
+    async openInputFiltersDialog(params) {
+        OpenInputFiltersDialogRequestSchema.parse(params);
+        await this.obs.call("OpenInputFiltersDialog", params);
+    }
+    async openInputInteractDialog(params) {
+        OpenInputInteractDialogRequestSchema.parse(params);
+        await this.obs.call("OpenInputInteractDialog", params);
+    }
+    async getMonitorList() {
+        const res = await this.obs.call("GetMonitorList");
+        return GetMonitorListResponseSchema.parse(res);
+    }
+    async openVideoMixProjector(params) {
+        OpenVideoMixProjectorRequestSchema.parse(params);
+        await this.obs.call("OpenVideoMixProjector", params);
+    }
+    async openSourceProjector(params) {
+        OpenSourceProjectorRequestSchema.parse(params);
+        await this.obs.call("OpenSourceProjector", params);
+    }
+}
+//# sourceMappingURL=ui.js.map

package/dist/modules/ui.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ui.js","sourceRoot":"","sources":["../../src/modules/ui.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAC;AAC3B,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAEtD,2BAA2B;AAC3B,kBAAkB;AAClB,2BAA2B;AAE3B,MAAM,iCAAiC,GAAG,CAAC,CAAC,MAAM,CAAC;IACjD,iBAAiB,EAAE,CAAC,CAAC,OAAO,EAAE;CAC/B,CAAC,CAAC;AAEH,MAAM,sCAAsC,GAAG,CAAC,CAAC,MAAM,CAAC;IACtD,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC,CAAC;AAEH,MAAM,mCAAmC,GAAG,CAAC,CAAC,MAAM,CAAC;IACnD,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC,CAAC;AAEH,MAAM,oCAAoC,GAAG,CAAC,CAAC,MAAM,CAAC;IACpD,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC,CAAC;AAEH,MAAM,kCAAkC,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACzC,CAAC,CAAC;AAEH,MAAM,gCAAgC,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACzC,CAAC,CAAC;AAEH,2BAA2B;AAC3B,mBAAmB;AACnB,2BAA2B;AAE3B,MAAM,kCAAkC,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,iBAAiB,EAAE,CAAC,CAAC,OAAO,EAAE;CAC/B,CAAC,CAAC;AAEH,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,QAAQ,EAAE,gBAAgB,CAAC,KAAK,EAAE;CACnC,CAAC,CAAC;AAeH,2BAA2B;AAC3B,SAAS;AACT,2BAA2B;AAE3B,MAAM,OAAO,QAAS,SAAQ,UAAU;IACtC,KAAK,CAAC,oBAAoB;QACxB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;QACxD,OAAO,kCAAkC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACvD,CAAC;IAED,KAAK,CAAC,oBAAoB,CAAC,MAAmC;QAC5D,iCAAiC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAChD,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,sBAAsB,EAAE,MAAM,CAAC,CAAC;IACtD,CAAC;IAED,KAAK,CAAC,yBAAyB,CAAC,MAAwC;QACtE,sCAAsC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACrD,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,2BAA2B,EAAE,MAAM,CAAC,CAAC;IAC3D,CAAC;IAED,KAAK,CAAC,sBAAsB,CAAC,MAAqC;QAChE,mCAAmC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAClD,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;IACxD,CAAC;IAED,KAAK,CAAC,uBAAuB,CAAC,MAAsC;QAClE,oCAAoC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACnD,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,yBAAyB,EAAE,MAAM,CAAC,CAAC;IACzD,CAAC;IAED,KAAK,CAAC,cAAc;QAClB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAClD,OAAO,4BAA4B,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACjD,CAAC;IAED,KAAK,CAAC,qBAAqB,CAAC,MAAoC;QAC9D,kCAAkC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACjD,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,MAAkC;QAC1D,gCAAgC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC/C,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;IACrD,CAAC;CACF"}

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "obs-ws-sdk",
+  "type": "module",
+  "version": "0.0.1",
+  "description": "支持完整类型安全与运行时验证的 OBS WebSocket TypeScript SDK. TypeScript SDK for OBS WebSocket with full type safety and runtime validation.",
+  "license": "MIT",
+  "homepage": "https://github.com/RSoraM/obs-ws-sdk",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/RSoraM/obs-ws-sdk"
+  },
+  "keywords": [
+    "obs",
+    "obs-websocket",
+    "obs-studio",
+    "streaming",
+    "typescript",
+    "sdk"
+  ],
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "unbuild",
+    "postbuild": "tsc",
+    "dev": "unbuild --stub",
+    "lint": "biome check --write",
+    "prepublishOnly": "pnpm run build",
+    "release": "bumpp && npm publish",
+    "start": "tsx src/index.ts",
+    "test": "vitest",
+    "typecheck": "tsc --noEmit",
+    "prepare": "simple-git-hooks",
+    "test:integration": "npx tsx scripts/integration-test.ts",
+    "test:coverage": "npx tsx scripts/schema-coverage.ts"
+  },
+  "dependencies": {
+    "obs-websocket-js": "^5.0.6",
+    "zod": "^3.24.0"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^2.0.0",
+    "@types/node": "^25.5.0",
+    "bumpp": "^10.1.0",
+    "changelogithub": "^13.0.0",
+    "dotenv": "^17.3.1",
+    "lint-staged": "^16.0.0",
+    "simple-git-hooks": "^2.12.0",
+    "tsx": "^4.19.0",
+    "typescript": "^5.8.0",
+    "unbuild": "^3.5.0",
+    "vitest": "^3.1.0"
+  },
+  "simple-git-hooks": {
+    "pre-commit": "pnpm lint-staged"
+  },
+  "lint-staged": {
+    "*": "biome check --write --no-errors-on-unmatched"
+  },
+  "packageManager": "pnpm@10.6.0"
+}