@truedat/dd 4.44.5 → 4.45.3

package/CHANGELOG.md

@@ -1,8 +1,14 @@
 # Changelog
 
+## [4.45.3] 2022-06-01
+
+### Added
+
+- [TD-3920] Alias support for structures
+
 ## [4.44.4] 2022-05-19
 
-## Added
+### Added
 
 - [TD-4660] Support for reference datasets
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@truedat/dd",
-  "version": "4.44.5",
+  "version": "4.45.3",
   "description": "Truedat Web Data Dictionary",
   "sideEffects": false,
   "jsnext:main": "src/index.js",
@@ -34,7 +34,7 @@
     "@testing-library/jest-dom": "^5.16.4",
     "@testing-library/react": "^12.0.0",
     "@testing-library/user-event": "^13.2.1",
-    "@truedat/test": "4.44.5",
+    "@truedat/test": "4.45.1",
     "babel-jest": "^28.1.0",
     "babel-plugin-dynamic-import-node": "^2.3.3",
     "babel-plugin-lodash": "^3.3.4",
@@ -88,9 +88,9 @@
   },
   "dependencies": {
     "@apollo/client": "^3.6.4",
-    "@truedat/auth": "4.44.5",
-    "@truedat/core": "4.44.5",
-    "@truedat/df": "4.44.5",
+    "@truedat/auth": "4.45.1",
+    "@truedat/core": "4.45.1",
+    "@truedat/df": "4.45.1",
     "lodash": "^4.17.21",
     "path-to-regexp": "^1.7.0",
     "prop-types": "^15.8.1",
@@ -99,7 +99,6 @@
     "react-moment": "^1.1.2",
     "react-redux": "^7.2.4",
     "react-router-dom": "^5.2.0",
-    "react-vis": "^1.11.7",
     "redux": "^4.1.1",
     "redux-saga": "^1.1.3",
     "redux-saga-routines": "^3.2.3",
@@ -107,9 +106,10 @@
     "svg-pan-zoom": "^3.6.1"
   },
   "peerDependencies": {
+    "@truedat/profile": ">= 4.45.0",
     "react": ">= 16.8.6 < 17",
     "react-dom": ">= 16.8.6 < 17",
     "semantic-ui-react": ">= 0.88.2 < 2.1"
   },
-  "gitHead": "5a339468198c803592b285eddd0dd0c0b0eced93"
+  "gitHead": "35c764482ee330282ab7d56d9325314691da72db"
 }

package/src/components/StructureCrumbs.js

@@ -29,18 +29,21 @@ export const SystemCrumb = ({ name, id }) => (
   </>
 );
 
-export const AncestorCrumb = ({ name, id }) => (
+export const AncestorCrumb = ({ name, id, published_note }) => (
   <>
     <Breadcrumb.Section as={Link} to={linkTo.STRUCTURE({ id })} active={false}>
-      {name}
+      {_.isEmpty(published_note?.alias) ? name : published_note.alias}
     </Breadcrumb.Section>
     <Breadcrumb.Divider icon="right angle" />
   </>
 );
 
-export const StructureCrumb = ({ name, id, version }) =>
+export const StructureCrumb = ({ name, id, version, published_note }) =>
   _.isNil(version) ? (
-    <Breadcrumb.Section active content={name} />
+    <Breadcrumb.Section
+      active
+      content={_.isEmpty(published_note?.alias) ? name : published_note.alias}
+    />
   ) : (
     <>
       <Breadcrumb.Section
@@ -48,7 +51,7 @@ export const StructureCrumb = ({ name, id, version }) =>
         to={linkTo.STRUCTURE({ id })}
         active={false}
       >
-        {name}
+        {_.isEmpty(published_note?.alias) ? name : published_note.alias}
       </Breadcrumb.Section>
       <Breadcrumb.Divider icon="right angle" />
     </>
@@ -60,20 +63,33 @@ export const VersionCrumb = ({ version }) => (
   </Breadcrumb.Section>
 );
 
-export const StructureCrumbs = ({ id, system, ancestry, name, version }) =>
+export const StructureCrumbs = ({
+  id,
+  system,
+  ancestry,
+  name,
+  version,
+  published_note,
+}) =>
   name ? (
     <Breadcrumb>
       <StructuresCrumb />
       {!_.isEmpty(system) && <SystemCrumb {...system} />}
       {!_.isEmpty(ancestry) &&
-        _.map(({ data_structure_id, name }) => (
+        _.map(({ data_structure_id, name, published_note }) => (
           <AncestorCrumb
             key={data_structure_id}
             name={name}
             id={data_structure_id}
+            published_note={published_note}
           />
         ))(ancestry)}
-      <StructureCrumb name={name} id={id} version={version} />
+      <StructureCrumb
+        name={name}
+        id={id}
+        version={version}
+        published_note={published_note}
+      />
       {!_.isNil(version) && <VersionCrumb id={id} version={version} />}
     </Breadcrumb>
   ) : null;
@@ -84,18 +100,19 @@ StructureCrumbs.propTypes = {
   name: PropTypes.string,
   field: PropTypes.object,
   system: PropTypes.object,
-  version: PropTypes.string
+  version: PropTypes.string,
+  published_note: PropTypes.object,
 };
 
 const mapStateToProps = ({
   structure,
   structureAncestry: ancestry,
   structureVersion: version,
-  structureSystem: system
+  structureSystem: system,
 }) => ({
   ...structure,
   ancestry,
   system,
-  version
+  version,
 });
 export default connect(mapStateToProps)(StructureCrumbs);

package/src/components/StructureItem.js

@@ -49,13 +49,14 @@ StructureItem.propTypes = {
 
 export const mapStateToProps = (
   { structure },
-  { data_structure_id, id: structureId, type }
+  { data_structure_id, id: structureId, type, name, published_note }
 ) => {
   const id = data_structure_id || structureId;
   return {
     id: id,
     active:
       type !== "system" && _.isFinite(id) && _.propEq("id", id)(structure),
+    name: _.isEmpty(published_note?.alias) ? name : published_note.alias,
   };
 };
 

package/src/components/StructureSummary.js

@@ -56,6 +56,7 @@ const dateProperties = (deleted_at, updatedAt) =>
 export const StructureSummary = ({
   class: structureClass,
   name,
+  published_note,
   description,
   type,
   userPermissions,
@@ -79,7 +80,9 @@ export const StructureSummary = ({
             <Dimmer.Dimmable dimmed={linkedStructureTagsLoading}>
               <Header as="h2">
                 <Header.Content>
-                  {name}
+                  {_.isEmpty(published_note?.alias)
+                    ? name
+                    : published_note.alias}
                   {grant ? (
                     structureGrant ? (
                       structureGrant(grant)
@@ -92,14 +95,8 @@ export const StructureSummary = ({
                   ) : (
                     <StructureGrantRequestButton />
                   )}
-                  {type && (
-                    <Header.Subheader>
-                      {formatMessage({
-                        id: `structure.type.${type}.text`,
-                        defaultMessage:
-                          _.get("translation")(data_structure_type) || type,
-                      })}
-                    </Header.Subheader>
+                  {!_.isEmpty(published_note?.alias) && (
+                    <Header.Subheader>{name}</Header.Subheader>
                   )}
                 </Header.Content>
               </Header>
@@ -136,6 +133,7 @@ export const StructureSummary = ({
 StructureSummary.propTypes = {
   class: PropTypes.string,
   name: PropTypes.string,
+  published_note: PropTypes.object,
   description: PropTypes.string,
   type: PropTypes.string,
   userPermissions: PropTypes.object,

package/src/components/StructureTabPane.js

@@ -18,7 +18,6 @@ import StructureLineage from "./StructureLineage";
 import StructureNotes from "./StructureNotes";
 import StructureNotesEdit from "./StructureNotesEdit";
 import StructureParentRelations from "./StructureParentRelations";
-import StructureProfiling from "./StructureProfiling";
 import StructureVersions from "./StructureVersions";
 import StructureMetadata from "./StructureMetadata";
 import StructureNotesLoader from "./StructureNotesLoader";
@@ -26,6 +25,9 @@ import StructureNotesLoader from "./StructureNotesLoader";
 const StructureLinks = React.lazy(() =>
   import("@truedat/lm/components/StructureLinks")
 );
+
+const StructureProfile = React.lazy(() => import("@truedat/profile"));
+
 const StructureRelationForm = React.lazy(() =>
   import("@truedat/lm/components/StructureRelationForm")
 );
@@ -59,7 +61,7 @@ export const StructureTabPane = ({ activeTab, tabVisibility }) => (
         <Route render={() => <StructureLinks />} />
       </Switch>
     )}
-    {activeTab === "profile" && tabVisibility.profile && <StructureProfiling />}
+    {activeTab === "profile" && tabVisibility.profile && <StructureProfile />}
     {activeTab === "parents" && <StructureParentRelations />}
     {activeTab === "children" && <StructureChildrenRelations />}
     {activeTab === "versions" && <StructureVersions />}

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

@@ -1,8 +1,12 @@
 import React from "react";
+import { render } from "@truedat/test/render";
 import { shallow } from "enzyme";
 import { Link } from "react-router-dom";
 import { intl } from "@truedat/test/intl-stub";
-import { StructureItem, mapStateToProps } from "../StructureItem";
+import DefaultStructureItem, {
+  StructureItem,
+  mapStateToProps,
+} from "../StructureItem";
 
 // workaround for enzyme issue with React.useContext
 // see https://github.com/airbnb/enzyme/issues/2176#issuecomment-532361526
@@ -14,14 +18,27 @@ describe("<StructureItem />", () => {
 
   it("matches the latest snapshot", () => {
     const props = { id, name };
-    const wrapper = shallow(<StructureItem {...props} />);
-    expect(wrapper).toMatchSnapshot();
+
+    const { container } = render(<DefaultStructureItem {...props} />);
+    expect(container).toMatchSnapshot();
   });
 
   it("matches the latest snapshot (active state)", () => {
-    const props = { id, name };
-    const wrapper = shallow(<StructureItem active={true} {...props} />);
-    expect(wrapper).toMatchSnapshot();
+    const props = { data_structure_id: 8, name, type: "not_system" };
+    const state = {
+      structure: { id: 8 },
+    };
+    const { container } = render(<DefaultStructureItem {...props} />, {
+      state,
+    });
+    expect(container).toMatchSnapshot();
+  });
+
+  it("matches the latest snapshot with alias", () => {
+    const props = { id, name, published_note: { alias: "alias" } };
+
+    const { container } = render(<DefaultStructureItem {...props} />);
+    expect(container).toMatchSnapshot();
   });
 
   it("renders as a link to the /structures/:id route if id is present", () => {

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

@@ -1,13 +1,23 @@
 import React from "react";
-import { shallow } from "enzyme";
+import { render } from "@truedat/test/render";
 import { StructureItems } from "../StructureItems";
 
 describe("<StructureItems />", () => {
   it("matches the latest snapshot", () => {
-    const structures = [{ id: 1 }];
+    const structures = [{ id: 1, name: "some structure" }];
     const props = { structures };
 
-    const wrapper = shallow(<StructureItems {...props} />);
-    expect(wrapper).toMatchSnapshot();
+    const { container } = render(<StructureItems {...props} />);
+    expect(container).toMatchSnapshot();
+  });
+
+  it("matches the latest snapshot with alias", () => {
+    const structures = [
+      { id: 1, name: "some structure", published_note: { alias: "alias" } },
+    ];
+    const props = { structures };
+
+    const { container } = render(<StructureItems {...props} />);
+    expect(container).toMatchSnapshot();
   });
 });

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

@@ -4,7 +4,7 @@ import StructureProperties from "../StructureProperties";
 
 describe("<StructureProperties />", () => {
   it("matches the latest snapshot", () => {
-    const structure = { description: "dd", group: "gp" };
+    const structure = { description: "dd", group: "gp", type: "Database" };
     const state = { structure };
     const { container } = render(<StructureProperties />, { state });
     expect(container).toMatchSnapshot();

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

@@ -44,6 +44,19 @@ describe("<StructureSummary />", () => {
     expect(wrapper).toMatchSnapshot();
   });
 
+  it("matches the latest snapshot with alias", () => {
+    const props = {
+      ...structure,
+      published_note: { alias: "some alias" },
+      updatedAt,
+      deleted_at,
+      structureFields,
+      linkedStructureTagsLoading: false,
+    };
+    const wrapper = shallow(<StructureSummary {...props} />);
+    expect(wrapper).toMatchSnapshot();
+  });
+
   it("renders loading when linkedStructureTagsLoading is true", () => {
     const props = {
       ...structure,

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

@@ -1,50 +1,75 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`<StructureItem /> matches the latest snapshot (active state) 1`] = `
-<ListItem
-  active={true}
-  as="a"
-  title="foo"
->
-  <ListIcon
-    name="question circle outline"
-    verticalAlign="middle"
-  />
-  <ListContent>
-    <ListDescription>
-      foo
-    </ListDescription>
-  </ListContent>
-</ListItem>
+<div>
+  <a
+    class="active item"
+    role="listitem"
+    title="foo"
+  >
+    <i
+      aria-hidden="true"
+      class="question circle outline icon middle aligned"
+    />
+    <div
+      class="content"
+    >
+      <div
+        class="description"
+      >
+        foo
+      </div>
+    </div>
+  </a>
+</div>
 `;
 
 exports[`<StructureItem /> matches the latest snapshot 1`] = `
-<ListItem
-  as={
-    Object {
-      "$$typeof": Symbol(react.forward_ref),
-      "displayName": "Link",
-      "propTypes": Object {
-        "innerRef": [Function],
-        "onClick": [Function],
-        "replace": [Function],
-        "target": [Function],
-        "to": [Function],
-      },
-      "render": [Function],
-    }
-  }
-  title="foo"
-  to="/structures/1"
->
-  <ListIcon
-    name="question circle outline"
-    verticalAlign="middle"
-  />
-  <ListContent>
-    <ListDescription>
-      foo
-    </ListDescription>
-  </ListContent>
-</ListItem>
+<div>
+  <a
+    class="item"
+    href="/structures/1"
+    role="listitem"
+    title="foo"
+  >
+    <i
+      aria-hidden="true"
+      class="question circle outline icon middle aligned"
+    />
+    <div
+      class="content"
+    >
+      <div
+        class="description"
+      >
+        foo
+      </div>
+    </div>
+  </a>
+</div>
+`;
+
+exports[`<StructureItem /> matches the latest snapshot with alias 1`] = `
+<div>
+  <a
+    class="item"
+    href="/structures/1"
+    role="listitem"
+    title="alias"
+  >
+    <i
+      aria-hidden="true"
+      class="question circle outline icon middle aligned"
+    />
+    <div
+      class="content"
+    >
+      <div
+        class="description"
+      >
+        alias
+      </div>
+    </div>
+  </a>
+</div>
 `;

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

@@ -1,8 +1,51 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`<StructureItems /> matches the latest snapshot 1`] = `
-<Connect(StructureItem)
-  id={1}
-  key="0"
-/>
+<div>
+  <a
+    class="item"
+    href="/structures/1"
+    role="listitem"
+    title="some structure"
+  >
+    <i
+      aria-hidden="true"
+      class="question circle outline icon middle aligned"
+    />
+    <div
+      class="content"
+    >
+      <div
+        class="description"
+      >
+        some structure
+      </div>
+    </div>
+  </a>
+</div>
+`;
+
+exports[`<StructureItems /> matches the latest snapshot with alias 1`] = `
+<div>
+  <a
+    class="item"
+    href="/structures/1"
+    role="listitem"
+    title="alias"
+  >
+    <i
+      aria-hidden="true"
+      class="question circle outline icon middle aligned"
+    />
+    <div
+      class="content"
+    >
+      <div
+        class="description"
+      >
+        alias
+      </div>
+    </div>
+  </a>
+</div>
 `;

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

@@ -95,6 +95,28 @@ exports[`<StructureProperties /> matches the latest snapshot 1`] = `
           </div>
         </div>
       </div>
+      <div
+        class="three wide column"
+      >
+        <div
+          class="item"
+        >
+          <div
+            class="content"
+          >
+            <h5
+              class="header"
+            >
+              Type
+            </h5>
+            <div
+              class="description"
+            >
+              Database
+            </div>
+          </div>
+        </div>
+      </div>
     </div>
   </div>
 </div>