shelving 1.86.7 → 1.86.8

package/package.json

@@ -11,7 +11,7 @@
 		"state-management",
 		"query-builder"
 	],
-	"version": "1.86.7",
+	"version": "1.86.8",
 	"repository": "https://github.com/dhoulb/shelving",
 	"author": "Dave Houlbrooke <dave@shax.com>",
 	"license": "0BSD",
@@ -71,7 +71,7 @@
 		"@typescript-eslint/eslint-plugin": "^5.49.0",
 		"@typescript-eslint/parser": "^5.49.0",
 		"dpdm": "^3.11.0",
-		"esbuild": "^0.15.18",
+		"esbuild": "^0.17.12",
 		"esbuild-jest": "^0.5.0",
 		"eslint": "^8.33.0",
 		"eslint-config-prettier": "^8.6.0",
@@ -83,7 +83,7 @@
 		"prettier": "^2.8.3",
 		"react": "^18.1.0",
 		"react-dom": "^18.1.0",
-		"typescript": "^4.9.4"
+		"typescript": "^5.0.2"
 	},
 	"peerDependencies": {
 		"@google-cloud/firestore": ">=4.0.0",

package/state/State.js

@@ -10,7 +10,7 @@ import { DeferredSequence } from "../sequence/DeferredSequence.js";
  * - To set the state to be loading, use the `State.NOVALUE` constant or a `Promise` value.
  * - To set the state to an explicit value, use that value or another `State` instance with a value.
  * */
-export class State {
+class State {
     /** Most recently dispatched value (or throw `Promise` that resolves to the next value). */
     get value() {
         if (this._value === State.NOVALUE)
@@ -79,5 +79,6 @@ export class State {
 }
 /** The `NOVALUE` symbol indicates no value has been received by a `State` instance. */
 State.NOVALUE = Symbol("shelving/State.NOVALUE");
+export { State };
 /** Is an unknown value a `State` instance. */
 export const isState = (v) => v instanceof State;

package/util/async.js

@@ -78,7 +78,7 @@ export class Delay extends AbstractPromise {
     }
 }
 /** Resolve to `SIGNAL` on a specific signal. */
-export class Signal extends AbstractPromise {
+class Signal extends AbstractPromise {
     constructor() {
         super(...arguments);
         /** Send this signal now. */
@@ -87,3 +87,4 @@ export class Signal extends AbstractPromise {
 }
 /** The `SIGNAL` symbol indicates a signal. */
 Signal.SIGNAL = SIGNAL;
+export { Signal };

package/util/duration.d.ts

@@ -1,8 +1,8 @@
 import { PossibleDate } from "./date.js";
 /** 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 declare function formatFullDuration(ms: number, precision?: number): string;
+export declare function formatFullDuration(ms: number): string;
 /** Format a description of a duration of time using the most reasonable units e.g. `5y` or `4m` or `12ms`. */
-export declare function formatDuration(ms: number, precision?: number): string;
+export declare function formatDuration(ms: number): string;
 /** Full when a date happens/happened, e.g. `in 10 days` or `2 hours ago` */
 export declare const formatFullWhen: (target: PossibleDate, current?: PossibleDate) => string;
 /** Compact when a date happens/happened, e.g. `in 10d` or `2h ago` or `in 1w` */

package/util/duration.js

@@ -1,35 +1,34 @@
 import { MONTH, WEEK, DAY, HOUR, SECOND } from "./constants.js";
 import { getDuration } from "./date.js";
-import { getMapItem } from "./map.js";
 import { TIME_UNITS } from "./units.js";
-/** Get the ID for a time unit based on the amount in milliseconds. */
-function _getTimeUnitKey(ms) {
+/** Get an appropriate time unit based on an amount in milliseconds. */
+function _getTimeUnit(ms) {
     const abs = Math.abs(ms);
     if (abs > 18 * MONTH)
-        return "year";
+        return TIME_UNITS.unit("year");
     if (abs > 10 * WEEK)
-        return "month";
+        return TIME_UNITS.unit("month");
     if (abs > 2 * WEEK)
-        return "week";
+        return TIME_UNITS.unit("week");
     if (abs > DAY)
-        return "day";
+        return TIME_UNITS.unit("day");
     if (abs > HOUR)
-        return "hour";
+        return TIME_UNITS.unit("hour");
     if (abs > 9949)
-        return "minute";
+        return TIME_UNITS.unit("minute");
     if (abs > SECOND)
-        return "second";
-    return "millisecond";
+        return TIME_UNITS.unit("second");
+    return TIME_UNITS.unit("millisecond");
 }
 /** 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, precision) {
-    const unit = getMapItem(TIME_UNITS, _getTimeUnitKey(ms));
-    return unit.formatFull(unit.from(ms), precision);
+export function formatFullDuration(ms) {
+    const unit = _getTimeUnit(ms);
+    return unit.formatFull(unit.from(ms), 0);
 }
 /** Format a description of a duration of time using the most reasonable units e.g. `5y` or `4m` or `12ms`. */
-export function formatDuration(ms, precision) {
-    const unit = getMapItem(TIME_UNITS, _getTimeUnitKey(ms));
-    return unit.format(unit.from(ms), precision);
+export function formatDuration(ms) {
+    const unit = _getTimeUnit(ms);
+    return unit.format(unit.from(ms), 0);
 }
 /** format when a data happens/happened. */
 function _formatWhen(formatter, target, current) {

package/util/units.d.ts

@@ -6,6 +6,7 @@ type Conversion = number | ((num: number) => number);
 type Conversions<T extends string> = {
     readonly [K in T]?: Conversion;
 };
+/** Get a `Unit` instance from a `UnitList` instance */
 type UnitProps<T extends string> = {
     /** Short abbreviation for this unit, e.g. `km` (defaults to first letter of `id`). */
     readonly abbr?: string;
@@ -58,6 +59,7 @@ export declare class Unit<K extends string> {
 /**
  * Represent a list of units.
  * - Has a known base unit at `.base`
+ * - Can get required units from `.unit()`
  * - Cannot have additional units added after it is created.
  */
 export declare class UnitList<K extends string> extends ImmutableMap<K, Unit<K>> {
@@ -65,6 +67,11 @@ export declare class UnitList<K extends string> extends ImmutableMap<K, Unit<K>>
     constructor(units: ImmutableObject<K, UnitProps<K>>);
     /** Convert an amount from a unit to another unit. */
     convert(amount: number, sourceUnit: K | Unit<K>, targetUnit: K | Unit<K>): number;
+    /**
+     * Get a unit from this list.
+     * @throws RequiredError if the unit is not found.
+     */
+    unit(unit: K | Unit<K>): Unit<K>;
 }
 /** Percentage units. */
 export declare const PERCENTAGE_UNITS: UnitList<"percent">;

package/util/units.js

@@ -1,12 +1,11 @@
 import { ConditionError } from "../error/ConditionError.js";
+import { RequiredError } from "../error/RequiredError.js";
 import { DAY, HOUR, MILLION, MINUTE, MONTH, NNBSP, SECOND, WEEK, YEAR } from "./constants.js";
 import { getProps } from "./object.js";
-import { ImmutableMap, getMapItem } from "./map.js";
+import { ImmutableMap } from "./map.js";
 import { cramQuantity, formatFullQuantity, formatQuantity } from "./number.js";
 /** Convert an amount using a `Conversion. */
 const _convert = (amount, conversion) => (typeof conversion === "function" ? conversion(amount) : conversion === 1 ? amount : amount * conversion);
-/** Get a `Unit` instance from a `UnitList` instance */
-const _getUnit = (list, unit) => (typeof unit === "string" ? getMapItem(list, unit) : unit);
 /** Represent a unit. */
 export class Unit {
     /** Title for this unit (uses format `abbr (plural)`, e.g. `fl oz (US fluid ounces)`) */
@@ -30,11 +29,11 @@ export class Unit {
     }
     /** Convert an amount from this unit to another unit. */
     to(amount, unit = this.list.base) {
-        return this._toUnit(amount, _getUnit(this.list, unit));
+        return this._toUnit(amount, this.list.unit(unit));
     }
     /** Convert an amount from another unit to this unit. */
     from(amount, unit = this.list.base) {
-        return _getUnit(this.list, unit)._toUnit(amount, this);
+        return this.list.unit(unit)._toUnit(amount, this);
     }
     /** Convert an amount from this unit to another unit (must specify another `Unit` instance). */
     _toUnit(amount, unit) {
@@ -74,6 +73,7 @@ export class Unit {
 /**
  * Represent a list of units.
  * - Has a known base unit at `.base`
+ * - Can get required units from `.unit()`
  * - Cannot have additional units added after it is created.
  */
 export class UnitList extends ImmutableMap {
@@ -88,7 +88,18 @@ export class UnitList extends ImmutableMap {
     }
     /** Convert an amount from a unit to another unit. */
     convert(amount, sourceUnit, targetUnit) {
-        return _getUnit(this, sourceUnit).to(amount, targetUnit);
+        return this.unit(sourceUnit).to(amount, targetUnit);
+    }
+    /**
+     * Get a unit from this list.
+     * @throws RequiredError if the unit is not found.
+     */
+    unit(unit) {
+        if (typeof unit !== "string")
+            return unit;
+        if (!this.has(unit))
+            throw new RequiredError(`Unit "${unit}" not found`);
+        return this.get(unit);
     }
 }
 // Distance constants.