@difizen/libro-kernel 0.0.2-alpha.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present Difizen Team
+
+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 @@
+# libro-kernel

package/es/basemanager.d.ts

@@ -0,0 +1,94 @@
+import type { Disposable, Event as ManaEvent } from '@difizen/mana-app';
+import { Emitter } from '@difizen/mana-app';
+import type { ISettings, NetworkError } from './server/index.js';
+/**
+ * A disposable object with an observable `disposed` signal.
+ */
+export interface ObservableDisposable extends Disposable {
+    /**
+     * A signal emitted when the object is disposed.
+     */
+    readonly onDisposed: ManaEvent<void>;
+}
+/**
+ * Object which manages kernel instances for a given base url.
+ *
+ * #### Notes
+ * The manager is responsible for maintaining the state of kernel specs.
+ */
+export interface IManager extends ObservableDisposable {
+    /**
+     * A signal emitted when there is a connection failure.
+     */
+    connectionFailure: ManaEvent<NetworkError>;
+    /**
+     * The server settings for the manager.
+     */
+    readonly serverSettings: ISettings;
+    /**
+     * Whether the manager is ready.
+     */
+    readonly isReady: boolean;
+    /**
+     * A promise that resolves when the manager is initially ready.
+     */
+    readonly ready: Promise<void>;
+    /**
+     * Whether the manager is active.
+     */
+    readonly isActive: boolean;
+}
+export declare class BaseManager implements IManager {
+    /**
+     * A signal emitted when the delegate is disposed.
+     */
+    get onDisposed(): ManaEvent<void>;
+    /**
+     * A signal emitted when there is a connection failure.
+     */
+    get connectionFailure(): ManaEvent<Error>;
+    /**
+     * Test whether the delegate has been disposed.
+     */
+    get isDisposed(): boolean;
+    /**
+     * Test whether the manager is ready.
+     */
+    get isReady(): boolean;
+    /**
+     * A promise that fulfills when the manager is ready.
+     */
+    get ready(): Promise<void>;
+    /**
+     * Whether the manager is active.
+     */
+    get isActive(): boolean;
+    /**
+     * Dispose of the delegate and invoke the callback function.
+     */
+    dispose(): void;
+    /**
+     * The server settings of the manager.
+     */
+    readonly serverSettings: ISettings;
+    protected _isDisposed: boolean;
+    protected onDisposedEmitter: Emitter<void>;
+    protected connectionFailureEmitter: Emitter<Error>;
+    _isReady: boolean;
+    _ready: Promise<void>;
+}
+/**
+ * The namespace for `BaseManager` class statics.
+ */
+export declare namespace BaseManager {
+    /**
+     * The options used to initialize a SessionManager.
+     */
+    interface IOptions {
+        /**
+         * The server settings for the manager.
+         */
+        serverSettings?: ISettings;
+    }
+}
+//# sourceMappingURL=basemanager.d.ts.map

package/es/basemanager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"basemanager.d.ts","sourceRoot":"","sources":["../src/basemanager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,KAAK,IAAI,SAAS,EAAE,MAAM,mBAAmB,CAAC;AACxE,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAG5C,OAAO,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjE;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,UAAU;IACtD;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;CACtC;AAED;;;;;GAKG;AACH,MAAM,WAAW,QAAS,SAAQ,oBAAoB;IACpD;;OAEG;IACH,iBAAiB,EAAE,SAAS,CAAC,YAAY,CAAC,CAAC;IAE3C;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,SAAS,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;CAC5B;AAED,qBACa,WAAY,YAAW,QAAQ;IAI1C;;OAEG;IACH,IAAI,UAAU,IAAI,SAAS,CAAC,IAAI,CAAC,CAEhC;IAED;;OAEG;IACH,IAAI,iBAAiB,IAAI,SAAS,CAAC,KAAK,CAAC,CAExC;IAED;;OAEG;IACH,IAAI,UAAU,IAAI,OAAO,CAExB;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IAED;;OAEG;IACH,IAAI,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAEzB;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED;;OAEG;IACH,OAAO,IAAI,IAAI;IAQf;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,SAAS,CAAC;IAEnC,SAAS,CAAC,WAAW,UAAS;IAC9B,SAAS,CAAC,iBAAiB,gBAAuB;IAElD,SAAS,CAAC,wBAAwB,iBAAwB;IAC1D,QAAQ,UAAS;IACjB,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;CACvB;AAED;;GAEG;AACH,yBAAiB,WAAW,CAAC;IAC3B;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,cAAc,CAAC,EAAE,SAAS,CAAC;KAC5B;CACF"}

package/es/basemanager.js

@@ -0,0 +1,110 @@
+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 _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 { Emitter } from '@difizen/mana-app';
+import { singleton } from '@difizen/mana-app';
+
+/**
+ * A disposable object with an observable `disposed` signal.
+ */
+
+/**
+ * Object which manages kernel instances for a given base url.
+ *
+ * #### Notes
+ * The manager is responsible for maintaining the state of kernel specs.
+ */
+
+export var BaseManager = (_dec = singleton(), _dec(_class = /*#__PURE__*/function () {
+  function BaseManager() {
+    _classCallCheck(this, BaseManager);
+    this._isDisposed = false;
+    this.onDisposedEmitter = new Emitter();
+    this.connectionFailureEmitter = new Emitter();
+    this._isReady = false;
+  }
+  _createClass(BaseManager, [{
+    key: "onDisposed",
+    get:
+    // constructor(options: BaseManager.IOptions) {
+    //   this.serverSettings = options.serverSettings ?? ServerConnection.makeSettings();
+    // }
+    /**
+     * A signal emitted when the delegate is disposed.
+     */
+    function get() {
+      return this.onDisposedEmitter.event;
+    }
+
+    /**
+     * A signal emitted when there is a connection failure.
+     */
+  }, {
+    key: "connectionFailure",
+    get: function get() {
+      return this.connectionFailureEmitter.event;
+    }
+
+    /**
+     * Test whether the delegate has been disposed.
+     */
+  }, {
+    key: "isDisposed",
+    get: function get() {
+      return this._isDisposed;
+    }
+
+    /**
+     * Test whether the manager is ready.
+     */
+  }, {
+    key: "isReady",
+    get: function get() {
+      return this._isReady;
+    }
+
+    /**
+     * A promise that fulfills when the manager is ready.
+     */
+  }, {
+    key: "ready",
+    get: function get() {
+      return this._ready;
+    }
+
+    /**
+     * Whether the manager is active.
+     */
+  }, {
+    key: "isActive",
+    get: function get() {
+      return true;
+    }
+
+    /**
+     * Dispose of the delegate and invoke the callback function.
+     */
+  }, {
+    key: "dispose",
+    value: function dispose() {
+      if (this.isDisposed) {
+        return;
+      }
+      this.onDisposedEmitter.fire(undefined);
+      this.onDisposedEmitter.dispose();
+    }
+
+    /**
+     * The server settings of the manager.
+     */
+  }]);
+  return BaseManager;
+}()) || _class);
+
+/**
+ * The namespace for `BaseManager` class statics.
+ */

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

@@ -0,0 +1,189 @@
+import type { Event as ManaEvent } from '@difizen/mana-app';
+import { Emitter } from '@difizen/mana-app';
+import type { ISettings } from '../server/index.js';
+import { ServerConnection } from '../server/index.js';
+import type { IContentsChangedArgs, IContentsCheckpointModel, IContentsCreateOptions, IContentsDrive, IContentsFetchOptions, IContentsModel, IContentsRequestOptions } from './contents-protocol.js';
+/**
+ * A default implementation for an `IContentsDrive`, talking to the
+ * server using the Jupyter REST API.
+ */
+export declare class Drive implements IContentsDrive {
+    serverConnection: ServerConnection;
+    /**
+     * Construct a new contents manager object.
+     *
+     * @param options - The options used to initialize the object.
+     */
+    constructor();
+    /**
+     * The name of the drive, which is used at the leading
+     * component of file paths.
+     */
+    readonly name: string;
+    /**
+     * A signal emitted when a file operation takes place.
+     */
+    get fileChanged(): ManaEvent<IContentsChangedArgs>;
+    /**
+     * The server settings of the drive.
+     */
+    /**
+     * Test whether the manager has been disposed.
+     */
+    get isDisposed(): boolean;
+    /**
+     * Dispose of the resources held by the manager.
+     */
+    dispose(): void;
+    /**
+     * Get a file or directory.
+     *
+     * @param localPath: The path to the file.
+     *
+     * @param options: The options used to fetch the file.
+     *
+     * @returns A promise which resolves with the file content.
+     *
+     * Uses the [Jupyter Notebook API](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter/notebook/master/notebook/services/api/api.yaml#!/contents) and validates the response model.
+     */
+    get(localPath: string, options?: IContentsFetchOptions): Promise<IContentsModel>;
+    /**
+     * Get an encoded download url given a file path.
+     *
+     * @param localPath - 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.
+     */
+    getDownloadUrl(localPath: string, options?: IContentsRequestOptions): Promise<string>;
+    /**
+     * 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.
+     *
+     * #### Notes
+     * Uses the [Jupyter Notebook API](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter/notebook/master/notebook/services/api/api.yaml#!/contents) and validates the response model.
+     */
+    newUntitled(options?: IContentsCreateOptions): Promise<IContentsModel>;
+    /**
+     * Delete a file.
+     *
+     * @param localPath - The path to the file.
+     *
+     * @returns A promise which resolves when the file is deleted.
+     *
+     * #### Notes
+     * Uses the [Jupyter Notebook API](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter/notebook/master/notebook/services/api/api.yaml#!/contents).
+     */
+    delete(localPath: string, options?: IContentsRequestOptions): Promise<void>;
+    /**
+     * Rename a file or directory.
+     *
+     * @param oldLocalPath - The original file path.
+     *
+     * @param newLocalPath - The new file path.
+     *
+     * @returns A promise which resolves with the new file contents model when
+     *   the file is renamed.
+     *
+     * #### Notes
+     * Uses the [Jupyter Notebook API](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter/notebook/master/notebook/services/api/api.yaml#!/contents) and validates the response model.
+     */
+    rename(oldLocalPath: string, newLocalPath: string, options?: IContentsRequestOptions): Promise<IContentsModel>;
+    /**
+     * Save a file.
+     *
+     * @param localPath - 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.
+     *
+     * Uses the [Jupyter Notebook API](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter/notebook/master/notebook/services/api/api.yaml#!/contents) and validates the response model.
+     */
+    save(localPath: string, options?: Partial<IContentsModel>): Promise<IContentsModel>;
+    /**
+     * Copy a file into a given directory.
+     *
+     * @param localPath - 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.
+     *
+     * Uses the [Jupyter Notebook API](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter/notebook/master/notebook/services/api/api.yaml#!/contents) and validates the response model.
+     */
+    copy(fromFile: string, toDir: string, options?: IContentsRequestOptions): Promise<IContentsModel>;
+    /**
+     * Create a checkpoint for a file.
+     *
+     * @param localPath - The path of the file.
+     *
+     * @returns A promise which resolves with the new checkpoint model when the
+     *   checkpoint is created.
+     *
+     * #### Notes
+     * Uses the [Jupyter Notebook API](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter/notebook/master/notebook/services/api/api.yaml#!/contents) and validates the response model.
+     */
+    createCheckpoint(localPath: string, options?: IContentsRequestOptions): Promise<IContentsCheckpointModel>;
+    /**
+     * List available checkpoints for a file.
+     *
+     * @param localPath - The path of the file.
+     *
+     * @returns A promise which resolves with a list of checkpoint models for
+     *    the file.
+     *
+     * #### Notes
+     * Uses the [Jupyter Notebook API](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter/notebook/master/notebook/services/api/api.yaml#!/contents) and validates the response model.
+     */
+    listCheckpoints(localPath: string, options?: IContentsRequestOptions): Promise<IContentsCheckpointModel[]>;
+    /**
+     * Restore a file to a known checkpoint state.
+     *
+     * @param localPath - The path of the file.
+     *
+     * @param checkpointID - The id of the checkpoint to restore.
+     *
+     * @returns A promise which resolves when the checkpoint is restored.
+     *
+     * #### Notes
+     * Uses the [Jupyter Notebook API](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter/notebook/master/notebook/services/api/api.yaml#!/contents).
+     */
+    restoreCheckpoint(localPath: string, checkpointID: string, options?: IContentsRequestOptions): Promise<void>;
+    /**
+     * Delete a checkpoint for a file.
+     *
+     * @param localPath - The path of the file.
+     *
+     * @param checkpointID - The id of the checkpoint to delete.
+     *
+     * @returns A promise which resolves when the checkpoint is deleted.
+     *
+     * #### Notes
+     * Uses the [Jupyter Notebook API](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter/notebook/master/notebook/services/api/api.yaml#!/contents).
+     */
+    deleteCheckpoint(localPath: string, checkpointID: string, options?: IContentsRequestOptions): Promise<void>;
+    /**
+     * Get a REST url for a file given a path.
+     */
+    protected getUrl(base?: string, ...args: string[]): string;
+    protected _getSettings(baseUrl?: string): ISettings;
+    protected apiEndpoint: string;
+    protected _isDisposed: boolean;
+    protected fileChangedEmitter: Emitter<IContentsChangedArgs>;
+}
+//# sourceMappingURL=contents-drive.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"contents-drive.d.ts","sourceRoot":"","sources":["../../src/contents/contents-drive.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,KAAK,IAAI,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAE5D,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAG5C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAuB,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3E,OAAO,KAAK,EACV,oBAAoB,EACpB,wBAAwB,EACxB,sBAAsB,EACtB,cAAc,EACd,qBAAqB,EACrB,cAAc,EACd,uBAAuB,EACxB,MAAM,wBAAwB,CAAC;AAoBhC;;;GAGG;AACH,qBACa,KAAM,YAAW,cAAc;IAChB,gBAAgB,EAAE,gBAAgB,CAAC;IAE7D;;;;OAIG;;IAKH;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,WAAW,IAAI,SAAS,CAAC,oBAAoB,CAAC,CAEjD;IAED;;OAEG;IAGH;;OAEG;IACH,IAAI,UAAU,IAAI,OAAO,CAExB;IAED;;OAEG;IACH,OAAO,IAAI,IAAI;IAQf;;;;;;;;;;OAUG;IACG,GAAG,CACP,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,qBAAqB,GAC9B,OAAO,CAAC,cAAc,CAAC;IA2B1B;;;;;;;;;OASG;IACH,cAAc,CACZ,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,uBAAuB,GAChC,OAAO,CAAC,MAAM,CAAC;IAYlB;;;;;;;;;;OAUG;IACG,WAAW,CAAC,OAAO,GAAE,sBAA2B,GAAG,OAAO,CAAC,cAAc,CAAC;IAiChF;;;;;;;;;OASG;IACG,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;IAkBjF;;;;;;;;;;;;OAYG;IACG,MAAM,CACV,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,MAAM,EACpB,OAAO,CAAC,EAAE,uBAAuB,GAChC,OAAO,CAAC,cAAc,CAAC;IAsB1B;;;;;;;;;;;;;;OAcG;IACG,IAAI,CACR,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,OAAO,CAAC,cAAc,CAAM,GACpC,OAAO,CAAC,cAAc,CAAC;IA8B1B;;;;;;;;;;;;;;OAcG;IACG,IAAI,CACR,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,uBAAuB,GAChC,OAAO,CAAC,cAAc,CAAC;IAsB1B;;;;;;;;;;OAUG;IACG,gBAAgB,CACpB,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,uBAAuB,GAChC,OAAO,CAAC,wBAAwB,CAAC;IAcpC;;;;;;;;;;OAUG;IACG,eAAe,CACnB,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,uBAAuB,GAChC,OAAO,CAAC,wBAAwB,EAAE,CAAC;IAkBtC;;;;;;;;;;;OAWG;IACG,iBAAiB,CACrB,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,MAAM,EACpB,OAAO,CAAC,EAAE,uBAAuB,GAChC,OAAO,CAAC,IAAI,CAAC;IAWhB;;;;;;;;;;;OAWG;IACG,gBAAgB,CACpB,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,MAAM,EACpB,OAAO,CAAC,EAAE,uBAAuB,GAChC,OAAO,CAAC,IAAI,CAAC;IAWhB;;OAEG;IACH,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM;IAS1D,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS;IAQnD,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC;IAC9B,SAAS,CAAC,WAAW,UAAS;IAC9B,SAAS,CAAC,kBAAkB,gCAAuC;CACpE"}