@jupyterlab/workspaces 4.2.0-alpha.2

package/lib/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @packageDocumentation
+ * @module workspaces
+ */
+export * from './model';
+export * from './tokens';

package/lib/index.js

@@ -0,0 +1,9 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+/**
+ * @packageDocumentation
+ * @module workspaces
+ */
+export * from './model';
+export * from './tokens';
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAC3D;;;GAGG;AAEH,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC"}

package/lib/model.d.ts

@@ -0,0 +1,87 @@
+import { Poll } from '@lumino/polling';
+import { ISignal } from '@lumino/signaling';
+import { Workspace } from '@jupyterlab/services';
+import { IWorkspacesModel } from './tokens';
+/**
+ * An implementation of a workspaces model.
+ */
+export declare class WorkspacesModel implements IWorkspacesModel {
+    constructor(options: WorkspacesModel.IOptions);
+    /**
+     * The list of available workspaces.
+     */
+    get workspaces(): Workspace.IWorkspace[];
+    /**
+     * The list of workspace identifiers.
+     */
+    get identifiers(): string[];
+    /**
+     * Create an empty workspace.
+     */
+    create(workspaceId: string): Promise<void>;
+    /**
+     * A signal emitted when the workspaces list is refreshed.
+     */
+    get refreshed(): ISignal<WorkspacesModel, void>;
+    /**
+     * Force a refresh of the workspaces list.
+     */
+    refresh(): Promise<void>;
+    /**
+     * Rename a workspace.
+     */
+    rename(workspaceId: string, newName: string): Promise<void>;
+    /**
+     * Reset a workspace.
+     */
+    reset(workspaceId: string): Promise<void>;
+    /**
+     * Remove a workspace.
+     */
+    remove(workspaceId: string): Promise<void>;
+    /**
+     * Save workspace under a different name.
+     */
+    saveAs(workspaceId: string, newName: string): Promise<void>;
+    /**
+     * Get whether the model is disposed.
+     */
+    get isDisposed(): boolean;
+    /**
+     * Dispose of the resources held by the model.
+     */
+    dispose(): void;
+    private _fetchList;
+    private _refreshed;
+    private _isDisposed;
+    private _poll;
+    private _manager;
+    private _workspaceData;
+}
+/**
+ * The namespace for the `WorkspacesModel` class statics.
+ */
+export declare namespace WorkspacesModel {
+    /**
+     * An options object for initializing a the workspaces model.
+     */
+    interface IOptions {
+        /**
+         * The workspaces manager.
+         */
+        manager: Workspace.IManager;
+        /**
+         * Whether a to automatically loads initial list of workspaces.
+         * The default is `true`.
+         */
+        auto?: boolean;
+        /**
+         * The time interval for browser refreshing, in ms.
+         */
+        refreshInterval?: number;
+        /**
+         * When the model stops polling the API. Defaults to `when-hidden`.
+         */
+        refreshStandby?: Poll.Standby | (() => boolean | Poll.Standby);
+    }
+}

package/lib/model.js

@@ -0,0 +1,129 @@
+/*
+ * Copyright (c) Jupyter Development Team.
+ * Distributed under the terms of the Modified BSD License.
+ */
+import { Poll } from '@lumino/polling';
+import { Signal } from '@lumino/signaling';
+/**
+ * The default duration of the auto-refresh in ms
+ */
+const DEFAULT_REFRESH_INTERVAL = 10000;
+/**
+ * An implementation of a workspaces model.
+ */
+export class WorkspacesModel {
+    constructor(options) {
+        var _a;
+        this._refreshed = new Signal(this);
+        this._isDisposed = false;
+        this._workspaceData = {
+            ids: [],
+            values: []
+        };
+        this._manager = options.manager;
+        const refreshInterval = options.refreshInterval || DEFAULT_REFRESH_INTERVAL;
+        this._poll = new Poll({
+            auto: (_a = options.auto) !== null && _a !== void 0 ? _a : true,
+            name: '@jupyterlab/workspaces:Model',
+            factory: () => this._fetchList(),
+            frequency: {
+                interval: refreshInterval,
+                backoff: true,
+                max: 300 * 1000
+            },
+            standby: options.refreshStandby || 'when-hidden'
+        });
+    }
+    /**
+     * The list of available workspaces.
+     */
+    get workspaces() {
+        return this._workspaceData.values;
+    }
+    /**
+     * The list of workspace identifiers.
+     */
+    get identifiers() {
+        return this._workspaceData.ids;
+    }
+    /**
+     * Create an empty workspace.
+     */
+    async create(workspaceId) {
+        await this._manager.save(workspaceId, {
+            metadata: { id: workspaceId },
+            data: {}
+        });
+        await this.refresh();
+    }
+    /**
+     * A signal emitted when the workspaces list is refreshed.
+     */
+    get refreshed() {
+        return this._refreshed;
+    }
+    /**
+     * Force a refresh of the workspaces list.
+     */
+    async refresh() {
+        await this._poll.refresh();
+        await this._poll.tick;
+    }
+    /**
+     * Rename a workspace.
+     */
+    async rename(workspaceId, newName) {
+        const workspace = await this._manager.fetch(workspaceId);
+        workspace.metadata.id = newName;
+        await this._manager.save(newName, workspace);
+        await this._manager.remove(workspaceId);
+        await this.refresh();
+    }
+    /**
+     * Reset a workspace.
+     */
+    async reset(workspaceId) {
+        const workspace = await this._manager.fetch(workspaceId);
+        workspace.data = {};
+        await this._manager.save(workspaceId, workspace);
+        await this.refresh();
+    }
+    /**
+     * Remove a workspace.
+     */
+    async remove(workspaceId) {
+        await this._manager.remove(workspaceId);
+        await this.refresh();
+    }
+    /**
+     * Save workspace under a different name.
+     */
+    async saveAs(workspaceId, newName) {
+        const data = await this._manager.fetch(workspaceId);
+        data.metadata.id = newName;
+        await this._manager.save(newName, data);
+        await this.refresh();
+    }
+    /**
+     * Get whether the model is disposed.
+     */
+    get isDisposed() {
+        return this._isDisposed;
+    }
+    /**
+     * Dispose of the resources held by the model.
+     */
+    dispose() {
+        if (this.isDisposed) {
+            return;
+        }
+        this._isDisposed = true;
+        this._poll.dispose();
+        Signal.clearData(this);
+    }
+    async _fetchList() {
+        this._workspaceData = await this._manager.list();
+        this._refreshed.emit(void 0);
+    }
+}
+//# sourceMappingURL=model.js.map

package/lib/model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.js","sourceRoot":"","sources":["../src/model.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAW,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAIpD;;GAEG;AACH,MAAM,wBAAwB,GAAG,KAAK,CAAC;AAEvC;;GAEG;AACH,MAAM,OAAO,eAAe;IAC1B,YAAY,OAAiC;;QAwHrC,eAAU,GAAG,IAAI,MAAM,CAAwB,IAAI,CAAC,CAAC;QACrD,gBAAW,GAAG,KAAK,CAAC;QAGpB,mBAAc,GAAsD;YAC1E,GAAG,EAAE,EAAE;YACP,MAAM,EAAE,EAAE;SACX,CAAC;QA9HA,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;QAChC,MAAM,eAAe,GAAG,OAAO,CAAC,eAAe,IAAI,wBAAwB,CAAC;QAC5E,IAAI,CAAC,KAAK,GAAG,IAAI,IAAI,CAAC;YACpB,IAAI,EAAE,MAAA,OAAO,CAAC,IAAI,mCAAI,IAAI;YAC1B,IAAI,EAAE,8BAA8B;YACpC,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,UAAU,EAAE;YAChC,SAAS,EAAE;gBACT,QAAQ,EAAE,eAAe;gBACzB,OAAO,EAAE,IAAI;gBACb,GAAG,EAAE,GAAG,GAAG,IAAI;aAChB;YACD,OAAO,EAAE,OAAO,CAAC,cAAc,IAAI,aAAa;SACjD,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,WAAmB;QAC9B,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE;YACpC,QAAQ,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE;YAC7B,IAAI,EAAE,EAAE;SACT,CAAC,CAAC;QACH,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO;QACX,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;QAC3B,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,WAAmB,EAAE,OAAe;QAC/C,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACzD,SAAS,CAAC,QAAQ,CAAC,EAAE,GAAG,OAAO,CAAC;QAEhC,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QAC7C,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACxC,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK,CAAC,WAAmB;QAC7B,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACzD,SAAS,CAAC,IAAI,GAAG,EAAE,CAAC;QACpB,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;QACjD,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,WAAmB;QAC9B,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACxC,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,WAAmB,EAAE,OAAe;QAC/C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACpD,IAAI,CAAC,QAAQ,CAAC,EAAE,GAAG,OAAO,CAAC;QAC3B,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACxC,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,OAAO;QACL,IAAI,IAAI,CAAC,UAAU,EAAE;YACnB,OAAO;SACR;QACD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;QACrB,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IAEO,KAAK,CAAC,UAAU;QACtB,IAAI,CAAC,cAAc,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;QACjD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAC/B,CAAC;CAUF"}

package/lib/tokens.d.ts

@@ -0,0 +1,66 @@
+import { Token } from '@lumino/coreutils';
+import { IDisposable } from '@lumino/disposable';
+import { ISignal } from '@lumino/signaling';
+import type { Workspace } from '@jupyterlab/services';
+/**
+ * The token that provides the identifiers of workspace commands for reuse.
+ */
+export declare const IWorkspaceCommands: Token<IWorkspaceCommands>;
+/**
+ * The identifiers of loaded commands exposed for reuse.
+ */
+export interface IWorkspaceCommands {
+    /**
+     * Command for opening a workspace by identifier.
+     */
+    open: string;
+    /**
+     * Command for deleting a workspace.
+     */
+    deleteWorkspace: string;
+}
+/**
+ * The token that provides the identifiers of workspace commands for reuse.
+ */
+export declare const IWorkspacesModel: Token<IWorkspacesModel>;
+/**
+ * The model for listing available workspaces.
+ */
+export interface IWorkspacesModel extends IDisposable {
+    /**
+     * The list of available workspaces.
+     */
+    readonly workspaces: Workspace.IWorkspace[];
+    /**
+     * The list of workspace identifiers.
+     */
+    readonly identifiers: string[];
+    /**
+     * Create an empty workspace.
+     */
+    create(workspaceId: string): Promise<void>;
+    /**
+     * Rename a workspace.
+     */
+    rename(workspaceId: string, newName: string): Promise<void>;
+    /**
+     * Refresh the listing of workspaces.
+     */
+    refresh(): Promise<void>;
+    /**
+     * Signal emitted when the listing is refreshed.
+     */
+    refreshed: ISignal<IWorkspacesModel, void>;
+    /**
+     * Reset a workspace.
+     */
+    reset(workspaceId: string): Promise<void>;
+    /**
+     * Remove a workspace.
+     */
+    remove(workspaceId: string): Promise<void>;
+    /**
+     * Save workspace under a different name.
+     */
+    saveAs(workspaceId: string, newName: string): Promise<void>;
+}

package/lib/tokens.js

@@ -0,0 +1,12 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+import { Token } from '@lumino/coreutils';
+/**
+ * The token that provides the identifiers of workspace commands for reuse.
+ */
+export const IWorkspaceCommands = new Token('@jupyterlab/workspaces:IWorkspaceCommands', 'Provides identifiers of workspace commands.');
+/**
+ * The token that provides the identifiers of workspace commands for reuse.
+ */
+export const IWorkspacesModel = new Token('@jupyterlab/workspaces:IWorkspacesModel', 'Provides a model for available workspaces.');
+//# sourceMappingURL=tokens.js.map

package/lib/tokens.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokens.js","sourceRoot":"","sources":["../src/tokens.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAC3D,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAK1C;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,IAAI,KAAK,CACzC,2CAA2C,EAC3C,6CAA6C,CAC9C,CAAC;AAgBF;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,KAAK,CACvC,yCAAyC,EACzC,4CAA4C,CAC7C,CAAC"}

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@jupyterlab/workspaces",
+  "version": "4.2.0-alpha.2",
+  "description": "JupyterLab workspaces management",
+  "homepage": "https://github.com/jupyterlab/jupyterlab",
+  "bugs": {
+    "url": "https://github.com/jupyterlab/jupyterlab/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jupyterlab/jupyterlab.git"
+  },
+  "license": "BSD-3-Clause",
+  "author": "Project Jupyter",
+  "sideEffects": [
+    "style/**/*"
+  ],
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "directories": {
+    "lib": "lib/"
+  },
+  "files": [
+    "lib/**/*.{d.ts,eot,gif,html,jpg,js,js.map,json,png,svg,woff2,ttf}",
+    "schema/*.json",
+    "style/**/*.{css,eot,gif,html,jpg,json,png,svg,woff2,ttf}",
+    "src/**/*.{ts,tsx}",
+    "style/index.js"
+  ],
+  "scripts": {
+    "build": "tsc -b",
+    "build:test": "tsc --build tsconfig.test.json",
+    "clean": "rimraf lib tsconfig.tsbuildinfo",
+    "docs": "typedoc src",
+    "test": "jest",
+    "test:cov": "jest --collect-coverage",
+    "test:debug": "node --inspect-brk ../../node_modules/.bin/jest --runInBand",
+    "test:debug:watch": "node --inspect-brk ../../node_modules/.bin/jest --runInBand --watch",
+    "watch": "tsc -b --watch"
+  },
+  "dependencies": {
+    "@jupyterlab/services": "^7.2.0-alpha.2",
+    "@lumino/coreutils": "^2.1.2",
+    "@lumino/disposable": "^2.1.2",
+    "@lumino/polling": "^2.1.2",
+    "@lumino/signaling": "^2.1.2"
+  },
+  "devDependencies": {
+    "@jupyterlab/testing": "^4.2.0-alpha.2",
+    "@types/jest": "^29.2.0",
+    "jest": "^29.2.0",
+    "rimraf": "~5.0.5",
+    "typedoc": "~0.24.7",
+    "typescript": "~5.1.6"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/index.ts

@@ -0,0 +1,9 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+/**
+ * @packageDocumentation
+ * @module workspaces
+ */
+
+export * from './model';
+export * from './tokens';

package/src/model.ts

@@ -0,0 +1,179 @@
+/*
+ * Copyright (c) Jupyter Development Team.
+ * Distributed under the terms of the Modified BSD License.
+ */
+
+import { Poll } from '@lumino/polling';
+import { ISignal, Signal } from '@lumino/signaling';
+import { Workspace } from '@jupyterlab/services';
+import { IWorkspacesModel } from './tokens';
+
+/**
+ * The default duration of the auto-refresh in ms
+ */
+const DEFAULT_REFRESH_INTERVAL = 10000;
+
+/**
+ * An implementation of a workspaces model.
+ */
+export class WorkspacesModel implements IWorkspacesModel {
+  constructor(options: WorkspacesModel.IOptions) {
+    this._manager = options.manager;
+    const refreshInterval = options.refreshInterval || DEFAULT_REFRESH_INTERVAL;
+    this._poll = new Poll({
+      auto: options.auto ?? true,
+      name: '@jupyterlab/workspaces:Model',
+      factory: () => this._fetchList(),
+      frequency: {
+        interval: refreshInterval,
+        backoff: true,
+        max: 300 * 1000
+      },
+      standby: options.refreshStandby || 'when-hidden'
+    });
+  }
+
+  /**
+   * The list of available workspaces.
+   */
+  get workspaces(): Workspace.IWorkspace[] {
+    return this._workspaceData.values;
+  }
+
+  /**
+   * The list of workspace identifiers.
+   */
+  get identifiers(): string[] {
+    return this._workspaceData.ids;
+  }
+
+  /**
+   * Create an empty workspace.
+   */
+  async create(workspaceId: string): Promise<void> {
+    await this._manager.save(workspaceId, {
+      metadata: { id: workspaceId },
+      data: {}
+    });
+    await this.refresh();
+  }
+
+  /**
+   * A signal emitted when the workspaces list is refreshed.
+   */
+  get refreshed(): ISignal<WorkspacesModel, void> {
+    return this._refreshed;
+  }
+
+  /**
+   * Force a refresh of the workspaces list.
+   */
+  async refresh(): Promise<void> {
+    await this._poll.refresh();
+    await this._poll.tick;
+  }
+
+  /**
+   * Rename a workspace.
+   */
+  async rename(workspaceId: string, newName: string): Promise<void> {
+    const workspace = await this._manager.fetch(workspaceId);
+    workspace.metadata.id = newName;
+
+    await this._manager.save(newName, workspace);
+    await this._manager.remove(workspaceId);
+    await this.refresh();
+  }
+
+  /**
+   * Reset a workspace.
+   */
+  async reset(workspaceId: string): Promise<void> {
+    const workspace = await this._manager.fetch(workspaceId);
+    workspace.data = {};
+    await this._manager.save(workspaceId, workspace);
+    await this.refresh();
+  }
+
+  /**
+   * Remove a workspace.
+   */
+  async remove(workspaceId: string): Promise<void> {
+    await this._manager.remove(workspaceId);
+    await this.refresh();
+  }
+
+  /**
+   * Save workspace under a different name.
+   */
+  async saveAs(workspaceId: string, newName: string): Promise<void> {
+    const data = await this._manager.fetch(workspaceId);
+    data.metadata.id = newName;
+    await this._manager.save(newName, data);
+    await this.refresh();
+  }
+
+  /**
+   * Get whether the model is disposed.
+   */
+  get isDisposed(): boolean {
+    return this._isDisposed;
+  }
+
+  /**
+   * Dispose of the resources held by the model.
+   */
+  dispose(): void {
+    if (this.isDisposed) {
+      return;
+    }
+    this._isDisposed = true;
+    this._poll.dispose();
+    Signal.clearData(this);
+  }
+
+  private async _fetchList() {
+    this._workspaceData = await this._manager.list();
+    this._refreshed.emit(void 0);
+  }
+
+  private _refreshed = new Signal<WorkspacesModel, void>(this);
+  private _isDisposed = false;
+  private _poll: Poll;
+  private _manager: Workspace.IManager;
+  private _workspaceData: { ids: string[]; values: Workspace.IWorkspace[] } = {
+    ids: [],
+    values: []
+  };
+}
+
+/**
+ * The namespace for the `WorkspacesModel` class statics.
+ */
+export namespace WorkspacesModel {
+  /**
+   * An options object for initializing a the workspaces model.
+   */
+  export interface IOptions {
+    /**
+     * The workspaces manager.
+     */
+    manager: Workspace.IManager;
+
+    /**
+     * Whether a to automatically loads initial list of workspaces.
+     * The default is `true`.
+     */
+    auto?: boolean;
+
+    /**
+     * The time interval for browser refreshing, in ms.
+     */
+    refreshInterval?: number;
+
+    /**
+     * When the model stops polling the API. Defaults to `when-hidden`.
+     */
+    refreshStandby?: Poll.Standby | (() => boolean | Poll.Standby);
+  }
+}

package/src/tokens.ts

@@ -0,0 +1,86 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+import { Token } from '@lumino/coreutils';
+import { IDisposable } from '@lumino/disposable';
+import { ISignal } from '@lumino/signaling';
+import type { Workspace } from '@jupyterlab/services';
+
+/**
+ * The token that provides the identifiers of workspace commands for reuse.
+ */
+export const IWorkspaceCommands = new Token<IWorkspaceCommands>(
+  '@jupyterlab/workspaces:IWorkspaceCommands',
+  'Provides identifiers of workspace commands.'
+);
+
+/**
+ * The identifiers of loaded commands exposed for reuse.
+ */
+export interface IWorkspaceCommands {
+  /**
+   * Command for opening a workspace by identifier.
+   */
+  open: string;
+  /**
+   * Command for deleting a workspace.
+   */
+  deleteWorkspace: string;
+}
+
+/**
+ * The token that provides the identifiers of workspace commands for reuse.
+ */
+export const IWorkspacesModel = new Token<IWorkspacesModel>(
+  '@jupyterlab/workspaces:IWorkspacesModel',
+  'Provides a model for available workspaces.'
+);
+
+/**
+ * The model for listing available workspaces.
+ */
+export interface IWorkspacesModel extends IDisposable {
+  /**
+   * The list of available workspaces.
+   */
+  readonly workspaces: Workspace.IWorkspace[];
+
+  /**
+   * The list of workspace identifiers.
+   */
+  readonly identifiers: string[];
+
+  /**
+   * Create an empty workspace.
+   */
+  create(workspaceId: string): Promise<void>;
+
+  /**
+   * Rename a workspace.
+   */
+  rename(workspaceId: string, newName: string): Promise<void>;
+
+  /**
+   * Refresh the listing of workspaces.
+   */
+  refresh(): Promise<void>;
+
+  /**
+   * Signal emitted when the listing is refreshed.
+   */
+  refreshed: ISignal<IWorkspacesModel, void>;
+
+  /**
+   * Reset a workspace.
+   */
+  reset(workspaceId: string): Promise<void>;
+
+  /**
+   * Remove a workspace.
+   */
+  remove(workspaceId: string): Promise<void>;
+
+  /**
+   * Save workspace under a different name.
+   */
+  saveAs(workspaceId: string, newName: string): Promise<void>;
+}