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

package/package.json

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

package/src/index.d.ts

@@ -11,6 +11,7 @@ export { appManifestSchema, appToolPrefix, collectionOf, crossAppTool, collectio
 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';
+export { READERS_LIMIT, readersOf, readersProblems, type ReadersProblemCode } from './readers.js';
 export { DOCUMENT_LIMITS } from './document-limits.js';
 export { HOST_CAPABILITIES, KNOWN_HOST_GRANTS, isHostCapability, unknownHostGrant } from './grants.js';
 export { diffSchemas, migrationProblems, migrationSchema, migrationStepSchema, migrationsSchema, publishedMigrationProblems, schemaOf, type Migration, type MigrationCode, type MigrationProblem, type MigrationStep, type SchemaChange, } from './migrations.js';

package/src/index.js

@@ -11,6 +11,7 @@ export { appManifestSchema, appToolPrefix, collectionOf, crossAppTool, collectio
 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";
+export { READERS_LIMIT, readersOf, readersProblems } from "./readers.js";
 export { DOCUMENT_LIMITS } from "./document-limits.js";
 export { HOST_CAPABILITIES, KNOWN_HOST_GRANTS, isHostCapability, unknownHostGrant } from "./grants.js";
 export { diffSchemas, migrationProblems, migrationSchema, migrationStepSchema, migrationsSchema, publishedMigrationProblems, schemaOf, } from "./migrations.js";

package/src/readers.d.ts

@@ -0,0 +1,31 @@
+import { z } from 'zod';
+/**
+ * Record readers (P16): a record only the people it
+ * names may read.
+ *
+ * An app names one of the collection's own `string[]` fields, which holds
+ * user ids. When a record's list is empty, everyone who can read the
+ * instance reads it, as before; when it names anyone, nobody else finds it —
+ * not on a screen, not through a tool, not through the assistant, not on the
+ * co-edit socket. There is no admin past it: an app that wants its admins
+ * in puts them in the list. Brydio keeps the list in plain beside the record
+ * (`app_document.readers`), so every read can be narrowed before anything
+ * is decrypted. Mirrors Brydio's `apps/api/src/apps/manifest/readers.ts`;
+ * the two change together.
+ */
+export declare const readersSchema: z.ZodString;
+export type ReadersProblemCode = 'data_readers_field' | 'data_readers_anonymous';
+/** The most people one record's list may name. */
+export declare const READERS_LIMIT = 1000;
+export declare function readersProblems(collection: string, declared: {
+    schema: Record<string, unknown>;
+    readers?: string;
+    anonymous?: unknown;
+}): {
+    code: ReadersProblemCode;
+    collection: string;
+    field?: string;
+    message: string;
+}[];
+/** The plain list a record is kept with: its readers, or null for everyone who can read the instance. */
+export declare function readersOf(field: string | undefined, body: Record<string, unknown>): string[] | null;

package/src/readers.js

@@ -0,0 +1,59 @@
+import { z } from 'zod';
+import { FIELD_LIMITS, parseFieldType } from "./field-types.js";
+/**
+ * Record readers (P16): a record only the people it
+ * names may read.
+ *
+ * An app names one of the collection's own `string[]` fields, which holds
+ * user ids. When a record's list is empty, everyone who can read the
+ * instance reads it, as before; when it names anyone, nobody else finds it —
+ * not on a screen, not through a tool, not through the assistant, not on the
+ * co-edit socket. There is no admin past it: an app that wants its admins
+ * in puts them in the list. Brydio keeps the list in plain beside the record
+ * (`app_document.readers`), so every read can be narrowed before anything
+ * is decrypted. Mirrors Brydio's `apps/api/src/apps/manifest/readers.ts`;
+ * the two change together.
+ */
+export const readersSchema = z.string().min(1).max(FIELD_LIMITS.nameChars);
+/** The most people one record's list may name. */
+export const READERS_LIMIT = 1_000;
+export function readersProblems(collection, declared) {
+    if (!declared.readers)
+        return [];
+    const problems = [];
+    const raw = declared.schema[declared.readers];
+    let listed = false;
+    try {
+        listed = raw !== undefined && parseFieldType(raw).kind === 'string[]';
+    }
+    catch {
+        // Refused as a field type already.
+    }
+    if (!listed) {
+        problems.push({
+            code: 'data_readers_field',
+            collection,
+            field: declared.readers,
+            message: `"${collection}" names "${declared.readers}" as its readers, which must be one of its own string[] fields holding user ids.`,
+        });
+    }
+    // An anonymous answer names nobody; a list of who may read it would.
+    if (declared.anonymous) {
+        problems.push({
+            code: 'data_readers_anonymous',
+            collection,
+            message: `"${collection}" can't be anonymous and name its readers.`,
+        });
+    }
+    return problems;
+}
+/** The plain list a record is kept with: its readers, or null for everyone who can read the instance. */
+export function readersOf(field, body) {
+    if (!field)
+        return null;
+    const value = body[field];
+    if (!Array.isArray(value))
+        return null;
+    const ids = [...new Set(value.filter((one) => typeof one === 'string' && one.length > 0))];
+    return ids.length ? ids.sort() : null;
+}

package/src/schema.d.ts

@@ -3,6 +3,7 @@ import { FieldTypeInvalid, type FieldType } from './field-types.js';
 import { type OpenProblemCode } from './open-schema.js';
 import { type ConfirmProblemCode } from './confirm-email.js';
 import { type AnonymousProblemCode, type AnonymousSpec } from './anonymous.js';
+import { type ReadersProblemCode } from './readers.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
@@ -163,6 +164,7 @@ declare const extensionShape: {
             group: z.ZodString;
             minimum: z.ZodOptional<z.ZodNumber>;
         }, z.core.$strict>>;
+        readers: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>>>;
     tools: z.ZodOptional<z.ZodObject<{
         generated: z.ZodOptional<z.ZodBoolean>;
@@ -241,7 +243,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_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 | '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.
@@ -340,6 +342,7 @@ export declare const manifestExtensionsSchema: z.ZodObject<{
             group: z.ZodString;
             minimum: z.ZodOptional<z.ZodNumber>;
         }, z.core.$strict>>;
+        readers: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>>>;
     tools: z.ZodOptional<z.ZodObject<{
         generated: z.ZodOptional<z.ZodBoolean>;
@@ -476,6 +479,7 @@ export declare const storedExtensionsSchema: z.ZodObject<{
             group: z.ZodString;
             minimum: z.ZodOptional<z.ZodNumber>;
         }, z.core.$strict>>;
+        readers: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>>>;
     tools: z.ZodOptional<z.ZodObject<{
         generated: z.ZodOptional<z.ZodBoolean>;
@@ -647,6 +651,7 @@ export declare const appManifestSchema: z.ZodObject<{
             group: z.ZodString;
             minimum: z.ZodOptional<z.ZodNumber>;
         }, z.core.$strict>>;
+        readers: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>>>;
     tools: z.ZodOptional<z.ZodObject<{
         generated: z.ZodOptional<z.ZodBoolean>;
@@ -822,6 +827,7 @@ export declare const newAppManifestSchema: z.ZodObject<{
             group: z.ZodString;
             minimum: z.ZodOptional<z.ZodNumber>;
         }, z.core.$strict>>;
+        readers: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>>>;
     tools: z.ZodOptional<z.ZodObject<{
         generated: z.ZodOptional<z.ZodBoolean>;
@@ -914,6 +920,8 @@ export interface CollectionSpec {
     definesFieldsOf?: string;
     /** Answers kept with no writer, read only a whole group of at least `minimum` at a time (P13). */
     anonymous?: AnonymousSpec;
+    /** The string[] field naming who alone may read a record, when it names anyone (P16). */
+    readers?: string;
 }
 /**
  * The singular a collection's tools are named with: the manifest's, else the

package/src/schema.js

@@ -5,6 +5,7 @@ import { migrationsSchema } from "./migrations.js";
 import { openSchemaProblems } from "./open-schema.js";
 import { confirmEmailProblems, confirmEmailSchema } from "./confirm-email.js";
 import { anonymousProblems, anonymousSchema, anonymousSpec } from "./anonymous.js";
+import { readersProblems, readersSchema } from "./readers.js";
 export { COLOUR_TOKENS, FIELD_LIMITS, parseFieldType, RESERVED_FIELDS, structuredFields, } from "./field-types.js";
 /**
  * What an app adds to `.brydio/app.json` to be more than a bundle of servers
@@ -152,6 +153,8 @@ const collectionSchema = z.object({
      * batch, a watch and a create naming its own writer.
      */
     anonymous: anonymousSchema.optional(),
+    /** One of its string[] fields: the user ids who alone may read a record, when it names any (P16). */
+    readers: readersSchema.optional(),
 });
 const screenSchema = z.object({
     /**
@@ -389,6 +392,10 @@ export function dataProblems(additions, options = {}) {
     for (const [collection, declared] of collections) {
         problems.push(...anonymousProblems(collection, declared));
     }
+    // A collection whose records name their readers names a list of user ids to keep them in (P16).
+    for (const [collection, declared] of collections) {
+        problems.push(...readersProblems(collection, declared));
+    }
     // What the app keeps must be what it asks to keep (A3-F06-S01): a
     // collection the grants leave out would be data a workspace never agreed to
     // hold, found only when the first write is refused.
@@ -738,6 +745,7 @@ export function collectionsOf(manifest) {
                 : {}),
             ...(owner ? { definesFieldsOf: owner.name } : {}),
             ...(declared.anonymous ? { anonymous: anonymousSpec(declared.anonymous) } : {}),
+            ...(declared.readers ? { readers: declared.readers } : {}),
         };
     });
 }