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

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

@@ -1,5 +1,5 @@
 import React from 'react';
-import { IConversation, IListMemberData } from './../../discussion';
+import type { IConversation, IListMemberData } from '../../../discussion/shared';
 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 { IMentions } from './../../discussion.d';
+import type { IDiscussionForm } from './../form';
+import type { IMentions } from '../../../discussion/shared';
 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 { IDiscussionContentType } from './../../../../discussion.d';
+import type { IDiscussionContentType } from '../../../../../discussion/shared';
 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 { IDiscussionContentType } from './../../../../discussion.d';
+import type { IDiscussionContentType } from '../../../../../discussion/shared';
 interface Props extends ILabelProps {
     /** The internationalisation path for the label */
     intlPath: string;

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

@@ -1,5 +1,5 @@
 import type { IEnrichedUrlData } from '../../../navigation';
-import type { ICategory, IDiscussionFormFunctions, IDiscussionContent, IMentions } from '../../shared';
+import type { ICategory, IDiscussionContent, IDiscussionFormFunctions, IMentions } from '../../../discussion/shared';
 interface IPollData {
     options: string[];
     multipleAnswers: boolean;

package/discussion/components/post/components/author-section/author-section.d.ts

@@ -0,0 +1,14 @@
+import type { IFullDiscussionContent } from '../../../../../discussion/shared';
+import type { IDiscussionPostProps } from '../../post';
+export interface IAuthorSectionProps {
+    author: IFullDiscussionContent['author'];
+    originalAuthorId?: string;
+    createdAt: IFullDiscussionContent['createdAt'];
+    contentData: {
+        didEdit: boolean;
+    };
+    content: IDiscussionPostProps['content'];
+    badges?: IDiscussionPostProps['badges'];
+    gtmContext?: string;
+}
+export default function AuthorSection({ author, originalAuthorId, createdAt, contentData, content, gtmContext, badges, }: IAuthorSectionProps): import("react/jsx-runtime").JSX.Element;

package/discussion/components/post/components/author-section/index.d.ts

@@ -0,0 +1 @@
+export { default as AuthorSection } from './author-section';

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

@@ -0,0 +1,5 @@
+import type { IDiscussionPostProps } from '../../post';
+export interface ICategoriesProps {
+    content: IDiscussionPostProps['content'];
+}
+export default function Categories({ content }: ICategoriesProps): import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1 @@
+export { default as Categories } from './categories';

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

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

package/discussion/components/post/components/poll-content/index.d.ts

@@ -0,0 +1 @@
+export { default as PollContent } from './poll-content';

package/discussion/components/post/components/poll-content/poll-content.d.ts

@@ -0,0 +1,10 @@
+import { IPollFns } from '../../../../../polls';
+import { IDiscussionPostProps } from '../../post';
+export interface IPollContentProps {
+    content: IDiscussionPostProps['content'];
+    contentData: {
+        title: string;
+    };
+    functions: IPollFns;
+}
+export default function PollContent({ content, contentData, functions, }: IPollContentProps): import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1 @@
+export { default as PostContent } from './post-content';

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

@@ -0,0 +1,15 @@
+import type { IDiscussionPostProps } from '../../post';
+import type { IFullDiscussionContent } from '../../../../../discussion';
+export interface IPostContentProps {
+    links: IDiscussionPostProps['links'];
+    contentData: {
+        title: string;
+        isEditing: boolean;
+        didEdit: boolean;
+        postBody: string;
+        data: IFullDiscussionContent['data'];
+    };
+    postCutOff: number;
+    content: IDiscussionPostProps['content'];
+}
+export default function PostContent({ links, contentData, postCutOff, content, }: IPostContentProps): import("react/jsx-runtime").JSX.Element;

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

@@ -1,8 +1,8 @@
 import React from 'react';
-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';
+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';
 export interface IPostContent extends IFullDiscussionContent {
     /** The post body */
     postBody?: string;
@@ -10,6 +10,13 @@ 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 */
@@ -44,6 +51,7 @@ export interface IDiscussionPostProps {
             /** List the likes on the post */
             listLikes: DiscussionListLikesFunction;
         };
+        polls?: IPollFunctions;
         comments: {
             /** Open comments on a post */
             openComments?: () => void;
@@ -89,5 +97,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, }: 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, locale, }: IDiscussionPostProps) => import("react/jsx-runtime").JSX.Element;
 export default Post;

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

@@ -1,5 +1,9 @@
-import { IMentions } from './../../discussion';
+import type { IMentions } from '../../../discussion/shared';
 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/feeds/activities-feed/activities-feed.d.ts

@@ -1,8 +1,7 @@
 /// <reference types="react" />
 import { type IProfileFormProps } from '../../../form';
-import { ICategory } from '../../../discussion/shared';
+import { ICategory, type IDiscussionFormFns } from '../../../discussion/shared';
 import type { ILikesFeedQueryFns } from '../../../discussion/feeds/likes-feed';
-import type { IDiscussionFormFns } from '../../../discussion/discussion.d';
 import { type IQueryFns } from './cache';
 interface Props {
     /** The base path, used for slugs */
@@ -26,9 +25,13 @@ 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/create-vote/create-vote.hook.d.ts

@@ -0,0 +1,8 @@
+import type { IMutationContext } from '../../../../../../discussion/shared';
+import type { ICache, ICacheSubitem } from '../..';
+interface ICreateVoteVars {
+    activityId: string;
+    reactionId: string;
+}
+export declare function useCreateVote({ mutationFn, mutationHandlers: { mutate: mutateWrapper, error: onError }, queryClient, queryKey, user, }: IMutationContext<ICacheSubitem, Error, ICreateVoteVars, ICache>): import("@tanstack/react-query/build/legacy/types").UseMutateFunction<import('../../../../../../discussion/shared').IReaction, Error, ICreateVoteVars, ICache>;
+export {};

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

@@ -0,0 +1 @@
+export * from './create-vote.hook';

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

@@ -1,9 +1,11 @@
 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/activities-feed/cache/hooks/remove-vote/index.d.ts

@@ -0,0 +1 @@
+export * from './remove-vote.hook';

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

@@ -0,0 +1,8 @@
+import type { IMutationContext } from '../../../../../../discussion/shared';
+import type { ICache } from '../..';
+interface IRemoveVoteVars {
+    activityId: string;
+    reactionId: string;
+}
+export declare function useRemoveVote({ mutationFn, mutationHandlers: { mutate: mutateWrapper, error: onError }, user, }: IMutationContext<unknown, Error, IRemoveVoteVars, ICache>): import("@tanstack/react-query/build/legacy/types").UseMutateFunction<unknown, Error, IRemoveVoteVars, ICache>;
+export {};

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

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

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

package/discussion/shared/constants.d.ts

@@ -1,3 +1,4 @@
 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,4 +1,5 @@
 export * from './activity.helper';
-export * from './reply.helper';
 export * from './cache.helper';
+export * from './poll.helper';
+export * from './reply.helper';
 export { default as triggerDiscussionPostAdded } from './trigger-discussion-post-added';

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

@@ -0,0 +1,23 @@
+import type { IPollOption } from '../../../polls';
+import { type IActivity } from '../interfaces/activity.interface';
+import type { IUserContext } from '../../../context';
+import { ICache } from './cache.helper';
+import { ICacheItem } from '../../feeds/activities-feed/cache';
+interface IPreparePollVoteArgs {
+    activity: IActivity;
+    reactionId: string;
+    user?: IUserContext;
+}
+interface IEnrichPollVoteArgs extends IPreparePollVoteArgs {
+    correctReactionId: string;
+}
+interface IRemovePollVoteArgs {
+    cache: ICache<ICacheItem>;
+    activityId: string;
+    reactionId: string;
+}
+export declare const getActivityPollOptions: (pollOption: ICacheItem, locale?: string) => IPollOption[];
+export declare function preparePollVote({ activity, reactionId, user }: IPreparePollVoteArgs): void;
+export declare function enrichPollVote({ activity, reactionId, correctReactionId, user, }: IEnrichPollVoteArgs): void;
+export declare function removePollVote({ cache, activityId, reactionId }: IRemovePollVoteArgs): ICache<IActivity>;
+export {};

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

@@ -1,13 +1,28 @@
 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;
+    title: string | {
+        [key: string]: 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,8 +1,8 @@
-import { MemberProps, MemberDetailsProps } from '../../../user';
+import type { MemberProps, MemberDetailsProps } from '../../../user';
 import type { ListMembers, ClickMentionFallback } from '../../../form';
 import type { IEnrichedUrlData } from '../../../navigation';
 import type { ICategory } from './community.category.interface';
-import type { IDiscussionFormFns } from '../../discussion';
+import type { ILikesFeedQueryFns } from '../../../discussion/feeds/likes-feed';
 export declare enum DiscussionContentType {
     Answer = "answer",
     Poll = "poll",
@@ -30,7 +30,9 @@ export interface IFullDiscussionContent extends IDiscussionContent {
     /** The content slug */
     slug: string;
     /** The title of the content post */
-    title?: string;
+    title?: string | {
+        [key: string]: string;
+    };
     /** The body of the content post */
     body?: string;
     /** The author of the post */
@@ -72,6 +74,7 @@ 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;
 }
@@ -87,6 +90,14 @@ 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;

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

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

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

@@ -1,6 +1,6 @@
 import { Dispatch } from 'react';
 import { Point } from 'slate';
-import { IListMemberData } from '../../../../../discussion';
+import type { IListMemberData } from '../../../../../discussion/shared';
 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';
+import type { IListMemberData, IMentions, IDiscussionFormFns } from '../../../discussion/shared';
 import type { MemberDetailsProps } from '../../../user';
 import type { IEnrichedUrlData } from '../../../navigation';
 interface IRTEData {

package/helpers/intl.d.ts

@@ -113,6 +113,7 @@ 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;
@@ -123,6 +124,7 @@ 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;

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

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