@stonecrop/aform 0.31.0 → 0.32.0

package/dist/{tsdoc-metadata.json → src/tsdoc-metadata.json}

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.58.11"
+      "packageVersion": "7.59.0"
     }
   ]
 }

package/package.json

@@ -1,48 +1,58 @@
 {
   "name": "@stonecrop/aform",
-  "version": "0.31.0",
+  "version": "0.32.0",
   "description": "Schema-driven form components for Stonecrop",
+  "keywords": [
+    "components",
+    "forms",
+    "schema",
+    "stonecrop",
+    "vue"
+  ],
+  "homepage": "https://github.com/agritheory/stonecrop#readme",
   "bugs": {
     "url": "https://github.com/agritheory/stonecrop/issues"
   },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/agritheory/stonecrop",
-    "directory": "aform"
-  },
   "license": "MIT",
   "author": {
     "name": "Tyler Matteson",
     "email": "tyler@agritheory.com"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/agritheory/stonecrop",
+    "directory": "aform"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
   "sideEffects": [
     "**/*.css"
   ],
-  "type": "module",
+  "types": "./dist/src/index.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/aform.d.ts",
+      "types": "./dist/src/index.d.ts",
       "import": "./dist/aform.js"
     },
     "./styles": "./dist/assets/index.css",
-    "./types": "./dist/src/types/index.d.ts"
+    "./types": "./dist/src/types/index.d.ts",
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public"
   },
-  "types": "./dist/aform.d.ts",
-  "files": [
-    "dist/*",
-    "src/*"
-  ],
   "dependencies": {
     "@vueuse/components": "^14.2.1",
     "@vueuse/core": "^14.2.1",
-    "@stonecrop/atable": "0.31.0",
-    "@stonecrop/schema": "0.31.0",
-    "@stonecrop/themes": "0.31.0",
-    "@stonecrop/utilities": "0.31.0"
+    "@stonecrop/atable": "0.32.0",
+    "@stonecrop/schema": "0.32.0",
+    "@stonecrop/utilities": "0.32.0",
+    "@stonecrop/themes": "0.32.0"
   },
   "devDependencies": {
-    "@microsoft/api-documenter": "^7.30.5",
-    "@rushstack/heft": "^1.2.17",
+    "@microsoft/api-extractor": "^7.58.7",
     "@types/node": "^24.12.4",
     "@vitejs/plugin-vue": "^6.0.6",
     "@vitest/coverage-istanbul": "^4.1.5",
@@ -53,13 +63,13 @@
     "oxlint-tsgolint": "0.23.0",
     "pinia": "^3.0.4",
     "typescript": "^6.0.3",
-    "vite": "^7.3.2",
+    "vite": "^8.2.2",
     "vite-plugin-lib-inject-css": "^2.2.2",
     "vitest": "^4.1.5",
     "vue": "^3.5.33",
+    "vue-component-meta": "^3.3.11",
     "vue-router": "^5.0.6",
-    "vue-tsc": "^3.3.6",
-    "stonecrop-rig": "0.7.0"
+    "vue-tsc": "^3.3.6"
   },
   "peerDependencies": {
     "pinia": "^3.0.4",
@@ -68,14 +78,9 @@
   "engines": {
     "node": ">=24.0.0"
   },
-  "publishConfig": {
-    "access": "public"
-  },
   "scripts": {
-    "_phase:build": "heft build --clean && vite build && rushx docs",
-    "build": "heft build --clean && vite build && rushx docs",
-    "dev": "vite",
-    "docs": "bash ../common/scripts/run-docs.sh aform",
+    "dev": "vite build --watch",
+    "docs": "bash ../tools/scripts/run-docs.sh aform",
     "lint": "oxlint",
     "lint:fix": "oxlint --fix",
     "preview": "vite preview",

package/dist/aform.d.ts

@@ -1,441 +0,0 @@
-import ABadge from './components/form/ABadge.vue';
-import ACheckbox from './components/form/ACheckbox.vue';
-import ACurrencyInput from './components/form/ACurrencyInput.vue';
-import ADate from './components/form/ADate.vue';
-import ADatePicker from './components/form/ADatePicker.vue';
-import ADateRange from './components/form/ADateRange.vue';
-import ADateSelection from './components/form/ADateSelection.vue';
-import ADateTime from './components/form/ADateTime.vue';
-import ADateTimeInput from './components/form/ADateTimeInput.vue';
-import ADropdown from './components/form/ADropdown.vue';
-import ADuration from './components/form/ADuration.vue';
-import AFieldset from './components/form/AFieldset.vue';
-import AFileAttach from './components/form/AFileAttach.vue';
-import AForm from './components/AForm.vue';
-import AFormLink from './components/form/AFormLink.vue';
-import AFormLoading from './components/AFormLoading.vue';
-import ANumericInput from './components/form/ANumericInput.vue';
-import type { App } from 'vue';
-import AQuantityInput from './components/form/AQuantityInput.vue';
-import ASegmentedControl from './components/form/ASegmentedControl.vue';
-import ATextboxInput from './components/form/ATextboxInput.vue';
-import ATextInput from './components/form/ATextInput.vue';
-import type { BadgeDescriptor } from '@stonecrop/schema';
-import type { ColumnSchema } from '@stonecrop/schema';
-import ExpandButton from './components/base/ExpandButton.vue';
-import type { FieldOptions } from '@stonecrop/schema';
-import type { FieldValidation } from '@stonecrop/schema';
-import type { GetRecordsOptions } from '@stonecrop/schema';
-import type { GetRecordsResult } from '@stonecrop/schema';
-import { InteractionMode } from '@stonecrop/schema';
-import Login from './components/utilities/Login.vue';
-import type { TableViewConfig } from '@stonecrop/schema';
-import type { ValueField } from '@stonecrop/schema';
-
-export { ABadge }
-
-export { ACheckbox }
-
-export { ACurrencyInput }
-
-export { ADate }
-
-export { ADatePicker }
-
-export { ADateRange }
-
-export { ADateSelection }
-
-export { ADateTime }
-
-export { ADateTimeInput }
-
-export { ADropdown }
-
-export { ADuration }
-
-export { AFieldset }
-
-export { AFileAttach }
-
-export { AForm }
-
-export { AFormLink }
-
-/**
- * What AFormLink accepts as its `v-model`.
- *
- * Wider than {@link AFormLinkValue} because a link is as often bound straight to its FK column as
- * to a resolved reference: a record loaded from the DB carries the raw scalar, and a parent bound
- * to that column coerces every update it receives back to a scalar. The component reads through
- * `linkId`/`linkDisplayText`/`asLinkValue`, so all three shapes render and resolve identically.
- *
- * Emitting is narrower — AFormLink always writes back an {@link AFormLinkValue}.
- * @public
- */
-export declare type AFormLinkModelValue = AFormLinkValue | string | number;
-
-/**
- * Navigation contract for AFormLink. Provide via `provide('aformLinkNavigator', ...)` in the app plugin.
- * @public
- */
-export declare interface AFormLinkNavigator {
-    /** Navigate to the linked document. Implementation is app-defined. */
-    navigate(doctype: string, id: string | number): void;
-}
-
-/**
- * The value shape for AFormLink — a linked document reference with optional display text
- * @public
- */
-export declare interface AFormLinkValue {
-    /** The FK/linked document ID. `id: 0` is a valid ID. */
-    id: string | number;
-    /** Display text shown in the input. Falls back to `String(id)` if omitted. */
-    displayText?: string;
-    /** Additional properties passed through to the underlying input component */
-    [extra: string]: any;
-}
-
-export { AFormLoading }
-
-export { ANumericInput }
-
-export { AQuantityInput }
-
-export { ASegmentedControl }
-
-export { ATextboxInput }
-
-export { ATextInput }
-
-/**
- * Row context passed to badge `format` functions in form fields.
- * @public
- */
-export declare type BadgeFormatContext = {
-    record?: Record<string, unknown>;
-    row?: Record<string, unknown>;
-};
-
-/**
- * Badge-aware field `format` function signature.
- * @public
- */
-export declare type BadgeFormatFn = (value: unknown, context: BadgeFormatContext) => string | BadgeDescriptor;
-
-/**
- * CSS custom properties for input-accent styling on a native input.
- * @public
- */
-export declare function badgeInputAccentStyle(descriptor: BadgeDescriptor | undefined): Record<string, string> | undefined;
-
-/**
- * Defined props for AForm components
- * @public
- */
-export declare type ComponentProps = {
-    /**
-     * The schema object to pass to the component
-     * @public
-     */
-    schema?: ResolvedField;
-    /**
-     * The label to display in the component
-     * @public
-     */
-    label?: string;
-    selectRange?: boolean;
-    /**
-     * The mask to apply to inputs inside the component. Accepts either a plain
-     * mask string (e.g. `"(###) ###-####"`) or a stringified arrow function that
-     * receives `locale` and returns a mask string
-     * (e.g. `"(locale) => locale === 'en-US' ? '(###) ###-####' : '####-######'"`).
-     * @public
-     */
-    mask?: string;
-    /**
-     * Indicate whether input is required for text and/or select elements inside the component
-     * @public
-     */
-    required?: boolean;
-    /**
-     * The rendering mode for the component
-     * @public
-     */
-    mode?: InteractionMode;
-    /**
-     * Set a unique identifier for elements inside the component
-     * @public
-     */
-    uuid?: string;
-    /**
-     * Validation options for elements inside the component
-     * @public
-     */
-    validation?: {
-        /**
-         * The error message to display when validation fails
-         * @public
-         */
-        errorMessage: string;
-        [key: string]: any;
-    };
-    /**
-     * Inline validation error messages to display on this field. Fed by the host
-     * (e.g. mapped from the core validation store) — the renderer stays dumb and just
-     * shows what it is given. Takes precedence over the static `validation.errorMessage`.
-     * @public
-     */
-    errors?: string[];
-};
-
-/**
- * Type-specific configuration for ACurrencyInput, passed via the field's `options` property.
- * @public
- */
-export declare interface CurrencyOptions {
-    /** Currency doctype name, used for FK resolution via `aformLinkResolver`. The currency picker is embedded, so it renders no navigate button. */
-    doctype?: string;
-    /** The record's base currency — fixed, not user-editable. A bare id resolves to displayText via `aformLinkResolver`. */
-    baseCurrency?: AFormLinkValue | string;
-    /** Exchange rate lookup for each non-base currency id, relative to `baseCurrency` (which is implicitly `1`) */
-    exchangeRates?: Record<string, number>;
-    /** Decimal places to round the derived `baseAmount` to — the base currency's scale (JPY carries 0, most carry 2, KWD 3). Applies only to `baseAmount`; the entered `amount` is left as typed. Omit to round only enough to shed binary floating-point noise, which never discards a digit the rate actually produced. A non-integer or out-of-range value falls back to that default. */
-    precision?: number;
-    /** Search function backing the `currency` autocomplete dropdown — see AFormLink's `filterFunction` */
-    filterFunction?: string | ((search: string) => AFormLinkValue[] | Promise<AFormLinkValue[]>);
-    /** Whether `filterFunction` results should show a loading state — see AFormLink's `isAsync` */
-    isAsync?: boolean;
-}
-
-/**
- * The value shape for ACurrencyInput — an amount paired with its currency (an
- * {@link AFormLinkValue} FK reference), plus the derived base-currency-equivalent amount.
- * `exchangeRate` is carried on the value so it round-trips with the record even though it is
- * never directly edited by the user.
- * @public
- */
-export declare interface CurrencyValue {
-    /** The entered amount, in `currency` units */
-    amount: number;
-    /** FK reference to the Currency doctype the user entered `amount` in */
-    currency: AFormLinkValue;
-    /** `amount` converted into `baseCurrency` units — `amount * exchangeRate` */
-    baseAmount: number;
-    /** The record's base currency — fixed, not user-editable */
-    baseCurrency: AFormLinkValue;
-    /** Multiplier from `currency` to `baseCurrency` — hidden from the UI, drives `baseAmount` */
-    exchangeRate: number;
-}
-
-/**
- * Deserializes a stringified function expression into a typed callable.
- *
- * Throws if the string cannot be parsed as a function (SyntaxError) or if the
- * resulting expression is not callable (TypeError), or if the expression references
- * an undefined variable (ReferenceError). Callers are responsible for try/catch.
- *
- * @example
- * ```ts
- * const fn = deserializeFunction<(x: number) => number>('(x) => x * 2')
- * fn(5) // 10
- * ```
- * @public
- */
-export declare function deserializeFunction<T extends (...args: any[]) => any>(source: string): T;
-
-export { ExpandButton }
-
-/**
- * Install all AForm components
- * @param app - Vue app instance
- * @public
- */
-export declare function install(app: App): void;
-
-export { InteractionMode }
-
-export { Login }
-
-/**
- * Type-specific configuration for AQuantityInput, passed via the field's `options` property.
- * @public
- */
-export declare interface QuantityOptions {
-    /** Dropdown choices for the `uom` field */
-    uoms?: string[];
-    /** The item's base/stock unit of measure — fixed, not user-editable */
-    stockUom?: string;
-    /** Conversion factor lookup for each non-stock UOM, relative to `stockUom` (which is implicitly `1`) */
-    conversionFactors?: Record<string, number>;
-}
-
-/**
- * The value shape for AQuantityInput — a quantity paired with its unit of measure, plus the
- * derived stock-equivalent quantity/UOM. `conversionFactor` is carried on the value so it
- * round-trips with the record even though it is never shown in the UI.
- * @public
- */
-export declare interface QuantityValue {
-    /** The entered quantity, in `uom` units */
-    qty: number;
-    /** Unit of measure the user entered `qty` in */
-    uom: string;
-    /** `qty` converted into `stockUom` units — `qty * conversionFactor` */
-    stockQty: number;
-    /** The item's base/stock unit of measure — fixed, not user-editable */
-    stockUom: string;
-    /** Multiplier from `uom` to `stockUom` — hidden from the UI, drives `stockQty` */
-    conversionFactor: number;
-}
-
-/**
- * The discriminated union of all resolved field types — what AForm consumes,
- * usually after `resolveSchema()` has transformed the authoring `DoctypeField[]`,
- * but also valid hand-authored for view chrome with no backing doctype.
- * Narrowed by `kind`: `'field'` | `'link'` | `'table'` | `'fieldset'`.
- *
- * `kind` is required — AForm dispatches on it alone and does not infer a field's
- * type from its structure.
- * @public
- */
-export declare type ResolvedField = ResolvedScalar | ResolvedLink | ResolvedTable | ResolvedFieldset;
-
-/**
- * A resolved fieldset — groups child fields inside an AFieldset component.
- * @public
- */
-export declare interface ResolvedFieldset {
-    /** Discriminator */
-    kind: 'fieldset';
-    /** Field identifier */
-    fieldname: string;
-    /** Component to render; defaults to `'AFieldset'` */
-    component?: string;
-    /** Human-readable label for the legend */
-    label?: string;
-    /** Whether the fieldset can be collapsed */
-    collapsible?: boolean;
-    /** Interaction mode for all children */
-    mode?: InteractionMode;
-    /** Resolved child fields */
-    schema: ResolvedField[];
-}
-
-/**
- * The resolved fields that can be columns in a list or table view, in declaration order.
- *
- * A cell renders one value, so only `kind: 'field'` qualifies. The other three kinds are
- * containers: a `fieldset` groups fields for layout and has no value of its own, while a `link`
- * and a `table` hold a nested record and an array of them. Neither has a `cellComponent`, so a
- * container reaching `ACell` falls through to plain-text rendering and stringifies its children —
- * no error and no log, just a wrong column.
- *
- * A fieldset's *children* are real columns, so it is flattened rather than dropped; losing them is
- * the same silent defect in the other direction.
- *
- * One definition, called by both consumers: `Registry.buildTableConfig` (a child table's columns,
- * from its target's resolved schema) and Desktop's records list. Re-deriving it at either call
- * site produced exactly one of the two failures above at each.
- *
- * @param fields - resolved fields, as produced by `resolveSchema`
- * @returns column definitions, with the `kind` discriminator stripped
- * @public
- */
-export declare function resolvedFieldsToColumns(fields: readonly ResolvedField[]): ColumnSchema[];
-
-/**
- * A resolved Link field with cardinality `one` or `atMostOne` — embedded as a nested form.
- * @public
- */
-export declare interface ResolvedLink {
-    /** Discriminator */
-    kind: 'link';
-    /** Field identifier */
-    fieldname: string;
-    /** Component to render; defaults to `'AForm'` */
-    component: string;
-    /** Human-readable label */
-    label?: string;
-    /** Interaction mode */
-    mode?: InteractionMode;
-    /** Resolved child fields */
-    schema: ResolvedField[];
-    /** Preserved from the original ValueField */
-    required?: boolean;
-    /** Preserved from the original ValueField */
-    readOnly?: boolean;
-    /** Preserved from the original ValueField */
-    hidden?: boolean;
-    /** Preserved from the original ValueField */
-    default?: unknown;
-    /** Preserved from the original ValueField */
-    validation?: FieldValidation;
-}
-
-/**
- * A resolved scalar field. Derived from ValueField with `cardinality` omitted
- * (consumed by resolveSchema) and an optional `doctype` added for unresolved Link fields.
- * @public
- */
-export declare type ResolvedScalar = Omit<ValueField, 'cardinality'> & {
-    /** Doctype slug for unresolved Link fields — added by resolveSchema when AFormLink is available */
-    doctype?: string;
-};
-
-/**
- * A resolved table — either from a Link with `noneOrMany`/`atLeastOne` cardinality,
- * or from an inline TableField. ATable receives columns via `:schema` (ColumnSchema[])
- * and row data via `:rows` from formData at render time.
- *
- * Note the key rename: an authoring `TableField` declares its columns under `columns`;
- * `resolveSchema` moves them to `schema` here, because `schema` is the ATable prop that
- * runs `schemaToColumns()` (ATable's own `columns` prop means already-converted
- * `TableColumn[]`). A hand-authored table must therefore use `schema`, not `columns`.
- *
- * Rows are never part of the schema. AForm sources them from the data model at
- * `dataModel[fieldname]`, so a `rows` key placed on this object is ignored.
- * @public
- */
-export declare interface ResolvedTable {
-    /** Discriminator */
-    kind: 'table';
-    /** Field identifier */
-    fieldname: string;
-    /** Component to render; defaults to `'ATable'` */
-    component: string;
-    /** Human-readable label */
-    label?: string;
-    /** Interaction mode for all cells */
-    mode?: InteractionMode;
-    /** Column definitions — passed to ATable's `:schema` prop */
-    schema: ColumnSchema[];
-    /** View configuration — always present; defaults to `{ view: 'list' }` */
-    config: TableViewConfig;
-    /** Preserved from the original ValueField or TableField */
-    required?: boolean;
-    /** Preserved from the original ValueField or TableField */
-    readOnly?: boolean;
-    /** Preserved from the original ValueField or TableField */
-    hidden?: boolean;
-    /** Preserved from the original ValueField or TableField */
-    default?: unknown;
-    /** Preserved from the original ValueField or TableField */
-    validation?: FieldValidation;
-    /** When set, ATable fetches list pages through this callback (server paging). */
-    getRecords?: (options?: GetRecordsOptions) => Promise<GetRecordsResult>;
-    /** When this changes, ATable refetches from offset 0. */
-    sourceKey?: string;
-}
-
-/**
- * Resolve a field value to a badge descriptor using format (if present) then options map.
- * @public
- */
-export declare function resolveFieldBadge(value: unknown, options: FieldOptions | undefined, format: string | BadgeFormatFn | undefined, context?: BadgeFormatContext): BadgeDescriptor | undefined;
-
-
-export * from "@stonecrop/atable/types";
-
-export { }

package/dist/aform.tsbuildinfo

@@ -1 +0,0 @@
-{"version":"6.0.3"}

package/dist/src/directives/mask.js

@@ -1,107 +0,0 @@
-import { deserializeFunction } from '../utils/deserialize';
-/**
- * Extracts a mask function from a stringified function
- * @param mask - Mask string
- * @returns Mask function, or undefined if the string is not a valid function expression
- */
-function extractMaskFn(mask) {
-    try {
-        return deserializeFunction(mask);
-    }
-    catch {
-        return undefined;
-    }
-}
-/**
- * Gets the mask for a given directive binding
- * @param binding - Binding object from directive hook
- * @returns Mask string
- */
-function getMask(binding) {
-    const mask = binding.value;
-    if (!mask)
-        return undefined;
-    const maskFn = extractMaskFn(mask);
-    if (maskFn) {
-        // TODO: (state) replace with state management;
-        // pass the entire form/table data to the function
-        // Vue directive reads arbitrary fields off host component instance; type is unknown at this layer.
-        // oxlint-disable-next-line typescript/no-unsafe-type-assertion
-        const instance = binding.instance;
-        // oxlint-disable-next-line typescript/no-unsafe-type-assertion
-        const locale = instance?.['locale'];
-        return maskFn(locale);
-    }
-    return mask;
-}
-/**
- * Unmasks the input string
- * @param input - Input string
- * @param maskToken - Mask token character
- * @returns Unmasked input string
- */
-function unmaskInput(input, maskToken) {
-    if (!maskToken) {
-        maskToken = '#';
-    }
-    let unmaskedInput = input;
-    const maskChars = [maskToken, '/', '-', '(', ')', ' '];
-    for (const char of maskChars) {
-        unmaskedInput = unmaskedInput.replaceAll(char, '');
-    }
-    return unmaskedInput;
-}
-/**
- * Fills the mask with the input string
- * @param input - Input string
- * @param mask - Mask string
- * @param maskToken - Mask token character
- * @returns Masked input string
- */
-function fillMask(input, mask, maskToken) {
-    if (!maskToken) {
-        maskToken = '#';
-    }
-    let replacement = mask;
-    for (const inputChar of input) {
-        const replaceIndex = replacement.indexOf(maskToken);
-        if (replaceIndex !== -1) {
-            const prefix = replacement.substring(0, replaceIndex);
-            const suffix = replacement.substring(replaceIndex + 1);
-            replacement = prefix + inputChar + suffix;
-        }
-    }
-    return replacement.slice(0, mask.length);
-}
-/**
- * Applies a mask to an input element
- * @param el - Input element
- * @param binding - Binding object from directive hook
- * @returns void
- * @public
- */
-export function useStringMask(el, binding) {
-    const mask = getMask(binding);
-    if (!mask)
-        return;
-    const maskToken = '#';
-    const inputText = el.value;
-    // process input value with mask
-    const unmaskedInput = unmaskInput(inputText, maskToken);
-    if (unmaskedInput) {
-        const replacement = fillMask(unmaskedInput, mask, maskToken);
-        // TODO: (state) this is very opinionated;
-        // most likely fixed with state management;
-        // a better way could be to emit back to instance;
-        // Vue directive reads/writes arbitrary fields on host component instance.
-        // oxlint-disable-next-line typescript/no-unsafe-type-assertion
-        const instance = binding.instance;
-        if (instance?.['maskFilled']) {
-            instance['maskFilled'] = !replacement.includes(maskToken);
-        }
-        el.value = replacement;
-    }
-    else {
-        el.value = mask;
-    }
-}