@apolitical/component-library 2.0.6 → 2.1.0

package/form/components/form/form.d.ts

@@ -1,3 +1,3 @@
 import { IFormProps } from './form.types';
-declare const Form: ({ fields, className, id: formId, formRef: ref, intlPath, button, meta: { shouldReset, showRequiredLabels }, gtm, functions: { onSuccess, onCatch, onFailure }, ...props }: IFormProps) => import("react/jsx-runtime").JSX.Element | null;
+declare const Form: ({ fields, className, id: formId, formRef: ref, intlPath, button, secondaryActionButton, meta: { shouldShowCancelButton, shouldReset, showRequiredLabels, showSuccessMessage }, gtm, functions: { onSuccess, onCancel, onCatch, onFailure }, ...props }: IFormProps) => import("react/jsx-runtime").JSX.Element | null;
 export default Form;

package/form/components/form/form.types.d.ts

@@ -39,7 +39,7 @@ export interface IFormPayload {
     /** Function to call when everything succeeds */
     onSuccess?: (arg: IFormValues) => void;
     /** Function to call when something fails */
-    onFailure?: (arg: IFormValues) => void;
+    onFailure?: (arg: IFormValues, arg2?: FormValues) => void;
 }
 export interface IFormReducerAction extends IReducerAction<IFormPayload> {
 }
@@ -136,6 +136,10 @@ export interface IField {
     /** The value of the field */
     value?: FormValues;
 }
+export interface FormCancelButtonPropsType extends ButtonPropsType {
+    /** The text to show on the button */
+    text?: string;
+}
 export interface FormButtonPropsType extends ButtonPropsType {
     /** A custom component to render when the form is submitting */
     customOnSubmit?: React.ReactNode | false;
@@ -143,8 +147,10 @@ export interface FormButtonPropsType extends ButtonPropsType {
     text?: string;
 }
 export interface IFormProps {
-    /** The button to render at the bottom of the form */
+    /** The form submit button */
     button?: FormButtonPropsType;
+    /** The button to cancel the form (can be used to redirects user to another url or close modal) */
+    secondaryActionButton?: FormCancelButtonPropsType;
     /** The classes to add to the form */
     className?: string;
     /** The fields to render in the form */
@@ -156,9 +162,11 @@ export interface IFormProps {
         /** The function to call when onSuccess fails */
         onCatch?: (error?: unknown) => void;
         /** The function to call when the form submission fails */
-        onFailure?: (arg: IFormValues) => void;
+        onFailure?: (arg: IFormValues, arg2?: FormValues) => void;
         /** The function to call when the form is successfully submitted */
-        onSuccess?: (arg: IFormValues) => void;
+        onSuccess?: (arg: IFormValues) => Promise<void>;
+        /** The function to call when the cancel button is clicked */
+        onCancel?: () => void;
     };
     /** The Google Tag Manager data to be passed to the field */
     gtm?: {
@@ -177,6 +185,10 @@ export interface IFormProps {
         shouldReset?: boolean;
         /** Whether the form should show required labels */
         showRequiredLabels?: boolean;
+        /** Whether the form should show success message*/
+        showSuccessMessage?: boolean | string;
+        /** Whether the form should show cancel button */
+        shouldShowCancelButton?: boolean;
     };
 }
 export interface IFieldWrapper extends IField {

package/form/types/contact-form/contact-form.d.ts

@@ -4,7 +4,7 @@ interface IContactFormProps {
         event?: string;
     };
     functions: {
-        onSuccess?: () => void;
+        onSuccess?: () => Promise<void>;
         onFailure?: () => void;
     };
 }

package/helpers/index.d.ts

@@ -1,6 +1,7 @@
 export { default as basicReducer } from './basic-reducer';
 export * from './breakpoints';
 export * from './cases';
+export * from './inline-styling';
 export * from './dates';
 export { default as delay } from './delay';
 export * from './in-development';

package/helpers/inline-styling.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare function generateCssIcon(icon: string | undefined): React.CSSProperties;

package/helpers/validation.d.ts

@@ -1 +1,9 @@
 export declare const valueIsNotEmpty: (value: string) => boolean;
+export declare const passwordValidator: (password: string) => {
+    isValid: boolean;
+    matchingRules: {
+        isMoreThanEightCharacters: boolean;
+        includesNumberAndSymbol: boolean;
+        includesLowerAndUppercase: boolean;
+    };
+};

package/index.d.ts

@@ -18,3 +18,4 @@ export * from './sections';
 export * from './text';
 export * from './user';
 export * from './helpers/prerender';
+export { passwordValidator } from './helpers';