@thirdweb-dev/service-utils 0.2.5 → 0.3.0-nightly-d01e6396-20230802191417

package/README.md

@@ -1 +1,7 @@
-### todo
+# Service Utils
+
+This repository contains utilities that handle common requirements for thirdweb services.
+
+- `/cf-worker`: for use only in Cloudflare Worker services
+- `/node`: for use in self-hosted services
+- `/core`: for use in any service

package/dist/declarations/src/core/usage.d.ts

@@ -0,0 +1,68 @@
+import { z } from "zod";
+import { AwsCredentialIdentity } from "@smithy/types";
+/**
+ * Types
+ */
+declare const usageEventSchema: z.ZodObject<{
+    source: z.ZodEnum<["wallet", "rpc", "storage", "bundler", "paymaster", "relayer"]>;
+    action: z.ZodString;
+    accountId: z.ZodString;
+    apiKeyId: z.ZodOptional<z.ZodString>;
+    creatorWalletAddress: z.ZodOptional<z.ZodString>;
+    clientId: z.ZodOptional<z.ZodString>;
+    walletAddress: z.ZodOptional<z.ZodString>;
+    chainId: z.ZodOptional<z.ZodNumber>;
+    provider: z.ZodOptional<z.ZodString>;
+    mimeType: z.ZodOptional<z.ZodString>;
+    fileSize: z.ZodOptional<z.ZodNumber>;
+    fileCid: z.ZodOptional<z.ZodString>;
+    transactionHash: z.ZodOptional<z.ZodString>;
+    gasLimit: z.ZodOptional<z.ZodNumber>;
+    gasPricePerUnit: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    source: "storage" | "rpc" | "bundler" | "relayer" | "wallet" | "paymaster";
+    action: string;
+    accountId: string;
+    apiKeyId?: string | undefined;
+    creatorWalletAddress?: string | undefined;
+    clientId?: string | undefined;
+    walletAddress?: string | undefined;
+    chainId?: number | undefined;
+    provider?: string | undefined;
+    mimeType?: string | undefined;
+    fileSize?: number | undefined;
+    fileCid?: string | undefined;
+    transactionHash?: string | undefined;
+    gasLimit?: number | undefined;
+    gasPricePerUnit?: number | undefined;
+}, {
+    source: "storage" | "rpc" | "bundler" | "relayer" | "wallet" | "paymaster";
+    action: string;
+    accountId: string;
+    apiKeyId?: string | undefined;
+    creatorWalletAddress?: string | undefined;
+    clientId?: string | undefined;
+    walletAddress?: string | undefined;
+    chainId?: number | undefined;
+    provider?: string | undefined;
+    mimeType?: string | undefined;
+    fileSize?: number | undefined;
+    fileCid?: string | undefined;
+    transactionHash?: string | undefined;
+    gasLimit?: number | undefined;
+    gasPricePerUnit?: number | undefined;
+}>;
+export type UsageEvent = z.infer<typeof usageEventSchema>;
+/**
+ * Publish usage events. Provide the relevant fields for your application.
+ *
+ * @param usageEvents
+ * @param config
+ */
+export declare function publishUsageEvents(usageEvents: UsageEvent[], config: {
+    queueUrl: string;
+    region?: string;
+    credentials?: AwsCredentialIdentity;
+}): Promise<void>;
+export {};
+//# sourceMappingURL=usage.d.ts.map

package/dist/declarations/src/core/usage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"usage.d.ts","sourceRoot":"../../../../src/core","sources":["usage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAMxB,OAAO,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC;AAkBtD;;GAEG;AACH,QAAA,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAyBpB,CAAC;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAE1D;;;;;GAKG;AACH,wBAAsB,kBAAkB,CACtC,WAAW,EAAE,UAAU,EAAE,EACzB,MAAM,EAAE;IACN,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,qBAAqB,CAAC;CACrC,GACA,OAAO,CAAC,IAAI,CAAC,CAaf"}

package/dist/declarations/src/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./core/services";
+export * from "./core/usage";
 //# sourceMappingURL=index.d.ts.map

package/dist/declarations/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"../../../src","sources":["index.ts"],"names":[],"mappings":"AACA,cAAc,iBAAiB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"../../../src","sources":["index.ts"],"names":[],"mappings":"AACA,cAAc,iBAAiB,CAAC;AAGhC,cAAc,cAAc,CAAC"}

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

@@ -3,10 +3,74 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var services = require('./services-a3f36057.cjs.dev.js');
+var zod = require('zod');
+var clientSqs = require('@aws-sdk/client-sqs');
+var crypto = require('crypto');
 
+let sqs;
+function getSqs(_ref) {
+  let {
+    region,
+    credentials
+  } = _ref;
+  if (!sqs) {
+    sqs = new clientSqs.SQSClient({
+      region,
+      credentials
+    });
+  }
+  return sqs;
+}
 
+/**
+ * Types
+ */
+const usageEventSchema = zod.z.object({
+  source: zod.z.enum(["wallet", "rpc", "storage", "bundler", "paymaster", "relayer"]),
+  action: zod.z.string(),
+  accountId: zod.z.string(),
+  // Optional
+  apiKeyId: zod.z.string().optional(),
+  creatorWalletAddress: zod.z.string().optional(),
+  clientId: zod.z.string().optional(),
+  walletAddress: zod.z.string().optional(),
+  chainId: zod.z.number().int().positive().optional(),
+  provider: zod.z.string().optional(),
+  mimeType: zod.z.string().optional(),
+  fileSize: zod.z.number().int().nonnegative().optional(),
+  fileCid: zod.z.string().optional(),
+  transactionHash: zod.z.string().optional(),
+  gasLimit: zod.z.number().nonnegative().optional(),
+  gasPricePerUnit: zod.z.number().nonnegative().optional()
+});
+/**
+ * Publish usage events. Provide the relevant fields for your application.
+ *
+ * @param usageEvents
+ * @param config
+ */
+async function publishUsageEvents(usageEvents, config) {
+  const {
+    queueUrl,
+    region = "us-west-2",
+    credentials
+  } = config;
+  const entries = usageEvents.map(event => ({
+    Id: crypto.randomUUID(),
+    MessageBody: JSON.stringify(usageEventSchema.parse(event))
+  }));
+  const input = new clientSqs.SendMessageBatchCommand({
+    QueueUrl: queueUrl,
+    Entries: entries
+  });
+  await getSqs({
+    region,
+    credentials
+  }).send(input);
+}
 
 exports.SERVICES = services.SERVICES;
 exports.SERVICE_DEFINITIONS = services.SERVICE_DEFINITIONS;
 exports.SERVICE_NAMES = services.SERVICE_NAMES;
 exports.getServiceByName = services.getServiceByName;
+exports.publishUsageEvents = publishUsageEvents;

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

@@ -3,10 +3,74 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var services = require('./services-9e185105.cjs.prod.js');
+var zod = require('zod');
+var clientSqs = require('@aws-sdk/client-sqs');
+var crypto = require('crypto');
 
+let sqs;
+function getSqs(_ref) {
+  let {
+    region,
+    credentials
+  } = _ref;
+  if (!sqs) {
+    sqs = new clientSqs.SQSClient({
+      region,
+      credentials
+    });
+  }
+  return sqs;
+}
 
+/**
+ * Types
+ */
+const usageEventSchema = zod.z.object({
+  source: zod.z.enum(["wallet", "rpc", "storage", "bundler", "paymaster", "relayer"]),
+  action: zod.z.string(),
+  accountId: zod.z.string(),
+  // Optional
+  apiKeyId: zod.z.string().optional(),
+  creatorWalletAddress: zod.z.string().optional(),
+  clientId: zod.z.string().optional(),
+  walletAddress: zod.z.string().optional(),
+  chainId: zod.z.number().int().positive().optional(),
+  provider: zod.z.string().optional(),
+  mimeType: zod.z.string().optional(),
+  fileSize: zod.z.number().int().nonnegative().optional(),
+  fileCid: zod.z.string().optional(),
+  transactionHash: zod.z.string().optional(),
+  gasLimit: zod.z.number().nonnegative().optional(),
+  gasPricePerUnit: zod.z.number().nonnegative().optional()
+});
+/**
+ * Publish usage events. Provide the relevant fields for your application.
+ *
+ * @param usageEvents
+ * @param config
+ */
+async function publishUsageEvents(usageEvents, config) {
+  const {
+    queueUrl,
+    region = "us-west-2",
+    credentials
+  } = config;
+  const entries = usageEvents.map(event => ({
+    Id: crypto.randomUUID(),
+    MessageBody: JSON.stringify(usageEventSchema.parse(event))
+  }));
+  const input = new clientSqs.SendMessageBatchCommand({
+    QueueUrl: queueUrl,
+    Entries: entries
+  });
+  await getSqs({
+    region,
+    credentials
+  }).send(input);
+}
 
 exports.SERVICES = services.SERVICES;
 exports.SERVICE_DEFINITIONS = services.SERVICE_DEFINITIONS;
 exports.SERVICE_NAMES = services.SERVICE_NAMES;
 exports.getServiceByName = services.getServiceByName;
+exports.publishUsageEvents = publishUsageEvents;

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

@@ -1 +1,68 @@
 export { b as SERVICES, S as SERVICE_DEFINITIONS, a as SERVICE_NAMES, g as getServiceByName } from './services-86283509.esm.js';
+import { z } from 'zod';
+import { SendMessageBatchCommand, SQSClient } from '@aws-sdk/client-sqs';
+import { randomUUID } from 'crypto';
+
+let sqs;
+function getSqs(_ref) {
+  let {
+    region,
+    credentials
+  } = _ref;
+  if (!sqs) {
+    sqs = new SQSClient({
+      region,
+      credentials
+    });
+  }
+  return sqs;
+}
+
+/**
+ * Types
+ */
+const usageEventSchema = z.object({
+  source: z.enum(["wallet", "rpc", "storage", "bundler", "paymaster", "relayer"]),
+  action: z.string(),
+  accountId: z.string(),
+  // Optional
+  apiKeyId: z.string().optional(),
+  creatorWalletAddress: z.string().optional(),
+  clientId: z.string().optional(),
+  walletAddress: z.string().optional(),
+  chainId: z.number().int().positive().optional(),
+  provider: z.string().optional(),
+  mimeType: z.string().optional(),
+  fileSize: z.number().int().nonnegative().optional(),
+  fileCid: z.string().optional(),
+  transactionHash: z.string().optional(),
+  gasLimit: z.number().nonnegative().optional(),
+  gasPricePerUnit: z.number().nonnegative().optional()
+});
+/**
+ * Publish usage events. Provide the relevant fields for your application.
+ *
+ * @param usageEvents
+ * @param config
+ */
+async function publishUsageEvents(usageEvents, config) {
+  const {
+    queueUrl,
+    region = "us-west-2",
+    credentials
+  } = config;
+  const entries = usageEvents.map(event => ({
+    Id: randomUUID(),
+    MessageBody: JSON.stringify(usageEventSchema.parse(event))
+  }));
+  const input = new SendMessageBatchCommand({
+    QueueUrl: queueUrl,
+    Entries: entries
+  });
+  await getSqs({
+    region,
+    credentials
+  }).send(input);
+}
+
+export { publishUsageEvents };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thirdweb-dev/service-utils",
-  "version": "0.2.5",
+  "version": "0.3.0-nightly-d01e6396-20230802191417",
   "main": "dist/thirdweb-dev-service-utils.cjs.js",
   "module": "dist/thirdweb-dev-service-utils.esm.js",
   "exports": {
@@ -41,6 +41,7 @@
   "devDependencies": {
     "@cloudflare/workers-types": "^4.20230724.0",
     "@preconstruct/cli": "2.7.0",
+    "@smithy/types": "^2.0.2",
     "@thirdweb-dev/tsconfig": "^0.1.7",
     "@types/jest": "^29.5.3",
     "@types/node": "^18.17.1",
@@ -53,6 +54,10 @@
     "prettier": "^3.0.0",
     "typescript": "^5.1.6"
   },
+  "dependencies": {
+    "@aws-sdk/client-sqs": "^3.379.1",
+    "zod": "^3.20.2"
+  },
   "scripts": {
     "format": "prettier --write 'src/**/*'",
     "lint": "eslint src/",