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

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

@@ -1,6 +1,6 @@
 /// <reference types="react" />
 import type { IDiscussionForm } from '../../../discussion/components/form';
-import { ICategory } from '../../shared';
+import { type ICategory } from '../../shared';
 interface Props {
     /** Whether the form should be displayed as a card */
     isCard?: boolean;
@@ -23,6 +23,8 @@ interface Props {
         /** The text to show when the user is not a member of the community */
         notMemberStateText?: string;
     };
+    /** The locale of the page */
+    locale?: string;
 }
 declare const AddPost: React.FC<Props>;
 export default AddPost;

package/discussion/feeds/activities-feed/cache/hooks/create-poll/create-poll.hook.d.ts

@@ -0,0 +1,24 @@
+import type { IMutationContext } from '../../../../../../discussion/shared';
+import type { ICache, ICacheItem } from '../..';
+import { ResultsVisibility } from '../../../../../../polls';
+interface ICreatePollVars {
+    title: {
+        [key: string]: string;
+    };
+    options: {
+        position: number;
+        description: {
+            [key: string]: string;
+        };
+    }[];
+    settings: {
+        show_remove_vote?: boolean;
+        allow_multiple_votes?: boolean;
+        deadline_at?: string;
+        hide_participants?: boolean;
+        number_of_winners?: number;
+        results_visibility?: ResultsVisibility;
+    };
+}
+export declare function useCreatePoll({ mutationFn, mutationHandlers: { mutate: mutateWrapper, error: onError }, queryClient, queryKey, user, }: IMutationContext<ICacheItem, Error, ICreatePollVars, ICache>): import("@tanstack/react-query/build/legacy/types").UseMutateFunction<import('../../../../../../discussion/shared').IActivity, Error, ICreatePollVars, ICache>;
+export {};

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

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

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

@@ -1,4 +1,5 @@
 export * from './create';
+export * from './create-poll';
 export * from './create-vote';
 export * from './edit';
 export * from './feed';

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

@@ -20,9 +20,12 @@ export interface IActivitySectionProps {
         form: IDiscussionFormFns;
         join: () => Promise<void>;
         leave: () => Promise<void>;
+        polls: IQueryFns;
     };
     profile: IProfileFormProps;
     categories?: ICategory[];
+    /** The locale of the page */
+    locale?: string;
 }
 declare const ActivitySection: React.FC<IActivitySectionProps>;
 export default ActivitySection;

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

@@ -1,2 +1,2 @@
-import type { ReactionsRecords, DefaultGenerics } from 'getstream';
-export declare function checkIfUserHasVoted(activityType: string, latestReactions: ReactionsRecords<DefaultGenerics> | undefined): boolean;
+import { IActivity } from '../../shared';
+export declare function hasUserVoted(activity: IActivity): boolean;

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

@@ -0,0 +1,7 @@
+import type { IMutationContext } from '../../../../../../discussion/shared';
+import type { ICache, ICacheSubitem } from '../..';
+interface ICreateVoteVars {
+    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, import('../../../../../../discussion/shared').IActivity>;
+export {};

package/discussion/sections/activity-section/cache/hooks/create-vote/index.d.ts

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

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

@@ -1,7 +1,9 @@
+export * from './create-vote';
 export * from './edit';
+export * from './like';
+export * from './pin';
 export * from './read';
+export * from './remove-vote';
 export * from './section';
-export * from './like';
 export * from './unlike';
-export * from './pin';
 export * from './unpin';

package/discussion/sections/activity-section/cache/hooks/remove-vote/index.d.ts

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

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

@@ -0,0 +1,7 @@
+import type { IMutationContext } from '../../../../../../discussion/shared';
+import type { ICache } from '../..';
+interface IRemoveVoteVars {
+    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, import('../../../../../../discussion/shared').IActivity>;
+export {};

package/discussion/sections/activity-section/mocks/activity-functions.mock.d.ts

@@ -28,6 +28,11 @@ export declare const mockFunctions: {
         listMembers: jest.Mock<any, any, any>;
         clickMentionFallback: jest.Mock<any, any, any>;
     };
+    polls: {
+        createVote: jest.Mock<any, any, any>;
+        removeVote: jest.Mock<any, any, any>;
+        removePoll: jest.Mock<any, any, any>;
+    };
     join: jest.Mock<any, any, any>;
     leave: jest.Mock<any, any, any>;
 };

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

@@ -1,14 +1,47 @@
 import type { IUserContext } from '../../../context';
 import type { IActivity, IReaction } from '..';
+import { ActivityType } from '../../../discussion/shared';
+import { ResultsVisibility } from '../../../polls';
 interface IPrepareActivityArgs {
     title?: string;
     content?: string;
     categories?: string;
 }
+interface IPreparePollActivityArgs {
+    title?: {
+        [key: string]: string;
+    };
+    options: {
+        position: number;
+        description: {
+            [key: string]: string;
+        };
+    }[];
+    settings: {
+        show_remove_vote?: boolean;
+        allow_multiple_votes?: boolean;
+        deadline_at?: string;
+        hide_participants?: boolean;
+        number_of_winners?: number;
+        results_visibility?: ResultsVisibility;
+    };
+    user: IUserContext;
+    correctActivityId?: string;
+}
 interface IEnrichActivityArgs {
     activity: IActivity | Partial<IActivity>;
     user: IUserContext;
 }
+interface IEnrichPollActivityArgs {
+    activity: IActivity | Partial<IActivity>;
+    options: {
+        position: number;
+        description: {
+            [key: string]: string;
+        };
+    }[];
+    user: IUserContext;
+}
 interface IIncrementActivityLikesArgs {
     activity: IActivity;
     reaction?: IReaction;
@@ -24,9 +57,19 @@ export declare function prepareActivity({ title, content, categories }: IPrepare
     categories: string[];
     id: string;
     time: string;
-    verb: string;
+    verb: ActivityType;
+};
+export declare function preparePollActivity({ title, options, settings, user, correctActivityId, }: IPreparePollActivityArgs): {
+    title: {
+        [key: string]: string;
+    } | undefined;
+    content: string;
+    id: string;
+    time: string;
+    verb: ActivityType;
 };
 export declare function enrichActivity({ activity, user }: IEnrichActivityArgs): IActivity;
+export declare function enrichPollActivity({ activity, options, user }: IEnrichPollActivityArgs): IActivity;
 export declare function incrementActivityLikes({ activity, reaction, }: IIncrementActivityLikesArgs): void;
 export declare function decrementActivityLikes({ activity, user }: IDecrementActivityLikesArgs): void;
 export declare function incrementActivityPins({ activity, reaction, }: IIncrementActivityLikesArgs): void;

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

@@ -18,7 +18,13 @@ export declare function buildEmptyCacheWithItem<ICacheItem>(item: ICacheItem): {
     }[];
     pageParams: string[];
 };
-export declare function addItem<ICacheItem extends ICacheItemBase>(item: ICacheItem, cache?: ICache<ICacheItem>, opts?: IAdditionOptions): ICache<ICacheItem>;
+export declare function addItem<ICacheItem extends ICacheItemBase>(item: ICacheItem, cache?: ICache<ICacheItem>, opts?: IAdditionOptions): {
+    pages: {
+        next: string;
+        results: ICacheItem[];
+    }[];
+    pageParams: string[];
+};
 export declare function findItem<ICacheItem extends ICacheItemBase>(itemId: string, cache?: ICache<ICacheItem>): ICacheItem | undefined;
 export declare function removeItem<ICacheItem extends ICacheItemBase>(itemId: string, cache: ICache<ICacheItem>): ICache<ICacheItem>;
 export declare function flattenCache<ICacheItem extends ICacheItemBase>(cache?: ICache<ICacheItem>): ICacheItem[];

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

@@ -1,23 +1,46 @@
 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 IPreparePollOptionArgs {
+    position: number;
+    description: {
+        [key: string]: string;
+    };
+    user?: IUserContext;
+}
+interface IEnrichPollArgs {
+    activity: IActivity;
+    activityId: string;
+}
 interface IEnrichPollVoteArgs extends IPreparePollVoteArgs {
     correctReactionId: string;
 }
 interface IRemovePollVoteArgs {
-    cache: ICache<ICacheItem>;
-    activityId: string;
+    activity: IActivity;
     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 declare function removePollVote({ activity, reactionId }: IRemovePollVoteArgs): void;
+export declare function enrichPoll({ activity, activityId }: IEnrichPollArgs): void;
+export declare function preparePollOption({ position, description }: IPreparePollOptionArgs, user?: IUserContext): {
+    created_at: string;
+    updated_at: string;
+    id: string;
+    kind: string;
+    data: {
+        description: {
+            [key: string]: string;
+        };
+        position: number;
+    };
+    parent: string;
+} | undefined;
 export {};

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

@@ -1,15 +1,19 @@
+import { IUserContext } from '../../../context';
 export declare function buildEmptyReactionsForActivity(): {
     latest_reactions: {
         like: never[];
         reply: never[];
+        'poll-option': never[];
     };
     reaction_counts: {
         like: number;
         reply: number;
+        'poll-option': number;
     };
     own_reactions: {
         like: never[];
         reply: never[];
+        'poll-option': never[];
     };
 };
 export declare function buildEmptyReactionsForReply(): {
@@ -26,3 +30,37 @@ export declare function buildEmptyReactionsForReply(): {
         reply: never[];
     };
 };
+export declare function buildReactionsForPollActivity(options: {
+    position: number;
+    description: {
+        [key: string]: string;
+    };
+}[], user: IUserContext): {
+    latest_reactions: {
+        like: never[];
+        reply: never[];
+        'poll-option': ({
+            created_at: string;
+            updated_at: string;
+            id: string;
+            kind: string;
+            data: {
+                description: {
+                    [key: string]: string;
+                };
+                position: number;
+            };
+            parent: string;
+        } | undefined)[];
+    };
+    reaction_counts: {
+        like: number;
+        reply: number;
+        'poll-option': number;
+    };
+    own_reactions: {
+        like: never[];
+        reply: never[];
+        'poll-option': never[];
+    };
+};