shelving 1.158.1 → 1.158.2

package/package.json

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

package/schema/ArraySchema.d.ts

@@ -3,6 +3,8 @@ import type { SchemaOptions } from "./Schema.js";
 import { Schema } from "./Schema.js";
 /** Allowed options for `ArraySchema` */
 export interface ArraySchemaOptions<T> extends SchemaOptions {
+    readonly one?: string;
+    readonly many?: string;
     readonly value?: ImmutableArray;
     readonly items: Schema<T>;
     readonly min?: number;
@@ -38,11 +40,13 @@ export interface ArraySchemaOptions<T> extends SchemaOptions {
  */
 export declare class ArraySchema<T> extends Schema<ImmutableArray<T>> {
     readonly value: ImmutableArray;
+    readonly one: string;
+    readonly many: string;
     readonly items: Schema<T>;
     readonly unique: boolean;
     readonly min: number;
     readonly max: number;
-    constructor({ items, unique, min, max, title, value, ...options }: ArraySchemaOptions<T>);
+    constructor({ items, one, many, unique, min, max, title, value, ...options }: ArraySchemaOptions<T>);
     validate(unsafeValue?: unknown): ImmutableArray<T>;
 }
 /** Valid array with specifed items. */

package/schema/ArraySchema.js

@@ -30,12 +30,16 @@ import { Schema } from "./Schema.js";
  *  schema.validate(["a", null], schema); // Throws Invalids({ "1": Invalid('Must be a string') });
  */
 export class ArraySchema extends Schema {
+    one;
+    many;
     items;
     unique;
     min;
     max;
-    constructor({ items, unique = false, min = 0, max = Number.POSITIVE_INFINITY, title = "Items", value = [], ...options }) {
+    constructor({ items, one = "item", many = `${one}s`, unique = false, min = 0, max = Number.POSITIVE_INFINITY, title = "Items", value = [], ...options }) {
         super({ title, value, ...options });
+        this.one = one;
+        this.many = many;
         this.items = items;
         this.unique = unique;
         this.min = min;

package/schema/DictionarySchema.d.ts

@@ -3,6 +3,8 @@ import type { SchemaOptions } from "./Schema.js";
 import { Schema } from "./Schema.js";
 /** Allowed options for `DictionarySchema` */
 export interface DictionarySchemaOptions<T> extends SchemaOptions {
+    readonly one?: string;
+    readonly many?: string;
     readonly items: Schema<T>;
     readonly value?: ImmutableDictionary | undefined;
     readonly min?: number | undefined;
@@ -11,10 +13,12 @@ export interface DictionarySchemaOptions<T> extends SchemaOptions {
 /** Validate a dictionary object (whose props are all the same with string keys). */
 export declare class DictionarySchema<T> extends Schema<ImmutableDictionary<T>> {
     readonly value: ImmutableDictionary;
+    readonly one: string;
+    readonly many: string;
     readonly items: Schema<T>;
     readonly min: number;
     readonly max: number;
-    constructor({ items, min, max, title, value, ...options }: DictionarySchemaOptions<T>);
+    constructor({ items, one, many, min, max, title, value, ...options }: DictionarySchemaOptions<T>);
     validate(unsafeValue?: unknown): ImmutableDictionary<T>;
 }
 /** Valid dictionary object with specifed items. */

package/schema/DictionarySchema.js

@@ -4,11 +4,15 @@ import { validateDictionary } from "../util/validate.js";
 import { Schema } from "./Schema.js";
 /** Validate a dictionary object (whose props are all the same with string keys). */
 export class DictionarySchema extends Schema {
+    one;
+    many;
     items;
     min;
     max;
-    constructor({ items, min = 0, max = Number.POSITIVE_INFINITY, title = "Items", value = {}, ...options }) {
+    constructor({ items, one = "item", many = "items", min = 0, max = Number.POSITIVE_INFINITY, title = "Items", value = {}, ...options }) {
         super({ title, value, ...options });
+        this.one = one;
+        this.many = many;
         this.items = items;
         this.min = min;
         this.max = max;

package/util/format.d.ts

@@ -9,7 +9,7 @@ export declare function formatQuantity(num: number, suffix: string, options?: In
 /** Format a number (based on the user's browser language settings). */
 export declare function formatNumber(num: number, options?: Intl.NumberFormatOptions): string;
 /** Format a number with a longer full-word suffix. */
-export declare function pluralizeQuantity(num: number, singular: string, plural: string, options?: Intl.NumberFormatOptions): string;
+export declare function pluralizeQuantity(num: number, one: string, many: string, options?: Intl.NumberFormatOptions): string;
 /**
  * Format a percentage (combines `getPercent()` and `formatQuantity()` for convenience).
  * - Defaults to showing no decimal places.

package/util/format.js

@@ -22,12 +22,12 @@ export function formatNumber(num, options) {
     return new Intl.NumberFormat(undefined, options).format(num).replace(/ /, NNBSP);
 }
 /** Format a number with a longer full-word suffix. */
-export function pluralizeQuantity(num, singular, plural, options) {
+export function pluralizeQuantity(num, one, many, options) {
     const qty = formatNumber(num, {
         ...options,
         style: "decimal",
     });
-    return `${qty}${NNBSP}${num === 1 ? singular : plural}`;
+    return `${qty}${NNBSP}${num === 1 ? one : many}`;
 }
 /**
  * Format a percentage (combines `getPercent()` and `formatQuantity()` for convenience).

package/util/units.d.ts

@@ -10,9 +10,9 @@ type UnitProps<T extends string> = {
     /** 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 `id` + "s"). */
-    readonly singular?: string;
+    readonly one?: string;
     /** Plural name for this unit, e.g. `kilometers` (defaults to `id`). */
-    readonly plural?: string;
+    readonly many?: string;
     /** Conversions to other units (typically needs at least the base conversion, unless it's already the base unit). */
     readonly to?: Conversions<T>;
     /** Possible options for formatting these units with `Intl.NumberFormat` (`.unit` can be specified if different from key, but is not required). */
@@ -28,9 +28,9 @@ export declare class Unit<K extends string> {
     /** 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 `id`). */
-    readonly singular: string;
+    readonly one: string;
     /** Plural name for this unit, e.g. `kilometers` (defaults to `singular` + "s"). */
-    readonly plural: string;
+    readonly many: string;
     /** Possible options for formatting these units with `Intl.NumberFormat` (`.unit` can be specified if different from key, but is not required). */
     readonly options: Readonly<Intl.NumberFormatOptions> | undefined;
     /** Title for this unit (uses format `abbr (plural)`, e.g. `fl oz (US fluid ounces)`) */
@@ -41,7 +41,7 @@ export declare class Unit<K extends string> {
     /** String key for this unit, e.g. `kilometer` */
     key: K, 
     /** Props to configure this unit. */
-    { abbr, singular, plural, options, to }: UnitProps<K>);
+    { abbr, one, many, options, to }: UnitProps<K>);
     /** Convert an amount from this unit to another unit. */
     to(amount: number, targetKey?: K): number;
     /** Convert an amount from another unit to this unit. */

package/util/units.js

@@ -18,14 +18,14 @@ export class Unit {
     /** Short abbreviation for this unit, e.g. `km` (defaults to first letter of `id`). */
     abbr;
     /** Singular name for this unit, e.g. `kilometer` (defaults to `id`). */
-    singular;
+    one;
     /** Plural name for this unit, e.g. `kilometers` (defaults to `singular` + "s"). */
-    plural;
+    many;
     /** Possible options for formatting these units with `Intl.NumberFormat` (`.unit` can be specified if different from key, but is not required). */
     options;
     /** Title for this unit (uses format `abbr (plural)`, e.g. `fl oz (US fluid ounces)`) */
     get title() {
-        return `${this.abbr} (${this.plural})`;
+        return `${this.abbr} (${this.many})`;
     }
     constructor(
     /** `UnitList` this unit belongs to. */
@@ -33,12 +33,12 @@ export class Unit {
     /** String key for this unit, e.g. `kilometer` */
     key, 
     /** Props to configure this unit. */
-    { abbr = key.slice(0, 1), singular = key.replace(/-/, " "), plural = `${singular}s`, options, to }) {
+    { abbr = key.slice(0, 1), one = key.replace(/-/, " "), many = `${one}s`, options, to }) {
         this.list = list;
         this.key = key;
         this.abbr = abbr;
-        this.singular = singular;
-        this.plural = plural;
+        this.one = one;
+        this.many = many;
         this.options = options;
         this._to = to;
     }
@@ -89,7 +89,7 @@ export class Unit {
         // Otherwise, use the default number format.
         // If unitDisplay is "long" use the singular/plural form.
         const o = { style: "decimal", unitDisplay: "short", ...this.options, ...options };
-        return o.unitDisplay === "long" ? pluralizeQuantity(amount, this.singular, this.plural, o) : formatQuantity(amount, this.abbr, o);
+        return o.unitDisplay === "long" ? pluralizeQuantity(amount, this.one, this.many, o) : formatQuantity(amount, this.abbr, o);
     }
 }
 /**
@@ -155,7 +155,7 @@ const US_IN3_PER_GAL = 231;
 const IMP_ML_PER_GAL = 4546090 / 1000;
 /** Percentage units. */
 export const PERCENT_UNITS = new UnitList({
-    percent: { abbr: "%", plural: "percent" },
+    percent: { abbr: "%", many: "percent" },
 });
 /** Point units. */
 export const POINT_UNITS = new UnitList({
@@ -177,7 +177,7 @@ export const MASS_UNITS = new UnitList({
     // Imperial.
     ounce: { abbr: "oz", to: { milligram: MG_PER_LB / OZ_PER_LB } },
     pound: { abbr: "lb", to: { milligram: MG_PER_LB, ounce: OZ_PER_LB } },
-    stone: { abbr: "st", plural: "stone", to: { milligram: MG_PER_LB * LB_PER_ST, pound: LB_PER_ST, ounce: OZ_PER_LB * LB_PER_ST } },
+    stone: { abbr: "st", many: "stone", to: { milligram: MG_PER_LB * LB_PER_ST, pound: LB_PER_ST, ounce: OZ_PER_LB * LB_PER_ST } },
 });
 const TIME_OPTIONS = {
     roundingMode: "trunc",
@@ -202,8 +202,8 @@ export const LENGTH_UNITS = new UnitList({
     meter: { to: { millimeter: MM_PER_M } },
     kilometer: { abbr: "km", to: { millimeter: MM_PER_KM } },
     // Imperial.
-    inch: { abbr: "in", plural: "inches", to: { millimeter: MM_PER_IN } },
-    foot: { abbr: "ft", plural: "feet", to: { millimeter: IN_PER_FT * MM_PER_IN, inch: IN_PER_FT } },
+    inch: { abbr: "in", many: "inches", to: { millimeter: MM_PER_IN } },
+    foot: { abbr: "ft", many: "feet", to: { millimeter: IN_PER_FT * MM_PER_IN, inch: IN_PER_FT } },
     yard: { abbr: "yd", to: { millimeter: IN_PER_YD * MM_PER_IN, inch: IN_PER_YD, foot: FT_PER_YD } },
     furlong: { abbr: "fur", to: { millimeter: IN_PER_YD * MM_PER_IN * YD_PER_FUR, foot: YD_PER_FUR * FT_PER_YD, yard: YD_PER_FUR } },
     mile: { abbr: "mi", to: { millimeter: MM_PER_MI, yard: YD_PER_MI, foot: FT_PER_MI, inch: IN_PER_MI } },
@@ -211,15 +211,15 @@ export const LENGTH_UNITS = new UnitList({
 /** Speed units. */
 export const SPEED_UNITS = new UnitList({
     // Metric.
-    "meter-per-second": { abbr: "m/s", singular: "meter per second", plural: "meters per second", to: { "kilometer-per-hour": 3.6 } },
+    "meter-per-second": { abbr: "m/s", one: "meter per second", many: "meters per second", to: { "kilometer-per-hour": 3.6 } },
     "kilometer-per-hour": {
         abbr: "kph",
-        singular: "kilometer per hour",
-        plural: "kilometers per hour",
+        one: "kilometer per hour",
+        many: "kilometers per hour",
         to: { "meter-per-second": MM_PER_KM / HOUR },
     },
     // Imperial.
-    "mile-per-hour": { abbr: "mph", singular: "mile per hour", plural: "miles per hour", to: { "meter-per-second": MM_PER_MI / HOUR } },
+    "mile-per-hour": { abbr: "mph", one: "mile per hour", many: "miles per hour", to: { "meter-per-second": MM_PER_MI / HOUR } },
 });
 /** Area units. */
 export const AREA_UNITS = new UnitList({
@@ -230,10 +230,10 @@ export const AREA_UNITS = new UnitList({
     "square-kilometer": { abbr: "km²", to: { "square-millimeter": MM_PER_KM ** 2 } },
     hectare: { abbr: "ha", to: { "square-millimeter": (MM_PER_M * 100) ** 2 } },
     // Imperial.
-    "square-inch": { abbr: "in²", plural: "square inches", to: { "square-millimeter": MM2_PER_IN2 } },
+    "square-inch": { abbr: "in²", many: "square inches", to: { "square-millimeter": MM2_PER_IN2 } },
     "square-foot": {
         abbr: "ft²",
-        plural: "square feet",
+        many: "square feet",
         to: { "square-millimeter": IN_PER_FT ** 2 * MM2_PER_IN2, "square-inch": IN_PER_FT ** 2 },
     },
     "square-yard": {
@@ -255,19 +255,19 @@ export const VOLUME_UNITS = new UnitList({
     // US.
     "us-fluid-ounce": {
         abbr: `fl${NNBSP}oz`,
-        singular: "US fluid ounce",
-        plural: "US fluid ounces",
+        one: "US fluid ounce",
+        many: "US fluid ounces",
         to: { milliliter: (US_IN3_PER_GAL * ML_PER_IN3) / 128 },
     },
-    "us-pint": { abbr: "pt", singular: "US pint", to: { milliliter: (US_IN3_PER_GAL * ML_PER_IN3) / 8, "us-fluid-ounce": 16 } },
+    "us-pint": { abbr: "pt", one: "US pint", to: { milliliter: (US_IN3_PER_GAL * ML_PER_IN3) / 8, "us-fluid-ounce": 16 } },
     "us-quart": {
         abbr: "qt",
-        singular: "US quart",
+        one: "US quart",
         to: { milliliter: (US_IN3_PER_GAL * ML_PER_IN3) / 4, "us-pint": 2, "us-fluid-ounce": 32 },
     },
     "us-gallon": {
         abbr: "gal",
-        singular: "US gallon",
+        one: "US gallon",
         to: { milliliter: US_IN3_PER_GAL * ML_PER_IN3, "us-quart": 4, "us-pint": 8, "us-fluid-ounce": 128 },
     },
     // Imperial.
@@ -278,8 +278,8 @@ export const VOLUME_UNITS = new UnitList({
         abbr: "gal",
         to: { milliliter: IMP_ML_PER_GAL, "imperial-quart": 4, "imperial-pint": 8, "imperial-fluid-ounce": 160 },
     },
-    "cubic-inch": { abbr: "in³", plural: "cubic inches", to: { milliliter: ML_PER_IN3 } },
-    "cubic-foot": { abbr: "ft³", plural: "cubic feet", to: { milliliter: IN_PER_FT ** 3 * ML_PER_IN3, "cubic-inch": IN_PER_FT ** 3 } },
+    "cubic-inch": { abbr: "in³", many: "cubic inches", to: { milliliter: ML_PER_IN3 } },
+    "cubic-foot": { abbr: "ft³", many: "cubic feet", to: { milliliter: IN_PER_FT ** 3 * ML_PER_IN3, "cubic-inch": IN_PER_FT ** 3 } },
     "cubic-yard": {
         abbr: "yd³",
         to: { milliliter: IN_PER_YD ** 3 * ML_PER_IN3, "cubic-foot": FT_PER_YD ** 3, "cubic-inch": IN_PER_YD ** 3 },
@@ -289,10 +289,10 @@ export const VOLUME_UNITS = new UnitList({
 export const TEMPERATURE_UNITS = new UnitList({
     celsius: {
         abbr: "°C",
-        singular: "degree Celsius",
-        plural: "degrees Celsius",
+        one: "degree Celsius",
+        many: "degrees Celsius",
         to: { fahrenheit: n => n * (9 / 5) + 32, kelvin: n => n + 273.15 },
     },
-    fahrenheit: { abbr: "°F", singular: "degree Fahrenheit", plural: "degrees Fahrenheit", to: { celsius: n => (n - 32) * (5 / 9) } },
-    kelvin: { abbr: "°K", singular: "degree Kelvin", plural: "degrees Kelvin", to: { celsius: n => n - 273.15 } },
+    fahrenheit: { abbr: "°F", one: "degree Fahrenheit", many: "degrees Fahrenheit", to: { celsius: n => (n - 32) * (5 / 9) } },
+    kelvin: { abbr: "°K", one: "degree Kelvin", many: "degrees Kelvin", to: { celsius: n => n - 273.15 } },
 });