@apolitical/component-library 4.1.4 → 4.1.5

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

@@ -1,3 +1,3 @@
-import { BlockOptionType, MarkOptionType } from '../../../../../form/components/rich-text-editor/rich-text-editor.types';
+import { BlockOptionType, MarkOptionType } from './../../rich-text-editor.types';
 export declare const marks: MarkOptionType[];
 export declare const blocks: BlockOptionType[];

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

@@ -1,12 +1,13 @@
+import { Formatting, Marks } from './../../rich-text-editor.types';
 export interface NodeTypes {
-    paragraph: string;
-    block_quote: string;
-    code_block: string;
-    link: string;
-    ul_list: string;
-    ol_list: string;
-    listItem: string;
-    heading: {
+    [Formatting.paragraph]: string;
+    [Formatting.blockquote]: string;
+    [Formatting.codeblock]: string;
+    [Formatting.link]: string;
+    [Formatting.ul]: string;
+    [Formatting.ol]: string;
+    [Formatting.li]: string;
+    [Formatting.heading]: {
         1: string;
         2: string;
         3: string;
@@ -14,21 +15,38 @@ export interface NodeTypes {
         5: string;
         6: string;
     };
-    emphasis_mark: string;
-    strong_mark: string;
-    delete_mark: string;
-    inline_code_mark: string;
-    thematic_break: string;
-    image: string;
+    [Marks.emphasis]: string;
+    [Marks.strong]: string;
+    [Marks.delete]: string;
+    [Marks.code]: string;
+    [Formatting.hr]: string;
+    [Formatting.image]: string;
 }
-export type MdastNodeType = 'paragraph' | 'heading' | 'list' | 'listItem' | 'link' | 'image' | 'blockquote' | 'code' | 'html' | 'emphasis' | 'strong' | 'delete' | 'inlineCode' | 'thematicBreak' | 'text';
+export declare enum MdastNodes {
+    paragraph = "paragraph",
+    heading = "heading",
+    list = "list",
+    listItem = "listItem",
+    link = "link",
+    image = "image",
+    blockquote = "blockquote",
+    code = "code",
+    html = "html",
+    emphasis = "emphasis",
+    strong = "strong",
+    delete = "delete",
+    inlineCode = "inlineCode",
+    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 declare const defaultNodeTypes: NodeTypes;
 export interface LeafType {
     text: string;
-    strikeThrough?: boolean;
-    bold?: boolean;
-    italic?: boolean;
-    code?: boolean;
+    [Formatting.strikethrough]?: boolean;
+    [Formatting.bold]?: boolean;
+    [Formatting.italic]?: boolean;
+    [Formatting.code]?: boolean;
     parentType?: string;
 }
 export interface BlockType {
@@ -41,14 +59,14 @@ export interface BlockType {
     children: Array<BlockType | LeafType>;
 }
 export interface InputNodeTypes {
-    paragraph: string;
-    block_quote: string;
-    code_block: string;
-    link: string;
-    ul_list: string;
-    ol_list: string;
-    listItem: string;
-    heading: {
+    [Formatting.paragraph]: string;
+    [Formatting.blockquote]: string;
+    [Formatting.codeblock]: string;
+    [Formatting.link]: string;
+    [Formatting.ul]: string;
+    [Formatting.ol]: string;
+    [Formatting.li]: string;
+    [Formatting.heading]: {
         1: string;
         2: string;
         3: string;
@@ -56,12 +74,12 @@ export interface InputNodeTypes {
         5: string;
         6: string;
     };
-    emphasis_mark: string;
-    strong_mark: string;
-    delete_mark: string;
-    inline_code_mark: string;
-    thematic_break: string;
-    image: string;
+    [Marks.emphasis]: string;
+    [Marks.strong]: string;
+    [Marks.delete]: string;
+    [Marks.code]: string;
+    [Formatting.hr]: string;
+    [Formatting.image]: string;
 }
 type RecursivePartial<T> = {
     [P in keyof T]?: RecursivePartial<T[P]>;
@@ -91,65 +109,65 @@ export type TextNode = {
     text?: string | undefined;
 };
 export type CodeBlockNode<T extends InputNodeTypes> = {
-    type: T['code_block'];
+    type: T[Formatting.codeblock];
     language: string | undefined;
     children: Array<TextNode>;
 };
 export type HeadingNode<T extends InputNodeTypes> = {
-    type: T['heading'][1] | T['heading'][2] | T['heading'][3] | T['heading'][4] | T['heading'][5] | T['heading'][6];
+    type: T[Formatting.heading][1] | T[Formatting.heading][2] | T[Formatting.heading][3] | T[Formatting.heading][4] | T[Formatting.heading][5] | T[Formatting.heading][6];
     children: Array<DeserializedNode<T>>;
 };
 export type ListNode<T extends InputNodeTypes> = {
-    type: T['ol_list'] | T['ul_list'];
+    type: T[Formatting.ol] | T[Formatting.ul];
     children: Array<DeserializedNode<T>>;
 };
 export type ListItemNode<T extends InputNodeTypes> = {
-    type: T['listItem'];
+    type: T[Formatting.li];
     children: Array<DeserializedNode<T>>;
 };
 export type ParagraphNode<T extends InputNodeTypes> = {
-    type: T['paragraph'];
+    type: T[Formatting.paragraph];
     break?: true;
     children: Array<DeserializedNode<T>>;
 };
 export type LinkNode<T extends InputNodeTypes> = {
-    type: T['link'];
+    type: T[Formatting.link];
     children: Array<DeserializedNode<T>>;
     [urlKey: string]: string | undefined | Array<DeserializedNode<T>>;
 };
 export type ImageNode<T extends InputNodeTypes> = {
-    type: T['image'];
+    type: T[Formatting.image];
     children: Array<DeserializedNode<T>>;
     [sourceOrCaptionKey: string]: string | undefined | Array<DeserializedNode<T>>;
 };
 export type BlockQuoteNode<T extends InputNodeTypes> = {
-    type: T['block_quote'];
+    type: T[Formatting.blockquote];
     children: Array<DeserializedNode<T>>;
 };
 export type InlineCodeMarkNode<T extends InputNodeTypes> = {
-    type: T['inline_code_mark'];
+    type: T[Marks.code];
     children: Array<TextNode>;
     language: string | undefined;
 };
 export type ThematicBreakNode<T extends InputNodeTypes> = {
-    type: T['thematic_break'];
+    type: T[Formatting.hr];
     children: Array<DeserializedNode<T>>;
 };
 export type ItalicNode<T extends InputNodeTypes> = {
-    [K in T['emphasis_mark']]: true;
+    [K in T[Marks.emphasis]]: true;
 } & {
     children: TextNode;
 };
 export type BoldNode = {
-    bold: true;
+    [Formatting.bold]: true;
     children: TextNode;
 };
 export type StrikeThoughNode = {
-    strikeThrough: true;
+    [Formatting.strikethrough]: true;
     children: TextNode;
 };
 export type InlineCodeNode = {
-    code: true;
+    [Formatting.code]: true;
     text: string | undefined;
 };
 export type DeserializedNode<T extends InputNodeTypes> = CodeBlockNode<T> | HeadingNode<T> | ListNode<T> | ListItemNode<T> | ParagraphNode<T> | LinkNode<T> | ImageNode<T> | BlockQuoteNode<T> | InlineCodeMarkNode<T> | ThematicBreakNode<T> | ItalicNode<T> | BoldNode | StrikeThoughNode | InlineCodeNode | TextNode;

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

@@ -1,6 +1,7 @@
+import { Formatting } from './../../rich-text-editor.types';
 import { BlockQuoteNode, CodeBlockNode, HeadingNode, ImageNode, InputNodeTypes, ItalicNode, LinkNode, ListItemNode, ListNode, MdastNode, OptionType, ParagraphNode, ThematicBreakNode } from './../ast-types';
 export default function transform<T extends InputNodeTypes>(node: MdastNode, opts?: OptionType<T>): CodeBlockNode<T> | HeadingNode<T> | ListNode<T> | ListItemNode<T> | ParagraphNode<T> | LinkNode<T> | ImageNode<T> | BlockQuoteNode<T> | ThematicBreakNode<T> | ItalicNode<T> | {
-    type: string;
+    type: Formatting;
     children: {
         text: string;
     }[];

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

@@ -1,24 +1,47 @@
 import { BaseElement, BaseText, Descendant } from 'slate';
+export declare enum Formatting {
+    blockquote = "block_quote",
+    bold = "bold",
+    code = "code",
+    codeblock = "code_block",
+    heading = "heading",
+    hr = "thematic_break",
+    image = "image",
+    italic = "italic",
+    li = "list_item",
+    link = "link",
+    ol = "ol_list",
+    paragraph = "paragraph",
+    ul = "ul_list",
+    strikethrough = "strikeThrough",
+    span = "span"
+}
+export declare enum Marks {
+    delete = "delete_mark",
+    emphasis = "emphasis_mark",
+    code = "inline_code_mark",
+    strong = "strong_mark"
+}
 export interface BaseProps {
     className?: string;
     [key: string]: unknown;
 }
-export type BlockOptionType = 'block_quote' | 'link' | 'list_item' | 'ol_list' | 'ul_list' | 'paragraph' | 'span';
+export type BlockOptionType = Formatting.blockquote | Formatting.link | Formatting.li | Formatting.ol | Formatting.ul | Formatting.paragraph | Formatting.span;
 export interface TypeElement extends BaseElement {
     type: BlockOptionType;
 }
-export type MarkOptionType = 'bold' | 'italic' | 'strikeThrough';
+export type MarkOptionType = Formatting.bold | Formatting.italic | Formatting.strikethrough;
 export interface TypeText extends BaseText {
-    bold?: boolean;
-    italic?: boolean;
-    strikeThrough?: boolean;
+    [Formatting.bold]?: boolean;
+    [Formatting.italic]?: boolean;
+    [Formatting.strikethrough]?: boolean;
 }
 export type OptionTypes = {
     format: BlockOptionType | MarkOptionType;
     hasDivider?: boolean;
 };
 export type LinkElement = {
-    type: 'link';
+    type: Formatting.link;
     link: string;
     children: Descendant[];
 };