@apolitical/component-library 5.1.2-SW.3 → 5.1.2-SW.4

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

@@ -1,2 +1,3 @@
+export type { IDiscussionPostProps, IPostContent } from './post';
 export { default as DiscussionPost } from './post';
 export { getPostBody } from './post.helpers';

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

@@ -2,15 +2,17 @@ import React from 'react';
 import { type ListMembers, ClickMentionFallback } from '../../../form';
 import { DiscussionCreateContentFunction, DiscussionCreateLikeFunction, DiscussionDeleteLikeFunction, IForceHide, IFullDiscussionContent } from '../../discussion';
 import { IBadgesOption } from '../../../user/badges';
-interface PostContent extends IFullDiscussionContent {
+export interface IPostContent extends IFullDiscussionContent {
     /** The post body */
     postBody?: string;
+    /** Custom message to pass through to the Member component */
+    memberCustomMessage?: string;
 }
-interface Props {
+export interface IDiscussionPostProps {
     /** The element that will render around the content */
     element?: 'li' | 'div' | 'section' | 'article';
     /** Information about the content being posted */
-    content: PostContent;
+    content: IPostContent;
     /** If the user has permission to interact with the post box and content, e.g. if they're a member of the community */
     userHasPermissions?: boolean;
     /** If the user has owner permissions, e.g. if they're a community owner */
@@ -73,6 +75,8 @@ interface Props {
     styling?: {
         /** Option of whether or not to show the copy link button */
         showShareLinkButton?: boolean;
+        /** Option of whether or not to show the more menu button */
+        showMoreMenuButton?: boolean;
     };
     /** If the browser should focus on this post */
     setFocus?: boolean;
@@ -81,5 +85,5 @@ interface Props {
     /** Whether to show badges and the scope of the badge */
     badges?: IBadgesOption;
 }
-declare const Post: ({ element, content, userHasPermissions, userHasOwnerPermissions, isLoading, originalAuthorId, forceHide, functions, links, className, gtmContext, children, isTruncated, styling: { showShareLinkButton }, setFocus, isCommunity, badges, }: Props) => import("react/jsx-runtime").JSX.Element;
+declare const Post: ({ element, content, userHasPermissions, userHasOwnerPermissions, isLoading, originalAuthorId, forceHide, functions, links, className, gtmContext, children, isTruncated, styling: { showShareLinkButton, showMoreMenuButton }, setFocus, isCommunity, badges, }: IDiscussionPostProps) => import("react/jsx-runtime").JSX.Element;
 export default Post;

package/discussion/index.d.ts

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

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

@@ -1,7 +1,8 @@
 import type { FlatActivityEnriched } from 'getstream';
 export interface IActivity extends FlatActivityEnriched {
-    title: string;
     content: string;
+    feed_id?: string;
+    title: string;
     total_replies?: number;
     total_likes?: number;
 }

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

@@ -0,0 +1,84 @@
+import { MemberProps, MemberDetailsProps } from '../../../user';
+import type { ListMembers, ClickMentionFallback } from '../../../form';
+export type IDiscussionContentType = 'answer' | 'post' | 'response' | 'reply' | 'question';
+export interface IDiscussionContent {
+    /** The type of content */
+    type: IDiscussionContentType;
+    /** The slugs we're dealing with - used in functions */
+    slugs: {
+        question?: string;
+        answer?: string;
+        reply?: string;
+    };
+    /** The ID for the content */
+    slug?: string;
+}
+export interface IFullDiscussionContent extends IDiscussionContent {
+    /** The ID for the content */
+    id?: string;
+    /** The content slug */
+    slug: string;
+    /** The title of the content post */
+    title?: string;
+    /** The body of the content post */
+    body?: string;
+    /** The author of the post */
+    author: MemberProps;
+    createdAt: Date | string;
+    /** The number of likes to display */
+    likes?: number;
+    /** If the current user liked the content */
+    userLiked?: boolean;
+    peopleWhoLiked?: MemberProps[] | false;
+    /** If the content is pinned */
+    pinned?: boolean;
+    /** If the user is able to like the content (e.g. they can't like if they're not a member) */
+    canLike?: boolean;
+    /** The number of comments the post has */
+    comments?: number;
+    /** Details of users mentioned in the content */
+    mentions?: IMentions;
+    /** If the content has been edited */
+    isEdited?: boolean;
+    /** The URL to use for reporting context, etc. */
+    linkBase?: string;
+}
+export type IForceHide = {
+    /** Whether to hide the whole action bar */
+    actionBar?: boolean;
+    /** Whether to hide the comments */
+    comments?: boolean;
+    /** Whether to hide the likes */
+    likes?: boolean;
+};
+export type DiscussionCreateContentFunction = (args1: void | object, args2?: object) => void;
+export type DiscussionCreateLikeFunction = (args1: object) => void;
+export type DiscussionDeleteLikeFunction = (args: object) => void;
+export interface IMentions {
+    [key: string]: IMentionData;
+}
+export interface IMentionData {
+    /** The time the mention was created */
+    created_at: string;
+    /** The time the mention was updated */
+    updated_at: string;
+    /** The ID, matching the key */
+    id: string;
+    /** The data of the user being mentioned */
+    data: MemberDetailsProps;
+    /** An error message, shown if the user was deleted */
+    error?: string;
+}
+export interface IMentionsFns {
+    listMembers: ListMembers;
+    clickMentionFallback: ClickMentionFallback;
+}
+export interface IListMemberData {
+    id?: string;
+    name?: string;
+}
+export interface IConversation {
+    showForm: boolean;
+    prepopulateForm?: string;
+    mentionData?: IListMemberData;
+}

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

@@ -1,4 +1,5 @@
 export * from './activity.interface';
 export * from './context.interface';
+export * from './discussion.interface';
 export * from './reaction.interface';
 export * from './user.interface';