document-model 1.0.0

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 (163) hide show
  1. package/LICENSE +661 -0
  2. package/README.md +197 -0
  3. package/dist/browser/document-model.cjs +1 -0
  4. package/dist/browser/document-model.d.ts +1 -0
  5. package/dist/browser/document-model.js +17 -0
  6. package/dist/browser/document.cjs +1 -0
  7. package/dist/browser/document.d.ts +1 -0
  8. package/dist/browser/document.js +15 -0
  9. package/dist/browser/index-1aa6b70c.js +1 -0
  10. package/dist/browser/index-47a38d27.mjs +1776 -0
  11. package/dist/browser/index-71473ecd.js +22 -0
  12. package/dist/browser/index-ede882c4.mjs +29 -0
  13. package/dist/browser/index.cjs +1 -0
  14. package/dist/browser/index.d.ts +3 -0
  15. package/dist/browser/index.js +18 -0
  16. package/dist/browser/object-38724dbb.js +1 -0
  17. package/dist/browser/object-916a56cd.mjs +641 -0
  18. package/dist/browser/src/document/actions/creators.d.ts +46 -0
  19. package/dist/browser/src/document/actions/index.d.ts +10 -0
  20. package/dist/browser/src/document/actions/types.d.ts +9 -0
  21. package/dist/browser/src/document/index.d.ts +5 -0
  22. package/dist/browser/src/document/object.d.ts +118 -0
  23. package/dist/browser/src/document/reducer.d.ts +15 -0
  24. package/dist/browser/src/document/schema/index.d.ts +2 -0
  25. package/dist/browser/src/document/schema/types.d.ts +168 -0
  26. package/dist/browser/src/document/schema/zod.d.ts +72 -0
  27. package/dist/browser/src/document/types.d.ts +154 -0
  28. package/dist/browser/src/document/utils/base.d.ts +55 -0
  29. package/dist/browser/src/document/utils/file.d.ts +47 -0
  30. package/dist/browser/src/document/utils/index.d.ts +2 -0
  31. package/dist/browser/src/document/utils/node.d.ts +9 -0
  32. package/dist/browser/src/document-model/custom/reducers/header.d.ts +2 -0
  33. package/dist/browser/src/document-model/custom/reducers/module.d.ts +2 -0
  34. package/dist/browser/src/document-model/custom/reducers/operation-error.d.ts +2 -0
  35. package/dist/browser/src/document-model/custom/reducers/operation-example.d.ts +2 -0
  36. package/dist/browser/src/document-model/custom/reducers/operation.d.ts +2 -0
  37. package/dist/browser/src/document-model/custom/reducers/state.d.ts +2 -0
  38. package/dist/browser/src/document-model/custom/reducers/versioning.d.ts +7 -0
  39. package/dist/browser/src/document-model/custom/utils.d.ts +1 -0
  40. package/dist/browser/src/document-model/gen/actions.d.ts +15 -0
  41. package/dist/browser/src/document-model/gen/creators.d.ts +7 -0
  42. package/dist/browser/src/document-model/gen/document-model.d.ts +2 -0
  43. package/dist/browser/src/document-model/gen/header/actions.d.ts +9 -0
  44. package/dist/browser/src/document-model/gen/header/creators.d.ts +8 -0
  45. package/dist/browser/src/document-model/gen/header/object.d.ts +11 -0
  46. package/dist/browser/src/document-model/gen/header/operations.d.ts +10 -0
  47. package/dist/browser/src/document-model/gen/index.d.ts +5 -0
  48. package/dist/browser/src/document-model/gen/module/actions.d.ts +8 -0
  49. package/dist/browser/src/document-model/gen/module/creators.d.ts +7 -0
  50. package/dist/browser/src/document-model/gen/module/object.d.ts +10 -0
  51. package/dist/browser/src/document-model/gen/module/operations.d.ts +9 -0
  52. package/dist/browser/src/document-model/gen/object.d.ts +28 -0
  53. package/dist/browser/src/document-model/gen/operation/actions.d.ts +12 -0
  54. package/dist/browser/src/document-model/gen/operation/creators.d.ts +11 -0
  55. package/dist/browser/src/document-model/gen/operation/object.d.ts +14 -0
  56. package/dist/browser/src/document-model/gen/operation/operations.d.ts +13 -0
  57. package/dist/browser/src/document-model/gen/operation-error/actions.d.ts +10 -0
  58. package/dist/browser/src/document-model/gen/operation-error/creators.d.ts +9 -0
  59. package/dist/browser/src/document-model/gen/operation-error/object.d.ts +12 -0
  60. package/dist/browser/src/document-model/gen/operation-error/operations.d.ts +11 -0
  61. package/dist/browser/src/document-model/gen/operation-example/actions.d.ts +7 -0
  62. package/dist/browser/src/document-model/gen/operation-example/creators.d.ts +6 -0
  63. package/dist/browser/src/document-model/gen/operation-example/object.d.ts +9 -0
  64. package/dist/browser/src/document-model/gen/operation-example/operations.d.ts +8 -0
  65. package/dist/browser/src/document-model/gen/reducer.d.ts +3 -0
  66. package/dist/browser/src/document-model/gen/schema/index.d.ts +2 -0
  67. package/dist/browser/src/document-model/gen/schema/types.d.ts +435 -0
  68. package/dist/browser/src/document-model/gen/schema/zod.d.ts +428 -0
  69. package/dist/browser/src/document-model/gen/state/actions.d.ts +9 -0
  70. package/dist/browser/src/document-model/gen/state/creators.d.ts +8 -0
  71. package/dist/browser/src/document-model/gen/state/object.d.ts +11 -0
  72. package/dist/browser/src/document-model/gen/state/operations.d.ts +10 -0
  73. package/dist/browser/src/document-model/gen/types.d.ts +8 -0
  74. package/dist/browser/src/document-model/gen/utils.d.ts +4 -0
  75. package/dist/browser/src/document-model/gen/versioning/actions.d.ts +8 -0
  76. package/dist/browser/src/document-model/gen/versioning/creators.d.ts +7 -0
  77. package/dist/browser/src/document-model/gen/versioning/object.d.ts +10 -0
  78. package/dist/browser/src/document-model/gen/versioning/operations.d.ts +9 -0
  79. package/dist/browser/src/document-model/index.d.ts +73 -0
  80. package/dist/browser/src/index.d.ts +25 -0
  81. package/dist/browser/src/index.doc.d.ts +20 -0
  82. package/dist/browser/vite.config.d.ts +2 -0
  83. package/dist/node/document-model.cjs +1 -0
  84. package/dist/node/document-model.d.ts +1 -0
  85. package/dist/node/document-model.js +20 -0
  86. package/dist/node/document.cjs +1 -0
  87. package/dist/node/document.d.ts +1 -0
  88. package/dist/node/document.js +18 -0
  89. package/dist/node/index-03f82dde.mjs +29 -0
  90. package/dist/node/index-0b695055.js +1 -0
  91. package/dist/node/index-78a1221c.mjs +1779 -0
  92. package/dist/node/index-fbaffded.js +22 -0
  93. package/dist/node/index.cjs +1 -0
  94. package/dist/node/index.d.ts +3 -0
  95. package/dist/node/index.js +21 -0
  96. package/dist/node/object-b1510be8.js +1 -0
  97. package/dist/node/object-bdb7f8c6.mjs +654 -0
  98. package/dist/node/src/document/actions/creators.d.ts +46 -0
  99. package/dist/node/src/document/actions/index.d.ts +10 -0
  100. package/dist/node/src/document/actions/types.d.ts +9 -0
  101. package/dist/node/src/document/index.d.ts +5 -0
  102. package/dist/node/src/document/object.d.ts +118 -0
  103. package/dist/node/src/document/reducer.d.ts +15 -0
  104. package/dist/node/src/document/schema/index.d.ts +2 -0
  105. package/dist/node/src/document/schema/types.d.ts +168 -0
  106. package/dist/node/src/document/schema/zod.d.ts +72 -0
  107. package/dist/node/src/document/types.d.ts +154 -0
  108. package/dist/node/src/document/utils/base.d.ts +55 -0
  109. package/dist/node/src/document/utils/file.d.ts +47 -0
  110. package/dist/node/src/document/utils/index.d.ts +2 -0
  111. package/dist/node/src/document/utils/node.d.ts +9 -0
  112. package/dist/node/src/document-model/custom/reducers/header.d.ts +2 -0
  113. package/dist/node/src/document-model/custom/reducers/module.d.ts +2 -0
  114. package/dist/node/src/document-model/custom/reducers/operation-error.d.ts +2 -0
  115. package/dist/node/src/document-model/custom/reducers/operation-example.d.ts +2 -0
  116. package/dist/node/src/document-model/custom/reducers/operation.d.ts +2 -0
  117. package/dist/node/src/document-model/custom/reducers/state.d.ts +2 -0
  118. package/dist/node/src/document-model/custom/reducers/versioning.d.ts +7 -0
  119. package/dist/node/src/document-model/custom/utils.d.ts +1 -0
  120. package/dist/node/src/document-model/gen/actions.d.ts +15 -0
  121. package/dist/node/src/document-model/gen/creators.d.ts +7 -0
  122. package/dist/node/src/document-model/gen/document-model.d.ts +2 -0
  123. package/dist/node/src/document-model/gen/header/actions.d.ts +9 -0
  124. package/dist/node/src/document-model/gen/header/creators.d.ts +8 -0
  125. package/dist/node/src/document-model/gen/header/object.d.ts +11 -0
  126. package/dist/node/src/document-model/gen/header/operations.d.ts +10 -0
  127. package/dist/node/src/document-model/gen/index.d.ts +5 -0
  128. package/dist/node/src/document-model/gen/module/actions.d.ts +8 -0
  129. package/dist/node/src/document-model/gen/module/creators.d.ts +7 -0
  130. package/dist/node/src/document-model/gen/module/object.d.ts +10 -0
  131. package/dist/node/src/document-model/gen/module/operations.d.ts +9 -0
  132. package/dist/node/src/document-model/gen/object.d.ts +28 -0
  133. package/dist/node/src/document-model/gen/operation/actions.d.ts +12 -0
  134. package/dist/node/src/document-model/gen/operation/creators.d.ts +11 -0
  135. package/dist/node/src/document-model/gen/operation/object.d.ts +14 -0
  136. package/dist/node/src/document-model/gen/operation/operations.d.ts +13 -0
  137. package/dist/node/src/document-model/gen/operation-error/actions.d.ts +10 -0
  138. package/dist/node/src/document-model/gen/operation-error/creators.d.ts +9 -0
  139. package/dist/node/src/document-model/gen/operation-error/object.d.ts +12 -0
  140. package/dist/node/src/document-model/gen/operation-error/operations.d.ts +11 -0
  141. package/dist/node/src/document-model/gen/operation-example/actions.d.ts +7 -0
  142. package/dist/node/src/document-model/gen/operation-example/creators.d.ts +6 -0
  143. package/dist/node/src/document-model/gen/operation-example/object.d.ts +9 -0
  144. package/dist/node/src/document-model/gen/operation-example/operations.d.ts +8 -0
  145. package/dist/node/src/document-model/gen/reducer.d.ts +3 -0
  146. package/dist/node/src/document-model/gen/schema/index.d.ts +2 -0
  147. package/dist/node/src/document-model/gen/schema/types.d.ts +435 -0
  148. package/dist/node/src/document-model/gen/schema/zod.d.ts +428 -0
  149. package/dist/node/src/document-model/gen/state/actions.d.ts +9 -0
  150. package/dist/node/src/document-model/gen/state/creators.d.ts +8 -0
  151. package/dist/node/src/document-model/gen/state/object.d.ts +11 -0
  152. package/dist/node/src/document-model/gen/state/operations.d.ts +10 -0
  153. package/dist/node/src/document-model/gen/types.d.ts +8 -0
  154. package/dist/node/src/document-model/gen/utils.d.ts +4 -0
  155. package/dist/node/src/document-model/gen/versioning/actions.d.ts +8 -0
  156. package/dist/node/src/document-model/gen/versioning/creators.d.ts +7 -0
  157. package/dist/node/src/document-model/gen/versioning/object.d.ts +10 -0
  158. package/dist/node/src/document-model/gen/versioning/operations.d.ts +9 -0
  159. package/dist/node/src/document-model/index.d.ts +73 -0
  160. package/dist/node/src/index.d.ts +25 -0
  161. package/dist/node/src/index.doc.d.ts +20 -0
  162. package/dist/node/vite.config.d.ts +2 -0
  163. package/package.json +89 -0
@@ -0,0 +1,20 @@
1
+ import * as Document from './document';
2
+ import * as DocumentModel from './document-model';
3
+ /**
4
+ * This module exports all the public types, functions, and objects
5
+ * from the document module. It provides an easy-to-use interface
6
+ * for managing documents, and can be used in any Redux-based
7
+ * application. This module exports:
8
+ * - All action creators for the base document actions.
9
+ * - The Document object, which is used to for creating and
10
+ * manipulating documents in an object-oriented way.
11
+ * - The baseReducer function, which is a reducer for managing
12
+ * documents
13
+ * - Various utility functions to be used by Document Models.
14
+ */
15
+ export { Document, DocumentModel };
16
+ declare const _default: {
17
+ Document: typeof Document;
18
+ DocumentModel: typeof DocumentModel;
19
+ };
20
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("vite").UserConfigFnObject;
2
+ export default _default;
package/package.json ADDED
@@ -0,0 +1,89 @@
1
+ {
2
+ "name": "document-model",
3
+ "version": "1.0.0",
4
+ "license": "AGPL-3.0-only",
5
+ "private": false,
6
+ "files": [
7
+ "dist"
8
+ ],
9
+ "types": "dist/node/index.d.ts",
10
+ "main": "dist/node/index.cjs",
11
+ "module": "dist/node/index.js",
12
+ "scripts": {
13
+ "lint": "eslint --ext .js,.ts . && tsc --noemit --project tsconfig.spec.json",
14
+ "format": "prettier --ignore-path .gitignore --write \"**/*.+(js|ts|json)\"",
15
+ "build": "yarn build:browser && yarn build:node",
16
+ "build:browser": "vite build --mode browser",
17
+ "build:node": "vite build --mode node",
18
+ "test": "jest"
19
+ },
20
+ "exports": {
21
+ ".": {
22
+ "import": "./dist/node/index.js",
23
+ "require": "./dist/node/index.cjs"
24
+ },
25
+ "./browser": {
26
+ "import": "./dist/browser/index.js",
27
+ "require": "./dist/browser/index.cjs"
28
+ },
29
+ "./document": {
30
+ "import": "./dist/node/document.js",
31
+ "require": "./dist/node/document.cjs"
32
+ },
33
+ "./browser/document": {
34
+ "import": "./dist/browser/document.js",
35
+ "require": "./dist/browser/document.cjs"
36
+ },
37
+ "./document-model": {
38
+ "import": "./dist/node/document-model.js",
39
+ "require": "./dist/node/document-model.cjs"
40
+ },
41
+ "./browser/document-model": {
42
+ "import": "./dist/node/document-model.js",
43
+ "require": "./dist/node/document-model.cjs"
44
+ }
45
+ },
46
+ "typesVersions": {
47
+ "*": {
48
+ "document": [
49
+ "dist/node/document"
50
+ ],
51
+ "browser/document": [
52
+ "dist/browser/document"
53
+ ],
54
+ "document-model": [
55
+ "dist/node/document-model"
56
+ ],
57
+ "browser/document-model": [
58
+ "dist/browser/document-model"
59
+ ]
60
+ }
61
+ },
62
+ "devDependencies": {
63
+ "@rollup/plugin-node-resolve": "^15.2.1",
64
+ "@types/jest": "^29.5.4",
65
+ "@types/mime": "^3.0.1",
66
+ "@typescript-eslint/eslint-plugin": "^6.4.1",
67
+ "@typescript-eslint/parser": "^6.4.1",
68
+ "eslint": "^8.48.0",
69
+ "eslint-config-prettier": "^9.0.0",
70
+ "jest": "^29.6.4",
71
+ "prettier": "^3.0.2",
72
+ "prettier-plugin-organize-imports": "^3.2.3",
73
+ "rollup-plugin-polyfill-node": "^0.12.0",
74
+ "ts-jest": "^29.1.1",
75
+ "ts-node": "^10.9.1",
76
+ "typescript": "^5.2.2",
77
+ "vite": "^4.4.9",
78
+ "vite-plugin-dts": "^3.5.2",
79
+ "vite-plugin-node-polyfills": "^0.11.3"
80
+ },
81
+ "dependencies": {
82
+ "immer": "^10.0.2",
83
+ "json-stringify-deterministic": "^1.0.10",
84
+ "jszip": "^3.10.1",
85
+ "mime": "^3.0.0",
86
+ "sha.js": "^2.4.11",
87
+ "zod": "^3.22.2"
88
+ }
89
+ }