@sinclair/typebox 0.31.28 → 0.32.0-dev-2

package/esm/type/deref/deref.mjs

@@ -0,0 +1,131 @@
+/*--------------------------------------------------------------------------
+
+@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 { CloneType } from '../clone/type.mjs';
+import { Discard } from '../discard/index.mjs';
+import { IsUndefined } from '../guard/value.mjs';
+import { TConstructor as IsConstructorType, TFunction as IsFunctionType, TIntersect as IsIntersectType, TUnion as IsUnionType, TTuple as IsTupleType, TArray as IsArrayType, TObject as IsObjectType, TPromise as IsPromiseType, TAsyncIterator as IsAsyncIteratorType, TIterator as IsIteratorType, TRef as IsRefType, } from '../guard/type.mjs';
+function FromRest(schema, references) {
+    return schema.map((schema) => Deref(schema, references));
+}
+// prettier-ignore
+function FromProperties(properties, references) {
+    return globalThis.Object.getOwnPropertyNames(properties).reduce((acc, key) => {
+        return { ...acc, [key]: Deref(properties[key], references) };
+    }, {});
+}
+// prettier-ignore
+function FromConstructor(schema, references) {
+    const clone = CloneType(schema);
+    clone.parameters = FromRest(clone.parameters, references);
+    clone.returns = Deref(clone.returns, references);
+    return clone;
+}
+// prettier-ignore
+function FromFunction(schema, references) {
+    const clone = CloneType(schema);
+    clone.parameters = FromRest(clone.parameters, references);
+    clone.returns = Deref(clone.returns, references);
+    return clone;
+}
+// prettier-ignore
+function FromIntersect(schema, references) {
+    const clone = CloneType(schema);
+    clone.allOf = FromRest(clone.allOf, references);
+    return clone;
+}
+// prettier-ignore
+function FromUnion(schema, references) {
+    const clone = CloneType(schema);
+    clone.anyOf = FromRest(clone.anyOf, references);
+    return clone;
+}
+// prettier-ignore
+function FromTuple(schema, references) {
+    const clone = CloneType(schema);
+    if (IsUndefined(clone.items))
+        return clone;
+    clone.items = FromRest(clone.items, references);
+    return clone;
+}
+// prettier-ignore
+function FromArray(schema, references) {
+    const clone = CloneType(schema);
+    clone.items = Deref(clone.items, references);
+    return clone;
+}
+// prettier-ignore
+function FromObject(schema, references) {
+    const clone = CloneType(schema);
+    clone.properties = FromProperties(clone.properties, references);
+    return clone;
+}
+// prettier-ignore
+function FromPromise(schema, references) {
+    const clone = CloneType(schema);
+    clone.item = Deref(clone.item, references);
+    return clone;
+}
+// prettier-ignore
+function FromAsyncIterator(schema, references) {
+    const clone = CloneType(schema);
+    clone.items = Deref(clone.items, references);
+    return clone;
+}
+// prettier-ignore
+function FromIterator(schema, references) {
+    const clone = CloneType(schema);
+    clone.items = Deref(clone.items, references);
+    return clone;
+}
+// prettier-ignore
+function FromRef(schema, references) {
+    const target = references.find(remote => remote.$id === schema.$ref);
+    if (target === undefined)
+        throw Error(`Unable to dereference schema with $id ${schema.$ref}`);
+    const discard = Discard(target, ['$id']);
+    return Deref(discard, references);
+}
+// prettier-ignore
+export function DerefResolve(schema, references) {
+    return (IsConstructorType(schema) ? FromConstructor(schema, references) :
+        IsFunctionType(schema) ? FromFunction(schema, references) :
+            IsIntersectType(schema) ? FromIntersect(schema, references) :
+                IsUnionType(schema) ? FromUnion(schema, references) :
+                    IsTupleType(schema) ? FromTuple(schema, references) :
+                        IsArrayType(schema) ? FromArray(schema, references) :
+                            IsObjectType(schema) ? FromObject(schema, references) :
+                                IsPromiseType(schema) ? FromPromise(schema, references) :
+                                    IsAsyncIteratorType(schema) ? FromAsyncIterator(schema, references) :
+                                        IsIteratorType(schema) ? FromIterator(schema, references) :
+                                            IsRefType(schema) ? FromRef(schema, references) :
+                                                schema);
+}
+/** `[Json]` Creates a dereferenced type */
+export function Deref(schema, references) {
+    return DerefResolve(schema, references);
+}

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

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

package/esm/type/deref/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 './deref.mjs';

package/esm/type/discard/discard.d.mts

@@ -0,0 +1 @@
+export declare function Discard(value: Record<PropertyKey, any>, keys: PropertyKey[]): Record<PropertyKey, any>;

package/esm/type/discard/discard.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.
+
+---------------------------------------------------------------------------*/
+function Key(value, key) {
+    const { [key]: _, ...rest } = value;
+    return rest;
+}
+export function Discard(value, keys) {
+    return keys.reduce((acc, key) => Key(acc, key), value);
+}

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

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

package/esm/type/discard/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 './discard.mjs';

package/esm/type/enum/enum.d.mts

@@ -0,0 +1,14 @@
+import type { TSchema, SchemaOptions } from '../schema/index.mjs';
+import { type TLiteral } from '../literal/index.mjs';
+import { Kind, Hint } from '../symbols/index.mjs';
+export type TEnumRecord = Record<TEnumKey, TEnumValue>;
+export type TEnumValue = string | number;
+export type TEnumKey = string;
+export interface TEnum<T extends Record<string, string | number> = Record<string, string | number>> extends TSchema {
+    [Kind]: 'Union';
+    [Hint]: 'Enum';
+    static: T[keyof T];
+    anyOf: TLiteral<T[keyof T]>[];
+}
+/** `[Json]` Creates a Enum type */
+export declare function Enum<V extends TEnumValue, T extends Record<TEnumKey, V>>(item: T, options?: SchemaOptions): TEnum<T>;

package/esm/type/enum/enum.mjs

@@ -0,0 +1,42 @@
+/*--------------------------------------------------------------------------
+
+@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 { Kind, Hint } from '../symbols/index.mjs';
+import { Union } from '../union/index.mjs';
+import { IsUndefined } from '../guard/value.mjs';
+/** `[Json]` Creates a Enum type */
+export function Enum(item, options = {}) {
+    if (IsUndefined(item))
+        throw new Error('Enum undefined or empty');
+    const values1 = globalThis.Object.getOwnPropertyNames(item)
+        .filter((key) => isNaN(key))
+        .map((key) => item[key]);
+    const values2 = [...new Set(values1)];
+    const anyOf = values2.map((value) => Literal(value));
+    return Union(anyOf, { ...options, [Hint]: 'Enum' });
+}

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

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

package/esm/type/enum/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 './enum.mjs';

package/esm/type/exclude/exclude.d.mts

@@ -0,0 +1,21 @@
+import type { TSchema, SchemaOptions } from '../schema/index.mjs';
+import type { UnionToTuple, AssertRest, AssertType, Assert } from '../helpers/index.mjs';
+import { type TTemplateLiteral } from '../template-literal/index.mjs';
+import { type TUnion } from '../union/index.mjs';
+import { type TNever } from '../never/index.mjs';
+import { type TLiteral } from '../literal/index.mjs';
+import { type Static } from '../static/index.mjs';
+import { UnionResolve } from '../union/index.mjs';
+type ExcludeTemplateLiteralResult<T extends string> = UnionResolve<AssertRest<UnionToTuple<{
+    [K in T]: TLiteral<K>;
+}[T]>>>;
+type ExcludeTemplateLiteral<T extends TTemplateLiteral, U extends TSchema> = (Exclude<Static<T>, Static<U>> extends infer S ? ExcludeTemplateLiteralResult<Assert<S, string>> : never);
+type ExcludeArray<T extends TSchema[], U extends TSchema> = AssertRest<UnionToTuple<{
+    [K in keyof T]: Static<AssertType<T[K]>> extends Static<U> ? never : T[K];
+}[number]>> extends infer R extends TSchema[] ? UnionResolve<R> : never;
+type ExcludeResolve<T extends TSchema, U extends TSchema> = T extends TTemplateLiteral ? ExcludeTemplateLiteral<T, U> : T extends TUnion<infer S> ? ExcludeArray<S, U> : T extends U ? TNever : T;
+export declare function ExcludeResolve<L extends TSchema, R extends TSchema>(L: L, R: R): ExcludeResolve<L, R>;
+export type TExclude<T extends TSchema, U extends TSchema> = ExcludeResolve<T, U>;
+/** `[Json]` Constructs a type by excluding from unionType all union members that are assignable to excludedMembers */
+export declare function Exclude<L extends TSchema, R extends TSchema>(unionType: L, excludedMembers: R, options?: SchemaOptions): TExclude<L, R>;
+export {};

package/esm/type/exclude/exclude.mjs

@@ -0,0 +1,49 @@
+/*--------------------------------------------------------------------------
+
+@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 { TemplateLiteralToUnion } from '../template-literal/index.mjs';
+import { Union } from '../union/index.mjs';
+import { Never } from '../never/index.mjs';
+import { ExtendsCheck, ExtendsResult } from '../extends/index.mjs';
+import { CloneType } from '../clone/type.mjs';
+import { TTemplateLiteral as IsTemplateLiteralType, TUnion as IsUnionType } from '../guard/type.mjs';
+// prettier-ignore
+export function ExcludeResolve(L, R) {
+    return (IsTemplateLiteralType(L) ? ExcludeResolve(TemplateLiteralToUnion(L), R) :
+        IsTemplateLiteralType(R) ? ExcludeResolve(L, TemplateLiteralToUnion(R)) :
+            IsUnionType(L) ? (() => {
+                const narrowed = L.anyOf.filter((inner) => ExtendsCheck(inner, R) === ExtendsResult.False);
+                return (narrowed.length === 1 ? narrowed[0] : Union(narrowed));
+            })() :
+                ExtendsCheck(L, R) !== ExtendsResult.False ? Never() :
+                    L);
+}
+/** `[Json]` Constructs a type by excluding from unionType all union members that are assignable to excludedMembers */
+export function Exclude(unionType, excludedMembers, options = {}) {
+    const E = ExcludeResolve(unionType, excludedMembers);
+    return CloneType(E, options);
+}

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

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

package/esm/type/exclude/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 './exclude.mjs';

package/esm/type/extends/extends-check.d.mts

@@ -0,0 +1,9 @@
+import { type TSchema } from '../schema/index.mjs';
+export declare class ExtendsResolverError extends Error {
+}
+export declare enum ExtendsResult {
+    Union = 0,
+    True = 1,
+    False = 2
+}
+export declare function ExtendsCheck(left: TSchema, right: TSchema): ExtendsResult;