@bgord/bun 1.4.6 → 1.4.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bgord/bun",
-  "version": "1.4.6",
+  "version": "1.4.8",
   "license": "MIT",
   "type": "module",
   "author": "Bartosz Gordon",
@@ -28,7 +28,7 @@
     "@types/nodemailer": "7.0.4",
     "@types/yazl": "3.3.0",
     "cspell": "9.4.0",
-    "knip": "5.73.0",
+    "knip": "5.73.3",
     "lefthook": "2.0.9",
     "only-allow": "1.2.2",
     "sharp": "0.34.5",

package/readme.md

@@ -237,14 +237,12 @@ src/
 ├── secret-manager.port.ts
 ├── secret.vo.ts
 ├── setup.service.ts
-├── shield-api-key-noop.adapter.ts
 ├── shield-api-key.adapter.ts
 ├── shield-auth.middleware.ts
 ├── shield-captcha-hcaptcha-local.adapter.ts
 ├── shield-captcha-hcaptcha.adapter.ts
-├── shield-captcha-noop.adapter.ts
 ├── shield-captcha-recaptcha.adapter.ts
-├── shield-rate-limit-noop.adapter.ts
+├── shield-noop.adapter.ts
 ├── shield-rate-limit.adapter.ts
 ├── shield.port.ts
 ├── simulated-error.middleware.ts

package/src/healthcheck.service.ts

@@ -5,6 +5,7 @@ import type { ClockPort } from "./clock.port";
 import type { JsonFileReaderPort } from "./json-file-reader.port";
 import type { LoggerPort } from "./logger.port";
 import { MemoryConsumption } from "./memory-consumption.service";
+import { PrerequisiteSelf } from "./prerequisites/self";
 import * as prereqs from "./prerequisites.service";
 import { Uptime, type UptimeResultType } from "./uptime.service";
 
@@ -30,7 +31,9 @@ export class Healthcheck {
 
       const details: HealthcheckResultType["details"][number][] = [];
 
-      for (const prerequisite of prerequisites) {
+      for (const prerequisite of [new PrerequisiteSelf({ label: "self" }), ...prerequisites].filter(
+        (prerequisite) => prerequisite.kind !== "port",
+      )) {
         details.push({ label: prerequisite.label, outcome: await prerequisite.verify(deps.Clock) });
       }
 

package/src/index.ts

@@ -160,14 +160,12 @@ export * from "./secret-manager-noop.adapter";
 export * from "./setup.service";
 export * from "./shield.port";
 export * from "./shield-api-key.adapter";
-export * from "./shield-api-key-noop.adapter";
 export * from "./shield-auth.middleware";
 export * from "./shield-captcha-hcaptcha.adapter";
 export * from "./shield-captcha-hcaptcha-local.adapter";
-export * from "./shield-captcha-noop.adapter";
 export * from "./shield-captcha-recaptcha.adapter";
+export * from "./shield-noop.adapter";
 export * from "./shield-rate-limit.adapter";
-export * from "./shield-rate-limit-noop.adapter";
 export * from "./simulated-error.middleware";
 export * from "./slower.middleware";
 export * from "./static-files.service";

package/src/logger-noop.adapter.ts

@@ -10,4 +10,8 @@ export class LoggerNoopAdapter implements LoggerPort {
   silly: LoggerPort["silly"] = (_log) => {};
 
   setSilent: LoggerPort["setSilent"] = (_silent) => {};
+
+  getFilePath() {
+    return null;
+  }
 }

package/src/logger-winston-local.adapter.ts

@@ -16,6 +16,7 @@ export class LoggerWinstonLocalAdapter {
       level,
       redactor: this.config.redactor,
       formats: [winston.format.prettyPrint()],
+      filePath: null,
     });
   }
 }

package/src/logger-winston-production.adapter.ts

@@ -13,15 +13,15 @@ type LoggerWinstonProductionAdapterConfigType = {
 };
 
 export class LoggerWinstonProductionAdapter {
-  readonly prodLogFile: string;
-
-  constructor(private readonly config: LoggerWinstonProductionAdapterConfigType) {
-    this.prodLogFile = this.createProdLogFile();
-  }
+  constructor(private readonly config: LoggerWinstonProductionAdapterConfigType) {}
 
   create(level: LogLevelEnum): LoggerPort {
+    const filePath = tools.FilePathAbsolute.fromString(
+      `/var/log/${this.config.app}-${NodeEnvironmentEnum.production}.log`,
+    );
+
     const file = new winston.transports.File({
-      filename: this.prodLogFile,
+      filename: filePath.get(),
       maxsize: tools.Size.fromMB(100).toBytes(),
       maxFiles: 3,
       tailable: true,
@@ -38,10 +38,7 @@ export class LoggerWinstonProductionAdapter {
           : undefined,
       ].filter((adapter) => adapter !== undefined),
       redactor: this.config.redactor,
+      filePath,
     });
   }
-
-  private createProdLogFile() {
-    return `/var/log/${this.config.app}-${NodeEnvironmentEnum.production}.log`;
-  }
 }

package/src/logger-winston.adapter.ts

@@ -1,3 +1,4 @@
+import type * as tools from "@bgord/tools";
 import * as winston from "winston";
 import { type LogAppType, type LoggerPort, LogLevelEnum } from "./logger.port";
 import type { NodeEnvironmentEnum } from "./node-env.vo";
@@ -10,11 +11,14 @@ type WinstonLoggerOptions = {
   redactor: RedactorPort;
   formats?: winston.Logform.Format[];
   transports?: winston.transport[];
+  filePath: tools.FilePathAbsolute | null;
 };
 
 export class LoggerWinstonAdapter implements LoggerPort {
   private readonly logger: winston.Logger;
 
+  private readonly filePath: tools.FilePathAbsolute | null;
+
   constructor(options: WinstonLoggerOptions) {
     const format = winston.format.combine(
       winston.format((info) => options.redactor.redact(info))(),
@@ -33,6 +37,8 @@ export class LoggerWinstonAdapter implements LoggerPort {
       format,
       transports: [new winston.transports.Console(), ...(options.transports ?? [])],
     });
+
+    this.filePath = options.filePath;
   }
 
   warn: LoggerPort["warn"] = (log) => this.logger.log({ level: LogLevelEnum.warn, ...log });
@@ -46,4 +52,8 @@ export class LoggerWinstonAdapter implements LoggerPort {
   setSilent: LoggerPort["setSilent"] = (silent) => {
     this.logger.silent = silent;
   };
+
+  getFilePath() {
+    return this.filePath;
+  }
 }

package/src/logger.port.ts

@@ -1,3 +1,4 @@
+import type * as tools from "@bgord/tools";
 import { z } from "zod/v4";
 import type { CorrelationIdType } from "./correlation-id.vo";
 import type { NodeEnvironmentEnum } from "./node-env.vo";
@@ -58,4 +59,6 @@ export interface LoggerPort {
   silly(entry: Omit<LogCoreType, AdapterInjectedFields>): void;
 
   setSilent(silent: boolean): void;
+
+  getFilePath(): tools.FilePathAbsolute | null;
 }

package/src/prerequisites/log-file.ts

@@ -1,6 +1,6 @@
 import * as tools from "@bgord/tools";
 import type { ClockPort } from "../clock.port";
-import type { LoggerWinstonProductionAdapter } from "../logger-winston-production.adapter";
+import type { LoggerPort } from "../logger.port";
 import * as prereqs from "../prerequisites.service";
 
 export class PrerequisiteLogFile implements prereqs.Prerequisite {
@@ -8,9 +8,9 @@ export class PrerequisiteLogFile implements prereqs.Prerequisite {
   readonly label: prereqs.PrerequisiteLabelType;
   readonly enabled?: boolean = true;
 
-  private readonly Logger: LoggerWinstonProductionAdapter;
+  private readonly Logger: LoggerPort;
 
-  constructor(config: prereqs.PrerequisiteConfigType & { Logger: LoggerWinstonProductionAdapter }) {
+  constructor(config: prereqs.PrerequisiteConfigType & { Logger: LoggerPort }) {
     this.label = config.label;
     this.enabled = config.enabled === undefined ? true : config.enabled;
 
@@ -23,11 +23,13 @@ export class PrerequisiteLogFile implements prereqs.Prerequisite {
     if (!this.enabled) return prereqs.Verification.undetermined(stopwatch.stop());
 
     try {
-      const path = this.Logger.prodLogFile;
-      const result = await Bun.file(path).exists();
+      const path = this.Logger.getFilePath();
+      if (!path) return prereqs.Verification.undetermined(stopwatch.stop());
+
+      const result = await Bun.file(path.get()).exists();
 
       if (result) return prereqs.Verification.success(stopwatch.stop());
-      return prereqs.Verification.failure(stopwatch.stop(), { message: `Missing file: ${path}` });
+      return prereqs.Verification.failure(stopwatch.stop(), { message: `Missing file: ${path.get()}` });
     } catch (error) {
       return prereqs.Verification.failure(stopwatch.stop(), error as Error);
     }

package/src/{shield-captcha-noop.adapter.ts → shield-noop.adapter.ts}

@@ -1,6 +1,6 @@
 import { createMiddleware } from "hono/factory";
 import type { ShieldPort } from "./shield.port";
 
-export class ShieldCaptchaNoopAdapter implements ShieldPort {
+export class ShieldNoopAdapter implements ShieldPort {
   verify = createMiddleware(async (_c, next) => next());
 }

package/src/shield-rate-limit.adapter.ts

@@ -7,7 +7,7 @@ import type { RateLimitStorePort } from "./rate-limit-store.port";
 import type { ShieldPort } from "./shield.port";
 
 type SubjectResolver = (c: Context) => string;
-type RateLimitShieldOptionsType = { enabled: boolean; store: RateLimitStorePort; subject: SubjectResolver };
+type ShieldRateLimitOptionsType = { enabled: boolean; store: RateLimitStorePort; subject: SubjectResolver };
 
 type Dependencies = { Clock: ClockPort };
 
@@ -18,7 +18,7 @@ export const TooManyRequestsError = new HTTPException(429, { message: "app.too_m
 
 export class ShieldRateLimitAdapter implements ShieldPort {
   constructor(
-    private readonly options: RateLimitShieldOptionsType,
+    private readonly options: ShieldRateLimitOptionsType,
     private readonly deps: Dependencies,
   ) {}
 

package/dist/shield-api-key-noop.adapter.d.ts

@@ -1,5 +0,0 @@
-import type { ShieldPort } from "./shield.port";
-export declare class ShieldApiKeyAdapterNoop implements ShieldPort {
-    verify: import("hono").MiddlewareHandler<any, string, {}, Response>;
-}
-//# sourceMappingURL=shield-api-key-noop.adapter.d.ts.map

package/dist/shield-api-key-noop.adapter.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"shield-api-key-noop.adapter.d.ts","sourceRoot":"","sources":["../src/shield-api-key-noop.adapter.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAEhD,qBAAa,uBAAwB,YAAW,UAAU;IACxD,MAAM,8DAEH;CACJ"}

package/dist/shield-api-key-noop.adapter.js

@@ -1,7 +0,0 @@
-import { createMiddleware } from "hono/factory";
-export class ShieldApiKeyAdapterNoop {
-    verify = createMiddleware(async (_c, next) => {
-        return next();
-    });
-}
-//# sourceMappingURL=shield-api-key-noop.adapter.js.map

package/dist/shield-api-key-noop.adapter.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"shield-api-key-noop.adapter.js","sourceRoot":"","sources":["../src/shield-api-key-noop.adapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAGhD,MAAM,OAAO,uBAAuB;IAClC,MAAM,GAAG,gBAAgB,CAAC,KAAK,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE;QAC3C,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC,CAAC,CAAC;CACJ"}

package/dist/shield-captcha-noop.adapter.d.ts

@@ -1,5 +0,0 @@
-import type { ShieldPort } from "./shield.port";
-export declare class ShieldCaptchaNoopAdapter implements ShieldPort {
-    verify: import("hono").MiddlewareHandler<any, string, {}, Response>;
-}
-//# sourceMappingURL=shield-captcha-noop.adapter.d.ts.map

package/dist/shield-captcha-noop.adapter.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"shield-captcha-noop.adapter.d.ts","sourceRoot":"","sources":["../src/shield-captcha-noop.adapter.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAEhD,qBAAa,wBAAyB,YAAW,UAAU;IACzD,MAAM,8DAAgD;CACvD"}

package/dist/shield-captcha-noop.adapter.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"shield-captcha-noop.adapter.js","sourceRoot":"","sources":["../src/shield-captcha-noop.adapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAGhD,MAAM,OAAO,wBAAwB;IACnC,MAAM,GAAG,gBAAgB,CAAC,KAAK,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;CACvD"}

package/dist/shield-rate-limit-noop.adapter.d.ts

@@ -1,5 +0,0 @@
-import type { ShieldPort } from "./shield.port";
-export declare class ShieldRateLimitNoopAdapter implements ShieldPort {
-    verify: import("hono").MiddlewareHandler<any, string, {}, Response>;
-}
-//# sourceMappingURL=shield-rate-limit-noop.adapter.d.ts.map

package/dist/shield-rate-limit-noop.adapter.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"shield-rate-limit-noop.adapter.d.ts","sourceRoot":"","sources":["../src/shield-rate-limit-noop.adapter.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAEhD,qBAAa,0BAA2B,YAAW,UAAU;IAC3D,MAAM,8DAEH;CACJ"}

package/dist/shield-rate-limit-noop.adapter.js

@@ -1,7 +0,0 @@
-import { createMiddleware } from "hono/factory";
-export class ShieldRateLimitNoopAdapter {
-    verify = createMiddleware(async (_c, next) => {
-        return next();
-    });
-}
-//# sourceMappingURL=shield-rate-limit-noop.adapter.js.map

package/dist/shield-rate-limit-noop.adapter.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"shield-rate-limit-noop.adapter.js","sourceRoot":"","sources":["../src/shield-rate-limit-noop.adapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAGhD,MAAM,OAAO,0BAA0B;IACrC,MAAM,GAAG,gBAAgB,CAAC,KAAK,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE;QAC3C,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC,CAAC,CAAC;CACJ"}

package/src/shield-api-key-noop.adapter.ts

@@ -1,8 +0,0 @@
-import { createMiddleware } from "hono/factory";
-import type { ShieldPort } from "./shield.port";
-
-export class ShieldApiKeyAdapterNoop implements ShieldPort {
-  verify = createMiddleware(async (_c, next) => {
-    return next();
-  });
-}

package/src/shield-rate-limit-noop.adapter.ts

@@ -1,8 +0,0 @@
-import { createMiddleware } from "hono/factory";
-import type { ShieldPort } from "./shield.port";
-
-export class ShieldRateLimitNoopAdapter implements ShieldPort {
-  verify = createMiddleware(async (_c, next) => {
-    return next();
-  });
-}