contensis-cli 1.6.1-beta.13 → 1.6.1-beta.15

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "contensis-cli",
-  "version": "1.6.1-beta.13",
+  "version": "1.6.1-beta.15",
   "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",

package/src/commands/create.ts

@@ -71,6 +71,54 @@ Example call:
       );
     });
 
+  create
+    .command('node')
+    .description('create a new site view node')
+    .argument('<"node path or id">', 'the path or id of the node to create')
+    .argument(
+      '["display name"]',
+      'provide a separate display name for the node (optional)'
+    )
+    .argument(
+      '["slug"]',
+      'provide a slug for the node (defaults to slug from provided node path)'
+    )
+    .option(
+      '--include-in-menu',
+      'set include in menu flag on the created node',
+      false
+    )
+    .option(
+      '--language <language>',
+      'language of the node to create (defaults to current project primary language)'
+    )
+    .option('--entry-id <entryId>', 'attach an entry to the node')
+    .usage(
+      '<"node path or id"> ["display name"] (both args in "double quotes")'
+    )
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > create node /test "Test Node" --include-in-menu\n`
+    )
+    .action(
+      async (
+        pathOrId: string,
+        displayName: string,
+        slug: string,
+        opts: any
+      ) => {
+        await cliCommand(['create', 'node', pathOrId], opts).CreateOrUpdateNode(
+          pathOrId,
+          opts,
+          displayName,
+          slug,
+          opts.language
+        );
+      }
+    );
+
   create
     .command('role')
     .description('create a new role')

package/src/commands/set.ts

@@ -1,4 +1,4 @@
-import { Argument, Command } from 'commander';
+import { Argument, Command, Option } from 'commander';
 import { cliCommand } from '~/services/ContensisCliService';
 import { shell } from '~/shell';
 
@@ -10,6 +10,56 @@ export const makeSetCommand = () => {
     .showHelpAfterError(true)
     .exitOverride();
 
+  const node = set.command('node').description('update a site view node');
+
+  node
+    .command('entry')
+    .description('assign an entry to a node')
+    .argument('<"node path or id">', 'the path or id of the node to update')
+    .argument('<entryId>', 'the new entry id to assign to the node')
+    .usage('<"node path or id"> <entryId>')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > set node entry /path 1502f64e-e9b1-436b-b62f-e273f639ecb6\n`
+    )
+    .action(async (nodePathOrId: string, entryId: string, opts) => {
+      await cliCommand(['set', 'node', 'entry'], opts).CreateOrUpdateNode(
+        nodePathOrId,
+        { entryId }
+      );
+    });
+
+  node
+    .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')
+    .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>')
+    .addHelpText(
+      'after',
+      `
+Example call:
+  > set node renderer /path 1502f64e-e9b1-436b-b62f-e273f639ecb6 --is-partial-match-root\n`
+    )
+    .action(async (nodePathOrId: string, rendererId: string, opts) => {
+      await cliCommand(['set', 'node', 'renderer'], opts).CreateOrUpdateNode(
+        nodePathOrId,
+        {
+          renderer: {
+            id: rendererId,
+            isPartialMatchRoot: opts.isPartialMatchRoot,
+          },
+        }
+      );
+    });
+
   const project = set
     .command('project')
     .description('set current working project')
@@ -178,6 +228,21 @@ Example call:
       '--entry-languages [entry-languages...]',
       'the entry languages to add to the role permissions'
     )
+    .addOption(
+      new Option(
+        '--block-actions [block-actions...]',
+        'the block actions to add to the role permissions'
+      ).choices([
+        'push',
+        'release',
+        'manageLive',
+        'manualStartStop',
+        'markAsBroken',
+        'delete',
+        'view',
+        '*',
+      ])
+    )
     .addHelpText(
       'after',
       `
@@ -194,6 +259,9 @@ Example call:
               actions: opts.entryActions || [],
               languages: opts.entryLanguages || [],
             })),
+            blocks: opts.blockActions
+              ? { actions: opts.blockActions }
+              : undefined,
           },
         }
       );

package/src/localisation/en-GB.ts

@@ -188,6 +188,14 @@ export const LogMessages = {
         depth ? ` to a depth of ${depth}` : ``
       }\n`,
     noChange: (env: string) => `[${env}] No changes to be made`,
+    setPayload: () => `Updating node with details\n`,
+    set: (env: string) => `[${env}] Succesfully updated node\n`,
+    failedSet: (env: string, name?: string) =>
+      `[${env}] Unable to update node ${Logger.highlightText(name)}`,
+    created: (env: string, name: string) =>
+      `[${env}] Created node ${Logger.highlightText(name)}\n`,
+    failedCreate: (env: string, name?: string) =>
+      `[${env}] Unable to create node ${Logger.highlightText(name)}`,
   },
   contenttypes: {
     list: (projectId: string) =>

package/src/services/ContensisCliService.ts

@@ -8,8 +8,10 @@ import clone from 'rfdc';
 
 import { Component, ContentType, Project } from 'contensis-core-api';
 import {
+  ICreateNode,
   ICreateTag,
   ICreateTagGroup,
+  Node,
   Role,
   Tag,
   TagGroup,
@@ -23,6 +25,7 @@ import {
   Model,
   BlockActionType,
   logEntitiesTable,
+  Renderer,
 } from 'migratortron';
 
 import ContensisAuthService from './ContensisAuthService';
@@ -2774,6 +2777,142 @@ class ContensisCli {
     }
   };
 
+  CreateOrUpdateNode = async (
+    nodePathOrId: string,
+    nodeUpdates: Partial<Node>,
+    displayName?: string | undefined,
+    slug?: string | undefined,
+    language?: string | undefined
+  ) => {
+    const { currentEnv, currentProject, log, messages } = this;
+    const contensis = await this.ConnectContensis();
+
+    const nodePath = nodePathOrId.startsWith('/') ? nodePathOrId : undefined;
+    let nodeId = isUuid(nodePathOrId) ? nodePathOrId : undefined;
+
+    let existingNode: Node | undefined;
+    let parentNode: Node | undefined;
+    let updateNode: Node | undefined;
+
+    if (contensis) {
+      // Retrieve node
+      if (nodePath) {
+        const [, nodesByPath] = await to(contensis.nodes.GetNodes(nodePath, 0));
+
+        if (Array.isArray(nodesByPath) && nodesByPath[0]?.id) {
+          nodeId = nodesByPath[0].id;
+        }
+      }
+
+      if (nodeId) {
+        // Get the management node so we can update it
+        const [, nodeById] = await to(
+          contensis.source.repo.GetNodeById(nodeId)
+        );
+
+        if (nodeById) existingNode = nodeById;
+      }
+
+      // TODO: resolve any renderer id to its uuid so we can support passing the regular id for ease of use
+      if (!existingNode) {
+        // Build a node object to create or reject if there is not enough data
+
+        if (!language) {
+          const project =
+            await contensis.source.repo.GetProject(currentProject);
+          language = project?.primaryLanguage || 'en-GB';
+        }
+
+        if (!nodeUpdates.parentId) {
+          // Find the node's parentId from the path if possible
+          if (!nodePath)
+            throw new Error(
+              `A node with id "${nodeId}" does not exist, and a path was not provided to find the parent node.`
+            );
+
+          const parentPath =
+            nodePath.substring(0, nodePath.lastIndexOf('/')) || '/';
+          const [, parentNodesByPath] = await to(
+            contensis.nodes.GetNodes(parentPath, 0)
+          );
+
+          if (!parentNodesByPath?.[0]?.id)
+            throw new Error(
+              `A node with id "${nodeId}" does not exist, and the parent node could not be found at path "${parentPath}".`
+            );
+          else parentNode = parentNodesByPath[0] as unknown as Node;
+        }
+        const pathSlug = nodePath?.substring(nodePath.lastIndexOf('/') + 1);
+
+        const createNode: ICreateNode = {
+          id: nodeId,
+          parentId: nodeUpdates.parentId || parentNode?.id,
+          projectId: currentProject,
+          displayName: displayName
+            ? {
+                [language]: displayName,
+              }
+            : nodeUpdates.displayName
+              ? nodeUpdates.displayName
+              : pathSlug
+                ? {
+                    [language]: pathSlug,
+                  }
+                : (undefined as any),
+          slug: slug
+            ? {
+                [language]: slug,
+              }
+            : nodeUpdates.slug
+              ? nodeUpdates.slug
+              : pathSlug
+                ? {
+                    [language]: pathSlug,
+                  }
+                : (undefined as any),
+          entryId: nodeUpdates.entryId,
+          isCanonical: nodeUpdates.isCanonical,
+          renderer: nodeUpdates.renderer,
+          proxy: nodeUpdates.proxy,
+          includeInMenu: nodeUpdates.includeInMenu,
+        };
+
+        // Validate createNode
+        updateNode = createNode as Node;
+      } else {
+        updateNode = { ...existingNode, ...nodeUpdates };
+      }
+
+      if (updateNode) {
+        log.info(messages.nodes.setPayload());
+        log.object(updateNode);
+        const [err, newNode] = await contensis.source.repo.UpdateOrCreateNode(
+          existingNode as Node,
+          updateNode
+        );
+
+        if (err)
+          log.error(
+            messages.nodes[existingNode ? 'failedSet' : 'failedCreate'](
+              currentEnv,
+              nodePathOrId
+            ),
+            err
+          );
+        else if (newNode) {
+          log.success(
+            messages.nodes[existingNode ? 'set' : 'created'](
+              currentEnv,
+              newNode.id
+            )
+          );
+
+          await this.HandleFormattingAndOutput(newNode, log.object);
+        }
+      }
+    }
+  };
+
   PrintWebhookSubscriptions = async (subscriptionIdsOrNames?: string[]) => {
     const { currentEnv, log, messages } = this;
     const contensis = await this.ConnectContensis();
@@ -3372,7 +3511,6 @@ class ContensisCli {
     }
   };
 
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   PrintRenderers = async (rendererId?: string) => {
     const { currentEnv, env, log, messages } = this;
     const contensis = await this.ConnectContensis();
@@ -3381,19 +3519,27 @@ class ContensisCli {
       const [err, renderers] = await contensis.renderers.GetRenderers();
 
       if (Array.isArray(renderers)) {
-        await this.HandleFormattingAndOutput(renderers, () => {
+        const result = rendererId
+          ? ([renderers.find(r => r.id === rendererId)].filter(
+              Boolean
+            ) as Renderer[])
+          : renderers || [];
+
+        await this.HandleFormattingAndOutput(result, () => {
           // print the renderers to console
           log.success(messages.renderers.list(currentEnv, env.currentProject));
           for (const {
+            uuid,
             id,
             description,
             assignedContentTypes,
             rules,
             version,
-          } of renderers) {
+          } of result) {
             console.log(
               `  - ${id} [${version.versionNo}] ${log.infoText`${description}`}`
             );
+            console.log(log.infoText`      uuid: ${uuid}`);
             if (assignedContentTypes?.length)
               console.log(
                 log.infoText`      assignedContentTypes: ${assignedContentTypes.join(
@@ -3409,7 +3555,7 @@ class ContensisCli {
                 );
           }
         });
-        return renderers;
+        return result;
       }
 
       if (err) {

package/src/shell.ts

@@ -142,12 +142,15 @@ class ContensisShell {
         'login',
         'list projects',
         'set project',
-        ...(this.env?.projects || []).map(project => `set project ${project.id}`)
+        ...(this.env?.projects || []).map(
+          project => `set project ${project.id}`
+        )
       );
     if (userId)
       availableCommands.push(
         'copy field',
         'create key',
+        'create node',
         'create project',
         'create role',
         'create tag',
@@ -208,6 +211,8 @@ class ContensisShell {
         'remove tags',
         'remove tags in',
         'remove taggroup',
+        'set node entry',
+        'set node renderer',
         'set project name',
         'set project description',
         'set role name',

package/src/version.ts

@@ -1 +1 @@
-export const LIB_VERSION = "1.6.1-beta.13";
+export const LIB_VERSION = "1.6.1-beta.15";