@brydio/manifest 0.1.0-alpha.36 → 0.1.0-alpha.37

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brydio/manifest",
-  "version": "0.1.0-alpha.36",
+  "version": "0.1.0-alpha.37",
   "description": "The shape of a Brydio app's manifest, its collections' schemas, and the checks that say what is wrong with one.",
   "type": "module",
   "license": "MIT",
@@ -10,7 +10,7 @@
     "url": "https://github.com/nakel-ola/brydio-sdk",
     "directory": "packages/manifest"
   },
-  "gitHead": "2d8e769d02c74fe201ce734f6d77def59ea99d53",
+  "gitHead": "c0364642e34a602b75477af366aa61582e5598f7",
   "exports": {
     ".": {
       "types": "./src/index.d.ts",

package/src/grants.d.ts

@@ -6,8 +6,16 @@
  * `apps/api/src/apps/manifest/grants.ts`, and the `grant_unknown` sentence in
  * `apps/api/src/apps/publishing/app-publish.service.ts`.
  */
-/** The host grants with a name of their own. A connection's is `connection:<name>`. */
-export declare const HOST_CAPABILITIES: readonly ["navigate", "message", "members", "projects", "files", "chats", "model", "secrets", "notify", "approvals"];
+/**
+ * The host grants with a name of their own. A connection's is `connection:<name>`.
+ *
+ * `chats` and `chat` differ: `chats` is the typed Brydio API's reach into the
+ * person's assistant conversations; `chat` is a handler's `chat.post`, the
+ * app posting one of its cards into a workspace room (FO03). `directory` is
+ * a handler's `directory.*` and a screen's `useProfile` (FO02); `webhooks`
+ * is a handler's `webhooks.send` (FO07).
+ */
+export declare const HOST_CAPABILITIES: readonly ["navigate", "message", "members", "projects", "files", "chats", "model", "secrets", "notify", "approvals", "chat", "directory", "webhooks"];
 /** The older name for `HOST_CAPABILITIES`, kept for what already imports it. */
 export declare const KNOWN_HOST_GRANTS: readonly string[];
 /** True for a host grant Brydio knows how to honour: a named capability, or one connection. */

package/src/grants.js

@@ -7,8 +7,30 @@
  * `apps/api/src/apps/publishing/app-publish.service.ts`.
  */
 import { BUNDLE_MANIFEST } from "./bundle.js";
-/** The host grants with a name of their own. A connection's is `connection:<name>`. */
-export const HOST_CAPABILITIES = ['navigate', 'message', 'members', 'projects', 'files', 'chats', 'model', 'secrets', 'notify', 'approvals'];
+/**
+ * The host grants with a name of their own. A connection's is `connection:<name>`.
+ *
+ * `chats` and `chat` differ: `chats` is the typed Brydio API's reach into the
+ * person's assistant conversations; `chat` is a handler's `chat.post`, the
+ * app posting one of its cards into a workspace room (FO03). `directory` is
+ * a handler's `directory.*` and a screen's `useProfile` (FO02); `webhooks`
+ * is a handler's `webhooks.send` (FO07).
+ */
+export const HOST_CAPABILITIES = [
+    'navigate',
+    'message',
+    'members',
+    'projects',
+    'files',
+    'chats',
+    'model',
+    'secrets',
+    'notify',
+    'approvals',
+    'chat',
+    'directory',
+    'webhooks',
+];
 /** The older name for `HOST_CAPABILITIES`, kept for what already imports it. */
 export const KNOWN_HOST_GRANTS = HOST_CAPABILITIES;
 const CONNECTION = /^connection:[a-z0-9][a-z0-9_-]{0,59}$/;

package/src/index.d.ts

@@ -7,7 +7,7 @@ export { APP_NAME_FORMAT, MANIFEST_LIMITS, SEMVER_FORMAT, baseManifestSchema, br
 export { BRAND_FIELDS, BRAND_LIMITS, brandFilePath, brandPathsOf, brandProblems, brandShapeOf, isBrandPath, pngVerdict, svgColours, toolsProblem, type BrandField, type RequirementCode, type RequirementFiles, type RequirementProblem, } from './requirements.js';
 export { BUNDLE_MANIFEST, BUNDLE_MAX_BYTES, BUNDLE_PATH_MAX_CHARS, bundleBytes, bundleHash, brandOf, bundleProblem, codeOf, isBundlePath, isScriptPath, sizeOf, type BundleFiles, type BundleProblem, type BundleProblemCode, } from './bundle.js';
 export { COLOUR_TOKENS, coeditedFields, FIELD_LIMITS, RESERVED_FIELDS, describeType, isCoedited, isSearchable, isSortable, isStructured, parseFieldType, structuredFields, valueProblem, valueSchema, FieldTypeInvalid, type DocumentOf, type FieldKind, type FieldType, type FieldValue, type FieldsOf, } from './field-types.js';
-export { appManifestSchema, collectionOf, collectionsOf, dataProblems, effectivePlacementKey, HOME_CARD_SIZES, labelOf, manifestExtensionsSchema, newAppManifestSchema, SIZED_PLACEMENT_KINDS, MAX_APP_SECRETS, MAX_SECRET_CHARS, PLACEMENT_KEY, SECRET_NAME, storedExtensionsSchema, type AppManifestWithData, type CollectionSpec, type DataProblem, type DataProblemCode, type DataProblemOptions, type HomeCardSize, type ManifestExtensions, type SecretSpec, } from './schema.js';
+export { appManifestSchema, appToolPrefix, collectionOf, crossAppTool, collectionsOf, dataProblems, effectivePlacementKey, HOME_CARD_SIZES, labelOf, manifestExtensionsSchema, newAppManifestSchema, SIZED_PLACEMENT_KINDS, MAX_APP_SECRETS, MAX_SECRET_CHARS, PLACEMENT_KEY, SECRET_NAME, storedExtensionsSchema, type AppManifestWithData, type CollectionSpec, type DataProblem, type DataProblemCode, type DataProblemOptions, type HomeCardSize, type ManifestExtensions, type SecretSpec, } from './schema.js';
 export { OPEN_LIMITS, OPEN_TYPES, choicesProblem, definitionOf, definitionTypeProblem, describeField, fieldTypeOf, hasChoices, isPlainOpenType, keyFromName, keyProblem, missingRequired, moveValue, openSchemaProblems, openSpec, openValueProblem, type Moved, type OpenField, type OpenFieldChange, type OpenFieldValue, type OpenProblem, type OpenProblemCode, type OpenSchemaFlag, type OpenType, } from './open-schema.js';
 export { CONFIRM_LIMITS, confirmEmailProblems, confirmEmailSpec, type ConfirmEmailDeclared, type ConfirmEmailSpec, type ConfirmProblemCode, } from './confirm-email.js';
 export { ANONYMOUS_LIMITS, ANONYMOUS_WRITER, anonymousProblems, anonymousSpec, type AnonymousDeclared, type AnonymousProblemCode, type AnonymousSpec, } from './anonymous.js';

package/src/index.js

@@ -7,7 +7,7 @@ export { APP_NAME_FORMAT, MANIFEST_LIMITS, SEMVER_FORMAT, baseManifestSchema, br
 export { BRAND_FIELDS, BRAND_LIMITS, brandFilePath, brandPathsOf, brandProblems, brandShapeOf, isBrandPath, pngVerdict, svgColours, toolsProblem, } from "./requirements.js";
 export { BUNDLE_MANIFEST, BUNDLE_MAX_BYTES, BUNDLE_PATH_MAX_CHARS, bundleBytes, bundleHash, brandOf, bundleProblem, codeOf, isBundlePath, isScriptPath, sizeOf, } from "./bundle.js";
 export { COLOUR_TOKENS, coeditedFields, FIELD_LIMITS, RESERVED_FIELDS, describeType, isCoedited, isSearchable, isSortable, isStructured, parseFieldType, structuredFields, valueProblem, valueSchema, FieldTypeInvalid, } from "./field-types.js";
-export { appManifestSchema, collectionOf, collectionsOf, dataProblems, effectivePlacementKey, HOME_CARD_SIZES, labelOf, manifestExtensionsSchema, newAppManifestSchema, SIZED_PLACEMENT_KINDS, MAX_APP_SECRETS, MAX_SECRET_CHARS, PLACEMENT_KEY, SECRET_NAME, storedExtensionsSchema, } from "./schema.js";
+export { appManifestSchema, appToolPrefix, collectionOf, crossAppTool, collectionsOf, dataProblems, effectivePlacementKey, HOME_CARD_SIZES, labelOf, manifestExtensionsSchema, newAppManifestSchema, SIZED_PLACEMENT_KINDS, MAX_APP_SECRETS, MAX_SECRET_CHARS, PLACEMENT_KEY, SECRET_NAME, storedExtensionsSchema, } from "./schema.js";
 export { OPEN_LIMITS, OPEN_TYPES, choicesProblem, definitionOf, definitionTypeProblem, describeField, fieldTypeOf, hasChoices, isPlainOpenType, keyFromName, keyProblem, missingRequired, moveValue, openSchemaProblems, openSpec, openValueProblem, } from "./open-schema.js";
 export { CONFIRM_LIMITS, confirmEmailProblems, confirmEmailSpec, } from "./confirm-email.js";
 export { ANONYMOUS_LIMITS, ANONYMOUS_WRITER, anonymousProblems, anonymousSpec, } from "./anonymous.js";

package/src/schema.d.ts

@@ -102,6 +102,7 @@ declare const extensionShape: {
             "project-sidebar": "project-sidebar";
             "workspace-sidebar": "workspace-sidebar";
             "public-page": "public-page";
+            "chat-card": "chat-card";
         }>;
         screen: z.ZodString;
         sizes: z.ZodOptional<z.ZodArray<z.ZodEnum<{
@@ -240,7 +241,7 @@ export interface DataProblem {
     field?: string;
     message: string;
 }
-export type DataProblemCode = FieldTypeInvalid['code'] | OpenProblemCode | ConfirmProblemCode | AnonymousProblemCode | 'data_too_many_collections' | 'data_too_many_fields' | 'data_collection_name_format' | 'data_field_name_format' | 'data_field_reserved' | 'data_label_format' | 'data_label_taken' | 'data_project_field_twice' | 'data_search_unknown_field' | 'data_search_not_text' | 'grant_collection_missing' | 'grant_tool_missing' | 'custom_name_taken' | 'custom_collection_unknown' | 'custom_input_invalid' | 'placement_key_taken' | 'placement_screen_unknown' | 'placement_home_sizes' | 'placement_sizes_not_home' | 'placement_widget_sizes' | 'placement_tab_retired' | 'placement_public_shape' | 'placement_public_nothing' | 'placement_children_too_deep' | 'placement_create_tool_unknown' | 'placement_create_not_write' | 'secret_name_taken' | 'grant_secrets_missing';
+export type DataProblemCode = FieldTypeInvalid['code'] | OpenProblemCode | ConfirmProblemCode | AnonymousProblemCode | 'data_too_many_collections' | 'data_too_many_fields' | 'data_collection_name_format' | 'data_field_name_format' | 'data_field_reserved' | 'data_label_format' | 'data_label_taken' | 'data_project_field_twice' | 'data_search_unknown_field' | 'data_search_not_text' | 'grant_collection_missing' | 'grant_tool_missing' | 'custom_name_taken' | 'custom_collection_unknown' | 'custom_input_invalid' | 'placement_key_taken' | 'placement_screen_unknown' | 'placement_home_sizes' | 'placement_sizes_not_home' | 'placement_widget_sizes' | 'placement_tab_retired' | 'placement_public_shape' | 'placement_public_nothing' | 'placement_chat_card_shape' | 'grant_tool_cross_app_self' | 'placement_children_too_deep' | 'placement_create_tool_unknown' | 'placement_create_not_write' | 'secret_name_taken' | 'grant_secrets_missing';
 type Additions = z.infer<z.ZodObject<typeof extensionShape>>;
 /**
  * Everything wrong with an app's additions that a type cannot say.
@@ -256,6 +257,17 @@ export interface DataProblemOptions {
     retired?: boolean;
 }
 export declare function dataProblems(additions: Additions, options?: DataProblemOptions): DataProblem[];
+/**
+ * Another installed app's tool, as `grants.tools` names it (FO07): the name
+ * the assistant knows it by, `<slug>__<tool>`. Null for anything else.
+ * A handler calls it with `tools.call('<slug>__<tool>', input)`.
+ */
+export declare function crossAppTool(name: string): {
+    app: string;
+    tool: string;
+} | null;
+/** An app's name as the front of its tools' assistant names: `issue-tracker` → `issue_tracker`. */
+export declare const appToolPrefix: (name: string) => string;
 /** The additions alone, for code that has the rest of the manifest already. */
 export declare const manifestExtensionsSchema: z.ZodObject<{
     placements: z.ZodOptional<z.ZodArray<z.ZodObject<{
@@ -267,6 +279,7 @@ export declare const manifestExtensionsSchema: z.ZodObject<{
             "project-sidebar": "project-sidebar";
             "workspace-sidebar": "workspace-sidebar";
             "public-page": "public-page";
+            "chat-card": "chat-card";
         }>;
         screen: z.ZodString;
         sizes: z.ZodOptional<z.ZodArray<z.ZodEnum<{
@@ -402,6 +415,7 @@ export declare const storedExtensionsSchema: z.ZodObject<{
             "project-sidebar": "project-sidebar";
             "workspace-sidebar": "workspace-sidebar";
             "public-page": "public-page";
+            "chat-card": "chat-card";
         }>;
         screen: z.ZodString;
         sizes: z.ZodOptional<z.ZodArray<z.ZodEnum<{
@@ -572,6 +586,7 @@ export declare const appManifestSchema: z.ZodObject<{
             "project-sidebar": "project-sidebar";
             "workspace-sidebar": "workspace-sidebar";
             "public-page": "public-page";
+            "chat-card": "chat-card";
         }>;
         screen: z.ZodString;
         sizes: z.ZodOptional<z.ZodArray<z.ZodEnum<{
@@ -746,6 +761,7 @@ export declare const newAppManifestSchema: z.ZodObject<{
             "project-sidebar": "project-sidebar";
             "workspace-sidebar": "workspace-sidebar";
             "public-page": "public-page";
+            "chat-card": "chat-card";
         }>;
         screen: z.ZodString;
         sizes: z.ZodOptional<z.ZodArray<z.ZodEnum<{

package/src/schema.js

@@ -72,8 +72,12 @@ const placementSchema = z.object({
      * `children` or `settings` (`placement_public_shape`), and it reaches only
      * collections marked `publicRead` or `publicSubmit` and tools marked
      * `public`.
+     * `chat-card`: a screen drawn inside a chat message the app posted with
+     * a handler's `chat.post` (FO03). Nobody places it by hand, so it has no
+     * `sizes`, `children` or `settings` (`placement_chat_card_shape`); its
+     * screen sees `placement.kind === 'chat-card'` and the card's `route`.
      */
-    kind: z.enum(['project-tab', 'project-widget', 'project-sidebar', 'workspace-sidebar', 'home', 'public-page']),
+    kind: z.enum(['project-tab', 'project-widget', 'project-sidebar', 'workspace-sidebar', 'home', 'public-page', 'chat-card']),
     screen: z.string().min(1).max(FIELD_LIMITS.nameChars),
     /** For `home` and `project-widget` only, and required there: the sizes the screen draws well at. */
     sizes: z.array(z.enum(HOME_CARD_SIZES)).max(3).optional(),
@@ -454,6 +458,14 @@ export function dataProblems(additions, options = {}) {
                 message: `The public page "${placement.screen}" can have no children or settings: it is one screen at its own address.`,
             });
         }
+        // A chat card is drawn at the message's own size, in a message nobody
+        // places by hand (FO03): nothing to size, configure or list.
+        if (placement.kind === 'chat-card' && (placement.sizes?.length || placement.children || placement.settings)) {
+            problems.push({
+                code: 'placement_chat_card_shape',
+                message: `The chat card "${placement.screen}" cannot have sizes, children or settings.`,
+            });
+        }
     }
     // A public page with nothing public could show a visitor nothing at all.
     if ((additions.placements ?? []).some(placement => placement.kind === 'public-page')) {
@@ -551,6 +563,20 @@ function customToolProblems(additions, options) {
         }));
     const seen = new Set();
     const granted = additions.grants?.tools ?? [];
+    // Another app's tool, asked for by its assistant name `<slug>__<tool>`
+    // (FO07): never an unknown custom tool of this app, but naming the app
+    // itself would be a way round its own grants.
+    const name = additions.name;
+    const own = typeof name === 'string' ? appToolPrefix(name) : null;
+    for (const grant of granted) {
+        const qualified = crossAppTool(grant);
+        if (qualified && own !== null && qualified.app === own) {
+            problems.push({
+                code: 'grant_tool_cross_app_self',
+                message: `${grant} names this app's own tool: ask for ${qualified.tool} instead.`,
+            });
+        }
+    }
     for (const tool of custom) {
         if (generated.has(tool.name) || seen.has(tool.name)) {
             problems.push({
@@ -587,6 +613,22 @@ function customToolProblems(additions, options) {
     }
     return problems;
 }
+/**
+ * Another installed app's tool, as `grants.tools` names it (FO07): the name
+ * the assistant knows it by, `<slug>__<tool>`. Null for anything else.
+ * A handler calls it with `tools.call('<slug>__<tool>', input)`.
+ */
+export function crossAppTool(name) {
+    const at = name.indexOf('__');
+    if (at <= 0 || at + 2 >= name.length)
+        return null;
+    return { app: name.slice(0, at), tool: name.slice(at + 2) };
+}
+/** An app's name as the front of its tools' assistant names: `issue-tracker` → `issue_tracker`. */
+export const appToolPrefix = (name) => name
+    .replace(/[^A-Za-z0-9_]+/g, '_')
+    .replace(/_+/g, '_')
+    .replace(/^_+|_+$/g, '');
 /**
  * Each secret declared once, and asked for (ADR-A24): an app that declares
  * secrets without the `secrets` host grant could never read one.
@@ -619,7 +661,7 @@ const refuse = (additions, ctx, options = {}) => {
         ctx.addIssue({
             code: 'custom',
             message: problem.message,
-            path: problem.code === 'grant_tool_missing'
+            path: problem.code === 'grant_tool_missing' || problem.code === 'grant_tool_cross_app_self'
                 ? ['grants', 'tools']
                 : problem.code === 'grant_secrets_missing'
                     ? ['grants', 'host']