@jupyterlite/application 0.7.0-alpha.2 → 0.7.0-alpha.4

package/lib/index.d.ts

@@ -1,2 +1,3 @@
+export * from './router';
 export * from './singleWidgetApp';
 export * from './singleWidgetShell';

package/lib/index.js

@@ -1,5 +1,6 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
+export * from './router';
 export * from './singleWidgetApp';
 export * from './singleWidgetShell';
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAE3D,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAE3D,cAAc,UAAU,CAAC;AACzB,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC"}

package/lib/router.d.ts

@@ -0,0 +1,54 @@
+import { IRouter, Router } from '@jupyterlab/application';
+import { Token } from '@lumino/coreutils';
+/**
+ * An interface for URL transformers
+ */
+export interface IURLTransformer {
+    id: string;
+    transform: (args: {
+        url: URL;
+        options: {
+            skipRouting?: boolean;
+            hard?: boolean;
+        };
+    }) => {
+        url: URL;
+        options: {
+            skipRouting?: boolean;
+            hard?: boolean;
+        };
+    };
+}
+/**
+ * An interface for the custom URL router provider.
+ *
+ * Provides IRouter, plus the additional methods to transform `/path/`-based routes
+ */
+export interface ILiteRouter extends IRouter {
+    /**
+     * Add a URL transformer
+     */
+    addTransformer: (transformer: IURLTransformer) => void;
+}
+/**
+ * A token for the ILiteRouter interface
+ */
+export declare const ILiteRouter: Token<ILiteRouter>;
+/**
+ * A custom router that extends the standard Router with URL transformation capabilities
+ */
+export declare class LiteRouter extends Router implements ILiteRouter {
+    constructor(options: Router.IOptions);
+    /**
+     * Add a URL transformer
+     */
+    addTransformer(transformer: IURLTransformer): void;
+    /**
+     * Navigate to a new path within the application.
+     */
+    navigate(url: string, options?: {
+        skipRouting?: boolean;
+        hard?: boolean;
+    }): void;
+    private _transformers;
+}

package/lib/router.js

@@ -0,0 +1,44 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+import { Router } from '@jupyterlab/application';
+import { Token } from '@lumino/coreutils';
+/**
+ * A token for the ILiteRouter interface
+ */
+export const ILiteRouter = new Token('@jupyterlite/application:ILiteRouter');
+/**
+ * A custom router that extends the standard Router with URL transformation capabilities
+ */
+export class LiteRouter extends Router {
+    constructor(options) {
+        super(options);
+        this._transformers = [];
+        this._transformers = [];
+    }
+    /**
+     * Add a URL transformer
+     */
+    addTransformer(transformer) {
+        this._transformers.push(transformer);
+    }
+    /**
+     * Navigate to a new path within the application.
+     */
+    navigate(url, options = {}) {
+        const urlObj = new URL(url, window.location.href);
+        // Apply all transformers
+        let transformedUrl = urlObj;
+        let transformedOptions = options;
+        for (const transformer of this._transformers) {
+            const result = transformer.transform({
+                url: transformedUrl,
+                options: transformedOptions,
+            });
+            transformedUrl = result.url;
+            transformedOptions = result.options;
+        }
+        // Call the parent navigate method with transformed values
+        super.navigate(transformedUrl.pathname + transformedUrl.search + transformedUrl.hash, transformedOptions);
+    }
+}
+//# sourceMappingURL=router.js.map

package/lib/router.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"router.js","sourceRoot":"","sources":["../src/router.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAE3D,OAAO,EAAW,MAAM,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AA4B1C;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,IAAI,KAAK,CAClC,sCAAsC,CACvC,CAAC;AAEF;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,MAAM;IACpC,YAAY,OAAwB;QAClC,KAAK,CAAC,OAAO,CAAC,CAAC;QAqCT,kBAAa,GAAsB,EAAE,CAAC;QApC5C,IAAI,CAAC,aAAa,GAAG,EAAE,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,WAA4B;QACzC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACvC,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,GAAW,EAAE,UAAqD,EAAE;QAC3E,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAElD,yBAAyB;QACzB,IAAI,cAAc,GAAG,MAAM,CAAC;QAC5B,IAAI,kBAAkB,GAAG,OAAO,CAAC;QAEjC,KAAK,MAAM,WAAW,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YAC7C,MAAM,MAAM,GAAG,WAAW,CAAC,SAAS,CAAC;gBACnC,GAAG,EAAE,cAAc;gBACnB,OAAO,EAAE,kBAAkB;aAC5B,CAAC,CAAC;YACH,cAAc,GAAG,MAAM,CAAC,GAAG,CAAC;YAC5B,kBAAkB,GAAG,MAAM,CAAC,OAAO,CAAC;QACtC,CAAC;QAED,0DAA0D;QAC1D,KAAK,CAAC,QAAQ,CACZ,cAAc,CAAC,QAAQ,GAAG,cAAc,CAAC,MAAM,GAAG,cAAc,CAAC,IAAI,EACrE,kBAAkB,CACnB,CAAC;IACJ,CAAC;CAGF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyterlite/application",
-  "version": "0.7.0-alpha.2",
+  "version": "0.7.0-alpha.4",
   "description": "JupyterLite - Application",
   "homepage": "https://github.com/jupyterlite/jupyterlite",
   "bugs": {
@@ -38,11 +38,11 @@
     "watch": "tsc -b --watch"
   },
   "dependencies": {
-    "@jupyterlab/application": "~4.5.0-alpha.2",
-    "@jupyterlab/coreutils": "~6.5.0-alpha.2",
-    "@jupyterlab/docregistry": "~4.5.0-alpha.2",
-    "@jupyterlab/rendermime-interfaces": "~3.13.0-alpha.2",
-    "@jupyterlite/server": "^0.7.0-alpha.2",
+    "@jupyterlab/application": "~4.5.0-alpha.3",
+    "@jupyterlab/coreutils": "~6.5.0-alpha.3",
+    "@jupyterlab/docregistry": "~4.5.0-alpha.3",
+    "@jupyterlab/rendermime-interfaces": "~3.13.0-alpha.3",
+    "@jupyterlite/server": "^0.7.0-alpha.4",
     "@lumino/coreutils": "^2.2.1",
     "@lumino/signaling": "^2.1.4",
     "@lumino/widgets": "^2.7.1"
@@ -50,7 +50,7 @@
   "devDependencies": {
     "@babel/core": "^7.11.6",
     "@babel/preset-env": "^7.12.1",
-    "@jupyterlab/testutils": "~4.5.0-alpha.2",
+    "@jupyterlab/testutils": "~4.5.0-alpha.3",
     "@types/jest": "^29.5.3",
     "jest": "^29.6.2",
     "rimraf": "~5.0.1",

package/src/index.ts

@@ -1,5 +1,6 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
 
+export * from './router';
 export * from './singleWidgetApp';
 export * from './singleWidgetShell';

package/src/router.ts

@@ -0,0 +1,83 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+
+import { IRouter, Router } from '@jupyterlab/application';
+import { Token } from '@lumino/coreutils';
+
+/**
+ * An interface for URL transformers
+ */
+export interface IURLTransformer {
+  id: string;
+  transform: (args: {
+    url: URL;
+    options: { skipRouting?: boolean; hard?: boolean };
+  }) => {
+    url: URL;
+    options: { skipRouting?: boolean; hard?: boolean };
+  };
+}
+
+/**
+ * An interface for the custom URL router provider.
+ *
+ * Provides IRouter, plus the additional methods to transform `/path/`-based routes
+ */
+export interface ILiteRouter extends IRouter {
+  /**
+   * Add a URL transformer
+   */
+  addTransformer: (transformer: IURLTransformer) => void;
+}
+
+/**
+ * A token for the ILiteRouter interface
+ */
+export const ILiteRouter = new Token<ILiteRouter>(
+  '@jupyterlite/application:ILiteRouter',
+);
+
+/**
+ * A custom router that extends the standard Router with URL transformation capabilities
+ */
+export class LiteRouter extends Router implements ILiteRouter {
+  constructor(options: Router.IOptions) {
+    super(options);
+    this._transformers = [];
+  }
+
+  /**
+   * Add a URL transformer
+   */
+  addTransformer(transformer: IURLTransformer): void {
+    this._transformers.push(transformer);
+  }
+
+  /**
+   * Navigate to a new path within the application.
+   */
+  navigate(url: string, options: { skipRouting?: boolean; hard?: boolean } = {}): void {
+    const urlObj = new URL(url, window.location.href);
+
+    // Apply all transformers
+    let transformedUrl = urlObj;
+    let transformedOptions = options;
+
+    for (const transformer of this._transformers) {
+      const result = transformer.transform({
+        url: transformedUrl,
+        options: transformedOptions,
+      });
+      transformedUrl = result.url;
+      transformedOptions = result.options;
+    }
+
+    // Call the parent navigate method with transformed values
+    super.navigate(
+      transformedUrl.pathname + transformedUrl.search + transformedUrl.hash,
+      transformedOptions,
+    );
+  }
+
+  private _transformers: IURLTransformer[] = [];
+}