Class _list

project

delete

• get delete(): (token: string) => DeleteResult

  Returns (token: string) => DeleteResult

deleteNode

• get deleteNode(): (
      nodeToken: string,
  ) => [_operation<any, OperationReference>, boolean]

  Returns (nodeToken: string) => [_operation<any, OperationReference>, boolean]

flatv1

• get flatv1(): (fromNodeToken?: string) => FlatStructureV1

  Returns (fromNodeToken?: string) => FlatStructureV1

flatv2

• get flatv2(): (fromNodeToken?: string) => FlatStructureV2Node[]

  Returns (fromNodeToken?: string) => FlatStructureV2Node[]

forNodes

• get forNodes(): (_node<NodeType> | _structureChild | _listChild)[]

  Returns (_node<NodeType> | _structureChild | _listChild)[]

forRelationships

• get forRelationships(): {
      create_dt?: number;
      f_id?: string;
      f_token?: string;
      r_id?: string;
      r_type?: string;
      t_id?: string;
      t_token?: string;
      update_dt?: number;
  }[]

  Returns {
      create_dt?: number;
      f_id?: string;
      f_token?: string;
      r_id?: string;
      r_type?: string;
      t_id?: string;
      t_token?: string;
      update_dt?: number;
  }[]

fromNodes

• get fromNodes(): (_node<NodeType> | _structureChild | _listChild)[]

  Returns (_node<NodeType> | _structureChild | _listChild)[]

fromRelationships

• get fromRelationships(): {
      create_dt?: number;
      f_id?: string;
      f_token?: string;
      r_id?: string;
      r_type?: string;
      t_id?: string;
      t_token?: string;
      update_dt?: number;
  }[]

  Returns {
      create_dt?: number;
      f_id?: string;
      f_token?: string;
      r_id?: string;
      r_type?: string;
      t_id?: string;
      t_token?: string;
      update_dt?: number;
  }[]

getChildByToken

• get getChildByToken(): (
      nodeId: string,
  ) => {
      child?: string;
      create_dt?: number;
      id?: string;
      meta?: any;
      name?: string;
      token?: string;
      type?: "structure_child";
      update_dt?: number;
  }

  Returns (
      nodeId: string,
  ) => {
      child?: string;
      create_dt?: number;
      id?: string;
      meta?: any;
      name?: string;
      token?: string;
      type?: "structure_child";
      update_dt?: number;
  }

getMetadata

• get getMetadata(): () => MetadataConstructorMap[Type]

  Returns () => MetadataConstructorMap[Type]

hasNode

• get hasNode(): (nodeToken: string) => boolean

  Returns (nodeToken: string) => boolean

inNodes

• get inNodes(): (_node<NodeType> | _structureChild | _listChild)[]

  Returns (_node<NodeType> | _structureChild | _listChild)[]

inRelationships

• get inRelationships(): {
      create_dt?: number;
      f_id?: string;
      f_token?: string;
      r_id?: string;
      r_type?: string;
      t_id?: string;
      t_token?: string;
      update_dt?: number;
  }[]

  Returns {
      create_dt?: number;
      f_id?: string;
      f_token?: string;
      r_id?: string;
      r_type?: string;
      t_id?: string;
      t_token?: string;
      update_dt?: number;
  }[]

jsonReady

• get jsonReady(): IStructureInitOptions

  The function returns a JSON-ready object with the properties of the current object.

  Returns IStructureInitOptions

  an object with the following properties:

nestedv1

• get nestedv1(): () => any

  Returns () => any

nestedv2

• get nestedv2(): <
      T extends
          {
              child?: string;
              create_dt?: number;
              id?: string;
              meta?: any;
              name?: string;
              token?: string;
              type?: "structure_child";
              update_dt?: number;
          } = {
          child?: string;
          create_dt?: number;
          id?: string;
          meta?: any;
          name?: string;
          token?: string;
          type?: "structure_child";
          update_dt?: number;
      },
  >(
      start_token?: string,
      binder?: (
          node: {
              child?: string;
              create_dt?: number;
              id?: string;
              meta?: any;
              name?: string;
              token?: string;
              type?: "structure_child";
              update_dt?: number;
          },
      ) => T,
  ) => NestedStructureResult<T>[]

  Returns <
      T extends
          {
              child?: string;
              create_dt?: number;
              id?: string;
              meta?: any;
              name?: string;
              token?: string;
              type?: "structure_child";
              update_dt?: number;
          } = {
          child?: string;
          create_dt?: number;
          id?: string;
          meta?: any;
          name?: string;
          token?: string;
          type?: "structure_child";
          update_dt?: number;
      },
  >(
      start_token?: string,
      binder?: (
          node: {
              child?: string;
              create_dt?: number;
              id?: string;
              meta?: any;
              name?: string;
              token?: string;
              type?: "structure_child";
              update_dt?: number;
          },
      ) => T,
  ) => NestedStructureResult<T>[]

outNodes

• get outNodes(): (_node<NodeType> | _structureChild | _listChild)[]

  Returns (_node<NodeType> | _structureChild | _listChild)[]

outRelationships

• get outRelationships(): {
      create_dt?: number;
      f_id?: string;
      f_token?: string;
      r_id?: string;
      r_type?: string;
      t_id?: string;
      t_token?: string;
      update_dt?: number;
  }[]

  Returns {
      create_dt?: number;
      f_id?: string;
      f_token?: string;
      r_id?: string;
      r_type?: string;
      t_id?: string;
      t_token?: string;
      update_dt?: number;
  }[]

queryNodeAll

• get queryNodeAll(): (
      query:
          | {
              child?: string;
              create_dt?: number;
              id?: string;
              meta?: any;
              name?: string;
              token?: string;
              type?: "structure_child";
              update_dt?: number;
          }
          | {
              child?: string;
              create_dt?: number;
              id?: string;
              meta?: any;
              name?: string;
              token?: string;
              type?: "list_child";
              update_dt?: number;
          },
  ) => {
      child?: string;
      create_dt?: number;
      id?: string;
      meta?: any;
      name?: string;
      token?: string;
      type?: "structure_child";
      update_dt?: number;
  }[]

  Returns (
      query:
          | {
              child?: string;
              create_dt?: number;
              id?: string;
              meta?: any;
              name?: string;
              token?: string;
              type?: "structure_child";
              update_dt?: number;
          }
          | {
              child?: string;
              create_dt?: number;
              id?: string;
              meta?: any;
              name?: string;
              token?: string;
              type?: "list_child";
              update_dt?: number;
          },
  ) => {
      child?: string;
      create_dt?: number;
      id?: string;
      meta?: any;
      name?: string;
      token?: string;
      type?: "structure_child";
      update_dt?: number;
  }[]

setMetadata

• get setMetadata(): (meta: MetadataConstructorMap[Type]) => void

  Returns (meta: MetadataConstructorMap[Type]) => void

update

• get update(): (
      node: {
          create_dt?: number;
          id?: string;
          meta?: {
              alias?: string;
              assignee?: string;
              author?: string;
              buisnessPhones?: string;
              category?: string;
              children?: any[];
              completeness?: number;
              consistant?: number;
              consistency?: string;
              content?: string;
              correctness?: number;
              dataQuality?: string;
              dateModified?: string;
              dateModifiedValue?: number;
              dbStatus?: string;
              default?: boolean;
              description?: string;
              email?: string;
              endDate?: string;
              estimateCost?: string;
              estimateTime?: string;
              extension?: string;
              external?: {
                  excel?: { token?: string };
                  graph365?: { id?: string; url?: string };
                  jira?: { id?: string; url?: string };
                  relatics?: { id?: string; url?: string };
                  sharepoint?: { id?: string; url?: string };
                  testlink?: { id?: string; url?: string };
              };
              fileSize?: number;
              fileSizeRaw?: number;
              fileType?: string;
              first_name?: string;
              groups?: string;
              itemPath?: string;
              jobTitle?: string;
              key?: string;
              last_name?: string;
              linkItem?: string;
              liveview?: string;
              metatag?: string[];
              mimeType?: string;
              modifiedBy?: string;
              modile?: string;
              officeLocaltion?: string;
              path?: string[];
              preferredLanguage?: string;
              project_id?: string;
              projectStatus?: string;
              rat?: {
                  numericQuality?: string;
                  qualityDate?: string;
                  qualityLevel?: string;
                  qualitySummary?: string;
              };
              ref_extern?: string;
              register_dt?: number;
              remark?: string;
              resolve_dt?: number;
              site?: { id?: string; url?: string };
              startDate?: string;
              status?: string;
              tags?: string[];
              type?: string;
              url?: string;
              userGroup?: string[];
              userPrincipalName?: string;
              validationType?: string;
              value?: string;
              views?: {
                  bubble?: any;
                  forceDirectedTree?: any;
                  listView?: { views?: any };
              };
          };
          name?: string;
          token?: string;
          type?: | "object"
          | "attachement"
          | "order"
          | "deliverable"
          | "contact"
          | "work"
          | "worklog"
          | "entity"
          | "material"
          | "requirement"
          | "register"
          | "test"
          | "file"
          | "functional"
          | "structure"
          | "product"
          | "process"
          | "role"
          | "right"
          | "group"
          | "invoice"
          | "user"
          | "risk"
          | "descision"
          | "action"
          | "list"
          | "project"
          | "system"
          | "application_component"
          | "test_project"
          | "test_build"
          | "test_plan"
          | "test_suite"
          | "test_case"
          | "test_case_execution"
          | "structure_child"
          | "list_child";
          update_dt?: number;
      },
  ) => NodeCreationResult

  Returns (
      node: {
          create_dt?: number;
          id?: string;
          meta?: {
              alias?: string;
              assignee?: string;
              author?: string;
              buisnessPhones?: string;
              category?: string;
              children?: any[];
              completeness?: number;
              consistant?: number;
              consistency?: string;
              content?: string;
              correctness?: number;
              dataQuality?: string;
              dateModified?: string;
              dateModifiedValue?: number;
              dbStatus?: string;
              default?: boolean;
              description?: string;
              email?: string;
              endDate?: string;
              estimateCost?: string;
              estimateTime?: string;
              extension?: string;
              external?: {
                  excel?: { token?: string };
                  graph365?: { id?: string; url?: string };
                  jira?: { id?: string; url?: string };
                  relatics?: { id?: string; url?: string };
                  sharepoint?: { id?: string; url?: string };
                  testlink?: { id?: string; url?: string };
              };
              fileSize?: number;
              fileSizeRaw?: number;
              fileType?: string;
              first_name?: string;
              groups?: string;
              itemPath?: string;
              jobTitle?: string;
              key?: string;
              last_name?: string;
              linkItem?: string;
              liveview?: string;
              metatag?: string[];
              mimeType?: string;
              modifiedBy?: string;
              modile?: string;
              officeLocaltion?: string;
              path?: string[];
              preferredLanguage?: string;
              project_id?: string;
              projectStatus?: string;
              rat?: {
                  numericQuality?: string;
                  qualityDate?: string;
                  qualityLevel?: string;
                  qualitySummary?: string;
              };
              ref_extern?: string;
              register_dt?: number;
              remark?: string;
              resolve_dt?: number;
              site?: { id?: string; url?: string };
              startDate?: string;
              status?: string;
              tags?: string[];
              type?: string;
              url?: string;
              userGroup?: string[];
              userPrincipalName?: string;
              validationType?: string;
              value?: string;
              views?: {
                  bubble?: any;
                  forceDirectedTree?: any;
                  listView?: { views?: any };
              };
          };
          name?: string;
          token?: string;
          type?: | "object"
          | "attachement"
          | "order"
          | "deliverable"
          | "contact"
          | "work"
          | "worklog"
          | "entity"
          | "material"
          | "requirement"
          | "register"
          | "test"
          | "file"
          | "functional"
          | "structure"
          | "product"
          | "process"
          | "role"
          | "right"
          | "group"
          | "invoice"
          | "user"
          | "risk"
          | "descision"
          | "action"
          | "list"
          | "project"
          | "system"
          | "application_component"
          | "test_project"
          | "test_build"
          | "test_plan"
          | "test_suite"
          | "test_case"
          | "test_case_execution"
          | "structure_child"
          | "list_child";
          update_dt?: number;
      },
  ) => NodeCreationResult

flat

• flat(): Record<string, unknown>

  Returns Record<string, unknown>

isComplete

• isComplete(collect: boolean): boolean | ZodError<any>

  Checks if the node structure is complete by verifying that all child nodes have at least one relationship.

  A structure is considered complete when:

  • The node has valid metadata and project references
  • All children defined in the metadata have at least one 'HAS_LINK' relationship

  Parameters

  • collect: boolean

  Returns boolean | ZodError<any>

  • true if all children have at least one relationship
  • false if any child is missing relationships
  • null if metadata or project references are missing

isConsistant

• isConsistant(): void

  Returns void

isCorrect

• isCorrect(collect: boolean): boolean | ZodError<any>

  Validates the structure of the node by checking its relationships and linked nodes.

  This method performs two main validations:

  1. Verifies that all links point to existing nodes in the project
  2. Ensures that all linked nodes are of the expected type as defined in metadata

  The validation is performed using Zod schema validation with custom refinements.

  Parameters

  • collect: boolean

  Returns boolean | ZodError<any>

  Returns:

  • true if the structure is valid
  • false if any validation fails
  • null if metadata or project is not available

  Example

  const node = new StructureNode();
  const isValid = node.isCorrect();
  if (isValid === true) {
    // Structure is valid
  }
  Copy

json

• json(): _list & { meta: IStructureNodeMetadata }

  Returns _list & { meta: IStructureNodeMetadata }

linkFor

• linkFor(forNodeToken: string): RelationCreationResult

  Define link from this node is for node

  Will produce a link IS_{{node.type}}_FOR

  Parameters

  • forNodeToken: string

  Returns RelationCreationResult

linkFrom

• linkFrom(fromNodeToken: string): RelationCreationResult

  Define link from parent to this node

  Will produce a link HAS_{{parent_node.type}}

  Parameters

  • fromNodeToken: string

  Returns RelationCreationResult

linkTo

• linkTo(toNodeToken: string): RelationCreationResult

  Define link from this node to children node

  Will produce a link HAS_{{this_node.type}}

  Parameters

  • toNodeToken: string

  Returns RelationCreationResult

setMetaDataKey

• setMetaDataKey(key: string, value: any): void

  Parameters

  • key: string
  • value: any

  Returns void

shema

• shema(): JSONSchema3or4

  Returns JSONSchema3or4