@difizen/libro-kernel 0.0.2-alpha.0

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

@@ -0,0 +1,487 @@
+import type { Disposable, Event as ManaEvent } from '@difizen/mana-app';
+import type { ISettings } from '../server/index.js';
+/**
+ * The options used to fetch a file.
+ */
+export interface IContentsRequestOptions {
+    baseUrl?: string;
+}
+/**
+ * A contents file type. It can be anything but `jupyter-server`
+ * has special treatment for `notebook` and `directory` types.
+ * Anything else is considered as `file` type.
+ */
+export type ContentType = string;
+/**
+ * A contents file format.
+ */
+export type ContentsFileFormat = 'json' | 'text' | 'base64' | null;
+/**
+ * A contents model.
+ */
+export interface IContentsModel extends IContentsRequestOptions {
+    /**
+     * Name of the contents file.
+     *
+     * #### Notes
+     *  Equivalent to the last part of the `path` field.
+     */
+    readonly name: string;
+    /**
+     * The full file path.
+     *
+     * #### Notes
+     * It will *not* start with `/`, and it will be `/`-delimited.
+     */
+    readonly path: string;
+    /**
+     * The type of file.
+     */
+    readonly type: ContentType;
+    /**
+     * Whether the requester has permission to edit the file.
+     */
+    readonly writable: boolean;
+    /**
+     * File creation timestamp.
+     */
+    readonly created: string;
+    /**
+     * Last modified timestamp.
+     */
+    readonly last_modified: string;
+    /**
+     * Specify the mime-type of file contents.
+     *
+     * #### Notes
+     * Only non-`null` when `content` is present and `type` is `"file"`.
+     */
+    readonly mimetype?: string;
+    /**
+     * The optional file content.
+     */
+    readonly content: any;
+    /**
+     * The chunk of the file upload.
+     */
+    readonly chunk?: number;
+    /**
+     * The format of the file `content`.
+     *
+     * #### Notes
+     * Only relevant for type: 'file'
+     */
+    readonly format?: ContentsFileFormat;
+    /**
+     * The size of then file in bytes.
+     */
+    readonly size?: number;
+    /**
+     * The indices of the matched characters in the name.
+     */
+    indices?: readonly number[] | null;
+    message?: string;
+}
+/**
+ * The options used to fetch a file.
+ */
+export interface IContentsFetchOptions extends IContentsRequestOptions {
+    /**
+     * The override file type for the request.
+     */
+    type?: ContentType;
+    /**
+     * The override file format for the request.
+     */
+    format?: ContentsFileFormat;
+    /**
+     * Whether to include the file content.
+     *
+     * The default is `true`.
+     */
+    content?: boolean;
+}
+/**
+ * The options used to create a file.
+ */
+export interface IContentsCreateOptions extends IContentsRequestOptions {
+    /**
+     * The directory in which to create the file.
+     */
+    path?: string;
+    /**
+     * The optional file extension for the new file (e.g. `".txt"`).
+     *
+     * #### Notes
+     * This ignored if `type` is `'notebook'`.
+     */
+    ext?: string;
+    /**
+     * The file type.
+     */
+    type?: ContentType;
+}
+/**
+ * Checkpoint model.
+ */
+export interface IContentsCheckpointModel {
+    /**
+     * The unique identifier for the checkpoint.
+     */
+    readonly id: string;
+    /**
+     * Last modified timestamp.
+     */
+    readonly last_modified: string;
+}
+/**
+ * The change args for a file change.
+ */
+export interface IContentsChangedArgs {
+    /**
+     * The type of change.
+     */
+    type: 'new' | 'delete' | 'rename' | 'save';
+    /**
+     * The new contents.
+     */
+    oldValue: Partial<IContentsModel> | null;
+    /**
+     * The old contents.
+     */
+    newValue: Partial<IContentsModel> | null;
+}
+/**
+ * The interface for a contents manager.
+ */
+export interface IContentsManager extends Disposable {
+    /**
+     * A signal emitted when a file operation takes place.
+     */
+    readonly fileChanged: ManaEvent<IContentsChangedArgs>;
+    /**
+     * The server settings associated with the manager.
+     */
+    /**
+     * Add an `IContentsDrive` to the manager.
+     */
+    addDrive: (drive: IContentsDrive) => void;
+    /**
+     * 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.
+     */
+    localPath: (path: string) => string;
+    /**
+     * 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.
+     */
+    normalize: (path: string) => string;
+    /**
+     * 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.
+     */
+    resolvePath: (root: string, path: string) => string;
+    /**
+     * 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.
+     */
+    driveName: (path: string) => string;
+    /**
+     * Given a path, get a ModelDB.IFactory from the
+     * relevant backend. Returns `null` if the backend
+     * does not provide one.
+     */
+    /**
+     * 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.
+     */
+    get: (path: string, options?: IContentsFetchOptions) => Promise<IContentsModel>;
+    /**
+     * Get an encoded download url given a file path.
+     *
+     * @param A promise which resolves with the absolute POSIX
+     *   file path on the server.
+     *
+     * #### Notes
+     * The returned URL may include a query parameter.
+     */
+    getDownloadUrl: (path: 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.
+     */
+    newUntitled: (options?: IContentsCreateOptions) => Promise<IContentsModel>;
+    /**
+     * Delete a file.
+     *
+     * @param path - The path to the file.
+     *
+     * @returns A promise which resolves when the file is deleted.
+     */
+    delete: (path: string, options?: IContentsRequestOptions) => Promise<void>;
+    /**
+     * 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 content model when the
+     *   file is renamed.
+     */
+    rename: (path: string, newPath: string, options?: IContentsRequestOptions) => Promise<IContentsModel>;
+    /**
+     * 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.
+     */
+    save: (path: string, options?: Partial<IContentsModel>) => Promise<IContentsModel>;
+    /**
+     * 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 content model when the
+     *  file is copied.
+     */
+    copy: (path: string, toDir: string, options?: IContentsRequestOptions) => Promise<IContentsModel>;
+    /**
+     * 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.
+     */
+    createCheckpoint: (path: string, options?: IContentsRequestOptions) => Promise<IContentsCheckpointModel>;
+    /**
+     * 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.
+     */
+    listCheckpoints: (path: string, options?: IContentsRequestOptions) => Promise<IContentsCheckpointModel[]>;
+    /**
+     * 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.
+     */
+    restoreCheckpoint: (path: string, checkpointID: string, options?: IContentsRequestOptions) => Promise<void>;
+    /**
+     * 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.
+     */
+    deleteCheckpoint: (path: string, checkpointID: string, options?: IContentsRequestOptions) => Promise<void>;
+}
+/**
+ * The interface for a network drive that can be mounted
+ * in the contents manager.
+ */
+export interface IContentsDrive extends Disposable {
+    /**
+     * The name of the drive, which is used at the leading
+     * component of file paths.
+     */
+    readonly name: string;
+    /**
+     * The server settings of the manager.
+     */
+    /**
+     * An optional ModelDB.IFactory instance for the
+     * drive.
+     */
+    /**
+     * A signal emitted when a file operation takes place.
+     */
+    fileChanged: ManaEvent<IContentsChangedArgs>;
+    /**
+     * 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.
+     */
+    get: (localPath: string, options?: IContentsFetchOptions) => Promise<IContentsModel>;
+    /**
+     * Get an encoded download url given a file path.
+     *
+     * @param A promise which resolves with the absolute POSIX
+     *   file path on the server.
+     *
+     * #### Notes
+     * 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.
+     */
+    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.
+     */
+    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 content model when the
+     *   file is renamed.
+     */
+    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.
+     */
+    save: (localPath: string, options?: Partial<IContentsModel>) => Promise<IContentsModel>;
+    /**
+     * Copy a file into a given directory.
+     *
+     * @param localPath - The original file path.
+     *
+     * @param toLocalDir - The destination directory path.
+     *
+     * @returns A promise which resolves with the new content model when the
+     *  file is copied.
+     */
+    copy: (localPath: string, toLocalDir: 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.
+     */
+    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.
+     */
+    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.
+     */
+    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.
+     */
+    deleteCheckpoint: (localPath: string, checkpointID: string, options?: IContentsRequestOptions) => Promise<void>;
+}
+/**
+ * The options used to initialize a contents manager.
+ */
+export interface IContentsManagerOptions {
+    /**
+     * The default drive backend for the contents manager.
+     */
+    defaultDrive?: IContentsDrive;
+    /**
+     * The server settings associated with the manager.
+     */
+    serverSettings?: ISettings;
+}
+/**
+ * The options used to initialize a `Drive`.
+ */
+export interface IDriveOptions {
+    /**
+     * The name for the `Drive`, which is used in file
+     * paths to disambiguate it from other drives.
+     */
+    name?: string;
+    /**
+     * The server settings for the server.
+     */
+    serverSettings?: ISettings;
+    /**
+     * A REST endpoint for drive requests.
+     * If not given, defaults to the Jupyter
+     * REST API given by [Jupyter Notebook API](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter/notebook/master/notebook/services/api/api.yaml#!/contents).
+     */
+    apiEndpoint?: string;
+}
+//# sourceMappingURL=contents-protocol.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"contents-protocol.d.ts","sourceRoot":"","sources":["../../src/contents/contents-protocol.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,KAAK,IAAI,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAExE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAEpD;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AAEjC;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,IAAI,CAAC;AAEnE;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,uBAAuB;IAC7D;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAE/B;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,kBAAkB,CAAC;IAErC;;OAEG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI,CAAC;IAEnC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,uBAAuB;IACpE;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,kBAAkB,CAAC;IAE5B;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,uBAAuB;IACrE;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,EAAE,KAAK,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAC;IAE3C;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC;CAC1C;AACD;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,SAAS,CAAC,oBAAoB,CAAC,CAAC;IAEtD;;OAEG;IAGH;;OAEG;IACH,QAAQ,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI,CAAC;IAE1C;;;;;;;OAOG;IACH,SAAS,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IAEpC;;;;;;;;OAQG;IACH,SAAS,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IAEpC;;;;;;;;;;OAUG;IACH,WAAW,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IAEpD;;;;;;;;OAQG;IACH,SAAS,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IAEpC;;;;OAIG;IAGH;;;;;;;;OAQG;IACH,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,qBAAqB,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAEhF;;;;;;;;OAQG;IACH,cAAc,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,uBAAuB,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAErF;;;;;;;OAOG;IACH,WAAW,EAAE,CAAC,OAAO,CAAC,EAAE,sBAAsB,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAE3E;;;;;;OAMG;IACH,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,uBAAuB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3E;;;;;;;;;OASG;IACH,MAAM,EAAE,CACN,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,uBAAuB,KAC9B,OAAO,CAAC,cAAc,CAAC,CAAC;IAE7B;;;;;;;;;OASG;IACH,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAEnF;;;;;;;;;OASG;IACH,IAAI,EAAE,CACJ,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,uBAAuB,KAC9B,OAAO,CAAC,cAAc,CAAC,CAAC;IAE7B;;;;;;;OAOG;IACH,gBAAgB,EAAE,CAChB,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,uBAAuB,KAC9B,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAEvC;;;;;;;OAOG;IACH,eAAe,EAAE,CACf,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,uBAAuB,KAC9B,OAAO,CAAC,wBAAwB,EAAE,CAAC,CAAC;IAEzC;;;;;;;;OAQG;IACH,iBAAiB,EAAE,CACjB,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,MAAM,EACpB,OAAO,CAAC,EAAE,uBAAuB,KAC9B,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnB;;;;;;;;OAQG;IACH,gBAAgB,EAAE,CAChB,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,MAAM,EACpB,OAAO,CAAC,EAAE,uBAAuB,KAC9B,OAAO,CAAC,IAAI,CAAC,CAAC;CACpB;AACD;;;GAGG;AACH,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;OAEG;IAGH;;;OAGG;IAGH;;OAEG;IACH,WAAW,EAAE,SAAS,CAAC,oBAAoB,CAAC,CAAC;IAE7C;;;;;;;;OAQG;IACH,GAAG,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,qBAAqB,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAErF;;;;;;;;OAQG;IACH,cAAc,EAAE,CACd,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,uBAAuB,KAC9B,OAAO,CAAC,MAAM,CAAC,CAAC;IAErB;;;;;;;OAOG;IACH,WAAW,EAAE,CAAC,OAAO,CAAC,EAAE,sBAAsB,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAE3E;;;;;;OAMG;IACH,MAAM,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,uBAAuB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhF;;;;;;;;;OASG;IACH,MAAM,EAAE,CACN,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,MAAM,EACpB,OAAO,CAAC,EAAE,uBAAuB,KAC9B,OAAO,CAAC,cAAc,CAAC,CAAC;IAE7B;;;;;;;;;OASG;IACH,IAAI,EAAE,CACJ,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,KAC9B,OAAO,CAAC,cAAc,CAAC,CAAC;IAE7B;;;;;;;;;OASG;IACH,IAAI,EAAE,CACJ,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,uBAAuB,KAC9B,OAAO,CAAC,cAAc,CAAC,CAAC;IAE7B;;;;;;;OAOG;IACH,gBAAgB,EAAE,CAChB,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,uBAAuB,KAC9B,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAEvC;;;;;;;OAOG;IACH,eAAe,EAAE,CACf,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,uBAAuB,KAC9B,OAAO,CAAC,wBAAwB,EAAE,CAAC,CAAC;IAEzC;;;;;;;;OAQG;IACH,iBAAiB,EAAE,CACjB,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,MAAM,EACpB,OAAO,CAAC,EAAE,uBAAuB,KAC9B,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnB;;;;;;;;OAQG;IACH,gBAAgB,EAAE,CAChB,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,MAAM,EACpB,OAAO,CAAC,EAAE,uBAAuB,KAC9B,OAAO,CAAC,IAAI,CAAC,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,SAAS,CAAC;CAC5B;AACD;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,cAAc,CAAC,EAAE,SAAS,CAAC;IAE3B;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB"}

package/es/contents/contents-protocol.js

@@ -0,0 +1 @@
+export {};

package/es/contents/index.d.ts

@@ -0,0 +1,6 @@
+export * from './contents-drive.js';
+export * from './contents-manager.js';
+export * from './contents-module.js';
+export * from './contents-protocol.js';
+export * from './validate.js';
+//# sourceMappingURL=index.d.ts.map

package/es/contents/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/contents/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,cAAc,eAAe,CAAC"}

package/es/contents/index.js

@@ -0,0 +1,5 @@
+export * from "./contents-drive.js";
+export * from "./contents-manager.js";
+export * from "./contents-module.js";
+export * from "./contents-protocol.js";
+export * from "./validate.js";

package/es/contents/validate.d.ts

@@ -0,0 +1,10 @@
+import type { IContentsCheckpointModel, IContentsModel } from './contents-protocol.js';
+/**
+ * Validate an `IContentsModel` object.
+ */
+export declare function validateContentsModel(model: IContentsModel): asserts model is IContentsModel;
+/**
+ * Validate an `IContentsCheckpointModel` object.
+ */
+export declare function validateCheckpointModel(model: IContentsCheckpointModel): asserts model is IContentsCheckpointModel;
+//# sourceMappingURL=validate.d.ts.map

package/es/contents/validate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../src/contents/validate.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,wBAAwB,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAEvF;;GAEG;AACH,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,cAAc,GACpB,OAAO,CAAC,KAAK,IAAI,cAAc,CASjC;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CACrC,KAAK,EAAE,wBAAwB,GAC9B,OAAO,CAAC,KAAK,IAAI,wBAAwB,CAG3C"}

package/es/contents/validate.js

@@ -0,0 +1,22 @@
+import { validateProperty } from "../validate-property.js";
+/**
+ * Validate an `IContentsModel` object.
+ */
+export function validateContentsModel(model) {
+  validateProperty(model, 'name', 'string');
+  validateProperty(model, 'path', 'string');
+  validateProperty(model, 'type', 'string');
+  validateProperty(model, 'created', 'string');
+  validateProperty(model, 'last_modified', 'string');
+  validateProperty(model, 'mimetype', 'object');
+  validateProperty(model, 'content', 'object');
+  validateProperty(model, 'format', 'object');
+}
+
+/**
+ * Validate an `IContentsCheckpointModel` object.
+ */
+export function validateCheckpointModel(model) {
+  validateProperty(model, 'id', 'string');
+  validateProperty(model, 'last_modified', 'string');
+}

package/es/index.d.ts

@@ -0,0 +1,10 @@
+export * from './module.js';
+export * from './contents/index.js';
+export * from './kernel/index.js';
+export * from './session/index.js';
+export * from './server/index.js';
+export * from './kernelspec/index.js';
+export * from './libro-kernel-connection-manager.js';
+export * from './page-config.js';
+export * from './protocol.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.tsx"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sCAAsC,CAAC;AACrD,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC"}

package/es/index.js

@@ -0,0 +1,9 @@
+export * from "./module.js";
+export * from "./contents/index.js";
+export * from "./kernel/index.js";
+export * from "./session/index.js";
+export * from "./server/index.js";
+export * from "./kernelspec/index.js";
+export * from "./libro-kernel-connection-manager.js";
+export * from "./page-config.js";
+export * from "./protocol.js";

package/es/kernel/comm.d.ts

@@ -0,0 +1,92 @@
+import type { JSONObject } from '@difizen/libro-common';
+import type { IComm, IShellFuture, IKernelConnection } from './libro-kernel-protocol.js';
+import * as KernelMessage from './messages.js';
+/**
+ * Comm channel handler.
+ */
+export declare class CommHandler implements IComm {
+    protected _target: string;
+    protected _id: string;
+    protected _kernel: IKernelConnection;
+    protected _onClose: (msg: KernelMessage.ICommCloseMsg<'iopub' | 'shell'>) => void | PromiseLike<void>;
+    protected _onMsg: (msg: KernelMessage.ICommMsgMsg) => void | PromiseLike<void>;
+    protected disposeCb: () => void;
+    disposed: boolean;
+    /**
+     * Construct a new comm channel.
+     */
+    constructor(target: string, id: string, kernel: IKernelConnection, disposeCb: () => void);
+    dispose(): void;
+    /**
+     * The unique id for the comm channel.
+     */
+    get commId(): string;
+    /**
+     * The target name for the comm channel.
+     */
+    get targetName(): string;
+    /**
+     * Get the callback for a comm close event.
+     *
+     * #### Notes
+     * This is called when the comm is closed from either the server or client.
+     *
+     * **See also:** [[ICommClose]], [[close]]
+     */
+    get onClose(): (msg: KernelMessage.ICommCloseMsg) => void | PromiseLike<void>;
+    /**
+     * Set the callback for a comm close event.
+     *
+     * #### Notes
+     * This is called when the comm is closed from either the server or client. If
+     * the function returns a promise, and the kernel was closed from the server,
+     * kernel message processing will pause until the returned promise is
+     * fulfilled.
+     *
+     * **See also:** [[close]]
+     */
+    set onClose(cb: (msg: KernelMessage.ICommCloseMsg) => void | PromiseLike<void>);
+    /**
+     * Get the callback for a comm message received event.
+     */
+    get onMsg(): (msg: KernelMessage.ICommMsgMsg) => void | PromiseLike<void>;
+    /**
+     * Set the callback for a comm message received event.
+     *
+     * #### Notes
+     * This is called when a comm message is received. If the function returns a
+     * promise, kernel message processing will pause until it is fulfilled.
+     */
+    set onMsg(cb: (msg: KernelMessage.ICommMsgMsg) => void | PromiseLike<void>);
+    /**
+     * Open a comm with optional data and metadata.
+     *
+     * #### Notes
+     * This sends a `comm_open` message to the server.
+     *
+     * **See also:** [[ICommOpen]]
+     */
+    open(data?: JSONObject, metadata?: JSONObject, buffers?: (ArrayBuffer | ArrayBufferView)[]): IShellFuture;
+    /**
+     * Send a `comm_msg` message to the kernel.
+     *
+     * #### Notes
+     * This is a no-op if the comm has been closed.
+     *
+     * **See also:** [[ICommMsg]]
+     */
+    send(data: JSONObject, metadata?: JSONObject, buffers?: (ArrayBuffer | ArrayBufferView)[], disposeOnDone?: boolean): IShellFuture;
+    /**
+     * Close the comm.
+     *
+     * #### Notes
+     * This will send a `comm_close` message to the kernel, and call the
+     * `onClose` callback if set.
+     *
+     * This is a no-op if the comm is already closed.
+     *
+     * **See also:** [[ICommClose]], [[onClose]]
+     */
+    close(data?: JSONObject, metadata?: JSONObject, buffers?: (ArrayBuffer | ArrayBufferView)[]): IShellFuture;
+}
+//# sourceMappingURL=comm.d.ts.map

package/es/kernel/comm.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"comm.d.ts","sourceRoot":"","sources":["../../src/kernel/comm.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAExD,OAAO,KAAK,EACV,KAAK,EACL,YAAY,EACZ,iBAAiB,EAClB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,aAAa,MAAM,eAAe,CAAC;AAE/C;;GAEG;AACH,qBAAa,WAAY,YAAW,KAAK;IACvC,SAAS,CAAC,OAAO,SAAM;IACvB,SAAS,CAAC,GAAG,SAAM;IACnB,SAAS,CAAC,OAAO,EAAE,iBAAiB,CAAC;IACrC,SAAS,CAAC,QAAQ,EAAE,CAClB,GAAG,EAAE,aAAa,CAAC,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC,KAChD,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAC9B,SAAS,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,aAAa,CAAC,WAAW,KAAK,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAE/E,SAAS,CAAC,SAAS,EAAE,MAAM,IAAI,CAAC;IAChC,QAAQ,UAAS;IAEjB;;OAEG;gBAED,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,iBAAiB,EACzB,SAAS,EAAE,MAAM,IAAI;IAOvB,OAAO;IAKP;;OAEG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED;;OAEG;IACH,IAAI,UAAU,IAAI,MAAM,CAEvB;IAED;;;;;;;OAOG;IACH,IAAI,OAAO,IAAI,CAAC,GAAG,EAAE,aAAa,CAAC,aAAa,KAAK,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,CAE5E;IAED;;;;;;;;;;OAUG;IACH,IAAI,OAAO,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,aAAa,CAAC,aAAa,KAAK,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,EAE7E;IAED;;OAEG;IACH,IAAI,KAAK,IAAI,CAAC,GAAG,EAAE,aAAa,CAAC,WAAW,KAAK,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,CAExE;IAED;;;;;;OAMG;IACH,IAAI,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,aAAa,CAAC,WAAW,KAAK,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,EAEzE;IAED;;;;;;;OAOG;IACH,IAAI,CACF,IAAI,CAAC,EAAE,UAAU,EACjB,QAAQ,CAAC,EAAE,UAAU,EACrB,OAAO,GAAE,CAAC,WAAW,GAAG,eAAe,CAAC,EAAO,GAC9C,YAAY;IAoBf;;;;;;;OAOG;IACH,IAAI,CACF,IAAI,EAAE,UAAU,EAChB,QAAQ,CAAC,EAAE,UAAU,EACrB,OAAO,GAAE,CAAC,WAAW,GAAG,eAAe,CAAC,EAAO,EAC/C,aAAa,UAAO,GACnB,YAAY;IAmBf;;;;;;;;;;OAUG;IACH,KAAK,CACH,IAAI,CAAC,EAAE,UAAU,EACjB,QAAQ,CAAC,EAAE,UAAU,EACrB,OAAO,GAAE,CAAC,WAAW,GAAG,eAAe,CAAC,EAAO,GAC9C,YAAY;CAsChB"}