@sinclair/typebox 0.31.28 → 0.32.0-dev-2

package/esm/type/intersect/index.mjs

@@ -0,0 +1,28 @@
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/type
+
+The MIT License (MIT)
+
+Copyright (c) 2017-2023 Haydn Paterson (sinclair) <haydn.developer@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+---------------------------------------------------------------------------*/
+export * from './intersect.mjs';

package/esm/type/intersect/intersect.d.mts

@@ -0,0 +1,22 @@
+import type { TupleToIntersect, AssertType } from '../helpers/index.mjs';
+import type { TSchema, SchemaOptions } from '../schema/index.mjs';
+import type { Static } from '../static/index.mjs';
+import { type TNever } from '../never/index.mjs';
+import { OptionalFromIntersect } from '../modifiers/index.mjs';
+import { Kind } from '../symbols/index.mjs';
+export type IntersectResolve<T extends TSchema[]> = (T extends [] ? TNever : T extends [TSchema] ? T[0] : OptionalFromIntersect<T>);
+export declare function IntersectResolve<T extends TSchema[]>(T: T): IntersectResolve<T>;
+export type TUnevaluatedProperties = undefined | TSchema | boolean;
+export interface IntersectOptions extends SchemaOptions {
+    unevaluatedProperties?: TUnevaluatedProperties;
+}
+export interface TIntersect<T extends TSchema[] = TSchema[]> extends TSchema, IntersectOptions {
+    [Kind]: 'Intersect';
+    static: TupleToIntersect<{
+        [K in keyof T]: Static<AssertType<T[K]>, this['params']>;
+    }>;
+    type?: 'object';
+    allOf: [...T];
+}
+/** `[Json]` Creates an Intersect type */
+export declare function Intersect<T extends TSchema[]>(T: [...T], options?: IntersectOptions): IntersectResolve<T>;

package/esm/type/intersect/intersect.mjs

@@ -0,0 +1,54 @@
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/type
+
+The MIT License (MIT)
+
+Copyright (c) 2017-2023 Haydn Paterson (sinclair) <haydn.developer@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+---------------------------------------------------------------------------*/
+import { Never } from '../never/index.mjs';
+import { OptionalFromIntersect } from '../modifiers/index.mjs';
+import { Kind } from '../symbols/index.mjs';
+import { CloneType, CloneRest } from '../clone/type.mjs';
+import { TTransform as IsTransformType, TObject as IsObjectType, TSchema as IsSchemaType } from '../guard/type.mjs';
+// prettier-ignore
+export function IntersectResolve(T) {
+    return (T.length === 0
+        ? Never()
+        : T.length === 1
+            ? T[0]
+            : OptionalFromIntersect(T));
+}
+/** `[Json]` Creates an Intersect type */
+export function Intersect(T, options = {}) {
+    if (T.length === 0)
+        return Never();
+    if (T.length === 1)
+        return CloneType(T[0], options);
+    if (T.some((schema) => IsTransformType(schema)))
+        throw new Error('Cannot intersect transform types');
+    const allObjects = T.every((schema) => IsObjectType(schema));
+    const clonedUnevaluatedProperties = IsSchemaType(options.unevaluatedProperties) ? { unevaluatedProperties: CloneType(options.unevaluatedProperties) } : {};
+    return (options.unevaluatedProperties === false || IsSchemaType(options.unevaluatedProperties) || allObjects
+        ? { ...options, ...clonedUnevaluatedProperties, [Kind]: 'Intersect', type: 'object', allOf: CloneRest(T) }
+        : { ...options, ...clonedUnevaluatedProperties, [Kind]: 'Intersect', allOf: CloneRest(T) });
+}

package/esm/type/intrinsic/index.d.mts

@@ -0,0 +1 @@
+export * from './intrinsic.mjs';

package/esm/type/intrinsic/index.mjs

@@ -0,0 +1,28 @@
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/type
+
+The MIT License (MIT)
+
+Copyright (c) 2017-2023 Haydn Paterson (sinclair) <haydn.developer@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+---------------------------------------------------------------------------*/
+export * from './intrinsic.mjs';

package/esm/type/intrinsic/intrinsic.d.mts

@@ -0,0 +1,27 @@
+import type { TSchema, SchemaOptions } from '../schema/index.mjs';
+import { type TTemplateLiteral, type TTemplateLiteralKind } from '../template-literal/index.mjs';
+import { type TLiteral, type TLiteralValue } from '../literal/index.mjs';
+import { type TUnion } from '../union/index.mjs';
+type IntrinsicMode = 'Uppercase' | 'Lowercase' | 'Capitalize' | 'Uncapitalize';
+type FromTemplateLiteral<T extends TTemplateLiteralKind[], M extends IntrinsicMode> = M extends IntrinsicMode ? T extends [infer L extends TTemplateLiteralKind, ...infer R extends TTemplateLiteralKind[]] ? [IntrinsicResolve<L, M>, ...FromTemplateLiteral<R, M>] : T : T;
+declare function FromTemplateLiteral<T extends TTemplateLiteralKind[], M extends IntrinsicMode>(schema: TTemplateLiteral, mode: IntrinsicMode): FromTemplateLiteral<T, M>;
+type FromLiteralValue<T, M extends IntrinsicMode> = (T extends string ? M extends 'Uncapitalize' ? Uncapitalize<T> : M extends 'Capitalize' ? Capitalize<T> : M extends 'Uppercase' ? Uppercase<T> : M extends 'Lowercase' ? Lowercase<T> : string : T);
+declare function FromLiteralValue(value: TLiteralValue, mode: IntrinsicMode): string;
+type FromRest<T extends TSchema[], M extends IntrinsicMode> = T extends [infer L extends TSchema, ...infer R extends TSchema[]] ? [IntrinsicResolve<L, M>, ...FromRest<R, M>] : [];
+declare function FromRest<T extends TSchema[], M extends IntrinsicMode>(T: [...T], mode: M): FromRest<T, M>;
+export type IntrinsicResolve<T extends TSchema, M extends IntrinsicMode> = T extends TTemplateLiteral<infer S> ? TTemplateLiteral<FromTemplateLiteral<S, M>> : T extends TUnion<infer S> ? TUnion<FromRest<S, M>> : T extends TLiteral<infer S> ? TLiteral<FromLiteralValue<S, M>> : T;
+/** Applies an intrinsic string manipulation to the given type. */
+export declare function IntrinsicResolve<T extends TSchema, M extends IntrinsicMode>(schema: T, mode: M): IntrinsicResolve<T, M>;
+export type TUncapitalize<T extends TSchema> = IntrinsicResolve<T, 'Uncapitalize'>;
+/** `[Json]` Intrinsic function to Uncapitalize LiteralString types */
+export declare function Uncapitalize<T extends TSchema>(T: T, options?: SchemaOptions): TUncapitalize<T>;
+export type TUppercase<T extends TSchema> = IntrinsicResolve<T, 'Uppercase'>;
+/** `[Json]` Intrinsic function to Uppercase LiteralString types */
+export declare function Uppercase<T extends TSchema>(T: T, options?: SchemaOptions): TUppercase<T>;
+export type TLowercase<T extends TSchema> = IntrinsicResolve<T, 'Lowercase'>;
+/** `[Json]` Intrinsic function to Lowercase LiteralString types */
+export declare function Lowercase<T extends TSchema>(T: T, options?: SchemaOptions): TLowercase<T>;
+export type TCapitalize<T extends TSchema> = IntrinsicResolve<T, 'Capitalize'>;
+/** `[Json]` Intrinsic function to Capitalize LiteralString types */
+export declare function Capitalize<T extends TSchema>(T: T, options?: SchemaOptions): TCapitalize<T>;
+export {};

package/esm/type/intrinsic/intrinsic.mjs

@@ -0,0 +1,98 @@
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/type
+
+The MIT License (MIT)
+
+Copyright (c) 2017-2023 Haydn Paterson (sinclair) <haydn.developer@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+---------------------------------------------------------------------------*/
+import { TemplateLiteral, TemplateLiteralParseExact, IsTemplateLiteralFinite, TemplateLiteralGenerate } from '../template-literal/index.mjs';
+import { Literal } from '../literal/index.mjs';
+import { Union } from '../union/index.mjs';
+import { TTemplateLiteral as IsTemplateLiteralType, TUnion as IsUnionType, TLiteral as IsLiteralType } from '../guard/type.mjs';
+import { CloneType } from '../clone/type.mjs';
+// ------------------------------------------------------------------
+// Apply
+// ------------------------------------------------------------------
+function ApplyUncapitalize(value) {
+    const [first, rest] = [value.slice(0, 1), value.slice(1)];
+    return [first.toLowerCase(), rest].join('');
+}
+function ApplyCapitalize(value) {
+    const [first, rest] = [value.slice(0, 1), value.slice(1)];
+    return [first.toUpperCase(), rest].join('');
+}
+function ApplyUppercase(value) {
+    return value.toUpperCase();
+}
+function ApplyLowercase(value) {
+    return value.toLowerCase();
+}
+function FromTemplateLiteral(schema, mode) {
+    // note: template literals require special runtime handling as they are encoded in string patterns.
+    // This diverges from the mapped type which would otherwise map on the template literal kind.
+    const expression = TemplateLiteralParseExact(schema.pattern);
+    const finite = IsTemplateLiteralFinite(expression);
+    if (!finite)
+        return { ...schema, pattern: FromLiteralValue(schema.pattern, mode) };
+    const strings = [...TemplateLiteralGenerate(expression)];
+    const literals = strings.map((value) => Literal(value));
+    const mapped = FromRest(literals, mode);
+    const union = Union(mapped);
+    return TemplateLiteral([union]);
+}
+// prettier-ignore
+function FromLiteralValue(value, mode) {
+    return (typeof value === 'string' ? (mode === 'Uncapitalize' ? ApplyUncapitalize(value) :
+        mode === 'Capitalize' ? ApplyCapitalize(value) :
+            mode === 'Uppercase' ? ApplyUppercase(value) :
+                mode === 'Lowercase' ? ApplyLowercase(value) :
+                    value) : value.toString());
+}
+function FromRest(T, mode) {
+    const [L, ...R] = T;
+    return (T.length > 0 ? [IntrinsicResolve(L, mode), ...FromRest(R, mode)] : []);
+}
+/** Applies an intrinsic string manipulation to the given type. */
+// prettier-ignore
+export function IntrinsicResolve(schema, mode) {
+    return (IsTemplateLiteralType(schema) ? FromTemplateLiteral(schema, mode) :
+        IsUnionType(schema) ? Union(FromRest(schema.anyOf, mode)) :
+            IsLiteralType(schema) ? Literal(FromLiteralValue(schema.const, mode)) :
+                schema);
+}
+/** `[Json]` Intrinsic function to Uncapitalize LiteralString types */
+export function Uncapitalize(T, options = {}) {
+    return CloneType(IntrinsicResolve(T, 'Uncapitalize'), options);
+}
+/** `[Json]` Intrinsic function to Uppercase LiteralString types */
+export function Uppercase(T, options = {}) {
+    return CloneType(IntrinsicResolve(T, 'Uppercase'), options);
+}
+/** `[Json]` Intrinsic function to Lowercase LiteralString types */
+export function Lowercase(T, options = {}) {
+    return CloneType(IntrinsicResolve(T, 'Lowercase'), options);
+}
+/** `[Json]` Intrinsic function to Capitalize LiteralString types */
+export function Capitalize(T, options = {}) {
+    return CloneType(IntrinsicResolve(T, 'Capitalize'), options);
+}

package/esm/type/iterator/index.d.mts

@@ -0,0 +1 @@
+export * from './iterator.mjs';

package/esm/type/iterator/index.mjs

@@ -0,0 +1,28 @@
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/type
+
+The MIT License (MIT)
+
+Copyright (c) 2017-2023 Haydn Paterson (sinclair) <haydn.developer@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+---------------------------------------------------------------------------*/
+export * from './iterator.mjs';

package/esm/type/iterator/iterator.d.mts

@@ -0,0 +1,11 @@
+import type { TSchema, SchemaOptions } from '../schema/index.mjs';
+import type { Static } from '../static/index.mjs';
+import { Kind } from '../symbols/index.mjs';
+export interface TIterator<T extends TSchema = TSchema> extends TSchema {
+    [Kind]: 'Iterator';
+    static: IterableIterator<Static<T, this['params']>>;
+    type: 'Iterator';
+    items: T;
+}
+/** `[JavaScript]` Creates an Iterator type */
+export declare function Iterator<T extends TSchema>(items: T, options?: SchemaOptions): TIterator<T>;

package/esm/type/iterator/iterator.mjs

@@ -0,0 +1,38 @@
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/type
+
+The MIT License (MIT)
+
+Copyright (c) 2017-2023 Haydn Paterson (sinclair) <haydn.developer@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+---------------------------------------------------------------------------*/
+import { Kind } from '../symbols/index.mjs';
+import { CloneType } from '../clone/type.mjs';
+/** `[JavaScript]` Creates an Iterator type */
+export function Iterator(items, options = {}) {
+    return {
+        ...options,
+        [Kind]: 'Iterator',
+        type: 'Iterator',
+        items: CloneType(items),
+    };
+}

package/esm/type/keyof/index.d.mts

@@ -0,0 +1,3 @@
+export * from './keyof-string.mjs';
+export * from './keyof-type.mjs';
+export * from './keyof.mjs';

package/esm/type/keyof/index.mjs

@@ -0,0 +1,30 @@
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/type
+
+The MIT License (MIT)
+
+Copyright (c) 2017-2023 Haydn Paterson (sinclair) <haydn.developer@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+---------------------------------------------------------------------------*/
+export * from './keyof-string.mjs';
+export * from './keyof-type.mjs';
+export * from './keyof.mjs';

package/esm/type/keyof/keyof-string.d.mts

@@ -0,0 +1,30 @@
+import type { TSchema } from '../schema/index.mjs';
+import { type ZeroString, type UnionToTuple, Increment } from '../helpers/index.mjs';
+import type { TRecursive } from '../recursive/index.mjs';
+import type { TIntersect } from '../intersect/index.mjs';
+import type { TUnion } from '../union/index.mjs';
+import type { TTuple } from '../tuple/index.mjs';
+import type { TArray } from '../array/index.mjs';
+import type { TObject, TProperties } from '../object/index.mjs';
+import { OperatorUnionMany, OperatorIntersectMany } from '../operators/index.mjs';
+type FromRest<T extends TSchema[]> = (T extends [infer L extends TSchema, ...infer R extends TSchema[]] ? [KeyOfStringResolve<L>, ...FromRest<R>] : []);
+declare function FromRest<T extends TSchema[]>(T: [...T]): FromRest<T>;
+type FromIntersect<T extends TSchema[], C extends PropertyKey[][] = FromRest<T>> = (OperatorUnionMany<C>);
+declare function FromIntersect<T extends TSchema[]>(T: [...T], C?: FromRest<T>): FromIntersect<T>;
+type FromUnion<T extends TSchema[], C extends PropertyKey[][] = FromRest<T>> = (OperatorIntersectMany<C>);
+declare function FromUnion<T extends TSchema[]>(T: [...T]): FromUnion<T>;
+type FromTuple<T extends TSchema[], I extends string = ZeroString> = T extends [infer _ extends TSchema, ...infer R extends TSchema[]] ? [I, ...FromTuple<R, Increment<I>>] : [];
+declare function FromTuple<T extends TSchema[]>(T: [...T], I?: string): FromTuple<T>;
+type FromArray<_ extends TSchema> = ([
+    '[number]'
+]);
+declare function FromArray<_ extends TSchema>(_: _): FromArray<_>;
+type FromProperties<T extends TProperties> = (UnionToTuple<keyof T>);
+declare function FromProperties<T extends TProperties>(T: T): FromProperties<T>;
+export type KeyOfStringResolve<T extends TSchema> = (T extends TRecursive<infer S> ? KeyOfStringResolve<S> : T extends TIntersect<infer S> ? FromIntersect<S> : T extends TUnion<infer S> ? FromUnion<S> : T extends TTuple<infer S> ? FromTuple<S> : T extends TArray<infer S> ? FromArray<S> : T extends TObject<infer S> ? FromProperties<S> : [
+]);
+/** Resolves finite keys from this type */
+export declare function KeyOfStringResolve<T extends TSchema>(T: T): KeyOfStringResolve<T>;
+/** Resolves keys as a regular expression, including pattern property keys */
+export declare function KeyOfStringResolvePattern(schema: TSchema): string;
+export {};

package/esm/type/keyof/keyof-string.mjs

@@ -0,0 +1,98 @@
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/type
+
+The MIT License (MIT)
+
+Copyright (c) 2017-2023 Haydn Paterson (sinclair) <haydn.developer@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+---------------------------------------------------------------------------*/
+import { Increment } from '../helpers/index.mjs';
+import { OperatorUnionMany, OperatorIntersectMany } from '../operators/index.mjs';
+import { TIntersect as IsIntersectType, TUnion as IsUnionType, TTuple as IsTupleType, TArray as IsArrayType, TObject as IsObjectType, TRecord as IsRecordType } from '../guard/type.mjs';
+// prettier-ignore
+function FromRest(T) {
+    const [L, ...R] = T;
+    return (T.length > 0
+        ? [KeyOfStringResolve(L), ...FromRest(R)]
+        : []);
+}
+// prettier-ignore
+function FromIntersect(T, C = FromRest(T)) {
+    return OperatorUnionMany(C);
+}
+// prettier-ignore
+function FromUnion(T) {
+    const C = FromRest(T);
+    return OperatorIntersectMany(C);
+}
+// prettier-ignore
+function FromTuple(T, I = '0') {
+    const [_, ...R] = T;
+    return (T.length > 0
+        ? [I, ...FromTuple(R, Increment(I))]
+        : []);
+}
+// prettier-ignore
+function FromArray(_) {
+    return (['[number]']);
+}
+// prettier-ignore
+function FromProperties(T) {
+    return (globalThis.Object.getOwnPropertyNames(T));
+}
+// ------------------------------------------------------------------
+// FromPatternProperties
+// ------------------------------------------------------------------
+// prettier-ignore
+function FromPatternProperties(patternProperties) {
+    if (!includePatternProperties)
+        return [];
+    const patternPropertyKeys = globalThis.Object.getOwnPropertyNames(patternProperties);
+    return patternPropertyKeys.map(key => {
+        return (key[0] === '^' && key[key.length - 1] === '$')
+            ? key.slice(1, key.length - 1)
+            : key;
+    });
+}
+/** Resolves finite keys from this type */
+// prettier-ignore
+export function KeyOfStringResolve(T) {
+    return (IsIntersectType(T) ? FromIntersect(T.allOf) :
+        IsUnionType(T) ? FromUnion(T.anyOf) :
+            IsTupleType(T) ? FromTuple(T.items ?? []) :
+                IsArrayType(T) ? FromArray(T.items) :
+                    IsObjectType(T) ? FromProperties(T.properties) :
+                        IsRecordType(T) ? FromPatternProperties(T.patternProperties) :
+                            []);
+}
+// ----------------------------------------------------------------
+// KeyOfStringResolvePattern
+// ----------------------------------------------------------------
+let includePatternProperties = false;
+/** Resolves keys as a regular expression, including pattern property keys */
+export function KeyOfStringResolvePattern(schema) {
+    includePatternProperties = true;
+    const keys = KeyOfStringResolve(schema);
+    includePatternProperties = false;
+    const pattern = keys.map((key) => `(${key})`);
+    return `^(${pattern.join('|')})$`;
+}

package/esm/type/keyof/keyof-type.d.mts

@@ -0,0 +1,11 @@
+import type { TSchema } from '../schema/index.mjs';
+import type { Ensure } from '../helpers/index.mjs';
+import { type TLiteral, TLiteralValue } from '../literal/index.mjs';
+import { type TNumber } from '../number/index.mjs';
+import { KeyOfStringResolve } from './keyof-string.mjs';
+import { UnionResolve } from '../union/index.mjs';
+type FromLiterals<T extends TLiteralValue[]> = (T extends [infer L extends TLiteralValue, ...infer R extends TLiteralValue[]] ? L extends '[number]' ? [TNumber, ...FromLiterals<R>] : [TLiteral<L>, ...FromLiterals<R>] : []);
+declare function FromLiterals<T extends TLiteralValue[]>(T: [...T]): FromLiterals<T>;
+export type KeyOfTypeResolve<T extends TSchema> = (Ensure<UnionResolve<FromLiterals<KeyOfStringResolve<T>>>>);
+export declare function KeyOfTypeResolve<T extends TSchema>(T: T): KeyOfTypeResolve<T>;
+export {};

package/esm/type/keyof/keyof-type.mjs

@@ -0,0 +1,44 @@
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/type
+
+The MIT License (MIT)
+
+Copyright (c) 2017-2023 Haydn Paterson (sinclair) <haydn.developer@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+---------------------------------------------------------------------------*/
+import { Literal } from '../literal/index.mjs';
+import { Number } from '../number/index.mjs';
+import { KeyOfStringResolve } from './keyof-string.mjs';
+import { UnionResolve } from '../union/index.mjs';
+// prettier-ignore
+function FromLiterals(T) {
+    const [L, ...R] = T;
+    return (T.length > 0
+        ? L === '[number]'
+            ? [Number(), ...FromLiterals(R)]
+            : [Literal(L), ...FromLiterals(R)]
+        : []);
+}
+// prettier-ignore
+export function KeyOfTypeResolve(T) {
+    return (UnionResolve(FromLiterals(KeyOfStringResolve(T))));
+}

package/esm/type/keyof/keyof.d.mts

@@ -0,0 +1,5 @@
+import type { TSchema, SchemaOptions } from '../schema/index.mjs';
+import { KeyOfTypeResolve } from './keyof-type.mjs';
+export type TKeyOf<T extends TSchema> = KeyOfTypeResolve<T>;
+/** `[Json]` Creates a KeyOf type */
+export declare function KeyOf<T extends TSchema>(schema: T, options?: SchemaOptions): KeyOfTypeResolve<T>;

package/esm/type/keyof/keyof.mjs

@@ -0,0 +1,34 @@
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/type
+
+The MIT License (MIT)
+
+Copyright (c) 2017-2023 Haydn Paterson (sinclair) <haydn.developer@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+---------------------------------------------------------------------------*/
+import { KeyOfTypeResolve } from './keyof-type.mjs';
+import { CloneType } from '../clone/type.mjs';
+/** `[Json]` Creates a KeyOf type */
+export function KeyOf(schema, options = {}) {
+    const K = KeyOfTypeResolve(schema);
+    return CloneType(K, options);
+}

package/esm/type/literal/index.d.mts

@@ -0,0 +1 @@
+export * from './literal.mjs';

package/esm/type/literal/index.mjs

@@ -0,0 +1,28 @@
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/type
+
+The MIT License (MIT)
+
+Copyright (c) 2017-2023 Haydn Paterson (sinclair) <haydn.developer@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+---------------------------------------------------------------------------*/
+export * from './literal.mjs';