shelving 1.83.2 → 1.83.4

package/package.json

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

package/util/entry.d.ts

@@ -20,6 +20,6 @@ export declare function getEntryKeys<K, T>(input: Iterable<Entry<K, T>>): Iterab
 /** Yield the values of an iterable set of entries. */
 export declare function getEntryValues<K, T>(input: Iterable<Entry<K, T>>): Iterable<T>;
 /** Yield the entries in something that can yield entries. */
-export declare function getEntries<K extends number, T = K>(entries: ImmutableArray<T> | ImmutableSet<K & T> | ImmutableObject<K, T> | Iterable<Entry<K, T>>): Iterable<Entry<K, T>>;
-export declare function getEntries<K extends string, T = K>(entries: ImmutableSet<K & T> | ImmutableObject<K, T> | Iterable<Entry<K, T>>): Iterable<Entry<K, T>>;
-export declare function getEntries<K, T = K>(entries: ImmutableArray<K & T> | ImmutableSet<K & T> | ImmutableObject<K & PropertyKey, T> | Iterable<Entry<K, T>>): Iterable<Entry<K, T>>;
+export declare function getEntries<K extends string, T = K>(...input: (ImmutableSet<K & T> | Partial<ImmutableObject<K, T>> | Iterable<Entry<K, T>>)[]): Iterable<Entry<K, T>>;
+export declare function getEntries<K extends number, T = K>(...input: (ImmutableArray<T> | ImmutableSet<K & T> | Iterable<Entry<K, T>>)[]): Iterable<Entry<K, T>>;
+export declare function getEntries<K, T = K>(...input: (ImmutableSet<K & T> | Iterable<Entry<K, T>>)[]): Iterable<Entry<K, T>>;

package/util/entry.js

@@ -15,10 +15,13 @@ export function* getEntryValues(input) {
     for (const [, v] of input)
         yield v;
 }
-export function getEntries(entries) {
-    if (isArray(entries) || isSet(entries))
-        return entries.entries();
-    if (isIterable(entries))
-        return entries;
-    return Object.entries(entries);
+export function* getEntries(...input) {
+    for (const entries of input) {
+        if (isArray(entries) || isSet(entries))
+            yield* entries.entries();
+        else if (isIterable(entries))
+            yield* entries;
+        else
+            yield* Object.entries(entries);
+    }
 }

package/util/units.d.ts

@@ -8,11 +8,11 @@ declare type Conversions<T extends string> = {
     readonly [K in T]?: Conversion;
 };
 declare type UnitProps<T extends string> = {
-    /** Short abbreviation for this unit, e.g. `km` (defaults to first letter of `ref`). */
+    /** Short abbreviation for this unit, e.g. `km` (defaults to first letter of `id`). */
     readonly abbr?: string;
-    /** Singular name for this unit, e.g. `kilometer` (defaults to `ref` + "s"). */
+    /** Singular name for this unit, e.g. `kilometer` (defaults to `id` + "s"). */
     readonly singular?: string;
-    /** Plural name for this unit, e.g. `kilometers` (defaults to `ref`). */
+    /** Plural name for this unit, e.g. `kilometers` (defaults to `id`). */
     readonly plural?: string;
     /** Conversions to other units (typically needs at least the base conversion, unless it's already the base unit). */
     readonly to?: Conversions<T>;
@@ -22,11 +22,11 @@ export declare class Unit<T extends string> {
     /** `UnitList` this unit belongs to. */
     readonly list: UnitList<T>;
     private readonly _to;
-    /** Reference for this unit, e.g. `kilometer` */
-    readonly ref: T;
-    /** Short abbreviation for this unit, e.g. `km` (defaults to first letter of `ref`). */
+    /** Identifier for this unit, e.g. `kilometer` */
+    readonly id: T;
+    /** Short abbreviation for this unit, e.g. `km` (defaults to first letter of `id`). */
     readonly abbr: string;
-    /** Singular name for this unit, e.g. `kilometer` (defaults to `ref`). */
+    /** Singular name for this unit, e.g. `kilometer` (defaults to `id`). */
     readonly singular: string;
     /** Plural name for this unit, e.g. `kilometers` (defaults to `singular` + "s"). */
     readonly plural: string;
@@ -35,16 +35,14 @@ export declare class Unit<T extends string> {
     constructor(
     /** `UnitList` this unit belongs to. */
     list: UnitList<T>, 
-    /** Reference for this unit. */
-    ref: T, 
+    /** Key for this unit, e.g. `kilometer` */
+    id: T, 
     /** Props to configure this unit. */
     { abbr, singular, plural, to }: UnitProps<T>);
     /** Convert an amount from this unit to another unit. */
-    to(amount: number, ref?: T | Unit<T>): number;
+    to(amount: number, id?: T | Unit<T>): number;
     /** Convert an amount from another unit to this unit. */
-    from(amount: number, ref?: T | Unit<T>): number;
-    /** Get a unit from a unit or unit reference. */
-    private _unit;
+    from(amount: number, id?: T | Unit<T>): number;
     /** Convert an amount from this unit to another unit (must specify another `Unit` instance). */
     private _toUnit;
     /** Format a number with a given unit of measure, e.g. `12 kg` or `29.5 l` */
@@ -59,33 +57,34 @@ export declare class UnitList<T extends string> extends ImmutableRequiredMap<T,
 }
 /** Percentage units. */
 export declare const PERCENTAGE_UNITS: UnitList<"percent">;
-export declare type PercentageUnit = MapKey<typeof PERCENTAGE_UNITS>;
+export declare type PercentageUnitIdentifier = MapKey<typeof PERCENTAGE_UNITS>;
 /** Point units. */
 export declare const POINT_UNITS: UnitList<"basis-point" | "percentage-point">;
-export declare type PointUnit = MapKey<typeof POINT_UNITS>;
+export declare type PointUnitIdentifier = MapKey<typeof POINT_UNITS>;
 /** Angle units. */
 export declare const ANGLE_UNITS: UnitList<"degree" | "radian" | "gradian">;
-export declare type AngleUnit = MapKey<typeof ANGLE_UNITS>;
+export declare type AngleUnitIdentifier = MapKey<typeof ANGLE_UNITS>;
 /** Mass units. */
 export declare const MASS_UNITS: UnitList<"milligram" | "gram" | "kilogram" | "ounce" | "pound" | "stone">;
-export declare type MassUnit = MapKey<typeof MASS_UNITS>;
+export declare type MassUnitIdentifier = MapKey<typeof MASS_UNITS>;
 /** Time units. */
 export declare const TIME_UNITS: UnitList<"millisecond" | "second" | "minute" | "hour" | "day" | "week" | "month" | "year">;
-export declare type TimeUnit = MapKey<typeof TIME_UNITS>;
+export declare type TimeUnitIdentifier = MapKey<typeof TIME_UNITS>;
 /** Length units. */
 export declare const LENGTH_UNITS: UnitList<"millimeter" | "centimeter" | "meter" | "kilometer" | "inch" | "foot" | "yard" | "furlong" | "mile">;
-export declare type LengthUnit = MapKey<typeof LENGTH_UNITS>;
+export declare type LengthUnitIdentifier = MapKey<typeof LENGTH_UNITS>;
 /** Speed units. */
 export declare const SPEED_UNITS: UnitList<"meter-per-second" | "kilometer-per-hour" | "mile-per-hour">;
-export declare type SpeedUnit = MapKey<typeof SPEED_UNITS>;
+export declare type SpeedUnitIdentifier = MapKey<typeof SPEED_UNITS>;
 /** Area units. */
 export declare const AREA_UNITS: UnitList<"square-millimeter" | "square-centimeter" | "square-meter" | "square-kilometer" | "hectare" | "square-inch" | "square-foot" | "square-yard" | "acre">;
+export declare type AreaUnitIdentifier = MapKey<typeof AREA_UNITS>;
 /** Volume units. */
 export declare const VOLUME_UNITS: UnitList<"milliliter" | "liter" | "cubic-centimeter" | "cubic-meter" | "us-fluid-ounce" | "us-pint" | "us-quart" | "us-gallon" | "imperial-fluid-ounce" | "imperial-pint" | "imperial-quart" | "imperial-gallon" | "cubic-inch" | "cubic-foot" | "cubic-yard">;
-export declare type VolumeUnit = MapKey<typeof VOLUME_UNITS>;
+export declare type VolumeUnitIdentifier = MapKey<typeof VOLUME_UNITS>;
 /** Temperature units. */
 export declare const TEMPERATURE_UNITS: UnitList<"celsius" | "fahrenheit" | "kelvin">;
-export declare type TemperatureUnit = MapKey<typeof TEMPERATURE_UNITS>;
+export declare type TemperatureUnitIdentifier = MapKey<typeof TEMPERATURE_UNITS>;
 /** Format a percentage (combines `getPercent()` and `formatUnits()` for convenience). */
 export declare const formatPercent: (numerator: number, denumerator: number, maxPrecision?: number, minPrecision?: number) => string;
 /** Format a full format of a duration of time using the most reasonable units e.g. `5 years` or `1 week` or `4 minutes` or `12 milliseconds`. */

package/util/units.js

@@ -11,12 +11,12 @@ export class Unit {
     constructor(
     /** `UnitList` this unit belongs to. */
     list, 
-    /** Reference for this unit. */
-    ref, 
+    /** Key for this unit, e.g. `kilometer` */
+    id, 
     /** Props to configure this unit. */
-    { abbr = ref.slice(0, 1), singular = ref.replace(/-/, " "), plural = `${singular}s`, to }) {
+    { abbr = id.slice(0, 1), singular = id.replace(/-/, " "), plural = `${singular}s`, to }) {
         this.list = list;
-        this.ref = ref;
+        this.id = id;
         this.abbr = abbr;
         this.singular = singular;
         this.plural = plural;
@@ -27,16 +27,12 @@ export class Unit {
         return `${this.abbr} (${this.plural})`;
     }
     /** Convert an amount from this unit to another unit. */
-    to(amount, ref = this.list.base) {
-        return this._toUnit(amount, this._unit(ref));
+    to(amount, id = this.list.base) {
+        return this._toUnit(amount, _getUnit(this.list, id));
     }
     /** Convert an amount from another unit to this unit. */
-    from(amount, ref = this.list.base) {
-        return this._unit(ref)._toUnit(amount, this);
-    }
-    /** Get a unit from a unit or unit reference. */
-    _unit(ref) {
-        return typeof ref === "string" ? this.list.get(ref) : ref;
+    from(amount, id = this.list.base) {
+        return _getUnit(this.list, id)._toUnit(amount, this);
     }
     /** Convert an amount from this unit to another unit (must specify another `Unit` instance). */
     _toUnit(amount, unit) {
@@ -45,20 +41,20 @@ export class Unit {
         if (unit === this)
             return amount;
         // Exact conversion.
-        const thisToUnit = (_a = this._to) === null || _a === void 0 ? void 0 : _a[unit.ref];
+        const thisToUnit = (_a = this._to) === null || _a === void 0 ? void 0 : _a[unit.id];
         if (thisToUnit)
             return _convert(amount, thisToUnit);
         // Invert number conversion (can't do this for function conversions).
-        const unitToThis = (_b = unit._to) === null || _b === void 0 ? void 0 : _b[this.ref];
+        const unitToThis = (_b = unit._to) === null || _b === void 0 ? void 0 : _b[this.id];
         if (typeof unitToThis === "number")
             return amount / unitToThis;
         // Two step conversion via base.
         const base = this.list.base;
-        const thisToBase = (_c = this._to) === null || _c === void 0 ? void 0 : _c[base.ref];
+        const thisToBase = (_c = this._to) === null || _c === void 0 ? void 0 : _c[base.id];
         if (thisToBase)
             return base._toUnit(_convert(amount, thisToBase), unit);
         // Cannot convert.
-        throw new ConditionError(`Cannot convert "${this.ref}" to "${unit.ref}"`);
+        throw new ConditionError(`Cannot convert "${this.id}" to "${unit.id}"`);
     }
     /** Format a number with a given unit of measure, e.g. `12 kg` or `29.5 l` */
     format(amount, maxPrecision, minPrecision) {
@@ -69,15 +65,16 @@ export class Unit {
         return formatFullQuantity(amount, this.singular, this.plural, maxPrecision, minPrecision);
     }
 }
+const _getUnit = (list, id) => (typeof id === "string" ? list.get(id) : id);
 /** Represent a list of units. */
 export class UnitList extends ImmutableRequiredMap {
     constructor(units) {
         super();
-        for (const [ref, props] of getProps(units)) {
-            const unit = new Unit(this, ref, props);
+        for (const [id, props] of getProps(units)) {
+            const unit = new Unit(this, id, props);
             if (!this.base)
                 this.base = unit;
-            Map.prototype.set.call(this, ref, unit);
+            Map.prototype.set.call(this, id, unit);
         }
     }
 }
@@ -210,8 +207,8 @@ export const TEMPERATURE_UNITS = new UnitList({
 });
 /** Format a percentage (combines `getPercent()` and `formatUnits()` for convenience). */
 export const formatPercent = (numerator, denumerator, maxPrecision, minPrecision) => formatQuantity(getPercent(numerator, denumerator), "%", maxPrecision, minPrecision);
-/** Format a duration with a formatter. */
-function _getTimeUnitReference(ms) {
+/** Get the ID for a time unit based on the amount in milliseconds. */
+function _getTimeUnitIdentifier(ms) {
     const abs = Math.abs(ms);
     if (abs > 18 * MONTH)
         return "year";
@@ -231,12 +228,12 @@ function _getTimeUnitReference(ms) {
 }
 /** Format a full format of a duration of time using the most reasonable units e.g. `5 years` or `1 week` or `4 minutes` or `12 milliseconds`. */
 export function formatFullDuration(ms, maxPrecision, minPrecision) {
-    const unit = TIME_UNITS.get(_getTimeUnitReference(ms));
+    const unit = TIME_UNITS.get(_getTimeUnitIdentifier(ms));
     return unit.formatFull(unit.from(ms), maxPrecision, minPrecision);
 }
 /** Format a description of a duration of time using the most reasonable units e.g. `5y` or `4m` or `12ms`. */
 export function formatDuration(ms, maxPrecision, minPrecision) {
-    const unit = TIME_UNITS.get(_getTimeUnitReference(ms));
+    const unit = TIME_UNITS.get(_getTimeUnitIdentifier(ms));
     return unit.format(unit.from(ms), maxPrecision, minPrecision);
 }
 /** format when a data happens/happened. */