@budiauktioner/buildi-primitives 0.1.1 → 0.2.0

package/dist/cjs/measurement/voltage.js

@@ -0,0 +1,159 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var voltage_exports = {};
+__export(voltage_exports, {
+  Voltage: () => Voltage,
+  maskVoltage: () => maskVoltage
+});
+module.exports = __toCommonJS(voltage_exports);
+var import_decimal = require("../internal/decimal.js");
+var import_quantity = require("../internal/quantity.js");
+var import_text_candidate = require("../text-scanning/text-candidate.js");
+var import_text_candidate_category = require("../text-scanning/text-candidate-category.js");
+var import_text_match_confidence = require("../text-scanning/text-match-confidence.js");
+var import_voltage_unit = require("./voltage-unit.js");
+const SCAN_PATTERN = new RegExp(
+  String.raw`(?<!\w)(?:[+-]\s*)?\d+[0-9 .,]*\s*(?:µV|uV|mV|kV|MV|V)\b`,
+  "giu"
+);
+class Voltage extends import_quantity.Quantity {
+  static typeInfo = Object.freeze({
+    englishName: "Voltage",
+    localizedName: "Sp\xE4nning",
+    emoji: "\u{1F50C}",
+    sources: Object.freeze([
+      "https://www.bipm.org/en/measurement-units/si-derived-units",
+      "https://en.wikipedia.org/wiki/Volt"
+    ])
+  });
+  get units() {
+    return import_voltage_unit.VoltageUnit.index;
+  }
+  withBaseValue(baseValue, unit) {
+    return new Voltage(baseValue, unit);
+  }
+  get microvolts() {
+    return this.in(import_voltage_unit.VoltageUnit.Microvolt);
+  }
+  get millivolts() {
+    return this.in(import_voltage_unit.VoltageUnit.Millivolt);
+  }
+  get volts() {
+    return this.in(import_voltage_unit.VoltageUnit.Volt);
+  }
+  get kilovolts() {
+    return this.in(import_voltage_unit.VoltageUnit.Kilovolt);
+  }
+  get megavolts() {
+    return this.in(import_voltage_unit.VoltageUnit.Megavolt);
+  }
+  /** Creates a voltage from a value and unit. */
+  static create(value, unit) {
+    import_voltage_unit.VoltageUnit.index.assertOwns(unit);
+    const amount = value instanceof import_decimal.Decimal ? value : Voltage.decimalOf(value);
+    return new Voltage(unit.toBase(amount), unit);
+  }
+  static fromMicrovolts(value) {
+    return Voltage.create(value, import_voltage_unit.VoltageUnit.Microvolt);
+  }
+  static fromMillivolts(value) {
+    return Voltage.create(value, import_voltage_unit.VoltageUnit.Millivolt);
+  }
+  static fromVolts(value) {
+    return Voltage.create(value, import_voltage_unit.VoltageUnit.Volt);
+  }
+  static fromKilovolts(value) {
+    return Voltage.create(value, import_voltage_unit.VoltageUnit.Kilovolt);
+  }
+  static fromMegavolts(value) {
+    return Voltage.create(value, import_voltage_unit.VoltageUnit.Megavolt);
+  }
+  static tryParse(input) {
+    const parsed = (0, import_quantity.tryParseQuantity)(input, import_voltage_unit.VoltageUnit.index, import_voltage_unit.VoltageUnit.tryParse);
+    return parsed === null ? null : new Voltage(parsed.baseValue, parsed.unit);
+  }
+  static parse(input) {
+    const result = Voltage.tryParse(input);
+    if (result === null) throw new Error("Invalid voltage.");
+    return result;
+  }
+  static isValid(input) {
+    return Voltage.tryParse(input) !== null;
+  }
+  /** Display form in the parsed unit, or `null` when the input is invalid. */
+  static format(input, options) {
+    const parsed = Voltage.tryParse(input);
+    if (parsed !== null) {
+      if (options?.unit !== void 0 || options?.decimals !== void 0) {
+        return parsed.toStringInUnit(options.unit ?? parsed.originalUnit, options.decimals);
+      }
+      return parsed.toString();
+    }
+    return Voltage.fallback(input, options);
+  }
+  /** The value in volts, or `null` when the input is invalid. */
+  static normalize(input, options) {
+    const parsed = Voltage.tryParse(input);
+    if (parsed !== null) return parsed.toNormalizedString();
+    return Voltage.fallback(input, options);
+  }
+  static isNormalized(input) {
+    return input != null && Voltage.normalize(input) === input;
+  }
+  static findCandidatesInText(text) {
+    if (!text) return [];
+    const out = [];
+    const pattern = new RegExp(SCAN_PATTERN.source, SCAN_PATTERN.flags);
+    let match;
+    while ((match = pattern.exec(text)) !== null) {
+      const value = Voltage.tryParse(match[0]);
+      if (value === null) continue;
+      out.push(
+        new import_text_candidate.TextCandidate({
+          startIndex: match.index,
+          length: match[0].length,
+          originalText: match[0],
+          typeName: "Voltage",
+          category: import_text_candidate_category.TextCandidateCategory.Measurement,
+          normalizedForm: value.toNormalizedString(),
+          formattedForm: value.toString(),
+          maskedForm: maskVoltage(value),
+          confidence: import_text_match_confidence.TextMatchConfidence.Medium,
+          value
+        })
+      );
+    }
+    return out;
+  }
+  static fallback(input, options) {
+    if (options?.fallbackToTrimmedInputWhenInvalid !== true) return null;
+    if (input == null) return null;
+    const trimmed = input.trim();
+    return trimmed.length > 0 ? trimmed : null;
+  }
+  static decimalOf(value) {
+    const parsed = import_decimal.Decimal.fromNumber(value);
+    if (parsed === null) throw new Error(`Value cannot be represented as a voltage: ${value}`);
+    return parsed;
+  }
+}
+function maskVoltage(value) {
+  return `*** ${value.originalUnit.symbol}`;
+}
+//# sourceMappingURL=voltage.js.map

package/dist/cjs/measurement/voltage.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/measurement/voltage.ts"],
+  "sourcesContent": ["import { Decimal } from \"../internal/decimal.js\";\nimport type { MeasurementUnitIndex } from \"../internal/measurement-unit.js\";\nimport { Quantity, tryParseQuantity } from \"../internal/quantity.js\";\nimport type { PrimitiveTypeInfo } from \"../primitive-type-info.js\";\nimport { TextCandidate } from \"../text-scanning/text-candidate.js\";\nimport { TextCandidateCategory } from \"../text-scanning/text-candidate-category.js\";\nimport { TextMatchConfidence } from \"../text-scanning/text-match-confidence.js\";\nimport { VoltageUnit } from \"./voltage-unit.js\";\n\n/** Options for {@link Voltage.format} and {@link Voltage.normalize}. */\nexport interface VoltageFormatOptions {\n  fallbackToTrimmedInputWhenInvalid?: boolean;\n  /** Convert to this unit instead of preserving the parsed one. */\n  unit?: VoltageUnit;\n  /** Round to this many fractional digits, away from zero. */\n  decimals?: number;\n}\n\nconst SCAN_PATTERN = new RegExp(\n  String.raw`(?<!\\w)(?:[+-]\\s*)?\\d+[0-9 .,]*\\s*(?:\u00B5V|uV|mV|kV|MV|V)\\b`,\n  \"giu\",\n);\n\n/**\n * A voltage stored internally in volts,\n * parsed from any supported unit and convertible between all of them.\n */\nexport class Voltage extends Quantity<VoltageUnit> {\n  static readonly typeInfo: PrimitiveTypeInfo = Object.freeze({\n    englishName: \"Voltage\",\n    localizedName: \"Sp\u00E4nning\",\n    emoji: \"\uD83D\uDD0C\",\n    sources: Object.freeze([\n      \"https://www.bipm.org/en/measurement-units/si-derived-units\",\n      \"https://en.wikipedia.org/wiki/Volt\",\n    ]),\n  });\n\n  protected get units(): MeasurementUnitIndex<VoltageUnit> {\n    return VoltageUnit.index;\n  }\n\n  protected withBaseValue(baseValue: Decimal, unit: VoltageUnit): this {\n    return new Voltage(baseValue, unit) as this;\n  }\n\n  get microvolts(): number {\n    return this.in(VoltageUnit.Microvolt);\n  }\n  get millivolts(): number {\n    return this.in(VoltageUnit.Millivolt);\n  }\n  get volts(): number {\n    return this.in(VoltageUnit.Volt);\n  }\n  get kilovolts(): number {\n    return this.in(VoltageUnit.Kilovolt);\n  }\n  get megavolts(): number {\n    return this.in(VoltageUnit.Megavolt);\n  }\n\n  /** Creates a voltage from a value and unit. */\n  static create(value: number | Decimal, unit: VoltageUnit): Voltage {\n    VoltageUnit.index.assertOwns(unit);\n    const amount = value instanceof Decimal ? value : Voltage.decimalOf(value);\n    return new Voltage(unit.toBase(amount), unit);\n  }\n\n  static fromMicrovolts(value: number | Decimal): Voltage {\n    return Voltage.create(value, VoltageUnit.Microvolt);\n  }\n  static fromMillivolts(value: number | Decimal): Voltage {\n    return Voltage.create(value, VoltageUnit.Millivolt);\n  }\n  static fromVolts(value: number | Decimal): Voltage {\n    return Voltage.create(value, VoltageUnit.Volt);\n  }\n  static fromKilovolts(value: number | Decimal): Voltage {\n    return Voltage.create(value, VoltageUnit.Kilovolt);\n  }\n  static fromMegavolts(value: number | Decimal): Voltage {\n    return Voltage.create(value, VoltageUnit.Megavolt);\n  }\n\n  static tryParse(input: string | null | undefined): Voltage | null {\n    const parsed = tryParseQuantity(input, VoltageUnit.index, VoltageUnit.tryParse);\n    return parsed === null ? null : new Voltage(parsed.baseValue, parsed.unit);\n  }\n\n  static parse(input: string): Voltage {\n    const result = Voltage.tryParse(input);\n    if (result === null) throw new Error(\"Invalid voltage.\");\n    return result;\n  }\n\n  static isValid(input: string | null | undefined): boolean {\n    return Voltage.tryParse(input) !== null;\n  }\n\n  /** Display form in the parsed unit, or `null` when the input is invalid. */\n  static format(input: string | null | undefined, options?: VoltageFormatOptions): string | null {\n    const parsed = Voltage.tryParse(input);\n    if (parsed !== null) {\n      if (options?.unit !== undefined || options?.decimals !== undefined) {\n        return parsed.toStringInUnit(options.unit ?? parsed.originalUnit, options.decimals);\n      }\n      return parsed.toString();\n    }\n    return Voltage.fallback(input, options);\n  }\n\n  /** The value in volts, or `null` when the input is invalid. */\n  static normalize(\n    input: string | null | undefined,\n    options?: VoltageFormatOptions,\n  ): string | null {\n    const parsed = Voltage.tryParse(input);\n    if (parsed !== null) return parsed.toNormalizedString();\n    return Voltage.fallback(input, options);\n  }\n\n  static isNormalized(input: string | null | undefined): boolean {\n    return input != null && Voltage.normalize(input) === input;\n  }\n\n  static findCandidatesInText(text: string): readonly TextCandidate<Voltage>[] {\n    if (!text) return [];\n\n    const out: TextCandidate<Voltage>[] = [];\n    const pattern = new RegExp(SCAN_PATTERN.source, SCAN_PATTERN.flags);\n    let match: RegExpExecArray | null;\n\n    while ((match = pattern.exec(text)) !== null) {\n      const value = Voltage.tryParse(match[0]);\n      if (value === null) continue;\n      out.push(\n        new TextCandidate<Voltage>({\n          startIndex: match.index,\n          length: match[0].length,\n          originalText: match[0],\n          typeName: \"Voltage\",\n          category: TextCandidateCategory.Measurement,\n          normalizedForm: value.toNormalizedString(),\n          formattedForm: value.toString(),\n          maskedForm: maskVoltage(value),\n          confidence: TextMatchConfidence.Medium,\n          value,\n        }),\n      );\n    }\n\n    return out;\n  }\n\n  private static fallback(\n    input: string | null | undefined,\n    options?: VoltageFormatOptions,\n  ): string | null {\n    if (options?.fallbackToTrimmedInputWhenInvalid !== true) return null;\n    if (input == null) return null;\n    const trimmed = input.trim();\n    return trimmed.length > 0 ? trimmed : null;\n  }\n\n  private static decimalOf(value: number): Decimal {\n    const parsed = Decimal.fromNumber(value);\n    if (parsed === null) throw new Error(`Value cannot be represented as a voltage: ${value}`);\n    return parsed;\n  }\n}\n\n/** Returns a masked voltage, e.g. `10 V` becomes `*** V`. */\nexport function maskVoltage(value: Voltage): string {\n  return `*** ${value.originalUnit.symbol}`;\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,qBAAwB;AAExB,sBAA2C;AAE3C,4BAA8B;AAC9B,qCAAsC;AACtC,mCAAoC;AACpC,0BAA4B;AAW5B,MAAM,eAAe,IAAI;AAAA,EACvB,OAAO;AAAA,EACP;AACF;AAMO,MAAM,gBAAgB,yBAAsB;AAAA,EACjD,OAAgB,WAA8B,OAAO,OAAO;AAAA,IAC1D,aAAa;AAAA,IACb,eAAe;AAAA,IACf,OAAO;AAAA,IACP,SAAS,OAAO,OAAO;AAAA,MACrB;AAAA,MACA;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AAAA,EAED,IAAc,QAA2C;AACvD,WAAO,gCAAY;AAAA,EACrB;AAAA,EAEU,cAAc,WAAoB,MAAyB;AACnE,WAAO,IAAI,QAAQ,WAAW,IAAI;AAAA,EACpC;AAAA,EAEA,IAAI,aAAqB;AACvB,WAAO,KAAK,GAAG,gCAAY,SAAS;AAAA,EACtC;AAAA,EACA,IAAI,aAAqB;AACvB,WAAO,KAAK,GAAG,gCAAY,SAAS;AAAA,EACtC;AAAA,EACA,IAAI,QAAgB;AAClB,WAAO,KAAK,GAAG,gCAAY,IAAI;AAAA,EACjC;AAAA,EACA,IAAI,YAAoB;AACtB,WAAO,KAAK,GAAG,gCAAY,QAAQ;AAAA,EACrC;AAAA,EACA,IAAI,YAAoB;AACtB,WAAO,KAAK,GAAG,gCAAY,QAAQ;AAAA,EACrC;AAAA;AAAA,EAGA,OAAO,OAAO,OAAyB,MAA4B;AACjE,oCAAY,MAAM,WAAW,IAAI;AACjC,UAAM,SAAS,iBAAiB,yBAAU,QAAQ,QAAQ,UAAU,KAAK;AACzE,WAAO,IAAI,QAAQ,KAAK,OAAO,MAAM,GAAG,IAAI;AAAA,EAC9C;AAAA,EAEA,OAAO,eAAe,OAAkC;AACtD,WAAO,QAAQ,OAAO,OAAO,gCAAY,SAAS;AAAA,EACpD;AAAA,EACA,OAAO,eAAe,OAAkC;AACtD,WAAO,QAAQ,OAAO,OAAO,gCAAY,SAAS;AAAA,EACpD;AAAA,EACA,OAAO,UAAU,OAAkC;AACjD,WAAO,QAAQ,OAAO,OAAO,gCAAY,IAAI;AAAA,EAC/C;AAAA,EACA,OAAO,cAAc,OAAkC;AACrD,WAAO,QAAQ,OAAO,OAAO,gCAAY,QAAQ;AAAA,EACnD;AAAA,EACA,OAAO,cAAc,OAAkC;AACrD,WAAO,QAAQ,OAAO,OAAO,gCAAY,QAAQ;AAAA,EACnD;AAAA,EAEA,OAAO,SAAS,OAAkD;AAChE,UAAM,aAAS,kCAAiB,OAAO,gCAAY,OAAO,gCAAY,QAAQ;AAC9E,WAAO,WAAW,OAAO,OAAO,IAAI,QAAQ,OAAO,WAAW,OAAO,IAAI;AAAA,EAC3E;AAAA,EAEA,OAAO,MAAM,OAAwB;AACnC,UAAM,SAAS,QAAQ,SAAS,KAAK;AACrC,QAAI,WAAW,KAAM,OAAM,IAAI,MAAM,kBAAkB;AACvD,WAAO;AAAA,EACT;AAAA,EAEA,OAAO,QAAQ,OAA2C;AACxD,WAAO,QAAQ,SAAS,KAAK,MAAM;AAAA,EACrC;AAAA;AAAA,EAGA,OAAO,OAAO,OAAkC,SAA+C;AAC7F,UAAM,SAAS,QAAQ,SAAS,KAAK;AACrC,QAAI,WAAW,MAAM;AACnB,UAAI,SAAS,SAAS,UAAa,SAAS,aAAa,QAAW;AAClE,eAAO,OAAO,eAAe,QAAQ,QAAQ,OAAO,cAAc,QAAQ,QAAQ;AAAA,MACpF;AACA,aAAO,OAAO,SAAS;AAAA,IACzB;AACA,WAAO,QAAQ,SAAS,OAAO,OAAO;AAAA,EACxC;AAAA;AAAA,EAGA,OAAO,UACL,OACA,SACe;AACf,UAAM,SAAS,QAAQ,SAAS,KAAK;AACrC,QAAI,WAAW,KAAM,QAAO,OAAO,mBAAmB;AACtD,WAAO,QAAQ,SAAS,OAAO,OAAO;AAAA,EACxC;AAAA,EAEA,OAAO,aAAa,OAA2C;AAC7D,WAAO,SAAS,QAAQ,QAAQ,UAAU,KAAK,MAAM;AAAA,EACvD;AAAA,EAEA,OAAO,qBAAqB,MAAiD;AAC3E,QAAI,CAAC,KAAM,QAAO,CAAC;AAEnB,UAAM,MAAgC,CAAC;AACvC,UAAM,UAAU,IAAI,OAAO,aAAa,QAAQ,aAAa,KAAK;AAClE,QAAI;AAEJ,YAAQ,QAAQ,QAAQ,KAAK,IAAI,OAAO,MAAM;AAC5C,YAAM,QAAQ,QAAQ,SAAS,MAAM,CAAC,CAAC;AACvC,UAAI,UAAU,KAAM;AACpB,UAAI;AAAA,QACF,IAAI,oCAAuB;AAAA,UACzB,YAAY,MAAM;AAAA,UAClB,QAAQ,MAAM,CAAC,EAAE;AAAA,UACjB,cAAc,MAAM,CAAC;AAAA,UACrB,UAAU;AAAA,UACV,UAAU,qDAAsB;AAAA,UAChC,gBAAgB,MAAM,mBAAmB;AAAA,UACzC,eAAe,MAAM,SAAS;AAAA,UAC9B,YAAY,YAAY,KAAK;AAAA,UAC7B,YAAY,iDAAoB;AAAA,UAChC;AAAA,QACF,CAAC;AAAA,MACH;AAAA,IACF;AAEA,WAAO;AAAA,EACT;AAAA,EAEA,OAAe,SACb,OACA,SACe;AACf,QAAI,SAAS,sCAAsC,KAAM,QAAO;AAChE,QAAI,SAAS,KAAM,QAAO;AAC1B,UAAM,UAAU,MAAM,KAAK;AAC3B,WAAO,QAAQ,SAAS,IAAI,UAAU;AAAA,EACxC;AAAA,EAEA,OAAe,UAAU,OAAwB;AAC/C,UAAM,SAAS,uBAAQ,WAAW,KAAK;AACvC,QAAI,WAAW,KAAM,OAAM,IAAI,MAAM,6CAA6C,KAAK,EAAE;AACzF,WAAO;AAAA,EACT;AACF;AAGO,SAAS,YAAY,OAAwB;AAClD,SAAO,OAAO,MAAM,aAAa,MAAM;AACzC;",
+  "names": []
+}

package/dist/cjs/measurement/volume-unit.js

@@ -0,0 +1,178 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var volume_unit_exports = {};
+__export(volume_unit_exports, {
+  VolumeUnit: () => VolumeUnit
+});
+module.exports = __toCommonJS(volume_unit_exports);
+var import_decimal = require("../internal/decimal.js");
+var import_measurement_unit = require("../internal/measurement-unit.js");
+function factor(literal) {
+  const parsed = import_decimal.Decimal.parse(literal);
+  if (parsed === null) throw new Error(`Invalid conversion factor: ${literal}`);
+  return parsed;
+}
+class VolumeUnit extends import_measurement_unit.MeasurementUnit {
+  static typeInfo = Object.freeze({
+    englishName: "Volume Unit",
+    localizedName: "Volymenhet",
+    emoji: "\u{1F9EA}",
+    sources: Object.freeze([])
+  });
+  static Microliter = new VolumeUnit({
+    symbol: "\xB5L",
+    englishName: "microliter",
+    localizedName: "mikroliter",
+    pluralEnglish: "microliters",
+    pluralSwedish: "mikroliter",
+    toBaseUnitFactor: factor("0.000001"),
+    aliases: ["\xB5l", "ul", "microlitre", "microlitres"]
+  });
+  static Milliliter = new VolumeUnit({
+    symbol: "mL",
+    englishName: "milliliter",
+    localizedName: "milliliter",
+    pluralEnglish: "milliliters",
+    pluralSwedish: "milliliter",
+    toBaseUnitFactor: factor("0.001"),
+    aliases: ["ml", "millilitre", "millilitres"]
+  });
+  static Centiliter = new VolumeUnit({
+    symbol: "cL",
+    englishName: "centiliter",
+    localizedName: "centiliter",
+    pluralEnglish: "centiliters",
+    pluralSwedish: "centiliter",
+    toBaseUnitFactor: factor("0.01"),
+    aliases: ["cl", "centilitre", "centilitres"]
+  });
+  static Deciliter = new VolumeUnit({
+    symbol: "dL",
+    englishName: "deciliter",
+    localizedName: "deciliter",
+    pluralEnglish: "deciliters",
+    pluralSwedish: "deciliter",
+    toBaseUnitFactor: factor("0.1"),
+    aliases: ["dl", "decilitre", "decilitres"]
+  });
+  static Liter = new VolumeUnit({
+    symbol: "L",
+    englishName: "liter",
+    localizedName: "liter",
+    pluralEnglish: "liters",
+    pluralSwedish: "liter",
+    toBaseUnitFactor: factor("1"),
+    aliases: ["litre", "litres"]
+  });
+  static Hectoliter = new VolumeUnit({
+    symbol: "hL",
+    englishName: "hectoliter",
+    localizedName: "hektoliter",
+    pluralEnglish: "hectoliters",
+    pluralSwedish: "hektoliter",
+    toBaseUnitFactor: factor("100"),
+    aliases: ["hl", "hectolitre", "hectolitres"]
+  });
+  static CubicMeter = new VolumeUnit({
+    symbol: "m\xB3",
+    englishName: "cubic meter",
+    localizedName: "kubikmeter",
+    pluralEnglish: "cubic meters",
+    pluralSwedish: "kubikmeter",
+    toBaseUnitFactor: factor("1000"),
+    aliases: ["m3", "cbm", "kubikmeter", "cubic metre", "cubic metres"]
+  });
+  static Gallon = new VolumeUnit({
+    symbol: "gal",
+    englishName: "gallon",
+    localizedName: "gallon",
+    pluralEnglish: "gallons",
+    pluralSwedish: "gallon",
+    toBaseUnitFactor: factor("3.785411784"),
+    aliases: ["gallon", "gallons"]
+  });
+  static Pint = new VolumeUnit({
+    symbol: "pt",
+    englishName: "pint",
+    localizedName: "pint",
+    pluralEnglish: "pints",
+    pluralSwedish: "pint",
+    toBaseUnitFactor: factor("0.473176473")
+  });
+  static FluidOunce = new VolumeUnit({
+    symbol: "fl oz",
+    englishName: "fluid ounce",
+    localizedName: "v\xE4tskeans",
+    pluralEnglish: "fluid ounces",
+    pluralSwedish: "v\xE4tskeans",
+    toBaseUnitFactor: factor("0.0295735296"),
+    aliases: ["fluid ounce", "fluid ounces", "floz"]
+  });
+  static Cup = new VolumeUnit({
+    symbol: "cup",
+    englishName: "cup",
+    localizedName: "kopp",
+    pluralEnglish: "cups",
+    pluralSwedish: "koppar",
+    toBaseUnitFactor: factor("0.2365882365")
+  });
+  /** @internal Shared lookup and natural-scale walk. */
+  static index = new import_measurement_unit.MeasurementUnitIndex(
+    [
+      VolumeUnit.Microliter,
+      VolumeUnit.Milliliter,
+      VolumeUnit.Centiliter,
+      VolumeUnit.Deciliter,
+      VolumeUnit.Liter,
+      VolumeUnit.Hectoliter,
+      VolumeUnit.CubicMeter,
+      VolumeUnit.Gallon,
+      VolumeUnit.Pint,
+      VolumeUnit.FluidOunce,
+      VolumeUnit.Cup
+    ],
+    VolumeUnit.Liter,
+    [VolumeUnit.Milliliter, VolumeUnit.Deciliter, VolumeUnit.Liter, VolumeUnit.CubicMeter]
+  );
+  static get all() {
+    return VolumeUnit.index.all;
+  }
+  /** The base unit: L. */
+  static get baseUnit() {
+    return VolumeUnit.index.baseUnit;
+  }
+  /** Units ordered small to large, used to auto-scale display. */
+  static get naturalScale() {
+    return VolumeUnit.index.naturalScale;
+  }
+  /** Resolves a unit from a symbol, name, plural or alias, case-insensitively. */
+  static tryParse(input) {
+    return VolumeUnit.index.tryParse(input);
+  }
+  static parse(input) {
+    const result = VolumeUnit.tryParse(input);
+    if (result === null) throw new Error("Unknown volume unit.");
+    return result;
+  }
+  /** Returns the most human-readable unit for a value in L. */
+  static getNatural(baseValue) {
+    return VolumeUnit.index.getNatural(baseValue);
+  }
+}
+//# sourceMappingURL=volume-unit.js.map

package/dist/cjs/measurement/volume-unit.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/measurement/volume-unit.ts"],
+  "sourcesContent": ["import { Decimal } from \"../internal/decimal.js\";\nimport { MeasurementUnit, MeasurementUnitIndex } from \"../internal/measurement-unit.js\";\nimport type { PrimitiveTypeInfo } from \"../primitive-type-info.js\";\n\nfunction factor(literal: string): Decimal {\n  const parsed = Decimal.parse(literal);\n  /* c8 ignore next */\n  if (parsed === null) throw new Error(`Invalid conversion factor: ${literal}`);\n  return parsed;\n}\n\n/**\n * A unit of volume identified by its symbol.\n * Each unit carries English and Swedish names, singular and plural forms, and an\n * exact conversion factor to the base unit.\n */\nexport class VolumeUnit extends MeasurementUnit {\n  declare private readonly __volumeUnitBrand: void;\n\n  static readonly typeInfo: PrimitiveTypeInfo = Object.freeze({\n    englishName: \"Volume Unit\",\n    localizedName: \"Volymenhet\",\n    emoji: \"\uD83E\uDDEA\",\n    sources: Object.freeze([]),\n  });\n\n  static readonly Microliter = new VolumeUnit({\n    symbol: \"\u00B5L\",\n    englishName: \"microliter\",\n    localizedName: \"mikroliter\",\n    pluralEnglish: \"microliters\",\n    pluralSwedish: \"mikroliter\",\n    toBaseUnitFactor: factor(\"0.000001\"),\n    aliases: [\"\u00B5l\", \"ul\", \"microlitre\", \"microlitres\"],\n  });\n\n  static readonly Milliliter = new VolumeUnit({\n    symbol: \"mL\",\n    englishName: \"milliliter\",\n    localizedName: \"milliliter\",\n    pluralEnglish: \"milliliters\",\n    pluralSwedish: \"milliliter\",\n    toBaseUnitFactor: factor(\"0.001\"),\n    aliases: [\"ml\", \"millilitre\", \"millilitres\"],\n  });\n\n  static readonly Centiliter = new VolumeUnit({\n    symbol: \"cL\",\n    englishName: \"centiliter\",\n    localizedName: \"centiliter\",\n    pluralEnglish: \"centiliters\",\n    pluralSwedish: \"centiliter\",\n    toBaseUnitFactor: factor(\"0.01\"),\n    aliases: [\"cl\", \"centilitre\", \"centilitres\"],\n  });\n\n  static readonly Deciliter = new VolumeUnit({\n    symbol: \"dL\",\n    englishName: \"deciliter\",\n    localizedName: \"deciliter\",\n    pluralEnglish: \"deciliters\",\n    pluralSwedish: \"deciliter\",\n    toBaseUnitFactor: factor(\"0.1\"),\n    aliases: [\"dl\", \"decilitre\", \"decilitres\"],\n  });\n\n  static readonly Liter = new VolumeUnit({\n    symbol: \"L\",\n    englishName: \"liter\",\n    localizedName: \"liter\",\n    pluralEnglish: \"liters\",\n    pluralSwedish: \"liter\",\n    toBaseUnitFactor: factor(\"1\"),\n    aliases: [\"litre\", \"litres\"],\n  });\n\n  static readonly Hectoliter = new VolumeUnit({\n    symbol: \"hL\",\n    englishName: \"hectoliter\",\n    localizedName: \"hektoliter\",\n    pluralEnglish: \"hectoliters\",\n    pluralSwedish: \"hektoliter\",\n    toBaseUnitFactor: factor(\"100\"),\n    aliases: [\"hl\", \"hectolitre\", \"hectolitres\"],\n  });\n\n  static readonly CubicMeter = new VolumeUnit({\n    symbol: \"m\u00B3\",\n    englishName: \"cubic meter\",\n    localizedName: \"kubikmeter\",\n    pluralEnglish: \"cubic meters\",\n    pluralSwedish: \"kubikmeter\",\n    toBaseUnitFactor: factor(\"1000\"),\n    aliases: [\"m3\", \"cbm\", \"kubikmeter\", \"cubic metre\", \"cubic metres\"],\n  });\n\n  static readonly Gallon = new VolumeUnit({\n    symbol: \"gal\",\n    englishName: \"gallon\",\n    localizedName: \"gallon\",\n    pluralEnglish: \"gallons\",\n    pluralSwedish: \"gallon\",\n    toBaseUnitFactor: factor(\"3.785411784\"),\n    aliases: [\"gallon\", \"gallons\"],\n  });\n\n  static readonly Pint = new VolumeUnit({\n    symbol: \"pt\",\n    englishName: \"pint\",\n    localizedName: \"pint\",\n    pluralEnglish: \"pints\",\n    pluralSwedish: \"pint\",\n    toBaseUnitFactor: factor(\"0.473176473\"),\n  });\n\n  static readonly FluidOunce = new VolumeUnit({\n    symbol: \"fl oz\",\n    englishName: \"fluid ounce\",\n    localizedName: \"v\u00E4tskeans\",\n    pluralEnglish: \"fluid ounces\",\n    pluralSwedish: \"v\u00E4tskeans\",\n    toBaseUnitFactor: factor(\"0.0295735296\"),\n    aliases: [\"fluid ounce\", \"fluid ounces\", \"floz\"],\n  });\n\n  static readonly Cup = new VolumeUnit({\n    symbol: \"cup\",\n    englishName: \"cup\",\n    localizedName: \"kopp\",\n    pluralEnglish: \"cups\",\n    pluralSwedish: \"koppar\",\n    toBaseUnitFactor: factor(\"0.2365882365\"),\n  });\n\n  /** @internal Shared lookup and natural-scale walk. */\n  static readonly index: MeasurementUnitIndex<VolumeUnit> = new MeasurementUnitIndex<VolumeUnit>(\n    [\n      VolumeUnit.Microliter,\n      VolumeUnit.Milliliter,\n      VolumeUnit.Centiliter,\n      VolumeUnit.Deciliter,\n      VolumeUnit.Liter,\n      VolumeUnit.Hectoliter,\n      VolumeUnit.CubicMeter,\n      VolumeUnit.Gallon,\n      VolumeUnit.Pint,\n      VolumeUnit.FluidOunce,\n      VolumeUnit.Cup,\n    ],\n    VolumeUnit.Liter,\n    [VolumeUnit.Milliliter, VolumeUnit.Deciliter, VolumeUnit.Liter, VolumeUnit.CubicMeter],\n  );\n\n  static get all(): readonly VolumeUnit[] {\n    return VolumeUnit.index.all;\n  }\n\n  /** The base unit: L. */\n  static get baseUnit(): VolumeUnit {\n    return VolumeUnit.index.baseUnit;\n  }\n\n  /** Units ordered small to large, used to auto-scale display. */\n  static get naturalScale(): readonly VolumeUnit[] {\n    return VolumeUnit.index.naturalScale;\n  }\n\n  /** Resolves a unit from a symbol, name, plural or alias, case-insensitively. */\n  static tryParse(input: string | null | undefined): VolumeUnit | null {\n    return VolumeUnit.index.tryParse(input);\n  }\n\n  static parse(input: string): VolumeUnit {\n    const result = VolumeUnit.tryParse(input);\n    if (result === null) throw new Error(\"Unknown volume unit.\");\n    return result;\n  }\n\n  /** Returns the most human-readable unit for a value in L. */\n  static getNatural(baseValue: Decimal): VolumeUnit {\n    return VolumeUnit.index.getNatural(baseValue);\n  }\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,qBAAwB;AACxB,8BAAsD;AAGtD,SAAS,OAAO,SAA0B;AACxC,QAAM,SAAS,uBAAQ,MAAM,OAAO;AAEpC,MAAI,WAAW,KAAM,OAAM,IAAI,MAAM,8BAA8B,OAAO,EAAE;AAC5E,SAAO;AACT;AAOO,MAAM,mBAAmB,wCAAgB;AAAA,EAG9C,OAAgB,WAA8B,OAAO,OAAO;AAAA,IAC1D,aAAa;AAAA,IACb,eAAe;AAAA,IACf,OAAO;AAAA,IACP,SAAS,OAAO,OAAO,CAAC,CAAC;AAAA,EAC3B,CAAC;AAAA,EAED,OAAgB,aAAa,IAAI,WAAW;AAAA,IAC1C,QAAQ;AAAA,IACR,aAAa;AAAA,IACb,eAAe;AAAA,IACf,eAAe;AAAA,IACf,eAAe;AAAA,IACf,kBAAkB,OAAO,UAAU;AAAA,IACnC,SAAS,CAAC,SAAM,MAAM,cAAc,aAAa;AAAA,EACnD,CAAC;AAAA,EAED,OAAgB,aAAa,IAAI,WAAW;AAAA,IAC1C,QAAQ;AAAA,IACR,aAAa;AAAA,IACb,eAAe;AAAA,IACf,eAAe;AAAA,IACf,eAAe;AAAA,IACf,kBAAkB,OAAO,OAAO;AAAA,IAChC,SAAS,CAAC,MAAM,cAAc,aAAa;AAAA,EAC7C,CAAC;AAAA,EAED,OAAgB,aAAa,IAAI,WAAW;AAAA,IAC1C,QAAQ;AAAA,IACR,aAAa;AAAA,IACb,eAAe;AAAA,IACf,eAAe;AAAA,IACf,eAAe;AAAA,IACf,kBAAkB,OAAO,MAAM;AAAA,IAC/B,SAAS,CAAC,MAAM,cAAc,aAAa;AAAA,EAC7C,CAAC;AAAA,EAED,OAAgB,YAAY,IAAI,WAAW;AAAA,IACzC,QAAQ;AAAA,IACR,aAAa;AAAA,IACb,eAAe;AAAA,IACf,eAAe;AAAA,IACf,eAAe;AAAA,IACf,kBAAkB,OAAO,KAAK;AAAA,IAC9B,SAAS,CAAC,MAAM,aAAa,YAAY;AAAA,EAC3C,CAAC;AAAA,EAED,OAAgB,QAAQ,IAAI,WAAW;AAAA,IACrC,QAAQ;AAAA,IACR,aAAa;AAAA,IACb,eAAe;AAAA,IACf,eAAe;AAAA,IACf,eAAe;AAAA,IACf,kBAAkB,OAAO,GAAG;AAAA,IAC5B,SAAS,CAAC,SAAS,QAAQ;AAAA,EAC7B,CAAC;AAAA,EAED,OAAgB,aAAa,IAAI,WAAW;AAAA,IAC1C,QAAQ;AAAA,IACR,aAAa;AAAA,IACb,eAAe;AAAA,IACf,eAAe;AAAA,IACf,eAAe;AAAA,IACf,kBAAkB,OAAO,KAAK;AAAA,IAC9B,SAAS,CAAC,MAAM,cAAc,aAAa;AAAA,EAC7C,CAAC;AAAA,EAED,OAAgB,aAAa,IAAI,WAAW;AAAA,IAC1C,QAAQ;AAAA,IACR,aAAa;AAAA,IACb,eAAe;AAAA,IACf,eAAe;AAAA,IACf,eAAe;AAAA,IACf,kBAAkB,OAAO,MAAM;AAAA,IAC/B,SAAS,CAAC,MAAM,OAAO,cAAc,eAAe,cAAc;AAAA,EACpE,CAAC;AAAA,EAED,OAAgB,SAAS,IAAI,WAAW;AAAA,IACtC,QAAQ;AAAA,IACR,aAAa;AAAA,IACb,eAAe;AAAA,IACf,eAAe;AAAA,IACf,eAAe;AAAA,IACf,kBAAkB,OAAO,aAAa;AAAA,IACtC,SAAS,CAAC,UAAU,SAAS;AAAA,EAC/B,CAAC;AAAA,EAED,OAAgB,OAAO,IAAI,WAAW;AAAA,IACpC,QAAQ;AAAA,IACR,aAAa;AAAA,IACb,eAAe;AAAA,IACf,eAAe;AAAA,IACf,eAAe;AAAA,IACf,kBAAkB,OAAO,aAAa;AAAA,EACxC,CAAC;AAAA,EAED,OAAgB,aAAa,IAAI,WAAW;AAAA,IAC1C,QAAQ;AAAA,IACR,aAAa;AAAA,IACb,eAAe;AAAA,IACf,eAAe;AAAA,IACf,eAAe;AAAA,IACf,kBAAkB,OAAO,cAAc;AAAA,IACvC,SAAS,CAAC,eAAe,gBAAgB,MAAM;AAAA,EACjD,CAAC;AAAA,EAED,OAAgB,MAAM,IAAI,WAAW;AAAA,IACnC,QAAQ;AAAA,IACR,aAAa;AAAA,IACb,eAAe;AAAA,IACf,eAAe;AAAA,IACf,eAAe;AAAA,IACf,kBAAkB,OAAO,cAAc;AAAA,EACzC,CAAC;AAAA;AAAA,EAGD,OAAgB,QAA0C,IAAI;AAAA,IAC5D;AAAA,MACE,WAAW;AAAA,MACX,WAAW;AAAA,MACX,WAAW;AAAA,MACX,WAAW;AAAA,MACX,WAAW;AAAA,MACX,WAAW;AAAA,MACX,WAAW;AAAA,MACX,WAAW;AAAA,MACX,WAAW;AAAA,MACX,WAAW;AAAA,MACX,WAAW;AAAA,IACb;AAAA,IACA,WAAW;AAAA,IACX,CAAC,WAAW,YAAY,WAAW,WAAW,WAAW,OAAO,WAAW,UAAU;AAAA,EACvF;AAAA,EAEA,WAAW,MAA6B;AACtC,WAAO,WAAW,MAAM;AAAA,EAC1B;AAAA;AAAA,EAGA,WAAW,WAAuB;AAChC,WAAO,WAAW,MAAM;AAAA,EAC1B;AAAA;AAAA,EAGA,WAAW,eAAsC;AAC/C,WAAO,WAAW,MAAM;AAAA,EAC1B;AAAA;AAAA,EAGA,OAAO,SAAS,OAAqD;AACnE,WAAO,WAAW,MAAM,SAAS,KAAK;AAAA,EACxC;AAAA,EAEA,OAAO,MAAM,OAA2B;AACtC,UAAM,SAAS,WAAW,SAAS,KAAK;AACxC,QAAI,WAAW,KAAM,OAAM,IAAI,MAAM,sBAAsB;AAC3D,WAAO;AAAA,EACT;AAAA;AAAA,EAGA,OAAO,WAAW,WAAgC;AAChD,WAAO,WAAW,MAAM,WAAW,SAAS;AAAA,EAC9C;AACF;",
+  "names": []
+}

package/dist/cjs/measurement/volume.js

@@ -0,0 +1,195 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var volume_exports = {};
+__export(volume_exports, {
+  Volume: () => Volume,
+  maskVolume: () => maskVolume
+});
+module.exports = __toCommonJS(volume_exports);
+var import_decimal = require("../internal/decimal.js");
+var import_quantity = require("../internal/quantity.js");
+var import_text_candidate = require("../text-scanning/text-candidate.js");
+var import_text_candidate_category = require("../text-scanning/text-candidate-category.js");
+var import_text_match_confidence = require("../text-scanning/text-match-confidence.js");
+var import_volume_unit = require("./volume-unit.js");
+const SCAN_PATTERN = new RegExp(
+  String.raw`(?<!\w)(?:[+-]\s*)?\d+[0-9 .,]*\s*(?:kubikmeter|hektoliter|mikroliter|vätskeans|fluid\s+ounces?|fl\s*oz|gallons?|microliters?|milliliters?|centiliters?|deciliters?|hectoliters?|liters?|cubic\s+meters?|koppar|kopp|cups?|pints?|m³|m3|cbm|µL|µl|ul|ml|cl|dl|hL|hl|gal|pt|l)\b`,
+  "giu"
+);
+class Volume extends import_quantity.Quantity {
+  static typeInfo = Object.freeze({
+    englishName: "Volume",
+    localizedName: "Volym",
+    emoji: "\u{1F9EA}",
+    sources: Object.freeze([
+      "https://www.bipm.org/en/measurement-units/si-derived-units",
+      "https://en.wikipedia.org/wiki/Conversion_of_units"
+    ])
+  });
+  get units() {
+    return import_volume_unit.VolumeUnit.index;
+  }
+  withBaseValue(baseValue, unit) {
+    return new Volume(baseValue, unit);
+  }
+  get microliters() {
+    return this.in(import_volume_unit.VolumeUnit.Microliter);
+  }
+  get milliliters() {
+    return this.in(import_volume_unit.VolumeUnit.Milliliter);
+  }
+  get centiliters() {
+    return this.in(import_volume_unit.VolumeUnit.Centiliter);
+  }
+  get deciliters() {
+    return this.in(import_volume_unit.VolumeUnit.Deciliter);
+  }
+  get liters() {
+    return this.in(import_volume_unit.VolumeUnit.Liter);
+  }
+  get hectoliters() {
+    return this.in(import_volume_unit.VolumeUnit.Hectoliter);
+  }
+  get cubicMeters() {
+    return this.in(import_volume_unit.VolumeUnit.CubicMeter);
+  }
+  get gallons() {
+    return this.in(import_volume_unit.VolumeUnit.Gallon);
+  }
+  get pints() {
+    return this.in(import_volume_unit.VolumeUnit.Pint);
+  }
+  get fluidOunces() {
+    return this.in(import_volume_unit.VolumeUnit.FluidOunce);
+  }
+  get cups() {
+    return this.in(import_volume_unit.VolumeUnit.Cup);
+  }
+  /** Creates a volume from a value and unit. */
+  static create(value, unit) {
+    import_volume_unit.VolumeUnit.index.assertOwns(unit);
+    const amount = value instanceof import_decimal.Decimal ? value : Volume.decimalOf(value);
+    return new Volume(unit.toBase(amount), unit);
+  }
+  static fromMicroliters(value) {
+    return Volume.create(value, import_volume_unit.VolumeUnit.Microliter);
+  }
+  static fromMilliliters(value) {
+    return Volume.create(value, import_volume_unit.VolumeUnit.Milliliter);
+  }
+  static fromCentiliters(value) {
+    return Volume.create(value, import_volume_unit.VolumeUnit.Centiliter);
+  }
+  static fromDeciliters(value) {
+    return Volume.create(value, import_volume_unit.VolumeUnit.Deciliter);
+  }
+  static fromLiters(value) {
+    return Volume.create(value, import_volume_unit.VolumeUnit.Liter);
+  }
+  static fromHectoliters(value) {
+    return Volume.create(value, import_volume_unit.VolumeUnit.Hectoliter);
+  }
+  static fromCubicMeters(value) {
+    return Volume.create(value, import_volume_unit.VolumeUnit.CubicMeter);
+  }
+  static fromGallons(value) {
+    return Volume.create(value, import_volume_unit.VolumeUnit.Gallon);
+  }
+  static fromPints(value) {
+    return Volume.create(value, import_volume_unit.VolumeUnit.Pint);
+  }
+  static fromFluidOunces(value) {
+    return Volume.create(value, import_volume_unit.VolumeUnit.FluidOunce);
+  }
+  static fromCups(value) {
+    return Volume.create(value, import_volume_unit.VolumeUnit.Cup);
+  }
+  static tryParse(input) {
+    const parsed = (0, import_quantity.tryParseQuantity)(input, import_volume_unit.VolumeUnit.index);
+    return parsed === null ? null : new Volume(parsed.baseValue, parsed.unit);
+  }
+  static parse(input) {
+    const result = Volume.tryParse(input);
+    if (result === null) throw new Error("Invalid volume.");
+    return result;
+  }
+  static isValid(input) {
+    return Volume.tryParse(input) !== null;
+  }
+  /** Display form in the parsed unit, or `null` when the input is invalid. */
+  static format(input, options) {
+    const parsed = Volume.tryParse(input);
+    if (parsed !== null) {
+      if (options?.unit !== void 0 || options?.decimals !== void 0) {
+        return parsed.toStringInUnit(options.unit ?? parsed.originalUnit, options.decimals);
+      }
+      return parsed.toString();
+    }
+    return Volume.fallback(input, options);
+  }
+  /** The value in liters, or `null` when the input is invalid. */
+  static normalize(input, options) {
+    const parsed = Volume.tryParse(input);
+    if (parsed !== null) return parsed.toNormalizedString();
+    return Volume.fallback(input, options);
+  }
+  static isNormalized(input) {
+    return input != null && Volume.normalize(input) === input;
+  }
+  static findCandidatesInText(text) {
+    if (!text) return [];
+    const out = [];
+    const pattern = new RegExp(SCAN_PATTERN.source, SCAN_PATTERN.flags);
+    let match;
+    while ((match = pattern.exec(text)) !== null) {
+      const value = Volume.tryParse(match[0]);
+      if (value === null) continue;
+      out.push(
+        new import_text_candidate.TextCandidate({
+          startIndex: match.index,
+          length: match[0].length,
+          originalText: match[0],
+          typeName: "Volume",
+          category: import_text_candidate_category.TextCandidateCategory.Measurement,
+          normalizedForm: value.toNormalizedString(),
+          formattedForm: value.toString(),
+          maskedForm: maskVolume(value),
+          confidence: import_text_match_confidence.TextMatchConfidence.Medium,
+          value
+        })
+      );
+    }
+    return out;
+  }
+  static fallback(input, options) {
+    if (options?.fallbackToTrimmedInputWhenInvalid !== true) return null;
+    if (input == null) return null;
+    const trimmed = input.trim();
+    return trimmed.length > 0 ? trimmed : null;
+  }
+  static decimalOf(value) {
+    const parsed = import_decimal.Decimal.fromNumber(value);
+    if (parsed === null) throw new Error(`Value cannot be represented as a volume: ${value}`);
+    return parsed;
+  }
+}
+function maskVolume(value) {
+  return `*** ${value.originalUnit.symbol}`;
+}
+//# sourceMappingURL=volume.js.map

package/dist/cjs/measurement/volume.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/measurement/volume.ts"],
+  "sourcesContent": ["import { Decimal } from \"../internal/decimal.js\";\nimport type { MeasurementUnitIndex } from \"../internal/measurement-unit.js\";\nimport { Quantity, tryParseQuantity } from \"../internal/quantity.js\";\nimport type { PrimitiveTypeInfo } from \"../primitive-type-info.js\";\nimport { TextCandidate } from \"../text-scanning/text-candidate.js\";\nimport { TextCandidateCategory } from \"../text-scanning/text-candidate-category.js\";\nimport { TextMatchConfidence } from \"../text-scanning/text-match-confidence.js\";\nimport { VolumeUnit } from \"./volume-unit.js\";\n\n/** Options for {@link Volume.format} and {@link Volume.normalize}. */\nexport interface VolumeFormatOptions {\n  fallbackToTrimmedInputWhenInvalid?: boolean;\n  /** Convert to this unit instead of preserving the parsed one. */\n  unit?: VolumeUnit;\n  /** Round to this many fractional digits, away from zero. */\n  decimals?: number;\n}\n\nconst SCAN_PATTERN = new RegExp(\n  String.raw`(?<!\\w)(?:[+-]\\s*)?\\d+[0-9 .,]*\\s*(?:kubikmeter|hektoliter|mikroliter|v\u00E4tskeans|fluid\\s+ounces?|fl\\s*oz|gallons?|microliters?|milliliters?|centiliters?|deciliters?|hectoliters?|liters?|cubic\\s+meters?|koppar|kopp|cups?|pints?|m\u00B3|m3|cbm|\u00B5L|\u00B5l|ul|ml|cl|dl|hL|hl|gal|pt|l)\\b`,\n  \"giu\",\n);\n\n/**\n * A volume stored internally in liters,\n * parsed from any supported unit and convertible between all of them.\n */\nexport class Volume extends Quantity<VolumeUnit> {\n  static readonly typeInfo: PrimitiveTypeInfo = Object.freeze({\n    englishName: \"Volume\",\n    localizedName: \"Volym\",\n    emoji: \"\uD83E\uDDEA\",\n    sources: Object.freeze([\n      \"https://www.bipm.org/en/measurement-units/si-derived-units\",\n      \"https://en.wikipedia.org/wiki/Conversion_of_units\",\n    ]),\n  });\n\n  protected get units(): MeasurementUnitIndex<VolumeUnit> {\n    return VolumeUnit.index;\n  }\n\n  protected withBaseValue(baseValue: Decimal, unit: VolumeUnit): this {\n    return new Volume(baseValue, unit) as this;\n  }\n\n  get microliters(): number {\n    return this.in(VolumeUnit.Microliter);\n  }\n  get milliliters(): number {\n    return this.in(VolumeUnit.Milliliter);\n  }\n  get centiliters(): number {\n    return this.in(VolumeUnit.Centiliter);\n  }\n  get deciliters(): number {\n    return this.in(VolumeUnit.Deciliter);\n  }\n  get liters(): number {\n    return this.in(VolumeUnit.Liter);\n  }\n  get hectoliters(): number {\n    return this.in(VolumeUnit.Hectoliter);\n  }\n  get cubicMeters(): number {\n    return this.in(VolumeUnit.CubicMeter);\n  }\n  get gallons(): number {\n    return this.in(VolumeUnit.Gallon);\n  }\n  get pints(): number {\n    return this.in(VolumeUnit.Pint);\n  }\n  get fluidOunces(): number {\n    return this.in(VolumeUnit.FluidOunce);\n  }\n  get cups(): number {\n    return this.in(VolumeUnit.Cup);\n  }\n\n  /** Creates a volume from a value and unit. */\n  static create(value: number | Decimal, unit: VolumeUnit): Volume {\n    VolumeUnit.index.assertOwns(unit);\n    const amount = value instanceof Decimal ? value : Volume.decimalOf(value);\n    return new Volume(unit.toBase(amount), unit);\n  }\n\n  static fromMicroliters(value: number | Decimal): Volume {\n    return Volume.create(value, VolumeUnit.Microliter);\n  }\n  static fromMilliliters(value: number | Decimal): Volume {\n    return Volume.create(value, VolumeUnit.Milliliter);\n  }\n  static fromCentiliters(value: number | Decimal): Volume {\n    return Volume.create(value, VolumeUnit.Centiliter);\n  }\n  static fromDeciliters(value: number | Decimal): Volume {\n    return Volume.create(value, VolumeUnit.Deciliter);\n  }\n  static fromLiters(value: number | Decimal): Volume {\n    return Volume.create(value, VolumeUnit.Liter);\n  }\n  static fromHectoliters(value: number | Decimal): Volume {\n    return Volume.create(value, VolumeUnit.Hectoliter);\n  }\n  static fromCubicMeters(value: number | Decimal): Volume {\n    return Volume.create(value, VolumeUnit.CubicMeter);\n  }\n  static fromGallons(value: number | Decimal): Volume {\n    return Volume.create(value, VolumeUnit.Gallon);\n  }\n  static fromPints(value: number | Decimal): Volume {\n    return Volume.create(value, VolumeUnit.Pint);\n  }\n  static fromFluidOunces(value: number | Decimal): Volume {\n    return Volume.create(value, VolumeUnit.FluidOunce);\n  }\n  static fromCups(value: number | Decimal): Volume {\n    return Volume.create(value, VolumeUnit.Cup);\n  }\n\n  static tryParse(input: string | null | undefined): Volume | null {\n    const parsed = tryParseQuantity(input, VolumeUnit.index);\n    return parsed === null ? null : new Volume(parsed.baseValue, parsed.unit);\n  }\n\n  static parse(input: string): Volume {\n    const result = Volume.tryParse(input);\n    if (result === null) throw new Error(\"Invalid volume.\");\n    return result;\n  }\n\n  static isValid(input: string | null | undefined): boolean {\n    return Volume.tryParse(input) !== null;\n  }\n\n  /** Display form in the parsed unit, or `null` when the input is invalid. */\n  static format(input: string | null | undefined, options?: VolumeFormatOptions): string | null {\n    const parsed = Volume.tryParse(input);\n    if (parsed !== null) {\n      if (options?.unit !== undefined || options?.decimals !== undefined) {\n        return parsed.toStringInUnit(options.unit ?? parsed.originalUnit, options.decimals);\n      }\n      return parsed.toString();\n    }\n    return Volume.fallback(input, options);\n  }\n\n  /** The value in liters, or `null` when the input is invalid. */\n  static normalize(input: string | null | undefined, options?: VolumeFormatOptions): string | null {\n    const parsed = Volume.tryParse(input);\n    if (parsed !== null) return parsed.toNormalizedString();\n    return Volume.fallback(input, options);\n  }\n\n  static isNormalized(input: string | null | undefined): boolean {\n    return input != null && Volume.normalize(input) === input;\n  }\n\n  static findCandidatesInText(text: string): readonly TextCandidate<Volume>[] {\n    if (!text) return [];\n\n    const out: TextCandidate<Volume>[] = [];\n    const pattern = new RegExp(SCAN_PATTERN.source, SCAN_PATTERN.flags);\n    let match: RegExpExecArray | null;\n\n    while ((match = pattern.exec(text)) !== null) {\n      const value = Volume.tryParse(match[0]);\n      if (value === null) continue;\n      out.push(\n        new TextCandidate<Volume>({\n          startIndex: match.index,\n          length: match[0].length,\n          originalText: match[0],\n          typeName: \"Volume\",\n          category: TextCandidateCategory.Measurement,\n          normalizedForm: value.toNormalizedString(),\n          formattedForm: value.toString(),\n          maskedForm: maskVolume(value),\n          confidence: TextMatchConfidence.Medium,\n          value,\n        }),\n      );\n    }\n\n    return out;\n  }\n\n  private static fallback(\n    input: string | null | undefined,\n    options?: VolumeFormatOptions,\n  ): string | null {\n    if (options?.fallbackToTrimmedInputWhenInvalid !== true) return null;\n    if (input == null) return null;\n    const trimmed = input.trim();\n    return trimmed.length > 0 ? trimmed : null;\n  }\n\n  private static decimalOf(value: number): Decimal {\n    const parsed = Decimal.fromNumber(value);\n    if (parsed === null) throw new Error(`Value cannot be represented as a volume: ${value}`);\n    return parsed;\n  }\n}\n\n/** Returns a masked volume, e.g. `10 L` becomes `*** L`. */\nexport function maskVolume(value: Volume): string {\n  return `*** ${value.originalUnit.symbol}`;\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,qBAAwB;AAExB,sBAA2C;AAE3C,4BAA8B;AAC9B,qCAAsC;AACtC,mCAAoC;AACpC,yBAA2B;AAW3B,MAAM,eAAe,IAAI;AAAA,EACvB,OAAO;AAAA,EACP;AACF;AAMO,MAAM,eAAe,yBAAqB;AAAA,EAC/C,OAAgB,WAA8B,OAAO,OAAO;AAAA,IAC1D,aAAa;AAAA,IACb,eAAe;AAAA,IACf,OAAO;AAAA,IACP,SAAS,OAAO,OAAO;AAAA,MACrB;AAAA,MACA;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AAAA,EAED,IAAc,QAA0C;AACtD,WAAO,8BAAW;AAAA,EACpB;AAAA,EAEU,cAAc,WAAoB,MAAwB;AAClE,WAAO,IAAI,OAAO,WAAW,IAAI;AAAA,EACnC;AAAA,EAEA,IAAI,cAAsB;AACxB,WAAO,KAAK,GAAG,8BAAW,UAAU;AAAA,EACtC;AAAA,EACA,IAAI,cAAsB;AACxB,WAAO,KAAK,GAAG,8BAAW,UAAU;AAAA,EACtC;AAAA,EACA,IAAI,cAAsB;AACxB,WAAO,KAAK,GAAG,8BAAW,UAAU;AAAA,EACtC;AAAA,EACA,IAAI,aAAqB;AACvB,WAAO,KAAK,GAAG,8BAAW,SAAS;AAAA,EACrC;AAAA,EACA,IAAI,SAAiB;AACnB,WAAO,KAAK,GAAG,8BAAW,KAAK;AAAA,EACjC;AAAA,EACA,IAAI,cAAsB;AACxB,WAAO,KAAK,GAAG,8BAAW,UAAU;AAAA,EACtC;AAAA,EACA,IAAI,cAAsB;AACxB,WAAO,KAAK,GAAG,8BAAW,UAAU;AAAA,EACtC;AAAA,EACA,IAAI,UAAkB;AACpB,WAAO,KAAK,GAAG,8BAAW,MAAM;AAAA,EAClC;AAAA,EACA,IAAI,QAAgB;AAClB,WAAO,KAAK,GAAG,8BAAW,IAAI;AAAA,EAChC;AAAA,EACA,IAAI,cAAsB;AACxB,WAAO,KAAK,GAAG,8BAAW,UAAU;AAAA,EACtC;AAAA,EACA,IAAI,OAAe;AACjB,WAAO,KAAK,GAAG,8BAAW,GAAG;AAAA,EAC/B;AAAA;AAAA,EAGA,OAAO,OAAO,OAAyB,MAA0B;AAC/D,kCAAW,MAAM,WAAW,IAAI;AAChC,UAAM,SAAS,iBAAiB,yBAAU,QAAQ,OAAO,UAAU,KAAK;AACxE,WAAO,IAAI,OAAO,KAAK,OAAO,MAAM,GAAG,IAAI;AAAA,EAC7C;AAAA,EAEA,OAAO,gBAAgB,OAAiC;AACtD,WAAO,OAAO,OAAO,OAAO,8BAAW,UAAU;AAAA,EACnD;AAAA,EACA,OAAO,gBAAgB,OAAiC;AACtD,WAAO,OAAO,OAAO,OAAO,8BAAW,UAAU;AAAA,EACnD;AAAA,EACA,OAAO,gBAAgB,OAAiC;AACtD,WAAO,OAAO,OAAO,OAAO,8BAAW,UAAU;AAAA,EACnD;AAAA,EACA,OAAO,eAAe,OAAiC;AACrD,WAAO,OAAO,OAAO,OAAO,8BAAW,SAAS;AAAA,EAClD;AAAA,EACA,OAAO,WAAW,OAAiC;AACjD,WAAO,OAAO,OAAO,OAAO,8BAAW,KAAK;AAAA,EAC9C;AAAA,EACA,OAAO,gBAAgB,OAAiC;AACtD,WAAO,OAAO,OAAO,OAAO,8BAAW,UAAU;AAAA,EACnD;AAAA,EACA,OAAO,gBAAgB,OAAiC;AACtD,WAAO,OAAO,OAAO,OAAO,8BAAW,UAAU;AAAA,EACnD;AAAA,EACA,OAAO,YAAY,OAAiC;AAClD,WAAO,OAAO,OAAO,OAAO,8BAAW,MAAM;AAAA,EAC/C;AAAA,EACA,OAAO,UAAU,OAAiC;AAChD,WAAO,OAAO,OAAO,OAAO,8BAAW,IAAI;AAAA,EAC7C;AAAA,EACA,OAAO,gBAAgB,OAAiC;AACtD,WAAO,OAAO,OAAO,OAAO,8BAAW,UAAU;AAAA,EACnD;AAAA,EACA,OAAO,SAAS,OAAiC;AAC/C,WAAO,OAAO,OAAO,OAAO,8BAAW,GAAG;AAAA,EAC5C;AAAA,EAEA,OAAO,SAAS,OAAiD;AAC/D,UAAM,aAAS,kCAAiB,OAAO,8BAAW,KAAK;AACvD,WAAO,WAAW,OAAO,OAAO,IAAI,OAAO,OAAO,WAAW,OAAO,IAAI;AAAA,EAC1E;AAAA,EAEA,OAAO,MAAM,OAAuB;AAClC,UAAM,SAAS,OAAO,SAAS,KAAK;AACpC,QAAI,WAAW,KAAM,OAAM,IAAI,MAAM,iBAAiB;AACtD,WAAO;AAAA,EACT;AAAA,EAEA,OAAO,QAAQ,OAA2C;AACxD,WAAO,OAAO,SAAS,KAAK,MAAM;AAAA,EACpC;AAAA;AAAA,EAGA,OAAO,OAAO,OAAkC,SAA8C;AAC5F,UAAM,SAAS,OAAO,SAAS,KAAK;AACpC,QAAI,WAAW,MAAM;AACnB,UAAI,SAAS,SAAS,UAAa,SAAS,aAAa,QAAW;AAClE,eAAO,OAAO,eAAe,QAAQ,QAAQ,OAAO,cAAc,QAAQ,QAAQ;AAAA,MACpF;AACA,aAAO,OAAO,SAAS;AAAA,IACzB;AACA,WAAO,OAAO,SAAS,OAAO,OAAO;AAAA,EACvC;AAAA;AAAA,EAGA,OAAO,UAAU,OAAkC,SAA8C;AAC/F,UAAM,SAAS,OAAO,SAAS,KAAK;AACpC,QAAI,WAAW,KAAM,QAAO,OAAO,mBAAmB;AACtD,WAAO,OAAO,SAAS,OAAO,OAAO;AAAA,EACvC;AAAA,EAEA,OAAO,aAAa,OAA2C;AAC7D,WAAO,SAAS,QAAQ,OAAO,UAAU,KAAK,MAAM;AAAA,EACtD;AAAA,EAEA,OAAO,qBAAqB,MAAgD;AAC1E,QAAI,CAAC,KAAM,QAAO,CAAC;AAEnB,UAAM,MAA+B,CAAC;AACtC,UAAM,UAAU,IAAI,OAAO,aAAa,QAAQ,aAAa,KAAK;AAClE,QAAI;AAEJ,YAAQ,QAAQ,QAAQ,KAAK,IAAI,OAAO,MAAM;AAC5C,YAAM,QAAQ,OAAO,SAAS,MAAM,CAAC,CAAC;AACtC,UAAI,UAAU,KAAM;AACpB,UAAI;AAAA,QACF,IAAI,oCAAsB;AAAA,UACxB,YAAY,MAAM;AAAA,UAClB,QAAQ,MAAM,CAAC,EAAE;AAAA,UACjB,cAAc,MAAM,CAAC;AAAA,UACrB,UAAU;AAAA,UACV,UAAU,qDAAsB;AAAA,UAChC,gBAAgB,MAAM,mBAAmB;AAAA,UACzC,eAAe,MAAM,SAAS;AAAA,UAC9B,YAAY,WAAW,KAAK;AAAA,UAC5B,YAAY,iDAAoB;AAAA,UAChC;AAAA,QACF,CAAC;AAAA,MACH;AAAA,IACF;AAEA,WAAO;AAAA,EACT;AAAA,EAEA,OAAe,SACb,OACA,SACe;AACf,QAAI,SAAS,sCAAsC,KAAM,QAAO;AAChE,QAAI,SAAS,KAAM,QAAO;AAC1B,UAAM,UAAU,MAAM,KAAK;AAC3B,WAAO,QAAQ,SAAS,IAAI,UAAU;AAAA,EACxC;AAAA,EAEA,OAAe,UAAU,OAAwB;AAC/C,UAAM,SAAS,uBAAQ,WAAW,KAAK;AACvC,QAAI,WAAW,KAAM,OAAM,IAAI,MAAM,4CAA4C,KAAK,EAAE;AACxF,WAAO;AAAA,EACT;AACF;AAGO,SAAS,WAAW,OAAuB;AAChD,SAAO,OAAO,MAAM,aAAa,MAAM;AACzC;",
+  "names": []
+}