@twin.org/auditable-item-graph-models 0.9.0 → 0.9.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.
Files changed (5) hide show
  1. package/dist/es/models/api/IAuditableItemGraphListRequest.js.map +1 -1
  2. package/dist/types/models/api/IAuditableItemGraphListRequest.d.ts +1 -1
  3. package/docs/changelog.md +52 -0
  4. package/docs/reference/interfaces/IAuditableItemGraphListRequest.md +1 -1
  5. package/package.json +10 -10
package/dist/es/models/api/IAuditableItemGraphListRequest.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"IAuditableItemGraphListRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IAuditableItemGraphListRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { SortDirection } from \"@twin.org/entity\";\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\nimport type { IAuditableItemGraphVertex } from \"../IAuditableItemGraphVertex.js\";\n\n/**\n * Get the a list of the vertices with matching ids or aliases.\n */\nexport interface IAuditableItemGraphListRequest {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The query parameters.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * The id or alias to try and find.\n\t\t */\n\t\tid?: string;\n\n\t\t/**\n\t\t * Which field to look in with the id, defaults to both.\n\t\t */\n\t\tidMode?: \"id\" | \"alias\" | \"both\";\n\n\t\t/**\n\t\t * Find only exact matches, default to false meaning partial matching.\n\t\t */\n\t\tidExact?: string;\n\n\t\t/**\n\t\t * Include vertices with specific resource types, comma separated.\n\t\t */\n\t\tresourceTypes?: string;\n\n\t\t/**\n\t\t * The conditions to filter the streams, JSON stringified EntityCondition<IAuditableItemGraphVertex>.\n\t\t */\n\t\tconditions?: string;\n\n\t\t/**\n\t\t * The order for the results, default to dateCreated.\n\t\t */\n\t\torderBy?: keyof Pick<IAuditableItemGraphVertex, \"dateCreated\" | \"dateModified\">;\n\n\t\t/**\n\t\t * The direction for the order, defaults to desc.\n\t\t */\n\t\torderByDirection?: SortDirection;\n\n\t\t/**\n\t\t * The properties to return as a comma separated list, defaults to \"id,dateCreated,aliases,annotationObject\".\n\t\t */\n\t\tproperties?: string;\n\n\t\t/**\n\t\t * The optional cursor to get next chunk.\n\t\t */\n\t\tcursor?: string;\n\n\t\t/**\n\t\t * Limit the number of entities to return.\n\t\t */\n\t\tlimit?: string;\n\t};\n}\n"]}
1
+ {"version":3,"file":"IAuditableItemGraphListRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IAuditableItemGraphListRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { SortDirection } from \"@twin.org/entity\";\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\nimport type { IAuditableItemGraphVertex } from \"../IAuditableItemGraphVertex.js\";\n\n/**\n * Get the a list of the vertices with matching ids or aliases.\n */\nexport interface IAuditableItemGraphListRequest {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The query parameters.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * The id or alias to try and find.\n\t\t */\n\t\tid?: string;\n\n\t\t/**\n\t\t * Which field to look in with the id, defaults to both.\n\t\t */\n\t\tidMode?: \"id\" | \"alias\" | \"both\";\n\n\t\t/**\n\t\t * Find only exact matches, default to false meaning partial matching.\n\t\t */\n\t\tidExact?: string;\n\n\t\t/**\n\t\t * Include vertices with specific resource types, comma separated.\n\t\t */\n\t\tresourceTypes?: string;\n\n\t\t/**\n\t\t * The conditions to filter the streams, JSON stringified `EntityCondition<IAuditableItemGraphVertex>`.\n\t\t */\n\t\tconditions?: string;\n\n\t\t/**\n\t\t * The order for the results, default to dateCreated.\n\t\t */\n\t\torderBy?: keyof Pick<IAuditableItemGraphVertex, \"dateCreated\" | \"dateModified\">;\n\n\t\t/**\n\t\t * The direction for the order, defaults to desc.\n\t\t */\n\t\torderByDirection?: SortDirection;\n\n\t\t/**\n\t\t * The properties to return as a comma separated list, defaults to \"id,dateCreated,aliases,annotationObject\".\n\t\t */\n\t\tproperties?: string;\n\n\t\t/**\n\t\t * The optional cursor to get next chunk.\n\t\t */\n\t\tcursor?: string;\n\n\t\t/**\n\t\t * Limit the number of entities to return.\n\t\t */\n\t\tlimit?: string;\n\t};\n}\n"]}
package/dist/types/models/api/IAuditableItemGraphListRequest.d.ts CHANGED
@@ -32,7 +32,7 @@ export interface IAuditableItemGraphListRequest {
32
32
  */
33
33
  resourceTypes?: string;
34
34
  /**
35
- * The conditions to filter the streams, JSON stringified EntityCondition<IAuditableItemGraphVertex>.
35
+ * The conditions to filter the streams, JSON stringified `EntityCondition<IAuditableItemGraphVertex>`.
36
36
  */
37
37
  conditions?: string;
38
38
  /**
package/docs/changelog.md CHANGED
@@ -1,5 +1,57 @@
1
1
  # Changelog
2
2
 
3
+ ## [0.9.1-next.2](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.9.1-next.1...auditable-item-graph-models-v0.9.1-next.2) (2026-06-29)
4
+
5
+
6
+ ### Miscellaneous Chores
7
+
8
+ * **auditable-item-graph-models:** Synchronize repo versions
9
+
10
+ ## [0.9.1-next.1](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.9.1-next.0...auditable-item-graph-models-v0.9.1-next.1) (2026-06-26)
11
+
12
+
13
+ ### Features
14
+
15
+ * 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))
16
+ * add data types with fully qualified name ([93e1ee7](https://github.com/iotaledger/twin-auditable-item-graph/commit/93e1ee7c0f7bad81f003787f797f363864e201af))
17
+ * 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))
18
+ * add ts-to-jsonld-context tool ([08d360e](https://github.com/iotaledger/twin-auditable-item-graph/commit/08d360e05fd7f8c5bbe6ee4d4e691ffd516db418))
19
+ * add unique flag for alias, and exact match option for id query ([33dbd19](https://github.com/iotaledger/twin-auditable-item-graph/commit/33dbd19cabd9fbfaba81032f1d1a6527584c3f5a))
20
+ * add validate-locales ([e76e6f6](https://github.com/iotaledger/twin-auditable-item-graph/commit/e76e6f6b3ec9c447a04315d353442e32233601d3))
21
+ * add versions ([#60](https://github.com/iotaledger/twin-auditable-item-graph/issues/60)) ([5c36f94](https://github.com/iotaledger/twin-auditable-item-graph/commit/5c36f94b1155c01dddbc8d62f3f65d599916c521))
22
+ * 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))
23
+ * 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))
24
+ * changeset endpoints ([#44](https://github.com/iotaledger/twin-auditable-item-graph/issues/44)) ([7c854de](https://github.com/iotaledger/twin-auditable-item-graph/commit/7c854de39b247d6f24cd94a04a9f99fa9edde51d))
25
+ * eslint migration to flat config ([1b42a3a](https://github.com/iotaledger/twin-auditable-item-graph/commit/1b42a3a27bd6e32d7816de406b92b6332472edf6))
26
+ * id optional in edge updates ([6b63fe3](https://github.com/iotaledger/twin-auditable-item-graph/commit/6b63fe34553104843ae15aa5066775f5872859e9))
27
+ * improve comments ([97f311a](https://github.com/iotaledger/twin-auditable-item-graph/commit/97f311a9cc4353b5020a48a44420c97a2fa0c8d7))
28
+ * improve JSON schemas ([bec8dc1](https://github.com/iotaledger/twin-auditable-item-graph/commit/bec8dc1f270c6c9710623a192b984cf46f8a5613))
29
+ * improved versioning ([#66](https://github.com/iotaledger/twin-auditable-item-graph/issues/66)) ([1b497cd](https://github.com/iotaledger/twin-auditable-item-graph/commit/1b497cdc88eec9b6707b097283773e109baae3aa))
30
+ * 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))
31
+ * typescript 6 update ([2483c31](https://github.com/iotaledger/twin-auditable-item-graph/commit/2483c3171cff4c5ecedc83d958ab551291a4a487))
32
+ * update background task service ([e483ddb](https://github.com/iotaledger/twin-auditable-item-graph/commit/e483ddbc948f035334f92b8342248caa6abbe441))
33
+ * update contexts ([#35](https://github.com/iotaledger/twin-auditable-item-graph/issues/35)) ([cdf0989](https://github.com/iotaledger/twin-auditable-item-graph/commit/cdf0989fe4677a88b757e97e752b7d4c29013a7e))
34
+ * 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))
35
+ * update dependencies ([6986689](https://github.com/iotaledger/twin-auditable-item-graph/commit/698668957a1fcb7f85ce2f117914d5980043924f))
36
+ * update edges to use targetId instead of id ([6c5d0e3](https://github.com/iotaledger/twin-auditable-item-graph/commit/6c5d0e31b6e2ea74bfa2f3344e4be628e5f237af))
37
+ * update framework core ([88ad4e6](https://github.com/iotaledger/twin-auditable-item-graph/commit/88ad4e6421132c3c6c45579b078d982a26f16990))
38
+ * 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))
39
+ * update schemas ([b00bcac](https://github.com/iotaledger/twin-auditable-item-graph/commit/b00bcac6551fa524e8871e1b573a712ed0f30943))
40
+ * update targetid json context type ([1e47ca7](https://github.com/iotaledger/twin-auditable-item-graph/commit/1e47ca7ec3080251d940fd8e58c44ca4fa9457f7))
41
+ * update ts-to-schema generation ([edce91e](https://github.com/iotaledger/twin-auditable-item-graph/commit/edce91e8272ab361595489458066040caf582df2))
42
+ * use new nameof operators ([3921c4c](https://github.com/iotaledger/twin-auditable-item-graph/commit/3921c4c9ac53e42459e45f10d9e702afb2797a23))
43
+ * 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))
44
+ * use standard list json ld types ([8f53836](https://github.com/iotaledger/twin-auditable-item-graph/commit/8f53836d4c83a98d64d7f5fe0531bb9af09464ae))
45
+
46
+
47
+ ### Bug Fixes
48
+
49
+ * docs ([cf961ff](https://github.com/iotaledger/twin-auditable-item-graph/commit/cf961ff3e89f3c856e85f840cd01730c4fd42fa9))
50
+ * 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))
51
+ * 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))
52
+ * 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))
53
+ * query params force coercion ([2dd9afe](https://github.com/iotaledger/twin-auditable-item-graph/commit/2dd9afe9ec37e2a91c110317fe289f7495c187a0))
54
+
3
55
  ## [0.9.0](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.9.0...auditable-item-graph-models-v0.9.0) (2026-06-25)
4
56
 
5
57
 
package/docs/reference/interfaces/IAuditableItemGraphListRequest.md CHANGED
@@ -50,7 +50,7 @@ Include vertices with specific resource types, comma separated.
50
50
 
51
51
  > `optional` **conditions?**: `string`
52
52
 
53
- The conditions to filter the streams, JSON stringified EntityCondition<IAuditableItemGraphVertex>.
53
+ The conditions to filter the streams, JSON stringified `EntityCondition<IAuditableItemGraphVertex>`.
54
54
 
55
55
  #### orderBy?
56
56
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/auditable-item-graph-models",
3
- "version": "0.9.0",
3
+ "version": "0.9.1-next.2",
4
4
  "description": "Defines shared graph data contracts, JSON schemas, and JSON-LD contexts for consistent interoperability.",
5
5
  "repository": {
6
6
  "type": "git",
@@ -14,15 +14,15 @@
14
14
  "node": ">=20.0.0"
15
15
  },
16
16
  "dependencies": {
17
- "@twin.org/core": "^0.9.0",
18
- "@twin.org/data-core": "^0.9.0",
19
- "@twin.org/data-json-ld": "^0.9.0",
20
- "@twin.org/entity": "^0.9.0",
21
- "@twin.org/immutable-proof-models": "^0.9.0",
22
- "@twin.org/nameof": "^0.9.0",
23
- "@twin.org/standards-schema-org": "^0.9.0",
24
- "@twin.org/telemetry-models": "^0.9.0",
25
- "@twin.org/web": "^0.9.0"
17
+ "@twin.org/core": "next",
18
+ "@twin.org/data-core": "next",
19
+ "@twin.org/data-json-ld": "next",
20
+ "@twin.org/entity": "next",
21
+ "@twin.org/immutable-proof-models": "next",
22
+ "@twin.org/nameof": "next",
23
+ "@twin.org/standards-schema-org": "next",
24
+ "@twin.org/telemetry-models": "next",
25
+ "@twin.org/web": "next"
26
26
  },
27
27
  "main": "./dist/es/index.js",
28
28
  "types": "./dist/types/index.d.ts",