@streamline-pulse/formkrafter-core 0.21.0 → 0.23.0

package/dist/review.d.ts

@@ -0,0 +1,10 @@
+/** What a reviewer said about one field, keyed by the brick `key`. */
+export interface FieldAnnotation {
+    /** The value must be corrected. */
+    incorrect?: boolean;
+    /** Free text shown to whoever corrects the field. */
+    comment?: string;
+}
+export type FieldAnnotations = Record<string, FieldAnnotation>;
+/** Keys flagged as incorrect: the fields a correction step lets the applicant edit. */
+export declare const flaggedKeys: (annotations: FieldAnnotations | undefined) => string[];

package/dist/utils/fields.d.ts

@@ -0,0 +1,34 @@
+import type { SelectOption } from "./options";
+import type { BrickSpec } from "./brick-spec";
+import type { JSONSchemaType } from "../validators/json-schema-type";
+/** One data-bearing brick of a spec, described independently of any renderer. */
+export interface FieldDescriptor {
+    /** Data key (`configs.key`). */
+    key: string;
+    /** Spec path, as `iterateBricks` yields it (`"0.2.1"`). */
+    path: string;
+    /** Label resolved for the locale, falling back to the key. */
+    label: string;
+    /** Brick id (`text`, `select`, `data-grid`, ...). */
+    brick: string;
+    type: "input" | "collection";
+    dataType?: JSONSchemaType;
+    /** Several values among `options` (multi select, select boxes, tags). */
+    multiple: boolean;
+    required: boolean;
+    /** Static options only; remote, catalog and computed sources are not resolved here. */
+    options?: SelectOption[];
+    /** For a collection, the fields of one row. */
+    columns?: FieldDescriptor[];
+}
+export interface CollectFieldsOptions {
+    /** Keep keys starting with `_` (never part of the submitted data). Default false. */
+    includePrivate?: boolean;
+}
+/**
+ * Lists the fields a form collects: every input and collection with a key,
+ * in document order, with the label, static options and requiredness a
+ * backend or an assistant needs to read or fill the data. Panels are
+ * flattened; a collection is one field whose `columns` describe a row.
+ */
+export declare const collectFields: (spec: BrickSpec | undefined, locale?: string, options?: CollectFieldsOptions) => FieldDescriptor[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@streamline-pulse/formkrafter-core",
-  "version": "0.21.0",
+  "version": "0.23.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",