@luomus/laji-form 15.1.119 → 15.1.121

package/lib/components/LajiForm.d.ts

@@ -313,6 +313,7 @@ export default class LajiForm extends React.Component<LajiFormProps, LajiFormSta
         MultiActiveArrayField: typeof fields.MultiActiveArrayField;
         PrefixArrayField: typeof fields.PrefixArrayField;
         FillDateRangeField: typeof fields.FillDateRangeField;
+        TaxaByYearPopulatorField: typeof fields.TaxaByYearPopulatorField;
         TaxonSetPopulatorField: typeof fields.TaxonSetPopulatorField;
         ScientificNameTaxonAutosuggestField: typeof fields.ScientificNameTaxonAutosuggestField;
         ArraySchemaField: typeof fields.SchemaField;
@@ -487,7 +488,7 @@ export default class LajiForm extends React.Component<LajiFormProps, LajiFormSta
     addEventListener: (target: typeof document | typeof window, name: string, fn: (e: Event) => void) => void;
     setTimeout: (fn: () => void, time?: number) => number;
     destroy: () => void;
-    getSchemaValidationErrors: (formData: any) => any;
+    getSchemaValidationErrors: (formData: any) => ErrorSchema;
     getFormDataReadyForSubmit: (formData: any, schema: JSONSchema) => {
         formData: any;
         removedArrayItemsAndObjects: string[];

package/lib/components/LajiForm.js

@@ -377,7 +377,7 @@ class LajiForm extends React.Component {
             ignoreErrorPaths.forEach(path => {
                 schemaErrors = (0, utils_1.immutableDelete)(schemaErrors, path);
             });
-            return schemaErrors;
+            return removeEmptyErrorObjects(schemaErrors);
         };
         this.getFormDataReadyForSubmit = (formData, schema) => {
             formData = this.memoizedFormContext.services.ids.removeLajiFormIds(formData);
@@ -597,6 +597,21 @@ const removeEmptyValuesAndTrim = (formData, schema) => {
         return formData;
     }
 };
+const removeEmptyErrorObjects = (errors) => {
+    const result = {};
+    for (const key of Object.keys(errors)) {
+        if (key === "__errors") {
+            result[key] = errors[key];
+        }
+        else if (errors[key]) {
+            const cleanedValue = removeEmptyErrorObjects(errors[key]);
+            if (Object.keys(cleanedValue).length > 0) {
+                result[key] = cleanedValue;
+            }
+        }
+    }
+    return Object.keys(result).length === 0 ? {} : result;
+};
 const getShortcuts = (uiSchema) => {
     var _a, _b;
     if ((_b = (_a = window.navigator) === null || _a === void 0 ? void 0 : _a.platform) === null || _b === void 0 ? void 0 : _b.includes("Mac")) {

package/lib/components/fields/TaxaByYearPopulatorField.d.ts

@@ -0,0 +1,45 @@
+import * as React from "react";
+import * as PropTypes from "prop-types";
+import { FieldProps } from "../../types";
+/**
+ * Watches a specified field which contains a year.
+ *
+ * Fetches taxa observed in the specified year and adds them to the units in formData.
+ *
+ * uiSchema = {
+ *   "ui:field": "TaxaByYearPopulatorField",
+ *   "ui:options": {
+ *     "collectionID": "HR.6920",                       // Collection ID to fetch documents from
+ *     "unitFilter": {                                  // Filter for units from fetched documents
+ *       "field": "observationStatus",                  // Field to filter on
+ *       "valueIn": ["MY.observationStatusObservedNoCount", ...] // Allowed values
+ *     }
+ *   }
+ * }
+ */
+export default class TaxaByYearPopulatorField extends React.Component<FieldProps> {
+    static propTypes: {
+        uiSchema: PropTypes.Validator<NonNullable<PropTypes.InferProps<{
+            "ui:options": PropTypes.Requireable<PropTypes.InferProps<{
+                collectionID: PropTypes.Requireable<string>;
+                unitFilter: PropTypes.Requireable<PropTypes.InferProps<{
+                    field: PropTypes.Validator<string>;
+                    valueIn: PropTypes.Validator<(string | null | undefined)[]>;
+                }>>;
+            }>>;
+            uiSchema: PropTypes.Requireable<object>;
+        }>>>;
+        schema: PropTypes.Validator<NonNullable<PropTypes.InferProps<{
+            type: PropTypes.Requireable<string>;
+        }>>>;
+        formData: PropTypes.Validator<object>;
+    };
+    static getName(): string;
+    getStateFromProps(): {
+        onChange: (formData: any) => Promise<void>;
+    };
+    componentDidMount(): Promise<void>;
+    onChange: (formData: any) => Promise<void>;
+    private populateTaxa;
+    private fetchTaxaFromNamedPlace;
+}

package/lib/components/fields/TaxaByYearPopulatorField.js

@@ -0,0 +1,190 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const React = __importStar(require("react"));
+const PropTypes = __importStar(require("prop-types"));
+const VirtualSchemaField_1 = __importDefault(require("../VirtualSchemaField"));
+const utils_1 = require("../../utils");
+const unitFilterPropType = PropTypes.shape({
+    field: PropTypes.string.isRequired,
+    valueIn: PropTypes.arrayOf(PropTypes.string).isRequired
+});
+/**
+ * Watches a specified field which contains a year.
+ *
+ * Fetches taxa observed in the specified year and adds them to the units in formData.
+ *
+ * uiSchema = {
+ *   "ui:field": "TaxaByYearPopulatorField",
+ *   "ui:options": {
+ *     "collectionID": "HR.6920",                       // Collection ID to fetch documents from
+ *     "unitFilter": {                                  // Filter for units from fetched documents
+ *       "field": "observationStatus",                  // Field to filter on
+ *       "valueIn": ["MY.observationStatusObservedNoCount", ...] // Allowed values
+ *     }
+ *   }
+ * }
+ */
+let TaxaByYearPopulatorField = class TaxaByYearPopulatorField extends React.Component {
+    constructor() {
+        super(...arguments);
+        this.onChange = (formData) => __awaiter(this, void 0, void 0, function* () {
+            yield this.populateTaxa(formData);
+        });
+    }
+    static getName() {
+        return "TaxaByYearPopulatorField";
+    }
+    getStateFromProps() {
+        return { onChange: this.onChange };
+    }
+    componentDidMount() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.populateTaxa(this.props.formData);
+        });
+    }
+    populateTaxa(formData) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g;
+            if (!((_a = formData === null || formData === void 0 ? void 0 : formData.gatheringEvent) === null || _a === void 0 ? void 0 : _a.dateBegin)) {
+                this.props.onChange(formData);
+                return;
+            }
+            const { collectionID, unitFilter } = (0, utils_1.getUiOptions)(this.props.uiSchema);
+            const namedPlace = formData === null || formData === void 0 ? void 0 : formData.namedPlaceID;
+            const observationYear = Number((_c = (_b = formData === null || formData === void 0 ? void 0 : formData.gatheringEvent) === null || _b === void 0 ? void 0 : _b.dateBegin) === null || _c === void 0 ? void 0 : _c.split("-")[0]) || undefined;
+            const res = yield this.fetchTaxaFromNamedPlace(this.props, collectionID, namedPlace, observationYear);
+            let fetchedUnits = res.flatMap(doc => doc.gatherings.flatMap(g => g.units));
+            if ((unitFilter === null || unitFilter === void 0 ? void 0 : unitFilter.field) && (unitFilter === null || unitFilter === void 0 ? void 0 : unitFilter.valueIn)) {
+                fetchedUnits = fetchedUnits.filter((u) => u[unitFilter.field] && unitFilter.valueIn.includes(u[unitFilter.field]));
+            }
+            if (fetchedUnits.length === 0) {
+                this.props.onChange(formData);
+                return;
+            }
+            const seen = new Set();
+            const identifications = fetchedUnits.flatMap(u => u.identifications).filter(id => {
+                if (!id.taxonID || seen.has(id.taxonID))
+                    return false;
+                seen.add(id.taxonID);
+                return true;
+            });
+            const tmpIdTree = this.props.formContext.services.ids.getRelativeTmpIdTree(this.props.idSchema.$id + "_units");
+            const formUnits = ((_e = (_d = formData.gatherings) === null || _d === void 0 ? void 0 : _d[0]) === null || _e === void 0 ? void 0 : _e.units)
+                ? [...formData.gatherings[0].units].filter((unit) => { var _a; return (_a = unit.unitFact) === null || _a === void 0 ? void 0 : _a.autocompleteSelectedTaxonID; })
+                : [];
+            identifications.forEach((identification) => {
+                if (!formUnits.some((u) => { var _a; return ((_a = u.unitFact) === null || _a === void 0 ? void 0 : _a.autocompleteSelectedTaxonID) === identification.taxonID; })) {
+                    formUnits.push((0, utils_1.addLajiFormIds)({
+                        identifications: [{
+                                taxon: identification.taxonVerbatim
+                            }],
+                        unitFact: {
+                            autocompleteSelectedTaxonID: identification.taxonID
+                        }
+                    }, tmpIdTree, false)[0]);
+                }
+            });
+            this.props.onChange(Object.assign(Object.assign({}, formData), { gatherings: [
+                    Object.assign(Object.assign({}, (((_f = formData.gatherings) === null || _f === void 0 ? void 0 : _f[0]) || {})), { units: formUnits }),
+                    ...(((_g = formData.gatherings) === null || _g === void 0 ? void 0 : _g.slice(1)) || [])
+                ] }));
+            return;
+        });
+    }
+    fetchTaxaFromNamedPlace(props, collectionID, namedPlace, observationYear) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const apiClient = (_a = props.formContext) === null || _a === void 0 ? void 0 : _a.apiClient;
+            if (!apiClient) {
+                return [];
+            }
+            try {
+                const response = yield apiClient.get("/documents", {
+                    query: {
+                        collectionID,
+                        namedPlace,
+                        observationYear,
+                        selfAsEditorOrCreator: true,
+                        pageSize: 1000,
+                        page: 1
+                    }
+                });
+                if (!response.results || !Array.isArray(response.results)) {
+                    return [];
+                }
+                return response.results;
+            }
+            catch (error) {
+                return [];
+            }
+        });
+    }
+};
+TaxaByYearPopulatorField.propTypes = {
+    uiSchema: PropTypes.shape({
+        "ui:options": PropTypes.shape({
+            collectionID: PropTypes.string,
+            unitFilter: unitFilterPropType
+        }),
+        uiSchema: PropTypes.object
+    }).isRequired,
+    schema: PropTypes.shape({
+        type: PropTypes.oneOf(["array", "object"])
+    }).isRequired,
+    formData: PropTypes.oneOfType([PropTypes.array, PropTypes.object]).isRequired
+};
+TaxaByYearPopulatorField = __decorate([
+    VirtualSchemaField_1.default
+], TaxaByYearPopulatorField);
+exports.default = TaxaByYearPopulatorField;

package/lib/components/fields/TaxonSetPopulatorField.js

@@ -54,7 +54,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const React = __importStar(require("react"));
 const PropTypes = __importStar(require("prop-types"));
 const VirtualSchemaField_1 = __importDefault(require("../VirtualSchemaField"));
-const utils_1 = require("../..//utils");
+const utils_1 = require("../../utils");
 const propsPropType = PropTypes.shape({
     from: PropTypes.string.isRequired,
     fromArrayKey: PropTypes.string,

package/lib/components/fields/index.d.ts

@@ -67,6 +67,7 @@ export { default as CondensedObjectField } from "./CondensedObjectField";
 export { default as MultiActiveArrayField } from "./MultiActiveArrayField";
 export { default as PrefixArrayField } from "./PrefixArrayField";
 export { default as FillDateRangeField } from "./FillDateRangeField";
+export { default as TaxaByYearPopulatorField } from "./TaxaByYearPopulatorField";
 export { default as TaxonSetPopulatorField } from "./TaxonSetPopulatorField";
 export { default as ScientificNameTaxonAutosuggestField } from "./ScientificNameTaxonAutosuggestField";
 export { default as ArraySchemaField } from "./SchemaField";

package/lib/components/fields/index.js

@@ -4,7 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FakePropertyField = exports.ImageDisplayField = exports.LocalityField = exports.DataLeakerField = exports.LocationChooserField = exports.UnitListShorthandArrayField = exports.EnumRangeArrayField = exports.AnyToBooleanField = exports.PrefillingArrayField = exports.AnnotationField = exports.ConditionalUiSchemaField = exports.ConditionalOnChangeField = exports.StringToArrayField = exports.TagArrayField = exports.GeocoderField = exports.MapField = exports.NamedPlaceSaverField = exports.NamedPlaceChooserField = exports.SumField = exports.ExtraLabelRowField = exports.UiFieldMapperArrayField = exports.CombinedValueDisplayField = exports.UnitShorthandField = exports.SingleItemArrayField = exports.SingleActiveArrayField = exports.FlatField = exports.SplitField = exports.ImageArrayField = exports.ContextInjectionField = exports.InitiallyHiddenField = exports.HiddenWithTextField = exports.HiddenField = exports.AutosuggestField = exports.AutoArrayField = exports.MapArrayField = exports.DependentDisableField = exports.DependentBooleanField = exports.ArrayCombinerField = exports.InjectDefaultValueField = exports.InjectField = exports.TableField = exports.GridLayoutField = exports.SelectTreeField = exports.ScopeField = exports.ArrayPropertyCountField = exports.ArrayPropertySumField = exports.NestField = exports.ObjectField = exports.ArrayField = exports.SchemaField = void 0;
-exports.AccordionArrayField = exports.UnitRapidField = exports.ConditionalField = exports.InputTransformerField = exports.ArraySchemaField = exports.ScientificNameTaxonAutosuggestField = exports.TaxonSetPopulatorField = exports.FillDateRangeField = exports.PrefixArrayField = exports.MultiActiveArrayField = exports.CondensedObjectField = exports.AsArrayField = exports.PdfArrayField = exports.MultiTagArrayField = exports.InputWithDefaultValueButtonField = exports.SortArrayField = exports.MultiLanguageField = exports.UiFieldApplierField = exports.DefaultValueArrayField = exports.ToggleAdditionalArrayFieldsField = exports.UnitCountShorthandField = exports.MultiAnyToBooleanField = exports.FilterArrayField = exports.AudioArrayField = exports.MultiArrayField = exports.SectionArrayField = void 0;
+exports.AccordionArrayField = exports.UnitRapidField = exports.ConditionalField = exports.InputTransformerField = exports.ArraySchemaField = exports.ScientificNameTaxonAutosuggestField = exports.TaxonSetPopulatorField = exports.TaxaByYearPopulatorField = exports.FillDateRangeField = exports.PrefixArrayField = exports.MultiActiveArrayField = exports.CondensedObjectField = exports.AsArrayField = exports.PdfArrayField = exports.MultiTagArrayField = exports.InputWithDefaultValueButtonField = exports.SortArrayField = exports.MultiLanguageField = exports.UiFieldApplierField = exports.DefaultValueArrayField = exports.ToggleAdditionalArrayFieldsField = exports.UnitCountShorthandField = exports.MultiAnyToBooleanField = exports.FilterArrayField = exports.AudioArrayField = exports.MultiArrayField = exports.SectionArrayField = void 0;
 var SchemaField_1 = require("./SchemaField");
 Object.defineProperty(exports, "SchemaField", { enumerable: true, get: function () { return __importDefault(SchemaField_1).default; } });
 var ArrayField_1 = require("./ArrayField");
@@ -143,6 +143,8 @@ var PrefixArrayField_1 = require("./PrefixArrayField");
 Object.defineProperty(exports, "PrefixArrayField", { enumerable: true, get: function () { return __importDefault(PrefixArrayField_1).default; } });
 var FillDateRangeField_1 = require("./FillDateRangeField");
 Object.defineProperty(exports, "FillDateRangeField", { enumerable: true, get: function () { return __importDefault(FillDateRangeField_1).default; } });
+var TaxaByYearPopulatorField_1 = require("./TaxaByYearPopulatorField");
+Object.defineProperty(exports, "TaxaByYearPopulatorField", { enumerable: true, get: function () { return __importDefault(TaxaByYearPopulatorField_1).default; } });
 var TaxonSetPopulatorField_1 = require("./TaxonSetPopulatorField");
 Object.defineProperty(exports, "TaxonSetPopulatorField", { enumerable: true, get: function () { return __importDefault(TaxonSetPopulatorField_1).default; } });
 var ScientificNameTaxonAutosuggestField_1 = require("./ScientificNameTaxonAutosuggestField");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@luomus/laji-form",
-  "version": "15.1.119",
+  "version": "15.1.121",
   "description": "React module capable of building dynamic forms from Laji form json schemas",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

package/test-export/test-utils.d.ts

@@ -268,4 +268,5 @@ export declare const maybeJSONPointerToLocator: (pointer: string) => string;
 /** Fills value into given input and presses tab to unfocus it. Useful for inputs with debounce */
 export declare const updateValue: ($input: Locator, value: string) => Promise<void>;
 export declare const getRemoveUnit: (page: Page) => (gatheringIdx: number, unitIdx: number) => Promise<void>;
+export declare const getRemoveIdentification: (page: Page) => (gatheringIdx: number, unitIdx: number, identificationIdx: number) => Promise<void>;
 export {};

package/test-export/test-utils.js

@@ -53,7 +53,7 @@ var __rest = (this && this.__rest) || function (s, e) {
     return t;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getRemoveUnit = exports.updateValue = exports.maybeJSONPointerToLocator = exports.filterUUIDs = exports.mockImageMetadata = exports.DemoPageForm = exports.Form = exports.getFocusedId = exports.getFocusedElement = exports.lajiFormLocate = exports.lajiFormLocator = exports.navigateToForm = exports.emptyForm = void 0;
+exports.getRemoveIdentification = exports.getRemoveUnit = exports.updateValue = exports.maybeJSONPointerToLocator = exports.filterUUIDs = exports.mockImageMetadata = exports.DemoPageForm = exports.Form = exports.getFocusedId = exports.getFocusedElement = exports.lajiFormLocate = exports.lajiFormLocator = exports.navigateToForm = exports.emptyForm = void 0;
 exports.createForm = createForm;
 const path = __importStar(require("path"));
 const test_utils_1 = require("@luomus/laji-map/test-export/test-utils");
@@ -415,3 +415,8 @@ const getRemoveUnit = (page) => (gatheringIdx, unitIdx) => __awaiter(void 0, voi
     return page.locator(`#root_gatherings_${gatheringIdx}_units_${unitIdx}-delete-confirm-yes`).click();
 });
 exports.getRemoveUnit = getRemoveUnit;
+const getRemoveIdentification = (page) => (gatheringIdx, unitIdx, identificationIdx) => __awaiter(void 0, void 0, void 0, function* () {
+    yield page.locator(`#root_gatherings_${gatheringIdx}_units_${unitIdx}_identifications_${identificationIdx}-delete`).click();
+    return page.locator(`#root_gatherings_${gatheringIdx}_units_${unitIdx}_identifications_${identificationIdx}-delete-confirm-yes`).click();
+});
+exports.getRemoveIdentification = getRemoveIdentification;