@bigbinary/neeto-editor 1.16.4 → 1.17.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigbinary/neeto-editor",
-  "version": "1.16.4",
+  "version": "1.17.0",
   "main": "./index.js",
   "module": "./index.js",
   "types": "./types.d.ts",

package/types.d.ts

@@ -69,32 +69,45 @@ interface Config {
   placeholder?: Partial<PlaceholderOptions>;
 }
 
+interface tooltip {
+  label: string;
+  keys: string[];
+}
+
 interface tooltips {
-[key: string]: string;
+  [key: string]: tooltip;
 }
 
 interface MenuProps {
   tooltips?: tooltips;
-  editor: string;
+  editor: TiptapEditor | null;
   menuType?: "fixed" | "bubble" | "headless" | "none";
   defaults?: string[];
   addons?: string[];
   uploadEndpoint?: string;
   mentions?: Mention[];
-  variables: (VariableCategory | Variable)[];
+  editorSecrets?: Array<{ unsplash?: string }>;
+  variables?: (VariableCategory | Variable)[];
   addonCommands?: Command[];
   isIndependant?: boolean;
   className?: string;
 }
 
-type attachment = {
+interface attachment {
   filename?: string;
   signedId?: string;
   url?: string;
   [otherProps: string]: any;
 };
 
+interface attachmentsConfig {
+  maxFileSize?: number,
+  maxNumberOfFiles?: number,
+  allowedFileTypes?: string[],
+}
+
 interface EditorProps {
+  attachmentsConfig?: attachmentsConfig;
   tooltips?: tooltips;
   initialValue?: string;
   menuType?: "fixed" | "bubble" | "headless" | "none";
@@ -112,7 +125,7 @@ interface EditorProps {
   onFocus?: EditorFocus;
   onBlur?: EditorFocus;
   onSubmit?: (htmlContent: string) => void;
-  variables: (VariableCategory | Variable)[];
+  variables?: (VariableCategory | Variable)[];
   mentions?: Mention[];
   placeholder?: string;
   extensions?: Array<Node | Extension>;
@@ -123,7 +136,7 @@ interface EditorProps {
   error?: string;
   config?: Config;
   attachments?: Array<attachment>;
-  onChangeAttachments: (attachments: attachment[]) => void;
+  onChangeAttachments?: (attachments: attachment[]) => void;
   [otherProps: string]: any;
 }
 
@@ -131,10 +144,11 @@ interface FormikEditorProps extends EditorProps {
   name: string;
 }
 interface AttachmentsProps {
+  config?: attachmentsConfig;
   endpoint?: string;
   attachments?: Array<attachment>;
   dragDropRef?: React.RefObject<HTMLDivElement>;
-  onChange: (attachments: attachment[]) => void;
+  onChange?: (attachments: attachment[]) => void;
   isIndependent?: boolean;
   disabled?: boolean;
   className?: string;
@@ -149,10 +163,17 @@ export function Attachments(props: AttachmentsProps): JSX.Element;
 export function EditorContent(props: {
   content?: string;
   className?: string;
-  variables: (VariableCategory | Variable)[];
+  variables?: (VariableCategory | Variable)[];
   [otherProps: string]: any;
 }): JSX.Element;
 
 export function Menu(props: MenuProps): JSX.Element;
 
 export function isEditorEmpty(htmlContent: string | null | undefined): boolean;
+
+export function isEditorOverlaysActive(): boolean;
+
+export function substituteVariables(
+  highlightedContent: string,
+  variables: (VariableCategory | Variable)[]
+): string;