@brydio/manifest 0.1.0-alpha.39 → 0.1.0-alpha.40

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brydio/manifest",
-  "version": "0.1.0-alpha.39",
+  "version": "0.1.0-alpha.40",
   "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": "4b20d567d9361683e104ec609d231111bd93bcbf",
+  "gitHead": "5ed892628acced988a9686e371721619ff50798c",
   "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' | 'canvas';
+export type FieldKind = 'string' | 'text' | 'enum' | 'member' | 'project' | 'date' | 'number' | 'boolean' | 'string[]' | 'token' | 'canvas' | 'ref';
 export interface FieldType {
     kind: FieldKind;
     /** Written with a trailing `?`: may be left out on create. */
@@ -96,6 +96,10 @@ 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' | '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);
 }
+/** The longest record id a `ref` field holds. */
+export declare const REF_CHARS = 128;
+/** What a record id looks like: letters, digits, `_` and `-`; never words. */
+export declare const REF_FORMAT: RegExp;
 /**
  * One field's manifest spelling, as a type.
  *

package/src/field-types.js

@@ -65,10 +65,12 @@ const STRUCTURED = new Set([
     'number',
     'boolean',
     'token',
+    // Another of the app's records, by id (DW06): an id, never words, so a list can name it.
+    'ref',
 ]);
 /** 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', 'canvas']);
+const SCALARS = new Set(['string', 'text', 'member', 'project', 'date', 'number', 'boolean', 'token', 'canvas', 'ref']);
 /** A field type the manifest wrote that Brydio does not have, or a bad list. */
 export class FieldTypeInvalid extends Error {
     code;
@@ -78,6 +80,10 @@ export class FieldTypeInvalid extends Error {
         this.name = 'FieldTypeInvalid';
     }
 }
+/** The longest record id a `ref` field holds. */
+export const REF_CHARS = 128;
+/** What a record id looks like: letters, digits, `_` and `-`; never words. */
+export const REF_FORMAT = /^[A-Za-z0-9_-]+$/;
 /**
  * One field's manifest spelling, as a type.
  *
@@ -262,6 +268,8 @@ export function valueSchema(type) {
             return z.array(z.string().max(FIELD_LIMITS.stringChars)).max(type.maxEntries ?? FIELD_LIMITS.listEntries);
         case 'canvas':
             return z.object({ elements: z.number().int().min(0), text: z.string().max(CANVAS_SUMMARY_CHARS) }).strict();
+        case 'ref':
+            return z.string().min(1).max(REF_CHARS).regex(REF_FORMAT);
     }
 }
 /**
@@ -299,6 +307,8 @@ export function valueProblem(field, type, value) {
                 : `${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.`;
+        case 'ref':
+            return `${field} must be the id of one of this app's records.`;
     }
 }
 /** A type in a few words, for a tool's description: every allowed value named. */
@@ -326,6 +336,8 @@ export function describeType(type) {
             return 'a list of short texts';
         case 'canvas':
             return 'a drawing, read only: how many shapes it has and the words on it';
+        case 'ref':
+            return "the id of another of this app's records";
     }
 }
 /** ", read as \"todo\" is To do, \"done\" is Done", for a choice with labels. */