@apolitical/component-library 4.5.0-beta.8 → 4.5.0

package/discussion/components/add-post/add-post.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import { type IDiscussionForm } from '../../../discussion/components/form';
+import type { IDiscussionForm } from '../../../discussion/components/form';
 interface Props {
     /** Whether the form should be displayed as a card */
     isCard?: boolean;

package/discussion/components/form/components/guidelines/guidelines.d.ts

@@ -9,5 +9,5 @@ interface Props {
     /** The Google Tag Manager context */
     gtmContext: string;
 }
-declare const Guidelines: ({ intlPath, showGuidelines, type, gtmContext }: Props) => import("react/jsx-runtime").JSX.Element | null;
+declare const Guidelines: ({ intlPath, showGuidelines, type, gtmContext }: Props) => import("react/jsx-runtime").JSX.Element;
 export default Guidelines;

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

@@ -1,108 +1,3 @@
-import {
- type ListMembers,
-} from '@/components/form';
-
-import {
-  DiscussionCreateContentFunction,
-  IDiscussionContent,
-  IMentions,
-} from './../../discussion';
-
-export interface IDiscussionFormMeta {
-  /** Whether the form data is still loading */
-  isLoading?: boolean;
-
-  /** Whether the form is in a wrapper or not - used for styling */
-  isInWrapper?: boolean;
-
-  /** Whether the form is in a modal or not - used to handle portals */
-  isInOverlay?: false | string;
-
-  /** Whether the form should be autofocused. (It will always be autofocused when `isEditing`. */
-  isAutoFocused?: boolean;
-
-  /** Whether we're editing or creating */
-  isEditing: false | { text?: string };
-
-  /** Whether the form has a title field */
-  hasTitleField?: false | { text?: string };
-
-  /** Whether the form is prepopulated with text (different to isEditing, as we want different buttons and text to show */
-  isPrepopulated: false | { text?: string };
-
-  /** Whether title text should show above the form */
-  showTitle?: boolean;
-
-  /** Whether the community guidelines text should show beneath the form */
-  showGuidelines?: boolean;
-
-  /** Whether to show a divider before the buttons */
-  showDivider?: boolean;
-
-  /** Whether the success message should show on a successful submit */
-  showSuccessMessage?: boolean;
-}
-
-export interface IDiscussionForm {
-  /** A unique ID for the form */
-  id?: string;
-
-  /** Information about the content being created/edited */
-  content: IDiscussionContent;
-
-  /** If the user has permission to interact with the form, e.g. if they're a member of the community */
-  userHasPermissions?: boolean;
-
-  /** Information about the form */
-  meta?: IDiscussionFormMeta;
-
-  /** The placeholder text - this defaults to the intl text */
-  placeholder?: string;
-
-  /** The maximum number of characters */
-  maxLength?: number;
-
-  /** The buttons at the bottom of the form */
-  buttons?: {
-    /** Text for the cancel button */
-    cancel?: string;
-    /** Text for the submit button */
-    submit?: string;
-  };
-
-  /** If the form is used within a Community */
-  isCommunity?: boolean;
-
-  /** Force elements on the form to show, regardless of the form state */
-  forceShow?: {
-    /** If the cancel button should always show */
-    cancel?: boolean;
-    /** If an error, created externally, should always show */
-    error?: false | string;
-  };
-
-  /** The functions that are passed in to handle the functionality */
-  functions: {
-    create: DiscussionCreateContentFunction;
-    handleSaveEdit?: (({ title: string, body: string }) => Promise<void>) | (() => void);
-    handleCancel?: () => void;
-    callback?: (args: void) => void;
-    listMembers?: ListMembers;
-
-    props?: {
-      create: { projectNames: ['questions-answers'] };
-    };
-  };
-
-  /** Data to be passed into the rich text editor */
-  data?: {
-    /** Mentions data */
-    mentions?: IMentions;
-  };
-
-  /** The context for GTM */
-  gtmContext?: string;
-
-  /** The language to use for the text */
-  locale?: string;
-}
+import { IDiscussionForm } from './form.type';
+declare const DiscussionForm: ({ id, content, userHasPermissions, meta, placeholder, maxLength, buttons, forceShow, isCommunity, functions, data, gtmContext, }: IDiscussionForm) => import("react/jsx-runtime").JSX.Element;
+export default DiscussionForm;

package/discussion/components/form/form.type.d.ts

@@ -0,0 +1,87 @@
+import { type ListMembers } from '../../../form';
+import { DiscussionCreateContentFunction, IDiscussionContent, IMentions } from './../../discussion';
+export interface IDiscussionFormMeta {
+    /** Whether the form data is still loading */
+    isLoading?: boolean;
+    /** Whether the form is in a wrapper or not - used for styling */
+    isInWrapper?: boolean;
+    /** Whether the form is in a modal or not - used to handle portals */
+    isInOverlay?: false | string;
+    /** Whether the form should be autofocused. (It will always be autofocused when `isEditing`. */
+    isAutoFocused?: boolean;
+    /** Whether we're editing or creating */
+    isEditing: false | {
+        text?: string;
+    };
+    /** Whether the form has a title field */
+    hasTitleField?: false | {
+        text?: string;
+    };
+    /** Whether the form is prepopulated with text (different to isEditing, as we want different buttons and text to show */
+    isPrepopulated: false | {
+        text?: string;
+    };
+    /** Whether title text should show above the form */
+    showTitle?: boolean;
+    /** Whether the community guidelines text should show beneath the form */
+    showGuidelines?: boolean;
+    /** Whether to show a divider before the buttons */
+    showDivider?: boolean;
+    /** Whether the success message should show on a successful submit */
+    showSuccessMessage?: boolean;
+}
+export interface IDiscussionForm {
+    /** A unique ID for the form */
+    id?: string;
+    /** Information about the content being created/edited */
+    content: IDiscussionContent;
+    /** If the user has permission to interact with the form, e.g. if they're a member of the community */
+    userHasPermissions?: boolean;
+    /** Information about the form */
+    meta?: IDiscussionFormMeta;
+    /** The placeholder text - this defaults to the intl text */
+    placeholder?: string;
+    /** The maximum number of characters */
+    maxLength?: number;
+    /** The buttons at the bottom of the form */
+    buttons?: {
+        /** Text for the cancel button */
+        cancel?: string;
+        /** Text for the submit button */
+        submit?: string;
+    };
+    /** If the form is used within a Community */
+    isCommunity?: boolean;
+    /** Force elements on the form to show, regardless of the form state */
+    forceShow?: {
+        /** If the cancel button should always show */
+        cancel?: boolean;
+        /** If an error, created externally, should always show */
+        error?: false | string;
+    };
+    /** The functions that are passed in to handle the functionality */
+    functions: {
+        create: DiscussionCreateContentFunction;
+        handleSaveEdit?: (({ title, body }: {
+            title: string;
+            body: string;
+        }) => Promise<void>) | (() => void);
+        handleCancel?: () => void;
+        callback?: (args: void) => void;
+        listMembers?: ListMembers;
+        props?: {
+            create: {
+                projectNames: ['questions-answers'];
+            };
+        };
+    };
+    /** Data to be passed into the rich text editor */
+    data?: {
+        /** Mentions data */
+        mentions?: IMentions;
+    };
+    /** The context for GTM */
+    gtmContext?: string;
+    /** The language to use for the text */
+    locale?: string;
+}

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

@@ -1,2 +1,2 @@
-export type { IDiscussionForm, IDiscussionFormMeta } from './form.d';
+export type { IDiscussionForm, IDiscussionFormMeta } from './form.type';
 export { default as DiscussionForm } from './form';

package/discussion/feeds/activities-feed/cache/hooks/create/create.hook.d.ts

@@ -2,7 +2,7 @@ import type { IMutationContext } from '../../../../../../discussion/shared';
 import type { ICache, ICacheItem } from '../..';
 interface ICreateVars {
     title?: string;
-    content: string;
+    content?: string;
 }
 export declare function useCreateActivity({ mutationFn, mutationHandlers: { mutate: mutateWrapper, error: onError }, queryClient, queryKey, user, }: IMutationContext<ICacheItem, Error, ICreateVars, ICache>): import("@tanstack/react-query/build/legacy/types").UseMutateFunction<import('../../../../../../discussion/shared').IActivity, Error, ICreateVars, ICache>;
 export {};

package/discussion/sections/activity-section/cache/hooks/edit/edit.hook.d.ts

@@ -2,7 +2,7 @@ import type { IMutationContext } from '../../../../../../discussion/shared';
 import type { ICache } from '../..';
 interface IEditVars {
     title?: string;
-    content: string;
+    content?: string;
 }
 export declare function useEditActivity({ mutationFn, mutationHandlers: { mutate: mutateWrapper, error: onError }, }: IMutationContext<ICache, Error, IEditVars, ICache>): import("@tanstack/react-query/build/legacy/types").UseMutateFunction<import('../../../../../../discussion/shared').IActivity, Error, IEditVars, import('../../../../../../discussion/shared').IActivity>;
 export {};

package/discussion/shared/helpers/activity.helper.d.ts

@@ -2,7 +2,7 @@ import type { IUserContext } from '../../../context';
 import type { IActivity, IReaction } from '..';
 interface IPrepareActivityArgs {
     title?: string;
-    content: string;
+    content?: string;
 }
 interface IEnrichActivityArgs {
     activity: IActivity | Partial<IActivity>;
@@ -19,7 +19,7 @@ interface IDecrementActivityLikesArgs {
 }
 export declare function prepareActivity({ title, content }: IPrepareActivityArgs): {
     title: string | undefined;
-    content: string;
+    content: string | undefined;
     id: string;
     time: string;
     verb: string;