@nolwenture/formik-jsonschema-form 0.1.0

package/.storybook/main.js

@@ -0,0 +1,13 @@
+module.exports = {
+  stories: ["../src/**/*.stories.mdx", "../src/**/*.stories.@(js|jsx|ts|tsx)"],
+  addons: [
+    "@storybook/addon-links",
+    "@storybook/addon-essentials",
+    "@storybook/addon-interactions",
+    "@storybook/preset-create-react-app",
+  ],
+  framework: "@storybook/react",
+  core: {
+    builder: "@storybook/builder-webpack5",
+  },
+};

package/.storybook/preview.js

@@ -0,0 +1,9 @@
+export const parameters = {
+  actions: { argTypesRegex: "^on[A-Z].*" },
+  controls: {
+    matchers: {
+      color: /(background|color)$/i,
+      date: /Date$/,
+    },
+  },
+};

package/README.md

@@ -0,0 +1,46 @@
+# Getting Started with Create React App
+
+This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+
+## Available Scripts
+
+In the project directory, you can run:
+
+### `npm start`
+
+Runs the app in the development mode.\
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+
+The page will reload if you make edits.\
+You will also see any lint errors in the console.
+
+### `npm test`
+
+Launches the test runner in the interactive watch mode.\
+See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+
+### `npm run build`
+
+Builds the app for production to the `build` folder.\
+It correctly bundles React in production mode and optimizes the build for the best performance.
+
+The build is minified and the filenames include the hashes.\
+Your app is ready to be deployed!
+
+See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+
+### `npm run eject`
+
+**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+
+If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+
+Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
+
+You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
+
+## Learn More
+
+You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+
+To learn React, check out the [React documentation](https://reactjs.org/).

package/package.json

@@ -0,0 +1,90 @@
+{
+  "name": "@nolwenture/formik-jsonschema-form",
+  "version": "0.1.0",
+  "description": "Formik form generation from json schema",
+  "author": "Antti Vikman <antti.vikman@nolwenture.com>",
+  "contributors": [
+    "Antti Vikman <antti.vikman@nolwenture.com>"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nolwenture/formik-jsonschema-form.git"
+  },
+  "bugs": {
+    "url": "https://github.com/nolwenture/formik-jsonschema-form/issues"
+  },
+  "homepage": "https://github.com/nolwenture/formik-jsonschema-form#readme",
+  "keywords": [
+    "formik",
+    "jsonschema"
+  ],
+  "dependencies": {
+    "@testing-library/jest-dom": "^5.16.4",
+    "@testing-library/react": "^13.3.0",
+    "@testing-library/user-event": "^13.5.0",
+    "@types/jest": "^27.5.2",
+    "@types/node": "^16.11.45",
+    "@types/react": "^18.0.15",
+    "@types/react-dom": "^18.0.6",
+    "@types/styled-components": "^5.1.25",
+    "formik": "^2.2.9",
+    "json-schema": "^0.4.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "react-scripts": "5.0.1",
+    "styled-components": "^5.3.5",
+    "typescript": "^4.7.4",
+    "web-vitals": "^2.1.4"
+  },
+  "scripts": {
+    "start": "react-scripts start",
+    "build": "react-scripts build",
+    "test": "react-scripts test",
+    "eject": "react-scripts eject",
+    "storybook": "start-storybook -p 6006",
+    "build-storybook": "build-storybook"
+  },
+  "eslintConfig": {
+    "extends": [
+      "react-app",
+      "react-app/jest"
+    ],
+    "overrides": [
+      {
+        "files": [
+          "**/*.stories.*"
+        ],
+        "rules": {
+          "import/no-anonymous-default-export": "off"
+        }
+      }
+    ]
+  },
+  "browserslist": {
+    "production": [
+      ">0.2%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 1 chrome version",
+      "last 1 firefox version",
+      "last 1 safari version"
+    ]
+  },
+  "devDependencies": {
+    "@storybook/addon-essentials": "^6.5.9",
+    "@storybook/addon-interactions": "^6.5.9",
+    "@storybook/addon-links": "^6.5.9",
+    "@storybook/builder-webpack5": "^6.5.9",
+    "@storybook/manager-webpack5": "^6.5.9",
+    "@storybook/node-logger": "^6.5.9",
+    "@storybook/preset-create-react-app": "^4.1.2",
+    "@storybook/react": "^6.5.9",
+    "@storybook/testing-library": "^0.0.13",
+    "babel-plugin-named-exports-order": "^0.0.2",
+    "prop-types": "^15.8.1",
+    "webpack": "^5.73.0"
+  }
+}

package/src/Form.stories.tsx

@@ -0,0 +1,124 @@
+import { ComponentStory, ComponentMeta } from "@storybook/react";
+import { action } from "@storybook/addon-actions";
+import styled from "styled-components";
+import { Formik, useFormikContext } from "formik";
+
+import {
+  completeSchema,
+  completeUiSchema,
+  SimpleFormDataType,
+  simpleSchema,
+  simpleUiSchema,
+  generatedSchema,
+} from "./_sampleData";
+import { Form, styledComponents } from "./";
+
+export default {
+  title: "Form",
+  component: Form,
+  // More on argTypes: https://storybook.js.org/docs/react/api/argtypes
+  argTypes: {
+    schema: { control: { type: "object" } },
+    uiSchema: { control: { type: "object" } },
+  },
+} as ComponentMeta<typeof Form>;
+
+const Template: ComponentStory<typeof Form> = (args) => (
+  <Formik
+    initialValues={{}}
+    onSubmit={async (values, formikHelpers) => {
+      action("onSubmit(_, formHelper)")(formikHelpers);
+      action("onSubmit(values)")(values);
+      formikHelpers.setSubmitting(false);
+    }}
+  >
+    <Form {...args} />
+  </Formik>
+);
+
+export const Simple = Template.bind({});
+Simple.args = {
+  schema: simpleSchema,
+};
+
+export const WithUiSchema = Template.bind({});
+WithUiSchema.args = {
+  schema: simpleSchema,
+  uiSchema: simpleUiSchema,
+};
+
+export const CompleteSchema = Template.bind({});
+CompleteSchema.args = {
+  schema: completeSchema,
+  uiSchema: completeUiSchema,
+};
+
+export const StrictlyTyped = () => {
+  return (
+    <Formik<SimpleFormDataType>
+      initialValues={{ firstName: "", lastName: "" }}
+      onSubmit={async (values, formikHelpers) => {
+        action("onSubmit(_, formHelper)")(formikHelpers);
+        action("onSubmit(values)")(values);
+        formikHelpers.setSubmitting(false);
+      }}
+    >
+      <Form<SimpleFormDataType> schema={simpleSchema} />
+    </Formik>
+  );
+};
+
+/*** CUSTOMIZATION  ***/
+const CustomizedForm = styled(Form)`
+  ${styledComponents.FieldTitle} {
+    color: red;
+  }
+`;
+
+const CustomizedFieldWrapper = styled.div`
+  outline: 2px solid
+    ${(props) => (props.title === "ABC" ? "blue" : "transparent")};
+`;
+
+const CustomizedErrorMessage = (props: { name: keyof SimpleFormDataType }) => {
+  const { name } = props;
+  const { errors } = useFormikContext<SimpleFormDataType>();
+  const error = errors[name];
+  return error ? <p>{error}</p> : <p>Hurray! No errors</p>;
+};
+
+export const StylesCustomized = () => {
+  return (
+    <Formik
+      initialValues={{}}
+      onSubmit={async (values, formikHelpers) => {
+        action("onSubmit(_, formHelper)")(formikHelpers);
+        action("onSubmit(values)")(values);
+        formikHelpers.setSubmitting(false);
+      }}
+    >
+      <CustomizedForm
+        schema={simpleSchema}
+        uiSchema={{
+          firstName: {
+            props: {
+              wrapper: {
+                title: "ABC",
+              },
+            },
+          },
+        }}
+        components={{
+          FieldWrapper: CustomizedFieldWrapper,
+          ErrorMessage: CustomizedErrorMessage,
+        }}
+      />
+    </Formik>
+  );
+};
+
+export const WithGeneratedSchema = Template.bind({});
+WithGeneratedSchema.args = {
+  schema: generatedSchema,
+  uiSchema: {},
+};

package/src/Form.test.tsx

@@ -0,0 +1,10 @@
+import React from "react";
+import { render, screen } from "@testing-library/react";
+import { Form } from "./Form";
+import { SimpleFormDataType, simpleSchema } from "./_sampleData";
+
+test("renders title", () => {
+  render(<Form<SimpleFormDataType> schema={simpleSchema} />);
+  const titleElement = screen.getByText(/TITLE/i);
+  expect(titleElement).toBeInTheDocument();
+});

package/src/Form.tsx

@@ -0,0 +1,71 @@
+import React from "react";
+import { FormProps, FormRegistryContextValue } from "./types";
+import { useFormikContext } from "formik";
+
+import * as defaultComponents from "./styledComponents";
+import { warnFromUnsupportedKeys } from "./utils";
+
+import * as defaultFields from "./fields";
+import * as defaultTemplates from "./templates";
+
+export const FormRegistry = React.createContext<FormRegistryContextValue>({
+  fields: defaultFields,
+  templates: defaultTemplates,
+  components: defaultComponents,
+  definitions: {},
+  formContext: {},
+});
+
+export function Form<T>(props: FormProps<T>) {
+  warnFromUnsupportedKeys("Form", props, [
+    "schema",
+    "onSubmit",
+    "uiSchema",
+    "className",
+    "formData",
+    "className",
+    "children",
+    "fields",
+    "formContext",
+  ]);
+  const { isSubmitting } = useFormikContext<T>();
+  const {
+    schema,
+    uiSchema = {},
+    className,
+    children,
+    fields = {},
+    templates = {},
+    components = {},
+    formContext = {},
+  } = props;
+
+  const registry = {
+    fields: { ...defaultFields, ...fields },
+    templates: { ...defaultTemplates, ...templates },
+    components: { ...defaultComponents, ...components },
+    definitions: {},
+    formContext,
+  };
+
+  const { Form: FormEl, FormButton, FormButtonWrapper } = registry.components;
+
+  const _SchemaField = registry.fields.SchemaField;
+
+  return (
+    <FormRegistry.Provider value={registry}>
+      <FormEl className={className}>
+        <_SchemaField name={""} schema={schema} uiSchema={uiSchema} />
+        {children ? (
+          children
+        ) : (
+          <FormButtonWrapper>
+            <FormButton type="submit" disabled={isSubmitting}>
+              Send
+            </FormButton>
+          </FormButtonWrapper>
+        )}
+      </FormEl>
+    </FormRegistry.Provider>
+  );
+}

package/src/FormEditor.stories.tsx

@@ -0,0 +1,17 @@
+import { ComponentStory, ComponentMeta } from "@storybook/react";
+import { action } from "@storybook/addon-actions";
+import { FormEditor } from "./FormEditor";
+
+export default {
+  title: "FormEditor",
+  component: FormEditor,
+  // More on argTypes: https://storybook.js.org/docs/react/api/argtypes
+  argTypes: {},
+} as ComponentMeta<typeof FormEditor>;
+
+const Template: ComponentStory<typeof FormEditor> = (args) => (
+  <FormEditor {...args} />
+);
+
+export const Default = Template.bind({});
+Default.args = {};

package/src/FormEditor.tsx

@@ -0,0 +1,53 @@
+import { Formik } from "formik";
+import { useEffect, useState } from "react";
+import { Form } from "./Form";
+import { Schema, UiSchema } from "./types";
+import * as formEditorSchemas from "./formEditorSchemas";
+
+export type FormEditorProps = {};
+export type FormEditorValues = {
+  schema: Schema;
+  uiSchema: UiSchema;
+};
+
+export function FormEditor(props: FormEditorProps) {
+  const [editorGeneratedSchemas, setEditorGeneratedSchemas] =
+    useState<FormEditorValues>({
+      schema: {},
+      uiSchema: {},
+    });
+  useEffect(
+    () => console.log(editorGeneratedSchemas),
+    [editorGeneratedSchemas]
+  );
+
+  return (
+    <div style={{ display: "flex", justifyContent: "space-between" }}>
+      <div>
+        <h1>Editor</h1>
+        <Formik<FormEditorValues>
+          initialValues={{ schema: {}, uiSchema: {} }}
+          onSubmit={async (values, formikHelpers) => {
+            setEditorGeneratedSchemas(values);
+            formikHelpers.setSubmitting(false);
+          }}
+        >
+          <Form<FormEditorValues> {...formEditorSchemas} />
+        </Formik>
+      </div>
+      <div>
+        <h1>Preview</h1>
+        <Formik
+          initialValues={{}}
+          onSubmit={async (values, formikHelpers) => {
+            // action("onSubmit(_, formHelper)")(formikHelpers);
+            // action("onSubmit(values)")(values);
+            formikHelpers.setSubmitting(false);
+          }}
+        >
+          <Form {...editorGeneratedSchemas} />
+        </Formik>
+      </div>
+    </div>
+  );
+}