@difizen/libro-shared-model 0.0.2-alpha.0

package/es/api.js

@@ -0,0 +1,91 @@
+/**
+ * This file defines the shared shared-models types.
+ *
+ * - Notebook Type.
+ * - Notebook Metadata Types.
+ * - Cell Types.
+ * - Cell Metadata Types.
+ *
+ * It also defines the shared changes to be used in the events.
+ */
+/**
+ * Changes on Sequence-like data are expressed as Quill-inspired deltas.
+ *
+ * @source https://quilljs.com/docs/delta/
+ */
+/**
+ * ISharedBase defines common operations that can be performed on any shared object.
+ */
+/**
+ * Implement an API for Context information on the shared information.
+ * This is used by, for example, docregistry to share the file-path of the edited content.
+ */
+/**
+ * The ISharedText interface defines models that can be bound to a text editor like CodeMirror.
+ */
+/**
+ * Text/Markdown/Code files are represented as ISharedFile
+ */
+/**
+ * Implements an API for INotebookContent
+ */
+/**
+ * Definition of the map changes for yjs.
+ */
+/**
+ * 类型转换器：将libro的cell type（string） 转换为 'code' | 'markdown' | 'raw' 三种之一
+ */
+/**
+ * The namespace for `ISharedNotebook` class statics.
+ */
+export var ISharedNotebook;
+/** Cell Types. */
+/**
+ * Shared cell namespace
+ */
+export var SharedCell;
+/**
+ * Implements an API for IBaseCell.
+ */
+/**
+ * Implements an API for ICodeCell.
+ */
+/**
+ * Cell with attachment interface.
+ */
+/**
+ * Implements an API for IMarkdownCell.
+ */
+/**
+ * Implements an API for IRawCell.
+ */
+/**
+ * Implements an API for IUnrecognizedCell.
+ */
+/**
+ * Generic document change
+ */
+/**
+ * The change types which occur on a list.
+ */
+/**
+ * The changed object which is emitted by a list.
+ */
+/**
+ * The change types which occur on an observable map.
+ */
+/**
+ * The changed args object which is emitted by an observable map.
+ */
+/**
+ * Text source change
+ */
+/**
+ * Definition of the shared Notebook changes.
+ */
+/**
+ * File change
+ */
+/**
+ * Definition of the shared Cell changes.
+ */

package/es/index.d.ts

@@ -0,0 +1,4 @@
+export * from './api.js';
+export * from './utils.js';
+export * from './ymodels.js';
+//# sourceMappingURL=index.d.ts.map

package/es/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC"}

package/es/index.js

@@ -0,0 +1,3 @@
+export * from "./api.js";
+export * from "./utils.js";
+export * from "./ymodels.js";

package/es/utils.d.ts

@@ -0,0 +1,18 @@
+import type * as Y from 'yjs';
+import type * as models from './api.js';
+export declare function convertYMapEventToMapChange(yMapEvent: Y.YMapEvent<any>): models.MapChange;
+/**
+ * Creates a mutual exclude function with the following property:
+ *
+ * ```js
+ * const mutex = createMutex()
+ * mutex(() => {
+ *   // This function is immediately executed
+ *   mutex(() => {
+ *     // This function is not executed, as the mutex is already active.
+ *   })
+ * })
+ * ```
+ */
+export declare const createMutex: () => (f: () => void) => void;
+//# sourceMappingURL=utils.d.ts.map

package/es/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,CAAC,MAAM,KAAK,CAAC;AAE9B,OAAO,KAAK,KAAK,MAAM,MAAM,UAAU,CAAC;AAExC,wBAAgB,2BAA2B,CACzC,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,GAC1B,MAAM,CAAC,SAAS,CAYlB;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,WAAW,YAAY,MAAM,IAAI,KAAK,IAYlD,CAAC"}

package/es/utils.js

@@ -0,0 +1,41 @@
+export function convertYMapEventToMapChange(yMapEvent) {
+  var _this = this;
+  var changes = new Map();
+  yMapEvent.changes.keys.forEach(function (event, key) {
+    changes.set(key, {
+      action: event.action,
+      oldValue: event.oldValue,
+      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+      // @ts-ignore
+      newValue: _this.ymeta.get(key)
+    });
+  });
+  return changes;
+}
+
+/**
+ * Creates a mutual exclude function with the following property:
+ *
+ * ```js
+ * const mutex = createMutex()
+ * mutex(() => {
+ *   // This function is immediately executed
+ *   mutex(() => {
+ *     // This function is not executed, as the mutex is already active.
+ *   })
+ * })
+ * ```
+ */
+export var createMutex = function createMutex() {
+  var token = true;
+  return function (f) {
+    if (token) {
+      token = false;
+      try {
+        f();
+      } finally {
+        token = true;
+      }
+    }
+  };
+};