contensis-cli 1.6.1-beta.21 → 1.6.1-beta.23

package/docs/copy_field_templates.md

@@ -352,3 +352,115 @@ Or we can refer to other fields in the `entry` variable
 ```handlebars
 {{entry.text}}{% if entry.heading %} - {{entry.heading}}{% endif %}
 ```
+
+### Transforming fields inside Canvas blocks
+
+Canvas fields contain an array of blocks (objects with `id`, `type`, `value`, `properties`). Some blocks are components (`_component` type with `properties.component`) that hold nested fields inside `value`. To transform those inner fields - for example converting a rich text field inside a component to canvas format - you need to rebuild the canvas array by iterating over the blocks and selectively transforming the ones you need.
+
+This is done using the `capture` tag to build the output as a JSON string, then `from_json | json` to validate and minify the result.
+
+#### Example: Convert rich text to canvas inside a component block
+
+Given a canvas field containing a `linkedComponent` block with a `richText` field:
+
+```json
+{
+  "id": "5b03fe6a",
+  "type": "_component",
+  "properties": { "component": "linkedComponent" },
+  "value": {
+    "entry": [{ "sys": { "id": "abc123", "dataFormat": "entry" } }],
+    "title": "My component",
+    "richText": "<h2>Original rich text</h2>",
+    "canvas": null
+  }
+}
+```
+
+This template converts `richText` to canvas via `html_to_canvas`, storing it in the `canvas` field. Other blocks pass through unchanged:
+
+```handlebars
+{% capture out %}
+[
+{%- for b in value -%}
+{%- if forloop.index0 > 0 %},{% endif -%}
+{%- if b.properties.component == "linkedComponent" -%}
+{
+  "id": {{ b.id | json }},
+  "type": {{ b.type | json }},
+  "properties": {{ b.properties | json }},
+  "value": {
+    "entry": {{ b.value.entry | json }},
+    "title": {{ b.value.title | json }},
+    "richText": {{ b.value.richText | json }},
+    "canvas": {% if b.value.richText and b.value.richText != "" %}{{ b.value.richText | html_to_canvas | json }}{% else %}{{ b.value.canvas | json }}{% endif %}
+  }
+}
+{%- else -%}
+{{ b | json }}
+{%- endif -%}
+{%- endfor -%}
+]
+{% endcapture %}
+{{ out | from_json | json }}
+```
+
+#### How it works
+
+1. `{% capture out %}` starts building the output as a JSON string
+2. The outer `[` opens the canvas array
+3. `{% for b in value %}` iterates over every block in the canvas
+4. `{% if b.properties.component == "linkedComponent" %}` matches the block we want to transform
+5. Each field in the block is mapped with `|json` to ensure valid JSON output (strings get quotes, objects serialize correctly)
+6. The `canvas` field conditionally applies `html_to_canvas` when `richText` exists, otherwise passes the existing value through
+7. `{% else %}` passes non-matching blocks through unchanged via `{{ b | json }}`
+8. `{% endcapture %}` closes the string, then `{{ out | from_json | json }}` parses and re-serializes to validate the JSON
+
+#### Why `|json` is needed on every mapped field
+
+Without it, strings would render bare (invalid JSON: `hello` instead of `"hello"`) and objects would render as `[object Object]`. The `|json` filter handles strings, objects, arrays, nulls, and booleans correctly.
+
+#### Handling nested component blocks
+
+If a canvas block contains a repeatable array of sub-components, you can nest the same pattern. For example, a `nestingLinkedComponent` block has `linkedComponent[]` items, each with their own `richText` and `canvas`:
+
+```handlebars
+{% capture out %}
+[
+{%- for b in value -%}
+{%- if forloop.index0 > 0 %},{% endif -%}
+{%- if b.properties.component == "nestingLinkedComponent" -%}
+{
+  "id": {{ b.id | json }},
+  "type": {{ b.type | json }},
+  "properties": {{ b.properties | json }},
+  "value": {
+    "linkedComponent": [
+    {%- for it in b.value.linkedComponent -%}
+    {%- if forloop.index0 > 0 %},{% endif -%}
+    {
+      "entry": {{ it.entry | json }},
+      "title": {{ it.title | json }},
+      "richText": {{ it.richText | json }},
+      "canvas": {% if it.richText and it.richText != "" %}{{ it.richText | html_to_canvas | json }}{% else %}{{ it.canvas | json }}{% endif %}
+    }
+    {%- endfor -%}
+    ],
+    "singleLinkedComponent": {
+      "entry": {{ b.value.singleLinkedComponent.entry | json }},
+      "title": {{ b.value.singleLinkedComponent.title | json }},
+      "richText": {{ b.value.singleLinkedComponent.richText | json }},
+      "canvas": {% if b.value.singleLinkedComponent.richText and b.value.singleLinkedComponent.richText != "" %}{{ b.value.singleLinkedComponent.richText | html_to_canvas | json }}{% else %}{{ b.value.singleLinkedComponent.canvas | json }}{% endif %}
+    }
+  }
+}
+{%- else -%}
+{{ b | json }}
+{%- endif -%}
+{%- endfor -%}
+]
+{% endcapture %}
+{{ out | from_json | json }}
+```
+
+The same `richText` to `canvas` conversion is applied to each item in the repeatable `linkedComponent` array and to the singular `singleLinkedComponent` block.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "contensis-cli",
-  "version": "1.6.1-beta.21",
+  "version": "1.6.1-beta.23",
   "description": "A fully featured Contensis command line interface with a shell UI provides simple and intuitive ways to manage or profile your content in any NodeJS terminal.",
   "repository": {
     "type": "git",
@@ -25,7 +25,7 @@
     "package-lock": "npm i --package-lock-only --workspaces false"
   },
   "author": "Zengenti",
-  "license": "ISC",
+  "license": "GPL-3.0",
   "dependencies": {
     "@action-validator/core": "^0.6.0",
     "@inquirer/prompts": "^8.2.0",
@@ -43,7 +43,7 @@
     "inquirer-command-prompt": "^0.1.0",
     "keytar": "^7.9.0",
     "lodash": "^4.17.21",
-    "migratortron": "^1.0.0-beta.88",
+    "migratortron": "^1.0.0-beta.89",
     "nanospinner": "^1.2.0",
     "node-fetch": "^2.6.7",
     "parse-git-config": "^3.0.0",

package/src/commands/set.ts

@@ -35,18 +35,19 @@ Example call:
     .command('renderer')
     .description('assign a renderer to a node')
     .argument('<"node path or id">', 'the path or id of the node to update')
-    .argument('<rendererUuid>', 'the renderer uuid to assign to the node')
+    .argument('<rendererUuidOrName>', 'the renderer uuid, id or name to assign to the node')
     .option(
       '--is-partial-match-root',
       'should the renderer be used as the partial match root for the node',
       false
     )
-    .usage('<"node path or id"> <rendererUuid>')
+    .usage('<"node path or id"> <rendererUuidOrName>')
     .addHelpText(
       'after',
       `
 Example call:
-  > set node renderer /path 1502f64e-e9b1-436b-b62f-e273f639ecb6 --is-partial-match-root\n`
+  > set node renderer /path 1502f64e-e9b1-436b-b62f-e273f639ecb6 --is-partial-match-root
+  > set node renderer /path my-block --is-partial-match-root\n`
     )
     .action(async (nodePathOrId: string, rendererId: string, opts) => {
       await cliCommand(['set', 'node', 'renderer'], opts).CreateOrUpdateNode(

package/src/localisation/en-GB.ts

@@ -325,6 +325,10 @@ export const LogMessages = {
       `[${env}] Unable to find renderer ${Logger.highlightText(
         name
       )} in project ${projectId}`,
+    resolved: (env: string, name: string, uuid: string) =>
+      `[${env}] Resolved renderer ${Logger.highlightText(
+        name
+      )} to uuid ${Logger.highlightText(uuid)}`,
     created: (env: string, name: string, projectId: string) =>
       `[${env}] Created renderer ${Logger.highlightText(
         name

package/src/services/ContensisCliService.ts

@@ -5,6 +5,7 @@ import inquirer from 'inquirer';
 import fetch from 'node-fetch';
 import path from 'path';
 import clone from 'rfdc';
+import type { CommanderError } from 'commander';
 
 import { Component, ContentType, Project } from 'contensis-core-api';
 import {
@@ -74,9 +75,9 @@ import { GetTagGroupsArgs } from 'migratortron/dist/services/TagGroupsMigrationS
 let insecurePasswordWarningShown = false;
 
 class ContensisCli {
-  static quit = (error?: Error) => {
+  static quit = (error?: CommanderError) => {
     process.removeAllListeners('exit');
-    const exitCode = error ? 1 : 0;
+    const exitCode = error?.exitCode ?? (error ? 1 : 0);
 
     // console.info(`\nExiting contensis-cli with exit code: ${exitCode}\n`);
     process.exit(exitCode);
@@ -2818,7 +2819,32 @@ class ContensisCli {
         if (nodeById) existingNode = nodeById;
       }
 
-      // TODO: resolve any renderer id to its uuid so we can support passing the regular id for ease of use
+      // Resolve a friendly renderer id/name to its uuid for ease of use
+      const rendererRef = nodeUpdates.renderer?.id;
+      if (rendererRef && !isUuid(rendererRef)) {
+        const [, renderers] = await contensis.renderers.GetRenderers();
+        const match = renderers?.find(
+          r =>
+            r.id?.toLowerCase() === rendererRef.toLowerCase() ||
+            r.name?.toLowerCase() === rendererRef.toLowerCase()
+        );
+        if (match) {
+          log.info(
+            messages.renderers.resolved(
+              currentEnv,
+              rendererRef,
+              match.uuid
+            )
+          );
+          nodeUpdates.renderer.id = match.uuid;
+        } else {
+          log.error(
+            messages.renderers.failedGet(currentEnv, rendererRef, currentProject)
+          );
+          return;
+        }
+      }
+
       if (!existingNode) {
         // Build a node object to create or reject if there is not enough data
 

package/src/version.ts

@@ -1 +1 @@
-export const LIB_VERSION = "1.6.1-beta.21";
+export const LIB_VERSION = "1.6.1-beta.23";