@contentful/field-editor-rich-text 2.0.2 → 2.1.0

package/dist/plugins/CommandPalette/components/CommandList.d.ts

@@ -0,0 +1,6 @@
+import { PlateEditor } from '@udecode/plate-core';
+export interface CommandListProps {
+    query: string;
+    editor: PlateEditor;
+}
+export declare const CommandList: ({ query, editor }: CommandListProps) => JSX.Element | null;

package/dist/plugins/CommandPalette/components/CommandList.styles.d.ts

@@ -0,0 +1,13 @@
+declare const styles: {
+    container: string;
+    menuContent: string;
+    menuList: string;
+    menuItem: string;
+    menuItemSelected: string;
+    menuDivider: string;
+    menuHeader: string;
+    menuFooter: string;
+    footerList: string;
+    thumbnail: string;
+};
+export default styles;

package/dist/plugins/CommandPalette/components/CommandPrompt.d.ts

@@ -0,0 +1,2 @@
+import { PlateRenderLeafProps } from '@udecode/plate-core';
+export declare const CommandPrompt: (props: PlateRenderLeafProps) => JSX.Element;

package/dist/plugins/CommandPalette/constants.d.ts

@@ -0,0 +1 @@
+export declare const COMMAND_PROMPT = "command-prompt";

package/dist/plugins/CommandPalette/createCommandPalettePlugin.d.ts

@@ -0,0 +1,13 @@
+import { RichTextPlugin } from '../../types';
+/**
+ * A command palette plugin (aka slash commands)
+ *
+ * How does it work?
+ * * When the user presses the slash key, the editor will show a command palette
+ * * When the user presses a key, the command palette will show the command suggestions
+ * * When the user presses enter, the command palette will execute the command
+ * * When the user presses escape, the command palette will hide
+ * * When the user presses a letter, number, or space, the command palette will show the command suggestions
+ * * When the user presses backspace, the command palette will remove the last character from the command string
+ */
+export declare const createCommandPalettePlugin: () => RichTextPlugin;

package/dist/plugins/CommandPalette/hooks/useCommandList.d.ts

@@ -0,0 +1,3 @@
+export declare const useCommandList: (commandItems: any, container: any) => {
+    selectedItem: string;
+};

package/dist/plugins/CommandPalette/index.d.ts

@@ -0,0 +1 @@
+export { createCommandPalettePlugin } from './createCommandPalettePlugin';

package/dist/plugins/CommandPalette/onKeyDown.d.ts

@@ -0,0 +1,3 @@
+import { KeyboardHandler } from '@udecode/plate-core';
+import { RichTextEditor } from '../../types';
+export declare const createOnKeyDown: () => KeyboardHandler<RichTextEditor>;

package/dist/plugins/CommandPalette/useCommands.d.ts

@@ -0,0 +1,14 @@
+import { FieldExtensionSDK } from '@contentful/app-sdk';
+import { PlateEditor } from '@udecode/plate-core';
+export interface Command {
+    id: string;
+    thumbnail?: string;
+    label: string;
+    callback?: () => void;
+}
+export interface CommandGroup {
+    group: string;
+    commands: Command[];
+}
+export declare type CommandList = (Command | CommandGroup)[];
+export declare const useCommands: (sdk: FieldExtensionSDK, query: string, editor: PlateEditor) => CommandList;

package/dist/plugins/CommandPalette/utils/createInlineEntryNode.d.ts

@@ -0,0 +1,16 @@
+import { INLINES } from '@contentful/rich-text-types';
+export declare function createInlineEntryNode(id: string): {
+    type: INLINES;
+    children: {
+        text: string;
+    }[];
+    data: {
+        target: {
+            sys: {
+                id: string;
+                type: string;
+                linkType: string;
+            };
+        };
+    };
+};

package/dist/plugins/CommandPalette/utils/fetchAssets.d.ts

@@ -0,0 +1,8 @@
+import { FieldExtensionSDK } from '@contentful/app-sdk';
+export declare function fetchAssets(sdk: FieldExtensionSDK, query: string): Promise<{
+    contentTypeName: string;
+    displayTitle: string;
+    id: string;
+    entity: import("@contentful/app-sdk").Asset;
+    thumbnail: string;
+}[]>;

package/dist/plugins/CommandPalette/utils/fetchEntries.d.ts

@@ -0,0 +1,9 @@
+import { FieldExtensionSDK } from '@contentful/app-sdk';
+import { ContentTypeProps } from 'contentful-management/types';
+export declare function fetchEntries(sdk: FieldExtensionSDK, contentType: ContentTypeProps, query: string): Promise<{
+    contentTypeName: string;
+    displayTitle: string;
+    id: string;
+    description: string;
+    entry: import("@contentful/app-sdk").Entry<unknown>;
+}[]>;

package/dist/plugins/CommandPalette/utils/insertBlock.d.ts

@@ -0,0 +1 @@
+export declare function insertBlock(editor: any, nodeType: any, entity: any): void;

package/dist/plugins/CommandPalette/utils/trimLeadingSlash.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Trim leading slash character if found. Bails otherwise.
+ *
+ * @example
+ * trimLeadingSlash("/my query") // --> "my query"
+ */
+export declare function trimLeadingSlash(text: string): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/field-editor-rich-text",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "source": "./src/index.tsx",
   "main": "./dist/index.js",
   "module": "dist/field-editor-rich-text.esm.js",
@@ -29,7 +29,7 @@
     "@contentful/f36-components": "^4.0.33",
     "@contentful/f36-icons": "^4.1.1",
     "@contentful/f36-tokens": "^4.0.0",
-    "@contentful/field-editor-reference": "^4.3.10",
+    "@contentful/field-editor-reference": "^4.3.11",
     "@contentful/field-editor-shared": "^1.1.3",
     "@contentful/rich-text-plain-text-renderer": "^15.12.1",
     "@contentful/rich-text-types": "^15.12.1",
@@ -70,5 +70,5 @@
     "@udecode/plate-test-utils": "^3.2.0",
     "react": ">=16.14.0"
   },
-  "gitHead": "1d89ccc17095a0d9deffe66b1992d14e248fdaf6"
+  "gitHead": "0a64b352a8e7f64c4ba35a1075beb32ac3d9b432"
 }

package/dist/plugins/CommandPalette/CommandPanel/InViewport/InViewport.d.ts

@@ -1,37 +0,0 @@
-export class InViewport extends React.Component<any, any, any> {
-    static defaultProps: {
-        testId: string;
-        offset: number;
-    };
-    constructor(props: any);
-    constructor(props: any, context: any);
-    tGetDomPosition: any;
-    nodeRef: any;
-    lastOverflowAt: any;
-    tOnOverflowTop: (...args: any[]) => any;
-    tOnOverflowBottom: (...args: any[]) => any;
-    tOnOverflowRight: (...args: any[]) => any;
-    tOnOverflowLeft: (...args: any[]) => any;
-    getDomPosition: () => void;
-    bindEventListeners: () => void;
-    handleOverflow: ({ top, left, bottom, right }: {
-        top: any;
-        left: any;
-        bottom: any;
-        right: any;
-    }, windowWidth: any, windowHeight: any) => void;
-}
-export namespace InViewport {
-    export namespace propTypes {
-        export const offset: PropTypes.Requireable<number>;
-        export const onOverflowTop: PropTypes.Requireable<(...args: any[]) => any>;
-        export const onOverflowRight: PropTypes.Requireable<(...args: any[]) => any>;
-        export const onOverflowBottom: PropTypes.Requireable<(...args: any[]) => any>;
-        export const onOverflowLeft: PropTypes.Requireable<(...args: any[]) => any>;
-        export const className: PropTypes.Requireable<string>;
-        export const children: PropTypes.Requireable<any>;
-        export const testId: PropTypes.Requireable<string>;
-    }
-}
-import React from "react";
-import PropTypes from "prop-types";

package/dist/plugins/EmbeddedEntryInline/FetchingWrappedInlineEntryCard.d.ts

@@ -1,14 +0,0 @@
-export function FetchingWrappedInlineEntryCard(props: any): JSX.Element;
-export namespace FetchingWrappedInlineEntryCard {
-    export namespace propTypes {
-        export const sdk: PropTypes.Validator<object>;
-        export const entryId: PropTypes.Validator<string>;
-        export const isDisabled: PropTypes.Validator<boolean>;
-        export const isSelected: PropTypes.Validator<boolean>;
-        export const isReadOnly: PropTypes.Validator<boolean>;
-        export const onRemove: PropTypes.Validator<(...args: any[]) => any>;
-        export const onEdit: PropTypes.Validator<(...args: any[]) => any>;
-        export const onEntityFetchComplete: PropTypes.Requireable<(...args: any[]) => any>;
-    }
-}
-import PropTypes from "prop-types";

package/dist/plugins/Hyperlink/Hyperlink.d.ts

@@ -1,13 +0,0 @@
-declare function Hyperlink(props: any): JSX.Element;
-declare namespace Hyperlink {
-    export namespace propTypes {
-        export const attributes: PropTypes.Validator<object>;
-        export const node: PropTypes.Validator<object>;
-        export const children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
-        export const editor: PropTypes.Requireable<object>;
-        export const richTextAPI: PropTypes.Validator<object>;
-        export const onEdit: PropTypes.Requireable<(...args: any[]) => any>;
-    }
-}
-export default Hyperlink;
-import PropTypes from "prop-types";

package/dist/plugins/SlashCommands/SlashCommandsPalette.d.ts

@@ -1,5 +0,0 @@
-interface SlashCommandsPaletteProps {
-    editorId: string;
-}
-export declare function SlashCommandsPalette({ editorId }: SlashCommandsPaletteProps): JSX.Element | null;
-export {};

package/dist/plugins/SlashCommands/createSlashCommandsPlugin.d.ts

@@ -1,2 +0,0 @@
-import { RichTextPlugin } from '../../types';
-export declare function createSlashCommandsPlugin(): RichTextPlugin;

package/dist/plugins/SlashCommands/helpers.d.ts

@@ -1,6 +0,0 @@
-export declare function getCaretTopPoint(): {
-    left: any;
-    top: any;
-} | undefined;
-export declare function closePanel(editorId: string): void;
-export declare function openPanel(editorId: string): void;

package/dist/plugins/SlashCommands/index.d.ts

@@ -1,2 +0,0 @@
-export * from './createSlashCommandsPlugin';
-export * from './SlashCommandsPalette';