Index: node_modules/@standard-schema/utils/LICENSE =================================================================== --- node_modules/@standard-schema/utils/LICENSE (revision a762898ecd37a452c782821d4c2c4955c6ed2521) +++ node_modules/@standard-schema/utils/LICENSE (revision a762898ecd37a452c782821d4c2c4955c6ed2521) @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Fabian Hiller + +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. Index: node_modules/@standard-schema/utils/README.md =================================================================== --- node_modules/@standard-schema/utils/README.md (revision a762898ecd37a452c782821d4c2c4955c6ed2521) +++ node_modules/@standard-schema/utils/README.md (revision a762898ecd37a452c782821d4c2c4955c6ed2521) @@ -0,0 +1,61 @@ +# Standard Schema Utils + +There are two common tasks that third-party libraries perform after validation fails. The first is to flatten the issues by creating a dot path to more easily associate the issues with the input data. This is commonly used in form libraries. The second is to throw an error that contains all the issue information. To simplify both tasks, Standard Schema also ships a utils package that provides a `getDotPath` function and a `SchemaError` class. + +```sh +npm install @standard-schema/utils # npm +yarn add @standard-schema/utils # yarn +pnpm add @standard-schema/utils # pnpm +bun add @standard-schema/utils # bun +deno add jsr:@standard-schema/utils # deno +``` + +## Get Dot Path + +To generate a dot path, simply pass an issue to the `getDotPath` function. If the issue does not contain a path or the path contains a key that is not of type `string` or `number`, the function returns `null`. + +```ts +import type { StandardSchemaV1 } from "@standard-schema/spec"; +import { getDotPath } from "@standard-schema/utils"; + +async function getFormErrors(schema: StandardSchemaV1, data: unknown) { + const result = await schema["~standard"].validate(data); + const formErrors: string[] = []; + const fieldErrors: Record = {}; + if (result.issues) { + for (const issue of result.issues) { + const dotPath = getDotPath(issue); + if (dotPath) { + if (fieldErrors[dotPath]) { + fieldErrors[dotPath].push(issue.message); + } else { + fieldErrors[dotPath] = [issue.message]; + } + } else { + formErrors.push(issue.message); + } + } + } + return { formErrors, fieldErrors }; +} +``` + +## Schema Error + +To throw an error that contains all issue information, simply pass the issues of the failed schema validation to the `SchemaError` class. The `SchemaError` class extends the `Error` class with an `issues` property that contains all the issues. + +```ts +import type { StandardSchemaV1 } from "@standard-schema/spec"; +import { SchemaError } from "@standard-schema/utils"; + +async function validateInput( + schema: TSchema, + data: unknown, +): Promise> { + const result = await schema["~standard"].validate(data); + if (result.issues) { + throw new SchemaError(result.issues); + } + return result.value; +} +``` Index: node_modules/@standard-schema/utils/dist/index.cjs =================================================================== --- node_modules/@standard-schema/utils/dist/index.cjs (revision a762898ecd37a452c782821d4c2c4955c6ed2521) +++ node_modules/@standard-schema/utils/dist/index.cjs (revision a762898ecd37a452c782821d4c2c4955c6ed2521) @@ -0,0 +1,70 @@ +"use strict"; +var __defProp = Object.defineProperty; +var __getOwnPropDesc = Object.getOwnPropertyDescriptor; +var __getOwnPropNames = Object.getOwnPropertyNames; +var __hasOwnProp = Object.prototype.hasOwnProperty; +var __export = (target, all) => { + for (var name in all) + __defProp(target, name, { get: all[name], enumerable: true }); +}; +var __copyProps = (to, from, except, desc) => { + if (from && typeof from === "object" || typeof from === "function") { + for (let key of __getOwnPropNames(from)) + if (!__hasOwnProp.call(to, key) && key !== except) + __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable }); + } + return to; +}; +var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod); + +// src/index.ts +var src_exports = {}; +__export(src_exports, { + SchemaError: () => SchemaError, + getDotPath: () => getDotPath +}); +module.exports = __toCommonJS(src_exports); + +// src/getDotPath/getDotPath.ts +function getDotPath(issue) { + if (issue.path?.length) { + let dotPath = ""; + for (const item of issue.path) { + const key = typeof item === "object" ? item.key : item; + if (typeof key === "string" || typeof key === "number") { + if (dotPath) { + dotPath += `.${key}`; + } else { + dotPath += key; + } + } else { + return null; + } + } + return dotPath; + } + return null; +} + +// src/SchemaError/SchemaError.ts +var SchemaError = class extends Error { + /** + * The schema issues. + */ + issues; + /** + * Creates a schema error with useful information. + * + * @param issues The schema issues. + */ + constructor(issues) { + super(issues[0].message); + this.name = "SchemaError"; + this.issues = issues; + } +}; +// Annotate the CommonJS export names for ESM import in node: +0 && (module.exports = { + SchemaError, + getDotPath +}); Index: node_modules/@standard-schema/utils/dist/index.d.cts =================================================================== --- node_modules/@standard-schema/utils/dist/index.d.cts (revision a762898ecd37a452c782821d4c2c4955c6ed2521) +++ node_modules/@standard-schema/utils/dist/index.d.cts (revision a762898ecd37a452c782821d4c2c4955c6ed2521) @@ -0,0 +1,28 @@ +import { StandardSchemaV1 } from '@standard-schema/spec'; + +/** + * Creates and returns the dot path of an issue if possible. + * + * @param issue The issue to get the dot path from. + * + * @returns The dot path or null. + */ +declare function getDotPath(issue: StandardSchemaV1.Issue): string | null; + +/** + * A schema error with useful information. + */ +declare class SchemaError extends Error { + /** + * The schema issues. + */ + readonly issues: ReadonlyArray; + /** + * Creates a schema error with useful information. + * + * @param issues The schema issues. + */ + constructor(issues: ReadonlyArray); +} + +export { SchemaError, getDotPath }; Index: node_modules/@standard-schema/utils/dist/index.d.ts =================================================================== --- node_modules/@standard-schema/utils/dist/index.d.ts (revision a762898ecd37a452c782821d4c2c4955c6ed2521) +++ node_modules/@standard-schema/utils/dist/index.d.ts (revision a762898ecd37a452c782821d4c2c4955c6ed2521) @@ -0,0 +1,28 @@ +import { StandardSchemaV1 } from '@standard-schema/spec'; + +/** + * Creates and returns the dot path of an issue if possible. + * + * @param issue The issue to get the dot path from. + * + * @returns The dot path or null. + */ +declare function getDotPath(issue: StandardSchemaV1.Issue): string | null; + +/** + * A schema error with useful information. + */ +declare class SchemaError extends Error { + /** + * The schema issues. + */ + readonly issues: ReadonlyArray; + /** + * Creates a schema error with useful information. + * + * @param issues The schema issues. + */ + constructor(issues: ReadonlyArray); +} + +export { SchemaError, getDotPath }; Index: node_modules/@standard-schema/utils/dist/index.js =================================================================== --- node_modules/@standard-schema/utils/dist/index.js (revision a762898ecd37a452c782821d4c2c4955c6ed2521) +++ node_modules/@standard-schema/utils/dist/index.js (revision a762898ecd37a452c782821d4c2c4955c6ed2521) @@ -0,0 +1,42 @@ +// src/getDotPath/getDotPath.ts +function getDotPath(issue) { + if (issue.path?.length) { + let dotPath = ""; + for (const item of issue.path) { + const key = typeof item === "object" ? item.key : item; + if (typeof key === "string" || typeof key === "number") { + if (dotPath) { + dotPath += `.${key}`; + } else { + dotPath += key; + } + } else { + return null; + } + } + return dotPath; + } + return null; +} + +// src/SchemaError/SchemaError.ts +var SchemaError = class extends Error { + /** + * The schema issues. + */ + issues; + /** + * Creates a schema error with useful information. + * + * @param issues The schema issues. + */ + constructor(issues) { + super(issues[0].message); + this.name = "SchemaError"; + this.issues = issues; + } +}; +export { + SchemaError, + getDotPath +}; Index: node_modules/@standard-schema/utils/package.json =================================================================== --- node_modules/@standard-schema/utils/package.json (revision a762898ecd37a452c782821d4c2c4955c6ed2521) +++ node_modules/@standard-schema/utils/package.json (revision a762898ecd37a452c782821d4c2c4955c6ed2521) @@ -0,0 +1,54 @@ +{ + "name": "@standard-schema/utils", + "description": "The official runtime utils for Standard Schema", + "version": "0.3.0", + "license": "MIT", + "author": "Fabian Hiller", + "repository": { + "type": "git", + "url": "https://github.com/standard-schema/standard-schema" + }, + "keywords": [ + "standard", + "schema", + "utils" + ], + "type": "module", + "main": "./dist/index.js", + "types": "./dist/index.d.ts", + "exports": { + ".": { + "import": { + "types": "./dist/index.d.ts", + "default": "./dist/index.js" + }, + "require": { + "types": "./dist/index.d.cts", + "default": "./dist/index.cjs" + } + } + }, + "sideEffects": false, + "files": [ + "dist" + ], + "publishConfig": { + "access": "public" + }, + "devDependencies": { + "@standard-schema/spec": "npm:@jsr/standard-schema__spec@1.0.0-beta.4", + "@vitest/coverage-v8": "2.1.2", + "tsup": "^8.3.0", + "typescript": "^5.6.2", + "vite": "^5.4.8", + "vitest": "^2.1.2" + }, + "scripts": { + "test": "vitest", + "coverage": "vitest run --coverage --isolate", + "lint": "pnpm biome lint ./src", + "format": "pnpm biome format --write ./src", + "check": "pnpm biome check ./src", + "build": "tsup" + } +}