@apolitical/component-library 4.5.10 → 4.5.11-beta.2

package/context/user/user.context.d.ts

@@ -1,14 +1,22 @@
-/// <reference types="react" />
+import React from 'react';
+export interface IUserDetailsImage {
+    thumbnail?: string;
+    full?: string;
+}
+export interface IUserDetailsLocation {
+    country?: string;
+}
 export interface IUserDetails {
     id?: string;
     name?: string;
-    image?: {
-        thumbnail?: string;
-    };
+    image?: IUserDetailsImage;
     organization?: string;
     jobTitle?: string;
+    location?: IUserDetailsLocation;
+    biography?: string;
 }
 export interface IUserContext extends IUserDetails {
     isLoading: boolean;
+    updateDetails?: React.Dispatch<React.SetStateAction<IUserContext>>;
 }
-export declare const UserContext: import("react").Context<IUserContext>;
+export declare const UserContext: React.Context<IUserContext>;

package/context/user/user.provider.d.ts

@@ -3,6 +3,7 @@ import type { IUserContext } from './user.context';
 interface Props {
     children: React.ReactNode;
     user: IUserContext;
+    updateDetails?: React.Dispatch<React.SetStateAction<IUserContext>>;
 }
-export declare const UserProvider: ({ children, user }: Props) => import("react/jsx-runtime").JSX.Element;
+export declare const UserProvider: ({ children, user, updateDetails }: Props) => import("react/jsx-runtime").JSX.Element;
 export {};

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

@@ -173,6 +173,18 @@ export interface FormButtonPropsType extends ButtonPropsType {
     /** The option to not have the submit button at all */
     hideButton?: boolean;
 }
+export interface IFormMeta {
+    /** Whether the form should reset after submission */
+    shouldReset?: boolean;
+    /** Whether the form should hide after submission */
+    shouldHide?: 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 IFormProps {
     /** The form submit button */
     button?: FormButtonPropsType;
@@ -209,18 +221,7 @@ export interface IFormProps {
     /** The internationalisation path for text in the form */
     intlPath?: string | false;
     /** Data about the form */
-    meta?: {
-        /** Whether the form should reset after submission */
-        shouldReset?: boolean;
-        /** Whether the form should hide after submission */
-        shouldHide?: 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;
-    };
+    meta?: IFormMeta;
     /** Optional children */
     children?: React.ReactNode;
     /** An ID for jest tests */

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

@@ -1,2 +1,2 @@
 export { default as Form } from './form';
-export type { IField, FormValues } from './form.types';
+export type { IField, FormValues, IFormMeta } from './form.types';

package/form/components/profile-image-change/profile-image-change.d.ts

@@ -1,9 +1,10 @@
 import React from 'react';
+import type { IUserDetailsImage } from '../../../context';
 interface IUploadImageResponse {
     thumbnailURL: string;
     originalURL: string;
 }
-type TSetUserImage = (value: React.SetStateAction<IUploadImageResponse>) => void;
+type TSetUserImage = (value: React.SetStateAction<IUserDetailsImage>) => void;
 interface IUploadImageProps {
     fileObject: File;
     userId: string;
@@ -15,12 +16,24 @@ interface Props {
     userId: string;
     /** User name */
     userName: string;
-    /** Thumbnail image */
-    src?: string;
+    /** Image data */
+    src?: IUserDetailsImage;
     /** Function to upload the image */
-    uploadImage: ({ fileObject, userId }: IUploadImageProps) => Promise<IUploadImageResponse>;
-    /** Function to set the profile info */
-    setUserImage: TSetUserImage;
+    uploadImage: ({ fileObject, userId, }: IUploadImageProps) => Promise<IUploadImageResponse>;
+    /** Button props */
+    button?: {
+        /** Text for the button */
+        text?: {
+            /** Text to upload an image for the first time */
+            upload?: string;
+            /** Text to change the image */
+            change?: string;
+            /** Text to show while the image is being uploaded */
+            uploading?: string;
+        };
+    };
+    /** Callback function to update state in the parent file */
+    callback: TSetUserImage;
 }
-declare function ProfileImageChange({ className, userId, userName, src, setUserImage, uploadImage, }: Props): import("react/jsx-runtime").JSX.Element;
+declare function ProfileImageChange({ className, userId, userName, src, uploadImage, button, callback, }: Props): import("react/jsx-runtime").JSX.Element;
 export default ProfileImageChange;

package/form/types/index.d.ts

@@ -1,5 +1,6 @@
 export * from './contact-form';
 export * from './invite-form';
 export * from './password-form';
+export * from './profile-form';
 export * from './search-form';
 export * from './signup-form';

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

@@ -0,0 +1 @@
+export { default as ProfileForm, type IProfileFormProps } from './profile-form';

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

@@ -0,0 +1,25 @@
+import type { IFormValues, IFormMeta } from './../../components/form/form.types';
+export interface IProfileFormProps {
+    /** The functions to call */
+    functions: {
+        /** The function to upload the user's profile image */
+        uploadImage: () => void;
+        /** The function to handle getting the location predictions */
+        predictPlace: (arg: object) => {
+            city: Promise<any[]>;
+        };
+        /** The function to call on success */
+        onSuccess?: (data: IFormValues) => Promise<void>;
+        /** The function to call on failure */
+        onFailure?: () => void;
+    };
+    /** Meta for the form */
+    meta?: IFormMeta;
+    /** The Google Tag Manager data */
+    gtm?: {
+        context?: string;
+        event?: string;
+    };
+}
+declare const ProfileForm: ({ functions, meta, gtm }: IProfileFormProps) => import("react/jsx-runtime").JSX.Element;
+export default ProfileForm;

package/helpers/intl.d.ts

@@ -233,10 +233,22 @@ export declare const checkIntlPathExists: (path: string, language?: {
     passwordRules_currentPassword_label: string;
     passwordRules_newPassword_label: string;
     passwordRules_confirmPassword_label: string;
-    profile_image_change_uploading_text: string;
-    profile_image_change_cta_with_picture: string;
-    profile_image_change_cta_without_picture: string;
-    profile_image_change_error: string;
+    profileForm_image: string;
+    profileForm_name: string;
+    profileForm_name_placeholder: string;
+    profileForm_jobTitle: string;
+    profileForm_jobTitle_placeholder: string;
+    profileForm_organization: string;
+    profileForm_organization_placeholder: string;
+    profileForm_location: string;
+    profileForm_location_placeholder: string;
+    profileForm_bio: string;
+    profileForm_bio_placeholder: string;
+    profileForm_cta: string;
+    profileImageChange_cta_uploading: string;
+    profileImageChange_cta_change: string;
+    profileImageChange_cta_upload: string;
+    profileImageChange_error: string;
     ratings_text: string;
     ratings_stars: string;
     ratings_low: string;
@@ -393,6 +405,7 @@ export declare const checkIntlPathExists: (path: string, language?: {
     inviteModal_formLabel: string;
     inviteModal_cta: string;
     overlay_close: string;
+    profileModal_title: string;
     breadcrumbs_label: string;
     breadcrumbs_currentPage: string;
     filters_all: string;
@@ -421,8 +434,9 @@ export declare const checkIntlPathExists: (path: string, language?: {
     shareLinks_link_email: string;
     'shareLinks_link_clipboard-copy': string;
     tags_community: string;
-    edit_section_placeholder_description: string;
-    edit_section_placeholder_cta: string;
+    editSection_placeholder_description: string;
+    editSection_placeholder_cta: string;
+    editSection_edit: string;
     notFoundError_title: string;
     notFoundError_text: string;
     notFoundError_post_1: string;