@datalayer/agent-runtimes 1.3.84 → 1.3.86

package/lib/loop/apps/AppRenderer.js

@@ -58,6 +58,7 @@ import { LoopEmbed } from '../embed/LoopEmbed';
 import { dumpAppspec } from './appspec';
 import { defineAppActivityPlugin } from '../plugins/app-activity';
 import { AppElementsPlugin } from '../plugins/app-elements';
+import { defineAppComponentsPlugin, hasCustomComponents, } from '../plugins/app-components';
 import { defineAppComputerPlugin } from '../plugins/app-computer';
 import { defineAppRulesPlugin } from '../plugins/app-rules';
 import { defineAppComposerPlugin, needsAppComposer, startersAsOpeners, } from './AppComposer';
@@ -67,6 +68,7 @@ import { defineAppFeedbackPlugin } from './AppFeedback';
 import { defineAppKeptPlugin } from './AppKept';
 import { keepsFeedback } from './feedback';
 import { keptBeforeFirstMessage } from './kept';
+import { ChatLanguage } from '../../chat/ChatLanguage';
 /** The id of an agent or a Cog, without its version. */
 export const agentIdOf = (app) => {
     const reference = app.agent || app.team;
@@ -167,7 +169,8 @@ export function appLayoutOptions(app) {
  *   whose contributions are the blocks it may draw (R-01b); a thumb and a
  *   comment on each answer when its record keeps feedback (V-18); its
  *   commands in the composer's `/` menu and its modes beside it (P-19); the
- *   side panel and the pages its code opens (`app-elements`, P-18); what it
+ *   side panel and the pages its code opens (`app-elements`, P-18); the
+ *   components its developer wrote (`app-components`, P-17); what it
  *   keeps and for how long, under its prompt before the first message, when
  *   `kept` says it (R-31); with
  *   `sidebar`, its rules and approvals card, its activity feed and its
@@ -203,6 +206,9 @@ export function appPreset(app, options = {}) {
         plugins: [
             defineAppPlugin(app, shown),
             ...(withPage ? [defineAppPagePlugin(shown), ...blocks] : []),
+            // The components its developer wrote (LOOP P-17): blocks of its page
+            // and renderers of its page, its elements and its answers — its own.
+            ...(hasCustomComponents(app) ? [defineAppComponentsPlugin(app)] : []),
             // Its commands in the composer's `/` menu, its modes and its profiles
             // beside the composer (LOOP P-19, P-20) and what a person may attach
             // there (P-21): only for an application that has some.
@@ -385,31 +391,34 @@ export function AppRenderer({ app, plugins = NO_PLUGINS, instance, onPresence, o
     if ('problem' in preset) {
         return (_jsx("div", { role: "status", style: { padding: 16 }, children: preset.problem }));
     }
-    return (_jsx(LoopEmbed
-    // The application's own agent: created under its id, so that its
-    // spec is applied to an agent of its own, never to the one it extends.
-    , { 
+    return (
+    // The chat's own words in the person's language too (P-26): the host's,
+    // else the browser's.
+    _jsx(ChatLanguage, { language: language, children: _jsx(LoopEmbed
         // The application's own agent: created under its id, so that its
         // spec is applied to an agent of its own, never to the one it extends.
-        agentId: app.id, ...preset.workspace, ...(frame
-            ? {
-                frameTitle: [app.emoji, shown.name].filter(Boolean).join(' '),
-            }
-            : {}), 
-        // Its rules, activity and computer on a rail, one at a time (T-07).
-        sidebarRail: sidebar || computer, teamPicker: false, showAgentVariants: false, graph: false, pluginsPanel: false, datalayerAgentSpecId: DATALAYER_BOOTSTRAP_AGENTSPEC, 
-        // Where an application runs is decided by its host — the Studio's
-        // Preview, the hosted page — not offered to its user.
-        targetFixed: true, ...(named ? { themeVariant: named.variant } : {}), ...(namedMode ? { colorMode: namedMode } : {}), themeOverrides: themeOverrides, 
-        // Its own face, name and welcome in the chat (T-08); no counters: a
-        // person using an application is not asking about tokens.
-        presence: {
-            name: shown.name,
-            face: app.emoji,
-            welcome: shown.interface.welcome || shown.description,
-            paused,
-            onPresence,
-            onSaying,
-        }, showTokenUsage: false, datalayerCreatePayload: datalayerCreatePayload, ...embed, plugins: allPlugins }));
+        , { 
+            // The application's own agent: created under its id, so that its
+            // spec is applied to an agent of its own, never to the one it extends.
+            agentId: app.id, ...preset.workspace, ...(frame
+                ? {
+                    frameTitle: [app.emoji, shown.name].filter(Boolean).join(' '),
+                }
+                : {}), 
+            // Its rules, activity and computer on a rail, one at a time (T-07).
+            sidebarRail: sidebar || computer, teamPicker: false, showAgentVariants: false, graph: false, pluginsPanel: false, datalayerAgentSpecId: DATALAYER_BOOTSTRAP_AGENTSPEC, 
+            // Where an application runs is decided by its host — the Studio's
+            // Preview, the hosted page — not offered to its user.
+            targetFixed: true, ...(named ? { themeVariant: named.variant } : {}), ...(namedMode ? { colorMode: namedMode } : {}), themeOverrides: themeOverrides, 
+            // Its own face, name and welcome in the chat (T-08); no counters: a
+            // person using an application is not asking about tokens.
+            presence: {
+                name: shown.name,
+                face: app.emoji,
+                welcome: shown.interface.welcome || shown.description,
+                paused,
+                onPresence,
+                onSaying,
+            }, showTokenUsage: false, datalayerCreatePayload: datalayerCreatePayload, ...embed, plugins: allPlugins }) }));
 }
 export default AppRenderer;

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

@@ -24,7 +24,7 @@
  *
  * @module loop/apps/appspec
  */
-import type { AppAccent, AppThemeMode, AppThemeVariant, AppAssistantCharacter, AppEmbedMode, AppVoiceSpec, AppKind, AppLayout, AppSpec } from '../../types/agentspecs';
+import type { AppAccent, AppThemeMode, AppThemeVariant, AppAssistantCharacter, AppEmbedMode, AppCustomComponentSpec, AppVoiceSpec, AppKind, AppLayout, AppPageOutputComponent, AppSpec } from '../../types/agentspecs';
 /** The version of the spec itself. */
 export declare const APP_SCHEMA = "loop.app/v1";
 /** The language an application's own words are in, unless it says (LOOP P-26). */
@@ -62,6 +62,16 @@ export declare function retentionDays(keepFor: string): number;
 export declare function emptyAppspec(kind?: AppKind): AppSpec;
 /** An application's voice (VOICE.md VO-41): off unless said. */
 export declare const DEFAULT_VOICE: AppVoiceSpec;
+/** What a page's output may be drawn with (LOOP P-05), and the property of each that shows its value. */
+export declare const PAGE_OUTPUT_SHOWS: Record<AppPageOutputComponent, string>;
+/** The height of a component its developer wrote (P-17), unless it says. */
+export declare const DEFAULT_CUSTOM_HEIGHT = 240;
+/**
+ * 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 declare function pageOutputShows(component: string, own?: readonly AppCustomComponentSpec[]): string | undefined;
 /** What reading a document gives: the application, and what the document got wrong. */
 export interface ParsedAppspec {
     app: AppSpec;

package/lib/loop/apps/appspec.js

@@ -363,6 +363,103 @@ function parseUploads(data) {
         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]),
@@ -392,9 +489,16 @@ function parseInterface(data, kind) {
     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;
     }
@@ -452,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),
@@ -752,9 +861,13 @@ function dumpInterface(spec, kind) {
             .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;
     }
@@ -905,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

@@ -20,6 +20,14 @@ export declare const componentNamed: (name: string) => ComponentSpec | undefined
  * 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'

package/lib/loop/apps/checks.js

@@ -39,12 +39,13 @@ import { getTeamSpec } from '../../specs/teams';
 import { getBackendToolSpec } from '../../specs/backendTools';
 import { getTrack } from '../../specs/tracks';
 import { pluginsOffSetupNotes } from '../plugins/canvas-blocks';
-import { APP_THEME_MODES, APP_THEME_VARIANTS, isAssistantCharacterId, parseAppspec, } from './appspec';
+import { APP_THEME_MODES, APP_THEME_VARIANTS, isAssistantCharacterId, PAGE_OUTPUT_SHOWS, parseAppspec, } from './appspec';
 import { classesOf, splitRef, toolBehaviours } from './rules';
 import { COMMAND_INPUT, COMMAND_NAME, MODE_ID } from './composer';
-import { HOST_NAME, hostToolsOf } from './hostTools';
+import { HOST_NAME, HOST_USERS, hostToolsOf } from './hostTools';
 import { MAX_UPLOAD_MB, UPLOAD_KIND } from './uploads';
 import { formUiProblems } from './settingsInputs';
+import { customComponentOf, customComponentsProblems, customNodeRefused, customPropsRefused, } from './customComponents';
 import { translationProblems } from './language';
 export const NOT_READY = 'Not ready';
 export const NEEDS_ATTENTION = 'Needs attention';
@@ -129,6 +130,82 @@ export function ownCodeProblems(app) {
     if (new Set(decided).size !== decided.length) {
         problems.push('Two tests are decided by the same function of its code.');
     }
+    problems.push(...pageProblems(app));
+    // The components its developer wrote, reviewed as the catalog's (P-17).
+    problems.push(...customComponentsProblems(app));
+    return problems;
+}
+/**
+ * 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 function pageProblems(app) {
+    const page = app.interface.page;
+    if (!page) {
+        return [];
+    }
+    const problems = [];
+    if (app.kind !== 'widget') {
+        problems.push(`A page of inputs and outputs is a widget's: a ${app.kind} application has none. Remove \`interface.page\`, or make it a widget.`);
+    }
+    if (!CODE_NAME.test(page.function)) {
+        problems.push(`Cannot use “${page.function}” as the function of its page: letters, digits and \`_\`, as in Python.`);
+    }
+    problems.push(...formProblems({
+        id: 'page inputs',
+        schema: page.inputs,
+        ui: page.inputsUi,
+    }));
+    if (page.outputs.length === 0) {
+        problems.push('Its page shows one output at least.');
+    }
+    const names = page.outputs.map(output => output.name);
+    if (new Set(names).size !== names.length) {
+        problems.push('Two outputs of its page have the same name.');
+    }
+    for (const output of page.outputs) {
+        if (!CODE_NAME.test(output.name)) {
+            problems.push(`Cannot use “${output.name}” as an output's name: letters, digits and \`_\`, as in Python.`);
+        }
+        // A component its developer wrote (P-17): its value what it shows first.
+        const custom = output.component in PAGE_OUTPUT_SHOWS
+            ? undefined
+            : customComponentOf(app, output.component);
+        if (custom) {
+            if (custom.shows.length === 0) {
+                problems.push(`The output “${output.name}” is drawn with ${output.component}, which shows nothing: its value is what it shows first, under \`shows\`.`);
+                continue;
+            }
+            const refused = customPropsRefused(custom, output.props);
+            if (refused.length > 0) {
+                problems.push(`The output “${output.name}” is a ${output.component} its schema refuses: ${refused.join('; ')}.`);
+            }
+            continue;
+        }
+        const shows = PAGE_OUTPUT_SHOWS[output.component];
+        if (!shows) {
+            problems.push(`The output “${output.name}” is drawn with ${output.component}: an output is one of ${Object.keys(PAGE_OUTPUT_SHOWS).join(', ')} or a component of its own (\`custom_components\`).`);
+            continue;
+        }
+        const said = [shows, 'id', 'component'].filter(key => key in output.props);
+        if (said.length > 0) {
+            problems.push(`The output “${output.name}” says ${said.join(', ')} in its \`props\`: its id is its name, and what it shows is its value.`);
+        }
+        const schema = getComponent(output.component)?.properties;
+        const missing = (schema?.required ?? []).filter(key => key !== shows && !(key in output.props));
+        if (missing.length > 0) {
+            problems.push(`The output “${output.name}” is a ${output.component} without ${missing.join(', ')}: say it in its \`props\`.`);
+        }
+    }
+    const settings = Object.keys(app.interface.settings?.properties ?? {});
+    const inputs = Object.keys(page.inputs?.properties ?? {});
+    const shared = settings.filter(name => inputs.includes(name));
+    if (shared.length > 0) {
+        problems.push(`${shared.map(name => `“${name}”`).join(', ')} is both a setting and an input of its page: name one otherwise.`);
+    }
     return problems;
 }
 /** What the spec says of itself that the tolerant reader lets through. */
@@ -228,6 +305,10 @@ function shapeProblems(app) {
         if (new Set(names).size !== names.length) {
             problems.push('The host’s functions are named once each.');
         }
+        // Who its user is (D-21): what the page says, or what its server signed.
+        if (host.user !== undefined && !HOST_USERS.includes(host.user)) {
+            problems.push(`“${host.user}” is not how the host’s user is taken: claimed or signed.`);
+        }
         const named = new Set(app.rules.flatMap(rule => rule.appliesTo));
         for (const tool of hostToolsOf(host)) {
             if (!named.has(tool)) {
@@ -380,13 +461,21 @@ function referenceProblems(app, organizationFrames) {
         }
     }
     // The components it may use, and those its surface uses, are the catalog's (C-13).
+    // Those its developer wrote are of the catalog for it alone (P-17).
     for (const name of app.interface.components ?? []) {
-        if (!componentNamed(name)) {
+        if (!componentNamed(name) && !customComponentOf(app, name)) {
             problems.push(`There is no component named “${name}” in the catalog.`);
         }
     }
     for (const node of app.interface.surface?.components ?? []) {
-        if (!componentNamed(String(node.component))) {
+        const custom = customComponentOf(app, String(node.component));
+        if (custom) {
+            const refused = customNodeRefused(custom, node);
+            if (refused.length > 0) {
+                problems.push(`The surface's “${String(node.id)}” is a ${custom.name} its schema refuses: ${refused.join('; ')}.`);
+            }
+        }
+        else if (!componentNamed(String(node.component))) {
             problems.push(`The surface's “${String(node.id)}” is a “${String(node.component)}”, which the catalog does not have.`);
         }
         else if (node.component === 'Form') {
@@ -912,6 +1001,19 @@ export function documentShapeProblems(document) {
                 required(item, 'id', where);
                 required(item, 'component', where);
             });
+        }); // A widget's page written in its code (LOOP P-05), as agentspecs reads it.
+        mapping(ui.page, 'interface.page', page => {
+            unknownKeys(page, ['function', 'inputs', 'inputs_ui', 'outputs', 'live'], 'interface.page', 'a page');
+            required(page, 'function', 'interface.page');
+            required(page, 'inputs', 'interface.page');
+            required(page, 'outputs', 'interface.page');
+            if (page.live !== undefined && typeof page.live !== 'boolean') {
+                at('interface.page.live', 'is true or false');
+            }
+            records(page.outputs, 'interface.page.outputs', (output, where) => {
+                required(output, 'name', where);
+                unknownKeys(output, ['name', 'title', 'component', 'props'], where, 'an output');
+            });
         });
     });
     mapping(d.tests, 'tests', tests => {

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

@@ -0,0 +1,41 @@
+import type { AppCustomComponentSpec, AppSpec, ComponentSpec } from '../../types/agentspecs';
+/** Its name: a word starting with a capital letter, as the catalog's are named. */
+export declare const CUSTOM_COMPONENT_NAME: RegExp;
+/** What one of its properties may be typed: what the renderer tells apart. */
+export declare const CUSTOM_PROPERTY_TYPES: readonly ["string", "integer", "number", "boolean", "array", "object"];
+/** What every component of a surface already has, and a custom one cannot declare. */
+export declare const CUSTOM_RESERVED_NAMES: readonly ["id", "component", "action", "weight", "visible_when", "children", "child"];
+/**
+ * Where its module is loaded from: an address served over HTTPS, or this
+ * machine while it is written. A file of the application's folder waits for
+ * its packaging (P-29).
+ */
+export declare const CUSTOM_SOURCE: RegExp;
+/** A Subresource Integrity hash: the module as it was reviewed. */
+export declare const INTEGRITY: RegExp;
+/**
+ * What its schema refuses of the properties given, in the words agentspecs
+ * says them: one it does not have, a value of another type, one it needs.
+ * `bound` are given elsewhere — bound to what the application publishes.
+ */
+export declare function customPropsRefused(component: AppCustomComponentSpec, props: Record<string, unknown>, bound?: readonly string[]): string[];
+/** What stops one component its developer wrote from being reviewed, in sentences. */
+export declare function customComponentProblems(component: AppCustomComponentSpec): string[];
+/** What stops the components an application's developer wrote, in sentences. */
+export declare function customComponentsProblems(app: AppSpec): string[];
+/** A component its developer wrote, by name, or undefined. */
+export declare function customComponentOf(app: Pick<AppSpec, 'interface'>, name: string): AppCustomComponentSpec | undefined;
+/**
+ * It as the catalog lists a component (C-13): what the palette, the
+ * components page and the checks read — under the application's version, its
+ * category `custom`.
+ */
+export declare function customComponentEntry(component: AppCustomComponentSpec, version: string): ComponentSpec;
+/**
+ * The components an application may place: the catalog's own, given, and
+ * those its developer wrote, for it alone. A name of its own that the
+ * catalog has is not listed twice: the checks refuse it.
+ */
+export declare function appComponents(app: Pick<AppSpec, 'interface' | 'version'>, catalog: readonly ComponentSpec[]): ComponentSpec[];
+/** What its schema refuses of a node of a surface drawn by it, in sentences; empty when nothing. */
+export declare function customNodeRefused(component: AppCustomComponentSpec, node: Record<string, unknown>): string[];