shelving 1.157.3 → 1.158.0

package/api/Endpoint.d.ts

@@ -1,5 +1,5 @@
+import { type Schema } from "../schema/Schema.js";
 import type { AbsolutePath } from "../util/path.js";
-import { type Validator } from "../util/validate.js";
 import type { EndpointCallback, EndpointHandler } from "./util.js";
 /** Types for an HTTP request or response that does something. */
 export type EndpointMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
@@ -8,8 +8,8 @@ export type EndpointMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
  *
  * @param method The method of the resource, e.g. `GET`
  * @param path The path of the resource optionally including `{placeholder}` values, e.g. `/patient/{id}`
- * @param payload A `Validator` for the payload of the resource.
- * @param result A `Validator` for the result of the resource.
+ * @param payload A `Schema` for the payload of the resource.
+ * @param result A `Schema` for the result of the resource.
  */
 export declare class Endpoint<P, R> {
     /** Endpoint method. */
@@ -17,10 +17,10 @@ export declare class Endpoint<P, R> {
     /** Endpoint path, e.g. `/patient/{id}` */
     readonly path: AbsolutePath;
     /** Payload validator. */
-    readonly payload: Validator<P>;
+    readonly payload: Schema<P>;
     /** Result validator. */
-    readonly result: Validator<R>;
-    constructor(method: EndpointMethod, path: AbsolutePath, payload: Validator<P>, result: Validator<R>);
+    readonly result: Schema<R>;
+    constructor(method: EndpointMethod, path: AbsolutePath, payload: Schema<P>, result: Schema<R>);
     /**
      * Return an `EndpointHandler` for this endpoint.
      *
@@ -46,34 +46,34 @@ export type EndpointType<X extends Endpoint<unknown, unknown>> = X extends Endpo
  * Represent a GET request to a specified path, with validated payload and return types.
  * "The GET method requests a representation of the specified resource. Requests using GET should only retrieve data and should not contain a request content."
  */
-export declare function GET<P, R>(path: AbsolutePath, payload?: Validator<P>, result?: Validator<R>): Endpoint<P, R>;
-export declare function GET<P>(path: AbsolutePath, payload: Validator<P>): Endpoint<P, undefined>;
-export declare function GET<R>(path: AbsolutePath, payload: undefined, result: Validator<R>): Endpoint<undefined, R>;
+export declare function GET<P, R>(path: AbsolutePath, payload?: Schema<P>, result?: Schema<R>): Endpoint<P, R>;
+export declare function GET<P>(path: AbsolutePath, payload: Schema<P>): Endpoint<P, undefined>;
+export declare function GET<R>(path: AbsolutePath, payload: undefined, result: Schema<R>): Endpoint<undefined, R>;
 /**
  * Represent a POST request to a specified path, with validated payload and return types.
  * "The POST method submits an entity to the specified resource, often causing a change in state or side effects on the server.
  */
-export declare function POST<P, R>(path: AbsolutePath, payload?: Validator<P>, result?: Validator<R>): Endpoint<P, R>;
-export declare function POST<P>(path: AbsolutePath, payload: Validator<P>): Endpoint<P, undefined>;
-export declare function POST<R>(path: AbsolutePath, payload: undefined, result: Validator<R>): Endpoint<undefined, R>;
+export declare function POST<P, R>(path: AbsolutePath, payload?: Schema<P>, result?: Schema<R>): Endpoint<P, R>;
+export declare function POST<P>(path: AbsolutePath, payload: Schema<P>): Endpoint<P, undefined>;
+export declare function POST<R>(path: AbsolutePath, payload: undefined, result: Schema<R>): Endpoint<undefined, R>;
 /**
  * Represent a PUT request to a specified path, with validated payload and return types.
  * "The PUT method replaces all current representations of the target resource with the request content."
  */
-export declare function PUT<P, R>(path: AbsolutePath, payload?: Validator<P>, result?: Validator<R>): Endpoint<P, R>;
-export declare function PUT<P>(path: AbsolutePath, payload: Validator<P>): Endpoint<P, undefined>;
-export declare function PUT<R>(path: AbsolutePath, payload: undefined, result: Validator<R>): Endpoint<undefined, R>;
+export declare function PUT<P, R>(path: AbsolutePath, payload?: Schema<P>, result?: Schema<R>): Endpoint<P, R>;
+export declare function PUT<P>(path: AbsolutePath, payload: Schema<P>): Endpoint<P, undefined>;
+export declare function PUT<R>(path: AbsolutePath, payload: undefined, result: Schema<R>): Endpoint<undefined, R>;
 /**
  * Represent a PATCH request to a specified path, with validated payload and return types.
  * "The PATCH method applies partial modifications to a resource."
  */
-export declare function PATCH<P, R>(path: AbsolutePath, payload?: Validator<P>, result?: Validator<R>): Endpoint<P, R>;
-export declare function PATCH<P>(path: AbsolutePath, payload: Validator<P>): Endpoint<P, undefined>;
-export declare function PATCH<R>(path: AbsolutePath, payload: undefined, result: Validator<R>): Endpoint<undefined, R>;
+export declare function PATCH<P, R>(path: AbsolutePath, payload?: Schema<P>, result?: Schema<R>): Endpoint<P, R>;
+export declare function PATCH<P>(path: AbsolutePath, payload: Schema<P>): Endpoint<P, undefined>;
+export declare function PATCH<R>(path: AbsolutePath, payload: undefined, result: Schema<R>): Endpoint<undefined, R>;
 /**
  * Represent a DELETE request to a specified path, with validated payload and return types.
  * "The DELETE method deletes the specified resource."
  */
-export declare function DELETE<P, R>(path: AbsolutePath, payload?: Validator<P>, result?: Validator<R>): Endpoint<P, R>;
-export declare function DELETE<P>(path: AbsolutePath, payload: Validator<P>): Endpoint<P, undefined>;
-export declare function DELETE<R>(path: AbsolutePath, payload: undefined, result: Validator<R>): Endpoint<undefined, R>;
+export declare function DELETE<P, R>(path: AbsolutePath, payload?: Schema<P>, result?: Schema<R>): Endpoint<P, R>;
+export declare function DELETE<P>(path: AbsolutePath, payload: Schema<P>): Endpoint<P, undefined>;
+export declare function DELETE<R>(path: AbsolutePath, payload: undefined, result: Schema<R>): Endpoint<undefined, R>;

package/api/Endpoint.js

@@ -1,12 +1,13 @@
+import { UNDEFINED } from "../schema/Schema.js";
 import { getResponse } from "../util/http.js";
-import { UNDEFINED, getValid } from "../util/validate.js";
+import { getValid } from "../util/validate.js";
 /**
  * An abstract API resource definition, used to specify types for e.g. serverless functions.
  *
  * @param method The method of the resource, e.g. `GET`
  * @param path The path of the resource optionally including `{placeholder}` values, e.g. `/patient/{id}`
- * @param payload A `Validator` for the payload of the resource.
- * @param result A `Validator` for the result of the resource.
+ * @param payload A `Schema` for the payload of the resource.
+ * @param result A `Schema` for the result of the resource.
  */
 export class Endpoint {
     /** Endpoint method. */
@@ -53,18 +54,18 @@ export class Endpoint {
         return `${this.method} ${this.path}`;
     }
 }
-export function GET(path, payload, result) {
-    return new Endpoint("GET", path, payload || UNDEFINED, result || UNDEFINED);
+export function GET(path, payload = UNDEFINED, result = UNDEFINED) {
+    return new Endpoint("GET", path, payload, result);
 }
-export function POST(path, payload, result) {
-    return new Endpoint("POST", path, payload || UNDEFINED, result || UNDEFINED);
+export function POST(path, payload = UNDEFINED, result = UNDEFINED) {
+    return new Endpoint("POST", path, payload, result);
 }
-export function PUT(path, payload, result) {
-    return new Endpoint("PUT", path, payload || UNDEFINED, result || UNDEFINED);
+export function PUT(path, payload = UNDEFINED, result = UNDEFINED) {
+    return new Endpoint("PUT", path, payload, result);
 }
-export function PATCH(path, payload, result) {
-    return new Endpoint("PATCH", path, payload || UNDEFINED, result || UNDEFINED);
+export function PATCH(path, payload = UNDEFINED, result = UNDEFINED) {
+    return new Endpoint("PATCH", path, payload, result);
 }
-export function DELETE(path, payload, result) {
-    return new Endpoint("DELETE", path, payload || UNDEFINED, result || UNDEFINED);
+export function DELETE(path, payload = UNDEFINED, result = UNDEFINED) {
+    return new Endpoint("DELETE", path, payload, result);
 }

package/package.json

@@ -11,7 +11,7 @@
 		"state-management",
 		"query-builder"
 	],
-	"version": "1.157.3",
+	"version": "1.158.0",
 	"repository": "https://github.com/dhoulb/shelving",
 	"author": "Dave Houlbrooke <dave@shax.com>",
 	"license": "0BSD",

package/schema/ArraySchema.d.ts

@@ -1,11 +1,10 @@
 import type { ImmutableArray } from "../util/array.js";
-import type { Validator } from "../util/validate.js";
 import type { SchemaOptions } from "./Schema.js";
 import { Schema } from "./Schema.js";
 /** Allowed options for `ArraySchema` */
 export interface ArraySchemaOptions<T> extends SchemaOptions {
     readonly value?: ImmutableArray;
-    readonly items: Validator<T>;
+    readonly items: Schema<T>;
     readonly min?: number;
     readonly max?: number;
     readonly unique?: boolean;
@@ -39,7 +38,7 @@ export interface ArraySchemaOptions<T> extends SchemaOptions {
  */
 export declare class ArraySchema<T> extends Schema<ImmutableArray<T>> {
     readonly value: ImmutableArray;
-    readonly items: Validator<T>;
+    readonly items: Schema<T>;
     readonly unique: boolean;
     readonly min: number;
     readonly max: number;
@@ -47,4 +46,4 @@ export declare class ArraySchema<T> extends Schema<ImmutableArray<T>> {
     validate(unsafeValue?: unknown): ImmutableArray<T>;
 }
 /** Valid array with specifed items. */
-export declare const ARRAY: <T>(items: Validator<T>) => ArraySchema<T>;
+export declare const ARRAY: <T>(items: Schema<T>) => ArraySchema<T>;

package/schema/DataSchema.d.ts

@@ -1,19 +1,18 @@
 import type { Data, Database } from "../util/data.js";
 import type { Identifier, Item } from "../util/item.js";
-import type { Validator, Validators } from "../util/validate.js";
 import type { NullableSchema } from "./NullableSchema.js";
-import type { SchemaOptions } from "./Schema.js";
+import type { SchemaOptions, Schemas } from "./Schema.js";
 import { Schema } from "./Schema.js";
 /** Allowed options for `PropsSchema` (a schema that has props). */
 export interface DataSchemaOptions<T extends Data> extends SchemaOptions {
-    readonly id?: Validator<string>;
-    readonly props: Validators<T>;
+    readonly id?: Schema<string>;
+    readonly props: Schemas<T>;
     readonly value?: Partial<T> | undefined;
 }
 /** Validate a data object. */
 export declare class DataSchema<T extends Data> extends Schema<unknown> {
     readonly value: Partial<T>;
-    readonly props: Validators<T>;
+    readonly props: Schemas<T>;
     constructor({ props, title, value, ...options }: DataSchemaOptions<T>);
     validate(unsafeValue?: unknown): T;
 }
@@ -22,10 +21,10 @@ export type DataSchemas<T extends Database> = {
     [K in keyof T]: DataSchema<T[K]>;
 };
 /** Create a `DataSchema` for a set of properties. */
-export declare const DATA: <T extends Data>(props: Validators<T>) => DataSchema<T>;
+export declare const DATA: <T extends Data>(props: Schemas<T>) => DataSchema<T>;
 /** Valid data object with specifed properties, or `null` */
-export declare const NULLABLE_DATA: <T extends Data>(props: Validators<T>) => NullableSchema<T>;
+export declare const NULLABLE_DATA: <T extends Data>(props: Schemas<T>) => NullableSchema<T>;
 /** Create a `DataSchema` that validates partially, i.e. properties can be their value, or `undefined` */
-export declare function PARTIAL<T extends Data>(source: Validators<T> | DataSchema<T>): DataSchema<Partial<T>>;
+export declare function PARTIAL<T extends Data>(source: Schemas<T> | DataSchema<T>): DataSchema<Partial<T>>;
 /** Create a `DataSchema` that validates a data item, i.e. it has a string or number `.id` identifier property. */
-export declare function ITEM<I extends Identifier, T extends Data>(id: Validator<I>, validators: Validators<T> | DataSchema<T>): DataSchema<Item<I, T>>;
+export declare function ITEM<I extends Identifier, T extends Data>(id: Schema<I>, schemas: Schemas<T> | DataSchema<T>): DataSchema<Item<I, T>>;

package/schema/DataSchema.js

@@ -32,8 +32,8 @@ function _optionalProp([, v]) {
     return OPTIONAL(v);
 }
 /** Create a `DataSchema` that validates a data item, i.e. it has a string or number `.id` identifier property. */
-export function ITEM(id, validators) {
-    const props = validators instanceof DataSchema ? validators.props : validators;
+export function ITEM(id, schemas) {
+    const props = schemas instanceof DataSchema ? schemas.props : schemas;
     return new DataSchema({
         props: { id, ...props },
     });

package/schema/DictionarySchema.d.ts

@@ -1,10 +1,9 @@
 import type { ImmutableDictionary } from "../util/dictionary.js";
-import type { Validator } from "../util/validate.js";
 import type { SchemaOptions } from "./Schema.js";
 import { Schema } from "./Schema.js";
 /** Allowed options for `DictionarySchema` */
 export interface DictionarySchemaOptions<T> extends SchemaOptions {
-    readonly items: Validator<T>;
+    readonly items: Schema<T>;
     readonly value?: ImmutableDictionary | undefined;
     readonly min?: number | undefined;
     readonly max?: number | undefined;
@@ -12,11 +11,11 @@ export interface DictionarySchemaOptions<T> extends SchemaOptions {
 /** Validate a dictionary object (whose props are all the same with string keys). */
 export declare class DictionarySchema<T> extends Schema<ImmutableDictionary<T>> {
     readonly value: ImmutableDictionary;
-    readonly items: Validator<T>;
+    readonly items: Schema<T>;
     readonly min: number;
     readonly max: number;
     constructor({ items, min, max, title, value, ...options }: DictionarySchemaOptions<T>);
     validate(unsafeValue?: unknown): ImmutableDictionary<T>;
 }
 /** Valid dictionary object with specifed items. */
-export declare const DICTIONARY: <T>(items: Validator<T>) => DictionarySchema<T>;
+export declare const DICTIONARY: <T>(items: Schema<T>) => DictionarySchema<T>;

package/schema/NullableSchema.d.ts

@@ -1,4 +1,4 @@
-import type { Validator } from "../index.js";
+import type { Schema } from "./Schema.js";
 import { ThroughSchema, type ThroughSchemaOptions } from "./ThroughSchema.js";
 /** Allowed options for `NullableSchema` */
 export interface NullableSchemaOptions<T> extends ThroughSchemaOptions<T | null> {
@@ -12,4 +12,4 @@ export declare class NullableSchema<T> extends ThroughSchema<T | null> {
     validate(unsafeValue?: unknown): T | null;
 }
 /** Create a new nullable schema from a source schema. */
-export declare const NULLABLE: <T>(source: Validator<T>) => NullableSchema<T>;
+export declare const NULLABLE: <T>(source: Schema<T>) => NullableSchema<T>;

package/schema/OptionalSchema.d.ts

@@ -1,4 +1,4 @@
-import type { Validator } from "../util/validate.js";
+import type { Schema } from "./Schema.js";
 import { ThroughSchema, type ThroughSchemaOptions } from "./ThroughSchema.js";
 export interface OptionalSchemaOptions<T> extends ThroughSchemaOptions<T | undefined> {
     /** Default value for an `OptionalSchema` can always `undefined` */
@@ -16,4 +16,4 @@ export declare class OptionalSchema<T> extends ThroughSchema<T | undefined> {
     validate(unsafeValue: unknown): T | undefined;
 }
 /** Make a property of a set of data optional, i.e. it can be the value or `undefined` */
-export declare const OPTIONAL: <T>(source: Validator<T>) => OptionalSchema<T>;
+export declare const OPTIONAL: <T>(source: Schema<T>) => OptionalSchema<T>;

package/schema/Schema.d.ts

@@ -1,3 +1,4 @@
+import type { Data } from "../util/data.js";
 import type { Validator } from "../util/validate.js";
 /** Options allowed by a `Schema` instance. */
 export type SchemaOptions = {
@@ -28,3 +29,10 @@ export declare abstract class Schema<T = unknown> implements Validator<T> {
     /** Every schema must implement a `validate()` method. */
     abstract validate(unsafeValue: unknown): T;
 }
+/** A set of named schemas in `{ name: schema }` format. */
+export type Schemas<T extends Data = Data> = {
+    readonly [K in keyof T]: Schema<T[K]>;
+};
+export declare const UNKNOWN: Schema<unknown>;
+export declare const UNDEFINED: Schema<undefined>;
+export declare const NULL: Schema<null>;

package/schema/Schema.js

@@ -1,3 +1,6 @@
+import { PASSTHROUGH } from "../util/function.js";
+import { getNull } from "../util/null.js";
+import { getUndefined } from "../util/undefined.js";
 /**
  * Schema is an object instance with a `validate()` method.
  * - Type `T` represents the type of value `validate()` returns.
@@ -19,3 +22,9 @@ export class Schema {
         this.value = value;
     }
 }
+// Unknown validator always passes through its input value as `unknown`
+export const UNKNOWN = { title: "", description: "", placeholder: "", value: undefined, validate: PASSTHROUGH };
+// Undefined validator always returns `undefined`
+export const UNDEFINED = { ...UNKNOWN, validate: getUndefined };
+// Null validator always returns `null`
+export const NULL = { ...UNKNOWN, validate: getNull };

package/schema/ThroughSchema.d.ts

@@ -1,14 +1,13 @@
 import type { Sourceable } from "../util/source.js";
-import type { Validator } from "../util/validate.js";
 import type { SchemaOptions } from "./Schema.js";
 import { Schema } from "./Schema.js";
 /** Allowed options for `ThroughSchema` */
 export interface ThroughSchemaOptions<T> extends SchemaOptions {
-    source: Validator<T>;
+    source: Schema<T>;
 }
 /** Schema that passes through to a source schema. */
-export declare abstract class ThroughSchema<T> extends Schema<T> implements Sourceable<Validator<T>> {
-    readonly source: Validator<T>;
+export declare abstract class ThroughSchema<T> extends Schema<T> implements Sourceable<Schema<T>> {
+    readonly source: Schema<T>;
     constructor({ source, ...options }: ThroughSchemaOptions<T>);
     validate(unsafeValue: unknown): T;
 }

package/util/validate.d.ts

@@ -64,6 +64,3 @@ export declare function validateDictionary<T>(unsafeDictionary: ImmutableDiction
  */
 export declare function validateData<T extends Data>(unsafeData: Data, validators: Validators<T>, partial: true): DeepPartial<T>;
 export declare function validateData<T extends Data>(unsafeData: Data, validators: Validators<T>, partial?: false): T;
-export declare const UNDEFINED: Validator<undefined>;
-export declare const NULL: Validator<null>;
-export declare const UNKNOWN: Validator<unknown>;

package/util/validate.js

@@ -4,10 +4,7 @@ import { isArray } from "./array.js";
 import { getDataKeys, getDataProps } from "./data.js";
 import { getDictionaryItems } from "./dictionary.js";
 import { getNamedMessage } from "./error.js";
-import { PASSTHROUGH } from "./function.js";
 import { isIterable } from "./iterate.js";
-import { getNull } from "./null.js";
-import { getUndefined } from "./undefined.js";
 /** Get value that validates against a given `Validator`, or throw `ValueError` */
 export function getValid(value, validator, ErrorConstructor = ValueError, caller = getValid) {
     try {
@@ -135,9 +132,3 @@ export function validateData(unsafeData, validators, partial = isDeeplyPartial)
         isDeeplyPartial = false;
     }
 }
-// Undefined validator always returns `undefined`
-export const UNDEFINED = { validate: getUndefined };
-// Null validator always returns `null`
-export const NULL = { validate: getNull };
-// Unknown validator always passes through its input value as `unknown`
-export const UNKNOWN = { validate: PASSTHROUGH };