@develit-io/backend-sdk 5.40.1 → 5.42.0

package/dist/index.d.mts

@@ -438,6 +438,17 @@ interface UseFetchOptions extends RequestInit {
 }
 declare function useFetch<T = unknown>(url: string, { parseAs, ...options }?: UseFetchOptions): Promise<Result<T>>;
 
+declare const signPayload: ({ payload, privateKey, }: {
+    payload: string;
+    privateKey: string;
+}) => Promise<string>;
+declare const verifyPayloadSignature: ({ signature, data, publicKey, algorithm, }: {
+    signature: string;
+    data: string;
+    publicKey: string;
+    algorithm?: "RSA" | "EC" | "HMAC";
+}) => Promise<boolean>;
+
 declare const calculateExponentialBackoff: (attempts: number, baseDelaySeconds: number) => number;
 
 declare const RPCResponse: {
@@ -527,5 +538,5 @@ interface WithRetryCounterOptions {
 type AsyncMethod<TArgs extends unknown[] = unknown[], TResult = unknown> = (...args: TArgs) => Promise<TResult>;
 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, bankAccount, bankAccountMetadataSchema, base, bicSchema, calculateExponentialBackoff, cloudflareQueue, composeWranglerBase, createAuditLogWriter, createInternalError, defineCommand, derivePortFromId, develitWorker, durableObjectNamespaceIdFromName, first, firstOrError, getD1Credentials, getD1DatabaseIdFromWrangler, getDrizzleD1Config, getSecret, handleAction, handleActionResponse, ibanSchema, idempotency, ip, isInternalError, jwt, logger, paginationQuerySchema, paginationSchema, service, signature, useFetch, useResult, useResultSync, uuidv4 };
+export { DatabaseTransaction, ENVIRONMENT, RPCResponse, USER_ROLES, action, bankAccount, bankAccountMetadataSchema, base, bicSchema, calculateExponentialBackoff, cloudflareQueue, composeWranglerBase, createAuditLogWriter, createInternalError, defineCommand, derivePortFromId, develitWorker, durableObjectNamespaceIdFromName, first, firstOrError, getD1Credentials, getD1DatabaseIdFromWrangler, getDrizzleD1Config, getSecret, handleAction, handleActionResponse, ibanSchema, idempotency, ip, isInternalError, jwt, logger, paginationQuerySchema, paginationSchema, service, signPayload, signature, useFetch, useResult, useResultSync, uuidv4, verifyPayloadSignature };
 export type { ActionExecution, ActionHandlerOptions, AuditLogWriter, AuthUser, BankAccountMetadata, BaseEvent, Command, CommandLogPayload, DevelitWorkerMethods, Environment, GatewayResponse, IRPCResponse, IdempotencyVariables, IncludeRelation, InferResultType, InternalError, InternalErrorResponseStatus, Project, UserRole, UserVariables, ValidatedInput };

package/dist/index.d.ts

@@ -438,6 +438,17 @@ interface UseFetchOptions extends RequestInit {
 }
 declare function useFetch<T = unknown>(url: string, { parseAs, ...options }?: UseFetchOptions): Promise<Result<T>>;
 
+declare const signPayload: ({ payload, privateKey, }: {
+    payload: string;
+    privateKey: string;
+}) => Promise<string>;
+declare const verifyPayloadSignature: ({ signature, data, publicKey, algorithm, }: {
+    signature: string;
+    data: string;
+    publicKey: string;
+    algorithm?: "RSA" | "EC" | "HMAC";
+}) => Promise<boolean>;
+
 declare const calculateExponentialBackoff: (attempts: number, baseDelaySeconds: number) => number;
 
 declare const RPCResponse: {
@@ -527,5 +538,5 @@ interface WithRetryCounterOptions {
 type AsyncMethod<TArgs extends unknown[] = unknown[], TResult = unknown> = (...args: TArgs) => Promise<TResult>;
 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, bankAccount, bankAccountMetadataSchema, base, bicSchema, calculateExponentialBackoff, cloudflareQueue, composeWranglerBase, createAuditLogWriter, createInternalError, defineCommand, derivePortFromId, develitWorker, durableObjectNamespaceIdFromName, first, firstOrError, getD1Credentials, getD1DatabaseIdFromWrangler, getDrizzleD1Config, getSecret, handleAction, handleActionResponse, ibanSchema, idempotency, ip, isInternalError, jwt, logger, paginationQuerySchema, paginationSchema, service, signature, useFetch, useResult, useResultSync, uuidv4 };
+export { DatabaseTransaction, ENVIRONMENT, RPCResponse, USER_ROLES, action, bankAccount, bankAccountMetadataSchema, base, bicSchema, calculateExponentialBackoff, cloudflareQueue, composeWranglerBase, createAuditLogWriter, createInternalError, defineCommand, derivePortFromId, develitWorker, durableObjectNamespaceIdFromName, first, firstOrError, getD1Credentials, getD1DatabaseIdFromWrangler, getDrizzleD1Config, getSecret, handleAction, handleActionResponse, ibanSchema, idempotency, ip, isInternalError, jwt, logger, paginationQuerySchema, paginationSchema, service, signPayload, signature, useFetch, useResult, useResultSync, uuidv4, verifyPayloadSignature };
 export type { ActionExecution, ActionHandlerOptions, AuditLogWriter, AuthUser, BankAccountMetadata, BaseEvent, Command, CommandLogPayload, DevelitWorkerMethods, Environment, GatewayResponse, IRPCResponse, IdempotencyVariables, IncludeRelation, InferResultType, InternalError, InternalErrorResponseStatus, Project, UserRole, UserVariables, ValidatedInput };

package/dist/index.mjs

@@ -473,6 +473,37 @@ const logResponse = (log) => {
   console.log(`RESPONSE | An outgoing response has been recorded.`, log);
 };
 
+const signPayload = async ({
+  payload,
+  privateKey
+}) => {
+  const binaryPrivateKey = Uint8Array.from(
+    atob(privateKey),
+    (c) => c.charCodeAt(0)
+  );
+  const importedPrivateKey = await crypto.subtle.importKey(
+    "pkcs8",
+    binaryPrivateKey,
+    {
+      name: "RSASSA-PKCS1-v1_5",
+      hash: "SHA-256"
+    },
+    false,
+    ["sign"]
+  );
+  const encodedPayload = new TextEncoder().encode(payload);
+  const signature = await crypto.subtle.sign(
+    {
+      name: "RSASSA-PKCS1-v1_5"
+    },
+    importedPrivateKey,
+    encodedPayload
+  );
+  const base64Signature = btoa(
+    String.fromCharCode(...new Uint8Array(signature))
+  );
+  return base64Signature;
+};
 const algParams = {
   RSA: {
     name: "RSASSA-PKCS1-v1_5",
@@ -487,7 +518,7 @@ const algParams = {
     hash: { name: "SHA-256" }
   }
 };
-const verify = async ({
+const verifyPayloadSignature = async ({
   signature,
   data,
   publicKey,
@@ -583,36 +614,35 @@ const jwt = () => {
 
 const ip = () => {
   return createMiddleware(async (context, next) => {
-    if (["localhost", "dev"].includes(context.env.ENVIRONMENT)) {
-      await next();
-    }
-    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."
-      });
-    }
-    const user = context.get("user");
-    if (!user.organizationId) {
-      throw new HTTPException(401, {
-        message: "Failed to retrieve request organization ID."
-      });
-    }
-    const organizationService = context.env.ORGANIZATION_SERVICE;
-    const { data: organization, error } = await organizationService.getOrganization({
-      organizationId: user.organizationId
-    });
-    if (!organization || error) {
-      throw new HTTPException(404, {
-        message: "Failed to retrieve organization."
+    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."
+        });
+      }
+      const user = context.get("user");
+      if (!user.organizationId) {
+        throw new HTTPException(401, {
+          message: "Failed to retrieve request organization ID."
+        });
+      }
+      const organizationService = context.env.ORGANIZATION_SERVICE;
+      const { data: organization, error } = await organizationService.getOrganization({
+        organizationId: user.organizationId
       });
-    }
-    if (organization.ipAuthorization) {
-      if (!organization.authorizedIps.map((ip2) => ip2.ip).includes(requestIp)) {
+      if (!organization || error) {
         throw new HTTPException(404, {
-          message: "Forbidden"
+          message: "Failed to retrieve organization."
         });
       }
+      if (organization.ipAuthorization) {
+        if (!organization.authorizedIps.map((ip2) => ip2.ip).includes(requestIp)) {
+          throw new HTTPException(404, {
+            message: "Forbidden"
+          });
+        }
+      }
     }
     await next();
   });
@@ -655,54 +685,53 @@ const logger = () => {
 
 const signature = () => {
   return createMiddleware(async (context, next) => {
-    if (["localhost", "dev"].includes(context.env.ENVIRONMENT)) {
-      await next();
-    }
-    const signatureHeader = context.req.header("X-Signature");
-    if (!signatureHeader) {
-      throw new HTTPException(401, {
-        message: `The 'X-Signature' header must exist and must have a value.`
-      });
-    }
-    const signatureKeyHeader = context.req.header("X-Signature-Key");
-    if (!signatureKeyHeader) {
-      throw new HTTPException(401, {
-        message: `The 'X-Signature-Key' header must exist and must have a value.`
-      });
-    }
-    const payload = JSON.stringify(await context.req.json().catch(() => null));
-    const user = context.get("user");
-    if (!user.organizationId) {
-      throw new HTTPException(401, {
-        message: "Failed to retrieve request organization ID."
-      });
-    }
-    const organizationService = context.env.ORGANIZATION_SERVICE;
-    const { data: organization, error } = await organizationService.getOrganization({
-      organizationId: user.organizationId
-    });
-    if (!organization || error) {
-      throw new HTTPException(404, {
-        message: "Failed to retrieve organization."
-      });
-    }
-    const signatureKey = organization.signatureKeys.filter(
-      (signatureKey2) => signatureKey2.name === signatureKeyHeader
-    )[0];
-    if (!signatureKey) {
-      throw new HTTPException(404, {
-        message: "Signature key not found."
+    if (!["localhost", "dev"].includes(context.env.ENVIRONMENT)) {
+      const signatureHeader = context.req.header("X-Signature");
+      if (!signatureHeader) {
+        throw new HTTPException(401, {
+          message: `The 'X-Signature' header must exist and must have a value.`
+        });
+      }
+      const signatureKeyHeader = context.req.header("X-Signature-Key");
+      if (!signatureKeyHeader) {
+        throw new HTTPException(401, {
+          message: `The 'X-Signature-Key' header must exist and must have a value.`
+        });
+      }
+      const payload = JSON.stringify(await context.req.json().catch(() => null));
+      const user = context.get("user");
+      if (!user.organizationId) {
+        throw new HTTPException(401, {
+          message: "Failed to retrieve request organization ID."
+        });
+      }
+      const organizationService = context.env.ORGANIZATION_SERVICE;
+      const { data: organization, error } = await organizationService.getOrganization({
+        organizationId: user.organizationId
       });
-    }
-    const isVerified = await verify({
-      signature: signatureHeader,
-      publicKey: signatureKey.publicKey,
-      data: payload
-    });
-    if (!isVerified) {
-      throw new HTTPException(401, {
-        message: "Invalid signature key or signature."
+      if (!organization || error) {
+        throw new HTTPException(404, {
+          message: "Failed to retrieve organization."
+        });
+      }
+      const signatureKey = organization.signatureKeys.filter(
+        (signatureKey2) => signatureKey2.name === signatureKeyHeader
+      )[0];
+      if (!signatureKey) {
+        throw new HTTPException(404, {
+          message: "Signature key not found."
+        });
+      }
+      const isVerified = await verifyPayloadSignature({
+        signature: signatureHeader,
+        publicKey: signatureKey.publicKey,
+        data: payload
       });
+      if (!isVerified) {
+        throw new HTTPException(401, {
+          message: "Invalid signature key or signature."
+        });
+      }
     }
     await next();
   });
@@ -950,4 +979,4 @@ function develitWorker(Worker) {
   return DevelitWorker;
 }
 
-export { DatabaseTransaction, ENVIRONMENT, RPCResponse, USER_ROLES, action, bankAccount, bankAccountMetadataSchema, base, bicSchema, calculateExponentialBackoff, cloudflareQueue, composeWranglerBase, createAuditLogWriter, createInternalError, defineCommand, derivePortFromId, develitWorker, durableObjectNamespaceIdFromName, first, firstOrError, getD1Credentials, getD1DatabaseIdFromWrangler, getDrizzleD1Config, getSecret, handleAction, handleActionResponse, ibanSchema, idempotency, ip, isInternalError, jwt, logger, paginationQuerySchema, paginationSchema, service, signature, useFetch, useResult, useResultSync, uuidv4 };
+export { DatabaseTransaction, ENVIRONMENT, RPCResponse, USER_ROLES, action, bankAccount, bankAccountMetadataSchema, base, bicSchema, calculateExponentialBackoff, cloudflareQueue, composeWranglerBase, createAuditLogWriter, createInternalError, defineCommand, derivePortFromId, develitWorker, durableObjectNamespaceIdFromName, first, firstOrError, getD1Credentials, getD1DatabaseIdFromWrangler, getDrizzleD1Config, getSecret, handleAction, handleActionResponse, ibanSchema, idempotency, ip, isInternalError, jwt, logger, paginationQuerySchema, paginationSchema, service, signPayload, signature, useFetch, useResult, useResultSync, uuidv4, verifyPayloadSignature };

package/package.json

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