@apolitical/component-library 5.2.2 → 5.3.0

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

@@ -1,6 +1,7 @@
 import { Dispatch } from 'react';
 import { Point } from 'slate';
 import { IListMemberData } from '../../../../../discussion';
+import type { IEnrichedUrlData } from '../../../../../navigation';
 import { ReportError, IMentionPopOver } from './../../rich-text-editor.types';
 declare const RichTextEditorContext: import("react").Context<{
     /** The id of the editor */
@@ -19,8 +20,12 @@ declare const RichTextEditorContext: import("react").Context<{
     lastAnchor: Point | null;
     /** Whether the editor is inside a modal, used to handle portals for focus trap */
     isInOverlay?: string | false | undefined;
+    /** The data for the first link, to be displayed in the EnrichedUrl component. `undefined` is not set, `false` will not show the enriched url. (For cases where the user has manually removed it.) */
+    enrichedUrl?: IEnrichedUrlData | false | undefined;
     /** An optional function to call when a mention is inserted */
     onMention?: ((value?: IListMemberData) => void) | undefined;
+    /** The function to get metadata about a link */
+    getLinkPreview?: ((url: string) => Promise<IEnrichedUrlData>) | undefined;
     /** The function to update the state */
     dispatch: Dispatch<any>;
     /** The function to report an error */

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

@@ -1,3 +1,4 @@
 import { BaseEditor } from 'slate';
 export declare const getSelectedText: (editor: BaseEditor) => string | null;
 export declare const getAllText: (editor: BaseEditor) => string;
+export declare const firstLinkData: (editor: BaseEditor) => string | null;

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

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

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

@@ -1,3 +1,4 @@
+export * from './with-link-removal-listener';
 export * from './with-linlines';
 export * from './with-mentions';
 export * from './without-empty-links';

package/form/components/rich-text-editor/plugins/with-link-removal-listener/index.d.ts

@@ -0,0 +1 @@
+export { default as withLinkRemovalListener } from './with-link-removal-listener';

package/form/components/rich-text-editor/plugins/with-link-removal-listener/with-link-removal-listener.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 withLinkRemovalListener: (editor: BaseEditor & ReactEditor & HistoryEditor, reportError: ReportError) => BaseEditor & ReactEditor & HistoryEditor;
+export default withLinkRemovalListener;

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

@@ -1,43 +1,3 @@
-import type { IMentions, IListMemberData } from '../../../discussion/discussion';
-import { ListMembers, ReportError, ClickMentionFallback } from './rich-text-editor.types';
-interface Props {
-    /** The id of the rich text editor */
-    id?: string;
-    /** The default value of the rich text editor */
-    value?: string;
-    /** The placeholder text of the rich text editor */
-    placeholder?: string;
-    /** The maximum length of the rich text editor */
-    maxLength?: number;
-    /** Information about the rich text editor */
-    meta?: {
-        /** Whether the rich text editor is inside a modal */
-        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 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;
-    };
-    /** Optional autoFocus */
-    autoFocus?: boolean;
-    /** Optional aria invalid */
-    '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, meta, functions, autoFocus, data, ...props }: Props) => import("react/jsx-runtime").JSX.Element;
+import { IRTEProps } from './rich-text-editor.types';
+declare const RichTextEditor: ({ id, value, placeholder, maxLength, meta, functions, autoFocus, data, ...props }: IRTEProps) => import("react/jsx-runtime").JSX.Element;
 export default RichTextEditor;

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

@@ -1,6 +1,69 @@
-import { BaseElement, BaseText, Descendant, Range } from 'slate';
-import type { IListMemberData } from '../../../discussion';
+import { BaseElement, BaseText, Descendant, Point, Range } from 'slate';
+import type { IListMemberData, IMentions } from '../../../discussion';
 import type { MemberDetailsProps } from '../../../user';
+import type { IEnrichedUrlData } from '../../../navigation';
+export interface IRTEProps {
+    /** The id of the rich text editor */
+    id?: string;
+    /** The default value of the rich text editor */
+    value?: string;
+    /** The placeholder text of the rich text editor */
+    placeholder?: string;
+    /** The maximum length of the rich text editor */
+    maxLength?: number;
+    /** Information about the rich text editor */
+    meta?: {
+        /** Whether the rich text editor is inside a modal */
+        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;
+    };
+    /** Optional autoFocus */
+    autoFocus?: boolean;
+    /** Optional aria invalid */
+    'aria-invalid'?: boolean;
+    /**  Optional aria error message */
+    'aria-errormessage'?: string;
+    /** Optional data for the editor */
+    data?: {
+        /** Optional mentions */
+        mentions?: IMentions;
+        /** Optional data about the first link, to be displayed in the EnrichedUrl component */
+        link?: IEnrichedUrlData;
+    };
+}
+export interface IRTEInitialState {
+    editorKey: string | null;
+    originalValue: string | null;
+    initialValue: Descendant[] | null;
+    tabbableOption: string;
+    openTooltip: string | null;
+    showLinkEditor: boolean;
+    mentionPopover: IMentionPopOver;
+    lastAnchor: Point | null;
+    stringValue: string;
+    lastKey: string | null;
+    hasInteracted: boolean;
+    hasLoaded: boolean;
+    enrichedUrl: IEnrichedUrlData | false | undefined;
+}
+export interface IRTEReducer {
+    type: keyof IRTEInitialState;
+    value: any;
+}
 export declare enum Formatting {
     blockquote = "block_quote",
     bold = "bold",

package/helpers/intl.d.ts

@@ -286,6 +286,9 @@ export declare const checkIntlPathExists: (path: string, language?: {
     richTextEditor_link_edit: string;
     richTextEditor_link_remove: string;
     richTextEditor_link_button: string;
+    richTextEditor_link_enrichedUrl_aria: string;
+    richTextEditor_link_enrichedUrl_aria_fallback: string;
+    richTextEditor_link_enrichedUrl_aria_live: string;
     richTextEditor_ol_list: string;
     richTextEditor_ul_list: string;
     richTextEditor_block_quote: string;