@htilabs/platform-common-models 0.8.1 → 0.8.4

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 (38) hide show
  1. package/dist/constants/index.cjs +28 -5
  2. package/dist/constants/index.cjs.map +1 -1
  3. package/dist/constants/index.d.cts +1 -1
  4. package/dist/constants/index.d.ts +1 -1
  5. package/dist/constants/index.js +27 -5
  6. package/dist/constants/index.js.map +1 -1
  7. package/dist/cvcs/index.cjs +335 -3
  8. package/dist/cvcs/index.cjs.map +1 -1
  9. package/dist/cvcs/index.d.cts +1621 -1255
  10. package/dist/cvcs/index.d.ts +1621 -1255
  11. package/dist/cvcs/index.js +333 -3
  12. package/dist/cvcs/index.js.map +1 -1
  13. package/dist/index.cjs +406 -11
  14. package/dist/index.cjs.map +1 -1
  15. package/dist/index.d.cts +54 -6
  16. package/dist/index.d.ts +54 -6
  17. package/dist/index.js +401 -11
  18. package/dist/index.js.map +1 -1
  19. package/dist/{platform-auth-7dL99tZh.d.cts → platform-auth-BdnJUisw.d.cts} +16 -3
  20. package/dist/{platform-auth-7dL99tZh.d.ts → platform-auth-BdnJUisw.d.ts} +16 -3
  21. package/dist/schemas/index.cjs +25 -4
  22. package/dist/schemas/index.cjs.map +1 -1
  23. package/dist/schemas/index.js +25 -4
  24. package/dist/schemas/index.js.map +1 -1
  25. package/dist/types/index.d.cts +2 -2
  26. package/dist/types/index.d.ts +2 -2
  27. package/package.json +1 -1
  28. package/src/__tests__/__snapshots__/cvc-sot.snap +14 -6
  29. package/src/__tests__/cvc-sot-snapshot.test.ts +27 -7
  30. package/src/__tests__/cvc-structural.test.ts +2 -0
  31. package/src/constants/ic.ts +31 -3
  32. package/src/cvcs/highestEducationLevelCompleted.v1.0.0.json +9 -0
  33. package/src/cvcs/housingSubsidyTypes.v1.0.0.json +159 -0
  34. package/src/cvcs/incomeBenefitsSources.v1.0.0.json +31 -2
  35. package/src/cvcs/index.ts +4 -0
  36. package/src/cvcs/recencyBand.v1.0.0.json +105 -0
  37. package/src/cvcs/serviceStates.v1.0.0.json +23 -1
  38. package/src/generated/cvc-enums.ts +55 -3
@@ -2152,7 +2152,9 @@ var serviceStates_v1_0_0_default = {
2152
2152
  "049-007-001-000-000-000-000",
2153
2153
  "049-007-002-000-000-000-000",
2154
2154
  "049-007-003-000-000-000-000",
2155
- "049-007-004-000-000-000-000"
2155
+ "049-007-004-000-000-000-000",
2156
+ "049-007-005-000-000-000-000",
2157
+ "049-007-006-000-000-000-000"
2156
2158
  ],
2157
2159
  definition: "Program could not provide the service."
2158
2160
  },
@@ -2192,6 +2194,26 @@ var serviceStates_v1_0_0_default = {
2192
2194
  childCodes: [],
2193
2195
  definition: "Program could not provide the Service for a reason other than eligibility, capacity, or resources."
2194
2196
  },
2197
+ {
2198
+ code: "049-007-005-000-000-000-000",
2199
+ key: "unable_to_provide_service_fit",
2200
+ title: "Unable due to service fit",
2201
+ selectable: true,
2202
+ parentCode: "049-007-000-000-000-000-000",
2203
+ childCodes: [],
2204
+ definition: "Program's services were not an appropriate fit for the client's presenting needs.",
2205
+ provisional: true
2206
+ },
2207
+ {
2208
+ code: "049-007-006-000-000-000-000",
2209
+ key: "unable_to_provide_access_barrier",
2210
+ title: "Unable due to access barrier",
2211
+ selectable: true,
2212
+ parentCode: "049-007-000-000-000-000-000",
2213
+ childCodes: [],
2214
+ definition: "An access barrier (e.g. language, transportation, location, hours, technology) prevented service delivery.",
2215
+ provisional: true
2216
+ },
2195
2217
  {
2196
2218
  code: "049-000-000-000-000-000-000",
2197
2219
  key: "missingness_root",
@@ -7001,6 +7023,15 @@ var highestEducationLevelCompleted_v1_0_0_default = {
7001
7023
  childCodes: [],
7002
7024
  definition: "Completed a master's, doctoral, or professional degree (MA, MS, MBA, JD, MD, PhD, or equivalent). Aligns with Census/ACS 'Graduate or professional degree'."
7003
7025
  },
7026
+ {
7027
+ code: "180-008-000-000-000-000-000",
7028
+ key: "trade_vocational",
7029
+ title: "Trade or vocational credential",
7030
+ selectable: true,
7031
+ parentCode: null,
7032
+ childCodes: [],
7033
+ definition: "Completed a trade, vocational, or technical credential (apprenticeship, licensure, or postsecondary non-degree award) rather than an academic degree."
7034
+ },
7004
7035
  {
7005
7036
  code: "180-000-000-000-000-000-000",
7006
7037
  key: "missingness_root",
@@ -10700,7 +10731,8 @@ var incomeBenefitsSources_v1_0_0_default = {
10700
10731
  selectable: false,
10701
10732
  parentCode: null,
10702
10733
  childCodes: [
10703
- "171-001-001-000-000-000-000"
10734
+ "171-001-001-000-000-000-000",
10735
+ "171-001-002-000-000-000-000"
10704
10736
  ],
10705
10737
  definition: "Income from wages, salary, tips, gig/contract work, or other paid employment."
10706
10738
  },
@@ -10713,6 +10745,15 @@ var incomeBenefitsSources_v1_0_0_default = {
10713
10745
  childCodes: [],
10714
10746
  definition: "Income from wages, salary, tips, gig/contract work, or other paid employment. Includes informal earned income that is not supported by official documentation."
10715
10747
  },
10748
+ {
10749
+ code: "171-001-002-000-000-000-000",
10750
+ key: "informal_income",
10751
+ title: "Informal / undocumented income",
10752
+ selectable: true,
10753
+ parentCode: "171-001-000-000-000-000-000",
10754
+ childCodes: [],
10755
+ definition: "Informal or undocumented income, e.g. cash work or side activity not captured by formal employment or a benefit program."
10756
+ },
10716
10757
  {
10717
10758
  code: "171-002-000-000-000-000-000",
10718
10759
  key: "cash_benefit",
@@ -10961,7 +11002,8 @@ var incomeBenefitsSources_v1_0_0_default = {
10961
11002
  parentCode: null,
10962
11003
  childCodes: [
10963
11004
  "171-004-001-000-000-000-000",
10964
- "171-004-002-000-000-000-000"
11005
+ "171-004-002-000-000-000-000",
11006
+ "171-004-003-000-000-000-000"
10965
11007
  ],
10966
11008
  definition: "Income received as interpersonal transfers or support payments (e.g., child support, spousal support)."
10967
11009
  },
@@ -10983,6 +11025,15 @@ var incomeBenefitsSources_v1_0_0_default = {
10983
11025
  childCodes: [],
10984
11026
  definition: "All periodic payments received from an ex-spouse as alimony or spousal support. Excludes one-time property settlements."
10985
11027
  },
11028
+ {
11029
+ code: "171-004-003-000-000-000-000",
11030
+ key: "family_friend_support",
11031
+ title: "Family / friend financial support",
11032
+ selectable: true,
11033
+ parentCode: "171-004-000-000-000-000-000",
11034
+ childCodes: [],
11035
+ definition: "Informal financial support from family or friends, not a documented benefit program."
11036
+ },
10986
11037
  {
10987
11038
  code: "171-005-000-000-000-000-000",
10988
11039
  key: "other_unspecified",
@@ -11022,6 +11073,15 @@ var incomeBenefitsSources_v1_0_0_default = {
11022
11073
  parentCode: "171-005-000-000-000-000-000",
11023
11074
  childCodes: [],
11024
11075
  definition: "Income received as a stipend, scholarship refund, training allowance, or other education-related payment that can function as income for living expenses. Funder-specific exclusions may apply (e.g., SSVF)."
11076
+ },
11077
+ {
11078
+ code: "171-006-000-000-000-000-000",
11079
+ key: "victim_compensation",
11080
+ title: "Crime victim compensation",
11081
+ selectable: true,
11082
+ parentCode: null,
11083
+ childCodes: [],
11084
+ definition: "Income or benefits from a state or federal crime-victim compensation program (e.g. VOCA-funded victim compensation)."
11025
11085
  }
11026
11086
  ]
11027
11087
  };
@@ -23427,6 +23487,274 @@ var relationshipConcern_v1_0_0_default = {
23427
23487
  }
23428
23488
  ]
23429
23489
  };
23490
+
23491
+ // src/cvcs/recencyBand.v1.0.0.json
23492
+ var recencyBand_v1_0_0_default = {
23493
+ domain: "recency_band",
23494
+ name: "Core Recency Band (PROVISIONAL CVC-232 \u2014 pending codebook ratification)",
23495
+ version: "1.0.0",
23496
+ levels: {
23497
+ "0": "Unknown or Missing",
23498
+ "1": "Recency band"
23499
+ },
23500
+ entries: [
23501
+ {
23502
+ code: "232-000-000-000-000-000-000",
23503
+ key: "missingness_root",
23504
+ title: "Unknown, Redacted, or Missing",
23505
+ selectable: false,
23506
+ parentCode: null,
23507
+ childCodes: [
23508
+ "232-000-000-000-000-000-001",
23509
+ "232-000-000-000-000-000-002",
23510
+ "232-000-000-000-000-000-003"
23511
+ ],
23512
+ definition: "Root group for values indicating absent, withheld, or uncollected data."
23513
+ },
23514
+ {
23515
+ code: "232-000-000-000-000-000-001",
23516
+ key: "unknown",
23517
+ title: "Unknown / not captured",
23518
+ selectable: true,
23519
+ parentCode: "232-000-000-000-000-000-000",
23520
+ childCodes: [],
23521
+ definition: "The recency band is unknown or cannot be determined from the available information."
23522
+ },
23523
+ {
23524
+ code: "232-000-000-000-000-000-002",
23525
+ key: "anonymous",
23526
+ title: "Anonymous / declined to answer",
23527
+ selectable: true,
23528
+ parentCode: "232-000-000-000-000-000-000",
23529
+ childCodes: [],
23530
+ definition: "The recency band may be withheld by preference or due to redaction; identity is anonymous or redacted."
23531
+ },
23532
+ {
23533
+ code: "232-000-000-000-000-000-003",
23534
+ key: "data_not_collected",
23535
+ title: "Data not collected",
23536
+ selectable: true,
23537
+ parentCode: "232-000-000-000-000-000-000",
23538
+ childCodes: [],
23539
+ definition: "No attempt was made to collect the recency band."
23540
+ },
23541
+ {
23542
+ code: "232-001-000-000-000-000-000",
23543
+ key: "within_3_months",
23544
+ title: "Within the last 3 months",
23545
+ selectable: true,
23546
+ parentCode: null,
23547
+ childCodes: [],
23548
+ definition: "The event or condition occurred within the most recent 3 months (0 up to and including 3 months before time_as_of)."
23549
+ },
23550
+ {
23551
+ code: "232-002-000-000-000-000-000",
23552
+ key: "months_3_to_6",
23553
+ title: "3 to 6 months ago",
23554
+ selectable: true,
23555
+ parentCode: null,
23556
+ childCodes: [],
23557
+ definition: "The event or condition occurred more than 3 and up to and including 6 months before time_as_of."
23558
+ },
23559
+ {
23560
+ code: "232-003-000-000-000-000-000",
23561
+ key: "months_6_to_12",
23562
+ title: "6 to 12 months ago",
23563
+ selectable: true,
23564
+ parentCode: null,
23565
+ childCodes: [],
23566
+ definition: "The event or condition occurred more than 6 and up to and including 12 months before time_as_of."
23567
+ },
23568
+ {
23569
+ code: "232-004-000-000-000-000-000",
23570
+ key: "one_year_or_more",
23571
+ title: "1 year or more ago",
23572
+ selectable: true,
23573
+ parentCode: null,
23574
+ childCodes: [],
23575
+ definition: "The event or condition occurred at least 1 year before time_as_of. Use a finer-grained band (years_3_to_10 or ten_plus_years) when the source supports it."
23576
+ },
23577
+ {
23578
+ code: "232-005-000-000-000-000-000",
23579
+ key: "years_3_to_10",
23580
+ title: "3 to 10 years ago",
23581
+ selectable: true,
23582
+ parentCode: null,
23583
+ childCodes: [],
23584
+ definition: "The event or condition occurred more than 3 and up to and including 10 years before time_as_of."
23585
+ },
23586
+ {
23587
+ code: "232-006-000-000-000-000-000",
23588
+ key: "ten_plus_years",
23589
+ title: "More than 10 years ago",
23590
+ selectable: true,
23591
+ parentCode: null,
23592
+ childCodes: [],
23593
+ definition: "The event or condition occurred more than 10 years before time_as_of."
23594
+ }
23595
+ ]
23596
+ };
23597
+
23598
+ // src/cvcs/housingSubsidyTypes.v1.0.0.json
23599
+ var housingSubsidyTypes_v1_0_0_default = {
23600
+ domain: "housing_subsidy_types",
23601
+ name: "Core Housing Subsidy Types (PROVISIONAL CVC-233 \u2014 pending codebook ratification)",
23602
+ version: "1.0.0",
23603
+ levels: {
23604
+ "0": "Unknown or Missing",
23605
+ "1": "Housing subsidy type"
23606
+ },
23607
+ entries: [
23608
+ {
23609
+ code: "233-000-000-000-000-000-000",
23610
+ key: "missingness_root",
23611
+ title: "Unknown, Redacted, or Missing",
23612
+ selectable: false,
23613
+ parentCode: null,
23614
+ childCodes: [
23615
+ "233-000-000-000-000-000-001",
23616
+ "233-000-000-000-000-000-002",
23617
+ "233-000-000-000-000-000-003"
23618
+ ],
23619
+ definition: "Root group for values indicating absent, withheld, or uncollected data."
23620
+ },
23621
+ {
23622
+ code: "233-000-000-000-000-000-001",
23623
+ key: "unknown",
23624
+ title: "Unknown / not captured",
23625
+ selectable: true,
23626
+ parentCode: "233-000-000-000-000-000-000",
23627
+ childCodes: [],
23628
+ definition: "The housing subsidy type is unknown or cannot be determined from the available information."
23629
+ },
23630
+ {
23631
+ code: "233-000-000-000-000-000-002",
23632
+ key: "anonymous",
23633
+ title: "Anonymous / declined to answer",
23634
+ selectable: true,
23635
+ parentCode: "233-000-000-000-000-000-000",
23636
+ childCodes: [],
23637
+ definition: "The housing subsidy type may be withheld by preference or due to redaction; identity is anonymous or redacted."
23638
+ },
23639
+ {
23640
+ code: "233-000-000-000-000-000-003",
23641
+ key: "data_not_collected",
23642
+ title: "Data not collected",
23643
+ selectable: true,
23644
+ parentCode: "233-000-000-000-000-000-000",
23645
+ childCodes: [],
23646
+ definition: "No attempt was made to collect the housing subsidy type."
23647
+ },
23648
+ {
23649
+ code: "233-001-000-000-000-000-000",
23650
+ key: "housing_choice_voucher",
23651
+ title: "Housing Choice Voucher (Section 8 HCV)",
23652
+ selectable: true,
23653
+ parentCode: null,
23654
+ childCodes: [],
23655
+ definition: "Tenant-based rental assistance through the HUD Housing Choice Voucher program (Section 8 HCV), which subsidizes rent in private-market units chosen by the tenant."
23656
+ },
23657
+ {
23658
+ code: "233-002-000-000-000-000-000",
23659
+ key: "public_housing",
23660
+ title: "Public housing",
23661
+ selectable: true,
23662
+ parentCode: null,
23663
+ childCodes: [],
23664
+ definition: "Residence in a public housing unit owned and operated by a public housing authority (PHA), with rent set as a subsidized share of household income."
23665
+ },
23666
+ {
23667
+ code: "233-003-000-000-000-000-000",
23668
+ key: "project_based_rental_assistance",
23669
+ title: "Project-based rental assistance",
23670
+ selectable: true,
23671
+ parentCode: null,
23672
+ childCodes: [],
23673
+ definition: "Rental assistance tied to a specific housing development or unit (e.g. project-based Section 8, project-based vouchers, or other site-based subsidy) rather than to the tenant."
23674
+ },
23675
+ {
23676
+ code: "233-004-000-000-000-000-000",
23677
+ key: "permanent_supportive_housing",
23678
+ title: "Permanent supportive housing (PSH)",
23679
+ selectable: true,
23680
+ parentCode: null,
23681
+ childCodes: [],
23682
+ definition: "Permanent housing that pairs a long-term rental subsidy with voluntary supportive services for people with disabilities or chronic homelessness (HUD CoC PSH)."
23683
+ },
23684
+ {
23685
+ code: "233-005-000-000-000-000-000",
23686
+ key: "rapid_rehousing_assistance",
23687
+ title: "Rapid re-housing assistance",
23688
+ selectable: true,
23689
+ parentCode: null,
23690
+ childCodes: [],
23691
+ definition: "Time-limited rental assistance and housing-stabilization services to help a household quickly exit homelessness into permanent housing (HUD CoC/ESG rapid re-housing)."
23692
+ },
23693
+ {
23694
+ code: "233-008-000-000-000-000-000",
23695
+ key: "va_supportive_housing",
23696
+ title: "VA Supportive Housing (HUD-VASH)",
23697
+ selectable: true,
23698
+ parentCode: null,
23699
+ childCodes: [],
23700
+ definition: "HUD-VASH: a HUD Housing Choice Voucher paired with VA case management and clinical services for homeless Veterans."
23701
+ },
23702
+ {
23703
+ code: "233-009-000-000-000-000-000",
23704
+ key: "grant_per_diem_transition_in_place",
23705
+ title: "Grant and Per Diem Transition-in-Place (GPD TIP)",
23706
+ selectable: true,
23707
+ parentCode: null,
23708
+ childCodes: [],
23709
+ definition: "VA Grant and Per Diem Transition-in-Place: transitional housing that converts to permanent housing for the Veteran in the same unit."
23710
+ },
23711
+ {
23712
+ code: "233-010-000-000-000-000-000",
23713
+ key: "housing_stability_voucher",
23714
+ title: "Housing Stability Voucher (HSV)",
23715
+ selectable: true,
23716
+ parentCode: null,
23717
+ childCodes: [],
23718
+ definition: "Housing Stability Voucher: rental assistance for individuals and families who are homeless, at risk of homelessness, or fleeing domestic violence."
23719
+ },
23720
+ {
23721
+ code: "233-011-000-000-000-000-000",
23722
+ key: "family_unification_program",
23723
+ title: "Family Unification Program (FUP)",
23724
+ selectable: true,
23725
+ parentCode: null,
23726
+ childCodes: [],
23727
+ definition: "Family Unification Program: HUD vouchers for families at risk of child-welfare separation and for eligible youth aging out of foster care."
23728
+ },
23729
+ {
23730
+ code: "233-012-000-000-000-000-000",
23731
+ key: "foster_youth_to_independence",
23732
+ title: "Foster Youth to Independence (FYI)",
23733
+ selectable: true,
23734
+ parentCode: null,
23735
+ childCodes: [],
23736
+ definition: "Foster Youth to Independence: HUD vouchers for youth aging out of foster care who are homeless or at risk of homelessness."
23737
+ },
23738
+ {
23739
+ code: "233-006-000-000-000-000-000",
23740
+ key: "other_housing_subsidy",
23741
+ title: "Other housing subsidy",
23742
+ selectable: true,
23743
+ parentCode: null,
23744
+ childCodes: [],
23745
+ definition: "A housing subsidy or rental-assistance program not covered by the other codes (e.g. state or local subsidy, HOME TBRA, or other program). Record program name and free-text detail alongside this code to preserve analytic value."
23746
+ },
23747
+ {
23748
+ code: "233-007-000-000-000-000-000",
23749
+ key: "no_subsidy",
23750
+ title: "No housing subsidy",
23751
+ selectable: true,
23752
+ parentCode: null,
23753
+ childCodes: [],
23754
+ definition: "The household receives no housing subsidy or rental assistance (housing costs are paid in full without a subsidy)."
23755
+ }
23756
+ ]
23757
+ };
23430
23758
  export {
23431
23759
  accommodationType_v1_0_0_default as accommodationTypeSot,
23432
23760
  actionStepCompletionStatus_v1_0_0_default as actionStepCompletionStatusSot,
@@ -23479,6 +23807,7 @@ export {
23479
23807
  hopeScaleCaptureContext_v1_0_0_default as hopeScaleCaptureContextSot,
23480
23808
  hopeScaleResponseOptions_v1_0_0_default as hopeScaleResponseOptionsSot,
23481
23809
  hopeScaleTier_v1_0_0_default as hopeScaleTierSot,
23810
+ housingSubsidyTypes_v1_0_0_default as housingSubsidyTypesSot,
23482
23811
  htType_v1_0_0_default as htTypeSot,
23483
23812
  identificationStatus_v1_0_0_default as identificationStatusSot,
23484
23813
  incidentInvolvementRoles_v1_0_0_default as incidentInvolvementRolesSot,
@@ -23513,6 +23842,7 @@ export {
23513
23842
  proofOfIdType_v1_0_0_default as proofOfIdTypeSot,
23514
23843
  qualityFlags_v1_0_0_default as qualityFlagsSot,
23515
23844
  raceEthnicity_v1_0_0_default as raceEthnicitySot,
23845
+ recencyBand_v1_0_0_default as recencyBandSot,
23516
23846
  referenceLinkType_v1_0_0_default as referenceLinkTypeSot,
23517
23847
  referralEntityCategory_v1_0_0_default as referralEntityCategorySot,
23518
23848
  relationshipConcern_v1_0_0_default as relationshipConcernSot,