tsondb 0.3.0 → 0.4.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 (205) hide show
  1. package/LICENSE +385 -0
  2. package/README.md +173 -1
  3. package/lib/bin/tsondb.d.ts +8 -0
  4. package/lib/bin/tsondb.js +83 -0
  5. package/lib/index.d.ts +2 -1
  6. package/lib/index.js +1 -1
  7. package/lib/{Schema.d.ts → node/Schema.d.ts} +2 -2
  8. package/lib/{Schema.js → node/Schema.js} +1 -1
  9. package/lib/node/index.d.ts +8 -0
  10. package/lib/node/index.js +62 -0
  11. package/lib/{renderers → node/renderers}/Output.d.ts +1 -1
  12. package/lib/{renderers → node/renderers}/jsonschema/index.d.ts +2 -2
  13. package/lib/{renderers → node/renderers}/jsonschema/index.js +2 -2
  14. package/lib/{renderers → node/renderers}/jsonschema/render.d.ts +1 -1
  15. package/lib/{renderers → node/renderers}/jsonschema/render.js +9 -9
  16. package/lib/{renderers → node/renderers}/ts/index.d.ts +2 -2
  17. package/lib/{renderers → node/renderers}/ts/index.js +2 -2
  18. package/lib/{renderers → node/renderers}/ts/render.d.ts +1 -1
  19. package/lib/{renderers → node/renderers}/ts/render.js +9 -8
  20. package/lib/{schema → node/schema}/Node.d.ts +4 -4
  21. package/lib/{schema → node/schema}/Node.js +5 -5
  22. package/lib/{schema/parameters → node/schema}/TypeParameter.d.ts +3 -2
  23. package/lib/{schema/parameters → node/schema}/TypeParameter.js +2 -2
  24. package/lib/{schema → node/schema}/declarations/Declaration.d.ts +10 -11
  25. package/lib/{schema → node/schema}/declarations/Declaration.js +7 -5
  26. package/lib/{schema → node/schema}/declarations/EntityDecl.d.ts +10 -9
  27. package/lib/{schema → node/schema}/declarations/EntityDecl.js +2 -2
  28. package/lib/{schema → node/schema}/declarations/EnumDecl.d.ts +9 -7
  29. package/lib/{schema → node/schema}/declarations/EnumDecl.js +3 -3
  30. package/lib/{schema → node/schema}/declarations/TypeAliasDecl.d.ts +8 -7
  31. package/lib/{schema → node/schema}/declarations/TypeAliasDecl.js +3 -3
  32. package/lib/{schema → node/schema}/index.d.ts +4 -4
  33. package/lib/{schema → node/schema}/index.js +3 -4
  34. package/lib/node/schema/types/Type.d.ts +48 -0
  35. package/lib/{schema → node/schema}/types/Type.js +41 -25
  36. package/lib/{schema → node/schema}/types/generic/ArrayType.d.ts +5 -4
  37. package/lib/{schema → node/schema}/types/generic/ArrayType.js +3 -3
  38. package/lib/{schema → node/schema}/types/generic/EnumType.d.ts +5 -4
  39. package/lib/{schema → node/schema}/types/generic/EnumType.js +4 -2
  40. package/lib/{schema → node/schema}/types/generic/ObjectType.d.ts +8 -7
  41. package/lib/{schema → node/schema}/types/generic/ObjectType.js +8 -4
  42. package/lib/{schema → node/schema}/types/primitives/BooleanType.d.ts +4 -3
  43. package/lib/{schema → node/schema}/types/primitives/DateType.d.ts +5 -4
  44. package/lib/{schema → node/schema}/types/primitives/DateType.js +1 -1
  45. package/lib/{schema → node/schema}/types/primitives/FloatType.d.ts +5 -4
  46. package/lib/{schema → node/schema}/types/primitives/FloatType.js +1 -1
  47. package/lib/{schema → node/schema}/types/primitives/IntegerType.d.ts +5 -4
  48. package/lib/{schema → node/schema}/types/primitives/IntegerType.js +1 -1
  49. package/lib/{schema → node/schema}/types/primitives/NumericType.d.ts +2 -2
  50. package/lib/node/schema/types/primitives/PrimitiveType.d.ts +6 -0
  51. package/lib/{schema → node/schema}/types/primitives/StringType.d.ts +5 -4
  52. package/lib/{schema → node/schema}/types/primitives/StringType.js +1 -1
  53. package/lib/{schema → node/schema}/types/references/IncludeIdentifierType.d.ts +9 -8
  54. package/lib/{schema → node/schema}/types/references/IncludeIdentifierType.js +1 -1
  55. package/lib/{schema → node/schema}/types/references/NestedEntityMapType.d.ts +10 -9
  56. package/lib/{schema → node/schema}/types/references/NestedEntityMapType.js +4 -4
  57. package/lib/{schema → node/schema}/types/references/ReferenceIdentifierType.d.ts +7 -6
  58. package/lib/{schema → node/schema}/types/references/ReferenceIdentifierType.js +1 -1
  59. package/lib/node/schema/types/references/TypeArgumentType.d.ts +23 -0
  60. package/lib/node/schema/types/references/TypeArgumentType.js +19 -0
  61. package/lib/node/schema/validation/type.d.ts +4 -0
  62. package/lib/{server → node/server}/api/declarations.js +1 -1
  63. package/lib/{server → node/server}/api/git.js +14 -10
  64. package/lib/{server → node/server}/api/instanceOperations.d.ts +3 -3
  65. package/lib/{server → node/server}/api/instanceOperations.js +13 -4
  66. package/lib/{server → node/server}/api/instances.js +7 -3
  67. package/lib/node/server/index.d.ts +28 -0
  68. package/lib/{server → node/server}/index.js +6 -6
  69. package/lib/node/server/init.d.ts +5 -0
  70. package/lib/{server → node/server}/init.js +8 -8
  71. package/lib/{utils → node/utils}/error.js +4 -1
  72. package/lib/{utils → node/utils}/git.d.ts +2 -2
  73. package/lib/{utils → node/utils}/instances.d.ts +3 -3
  74. package/lib/{utils → node/utils}/instances.js +8 -6
  75. package/lib/{utils → node/utils}/references.d.ts +2 -2
  76. package/lib/{utils → node/utils}/references.js +3 -3
  77. package/lib/{utils → node/utils}/render.js +1 -1
  78. package/lib/shared/api.d.ts +8 -2
  79. package/lib/shared/utils/array.js +12 -9
  80. package/lib/shared/utils/displayName.d.ts +1 -1
  81. package/lib/shared/utils/displayName.js +4 -2
  82. package/lib/shared/utils/instances.d.ts +2 -2
  83. package/lib/{utils → shared/utils}/lazy.js +1 -1
  84. package/lib/shared/utils/markdown.js +6 -6
  85. package/lib/shared/utils/object.d.ts +3 -0
  86. package/lib/shared/utils/object.js +1 -0
  87. package/lib/{utils → shared/utils}/result.js +2 -2
  88. package/lib/shared/utils/string.js +7 -4
  89. package/lib/shared/utils/validation.js +3 -2
  90. package/lib/shared/validation/number.js +3 -3
  91. package/lib/shared/validation/object.js +4 -3
  92. package/lib/shared/validation/string.js +12 -7
  93. package/lib/{client → web}/api.d.ts +2 -2
  94. package/lib/{client → web}/api.js +4 -2
  95. package/lib/web/components/Git.d.ts +2 -0
  96. package/lib/{client → web}/components/Git.js +58 -14
  97. package/lib/{client → web}/components/Layout.d.ts +1 -1
  98. package/lib/{client → web}/components/Layout.js +1 -1
  99. package/lib/web/components/Select.d.ts +3 -0
  100. package/lib/web/components/Select.js +5 -0
  101. package/lib/web/components/typeInputs/ArrayTypeInput.d.ts +13 -0
  102. package/lib/{client → web}/components/typeInputs/ArrayTypeInput.js +7 -1
  103. package/lib/{client → web}/components/typeInputs/BooleanTypeInput.d.ts +2 -2
  104. package/lib/{client → web}/components/typeInputs/DateTypeInput.d.ts +2 -2
  105. package/lib/web/components/typeInputs/EnumTypeInput.d.ts +13 -0
  106. package/lib/{client → web}/components/typeInputs/EnumTypeInput.js +1 -1
  107. package/lib/{client → web}/components/typeInputs/FloatTypeInput.d.ts +2 -2
  108. package/lib/web/components/typeInputs/GenericTypeArgumentIdentifierTypeInput.d.ts +7 -0
  109. package/lib/{client → web}/components/typeInputs/GenericTypeArgumentIdentifierTypeInput.js +1 -1
  110. package/lib/web/components/typeInputs/IncludeIdentifierTypeInput.d.ts +13 -0
  111. package/lib/{client → web}/components/typeInputs/IntegerTypeInput.d.ts +2 -2
  112. package/lib/web/components/typeInputs/NestedEntityMapTypeInput.d.ts +13 -0
  113. package/lib/{client → web}/components/typeInputs/NestedEntityMapTypeInput.js +7 -2
  114. package/lib/{client → web}/components/typeInputs/ObjectTypeInput.d.ts +4 -4
  115. package/lib/{client → web}/components/typeInputs/ObjectTypeInput.js +4 -1
  116. package/lib/{client → web}/components/typeInputs/ReferenceIdentifierTypeInput.d.ts +3 -3
  117. package/lib/web/components/typeInputs/ReferenceIdentifierTypeInput.js +11 -0
  118. package/lib/{client → web}/components/typeInputs/StringTypeInput.d.ts +2 -2
  119. package/lib/web/components/typeInputs/TypeInput.d.ts +13 -0
  120. package/lib/{client → web}/components/typeInputs/TypeInput.js +3 -3
  121. package/lib/{client → web}/components/typeInputs/utils/Markdown.d.ts +1 -1
  122. package/lib/{client → web}/components/typeInputs/utils/Markdown.js +2 -2
  123. package/lib/{client → web}/components/typeInputs/utils/MismatchingTypeError.d.ts +1 -1
  124. package/lib/{client → web}/components/typeInputs/utils/ValidationErrors.d.ts +1 -1
  125. package/lib/web/hooks/useAPIResource.d.ts +1 -0
  126. package/lib/{client → web}/hooks/useEntityFromRoute.d.ts +1 -1
  127. package/lib/{client → web}/hooks/useEntityFromRoute.js +1 -1
  128. package/lib/{client → web}/hooks/useInstanceNamesByEntity.d.ts +1 -1
  129. package/lib/{client → web}/hooks/useInstanceNamesByEntity.js +8 -6
  130. package/lib/web/hooks/useMappedAPIResource.d.ts +1 -0
  131. package/lib/{client → web}/hooks/useMappedAPIResource.js +7 -9
  132. package/lib/{client → web}/hooks/useSecondaryDeclarations.d.ts +1 -1
  133. package/lib/{client → web}/hooks/useSecondaryDeclarations.js +4 -2
  134. package/lib/{client → web}/routes/CreateInstance.d.ts +1 -1
  135. package/lib/{client → web}/routes/CreateInstance.js +4 -2
  136. package/lib/web/routes/Entity.d.ts +2 -0
  137. package/lib/{client → web}/routes/Entity.js +5 -3
  138. package/lib/web/routes/Home.d.ts +2 -0
  139. package/lib/{client → web}/routes/Instance.d.ts +1 -1
  140. package/lib/{client → web}/routes/Instance.js +14 -8
  141. package/lib/{client → web}/routes/NotFound.d.ts +1 -1
  142. package/lib/web/utils/typeSkeleton.d.ts +3 -0
  143. package/lib/{client → web}/utils/typeSkeleton.js +4 -1
  144. package/package.json +31 -18
  145. package/lib/ModelContainer.d.ts +0 -17
  146. package/lib/ModelContainer.js +0 -65
  147. package/lib/client/components/Git.d.ts +0 -2
  148. package/lib/client/components/Select.d.ts +0 -3
  149. package/lib/client/components/Select.js +0 -2
  150. package/lib/client/components/typeInputs/ArrayTypeInput.d.ts +0 -13
  151. package/lib/client/components/typeInputs/EnumTypeInput.d.ts +0 -13
  152. package/lib/client/components/typeInputs/GenericTypeArgumentIdentifierTypeInput.d.ts +0 -7
  153. package/lib/client/components/typeInputs/IncludeIdentifierTypeInput.d.ts +0 -13
  154. package/lib/client/components/typeInputs/NestedEntityMapTypeInput.d.ts +0 -13
  155. package/lib/client/components/typeInputs/ReferenceIdentifierTypeInput.js +0 -9
  156. package/lib/client/components/typeInputs/TypeInput.d.ts +0 -13
  157. package/lib/client/hooks/useAPIResource.d.ts +0 -1
  158. package/lib/client/hooks/useMappedAPIResource.d.ts +0 -1
  159. package/lib/client/routes/Entity.d.ts +0 -2
  160. package/lib/client/routes/Home.d.ts +0 -2
  161. package/lib/client/utils/typeSkeleton.d.ts +0 -3
  162. package/lib/schema/types/Type.d.ts +0 -48
  163. package/lib/schema/types/primitives/PrimitiveType.d.ts +0 -6
  164. package/lib/schema/types/references/GenericArgumentIdentifierType.d.ts +0 -22
  165. package/lib/schema/types/references/GenericArgumentIdentifierType.js +0 -19
  166. package/lib/schema/validation/type.d.ts +0 -4
  167. package/lib/server/index.d.ts +0 -29
  168. package/lib/server/init.d.ts +0 -5
  169. package/lib/tsconfig.tsbuildinfo +0 -1
  170. package/lib/utils/object.d.ts +0 -3
  171. package/lib/utils/object.js +0 -1
  172. /package/lib/{renderers → node/renderers}/Output.js +0 -0
  173. /package/lib/{schema → node/schema}/types/primitives/BooleanType.js +0 -0
  174. /package/lib/{schema → node/schema}/types/primitives/NumericType.js +0 -0
  175. /package/lib/{schema → node/schema}/types/primitives/PrimitiveType.js +0 -0
  176. /package/lib/{schema → node/schema}/validation/options.d.ts +0 -0
  177. /package/lib/{schema → node/schema}/validation/options.js +0 -0
  178. /package/lib/{schema → node/schema}/validation/type.js +0 -0
  179. /package/lib/{server → node/server}/api/declarations.d.ts +0 -0
  180. /package/lib/{server → node/server}/api/git.d.ts +0 -0
  181. /package/lib/{server → node/server}/api/index.d.ts +0 -0
  182. /package/lib/{server → node/server}/api/index.js +0 -0
  183. /package/lib/{server → node/server}/api/instances.d.ts +0 -0
  184. /package/lib/{utils → node/utils}/error.d.ts +0 -0
  185. /package/lib/{utils → node/utils}/git.js +0 -0
  186. /package/lib/{utils → node/utils}/path.d.ts +0 -0
  187. /package/lib/{utils → node/utils}/path.js +0 -0
  188. /package/lib/{utils → node/utils}/render.d.ts +0 -0
  189. /package/lib/{utils → shared/utils}/enum.d.ts +0 -0
  190. /package/lib/{utils → shared/utils}/enum.js +0 -0
  191. /package/lib/{utils → shared/utils}/lazy.d.ts +0 -0
  192. /package/lib/{utils → shared/utils}/result.d.ts +0 -0
  193. /package/lib/{client → web}/components/typeInputs/BooleanTypeInput.js +0 -0
  194. /package/lib/{client → web}/components/typeInputs/DateTypeInput.js +0 -0
  195. /package/lib/{client → web}/components/typeInputs/FloatTypeInput.js +0 -0
  196. /package/lib/{client → web}/components/typeInputs/IncludeIdentifierTypeInput.js +0 -0
  197. /package/lib/{client → web}/components/typeInputs/IntegerTypeInput.js +0 -0
  198. /package/lib/{client → web}/components/typeInputs/StringTypeInput.js +0 -0
  199. /package/lib/{client → web}/components/typeInputs/utils/MismatchingTypeError.js +0 -0
  200. /package/lib/{client → web}/components/typeInputs/utils/ValidationErrors.js +0 -0
  201. /package/lib/{client → web}/hooks/useAPIResource.js +0 -0
  202. /package/lib/{client → web}/index.d.ts +0 -0
  203. /package/lib/{client → web}/index.js +0 -0
  204. /package/lib/{client → web}/routes/Home.js +0 -0
  205. /package/lib/{client → web}/routes/NotFound.js +0 -0
package/LICENSE ADDED
@@ -0,0 +1,385 @@
1
+ Mozilla Public License Version 2.0
2
+ ==================================
3
+
4
+ 1. Definitions
5
+
6
+ --------------
7
+
8
+ 1.1. "Contributor"
9
+ means each individual or legal entity that creates, contributes to
10
+ the creation of, or owns Covered Software.
11
+
12
+ 1.2. "Contributor Version"
13
+ means the combination of the Contributions of others (if any) used
14
+ by a Contributor and that particular Contributor's Contribution.
15
+
16
+ 1.3. "Contribution"
17
+ means Covered Software of a particular Contributor.
18
+
19
+ 1.4. "Covered Software"
20
+ means Source Code Form to which the initial Contributor has attached
21
+ the notice in Exhibit A, the Executable Form of such Source Code
22
+ Form, and Modifications of such Source Code Form, in each case
23
+ including portions thereof.
24
+
25
+ 1.5. "Incompatible With Secondary Licenses"
26
+ means
27
+
28
+ (a) that the initial Contributor has attached the notice described
29
+ in Exhibit B to the Covered Software; or
30
+
31
+ (b) that the Covered Software was made available under the terms of
32
+ version 1.1 or earlier of the License, but not also under the
33
+ terms of a Secondary License.
34
+
35
+ 1.6. "Executable Form"
36
+ means any form of the work other than Source Code Form.
37
+
38
+ 1.7. "Larger Work"
39
+ means a work that combines Covered Software with other material, in
40
+ a separate file or files, that is not Covered Software.
41
+
42
+ 1.8. "License"
43
+ means this document.
44
+
45
+ 1.9. "Licensable"
46
+ means having the right to grant, to the maximum extent possible,
47
+ whether at the time of the initial grant or subsequently, any and
48
+ all of the rights conveyed by this License.
49
+
50
+ 1.10. "Modifications"
51
+ means any of the following:
52
+
53
+ (a) any file in Source Code Form that results from an addition to,
54
+ deletion from, or modification of the contents of Covered
55
+ Software; or
56
+
57
+ (b) any new file in Source Code Form that contains any Covered
58
+ Software.
59
+
60
+ 1.11. "Patent Claims" of a Contributor
61
+ means any patent claim(s), including without limitation, method,
62
+ process, and apparatus claims, in any patent Licensable by such
63
+ Contributor that would be infringed, but for the grant of the
64
+ License, by the making, using, selling, offering for sale, having
65
+ made, import, or transfer of either its Contributions or its
66
+ Contributor Version.
67
+
68
+ 1.12. "Secondary License"
69
+ means either the GNU General Public License, Version 2.0, the GNU
70
+ Lesser General Public License, Version 2.1, the GNU Affero General
71
+ Public License, Version 3.0, or any later versions of those
72
+ licenses.
73
+
74
+ 1.13. "Source Code Form"
75
+ means the form of the work preferred for making modifications.
76
+
77
+ 1.14. "You" (or "Your")
78
+ means an individual or a legal entity exercising rights under this
79
+ License. For legal entities, "You" includes any entity that
80
+ controls, is controlled by, or is under common control with You. For
81
+ purposes of this definition, "control" means (a) the power, direct
82
+ or indirect, to cause the direction or management of such entity,
83
+ whether by contract or otherwise, or (b) ownership of more than
84
+ fifty percent (50%) of the outstanding shares or beneficial
85
+ ownership of such entity.
86
+
87
+ 2. License Grants and Conditions
88
+
89
+ --------------------------------
90
+
91
+ 2.1. Grants
92
+
93
+ Each Contributor hereby grants You a world-wide, royalty-free,
94
+ non-exclusive license:
95
+
96
+ (a) under intellectual property rights (other than patent or trademark)
97
+ Licensable by such Contributor to use, reproduce, make available,
98
+ modify, display, perform, distribute, and otherwise exploit its
99
+ Contributions, either on an unmodified basis, with Modifications, or
100
+ as part of a Larger Work; and
101
+
102
+ (b) under Patent Claims of such Contributor to make, use, sell, offer
103
+ for sale, have made, import, and otherwise transfer either its
104
+ Contributions or its Contributor Version.
105
+
106
+ 2.2. Effective Date
107
+
108
+ The licenses granted in Section 2.1 with respect to any Contribution
109
+ become effective for each Contribution on the date the Contributor first
110
+ distributes such Contribution.
111
+
112
+ 2.3. Limitations on Grant Scope
113
+
114
+ The licenses granted in this Section 2 are the only rights granted under
115
+ this License. No additional rights or licenses will be implied from the
116
+ distribution or licensing of Covered Software under this License.
117
+ Notwithstanding Section 2.1(b) above, no patent license is granted by a
118
+ Contributor:
119
+
120
+ (a) for any code that a Contributor has removed from Covered Software;
121
+ or
122
+
123
+ (b) for infringements caused by: (i) Your and any other third party's
124
+ modifications of Covered Software, or (ii) the combination of its
125
+ Contributions with other software (except as part of its Contributor
126
+ Version); or
127
+
128
+ (c) under Patent Claims infringed by Covered Software in the absence of
129
+ its Contributions.
130
+
131
+ This License does not grant any rights in the trademarks, service marks,
132
+ or logos of any Contributor (except as may be necessary to comply with
133
+ the notice requirements in Section 3.4).
134
+
135
+ 2.4. Subsequent Licenses
136
+
137
+ No Contributor makes additional grants as a result of Your choice to
138
+ distribute the Covered Software under a subsequent version of this
139
+ License (see Section 10.2) or under the terms of a Secondary License (if
140
+ permitted under the terms of Section 3.3).
141
+
142
+ 2.5. Representation
143
+
144
+ Each Contributor represents that the Contributor believes its
145
+ Contributions are its original creation(s) or it has sufficient rights
146
+ to grant the rights to its Contributions conveyed by this License.
147
+
148
+ 2.6. Fair Use
149
+
150
+ This License is not intended to limit any rights You have under
151
+ applicable copyright doctrines of fair use, fair dealing, or other
152
+ equivalents.
153
+
154
+ 2.7. Conditions
155
+
156
+ Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
157
+ in Section 2.1.
158
+
159
+ 3. Responsibilities
160
+
161
+ -------------------
162
+
163
+ 3.1. Distribution of Source Form
164
+
165
+ All distribution of Covered Software in Source Code Form, including any
166
+ Modifications that You create or to which You contribute, must be under
167
+ the terms of this License. You must inform recipients that the Source
168
+ Code Form of the Covered Software is governed by the terms of this
169
+ License, and how they can obtain a copy of this License. You may not
170
+ attempt to alter or restrict the recipients' rights in the Source Code
171
+ Form.
172
+
173
+ 3.2. Distribution of Executable Form
174
+
175
+ If You distribute Covered Software in Executable Form then:
176
+
177
+ (a) such Covered Software must also be made available in Source Code
178
+ Form, as described in Section 3.1, and You must inform recipients of
179
+ the Executable Form how they can obtain a copy of such Source Code
180
+ Form by reasonable means in a timely manner, at a charge no more
181
+ than the cost of distribution to the recipient; and
182
+
183
+ (b) You may distribute such Executable Form under the terms of this
184
+ License, or sublicense it under different terms, provided that the
185
+ license for the Executable Form does not attempt to limit or alter
186
+ the recipients' rights in the Source Code Form under this License.
187
+
188
+ 3.3. Distribution of a Larger Work
189
+
190
+ You may create and distribute a Larger Work under terms of Your choice,
191
+ provided that You also comply with the requirements of this License for
192
+ the Covered Software. If the Larger Work is a combination of Covered
193
+ Software with a work governed by one or more Secondary Licenses, and the
194
+ Covered Software is not Incompatible With Secondary Licenses, this
195
+ License permits You to additionally distribute such Covered Software
196
+ under the terms of such Secondary License(s), so that the recipient of
197
+ the Larger Work may, at their option, further distribute the Covered
198
+ Software under the terms of either this License or such Secondary
199
+ License(s).
200
+
201
+ 3.4. Notices
202
+
203
+ You may not remove or alter the substance of any license notices
204
+ (including copyright notices, patent notices, disclaimers of warranty,
205
+ or limitations of liability) contained within the Source Code Form of
206
+ the Covered Software, except that You may alter any license notices to
207
+ the extent required to remedy known factual inaccuracies.
208
+
209
+ 3.5. Application of Additional Terms
210
+
211
+ You may choose to offer, and to charge a fee for, warranty, support,
212
+ indemnity or liability obligations to one or more recipients of Covered
213
+ Software. However, You may do so only on Your own behalf, and not on
214
+ behalf of any Contributor. You must make it absolutely clear that any
215
+ such warranty, support, indemnity, or liability obligation is offered by
216
+ You alone, and You hereby agree to indemnify every Contributor for any
217
+ liability incurred by such Contributor as a result of warranty, support,
218
+ indemnity or liability terms You offer. You may include additional
219
+ disclaimers of warranty and limitations of liability specific to any
220
+ jurisdiction.
221
+
222
+ 4. Inability to Comply Due to Statute or Regulation
223
+
224
+ ---------------------------------------------------
225
+
226
+ If it is impossible for You to comply with any of the terms of this
227
+ License with respect to some or all of the Covered Software due to
228
+ statute, judicial order, or regulation then You must: (a) comply with
229
+ the terms of this License to the maximum extent possible; and (b)
230
+ describe the limitations and the code they affect. Such description must
231
+ be placed in a text file included with all distributions of the Covered
232
+ Software under this License. Except to the extent prohibited by statute
233
+ or regulation, such description must be sufficiently detailed for a
234
+ recipient of ordinary skill to be able to understand it.
235
+
236
+ 5. Termination
237
+
238
+ --------------
239
+
240
+ 5.1. The rights granted under this License will terminate automatically
241
+ if You fail to comply with any of its terms. However, if You become
242
+ compliant, then the rights granted under this License from a particular
243
+ Contributor are reinstated (a) provisionally, unless and until such
244
+ Contributor explicitly and finally terminates Your grants, and (b) on an
245
+ ongoing basis, if such Contributor fails to notify You of the
246
+ non-compliance by some reasonable means prior to 60 days after You have
247
+ come back into compliance. Moreover, Your grants from a particular
248
+ Contributor are reinstated on an ongoing basis if such Contributor
249
+ notifies You of the non-compliance by some reasonable means, this is the
250
+ first time You have received notice of non-compliance with this License
251
+ from such Contributor, and You become compliant prior to 30 days after
252
+ Your receipt of the notice.
253
+
254
+ 5.2. If You initiate litigation against any entity by asserting a patent
255
+ infringement claim (excluding declaratory judgment actions,
256
+ counter-claims, and cross-claims) alleging that a Contributor Version
257
+ directly or indirectly infringes any patent, then the rights granted to
258
+ You by any and all Contributors for the Covered Software under Section
259
+ 2.1 of this License shall terminate.
260
+
261
+ 5.3. In the event of termination under Sections 5.1 or 5.2 above, all
262
+ end user license agreements (excluding distributors and resellers) which
263
+ have been validly granted by You or Your distributors under this License
264
+ prior to termination shall survive termination.
265
+
266
+ ************************************************************************
267
+
268
+ * *
269
+ * 6. Disclaimer of Warranty *
270
+ * ------------------------- *
271
+ * *
272
+ * Covered Software is provided under this License on an "as is" *
273
+ * basis, without warranty of any kind, either expressed, implied, or *
274
+ * statutory, including, without limitation, warranties that the *
275
+ * Covered Software is free of defects, merchantable, fit for a *
276
+ * particular purpose or non-infringing. The entire risk as to the *
277
+ * quality and performance of the Covered Software is with You. *
278
+ * Should any Covered Software prove defective in any respect, You *
279
+ * (not any Contributor) assume the cost of any necessary servicing, *
280
+ * repair, or correction. This disclaimer of warranty constitutes an *
281
+ * essential part of this License. No use of any Covered Software is *
282
+ * authorized under this License except under this disclaimer. *
283
+ * *
284
+
285
+ ************************************************************************
286
+
287
+ ************************************************************************
288
+
289
+ * *
290
+ * 7. Limitation of Liability *
291
+ * -------------------------- *
292
+ * *
293
+ * Under no circumstances and under no legal theory, whether tort *
294
+ * (including negligence), contract, or otherwise, shall any *
295
+ * Contributor, or anyone who distributes Covered Software as *
296
+ * permitted above, be liable to You for any direct, indirect, *
297
+ * special, incidental, or consequential damages of any character *
298
+ * including, without limitation, damages for lost profits, loss of *
299
+ * goodwill, work stoppage, computer failure or malfunction, or any *
300
+ * and all other commercial damages or losses, even if such party *
301
+ * shall have been informed of the possibility of such damages. This *
302
+ * limitation of liability shall not apply to liability for death or *
303
+ * personal injury resulting from such party's negligence to the *
304
+ * extent applicable law prohibits such limitation. Some *
305
+ * jurisdictions do not allow the exclusion or limitation of *
306
+ * incidental or consequential damages, so this exclusion and *
307
+ * limitation may not apply to You. *
308
+ * *
309
+
310
+ ************************************************************************
311
+
312
+ 8. Litigation
313
+
314
+ -------------
315
+
316
+ Any litigation relating to this License may be brought only in the
317
+ courts of a jurisdiction where the defendant maintains its principal
318
+ place of business and such litigation shall be governed by laws of that
319
+ jurisdiction, without reference to its conflict-of-law provisions.
320
+ Nothing in this Section shall prevent a party's ability to bring
321
+ cross-claims or counter-claims.
322
+
323
+ 9. Miscellaneous
324
+
325
+ ----------------
326
+
327
+ This License represents the complete agreement concerning the subject
328
+ matter hereof. If any provision of this License is held to be
329
+ unenforceable, such provision shall be reformed only to the extent
330
+ necessary to make it enforceable. Any law or regulation which provides
331
+ that the language of a contract shall be construed against the drafter
332
+ shall not be used to construe this License against a Contributor.
333
+
334
+ 10. Versions of the License
335
+
336
+ ---------------------------
337
+
338
+ 10.1. New Versions
339
+
340
+ Mozilla Foundation is the license steward. Except as provided in Section
341
+ 10.3, no one other than the license steward has the right to modify or
342
+ publish new versions of this License. Each version will be given a
343
+ distinguishing version number.
344
+
345
+ 10.2. Effect of New Versions
346
+
347
+ You may distribute the Covered Software under the terms of the version
348
+ of the License under which You originally received the Covered Software,
349
+ or under the terms of any subsequent version published by the license
350
+ steward.
351
+
352
+ 10.3. Modified Versions
353
+
354
+ If you create software not governed by this License, and you want to
355
+ create a new license for such software, you may create and use a
356
+ modified version of this License if you rename the license and remove
357
+ any references to the name of the license steward (except to note that
358
+ such modified license differs from this License).
359
+
360
+ 10.4. Distributing Source Code Form that is Incompatible With Secondary
361
+ Licenses
362
+
363
+ If You choose to distribute Source Code Form that is Incompatible With
364
+ Secondary Licenses under the terms of this version of the License, the
365
+ notice described in Exhibit B of this License must be attached.
366
+
367
+ Exhibit A - Source Code Form License Notice
368
+ -------------------------------------------
369
+
370
+ This Source Code Form is subject to the terms of the Mozilla Public
371
+ License, v. 2.0. If a copy of the MPL was not distributed with this
372
+ file, You can obtain one at <https://mozilla.org/MPL/2.0/>.
373
+
374
+ If it is not possible or desirable to put the notice in a particular
375
+ file, then You may include the notice in a location (such as a LICENSE
376
+ file in a relevant directory) where a recipient would be likely to look
377
+ for such a notice.
378
+
379
+ You may add additional accurate notices of copyright ownership.
380
+
381
+ Exhibit B - "Incompatible With Secondary Licenses" Notice
382
+ ---------------------------------------------------------
383
+
384
+ This Source Code Form is "Incompatible With Secondary Licenses", as
385
+ defined by the Mozilla Public License, v. 2.0.
package/README.md CHANGED
@@ -1,3 +1,175 @@
1
1
  # TSON-DB
2
2
 
3
- A TypeScript DSL for creating and managing JSON databases.
3
+ TSON-DB is a specialized DBMS for file-based databases. The database schema is defined in TypeScript using type functions. With options provided in these functions, a graphical user interface is generated that can be accessed through a browser.
4
+
5
+ TSON-DB can also be used to render type declarations in multiple languages or vocabularies like TypeScript (as actual types) or JSON Schema for the defined schema, but custom renderers can also be defined and used to support any output you need.
6
+
7
+ ## Installation
8
+
9
+ ```sh
10
+ npm install tsondb
11
+ ```
12
+
13
+ ## Define a Schema
14
+
15
+ You define a schema by declarations that consist of types.
16
+
17
+ ```ts
18
+ import { Entity, Object, Required, String } from "tsondb/schema/def"
19
+
20
+ const User = Entity(import.meta.url, {
21
+ name: "User",
22
+ namePlural: "Users",
23
+ comment: "A user in the application.",
24
+ type: () => Object({
25
+ name: Required({
26
+ comment: "The user’s full name.",
27
+ type: String({ minLength: 1 }),
28
+ }),
29
+ }),
30
+ })
31
+ ```
32
+
33
+ This defines a user entity with a single property called `name`. Its type is a non-empty string.
34
+
35
+ You can see how constraints are added by passing an object to the type function. This is a pattern used throughout. When a type is generic, like `Array` or `Object`, the option parameter is usually the second.
36
+
37
+ You can also add comments that, while not displayed by IDEs during the development of the schema, are used when generating outputs.
38
+
39
+ Note that some imports may shadow global objects (like `String` and `Object` in the example above). If you need a different name for an import, instead renaming an import, you can import a longer version of all declaration and type functions &mdash; declarations have a `Decl` suffix (e.g. `EntityDecl`) and types have a `Type` suffix (e.g. `StringType`). The simple imports are preferred due to simplicity, but you can also always use the suffixed names if you prefer to not shadow global objects.
40
+
41
+ Make sure to always pass `import.meta.url` as the first parameter to each declaration function, otherwise some functionality will not work at all or will not work as expected.
42
+
43
+ ### Available Declarations
44
+
45
+ #### `Entity` or `EntityDecl`
46
+
47
+ Each entity has to be an object (and so the `type` option always has to return an `Object` type) and its instances have their own directory within the database root. TSON-DB automatically sets an `id` property on the object, so you cannot define an `id` by yourself. The identifier is a UUID that is also reflected in the instance’s file name.
48
+
49
+ #### `Enum` or `EnumDecl`
50
+
51
+ An enumeration consists of one or more cases that are defined using `EnumCase` (or `EnumCaseDecl`) declarations. In the database files, they are represented using a discriminator property.
52
+
53
+ #### `TypeAlias` or `TypeAliasDecl`
54
+
55
+ With a type alias you can give another type a descriptive name in generated outputs. Note that this is different from just assigning a type to a variable and using it. If you use a variable directly, it is merged into the declaration when generating outputs.
56
+
57
+ ### Available Types
58
+
59
+ #### `Array` or `ArrayType`
60
+
61
+ An array type where you can define length and uniqueness constraints.
62
+
63
+ #### `Enum` or `EnumType`
64
+
65
+ You do not use this type directly, it is used internally and is only exported if you want to write your output renderer.
66
+
67
+ #### `Object` or `ObjectType`
68
+
69
+ An object type where you can define length constraints. Use in conjunction with the `Required` and `Optional` functions for defining object properties.
70
+
71
+ #### `Boolean` or `BooleanType`
72
+
73
+ A boolean type. This is not configurable.
74
+
75
+ #### `Date` or `DateType`
76
+
77
+ A date type where you can define whether to include time or not.
78
+
79
+ #### `Float` or `FloatType`
80
+
81
+ A floating-point number type with bound and factor constraints.
82
+
83
+ #### `Integer` or `IntegerType`
84
+
85
+ An integer type with bound and factor constraints.
86
+
87
+ #### `String` or `StringType`
88
+
89
+ A string type with length and pattern constraints.
90
+
91
+ #### `GenericArgumentIdentifier` or `GenericArgumentIdentifierType`
92
+
93
+ A type that references a type argument. Only useful with generic declarations (see *Type Parameters (Generics)* below).
94
+
95
+ #### `IncludeIdentifier` or `IncludeIdentifierType`
96
+
97
+ A type that references a type alias. There is a `Gen` version to reference generic type aliases (see *Type Parameters (Generics)* below).
98
+
99
+ #### `NestedEntityMap` or `NestedEntityMapType`
100
+
101
+ A keyed dictionary type where the keys are references to instances of another type. Often used for translations where the keys represent the locale identifier.
102
+
103
+ #### `ReferenceIdentifier` or `ReferenceIdentifierType`
104
+
105
+ A type that defines a reference to an instance of an entity.
106
+
107
+ ### Type Parameters (Generics)
108
+
109
+ There are some declarations where you can define type parameters if you want it to be more flexible. In that case, you can import a declaration with a `Gen` prefix. `Entity` declarations do not support type parameters, but the other declaration types do (e.g. `GenTypeAlias`). In these cases, you have to define the `parameters` option, which must be an array of the type parameters you want to define via the `Param` function. You can optionally define type constraints for a type parameter using normal type functions.
110
+
111
+ To use these parameters in its definition, define them as parameters to the defining function and use the `GenericArgumentIdentifier` type to reference them.
112
+
113
+ ```ts
114
+ const ValueAtName = GenTypeAlias(import.meta.url, {
115
+ name: "ValueAtName",
116
+ parameters: [Parameter("Value")],
117
+ type: (Value) => Object({
118
+ name: Required({
119
+ type: GenericArgumentIdentifier(Value),
120
+ }),
121
+ }),
122
+ })
123
+ ```
124
+
125
+ To reference a type alias in another declaration, use the `GenIncludeIdentifier` function.
126
+
127
+ ```ts
128
+ const OtherEntity = Entity(import.meta.url, {
129
+ name: "OtherEntity",
130
+ namePlural: "OtherEntities",
131
+ type: () => Object({
132
+ arbitraryName: Required({
133
+ type: GenIncludeIdentifier(ValueAtName, [String()]),
134
+ }),
135
+ }),
136
+ })
137
+ ```
138
+
139
+ ## GUI
140
+
141
+ To generate the graphical user interface, you need to create a `ModelContainer` with the schema you created before. Call either the `serve` or `generateValidateAndServe` functions with the created `ModelContainer`. You’ll be able to access the web interface at <http://localhost:3000>.
142
+
143
+ **Important:** If you only call the `serve` function, make sure the database has been validated before using either the `validate` or `generateAndValidate` functions.
144
+
145
+ If the database is in a Git repository, you’ll also get a simple Git GUI for managing branches and commits.
146
+
147
+ ## Generate typings
148
+
149
+ To generate typings, you have to define the `outputs` option on the `ModelContainer`.
150
+
151
+ ```ts
152
+ ModelContainer({
153
+ // ...
154
+ outputs: [
155
+ TypeScriptOutput({
156
+ targetPath: join(import.meta.dirname, "..", "gen", "types.d.ts"),
157
+ rendererOptions: {
158
+ preserveFiles: false,
159
+ },
160
+ }),
161
+ JsonSchemaOutput({
162
+ targetPath: join(import.meta.dirname, "..", "gen", "types.schema.json"),
163
+ rendererOptions: {
164
+ preserveFiles: true,
165
+ },
166
+ }),
167
+ ],
168
+ })
169
+ ```
170
+
171
+ You specify a target path where to save each generated content, and you can optionally provide custom settings to the respective renderers.
172
+
173
+ If the `preserveFiles` option is set to `true`, the target path is treated as a directory and the structure of your schema definitions is preserved. For example, if you have two files with definitions, `User.ts` and `Address.ts`, instead of outputting everything in `types.d.ts` (as specified above), a `types.d.ts` directory is created with `User.d.ts` and `Address.d.ts` files, where each file contains the declarations you put in each respectively.
174
+
175
+ This is possible due to the first argument to each declaration function, which should always be `import.meta.url`. If it is not set to this value, the `preserveFiles` option will behave differently according to the different path you set.
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env node
2
+ import type { Output } from "../node/renderers/Output.ts";
3
+ import type { Schema } from "../node/Schema.ts";
4
+ export type Config = {
5
+ schema: Schema;
6
+ outputs: Output[];
7
+ dataRootPath?: string;
8
+ };
@@ -0,0 +1,83 @@
1
+ #!/usr/bin/env node
2
+ var __rewriteRelativeImportExtension = (this && this.__rewriteRelativeImportExtension) || function (path, preserveJsx) {
3
+ if (typeof path === "string" && /^\.\.?\//.test(path)) {
4
+ return path.replace(/\.(tsx)$|((?:\.d)?)((?:\.[^./]+?)?)\.([cm]?)ts$/i, function (m, tsx, d, ext, cm) {
5
+ return tsx ? preserveJsx ? ".jsx" : ".js" : d && (!ext || !cm) ? m : (d + ext + "." + cm.toLowerCase() + "js");
6
+ });
7
+ }
8
+ return path;
9
+ };
10
+ import Debug from "debug";
11
+ import { access, constants } from "node:fs/promises";
12
+ import { join } from "node:path";
13
+ import { cwd } from "node:process";
14
+ import { parseArguments } from "simple-cli-args";
15
+ import { generateOutputs, serve, validate } from "../node/index.js";
16
+ const debug = Debug("tsondb:cli");
17
+ const passedArguments = parseArguments({
18
+ commands: {
19
+ validate: {
20
+ name: "validate",
21
+ },
22
+ generate: {
23
+ name: "generate",
24
+ },
25
+ serve: {
26
+ name: "serve",
27
+ },
28
+ },
29
+ });
30
+ // import the config
31
+ const possibleConfigNames = [
32
+ "tsondb.config.ts",
33
+ "tsondb.config.mts",
34
+ "tsondb.config.js",
35
+ "tsondb.config.mjs",
36
+ ];
37
+ const config = await (async () => {
38
+ for (const configName of possibleConfigNames) {
39
+ const fullPath = join(cwd(), configName);
40
+ try {
41
+ await access(fullPath, constants.R_OK);
42
+ }
43
+ catch {
44
+ debug(`could not use config file ${fullPath}, not found`);
45
+ continue;
46
+ }
47
+ const foundConfigModule = (await import(__rewriteRelativeImportExtension(fullPath)));
48
+ if ("default" in foundConfigModule) {
49
+ debug(`config file ${fullPath} found with config`);
50
+ return foundConfigModule.default;
51
+ }
52
+ else {
53
+ debug(`config file ${fullPath} found, but no default export present`);
54
+ }
55
+ }
56
+ return undefined;
57
+ })();
58
+ if (config === undefined) {
59
+ throw new Error("No config file specified.");
60
+ }
61
+ if (passedArguments.command === undefined) {
62
+ throw new Error("No command has been specified. Possible commands are: generate, serve, validate.");
63
+ }
64
+ switch (passedArguments.command.name) {
65
+ case "generate":
66
+ debug(`running command: generate`);
67
+ await generateOutputs(config.schema, config.outputs);
68
+ break;
69
+ case "serve":
70
+ debug(`running command: serve`);
71
+ if (config.dataRootPath === undefined) {
72
+ throw new Error("No dataRootPath specified in config");
73
+ }
74
+ await serve(config.schema, config.dataRootPath);
75
+ break;
76
+ case "validate":
77
+ debug(`running command: validate`);
78
+ if (config.dataRootPath === undefined) {
79
+ throw new Error("No dataRootPath specified in config");
80
+ }
81
+ await validate(config.schema, config.dataRootPath);
82
+ break;
83
+ }
package/lib/index.d.ts CHANGED
@@ -1 +1,2 @@
1
- export {};
1
+ export type { Config } from "./bin/tsondb.ts";
2
+ export * from "./node/index.ts";
package/lib/index.js CHANGED
@@ -1 +1 @@
1
- export {};
1
+ export * from "./node/index.js";
@@ -1,5 +1,5 @@
1
- import { Decl } from "./schema/declarations/Declaration.js";
2
- import { EntityDecl } from "./schema/declarations/EntityDecl.js";
1
+ import type { Decl } from "./schema/declarations/Declaration.js";
2
+ import type { EntityDecl } from "./schema/declarations/EntityDecl.js";
3
3
  export interface Schema {
4
4
  declarations: readonly Decl[];
5
5
  localeEntity?: EntityDecl;
@@ -1,4 +1,4 @@
1
- import { getNestedDeclarations, getParameterNames, } from "./schema/declarations/Declaration.js";
1
+ import { getNestedDeclarations, getParameterNames } from "./schema/declarations/Declaration.js";
2
2
  import { isEntityDecl } from "./schema/declarations/EntityDecl.js";
3
3
  import { isStringType } from "./schema/types/primitives/StringType.js";
4
4
  import { isNestedEntityMapType } from "./schema/types/references/NestedEntityMapType.js";