@brydio/manifest 0.1.0-alpha.32 → 0.1.0-alpha.33

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brydio/manifest",
-  "version": "0.1.0-alpha.32",
+  "version": "0.1.0-alpha.33",
   "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": "ea8f005923ae49241284dd14969a4478c97bebe0",
+  "gitHead": "664471f08e89483e25fb1bd49dfd69709b575bfa",
   "exports": {
     ".": {
       "types": "./src/index.d.ts",

package/src/schema.d.ts

@@ -60,6 +60,7 @@ declare const customToolSchema: z.ZodObject<{
     input: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     write: z.ZodOptional<z.ZodBoolean>;
     collection: z.ZodOptional<z.ZodString>;
+    public: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strip>;
 export type CustomToolSpec = z.infer<typeof customToolSchema>;
 /** Most secrets one app may declare (ADR-A24). */
@@ -97,6 +98,7 @@ declare const extensionShape: {
             "project-tab": "project-tab";
             "project-sidebar": "project-sidebar";
             "workspace-sidebar": "workspace-sidebar";
+            "public-page": "public-page";
         }>;
         screen: z.ZodString;
         sizes: z.ZodOptional<z.ZodArray<z.ZodEnum<{
@@ -141,6 +143,8 @@ declare const extensionShape: {
         schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
         search: z.ZodOptional<z.ZodArray<z.ZodString>>;
         label: z.ZodOptional<z.ZodString>;
+        publicRead: z.ZodOptional<z.ZodBoolean>;
+        publicSubmit: z.ZodOptional<z.ZodBoolean>;
     }, z.core.$strip>>>;
     tools: z.ZodOptional<z.ZodObject<{
         generated: z.ZodOptional<z.ZodBoolean>;
@@ -151,6 +155,7 @@ declare const extensionShape: {
             input: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
             write: z.ZodOptional<z.ZodBoolean>;
             collection: z.ZodOptional<z.ZodString>;
+            public: z.ZodOptional<z.ZodBoolean>;
         }, z.core.$strip>>>;
     }, z.core.$strip>>;
     screens: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
@@ -218,7 +223,7 @@ export interface DataProblem {
     field?: string;
     message: string;
 }
-export type DataProblemCode = FieldTypeInvalid['code'] | '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_children_too_deep' | 'placement_create_tool_unknown' | 'placement_create_not_write' | 'secret_name_taken' | 'grant_secrets_missing';
+export type DataProblemCode = FieldTypeInvalid['code'] | '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';
 type Additions = z.infer<z.ZodObject<typeof extensionShape>>;
 /**
  * Everything wrong with an app's additions that a type cannot say.
@@ -244,6 +249,7 @@ export declare const manifestExtensionsSchema: z.ZodObject<{
             "project-tab": "project-tab";
             "project-sidebar": "project-sidebar";
             "workspace-sidebar": "workspace-sidebar";
+            "public-page": "public-page";
         }>;
         screen: z.ZodString;
         sizes: z.ZodOptional<z.ZodArray<z.ZodEnum<{
@@ -288,6 +294,8 @@ export declare const manifestExtensionsSchema: z.ZodObject<{
         schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
         search: z.ZodOptional<z.ZodArray<z.ZodString>>;
         label: z.ZodOptional<z.ZodString>;
+        publicRead: z.ZodOptional<z.ZodBoolean>;
+        publicSubmit: z.ZodOptional<z.ZodBoolean>;
     }, z.core.$strip>>>;
     tools: z.ZodOptional<z.ZodObject<{
         generated: z.ZodOptional<z.ZodBoolean>;
@@ -298,6 +306,7 @@ export declare const manifestExtensionsSchema: z.ZodObject<{
             input: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
             write: z.ZodOptional<z.ZodBoolean>;
             collection: z.ZodOptional<z.ZodString>;
+            public: z.ZodOptional<z.ZodBoolean>;
         }, z.core.$strip>>>;
     }, z.core.$strip>>;
     screens: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
@@ -361,6 +370,7 @@ export declare const storedExtensionsSchema: z.ZodObject<{
             "project-tab": "project-tab";
             "project-sidebar": "project-sidebar";
             "workspace-sidebar": "workspace-sidebar";
+            "public-page": "public-page";
         }>;
         screen: z.ZodString;
         sizes: z.ZodOptional<z.ZodArray<z.ZodEnum<{
@@ -405,6 +415,8 @@ export declare const storedExtensionsSchema: z.ZodObject<{
         schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
         search: z.ZodOptional<z.ZodArray<z.ZodString>>;
         label: z.ZodOptional<z.ZodString>;
+        publicRead: z.ZodOptional<z.ZodBoolean>;
+        publicSubmit: z.ZodOptional<z.ZodBoolean>;
     }, z.core.$strip>>>;
     tools: z.ZodOptional<z.ZodObject<{
         generated: z.ZodOptional<z.ZodBoolean>;
@@ -415,6 +427,7 @@ export declare const storedExtensionsSchema: z.ZodObject<{
             input: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
             write: z.ZodOptional<z.ZodBoolean>;
             collection: z.ZodOptional<z.ZodString>;
+            public: z.ZodOptional<z.ZodBoolean>;
         }, z.core.$strip>>>;
     }, z.core.$strip>>;
     screens: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
@@ -513,6 +526,7 @@ export declare const appManifestSchema: z.ZodObject<{
             "project-tab": "project-tab";
             "project-sidebar": "project-sidebar";
             "workspace-sidebar": "workspace-sidebar";
+            "public-page": "public-page";
         }>;
         screen: z.ZodString;
         sizes: z.ZodOptional<z.ZodArray<z.ZodEnum<{
@@ -557,6 +571,8 @@ export declare const appManifestSchema: z.ZodObject<{
         schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
         search: z.ZodOptional<z.ZodArray<z.ZodString>>;
         label: z.ZodOptional<z.ZodString>;
+        publicRead: z.ZodOptional<z.ZodBoolean>;
+        publicSubmit: z.ZodOptional<z.ZodBoolean>;
     }, z.core.$strip>>>;
     tools: z.ZodOptional<z.ZodObject<{
         generated: z.ZodOptional<z.ZodBoolean>;
@@ -567,6 +583,7 @@ export declare const appManifestSchema: z.ZodObject<{
             input: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
             write: z.ZodOptional<z.ZodBoolean>;
             collection: z.ZodOptional<z.ZodString>;
+            public: z.ZodOptional<z.ZodBoolean>;
         }, z.core.$strip>>>;
     }, z.core.$strip>>;
     screens: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
@@ -669,6 +686,7 @@ export declare const newAppManifestSchema: z.ZodObject<{
             "project-tab": "project-tab";
             "project-sidebar": "project-sidebar";
             "workspace-sidebar": "workspace-sidebar";
+            "public-page": "public-page";
         }>;
         screen: z.ZodString;
         sizes: z.ZodOptional<z.ZodArray<z.ZodEnum<{
@@ -713,6 +731,8 @@ export declare const newAppManifestSchema: z.ZodObject<{
         schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
         search: z.ZodOptional<z.ZodArray<z.ZodString>>;
         label: z.ZodOptional<z.ZodString>;
+        publicRead: z.ZodOptional<z.ZodBoolean>;
+        publicSubmit: z.ZodOptional<z.ZodBoolean>;
     }, z.core.$strip>>>;
     tools: z.ZodOptional<z.ZodObject<{
         generated: z.ZodOptional<z.ZodBoolean>;
@@ -723,6 +743,7 @@ export declare const newAppManifestSchema: z.ZodObject<{
             input: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
             write: z.ZodOptional<z.ZodBoolean>;
             collection: z.ZodOptional<z.ZodString>;
+            public: z.ZodOptional<z.ZodBoolean>;
         }, z.core.$strip>>>;
     }, z.core.$strip>>;
     screens: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{

package/src/schema.js

@@ -64,8 +64,13 @@ const placementSchema = z.object({
      * `project-widget`: a card on a project's page, drawn at one of `sizes`.
      * `project-tab` is retired (30 Sep 2026): still read from a published
      * manifest, refused in a new one (`placement_tab_retired`).
+     * `public-page`: a screen people without a Brydio account open at the
+     * page's own address, once an admin turns it on (P3). It has no `sizes`,
+     * `children` or `settings` (`placement_public_shape`), and it reaches only
+     * collections marked `publicRead` or `publicSubmit` and tools marked
+     * `public`.
      */
-    kind: z.enum(['project-tab', 'project-widget', 'project-sidebar', 'workspace-sidebar', 'home']),
+    kind: z.enum(['project-tab', 'project-widget', 'project-sidebar', 'workspace-sidebar', 'home', 'public-page']),
     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(),
@@ -101,6 +106,17 @@ const collectionSchema = z.object({
     search: z.array(z.string()).optional(),
     /** The singular noun the tools are named with: `issue` gives `create_issue`. */
     label: z.string().optional(),
+    /**
+     * A visitor on one of the app's public pages may `get` and `list` every
+     * record of this collection in that instance (P3).
+     */
+    publicRead: z.boolean().optional(),
+    /**
+     * A visitor on one of the app's public pages may create records here, and
+     * nothing else: no update, remove or batch, and no get or list unless
+     * `publicRead` is set too (P3).
+     */
+    publicSubmit: z.boolean().optional(),
 });
 const screenSchema = z.object({
     /**
@@ -137,6 +153,12 @@ const customToolSchema = z.object({
     write: z.boolean().optional(),
     /** The collection it works on, when it works on one: its grant then needs that collection too. */
     collection: z.string().optional(),
+    /**
+     * Callable from a public page (P3). Its handler then runs for a visitor,
+     * whose `data` is held to `publicRead` and `publicSubmit` and who can use
+     * nothing else of the workspace's.
+     */
+    public: z.boolean().optional(),
 });
 const toolsSchema = z.object({
     /** Off only when the app supplies every tool itself (A3-F08). */
@@ -366,6 +388,25 @@ export function dataProblems(additions, options = {}) {
                 message: 'Project tabs are retired; declare a project-widget with sizes instead.',
             });
         }
+        // A public page is one screen at its own address: nothing to list in a
+        // sidebar, and nothing for an admin to fill in when it is placed.
+        if (placement.kind === 'public-page' && (placement.children || placement.settings)) {
+            problems.push({
+                code: 'placement_public_shape',
+                message: `The public page "${placement.screen}" can have no children or settings: it is one screen at its own address.`,
+            });
+        }
+    }
+    // A public page with nothing public could show a visitor nothing at all.
+    if ((additions.placements ?? []).some(placement => placement.kind === 'public-page')) {
+        const publicData = Object.values(additions.data ?? {}).some(declared => declared.publicRead || declared.publicSubmit);
+        const publicTool = (additions.tools?.custom ?? []).some(tool => tool.public);
+        if (!publicData && !publicTool) {
+            problems.push({
+                code: 'placement_public_nothing',
+                message: 'A public page needs something a visitor may use: mark a collection publicRead or publicSubmit, or a custom tool public.',
+            });
+        }
     }
     problems.push(...folderProblems(additions));
     return problems;