@apolitical/component-library 5.3.2 → 5.3.4-SW.0

package/cards/cards.types.d.ts

@@ -148,3 +148,22 @@ export interface IndividualCarouselProps extends BaseCarouselProps {
     /** The types for each card, from Contentful */
     cardTypes: CardContentType[];
 }
+export interface NarrowCardType {
+    /** The image to use */
+    banner?: ResponsiveImageType;
+    /** The title of the narrow card */
+    title?: string;
+    /** The primary text */
+    text?: string;
+    /** Is the content private  */
+    isPrivate?: boolean;
+}
+export interface NarrowCardProps {
+    /** The card data, from Contentful */
+    card: NarrowCardType;
+    functions?: {
+        onClick?: () => void;
+    };
+    /** Additional classes */
+    className?: string;
+}

package/cards/index.d.ts

@@ -2,3 +2,4 @@ export * from './card';
 export * from './card-block';
 export * from './carousel';
 export * from './cards.types';
+export * from './narrow-card';

package/cards/mocks/index.d.ts

@@ -1,3 +1,4 @@
 export * from './card';
 export * from './carousel';
 export * from './mocks.helpers';
+export * from './narrow-card';

package/cards/mocks/narrow-card.d.ts

@@ -0,0 +1,30 @@
+export namespace openCommunityMember {
+    namespace banner {
+        let description: string;
+        let height: number;
+        let type: string;
+        let url: string;
+        let width: number;
+        let aspect: string;
+        let query: string;
+    }
+    let title: string;
+    let text: string;
+    let isPrivate: boolean;
+}
+export namespace openCommunityMemberNoImage {
+    let title_1: string;
+    export { title_1 as title };
+    let text_1: string;
+    export { text_1 as text };
+    let isPrivate_1: boolean;
+    export { isPrivate_1 as isPrivate };
+}
+export namespace closedCommunityMember {
+    let isPrivate_2: boolean;
+    export { isPrivate_2 as isPrivate };
+}
+export namespace closedCommunityMemberNoImage {
+    let isPrivate_3: boolean;
+    export { isPrivate_3 as isPrivate };
+}

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

@@ -0,0 +1 @@
+export { default as NarrowCard } from './narrow-card';

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

@@ -0,0 +1,3 @@
+import { NarrowCardProps } from '../cards.types';
+declare const NarrowCard: ({ className, card, functions }: NarrowCardProps) => import("react/jsx-runtime").JSX.Element;
+export default NarrowCard;

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

@@ -1,5 +1,6 @@
 /// <reference types="react" />
 import type { IDiscussionForm } from '../../../discussion/components/form';
+import { ICategory } from '../../shared';
 interface Props {
     /** Whether the form should be displayed as a card */
     isCard?: boolean;
@@ -7,6 +8,8 @@ interface Props {
     parentId?: string;
     /** Props for the form - this uses everything the `DiscussionForm` component does */
     form: IDiscussionForm;
+    /** The categories to show in the form */
+    categories?: ICategory[];
     /** Details about what a user needs to have to be able to access the form */
     membershipRequiredToPost: {
         /** Whether the user needs to be a member of the community to post */

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

@@ -1,5 +1,6 @@
 import { type ListMembers, ClickMentionFallback } from '../../../form';
 import { DiscussionCreateContentFunction, IDiscussionContent, IListMemberData, IMentions } from './../../discussion';
+import { ICategory } from '../../shared';
 export interface IDiscussionFormMeta {
     /** Whether the form data is still loading */
     isLoading?: boolean;
@@ -23,6 +24,10 @@ export interface IDiscussionFormMeta {
     };
     /** Whether title text should show above the form */
     showTitle?: boolean;
+    /** What category options should be made available for the form */
+    postCategories?: ICategory[];
+    /** Whether the post type should show */
+    showPostType?: boolean;
     /** Whether the community guidelines text should show beneath the form */
     showGuidelines?: boolean;
     /** Whether to show a divider before the buttons */

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

@@ -87,10 +87,15 @@ export interface IDiscussionPostProps {
     isCommunity?: boolean;
     /** Whether to show badges and the scope of the badge */
     badges?: IBadgesOption;
+    /** Categories for the community */
+    categories?: {
+        name: string;
+        slug: string;
+    }[];
     /** The base path, used for slugs */
     basePath: string;
     /** The ID of the parent, used for slugs */
     parentId: string;
 }
-declare const Post: ({ element, content, userHasPermissions, userHasOwnerPermissions, isLoading, originalAuthorId, forceHide, functions, links, className, gtmContext, children, isTruncated, styling: { showShareLinkButton, showMoreMenuButton }, setFocus, isCommunity, badges, basePath, parentId, }: IDiscussionPostProps) => import("react/jsx-runtime").JSX.Element;
+declare const Post: ({ element, content, userHasPermissions, userHasOwnerPermissions, isLoading, originalAuthorId, forceHide, functions, links, className, gtmContext, children, isTruncated, styling: { showShareLinkButton, showMoreMenuButton }, setFocus, isCommunity, badges, categories, basePath, parentId, }: IDiscussionPostProps) => import("react/jsx-runtime").JSX.Element;
 export default Post;

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

@@ -12,6 +12,11 @@ interface Props {
     isMember: boolean;
     /** Whether the user is an owner of the community */
     isOwner: boolean;
+    /** The categories for the community */
+    categories: {
+        name: string;
+        slug: string;
+    }[];
     /** Functions for the activities query */
     functions: {
         /** Query functions for the activities */

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

@@ -3,9 +3,12 @@ import type { ICache, ICachePage } from '../..';
 export interface IListActivitiesArgs {
     queryFn: (_: unknown) => Promise<ICachePage>;
     queryKey: QueryKey;
-    rankingMethod?: string;
+    filterOption?: {
+        id: string;
+        type: string;
+    };
 }
-export declare function useListActivities({ queryFn, queryKey, rankingMethod, }: IListActivitiesArgs): {
+export declare function useListActivities({ queryFn, queryKey, filterOption, }: IListActivitiesArgs): {
     activities: import('../../../../../../discussion/shared').IActivity[];
     error: Error | null;
     isLoading: boolean;

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

@@ -16,6 +16,7 @@ export declare const activitiesFeedMock: {
             };
         };
         title: string;
+        categories: string[];
         content: string;
         feed_id: string;
         foreign_id: string;
@@ -124,6 +125,7 @@ export declare const activitiesFeedMock: {
             };
         };
         title: string;
+        categories: string[];
         content: string;
         feed_id: string;
         foreign_id: string;
@@ -155,6 +157,7 @@ export declare const activitiesFeedMock: {
                 badges?: undefined;
             };
         };
+        categories: string[];
         content: string;
         feed_id: string;
         foreign_id: string;
@@ -229,6 +232,7 @@ export declare const activitiesFeedMock: {
         target: string;
         time: string;
         verb: string;
+        categories?: undefined;
     })[];
     next: string;
     duration: string;

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

@@ -22,6 +22,10 @@ export interface IActivitySectionProps {
         leave: () => Promise<void>;
     };
     profile: IProfileFormProps;
+    categories?: {
+        name: string;
+        slug: string;
+    }[];
 }
 declare const ActivitySection: React.FC<IActivitySectionProps>;
 export default ActivitySection;

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

@@ -17,6 +17,7 @@ export declare const activitySectionMock: {
             };
         };
     };
+    categories: string[];
     content: string;
     feed_id: string;
     foreign_id: string;

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

@@ -3,6 +3,7 @@ import type { IActivity, IReaction } from '..';
 interface IPrepareActivityArgs {
     title?: string;
     content?: string;
+    categories?: string;
 }
 interface IEnrichActivityArgs {
     activity: IActivity | Partial<IActivity>;
@@ -17,9 +18,10 @@ interface IDecrementActivityLikesArgs {
     activity: IActivity;
     user?: IUserContext;
 }
-export declare function prepareActivity({ title, content }: IPrepareActivityArgs): {
+export declare function prepareActivity({ title, content, categories }: IPrepareActivityArgs): {
     title: string | undefined;
     content: string | undefined;
+    categories: string[];
     id: string;
     time: string;
     verb: string;

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

@@ -1,6 +1,7 @@
 import type { FlatActivityEnriched } from 'getstream';
 export interface IActivity extends FlatActivityEnriched {
     content: string;
+    categories?: string[];
     feed_id?: string;
     title: string;
     total_replies?: number;

package/discussion/shared/interfaces/community.category.interface.d.ts

@@ -0,0 +1,4 @@
+export interface ICategory {
+    name: string;
+    slug: string;
+}

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

@@ -24,6 +24,8 @@ export interface IFullDiscussionContent extends IDiscussionContent {
     body?: string;
     /** The author of the post */
     author: MemberProps;
+    /** The post categories */
+    categories?: string[];
     createdAt: Date | string;
     /** The number of likes to display */
     likes?: number;

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

@@ -1,4 +1,5 @@
 export * from './activity.interface';
+export * from './community.category.interface';
 export * from './context.interface';
 export * from './discussion.interface';
 export * from './reaction.interface';

package/form/components/form/components/fields/checkbox/checkbox.d.ts

@@ -1,11 +1,11 @@
 import React from 'react';
 import { IField } from '../../../form.types';
-export declare const Checkbox: ({ className, disabled, element, functions: allFunctions, id, inputRef: ref, intlPath, label, shownValue: value, type, value: isChecked, ...props }: IField) => React.DOMElement<{
+export declare const Checkbox: ({ className, disabled, element, functions: allFunctions, id, inputRef: ref, intlPath, label, shownValue: value, type, value: isChecked, accessibilityOptions: { checkboxes: { navigateWithArrowKeys } }, ...props }: IField) => React.DOMElement<{
     onMultiSelectSubmit?: ((arg1: import("../../../form.types").FormValues) => void) | undefined;
     onBlur?: (() => void) | undefined;
     onFocus?: (() => void) | undefined;
     onKeyInput?: (<T>(arg1: import("../../../form.types").FormValues) => Promise<T>) | undefined;
-    onKeyDown?: ((e: React.KeyboardEvent<HTMLElement>) => void) | undefined;
+    onKeyDown: ((e: React.KeyboardEvent<HTMLElement>) => void) | undefined;
     submitForm?: ((arg: import("../../../form.types").IFormValues) => void) | undefined;
     'aria-describedby'?: string | undefined;
     'aria-errormessage'?: string | undefined;

package/form/components/form/components/fields/input/input.d.ts

@@ -15,6 +15,11 @@ export declare const Input: ({ className, element, id, inputRef: ref, functions,
     value: InputValues;
     placeholder: string | undefined;
     autoFocus: boolean | undefined;
+    accessibilityOptions?: {
+        checkboxes?: {
+            navigateWithArrowKeys?: boolean | undefined;
+        } | undefined;
+    } | undefined;
     'aria-describedby'?: string | undefined;
     'aria-errormessage'?: string | undefined;
     'aria-invalid'?: boolean | undefined;

package/form/components/form/components/fields/multiple-options/multiple-options.d.ts

@@ -1,3 +1,3 @@
 import { IField } from '../../../form.types';
-export declare const MultipleOptions: ({ className, functions, intlPath, id: groupId, label, multiSelect, name, options, required, type, value, ...props }: IField) => import("react/jsx-runtime").JSX.Element;
+export declare const MultipleOptions: ({ className, functions, intlPath, id: groupId, label, multiSelect, name, options, required, type, value, accessibilityOptions, ...props }: IField) => import("react/jsx-runtime").JSX.Element;
 export default MultipleOptions;

package/form/components/form/form.types.d.ts

@@ -82,6 +82,14 @@ export interface IFieldFunctions {
     submitForm?: (arg: IFormValues) => void;
 }
 export interface IField {
+    /** Additional accessibility configuration */
+    accessibilityOptions?: {
+        /** Additional options for checkboxes */
+        checkboxes?: {
+            /** Whether the field should be navigable with arrow keys */
+            navigateWithArrowKeys?: boolean;
+        };
+    };
     /** Optional ID of the element which describes this field, for screen readers */
     'aria-describedby'?: string;
     /** Optional ID of the element which provides an error message for this field */

package/helpers/intl.d.ts

@@ -127,6 +127,8 @@ export declare const checkIntlPathExists: (path: string, language?: {
     discussionFormCard_overlay_text: string;
     discussionFormCard_overlay_cta_discard: string;
     discussionFormCard_overlay_cta_continue: string;
+    discussion_form_postType_label: string;
+    'discussion_form__postType_no-category': string;
     discussion_form_title: string;
     discussion_form_titleField_label: string;
     discussion_form_titleField_placeholder: string;