@brydio/manifest 0.1.0-alpha.4 → 0.1.0-alpha.5

package/README.md

@@ -0,0 +1,24 @@
+# @brydio/manifest
+
+The schema and validation rules for `.brydio/app.json`. It covers app identity,
+placements, screens, collections, generated and custom tools, grants, and
+migrations.
+
+```ts
+import { defineManifest } from '@brydio/manifest';
+
+export const manifest = defineManifest({
+  name: 'checklist',
+  version: '0.1.0',
+  screens: { home: { entry: 'screens/home.js' } },
+  placements: [{ kind: 'project-tab', screen: 'home', label: 'Checklist' }],
+});
+```
+
+Read the [manifest reference](https://github.com/nakel-ola/brydio-sdk/blob/main/docs/manifest.md)
+for every field, schema type, grant, migration operation, and limit. The
+[publish checklist](https://github.com/nakel-ola/brydio-sdk/blob/main/docs/publish-checklist.md)
+lists every validation code and its refusal message.
+
+This package is MIT licensed. While the SDK is `0.x`, a minor version may
+contain a breaking change. Read the repository changelog before upgrading.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brydio/manifest",
-  "version": "0.1.0-alpha.4",
+  "version": "0.1.0-alpha.5",
   "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": "3668aa5394f40d6e6e941b68eacf4e6140ff5367",
+  "gitHead": "f9e99418eb18cedd529d7a62fe6c037396c50e3f",
   "exports": {
     ".": {
       "types": "./src/index.d.ts",

package/src/grants.d.ts

@@ -7,7 +7,7 @@
  * `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"];
+export declare const HOST_CAPABILITIES: readonly ["navigate", "message", "members", "projects", "model"];
 /** 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

@@ -8,7 +8,7 @@
  */
 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'];
+export const HOST_CAPABILITIES = ['navigate', 'message', 'members', 'projects', 'model'];
 /** 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/schema.d.ts

@@ -1,6 +1,31 @@
 import { z } from 'zod';
 import { FieldTypeInvalid, type FieldType } from './field-types.js';
 export { COLOUR_TOKENS, FIELD_LIMITS, parseFieldType, RESERVED_FIELDS, structuredFields, type FieldKind, type FieldType, } from './field-types.js';
+/**
+ * What an app adds to `.brydio/app.json` to be more than a bundle of servers
+ * and skills: where it is shown, what it keeps, the tools that come from what
+ * it keeps, its screens, and what it asks the workspace for (contracts §4).
+ *
+ * Every key is optional, so every manifest E5 already imports still parses.
+ * A copy of Brydio's `apps/api/src/apps/manifest/manifest-ext.schema.ts`, the
+ * schema the server reads an installed app's manifest with. The two change
+ * together; `test/manifest.test.ts` parses the same manifests with both.
+ *
+ * Zod says what the additions *are*. The checks that are claims about one
+ * field against another — a search list naming a date, a placement naming a
+ * screen nobody declared — are `dataProblems` below, with a code each, so an
+ * import report can say which collection and which field, not just "invalid".
+ */
+declare const placementSettingSchema: z.ZodObject<{
+    type: z.ZodEnum<{
+        string: "string";
+        url: "url";
+    }>;
+    label: z.ZodString;
+    required: z.ZodOptional<z.ZodBoolean>;
+    placeholder: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type PlacementSettingSpec = z.infer<typeof placementSettingSchema>;
 /** Most custom tools one app may declare (A3-F08). */
 export declare const MAX_CUSTOM_TOOLS = 20;
 /** A tool name the model and a policy row can both use as it is. */
@@ -28,6 +53,15 @@ declare const extensionShape: {
         screen: z.ZodString;
         label: z.ZodOptional<z.ZodString>;
         icon: z.ZodOptional<z.ZodString>;
+        settings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+            type: z.ZodEnum<{
+                string: "string";
+                url: "url";
+            }>;
+            label: z.ZodString;
+            required: z.ZodOptional<z.ZodBoolean>;
+            placeholder: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
     }, z.core.$strip>>>;
     data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
         schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
@@ -122,6 +156,15 @@ export declare const manifestExtensionsSchema: z.ZodObject<{
         screen: z.ZodString;
         label: z.ZodOptional<z.ZodString>;
         icon: z.ZodOptional<z.ZodString>;
+        settings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+            type: z.ZodEnum<{
+                string: "string";
+                url: "url";
+            }>;
+            label: z.ZodString;
+            required: z.ZodOptional<z.ZodBoolean>;
+            placeholder: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
     }, z.core.$strip>>>;
     data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
         schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
@@ -191,6 +234,15 @@ export declare const storedExtensionsSchema: z.ZodObject<{
         screen: z.ZodString;
         label: z.ZodOptional<z.ZodString>;
         icon: z.ZodOptional<z.ZodString>;
+        settings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+            type: z.ZodEnum<{
+                string: "string";
+                url: "url";
+            }>;
+            label: z.ZodString;
+            required: z.ZodOptional<z.ZodBoolean>;
+            placeholder: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
     }, z.core.$strip>>>;
     data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
         schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
@@ -288,6 +340,15 @@ export declare const appManifestSchema: z.ZodObject<{
         screen: z.ZodString;
         label: z.ZodOptional<z.ZodString>;
         icon: z.ZodOptional<z.ZodString>;
+        settings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+            type: z.ZodEnum<{
+                string: "string";
+                url: "url";
+            }>;
+            label: z.ZodString;
+            required: z.ZodOptional<z.ZodBoolean>;
+            placeholder: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
     }, z.core.$strip>>>;
     data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
         schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;

package/src/schema.js

@@ -18,11 +18,18 @@ export { COLOUR_TOKENS, FIELD_LIMITS, parseFieldType, RESERVED_FIELDS, structure
  * screen nobody declared — are `dataProblems` below, with a code each, so an
  * import report can say which collection and which field, not just "invalid".
  */
+const placementSettingSchema = z.object({
+    type: z.enum(['string', 'url']),
+    label: z.string().min(1).max(60),
+    required: z.boolean().optional(),
+    placeholder: z.string().max(200).optional(),
+});
 const placementSchema = z.object({
     kind: z.enum(['project-tab', 'project-sidebar', 'workspace-sidebar']),
     screen: z.string().min(1).max(FIELD_LIMITS.nameChars),
     label: z.string().min(1).max(60).optional(),
     icon: z.string().max(60).optional(),
+    settings: z.record(z.string().regex(FIELD_NAME), placementSettingSchema).optional(),
 });
 const collectionSchema = z.object({
     /** Field name to type, in the manifest's spelling (`"member?"`, `["todo","done"]`). */