ts-fortress 1.0.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/LICENSE +201 -0
- package/README.md +324 -0
- package/dist/array/array-of-length.d.mts +6 -0
- package/dist/array/array-of-length.d.mts.map +1 -0
- package/dist/array/array-of-length.mjs +50 -0
- package/dist/array/array-of-length.mjs.map +1 -0
- package/dist/array/array.d.mts +6 -0
- package/dist/array/array.d.mts.map +1 -0
- package/dist/array/array.mjs +39 -0
- package/dist/array/array.mjs.map +1 -0
- package/dist/array/index.d.mts +5 -0
- package/dist/array/index.d.mts.map +1 -0
- package/dist/array/index.mjs +5 -0
- package/dist/array/index.mjs.map +1 -0
- package/dist/array/non-empty-array.d.mts +6 -0
- package/dist/array/non-empty-array.d.mts.map +1 -0
- package/dist/array/non-empty-array.mjs +46 -0
- package/dist/array/non-empty-array.mjs.map +1 -0
- package/dist/array/tuple.d.mts +9 -0
- package/dist/array/tuple.d.mts.map +1 -0
- package/dist/array/tuple.mjs +47 -0
- package/dist/array/tuple.mjs.map +1 -0
- package/dist/branded/brand.d.mts +11 -0
- package/dist/branded/brand.d.mts.map +1 -0
- package/dist/branded/brand.mjs +29 -0
- package/dist/branded/brand.mjs.map +1 -0
- package/dist/branded/index.d.mts +5 -0
- package/dist/branded/index.d.mts.map +1 -0
- package/dist/branded/index.mjs +20 -0
- package/dist/branded/index.mjs.map +1 -0
- package/dist/branded/number/finite-number.d.mts +3 -0
- package/dist/branded/number/finite-number.d.mts.map +1 -0
- package/dist/branded/number/finite-number.mjs +14 -0
- package/dist/branded/number/finite-number.mjs.map +1 -0
- package/dist/branded/number/index.d.mts +17 -0
- package/dist/branded/number/index.d.mts.map +1 -0
- package/dist/branded/number/index.mjs +17 -0
- package/dist/branded/number/index.mjs.map +1 -0
- package/dist/branded/number/int.d.mts +3 -0
- package/dist/branded/number/int.d.mts.map +1 -0
- package/dist/branded/number/int.mjs +14 -0
- package/dist/branded/number/int.mjs.map +1 -0
- package/dist/branded/number/int16.d.mts +3 -0
- package/dist/branded/number/int16.d.mts.map +1 -0
- package/dist/branded/number/int16.mjs +26 -0
- package/dist/branded/number/int16.mjs.map +1 -0
- package/dist/branded/number/int32.d.mts +3 -0
- package/dist/branded/number/int32.d.mts.map +1 -0
- package/dist/branded/number/int32.mjs +22 -0
- package/dist/branded/number/int32.mjs.map +1 -0
- package/dist/branded/number/non-negative-finite-number.d.mts +3 -0
- package/dist/branded/number/non-negative-finite-number.d.mts.map +1 -0
- package/dist/branded/number/non-negative-finite-number.mjs +14 -0
- package/dist/branded/number/non-negative-finite-number.mjs.map +1 -0
- package/dist/branded/number/non-zero-finite-number.d.mts +3 -0
- package/dist/branded/number/non-zero-finite-number.d.mts.map +1 -0
- package/dist/branded/number/non-zero-finite-number.mjs +14 -0
- package/dist/branded/number/non-zero-finite-number.mjs.map +1 -0
- package/dist/branded/number/non-zero-int.d.mts +3 -0
- package/dist/branded/number/non-zero-int.d.mts.map +1 -0
- package/dist/branded/number/non-zero-int.mjs +14 -0
- package/dist/branded/number/non-zero-int.mjs.map +1 -0
- package/dist/branded/number/non-zero-safe-int.d.mts +3 -0
- package/dist/branded/number/non-zero-safe-int.d.mts.map +1 -0
- package/dist/branded/number/non-zero-safe-int.mjs +14 -0
- package/dist/branded/number/non-zero-safe-int.mjs.map +1 -0
- package/dist/branded/number/positive-finite-number.d.mts +3 -0
- package/dist/branded/number/positive-finite-number.d.mts.map +1 -0
- package/dist/branded/number/positive-finite-number.mjs +22 -0
- package/dist/branded/number/positive-finite-number.mjs.map +1 -0
- package/dist/branded/number/positive-int.d.mts +3 -0
- package/dist/branded/number/positive-int.d.mts.map +1 -0
- package/dist/branded/number/positive-int.mjs +23 -0
- package/dist/branded/number/positive-int.mjs.map +1 -0
- package/dist/branded/number/positive-safe-int.d.mts +3 -0
- package/dist/branded/number/positive-safe-int.d.mts.map +1 -0
- package/dist/branded/number/positive-safe-int.mjs +24 -0
- package/dist/branded/number/positive-safe-int.mjs.map +1 -0
- package/dist/branded/number/safe-int.d.mts +3 -0
- package/dist/branded/number/safe-int.d.mts.map +1 -0
- package/dist/branded/number/safe-int.mjs +14 -0
- package/dist/branded/number/safe-int.mjs.map +1 -0
- package/dist/branded/number/safe-uint.d.mts +3 -0
- package/dist/branded/number/safe-uint.d.mts.map +1 -0
- package/dist/branded/number/safe-uint.mjs +23 -0
- package/dist/branded/number/safe-uint.mjs.map +1 -0
- package/dist/branded/number/uint.d.mts +3 -0
- package/dist/branded/number/uint.d.mts.map +1 -0
- package/dist/branded/number/uint.mjs +22 -0
- package/dist/branded/number/uint.mjs.map +1 -0
- package/dist/branded/number/uint16.d.mts +3 -0
- package/dist/branded/number/uint16.d.mts.map +1 -0
- package/dist/branded/number/uint16.mjs +26 -0
- package/dist/branded/number/uint16.mjs.map +1 -0
- package/dist/branded/number/uint32.d.mts +3 -0
- package/dist/branded/number/uint32.d.mts.map +1 -0
- package/dist/branded/number/uint32.mjs +24 -0
- package/dist/branded/number/uint32.mjs.map +1 -0
- package/dist/branded/simple-branded-number.d.mts +3 -0
- package/dist/branded/simple-branded-number.d.mts.map +1 -0
- package/dist/branded/simple-branded-number.mjs +15 -0
- package/dist/branded/simple-branded-number.mjs.map +1 -0
- package/dist/branded/simple-branded-string.d.mts +3 -0
- package/dist/branded/simple-branded-string.d.mts.map +1 -0
- package/dist/branded/simple-branded-string.mjs +15 -0
- package/dist/branded/simple-branded-string.mjs.map +1 -0
- package/dist/compose/index.d.mts +4 -0
- package/dist/compose/index.d.mts.map +1 -0
- package/dist/compose/index.mjs +4 -0
- package/dist/compose/index.mjs.map +1 -0
- package/dist/compose/intersection.d.mts +19 -0
- package/dist/compose/intersection.d.mts.map +1 -0
- package/dist/compose/intersection.mjs +38 -0
- package/dist/compose/intersection.mjs.map +1 -0
- package/dist/compose/merge-records.d.mts +15 -0
- package/dist/compose/merge-records.d.mts.map +1 -0
- package/dist/compose/merge-records.mjs +48 -0
- package/dist/compose/merge-records.mjs.map +1 -0
- package/dist/compose/union.d.mts +14 -0
- package/dist/compose/union.d.mts.map +1 -0
- package/dist/compose/union.mjs +33 -0
- package/dist/compose/union.mjs.map +1 -0
- package/dist/enum/enum.d.mts +6 -0
- package/dist/enum/enum.d.mts.map +1 -0
- package/dist/enum/enum.mjs +34 -0
- package/dist/enum/enum.mjs.map +1 -0
- package/dist/enum/index.d.mts +3 -0
- package/dist/enum/index.d.mts.map +1 -0
- package/dist/enum/index.mjs +3 -0
- package/dist/enum/index.mjs.map +1 -0
- package/dist/enum/uint-range.d.mts +8 -0
- package/dist/enum/uint-range.d.mts.map +1 -0
- package/dist/enum/uint-range.mjs +40 -0
- package/dist/enum/uint-range.mjs.map +1 -0
- package/dist/globals.d.mts +3 -0
- package/dist/index.d.mts +10 -0
- package/dist/index.d.mts.map +1 -0
- package/dist/index.mjs +50 -0
- package/dist/index.mjs.map +1 -0
- package/dist/primitives/bigint.d.mts +4 -0
- package/dist/primitives/bigint.d.mts.map +1 -0
- package/dist/primitives/bigint.mjs +12 -0
- package/dist/primitives/bigint.mjs.map +1 -0
- package/dist/primitives/boolean.d.mts +4 -0
- package/dist/primitives/boolean.d.mts.map +1 -0
- package/dist/primitives/boolean.mjs +12 -0
- package/dist/primitives/boolean.mjs.map +1 -0
- package/dist/primitives/index.d.mts +8 -0
- package/dist/primitives/index.d.mts.map +1 -0
- package/dist/primitives/index.mjs +8 -0
- package/dist/primitives/index.mjs.map +1 -0
- package/dist/primitives/null.d.mts +3 -0
- package/dist/primitives/null.d.mts.map +1 -0
- package/dist/primitives/null.mjs +11 -0
- package/dist/primitives/null.mjs.map +1 -0
- package/dist/primitives/number.d.mts +4 -0
- package/dist/primitives/number.d.mts.map +1 -0
- package/dist/primitives/number.mjs +12 -0
- package/dist/primitives/number.mjs.map +1 -0
- package/dist/primitives/string.d.mts +4 -0
- package/dist/primitives/string.d.mts.map +1 -0
- package/dist/primitives/string.mjs +12 -0
- package/dist/primitives/string.mjs.map +1 -0
- package/dist/primitives/symbol.d.mts +3 -0
- package/dist/primitives/symbol.d.mts.map +1 -0
- package/dist/primitives/symbol.mjs +11 -0
- package/dist/primitives/symbol.mjs.map +1 -0
- package/dist/primitives/undefined.d.mts +3 -0
- package/dist/primitives/undefined.d.mts.map +1 -0
- package/dist/primitives/undefined.mjs +11 -0
- package/dist/primitives/undefined.mjs.map +1 -0
- package/dist/record/index.d.mts +8 -0
- package/dist/record/index.d.mts.map +1 -0
- package/dist/record/index.mjs +8 -0
- package/dist/record/index.mjs.map +1 -0
- package/dist/record/key-value-record.d.mts +7 -0
- package/dist/record/key-value-record.d.mts.map +1 -0
- package/dist/record/key-value-record.mjs +52 -0
- package/dist/record/key-value-record.mjs.map +1 -0
- package/dist/record/keyof.d.mts +7 -0
- package/dist/record/keyof.d.mts.map +1 -0
- package/dist/record/keyof.mjs +15 -0
- package/dist/record/keyof.mjs.map +1 -0
- package/dist/record/omit.d.mts +8 -0
- package/dist/record/omit.d.mts.map +1 -0
- package/dist/record/omit.mjs +39 -0
- package/dist/record/omit.mjs.map +1 -0
- package/dist/record/optional.d.mts +5 -0
- package/dist/record/optional.d.mts.map +1 -0
- package/dist/record/optional.mjs +8 -0
- package/dist/record/optional.mjs.map +1 -0
- package/dist/record/partial.d.mts +13 -0
- package/dist/record/partial.d.mts.map +1 -0
- package/dist/record/partial.mjs +128 -0
- package/dist/record/partial.mjs.map +1 -0
- package/dist/record/pick.d.mts +8 -0
- package/dist/record/pick.d.mts.map +1 -0
- package/dist/record/pick.mjs +39 -0
- package/dist/record/pick.mjs.map +1 -0
- package/dist/record/record.d.mts +21 -0
- package/dist/record/record.d.mts.map +1 -0
- package/dist/record/record.mjs +53 -0
- package/dist/record/record.mjs.map +1 -0
- package/dist/tsconfig.json +1 -0
- package/dist/type.d.mts +27 -0
- package/dist/type.d.mts.map +1 -0
- package/dist/type.mjs +2 -0
- package/dist/type.mjs.map +1 -0
- package/dist/types.d.mts +2 -0
- package/dist/unknown.d.mts +3 -0
- package/dist/unknown.d.mts.map +1 -0
- package/dist/unknown.mjs +18 -0
- package/dist/unknown.mjs.map +1 -0
- package/dist/utils/create-assert-fn.d.mts +3 -0
- package/dist/utils/create-assert-fn.d.mts.map +1 -0
- package/dist/utils/create-assert-fn.mjs +12 -0
- package/dist/utils/create-assert-fn.mjs.map +1 -0
- package/dist/utils/create-cast-fn.d.mts +3 -0
- package/dist/utils/create-cast-fn.d.mts.map +1 -0
- package/dist/utils/create-cast-fn.mjs +13 -0
- package/dist/utils/create-cast-fn.mjs.map +1 -0
- package/dist/utils/create-is-fn.d.mts +3 -0
- package/dist/utils/create-is-fn.d.mts.map +1 -0
- package/dist/utils/create-is-fn.mjs +6 -0
- package/dist/utils/create-is-fn.mjs.map +1 -0
- package/dist/utils/create-primitive-type.d.mts +7 -0
- package/dist/utils/create-primitive-type.d.mts.map +1 -0
- package/dist/utils/create-primitive-type.mjs +24 -0
- package/dist/utils/create-primitive-type.mjs.map +1 -0
- package/dist/utils/create-type.d.mts +8 -0
- package/dist/utils/create-type.d.mts.map +1 -0
- package/dist/utils/create-type.mjs +19 -0
- package/dist/utils/create-type.mjs.map +1 -0
- package/dist/utils/index.d.mts +7 -0
- package/dist/utils/index.d.mts.map +1 -0
- package/dist/utils/index.mjs +7 -0
- package/dist/utils/index.mjs.map +1 -0
- package/dist/utils/validation-error-message.d.mts +2 -0
- package/dist/utils/validation-error-message.d.mts.map +1 -0
- package/dist/utils/validation-error-message.mjs +13 -0
- package/dist/utils/validation-error-message.mjs.map +1 -0
- package/package.json +102 -0
- package/src/array/array-of-length.mts +76 -0
- package/src/array/array-of-length.test.mts +113 -0
- package/src/array/array.mts +62 -0
- package/src/array/array.test.mts +84 -0
- package/src/array/index.mts +4 -0
- package/src/array/non-empty-array.mts +70 -0
- package/src/array/non-empty-array.test.mts +113 -0
- package/src/array/tuple.mts +72 -0
- package/src/array/tuple.test.mts +122 -0
- package/src/branded/brand.mts +70 -0
- package/src/branded/index.mts +4 -0
- package/src/branded/number/finite-number.mts +15 -0
- package/src/branded/number/index.mts +16 -0
- package/src/branded/number/int.mts +13 -0
- package/src/branded/number/int16.mts +25 -0
- package/src/branded/number/int32.mts +21 -0
- package/src/branded/number/non-negative-finite-number.mts +18 -0
- package/src/branded/number/non-zero-finite-number.mts +15 -0
- package/src/branded/number/non-zero-int.mts +15 -0
- package/src/branded/number/non-zero-safe-int.mts +15 -0
- package/src/branded/number/positive-finite-number.mts +23 -0
- package/src/branded/number/positive-int.mts +24 -0
- package/src/branded/number/positive-safe-int.mts +25 -0
- package/src/branded/number/safe-int.mts +13 -0
- package/src/branded/number/safe-uint.mts +24 -0
- package/src/branded/number/uint.mts +21 -0
- package/src/branded/number/uint16.mts +25 -0
- package/src/branded/number/uint32.mts +23 -0
- package/src/branded/simple-branded-number.mts +18 -0
- package/src/branded/simple-branded-string.mts +18 -0
- package/src/combination.test.mts +287 -0
- package/src/compose/index.mts +3 -0
- package/src/compose/intersection.mts +206 -0
- package/src/compose/intersection.test.mts +231 -0
- package/src/compose/merge-records.mts +218 -0
- package/src/compose/merge-records.test.mts +90 -0
- package/src/compose/union.mts +77 -0
- package/src/compose/union.test.mts +92 -0
- package/src/enum/enum.mts +53 -0
- package/src/enum/enum.test.mts +63 -0
- package/src/enum/index.mts +2 -0
- package/src/enum/uint-range.mts +63 -0
- package/src/enum/uint-range.test.mts +66 -0
- package/src/globals.d.mts +3 -0
- package/src/index.mts +9 -0
- package/src/primitives/bigint.mts +13 -0
- package/src/primitives/boolean.mts +13 -0
- package/src/primitives/index.mts +7 -0
- package/src/primitives/null.mts +9 -0
- package/src/primitives/number.mts +13 -0
- package/src/primitives/string.mts +13 -0
- package/src/primitives/symbol.mts +10 -0
- package/src/primitives/undefined.mts +9 -0
- package/src/record/index.mts +7 -0
- package/src/record/key-value-record.mts +84 -0
- package/src/record/key-value-record.test.mts +96 -0
- package/src/record/keyof.mts +31 -0
- package/src/record/keyof.test.mts +73 -0
- package/src/record/omit.mts +94 -0
- package/src/record/omit.test.mts +116 -0
- package/src/record/optional.mts +16 -0
- package/src/record/partial.mts +186 -0
- package/src/record/partial.test.mts +261 -0
- package/src/record/pick.mts +98 -0
- package/src/record/pick.test.mts +116 -0
- package/src/record/record.mts +105 -0
- package/src/record/record.test.mts +253 -0
- package/src/type.mts +30 -0
- package/src/unknown.mts +17 -0
- package/src/utils/create-assert-fn.mts +14 -0
- package/src/utils/create-cast-fn.mts +15 -0
- package/src/utils/create-is-fn.mts +7 -0
- package/src/utils/create-primitive-type.mts +35 -0
- package/src/utils/create-type.mts +28 -0
- package/src/utils/index.mts +6 -0
- package/src/utils/validation-error-message.mts +17 -0
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
import { Obj, isRecord, Result, ISet } from 'ts-data-forge';
|
|
2
|
+
import { createAssertFn } from '../utils/create-assert-fn.mjs';
|
|
3
|
+
import { createCastFn } from '../utils/create-cast-fn.mjs';
|
|
4
|
+
import { createIsFn } from '../utils/create-is-fn.mjs';
|
|
5
|
+
import { validationErrorMessage } from '../utils/validation-error-message.mjs';
|
|
6
|
+
|
|
7
|
+
/**
|
|
8
|
+
* Creates a Partial type. If keysToBeOptional is set, only those keys are
|
|
9
|
+
* optional, otherwise, all properties are optional.
|
|
10
|
+
*/
|
|
11
|
+
const partial = (recordType, options) => {
|
|
12
|
+
const typeNameFilled = options?.typeName ??
|
|
13
|
+
(options?.keysToBeOptional === undefined
|
|
14
|
+
? `Partial<${recordType.typeName}>`
|
|
15
|
+
: `PartiallyPartial<${recordType.typeName}, ${options.keysToBeOptional.join('|')}>`);
|
|
16
|
+
const keysToBeOptional = options?.keysToBeOptional ?? Object.keys(recordType.defaultValue);
|
|
17
|
+
// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
|
|
18
|
+
const defaultValue = Obj.omit(recordType.defaultValue, keysToBeOptional);
|
|
19
|
+
const validate = (a) => {
|
|
20
|
+
if (!isRecord(a)) {
|
|
21
|
+
return Result.err([
|
|
22
|
+
validationErrorMessage(a, 'The value is expected to be a record'),
|
|
23
|
+
]);
|
|
24
|
+
}
|
|
25
|
+
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions
|
|
26
|
+
const objectFilled = {
|
|
27
|
+
// fill optional properties to skip check by recordType.validate
|
|
28
|
+
...Obj.pick(recordType.defaultValue, keysToBeOptional),
|
|
29
|
+
// overwrite with `a`
|
|
30
|
+
...a,
|
|
31
|
+
};
|
|
32
|
+
// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
|
|
33
|
+
return recordType.validate(objectFilled);
|
|
34
|
+
};
|
|
35
|
+
const fill = (a) => {
|
|
36
|
+
if (!isRecord(a)) {
|
|
37
|
+
return defaultValue;
|
|
38
|
+
}
|
|
39
|
+
const inputKeys = ISet.create(Object.keys(a));
|
|
40
|
+
// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
|
|
41
|
+
return Obj.omit(
|
|
42
|
+
// First, create a recursively filled object with all properties required.
|
|
43
|
+
recordType.fill(a),
|
|
44
|
+
// Then, Omit optional properties not present in `a`.
|
|
45
|
+
keysToBeOptional.filter((k) =>
|
|
46
|
+
// avoid removing properties from `a`
|
|
47
|
+
!inputKeys.has(k)));
|
|
48
|
+
};
|
|
49
|
+
return {
|
|
50
|
+
typeName: typeNameFilled,
|
|
51
|
+
defaultValue,
|
|
52
|
+
fill,
|
|
53
|
+
validate,
|
|
54
|
+
is: createIsFn(validate),
|
|
55
|
+
assertIs: createAssertFn(validate),
|
|
56
|
+
cast: createCastFn(validate),
|
|
57
|
+
};
|
|
58
|
+
};
|
|
59
|
+
// expectType<TsFortressInternal.SetOptional<Type<0>>, OptionalType<0>>('=');
|
|
60
|
+
// expectType<
|
|
61
|
+
// TsFortressInternal.SetOptionalForAllKey<{
|
|
62
|
+
// a: Type<0>;
|
|
63
|
+
// }>,
|
|
64
|
+
// Readonly<{
|
|
65
|
+
// a: OptionalType<0>;
|
|
66
|
+
// }>
|
|
67
|
+
// >('=');
|
|
68
|
+
// expectType<
|
|
69
|
+
// TsFortressInternal.SetOptionalForAllKey<{
|
|
70
|
+
// a: Type<0>;
|
|
71
|
+
// b: OptionalType<0>;
|
|
72
|
+
// }>,
|
|
73
|
+
// Readonly<{
|
|
74
|
+
// a: OptionalType<0>;
|
|
75
|
+
// b: OptionalType<0>;
|
|
76
|
+
// }>
|
|
77
|
+
// >('=');
|
|
78
|
+
// expectType<
|
|
79
|
+
// TsFortressInternal.SetOptionalForAllKey<
|
|
80
|
+
// RecordType<{
|
|
81
|
+
// a: OptionalType<0>;
|
|
82
|
+
// b: OptionalType<0>;
|
|
83
|
+
// c: Type<0>;
|
|
84
|
+
// }>['source']
|
|
85
|
+
// >,
|
|
86
|
+
// Readonly<{
|
|
87
|
+
// a: OptionalType<0>;
|
|
88
|
+
// b: OptionalType<0>;
|
|
89
|
+
// c: OptionalType<0>;
|
|
90
|
+
// }>
|
|
91
|
+
// >('=');
|
|
92
|
+
// expectType<
|
|
93
|
+
// PartialType<
|
|
94
|
+
// RecordType<{
|
|
95
|
+
// a: OptionalType<0>;
|
|
96
|
+
// b: OptionalType<0>;
|
|
97
|
+
// c: Type<0>;
|
|
98
|
+
// }>,
|
|
99
|
+
// undefined
|
|
100
|
+
// >,
|
|
101
|
+
// RecordType<
|
|
102
|
+
// Readonly<{
|
|
103
|
+
// a: OptionalType<0>;
|
|
104
|
+
// b: OptionalType<0>;
|
|
105
|
+
// c: OptionalType<0>;
|
|
106
|
+
// }>
|
|
107
|
+
// >
|
|
108
|
+
// >('=');
|
|
109
|
+
// expectType<
|
|
110
|
+
// PartialType<
|
|
111
|
+
// Type<{
|
|
112
|
+
// a: OptionalType<0>;
|
|
113
|
+
// b: Type<0>;
|
|
114
|
+
// c: Type<0>;
|
|
115
|
+
// }>,
|
|
116
|
+
// ['b']
|
|
117
|
+
// >,
|
|
118
|
+
// RecordType<
|
|
119
|
+
// Readonly<{
|
|
120
|
+
// a: OptionalType<0>;
|
|
121
|
+
// b: OptionalType<0>;
|
|
122
|
+
// c: Type<0>;
|
|
123
|
+
// }>
|
|
124
|
+
// >
|
|
125
|
+
// >('=');
|
|
126
|
+
|
|
127
|
+
export { partial };
|
|
128
|
+
//# sourceMappingURL=partial.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"partial.mjs","sources":["../../src/record/partial.mts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;AASA;;;AAGG;MACU,OAAO,GAAG,CAIrB,UAAa,EACb,OAKC,KACmC;AAGpC,IAAA,MAAM,cAAc,GAClB,OAAO,EAAE,QAAQ;AACjB,SAAC,OAAO,EAAE,gBAAgB,KAAK;AAC7B,cAAE,CAAA,QAAA,EAAW,UAAU,CAAC,QAAQ,CAAA,CAAA;AAChC,cAAE,CAAA,iBAAA,EAAoB,UAAU,CAAC,QAAQ,KAAK,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA,CAAA,CAAG,CAAC;AAExF,IAAA,MAAM,gBAAgB,GACpB,OAAO,EAAE,gBAAgB,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;;AAGnE,IAAA,MAAM,YAAY,GAAM,GAAG,CAAC,IAAI,CAC9B,UAAU,CAAC,YAAY,EACvB,gBAAgB,CACZ;AAEN,IAAA,MAAM,QAAQ,GAAwB,CAAC,CAAC,KAAI;AAC1C,QAAA,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;YAChB,OAAO,MAAM,CAAC,GAAG,CAAC;AAChB,gBAAA,sBAAsB,CAAC,CAAC,EAAE,sCAAsC,CAAC;AAClE,aAAA,CAAC;;;AAIJ,QAAA,MAAM,YAAY,GAAG;;YAEnB,GAAG,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,gBAAgB,CAAC;;AAEtD,YAAA,GAAG,CAAC;SACQ;;AAGd,QAAA,OAAO,UAAU,CAAC,QAAQ,CAAC,YAAY,CAAoC;AAC7E,IAAA,CAAC;AAED,IAAA,MAAM,IAAI,GAAoB,CAAC,CAAC,KAAI;AAClC,QAAA,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;AAChB,YAAA,OAAO,YAAY;;AAGrB,QAAA,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;;QAG7C,OAAO,GAAG,CAAC,IAAI;;AAEb,QAAA,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;;AAElB,QAAA,gBAAgB,CAAC,MAAM,CACrB,CAAC,CAAC;;QAEA,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CACpB,CACc;AACnB,IAAA,CAAC;IAED,OAAO;AACL,QAAA,QAAQ,EAAE,cAAc;QACxB,YAAY;QACZ,IAAI;QACJ,QAAQ;AACR,QAAA,EAAE,EAAE,UAAU,CAAC,QAAQ,CAAC;AACxB,QAAA,QAAQ,EAAE,cAAc,CAAC,QAAQ,CAAC;AAClC,QAAA,IAAI,EAAE,YAAY,CAAC,QAAQ,CAAC;KAC7B;AACH;AAeA;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;;"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { type Type, type TypeOf } from '../type.mjs';
|
|
2
|
+
/** Creates a record type with keys picked. */
|
|
3
|
+
export declare const pick: <const R extends Type<UnknownRecord>, const KeysToPick extends readonly (keyof TypeOf<R> & string)[]>(recordType: R, keysToPick: KeysToPick, options?: Partial<Readonly<{
|
|
4
|
+
typeName: string;
|
|
5
|
+
}>>) => PickedType<R, KeysToPick>;
|
|
6
|
+
type PickedType<R extends Type<UnknownRecord>, KeysToPick extends readonly (keyof TypeOf<R>)[]> = Type<Pick<TypeOf<R>, ArrayElement<KeysToPick>>>;
|
|
7
|
+
export {};
|
|
8
|
+
//# sourceMappingURL=pick.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"pick.d.mts","sourceRoot":"","sources":["../../src/record/pick.mts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,IAAI,EAAE,KAAK,MAAM,EAAE,MAAM,aAAa,CAAC;AAQrD,8CAA8C;AAC9C,eAAO,MAAM,IAAI,GACf,KAAK,CAAC,CAAC,SAAS,IAAI,CAAC,aAAa,CAAC,EACnC,KAAK,CAAC,UAAU,SAAS,SAAS,CAAC,MAAM,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,EAAE,EAE9D,YAAY,CAAC,EACb,YAAY,UAAU,EACtB,UAAU,OAAO,CACf,QAAQ,CAAC;IACP,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC,CACH,KACA,UAAU,CAAC,CAAC,EAAE,UAAU,CAsC1B,CAAC;AAEF,KAAK,UAAU,CACb,CAAC,SAAS,IAAI,CAAC,aAAa,CAAC,EAC7B,UAAU,SAAS,SAAS,CAAC,MAAM,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,IAC7C,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC"}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { Obj, isRecord, Result } from 'ts-data-forge';
|
|
2
|
+
import { createAssertFn } from '../utils/create-assert-fn.mjs';
|
|
3
|
+
import { createCastFn } from '../utils/create-cast-fn.mjs';
|
|
4
|
+
import { createIsFn } from '../utils/create-is-fn.mjs';
|
|
5
|
+
import { validationErrorMessage } from '../utils/validation-error-message.mjs';
|
|
6
|
+
|
|
7
|
+
/** Creates a record type with keys picked. */
|
|
8
|
+
const pick = (recordType, keysToPick, options) => {
|
|
9
|
+
const typeNameFilled = options?.typeName ??
|
|
10
|
+
`Pick<${recordType.typeName}, ${keysToPick.join('|')}>`;
|
|
11
|
+
const defaultValue = Obj.pick(recordType.defaultValue, keysToPick);
|
|
12
|
+
const validate = (a) => {
|
|
13
|
+
if (!isRecord(a)) {
|
|
14
|
+
return Result.err([
|
|
15
|
+
validationErrorMessage(a, 'The value is expected to be a record'),
|
|
16
|
+
]);
|
|
17
|
+
}
|
|
18
|
+
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions
|
|
19
|
+
const objectFilled = {
|
|
20
|
+
...Obj.omit(recordType.fill(a), keysToPick),
|
|
21
|
+
...a,
|
|
22
|
+
};
|
|
23
|
+
// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
|
|
24
|
+
return recordType.validate(objectFilled);
|
|
25
|
+
};
|
|
26
|
+
const fill = (a) => Obj.pick(recordType.fill(a), keysToPick);
|
|
27
|
+
return {
|
|
28
|
+
typeName: typeNameFilled,
|
|
29
|
+
defaultValue,
|
|
30
|
+
fill,
|
|
31
|
+
validate,
|
|
32
|
+
is: createIsFn(validate),
|
|
33
|
+
assertIs: createAssertFn(validate),
|
|
34
|
+
cast: createCastFn(validate),
|
|
35
|
+
};
|
|
36
|
+
};
|
|
37
|
+
|
|
38
|
+
export { pick };
|
|
39
|
+
//# sourceMappingURL=pick.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"pick.mjs","sources":["../../src/record/pick.mts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;AASA;AACO,MAAM,IAAI,GAAG,CAIlB,UAAa,EACb,UAAsB,EACtB,OAIC,KAC4B;AAG7B,IAAA,MAAM,cAAc,GAClB,OAAO,EAAE,QAAQ;QACjB,CAAA,KAAA,EAAQ,UAAU,CAAC,QAAQ,CAAA,EAAA,EAAK,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA,CAAA,CAAG;AAEzD,IAAA,MAAM,YAAY,GAAM,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,UAAU,CAAM;AAE1E,IAAA,MAAM,QAAQ,GAAwB,CAAC,CAAC,KAAI;AAC1C,QAAA,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;YAChB,OAAO,MAAM,CAAC,GAAG,CAAC;AAChB,gBAAA,sBAAsB,CAAC,CAAC,EAAE,sCAAsC,CAAC;AAClE,aAAA,CAAC;;;AAIJ,QAAA,MAAM,YAAY,GAAG;AACnB,YAAA,GAAG,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC;AAC3C,YAAA,GAAG,CAAC;SACQ;;AAGd,QAAA,OAAO,UAAU,CAAC,QAAQ,CAAC,YAAY,CAAoC;AAC7E,IAAA,CAAC;IAED,MAAM,IAAI,GAAoB,CAAC,CAAC,KAC9B,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,UAAU,CAAM;IAE/C,OAAO;AACL,QAAA,QAAQ,EAAE,cAAc;QACxB,YAAY;QACZ,IAAI;QACJ,QAAQ;AACR,QAAA,EAAE,EAAE,UAAU,CAAC,QAAQ,CAAC;AACxB,QAAA,QAAQ,EAAE,cAAc,CAAC,QAAQ,CAAC;AAClC,QAAA,IAAI,EAAE,YAAY,CAAC,QAAQ,CAAC;KAC7B;AACH;;;;"}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import { type Type, type TypeOf } from '../type.mjs';
|
|
2
|
+
export declare const record: <const R extends Record<string, Type<unknown>>>(source: R, options?: Partial<Readonly<{
|
|
3
|
+
typeName: string;
|
|
4
|
+
}>>) => Type<RecordTypeValue<R>>;
|
|
5
|
+
type RecordTypeValue<R extends Record<string, Type<unknown>>> = TsFortressInternal.RecordTypeValueImpl<R>;
|
|
6
|
+
declare namespace TsFortressInternal {
|
|
7
|
+
export type RecordTypeValueImpl<R extends Record<string, Type<unknown>>> = RecordTypeValueImplSub<R, OptionalTypeKeys<R>>;
|
|
8
|
+
type RecordTypeValueImplSub<A extends Record<string, Type<unknown>>, OptionalKeys extends keyof A> = Readonly<{
|
|
9
|
+
[key in OptionalKeys]?: TypeOf<A[key]>;
|
|
10
|
+
} & {
|
|
11
|
+
[key in Exclude<keyof A, OptionalKeys>]: TypeOf<A[key]>;
|
|
12
|
+
}>;
|
|
13
|
+
type OptionalTypeKeys<A extends Record<string, Type<unknown>>> = {
|
|
14
|
+
[K in keyof A]: A[K] extends {
|
|
15
|
+
optional: true;
|
|
16
|
+
} ? K : never;
|
|
17
|
+
}[keyof A];
|
|
18
|
+
export {};
|
|
19
|
+
}
|
|
20
|
+
export {};
|
|
21
|
+
//# sourceMappingURL=record.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"record.d.mts","sourceRoot":"","sources":["../../src/record/record.mts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,IAAI,EAAE,KAAK,MAAM,EAAE,MAAM,aAAa,CAAC;AAQrD,eAAO,MAAM,MAAM,GAAI,KAAK,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,EAClE,QAAQ,CAAC,EACT,UAAU,OAAO,CACf,QAAQ,CAAC;IACP,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC,CACH,KACA,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAiEzB,CAAC;AAEF,KAAK,eAAe,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,IAC1D,kBAAkB,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;AAE5C,kBAAU,kBAAkB,CAAC;IAC3B,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,IACrE,sBAAsB,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;IAEjD,KAAK,sBAAsB,CACzB,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,EACvC,YAAY,SAAS,MAAM,CAAC,IAC1B,QAAQ,CACV;SACG,GAAG,IAAI,YAAY,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;KACvC,GAAG;SACD,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,EAAE,YAAY,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;KACxD,CACF,CAAC;IAEF,KAAK,gBAAgB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI;SAC9D,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS;YAAE,QAAQ,EAAE,IAAI,CAAA;SAAE,GAAG,CAAC,GAAG,KAAK;KAC5D,CAAC,MAAM,CAAC,CAAC,CAAC;;CACZ"}
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
import { tp, isRecord, Result } from 'ts-data-forge';
|
|
2
|
+
import { createAssertFn } from '../utils/create-assert-fn.mjs';
|
|
3
|
+
import { createCastFn } from '../utils/create-cast-fn.mjs';
|
|
4
|
+
import { createIsFn } from '../utils/create-is-fn.mjs';
|
|
5
|
+
import { validationErrorMessage } from '../utils/validation-error-message.mjs';
|
|
6
|
+
|
|
7
|
+
const record = (source, options) => {
|
|
8
|
+
const typeNameFilled = options?.typeName ??
|
|
9
|
+
`{ ${Object.entries(source)
|
|
10
|
+
.map(([k, v]) => `${k}: ${v.typeName}`)
|
|
11
|
+
.join(', ')} }`;
|
|
12
|
+
const defaultValue =
|
|
13
|
+
// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
|
|
14
|
+
Object.fromEntries(Object.entries(source).map(([key, value]) => tp(key, value.defaultValue)));
|
|
15
|
+
const validate = (a) => {
|
|
16
|
+
if (!isRecord(a)) {
|
|
17
|
+
return Result.err([
|
|
18
|
+
validationErrorMessage(a, 'The value is expected to be a record'),
|
|
19
|
+
]);
|
|
20
|
+
}
|
|
21
|
+
for (const [k, valueType] of Object.entries(source)) {
|
|
22
|
+
if (!Object.hasOwn(a, k)) {
|
|
23
|
+
if (source[k]?.optional === true)
|
|
24
|
+
continue;
|
|
25
|
+
return Result.err([`The record is expected to have the key "${k}".`]);
|
|
26
|
+
}
|
|
27
|
+
const v = a[k];
|
|
28
|
+
const res = valueType.validate(v);
|
|
29
|
+
if (Result.isErr(res)) {
|
|
30
|
+
const message = validationErrorMessage(v, `The value at record key "${k}" is expected to be <${valueType.typeName}>`);
|
|
31
|
+
return Result.err([message, ...res.value]);
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
|
|
35
|
+
return Result.ok(a);
|
|
36
|
+
};
|
|
37
|
+
const fill = (a) => isRecord(a)
|
|
38
|
+
? // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
|
|
39
|
+
Object.fromEntries(Object.entries(source).map(([k, v]) => tp(k, Object.hasOwn(a, k) ? v.fill(a[k]) : v.defaultValue)))
|
|
40
|
+
: defaultValue;
|
|
41
|
+
return {
|
|
42
|
+
typeName: typeNameFilled,
|
|
43
|
+
defaultValue,
|
|
44
|
+
fill,
|
|
45
|
+
validate,
|
|
46
|
+
is: createIsFn(validate),
|
|
47
|
+
assertIs: createAssertFn(validate),
|
|
48
|
+
cast: createCastFn(validate),
|
|
49
|
+
};
|
|
50
|
+
};
|
|
51
|
+
|
|
52
|
+
export { record };
|
|
53
|
+
//# sourceMappingURL=record.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"record.mjs","sources":["../../src/record/record.mts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;MASa,MAAM,GAAG,CACpB,MAAS,EACT,OAIC,KAC2B;AAG5B,IAAA,MAAM,cAAc,GAClB,OAAO,EAAE,QAAQ;AACjB,QAAA,CAAA,EAAA,EAAK,MAAM,CAAC,OAAO,CAAC,MAAM;AACvB,aAAA,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,GAAG,CAAC,CAAA,EAAA,EAAK,CAAC,CAAC,QAAQ,EAAE;AACrC,aAAA,IAAI,CAAC,IAAI,CAAC,CAAA,EAAA,CAAI;AAEnB,IAAA,MAAM,YAAY;;AAEhB,IAAA,MAAM,CAAC,WAAW,CAChB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC,CACrE;AAER,IAAA,MAAM,QAAQ,GAAwB,CAAC,CAAC,KAAI;AAC1C,QAAA,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;YAChB,OAAO,MAAM,CAAC,GAAG,CAAC;AAChB,gBAAA,sBAAsB,CAAC,CAAC,EAAE,sCAAsC,CAAC;AAClE,aAAA,CAAC;QACJ;AAEA,QAAA,KAAK,MAAM,CAAC,CAAC,EAAE,SAAS,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;YACnD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE;AACxB,gBAAA,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,QAAQ,KAAK,IAAI;oBAAE;gBAElC,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,2CAA2C,CAAC,CAAA,EAAA,CAAI,CAAC,CAAC;YACvE;AAEA,YAAA,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YACd,MAAM,GAAG,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;AAEjC,YAAA,IAAI,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;AACrB,gBAAA,MAAM,OAAO,GAAG,sBAAsB,CACpC,CAAC,EACD,CAAA,yBAAA,EAA4B,CAAC,CAAA,qBAAA,EAAwB,SAAS,CAAC,QAAQ,CAAA,CAAA,CAAG,CAC3E;AAED,gBAAA,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC;YAC5C;QACF;;AAGA,QAAA,OAAO,MAAM,CAAC,EAAE,CAAC,CAAM,CAAC;AAC1B,IAAA,CAAC;IAED,MAAM,IAAI,GAAoB,CAAC,CAAC,KAC9B,QAAQ,CAAC,CAAC;AACR;YACG,MAAM,CAAC,WAAW,CACjB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAChC,EAAE,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,YAAY,CAAC,CAC3D;UAEH,YAAY;IAElB,OAAO;AACL,QAAA,QAAQ,EAAE,cAAc;QACxB,YAAY;QACZ,IAAI;QACJ,QAAQ;AACR,QAAA,EAAE,EAAE,UAAU,CAAC,QAAQ,CAAC;AACxB,QAAA,QAAQ,EAAE,cAAc,CAAC,QAAQ,CAAC;AAClC,QAAA,IAAI,EAAE,YAAY,CAAC,QAAQ,CAAC;KAC7B;AACH;;;;"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"include":["."]}
|
package/dist/type.d.mts
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { type Result } from 'ts-data-forge';
|
|
2
|
+
/**
|
|
3
|
+
* - `typeName` : Name for this type
|
|
4
|
+
* - `is` : Type guard function
|
|
5
|
+
* - `assertIs` : Type assertion function
|
|
6
|
+
* - `cast` : Cast function
|
|
7
|
+
* - `fill` : Default value filling function
|
|
8
|
+
* - `validate` : A base function to be used in `is` and `assertIs`. `validate`
|
|
9
|
+
* returns Result.Ok if the value is of Type A, otherwise returns Result.Err
|
|
10
|
+
* with error message stack as the value.
|
|
11
|
+
*/
|
|
12
|
+
export type Type<A> = Readonly<{
|
|
13
|
+
typeName: string;
|
|
14
|
+
defaultValue: A;
|
|
15
|
+
is: (a: unknown) => a is A;
|
|
16
|
+
assertIs: (a: unknown) => asserts a is A;
|
|
17
|
+
cast: (a: unknown) => A;
|
|
18
|
+
fill: (a: unknown) => A;
|
|
19
|
+
validate: (a: unknown) => Result<A, readonly string[]>;
|
|
20
|
+
/** Used in record type */
|
|
21
|
+
optional?: true;
|
|
22
|
+
}>;
|
|
23
|
+
export type TypeOf<A extends Type<unknown>> = A['defaultValue'];
|
|
24
|
+
export type OptionalType<A> = MergeIntersection<Type<A> & Readonly<{
|
|
25
|
+
optional: true;
|
|
26
|
+
}>>;
|
|
27
|
+
//# sourceMappingURL=type.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"type.d.mts","sourceRoot":"","sources":["../src/type.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,eAAe,CAAC;AAE5C;;;;;;;;;GASG;AACH,MAAM,MAAM,IAAI,CAAC,CAAC,IAAI,QAAQ,CAAC;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,CAAC,CAAC;IAChB,EAAE,EAAE,CAAC,CAAC,EAAE,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC;IAC3B,QAAQ,EAAE,CAAC,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;IACzC,IAAI,EAAE,CAAC,CAAC,EAAE,OAAO,KAAK,CAAC,CAAC;IACxB,IAAI,EAAE,CAAC,CAAC,EAAE,OAAO,KAAK,CAAC,CAAC;IACxB,QAAQ,EAAE,CAAC,CAAC,EAAE,OAAO,KAAK,MAAM,CAAC,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC,CAAC;IAEvD,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,IAAI,CAAC;CACjB,CAAC,CAAC;AAEH,MAAM,MAAM,MAAM,CAAC,CAAC,SAAS,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,cAAc,CAAC,CAAC;AAEhE,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,iBAAiB,CAC7C,IAAI,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC;IAAE,QAAQ,EAAE,IAAI,CAAA;CAAE,CAAC,CACvC,CAAC"}
|
package/dist/type.mjs
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"type.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":""}
|
package/dist/types.d.mts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"unknown.d.mts","sourceRoot":"","sources":["../src/unknown.mts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,YAAY,CAAC;AAGvC,eAAO,MAAM,OAAO,GAAI,eAAe,OAAO,KAAG,IAAI,CAAC,OAAO,CAQ3D,CAAC"}
|
package/dist/unknown.mjs
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { Result } from 'ts-data-forge';
|
|
2
|
+
import { createAssertFn } from './utils/create-assert-fn.mjs';
|
|
3
|
+
import { createCastFn } from './utils/create-cast-fn.mjs';
|
|
4
|
+
|
|
5
|
+
const unknown = (defaultValue) => ({
|
|
6
|
+
typeName: 'unknown',
|
|
7
|
+
defaultValue,
|
|
8
|
+
is,
|
|
9
|
+
fill: (a) => a,
|
|
10
|
+
validate,
|
|
11
|
+
assertIs: createAssertFn(validate),
|
|
12
|
+
cast: createCastFn(validate),
|
|
13
|
+
});
|
|
14
|
+
const validate = Result.ok;
|
|
15
|
+
const is = (_a) => true;
|
|
16
|
+
|
|
17
|
+
export { unknown };
|
|
18
|
+
//# sourceMappingURL=unknown.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"unknown.mjs","sources":["../src/unknown.mts"],"sourcesContent":[null],"names":[],"mappings":";;;;MAIa,OAAO,GAAG,CAAC,YAAsB,MAAqB;AACjE,IAAA,QAAQ,EAAE,SAAS;IACnB,YAAY;IACZ,EAAE;AACF,IAAA,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC;IACd,QAAQ;AACR,IAAA,QAAQ,EAAE,cAAc,CAAC,QAAQ,CAAC;AAClC,IAAA,IAAI,EAAE,YAAY,CAAC,QAAQ,CAAC;AAC7B,CAAA;AAED,MAAM,QAAQ,GAA8B,MAAM,CAAC,EAAE;AAErD,MAAM,EAAE,GAAG,CAAC,EAAW,KAAoB,IAAI;;;;"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"create-assert-fn.d.mts","sourceRoot":"","sources":["../../src/utils/create-assert-fn.mts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,aAAa,CAAC;AAKxC,eAAO,MAAM,cAAc,GACxB,CAAC,EAAG,UAAU,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,MACjC,GAAG,OAAO,KAAG,QAAQ,CAAC,IAAI,CAK1B,CAAC"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { Result } from 'ts-data-forge';
|
|
2
|
+
|
|
3
|
+
const validationResultToString = (result) => `\n${result.join(',\n')}`;
|
|
4
|
+
const createAssertFn = (validate) => (a) => {
|
|
5
|
+
const res = validate(a);
|
|
6
|
+
if (Result.isErr(res)) {
|
|
7
|
+
throw new Error(validationResultToString(res.value));
|
|
8
|
+
}
|
|
9
|
+
};
|
|
10
|
+
|
|
11
|
+
export { createAssertFn };
|
|
12
|
+
//# sourceMappingURL=create-assert-fn.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"create-assert-fn.mjs","sources":["../../src/utils/create-assert-fn.mts"],"sourcesContent":[null],"names":[],"mappings":";;AAGA,MAAM,wBAAwB,GAAG,CAAC,MAAyB,KACzD,CAAA,EAAA,EAAK,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;AAEpB,MAAM,cAAc,GACzB,CAAK,QAA6B,KAClC,CAAC,CAAU,KAAoB;AAC7B,IAAA,MAAM,GAAG,GAAG,QAAQ,CAAC,CAAC,CAAC;AACvB,IAAA,IAAI,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;QACrB,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACtD;AACF;;;;"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"create-cast-fn.d.mts","sourceRoot":"","sources":["../../src/utils/create-cast-fn.mts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,aAAa,CAAC;AAKxC,eAAO,MAAM,YAAY,GACtB,CAAC,EAAG,UAAU,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,MACjC,GAAG,OAAO,KAAG,CAMb,CAAC"}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { Result } from 'ts-data-forge';
|
|
2
|
+
|
|
3
|
+
const validationResultToString = (result) => `\n${result.join(',\n')}`;
|
|
4
|
+
const createCastFn = (validate) => (a) => {
|
|
5
|
+
const res = validate(a);
|
|
6
|
+
if (Result.isErr(res)) {
|
|
7
|
+
throw new Error(validationResultToString(res.value));
|
|
8
|
+
}
|
|
9
|
+
return res.value;
|
|
10
|
+
};
|
|
11
|
+
|
|
12
|
+
export { createCastFn };
|
|
13
|
+
//# sourceMappingURL=create-cast-fn.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"create-cast-fn.mjs","sources":["../../src/utils/create-cast-fn.mts"],"sourcesContent":[null],"names":[],"mappings":";;AAGA,MAAM,wBAAwB,GAAG,CAAC,MAAyB,KACzD,CAAA,EAAA,EAAK,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;AAEpB,MAAM,YAAY,GACvB,CAAK,QAA6B,KAClC,CAAC,CAAU,KAAO;AAChB,IAAA,MAAM,GAAG,GAAG,QAAQ,CAAC,CAAC,CAAC;AACvB,IAAA,IAAI,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;QACrB,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACtD;IACA,OAAO,GAAG,CAAC,KAAK;AAClB;;;;"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"create-is-fn.d.mts","sourceRoot":"","sources":["../../src/utils/create-is-fn.mts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,aAAa,CAAC;AAExC,eAAO,MAAM,UAAU,GACpB,CAAC,EAAG,UAAU,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,MACjC,GAAG,OAAO,KAAG,CAAC,IAAI,CACO,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"create-is-fn.mjs","sources":["../../src/utils/create-is-fn.mts"],"sourcesContent":[null],"names":[],"mappings":";;MAGa,UAAU,GACrB,CAAK,QAA6B,KAClC,CAAC,CAAU,KACT,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;;;;"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { type Type } from '../type.mjs';
|
|
2
|
+
export declare const createPrimitiveType: <A extends Primitive>({ typeName, defaultValue, is, }: Readonly<{
|
|
3
|
+
typeName: string;
|
|
4
|
+
defaultValue: A;
|
|
5
|
+
is: (value: unknown) => value is A;
|
|
6
|
+
}>) => Type<A>;
|
|
7
|
+
//# sourceMappingURL=create-primitive-type.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"create-primitive-type.d.mts","sourceRoot":"","sources":["../../src/utils/create-primitive-type.mts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,aAAa,CAAC;AAKxC,eAAO,MAAM,mBAAmB,GAAI,CAAC,SAAS,SAAS,EAAE,iCAItD,QAAQ,CAAC;IACV,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,CAAC,CAAC;IAChB,EAAE,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAAC;CACpC,CAAC,KAAG,IAAI,CAAC,CAAC,CAoBV,CAAC"}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { Result } from 'ts-data-forge';
|
|
2
|
+
import { createAssertFn } from './create-assert-fn.mjs';
|
|
3
|
+
import { createCastFn } from './create-cast-fn.mjs';
|
|
4
|
+
import { validationErrorMessage } from './validation-error-message.mjs';
|
|
5
|
+
|
|
6
|
+
const createPrimitiveType = ({ typeName, defaultValue, is, }) => {
|
|
7
|
+
const validate = (a) => is(a)
|
|
8
|
+
? Result.ok(a)
|
|
9
|
+
: Result.err([
|
|
10
|
+
validationErrorMessage(a, `The value is expected to be <${typeName}>`),
|
|
11
|
+
]);
|
|
12
|
+
return {
|
|
13
|
+
typeName,
|
|
14
|
+
defaultValue,
|
|
15
|
+
is,
|
|
16
|
+
fill: (a) => (is(a) ? a : defaultValue),
|
|
17
|
+
validate,
|
|
18
|
+
assertIs: createAssertFn(validate),
|
|
19
|
+
cast: createCastFn(validate),
|
|
20
|
+
};
|
|
21
|
+
};
|
|
22
|
+
|
|
23
|
+
export { createPrimitiveType };
|
|
24
|
+
//# sourceMappingURL=create-primitive-type.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"create-primitive-type.mjs","sources":["../../src/utils/create-primitive-type.mts"],"sourcesContent":[null],"names":[],"mappings":";;;;;AAMO,MAAM,mBAAmB,GAAG,CAAsB,EACvD,QAAQ,EACR,YAAY,EACZ,EAAE,GAKF,KAAa;IACb,MAAM,QAAQ,GAAwB,CAAC,CAAC,KACtC,EAAE,CAAC,CAAC;AACF,UAAE,MAAM,CAAC,EAAE,CAAC,CAAC;AACb,UAAE,MAAM,CAAC,GAAG,CAAC;AACT,YAAA,sBAAsB,CACpB,CAAC,EACD,CAAA,6BAAA,EAAgC,QAAQ,GAAG,CAC5C;AACF,SAAA,CAAC;IAER,OAAO;QACL,QAAQ;QACR,YAAY;QACZ,EAAE;AACF,QAAA,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC;QACvC,QAAQ;AACR,QAAA,QAAQ,EAAE,cAAc,CAAC,QAAQ,CAAC;AAClC,QAAA,IAAI,EAAE,YAAY,CAAC,QAAQ,CAAC;KAC7B;AACH;;;;"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { type Type } from '../type.mjs';
|
|
2
|
+
export declare const createType: <A>({ typeName, defaultValue, validate, fill, }: Readonly<{
|
|
3
|
+
typeName: string;
|
|
4
|
+
defaultValue: A;
|
|
5
|
+
validate: Type<A>["validate"];
|
|
6
|
+
fill?: Type<A>["fill"];
|
|
7
|
+
}>) => Type<A>;
|
|
8
|
+
//# sourceMappingURL=create-type.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"create-type.d.mts","sourceRoot":"","sources":["../../src/utils/create-type.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,aAAa,CAAC;AAKxC,eAAO,MAAM,UAAU,GAAI,CAAC,EAAG,6CAK5B,QAAQ,CAAC;IACV,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,CAAC,CAAC;IAChB,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;IAC9B,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;CACxB,CAAC,KAAG,IAAI,CAAC,CAAC,CAYV,CAAC"}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { createAssertFn } from './create-assert-fn.mjs';
|
|
2
|
+
import { createCastFn } from './create-cast-fn.mjs';
|
|
3
|
+
import { createIsFn } from './create-is-fn.mjs';
|
|
4
|
+
|
|
5
|
+
const createType = ({ typeName, defaultValue, validate, fill, }) => {
|
|
6
|
+
const is = createIsFn(validate);
|
|
7
|
+
return {
|
|
8
|
+
typeName,
|
|
9
|
+
defaultValue,
|
|
10
|
+
validate,
|
|
11
|
+
is,
|
|
12
|
+
assertIs: createAssertFn(validate),
|
|
13
|
+
fill: fill ?? ((a) => (is(a) ? a : defaultValue)),
|
|
14
|
+
cast: createCastFn(validate),
|
|
15
|
+
};
|
|
16
|
+
};
|
|
17
|
+
|
|
18
|
+
export { createType };
|
|
19
|
+
//# sourceMappingURL=create-type.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"create-type.mjs","sources":["../../src/utils/create-type.mts"],"sourcesContent":[null],"names":[],"mappings":";;;;AAKO,MAAM,UAAU,GAAG,CAAK,EAC7B,QAAQ,EACR,YAAY,EACZ,QAAQ,EACR,IAAI,GAMJ,KAAa;AACb,IAAA,MAAM,EAAE,GAAG,UAAU,CAAI,QAAQ,CAAC;IAElC,OAAO;QACL,QAAQ;QACR,YAAY;QACZ,QAAQ;QACR,EAAE;AACF,QAAA,QAAQ,EAAE,cAAc,CAAC,QAAQ,CAAC;QAClC,IAAI,EAAE,IAAI,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,CAAC;AACjD,QAAA,IAAI,EAAE,YAAY,CAAC,QAAQ,CAAC;KAC7B;AACH;;;;"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
export * from './create-assert-fn.mjs';
|
|
2
|
+
export * from './create-cast-fn.mjs';
|
|
3
|
+
export * from './create-is-fn.mjs';
|
|
4
|
+
export * from './create-primitive-type.mjs';
|
|
5
|
+
export * from './create-type.mjs';
|
|
6
|
+
export * from './validation-error-message.mjs';
|
|
7
|
+
//# sourceMappingURL=index.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/utils/index.mts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,mBAAmB,CAAC;AAClC,cAAc,gCAAgC,CAAC"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
export { createAssertFn } from './create-assert-fn.mjs';
|
|
2
|
+
export { createCastFn } from './create-cast-fn.mjs';
|
|
3
|
+
export { createIsFn } from './create-is-fn.mjs';
|
|
4
|
+
export { createPrimitiveType } from './create-primitive-type.mjs';
|
|
5
|
+
export { createType } from './create-type.mjs';
|
|
6
|
+
export { validationErrorMessage } from './validation-error-message.mjs';
|
|
7
|
+
//# sourceMappingURL=index.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"validation-error-message.d.mts","sourceRoot":"","sources":["../../src/utils/validation-error-message.mts"],"names":[],"mappings":"AAEA,eAAO,MAAM,sBAAsB,GACjC,GAAG,OAAO,EACV,QAAQ,MAAM,EACd,SAAQ,CAAC,CAAC,EAAE,MAAM,KAAK,MAA2C,KACjE,MAUF,CAAC"}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { Json, Result } from 'ts-data-forge';
|
|
2
|
+
|
|
3
|
+
const validationErrorMessage = (a, prefix, suffix = (s) => `but it is actually '${s}'`) => {
|
|
4
|
+
const stringifyResult = Json.stringify(a);
|
|
5
|
+
if (Result.isErr(stringifyResult)) {
|
|
6
|
+
return `${prefix}, but it isn't (stringification failed).`;
|
|
7
|
+
}
|
|
8
|
+
const str = stringifyResult.value;
|
|
9
|
+
return `${prefix}, ${suffix(str)}.`;
|
|
10
|
+
};
|
|
11
|
+
|
|
12
|
+
export { validationErrorMessage };
|
|
13
|
+
//# sourceMappingURL=validation-error-message.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"validation-error-message.mjs","sources":["../../src/utils/validation-error-message.mts"],"sourcesContent":[null],"names":[],"mappings":";;AAEO,MAAM,sBAAsB,GAAG,CACpC,CAAU,EACV,MAAc,EACd,SAAgC,CAAC,CAAC,KAAK,uBAAuB,CAAC,CAAA,CAAA,CAAG,KACxD;IACV,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;AAEzC,IAAA,IAAI,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE;QACjC,OAAO,CAAA,EAAG,MAAM,CAAA,wCAAA,CAA0C;IAC5D;AAEA,IAAA,MAAM,GAAG,GAAG,eAAe,CAAC,KAAK;IAEjC,OAAO,CAAA,EAAG,MAAM,CAAA,EAAA,EAAK,MAAM,CAAC,GAAG,CAAC,GAAG;AACrC;;;;"}
|