@twin.org/standards-unece 0.0.3-next.37 → 0.0.3-next.39

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 (61) hide show
  1. package/dist/es/helpers/unCodeLists.js +85 -0
  2. package/dist/es/helpers/unCodeLists.js.map +1 -0
  3. package/dist/es/index.js +2 -0
  4. package/dist/es/index.js.map +1 -1
  5. package/dist/es/models/bsp/IUneceAirFlowUnitMeasureType.js.map +1 -1
  6. package/dist/es/models/bsp/IUneceAmountType.js.map +1 -1
  7. package/dist/es/models/bsp/IUneceDurationUnitMeasureType.js.map +1 -1
  8. package/dist/es/models/bsp/IUneceFileSizeUnitMeasureType.js.map +1 -1
  9. package/dist/es/models/bsp/IUneceLinearUnitMeasureType.js.map +1 -1
  10. package/dist/es/models/bsp/IUneceMeasureType.js.map +1 -1
  11. package/dist/es/models/bsp/IUneceQuantityType.js.map +1 -1
  12. package/dist/es/models/bsp/IUneceTemperatureUnitMeasureType.js.map +1 -1
  13. package/dist/es/models/bsp/IUneceUnitMeasureType.js.map +1 -1
  14. package/dist/es/models/bsp/IUneceVolumeUnitMeasureType.js.map +1 -1
  15. package/dist/es/models/bsp/IUneceWeightUnitMeasureType.js.map +1 -1
  16. package/dist/es/models/uneceCodeLists.js +717 -0
  17. package/dist/es/models/uneceCodeLists.js.map +1 -0
  18. package/dist/es/schemas/UneceAirFlowUnitMeasureType.json +1 -1
  19. package/dist/es/schemas/UneceAmountType.json +1 -1
  20. package/dist/es/schemas/UneceDurationUnitMeasureType.json +1 -1
  21. package/dist/es/schemas/UneceFileSizeUnitMeasureType.json +1 -1
  22. package/dist/es/schemas/UneceLinearUnitMeasureType.json +1 -1
  23. package/dist/es/schemas/UneceMeasureType.json +1 -1
  24. package/dist/es/schemas/UneceQuantityType.json +1 -1
  25. package/dist/es/schemas/UneceTemperatureUnitMeasureType.json +1 -1
  26. package/dist/es/schemas/UneceUnitMeasureType.json +1 -1
  27. package/dist/es/schemas/UneceVolumeUnitMeasureType.json +1 -1
  28. package/dist/es/schemas/UneceWeightUnitMeasureType.json +1 -1
  29. package/dist/types/helpers/unCodeLists.d.ts +24 -0
  30. package/dist/types/index.d.ts +2 -0
  31. package/dist/types/models/bsp/IUneceAirFlowUnitMeasureType.d.ts +1 -1
  32. package/dist/types/models/bsp/IUneceAmountType.d.ts +1 -1
  33. package/dist/types/models/bsp/IUneceDurationUnitMeasureType.d.ts +1 -1
  34. package/dist/types/models/bsp/IUneceFileSizeUnitMeasureType.d.ts +1 -1
  35. package/dist/types/models/bsp/IUneceLinearUnitMeasureType.d.ts +1 -1
  36. package/dist/types/models/bsp/IUneceMeasureType.d.ts +1 -1
  37. package/dist/types/models/bsp/IUneceQuantityType.d.ts +1 -1
  38. package/dist/types/models/bsp/IUneceTemperatureUnitMeasureType.d.ts +1 -1
  39. package/dist/types/models/bsp/IUneceUnitMeasureType.d.ts +1 -1
  40. package/dist/types/models/bsp/IUneceVolumeUnitMeasureType.d.ts +1 -1
  41. package/dist/types/models/bsp/IUneceWeightUnitMeasureType.d.ts +1 -1
  42. package/dist/types/models/uneceCodeLists.d.ts +716 -0
  43. package/docs/changelog.md +14 -0
  44. package/docs/reference/classes/UnCodeLists.md +79 -0
  45. package/docs/reference/index.md +3 -0
  46. package/docs/reference/interfaces/IUneceAirFlowUnitMeasureType.md +1 -1
  47. package/docs/reference/interfaces/IUneceAmountType.md +1 -1
  48. package/docs/reference/interfaces/IUneceDurationUnitMeasureType.md +1 -1
  49. package/docs/reference/interfaces/IUneceFileSizeUnitMeasureType.md +1 -1
  50. package/docs/reference/interfaces/IUneceLinearUnitMeasureType.md +1 -1
  51. package/docs/reference/interfaces/IUneceMeasureType.md +1 -1
  52. package/docs/reference/interfaces/IUneceQuantityType.md +1 -1
  53. package/docs/reference/interfaces/IUneceTemperatureUnitMeasureType.md +1 -1
  54. package/docs/reference/interfaces/IUneceUnitMeasureType.md +1 -1
  55. package/docs/reference/interfaces/IUneceVolumeUnitMeasureType.md +1 -1
  56. package/docs/reference/interfaces/IUneceWeightUnitMeasureType.md +1 -1
  57. package/docs/reference/type-aliases/UneceCodeLists.md +9 -0
  58. package/docs/reference/variables/UneceCodeLists.md +1421 -0
  59. package/locales/.validate-ignore +1 -0
  60. package/locales/en.json +13758 -1
  61. package/package.json +1 -1
package/docs/changelog.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # @twin.org/standards-unece - Changelog
2
2
 
3
+ ## [0.0.3-next.39](https://github.com/twinfoundation/standards/compare/standards-unece-v0.0.3-next.38...standards-unece-v0.0.3-next.39) (2026-02-13)
4
+
5
+
6
+ ### Features
7
+
8
+ * un code list descriptions ([#158](https://github.com/twinfoundation/standards/issues/158)) ([ad685ab](https://github.com/twinfoundation/standards/commit/ad685ab46f237e724388af6d2822007502b5b232))
9
+
10
+ ## [0.0.3-next.38](https://github.com/twinfoundation/standards/compare/standards-unece-v0.0.3-next.37...standards-unece-v0.0.3-next.38) (2026-02-13)
11
+
12
+
13
+ ### Features
14
+
15
+ * revert unece decimal changes ([#156](https://github.com/twinfoundation/standards/issues/156)) ([0e054d3](https://github.com/twinfoundation/standards/commit/0e054d3abf9cea5eacae5b973a821895b0eb61d8))
16
+
3
17
  ## [0.0.3-next.37](https://github.com/twinfoundation/standards/compare/standards-unece-v0.0.3-next.36...standards-unece-v0.0.3-next.37) (2026-02-12)
4
18
 
5
19
 
@@ -0,0 +1,79 @@
1
+ # Class: UnCodeLists
2
+
3
+ A class for handling Code Lists.
4
+
5
+ ## See
6
+
7
+ https://vocabulary.uncefact.org/code-lists
8
+
9
+ ## Constructors
10
+
11
+ ### Constructor
12
+
13
+ > **new UnCodeLists**(): `UnCodeLists`
14
+
15
+ #### Returns
16
+
17
+ `UnCodeLists`
18
+
19
+ ## Methods
20
+
21
+ ### getDescriptions()
22
+
23
+ > `static` **getDescriptions**(`codeList`, `locale?`): `Promise`\<\{\[`key`: `string`\]: `string`; \}\>
24
+
25
+ Get all the translations for a specific list type.
26
+
27
+ #### Parameters
28
+
29
+ ##### codeList
30
+
31
+ [`UneceCodeLists`](../type-aliases/UneceCodeLists.md)
32
+
33
+ The code list to get the translations for.
34
+
35
+ ##### locale?
36
+
37
+ `string`
38
+
39
+ The locale to get the translations for. If not provided, the default locale will be used. Falls back to 'en' if the locale doesn't exist.
40
+
41
+ #### Returns
42
+
43
+ `Promise`\<\{\[`key`: `string`\]: `string`; \}\>
44
+
45
+ The translations for the code list.
46
+
47
+ ***
48
+
49
+ ### getDescription()
50
+
51
+ > `static` **getDescription**(`codeList`, `key`, `locale?`): `Promise`\<`string` \| `undefined`\>
52
+
53
+ Get a translation for a specific list type.
54
+
55
+ #### Parameters
56
+
57
+ ##### codeList
58
+
59
+ [`UneceCodeLists`](../type-aliases/UneceCodeLists.md)
60
+
61
+ The code list to get the translations for.
62
+
63
+ ##### key
64
+
65
+ `string`
66
+
67
+ The key to get the translation for.
68
+
69
+ ##### locale?
70
+
71
+ `string`
72
+
73
+ The locale to get the translations for. If not provided, the default locale will be used.
74
+
75
+ #### Returns
76
+
77
+ `Promise`\<`string` \| `undefined`\>
78
+
79
+ The translation for the specified key in the code list.
@@ -3,6 +3,7 @@
3
3
  ## Classes
4
4
 
5
5
  - [UneceDataTypes](classes/UneceDataTypes.md)
6
+ - [UnCodeLists](classes/UnCodeLists.md)
6
7
  - [UnLocodes](classes/UnLocodes.md)
7
8
 
8
9
  ## Interfaces
@@ -659,6 +660,7 @@
659
660
  - [UneceTransportationWasteMaterialTypeCodeList](type-aliases/UneceTransportationWasteMaterialTypeCodeList.md)
660
661
  - [UneceVoucherTypeCodeList](type-aliases/UneceVoucherTypeCodeList.md)
661
662
  - [UneceXHEParameterTypeCodeList](type-aliases/UneceXHEParameterTypeCodeList.md)
663
+ - [UneceCodeLists](type-aliases/UneceCodeLists.md)
662
664
  - [UneceContextType](type-aliases/UneceContextType.md)
663
665
  - [UneceContexts](type-aliases/UneceContexts.md)
664
666
  - [UneceTypes](type-aliases/UneceTypes.md)
@@ -915,5 +917,6 @@
915
917
  - [UneceTransportationWasteMaterialTypeCodeList](variables/UneceTransportationWasteMaterialTypeCodeList.md)
916
918
  - [UneceVoucherTypeCodeList](variables/UneceVoucherTypeCodeList.md)
917
919
  - [UneceXHEParameterTypeCodeList](variables/UneceXHEParameterTypeCodeList.md)
920
+ - [UneceCodeLists](variables/UneceCodeLists.md)
918
921
  - [UneceContexts](variables/UneceContexts.md)
919
922
  - [UneceTypes](variables/UneceTypes.md)
@@ -38,7 +38,7 @@ JSON-LD Type.
38
38
 
39
39
  ### AirFlowUnitMeasureTypeValue?
40
40
 
41
- > `optional` **AirFlowUnitMeasureTypeValue**: `number`
41
+ > `optional` **AirFlowUnitMeasureTypeValue**: `string`
42
42
 
43
43
  The numeric value.
44
44
 
@@ -38,7 +38,7 @@ JSON-LD Type.
38
38
 
39
39
  ### AmountTypeValue?
40
40
 
41
- > `optional` **AmountTypeValue**: `number`
41
+ > `optional` **AmountTypeValue**: `string`
42
42
 
43
43
  A number of monetary units.
44
44
 
@@ -38,7 +38,7 @@ JSON-LD Type.
38
38
 
39
39
  ### DurationUnitMeasureTypeValue?
40
40
 
41
- > `optional` **DurationUnitMeasureTypeValue**: `number`
41
+ > `optional` **DurationUnitMeasureTypeValue**: `string`
42
42
 
43
43
  The numeric value.
44
44
 
@@ -38,7 +38,7 @@ JSON-LD Type.
38
38
 
39
39
  ### FileSizeUnitMeasureTypeValue?
40
40
 
41
- > `optional` **FileSizeUnitMeasureTypeValue**: `number`
41
+ > `optional` **FileSizeUnitMeasureTypeValue**: `string`
42
42
 
43
43
  The numeric value.
44
44
 
@@ -38,7 +38,7 @@ JSON-LD Type.
38
38
 
39
39
  ### LinearUnitMeasureTypeValue?
40
40
 
41
- > `optional` **LinearUnitMeasureTypeValue**: `number`
41
+ > `optional` **LinearUnitMeasureTypeValue**: `string`
42
42
 
43
43
  The numeric value.
44
44
 
@@ -38,7 +38,7 @@ JSON-LD Type.
38
38
 
39
39
  ### MeasureTypeValue?
40
40
 
41
- > `optional` **MeasureTypeValue**: `number`
41
+ > `optional` **MeasureTypeValue**: `string`
42
42
 
43
43
  The numeric value.
44
44
 
@@ -38,7 +38,7 @@ JSON-LD Type.
38
38
 
39
39
  ### QuantityTypeValue?
40
40
 
41
- > `optional` **QuantityTypeValue**: `number`
41
+ > `optional` **QuantityTypeValue**: `string`
42
42
 
43
43
  The numeric value.
44
44
 
@@ -38,7 +38,7 @@ JSON-LD Type.
38
38
 
39
39
  ### TemperatureUnitMeasureTypeValue?
40
40
 
41
- > `optional` **TemperatureUnitMeasureTypeValue**: `number`
41
+ > `optional` **TemperatureUnitMeasureTypeValue**: `string`
42
42
 
43
43
  The numeric value.
44
44
 
@@ -38,7 +38,7 @@ JSON-LD Type.
38
38
 
39
39
  ### UnitMeasureTypeValue?
40
40
 
41
- > `optional` **UnitMeasureTypeValue**: `number`
41
+ > `optional` **UnitMeasureTypeValue**: `string`
42
42
 
43
43
  The numeric value.
44
44
 
@@ -38,7 +38,7 @@ JSON-LD Type.
38
38
 
39
39
  ### VolumeUnitMeasureTypeValue?
40
40
 
41
- > `optional` **VolumeUnitMeasureTypeValue**: `number`
41
+ > `optional` **VolumeUnitMeasureTypeValue**: `string`
42
42
 
43
43
  The numeric value.
44
44
 
@@ -38,7 +38,7 @@ JSON-LD Type.
38
38
 
39
39
  ### WeightUnitMeasureTypeValue?
40
40
 
41
- > `optional` **WeightUnitMeasureTypeValue**: `number`
41
+ > `optional` **WeightUnitMeasureTypeValue**: `string`
42
42
 
43
43
  The numeric value.
44
44
 
@@ -0,0 +1,9 @@
1
+ # Type Alias: UneceCodeLists
2
+
3
+ > **UneceCodeLists** = *typeof* [`UneceCodeLists`](../variables/UneceCodeLists.md)\[keyof *typeof* [`UneceCodeLists`](../variables/UneceCodeLists.md)\]
4
+
5
+ The types of UNECE code lists.
6
+
7
+ ## See
8
+
9
+ https://vocabulary.uncefact.org/code-lists