@truedat/core 4.53.1 → 4.53.2

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [4.53.2] 2022-10-07
+
+### Added
+
+- [TD-5226] `useOperators` hook to load operators using GraphQL `functions`
+  query
+
 ## [4.52.4] 2022-09-30
 
 ### Fixed

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@truedat/core",
-  "version": "4.53.1",
+  "version": "4.53.2",
   "description": "Truedat Web Core",
   "sideEffects": false,
   "jsnext:main": "src/index.js",
@@ -35,7 +35,7 @@
     "@testing-library/jest-dom": "^5.16.4",
     "@testing-library/react": "^12.0.0",
     "@testing-library/user-event": "^13.2.1",
-    "@truedat/test": "4.53.1",
+    "@truedat/test": "4.53.2",
     "babel-jest": "^28.1.0",
     "babel-plugin-dynamic-import-node": "^2.3.3",
     "babel-plugin-lodash": "^3.3.4",
@@ -112,5 +112,5 @@
     "react-dom": ">= 16.8.6 < 17",
     "semantic-ui-react": ">= 0.88.2 < 2.1"
   },
-  "gitHead": "aec23f8f32a131dfa84620ec6e14c31916118d44"
+  "gitHead": "e29af66624aad6ecce065ced88c8cc2e320d67e2"
 }

package/src/api/queries.js

@@ -32,3 +32,20 @@ export const TEMPLATES_QUERY = gql`
     }
   }
 `;
+
+export const FUNCTIONS_QUERY = gql`
+  query Functions {
+    functions {
+      id
+      name
+      group
+      returnType
+      scope
+      args {
+        name
+        type
+        values
+      }
+    }
+  }
+`;

package/src/hooks/index.js

@@ -3,3 +3,4 @@ export * from "./useActiveRoutes";
 export * from "./useAuthorized";
 export * from "./usePath";
 export * from "./useOnScreen";
+export * from "./useOperators";

package/src/hooks/useOperators.js

@@ -0,0 +1,10 @@
+import { useQuery } from "@apollo/client";
+import { FUNCTIONS_QUERY } from "../api/queries";
+import { transform } from "../services/operators";
+
+export const useOperators = () => {
+  const { loading, error, data } = useQuery(FUNCTIONS_QUERY);
+  return { loading, error, data: data ? transform(data) : [] };
+};
+
+export default useOperators;

package/src/services/__tests__/operators.spec.js

@@ -0,0 +1,215 @@
+import { toItem, transform } from "../operators";
+
+describe("services: operators toItem should transform to existing operator/modifier format", () => {
+  const id = "123";
+
+  it("simple operator", () => {
+    expect(
+      toItem({
+        id,
+        name: "name",
+        returnType: "boolean",
+        args: [{ type: "xyz" }],
+      })
+    ).toEqual({ id, category: "xyz", name: "name", returnType: "boolean" });
+  });
+
+  it("includes scope and group", () => {
+    expect(
+      toItem({
+        id,
+        name: "name",
+        group: "group",
+        scope: "scope",
+        returnType: "boolean",
+        args: [{ type: "any" }],
+      })
+    ).toEqual({
+      id,
+      category: "any",
+      name: "name",
+      group: "group",
+      scope: "scope",
+      returnType: "boolean",
+    });
+  });
+
+  it("maps as a modifier with params if returnType is not boolean", () => {
+    expect(
+      toItem({
+        id,
+        name: "name",
+        returnType: "string",
+        args: [
+          { type: "cat" },
+          { name: "start", type: "number" },
+          { name: "end", type: "number" },
+        ],
+      })
+    ).toEqual({
+      id,
+      category: "cat",
+      name: "name",
+      type: "string",
+      params: [
+        { name: "start", type: "number" },
+        { name: "end", type: "number" },
+      ],
+      returnType: "string",
+    });
+  });
+
+  it("maps arity and values", () => {
+    expect(
+      toItem({
+        id,
+        name: "variation_on_count",
+        scope: "validation",
+        returnType: "boolean",
+        args: [
+          { type: "date" },
+          {
+            type: "string",
+            values: ["D-0", "D-1", "M-0", "M-1", "M-2", "Y-0", "Y-1"],
+          },
+          {
+            type: "string",
+            values: ["D-0", "D-1", "M-0", "M-1", "M-2", "Y-0", "Y-1"],
+          },
+        ],
+      })
+    ).toEqual({
+      id,
+      category: "date",
+      name: "variation_on_count",
+      value_type: "string",
+      fixed_values: ["D-0", "D-1", "M-0", "M-1", "M-2", "Y-0", "Y-1"],
+      scope: "validation",
+      arity: 2,
+      returnType: "boolean",
+    });
+  });
+
+  it("maps value_type_filter if type is 'ref'", () => {
+    expect(
+      toItem({
+        id,
+        name: "references",
+        scope: "validation_filter",
+        group: "references",
+        returnType: "boolean",
+        args: [{ type: "any" }, { type: "ref" }],
+      })
+    ).toEqual({
+      id,
+      category: "any",
+      group: "references",
+      name: "references",
+      value_type: "field",
+      value_type_filter: "any",
+      scope: "validation",
+      population: true,
+      returnType: "boolean",
+    });
+  });
+});
+
+describe("services: operators transform", () => {
+  test("transforms items and groups by category", () => {
+    const data = {
+      functions: [
+        {
+          id: "1",
+          name: "name",
+          returnType: "boolean",
+          args: [{ type: "xyz" }],
+        },
+        {
+          id: "2",
+          name: "name",
+          group: "group",
+          scope: "scope",
+          returnType: "boolean",
+          args: [{ type: "any" }],
+        },
+        {
+          id: "3",
+          name: "name",
+          returnType: "string",
+          args: [
+            { type: "cat" },
+            { name: "start", type: "number" },
+            { name: "end", type: "number" },
+          ],
+        },
+        {
+          id: "4",
+          name: "variation_on_count",
+          scope: "validation",
+          returnType: "boolean",
+          args: [
+            { type: "date" },
+            {
+              type: "string",
+              values: ["D-0", "D-1", "M-0", "M-1", "M-2", "Y-0", "Y-1"],
+            },
+            {
+              type: "string",
+              values: ["D-0", "D-1", "M-0", "M-1", "M-2", "Y-0", "Y-1"],
+            },
+          ],
+        },
+        {
+          id: "5",
+          name: "references",
+          scope: "validation_filter",
+          group: "references",
+          returnType: "boolean",
+          args: [{ type: "any" }, { type: "ref" }],
+        },
+      ],
+    };
+    expect(transform(data)).toEqual({
+      xyz: { operators: [{ id: "1", name: "name" }] },
+      any: {
+        operators: [
+          { id: "2", name: "name", group: "group", scope: "scope" },
+          {
+            id: "5",
+            name: "references",
+            group: "references",
+            scope: "validation",
+            value_type: "field",
+            value_type_filter: "any",
+            population: true,
+          },
+        ],
+      },
+      cat: {
+        modifiers: [
+          {
+            id: "3",
+            name: "name",
+            type: "string",
+            params: [
+              { name: "start", type: "number" },
+              { name: "end", type: "number" },
+            ],
+          },
+        ],
+      },
+      date: {
+        operators: [
+          {
+            arity: 2,
+            id: "4",
+            name: "variation_on_count",
+            scope: "validation",
+            value_type: "string",
+            fixed_values: ["D-0", "D-1", "M-0", "M-1", "M-2", "Y-0", "Y-1"],
+          },
+        ],
+      },
+    });
+  });
+});

package/src/services/operators.js

@@ -0,0 +1,54 @@
+import _ from "lodash/fp";
+
+export const toItem = ({
+  name,
+  group,
+  returnType,
+  scope,
+  id,
+  args: [{ type: category }, ...args],
+}) => {
+  const arity = _.size(args);
+  const arg1 = _.head(args);
+  const type = arg1?.type;
+  const values = arg1?.values;
+  const params =
+    _.isEmpty(args) || returnType === "boolean"
+      ? null
+      : _.map(_.pick(["name", "type"]))(args);
+  const value_type =
+    returnType === "boolean" ? (type === "ref" ? "field" : type) : null;
+  return _.pickBy(_.identity)({
+    arity: returnType === "boolean" && arity > 1 ? arity : null,
+    category,
+    name,
+    group: group,
+    scope: scope === "validation_filter" ? "validation" : scope || null,
+    id,
+    type: returnType === "boolean" ? null : returnType,
+    value_type,
+    value_type_filter: type === "ref" ? "any" : null,
+    population: scope === "validation_filter",
+    fixed_values: values,
+    returnType,
+    params,
+  });
+};
+
+// Transfrom functions from GraphQL API to old model (operators + modifiers)
+export const transform = _.flow(
+  _.propOr([], "functions"),
+  _.map(toItem),
+  _.flow(
+    _.groupBy("category"),
+    _.mapValues(_.map(_.omit(["category"]))),
+    _.mapValues(
+      _.flow(
+        _.groupBy(({ returnType }) =>
+          returnType === "boolean" ? "operators" : "modifiers"
+        ),
+        _.mapValues(_.map(_.omit(["returnType"])))
+      )
+    )
+  )
+);