@thirdweb-dev/service-utils 0.5.0-nightly-0f027069-20230828164852 → 0.5.0-nightly-6cf298a29-20240308012322

package/node/dist/thirdweb-dev-service-utils-node.cjs.dev.js

@@ -3,9 +3,26 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var node_crypto = require('node:crypto');
-var index = require('../../dist/index-cd4f96ef.cjs.dev.js');
-var services = require('../../dist/services-a3f36057.cjs.dev.js');
+var index = require('../../dist/index-62b88cac.cjs.dev.js');
+var services = require('../../dist/services-508322f3.cjs.dev.js');
 
+/**
+ *
+ * @param {AuthInput['req']} authInput.req - The incoming request from which information will be pulled from. These information includes (checks are in order and terminates on first match):
+ * - clientId: Checks header `x-client-id`, search param `clientId`
+ * - bundleId: Checks header `x-bundle-id`, search param `bundleId`
+ * - secretKey: Checks header `x-secret-key`
+ * - origin (the requesting domain): Checks header `origin`, `referer`
+ * @param {AuthInput['clientId']} authInput.clientId - Overrides any clientId found on the `req` object
+ * @param {AuthInput['targetAddress']} authInput.targetAddress - Only used in smart wallets to determine if the request is authorized to interact with the target address.
+ * @param {NodeServiceConfig['enforceAuth']} serviceConfig - Always `true` unless you need to turn auth off. Tells the service whether or not to enforce auth.
+ * @param {NodeServiceConfig['apiUrl']} serviceConfig.apiUrl - The url of the api server to fetch information for verification. `https://api.thirdweb.com` for production and `https://api.staging.thirdweb.com` for staging
+ * @param {NodeServiceConfig['serviceApiKey']} serviceConfig.serviceApiKey - secret key to be used authenticate the caller of the api-server. Check the api-server's env variable for the keys.
+ * @param {NodeServiceConfig['serviceScope']} serviceConfig.serviceScope - The service that we are requesting authorization for. E.g. `relayer`, `rpc`, 'bundler', 'storage' etc.
+ * @param {NodeServiceConfig['serviceAction']} serviceConfig.serviceAction - Needed when the `serviceScope` is `storage`. Can be either `read` or `write`.
+ * @param {NodeServiceConfig['useWalletAuth']} serviceConfig.useWalletAuth - If true it pings the `wallet/me` or else, `account/me`. You most likely can leave this as false.
+ * @returns {AuthorizationResult} authorizationResult - contains if the request is authorized, and information about the account if it is authorized. Otherwise, it contains the error message and status code.
+ */
 async function authorizeNode(authInput, serviceConfig) {
   let authData;
   try {
@@ -131,31 +148,40 @@ function logHttpRequest(_ref) {
     req,
     res,
     isAuthed,
-    statusMessage
+    statusMessage,
+    latencyMs
   } = _ref;
-  const authorizationData = extractAuthorizationData({
-    req,
-    clientId
-  });
-  const headers = req.headers;
-  const _statusMessage = statusMessage ?? res.statusMessage;
-  console.log(JSON.stringify({
-    source,
-    pathname: req.url,
-    hasSecretKey: !!authorizationData.secretKey,
-    hasClientId: !!authorizationData.clientId,
-    hasJwt: !!authorizationData.jwt,
-    clientId: authorizationData.clientId,
-    isAuthed: !!isAuthed ?? null,
-    status: res.statusCode,
-    statusMessage: _statusMessage,
-    sdkName: headers["x-sdk-name"] ?? "unknown",
-    sdkVersion: headers["x-sdk-version"] ?? "unknown",
-    platform: headers["x-sdk-platform"] ?? "unknown"
-  }));
-  console.log(`statusMessage=${_statusMessage}`);
+  try {
+    const authorizationData = extractAuthorizationData({
+      req,
+      clientId
+    });
+    const headers = req.headers;
+    const _statusMessage = statusMessage ?? res.statusMessage;
+    console.log(JSON.stringify({
+      source,
+      pathname: req.url,
+      hasSecretKey: !!authorizationData.secretKey,
+      hasClientId: !!authorizationData.clientId,
+      hasJwt: !!authorizationData.jwt,
+      clientId: authorizationData.clientId,
+      isAuthed: !!isAuthed ?? null,
+      status: res.statusCode,
+      statusMessage: _statusMessage,
+      sdkName: headers["x-sdk-name"] ?? "unknown",
+      sdkVersion: headers["x-sdk-version"] ?? "unknown",
+      platform: headers["x-sdk-platform"] ?? "unknown",
+      os: headers["x-sdk-os"] ?? "unknown",
+      latencyMs: latencyMs ?? null
+    }));
+    console.log(`statusMessage=${_statusMessage}`);
+  } catch (err) {
+    console.error("Failed to log HTTP request:", err);
+  }
 }
 
+exports.rateLimit = index.rateLimit;
+exports.usageLimit = index.usageLimit;
 exports.SERVICES = services.SERVICES;
 exports.SERVICE_DEFINITIONS = services.SERVICE_DEFINITIONS;
 exports.SERVICE_NAMES = services.SERVICE_NAMES;

package/node/dist/thirdweb-dev-service-utils-node.cjs.prod.js

@@ -3,9 +3,26 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var node_crypto = require('node:crypto');
-var index = require('../../dist/index-6e0ecc5f.cjs.prod.js');
-var services = require('../../dist/services-9e185105.cjs.prod.js');
+var index = require('../../dist/index-aa324361.cjs.prod.js');
+var services = require('../../dist/services-5c4d6977.cjs.prod.js');
 
+/**
+ *
+ * @param {AuthInput['req']} authInput.req - The incoming request from which information will be pulled from. These information includes (checks are in order and terminates on first match):
+ * - clientId: Checks header `x-client-id`, search param `clientId`
+ * - bundleId: Checks header `x-bundle-id`, search param `bundleId`
+ * - secretKey: Checks header `x-secret-key`
+ * - origin (the requesting domain): Checks header `origin`, `referer`
+ * @param {AuthInput['clientId']} authInput.clientId - Overrides any clientId found on the `req` object
+ * @param {AuthInput['targetAddress']} authInput.targetAddress - Only used in smart wallets to determine if the request is authorized to interact with the target address.
+ * @param {NodeServiceConfig['enforceAuth']} serviceConfig - Always `true` unless you need to turn auth off. Tells the service whether or not to enforce auth.
+ * @param {NodeServiceConfig['apiUrl']} serviceConfig.apiUrl - The url of the api server to fetch information for verification. `https://api.thirdweb.com` for production and `https://api.staging.thirdweb.com` for staging
+ * @param {NodeServiceConfig['serviceApiKey']} serviceConfig.serviceApiKey - secret key to be used authenticate the caller of the api-server. Check the api-server's env variable for the keys.
+ * @param {NodeServiceConfig['serviceScope']} serviceConfig.serviceScope - The service that we are requesting authorization for. E.g. `relayer`, `rpc`, 'bundler', 'storage' etc.
+ * @param {NodeServiceConfig['serviceAction']} serviceConfig.serviceAction - Needed when the `serviceScope` is `storage`. Can be either `read` or `write`.
+ * @param {NodeServiceConfig['useWalletAuth']} serviceConfig.useWalletAuth - If true it pings the `wallet/me` or else, `account/me`. You most likely can leave this as false.
+ * @returns {AuthorizationResult} authorizationResult - contains if the request is authorized, and information about the account if it is authorized. Otherwise, it contains the error message and status code.
+ */
 async function authorizeNode(authInput, serviceConfig) {
   let authData;
   try {
@@ -131,31 +148,40 @@ function logHttpRequest(_ref) {
     req,
     res,
     isAuthed,
-    statusMessage
+    statusMessage,
+    latencyMs
   } = _ref;
-  const authorizationData = extractAuthorizationData({
-    req,
-    clientId
-  });
-  const headers = req.headers;
-  const _statusMessage = statusMessage ?? res.statusMessage;
-  console.log(JSON.stringify({
-    source,
-    pathname: req.url,
-    hasSecretKey: !!authorizationData.secretKey,
-    hasClientId: !!authorizationData.clientId,
-    hasJwt: !!authorizationData.jwt,
-    clientId: authorizationData.clientId,
-    isAuthed: !!isAuthed ?? null,
-    status: res.statusCode,
-    statusMessage: _statusMessage,
-    sdkName: headers["x-sdk-name"] ?? "unknown",
-    sdkVersion: headers["x-sdk-version"] ?? "unknown",
-    platform: headers["x-sdk-platform"] ?? "unknown"
-  }));
-  console.log(`statusMessage=${_statusMessage}`);
+  try {
+    const authorizationData = extractAuthorizationData({
+      req,
+      clientId
+    });
+    const headers = req.headers;
+    const _statusMessage = statusMessage ?? res.statusMessage;
+    console.log(JSON.stringify({
+      source,
+      pathname: req.url,
+      hasSecretKey: !!authorizationData.secretKey,
+      hasClientId: !!authorizationData.clientId,
+      hasJwt: !!authorizationData.jwt,
+      clientId: authorizationData.clientId,
+      isAuthed: !!isAuthed ?? null,
+      status: res.statusCode,
+      statusMessage: _statusMessage,
+      sdkName: headers["x-sdk-name"] ?? "unknown",
+      sdkVersion: headers["x-sdk-version"] ?? "unknown",
+      platform: headers["x-sdk-platform"] ?? "unknown",
+      os: headers["x-sdk-os"] ?? "unknown",
+      latencyMs: latencyMs ?? null
+    }));
+    console.log(`statusMessage=${_statusMessage}`);
+  } catch (err) {
+    console.error("Failed to log HTTP request:", err);
+  }
 }
 
+exports.rateLimit = index.rateLimit;
+exports.usageLimit = index.usageLimit;
 exports.SERVICES = services.SERVICES;
 exports.SERVICE_DEFINITIONS = services.SERVICE_DEFINITIONS;
 exports.SERVICE_NAMES = services.SERVICE_NAMES;

package/node/dist/thirdweb-dev-service-utils-node.esm.js

@@ -1,7 +1,25 @@
 import { createHash } from 'node:crypto';
-import { a as authorize } from '../../dist/index-ffddf746.esm.js';
-export { b as SERVICES, S as SERVICE_DEFINITIONS, a as SERVICE_NAMES, g as getServiceByName } from '../../dist/services-86283509.esm.js';
+import { a as authorize } from '../../dist/index-3b9a0743.esm.js';
+export { r as rateLimit, u as usageLimit } from '../../dist/index-3b9a0743.esm.js';
+export { b as SERVICES, S as SERVICE_DEFINITIONS, a as SERVICE_NAMES, g as getServiceByName } from '../../dist/services-2aecbda8.esm.js';
 
+/**
+ *
+ * @param {AuthInput['req']} authInput.req - The incoming request from which information will be pulled from. These information includes (checks are in order and terminates on first match):
+ * - clientId: Checks header `x-client-id`, search param `clientId`
+ * - bundleId: Checks header `x-bundle-id`, search param `bundleId`
+ * - secretKey: Checks header `x-secret-key`
+ * - origin (the requesting domain): Checks header `origin`, `referer`
+ * @param {AuthInput['clientId']} authInput.clientId - Overrides any clientId found on the `req` object
+ * @param {AuthInput['targetAddress']} authInput.targetAddress - Only used in smart wallets to determine if the request is authorized to interact with the target address.
+ * @param {NodeServiceConfig['enforceAuth']} serviceConfig - Always `true` unless you need to turn auth off. Tells the service whether or not to enforce auth.
+ * @param {NodeServiceConfig['apiUrl']} serviceConfig.apiUrl - The url of the api server to fetch information for verification. `https://api.thirdweb.com` for production and `https://api.staging.thirdweb.com` for staging
+ * @param {NodeServiceConfig['serviceApiKey']} serviceConfig.serviceApiKey - secret key to be used authenticate the caller of the api-server. Check the api-server's env variable for the keys.
+ * @param {NodeServiceConfig['serviceScope']} serviceConfig.serviceScope - The service that we are requesting authorization for. E.g. `relayer`, `rpc`, 'bundler', 'storage' etc.
+ * @param {NodeServiceConfig['serviceAction']} serviceConfig.serviceAction - Needed when the `serviceScope` is `storage`. Can be either `read` or `write`.
+ * @param {NodeServiceConfig['useWalletAuth']} serviceConfig.useWalletAuth - If true it pings the `wallet/me` or else, `account/me`. You most likely can leave this as false.
+ * @returns {AuthorizationResult} authorizationResult - contains if the request is authorized, and information about the account if it is authorized. Otherwise, it contains the error message and status code.
+ */
 async function authorizeNode(authInput, serviceConfig) {
   let authData;
   try {
@@ -127,29 +145,36 @@ function logHttpRequest(_ref) {
     req,
     res,
     isAuthed,
-    statusMessage
+    statusMessage,
+    latencyMs
   } = _ref;
-  const authorizationData = extractAuthorizationData({
-    req,
-    clientId
-  });
-  const headers = req.headers;
-  const _statusMessage = statusMessage ?? res.statusMessage;
-  console.log(JSON.stringify({
-    source,
-    pathname: req.url,
-    hasSecretKey: !!authorizationData.secretKey,
-    hasClientId: !!authorizationData.clientId,
-    hasJwt: !!authorizationData.jwt,
-    clientId: authorizationData.clientId,
-    isAuthed: !!isAuthed ?? null,
-    status: res.statusCode,
-    statusMessage: _statusMessage,
-    sdkName: headers["x-sdk-name"] ?? "unknown",
-    sdkVersion: headers["x-sdk-version"] ?? "unknown",
-    platform: headers["x-sdk-platform"] ?? "unknown"
-  }));
-  console.log(`statusMessage=${_statusMessage}`);
+  try {
+    const authorizationData = extractAuthorizationData({
+      req,
+      clientId
+    });
+    const headers = req.headers;
+    const _statusMessage = statusMessage ?? res.statusMessage;
+    console.log(JSON.stringify({
+      source,
+      pathname: req.url,
+      hasSecretKey: !!authorizationData.secretKey,
+      hasClientId: !!authorizationData.clientId,
+      hasJwt: !!authorizationData.jwt,
+      clientId: authorizationData.clientId,
+      isAuthed: !!isAuthed ?? null,
+      status: res.statusCode,
+      statusMessage: _statusMessage,
+      sdkName: headers["x-sdk-name"] ?? "unknown",
+      sdkVersion: headers["x-sdk-version"] ?? "unknown",
+      platform: headers["x-sdk-platform"] ?? "unknown",
+      os: headers["x-sdk-os"] ?? "unknown",
+      latencyMs: latencyMs ?? null
+    }));
+    console.log(`statusMessage=${_statusMessage}`);
+  } catch (err) {
+    console.error("Failed to log HTTP request:", err);
+  }
 }
 
 export { authorizeNode, deriveClientIdFromSecretKeyHash, extractAuthorizationData, hashSecretKey, logHttpRequest };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thirdweb-dev/service-utils",
-  "version": "0.5.0-nightly-0f027069-20230828164852",
+  "version": "0.5.0-nightly-6cf298a29-20240308012322",
   "main": "dist/thirdweb-dev-service-utils.cjs.js",
   "module": "dist/thirdweb-dev-service-utils.esm.js",
   "exports": {
@@ -46,21 +46,22 @@
     "@types/jest": "^29.5.3",
     "@types/node": "^18.17.1",
     "@typescript-eslint/eslint-plugin": "^6.2.0",
-    "@typescript-eslint/parser": "^6.2.0",
-    "eslint": "^8.45.0",
+    "@typescript-eslint/parser": "^6.19.1",
+    "eslint": "^8.56.0",
     "eslint-config-prettier": "^8.9.0",
-    "eslint-config-thirdweb": "^0.1.6",
+    "eslint-config-thirdweb": "^0.1.7",
     "jest": "^29.6.2",
-    "prettier": "^3.0.0",
-    "typescript": "^5.1.6"
+    "prettier": "^3.1.1",
+    "ts-jest": "^29.1.1",
+    "typescript": "^5.3.3"
   },
   "dependencies": {
     "aws4fetch": "^1.0.17",
-    "zod": "^3.20.2"
+    "zod": "^3.22.3"
   },
   "scripts": {
     "format": "prettier --write 'src/**/*'",
-    "lint": "eslint src/",
+    "lint": "eslint src/ && bunx publint --strict --level warning",
     "fix": "eslint src/ --fix",
     "clean": "rm -rf dist/",
     "build": "tsc && preconstruct build",