typesafe recursive metadata

gadget-inc · Oct 18, 2024 · 5d2ac2f · 5d2ac2f
1 parent fce894e
commit 5d2ac2f
Show file tree

Hide file tree

Showing 29 changed files with 4,235 additions and 2,833 deletions.
diff --git a/packages/react/spec/auto/MockForm.tsx b/packages/react/spec/auto/MockForm.tsx
@@ -7,15 +7,15 @@ import { FormProvider, useForm } from "../../src/useActionForm.js";
 import { testApi as api } from "../apis.js";
 import { MockClientProvider } from "../testWrappers.js";
 
-export const MockForm = ({ submit, metadata, submitResult, resolver }: AutoFormMetadataContext & { resolver?: any }) => {
+export const MockForm = ({ submit, metadata, submitResult, resolver }: Partial<AutoFormMetadataContext> & { resolver?: any }) => {
   return (props: { children: ReactNode }) => {
     // eslint-disable-next-line react-hooks/rules-of-hooks
     const methods = useForm({ resolver });
 
     return (
       <MockClientProvider api={api}>
         <FormProvider {...methods}>
-          <AutoFormMetadataContext.Provider value={{ submit, metadata, submitResult }}>
+          <AutoFormMetadataContext.Provider value={{ submit: submit!, metadata, submitResult }}>
             <AppProvider i18n={translations}>
               {/* eslint-disable-next-line @typescript-eslint/no-misused-promises */}
               <form onSubmit={methods.handleSubmit(submit as any)}>

diff --git a/packages/react/spec/auto/PolarisAutoForm.spec.tsx b/packages/react/spec/auto/PolarisAutoForm.spec.tsx
@@ -28,7 +28,7 @@ describe("PolarisAutoForm", () => {
   describe("when used as a one liner", () => {
     describe("for widget create", () => {
       test("it renders the name input", async () => {
-        render(<PolarisAutoForm action={api.widget.create} />, { wrapper: PolarisMockedProviders });
+        render(<PolarisAutoForm action={api.widget.create} exclude={["section", "gizmos"]} />, { wrapper: PolarisMockedProviders });
         loadMockWidgetCreateMetadata();
         expect(await screen.findByLabelText("Name")).toBeInTheDocument();
       });
@@ -69,7 +69,7 @@ describe("PolarisAutoForm", () => {
     test("it includes the record ID when submitting a form that updates a record", async () => {
       const user = userEvent.setup();
 
-      const result = render(<PolarisAutoForm action={api.widget.update} exclude={["gizmos"]} findBy="1145" />, {
+      const result = render(<PolarisAutoForm action={api.widget.update} exclude={["section", "gizmos"]} findBy="1145" />, {
         wrapper: PolarisMockedProviders,
       });
       const { getByLabelText, queryAllByText } = result;
@@ -266,7 +266,7 @@ describe("PolarisAutoForm", () => {
     test("it should include fields that are not dirty when submitting an update form", async () => {
       const user = userEvent.setup();
 
-      const result = render(<PolarisAutoForm action={api.widget.update} exclude={["gizmos"]} findBy="1145" />, {
+      const result = render(<PolarisAutoForm action={api.widget.update} exclude={["section", "gizmos"]} findBy="1145" />, {
         wrapper: PolarisMockedProviders,
       });
       const { getByLabelText, queryAllByText } = result;
@@ -311,9 +311,6 @@ describe("PolarisAutoForm", () => {
         name: "Test Widget",
         roles: [],
         secretKey: null,
-        section: {
-          _link: undefined,
-        },
         startsAt: null,
       });
       expect(recordId).toEqual("1145");
@@ -619,7 +616,7 @@ describe("PolarisAutoForm", () => {
       beforeEach(() => {
         user = userEvent.setup();
 
-        renderResult = render(<PolarisAutoForm action={api.widget.update} exclude={["gizmos"]} findBy="1145" />, {
+        renderResult = render(<PolarisAutoForm action={api.widget.update} exclude={["section", "gizmos"]} findBy="1145" />, {
           wrapper: PolarisMockedProviders,
         });
 
@@ -708,7 +705,6 @@ function loadMockGizmoCreateMetadata() {
     modelApiIdentifier: "gizmo",
     modelNamespace: null,
     action: "create",
-    includeRelatedFields: false,
   });
 
   mockUrqlClient.executeQuery.pushResponse("ModelActionMetadata", {
@@ -727,7 +723,6 @@ function loadMockWidgetCreateMetadata(opts?: { inputFields?: any[]; triggers?: a
     modelApiIdentifier: "widget",
     modelNamespace: null,
     action: "create",
-    includeRelatedFields: false,
   });
 
   mockUrqlClient.executeQuery.pushResponse("ModelActionMetadata", {
@@ -783,7 +778,6 @@ const mockWidgetUpdateHelperFunctions = {
       modelApiIdentifier: "widget",
       modelNamespace: null,
       action: "update",
-      includeRelatedFields: false,
     });
   },
 };
@@ -793,7 +787,6 @@ function loadMockWidgetDeleteMetadata() {
     modelApiIdentifier: "widget",
     modelNamespace: null,
     action: "delete",
-    includeRelatedFields: false,
   });
 
   mockUrqlClient.executeQuery.pushResponse("ModelActionMetadata", {
@@ -814,7 +807,6 @@ function loadMockFlipAllMetadata(opts?: { triggers?: any[] }) {
   expect(mockUrqlClient.executeQuery.mock.calls[0][0].variables).toEqual({
     namespace: null,
     apiIdentifier: "flipAll",
-    includeRelatedFields: false,
   });
 
   mockUrqlClient.executeQuery.pushResponse("GlobalActionMetadata", {

diff --git a/packages/react/spec/auto/hooks/helpers.spec.ts b/packages/react/spec/auto/hooks/helpers.spec.ts
@@ -1,6 +1,6 @@
-import { GadgetRecord } from "@gadgetinc/api-client-core";
-import type { FieldMetadataFragment } from "../../../src/internal/gql/graphql.js";
+import type { GadgetRecord } from "@gadgetinc/api-client-core";
 import { GadgetFieldType } from "../../../src/internal/gql/graphql.js";
+import type { FieldMetadata } from "../../../src/metadata.js";
 import {
   fieldMetadataArrayToFieldMetadataTree,
   getTableColumns,
@@ -511,7 +511,7 @@ const getSimpleFieldMetadata = (name: string, apiIdentifier: string, fieldType:
     fieldType,
     configuration: gadgetGenericFieldConfig,
     sortable: sortable ?? true,
-  } as FieldMetadataFragment;
+  } as FieldMetadata;
 };
 
 const getRelationshipFieldMetadata = (props: {
@@ -539,7 +539,7 @@ const getRelationshipFieldMetadata = (props: {
         defaultDisplayField,
       },
     },
-  } as FieldMetadataFragment;
+  } as FieldMetadata;
 };
 
 const fieldMetadataTreeWithRelationship = fieldMetadataArrayToFieldMetadataTree([

diff --git a/packages/react/spec/auto/hooks/useFieldMetadata.spec.tsx b/packages/react/spec/auto/hooks/useFieldMetadata.spec.tsx
@@ -1,13 +1,13 @@
 import { jest } from "@jest/globals";
 import { renderHook } from "@testing-library/react";
 import { useFieldMetadata } from "../../../src/auto/hooks/useFieldMetadata.js";
-import type { ActionMetadata } from "../../../src/metadata.js";
+import { GadgetFieldType } from "../../../src/internal/gql/graphql.js";
 import { MockForm } from "../MockForm.js";
 
 describe("useFieldMetadata hook", () => {
   const getUseFieldMetadataResult = (fieldApiId: string) => {
     const { result } = renderHook(() => useFieldMetadata(fieldApiId), {
-      wrapper: MockForm({ submit: jest.fn<any>(), metadata }),
+      wrapper: MockForm({ submit: jest.fn<any>(), metadata: metadata as any }),
     });
 
     return result.current;
@@ -62,7 +62,7 @@ describe("useFieldMetadata hook", () => {
   });
 });
 
-const metadata: ActionMetadata = {
+const metadata = {
   name: "Widget",
   apiIdentifier: "widget",
   action: {
@@ -72,11 +72,11 @@ const metadata: ActionMetadata = {
       {
         name: "Widget",
         apiIdentifier: "widget",
-        fieldType: "Object",
+        fieldType: GadgetFieldType.Object,
         requiredArgumentForInput: false,
         configuration: {
           __typename: "GadgetObjectFieldConfig",
-          fieldType: "Object",
+          fieldType: GadgetFieldType.Object,
           name: null,
           fields: [
             {
@@ -115,4 +115,4 @@ const metadata: ActionMetadata = {
     __typename: "GadgetAction",
   },
   __typename: "GadgetModel",
-} as ActionMetadata;
+};
diff --git a/packages/react/spec/auto/hooks/useFormFields.spec.tsx b/packages/react/spec/auto/hooks/useFormFields.spec.tsx
@@ -2,7 +2,7 @@ import { jest } from "@jest/globals";
 import { renderHook } from "@testing-library/react";
 import { useFormFields } from "../../../src/auto/AutoForm.js";
 import { useAutoFormMetadata } from "../../../src/auto/AutoFormContext.js";
-import type { ActionMetadata } from "../../../src/metadata.js";
+import type { ModelWithOneActionMetadata } from "../../../src/metadata.js";
 import { MockForm } from "../MockForm.js";
 
 const shopifyShopModelKey = "DataModel-Shopify-Shop";
@@ -96,7 +96,7 @@ describe("useFormFields hook", () => {
   });
 });
 
-const metadata: ActionMetadata = {
+const metadata: ModelWithOneActionMetadata = {
   name: "Widget",
   apiIdentifier: "widget",
   action: {
@@ -239,7 +239,7 @@ const metadata: ActionMetadata = {
     __typename: "GadgetAction",
   },
   __typename: "GadgetModel",
-} as ActionMetadata;
+} as ModelWithOneActionMetadata;
 
 const autoFormMetadataWithDuplicateInputFields = {
   name: "Auto table test",