@difizen/libro-kernel 0.0.2-alpha.0

package/es/contents/contents-manager.js

@@ -0,0 +1,551 @@
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+var _dec, _class;
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e2) { throw _e2; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e3) { didErr = true; err = _e3; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _iterableToArrayLimit(arr, i) { var _i = null == arr ? null : "undefined" != typeof Symbol && arr[Symbol.iterator] || arr["@@iterator"]; if (null != _i) { var _s, _e, _x, _r, _arr = [], _n = !0, _d = !1; try { if (_x = (_i = _i.call(arr)).next, 0 === i) { if (Object(_i) !== _i) return; _n = !1; } else for (; !(_n = (_s = _x.call(_i)).done) && (_arr.push(_s.value), _arr.length !== i); _n = !0); } catch (err) { _d = !0, _e = err; } finally { try { if (!_n && null != _i.return && (_r = _i.return(), Object(_r) !== _r)) return; } finally { if (_d) throw _e; } } return _arr; } }
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
+function _toConsumableArray(arr) { return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread(); }
+function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter); }
+function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor); } }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+import { PathExt } from '@difizen/libro-common';
+import { inject, singleton } from '@difizen/mana-app';
+import { Emitter } from '@difizen/mana-app';
+import { Drive } from "./contents-drive.js";
+/**
+ * A contents manager that passes file operations to the server.
+ * Multiple servers implementing the `IContentsDrive` interface can be
+ * attached to the contents manager, so that the same session can
+ * perform file operations on multiple backends.
+ *
+ * This includes checkpointing with the normal file operations.
+ */
+export var ContentsManager = (_dec = singleton(), _dec(_class = /*#__PURE__*/function () {
+  function ContentsManager(defaultDrive) {
+    var _this = this;
+    _classCallCheck(this, ContentsManager);
+    this._isDisposed = false;
+    this.additionalDrives = new Map();
+    this.fileChangedEmitter = new Emitter();
+    this.defaultDrive = defaultDrive;
+    this.defaultDrive.fileChanged(function (args) {
+      return _this.onFileChanged(_this.defaultDrive, args);
+    });
+  }
+
+  /**
+   * The server settings associated with the manager.
+   */
+  // serverSettings: ISettings;
+
+  /**
+   * A signal emitted when a file operation takes place.
+   */
+  ContentsManager = inject(Drive)(ContentsManager, undefined, 0) || ContentsManager;
+  _createClass(ContentsManager, [{
+    key: "fileChanged",
+    get: function get() {
+      // return this._fileChanged;
+      return this.fileChangedEmitter.event;
+    }
+
+    /**
+     * Test whether the manager has been disposed.
+     */
+  }, {
+    key: "isDisposed",
+    get: function get() {
+      return this._isDisposed;
+    }
+
+    /**
+     * Dispose of the resources held by the manager.
+     */
+  }, {
+    key: "dispose",
+    value: function dispose() {
+      if (this.isDisposed) {
+        return;
+      }
+      this._isDisposed = true;
+      this.fileChangedEmitter.dispose();
+    }
+
+    /**
+     * Add an `IContentsDrive` to the manager.
+     */
+  }, {
+    key: "addDrive",
+    value: function addDrive(drive) {
+      var _this2 = this;
+      this.additionalDrives.set(drive.name, drive);
+      drive.fileChanged(function (args) {
+        return _this2.onFileChanged(drive, args);
+      });
+    }
+
+    /**
+     * Given a path, get a ModelDB.IFactory from the
+     * relevant backend. Returns `undefined` if the backend
+     * does not provide one.
+     */
+    // getModelDBFactory(path: string): ModelDB.IFactory | null {
+    //   const [drive] = this.driveForPath(path);
+    //   return drive?.modelDBFactory ?? null;
+    // }
+
+    /**
+     * Given a path of the form `drive:local/portion/of/it.txt`
+     * get the local part of it.
+     *
+     * @param path: the path.
+     *
+     * @returns The local part of the path.
+     */
+  }, {
+    key: "localPath",
+    value: function localPath(path) {
+      var parts = path.split('/');
+      var firstParts = parts[0].split(':');
+      if (firstParts.length === 1 || !this.additionalDrives.has(firstParts[0])) {
+        return PathExt.removeSlash(path);
+      }
+      return PathExt.join.apply(PathExt, [firstParts.slice(1).join(':')].concat(_toConsumableArray(parts.slice(1))));
+    }
+
+    /**
+     * Normalize a global path. Reduces '..' and '.' parts, and removes
+     * leading slashes from the local part of the path, while retaining
+     * the drive name if it exists.
+     *
+     * @param path: the path.
+     *
+     * @returns The normalized path.
+     */
+  }, {
+    key: "normalize",
+    value: function normalize(path) {
+      var parts = path.split(':');
+      if (parts.length === 1) {
+        return PathExt.normalize(path);
+      }
+      return "".concat(parts[0], ":").concat(PathExt.normalize(parts.slice(1).join(':')));
+    }
+
+    /**
+     * Resolve a global path, starting from the root path. Behaves like
+     * posix-path.resolve, with 3 differences:
+     *  - will never prepend cwd
+     *  - if root has a drive name, the result is prefixed with "<drive>:"
+     *  - before adding drive name, leading slashes are removed
+     *
+     * @param path: the path.
+     *
+     * @returns The normalized path.
+     */
+  }, {
+    key: "resolvePath",
+    value: function resolvePath(root, path) {
+      var driveName = this.driveName(root);
+      var localPath = this.localPath(root);
+      var resolved = PathExt.resolve('/', localPath, path);
+      return driveName ? "".concat(driveName, ":").concat(resolved) : resolved;
+    }
+
+    /**
+     * Given a path of the form `drive:local/portion/of/it.txt`
+     * get the name of the drive. If the path is missing
+     * a drive portion, returns an empty string.
+     *
+     * @param path: the path.
+     *
+     * @returns The drive name for the path, or the empty string.
+     */
+  }, {
+    key: "driveName",
+    value: function driveName(path) {
+      var parts = path.split('/');
+      var firstParts = parts[0].split(':');
+      if (firstParts.length === 1) {
+        return '';
+      }
+      if (this.additionalDrives.has(firstParts[0])) {
+        return firstParts[0];
+      }
+      return '';
+    }
+
+    /**
+     * Get a file or directory.
+     *
+     * @param path: The path to the file.
+     *
+     * @param options: The options used to fetch the file.
+     *
+     * @returns A promise which resolves with the file content.
+     */
+  }, {
+    key: "get",
+    value: function get(path, options) {
+      var _this3 = this;
+      var _this$driveForPath = this.driveForPath(path),
+        _this$driveForPath2 = _slicedToArray(_this$driveForPath, 2),
+        drive = _this$driveForPath2[0],
+        localPath = _this$driveForPath2[1];
+      return drive.get(localPath, options).then(function (contentsModel) {
+        var listing = [];
+        if (contentsModel.type === 'directory' && contentsModel.content) {
+          var _iterator = _createForOfIteratorHelper(contentsModel.content),
+            _step;
+          try {
+            for (_iterator.s(); !(_step = _iterator.n()).done;) {
+              var item = _step.value;
+              listing.push(_objectSpread(_objectSpread({}, item), {}, {
+                path: _this3.toGlobalPath(drive, item.path)
+              }));
+            }
+          } catch (err) {
+            _iterator.e(err);
+          } finally {
+            _iterator.f();
+          }
+          return _objectSpread(_objectSpread({}, contentsModel), {}, {
+            path: _this3.toGlobalPath(drive, localPath),
+            content: listing
+          });
+        } else {
+          return _objectSpread(_objectSpread({}, contentsModel), {}, {
+            path: _this3.toGlobalPath(drive, localPath)
+          });
+        }
+      });
+    }
+
+    /**
+     * Get an encoded download url given a file path.
+     *
+     * @param path - An absolute POSIX file path on the server.
+     *
+     * #### Notes
+     * It is expected that the path contains no relative paths.
+     *
+     * The returned URL may include a query parameter.
+     */
+  }, {
+    key: "getDownloadUrl",
+    value: function getDownloadUrl(path, options) {
+      var _this$driveForPath3 = this.driveForPath(path),
+        _this$driveForPath4 = _slicedToArray(_this$driveForPath3, 2),
+        drive = _this$driveForPath4[0],
+        localPath = _this$driveForPath4[1];
+      return drive.getDownloadUrl(localPath, options);
+    }
+
+    /**
+     * Create a new untitled file or directory in the specified directory path.
+     *
+     * @param options: The options used to create the file.
+     *
+     * @returns A promise which resolves with the created file content when the
+     *    file is created.
+     */
+  }, {
+    key: "newUntitled",
+    value: function newUntitled() {
+      var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+      if (options.path) {
+        var globalPath = this.normalize(options.path);
+        var _this$driveForPath5 = this.driveForPath(globalPath),
+          _this$driveForPath6 = _slicedToArray(_this$driveForPath5, 2),
+          drive = _this$driveForPath6[0],
+          localPath = _this$driveForPath6[1];
+        return drive.newUntitled(_objectSpread(_objectSpread({}, options), {}, {
+          path: localPath
+        })).then(function (contentsModel) {
+          return _objectSpread(_objectSpread({}, contentsModel), {}, {
+            path: PathExt.join(globalPath, contentsModel.name)
+          });
+        });
+      } else {
+        return this.defaultDrive.newUntitled(options);
+      }
+    }
+
+    /**
+     * Delete a file.
+     *
+     * @param path - The path to the file.
+     *
+     * @returns A promise which resolves when the file is deleted.
+     */
+  }, {
+    key: "delete",
+    value: function _delete(path, options) {
+      var _this$driveForPath7 = this.driveForPath(path),
+        _this$driveForPath8 = _slicedToArray(_this$driveForPath7, 2),
+        drive = _this$driveForPath8[0],
+        localPath = _this$driveForPath8[1];
+      return drive.delete(localPath, options);
+    }
+
+    /**
+     * Rename a file or directory.
+     *
+     * @param path - The original file path.
+     *
+     * @param newPath - The new file path.
+     *
+     * @returns A promise which resolves with the new file contents model when
+     *   the file is renamed.
+     */
+  }, {
+    key: "rename",
+    value: function rename(path, newPath, options) {
+      var _this4 = this;
+      var _this$driveForPath9 = this.driveForPath(path),
+        _this$driveForPath10 = _slicedToArray(_this$driveForPath9, 2),
+        drive1 = _this$driveForPath10[0],
+        path1 = _this$driveForPath10[1];
+      var _this$driveForPath11 = this.driveForPath(newPath),
+        _this$driveForPath12 = _slicedToArray(_this$driveForPath11, 2),
+        drive2 = _this$driveForPath12[0],
+        path2 = _this$driveForPath12[1];
+      if (drive1 !== drive2) {
+        throw Error('ContentsManager: renaming files must occur within a Drive');
+      }
+      return drive1.rename(path1, path2, options).then(function (contentsModel) {
+        return _objectSpread(_objectSpread({}, contentsModel), {}, {
+          path: _this4.toGlobalPath(drive1, path2)
+        });
+      });
+    }
+
+    /**
+     * Save a file.
+     *
+     * @param path - The desired file path.
+     *
+     * @param options - Optional overrides to the model.
+     *
+     * @returns A promise which resolves with the file content model when the
+     *   file is saved.
+     *
+     * #### Notes
+     * Ensure that `model.content` is populated for the file.
+     */
+  }, {
+    key: "save",
+    value: function save(path) {
+      var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+      var globalPath = this.normalize(path);
+      var _this$driveForPath13 = this.driveForPath(path),
+        _this$driveForPath14 = _slicedToArray(_this$driveForPath13, 2),
+        drive = _this$driveForPath14[0],
+        localPath = _this$driveForPath14[1];
+      return drive.save(localPath, _objectSpread(_objectSpread({}, options), {}, {
+        path: localPath
+      })).then(function (contentsModel) {
+        return _objectSpread(_objectSpread({}, contentsModel), {}, {
+          path: globalPath
+        });
+      });
+    }
+
+    /**
+     * Copy a file into a given directory.
+     *
+     * @param path - The original file path.
+     *
+     * @param toDir - The destination directory path.
+     *
+     * @returns A promise which resolves with the new contents model when the
+     *  file is copied.
+     *
+     * #### Notes
+     * The server will select the name of the copied file.
+     */
+  }, {
+    key: "copy",
+    value: function copy(fromFile, toDir, options) {
+      var _this5 = this;
+      var _this$driveForPath15 = this.driveForPath(fromFile),
+        _this$driveForPath16 = _slicedToArray(_this$driveForPath15, 2),
+        drive1 = _this$driveForPath16[0],
+        path1 = _this$driveForPath16[1];
+      var _this$driveForPath17 = this.driveForPath(toDir),
+        _this$driveForPath18 = _slicedToArray(_this$driveForPath17, 2),
+        drive2 = _this$driveForPath18[0],
+        path2 = _this$driveForPath18[1];
+      if (drive1 === drive2) {
+        return drive1.copy(path1, path2, options).then(function (contentsModel) {
+          return _objectSpread(_objectSpread({}, contentsModel), {}, {
+            path: _this5.toGlobalPath(drive1, contentsModel.path)
+          });
+        });
+      } else {
+        throw Error('Copying files between drives is not currently implemented');
+      }
+    }
+
+    /**
+     * Create a checkpoint for a file.
+     *
+     * @param path - The path of the file.
+     *
+     * @returns A promise which resolves with the new checkpoint model when the
+     *   checkpoint is created.
+     */
+  }, {
+    key: "createCheckpoint",
+    value: function createCheckpoint(path, options) {
+      var _this$driveForPath19 = this.driveForPath(path),
+        _this$driveForPath20 = _slicedToArray(_this$driveForPath19, 2),
+        drive = _this$driveForPath20[0],
+        localPath = _this$driveForPath20[1];
+      return drive.createCheckpoint(localPath, options);
+    }
+
+    /**
+     * List available checkpoints for a file.
+     *
+     * @param path - The path of the file.
+     *
+     * @returns A promise which resolves with a list of checkpoint models for
+     *    the file.
+     */
+  }, {
+    key: "listCheckpoints",
+    value: function listCheckpoints(path, options) {
+      var _this$driveForPath21 = this.driveForPath(path),
+        _this$driveForPath22 = _slicedToArray(_this$driveForPath21, 2),
+        drive = _this$driveForPath22[0],
+        localPath = _this$driveForPath22[1];
+      return drive.listCheckpoints(localPath, options);
+    }
+
+    /**
+     * Restore a file to a known checkpoint state.
+     *
+     * @param path - The path of the file.
+     *
+     * @param checkpointID - The id of the checkpoint to restore.
+     *
+     * @returns A promise which resolves when the checkpoint is restored.
+     */
+  }, {
+    key: "restoreCheckpoint",
+    value: function restoreCheckpoint(path, checkpointID, options) {
+      var _this$driveForPath23 = this.driveForPath(path),
+        _this$driveForPath24 = _slicedToArray(_this$driveForPath23, 2),
+        drive = _this$driveForPath24[0],
+        localPath = _this$driveForPath24[1];
+      return drive.restoreCheckpoint(localPath, checkpointID, options);
+    }
+
+    /**
+     * Delete a checkpoint for a file.
+     *
+     * @param path - The path of the file.
+     *
+     * @param checkpointID - The id of the checkpoint to delete.
+     *
+     * @returns A promise which resolves when the checkpoint is deleted.
+     */
+  }, {
+    key: "deleteCheckpoint",
+    value: function deleteCheckpoint(path, checkpointID, options) {
+      var _this$driveForPath25 = this.driveForPath(path),
+        _this$driveForPath26 = _slicedToArray(_this$driveForPath25, 2),
+        drive = _this$driveForPath26[0],
+        localPath = _this$driveForPath26[1];
+      return drive.deleteCheckpoint(localPath, checkpointID, options);
+    }
+
+    /**
+     * Given a drive and a local path, construct a fully qualified
+     * path. The inverse of `driveForPath`.
+     *
+     * @param drive: an `IContentsDrive`.
+     *
+     * @param localPath: the local path on the drive.
+     *
+     * @returns the fully qualified path.
+     */
+  }, {
+    key: "toGlobalPath",
+    value: function toGlobalPath(drive, localPath) {
+      if (drive === this.defaultDrive) {
+        return PathExt.removeSlash(localPath);
+      } else {
+        return "".concat(drive.name, ":").concat(PathExt.removeSlash(localPath));
+      }
+    }
+
+    /**
+     * Given a path, get the `IContentsDrive to which it refers,
+     * where the path satisfies the pattern
+     * `'driveName:path/to/file'`. If there is no `driveName`
+     * prepended to the path, it returns the default drive.
+     *
+     * @param path: a path to a file.
+     *
+     * @returns A tuple containing an `IContentsDrive` object for the path,
+     * and a local path for that drive.
+     */
+  }, {
+    key: "driveForPath",
+    value: function driveForPath(path) {
+      var driveName = this.driveName(path);
+      var localPath = this.localPath(path);
+      if (driveName) {
+        return [this.additionalDrives.get(driveName), localPath];
+      } else {
+        return [this.defaultDrive, localPath];
+      }
+    }
+
+    /**
+     * Respond to fileChanged signals from the drives attached to
+     * the manager. This prepends the drive name to the path if necessary,
+     * and then forwards the signal.
+     */
+  }, {
+    key: "onFileChanged",
+    value: function onFileChanged(sender, args) {
+      if (sender === this.defaultDrive) {
+        this.fileChangedEmitter.fire(args);
+      } else {
+        var _args$newValue, _args$oldValue;
+        var newValue = null;
+        var oldValue = null;
+        if ((_args$newValue = args.newValue) !== null && _args$newValue !== void 0 && _args$newValue.path) {
+          newValue = _objectSpread(_objectSpread({}, args.newValue), {}, {
+            path: this.toGlobalPath(sender, args.newValue.path)
+          });
+        }
+        if ((_args$oldValue = args.oldValue) !== null && _args$oldValue !== void 0 && _args$oldValue.path) {
+          oldValue = _objectSpread(_objectSpread({}, args.oldValue), {}, {
+            path: this.toGlobalPath(sender, args.oldValue.path)
+          });
+        }
+        this.fileChangedEmitter.fire({
+          type: args.type,
+          newValue: newValue,
+          oldValue: oldValue
+        });
+      }
+    }
+  }]);
+  return ContentsManager;
+}()) || _class);

package/es/contents/contents-module.d.ts

@@ -0,0 +1,3 @@
+import { ManaModule } from '@difizen/mana-app';
+export declare const LibroContentsModule: ManaModule;
+//# sourceMappingURL=contents-module.d.ts.map

package/es/contents/contents-module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contents-module.d.ts","sourceRoot":"","sources":["../../src/contents/contents-module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAK/C,eAAO,MAAM,mBAAmB,YAAuD,CAAC"}

package/es/contents/contents-module.js

@@ -0,0 +1,4 @@
+import { ManaModule } from '@difizen/mana-app';
+import { Drive } from "./contents-drive.js";
+import { ContentsManager } from "./contents-manager.js";
+export var LibroContentsModule = ManaModule.create().register(Drive, ContentsManager);