@apolitical/component-library 5.2.0-jc.0 → 5.2.0-jc.10

package/communities/members-list/index.d.ts

@@ -1 +1,3 @@
 export { default as MembersList } from './members-list';
+export type { CommunityMemberProps } from './members-list';
+export * from './members-list.constants';

package/communities/members-list/members-list.constants.d.ts

@@ -0,0 +1 @@
+export declare const MEMBERS_PER_PAGE = 25;

package/communities/members-list/members-list.d.ts

@@ -1,6 +1,6 @@
 import { type IProfileFormProps } from '../../form';
 import { MemberDetailsProps } from '../../user';
-interface CommunityMemberProps extends MemberDetailsProps {
+export interface CommunityMemberProps extends MemberDetailsProps {
     /** Whether the user is an admin of the community or not */
     isAdmin?: boolean;
 }
@@ -23,8 +23,12 @@ interface Props {
     gtmContext?: string;
     /** The GTM event to use */
     gtmType?: string;
+    /** Whether to show the header */
+    showHeader?: boolean;
+    /** Whether to show placeholders */
+    showPlaceholders?: boolean;
     /** Additional classes */
     className?: string;
 }
-declare const MembersList: ({ members: { data, total }, communitySlug, isMember, hasNextPage, loadNextPage, profile, gtmContext, gtmType, className, }: Props) => import("react/jsx-runtime").JSX.Element | null;
+declare const MembersList: ({ members: { data, total }, communitySlug, isMember, hasNextPage, loadNextPage, profile, gtmContext, gtmType, showHeader, showPlaceholders, className, }: Props) => import("react/jsx-runtime").JSX.Element | null;
 export default MembersList;

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

@@ -0,0 +1 @@
+export * from './likes-modal';

package/discussion/components/likes/components/likes-modal/index.d.ts

@@ -0,0 +1 @@
+export { default as LikesModal } from './likes-modal';

package/discussion/components/likes/components/likes-modal/likes-modal.d.ts

@@ -0,0 +1,17 @@
+import { ILikesFeedProps, ILikesFeedQueryFns } from '../../../../../discussion/feeds';
+export interface ILikesModalProps extends ILikesFeedProps {
+    /** Whether the modal is open on page load */
+    showModal?: boolean;
+    /** Functions used inside the modal */
+    functions: {
+        likes: {
+            list: ILikesFeedQueryFns['list'];
+        };
+        /** Function to call when the modal is closed */
+        onClose?: () => void;
+    };
+    /** Additional classes */
+    className?: string;
+}
+declare const LikesModal: ({ showModal, activityId, functions: { onClose, likes: likesFns }, likeCount, className, basePath, parentId, }: ILikesModalProps) => import("react/jsx-runtime").JSX.Element;
+export default LikesModal;

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

@@ -1 +1,2 @@
 export { default as DiscussionLikes } from './likes';
+export { default as LikesModal } from './components/likes-modal/likes-modal';

package/discussion/components/likes/likes.d.ts

@@ -1,6 +1,7 @@
 import React from 'react';
-import { MemberProps } from '../../../user';
+import { IBadgesOption, MemberProps } from '../../../user';
 import { IDiscussionContent } from './../../discussion';
+import { ILikesFeedQueryFns } from '../../../discussion/feeds/likes-feed';
 interface Props {
     /** The element to render around the content */
     element?: 'li' | 'div';
@@ -16,17 +17,27 @@ interface Props {
     content?: IDiscussionContent;
     /** If the user is able to like the content */
     canLike?: boolean;
+    /** The ID of the activity */
+    activityId: string;
+    /** The base path, used for slugs */
+    basePath: string;
+    /** The ID of the parent, used for slugs */
+    parentId: string;
+    /** Whether to show badges and the scope of the badge */
+    badges: IBadgesOption | undefined;
     /** Functions to handle liking and unliking */
-    functions?: {
+    functions: {
         /** Function to create a like */
         createLike?: (args1: object) => void;
         /** Function to delete a like */
         deleteLike?: (args: object) => void;
+        /** Functions for the likes query */
+        listLikes?: ILikesFeedQueryFns['list'];
     };
     /** The language to use for the text */
     locale?: string;
 }
-declare const Likes: ({ element, likes, peopleWhoLiked, isShort, userLiked, content, canLike, functions: { createLike, deleteLike }, }: Props) => React.DetailedReactHTMLElement<{
+declare const Likes: ({ element, likes, peopleWhoLiked, isShort, userLiked, content, canLike, activityId, basePath, parentId, badges, functions: { createLike, deleteLike, listLikes, }, }: Props) => React.DetailedReactHTMLElement<{
     className: string;
     onKeyDown: (e: React.KeyboardEvent<HTMLElement>) => void;
     onMouseEnter: () => void;

package/discussion/components/likes/likes.mock.d.ts

@@ -0,0 +1,2 @@
+import { MemberProps } from '../../../user';
+export declare const peopleWhoLiked: MemberProps[];

package/discussion/components/likes/mocks/index.d.ts

@@ -0,0 +1 @@
+export * from './likes-response.mock';

package/discussion/components/likes/mocks/likes-response.mock.d.ts

@@ -0,0 +1,64 @@
+export declare const likesResponseMock: {
+    results: ({
+        created_at: string;
+        updated_at: string;
+        id: string;
+        user_id: string;
+        user: {
+            id: string;
+            data: {
+                name: string;
+                thumbnail: string;
+                jobTitle: string;
+                organization: string;
+                badges: {
+                    communities: {
+                        'endor-alumni': string[];
+                    };
+                    platform?: undefined;
+                };
+            };
+            created_at?: undefined;
+            updated_at?: undefined;
+        };
+        kind: string;
+        activity_id: string;
+        data: {
+            mentioned_users: null;
+        };
+        parent: string;
+        latest_children: {};
+        children_counts: {};
+    } | {
+        created_at: string;
+        updated_at: string;
+        id: string;
+        user_id: string;
+        user: {
+            created_at: string;
+            updated_at: string;
+            id: string;
+            data: {
+                jobTitle: string;
+                name: string;
+                organization: string;
+                thumbnail: string;
+                badges: {
+                    platform: {
+                        all: string[];
+                    };
+                    communities?: undefined;
+                };
+            };
+        };
+        kind: string;
+        activity_id: string;
+        data: {
+            mentioned_users: null;
+        };
+        parent: string;
+        latest_children: {};
+        children_counts: {};
+    })[];
+    next: string;
+};

package/discussion/components/likes/tooltip.hook.d.ts

@@ -0,0 +1,5 @@
+import { Dispatch } from 'react';
+export declare function useOnTooltipKeyDown(dispatch: Dispatch<{
+    type: 'tabbableLink';
+    value: number;
+}[]>): (e: React.KeyboardEvent<HTMLElement> | undefined) => void;

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

@@ -1,16 +1,19 @@
 import React from 'react';
-import { type ListMembers, ClickMentionFallback } from '../../../form';
-import { DiscussionCreateContentFunction, DiscussionCreateLikeFunction, DiscussionDeleteLikeFunction, IForceHide, IFullDiscussionContent } from '../../discussion';
+import { ClickMentionFallback, type ListMembers } from '../../../form';
+import { DiscussionCreateContentFunction, DiscussionCreateLikeFunction, DiscussionDeleteLikeFunction, DiscussionListLikesFunction } from '../../discussion';
+import type { IForceHide, IFullDiscussionContent } from '../../shared/interfaces';
 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 */
@@ -36,6 +39,8 @@ interface Props {
             createLike: DiscussionCreateLikeFunction;
             /** Delete a like on the post */
             deleteLike: DiscussionDeleteLikeFunction;
+            /** List the likes on the post */
+            listLikes: DiscussionListLikesFunction;
         };
         comments: {
             /** Open comments on a post */
@@ -73,6 +78,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;
@@ -80,6 +87,10 @@ interface Props {
     isCommunity?: boolean;
     /** Whether to show badges and the scope of the badge */
     badges?: IBadgesOption;
+    /** The base path, used for slugs */
+    basePath: string;
+    /** 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, 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, basePath, parentId, }: IDiscussionPostProps) => import("react/jsx-runtime").JSX.Element;
 export default Post;

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

@@ -9,6 +9,70 @@ declare namespace _default {
         namespace likes {
             function createLike(): void;
             function deleteLike(): void;
+            function listLikes(): Promise<{
+                results: ({
+                    created_at: string;
+                    updated_at: string;
+                    id: string;
+                    user_id: string;
+                    user: {
+                        id: string;
+                        data: {
+                            name: string;
+                            thumbnail: string;
+                            jobTitle: string;
+                            organization: string;
+                            badges: {
+                                communities: {
+                                    'endor-alumni': string[];
+                                };
+                                platform?: undefined;
+                            };
+                        };
+                        created_at?: undefined;
+                        updated_at?: undefined;
+                    };
+                    kind: string;
+                    activity_id: string;
+                    data: {
+                        mentioned_users: null;
+                    };
+                    parent: string;
+                    latest_children: {};
+                    children_counts: {};
+                } | {
+                    created_at: string;
+                    updated_at: string;
+                    id: string;
+                    user_id: string;
+                    user: {
+                        created_at: string;
+                        updated_at: string;
+                        id: string;
+                        data: {
+                            jobTitle: string;
+                            name: string;
+                            organization: string;
+                            thumbnail: string;
+                            badges: {
+                                platform: {
+                                    all: string[];
+                                };
+                                communities?: undefined;
+                            };
+                        };
+                    };
+                    kind: string;
+                    activity_id: string;
+                    data: {
+                        mentioned_users: null;
+                    };
+                    parent: string;
+                    latest_children: {};
+                    children_counts: {};
+                })[];
+                next: string;
+            }>;
         }
         namespace comments {
             function openComments(): void;

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

@@ -2,6 +2,7 @@
 import { type IProfileFormProps } from '../../../form';
 import type { IMentionsFns } from '../../../discussion/discussion.d';
 import type { IQueryFns } from './cache';
+import type { ILikesFeedQueryFns } from '../../../discussion/feeds/likes-feed';
 interface Props {
     /** The base path, used for slugs */
     basePath: string;
@@ -21,6 +22,7 @@ interface Props {
         join: () => Promise<void>;
         /** Function to leave the community */
         leave: () => Promise<void>;
+        likes: ILikesFeedQueryFns;
     };
     /** Props to pass into the profile form */
     profile: IProfileFormProps;

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

@@ -0,0 +1,5 @@
+import type { ICache, ICacheItem, ICacheItems } from './cache.interface';
+export declare function addItem(item: ICacheItem, cache?: ICache, replace?: boolean): ICache;
+export declare function findItem(itemId: string, cache?: ICache): import("../../..").IActivity | undefined;
+export declare function removeItem(itemId: string, cache: ICache): ICache;
+export declare function flattenCache(cache?: ICache): ICacheItems;

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

@@ -46,6 +46,55 @@ export declare const activitiesFeedMock: {
                 latest_children: {};
                 children_counts: {};
             }[];
+            like: ({
+                created_at: string;
+                updated_at: string;
+                id: string;
+                user_id: string;
+                user: {
+                    id: string;
+                    data: {
+                        name: string;
+                        thumbnail: string;
+                        jobTitle: string;
+                        organization: string;
+                    };
+                    created_at?: undefined;
+                    updated_at?: undefined;
+                };
+                kind: string;
+                activity_id: string;
+                data: {
+                    mentioned_users: null;
+                };
+                parent: string;
+                latest_children: {};
+                children_counts: {};
+            } | {
+                created_at: string;
+                updated_at: string;
+                id: string;
+                user_id: string;
+                user: {
+                    created_at: string;
+                    updated_at: string;
+                    id: string;
+                    data: {
+                        jobTitle: string;
+                        name: string;
+                        organization: string;
+                        thumbnail: string;
+                    };
+                };
+                kind: string;
+                activity_id: string;
+                data: {
+                    mentioned_users: null;
+                };
+                parent: string;
+                latest_children: {};
+                children_counts: {};
+            })[];
         };
         latest_reactions_extra: {};
         object: string;
@@ -81,6 +130,7 @@ export declare const activitiesFeedMock: {
         id: string;
         latest_reactions: {
             pin?: undefined;
+            like?: undefined;
         };
         latest_reactions_extra: {};
         object: string;
@@ -110,6 +160,29 @@ export declare const activitiesFeedMock: {
         foreign_id: string;
         id: string;
         latest_reactions: {
+            like: {
+                created_at: string;
+                updated_at: string;
+                id: string;
+                user_id: string;
+                user: {
+                    id: string;
+                    data: {
+                        name: string;
+                        thumbnail: string;
+                        jobTitle: string;
+                        organization: string;
+                    };
+                };
+                kind: string;
+                activity_id: string;
+                data: {
+                    mentioned_users: null;
+                };
+                parent: string;
+                latest_children: {};
+                children_counts: {};
+            }[];
             pin?: undefined;
         };
         latest_reactions_extra: {};
@@ -117,7 +190,7 @@ export declare const activitiesFeedMock: {
         origin: null;
         own_reactions: {};
         reaction_counts: {
-            like?: undefined;
+            like: number;
             pin?: undefined;
         };
         target: string;
@@ -143,6 +216,7 @@ export declare const activitiesFeedMock: {
         id: string;
         latest_reactions: {
             pin?: undefined;
+            like?: undefined;
         };
         latest_reactions_extra: {};
         object: string;

package/discussion/feeds/index.d.ts

@@ -1,2 +1,3 @@
 export * from './activities-feed';
 export * from './replies-feed';
+export * from './likes-feed';

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

@@ -15,6 +15,6 @@ export declare function useLikesFeed({ queryFns: { list }, queryKey }: ILikesFee
     hasNextPage: boolean;
     fetchNextPage: (options?: import("@tanstack/query-core/build/legacy/queryClient-13f81fcb").a2 | undefined) => Promise<import("@tanstack/query-core/build/legacy/queryClient-13f81fcb").aj<import("../..").ICache, Error>>;
     refetch: (options?: import("@tanstack/query-core/build/legacy/queryClient-13f81fcb").Z | undefined) => Promise<import("@tanstack/query-core/build/legacy/queryClient-13f81fcb").ac<import("../..").ICache, Error>>;
-    likes: import("../../../../../shared").IReaction[];
+    likes: import("../../../../..").IReaction[];
 };
 export {};

package/discussion/feeds/likes-feed/index.d.ts

@@ -1,2 +1,3 @@
 export type { IQueryFns as ILikesFeedQueryFns } from './cache';
 export { default as LikesFeed } from './likes-feed';
+export type { ILikesFeedProps } from './likes-feed';

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

@@ -1,20 +1,16 @@
-import { IQueryFns } from '../../../discussion/feeds/likes-feed/cache';
-import { type IBadgesOption } from '../../../user';
-interface Props {
-    /** Whether to show badges and the scope of the badge */
-    badges?: IBadgesOption;
+import { IQueryFns } from './cache';
+export interface ILikesFeedProps {
     /** The base path, used for slugs */
     basePath: string;
     /** The ID of the parent, used for slugs */
     parentId: string;
     /** The ID of the activity the replies are for */
     activityId: string;
-    /** The initial number of likes */
-    initialLikeCount: number;
+    /** The total number of likes */
+    likeCount: number;
     /** Functions for the replies query */
     functions: {
         likes: IQueryFns;
     };
 }
-export default function LikesFeed({ badges, basePath, parentId, activityId, initialLikeCount, functions, }: Props): import("react/jsx-runtime").JSX.Element;
-export {};
+export default function LikesFeed({ basePath, parentId, activityId, likeCount, functions, }: ILikesFeedProps): import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,16 @@
+import type { ICache, ICacheItem, ICacheItems } from './cache.interface';
+interface IAdditionOptions {
+    append?: boolean;
+    replace?: boolean;
+}
+export declare function addItem(item: ICacheItem, cache?: ICache, opts?: IAdditionOptions): {
+    pages: {
+        next: string;
+        results: import("../../..").IReaction[];
+    }[];
+    pageParams: string[];
+};
+export declare function findItem(itemId: string, cache?: ICache): import("../../..").IReaction | undefined;
+export declare function removeItem(itemId: string, cache: ICache): ICache;
+export declare function flattenCache(cache?: ICache): ICacheItems;
+export {};

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

@@ -1,7 +1,13 @@
 /// <reference types="react" />
 import type { IMentionsFns } from '../../../../discussion/discussion.d';
 import type { IQueryFns } from './../cache';
-interface NestedRepliesFunctions extends IQueryFns, IMentionsFns {
+import { ILikesFeedQueryFns } from '../../../../discussion/feeds/likes-feed';
+interface NestedRepliesFunctions {
+    /** Functions for the replies query */
+    reactions: IQueryFns;
+    mentions: IMentionsFns;
+    /** Functions for the likes query */
+    likes: ILikesFeedQueryFns;
 }
 interface Props {
     /** The base path, used for slugs */

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

@@ -2,6 +2,19 @@
 import { type IProfileFormProps } from '../../../form';
 import type { IMentionsFns } from './../../discussion';
 import { type IQueryFns } from './cache';
+import { ILikesFeedQueryFns } from '../../../discussion/feeds/likes-feed';
+interface RepliesFunctions {
+    /** Functions for the replies query */
+    reactions: IQueryFns;
+    /** Functions for the likes query */
+    likes: ILikesFeedQueryFns;
+    /** Query functions for the mentions */
+    mentions: IMentionsFns;
+    /** Function to join the community */
+    join: () => Promise<void>;
+    /** Function to leave the community */
+    leave: () => Promise<void>;
+}
 interface Props {
     /** The base path, used for slugs */
     basePath: string;
@@ -14,16 +27,7 @@ interface Props {
     /** Whether the user is a member of the community */
     isMember: boolean;
     /** Functions for the replies query */
-    functions: {
-        /** Query functions for the replies */
-        reactions: IQueryFns;
-        /** Query functions for the mentions */
-        mentions: IMentionsFns;
-        /** Function to join the community */
-        join: () => Promise<void>;
-        /** Function to leave the community */
-        leave: () => Promise<void>;
-    };
+    functions: RepliesFunctions;
     /** Props to pass into the profile form */
     profile: IProfileFormProps;
 }

package/discussion/index.d.ts

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

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

@@ -3,6 +3,7 @@ import { type IProfileFormProps } from '../../../form';
 import { type IRepliesFeedQueryFns } from '../../../discussion/feeds';
 import type { IMentionsFns } from './../../discussion.d';
 import { type IQueryFns } from './cache';
+import type { ILikesFeedQueryFns } from '../../../discussion/feeds/likes-feed';
 interface IActivitySectionQueryFns extends IQueryFns {
     remove: () => Promise<void>;
 }
@@ -15,6 +16,7 @@ export interface IActivitySectionProps {
     functions: {
         activities: IActivitySectionQueryFns;
         reactions: IRepliesFeedQueryFns;
+        likes: ILikesFeedQueryFns;
         mentions: IMentionsFns;
         join: () => Promise<void>;
         leave: () => Promise<void>;

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

@@ -5,7 +5,7 @@ export interface IReadActivityArgs {
     queryKey: QueryKey;
 }
 export declare function useReadActivity({ queryFn, queryKey }: IReadActivityArgs): {
-    activity: import("../../../../../shared").IActivity | undefined;
+    activity: import("../../../../..").IActivity | undefined;
     error: Error | null;
     isLoading: boolean;
     isFetching: boolean;

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;
 }