shelving 1.156.0 → 1.157.1

package/index.d.ts

@@ -7,7 +7,6 @@ export * from "./api/index.js";
 export * from "./db/index.js";
 export * from "./error/index.js";
 export * from "./feedback/index.js";
-export * from "./iterate/index.js";
 export * from "./markup/index.js";
 export * from "./schema/index.js";
 export * from "./sequence/index.js";

package/index.js

@@ -10,7 +10,6 @@ export * from "./feedback/index.js";
 // export * from "./firestore/client/index.js"; // Not exported.
 // export * from "./firestore/lite/index.js"; // Not exported.
 // export * from "./firestore/server/index.js"; // Not exported.
-export * from "./iterate/index.js";
 export * from "./markup/index.js";
 // export * from "./react/index.js"; // Not exported.
 export * from "./schema/index.js";

package/package.json

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

package/schema/ChoiceSchema.d.ts

@@ -1,8 +1,16 @@
+import { type ImmutableArray } from "../util/array.js";
 import type { SchemaOptions } from "./Schema.js";
 import { Schema } from "./Schema.js";
-export type ChoiceOptions<K extends string> = {
+export type ChoiceOptions<K extends string> = ImmutableArray<K> | {
     readonly [KK in K]: unknown;
 };
+export type ChoiceOption<K extends string> = readonly [K, unknown];
+/** Get the options for a choice field as an array. */
+export declare function getChoiceEntries<K extends string>(options: ChoiceOptions<K>): ImmutableArray<ChoiceOption<K>>;
+/** Get the keys for a choice field as an array. */
+export declare function getChoiceKeys<K extends string>(options: ChoiceOptions<K>): ImmutableArray<K>;
+/** Get the options for a choice field as an array. */
+export declare function isOption<K extends string>(options: ChoiceOptions<K>, option: string): option is K;
 /** Allowed options for `ChoiceSchema` */
 export interface ChoiceSchemaOptions<K extends string> extends Omit<SchemaOptions, "value"> {
     /** Specify correct options using a dictionary of entries. */
@@ -11,11 +19,14 @@ export interface ChoiceSchemaOptions<K extends string> extends Omit<SchemaOption
     value?: K;
 }
 /** Choose from an allowed set of values. */
-export declare class ChoiceSchema<K extends string> extends Schema<K> {
-    readonly value: string;
+export declare class ChoiceSchema<K extends string> extends Schema<K> implements Iterable<ChoiceOption<K>> {
+    readonly value: K;
     readonly options: ChoiceOptions<K>;
     constructor({ options, value, ...rest }: ChoiceSchemaOptions<K>);
     validate(unsafeValue?: unknown): K;
+    [Symbol.iterator](): Iterator<ChoiceOption<K>>;
+    keys(): ImmutableArray<K>;
+    entries(): ImmutableArray<ChoiceOption<K>>;
 }
 /** Choose from an allowed set of values. */
 export declare function CHOICE<K extends string>(options: ChoiceOptions<K>): ChoiceSchema<K>;

package/schema/ChoiceSchema.js

@@ -1,19 +1,46 @@
 import { ValueFeedback } from "../feedback/Feedback.js";
-import { requireFirst } from "../util/array.js";
-import { getKeys, isProp } from "../util/object.js";
+import { isArray, requireFirst } from "../util/array.js";
+import { getKeys, getProps, isProp } from "../util/object.js";
 import { Schema } from "./Schema.js";
+/** Get the options for a choice field as an array. */
+export function getChoiceEntries(options) {
+    return isArray(options) ? options.map(_makeKeyEntry) : getProps(options);
+}
+function _makeKeyEntry(k) {
+    return [k, k];
+}
+/** Get the keys for a choice field as an array. */
+export function getChoiceKeys(options) {
+    return isArray(options) ? options : getKeys(options);
+}
+/** Get the options for a choice field as an array. */
+export function isOption(options, option) {
+    return isArray(options) ? options.includes(option) : isProp(options, option);
+}
 /** Choose from an allowed set of values. */
 export class ChoiceSchema extends Schema {
     options;
-    constructor({ options, value = requireFirst(getKeys(options)), ...rest }) {
+    constructor({ options, value = requireFirst(isArray(options) ? options : getKeys(options)), ...rest }) {
         super({ value, ...rest });
         this.options = options;
     }
     validate(unsafeValue = this.value) {
-        if (typeof unsafeValue === "string" && isProp(this.options, unsafeValue))
+        if (typeof unsafeValue === "string" && isOption(this.options, unsafeValue))
             return unsafeValue;
         throw new ValueFeedback("Unknown value", unsafeValue);
     }
+    // Implement iterable.
+    *[Symbol.iterator]() {
+        yield* getChoiceEntries(this.options);
+    }
+    // Get the current list of keys for this choice.
+    keys() {
+        return getChoiceKeys(this.options);
+    }
+    // Get the current list of entries for this choice.
+    entries() {
+        return getChoiceEntries(this.options);
+    }
 }
 /** Choose from an allowed set of values. */
 export function CHOICE(options) {

package/schema/StringSchema.d.ts

@@ -43,10 +43,7 @@ export declare class StringSchema extends Schema<string> {
 /** Valid string, e.g. `Hello there!` */
 export declare const STRING: StringSchema;
 /** Valid string, `Hello there!`, with more than one character. */
-export declare const REQUIRED_STRING: StringSchema; /** Valid text, e.g. `Hello there!` */
-export declare const TEXT: StringSchema;
-/** Valid text, `Hello there!`, with more than one character. */
-export declare const REQUIRED_TEXT: StringSchema;
+export declare const REQUIRED_STRING: StringSchema;
 /** Title string, e.g. `Title of something` */
 export declare const TITLE: StringSchema;
 /** Optional name string, e.g. `Title of something` or `null` */

package/schema/StringSchema.js

@@ -59,10 +59,7 @@ export class StringSchema extends Schema {
 /** Valid string, e.g. `Hello there!` */
 export const STRING = new StringSchema({});
 /** Valid string, `Hello there!`, with more than one character. */
-export const REQUIRED_STRING = new StringSchema({ min: 1 }); /** Valid text, e.g. `Hello there!` */
-export const TEXT = new StringSchema({ title: "Text" });
-/** Valid text, `Hello there!`, with more than one character. */
-export const REQUIRED_TEXT = new StringSchema({ min: 1 });
+export const REQUIRED_STRING = new StringSchema({ min: 1 });
 /** Title string, e.g. `Title of something` */
 export const TITLE = new StringSchema({ title: "Title", min: 1, max: 100 });
 /** Optional name string, e.g. `Title of something` or `null` */

package/iterate/AbstractIterator.d.ts

@@ -1,7 +0,0 @@
-/** Abstract generator designed to be extended that implements the full generator protocol. */
-export declare abstract class AbstractIterator<T, R, N> implements Iterator<T, R, N>, Iterable<T, R, N> {
-    abstract next(value: N): IteratorResult<T, R>;
-    throw(thrown: unknown): IteratorResult<T, R>;
-    return(value: R): IteratorResult<T, R>;
-    [Symbol.iterator](): Iterator<T, R, N>;
-}

package/iterate/AbstractIterator.js

@@ -1,15 +0,0 @@
-/** Abstract generator designed to be extended that implements the full generator protocol. */
-export class AbstractIterator {
-    throw(thrown) {
-        // Default behaviour for a generator is to throw the error back out of the iterator and not continue.
-        throw thrown;
-    }
-    return(value) {
-        // Default behaviour for a generator is to return `done: true` and the input value.
-        return { done: true, value };
-    }
-    // Implement `Iterable`
-    [Symbol.iterator]() {
-        return this;
-    }
-}

package/iterate/InspectIterator.d.ts

@@ -1,31 +0,0 @@
-import { ThroughIterator } from "./ThroughIterator.js";
-/**
- * Iterable that inspects a source iterable as it iterates.
- * - Stores: first/last yielded value, returned value, whether iteration is done, the number of items that were iterated.
- *
- * @example
- * 	const watch = new InspectIterator(iterable);
- * 	for (const next of capture) console.log("YIELDED", next);
- * 	console.log("FIRST", watch.first);
- * 	console.log("RETURNED", watch.returned);
- */
-export declare class InspectIterator<T, R, N> extends ThroughIterator<T, R, N> implements Iterator<T, R, N>, Iterable<T, R, N> {
-    /** Get the number of results received by this iterator so far. */
-    readonly count = 0;
-    /** Is the iteration done? */
-    readonly done: boolean;
-    /** The first yielded value (throws if the iteration yielded no values, i.e. `this.count === 0`). */
-    get first(): T;
-    private _first;
-    /** The last yielded value (throws if the iteration yielded no values, i.e. `this.count === 0`). */
-    get last(): T;
-    private _last;
-    /** The returned value (throws if the iteration is not done, i.e. `this.done === false`). */
-    get returned(): R;
-    private _returned;
-    next(value: N): IteratorResult<T, R>;
-    throw(thrown: unknown): IteratorResult<T, R>;
-    return(value: R): IteratorResult<T, R>;
-    /** Capture a result. */
-    private _inspect;
-}

package/iterate/InspectIterator.js

@@ -1,75 +0,0 @@
-import { UnexpectedError } from "../error/UnexpectedError.js";
-import { getGetter } from "../util/class.js";
-import { ThroughIterator } from "./ThroughIterator.js";
-/** Used when the sequence hasn't inspected anything yet. */
-const _NOVALUE = Symbol("shelving/InspectGenerator.NOVALUE");
-/**
- * Iterable that inspects a source iterable as it iterates.
- * - Stores: first/last yielded value, returned value, whether iteration is done, the number of items that were iterated.
- *
- * @example
- * 	const watch = new InspectIterator(iterable);
- * 	for (const next of capture) console.log("YIELDED", next);
- * 	console.log("FIRST", watch.first);
- * 	console.log("RETURNED", watch.returned);
- */
-export class InspectIterator extends ThroughIterator {
-    /** Get the number of results received by this iterator so far. */
-    count = 0;
-    /** Is the iteration done? */
-    done = false;
-    /** The first yielded value (throws if the iteration yielded no values, i.e. `this.count === 0`). */
-    get first() {
-        if (this._first === _NOVALUE)
-            throw new UnexpectedError("Iteration not started", {
-                iterator: this,
-                caller: getGetter(this, "first"),
-            });
-        return this._first;
-    }
-    _first = _NOVALUE;
-    /** The last yielded value (throws if the iteration yielded no values, i.e. `this.count === 0`). */
-    get last() {
-        if (this._last === _NOVALUE)
-            throw new UnexpectedError("Iteration not started", {
-                iterator: this,
-                caller: getGetter(this, "last"),
-            });
-        return this._last;
-    }
-    _last = _NOVALUE;
-    /** The returned value (throws if the iteration is not done, i.e. `this.done === false`). */
-    get returned() {
-        if (this._returned === _NOVALUE)
-            throw new UnexpectedError("Iteration not done", {
-                iterator: this,
-                caller: getGetter(this, "returned"),
-            });
-        return this._returned;
-    }
-    _returned = _NOVALUE;
-    // Override to watch returned values.
-    next(value) {
-        return this._inspect(this.next(value));
-    }
-    throw(thrown) {
-        return this._inspect(this.throw(thrown));
-    }
-    return(value) {
-        return this._inspect(this.return(value));
-    }
-    /** Capture a result. */
-    _inspect(result) {
-        if (!result.done) {
-            if (this.first === undefined)
-                this._first = result.value;
-            this._last = result.value;
-            this.count++;
-        }
-        else {
-            this._returned = result.value;
-            this.done = true;
-        }
-        return result;
-    }
-}

package/iterate/ThroughIterator.d.ts

@@ -1,9 +0,0 @@
-import { AbstractIterator } from "./AbstractIterator.js";
-/** Iterable that pulls values from a source iterable. */
-export declare class ThroughIterator<T, R, N> extends AbstractIterator<T, R, N> implements Iterator<T, R, N>, Iterable<T, R, N> {
-    private readonly _source;
-    constructor(iterator: Iterator<T, R, N>);
-    next(value: N): IteratorResult<T, R>;
-    throw(thrown: unknown): IteratorResult<T, R>;
-    return(value: R): IteratorResult<T, R>;
-}

package/iterate/ThroughIterator.js

@@ -1,19 +0,0 @@
-import { AbstractIterator } from "./AbstractIterator.js";
-/** Iterable that pulls values from a source iterable. */
-export class ThroughIterator extends AbstractIterator {
-    _source;
-    constructor(iterator) {
-        super();
-        this._source = iterator;
-    }
-    // Implement `AbstractIterator`
-    next(value) {
-        return this._source.next(value);
-    }
-    throw(thrown) {
-        return this._source.throw ? this._source.throw(thrown) : super.throw(thrown);
-    }
-    return(value) {
-        return this._source.return ? this._source.return(value) : super.return(value);
-    }
-}

package/iterate/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./AbstractIterator.js";
-export * from "./ThroughIterator.js";
-export * from "./InspectIterator.js";

package/iterate/index.js

@@ -1,3 +0,0 @@
-export * from "./AbstractIterator.js";
-export * from "./ThroughIterator.js";
-export * from "./InspectIterator.js";