@hybridly/core 0.4.5 → 0.5.0

package/dist/index.cjs

@@ -644,6 +644,27 @@ async function closeDialog(options) {
   });
 }
 
+function isDownloadResponse(response) {
+  return response.status === 200 && !!response.headers["content-disposition"];
+}
+async function handleDownloadResponse(response) {
+  const blob = new Blob([response.data], { type: "application/octet-stream" });
+  const urlObject = window.webkitURL || window.URL;
+  const link = document.createElement("a");
+  link.style.display = "none";
+  link.href = urlObject.createObjectURL(blob);
+  link.download = getFileNameFromContentDispositionHeader(response.headers["content-disposition"]);
+  link.click();
+  setTimeout(() => {
+    urlObject.revokeObjectURL(link.href);
+    link.remove();
+  }, 0);
+}
+function getFileNameFromContentDispositionHeader(header) {
+  const result = header.split(";")[1]?.trim().split("=")[1];
+  return result?.replace(/^"(.*)"$/, "$1") ?? "";
+}
+
 function isPreloaded(targetUrl) {
   const context = getInternalRouterContext();
   return context.preloadCache.has(targetUrl.toString()) ?? false;
@@ -765,10 +786,7 @@ async function performHybridNavigation(options) {
       context.pendingNavigation?.controller?.abort();
     }
     saveScrollPositions();
-    if (options.url && options.transformUrl) {
-      options.url = makeUrl(options.url, options.transformUrl);
-    }
-    const targetUrl = makeUrl(options.url ?? context.url);
+    const targetUrl = makeUrl(options.url ?? context.url, options.transformUrl);
     const abortController = new AbortController();
     setContext({
       pendingNavigation: {
@@ -782,7 +800,10 @@ async function performHybridNavigation(options) {
     await runHooks("start", options.hooks, context);
     utils.debug.router("Making request with axios.");
     const response = await performHybridRequest(targetUrl, options, abortController);
-    await runHooks("data", options.hooks, response, context);
+    const result = await runHooks("data", options.hooks, response, context);
+    if (result === false) {
+      return { response };
+    }
     if (isExternalResponse(response)) {
       utils.debug.router("The response is explicitely external.");
       await performExternalNavigation({
@@ -791,6 +812,11 @@ async function performHybridNavigation(options) {
       });
       return { response };
     }
+    if (isDownloadResponse(response)) {
+      utils.debug.router("The response returns a file to download.");
+      await handleDownloadResponse(response);
+      return { response };
+    }
     if (!isHybridResponse(response)) {
       throw new NotAHybridResponseError(response);
     }
@@ -995,7 +1021,7 @@ async function initializeRouter() {
   } else if (isExternalNavigation()) {
     handleExternalNavigation();
   } else {
-    utils.debug.router("Handling the initial page navigation.");
+    utils.debug.router("Handling the initial navigation.");
     setContext({
       url: makeUrl(context.url, { hash: window.location.hash }).toString()
     });

package/dist/index.d.cts

@@ -55,7 +55,7 @@ interface Hooks extends RequestHooks {
          */
     initialized: (context: InternalRouterContext) => MaybePromise<any>;
     /**
-     * Called after Hybridly's initial page load.
+     * Called after Hybridly's initial load.
      */
     ready: (context: InternalRouterContext) => MaybePromise<any>;
     /**
@@ -134,7 +134,7 @@ interface ComponentNavigationOptions {
     replace?: ConditionalNavigationOption<boolean>;
     /** Whether to preserve the current scrollbar position. */
     preserveScroll?: ConditionalNavigationOption<boolean>;
-    /** Whether to preserve the current page component state. */
+    /** Whether to preserve the current view component state. */
     preserveState?: ConditionalNavigationOption<boolean>;
 }
 interface NavigationOptions {
@@ -145,9 +145,9 @@ interface NavigationOptions {
      * one. This affects the browser's "back" and "forward" features.
      */
     replace?: ConditionalNavigationOption<boolean>;
-    /** Whether to preserve the scrollbars positions on the page. */
+    /** Whether to preserve the scrollbars positions on the view. */
     preserveScroll?: ConditionalNavigationOption<boolean>;
-    /** Whether to preserve the current page component's state. */
+    /** Whether to preserve the current view component's state. */
     preserveState?: ConditionalNavigationOption<boolean>;
     /** Whether to preserve the current URL. */
     preserveUrl?: ConditionalNavigationOption<boolean>;
@@ -170,7 +170,7 @@ interface NavigationOptions {
 interface InternalNavigationOptions extends NavigationOptions {
     /**
      * Defines the kind of navigation being performed.
-     * - initial: the initial page load's navigation
+     * - initial: the initial load's navigation
      * - server: a navigation initiated by a server round-trip
      * - local: a navigation initiated by `router.local`
      * - back-forward: a navigation initiated by the browser's `popstate` event
@@ -278,7 +278,7 @@ interface PendingNavigation {
     /** Current status. */
     status: 'pending' | 'success' | 'error';
 }
-/** A page or dialog component. */
+/** A view or dialog component. */
 interface View {
     /** Name of the component to use. */
     component?: string;
@@ -288,7 +288,7 @@ interface View {
     deferred: string[];
 }
 interface Dialog extends Required<View> {
-    /** URL that is the base background page when navigating to the dialog directly. */
+    /** URL that is the base background view when navigating to the dialog directly. */
     baseUrl: string;
     /** URL to which the dialog should redirect when closed. */
     redirectUrl: string;

package/dist/index.d.mts

@@ -55,7 +55,7 @@ interface Hooks extends RequestHooks {
          */
     initialized: (context: InternalRouterContext) => MaybePromise<any>;
     /**
-     * Called after Hybridly's initial page load.
+     * Called after Hybridly's initial load.
      */
     ready: (context: InternalRouterContext) => MaybePromise<any>;
     /**
@@ -134,7 +134,7 @@ interface ComponentNavigationOptions {
     replace?: ConditionalNavigationOption<boolean>;
     /** Whether to preserve the current scrollbar position. */
     preserveScroll?: ConditionalNavigationOption<boolean>;
-    /** Whether to preserve the current page component state. */
+    /** Whether to preserve the current view component state. */
     preserveState?: ConditionalNavigationOption<boolean>;
 }
 interface NavigationOptions {
@@ -145,9 +145,9 @@ interface NavigationOptions {
      * one. This affects the browser's "back" and "forward" features.
      */
     replace?: ConditionalNavigationOption<boolean>;
-    /** Whether to preserve the scrollbars positions on the page. */
+    /** Whether to preserve the scrollbars positions on the view. */
     preserveScroll?: ConditionalNavigationOption<boolean>;
-    /** Whether to preserve the current page component's state. */
+    /** Whether to preserve the current view component's state. */
     preserveState?: ConditionalNavigationOption<boolean>;
     /** Whether to preserve the current URL. */
     preserveUrl?: ConditionalNavigationOption<boolean>;
@@ -170,7 +170,7 @@ interface NavigationOptions {
 interface InternalNavigationOptions extends NavigationOptions {
     /**
      * Defines the kind of navigation being performed.
-     * - initial: the initial page load's navigation
+     * - initial: the initial load's navigation
      * - server: a navigation initiated by a server round-trip
      * - local: a navigation initiated by `router.local`
      * - back-forward: a navigation initiated by the browser's `popstate` event
@@ -278,7 +278,7 @@ interface PendingNavigation {
     /** Current status. */
     status: 'pending' | 'success' | 'error';
 }
-/** A page or dialog component. */
+/** A view or dialog component. */
 interface View {
     /** Name of the component to use. */
     component?: string;
@@ -288,7 +288,7 @@ interface View {
     deferred: string[];
 }
 interface Dialog extends Required<View> {
-    /** URL that is the base background page when navigating to the dialog directly. */
+    /** URL that is the base background view when navigating to the dialog directly. */
     baseUrl: string;
     /** URL to which the dialog should redirect when closed. */
     redirectUrl: string;

package/dist/index.d.ts

@@ -55,7 +55,7 @@ interface Hooks extends RequestHooks {
          */
     initialized: (context: InternalRouterContext) => MaybePromise<any>;
     /**
-     * Called after Hybridly's initial page load.
+     * Called after Hybridly's initial load.
      */
     ready: (context: InternalRouterContext) => MaybePromise<any>;
     /**
@@ -134,7 +134,7 @@ interface ComponentNavigationOptions {
     replace?: ConditionalNavigationOption<boolean>;
     /** Whether to preserve the current scrollbar position. */
     preserveScroll?: ConditionalNavigationOption<boolean>;
-    /** Whether to preserve the current page component state. */
+    /** Whether to preserve the current view component state. */
     preserveState?: ConditionalNavigationOption<boolean>;
 }
 interface NavigationOptions {
@@ -145,9 +145,9 @@ interface NavigationOptions {
      * one. This affects the browser's "back" and "forward" features.
      */
     replace?: ConditionalNavigationOption<boolean>;
-    /** Whether to preserve the scrollbars positions on the page. */
+    /** Whether to preserve the scrollbars positions on the view. */
     preserveScroll?: ConditionalNavigationOption<boolean>;
-    /** Whether to preserve the current page component's state. */
+    /** Whether to preserve the current view component's state. */
     preserveState?: ConditionalNavigationOption<boolean>;
     /** Whether to preserve the current URL. */
     preserveUrl?: ConditionalNavigationOption<boolean>;
@@ -170,7 +170,7 @@ interface NavigationOptions {
 interface InternalNavigationOptions extends NavigationOptions {
     /**
      * Defines the kind of navigation being performed.
-     * - initial: the initial page load's navigation
+     * - initial: the initial load's navigation
      * - server: a navigation initiated by a server round-trip
      * - local: a navigation initiated by `router.local`
      * - back-forward: a navigation initiated by the browser's `popstate` event
@@ -278,7 +278,7 @@ interface PendingNavigation {
     /** Current status. */
     status: 'pending' | 'success' | 'error';
 }
-/** A page or dialog component. */
+/** A view or dialog component. */
 interface View {
     /** Name of the component to use. */
     component?: string;
@@ -288,7 +288,7 @@ interface View {
     deferred: string[];
 }
 interface Dialog extends Required<View> {
-    /** URL that is the base background page when navigating to the dialog directly. */
+    /** URL that is the base background view when navigating to the dialog directly. */
     baseUrl: string;
     /** URL to which the dialog should redirect when closed. */
     redirectUrl: string;

package/dist/index.mjs

@@ -637,6 +637,27 @@ async function closeDialog(options) {
   });
 }
 
+function isDownloadResponse(response) {
+  return response.status === 200 && !!response.headers["content-disposition"];
+}
+async function handleDownloadResponse(response) {
+  const blob = new Blob([response.data], { type: "application/octet-stream" });
+  const urlObject = window.webkitURL || window.URL;
+  const link = document.createElement("a");
+  link.style.display = "none";
+  link.href = urlObject.createObjectURL(blob);
+  link.download = getFileNameFromContentDispositionHeader(response.headers["content-disposition"]);
+  link.click();
+  setTimeout(() => {
+    urlObject.revokeObjectURL(link.href);
+    link.remove();
+  }, 0);
+}
+function getFileNameFromContentDispositionHeader(header) {
+  const result = header.split(";")[1]?.trim().split("=")[1];
+  return result?.replace(/^"(.*)"$/, "$1") ?? "";
+}
+
 function isPreloaded(targetUrl) {
   const context = getInternalRouterContext();
   return context.preloadCache.has(targetUrl.toString()) ?? false;
@@ -758,10 +779,7 @@ async function performHybridNavigation(options) {
       context.pendingNavigation?.controller?.abort();
     }
     saveScrollPositions();
-    if (options.url && options.transformUrl) {
-      options.url = makeUrl(options.url, options.transformUrl);
-    }
-    const targetUrl = makeUrl(options.url ?? context.url);
+    const targetUrl = makeUrl(options.url ?? context.url, options.transformUrl);
     const abortController = new AbortController();
     setContext({
       pendingNavigation: {
@@ -775,7 +793,10 @@ async function performHybridNavigation(options) {
     await runHooks("start", options.hooks, context);
     debug.router("Making request with axios.");
     const response = await performHybridRequest(targetUrl, options, abortController);
-    await runHooks("data", options.hooks, response, context);
+    const result = await runHooks("data", options.hooks, response, context);
+    if (result === false) {
+      return { response };
+    }
     if (isExternalResponse(response)) {
       debug.router("The response is explicitely external.");
       await performExternalNavigation({
@@ -784,6 +805,11 @@ async function performHybridNavigation(options) {
       });
       return { response };
     }
+    if (isDownloadResponse(response)) {
+      debug.router("The response returns a file to download.");
+      await handleDownloadResponse(response);
+      return { response };
+    }
     if (!isHybridResponse(response)) {
       throw new NotAHybridResponseError(response);
     }
@@ -988,7 +1014,7 @@ async function initializeRouter() {
   } else if (isExternalNavigation()) {
     handleExternalNavigation();
   } else {
-    debug.router("Handling the initial page navigation.");
+    debug.router("Handling the initial navigation.");
     setContext({
       url: makeUrl(context.url, { hash: window.location.hash }).toString()
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hybridly/core",
-  "version": "0.4.5",
+  "version": "0.5.0",
   "description": "Core functionality of Hybridly",
   "keywords": [
     "hybridly",
@@ -38,7 +38,7 @@
   "dependencies": {
     "qs": "^6.11.2",
     "superjson": "^1.13.1",
-    "@hybridly/utils": "0.4.5"
+    "@hybridly/utils": "0.5.0"
   },
   "devDependencies": {
     "defu": "^6.1.2"