@vicin/phantom 1.0.2 → 1.0.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 (115) hide show
  1. package/README.md +18 -3
  2. package/dist/index.d.mts +1353 -0
  3. package/dist/index.d.ts +1353 -7
  4. package/dist/index.global.js +135 -0
  5. package/dist/index.global.js.map +1 -0
  6. package/dist/index.js +129 -5
  7. package/dist/index.js.map +1 -1
  8. package/dist/index.mjs +117 -0
  9. package/dist/index.mjs.map +1 -0
  10. package/package.json +6 -2
  11. package/dist/assertors/assertors.d.ts +0 -86
  12. package/dist/assertors/assertors.d.ts.map +0 -1
  13. package/dist/assertors/assertors.js +0 -91
  14. package/dist/assertors/assertors.js.map +0 -1
  15. package/dist/assertors/brand.d.ts +0 -13
  16. package/dist/assertors/brand.d.ts.map +0 -1
  17. package/dist/assertors/brand.js +0 -12
  18. package/dist/assertors/brand.js.map +0 -1
  19. package/dist/assertors/identity.d.ts +0 -13
  20. package/dist/assertors/identity.d.ts.map +0 -1
  21. package/dist/assertors/identity.js +0 -12
  22. package/dist/assertors/identity.js.map +0 -1
  23. package/dist/assertors/index.d.ts +0 -2
  24. package/dist/assertors/index.d.ts.map +0 -1
  25. package/dist/assertors/index.js +0 -2
  26. package/dist/assertors/index.js.map +0 -1
  27. package/dist/assertors/trait.d.ts +0 -38
  28. package/dist/assertors/trait.d.ts.map +0 -1
  29. package/dist/assertors/trait.js +0 -37
  30. package/dist/assertors/trait.js.map +0 -1
  31. package/dist/assertors/transformation.d.ts +0 -27
  32. package/dist/assertors/transformation.d.ts.map +0 -1
  33. package/dist/assertors/transformation.js +0 -26
  34. package/dist/assertors/transformation.js.map +0 -1
  35. package/dist/chain/chain.d.ts +0 -42
  36. package/dist/chain/chain.d.ts.map +0 -1
  37. package/dist/chain/chain.js +0 -48
  38. package/dist/chain/chain.js.map +0 -1
  39. package/dist/chain/index.d.ts +0 -2
  40. package/dist/chain/index.d.ts.map +0 -1
  41. package/dist/chain/index.js +0 -2
  42. package/dist/chain/index.js.map +0 -1
  43. package/dist/index.d.ts.map +0 -1
  44. package/dist/phantom.d.ts +0 -352
  45. package/dist/phantom.d.ts.map +0 -1
  46. package/dist/phantom.js +0 -139
  47. package/dist/phantom.js.map +0 -1
  48. package/dist/types/composed/brand.d.ts +0 -32
  49. package/dist/types/composed/brand.d.ts.map +0 -1
  50. package/dist/types/composed/brand.js +0 -2
  51. package/dist/types/composed/brand.js.map +0 -1
  52. package/dist/types/composed/helpers.d.ts +0 -75
  53. package/dist/types/composed/helpers.d.ts.map +0 -1
  54. package/dist/types/composed/helpers.js +0 -2
  55. package/dist/types/composed/helpers.js.map +0 -1
  56. package/dist/types/composed/identity.d.ts +0 -37
  57. package/dist/types/composed/identity.d.ts.map +0 -1
  58. package/dist/types/composed/identity.js +0 -2
  59. package/dist/types/composed/identity.js.map +0 -1
  60. package/dist/types/composed/index.d.ts +0 -6
  61. package/dist/types/composed/index.d.ts.map +0 -1
  62. package/dist/types/composed/index.js +0 -2
  63. package/dist/types/composed/index.js.map +0 -1
  64. package/dist/types/composed/trait.d.ts +0 -35
  65. package/dist/types/composed/trait.d.ts.map +0 -1
  66. package/dist/types/composed/trait.js +0 -2
  67. package/dist/types/composed/trait.js.map +0 -1
  68. package/dist/types/composed/transformation.d.ts +0 -34
  69. package/dist/types/composed/transformation.d.ts.map +0 -1
  70. package/dist/types/composed/transformation.js +0 -2
  71. package/dist/types/composed/transformation.js.map +0 -1
  72. package/dist/types/core/base.d.ts +0 -35
  73. package/dist/types/core/base.d.ts.map +0 -1
  74. package/dist/types/core/base.js +0 -2
  75. package/dist/types/core/base.js.map +0 -1
  76. package/dist/types/core/index.d.ts +0 -8
  77. package/dist/types/core/index.d.ts.map +0 -1
  78. package/dist/types/core/index.js +0 -2
  79. package/dist/types/core/index.js.map +0 -1
  80. package/dist/types/core/input.d.ts +0 -38
  81. package/dist/types/core/input.d.ts.map +0 -1
  82. package/dist/types/core/input.js +0 -2
  83. package/dist/types/core/input.js.map +0 -1
  84. package/dist/types/core/label.d.ts +0 -34
  85. package/dist/types/core/label.d.ts.map +0 -1
  86. package/dist/types/core/label.js +0 -2
  87. package/dist/types/core/label.js.map +0 -1
  88. package/dist/types/core/phantom.d.ts +0 -20
  89. package/dist/types/core/phantom.d.ts.map +0 -1
  90. package/dist/types/core/phantom.js +0 -11
  91. package/dist/types/core/phantom.js.map +0 -1
  92. package/dist/types/core/tag.d.ts +0 -35
  93. package/dist/types/core/tag.d.ts.map +0 -1
  94. package/dist/types/core/tag.js +0 -2
  95. package/dist/types/core/tag.js.map +0 -1
  96. package/dist/types/core/traits.d.ts +0 -51
  97. package/dist/types/core/traits.d.ts.map +0 -1
  98. package/dist/types/core/traits.js +0 -2
  99. package/dist/types/core/traits.js.map +0 -1
  100. package/dist/types/core/variants.d.ts +0 -34
  101. package/dist/types/core/variants.d.ts.map +0 -1
  102. package/dist/types/core/variants.js +0 -2
  103. package/dist/types/core/variants.js.map +0 -1
  104. package/dist/types/errors.d.ts +0 -40
  105. package/dist/types/errors.d.ts.map +0 -1
  106. package/dist/types/errors.js +0 -2
  107. package/dist/types/errors.js.map +0 -1
  108. package/dist/types/index.d.ts +0 -4
  109. package/dist/types/index.d.ts.map +0 -1
  110. package/dist/types/index.js +0 -2
  111. package/dist/types/index.js.map +0 -1
  112. package/dist/types/public.d.ts +0 -224
  113. package/dist/types/public.d.ts.map +0 -1
  114. package/dist/types/public.js +0 -12
  115. package/dist/types/public.js.map +0 -1
package/README.md CHANGED
@@ -9,7 +9,14 @@
9
9
  - [Features](#features)
10
10
  - [Install](#install)
11
11
  - [Core concepts](#core-concepts)
12
- - [Phantom](#phantom-1)
12
+ - [Type constructs](#type-constructs)
13
+ - [Branding](#branding)
14
+ - [Identities with constraints](#identities-with-constraints)
15
+ - [Traits (additive capabilities)](#traits-additive-capabilities)
16
+ - [Transformations (Type pipe-like behavior)](#transformations-type-pipe-like-behavior)
17
+ - [Errors](#errors)
18
+ - [Symbols](#symbols)
19
+ - [Imports](#imports)
13
20
  - [Chaining](#chaining)
14
21
  - [Hot-path code ( truly type-only pattern )](#hot-path-code--truly-type-only-pattern-)
15
22
  - [Debugging](#debugging)
@@ -116,7 +123,7 @@ More details of these properties will be discussed later.
116
123
 
117
124
  ---
118
125
 
119
- ## Phantom
126
+ ## Type constructs
120
127
 
121
128
  ### Branding
122
129
 
@@ -426,7 +433,7 @@ type UserId = Brand.Declare<typeof __UserId, 'User id'>;
426
433
  export const asUserId = assertors.asBrand<UserId>();
427
434
  ```
428
435
 
429
- Also if you prefer default imports you can just:
436
+ If you prefer default imports you can just:
430
437
 
431
438
  ```ts
432
439
  import P from '@vicin/phantom';
@@ -439,6 +446,14 @@ type UserId = P.Brand.Declare<typeof __UserId, 'User id'>;
439
446
  export const asUserId = P.assertors.asBrand<UserId>();
440
447
  ```
441
448
 
449
+ Also you can import single assertor function:
450
+
451
+ ```ts
452
+ import { asBrand } from '@vicin/phantom';
453
+
454
+ export const asUserId = assertors.asBrand<UserId>();
455
+ ```
456
+
442
457
  You are free to pick whatever pattern you are comfortable with.
443
458
 
444
459
  ---