@apolitical/component-library 6.5.0-SW.0 → 6.5.0-beta.0

package/discussion/components/conversation/conversation.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-import type { IConversation, IListMemberData } from '../../../discussion/shared';
+import { IConversation, IListMemberData } from './../../discussion';
 export declare const ConversationContext: React.Context<{
     showForm: boolean;
     prepopulateForm?: string | undefined;

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

@@ -1,5 +1,5 @@
-import type { IDiscussionForm } from './../form';
-import type { IMentions } from '../../../discussion/shared';
+import { type IDiscussionForm } from './../form';
+import { IMentions } from './../../discussion.d';
 export interface CachedText {
     /** Whether the cached text should show on the form card; this is false by default
      * to prevent the text changing right away and distracting the user */

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

@@ -1,4 +1,4 @@
-import type { IDiscussionContentType } from '../../../../../discussion/shared';
+import { IDiscussionContentType } from './../../../../discussion.d';
 interface Props {
     /** The internationalisation path for the guidelines */
     intlPath: string;

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

@@ -1,5 +1,5 @@
 import { type ILabelProps } from '../../../../../form';
-import type { IDiscussionContentType } from '../../../../../discussion/shared';
+import { IDiscussionContentType } from './../../../../discussion.d';
 interface Props extends ILabelProps {
     /** The internationalisation path for the label */
     intlPath: string;

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

@@ -0,0 +1,2 @@
+export declare const MAX_POLL_OPTIONS = 5;
+export declare const MIN_POLL_OPTIONS = 2;

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

@@ -1,3 +1,3 @@
 import { IDiscussionForm } from './form.type';
-declare const DiscussionForm: ({ id, parentId, content, userHasPermissions, meta, placeholder, maxLength, buttons, forceShow, isCommunity, functions, data, gtmContext, }: IDiscussionForm) => import("react/jsx-runtime").JSX.Element;
+declare const DiscussionForm: ({ id, parentId, content, userHasPermissions, meta, placeholder, maxLength, buttons, forceShow, functions, data, gtmContext, }: IDiscussionForm) => import("react/jsx-runtime").JSX.Element;
 export default DiscussionForm;

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

@@ -0,0 +1,4 @@
+import type { IFormValues } from '../../../form';
+import type { IRTEValues } from './form.type';
+import { ITransformedPollData } from './../../shared';
+export declare const transformPollData: (data: IRTEValues & IFormValues) => ITransformedPollData;

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

@@ -1,5 +1,9 @@
 import type { IEnrichedUrlData } from '../../../navigation';
-import type { ICategory, IDiscussionContent, IDiscussionFormFunctions, IMentions } from '../../../discussion/shared';
+import type { ICategory, IDiscussionFormFunctions, IDiscussionContent, IMentions } from '../../shared';
+interface IPollData {
+    options: string[];
+    multipleAnswers: boolean;
+}
 export interface IDiscussionFormMeta {
     /** Whether the form data is still loading */
     isLoading?: boolean;
@@ -13,11 +17,14 @@ export interface IDiscussionFormMeta {
     isEditing: false | {
         categories?: string[] | string;
         text?: string;
+        poll?: IPollData;
     };
     /** Whether the form has a title field */
     hasTitleField?: false | {
         text?: string;
     };
+    /** If the form can be pre-populated; this is not allowed outside communities at the moment */
+    canBePrepopulated?: boolean;
     /** Whether the form is prepopulated with text (different to isEditing, as we want different buttons and text to show */
     isPrepopulated: false | {
         text?: string;
@@ -57,8 +64,6 @@ export interface IDiscussionForm {
         /** 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 */
@@ -80,11 +85,15 @@ export interface IDiscussionForm {
     /** The language to use for the text */
     locale?: string;
 }
-export interface IDiscussionFormState {
-    title: string;
-    body: string;
-    categories: string[] | string;
-    data: {
+export interface IRTEValues {
+    body?: string;
+    data?: {
         link?: false | IEnrichedUrlData;
     };
 }
+export interface IDiscussionFormState {
+    status: false | 'submitting' | 'submitted';
+    title: string;
+    polls: number;
+}
+export {};

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

@@ -1,5 +1 @@
-export * from './author-section';
 export * from './blockquote';
-export * from './categories';
-export * from './poll-content';
-export * from './post-content';

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

@@ -1,8 +1,8 @@
 import React from 'react';
-import type { IPollFns, IPollProps } from '../../../polls';
-import type { IMemberComponentProps } from '../../../user';
-import type { DiscussionCreateContentFunction, DiscussionCreateLikeFunction, DiscussionDeleteLikeFunction, DiscussionListLikesFunction, IDiscussionFormFns, IForceHide, IFullDiscussionContent } from '../../../discussion/shared';
-import type { IBadgesOption } from '../../../user/badges';
+import { IMemberComponentProps } from '../../../user';
+import { DiscussionCreateContentFunction, DiscussionCreateLikeFunction, DiscussionDeleteLikeFunction, DiscussionListLikesFunction, IDiscussionFormFns } from '../../discussion';
+import { type IForceHide, type IFullDiscussionContent } from '../../shared/interfaces';
+import { IBadgesOption } from '../../../user/badges';
 export interface IPostContent extends IFullDiscussionContent {
     /** The post body */
     postBody?: string;
@@ -10,13 +10,6 @@ export interface IPostContent extends IFullDiscussionContent {
         /** Custom props to pass through to the Member component */
         member: IMemberComponentProps;
     };
-    /** The options for the Poll */
-    pollOptions?: IPollProps['options'];
-    /** The settings for the Poll */
-    pollSettings?: IPollProps['settings'];
-}
-export interface IPollFunctions extends IPollFns {
-    removePoll: (args?: object) => void;
 }
 export interface IDiscussionPostProps {
     /** The element that will render around the content */
@@ -51,7 +44,6 @@ export interface IDiscussionPostProps {
             /** List the likes on the post */
             listLikes: DiscussionListLikesFunction;
         };
-        polls?: IPollFunctions;
         comments: {
             /** Open comments on a post */
             openComments?: () => void;
@@ -97,5 +89,5 @@ export interface IDiscussionPostProps {
     /** The ID of the parent, used for slugs */
     parentId: string;
 }
-declare const Post: ({ element, content, userHasPermissions, userHasOwnerPermissions, isLoading, originalAuthorId, forceHide, functions, links, className, gtmContext, children, isTruncated, setFocus, isCommunity, badges, basePath, parentId, locale, }: IDiscussionPostProps) => import("react/jsx-runtime").JSX.Element;
+declare const Post: ({ element, content, userHasPermissions, userHasOwnerPermissions, isLoading, originalAuthorId, forceHide, functions, links, className, gtmContext, children, isTruncated, setFocus, isCommunity, badges, basePath, parentId, }: IDiscussionPostProps) => import("react/jsx-runtime").JSX.Element;
 export default Post;

package/discussion/components/post/post.helpers.d.ts

@@ -1,9 +1,5 @@
-import type { IMentions } from '../../../discussion/shared';
+import { IMentions } from './../../discussion';
 import { ListMembers } from '../../../form';
 import { ICategory } from '../../shared';
 export declare const getPostBody: (body: string, isTruncated: boolean | number, mentions?: IMentions, listMembers?: ListMembers) => Promise<string>;
 export declare const enrichPostCategories: (postCategories: string[], allCategories: ICategory[]) => (ICategory | undefined)[];
-export declare const allowClickUntilClassNameFound: (event: React.MouseEvent<HTMLElement, MouseEvent>, contentClasses: string[], breakClassName: string) => boolean;
-export declare const getTitleText: (title: string | {
-    [key: string]: string;
-} | undefined, locale: string) => string;

package/discussion/discussion.mock.d.ts

@@ -216,3 +216,7 @@ export namespace question {
     let createdAt_5: string;
     export { createdAt_5 as createdAt };
 }
+export const postCategories: {
+    name: string;
+    slug: string;
+}[];

package/discussion/feeds/activities-feed/activities-feed.d.ts

@@ -1,8 +1,8 @@
 /// <reference types="react" />
 import { type IProfileFormProps } from '../../../form';
-import { type ICategory } from '../../../discussion/shared';
+import { ICategory } from '../../../discussion/shared';
 import type { ILikesFeedQueryFns } from '../../../discussion/feeds/likes-feed';
-import type { IDiscussionFormFns } from '../../../discussion/shared';
+import type { IDiscussionFormFns } from '../../../discussion/discussion.d';
 import { type IQueryFns } from './cache';
 interface Props {
     /** The base path, used for slugs */
@@ -26,13 +26,9 @@ interface Props {
         /** Function to leave the community */
         leave: () => Promise<void>;
         likes: ILikesFeedQueryFns;
-        /** Query functions for polls */
-        polls: IQueryFns;
     };
     /** Props to pass into the profile form */
     profile: IProfileFormProps;
-    /** The locale of the page */
-    locale?: string;
 }
 declare const ActivitiesFeed: React.FC<Props>;
 export default ActivitiesFeed;

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

@@ -1,11 +1,9 @@
 export * from './create';
-export * from './create-vote';
 export * from './edit';
 export * from './feed';
 export * from './like';
 export * from './list';
 export * from './pin';
 export * from './remove';
-export * from './remove-vote';
 export * from './unlike';
 export * from './unpin';

package/discussion/feeds/replies-feed/components/nested-replies-feed/nested-replies-feed.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import type { IDiscussionFormFns } from '../../../../../discussion/shared';
+import type { IDiscussionFormFns } from '../../../../../discussion/discussion.d';
 import { ILikesFeedQueryFns } from '../../../../../discussion/feeds/likes-feed';
 import { type IQueryFns } from '../../cache';
 interface NestedRepliesFunctions {

package/discussion/feeds/replies-feed/components/reply-item/reply-item.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="react" />
 import { ILikesFeedQueryFns } from '../../../../../discussion/feeds/likes-feed';
-import type { IDiscussionFormFns } from '../../../../../discussion/shared';
+import type { IDiscussionFormFns } from '../../../../discussion';
 import type { IParsedReplies, IQueryFns } from '../../cache';
 interface IMutations {
     edit: (params: {

package/discussion/feeds/replies-feed/replies-feed.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import { type IProfileFormProps } from '../../../form';
-import { type IDiscussionFormFns } from '../../../discussion/shared';
 import { ILikesFeedQueryFns } from '../../../discussion/feeds/likes-feed';
+import type { IDiscussionFormFns } from '../../discussion';
 import { type IQueryFns } from './cache';
 interface RepliesFunctions {
     /** Functions for the replies query */

package/discussion/index.d.ts

@@ -2,4 +2,5 @@ export * from './components';
 export * from './feeds';
 export * from './discussion.helpers';
 export * from './sections';
-export * from './shared/interfaces';
+export type { IActivity, IFullDiscussionContent, IListMemberData, IMentionData, IMentions, IReaction, IUser, } from './shared/interfaces';
+export type { IDiscussionFormFns } from './discussion.d';

package/discussion/sections/activity-section/activity-section.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import { type IProfileFormProps } from '../../../form';
-import { type IRepliesFeedQueryFns, type ILikesFeedQueryFns } from '../../../discussion/feeds';
-import type { IDiscussionFormFns } from '../../../discussion/shared';
+import { type ILikesFeedQueryFns, type IRepliesFeedQueryFns } from '../../../discussion/feeds';
+import type { IDiscussionFormFns } from './../../discussion.d';
 import { type IQueryFns } from './cache';
 import { ICategory } from '../../shared';
 interface IActivitySectionQueryFns extends IQueryFns {

package/discussion/shared/constants.d.ts

@@ -1,4 +1,3 @@
 export declare const ACTIVITY_VERB = "post";
 export declare const REPLY_KIND = "reply";
 export declare const TMP_ID = "00000000-0000-0000-0000-000000000000";
-export declare const DEFAULT_LOCALE = "en";

package/discussion/shared/helpers/index.d.ts

@@ -1,5 +1,4 @@
 export * from './activity.helper';
-export * from './cache.helper';
-export * from './poll.helper';
 export * from './reply.helper';
+export * from './cache.helper';
 export { default as triggerDiscussionPostAdded } from './trigger-discussion-post-added';

package/discussion/shared/interfaces/activity.interface.d.ts

@@ -1,28 +1,13 @@
 import type { FlatActivityEnriched } from 'getstream';
 import type { IEnrichedUrlData } from '../../../navigation/enriched-url';
-import { ResultsVisibility } from '../../../polls/poll';
-export declare enum ActivityType {
-    Post = "post",
-    Poll = "poll"
-}
 export interface IActivity extends FlatActivityEnriched {
     content: string;
     categories?: string[];
     feed_id?: string;
-    title: string | {
-        [key: string]: string;
-    };
+    title: string;
     total_replies?: number;
     total_likes?: number;
     additional_data?: {
         link?: IEnrichedUrlData | false | undefined;
     };
-    settings?: {
-        show_remove_vote?: boolean;
-        allow_multiple_votes?: boolean;
-        deadline_at?: string;
-        hide_participants?: boolean;
-        number_of_winners?: number;
-        results_visibility?: ResultsVisibility;
-    };
 }

package/discussion/shared/interfaces/discussion.interface.d.ts

@@ -1,12 +1,20 @@
-import type { MemberProps, MemberDetailsProps } from '../../../user';
+import { MemberProps, MemberDetailsProps } from '../../../user';
 import type { ListMembers, ClickMentionFallback } from '../../../form';
 import type { IEnrichedUrlData } from '../../../navigation';
 import type { ICategory } from './community.category.interface';
-import type { ILikesFeedQueryFns } from '../../../discussion/feeds/likes-feed';
-export type IDiscussionContentType = 'answer' | 'post' | 'response' | 'reply' | 'question' | 'poll';
+import type { IDiscussionFormFns } from '../../discussion';
+export declare enum DiscussionContentType {
+    Answer = "answer",
+    Poll = "poll",
+    Post = "post",
+    Response = "response",
+    Reply = "reply",
+    Question = "question"
+}
+export type IDiscussionContentType = DiscussionContentType.Answer | DiscussionContentType.Poll | DiscussionContentType.Post | DiscussionContentType.Response | DiscussionContentType.Reply | DiscussionContentType.Question;
 export interface IDiscussionContent {
     /** The type of content */
-    type: IDiscussionContentType;
+    type: IDiscussionContentType | undefined;
     /** The slugs we're dealing with - used in functions */
     slugs: {
         question?: string;
@@ -22,9 +30,7 @@ export interface IFullDiscussionContent extends IDiscussionContent {
     /** The content slug */
     slug: string;
     /** The title of the content post */
-    title?: string | {
-        [key: string]: string;
-    };
+    title?: string;
     /** The body of the content post */
     body?: string;
     /** The author of the post */
@@ -66,7 +72,6 @@ export type IForceHide = {
 export type DiscussionCreateContentFunction = (args1: void | object, args2?: object) => void;
 export type DiscussionCreateLikeFunction = (args1: object) => void;
 export type DiscussionDeleteLikeFunction = (args: object) => void;
-export type DiscussionListLikesFunction = ILikesFeedQueryFns['list'];
 export interface IMentions {
     [key: string]: IMentionData;
 }
@@ -82,14 +87,6 @@ export interface IMentionData {
     /** An error message, shown if the user was deleted */
     error?: string;
 }
-export interface IDiscussionFormFns {
-    /** A function to get a filtered list of members when the user starts typing a mention */
-    listMembers: ListMembers;
-    /** A function to call when the user clicks the mention fallback, e.g. to show an invite modal */
-    clickMentionFallback: ClickMentionFallback;
-    /** Get metadata about a link, to show an enriched URL */
-    getLinkPreview?: (url: string) => Promise<IEnrichedUrlData>;
-}
 export interface IMentionsFns {
     listMembers: ListMembers;
     clickMentionFallback: ClickMentionFallback;
@@ -103,15 +100,21 @@ export interface IConversation {
     prepopulateForm?: string;
     mentionData?: IListMemberData;
 }
+export interface ITransformedPollData {
+    [key: string]: string | number | {
+        [key: string]: string | number;
+    } | {
+        [key: string]: string | number;
+    }[];
+}
 export interface IDiscussionFormFunctions extends IDiscussionFormFns {
     onChange?: (args: {
-        [key: string]: string | boolean;
+        [key: string]: string | string[] | boolean;
     }) => void;
     create: DiscussionCreateContentFunction;
-    handleSaveEdit?: (({ title, body }: {
-        title: string;
-        body: string;
-    }) => Promise<void>) | (() => void);
+    createPoll?: (args: ITransformedPollData) => void;
+    handleSaveEdit?: // eslint-disable-next-line  @typescript-eslint/no-explicit-any
+    ((args: any) => Promise<void>) | (() => void);
     handleCancel?: () => void;
     callback?: (args: void) => void;
     onMention?: (value?: IListMemberData) => void;

package/discussion/shared/interfaces/reaction.interface.d.ts

@@ -1,5 +1,5 @@
 import type { EnrichedReaction } from 'getstream';
-import type { IMentions } from '../../../discussion/shared';
+import type { IMentions } from './../../discussion.d';
 export interface IReaction extends EnrichedReaction {
     /** Details of users mentioned in the content */
     mentioned_users?: IMentions;

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

@@ -268,5 +268,7 @@ export interface IFieldWrapper extends IField {
         setFields: React.Dispatch<React.SetStateAction<IField[]>>;
         dispatch: React.Dispatch<IFormReducerAction>;
     };
+    /** Optional siblings to render alongside component */
+    siblings?: React.ReactNode;
 }
 export {};

package/form/components/rich-text-editor/components/context/context.d.ts

@@ -1,6 +1,6 @@
 import { Dispatch } from 'react';
 import { Point } from 'slate';
-import type { IListMemberData } from '../../../../../discussion/shared';
+import { IListMemberData } from '../../../../../discussion';
 import type { IEnrichedUrlData } from '../../../../../navigation';
 import { ReportError, IMentionPopOver } from './../../rich-text-editor.types';
 declare const RichTextEditorContext: import("react").Context<{

package/form/components/rich-text-editor/rich-text-editor.types.d.ts

@@ -1,5 +1,5 @@
 import { BaseElement, BaseText, Descendant, Point, Range } from 'slate';
-import type { IListMemberData, IMentions, IDiscussionFormFns } from '../../../discussion/shared';
+import type { IListMemberData, IMentions, IDiscussionFormFns } from '../../../discussion';
 import type { MemberDetailsProps } from '../../../user';
 import type { IEnrichedUrlData } from '../../../navigation';
 interface IRTEData {

package/helpers/intl.d.ts

@@ -113,7 +113,6 @@ export declare const checkIntlPathExists: (path: string, language?: {
     markCompleteButton_completed: string;
     discussion_action_answer: string;
     discussion_action_comment: string;
-    discussion_action_poll: string;
     discussion_action_post: string;
     discussion_action_response: string;
     discussion_action_reply: string;
@@ -124,7 +123,6 @@ export declare const checkIntlPathExists: (path: string, language?: {
     discussion_delete_cancel: string;
     discussion_delete_delete: string;
     discussion_delete_error: string;
-    discussion_pinned_post: string;
     discussion_reply: string;
     discussion_report_subject: string;
     discussion_report_body: string;
@@ -139,6 +137,12 @@ export declare const checkIntlPathExists: (path: string, language?: {
     discussion_form_titleField_label: string;
     discussion_form_titleField_placeholder: string;
     discussion_form_titleField_error: string;
+    discussion_form_question_label: string;
+    discussion_form_question_placeholder: string;
+    discussion_form_option_label: string;
+    discussion_form_option_placeholder: string;
+    discussion_form_option_cta: string;
+    discussion_form_multiplePollAnswers: string;
     discussion_form_placeholder: string;
     discussion_form_label: string;
     discussion_form_label_action: string;
@@ -238,6 +242,7 @@ export declare const checkIntlPathExists: (path: string, language?: {
     form_multipleInputs_label: string;
     form_multipleInputs_filledInCount: string;
     form_multipleInputs_filledInCount_aria: string;
+    form_multipleInputs_remove: string;
     inviteForm_email_placeholder: string;
     inviteForm_title: string;
     inviteForm_label: string;
@@ -281,7 +286,6 @@ export declare const checkIntlPathExists: (path: string, language?: {
     profileImageChange_error: string;
     publishArticleForm_title_label: string;
     publishArticleForm_title_placeholder: string;
-    publishArticleForm_title_error: string;
     publishArticleForm_subtitle_label: string;
     publishArticleForm_subtitle_placeholder: string;
     publishArticleForm_body_label: string;

package/helpers/replace-mention-data.d.ts

@@ -1,4 +1,4 @@
-import type { IMentions } from '../discussion/shared';
+import { IMentions } from '../discussion';
 import { ListMembers } from '../form';
 declare const replaceMentionData: ({ text, template, mentions, listMembers, }: {
     text: string;