@obelism/content 0.10.0 → 0.12.0

package/README.md

@@ -316,7 +316,9 @@ npx @obelism/content model plan    # what applying would change
 npx @obelism/content model apply   # apply it, all or nothing
 ```
 
-Options: `--file`, `--url` (or `$CONTENT_URL`), `--prune`. In GitHub Actions
+Options: `--file`, `--url` (or `$CONTENT_URL`), `--prune`, and for `apply`
+`--lock` (the environment's model becomes managed in code: read-only in the
+dashboard, the agent API and MCP) or `--unlock`. In GitHub Actions
 the plan is also written to the job summary.
 
 ### Types

package/dist/bin/content.js

@@ -285,7 +285,7 @@ const managementApi = (url, token, fetchImpl = fetch)=>async (method, path, body
         }
     };
 // Exit code: 0 done, 1 problems in the plan.
-const runModelCommand = async ({ command, file, url, token, prune, log = console.log, summaryFile, fetch: fetchImpl = fetch })=>{
+const runModelCommand = async ({ command, file, url, token, prune, lock, log = console.log, summaryFile, fetch: fetchImpl = fetch })=>{
     const call = managementApi(url, token, fetchImpl);
     if (command === 'pull') {
         const { ok, json } = await call('GET', '/model');
@@ -312,7 +312,10 @@ const runModelCommand = async ({ command, file, url, token, prune, log = console
     }
     const { ok, status, json } = await call('POST', command === 'plan' ? '/model/plan' : '/model/apply', {
         model,
-        prune
+        prune,
+        ...command === 'apply' && lock !== undefined && {
+            lock
+        }
     });
     // A plan with issues, or an apply refused for them, still has the plan.
     const plan = json.changes || json.issues ? json : null;
@@ -321,6 +324,9 @@ const runModelCommand = async ({ command, file, url, token, prune, log = console
     log(formatPlan(plan, {
         applied
     }));
+    if (applied && lock !== undefined) {
+        log(lock ? 'The model is now managed in code: read-only in the dashboard.' : 'The model can be changed in the dashboard again.');
+    }
     if (summaryFile) {
         await promises.appendFile(summaryFile, `${formatPlan(plan, {
             markdown: true,
@@ -680,6 +686,7 @@ const runTypesCommand = async ({ dir, file, url, token, cwd = process.cwd(), log
 
 const USAGE = `Usage: content init [--dir content] [--url origin] [--skip-install]
        content model <pull|plan|apply> [--file path] [--url origin] [--prune]
+                     [--lock | --unlock]
        content types [--dir content] [--file path] [--url origin]
 
   init          start a site's repository on the token's environment: the
@@ -698,6 +705,9 @@ const USAGE = `Usage: content init [--dir content] [--url origin] [--skip-instal
                   reads it instead of pulling the model
   --url           the CMS (default $CONTENT_URL, else ${config.DEFAULT_URL})
   --prune         plan and apply also delete content types the file leaves out
+  --lock          apply also marks the environment's model as managed in code:
+                  read-only in the dashboard, the agent API and MCP
+  --unlock        apply also gives the model back to the dashboard
 
 Needs CONTENT_MANAGEMENT_TOKEN: a management token from Space settings
 (not for types --file).`;
@@ -717,6 +727,14 @@ const main = async ()=>{
                     type: 'boolean',
                     default: false
                 },
+                lock: {
+                    type: 'boolean',
+                    default: false
+                },
+                unlock: {
+                    type: 'boolean',
+                    default: false
+                },
                 dir: {
                     type: 'string',
                     default: 'content'
@@ -767,12 +785,19 @@ const main = async ()=>{
             install: !values['skip-install']
         });
     }
+    if (values.lock && values.unlock) {
+        throw new CliError(`Use --lock or --unlock, not both.\n\n${USAGE}`, 2);
+    }
+    if ((values.lock || values.unlock) && modelCommand !== 'apply') {
+        throw new CliError(`--lock and --unlock go with model apply.\n\n${USAGE}`, 2);
+    }
     return runModelCommand({
         command: modelCommand,
         file: values.file ?? 'content/content-model.json',
         url,
         token,
         prune: values.prune,
+        lock: values.lock ? true : values.unlock ? false : undefined,
         summaryFile: process.env.GITHUB_STEP_SUMMARY || undefined
     });
 };

package/dist/index.d.mts

@@ -1,5 +1,5 @@
-import { R as RichTextFormat, E as Entry, a as RedirectList, b as Redirect, c as EntryList, M as ModelFile, A as Asset, B as Block, I as ImproveBlock, d as EntryStub, e as RichTextNode } from './types-gc2dwaqa.js';
-export { C as ContentTypeDefinition, f as ContentTypeKind, g as Environment, F as FieldDefinition, h as FieldType, i as RichTextDocument, j as RichTextMark } from './types-gc2dwaqa.js';
+import { R as RichTextFormat, E as Entry, a as RedirectList, b as Redirect, c as EntryList, M as ModelFile, A as Asset, B as Block, I as ImproveBlock, d as EntryStub, e as RichTextNode } from './types-hmpsikmo.js';
+export { C as ContentTypeDefinition, f as ContentTypeKind, g as Environment, F as FieldDefinition, h as FieldType, i as RichTextDocument, j as RichTextMark } from './types-hmpsikmo.js';
 
 type ContentClientOptions = {
     token: string;

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { R as RichTextFormat, E as Entry, a as RedirectList, b as Redirect, c as EntryList, M as ModelFile, A as Asset, B as Block, I as ImproveBlock, d as EntryStub, e as RichTextNode } from './types-gc2dwaqa.js';
-export { C as ContentTypeDefinition, f as ContentTypeKind, g as Environment, F as FieldDefinition, h as FieldType, i as RichTextDocument, j as RichTextMark } from './types-gc2dwaqa.js';
+import { R as RichTextFormat, E as Entry, a as RedirectList, b as Redirect, c as EntryList, M as ModelFile, A as Asset, B as Block, I as ImproveBlock, d as EntryStub, e as RichTextNode } from './types-hmpsikmo.js';
+export { C as ContentTypeDefinition, f as ContentTypeKind, g as Environment, F as FieldDefinition, h as FieldType, i as RichTextDocument, j as RichTextMark } from './types-hmpsikmo.js';
 
 type ContentClientOptions = {
     token: string;

package/dist/{types-gc2dwaqa.d.ts → types-hmpsikmo.d.ts}

@@ -84,10 +84,15 @@ type FieldDefinition = BaseField & ({
     minLength?: number;
     maxLength?: number;
     pattern?: string;
+    format?: 'url' | 'email' | 'color' | 'slug';
+    unique?: boolean;
+    defaultValue?: string;
 } | {
     type: 'textarea';
     minLength?: number;
     maxLength?: number;
+    pattern?: string;
+    defaultValue?: string;
 } | {
     type: 'richtext';
 } | {
@@ -95,8 +100,11 @@ type FieldDefinition = BaseField & ({
     integer?: boolean;
     min?: number;
     max?: number;
+    unique?: boolean;
+    defaultValue?: number;
 } | {
     type: 'boolean';
+    defaultValue?: boolean;
 } | {
     type: 'datetime';
     withTime?: boolean;
@@ -107,14 +115,19 @@ type FieldDefinition = BaseField & ({
         value: string;
         label: string;
     }[];
+    defaultValue?: string | string[];
 } | {
     type: 'asset';
     multiple?: boolean;
     mimeTypes?: string[];
+    min?: number;
+    max?: number;
 } | {
     type: 'reference';
     multiple?: boolean;
     contentTypes?: string[];
+    min?: number;
+    max?: number;
 } | {
     type: 'blocks';
     allowedBlocks?: string[];
@@ -138,4 +151,4 @@ type ModelFile = {
 };
 
 export type { Asset as A, Block as B, ContentTypeDefinition as C, Entry as E, FieldDefinition as F, ImproveBlock as I, ModelFile as M, RichTextFormat as R, RedirectList as a, Redirect as b, EntryList as c, EntryStub as d, RichTextNode as e, ContentTypeKind as f, Environment as g, FieldType as h, RichTextDocument as i, RichTextMark as j };
-//# sourceMappingURL=types-gc2dwaqa.d.ts.map
+//# sourceMappingURL=types-hmpsikmo.d.ts.map

package/dist/{types-gc2dwaqa.d.ts.map → types-hmpsikmo.d.ts.map}

@@ -1 +1 @@
-{"version":3,"file":"types-gc2dwaqa.d.ts","sources":["../src/types.ts"],"mappings":"AAAA,KAAK,WAAW;AAChB,KAAK,cAAc;AACnB,KAAK,KAAK;AACV;AACA;AACA;AACA;AACA;AACA;AACA;AACA,oBAAoB,MAAM;AAC1B,kBAAkB,MAAM;AACxB;AACA;AACA;AACA;AACA;AACA,KAAK,KAAK,iBAAiB,MAAM,oBAAoB,MAAM;AAC3D;AACA;AACA;AACA;AACA;AACA,WAAW,MAAM;AACjB;AACA;AACA;AACA;AACA;AACA,KAAK,SAAS;AACd;AACA;AACA;AACA,KAAK,KAAK,iBAAiB,MAAM,oBAAoB,MAAM;AAC3D;AACA;AACA;AACA,KAAK,YAAY,gBAAgB,KAAK,GAAG,KAAK,IAAI,KAAK;AACvD;AACA;AACA,cAAc,MAAM;AACpB;AACA,KAAK,YAAY;AACjB;AACA,YAAY,MAAM;AAClB;AACA,KAAK,YAAY;AACjB;AACA,YAAY,MAAM;AAClB,cAAc,YAAY;AAC1B;AACA,YAAY,YAAY;AACxB;AACA,KAAK,gBAAgB,GAAG,YAAY;AACpC;AACA;AACA,KAAK,SAAS,gBAAgB,KAAK,GAAG,KAAK;AAC3C;AACA;AACA;AACA;AACA;AACA,KAAK,QAAQ;AACb;AACA;AACA;AACA;AACA,KAAK,YAAY;AACjB,WAAW,QAAQ;AACnB;AACA;AACA;AACA;AACA,KAAK,eAAe;AACpB,KAAK,SAAS;AACd;AACA;AACA;AACA;AACA;AACA;AACA,KAAK,eAAe,GAAG,SAAS;AAChC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,KAAK,SAAS,GAAG,eAAe;AAChC,KAAK,qBAAqB;AAC1B;AACA;AACA,UAAU,eAAe;AACzB;AACA,YAAY,eAAe;AAC3B;AACA,KAAK,SAAS;AACd;AACA;AACA,kBAAkB,qBAAqB;AACvC;;","names":[]}
+{"version":3,"file":"types-hmpsikmo.d.ts","sources":["../src/types.ts"],"mappings":"AAAA,KAAK,WAAW;AAChB,KAAK,cAAc;AACnB,KAAK,KAAK;AACV;AACA;AACA;AACA;AACA;AACA;AACA;AACA,oBAAoB,MAAM;AAC1B,kBAAkB,MAAM;AACxB;AACA;AACA;AACA;AACA;AACA,KAAK,KAAK,iBAAiB,MAAM,oBAAoB,MAAM;AAC3D;AACA;AACA;AACA;AACA;AACA,WAAW,MAAM;AACjB;AACA;AACA;AACA;AACA;AACA,KAAK,SAAS;AACd;AACA;AACA;AACA,KAAK,KAAK,iBAAiB,MAAM,oBAAoB,MAAM;AAC3D;AACA;AACA;AACA,KAAK,YAAY,gBAAgB,KAAK,GAAG,KAAK,IAAI,KAAK;AACvD;AACA;AACA,cAAc,MAAM;AACpB;AACA,KAAK,YAAY;AACjB;AACA,YAAY,MAAM;AAClB;AACA,KAAK,YAAY;AACjB;AACA,YAAY,MAAM;AAClB,cAAc,YAAY;AAC1B;AACA,YAAY,YAAY;AACxB;AACA,KAAK,gBAAgB,GAAG,YAAY;AACpC;AACA;AACA,KAAK,SAAS,gBAAgB,KAAK,GAAG,KAAK;AAC3C;AACA;AACA;AACA;AACA;AACA,KAAK,QAAQ;AACb;AACA;AACA;AACA;AACA,KAAK,YAAY;AACjB,WAAW,QAAQ;AACnB;AACA;AACA;AACA;AACA,KAAK,eAAe;AACpB,KAAK,SAAS;AACd;AACA;AACA;AACA;AACA;AACA;AACA,KAAK,eAAe,GAAG,SAAS;AAChC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,KAAK,SAAS,GAAG,eAAe;AAChC,KAAK,qBAAqB;AAC1B;AACA;AACA,UAAU,eAAe;AACzB;AACA,YAAY,eAAe;AAC3B;AACA,KAAK,SAAS;AACd;AACA;AACA,kBAAkB,qBAAqB;AACvC;;","names":[]}

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@obelism/content",
 	"description": "Obelism Content SDK: the delivery API client, the visual editor bridge with prompt editing, editing on your own site, webhook verification, and the content model CLI",
-	"version": "0.10.0",
+	"version": "0.12.0",
 	"keywords": [
 		"cms",
 		"headless-cms",