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

Index

Constructors

constructor

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

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

userGroup

userGroup: string[] = []

Accessors

addNode

get addNode(): (
    node: {
        child?: string;
        create_dt?: number;
        id?: string;
        meta?: null;
        name?: string;
        token?: string;
        type?: "structure_child";
        update_dt?: number;
        userGroup?: string[];
    },
) => [
    _operation<any, OperationReference>,
    {
        child?: string;
        create_dt?: number;
        id?: string;
        meta?: null;
        name?: string;
        token?: string;
        type?: "structure_child";
        update_dt?: number;
        userGroup?: string[];
    },
]
Returns (
    node: {
        child?: string;
        create_dt?: number;
        id?: string;
        meta?: null;
        name?: string;
        token?: string;
        type?: "structure_child";
        update_dt?: number;
        userGroup?: string[];
    },
) => [
    _operation<any, OperationReference>,
    {
        child?: string;
        create_dt?: number;
        id?: string;
        meta?: null;
        name?: string;
        token?: string;
        type?: "structure_child";
        update_dt?: number;
        userGroup?: string[];
    },
]
- Defined in src/models/nodes/structure.ts:80

delete

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

deleteNode

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

flatv1

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

flatv2

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

forNodes

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

forRelationships

get forRelationships(): {
    create_dt?: number;
    f_id?: string;
    f_token?: string;
    r_type?: string;
    t_id?: string;
    t_token?: string;
    update_dt?: number;
}[]
Returns {
    create_dt?: number;
    f_id?: string;
    f_token?: string;
    r_type?: string;
    t_id?: string;
    t_token?: string;
    update_dt?: number;
}[]
Inherited from _node.forRelationships
- Defined in src/models/nodes/node.ts:62

fromNodes

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

fromRelationships

get fromRelationships(): {
    create_dt?: number;
    f_id?: string;
    f_token?: string;
    r_type?: string;
    t_id?: string;
    t_token?: string;
    update_dt?: number;
}[]
Returns {
    create_dt?: number;
    f_id?: string;
    f_token?: string;
    r_type?: string;
    t_id?: string;
    t_token?: string;
    update_dt?: number;
}[]
Inherited from _node.fromRelationships
- Defined in src/models/nodes/node.ts:61

getChildByToken

get getChildByToken(): (
    nodeId: string,
) => {
    child?: string;
    create_dt?: number;
    id?: string;
    meta?: null;
    name?: string;
    token?: string;
    type?: "structure_child";
    update_dt?: number;
    userGroup?: string[];
}
Returns (
    nodeId: string,
) => {
    child?: string;
    create_dt?: number;
    id?: string;
    meta?: null;
    name?: string;
    token?: string;
    type?: "structure_child";
    update_dt?: number;
    userGroup?: string[];
}
- Defined in src/models/nodes/structure.ts:85

getMetadata

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

hasNode

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

inNodes

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

inRelationships

get inRelationships(): {
    create_dt?: number;
    f_id?: string;
    f_token?: string;
    r_type?: string;
    t_id?: string;
    t_token?: string;
    update_dt?: number;
}[]
Returns {
    create_dt?: number;
    f_id?: string;
    f_token?: string;
    r_type?: string;
    t_id?: string;
    t_token?: string;
    update_dt?: number;
}[]
Inherited from _node.inRelationships
- Defined in src/models/nodes/node.ts:58

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 src/models/nodes/structure.ts:65

nestedv1

get nestedv1(): () => any
Returns () => any
- Defined in src/models/nodes/structure.ts:150

nestedv2

get nestedv2(): <
    T extends
        {
            child?: string;
            create_dt?: number;
            id?: string;
            meta?: null;
            name?: string;
            token?: string;
            type?: "structure_child";
            update_dt?: number;
            userGroup?: string[];
        } = {
        child?: string;
        create_dt?: number;
        id?: string;
        meta?: null;
        name?: string;
        token?: string;
        type?: "structure_child";
        update_dt?: number;
        userGroup?: string[];
    },
>(
    start_token?: string,
    binder?: (
        node: {
            child?: string;
            create_dt?: number;
            id?: string;
            meta?: null;
            name?: string;
            token?: string;
            type?: "structure_child";
            update_dt?: number;
            userGroup?: string[];
        },
    ) => T,
) => NestedStructureResult<T>[]
Returns <
    T extends
        {
            child?: string;
            create_dt?: number;
            id?: string;
            meta?: null;
            name?: string;
            token?: string;
            type?: "structure_child";
            update_dt?: number;
            userGroup?: string[];
        } = {
        child?: string;
        create_dt?: number;
        id?: string;
        meta?: null;
        name?: string;
        token?: string;
        type?: "structure_child";
        update_dt?: number;
        userGroup?: string[];
    },
>(
    start_token?: string,
    binder?: (
        node: {
            child?: string;
            create_dt?: number;
            id?: string;
            meta?: null;
            name?: string;
            token?: string;
            type?: "structure_child";
            update_dt?: number;
            userGroup?: string[];
        },
    ) => T,
) => NestedStructureResult<T>[]
- Defined in src/models/nodes/structure.ts:151

outNodes

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

outRelationships

get outRelationships(): {
    create_dt?: number;
    f_id?: string;
    f_token?: string;
    r_type?: string;
    t_id?: string;
    t_token?: string;
    update_dt?: number;
}[]
Returns {
    create_dt?: number;
    f_id?: string;
    f_token?: string;
    r_type?: string;
    t_id?: string;
    t_token?: string;
    update_dt?: number;
}[]
Inherited from _node.outRelationships
- Defined in src/models/nodes/node.ts:59

queryNodeAll

get queryNodeAll(): (
    query: {
        child?: string;
        create_dt?: number;
        id?: string;
        meta?: null;
        name?: string;
        token?: string;
        type?: "structure_child";
        update_dt?: number;
        userGroup?: string[];
    },
) => {
    child?: string;
    create_dt?: number;
    id?: string;
    meta?: null;
    name?: string;
    token?: string;
    type?: "structure_child";
    update_dt?: number;
    userGroup?: string[];
}[]
Returns (
    query: {
        child?: string;
        create_dt?: number;
        id?: string;
        meta?: null;
        name?: string;
        token?: string;
        type?: "structure_child";
        update_dt?: number;
        userGroup?: string[];
    },
) => {
    child?: string;
    create_dt?: number;
    id?: string;
    meta?: null;
    name?: string;
    token?: string;
    type?: "structure_child";
    update_dt?: number;
    userGroup?: string[];
}[]
- Defined in src/models/nodes/structure.ts:84

setMetadata

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

setNode

get setNode(): (
    node: {
        child?: string;
        create_dt?: number;
        id?: string;
        meta?: null;
        name?: string;
        token?: string;
        type?: "structure_child";
        update_dt?: number;
        userGroup?: string[];
    },
) => [
    _operation<any, OperationReference>,
    {
        child?: string;
        create_dt?: number;
        id?: string;
        meta?: null;
        name?: string;
        token?: string;
        type?: "structure_child";
        update_dt?: number;
        userGroup?: string[];
    },
]
Returns (
    node: {
        child?: string;
        create_dt?: number;
        id?: string;
        meta?: null;
        name?: string;
        token?: string;
        type?: "structure_child";
        update_dt?: number;
        userGroup?: string[];
    },
) => [
    _operation<any, OperationReference>,
    {
        child?: string;
        create_dt?: number;
        id?: string;
        meta?: null;
        name?: string;
        token?: string;
        type?: "structure_child";
        update_dt?: number;
        userGroup?: string[];
    },
]
- Defined in src/models/nodes/structure.ts:81

update

get update(): (
    node: {
        create_dt?: number;
        id?: string;
        name?: string;
        token?: string;
        type?: string;
        update_dt?: number;
        userGroup?: string[];
    },
) => NodeCreationResult
Returns (
    node: {
        create_dt?: number;
        id?: string;
        name?: string;
        token?: string;
        type?: string;
        update_dt?: number;
        userGroup?: string[];
    },
) => NodeCreationResult
Inherited from _node.update
- Defined in src/models/nodes/node.ts:70

Methods

flat

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

json

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

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 src/models/nodes/node.ts:170

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 src/models/nodes/node.ts:82

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 src/models/nodes/node.ts:126

setMetaDataKey

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

shema

shema(): JSONSchema3or4
Returns JSONSchema3or4
Overrides _node.shema
- Defined in src/models/nodes/structure.ts:78

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

userGroup

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_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_type?: string; t_id?: string; t_token?: string; update_dt?: number;}[]

getChildByToken

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

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_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_type?: string; t_id?: string; t_token?: string; update_dt?: number;}[]

queryNodeAll

setMetadata

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

setNode

update

Returns ( node: { create_dt?: number; id?: string; name?: string; token?: string; type?: string; update_dt?: number; userGroup?: string[]; },) => NodeCreationResult

Methods

flat

Returns Record<string, unknown>

json

Returns _structure & { meta: IStructureNodeMetadata }

linkFor

Parameters

Returns RelationCreationResult

linkFrom

Parameters

Returns RelationCreationResult

linkTo

Parameters

Returns RelationCreationResult

setMetaDataKey

Parameters

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

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

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

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

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

Returns (
node: {
create_dt?: number;
id?: string;
name?: string;
token?: string;
type?: string;
update_dt?: number;
userGroup?: string[];
},
) => NodeCreationResult