@streamline-pulse/formkrafter-core 0.20.0 → 0.22.0

package/dist/brick/brick.d.ts

@@ -7,6 +7,7 @@ import type { BrickSpec } from "../utils/brick-spec";
 import type { BrickType } from "../utils/brick-type";
 import type { BrickBaseConfigs, CommonBrickProps } from "../utils/common-brick-props";
 import type { BrickMoldDropType } from "../utils/drop-type";
+import type { FieldAnnotation } from "../review";
 export interface BrickProps<DataType, Configs extends BrickBaseConfigs, Styles> extends CommonBrickProps<Configs, Styles> {
     onConfigsChange?: (configs: BrickBaseConfigs & Record<string, unknown>, path?: string) => void;
     onStylesChange?: (styles: Record<string, unknown>, path?: string) => void;
@@ -22,6 +23,13 @@ export interface BrickProps<DataType, Configs extends BrickBaseConfigs, Styles>
     error?: string;
     disabled?: boolean;
     readOnly?: boolean;
+    /** A reviewer's note on this field, shown under the control. */
+    annotation?: FieldAnnotation;
+    /** Present in review mode: the controls to flag the field and comment it. */
+    review?: {
+        value: FieldAnnotation;
+        onChange: (next: FieldAnnotation) => void;
+    };
     locale?: string;
     children?: unknown;
     brickSpec?: BrickSpec;

package/dist/index.d.ts

@@ -7,6 +7,8 @@ export { BrickSpec, buildValidationSchema, iterateBricks, iterateSchemaBricks, d
 export { getBrickData, wrapBrickData } from "./utils/brick-data";
 export { SelectOption, normalizeOptions } from "./utils/options";
 export { RecapItem, collectRecapItems } from "./utils/recap";
+export { FieldDescriptor, CollectFieldsOptions, collectFields } from "./utils/fields";
+export { FieldAnnotation, FieldAnnotations, flaggedKeys } from "./review";
 export { SpecIssue, SpecIssueCode, lintSpec } from "./utils/lint-spec";
 export { ensureBrickUids, stripBrickUids, stripUidsFromPatches } from "./ops/uids";
 export { interpolateTemplate, parseHeaderLines, appendSearchParam } from "./utils/remote";

package/dist/index.js

@@ -17,7 +17,7 @@ var __toESM = (mod, isNodeMode, target) => {
       return cached;
   }
   target = mod != null ? __create(__getProtoOf(mod)) : {};
-  const to = isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target;
+  const to = isNodeMode || !mod || !mod.__esModule || !__hasOwnProp.call(mod, "default") ? __defProp(target, "default", { value: mod, enumerable: true }) : target;
   if (mod && typeof mod === "object" || typeof mod === "function") {
     for (let key of __getOwnPropNames(mod))
       if (!__hasOwnProp.call(to, key))
@@ -199,9 +199,9 @@ var require_scope = __commonJS(function(exports) {
     }
   }
   var UsedValueState;
-  (function(UsedValueState2) {
-    UsedValueState2[UsedValueState2["Started"] = 0] = "Started";
-    UsedValueState2[UsedValueState2["Completed"] = 1] = "Completed";
+  (function(UsedValueState) {
+    UsedValueState[UsedValueState["Started"] = 0] = "Started";
+    UsedValueState[UsedValueState["Completed"] = 1] = "Completed";
   })(UsedValueState || (exports.UsedValueState = UsedValueState = {}));
   exports.varKinds = {
     const: new code_1.Name("const"),
@@ -1183,9 +1183,9 @@ var require_util = __commonJS(function(exports) {
   }
   exports.useFunc = useFunc;
   var Type;
-  (function(Type2) {
-    Type2[Type2["Num"] = 0] = "Num";
-    Type2[Type2["Str"] = 1] = "Str";
+  (function(Type) {
+    Type[Type["Num"] = 0] = "Num";
+    Type[Type["Str"] = 1] = "Str";
   })(Type || (exports.Type = Type = {}));
   function getErrorPath(dataProp, dataPropType, jsPropertySyntax) {
     if (dataProp instanceof codegen_1.Name) {
@@ -1455,9 +1455,9 @@ var require_dataType = __commonJS(function(exports) {
   var codegen_1 = require_codegen();
   var util_1 = require_util();
   var DataType;
-  (function(DataType2) {
-    DataType2[DataType2["Correct"] = 0] = "Correct";
-    DataType2[DataType2["Wrong"] = 1] = "Wrong";
+  (function(DataType) {
+    DataType[DataType["Correct"] = 0] = "Correct";
+    DataType[DataType["Wrong"] = 1] = "Wrong";
   })(DataType || (exports.DataType = DataType = {}));
   function getSchemaTypes(schema) {
     const types = getJSONTypes(schema.type);
@@ -1853,8 +1853,8 @@ var require_keyword = __commonJS(function(exports) {
       gen.assign(valid, (0, codegen_1._)`${_await}${(0, code_1.callValidateCode)(cxt, validateRef, passCxt, passSchema)}`, def.modifying);
     }
     function reportErrs(errors) {
-      var _a2;
-      gen.if((0, codegen_1.not)((_a2 = def.valid) !== null && _a2 !== undefined ? _a2 : valid), errors);
+      var _a;
+      gen.if((0, codegen_1.not)((_a = def.valid) !== null && _a !== undefined ? _a : valid), errors);
     }
   }
   exports.funcKeywordCode = funcKeywordCode;
@@ -2635,8 +2635,8 @@ var require_validate = __commonJS(function(exports) {
       if (!this.allErrors)
         this.gen.if(cond);
     }
-    setParams(obj, assign2) {
-      if (assign2)
+    setParams(obj, assign) {
+      if (assign)
         Object.assign(this.params, obj);
       else
         this.params = obj;
@@ -3527,7 +3527,7 @@ var require_fast_uri = __commonJS(function(exports, module) {
     if (typeof uri === "string") {
       uri = normalizeString(uri, options);
     } else if (typeof uri === "object") {
-      uri = parse3(serialize(uri, options), options);
+      uri = parse(serialize(uri, options), options);
     }
     return uri;
   }
@@ -3545,8 +3545,8 @@ var require_fast_uri = __commonJS(function(exports, module) {
   function resolveComponent(base, relative, options, skipNormalization) {
     const target = {};
     if (!skipNormalization) {
-      base = parse3(serialize(base, options), options);
-      relative = parse3(serialize(relative, options), options);
+      base = parse(serialize(base, options), options);
+      relative = parse(serialize(relative, options), options);
     }
     options = options || {};
     if (!options.tolerant && relative.scheme) {
@@ -3791,7 +3791,7 @@ var require_fast_uri = __commonJS(function(exports, module) {
     }
     return { parsed, malformedAuthorityOrPort };
   }
-  function parse3(uri, opts) {
+  function parse(uri, opts) {
     return parseWithStatus(uri, opts).parsed;
   }
   function normalizeString(uri, opts) {
@@ -3820,7 +3820,7 @@ var require_fast_uri = __commonJS(function(exports, module) {
     resolveComponent,
     equal,
     serialize,
-    parse: parse3
+    parse
   };
   module.exports = fastUri;
   module.exports.default = fastUri;
@@ -6001,9 +6001,9 @@ var require_types = __commonJS(function(exports) {
   Object.defineProperty(exports, "__esModule", { value: true });
   exports.DiscrError = undefined;
   var DiscrError;
-  (function(DiscrError2) {
-    DiscrError2["Tag"] = "tag";
-    DiscrError2["Mapping"] = "mapping";
+  (function(DiscrError) {
+    DiscrError["Tag"] = "tag";
+    DiscrError["Mapping"] = "mapping";
   })(DiscrError || (exports.DiscrError = DiscrError = {}));
 });
 
@@ -7229,7 +7229,10 @@ var en = {
   "brick.row.name": "Row",
   "brick.column.name": "Column",
   "brick.stepper.name": "Stepper",
-  "brick.tabs.name": "Tabs"
+  "brick.tabs.name": "Tabs",
+  "review.incorrect": "Incorrect",
+  "review.comment": "Comment for the person who corrects it",
+  "review.flagged": "To correct"
 };
 var frFkTranslations = {
   "palette.search": "Rechercher une brique…",
@@ -7367,7 +7370,10 @@ var frFkTranslations = {
   "brick.row.name": "Ligne",
   "brick.column.name": "Colonne",
   "brick.stepper.name": "Étapes",
-  "brick.tabs.name": "Onglets"
+  "brick.tabs.name": "Onglets",
+  "review.incorrect": "Incorrect",
+  "review.comment": "Commentaire pour la personne qui corrige",
+  "review.flagged": "À corriger"
 };
 var GLOBAL_KEY = Symbol.for("formkrafter.i18n");
 var globalStore = globalThis;
@@ -7523,16 +7529,16 @@ var evalNode = (ctx, node) => {
             return;
           throw new Error(`Cannot call "${String(prop)}" of ${String(object)}`);
         }
-        const fn3 = object[prop];
-        if (typeof fn3 !== "function") {
-          if (node.optional === true && fn3 == null)
+        const fn2 = object[prop];
+        if (typeof fn2 !== "function") {
+          if (node.optional === true && fn2 == null)
             return;
           throw new Error(`"${String(prop)}" is not a function`);
         }
-        if (fn3 === Function || fn3 === eval) {
+        if (fn2 === Function || fn2 === eval) {
           throw new Error("This function is not allowed");
         }
-        return fn3.apply(object, args);
+        return fn2.apply(object, args);
       }
       const fn2 = evalNode(ctx, callee);
       if (typeof fn2 !== "function") {
@@ -7664,8 +7670,8 @@ var evalNode = (ctx, node) => {
         if (property.type === "SpreadElement") {
           const spread = evalNode(ctx, property.argument);
           if (spread && typeof spread === "object") {
-            for (const [key2, value] of Object.entries(spread)) {
-              result[String(guardProp(key2))] = value;
+            for (const [key, value] of Object.entries(spread)) {
+              result[String(guardProp(key))] = value;
             }
           }
           continue;
@@ -8083,8 +8089,8 @@ var collectRecapItems = (spec, dataMap, locale, showEmpty, groupBySections = fal
         label,
         columns: inputs.map((input) => brickLabel(input, locale)),
         rows: rows.map((row) => inputs.map((input) => {
-          const raw2 = row?.[input.configs.key];
-          return isEmptyRecapValue(raw2) ? "—" : formatRecapValue(input, raw2);
+          const raw = row?.[input.configs.key];
+          return isEmptyRecapValue(raw) ? "—" : formatRecapValue(input, raw);
         }))
       });
       continue;
@@ -8115,6 +8121,64 @@ var collectRecapItems = (spec, dataMap, locale, showEmpty, groupBySections = fal
   }
   return items;
 };
+// lib/utils/fields.ts
+var staticOptions = (brick) => {
+  const configs = brick.configs ?? {};
+  const source = typeof configs.optionsSource === "string" ? configs.optionsSource : "static";
+  if (source !== "static" || configs.options == null)
+    return;
+  const labelKey = typeof configs.labelKey === "string" ? configs.labelKey : "label";
+  const valueKey = typeof configs.valueKey === "string" ? configs.valueKey : "value";
+  const options = normalizeOptions(configs.options, labelKey, valueKey);
+  return options.length ? options : undefined;
+};
+var describe = (brick, path, locale) => {
+  const key = brick.configs?.key;
+  const label = resolveLocalizedText(brick.configs?.label, locale);
+  return {
+    key,
+    path,
+    label: typeof label === "string" && label ? label : key,
+    brick: brick.id,
+    type: brick.type,
+    dataType: brick.dataType,
+    multiple: brick.type === "input" && brick.dataType === "array",
+    required: (brick.validations ?? []).some((validation2) => validation2.validator === "required"),
+    options: staticOptions(brick)
+  };
+};
+var collectFields = (spec, locale, options = {}) => {
+  const out = [];
+  const walk = (brick, path, into) => {
+    if (!brick)
+      return;
+    const key = brick.configs?.key;
+    const named = typeof key === "string" && key !== "" && (options.includePrivate || !key.startsWith("_"));
+    if (brick.type === "collection") {
+      if (named) {
+        const field = describe(brick, path, locale);
+        field.columns = [];
+        for (const [index, child] of (brick.children ?? []).entries())
+          walk(child, `${path}.${index}`, field.columns);
+        into.push(field);
+      }
+      return;
+    }
+    if (brick.type === "input") {
+      if (named && brick.dataType && brick.dataType !== "void")
+        into.push(describe(brick, path, locale));
+      return;
+    }
+    if (brick.type === "panel") {
+      for (const [index, child] of (brick.children ?? []).entries())
+        walk(child, `${path}.${index}`, into);
+    }
+  };
+  walk(spec, "0", out);
+  return out;
+};
+// lib/review.ts
+var flaggedKeys = (annotations) => Object.entries(annotations ?? {}).filter(([, annotation]) => annotation?.incorrect === true).map(([key]) => key);
 // lib/utils/lint-spec.ts
 var isDataCarrying = (brick) => brick.type === "input" || brick.type === "collection";
 function lintSpec(spec) {
@@ -8502,8 +8566,8 @@ function addBrick(spec, brick, parentPath, index) {
   const parentPointer = pointerFromPath(parentPath);
   const value = toJsonValue(brick);
   if (!parent.children) {
-    const pointer2 = `${parentPointer}/children`;
-    return apply(spec, [{ op: "add", path: pointer2, value: [value] }], [{ op: "remove", path: pointer2 }]);
+    const pointer = `${parentPointer}/children`;
+    return apply(spec, [{ op: "add", path: pointer, value: [value] }], [{ op: "remove", path: pointer }]);
   }
   const position = Math.min(index ?? parent.children.length, parent.children.length);
   const pointer = `${parentPointer}/children/${position}`;
@@ -8818,7 +8882,7 @@ function convertComponent(component, ctx) {
         configs: {
           ...baseConfigs(component, ctx),
           optionsSource: "static",
-          options: emitOptions(staticOptions(component.values), component, ctx)
+          options: emitOptions(staticOptions2(component.values), component, ctx)
         }
       })
     ];
@@ -8833,7 +8897,7 @@ function convertComponent(component, ctx) {
         configs: {
           ...baseConfigs(component, ctx),
           optionsSource: "static",
-          options: emitOptions(staticOptions(component.values), component, ctx)
+          options: emitOptions(staticOptions2(component.values), component, ctx)
         }
       })
     ];
@@ -8921,7 +8985,7 @@ function convertSelect(component, ctx) {
       ctx.warn(`select "${component.key ?? "?"}" uses dataSrc "${component.dataSrc}" — converted to static options`);
     }
     configs.optionsSource = "static";
-    configs.options = emitOptions(staticOptions(component.data?.values ?? component.values), component, ctx);
+    configs.options = emitOptions(staticOptions2(component.data?.values ?? component.values), component, ctx);
   }
   return withCommon(component, ctx, {
     type: "input",
@@ -8968,7 +9032,7 @@ function labelKeyFromTemplate(template) {
   const match = /item\.([a-zA-Z0-9_.]+)/.exec(template);
   return match?.[1];
 }
-function staticOptions(values) {
+function staticOptions2(values) {
   return (values ?? []).map((option) => {
     if (!isPlainOptionObject(option))
       return scalarOption(option);
@@ -9214,6 +9278,7 @@ export {
   addBrick,
   appendSearchParam,
   buildValidationSchema,
+  collectFields,
   collectRecapItems,
   convertFormioForm,
   defaultFormData,
@@ -9224,6 +9289,7 @@ export {
   expandSpec,
   fkT,
   fkTOr,
+  flaggedKeys,
   frFkTranslations,
   getAffectedProperties,
   getBrickAt,
@@ -9257,5 +9323,5 @@ export {
   wrapBrickData
 };
 
-//# debugId=96AA46B0772C95DC64756E2164756E21
+//# debugId=3FF11B6D83F7254764756E2164756E21
 //# sourceMappingURL=index.js.map