@hedystia/validations 1.10.0 → 1.10.2

package/dist/types.d.cts

@@ -0,0 +1,244 @@
+import { StandardSchemaV1 } from "./node_modules/@standard-schema/spec/dist/index.cjs";
+
+//#region src/types.d.ts
+type SchemaPrimitive = "string" | "number" | "boolean" | "any";
+interface SchemaLike {
+  [key: string]: SchemaPrimitive | SchemaLike | BaseSchema<any, any>;
+}
+type Simplify<T> = T extends any ? { [K in keyof T]: T[K] } : never;
+type RequiredKeys<S> = { [K in keyof S]: S[K] extends OptionalSchema<any, any> ? never : K }[keyof S];
+type OptionalKeys<S> = { [K in keyof S]: S[K] extends OptionalSchema<any, any> ? K : never }[keyof S];
+type SchemaPrimitiveMap = {
+  string: string;
+  number: number;
+  boolean: boolean;
+  any: unknown;
+};
+type SchemaType<S> = S extends BaseSchema<any, infer O> ? O : S extends keyof SchemaPrimitiveMap ? SchemaPrimitiveMap[S] : S extends Record<string, any> ? InferSchema<S> : unknown;
+type InferObject<S extends SchemaDefinition> = Simplify<{ [K in RequiredKeys<S>]: SchemaType<S[K]> } & { [K in OptionalKeys<S>]?: SchemaType<S[K]> }>;
+type InferSchema<S> = S extends BaseSchema<any, infer O> ? O : S extends "string" ? string : S extends "number" ? number : S extends "boolean" ? boolean : S extends {
+  [key: string]: any;
+} ? { [K in keyof S as undefined extends InferSchema<S[K]> ? K : never]?: InferSchema<S[K]> } & { [K in keyof S as undefined extends InferSchema<S[K]> ? never : K]: InferSchema<S[K]> } : unknown;
+type SchemaDefinition = SchemaLike;
+interface Schema<I, O> extends StandardSchemaV1<I, O> {
+  optional(): OptionalSchema<I, O | undefined>;
+  enum<V extends O & (string | number | boolean), Values extends readonly [V, ...V[]]>(values: Values): UnionSchema<I, Values[number]>;
+  array(): ArraySchema<I, O[]>;
+  instanceOf<C extends new (...args: any[]) => any>(constructor: C): InstanceOfSchema<I, InstanceType<C>>;
+  jsonSchema: any;
+  readonly inferred: O;
+  schema: Schema<I, O>;
+}
+declare abstract class BaseSchema<I, O> implements Schema<I, O> {
+  abstract readonly "~standard": StandardSchemaV1.Props<I, O>;
+  jsonSchema: any;
+  get inferred(): O;
+  schema: Schema<I, O>;
+  protected _coerce: boolean;
+  coerce(): this;
+  optional(): OptionalSchema<I, O | undefined>;
+  null(): UnionSchema<I, O | null>;
+  enum<V extends O & (string | number | boolean), Values extends readonly [V, ...V[]]>(values: Values): UnionSchema<I, Values[number]>;
+  array(): ArraySchema<I, O[]>;
+  instanceOf<C extends new (...args: any[]) => any>(constructor: C): InstanceOfSchema<I, InstanceType<C>>;
+}
+declare class StringSchemaType extends BaseSchema<unknown, string> {
+  readonly type: SchemaPrimitive;
+  private _validateDate;
+  private _validateUUID;
+  private _validateRegex;
+  private _validateEmail;
+  private _validatePhone;
+  private _validateDomain;
+  private _requireHttpOrHttps;
+  private _minLength?;
+  private _maxLength?;
+  constructor();
+  primitive(): SchemaPrimitive;
+  minLength(n: number): StringSchemaType;
+  maxLength(n: number): StringSchemaType;
+  date(): StringSchemaType;
+  uuid(): StringSchemaType;
+  regex(regex: RegExp): StringSchemaType;
+  email(): StringSchemaType;
+  phone(): StringSchemaType;
+  domain(requireHttpOrHttps?: boolean): StringSchemaType;
+  readonly "~standard": StandardSchemaV1.Props<unknown, string>;
+  private _isValidDate;
+  private _isValidUUID;
+  private _isValidRegex;
+  private _isValidEmail;
+  private _isValidPhone;
+  private _isValidDomain;
+}
+declare class NumberSchemaType extends BaseSchema<unknown, number> {
+  readonly type: SchemaPrimitive;
+  private _min?;
+  private _max?;
+  constructor();
+  primitive(): SchemaPrimitive;
+  min(n: number): NumberSchemaType;
+  max(n: number): NumberSchemaType;
+  readonly "~standard": StandardSchemaV1.Props<unknown, number>;
+}
+declare class BooleanSchemaType extends BaseSchema<unknown, boolean> {
+  readonly type: SchemaPrimitive;
+  constructor();
+  primitive(): SchemaPrimitive;
+  readonly "~standard": StandardSchemaV1.Props<unknown, boolean>;
+}
+declare class AnySchemaType extends BaseSchema<unknown, any> {
+  readonly type: SchemaPrimitive;
+  readonly "~standard": StandardSchemaV1.Props<unknown, any>;
+}
+declare class LiteralSchema<I, T extends string | number | boolean> extends BaseSchema<I, T> {
+  private readonly value;
+  constructor(value: T);
+  readonly "~standard": StandardSchemaV1.Props<I, T>;
+}
+declare class OptionalSchema<I, O> extends BaseSchema<I, O | undefined> {
+  private readonly innerSchema;
+  constructor(schema: Schema<I, O>);
+  readonly "~standard": StandardSchemaV1.Props<I, O | undefined>;
+}
+declare class NullSchemaType extends BaseSchema<unknown, null> {
+  readonly type = "null";
+  constructor();
+  readonly "~standard": StandardSchemaV1.Props<unknown, null>;
+}
+declare class UnionSchema<I, O> extends BaseSchema<I, O> {
+  private readonly schemas;
+  constructor(...schemas: Schema<I, any>[]);
+  readonly "~standard": StandardSchemaV1.Props<I, O>;
+}
+declare class ArraySchema<I, O extends any[]> extends BaseSchema<I, O> {
+  private readonly innerSchema;
+  constructor(schema: Schema<I, O[number]>);
+  readonly "~standard": StandardSchemaV1.Props<I, O>;
+}
+declare class InstanceOfSchema<I, O> extends BaseSchema<I, O> {
+  private readonly innerSchema;
+  private readonly classConstructor;
+  constructor(schema: Schema<I, any>, classConstructor: new (...args: any[]) => any);
+  readonly "~standard": StandardSchemaV1.Props<I, O>;
+}
+declare class ObjectSchemaType<T extends Record<string, unknown>> extends BaseSchema<unknown, T> {
+  readonly definition: SchemaDefinition;
+  constructor(definition: SchemaDefinition);
+  readonly "~standard": StandardSchemaV1.Props<unknown, T>;
+}
+type AnySchema = SchemaPrimitive | BaseSchema<any, any> | SchemaDefinition;
+declare function toStandard<T>(schema: AnySchema): Schema<unknown, T>;
+/**
+ * Create standard schema types
+ * @returns {typeof h} Standard schema types
+ */
+declare const h: {
+  /**
+   * Create string schema type
+   * @returns {StringSchemaType} String schema type
+   */
+  string: () => StringSchemaType;
+  /**
+   * Create number schema type
+   * @returns {NumberSchemaType} Number schema type
+   */
+  number: () => NumberSchemaType;
+  /**
+   * Create boolean schema type
+   * @returns {BooleanSchemaType} Boolean schema type
+   */
+  boolean: () => BooleanSchemaType;
+  /**
+   * Create null schema type
+   * @returns {NullSchemaType} Null schema type
+   */
+  null: () => NullSchemaType;
+  /**
+   * Create any schema type
+   * @returns {AnySchemaType} Any schema type
+   */
+  any: () => AnySchemaType;
+  /**
+   * Create literal schema type
+   * @param {T} value - Literal value
+   * @returns {LiteralSchema<unknown, T>} Literal schema type
+   */
+  literal: <T extends string | number | boolean>(value: T) => LiteralSchema<unknown, T>;
+  /**
+   * Create object schema type
+   * @param {S} [schemaDef] - Schema definition
+   * @returns {ObjectSchemaType<InferObject<S>>} Object schema type
+   */
+  object: <S extends SchemaDefinition>(schemaDef?: S) => ObjectSchemaType<InferObject<S>>;
+  /**
+   * Create array schema type
+   * @param {S} schema - Schema
+   * @returns {ArraySchema<unknown, InferSchema<S>[]>} Array schema type
+   */
+  array: <S extends AnySchema>(schema: S) => ArraySchema<unknown, SchemaType<S>[]>;
+  /**
+   * Create enum schema type from a list of string, number or boolean values.
+   * @param {Values} values - An array of literal values.
+   * @returns {UnionSchema<unknown, Values[number]>} A schema that validates against one of the provided literal values.
+   */
+  enum: <T extends string | number | boolean, Values extends readonly [T, ...T[]]>(values: Values) => UnionSchema<unknown, Values[number]>;
+  /**
+   * Create optional schema type
+   * @param {S} schema - Schema
+   * @returns {OptionalSchema<unknown, InferSchema<S> | undefined>} Optional schema type
+   */
+  optional: <S extends AnySchema>(schema: S) => OptionalSchema<unknown, InferSchema<S> | undefined>;
+  /**
+   * Create options schema type
+   * @param {S} schemas - Schemas
+   * @returns {UnionSchema<unknown, InferSchema<S[number]>>} Options schema type
+   */
+  options: <S extends AnySchema[]>(...schemas: S) => UnionSchema<unknown, InferSchema<S[number]>>;
+  /**
+   * Create instance of schema type
+   * @param {C} constructor - Constructor function
+   * @returns {InstanceOfSchema<unknown, InstanceType<C>>} Instance of schema type
+   */
+  instanceOf: <C extends new (...args: any[]) => any>(constructor: C) => InstanceOfSchema<unknown, InstanceType<C>>;
+  /**
+   * Create date schema type
+   * @returns {StringSchemaType} Date schema type
+   */
+  date: () => StringSchemaType;
+  /**
+   * Create UUID schema type
+   * @returns {StringSchemaType} UUID schema type
+   */
+  uuid: () => StringSchemaType;
+  /**
+   * Create regex schema type
+   * @param {RegExp} regex - Regex
+   * @returns {StringSchemaType} Regex schema type
+   */
+  regex: (regex: RegExp) => StringSchemaType;
+  /**
+   * Create email schema type
+   * @returns {StringSchemaType} Email schema type
+   */
+  email: () => StringSchemaType;
+  /**
+   * Create phone schema type
+   * @returns {StringSchemaType} Phone schema type
+   */
+  phone: () => StringSchemaType;
+  /** Create domain schema type
+   * @param {boolean} requireHttpOrHttps - Require http or https
+   * @returns {StringSchemaType} Domain schema type
+   */
+  domain: (requireHttpOrHttps?: boolean) => StringSchemaType;
+  /**
+   * Convert schema to standard schema
+   * @param {AnySchema} schema - Schema
+   * @returns {Schema<unknown, any>} Standard schema
+   */
+  toStandard: typeof toStandard;
+};
+//#endregion
+export { AnySchema, AnySchemaType, ArraySchema, BaseSchema, BooleanSchemaType, InstanceOfSchema, LiteralSchema, NullSchemaType, NumberSchemaType, ObjectSchemaType, OptionalSchema, StringSchemaType, UnionSchema, h };
+//# sourceMappingURL=types.d.cts.map

package/dist/types.d.mts

@@ -0,0 +1,244 @@
+import { StandardSchemaV1 } from "./node_modules/@standard-schema/spec/dist/index.mjs";
+
+//#region src/types.d.ts
+type SchemaPrimitive = "string" | "number" | "boolean" | "any";
+interface SchemaLike {
+  [key: string]: SchemaPrimitive | SchemaLike | BaseSchema<any, any>;
+}
+type Simplify<T> = T extends any ? { [K in keyof T]: T[K] } : never;
+type RequiredKeys<S> = { [K in keyof S]: S[K] extends OptionalSchema<any, any> ? never : K }[keyof S];
+type OptionalKeys<S> = { [K in keyof S]: S[K] extends OptionalSchema<any, any> ? K : never }[keyof S];
+type SchemaPrimitiveMap = {
+  string: string;
+  number: number;
+  boolean: boolean;
+  any: unknown;
+};
+type SchemaType<S> = S extends BaseSchema<any, infer O> ? O : S extends keyof SchemaPrimitiveMap ? SchemaPrimitiveMap[S] : S extends Record<string, any> ? InferSchema<S> : unknown;
+type InferObject<S extends SchemaDefinition> = Simplify<{ [K in RequiredKeys<S>]: SchemaType<S[K]> } & { [K in OptionalKeys<S>]?: SchemaType<S[K]> }>;
+type InferSchema<S> = S extends BaseSchema<any, infer O> ? O : S extends "string" ? string : S extends "number" ? number : S extends "boolean" ? boolean : S extends {
+  [key: string]: any;
+} ? { [K in keyof S as undefined extends InferSchema<S[K]> ? K : never]?: InferSchema<S[K]> } & { [K in keyof S as undefined extends InferSchema<S[K]> ? never : K]: InferSchema<S[K]> } : unknown;
+type SchemaDefinition = SchemaLike;
+interface Schema<I, O> extends StandardSchemaV1<I, O> {
+  optional(): OptionalSchema<I, O | undefined>;
+  enum<V extends O & (string | number | boolean), Values extends readonly [V, ...V[]]>(values: Values): UnionSchema<I, Values[number]>;
+  array(): ArraySchema<I, O[]>;
+  instanceOf<C extends new (...args: any[]) => any>(constructor: C): InstanceOfSchema<I, InstanceType<C>>;
+  jsonSchema: any;
+  readonly inferred: O;
+  schema: Schema<I, O>;
+}
+declare abstract class BaseSchema<I, O> implements Schema<I, O> {
+  abstract readonly "~standard": StandardSchemaV1.Props<I, O>;
+  jsonSchema: any;
+  get inferred(): O;
+  schema: Schema<I, O>;
+  protected _coerce: boolean;
+  coerce(): this;
+  optional(): OptionalSchema<I, O | undefined>;
+  null(): UnionSchema<I, O | null>;
+  enum<V extends O & (string | number | boolean), Values extends readonly [V, ...V[]]>(values: Values): UnionSchema<I, Values[number]>;
+  array(): ArraySchema<I, O[]>;
+  instanceOf<C extends new (...args: any[]) => any>(constructor: C): InstanceOfSchema<I, InstanceType<C>>;
+}
+declare class StringSchemaType extends BaseSchema<unknown, string> {
+  readonly type: SchemaPrimitive;
+  private _validateDate;
+  private _validateUUID;
+  private _validateRegex;
+  private _validateEmail;
+  private _validatePhone;
+  private _validateDomain;
+  private _requireHttpOrHttps;
+  private _minLength?;
+  private _maxLength?;
+  constructor();
+  primitive(): SchemaPrimitive;
+  minLength(n: number): StringSchemaType;
+  maxLength(n: number): StringSchemaType;
+  date(): StringSchemaType;
+  uuid(): StringSchemaType;
+  regex(regex: RegExp): StringSchemaType;
+  email(): StringSchemaType;
+  phone(): StringSchemaType;
+  domain(requireHttpOrHttps?: boolean): StringSchemaType;
+  readonly "~standard": StandardSchemaV1.Props<unknown, string>;
+  private _isValidDate;
+  private _isValidUUID;
+  private _isValidRegex;
+  private _isValidEmail;
+  private _isValidPhone;
+  private _isValidDomain;
+}
+declare class NumberSchemaType extends BaseSchema<unknown, number> {
+  readonly type: SchemaPrimitive;
+  private _min?;
+  private _max?;
+  constructor();
+  primitive(): SchemaPrimitive;
+  min(n: number): NumberSchemaType;
+  max(n: number): NumberSchemaType;
+  readonly "~standard": StandardSchemaV1.Props<unknown, number>;
+}
+declare class BooleanSchemaType extends BaseSchema<unknown, boolean> {
+  readonly type: SchemaPrimitive;
+  constructor();
+  primitive(): SchemaPrimitive;
+  readonly "~standard": StandardSchemaV1.Props<unknown, boolean>;
+}
+declare class AnySchemaType extends BaseSchema<unknown, any> {
+  readonly type: SchemaPrimitive;
+  readonly "~standard": StandardSchemaV1.Props<unknown, any>;
+}
+declare class LiteralSchema<I, T extends string | number | boolean> extends BaseSchema<I, T> {
+  private readonly value;
+  constructor(value: T);
+  readonly "~standard": StandardSchemaV1.Props<I, T>;
+}
+declare class OptionalSchema<I, O> extends BaseSchema<I, O | undefined> {
+  private readonly innerSchema;
+  constructor(schema: Schema<I, O>);
+  readonly "~standard": StandardSchemaV1.Props<I, O | undefined>;
+}
+declare class NullSchemaType extends BaseSchema<unknown, null> {
+  readonly type = "null";
+  constructor();
+  readonly "~standard": StandardSchemaV1.Props<unknown, null>;
+}
+declare class UnionSchema<I, O> extends BaseSchema<I, O> {
+  private readonly schemas;
+  constructor(...schemas: Schema<I, any>[]);
+  readonly "~standard": StandardSchemaV1.Props<I, O>;
+}
+declare class ArraySchema<I, O extends any[]> extends BaseSchema<I, O> {
+  private readonly innerSchema;
+  constructor(schema: Schema<I, O[number]>);
+  readonly "~standard": StandardSchemaV1.Props<I, O>;
+}
+declare class InstanceOfSchema<I, O> extends BaseSchema<I, O> {
+  private readonly innerSchema;
+  private readonly classConstructor;
+  constructor(schema: Schema<I, any>, classConstructor: new (...args: any[]) => any);
+  readonly "~standard": StandardSchemaV1.Props<I, O>;
+}
+declare class ObjectSchemaType<T extends Record<string, unknown>> extends BaseSchema<unknown, T> {
+  readonly definition: SchemaDefinition;
+  constructor(definition: SchemaDefinition);
+  readonly "~standard": StandardSchemaV1.Props<unknown, T>;
+}
+type AnySchema = SchemaPrimitive | BaseSchema<any, any> | SchemaDefinition;
+declare function toStandard<T>(schema: AnySchema): Schema<unknown, T>;
+/**
+ * Create standard schema types
+ * @returns {typeof h} Standard schema types
+ */
+declare const h: {
+  /**
+   * Create string schema type
+   * @returns {StringSchemaType} String schema type
+   */
+  string: () => StringSchemaType;
+  /**
+   * Create number schema type
+   * @returns {NumberSchemaType} Number schema type
+   */
+  number: () => NumberSchemaType;
+  /**
+   * Create boolean schema type
+   * @returns {BooleanSchemaType} Boolean schema type
+   */
+  boolean: () => BooleanSchemaType;
+  /**
+   * Create null schema type
+   * @returns {NullSchemaType} Null schema type
+   */
+  null: () => NullSchemaType;
+  /**
+   * Create any schema type
+   * @returns {AnySchemaType} Any schema type
+   */
+  any: () => AnySchemaType;
+  /**
+   * Create literal schema type
+   * @param {T} value - Literal value
+   * @returns {LiteralSchema<unknown, T>} Literal schema type
+   */
+  literal: <T extends string | number | boolean>(value: T) => LiteralSchema<unknown, T>;
+  /**
+   * Create object schema type
+   * @param {S} [schemaDef] - Schema definition
+   * @returns {ObjectSchemaType<InferObject<S>>} Object schema type
+   */
+  object: <S extends SchemaDefinition>(schemaDef?: S) => ObjectSchemaType<InferObject<S>>;
+  /**
+   * Create array schema type
+   * @param {S} schema - Schema
+   * @returns {ArraySchema<unknown, InferSchema<S>[]>} Array schema type
+   */
+  array: <S extends AnySchema>(schema: S) => ArraySchema<unknown, SchemaType<S>[]>;
+  /**
+   * Create enum schema type from a list of string, number or boolean values.
+   * @param {Values} values - An array of literal values.
+   * @returns {UnionSchema<unknown, Values[number]>} A schema that validates against one of the provided literal values.
+   */
+  enum: <T extends string | number | boolean, Values extends readonly [T, ...T[]]>(values: Values) => UnionSchema<unknown, Values[number]>;
+  /**
+   * Create optional schema type
+   * @param {S} schema - Schema
+   * @returns {OptionalSchema<unknown, InferSchema<S> | undefined>} Optional schema type
+   */
+  optional: <S extends AnySchema>(schema: S) => OptionalSchema<unknown, InferSchema<S> | undefined>;
+  /**
+   * Create options schema type
+   * @param {S} schemas - Schemas
+   * @returns {UnionSchema<unknown, InferSchema<S[number]>>} Options schema type
+   */
+  options: <S extends AnySchema[]>(...schemas: S) => UnionSchema<unknown, InferSchema<S[number]>>;
+  /**
+   * Create instance of schema type
+   * @param {C} constructor - Constructor function
+   * @returns {InstanceOfSchema<unknown, InstanceType<C>>} Instance of schema type
+   */
+  instanceOf: <C extends new (...args: any[]) => any>(constructor: C) => InstanceOfSchema<unknown, InstanceType<C>>;
+  /**
+   * Create date schema type
+   * @returns {StringSchemaType} Date schema type
+   */
+  date: () => StringSchemaType;
+  /**
+   * Create UUID schema type
+   * @returns {StringSchemaType} UUID schema type
+   */
+  uuid: () => StringSchemaType;
+  /**
+   * Create regex schema type
+   * @param {RegExp} regex - Regex
+   * @returns {StringSchemaType} Regex schema type
+   */
+  regex: (regex: RegExp) => StringSchemaType;
+  /**
+   * Create email schema type
+   * @returns {StringSchemaType} Email schema type
+   */
+  email: () => StringSchemaType;
+  /**
+   * Create phone schema type
+   * @returns {StringSchemaType} Phone schema type
+   */
+  phone: () => StringSchemaType;
+  /** Create domain schema type
+   * @param {boolean} requireHttpOrHttps - Require http or https
+   * @returns {StringSchemaType} Domain schema type
+   */
+  domain: (requireHttpOrHttps?: boolean) => StringSchemaType;
+  /**
+   * Convert schema to standard schema
+   * @param {AnySchema} schema - Schema
+   * @returns {Schema<unknown, any>} Standard schema
+   */
+  toStandard: typeof toStandard;
+};
+//#endregion
+export { AnySchema, AnySchemaType, ArraySchema, BaseSchema, BooleanSchemaType, InstanceOfSchema, LiteralSchema, NullSchemaType, NumberSchemaType, ObjectSchemaType, OptionalSchema, StringSchemaType, UnionSchema, h };
+//# sourceMappingURL=types.d.mts.map