prosemirror-slash-menu 0.0.1

package/README.md

@@ -0,0 +1 @@
+TODO

package/dist/actions.d.ts

@@ -0,0 +1,23 @@
+import { SlashMenuMeta, SlashMenuState } from "./types";
+export declare const openSubMenu: (state: SlashMenuState, meta: SlashMenuMeta) => SlashMenuState;
+export declare const closeSubMenu: (state: SlashMenuState, meta: SlashMenuMeta, initialState: SlashMenuState) => SlashMenuState;
+export declare const nextItem: (state: SlashMenuState) => SlashMenuState;
+export declare const prevItem: (state: SlashMenuState) => SlashMenuState;
+export declare const filterItems: (state: SlashMenuState, filter: string) => {
+    filter: string;
+    selected: string;
+    filteredElements: import("./types").MenuElement[];
+    open: boolean;
+    subMenuId?: string | undefined;
+    elements: import("./types").MenuElement[];
+    ignoredKeys: string[];
+};
+export declare const updateInput: (state: SlashMenuState, meta: SlashMenuMeta, initialState: SlashMenuState) => {
+    filteredElements: import("./types").MenuElement[];
+    filter: string;
+    selected: string;
+    open: boolean;
+    subMenuId?: string | undefined;
+    elements: import("./types").MenuElement[];
+    ignoredKeys: string[];
+};

package/dist/cases.d.ts

@@ -0,0 +1,14 @@
+import { EditorView } from "prosemirror-view";
+import { SlashMenuState } from "./types";
+export declare enum SlashCases {
+    OpenMenu = "openMenu",
+    CloseMenu = "closeMenu",
+    Execute = "Execute",
+    NextItem = "NextItem",
+    PrevItem = "PrevItem",
+    inputChange = "InputChange",
+    addChar = "addChar",
+    removeChar = "removeChar",
+    Ignore = "Ignore"
+}
+export declare const getCase: (state: SlashMenuState, event: KeyboardEvent, view: EditorView) => SlashCases;

package/dist/enums.d.ts

@@ -0,0 +1,10 @@
+export declare enum SlashMetaTypes {
+    open = "open",
+    close = "close",
+    execute = "execute",
+    nextItem = "nextItem",
+    prevItem = "prevItem",
+    openSubMenu = "openSubMenu",
+    closeSubMenu = "closeSubMenu",
+    inputChange = "inputChange"
+}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+import { SlashMenuPlugin, SlashMenuKey } from "./plugin";
+import { dispatchWithMeta, getElementById, ignoredKeys } from "./utils";
+import { SlashMenuState, SlashMenuMeta, SubMenu, MenuElement, MenuItem, ItemId, CommandItem, ItemType } from "./types";
+import { SlashMetaTypes } from "./enums";
+export { SlashMenuPlugin, SlashMenuKey, SlashMetaTypes, dispatchWithMeta, getElementById, ignoredKeys, SlashMenuState, SlashMenuMeta, SubMenu, MenuElement, MenuItem, ItemId, CommandItem, ItemType, };

package/dist/index.es.js

@@ -0,0 +1 @@
+import{PluginKey as e,Plugin as t}from"prosemirror-state";const n=e=>"submenu"===e.type?[e.id,...e.elements.map((e=>n(e)))].flat():[e.id],r=e=>{const t=(e=>e.filteredElements.map((e=>n(e))).flat())(e);return t.length!==new Set(t).size},s=e=>"submenu"===e.type?[e,...e.elements.map((e=>s(e)))].flat():[e],l=e=>e.elements.map((e=>s(e))).flat(),u=(e,t)=>l(t).find((t=>t.id===e)),i=(e,t,n="root")=>{let r="root";return t.forEach((t=>{if("submenu"===t.type){t.id===e&&(r=n);const s=t.elements.map((e=>e.id));r=s.includes(e)?t.id:i(e,t.elements,t.id)}t.id===e&&(r=n)})),r},o=(e,t,n)=>e.dispatch(e.state.tr.setMeta(t,n)),c=(e,t)=>{const n=new RegExp(`${t.toLowerCase().replace(/\s/g,"\\s")}`);return l(e).map((e=>e)).filter((e=>null!==e.label.toLowerCase().match(n)&&"submenu"!==e.type))},a=["Shift","Alt","Control","Pause","CapsLock","Escape","PageUp","PageDown","End","Home","PrintScreen","Insert","Delete","Meta","ContextMenu","F1","F2","F3","F4","F5","F6","F7","F8","F9","F10","NumLock","ScrollLock","AudioVolumeMute","AudioVolumeDown","AudioVolumeUp","LaunchMediaPlayer","LaunchApplication1","LaunchApplication2","ArrowUp","ArrowDown","ArrowLeft","ArrowRight"];var d;!function(e){e.OpenMenu="openMenu",e.CloseMenu="closeMenu",e.Execute="Execute",e.NextItem="NextItem",e.PrevItem="PrevItem",e.inputChange="InputChange",e.addChar="addChar",e.removeChar="removeChar",e.Ignore="Ignore"}(d||(d={}));const m=(e,t,n)=>{const r=n.state,s=r.selection.from<0||r.selection.from>r.doc.content.size?null:r.doc.resolve(r.selection.from),l=null==s?void 0:s.parent,u="paragraph"===(null==l?void 0:l.type.name)&&2===(null==l?void 0:l.nodeSize);return!e.open&&"/"===t.key&&u},p=(e,t)=>e.open&&("/"===t.key||"Escape"===t.key||"Backspace"===t.key)&&0===e.filter.length,f=e=>{const t=(e=>{const t=i(e.selected,e.filteredElements),n=u(t,e);if("root"===t){const t=e.filteredElements.findIndex((t=>t.id===e.selected))+1;if(t<e.filteredElements.length)return e.filteredElements[t].id}if(n&&"submenu"===n.type){const t=n.elements.findIndex((t=>t.id===e.selected))+1;if(t<n.elements.length)return n.elements[t].id}})(e);return t?Object.assign(Object.assign({},e),{selected:t}):e},y=e=>{const t=(e=>{const t=i(e.selected,e.filteredElements),n=u(t,e);if("root"===t){const t=e.filteredElements.findIndex((t=>t.id===e.selected))-1;if(t>=0)return e.filteredElements[t].id}if(n&&"submenu"===n.type){const t=n.elements.findIndex((t=>t.id===e.selected))-1;if(t>=0)return n.elements[t].id}})(e);return t?Object.assign(Object.assign({},e),{selected:t}):e};var g;!function(e){e.open="open",e.close="close",e.execute="execute",e.nextItem="nextItem",e.prevItem="prevItem",e.openSubMenu="openSubMenu",e.closeSubMenu="closeSubMenu",e.inputChange="inputChange"}(g||(g={}));const b=new e("slash-menu-plugin"),h=e=>{const n=Object.assign(Object.assign({},e),{elements:e.filteredElements,ignoredKeys:e.ignoredKeys});if(r(n))throw new Error("Menu elements must have unique id's!");return new t({key:b,props:{handleKeyDown(e,t){const r=e.state,s=b.getState(r);if(!s)return!1;const l=((e,t,n)=>{const r=u(e.selected,e);if(m(e,t,n))return d.OpenMenu;if(p(e,t))return d.CloseMenu;if(e.open){if("ArrowDown"===t.key)return d.NextItem;if("ArrowUp"===t.key)return d.PrevItem;if("Enter"===t.key||"Tab"===t.key||"ArrowRight"===t.key&&"submenu"===(null==r?void 0:r.type))return d.Execute;if("Escape"===t.key||"Backspace"===t.key&&0===e.filter.length||"ArrowLeft"===t.key&&e.subMenuId)return d.CloseMenu;if(e.filter.length>0&&"Backspace"===t.key)return d.removeChar;if(!a.includes(t.key))return d.addChar}return d.Ignore})(s,t,e);switch(l){case d.OpenMenu:return o(e,b,{type:g.open}),!0;case d.CloseMenu:{const{subMenuId:l}=s;return l?o(e,b,{type:g.closeSubMenu,element:u(l,n)}):"/"===t.key?e.dispatch(r.tr.insertText("/").setMeta(b,{type:g.close})):o(e,b,{type:g.close}),!0}case d.Execute:{const t=u(s.selected,s);return!!t&&("command"===t.type&&(t.command(e),o(e,b,{type:g.execute})),"submenu"===t.type&&o(e,b,{type:g.openSubMenu,element:t}),!0)}case d.NextItem:return o(e,b,{type:g.nextItem}),!0;case d.PrevItem:return o(e,b,{type:g.prevItem}),!0;case d.addChar:return o(e,b,{type:g.inputChange,filter:s.filter+t.key}),!0;case d.removeChar:{const t=1===s.filter.length?"":s.filter.slice(0,-1);return o(e,b,{type:g.inputChange,filter:t}),!0}default:return!1}}},state:{init:()=>n,apply(e,t){const r=e.getMeta(b);switch(null==r?void 0:r.type){case g.open:return Object.assign(Object.assign({},n),{open:!0});case g.close:case g.execute:return n;case g.openSubMenu:return((e,t)=>{const n=t.element;return"submenu"===(null==n?void 0:n.type)?Object.assign(Object.assign({},e),{filteredElements:n.elements,selected:n.elements[0].id,subMenuId:n.id}):e})(t,r);case g.closeSubMenu:return((e,t,n)=>{const r=t.element;if("submenu"===(null==r?void 0:r.type)){const t=i(r.id,n.filteredElements);if("root"===t)return Object.assign(Object.assign({},n),{open:!0});const s=u(t,n);return"submenu"!==(null==s?void 0:s.type)?e:Object.assign(Object.assign({},e),{filteredElements:s.elements,selected:s.elements[0].id,subMenuId:t})}return e})(t,r,n);case g.nextItem:return f(t);case g.prevItem:return y(t);case g.inputChange:return Object.assign(Object.assign({},t),{filteredElements:r.filter?c(n,r.filter):n.elements,filter:r.filter||""});default:return t}}},initialState:n})};export{b as SlashMenuKey,h as SlashMenuPlugin,g as SlashMetaTypes,o as dispatchWithMeta,u as getElementById,a as ignoredKeys};

package/dist/index.js

@@ -0,0 +1 @@
+"use strict";var e=require("prosemirror-state");const t=e=>"submenu"===e.type?[e.id,...e.elements.map((e=>t(e)))].flat():[e.id],n=e=>{const n=(e=>e.filteredElements.map((e=>t(e))).flat())(e);return n.length!==new Set(n).size},s=e=>"submenu"===e.type?[e,...e.elements.map((e=>s(e)))].flat():[e],r=e=>e.elements.map((e=>s(e))).flat(),l=(e,t)=>r(t).find((t=>t.id===e)),a=(e,t,n="root")=>{let s="root";return t.forEach((t=>{if("submenu"===t.type){t.id===e&&(s=n);const r=t.elements.map((e=>e.id));s=r.includes(e)?t.id:a(e,t.elements,t.id)}t.id===e&&(s=n)})),s},o=(e,t,n)=>e.dispatch(e.state.tr.setMeta(t,n)),u=(e,t)=>{const n=new RegExp(`${t.toLowerCase().replace(/\s/g,"\\s")}`);return r(e).map((e=>e)).filter((e=>null!==e.label.toLowerCase().match(n)&&"submenu"!==e.type))},i=["Shift","Alt","Control","Pause","CapsLock","Escape","PageUp","PageDown","End","Home","PrintScreen","Insert","Delete","Meta","ContextMenu","F1","F2","F3","F4","F5","F6","F7","F8","F9","F10","NumLock","ScrollLock","AudioVolumeMute","AudioVolumeDown","AudioVolumeUp","LaunchMediaPlayer","LaunchApplication1","LaunchApplication2","ArrowUp","ArrowDown","ArrowLeft","ArrowRight"];var p;!function(e){e.OpenMenu="openMenu",e.CloseMenu="closeMenu",e.Execute="Execute",e.NextItem="NextItem",e.PrevItem="PrevItem",e.inputChange="InputChange",e.addChar="addChar",e.removeChar="removeChar",e.Ignore="Ignore"}(p||(p={}));const c=(e,t,n)=>{const s=n.state,r=s.selection.from<0||s.selection.from>s.doc.content.size?null:s.doc.resolve(s.selection.from),l=null==r?void 0:r.parent,a="paragraph"===(null==l?void 0:l.type.name)&&2===(null==l?void 0:l.nodeSize);return!e.open&&"/"===t.key&&a},d=(e,t)=>e.open&&("/"===t.key||"Escape"===t.key||"Backspace"===t.key)&&0===e.filter.length,m=e=>{const t=(e=>{const t=a(e.selected,e.filteredElements),n=l(t,e);if("root"===t){const t=e.filteredElements.findIndex((t=>t.id===e.selected))+1;if(t<e.filteredElements.length)return e.filteredElements[t].id}if(n&&"submenu"===n.type){const t=n.elements.findIndex((t=>t.id===e.selected))+1;if(t<n.elements.length)return n.elements[t].id}})(e);return t?Object.assign(Object.assign({},e),{selected:t}):e},y=e=>{const t=(e=>{const t=a(e.selected,e.filteredElements),n=l(t,e);if("root"===t){const t=e.filteredElements.findIndex((t=>t.id===e.selected))-1;if(t>=0)return e.filteredElements[t].id}if(n&&"submenu"===n.type){const t=n.elements.findIndex((t=>t.id===e.selected))-1;if(t>=0)return n.elements[t].id}})(e);return t?Object.assign(Object.assign({},e),{selected:t}):e};var f;exports.SlashMetaTypes=void 0,(f=exports.SlashMetaTypes||(exports.SlashMetaTypes={})).open="open",f.close="close",f.execute="execute",f.nextItem="nextItem",f.prevItem="prevItem",f.openSubMenu="openSubMenu",f.closeSubMenu="closeSubMenu",f.inputChange="inputChange";const h=new e.PluginKey("slash-menu-plugin");exports.SlashMenuKey=h,exports.SlashMenuPlugin=t=>{const s=Object.assign(Object.assign({},t),{elements:t.filteredElements,ignoredKeys:t.ignoredKeys});if(n(s))throw new Error("Menu elements must have unique id's!");return new e.Plugin({key:h,props:{handleKeyDown(e,t){const n=e.state,r=h.getState(n);if(!r)return!1;const a=((e,t,n)=>{const s=l(e.selected,e);if(c(e,t,n))return p.OpenMenu;if(d(e,t))return p.CloseMenu;if(e.open){if("ArrowDown"===t.key)return p.NextItem;if("ArrowUp"===t.key)return p.PrevItem;if("Enter"===t.key||"Tab"===t.key||"ArrowRight"===t.key&&"submenu"===(null==s?void 0:s.type))return p.Execute;if("Escape"===t.key||"Backspace"===t.key&&0===e.filter.length||"ArrowLeft"===t.key&&e.subMenuId)return p.CloseMenu;if(e.filter.length>0&&"Backspace"===t.key)return p.removeChar;if(!i.includes(t.key))return p.addChar}return p.Ignore})(r,t,e);switch(a){case p.OpenMenu:return o(e,h,{type:exports.SlashMetaTypes.open}),!0;case p.CloseMenu:{const{subMenuId:a}=r;return a?o(e,h,{type:exports.SlashMetaTypes.closeSubMenu,element:l(a,s)}):"/"===t.key?e.dispatch(n.tr.insertText("/").setMeta(h,{type:exports.SlashMetaTypes.close})):o(e,h,{type:exports.SlashMetaTypes.close}),!0}case p.Execute:{const t=l(r.selected,r);return!!t&&("command"===t.type&&(t.command(e),o(e,h,{type:exports.SlashMetaTypes.execute})),"submenu"===t.type&&o(e,h,{type:exports.SlashMetaTypes.openSubMenu,element:t}),!0)}case p.NextItem:return o(e,h,{type:exports.SlashMetaTypes.nextItem}),!0;case p.PrevItem:return o(e,h,{type:exports.SlashMetaTypes.prevItem}),!0;case p.addChar:return o(e,h,{type:exports.SlashMetaTypes.inputChange,filter:r.filter+t.key}),!0;case p.removeChar:{const t=1===r.filter.length?"":r.filter.slice(0,-1);return o(e,h,{type:exports.SlashMetaTypes.inputChange,filter:t}),!0}default:return!1}}},state:{init:()=>s,apply(e,t){const n=e.getMeta(h);switch(null==n?void 0:n.type){case exports.SlashMetaTypes.open:return Object.assign(Object.assign({},s),{open:!0});case exports.SlashMetaTypes.close:case exports.SlashMetaTypes.execute:return s;case exports.SlashMetaTypes.openSubMenu:return((e,t)=>{const n=t.element;return"submenu"===(null==n?void 0:n.type)?Object.assign(Object.assign({},e),{filteredElements:n.elements,selected:n.elements[0].id,subMenuId:n.id}):e})(t,n);case exports.SlashMetaTypes.closeSubMenu:return((e,t,n)=>{const s=t.element;if("submenu"===(null==s?void 0:s.type)){const t=a(s.id,n.filteredElements);if("root"===t)return Object.assign(Object.assign({},n),{open:!0});const r=l(t,n);return"submenu"!==(null==r?void 0:r.type)?e:Object.assign(Object.assign({},e),{filteredElements:r.elements,selected:r.elements[0].id,subMenuId:t})}return e})(t,n,s);case exports.SlashMetaTypes.nextItem:return m(t);case exports.SlashMetaTypes.prevItem:return y(t);case exports.SlashMetaTypes.inputChange:return Object.assign(Object.assign({},t),{filteredElements:n.filter?u(s,n.filter):s.elements,filter:n.filter||""});default:return t}}},initialState:s})},exports.dispatchWithMeta=o,exports.getElementById=l,exports.ignoredKeys=i;

package/dist/keyHandlers.d.ts

@@ -0,0 +1,6 @@
+import { EditorView } from "prosemirror-view";
+import { SlashMenuState } from "./types";
+export declare const keyHandlers: {
+    execute: (view: EditorView, state: SlashMenuState) => boolean;
+    closeMenu: (view: EditorView, state: SlashMenuState, initialState: SlashMenuState, event: KeyboardEvent) => boolean;
+};

package/dist/plugin.d.ts

@@ -0,0 +1,4 @@
+import { Plugin, PluginKey } from "prosemirror-state";
+import { SlashMenuState } from "./types";
+export declare const SlashMenuKey: PluginKey<SlashMenuState>;
+export declare const SlashMenuPlugin: (config: Partial<SlashMenuState>) => Plugin<SlashMenuState>;

package/dist/types.d.ts

@@ -0,0 +1,34 @@
+import { EditorView } from "prosemirror-view";
+import { SlashMetaTypes } from "./enums";
+export type ItemId = string | "root";
+export type ItemType = "command" | "submenu";
+export type MenuItem = {
+    id: ItemId;
+    label: string;
+    type: ItemType;
+};
+export interface CommandItem extends MenuItem {
+    type: "command";
+    command: (view: EditorView) => void;
+    available: () => boolean;
+}
+export type MenuElement = CommandItem | SubMenu;
+export interface SubMenu extends MenuItem {
+    type: "submenu";
+    elements: MenuElement[];
+    sideEffect?: () => void;
+}
+export type SlashMenuState = {
+    selected: ItemId;
+    filteredElements: MenuElement[];
+    open: boolean;
+    subMenuId?: ItemId;
+    filter: string;
+    elements: MenuElement[];
+    ignoredKeys: string[];
+};
+export interface SlashMenuMeta {
+    type: SlashMetaTypes;
+    element?: MenuElement;
+    filter?: string;
+}

package/dist/utils.d.ts

@@ -0,0 +1,14 @@
+import { EditorView } from "prosemirror-view";
+import { PluginKey } from "prosemirror-state";
+import { ItemId, MenuElement, SlashMenuMeta, SlashMenuState } from "./types";
+export declare const getElementIds: (item: MenuElement) => ItemId[];
+export declare const getAllElementIds: (config: SlashMenuState) => string[];
+export declare const hasDuplicateIds: (config: SlashMenuState) => boolean;
+export declare const getAllElements: (state: SlashMenuState) => MenuElement[];
+export declare const getElementById: (id: ItemId, state: SlashMenuState) => MenuElement | undefined;
+export declare const findParent: (id: ItemId, elements: MenuElement[], subMenu?: ItemId | "root") => ItemId | "root";
+export declare const getNextItemId: (state: SlashMenuState) => ItemId | undefined;
+export declare const getPreviousItemId: (state: SlashMenuState) => ItemId | undefined;
+export declare const dispatchWithMeta: (view: EditorView, key: PluginKey, meta: SlashMenuMeta) => void;
+export declare const getFilteredItems: (state: SlashMenuState, input: string) => MenuElement[];
+export declare const ignoredKeys: string[];

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "prosemirror-slash-menu",
+  "version": "0.0.1",
+  "description": "Slash menu for ProseMirror",
+  "main": "dist/index.js",
+  "module": "dist/index.es.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "prebuild": "rimraf dist",
+    "build": "rollup -c --bundleConfigAsCjs",
+    "dev": "rollup -c -w --bundleConfigAsCjs",
+    "yalc:watch": "nodemon --watch dist --exec 'yalc push'",
+    "dev:watch": "npm-run-all --parallel dev yalc:watch",
+    "format": "eslint src --ext .ts --fix",
+    "prepublishOnly": "npm run build && npm test && npm run lint",
+    "version": "npm run format && git add -A src",
+    "postversion": "git push && git push --tags",
+    "lint": "tsc --noEmit && eslint src --ext .ts",
+    "test": "echo \"no test specified\" && exit 0",
+    "upgrade-interactive": "npm-check --update",
+    "publish:np": "np"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/emergence-engineering/prosemirror-slash-menu.git"
+  },
+  "files": [
+    "dist/**/*"
+  ],
+  "author": "Emergence Engineering",
+  "keywords": [
+    "ProseMirror",
+    "slash",
+    "menu"
+  ],
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/emergence-engineering/prosemirror-slash-menu/issues"
+  },
+  "homepage": "https://github.com/emergence-engineering/prosemirror-slash-menu#readme",
+  "dependencies": {
+    "prosemirror-state": "^1.4.3",
+    "prosemirror-view": "^1.31.4"
+  },
+  "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "^5.46.1",
+    "@typescript-eslint/parser": "^5.46.1",
+    "eslint": "^8.29.0",
+    "eslint-config-airbnb": "^19.0.4",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-jest": "^27.1.6",
+    "eslint-plugin-jsx-a11y": "^6.6.1",
+    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-react": "^7.31.11",
+    "nodemon": "^2.0.22",
+    "np": "^8.0.2",
+    "npm-check": "^6.0.1",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^2.8.8",
+    "rollup": "^3.24.0",
+    "rollup-plugin-minification": "^0.2.0",
+    "rollup-plugin-peer-deps-external": "^2.2.4",
+    "rollup-plugin-typescript2": "^0.34.1",
+    "typescript": "^5.1.3"
+  }
+}