Merge pull request #13 from openscript/develop

openscript · web-flow · commit 103b4ef68d93 · 2020-05-25T19:05:59.000+02:00
Enhance surface types
diff --git a/package.json b/package.json
@@ -7,7 +7,7 @@
     "react"
   ],
   "homepage": "https://openscript.github.io/react-dsv-import/",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "main": "dist/index.js",
   "module": "dist/es/index.js",
   "types": "dist/index.d.ts",
diff --git a/src/DSVImport.stories.tsx b/src/DSVImport.stories.tsx
@@ -1,5 +1,5 @@
 import React, { useState } from 'react';
-import { DSVImport, ColumnsType } from './';
+import { DSVImport, ColumnType } from './';
 import { action } from '@storybook/addon-actions';
 import styled from '@emotion/styled';
 
@@ -8,7 +8,7 @@ export default { title: 'Usage|Examples' };
 type BasicType = { forename: string; surname: string; email: string };
 
 export const BasicUsage = () => {
-  const columns: ColumnsType<BasicType> = [
+  const columns: ColumnType<BasicType>[] = [
     { key: 'forename', label: 'Forename' },
     { key: 'surname', label: 'Surname' },
     { key: 'email', label: 'Email' }
@@ -25,7 +25,7 @@ export const BasicUsage = () => {
 BasicUsage.story = { name: 'Basic usage' };
 
 export const UsingOnChangeCallback = () => {
-  const columns: ColumnsType<BasicType> = [
+  const columns: ColumnType<BasicType>[] = [
     { key: 'forename', label: 'Forename' },
     { key: 'surname', label: 'Surname' },
     { key: 'email', label: 'Email' }
@@ -58,7 +58,7 @@ const CustomTablePreview = styled(DSVImport.TablePreview)`
 `;
 
 export const UsingOnValidationCallback = () => {
-  const columns: ColumnsType<BasicType> = [
+  const columns: ColumnType<BasicType>[] = [
     { key: 'forename', label: 'Forename' },
     { key: 'surname', label: 'Surname' },
     { key: 'email', label: 'Email', rules: [{ constraint: { unique: true }, message: 'Duplicates are not allowed' }] }
diff --git a/src/DSVImport.test.tsx b/src/DSVImport.test.tsx
@@ -1,4 +1,4 @@
-import { ColumnsType } from './models/column';
+import { ColumnType } from './models/column';
 import { DSVImport } from '.';
 import React from 'react';
 import { render, fireEvent } from '@testing-library/react';
@@ -8,7 +8,7 @@ import { ValidationError } from './models/validation';
 describe('DSVImport', () => {
   type TestType = { forename: string; surname: string; email: string };
 
-  const columns: ColumnsType<TestType> = [
+  const columns: ColumnType<TestType>[] = [
     { key: 'forename', label: 'Forename' },
     { key: 'surname', label: 'Surname' },
     { key: 'email', label: 'Email', rules: [{ constraint: { unique: true }, message: 'Contains duplicates' }] }
@@ -17,7 +17,7 @@ describe('DSVImport', () => {
   interface Props<T> {
     onChange?: (value: T[]) => void;
     onValidation?: (errors: ValidationError<T>[]) => void;
-    columns: ColumnsType<T>;
+    columns: ColumnType<T>[];
   }
 
   const MinimalTextareaInput: React.FC = () => {
diff --git a/src/DSVImport.tsx b/src/DSVImport.tsx
@@ -1,5 +1,5 @@
 import React, { PropsWithChildren, useReducer, useEffect } from 'react';
-import { ColumnsType } from './models/column';
+import { ColumnType } from './models/column';
 import { getDSVImportContext, useDSVImport, createReducer } from './features/context';
 import { createParserMiddleware } from './middlewares/parserMiddleware';
 import { State } from './models/state';
@@ -33,7 +33,7 @@ const EventListener = <T extends { [key: string]: string }>(props: EventListener
 };
 
 export interface Props<T> {
-  columns: ColumnsType<T>;
+  columns: ColumnType<T>[];
   onChange?: (value: T[]) => void;
   onValidation?: (errors: ValidationError<T>[]) => void;
   transformers?: Transformer[];
diff --git a/src/components/inputs/TextareaInput.test.tsx b/src/components/inputs/TextareaInput.test.tsx
@@ -1,13 +1,13 @@
 import { render, fireEvent } from '@testing-library/react';
 import { TextareaInput } from './TextareaInput';
 import React from 'react';
-import { ColumnsType } from '../../models/column';
+import { ColumnType } from '../../models/column';
 import { getDSVImportContext } from '../../features/context';
 import { State } from '../../models/state';
 
 describe('TextareaInput', () => {
-  type TestType = {};
-  const columns: ColumnsType<TestType> = [];
+  type TestType = unknown;
+  const columns: ColumnType<TestType>[] = [];
   const state: State<TestType> = { columns };
   const Context = getDSVImportContext<TestType>();
 
diff --git a/src/components/previews/TablePreview.test.tsx b/src/components/previews/TablePreview.test.tsx
@@ -1,13 +1,13 @@
 import { render } from '@testing-library/react';
 import React from 'react';
-import { ColumnsType } from '../../models/column';
+import { ColumnType } from '../../models/column';
 import { TablePreview } from './TablePreview';
 import { State } from '../../models/state';
 import { getDSVImportContext } from '../../features/context';
 
 describe('TablePreview', () => {
   type TestType = { forename: string; surname: string; email: string };
-  const columns: ColumnsType<TestType> = [
+  const columns: ColumnType<TestType>[] = [
     { key: 'forename', label: 'Forename' },
     { key: 'surname', label: 'Surname' },
     { key: 'email', label: 'Email' }
diff --git a/src/features/context.test.ts b/src/features/context.test.ts
@@ -4,7 +4,7 @@ import { useContext } from 'react';
 import { renderHook } from '@testing-library/react-hooks';
 
 describe('context', () => {
-  type TestType = {};
+  type TestType = unknown;
   const defaultState: State<TestType> = { columns: [] };
 
   it('should reduce raw data action to state', () => {
diff --git a/src/index.tsx b/src/index.tsx
@@ -10,6 +10,7 @@ export function DSVImport<T extends { [key: string]: string }>(props: PropsWithC
 DSVImport.TextareaInput = TextareaInput;
 DSVImport.TablePreview = TablePreview;
 
-export { ColumnsType } from './models/column';
+export { ColumnType } from './models/column';
 export { useDSVImport } from './features/context';
 export { Rule } from './models/rule';
+export { Transformer } from './models/transformer';
diff --git a/src/middlewares/middleware.test.ts b/src/middlewares/middleware.test.ts
@@ -1,10 +1,10 @@
-import { ColumnsType } from '../models/column';
+import { ColumnType } from '../models/column';
 import { State } from '../models/state';
 import { applyMiddlewares } from './middleware';
 
 describe('middleware', () => {
   type TestType = { forename: string; surname: string; email: string };
-  const columns: ColumnsType<TestType> = [
+  const columns: ColumnType<TestType>[] = [
     { key: 'forename', label: 'Forename' },
     { key: 'surname', label: 'Surname' },
     { key: 'email', label: 'Email' }
diff --git a/src/middlewares/parserMiddleware.test.ts b/src/middlewares/parserMiddleware.test.ts
@@ -1,11 +1,11 @@
 import { createParserMiddleware } from './parserMiddleware';
 import { State } from '../models/state';
-import { ColumnsType } from '../models/column';
+import { ColumnType } from '../models/column';
 import { Delimiter } from '../models/delimiter';
 
 describe('parserMiddleware', () => {
   type TestType = { forename: string; surname: string; email: string };
-  const columns: ColumnsType<TestType> = [
+  const columns: ColumnType<TestType>[] = [
     { key: 'forename', label: 'Forename' },
     { key: 'surname', label: 'Surname' },
     { key: 'email', label: 'Email' }
diff --git a/src/middlewares/parserMiddleware.ts b/src/middlewares/parserMiddleware.ts
@@ -1,6 +1,6 @@
 import { State } from '../models/state';
 import { Delimiter } from '../models/delimiter';
-import { ColumnsType } from '../models/column';
+import { ColumnType } from '../models/column';
 import { Dispatch } from 'react';
 import { Actions } from '../models/actions';
 
@@ -17,7 +17,7 @@ const detectDelimiterFromValue = (value: string, defaultDelimiter: Delimiter) =>
   return currentDelimiter;
 };
 
-const parseData = <T>(value: string, columns: ColumnsType<T>, delimiter: Delimiter) => {
+const parseData = <T>(value: string, columns: ColumnType<T>[], delimiter: Delimiter) => {
   const lines = value.split('\n');
   return lines.map((line) => {
     const lineValues = line.split(delimiter);
diff --git a/src/middlewares/transformerMiddleware.test.ts b/src/middlewares/transformerMiddleware.test.ts
@@ -1,10 +1,10 @@
-import { ColumnsType } from '../models/column';
+import { ColumnType } from '../models/column';
 import { State } from '../models/state';
 import { createTransformerMiddleware } from './transformerMiddleware';
 
 describe('validatorMiddleware', () => {
   type TestType = { forename: string; surname: string; email: string };
-  const defaultColumns: ColumnsType<TestType> = [
+  const defaultColumns: ColumnType<TestType>[] = [
     { key: 'forename', label: 'Forename' },
     { key: 'surname', label: 'Surname' },
     { key: 'email', label: 'Email' }
diff --git a/src/middlewares/transformerMiddleware.ts b/src/middlewares/transformerMiddleware.ts
@@ -1,10 +1,10 @@
 import { State } from '../models/state';
 import { Dispatch } from 'react';
 import { Actions } from '../models/actions';
-import { ColumnsType } from '../models/column';
+import { ColumnType } from '../models/column';
 import { Transformer } from '../models/transformer';
 
-const executeGlobalTransformers = <T>(values: T[], transformer: Transformer, columns: ColumnsType<T>) => {
+const executeGlobalTransformers = <T>(values: T[], transformer: Transformer, columns: ColumnType<T>[]) => {
   return values.map<T>((r) => {
     const transformed = { ...r };
     columns.forEach((c) => {
@@ -14,7 +14,7 @@ const executeGlobalTransformers = <T>(values: T[], transformer: Transformer, col
   });
 };
 
-const executeColumnTransformers = <T>(values: T[], columns: ColumnsType<T>) => {
+const executeColumnTransformers = <T>(values: T[], columns: ColumnType<T>[]) => {
   return values.map<T>((r) => {
     const transformed = { ...r };
     columns.forEach((c) => {
diff --git a/src/middlewares/validatorMiddleware.test.ts b/src/middlewares/validatorMiddleware.test.ts
@@ -1,10 +1,10 @@
 import { createValidatorMiddleware } from './validatorMiddleware';
 import { State } from '../models/state';
-import { ColumnsType } from '../models/column';
+import { ColumnType } from '../models/column';
 
 describe('validatorMiddleware', () => {
   type TestType = { forename: string; surname: string; email: string };
-  const defaultColumns: ColumnsType<TestType> = [
+  const defaultColumns: ColumnType<TestType>[] = [
     { key: 'forename', label: 'Forename' },
     { key: 'surname', label: 'Surname' },
     { key: 'email', label: 'Email' }
@@ -27,7 +27,7 @@ describe('validatorMiddleware', () => {
 
   it('should validate unique constraints', () => {
     const dispatchMock = jest.fn();
-    const columns: ColumnsType<TestType> = [...defaultColumns];
+    const columns: ColumnType<TestType>[] = [...defaultColumns];
     columns[2] = { ...defaultColumns[2], rules: [{ constraint: { unique: true }, message: 'Contains duplicates' }] };
     const state: State<TestType> = { columns };
 
@@ -44,7 +44,7 @@ describe('validatorMiddleware', () => {
 
   it('should validate with callback constraints', () => {
     const dispatchMock = jest.fn();
-    const columns: ColumnsType<TestType> = [...defaultColumns];
+    const columns: ColumnType<TestType>[] = [...defaultColumns];
     columns[0] = {
       ...defaultColumns[0],
       rules: [{ constraint: { callback: (value) => value === 'Hans' }, message: "No 'Hans' allowed" }]
diff --git a/src/middlewares/validatorMiddleware.ts b/src/middlewares/validatorMiddleware.ts
@@ -34,7 +34,6 @@ const validateColumn = <T>(key: keyof T, data: T[keyof T][], rules?: Rule[]): Va
         });
       }
     });
-    return errors;
   }
 
   return errors;
diff --git a/src/models/column.ts b/src/models/column.ts
@@ -1,4 +1,4 @@
 import { Rule } from './rule';
 import { Transformer } from './transformer';
 
-export type ColumnsType<T> = { key: keyof T; label: string; rules?: Rule[]; transformers?: Transformer[] }[];
+export type ColumnType<T> = { key: keyof T; label: string; rules?: Rule[]; transformers?: Transformer[] };
diff --git a/src/models/state.ts b/src/models/state.ts
@@ -1,4 +1,4 @@
-import { ColumnsType } from './column';
+import { ColumnType } from './column';
 import { ValidationError } from './validation';
 import { Transformer } from './transformer';
 
@@ -7,7 +7,7 @@ export interface State<T> {
   parsed?: T[];
   validation?: ValidationError<T>[];
   transformers?: Transformer[];
-  columns: ColumnsType<T>;
+  columns: ColumnType<T>[];
 }
 
 export const emptyState: State<{ [key: string]: string }> = {
diff --git a/yarn.lock b/yarn.lock
@@ -3933,9 +3933,9 @@ can-use-dom@^0.1.0:
   integrity sha1-IsxKNKCrxDlQ9CxkEQJKP2NmtFo=
 
 caniuse-lite@^1.0.30000989, caniuse-lite@^1.0.30001043, caniuse-lite@^1.0.30001061:
-  version "1.0.30001064"
-  resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001064.tgz#a0f49689119ba08943b09968e118faf3f645add0"
-  integrity sha512-hdBcQMFvJIrOhkpAZiRXz04Cmetwc9NekeuNl0qZfHOugxOhJKxsjF1RmISMPFjIF4PPx1reliIzbfN42EiQ5A==
+  version "1.0.30001065"
+  resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001065.tgz#e8d7fef61cdfd8a7107493ad6bf551a4eb59c68f"
+  integrity sha512-DDxCLgJ266YnAHQv0jS1wdOaihRFF52Zgmlag39sQJVy2H46oROpJp4hITstqhdB8qnHSrKNoAEkQA9L/oYF9A==
 
 capture-exit@^2.0.0:
   version "2.0.0"
@@ -7778,11 +7778,11 @@ jstransformer@1.0.0:
     promise "^7.0.1"
 
 jsx-ast-utils@^2.2.3:
-  version "2.2.3"
-  resolved "https://registry.yarnpkg.com/jsx-ast-utils/-/jsx-ast-utils-2.2.3.tgz#8a9364e402448a3ce7f14d357738310d9248054f"
-  integrity sha512-EdIHFMm+1BPynpKOpdPqiOsvnIrInRGJD7bzPZdPkjitQEqpdpUuFpq4T0npZFKTiB3RhWFdGN+oqOJIdhDhQA==
+  version "2.3.0"
+  resolved "https://registry.yarnpkg.com/jsx-ast-utils/-/jsx-ast-utils-2.3.0.tgz#edd727794ea284d7fda575015ed1b0cde0289ab6"
+  integrity sha512-3HNoc7nZ1hpZIKB3hJ7BlFRkzCx2BynRtfSwbkqZdpRdvAPsGMnzclPwrvDBS7/lalHTj21NwIeaEpysHBOudg==
   dependencies:
-    array-includes "^3.0.3"
+    array-includes "^3.1.1"
     object.assign "^4.1.0"
 
 kind-of@^2.0.1:
