@truedat/dq 7.11.0 → 7.11.2

package/src/hooks/useImplementations.js

@@ -0,0 +1,80 @@
+import { compile } from "path-to-regexp";
+import useSWR from "swr";
+import useSWRMutations from "swr/mutation";
+import FileSaver from "file-saver";
+import {
+  apiJson,
+  apiJsonPost,
+  JSON_OPTS,
+  UPLOAD_JSON_OPTS,
+} from "@truedat/core/services/api";
+import {
+  API_RULE_IMPLEMENTATIONS_SEARCH,
+  API_RULE_IMPLEMENTATION_FILTERS_SEARCH,
+  API_RULE_IMPLEMENTATIONS_XLSX_DOWNLOAD,
+  API_RULE_IMPLEMENTATIONS_XLSX_UPLOAD,
+  API_RULE_IMPLEMENTATIONS_XLSX_UPLOAD_JOBS,
+  API_RULE_IMPLEMENTATIONS_XLSX_UPLOAD_JOB,
+} from "../api";
+
+function saveFile({ data, headers }) {
+  const contentDisposition = headers["content-disposition"];
+  const regex = /filename=(.+)$/;
+  const match = regex.exec(contentDisposition);
+  const fileName = match ? match[1] : "structures.xlsx";
+
+  FileSaver.saveAs(data, fileName);
+}
+
+export const useRuleImplementationFilters = () => {
+  return useSWRMutations(
+    API_RULE_IMPLEMENTATION_FILTERS_SEARCH,
+    (url, { arg }) => {
+      return apiJsonPost(url, arg);
+    }
+  );
+};
+
+export const useRuleImplementationSearch = () => {
+  return useSWRMutations(API_RULE_IMPLEMENTATIONS_SEARCH, (url, { arg }) => {
+    return apiJsonPost(url, arg);
+  });
+};
+
+export const useImplementationsDownload = () => {
+  return useSWRMutations(
+    API_RULE_IMPLEMENTATIONS_XLSX_DOWNLOAD,
+    (url, { arg }) => {
+      return apiJsonPost(url, arg, { ...JSON_OPTS, responseType: "blob" }).then(
+        ({ data, headers }) => {
+          saveFile({ data, headers });
+        }
+      );
+    }
+  );
+};
+
+export const useImplementationsUpload = () => {
+  return useSWRMutations(
+    API_RULE_IMPLEMENTATIONS_XLSX_UPLOAD,
+    (url, { arg }) => {
+      return apiJsonPost(url, arg, UPLOAD_JSON_OPTS);
+    }
+  );
+};
+
+export const useImplementationsUploadJobs = () => {
+  const { data, error, mutate } = useSWR(
+    API_RULE_IMPLEMENTATIONS_XLSX_UPLOAD_JOBS,
+    apiJson
+  );
+  return { data: data?.data, error, loading: !error && !data, mutate };
+};
+
+export const useImplementationsUploadJob = (id) => {
+  const url = compile(API_RULE_IMPLEMENTATIONS_XLSX_UPLOAD_JOB)({
+    id: `${id}`,
+  });
+  const { data, error, mutate } = useSWR(url, apiJson);
+  return { data: data?.data, error, loading: !error && !data, mutate };
+};

package/src/reducers/index.js

@@ -32,6 +32,7 @@ import { ruleImplementationSaving } from "./ruleImplementationSaving";
 import { ruleImplementationSelectedFilter } from "./ruleImplementationSelectedFilter";
 import { ruleImplementations } from "./ruleImplementations";
 import { ruleImplementationsDownloading } from "./ruleImplementationsDownloading";
+import { ruleImplementationsDownloadingXlsx } from "./ruleImplementationsDownloadingXlsx";
 import { ruleImplementationsLoading } from "./ruleImplementationsLoading";
 import { ruleImplementationsPageSize } from "./ruleImplementationsPageSize";
 import { ruleLoading } from "./ruleLoading";
@@ -83,6 +84,7 @@ export {
   ruleImplementationSelectedFilter,
   ruleImplementations,
   ruleImplementationsDownloading,
+  ruleImplementationsDownloadingXlsx,
   ruleImplementationsLoading,
   ruleImplementationsPageSize,
   ruleLoading,

package/src/reducers/ruleImplementationSelectedFilter.js

@@ -3,7 +3,7 @@ import {
   closeImplementationFilter,
   openImplementationFilter,
   removeImplementationFilter,
-  resetImplementationFilters
+  resetImplementationFilters,
 } from "../routines";
 
 /** @type {string} */

package/src/reducers/ruleImplementationsDownloadingXlsx.js

@@ -0,0 +1,14 @@
+import { downloadImplementationsXlsx } from "../routines";
+
+const ruleImplementationsDownloadingXlsx = (state = false, { type }) => {
+  switch (type) {
+    case downloadImplementationsXlsx.TRIGGER:
+      return true;
+    case downloadImplementationsXlsx.FULFILL:
+      return false;
+    default:
+      return state;
+  }
+};
+
+export { ruleImplementationsDownloadingXlsx };

package/src/routines.js

@@ -47,6 +47,9 @@ export const deprecateImplementation = createRoutine("CREATE_IMPLEMENTATION");
 export const downloadImplementations = createRoutine(
   "DOWNLOAD_IMPLEMENTATIONS"
 );
+export const downloadImplementationsXlsx = createRoutine(
+  "DOWNLOAD_IMPLEMENTATIONS_XLSX"
+);
 export const fetchConceptRules = createRoutine("FETCH_CONCEPT_RULES");
 export const fetchExecutionGroup = createRoutine("FETCH_EXECUTION_GROUP");
 export const fetchImplementationFilters = createRoutine(

package/src/sagas/downloadRuleImplementationsXlsx.js

@@ -0,0 +1,52 @@
+import _ from "lodash/fp";
+import FileSaver from "file-saver";
+import { call, put, select, takeLatest } from "redux-saga/effects";
+import { apiJsonPost, JSON_OPTS } from "@truedat/core/services/api";
+import { downloadImplementationsXlsx } from "../routines";
+import { getPreviousRuleImplementationQuery } from "../selectors";
+import { API_RULE_IMPLEMENTATIONS_XLSX_DOWNLOAD } from "../api";
+
+export function saveFile(data) {
+  if (!_.isEmpty(data)) {
+    const blob = new Blob([String.fromCharCode(0xfeff), data], {
+      type: "text/csv;charset=utf-8",
+    });
+    FileSaver.saveAs(blob, "implementations.csv");
+  }
+}
+
+export function* downloadRuleImplementationsXlsxSaga({ payload }) {
+  try {
+    const headerLabels = _.propOr({}, "headerLabels")(payload);
+    const contentLabels = _.propOr({}, "contentLabels")(payload);
+    const lang = _.propOr("es", "lang")(payload);
+    const query = yield select(getPreviousRuleImplementationQuery);
+    const body = {
+      header_labels: headerLabels,
+      content_labels: contentLabels,
+      lang,
+      ...query,
+    };
+    const url = API_RULE_IMPLEMENTATIONS_XLSX_DOWNLOAD;
+    yield put(downloadImplementationsXlsx.request(body));
+    const { data } = yield call(apiJsonPost, url, body, JSON_OPTS);
+    yield call(saveFile, data);
+    yield put(downloadImplementationsXlsx.success(data));
+  } catch (error) {
+    if (error.response) {
+      const { status, data } = error.response;
+      yield put(downloadImplementationsXlsx.failure({ status, data }));
+    } else {
+      yield put(downloadImplementationsXlsx.failure(error.message));
+    }
+  } finally {
+    yield put(downloadImplementationsXlsx.fulfill());
+  }
+}
+
+export function* downloadRuleImplementationsXlsxRequestSaga() {
+  yield takeLatest(
+    downloadImplementationsXlsx.TRIGGER,
+    downloadRuleImplementationsXlsxSaga
+  );
+}

package/src/sagas/index.js

@@ -9,6 +9,7 @@ import { deleteRemediationRequestSaga } from "./deleteRemediation";
 import { deleteRuleRequestSaga } from "./deleteRule";
 import { deleteRuleResultRequestSaga } from "./deleteRuleResult";
 import { downloadRuleImplementationsRequestSaga } from "./downloadRuleImplementations";
+import { downloadRuleImplementationsXlsxRequestSaga } from "./downloadRuleImplementationsXlsx";
 import { fetchConceptRulesRequestSaga } from "./fetchConceptRules";
 import { fetchExecutionGroupRequestSaga } from "./fetchExecutionGroup";
 import { fetchRemediationRequestSaga } from "./fetchRemediation";
@@ -43,6 +44,7 @@ export {
   deleteRuleRequestSaga,
   deleteRuleResultRequestSaga,
   downloadRuleImplementationsRequestSaga,
+  downloadRuleImplementationsXlsxRequestSaga,
   fetchConceptRulesRequestSaga,
   fetchExecutionGroupRequestSaga,
   fetchRemediationRequestSaga,
@@ -78,6 +80,7 @@ export default [
   deleteRuleRequestSaga(),
   deleteRuleResultRequestSaga(),
   downloadRuleImplementationsRequestSaga(),
+  downloadRuleImplementationsXlsxRequestSaga(),
   fetchConceptRulesRequestSaga(),
   fetchExecutionGroupRequestSaga(),
   fetchRemediationRequestSaga(),

package/src/components/RuleImplementationFilters.js

@@ -1,25 +0,0 @@
-import { connect } from "react-redux";
-import { bindActionCreators } from "redux";
-import { AvailableFilters } from "@truedat/core/components";
-import {
-  addImplementationFilter,
-  resetImplementationFilters,
-} from "../routines";
-import { getRuleImplementationAvailableFilters } from "../selectors";
-
-const mapStateToProps = (state) => ({
-  filters: getRuleImplementationAvailableFilters(state),
-  disabled: state.ruleFiltersLoading,
-  loading: state.ruleFiltersLoading,
-});
-
-const mapDispatchToProps = (dispatch) =>
-  bindActionCreators(
-    {
-      addFilter: addImplementationFilter,
-      resetFilters: resetImplementationFilters,
-    },
-    dispatch
-  );
-
-export default connect(mapStateToProps, mapDispatchToProps)(AvailableFilters);

package/src/components/RuleImplementationSelectedFilters.js

@@ -1,99 +0,0 @@
-import _ from "lodash/fp";
-import { bindActionCreators, compose } from "redux";
-import { connect } from "react-redux";
-import { injectIntl } from "react-intl";
-import { makeOption } from "@truedat/core/services/i18n";
-import { SelectedFilters, StructureFilterItem } from "@truedat/core/components";
-import { StructuresLoader } from "@truedat/dd/components";
-
-import {
-  applyUserSearchFilter,
-  deleteUserSearchFilter,
-  saveUserSearchFilters,
-  searchStructures,
-} from "@truedat/dd/routines";
-import {
-  closeImplementationFilter,
-  openImplementationFilter,
-  removeImplementationFilter,
-  resetImplementationFilters,
-  toggleImplementationFilterValue,
-} from "../routines";
-
-import {
-  getRuleImplementationSelectedFilterActiveValues,
-  getRuleImplementationSelectedFilters,
-  getRuleImplementationSelectedFilterValues,
-  getRuleImplementationFilterTypes,
-} from "../selectors";
-
-const translations = (formatMessage) => ({
-  "execution_result_info.result_text": (v) =>
-    formatMessage({ id: v, defaultMessage: v }),
-});
-
-export const mapStateToProps = (state, ownProps) => {
-  const formatMessage = _.pathOr(_.prop("id"), "intl.formatMessage")(ownProps);
-  const {
-    ruleImplementationFiltersLoading: loading,
-    ruleImplementationSelectedFilter: selectedFilter,
-  } = state;
-  const i18nValues = _.flow(
-    getRuleImplementationSelectedFilterValues,
-    _.map(makeOption(translations(formatMessage), selectedFilter))
-  )(state);
-
-  const {
-    selectedUserSearchFilter: selectedUserFilter,
-    ruleImplementationActiveFilters: activeFilters,
-    userSearchFilters: userFilters,
-  } = state;
-
-  const searchFiltersPropsMapping = {
-    linked_structures_ids: {
-      query: state.structureQuery?.query,
-      searchCallback: searchStructures,
-      options: state.structures,
-      placeholder: formatMessage({ id: "structures.search.placeholder" }),
-      FilterDataLoader: StructuresLoader,
-      loaderProps: { pageSize: 50 },
-      FilterItem: StructureFilterItem,
-    },
-  };
-
-  return {
-    loading,
-    filterTypes: getRuleImplementationFilterTypes(state),
-    selectedFilter,
-    selectedFilters: getRuleImplementationSelectedFilters(state),
-    selectedFilterActiveValues:
-      getRuleImplementationSelectedFilterActiveValues(state),
-    selectedFilterValues: i18nValues,
-    selectedUserFilter,
-    activeFilters,
-    userFilters,
-    userFilterScope: "rule_implementation",
-    searchFiltersPropsMapping,
-  };
-};
-
-const mapDispatchToProps = (dispatch) =>
-  bindActionCreators(
-    {
-      applyUserFilter: applyUserSearchFilter,
-      closeFilter: closeImplementationFilter,
-      deleteUserFilter: deleteUserSearchFilter,
-      openFilter: openImplementationFilter,
-      removeFilter: removeImplementationFilter,
-      resetFilters: resetImplementationFilters,
-      toggleFilterValue: toggleImplementationFilterValue,
-      saveFilters: saveUserSearchFilters,
-      searchFilterDispacher: (searchCall) => dispatch(searchCall),
-    },
-    dispatch
-  );
-
-export default compose(
-  injectIntl,
-  connect(mapStateToProps, mapDispatchToProps)
-)(SelectedFilters);

package/src/components/RuleImplementationsFromRuleLoader.js

@@ -1,60 +0,0 @@
-import { useEffect } from "react";
-import { useParams } from "react-router";
-import PropTypes from "prop-types";
-import { connect } from "react-redux";
-import { Dimmer, Loader } from "semantic-ui-react";
-import {
-  clearRuleImplementations,
-  fetchRuleImplementations,
-} from "../routines";
-
-export const RuleImplementationsFromRuleLoader = ({
-  clearRuleImplementations,
-  fetchRuleImplementations,
-  ruleImplementationsLoading,
-}) => {
-  const { id } = useParams();
-  useEffect(() => {
-    if (id) {
-      fetchRuleImplementations({
-        id,
-        filters: {
-          must_not: {
-            status: ["versioned"],
-          },
-        },
-      });
-    }
-  }, [clearRuleImplementations, fetchRuleImplementations, id]);
-
-  useEffect(() => {
-    return () => {
-      clearRuleImplementations();
-    };
-  }, [clearRuleImplementations]);
-  return ruleImplementationsLoading ? (
-    <Dimmer active={ruleImplementationsLoading} inverted>
-      <Loader size="massive" inverted />
-    </Dimmer>
-  ) : null;
-};
-
-RuleImplementationsFromRuleLoader.propTypes = {
-  clearRuleImplementations: PropTypes.func,
-  fetchRuleImplementations: PropTypes.func,
-  ruleImplementationsLoading: PropTypes.bool,
-};
-
-const mapDispatchToProps = {
-  clearRuleImplementations,
-  fetchRuleImplementations,
-};
-
-const mapStateToProps = ({ ruleImplementationsLoading }) => ({
-  ruleImplementationsLoading,
-});
-
-export default connect(
-  mapStateToProps,
-  mapDispatchToProps
-)(RuleImplementationsFromRuleLoader);

package/src/components/RuleImplementationsPagination.js

@@ -1,18 +0,0 @@
-import { connect } from "react-redux";
-import { bindActionCreators } from "redux";
-import { Pagination } from "@truedat/core/components";
-import { selectImplementationPage } from "../routines";
-
-const mapDispatchToProps = (dispatch) =>
-  bindActionCreators({ selectPage: selectImplementationPage }, dispatch);
-
-const mapStateToProps = ({
-  ruleImplementationQuery,
-  ruleImplementationCount,
-  ruleImplementationsPageSize,
-}) => ({
-  activePage: ruleImplementationQuery?.page,
-  totalPages: Math.ceil(ruleImplementationCount / ruleImplementationsPageSize),
-});
-
-export default connect(mapStateToProps, mapDispatchToProps)(Pagination);

package/src/components/RuleImplementationsSearch.js

@@ -1,39 +0,0 @@
-import PropTypes from "prop-types";
-import { connect } from "react-redux";
-import { Input } from "semantic-ui-react";
-import { useIntl } from "react-intl";
-import { searchImplementations } from "../routines";
-import RuleImplementationFilters from "./RuleImplementationFilters";
-
-export const RuleImplementationsSearch = ({
-  query,
-  searchImplementations,
-  loading,
-}) => {
-  const { formatMessage } = useIntl();
-  return (
-    <Input
-      value={query}
-      onChange={(_e, data) => searchImplementations({ query: data.value })}
-      icon={{ name: "search", link: true }}
-      iconPosition="left"
-      action={<RuleImplementationFilters />}
-      placeholder={formatMessage({ id: "implementations.search.placeholder" })}
-      loading={loading}
-    />
-  );
-};
-
-RuleImplementationsSearch.propTypes = {
-  query: PropTypes.string,
-  searchImplementations: PropTypes.func,
-  loading: PropTypes.bool,
-};
-
-const mapStateToProps = ({ ruleImplementationQuery }) => ({
-  query: ruleImplementationQuery?.query,
-});
-
-export default connect(mapStateToProps, { searchImplementations })(
-  RuleImplementationsSearch
-);

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

@@ -1,63 +0,0 @@
-import { useParams } from "react-router";
-import { render, waitForLoad } from "@truedat/test/render";
-import { RuleImplementationsFromRuleLoader } from "../RuleImplementationsFromRuleLoader";
-
-jest.mock("react-router", () => ({
-  ...jest.requireActual("react-router"),
-  useParams: jest.fn(),
-}));
-
-afterEach(() => {
-  jest.clearAllMocks();
-});
-
-describe("<RuleImplementationsFromRuleLoader />", () => {
-  const fetchRuleImplementations = jest.fn();
-  const clearRuleImplementations = jest.fn();
-  const deletionQuery = { deleted: false };
-
-  const props = {
-    deletionQuery,
-    fetchRuleImplementations,
-    clearRuleImplementations,
-    ruleImplementationsLoading: false,
-  };
-
-  beforeEach(() => {
-    useParams.mockImplementation(() => ({ id: 1 }));
-  });
-
-  it("matches the latest snapshot", async () => {
-    const rendered = render(<RuleImplementationsFromRuleLoader {...props} />);
-    await waitForLoad(rendered);
-    expect(rendered.container).toMatchSnapshot();
-  });
-
-  it("calls fetchRuleImplementations when component mounts, clearRuleImplementations when component unmounts", async () => {
-    const rendered = render(<RuleImplementationsFromRuleLoader {...props} />);
-    await waitForLoad(rendered);
-
-    expect(clearRuleImplementations).toHaveBeenCalledTimes(0);
-    expect(fetchRuleImplementations).toHaveBeenCalledTimes(1);
-    expect(fetchRuleImplementations).toHaveBeenCalledWith({
-      id: 1,
-      filters: { must_not: { status: ["versioned"] } },
-    });
-
-    rendered.unmount();
-    expect(clearRuleImplementations).toHaveBeenCalledTimes(1);
-    expect(fetchRuleImplementations).toHaveBeenCalledTimes(1);
-  });
-
-  it("renders dimmer when rule implementations loading", async () => {
-    const rendered = render(
-      <RuleImplementationsFromRuleLoader
-        {...props}
-        ruleImplementationsLoading
-      />
-    );
-    expect(
-      rendered.container.querySelector(".dimmer.active")
-    ).toBeInTheDocument();
-  });
-});

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

@@ -1,29 +0,0 @@
-import userEvent from "@testing-library/user-event";
-import { render, waitForLoad } from "@truedat/test/render";
-import { RuleImplementationsSearch } from "../RuleImplementationsSearch";
-
-describe("<RuleImplementationsSearch/>", () => {
-  it("matches the latest snapshot", async () => {
-    const searchImplementations = jest.fn();
-    const loading = false;
-    const query = "";
-    const props = { searchImplementations, loading, query };
-    const rendered = render(<RuleImplementationsSearch {...props} />);
-    await waitForLoad(rendered);
-    expect(rendered.container).toMatchSnapshot();
-  });
-
-  it("dispatches onChange when Input changes", async () => {
-    const searchImplementations = jest.fn();
-    const loading = false;
-    const query = "";
-    const props = { searchImplementations, loading, query };
-    const rendered = render(<RuleImplementationsSearch {...props} />);
-    await waitForLoad(rendered);
-
-    const user = userEvent.setup({ delay: null });
-    await user.type(rendered.getByRole("textbox"), "test");
-
-    expect(searchImplementations).toHaveBeenCalled();
-  });
-});

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

@@ -1,3 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`<RuleImplementationsFromRuleLoader /> matches the latest snapshot 1`] = `<div />`;

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

@@ -1,50 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`<RuleImplementationsSearch/> matches the latest snapshot 1`] = `
-<div>
-  <div
-    class="ui action left icon input"
-  >
-    <input
-      placeholder="implementations.search.placeholder"
-      type="text"
-      value=""
-    />
-    <i
-      aria-hidden="true"
-      class="search link icon"
-    />
-    <div
-      aria-expanded="false"
-      class="ui button floating labeled scrolling dropdown icon"
-      role="listbox"
-      tabindex="0"
-    >
-      <div
-        aria-atomic="true"
-        aria-live="polite"
-        class="divider text"
-        role="alert"
-      >
-        Filters
-      </div>
-      <i
-        aria-hidden="true"
-        class="filter icon"
-      />
-      <div
-        class="menu transition"
-      >
-        <div
-          class="item"
-          role="option"
-        >
-          <em>
-            (reset filters)
-          </em>
-        </div>
-      </div>
-    </div>
-  </div>
-</div>
-`;