@crombolo/schema 0.9.1 → 0.11.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crombolo/schema",
-  "version": "0.9.1",
+  "version": "0.11.0",
   "description": "Schema-as-code for crombolo: TOML document, media and member type definitions.",
   "license": "MIT",
   "author": "Crombolo",
@@ -28,7 +28,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@crombolo/core": "0.9.1",
-    "@crombolo/data": "0.9.1"
+    "@crombolo/core": "0.11.0",
+    "@crombolo/data": "0.11.0"
   }
 }

package/src/check.ts

@@ -1,7 +1,7 @@
 /**
  * The pre-upgrade check: what would this change do to the data, and what does
  * it need? One function behind `crombolo upgrade check` and `crombolo schema
- * check`. Read-only. docs/10-packaging-and-upgrades.md, "Three kinds of finding".
+ * check`. Read-only. docs/packaging-and-upgrades.md, "Three kinds of finding".
  */
 import type { ContentTypeAggregate, PropertyTypeModel } from '@crombolo/core'
 import { DEFAULT_BACKOFFICE_PATH } from '@crombolo/core'

package/src/export.ts

@@ -67,6 +67,7 @@ function toSchemaProperty(p: PropertyTypeModel, ctx: ExportContext): SchemaPrope
   if (p.memberCanView) property.memberCanView = true
   if (p.memberCanEdit) property.memberCanEdit = true
   if (p.isSensitive) property.sensitive = true
+  if (p.searchable === false) property.searchable = false
   return property
 }
 

package/src/forms.ts

@@ -2,7 +2,7 @@
  * The form model, and the closed set of field types it may use.
  *
  * A form definition is structure, so it is a file like every other type
- * (`docs/18-forms.md`). Field types are an internal registry rather than an
+ * (`docs/forms.md`). Field types are an internal registry rather than an
  * extension point: the TOML vocabulary, the validator, the renderer and the
  * entry value shape all have to agree, and freezing that contract before
  * anything has stressed it would be a promise made too early.

package/src/model.ts

@@ -2,7 +2,7 @@ import type { SchemaForm } from '@crombolo/core'
 
 /**
  * The schema-as-code model: what a site's `schema/*.toml` files describe.
- * The shapes mirror the TOML vocabulary in docs/09-schema-as-code.md, with
+ * The shapes mirror the TOML vocabulary in docs/schema-as-code.md, with
  * defaults applied, so the rest of the system never sees a missing key.
  */
 export interface SchemaProperty {
@@ -26,6 +26,8 @@ export interface SchemaProperty {
   memberCanEdit?: boolean
   /** Member types only: hidden from users without sensitive-data access. */
   sensitive?: boolean
+  /** False keeps the property's values out of backoffice search; searchable when absent. */
+  searchable?: boolean
   /** Fills existing content when a required property is added to a type with pages. */
   default?: unknown
   since?: string
@@ -108,7 +110,7 @@ export interface SchemaSet {
   memberTypes?: SchemaContentType[]
   dataTypes: SchemaDataType[]
   languages: SchemaLanguage[]
-  /** `schema/forms/*.toml` — form definitions; see `docs/18-forms.md`. */
+  /** `schema/forms/*.toml` — form definitions; see `docs/forms.md`. */
   forms?: SchemaForm[]
 }
 

package/src/parse.ts

@@ -21,6 +21,7 @@ const PROPERTY_KEYS = [
   'member-can-view',
   'member-can-edit',
   'sensitive',
+  'searchable',
   'key',
   'alias',
   'name',
@@ -101,6 +102,7 @@ function property(r: Reader, t: Toml, path: string): SchemaProperty {
       ? { memberCanEdit: r.bool(t, 'member-can-edit', path, false) }
       : {}),
     ...(t.sensitive !== undefined ? { sensitive: r.bool(t, 'sensitive', path, false) } : {}),
+    ...(t.searchable !== undefined ? { searchable: r.bool(t, 'searchable', path, true) } : {}),
     default: t.default,
     since: r.str(t, 'since', path),
   }

package/src/sync.ts

@@ -1,7 +1,7 @@
 /**
  * Files → database. Version-gated, locked, and never destructive: removal is
  * retirement, and a type with content refuses to disappear. The algorithm and
- * the multi-node rules are in docs/09-schema-as-code.md, "Synchronisation".
+ * the multi-node rules are in docs/schema-as-code.md, "Synchronisation".
  */
 import { type ContentTypeAggregate, ObjectTypes, type PropertyTypeModel } from '@crombolo/core'
 import {
@@ -418,6 +418,7 @@ export async function syncSchema(
                 memberCanView: p.memberCanView === true,
                 memberCanEdit: p.memberCanEdit === true,
                 isSensitive: p.sensitive === true,
+                searchable: p.searchable !== false,
               }
             }
             // Groups have no key in the file; they match an existing group of the same name.

package/src/write.ts

@@ -65,6 +65,7 @@ function writeProperty(out: string[], header: string, p: SchemaProperty): void {
   line(out, 'member-can-view', true, p.memberCanView === true)
   line(out, 'member-can-edit', true, p.memberCanEdit === true)
   line(out, 'sensitive', true, p.sensitive === true)
+  line(out, 'searchable', false, p.searchable === false)
   line(out, 'default', p.default)
   line(out, 'since', p.since)
 }