hono-utils 0.3.8 → 0.3.9

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import * as hono from 'hono';
-import { Env, Context, ErrorHandler, NotFoundHandler, Hono } from 'hono';
+import { MiddlewareHandler, Context, Env, ErrorHandler, NotFoundHandler, Hono } from 'hono';
 import { Logger, Details } from 'hierarchical-area-logger';
 import * as hono_utils_http_status from 'hono/utils/http-status';
 import { ContentfulStatusCode, SuccessStatusCode, ClientErrorStatusCode, StatusCode } from 'hono/utils/http-status';
@@ -36,29 +36,6 @@ declare const logger: (details: Details, parentEventIdHeader?: string) => hono.M
     Variables: HonoLoggerVariables;
 }, string, {}, Response>;
 
-type WrappableMiddleware<V extends Env> = (c: Context<V>, loggerFunctions: ReturnType<Logger['getArea']> & Pick<Logger, 'eventId' | 'parentEventId' | 'dump'>) => Promise<void>;
-/**
- * Wraps middleware with logger. Logger should be initialized before middleware.
- *
- * @param name - Name of the middleware
- * @param middleware - Middleware function
- *
- * @example
- * ```ts
- * app.use('*', logger(
- * {
- *   service: 'logger',
- * },
- * parentEventIdHeader: 'parent-event-id',
- * ));
- *
- * app.use('*', withLogger('middlewareName', (c, { info }) => {
- *   info('Middleware initialized');
- * }));
- * ```
- */
-declare const withLogger: <V extends Env>(name: string, middleware: WrappableMiddleware<V>) => hono.MiddlewareHandler<any, string, {}, Response>;
-
 /**
  * @description
  * Validator middleware for JSON data.
@@ -85,6 +62,13 @@ declare const jsonValidator: <T extends z.ZodRawShape>(schema: z.ZodObject<T>) =
     };
 }, z.core.$InferObjectOutput<T, {}> extends infer T_3 ? T_3 extends z.core.$InferObjectOutput<T, {}> ? T_3 extends Promise<infer PR_1> ? PR_1 extends hono.TypedResponse<infer T_4, infer S extends hono_utils_http_status.StatusCode, infer F extends string> ? hono.TypedResponse<T_4, S, F> : PR_1 extends Response ? PR_1 : PR_1 extends undefined ? never : never : T_3 extends hono.TypedResponse<infer T_5, infer S_1 extends hono_utils_http_status.StatusCode, infer F_1 extends string> ? hono.TypedResponse<T_5, S_1, F_1> : T_3 extends Response ? T_3 : T_3 extends undefined ? never : never : never : never>;
 
+type MiddlewareWithLoggingCapabilityProps<RestProps extends Record<string, unknown>> = {
+    useLogger?: boolean;
+} & RestProps;
+interface MiddlewareWithLoggingCapability<RestProps extends Record<string, unknown>> {
+    (props?: MiddlewareWithLoggingCapabilityProps<RestProps>): MiddlewareHandler;
+}
+
 type HonoIsBotVariables = {
     isBot: boolean;
 };
@@ -107,12 +91,10 @@ type HonoIsBotVariables = {
  * app.use('/api/*', isBot({ threshold: 50, allowVerifiedBot: true }));
  * ```
  */
-declare const isBot: ({ threshold, allowVerifiedBot, }: {
+declare const isBot: MiddlewareWithLoggingCapability<{
     threshold: number;
     allowVerifiedBot?: boolean;
-}) => hono.MiddlewareHandler<{
-    Variables: HonoIsBotVariables;
-}, string, {}, Response>;
+}>;
 
 type HonoLanguageVariables = {
     language: string;
@@ -384,7 +366,9 @@ type HonoClientInfoVariables = {
  * ```ts
  * const app = new Hono<{ Variables: HonoClientInfoVariables }>();
  *
- * app.use('*', clientInfo());
+ * app.use('*', clientInfo({
+ *  useLogger: true // for debugging purposes
+ * }));
  *
  * app.get('/me', (c) => {
  *  const client = c.get('client');
@@ -395,41 +379,12 @@ type HonoClientInfoVariables = {
  * });
  * ```
  */
-declare const clientInfo: (config?: {
+declare const clientInfo: MiddlewareWithLoggingCapability<{
     hashSecretBinding?: string;
     securityHashString?: (content: CFData & UserAgentData & {
         ip: string;
     }) => string;
-}) => hono.MiddlewareHandler<{
-    Bindings: Record<string, string>;
-    Variables: HonoClientInfoVariables;
-}, string, {}, Response>;
-
-/**
- * A Hono middleware factory that hydrates a context variable based on environment bindings or other variables.
- * @template {Record<string, unknown>} Bindings - The environment bindings (e.g., Cloudflare Env).
- * @template {Record<string, unknown>} Variables - The Hono context variables.
- * @template HidratedResult - The resulting type of the hydrated variable.
- * @param {Object} options - The configuration options for hydration.
- * @param {keyof Variables} options.variableName - The name of the variable in the context to be set.
- * @param {(c: Bindings & { get: <T>(key: keyof Variables) => T }) => HidratedResult} options.hydrate -
- * A function that takes the environment and a getter, returning the hydrated value.
- * @returns {import("hono").MiddlewareHandler} A Hono middleware that performs the hydration and calls next().
- * @example
- * const middleware = hydrateVariable({
- *   variableName: 'userProfile',
- *   hydrate: (c) => new UserProfile(c.USER_ID)
- * });
- */
-declare const hydrateVariable: <Environment extends Env, HidratedResult>({ variableName, hydrate, }: {
-    variableName: keyof Environment["Variables"];
-    hydrate: (c: Environment["Bindings"] & {
-        get: <T>(key: keyof Environment["Variables"]) => T;
-    }) => HidratedResult;
-}) => hono.MiddlewareHandler<{
-    Bindings: Environment["Bindings"];
-    Variables: Record<string, HidratedResult>;
-}, string, {}, Response>;
+}>;
 
 /**
  * Derives a secure hex-encoded hash from an input string using PBKDF2-HMAC-SHA256.
@@ -501,4 +456,4 @@ interface CreateTypedClientOptions {
 }
 declare const createTypedClient: <TApp extends Hono<any, any, any>>() => (options: CreateTypedClientOptions) => <TSuccessData>(fn: (c: ReturnType<typeof hc<TApp>>) => Promise<ClientResponse<TSuccessData>>, callbacks?: TypedClientCallbacks) => Promise<TSuccessData>;
 
-export { type ContextFn, type CreateTypedClientOptions, type HonoClientInfoVariables, type HonoI18nVariables, type HonoIsBotVariables, type HonoLanguageVariables, type HonoLoggerVariables, type HonoResponseVariables, type MessageHandlers, pbkdf2 as PBKDF2, QueueHandler, sha as SHA, type TypedClientCallbacks, type WrappableMiddleware, clientInfo, createTypedClient, hydrateVariable, i18n, isBot, jsonValidator, logger, onError, onNotFound, queue, response, withLogger };
+export { type ContextFn, type CreateTypedClientOptions, type HonoClientInfoVariables, type HonoI18nVariables, type HonoIsBotVariables, type HonoLanguageVariables, type HonoLoggerVariables, type HonoResponseVariables, type MessageHandlers, type MiddlewareWithLoggingCapability, pbkdf2 as PBKDF2, QueueHandler, sha as SHA, type TypedClientCallbacks, clientInfo, createTypedClient, i18n, isBot, jsonValidator, logger, onError, onNotFound, queue, response };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as hono from 'hono';
-import { Env, Context, ErrorHandler, NotFoundHandler, Hono } from 'hono';
+import { MiddlewareHandler, Context, Env, ErrorHandler, NotFoundHandler, Hono } from 'hono';
 import { Logger, Details } from 'hierarchical-area-logger';
 import * as hono_utils_http_status from 'hono/utils/http-status';
 import { ContentfulStatusCode, SuccessStatusCode, ClientErrorStatusCode, StatusCode } from 'hono/utils/http-status';
@@ -36,29 +36,6 @@ declare const logger: (details: Details, parentEventIdHeader?: string) => hono.M
     Variables: HonoLoggerVariables;
 }, string, {}, Response>;
 
-type WrappableMiddleware<V extends Env> = (c: Context<V>, loggerFunctions: ReturnType<Logger['getArea']> & Pick<Logger, 'eventId' | 'parentEventId' | 'dump'>) => Promise<void>;
-/**
- * Wraps middleware with logger. Logger should be initialized before middleware.
- *
- * @param name - Name of the middleware
- * @param middleware - Middleware function
- *
- * @example
- * ```ts
- * app.use('*', logger(
- * {
- *   service: 'logger',
- * },
- * parentEventIdHeader: 'parent-event-id',
- * ));
- *
- * app.use('*', withLogger('middlewareName', (c, { info }) => {
- *   info('Middleware initialized');
- * }));
- * ```
- */
-declare const withLogger: <V extends Env>(name: string, middleware: WrappableMiddleware<V>) => hono.MiddlewareHandler<any, string, {}, Response>;
-
 /**
  * @description
  * Validator middleware for JSON data.
@@ -85,6 +62,13 @@ declare const jsonValidator: <T extends z.ZodRawShape>(schema: z.ZodObject<T>) =
     };
 }, z.core.$InferObjectOutput<T, {}> extends infer T_3 ? T_3 extends z.core.$InferObjectOutput<T, {}> ? T_3 extends Promise<infer PR_1> ? PR_1 extends hono.TypedResponse<infer T_4, infer S extends hono_utils_http_status.StatusCode, infer F extends string> ? hono.TypedResponse<T_4, S, F> : PR_1 extends Response ? PR_1 : PR_1 extends undefined ? never : never : T_3 extends hono.TypedResponse<infer T_5, infer S_1 extends hono_utils_http_status.StatusCode, infer F_1 extends string> ? hono.TypedResponse<T_5, S_1, F_1> : T_3 extends Response ? T_3 : T_3 extends undefined ? never : never : never : never>;
 
+type MiddlewareWithLoggingCapabilityProps<RestProps extends Record<string, unknown>> = {
+    useLogger?: boolean;
+} & RestProps;
+interface MiddlewareWithLoggingCapability<RestProps extends Record<string, unknown>> {
+    (props?: MiddlewareWithLoggingCapabilityProps<RestProps>): MiddlewareHandler;
+}
+
 type HonoIsBotVariables = {
     isBot: boolean;
 };
@@ -107,12 +91,10 @@ type HonoIsBotVariables = {
  * app.use('/api/*', isBot({ threshold: 50, allowVerifiedBot: true }));
  * ```
  */
-declare const isBot: ({ threshold, allowVerifiedBot, }: {
+declare const isBot: MiddlewareWithLoggingCapability<{
     threshold: number;
     allowVerifiedBot?: boolean;
-}) => hono.MiddlewareHandler<{
-    Variables: HonoIsBotVariables;
-}, string, {}, Response>;
+}>;
 
 type HonoLanguageVariables = {
     language: string;
@@ -384,7 +366,9 @@ type HonoClientInfoVariables = {
  * ```ts
  * const app = new Hono<{ Variables: HonoClientInfoVariables }>();
  *
- * app.use('*', clientInfo());
+ * app.use('*', clientInfo({
+ *  useLogger: true // for debugging purposes
+ * }));
  *
  * app.get('/me', (c) => {
  *  const client = c.get('client');
@@ -395,41 +379,12 @@ type HonoClientInfoVariables = {
  * });
  * ```
  */
-declare const clientInfo: (config?: {
+declare const clientInfo: MiddlewareWithLoggingCapability<{
     hashSecretBinding?: string;
     securityHashString?: (content: CFData & UserAgentData & {
         ip: string;
     }) => string;
-}) => hono.MiddlewareHandler<{
-    Bindings: Record<string, string>;
-    Variables: HonoClientInfoVariables;
-}, string, {}, Response>;
-
-/**
- * A Hono middleware factory that hydrates a context variable based on environment bindings or other variables.
- * @template {Record<string, unknown>} Bindings - The environment bindings (e.g., Cloudflare Env).
- * @template {Record<string, unknown>} Variables - The Hono context variables.
- * @template HidratedResult - The resulting type of the hydrated variable.
- * @param {Object} options - The configuration options for hydration.
- * @param {keyof Variables} options.variableName - The name of the variable in the context to be set.
- * @param {(c: Bindings & { get: <T>(key: keyof Variables) => T }) => HidratedResult} options.hydrate -
- * A function that takes the environment and a getter, returning the hydrated value.
- * @returns {import("hono").MiddlewareHandler} A Hono middleware that performs the hydration and calls next().
- * @example
- * const middleware = hydrateVariable({
- *   variableName: 'userProfile',
- *   hydrate: (c) => new UserProfile(c.USER_ID)
- * });
- */
-declare const hydrateVariable: <Environment extends Env, HidratedResult>({ variableName, hydrate, }: {
-    variableName: keyof Environment["Variables"];
-    hydrate: (c: Environment["Bindings"] & {
-        get: <T>(key: keyof Environment["Variables"]) => T;
-    }) => HidratedResult;
-}) => hono.MiddlewareHandler<{
-    Bindings: Environment["Bindings"];
-    Variables: Record<string, HidratedResult>;
-}, string, {}, Response>;
+}>;
 
 /**
  * Derives a secure hex-encoded hash from an input string using PBKDF2-HMAC-SHA256.
@@ -501,4 +456,4 @@ interface CreateTypedClientOptions {
 }
 declare const createTypedClient: <TApp extends Hono<any, any, any>>() => (options: CreateTypedClientOptions) => <TSuccessData>(fn: (c: ReturnType<typeof hc<TApp>>) => Promise<ClientResponse<TSuccessData>>, callbacks?: TypedClientCallbacks) => Promise<TSuccessData>;
 
-export { type ContextFn, type CreateTypedClientOptions, type HonoClientInfoVariables, type HonoI18nVariables, type HonoIsBotVariables, type HonoLanguageVariables, type HonoLoggerVariables, type HonoResponseVariables, type MessageHandlers, pbkdf2 as PBKDF2, QueueHandler, sha as SHA, type TypedClientCallbacks, type WrappableMiddleware, clientInfo, createTypedClient, hydrateVariable, i18n, isBot, jsonValidator, logger, onError, onNotFound, queue, response, withLogger };
+export { type ContextFn, type CreateTypedClientOptions, type HonoClientInfoVariables, type HonoI18nVariables, type HonoIsBotVariables, type HonoLanguageVariables, type HonoLoggerVariables, type HonoResponseVariables, type MessageHandlers, type MiddlewareWithLoggingCapability, pbkdf2 as PBKDF2, QueueHandler, sha as SHA, type TypedClientCallbacks, clientInfo, createTypedClient, i18n, isBot, jsonValidator, logger, onError, onNotFound, queue, response };

package/dist/index.js

@@ -19,23 +19,6 @@ var logger = (details, parentEventIdHeader) => createMiddleware(async (c, next)
   await next();
 });
 
-// src/middleware/withLogger.ts
-import { createMiddleware as createMiddleware2 } from "hono/factory";
-var withLogger = (name, middleware) => createMiddleware2(async (c, next) => {
-  const logger2 = c.get("logger");
-  if (!logger2) {
-    throw new Error("Logger should be initialized");
-  }
-  const loggerFunctions = logger2.getArea(`middleware:${name}`);
-  await middleware(c, {
-    ...loggerFunctions,
-    eventId: logger2.eventId,
-    parentEventId: logger2.parentEventId,
-    dump: logger2.dump
-  });
-  await next();
-});
-
 // src/middleware/validator.ts
 import { HTTPException } from "hono/http-exception";
 import { validator } from "hono/validator";
@@ -13821,11 +13804,17 @@ var jsonValidator = (schema) => validator("json", (value) => {
 
 // src/middleware/isBot.ts
 import { HTTPException as HTTPException2 } from "hono/http-exception";
-import { createMiddleware as createMiddleware3 } from "hono/factory";
-var isBot = ({
-  threshold = 49,
-  allowVerifiedBot
-}) => createMiddleware3(async (c, next) => {
+import { Logger as Logger2 } from "hierarchical-area-logger";
+import { createMiddleware as createMiddleware2 } from "hono/factory";
+var isBot = ({ threshold, allowVerifiedBot, useLogger } = {
+  threshold: 49
+}) => createMiddleware2(async (c, next) => {
+  const logger2 = useLogger ? (c.get("logger") ?? new Logger2({
+    details: {
+      service: "dummy"
+    }
+  })).getArea("middeware:isBot") : void 0;
+  logger2?.debug("Retrieving bot management data from cloudflare data");
   const botManagement = c.req.raw.cf?.botManagement;
   if (!botManagement) {
     throw new Error("botManagement is not available");
@@ -13835,6 +13824,12 @@ var isBot = ({
   const isBotByScore = score < threshold;
   const isVerifiedAllowed = !!(allowVerifiedBot && verifiedBot);
   const isBot2 = isBotByScore;
+  logger2?.debug("Setting isBot variable in context", {
+    isBotByScore,
+    isVerifiedAllowed,
+    isBot: isBot2
+  });
+  logger2?.info("isBot variable set");
   c.set("isBot", isBot2);
   if (isBotByScore && !isVerifiedAllowed) {
     throw new HTTPException2(401, { message: "Bot detected" });
@@ -13843,7 +13838,7 @@ var isBot = ({
 });
 
 // src/middleware/i18n.ts
-import { createMiddleware as createMiddleware4 } from "hono/factory";
+import { createMiddleware as createMiddleware3 } from "hono/factory";
 var setI18n = (translations, language, defaultLanguage) => (input, params, overrideLanguage) => {
   const result = input.split(".").reduce(
     (acc, key) => {
@@ -13873,7 +13868,7 @@ var setI18n = (translations, language, defaultLanguage) => (input, params, overr
   return typeof result === "string" ? result : input;
 };
 var i18n = (translations, defaultLanguage) => ({
-  middleware: createMiddleware4(async ({ set: set2, var: { language } }, next) => {
+  middleware: createMiddleware3(async ({ set: set2, var: { language } }, next) => {
     if (!language) {
       throw new Error(
         "Language variable should be initialized before translations middleware"
@@ -13886,26 +13881,26 @@ var i18n = (translations, defaultLanguage) => ({
 });
 
 // src/middleware/queue.ts
-import { createMiddleware as createMiddleware5 } from "hono/factory";
+import { createMiddleware as createMiddleware4 } from "hono/factory";
 var queue = ({
   name,
   queueHandler,
   finalizeLogHandler
-}) => createMiddleware5(async ({ env, set: set2, get }, next) => {
+}) => createMiddleware4(async ({ env, set: set2, get }, next) => {
   const queueEnv = env[name];
   const language = get("language");
-  const logger2 = get("logger");
   if (!queueEnv) {
     throw new Error(
       `Queue environment variable ${name} is not defined`
     );
   }
+  const logger2 = get("logger");
   let parentEventId;
   if (finalizeLogHandler) {
     if (!logger2) {
       throw new Error("Logger should be initialized before queue middleware");
     }
-    parentEventId = logger2.eventId;
+    parentEventId = logger2?.eventId;
   }
   const producer = queueHandler.getProducer(queueEnv, {
     parentEventId,
@@ -13922,7 +13917,7 @@ var queue = ({
 });
 
 // src/middleware/response.ts
-import { createMiddleware as createMiddleware6 } from "hono/factory";
+import { createMiddleware as createMiddleware5 } from "hono/factory";
 import { HTTPException as HTTPException3 } from "hono/http-exception";
 var setResponseHandlers = (c) => {
   return {
@@ -13951,7 +13946,7 @@ var setResponseHandlers = (c) => {
     }
   };
 };
-var response = createMiddleware6(async (c, next) => {
+var response = createMiddleware5(async (c, next) => {
   c.set("res", setResponseHandlers(c));
   if (c.var.eventId) {
     c.header("x-event-id", c.var.eventId);
@@ -13960,7 +13955,7 @@ var response = createMiddleware6(async (c, next) => {
 });
 
 // src/middleware/clientInfo.ts
-import { createMiddleware as createMiddleware7 } from "hono/factory";
+import { createMiddleware as createMiddleware6 } from "hono/factory";
 import { UAParser } from "ua-parser-js";
 
 // src/crypto/pbkdf2.ts
@@ -14045,10 +14040,17 @@ async function hash3({
 }
 
 // src/middleware/clientInfo.ts
-var clientInfo = (config2) => createMiddleware7(async ({ env, req, set: set2 }, next) => {
+import { Logger as Logger3 } from "hierarchical-area-logger";
+var clientInfo = (config2) => createMiddleware6(async ({ env, req, set: set2, get }, next) => {
+  const logger2 = config2?.useLogger ? (get("logger") ?? new Logger3({
+    details: {
+      service: "dummy"
+    }
+  })).getArea("middeware:clientInfo") : void 0;
   if (!req.raw.cf) {
     throw new Error("Cloudflare data is not available");
   }
+  logger2?.debug("Retrieving hash secret from environment");
   const hashSecret = env[config2?.hashSecretBinding ?? "HASH_SECRET"];
   if (!hashSecret) {
     throw new Error("Hash secret is not available");
@@ -14067,6 +14069,7 @@ var clientInfo = (config2) => createMiddleware7(async ({ env, req, set: set2 },
     postalCode,
     timezone
   } = req.raw.cf;
+  logger2?.debug("Forming cloudflare client data object");
   const cf = {
     latitude,
     longitude,
@@ -14081,6 +14084,7 @@ var clientInfo = (config2) => createMiddleware7(async ({ env, req, set: set2 },
     postalCode,
     timezone
   };
+  logger2?.debug("Parsing user agent");
   const userAgent = req.raw.headers.get("user-agent") ?? "Unknown";
   const parser = new UAParser(userAgent);
   const userAgentParsed = parser.getResult();
@@ -14105,8 +14109,10 @@ var clientInfo = (config2) => createMiddleware7(async ({ env, req, set: set2 },
     },
     cpu: cpu.architecture ?? "Unknown"
   };
+  logger2?.debug("Getting ip address");
   const ip = req.raw.headers.get("CF-Connecting-IP") ?? "127.0.0.1";
   const clientContent = { ...cf, ...ua, ip };
+  logger2?.debug("Setting client data into context");
   set2("client", {
     ...clientContent,
     userAgent,
@@ -14116,16 +14122,7 @@ var clientInfo = (config2) => createMiddleware7(async ({ env, req, set: set2 },
       pepper: hashSecret
     })
   });
-  next();
-});
-
-// src/middleware/hydrateVariable.ts
-import { createMiddleware as createMiddleware8 } from "hono/factory";
-var hydrateVariable = ({
-  variableName,
-  hydrate
-}) => createMiddleware8(async ({ set: set2, env, get }, next) => {
-  set2(variableName, hydrate({ ...env, get }));
+  logger2?.info("Client data variable set");
   await next();
 });
 
@@ -14266,7 +14263,8 @@ var createTypedClient = () => {
         throw new HTTPException4(status, { message: "Fetch malformed" });
       }
       const { message } = detail;
-      options.errorHandler?.(status, { ...detail, status });
+      const eventId = responseHeaders.get("x-event-id") ?? void 0;
+      options.errorHandler?.(status, { ...detail, eventId, status });
       callbacks?.onError?.(detail, responseHeaders);
       throw new HTTPException4(status, { message });
     } finally {
@@ -14280,7 +14278,6 @@ export {
   sha_exports as SHA,
   clientInfo,
   createTypedClient,
-  hydrateVariable,
   i18n,
   isBot,
   jsonValidator,
@@ -14288,7 +14285,6 @@ export {
   onError,
   onNotFound,
   queue,
-  response,
-  withLogger
+  response
 };
 //# sourceMappingURL=index.js.map