@rockcarver/frodo-cli 0.14.0 → 0.14.1

package/src/ops/EmailTemplateOps.ts

@@ -1,19 +0,0 @@
-import { EmailTemplateSkeleton } from '@rockcarver/frodo-lib/types/api/ApiTypes';
-
-/**
- * Get a one-line description of the email template
- * @param {EmailTemplateSkeleton} templateObj email template object to describe
- * @returns {string} a one-line description
- */
-export function getOneLineDescription(
-  templateObj: EmailTemplateSkeleton
-): string {
-  const description = `[${templateObj._id.split('/')[1]['brightCyan']}] ${
-    templateObj.displayName ? templateObj.displayName : ''
-  } - ${
-    templateObj.defaultLocale
-      ? templateObj.subject[templateObj.defaultLocale]
-      : Object.values(templateObj.subject)[0]
-  }`;
-  return description;
-}

package/src/ops/IdpOps.ts

@@ -1,11 +0,0 @@
-import { SocialIdpSkeleton } from "@rockcarver/frodo-lib/types/api/ApiTypes";
-
-/**
- * Get a one-line description of the social idp object
- * @param {SocialIdpSkeleton} socialIdpObj social idp object to describe
- * @returns {string} a one-line description
- */
-export function getOneLineDescription(socialIdpObj: SocialIdpSkeleton): string {
-  const description = `[${socialIdpObj._id['brightCyan']}] ${socialIdpObj._type._id}`;
-  return description;
-}

package/src/ops/JourneyOps.ts

@@ -1,278 +0,0 @@
-import {
-  NodeSkeleton,
-  TreeSkeleton,
-} from '@rockcarver/frodo-lib/types/api/ApiTypes';
-import {
-  SingleTreeExportInterface,
-  TreeDependencyMapInterface,
-  TreeExportResolverInterface,
-} from '@rockcarver/frodo-lib/types/ops/OpsTypes';
-import { printMessage } from '../utils/Console';
-import { Journey, Types, state } from '@rockcarver/frodo-lib';
-import * as CirclesOfTrust from './CirclesOfTrustOps';
-import * as EmailTemplate from './EmailTemplateOps';
-import * as Idp from './IdpOps';
-import * as Node from './NodeOps';
-import * as Saml2 from './Saml2Ops';
-import * as Script from './ScriptOps';
-import * as Theme from './ThemeOps';
-
-const {
-  onlineTreeExportResolver,
-  getTreeDescendents,
-  getNodeRef,
-} = Journey;
-
-/**
- * Get journey classification
- * @param {SingleTreeExportInterface} journey journey export
- * @returns {stringp[]} Colored string array of classifications
- */
-export function getJourneyClassification(journey: SingleTreeExportInterface): string[] {
-  return Journey.getJourneyClassification(journey).map((it) => {
-    switch (it) {
-      case Types.JourneyClassification.STANDARD:
-        return it.toString()['brightGreen'];
-
-      case Types.JourneyClassification.CLOUD:
-        return it.toString()['brightMagenta'];
-
-      case Types.JourneyClassification.CUSTOM:
-        return it.toString()['brightRed'];
-
-      case Types.JourneyClassification.PREMIUM:
-        return it.toString()['brightYellow'];
-    }
-  });
-}
-
-/**
- * Get a one-line description of the tree object
- * @param {TreeSkeleton} treeObj circle of trust object to describe
- * @returns {string} a one-line description
- */
-export function getOneLineDescription(treeObj: TreeSkeleton): string {
-  const description = `[${treeObj._id['brightCyan']}]`;
-  return description;
-}
-
-/**
- * Helper function to render a nested list of dependent trees
- * @param {TreeDependencyMapInterface} descendents tree dependency map
- * @param {number} depth level of nesting
- */
-function describeTreeDescendents(
-  descendents: TreeDependencyMapInterface,
-  depth = 0
-) {
-  if (depth || Object.values(descendents)[0].length) {
-    // heading
-    if (depth === 0) {
-      printMessage(
-        `\nInner Tree Dependencies (${Object.values(descendents)[0].length}):`,
-        'data'
-      );
-    }
-    const indent = Array(depth * 2)
-      .fill(' ')
-      .join('');
-    const [tree] = Object.keys(descendents);
-    printMessage(`${indent}- ${tree['brightCyan']}`, 'data');
-    for (const descendent of descendents[tree]) {
-      describeTreeDescendents(descendent, depth + 1);
-    }
-  }
-}
-
-/**
- * Describe a journey:
- * - Properties, tags, description, name, metadata
- * - Inner tree dependency tree
- * - Node type summary
- * - Nodes
- * - Themes
- * - Scripts
- * - Email templates
- * - Social identity providers
- * - SAML2 entity providers
- * - SAML2 circles of trust
- * @param {SingleTreeExportInterface} journeyData journey export object
- * @param {TreeExportResolverInterface} resolveTreeExport tree export resolver callback function
- */
-export async function describeJourney(
-  journeyData: SingleTreeExportInterface,
-  resolveTreeExport: TreeExportResolverInterface = onlineTreeExportResolver
-): Promise<void> {
-  const allNodes = {
-    ...journeyData.nodes,
-    ...journeyData.innerNodes,
-  };
-  const nodeTypeMap = {};
-
-  for (const nodeData of Object.values(allNodes)) {
-    if (nodeTypeMap[nodeData._type._id]) {
-      nodeTypeMap[nodeData._type._id] += 1;
-    } else {
-      nodeTypeMap[nodeData._type._id] = 1;
-    }
-  }
-
-  // Journey Name
-  printMessage(`${getOneLineDescription(journeyData.tree)}`, 'data');
-  printMessage(Array(`[${journeyData.tree._id}]`['length']).fill('=').join(''));
-
-  // Description
-  if (journeyData.tree.description) {
-    printMessage(`\n${journeyData.tree.description}`, 'data');
-  }
-
-  // Status
-  printMessage(
-    `\nStatus\n${
-      journeyData.tree.enabled === false
-        ? 'disabled'['brightRed']
-        : 'enabled'['brightGreen']
-    }`
-  );
-
-  // Classification
-  if (
-    !state.default.session.getAmVersion() &&
-    journeyData.meta?.originAmVersion
-  ) {
-    state.default.session.setAmVersion(journeyData.meta.originAmVersion);
-  }
-  if (state.default.session.getAmVersion()) {
-    printMessage(
-      `\nClassification\n${getJourneyClassification(journeyData).join(', ')}`,
-      'data'
-    );
-  }
-
-  // Categories/Tags
-  if (journeyData.tree.uiConfig?.categories && journeyData.tree.uiConfig.categories != '[]') {
-    printMessage('\nCategories/Tags', 'data');
-    printMessage(
-      `${
-        JSON.parse(journeyData.tree.uiConfig.categories).join(', ')
-      }`,
-      'data'
-    );
-  }
-
-  // Dependency Tree
-  const descendents = await getTreeDescendents(journeyData, resolveTreeExport);
-  describeTreeDescendents(descendents);
-
-  // Node Types
-  if (Object.entries(nodeTypeMap).length) {
-    printMessage(
-      `\nNode Types (${Object.entries(nodeTypeMap).length}):`,
-      'data'
-    );
-    for (const [nodeType, count] of Object.entries(nodeTypeMap)) {
-      printMessage(
-        `- ${String(count)} [${
-          nodeType['brightCyan']
-        }] (${Node.getNodeClassification(nodeType).join(', ')})`,
-        'data'
-      );
-    }
-  }
-
-  // Nodes
-  if (Object.entries(allNodes).length) {
-    printMessage(`\nNodes (${Object.entries(allNodes).length}):`, 'data');
-    for (const nodeObj of Object.values<NodeSkeleton>(allNodes)) {
-      printMessage(
-        `- ${Node.getOneLineDescription(
-          nodeObj,
-          getNodeRef(nodeObj, journeyData)
-        )}`,
-        'data'
-      );
-    }
-  }
-
-  // Themes
-  if (journeyData.themes?.length) {
-    printMessage(`\nThemes (${journeyData.themes.length}):`, 'data');
-    for (const themeData of journeyData.themes) {
-      printMessage(`- ${Theme.getOneLineDescription(themeData)}`, 'data');
-    }
-  }
-
-  // Scripts
-  if (Object.entries(journeyData.scripts).length) {
-    printMessage(
-      `\nScripts (${Object.entries(journeyData.scripts).length}):`,
-      'data'
-    );
-    for (const scriptData of Object.values(journeyData.scripts)) {
-      printMessage(`- ${Script.getOneLineDescription(scriptData)}`, 'data');
-    }
-  }
-
-  // Email Templates
-  if (Object.entries(journeyData.emailTemplates).length) {
-    printMessage(
-      `\nEmail Templates (${
-        Object.entries(journeyData.emailTemplates).length
-      }):`,
-      'data'
-    );
-    for (const templateData of Object.values(journeyData.emailTemplates)) {
-      printMessage(
-        `- ${EmailTemplate.getOneLineDescription(templateData)}`,
-        'data'
-      );
-    }
-  }
-
-  // Social Identity Providers
-  if (Object.entries(journeyData.socialIdentityProviders).length) {
-    printMessage(
-      `\nSocial Identity Providers (${
-        Object.entries(journeyData.socialIdentityProviders).length
-      }):`,
-      'data'
-    );
-    for (const socialIdpData of Object.values(
-      journeyData.socialIdentityProviders
-    )) {
-      printMessage(`- ${Idp.getOneLineDescription(socialIdpData)}`, 'data');
-    }
-  }
-
-  // SAML2 Entity Providers
-  if (Object.entries(journeyData.saml2Entities).length) {
-    printMessage(
-      `\nSAML2 Entity Providers (${
-        Object.entries(journeyData.saml2Entities).length
-      }):`,
-      'data'
-    );
-    for (const entityProviderData of Object.values(journeyData.saml2Entities)) {
-      printMessage(
-        `- ${Saml2.getOneLineDescription(entityProviderData)}`,
-        'data'
-      );
-    }
-  }
-
-  // SAML2 Circles Of Trust
-  if (Object.entries(journeyData.circlesOfTrust).length) {
-    printMessage(
-      `\nSAML2 Circles Of Trust (${
-        Object.entries(journeyData.circlesOfTrust).length
-      }):`,
-      'data'
-    );
-    for (const cotData of Object.values(journeyData.circlesOfTrust)) {
-      printMessage(
-        `- ${CirclesOfTrust.getOneLineDescription(cotData)}`,
-        'data'
-      );
-    }
-  }
-}

package/src/ops/NodeOps.ts

@@ -1,47 +0,0 @@
-import {
-  InnerNodeRefSkeletonInterface,
-  NodeRefSkeletonInterface,
-  NodeSkeleton,
-} from '@rockcarver/frodo-lib/types/api/ApiTypes';
-import { Node, Types } from '@rockcarver/frodo-lib';
-
-/**
- * Get node classification
- * @param {string} nodeType node type
- * @returns {stringp[]} Colored string array of classifications
- */
-export function getNodeClassification(nodeType: string): string[] {
-  return Node.getNodeClassification(nodeType).map((it) => {
-    switch (it) {
-      case Types.NodeClassification.STANDARD:
-        return it.toString()['brightGreen'];
-
-      case Types.NodeClassification.CLOUD:
-        return it.toString()['brightMagenta'];
-
-      case Types.NodeClassification.CUSTOM:
-        return it.toString()['brightRed'];
-
-      case Types.NodeClassification.PREMIUM:
-        return it.toString()['brightYellow'];
-    }
-  });
-}
-
-/**
- * Get a one-line description of the node
- * @param {NodeSkeleton} nodeObj node object to describe
- * @param {NodeRefSkeletonInterface | InnerNodeRefSkeletonInterface} nodeRef node reference object
- * @returns {string} a one-line description
- */
-export function getOneLineDescription(
-  nodeObj: NodeSkeleton,
-  nodeRef?: NodeRefSkeletonInterface | InnerNodeRefSkeletonInterface
-): string {
-  const description = `[${nodeObj._id['brightCyan']}] (${getNodeClassification(
-    nodeObj._type._id
-  ).join(', ')}) ${nodeObj._type._id}${
-    nodeRef ? ' - ' + nodeRef?.displayName : ''
-  }`;
-  return description;
-}

package/src/ops/Saml2Ops.ts

@@ -1,24 +0,0 @@
-import { Saml2ProviderSkeleton } from '@rockcarver/frodo-lib/types/api/ApiTypes';
-import { Saml2 } from '@rockcarver/frodo-lib';
-
-const { roleMap } = Saml2;
-
-/**
- * Get a one-line description of the saml2 provider object
- * @param {Saml2ProviderSkeleton} saml2ProviderObj saml2 provider object to describe
- * @returns {string} a one-line description
- */
-export function getOneLineDescription(
-  saml2ProviderObj: Saml2ProviderSkeleton
-): string {
-  const roles: string[] = [];
-  for (const [key, value] of Object.entries(roleMap)) {
-    if (saml2ProviderObj[key]) {
-      roles.push(value);
-    }
-  }
-  const description = `[${saml2ProviderObj.entityId['brightCyan']}]${
-    ' (' + saml2ProviderObj.entityLocation
-  }${roles.length ? ' ' + roles.join(', ') + ')' : ')'}`;
-  return description;
-}

package/src/ops/ScriptOps.ts

@@ -1,11 +0,0 @@
-import { ScriptSkeleton } from '@rockcarver/frodo-lib/types/api/ApiTypes';
-
-/**
- * Get a one-line description of the script object
- * @param {ScriptSkeleton} scriptObj script object to describe
- * @returns {string} a one-line description
- */
-export function getOneLineDescription(scriptObj: ScriptSkeleton): string {
-  const description = `[${scriptObj._id['brightCyan']}] ${scriptObj.context} - ${scriptObj.name}`;
-  return description;
-}

package/src/ops/ThemeOps.ts

@@ -1,17 +0,0 @@
-import { ThemeSkeleton } from '@rockcarver/frodo-lib/types/api/ApiTypes';
-
-/**
- * Get a one-line description of the theme
- * @param {ThemeSkeleton} themeObj theme object to describe
- * @returns {string} a one-line description
- */
-export function getOneLineDescription(themeObj: ThemeSkeleton): string {
-  const description = `[${themeObj._id['brightCyan']}] ${
-    themeObj.name
-  }${
-    themeObj.linkedTrees
-      ? ' (' + themeObj.linkedTrees.join(', ')['brightCyan'] + ')'
-      : ''
-  }`;
-  return description;
-}

package/src/ops/utils/Wordwrap.ts

@@ -1,11 +0,0 @@
-export default function wordwrap(str, len, indent = undefined) {
-  if (!str) return '';
-  return (
-    str.match(
-      new RegExp(
-        `(\\S.{0,${len - 1 - (indent ? indent.length : 0)}})(?=\\s+|$)`,
-        'g'
-      )
-    ) || []
-  ).join(indent ? `\n${indent}` : '\n');
-}

package/src/storage/StaticStorage.ts

@@ -1,15 +0,0 @@
-export const DEFAULT_REALM_KEY = '__default__realm__';
-export const CLASSIC_DEPLOYMENT_TYPE_KEY = 'classic';
-export const CLOUD_DEPLOYMENT_TYPE_KEY = 'cloud';
-export const FORGEOPS_DEPLOYMENT_TYPE_KEY = 'forgeops';
-export const DEPLOYMENT_TYPES = [
-  CLASSIC_DEPLOYMENT_TYPE_KEY,
-  CLOUD_DEPLOYMENT_TYPE_KEY,
-  FORGEOPS_DEPLOYMENT_TYPE_KEY,
-];
-export const DEPLOYMENT_TYPE_REALM_MAP = {
-  [CLASSIC_DEPLOYMENT_TYPE_KEY]: '/',
-  [CLOUD_DEPLOYMENT_TYPE_KEY]: 'alpha',
-  [FORGEOPS_DEPLOYMENT_TYPE_KEY]: '/',
-};
-export const FRODO_METADATA_ID = 'frodo';