@apolitical/component-library 5.5.3-jc.0 → 5.5.4-SW.0

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

@@ -13,7 +13,7 @@ export interface ILabel {
     htmlFor?: string;
 }
 export type FormActionTypes = 'addError' | 'formSubmitted' | 'formSubmittedAndReset' | 'removeError' | 'submitForm' | 'updateValue';
-export type FieldValidationConditions = boolean | 'no-numbers' | 'required' | 'valid-email' | 'valid-url' | 'custom-validation' | ((arg: IFormValues) => boolean | null | string);
+export type FieldValidationConditions = boolean | 'no-numbers' | 'required' | 'valid-email' | 'valid-url' | 'custom-validation' | ((arg: IFormValues) => boolean);
 export interface IFieldOption {
     /** The ID of the option */
     id: string;

package/form/types/password-form/index.d.ts

@@ -1,3 +1,2 @@
-export { default as PasswordForm } from './password-form';
-export type { IPasswordFormProps } from './password-form';
+export { default as PasswordForm, type IPasswordFormProps } from './password-form';
 export * from './helper';

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

@@ -1,12 +1,24 @@
 import React from 'react';
-import type { IFormProps, IFormValues } from '../../components/form/form.types';
-export interface IPasswordFormProps extends Omit<IFormProps, 'id' | 'fields'> {
+import { FormValues, IFormValues } from '../../components/form/form.types';
+export interface IPasswordFormProps {
     /** Indicated for whether to show the current password field */
     isPasswordChange?: boolean;
     /** The functions being passed to the form */
-    functions: IFormProps['functions'] & {
+    functions: {
         /** The function to call to create the password */
         createPassword: (arg: IFormValues) => Promise<void>;
+        /** The function to call when onSuccess fails */
+        onCatch?: (error?: unknown) => void;
+        /** The function to call when the form submission fails */
+        onFailure?: (arg: IFormValues, arg2?: FormValues) => void;
+        /** The function to call when the form is successfully submitted */
+        onSuccess?: (arg: IFormValues) => Promise<void>;
+        /** The function to call when the cancel button is clicked */
+        onCancel?: () => void;
+    };
+    /** Specify custom text for the submit button */
+    button?: {
+        text: string;
     };
 }
 declare const PasswordForm: React.FC<IPasswordFormProps>;

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

@@ -1,5 +1,7 @@
 import type { IFormValues, IFormMeta } from './../../components/form/form.types';
 export interface IProfileFormProps<OnSuccessArgs = IFormValues> {
+    /** Indicated for whether to the form is for creating the profile */
+    isCreateProfile?: boolean;
     /** The hooks used in the form */
     hooks: {
         /** The hook to predict the user's location */
@@ -16,7 +18,7 @@ export interface IProfileFormProps<OnSuccessArgs = IFormValues> {
     /** The functions to call */
     functions: {
         /** The function to upload the user's profile image */
-        uploadImage: () => Promise<unknown>;
+        uploadImage?: () => Promise<unknown>;
         /** The function to call on success */
         onSuccess?: (data: OnSuccessArgs) => Promise<void>;
         /** The function to call when the form is cancelled, e.g. the user presses a cancel button */
@@ -31,6 +33,10 @@ export interface IProfileFormProps<OnSuccessArgs = IFormValues> {
         context?: string;
         event?: string;
     };
+    /** Specify custom text for the submit button */
+    button?: {
+        text: string;
+    };
 }
-declare const ProfileForm: ({ hooks, functions, meta, gtm }: IProfileFormProps) => import("react/jsx-runtime").JSX.Element;
+declare const ProfileForm: ({ isCreateProfile, hooks, functions, meta, gtm, ...props }: IProfileFormProps) => import("react/jsx-runtime").JSX.Element;
 export default ProfileForm;

package/general/progress-tracker/index.d.ts

@@ -1 +1 @@
-export { default as ProgressTracker } from './progress-tracker';
+export { default as ProgressTracker, type INavigationDotsProps as IProgressTrackerProps, } from './progress-tracker';

package/general/progress-tracker/progress-tracker.d.ts

@@ -1,9 +1,9 @@
 /// <reference types="react" />
-interface Props {
+export interface INavigationDotsProps {
     /** The current step */
     currentStep?: number;
     /** The total number of steps */
     steps?: number;
 }
-declare const NavigationDots: React.FC<Props>;
+declare const NavigationDots: React.FC<INavigationDotsProps>;
 export default NavigationDots;