@type-map-for/core 0.1.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/dist/index.d.ts +14 -0
- package/package.json +19 -0
- package/src/index.d.ts +14 -0
- package/src/index.ts +52 -0
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
export type BaseFieldType = 'string' | 'int32' | 'float' | 'bool' | 'object' | string;
|
|
2
|
+
export type FieldType = BaseFieldType | `${BaseFieldType}[]`;
|
|
3
|
+
export type FieldTypeFor<T> = T extends (infer U)[] ? `${FieldTypeFor<U>}[]` : T extends string ? 'string' : T extends number ? 'int32' | 'float' : T extends boolean ? 'bool' : T extends object ? 'object' : never;
|
|
4
|
+
export type MapType<FT extends string, M extends Record<string, string>> = FT extends keyof M ? M[FT] : FT;
|
|
5
|
+
/** True if T (ignoring undefined) is an array type. */
|
|
6
|
+
export type IsArray<T> = NonNullable<T> extends any[] ? true : false;
|
|
7
|
+
/** True if T can be undefined (i.e. optional field). */
|
|
8
|
+
export type IsOptional<T> = undefined extends T ? true : false;
|
|
9
|
+
/** Inner element type of an array, stripping undefined. */
|
|
10
|
+
export type ItemType<T> = NonNullable<T> extends (infer U)[] ? U : NonNullable<T>;
|
|
11
|
+
/** Non-optional keys of T. */
|
|
12
|
+
export type RequiredKeys<T> = {
|
|
13
|
+
[K in keyof T]-?: undefined extends T[K] ? never : K;
|
|
14
|
+
}[keyof T];
|
package/package.json
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@type-map-for/core",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Compile-time field-mapping primitives — FieldTypeFor, MapType, and type utilities",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"author": "Nathan Frenette",
|
|
7
|
+
"types": "./dist/index.d.ts",
|
|
8
|
+
"exports": {
|
|
9
|
+
".": { "types": "./dist/index.d.ts" }
|
|
10
|
+
},
|
|
11
|
+
"files": ["dist", "src"],
|
|
12
|
+
"scripts": {
|
|
13
|
+
"build": "tsc -p tsconfig.json"
|
|
14
|
+
},
|
|
15
|
+
"publishConfig": { "access": "public" },
|
|
16
|
+
"devDependencies": {
|
|
17
|
+
"typescript": "*"
|
|
18
|
+
}
|
|
19
|
+
}
|
package/src/index.d.ts
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
export type BaseFieldType = 'string' | 'int32' | 'float' | 'bool' | 'object' | string;
|
|
2
|
+
export type FieldType = BaseFieldType | `${BaseFieldType}[]`;
|
|
3
|
+
export type FieldTypeFor<T> = T extends (infer U)[] ? `${FieldTypeFor<U>}[]` : T extends string ? 'string' : T extends number ? 'int32' | 'float' : T extends boolean ? 'bool' : T extends object ? 'object' : never;
|
|
4
|
+
export type MapType<FT extends string, M extends Record<string, string>> = FT extends keyof M ? M[FT] : FT;
|
|
5
|
+
/** True if T (ignoring undefined) is an array type. */
|
|
6
|
+
export type IsArray<T> = NonNullable<T> extends any[] ? true : false;
|
|
7
|
+
/** True if T can be undefined (i.e. optional field). */
|
|
8
|
+
export type IsOptional<T> = undefined extends T ? true : false;
|
|
9
|
+
/** Inner element type of an array, stripping undefined. */
|
|
10
|
+
export type ItemType<T> = NonNullable<T> extends (infer U)[] ? U : NonNullable<T>;
|
|
11
|
+
/** Non-optional keys of T. */
|
|
12
|
+
export type RequiredKeys<T> = {
|
|
13
|
+
[K in keyof T]-?: undefined extends T[K] ? never : K;
|
|
14
|
+
}[keyof T];
|
package/src/index.ts
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
/* ------------------------------------------------------------------ *
|
|
2
|
+
* @type-map-for/core *
|
|
3
|
+
* Compile-time field-mapping primitives *
|
|
4
|
+
* ------------------------------------------------------------------ */
|
|
5
|
+
|
|
6
|
+
/* === Canonical base field types ----------------------------------- */
|
|
7
|
+
export type BaseFieldType =
|
|
8
|
+
| 'string'
|
|
9
|
+
| 'int32'
|
|
10
|
+
| 'float'
|
|
11
|
+
| 'bool'
|
|
12
|
+
| 'object'
|
|
13
|
+
| string; // allow custom user-literals
|
|
14
|
+
|
|
15
|
+
export type FieldType = BaseFieldType | `${BaseFieldType}[]`;
|
|
16
|
+
|
|
17
|
+
/* === Infer canonical type from a TypeScript type ------------------ *
|
|
18
|
+
*
|
|
19
|
+
* number → 'int32' | 'float' (TS can't distinguish; use bigint for int64)
|
|
20
|
+
* Distributive over unions, so FieldTypeFor<string | undefined> = 'string'.
|
|
21
|
+
* ------------------------------------------------------------------ */
|
|
22
|
+
export type FieldTypeFor<T> =
|
|
23
|
+
T extends (infer U)[]
|
|
24
|
+
? `${FieldTypeFor<U>}[]`
|
|
25
|
+
: T extends string ? 'string'
|
|
26
|
+
: T extends number ? 'int32' | 'float'
|
|
27
|
+
: T extends boolean ? 'bool'
|
|
28
|
+
: T extends object ? 'object'
|
|
29
|
+
: never;
|
|
30
|
+
|
|
31
|
+
/* === Translate a canonical type using a lookup map ---------------- */
|
|
32
|
+
export type MapType<
|
|
33
|
+
FT extends string,
|
|
34
|
+
M extends Record<string, string>
|
|
35
|
+
> = FT extends keyof M ? M[FT] : FT;
|
|
36
|
+
|
|
37
|
+
/* === Field shape utilities ---------------------------------------- */
|
|
38
|
+
|
|
39
|
+
/** True if T (ignoring undefined) is an array type. */
|
|
40
|
+
export type IsArray<T> = NonNullable<T> extends any[] ? true : false;
|
|
41
|
+
|
|
42
|
+
/** True if T can be undefined (i.e. optional field). */
|
|
43
|
+
export type IsOptional<T> = undefined extends T ? true : false;
|
|
44
|
+
|
|
45
|
+
/** Inner element type of an array, stripping undefined. */
|
|
46
|
+
export type ItemType<T> =
|
|
47
|
+
NonNullable<T> extends (infer U)[] ? U : NonNullable<T>;
|
|
48
|
+
|
|
49
|
+
/** Non-optional keys of T. */
|
|
50
|
+
export type RequiredKeys<T> = {
|
|
51
|
+
[K in keyof T]-?: undefined extends T[K] ? never : K;
|
|
52
|
+
}[keyof T];
|