@apolitical/component-library 1.8.0 → 1.8.1-beta.0

package/context/index.d.ts

@@ -1,2 +1,3 @@
 export * from './intl';
 export * from './user';
+export * from './react-query';

package/context/react-query/index.d.ts

@@ -0,0 +1 @@
+export * from './react-query.provider';

package/context/react-query/react-query.provider.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+interface Props {
+    showDevTools: boolean;
+    children: React.ReactNode;
+}
+export declare const ReactQueryProvider: React.FC<Props>;
+export {};

package/context/user/user.context.d.ts

@@ -5,6 +5,8 @@ export interface IUserDetails {
     image?: {
         thumbnail?: string;
     };
+    organization?: string;
+    jobTitle?: string;
 }
 export interface IUserContext extends IUserDetails {
     isLoading: boolean;

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

@@ -0,0 +1,16 @@
+/// <reference types="react" />
+import { UseMutateFunction } from '@tanstack/react-query';
+import { IDiscussionContentType } from '../../discussion';
+interface Props {
+    membershipRequiredToPost: {
+        required: boolean;
+        isMember?: boolean;
+        join?: () => Promise<void>;
+        leave?: () => Promise<void>;
+        notMemberStateText?: string;
+    };
+    contentType: IDiscussionContentType;
+    createPost: UseMutateFunction<any, any, any, any>;
+}
+declare const AddPost: React.FC<Props>;
+export default AddPost;

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

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

package/discussion/{form → components/form}/form.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-import { DiscussionCreateContentFunction, IDiscussionContent } from './../discussion';
+import { DiscussionCreateContentFunction, IDiscussionContent } from './../../discussion';
 interface Props {
     /** Information about the content being created/edited */
     content: IDiscussionContent;

package/discussion/components/index.d.ts

@@ -0,0 +1,7 @@
+export * from './add-post';
+export * from './conversation';
+export * from './form';
+export * from './likes';
+export * from './post';
+export * from './responses-heading';
+export * from './thread';

package/discussion/{likes → components/likes}/likes.d.ts

@@ -1,6 +1,6 @@
 import React from 'react';
-import { MemberProps } from '../../user';
-import { IDiscussionContent } from './../discussion';
+import { MemberProps } from '../../../user';
+import { IDiscussionContent } from './../../discussion';
 interface Props {
     /** The element to render around the content */
     element?: 'li' | 'div';
@@ -26,7 +26,7 @@ interface Props {
     /** 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, functions: { createLike, deleteLike }, }: Props) => React.DetailedReactHTMLElement<{
     className: string;
     onClick: (e: React.MouseEvent<HTMLElement>) => false | undefined;
     onMouseEnter: () => void;

package/discussion/{likes → components/likes}/likes.helpers.d.ts

@@ -1,4 +1,4 @@
-import { MemberProps } from '../../user';
+import { MemberProps } from '../../../user';
 export declare const createSlugsPayload: ({ question, answer, reply, }: {
     question?: string | undefined;
     answer?: string | undefined;

package/discussion/{post → components/post}/post.d.ts

@@ -1,12 +1,10 @@
 import React from 'react';
-import { DiscussionCreateContentFunction, DiscussionCreateLikeFunction, DiscussionDeleteLikeFunction, IFullDiscussionContent } from './../discussion';
+import { DiscussionCreateContentFunction, DiscussionCreateLikeFunction, DiscussionDeleteLikeFunction, IFullDiscussionContent } from '../../discussion';
 interface Props {
     /** The element that will render around the content */
     element?: 'li' | 'div' | 'section' | 'article';
     /** Information about the content being posted */
     content: IFullDiscussionContent;
-    /** 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 post is still loading */
     isLoading?: boolean;
     /** The ID of the original post author, for threads */
@@ -46,5 +44,5 @@ interface Props {
     /** The language for the text */
     locale?: string;
 }
-declare const Post: ({ element, content, userHasPermissions, isLoading, originalAuthorId, functions: { content: { createContent, deleteContent, updateContent }, likes: { createLike, deleteLike }, comments: { openComments }, }, links, className, gtmContext, children, }: Props) => import("react/jsx-runtime").JSX.Element;
+declare const Post: ({ element, content, isLoading, originalAuthorId, functions: { content: { createContent, deleteContent, updateContent }, likes: { createLike, deleteLike }, comments: { openComments }, }, links, className, gtmContext, locale, children, }: Props) => import("react/jsx-runtime").JSX.Element;
 export default Post;

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

@@ -0,0 +1,24 @@
+/// <reference types="react" />
+import { InvalidateQueryFilters, QueryFunction } from '@tanstack/react-query';
+interface Props {
+    basePath: string;
+    parentId: string;
+    membershipRequiredToPost: {
+        isMember: boolean;
+        join: () => Promise<void>;
+        leave: () => Promise<void>;
+    };
+    functions: {
+        list: QueryFunction<unknown, InvalidateQueryFilters[], never>;
+        create: () => Promise<void>;
+        like: ({ activityId }: {
+            activityId: string;
+        }) => Promise<void>;
+        unlike: ({ activityId, reactionId, }: {
+            activityId: string;
+            reactionId: string;
+        }) => Promise<void>;
+    };
+}
+declare const ActivitiesFeed: React.FC<Props>;
+export default ActivitiesFeed;

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

@@ -0,0 +1,28 @@
+import { QueryClient, QueryKey } from '@tanstack/query-core';
+import { IUserContext } from '../../..';
+export interface buildAddActivityHandlersProps {
+    queryClient: QueryClient;
+    queryKey: QueryKey;
+    user: IUserContext | null;
+    mutationFn: () => Promise<void>;
+}
+export declare const buildAddActivityHandlers: ({ queryClient, queryKey, user, mutationFn, }: buildAddActivityHandlersProps) => object;
+interface buildLikeActivityHandlersProps {
+    queryClient: QueryClient;
+    queryKey: QueryKey;
+    mutationFn: ({ activityId }: {
+        activityId: string;
+    }) => Promise<void>;
+}
+export declare const buildLikeActivityHandlers: ({ queryClient, queryKey, mutationFn, }: buildLikeActivityHandlersProps) => object;
+interface buildUnlikeActivityHandlersProps {
+    queryClient: QueryClient;
+    queryKey: QueryKey;
+    user: IUserContext | null;
+    mutationFn: ({ activityId, reactionId, }: {
+        activityId: string;
+        reactionId: string;
+    }) => Promise<void>;
+}
+export declare const buildUnlikeActivityHandlers: ({ queryClient, queryKey, user, mutationFn, }: buildUnlikeActivityHandlersProps) => object;
+export {};

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

@@ -0,0 +1,23 @@
+import { IUserDetails } from '../../../context';
+export declare const createActivityObject: ({ user, content, verb, }: {
+    user: IUserDetails;
+    content: string;
+    verb: string;
+}) => {
+    actor: {
+        id: string | undefined;
+        data: {
+            name: string | undefined;
+            organization: string | undefined;
+            jobTitle: string | undefined;
+        };
+    };
+    content: string;
+    latest_reactions: {
+        like: never[];
+    };
+    reaction_counts: {
+        like: number;
+    };
+    verb: string;
+};

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

@@ -0,0 +1,318 @@
+export declare const activitiesFeedMock: ({
+    actor: {
+        created_at: string;
+        updated_at: string;
+        id: string;
+        data: {
+            jobTitle: string;
+            name: string;
+            organization: string;
+            thumbnail: null;
+        };
+    };
+    content: string;
+    feed_id: string;
+    foreign_id: string;
+    id: string;
+    latest_reactions: {
+        like: {
+            created_at: string;
+            updated_at: string;
+            id: string;
+            user_id: string;
+            user: {
+                created_at: string;
+                updated_at: string;
+                id: string;
+                data: {
+                    name: string;
+                };
+            };
+            kind: string;
+            activity_id: string;
+            data: {};
+            parent: string;
+            latest_children: {};
+            children_counts: {};
+        }[];
+        reply: {
+            created_at: string;
+            updated_at: string;
+            id: string;
+            user_id: string;
+            user: {
+                created_at: string;
+                updated_at: string;
+                id: string;
+                data: {
+                    name: string;
+                };
+            };
+            kind: string;
+            activity_id: string;
+            data: {
+                content: {
+                    text: string;
+                };
+            };
+            parent: string;
+            latest_children: {};
+            children_counts: {};
+        }[];
+    };
+    latest_reactions_extra: {
+        like: {
+            next: string;
+        };
+        reply: {
+            next: string;
+        };
+    };
+    object: string;
+    origin: null;
+    own_reactions: {
+        like: {
+            created_at: string;
+            updated_at: string;
+            id: string;
+            user_id: string;
+            user: {
+                created_at: string;
+                updated_at: string;
+                id: string;
+                data: {
+                    name: string;
+                };
+            };
+            kind: string;
+            activity_id: string;
+            data: {};
+            parent: string;
+            latest_children: {};
+            children_counts: {};
+        }[];
+        reply: {
+            created_at: string;
+            updated_at: string;
+            id: string;
+            user_id: string;
+            user: {
+                created_at: string;
+                updated_at: string;
+                id: string;
+                data: {
+                    name: string;
+                };
+            };
+            kind: string;
+            activity_id: string;
+            data: {
+                content: {
+                    text: string;
+                };
+            };
+            parent: string;
+            latest_children: {};
+            children_counts: {};
+        }[];
+    };
+    reaction_counts: {
+        like: number;
+        reply: number;
+    };
+    target: string;
+    time: string;
+    verb: string;
+} | {
+    actor: {
+        created_at: string;
+        updated_at: string;
+        id: string;
+        data: {
+            name: string;
+            jobTitle?: undefined;
+            organization?: undefined;
+            thumbnail?: undefined;
+        };
+    };
+    content: string;
+    feed_id: string;
+    foreign_id: string;
+    id: string;
+    latest_reactions: {
+        like: {
+            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: {};
+            parent: string;
+            latest_children: {};
+            children_counts: {};
+        }[];
+        reply?: undefined;
+    };
+    latest_reactions_extra: {
+        like: {
+            next: string;
+        };
+        reply?: undefined;
+    };
+    object: string;
+    origin: null;
+    own_reactions: {
+        like?: undefined;
+        reply?: undefined;
+    };
+    reaction_counts: {
+        like: number;
+        reply?: undefined;
+    };
+    target: string;
+    time: string;
+    verb: string;
+} | {
+    actor: {
+        created_at: string;
+        updated_at: string;
+        id: string;
+        data: {
+            jobTitle: string;
+            name: string;
+            organization: string;
+            thumbnail: string;
+        };
+    };
+    content: string;
+    feed_id: string;
+    foreign_id: string;
+    id: string;
+    latest_reactions: {
+        like: ({
+            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: null;
+                };
+            };
+            kind: string;
+            activity_id: string;
+            data: {};
+            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: {
+                    name: string;
+                    jobTitle?: undefined;
+                    organization?: undefined;
+                    thumbnail?: undefined;
+                };
+            };
+            kind: string;
+            activity_id: string;
+            data: {};
+            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: {};
+            parent: string;
+            latest_children: {};
+            children_counts: {};
+        })[];
+        reply: {
+            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: {
+                content: string;
+            };
+            parent: string;
+            latest_children: {};
+            children_counts: {};
+        }[];
+    };
+    latest_reactions_extra: {
+        like: {
+            next: string;
+        };
+        reply: {
+            next: string;
+        };
+    };
+    object: string;
+    origin: null;
+    own_reactions: {
+        like?: undefined;
+        reply?: undefined;
+    };
+    reaction_counts: {
+        like: number;
+        reply: number;
+    };
+    target: string;
+    time: string;
+    verb: string;
+})[];

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

@@ -0,0 +1 @@
+export { default as ActivitiesFeed } from './activities-feed';

package/discussion/feeds/index.d.ts

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

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

@@ -0,0 +1 @@
+export { default as RepliesFeed } from './replies-feed';

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

@@ -0,0 +1,24 @@
+/// <reference types="react" />
+import { IReply } from '../../getstream';
+interface Props {
+    basePath: string;
+    parentId: string;
+    activityId: string;
+    repliesList: IReply[] | undefined;
+    membershipRequiredToPost: {
+        isMember: boolean;
+        join: () => Promise<void>;
+        leave: () => Promise<void>;
+    };
+    functions: {
+        createReply: () => Promise<void>;
+        like: ({ replyId }: {
+            replyId: string;
+        }) => Promise<void>;
+        unlike: ({ replyId }: {
+            replyId: string;
+        }) => Promise<void>;
+    };
+}
+declare const RepliesFeed: React.FC<Props>;
+export default RepliesFeed;

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

@@ -0,0 +1,81 @@
+import { QueryClient, QueryKey } from '@tanstack/query-core';
+import { IActivity, ILike, IReply } from '../../getstream';
+import { IUserContext } from '../../..';
+interface buildAddReplyHandlersProps {
+    queryClient: QueryClient;
+    queryKey: QueryKey;
+    mutationFn: () => Promise<void>;
+}
+export declare const buildAddReplyHandlers: ({ queryClient, queryKey, mutationFn, }: buildAddReplyHandlersProps) => {
+    mutationFn: () => Promise<void>;
+    onMutate: () => Promise<void>;
+    onError: (_err: {
+        [key: string]: string;
+    }, _newActivity: {
+        activityId: string;
+    }, context: {
+        previousActivity: IActivity;
+    }) => void;
+    onSuccess: (data: IReply) => {
+        previousActivity: IActivity;
+    } | undefined;
+    onSettled: () => void;
+};
+interface buildLikeReplyHandlersProps {
+    queryClient: QueryClient;
+    queryKey: QueryKey;
+    mutationFn: ({ replyId }: {
+        replyId: string;
+    }) => Promise<void>;
+}
+export declare const buildLikeReplyHandlers: ({ queryClient, queryKey, mutationFn, }: buildLikeReplyHandlersProps) => {
+    mutationFn: ({ replyId }: {
+        replyId: string;
+    }) => Promise<void>;
+    onMutate: ({ replyId }: {
+        replyId: string;
+    }) => Promise<{
+        previousActivity: IActivity | undefined;
+    }>;
+    onError: (_err: {
+        [key: string]: string;
+    }, _newActivity: {
+        activityId: string;
+    }, context: {
+        previousActivity: IActivity;
+    }) => void;
+    onSuccess: (data: ILike) => {
+        previousActivity: IActivity | undefined;
+    };
+};
+interface buildUnlikeReplyHandlersProps {
+    queryClient: QueryClient;
+    queryKey: QueryKey;
+    user: IUserContext | null;
+    mutationFn: ({ replyId }: {
+        replyId: string;
+    }) => Promise<void>;
+}
+export declare const buildUnlikeReplyHandlers: ({ queryClient, queryKey, user, mutationFn, }: buildUnlikeReplyHandlersProps) => {
+    mutationFn: ({ replyId }: {
+        replyId: string;
+    }) => Promise<void>;
+    onMutate: ({ replyId }: {
+        replyId: string;
+    }) => Promise<{
+        previousActivity: IActivity;
+    } | undefined>;
+    onError: (_err: {
+        [key: string]: string;
+    }, _newActivity: {
+        activityId: string;
+    }, context: {
+        previousActivity: IActivity;
+    }) => void;
+    onSuccess: (data: ILike, { replyId }: {
+        replyId: string;
+    }) => {
+        previousActivity: IActivity;
+    } | undefined;
+};
+export {};

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

@@ -0,0 +1,2 @@
+import { IReply } from '../../getstream';
+export declare const repliesFeedMock: IReply[];

package/discussion/index.d.ts

@@ -1,6 +1,3 @@
-export * from './conversation';
-export * from './form';
-export * from './likes';
-export * from './post';
-export * from './responses-heading';
-export * from './thread';
+export * from './components';
+export * from './feeds';
+export * from './sections';

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

@@ -0,0 +1,32 @@
+/// <reference types="react" />
+import { QueryFunction, InvalidateQueryFilters } from '@tanstack/react-query';
+import { IActivity } from '../../getstream';
+interface Props {
+    basePath: string;
+    parentId: string;
+    activityId: string;
+    membershipRequiredToPost: {
+        isMember: boolean;
+        join: () => Promise<void>;
+        leave: () => Promise<void>;
+    };
+    functions: {
+        get: QueryFunction<IActivity, InvalidateQueryFilters[], never>;
+        likeActivity: ({ activityId }: {
+            activityId: string;
+        }) => Promise<void>;
+        unlikeActivity: ({ activityId, reactionId, }: {
+            activityId: string;
+            reactionId: string | undefined;
+        }) => Promise<void>;
+        createReply: () => Promise<void>;
+        likeReply: ({ replyId }: {
+            replyId: string;
+        }) => Promise<void>;
+        unlikeReply: ({ replyId }: {
+            replyId: string;
+        }) => Promise<void>;
+    };
+}
+declare const ActivitySection: React.FC<Props>;
+export default ActivitySection;