@crombolo/schema 0.13.1 → 0.14.1

package/package.json

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

package/src/export.ts

@@ -69,6 +69,7 @@ function toSchemaProperty(p: PropertyTypeModel, ctx: ExportContext): SchemaPrope
   if (p.memberCanEdit) property.memberCanEdit = true
   if (p.isSensitive) property.sensitive = true
   if (p.searchable === false) property.searchable = false
+  if (p.siteSearch !== undefined && p.siteSearch !== 'normal') property.siteSearch = p.siteSearch
   return property
 }
 
@@ -109,6 +110,7 @@ export function toSchemaContentType(
     tabs: [],
   }
   if (aggregate.description) type.description = aggregate.description
+  if (aggregate.siteSearch === false) type.siteSearch = false
   if (aggregate.defaultComponentKey) {
     const alias = ctx.componentAlias(aggregate.defaultComponentKey)
     if (alias) type.defaultComponent = alias

package/src/model.ts

@@ -1,4 +1,4 @@
-import type { SchemaForm, SchemaWorkflow } from '@crombolo/core'
+import type { SchemaForm, SchemaWorkflow, SiteSearchLevel } from '@crombolo/core'
 
 /**
  * The schema-as-code model: what a site's `schema/*.toml` files describe.
@@ -28,6 +28,8 @@ export interface SchemaProperty {
   sensitive?: boolean
   /** False keeps the property's values out of backoffice search; searchable when absent. */
   searchable?: boolean
+  /** Its weight in site search, or false to leave it out; `normal` when absent. */
+  siteSearch?: SiteSearchLevel | false
   /** Fills existing content when a required property is added to a type with pages. */
   default?: unknown
   since?: string
@@ -73,6 +75,8 @@ export interface SchemaContentType {
   folder?: string
   cleanup: SchemaCleanup
   since?: string
+  /** False leaves every page of the type out of site search. */
+  siteSearch?: false
   /** Properties outside any tab. */
   properties: SchemaProperty[]
   /** Groups outside any tab — `[[group]]`; Umbraco's built-in media types use one. */

package/src/parse.ts

@@ -3,6 +3,7 @@
  * the most common mistake a non-developer makes and silently ignoring it would
  * hide the thing they were trying to do.
  */
+import { SITE_SEARCH_LEVELS, type SiteSearchLevel } from '@crombolo/core'
 import {
   type SchemaContentType,
   type SchemaDataType,
@@ -23,6 +24,7 @@ const PROPERTY_KEYS = [
   'member-can-edit',
   'sensitive',
   'searchable',
+  'site-search',
   'key',
   'alias',
   'name',
@@ -61,6 +63,7 @@ const TYPE_KEYS = [
   'folder',
   'cleanup',
   'since',
+  'site-search',
 ] as const
 const CLEANUP_KEYS = [
   'prevent',
@@ -104,11 +107,22 @@ function property(r: Reader, t: Toml, path: string): SchemaProperty {
       : {}),
     ...(t.sensitive !== undefined ? { sensitive: r.bool(t, 'sensitive', path, false) } : {}),
     ...(t.searchable !== undefined ? { searchable: r.bool(t, 'searchable', path, true) } : {}),
+    ...(t['site-search'] !== undefined ? { siteSearch: siteSearchLevel(r, t, path) } : {}),
     default: t.default,
     since: r.str(t, 'since', path),
   }
 }
 
+/** `site-search` on a property: a level, or false to leave it out. */
+function siteSearchLevel(r: Reader, t: Toml, path: string): SiteSearchLevel | false {
+  const value = t['site-search']
+  if (value === false) return false
+  if (typeof value === 'string' && (SITE_SEARCH_LEVELS as readonly string[]).includes(value))
+    return value as SiteSearchLevel
+  r.problem(`${path}.site-search`, `expected false or one of ${SITE_SEARCH_LEVELS.join(', ')}`)
+  return 'normal'
+}
+
 function group(r: Reader, t: Toml, path: string): SchemaGroup {
   r.unknown(t, GROUP_KEYS, path)
   return {
@@ -132,9 +146,9 @@ function tab(r: Reader, t: Toml, path: string): SchemaTab {
   }
 }
 
-/** Media types have no templates and no version cleanup policy. */
+/** Media types have no templates, no version cleanup policy, and are not pages to search. */
 const MEDIA_TYPE_KEYS = TYPE_KEYS.filter(
-  (k) => k !== 'components' && k !== 'default-component' && k !== 'cleanup',
+  (k) => k !== 'components' && k !== 'default-component' && k !== 'cleanup' && k !== 'site-search',
 )
 /** Member types, besides, allow no children: members are not a tree. */
 const MEMBER_TYPE_KEYS = MEDIA_TYPE_KEYS.filter((k) => k !== 'allow-children')
@@ -190,6 +204,9 @@ export function parseContentType(
         : undefined,
     },
     since: r.str(t, 'since', path),
+    ...(t['site-search'] !== undefined && typeSiteSearch(r, t, path) === false
+      ? { siteSearch: false as const }
+      : {}),
     properties: r.tables(root.property, 'property').map((p, i) => property(r, p, `property[${i}]`)),
     tabs: r.tables(root.tab, 'tab').map((x, i) => tab(r, x, `tab[${i}]`)),
     groups: r.tables(root.group, 'group').map((g, i) => group(r, g, `group[${i}]`)),
@@ -197,6 +214,13 @@ export function parseContentType(
   return { value: r.problems.length === 0 ? value : undefined, problems: r.problems }
 }
 
+/** `site-search` on a content type: only false, which leaves its pages out. */
+function typeSiteSearch(r: Reader, t: Toml, path: string): false | undefined {
+  if (t['site-search'] === false) return false
+  r.problem(`${path}.site-search`, 'expected false; a page type is searchable unless it says so')
+  return undefined
+}
+
 export function parseMediaType(file: string, source: string): ParseResult<SchemaContentType> {
   return parseContentType(file, source, 'media')
 }

package/src/sync.ts

@@ -240,8 +240,15 @@ export async function syncSchema(
         for (const d of set.dataTypes) {
           const existing = await dataTypes.byAlias(d.alias)
           const builtin = BUILTIN_DATA_TYPES.find((b) => b.alias === d.alias)
-          const key = d.key ?? existing?.key ?? crypto.randomUUID()
-          if (!d.key && !existing)
+          // A key this site has never had, for an alias it has, is that data
+          // type: the row keeps its key and the file is given it (story 105).
+          const rekeyed =
+            d.key !== undefined &&
+            existing !== undefined &&
+            existing.key.toLowerCase() !== d.key.toLowerCase() &&
+            !(await dataTypes.byKey(d.key))
+          const key = (rekeyed ? existing?.key : d.key) ?? existing?.key ?? crypto.randomUUID()
+          if ((!d.key && !existing) || rekeyed)
             report.assignedKeys.push({
               file: loaded.files.get(`data-type:${d.alias}`) ?? '',
               typeAlias: d.alias,
@@ -370,17 +377,35 @@ export async function syncSchema(
             type: SchemaContentType
             aggregate: ContentTypeAggregate
           }> = []
+          const fileTypeKeys = new Set(
+            kind.types.flatMap((t) => (t.key ? [t.key.toLowerCase()] : [])),
+          )
           for (const t of inCompositionOrder(kind.types)) {
             const file = loaded.files.get(typeFileKey(kind.name, t.alias)) ?? ''
-            const existing = t.key
+            let existing = t.key
               ? await kind.repo.byKey(t.key)
               : await kind.repo.byAlias(t.alias, { includeRetired: true })
+            // A key this site has never had, for an alias it has and no other
+            // file claims, is that type — as a property's is: the row keeps its
+            // key, and the file is given it (story 105).
+            let rekeyed = false
+            if (!existing && t.key) {
+              const sameAlias = await kind.repo.byAlias(t.alias, { includeRetired: true })
+              if (sameAlias && !fileTypeKeys.has(sameAlias.key.toLowerCase())) {
+                existing = sameAlias
+                rekeyed = true
+              }
+            }
             const shippedKey =
               kind.name === 'document'
                 ? SYSTEM_CONTENT_TYPES.find((d) => d.alias === t.alias)?.key
                 : undefined
-            const key = t.key ?? existing?.key ?? shippedKey ?? crypto.randomUUID()
-            if (!t.key && !existing)
+            const key =
+              (rekeyed ? existing?.key : t.key) ??
+              existing?.key ??
+              shippedKey ??
+              crypto.randomUUID()
+            if ((!t.key && !existing) || rekeyed)
               report.assignedKeys.push({ file, typeAlias: t.alias, key, revived: false })
             typeKeyByAlias.set(t.alias, key)
             const retired = existing ? await kind.repo.retiredProperties(existing.key) : []
@@ -454,6 +479,7 @@ export async function syncSchema(
                 memberCanEdit: p.memberCanEdit === true,
                 isSensitive: p.sensitive === true,
                 searchable: p.searchable !== false,
+                siteSearch: p.siteSearch ?? 'normal',
               }
             }
             // Groups have no key in the file; they match an existing group of the same name.
@@ -524,6 +550,7 @@ export async function syncSchema(
                 allowedInLibrary: t.allowInLibrary,
                 collectionKey: t.collection ? (dataTypeKeyByAlias.get(t.collection) ?? null) : null,
                 sinceVersion: t.since ?? null,
+                siteSearch: t.siteSearch !== false,
                 cleanup: {
                   preventCleanup: t.cleanup.prevent,
                   keepAllVersionsNewerThanDays: t.cleanup.keepAllNewerThanDays ?? null,

package/src/write.ts

@@ -67,6 +67,7 @@ function writeProperty(out: string[], header: string, p: SchemaProperty): void {
   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, 'site-search', p.siteSearch, p.siteSearch !== 'normal')
   line(out, 'default', p.default)
   line(out, 'since', p.since)
 }
@@ -91,6 +92,7 @@ export function writeContentType(t: SchemaContentType, kind: SchemaTypeKind = 'd
   line(out, 'collection', t.collection)
   line(out, 'folder', t.folder)
   line(out, 'since', t.since)
+  line(out, 'site-search', false, t.siteSearch === false)
   if (
     t.cleanup.prevent ||
     t.cleanup.keepAllNewerThanDays !== undefined ||