@twin.org/auditable-item-graph-service 0.10.0 → 0.10.1-next.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/es/auditableItemGraphService.js +299 -120
- package/dist/es/auditableItemGraphService.js.map +1 -1
- package/dist/es/entities/auditableItemGraphAlias.js +2 -2
- package/dist/es/entities/auditableItemGraphAlias.js.map +1 -1
- package/dist/es/entities/auditableItemGraphChangeset.js +15 -5
- package/dist/es/entities/auditableItemGraphChangeset.js.map +1 -1
- package/dist/es/entities/auditableItemGraphEdge.js +2 -2
- package/dist/es/entities/auditableItemGraphEdge.js.map +1 -1
- package/dist/es/entities/auditableItemGraphPatch.js +3 -3
- package/dist/es/entities/auditableItemGraphPatch.js.map +1 -1
- package/dist/es/entities/auditableItemGraphResource.js +1 -1
- package/dist/es/entities/auditableItemGraphResource.js.map +1 -1
- package/dist/es/entities/auditableItemGraphVertex.js +4 -20
- package/dist/es/entities/auditableItemGraphVertex.js.map +1 -1
- package/dist/es/entities/auditableItemGraphVertexIndex.js +83 -0
- package/dist/es/entities/auditableItemGraphVertexIndex.js.map +1 -0
- package/dist/es/entities/auditableItemGraphVertexV1.js +113 -0
- package/dist/es/entities/auditableItemGraphVertexV1.js.map +1 -0
- package/dist/es/index.js +2 -0
- package/dist/es/index.js.map +1 -1
- package/dist/es/models/IAuditableItemGraphServiceConstructorOptions.js.map +1 -1
- package/dist/es/schema.js +4 -0
- package/dist/es/schema.js.map +1 -1
- package/dist/types/auditableItemGraphService.d.ts +3 -2
- package/dist/types/entities/auditableItemGraphVertex.d.ts +0 -8
- package/dist/types/entities/auditableItemGraphVertexIndex.d.ts +31 -0
- package/dist/types/entities/auditableItemGraphVertexV1.d.ts +58 -0
- package/dist/types/index.d.ts +2 -0
- package/dist/types/models/IAuditableItemGraphServiceConstructorOptions.d.ts +5 -0
- package/docs/changelog.md +86 -0
- package/docs/open-api/spec.json +1 -1
- package/docs/reference/classes/AuditableItemGraphService.md +2 -1
- package/docs/reference/classes/AuditableItemGraphVertex.md +0 -16
- package/docs/reference/classes/AuditableItemGraphVertexIndex.md +63 -0
- package/docs/reference/classes/AuditableItemGraphVertexV1.md +109 -0
- package/docs/reference/index.md +2 -0
- package/docs/reference/interfaces/IAuditableItemGraphServiceConstructorOptions.md +14 -0
- package/package.json +16 -16
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Class describing the auditable item graph vertex index.
|
|
3
|
+
*/
|
|
4
|
+
export declare class AuditableItemGraphVertexIndex {
|
|
5
|
+
/**
|
|
6
|
+
* The id of the index.
|
|
7
|
+
*/
|
|
8
|
+
id: string;
|
|
9
|
+
/**
|
|
10
|
+
* The id of the vertex this index refers to.
|
|
11
|
+
*/
|
|
12
|
+
vertexId: string;
|
|
13
|
+
/**
|
|
14
|
+
* Index type.
|
|
15
|
+
*/
|
|
16
|
+
type: string;
|
|
17
|
+
/**
|
|
18
|
+
* Index value, case folded so lookups do not depend on the column collation.
|
|
19
|
+
*/
|
|
20
|
+
value: string;
|
|
21
|
+
/**
|
|
22
|
+
* The date/time of when the vertex was created, copied so the index can order and page its
|
|
23
|
+
* own matches without reading the vertex.
|
|
24
|
+
*/
|
|
25
|
+
dateCreated: string;
|
|
26
|
+
/**
|
|
27
|
+
* The date/time of when the vertex was last modified, copied so a query ordered by the
|
|
28
|
+
* modified date can also be paged from the index.
|
|
29
|
+
*/
|
|
30
|
+
dateModified?: string;
|
|
31
|
+
}
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
import type { AuditableItemGraphAuditMode } from "@twin.org/auditable-item-graph-models";
|
|
2
|
+
import { type IJsonLdNodeObject } from "@twin.org/data-json-ld";
|
|
3
|
+
import type { AuditableItemGraphAlias } from "./auditableItemGraphAlias.js";
|
|
4
|
+
import type { AuditableItemGraphEdge } from "./auditableItemGraphEdge.js";
|
|
5
|
+
import type { AuditableItemGraphResource } from "./auditableItemGraphResource.js";
|
|
6
|
+
/**
|
|
7
|
+
* Class describing the auditable item graph vertex.
|
|
8
|
+
*/
|
|
9
|
+
export declare class AuditableItemGraphVertexV1 {
|
|
10
|
+
/**
|
|
11
|
+
* The id of the vertex.
|
|
12
|
+
*/
|
|
13
|
+
id: string;
|
|
14
|
+
/**
|
|
15
|
+
* The identity of the organization which controls the vertex.
|
|
16
|
+
*/
|
|
17
|
+
organizationIdentity: string;
|
|
18
|
+
/**
|
|
19
|
+
* The date/time of when the vertex was created.
|
|
20
|
+
*/
|
|
21
|
+
dateCreated: string;
|
|
22
|
+
/**
|
|
23
|
+
* The date/time of when the vertex was last modified.
|
|
24
|
+
*/
|
|
25
|
+
dateModified?: string;
|
|
26
|
+
/**
|
|
27
|
+
* How the mutations of the vertex are recorded, when absent the vertex behaves as audited.
|
|
28
|
+
*/
|
|
29
|
+
auditMode?: AuditableItemGraphAuditMode;
|
|
30
|
+
/**
|
|
31
|
+
* Combined alias index for the vertex used for querying.
|
|
32
|
+
*/
|
|
33
|
+
aliasIndex?: string;
|
|
34
|
+
/**
|
|
35
|
+
* Combined resource type index for the vertex used for querying.
|
|
36
|
+
*/
|
|
37
|
+
resourceTypeIndex?: string;
|
|
38
|
+
/**
|
|
39
|
+
* Object to associate with the vertex as JSON-LD.
|
|
40
|
+
*/
|
|
41
|
+
annotationObject?: IJsonLdNodeObject;
|
|
42
|
+
/**
|
|
43
|
+
* Alternative aliases that can be used to identify the vertex.
|
|
44
|
+
*/
|
|
45
|
+
aliases?: AuditableItemGraphAlias[];
|
|
46
|
+
/**
|
|
47
|
+
* The resources attached to the vertex.
|
|
48
|
+
*/
|
|
49
|
+
resources?: AuditableItemGraphResource[];
|
|
50
|
+
/**
|
|
51
|
+
* Edges connected to the vertex.
|
|
52
|
+
*/
|
|
53
|
+
edges?: AuditableItemGraphEdge[];
|
|
54
|
+
/**
|
|
55
|
+
* The current version of the vertex, incremented on each changeset.
|
|
56
|
+
*/
|
|
57
|
+
version?: number;
|
|
58
|
+
}
|
package/dist/types/index.d.ts
CHANGED
|
@@ -6,7 +6,9 @@ export * from "./entities/auditableItemGraphEdge.js";
|
|
|
6
6
|
export * from "./entities/auditableItemGraphPatch.js";
|
|
7
7
|
export * from "./entities/auditableItemGraphResource.js";
|
|
8
8
|
export * from "./entities/auditableItemGraphVertex.js";
|
|
9
|
+
export * from "./entities/auditableItemGraphVertexIndex.js";
|
|
9
10
|
export * from "./entities/auditableItemGraphVertexV0.js";
|
|
11
|
+
export * from "./entities/auditableItemGraphVertexV1.js";
|
|
10
12
|
export * from "./models/IAuditableItemGraphServiceConfig.js";
|
|
11
13
|
export * from "./models/IAuditableItemGraphServiceConstructorOptions.js";
|
|
12
14
|
export * from "./restEntryPoints.js";
|
|
@@ -13,6 +13,11 @@ export interface IAuditableItemGraphServiceConstructorOptions {
|
|
|
13
13
|
* @default auditable-item-graph-vertex
|
|
14
14
|
*/
|
|
15
15
|
vertexEntityStorageType?: string;
|
|
16
|
+
/**
|
|
17
|
+
* The entity storage for vertex indices.
|
|
18
|
+
* @default auditable-item-graph-vertex-index
|
|
19
|
+
*/
|
|
20
|
+
vertexIndexEntityStorageType?: string;
|
|
16
21
|
/**
|
|
17
22
|
* The entity storage for changesets.
|
|
18
23
|
* @default auditable-item-graph-changeset
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,91 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.10.1-next.2](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-service-v0.10.1-next.1...auditable-item-graph-service-v0.10.1-next.2) (2026-09-22)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* use entity storage query join ([#155](https://github.com/iotaledger/twin-auditable-item-graph/issues/155)) ([116bc94](https://github.com/iotaledger/twin-auditable-item-graph/commit/116bc94183fc70442ff2948d2506c65eb920b20e))
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Dependencies
|
|
12
|
+
|
|
13
|
+
* The following workspace dependencies were updated
|
|
14
|
+
* dependencies
|
|
15
|
+
* @twin.org/auditable-item-graph-models bumped from 0.10.1-next.1 to 0.10.1-next.2
|
|
16
|
+
|
|
17
|
+
## [0.10.1-next.1](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-service-v0.10.1-next.0...auditable-item-graph-service-v0.10.1-next.1) (2026-09-18)
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
### Features
|
|
21
|
+
|
|
22
|
+
* add audit mode ([9cb3a81](https://github.com/iotaledger/twin-auditable-item-graph/commit/9cb3a818b178ed76a8cb835745d12aa7153ca794))
|
|
23
|
+
* add context id features ([#30](https://github.com/iotaledger/twin-auditable-item-graph/issues/30)) ([a35d37c](https://github.com/iotaledger/twin-auditable-item-graph/commit/a35d37c0db62a240adde493965c0a9f7971fec45))
|
|
24
|
+
* add data types with fully qualified name ([93e1ee7](https://github.com/iotaledger/twin-auditable-item-graph/commit/93e1ee7c0f7bad81f003787f797f363864e201af))
|
|
25
|
+
* add event-driven telemetry metrics ([#63](https://github.com/iotaledger/twin-auditable-item-graph/issues/63)) ([8fe6cdd](https://github.com/iotaledger/twin-auditable-item-graph/commit/8fe6cdd0d56496402b766c151f002f475ddb8c0e))
|
|
26
|
+
* add health provider ([#132](https://github.com/iotaledger/twin-auditable-item-graph/issues/132)) ([5183025](https://github.com/iotaledger/twin-auditable-item-graph/commit/51830259fe6480cd56d1aeade0b1889f2c59f711))
|
|
27
|
+
* add optional audit mode ([#140](https://github.com/iotaledger/twin-auditable-item-graph/issues/140)) ([95e8fba](https://github.com/iotaledger/twin-auditable-item-graph/commit/95e8fba664611fb9bc6ab18dea6020a2a4e40792))
|
|
28
|
+
* add unique flag for alias, and exact match option for id query ([33dbd19](https://github.com/iotaledger/twin-auditable-item-graph/commit/33dbd19cabd9fbfaba81032f1d1a6527584c3f5a))
|
|
29
|
+
* add validate-locales ([e76e6f6](https://github.com/iotaledger/twin-auditable-item-graph/commit/e76e6f6b3ec9c447a04315d353442e32233601d3))
|
|
30
|
+
* add versions ([#60](https://github.com/iotaledger/twin-auditable-item-graph/issues/60)) ([5c36f94](https://github.com/iotaledger/twin-auditable-item-graph/commit/5c36f94b1155c01dddbc8d62f3f65d599916c521))
|
|
31
|
+
* add vertex validation ([#54](https://github.com/iotaledger/twin-auditable-item-graph/issues/54)) ([d3ef124](https://github.com/iotaledger/twin-auditable-item-graph/commit/d3ef1241f60956dc296e22d063f188921255d68c))
|
|
32
|
+
* additional query conditions ([#100](https://github.com/iotaledger/twin-auditable-item-graph/issues/100)) ([4fc6b7a](https://github.com/iotaledger/twin-auditable-item-graph/commit/4fc6b7afd7a854806537954fcd334619304da49c))
|
|
33
|
+
* changeset endpoints ([#44](https://github.com/iotaledger/twin-auditable-item-graph/issues/44)) ([7c854de](https://github.com/iotaledger/twin-auditable-item-graph/commit/7c854de39b247d6f24cd94a04a9f99fa9edde51d))
|
|
34
|
+
* configurable timeout for mutex ([5178789](https://github.com/iotaledger/twin-auditable-item-graph/commit/5178789ba160bca95221ce26bf87d7bd8c0c8619))
|
|
35
|
+
* enhanced rest testing ([#119](https://github.com/iotaledger/twin-auditable-item-graph/issues/119)) ([11f5653](https://github.com/iotaledger/twin-auditable-item-graph/commit/11f5653d297066983b5787429a262eca6a6f3fa7))
|
|
36
|
+
* eslint migration to flat config ([1b42a3a](https://github.com/iotaledger/twin-auditable-item-graph/commit/1b42a3a27bd6e32d7816de406b92b6332472edf6))
|
|
37
|
+
* id optional in edge updates ([6b63fe3](https://github.com/iotaledger/twin-auditable-item-graph/commit/6b63fe34553104843ae15aa5066775f5872859e9))
|
|
38
|
+
* improve entity schemas ([#151](https://github.com/iotaledger/twin-auditable-item-graph/issues/151)) ([41ca3ef](https://github.com/iotaledger/twin-auditable-item-graph/commit/41ca3ef89e6c41dcaf80381a34c18ac0de7d0eac))
|
|
39
|
+
* improve JSON schemas ([bec8dc1](https://github.com/iotaledger/twin-auditable-item-graph/commit/bec8dc1f270c6c9710623a192b984cf46f8a5613))
|
|
40
|
+
* improved versioning ([#66](https://github.com/iotaledger/twin-auditable-item-graph/issues/66)) ([1b497cd](https://github.com/iotaledger/twin-auditable-item-graph/commit/1b497cdc88eec9b6707b097283773e109baae3aa))
|
|
41
|
+
* mutex on remove proof operation ([d3697a0](https://github.com/iotaledger/twin-auditable-item-graph/commit/d3697a010997c2f9da1d13922a321be002ee27d3))
|
|
42
|
+
* only set dateModified after update ([#4](https://github.com/iotaledger/twin-auditable-item-graph/issues/4)) ([43ea6e5](https://github.com/iotaledger/twin-auditable-item-graph/commit/43ea6e5f2d0b9181a80f0bf2935db64b3263839a))
|
|
43
|
+
* organization identifiers ([#88](https://github.com/iotaledger/twin-auditable-item-graph/issues/88)) ([c58d35b](https://github.com/iotaledger/twin-auditable-item-graph/commit/c58d35bd5b878da0fa02862797c70b61e4f2a469))
|
|
44
|
+
* remove hosting component ([#91](https://github.com/iotaledger/twin-auditable-item-graph/issues/91)) ([d6180a8](https://github.com/iotaledger/twin-auditable-item-graph/commit/d6180a89a741314d81b44a9664aaff708c2d0ffa))
|
|
45
|
+
* remove unused namespace ([ff1a3b4](https://github.com/iotaledger/twin-auditable-item-graph/commit/ff1a3b4e414fe2ee311a03027456ee40fbb580d7))
|
|
46
|
+
* replace nextItem property with Link header ([#39](https://github.com/iotaledger/twin-auditable-item-graph/issues/39)) ([b29a333](https://github.com/iotaledger/twin-auditable-item-graph/commit/b29a333ca78ca2091e54e3e6f4355f84c350007d))
|
|
47
|
+
* rest enhancements ([1e51050](https://github.com/iotaledger/twin-auditable-item-graph/commit/1e51050af4c1a92f1f127054fe4c9da5e8cb591e))
|
|
48
|
+
* typescript 6 update ([2483c31](https://github.com/iotaledger/twin-auditable-item-graph/commit/2483c3171cff4c5ecedc83d958ab551291a4a487))
|
|
49
|
+
* update background task service ([e483ddb](https://github.com/iotaledger/twin-auditable-item-graph/commit/e483ddbc948f035334f92b8342248caa6abbe441))
|
|
50
|
+
* update contexts ([#35](https://github.com/iotaledger/twin-auditable-item-graph/issues/35)) ([cdf0989](https://github.com/iotaledger/twin-auditable-item-graph/commit/cdf0989fe4677a88b757e97e752b7d4c29013a7e))
|
|
51
|
+
* update contexts and namespaces ([#33](https://github.com/iotaledger/twin-auditable-item-graph/issues/33)) ([5dadb99](https://github.com/iotaledger/twin-auditable-item-graph/commit/5dadb99773d410aceacaba7ed92c1ccb8b46516b))
|
|
52
|
+
* update dependencies ([482c97e](https://github.com/iotaledger/twin-auditable-item-graph/commit/482c97e16109e504cb495084ef51e860a7f86669))
|
|
53
|
+
* update dependencies ([6986689](https://github.com/iotaledger/twin-auditable-item-graph/commit/698668957a1fcb7f85ce2f117914d5980043924f))
|
|
54
|
+
* update edges to use targetId instead of id ([6c5d0e3](https://github.com/iotaledger/twin-auditable-item-graph/commit/6c5d0e31b6e2ea74bfa2f3344e4be628e5f237af))
|
|
55
|
+
* update framework core ([88ad4e6](https://github.com/iotaledger/twin-auditable-item-graph/commit/88ad4e6421132c3c6c45579b078d982a26f16990))
|
|
56
|
+
* update immutable proof usage ([#73](https://github.com/iotaledger/twin-auditable-item-graph/issues/73)) ([a5181d1](https://github.com/iotaledger/twin-auditable-item-graph/commit/a5181d172cbc492c7cc964d22724cc10c46fc52e))
|
|
57
|
+
* update naming ([39210c4](https://github.com/iotaledger/twin-auditable-item-graph/commit/39210c45baddd3cd48805140a1c0049f3004653f))
|
|
58
|
+
* update schemas ([b00bcac](https://github.com/iotaledger/twin-auditable-item-graph/commit/b00bcac6551fa524e8871e1b573a712ed0f30943))
|
|
59
|
+
* use new hosting url for cursor links ([809cdc6](https://github.com/iotaledger/twin-auditable-item-graph/commit/809cdc623491bad91000d0b0f740e40dc019198d))
|
|
60
|
+
* use new nameof operators ([3921c4c](https://github.com/iotaledger/twin-auditable-item-graph/commit/3921c4c9ac53e42459e45f10d9e702afb2797a23))
|
|
61
|
+
* use shared store mechanism ([#10](https://github.com/iotaledger/twin-auditable-item-graph/issues/10)) ([da035e5](https://github.com/iotaledger/twin-auditable-item-graph/commit/da035e5eb8f157482b4eb2bdbc689c6c0647ff7d))
|
|
62
|
+
* use standard list json ld types ([8f53836](https://github.com/iotaledger/twin-auditable-item-graph/commit/8f53836d4c83a98d64d7f5fe0531bb9af09464ae))
|
|
63
|
+
* uuidv7 ([#46](https://github.com/iotaledger/twin-auditable-item-graph/issues/46)) ([d0179f8](https://github.com/iotaledger/twin-auditable-item-graph/commit/d0179f81290e0beae2f1c398a028aca6dd754023))
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
### Bug Fixes
|
|
67
|
+
|
|
68
|
+
* aig concurrent resource regression tests ([#77](https://github.com/iotaledger/twin-auditable-item-graph/issues/77)) ([82b8725](https://github.com/iotaledger/twin-auditable-item-graph/commit/82b872585686e070dde0a0c8493ded6e40a7a1d9))
|
|
69
|
+
* context usage ([9c8f64d](https://github.com/iotaledger/twin-auditable-item-graph/commit/9c8f64d342e9fb40d3514b87fd547a824ce50676))
|
|
70
|
+
* gate immutable proof on vertex organizationIdentity in AIG ([#81](https://github.com/iotaledger/twin-auditable-item-graph/issues/81)) ([0e67b6f](https://github.com/iotaledger/twin-auditable-item-graph/commit/0e67b6fb3511ca903667e11da3bdbcecdad7b21d))
|
|
71
|
+
* implement removeProof on AuditableItemGraphRestClient and expose DELETE /:id/proof route ([#85](https://github.com/iotaledger/twin-auditable-item-graph/issues/85)) ([ed74458](https://github.com/iotaledger/twin-auditable-item-graph/commit/ed74458aff9bc8606b75657a7bff15af4884189e))
|
|
72
|
+
* incremental edge merge and per-vertex update queue ([#70](https://github.com/iotaledger/twin-auditable-item-graph/issues/70)) ([91eb51d](https://github.com/iotaledger/twin-auditable-item-graph/commit/91eb51d135d2e609eebce90de099670f08eb20ca))
|
|
73
|
+
* only include alias in index if not deleted ([#6](https://github.com/iotaledger/twin-auditable-item-graph/issues/6)) ([5da3c41](https://github.com/iotaledger/twin-auditable-item-graph/commit/5da3c419fafa2afefd34b1c570d103012b888a75))
|
|
74
|
+
* query fixed ordering ([#124](https://github.com/iotaledger/twin-auditable-item-graph/issues/124)) ([f28d46d](https://github.com/iotaledger/twin-auditable-item-graph/commit/f28d46dae9bd2706c0cb1562b992757b1f5012ec))
|
|
75
|
+
* query params force coercion ([2dd9afe](https://github.com/iotaledger/twin-auditable-item-graph/commit/2dd9afe9ec37e2a91c110317fe289f7495c187a0))
|
|
76
|
+
* query resource type property name ([b684b31](https://github.com/iotaledger/twin-auditable-item-graph/commit/b684b3108e1e16852ee319e47edd0e40d5a2fe99))
|
|
77
|
+
* support new compactArrays flag ([2809b2b](https://github.com/iotaledger/twin-auditable-item-graph/commit/2809b2b83a946a850ad8f87f390fc00265a3fe7d))
|
|
78
|
+
* update tests with new deterministic background tasks ([#8](https://github.com/iotaledger/twin-auditable-item-graph/issues/8)) ([a96721c](https://github.com/iotaledger/twin-auditable-item-graph/commit/a96721c28128781f9cbd983d013dcf4c5542158c))
|
|
79
|
+
* use async getStore in tests ([0a911c0](https://github.com/iotaledger/twin-auditable-item-graph/commit/0a911c0c2c8a92e89d284e8651c0ef44736dc396))
|
|
80
|
+
* use async getStore in tests ([8d2969b](https://github.com/iotaledger/twin-auditable-item-graph/commit/8d2969b45fdeef849456cfbf898c580b23ce676c))
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
### Dependencies
|
|
84
|
+
|
|
85
|
+
* The following workspace dependencies were updated
|
|
86
|
+
* dependencies
|
|
87
|
+
* @twin.org/auditable-item-graph-models bumped from 0.10.1-next.0 to 0.10.1-next.1
|
|
88
|
+
|
|
3
89
|
## [0.10.0](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-service-v0.10.0...auditable-item-graph-service-v0.10.0) (2026-09-16)
|
|
4
90
|
|
|
5
91
|
|
package/docs/open-api/spec.json
CHANGED
|
@@ -300,7 +300,7 @@
|
|
|
300
300
|
},
|
|
301
301
|
{
|
|
302
302
|
"name": "limit",
|
|
303
|
-
"description": "
|
|
303
|
+
"description": "The maximum number of entities to return, a page can contain fewer so follow the cursor\nuntil it is absent to read them all.",
|
|
304
304
|
"in": "query",
|
|
305
305
|
"required": false,
|
|
306
306
|
"schema": {
|
|
@@ -525,7 +525,8 @@ The cursor to request the next chunk of entities.
|
|
|
525
525
|
|
|
526
526
|
`number`
|
|
527
527
|
|
|
528
|
-
|
|
528
|
+
The maximum number of entities to return, a page can contain fewer so follow
|
|
529
|
+
the cursor until it is absent to read them all.
|
|
529
530
|
|
|
530
531
|
#### Returns
|
|
531
532
|
|
|
@@ -54,22 +54,6 @@ How the mutations of the vertex are recorded, when absent the vertex behaves as
|
|
|
54
54
|
|
|
55
55
|
***
|
|
56
56
|
|
|
57
|
-
### aliasIndex? {#aliasindex}
|
|
58
|
-
|
|
59
|
-
> `optional` **aliasIndex?**: `string`
|
|
60
|
-
|
|
61
|
-
Combined alias index for the vertex used for querying.
|
|
62
|
-
|
|
63
|
-
***
|
|
64
|
-
|
|
65
|
-
### resourceTypeIndex? {#resourcetypeindex}
|
|
66
|
-
|
|
67
|
-
> `optional` **resourceTypeIndex?**: `string`
|
|
68
|
-
|
|
69
|
-
Combined resource type index for the vertex used for querying.
|
|
70
|
-
|
|
71
|
-
***
|
|
72
|
-
|
|
73
57
|
### annotationObject? {#annotationobject}
|
|
74
58
|
|
|
75
59
|
> `optional` **annotationObject?**: `IJsonLdNodeObject`
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# Class: AuditableItemGraphVertexIndex
|
|
2
|
+
|
|
3
|
+
Class describing the auditable item graph vertex index.
|
|
4
|
+
|
|
5
|
+
## Constructors
|
|
6
|
+
|
|
7
|
+
### Constructor
|
|
8
|
+
|
|
9
|
+
> **new AuditableItemGraphVertexIndex**(): `AuditableItemGraphVertexIndex`
|
|
10
|
+
|
|
11
|
+
#### Returns
|
|
12
|
+
|
|
13
|
+
`AuditableItemGraphVertexIndex`
|
|
14
|
+
|
|
15
|
+
## Properties
|
|
16
|
+
|
|
17
|
+
### id {#id}
|
|
18
|
+
|
|
19
|
+
> **id**: `string`
|
|
20
|
+
|
|
21
|
+
The id of the index.
|
|
22
|
+
|
|
23
|
+
***
|
|
24
|
+
|
|
25
|
+
### vertexId {#vertexid}
|
|
26
|
+
|
|
27
|
+
> **vertexId**: `string`
|
|
28
|
+
|
|
29
|
+
The id of the vertex this index refers to.
|
|
30
|
+
|
|
31
|
+
***
|
|
32
|
+
|
|
33
|
+
### type {#type}
|
|
34
|
+
|
|
35
|
+
> **type**: `string`
|
|
36
|
+
|
|
37
|
+
Index type.
|
|
38
|
+
|
|
39
|
+
***
|
|
40
|
+
|
|
41
|
+
### value {#value}
|
|
42
|
+
|
|
43
|
+
> **value**: `string`
|
|
44
|
+
|
|
45
|
+
Index value, case folded so lookups do not depend on the column collation.
|
|
46
|
+
|
|
47
|
+
***
|
|
48
|
+
|
|
49
|
+
### dateCreated {#datecreated}
|
|
50
|
+
|
|
51
|
+
> **dateCreated**: `string`
|
|
52
|
+
|
|
53
|
+
The date/time of when the vertex was created, copied so the index can order and page its
|
|
54
|
+
own matches without reading the vertex.
|
|
55
|
+
|
|
56
|
+
***
|
|
57
|
+
|
|
58
|
+
### dateModified? {#datemodified}
|
|
59
|
+
|
|
60
|
+
> `optional` **dateModified?**: `string`
|
|
61
|
+
|
|
62
|
+
The date/time of when the vertex was last modified, copied so a query ordered by the
|
|
63
|
+
modified date can also be paged from the index.
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
# Class: AuditableItemGraphVertexV1
|
|
2
|
+
|
|
3
|
+
Class describing the auditable item graph vertex.
|
|
4
|
+
|
|
5
|
+
## Constructors
|
|
6
|
+
|
|
7
|
+
### Constructor
|
|
8
|
+
|
|
9
|
+
> **new AuditableItemGraphVertexV1**(): `AuditableItemGraphVertexV1`
|
|
10
|
+
|
|
11
|
+
#### Returns
|
|
12
|
+
|
|
13
|
+
`AuditableItemGraphVertexV1`
|
|
14
|
+
|
|
15
|
+
## Properties
|
|
16
|
+
|
|
17
|
+
### id {#id}
|
|
18
|
+
|
|
19
|
+
> **id**: `string`
|
|
20
|
+
|
|
21
|
+
The id of the vertex.
|
|
22
|
+
|
|
23
|
+
***
|
|
24
|
+
|
|
25
|
+
### organizationIdentity {#organizationidentity}
|
|
26
|
+
|
|
27
|
+
> **organizationIdentity**: `string`
|
|
28
|
+
|
|
29
|
+
The identity of the organization which controls the vertex.
|
|
30
|
+
|
|
31
|
+
***
|
|
32
|
+
|
|
33
|
+
### dateCreated {#datecreated}
|
|
34
|
+
|
|
35
|
+
> **dateCreated**: `string`
|
|
36
|
+
|
|
37
|
+
The date/time of when the vertex was created.
|
|
38
|
+
|
|
39
|
+
***
|
|
40
|
+
|
|
41
|
+
### dateModified? {#datemodified}
|
|
42
|
+
|
|
43
|
+
> `optional` **dateModified?**: `string`
|
|
44
|
+
|
|
45
|
+
The date/time of when the vertex was last modified.
|
|
46
|
+
|
|
47
|
+
***
|
|
48
|
+
|
|
49
|
+
### auditMode? {#auditmode}
|
|
50
|
+
|
|
51
|
+
> `optional` **auditMode?**: `AuditableItemGraphAuditMode`
|
|
52
|
+
|
|
53
|
+
How the mutations of the vertex are recorded, when absent the vertex behaves as audited.
|
|
54
|
+
|
|
55
|
+
***
|
|
56
|
+
|
|
57
|
+
### aliasIndex? {#aliasindex}
|
|
58
|
+
|
|
59
|
+
> `optional` **aliasIndex?**: `string`
|
|
60
|
+
|
|
61
|
+
Combined alias index for the vertex used for querying.
|
|
62
|
+
|
|
63
|
+
***
|
|
64
|
+
|
|
65
|
+
### resourceTypeIndex? {#resourcetypeindex}
|
|
66
|
+
|
|
67
|
+
> `optional` **resourceTypeIndex?**: `string`
|
|
68
|
+
|
|
69
|
+
Combined resource type index for the vertex used for querying.
|
|
70
|
+
|
|
71
|
+
***
|
|
72
|
+
|
|
73
|
+
### annotationObject? {#annotationobject}
|
|
74
|
+
|
|
75
|
+
> `optional` **annotationObject?**: `IJsonLdNodeObject`
|
|
76
|
+
|
|
77
|
+
Object to associate with the vertex as JSON-LD.
|
|
78
|
+
|
|
79
|
+
***
|
|
80
|
+
|
|
81
|
+
### aliases? {#aliases}
|
|
82
|
+
|
|
83
|
+
> `optional` **aliases?**: [`AuditableItemGraphAlias`](AuditableItemGraphAlias.md)[]
|
|
84
|
+
|
|
85
|
+
Alternative aliases that can be used to identify the vertex.
|
|
86
|
+
|
|
87
|
+
***
|
|
88
|
+
|
|
89
|
+
### resources? {#resources}
|
|
90
|
+
|
|
91
|
+
> `optional` **resources?**: [`AuditableItemGraphResource`](AuditableItemGraphResource.md)[]
|
|
92
|
+
|
|
93
|
+
The resources attached to the vertex.
|
|
94
|
+
|
|
95
|
+
***
|
|
96
|
+
|
|
97
|
+
### edges? {#edges}
|
|
98
|
+
|
|
99
|
+
> `optional` **edges?**: [`AuditableItemGraphEdge`](AuditableItemGraphEdge.md)[]
|
|
100
|
+
|
|
101
|
+
Edges connected to the vertex.
|
|
102
|
+
|
|
103
|
+
***
|
|
104
|
+
|
|
105
|
+
### version? {#version}
|
|
106
|
+
|
|
107
|
+
> `optional` **version?**: `number`
|
|
108
|
+
|
|
109
|
+
The current version of the vertex, incremented on each changeset.
|
package/docs/reference/index.md
CHANGED
|
@@ -9,7 +9,9 @@
|
|
|
9
9
|
- [AuditableItemGraphPatch](classes/AuditableItemGraphPatch.md)
|
|
10
10
|
- [AuditableItemGraphResource](classes/AuditableItemGraphResource.md)
|
|
11
11
|
- [AuditableItemGraphVertex](classes/AuditableItemGraphVertex.md)
|
|
12
|
+
- [AuditableItemGraphVertexIndex](classes/AuditableItemGraphVertexIndex.md)
|
|
12
13
|
- [AuditableItemGraphVertexV0](classes/AuditableItemGraphVertexV0.md)
|
|
14
|
+
- [AuditableItemGraphVertexV1](classes/AuditableItemGraphVertexV1.md)
|
|
13
15
|
|
|
14
16
|
## Interfaces
|
|
15
17
|
|
|
@@ -32,6 +32,20 @@ auditable-item-graph-vertex
|
|
|
32
32
|
|
|
33
33
|
***
|
|
34
34
|
|
|
35
|
+
### vertexIndexEntityStorageType? {#vertexindexentitystoragetype}
|
|
36
|
+
|
|
37
|
+
> `optional` **vertexIndexEntityStorageType?**: `string`
|
|
38
|
+
|
|
39
|
+
The entity storage for vertex indices.
|
|
40
|
+
|
|
41
|
+
#### Default
|
|
42
|
+
|
|
43
|
+
```ts
|
|
44
|
+
auditable-item-graph-vertex-index
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
***
|
|
48
|
+
|
|
35
49
|
### changesetEntityStorageType? {#changesetentitystoragetype}
|
|
36
50
|
|
|
37
51
|
> `optional` **changesetEntityStorageType?**: `string`
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/auditable-item-graph-service",
|
|
3
|
-
"version": "0.10.
|
|
3
|
+
"version": "0.10.1-next.2",
|
|
4
4
|
"description": "Implements graph lifecycle operations and audited change tracking with API route definitions.",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -14,21 +14,21 @@
|
|
|
14
14
|
"node": ">=24.0.0"
|
|
15
15
|
},
|
|
16
16
|
"dependencies": {
|
|
17
|
-
"@twin.org/api-models": "
|
|
18
|
-
"@twin.org/auditable-item-graph-models": "
|
|
19
|
-
"@twin.org/context": "
|
|
20
|
-
"@twin.org/core": "
|
|
21
|
-
"@twin.org/data-core": "
|
|
22
|
-
"@twin.org/data-json-ld": "
|
|
23
|
-
"@twin.org/entity": "
|
|
24
|
-
"@twin.org/entity-storage-models": "
|
|
25
|
-
"@twin.org/event-bus-models": "
|
|
26
|
-
"@twin.org/immutable-proof-models": "
|
|
27
|
-
"@twin.org/nameof": "
|
|
28
|
-
"@twin.org/standards-schema-org": "
|
|
29
|
-
"@twin.org/standards-w3c-did": "
|
|
30
|
-
"@twin.org/telemetry-models": "
|
|
31
|
-
"@twin.org/web": "
|
|
17
|
+
"@twin.org/api-models": "next",
|
|
18
|
+
"@twin.org/auditable-item-graph-models": "0.10.1-next.2",
|
|
19
|
+
"@twin.org/context": "next",
|
|
20
|
+
"@twin.org/core": "next",
|
|
21
|
+
"@twin.org/data-core": "next",
|
|
22
|
+
"@twin.org/data-json-ld": "next",
|
|
23
|
+
"@twin.org/entity": "next",
|
|
24
|
+
"@twin.org/entity-storage-models": "next",
|
|
25
|
+
"@twin.org/event-bus-models": "next",
|
|
26
|
+
"@twin.org/immutable-proof-models": "next",
|
|
27
|
+
"@twin.org/nameof": "next",
|
|
28
|
+
"@twin.org/standards-schema-org": "next",
|
|
29
|
+
"@twin.org/standards-w3c-did": "next",
|
|
30
|
+
"@twin.org/telemetry-models": "next",
|
|
31
|
+
"@twin.org/web": "next"
|
|
32
32
|
},
|
|
33
33
|
"main": "./dist/es/index.js",
|
|
34
34
|
"types": "./dist/types/index.d.ts",
|