@develit-io/backend-sdk 9.0.3 → 9.1.1

package/dist/index.d.mts

@@ -474,6 +474,22 @@ type InferResultType<Tables extends Record<string, unknown>, TableName extends k
     with: With;
 }>;
 
+interface RequestLog {
+    method: string;
+    path: string;
+    query: Record<string, string>;
+    headers: Record<string, string>;
+    body: Record<string, unknown> | null;
+}
+interface ResponseLog {
+    method: string;
+    path: string;
+    status: number;
+    statusText: string;
+    headers: Record<string, string>;
+    body: unknown;
+}
+
 declare const paginationQuerySchema: z.$ZodObject<Readonly<Readonly<{
     [k: string]: z.$ZodType<unknown, unknown, z.$ZodTypeInternals<unknown, unknown>>;
 }>>, z.$ZodObjectConfig>;
@@ -844,4 +860,4 @@ type AsyncMethod<TArgs extends unknown[] = unknown[], TResult = unknown> = (...a
 declare function cloudflareQueue<TArgs extends unknown[] = unknown[], TResult = unknown>(options: WithRetryCounterOptions): (target: unknown, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<AsyncMethod<TArgs, TResult>>) => void;
 
 export { DatabaseTransaction, ENVIRONMENT, RPCResponse, USER_ROLES, action, asNonEmpty, bankAccount, bankAccountMetadataSchema, base, bicSchema, buildMultiFilterConditions, buildRangeFilterConditions, buildSearchConditions, calculateExponentialBackoff, cloudflareQueue, composeWranglerBase, createAuditLogWriter, createInternalError, createSignatureKeyPair, defineCommand, derivePortFromId, develitWorker, durableObjectNamespaceIdFromName, first, firstOrError, getD1Credentials, getD1DatabaseIdFromWrangler, getDrizzleD1Config, getSecret, handleAction, ibanSchema, isInternalError, nullToOptional, optionalToNull, paginationQuerySchema, paginationSchema, resolveColumn, service, signPayload, useFetch, useResult, useResultSync, uuidv4, verifyPayloadSignature, workflowInstanceStatusSchema };
-export type { ActionExecution, ActionHandlerOptions, AuditLogWriter, BankAccountMetadata, BaseEvent, BuildSearchOptions, Command, CommandLogPayload, DevelitWorkerMethods, Environment, GatewayResponse, IRPCResponse, IdempotencyContextVariables, IncludeRelation, InferResultType, InternalError, InternalErrorResponseStatus, Project, UserContextVariables, UserRole, ValidatedInput, WorkflowInstanceStatus };
+export type { ActionExecution, ActionHandlerOptions, AuditLogWriter, BankAccountMetadata, BaseEvent, BuildSearchOptions, Command, CommandLogPayload, DevelitWorkerMethods, Environment, GatewayResponse, IRPCResponse, IdempotencyContextVariables, IncludeRelation, InferResultType, InternalError, InternalErrorResponseStatus, Project, RequestLog, ResponseLog, UserContextVariables, UserRole, ValidatedInput, WorkflowInstanceStatus };

package/dist/index.d.ts

@@ -474,6 +474,22 @@ type InferResultType<Tables extends Record<string, unknown>, TableName extends k
     with: With;
 }>;
 
+interface RequestLog {
+    method: string;
+    path: string;
+    query: Record<string, string>;
+    headers: Record<string, string>;
+    body: Record<string, unknown> | null;
+}
+interface ResponseLog {
+    method: string;
+    path: string;
+    status: number;
+    statusText: string;
+    headers: Record<string, string>;
+    body: unknown;
+}
+
 declare const paginationQuerySchema: z.$ZodObject<Readonly<Readonly<{
     [k: string]: z.$ZodType<unknown, unknown, z.$ZodTypeInternals<unknown, unknown>>;
 }>>, z.$ZodObjectConfig>;
@@ -844,4 +860,4 @@ type AsyncMethod<TArgs extends unknown[] = unknown[], TResult = unknown> = (...a
 declare function cloudflareQueue<TArgs extends unknown[] = unknown[], TResult = unknown>(options: WithRetryCounterOptions): (target: unknown, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<AsyncMethod<TArgs, TResult>>) => void;
 
 export { DatabaseTransaction, ENVIRONMENT, RPCResponse, USER_ROLES, action, asNonEmpty, bankAccount, bankAccountMetadataSchema, base, bicSchema, buildMultiFilterConditions, buildRangeFilterConditions, buildSearchConditions, calculateExponentialBackoff, cloudflareQueue, composeWranglerBase, createAuditLogWriter, createInternalError, createSignatureKeyPair, defineCommand, derivePortFromId, develitWorker, durableObjectNamespaceIdFromName, first, firstOrError, getD1Credentials, getD1DatabaseIdFromWrangler, getDrizzleD1Config, getSecret, handleAction, ibanSchema, isInternalError, nullToOptional, optionalToNull, paginationQuerySchema, paginationSchema, resolveColumn, service, signPayload, useFetch, useResult, useResultSync, uuidv4, verifyPayloadSignature, workflowInstanceStatusSchema };
-export type { ActionExecution, ActionHandlerOptions, AuditLogWriter, BankAccountMetadata, BaseEvent, BuildSearchOptions, Command, CommandLogPayload, DevelitWorkerMethods, Environment, GatewayResponse, IRPCResponse, IdempotencyContextVariables, IncludeRelation, InferResultType, InternalError, InternalErrorResponseStatus, Project, UserContextVariables, UserRole, ValidatedInput, WorkflowInstanceStatus };
+export type { ActionExecution, ActionHandlerOptions, AuditLogWriter, BankAccountMetadata, BaseEvent, BuildSearchOptions, Command, CommandLogPayload, DevelitWorkerMethods, Environment, GatewayResponse, IRPCResponse, IdempotencyContextVariables, IncludeRelation, InferResultType, InternalError, InternalErrorResponseStatus, Project, RequestLog, ResponseLog, UserContextVariables, UserRole, ValidatedInput, WorkflowInstanceStatus };

package/dist/middlewares.mjs

@@ -25,89 +25,94 @@ const logRequest = (log) => {
 const logResponse = (log) => {
   console.log(`RESPONSE | An outgoing response has been recorded.`, log);
 };
+const getRequestIpAddress = (request) => {
+  return request.header("cf-connecting-ip") || request.header("x-real-ip") || request.header("x-forwarded-for") || "UNKNOWN";
+};
+const getRequestUserAgent = (request) => {
+  return request.header("user-agent") || "UNKNOWN";
+};
 
 const idempotency = () => {
   return createMiddleware(async (context, next) => {
-    const idempotencyKeyHeader = context.req.header("x-idempotency-key");
-    if (!idempotencyKeyHeader) {
-      throw new HTTPException(401, {
-        message: `The 'x-idempotency-key' header must exist and must have a value.`
-      });
-    }
-    const existingIdempotencyRecord = await context.env.IDEMPOTENCY_KV.get(idempotencyKeyHeader);
-    if (existingIdempotencyRecord) {
-      throw new HTTPException(409, {
-        message: "The identical request has already been processed. The idempotency key is not unique."
+    if (!context.env.MIDDLEWARE_IDEMPOTENCY_DISABLED) {
+      const idempotencyKeyHeader = context.req.header("x-idempotency-key");
+      if (!idempotencyKeyHeader) {
+        throw new HTTPException(401, {
+          message: `The 'x-idempotency-key' header must exist and must have a value.`
+        });
+      }
+      const existingIdempotencyRecord = await context.env.IDEMPOTENCY_KV.get(idempotencyKeyHeader);
+      if (existingIdempotencyRecord) {
+        throw new HTTPException(409, {
+          message: "The identical request has already been processed. The idempotency key is not unique."
+        });
+      }
+      await context.env.IDEMPOTENCY_KV.put(
+        idempotencyKeyHeader,
+        idempotencyKeyHeader,
+        {
+          expirationTtl: 60 * 60 * 24 * 3
+          // 3 days
+        }
+      );
+      context.set("idempotency", {
+        key: idempotencyKeyHeader
       });
     }
-    await context.env.IDEMPOTENCY_KV.put(
-      idempotencyKeyHeader,
-      idempotencyKeyHeader,
-      {
-        expirationTtl: 60 * 60 * 24 * 3
-        // 3 days
-      }
-    );
-    context.set("idempotency", {
-      key: idempotencyKeyHeader
-    });
     await next();
   });
 };
 
 const jwt = () => {
   return createMiddleware(async (context, next) => {
-    const authorizationHeader = context.req.header("authorization");
-    if (!authorizationHeader) {
-      throw new HTTPException(401, {
-        message: `The 'authorization' header must exist and must have a value.`
-      });
-    }
-    if (!validateBearerScheme(authorizationHeader)) {
-      throw new HTTPException(401, {
-        message: `The 'authorization' header value must use the Bearer scheme.`
-      });
-    }
-    const bearerToken = extractBearerToken(authorizationHeader);
-    if (!validateBearerToken(bearerToken)) {
-      throw new HTTPException(401, {
-        message: `The Bearer token in the 'authorization' header value must be a JWT.`
-      });
-    }
-    const { data, error } = await context.env.AUTH_SERVICE.verifyAccessToken({
-      accessToken: bearerToken
-    });
-    if (!data || error) {
-      throw new HTTPException(401, {
-        message: "The JWT must contain valid user information."
+    if (!context.env.MIDDLEWARE_JWT_DISABLED) {
+      const authorizationHeader = context.req.header("authorization");
+      if (!authorizationHeader) {
+        throw new HTTPException(401, {
+          message: `The 'authorization' header must exist and must have a value.`
+        });
+      }
+      if (!validateBearerScheme(authorizationHeader)) {
+        throw new HTTPException(401, {
+          message: `The 'authorization' header value must use the Bearer scheme.`
+        });
+      }
+      const bearerToken = extractBearerToken(authorizationHeader);
+      if (!validateBearerToken(bearerToken)) {
+        throw new HTTPException(401, {
+          message: `The Bearer token in the 'authorization' header value must be a JWT.`
+        });
+      }
+      const { data, error } = await context.env.AUTH_SERVICE.verifyAccessToken({
+        accessToken: bearerToken
       });
-    }
-    const rawUserMetaDataString = data.payload.user.rawUserMetaData;
-    const rawUserMetaData = rawUserMetaDataString ? JSON.parse(rawUserMetaDataString) : null;
-    const organizationId = rawUserMetaData?.organizationId ?? null;
-    if (!organizationId) {
-      throw new HTTPException(422, {
-        message: "User data integrity check failed."
+      if (!data || error) {
+        throw new HTTPException(401, {
+          message: "The JWT must contain valid user information."
+        });
+      }
+      const rawUserMetaDataString = data.payload.user.rawUserMetaData;
+      const rawUserMetaData = rawUserMetaDataString ? JSON.parse(rawUserMetaDataString) : null;
+      const organizationId = rawUserMetaData?.organizationId ?? null;
+      if (!organizationId) {
+        throw new HTTPException(422, {
+          message: "User data integrity check failed."
+        });
+      }
+      context.set("user", {
+        email: data.payload.user.email,
+        role: data.payload.user.role,
+        organizationId
       });
     }
-    context.set("user", {
-      email: data.payload.user.email,
-      role: data.payload.user.role,
-      organizationId
-    });
     await next();
   });
 };
 
 const ip = () => {
   return createMiddleware(async (context, next) => {
-    if (!["localhost", "dev"].includes(context.env.ENVIRONMENT)) {
-      const requestIp = context.req.header("cf-connecting-ip") || context.req.header("x-forwarded-for");
-      if (!requestIp) {
-        throw new HTTPException(401, {
-          message: "Failed to retrieve request IP address."
-        });
-      }
+    if (!context.env.MIDDLEWARE_IP_DISABLED) {
+      const requestIp = getRequestIpAddress(context.req);
       const user = context.get("user");
       if (!user.organizationId) {
         throw new HTTPException(401, {
@@ -156,22 +161,56 @@ const composeResponseLog = async (response, method, path) => {
 
 const logger = () => {
   return createMiddleware(async (context, next) => {
-    const requestLog = await composeRequestLog(context.req);
-    logRequest(requestLog);
+    if (!context.env.MIDDLEWARE_LOGGER_DISABLED) {
+      const requestLog = await composeRequestLog(context.req);
+      logRequest(requestLog);
+      if (!context.env.MIDDLEWARE_LOGGER_AUDITLOG_DISABLED) {
+        const user = context.get("user") || {};
+        await context.env.AUDITLOG_SERVICE.processLog({
+          type: "REQUEST",
+          actor: {
+            email: user.email || "UNKNOWN",
+            organizationId: user.organizationId || "UNKNOWN"
+          },
+          metadata: {
+            ip: getRequestIpAddress(context.req),
+            userAgent: getRequestUserAgent(context.req)
+          },
+          log: requestLog
+        });
+      }
+    }
     await next();
-    const response = context.res.clone();
-    const responseLog = await composeResponseLog(
-      response,
-      context.req.method,
-      context.req.url
-    );
-    logResponse(responseLog);
+    if (!context.env.MIDDLEWARE_LOGGER_DISABLED) {
+      const response = context.res.clone();
+      const responseLog = await composeResponseLog(
+        response,
+        context.req.method,
+        context.req.url
+      );
+      logResponse(responseLog);
+      if (!context.env.MIDDLEWARE_LOGGER_AUDITLOG_DISABLED) {
+        const user = context.get("user") || {};
+        await context.env.AUDITLOG_SERVICE.processLog({
+          type: "RESPONSE",
+          actor: {
+            email: user.email || "UNKNOWN",
+            organizationId: user.organizationId || "UNKNOWN"
+          },
+          metadata: {
+            ip: getRequestIpAddress(context.req),
+            userAgent: getRequestUserAgent(context.req)
+          },
+          log: responseLog
+        });
+      }
+    }
   });
 };
 
 const signature = () => {
   return createMiddleware(async (context, next) => {
-    if (!["localhost", "dev"].includes(context.env.ENVIRONMENT)) {
+    if (!context.env.MIDDLEWARE_SIGNATURE_DISABLED) {
       const signatureHeader = context.req.header("x-signature");
       if (!signatureHeader) {
         throw new HTTPException(401, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@develit-io/backend-sdk",
-  "version": "9.0.3",
+  "version": "9.1.1",
   "description": "Develit Backend SDK",
   "author": "Develit.io",
   "license": "ISC",