@jupytergis/jupytergis-qgis 0.1.3 → 0.1.5

package/lib/plugins.js

@@ -1,14 +1,23 @@
 import { ICollaborativeDrive } from '@jupyter/docprovider';
-import { JupyterGISDoc, IJGISExternalCommandRegistryToken } from '@jupytergis/schema';
-import { IThemeManager, showErrorMessage } from '@jupyterlab/apputils';
+import { IJGISExternalCommandRegistryToken, JupyterGISDoc } from '@jupytergis/schema';
+import { Dialog, ICommandPalette, IThemeManager, InputDialog, showDialog, showErrorMessage } from '@jupyterlab/apputils';
 import { IEditorServices } from '@jupyterlab/codeeditor';
 import { ConsolePanel, IConsoleTracker } from '@jupyterlab/console';
+import { PathExt } from '@jupyterlab/coreutils';
 import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
+import { Widget } from '@lumino/widgets';
+import { requestAPI } from '@jupytergis/base';
 import { JupyterGISWidgetFactory } from '@jupytergis/jupytergis-core';
 import { IJupyterGISDocTracker } from '@jupytergis/schema';
-import { requestAPI } from '@jupytergis/base';
 import { QGSModelFactory, QGZModelFactory } from './modelfactory';
-const activate = async (app, tracker, themeManager, drive, externalCommandRegistry, contentFactory, editorServices, rendermime, consoleTracker) => {
+/**
+ * The command IDs used by the qgis plugin.
+ */
+var CommandIDs;
+(function (CommandIDs) {
+    CommandIDs.exportQgis = 'jupytergis:export';
+})(CommandIDs || (CommandIDs = {}));
+const activate = async (app, tracker, themeManager, drive, externalCommandRegistry, contentFactory, editorServices, rendermime, consoleTracker, commandPalette) => {
     const fcCheck = await requestAPI('jupytergis_qgis/backend-check', {
         method: 'POST',
         body: JSON.stringify({})
@@ -33,7 +42,8 @@ const activate = async (app, tracker, themeManager, drive, externalCommandRegist
         contentFactory,
         rendermime,
         mimeTypeService: editorServices.mimeTypeService,
-        consoleTracker
+        consoleTracker,
+        drive
     });
     const QGZWidgetFactory = new JupyterGISWidgetFactory({
         name: 'JupyterGIS QGZ Factory',
@@ -48,7 +58,8 @@ const activate = async (app, tracker, themeManager, drive, externalCommandRegist
         contentFactory,
         rendermime,
         mimeTypeService: editorServices.mimeTypeService,
-        consoleTracker
+        consoleTracker,
+        drive
     });
     // Registering the widget factory
     app.docRegistry.addWidgetFactory(QGSWidgetFactory);
@@ -90,10 +101,107 @@ const activate = async (app, tracker, themeManager, drive, externalCommandRegist
     };
     QGSWidgetFactory.widgetCreated.connect(widgetCreatedCallback);
     QGZWidgetFactory.widgetCreated.connect(widgetCreatedCallback);
-    console.log('jupytergis:qgisplugin is activated!');
+    /**
+     * The command to export the current main area jGIS project to QGIS file ('.qgz').
+     *
+     * A popup opens to choose a filepath (local from the current jGIS file) if the
+     * filepath is not provided in args.
+     */
+    if (installed) {
+        app.commands.addCommand(CommandIDs.exportQgis, {
+            label: 'Export To QGZ',
+            isEnabled: () => tracker.currentWidget
+                ? tracker.currentWidget.context.model.sharedModel.editable
+                : false,
+            execute: async (args) => {
+                var _a, _b;
+                const sourceExtension = '.jGIS';
+                const extension = '.qgz';
+                const model = (_a = tracker.currentWidget) === null || _a === void 0 ? void 0 : _a.context.model.sharedModel;
+                if (!model) {
+                    return;
+                }
+                const sourcePath = tracker.currentWidget.context.localPath;
+                let filepath = (_b = args.filepath) !== null && _b !== void 0 ? _b : null;
+                if (!filepath) {
+                    filepath = (await InputDialog.getText({
+                        label: 'File name',
+                        placeholder: PathExt.basename(sourcePath, sourceExtension),
+                        title: 'Export the project to QGZ file'
+                    })).value;
+                }
+                if (filepath === null) {
+                    // no-op if the dialog has been cancelled.
+                    return;
+                }
+                else if (!filepath) {
+                    // create the filepath if the dialog has been validated empty.
+                    filepath = `${PathExt.basename(sourcePath, sourceExtension)}${extension}`;
+                }
+                else if (!filepath.endsWith(extension)) {
+                    // add the extension to the path if it does not exist.
+                    filepath = `${filepath}${extension}`;
+                }
+                let dir = PathExt.dirname(sourcePath);
+                if (dir.includes(':')) {
+                    dir = dir.split(':')[1];
+                }
+                const absolutePath = PathExt.join(dir, filepath);
+                const virtualFile = {
+                    layers: model.layers,
+                    sources: model.sources,
+                    layerTree: model.layerTree.slice().reverse(),
+                    options: model.options
+                };
+                // Check if the file exists
+                let fileExist = true;
+                await drive.get(absolutePath, { content: false }).catch(() => {
+                    fileExist = false;
+                });
+                if (fileExist) {
+                    const overwrite = await showDialog({
+                        title: 'Export the project to QGZ file',
+                        body: `The file ${filepath} already exists.\nDo you want to overwrite it ?`
+                    });
+                    if (!overwrite.button.accept) {
+                        return;
+                    }
+                }
+                const response = await requestAPI('jupytergis_qgis/export', {
+                    method: 'POST',
+                    body: JSON.stringify({
+                        path: absolutePath,
+                        virtual_file: virtualFile
+                    })
+                });
+                if (!response.exported) {
+                    showErrorMessage('Export the project to QGZ file', response.logs.errors.length
+                        ? response.logs.errors.join('\n')
+                        : 'Unknown error');
+                }
+                else if (response.logs.warnings.length) {
+                    const bodyElement = document.createElement('pre');
+                    bodyElement.textContent = `${filepath} has been exported with warnings\n  - ${response.logs.warnings.join('\n  - ')}`;
+                    const body = new Widget({ node: bodyElement });
+                    await showDialog({
+                        title: 'Export the project to QGZ file',
+                        body,
+                        buttons: [Dialog.okButton()]
+                    });
+                }
+            }
+        });
+        if (commandPalette) {
+            commandPalette.addItem({
+                command: CommandIDs.exportQgis,
+                category: 'JupyterGIS'
+            });
+        }
+    }
+    console.log('@jupytergis/jupytergis-qgis:qgisplugin is activated!');
 };
 export const qgisplugin = {
-    id: 'jupytergis:qgisplugin',
+    id: '@jupytergis/jupytergis-qgis:qgisplugin',
     requires: [
         IJupyterGISDocTracker,
         IThemeManager,
@@ -104,6 +212,7 @@ export const qgisplugin = {
         IRenderMimeRegistry,
         IConsoleTracker
     ],
+    optional: [ICommandPalette],
     autoStart: true,
     activate
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupytergis/jupytergis-qgis",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "JupyterGIS QGIS extension.",
   "keywords": [
     "jupyter",
@@ -15,6 +15,7 @@
   "author": "JupyterGIS contributors",
   "files": [
     "lib/**/*.{d.ts,eot,gif,html,jpg,js,js.map,json,png,svg,woff2,ttf}",
+    "schema/*.json",
     "style/**/*.{css,js,eot,gif,html,jpg,json,png,svg,woff2,ttf}"
   ],
   "main": "lib/index.js",
@@ -53,9 +54,9 @@
   },
   "dependencies": {
     "@jupyter/docprovider": "^2.0.0",
-    "@jupytergis/base": "^0.1.3",
-    "@jupytergis/jupytergis-core": "^0.1.3",
-    "@jupytergis/schema": "^0.1.3",
+    "@jupytergis/base": "^0.1.5",
+    "@jupytergis/jupytergis-core": "^0.1.5",
+    "@jupytergis/schema": "^0.1.5",
     "@jupyterlab/application": "^4.0.0",
     "@jupyterlab/apputils": "^4.0.0",
     "@jupyterlab/coreutils": "^6.0.0",
@@ -99,6 +100,7 @@
       }
     },
     "extension": true,
+    "schemaDir": "schema",
     "outputDir": "jupytergis_qgis/labextension",
     "sharedPackages": {
       "@jupytergis/base": {

package/schema/qgisplugin.json

@@ -0,0 +1,27 @@
+{
+  "title": "Qgis plugin",
+  "description": "Schema for the qgis plugin",
+  "jupyter.lab.menus": {
+    "main": [
+      {
+        "id": "jp-mainmenu-file",
+        "items": [
+          {
+            "type": "separator",
+            "rank": 10
+          },
+          {
+            "command": "jupytergis:export",
+            "rank": 10
+          },
+          {
+            "type": "separator",
+            "rank": 10
+          }
+        ]
+      }
+    ]
+  },
+  "additionalProperties": false,
+  "type": "object"
+}