Skip to content

Feat: Improve json schema #407

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rjmunro wants to merge 2 commits into
base: release53
Choose a base branch
from
Open

Feat: Improve json schema #407

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0a9f81d
feat: Improve headers of generated schemas
rjmunro Sep 23, 2025
2bfc824
fix: Allow schema reference in mappings
rjmunro Sep 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/timeline-state-resolver-api/$schemas/mapping-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
"description": "This is a meta-schema that defines the schemas for *device*/$schemas/mappings.json",
"type": "object",
"properties": {
"$schema": {
"description": "The $schema property is the schema that this file adheres to",
"type": "string"
},
"default": {
"description": "The default mapping to use when creating a new mapping for this device",
"type": "string"
Expand Down
6 changes: 4 additions & 2 deletions packages/timeline-state-resolver-tools/bin/schema-types.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,9 @@ if (!searchPath || !outputPath) {
}

const BANNER =
'/* eslint-disable */\n/**\n * This file was automatically generated by json-schema-to-typescript.\n * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,\n * and re-run the "tsr-schema-types" tool to regenerate this file.\n */\n'
'/* eslint-disable */\n/**\n * This file was automatically generated by json-schema-to-typescript.\n * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,\n * and run "yarn generate-schema-types" regenerate this file.\n */\n'
const BANNER_WITH_SOURCE =
'/* eslint-disable */\n/**\n * This file was automatically generated by json-schema-to-typescript from [source].\n * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,\n * and run "yarn generate-schema-types" regenerate this file.\n */\n'

let hadError = false

Expand Down Expand Up @@ -450,7 +452,7 @@ export interface DeviceOptions${dirId} extends DeviceOptionsBase<${dirId}Options
// Output to tsr types package
const outputFilePath = path.join(resolvedOutputPath, dir + '.ts')
if (output) {
output = BANNER + output
output = BANNER_WITH_SOURCE.replace('[source]', 'src/$schemas/generated/' + dir) + output

await fs.writeFile(outputFilePath, output)

Expand Down
4 changes: 2 additions & 2 deletions packages/timeline-state-resolver-types/src/generated/abstract.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/* eslint-disable */
/**
* This file was automatically generated by json-schema-to-typescript.
* This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/abstract.
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
* and re-run the "tsr-schema-types" tool to regenerate this file.
* and run "yarn generate-schema-types" regenerate this file.
*/
import type { ActionExecutionResult } from "../actions"

Expand Down
2 changes: 1 addition & 1 deletion packages/timeline-state-resolver-types/src/generated/action-schema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
/**
* This file was automatically generated by json-schema-to-typescript.
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
* and re-run the "tsr-schema-types" tool to regenerate this file.
* and run "yarn generate-schema-types" regenerate this file.
*/

export interface TSRActionSchema {
Expand Down
4 changes: 2 additions & 2 deletions packages/timeline-state-resolver-types/src/generated/atem.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/* eslint-disable */
/**
* This file was automatically generated by json-schema-to-typescript.
* This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/atem.
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
* and re-run the "tsr-schema-types" tool to regenerate this file.
* and run "yarn generate-schema-types" regenerate this file.
*/
import type { ActionExecutionResult } from "../actions"

Expand Down
4 changes: 2 additions & 2 deletions packages/timeline-state-resolver-types/src/generated/casparCG.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/* eslint-disable */
/**
* This file was automatically generated by json-schema-to-typescript.
* This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/casparCG.
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
* and re-run the "tsr-schema-types" tool to regenerate this file.
* and run "yarn generate-schema-types" regenerate this file.
*/
import type { ActionExecutionResult } from "../actions"

Expand Down
2 changes: 1 addition & 1 deletion packages/timeline-state-resolver-types/src/generated/common-options.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
/**
* This file was automatically generated by json-schema-to-typescript.
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
* and re-run the "tsr-schema-types" tool to regenerate this file.
* and run "yarn generate-schema-types" regenerate this file.
*/

export interface DeviceCommonOptions {
Expand Down
2 changes: 1 addition & 1 deletion packages/timeline-state-resolver-types/src/generated/device-options.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
/**
* This file was automatically generated by json-schema-to-typescript.
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
* and re-run the "tsr-schema-types" tool to regenerate this file.
* and run "yarn generate-schema-types" regenerate this file.
*/

import type { DeviceOptionsBase } from '../device'
Expand Down
2 changes: 1 addition & 1 deletion packages/timeline-state-resolver-types/src/generated/generic-ptz-actions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
/**
* This file was automatically generated by json-schema-to-typescript.
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
* and re-run the "tsr-schema-types" tool to regenerate this file.
* and run "yarn generate-schema-types" regenerate this file.
*/


Expand Down
4 changes: 2 additions & 2 deletions packages/timeline-state-resolver-types/src/generated/httpSend.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/* eslint-disable */
/**
* This file was automatically generated by json-schema-to-typescript.
* This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/httpSend.
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
* and re-run the "tsr-schema-types" tool to regenerate this file.
* and run "yarn generate-schema-types" regenerate this file.
*/
import type { ActionExecutionResult } from "../actions"

Expand Down
4 changes: 2 additions & 2 deletions packages/timeline-state-resolver-types/src/generated/httpWatcher.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/* eslint-disable */
/**
* This file was automatically generated by json-schema-to-typescript.
* This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/httpWatcher.
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
* and re-run the "tsr-schema-types" tool to regenerate this file.
* and run "yarn generate-schema-types" regenerate this file.
*/

export interface HttpWatcherOptions {
Expand Down
4 changes: 2 additions & 2 deletions packages/timeline-state-resolver-types/src/generated/hyperdeck.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/* eslint-disable */
/**
* This file was automatically generated by json-schema-to-typescript.
* This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/hyperdeck.
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
* and re-run the "tsr-schema-types" tool to regenerate this file.
* and run "yarn generate-schema-types" regenerate this file.
*/
import type { ActionExecutionResult } from "../actions"

Expand Down
2 changes: 1 addition & 1 deletion packages/timeline-state-resolver-types/src/generated/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
/**
* This file was automatically generated by json-schema-to-typescript.
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
* and re-run the "tsr-schema-types" tool to regenerate this file.
* and run "yarn generate-schema-types" regenerate this file.
*/

export * from './action-schema'
Expand Down
4 changes: 2 additions & 2 deletions packages/timeline-state-resolver-types/src/generated/lawo.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/* eslint-disable */
/**
* This file was automatically generated by json-schema-to-typescript.
* This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/lawo.
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
* and re-run the "tsr-schema-types" tool to regenerate this file.
* and run "yarn generate-schema-types" regenerate this file.
*/

export interface LawoOptions {
Expand Down
4 changes: 2 additions & 2 deletions packages/timeline-state-resolver-types/src/generated/multiOsc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/* eslint-disable */
/**
* This file was automatically generated by json-schema-to-typescript.
* This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/multiOsc.
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
* and re-run the "tsr-schema-types" tool to regenerate this file.
* and run "yarn generate-schema-types" regenerate this file.
*/

export interface MultiOscOptions {
Expand Down
4 changes: 2 additions & 2 deletions packages/timeline-state-resolver-types/src/generated/obs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/* eslint-disable */
/**
* This file was automatically generated by json-schema-to-typescript.
* This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/obs.
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
* and re-run the "tsr-schema-types" tool to regenerate this file.
* and run "yarn generate-schema-types" regenerate this file.
*/

export interface ObsOptions {
Expand Down
4 changes: 2 additions & 2 deletions packages/timeline-state-resolver-types/src/generated/osc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/* eslint-disable */
/**
* This file was automatically generated by json-schema-to-typescript.
* This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/osc.
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
* and re-run the "tsr-schema-types" tool to regenerate this file.
* and run "yarn generate-schema-types" regenerate this file.
*/

export interface OscOptions {
Expand Down
4 changes: 2 additions & 2 deletions packages/timeline-state-resolver-types/src/generated/panasonicPTZ.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/* eslint-disable */
/**
* This file was automatically generated by json-schema-to-typescript.
* This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/panasonicPTZ.
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
* and re-run the "tsr-schema-types" tool to regenerate this file.
* and run "yarn generate-schema-types" regenerate this file.
*/
import type { ActionExecutionResult } from "../actions"
import type { SetPanTiltSpeedPayload, GetPanTiltPositionResult, SetZoomSpeedPayload, GetZoomPositionResult, StorePresetPayload, RecallPresetPayload, ResetPresetPayload, SetFocusSpeedPayload, SetFocusModePayload, GetFocusPositionResult, GetFocusModeResult } from './generic-ptz-actions'
Expand Down
4 changes: 2 additions & 2 deletions packages/timeline-state-resolver-types/src/generated/pharos.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/* eslint-disable */
/**
* This file was automatically generated by json-schema-to-typescript.
* This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/pharos.
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
* and re-run the "tsr-schema-types" tool to regenerate this file.
* and run "yarn generate-schema-types" regenerate this file.
*/

export interface PharosOptions {
Expand Down
4 changes: 2 additions & 2 deletions packages/timeline-state-resolver-types/src/generated/quantel.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/* eslint-disable */
/**
* This file was automatically generated by json-schema-to-typescript.
* This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/quantel.
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
* and re-run the "tsr-schema-types" tool to regenerate this file.
* and run "yarn generate-schema-types" regenerate this file.
*/
import type { ActionExecutionResult } from "../actions"

Expand Down
4 changes: 2 additions & 2 deletions packages/timeline-state-resolver-types/src/generated/shotoku.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/* eslint-disable */
/**
* This file was automatically generated by json-schema-to-typescript.
* This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/shotoku.
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
* and re-run the "tsr-schema-types" tool to regenerate this file.
* and run "yarn generate-schema-types" regenerate this file.
*/

export interface ShotokuOptions {
Expand Down
4 changes: 2 additions & 2 deletions packages/timeline-state-resolver-types/src/generated/singularLive.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/* eslint-disable */
/**
* This file was automatically generated by json-schema-to-typescript.
* This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/singularLive.
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
* and re-run the "tsr-schema-types" tool to regenerate this file.
* and run "yarn generate-schema-types" regenerate this file.
*/

export interface SingularLiveOptions {
Expand Down
4 changes: 2 additions & 2 deletions packages/timeline-state-resolver-types/src/generated/sisyfos.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/* eslint-disable */
/**
* This file was automatically generated by json-schema-to-typescript.
* This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/sisyfos.
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
* and re-run the "tsr-schema-types" tool to regenerate this file.
* and run "yarn generate-schema-types" regenerate this file.
*/
import type { ActionExecutionResult } from "../actions"

Expand Down
4 changes: 2 additions & 2 deletions packages/timeline-state-resolver-types/src/generated/sofieChef.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/* eslint-disable */
/**
* This file was automatically generated by json-schema-to-typescript.
* This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/sofieChef.
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
* and re-run the "tsr-schema-types" tool to regenerate this file.
* and run "yarn generate-schema-types" regenerate this file.
*/
import type { ActionExecutionResult } from "../actions"

Expand Down
4 changes: 2 additions & 2 deletions packages/timeline-state-resolver-types/src/generated/tcpSend.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/* eslint-disable */
/**
* This file was automatically generated by json-schema-to-typescript.
* This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/tcpSend.
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
* and re-run the "tsr-schema-types" tool to regenerate this file.
* and run "yarn generate-schema-types" regenerate this file.
*/
import type { ActionExecutionResult } from "../actions"

Expand Down
4 changes: 2 additions & 2 deletions packages/timeline-state-resolver-types/src/generated/telemetrics.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/* eslint-disable */
/**
* This file was automatically generated by json-schema-to-typescript.
* This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/telemetrics.
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
* and re-run the "tsr-schema-types" tool to regenerate this file.
* and run "yarn generate-schema-types" regenerate this file.
*/

export interface TelemetricsOptions {
Expand Down
4 changes: 2 additions & 2 deletions packages/timeline-state-resolver-types/src/generated/tricaster.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/* eslint-disable */
/**
* This file was automatically generated by json-schema-to-typescript.
* This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/tricaster.
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
* and re-run the "tsr-schema-types" tool to regenerate this file.
* and run "yarn generate-schema-types" regenerate this file.
*/

export interface TricasterOptions {
Expand Down
4 changes: 2 additions & 2 deletions packages/timeline-state-resolver-types/src/generated/viscaOverIP.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/* eslint-disable */
/**
* This file was automatically generated by json-schema-to-typescript.
* This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/viscaOverIP.
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
* and re-run the "tsr-schema-types" tool to regenerate this file.
* and run "yarn generate-schema-types" regenerate this file.
*/
import type { ActionExecutionResult } from "../actions"
import type { SetPanTiltSpeedPayload, GetPanTiltPositionResult, SetZoomSpeedPayload, GetZoomPositionResult, StorePresetPayload, RecallPresetPayload, ResetPresetPayload, SetFocusSpeedPayload, SetFocusModePayload, GetFocusPositionResult, GetFocusModeResult } from './generic-ptz-actions'
Expand Down
4 changes: 2 additions & 2 deletions packages/timeline-state-resolver-types/src/generated/vizMSE.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/* eslint-disable */
/**
* This file was automatically generated by json-schema-to-typescript.
* This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/vizMSE.
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
* and re-run the "tsr-schema-types" tool to regenerate this file.
* and run "yarn generate-schema-types" regenerate this file.
*/
import type { ActionExecutionResult } from "../actions"

Expand Down
4 changes: 2 additions & 2 deletions packages/timeline-state-resolver-types/src/generated/vmix.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/* eslint-disable */
/**
* This file was automatically generated by json-schema-to-typescript.
* This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/vmix.
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
* and re-run the "tsr-schema-types" tool to regenerate this file.
* and run "yarn generate-schema-types" regenerate this file.
*/
import type { ActionExecutionResult } from "../actions"

Expand Down
4 changes: 2 additions & 2 deletions packages/timeline-state-resolver-types/src/generated/websocketClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
/* eslint-disable */
/**
* This file was automatically generated by json-schema-to-typescript.
* This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/websocketClient.
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
* and re-run the "tsr-schema-types" tool to regenerate this file.
* and run "yarn generate-schema-types" regenerate this file.
*/
import type { ActionExecutionResult } from "../actions"

Expand Down
2 changes: 1 addition & 1 deletion packages/timeline-state-resolver/src/manifest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
/**
* This file was automatically generated by json-schema-to-typescript.
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
* and re-run the "tsr-schema-types" tool to regenerate this file.
* and run "yarn generate-schema-types" regenerate this file.
*/

import { DeviceType } from 'timeline-state-resolver-types'
Expand Down
Loading