@truedat/dd 4.40.9 → 4.40.12

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [4.40.10] 2022-03-21
+
+### Changed
+
+- [TD-4447] Support for associating metadata filters with a structure type
+
+### Removed
+
+- [TD-4303] `GET /api/data_structure_types/lite` was removed, reverted
+  corresponding changes from [TD-4344]
+
 ## [4.40.7] 2022-03-18
 
 ### Added
@@ -10,7 +21,7 @@
 
 ### Changed
 
-- [TD-4500] Remove unnecessary domain_id attribute on GrantRequestApprovalForm
+- [TD-4500] Remove unnecessary `domain_id` attribute on `GrantRequestApprovalForm`
 
 ## [4.40.2] 2022-03-14
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@truedat/dd",
-  "version": "4.40.9",
+  "version": "4.40.12",
   "description": "Truedat Web Data Dictionary",
   "sideEffects": false,
   "jsnext:main": "src/index.js",
@@ -34,7 +34,7 @@
     "@testing-library/jest-dom": "^5.14.1",
     "@testing-library/react": "^12.0.0",
     "@testing-library/user-event": "^13.2.1",
-    "@truedat/test": "4.40.9",
+    "@truedat/test": "4.40.12",
     "babel-jest": "^27.0.6",
     "babel-plugin-dynamic-import-node": "^2.3.3",
     "babel-plugin-lodash": "^3.3.4",
@@ -84,9 +84,9 @@
     ]
   },
   "dependencies": {
-    "@truedat/auth": "4.40.9",
-    "@truedat/core": "4.40.9",
-    "@truedat/df": "4.40.9",
+    "@truedat/auth": "4.40.12",
+    "@truedat/core": "4.40.12",
+    "@truedat/df": "4.40.12",
     "lodash": "^4.17.21",
     "path-to-regexp": "^1.7.0",
     "prop-types": "^15.7.2",
@@ -107,5 +107,5 @@
     "react-dom": ">= 16.8.6 < 17",
     "semantic-ui-react": ">= 0.88.2 < 2.1"
   },
-  "gitHead": "618928c0c77ccea1e95b9a6d3255ecf8cbed0c90"
+  "gitHead": "f8f89f659e97ba1eeb39d9f86c9b8c2c8934518a"
 }

package/src/api.js

@@ -31,7 +31,6 @@ const API_STRUCTURE_TAG = "/api/data_structure_tags/:id";
 const API_STRUCTURE_TAGS = "/api/data_structure_tags";
 const API_STRUCTURE_TYPE = "/api/data_structure_types/:id";
 const API_STRUCTURE_TYPES = "/api/data_structure_types";
-const API_STRUCTURE_TYPES_LITE = "/api/data_structure_types/lite";
 const API_STRUCTURES_TAG = "/api/data_structures/:data_structure_id/tags/:id";
 const API_STRUCTURES_TAGS = "/api/data_structures/:data_structure_id/tags";
 const API_USER_SEARCH_FILTERS = "/api/user_search_filters";
@@ -77,7 +76,6 @@ export {
   API_STRUCTURE_TAGS,
   API_STRUCTURE_TYPE,
   API_STRUCTURE_TYPES,
-  API_STRUCTURE_TYPES_LITE,
   API_USER_SEARCH_FILTERS,
   API_USER_SEARCH_FILTER,
   API_GET_USER_SEARCH_FILTERS,

package/src/components/DictionaryRoutes.js

@@ -48,7 +48,7 @@ export const DictionaryRoutes = () => {
         path={STRUCTURES}
         render={() => (
           <>
-            <StructureTypesLoader liteRequest={true} />
+            <StructureTypesLoader />
             <SystemsLoader />
             <StructuresRoutes />
           </>
@@ -58,7 +58,7 @@ export const DictionaryRoutes = () => {
         path={SYSTEMS}
         render={() => (
           <>
-            <StructureTypesLoader liteRequest={true} />
+            <StructureTypesLoader />
             <SystemsLoader />
             <SystemsRoutes />
           </>
@@ -68,7 +68,7 @@ export const DictionaryRoutes = () => {
         path={STRUCTURE_TAGS}
         render={() => (
           <>
-            <StructureTypesLoader liteRequest={true} />
+            <StructureTypesLoader />
             <StructureTagsRoutes />
           </>
         )}
@@ -77,7 +77,7 @@ export const DictionaryRoutes = () => {
         path={STRUCTURE_TYPES}
         render={() => (
           <>
-            <StructureTypesLoader liteRequest={true} />
+            <StructureTypesLoader />
             <StructureTypesRoutes />
           </>
         )}
@@ -86,7 +86,7 @@ export const DictionaryRoutes = () => {
         path={PROFILE_GROUP}
         render={() => (
           <>
-            <StructureTypesLoader liteRequest={true} />
+            <StructureTypesLoader />
             <Route render={() => <ProfileGroupLoader />} />
             <Switch>
               <Route

package/src/components/MetadataFiltersInput.js

@@ -0,0 +1,42 @@
+import _ from "lodash/fp";
+import React from "react";
+import PropTypes from "prop-types";
+import { Controller } from "react-hook-form";
+import { useIntl } from "react-intl";
+import { Form } from "semantic-ui-react";
+
+export const MetadataFiltersInput = ({ control, fieldOptions, fields }) => {
+  const { formatMessage } = useIntl();
+  return (
+    <Controller
+      control={control}
+      name="filters"
+      defaultValue={_.isArray(fields) ? fields : []}
+      render={({ onBlur, onChange, value }) => (
+        <Form.Dropdown
+          name="filters"
+          label={formatMessage({ id: "structureType.filters" })}
+          search
+          selection
+          clearable
+          multiple
+          options={fieldOptions}
+          onBlur={onBlur}
+          onChange={(_e, { value }) => onChange(value)}
+          placeholder={formatMessage({
+            id: "structureType.filters.placeholder",
+          })}
+          value={value}
+        />
+      )}
+    />
+  );
+};
+
+MetadataFiltersInput.propTypes = {
+  control: PropTypes.object,
+  fieldOptions: PropTypes.array,
+  fields: PropTypes.array,
+};
+
+export default MetadataFiltersInput;

package/src/components/StructureSelector.js

@@ -35,7 +35,7 @@ export const StructureSelector = ({
   return (
     <Segment>
       <StructuresLoader pageSize={pageSize} defaultFilters={defaultFilters} />
-      <StructureTypesLoader liteRequest={true} />
+      <StructureTypesLoader />
       <StructureFiltersLoader defaultFilters={defaultFilters} />
       <StructuresSearch />
       <StructureSelectedFilters />

package/src/components/StructureTypeForm.js

@@ -3,7 +3,7 @@ import React from "react";
 import PropTypes from "prop-types";
 import { connect } from "react-redux";
 import { useForm, useFieldArray, Controller } from "react-hook-form";
-import { useIntl } from "react-intl";
+import { useIntl, FormattedMessage } from "react-intl";
 import {
   accentInsensitiveOrder,
   accentInsensitivePathOrder,
@@ -11,6 +11,7 @@ import {
 import { HistoryBackButton } from "@truedat/core/components";
 import { Button, Form } from "semantic-ui-react";
 import { updateStructureType } from "../routines";
+import MetadataFiltersInput from "./MetadataFiltersInput";
 import MetadataViewForm from "./MetadataViewForm";
 
 export const StructureTypeForm = ({
@@ -24,6 +25,7 @@ export const StructureTypeForm = ({
   const { handleSubmit, control, formState } = useForm({
     mode: "all",
     defaultValues: {
+      filters: structureType?.filters || [],
       metadata_views: structureType?.metadata_views || [],
       template_id: structureType?.template?.id || "",
       translation: structureType?.translation || "",
@@ -88,6 +90,13 @@ export const StructureTypeForm = ({
           />
         )}
       />
+      {_.isEmpty(structureType?.metadata_fields) ? null : (
+        <MetadataFiltersInput
+          control={control}
+          fieldOptions={fieldOptions}
+          fields={structureType.metadata_fields}
+        />
+      )}
       {metadata_views.map(({ id, name, fields }, idx) => (
         <MetadataViewForm
           key={id}
@@ -107,9 +116,11 @@ export const StructureTypeForm = ({
           loading={saving}
           content={formatMessage({ id: "actions.save" })}
         />
-        <Button as="a" floated="left" onClick={() => append({ name: "" })}>
-          Add Metadata View
-        </Button>
+        {_.isEmpty(structureType?.metadata_fields) ? null : (
+          <Button as="a" floated="left" onClick={() => append({ name: "" })}>
+            <FormattedMessage id="structureType.actions.addMetadataView" />
+          </Button>
+        )}
         <HistoryBackButton content={formatMessage({ id: "actions.cancel" })} />
       </div>
     </Form>

package/src/components/StructureTypesLoader.js

@@ -6,21 +6,19 @@ import { clearStructureTypes, fetchStructureTypes } from "../routines";
 export const StructureTypesLoader = ({
   clearStructureTypes,
   fetchStructureTypes,
-  liteRequest = false,
 }) => {
   useEffect(() => {
-    fetchStructureTypes({ liteRequest });
+    fetchStructureTypes();
     return () => {
       clearStructureTypes();
     };
-  }, [clearStructureTypes, fetchStructureTypes, liteRequest]);
+  }, [clearStructureTypes, fetchStructureTypes]);
   return null;
 };
 
 StructureTypesLoader.propTypes = {
   clearStructureTypes: PropTypes.func,
   fetchStructureTypes: PropTypes.func,
-  liteRequest: PropTypes.bool,
 };
 
 export default connect(null, { clearStructureTypes, fetchStructureTypes })(

package/src/components/StructureTypesTable.js

@@ -50,9 +50,7 @@ export const StructureTypeRow = ({
     <Table.Cell>
       {_.flow(_.map("name"), _.join(", "))(metadata_views)}
     </Table.Cell>
-    {hasMetadataFields && (
-      <Table.Cell className="text-right">{metadata_fields?.length}</Table.Cell>
-    )}
+    <Table.Cell className="text-right">{metadata_fields?.length}</Table.Cell>
   </Table.Row>
 );
 
@@ -67,8 +65,6 @@ StructureTypeRow.propTypes = {
 
 export const StructureTypesTable = ({ structureTypes, loading }) => {
   const { formatMessage } = useIntl();
-  const hasMetadataFields =
-    _.filter("metadata_fields")(structureTypes).length > 0;
   return loading ? null : (
     <Table basic definition>
       <Table.Header>
@@ -83,21 +79,15 @@ export const StructureTypesTable = ({ structureTypes, loading }) => {
           <Table.HeaderCell
             content={formatMessage({ id: "structureType.metadataViews" })}
           />
-          {hasMetadataFields && (
-            <Table.HeaderCell
-              className="text-right"
-              content={formatMessage({ id: "structureType.metadataFields" })}
-            />
-          )}
+          <Table.HeaderCell
+            className="text-right"
+            content={formatMessage({ id: "structureType.metadataFields" })}
+          />
         </Table.Row>
       </Table.Header>
       <Table.Body>
         {structureTypes.map((props, key) => (
-          <StructureTypeRow
-            key={key}
-            {...props}
-            hasMetadataFields={hasMetadataFields}
-          />
+          <StructureTypeRow key={key} {...props} />
         ))}
       </Table.Body>
     </Table>

package/src/components/__tests__/StructureTypeForm.spec.js

@@ -6,7 +6,8 @@ const structureType = {
   id: 123,
   name: "foo",
   template_id: 1,
-  metadata_fields: ["one"],
+  filters: ["one"],
+  metadata_fields: ["one", "two"],
   metadata_views: [
     { name: "default", fields: ["one"] },
     { name: "custom", fields: [] },
@@ -24,7 +25,10 @@ const renderOpts = {
       "actions.cancel": "cancel",
       "actions.save": "save",
       "metadataView.fields": "Fields",
-      "metadataView.fields.placeholder": "Placeholder",
+      "metadataView.fields.placeholder": "select fields",
+      "structureType.actions.addMetadataView": "add metadata view",
+      "structureType.filters": "filters",
+      "structureType.filters.placeholder": "select filters",
       "structureType.template": "template",
       "structureType.translation": "translation",
     },

package/src/components/__tests__/__snapshots__/StructureSelector.spec.js.snap

@@ -5,9 +5,7 @@ exports[`<StructureSelector /> matches the latest snapshot 1`] = `
   <Connect(StructuresLoader)
     pageSize={7}
   />
-  <Connect(StructureTypesLoader)
-    liteRequest={true}
-  />
+  <Connect(StructureTypesLoader) />
   <Connect(FiltersLoader) />
   <Connect(StructuresSearch) />
   <injectIntl(Connect(SelectedFilters)) />

package/src/components/__tests__/__snapshots__/StructureTypeForm.spec.js.snap

@@ -71,6 +71,72 @@ exports[`<StructureTypeForm /> matches the latest snapshot 1`] = `
         </div>
       </div>
     </div>
+    <div
+      class="field"
+    >
+      <label>
+        filters
+      </label>
+      <div
+        aria-expanded="false"
+        class="ui multiple search selection dropdown"
+        name="filters"
+        role="combobox"
+      >
+        <a
+          class="ui label"
+          value="one"
+        >
+          one
+          <i
+            aria-hidden="true"
+            class="delete icon"
+          />
+        </a>
+        <input
+          aria-autocomplete="list"
+          autocomplete="off"
+          class="search"
+          tabindex="0"
+          type="text"
+          value=""
+        />
+        <span
+          class="sizer"
+        />
+        <div
+          aria-atomic="true"
+          aria-live="polite"
+          class="divider text"
+          role="alert"
+        >
+          select filters
+        </div>
+        <i
+          aria-hidden="true"
+          class="dropdown icon clear"
+        />
+        <div
+          aria-multiselectable="true"
+          class="menu transition"
+          role="listbox"
+        >
+          <div
+            aria-checked="false"
+            aria-selected="true"
+            class="selected item"
+            role="option"
+            style="pointer-events: all;"
+          >
+            <span
+              class="text"
+            >
+              two
+            </span>
+          </div>
+        </div>
+      </div>
+    </div>
     <div
       class="ui segment"
     >
@@ -136,7 +202,7 @@ exports[`<StructureTypeForm /> matches the latest snapshot 1`] = `
             class="divider text"
             role="alert"
           >
-            Placeholder
+            select fields
           </div>
           <i
             aria-hidden="true"
@@ -148,9 +214,17 @@ exports[`<StructureTypeForm /> matches the latest snapshot 1`] = `
             role="listbox"
           >
             <div
-              class="message"
+              aria-checked="false"
+              aria-selected="true"
+              class="selected item"
+              role="option"
+              style="pointer-events: all;"
             >
-              No results found.
+              <span
+                class="text"
+              >
+                two
+              </span>
             </div>
           </div>
         </div>
@@ -211,7 +285,7 @@ exports[`<StructureTypeForm /> matches the latest snapshot 1`] = `
             class="divider default text"
             role="alert"
           >
-            Placeholder
+            select fields
           </div>
           <i
             aria-hidden="true"
@@ -235,6 +309,19 @@ exports[`<StructureTypeForm /> matches the latest snapshot 1`] = `
                 one
               </span>
             </div>
+            <div
+              aria-checked="false"
+              aria-selected="false"
+              class="item"
+              role="option"
+              style="pointer-events: all;"
+            >
+              <span
+                class="text"
+              >
+                two
+              </span>
+            </div>
           </div>
         </div>
       </div>
@@ -254,7 +341,7 @@ exports[`<StructureTypeForm /> matches the latest snapshot 1`] = `
         class="ui left floated button"
         role="button"
       >
-        Add Metadata View
+        add metadata view
       </a>
       <a
         class="ui secondary button"

package/src/messages/en.js

@@ -329,6 +329,9 @@ export default {
   "structureTags.empty": "There are no Structure Tags yet",
   "structureTags.header": "Structure tags management",
   "structureTags.subheader": "Tags for Data Catalog",
+  "structureType.actions.addMetadataView": "Add Metadata View",
+  "structureType.filters": "Filters",
+  "structureType.filters.placeholder": "Select filterable fields",
   "structureType.metadataFields": "Metadata Fields",
   "structureType.metadataViews": "Metadata Views",
   "structureType.name": "Type",

package/src/messages/es.js

@@ -333,6 +333,9 @@ export default {
   "structureTags.empty": "Aún no hay ninguna Etiqueta de Estructura",
   "structureTags.header": "Gestión de Etiquetas de Estructuras",
   "structureTags.subheader": "Etiquetas para el Catálogo de Datos",
+  "structureType.actions.addMetadataView": "Añadir vista de metadata",
+  "structureType.filters": "Filtros",
+  "structureType.filters.placeholder": "Seleccionar campos filtrables",
   "structureType.metadataFields": "Campos de metadata",
   "structureType.metadataViews": "Vistas de metadata",
   "structureType.name": "Tipo",

package/src/sagas/fetchStructureTypes.js

@@ -1,14 +1,12 @@
 import { call, put, takeLatest } from "redux-saga/effects";
 import { apiJson, JSON_OPTS } from "@truedat/core/services/api";
 import { fetchStructureTypes } from "../routines";
-import { API_STRUCTURE_TYPES, API_STRUCTURE_TYPES_LITE } from "../api";
+import { API_STRUCTURE_TYPES } from "../api";
 
-export function* fetchStructureTypesSaga({ payload }) {
+export function* fetchStructureTypesSaga() {
   try {
-    const { liteRequest } = payload;
     yield put(fetchStructureTypes.request());
-    const url = liteRequest ? API_STRUCTURE_TYPES_LITE : API_STRUCTURE_TYPES;
-    const { data } = yield call(apiJson, url, JSON_OPTS);
+    const { data } = yield call(apiJson, API_STRUCTURE_TYPES, JSON_OPTS);
     yield put(fetchStructureTypes.success(data));
   } catch (error) {
     if (error.response) {