typebox 0.0.1 → 1.0.0

package/build/type/types/never.mjs

@@ -0,0 +1,21 @@
+// deno-fmt-ignore-file
+import { Memory } from '../../system/memory/index.mjs';
+import { IsKind } from './schema.mjs';
+// ------------------------------------------------------------------
+// Pattern
+// ------------------------------------------------------------------
+export const NeverPattern = '(?!)';
+// ------------------------------------------------------------------
+// Factory
+// ------------------------------------------------------------------
+/** Creates a Never type. */
+export function Never(options) {
+    return Memory.Create({ '~kind': 'Never' }, { not: {} }, options);
+}
+// ------------------------------------------------------------------
+// Guard
+// ------------------------------------------------------------------
+/** Returns true if the given value is TNever. */
+export function IsNever(value) {
+    return IsKind(value, 'Never');
+}

package/build/type/types/null.d.mts

@@ -0,0 +1,11 @@
+import { type TSchema, type TSchemaOptions } from './schema.mjs';
+export type StaticNull = null;
+/** Represents a Null type. */
+export interface TNull extends TSchema {
+    '~kind': 'Null';
+    type: 'null';
+}
+/** Creates a Null type. */
+export declare function Null(options?: TSchemaOptions): TNull;
+/** Returns true if the given value is TNull. */
+export declare function IsNull(value: unknown): value is TNull;

package/build/type/types/null.mjs

@@ -0,0 +1,17 @@
+// deno-fmt-ignore-file
+import { Memory } from '../../system/memory/index.mjs';
+import { IsKind } from './schema.mjs';
+// ------------------------------------------------------------------
+// Factory
+// ------------------------------------------------------------------
+/** Creates a Null type. */
+export function Null(options) {
+    return Memory.Create({ '~kind': 'Null' }, { type: 'null' }, options);
+}
+// ------------------------------------------------------------------
+// Guard
+// ------------------------------------------------------------------
+/** Returns true if the given value is TNull. */
+export function IsNull(value) {
+    return IsKind(value, 'Null');
+}

package/build/type/types/number.d.mts

@@ -0,0 +1,12 @@
+import { type TSchema, type TNumberOptions } from './schema.mjs';
+export declare const NumberPattern = "-?(?:0|[1-9][0-9]*)(?:.[0-9]+)?";
+export type StaticNumber = number;
+/** Represents a Number type. */
+export interface TNumber extends TSchema {
+    '~kind': 'Number';
+    type: 'number';
+}
+/** Creates a Number type. */
+export declare function Number(options?: TNumberOptions): TNumber;
+/** Returns true if the given value is a TNumber. */
+export declare function IsNumber(value: unknown): value is TNumber;

package/build/type/types/number.mjs

@@ -0,0 +1,21 @@
+// deno-fmt-ignore-file
+import { Memory } from '../../system/memory/index.mjs';
+import { IsKind } from './schema.mjs';
+// ------------------------------------------------------------------
+// Pattern
+// ------------------------------------------------------------------
+export const NumberPattern = '-?(?:0|[1-9][0-9]*)(?:\.[0-9]+)?';
+// ------------------------------------------------------------------
+// Factory
+// ------------------------------------------------------------------
+/** Creates a Number type. */
+export function Number(options) {
+    return Memory.Create({ '~kind': 'Number' }, { type: 'number' }, options);
+}
+// ------------------------------------------------------------------
+// Guard
+// ------------------------------------------------------------------
+/** Returns true if the given value is a TNumber. */
+export function IsNumber(value) {
+    return IsKind(value, 'Number');
+}

package/build/type/types/object.d.mts

@@ -0,0 +1,17 @@
+import { type StaticDirection } from './static.mjs';
+import { type TSchema, type TObjectOptions } from './schema.mjs';
+import { type TProperties, type TRequiredArray, type StaticProperties } from './properties.mjs';
+export type StaticObject<Direction extends StaticDirection, Context extends TProperties, _This extends TProperties, Properties extends TProperties, Result = keyof Properties extends never ? object : StaticProperties<Direction, Context, Properties, Properties>> = Result;
+/** Represents an Object type. */
+export interface TObject<Properties extends TProperties = TProperties> extends TSchema {
+    '~kind': 'Object';
+    type: 'object';
+    properties: Properties;
+    required: TRequiredArray<Properties>;
+}
+/** Creates an Object type. */
+export declare function Object<Properties extends TProperties>(properties: Properties, options?: TObjectOptions): TObject<Properties>;
+/** Returns true if the given value is TObject. */
+export declare function IsObject(value: unknown): value is TObject;
+/** Extracts options from a TObject. */
+export declare function ObjectOptions(type: TObject): TObjectOptions;

package/build/type/types/object.mjs

@@ -0,0 +1,27 @@
+// deno-fmt-ignore-file
+import { Memory } from '../../system/memory/index.mjs';
+import { IsKind } from './schema.mjs';
+import { RequiredArray } from './properties.mjs';
+// ------------------------------------------------------------------
+// Factory
+// ------------------------------------------------------------------
+/** Creates an Object type. */
+export function Object(properties, options = {}) {
+    const requiredKeys = RequiredArray(properties);
+    const required = requiredKeys.length > 0 ? { required: requiredKeys } : {};
+    return Memory.Create({ '~kind': 'Object' }, { type: 'object', ...required, properties }, options);
+}
+// ------------------------------------------------------------------
+// Guard
+// ------------------------------------------------------------------
+/** Returns true if the given value is TObject. */
+export function IsObject(value) {
+    return IsKind(value, 'Object');
+}
+// ------------------------------------------------------------------
+// Options
+// ------------------------------------------------------------------
+/** Extracts options from a TObject. */
+export function ObjectOptions(type) {
+    return Memory.Discard(type, ['~kind', 'type', 'properties', 'required']);
+}

package/build/type/types/parameter.d.mts

@@ -0,0 +1,17 @@
+import { type TSchema } from './schema.mjs';
+import { type TUnknown } from './unknown.mjs';
+/** Represents a Generic parameter. */
+export interface TParameter<Name extends string = string, Extends extends TSchema = TSchema, Equals extends TSchema = TSchema> extends TSchema {
+    '~kind': 'Parameter';
+    name: Name;
+    extends: Extends;
+    equals: Equals;
+}
+/** Creates a Parameter type. */
+export declare function Parameter<Name extends string, Extends extends TSchema, Equals extends TSchema>(name: Name, extends_: Extends, equals: Equals): TParameter<Name, Extends, Equals>;
+/** Creates a Parameter type. */
+export declare function Parameter<Name extends string, Extends extends TSchema, Equals extends TSchema>(name: Name, extends_: Extends): TParameter<Name, Extends, Extends>;
+/** Creates a Parameter type. */
+export declare function Parameter<Name extends string>(name: Name): TParameter<Name, TUnknown, TUnknown>;
+/** Returns true if the given value is TParameter. */
+export declare function IsParameter(value: unknown): value is TParameter;

package/build/type/types/parameter.mjs

@@ -0,0 +1,21 @@
+// deno-fmt-ignore-file
+import { Arguments } from '../../system/arguments/index.mjs';
+import { Memory } from '../../system/memory/index.mjs';
+import { IsKind } from './schema.mjs';
+import { Unknown } from './unknown.mjs';
+/** Creates a Parameter type. */
+export function Parameter(...args) {
+    const [name, extends_, equals] = Arguments.Match(args, {
+        3: (name, extends_, equals) => [name, extends_, equals],
+        2: (name, extends_) => [name, extends_, extends_],
+        1: (name) => [name, Unknown(), Unknown()],
+    });
+    return Memory.Create({ '~kind': 'Parameter' }, { name, extends: extends_, equals }, {});
+}
+// ------------------------------------------------------------------
+// Guard
+// ------------------------------------------------------------------
+/** Returns true if the given value is TParameter. */
+export function IsParameter(value) {
+    return IsKind(value, 'Parameter');
+}

package/build/type/types/promise.d.mts

@@ -0,0 +1,16 @@
+import { type StaticType, type StaticDirection } from './static.mjs';
+import { type TSchema, type TSchemaOptions } from './schema.mjs';
+import { type TProperties } from './properties.mjs';
+export type StaticPromise<Direction extends StaticDirection, Context extends TProperties, This extends TProperties, Type extends TSchema, Result = Promise<StaticType<Direction, Context, This, Type>>> = Result;
+/** Represents a Promise type. */
+export interface TPromise<Type extends TSchema = TSchema> extends TSchema {
+    '~kind': 'Promise';
+    type: 'promise';
+    item: Type;
+}
+/** Creates a Promise type. */
+export declare function Promise<Type extends TSchema>(item: Type, options?: TSchemaOptions): TPromise<Type>;
+/** Returns true if the given type is TPromise. */
+export declare function IsPromise(value: unknown): value is TPromise;
+/** Extracts options from a TPromise. */
+export declare function PromiseOptions(type: TPromise): TSchemaOptions;

package/build/type/types/promise.mjs

@@ -0,0 +1,24 @@
+// deno-fmt-ignore-file
+import { Memory } from '../../system/memory/index.mjs';
+import { IsKind } from './schema.mjs';
+// ------------------------------------------------------------------
+// Factory
+// ------------------------------------------------------------------
+/** Creates a Promise type. */
+export function Promise(item, options) {
+    return Memory.Create({ ['~kind']: 'Promise' }, { type: 'promise', item }, options);
+}
+// ------------------------------------------------------------------
+// Guard
+// ------------------------------------------------------------------
+/** Returns true if the given type is TPromise. */
+export function IsPromise(value) {
+    return IsKind(value, 'Promise');
+}
+// ------------------------------------------------------------------
+// Options
+// ------------------------------------------------------------------
+/** Extracts options from a TPromise. */
+export function PromiseOptions(type) {
+    return Memory.Discard(type, ['~kind', 'type', 'item']);
+}

package/build/type/types/properties.d.mts

@@ -0,0 +1,42 @@
+import { type StaticType, type StaticDirection, type StaticEvaluate } from './static.mjs';
+import { type TSchema } from './schema.mjs';
+import { type TOptional } from './_optional.mjs';
+import { type TReadonly } from './_readonly.mjs';
+import { type TUnionToTuple } from '../engine/helpers/union.mjs';
+type ReadonlyOptionalKeys<Properties extends TProperties, Result extends PropertyKey = {
+    [Key in keyof Properties]: Properties[Key] extends TReadonly<TSchema> ? (Properties[Key] extends TOptional<Properties[Key]> ? Key : never) : never;
+}[keyof Properties]> = Result;
+type ReadonlyKeys<Properties extends TProperties, Result extends PropertyKey = {
+    [Key in keyof Properties]: Properties[Key] extends TReadonly<TSchema> ? (Properties[Key] extends TOptional<Properties[Key]> ? never : Key) : never;
+}[keyof Properties]> = Result;
+type OptionalKeys<Properties extends TProperties, Result extends PropertyKey = {
+    [Key in keyof Properties]: Properties[Key] extends TOptional<TSchema> ? (Properties[Key] extends TReadonly<Properties[Key]> ? never : Key) : never;
+}[keyof Properties]> = Result;
+type RequiredKeys<Properties extends TProperties, Result extends PropertyKey = keyof Omit<Properties, ReadonlyOptionalKeys<Properties> | ReadonlyKeys<Properties> | OptionalKeys<Properties>>> = Result;
+type StaticPropertiesWithModifiers<Properties extends TProperties, PropertiesWithoutModifiers extends Record<PropertyKey, unknown>> = StaticEvaluate<Readonly<Partial<Pick<PropertiesWithoutModifiers, ReadonlyOptionalKeys<Properties>>>> & Readonly<Pick<PropertiesWithoutModifiers, ReadonlyKeys<Properties>>> & Partial<Pick<PropertiesWithoutModifiers, OptionalKeys<Properties>>> & Required<Pick<PropertiesWithoutModifiers, RequiredKeys<Properties>>>>;
+type StaticPropertiesWithoutModifiers<Direction extends StaticDirection, Context extends TProperties, This extends TProperties, Properties extends TProperties, Result extends Record<PropertyKey, unknown> = {
+    [Key in keyof Properties]: StaticType<Direction, Context, This, Properties[Key]>;
+}> = Result;
+export type StaticProperties<Direction extends StaticDirection, Context extends TProperties, This extends TProperties, Properties extends TProperties, PropertiesWithoutModifiers extends Record<PropertyKey, unknown> = StaticPropertiesWithoutModifiers<Direction, Context, This, Properties>, PropertiesWithModifiers extends Record<PropertyKey, unknown> = StaticPropertiesWithModifiers<Properties, PropertiesWithoutModifiers>, Result extends Record<PropertyKey, unknown> = {
+    [Key in keyof PropertiesWithModifiers]: PropertiesWithModifiers[Key];
+}> = Result;
+/** Represents a Record<PropertyKey, TSchema> structure. */
+export interface TProperties extends TSchema {
+    [key: PropertyKey]: TSchema;
+}
+/** Creates a RequiredArray derived from the given TProperties value. */
+export type TRequiredArray<Properties extends TProperties, RequiredProperties extends TProperties = {
+    [Key in keyof Properties as Properties[Key] extends TOptional<Properties[Key]> ? never : Key]: Properties[Key];
+}, RequiredKeys extends string[] = TUnionToTuple<Extract<keyof RequiredProperties, string>>, Result extends string[] | undefined = RequiredKeys extends [] ? undefined : RequiredKeys> = Result;
+/** Creates a RequiredArray derived from the given TProperties value. */
+export declare function RequiredArray<Properties extends TProperties>(properties: Properties): TRequiredArray<Properties>;
+/** Extracts a tuple of keys from a TProperties value. */
+export type TPropertyKeys<Properties extends TProperties, Result extends string[] = TUnionToTuple<Extract<keyof Properties, string>>> = Result;
+/** Extracts a tuple of keys from a TProperties value. */
+export declare function PropertyKeys<Properties extends TProperties>(properties: Properties): TPropertyKeys<Properties>;
+type TPropertyValuesReduce<Properties extends TProperties, Keys extends string[], Result extends TSchema[] = []> = Keys extends [infer Left extends string, ...infer Right extends string[]] ? Left extends keyof Properties ? TPropertyValuesReduce<Properties, Right, [...Result, Properties[Left]]> : TPropertyValuesReduce<Properties, Right, Result> : Result;
+/** Extracts a tuple of property values from a TProperties value. */
+export type TPropertyValues<Properties extends TProperties, Keys extends string[] = TPropertyKeys<Properties>, Result extends TSchema[] = TPropertyValuesReduce<Properties, Keys>> = Result;
+/** Extracts a tuple of property values from a TProperties value. */
+export declare function PropertyValues<Properties extends TProperties>(properties: Properties): TPropertyValues<Properties>;
+export {};

package/build/type/types/properties.mjs

@@ -0,0 +1,16 @@
+// deno-lint-ignore-file no-array-constructor
+// deno-fmt-ignore-file
+import { Guard } from '../../guard/index.mjs';
+import { IsOptional } from './_optional.mjs';
+/** Creates a RequiredArray derived from the given TProperties value. */
+export function RequiredArray(properties) {
+    return Guard.Keys(properties).filter((key) => !IsOptional(properties[key]));
+}
+/** Extracts a tuple of keys from a TProperties value. */
+export function PropertyKeys(properties) {
+    return Guard.Keys(properties);
+}
+/** Extracts a tuple of property values from a TProperties value. */
+export function PropertyValues(properties) {
+    return Guard.Values(properties);
+}

package/build/type/types/record.d.mts

@@ -0,0 +1,44 @@
+import { type TSchema, type TObjectOptions } from './schema.mjs';
+import { type StaticType, type StaticDirection } from './static.mjs';
+import { type TProperties } from './properties.mjs';
+import { type TInteger } from './integer.mjs';
+import { type TNumber } from './number.mjs';
+import { type TString } from './string.mjs';
+import { type TDeferred } from './deferred.mjs';
+import { type TInstantiate } from '../engine/instantiate.mjs';
+export type StaticRecord<Direction extends StaticDirection, Context extends TProperties, This extends TProperties, Key extends string, Value extends TSchema, StaticValue extends unknown = StaticType<Direction, Context, This, Value>, Result extends Record<PropertyKey, unknown> = (Key extends TStringKey ? Record<string, StaticValue> : Key extends TIntegerKey ? Record<number, StaticValue> : Key extends TNumberKey ? Record<number, StaticValue> : Record<PropertyKey, StaticValue>)> = Result;
+export type TStringKey = typeof StringKey;
+export type TIntegerKey = typeof IntegerKey;
+export type TNumberKey = typeof NumberKey;
+export declare const IntegerKey = "^-?(?:0|[1-9][0-9]*)$";
+export declare const NumberKey = "^-?(?:0|[1-9][0-9]*)(?:.[0-9]+)?$";
+export declare const StringKey = "^.*$";
+export interface TRecord<Key extends string = string, Value extends TSchema = TSchema> extends TSchema {
+    '~kind': 'Record';
+    type: 'object';
+    patternProperties: {
+        [_ in Key]: Value;
+    };
+}
+/** Represents a deferred Record action. */
+export type TRecordDeferred<Key extends TSchema, Value extends TSchema> = (TDeferred<'Record', [Key, Value]>);
+/** Represents a deferred Record action. */
+export declare function RecordDeferred<Key extends TSchema, Value extends TSchema>(key: Key, value: Value, options?: TObjectOptions): TRecordDeferred<Key, Value>;
+export type TRecordConstruct<Key extends TSchema, Value extends TSchema> = (TInstantiate<{}, TRecordDeferred<Key, Value>>);
+export declare function RecordConstruct<Key extends TSchema, Value extends TSchema>(key: Key, value: Value, options?: TObjectOptions): TRecordConstruct<Key, Value>;
+/** Creates a Record type. */
+export declare function Record<Key extends TSchema, Value extends TSchema>(key: Key, value: Value, options?: TObjectOptions): TRecordConstruct<Key, Value>;
+/** Creates a Record type from regular expression pattern. */
+export declare function RecordFromPattern<Pattern extends string, Value extends TSchema>(key: Pattern, value: Value): TRecord<Pattern, Value>;
+/** Returns the raw string pattern used for the Record key  */
+export type TRecordPattern<Type extends TRecord, Result extends string = Extract<keyof Type['patternProperties'], string>> = Result;
+/** Returns the raw string pattern used for the Record key  */
+export declare function RecordPattern<Type extends TRecord>(type: Type): TRecordPattern<Type>;
+/** Returns the Record key as a TypeBox type  */
+export type TRecordKey<Type extends TRecord, Pattern extends string = TRecordPattern<Type>, Result extends TSchema = (Pattern extends typeof IntegerKey ? TInteger : Pattern extends typeof NumberKey ? TNumber : TString)> = Result;
+/** Returns the Record key as a TypeBox type  */
+export declare function RecordKey<Type extends TRecord>(type: Type): TRecordKey<Type>;
+export type TRecordValue<Type extends TRecord, Result extends TSchema = Type['patternProperties'][TRecordPattern<Type>]> = Result;
+export declare function RecordValue<Type extends TRecord>(type: Type): TRecordValue<Type>;
+export declare function IsRecord(value: unknown): value is TRecord;
+export declare function RecordOptions(type: TRecord): TObjectOptions;

package/build/type/types/record.mjs

@@ -0,0 +1,61 @@
+// deno-fmt-ignore-file
+import { Memory } from '../../system/memory/index.mjs';
+import { Guard } from '../../guard/index.mjs';
+import { IsKind } from './schema.mjs';
+import { Integer, IntegerPattern } from './integer.mjs';
+import { Number, NumberPattern } from './number.mjs';
+import { String, StringPattern } from './string.mjs';
+import { Deferred } from './deferred.mjs';
+import { Instantiate } from '../engine/instantiate.mjs';
+import { CreateRecord } from '../engine/record/record-create.mjs';
+export const IntegerKey = `^${IntegerPattern}$`;
+export const NumberKey = `^${NumberPattern}$`;
+export const StringKey = `^${StringPattern}$`;
+/** Represents a deferred Record action. */
+export function RecordDeferred(key, value, options = {}) {
+    return Deferred('Record', [key, value], options);
+}
+export function RecordConstruct(key, value, options = {}) {
+    return Instantiate({}, RecordDeferred(key, value, options));
+}
+// -------------------------------------------------------------------
+// Factory
+// -------------------------------------------------------------------
+/** Creates a Record type. */
+export function Record(key, value, options = {}) {
+    return RecordConstruct(key, value, options);
+}
+// -------------------------------------------------------------------
+// FromPattern
+// -------------------------------------------------------------------
+/** Creates a Record type from regular expression pattern. */
+export function RecordFromPattern(key, value) {
+    return CreateRecord(key, value);
+}
+/** Returns the raw string pattern used for the Record key  */
+export function RecordPattern(type) {
+    return Guard.Keys(type.patternProperties)[0];
+}
+/** Returns the Record key as a TypeBox type  */
+export function RecordKey(type) {
+    const pattern = RecordPattern(type);
+    const result = (Guard.IsEqual(pattern, IntegerKey) ? Integer() :
+        Guard.IsEqual(pattern, NumberKey) ? Number() :
+            String());
+    return result;
+}
+export function RecordValue(type) {
+    return type.patternProperties[RecordPattern(type)];
+}
+// -------------------------------------------------------------------
+// Guard
+// -------------------------------------------------------------------
+export function IsRecord(value) {
+    return IsKind(value, 'Record');
+}
+// -------------------------------------------------------------------
+// Options
+// -------------------------------------------------------------------
+export function RecordOptions(type) {
+    return Memory.Discard(type, ['~kind', 'type', 'patternProperties']);
+}

package/build/type/types/ref.d.mts

@@ -0,0 +1,13 @@
+import { type StaticType, type StaticDirection } from './static.mjs';
+import { type TSchema, type TSchemaOptions } from './schema.mjs';
+import { type TProperties } from './properties.mjs';
+export type StaticRef<Direction extends StaticDirection, Context extends TProperties, This extends TProperties, Ref extends string, Result extends unknown = Ref extends keyof Context ? StaticType<Direction, Context, This, Context[Ref]> : unknown> = Result;
+/** Represents a type reference. */
+export interface TRef<Ref extends string = string> extends TSchema {
+    '~kind': 'Ref';
+    $ref: Ref;
+}
+/** Creates a Ref type. */
+export declare function Ref<Ref extends string>(ref: Ref, options?: TSchemaOptions): TRef<Ref>;
+/** Returns true if the given value is TRef. */
+export declare function IsRef(value: unknown): value is TRef;

package/build/type/types/ref.mjs

@@ -0,0 +1,17 @@
+// deno-fmt-ignore-file
+import { Memory } from '../../system/memory/index.mjs';
+import { IsKind } from './schema.mjs';
+// ------------------------------------------------------------------
+// Factory
+// ------------------------------------------------------------------
+/** Creates a Ref type. */
+export function Ref(ref, options) {
+    return Memory.Create({ ['~kind']: 'Ref' }, { $ref: ref }, options);
+}
+// ------------------------------------------------------------------
+// Guard
+// ------------------------------------------------------------------
+/** Returns true if the given value is TRef. */
+export function IsRef(value) {
+    return IsKind(value, 'Ref');
+}

package/build/type/types/rest.d.mts

@@ -0,0 +1,11 @@
+import { type TSchema } from '../types/schema.mjs';
+/** Represents a Rest instruction. */
+export interface TRest<Type extends TSchema = TSchema> extends TSchema {
+    '~kind': 'Rest';
+    type: 'rest';
+    items: Type;
+}
+/** Creates a Rest instruction type. */
+export declare function Rest<Type extends TSchema>(type: Type): TRest<Type>;
+/** Returns true if the given value is TRest. */
+export declare function IsRest(value: unknown): value is TRest;

package/build/type/types/rest.mjs

@@ -0,0 +1,17 @@
+// deno-fmt-ignore-file
+import { Memory } from '../../system/memory/index.mjs';
+import { IsKind } from '../types/schema.mjs';
+// ------------------------------------------------------------------
+// Type
+// ------------------------------------------------------------------
+/** Creates a Rest instruction type. */
+export function Rest(type) {
+    return Memory.Create({ '~kind': 'Rest' }, { type: 'rest', items: type }, {});
+}
+// ------------------------------------------------------------------
+// Guard
+// ------------------------------------------------------------------
+/** Returns true if the given value is TRest. */
+export function IsRest(value) {
+    return IsKind(value, 'Rest');
+}