@datalayer/agent-runtimes 1.3.83 → 1.3.84

package/lib/specs/appspecSchema.js

@@ -16,6 +16,12 @@ export const APPSPEC_SCHEMA = {
             title: 'Access',
             type: 'string',
         },
+        ActionClass: {
+            description: 'What a tool does to the world.',
+            enum: ['read', 'write', 'send', 'buy', 'delete', 'publish'],
+            title: 'ActionClass',
+            type: 'string',
+        },
         ActsAs: {
             description: 'In whose name a connection acts.',
             enum: ['owner', 'user'],
@@ -24,7 +30,7 @@ export const APPSPEC_SCHEMA = {
         },
         AppChecks: {
             additionalProperties: false,
-            description: 'Optional: checks from the catalogue, for a builder who wants them.',
+            description: "Optional: checks from the catalogue, for a builder who wants them — and its code's own.",
             properties: {
                 guards: {
                     description: 'Guards, `id` or `id:version`',
@@ -48,10 +54,43 @@ export const APPSPEC_SCHEMA = {
                     title: 'Track',
                     type: 'string',
                 },
+                code: {
+                    description: 'Checks written in its code (`@app.check`), each run at its stage (LOOP P-06)',
+                    items: {
+                        $ref: '#/$defs/AppCodeCheck',
+                    },
+                    title: 'Code',
+                    type: 'array',
+                },
             },
             title: 'AppChecks',
             type: 'object',
         },
+        AppCodeCheck: {
+            additionalProperties: false,
+            description: "A check written in the application's code (LOOP P-06): `@app.check`.\n\nRun at its stage beside the built-in checks and the catalogue's Guards;\nwhat it refuses is said in its own sentence. Without its file nothing\nruns it, and validation says so.",
+            properties: {
+                name: {
+                    description: 'The function of its code that checks, by name',
+                    pattern: '^[A-Za-z_][A-Za-z0-9_]*$',
+                    title: 'Name',
+                    type: 'string',
+                },
+                on: {
+                    $ref: '#/$defs/CheckStage',
+                    description: '`answer` or `tool_call`: where it runs',
+                },
+                description: {
+                    description: 'What it checks, in a sentence a person reads',
+                    minLength: 1,
+                    title: 'Description',
+                    type: 'string',
+                },
+            },
+            required: ['name', 'on', 'description'],
+            title: 'AppCodeCheck',
+            type: 'object',
+        },
         AppCommand: {
             additionalProperties: false,
             description: "A slash command the user picks in the composer (LOOP P-19).\n\nTyping `/` lists the application's commands; picking one sends its\n`prompt`, `{input}` replaced by the words typed after the command.",
@@ -275,6 +314,34 @@ export const APPSPEC_SCHEMA = {
             title: 'AppDeployment',
             type: 'object',
         },
+        AppFieldTranslation: {
+            additionalProperties: false,
+            description: 'A field of the settings in another language.',
+            properties: {
+                title: {
+                    default: '',
+                    description: 'Its title',
+                    title: 'Title',
+                    type: 'string',
+                },
+                description: {
+                    default: '',
+                    description: 'What it is for',
+                    title: 'Description',
+                    type: 'string',
+                },
+                options: {
+                    additionalProperties: {
+                        type: 'string',
+                    },
+                    description: "What each value of its `enum` (or of its items') reads as, by the value; the value is sent",
+                    title: 'Options',
+                    type: 'object',
+                },
+            },
+            title: 'AppFieldTranslation',
+            type: 'object',
+        },
         AppInterface: {
             additionalProperties: false,
             description: 'What the user sees.',
@@ -338,6 +405,14 @@ export const APPSPEC_SCHEMA = {
                     title: 'Modes',
                     type: 'array',
                 },
+                profiles: {
+                    description: 'Several assistants in one application, two at least: the person picks one before the conversation starts — the first unless they do — and keeps it to the end; its instructions, model and starters go with every run (LOOP P-20). None when unsaid',
+                    items: {
+                        $ref: '#/$defs/AppProfile',
+                    },
+                    title: 'Profiles',
+                    type: 'array',
+                },
                 settings: {
                     anyOf: [
                         {
@@ -352,6 +427,46 @@ export const APPSPEC_SCHEMA = {
                     description: "What the user may set: the JSON Schema of a form, an object of named fields, each with its `title` and its `default` (LOOP C-16). Drawn with `@datalayer/primer-rjsf` beside the conversation and on a deployment's Ship card, its values go with every run and are checked by the runtime against the same schema. None when unsaid",
                     title: 'Settings',
                 },
+                settings_ui: {
+                    anyOf: [
+                        {
+                            additionalProperties: true,
+                            type: 'object',
+                        },
+                        {
+                            type: 'null',
+                        },
+                    ],
+                    default: null,
+                    description: "How the settings' fields are drawn, as `@datalayer/primer-rjsf` reads a uiSchema: by field name, its `ui:` options — `ui:widget` one of `select`, `radio`, `range`, `updown`, `switch`, `checkbox`, `text`, `textarea`, `date`, `checkboxes`, `tags` — and `ui:order` (LOOP P-20). Each field's own widget when unsaid",
+                    title: 'Settings Ui',
+                },
+                language: {
+                    default: 'en',
+                    description: 'The language its own words are in, as BCP 47 tags it (`en`, `fr`, `pt-BR`) (LOOP P-26)',
+                    title: 'Language',
+                    type: 'string',
+                },
+                translations: {
+                    additionalProperties: {
+                        $ref: '#/$defs/AppTranslation',
+                    },
+                    description: "What a person reads of it in other languages, by BCP 47 tag: its name, welcome, starters and their categories, settings, commands, modes and profiles. The page shows the person's language when it has it, else its own words (LOOP P-26)",
+                    title: 'Translations',
+                    type: 'object',
+                },
+                uploads: {
+                    anyOf: [
+                        {
+                            $ref: '#/$defs/AppUploads',
+                        },
+                        {
+                            type: 'null',
+                        },
+                    ],
+                    default: null,
+                    description: 'What a person may send in the composer without being asked — images, files, audio — by kind, each with its largest size, and how many at once (LOOP P-21). None when unsaid: the composer offers no attachment, and a file sent with a message is refused',
+                },
                 components: {
                     description: "The components of the catalog the surface may use; the kind's own when empty",
                     items: {
@@ -512,6 +627,48 @@ export const APPSPEC_SCHEMA = {
             title: 'AppModeOption',
             type: 'object',
         },
+        AppModeTranslation: {
+            additionalProperties: false,
+            description: 'A mode in another language.',
+            properties: {
+                label: {
+                    default: '',
+                    description: 'What the switch is called',
+                    title: 'Label',
+                    type: 'string',
+                },
+                options: {
+                    additionalProperties: {
+                        $ref: '#/$defs/AppOptionTranslation',
+                    },
+                    description: 'Its options, by id',
+                    title: 'Options',
+                    type: 'object',
+                },
+            },
+            title: 'AppModeTranslation',
+            type: 'object',
+        },
+        AppOptionTranslation: {
+            additionalProperties: false,
+            description: 'An option of a mode in another language.',
+            properties: {
+                label: {
+                    default: '',
+                    description: 'What the switch says',
+                    title: 'Label',
+                    type: 'string',
+                },
+                description: {
+                    default: '',
+                    description: 'What it changes',
+                    title: 'Description',
+                    type: 'string',
+                },
+            },
+            title: 'AppOptionTranslation',
+            type: 'object',
+        },
         AppPermissions: {
             additionalProperties: false,
             description: 'What the application may reach beside its connections. Nothing, unless said.',
@@ -532,6 +689,80 @@ export const APPSPEC_SCHEMA = {
             title: 'AppPermissions',
             type: 'object',
         },
+        AppProfile: {
+            additionalProperties: false,
+            description: "One of several assistants in one application (LOOP P-20): a variant of its agent.\n\nThe person picks a profile before the conversation starts, and keeps it to\nthe end: its instructions are told to the agent on top of the\napplication's in every run, its model run in place of the application's\n(a mode's model wins over it), and its starters offered in place of the\napplication's.",
+            properties: {
+                id: {
+                    description: 'Its id, what a conversation says it is with',
+                    pattern: '^[a-z][a-z0-9_-]{0,39}$',
+                    title: 'Id',
+                    type: 'string',
+                },
+                label: {
+                    description: 'What the person picks it by',
+                    minLength: 1,
+                    title: 'Label',
+                    type: 'string',
+                },
+                description: {
+                    default: '',
+                    description: 'What it is for, in a sentence, beside its label',
+                    title: 'Description',
+                    type: 'string',
+                },
+                instructions: {
+                    default: '',
+                    description: 'What the agent is told besides its instructions, in every run with this profile',
+                    title: 'Instructions',
+                    type: 'string',
+                },
+                model: {
+                    anyOf: [
+                        {
+                            type: 'string',
+                        },
+                        {
+                            type: 'null',
+                        },
+                    ],
+                    default: null,
+                    description: "The model it runs on, in place of the application's; a mode's model wins over it",
+                    title: 'Model',
+                },
+                starters: {
+                    description: "The first messages it offers, in place of the application's; the application's when empty",
+                    items: {
+                        $ref: '#/$defs/AppStarter',
+                    },
+                    title: 'Starters',
+                    type: 'array',
+                },
+            },
+            required: ['id', 'label'],
+            title: 'AppProfile',
+            type: 'object',
+        },
+        AppProfileTranslation: {
+            additionalProperties: false,
+            description: 'A profile in another language.',
+            properties: {
+                label: {
+                    default: '',
+                    description: 'What the person picks it by',
+                    title: 'Label',
+                    type: 'string',
+                },
+                description: {
+                    default: '',
+                    description: 'What it is for',
+                    title: 'Description',
+                    type: 'string',
+                },
+            },
+            title: 'AppProfileTranslation',
+            type: 'object',
+        },
         AppRecord: {
             additionalProperties: false,
             description: 'What is kept of what the application did, and for how long.',
@@ -648,11 +879,37 @@ export const APPSPEC_SCHEMA = {
                     title: 'Message',
                     type: 'string',
                 },
+                category: {
+                    default: '',
+                    description: 'The heading it is offered under: the starters of one category are shown together, those without one first (LOOP P-20)',
+                    title: 'Category',
+                    type: 'string',
+                },
             },
             required: ['label', 'message'],
             title: 'AppStarter',
             type: 'object',
         },
+        AppStarterTranslation: {
+            additionalProperties: false,
+            description: 'A starter in another language.',
+            properties: {
+                label: {
+                    default: '',
+                    description: 'What the button says',
+                    title: 'Label',
+                    type: 'string',
+                },
+                message: {
+                    default: '',
+                    description: 'What is sent when it is chosen',
+                    title: 'Message',
+                    type: 'string',
+                },
+            },
+            title: 'AppStarterTranslation',
+            type: 'object',
+        },
         AppSurface: {
             additionalProperties: false,
             description: 'The component tree the user meets, over the approved catalog (A2UI).',
@@ -690,7 +947,7 @@ export const APPSPEC_SCHEMA = {
         },
         AppTestCase: {
             additionalProperties: false,
-            description: 'An example of what the application should do, in plain words.',
+            description: "An example of what the application should do, in plain words.\n\nWhen plain words are not enough, its code decides it (LOOP P-06): `code`\nnames the function of the application's `app.py` that is given the\nconversation and says whether it passed — `@app.test` writes it. `expect`\nstill says it in words: without its file, the case is judged by them.",
             properties: {
                 ask: {
                     description: 'What it is asked',
@@ -702,6 +959,13 @@ export const APPSPEC_SCHEMA = {
                     title: 'Expect',
                     type: 'string',
                 },
+                code: {
+                    default: '',
+                    description: 'The function of its code that decides the case, by name, when words are not enough; `expect` says it in words',
+                    pattern: '^(?:[A-Za-z_][A-Za-z0-9_]*)?$',
+                    title: 'Code',
+                    type: 'string',
+                },
             },
             required: ['ask', 'expect'],
             title: 'AppTestCase',
@@ -766,6 +1030,116 @@ export const APPSPEC_SCHEMA = {
             title: 'AppTheme',
             type: 'object',
         },
+        AppTool: {
+            additionalProperties: false,
+            description: "A tool of the application's own, written in its code (LOOP P-06): `@app.tool`.\n\nIts agent calls it as any tool; the rules decide each call by what it\n`does` — a rule may name it, by its name alone — and the Canvas lists it.\nWithout its file the agent is not given it.",
+            properties: {
+                name: {
+                    description: 'Its name: what the agent calls, and a rule names',
+                    pattern: '^[A-Za-z_][A-Za-z0-9_]*$',
+                    title: 'Name',
+                    type: 'string',
+                },
+                description: {
+                    description: 'What it does, for the agent: when to call it',
+                    minLength: 1,
+                    title: 'Description',
+                    type: 'string',
+                },
+                parameters: {
+                    additionalProperties: true,
+                    description: 'The JSON Schema of its arguments, an object; none when unsaid',
+                    title: 'Parameters',
+                    type: 'object',
+                },
+                does: {
+                    description: 'What it does, by class of action (`read`, `write`, `send`…): what the rules decide',
+                    items: {
+                        $ref: '#/$defs/ActionClass',
+                    },
+                    minItems: 1,
+                    title: 'Does',
+                    type: 'array',
+                },
+            },
+            required: ['name', 'description', 'does'],
+            title: 'AppTool',
+            type: 'object',
+        },
+        AppTranslation: {
+            additionalProperties: false,
+            description: "What a person reads of an application, in another language (LOOP P-26).\n\nEach part is keyed by what names it in the spec: a starter by its label,\na category by its words, a setting by its field, a command by its name,\na mode and a profile by their ids. What is not translated is shown in\nthe spec's own words; what is translated is shown, never sent, but a\nstarter's message — the agent is written to in the person's language.",
+            properties: {
+                name: {
+                    default: '',
+                    description: 'Its display name',
+                    title: 'Name',
+                    type: 'string',
+                },
+                description: {
+                    default: '',
+                    description: 'What it does',
+                    title: 'Description',
+                    type: 'string',
+                },
+                welcome: {
+                    default: '',
+                    description: 'What it says first',
+                    title: 'Welcome',
+                    type: 'string',
+                },
+                starters: {
+                    additionalProperties: {
+                        $ref: '#/$defs/AppStarterTranslation',
+                    },
+                    description: "Its starters and its profiles', by their label",
+                    title: 'Starters',
+                    type: 'object',
+                },
+                categories: {
+                    additionalProperties: {
+                        type: 'string',
+                    },
+                    description: "The starters' categories, by their words",
+                    title: 'Categories',
+                    type: 'object',
+                },
+                settings: {
+                    additionalProperties: {
+                        $ref: '#/$defs/AppFieldTranslation',
+                    },
+                    description: 'The fields of its settings, by name',
+                    title: 'Settings',
+                    type: 'object',
+                },
+                commands: {
+                    additionalProperties: {
+                        type: 'string',
+                    },
+                    description: "Its commands' descriptions, by name",
+                    title: 'Commands',
+                    type: 'object',
+                },
+                modes: {
+                    additionalProperties: {
+                        $ref: '#/$defs/AppModeTranslation',
+                    },
+                    description: 'Its modes, by id',
+                    title: 'Modes',
+                    type: 'object',
+                },
+                profiles: {
+                    additionalProperties: {
+                        $ref: '#/$defs/AppProfileTranslation',
+                    },
+                    description: 'Its profiles, by id',
+                    title: 'Profiles',
+                    type: 'object',
+                },
+            },
+            title: 'AppTranslation',
+            type: 'object',
+        },
         AppTrigger: {
             additionalProperties: false,
             description: "What starts a worker's work.",
@@ -809,6 +1183,55 @@ export const APPSPEC_SCHEMA = {
             title: 'AppTrigger',
             type: 'object',
         },
+        AppUploadKind: {
+            additionalProperties: false,
+            description: 'A kind of file a person may send, and how large (LOOP P-21).',
+            properties: {
+                type: {
+                    description: 'A media type (`application/pdf`), a family of them (`image/*`, `audio/*`) or an extension (`.csv`), lowercase',
+                    pattern: '^(?:[a-z0-9][a-z0-9.+-]*/(?:\\*|[a-z0-9][a-z0-9.+-]*)|\\.[a-z0-9][a-z0-9_+-]*)$',
+                    title: 'Type',
+                    type: 'string',
+                },
+                max_mb: {
+                    default: 10,
+                    description: 'The largest file of this kind, in megabytes; 25 at most',
+                    exclusiveMinimum: 0,
+                    maximum: 25,
+                    title: 'Max Mb',
+                    type: 'number',
+                },
+            },
+            required: ['type'],
+            title: 'AppUploadKind',
+            type: 'object',
+        },
+        AppUploads: {
+            additionalProperties: false,
+            description: 'What a person may send in the composer without being asked (LOOP P-21): images, files, audio.\n\nA file of a kind it does not name, larger than its kind takes, or one too\nmany is refused, in a sentence — by the page before it is sent, and by the\nruntime when it is sent all the same.',
+            properties: {
+                kinds: {
+                    description: 'The kinds of file it takes, each with its largest size',
+                    items: {
+                        $ref: '#/$defs/AppUploadKind',
+                    },
+                    minItems: 1,
+                    title: 'Kinds',
+                    type: 'array',
+                },
+                max_files: {
+                    default: 5,
+                    description: 'The most files sent with one message',
+                    maximum: 20,
+                    minimum: 1,
+                    title: 'Max Files',
+                    type: 'integer',
+                },
+            },
+            required: ['kinds'],
+            title: 'AppUploads',
+            type: 'object',
+        },
         AppVerified: {
             additionalProperties: false,
             description: 'What was verified, and how, each in a sentence a person reads (LOOP E-14).\n\nAn example says it on its card and on its page: what was tried live,\nwhat runs on recorded data instead, and what is not verified yet. Said\nby whoever tried it; nothing here is computed.',
@@ -895,6 +1318,12 @@ export const APPSPEC_SCHEMA = {
             title: 'Behaviour',
             type: 'string',
         },
+        CheckStage: {
+            description: 'Where a check of its code runs (LOOP P-06), as the built-in checks do (R-06).',
+            enum: ['answer', 'tool_call'],
+            title: 'CheckStage',
+            type: 'string',
+        },
         CriterionKind: {
             description: 'How a criterion is assessed.',
             enum: ['metric', 'noul', 'choice', 'score'],
@@ -1170,6 +1599,14 @@ export const APPSPEC_SCHEMA = {
             title: 'Backend Tools',
             type: 'array',
         },
+        tools: {
+            description: 'Tools of its own, written in its code (`@app.tool`): the agent calls them, rules decide them',
+            items: {
+                $ref: '#/$defs/AppTool',
+            },
+            title: 'Tools',
+            type: 'array',
+        },
         context: {
             description: "The Frames it works under: the catalogue's, or its organization's own (`org-…`)",
             items: {

package/lib/specs/uiPlugins.js

@@ -949,7 +949,7 @@ export const A2UI_UI_PLUGIN_0_0_1 = {
             category: 'input',
             emoji: '🧾',
             description: 'Several fields asked at once, from a JSON Schema, checked as they are filled and again when they arrive (drawn with @datalayer/primer-rjsf).',
-            version: '1.0.0',
+            version: '1.1.0',
             standard: false,
             properties: {
                 type: 'object',
@@ -965,6 +965,11 @@ export const A2UI_UI_PLUGIN_0_0_1 = {
                         title: 'Fields',
                         description: 'The JSON Schema of what is asked: its fields, their types, what is required.',
                     },
+                    ui: {
+                        type: 'object',
+                        title: 'How its fields are drawn',
+                        description: "By field name, the ui: options @datalayer/primer-rjsf reads (a uiSchema): ui:widget one of select, radio, range, updown, switch, checkbox, text, textarea, date, checkboxes, tags; each field's own widget when unsaid.",
+                    },
                     submit_label: {
                         type: 'string',
                         title: 'Send button',