feat(renderer): added .d.ts definitions

Hyperkid123 · Hyperkid123 · commit 21176adfbc08 · 2020-06-16T11:16:24.000+02:00
diff --git a/package.json b/package.json
@@ -17,6 +17,7 @@
     "codecov": "codecov",
     "start-demo": "lerna run start --scope=@data-driven-forms/react-render-demo",
     "lint": "yarn eslint .",
+    "lint:ts": "tslint -c ./tslint.json 'packages/**/*.d.ts'",
     "generate-template": "node ./scripts/generate-mapper.js"
   },
   "workspaces": [
@@ -53,6 +54,7 @@
     "@typescript-eslint/eslint-plugin": "^3.0.0",
     "atob-lite": "^2.0.0",
     "babel-plugin-transform-imports": "^2.0.0",
+    "dtslint": "^3.6.4",
     "eslint": "^6.8.0",
     "eslint-config-i-am-meticulous": "^12.0.0",
     "eslint-config-prettier": "^6.10.0",
@@ -77,6 +79,8 @@
     "strip-ansi": "^6.0.0",
     "terser-webpack-plugin": "^1.3.0",
     "ts-loader": "^7.0.5",
+    "tslint": "^6.1.2",
+    "tslint-config-prettier": "^1.18.0",
     "typescript": "^3.9.3"
   },
   "release": {
diff --git a/packages/common/tsconfig.json b/packages/common/tsconfig.json
@@ -1,12 +1,17 @@
 {
   "compilerOptions": {
     "sourceMap": true,
-    "noImplicitAny": true,
-    "module": "ES6",
+    "module": "esnext",
+    "moduleResolution": "node",
     "target": "es5",
-    "jsx": "react",
-    "allowSyntheticDefaultImports": true
+    "lib": ["es6", "dom"],
+    "jsx": "preserve",
+    "allowSyntheticDefaultImports": true,
+    "noErrorTruncation": true,
+    "allowJs": true,
+    "strict": true,
+    "noEmit": true,
   },
-  "include": ["./src/**/*.ts"],
+  "include": ["./src/**/*.ts", "./src/**/*.tsx", "./src/**/*.js"],
   "exclude": ["./dist"]
 }
diff --git a/packages/react-form-renderer/rollup.config.js b/packages/react-form-renderer/rollup.config.js
@@ -9,7 +9,10 @@ import glob from 'glob';
 import path from 'path';
 import sourcemaps from 'rollup-plugin-sourcemaps';
 
-const outputPaths = [...glob.sync(path.resolve(__dirname, './src/files/!(*.d.ts)')), ...glob.sync(path.resolve(__dirname, './src/files/*.js'))];
+const outputPaths = [
+  ...glob.sync(path.resolve(__dirname, './src/files/!(*.d.ts)')),
+  ...glob.sync(path.resolve(__dirname, './src/files/*.(js|ts|tsx)'))
+];
 
 const globals = {
   react: 'React',
diff --git a/packages/react-form-renderer/src/common/convert-type.d.ts b/packages/react-form-renderer/src/common/convert-type.d.ts
@@ -0,0 +1,3 @@
+import { DataTypeValidators } from '../validators';
+
+export default function convertType(dataType: DataTypeValidators, value: any): any;
diff --git a/packages/react-form-renderer/src/common/isValidComponent.js b/packages/react-form-renderer/src/common/isValidComponent.js
diff --git a/packages/react-form-renderer/src/files/action-mapper.d.ts b/packages/react-form-renderer/src/files/action-mapper.d.ts
@@ -0,0 +1,5 @@
+interface ActionMapper {
+  [key: string]: (...args: any[]) => any;
+}
+
+export default ActionMapper;
diff --git a/packages/react-form-renderer/src/files/component-mapper.d.ts b/packages/react-form-renderer/src/files/component-mapper.d.ts
@@ -0,0 +1,9 @@
+export interface ExtendedMapperComponent extends Object {
+  component: string;
+}
+
+interface ComponentMapper {
+  [key: string]: string | ExtendedMapperComponent;
+}
+
+export default ComponentMapper;
diff --git a/packages/react-form-renderer/src/files/component-types.d.ts b/packages/react-form-renderer/src/files/component-types.d.ts
@@ -0,0 +1,25 @@
+export type ComponentType = 'text-field'|'field-array'|'checkbox'|'sub-form'|'radio'|'tabs'|'tab-item'|'date-picker'|'time-picker'|'wizard'|'switch'|'textarea'|'select'|'plain-text'|'button'|'input-addon-group'|'input-addon-button-group'|'dual-list-select'|'slider';
+
+interface componentTypes {
+  TEXT_FIELD: 'text-field';
+  FIELD_ARRAY: 'field-array';
+  CHECKBOX: 'checkbox';
+  SUB_FORM: 'sub-form';
+  RADIO: 'radio';
+  TABS: 'tabs';
+  TAB_ITEM: 'tab-item';
+  DATE_PICKER: 'date-picker';
+  TIME_PICKER: 'time-picker';
+  WIZARD: 'wizard';
+  SWITCH: 'switch';
+  TEXTAREA: 'textarea';
+  SELECT: 'select';
+  PLAIN_TEXT: 'plain-text';
+  BUTTON: 'button';
+  INPUT_ADDON_GROUP: 'input-addon-group';
+  INPUT_ADDON_BUTTON_GROUP: 'input-addon-button-group';
+  DUAL_LIST_SELECT: 'dual-list-select';
+  SLIDER: 'slider';
+}
+
+export default componentTypes;
diff --git a/packages/react-form-renderer/src/files/compose-validators.d.ts b/packages/react-form-renderer/src/files/compose-validators.d.ts
@@ -0,0 +1,3 @@
+import { ValidatorFunction } from '../validators';
+
+export default function(validators: ValidatorFunction[]): ValidatorFunction;
diff --git a/packages/react-form-renderer/src/files/data-types.d.ts b/packages/react-form-renderer/src/files/data-types.d.ts
@@ -0,0 +1,11 @@
+export type DataType = 'integer'|'float'|'number'|'boolean'|'string';
+
+interface dataTypes {
+  INTEGER: 'integer';
+  FLOAT: 'float';
+  NUMBER: 'number';
+  BOOLEAN: 'boolean';
+  STRING: 'string';
+}
+
+export default dataTypes;
diff --git a/packages/react-form-renderer/src/files/default-schema-validator.d.ts b/packages/react-form-renderer/src/files/default-schema-validator.d.ts
@@ -0,0 +1,11 @@
+import Schema from './schema';
+import ComponentMapper from './component-mapper';
+import SchemaValidatorMapper from './schema-validator-mapper';
+
+export default function(
+  schema: Schema,
+  componentMapper: ComponentMapper,
+  validatorTypes: string[],
+  actionTypes: string[],
+  schemaValidatorMapper: SchemaValidatorMapper
+): void;
diff --git a/packages/react-form-renderer/src/files/default-schema-validator.js b/packages/react-form-renderer/src/files/default-schema-validator.js
@@ -106,7 +106,7 @@ const checkCondition = (condition, fieldName, isRoot) => {
     if (!(typeof condition.when === 'string' || Array.isArray(condition.when))) {
       throw new DefaultSchemaError(`
       Error occured in field definition with name: "${fieldName}".
-      Field condition property "when" must be oof type "string", ${typeof condition.when} received!].
+      Field condition property "when" must be of type "string", ${typeof condition.when} received!].
     `);
     }
 
diff --git a/packages/react-form-renderer/src/files/field-array.d.ts b/packages/react-form-renderer/src/files/field-array.d.ts
@@ -0,0 +1,5 @@
+import { ComponentType } from 'react';
+
+import { FieldArrayProps } from 'react-final-form-arrays';
+
+export default FieldArrayProps;
diff --git a/packages/react-form-renderer/src/files/field-provider.d.ts b/packages/react-form-renderer/src/files/field-provider.d.ts
@@ -0,0 +1,10 @@
+import { ComponentType, ReactNode } from 'react';
+
+export interface FieldProviderProps<T> {
+  Component?: ComponentType<any>;
+  render?: (props: T) => ReactNode;
+}
+
+declare const FieldProvider: React.ComponentType<FieldProviderProps<object>>;
+
+export default FieldProvider;
diff --git a/packages/react-form-renderer/src/files/field-provider.js b/packages/react-form-renderer/src/files/field-provider.js
@@ -1,7 +1,7 @@
 import React from 'react';
 import PropTypes from 'prop-types';
 
-import useFieldApi from '../files/use-field-api';
+import useFieldApi from './use-field-api';
 
 const FieldProvider = ({ Component, render, ...props }) => {
   const fieldProviderProps = useFieldApi(props);
diff --git a/packages/react-form-renderer/src/files/field.d.ts b/packages/react-form-renderer/src/files/field.d.ts
@@ -0,0 +1,20 @@
+import { Validator } from "../validators";
+import { ConditionDefinition } from '../form-renderer/condition';
+import { DataType } from "./data-types";
+
+export type FieldAction = [string, ...any[]];
+
+interface Field extends Object {
+  name: string;
+  component: string;
+  validate?: Validator[];
+  condition?: ConditionDefinition[];
+  initializeOnMount?: boolean;
+  dataType?: DataType;
+  initialValue?: any;
+  clearedValue?: any;
+  clearOnUnmount?: boolean;
+  actions?: FieldAction;
+}
+
+export default Field;
diff --git a/packages/react-form-renderer/src/files/form-renderer.d.ts b/packages/react-form-renderer/src/files/form-renderer.d.ts
@@ -0,0 +1,31 @@
+import { ComponentType } from 'react';
+import { FormApi } from 'final-form';
+import Schema from './schema';
+import ComponentMapper from './component-mapper';
+import ValidatorMapper from './validator-mapper';
+import ActionMapper from './action-mapper';
+import SchemaValidatorMapper from './schema-validator-mapper';
+
+export interface FormSubscription {
+  [key: string]: boolean;
+}
+
+export interface FormRendererProps {
+  initialValues?: object;
+  onSubmit: (values: object, formApi: FormApi, callback: () => void) => Promise<any>;
+  onCancel: () => void;
+  onReset: () => void;
+  schema: Schema;
+  clearOnUnmount?: boolean;
+  subscription: FormSubscription;
+  clearedValue: any;
+  componentMapper: ComponentMapper;
+  FormTemplate: ComponentType;
+  validatorMapper: ValidatorMapper;
+  actionMapper: ActionMapper;
+  schemaValidatorMapper: SchemaValidatorMapper;
+}
+
+declare const FormRenderer: React.ComponentType<FormRendererProps>;
+
+export default FormRenderer;
diff --git a/packages/react-form-renderer/src/files/form-spy.d.ts b/packages/react-form-renderer/src/files/form-spy.d.ts
@@ -0,0 +1,3 @@
+import { FormSpyProps } from 'react-final-form';
+
+export default FormSpyProps;
diff --git a/packages/react-form-renderer/src/files/form.d.ts b/packages/react-form-renderer/src/files/form.d.ts
@@ -0,0 +1,3 @@
+import { FormProps } from 'react-final-form';
+
+export default FormProps;
diff --git a/packages/react-form-renderer/src/files/renderer-context.d.ts b/packages/react-form-renderer/src/files/renderer-context.d.ts
@@ -0,0 +1,28 @@
+import { ReactNode } from 'react';
+import { FormApi } from 'final-form';
+import ComponentMapper from './component-mapper';
+import ValidatorMapper from './validator-mapper';
+import ActionMapper from './action-mapper';
+import Field from './field';
+
+export interface FormOptions extends FormApi {
+  registerInputFile: (name: string) => void;
+  unRegisterInputFile: (name: string) => void;
+  onCancel: (values: object, ...args: any[]) => void;
+  onReset: () => void;
+  clearedValue: any;
+  renderForm: (fields: Field[]) => ReactNode[];
+}
+
+export interface RendererContextValue {
+  componentMapper: ComponentMapper;
+  validatorMapper: ValidatorMapper;
+  actionMapper: ActionMapper;
+  formOptions: FormOptions;
+}
+
+interface RendererContext {
+  value: object;
+}
+
+export default RendererContext;
diff --git a/packages/react-form-renderer/src/files/schema-validator-mapper.d.ts b/packages/react-form-renderer/src/files/schema-validator-mapper.d.ts
@@ -0,0 +1,11 @@
+export interface PartialValidator {
+  [key: string]: () => void;
+}
+
+interface SchemaValidatorMapper {
+  components?: PartialValidator;
+  actions?: PartialValidator;
+  validators?: PartialValidator;
+}
+
+export default SchemaValidatorMapper;
diff --git a/packages/react-form-renderer/src/files/schema.d.ts b/packages/react-form-renderer/src/files/schema.d.ts
@@ -0,0 +1,10 @@
+import { ReactNode } from "react";
+import Field from "./field";
+
+interface Schema {
+  title?: ReactNode;
+  description?: ReactNode;
+  fields: Field[];
+}
+
+export default Schema;
diff --git a/packages/react-form-renderer/src/files/use-field-api.d.ts b/packages/react-form-renderer/src/files/use-field-api.d.ts
@@ -0,0 +1,20 @@
+import { ReactNode } from 'react';
+import { FieldInputProps, FieldMetaState } from 'react-final-form';
+
+export interface ValidatorType extends Object {
+  type: string;
+  message: ReactNode;
+}
+
+export interface UseFieldApiConfig extends Object {
+  name: string;
+  component: string;
+  validate: ValidatorType[];
+}
+
+export interface UseFieldApiProps extends Object {
+  input: FieldInputProps<any>;
+  meta: FieldMetaState<any>;
+}
+
+export default function(options: UseFieldApiConfig): UseFieldApiProps;
diff --git a/packages/react-form-renderer/src/files/use-form-api.d.ts b/packages/react-form-renderer/src/files/use-form-api.d.ts
@@ -0,0 +1,4 @@
+import { useContext } from 'react';
+import RendererContext, { RendererContextValue } from './renderer-context';
+
+export default function(): RendererContextValue;
diff --git a/packages/react-form-renderer/src/files/validator-mapper.d.ts b/packages/react-form-renderer/src/files/validator-mapper.d.ts
@@ -0,0 +1,5 @@
+interface ValidatorMapper {
+  [key: string]: (options: object) => (value: any, allValues: object) => string;
+}
+
+export default ValidatorMapper;
diff --git a/packages/react-form-renderer/src/files/validator-types.d.ts b/packages/react-form-renderer/src/files/validator-types.d.ts
@@ -0,0 +1,13 @@
+interface validatorTypes {
+  REQUIRED: 'required';
+  MIN_LENGTH: 'min-length';
+  MAX_LENGTH: 'max-length';
+  EXACT_LENGTH: 'exact-length';
+  MIN_ITEMS: 'min-items';
+  MIN_NUMBER_VALUE: 'min-number-value';
+  MAX_NUMBER_VALUE: 'max-number-value';
+  PATTERN: 'pattern';
+  URL: 'url';
+}
+
+export default validatorTypes;
diff --git a/packages/react-form-renderer/src/form-renderer/assign-special-type.d.ts b/packages/react-form-renderer/src/form-renderer/assign-special-type.d.ts
@@ -0,0 +1,3 @@
+import { ComponentType } from '../files/component-types';
+
+export default function(componentType: ComponentType): string | undefined;
diff --git a/packages/react-form-renderer/src/form-renderer/condition.d.ts b/packages/react-form-renderer/src/form-renderer/condition.d.ts
@@ -0,0 +1,32 @@
+export interface ActionResolution {
+  visible?: boolean;
+  set?: object; // TO DO specify this
+}
+
+export interface ConditionProp {
+  when?: string | string[];
+  is?: any;
+  isNotEmpty?: boolean;
+  isEmpty?: boolean;
+  pattern?: string | RegExp;
+  notMatch?: any;
+  then?: ActionResolution;
+  else?: ActionResolution;
+}
+
+export interface ConditionDefinition extends ConditionProp {
+  or?: ConditionProp | ConditionProp[];
+  and?: ConditionProp | ConditionProp[];
+  not?: ConditionProp | ConditionProp[];
+  sequence?: ConditionProp[];
+}
+
+export interface ConditionProps {
+  values: object;
+  children: React.ReactChildren;
+  condition?: ConditionDefinition | ConditionDefinition[];
+}
+
+declare const Condition: React.ComponentType<ConditionProps>;
+
+export default Condition;
diff --git a/packages/react-form-renderer/src/form-renderer/convert-initial-value.d.ts b/packages/react-form-renderer/src/form-renderer/convert-initial-value.d.ts
@@ -0,0 +1,3 @@
+import { DataType } from "../files/data-types";
+
+export default function(initialValue: any, dataType: DataType): any;
diff --git a/packages/react-form-renderer/src/form-renderer/enhanced-on-change.d.ts b/packages/react-form-renderer/src/form-renderer/enhanced-on-change.d.ts
@@ -0,0 +1,11 @@
+import { DataType } from "../files/data-types";
+
+export interface EnhancedOnChangeOptions {
+  dataType?: DataType;
+  onChange: (value: any) => void;
+  initial?: any;
+  clearedValue?: any;
+  dirty?: boolean;
+}
+
+export default function enhancedOnChange(options: EnhancedOnChangeOptions, value: any): void;
diff --git a/packages/react-form-renderer/src/form-renderer/render-form.d.ts b/packages/react-form-renderer/src/form-renderer/render-form.d.ts
diff --git a/packages/react-form-renderer/src/form-renderer/schema-error-component.d.ts b/packages/react-form-renderer/src/form-renderer/schema-error-component.d.ts
diff --git a/packages/react-form-renderer/src/form-renderer/validator-helpers.d.ts b/packages/react-form-renderer/src/form-renderer/validator-helpers.d.ts
diff --git a/packages/react-form-renderer/src/form-renderer/validator-helpers.js b/packages/react-form-renderer/src/form-renderer/validator-helpers.js
diff --git a/packages/react-form-renderer/src/tests/parsers/__snapshots__/default-schema-validator.test.js.snap b/packages/react-form-renderer/src/tests/parsers/__snapshots__/default-schema-validator.test.js.snap
diff --git a/packages/react-form-renderer/src/validators/helpers.d.ts b/packages/react-form-renderer/src/validators/helpers.d.ts
diff --git a/packages/react-form-renderer/src/validators/index.d.ts b/packages/react-form-renderer/src/validators/index.d.ts
diff --git a/packages/react-form-renderer/src/validators/messages.d.ts b/packages/react-form-renderer/src/validators/messages.d.ts
diff --git a/packages/react-form-renderer/src/validators/url-validator.d.ts b/packages/react-form-renderer/src/validators/url-validator.d.ts
diff --git a/tslint.json b/tslint.json
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import { DataTypeValidators } from '../validators';`
	`2`	`+`
	`3`	`+export default function convertType(dataType: DataTypeValidators, value: any): any;`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import { ValidatorFunction } from '../validators';`
	`2`	`+`
	`3`	`+export default function(validators: ValidatorFunction[]): ValidatorFunction;`