@crombolo/schema 0.10.0 → 0.11.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crombolo/schema",
-  "version": "0.10.0",
+  "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.10.0",
-    "@crombolo/data": "0.10.0"
+    "@crombolo/core": "0.11.0",
+    "@crombolo/data": "0.11.0"
   }
 }

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/model.ts

@@ -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

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

@@ -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)
 }