@thecb/components 8.0.6-beta.8 → 8.0.6-beta.9

package/dist/index.d.ts

@@ -61,21 +61,53 @@ interface CardProps {
 declare const Card: React.FC<Expand<CardProps> &
   React.HTMLAttributes<HTMLElement>>;
 
-interface ErrorMessage {
-    [fieldName: string]: string;
-  }
-
 interface Field {
-    hasErrors?: boolean;
-    dirty?: boolean;
-    rawValue?: string;
+  hasErrors?: boolean;
+  dirty?: boolean;
+  rawValue?: string;
+}
+
+interface ReduxAction<T = string, P = {}> {
+  type: T;
+  payload?: P;
+}
+
+/**
+ * These types should be moved to and referenced from redux-freeform if it implements TypeScript
+ */
+
+type ValidatorFn = (value: string) => boolean;
+
+interface FieldActionPayload {
+  fieldName: string;
+  value?: string;
+  validator?: ValidatorFn;
 }
 
+type SetAction = ReduxAction<"field/SET", FieldActionPayload>;
+type AddValidatorAction = ReduxAction<
+  "field/ADD_VALIDATOR",
+  FieldActionPayload
+>;
+type RemoveValidatorAction = ReduxAction<
+  "field/REMOVE_VALIDATOR",
+  FieldActionPayload
+>;
+type ClearAction = ReduxAction<"field/CLEAR">;
+
 interface FieldActions {
-  set?: (value: any) => void;
-  addValidator?: (validator: any) => void;
-  removeValidator?: (validator: any) => void;
-  clear?: () => void;
+  set?: (fieldName: string) => (value: string) => SetAction;
+  addValidator?: (
+    fieldName: string
+  ) => (validator: ValidatorFn) => AddValidatorAction;
+  removeValidator?: (
+    fieldName: string
+  ) => (validator: ValidatorFn) => RemoveValidatorAction;
+  clear?: () => ClearAction;
+}
+
+interface ErrorMessage {
+  [fieldName: string]: string;
 }
 
 interface FormInputProps {
@@ -107,8 +139,8 @@ interface FormSelectProps {
   options?: Option[];
   fieldActions?: FieldActions;
   showErrors?: boolean;
-  errorMessages?: ErrorMessage[]
-  field?: Field
+  errorMessages?: ErrorMessage[];
+  field?: Field;
 }
 
 declare const FormSelect: React.FC<Expand<FormSelectProps> &

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thecb/components",
-  "version": "8.0.6-beta.8",
+  "version": "8.0.6-beta.9",
   "description": "Common lib for CityBase react components",
   "main": "dist/index.cjs.js",
   "typings": "dist/index.d.ts",

package/src/components/atoms/form-select/index.d.ts

@@ -1,6 +1,6 @@
 import React from "react";
 import Expand from "../../../util/expand";
-import { ErrorMessage, Field, FieldActions} from "../../../types/common";
+import { ErrorMessage, Field, FieldActions } from "../../../types/common";
 
 interface Option {
   text?: string;
@@ -14,8 +14,8 @@ export interface FormSelectProps {
   options?: Option[];
   fieldActions?: FieldActions;
   showErrors?: boolean;
-  errorMessages?: ErrorMessage[]
-  field?: Field
+  errorMessages?: ErrorMessage[];
+  field?: Field;
 }
 
 export const FormSelect: React.FC<Expand<FormSelectProps> &

package/src/types/common/ErrorMessage.ts

@@ -1,4 +1,3 @@
 export default interface ErrorMessage {
-    [fieldName: string]: string;
-  }
-
+  [fieldName: string]: string;
+}

package/src/types/common/Field.ts

@@ -1,5 +1,5 @@
 export default interface Field {
-    hasErrors?: boolean;
-    dirty?: boolean;
-    rawValue?: string;
-}
+  hasErrors?: boolean;
+  dirty?: boolean;
+  rawValue?: string;
+}

package/src/types/common/FieldActions.ts

@@ -1,6 +1,35 @@
+import ReduxAction from "./ReduxAction";
+
+/**
+ * These types should be moved to and referenced from redux-freeform if it implements TypeScript
+ */
+
+type ValidatorFn = (value: string) => boolean;
+
+interface FieldActionPayload {
+  fieldName: string;
+  value?: string;
+  validator?: ValidatorFn;
+}
+
+type SetAction = ReduxAction<"field/SET", FieldActionPayload>;
+type AddValidatorAction = ReduxAction<
+  "field/ADD_VALIDATOR",
+  FieldActionPayload
+>;
+type RemoveValidatorAction = ReduxAction<
+  "field/REMOVE_VALIDATOR",
+  FieldActionPayload
+>;
+type ClearAction = ReduxAction<"field/CLEAR">;
+
 export default interface FieldActions {
-  set?: (value: any) => void;
-  addValidator?: (validator: any) => void;
-  removeValidator?: (validator: any) => void;
-  clear?: () => void;
+  set?: (fieldName: string) => (value: string) => SetAction;
+  addValidator?: (
+    fieldName: string
+  ) => (validator: ValidatorFn) => AddValidatorAction;
+  removeValidator?: (
+    fieldName: string
+  ) => (validator: ValidatorFn) => RemoveValidatorAction;
+  clear?: () => ClearAction;
 }

package/src/types/common/ReduxAction.ts

@@ -0,0 +1,4 @@
+export default interface ReduxAction<T = string, P = {}> {
+  type: T;
+  payload?: P;
+}

package/src/types/common/index.ts

@@ -1,3 +1,4 @@
-export type { default as ErrorMessage } from "./ErrorMessage";
-export type { default as Field } from "./Field";
-export type { default as FieldActions } from "./FieldActions"
+export { default as Field } from "./Field";
+export { default as ReduxAction } from "./ReduxAction";
+export { default as FieldActions } from "./FieldActions";
+export { default as ErrorMessage } from "./ErrorMessage";