@htilabs/platform-common-models 0.2.0-beta.4 → 0.3.0-beta.5

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 (75) hide show
  1. package/README.md +38 -0
  2. package/dist/constants/index.cjs +0 -843
  3. package/dist/constants/index.cjs.map +1 -1
  4. package/dist/constants/index.d.cts +146 -5
  5. package/dist/constants/index.d.ts +146 -5
  6. package/dist/constants/index.js +0 -786
  7. package/dist/constants/index.js.map +1 -1
  8. package/dist/{platform-role-AHv1l5Og.d.cts → cvcEntry-wqktWfzE.d.cts} +231 -37
  9. package/dist/{platform-role-AHv1l5Og.d.ts → cvcEntry-wqktWfzE.d.ts} +231 -37
  10. package/dist/cvcs/index.cjs +2184 -0
  11. package/dist/cvcs/index.cjs.map +1 -0
  12. package/dist/cvcs/index.d.cts +2384 -0
  13. package/dist/cvcs/index.d.ts +2384 -0
  14. package/dist/cvcs/index.js +2154 -0
  15. package/dist/cvcs/index.js.map +1 -0
  16. package/dist/index--NCIPluF.d.cts +378 -0
  17. package/dist/index-CFOrHA8l.d.ts +378 -0
  18. package/dist/index.cjs +2962 -843
  19. package/dist/index.cjs.map +1 -1
  20. package/dist/index.d.cts +217 -3
  21. package/dist/index.d.ts +217 -3
  22. package/dist/index.js +2934 -786
  23. package/dist/index.js.map +1 -1
  24. package/dist/models/index.cjs +211 -0
  25. package/dist/models/index.cjs.map +1 -1
  26. package/dist/models/index.d.cts +3 -292
  27. package/dist/models/index.d.ts +3 -292
  28. package/dist/models/index.js +209 -0
  29. package/dist/models/index.js.map +1 -1
  30. package/dist/{platform-auth-BTbQIY3b.d.cts → platform-auth-C-G2qeGM.d.cts} +1 -297
  31. package/dist/{platform-auth-BTbQIY3b.d.ts → platform-auth-C-G2qeGM.d.ts} +1 -297
  32. package/dist/schemas/index.cjs +195 -729
  33. package/dist/schemas/index.cjs.map +1 -1
  34. package/dist/schemas/index.d.cts +11 -11
  35. package/dist/schemas/index.d.ts +11 -11
  36. package/dist/schemas/index.js +189 -729
  37. package/dist/schemas/index.js.map +1 -1
  38. package/dist/services/index.cjs +1442 -0
  39. package/dist/services/index.cjs.map +1 -0
  40. package/dist/services/index.d.cts +305 -0
  41. package/dist/services/index.d.ts +305 -0
  42. package/dist/services/index.js +1417 -0
  43. package/dist/services/index.js.map +1 -0
  44. package/dist/types/index.d.cts +2 -2
  45. package/dist/types/index.d.ts +2 -2
  46. package/dist/validation/index.cjs +261 -0
  47. package/dist/validation/index.cjs.map +1 -0
  48. package/dist/validation/index.d.cts +251 -0
  49. package/dist/validation/index.d.ts +251 -0
  50. package/dist/validation/index.js +228 -0
  51. package/dist/validation/index.js.map +1 -0
  52. package/package.json +36 -12
  53. package/src/__tests__/__snapshots__/cvc-sot.snap +22 -0
  54. package/src/__tests__/cvc-sot-snapshot.test.ts +184 -0
  55. package/src/__tests__/cvc-structural.test.ts +130 -0
  56. package/src/constants/ic.ts +0 -925
  57. package/src/constants/service-catalog.ts +146 -4
  58. package/src/cvcs/index.ts +31 -0
  59. package/src/cvcs/missingness.v1.0.0.json +50 -0
  60. package/src/cvcs/serviceCategories.v1.0.0.json +1947 -0
  61. package/src/cvcs/serviceMechanisms.v1.0.0.json +47 -0
  62. package/src/cvcs/serviceStates.v1.0.0.json +106 -0
  63. package/src/generated/cvc-enums.ts +215 -0
  64. package/src/index.ts +61 -1
  65. package/src/models/cvcEntryModel.ts +32 -0
  66. package/src/models/cvcRegistryModel.ts +35 -0
  67. package/src/models/index.ts +8 -0
  68. package/src/schemas/cvcEntry.ts +158 -0
  69. package/src/schemas/cvcRegistry.ts +149 -0
  70. package/src/schemas/index.ts +16 -0
  71. package/src/services/__tests__/cvcRegistryService.test.ts +614 -0
  72. package/src/services/cvcRegistryService.ts +729 -0
  73. package/src/services/index.ts +21 -0
  74. package/src/validation/cvc.ts +414 -0
  75. package/src/validation/index.ts +15 -0
@@ -0,0 +1,378 @@
1
+ import { F as Form, l as buildFormSchema, h as Section, q as buildSectionSchema, Q as Question, o as buildQuestionSchema, f as ScoringRule, p as buildScoringRuleSchema, P as PlatformFunction, m as buildPlatformFunctionSchema, d as PlatformRole, n as buildPlatformRoleSchema, b as CvcRegistry, k as buildCvcRegistrySchema, a as CvcEntry, j as buildCvcEntrySchema } from './cvcEntry-wqktWfzE.js';
2
+ import * as mongoose from 'mongoose';
3
+ import { HydratedDocument, Connection, Model } from 'mongoose';
4
+
5
+ type FormDoc = HydratedDocument<Form>;
6
+
7
+ /**
8
+ * Compile the Form model on a specific connection.
9
+ * @param connection - Mongoose connection to bind the model to
10
+ * @param schema - Optional pre-built schema (uses buildFormSchema() if not provided)
11
+ * @returns Mongoose Model for Form
12
+ */
13
+ declare function compileModel$7(connection: Connection, schema?: mongoose.Schema<any, Model<any, any, any, any, any, any, any>, {}, {}, {}, {}, mongoose.DefaultSchemaOptions, {
14
+ [x: number]: unknown;
15
+ [x: symbol]: unknown;
16
+ [x: string]: unknown;
17
+ }, mongoose.Document<unknown, {}, {
18
+ [x: number]: unknown;
19
+ [x: symbol]: unknown;
20
+ [x: string]: unknown;
21
+ }, {
22
+ id: string;
23
+ }, mongoose.DefaultSchemaOptions> & Omit<{
24
+ [x: number]: unknown;
25
+ [x: symbol]: unknown;
26
+ [x: string]: unknown;
27
+ } & Required<{
28
+ _id: unknown;
29
+ }> & {
30
+ __v: number;
31
+ }, "id"> & {
32
+ id: string;
33
+ }, unknown, {
34
+ [x: number]: {};
35
+ [x: symbol]: {};
36
+ [x: string]: {};
37
+ } & Required<{
38
+ _id: unknown;
39
+ }> & {
40
+ __v: number;
41
+ }>): Model<Form>;
42
+
43
+ type formModel_FormDoc = FormDoc;
44
+ declare namespace formModel {
45
+ export { type formModel_FormDoc as FormDoc, buildFormSchema as buildSchema, compileModel$7 as compileModel };
46
+ }
47
+
48
+ type SectionDoc = HydratedDocument<Section>;
49
+
50
+ /**
51
+ * Compile the Section model on a specific connection.
52
+ * @param connection - Mongoose connection to bind the model to
53
+ * @param schema - Optional pre-built schema (uses buildSectionSchema() if not provided)
54
+ * @returns Mongoose Model for Section
55
+ */
56
+ declare function compileModel$6(connection: Connection, schema?: mongoose.Schema<any, Model<any, any, any, any, any, any, any>, {}, {}, {}, {}, mongoose.DefaultSchemaOptions, {
57
+ [x: number]: unknown;
58
+ [x: symbol]: unknown;
59
+ [x: string]: unknown;
60
+ }, mongoose.Document<unknown, {}, {
61
+ [x: number]: unknown;
62
+ [x: symbol]: unknown;
63
+ [x: string]: unknown;
64
+ }, {
65
+ id: string;
66
+ }, mongoose.DefaultSchemaOptions> & Omit<{
67
+ [x: number]: unknown;
68
+ [x: symbol]: unknown;
69
+ [x: string]: unknown;
70
+ } & Required<{
71
+ _id: unknown;
72
+ }> & {
73
+ __v: number;
74
+ }, "id"> & {
75
+ id: string;
76
+ }, unknown, {
77
+ [x: number]: {};
78
+ [x: symbol]: {};
79
+ [x: string]: {};
80
+ } & Required<{
81
+ _id: unknown;
82
+ }> & {
83
+ __v: number;
84
+ }>): Model<Section>;
85
+
86
+ type sectionModel_SectionDoc = SectionDoc;
87
+ declare namespace sectionModel {
88
+ export { type sectionModel_SectionDoc as SectionDoc, buildSectionSchema as buildSchema, compileModel$6 as compileModel };
89
+ }
90
+
91
+ type QuestionDoc = HydratedDocument<Question>;
92
+
93
+ /**
94
+ * Compile the Question model on a specific connection.
95
+ * @param connection - Mongoose connection to bind the model to
96
+ * @param schema - Optional pre-built schema (uses buildQuestionSchema() if not provided)
97
+ * @returns Mongoose Model for Question
98
+ */
99
+ declare function compileModel$5(connection: Connection, schema?: mongoose.Schema<any, Model<any, any, any, any, any, any, any>, {}, {}, {}, {}, mongoose.DefaultSchemaOptions, {
100
+ [x: number]: unknown;
101
+ [x: symbol]: unknown;
102
+ [x: string]: unknown;
103
+ }, mongoose.Document<unknown, {}, {
104
+ [x: number]: unknown;
105
+ [x: symbol]: unknown;
106
+ [x: string]: unknown;
107
+ }, {
108
+ id: string;
109
+ }, mongoose.DefaultSchemaOptions> & Omit<{
110
+ [x: number]: unknown;
111
+ [x: symbol]: unknown;
112
+ [x: string]: unknown;
113
+ } & Required<{
114
+ _id: unknown;
115
+ }> & {
116
+ __v: number;
117
+ }, "id"> & {
118
+ id: string;
119
+ }, unknown, {
120
+ [x: number]: {};
121
+ [x: symbol]: {};
122
+ [x: string]: {};
123
+ } & Required<{
124
+ _id: unknown;
125
+ }> & {
126
+ __v: number;
127
+ }>): Model<Question>;
128
+
129
+ type questionModel_QuestionDoc = QuestionDoc;
130
+ declare namespace questionModel {
131
+ export { type questionModel_QuestionDoc as QuestionDoc, buildQuestionSchema as buildSchema, compileModel$5 as compileModel };
132
+ }
133
+
134
+ type ScoringRuleDoc = HydratedDocument<ScoringRule>;
135
+
136
+ /**
137
+ * Compile the ScoringRule model on a specific connection.
138
+ * @param connection - Mongoose connection to bind the model to
139
+ * @param schema - Optional pre-built schema (uses buildScoringRuleSchema() if not provided)
140
+ * @returns Mongoose Model for ScoringRule
141
+ */
142
+ declare function compileModel$4(connection: Connection, schema?: mongoose.Schema<any, Model<any, any, any, any, any, any, any>, {}, {}, {}, {}, mongoose.DefaultSchemaOptions, {
143
+ [x: number]: unknown;
144
+ [x: symbol]: unknown;
145
+ [x: string]: unknown;
146
+ }, mongoose.Document<unknown, {}, {
147
+ [x: number]: unknown;
148
+ [x: symbol]: unknown;
149
+ [x: string]: unknown;
150
+ }, {
151
+ id: string;
152
+ }, mongoose.DefaultSchemaOptions> & Omit<{
153
+ [x: number]: unknown;
154
+ [x: symbol]: unknown;
155
+ [x: string]: unknown;
156
+ } & Required<{
157
+ _id: unknown;
158
+ }> & {
159
+ __v: number;
160
+ }, "id"> & {
161
+ id: string;
162
+ }, unknown, {
163
+ [x: number]: {};
164
+ [x: symbol]: {};
165
+ [x: string]: {};
166
+ } & Required<{
167
+ _id: unknown;
168
+ }> & {
169
+ __v: number;
170
+ }>): Model<ScoringRule>;
171
+
172
+ type scoringRuleModel_ScoringRuleDoc = ScoringRuleDoc;
173
+ declare namespace scoringRuleModel {
174
+ export { type scoringRuleModel_ScoringRuleDoc as ScoringRuleDoc, buildScoringRuleSchema as buildSchema, compileModel$4 as compileModel };
175
+ }
176
+
177
+ type PlatformFunctionDoc = HydratedDocument<PlatformFunction>;
178
+
179
+ /**
180
+ * Compile the PlatformFunction model on a specific connection.
181
+ * @param connection - Mongoose connection to bind the model to
182
+ * @param schema - Optional pre-built schema (uses buildPlatformFunctionSchema() if not provided)
183
+ * @returns Mongoose Model for PlatformFunction
184
+ */
185
+ declare function compileModel$3(connection: Connection, schema?: mongoose.Schema<any, Model<any, any, any, any, any, any, any>, {}, {}, {}, {}, mongoose.DefaultSchemaOptions, {
186
+ [x: number]: unknown;
187
+ [x: symbol]: unknown;
188
+ [x: string]: unknown;
189
+ }, mongoose.Document<unknown, {}, {
190
+ [x: number]: unknown;
191
+ [x: symbol]: unknown;
192
+ [x: string]: unknown;
193
+ }, {
194
+ id: string;
195
+ }, mongoose.DefaultSchemaOptions> & Omit<{
196
+ [x: number]: unknown;
197
+ [x: symbol]: unknown;
198
+ [x: string]: unknown;
199
+ } & Required<{
200
+ _id: unknown;
201
+ }> & {
202
+ __v: number;
203
+ }, "id"> & {
204
+ id: string;
205
+ }, unknown, {
206
+ [x: number]: {};
207
+ [x: symbol]: {};
208
+ [x: string]: {};
209
+ } & Required<{
210
+ _id: unknown;
211
+ }> & {
212
+ __v: number;
213
+ }>): Model<PlatformFunction>;
214
+
215
+ type platformFunctionModel_PlatformFunctionDoc = PlatformFunctionDoc;
216
+ declare namespace platformFunctionModel {
217
+ export { type platformFunctionModel_PlatformFunctionDoc as PlatformFunctionDoc, buildPlatformFunctionSchema as buildSchema, compileModel$3 as compileModel };
218
+ }
219
+
220
+ type PlatformRoleDoc = HydratedDocument<PlatformRole>;
221
+
222
+ /**
223
+ * Compile the PlatformRole model on a specific connection.
224
+ * @param connection - Mongoose connection to bind the model to
225
+ * @param schema - Optional pre-built schema (uses buildPlatformRoleSchema() if not provided)
226
+ * @returns Mongoose Model for PlatformRole
227
+ */
228
+ declare function compileModel$2(connection: Connection, schema?: mongoose.Schema<any, Model<any, any, any, any, any, any, any>, {}, {}, {}, {}, mongoose.DefaultSchemaOptions, {
229
+ [x: number]: unknown;
230
+ [x: symbol]: unknown;
231
+ [x: string]: unknown;
232
+ }, mongoose.Document<unknown, {}, {
233
+ [x: number]: unknown;
234
+ [x: symbol]: unknown;
235
+ [x: string]: unknown;
236
+ }, {
237
+ id: string;
238
+ }, mongoose.DefaultSchemaOptions> & Omit<{
239
+ [x: number]: unknown;
240
+ [x: symbol]: unknown;
241
+ [x: string]: unknown;
242
+ } & Required<{
243
+ _id: unknown;
244
+ }> & {
245
+ __v: number;
246
+ }, "id"> & {
247
+ id: string;
248
+ }, unknown, {
249
+ [x: number]: {};
250
+ [x: symbol]: {};
251
+ [x: string]: {};
252
+ } & Required<{
253
+ _id: unknown;
254
+ }> & {
255
+ __v: number;
256
+ }>): Model<PlatformRole>;
257
+
258
+ type platformRoleModel_PlatformRoleDoc = PlatformRoleDoc;
259
+ declare namespace platformRoleModel {
260
+ export { type platformRoleModel_PlatformRoleDoc as PlatformRoleDoc, buildPlatformRoleSchema as buildSchema, compileModel$2 as compileModel };
261
+ }
262
+
263
+ type CvcRegistryDoc = HydratedDocument<CvcRegistry>;
264
+
265
+ /**
266
+ * Compile the CvcRegistry model on a specific connection.
267
+ * @param connection - Mongoose connection to bind the model to
268
+ * @param schema - Optional pre-built schema (uses buildCvcRegistrySchema() if not provided)
269
+ * @returns Mongoose Model for CvcRegistry
270
+ */
271
+ declare function compileModel$1(connection: Connection, schema?: mongoose.Schema<any, Model<any, any, any, any, any, any, any>, {}, {}, {}, {}, mongoose.DefaultSchemaOptions, {
272
+ [x: number]: unknown;
273
+ [x: symbol]: unknown;
274
+ [x: string]: unknown;
275
+ }, mongoose.Document<unknown, {}, {
276
+ [x: number]: unknown;
277
+ [x: symbol]: unknown;
278
+ [x: string]: unknown;
279
+ }, {
280
+ id: string;
281
+ }, mongoose.DefaultSchemaOptions> & Omit<{
282
+ [x: number]: unknown;
283
+ [x: symbol]: unknown;
284
+ [x: string]: unknown;
285
+ } & Required<{
286
+ _id: unknown;
287
+ }> & {
288
+ __v: number;
289
+ }, "id"> & {
290
+ id: string;
291
+ }, unknown, {
292
+ [x: number]: {};
293
+ [x: symbol]: {};
294
+ [x: string]: {};
295
+ } & Required<{
296
+ _id: unknown;
297
+ }> & {
298
+ __v: number;
299
+ }>): Model<CvcRegistry>;
300
+
301
+ type cvcRegistryModel_CvcRegistryDoc = CvcRegistryDoc;
302
+ declare namespace cvcRegistryModel {
303
+ export { type cvcRegistryModel_CvcRegistryDoc as CvcRegistryDoc, buildCvcRegistrySchema as buildSchema, compileModel$1 as compileModel };
304
+ }
305
+
306
+ type CvcEntryDoc = HydratedDocument<CvcEntry>;
307
+
308
+ /**
309
+ * Compile the CvcEntry model on a specific connection.
310
+ * @param connection - Mongoose connection to bind the model to
311
+ * @param schema - Optional pre-built schema (uses buildCvcEntrySchema() if not provided)
312
+ * @returns Mongoose Model for CvcEntry
313
+ */
314
+ declare function compileModel(connection: Connection, schema?: mongoose.Schema<any, Model<any, any, any, any, any, any, any>, {}, {}, {}, {}, mongoose.DefaultSchemaOptions, {
315
+ [x: number]: unknown;
316
+ [x: symbol]: unknown;
317
+ [x: string]: unknown;
318
+ }, mongoose.Document<unknown, {}, {
319
+ [x: number]: unknown;
320
+ [x: symbol]: unknown;
321
+ [x: string]: unknown;
322
+ }, {
323
+ id: string;
324
+ }, mongoose.DefaultSchemaOptions> & Omit<{
325
+ [x: number]: unknown;
326
+ [x: symbol]: unknown;
327
+ [x: string]: unknown;
328
+ } & Required<{
329
+ _id: unknown;
330
+ }> & {
331
+ __v: number;
332
+ }, "id"> & {
333
+ id: string;
334
+ }, unknown, {
335
+ [x: number]: {};
336
+ [x: symbol]: {};
337
+ [x: string]: {};
338
+ } & Required<{
339
+ _id: unknown;
340
+ }> & {
341
+ __v: number;
342
+ }>): Model<CvcEntry>;
343
+
344
+ type cvcEntryModel_CvcEntryDoc = CvcEntryDoc;
345
+ declare const cvcEntryModel_compileModel: typeof compileModel;
346
+ declare namespace cvcEntryModel {
347
+ export { type cvcEntryModel_CvcEntryDoc as CvcEntryDoc, buildCvcEntrySchema as buildSchema, cvcEntryModel_compileModel as compileModel };
348
+ }
349
+
350
+ /**
351
+ * Platform models interface returned by createPlatformModels.
352
+ */
353
+ interface PlatformModels {
354
+ FormModel: Model<Form>;
355
+ SectionModel: Model<Section>;
356
+ QuestionModel: Model<Question>;
357
+ ScoringRuleModel: Model<ScoringRule>;
358
+ PlatformFunctionModel: Model<PlatformFunction>;
359
+ PlatformRoleModel: Model<PlatformRole>;
360
+ }
361
+ /**
362
+ * Create all platform models bound to a single connection.
363
+ * Convenience function for apps that need all form-related models.
364
+ *
365
+ * @param connection - Mongoose connection to bind all models to
366
+ * @returns Object with all compiled models
367
+ *
368
+ * @example
369
+ * ```typescript
370
+ * const platformDb = mongoose.createConnection(PLATFORM_DB_URI);
371
+ * const { FormModel, SectionModel, QuestionModel, ScoringRuleModel } = createPlatformModels(platformDb);
372
+ *
373
+ * const forms = await FormModel.find({ status: 'active' });
374
+ * ```
375
+ */
376
+ declare function createPlatformModels(connection: Connection): PlatformModels;
377
+
378
+ export { type CvcEntryDoc as C, type FormDoc as F, type PlatformFunctionDoc as P, type QuestionDoc as Q, type ScoringRuleDoc as S, type CvcRegistryDoc as a, type PlatformModels as b, type PlatformRoleDoc as c, type SectionDoc as d, compileModel as e, compileModel$1 as f, createPlatformModels as g, cvcEntryModel as h, cvcRegistryModel as i, formModel as j, platformRoleModel as k, sectionModel as l, platformFunctionModel as p, questionModel as q, scoringRuleModel as s };