Type Alias Journey

fileByIdTreeExportResolver

onlineTreeExportResolver

countJourneys

• countJourneys(): Promise<number>

  Count all journeys in the active realm.

  Returns Promise<number>

  exact count when supported by the backing API

createFileParamTreeExportResolver

• createFileParamTreeExportResolver(file: string): TreeExportResolverInterface

  Factory that creates a tree export resolver used to resolve a tree id to a full export of that tree from a multi-tree export file.

  Parameters

  • file: string

    multi-tree export file

  Returns TreeExportResolverInterface

  tree export resolver

createJourney

• createJourney(
      journeyId: string,
      journeyData: TreeSkeleton,
  ): Promise<TreeSkeleton>

  Create journey without dependencies.

  Parameters

  • journeyId: string

    journey id/name

  • journeyData: TreeSkeleton

    journey payload object

  Returns Promise<TreeSkeleton>

  a promise that resolves to a journey object

createMultiTreeExportTemplate

• createMultiTreeExportTemplate(): MultiTreeExportInterface

  Create an empty multi tree export template

  Returns MultiTreeExportInterface

  an empty multi tree export template

createSingleTreeExportTemplate

• createSingleTreeExportTemplate(): SingleTreeExportInterface

  Create an empty single tree export template

  Returns SingleTreeExportInterface

  an empty single tree export template

deleteJourney

• deleteJourney(
      journeyId: string,
      options: { deep: boolean; progress?: boolean; verbose: boolean },
  ): Promise<DeleteJourneyStatus>

  Delete a journey

  Parameters

  • journeyId: string

    journey id/name

  • options: { deep: boolean; progress?: boolean; verbose: boolean }

    deep=true also delete all the nodes and inner nodes, verbose=true print verbose info

  Returns Promise<DeleteJourneyStatus>

deleteJourneys

• deleteJourneys(
      options: { deep: boolean; verbose: boolean },
      resultCallback?: ResultCallback<DeleteJourneyStatus>,
  ): Promise<DeleteJourneysStatus>

  Delete all journeys

  Parameters

  • options: { deep: boolean; verbose: boolean }

    deep=true also delete all the nodes and inner nodes, verbose=true print verbose info

  • OptionalresultCallback: ResultCallback<DeleteJourneyStatus>

    Optional callback to process individual results

  Returns Promise<DeleteJourneysStatus>

disableJourney

• disableJourney(journeyId: string): Promise<TreeSkeleton>

  Disable a journey

  Parameters

  • journeyId: string

    journey id/name

  Returns Promise<TreeSkeleton>

  the updated tree/journey object

enableJourney

• enableJourney(journeyId: string): Promise<TreeSkeleton>

  Enable a journey

  Parameters

  • journeyId: string

    journey id/name

  Returns Promise<TreeSkeleton>

  the updated tree/journey object

exportJourney

• exportJourney(
      treeId: string,
      options?: TreeExportOptions,
  ): Promise<MultiTreeExportInterface>

  Create export data for a tree/journey with all its nodes and dependencies. The export data can be written to a file as is.

  Parameters

  • treeId: string

    tree id/name

  • Optionaloptions: TreeExportOptions

    export options

  Returns Promise<MultiTreeExportInterface>

  a promise that resolves to an object containing the tree and any exported dependencies

exportJourneys

• exportJourneys(
      options?: TreeExportOptions,
      resultCallback?: ResultCallback<SingleTreeExportInterface>,
  ): Promise<MultiTreeExportInterface>

  Create export data for all trees/journeys with all their nodes and dependencies. The export data can be written to a file as is.

  Parameters

  • Optionaloptions: TreeExportOptions

    export options

  • OptionalresultCallback: ResultCallback<SingleTreeExportInterface>

    Optional callback to process individual results

  Returns Promise<MultiTreeExportInterface>

  a promise that resolves to an object containing the trees and all their nodes and dependencies

findScriptReferences

• findScriptReferences(scriptId: string): Promise<ScriptReference[]>

  Find every journey/node that references a given script, by scanning all nodes in the active realm for a matching script id and cross-referencing against every journey's node map. Also resolves references nested inside a container node (e.g. a Page Node), reporting the top-level node a journey actually references alongside the inner node that uses the script.

  Parameters

  • scriptId: string

    script id to find references to

  Returns Promise<ScriptReference[]>

  a promise that resolves to every reference found

getNodeRef

• getNodeRef(
      nodeObj: NodeSkeleton,
      singleTreeExport: SingleTreeExportInterface,
  ): NodeRefSkeletonInterface | InnerNodeRefSkeletonInterface

  Get the node reference obbject for a node object. Node reference objects are used in a tree flow definition and within page nodes to reference nodes. Among other things, node references contain all the non-configuration meta data that exists for readaility, like the x/y coordinates of the node and the display name chosen by the tree designer. The dislay name is the only intuitive link between the graphical representation of the tree and the node configurations that make up the tree.

  Parameters

  • nodeObj: NodeSkeleton

    node object to retrieve the node reference object for

  • singleTreeExport: SingleTreeExportInterface

    tree export with or without dependencies

  Returns NodeRefSkeletonInterface | InnerNodeRefSkeletonInterface

  node reference object

getTreeDescendents

• getTreeDescendents(
      treeExport: SingleTreeExportInterface,
      resolveTreeExport: TreeExportResolverInterface,
      resolvedTreeIds?: string[],
  ): Promise<TreeDependencyMapInterface>

  Get tree dependencies (all descendent inner trees)

  Parameters

  • treeExport: SingleTreeExportInterface

    single tree export

  • resolveTreeExport: TreeExportResolverInterface

    tree export resolver callback function

  • OptionalresolvedTreeIds: string[]

    list of tree ids wich have already been resolved

  Returns Promise<TreeDependencyMapInterface>

  a promise that resolves to a tree dependency map

importJourney

• importJourney(
      treeObject: SingleTreeExportInterface,
      options: TreeImportOptions,
  ): Promise<TreeSkeleton>

  Import journey

  Parameters

  • treeObject: SingleTreeExportInterface

    tree object containing tree and all its dependencies

  • options: TreeImportOptions

    import options

  Returns Promise<TreeSkeleton>

  a promise that resolves to a journey object

importJourneys

• importJourneys(
      importData: MultiTreeExportInterface,
      options: TreeImportOptions,
      resultCallback?: ResultCallback<TreeSkeleton>,
  ): Promise<TreeSkeleton[]>

  Import journeys

  Parameters

  • importData: MultiTreeExportInterface

    map of trees object

  • options: TreeImportOptions

    import options

  • OptionalresultCallback: ResultCallback<TreeSkeleton>

    Optional callback to process individual results

  Returns Promise<TreeSkeleton[]>

  Remarks

  The complete batch is validated before reading installed journeys or writing any journey. If validation fails, the batch is rejected without partially importing valid journeys.

readJourney

• readJourney(journeyId: string): Promise<TreeSkeleton>

  Read journey without dependencies.

  Parameters

  • journeyId: string

    journey id/name

  Returns Promise<TreeSkeleton>

  a promise that resolves to a journey object

readJourneys

• readJourneys(): Promise<TreeSkeleton[]>

  Read all journeys without dependencies.

  Returns Promise<TreeSkeleton[]>

  a promise that resolves to an array of journey objects

resolveDependencies

• resolveDependencies(
      installedJorneys: any,
      journeyMap: any,
      unresolvedJourneys: any,
      resolvedJourneys: any,
      index?: number,
  ): Promise<void>

  Resolve journey dependencies

  Parameters

  • installedJorneys: any

    Map of installed journeys

  • journeyMap: any

    Map of journeys to resolve dependencies for

  • unresolvedJourneys: any

    Map to hold the names of unresolved journeys and their dependencies

  • resolvedJourneys: any

    Array to hold the names of resolved journeys

  • Optionalindex: number

    Depth of recursion

  Returns Promise<void>

updateJourney

• updateJourney(
      journeyId: string,
      journeyData: TreeSkeleton,
  ): Promise<TreeSkeleton>

  Update journey without dependencies.

  Parameters

  • journeyId: string

    journey id/name

  • journeyData: TreeSkeleton

    journey payload object

  Returns Promise<TreeSkeleton>

  a promise that resolves to a journey object

validateJourneys

• validateJourneys(
      journeyIds?: string[],
      journeysExport?: MultiTreeExportInterface,
  ): Promise<JourneyValidationFinding[]>

  Validate journeys for referential integrity.

  journeyIds	journeysExport	Behavior
  omitted, null or []	omitted	Read and validate all journeys in the realm.
  ['login']	omitted	Read and validate journey login from the realm.
  omitted, null or []	supplied	Validate all journeys in the export offline.
  ['login']	supplied	Validate tree login in the export offline.

  Duplicate IDs are processed once. Live validation reads each journey once; findings are returned without printing. When verbose, live validation prints the export trace as exportJourney does (findings are never printed). Missing, blank, or unreadable journeys are reported together after all requested journeys are processed.

  Parameters

  • OptionaljourneyIds: string[]

    journey names; omit or pass an empty array to validate all journeys

  • OptionaljourneysExport: MultiTreeExportInterface

    optional export; when supplied, validation is offline

  Returns Promise<JourneyValidationFinding[]>

  validation findings