@jupyterlab/rendermime-extension 4.0.0-alpha.2 → 4.0.0-alpha.20

package/lib/index.js

@@ -8,8 +8,8 @@
  */
 import { ISanitizer } from '@jupyterlab/apputils';
 import { IDocumentManager } from '@jupyterlab/docmanager';
-import { ILatexTypesetter, IRenderMimeRegistry, RenderMimeRegistry, standardRendererFactories } from '@jupyterlab/rendermime';
-import { ITranslator } from '@jupyterlab/translation';
+import { ILatexTypesetter, IMarkdownParser, IRenderMimeRegistry, RenderMimeRegistry, standardRendererFactories } from '@jupyterlab/rendermime';
+import { ITranslator, nullTranslator } from '@jupyterlab/translation';
 var CommandIDs;
 (function (CommandIDs) {
     CommandIDs.handleLink = 'rendermime:handle-local-link';
@@ -19,8 +19,13 @@ var CommandIDs;
  */
 const plugin = {
     id: '@jupyterlab/rendermime-extension:plugin',
-    requires: [ITranslator],
-    optional: [IDocumentManager, ILatexTypesetter, ISanitizer],
+    optional: [
+        IDocumentManager,
+        ILatexTypesetter,
+        ISanitizer,
+        IMarkdownParser,
+        ITranslator
+    ],
     provides: IRenderMimeRegistry,
     activate: activate,
     autoStart: true
@@ -32,8 +37,8 @@ export default plugin;
 /**
  * Activate the rendermine plugin.
  */
-function activate(app, translator, docManager, latexTypesetter, sanitizer) {
-    const trans = translator.load('jupyterlab');
+function activate(app, docManager, latexTypesetter, sanitizer, markdownParser, translator) {
+    const trans = (translator !== null && translator !== void 0 ? translator : nullTranslator).load('jupyterlab');
     if (docManager) {
         app.commands.addCommand(CommandIDs.handleLink, {
             label: trans.__('Handle Local Link'),
@@ -77,7 +82,8 @@ function activate(app, translator, docManager, latexTypesetter, sanitizer) {
                 }
             },
         latexTypesetter: latexTypesetter !== null && latexTypesetter !== void 0 ? latexTypesetter : undefined,
-        translator: translator,
+        markdownParser: markdownParser !== null && markdownParser !== void 0 ? markdownParser : undefined,
+        translator: translator !== null && translator !== void 0 ? translator : undefined,
         sanitizer: sanitizer !== null && sanitizer !== void 0 ? sanitizer : undefined
     });
 }

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;+EAG+E;AAC/E;;;GAGG;AAMH,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EACL,gBAAgB,EAChB,mBAAmB,EACnB,kBAAkB,EAClB,yBAAyB,EAC1B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAEtD,IAAU,UAAU,CAEnB;AAFD,WAAU,UAAU;IACL,qBAAU,GAAG,8BAA8B,CAAC;AAC3D,CAAC,EAFS,UAAU,KAAV,UAAU,QAEnB;AAED;;GAEG;AACH,MAAM,MAAM,GAA+C;IACzD,EAAE,EAAE,yCAAyC;IAC7C,QAAQ,EAAE,CAAC,WAAW,CAAC;IACvB,QAAQ,EAAE,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,UAAU,CAAC;IAC1D,QAAQ,EAAE,mBAAmB;IAC7B,QAAQ,EAAE,QAAQ;IAClB,SAAS,EAAE,IAAI;CAChB,CAAC;AAEF;;GAEG;AACH,eAAe,MAAM,CAAC;AAEtB;;GAEG;AACH,SAAS,QAAQ,CACf,GAAoB,EACpB,UAAuB,EACvB,UAAmC,EACnC,eAAwC,EACxC,SAA4B;IAE5B,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC5C,IAAI,UAAU,EAAE;QACd,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,UAAU,EAAE;YAC7C,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC,mBAAmB,CAAC;YACpC,OAAO,EAAE,IAAI,CAAC,EAAE;gBACd,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAA8B,CAAC;gBACvD,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,CAA8B,CAAC;gBACnD,IAAI,CAAC,IAAI,EAAE;oBACT,OAAO;iBACR;gBACD,gDAAgD;gBAChD,OAAO,UAAU,CAAC,QAAQ,CAAC,QAAQ;qBAChC,GAAG,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;qBAC7B,IAAI,CAAC,GAAG,EAAE;oBACT,0DAA0D;oBAC1D,iBAAiB;oBACjB,MAAM,OAAO,GAAG,UAAU,CAAC,QAAQ,CAAC,4BAA4B,CAC9D,IAAI,CACL,CAAC;oBACF,MAAM,MAAM,GAAG,UAAU,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;oBAE3D,4CAA4C;oBAC5C,IAAI,MAAM,IAAI,EAAE,EAAE;wBAChB,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;qBACxB;gBACH,CAAC,CAAC,CAAC;YACP,CAAC;SACF,CAAC,CAAC;KACJ;IACD,OAAO,IAAI,kBAAkB,CAAC;QAC5B,gBAAgB,EAAE,yBAAyB;QAC3C,WAAW,EAAE,CAAC,UAAU;YACtB,CAAC,CAAC,SAAS;YACX,CAAC,CAAC;gBACE,UAAU,EAAE,CAAC,IAAiB,EAAE,IAAY,EAAE,EAAW,EAAE,EAAE;oBAC3D,6DAA6D;oBAC7D,wCAAwC;oBACxC,IAAI,IAAI,CAAC,OAAO,KAAK,GAAG,IAAI,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,EAAE;wBACzD,OAAO;qBACR;oBACD,GAAG,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,EAAE,UAAU,CAAC,UAAU,EAAE;wBACzD,IAAI;wBACJ,EAAE;qBACH,CAAC,CAAC;gBACL,CAAC;aACF;QACL,eAAe,EAAE,eAAe,aAAf,eAAe,cAAf,eAAe,GAAI,SAAS;QAC7C,UAAU,EAAE,UAAU;QACtB,SAAS,EAAE,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,SAAS;KAClC,CAAC,CAAC;AACL,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;+EAG+E;AAC/E;;;GAGG;AAMH,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EACL,gBAAgB,EAChB,eAAe,EACf,mBAAmB,EACnB,kBAAkB,EAClB,yBAAyB,EAC1B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAEtE,IAAU,UAAU,CAEnB;AAFD,WAAU,UAAU;IACL,qBAAU,GAAG,8BAA8B,CAAC;AAC3D,CAAC,EAFS,UAAU,KAAV,UAAU,QAEnB;AAED;;GAEG;AACH,MAAM,MAAM,GAA+C;IACzD,EAAE,EAAE,yCAAyC;IAC7C,QAAQ,EAAE;QACR,gBAAgB;QAChB,gBAAgB;QAChB,UAAU;QACV,eAAe;QACf,WAAW;KACZ;IACD,QAAQ,EAAE,mBAAmB;IAC7B,QAAQ,EAAE,QAAQ;IAClB,SAAS,EAAE,IAAI;CAChB,CAAC;AAEF;;GAEG;AACH,eAAe,MAAM,CAAC;AAEtB;;GAEG;AACH,SAAS,QAAQ,CACf,GAAoB,EACpB,UAAmC,EACnC,eAAwC,EACxC,SAA4B,EAC5B,cAAsC,EACtC,UAA8B;IAE9B,MAAM,KAAK,GAAG,CAAC,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,cAAc,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAChE,IAAI,UAAU,EAAE;QACd,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,UAAU,EAAE;YAC7C,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC,mBAAmB,CAAC;YACpC,OAAO,EAAE,IAAI,CAAC,EAAE;gBACd,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAA8B,CAAC;gBACvD,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,CAA8B,CAAC;gBACnD,IAAI,CAAC,IAAI,EAAE;oBACT,OAAO;iBACR;gBACD,gDAAgD;gBAChD,OAAO,UAAU,CAAC,QAAQ,CAAC,QAAQ;qBAChC,GAAG,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;qBAC7B,IAAI,CAAC,GAAG,EAAE;oBACT,0DAA0D;oBAC1D,iBAAiB;oBACjB,MAAM,OAAO,GACX,UAAU,CAAC,QAAQ,CAAC,4BAA4B,CAAC,IAAI,CAAC,CAAC;oBACzD,MAAM,MAAM,GAAG,UAAU,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;oBAE3D,4CAA4C;oBAC5C,IAAI,MAAM,IAAI,EAAE,EAAE;wBAChB,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;qBACxB;gBACH,CAAC,CAAC,CAAC;YACP,CAAC;SACF,CAAC,CAAC;KACJ;IACD,OAAO,IAAI,kBAAkB,CAAC;QAC5B,gBAAgB,EAAE,yBAAyB;QAC3C,WAAW,EAAE,CAAC,UAAU;YACtB,CAAC,CAAC,SAAS;YACX,CAAC,CAAC;gBACE,UAAU,EAAE,CAAC,IAAiB,EAAE,IAAY,EAAE,EAAW,EAAE,EAAE;oBAC3D,6DAA6D;oBAC7D,wCAAwC;oBACxC,IAAI,IAAI,CAAC,OAAO,KAAK,GAAG,IAAI,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,EAAE;wBACzD,OAAO;qBACR;oBACD,GAAG,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,EAAE,UAAU,CAAC,UAAU,EAAE;wBACzD,IAAI;wBACJ,EAAE;qBACH,CAAC,CAAC;gBACL,CAAC;aACF;QACL,eAAe,EAAE,eAAe,aAAf,eAAe,cAAf,eAAe,GAAI,SAAS;QAC7C,cAAc,EAAE,cAAc,aAAd,cAAc,cAAd,cAAc,GAAI,SAAS;QAC3C,UAAU,EAAE,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,SAAS;QACnC,SAAS,EAAE,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,SAAS;KAClC,CAAC,CAAC;AACL,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyterlab/rendermime-extension",
-  "version": "4.0.0-alpha.2",
+  "version": "4.0.0-alpha.20",
   "description": "A rendermime extension for JupyterLab",
   "homepage": "https://github.com/jupyterlab/jupyterlab",
   "bugs": {
@@ -24,7 +24,8 @@
   "files": [
     "lib/**/*.{d.ts,eot,gif,html,jpg,js,js.map,json,png,svg,woff2,ttf}",
     "style/**/*.{css,eot,gif,html,jpg,json,png,svg,woff2,ttf}",
-    "style/index.js"
+    "style/index.js",
+    "src/**/*.{ts,tsx}"
   ],
   "scripts": {
     "build": "tsc -b",
@@ -33,16 +34,16 @@
     "watch": "tsc -b --watch"
   },
   "dependencies": {
-    "@jupyterlab/application": "^4.0.0-alpha.2",
-    "@jupyterlab/apputils": "^4.0.0-alpha.2",
-    "@jupyterlab/docmanager": "^4.0.0-alpha.2",
-    "@jupyterlab/rendermime": "^4.0.0-alpha.2",
-    "@jupyterlab/translation": "^4.0.0-alpha.2"
+    "@jupyterlab/application": "^4.0.0-alpha.20",
+    "@jupyterlab/apputils": "^4.0.0-alpha.20",
+    "@jupyterlab/docmanager": "^4.0.0-alpha.20",
+    "@jupyterlab/rendermime": "^4.0.0-alpha.20",
+    "@jupyterlab/translation": "^4.0.0-alpha.20"
   },
   "devDependencies": {
     "rimraf": "~3.0.0",
-    "typedoc": "~0.21.2",
-    "typescript": "~4.5.2"
+    "typedoc": "~0.23.25",
+    "typescript": "~5.0.0-beta"
   },
   "publishConfig": {
     "access": "public"

package/src/index.ts

@@ -0,0 +1,112 @@
+/* -----------------------------------------------------------------------------
+| Copyright (c) Jupyter Development Team.
+| Distributed under the terms of the Modified BSD License.
+|----------------------------------------------------------------------------*/
+/**
+ * @packageDocumentation
+ * @module rendermime-extension
+ */
+
+import {
+  JupyterFrontEnd,
+  JupyterFrontEndPlugin
+} from '@jupyterlab/application';
+import { ISanitizer } from '@jupyterlab/apputils';
+import { IDocumentManager } from '@jupyterlab/docmanager';
+import {
+  ILatexTypesetter,
+  IMarkdownParser,
+  IRenderMimeRegistry,
+  RenderMimeRegistry,
+  standardRendererFactories
+} from '@jupyterlab/rendermime';
+import { ITranslator, nullTranslator } from '@jupyterlab/translation';
+
+namespace CommandIDs {
+  export const handleLink = 'rendermime:handle-local-link';
+}
+
+/**
+ * A plugin providing a rendermime registry.
+ */
+const plugin: JupyterFrontEndPlugin<IRenderMimeRegistry> = {
+  id: '@jupyterlab/rendermime-extension:plugin',
+  optional: [
+    IDocumentManager,
+    ILatexTypesetter,
+    ISanitizer,
+    IMarkdownParser,
+    ITranslator
+  ],
+  provides: IRenderMimeRegistry,
+  activate: activate,
+  autoStart: true
+};
+
+/**
+ * Export the plugin as default.
+ */
+export default plugin;
+
+/**
+ * Activate the rendermine plugin.
+ */
+function activate(
+  app: JupyterFrontEnd,
+  docManager: IDocumentManager | null,
+  latexTypesetter: ILatexTypesetter | null,
+  sanitizer: ISanitizer | null,
+  markdownParser: IMarkdownParser | null,
+  translator: ITranslator | null
+): RenderMimeRegistry {
+  const trans = (translator ?? nullTranslator).load('jupyterlab');
+  if (docManager) {
+    app.commands.addCommand(CommandIDs.handleLink, {
+      label: trans.__('Handle Local Link'),
+      execute: args => {
+        const path = args['path'] as string | undefined | null;
+        const id = args['id'] as string | undefined | null;
+        if (!path) {
+          return;
+        }
+        // First check if the path exists on the server.
+        return docManager.services.contents
+          .get(path, { content: false })
+          .then(() => {
+            // Open the link with the default rendered widget factory,
+            // if applicable.
+            const factory =
+              docManager.registry.defaultRenderedWidgetFactory(path);
+            const widget = docManager.openOrReveal(path, factory.name);
+
+            // Handle the hash if one has been provided.
+            if (widget && id) {
+              widget.setFragment(id);
+            }
+          });
+      }
+    });
+  }
+  return new RenderMimeRegistry({
+    initialFactories: standardRendererFactories,
+    linkHandler: !docManager
+      ? undefined
+      : {
+          handleLink: (node: HTMLElement, path: string, id?: string) => {
+            // If node has the download attribute explicitly set, use the
+            // default browser downloading behavior.
+            if (node.tagName === 'A' && node.hasAttribute('download')) {
+              return;
+            }
+            app.commandLinker.connectNode(node, CommandIDs.handleLink, {
+              path,
+              id
+            });
+          }
+        },
+    latexTypesetter: latexTypesetter ?? undefined,
+    markdownParser: markdownParser ?? undefined,
+    translator: translator ?? undefined,
+    sanitizer: sanitizer ?? undefined
+  });
+}