shelving 1.128.3 → 1.129.0

package/iterate/{AbstractGenerator.d.ts → AbstractIterator.d.ts}

@@ -1,8 +1,7 @@
 /** Abstract generator designed to be extended that implements the full generator protocol. */
-export declare abstract class AbstractGenerator<T, R, N> implements Generator<T, R, N> {
-    readonly [Symbol.toStringTag] = "Generator";
+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](): Generator<T, R, N>;
+    [Symbol.iterator](): Iterator<T, R, N>;
 }

package/iterate/{AbstractGenerator.js → AbstractIterator.js}

@@ -1,6 +1,5 @@
 /** Abstract generator designed to be extended that implements the full generator protocol. */
-export class AbstractGenerator {
-    [Symbol.toStringTag] = "Generator";
+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;

package/iterate/{InspectGenerator.d.ts → InspectIterator.d.ts}

@@ -1,15 +1,15 @@
-import { ThroughGenerator } from "./ThroughGenerator.js";
+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 WatchIterator(iterable);
+ * 	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 InspectGenerator<T, R, N> extends ThroughGenerator<T, R, N> {
+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? */

package/iterate/{InspectGenerator.js → InspectIterator.js}

@@ -1,5 +1,5 @@
 import { StateError } from "../error/StateError.js";
-import { ThroughGenerator } from "./ThroughGenerator.js";
+import { ThroughIterator } from "./ThroughIterator.js";
 /** Used when the sequence hasn't inspected anything yet. */
 const _NOVALUE = Symbol("shelving/InspectGenerator.NOVALUE");
 /**
@@ -7,12 +7,12 @@ const _NOVALUE = Symbol("shelving/InspectGenerator.NOVALUE");
  * - Stores: first/last yielded value, returned value, whether iteration is done, the number of items that were iterated.
  *
  * @example
- * 	const watch = new WatchIterator(iterable);
+ * 	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 InspectGenerator extends ThroughGenerator {
+export class InspectIterator extends ThroughIterator {
     /** Get the number of results received by this iterator so far. */
     count = 0;
     /** Is the iteration done? */

package/iterate/{ThroughGenerator.d.ts → ThroughIterator.d.ts}

@@ -1,6 +1,6 @@
-import { AbstractGenerator } from "./AbstractGenerator.js";
+import { AbstractIterator } from "./AbstractIterator.js";
 /** Iterable that pulls values from a source iterable. */
-export declare class ThroughGenerator<T, R, N> extends AbstractGenerator<T, R, N> {
+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>;

package/iterate/{ThroughGenerator.js → ThroughIterator.js}

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

package/iterate/index.d.ts

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

package/iterate/index.js

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

package/package.json

@@ -11,7 +11,7 @@
 		"state-management",
 		"query-builder"
 	],
-	"version": "1.128.3",
+	"version": "1.129.0",
 	"repository": "https://github.com/dhoulb/shelving",
 	"author": "Dave Houlbrooke <dave@shax.com>",
 	"license": "0BSD",
@@ -48,7 +48,7 @@
 		"test:types": "tsc --noEmit",
 		"test:unit": "bun test",
 		"fix": "bun run fix:biome",
-		"fix:biome": "biome check --apply .",
+		"fix:biome": "biome check --write .",
 		"build": "bun run build:setup && bun run build:copy && bun run build:emit && bun run build:test:syntax && bun run build:test:unit",
 		"build:setup": "rm -rf ./dist && mkdir -p ./dist",
 		"build:copy": "cp package.json dist/package.json && cp LICENSE.md dist/LICENSE.md && cp README.md dist/README.md && cp .npmignore dist/.npmignore",
@@ -57,15 +57,15 @@
 		"build:test:unit": "bun test ./dist/**/*.test.js --bail"
 	},
 	"devDependencies": {
-		"@biomejs/biome": "^1.7.3",
-		"@google-cloud/firestore": "^7.7.0",
-		"@types/bun": "^1.1.3",
+		"@biomejs/biome": "^1.8.3",
+		"@google-cloud/firestore": "^7.9.0",
+		"@types/bun": "^1.1.6",
 		"@types/react": "^18.3.3",
 		"@types/react-dom": "^18.3.0",
-		"firebase": "^10.12.2",
+		"firebase": "^10.12.5",
 		"react": "^18.3.1",
 		"react-dom": "^18.3.1",
-		"typescript": "^5.4.5"
+		"typescript": "^5.8.2"
 	},
 	"peerDependencies": {
 		"@google-cloud/firestore": ">=4.0.0",

package/sequence/AbstractSequence.d.ts

@@ -1,8 +1,8 @@
 /** Sequence of values designed to be extended that implements the full async generator protocol. */
-export declare abstract class AbstractSequence<T, R, N> implements AsyncGenerator<T, R, N> {
+export declare abstract class AbstractSequence<T, R, N> implements AsyncIterator<T, R, N>, AsyncIterable<T, R, N> {
     readonly [Symbol.toStringTag] = "Sequence";
     abstract next(value: N): Promise<IteratorResult<T, R>>;
     return(returnValue: R | PromiseLike<R>): Promise<IteratorResult<T, R>>;
     throw(reason: unknown): Promise<IteratorResult<T, R>>;
-    [Symbol.asyncIterator](): AsyncGenerator<T, R>;
+    [Symbol.asyncIterator](): AsyncIterator<T, R, N>;
 }

package/sequence/DeferredSequence.d.ts

@@ -27,5 +27,5 @@ export declare class DeferredSequence<T = void> extends AbstractSequence<T, void
     catch<Y>(onError: (r: unknown) => Y | PromiseLike<Y>): Promise<T | Y>;
     finally(onFinally: () => void): Promise<T>;
     /** Resolve the current deferred from a sequence of values. */
-    through(sequence: AsyncIterable<T>): AsyncIterable<T>;
+    through(sequence: AsyncIterable<T>): AsyncIterator<T>;
 }

package/sequence/InspectSequence.d.ts

@@ -4,12 +4,12 @@ import { ThroughSequence } from "./ThroughSequence.js";
  * - Stores: first/last yielded value, returned value, whether iteration is done, the number of items that were iterated.
  *
  * @example
- * 	const watch = new WatchIterator(iterable);
- * 	for (const next of capture) console.log("YIELDED", next);
+ * 	const watch = new InspectSequence(iterable);
+ * 	for await (const next of capture) console.log("YIELDED", next);
  * 	console.log("FIRST", watch.first);
  * 	console.log("RETURNED", watch.returned);
  */
-export declare class InspectSequence<T, R, N> extends ThroughSequence<T, R, N> {
+export declare class InspectSequence<T, R, N> extends ThroughSequence<T, R, N> implements AsyncIterator<T, R, N>, AsyncIterable<T, R, N> {
     /** Get the number of results received by this iterator so far. */
     readonly count = 0;
     /** Is the iteration done? */

package/sequence/InspectSequence.js

@@ -7,8 +7,8 @@ const _NOVALUE = Symbol("shelving/InspectSequence.NOVALUE");
  * - Stores: first/last yielded value, returned value, whether iteration is done, the number of items that were iterated.
  *
  * @example
- * 	const watch = new WatchIterator(iterable);
- * 	for (const next of capture) console.log("YIELDED", next);
+ * 	const watch = new InspectSequence(iterable);
+ * 	for await (const next of capture) console.log("YIELDED", next);
  * 	console.log("FIRST", watch.first);
  * 	console.log("RETURNED", watch.returned);
  */

package/sequence/LazyDeferredSequence.d.ts

@@ -5,6 +5,6 @@ export declare class LazyDeferredSequence<T = void> extends DeferredSequence<T>
     private _iterating;
     private _starter;
     constructor(start: Start<[DeferredSequence<T>]>);
-    [Symbol.asyncIterator](): AsyncGenerator<T, void, void>;
+    [Symbol.asyncIterator](): AsyncIterator<T, void, void>;
     [Symbol.dispose](): void;
 }

package/sequence/ThroughSequence.d.ts

@@ -1,6 +1,6 @@
 import { AbstractSequence } from "./AbstractSequence.js";
 /** Async iterable that pulls values from a source async iterable. */
-export declare class ThroughSequence<T, R, N> extends AbstractSequence<T, R, N> {
+export declare class ThroughSequence<T, R, N> extends AbstractSequence<T, R, N> implements AsyncIterator<T, R, N>, AsyncIterable<T, R, N> {
     private readonly _source;
     constructor(source: AsyncIterator<T, R, N>);
     next(next: N): Promise<IteratorResult<T, R>>;

package/test/basics.d.ts

@@ -8,10 +8,10 @@ export declare const BASIC_SCHEMA: import("../schema/DataSchema.js").DataSchema<
     odd: boolean;
     even: boolean;
     sub: {
-        str: any;
-        num: any;
-        odd: any;
-        even: any;
+        str: /*elided*/ any;
+        num: /*elided*/ any;
+        odd: /*elided*/ any;
+        even: /*elided*/ any;
     };
 }>;
 export type BasicData = ValidatorType<typeof BASIC_SCHEMA>;

package/test/index.d.ts

@@ -11,16 +11,16 @@ export declare const TEST_COLLECTIONS: {
         odd: boolean;
         even: boolean;
         sub: {
-            str: any;
-            num: any;
-            odd: any;
-            even: any;
+            str: /*elided*/ any;
+            num: /*elided*/ any;
+            odd: /*elided*/ any;
+            even: /*elided*/ any;
         };
     }>;
     people: import("../index.js").DataSchema<{
         name: {
-            first: any;
-            last: any;
+            first: /*elided*/ any;
+            last: /*elided*/ any;
         };
         birthday: string | null;
     }>;

package/test/people.d.ts

@@ -2,8 +2,8 @@ import type { Item } from "../util/item.js";
 import type { ValidatorType } from "../util/validate.js";
 export declare const PERSON_SCHEMA: import("../schema/DataSchema.js").DataSchema<{
     name: {
-        first: any;
-        last: any;
+        first: /*elided*/ any;
+        last: /*elided*/ any;
     };
     birthday: string | null;
 }>;

package/util/object.d.ts

@@ -24,7 +24,7 @@ export declare function isPlainObject(value: unknown): value is ImmutableObject;
 /** Assert that an unknown value is a plain object */
 export declare function assertPlainObject(value: unknown): asserts value is ImmutableObject;
 /** Is an unknown value the key for an own prop of an object. */
-export declare const isProp: <T extends ImmutableObject<PropertyKey, unknown>>(obj: T, key: PropertyKey) => key is keyof T;
+export declare const isProp: <T extends ImmutableObject>(obj: T, key: PropertyKey) => key is keyof T;
 /** Assert that an unknown value is the key for an own prop of an object. */
 export declare function assertProp<T extends ImmutableObject>(obj: T, key: PropertyKey): asserts key is keyof T;
 /** Turn a possible object into an object. */

package/util/units.d.ts

@@ -20,9 +20,9 @@ type UnitProps<T extends string> = {
 };
 /** Represent a unit. */
 export declare class Unit<K extends string> {
+    private readonly _to;
     /** `UnitList` this unit belongs to. */
     readonly list: UnitList<K>;
-    private readonly _to;
     /** String key for this unit, e.g. `kilometer` */
     readonly key: K;
     /** Short abbreviation for this unit, e.g. `km` (defaults to first letter of `id`). */

package/util/units.js

@@ -10,8 +10,9 @@ function _convert(amount, conversion) {
 }
 /** Represent a unit. */
 export class Unit {
-    list;
     _to;
+    /** `UnitList` this unit belongs to. */
+    list;
     /** String key for this unit, e.g. `kilometer` */
     key;
     /** Short abbreviation for this unit, e.g. `km` (defaults to first letter of `id`). */