@datalayer/agent-runtimes 1.3.83 → 1.3.85

package/lib/loop/apps/appspec.js

@@ -3,8 +3,11 @@
  * Distributed under the terms of the Modified BSD License.
  */
 import { BEHAVIOURS } from './rules';
+import { DEFAULT_MAX_FILES, DEFAULT_UPLOAD_MB } from './uploads';
 /** The version of the spec itself. */
 export const APP_SCHEMA = 'loop.app/v1';
+/** The language an application's own words are in, unless it says (LOOP P-26). */
+export const DEFAULT_LANGUAGE = 'en';
 /** The face of an application that has not chosen one. */
 export const DEFAULT_EMOJI = '\u{1F440}';
 export const APP_KINDS = ['chat', 'widget', 'decision', 'worker'];
@@ -124,6 +127,9 @@ export function emptyAppspec(kind = 'chat') {
             starters: [],
             commands: [],
             modes: [],
+            profiles: [],
+            language: DEFAULT_LANGUAGE,
+            translations: {},
             components: [],
             outputs: [],
         },
@@ -170,6 +176,7 @@ const KNOWN_KEYS = [
     'model',
     'skills',
     'backend_tools',
+    'tools',
     'context',
     'contents',
     'connections',
@@ -193,6 +200,19 @@ const KNOWN_KEYS = [
     'avatar',
     'banner',
 ];
+/** Where a check of its code runs (LOOP P-06). */
+const CHECK_STAGES = ['answer', 'tool_call'];
+/** A tool of its own, written in its code (LOOP P-06); a wrong one is said by the checks. */
+function parseTool(data) {
+    return {
+        name: text(data.name),
+        description: text(data.description),
+        parameters: isData(data.parameters)
+            ? data.parameters
+            : { ...NO_HOST_PARAMETERS },
+        does: texts(data.does),
+    };
+}
 function parseConnection(data) {
     return {
         server: text(data.server),
@@ -243,6 +263,67 @@ function parseMode(data) {
     }
     return mode;
 }
+/** A starter, its category said only when it has one (LOOP P-20). */
+function parseStarter(data) {
+    const starter = {
+        label: text(data.label),
+        message: text(data.message),
+    };
+    if (typeof data.category === 'string' && data.category) {
+        starter.category = data.category;
+    }
+    return starter;
+}
+/** One of several assistants in one application (LOOP P-20). */
+function parseProfile(data) {
+    return {
+        id: text(data.id),
+        label: text(data.label),
+        description: text(data.description),
+        instructions: text(data.instructions),
+        model: typeof data.model === 'string' && data.model ? data.model : null,
+        starters: records(data.starters).map(parseStarter),
+    };
+}
+/** Words by key, what is not a word left out. */
+function wordsBy(value) {
+    return Object.fromEntries(Object.entries(isData(value) ? value : {}).filter((entry) => typeof entry[1] === 'string'));
+}
+/** Records by key, what is not one left out. */
+function recordsBy(value) {
+    return Object.fromEntries(Object.entries(isData(value) ? value : {}).filter((entry) => isData(entry[1])));
+}
+const mapValues = (value, map) => Object.fromEntries(Object.entries(value).map(([key, item]) => [key, map(item)]));
+/** An application's words in one other language (LOOP P-26), every key present. */
+function parseTranslation(data) {
+    return {
+        name: text(data.name),
+        description: text(data.description),
+        welcome: text(data.welcome),
+        starters: mapValues(recordsBy(data.starters), starter => ({
+            label: text(starter.label),
+            message: text(starter.message),
+        })),
+        categories: wordsBy(data.categories),
+        settings: mapValues(recordsBy(data.settings), field => ({
+            title: text(field.title),
+            description: text(field.description),
+            options: wordsBy(field.options),
+        })),
+        commands: wordsBy(data.commands),
+        modes: mapValues(recordsBy(data.modes), mode => ({
+            label: text(mode.label),
+            options: mapValues(recordsBy(mode.options), option => ({
+                label: text(option.label),
+                description: text(option.description),
+            })),
+        })),
+        profiles: mapValues(recordsBy(data.profiles), profile => ({
+            label: text(profile.label),
+            description: text(profile.description),
+        })),
+    };
+}
 function parseSurface(data) {
     return {
         protocol: text(data.protocol, DEFAULT_PROTOCOL),
@@ -272,17 +353,124 @@ function parseVoice(data) {
         where: oneOf(voice.where, ['auto', 'device', 'server'], DEFAULT_VOICE.where),
     };
 }
+/** What a person may send without being asked (P-21), as the spec says it. */
+function parseUploads(data) {
+    return {
+        kinds: records(data.kinds).map(kind => ({
+            type: text(kind.type),
+            maxMb: numberOf(kind.max_mb, DEFAULT_UPLOAD_MB),
+        })),
+        maxFiles: numberOf(data.max_files, DEFAULT_MAX_FILES),
+    };
+}
+/** What a page's output may be drawn with (LOOP P-05), and the property of each that shows its value. */
+export const PAGE_OUTPUT_SHOWS = {
+    Text: 'text',
+    Image: 'url',
+    Table: 'rows',
+    Chart: 'points',
+};
+/** The height of a component its developer wrote (P-17), unless it says. */
+export const DEFAULT_CUSTOM_HEIGHT = 240;
+/**
+ * A component its developer wrote (LOOP P-17), as written: its schema and
+ * example kept whole, so that the checks say what is wrong with them.
+ */
+function parseCustomComponent(data) {
+    const component = {
+        name: text(data.name),
+        description: text(data.description),
+        props: isData(data.props)
+            ? JSON.parse(JSON.stringify(data.props))
+            : { type: 'object', properties: {} },
+        shows: texts(data.shows),
+        sends: texts(data.sends),
+        source: text(data.source),
+        integrity: text(data.integrity),
+        height: numberOf(data.height, DEFAULT_CUSTOM_HEIGHT),
+    };
+    if (isData(data.example)) {
+        component.example = JSON.parse(JSON.stringify(data.example));
+    }
+    return component;
+}
+function dumpCustomComponent(component) {
+    const written = new Writer()
+        .text('name', component.name, '\u0000')
+        .text('description', component.description, '\u0000');
+    written.data.props = JSON.parse(JSON.stringify(component.props));
+    written
+        .list('shows', component.shows)
+        .list('sends', component.sends)
+        .text('source', component.source, '\u0000')
+        .text('integrity', component.integrity)
+        .value('height', component.height, DEFAULT_CUSTOM_HEIGHT);
+    if (component.example) {
+        written.data.example = JSON.parse(JSON.stringify(component.example));
+    }
+    return written.data;
+}
+/**
+ * The property a page's output fills with its value (P-05): a catalog
+ * component's (`PAGE_OUTPUT_SHOWS`), or what a component of the
+ * application's own shows first (P-17). Undefined for any other.
+ */
+export function pageOutputShows(component, own = []) {
+    if (component in PAGE_OUTPUT_SHOWS) {
+        return PAGE_OUTPUT_SHOWS[component];
+    }
+    return own.find(each => each.name === component)?.shows[0];
+}
+/**
+ * A widget's page written in its code (P-05), as written: its inputs a form
+ * kept whole, an output drawn with another component kept as written so that
+ * the checks say it.
+ */
+function parsePage(data) {
+    const page = {
+        function: text(data.function),
+        inputs: (isData(data.inputs)
+            ? JSON.parse(JSON.stringify(data.inputs))
+            : {}),
+        outputs: records(data.outputs).map(output => ({
+            name: text(output.name),
+            title: text(output.title),
+            component: text(output.component, 'Text'),
+            props: isData(output.props)
+                ? JSON.parse(JSON.stringify(output.props))
+                : {},
+        })),
+        live: data.live !== false,
+    };
+    if (isData(data.inputs_ui)) {
+        page.inputsUi = JSON.parse(JSON.stringify(data.inputs_ui));
+    }
+    return page;
+}
+function dumpPage(page) {
+    const written = new Writer().text('function', page.function, '\u0000');
+    written.data.inputs = JSON.parse(JSON.stringify(page.inputs));
+    if (page.inputsUi) {
+        written.data.inputs_ui = { ...page.inputsUi };
+    }
+    written.list('outputs', page.outputs.map(output => new Writer()
+        .text('name', output.name, '\u0000')
+        .text('title', output.title)
+        .text('component', output.component, 'Text')
+        .part('props', { ...output.props }).data));
+    return written.value('live', page.live, true).data;
+}
 function parseInterface(data, kind) {
     const parsed = {
         layout: oneOf(data.layout, ['chat', 'page', 'split'], DEFAULT_LAYOUTS[kind]),
         accent: oneOf(data.accent, APP_ACCENTS, 'green'),
         welcome: text(data.welcome),
-        starters: records(data.starters).map(starter => ({
-            label: text(starter.label),
-            message: text(starter.message),
-        })),
+        starters: records(data.starters).map(parseStarter),
         commands: records(data.commands).map(parseCommand),
         modes: records(data.modes).map(parseMode),
+        profiles: records(data.profiles).map(parseProfile),
+        language: text(data.language, DEFAULT_LANGUAGE),
+        translations: mapValues(recordsBy(data.translations), parseTranslation),
         components: texts(data.components),
         voice: parseVoice(data.voice),
         outputs: texts(data.outputs),
@@ -293,9 +481,24 @@ function parseInterface(data, kind) {
     if (isData(data.settings)) {
         parsed.settings = JSON.parse(JSON.stringify(data.settings));
     }
+    // How its settings' fields are drawn (P-20), kept as written: a wrong
+    // widget is said by the checks.
+    if (isData(data.settings_ui)) {
+        parsed.settingsUi = JSON.parse(JSON.stringify(data.settings_ui));
+    }
+    if (isData(data.uploads)) {
+        parsed.uploads = parseUploads(data.uploads);
+    }
+    // Components its developer wrote (P-17): absent when it has none.
+    if (Array.isArray(data.custom_components)) {
+        parsed.customComponents = records(data.custom_components).map(parseCustomComponent);
+    }
     if (isData(data.surface)) {
         parsed.surface = parseSurface(data.surface);
     }
+    if (isData(data.page)) {
+        parsed.page = parsePage(data.page);
+    }
     if (isAssistantCharacterId(data.assistant)) {
         parsed.assistant = data.assistant;
     }
@@ -353,6 +556,11 @@ function parseDeployment(data) {
                 ? {
                     host: {
                         context: texts(data.embedded.host.context),
+                        // Kept as written when said: a value that is none is refused
+                        // by the checks, never read as `claimed` (D-21).
+                        ...(data.embedded.host.user !== undefined
+                            ? { user: text(data.embedded.host.user) }
+                            : {}),
                         functions: records(data.embedded.host.functions).map(fn => ({
                             name: text(fn.name),
                             description: text(fn.description),
@@ -416,6 +624,12 @@ export function parseAppspec(document) {
     const verified = isData(tests.verified) ? tests.verified : {};
     const record = isData(data.record) ? data.record : {};
     const checks = isData(data.checks) ? data.checks : {};
+    // A check of its code runs on an answer or a tool call (LOOP P-06).
+    for (const check of records(checks.code)) {
+        if (!CHECK_STAGES.includes(check.on)) {
+            problems.push(`The check \`${text(check.name)}\` of its code runs on answer or tool_call, not \`${String(check.on)}\`.`);
+        }
+    }
     const keepFor = text(record.keep_for, DEFAULT_KEEP_FOR);
     if (retentionDays(keepFor) === 0) {
         problems.push(`Cannot read the retention \`${keepFor}\`: write 90_days, 18_months or 1_years.`);
@@ -435,6 +649,7 @@ export function parseAppspec(document) {
         model: text(data.model),
         skills: texts(data.skills),
         backendTools: texts(data.backend_tools),
+        tools: records(data.tools).map(parseTool),
         context: texts(data.context),
         contents: texts(data.contents),
         connections: records(data.connections).map(parseConnection),
@@ -457,6 +672,8 @@ export function parseAppspec(document) {
             cases: records(tests.cases).map(testCase => ({
                 ask: text(testCase.ask),
                 expect: text(testCase.expect),
+                // Decided by its code (LOOP P-06), when it names the function.
+                ...(text(testCase.code) ? { code: text(testCase.code) } : {}),
             })),
             verified: {
                 live: texts(verified.live),
@@ -476,6 +693,11 @@ export function parseAppspec(document) {
             guards: texts(checks.guards),
             gates: texts(checks.gates),
             track: text(checks.track),
+            code: records(checks.code).map(check => ({
+                name: text(check.name),
+                on: oneOf(check.on, CHECK_STAGES, 'answer'),
+                description: text(check.description),
+            })),
         },
         deployment: parseDeployment(isData(data.deployment) ? data.deployment : {}),
         goal: text(data.goal),
@@ -557,16 +779,44 @@ function dumpSurface(surface) {
         .text('composed_by', surface.composedBy)
         .text('composed_at', surface.composedAt).data;
 }
+function dumpStarter(starter) {
+    return new Writer()
+        .text('label', starter.label, '\u0000')
+        .text('message', starter.message, '\u0000')
+        .text('category', starter.category ?? '').data;
+}
+/** Words by key, what is empty left out. */
+const saidWords = (words) => Object.fromEntries(Object.entries(words).filter(([, said]) => said !== ''));
+/** One translation as it is written (P-26): only what it says. */
+function dumpTranslation(words) {
+    const parts = (value, dump) => Object.fromEntries(Object.entries(value).map(([key, item]) => [key, dump(item)]));
+    return new Writer()
+        .text('name', words.name)
+        .text('description', words.description)
+        .text('welcome', words.welcome)
+        .part('starters', parts(words.starters, starter => new Writer()
+        .text('label', starter.label)
+        .text('message', starter.message).data))
+        .part('categories', saidWords(words.categories))
+        .part('settings', parts(words.settings, field => new Writer()
+        .text('title', field.title)
+        .text('description', field.description)
+        .part('options', saidWords(field.options)).data))
+        .part('commands', saidWords(words.commands))
+        .part('modes', parts(words.modes, mode => new Writer().text('label', mode.label).part('options', parts(mode.options, option => new Writer()
+        .text('label', option.label)
+        .text('description', option.description).data)).data))
+        .part('profiles', parts(words.profiles, profile => new Writer()
+        .text('label', profile.label)
+        .text('description', profile.description).data)).data;
+}
 function dumpInterface(spec, kind) {
     const writer = new Writer()
         // A layout is written when it is not the one its kind starts with.
         .value('layout', spec.layout, DEFAULT_LAYOUTS[kind])
         .value('accent', spec.accent, 'green')
         .text('welcome', spec.welcome)
-        .list('starters', spec.starters.map(starter => ({
-        label: starter.label,
-        message: starter.message,
-    })))
+        .list('starters', spec.starters.map(dumpStarter))
         .list('commands', spec.commands.map(command => ({
         name: command.name,
         description: command.description,
@@ -587,11 +837,37 @@ function dumpInterface(spec, kind) {
         }
         return written.data;
     }))
-        .part('settings', spec.settings ? { ...spec.settings } : {})
-        .list('components', spec.components);
+        .list('profiles', (spec.profiles ?? []).map(profile => new Writer()
+        .text('id', profile.id, '\u0000')
+        .text('label', profile.label, '\u0000')
+        .text('description', profile.description)
+        .text('instructions', profile.instructions)
+        .text('model', profile.model ?? '')
+        .list('starters', profile.starters.map(dumpStarter)).data))
+        .part('settings', spec.settings ? { ...spec.settings } : {});
+    // How its settings' fields are drawn (P-20): written when said.
+    if (spec.settingsUi) {
+        writer.data.settings_ui = { ...spec.settingsUi };
+    }
+    writer
+        .text('language', spec.language ?? DEFAULT_LANGUAGE, DEFAULT_LANGUAGE)
+        .part('translations', mapValues(spec.translations ?? {}, dumpTranslation));
+    // What a person may send without being asked (P-21): written when said.
+    if (spec.uploads) {
+        writer.data.uploads = new Writer()
+            .list('kinds', spec.uploads.kinds.map(kind => new Writer()
+            .text('type', kind.type, '\u0000')
+            .value('max_mb', kind.maxMb, DEFAULT_UPLOAD_MB).data))
+            .value('max_files', spec.uploads.maxFiles, DEFAULT_MAX_FILES).data;
+    }
+    writer.list('components', spec.components);
+    writer.list('custom_components', (spec.customComponents ?? []).map(dumpCustomComponent));
     if (spec.surface) {
         writer.data.surface = dumpSurface(spec.surface);
     }
+    if (spec.page) {
+        writer.data.page = dumpPage(spec.page);
+    }
     if (spec.assistant) {
         writer.data.assistant = spec.assistant;
     }
@@ -664,6 +940,16 @@ export function dumpAppspec(app) {
         .text('model', app.model)
         .list('skills', app.skills)
         .list('backend_tools', app.backendTools)
+        .list('tools', (app.tools ?? []).map(tool => ({
+        name: tool.name,
+        description: tool.description,
+        // No arguments is what it is unless said.
+        ...(JSON.stringify(tool.parameters) ===
+            JSON.stringify(NO_HOST_PARAMETERS)
+            ? {}
+            : { parameters: tool.parameters }),
+        does: tool.does,
+    })))
         .list('context', app.context)
         .list('contents', app.contents)
         .list('connections', app.connections.map(connection => new Writer()
@@ -692,6 +978,7 @@ export function dumpAppspec(app) {
         .list('cases', app.tests.cases.map(testCase => ({
         ask: testCase.ask,
         expect: testCase.expect,
+        ...(testCase.code ? { code: testCase.code } : {}),
     })))
         .part('verified', new Writer()
         .list('live', app.tests.verified.live)
@@ -704,7 +991,12 @@ export function dumpAppspec(app) {
         .part('checks', new Writer()
         .list('guards', app.checks.guards)
         .list('gates', app.checks.gates)
-        .text('track', app.checks.track).data)
+        .text('track', app.checks.track)
+        .list('code', (app.checks.code ?? []).map(check => ({
+        name: check.name,
+        on: check.on,
+        description: check.description,
+    }))).data)
         .part('deployment', new Writer()
         .present('hosted', app.deployment.hosted &&
         new Writer()
@@ -726,7 +1018,8 @@ export function dumpAppspec(app) {
                     JSON.stringify(NO_HOST_PARAMETERS)
                     ? {}
                     : { parameters: fn.parameters }),
-            }))).data).data).data)
+            })))
+                .value('user', app.deployment.embedded.host.user ?? 'claimed', 'claimed').data).data).data)
         .text('goal', app.goal)
         .list('triggers', app.triggers.map(trigger => new Writer()
         .text('type', trigger.type, '\u0000')

package/lib/loop/apps/checks.d.ts

@@ -14,6 +14,20 @@ export interface AppCheck {
  * UI plugins, by the name a surface gives it.
  */
 export declare const componentNamed: (name: string) => ComponentSpec | undefined;
+/**
+ * What its code declares that agentspecs refuses (LOOP P-06): its tools,
+ * its checks and the tests it decides, each by a Python name, each name
+ * once; a tool says what it does, by class, each class once.
+ */
+export declare function ownCodeProblems(app: AppSpec): string[];
+/**
+ * What agentspecs refuses of a widget's page written in its code (LOOP
+ * P-05): a page that is not a widget's, inputs that are not a form, outputs
+ * of one name twice, drawn with another component, saying in their `props`
+ * what their value fills or lacking what their component needs, and an input
+ * named as a setting — both are on the page at `/inputs/<name>`.
+ */
+export declare function pageProblems(app: AppSpec): string[];
 /** How an organization's own context is named: never a catalogue id (agentspecs' `ORGANIZATION_FRAME_PREFIX`). */
 /**
  * What stops a Form block from asking (LOOP C-16), in agentspecs'