@companion-surface/base 0.0.1

package/README.md

@@ -0,0 +1,46 @@
+# @companion-surface/base
+
+Plugin API for writing surface integrations for [Companion](https://github.com/bitfocus/companion).
+
+## Installation
+
+```bash
+yarn add @companion-surface/base
+```
+
+## Usage
+
+Implement the `SurfacePlugin` interface to create a surface integration. Your plugin handles all surfaces of a given type.
+
+```typescript
+import { SurfacePlugin, SurfaceContext } from '@companion-surface/base'
+
+export const MySurfacePlugin: SurfacePlugin = {
+  async init(): Promise<void> {
+    // Initialize your plugin
+  }
+
+  async destroy(): Promise<void> {
+    // Clean up
+  }
+
+  // Implement detection or manual connection methods
+}
+```
+
+Check the [template repository](https://github.com/bitfocus/companion-surface-template-ts) for a complete example.
+
+## Supported Versions
+
+| Companion | Module-base |
+| --------- | ----------- |
+| v4.x      | v1.0        |
+
+## Documentation
+
+- [Generated API docs](https://bitfocus.github.io/companion-surface-api/)
+- [Wiki](https://github.com/bitfocus/companion-surface-api/wiki)
+
+## Development
+
+This package is part of a monorepo. See the root README for development instructions.

package/assets/manifest.schema.json

@@ -0,0 +1,113 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"type": "object",
+	"title": "SurfaceModuleManifest",
+	"properties": {
+		"$schema": {
+			"type": "string"
+		},
+		"type": {
+			"type": "string",
+			"enum": ["surface"],
+			"description": "Type of module. Must be: surface"
+		},
+		"id": {
+			"type": "string",
+			"description": "Unique identifier for the module"
+		},
+		"name": {
+			"type": "string",
+			"description": "Name of the module"
+		},
+		"description": {
+			"type": "string",
+			"description": "Description of the module "
+		},
+		"version": {
+			"type": "string",
+			"description": "Current version of the module"
+		},
+		"isPrerelease": {
+			"type": "boolean",
+			"description": "Is this a pre-release version"
+		},
+		"license": {
+			"type": "string",
+			"description": "SPDX identifier for license of the module"
+		},
+		"repository": {
+			"type": "string",
+			"description": "URL to the source repository"
+		},
+		"bugs": {
+			"type": "string",
+			"description": "URL to bug tracker"
+		},
+		"maintainers": {
+			"type": "array",
+			"description": "List of active maintiners",
+			"uniqueItems": true,
+			"items": {
+				"type": "object",
+				"title": "SurfaceModuleManifestMaintainer",
+				"properties": {
+					"name": {
+						"type": "string"
+					},
+					"email": {
+						"type": "string"
+					},
+					"github": {
+						"type": "string"
+					},
+					"url": {
+						"type": "string"
+					}
+				},
+				"required": ["name"],
+				"additionalProperties": false
+			}
+		},
+		"runtime": {
+			"type": "object",
+			"title": "SurfaceModuleManifestRuntime",
+			"description": "Information on how to execute the module",
+			"properties": {
+				"type": {
+					"type": "string",
+					"description": "Type of the module. Must be: node18 or node22",
+					"enum": ["node22"]
+				},
+				"apiVersion": {
+					"type": "string",
+					"description": "The version of the host-api used"
+				},
+				"entrypoint": {
+					"type": "string",
+					"description": "Entrypoint to pass to the runtime. eg index.js"
+				}
+			},
+			"required": ["type", "apiVersion", "entrypoint"]
+		},
+		"keywords": {
+			"type": "array",
+			"uniqueItems": true,
+			"items": {
+				"type": "string"
+			}
+		}
+	},
+	"required": [
+		"type",
+		"id",
+		"name",
+		"description",
+		"version",
+		"license",
+		"repository",
+		"bugs",
+		"maintainers",
+		"runtime",
+		"keywords"
+	]
+}

package/assets/surface-layout.schema.json

@@ -0,0 +1,109 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"title": "SurfaceSchemaLayoutDefinition",
+	"description": "Schema describing a surface layout: default styling and a map of controls with positions and optional style overrides.",
+	"type": "object",
+	"$defs": {
+		"size": {
+			"title": "SurfaceSchemaBitmapConfig",
+			"description": "Bitmap content dimensions and format.",
+			"type": "object",
+			"properties": {
+				"w": {
+					"description": "Width in pixels (non-negative).",
+					"type": "number",
+					"minimum": 0
+				},
+				"h": {
+					"description": "Height in pixels (non-negative).",
+					"type": "number",
+					"minimum": 0
+				},
+				"format": {
+					"description": "Buffer pixel format",
+					"type": "string",
+					"title": "SurfaceSchemaPixelFormat",
+					"enum": ["rgb", "rgba", "bgr", "bgra"],
+					"default": "rgb"
+				}
+			},
+			"required": ["w", "h"],
+			"additionalProperties": false
+		},
+		"stylePreset": {
+			"title": "SurfaceSchemaControlStylePreset",
+			"description": "Styling options that can be applied to controls. Can be used as the default style or as per-control overrides.",
+			"type": "object",
+			"properties": {
+				"bitmap": {
+					"description": "If set, bitmaps of the specified size will be reported.",
+					"$ref": "#/$defs/size"
+				},
+				"text": {
+					"description": "If true, the control requests text to be reported.",
+					"type": "boolean"
+				},
+				"textStyle": {
+					"description": "If true, the control requests text style properties to be reported",
+					"type": "boolean"
+				},
+				"colors": {
+					"description": "If set, the control requests colours to be reported.",
+					"type": "string",
+					"enum": ["hex", "rgb"]
+				}
+			},
+			"additionalProperties": false
+		}
+	},
+	"properties": {
+		"stylePresets": {
+			"description": "Named collection of style presets. The preset named `default` is required and is used as the fallback style for controls when no `stylePreset` is specified.",
+			"type": "object",
+			"properties": {
+				"default": {
+					"$ref": "#/$defs/stylePreset"
+				}
+			},
+			"patternProperties": {
+				"^.+$": {
+					"$ref": "#/$defs/stylePreset"
+				}
+			},
+			"required": ["default"],
+			"additionalProperties": false
+		},
+		"controls": {
+			"type": "object",
+			"patternProperties": {
+				"^[a-zA-Z0-9\\-\\/]+$": {
+					"title": "SurfaceSchemaControlDefinition",
+					"description": "Single control definition. The id must be unique and may be user facing in logs. Typically the id would be in the form of 1/0, matching the row/column of the control.",
+					"type": "object",
+					"properties": {
+						"row": {
+							"description": "Zero-based row index for layout placement.",
+							"type": "number",
+							"minimum": 0
+						},
+						"column": {
+							"description": "Zero-based column index for layout placement.",
+							"type": "number",
+							"minimum": 0
+						},
+						"stylePreset": {
+							"description": "Optional name of a style preset defined in `stylePresets`. If present, the control will use the named preset instead of the default style.",
+							"type": "string",
+							"pattern": "^.+$"
+						}
+					},
+					"required": ["row", "column"],
+					"additionalProperties": false
+				}
+			},
+			"additionalProperties": false
+		}
+	},
+	"required": ["stylePresets", "controls"],
+	"additionalProperties": false
+}

package/dist/main.d.ts

@@ -0,0 +1,4 @@
+export * from './manifest.js';
+export * from './surface-api/index.js';
+export type * from '../generated/surface-layout.d.ts';
+//# sourceMappingURL=main.d.ts.map

package/dist/main.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA;AAC7B,cAAc,wBAAwB,CAAA;AAEtC,mBAAmB,kCAAkC,CAAA"}

package/dist/main.js

@@ -0,0 +1,3 @@
+export * from './manifest.js';
+export * from './surface-api/index.js';
+//# sourceMappingURL=main.js.map

package/dist/main.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA;AAC7B,cAAc,wBAAwB,CAAA"}

package/dist/manifest.d.ts

@@ -0,0 +1,5 @@
+import type { SurfaceModuleManifest, SurfaceModuleManifestMaintainer, SurfaceModuleManifestRuntime } from '../generated/manifest.d.ts';
+export { SurfaceModuleManifest, SurfaceModuleManifestMaintainer, SurfaceModuleManifestRuntime };
+/** Validate that a manifest looks correctly populated */
+export declare function validateSurfaceManifest(manifest: SurfaceModuleManifest, looseChecks: boolean): void;
+//# sourceMappingURL=manifest.d.ts.map

package/dist/manifest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"manifest.d.ts","sourceRoot":"","sources":["../src/manifest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,qBAAqB,EACrB,+BAA+B,EAC/B,4BAA4B,EAC5B,MAAM,4BAA4B,CAAA;AAKnC,OAAO,EAAE,qBAAqB,EAAE,+BAA+B,EAAE,4BAA4B,EAAE,CAAA;AAE/F,yDAAyD;AACzD,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,qBAAqB,EAAE,WAAW,EAAE,OAAO,GAAG,IAAI,CAiCnG"}

package/dist/manifest.js

@@ -0,0 +1,32 @@
+// @ts-expect-error no typings
+// eslint-disable-next-line n/no-missing-import
+import validateSurfaceManifestSchema from '../generated/validate_manifest.js';
+/** Validate that a manifest looks correctly populated */
+export function validateSurfaceManifest(manifest, looseChecks) {
+    if (manifest.type !== 'surface')
+        throw new Error(`Manifest 'type' must be 'surface'`);
+    if (!looseChecks) {
+        const manifestStr = JSON.stringify(manifest);
+        if (manifestStr.includes('companion-module-your-module-name'))
+            throw new Error(`Manifest incorrectly references template module 'companion-module-your-module-name'`);
+        if (manifestStr.includes('module-shortname'))
+            throw new Error(`Manifest incorrectly references template module 'module-shortname'`);
+        if (manifestStr.includes('A short one line description of your module'))
+            throw new Error(`Manifest incorrectly references template module 'A short one line description of your module'`);
+        if (manifestStr.includes('Your name'))
+            throw new Error(`Manifest incorrectly references template module 'Your name'`);
+        if (manifestStr.includes('Your email'))
+            throw new Error(`Manifest incorrectly references template module 'Your email'`);
+        if (manifestStr.includes('Your company'))
+            throw new Error(`Manifest incorrectly references template module 'Your company'`);
+        if (manifestStr.includes('Your product'))
+            throw new Error(`Manifest incorrectly references template module 'Your product'`);
+    }
+    if (!validateSurfaceManifestSchema(manifest)) {
+        const errors = validateSurfaceManifestSchema.errors;
+        if (!errors)
+            throw new Error(`Manifest failed validation with unknown reason`);
+        throw new Error(`Manifest validation failed: ${JSON.stringify(errors)}`);
+    }
+}
+//# sourceMappingURL=manifest.js.map

package/dist/manifest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"manifest.js","sourceRoot":"","sources":["../src/manifest.ts"],"names":[],"mappings":"AAKA,8BAA8B;AAC9B,+CAA+C;AAC/C,OAAO,6BAA6B,MAAM,mCAAmC,CAAA;AAI7E,yDAAyD;AACzD,MAAM,UAAU,uBAAuB,CAAC,QAA+B,EAAE,WAAoB;IAC5F,IAAI,QAAQ,CAAC,IAAI,KAAK,SAAS;QAAE,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAA;IAErF,IAAI,CAAC,WAAW,EAAE,CAAC;QAClB,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAA;QAC5C,IAAI,WAAW,CAAC,QAAQ,CAAC,mCAAmC,CAAC;YAC5D,MAAM,IAAI,KAAK,CAAC,qFAAqF,CAAC,CAAA;QAEvG,IAAI,WAAW,CAAC,QAAQ,CAAC,kBAAkB,CAAC;YAC3C,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAA;QAEtF,IAAI,WAAW,CAAC,QAAQ,CAAC,6CAA6C,CAAC;YACtE,MAAM,IAAI,KAAK,CAAC,+FAA+F,CAAC,CAAA;QAEjH,IAAI,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC;YACpC,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAA;QAE/E,IAAI,WAAW,CAAC,QAAQ,CAAC,YAAY,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAA;QAEhF,IAAI,WAAW,CAAC,QAAQ,CAAC,cAAc,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAA;QAElF,IAAI,WAAW,CAAC,QAAQ,CAAC,cAAc,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAA;IACnF,CAAC;IAED,IAAI,CAAC,6BAA6B,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC9C,MAAM,MAAM,GAAG,6BAA6B,CAAC,MAAM,CAAA;QACnD,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAA;QAE9E,MAAM,IAAI,KAAK,CAAC,+BAA+B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;IACzE,CAAC;AACF,CAAC"}

package/dist/surface-api/cards.d.ts

@@ -0,0 +1,7 @@
+import type { SurfaceSchemaPixelFormat } from '../../generated/surface-layout.d.ts';
+export interface CardGenerator {
+    generateBasicCard(width: number, height: number, pixelFormat: SurfaceSchemaPixelFormat): Promise<Uint8Array>;
+    generateLcdStripCard(width: number, height: number, pixelFormat: SurfaceSchemaPixelFormat): Promise<Uint8Array>;
+    generateLogoCard(width: number, height: number, pixelFormat: SurfaceSchemaPixelFormat): Promise<Uint8Array>;
+}
+//# sourceMappingURL=cards.d.ts.map

package/dist/surface-api/cards.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cards.d.ts","sourceRoot":"","sources":["../../src/surface-api/cards.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAEnF,MAAM,WAAW,aAAa;IAC7B,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,wBAAwB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAG5G,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,wBAAwB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAE/G,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,wBAAwB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;CAC3G"}

package/dist/surface-api/cards.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=cards.js.map

package/dist/surface-api/cards.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cards.js","sourceRoot":"","sources":["../../src/surface-api/cards.ts"],"names":[],"mappings":""}

package/dist/surface-api/context.d.ts

@@ -0,0 +1,14 @@
+export interface HostCapabilities {
+}
+export interface SurfaceContext {
+    get isLocked(): boolean;
+    get capabilities(): HostCapabilities;
+    disconnect(error: Error): void;
+    keyDownById(controlId: string): void;
+    keyUpById(controlId: string): void;
+    keyDownUpById(controlId: string): void;
+    rotateLeftById(controlId: string): void;
+    rotateRightById(controlId: string): void;
+    sendVariableValue(variable: string, value: any): void;
+}
+//# sourceMappingURL=context.d.ts.map

package/dist/surface-api/context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../src/surface-api/context.ts"],"names":[],"mappings":"AACA,MAAM,WAAW,gBAAgB;CAGhC;AAED,MAAM,WAAW,cAAc;IAC9B,IAAI,QAAQ,IAAI,OAAO,CAAA;IAEvB,IAAI,YAAY,IAAI,gBAAgB,CAAA;IAEpC,UAAU,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;IAE9B,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACpC,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACtC,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACvC,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IAExC,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI,CAAA;CACrD"}

package/dist/surface-api/context.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=context.js.map

package/dist/surface-api/context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../../src/surface-api/context.ts"],"names":[],"mappings":""}

package/dist/surface-api/enums.d.ts

@@ -0,0 +1,2 @@
+export type LogLevel = 'info' | 'warn' | 'error' | 'debug';
+//# sourceMappingURL=enums.d.ts.map

package/dist/surface-api/enums.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../../src/surface-api/enums.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,CAAA"}

package/dist/surface-api/enums.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=enums.js.map

package/dist/surface-api/enums.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enums.js","sourceRoot":"","sources":["../../src/surface-api/enums.ts"],"names":[],"mappings":""}

package/dist/surface-api/index.d.ts

@@ -0,0 +1,8 @@
+export * from './cards.js';
+export * from './context.js';
+export * from './enums.js';
+export * from './instance.js';
+export * from './pincode.js';
+export * from './plugin.js';
+export * from './types.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/surface-api/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/surface-api/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA;AAC1B,cAAc,eAAe,CAAA;AAC7B,cAAc,cAAc,CAAA;AAC5B,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA"}

package/dist/surface-api/index.js

@@ -0,0 +1,8 @@
+export * from './cards.js';
+export * from './context.js';
+export * from './enums.js';
+export * from './instance.js';
+export * from './pincode.js';
+export * from './plugin.js';
+export * from './types.js';
+//# sourceMappingURL=index.js.map

package/dist/surface-api/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/surface-api/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA;AAC1B,cAAc,eAAe,CAAA;AAC7B,cAAc,cAAc,CAAA;AAC5B,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA"}

package/dist/surface-api/instance.d.ts

@@ -0,0 +1,52 @@
+import type { CardGenerator } from './cards.js';
+import type { SurfaceDrawProps, SurfaceId } from './types.js';
+export interface SurfaceInstance {
+    /**
+     * A unique ID for this surface instance
+     * This is typically the serial number
+     */
+    readonly surfaceId: SurfaceId;
+    /**
+     * A user-friendly name for this surface
+     * This should be the product name of the device
+     */
+    readonly productName: string;
+    /**
+     * Initialize the surface for use, called after creation
+     */
+    init(): Promise<void>;
+    /**
+     * Clean up any resources, and close the surface
+     */
+    close(): Promise<void>;
+    /**
+     * When the surface transitions into the ready state
+     * This means that it is about to begin drawing
+     */
+    ready(): Promise<void>;
+    /**
+     * Set the brightness of the display
+     * @param percent 0-100
+     */
+    setBrightness(percent: number): Promise<void>;
+    /**
+     * Clear the display, setting all pixels to black/off
+     */
+    blank(): Promise<void>;
+    /**
+     * Draw to the device
+     * @param signal AbortSignal to cancel the draw operation
+     * @param drawProps Data to draw
+     */
+    draw(signal: AbortSignal, drawProps: SurfaceDrawProps): Promise<void>;
+    onVariableValue?(name: string, value: any): void;
+    showLockedStatus?(locked: boolean, characterCount: number): void;
+    /**
+     * Show a status image on the device, instead of the normal operation
+     * This is typically used for Satellite to show the "connecting" state
+     * @param signal AbortSignal to cancel the status display
+     * @param cardGenerator Card generator to create the status image(s)
+     */
+    showStatus(signal: AbortSignal, cardGenerator: CardGenerator, statusMessage: string): Promise<void>;
+}
+//# sourceMappingURL=instance.d.ts.map

package/dist/surface-api/instance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"instance.d.ts","sourceRoot":"","sources":["../../src/surface-api/instance.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAC/C,OAAO,KAAK,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAE7D,MAAM,WAAW,eAAe;IAC/B;;;OAGG;IACH,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B;;;OAGG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAE5B;;OAEG;IACH,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAErB;;OAEG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAEtB;;;OAGG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAItB;;;OAGG;IACH,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE7C;;OAEG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAEtB;;;;OAIG;IACH,IAAI,CAAC,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAErE,eAAe,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI,CAAA;IAEhD,gBAAgB,CAAC,CAAC,MAAM,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAEhE;;;;;OAKG;IACH,UAAU,CAAC,MAAM,EAAE,WAAW,EAAE,aAAa,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACnG"}

package/dist/surface-api/instance.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=instance.js.map

package/dist/surface-api/instance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"instance.js","sourceRoot":"","sources":["../../src/surface-api/instance.ts"],"names":[],"mappings":""}

package/dist/surface-api/pincode.d.ts

@@ -0,0 +1,40 @@
+import type { ControlId } from './types.js';
+/**
+ * Describe the pincode map for a surface
+ */
+export type SurfacePincodeMap = SurfacePincodeMapPageSingle | SurfacePincodeMapPageMultiple | SurfacePincodeMapCustom;
+/**
+ * An empty pincode map, for surfaces which do a custom pincode entry arrangement
+ */
+export interface SurfacePincodeMapCustom {
+    type: 'custom';
+}
+/**
+ * A pincode map with a single page of buttons
+ */
+export interface SurfacePincodeMapPageSingle extends SurfacePincodeMapPageEntry {
+    type: 'single-page';
+    pincode: ControlId | null;
+}
+/**
+ * A pincode map with multiple pages of buttons
+ */
+export interface SurfacePincodeMapPageMultiple {
+    type: 'multiple-page';
+    pincode: ControlId;
+    nextPage: ControlId;
+    pages: Partial<SurfacePincodeMapPageEntry>[];
+}
+export interface SurfacePincodeMapPageEntry {
+    0: ControlId;
+    1: ControlId;
+    2: ControlId;
+    3: ControlId;
+    4: ControlId;
+    5: ControlId;
+    6: ControlId;
+    7: ControlId;
+    8: ControlId;
+    9: ControlId;
+}
+//# sourceMappingURL=pincode.d.ts.map

package/dist/surface-api/pincode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pincode.d.ts","sourceRoot":"","sources":["../../src/surface-api/pincode.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAE3C;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,2BAA2B,GAAG,6BAA6B,GAAG,uBAAuB,CAAA;AAErH;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACvC,IAAI,EAAE,QAAQ,CAAA;CACd;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,0BAA0B;IAC9E,IAAI,EAAE,aAAa,CAAA;IACnB,OAAO,EAAE,SAAS,GAAG,IAAI,CAAA;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC7C,IAAI,EAAE,eAAe,CAAA;IACrB,OAAO,EAAE,SAAS,CAAA;IAClB,QAAQ,EAAE,SAAS,CAAA;IACnB,KAAK,EAAE,OAAO,CAAC,0BAA0B,CAAC,EAAE,CAAA;CAC5C;AAED,MAAM,WAAW,0BAA0B;IAC1C,CAAC,EAAE,SAAS,CAAA;IACZ,CAAC,EAAE,SAAS,CAAA;IACZ,CAAC,EAAE,SAAS,CAAA;IACZ,CAAC,EAAE,SAAS,CAAA;IACZ,CAAC,EAAE,SAAS,CAAA;IACZ,CAAC,EAAE,SAAS,CAAA;IACZ,CAAC,EAAE,SAAS,CAAA;IACZ,CAAC,EAAE,SAAS,CAAA;IACZ,CAAC,EAAE,SAAS,CAAA;IACZ,CAAC,EAAE,SAAS,CAAA;CACZ"}

package/dist/surface-api/pincode.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=pincode.js.map

package/dist/surface-api/pincode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pincode.js","sourceRoot":"","sources":["../../src/surface-api/pincode.ts"],"names":[],"mappings":""}

package/dist/surface-api/plugin.d.ts

@@ -0,0 +1,75 @@
+import type EventEmitter from 'node:events';
+import type { HIDDevice, OpenSurfaceResult, SurfaceId } from './types.js';
+import { SurfaceContext } from './context.js';
+export interface DiscoveredSurfaceInfo<TInfo> {
+    surfaceId: string;
+    description: string;
+    pluginInfo: TInfo;
+}
+export interface SurfacePluginDetectionEvents<TInfo> {
+    surfacesAdded: [surfaceInfos: DiscoveredSurfaceInfo<TInfo>[]];
+    surfacesRemoved: [surfaceIds: SurfaceId[]];
+}
+/**
+ * For some plugins which only support using a builtin detection mechanism, this can be used to provide the detection info
+ */
+export interface SurfacePluginDetection<TInfo> extends EventEmitter<SurfacePluginDetectionEvents<TInfo>> {
+    /**
+     * Trigger this plugin to perform a scan for any connected surfaces.
+     * This is used when the user triggers a scan, so should refresh any caches when possible
+     */
+    triggerScan(): Promise<void>;
+    /**
+     * When a surface is discovered, but the application has chosen not to open it, this function is called to inform the detection mechanism
+     * You can use this to cleanup any resources/handles for this surface, as it will not be used further
+     * @param surfaceInfo The info about the surface which was rejected
+     */
+    rejectSurface(surfaceInfo: DiscoveredSurfaceInfo<TInfo>): void;
+}
+/**
+ * The base SurfacePlugin interface, for all surface plugins
+ */
+export interface SurfacePlugin<TInfo> {
+    /**
+     * Some plugins are forced to use a builtin detection mechanism by their surfaces or inner library
+     * In this case, this property should be set to an instance of SurfacePluginDetection
+     *
+     * It is preferred that plugins to NOT use this, and to instead use the abtractions we provide to reduce the cost of scanning and detection
+     * Note: it is important that no events are emitted from this until after init() has been invoked, or they will be lost
+     */
+    readonly detection?: SurfacePluginDetection<TInfo>;
+    /**
+     * Initialize the plugin
+     *
+     * This will be called once when the plugin is loaded, before any surfaces or events are used
+     */
+    init(): Promise<void>;
+    /**
+     * Uninitialise the plugin
+     *
+     * This will be called once when the plugin is about to be unloaded. You should reset and close any surfaces here, and prepare for being terminated
+     */
+    destroy(): Promise<void>;
+    /**
+     * Check if a HID device is supported by this plugin
+     * Note: This must not open the device, just perform checks based on the provided info to see if it is supported
+     * @param device HID device to check
+     * @returns Info about the device if it is supported, otherwise null
+     */
+    checkSupportsHidDevice?: (device: HIDDevice) => DiscoveredSurfaceInfo<TInfo> | null;
+    /**
+     * Perform a scan for devices, but not open them
+     * Note: This should only be used if the plugin uses a protocol where we don't have other handling for
+     */
+    scanForSurfaces?: () => Promise<DiscoveredSurfaceInfo<TInfo>[]>;
+    /**
+     * Open a discovered/known surface
+     * This can be called for multiple surfaces in parallel
+     * @param surfaceId Id of the surface
+     * @param pluginInfo Plugin specific info about the surface
+     * @param context Context for the surface
+     * @returns Instance of the surface
+     */
+    openSurface: (surfaceId: string, pluginInfo: TInfo, context: SurfaceContext) => Promise<OpenSurfaceResult>;
+}
+//# sourceMappingURL=plugin.d.ts.map

package/dist/surface-api/plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../src/surface-api/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,YAAY,MAAM,aAAa,CAAA;AAC3C,OAAO,KAAK,EAAE,SAAS,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AACzE,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAE7C,MAAM,WAAW,qBAAqB,CAAC,KAAK;IAC3C,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,KAAK,CAAA;CACjB;AAED,MAAM,WAAW,4BAA4B,CAAC,KAAK;IAClD,aAAa,EAAE,CAAC,YAAY,EAAE,qBAAqB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;IAC7D,eAAe,EAAE,CAAC,UAAU,EAAE,SAAS,EAAE,CAAC,CAAA;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB,CAAC,KAAK,CAAE,SAAQ,YAAY,CAAC,4BAA4B,CAAC,KAAK,CAAC,CAAC;IACvG;;;OAGG;IACH,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAE5B;;;;OAIG;IACH,aAAa,CAAC,WAAW,EAAE,qBAAqB,CAAC,KAAK,CAAC,GAAG,IAAI,CAAA;CAC9D;AAED;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,KAAK;IACnC;;;;;;OAMG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,sBAAsB,CAAC,KAAK,CAAC,CAAA;IAElD;;;;OAIG;IACH,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAErB;;;;OAIG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAExB;;;;;OAKG;IACH,sBAAsB,CAAC,EAAE,CAAC,MAAM,EAAE,SAAS,KAAK,qBAAqB,CAAC,KAAK,CAAC,GAAG,IAAI,CAAA;IAEnF;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;IAE/D;;;;;;;OAOG;IACH,WAAW,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,cAAc,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAA;CAC1G"}

package/dist/surface-api/plugin.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=plugin.js.map

package/dist/surface-api/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../src/surface-api/plugin.ts"],"names":[],"mappings":""}

package/dist/surface-api/types.d.ts

@@ -0,0 +1,85 @@
+import type { SurfacePincodeMap } from './pincode.js';
+import type { SurfaceInstance } from './instance.js';
+import type { SurfaceSchemaLayoutDefinition } from '../../generated/surface-layout.d.ts';
+/**
+ * A representation of a HID device
+ * A simplified form of the HIDDevice from node-hid
+ */
+export interface HIDDevice {
+    vendorId: number;
+    productId: number;
+    serialNumber?: string | undefined;
+    manufacturer?: string | undefined;
+    product?: string | undefined;
+    release: number;
+    interface: number;
+    usagePage?: number | undefined;
+    usage?: number | undefined;
+}
+export type SurfaceId = string;
+export type ControlId = string;
+export interface SurfaceInputVariable {
+    id: string;
+    type: 'input';
+    name: string;
+    description?: string;
+}
+export interface SurfaceOutputVariable {
+    id: string;
+    type: 'output';
+    name: string;
+    description?: string;
+}
+/**
+ * Describes the capabilities of a surface when it is registered
+ */
+export interface SurfaceRegisterProps {
+    /**
+     * Whether the surface supports setting brightness
+     */
+    brightness: boolean;
+    /**
+     * The definition of the controls on the surface and the properties needed for drawing
+     */
+    surfaceLayout: SurfaceSchemaLayoutDefinition;
+    /**
+     * Describes any custom input or output variables for the surface
+     * These are typically used for reporting values such as a tbar or battery level.
+     * Or for providing non-button values such as leds next to a tbar
+     */
+    transferVariables?: Array<SurfaceInputVariable | SurfaceOutputVariable>;
+    /**
+     * If the surface supports pincode entry, this is the desired arrangement of the pin entry buttons
+     */
+    pincodeMap: SurfacePincodeMap | null;
+}
+export interface SurfaceRegisterPropsComplete extends SurfaceRegisterProps {
+    gridSize: GridSize;
+    fallbackBitmapSize: number;
+}
+export interface OpenSurfaceResult {
+    surface: SurfaceInstance;
+    registerProps: SurfaceRegisterProps;
+}
+export interface SurfaceDrawProps {
+    controlId: string;
+    /**
+     * If the surface requested an image to be drawn, this Uint8Array will contain the pixel data in the requested dimensions and format
+     */
+    image?: Uint8Array;
+    /**
+     * If the surface requested a background color, this is the color to display
+     * This is typically only used for surfaces which have buttons with a RGB backlight
+     */
+    color?: string;
+    /**
+     * If the surface requested button text, this is the text to draw
+     * This is typically only used for surfaces which have buttons with text-only displays
+     */
+    text?: string;
+}
+export interface GridSize {
+    rows: number;
+    columns: number;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/surface-api/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/surface-api/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AACrD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AACpD,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,qCAAqC,CAAA;AAExF;;;GAGG;AACH,MAAM,WAAW,SAAS;IACzB,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACjC,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACjC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC5B,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9B,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAC1B;AAED,MAAM,MAAM,SAAS,GAAG,MAAM,CAAA;AAC9B,MAAM,MAAM,SAAS,GAAG,MAAM,CAAA;AAE9B,MAAM,WAAW,oBAAoB;IACpC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,OAAO,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;CACpB;AACD,MAAM,WAAW,qBAAqB;IACrC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,QAAQ,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACpC;;OAEG;IACH,UAAU,EAAE,OAAO,CAAA;IACnB;;OAEG;IACH,aAAa,EAAE,6BAA6B,CAAA;IAC5C;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,oBAAoB,GAAG,qBAAqB,CAAC,CAAA;IACvE;;OAEG;IACH,UAAU,EAAE,iBAAiB,GAAG,IAAI,CAAA;CACpC;AAED,MAAM,WAAW,4BAA6B,SAAQ,oBAAoB;IACzE,QAAQ,EAAE,QAAQ,CAAA;IAClB,kBAAkB,EAAE,MAAM,CAAA;CAC1B;AAED,MAAM,WAAW,iBAAiB;IACjC,OAAO,EAAE,eAAe,CAAA;IACxB,aAAa,EAAE,oBAAoB,CAAA;CACnC;AAED,MAAM,WAAW,gBAAgB;IAChC,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,UAAU,CAAA;IAElB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,QAAQ;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;CACf"}

package/dist/surface-api/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/surface-api/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/surface-api/types.ts"],"names":[],"mappings":""}

package/generated/manifest.d.ts

@@ -0,0 +1,75 @@
+/* eslint-disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export interface SurfaceModuleManifest {
+  $schema?: string;
+  /**
+   * Type of module. Must be: surface
+   */
+  type: "surface";
+  /**
+   * Unique identifier for the module
+   */
+  id: string;
+  /**
+   * Name of the module
+   */
+  name: string;
+  /**
+   * Description of the module
+   */
+  description: string;
+  /**
+   * Current version of the module
+   */
+  version: string;
+  /**
+   * Is this a pre-release version
+   */
+  isPrerelease?: boolean;
+  /**
+   * SPDX identifier for license of the module
+   */
+  license: string;
+  /**
+   * URL to the source repository
+   */
+  repository: string;
+  /**
+   * URL to bug tracker
+   */
+  bugs: string;
+  /**
+   * List of active maintiners
+   */
+  maintainers: SurfaceModuleManifestMaintainer[];
+  runtime: SurfaceModuleManifestRuntime;
+  keywords: string[];
+}
+export interface SurfaceModuleManifestMaintainer {
+  name: string;
+  email?: string;
+  github?: string;
+  url?: string;
+}
+/**
+ * Information on how to execute the module
+ */
+export interface SurfaceModuleManifestRuntime {
+  /**
+   * Type of the module. Must be: node18 or node22
+   */
+  type: "node22";
+  /**
+   * The version of the host-api used
+   */
+  apiVersion: string;
+  /**
+   * Entrypoint to pass to the runtime. eg index.js
+   */
+  entrypoint: string;
+}

package/generated/surface-layout.d.ts

@@ -0,0 +1,82 @@
+/* eslint-disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+/**
+ * Buffer pixel format
+ */
+export type SurfaceSchemaPixelFormat = "rgb" | "rgba" | "bgr" | "bgra";
+
+/**
+ * Schema describing a surface layout: default styling and a map of controls with positions and optional style overrides.
+ */
+export interface SurfaceSchemaLayoutDefinition {
+  /**
+   * Named collection of style presets. The preset named `default` is required and is used as the fallback style for controls when no `stylePreset` is specified.
+   */
+  stylePresets: {
+    default: SurfaceSchemaControlStylePreset;
+    [k: string]: SurfaceSchemaControlStylePreset;
+  };
+  controls: {
+    [k: string]: SurfaceSchemaControlDefinition;
+  };
+}
+/**
+ * Styling options that can be applied to controls. Can be used as the default style or as per-control overrides.
+ *
+ * This interface was referenced by `undefined`'s JSON-Schema definition
+ * via the `patternProperty` "^.+$".
+ */
+export interface SurfaceSchemaControlStylePreset {
+  bitmap?: SurfaceSchemaBitmapConfig;
+  /**
+   * If true, the control requests text to be reported.
+   */
+  text?: boolean;
+  /**
+   * If true, the control requests text style properties to be reported
+   */
+  textStyle?: boolean;
+  /**
+   * If set, the control requests colours to be reported.
+   */
+  colors?: "hex" | "rgb";
+}
+/**
+ * If set, bitmaps of the specified size will be reported.
+ */
+export interface SurfaceSchemaBitmapConfig {
+  /**
+   * Width in pixels (non-negative).
+   */
+  w: number;
+  /**
+   * Height in pixels (non-negative).
+   */
+  h: number;
+  format?: SurfaceSchemaPixelFormat;
+}
+/**
+ * Single control definition. The id must be unique and may be user facing in logs. Typically the id would be in the form of 1/0, matching the row/column of the control.
+ *
+ * This interface was referenced by `undefined`'s JSON-Schema definition
+ * via the `patternProperty` "^[a-zA-Z0-9\-\/]+$".
+ */
+export interface SurfaceSchemaControlDefinition {
+  /**
+   * Zero-based row index for layout placement.
+   */
+  row: number;
+  /**
+   * Zero-based column index for layout placement.
+   */
+  column: number;
+  /**
+   * Optional name of a style preset defined in `stylePresets`. If present, the control will use the named preset instead of the default style.
+   */
+  stylePreset?: string;
+}

package/generated/validate_manifest.js

@@ -0,0 +1 @@
+import { createRequire } from 'module';const require = createRequire(import.meta.url);"use strict";export const validate = validate20;export default validate20;const schema31 = {"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","title":"SurfaceModuleManifest","properties":{"$schema":{"type":"string"},"type":{"type":"string","enum":["surface"],"description":"Type of module. Must be: surface"},"id":{"type":"string","description":"Unique identifier for the module"},"name":{"type":"string","description":"Name of the module"},"description":{"type":"string","description":"Description of the module "},"version":{"type":"string","description":"Current version of the module"},"isPrerelease":{"type":"boolean","description":"Is this a pre-release version"},"license":{"type":"string","description":"SPDX identifier for license of the module"},"repository":{"type":"string","description":"URL to the source repository"},"bugs":{"type":"string","description":"URL to bug tracker"},"maintainers":{"type":"array","description":"List of active maintiners","uniqueItems":true,"items":{"type":"object","title":"SurfaceModuleManifestMaintainer","properties":{"name":{"type":"string"},"email":{"type":"string"},"github":{"type":"string"},"url":{"type":"string"}},"required":["name"],"additionalProperties":false}},"runtime":{"type":"object","title":"SurfaceModuleManifestRuntime","description":"Information on how to execute the module","properties":{"type":{"type":"string","description":"Type of the module. Must be: node18 or node22","enum":["node22"]},"apiVersion":{"type":"string","description":"The version of the host-api used"},"entrypoint":{"type":"string","description":"Entrypoint to pass to the runtime. eg index.js"}},"required":["type","apiVersion","entrypoint"]},"keywords":{"type":"array","uniqueItems":true,"items":{"type":"string"}}},"required":["type","id","name","description","version","license","repository","bugs","maintainers","runtime","keywords"]};const func0 = require("ajv/dist/runtime/equal").default;function validate20(data, {instancePath="", parentData, parentDataProperty, rootData=data, dynamicAnchors={}}={}){let vErrors = null;let errors = 0;const evaluated0 = validate20.evaluated;if(evaluated0.dynamicProps){evaluated0.props = undefined;}if(evaluated0.dynamicItems){evaluated0.items = undefined;}if(errors === 0){if(data && typeof data == "object" && !Array.isArray(data)){let missing0;if((((((((((((data.type === undefined) && (missing0 = "type")) || ((data.id === undefined) && (missing0 = "id"))) || ((data.name === undefined) && (missing0 = "name"))) || ((data.description === undefined) && (missing0 = "description"))) || ((data.version === undefined) && (missing0 = "version"))) || ((data.license === undefined) && (missing0 = "license"))) || ((data.repository === undefined) && (missing0 = "repository"))) || ((data.bugs === undefined) && (missing0 = "bugs"))) || ((data.maintainers === undefined) && (missing0 = "maintainers"))) || ((data.runtime === undefined) && (missing0 = "runtime"))) || ((data.keywords === undefined) && (missing0 = "keywords"))){validate20.errors = [{instancePath,schemaPath:"#/required",keyword:"required",params:{missingProperty: missing0},message:"must have required property '"+missing0+"'"}];return false;}else {if(data.$schema !== undefined){const _errs1 = errors;if(typeof data.$schema !== "string"){validate20.errors = [{instancePath:instancePath+"/$schema",schemaPath:"#/properties/%24schema/type",keyword:"type",params:{type: "string"},message:"must be string"}];return false;}var valid0 = _errs1 === errors;}else {var valid0 = true;}if(valid0){if(data.type !== undefined){let data1 = data.type;const _errs3 = errors;if(typeof data1 !== "string"){validate20.errors = [{instancePath:instancePath+"/type",schemaPath:"#/properties/type/type",keyword:"type",params:{type: "string"},message:"must be string"}];return false;}if(!(data1 === "surface")){validate20.errors = [{instancePath:instancePath+"/type",schemaPath:"#/properties/type/enum",keyword:"enum",params:{allowedValues: schema31.properties.type.enum},message:"must be equal to one of the allowed values"}];return false;}var valid0 = _errs3 === errors;}else {var valid0 = true;}if(valid0){if(data.id !== undefined){const _errs5 = errors;if(typeof data.id !== "string"){validate20.errors = [{instancePath:instancePath+"/id",schemaPath:"#/properties/id/type",keyword:"type",params:{type: "string"},message:"must be string"}];return false;}var valid0 = _errs5 === errors;}else {var valid0 = true;}if(valid0){if(data.name !== undefined){const _errs7 = errors;if(typeof data.name !== "string"){validate20.errors = [{instancePath:instancePath+"/name",schemaPath:"#/properties/name/type",keyword:"type",params:{type: "string"},message:"must be string"}];return false;}var valid0 = _errs7 === errors;}else {var valid0 = true;}if(valid0){if(data.description !== undefined){const _errs9 = errors;if(typeof data.description !== "string"){validate20.errors = [{instancePath:instancePath+"/description",schemaPath:"#/properties/description/type",keyword:"type",params:{type: "string"},message:"must be string"}];return false;}var valid0 = _errs9 === errors;}else {var valid0 = true;}if(valid0){if(data.version !== undefined){const _errs11 = errors;if(typeof data.version !== "string"){validate20.errors = [{instancePath:instancePath+"/version",schemaPath:"#/properties/version/type",keyword:"type",params:{type: "string"},message:"must be string"}];return false;}var valid0 = _errs11 === errors;}else {var valid0 = true;}if(valid0){if(data.isPrerelease !== undefined){const _errs13 = errors;if(typeof data.isPrerelease !== "boolean"){validate20.errors = [{instancePath:instancePath+"/isPrerelease",schemaPath:"#/properties/isPrerelease/type",keyword:"type",params:{type: "boolean"},message:"must be boolean"}];return false;}var valid0 = _errs13 === errors;}else {var valid0 = true;}if(valid0){if(data.license !== undefined){const _errs15 = errors;if(typeof data.license !== "string"){validate20.errors = [{instancePath:instancePath+"/license",schemaPath:"#/properties/license/type",keyword:"type",params:{type: "string"},message:"must be string"}];return false;}var valid0 = _errs15 === errors;}else {var valid0 = true;}if(valid0){if(data.repository !== undefined){const _errs17 = errors;if(typeof data.repository !== "string"){validate20.errors = [{instancePath:instancePath+"/repository",schemaPath:"#/properties/repository/type",keyword:"type",params:{type: "string"},message:"must be string"}];return false;}var valid0 = _errs17 === errors;}else {var valid0 = true;}if(valid0){if(data.bugs !== undefined){const _errs19 = errors;if(typeof data.bugs !== "string"){validate20.errors = [{instancePath:instancePath+"/bugs",schemaPath:"#/properties/bugs/type",keyword:"type",params:{type: "string"},message:"must be string"}];return false;}var valid0 = _errs19 === errors;}else {var valid0 = true;}if(valid0){if(data.maintainers !== undefined){let data10 = data.maintainers;const _errs21 = errors;if(errors === _errs21){if(Array.isArray(data10)){var valid1 = true;const len0 = data10.length;for(let i0=0; i0<len0; i0++){let data11 = data10[i0];const _errs23 = errors;if(errors === _errs23){if(data11 && typeof data11 == "object" && !Array.isArray(data11)){let missing1;if((data11.name === undefined) && (missing1 = "name")){validate20.errors = [{instancePath:instancePath+"/maintainers/" + i0,schemaPath:"#/properties/maintainers/items/required",keyword:"required",params:{missingProperty: missing1},message:"must have required property '"+missing1+"'"}];return false;}else {const _errs25 = errors;for(const key0 in data11){if(!((((key0 === "name") || (key0 === "email")) || (key0 === "github")) || (key0 === "url"))){validate20.errors = [{instancePath:instancePath+"/maintainers/" + i0,schemaPath:"#/properties/maintainers/items/additionalProperties",keyword:"additionalProperties",params:{additionalProperty: key0},message:"must NOT have additional properties"}];return false;break;}}if(_errs25 === errors){if(data11.name !== undefined){const _errs26 = errors;if(typeof data11.name !== "string"){validate20.errors = [{instancePath:instancePath+"/maintainers/" + i0+"/name",schemaPath:"#/properties/maintainers/items/properties/name/type",keyword:"type",params:{type: "string"},message:"must be string"}];return false;}var valid2 = _errs26 === errors;}else {var valid2 = true;}if(valid2){if(data11.email !== undefined){const _errs28 = errors;if(typeof data11.email !== "string"){validate20.errors = [{instancePath:instancePath+"/maintainers/" + i0+"/email",schemaPath:"#/properties/maintainers/items/properties/email/type",keyword:"type",params:{type: "string"},message:"must be string"}];return false;}var valid2 = _errs28 === errors;}else {var valid2 = true;}if(valid2){if(data11.github !== undefined){const _errs30 = errors;if(typeof data11.github !== "string"){validate20.errors = [{instancePath:instancePath+"/maintainers/" + i0+"/github",schemaPath:"#/properties/maintainers/items/properties/github/type",keyword:"type",params:{type: "string"},message:"must be string"}];return false;}var valid2 = _errs30 === errors;}else {var valid2 = true;}if(valid2){if(data11.url !== undefined){const _errs32 = errors;if(typeof data11.url !== "string"){validate20.errors = [{instancePath:instancePath+"/maintainers/" + i0+"/url",schemaPath:"#/properties/maintainers/items/properties/url/type",keyword:"type",params:{type: "string"},message:"must be string"}];return false;}var valid2 = _errs32 === errors;}else {var valid2 = true;}}}}}}}else {validate20.errors = [{instancePath:instancePath+"/maintainers/" + i0,schemaPath:"#/properties/maintainers/items/type",keyword:"type",params:{type: "object"},message:"must be object"}];return false;}}var valid1 = _errs23 === errors;if(!valid1){break;}}if(valid1){let i1 = data10.length;let j0;if(i1 > 1){outer0:for(;i1--;){for(j0 = i1; j0--;){if(func0(data10[i1], data10[j0])){validate20.errors = [{instancePath:instancePath+"/maintainers",schemaPath:"#/properties/maintainers/uniqueItems",keyword:"uniqueItems",params:{i: i1, j: j0},message:"must NOT have duplicate items (items ## "+j0+" and "+i1+" are identical)"}];return false;break outer0;}}}}}}else {validate20.errors = [{instancePath:instancePath+"/maintainers",schemaPath:"#/properties/maintainers/type",keyword:"type",params:{type: "array"},message:"must be array"}];return false;}}var valid0 = _errs21 === errors;}else {var valid0 = true;}if(valid0){if(data.runtime !== undefined){let data16 = data.runtime;const _errs34 = errors;if(errors === _errs34){if(data16 && typeof data16 == "object" && !Array.isArray(data16)){let missing2;if((((data16.type === undefined) && (missing2 = "type")) || ((data16.apiVersion === undefined) && (missing2 = "apiVersion"))) || ((data16.entrypoint === undefined) && (missing2 = "entrypoint"))){validate20.errors = [{instancePath:instancePath+"/runtime",schemaPath:"#/properties/runtime/required",keyword:"required",params:{missingProperty: missing2},message:"must have required property '"+missing2+"'"}];return false;}else {if(data16.type !== undefined){let data17 = data16.type;const _errs36 = errors;if(typeof data17 !== "string"){validate20.errors = [{instancePath:instancePath+"/runtime/type",schemaPath:"#/properties/runtime/properties/type/type",keyword:"type",params:{type: "string"},message:"must be string"}];return false;}if(!(data17 === "node22")){validate20.errors = [{instancePath:instancePath+"/runtime/type",schemaPath:"#/properties/runtime/properties/type/enum",keyword:"enum",params:{allowedValues: schema31.properties.runtime.properties.type.enum},message:"must be equal to one of the allowed values"}];return false;}var valid4 = _errs36 === errors;}else {var valid4 = true;}if(valid4){if(data16.apiVersion !== undefined){const _errs38 = errors;if(typeof data16.apiVersion !== "string"){validate20.errors = [{instancePath:instancePath+"/runtime/apiVersion",schemaPath:"#/properties/runtime/properties/apiVersion/type",keyword:"type",params:{type: "string"},message:"must be string"}];return false;}var valid4 = _errs38 === errors;}else {var valid4 = true;}if(valid4){if(data16.entrypoint !== undefined){const _errs40 = errors;if(typeof data16.entrypoint !== "string"){validate20.errors = [{instancePath:instancePath+"/runtime/entrypoint",schemaPath:"#/properties/runtime/properties/entrypoint/type",keyword:"type",params:{type: "string"},message:"must be string"}];return false;}var valid4 = _errs40 === errors;}else {var valid4 = true;}}}}}else {validate20.errors = [{instancePath:instancePath+"/runtime",schemaPath:"#/properties/runtime/type",keyword:"type",params:{type: "object"},message:"must be object"}];return false;}}var valid0 = _errs34 === errors;}else {var valid0 = true;}if(valid0){if(data.keywords !== undefined){let data20 = data.keywords;const _errs42 = errors;if(errors === _errs42){if(Array.isArray(data20)){var valid5 = true;const len1 = data20.length;for(let i2=0; i2<len1; i2++){const _errs44 = errors;if(typeof data20[i2] !== "string"){validate20.errors = [{instancePath:instancePath+"/keywords/" + i2,schemaPath:"#/properties/keywords/items/type",keyword:"type",params:{type: "string"},message:"must be string"}];return false;}var valid5 = _errs44 === errors;if(!valid5){break;}}if(valid5){let i3 = data20.length;let j1;if(i3 > 1){const indices0 = {};for(;i3--;){let item0 = data20[i3];if(typeof item0 !== "string"){continue;}if(typeof indices0[item0] == "number"){j1 = indices0[item0];validate20.errors = [{instancePath:instancePath+"/keywords",schemaPath:"#/properties/keywords/uniqueItems",keyword:"uniqueItems",params:{i: i3, j: j1},message:"must NOT have duplicate items (items ## "+j1+" and "+i3+" are identical)"}];return false;break;}indices0[item0] = i3;}}}}else {validate20.errors = [{instancePath:instancePath+"/keywords",schemaPath:"#/properties/keywords/type",keyword:"type",params:{type: "array"},message:"must be array"}];return false;}}var valid0 = _errs42 === errors;}else {var valid0 = true;}}}}}}}}}}}}}}}else {validate20.errors = [{instancePath,schemaPath:"#/type",keyword:"type",params:{type: "object"},message:"must be object"}];return false;}}validate20.errors = vErrors;return errors === 0;}validate20.evaluated = {"props":{"$schema":true,"type":true,"id":true,"name":true,"description":true,"version":true,"isPrerelease":true,"license":true,"repository":true,"bugs":true,"maintainers":true,"runtime":true,"keywords":true},"dynamicProps":false,"dynamicItems":false};

package/generated/validate_surface_layout.js

@@ -0,0 +1 @@
+"use strict";export const validate = validate20;export default validate20;const schema31 = {"$schema":"https://json-schema.org/draft/2020-12/schema","title":"SurfaceSchemaLayoutDefinition","description":"Schema describing a surface layout: default styling and a map of controls with positions and optional style overrides.","type":"object","$defs":{"size":{"title":"SurfaceSchemaBitmapConfig","description":"Bitmap content dimensions and format.","type":"object","properties":{"w":{"description":"Width in pixels (non-negative).","type":"number","minimum":0},"h":{"description":"Height in pixels (non-negative).","type":"number","minimum":0},"format":{"description":"Buffer pixel format","type":"string","title":"SurfaceSchemaPixelFormat","enum":["rgb","rgba","bgr","bgra"],"default":"rgb"}},"required":["w","h"],"additionalProperties":false},"stylePreset":{"title":"SurfaceSchemaControlStylePreset","description":"Styling options that can be applied to controls. Can be used as the default style or as per-control overrides.","type":"object","properties":{"bitmap":{"description":"If set, bitmaps of the specified size will be reported.","$ref":"#/$defs/size"},"text":{"description":"If true, the control requests text to be reported.","type":"boolean"},"textStyle":{"description":"If true, the control requests text style properties to be reported","type":"boolean"},"colors":{"description":"If set, the control requests colours to be reported.","type":"string","enum":["hex","rgb"]}},"additionalProperties":false}},"properties":{"stylePresets":{"description":"Named collection of style presets. The preset named `default` is required and is used as the fallback style for controls when no `stylePreset` is specified.","type":"object","properties":{"default":{"$ref":"#/$defs/stylePreset"}},"patternProperties":{"^.+$":{"$ref":"#/$defs/stylePreset"}},"required":["default"],"additionalProperties":false},"controls":{"type":"object","patternProperties":{"^[a-zA-Z0-9\\-\\/]+$":{"title":"SurfaceSchemaControlDefinition","description":"Single control definition. The id must be unique and may be user facing in logs. Typically the id would be in the form of 1/0, matching the row/column of the control.","type":"object","properties":{"row":{"description":"Zero-based row index for layout placement.","type":"number","minimum":0},"column":{"description":"Zero-based column index for layout placement.","type":"number","minimum":0},"stylePreset":{"description":"Optional name of a style preset defined in `stylePresets`. If present, the control will use the named preset instead of the default style.","type":"string","pattern":"^.+$"}},"required":["row","column"],"additionalProperties":false}},"additionalProperties":false}},"required":["stylePresets","controls"],"additionalProperties":false};const pattern4 = new RegExp("^.+$", "u");const pattern6 = new RegExp("^[a-zA-Z0-9\\-\\/]+$", "u");const schema32 = {"title":"SurfaceSchemaControlStylePreset","description":"Styling options that can be applied to controls. Can be used as the default style or as per-control overrides.","type":"object","properties":{"bitmap":{"description":"If set, bitmaps of the specified size will be reported.","$ref":"#/$defs/size"},"text":{"description":"If true, the control requests text to be reported.","type":"boolean"},"textStyle":{"description":"If true, the control requests text style properties to be reported","type":"boolean"},"colors":{"description":"If set, the control requests colours to be reported.","type":"string","enum":["hex","rgb"]}},"additionalProperties":false};const schema33 = {"title":"SurfaceSchemaBitmapConfig","description":"Bitmap content dimensions and format.","type":"object","properties":{"w":{"description":"Width in pixels (non-negative).","type":"number","minimum":0},"h":{"description":"Height in pixels (non-negative).","type":"number","minimum":0},"format":{"description":"Buffer pixel format","type":"string","title":"SurfaceSchemaPixelFormat","enum":["rgb","rgba","bgr","bgra"],"default":"rgb"}},"required":["w","h"],"additionalProperties":false};function validate21(data, {instancePath="", parentData, parentDataProperty, rootData=data, dynamicAnchors={}}={}){let vErrors = null;let errors = 0;const evaluated0 = validate21.evaluated;if(evaluated0.dynamicProps){evaluated0.props = undefined;}if(evaluated0.dynamicItems){evaluated0.items = undefined;}if(errors === 0){if(data && typeof data == "object" && !Array.isArray(data)){const _errs1 = errors;for(const key0 in data){if(!((((key0 === "bitmap") || (key0 === "text")) || (key0 === "textStyle")) || (key0 === "colors"))){validate21.errors = [{instancePath,schemaPath:"#/additionalProperties",keyword:"additionalProperties",params:{additionalProperty: key0},message:"must NOT have additional properties"}];return false;break;}}if(_errs1 === errors){if(data.bitmap !== undefined){let data0 = data.bitmap;const _errs2 = errors;const _errs3 = errors;if(errors === _errs3){if(data0 && typeof data0 == "object" && !Array.isArray(data0)){let missing0;if(((data0.w === undefined) && (missing0 = "w")) || ((data0.h === undefined) && (missing0 = "h"))){validate21.errors = [{instancePath:instancePath+"/bitmap",schemaPath:"#/$defs/size/required",keyword:"required",params:{missingProperty: missing0},message:"must have required property '"+missing0+"'"}];return false;}else {const _errs5 = errors;for(const key1 in data0){if(!(((key1 === "w") || (key1 === "h")) || (key1 === "format"))){validate21.errors = [{instancePath:instancePath+"/bitmap",schemaPath:"#/$defs/size/additionalProperties",keyword:"additionalProperties",params:{additionalProperty: key1},message:"must NOT have additional properties"}];return false;break;}}if(_errs5 === errors){if(data0.w !== undefined){let data1 = data0.w;const _errs6 = errors;if(errors === _errs6){if((typeof data1 == "number") && (isFinite(data1))){if(data1 < 0 || isNaN(data1)){validate21.errors = [{instancePath:instancePath+"/bitmap/w",schemaPath:"#/$defs/size/properties/w/minimum",keyword:"minimum",params:{comparison: ">=", limit: 0},message:"must be >= 0"}];return false;}}else {validate21.errors = [{instancePath:instancePath+"/bitmap/w",schemaPath:"#/$defs/size/properties/w/type",keyword:"type",params:{type: "number"},message:"must be number"}];return false;}}var valid2 = _errs6 === errors;}else {var valid2 = true;}if(valid2){if(data0.h !== undefined){let data2 = data0.h;const _errs8 = errors;if(errors === _errs8){if((typeof data2 == "number") && (isFinite(data2))){if(data2 < 0 || isNaN(data2)){validate21.errors = [{instancePath:instancePath+"/bitmap/h",schemaPath:"#/$defs/size/properties/h/minimum",keyword:"minimum",params:{comparison: ">=", limit: 0},message:"must be >= 0"}];return false;}}else {validate21.errors = [{instancePath:instancePath+"/bitmap/h",schemaPath:"#/$defs/size/properties/h/type",keyword:"type",params:{type: "number"},message:"must be number"}];return false;}}var valid2 = _errs8 === errors;}else {var valid2 = true;}if(valid2){if(data0.format !== undefined){let data3 = data0.format;const _errs10 = errors;if(typeof data3 !== "string"){validate21.errors = [{instancePath:instancePath+"/bitmap/format",schemaPath:"#/$defs/size/properties/format/type",keyword:"type",params:{type: "string"},message:"must be string"}];return false;}if(!((((data3 === "rgb") || (data3 === "rgba")) || (data3 === "bgr")) || (data3 === "bgra"))){validate21.errors = [{instancePath:instancePath+"/bitmap/format",schemaPath:"#/$defs/size/properties/format/enum",keyword:"enum",params:{allowedValues: schema33.properties.format.enum},message:"must be equal to one of the allowed values"}];return false;}var valid2 = _errs10 === errors;}else {var valid2 = true;}}}}}}else {validate21.errors = [{instancePath:instancePath+"/bitmap",schemaPath:"#/$defs/size/type",keyword:"type",params:{type: "object"},message:"must be object"}];return false;}}var valid0 = _errs2 === errors;}else {var valid0 = true;}if(valid0){if(data.text !== undefined){const _errs12 = errors;if(typeof data.text !== "boolean"){validate21.errors = [{instancePath:instancePath+"/text",schemaPath:"#/properties/text/type",keyword:"type",params:{type: "boolean"},message:"must be boolean"}];return false;}var valid0 = _errs12 === errors;}else {var valid0 = true;}if(valid0){if(data.textStyle !== undefined){const _errs14 = errors;if(typeof data.textStyle !== "boolean"){validate21.errors = [{instancePath:instancePath+"/textStyle",schemaPath:"#/properties/textStyle/type",keyword:"type",params:{type: "boolean"},message:"must be boolean"}];return false;}var valid0 = _errs14 === errors;}else {var valid0 = true;}if(valid0){if(data.colors !== undefined){let data6 = data.colors;const _errs16 = errors;if(typeof data6 !== "string"){validate21.errors = [{instancePath:instancePath+"/colors",schemaPath:"#/properties/colors/type",keyword:"type",params:{type: "string"},message:"must be string"}];return false;}if(!((data6 === "hex") || (data6 === "rgb"))){validate21.errors = [{instancePath:instancePath+"/colors",schemaPath:"#/properties/colors/enum",keyword:"enum",params:{allowedValues: schema32.properties.colors.enum},message:"must be equal to one of the allowed values"}];return false;}var valid0 = _errs16 === errors;}else {var valid0 = true;}}}}}}else {validate21.errors = [{instancePath,schemaPath:"#/type",keyword:"type",params:{type: "object"},message:"must be object"}];return false;}}validate21.errors = vErrors;return errors === 0;}validate21.evaluated = {"props":true,"dynamicProps":false,"dynamicItems":false};function validate20(data, {instancePath="", parentData, parentDataProperty, rootData=data, dynamicAnchors={}}={}){let vErrors = null;let errors = 0;const evaluated0 = validate20.evaluated;if(evaluated0.dynamicProps){evaluated0.props = undefined;}if(evaluated0.dynamicItems){evaluated0.items = undefined;}if(errors === 0){if(data && typeof data == "object" && !Array.isArray(data)){let missing0;if(((data.stylePresets === undefined) && (missing0 = "stylePresets")) || ((data.controls === undefined) && (missing0 = "controls"))){validate20.errors = [{instancePath,schemaPath:"#/required",keyword:"required",params:{missingProperty: missing0},message:"must have required property '"+missing0+"'"}];return false;}else {const _errs1 = errors;for(const key0 in data){if(!((key0 === "stylePresets") || (key0 === "controls"))){validate20.errors = [{instancePath,schemaPath:"#/additionalProperties",keyword:"additionalProperties",params:{additionalProperty: key0},message:"must NOT have additional properties"}];return false;break;}}if(_errs1 === errors){if(data.stylePresets !== undefined){let data0 = data.stylePresets;const _errs2 = errors;if(errors === _errs2){if(data0 && typeof data0 == "object" && !Array.isArray(data0)){let missing1;if((data0.default === undefined) && (missing1 = "default")){validate20.errors = [{instancePath:instancePath+"/stylePresets",schemaPath:"#/properties/stylePresets/required",keyword:"required",params:{missingProperty: missing1},message:"must have required property '"+missing1+"'"}];return false;}else {const _errs4 = errors;for(const key1 in data0){if(!((key1 === "default") || (pattern4.test(key1)))){validate20.errors = [{instancePath:instancePath+"/stylePresets",schemaPath:"#/properties/stylePresets/additionalProperties",keyword:"additionalProperties",params:{additionalProperty: key1},message:"must NOT have additional properties"}];return false;break;}}if(_errs4 === errors){if(data0.default !== undefined){const _errs5 = errors;if(!(validate21(data0.default, {instancePath:instancePath+"/stylePresets/default",parentData:data0,parentDataProperty:"default",rootData,dynamicAnchors}))){vErrors = vErrors === null ? validate21.errors : vErrors.concat(validate21.errors);errors = vErrors.length;}var valid1 = _errs5 === errors;}else {var valid1 = true;}if(valid1){var valid2 = true;for(const key2 in data0){if(pattern4.test(key2)){const _errs6 = errors;if(!(validate21(data0[key2], {instancePath:instancePath+"/stylePresets/" + key2.replace(/~/g, "~0").replace(/\//g, "~1"),parentData:data0,parentDataProperty:key2,rootData,dynamicAnchors}))){vErrors = vErrors === null ? validate21.errors : vErrors.concat(validate21.errors);errors = vErrors.length;}var valid2 = _errs6 === errors;if(!valid2){break;}}}}}}}else {validate20.errors = [{instancePath:instancePath+"/stylePresets",schemaPath:"#/properties/stylePresets/type",keyword:"type",params:{type: "object"},message:"must be object"}];return false;}}var valid0 = _errs2 === errors;}else {var valid0 = true;}if(valid0){if(data.controls !== undefined){let data3 = data.controls;const _errs7 = errors;if(errors === _errs7){if(data3 && typeof data3 == "object" && !Array.isArray(data3)){const _errs9 = errors;for(const key3 in data3){if(!(pattern6.test(key3))){validate20.errors = [{instancePath:instancePath+"/controls",schemaPath:"#/properties/controls/additionalProperties",keyword:"additionalProperties",params:{additionalProperty: key3},message:"must NOT have additional properties"}];return false;break;}}if(_errs9 === errors){var valid3 = true;for(const key4 in data3){if(pattern6.test(key4)){let data4 = data3[key4];const _errs10 = errors;if(errors === _errs10){if(data4 && typeof data4 == "object" && !Array.isArray(data4)){let missing2;if(((data4.row === undefined) && (missing2 = "row")) || ((data4.column === undefined) && (missing2 = "column"))){validate20.errors = [{instancePath:instancePath+"/controls/" + key4.replace(/~/g, "~0").replace(/\//g, "~1"),schemaPath:"#/properties/controls/patternProperties/%5E%5Ba-zA-Z0-9%5C-%5C~1%5D%2B%24/required",keyword:"required",params:{missingProperty: missing2},message:"must have required property '"+missing2+"'"}];return false;}else {const _errs12 = errors;for(const key5 in data4){if(!(((key5 === "row") || (key5 === "column")) || (key5 === "stylePreset"))){validate20.errors = [{instancePath:instancePath+"/controls/" + key4.replace(/~/g, "~0").replace(/\//g, "~1"),schemaPath:"#/properties/controls/patternProperties/%5E%5Ba-zA-Z0-9%5C-%5C~1%5D%2B%24/additionalProperties",keyword:"additionalProperties",params:{additionalProperty: key5},message:"must NOT have additional properties"}];return false;break;}}if(_errs12 === errors){if(data4.row !== undefined){let data5 = data4.row;const _errs13 = errors;if(errors === _errs13){if((typeof data5 == "number") && (isFinite(data5))){if(data5 < 0 || isNaN(data5)){validate20.errors = [{instancePath:instancePath+"/controls/" + key4.replace(/~/g, "~0").replace(/\//g, "~1")+"/row",schemaPath:"#/properties/controls/patternProperties/%5E%5Ba-zA-Z0-9%5C-%5C~1%5D%2B%24/properties/row/minimum",keyword:"minimum",params:{comparison: ">=", limit: 0},message:"must be >= 0"}];return false;}}else {validate20.errors = [{instancePath:instancePath+"/controls/" + key4.replace(/~/g, "~0").replace(/\//g, "~1")+"/row",schemaPath:"#/properties/controls/patternProperties/%5E%5Ba-zA-Z0-9%5C-%5C~1%5D%2B%24/properties/row/type",keyword:"type",params:{type: "number"},message:"must be number"}];return false;}}var valid4 = _errs13 === errors;}else {var valid4 = true;}if(valid4){if(data4.column !== undefined){let data6 = data4.column;const _errs15 = errors;if(errors === _errs15){if((typeof data6 == "number") && (isFinite(data6))){if(data6 < 0 || isNaN(data6)){validate20.errors = [{instancePath:instancePath+"/controls/" + key4.replace(/~/g, "~0").replace(/\//g, "~1")+"/column",schemaPath:"#/properties/controls/patternProperties/%5E%5Ba-zA-Z0-9%5C-%5C~1%5D%2B%24/properties/column/minimum",keyword:"minimum",params:{comparison: ">=", limit: 0},message:"must be >= 0"}];return false;}}else {validate20.errors = [{instancePath:instancePath+"/controls/" + key4.replace(/~/g, "~0").replace(/\//g, "~1")+"/column",schemaPath:"#/properties/controls/patternProperties/%5E%5Ba-zA-Z0-9%5C-%5C~1%5D%2B%24/properties/column/type",keyword:"type",params:{type: "number"},message:"must be number"}];return false;}}var valid4 = _errs15 === errors;}else {var valid4 = true;}if(valid4){if(data4.stylePreset !== undefined){let data7 = data4.stylePreset;const _errs17 = errors;if(errors === _errs17){if(typeof data7 === "string"){if(!pattern4.test(data7)){validate20.errors = [{instancePath:instancePath+"/controls/" + key4.replace(/~/g, "~0").replace(/\//g, "~1")+"/stylePreset",schemaPath:"#/properties/controls/patternProperties/%5E%5Ba-zA-Z0-9%5C-%5C~1%5D%2B%24/properties/stylePreset/pattern",keyword:"pattern",params:{pattern: "^.+$"},message:"must match pattern \""+"^.+$"+"\""}];return false;}}else {validate20.errors = [{instancePath:instancePath+"/controls/" + key4.replace(/~/g, "~0").replace(/\//g, "~1")+"/stylePreset",schemaPath:"#/properties/controls/patternProperties/%5E%5Ba-zA-Z0-9%5C-%5C~1%5D%2B%24/properties/stylePreset/type",keyword:"type",params:{type: "string"},message:"must be string"}];return false;}}var valid4 = _errs17 === errors;}else {var valid4 = true;}}}}}}else {validate20.errors = [{instancePath:instancePath+"/controls/" + key4.replace(/~/g, "~0").replace(/\//g, "~1"),schemaPath:"#/properties/controls/patternProperties/%5E%5Ba-zA-Z0-9%5C-%5C~1%5D%2B%24/type",keyword:"type",params:{type: "object"},message:"must be object"}];return false;}}var valid3 = _errs10 === errors;if(!valid3){break;}}}}}else {validate20.errors = [{instancePath:instancePath+"/controls",schemaPath:"#/properties/controls/type",keyword:"type",params:{type: "object"},message:"must be object"}];return false;}}var valid0 = _errs7 === errors;}else {var valid0 = true;}}}}}else {validate20.errors = [{instancePath,schemaPath:"#/type",keyword:"type",params:{type: "object"},message:"must be object"}];return false;}}validate20.errors = vErrors;return errors === 0;}validate20.evaluated = {"props":true,"dynamicProps":false,"dynamicItems":false};

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@companion-surface/base",
+  "version": "0.0.1",
+  "type": "module",
+  "license": "MIT",
+  "repository": "https://github.com/bitfocus/companion-surface-api",
+  "exports": {
+    ".": {
+      "import": "./dist/main.js",
+      "require": "./dist/main.js"
+    },
+    "./package.json": {
+      "import": "./package.json",
+      "require": "./package.json"
+    }
+  },
+  "scripts": {
+    "docs:html": "typedoc --tsconfig tsconfig.build.json --entryPoints src/main.ts --excludePrivate --theme default --out docs"
+  },
+  "engines": {
+    "node": "^22.14"
+  },
+  "files": [
+    "README.md",
+    "CHANGELOG.md",
+    "dist",
+    "generated",
+    "assets",
+    "lib"
+  ],
+  "dependencies": {
+    "ajv": "^8.17.1",
+    "tslib": "^2.8.1"
+  },
+  "devDependencies": {
+    "typedoc": "^0.28.14"
+  }
+}