@truedat/core 6.3.0 → 6.3.2

package/src/hooks/__tests__/useAclEntries.spec.js

@@ -0,0 +1,143 @@
+import { compile } from "path-to-regexp";
+import { waitFor } from "@testing-library/react";
+import { renderHook } from "@testing-library/react-hooks";
+import { API_ACL_RESOURCE_ENTRIES, API_ACL_ENTRY } from "../../api";
+import { apiJsonPost, apiJsonPatch, apiJsonDelete } from "../../services/api";
+import {
+  useAclEntries,
+  useAclEntryCreate,
+  useAclEntryUpdate,
+  useAclEntryDelete,
+} from "../useAclEntries";
+
+jest.mock("@truedat/core/services/api", () => {
+  const originalModule = jest.requireActual("@truedat/core/services/api");
+
+  return {
+    __esModule: true,
+    ...originalModule,
+    apiJson: jest.fn(() => ({
+      data: {
+        _embedded: {
+          acl_entries: [
+            {
+              _links: {
+                self: {
+                  href: "/api/acl_entries/1",
+                  methods: ["GET", "DELETE", "POST"],
+                },
+              },
+              acl_entry_id: 1,
+              description: null,
+              principal: {
+                full_name: "Foo",
+                id: 11,
+                user_name: "foo@bar.com",
+              },
+              principal_type: "user",
+              role_id: 111,
+              role_name: "baz",
+            },
+          ],
+        },
+      },
+    })),
+    apiJsonPost: jest.fn(),
+    apiJsonPatch: jest.fn(),
+    apiJsonDelete: jest.fn(),
+  };
+});
+
+const id = 1;
+const resource = {
+  type: "domain",
+  id,
+};
+
+const payload = {
+  acl_entry: {
+    role_name: "role2",
+    resource_type: resource.type,
+    principal_type: "user",
+    principal_id: 1,
+    description: "foo",
+  },
+};
+
+const acl_entry = {
+  acl_entry_id: id,
+  description: null,
+  principal: {
+    full_name: "Foo",
+    id: 11,
+    user_name: "foo@bar.com",
+  },
+  principal_type: "user",
+  role_id: 111,
+  role_name: "baz",
+};
+
+describe("hooks: useAclEntries", () => {
+  it("use acl entries return acl entries correctly", () => {
+    const {
+      result: {
+        current: { data },
+      },
+    } = renderHook(() => useAclEntries(resource));
+
+    waitFor(() =>
+      expect(data).toBe(
+        expect.objectContaining({
+          aclEntries: [acl_entry],
+          actions: { canCreate: true },
+        })
+      )
+    );
+  });
+
+  it("create acl entry trigger calls api json post with correct url and payload", () => {
+    const {
+      result: {
+        current: { trigger },
+      },
+    } = renderHook(() => useAclEntryCreate(resource));
+
+    trigger(payload);
+
+    const url = compile(API_ACL_RESOURCE_ENTRIES)(resource);
+    expect(apiJsonPost).toHaveBeenCalledWith(url, {
+      ...payload,
+    });
+  });
+
+  it("update acl entry trigger calls api json patch with correct url and payload", () => {
+    const {
+      result: {
+        current: { trigger },
+      },
+    } = renderHook(() => useAclEntryUpdate(resource.id));
+
+    trigger(payload);
+
+    const url = compile(API_ACL_ENTRY)({ id: resource.id });
+    expect(apiJsonPatch).toHaveBeenCalledWith(url, {
+      ...payload,
+    });
+  });
+
+  it("update acl entry trigger calls api json delete with correct url", () => {
+    const {
+      result: {
+        current: { trigger },
+      },
+    } = renderHook(() => useAclEntryDelete(resource.id));
+
+    trigger();
+
+    const url = compile(API_ACL_ENTRY)({ id: resource.id });
+    expect(apiJsonDelete).toHaveBeenCalledWith(
+      url,
+      expect.objectContaining({})
+    );
+  });
+});

package/src/hooks/useAclEntries.js

@@ -0,0 +1,44 @@
+import { compile } from "path-to-regexp";
+import _ from "lodash/fp";
+import useSWR from "swr";
+import useSWRMutation from "swr/mutation";
+import { accentInsensitivePathOrder } from "../services/sort";
+import { API_ACL_ENTRY, API_ACL_RESOURCE_ENTRIES } from "../api";
+import {
+  apiJson,
+  apiJsonPatch,
+  apiJsonPost,
+  apiJsonDelete,
+  JSON_OPTS,
+} from "../services/api";
+
+export const useAclEntries = (resource) => {
+  const url = compile(API_ACL_RESOURCE_ENTRIES)(resource);
+  const { data, error, loading, mutate } = useSWR(url, apiJson);
+  const aclEntries = _.flow(
+    _.pathOr([], "_embedded.acl_entries"),
+    _.sortBy(accentInsensitivePathOrder("user_name"))
+  )(data?.data);
+  const actions = {
+    canCreate: _.flow(
+      _.pathOr([], "_links.self.methods"),
+      _.includes("POST")
+    )(data?.data),
+  };
+  return { data: { aclEntries, actions }, error, loading, mutate };
+};
+
+export const useAclEntryCreate = (resource) => {
+  const url = compile(API_ACL_RESOURCE_ENTRIES)(resource);
+  return useSWRMutation(url, (url, { arg }) => apiJsonPost(url, arg));
+};
+
+export const useAclEntryUpdate = (id) => {
+  const url = compile(API_ACL_ENTRY)({ id });
+  return useSWRMutation(url, (url, { arg }) => apiJsonPatch(url, arg));
+};
+
+export const useAclEntryDelete = (id) => {
+  const url = compile(API_ACL_ENTRY)({ id });
+  return useSWRMutation(url, (url) => apiJsonDelete(url, JSON_OPTS));
+};

package/src/routes.js

@@ -1,6 +1,7 @@
 import _ from "lodash/fp";
 import { compile } from "path-to-regexp";
 
+export const AI_SANDBOX = "/aiSandbox";
 export const CALLBACK = "/callback";
 export const BUCKETS_VIEW = "/buckets/:propertyPath";
 export const BUCKET_VIEW = "/bucketStructures";
@@ -148,6 +149,7 @@ export const PROFILE_EXECUTION =
   "/profileGroups/:group_id/profileExecutions/:id";
 export const PROFILE_GROUP = "/profileGroups/:id";
 export const PROMPTS = "/prompts";
+export const PROVIDERS = "/providers";
 export const QUALITY_CONTROLS = "/qualityControls";
 export const QUALITY_CONTROLS_DEPRECATED = "/qualityControls/deprecated";
 export const QUALITY_CONTROLS_DRAFTS = "/qualityControls/drafts";
@@ -213,15 +215,17 @@ export const STRUCTURE_STRUCTURE_LINKS_NEW =
   "/structures/:id/structureLinks/new";
 export const STRUCTURE_LINKS = "/structures/:id/links";
 export const STRUCTURE_LINKS_NEW = "/structures/:id/links/new";
+export const STRUCTURE_MEMBERS = "/structures/:id/members";
+export const STRUCTURE_MEMBERS_NEW = "/structures/:id/members/new";
 export const STRUCTURE_METADATA = "/structures/:id/metadata";
 export const STRUCTURE_NOTES = "/structures/:id/notes";
 export const STRUCTURE_NOTES_EDIT = "/structures/:id/notes/edit";
 export const STRUCTURE_PARENTS = "/structures/:id/parents";
 export const STRUCTURE_PROFILE = "/structures/:id/profile";
 export const STRUCTURE_RULES = "/structures/:id/rules";
+export const STRUCTURE_TAG_EDIT = "/structureTags/:id/edit";
 export const STRUCTURE_TAGS = "/structureTags";
 export const STRUCTURE_TAGS_NEW = "/structureTags/new";
-export const STRUCTURE_TAG_EDIT = "/structureTags/:id/edit";
 export const STRUCTURE_TYPES = "/structureTypes";
 export const STRUCTURE_TYPES_EDIT = "/structureTypes/:id/edit";
 export const STRUCTURE_VERSION = "/structures/:id/versions/:version";
@@ -251,6 +255,7 @@ export const USER_EDIT = "/users/:id/edit";
 export const USER_EDIT_PASSWORD = "/users/:id/password";
 
 const routes = {
+  AI_SANDBOX,
   CALLBACK,
   BUCKETS_VIEW,
   BUCKET_VIEW,
@@ -365,6 +370,7 @@ const routes = {
   PROFILE_EXECUTION,
   PROFILE_GROUP,
   PROMPTS,
+  PROVIDERS,
   QUALITY_CONTROLS,
   QUALITY_CONTROLS_DEPRECATED,
   QUALITY_CONTROLS_DRAFTS,
@@ -425,9 +431,11 @@ const routes = {
   STRUCTURE_STRUCTURE_LINKS_NEW,
   STRUCTURE_LINKS,
   STRUCTURE_LINKS_NEW,
+  STRUCTURE_MEMBERS_NEW,
+  STRUCTURE_MEMBERS,
   STRUCTURE_METADATA,
-  STRUCTURE_NOTES,
   STRUCTURE_NOTES_EDIT,
+  STRUCTURE_NOTES,
   STRUCTURE_PARENTS,
   STRUCTURE_PROFILE,
   STRUCTURE_RULES,