shelving 1.157.2 → 1.157.3

package/package.json

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

package/schema/DataSchema.js

@@ -1,6 +1,6 @@
 import { ValueFeedback } from "../feedback/Feedback.js";
 import { isData } from "../util/data.js";
-import { mapObject } from "../util/transform.js";
+import { mapProps } from "../util/transform.js";
 import { validateData } from "../util/validate.js";
 import { NULLABLE } from "./NullableSchema.js";
 import { OPTIONAL } from "./OptionalSchema.js";
@@ -22,13 +22,15 @@ export class DataSchema extends Schema {
 export const DATA = (props) => new DataSchema({ props });
 /** Valid data object with specifed properties, or `null` */
 export const NULLABLE_DATA = (props) => NULLABLE(new DataSchema({ props }));
-/** Create a `DataSchema` that validates partially, i.e. properties can be their value, or `undefined` */
 export function PARTIAL(source) {
     const props = source instanceof DataSchema ? source.props : source;
     return new DataSchema({
-        props: mapObject(props, OPTIONAL),
+        props: mapProps(props, _optionalProp),
     });
 }
+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;

package/schema/NullableSchema.d.ts

@@ -1,4 +1,4 @@
-import type { Schema } from "./Schema.js";
+import type { Validator } from "../index.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: Schema<T>) => NullableSchema<T>;
+export declare const NULLABLE: <T>(source: Validator<T>) => NullableSchema<T>;

package/schema/OptionalSchema.d.ts

@@ -1,4 +1,4 @@
-import type { Schema } from "./Schema.js";
+import type { Validator } from "../util/validate.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: Schema<T>) => OptionalSchema<T>;
+export declare const OPTIONAL: <T>(source: Validator<T>) => OptionalSchema<T>;

package/util/hydrate.js

@@ -5,7 +5,7 @@ import { isMap } from "./map.js";
 import { getProps, getPrototype, isObject, isPlainObject } from "./object.js";
 import { isSet } from "./set.js";
 import { isString } from "./string.js";
-import { mapArray, mapObject } from "./transform.js";
+import { mapArray, mapProps } from "./transform.js";
 /** Is an unknown value a dehydrated object with a `$type` key. */
 function _isDehydrated(value) {
     return isString(value.$type);
@@ -22,7 +22,7 @@ export function hydrate(value, hydrations) {
         return mapArray(value, hydrate, hydrations);
     if (isPlainObject(value)) {
         if (!_isDehydrated(value))
-            return mapObject(value, hydrate, hydrations);
+            return mapProps(value, _hydrateProp, hydrations);
         const { $type, $value } = value;
         if ($type === "Map")
             return new Map($value);
@@ -33,11 +33,14 @@ export function hydrate(value, hydrations) {
         // Complex object, check the hydrations list.
         const hydration = hydrations[$type];
         if (hydration)
-            return { __proto__: hydration.prototype, ...mapObject($value, hydrate, hydrations) };
+            return { __proto__: hydration.prototype, ...mapProps($value, _hydrateProp, hydrations) };
         throw new ValueError(`Cannot hydrate object "${$type}"`, { type: $type, received: $value, caller: hydrate });
     }
     return value;
 }
+function _hydrateProp([, v], hydrations) {
+    return hydrate(v, hydrations);
+}
 /**
  * Deeply dehydrate a class instance based on a set of `Hydrations`
  * - Dehydration allows you to pass class instances from a server back to a client.
@@ -59,13 +62,16 @@ export function dehydrate(value, hydrations) {
         if (isDate(value))
             return { $type: "Date", $value: value.getTime() };
         if (isPlainObject(value))
-            return mapObject(value, dehydrate, hydrations);
+            return mapProps(value, _dehydrateProp, hydrations);
         // Complex object, check the hydrations list.
         const proto = getPrototype(value);
         for (const [$type, hydration] of getProps(hydrations))
             if (proto === hydration.prototype)
-                return { $type, $value: mapObject(value, dehydrate, hydrations) };
+                return { $type, $value: mapProps(value, _dehydrateProp, hydrations) };
         throw new ValueError("Cannot dehydrate object", { received: value, caller: dehydrate });
     }
     return value;
 }
+function _dehydrateProp([, v], hydrations) {
+    return dehydrate(v, hydrations);
+}

package/util/transform.d.ts

@@ -1,32 +1,22 @@
-import type { ArrayItem, ImmutableArray } from "./array.js";
-import type { ImmutableDictionary } from "./dictionary.js";
+import type { ImmutableArray } from "./array.js";
+import type { DictionaryItem, ImmutableDictionary } from "./dictionary.js";
 import type { Entry } from "./entry.js";
 import type { Arguments } from "./function.js";
-import type { ImmutableObject, Value } from "./object.js";
-/** Function that can transform an input value into an output value. */
-export type Transform<I, O, A extends Arguments = []> = (input: I, ...args: A) => O;
-/** Function that can transform an input value into an output value. */
-export type AsyncTransform<I, O, A extends Arguments = []> = (input: I, ...args: A) => O | PromiseLike<O>;
+import type { ImmutableObject, Prop, Value } from "./object.js";
 /** Set of named transforms for a data object (or `undefined` to skip the transform). */
 export type Transforms<I extends ImmutableObject, O extends ImmutableObject, A extends Arguments = []> = {
-    readonly [K in keyof I]?: Transform<I[K], O[K], A>;
+    readonly [K in keyof I]?: (input: I[K], ...args: A) => O[K];
 };
 /** Modify a set of items using a transform. */
 export declare function mapItems<I, O, A extends Arguments = []>(items: Iterable<I>, transform: (v: I, ...args: A) => O, ...args: A): Iterable<O>;
-export declare function mapItems<I, O, A extends Arguments = []>(items: Iterable<I>, transform: Transform<I, O, A>, ...args: A): Iterable<O>;
 /** Modify the items of an array using a transform. */
-export declare function mapArray<T extends ImmutableArray>(arr: T, transform: Transform<ArrayItem<T>, ArrayItem<T>>): T;
 export declare function mapArray<I, O, A extends Arguments = []>(arr: Iterable<I>, transform: (v: I, ...args: A) => O, ...args: A): ImmutableArray<O>;
-export declare function mapArray<I, O, A extends Arguments = []>(arr: Iterable<I>, transform: Transform<I, O, A>, ...args: A): ImmutableArray<O>;
-/** Modify the values of the props of an object using a transform. */
-export declare function mapObject<T extends ImmutableObject>(obj: T, transform: Transform<Value<T>, Value<T>>): T;
-export declare function mapObject<I extends ImmutableObject, O extends ImmutableObject, A extends Arguments = []>(obj: I, transform: (v: Value<I>, ...args: A) => Value<O>, ...args: A): O;
-export declare function mapObject<I extends ImmutableObject, O extends ImmutableObject, A extends Arguments = []>(obj: I, transform: Transform<Value<I>, Value<O>, A>, ...args: A): O;
-/** Modify the values of a dictionary using a transform. */
-export declare function mapDictionary<I, O, A extends Arguments = []>(dictionary: ImmutableDictionary<I>, transform: (v: I, ...args: A) => O, ...args: A): ImmutableDictionary<O>;
-export declare function mapDictionary<I, O, A extends Arguments = []>(dictionary: ImmutableDictionary<I>, transform: Transform<I, O, A>, ...args: A): ImmutableDictionary<O>;
-/** Modify the values of a set of entries using a transform. */
-export declare function mapEntries<K, I, O, A extends Arguments = []>(entries: Iterable<Entry<K, I>>, transform: Transform<I, O, A>, ...args: A): Iterable<Entry<K, O>>;
+/** Modify the _values_ of the props of an object using a transform. */
+export declare function mapProps<I extends ImmutableObject, O extends ImmutableObject, A extends Arguments = []>(obj: I, transform: (prop: Prop<I>, ...args: A) => Value<O>, ...args: A): O;
+/** Modify the _values_ of a dictionary using a transform. */
+export declare function mapDictionary<I, O, A extends Arguments = []>(dictionary: ImmutableDictionary<I>, transform: (item: DictionaryItem<I>, ...args: A) => O, ...args: A): ImmutableDictionary<O>;
+/** Modify the _values_ of a set of entries using a transform. */
+export declare function mapEntries<K, I, O, A extends Arguments = []>(entries: Iterable<Entry<K, I>>, transform: (entry: Entry<K, I>, ...args: A) => O, ...args: A): Iterable<Entry<K, O>>;
 /**
  * Transform an object using a set of named transforms.
  *
@@ -38,4 +28,3 @@ export declare function transformObject<I extends ImmutableObject, O extends Imm
 export declare function transformObject<I extends ImmutableObject, O extends ImmutableObject, A extends Arguments = []>(obj: I | Partial<I>, transforms: Transforms<I, O | Partial<O>, A>, ...args: A): Partial<O>;
 /** Transform items in a sequence as they are yielded using a (potentially async) transform. */
 export declare function mapSequence<I, O, A extends Arguments = []>(sequence: AsyncIterable<I>, transform: (input: I, ...args: A) => O | PromiseLike<O>, ...args: A): AsyncIterable<O>;
-export declare function mapSequence<I, O, A extends Arguments = []>(sequence: AsyncIterable<I>, transform: AsyncTransform<I, O, A>, ...args: A): AsyncIterable<O>;

package/util/transform.js

@@ -1,22 +1,26 @@
 import { getDictionaryItems } from "./dictionary.js";
 import { getProps } from "./object.js";
+/** Modify a set of items using a transform. */
 export function* mapItems(items, transform, ...args) {
     for (const item of items)
         yield transform(item, ...args);
 }
+/** Modify the items of an array using a transform. */
 export function mapArray(arr, transform, ...args) {
     return Array.from(mapItems(arr, transform, ...args));
 }
-export function mapObject(obj, transform, ...args) {
+/** Modify the _values_ of the props of an object using a transform. */
+export function mapProps(obj, transform, ...args) {
     return Object.fromEntries(mapEntries(getProps(obj), transform, ...args));
 }
+/** Modify the _values_ of a dictionary using a transform. */
 export function mapDictionary(dictionary, transform, ...args) {
     return Object.fromEntries(mapEntries(getDictionaryItems(dictionary), transform, ...args));
 }
-/** Modify the values of a set of entries using a transform. */
+/** Modify the _values_ of a set of entries using a transform. */
 export function* mapEntries(entries, transform, ...args) {
-    for (const [k, v] of entries)
-        yield [k, transform(v, ...args)];
+    for (const e of entries)
+        yield [e[0], transform(e, ...args)];
 }
 export function transformObject(input, transforms, ...args) {
     let changed = false;
@@ -37,6 +41,7 @@ export function transformObject(input, transforms, ...args) {
     }
     return changed ? output : input;
 }
+/** Transform items in a sequence as they are yielded using a (potentially async) transform. */
 export async function* mapSequence(sequence, transform, ...args) {
     for await (const item of sequence)
         yield transform(item, ...args);