@dialecte/core 0.1.0 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/document/query/find/descendant/find-descendant.types.d.ts +2 -2
- package/dist/document/query/find/descendant/find-descendant.types.d.ts.map +1 -1
- package/dist/document/query/main.d.ts +134 -10
- package/dist/document/query/main.d.ts.map +1 -1
- package/dist/document/transaction/main.d.ts +53 -0
- package/dist/document/transaction/main.d.ts.map +1 -1
- package/dist/{index--bGUvjR6.js → index-CCEg5JAo.js} +1049 -920
- package/dist/index.js +1 -1
- package/dist/test.js +1 -1
- package/package.json +4 -4
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { FilterAttributes } from '../by-attribute/find-by-attributes.types';
|
|
2
2
|
import { AnyDialecteConfig, DescendantsOf, ElementsOf, TrackedRecord } from '../../../../types';
|
|
3
|
-
type Depth = [never, 0, 1, 2, 3, 4, 5, 6, 7, 8
|
|
3
|
+
type Depth = [never, 0, 1, 2, 3, 4, 5, 6, 7, 8];
|
|
4
4
|
type FilterNode<GenericConfig extends AnyDialecteConfig, GenericElement extends ElementsOf<GenericConfig>, D extends number> = Depth[D] extends never ? never : {
|
|
5
5
|
[K in DescendantsOf<GenericConfig, GenericElement>]: {
|
|
6
6
|
tagName: K;
|
|
@@ -24,7 +24,7 @@ export type DescendantsFilter<GenericConfig extends AnyDialecteConfig> = {
|
|
|
24
24
|
* Default: false (required — candidates whose path lacks this element are excluded).
|
|
25
25
|
*/
|
|
26
26
|
isOptional?: boolean;
|
|
27
|
-
descendant?: FilterNode<GenericConfig, K,
|
|
27
|
+
descendant?: FilterNode<GenericConfig, K, 8>;
|
|
28
28
|
};
|
|
29
29
|
}[ElementsOf<GenericConfig>];
|
|
30
30
|
export type FilterCondition<GenericConfig extends AnyDialecteConfig, GenericElement extends ElementsOf<GenericConfig>> = {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"find-descendant.types.d.ts","sourceRoot":"","sources":["../../../../../src/document/query/find/descendant/find-descendant.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,6DAA6D,CAAA;AACnG,OAAO,KAAK,EAAE,iBAAiB,EAAE,aAAa,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAM1F,KAAK,KAAK,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,
|
|
1
|
+
{"version":3,"file":"find-descendant.types.d.ts","sourceRoot":"","sources":["../../../../../src/document/query/find/descendant/find-descendant.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,6DAA6D,CAAA;AACnG,OAAO,KAAK,EAAE,iBAAiB,EAAE,aAAa,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAM1F,KAAK,KAAK,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;AAE/C,KAAK,UAAU,CACd,aAAa,SAAS,iBAAiB,EACvC,cAAc,SAAS,UAAU,CAAC,aAAa,CAAC,EAChD,CAAC,SAAS,MAAM,IACb,KAAK,CAAC,CAAC,CAAC,SAAS,KAAK,GACvB,KAAK,GACL;KACC,CAAC,IAAI,aAAa,CAAC,aAAa,EAAE,cAAc,CAAC,GAAG;QACpD,OAAO,EAAE,CAAC,CAAA;QACV,uDAAuD;QACvD,UAAU,CAAC,EAAE,gBAAgB,CAAC,aAAa,EAAE,CAAC,CAAC,CAAA;QAC/C;;;WAGG;QACH,UAAU,CAAC,EAAE,OAAO,CAAA;QACpB,UAAU,CAAC,EAAE,UAAU,CAAC,aAAa,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;KACnD;CACD,CAAC,aAAa,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC,CAAA;AAEjD,MAAM,MAAM,iBAAiB,CAAC,aAAa,SAAS,iBAAiB,IAAI;KACvE,CAAC,IAAI,UAAU,CAAC,aAAa,CAAC,GAAG;QACjC,OAAO,EAAE,CAAC,CAAA;QACV,uDAAuD;QACvD,UAAU,CAAC,EAAE,gBAAgB,CAAC,aAAa,EAAE,CAAC,CAAC,CAAA;QAC/C;;;WAGG;QACH,UAAU,CAAC,EAAE,OAAO,CAAA;QACpB,UAAU,CAAC,EAAE,UAAU,CAAC,aAAa,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;KAC5C;CACD,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAA;AAM5B,MAAM,MAAM,eAAe,CAC1B,aAAa,SAAS,iBAAiB,EACvC,cAAc,SAAS,UAAU,CAAC,aAAa,CAAC,IAC7C;IACH,OAAO,EAAE,cAAc,CAAA;IACvB,UAAU,CAAC,EAAE,gBAAgB,CAAC,aAAa,EAAE,cAAc,CAAC,CAAA;IAC5D,QAAQ,EAAE,OAAO,CAAA;CACjB,CAAA;AAMD,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,OAAO,EAAE,MAAM,CAAC,CAAA;CAAE,GACxD,CAAC,GAAG,CAAC,CAAC,SAAS;IAAE,UAAU,CAAC,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,GACjE,KAAK,CAAA;AAMR,MAAM,MAAM,SAAS,CAAC,aAAa,SAAS,iBAAiB,EAAE,WAAW,SAAS,MAAM,IAAI;KAC3F,CAAC,IAAI,WAAW,GAAG,aAAa,CAAC,aAAa,EAAE,CAAC,CAAC,EAAE;CACrD,CAAA;AAED,MAAM,MAAM,qBAAqB,CAChC,aAAa,SAAS,iBAAiB,EACvC,cAAc,SAAS,UAAU,CAAC,aAAa,CAAC,EAChD,aAAa,SAAS,iBAAiB,CAAC,aAAa,CAAC,GAAG,SAAS,IAC/D,aAAa,SAAS,SAAS,GAChC;KACC,CAAC,IAAI,cAAc,GAAG,aAAa,CAAC,aAAa,EAAE,cAAc,CAAC,GAAG,aAAa,CAClF,aAAa,EACb,CAAC,CACD,EAAE;CACH,GACA,aAAa,SAAS,iBAAiB,CAAC,aAAa,CAAC,GACrD,SAAS,CAAC,aAAa,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC,GACpD,KAAK,CAAA"}
|
|
@@ -27,29 +27,153 @@ export declare class Query<GenericConfig extends AnyDialecteConfig> {
|
|
|
27
27
|
* the same FP functions for domain-specific queries.
|
|
28
28
|
*/
|
|
29
29
|
protected get context(): Context<GenericConfig>;
|
|
30
|
+
/**
|
|
31
|
+
* Get the root element of the document.
|
|
32
|
+
*
|
|
33
|
+
* @returns The root record, or `undefined` if the database is empty.
|
|
34
|
+
*
|
|
35
|
+
* @example
|
|
36
|
+
* ```ts
|
|
37
|
+
* const root = await query.getRoot()
|
|
38
|
+
* ```
|
|
39
|
+
*/
|
|
30
40
|
getRoot(): Promise<TrackedRecord<GenericConfig, RootElementOf<GenericConfig>> | undefined>;
|
|
41
|
+
/**
|
|
42
|
+
* Get a single record by ref, record, or relationship.
|
|
43
|
+
*
|
|
44
|
+
* @param refOrRecord - A ref `{ tagName, id }`, or any record/relationship.
|
|
45
|
+
* @returns The tracked record, or `undefined` if not found.
|
|
46
|
+
*
|
|
47
|
+
* @example
|
|
48
|
+
* ```ts
|
|
49
|
+
* const ied = await query.getRecord({ tagName: 'IED', id: knownId })
|
|
50
|
+
* ```
|
|
51
|
+
*/
|
|
31
52
|
getRecord<GenericElement extends ElementsOf<GenericConfig>>(refOrRecord: RefOrRecord<GenericConfig, GenericElement> | undefined): Promise<TrackedRecord<GenericConfig, GenericElement> | undefined>;
|
|
53
|
+
/**
|
|
54
|
+
* Get multiple records in a single call.
|
|
55
|
+
*
|
|
56
|
+
* @param refsOrRecords - Array of refs, records, or relationships.
|
|
57
|
+
* @returns Array of tracked records (same order, `undefined` for missing).
|
|
58
|
+
*
|
|
59
|
+
* @example
|
|
60
|
+
* ```ts
|
|
61
|
+
* const [bay1, bay2] = await query.getRecords([ref1, ref2])
|
|
62
|
+
* ```
|
|
63
|
+
*/
|
|
32
64
|
getRecords<GenericElement extends ElementsOf<GenericConfig>>(refsOrRecords: (RefOrRecord<GenericConfig, GenericElement> | undefined)[]): Promise<(TrackedRecord<GenericConfig, GenericElement> | undefined)[]>;
|
|
65
|
+
/**
|
|
66
|
+
* Get all records of a given tag name.
|
|
67
|
+
*
|
|
68
|
+
* @param tagName - The element type to retrieve.
|
|
69
|
+
* @returns All tracked records matching that tag name.
|
|
70
|
+
*
|
|
71
|
+
* @example
|
|
72
|
+
* ```ts
|
|
73
|
+
* const ieds = await query.getRecordsByTagName('IED')
|
|
74
|
+
* ```
|
|
75
|
+
*/
|
|
33
76
|
getRecordsByTagName<GenericElement extends ElementsOf<GenericConfig>>(tagName: GenericElement): Promise<TrackedRecord<GenericConfig, GenericElement>[]>;
|
|
77
|
+
/**
|
|
78
|
+
* Find all descendants of an element, grouped by tag name.
|
|
79
|
+
*
|
|
80
|
+
* @param refOrRecord - The ancestor element.
|
|
81
|
+
* @param filter - Optional filter to restrict which tag names are returned.
|
|
82
|
+
* @returns Object keyed by tag name, each value an array of tracked records.
|
|
83
|
+
*
|
|
84
|
+
* @example
|
|
85
|
+
* ```ts
|
|
86
|
+
* const { Bay, VoltageLevel } = await query.findDescendants(substation)
|
|
87
|
+
* ```
|
|
88
|
+
*/
|
|
34
89
|
findDescendants<GenericElement extends ElementsOf<GenericConfig>, GenericFilter extends DescendantsFilter<GenericConfig> | undefined = undefined>(refOrRecord: RefOrRecord<GenericConfig, GenericElement> | undefined, filter?: GenericFilter): Promise<FindDescendantsReturn<GenericConfig, GenericElement, GenericFilter>>;
|
|
90
|
+
/**
|
|
91
|
+
* Build a full tree structure from an element down.
|
|
92
|
+
*
|
|
93
|
+
* @param refOrRecord - The root of the subtree.
|
|
94
|
+
* @param options - Optional depth/filter controls.
|
|
95
|
+
* @returns A tree record with nested children, or `undefined` if not found.
|
|
96
|
+
*
|
|
97
|
+
* @example
|
|
98
|
+
* ```ts
|
|
99
|
+
* const tree = await query.getTree(bay)
|
|
100
|
+
* ```
|
|
101
|
+
*/
|
|
35
102
|
getTree<GenericElement extends ElementsOf<GenericConfig>>(refOrRecord: RefOrRecord<GenericConfig, GenericElement> | undefined, options?: GetTreeParams<GenericConfig, GenericElement>): Promise<TreeRecord<GenericConfig, GenericElement> | undefined>;
|
|
36
103
|
/**
|
|
104
|
+
* Get a single attribute value from a record.
|
|
105
|
+
*
|
|
106
|
+
* @param refOrRecord - The element to read from.
|
|
107
|
+
* @param params - Attribute name.
|
|
108
|
+
* @returns The attribute value, or `''` if absent.
|
|
109
|
+
*
|
|
110
|
+
* @example
|
|
111
|
+
* ```ts
|
|
112
|
+
* const name = await query.getAttribute(bay, { name: 'name' })
|
|
113
|
+
* ```
|
|
114
|
+
*/
|
|
115
|
+
getAttribute<GenericElement extends ElementsOf<GenericConfig>>(refOrRecord: RefOrRecord<GenericConfig, GenericElement> | undefined, params: {
|
|
116
|
+
name: AttributesOf<GenericConfig, GenericElement>;
|
|
117
|
+
fullObject?: false;
|
|
118
|
+
}): Promise<FullAttributeObjectOf<GenericConfig, GenericElement>['value'] | ''>;
|
|
119
|
+
/**
|
|
120
|
+
* Get the full attribute object for a single attribute.
|
|
121
|
+
*
|
|
122
|
+
* @param refOrRecord - The element to read from.
|
|
123
|
+
* @param params - Attribute name and `fullObject: true`.
|
|
124
|
+
* @returns The full attribute object, or `undefined` if absent.
|
|
125
|
+
*
|
|
37
126
|
* @example
|
|
38
|
-
*
|
|
39
|
-
* await
|
|
127
|
+
* ```ts
|
|
128
|
+
* const fullAttributeObject = await query.getAttribute(bay, { name: 'name', fullObject: true })
|
|
129
|
+
* ```
|
|
40
130
|
*/
|
|
41
|
-
getAttribute<GenericElement extends ElementsOf<GenericConfig
|
|
131
|
+
getAttribute<GenericElement extends ElementsOf<GenericConfig>>(refOrRecord: RefOrRecord<GenericConfig, GenericElement> | undefined, params: {
|
|
42
132
|
name: AttributesOf<GenericConfig, GenericElement>;
|
|
43
|
-
fullObject
|
|
44
|
-
}): Promise<
|
|
133
|
+
fullObject: true;
|
|
134
|
+
}): Promise<FullAttributeObjectOf<GenericConfig, GenericElement> | undefined>;
|
|
135
|
+
/**
|
|
136
|
+
* Get all attributes of a record as a destructurable key/value object.
|
|
137
|
+
*
|
|
138
|
+
* @param refOrRecord - The element to read from.
|
|
139
|
+
* @returns A `{ name, desc, ... }` object with attribute names as keys.
|
|
140
|
+
*
|
|
141
|
+
* @example
|
|
142
|
+
* ```ts
|
|
143
|
+
* const { name, desc } = await query.getAttributes(bay)
|
|
144
|
+
* ```
|
|
145
|
+
*/
|
|
146
|
+
getAttributes<GenericElement extends ElementsOf<GenericConfig>>(refOrRecord: RefOrRecord<GenericConfig, GenericElement> | undefined, params?: {
|
|
147
|
+
fullObject?: false;
|
|
148
|
+
}): Promise<AttributesValueObjectOf<GenericConfig, GenericElement>>;
|
|
149
|
+
/**
|
|
150
|
+
* Get all attributes of a record as an array of full attribute objects.
|
|
151
|
+
*
|
|
152
|
+
* @param refOrRecord - The element to read from.
|
|
153
|
+
* @returns An array of full attribute objects.
|
|
154
|
+
*
|
|
155
|
+
* @example
|
|
156
|
+
* ```ts
|
|
157
|
+
* const fullAttributeObjects = await query.getAttributes(bay, { fullObject: true })
|
|
158
|
+
* ```
|
|
159
|
+
*/
|
|
160
|
+
getAttributes<GenericElement extends ElementsOf<GenericConfig>>(refOrRecord: RefOrRecord<GenericConfig, GenericElement> | undefined, params: {
|
|
161
|
+
fullObject: true;
|
|
162
|
+
}): Promise<FullAttributeObjectOf<GenericConfig, GenericElement>[]>;
|
|
45
163
|
/**
|
|
164
|
+
* Find records matching specific attribute values.
|
|
165
|
+
*
|
|
166
|
+
* @param params - Tag name and attribute filter criteria.
|
|
167
|
+
* @returns All matching tracked records.
|
|
168
|
+
*
|
|
46
169
|
* @example
|
|
47
|
-
*
|
|
48
|
-
* const
|
|
170
|
+
* ```ts
|
|
171
|
+
* const bays = await query.findByAttributes({
|
|
172
|
+
* tagName: 'Bay',
|
|
173
|
+
* attributes: { name: 'Q01' },
|
|
174
|
+
* })
|
|
175
|
+
* ```
|
|
49
176
|
*/
|
|
50
|
-
getAttributes<GenericElement extends ElementsOf<GenericConfig>, GenericAttribute extends FullAttributeObjectOf<GenericConfig, GenericElement>, FullObject extends boolean = false>(refOrRecord: RefOrRecord<GenericConfig, GenericElement> | undefined, params?: {
|
|
51
|
-
fullObject?: FullObject;
|
|
52
|
-
}): Promise<GenericAttribute[] | AttributesValueObjectOf<GenericConfig, GenericElement>>;
|
|
53
177
|
findByAttributes<GenericElement extends ElementsOf<GenericConfig>>(params: {
|
|
54
178
|
tagName: GenericElement;
|
|
55
179
|
attributes: FilterAttributes<GenericConfig, GenericElement>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../../src/document/query/main.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,UAAU,CAAA;AACvC,OAAO,KAAK,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,QAAQ,CAAA;AACxF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAA;AAC1C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AACpC,OAAO,KAAK,EACX,iBAAiB,EACjB,YAAY,EACZ,uBAAuB,EACvB,UAAU,EACV,qBAAqB,EACrB,aAAa,EACb,UAAU,EACV,SAAS,EAET,WAAW,EACX,aAAa,EACb,MAAM,SAAS,CAAA;AAEhB;;;;;;;;GAQG;AACH,qBAAa,KAAK,CAAC,aAAa,SAAS,iBAAiB;IACzD,SAAS,CAAC,KAAK,EAAE,KAAK,CAAA;IACtB,SAAS,CAAC,cAAc,EAAE,aAAa,CAAA;gBAE3B,KAAK,EAAE,KAAK,EAAE,cAAc,EAAE,aAAa;IAOvD;;;OAGG;IACH,SAAS,CAAC,aAAa,IAAI,SAAS,CAAC,aAAa,CAAC,EAAE;IAIrD;;;;OAIG;IACH,SAAS,KAAK,OAAO,IAAI,OAAO,CAAC,aAAa,CAAC,CAM9C;
|
|
1
|
+
{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../../src/document/query/main.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,UAAU,CAAA;AACvC,OAAO,KAAK,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,QAAQ,CAAA;AACxF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAA;AAC1C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AACpC,OAAO,KAAK,EACX,iBAAiB,EACjB,YAAY,EACZ,uBAAuB,EACvB,UAAU,EACV,qBAAqB,EACrB,aAAa,EACb,UAAU,EACV,SAAS,EAET,WAAW,EACX,aAAa,EACb,MAAM,SAAS,CAAA;AAEhB;;;;;;;;GAQG;AACH,qBAAa,KAAK,CAAC,aAAa,SAAS,iBAAiB;IACzD,SAAS,CAAC,KAAK,EAAE,KAAK,CAAA;IACtB,SAAS,CAAC,cAAc,EAAE,aAAa,CAAA;gBAE3B,KAAK,EAAE,KAAK,EAAE,cAAc,EAAE,aAAa;IAOvD;;;OAGG;IACH,SAAS,CAAC,aAAa,IAAI,SAAS,CAAC,aAAa,CAAC,EAAE;IAIrD;;;;OAIG;IACH,SAAS,KAAK,OAAO,IAAI,OAAO,CAAC,aAAa,CAAC,CAM9C;IAID;;;;;;;;;OASG;IACG,OAAO,IAAI,OAAO,CAAC,aAAa,CAAC,aAAa,EAAE,aAAa,CAAC,aAAa,CAAC,CAAC,GAAG,SAAS,CAAC;IAUhG;;;;;;;;;;OAUG;IACG,SAAS,CAAC,cAAc,SAAS,UAAU,CAAC,aAAa,CAAC,EAC/D,WAAW,EAAE,WAAW,CAAC,aAAa,EAAE,cAAc,CAAC,GAAG,SAAS,GACjE,OAAO,CAAC,aAAa,CAAC,aAAa,EAAE,cAAc,CAAC,GAAG,SAAS,CAAC;IAIpE;;;;;;;;;;OAUG;IACG,UAAU,CAAC,cAAc,SAAS,UAAU,CAAC,aAAa,CAAC,EAChE,aAAa,EAAE,CAAC,WAAW,CAAC,aAAa,EAAE,cAAc,CAAC,GAAG,SAAS,CAAC,EAAE,GACvE,OAAO,CAAC,CAAC,aAAa,CAAC,aAAa,EAAE,cAAc,CAAC,GAAG,SAAS,CAAC,EAAE,CAAC;IAKxE;;;;;;;;;;OAUG;IACG,mBAAmB,CAAC,cAAc,SAAS,UAAU,CAAC,aAAa,CAAC,EACzE,OAAO,EAAE,cAAc,GACrB,OAAO,CAAC,aAAa,CAAC,aAAa,EAAE,cAAc,CAAC,EAAE,CAAC;IAI1D;;;;;;;;;;;OAWG;IACG,eAAe,CACpB,cAAc,SAAS,UAAU,CAAC,aAAa,CAAC,EAChD,aAAa,SAAS,iBAAiB,CAAC,aAAa,CAAC,GAAG,SAAS,GAAG,SAAS,EAE9E,WAAW,EAAE,WAAW,CAAC,aAAa,EAAE,cAAc,CAAC,GAAG,SAAS,EACnE,MAAM,CAAC,EAAE,aAAa,GACpB,OAAO,CAAC,qBAAqB,CAAC,aAAa,EAAE,cAAc,EAAE,aAAa,CAAC,CAAC;IAS/E;;;;;;;;;;;OAWG;IACG,OAAO,CAAC,cAAc,SAAS,UAAU,CAAC,aAAa,CAAC,EAC7D,WAAW,EAAE,WAAW,CAAC,aAAa,EAAE,cAAc,CAAC,GAAG,SAAS,EACnE,OAAO,CAAC,EAAE,aAAa,CAAC,aAAa,EAAE,cAAc,CAAC,GACpD,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,cAAc,CAAC,GAAG,SAAS,CAAC;IAMjE;;;;;;;;;;;OAWG;IACG,YAAY,CAAC,cAAc,SAAS,UAAU,CAAC,aAAa,CAAC,EAClE,WAAW,EAAE,WAAW,CAAC,aAAa,EAAE,cAAc,CAAC,GAAG,SAAS,EACnE,MAAM,EAAE;QAAE,IAAI,EAAE,YAAY,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC;QAAC,UAAU,CAAC,EAAE,KAAK,CAAA;KAAE,GAC/E,OAAO,CAAC,qBAAqB,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;IAC9E;;;;;;;;;;;OAWG;IACG,YAAY,CAAC,cAAc,SAAS,UAAU,CAAC,aAAa,CAAC,EAClE,WAAW,EAAE,WAAW,CAAC,aAAa,EAAE,cAAc,CAAC,GAAG,SAAS,EACnE,MAAM,EAAE;QAAE,IAAI,EAAE,YAAY,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC;QAAC,UAAU,EAAE,IAAI,CAAA;KAAE,GAC7E,OAAO,CAAC,qBAAqB,CAAC,aAAa,EAAE,cAAc,CAAC,GAAG,SAAS,CAAC;IAkB5E;;;;;;;;;;OAUG;IACG,aAAa,CAAC,cAAc,SAAS,UAAU,CAAC,aAAa,CAAC,EACnE,WAAW,EAAE,WAAW,CAAC,aAAa,EAAE,cAAc,CAAC,GAAG,SAAS,EACnE,MAAM,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,KAAK,CAAA;KAAE,GAC7B,OAAO,CAAC,uBAAuB,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC;IAClE;;;;;;;;;;OAUG;IACG,aAAa,CAAC,cAAc,SAAS,UAAU,CAAC,aAAa,CAAC,EACnE,WAAW,EAAE,WAAW,CAAC,aAAa,EAAE,cAAc,CAAC,GAAG,SAAS,EACnE,MAAM,EAAE;QAAE,UAAU,EAAE,IAAI,CAAA;KAAE,GAC1B,OAAO,CAAC,qBAAqB,CAAC,aAAa,EAAE,cAAc,CAAC,EAAE,CAAC;IAiBlE;;;;;;;;;;;;;OAaG;IACG,gBAAgB,CAAC,cAAc,SAAS,UAAU,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE;QAChF,OAAO,EAAE,cAAc,CAAA;QACvB,UAAU,EAAE,gBAAgB,CAAC,aAAa,EAAE,cAAc,CAAC,CAAA;KAC3D,GAAG,OAAO,CAAC,aAAa,CAAC,aAAa,EAAE,cAAc,CAAC,EAAE,CAAC;CAG3D"}
|
|
@@ -34,9 +34,62 @@ export declare class Transaction<GenericConfig extends AnyDialecteConfig> extend
|
|
|
34
34
|
* and a mutable stagedOperations array (mutation FP functions push to it).
|
|
35
35
|
*/
|
|
36
36
|
protected get context(): Context<GenericConfig>;
|
|
37
|
+
/**
|
|
38
|
+
* Add a child element to a parent.
|
|
39
|
+
*
|
|
40
|
+
* @param parentRefOrRecord - The parent element (ref, record, or relationship). `undefined` for root.
|
|
41
|
+
* @param params - Child tagName, attributes and optional namespace, value, id.
|
|
42
|
+
* @returns Ref to the created child.
|
|
43
|
+
*
|
|
44
|
+
* @example
|
|
45
|
+
* ```ts
|
|
46
|
+
* const bayRef = await tx.addChild(substation, {
|
|
47
|
+
* tagName: 'VoltageLevel',
|
|
48
|
+
* attributes: { name: 'VL1' },
|
|
49
|
+
* })
|
|
50
|
+
* ```
|
|
51
|
+
*/
|
|
37
52
|
addChild<GenericElement extends ElementsOf<GenericConfig>, GenericChildElement extends ChildrenOf<GenericConfig, GenericElement>>(parentRefOrRecord: RefOrRecord<GenericConfig, GenericElement> | undefined, params: AddChildParams<GenericConfig, GenericElement, GenericChildElement>): Promise<Ref<GenericConfig, GenericChildElement>>;
|
|
53
|
+
/**
|
|
54
|
+
* Update attributes of an existing element.
|
|
55
|
+
*
|
|
56
|
+
* @param refOrRecord - The element to update (ref, record, or relationship).
|
|
57
|
+
* @param params - New attribute values.
|
|
58
|
+
* @returns Ref to the updated element.
|
|
59
|
+
*
|
|
60
|
+
* @example
|
|
61
|
+
* ```ts
|
|
62
|
+
* await tx.update(bay, {
|
|
63
|
+
* attributes: { name: 'Q02', desc: 'Feeder bay' },
|
|
64
|
+
* })
|
|
65
|
+
* ```
|
|
66
|
+
*/
|
|
38
67
|
update<GenericElement extends ElementsOf<GenericConfig>>(refOrRecord: RefOrRecord<GenericConfig, GenericElement> | undefined, params: UpdateParams<GenericConfig, GenericElement>): Promise<Ref<GenericConfig, GenericElement>>;
|
|
68
|
+
/**
|
|
69
|
+
* Delete an element and its entire subtree.
|
|
70
|
+
*
|
|
71
|
+
* @param refOrRecord - The element to delete (ref, record, or relationship).
|
|
72
|
+
* @returns Ref to the deleted element's parent.
|
|
73
|
+
*
|
|
74
|
+
* @example
|
|
75
|
+
* ```ts
|
|
76
|
+
* const parentRef = await tx.delete(bay)
|
|
77
|
+
* ```
|
|
78
|
+
*/
|
|
39
79
|
delete<GenericElement extends ElementsOf<GenericConfig>>(refOrRecord: RefOrRecord<GenericConfig, GenericElement> | undefined): Promise<Ref<GenericConfig, ParentsOf<GenericConfig, GenericElement>>>;
|
|
80
|
+
/**
|
|
81
|
+
* Deep-clone a subtree under a new parent.
|
|
82
|
+
*
|
|
83
|
+
* @param parentRefOrRecord - The target parent for the clone.
|
|
84
|
+
* @param record - The tree record to clone (from `getTree`).
|
|
85
|
+
* @returns The cloned root ref and an ID mapping from old to new.
|
|
86
|
+
*
|
|
87
|
+
* @example
|
|
88
|
+
* ```ts
|
|
89
|
+
* const tree = await tx.getTree(bay)
|
|
90
|
+
* const { ref, idMap } = await tx.deepClone(substation, tree)
|
|
91
|
+
* ```
|
|
92
|
+
*/
|
|
40
93
|
deepClone<GenericElement extends ElementsOf<GenericConfig>, GenericChildElement extends ChildrenOf<GenericConfig, GenericElement>>(parentRefOrRecord: RefOrRecord<GenericConfig, GenericElement> | undefined, record: TreeRecord<GenericConfig, GenericChildElement>): Promise<CloneResult<GenericConfig, GenericChildElement>>;
|
|
41
94
|
/** Returns a read-only view of staged operations (for prepare/preview) */
|
|
42
95
|
getStagedOperations(): ReadonlyArray<Operation<GenericConfig>>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../../src/document/transaction/main.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAA;AAShC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAC7C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,UAAU,CAAA;AACvC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAC1C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAC9C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAC5C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AACpC,OAAO,KAAK,EACX,iBAAiB,EACjB,YAAY,EACZ,UAAU,EACV,UAAU,EACV,SAAS,EACT,SAAS,EACT,GAAG,EACH,WAAW,EACX,UAAU,EACV,MAAM,SAAS,CAAA;AAEhB;;;;;;;;;;;;;GAaG;AACH,qBAAa,WAAW,CAAC,aAAa,SAAS,iBAAiB,CAAE,SAAQ,KAAK,CAAC,aAAa,CAAC;IAC7F,SAAS,CAAC,gBAAgB,EAAE,SAAS,CAAC,aAAa,CAAC,EAAE,CAAK;IAC3D,SAAS,CAAC,aAAa,EAAE,aAAa,CAAA;IACtC,SAAS,CAAC,WAAW,4BAAkC;gBAE3C,KAAK,EAAE,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,aAAa,EAAE,aAAa;IAOrF;;OAEG;cACgB,aAAa,IAAI,SAAS,CAAC,aAAa,CAAC,EAAE;IAI9D;;;;OAIG;IACH,cAAuB,OAAO,IAAI,OAAO,CAAC,aAAa,CAAC,CAMvD;
|
|
1
|
+
{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../../src/document/transaction/main.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAA;AAShC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAC7C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,UAAU,CAAA;AACvC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAC1C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAC9C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAC5C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AACpC,OAAO,KAAK,EACX,iBAAiB,EACjB,YAAY,EACZ,UAAU,EACV,UAAU,EACV,SAAS,EACT,SAAS,EACT,GAAG,EACH,WAAW,EACX,UAAU,EACV,MAAM,SAAS,CAAA;AAEhB;;;;;;;;;;;;;GAaG;AACH,qBAAa,WAAW,CAAC,aAAa,SAAS,iBAAiB,CAAE,SAAQ,KAAK,CAAC,aAAa,CAAC;IAC7F,SAAS,CAAC,gBAAgB,EAAE,SAAS,CAAC,aAAa,CAAC,EAAE,CAAK;IAC3D,SAAS,CAAC,aAAa,EAAE,aAAa,CAAA;IACtC,SAAS,CAAC,WAAW,4BAAkC;gBAE3C,KAAK,EAAE,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,aAAa,EAAE,aAAa;IAOrF;;OAEG;cACgB,aAAa,IAAI,SAAS,CAAC,aAAa,CAAC,EAAE;IAI9D;;;;OAIG;IACH,cAAuB,OAAO,IAAI,OAAO,CAAC,aAAa,CAAC,CAMvD;IAID;;;;;;;;;;;;;;OAcG;IACG,QAAQ,CACb,cAAc,SAAS,UAAU,CAAC,aAAa,CAAC,EAChD,mBAAmB,SAAS,UAAU,CAAC,aAAa,EAAE,cAAc,CAAC,EAErE,iBAAiB,EAAE,WAAW,CAAC,aAAa,EAAE,cAAc,CAAC,GAAG,SAAS,EACzE,MAAM,EAAE,cAAc,CAAC,aAAa,EAAE,cAAc,EAAE,mBAAmB,CAAC,GACxE,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,mBAAmB,CAAC,CAAC;IASnD;;;;;;;;;;;;;OAaG;IACG,MAAM,CAAC,cAAc,SAAS,UAAU,CAAC,aAAa,CAAC,EAC5D,WAAW,EAAE,WAAW,CAAC,aAAa,EAAE,cAAc,CAAC,GAAG,SAAS,EACnE,MAAM,EAAE,YAAY,CAAC,aAAa,EAAE,cAAc,CAAC,GACjD,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC;IAS9C;;;;;;;;;;OAUG;IACG,MAAM,CAAC,cAAc,SAAS,UAAU,CAAC,aAAa,CAAC,EAC5D,WAAW,EAAE,WAAW,CAAC,aAAa,EAAE,cAAc,CAAC,GAAG,SAAS,GACjE,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,SAAS,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC,CAAC;IAIxE;;;;;;;;;;;;OAYG;IACG,SAAS,CACd,cAAc,SAAS,UAAU,CAAC,aAAa,CAAC,EAChD,mBAAmB,SAAS,UAAU,CAAC,aAAa,EAAE,cAAc,CAAC,EAErE,iBAAiB,EAAE,WAAW,CAAC,aAAa,EAAE,cAAc,CAAC,GAAG,SAAS,EACzE,MAAM,EAAE,UAAU,CAAC,aAAa,EAAE,mBAAmB,CAAC,GACpD,OAAO,CAAC,WAAW,CAAC,aAAa,EAAE,mBAAmB,CAAC,CAAC;IAW3D,0EAA0E;IAC1E,mBAAmB,IAAI,aAAa,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IAI9D,yCAAyC;IACzC,qBAAqB,IAAI,IAAI;IAI7B,sCAAsC;IACtC,gBAAgB,IAAI,IAAI;IAIxB;;;;;;OAMG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CAO7B"}
|