@twin.org/document-management-models 0.0.1-next.13 → 0.0.1-next.14

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 (8) hide show
  1. package/dist/cjs/index.cjs +1 -5
  2. package/dist/esm/index.mjs +1 -5
  3. package/dist/types/models/IDocumentList.d.ts +5 -4
  4. package/dist/types/models/documentTypes.d.ts +0 -4
  5. package/docs/changelog.md +7 -0
  6. package/docs/reference/interfaces/IDocumentList.md +6 -6
  7. package/docs/reference/variables/DocumentTypes.md +0 -6
  8. package/package.json +1 -1
package/dist/cjs/index.cjs CHANGED
@@ -31,11 +31,7 @@ const DocumentTypes = {
31
31
  /**
32
32
  * Represents a document attestation.
33
33
  */
34
- DocumentAttestation: "DocumentAttestation",
35
- /**
36
- * Represents a document list.
37
- */
38
- DocumentList: "DocumentList"
34
+ DocumentAttestation: "DocumentAttestation"
39
35
  };
40
36
 
41
37
  exports.DocumentContexts = DocumentContexts;
package/dist/esm/index.mjs CHANGED
@@ -29,11 +29,7 @@ const DocumentTypes = {
29
29
  /**
30
30
  * Represents a document attestation.
31
31
  */
32
- DocumentAttestation: "DocumentAttestation",
33
- /**
34
- * Represents a document list.
35
- */
36
- DocumentList: "DocumentList"
32
+ DocumentAttestation: "DocumentAttestation"
37
33
  };
38
34
 
39
35
  export { DocumentContexts, DocumentTypes };
package/dist/types/models/IDocumentList.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
2
+ import type { SchemaOrgContexts, SchemaOrgTypes } from "@twin.org/standards-schema-org";
2
3
  import type { DocumentContexts } from "./documentContexts";
3
- import type { DocumentTypes } from "./documentTypes";
4
4
  import type { IDocument } from "./IDocument";
5
5
  /**
6
6
  * Interface describing a list of document entries.
@@ -10,6 +10,7 @@ export interface IDocumentList {
10
10
  * JSON-LD Context.
11
11
  */
12
12
  "@context": [
13
+ typeof SchemaOrgContexts.ContextRoot,
13
14
  typeof DocumentContexts.ContextRoot,
14
15
  typeof DocumentContexts.ContextRootCommon,
15
16
  ...IJsonLdContextDefinitionElement[]
@@ -17,11 +18,11 @@ export interface IDocumentList {
17
18
  /**
18
19
  * JSON-LD Type.
19
20
  */
20
- type: typeof DocumentTypes.DocumentList;
21
+ type: typeof SchemaOrgTypes.ItemList;
21
22
  /**
22
23
  * The list of documents.
23
24
  */
24
- documents: IDocument[];
25
+ [SchemaOrgTypes.ItemListElement]: IDocument[];
25
26
  /**
26
27
  * The ids of the other vertices which are connected to the document.
27
28
  */
@@ -29,5 +30,5 @@ export interface IDocumentList {
29
30
  /**
30
31
  * The cursor to get the next chunk of documents.
31
32
  */
32
- cursor?: string;
33
+ [SchemaOrgTypes.NextItem]?: string;
33
34
  }
package/dist/types/models/documentTypes.d.ts CHANGED
@@ -10,10 +10,6 @@ export declare const DocumentTypes: {
10
10
  * Represents a document attestation.
11
11
  */
12
12
  readonly DocumentAttestation: "DocumentAttestation";
13
- /**
14
- * Represents a document list.
15
- */
16
- readonly DocumentList: "DocumentList";
17
13
  };
18
14
  /**
19
15
  * The types of document management objects.
package/docs/changelog.md CHANGED
@@ -1,5 +1,12 @@
1
1
  # @twin.org/document-management-models - Changelog
2
2
 
3
+ ## [0.0.1-next.14](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.13...document-management-models-v0.0.1-next.14) (2025-05-08)
4
+
5
+
6
+ ### Features
7
+
8
+ * use standard list json ld types ([20ea04b](https://github.com/twinfoundation/document-management/commit/20ea04b05fd4bc4fcedce8f66958942c3c2fa303))
9
+
3
10
  ## [0.0.1-next.13](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.12...document-management-models-v0.0.1-next.13) (2025-04-30)
4
11
 
5
12
 
package/docs/reference/interfaces/IDocumentList.md CHANGED
@@ -6,7 +6,7 @@ Interface describing a list of document entries.
6
6
 
7
7
  ### @context
8
8
 
9
- > **@context**: \[`"https://schema.twindev.org/documents/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
9
+ > **@context**: \[`"https://schema.org"`, `"https://schema.twindev.org/documents/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
10
10
 
11
11
  JSON-LD Context.
12
12
 
@@ -14,15 +14,15 @@ JSON-LD Context.
14
14
 
15
15
  ### type
16
16
 
17
- > **type**: `"DocumentList"`
17
+ > **type**: `"ItemList"`
18
18
 
19
19
  JSON-LD Type.
20
20
 
21
21
  ***
22
22
 
23
- ### documents
23
+ ### itemListElement
24
24
 
25
- > **documents**: [`IDocument`](IDocument.md)[]
25
+ > **itemListElement**: [`IDocument`](IDocument.md)[]
26
26
 
27
27
  The list of documents.
28
28
 
@@ -36,8 +36,8 @@ The ids of the other vertices which are connected to the document.
36
36
 
37
37
  ***
38
38
 
39
- ### cursor?
39
+ ### nextItem?
40
40
 
41
- > `optional` **cursor**: `string`
41
+ > `optional` **nextItem**: `string`
42
42
 
43
43
  The cursor to get the next chunk of documents.
package/docs/reference/variables/DocumentTypes.md CHANGED
@@ -17,9 +17,3 @@ Represents a document.
17
17
  > `readonly` **DocumentAttestation**: `"DocumentAttestation"` = `"DocumentAttestation"`
18
18
 
19
19
  Represents a document attestation.
20
-
21
- ### DocumentList
22
-
23
- > `readonly` **DocumentList**: `"DocumentList"` = `"DocumentList"`
24
-
25
- Represents a document list.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/document-management-models",
3
- "version": "0.0.1-next.13",
3
+ "version": "0.0.1-next.14",
4
4
  "description": "Models which define the structure of the document management connectors and services",
5
5
  "repository": {
6
6
  "type": "git",