@htilabs/platform-common-models 0.6.0 → 0.7.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/README.md +44 -0
  2. package/dist/config/index.cjs +191 -0
  3. package/dist/config/index.cjs.map +1 -0
  4. package/dist/config/index.d.cts +101 -0
  5. package/dist/config/index.d.ts +101 -0
  6. package/dist/config/index.js +165 -0
  7. package/dist/config/index.js.map +1 -0
  8. package/dist/constants/index.cjs +46 -5
  9. package/dist/constants/index.cjs.map +1 -1
  10. package/dist/constants/index.d.cts +1 -1
  11. package/dist/constants/index.d.ts +1 -1
  12. package/dist/constants/index.js +42 -5
  13. package/dist/constants/index.js.map +1 -1
  14. package/dist/cvcs/index.cjs +321 -0
  15. package/dist/cvcs/index.cjs.map +1 -1
  16. package/dist/cvcs/index.d.cts +789 -436
  17. package/dist/cvcs/index.d.ts +789 -436
  18. package/dist/cvcs/index.js +318 -0
  19. package/dist/cvcs/index.js.map +1 -1
  20. package/dist/index.cjs +424 -6
  21. package/dist/index.cjs.map +1 -1
  22. package/dist/index.d.cts +94 -3
  23. package/dist/index.d.ts +94 -3
  24. package/dist/index.js +412 -6
  25. package/dist/index.js.map +1 -1
  26. package/dist/{platform-auth-CjC57132.d.cts → platform-auth-C97LpsRd.d.cts} +8 -4
  27. package/dist/{platform-auth-CjC57132.d.ts → platform-auth-C97LpsRd.d.ts} +8 -4
  28. package/dist/schemas/index.cjs +43 -6
  29. package/dist/schemas/index.cjs.map +1 -1
  30. package/dist/schemas/index.d.cts +4 -0
  31. package/dist/schemas/index.d.ts +4 -0
  32. package/dist/schemas/index.js +43 -6
  33. package/dist/schemas/index.js.map +1 -1
  34. package/dist/types/index.d.cts +2 -2
  35. package/dist/types/index.d.ts +2 -2
  36. package/package.json +9 -2
  37. package/src/__tests__/__snapshots__/cvc-sot.snap +12 -0
  38. package/src/__tests__/cvc-sot-snapshot.test.ts +24 -0
  39. package/src/__tests__/cvc-structural.test.ts +3 -0
  40. package/src/__tests__/runtime-contract-validator.test.ts +556 -0
  41. package/src/config/fixtures/valid.yaml +90 -0
  42. package/src/config/index.ts +352 -0
  43. package/src/constants/ic.ts +49 -6
  44. package/src/cvcs/hmisSex.v1.0.0.json +89 -0
  45. package/src/cvcs/index.ts +6 -0
  46. package/src/cvcs/juvenileJusticeEpisodeType.v1.0.0.json +96 -0
  47. package/src/cvcs/recencyBand.v1.0.0.json +124 -0
  48. package/src/generated/cvc-enums.ts +59 -0
  49. package/src/index.ts +20 -0
  50. package/src/schemas/common.ts +4 -0
@@ -76,6 +76,7 @@ declare const personNameSchema: Schema<any, mongoose.Model<any, any, any, any, a
76
76
  isPrimary?: boolean | null | undefined;
77
77
  isUnknown?: boolean | null | undefined;
78
78
  isAnonymous?: boolean | null | undefined;
79
+ isMononym?: boolean | null | undefined;
79
80
  }, mongoose.Document<unknown, {}, {
80
81
  alias?: boolean | null | undefined;
81
82
  firstName?: string | null | undefined;
@@ -86,6 +87,7 @@ declare const personNameSchema: Schema<any, mongoose.Model<any, any, any, any, a
86
87
  isPrimary?: boolean | null | undefined;
87
88
  isUnknown?: boolean | null | undefined;
88
89
  isAnonymous?: boolean | null | undefined;
90
+ isMononym?: boolean | null | undefined;
89
91
  }, {
90
92
  id: string;
91
93
  }, Omit<mongoose.DefaultSchemaOptions, "_id"> & {
@@ -100,6 +102,7 @@ declare const personNameSchema: Schema<any, mongoose.Model<any, any, any, any, a
100
102
  isPrimary?: boolean | null | undefined;
101
103
  isUnknown?: boolean | null | undefined;
102
104
  isAnonymous?: boolean | null | undefined;
105
+ isMononym?: boolean | null | undefined;
103
106
  } & {
104
107
  _id: mongoose.Types.ObjectId;
105
108
  } & {
@@ -116,6 +119,7 @@ declare const personNameSchema: Schema<any, mongoose.Model<any, any, any, any, a
116
119
  isPrimary?: boolean | null | undefined;
117
120
  isUnknown?: boolean | null | undefined;
118
121
  isAnonymous?: boolean | null | undefined;
122
+ isMononym?: boolean | null | undefined;
119
123
  } & {
120
124
  _id: mongoose.Types.ObjectId;
121
125
  } & {
@@ -76,6 +76,7 @@ declare const personNameSchema: Schema<any, mongoose.Model<any, any, any, any, a
76
76
  isPrimary?: boolean | null | undefined;
77
77
  isUnknown?: boolean | null | undefined;
78
78
  isAnonymous?: boolean | null | undefined;
79
+ isMononym?: boolean | null | undefined;
79
80
  }, mongoose.Document<unknown, {}, {
80
81
  alias?: boolean | null | undefined;
81
82
  firstName?: string | null | undefined;
@@ -86,6 +87,7 @@ declare const personNameSchema: Schema<any, mongoose.Model<any, any, any, any, a
86
87
  isPrimary?: boolean | null | undefined;
87
88
  isUnknown?: boolean | null | undefined;
88
89
  isAnonymous?: boolean | null | undefined;
90
+ isMononym?: boolean | null | undefined;
89
91
  }, {
90
92
  id: string;
91
93
  }, Omit<mongoose.DefaultSchemaOptions, "_id"> & {
@@ -100,6 +102,7 @@ declare const personNameSchema: Schema<any, mongoose.Model<any, any, any, any, a
100
102
  isPrimary?: boolean | null | undefined;
101
103
  isUnknown?: boolean | null | undefined;
102
104
  isAnonymous?: boolean | null | undefined;
105
+ isMononym?: boolean | null | undefined;
103
106
  } & {
104
107
  _id: mongoose.Types.ObjectId;
105
108
  } & {
@@ -116,6 +119,7 @@ declare const personNameSchema: Schema<any, mongoose.Model<any, any, any, any, a
116
119
  isPrimary?: boolean | null | undefined;
117
120
  isUnknown?: boolean | null | undefined;
118
121
  isAnonymous?: boolean | null | undefined;
122
+ isMononym?: boolean | null | undefined;
119
123
  } & {
120
124
  _id: mongoose.Types.ObjectId;
121
125
  } & {
@@ -32,8 +32,6 @@ var CVC_1_NAME_TYPE = {
32
32
  ALIAS: "alias",
33
33
  /** Trade name / business name - single unstructured name field */
34
34
  TRADE_NAME: "trade_name",
35
- /** Single-word name (e.g., "Madonna", "Prince") - single unstructured name field */
36
- MONONYM: "mononym",
37
35
  /** Nickname - single unstructured name field */
38
36
  NICKNAME: "nickname",
39
37
  /** Online handle or username - single unstructured name field */
@@ -45,7 +43,6 @@ var CVC_1_VALUES = [
45
43
  CVC_1_NAME_TYPE.LEGAL,
46
44
  CVC_1_NAME_TYPE.ALIAS,
47
45
  CVC_1_NAME_TYPE.TRADE_NAME,
48
- CVC_1_NAME_TYPE.MONONYM,
49
46
  CVC_1_NAME_TYPE.NICKNAME,
50
47
  CVC_1_NAME_TYPE.HANDLE,
51
48
  CVC_1_NAME_TYPE.UNKNOWN
@@ -54,7 +51,6 @@ var CVC_1_LABELS = {
54
51
  [CVC_1_NAME_TYPE.LEGAL]: "Legal Name",
55
52
  [CVC_1_NAME_TYPE.ALIAS]: "Alias / AKA",
56
53
  [CVC_1_NAME_TYPE.TRADE_NAME]: "Trade Name",
57
- [CVC_1_NAME_TYPE.MONONYM]: "Mononym",
58
54
  [CVC_1_NAME_TYPE.NICKNAME]: "Nickname",
59
55
  [CVC_1_NAME_TYPE.HANDLE]: "Handle / Username",
60
56
  [CVC_1_NAME_TYPE.UNKNOWN]: "Unknown"
@@ -65,7 +61,6 @@ var CVC_1_STRUCTURED_NAME_TYPES = [
65
61
  var CVC_1_UNSTRUCTURED_NAME_TYPES = [
66
62
  CVC_1_NAME_TYPE.ALIAS,
67
63
  CVC_1_NAME_TYPE.TRADE_NAME,
68
- CVC_1_NAME_TYPE.MONONYM,
69
64
  CVC_1_NAME_TYPE.NICKNAME,
70
65
  CVC_1_NAME_TYPE.HANDLE,
71
66
  CVC_1_NAME_TYPE.UNKNOWN
@@ -588,7 +583,10 @@ var CVC_17_CORE_GENDER_IDENTITY = {
588
583
  TRANSGENDER: "TRANSGENDER",
589
584
  NON_BINARY: "NON_BINARY",
590
585
  OTHER: "OTHER",
586
+ // Level 0 - Missingness codes (codebook canonical set)
591
587
  UNKNOWN: "UNK",
588
+ DATA_NOT_COLLECTED: "DNC",
589
+ PREFER_NOT_TO_ANSWER: "PNA",
592
590
  // Level 2 - Transgender subcategories
593
591
  TRANSGENDER_FTM: "TRANSGENDER_FTM",
594
592
  TRANSGENDER_MTF: "TRANSGENDER_MTF"
@@ -600,6 +598,8 @@ var CVC_17_LABELS = {
600
598
  [CVC_17_CORE_GENDER_IDENTITY.NON_BINARY]: "Non-Binary",
601
599
  [CVC_17_CORE_GENDER_IDENTITY.OTHER]: "Other",
602
600
  [CVC_17_CORE_GENDER_IDENTITY.UNKNOWN]: "Unknown",
601
+ [CVC_17_CORE_GENDER_IDENTITY.DATA_NOT_COLLECTED]: "Data not collected",
602
+ [CVC_17_CORE_GENDER_IDENTITY.PREFER_NOT_TO_ANSWER]: "Client prefers not to answer",
603
603
  [CVC_17_CORE_GENDER_IDENTITY.TRANSGENDER_FTM]: "Transgender - FTM",
604
604
  [CVC_17_CORE_GENDER_IDENTITY.TRANSGENDER_MTF]: "Transgender - MTF"
605
605
  };
@@ -620,6 +620,32 @@ var CVC_17_TRANSGENDER_VALUES = [
620
620
  CVC_17_CORE_GENDER_IDENTITY.TRANSGENDER_FTM,
621
621
  CVC_17_CORE_GENDER_IDENTITY.TRANSGENDER_MTF
622
622
  ];
623
+ var CVC_17_SELECTABLE_VALUES = [
624
+ CVC_17_CORE_GENDER_IDENTITY.MALE,
625
+ CVC_17_CORE_GENDER_IDENTITY.FEMALE,
626
+ CVC_17_CORE_GENDER_IDENTITY.TRANSGENDER,
627
+ CVC_17_CORE_GENDER_IDENTITY.TRANSGENDER_FTM,
628
+ CVC_17_CORE_GENDER_IDENTITY.TRANSGENDER_MTF,
629
+ CVC_17_CORE_GENDER_IDENTITY.NON_BINARY,
630
+ CVC_17_CORE_GENDER_IDENTITY.OTHER
631
+ ];
632
+ var CVC_17_MISSINGNESS_VALUES = [
633
+ CVC_17_CORE_GENDER_IDENTITY.UNKNOWN,
634
+ CVC_17_CORE_GENDER_IDENTITY.DATA_NOT_COLLECTED,
635
+ CVC_17_CORE_GENDER_IDENTITY.PREFER_NOT_TO_ANSWER
636
+ ];
637
+ var CVC_17_VALUES = [
638
+ CVC_17_CORE_GENDER_IDENTITY.MALE,
639
+ CVC_17_CORE_GENDER_IDENTITY.FEMALE,
640
+ CVC_17_CORE_GENDER_IDENTITY.TRANSGENDER,
641
+ CVC_17_CORE_GENDER_IDENTITY.NON_BINARY,
642
+ CVC_17_CORE_GENDER_IDENTITY.OTHER,
643
+ CVC_17_CORE_GENDER_IDENTITY.UNKNOWN,
644
+ CVC_17_CORE_GENDER_IDENTITY.DATA_NOT_COLLECTED,
645
+ CVC_17_CORE_GENDER_IDENTITY.PREFER_NOT_TO_ANSWER,
646
+ CVC_17_CORE_GENDER_IDENTITY.TRANSGENDER_FTM,
647
+ CVC_17_CORE_GENDER_IDENTITY.TRANSGENDER_MTF
648
+ ];
623
649
  var IC_24_RACE = {
624
650
  AMERICAN_INDIAN_ALASKA_NATIVE: 1,
625
651
  ASIAN: 2,
@@ -3473,6 +3499,13 @@ var CVC_67_SELECTABLE_VALUES = [
3473
3499
  var CVC_67_MISSINGNESS_VALUES = [
3474
3500
  CVC_67_HMIS_SEX.DATA_NOT_COLLECTED
3475
3501
  ];
3502
+ var CVC_67_VALUES = [
3503
+ CVC_67_HMIS_SEX.MALE,
3504
+ CVC_67_HMIS_SEX.FEMALE,
3505
+ CVC_67_HMIS_SEX.CLIENT_PREFERS_NOT_TO_ANSWER,
3506
+ CVC_67_HMIS_SEX.CLIENT_DOESNT_KNOW,
3507
+ CVC_67_HMIS_SEX.DATA_NOT_COLLECTED
3508
+ ];
3476
3509
 
3477
3510
  // src/schemas/common.ts
3478
3511
  var addressSchema = new Schema(
@@ -3500,7 +3533,11 @@ var personNameSchema = new Schema(
3500
3533
  isPrimary: Boolean,
3501
3534
  alias: Boolean,
3502
3535
  isUnknown: Boolean,
3503
- isAnonymous: Boolean
3536
+ isAnonymous: Boolean,
3537
+ // Shape flag: this person has only one name (e.g., Madonna). A mononym
3538
+ // can itself be legal, a nickname, a trade name, etc. — it's orthogonal
3539
+ // to nameType, not a value of it.
3540
+ isMononym: Boolean
3504
3541
  },
3505
3542
  { _id: false }
3506
3543
  );