@twin.org/auditable-item-graph-models 0.0.2-next.3 → 0.0.2-next.4
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/types/models/IAuditableItemGraphComponent.d.ts +4 -0
- package/dist/types/models/api/IAuditableItemGraphListRequest.d.ts +4 -0
- package/docs/changelog.md +7 -0
- package/docs/reference/interfaces/IAuditableItemGraphComponent.md +6 -0
- package/docs/reference/interfaces/IAuditableItemGraphListRequest.md +6 -0
- package/package.json +1 -1
|
@@ -24,6 +24,7 @@ export interface IAuditableItemGraphComponent extends IComponent {
|
|
|
24
24
|
aliases?: {
|
|
25
25
|
id: string;
|
|
26
26
|
aliasFormat?: string;
|
|
27
|
+
unique?: boolean;
|
|
27
28
|
annotationObject?: IJsonLdNodeObject;
|
|
28
29
|
}[];
|
|
29
30
|
resources?: {
|
|
@@ -54,6 +55,7 @@ export interface IAuditableItemGraphComponent extends IComponent {
|
|
|
54
55
|
aliases?: {
|
|
55
56
|
id: string;
|
|
56
57
|
aliasFormat?: string;
|
|
58
|
+
unique?: boolean;
|
|
57
59
|
annotationObject?: IJsonLdNodeObject;
|
|
58
60
|
}[];
|
|
59
61
|
resources?: {
|
|
@@ -94,6 +96,7 @@ export interface IAuditableItemGraphComponent extends IComponent {
|
|
|
94
96
|
* @param options The query options.
|
|
95
97
|
* @param options.id The optional id to look for.
|
|
96
98
|
* @param options.idMode Look in id, alias or both, defaults to both.
|
|
99
|
+
* @param options.idExact Find only exact matches, default to false meaning partial matching.
|
|
97
100
|
* @param options.resourceTypes Include vertices with specific resource types.
|
|
98
101
|
* @param conditions Conditions to use in the query.
|
|
99
102
|
* @param orderBy The order for the results, defaults to dateCreated.
|
|
@@ -106,6 +109,7 @@ export interface IAuditableItemGraphComponent extends IComponent {
|
|
|
106
109
|
query(options?: {
|
|
107
110
|
id?: string;
|
|
108
111
|
idMode?: "id" | "alias" | "both";
|
|
112
|
+
idExact?: boolean;
|
|
109
113
|
resourceTypes?: string[];
|
|
110
114
|
}, conditions?: IComparator[], orderBy?: keyof Pick<IAuditableItemGraphVertex, "dateCreated" | "dateModified">, orderByDirection?: SortDirection, properties?: (keyof IAuditableItemGraphVertex)[], cursor?: string, pageSize?: number): Promise<IAuditableItemGraphVertexList>;
|
|
111
115
|
}
|
|
@@ -23,6 +23,10 @@ export interface IAuditableItemGraphListRequest {
|
|
|
23
23
|
* Which field to look in with the id, defaults to both.
|
|
24
24
|
*/
|
|
25
25
|
idMode?: "id" | "alias" | "both";
|
|
26
|
+
/**
|
|
27
|
+
* Find only exact matches, default to false meaning partial matching.
|
|
28
|
+
*/
|
|
29
|
+
idExact?: boolean;
|
|
26
30
|
/**
|
|
27
31
|
* Include vertices with specific resource types, comma separated.
|
|
28
32
|
*/
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,12 @@
|
|
|
1
1
|
# @twin.org/auditable-item-graph-models - Changelog
|
|
2
2
|
|
|
3
|
+
## [0.0.2-next.4](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.2-next.3...auditable-item-graph-models-v0.0.2-next.4) (2025-09-24)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* add unique flag for alias, and exact match option for id query ([33dbd19](https://github.com/twinfoundation/auditable-item-graph/commit/33dbd19cabd9fbfaba81032f1d1a6527584c3f5a))
|
|
9
|
+
|
|
3
10
|
## [0.0.2-next.3](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.2-next.2...auditable-item-graph-models-v0.0.2-next.3) (2025-08-29)
|
|
4
11
|
|
|
5
12
|
|
|
@@ -230,6 +230,12 @@ The optional id to look for.
|
|
|
230
230
|
|
|
231
231
|
Look in id, alias or both, defaults to both.
|
|
232
232
|
|
|
233
|
+
###### idExact?
|
|
234
|
+
|
|
235
|
+
`boolean`
|
|
236
|
+
|
|
237
|
+
Find only exact matches, default to false meaning partial matching.
|
|
238
|
+
|
|
233
239
|
###### resourceTypes?
|
|
234
240
|
|
|
235
241
|
`string`[]
|
|
@@ -34,6 +34,12 @@ The id or alias to try and find.
|
|
|
34
34
|
|
|
35
35
|
Which field to look in with the id, defaults to both.
|
|
36
36
|
|
|
37
|
+
#### idExact?
|
|
38
|
+
|
|
39
|
+
> `optional` **idExact**: `boolean`
|
|
40
|
+
|
|
41
|
+
Find only exact matches, default to false meaning partial matching.
|
|
42
|
+
|
|
37
43
|
#### resourceTypes?
|
|
38
44
|
|
|
39
45
|
> `optional` **resourceTypes**: `string`
|
package/package.json
CHANGED