wicked-crew-api-types 0.116.0 → 0.118.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +80 -1
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -5472,6 +5472,37 @@ export interface SystemSettings {
|
|
|
5472
5472
|
[key: `studio.${string}`]: unknown;
|
|
5473
5473
|
}
|
|
5474
5474
|
|
|
5475
|
+
/**
|
|
5476
|
+
* The demo video's palette from the operator's studio skin (`studio.appearance`): each colour `#rrggbb`. Renderers
|
|
5477
|
+
* use it by default; a storyline's own brand colour or a custom video style overrides it.
|
|
5478
|
+
*/
|
|
5479
|
+
export interface VideoPalette {
|
|
5480
|
+
/** The page ground (title and end cards, the stage behind the app). */
|
|
5481
|
+
canvas: string;
|
|
5482
|
+
/** A raised surface (chips, caption band). */
|
|
5483
|
+
surface: string;
|
|
5484
|
+
/** Primary text. */
|
|
5485
|
+
ink: string;
|
|
5486
|
+
/** Secondary text. */
|
|
5487
|
+
ink2: string;
|
|
5488
|
+
/** Quiet text (kickers, counters). */
|
|
5489
|
+
muted: string;
|
|
5490
|
+
/** Hairlines and inactive progress. */
|
|
5491
|
+
line: string;
|
|
5492
|
+
/** The skin's accent, adjusted per theme and until it reads on `canvas` (≥ 3:1): chapter numbers, highlights, the cursor ring. */
|
|
5493
|
+
accent: string;
|
|
5494
|
+
/** The skin's typeface family name. */
|
|
5495
|
+
font: string;
|
|
5496
|
+
scheme: 'light' | 'dark';
|
|
5497
|
+
}
|
|
5498
|
+
|
|
5499
|
+
/** `GET /appearance/video-palette` → 200. `studio-default` = no skin stored: studio's new-install look. */
|
|
5500
|
+
export interface VideoPaletteResponse {
|
|
5501
|
+
source: 'studio-skin' | 'studio-default';
|
|
5502
|
+
theme: 'dark' | 'light' | 'wicked-light' | 'wicked-dark';
|
|
5503
|
+
palette: VideoPalette;
|
|
5504
|
+
}
|
|
5505
|
+
|
|
5475
5506
|
/**
|
|
5476
5507
|
* `GET /settings` → 200 (api-types 0.38.0 — the body's first named type; the shape `{ settings }`
|
|
5477
5508
|
* is unchanged since 0.1). `path` (additive; DES-L10 PR-L10-6, crew ≥ 0.7.35) is the ABSOLUTE
|
|
@@ -10416,7 +10447,51 @@ export type EditorPermission =
|
|
|
10416
10447
|
| 'network.media'
|
|
10417
10448
|
/** Talk, through studio's host, to an MCP server the operator connected (DES-MCP-INSPECTOR-001).
|
|
10418
10449
|
* No posture rule allows it: the editor's install consent writes its per-build grant. */
|
|
10419
|
-
| 'mcp.session'
|
|
10450
|
+
| 'mcp.session'
|
|
10451
|
+
/** Protocol 2 `theme.set` (DES-EDITOR-PLUGIN-CONTRACT-001 §7.2): change this artifact's theme, as a new version. */
|
|
10452
|
+
| 'artifact.theme';
|
|
10453
|
+
|
|
10454
|
+
/**
|
|
10455
|
+
* A protocol-2 editor's surfaces (DES-EDITOR-PLUGIN-CONTRACT-001 §5.2), as the registry parsed them from its
|
|
10456
|
+
* manifest: defaults filled (`interactive:false`, `aspect:'16:9'`, `actions:[]`, `primary:false`, `maxChars:200`,
|
|
10457
|
+
* `full.default:'simple'`), `options`/`full` null when not declared. The host renders the card, the options tabs
|
|
10458
|
+
* and full screen from this copy (and requires the bundle's `plugin.ready` copy to be the same).
|
|
10459
|
+
*/
|
|
10460
|
+
export interface EditorSurfaces {
|
|
10461
|
+
card: {
|
|
10462
|
+
/** The frame takes pointer and keys inside the card (a protocol-1 inline card never did). */
|
|
10463
|
+
interactive: boolean;
|
|
10464
|
+
/** `auto`: the plugin reports its height (`ui.height`, clamped to 120-560 px). */
|
|
10465
|
+
aspect: '16:9' | '4:3' | 'auto';
|
|
10466
|
+
/** At most 4, drawn by the HOST in the card footer. `plugin` → `host.action {id}`; the others are host verbs. */
|
|
10467
|
+
actions: Array<{ id: string; label: string; primary: boolean; verb: 'plugin' | 'host:export' | 'host:ask' }>;
|
|
10468
|
+
};
|
|
10469
|
+
/** At most 5 tabs, added to the host panel on Options; null = no Options button. */
|
|
10470
|
+
options: { tabs: EditorOptionsTab[] } | null;
|
|
10471
|
+
/** Null = no Full screen button. `modes` null = one mode (no Simple/Advanced toggle). */
|
|
10472
|
+
full: { modes: Array<'simple' | 'advanced'> | null; default: 'simple' | 'advanced' } | null;
|
|
10473
|
+
}
|
|
10474
|
+
|
|
10475
|
+
/** One options tab: a frame of the plugin's (`plugin`) or host-drawn controls (`controls`, at most 12). */
|
|
10476
|
+
export interface EditorOptionsTab {
|
|
10477
|
+
id: string;
|
|
10478
|
+
label: string;
|
|
10479
|
+
render: 'plugin' | 'controls';
|
|
10480
|
+
controls?: EditorControl[];
|
|
10481
|
+
}
|
|
10482
|
+
|
|
10483
|
+
/** A host-drawn control (§5.3, a closed vocabulary). `options` for select/segmented (2-8); `min`/`max`/`step`
|
|
10484
|
+
* for range; `maxChars` for text. */
|
|
10485
|
+
export interface EditorControl {
|
|
10486
|
+
id: string;
|
|
10487
|
+
label: string;
|
|
10488
|
+
type: 'toggle' | 'segmented' | 'select' | 'color' | 'text' | 'range';
|
|
10489
|
+
options?: Array<{ id: string; label: string }>;
|
|
10490
|
+
min?: number;
|
|
10491
|
+
max?: number;
|
|
10492
|
+
step?: number;
|
|
10493
|
+
maxChars?: number;
|
|
10494
|
+
}
|
|
10420
10495
|
|
|
10421
10496
|
/**
|
|
10422
10497
|
* One registered editor, as Settings → Editors renders it. No path is on the wire: the bundle is
|
|
@@ -10436,6 +10511,10 @@ export interface EditorView {
|
|
|
10436
10511
|
kinds: string[];
|
|
10437
10512
|
sizes: Array<'inline' | 'pane' | 'full'>;
|
|
10438
10513
|
panels?: Array<'checks'>;
|
|
10514
|
+
/** Protocol 2 (an editor whose `protocol` lists 2): its declared surfaces, parsed. Absent for a protocol-1
|
|
10515
|
+
* editor, and from a daemon that predates the field (added with api-types 0.117.0; the host then reads
|
|
10516
|
+
* the bundle's `plugin.ready` copy). */
|
|
10517
|
+
surfaces?: EditorSurfaces;
|
|
10439
10518
|
/** Each with the reason shown at install. The GRANTED set is `GET /editors/:id/grants`. */
|
|
10440
10519
|
permissions: Array<{ id: EditorPermission; why: string }>;
|
|
10441
10520
|
/** The full sha256 of the entry file, pinned when the registry read it. */
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "wicked-crew-api-types",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.118.0",
|
|
4
4
|
"description": "The wire contract of the wicked-crew daemon's /api/v1 REST surface and /ws CoreEvent frames \u2014 types only, zero runtime",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"types": "./index.d.ts",
|