@apolitical/component-library 4.1.10-ac.1 → 4.1.10-beta.0

package/constants/index.d.ts

@@ -2,4 +2,5 @@ export * from './assets';
 export * from './contact-details';
 export * from './courses';
 export * from './error-messages';
+export * from './regex';
 export * from './stats';

package/constants/regex.d.ts

@@ -0,0 +1 @@
+export declare const UUID_V4_REGEX: RegExp;

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

@@ -1,6 +1,6 @@
 import { Dispatch } from 'react';
 import { Point } from 'slate';
-import { ReportError } from './../../rich-text-editor.types';
+import { ReportError, IMentionPopOver } from './../../rich-text-editor.types';
 declare const RichTextEditorContext: import("react").Context<{
     /** The id of the editor */
     id: string;
@@ -12,6 +12,8 @@ declare const RichTextEditorContext: import("react").Context<{
     openTooltip: string | null;
     /** Whether the link editor is open */
     showLinkEditor: boolean;
+    /** The data for the mention popover, including if it's showing, the selected user for the popover, and the possible users */
+    mentionPopover: IMentionPopOver;
     /** The last anchor point (used for Slate to know where the cursor is) */
     lastAnchor: Point | null;
     /** The function to update the state */

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

@@ -1,2 +1,3 @@
 export * from './element';
 export * from './leaf';
+export * from './mention-popover';

package/form/components/rich-text-editor/components/editor/mention-popover/index.d.ts

@@ -0,0 +1 @@
+export { default as MentionPopover } from './mention-popover';

package/form/components/rich-text-editor/components/editor/mention-popover/mention-popover.d.ts

@@ -0,0 +1,2 @@
+declare const MentionPopover: () => import("react/jsx-runtime").JSX.Element | null;
+export default MentionPopover;

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

@@ -7,6 +7,7 @@ export interface NodeTypes {
     [Formatting.ul]: string;
     [Formatting.ol]: string;
     [Formatting.li]: string;
+    [Formatting.mention]: string;
     [Formatting.heading]: {
         1: string;
         2: string;
@@ -28,6 +29,7 @@ export declare enum MdastNodes {
     list = "list",
     listItem = "listItem",
     link = "link",
+    mention = "mention",
     image = "image",
     blockquote = "blockquote",
     code = "code",
@@ -39,7 +41,7 @@ export declare enum MdastNodes {
     thematicBreak = "thematicBreak",
     text = "text"
 }
-export type MdastNodeType = MdastNodes.paragraph | MdastNodes.heading | MdastNodes.list | MdastNodes.listItem | MdastNodes.link | MdastNodes.image | MdastNodes.blockquote | MdastNodes.code | MdastNodes.html | MdastNodes.emphasis | MdastNodes.strong | MdastNodes.delete | MdastNodes.inlineCode | MdastNodes.thematicBreak | MdastNodes.text;
+export type MdastNodeType = MdastNodes.paragraph | MdastNodes.heading | MdastNodes.list | MdastNodes.listItem | MdastNodes.link | MdastNodes.mention | MdastNodes.image | MdastNodes.blockquote | MdastNodes.code | MdastNodes.html | MdastNodes.emphasis | MdastNodes.strong | MdastNodes.delete | MdastNodes.inlineCode | MdastNodes.thematicBreak | MdastNodes.text;
 export declare const defaultNodeTypes: NodeTypes;
 export interface LeafType {
     text: string;
@@ -53,6 +55,7 @@ export interface BlockType {
     type: string;
     parentType?: string;
     link?: string;
+    mention?: string;
     caption?: string;
     language?: string;
     break?: boolean;

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

@@ -2,5 +2,6 @@ export * from './ast-types';
 export * from './deserialize';
 export * from './handle-text';
 export * from './hot-keys';
+export * from './mentions';
 export * from './serialize';
 export * from './transform';

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

@@ -0,0 +1,2 @@
+export { default as insertMention } from './insert-mention';
+export { default as shouldShowMentionsPopover } from './should-show-mentions-popover';

package/form/components/rich-text-editor/helpers/mentions/insert-mention.d.ts

@@ -0,0 +1,5 @@
+import { Dispatch } from 'react';
+import { BaseEditor } from 'slate';
+import { IMentionPopOver } from './../../rich-text-editor.types';
+declare const insertMention: (editor: BaseEditor, mentionPopover: IMentionPopOver, dispatch: Dispatch<any>) => void;
+export default insertMention;

package/form/components/rich-text-editor/helpers/mentions/should-show-mentions-popover.d.ts

@@ -0,0 +1,5 @@
+import { Dispatch } from 'react';
+import { BaseEditor } from 'slate';
+import { type GetUsers } from './../../rich-text-editor.types';
+declare const shouldShowMentionsPopover: (editor: BaseEditor, isShowing: boolean, getUsers: GetUsers | undefined, dispatch: Dispatch<any>) => Promise<void>;
+export default shouldShowMentionsPopover;

package/form/components/rich-text-editor/plugins/index.d.ts

@@ -1,2 +1,3 @@
 export * from './with-linlines';
+export * from './with-mentions';
 export * from './without-empty-links';

package/form/components/rich-text-editor/plugins/with-mentions/index.d.ts

@@ -0,0 +1 @@
+export { default as withMentions } from './with-mentions';

package/form/components/rich-text-editor/plugins/with-mentions/with-mentions.d.ts

@@ -0,0 +1,6 @@
+import { BaseEditor } from 'slate';
+import { HistoryEditor } from 'slate-history';
+import { ReactEditor } from 'slate-react';
+import { ReportError } from './../../rich-text-editor.types';
+declare const withMentions: (editor: BaseEditor & ReactEditor & HistoryEditor, reportError: ReportError) => BaseEditor & ReactEditor & HistoryEditor;
+export default withMentions;

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

@@ -0,0 +1 @@
+export declare const mentionIdentifier = "MENTION: ";

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

@@ -1,4 +1,5 @@
-import { ReportError } from './rich-text-editor.types';
+import type { IMentions } from '../../../discussion/discussion';
+import { GetUsers, ReportError } from './rich-text-editor.types';
 interface Props {
     /** The id of the rich text editor */
     id?: string;
@@ -10,6 +11,8 @@ interface Props {
     maxLength?: number;
     /** Optional functions */
     functions?: {
+        /** An optional function to get a filtered list of members when the user starts typing a mention */
+        getUsers?: GetUsers;
         /** An optional event handler, called when the rich text editor is changed */
         onChange?: (value: string) => void;
         /** An optional event handler, called when the rich text editor reports an error */
@@ -21,6 +24,11 @@ interface Props {
     'aria-invalid'?: boolean;
     /**  Optional aria error message */
     'aria-errormessage'?: string;
+    /** Optional data for the editor */
+    data?: {
+        /** Optional mentions */
+        mentions?: IMentions;
+    };
 }
-declare const RichTextEditor: ({ id, value, placeholder, maxLength, functions, autoFocus, ...props }: Props) => import("react/jsx-runtime").JSX.Element | null;
+declare const RichTextEditor: ({ id, value, placeholder, maxLength, functions, autoFocus, data, ...props }: Props) => import("react/jsx-runtime").JSX.Element | null;
 export default RichTextEditor;

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

@@ -1,4 +1,5 @@
-import { BaseElement, BaseText, Descendant } from 'slate';
+import { BaseElement, BaseText, Descendant, Range } from 'slate';
+import type { MemberDetailsProps } from '../../../user';
 export declare enum Formatting {
     blockquote = "block_quote",
     bold = "bold",
@@ -10,6 +11,7 @@ export declare enum Formatting {
     italic = "italic",
     li = "list_item",
     link = "link",
+    mention = "mention",
     ol = "ol_list",
     paragraph = "paragraph",
     ul = "ul_list",
@@ -26,10 +28,15 @@ export interface BaseProps {
     className?: string;
     [key: string]: unknown;
 }
-export type BlockOptionType = Formatting.blockquote | Formatting.link | Formatting.li | Formatting.ol | Formatting.ul | Formatting.paragraph | Formatting.span;
+export type BlockOptionType = Formatting.blockquote | Formatting.link | Formatting.li | Formatting.mention | Formatting.ol | Formatting.ul | Formatting.paragraph | Formatting.span;
 export interface TypeElement extends BaseElement {
     type: BlockOptionType;
 }
+export interface MentionElement extends BaseElement {
+    type: Formatting.mention;
+    id: string;
+    name?: string;
+}
 export type MarkOptionType = Formatting.bold | Formatting.italic | Formatting.strikethrough;
 export interface TypeText extends BaseText {
     [Formatting.bold]?: boolean;
@@ -46,3 +53,19 @@ export type LinkElement = {
     children: Descendant[];
 };
 export type ReportError = (error: string) => void;
+export interface IMention {
+    id: string;
+    creator?: boolean;
+    role?: string;
+    createdAt?: string;
+    updatedAt?: string;
+    userId?: string;
+    user: MemberDetailsProps;
+}
+export type GetUsers = (search: string) => Promise<IMention[]>;
+export interface IMentionPopOver {
+    show: boolean;
+    selectedUser: number;
+    possibleUsers: IMention[];
+    position: Range | null;
+}

package/general/index.d.ts

@@ -2,6 +2,7 @@ export * from './buttons';
 export * from './divider';
 export * from './image-container';
 export * from './link';
+export * from './popover';
 export * from './portal';
 export * from './progress-tracker';
 export * from './responsive-image';

package/general/popover/index.d.ts

@@ -0,0 +1 @@
+export { default as Popover } from './popover';

package/general/popover/popover.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+interface Props {
+    /** Additional className */
+    className?: string;
+    /** The content of the popover */
+    children: React.ReactNode;
+    /** Optional keydown event */
+    onKeyDown?: (e: React.KeyboardEvent<HTMLElement>) => void;
+}
+declare const _default: ({ className, children }: Props) => import("react/jsx-runtime").JSX.Element;
+export default _default;

package/helpers/intl.d.ts

@@ -146,8 +146,6 @@ export declare const checkIntlPathExists: (path: string, language?: {
     discussion_responses_empty: string;
     discussion_responses_empty_answer: string;
     discussion_responses_placeholder: string;
-    discussion_share_copy_link: string;
-    discussion_share_copy_link_success: string;
     discussion_thread_show: string;
     discussion_thread_hide: string;
     discussion_thread_loadMore: string;