Class _structure

The Structure class represents a node structure and provides methods for manipulating and querying the structure.

Hierarchy (View Summary)

_node<"structure">
- _structure
  - _list

Implements

IStructure

Constructors

constructor

new _structure(
options: IStructureInitOptions,
project?: ProxyProjectInstance,
): _structure
Parameters
- options: IStructureInitOptions
- Optionalproject: ProxyProjectInstance
Returns _structure
Overrides _node.constructor
- Defined in packages/vpi/models/nodes/structure.ts:48

Properties

create_dt

create_dt: number = ...

Node creation date time

id

id: string

Node Id

name

name: string

Node name

project

project: ProxyProjectInstance

token

token: string

Node token

type

type: "structure"

Node type

update_dt

update_dt: number = ...

Node update date time

Accessors

addNode

get addNode(): (
    node:
        | {
            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;
        },
) => [
    _operation<any, OperationReference>,

        | {
            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;
        },
]
Returns (
    node:
        | {
            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;
        },
) => [
    _operation<any, OperationReference>,

        | {
            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;
        },
]
- Defined in packages/vpi/models/nodes/structure.ts:82

delete

get delete(): (token: string) => DeleteResult
Returns (token: string) => DeleteResult
Inherited from _node.delete
- Defined in packages/vpi/models/nodes/node.ts:74

deleteNode

get deleteNode(): (
nodeToken: string,
) => [_operation<any, OperationReference>, boolean]
Returns (nodeToken: string) => [_operation<any, OperationReference>, boolean]
- Defined in packages/vpi/models/nodes/structure.ts:85

flatv1

get flatv1(): (fromNodeToken?: string) => FlatStructureV1
Returns (fromNodeToken?: string) => FlatStructureV1
- Defined in packages/vpi/models/nodes/structure.ts:322

flatv2

get flatv2(): (fromNodeToken?: string) => FlatStructureV2Node[]
Returns (fromNodeToken?: string) => FlatStructureV2Node[]
- Defined in packages/vpi/models/nodes/structure.ts:323

forNodes

get forNodes(): (_node<NodeType> | _structureChild | _listChild)[]
Returns (_node<NodeType> | _structureChild | _listChild)[]
Inherited from _node.forNodes
- Defined in packages/vpi/models/nodes/node.ts:71

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;
}[]
Inherited from _node.forRelationships
- Defined in packages/vpi/models/nodes/node.ts:65

fromNodes

get fromNodes(): (_node<NodeType> | _structureChild | _listChild)[]
Returns (_node<NodeType> | _structureChild | _listChild)[]
Inherited from _node.fromNodes
- Defined in packages/vpi/models/nodes/node.ts:70

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;
}[]
Inherited from _node.fromRelationships
- Defined in packages/vpi/models/nodes/node.ts:64

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;
}
- Defined in packages/vpi/models/nodes/structure.ts:87

getMetadata

get getMetadata(): () => MetadataConstructorMap[Type]
Returns () => MetadataConstructorMap[Type]
Inherited from _node.getMetadata
- Defined in packages/vpi/models/nodes/node.ts:42

hasNode

get hasNode(): (nodeToken: string) => boolean
Returns (nodeToken: string) => boolean
- Defined in packages/vpi/models/nodes/structure.ts:84

inNodes

get inNodes(): (_node<NodeType> | _structureChild | _listChild)[]
Returns (_node<NodeType> | _structureChild | _listChild)[]
Inherited from _node.inNodes
- Defined in packages/vpi/models/nodes/node.ts:67

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;
}[]
Inherited from _node.inRelationships
- Defined in packages/vpi/models/nodes/node.ts:61

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:
Overrides _node.jsonReady
- Defined in packages/vpi/models/nodes/structure.ts:67

nestedv1

get nestedv1(): () => any
Returns () => any
- Defined in packages/vpi/models/nodes/structure.ts:319

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>[]
- Defined in packages/vpi/models/nodes/structure.ts:320

outNodes

get outNodes(): (_node<NodeType> | _structureChild | _listChild)[]
Returns (_node<NodeType> | _structureChild | _listChild)[]
Inherited from _node.outNodes
- Defined in packages/vpi/models/nodes/node.ts:68

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;
}[]
Inherited from _node.outRelationships
- Defined in packages/vpi/models/nodes/node.ts:62

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;
}[]
- Defined in packages/vpi/models/nodes/structure.ts:86

setMetadata

get setMetadata(): (meta: MetadataConstructorMap[Type]) => void
Returns (meta: MetadataConstructorMap[Type]) => void
Inherited from _node.setMetadata
- Defined in packages/vpi/models/nodes/node.ts:43

setNode

get setNode(): (
    node:
        | {
            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;
        },
) => [
    _operation<any, OperationReference>,

        | {
            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;
        },
]
Returns (
    node:
        | {
            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;
        },
) => [
    _operation<any, OperationReference>,

        | {
            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;
        },
]
- Defined in packages/vpi/models/nodes/structure.ts:83

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
Inherited from _node.update
- Defined in packages/vpi/models/nodes/node.ts:73

Methods

flat

flat(): Record<string, unknown>
Returns Record<string, unknown>
Inherited from _node.flat
- Defined in packages/vpi/models/nodes/node.ts:222

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
- Defined in packages/vpi/models/nodes/structure.ts:102

isConsistant

isConsistant(): void
Returns void
- Defined in packages/vpi/models/nodes/structure.ts:89

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
}
```
- Defined in packages/vpi/models/nodes/structure.ts:173

json

json(): _structure & { meta: IStructureNodeMetadata }
Returns _structure & { meta: IStructureNodeMetadata }
Inherited from _node.json
- Defined in packages/vpi/models/nodes/node.ts:220

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
Inherited from _node.linkFor
- Defined in packages/vpi/models/nodes/node.ts:173

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
Inherited from _node.linkFrom
- Defined in packages/vpi/models/nodes/node.ts:85

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
Inherited from _node.linkTo
- Defined in packages/vpi/models/nodes/node.ts:129

setMetaDataKey

setMetaDataKey(key: string, value: any): void
Parameters
- key: string
- value: any
Returns void
Inherited from _node.setMetaDataKey
- Defined in packages/vpi/models/nodes/node.ts:216

shema

shema(): JSONSchema3or4
Returns JSONSchema3or4
Overrides _node.shema
- Defined in packages/vpi/models/nodes/structure.ts:80

Class _structure

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns _structure

Properties

create_dt

id

name

project

token

type

update_dt

Accessors

addNode

delete

Returns (token: string) => DeleteResult

deleteNode

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

flatv1

Returns (fromNodeToken?: string) => FlatStructureV1

flatv2

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

forNodes

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

forRelationships

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

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

fromRelationships

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

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

getMetadata

Returns () => MetadataConstructorMap[Type]

hasNode

Returns (nodeToken: string) => boolean

inNodes

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

inRelationships

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

Returns IStructureInitOptions

nestedv1

Returns () => any

nestedv2

outNodes

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

outRelationships

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

setMetadata

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

setNode

update

Methods

flat

Returns Record<string, unknown>

isComplete

Parameters

Returns boolean | ZodError<any>

isConsistant

Returns void

isCorrect

Parameters

Returns boolean | ZodError<any>

Example

json

Returns _structure & { meta: IStructureNodeMetadata }

linkFor

Parameters

Returns RelationCreationResult

linkFrom

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;
}[]

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;
}[]

Returns (
nodeId: string,
) => {
child?: string;
create_dt?: number;
id?: string;
meta?: any;
name?: string;
token?: string;
type?: "structure_child";
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;
}[]

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;
}[]