@brydio/manifest 0.1.0-alpha.45 → 0.1.0-alpha.47

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brydio/manifest",
-  "version": "0.1.0-alpha.45",
+  "version": "0.1.0-alpha.47",
   "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": "0e71c4d82c5629fe245e298e46f7835dc0e8c3ba",
+  "gitHead": "e8cb7890ccd27170d41d30a1447ea571a255e6ce",
   "exports": {
     ".": {
       "types": "./src/index.d.ts",

package/src/schema.d.ts

@@ -93,6 +93,9 @@ declare const secretSchema: z.ZodObject<{
     }>>;
 }, z.core.$strip>;
 export type SecretSpec = z.infer<typeof secretSchema>;
+/** The `instances` rules an app may declare (CA10). */
+export declare const INSTANCE_RULES: readonly ["one-per-workspace"];
+export type InstanceRule = (typeof INSTANCE_RULES)[number];
 declare const extensionShape: {
     placements: z.ZodOptional<z.ZodArray<z.ZodObject<{
         key: z.ZodOptional<z.ZodString>;
@@ -198,6 +201,15 @@ declare const extensionShape: {
             install: "install";
         }>>;
     }, z.core.$strip>>>;
+    /**
+     * How many instances a workspace may keep (CA10). `"one-per-workspace"`:
+     * a single workspace instance, shown in the sidebar and on any project as
+     * a view of that project's records; never a project's or a person's own.
+     * Left out, as many as people make.
+     */
+    instances: z.ZodOptional<z.ZodEnum<{
+        "one-per-workspace": "one-per-workspace";
+    }>>;
     /**
      * How records move when the schema changes between versions (A3-F07).
      * Checked against the previous version when a version is published, and
@@ -244,7 +256,7 @@ export interface DataProblem {
     field?: string;
     message: string;
 }
-export type DataProblemCode = FieldTypeInvalid['code'] | OpenProblemCode | ConfirmProblemCode | AnonymousProblemCode | ReadersProblemCode | EditorsProblemCode | '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';
+export type DataProblemCode = FieldTypeInvalid['code'] | OpenProblemCode | ConfirmProblemCode | AnonymousProblemCode | ReadersProblemCode | EditorsProblemCode | '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' | 'instances_needs_sidebar';
 type Additions = z.infer<z.ZodObject<typeof extensionShape>>;
 /**
  * Everything wrong with an app's additions that a type cannot say.
@@ -376,6 +388,9 @@ export declare const manifestExtensionsSchema: z.ZodObject<{
             install: "install";
         }>>;
     }, z.core.$strip>>>;
+    instances: z.ZodOptional<z.ZodEnum<{
+        "one-per-workspace": "one-per-workspace";
+    }>>;
     migrations: z.ZodOptional<z.ZodArray<z.ZodObject<{
         version: z.ZodString;
         steps: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
@@ -514,6 +529,9 @@ export declare const storedExtensionsSchema: z.ZodObject<{
             install: "install";
         }>>;
     }, z.core.$strip>>>;
+    instances: z.ZodOptional<z.ZodEnum<{
+        "one-per-workspace": "one-per-workspace";
+    }>>;
     migrations: z.ZodOptional<z.ZodArray<z.ZodObject<{
         version: z.ZodString;
         steps: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
@@ -687,6 +705,9 @@ export declare const appManifestSchema: z.ZodObject<{
             install: "install";
         }>>;
     }, z.core.$strip>>>;
+    instances: z.ZodOptional<z.ZodEnum<{
+        "one-per-workspace": "one-per-workspace";
+    }>>;
     migrations: z.ZodOptional<z.ZodArray<z.ZodObject<{
         version: z.ZodString;
         steps: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
@@ -864,6 +885,9 @@ export declare const newAppManifestSchema: z.ZodObject<{
             install: "install";
         }>>;
     }, z.core.$strip>>>;
+    instances: z.ZodOptional<z.ZodEnum<{
+        "one-per-workspace": "one-per-workspace";
+    }>>;
     migrations: z.ZodOptional<z.ZodArray<z.ZodObject<{
         version: z.ZodString;
         steps: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{

package/src/schema.js

@@ -237,6 +237,8 @@ const grantsSchema = z.object({
     collections: z.array(z.string().max(100)).max(FIELD_LIMITS.collections + 1).optional(),
     host: z.array(z.string().max(60)).max(20).optional(),
 });
+/** The `instances` rules an app may declare (CA10). */
+export const INSTANCE_RULES = ['one-per-workspace'];
 const extensionShape = {
     placements: z.array(placementSchema).max(20).optional(),
     data: z.record(z.string(), collectionSchema).optional(),
@@ -245,6 +247,13 @@ const extensionShape = {
     grants: grantsSchema.optional(),
     /** The secrets its handlers read (ADR-A24): names only, never values. */
     secrets: z.array(secretSchema).max(MAX_APP_SECRETS).optional(),
+    /**
+     * How many instances a workspace may keep (CA10). `"one-per-workspace"`:
+     * a single workspace instance, shown in the sidebar and on any project as
+     * a view of that project's records; never a project's or a person's own.
+     * Left out, as many as people make.
+     */
+    instances: z.enum(INSTANCE_RULES).optional(),
     /**
      * How records move when the schema changes between versions (A3-F07).
      * Checked against the previous version when a version is published, and
@@ -421,6 +430,7 @@ export function dataProblems(additions, options = {}) {
     }
     problems.push(...customToolProblems(additions, options));
     problems.push(...secretProblems(additions, options));
+    problems.push(...instanceRuleProblems(additions));
     const screens = new Set(Object.keys(additions.screens ?? {}));
     const placementKeys = new Set();
     for (const placement of additions.placements ?? []) {
@@ -644,6 +654,23 @@ export const appToolPrefix = (name) => name
  * Each secret declared once, and asked for (ADR-A24): an app that declares
  * secrets without the `secrets` host grant could never read one.
  */
+/**
+ * One instance per workspace is added once, from the workspace sidebar
+ * (CA10): an app that says so and offers no sidebar item could never be
+ * added at all.
+ */
+function instanceRuleProblems(additions) {
+    if (additions.instances !== 'one-per-workspace')
+        return [];
+    if ((additions.placements ?? []).some(one => one.kind === 'workspace-sidebar'))
+        return [];
+    return [
+        {
+            code: 'instances_needs_sidebar',
+            message: 'An app kept once per workspace is added from the workspace sidebar: add a "workspace-sidebar" placement.',
+        },
+    ];
+}
 function secretProblems(additions, options) {
     const problems = [];
     const secrets = additions.secrets ?? [];
@@ -678,13 +705,15 @@ const refuse = (additions, ctx, options = {}) => {
                     ? ['grants', 'host']
                     : problem.code === 'secret_name_taken'
                         ? ['secrets']
-                        : problem.code.startsWith('grant_')
-                            ? ['grants', 'collections']
-                            : problem.code.startsWith('custom_')
-                                ? ['tools', 'custom']
-                                : problem.collection
-                                    ? ['data', problem.collection, ...(problem.field ? ['schema', problem.field] : [])]
-                                    : [],
+                        : problem.code === 'instances_needs_sidebar'
+                            ? ['instances']
+                            : problem.code.startsWith('grant_')
+                                ? ['grants', 'collections']
+                                : problem.code.startsWith('custom_')
+                                    ? ['tools', 'custom']
+                                    : problem.collection
+                                        ? ['data', problem.collection, ...(problem.field ? ['schema', problem.field] : [])]
+                                        : [],
             params: { code: problem.code },
         });
     }

package/src/secrets.js

@@ -59,9 +59,20 @@ function walk(node, at, found, publicValue = () => false) {
  */
 export function secretsInJson(document, at) {
     const found = [];
-    walk(document, at, found, path => /(?:^|\.)placements\[\d+\]\.key$/.test(path));
+    walk(document, at, found, path => DECLARATIONS.some(declared => declared.test(path)));
     return found;
 }
+/**
+ * Names in an app.json that read like credentials but are declarations: a
+ * placement's identity, a collection's field definition (an open-schema
+ * companion must declare `key`), and a tool's input field. Their values are
+ * types and names, never secrets.
+ */
+const DECLARATIONS = [
+    /(?:^|\.)placements\[\d+\]\.key$/,
+    /(?:^|\.)data\.[^.[\]]+\.schema\.[^.[\]]+$/,
+    /(?:^|\.)tools\.custom\[\d+\]\.input\.[^.[\]]+$/,
+];
 /** Every secret declared in a bundle's files, as the server finds them. */
 export function findSecrets(files, root = '') {
     const found = [];