@apolitical/component-library 5.2.1-jc.4 → 5.2.1

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

@@ -3,5 +3,5 @@ import type { ICache } from '../..';
 interface IRemoveVars {
     replyId: string;
 }
-export declare function useRemoveReply({ mutationFn, mutationHandlers: { mutate: mutateWrapper, error: onError, }, }: IMutationContext<void, Error, IRemoveVars, ICache>): import("@tanstack/react-query/build/legacy/types").UseMutateFunction<void, Error, IRemoveVars, ICache>;
+export declare function useRemoveReply({ mutationFn, mutationHandlers: { mutate: mutateWrapper, error: onError }, }: IMutationContext<void, Error, IRemoveVars, ICache>): import("@tanstack/react-query/build/legacy/types").UseMutateFunction<void, Error, IRemoveVars, ICache>;
 export {};

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

@@ -4,5 +4,5 @@ interface IUnlikeVars {
     replyId: string;
     reactionId?: string;
 }
-export declare function useUnlikeReply({ mutationFn, mutationHandlers: { mutate: mutateWrapper, error: onError, }, user, }: IMutationContext<unknown, Error, IUnlikeVars, ICache>): import("@tanstack/react-query/build/legacy/types").UseMutateFunction<unknown, Error, IUnlikeVars, ICache>;
+export declare function useUnlikeReply({ mutationFn, mutationHandlers: { mutate: mutateWrapper, error: onError }, user, }: IMutationContext<unknown, Error, IUnlikeVars, ICache>): import("@tanstack/react-query/build/legacy/types").UseMutateFunction<unknown, Error, IUnlikeVars, ICache>;
 export {};

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

@@ -1,3 +1,2 @@
 export * from './hooks';
-export * from './cache.helper';
 export * from './cache.interface';

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/helpers/cache.helper.d.ts

@@ -0,0 +1,25 @@
+import { InfiniteData } from '@tanstack/query-core';
+type ICacheItemBase = {
+    id: string;
+};
+export interface ICachePage<ICacheItem extends ICacheItemBase> {
+    results: ICacheItem[];
+    next: string;
+}
+export type ICache<ICacheItem extends ICacheItemBase> = InfiniteData<ICachePage<ICacheItem>, string>;
+interface IAdditionOptions {
+    append?: boolean;
+    replace?: boolean;
+}
+export declare function buildEmptyCacheWithItem<ICacheItem>(item: ICacheItem): {
+    pages: {
+        next: string;
+        results: ICacheItem[];
+    }[];
+    pageParams: string[];
+};
+export declare function addItem<ICacheItem extends ICacheItemBase>(item: ICacheItem, cache?: ICache<ICacheItem>, opts?: IAdditionOptions): ICache<ICacheItem>;
+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[];
+export {};

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

@@ -1,3 +1,4 @@
 export * from './activity.helper';
 export * from './reply.helper';
+export * from './cache.helper';
 export { default as triggerDiscussionPostAdded } from './trigger-discussion-post-added';

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

package/general/link/link.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-interface Props {
+export interface ILinkProps {
     /** URL for link */
     href?: string | undefined;
     /** Content to rendered */
@@ -33,5 +33,5 @@ interface Props {
     /** Data attributes for the link */
     'data-before'?: string;
 }
-declare const Link: ({ href, children, fallbackElement, className, onClick, gtmContext, gtmType, ...props }: Props) => import("react/jsx-runtime").JSX.Element;
+declare const Link: ({ href, children, fallbackElement, className, onClick, gtmContext, gtmType, ...props }: ILinkProps) => import("react/jsx-runtime").JSX.Element;
 export default Link;

package/general/responsive-image/responsive-image.helpers.d.ts

@@ -33,7 +33,7 @@ export namespace IMAGE_ASPECTS {
         let sizes_3: string;
         export { sizes_3 as sizes };
     }
-    namespace fallback {
+    namespace highlightSection {
         let range_4: {
             height: number;
             width: number;
@@ -51,6 +51,15 @@ export namespace IMAGE_ASPECTS {
         let sizes_5: string;
         export { sizes_5 as sizes };
     }
+    namespace fallback {
+        let range_6: {
+            height: number;
+            width: number;
+        }[];
+        export { range_6 as range };
+        let sizes_6: string;
+        export { sizes_6 as sizes };
+    }
 }
 export function buildSourceParameters({ aspect: customAspect, range: customRange, sizes: customSizes, }: {
     aspect: any;

package/helpers/intl.d.ts

@@ -154,7 +154,7 @@ export declare const checkIntlPathExists: (path: string, language?: {
     discussion_form_explainer_question: string;
     discussion_likes: string;
     discussion_likes_short: string;
-    discussion_likes_more: string;
+    discussion_likes_showAll: string;
     discussion_likes_like: string;
     discussion_likes_unlike: string;
     discussion_likes_show: string;