@apolitical/component-library 5.3.7-SW.0 → 5.4.0-beta.0

package/cards/cards.types.d.ts

@@ -148,25 +148,3 @@ 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;
-    /** The URL the card should point to */
-    slug?: string | null;
-    /** Is the content private  */
-    isPrivate?: boolean;
-}
-export interface NarrowCardProps {
-    /** The element that will render around the content */
-    element?: 'li' | 'div';
-    /** The card data, from Contentful */
-    card: NarrowCardType;
-    /** Additional classes */
-    className?: string;
-    /** Context for the Google Tag Manager event */
-    gtmContext?: string;
-}

package/cards/index.d.ts

@@ -2,4 +2,3 @@ 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,4 +1,3 @@
 export * from './card';
 export * from './carousel';
 export * from './mocks.helpers';
-export * from './narrow-card';

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

@@ -1,5 +1,5 @@
-import { type ListMembers, ClickMentionFallback } from '../../../form';
-import { DiscussionCreateContentFunction, IDiscussionContent, IListMemberData, IMentions } from './../../discussion';
+import type { IEnrichedUrlData } from '../../../navigation';
+import { DiscussionCreateContentFunction, IDiscussionContent, IListMemberData, IMentions, IDiscussionFormFns } from './../../discussion';
 import { ICategory } from '../../shared';
 export interface IDiscussionFormMeta {
     /** Whether the form data is still loading */
@@ -36,6 +36,24 @@ export interface IDiscussionFormMeta {
     /** Whether the success message should show on a successful submit */
     showSuccessMessage?: boolean;
 }
+interface IDiscussionFormFunctions extends IDiscussionFormFns {
+    onChange?: (args: {
+        [key: string]: string | boolean;
+    }) => void;
+    create: DiscussionCreateContentFunction;
+    handleSaveEdit?: (({ title, body }: {
+        title: string;
+        body: string;
+    }) => Promise<void>) | (() => void);
+    handleCancel?: () => void;
+    callback?: (args: void) => void;
+    onMention?: (value?: IListMemberData) => void;
+    props?: {
+        create: {
+            projectNames: ['questions-answers'];
+        };
+    };
+}
 export interface IDiscussionForm {
     /** A unique ID for the form */
     id?: string;
@@ -68,33 +86,25 @@ export interface IDiscussionForm {
         error?: false | string;
     };
     /** The functions that are passed in to handle the functionality */
-    functions: {
-        onChange?: (args: {
-            [key: string]: string | boolean;
-        }) => void;
-        create: DiscussionCreateContentFunction;
-        handleSaveEdit?: (({ title, body }: {
-            title: string;
-            body: string;
-        }) => Promise<void>) | (() => void);
-        handleCancel?: () => void;
-        callback?: (args: void) => void;
-        onMention?: (value?: IListMemberData) => void;
-        listMembers?: ListMembers;
-        clickMentionFallback?: ClickMentionFallback;
-        props?: {
-            create: {
-                projectNames: ['questions-answers'];
-            };
-        };
-    };
+    functions: IDiscussionFormFunctions;
     /** Data to be passed into the rich text editor */
     data?: {
         /** Mentions data */
         mentions?: IMentions;
+        /** Optional data about the first link inside the post */
+        link?: false | IEnrichedUrlData;
     };
     /** The context for GTM */
     gtmContext?: string;
     /** The language to use for the text */
     locale?: string;
 }
+export interface IDiscussionFormState {
+    title: string;
+    body: string;
+    categories: string[] | string;
+    data: {
+        link?: false | IEnrichedUrlData;
+    };
+}
+export {};

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

@@ -1,6 +1,5 @@
 import React from 'react';
-import { ClickMentionFallback, type ListMembers } from '../../../form';
-import { DiscussionCreateContentFunction, DiscussionCreateLikeFunction, DiscussionDeleteLikeFunction, DiscussionListLikesFunction } from '../../discussion';
+import { DiscussionCreateContentFunction, DiscussionCreateLikeFunction, DiscussionDeleteLikeFunction, DiscussionListLikesFunction, IDiscussionFormFns } from '../../discussion';
 import type { IForceHide, IFullDiscussionContent } from '../../shared/interfaces';
 import { IBadgesOption } from '../../../user/badges';
 export interface IPostContent extends IFullDiscussionContent {
@@ -46,12 +45,7 @@ export interface IDiscussionPostProps {
             /** Open comments on a post */
             openComments?: () => void;
         };
-        mentions: {
-            /** Get data to hydrate mentions */
-            listMembers: ListMembers;
-            /** Function to call when clicking mention fallback */
-            clickMentionFallback: ClickMentionFallback;
-        };
+        form: IDiscussionFormFns;
         pins?: {
             /** Pin the post */
             createPin?: () => void;

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

@@ -77,7 +77,7 @@ declare namespace _default {
         namespace comments {
             function openComments(): void;
         }
-        namespace mentions {
+        namespace form {
             function listMembers(): Promise<never[]>;
             function clickMentionFallback(): void;
         }

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

@@ -1,8 +1,8 @@
 /// <reference types="react" />
 import { type IProfileFormProps } from '../../../form';
-import type { IMentionsFns } from '../../../discussion/discussion.d';
-import type { IQueryFns } from './cache';
 import type { ILikesFeedQueryFns } from '../../../discussion/feeds/likes-feed';
+import type { IDiscussionFormFns } from '../../../discussion/discussion.d';
+import { type IQueryFns } from './cache';
 interface Props {
     /** The base path, used for slugs */
     basePath: string;
@@ -21,8 +21,8 @@ interface Props {
     functions: {
         /** Query functions for the activities */
         activities: IQueryFns;
-        /** Query functions for the mentions */
-        mentions: IMentionsFns;
+        /** Query functions for the form, including mentions */
+        form: IDiscussionFormFns;
         /** Function to join the community */
         join: () => Promise<void>;
         /** Function to leave the community */

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

@@ -1,11 +1,11 @@
 /// <reference types="react" />
-import type { IMentionsFns } from '../../../../discussion/discussion.d';
-import type { IQueryFns } from './../cache';
+import type { IDiscussionFormFns } from '../../../../discussion/discussion.d';
 import { ILikesFeedQueryFns } from '../../../../discussion/feeds/likes-feed';
+import { type IQueryFns } from './../cache';
 interface NestedRepliesFunctions {
     /** Functions for the replies query */
     reactions: IQueryFns;
-    mentions: IMentionsFns;
+    form: IDiscussionFormFns;
     /** Functions for the likes query */
     likes: ILikesFeedQueryFns;
 }

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

@@ -1,15 +1,15 @@
 /// <reference types="react" />
 import { type IProfileFormProps } from '../../../form';
-import type { IMentionsFns } from './../../discussion';
-import { type IQueryFns } from './cache';
 import { ILikesFeedQueryFns } from '../../../discussion/feeds/likes-feed';
+import type { IDiscussionFormFns } from './../../discussion';
+import { type IQueryFns } from './cache';
 interface RepliesFunctions {
     /** Functions for the replies query */
     reactions: IQueryFns;
     /** Functions for the likes query */
     likes: ILikesFeedQueryFns;
     /** Query functions for the mentions */
-    mentions: IMentionsFns;
+    form: IDiscussionFormFns;
     /** Function to join the community */
     join: () => Promise<void>;
     /** Function to leave the community */

package/discussion/index.d.ts

@@ -3,3 +3,4 @@ export * from './feeds';
 export * from './discussion.helpers';
 export * from './sections';
 export type { IActivity, IFullDiscussionContent, IListMemberData, IMentionData, IMentions, IReaction, IUser, } from './shared/interfaces';
+export type { IDiscussionFormFns } from './discussion.d';

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

@@ -1,9 +1,8 @@
 /// <reference types="react" />
 import { type IProfileFormProps } from '../../../form';
-import { type IRepliesFeedQueryFns } from '../../../discussion/feeds';
-import type { IMentionsFns } from './../../discussion.d';
+import { type IRepliesFeedQueryFns, type ILikesFeedQueryFns } from '../../../discussion/feeds';
+import type { IDiscussionFormFns } from './../../discussion.d';
 import { type IQueryFns } from './cache';
-import type { ILikesFeedQueryFns } from '../../../discussion/feeds/likes-feed';
 interface IActivitySectionQueryFns extends IQueryFns {
     remove: () => Promise<void>;
 }
@@ -17,7 +16,7 @@ export interface IActivitySectionProps {
         activities: IActivitySectionQueryFns;
         reactions: IRepliesFeedQueryFns;
         likes: ILikesFeedQueryFns;
-        mentions: IMentionsFns;
+        form: IDiscussionFormFns;
         join: () => Promise<void>;
         leave: () => Promise<void>;
     };

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

@@ -1,5 +1,6 @@
 import { MemberProps, MemberDetailsProps } from '../../../user';
 import type { ListMembers, ClickMentionFallback } from '../../../form';
+import type { IEnrichedUrlData } from '../../../navigation';
 export type IDiscussionContentType = 'answer' | 'post' | 'response' | 'reply' | 'question';
 export interface IDiscussionContent {
     /** The type of content */
@@ -38,8 +39,13 @@ export interface IFullDiscussionContent extends IDiscussionContent {
     canLike?: boolean;
     /** The number of comments the post has */
     comments?: number;
-    /** Details of users mentioned in the content */
-    mentions?: IMentions;
+    /** Extra data, to show in the content */
+    data?: {
+        /** Details of users mentioned in the content */
+        mentions?: IMentions;
+        /** Link metadata, to show an enriched url for the first link in the post */
+        link?: false | IEnrichedUrlData;
+    };
     /** If the content has been edited */
     isEdited?: boolean;
     /** The URL to use for reporting context, etc. */

package/form/components/rich-text-editor/rich-text-editor.types.d.ts

@@ -1,7 +1,15 @@
 import { BaseElement, BaseText, Descendant, Point, Range } from 'slate';
-import type { IListMemberData, IMentions } from '../../../discussion';
+import type { IListMemberData, IMentions, IDiscussionFormFns } from '../../../discussion';
 import type { MemberDetailsProps } from '../../../user';
 import type { IEnrichedUrlData } from '../../../navigation';
+interface IRTEFunctions extends IDiscussionFormFns {
+    /** An optional event handler, called when the rich text editor is changed */
+    onChange?: (value: string, data?: false | IEnrichedUrlData) => void;
+    /** An optional function to call when a mention is inserted */
+    onMention?: (value?: IListMemberData) => void;
+    /** An optional event handler, called when the rich text editor reports an error */
+    reportError?: ReportError;
+}
 export interface IRTEProps {
     /** The id of the rich text editor */
     id?: string;
@@ -17,20 +25,7 @@ export interface IRTEProps {
         isInOverlay?: false | 'string';
     };
     /** Optional functions */
-    functions?: {
-        /** An optional function to get a filtered list of members when the user starts typing a mention */
-        listMembers?: ListMembers;
-        /** An optional function to call when the user clicks the mention fallback, e.g. to show an invite modal */
-        clickMentionFallback?: ClickMentionFallback;
-        /** An optional function to get a preview of a link */
-        getLinkPreview?: (url: string) => Promise<IEnrichedUrlData>;
-        /** An optional event handler, called when the rich text editor is changed */
-        onChange?: (value: string) => void;
-        /** An optional function to call when a mention is inserted */
-        onMention?: (value?: IListMemberData) => void;
-        /** An optional event handler, called when the rich text editor reports an error */
-        reportError?: ReportError;
-    };
+    functions?: IRTEFunctions;
     /** Optional autoFocus */
     autoFocus?: boolean;
     /** Optional aria invalid */
@@ -135,3 +130,4 @@ export interface IMentionPopOver {
     position: Range | null;
     numberOfUsers: number | null;
 }
+export {};