@systemfsoftware/hex-schema 1.6.3 → 1.7.0
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.
- package/CHANGELOG.md +19 -0
- package/LICENSE +203 -21
- package/README.md +23 -0
- package/dist/hex-schema.d.ts +8 -8
- package/dist/index.d.ts +14 -14
- package/dist/index.mjs +39 -21
- package/package.json +16 -18
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# @systemfsoftware/hex-schema
|
|
2
|
+
|
|
3
|
+
## 1.7.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- cut over to effect v4 (4.0.0-rc.108): public surface derives from effect types; peers flip effect ^3→^4
|
|
8
|
+
|
|
9
|
+
### Patch Changes
|
|
10
|
+
|
|
11
|
+
- New version is published through npm trusted publishing, so it carries a provenance attestation you can verify.
|
|
12
|
+
|
|
13
|
+
- The `0x`-prefix codec directions move to a new internal `prefixed-hex.kernel.ts` as `stripHexPrefix` and `addHexPrefix`. `prefixed-hex.schema.ts` and `uint8array-from-prefixed-hex.schema.ts` encode and decode exactly as before.
|
|
14
|
+
|
|
15
|
+
- Each of these packages now has a README, so its registry page says what the package is, how
|
|
16
|
+
to install it, and what to import or register — previously the page was blank. The lint
|
|
17
|
+
plugins show the configuration line that enables what they recommend.
|
|
18
|
+
|
|
19
|
+
`@systemfsoftware/stryker-js-mutation-report` also carries its licence text
|
package/LICENSE
CHANGED
|
@@ -1,21 +1,203 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
1
|
+
Copyright (c) 2026 Ryan Lee (systemfsoftware)
|
|
2
|
+
|
|
3
|
+
Apache License
|
|
4
|
+
Version 2.0, January 2004
|
|
5
|
+
http://www.apache.org/licenses/
|
|
6
|
+
|
|
7
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
8
|
+
|
|
9
|
+
1. Definitions.
|
|
10
|
+
|
|
11
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
12
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
13
|
+
|
|
14
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
15
|
+
the copyright owner that is granting the License.
|
|
16
|
+
|
|
17
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
18
|
+
other entities that control, are controlled by, or are under common
|
|
19
|
+
control with that entity. For the purposes of this definition,
|
|
20
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
21
|
+
direction or management of such entity, whether by contract or
|
|
22
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
23
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
24
|
+
|
|
25
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
26
|
+
exercising permissions granted by this License.
|
|
27
|
+
|
|
28
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
29
|
+
including but not limited to software source code, documentation
|
|
30
|
+
source, and configuration files.
|
|
31
|
+
|
|
32
|
+
"Object" form shall mean any form resulting from mechanical
|
|
33
|
+
transformation or translation of a Source form, including but
|
|
34
|
+
not limited to compiled object code, generated documentation,
|
|
35
|
+
and conversions to other media types.
|
|
36
|
+
|
|
37
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
38
|
+
Object form, made available under the License, as indicated by a
|
|
39
|
+
copyright notice that is included in or attached to the work
|
|
40
|
+
(an example is provided in the Appendix below).
|
|
41
|
+
|
|
42
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
43
|
+
form, that is based on (or derived from) the Work and for which the
|
|
44
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
45
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
46
|
+
of this License, Derivative Works shall not include works that remain
|
|
47
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
48
|
+
the Work and Derivative Works thereof.
|
|
49
|
+
|
|
50
|
+
"Contribution" shall mean any work of authorship, including
|
|
51
|
+
the original version of the Work and any modifications or additions
|
|
52
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
53
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
54
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
55
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
56
|
+
means any form of electronic, verbal, or written communication sent
|
|
57
|
+
to the Licensor or its representatives, including but not limited to
|
|
58
|
+
communication on electronic mailing lists, source code control systems,
|
|
59
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
60
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
61
|
+
excluding communication that is conspicuously marked or otherwise
|
|
62
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
63
|
+
|
|
64
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
65
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
66
|
+
subsequently incorporated within the Work.
|
|
67
|
+
|
|
68
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
69
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
70
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
71
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
72
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
73
|
+
Work and such Derivative Works in Source or Object form.
|
|
74
|
+
|
|
75
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
76
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
77
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
78
|
+
(except as stated in this section) patent license to make, have made,
|
|
79
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
80
|
+
where such license applies only to those patent claims licensable
|
|
81
|
+
by such Contributor that are necessarily infringed by their
|
|
82
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
83
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
84
|
+
institute patent litigation against any entity (including a
|
|
85
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
86
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
87
|
+
or contributory patent infringement, then any patent licenses
|
|
88
|
+
granted to You under this License for that Work shall terminate
|
|
89
|
+
as of the date such litigation is filed.
|
|
90
|
+
|
|
91
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
92
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
93
|
+
modifications, and in Source or Object form, provided that You
|
|
94
|
+
meet the following conditions:
|
|
95
|
+
|
|
96
|
+
(a) You must give any other recipients of the Work or
|
|
97
|
+
Derivative Works a copy of this License; and
|
|
98
|
+
|
|
99
|
+
(b) You must cause any modified files to carry prominent notices
|
|
100
|
+
stating that You changed the files; and
|
|
101
|
+
|
|
102
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
103
|
+
that You distribute, all copyright, patent, trademark, and
|
|
104
|
+
attribution notices from the Source form of the Work,
|
|
105
|
+
excluding those notices that do not pertain to any part of
|
|
106
|
+
the Derivative Works; and
|
|
107
|
+
|
|
108
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
109
|
+
distribution, then any Derivative Works that You distribute must
|
|
110
|
+
include a readable copy of the attribution notices contained
|
|
111
|
+
within such NOTICE file, excluding those notices that do not
|
|
112
|
+
pertain to any part of the Derivative Works, in at least one
|
|
113
|
+
of the following places: within a NOTICE text file distributed
|
|
114
|
+
as part of the Derivative Works; within the Source form or
|
|
115
|
+
documentation, if provided along with the Derivative Works; or,
|
|
116
|
+
within a display generated by the Derivative Works, if and
|
|
117
|
+
wherever such third-party notices normally appear. The contents
|
|
118
|
+
of the NOTICE file are for informational purposes only and
|
|
119
|
+
do not modify the License. You may add Your own attribution
|
|
120
|
+
notices within Derivative Works that You distribute, alongside
|
|
121
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
122
|
+
that such additional attribution notices cannot be construed
|
|
123
|
+
as modifying the License.
|
|
124
|
+
|
|
125
|
+
You may add Your own copyright statement to Your modifications and
|
|
126
|
+
may provide additional or different license terms and conditions
|
|
127
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
128
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
129
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
130
|
+
the conditions stated in this License.
|
|
131
|
+
|
|
132
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
133
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
134
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
135
|
+
this License, without any additional terms or conditions.
|
|
136
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
137
|
+
the terms of any separate license agreement you may have executed
|
|
138
|
+
with Licensor regarding such Contributions.
|
|
139
|
+
|
|
140
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
141
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
142
|
+
except as required for reasonable and customary use in describing the
|
|
143
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
144
|
+
|
|
145
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
146
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
147
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
148
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
149
|
+
implied, including, without limitation, any warranties or conditions
|
|
150
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
151
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
152
|
+
appropriateness of using or redistributing the Work and assume any
|
|
153
|
+
risks associated with Your exercise of permissions under this License.
|
|
154
|
+
|
|
155
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
156
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
157
|
+
unless required by applicable law (such as deliberate and grossly
|
|
158
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
159
|
+
liable to You for damages, including any direct, indirect, special,
|
|
160
|
+
incidental, or consequential damages of any character arising as a
|
|
161
|
+
result of this License or out of the use or inability to use the
|
|
162
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
163
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
164
|
+
other commercial damages or losses), even if such Contributor
|
|
165
|
+
has been advised of the possibility of such damages.
|
|
166
|
+
|
|
167
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
168
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
169
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
170
|
+
or other liability obligations and/or rights consistent with this
|
|
171
|
+
License. However, in accepting such obligations, You may act only
|
|
172
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
173
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
174
|
+
defend, and hold each Contributor harmless for any liability
|
|
175
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
176
|
+
of your accepting any such warranty or additional liability.
|
|
177
|
+
|
|
178
|
+
END OF TERMS AND CONDITIONS
|
|
179
|
+
|
|
180
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
181
|
+
|
|
182
|
+
To apply the Apache License to your work, attach the following
|
|
183
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
184
|
+
replaced with your own identifying information. (Don't include
|
|
185
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
186
|
+
comment syntax for the file format. We also recommend that a
|
|
187
|
+
file or class name and description of purpose be included on the
|
|
188
|
+
same "printed page" as the copyright notice for easier
|
|
189
|
+
identification within third-party archives.
|
|
190
|
+
|
|
191
|
+
Copyright 2026 Ryan Lee (systemfsoftware)
|
|
192
|
+
|
|
193
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
194
|
+
you may not use this file except in compliance with the License.
|
|
195
|
+
You may obtain a copy of the License at
|
|
196
|
+
|
|
197
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
198
|
+
|
|
199
|
+
Unless required by applicable law or agreed to in writing, software
|
|
200
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
201
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
202
|
+
See the License for the specific language governing permissions and
|
|
203
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# @systemfsoftware/hex-schema
|
|
2
|
+
|
|
3
|
+
Effect Schema definitions for hexadecimal wire formats — strict, colon-delimited, prefixed, and byte-level schemas with branded types.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
pnpm add @systemfsoftware/hex-schema 'effect@4.0.0-rc.108'
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Those are peer dependencies: this package declares them but does not install them, so one copy is shared with the rest of your project.
|
|
12
|
+
|
|
13
|
+
## Entry points
|
|
14
|
+
|
|
15
|
+
- `@systemfsoftware/hex-schema`
|
|
16
|
+
|
|
17
|
+
## API
|
|
18
|
+
|
|
19
|
+
The public surface is generated from the source and versioned with the package: [`etc/hex-schema.api.md`](./etc/hex-schema.api.md).
|
|
20
|
+
|
|
21
|
+
## License
|
|
22
|
+
|
|
23
|
+
Apache-2.0. Part of [systemfsoftware](https://github.com/systemfsoftware/systemfsoftware/tree/main/packages/hex-schema#readme).
|
package/dist/hex-schema.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Schema } from 'effect';
|
|
2
2
|
|
|
3
|
-
export declare const ColonHex: Schema.brand<Schema.
|
|
3
|
+
export declare const ColonHex: Schema.brand<Schema.decodeTo<Schema.brand<Schema.decodeTo<Schema.String, Schema.String, never, never>, "HexString">, Schema.decodeTo<Schema.toEncoded<Schema.brand<Schema.decodeTo<Schema.String, Schema.String, never, never>, "HexString">>, Schema.String, never, never>, never, never>, "ColonHex">;
|
|
4
4
|
|
|
5
5
|
export declare type ColonHex = Schema.Schema.Type<typeof ColonHex>;
|
|
6
6
|
|
|
@@ -9,23 +9,23 @@ export declare type ColonHex = Schema.Schema.Type<typeof ColonHex>;
|
|
|
9
9
|
* this to produce a `Uint8Array` from that format:
|
|
10
10
|
*
|
|
11
11
|
* ```ts
|
|
12
|
-
* S.
|
|
13
|
-
* S.
|
|
12
|
+
* S.decodeTo(HexBytes)(PrefixedHex) // Schema<Uint8Array, `0x${string}`>
|
|
13
|
+
* S.decodeTo(HexBytes)(ColonHex) // Schema<Uint8Array, string>
|
|
14
14
|
* ```
|
|
15
15
|
*/
|
|
16
|
-
export declare const HexBytes: Schema.
|
|
16
|
+
export declare const HexBytes: Schema.Uint8ArrayFromHex;
|
|
17
17
|
|
|
18
|
-
export declare const HexString: Schema.brand<Schema.
|
|
18
|
+
export declare const HexString: Schema.brand<Schema.decodeTo<Schema.String, Schema.String, never, never>, "HexString">;
|
|
19
19
|
|
|
20
20
|
export declare type HexString = Schema.Schema.Type<typeof HexString>;
|
|
21
21
|
|
|
22
|
-
export declare const PrefixedHex: Schema.brand<Schema.
|
|
22
|
+
export declare const PrefixedHex: Schema.brand<Schema.decodeTo<Schema.String, Schema.TemplateLiteral<readonly ["0x", Schema.String]>, never, never>, "PrefixedHex">;
|
|
23
23
|
|
|
24
24
|
export declare type PrefixedHex = Schema.Schema.Type<typeof PrefixedHex>;
|
|
25
25
|
|
|
26
|
-
export declare const StrictHex: Schema.
|
|
26
|
+
export declare const StrictHex: Schema.String;
|
|
27
27
|
|
|
28
|
-
export declare const Uint8ArrayFromPrefixedHex: Schema.
|
|
28
|
+
export declare const Uint8ArrayFromPrefixedHex: Schema.decodeTo<Schema.Uint8ArrayFromHex, Schema.brand<Schema.decodeTo<Schema.String, Schema.TemplateLiteral<readonly ["0x", Schema.String]>, never, never>, "PrefixedHex">, never, never>;
|
|
29
29
|
|
|
30
30
|
export declare type Uint8ArrayFromPrefixedHex = Schema.Schema.Type<typeof Uint8ArrayFromPrefixedHex>;
|
|
31
31
|
|
package/dist/index.d.ts
CHANGED
|
@@ -1,33 +1,33 @@
|
|
|
1
1
|
import { Schema } from "effect";
|
|
2
|
-
//#region src/
|
|
3
|
-
declare const ColonHex: Schema.brand<Schema.
|
|
2
|
+
//#region src/ColonHex.schema.d.ts
|
|
3
|
+
declare const ColonHex: Schema.brand<Schema.decodeTo<Schema.brand<Schema.decodeTo<Schema.String, Schema.String, never, never>, "HexString">, Schema.decodeTo<Schema.toEncoded<Schema.brand<Schema.decodeTo<Schema.String, Schema.String, never, never>, "HexString">>, Schema.String, never, never>, never, never>, "ColonHex">;
|
|
4
4
|
type ColonHex = Schema.Schema.Type<typeof ColonHex>;
|
|
5
5
|
//#endregion
|
|
6
|
-
//#region src/
|
|
6
|
+
//#region src/HexBytes.schema.d.ts
|
|
7
7
|
/**
|
|
8
8
|
* Composable hex-to-bytes schema. Compose any branded hex schema with
|
|
9
9
|
* this to produce a `Uint8Array` from that format:
|
|
10
10
|
*
|
|
11
11
|
* ```ts
|
|
12
|
-
* S.
|
|
13
|
-
* S.
|
|
12
|
+
* S.decodeTo(HexBytes)(PrefixedHex) // Schema<Uint8Array, `0x${string}`>
|
|
13
|
+
* S.decodeTo(HexBytes)(ColonHex) // Schema<Uint8Array, string>
|
|
14
14
|
* ```
|
|
15
15
|
*/
|
|
16
|
-
declare const HexBytes: Schema.
|
|
16
|
+
declare const HexBytes: Schema.Uint8ArrayFromHex;
|
|
17
17
|
//#endregion
|
|
18
|
-
//#region src/
|
|
19
|
-
declare const HexString: Schema.brand<Schema.
|
|
18
|
+
//#region src/HexString.schema.d.ts
|
|
19
|
+
declare const HexString: Schema.brand<Schema.decodeTo<Schema.String, Schema.String, never, never>, "HexString">;
|
|
20
20
|
type HexString = Schema.Schema.Type<typeof HexString>;
|
|
21
21
|
//#endregion
|
|
22
|
-
//#region src/
|
|
23
|
-
declare const PrefixedHex: Schema.brand<Schema.
|
|
22
|
+
//#region src/PrefixedHex.schema.d.ts
|
|
23
|
+
declare const PrefixedHex: Schema.brand<Schema.decodeTo<Schema.String, Schema.TemplateLiteral<readonly ["0x", Schema.String]>, never, never>, "PrefixedHex">;
|
|
24
24
|
type PrefixedHex = Schema.Schema.Type<typeof PrefixedHex>;
|
|
25
25
|
//#endregion
|
|
26
|
-
//#region src/
|
|
27
|
-
declare const StrictHex: Schema.
|
|
26
|
+
//#region src/StrictHex.schema.d.ts
|
|
27
|
+
declare const StrictHex: Schema.String;
|
|
28
28
|
//#endregion
|
|
29
|
-
//#region src/
|
|
30
|
-
declare const Uint8ArrayFromPrefixedHex: Schema.
|
|
29
|
+
//#region src/Uint8arrayFromPrefixedHex.schema.d.ts
|
|
30
|
+
declare const Uint8ArrayFromPrefixedHex: Schema.decodeTo<Schema.Uint8ArrayFromHex, Schema.brand<Schema.decodeTo<Schema.String, Schema.TemplateLiteral<readonly ["0x", Schema.String]>, never, never>, "PrefixedHex">, never, never>;
|
|
31
31
|
type Uint8ArrayFromPrefixedHex = Schema.Schema.Type<typeof Uint8ArrayFromPrefixedHex>;
|
|
32
32
|
//#endregion
|
|
33
33
|
export { ColonHex, HexBytes, HexString, PrefixedHex, StrictHex, Uint8ArrayFromPrefixedHex };
|
package/dist/index.mjs
CHANGED
|
@@ -1,67 +1,85 @@
|
|
|
1
|
-
import { Schema,
|
|
2
|
-
//#region src/
|
|
3
|
-
const StrictHex = Schema.String.pipe(Schema.
|
|
1
|
+
import { Schema, SchemaTransformation } from "effect";
|
|
2
|
+
//#region src/StrictHex.schema.ts
|
|
3
|
+
const StrictHex = Schema.String.pipe(Schema.check(Schema.isPattern(/^[0-9a-f]*$/)), Schema.annotate({
|
|
4
4
|
identifier: "StrictHex",
|
|
5
5
|
description: "A lowercase hexadecimal string with no prefix",
|
|
6
6
|
title: "Strict Hex String"
|
|
7
7
|
}));
|
|
8
|
+
Schema.decodeUnknownExit(StrictHex);
|
|
8
9
|
//#endregion
|
|
9
|
-
//#region src/
|
|
10
|
+
//#region src/HexString.schema.ts
|
|
10
11
|
const toStrictHex = (hex) => (hex.startsWith("0x") ? hex.slice(2) : hex).toLowerCase();
|
|
11
|
-
const HexString =
|
|
12
|
+
const HexString = Schema.String.pipe(Schema.annotate({
|
|
12
13
|
identifier: "HexStringInput",
|
|
13
14
|
description: "A hex string, optionally prefixed with 0x (empty string allowed)"
|
|
14
|
-
})
|
|
15
|
+
}), Schema.decodeTo(StrictHex, SchemaTransformation.transform({
|
|
15
16
|
decode: toStrictHex,
|
|
16
17
|
encode: (s) => s
|
|
17
|
-
}), Schema.
|
|
18
|
+
})), Schema.annotate({
|
|
18
19
|
identifier: "HexString",
|
|
19
20
|
description: "A string representing hexadecimal data, with or without the 0x prefix",
|
|
20
21
|
title: "Hex String"
|
|
21
22
|
}), Schema.brand("HexString"));
|
|
22
23
|
//#endregion
|
|
23
|
-
//#region src/
|
|
24
|
+
//#region src/ColonHex.schema.ts
|
|
24
25
|
const hexToColon = (hex) => (hex.match(/.{1,2}/g) ?? []).map((byte) => byte.toUpperCase()).join(":");
|
|
25
|
-
const ColonHex =
|
|
26
|
+
const ColonHex = Schema.String.pipe(Schema.check(Schema.isPattern(/^([0-9A-Fa-f]{1,2}(:[0-9A-Fa-f]{1,2})*)?$/)), Schema.decodeTo(Schema.toEncoded(HexString), SchemaTransformation.transform({
|
|
26
27
|
decode: (colon) => colon.replaceAll(":", ""),
|
|
27
28
|
encode: hexToColon
|
|
28
|
-
}), HexString), Schema.
|
|
29
|
+
})), Schema.decodeTo(HexString), Schema.annotate({
|
|
29
30
|
identifier: "ColonHex",
|
|
30
31
|
description: "Colon-separated uppercase hex bytes — the fingerprint format",
|
|
31
32
|
title: "Colon-Separated Hex String"
|
|
32
33
|
}), Schema.brand("ColonHex"));
|
|
33
34
|
//#endregion
|
|
34
|
-
//#region src/
|
|
35
|
+
//#region src/HexBytes.schema.ts
|
|
35
36
|
/**
|
|
36
37
|
* Composable hex-to-bytes schema. Compose any branded hex schema with
|
|
37
38
|
* this to produce a `Uint8Array` from that format:
|
|
38
39
|
*
|
|
39
40
|
* ```ts
|
|
40
|
-
* S.
|
|
41
|
-
* S.
|
|
41
|
+
* S.decodeTo(HexBytes)(PrefixedHex) // Schema<Uint8Array, `0x${string}`>
|
|
42
|
+
* S.decodeTo(HexBytes)(ColonHex) // Schema<Uint8Array, string>
|
|
42
43
|
* ```
|
|
43
44
|
*/
|
|
44
|
-
const HexBytes = Schema.Uint8ArrayFromHex.pipe(Schema.
|
|
45
|
+
const HexBytes = Schema.Uint8ArrayFromHex.pipe(Schema.annotate({
|
|
45
46
|
identifier: "HexBytes",
|
|
46
47
|
description: "Uint8Array encoded as a lowercase hex string — compose with any hex schema",
|
|
47
48
|
title: "Hex Bytes"
|
|
48
49
|
}));
|
|
50
|
+
Schema.decodeUnknownExit(HexBytes);
|
|
49
51
|
//#endregion
|
|
50
|
-
//#region src/
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
52
|
+
//#region src/PrefixedHex.ts
|
|
53
|
+
/**
|
|
54
|
+
* The two directions of the `0x`-prefix codec.
|
|
55
|
+
*
|
|
56
|
+
* They live here rather than inline in `Schema.transform` because naming each direction puts
|
|
57
|
+
* it within reach of a property test, which an inline arrow inside a combinator is not -
|
|
58
|
+
* though per HEX-V1 the codec laws for the schema itself stay with the injected law tests
|
|
59
|
+
* rather than being hand-written here.
|
|
60
|
+
*/
|
|
61
|
+
/** Drops the `0x` marker, leaving the bare hex digits the domain schema validates. */
|
|
62
|
+
const stripHexPrefix = (prefixed) => prefixed.slice(2);
|
|
63
|
+
/** Restores the wire form. The literal return type is what makes the encoded side a template literal. */
|
|
64
|
+
const addHexPrefix = (bare) => `0x${bare}`;
|
|
65
|
+
//#endregion
|
|
66
|
+
//#region src/PrefixedHex.schema.ts
|
|
67
|
+
const PrefixedHex = Schema.TemplateLiteral(["0x", Schema.String]).pipe(Schema.decodeTo(StrictHex, SchemaTransformation.transform({
|
|
68
|
+
decode: stripHexPrefix,
|
|
69
|
+
encode: addHexPrefix
|
|
70
|
+
})), Schema.annotate({
|
|
55
71
|
identifier: "PrefixedHex",
|
|
56
72
|
description: "A 0x-prefixed hex string on the wire — decodes to a plain lowercase hex string",
|
|
57
73
|
title: "Prefixed Hex String"
|
|
58
74
|
}), Schema.brand("PrefixedHex"));
|
|
75
|
+
Schema.decodeUnknownExit(PrefixedHex);
|
|
59
76
|
//#endregion
|
|
60
|
-
//#region src/
|
|
61
|
-
const Uint8ArrayFromPrefixedHex =
|
|
77
|
+
//#region src/Uint8arrayFromPrefixedHex.schema.ts
|
|
78
|
+
const Uint8ArrayFromPrefixedHex = Schema.decodeTo(HexBytes)(PrefixedHex).pipe(Schema.annotate({
|
|
62
79
|
identifier: "Uint8ArrayFromPrefixedHex",
|
|
63
80
|
description: "Uint8Array encoded as a 0x-prefixed hex string",
|
|
64
81
|
title: "Uint8Array from Prefixed Hex"
|
|
65
82
|
}));
|
|
83
|
+
Schema.decodeUnknownExit(Uint8ArrayFromPrefixedHex);
|
|
66
84
|
//#endregion
|
|
67
85
|
export { ColonHex, HexBytes, HexString, PrefixedHex, StrictHex, Uint8ArrayFromPrefixedHex };
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@systemfsoftware/hex-schema",
|
|
3
|
-
"license": "
|
|
4
|
-
"version": "1.
|
|
3
|
+
"license": "Apache-2.0",
|
|
4
|
+
"version": "1.7.0",
|
|
5
5
|
"author": "Ryan Lee <drdgvhbh@gmail.com>",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|
|
@@ -34,27 +34,25 @@
|
|
|
34
34
|
"dist"
|
|
35
35
|
],
|
|
36
36
|
"devDependencies": {
|
|
37
|
-
"@effect/vitest": "0.
|
|
37
|
+
"@effect/vitest": "4.0.0-rc.108",
|
|
38
38
|
"@microsoft/api-extractor": "^7.58.7",
|
|
39
|
-
"@
|
|
39
|
+
"@systemfsoftware/arethetypeswrong-cli": "^1.1.1",
|
|
40
40
|
"@types/node": "^24",
|
|
41
|
-
"effect": "
|
|
42
|
-
"fast-check": "^
|
|
41
|
+
"effect": "4.0.0-rc.108",
|
|
42
|
+
"fast-check": "^4",
|
|
43
|
+
"oxlint": "^1.77.0",
|
|
43
44
|
"rimraf": "^6.1.3",
|
|
44
|
-
"tsdown": "^0.22.
|
|
45
|
-
"vitest": "^4",
|
|
46
|
-
"@systemfsoftware/effect-schema-
|
|
47
|
-
"@systemfsoftware/arethetypeswrong-cli": "^1.1.1",
|
|
45
|
+
"tsdown": "^0.22.14",
|
|
46
|
+
"vitest": "^4.1.10",
|
|
47
|
+
"@systemfsoftware/effect-schema-vite": "^1.5.2",
|
|
48
48
|
"@systemfsoftware/oxlint-config": "^0.1.0",
|
|
49
|
-
"@systemfsoftware/stryker-
|
|
50
|
-
"@systemfsoftware/
|
|
51
|
-
"@systemfsoftware/stryker-js-typescript-checker": "^1.2.3",
|
|
52
|
-
"@systemfsoftware/stryker-plugins": "^0.11.0",
|
|
49
|
+
"@systemfsoftware/stryker-plugins": "^0.12.0",
|
|
50
|
+
"@systemfsoftware/tsconfig": "^1.3.2",
|
|
53
51
|
"@systemfsoftware/vitest-config": "^0.1.0",
|
|
54
|
-
"@systemfsoftware/
|
|
52
|
+
"@systemfsoftware/effect-schema-law": "^0.7.0"
|
|
55
53
|
},
|
|
56
54
|
"peerDependencies": {
|
|
57
|
-
"effect": "
|
|
55
|
+
"effect": "4.0.0-rc.108"
|
|
58
56
|
},
|
|
59
57
|
"publishConfig": {
|
|
60
58
|
"provenance": true
|
|
@@ -66,9 +64,9 @@
|
|
|
66
64
|
"test": "vitest run",
|
|
67
65
|
"api:check": "api-extractor run",
|
|
68
66
|
"api:update": "api-extractor run --local",
|
|
69
|
-
"lint": "oxlint .
|
|
67
|
+
"lint": "f=${OXLINT_FORMAT:-${AGENT:+agent}}; oxlint . --format=${f:-default}",
|
|
70
68
|
"attw": "attw --pack .",
|
|
71
69
|
"mutation": "stryker run",
|
|
72
|
-
"mutation:full": "stryker run"
|
|
70
|
+
"mutation:full": "stryker run --force"
|
|
73
71
|
}
|
|
74
72
|
}
|