@apolitical/component-library 4.7.5 → 4.7.7-SW.0

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

@@ -12,6 +12,8 @@ interface Props {
     content: PostContent;
     /** 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 */
+    userHasOwnerPermissions?: boolean;
     /** If the post is still loading */
     isLoading?: boolean;
     /** The ID of the original post author, for threads */
@@ -44,6 +46,12 @@ interface Props {
             /** Function to call when clicking mention fallback */
             clickMentionFallback: ClickMentionFallback;
         };
+        pins?: {
+            /** Pin the post */
+            createPin?: () => void;
+            /** Unpin the post */
+            deletePin?: () => void;
+        };
     };
     /** Optional `href`s for the card to link to */
     links?: {
@@ -70,5 +78,5 @@ interface Props {
     /** If the post is used within a community */
     isCommunity?: boolean;
 }
-declare const Post: ({ element, content, userHasPermissions, isLoading, originalAuthorId, forceHide, functions, links, className, gtmContext, children, isTruncated, styling: { showShareLinkButton }, setFocus, isCommunity, }: 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 }, setFocus, isCommunity, }: Props) => import("react/jsx-runtime").JSX.Element;
 export default Post;

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

@@ -9,6 +9,8 @@ interface Props {
     parentId: string;
     /** Whether the user is a member of the community */
     isMember: boolean;
+    /** Whether the user is an owner of the community */
+    isOwner: boolean;
     /** Functions for the activities query */
     functions: {
         /** Query functions for the activities */

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

@@ -3,5 +3,7 @@ export * from './edit';
 export * from './feed';
 export * from './like';
 export * from './list';
+export * from './pin';
 export * from './remove';
 export * from './unlike';
+export * from './unpin';

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

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

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

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

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

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

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

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

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

@@ -15,13 +15,40 @@ export declare const activitiesFeedMock: {
         feed_id: string;
         foreign_id: string;
         id: string;
-        latest_reactions: {};
+        latest_reactions: {
+            pin: {
+                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;
         origin: null;
         own_reactions: {};
         reaction_counts: {
             like: number;
+            pin: number;
         };
         target: string;
         time: string;
@@ -42,13 +69,16 @@ export declare const activitiesFeedMock: {
         feed_id: string;
         foreign_id: string;
         id: string;
-        latest_reactions: {};
+        latest_reactions: {
+            pin?: undefined;
+        };
         latest_reactions_extra: {};
         object: string;
         origin: null;
         own_reactions: {};
         reaction_counts: {
             like?: undefined;
+            pin?: undefined;
         };
         target: string;
         time: string;
@@ -68,13 +98,16 @@ export declare const activitiesFeedMock: {
         feed_id: string;
         foreign_id: string;
         id: string;
-        latest_reactions: {};
+        latest_reactions: {
+            pin?: undefined;
+        };
         latest_reactions_extra: {};
         object: string;
         origin: null;
         own_reactions: {};
         reaction_counts: {
             like?: undefined;
+            pin?: undefined;
         };
         target: string;
         time: string;

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

@@ -11,6 +11,7 @@ interface Props {
     parentId: string;
     activityId: string;
     isMember: boolean;
+    isOwner: boolean;
     functions: {
         activities: IActivitySectionQueryFns;
         reactions: IRepliesFeedQueryFns;

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

@@ -3,3 +3,5 @@ export * from './read';
 export * from './section';
 export * from './like';
 export * from './unlike';
+export * from './pin';
+export * from './unpin';

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

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

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

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

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

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

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

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

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

@@ -27,4 +27,6 @@ export declare function prepareActivity({ title, content }: IPrepareActivityArgs
 export declare function enrichActivity({ activity, user }: IEnrichActivityArgs): 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;
+export declare function decrementActivityPins({ activity }: IDecrementActivityLikesArgs): void;
 export {};

package/discussion/shared/mocks/reaction.mock.d.ts

@@ -18,3 +18,23 @@ export declare const reactionMock1: Readonly<{
         updated_at: string;
     };
 }>;
+export declare const reactionMock2: Readonly<{
+    id: "some-reaction-id-1";
+    activity_id: "some-activity-id-1";
+    kind: "pin";
+    created_at: "2023-11-24T17:58:36.162000";
+    data: {};
+    parent: "";
+    updated_at: "2023-11-24T17:58:36.162000";
+    user_id: "some-user-id-2";
+    children_counts: {};
+    latest_children: {};
+    latest_children_extra: {};
+    own_children: {};
+    user: {
+        id: "some-user-id-2";
+        data: {};
+        created_at: string;
+        updated_at: string;
+    };
+}>;

package/helpers/intl.d.ts

@@ -152,6 +152,8 @@ export declare const checkIntlPathExists: (path: string, language?: {
     discussion_likes_show: string;
     discussion_moreMenu_edit: string;
     discussion_moreMenu_delete: string;
+    discussion_moreMenu_pin: string;
+    discussion_moreMenu_unpin: string;
     discussion_moreMenu_report: string;
     discussion_comments_screenReader: string;
     discussion_comments: string;