@streamline-pulse/formkrafter-core 0.29.0 → 0.31.0

package/dist/utils/registries.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Public registries: vehicle plates and company registration numbers, each
+ * checked against a named format (per country, or a generic one).
+ */
+interface Format {
+    id: string;
+    label: string;
+    /** Tested against the compacted, upper-cased value. */
+    test: (value: string) => boolean;
+    /** Display form of a valid value (compacted input). */
+    format?: (value: string) => string;
+}
+export declare const PLATE_FORMATS: Format[];
+export declare const REGISTRY_FORMATS: Format[];
+/** Compact form kept in the data for plates (letters and digits only, upper case). */
+export declare const compactPlate: (value: string) => string;
+export declare function checkPlate(format: string, value: string): boolean;
+export declare function formatPlate(format: string, value: string): string;
+export declare function checkCompanyRegistry(format: string, value: string): boolean;
+export declare function formatCompanyRegistry(format: string, value: string): string;
+export {};

package/dist/utils/units.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Measures: a number with a unit, kept with its value in the family's base
+ * unit so sums and averages stay meaningful whatever unit each answer used.
+ */
+export type MeasureFamily = "length" | "area" | "mass" | "volume" | "duration";
+export interface MeasureUnit {
+    id: string;
+    /** Symbol shown to the user. */
+    symbol: string;
+    /** Multiply a value in this unit by `factor` to get the family's base unit. */
+    factor: number;
+}
+export interface MeasureValue {
+    value: number;
+    unit: string;
+    /** `value` converted to the family's base unit. */
+    base: number;
+}
+export declare const MEASURE_FAMILIES: Record<MeasureFamily, {
+    base: string;
+    units: MeasureUnit[];
+}>;
+export declare const measureFamilyOf: (value: unknown) => MeasureFamily;
+/** The units of a family, restricted to `allowed` (comma-separated ids) when given. */
+export declare function measureUnits(family: MeasureFamily, allowed?: unknown): MeasureUnit[];
+export declare function unitOf(family: MeasureFamily, id: string): MeasureUnit | undefined;
+/** Converts between two units of the same family; `undefined` when a unit is unknown. */
+export declare function convertMeasure(family: MeasureFamily, value: number, from: string, to: string): number | undefined;
+/** Builds the stored value: the number, its unit and the base-unit equivalent. */
+export declare function measureValue(family: MeasureFamily, value: number, unit: string): MeasureValue | undefined;
+/** Human form, e.g. `2,5 ha`. */
+export declare function formatMeasure(family: MeasureFamily, value: MeasureValue | undefined, locale?: string): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@streamline-pulse/formkrafter-core",
-  "version": "0.29.0",
+  "version": "0.31.0",
   "description": "Framework-agnostic core for FormKrafter: form specs, RFC 6902 ops with undo/redo, Ajv validation, sandboxed rules engine and injectable services",
   "license": "MIT",
   "type": "module",