Add flow lib defs to repository (#5)

Author: nathanalam

.flowconfig

@@ -1,6 +1,7 @@
 # Default flow options are good for most use cases, so this is left blank.
 [ignore]
 .*/example/.*
+.*/flow-libdef/.*
 
 [include]
 
@@ -19,7 +20,6 @@ module.file_ext=.js
 .*/node_modules/react-select/.*
 .*/node_modules/react-jss/.*
 .*/node_modules/react-beautiful-dnd/.*
-.*/node_modules/@ginkgo-bioworks/react-json-schema-form-builder/.*
 
 [version]
 0.92.1

.gitignore

@@ -11,6 +11,6 @@ coverage
 dist
 example/build
 
-.DS-store
+.DS_Store
 
 npm-debug.log*

CONTRIBUTING.md

@@ -14,6 +14,8 @@ In this repository, the source code for the component library is in the `src` di
 
 The example app being run on the [GitHub Pages site](https://ginkgobioworks.github.io/react-json-schema-form-builder/), meanwhile, has its code stored in the `example` directory. It relies on an additional set of dependencies, which are stored in the `devDependencies` within the `package.json` file.
 
+Library definitions for [Flow type annotations](https://flow.org/en/docs/types/) are stored in `src/flowlibdefs`, where the file structure under the `flow-typed` [best practices](https://github.com/flow-typed/flow-typed/blob/master/CONTRIBUTING.md) are followed. If any of the types in `src/formBuilder/types.js` are changed, or if the properties of the `FormBuilder` or `PredefinedGallery` are altered, then these flow typed library definitions should also be changed. This library definition is altered manually, and is currently set for major version 1 of the Form Builder. To update to library definition a PR must be made on the [flow-typed repository](https://github.com/flow-typed/flow-typed).
+
 ## Testing
 
 The `src` directory also contains testing files written for the [jest](https://jestjs.io/en/) test harness. The tests use [Enzyme](https://github.com/enzymejs/enzyme) for component and DOM manipulation and traversal. These tests are run in the CI/CD pipeline, and must pass before a branch can be merged into the 'main' branch. Changes may be needed to the test harness to accommodate new features or fixes.

flow-libdef/@ginkgo-bioworks/react-json-schema-form-builder_v1.x.x/flow_v0.30.x-v0.103.x/react-json-schema-form-builder_v1.x.x.js

@@ -0,0 +1,120 @@
+declare module '@ginkgo-bioworks/react-json-schema-form-builder' {
+  declare type CardProps = {
+    name: string,
+    required: boolean,
+    dataOptions: { [string]: any },
+    uiOptions: { [string]: any },
+    $ref?: string,
+    dependents?: Array<{
+      children: Array<string>,
+      value?: any,
+    }>,
+    dependent?: boolean,
+    parent?: string,
+    propType: string,
+    neighborNames: Array<string>,
+  };
+
+  declare type SectionProps = {
+    name: string,
+    required: boolean,
+    schema: { [string]: any },
+    uischema: { [string]: any },
+    $ref?: string,
+    dependents?: Array<{
+      children: Array<string>,
+      value?: any,
+    }>,
+    dependent?: boolean,
+    propType: string,
+    neighborNames: Array<string>,
+  };
+
+  declare type ElementProps = CardProps & SectionProps;
+
+  declare type Parameters = {
+    [string]: string | number | boolean | Array<string | number>,
+    name: string,
+    path: string,
+    definitionData: { [string]: any },
+    definitionUi: { [string]: any },
+    category: string,
+    'ui:option': { [string]: any },
+  };
+
+  declare type DataType =
+    | 'string'
+    | 'number'
+    | 'boolean'
+    | 'integer'
+    | 'array'
+    | '*'
+    | null;
+
+  declare type MatchType = {
+    types: Array<DataType>,
+    widget?: string,
+    field?: string,
+    format?: string,
+    $ref?: boolean,
+    enum?: boolean,
+  };
+
+  declare type FormInput = {
+    displayName: string,
+    // given a data and ui schema, determine if the object is of this input type
+    matchIf: Array<MatchType>,
+    // allowed keys for ui:options
+    possibleOptions?: Array<string>,
+    defaultDataSchema: {
+      [string]: any,
+    },
+    defaultUiSchema: {
+      [string]: any,
+    },
+    // the data schema type
+    type: DataType,
+    // inputs on the preview card
+    cardBody: React.AbstractComponent<{
+      parameters: Parameters,
+      onChange: (newParams: Parameters) => void,
+      mods: { [string]: any },
+    }>,
+    // inputs for the modal
+    modalBody?: React.AbstractComponent<{
+      parameters: Parameters,
+      onChange: (newParams: Parameters) => void,
+    }>,
+  };
+
+  // optional properties that can add custom features to the form builder
+  declare type Mods = {
+    customFormInputs?: {
+      [string]: FormInput,
+    },
+    tooltipDescriptions?: {
+      add?: string,
+      cardObjectName?: string,
+      cardDisplayName?: string,
+      cardDescription?: string,
+      cardInputType?: string,
+    },
+  };
+
+  declare type FormBuilderProps = {
+    schema: string,
+    uischema: string,
+    onChange: (string, string) => any,
+    mods?: Mods,
+    className?: string,
+  };
+
+  declare export class FormBuilder extends React$Component<FormBuilderProps> {
+    static defaultProps: FormBuilderProps;
+  }
+
+  declare export class PredefinedGallery
+    extends React$Component<FormBuilderProps> {
+    static defaultProps: FormBuilderProps;
+  }
+}

flow-libdef/@ginkgo-bioworks/react-json-schema-form-builder_v1.x.x/test_react-json-schema-form-builder_v1.x.x.js

@@ -0,0 +1,26 @@
+// @flow
+
+import React from 'react';
+import {
+  FormBuilder,
+  PredefinedGallery,
+} from '@ginkgo-bioworks/react-json-schema-form-builder';
+import { it, describe, expect } from 'flow-typed-test';
+import { mount } from 'enzyme';
+
+describe('@ginkgo-bioworks/react-json-schema-form-builder', () => {
+  const props = {
+    schema: '',
+    uischema: '',
+    onChange: (newSchema, newUiSchema) => {},
+  };
+  it('render form builder', () => {
+    const wrapper = mount(<FormBuilder {...props} />);
+    expect(wrapper.exists('.form-body')).toBeTruthy();
+  });
+
+  it('render predefined gallery', () => {
+    const wrapper = mount(<PredefinedGallery {...props} />);
+    expect(wrapper.exists('.form_gallery_container')).toBeTruthy();
+  });
+});