@htilabs/platform-common-models 0.2.0-beta.3 → 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 -140
  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 -128
  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 -140
  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 -128
  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-DHSJP7XP.d.cts → platform-auth-C-G2qeGM.d.cts} +1 -36
  31. package/dist/{platform-auth-DHSJP7XP.d.ts → platform-auth-C-G2qeGM.d.ts} +1 -36
  32. package/dist/schemas/index.cjs +195 -116
  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 -116
  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 -154
  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
package/README.md ADDED
@@ -0,0 +1,38 @@
1
+ # @htilabs/platform-common-models
2
+
3
+ Shared data models, schemas, services, and controlled-vocabulary (CVC) data
4
+ layer for HTI Labs applications (PAVE, LEADS, Thread).
5
+
6
+ This package provides:
7
+
8
+ - Mongoose schemas and model factories (`src/schemas`, `src/models`)
9
+ - Zod validation schemas (`src/validation`)
10
+ - Shared domain enums and constants (`src/constants`, `src/enums`)
11
+ - The generalized CVC data layer (`src/services/cvcRegistryService.ts`) and
12
+ the locked Source-of-Truth catalogs under `src/cvcs/`
13
+ - Generated CVC key enums under `src/generated/`
14
+
15
+ Package exports are organized into a public root API and a small number of
16
+ dedicated subpaths (`/validation`, `/cvcs`) — consult `package.json` for the
17
+ authoritative `exports` map.
18
+
19
+ ## Service Catalog: Deprecation Notice
20
+
21
+ The hardcoded `IC_48_*` constants and helpers in
22
+ `src/constants/service-catalog.ts` are **deprecated as of version 0.3.0**.
23
+
24
+ Use the generalized CVC data layer (`CvcRegistryService`) from
25
+ `@htilabs/platform-common-models` instead. The new API loads catalog data
26
+ from MongoDB at runtime rather than a hardcoded JSON bundle, and supports
27
+ multiple CVC domains beyond IC-48 service categories.
28
+
29
+ See `src/services/cvcRegistryService.ts` and the locked CVC Implementation
30
+ Spec at `/gt/docs/data/cvcs/` for the new API and migration guidance. The
31
+ file-level JSDoc at the top of `src/constants/service-catalog.ts` contains a
32
+ symbol-by-symbol migration table.
33
+
34
+ Removal of the legacy constants is intentionally deferred: it is tracked in a
35
+ downstream consumer-migration epic and will land in a future major version
36
+ only after Thread and PAVE have cut over to `CvcRegistryService`. Until then,
37
+ the legacy constants continue to ship alongside the new API — importing them
38
+ is safe but will surface a TypeScript `@deprecated` hint.
@@ -62,11 +62,6 @@ __export(constants_exports, {
62
62
  CVC_136_OPTIONS: () => CVC_136_OPTIONS,
63
63
  CVC_136_TYPE_TO_CATEGORY: () => CVC_136_TYPE_TO_CATEGORY,
64
64
  CVC_136_VALUES: () => CVC_136_VALUES,
65
- CVC_137_LABELS: () => CVC_137_LABELS,
66
- CVC_137_MISSINGNESS_VALUES: () => CVC_137_MISSINGNESS_VALUES,
67
- CVC_137_RECENCY_BAND: () => CVC_137_RECENCY_BAND,
68
- CVC_137_SELECTABLE_VALUES: () => CVC_137_SELECTABLE_VALUES,
69
- CVC_137_VALUES: () => CVC_137_VALUES,
70
65
  CVC_145_CATEGORY: () => CVC_145_CATEGORY,
71
66
  CVC_145_CATEGORY_LABELS: () => CVC_145_CATEGORY_LABELS,
72
67
  CVC_145_CATEGORY_ORDER: () => CVC_145_CATEGORY_ORDER,
@@ -146,7 +141,6 @@ __export(constants_exports, {
146
141
  CVC_17_LEVEL_1_OPTIONS: () => CVC_17_LEVEL_1_OPTIONS,
147
142
  CVC_17_LEVEL_2_TRANSGENDER_OPTIONS: () => CVC_17_LEVEL_2_TRANSGENDER_OPTIONS,
148
143
  CVC_17_TRANSGENDER_VALUES: () => CVC_17_TRANSGENDER_VALUES,
149
- CVC_17_VALUES: () => CVC_17_VALUES,
150
144
  CVC_180_EDUCATION_LEVEL: () => CVC_180_EDUCATION_LEVEL,
151
145
  CVC_180_LABELS: () => CVC_180_LABELS,
152
146
  CVC_180_ORDINAL: () => CVC_180_ORDINAL,
@@ -156,11 +150,6 @@ __export(constants_exports, {
156
150
  CVC_196_CHILD_WELFARE_EPISODE_TYPE: () => CVC_196_CHILD_WELFARE_EPISODE_TYPE,
157
151
  CVC_196_LABELS: () => CVC_196_LABELS,
158
152
  CVC_196_VALUES: () => CVC_196_VALUES,
159
- CVC_197_JUVENILE_JUSTICE_EPISODE: () => CVC_197_JUVENILE_JUSTICE_EPISODE,
160
- CVC_197_LABELS: () => CVC_197_LABELS,
161
- CVC_197_MISSINGNESS_VALUES: () => CVC_197_MISSINGNESS_VALUES,
162
- CVC_197_SELECTABLE_VALUES: () => CVC_197_SELECTABLE_VALUES,
163
- CVC_197_VALUES: () => CVC_197_VALUES,
164
153
  CVC_1_LABELS: () => CVC_1_LABELS,
165
154
  CVC_1_NAME_TYPE: () => CVC_1_NAME_TYPE,
166
155
  CVC_1_STRUCTURED_NAME_TYPES: () => CVC_1_STRUCTURED_NAME_TYPES,
@@ -170,7 +159,6 @@ __export(constants_exports, {
170
159
  CVC_67_LABELS: () => CVC_67_LABELS,
171
160
  CVC_67_MISSINGNESS_VALUES: () => CVC_67_MISSINGNESS_VALUES,
172
161
  CVC_67_SELECTABLE_VALUES: () => CVC_67_SELECTABLE_VALUES,
173
- CVC_67_VALUES: () => CVC_67_VALUES,
174
162
  CVC_72_HT_TYPE: () => CVC_72_HT_TYPE,
175
163
  CVC_72_LABELS: () => CVC_72_LABELS,
176
164
  CVC_72_VALUES: () => CVC_72_VALUES,
@@ -1375,16 +1363,6 @@ function isTransgenderGenderIdentity(value) {
1375
1363
  if (!value) return false;
1376
1364
  return CVC_17_TRANSGENDER_VALUES.includes(value);
1377
1365
  }
1378
- var CVC_17_VALUES = [
1379
- CVC_17_CORE_GENDER_IDENTITY.MALE,
1380
- CVC_17_CORE_GENDER_IDENTITY.FEMALE,
1381
- CVC_17_CORE_GENDER_IDENTITY.TRANSGENDER,
1382
- CVC_17_CORE_GENDER_IDENTITY.NON_BINARY,
1383
- CVC_17_CORE_GENDER_IDENTITY.OTHER,
1384
- CVC_17_CORE_GENDER_IDENTITY.UNKNOWN,
1385
- CVC_17_CORE_GENDER_IDENTITY.TRANSGENDER_FTM,
1386
- CVC_17_CORE_GENDER_IDENTITY.TRANSGENDER_MTF
1387
- ];
1388
1366
  var IC_24_RACE = {
1389
1367
  AMERICAN_INDIAN_ALASKA_NATIVE: 1,
1390
1368
  ASIAN: 2,
@@ -4301,112 +4279,6 @@ var CVC_67_SELECTABLE_VALUES = [
4301
4279
  var CVC_67_MISSINGNESS_VALUES = [
4302
4280
  CVC_67_HMIS_SEX.DATA_NOT_COLLECTED
4303
4281
  ];
4304
- var CVC_67_VALUES = [
4305
- CVC_67_HMIS_SEX.MALE,
4306
- CVC_67_HMIS_SEX.FEMALE,
4307
- CVC_67_HMIS_SEX.CLIENT_PREFERS_NOT_TO_ANSWER,
4308
- CVC_67_HMIS_SEX.CLIENT_DOESNT_KNOW,
4309
- CVC_67_HMIS_SEX.DATA_NOT_COLLECTED
4310
- ];
4311
- var CVC_137_RECENCY_BAND = {
4312
- // Primary recency values
4313
- WITHIN_3_MONTHS: "W3M",
4314
- MONTHS_3_TO_6: "M3_6",
4315
- MONTHS_6_TO_12: "M6_12",
4316
- ONE_YEAR_OR_MORE: "Y1P",
4317
- LESS_THAN_3_YEARS: "YLT3",
4318
- YEARS_3_TO_10: "Y3_10",
4319
- TEN_PLUS_YEARS: "Y10P",
4320
- // Missingness values
4321
- UNKNOWN: "UNK",
4322
- DATA_NOT_COLLECTED: "DNC",
4323
- ANONYMOUS: "ANON",
4324
- PREFERS_NOT_TO_ANSWER: "PNA"
4325
- };
4326
- var CVC_137_LABELS = {
4327
- [CVC_137_RECENCY_BAND.WITHIN_3_MONTHS]: "Within past 3 months",
4328
- [CVC_137_RECENCY_BAND.MONTHS_3_TO_6]: "3-6 months ago",
4329
- [CVC_137_RECENCY_BAND.MONTHS_6_TO_12]: "6-12 months ago",
4330
- [CVC_137_RECENCY_BAND.ONE_YEAR_OR_MORE]: "One year or more",
4331
- [CVC_137_RECENCY_BAND.LESS_THAN_3_YEARS]: "Less than 3 years ago",
4332
- [CVC_137_RECENCY_BAND.YEARS_3_TO_10]: "3-10 years ago",
4333
- [CVC_137_RECENCY_BAND.TEN_PLUS_YEARS]: "10+ years ago",
4334
- [CVC_137_RECENCY_BAND.UNKNOWN]: "Unknown",
4335
- [CVC_137_RECENCY_BAND.DATA_NOT_COLLECTED]: "Data not collected",
4336
- [CVC_137_RECENCY_BAND.ANONYMOUS]: "Anonymous",
4337
- [CVC_137_RECENCY_BAND.PREFERS_NOT_TO_ANSWER]: "Client prefers not to answer"
4338
- };
4339
- var CVC_137_VALUES = [
4340
- CVC_137_RECENCY_BAND.WITHIN_3_MONTHS,
4341
- CVC_137_RECENCY_BAND.MONTHS_3_TO_6,
4342
- CVC_137_RECENCY_BAND.MONTHS_6_TO_12,
4343
- CVC_137_RECENCY_BAND.ONE_YEAR_OR_MORE,
4344
- CVC_137_RECENCY_BAND.LESS_THAN_3_YEARS,
4345
- CVC_137_RECENCY_BAND.YEARS_3_TO_10,
4346
- CVC_137_RECENCY_BAND.TEN_PLUS_YEARS,
4347
- CVC_137_RECENCY_BAND.UNKNOWN,
4348
- CVC_137_RECENCY_BAND.DATA_NOT_COLLECTED,
4349
- CVC_137_RECENCY_BAND.ANONYMOUS,
4350
- CVC_137_RECENCY_BAND.PREFERS_NOT_TO_ANSWER
4351
- ];
4352
- var CVC_137_SELECTABLE_VALUES = [
4353
- CVC_137_RECENCY_BAND.WITHIN_3_MONTHS,
4354
- CVC_137_RECENCY_BAND.MONTHS_3_TO_6,
4355
- CVC_137_RECENCY_BAND.MONTHS_6_TO_12,
4356
- CVC_137_RECENCY_BAND.ONE_YEAR_OR_MORE,
4357
- CVC_137_RECENCY_BAND.LESS_THAN_3_YEARS,
4358
- CVC_137_RECENCY_BAND.YEARS_3_TO_10,
4359
- CVC_137_RECENCY_BAND.TEN_PLUS_YEARS
4360
- ];
4361
- var CVC_137_MISSINGNESS_VALUES = [
4362
- CVC_137_RECENCY_BAND.UNKNOWN,
4363
- CVC_137_RECENCY_BAND.DATA_NOT_COLLECTED,
4364
- CVC_137_RECENCY_BAND.ANONYMOUS,
4365
- CVC_137_RECENCY_BAND.PREFERS_NOT_TO_ANSWER
4366
- ];
4367
- var CVC_197_JUVENILE_JUSTICE_EPISODE = {
4368
- DIVERSION_PROGRAM: "diversion_program",
4369
- PROBATION_SUPERVISION: "probation_supervision",
4370
- PENDING_ADJUDICATION: "pending_adjudication",
4371
- DETENTION_STAY: "detention_stay",
4372
- RESIDENTIAL_JJ_PLACEMENT: "residential_jj_placement",
4373
- // Missingness values
4374
- DATA_NOT_COLLECTED: "DNC",
4375
- UNKNOWN: "UNK",
4376
- ANONYMOUS: "ANON"
4377
- };
4378
- var CVC_197_LABELS = {
4379
- [CVC_197_JUVENILE_JUSTICE_EPISODE.DIVERSION_PROGRAM]: "Diversion program",
4380
- [CVC_197_JUVENILE_JUSTICE_EPISODE.PROBATION_SUPERVISION]: "Probation supervision",
4381
- [CVC_197_JUVENILE_JUSTICE_EPISODE.PENDING_ADJUDICATION]: "Pending adjudication",
4382
- [CVC_197_JUVENILE_JUSTICE_EPISODE.DETENTION_STAY]: "Detention stay",
4383
- [CVC_197_JUVENILE_JUSTICE_EPISODE.RESIDENTIAL_JJ_PLACEMENT]: "Residential JJ placement",
4384
- [CVC_197_JUVENILE_JUSTICE_EPISODE.DATA_NOT_COLLECTED]: "Data not collected",
4385
- [CVC_197_JUVENILE_JUSTICE_EPISODE.UNKNOWN]: "Unknown",
4386
- [CVC_197_JUVENILE_JUSTICE_EPISODE.ANONYMOUS]: "Anonymous"
4387
- };
4388
- var CVC_197_VALUES = [
4389
- CVC_197_JUVENILE_JUSTICE_EPISODE.DIVERSION_PROGRAM,
4390
- CVC_197_JUVENILE_JUSTICE_EPISODE.PROBATION_SUPERVISION,
4391
- CVC_197_JUVENILE_JUSTICE_EPISODE.PENDING_ADJUDICATION,
4392
- CVC_197_JUVENILE_JUSTICE_EPISODE.DETENTION_STAY,
4393
- CVC_197_JUVENILE_JUSTICE_EPISODE.RESIDENTIAL_JJ_PLACEMENT,
4394
- CVC_197_JUVENILE_JUSTICE_EPISODE.DATA_NOT_COLLECTED,
4395
- CVC_197_JUVENILE_JUSTICE_EPISODE.UNKNOWN,
4396
- CVC_197_JUVENILE_JUSTICE_EPISODE.ANONYMOUS
4397
- ];
4398
- var CVC_197_SELECTABLE_VALUES = [
4399
- CVC_197_JUVENILE_JUSTICE_EPISODE.DIVERSION_PROGRAM,
4400
- CVC_197_JUVENILE_JUSTICE_EPISODE.PROBATION_SUPERVISION,
4401
- CVC_197_JUVENILE_JUSTICE_EPISODE.PENDING_ADJUDICATION,
4402
- CVC_197_JUVENILE_JUSTICE_EPISODE.DETENTION_STAY,
4403
- CVC_197_JUVENILE_JUSTICE_EPISODE.RESIDENTIAL_JJ_PLACEMENT
4404
- ];
4405
- var CVC_197_MISSINGNESS_VALUES = [
4406
- CVC_197_JUVENILE_JUSTICE_EPISODE.DATA_NOT_COLLECTED,
4407
- CVC_197_JUVENILE_JUSTICE_EPISODE.UNKNOWN,
4408
- CVC_197_JUVENILE_JUSTICE_EPISODE.ANONYMOUS
4409
- ];
4410
4282
 
4411
4283
  // src/constants/service-catalog.json
4412
4284
  var service_catalog_default = {
@@ -6033,11 +5905,6 @@ var FUNCTION_STATUS_LABELS = {
6033
5905
  CVC_136_OPTIONS,
6034
5906
  CVC_136_TYPE_TO_CATEGORY,
6035
5907
  CVC_136_VALUES,
6036
- CVC_137_LABELS,
6037
- CVC_137_MISSINGNESS_VALUES,
6038
- CVC_137_RECENCY_BAND,
6039
- CVC_137_SELECTABLE_VALUES,
6040
- CVC_137_VALUES,
6041
5908
  CVC_145_CATEGORY,
6042
5909
  CVC_145_CATEGORY_LABELS,
6043
5910
  CVC_145_CATEGORY_ORDER,
@@ -6117,7 +5984,6 @@ var FUNCTION_STATUS_LABELS = {
6117
5984
  CVC_17_LEVEL_1_OPTIONS,
6118
5985
  CVC_17_LEVEL_2_TRANSGENDER_OPTIONS,
6119
5986
  CVC_17_TRANSGENDER_VALUES,
6120
- CVC_17_VALUES,
6121
5987
  CVC_180_EDUCATION_LEVEL,
6122
5988
  CVC_180_LABELS,
6123
5989
  CVC_180_ORDINAL,
@@ -6127,11 +5993,6 @@ var FUNCTION_STATUS_LABELS = {
6127
5993
  CVC_196_CHILD_WELFARE_EPISODE_TYPE,
6128
5994
  CVC_196_LABELS,
6129
5995
  CVC_196_VALUES,
6130
- CVC_197_JUVENILE_JUSTICE_EPISODE,
6131
- CVC_197_LABELS,
6132
- CVC_197_MISSINGNESS_VALUES,
6133
- CVC_197_SELECTABLE_VALUES,
6134
- CVC_197_VALUES,
6135
5996
  CVC_1_LABELS,
6136
5997
  CVC_1_NAME_TYPE,
6137
5998
  CVC_1_STRUCTURED_NAME_TYPES,
@@ -6141,7 +6002,6 @@ var FUNCTION_STATUS_LABELS = {
6141
6002
  CVC_67_LABELS,
6142
6003
  CVC_67_MISSINGNESS_VALUES,
6143
6004
  CVC_67_SELECTABLE_VALUES,
6144
- CVC_67_VALUES,
6145
6005
  CVC_72_HT_TYPE,
6146
6006
  CVC_72_LABELS,
6147
6007
  CVC_72_VALUES,