@datalayer/agent-runtimes 1.5.3 → 1.5.6

package/lib/specs/sceneSchema.js

@@ -116,6 +116,35 @@ export const SCENE_SCHEMA = {
             title: 'RehearsalBeat',
             type: 'object',
         },
+        SceneActor: {
+            additionalProperties: false,
+            description: 'Somebody on a scripted scene: a person, an application, a company — never a team member.',
+            properties: {
+                id: {
+                    description: 'Its id, as the lines name it',
+                    title: 'Id',
+                    type: 'string',
+                },
+                name: {
+                    description: 'The name the audience sees',
+                    title: 'Name',
+                    type: 'string',
+                },
+                face: {
+                    description: 'One emoji, drawn before the name',
+                    title: 'Face',
+                    type: 'string',
+                },
+                is: {
+                    description: 'What it is, in a few words',
+                    title: 'Is',
+                    type: 'string',
+                },
+            },
+            required: ['id', 'name', 'face', 'is'],
+            title: 'SceneActor',
+            type: 'object',
+        },
         SceneAudience: {
             additionalProperties: false,
             description: 'Who may watch and ask, and what an ask may cost.',
@@ -242,6 +271,47 @@ export const SCENE_SCHEMA = {
             title: 'SceneBranch',
             type: 'object',
         },
+        SceneCard: {
+            additionalProperties: false,
+            description: 'What the audience reads on a line: rows and sentences, never a credential.',
+            properties: {
+                kind: {
+                    $ref: '#/$defs/SceneCardKind',
+                },
+                title: {
+                    title: 'Title',
+                    type: 'string',
+                },
+                rows: {
+                    description: 'Its rows: each a label and a value',
+                    items: {
+                        items: {
+                            type: 'string',
+                        },
+                        type: 'array',
+                    },
+                    title: 'Rows',
+                    type: 'array',
+                },
+                lines: {
+                    description: 'Its sentences',
+                    items: {
+                        type: 'string',
+                    },
+                    title: 'Lines',
+                    type: 'array',
+                },
+            },
+            required: ['kind', 'title'],
+            title: 'SceneCard',
+            type: 'object',
+        },
+        SceneCardKind: {
+            description: 'What a card of a scripted line is.',
+            enum: ['found', 'sign-in', 'approval', 'done', 'record'],
+            title: 'SceneCardKind',
+            type: 'string',
+        },
         SceneCastMember: {
             additionalProperties: false,
             description: 'A member of the cast.\n\nOn a staged team, it names a member of the team (`member`) and says only\nhow it appears here (`persona`) and what it is for in this scene\n(`brief`). Written inline — a scene with no `team` — it is the member:\nwhat it is (`app`, `ref` or `server`), its `role`, where it `runs_in`\nand whom it `talks_to`, as a team member says them.',
@@ -370,6 +440,67 @@ export const SCENE_SCHEMA = {
             title: 'SceneDeployment',
             type: 'object',
         },
+        SceneKind: {
+            description: 'What a scene plays: a team, live (`team`), or lines written out (`scripted`).',
+            enum: ['team', 'scripted'],
+            title: 'SceneKind',
+            type: 'string',
+        },
+        SceneLine: {
+            additionalProperties: false,
+            description: 'One line of a scripted scene: who acts, to whom, what they say or do.',
+            properties: {
+                from: {
+                    description: "Who acts: an actor's id",
+                    title: 'From',
+                    type: 'string',
+                },
+                to: {
+                    default: '',
+                    description: 'To whom, when somebody is addressed',
+                    title: 'To',
+                    type: 'string',
+                },
+                says: {
+                    description: 'What they say or do, in a sentence; in quotes when it is said',
+                    title: 'Says',
+                    type: 'string',
+                },
+                card: {
+                    anyOf: [
+                        {
+                            $ref: '#/$defs/SceneCard',
+                        },
+                        {
+                            type: 'null',
+                        },
+                    ],
+                    default: null,
+                    description: 'What the audience reads',
+                },
+                how: {
+                    default: '',
+                    description: "What happened underneath, in a visitor's words",
+                    title: 'How',
+                    type: 'string',
+                },
+                turn: {
+                    anyOf: [
+                        {
+                            $ref: '#/$defs/SceneTurn',
+                        },
+                        {
+                            type: 'null',
+                        },
+                    ],
+                    default: null,
+                    description: "The audience's turn: the scene waits",
+                },
+            },
+            required: ['from', 'says'],
+            title: 'SceneLine',
+            type: 'object',
+        },
         SceneMove: {
             additionalProperties: false,
             description: 'One member asking another over a protocol, or answering the audience.',
@@ -680,6 +811,32 @@ export const SCENE_SCHEMA = {
             title: 'SceneTranscript',
             type: 'object',
         },
+        SceneTurn: {
+            additionalProperties: false,
+            description: "The audience's turn on a scripted line: the scene waits for them.",
+            properties: {
+                yes: {
+                    description: 'What saying yes is called',
+                    title: 'Yes',
+                    type: 'string',
+                },
+                no: {
+                    default: '',
+                    description: 'What saying no is called; none when there is nothing to refuse',
+                    title: 'No',
+                    type: 'string',
+                },
+                declined: {
+                    default: '',
+                    description: 'What happens once they said no: the scene ends there',
+                    title: 'Declined',
+                    type: 'string',
+                },
+            },
+            required: ['yes'],
+            title: 'SceneTurn',
+            type: 'object',
+        },
         StagePosition: {
             additionalProperties: false,
             description: 'Where a member stands: fractions of the box, left to right and top to bottom.',
@@ -757,7 +914,7 @@ export const SCENE_SCHEMA = {
         },
     },
     additionalProperties: false,
-    description: 'Specification for a scene: a team, staged.',
+    description: 'Specification for a scene: a team, staged — or, `kind: scripted`, lines written out.',
     properties: {
         schema: {
             description: 'The version of the spec itself',
@@ -806,6 +963,11 @@ export const SCENE_SCHEMA = {
             title: 'Emoji',
             type: 'string',
         },
+        kind: {
+            $ref: '#/$defs/SceneKind',
+            default: 'team',
+            description: '`team`: a team staged, live; `scripted`: lines written out, played as written, with no team or cast',
+        },
         team: {
             default: '',
             description: 'The team it stages, `id` or `id:version`',
@@ -854,6 +1016,28 @@ export const SCENE_SCHEMA = {
             $ref: '#/$defs/SceneDeployment',
             description: 'Where it plays',
         },
+        actors: {
+            description: "A scripted scene's actors",
+            items: {
+                $ref: '#/$defs/SceneActor',
+            },
+            title: 'Actors',
+            type: 'array',
+        },
+        lines: {
+            description: "A scripted scene's lines, in order",
+            items: {
+                $ref: '#/$defs/SceneLine',
+            },
+            title: 'Lines',
+            type: 'array',
+        },
+        live: {
+            default: '',
+            description: 'A scripted scene: what of it runs on Datalayer today, said honestly',
+            title: 'Live',
+            type: 'string',
+        },
     },
     required: ['id', 'name'],
     title: 'Scene spec',

package/lib/specs/scenes.d.ts

@@ -11,6 +11,10 @@ import type { SceneSpec } from '../types/scenes';
 export declare const CROP_MONITORING_SCENE_0_0_1: SceneSpec;
 export declare const DISASTER_ASSESSMENT_SCENE_0_0_1: SceneSpec;
 export declare const MONTH_END_CLOSE_SCENE_0_0_1: SceneSpec;
+export declare const PAP_A_PERSON_AND_A_COMPANY_SCENE_0_0_1: SceneSpec;
+export declare const PAP_APPROVE_ONCE_SCENE_0_0_1: SceneSpec;
+export declare const PAP_TWO_COMPANIES_SCENE_0_0_1: SceneSpec;
+export declare const PAP_YOUR_APPLICATION_A_COMPANY_SCENE_0_0_1: SceneSpec;
 export declare const SALES_AND_ACCOUNTING_SCENE_0_0_1: SceneSpec;
 export declare const SCENE_CATALOGUE: Record<string, SceneSpec>;
 /** A scene, by `id` or `id:version`, or undefined. */