@difizen/libro-kernel 0.0.2-alpha.0

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

@@ -0,0 +1,229 @@
+import type { Event as ManaEvent } from '@difizen/mana-app';
+import { Emitter } from '@difizen/mana-app';
+import type { IContentsDrive } from './contents-protocol.js';
+import type { IContentsChangedArgs, IContentsFetchOptions, IContentsManager, IContentsModel, IContentsRequestOptions, IContentsCreateOptions, IContentsCheckpointModel } from './contents-protocol.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 declare class ContentsManager implements IContentsManager {
+    constructor(defaultDrive: IContentsDrive);
+    /**
+     * The server settings associated with the manager.
+     */
+    /**
+     * A signal emitted when a file operation takes place.
+     */
+    get fileChanged(): ManaEvent<IContentsChangedArgs>;
+    /**
+     * Test whether the manager has been disposed.
+     */
+    get isDisposed(): boolean;
+    /**
+     * Dispose of the resources held by the manager.
+     */
+    dispose(): void;
+    /**
+     * Add an `IContentsDrive` to the manager.
+     */
+    addDrive(drive: IContentsDrive): void;
+    /**
+     * Given a path, get a ModelDB.IFactory from the
+     * relevant backend. Returns `undefined` if the backend
+     * does not provide one.
+     */
+    /**
+     * 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;
+    /**
+     * 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 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.
+     */
+    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 contents 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.
+     *
+     * #### Notes
+     * Ensure that `model.content` is populated for the file.
+     */
+    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 contents model when the
+     *  file is copied.
+     *
+     * #### Notes
+     * The server will select the name of the copied file.
+     */
+    copy(fromFile: 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>;
+    /**
+     * 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.
+     */
+    protected toGlobalPath(drive: IContentsDrive, localPath: string): string;
+    /**
+     * 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.
+     */
+    protected driveForPath(path: string): [IContentsDrive, string];
+    /**
+     * 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.
+     */
+    protected onFileChanged(sender: IContentsDrive, args: IContentsChangedArgs): void;
+    protected _isDisposed: boolean;
+    protected additionalDrives: Map<string, IContentsDrive>;
+    protected defaultDrive: IContentsDrive;
+    protected fileChangedEmitter: Emitter<IContentsChangedArgs>;
+}
+//# sourceMappingURL=contents-manager.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"contents-manager.d.ts","sourceRoot":"","sources":["../../src/contents/contents-manager.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,IAAI,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAE5D,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAG5C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,KAAK,EACV,oBAAoB,EACpB,qBAAqB,EACrB,gBAAgB,EAChB,cAAc,EACd,uBAAuB,EACvB,sBAAsB,EACtB,wBAAwB,EACzB,MAAM,wBAAwB,CAAC;AAEhC;;;;;;;GAOG;AACH,qBACa,eAAgB,YAAW,gBAAgB;gBAC3B,YAAY,EAAE,cAAc;IAOvD;;OAEG;IAGH;;OAEG;IACH,IAAI,WAAW,IAAI,SAAS,CAAC,oBAAoB,CAAC,CAGjD;IAED;;OAEG;IACH,IAAI,UAAU,IAAI,OAAO,CAExB;IAED;;OAEG;IACH,OAAO,IAAI,IAAI;IAQf;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,cAAc,GAAG,IAAI;IAKrC;;;;OAIG;IAMH;;;;;;;OAOG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAS/B;;;;;;;;OAQG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAQ/B;;;;;;;;;;OAUG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;IAO/C;;;;;;;;OAQG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAY/B;;;;;;;;OAQG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,cAAc,CAAC;IAsB3E;;;;;;;;;OASG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAAC,MAAM,CAAC;IAKhF;;;;;;;OAOG;IACH,WAAW,CAAC,OAAO,GAAE,sBAA2B,GAAG,OAAO,CAAC,cAAc,CAAC;IAiB1E;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;IAKtE;;;;;;;;;OASG;IACH,MAAM,CACJ,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,uBAAuB,GAChC,OAAO,CAAC,cAAc,CAAC;IAc1B;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,OAAO,CAAC,cAAc,CAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAUlF;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,uBAAuB,GAChC,OAAO,CAAC,cAAc,CAAC;IAe1B;;;;;;;OAOG;IACH,gBAAgB,CACd,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,uBAAuB,GAChC,OAAO,CAAC,wBAAwB,CAAC;IAKpC;;;;;;;OAOG;IACH,eAAe,CACb,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,uBAAuB,GAChC,OAAO,CAAC,wBAAwB,EAAE,CAAC;IAKtC;;;;;;;;OAQG;IACH,iBAAiB,CACf,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,MAAM,EACpB,OAAO,CAAC,EAAE,uBAAuB,GAChC,OAAO,CAAC,IAAI,CAAC;IAKhB;;;;;;;;OAQG;IACH,gBAAgB,CACd,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,MAAM,EACpB,OAAO,CAAC,EAAE,uBAAuB,GAChC,OAAO,CAAC,IAAI,CAAC;IAKhB;;;;;;;;;OASG;IACH,SAAS,CAAC,YAAY,CAAC,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM;IAQxE;;;;;;;;;;OAUG;IACH,SAAS,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,cAAc,EAAE,MAAM,CAAC;IAU9D;;;;OAIG;IACH,SAAS,CAAC,aAAa,CAAC,MAAM,EAAE,cAAc,EAAE,IAAI,EAAE,oBAAoB;IA0B1E,SAAS,CAAC,WAAW,UAAS;IAC9B,SAAS,CAAC,gBAAgB,8BAAqC;IAC/D,SAAS,CAAC,YAAY,EAAE,cAAc,CAAC;IACvC,SAAS,CAAC,kBAAkB,gCAAuC;CACpE"}