@3sixty/document-management-models 0.0.0-stage → 0.20.0-next.1

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 (110) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +24 -2
  3. package/dist/es/compiled/validators.js +600 -0
  4. package/dist/es/compiled/validators.js.map +1 -0
  5. package/dist/es/dataTypes/documentManagementDataTypes.js +59 -0
  6. package/dist/es/dataTypes/documentManagementDataTypes.js.map +1 -0
  7. package/dist/es/index.js +25 -0
  8. package/dist/es/index.js.map +1 -0
  9. package/dist/es/models/IDocument.js +2 -0
  10. package/dist/es/models/IDocument.js.map +1 -0
  11. package/dist/es/models/IDocumentAttestation.js +2 -0
  12. package/dist/es/models/IDocumentAttestation.js.map +1 -0
  13. package/dist/es/models/IDocumentBase.js +2 -0
  14. package/dist/es/models/IDocumentBase.js.map +1 -0
  15. package/dist/es/models/IDocumentHydrated.js +2 -0
  16. package/dist/es/models/IDocumentHydrated.js.map +1 -0
  17. package/dist/es/models/IDocumentList.js +2 -0
  18. package/dist/es/models/IDocumentList.js.map +1 -0
  19. package/dist/es/models/IDocumentManagementComponent.js +2 -0
  20. package/dist/es/models/IDocumentManagementComponent.js.map +1 -0
  21. package/dist/es/models/IDocumentManagementEdgeEntry.js +2 -0
  22. package/dist/es/models/IDocumentManagementEdgeEntry.js.map +1 -0
  23. package/dist/es/models/api/IDocumentManagementCreateRequest.js +2 -0
  24. package/dist/es/models/api/IDocumentManagementCreateRequest.js.map +1 -0
  25. package/dist/es/models/api/IDocumentManagementGetRequest.js +2 -0
  26. package/dist/es/models/api/IDocumentManagementGetRequest.js.map +1 -0
  27. package/dist/es/models/api/IDocumentManagementGetResponse.js +2 -0
  28. package/dist/es/models/api/IDocumentManagementGetResponse.js.map +1 -0
  29. package/dist/es/models/api/IDocumentManagementGetRevisionRequest.js +2 -0
  30. package/dist/es/models/api/IDocumentManagementGetRevisionRequest.js.map +1 -0
  31. package/dist/es/models/api/IDocumentManagementGetRevisionResponse.js +2 -0
  32. package/dist/es/models/api/IDocumentManagementGetRevisionResponse.js.map +1 -0
  33. package/dist/es/models/api/IDocumentManagementQueryRequest.js +2 -0
  34. package/dist/es/models/api/IDocumentManagementQueryRequest.js.map +1 -0
  35. package/dist/es/models/api/IDocumentManagementQueryResponse.js +2 -0
  36. package/dist/es/models/api/IDocumentManagementQueryResponse.js.map +1 -0
  37. package/dist/es/models/api/IDocumentManagementRemoveRequest.js +4 -0
  38. package/dist/es/models/api/IDocumentManagementRemoveRequest.js.map +1 -0
  39. package/dist/es/models/api/IDocumentManagementUpdatePartialRequest.js +2 -0
  40. package/dist/es/models/api/IDocumentManagementUpdatePartialRequest.js.map +1 -0
  41. package/dist/es/models/documentContexts.js +33 -0
  42. package/dist/es/models/documentContexts.js.map +1 -0
  43. package/dist/es/models/documentManagementMetricIds.js +29 -0
  44. package/dist/es/models/documentManagementMetricIds.js.map +1 -0
  45. package/dist/es/models/documentManagementMetrics.js +36 -0
  46. package/dist/es/models/documentManagementMetrics.js.map +1 -0
  47. package/dist/es/models/documentTypes.js +25 -0
  48. package/dist/es/models/documentTypes.js.map +1 -0
  49. package/dist/es/schemas/Document.json +86 -0
  50. package/dist/es/schemas/DocumentAttestation.json +60 -0
  51. package/dist/es/schemas/DocumentBase.json +29 -0
  52. package/dist/es/schemas/DocumentHydrated.json +25 -0
  53. package/dist/es/schemas/DocumentList.json +51 -0
  54. package/dist/types/compiled/validators.d.ts +21 -0
  55. package/dist/types/dataTypes/documentManagementDataTypes.d.ts +9 -0
  56. package/dist/types/index.d.ts +22 -0
  57. package/dist/types/models/IDocument.d.ts +72 -0
  58. package/dist/types/models/IDocumentAttestation.d.ts +46 -0
  59. package/dist/types/models/IDocumentBase.d.ts +27 -0
  60. package/dist/types/models/IDocumentHydrated.d.ts +23 -0
  61. package/dist/types/models/IDocumentList.d.ts +32 -0
  62. package/dist/types/models/IDocumentManagementComponent.d.ts +123 -0
  63. package/dist/types/models/IDocumentManagementEdgeEntry.d.ts +18 -0
  64. package/dist/types/models/api/IDocumentManagementCreateRequest.d.ts +42 -0
  65. package/dist/types/models/api/IDocumentManagementGetRequest.d.ts +68 -0
  66. package/dist/types/models/api/IDocumentManagementGetResponse.d.ts +18 -0
  67. package/dist/types/models/api/IDocumentManagementGetRevisionRequest.d.ts +53 -0
  68. package/dist/types/models/api/IDocumentManagementGetRevisionResponse.d.ts +17 -0
  69. package/dist/types/models/api/IDocumentManagementQueryRequest.d.ts +29 -0
  70. package/dist/types/models/api/IDocumentManagementQueryResponse.d.ts +18 -0
  71. package/dist/types/models/api/IDocumentManagementRemoveRequest.d.ts +18 -0
  72. package/dist/types/models/api/IDocumentManagementUpdatePartialRequest.d.ts +61 -0
  73. package/dist/types/models/documentContexts.d.ts +33 -0
  74. package/dist/types/models/documentManagementMetricIds.d.ts +29 -0
  75. package/dist/types/models/documentManagementMetrics.d.ts +5 -0
  76. package/dist/types/models/documentTypes.d.ts +25 -0
  77. package/docs/changelog.md +9 -0
  78. package/docs/examples.md +23 -0
  79. package/docs/reference/classes/DocumentManagementDataTypes.md +25 -0
  80. package/docs/reference/index.md +42 -0
  81. package/docs/reference/interfaces/IDocument.md +155 -0
  82. package/docs/reference/interfaces/IDocumentAttestation.md +59 -0
  83. package/docs/reference/interfaces/IDocumentBase.md +39 -0
  84. package/docs/reference/interfaces/IDocumentHydrated.md +223 -0
  85. package/docs/reference/interfaces/IDocumentList.md +35 -0
  86. package/docs/reference/interfaces/IDocumentManagementComponent.md +348 -0
  87. package/docs/reference/interfaces/IDocumentManagementCreateRequest.md +53 -0
  88. package/docs/reference/interfaces/IDocumentManagementEdgeEntry.md +27 -0
  89. package/docs/reference/interfaces/IDocumentManagementGetRequest.md +127 -0
  90. package/docs/reference/interfaces/IDocumentManagementGetResponse.md +27 -0
  91. package/docs/reference/interfaces/IDocumentManagementGetRevisionRequest.md +91 -0
  92. package/docs/reference/interfaces/IDocumentManagementGetRevisionResponse.md +23 -0
  93. package/docs/reference/interfaces/IDocumentManagementQueryRequest.md +41 -0
  94. package/docs/reference/interfaces/IDocumentManagementQueryResponse.md +27 -0
  95. package/docs/reference/interfaces/IDocumentManagementRemoveRequest.md +23 -0
  96. package/docs/reference/interfaces/IDocumentManagementUpdatePartialRequest.md +80 -0
  97. package/docs/reference/type-aliases/DocumentContexts.md +5 -0
  98. package/docs/reference/type-aliases/DocumentManagementMetricIds.md +5 -0
  99. package/docs/reference/type-aliases/DocumentTypes.md +5 -0
  100. package/docs/reference/variables/CompiledDocument.md +5 -0
  101. package/docs/reference/variables/CompiledDocumentAttestation.md +5 -0
  102. package/docs/reference/variables/CompiledDocumentBase.md +5 -0
  103. package/docs/reference/variables/CompiledDocumentHydrated.md +5 -0
  104. package/docs/reference/variables/CompiledDocumentList.md +5 -0
  105. package/docs/reference/variables/DocumentContexts.md +43 -0
  106. package/docs/reference/variables/DocumentManagementMetricIds.md +37 -0
  107. package/docs/reference/variables/DocumentManagementMetrics.md +5 -0
  108. package/docs/reference/variables/DocumentTypes.md +31 -0
  109. package/locales/en.json +3 -0
  110. package/package.json +63 -5
package/docs/reference/variables/DocumentTypes.md ADDED
@@ -0,0 +1,31 @@
1
+ # Variable: DocumentTypes
2
+
3
+ > `const` **DocumentTypes**: `object`
4
+
5
+ The types of document management objects.
6
+
7
+ ## Type Declaration
8
+
9
+ ### Document {#document}
10
+
11
+ > `readonly` **Document**: `"Document"` = `"Document"`
12
+
13
+ Represents a document.
14
+
15
+ ### DocumentHydrated {#documenthydrated}
16
+
17
+ > `readonly` **DocumentHydrated**: `"DocumentHydrated"` = `"DocumentHydrated"`
18
+
19
+ Represents a document hydrated.
20
+
21
+ ### DocumentAttestation {#documentattestation}
22
+
23
+ > `readonly` **DocumentAttestation**: `"DocumentAttestation"` = `"DocumentAttestation"`
24
+
25
+ Represents a document attestation.
26
+
27
+ ### DocumentList {#documentlist}
28
+
29
+ > `readonly` **DocumentList**: `"DocumentList"` = `"DocumentList"`
30
+
31
+ Represents a document list.
package/locales/en.json ADDED
@@ -0,0 +1,3 @@
1
+ {
2
+ "error": {}
3
+ }
package/package.json CHANGED
@@ -1,6 +1,64 @@
1
1
  {
2
- "name": "@3sixty/document-management-models",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
6
- }
2
+ "name": "@3sixty/document-management-models",
3
+ "version": "0.20.0-next.1",
4
+ "description": "Shared data models, schemas, and context definitions for document lifecycle records.",
5
+ "repository": {
6
+ "type": "git",
7
+ "url": "git+https://github.com/3sixtyglobal/document-management.git",
8
+ "directory": "packages/document-management-models"
9
+ },
10
+ "author": "martyn.janes@iota.org",
11
+ "license": "Apache-2.0",
12
+ "type": "module",
13
+ "engines": {
14
+ "node": ">=24.0.0"
15
+ },
16
+ "dependencies": {
17
+ "@3sixty/attestation-models": "next",
18
+ "@3sixty/auditable-item-graph-models": "next",
19
+ "@3sixty/blob-storage-models": "next",
20
+ "@3sixty/core": "next",
21
+ "@3sixty/data-core": "next",
22
+ "@3sixty/data-json-ld": "next",
23
+ "@3sixty/nameof": "next",
24
+ "@3sixty/standards-schema-org": "next",
25
+ "@3sixty/standards-unece": "next",
26
+ "@3sixty/telemetry-models": "next",
27
+ "@3sixty/web": "next"
28
+ },
29
+ "main": "./dist/es/index.js",
30
+ "types": "./dist/types/index.d.ts",
31
+ "exports": {
32
+ ".": {
33
+ "types": "./dist/types/index.d.ts",
34
+ "import": "./dist/es/index.js",
35
+ "default": "./dist/es/index.js"
36
+ },
37
+ "./locales/*.json": "./locales/*.json"
38
+ },
39
+ "files": [
40
+ "dist/es",
41
+ "dist/types",
42
+ "locales",
43
+ "docs"
44
+ ],
45
+ "keywords": [
46
+ "twin",
47
+ "trade",
48
+ "iota",
49
+ "framework",
50
+ "blockchain",
51
+ "document-management",
52
+ "documents",
53
+ "management",
54
+ "storage",
55
+ "rest-api",
56
+ "models",
57
+ "types",
58
+ "schemas"
59
+ ],
60
+ "bugs": {
61
+ "url": "git+https://github.com/3sixtyglobal/document-management/issues"
62
+ },
63
+ "homepage": "https://3sixty.global"
64
+ }