@apolitical/component-library 5.0.0-4749.1 → 5.0.1

package/cards/card-block/card-block.d.ts

@@ -1,5 +1,5 @@
 import { CardType, CardContentType, BuildCardDataType } from '../../cards/cards.types';
-interface Props {
+export interface ICardBlockProps {
     /** The card data, from Contentful */
     cards: CardType[];
     /** The types for each card, from Contentful */
@@ -12,5 +12,5 @@ interface Props {
     className?: string;
     focusCardIndex?: number;
 }
-declare const CardBlock: ({ cards, cardTypes, className, ...props }: Props) => import("react/jsx-runtime").JSX.Element;
+declare const CardBlock: ({ cards, cardTypes, className, ...props }: ICardBlockProps) => import("react/jsx-runtime").JSX.Element;
 export default CardBlock;

package/cards/card-block/index.d.ts

@@ -1 +1,2 @@
+export type { ICardBlockProps } from './card-block';
 export { default as CardBlock } from './card-block';

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

@@ -10,6 +10,7 @@ interface Props {
         data: CommunityMemberProps[];
         total?: number;
     };
+    communitySlug?: string;
     /** Whether the user is a member of the community */
     isMember?: boolean;
     /** Whether there is another page of members to load */
@@ -25,5 +26,5 @@ interface Props {
     /** Additional classes */
     className?: string;
 }
-declare const MembersList: ({ members: { data, total }, 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, className, }: Props) => import("react/jsx-runtime").JSX.Element | null;
 export default MembersList;

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

@@ -1,6 +1,23 @@
 declare const _default: {
     members: {
         data: ({
+            id: string;
+            name: string;
+            jobTitle: string;
+            organization: string;
+            badges: {
+                communities: {
+                    playground: string[];
+                };
+            };
+            location: {
+                country: string;
+            };
+            image: {
+                thumbnail: string;
+            };
+            isAdmin: boolean;
+        } | {
             id: string;
             name: string;
             jobTitle: string;
@@ -12,6 +29,7 @@ declare const _default: {
                 thumbnail: string;
             };
             isAdmin: boolean;
+            badges?: undefined;
         } | {
             id: string;
             name: string;
@@ -23,6 +41,7 @@ declare const _default: {
             image: {
                 thumbnail: string;
             };
+            badges?: undefined;
             isAdmin?: undefined;
         } | {
             id: string;
@@ -32,6 +51,7 @@ declare const _default: {
             location: {
                 country: string;
             };
+            badges?: undefined;
             image?: undefined;
             isAdmin?: undefined;
         })[];
@@ -41,6 +61,7 @@ declare const _default: {
         length: number;
         limit: number;
     };
+    communitySlug: string;
     profile: {
         hooks: {
             useMaps: () => {

package/context/badges/badges.context.d.ts

@@ -0,0 +1,13 @@
+/// <reference types="react" />
+export interface IBadge {
+    name: string;
+    slug: string;
+    description?: string;
+    icon?: string;
+    colour?: 'Grey' | 'Blue' | 'Green' | 'Pink' | 'Purple' | 'Orange';
+}
+export interface IBadgesContext {
+    badges: IBadge[];
+    isLoading: boolean;
+}
+export declare const BadgesContext: import("react").Context<IBadgesContext>;

package/context/badges/badges.hook.d.ts

@@ -0,0 +1 @@
+export declare function useBadges(): import("./badges.context").IBadgesContext;

package/context/badges/badges.provider.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import type { IBadgesContext } from './badges.context';
+interface Props {
+    children: React.ReactNode;
+    badges: IBadgesContext;
+}
+export declare const BadgesProvider: ({ children, badges }: Props) => import("react/jsx-runtime").JSX.Element;
+export {};

package/context/badges/index.d.ts

@@ -0,0 +1,4 @@
+export type { IBadge, IBadgesContext } from './badges.context';
+export * from './badges.context';
+export * from './badges.hook';
+export * from './badges.provider';

package/context/global/global.providers.d.ts

@@ -2,7 +2,7 @@ import React from 'react';
 import { type IIntlContext } from '../intl';
 import { type IUserContext } from '../user';
 interface Props {
-    bootstrap: () => Promise<IUserContext>;
+    bootstrap: () => Promise<IUserContext | any[]>;
     children: React.ReactNode;
     intl?: IIntlContext;
     showDevTools?: boolean;

package/context/index.d.ts

@@ -1,3 +1,4 @@
+export * from './badges';
 export * from './cache';
 export * from './flags';
 export * from './global';

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

@@ -3,6 +3,8 @@ import type { IDiscussionForm } from '../../../discussion/components/form';
 interface Props {
     /** Whether the form should be displayed as a card */
     isCard?: boolean;
+    /** The ID of the parent, used for slugs */
+    parentId?: string;
     /** Props for the form - this uses everything the `DiscussionForm` component does */
     form: IDiscussionForm;
     /** Details about what a user needs to have to be able to access the form */

package/discussion/components/form/form.d.ts

@@ -1,3 +1,3 @@
 import { IDiscussionForm } from './form.type';
-declare const DiscussionForm: ({ id, content, userHasPermissions, meta, placeholder, maxLength, buttons, forceShow, isCommunity, functions, data, gtmContext, }: IDiscussionForm) => import("react/jsx-runtime").JSX.Element;
+declare const DiscussionForm: ({ id, parentId, content, userHasPermissions, meta, placeholder, maxLength, buttons, forceShow, isCommunity, functions, data, gtmContext, }: IDiscussionForm) => import("react/jsx-runtime").JSX.Element;
 export default DiscussionForm;

package/discussion/components/form/form.type.d.ts

@@ -33,6 +33,8 @@ export interface IDiscussionFormMeta {
 export interface IDiscussionForm {
     /** A unique ID for the form */
     id?: string;
+    /** The ID of the parent, used for slugs */
+    parentId?: string;
     /** Information about the content being created/edited */
     content: IDiscussionContent;
     /** If the user has permission to interact with the form, e.g. if they're a member of the community */

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

@@ -1,6 +1,7 @@
 import React from 'react';
 import { type ListMembers, ClickMentionFallback } from '../../../form';
 import { DiscussionCreateContentFunction, DiscussionCreateLikeFunction, DiscussionDeleteLikeFunction, IForceHide, IFullDiscussionContent } from '../../discussion';
+import { IBadgesOption } from '../../../user/badges';
 interface PostContent extends IFullDiscussionContent {
     /** The post body */
     postBody?: string;
@@ -77,6 +78,8 @@ interface Props {
     setFocus?: boolean;
     /** If the post is used within a community */
     isCommunity?: boolean;
+    /** Whether to show badges and the scope of the badge */
+    badges?: IBadgesOption;
 }
-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;
+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;
 export default Post;

package/discussion/discussion.helpers.d.ts

@@ -15,4 +15,5 @@ export declare const getAuthorData: (author: IUser) => "deleted" | {
     image: {
         thumbnail: string | undefined;
     };
+    badges: import("../user/badge").IBadgesObject | undefined;
 };

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

@@ -8,6 +8,11 @@ export declare const activitiesFeedMock: {
                 jobTitle: string;
                 name: string;
                 organization: string;
+                badges: {
+                    communities: {
+                        'community-slug': string[];
+                    };
+                };
             };
         };
         title: string;
@@ -62,6 +67,11 @@ export declare const activitiesFeedMock: {
                 jobTitle: string;
                 name: string;
                 organization: string;
+                badges: {
+                    communities: {
+                        'community-slug': string[];
+                    };
+                };
             };
         };
         title: string;
@@ -92,6 +102,7 @@ export declare const activitiesFeedMock: {
                 jobTitle: string;
                 name: string;
                 organization: string;
+                badges?: undefined;
             };
         };
         content: string;
@@ -113,6 +124,37 @@ export declare const activitiesFeedMock: {
         time: string;
         verb: string;
         title?: undefined;
+    } | {
+        actor: {
+            created_at: string;
+            updated_at: string;
+            id: string;
+            data: {
+                jobTitle: string;
+                name: string;
+                organization: string;
+                badges?: undefined;
+            };
+        };
+        title: string;
+        content: string;
+        feed_id: string;
+        foreign_id: string;
+        id: string;
+        latest_reactions: {
+            pin?: undefined;
+        };
+        latest_reactions_extra: {};
+        object: string;
+        origin: null;
+        own_reactions: {};
+        reaction_counts: {
+            like?: undefined;
+            pin?: undefined;
+        };
+        target: string;
+        time: string;
+        verb: string;
     })[];
     next: string;
     duration: string;

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

@@ -11,6 +11,11 @@ export declare const repliesFeedMock: {
             id: string;
             data: {
                 name: string;
+                badges: {
+                    communities: {
+                        'community-slug': string[];
+                    };
+                };
             };
         };
         kind: string;
@@ -37,6 +42,7 @@ export declare const repliesFeedMock: {
             id: string;
             data: {
                 name: string;
+                badges?: undefined;
             };
         };
         kind: string;
@@ -96,6 +102,33 @@ export declare const repliesFeedMock: {
         children_counts: {
             reply: number;
         };
+    } | {
+        created_at: string;
+        updated_at: string;
+        id: string;
+        user_id: string;
+        user: {
+            created_at: string;
+            updated_at: string;
+            id: string;
+            data: {
+                name: string;
+                badges?: undefined;
+            };
+        };
+        kind: string;
+        activity_id: string;
+        data: {
+            content: string;
+        };
+        parent: string;
+        latest_children: {
+            reply?: undefined;
+        };
+        children_counts: {
+            reply?: undefined;
+        };
+        own_children?: undefined;
     })[];
     duration: string;
 };

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

@@ -1,6 +1,6 @@
 export declare const nestedRepliesFeedMock: {
     next: string;
-    results: {
+    results: ({
         created_at: string;
         updated_at: string;
         id: string;
@@ -11,6 +11,11 @@ export declare const nestedRepliesFeedMock: {
             id: string;
             data: {
                 name: string;
+                badges: {
+                    communities: {
+                        'community-slug': string[];
+                    };
+                };
             };
         };
         kind: string;
@@ -21,6 +26,28 @@ export declare const nestedRepliesFeedMock: {
         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;
+                badges?: undefined;
+            };
+        };
+        kind: string;
+        activity_id: string;
+        data: {
+            content: string;
+        };
+        parent: string;
+        latest_children: {};
+        children_counts: {};
+    })[];
     duration: string;
 };

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

@@ -6,7 +6,7 @@ import { type IQueryFns } from './cache';
 interface IActivitySectionQueryFns extends IQueryFns {
     remove: () => Promise<void>;
 }
-interface Props {
+export interface IActivitySectionProps {
     basePath: string;
     parentId: string;
     activityId: string;
@@ -21,5 +21,5 @@ interface Props {
     };
     profile: IProfileFormProps;
 }
-declare const ActivitySection: React.FC<Props>;
+declare const ActivitySection: React.FC<IActivitySectionProps>;
 export default ActivitySection;

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

@@ -1 +1,2 @@
+export type { IActivitySectionProps } from './activity-section';
 export { default as ActivitySection } from './activity-section';

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

@@ -10,6 +10,11 @@ export declare const activitySectionMock: {
             location: {
                 country: string;
             };
+            badges: {
+                communities: {
+                    'community-slug': string[];
+                };
+            };
         };
     };
     content: string;

package/discussion/shared/interfaces/user.interface.d.ts

@@ -1,3 +1,4 @@
+import { IBadgesObject } from '../../../user/badge';
 import type { EnrichedUser } from 'getstream';
 export interface IUser extends EnrichedUser {
     error?: string;
@@ -9,5 +10,6 @@ export interface IUser extends EnrichedUser {
             country?: string;
         };
         thumbnail?: string;
+        badges?: IBadgesObject;
     };
 }

package/form/components/form/index.d.ts

@@ -1,2 +1,2 @@
 export { default as Form } from './form';
-export type { IField, FormValues, IFormMeta } from './form.types';
+export type { IField, FormValues, IFormMeta, IFormProps } from './form.types';

package/form/components/rich-text-editor/helpers/transform/transform.d.ts

@@ -12,7 +12,7 @@ export default function transform<T extends InputNodeTypes>(node: MdastNode, opt
     position?: any;
     ordered?: boolean | undefined;
     checked?: any;
-    depth?: 1 | 2 | 3 | 4 | 6 | 5 | undefined;
+    depth?: 1 | 2 | 3 | 4 | 5 | 6 | undefined;
     lang?: string | undefined;
     spread?: any;
     indent?: any;

package/form/types/profile-form/profile-form.d.ts

@@ -1,5 +1,5 @@
 import type { IFormValues, IFormMeta } from './../../components/form/form.types';
-export interface IProfileFormProps {
+export interface IProfileFormProps<OnSuccessArgs = IFormValues> {
     /** The hooks used in the form */
     hooks: {
         /** The hook to predict the user's location */
@@ -16,9 +16,9 @@ export interface IProfileFormProps {
     /** The functions to call */
     functions: {
         /** The function to upload the user's profile image */
-        uploadImage: () => Promise<void>;
+        uploadImage: () => Promise<unknown>;
         /** The function to call on success */
-        onSuccess?: (data: IFormValues) => Promise<void>;
+        onSuccess?: (data: OnSuccessArgs) => Promise<void>;
         /** The function to call when the form is cancelled, e.g. the user presses a cancel button */
         onCancel?: () => void;
         /** The function to call on failure */

package/general/tooltip/tooltip.d.ts

@@ -28,8 +28,13 @@ interface Props {
         /** The callback to fire when the tooltip is closed */
         onClose?: () => void;
     };
-    /** Whether the tooltip is hidden from screen readers or not */
-    'aria-hidden'?: boolean;
+    /** Optional props for accessibility */
+    accessibility?: {
+        /** Whether this should use `hidden` on content, or if screenreaders should be able to access the full text, even when the tooltip is closed, e.g. for tooltips on buttons and pills */
+        readToScreenreadersWhenClosed?: boolean;
+        /** Whether the tooltip is hidden from screen readers or not */
+        'aria-hidden'?: boolean;
+    };
     /** The id of the tooltip */
     id?: string;
 }

package/helpers/intl.d.ts

@@ -38,9 +38,12 @@ export declare const checkIntlPathExists: (path: string, language?: {
     card_cta_event_done: string;
     card_cta_microcourse_done: string;
     carousel_pagination_previous: string;
+    carousel_pagination_previousSlide: string;
     carousel_pagination_next: string;
-    carousel_pagination_page: string;
-    carousel_pagination_aria_live: string;
+    carousel_pagination_nextSlide: string;
+    carousel_pagination_slide: string;
+    carousel_pagination_ariaLive: string;
+    carousel_pagination_ariaLive_slide: string;
     activitySection_notFoundError: string;
     activitiesFeed_sorting_label: string;
     activitiesFeed_rankingMethod_recent: string;
@@ -50,6 +53,7 @@ export declare const checkIntlPathExists: (path: string, language?: {
     communityDetails_viewAll: string;
     communityDetails_invite: string;
     community_joinToPost: string;
+    community_sortSuccess: string;
     joinCommunityButton: string;
     joinCommunityButton_short: string;
     joinCommunityButton_joining: string;