@brydio/manifest 0.1.0-alpha.28 → 0.1.0-alpha.29

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brydio/manifest",
-  "version": "0.1.0-alpha.28",
+  "version": "0.1.0-alpha.29",
   "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": "8b1e83d55e0436cb13aa1f082c152ee3f82954ad",
+  "gitHead": "353f8a61e02fa687ca7eb2e7a48d5a73d66d08a0",
   "exports": {
     ".": {
       "types": "./src/index.d.ts",

package/src/field-types.d.ts

@@ -12,7 +12,7 @@ import { type ZodType } from 'zod';
  * and everything downstream — the store, the generated tools, the screen's
  * form — reads that shape, never the manifest's spelling.
  */
-export type FieldKind = 'string' | 'text' | 'enum' | 'member' | 'project' | 'date' | 'number' | 'boolean' | 'string[]' | 'token';
+export type FieldKind = 'string' | 'text' | 'enum' | 'member' | 'project' | 'date' | 'number' | 'boolean' | 'string[]' | 'token' | 'canvas';
 export interface FieldType {
     kind: FieldKind;
     /** Written with a trailing `?`: may be left out on create. */
@@ -27,6 +27,13 @@ export interface FieldType {
      * changes, and a value with no label reads as itself.
      */
     labels?: Readonly<Record<string, string>>;
+    /**
+     * Written by several people at once (`tasks/docs-wiki` DW01): a `text`
+     * field drawn with `bry-rich-text bind` is one fragment of a shared Yjs
+     * document the host keeps. Such a field leaves the record's `version`
+     * check, and a tool's change to it merges into the live text.
+     */
+    coedit?: boolean;
 }
 /**
  * The bounds a schema and a record are held to (A3-F01-S03).
@@ -74,8 +81,8 @@ export declare const FIELD_NAME: RegExp;
 export declare const COLLECTION_NAME: RegExp;
 /** A field type the manifest wrote that Brydio does not have, or a bad list. */
 export declare class FieldTypeInvalid extends Error {
-    readonly code: 'data_field_type_unknown' | 'data_enum_empty' | 'data_enum_too_many' | 'data_enum_value_invalid' | 'data_enum_duplicate' | 'data_default_not_allowed' | 'data_default_on_required' | 'data_default_invalid' | 'data_labels_not_allowed' | 'data_label_invalid' | 'data_label_unknown_value' | 'data_field_key_unknown';
-    constructor(code: 'data_field_type_unknown' | 'data_enum_empty' | 'data_enum_too_many' | 'data_enum_value_invalid' | 'data_enum_duplicate' | 'data_default_not_allowed' | 'data_default_on_required' | 'data_default_invalid' | 'data_labels_not_allowed' | 'data_label_invalid' | 'data_label_unknown_value' | 'data_field_key_unknown', message: string);
+    readonly code: 'data_field_type_unknown' | 'data_enum_empty' | 'data_enum_too_many' | 'data_enum_value_invalid' | 'data_enum_duplicate' | 'data_default_not_allowed' | 'data_default_on_required' | 'data_default_invalid' | 'data_labels_not_allowed' | 'data_label_invalid' | 'data_label_unknown_value' | 'data_field_key_unknown' | 'data_coedit_not_text';
+    constructor(code: 'data_field_type_unknown' | 'data_enum_empty' | 'data_enum_too_many' | 'data_enum_value_invalid' | 'data_enum_duplicate' | 'data_default_not_allowed' | 'data_default_on_required' | 'data_default_invalid' | 'data_labels_not_allowed' | 'data_label_invalid' | 'data_label_unknown_value' | 'data_field_key_unknown' | 'data_coedit_not_text', message: string);
 }
 /**
  * One field's manifest spelling, as a type.
@@ -87,6 +94,16 @@ export declare class FieldTypeInvalid extends Error {
 export declare function parseFieldType(raw: unknown): FieldType;
 /** How long a choice value's label may be. */
 export declare const LABEL_CHARS = 60;
+/** True for a field several people write at once, through the co-editing layer. */
+export declare const isCoedited: (type: FieldType) => boolean;
+/**
+ * What a drawing's field holds in the record (WB01): a summary the host writes
+ * from the live board, so a list, search and the assistant can say what is on
+ * it. The drawing itself lives only in the co-edited document.
+ */
+export declare const CANVAS_SUMMARY_CHARS = 10000;
+/** A collection's co-edited fields, by name. */
+export declare const coeditedFields: (fields: Readonly<Record<string, FieldType>>) => string[];
 /** How a choice's value reads to a person: its label, or the value itself. */
 export declare const labelOfValue: (type: FieldType, value: string) => string;
 /** True for a type whose value lands in the plain `fields` column. */
@@ -127,7 +144,10 @@ type Optional<T> = T extends `${string}?` ? true : T extends {
 /** The TypeScript type of one field's value, from its manifest spelling. */
 export type FieldValue<T> = T extends {
     type: infer U;
-} ? FieldValue<U> : T extends readonly (infer V)[] ? V : T extends 'number' | 'number?' ? number : T extends 'boolean' | 'boolean?' ? boolean : T extends 'string[]' | 'string[]?' ? string[] : T extends 'token' | 'token?' ? (typeof COLOUR_TOKENS)[number] : T extends string ? string : never;
+} ? FieldValue<U> : T extends readonly (infer V)[] ? V : T extends 'number' | 'number?' ? number : T extends 'boolean' | 'boolean?' ? boolean : T extends 'string[]' | 'string[]?' ? string[] : T extends 'token' | 'token?' ? (typeof COLOUR_TOKENS)[number] : T extends 'canvas' | 'canvas?' ? {
+    elements: number;
+    text: string;
+} : T extends string ? string : never;
 type Simplify<T> = {
     [K in keyof T]: T[K];
 } & {};

package/src/field-types.js

@@ -68,7 +68,7 @@ const STRUCTURED = new Set([
 ]);
 /** Only the words in these may one day be searched (A3-F01-S02). */
 const SEARCHABLE = new Set(['string', 'text', 'string[]']);
-const SCALARS = new Set(['string', 'text', 'member', 'project', 'date', 'number', 'boolean', 'token']);
+const SCALARS = new Set(['string', 'text', 'member', 'project', 'date', 'number', 'boolean', 'token', 'canvas']);
 /** A field type the manifest wrote that Brydio does not have, or a bad list. */
 export class FieldTypeInvalid extends Error {
     code;
@@ -99,18 +99,24 @@ export function parseFieldType(raw) {
         return { kind: 'string[]', optional };
     if (name === 'token')
         return { kind: 'token', optional, values: COLOUR_TOKENS };
+    // A drawing is always co-edited and never required: it starts empty (WB01).
+    if (name === 'canvas')
+        return { kind: 'canvas', optional: true, coedit: true };
     if (SCALARS.has(name))
         return { kind: name, optional };
     throw new FieldTypeInvalid('data_field_type_unknown', `"${raw}" is not a field type.`);
 }
-const FIELD_KEYS = new Set(['type', 'optional', 'default', 'labels']);
+const FIELD_KEYS = new Set(['type', 'optional', 'default', 'labels', 'coedit']);
 /** How long a choice value's label may be. */
 export const LABEL_CHARS = 60;
 /** The object form: the short form under `type`, and what it may add. */
 function parseFieldObject(raw) {
     const unknown = Object.keys(raw).find(key => !FIELD_KEYS.has(key));
     if (unknown) {
-        throw new FieldTypeInvalid('data_field_key_unknown', `"${unknown}" is not something a field may say; use type, optional, default and labels.`);
+        throw new FieldTypeInvalid('data_field_key_unknown', `"${unknown}" is not something a field may say; use type, optional, default, labels and coedit.`);
+    }
+    if (raw.coedit !== undefined && typeof raw.coedit !== 'boolean') {
+        throw new FieldTypeInvalid('data_field_key_unknown', '"coedit" is true or false.');
     }
     if (typeof raw.type !== 'string' && !Array.isArray(raw.type)) {
         throw new FieldTypeInvalid('data_field_type_unknown', 'A field written as an object names its type under "type".');
@@ -119,7 +125,12 @@ function parseFieldObject(raw) {
         throw new FieldTypeInvalid('data_field_key_unknown', '"optional" is true or false.');
     }
     const inner = parseFieldType(raw.type);
-    const type = { ...inner, optional: inner.optional || raw.optional === true, ...labelsOf(inner, raw) };
+    const type = {
+        ...inner,
+        optional: inner.optional || raw.optional === true,
+        ...labelsOf(inner, raw),
+        ...coeditOf(inner, raw),
+    };
     if (!('default' in raw))
         return type;
     const value = raw.default;
@@ -157,6 +168,27 @@ function labelsOf(type, raw) {
     }
     return { labels: { ...labels } };
 }
+/** `coedit`, on long text only: nothing else is typed into by several people at once. */
+function coeditOf(type, raw) {
+    if (raw.coedit !== true)
+        return {};
+    if (type.kind !== 'text' && type.kind !== 'canvas') {
+        throw new FieldTypeInvalid('data_coedit_not_text', `Only a text or canvas field may be co-edited, not a ${type.kind}.`);
+    }
+    return { coedit: true };
+}
+/** True for a field several people write at once, through the co-editing layer. */
+export const isCoedited = (type) => type.kind === 'canvas' || (type.kind === 'text' && type.coedit === true);
+/**
+ * What a drawing's field holds in the record (WB01): a summary the host writes
+ * from the live board, so a list, search and the assistant can say what is on
+ * it. The drawing itself lives only in the co-edited document.
+ */
+export const CANVAS_SUMMARY_CHARS = 10_000;
+/** A collection's co-edited fields, by name. */
+export const coeditedFields = (fields) => Object.entries(fields)
+    .filter(([, type]) => isCoedited(type))
+    .map(([field]) => field);
 /** How a choice's value reads to a person: its label, or the value itself. */
 export const labelOfValue = (type, value) => type.labels?.[value] ?? value;
 function parseEnumeration(values) {
@@ -228,6 +260,8 @@ export function valueSchema(type) {
             return z.boolean();
         case 'string[]':
             return z.array(z.string().max(FIELD_LIMITS.stringChars)).max(FIELD_LIMITS.listEntries);
+        case 'canvas':
+            return z.object({ elements: z.number().int().min(0), text: z.string().max(CANVAS_SUMMARY_CHARS) }).strict();
     }
 }
 /**
@@ -263,6 +297,8 @@ export function valueProblem(field, type, value) {
             return Array.isArray(value) && value.length > FIELD_LIMITS.listEntries
                 ? `${field} may hold at most ${FIELD_LIMITS.listEntries} entries.`
                 : `${field} must be a list of short texts, each at most ${FIELD_LIMITS.stringChars.toLocaleString('en-GB')} characters.`;
+        case 'canvas':
+            return `${field} is a drawing: it is changed on its board, never written.`;
     }
 }
 /** A type in a few words, for a tool's description: every allowed value named. */
@@ -288,6 +324,8 @@ export function describeType(type) {
             return 'true or false';
         case 'string[]':
             return 'a list of short texts';
+        case 'canvas':
+            return 'a drawing, read only: how many shapes it has and the words on it';
     }
 }
 /** ", read as \"todo\" is To do, \"done\" is Done", for a choice with labels. */

package/src/index.d.ts

@@ -6,7 +6,7 @@
 export { APP_NAME_FORMAT, MANIFEST_LIMITS, SEMVER_FORMAT, baseManifestSchema, brandImagesSchema } from './base.js';
 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, FIELD_LIMITS, RESERVED_FIELDS, describeType, isSearchable, isSortable, isStructured, parseFieldType, structuredFields, valueProblem, valueSchema, FieldTypeInvalid, type DocumentOf, type FieldKind, type FieldType, type FieldValue, type FieldsOf, } from './field-types.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 { DOCUMENT_LIMITS } from './document-limits.js';
 export { HOST_CAPABILITIES, KNOWN_HOST_GRANTS, isHostCapability, unknownHostGrant } from './grants.js';

package/src/index.js

@@ -6,7 +6,7 @@
 export { APP_NAME_FORMAT, MANIFEST_LIMITS, SEMVER_FORMAT, baseManifestSchema, brandImagesSchema } from "./base.js";
 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, FIELD_LIMITS, RESERVED_FIELDS, describeType, isSearchable, isSortable, isStructured, parseFieldType, structuredFields, valueProblem, valueSchema, FieldTypeInvalid, } from "./field-types.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 { DOCUMENT_LIMITS } from "./document-limits.js";
 export { HOST_CAPABILITIES, KNOWN_HOST_GRANTS, isHostCapability, unknownHostGrant } from "./grants.js";