@kerebron/extension-yjs 0.0.1

package/LICENSE

@@ -0,0 +1,23 @@
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,34 @@
+# Kerebron - Prosemirror based online editor kit
+
+Using vanilla Prosemirror modules is often impossible because of incompatibilities.  
+
+Kerebron forks several prosemirror projects into one monorepo in order to keep them in sync.
+
+Project is inspired on https://tiptap.dev/, but instead of building wrapper around a wrapper it borrows concept of extension and command manager. 
+
+It has simplified tooling (deno), fewer dependencies and resulting in lower number of output npm modules.
+
+**Work in progress**
+
+## Development
+
+To start example server:
+
+```
+deno task -f example-server-hono start
+```
+
+## Build
+
+# NPM packages are generated using DNT
+
+- https://deno.com/blog/publish-esm-cjs-module-dnt - the easiest way to publish
+  a hybrid npm module for ESM and CommonJS
+- https://github.com/denoland/dnt
+- https://gaubee.com/article/Publishing-Your-Deno-Project-as-a-Monorepo-using-dnt/
+
+To generate npm packages
+
+```shell
+deno -A ./scripts/build_npm.ts
+```

package/esm/ExtensionYjs.d.ts

@@ -0,0 +1,12 @@
+import { Schema } from 'prosemirror-model';
+import { Plugin } from 'prosemirror-state';
+import { CoreEditor, Extension } from '@kerebron/editor';
+import { Commands, CommandShortcuts } from '@kerebron/editor/commands';
+export declare class ExtensionYjs extends Extension {
+    name: string;
+    doc: any;
+    getCommands(editor: CoreEditor): Partial<Commands>;
+    getKeyboardShortcuts(): Partial<CommandShortcuts>;
+    getProseMirrorPlugins(editor: CoreEditor, schema: Schema): Plugin[];
+}
+//# sourceMappingURL=ExtensionYjs.d.ts.map

package/esm/ExtensionYjs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExtensionYjs.d.ts","sourceRoot":"","sources":["../src/ExtensionYjs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,MAAM,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAGzD,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAIvE,qBAAa,YAAa,SAAQ,SAAS;IACzC,IAAI,SAAS;IACb,GAAG,EAAE,GAAG,CAAC;IAGA,WAAW,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC;IAOlD,oBAAoB,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAOjD,qBAAqB,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE;CAY7E"}

package/esm/ExtensionYjs.js

@@ -0,0 +1,44 @@
+import { Extension } from '@kerebron/editor';
+import { initProseMirrorDoc, redo, undo, yUndoPlugin } from 'y-prosemirror';
+import { ySyncPlugin } from './SyncPlugin.js';
+import { yCursorPlugin } from './yCursorPlugin.js';
+export class ExtensionYjs extends Extension {
+    constructor() {
+        super(...arguments);
+        Object.defineProperty(this, "name", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 'yjs'
+        });
+        Object.defineProperty(this, "doc", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+    }
+    // declare type Command = (state: EditorState, dispatch?: (tr: Transaction) => void, view?: EditorView) => boolean;
+    getCommands(editor) {
+        return {
+            'undo': () => undo,
+            'redo': () => redo,
+        };
+    }
+    getKeyboardShortcuts() {
+        return {
+            'Mod-z': 'undo',
+            'Mod-y': 'redo',
+        };
+    }
+    getProseMirrorPlugins(editor, schema) {
+        const ydoc = this.config.ydoc;
+        const fragment = ydoc.getXmlFragment('prosemirror');
+        const { mapping } = initProseMirrorDoc(fragment, schema);
+        return [
+            ySyncPlugin(fragment, { mapping }),
+            yCursorPlugin(this.config.provider.awareness),
+            yUndoPlugin(),
+        ];
+    }
+}

package/esm/SyncPlugin.d.ts

@@ -0,0 +1,83 @@
+import * as PModel from 'prosemirror-model';
+import * as Y from 'yjs';
+import { mutex } from 'lib0/mutex';
+import { EditorView } from 'prosemirror-view';
+import { ProsemirrorMapping } from 'y-prosemirror';
+import { YSyncOpts } from 'y-prosemirror';
+/**
+ * @param {Y.Item} item
+ * @param {Y.Snapshot} [snapshot]
+ */
+export declare const isVisible: (item: any, snapshot: any) => any;
+export declare const ySyncPlugin: (yXmlFragment: Y.XmlFragment, { colors, colorMapping, permanentUserData, onFirstRender, mapping, }?: YSyncOpts) => any;
+export declare const getRelativeSelection: (pmbinding: any, state: any) => {
+    anchor: any;
+    head: any;
+};
+/**
+ * Binding for prosemirror.
+ *
+ * @protected
+ */
+export declare class ProsemirrorBinding {
+    private yXmlFragment;
+    private mapping;
+    type: Y.XmlFragment;
+    mux: mutex;
+    private _observeFunction;
+    private prosemirrorView;
+    private doc;
+    beforeTransactionSelection: {
+        anchor: any;
+        head: any;
+    };
+    afterAllTransactions: () => void;
+    beforeAllTransactions: (arg0: Y.Doc) => void;
+    constructor(yXmlFragment: Y.XmlFragment, mapping?: ProsemirrorMapping);
+    /**
+     * Create a transaction for changing the prosemirror state.
+     *
+     * @returns
+     */
+    get _tr(): any;
+    _isLocalCursorInView(): any;
+    _isDomSelectionInView(): boolean;
+    renderSnapshot(snapshot: Y.Snapshot, prevSnapshot: Y.Snapshot): void;
+    unrenderSnapshot(): void;
+    _forceRerender(): void;
+    _renderSnapshot(snapshot: Y.Snapshot | Uint8Array, prevSnapshot: Y.Snapshot | Uint8Array, pluginState: Object): void;
+    _typeChanged(events: Array<Y.YEvent<any>>, transaction: Y.Transaction): void;
+    _prosemirrorChanged(doc: any): void;
+    /**
+     * View is ready to listen to changes. Register observers.
+     * @param {any} prosemirrorView
+     */
+    initView(prosemirrorView: EditorView): void;
+    destroy(): void;
+}
+/**
+ * @private
+ * @param {Y.XmlElement} el
+ * @param {any} schema
+ * @param {ProsemirrorMapping} mapping
+ * @param {Y.Snapshot} [snapshot]
+ * @param {Y.Snapshot} [prevSnapshot]
+ * @param {function('removed' | 'added', Y.ID):any} [computeYChange]
+ * @return {PModel.Node | null} Returns node if node could be created. Otherwise it deletes the yjs type and returns null
+ */
+export declare const createNodeFromYElement: (el: Y.XmlElement, schema: any, mapping: ProsemirrorMapping, snapshot: Y.Snapshot, prevSnapshot: Y.Snapshot, computeYChange: (arg0: "removed" | "added", arg1: Y.ID) => any) => PModel.Node | null;
+/**
+ * Update a yDom node by syncing the current content of the prosemirror node.
+ *
+ * This is a y-prosemirror internal feature that you can use at your own risk.
+ *
+ * @private
+ * @unstable
+ *
+ * @param {{transact: Function}} y
+ * @param {Y.XmlFragment} yDomFragment
+ * @param {any} pNode
+ * @param {ProsemirrorMapping} mapping
+ */
+export declare const updateYFragment: (y: any, yDomFragment: Y.XmlFragment, pNode: any, mapping: ProsemirrorMapping) => void;
+//# sourceMappingURL=SyncPlugin.d.ts.map

package/esm/SyncPlugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SyncPlugin.d.ts","sourceRoot":"","sources":["../src/SyncPlugin.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,MAAM,MAAM,mBAAmB,CAAC;AAQ5C,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAUzB,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAG1C;;;GAGG;AACH,eAAO,MAAM,SAAS,mCAKmB,CAAC;AA8C1C,eAAO,MAAM,WAAW,iBAAkB,CAAC,CAAC,WAAW,yEAMpD,SAAS,QAsIX,CAAC;AA0BF,eAAO,MAAM,oBAAoB;;;CAW/B,CAAC;AAEH;;;;GAIG;AACH,qBAAa,kBAAkB;IAW3B,OAAO,CAAC,YAAY;IACpB,OAAO,CAAC,OAAO;IAXjB,IAAI,EAAE,CAAC,CAAC,WAAW,CAAC;IACpB,GAAG,EAAE,KAAK,CAAC;IACX,OAAO,CAAC,gBAAgB,CAA0C;IAClE,OAAO,CAAC,eAAe,CAAoB;IAC3C,OAAO,CAAC,GAAG,CAAQ;IACnB,0BAA0B,EAAE;QAAE,MAAM,EAAE,GAAG,CAAC;QAAC,IAAI,EAAE,GAAG,CAAA;KAAE,CAAC;IACvD,oBAAoB,EAAE,MAAM,IAAI,CAAC;IACjC,qBAAqB,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,KAAK,IAAI,CAAC;gBAGnC,YAAY,EAAE,CAAC,CAAC,WAAW,EAC3B,OAAO,GAAE,kBAA8B;IA+BjD;;;;OAIG;IACH,IAAI,GAAG,QAEN;IAED,oBAAoB;IAYpB,qBAAqB;IA2BrB,cAAc,CAAC,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,YAAY,EAAE,CAAC,CAAC,QAAQ;IAS7D,gBAAgB;IAqBhB,cAAc;IA+Bd,eAAe,CACb,QAAQ,EAAE,CAAC,CAAC,QAAQ,GAAG,UAAU,EACjC,YAAY,EAAE,CAAC,CAAC,QAAQ,GAAG,UAAU,EACrC,WAAW,EAAE,MAAM;IAuFrB,YAAY,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,WAAW;IAuDrE,mBAAmB,CAAC,GAAG,KAAA;IAUvB;;;OAGG;IACH,QAAQ,CAAC,eAAe,EAAE,UAAU;IAQpC,OAAO;CAOR;AA4BD;;;;;;;;;GASG;AACH,eAAO,MAAM,sBAAsB,OAC7B,CAAC,CAAC,UAAU,UACR,GAAG,WACF,kBAAkB,YACjB,CAAC,CAAC,QAAQ,gBACN,CAAC,CAAC,QAAQ,kBACR,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,KAAK,GAAG,KAC7D,MAAM,CAAC,IAAI,GAAG,IAgFhB,CAAC;AAwPF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,eAAe,yBAEZ,CAAC,CAAC,WAAW,uBAElB,kBAAkB,SA4J5B,CAAC"}