@zeruxjs/validator 0.0.0-stage → 0.0.1

package/dist/methods/fallbackAsync.d.ts

@@ -0,0 +1,44 @@
+import type { BaseIssue, BaseSchema, BaseSchemaAsync, Config, InferInput, InferIssue, InferOutput, MaybeDeepReadonly, MaybePromise, OutputDataset, StandardProps, UnknownDataset } from '../types/index.js';
+/**
+ * Fallback async type.
+ */
+export type FallbackAsync<TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>> = MaybeDeepReadonly<InferOutput<TSchema>> | ((dataset?: OutputDataset<InferOutput<TSchema>, InferIssue<TSchema>>, config?: Config<InferIssue<TSchema>>) => MaybePromise<MaybeDeepReadonly<InferOutput<TSchema>>>);
+/**
+ * Schema with fallback async type.
+ */
+export type SchemaWithFallbackAsync<TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>, TFallback extends FallbackAsync<TSchema>> = Omit<TSchema, 'async' | '~standard' | '~run'> & {
+    /**
+     * The fallback value.
+     */
+    readonly fallback: TFallback;
+    /**
+     * Whether it's async.
+     */
+    readonly async: true;
+    /**
+     * The Standard Schema properties.
+     *
+     * @internal
+     */
+    readonly '~standard': StandardProps<InferInput<TSchema>, InferOutput<TSchema>>;
+    /**
+     * Parses unknown input values.
+     *
+     * @param dataset The input dataset.
+     * @param config The configuration.
+     *
+     * @returns The output dataset.
+     *
+     * @internal
+     */
+    readonly '~run': (dataset: UnknownDataset, config: Config<BaseIssue<unknown>>) => Promise<OutputDataset<InferOutput<TSchema>, InferIssue<TSchema>>>;
+};
+/**
+ * Returns a fallback value as output if the input does not match the schema.
+ *
+ * @param schema The schema to catch.
+ * @param fallback The fallback value.
+ *
+ * @returns The passed schema.
+ */
+export declare function fallbackAsync<const TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>, const TFallback extends FallbackAsync<TSchema>>(schema: TSchema, fallback: TFallback): SchemaWithFallbackAsync<TSchema, TFallback>;

package/dist/methods/fallbackAsync.js

@@ -0,0 +1,31 @@
+import { _getStandardProps } from '../utils/index.js';
+import { getFallback } from './getFallback.js';
+/**
+ * Returns a fallback value as output if the input does not match the schema.
+ *
+ * @param schema The schema to catch.
+ * @param fallback The fallback value.
+ *
+ * @returns The passed schema.
+ */
+// @__NO_SIDE_EFFECTS__
+export function fallbackAsync(schema, fallback) {
+    return {
+        ...schema,
+        fallback,
+        async: true,
+        get '~standard'() {
+            return _getStandardProps(this);
+        },
+        async '~run'(dataset, config) {
+            const outputDataset = await schema['~run'](dataset, config);
+            return outputDataset.issues
+                ? {
+                    typed: true,
+                    value: await getFallback(this, outputDataset, config),
+                }
+                : outputDataset;
+        },
+    };
+}
+//# sourceMappingURL=fallbackAsync.js.map

package/dist/methods/fallbackAsync.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fallbackAsync.js","sourceRoot":"","sources":["../../src/methods/fallbackAsync.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AA0D/C;;;;;;;GAOG;AACH,uBAAuB;AACvB,MAAM,UAAU,aAAa,CAM3B,MAAe,EACf,QAAmB;IAEnB,OAAO;QACL,GAAG,MAAM;QACT,QAAQ;QACR,KAAK,EAAE,IAAI;QACX,IAAI,WAAW;YACb,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAC;QACjC,CAAC;QACD,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM;YAC1B,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YAC5D,OAAO,aAAa,CAAC,MAAM;gBACzB,CAAC,CAAC;oBACA,KAAK,EAAE,IAAI;oBACX,KAAK,EAAE,MAAM,WAAW,CAAC,IAAI,EAAE,aAAa,EAAE,MAAM,CAAC;iBACtD;gBACD,CAAC,CAAC,aAAa,CAAC;QACpB,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/methods/flatten.d.ts

@@ -0,0 +1,48 @@
+import type { BaseIssue, BaseSchema, BaseSchemaAsync, InferIssue, IssueDotPath, Prettify } from '../types/index.js';
+/**
+ * Flat errors type.
+ */
+export type FlatErrors<TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>> | undefined> = Prettify<{
+    /**
+     * The root errors.
+     *
+     * Hint: The error messages of issues without a path that belong to the root
+     * of the schema are added to this key.
+     */
+    readonly root?: [string, ...string[]];
+    /**
+     * The nested errors.
+     *
+     * Hint: The error messages of issues with a path that belong to the nested
+     * parts of the schema and can be converted to a dot path are added to this
+     * key.
+     */
+    readonly nested?: Prettify<Readonly<Partial<Record<TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>> ? IssueDotPath<TSchema> : string, [
+        string,
+        ...string[]
+    ]>>>>;
+    /**
+     * The other errors.
+     *
+     * Hint: Some issue paths, for example for complex data types like `Set` and
+     * `Map`, have no key or a key that cannot be converted to a dot path. These
+     * error messages are added to this key.
+     */
+    readonly other?: [string, ...string[]];
+}>;
+/**
+ * Flatten the error messages of issues.
+ *
+ * @param issues The list of issues.
+ *
+ * @returns A flat error object.
+ */
+export declare function flatten(issues: [BaseIssue<unknown>, ...BaseIssue<unknown>[]]): FlatErrors<undefined>;
+/**
+ * Flatten the error messages of issues.
+ *
+ * @param issues The list of issues.
+ *
+ * @returns A flat error object.
+ */
+export declare function flatten<TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>>(issues: [InferIssue<TSchema>, ...InferIssue<TSchema>[]]): FlatErrors<TSchema>;

package/dist/methods/flatten.js

@@ -0,0 +1,51 @@
+import { getDotPath } from '../utils/index.js';
+// @__NO_SIDE_EFFECTS__
+export function flatten(issues) {
+    // Create flat errors object
+    const flatErrors = {};
+    // Add message of each issue to flat errors object
+    for (const issue of issues) {
+        // If issue has path, add message to nested or other errors
+        if (issue.path) {
+            // Get dot path from issue
+            const dotPath = getDotPath(issue);
+            // If path has valid keys, add message to nested errors
+            if (dotPath) {
+                if (!flatErrors.nested) {
+                    // @ts-expect-error
+                    flatErrors.nested = {};
+                }
+                if (flatErrors.nested[dotPath]) {
+                    flatErrors.nested[dotPath].push(issue.message);
+                }
+                else {
+                    // @ts-expect-error
+                    flatErrors.nested[dotPath] = [issue.message];
+                }
+                // Otherwise, add message to other errors
+            }
+            else {
+                if (flatErrors.other) {
+                    flatErrors.other.push(issue.message);
+                }
+                else {
+                    // @ts-expect-error
+                    flatErrors.other = [issue.message];
+                }
+            }
+            // Otherwise, add message to root errors
+        }
+        else {
+            if (flatErrors.root) {
+                flatErrors.root.push(issue.message);
+            }
+            else {
+                // @ts-expect-error
+                flatErrors.root = [issue.message];
+            }
+        }
+    }
+    // Return flat errors object
+    return flatErrors;
+}
+//# sourceMappingURL=flatten.js.map

package/dist/methods/flatten.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"flatten.js","sourceRoot":"","sources":["../../src/methods/flatten.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAyE/C,uBAAuB;AACvB,MAAM,UAAU,OAAO,CACrB,MAAqD;IAErD,4BAA4B;IAC5B,MAAM,UAAU,GAA0B,EAAE,CAAC;IAE7C,kDAAkD;IAClD,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,2DAA2D;QAC3D,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;YACf,0BAA0B;YAC1B,MAAM,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;YAElC,uDAAuD;YACvD,IAAI,OAAO,EAAE,CAAC;gBACZ,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;oBACvB,mBAAmB;oBACnB,UAAU,CAAC,MAAM,GAAG,EAAE,CAAC;gBACzB,CAAC;gBACD,IAAI,UAAU,CAAC,MAAO,CAAC,OAAO,CAAC,EAAE,CAAC;oBAChC,UAAU,CAAC,MAAO,CAAC,OAAO,CAAE,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBACnD,CAAC;qBAAM,CAAC;oBACN,mBAAmB;oBACnB,UAAU,CAAC,MAAO,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBAChD,CAAC;gBAED,yCAAyC;YAC3C,CAAC;iBAAM,CAAC;gBACN,IAAI,UAAU,CAAC,KAAK,EAAE,CAAC;oBACrB,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBACvC,CAAC;qBAAM,CAAC;oBACN,mBAAmB;oBACnB,UAAU,CAAC,KAAK,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBACrC,CAAC;YACH,CAAC;YAED,wCAAwC;QAC1C,CAAC;aAAM,CAAC;YACN,IAAI,UAAU,CAAC,IAAI,EAAE,CAAC;gBACpB,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACtC,CAAC;iBAAM,CAAC;gBACN,mBAAmB;gBACnB,UAAU,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACpC,CAAC;QACH,CAAC;IACH,CAAC;IAED,4BAA4B;IAC5B,OAAO,UAAU,CAAC;AACpB,CAAC"}

package/dist/methods/forward.d.ts

@@ -0,0 +1,11 @@
+import type { BaseIssue, BaseValidation } from '../types/index.js';
+import type { RequiredPath, ValidPath } from './types/forward.js';
+/**
+ * Forwards the issues of the passed validation action.
+ *
+ * @param action The validation action.
+ * @param path The path to forward the issues to.
+ *
+ * @returns The modified action.
+ */
+export declare function forward<TInput extends Record<string, unknown> | ArrayLike<unknown>, TIssue extends BaseIssue<unknown>, const TPath extends RequiredPath>(action: BaseValidation<TInput, TInput, TIssue>, path: ValidPath<TInput, TPath>): BaseValidation<TInput, TInput, TIssue>;

package/dist/methods/forward.js

@@ -0,0 +1,66 @@
+// TODO: We should try to find a better way to type this function without
+// breaking the type inference, as the current implementation loses some type
+// information by returning a `BaseValidation` instead of the original type.
+// In the process, we should also figure out how to add a `.forward' property
+// to the returnd object in a type-safe way, similar to how the `fallback`
+// method works.
+/**
+ * Forwards the issues of the passed validation action.
+ *
+ * @param action The validation action.
+ * @param path The path to forward the issues to.
+ *
+ * @returns The modified action.
+ */
+// @__NO_SIDE_EFFECTS__
+export function forward(action, path) {
+    return {
+        ...action,
+        '~run'(dataset, config) {
+            // Create copy of previous issues
+            const prevIssues = dataset.issues && [...dataset.issues];
+            // Run validation action
+            dataset = action['~run'](dataset, config);
+            // If dataset contains issues, forward newly added issues
+            if (dataset.issues) {
+                for (const issue of dataset.issues) {
+                    if (!prevIssues?.includes(issue)) {
+                        // Create path input variable
+                        let pathInput = dataset.value;
+                        // Try to forward issue to end of path list
+                        for (const key of path) {
+                            // Create path value variable
+                            // @ts-expect-error
+                            const pathValue = pathInput[key];
+                            // Create path item for current key
+                            const pathItem = {
+                                type: 'unknown',
+                                origin: 'value',
+                                input: pathInput,
+                                key,
+                                value: pathValue,
+                            };
+                            // Forward issue by adding path item
+                            if (issue.path) {
+                                issue.path.push(pathItem);
+                            }
+                            else {
+                                // @ts-expect-error
+                                issue.path = [pathItem];
+                            }
+                            // If path value is undefined, stop forwarding
+                            if (!pathValue) {
+                                break;
+                            }
+                            // Set next path input to current path value
+                            pathInput = pathValue;
+                        }
+                    }
+                }
+            }
+            // Return output dataset
+            return dataset;
+        },
+    };
+}
+//# sourceMappingURL=forward.js.map

package/dist/methods/forward.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"forward.js","sourceRoot":"","sources":["../../src/methods/forward.ts"],"names":[],"mappings":"AAOA,yEAAyE;AACzE,6EAA6E;AAC7E,4EAA4E;AAC5E,6EAA6E;AAC7E,0EAA0E;AAC1E,gBAAgB;AAEhB;;;;;;;GAOG;AACH,uBAAuB;AACvB,MAAM,UAAU,OAAO,CAKrB,MAA8C,EAC9C,IAA8B;IAE9B,OAAO;QACL,GAAG,MAAM;QACT,MAAM,CAAC,OAAO,EAAE,MAAM;YACpB,iCAAiC;YACjC,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,IAAI,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;YAEzD,wBAAwB;YACxB,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YAE1C,yDAAyD;YACzD,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;gBACnB,KAAK,MAAM,KAAK,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;oBACnC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;wBACjC,6BAA6B;wBAC7B,IAAI,SAAS,GAAY,OAAO,CAAC,KAAK,CAAC;wBAEvC,2CAA2C;wBAC3C,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;4BACvB,6BAA6B;4BAC7B,mBAAmB;4BACnB,MAAM,SAAS,GAAY,SAAS,CAAC,GAAG,CAAC,CAAC;4BAE1C,mCAAmC;4BACnC,MAAM,QAAQ,GAAkB;gCAC9B,IAAI,EAAE,SAAS;gCACf,MAAM,EAAE,OAAO;gCACf,KAAK,EAAE,SAAS;gCAChB,GAAG;gCACH,KAAK,EAAE,SAAS;6BACjB,CAAC;4BAEF,oCAAoC;4BACpC,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;gCACf,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;4BAC5B,CAAC;iCAAM,CAAC;gCACN,mBAAmB;gCACnB,KAAK,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC;4BAC1B,CAAC;4BAED,8CAA8C;4BAC9C,IAAI,CAAC,SAAS,EAAE,CAAC;gCACf,MAAM;4BACR,CAAC;4BAED,4CAA4C;4BAC5C,SAAS,GAAG,SAAS,CAAC;wBACxB,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;YAED,wBAAwB;YACxB,OAAO,OAAO,CAAC;QACjB,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/methods/forwardAsync.d.ts

@@ -0,0 +1,11 @@
+import type { BaseIssue, BaseValidation, BaseValidationAsync } from '../types/index.js';
+import type { RequiredPath, ValidPath } from './types/forward.js';
+/**
+ * Forwards the issues of the passed validation action.
+ *
+ * @param action The validation action.
+ * @param path The path to forward the issues to.
+ *
+ * @returns The modified action.
+ */
+export declare function forwardAsync<TInput extends Record<string, unknown> | ArrayLike<unknown>, TIssue extends BaseIssue<unknown>, const TPath extends RequiredPath>(action: BaseValidation<TInput, TInput, TIssue> | BaseValidationAsync<TInput, TInput, TIssue>, path: ValidPath<TInput, TPath>): BaseValidationAsync<TInput, TInput, TIssue>;

package/dist/methods/forwardAsync.js

@@ -0,0 +1,67 @@
+// TODO: We should try to find a better way to type this function without
+// breaking the type inference, as the current implementation loses some type
+// information by returning a `BaseValidation` instead of the original type.
+// In the process, we should also figure out how to add a `.forward' property
+// to the returnd object in a type-safe way, similar to how the `fallback`
+// method works.
+/**
+ * Forwards the issues of the passed validation action.
+ *
+ * @param action The validation action.
+ * @param path The path to forward the issues to.
+ *
+ * @returns The modified action.
+ */
+// @__NO_SIDE_EFFECTS__
+export function forwardAsync(action, path) {
+    return {
+        ...action,
+        async: true,
+        async '~run'(dataset, config) {
+            // Create copy of previous issues
+            const prevIssues = dataset.issues && [...dataset.issues];
+            // Run validation action
+            dataset = await action['~run'](dataset, config);
+            // If dataset contains issues, forward newly added issues
+            if (dataset.issues) {
+                for (const issue of dataset.issues) {
+                    if (!prevIssues?.includes(issue)) {
+                        // Create path input variable
+                        let pathInput = dataset.value;
+                        // Try to forward issue to end of path list
+                        for (const key of path) {
+                            // Create path value variable
+                            // @ts-expect-error
+                            const pathValue = pathInput[key];
+                            // Create path item for current key
+                            const pathItem = {
+                                type: 'unknown',
+                                origin: 'value',
+                                input: pathInput,
+                                key,
+                                value: pathValue,
+                            };
+                            // Forward issue by adding path item
+                            if (issue.path) {
+                                issue.path.push(pathItem);
+                            }
+                            else {
+                                // @ts-expect-error
+                                issue.path = [pathItem];
+                            }
+                            // If path value is undefined, stop forwarding
+                            if (!pathValue) {
+                                break;
+                            }
+                            // Set next path input to current path value
+                            pathInput = pathValue;
+                        }
+                    }
+                }
+            }
+            // Return output dataset
+            return dataset;
+        },
+    };
+}
+//# sourceMappingURL=forwardAsync.js.map

package/dist/methods/forwardAsync.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"forwardAsync.js","sourceRoot":"","sources":["../../src/methods/forwardAsync.ts"],"names":[],"mappings":"AAQA,yEAAyE;AACzE,6EAA6E;AAC7E,4EAA4E;AAC5E,6EAA6E;AAC7E,0EAA0E;AAC1E,gBAAgB;AAEhB;;;;;;;GAOG;AACH,uBAAuB;AACvB,MAAM,UAAU,YAAY,CAK1B,MAE+C,EAC/C,IAA8B;IAE9B,OAAO;QACL,GAAG,MAAM;QACT,KAAK,EAAE,IAAI;QACX,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM;YAC1B,iCAAiC;YACjC,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,IAAI,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;YAEzD,wBAAwB;YACxB,OAAO,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YAEhD,yDAAyD;YACzD,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;gBACnB,KAAK,MAAM,KAAK,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;oBACnC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;wBACjC,6BAA6B;wBAC7B,IAAI,SAAS,GAAY,OAAO,CAAC,KAAK,CAAC;wBAEvC,2CAA2C;wBAC3C,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;4BACvB,6BAA6B;4BAC7B,mBAAmB;4BACnB,MAAM,SAAS,GAAY,SAAS,CAAC,GAAG,CAAC,CAAC;4BAE1C,mCAAmC;4BACnC,MAAM,QAAQ,GAAkB;gCAC9B,IAAI,EAAE,SAAS;gCACf,MAAM,EAAE,OAAO;gCACf,KAAK,EAAE,SAAS;gCAChB,GAAG;gCACH,KAAK,EAAE,SAAS;6BACjB,CAAC;4BAEF,oCAAoC;4BACpC,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;gCACf,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;4BAC5B,CAAC;iCAAM,CAAC;gCACN,mBAAmB;gCACnB,KAAK,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC;4BAC1B,CAAC;4BAED,8CAA8C;4BAC9C,IAAI,CAAC,SAAS,EAAE,CAAC;gCACf,MAAM;4BACR,CAAC;4BAED,4CAA4C;4BAC5C,SAAS,GAAG,SAAS,CAAC;wBACxB,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;YAED,wBAAwB;YACxB,OAAO,OAAO,CAAC;QACjB,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/methods/getDefault.d.ts

@@ -0,0 +1,25 @@
+import type { ExactOptionalSchema, ExactOptionalSchemaAsync, NullableSchema, NullableSchemaAsync, NullishSchema, NullishSchemaAsync, OptionalSchema, OptionalSchemaAsync, UndefinedableSchema, UndefinedableSchemaAsync } from '../schemas/index.js';
+import type { BaseIssue, BaseSchema, BaseSchemaAsync, Config, InferIssue, UnknownDataset } from '../types/index.js';
+/**
+ * Schema with default type.
+ */
+type SchemaWithDefault = ExactOptionalSchema<BaseSchema<unknown, unknown, BaseIssue<unknown>>, unknown> | NullableSchema<BaseSchema<unknown, unknown, BaseIssue<unknown>>, unknown> | NullishSchema<BaseSchema<unknown, unknown, BaseIssue<unknown>>, unknown> | OptionalSchema<BaseSchema<unknown, unknown, BaseIssue<unknown>>, unknown> | UndefinedableSchema<BaseSchema<unknown, unknown, BaseIssue<unknown>>, unknown>;
+/**
+ * Schema with default async type.
+ */
+type SchemaWithDefaultAsync = ExactOptionalSchemaAsync<BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>, unknown> | NullableSchemaAsync<BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>, unknown> | NullishSchemaAsync<BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>, unknown> | OptionalSchemaAsync<BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>, unknown> | UndefinedableSchemaAsync<BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>, unknown>;
+/**
+ * Infer default type.
+ */
+export type InferDefault<TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>> | SchemaWithDefault | SchemaWithDefaultAsync> = TSchema extends SchemaWithDefault | SchemaWithDefaultAsync ? TSchema['default'] extends (...args: any) => any ? ReturnType<TSchema['default']> : TSchema['default'] : undefined;
+/**
+ * Returns the default value of the schema.
+ *
+ * @param schema The schema to get it from.
+ * @param dataset The input dataset if available.
+ * @param config The config if available.
+ *
+ * @returns The default value.
+ */
+export declare function getDefault<const TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>>(schema: TSchema, dataset?: UnknownDataset, config?: Config<InferIssue<TSchema>>): InferDefault<TSchema>;
+export {};

package/dist/methods/getDefault.js

@@ -0,0 +1,19 @@
+/**
+ * Returns the default value of the schema.
+ *
+ * @param schema The schema to get it from.
+ * @param dataset The input dataset if available.
+ * @param config The config if available.
+ *
+ * @returns The default value.
+ */
+// @__NO_SIDE_EFFECTS__
+export function getDefault(schema, dataset, config) {
+    // @ts-expect-error
+    return typeof schema.default === 'function'
+        ? // @ts-expect-error
+            schema.default(dataset, config)
+        : // @ts-expect-error
+            schema.default;
+}
+//# sourceMappingURL=getDefault.js.map

package/dist/methods/getDefault.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getDefault.js","sourceRoot":"","sources":["../../src/methods/getDefault.ts"],"names":[],"mappings":"AAmFA;;;;;;;;GAQG;AACH,uBAAuB;AACvB,MAAM,UAAU,UAAU,CAKxB,MAAe,EACf,OAAwB,EACxB,MAAoC;IAEpC,mBAAmB;IACnB,OAAO,OAAO,MAAM,CAAC,OAAO,KAAK,UAAU;QACzC,CAAC,CAAC,mBAAmB;YACrB,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC;QAC/B,CAAC,CAAC,mBAAmB;YACrB,MAAM,CAAC,OAAO,CAAC;AACnB,CAAC"}

package/dist/methods/getDefaults.d.ts

@@ -0,0 +1,15 @@
+import type { LooseObjectIssue, LooseObjectSchema, LooseTupleIssue, LooseTupleSchema, ObjectIssue, ObjectSchema, ObjectWithRestIssue, ObjectWithRestSchema, StrictObjectIssue, StrictObjectSchema, StrictTupleIssue, StrictTupleSchema, TupleIssue, TupleSchema, TupleWithRestIssue, TupleWithRestSchema } from '../schemas/index.js';
+import type { BaseIssue, BaseSchema, ErrorMessage, ObjectEntries, TupleItems } from '../types/index.js';
+import type { InferDefaults } from './types/getDefaults.js';
+/**
+ * Returns the default values of the schema.
+ *
+ * Hint: The difference to `getDefault` is that for object and tuple schemas
+ * this function recursively returns the default values of the subschemas
+ * instead of `undefined`.
+ *
+ * @param schema The schema to get them from.
+ *
+ * @returns The default values.
+ */
+export declare function getDefaults<const TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | LooseObjectSchema<ObjectEntries, ErrorMessage<LooseObjectIssue> | undefined> | LooseTupleSchema<TupleItems, ErrorMessage<LooseTupleIssue> | undefined> | ObjectSchema<ObjectEntries, ErrorMessage<ObjectIssue> | undefined> | ObjectWithRestSchema<ObjectEntries, BaseSchema<unknown, unknown, BaseIssue<unknown>>, ErrorMessage<ObjectWithRestIssue> | undefined> | StrictObjectSchema<ObjectEntries, ErrorMessage<StrictObjectIssue> | undefined> | StrictTupleSchema<TupleItems, ErrorMessage<StrictTupleIssue> | undefined> | TupleSchema<TupleItems, ErrorMessage<TupleIssue> | undefined> | TupleWithRestSchema<TupleItems, BaseSchema<unknown, unknown, BaseIssue<unknown>>, ErrorMessage<TupleWithRestIssue> | undefined>>(schema: TSchema): InferDefaults<TSchema>;

package/dist/methods/getDefaults.js

@@ -0,0 +1,31 @@
+import { getDefault } from './getDefault.js';
+/**
+ * Returns the default values of the schema.
+ *
+ * Hint: The difference to `getDefault` is that for object and tuple schemas
+ * this function recursively returns the default values of the subschemas
+ * instead of `undefined`.
+ *
+ * @param schema The schema to get them from.
+ *
+ * @returns The default values.
+ */
+// @__NO_SIDE_EFFECTS__
+export function getDefaults(schema) {
+    // If it is an object schema, return defaults of entries
+    if ('entries' in schema) {
+        const object = {};
+        for (const key in schema.entries) {
+            object[key] = getDefaults(schema.entries[key]);
+        }
+        return object;
+    }
+    // If it is a tuple schema, return defaults of items
+    if ('items' in schema) {
+        return schema.items.map(getDefaults);
+    }
+    // Otherwise, return default or `undefined`
+    // @ts-expect-error
+    return getDefault(schema);
+}
+//# sourceMappingURL=getDefaults.js.map

package/dist/methods/getDefaults.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getDefaults.js","sourceRoot":"","sources":["../../src/methods/getDefaults.ts"],"names":[],"mappings":"AAyBA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAG7C;;;;;;;;;;GAUG;AACH,uBAAuB;AACvB,MAAM,UAAU,WAAW,CAyBzB,MAAe;IACf,wDAAwD;IACxD,IAAI,SAAS,IAAI,MAAM,EAAE,CAAC;QACxB,MAAM,MAAM,GAA4B,EAAE,CAAC;QAC3C,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACjC,MAAM,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;QACjD,CAAC;QACD,OAAO,MAAgC,CAAC;IAC1C,CAAC;IAED,oDAAoD;IACpD,IAAI,OAAO,IAAI,MAAM,EAAE,CAAC;QACtB,OAAO,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,CAA2B,CAAC;IACjE,CAAC;IAED,2CAA2C;IAC3C,mBAAmB;IACnB,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC;AAC5B,CAAC"}

package/dist/methods/getDefaultsAsync.d.ts

@@ -0,0 +1,15 @@
+import type { LooseObjectIssue, LooseObjectSchema, LooseObjectSchemaAsync, LooseTupleIssue, LooseTupleSchema, LooseTupleSchemaAsync, ObjectIssue, ObjectSchema, ObjectSchemaAsync, ObjectWithRestIssue, ObjectWithRestSchema, ObjectWithRestSchemaAsync, StrictObjectIssue, StrictObjectSchema, StrictObjectSchemaAsync, StrictTupleIssue, StrictTupleSchema, StrictTupleSchemaAsync, TupleIssue, TupleSchema, TupleSchemaAsync, TupleWithRestIssue, TupleWithRestSchema, TupleWithRestSchemaAsync } from '../schemas/index.js';
+import type { BaseIssue, BaseSchema, BaseSchemaAsync, ErrorMessage, ObjectEntries, ObjectEntriesAsync, TupleItems, TupleItemsAsync } from '../types/index.js';
+import type { InferDefaults } from './types/getDefaults.js';
+/**
+ * Returns the default values of the schema.
+ *
+ * Hint: The difference to `getDefault` is that for object and tuple schemas
+ * this function recursively returns the default values of the subschemas
+ * instead of `undefined`.
+ *
+ * @param schema The schema to get them from.
+ *
+ * @returns The default values.
+ */
+export declare function getDefaultsAsync<const TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>> | LooseObjectSchema<ObjectEntries, ErrorMessage<LooseObjectIssue> | undefined> | LooseObjectSchemaAsync<ObjectEntriesAsync, ErrorMessage<LooseObjectIssue> | undefined> | LooseTupleSchema<TupleItems, ErrorMessage<LooseTupleIssue> | undefined> | LooseTupleSchemaAsync<TupleItemsAsync, ErrorMessage<LooseTupleIssue> | undefined> | ObjectSchema<ObjectEntries, ErrorMessage<ObjectIssue> | undefined> | ObjectSchemaAsync<ObjectEntriesAsync, ErrorMessage<ObjectIssue> | undefined> | ObjectWithRestSchema<ObjectEntries, BaseSchema<unknown, unknown, BaseIssue<unknown>>, ErrorMessage<ObjectWithRestIssue> | undefined> | ObjectWithRestSchemaAsync<ObjectEntriesAsync, BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>, ErrorMessage<ObjectWithRestIssue> | undefined> | StrictObjectSchema<ObjectEntries, ErrorMessage<StrictObjectIssue> | undefined> | StrictObjectSchemaAsync<ObjectEntriesAsync, ErrorMessage<StrictObjectIssue> | undefined> | StrictTupleSchema<TupleItems, ErrorMessage<StrictTupleIssue> | undefined> | StrictTupleSchemaAsync<TupleItemsAsync, ErrorMessage<StrictTupleIssue> | undefined> | TupleSchema<TupleItems, ErrorMessage<TupleIssue> | undefined> | TupleSchemaAsync<TupleItemsAsync, ErrorMessage<TupleIssue> | undefined> | TupleWithRestSchema<TupleItems, BaseSchema<unknown, unknown, BaseIssue<unknown>>, ErrorMessage<TupleWithRestIssue> | undefined> | TupleWithRestSchemaAsync<TupleItemsAsync, BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>, ErrorMessage<TupleWithRestIssue> | undefined>>(schema: TSchema): Promise<InferDefaults<TSchema>>;

package/dist/methods/getDefaultsAsync.js

@@ -0,0 +1,30 @@
+import { getDefault } from './getDefault.js';
+/**
+ * Returns the default values of the schema.
+ *
+ * Hint: The difference to `getDefault` is that for object and tuple schemas
+ * this function recursively returns the default values of the subschemas
+ * instead of `undefined`.
+ *
+ * @param schema The schema to get them from.
+ *
+ * @returns The default values.
+ */
+// @__NO_SIDE_EFFECTS__
+export async function getDefaultsAsync(schema) {
+    // If it is an object schema, return defaults of entries
+    if ('entries' in schema) {
+        return Object.fromEntries(await Promise.all(Object.entries(schema.entries).map(async ([key, value]) => [
+            key,
+            await getDefaultsAsync(value),
+        ])));
+    }
+    // If it is a tuple schema, return defaults of items
+    if ('items' in schema) {
+        return Promise.all(schema.items.map(getDefaultsAsync));
+    }
+    // Otherwise, return default or `undefined`
+    // @ts-expect-error
+    return getDefault(schema);
+}
+//# sourceMappingURL=getDefaultsAsync.js.map

package/dist/methods/getDefaultsAsync.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getDefaultsAsync.js","sourceRoot":"","sources":["../../src/methods/getDefaultsAsync.ts"],"names":[],"mappings":"AAoCA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAG7C;;;;;;;;;;GAUG;AACH,uBAAuB;AACvB,MAAM,CAAC,KAAK,UAAU,gBAAgB,CA2DpC,MAAe;IACf,wDAAwD;IACxD,IAAI,SAAS,IAAI,MAAM,EAAE,CAAC;QACxB,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,OAAO,CAAC,GAAG,CACf,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC;YACzD,GAAG;YACH,MAAM,gBAAgB,CAAC,KAAK,CAAC;SAC9B,CAAC,CACH,CACwB,CAAC;IAC9B,CAAC;IAED,oDAAoD;IACpD,IAAI,OAAO,IAAI,MAAM,EAAE,CAAC;QACtB,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAEpD,CAAC;IACJ,CAAC;IAED,2CAA2C;IAC3C,mBAAmB;IACnB,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC;AAC5B,CAAC"}

package/dist/methods/getDescription.d.ts

@@ -0,0 +1,27 @@
+import type { DescriptionAction } from '../actions/index.js';
+import type { BaseIssue, BaseSchema, BaseSchemaAsync, PipeItem, PipeItemAsync } from '../types/index.js';
+import type { SchemaWithPipe, SchemaWithPipeAsync } from './index.js';
+/**
+ * Schema type.
+ */
+type Schema = BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>> | SchemaWithPipe<readonly [
+    BaseSchema<unknown, unknown, BaseIssue<unknown>>,
+    ...(PipeItem<any, unknown, BaseIssue<unknown>> | DescriptionAction<unknown, string>)[]
+]> | SchemaWithPipeAsync<readonly [
+    (BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>),
+    ...(PipeItem<any, unknown, BaseIssue<unknown>> | PipeItemAsync<any, unknown, BaseIssue<unknown>> | DescriptionAction<unknown, string>)[]
+]>;
+/**
+ * Returns the description of the schema.
+ *
+ * If multiple descriptions are defined, the last one of the highest level is
+ * returned. If no description is defined, `undefined` is returned.
+ *
+ * @param schema The schema to get the description from.
+ *
+ * @returns The description, if any.
+ *
+ * @beta
+ */
+export declare function getDescription(schema: Schema): string | undefined;
+export {};

package/dist/methods/getDescription.js

@@ -0,0 +1,19 @@
+import { _getLastMetadata } from '../utils/index.js';
+/**
+ * Returns the description of the schema.
+ *
+ * If multiple descriptions are defined, the last one of the highest level is
+ * returned. If no description is defined, `undefined` is returned.
+ *
+ * @param schema The schema to get the description from.
+ *
+ * @returns The description, if any.
+ *
+ * @beta
+ */
+// TODO: Investigate if return type can be strongly typed
+// @__NO_SIDE_EFFECTS__
+export function getDescription(schema) {
+    return _getLastMetadata(schema, 'description');
+}
+//# sourceMappingURL=getDescription.js.map

package/dist/methods/getDescription.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getDescription.js","sourceRoot":"","sources":["../../src/methods/getDescription.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAgCrD;;;;;;;;;;;GAWG;AACH,yDAAyD;AACzD,uBAAuB;AACvB,MAAM,UAAU,cAAc,CAAC,MAAc;IAC3C,OAAO,gBAAgB,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;AACjD,CAAC"}

package/dist/methods/getExamples.d.ts

@@ -0,0 +1,38 @@
+import type { ExamplesAction } from '../actions/index.js';
+import type { BaseIssue, BaseSchema, BaseSchemaAsync, PipeItem, PipeItemAsync } from '../types/index.js';
+import type { SchemaWithPipe, SchemaWithPipeAsync } from './index.js';
+/**
+ * Schema type.
+ */
+type Schema = BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>> | SchemaWithPipe<readonly [
+    BaseSchema<unknown, unknown, BaseIssue<unknown>>,
+    ...(PipeItem<any, unknown, BaseIssue<unknown>> | ExamplesAction<unknown, readonly unknown[]>)[]
+]> | SchemaWithPipeAsync<readonly [
+    (BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>),
+    ...(PipeItem<any, unknown, BaseIssue<unknown>> | PipeItemAsync<any, unknown, BaseIssue<unknown>> | ExamplesAction<unknown, readonly unknown[]>)[]
+]>;
+/**
+ * Recursively concat type.
+ */
+type RecursiveConcat<TRootPipe extends readonly (PipeItem<any, unknown, BaseIssue<unknown>> | PipeItemAsync<any, unknown, BaseIssue<unknown>>)[], TCollectedExamples extends unknown[] = []> = TRootPipe extends readonly [
+    infer TFirstItem,
+    ...infer TPipeRest extends readonly (PipeItem<any, unknown, BaseIssue<unknown>> | PipeItemAsync<any, unknown, BaseIssue<unknown>>)[]
+] ? TFirstItem extends SchemaWithPipe<infer TNestedPipe> | SchemaWithPipeAsync<infer TNestedPipe> ? RecursiveConcat<TPipeRest, RecursiveConcat<TNestedPipe, TCollectedExamples>> : TFirstItem extends ExamplesAction<unknown, infer TCurrentExamples> ? RecursiveConcat<TPipeRest, [...TCollectedExamples, ...TCurrentExamples]> : RecursiveConcat<TPipeRest, TCollectedExamples> : TCollectedExamples;
+/**
+ * Infer examples type.
+ */
+export type InferExamples<TSchema extends Schema> = TSchema extends SchemaWithPipe<infer TPipe> | SchemaWithPipeAsync<infer TPipe> ? Readonly<RecursiveConcat<TPipe>> : [];
+/**
+ * Returns the examples of a schema.
+ *
+ * If multiple examples are defined, it concatenates them using depth-first
+ * search. If no examples are defined, an empty array is returned.
+ *
+ * @param schema The schema to get the examples from.
+ *
+ * @returns The examples, if any.
+ *
+ * @beta
+ */
+export declare function getExamples<const TSchema extends Schema>(schema: TSchema): InferExamples<TSchema>;
+export {};

package/dist/methods/getExamples.js

@@ -0,0 +1,33 @@
+/**
+ * Returns the examples of a schema.
+ *
+ * If multiple examples are defined, it concatenates them using depth-first
+ * search. If no examples are defined, an empty array is returned.
+ *
+ * @param schema The schema to get the examples from.
+ *
+ * @returns The examples, if any.
+ *
+ * @beta
+ */
+// @__NO_SIDE_EFFECTS__
+export function getExamples(schema) {
+    const examples = [];
+    function depthFirstCollect(schema) {
+        if ('pipe' in schema) {
+            for (const item of schema.pipe) {
+                if (item.kind === 'schema' && 'pipe' in item) {
+                    depthFirstCollect(item);
+                }
+                else if (item.kind === 'metadata' && item.type === 'examples') {
+                    // @ts-expect-error
+                    examples.push(...item.examples);
+                }
+            }
+        }
+    }
+    depthFirstCollect(schema);
+    // @ts-expect-error
+    return examples;
+}
+//# sourceMappingURL=getExamples.js.map