@dudousxd/nestjs-durable-dashboard 0.37.1 → 0.38.0

package/dist/server/index.cjs

@@ -593,6 +593,9 @@ function resolveDashboardAuth(options) {
   if (options.revalidate !== void 0 && typeof options.revalidate !== "function") {
     throw new Error("DurableDashboardModule: dashboardAuth.revalidate must be a function.");
   }
+  if (options.unauthenticatedPage !== void 0 && typeof options.unauthenticatedPage !== "function") {
+    throw new Error("DurableDashboardModule: dashboardAuth.unauthenticatedPage must be a function.");
+  }
   if (modes.length === 0) {
     throw new Error("DurableDashboardModule: dashboardAuth needs at least one of `session` or `login` (otherwise the cookie can never be minted). Failing closed.");
   }
@@ -608,6 +611,9 @@ function resolveDashboardAuth(options) {
     } : {},
     ...options.revalidate !== void 0 ? {
       revalidate: options.revalidate
+    } : {},
+    ...options.unauthenticatedPage !== void 0 ? {
+      unauthenticatedPage: options.unauthenticatedPage
     } : {}
   };
 }
@@ -884,6 +890,11 @@ function redirectRaw(response, location, status = 302) {
   raw.end();
 }
 __name(redirectRaw, "redirectRaw");
+function responseAlreadyWritten(response) {
+  const raw = resolveRedirectResponse(response);
+  return raw?.headersSent === true;
+}
+__name(responseAlreadyWritten, "responseAlreadyWritten");
 function writeHtmlRaw(response, html, status = 200) {
   const raw = resolveRedirectResponse(response);
   if (!raw) return;
@@ -1137,6 +1148,16 @@ function _ts_decorate4(decorators, target, key, desc) {
   return c > 3 && r && Object.defineProperty(target, key, r), r;
 }
 __name(_ts_decorate4, "_ts_decorate");
+function _ts_metadata3(k, v) {
+  if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+}
+__name(_ts_metadata3, "_ts_metadata");
+function _ts_param3(paramIndex, decorator) {
+  return function(target, key) {
+    decorator(target, key, paramIndex);
+  };
+}
+__name(_ts_param3, "_ts_param");
 var DashboardSessionRequiredException = class extends import_common4.HttpException {
   static {
     __name(this, "DashboardSessionRequiredException");
@@ -1148,17 +1169,51 @@ var DashboardSessionRequiredException = class extends import_common4.HttpExcepti
     }, import_common4.HttpStatus.UNAUTHORIZED), this.basePath = basePath;
   }
 };
-var DashboardSessionRequiredFilter = class {
+var DashboardSessionRequiredFilter = class _DashboardSessionRequiredFilter {
   static {
     __name(this, "DashboardSessionRequiredFilter");
   }
-  catch(exception, host) {
-    const response = host.switchToHttp().getResponse();
+  auth;
+  logger = new import_common4.Logger(_DashboardSessionRequiredFilter.name);
+  warned = false;
+  constructor(auth = null) {
+    this.auth = auth;
+  }
+  async catch(exception, host) {
+    const http = host.switchToHttp();
+    const response = http.getResponse();
+    const hook = this.auth?.unauthenticatedPage;
+    if (hook) {
+      try {
+        await hook({
+          request: http.getRequest(),
+          response,
+          basePath: exception.basePath
+        });
+        if (responseAlreadyWritten(response)) return;
+        this.warnOnce("dashboardAuth.unauthenticatedPage returned without writing a response; falling back to the built-in page. The hook must write AND end the response it is given.");
+      } catch (error) {
+        this.warnOnce(`dashboardAuth.unauthenticatedPage threw; falling back to the built-in page. ${String(error)}`);
+        if (responseAlreadyWritten(response)) return;
+      }
+    }
     writeHtmlRaw(response, renderSessionRequiredPage(exception.basePath), import_common4.HttpStatus.UNAUTHORIZED);
   }
+  /** Once per process, not once per request: a broken hook fires on every denied navigation. */
+  warnOnce(message) {
+    if (this.warned) return;
+    this.warned = true;
+    this.logger.warn(message);
+  }
 };
 DashboardSessionRequiredFilter = _ts_decorate4([
-  (0, import_common4.Catch)(DashboardSessionRequiredException)
+  (0, import_common4.Catch)(DashboardSessionRequiredException),
+  _ts_param3(0, (0, import_common4.Optional)()),
+  _ts_param3(0, (0, import_common4.Inject)(DASHBOARD_AUTH)),
+  _ts_metadata3("design:type", Function),
+  _ts_metadata3("design:paramtypes", [
+    Object
+  ])
 ], DashboardSessionRequiredFilter);
 
 // src/server/durable-ui.controller.ts
@@ -1169,16 +1224,16 @@ function _ts_decorate5(decorators, target, key, desc) {
   return c > 3 && r && Object.defineProperty(target, key, r), r;
 }
 __name(_ts_decorate5, "_ts_decorate");
-function _ts_metadata3(k, v) {
+function _ts_metadata4(k, v) {
   if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 }
-__name(_ts_metadata3, "_ts_metadata");
-function _ts_param3(paramIndex, decorator) {
+__name(_ts_metadata4, "_ts_metadata");
+function _ts_param4(paramIndex, decorator) {
   return function(target, key) {
     decorator(target, key, paramIndex);
   };
 }
-__name(_ts_param3, "_ts_param");
+__name(_ts_param4, "_ts_param");
 var DASHBOARD_BASE_PATH = Symbol("DASHBOARD_BASE_PATH");
 var DASHBOARD_API_PATH = Symbol("DASHBOARD_API_PATH");
 var BUILD_BASE = "/durable";
@@ -1235,27 +1290,27 @@ _ts_decorate5([
   (0, import_common5.Get)(),
   (0, import_common5.Header)("Content-Type", "text/html; charset=utf-8"),
   (0, import_common5.Header)("Cache-Control", "no-store, must-revalidate"),
-  _ts_metadata3("design:type", Function),
-  _ts_metadata3("design:paramtypes", []),
-  _ts_metadata3("design:returntype", String)
+  _ts_metadata4("design:type", Function),
+  _ts_metadata4("design:paramtypes", []),
+  _ts_metadata4("design:returntype", String)
 ], DurableUiController.prototype, "index", null);
 _ts_decorate5([
   (0, import_common5.Get)("assets/:file"),
   (0, import_common5.Header)("Cache-Control", "public, max-age=31536000, immutable"),
-  _ts_param3(0, (0, import_common5.Param)("file")),
-  _ts_metadata3("design:type", Function),
-  _ts_metadata3("design:paramtypes", [
+  _ts_param4(0, (0, import_common5.Param)("file")),
+  _ts_metadata4("design:type", Function),
+  _ts_metadata4("design:paramtypes", [
     String
   ]),
-  _ts_metadata3("design:returntype", typeof import_common5.StreamableFile === "undefined" ? Object : import_common5.StreamableFile)
+  _ts_metadata4("design:returntype", typeof import_common5.StreamableFile === "undefined" ? Object : import_common5.StreamableFile)
 ], DurableUiController.prototype, "asset", null);
 DurableUiController = _ts_decorate5([
   (0, import_common5.UseFilters)(DashboardLoginRedirectFilter, DashboardSessionRequiredFilter),
   (0, import_common5.Controller)(),
-  _ts_param3(0, (0, import_common5.Inject)(DASHBOARD_BASE_PATH)),
-  _ts_param3(1, (0, import_common5.Inject)(DASHBOARD_API_PATH)),
-  _ts_metadata3("design:type", Function),
-  _ts_metadata3("design:paramtypes", [
+  _ts_param4(0, (0, import_common5.Inject)(DASHBOARD_BASE_PATH)),
+  _ts_param4(1, (0, import_common5.Inject)(DASHBOARD_API_PATH)),
+  _ts_metadata4("design:type", Function),
+  _ts_metadata4("design:paramtypes", [
     String,
     String
   ])
@@ -1269,16 +1324,16 @@ function _ts_decorate6(decorators, target, key, desc) {
   return c > 3 && r && Object.defineProperty(target, key, r), r;
 }
 __name(_ts_decorate6, "_ts_decorate");
-function _ts_metadata4(k, v) {
+function _ts_metadata5(k, v) {
   if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 }
-__name(_ts_metadata4, "_ts_metadata");
-function _ts_param4(paramIndex, decorator) {
+__name(_ts_metadata5, "_ts_metadata");
+function _ts_param5(paramIndex, decorator) {
   return function(target, key) {
     decorator(target, key, paramIndex);
   };
 }
-__name(_ts_param4, "_ts_param");
+__name(_ts_param5, "_ts_param");
 function isString(value) {
   return typeof value === "string";
 }
@@ -1378,58 +1433,58 @@ _ts_decorate6([
   (0, import_common6.Get)("login"),
   (0, import_common6.Header)("Content-Type", "text/html; charset=utf-8"),
   (0, import_common6.Header)("Cache-Control", "no-store, must-revalidate"),
-  _ts_metadata4("design:type", Function),
-  _ts_metadata4("design:paramtypes", []),
-  _ts_metadata4("design:returntype", String)
+  _ts_metadata5("design:type", Function),
+  _ts_metadata5("design:paramtypes", []),
+  _ts_metadata5("design:returntype", String)
 ], DurableAuthController.prototype, "loginPage", null);
 _ts_decorate6([
   (0, import_common6.Post)("login"),
   (0, import_common6.HttpCode)(200),
-  _ts_param4(0, (0, import_common6.Body)()),
-  _ts_param4(1, (0, import_common6.Req)()),
-  _ts_param4(2, (0, import_common6.Res)({
+  _ts_param5(0, (0, import_common6.Body)()),
+  _ts_param5(1, (0, import_common6.Req)()),
+  _ts_param5(2, (0, import_common6.Res)({
     passthrough: true
   })),
-  _ts_metadata4("design:type", Function),
-  _ts_metadata4("design:paramtypes", [
+  _ts_metadata5("design:type", Function),
+  _ts_metadata5("design:paramtypes", [
     typeof LoginBody === "undefined" ? Object : LoginBody,
     Object,
     Object
   ]),
-  _ts_metadata4("design:returntype", Promise)
+  _ts_metadata5("design:returntype", Promise)
 ], DurableAuthController.prototype, "login", null);
 _ts_decorate6([
   (0, import_common6.Post)("session"),
   (0, import_common6.HttpCode)(204),
-  _ts_param4(0, (0, import_common6.Req)()),
-  _ts_param4(1, (0, import_common6.Res)({
+  _ts_param5(0, (0, import_common6.Req)()),
+  _ts_param5(1, (0, import_common6.Res)({
     passthrough: true
   })),
-  _ts_metadata4("design:type", Function),
-  _ts_metadata4("design:paramtypes", [
+  _ts_metadata5("design:type", Function),
+  _ts_metadata5("design:paramtypes", [
     Object,
     Object
   ]),
-  _ts_metadata4("design:returntype", Promise)
+  _ts_metadata5("design:returntype", Promise)
 ], DurableAuthController.prototype, "session", null);
 _ts_decorate6([
   (0, import_common6.Get)("logout"),
-  _ts_param4(0, (0, import_common6.Req)()),
-  _ts_param4(1, (0, import_common6.Res)()),
-  _ts_metadata4("design:type", Function),
-  _ts_metadata4("design:paramtypes", [
+  _ts_param5(0, (0, import_common6.Req)()),
+  _ts_param5(1, (0, import_common6.Res)()),
+  _ts_metadata5("design:type", Function),
+  _ts_metadata5("design:paramtypes", [
     Object,
     Object
   ]),
-  _ts_metadata4("design:returntype", void 0)
+  _ts_metadata5("design:returntype", void 0)
 ], DurableAuthController.prototype, "logout", null);
 DurableAuthController = _ts_decorate6([
   (0, import_common6.Controller)(),
-  _ts_param4(0, (0, import_common6.Optional)()),
-  _ts_param4(0, (0, import_common6.Inject)(DASHBOARD_AUTH)),
-  _ts_param4(1, (0, import_common6.Inject)(DASHBOARD_BASE_PATH)),
-  _ts_metadata4("design:type", Function),
-  _ts_metadata4("design:paramtypes", [
+  _ts_param5(0, (0, import_common6.Optional)()),
+  _ts_param5(0, (0, import_common6.Inject)(DASHBOARD_AUTH)),
+  _ts_param5(1, (0, import_common6.Inject)(DASHBOARD_BASE_PATH)),
+  _ts_metadata5("design:type", Function),
+  _ts_metadata5("design:paramtypes", [
     Object,
     String
   ])
@@ -1449,16 +1504,16 @@ function _ts_decorate7(decorators, target, key, desc) {
   return c > 3 && r && Object.defineProperty(target, key, r), r;
 }
 __name(_ts_decorate7, "_ts_decorate");
-function _ts_metadata5(k, v) {
+function _ts_metadata6(k, v) {
   if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 }
-__name(_ts_metadata5, "_ts_metadata");
-function _ts_param5(paramIndex, decorator) {
+__name(_ts_metadata6, "_ts_metadata");
+function _ts_param6(paramIndex, decorator) {
   return function(target, key) {
     decorator(target, key, paramIndex);
   };
 }
-__name(_ts_param5, "_ts_param");
+__name(_ts_param6, "_ts_param");
 var DurableUiSessionGuard = class {
   static {
     __name(this, "DurableUiSessionGuard");
@@ -1501,10 +1556,10 @@ var DurableUiSessionGuard = class {
 };
 DurableUiSessionGuard = _ts_decorate7([
   (0, import_common7.Injectable)(),
-  _ts_param5(0, (0, import_common7.Inject)(DASHBOARD_AUTH)),
-  _ts_param5(1, (0, import_common7.Inject)(DASHBOARD_BASE_PATH)),
-  _ts_metadata5("design:type", Function),
-  _ts_metadata5("design:paramtypes", [
+  _ts_param6(0, (0, import_common7.Inject)(DASHBOARD_AUTH)),
+  _ts_param6(1, (0, import_common7.Inject)(DASHBOARD_BASE_PATH)),
+  _ts_metadata6("design:type", Function),
+  _ts_metadata6("design:paramtypes", [
     Object,
     String
   ])
@@ -1545,9 +1600,9 @@ var DurableApiSessionGuard = class {
 };
 DurableApiSessionGuard = _ts_decorate7([
   (0, import_common7.Injectable)(),
-  _ts_param5(0, (0, import_common7.Inject)(DASHBOARD_AUTH)),
-  _ts_metadata5("design:type", Function),
-  _ts_metadata5("design:paramtypes", [
+  _ts_param6(0, (0, import_common7.Inject)(DASHBOARD_AUTH)),
+  _ts_metadata6("design:type", Function),
+  _ts_metadata6("design:paramtypes", [
     Object
   ])
 ], DurableApiSessionGuard);