@chainpatrol/sdk 0.2.4 → 0.4.0

package/dist/index.d.ts

@@ -47,14 +47,27 @@ type ChainPatrolClientOptions = {
     apiKey: string;
     baseUrl?: string;
 };
+type ApiRequest = {
+    path: string[];
+    method: "GET" | "POST" | "PUT" | "DELETE";
+    body?: unknown;
+};
 type AssetType = "URL" | "PAGE" | "ADDRESS";
 type AssetStatus = "ALLOWED" | "BLOCKED" | "UNKNOWN";
+declare class ChainPatrolClientError extends Error {
+    readonly code: ChainPatrolClientErrorCodes;
+    constructor(message: string, code: ChainPatrolClientErrorCodes);
+}
+declare enum ChainPatrolClientErrorCodes {
+    MISSING_API_KEY = "MISSING_API_KEY",
+    API_ERROR = "API_ERROR"
+}
 declare class ChainPatrolClient {
     readonly baseUrl: string;
     private readonly apiKey;
     private readonly logger;
     constructor(options: ChainPatrolClientOptions);
-    private fetch;
+    fetch<TResult = unknown>(req: ApiRequest): Promise<TResult>;
     get asset(): {
         check: (req: AssetCheckInput) => Promise<AssetCheckOutput>;
         list: (req: AssetListInput) => Promise<AssetListOutput>;
@@ -203,4 +216,4 @@ declare namespace index {
   };
 }
 
-export { AssetStatus, AssetType, ChainPatrolClient, ChainPatrolClientOptions, DetectorAssetStatus, DomainParseError, EventData, Events, Relay, index as Storage, ThreatDetector, URLResult };
+export { AssetStatus, AssetType, ChainPatrolClient, ChainPatrolClientError, ChainPatrolClientErrorCodes, ChainPatrolClientOptions, DetectorAssetStatus, DomainParseError, EventData, Events, Relay, index as Storage, ThreatDetector, URLResult };

package/dist/index.js

@@ -473,50 +473,13 @@ zod.z.object({
   description: zod.z.string().optional(),
   assetGroupId: zod.z.number().optional()
 });
-
-// ../../internal/database/prisma/enums/index.ts
-var AssetType = {
-  URL: "URL",
-  PAGE: "PAGE",
-  ADDRESS: "ADDRESS",
-  DISCORD: "DISCORD",
-  LINKEDIN: "LINKEDIN",
-  TWITTER: "TWITTER",
-  FACEBOOK: "FACEBOOK",
-  YOUTUBE: "YOUTUBE",
-  REDDIT: "REDDIT",
-  TELEGRAM: "TELEGRAM"
-};
-var AssetStatus = {
-  UNKNOWN: "UNKNOWN",
-  ALLOWED: "ALLOWED",
-  BLOCKED: "BLOCKED"
-};
-
-// ../../internal/validation/src/public/asset/check.ts
-var assetCheckInputSchema = zod.z.object({
-  /** Asset content. Could be a domain, URL, or crypto address. */
-  content: zod.z.string().describe("Asset content")
-}).describe("Check asset request body");
 zod.z.object({
-  /**
-   * - `ALLOWED` - the asset is on the allowlist
-   * - `BLOCKED` - the asset is on the blocklist
-   * - `UNKNOWN` - the asset's status is not known
-   */
-  status: zod.z.nativeEnum(AssetStatus).describe("The result of the asset status check"),
-  /**
-   * Optional reason for the asset's status.
-   * If the asset is allowed or blocked, this will be the reason why.
-   * ChainPatrol aggregates data from multiple sources, so this will
-   * tell you which source blocked or allowed the asset.
-   */
-  reason: zod.z.string().optional().describe(`The reason for the result. If the result is \`BLOCKED\` this will be either
-\`report\` if it was reported on ChainPatrol or \`eth-phishing-detect\` if it was
-reported on the eth-phishing-detect list.`)
-}).describe("Check asset response body");
+  content: zod.z.string().min(1, { message: "Content must be at least 3 character" }).max(1e3, { message: "Content must be less than 1000 characters" }),
+  email: zod.z.string().email(),
+  description: zod.z.string().optional().default("")
+});
 
-// ../../node_modules/luxon/src/errors.js
+// ../../internal/validation/node_modules/luxon/src/errors.js
 var LuxonError = class extends Error {
 };
 var InvalidDateTimeError = class extends LuxonError {
@@ -549,7 +512,7 @@ var ZoneIsAbstractError = class extends LuxonError {
   }
 };
 
-// ../../node_modules/luxon/src/impl/formats.js
+// ../../internal/validation/node_modules/luxon/src/impl/formats.js
 var n = "numeric";
 var s = "short";
 var l = "long";
@@ -701,7 +664,7 @@ var DATETIME_HUGE_WITH_SECONDS = {
   timeZoneName: l
 };
 
-// ../../node_modules/luxon/src/impl/util.js
+// ../../internal/validation/node_modules/luxon/src/impl/util.js
 function isUndefined(o) {
   return typeof o === "undefined";
 }
@@ -893,7 +856,7 @@ function timeObject(obj) {
 }
 var ianaRegex = /[A-Za-z_+-]{1,256}(?::?\/[A-Za-z0-9_+-]{1,256}(?:\/[A-Za-z0-9_+-]{1,256})?)?/;
 
-// ../../node_modules/luxon/src/impl/english.js
+// ../../internal/validation/node_modules/luxon/src/impl/english.js
 var monthsLong = [
   "January",
   "February",
@@ -1019,7 +982,7 @@ function formatRelativeTime(unit, count, numeric = "always", narrow = false) {
   return isInPast ? `${fmtValue} ${fmtUnit} ago` : `in ${fmtValue} ${fmtUnit}`;
 }
 
-// ../../node_modules/luxon/src/impl/formatter.js
+// ../../internal/validation/node_modules/luxon/src/impl/formatter.js
 function stringifyTokens(splits, tokenToString) {
   let s2 = "";
   for (const token of splits) {
@@ -1297,7 +1260,7 @@ var Formatter = class _Formatter {
   }
 };
 
-// ../../node_modules/luxon/src/impl/invalid.js
+// ../../internal/validation/node_modules/luxon/src/impl/invalid.js
 var Invalid = class {
   constructor(reason, explanation) {
     this.reason = reason;
@@ -1312,7 +1275,7 @@ var Invalid = class {
   }
 };
 
-// ../../node_modules/luxon/src/zone.js
+// ../../internal/validation/node_modules/luxon/src/zone.js
 var Zone = class {
   /**
    * The type of zone
@@ -1392,7 +1355,7 @@ var Zone = class {
   }
 };
 
-// ../../node_modules/luxon/src/zones/systemZone.js
+// ../../internal/validation/node_modules/luxon/src/zones/systemZone.js
 var singleton = null;
 var SystemZone = class _SystemZone extends Zone {
   /**
@@ -1439,7 +1402,7 @@ var SystemZone = class _SystemZone extends Zone {
   }
 };
 
-// ../../node_modules/luxon/src/zones/IANAZone.js
+// ../../internal/validation/node_modules/luxon/src/zones/IANAZone.js
 var dtfCache = {};
 function makeDTF(zone) {
   if (!dtfCache[zone]) {
@@ -1594,7 +1557,7 @@ var IANAZone = class _IANAZone extends Zone {
   }
 };
 
-// ../../node_modules/luxon/src/zones/fixedOffsetZone.js
+// ../../internal/validation/node_modules/luxon/src/zones/fixedOffsetZone.js
 var singleton2 = null;
 var FixedOffsetZone = class _FixedOffsetZone extends Zone {
   /**
@@ -1677,7 +1640,7 @@ var FixedOffsetZone = class _FixedOffsetZone extends Zone {
   }
 };
 
-// ../../node_modules/luxon/src/zones/invalidZone.js
+// ../../internal/validation/node_modules/luxon/src/zones/invalidZone.js
 var InvalidZone = class extends Zone {
   constructor(zoneName) {
     super();
@@ -1717,7 +1680,7 @@ var InvalidZone = class extends Zone {
   }
 };
 
-// ../../node_modules/luxon/src/impl/zoneUtil.js
+// ../../internal/validation/node_modules/luxon/src/impl/zoneUtil.js
 function normalizeZone(input, defaultZone2) {
   if (isUndefined(input) || input === null) {
     return defaultZone2;
@@ -1742,7 +1705,7 @@ function normalizeZone(input, defaultZone2) {
   }
 }
 
-// ../../node_modules/luxon/src/settings.js
+// ../../internal/validation/node_modules/luxon/src/settings.js
 var now = () => Date.now();
 var defaultZone = "system";
 var defaultLocale = null;
@@ -1849,7 +1812,7 @@ var Settings = class {
   }
 };
 
-// ../../node_modules/luxon/src/impl/locale.js
+// ../../internal/validation/node_modules/luxon/src/impl/locale.js
 var intlLFCache = {};
 function getCachedLF(locString, opts = {}) {
   const key = JSON.stringify([locString, opts]);
@@ -1988,15 +1951,15 @@ var PolyNumberFormatter = class {
 var PolyDateFormatter = class {
   constructor(dt, intl, opts) {
     this.opts = opts;
-    let z6;
+    let z9;
     if (dt.zone.isUniversal) {
       const gmtOffset = -1 * (dt.offset / 60);
       const offsetZ = gmtOffset >= 0 ? `Etc/GMT+${gmtOffset}` : `Etc/GMT${gmtOffset}`;
       if (dt.offset !== 0 && IANAZone.create(offsetZ).valid) {
-        z6 = offsetZ;
+        z9 = offsetZ;
         this.dt = dt;
       } else {
-        z6 = "UTC";
+        z9 = "UTC";
         if (opts.timeZoneName) {
           this.dt = dt;
         } else {
@@ -2007,11 +1970,11 @@ var PolyDateFormatter = class {
       this.dt = dt;
     } else {
       this.dt = dt;
-      z6 = dt.zone.name;
+      z9 = dt.zone.name;
     }
     const intlOpts = __spreadValues({}, this.opts);
-    if (z6) {
-      intlOpts.timeZone = z6;
+    if (z9) {
+      intlOpts.timeZone = z9;
     }
     this.dtf = getCachedDTF(intl, intlOpts);
   }
@@ -2181,7 +2144,7 @@ var Locale = class _Locale {
   }
 };
 
-// ../../node_modules/luxon/src/impl/regexParser.js
+// ../../internal/validation/node_modules/luxon/src/impl/regexParser.js
 function combineRegexes(...regexes) {
   const full = regexes.reduce((f, r) => f + r.source, "");
   return RegExp(`^${full}$`);
@@ -2416,7 +2379,7 @@ function parseSQL(s2) {
   );
 }
 
-// ../../node_modules/luxon/src/duration.js
+// ../../internal/validation/node_modules/luxon/src/duration.js
 var INVALID = "Invalid Duration";
 var lowOrderMatrix = {
   weeks: {
@@ -3211,7 +3174,7 @@ var Duration = class _Duration {
   }
 };
 
-// ../../node_modules/luxon/src/interval.js
+// ../../internal/validation/node_modules/luxon/src/interval.js
 var INVALID2 = "Invalid Interval";
 function validateStartEnd(start, end) {
   if (!start || !start.isValid) {
@@ -3724,7 +3687,7 @@ var Interval = class _Interval {
   }
 };
 
-// ../../node_modules/luxon/src/info.js
+// ../../internal/validation/node_modules/luxon/src/info.js
 var Info = class {
   /**
    * Return whether the specified zone contains a DST.
@@ -3865,7 +3828,7 @@ var Info = class {
   }
 };
 
-// ../../node_modules/luxon/src/impl/diff.js
+// ../../internal/validation/node_modules/luxon/src/impl/diff.js
 function dayDiff(earlier, later) {
   const utcDayStart = (dt) => dt.toUTC(0, { keepLocalTime: true }).startOf("day").valueOf(), ms = utcDayStart(later) - utcDayStart(earlier);
   return Math.floor(Duration.fromMillis(ms).as("days"));
@@ -3924,7 +3887,7 @@ function diff_default(earlier, later, units, opts) {
   }
 }
 
-// ../../node_modules/luxon/src/impl/digits.js
+// ../../internal/validation/node_modules/luxon/src/impl/digits.js
 var numberingSystems = {
   arab: "[\u0660-\u0669]",
   arabext: "[\u06F0-\u06F9]",
@@ -3996,7 +3959,7 @@ function digitRegex({ numberingSystem }, append = "") {
   return new RegExp(`${numberingSystems[numberingSystem || "latn"]}${append}`);
 }
 
-// ../../node_modules/luxon/src/impl/tokenParser.js
+// ../../internal/validation/node_modules/luxon/src/impl/tokenParser.js
 var MISSING_FTP = "missing Intl.DateTimeFormat.formatToParts support";
 function intUnit(regex, post = (i) => i) {
   return { regex, deser: ([s2]) => post(parseDigits(s2)) };
@@ -4341,7 +4304,7 @@ function formatOptsToTokens(formatOpts, locale) {
   return parts.map((p) => tokenForPart(p, locale, formatOpts));
 }
 
-// ../../node_modules/luxon/src/impl/conversions.js
+// ../../internal/validation/node_modules/luxon/src/impl/conversions.js
 var nonLeapLadder = [0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334];
 var leapLadder = [0, 31, 60, 91, 121, 152, 182, 213, 244, 274, 305, 335];
 function unitOutOfRange(unit, value) {
@@ -4450,7 +4413,7 @@ function hasInvalidTimeData(obj) {
     return false;
 }
 
-// ../../node_modules/luxon/src/datetime.js
+// ../../internal/validation/node_modules/luxon/src/datetime.js
 var INVALID3 = "Invalid DateTime";
 var MAX_DATE = 864e13;
 function unsupportedZone(zone) {
@@ -6259,6 +6222,124 @@ function friendlyDateTime(dateTimeish) {
     );
   }
 }
+
+// ../../internal/database/prisma/enums/index.ts
+var AssetType = {
+  URL: "URL",
+  PAGE: "PAGE",
+  ADDRESS: "ADDRESS",
+  DISCORD: "DISCORD",
+  LINKEDIN: "LINKEDIN",
+  TWITTER: "TWITTER",
+  FACEBOOK: "FACEBOOK",
+  YOUTUBE: "YOUTUBE",
+  REDDIT: "REDDIT",
+  TELEGRAM: "TELEGRAM",
+  GOOGLE_APP_STORE: "GOOGLE_APP_STORE",
+  APPLE_APP_STORE: "APPLE_APP_STORE",
+  AMAZON_APP_STORE: "AMAZON_APP_STORE",
+  MICROSOFT_APP_STORE: "MICROSOFT_APP_STORE",
+  TIKTOK: "TIKTOK",
+  INSTAGRAM: "INSTAGRAM",
+  THREADS: "THREADS",
+  MEDIUM: "MEDIUM",
+  CHROME_WEB_STORE: "CHROME_WEB_STORE",
+  MOZILLA_ADDONS: "MOZILLA_ADDONS",
+  OPERA_ADDONS: "OPERA_ADDONS",
+  EMAIL: "EMAIL",
+  PATREON: "PATREON",
+  OPENSEA: "OPENSEA",
+  FARCASTER: "FARCASTER"
+};
+var AssetStatus = {
+  UNKNOWN: "UNKNOWN",
+  ALLOWED: "ALLOWED",
+  BLOCKED: "BLOCKED"
+};
+
+// ../../internal/validation/src/public/asset/changelog.ts
+zod.z.object({
+  /** The type of asset to retrieve. */
+  type: zod.z.nativeEnum(AssetType).optional().describe("Asset type"),
+  /** The content of the asset to retrieve. */
+  content: zod.z.string().optional().describe("Asset content"),
+  /** Optional filter determening from which status asset was updated. */
+  fromStatus: zod.z.nativeEnum(AssetStatus).optional().describe("Status of the changed assets to retrieve"),
+  /** Optional filter determening to which status asset was updated. */
+  toStatus: zod.z.nativeEnum(AssetStatus).optional().describe("Status of the changed assets to retrieve"),
+  /**
+   * Optional start date for listing assets; should be in `YYYY-MM-DD` format and is inclusive.
+   * Transformed into JavaScript Date objects from strings.
+   * If the startDate is after the endDate, a validation error will occur.
+   */
+  startDate: zod.z.string().transform((str) => new Date(str)).optional().describe(
+    "The start date to list items from. This should be in the format `YYYY-MM-DD` and is inclusive."
+  ),
+  /**
+   * Optional end date for listing assets; should be in `YYYY-MM-DD` format and is inclusive.
+   * Defaults to the current date if not provided.
+   * Transformed into JavaScript Date objects from strings.
+   * If the startDate is after the endDate, a validation error will occur.
+   */
+  endDate: zod.z.string().transform((str) => new Date(str)).optional().describe(
+    "The end date to list items from. This should be in the format `YYYY-MM-DD` and is inclusive."
+  )
+}).describe(
+  `List asset request body
+
+Defaults to getting all the updates in the last 1 day.
+
+You can also choose a \`startDate\` and \`endDate\` for the range of asset updates, most 
+timestamp formats should work, we use [Luxon](https://moment.github.io/luxon/#/parsing) 
+for parsing the dates.`
+).transform((data) => {
+  if (data.startDate && !data.endDate) {
+    data.endDate = DateTime.now().toJSDate();
+  }
+  return data;
+}).refine((data) => {
+  if (data.startDate && data.endDate && data.startDate > data.endDate) {
+    return {
+      path: ["startDate"],
+      message: "startDate must be before endDate"
+    };
+  }
+  return true;
+});
+zod.z.object({
+  /** An array of asset change with their content, type, status, and update timestamp. */
+  changelog: zod.z.array(
+    zod.z.object({
+      assetId: zod.z.number().describe("Asset ID"),
+      type: zod.z.nativeEnum(AssetType).describe("Asset type"),
+      content: zod.z.string().describe("Asset content"),
+      fromStatus: zod.z.nativeEnum(AssetStatus).describe("The result of the asset status check"),
+      toStatus: zod.z.nativeEnum(AssetStatus).describe("Status to which asset was updated at `updatedAt`"),
+      updatedAt: zod.z.date()
+    })
+  )
+}).describe("Successful operation");
+var assetCheckInputSchema = zod.z.object({
+  /** Asset content. Could be a domain, URL, or crypto address. */
+  content: zod.z.string().describe("Asset content")
+}).describe("Check asset request body");
+zod.z.object({
+  /**
+   * - `ALLOWED` - the asset is on the allowlist
+   * - `BLOCKED` - the asset is on the blocklist
+   * - `UNKNOWN` - the asset's status is not known
+   */
+  status: zod.z.nativeEnum(AssetStatus).describe("The result of the asset status check"),
+  /**
+   * Optional reason for the asset's status.
+   * If the asset is allowed or blocked, this will be the reason why.
+   * ChainPatrol aggregates data from multiple sources, so this will
+   * tell you which source blocked or allowed the asset.
+   */
+  reason: zod.z.string().optional().describe(`The reason for the result. If the result is \`BLOCKED\` this will be either
+\`report\` if it was reported on ChainPatrol or \`eth-phishing-detect\` if it was
+reported on the eth-phishing-detect list.`)
+}).describe("Check asset response body");
 var assetListInputSchema = zod.z.object({
   /** The type of asset to retrieve. */
   type: zod.z.nativeEnum(AssetType).describe("Asset type"),
@@ -6377,20 +6458,43 @@ zod.z.object({
     name: zod.z.string().describe("Name of the organization")
   }).nullable().describe("Organization the report was created for")
 });
+zod.z.object({
+  token: zod.z.string(),
+  memo: zod.z.string(),
+  additional_data: zod.z.object({
+    location: zod.z.string()
+  })
+});
+zod.z.object({
+  result: zod.z.string()
+});
 
 // src/client.ts
 function trimTrailingSlashes(url) {
   return url.replace(/\/+$/, "");
 }
+var ChainPatrolClientError = class extends Error {
+  constructor(message, code) {
+    super(message);
+    this.code = code;
+  }
+};
+var ChainPatrolClientErrorCodes = /* @__PURE__ */ ((ChainPatrolClientErrorCodes2) => {
+  ChainPatrolClientErrorCodes2["MISSING_API_KEY"] = "MISSING_API_KEY";
+  ChainPatrolClientErrorCodes2["API_ERROR"] = "API_ERROR";
+  return ChainPatrolClientErrorCodes2;
+})(ChainPatrolClientErrorCodes || {});
 var ChainPatrolClient = class {
   constructor(options) {
-    this.logger = new Logger({ component: "ChainPatrolClient" });
     var _a;
-    console.log("CREATING CLIENT");
-    this.baseUrl = (_a = options.baseUrl) != null ? _a : "https://app.chainpatrol.io/api/";
     if (!options.apiKey) {
-      throw new Error("ChainPatrol API key is required");
+      throw new ChainPatrolClientError(
+        "Missing API key",
+        "MISSING_API_KEY" /* MISSING_API_KEY */
+      );
     }
+    this.baseUrl = (_a = options.baseUrl) != null ? _a : "https://app.chainpatrol.io/api/";
+    this.logger = new Logger({ component: "ChainPatrolClient" });
     this.apiKey = options.apiKey;
   }
   fetch(req) {
@@ -6398,7 +6502,6 @@ var ChainPatrolClient = class {
       const url = `${trimTrailingSlashes(this.baseUrl)}/${req.path.join("/")}`;
       this.logger.debug("fetch", { url, req });
       const bodyString = JSON.stringify(req.body);
-      console.log("request body", bodyString);
       const res = yield fetch(url, {
         method: req.method,
         headers: {
@@ -6408,7 +6511,9 @@ var ChainPatrolClient = class {
         body: bodyString
       });
       if (!res.ok) {
-        throw new Error(yield res.text());
+        const text = yield res.text();
+        this.logger.error("fetch", { url, req, res: { status: res.status, text } });
+        throw new ChainPatrolClientError(text, "API_ERROR" /* API_ERROR */);
       }
       return res.json();
     });
@@ -6855,6 +6960,8 @@ _ThreatDetector.Schema = zod.z.object({
 var ThreatDetector = _ThreatDetector;
 
 exports.ChainPatrolClient = ChainPatrolClient;
+exports.ChainPatrolClientError = ChainPatrolClientError;
+exports.ChainPatrolClientErrorCodes = ChainPatrolClientErrorCodes;
 exports.DomainParseError = DomainParseError;
 exports.Events = Events;
 exports.Relay = Relay;