@pythnetwork/hermes-client 2.0.0 → 2.1.0

package/{lib/zodSchemas.js → dist/esm/zodSchemas.mjs}

@@ -1,85 +1,75 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.api = exports.schemas = void 0;
-exports.createApiClient = createApiClient;
-const core_1 = require("@zodios/core");
-const zod_1 = require("zod");
-const AssetType = zod_1.z.enum([
+import { makeApi, Zodios } from "@zodios/core";
+import { z } from "zod";
+const AssetType = z.enum([
     "crypto",
     "fx",
     "equity",
     "metal",
     "rates",
     "crypto_redemption_rate",
+    "commodities",
+    "crypto_index",
+    "crypto_nav"
 ]);
 const asset_type = AssetType.nullish();
-const RpcPriceIdentifier = zod_1.z.string();
-const PriceFeedMetadata = zod_1.z
-    .object({ attributes: zod_1.z.record(zod_1.z.string()), id: RpcPriceIdentifier })
-    .passthrough();
-const PriceIdInput = zod_1.z.string();
-const EncodingType = zod_1.z.enum(["hex", "base64"]);
-const BinaryUpdate = zod_1.z
-    .object({ data: zod_1.z.array(zod_1.z.string()), encoding: EncodingType })
-    .passthrough();
-const RpcPrice = zod_1.z
-    .object({
-    conf: zod_1.z.string(),
-    expo: zod_1.z.number().int(),
-    price: zod_1.z.string(),
-    publish_time: zod_1.z.number().int(),
-})
-    .passthrough();
-const RpcPriceFeedMetadataV2 = zod_1.z
-    .object({
-    prev_publish_time: zod_1.z.number().int().nullable(),
-    proof_available_time: zod_1.z.number().int().nullable(),
-    slot: zod_1.z.number().int().gte(0).nullable(),
-})
-    .partial()
-    .passthrough();
-const ParsedPriceUpdate = zod_1.z
-    .object({
+const RpcPriceIdentifier = z.string();
+const PriceFeedMetadata = z.object({
+    attributes: z.record(z.string()),
+    id: RpcPriceIdentifier
+}).passthrough();
+const PriceIdInput = z.string();
+const EncodingType = z.enum([
+    "hex",
+    "base64"
+]);
+const BinaryUpdate = z.object({
+    data: z.array(z.string()),
+    encoding: EncodingType
+}).passthrough();
+const RpcPrice = z.object({
+    conf: z.string(),
+    expo: z.number().int(),
+    price: z.string(),
+    publish_time: z.number().int()
+}).passthrough();
+const RpcPriceFeedMetadataV2 = z.object({
+    prev_publish_time: z.number().int().nullable(),
+    proof_available_time: z.number().int().nullable(),
+    slot: z.number().int().gte(0).nullable()
+}).partial().passthrough();
+const ParsedPriceUpdate = z.object({
     ema_price: RpcPrice,
     id: RpcPriceIdentifier,
     metadata: RpcPriceFeedMetadataV2,
-    price: RpcPrice,
-})
-    .passthrough();
-const PriceUpdate = zod_1.z
-    .object({
+    price: RpcPrice
+}).passthrough();
+const PriceUpdate = z.object({
     binary: BinaryUpdate,
-    parsed: zod_1.z.array(ParsedPriceUpdate).nullish(),
-})
-    .passthrough();
-const ParsedPublisherStakeCap = zod_1.z
-    .object({ cap: zod_1.z.number().int().gte(0), publisher: zod_1.z.string() })
-    .passthrough();
-const ParsedPublisherStakeCapsUpdate = zod_1.z
-    .object({ publisher_stake_caps: zod_1.z.array(ParsedPublisherStakeCap) })
-    .passthrough();
-const LatestPublisherStakeCapsUpdateDataResponse = zod_1.z
-    .object({
+    parsed: z.array(ParsedPriceUpdate).nullish()
+}).passthrough();
+const ParsedPublisherStakeCap = z.object({
+    cap: z.number().int().gte(0),
+    publisher: z.string()
+}).passthrough();
+const ParsedPublisherStakeCapsUpdate = z.object({
+    publisher_stake_caps: z.array(ParsedPublisherStakeCap)
+}).passthrough();
+const LatestPublisherStakeCapsUpdateDataResponse = z.object({
     binary: BinaryUpdate,
-    parsed: zod_1.z.array(ParsedPublisherStakeCapsUpdate).nullish(),
-})
-    .passthrough();
-const ParsedPriceFeedTwap = zod_1.z
-    .object({
-    down_slots_ratio: zod_1.z.string(),
-    end_timestamp: zod_1.z.number().int(),
+    parsed: z.array(ParsedPublisherStakeCapsUpdate).nullish()
+}).passthrough();
+const ParsedPriceFeedTwap = z.object({
+    down_slots_ratio: z.string(),
+    end_timestamp: z.number().int(),
     id: RpcPriceIdentifier,
-    start_timestamp: zod_1.z.number().int(),
-    twap: RpcPrice,
-})
-    .passthrough();
-const TwapsResponse = zod_1.z
-    .object({
+    start_timestamp: z.number().int(),
+    twap: RpcPrice
+}).passthrough();
+const TwapsResponse = z.object({
     binary: BinaryUpdate,
-    parsed: zod_1.z.array(ParsedPriceFeedTwap).nullish(),
-})
-    .passthrough();
-exports.schemas = {
+    parsed: z.array(ParsedPriceFeedTwap).nullish()
+}).passthrough();
+export const schemas = {
     AssetType,
     asset_type,
     RpcPriceIdentifier,
@@ -95,9 +85,9 @@ exports.schemas = {
     ParsedPublisherStakeCapsUpdate,
     LatestPublisherStakeCapsUpdateDataResponse,
     ParsedPriceFeedTwap,
-    TwapsResponse,
+    TwapsResponse
 };
-const endpoints = (0, core_1.makeApi)([
+const endpoints = makeApi([
     {
         method: "get",
         path: "/v2/price_feeds",
@@ -111,15 +101,15 @@ and query string.`,
             {
                 name: "query",
                 type: "Query",
-                schema: zod_1.z.string().nullish(),
+                schema: z.string().nullish()
             },
             {
                 name: "asset_type",
                 type: "Query",
-                schema: asset_type,
-            },
+                schema: asset_type
+            }
         ],
-        response: zod_1.z.array(PriceFeedMetadata),
+        response: z.array(PriceFeedMetadata)
     },
     {
         method: "get",
@@ -133,37 +123,40 @@ Given a collection of price feed ids, retrieve the latest Pyth price for each pr
             {
                 name: "publish_time",
                 type: "Path",
-                schema: zod_1.z.number().int(),
+                schema: z.number().int()
             },
             {
                 name: "ids[]",
                 type: "Query",
-                schema: zod_1.z.array(PriceIdInput),
+                schema: z.array(PriceIdInput)
             },
             {
                 name: "encoding",
                 type: "Query",
-                schema: zod_1.z.enum(["hex", "base64"]).optional(),
+                schema: z.enum([
+                    "hex",
+                    "base64"
+                ]).optional()
             },
             {
                 name: "parsed",
                 type: "Query",
-                schema: zod_1.z.boolean().optional(),
+                schema: z.boolean().optional()
             },
             {
                 name: "ignore_invalid_price_ids",
                 type: "Query",
-                schema: zod_1.z.boolean().optional(),
-            },
+                schema: z.boolean().optional()
+            }
         ],
         response: PriceUpdate,
         errors: [
             {
                 status: 404,
                 description: `Price ids not found`,
-                schema: zod_1.z.void(),
-            },
-        ],
+                schema: z.void()
+            }
+        ]
     },
     {
         method: "get",
@@ -177,79 +170,88 @@ Given a collection of price feed ids, retrieve the latest Pyth price for each pr
             {
                 name: "ids[]",
                 type: "Query",
-                schema: zod_1.z.array(PriceIdInput),
+                schema: z.array(PriceIdInput)
             },
             {
                 name: "encoding",
                 type: "Query",
-                schema: zod_1.z.enum(["hex", "base64"]).optional(),
+                schema: z.enum([
+                    "hex",
+                    "base64"
+                ]).optional()
             },
             {
                 name: "parsed",
                 type: "Query",
-                schema: zod_1.z.boolean().optional(),
+                schema: z.boolean().optional()
             },
             {
                 name: "ignore_invalid_price_ids",
                 type: "Query",
-                schema: zod_1.z.boolean().optional(),
-            },
+                schema: z.boolean().optional()
+            }
         ],
         response: PriceUpdate,
         errors: [
             {
                 status: 404,
                 description: `Price ids not found`,
-                schema: zod_1.z.void(),
-            },
-        ],
+                schema: z.void()
+            }
+        ]
     },
     {
         method: "get",
         path: "/v2/updates/price/stream",
         alias: "price_stream_sse_handler",
-        description: `SSE route handler for streaming price updates.`,
+        description: `SSE route handler for streaming price updates.
+
+The connection will automatically close after 24 hours to prevent resource leaks.
+Clients should implement reconnection logic to maintain continuous price updates.`,
         requestFormat: "json",
         parameters: [
             {
                 name: "ids[]",
                 type: "Query",
-                schema: zod_1.z.array(PriceIdInput),
+                schema: z.array(PriceIdInput)
             },
             {
                 name: "encoding",
                 type: "Query",
-                schema: zod_1.z.enum(["hex", "base64"]).optional(),
+                schema: z.enum([
+                    "hex",
+                    "base64"
+                ]).optional()
             },
             {
                 name: "parsed",
                 type: "Query",
-                schema: zod_1.z.boolean().optional(),
+                schema: z.boolean().optional()
             },
             {
                 name: "allow_unordered",
                 type: "Query",
-                schema: zod_1.z.boolean().optional(),
+                schema: z.boolean().optional()
             },
             {
                 name: "benchmarks_only",
                 type: "Query",
-                schema: zod_1.z.boolean().optional(),
+                schema: z.boolean().optional()
             },
             {
                 name: "ignore_invalid_price_ids",
                 type: "Query",
-                schema: zod_1.z.boolean().optional(),
-            },
+                schema: z.boolean().optional()
+            }
         ],
         response: PriceUpdate,
         errors: [
             {
                 status: 404,
                 description: `Price ids not found`,
-                schema: zod_1.z.void(),
-            },
-        ],
+                schema: z.void()
+            }
+        ]
     },
     {
         method: "get",
@@ -261,15 +263,18 @@ Given a collection of price feed ids, retrieve the latest Pyth price for each pr
             {
                 name: "encoding",
                 type: "Query",
-                schema: zod_1.z.enum(["hex", "base64"]).optional(),
+                schema: z.enum([
+                    "hex",
+                    "base64"
+                ]).optional()
             },
             {
                 name: "parsed",
                 type: "Query",
-                schema: zod_1.z.boolean().optional(),
-            },
+                schema: z.boolean().optional()
+            }
         ],
-        response: LatestPublisherStakeCapsUpdateDataResponse,
+        response: LatestPublisherStakeCapsUpdateDataResponse
     },
     {
         method: "get",
@@ -283,40 +288,43 @@ Given a collection of price feed ids, retrieve the latest Pyth TWAP price for ea
             {
                 name: "window_seconds",
                 type: "Path",
-                schema: zod_1.z.number().int().gte(0),
+                schema: z.number().int().gte(0)
             },
             {
                 name: "ids[]",
                 type: "Query",
-                schema: zod_1.z.array(PriceIdInput),
+                schema: z.array(PriceIdInput)
             },
             {
                 name: "encoding",
                 type: "Query",
-                schema: zod_1.z.enum(["hex", "base64"]).optional(),
+                schema: z.enum([
+                    "hex",
+                    "base64"
+                ]).optional()
             },
             {
                 name: "parsed",
                 type: "Query",
-                schema: zod_1.z.boolean().optional(),
+                schema: z.boolean().optional()
             },
             {
                 name: "ignore_invalid_price_ids",
                 type: "Query",
-                schema: zod_1.z.boolean().optional(),
-            },
+                schema: z.boolean().optional()
+            }
         ],
         response: TwapsResponse,
         errors: [
             {
                 status: 404,
                 description: `Price ids not found`,
-                schema: zod_1.z.void(),
-            },
-        ],
-    },
+                schema: z.void()
+            }
+        ]
+    }
 ]);
-exports.api = new core_1.Zodios(endpoints);
-function createApiClient(baseUrl, options) {
-    return new core_1.Zodios(baseUrl, endpoints, options);
+export const api = new Zodios(endpoints);
+export function createApiClient(baseUrl, options) {
+    return new Zodios(baseUrl, endpoints, options);
 }

package/package.json

@@ -1,15 +1,13 @@
 {
   "name": "@pythnetwork/hermes-client",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Pyth Hermes Client",
   "author": {
     "name": "Pyth Data Association"
   },
   "homepage": "https://pyth.network",
-  "main": "lib/HermesClient.js",
-  "types": "lib/HermesClient.d.ts",
   "files": [
-    "lib/**/*"
+    "dist/**/*"
   ],
   "repository": {
     "type": "git",
@@ -19,34 +17,21 @@
   "publishConfig": {
     "access": "public"
   },
-  "scripts": {
-    "build:typescript": "tsc",
-    "build:schemas": "openapi-zod-client ./schema.json --output src/zodSchemas.ts",
-    "pull:schema": "curl -o schema.json -z schema.json https://hermes.pyth.network/docs/openapi.json",
-    "example": "node lib/examples/HermesClient.js",
-    "format": "prettier --write \"src/**/*.ts\"",
-    "test:lint": "eslint src/",
-    "prepublishOnly": "pnpm run build:typescript && pnpm run test:lint",
-    "preversion": "pnpm run test:lint",
-    "version": "pnpm run format && git add -A src"
-  },
   "keywords": [
     "pyth",
     "oracle"
   ],
   "license": "Apache-2.0",
   "devDependencies": {
+    "@cprussin/eslint-config": "^4.0.2",
+    "@pythnetwork/jest-config": "",
     "@types/jest": "^29.4.0",
     "@types/node": "^20.14.2",
     "@types/yargs": "^17.0.10",
-    "@typescript-eslint/eslint-plugin": "^5.21.0",
-    "@typescript-eslint/parser": "^5.21.0",
-    "eslint": "^8.14.0",
+    "eslint": "^9.23.0",
     "jest": "^29.4.0",
     "openapi-zod-client": "^1.18.1",
-    "prettier": "^2.6.2",
-    "ts-jest": "^29.0.5",
-    "typescript": "catalog:",
+    "prettier": "^3.5.3",
     "yargs": "^17.4.1"
   },
   "dependencies": {
@@ -54,5 +39,67 @@
     "eventsource": "^3.0.5",
     "zod": "^3.23.8"
   },
-  "gitHead": "a691e18cf32192d4d1a3bb393d1ead08b4012989"
-}
+  "engines": {
+    "node": ">=22.14.0"
+  },
+  "type": "module",
+  "exports": {
+    "./hermes-client": {
+      "require": {
+        "types": "./dist/cjs/hermes-client.d.ts",
+        "default": "./dist/cjs/hermes-client.cjs"
+      },
+      "import": {
+        "types": "./dist/esm/hermes-client.d.ts",
+        "default": "./dist/esm/hermes-client.mjs"
+      }
+    },
+    ".": {
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.cjs"
+      },
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.mjs"
+      }
+    },
+    "./utils": {
+      "require": {
+        "types": "./dist/cjs/utils.d.ts",
+        "default": "./dist/cjs/utils.cjs"
+      },
+      "import": {
+        "types": "./dist/esm/utils.d.ts",
+        "default": "./dist/esm/utils.mjs"
+      }
+    },
+    "./zodSchemas": {
+      "require": {
+        "types": "./dist/cjs/zodSchemas.d.ts",
+        "default": "./dist/cjs/zodSchemas.cjs"
+      },
+      "import": {
+        "types": "./dist/esm/zodSchemas.d.ts",
+        "default": "./dist/esm/zodSchemas.mjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "module": "./dist/esm/index.mjs",
+  "types": "./dist/cjs/index.d.ts",
+  "main": "./dist/cjs/index.cjs",
+  "scripts": {
+    "build": "ts-duality",
+    "build:schemas": "openapi-zod-client ./schema.json --output src/zodSchemas.ts",
+    "pull:schema": "curl -o schema.json -z schema.json https://hermes.pyth.network/docs/openapi.json",
+    "example": "node lib/examples/HermesClient.js",
+    "fix:lint": "eslint src/ --fix --max-warnings 0",
+    "fix:format": "prettier --write \"src/**/*.ts\"",
+    "test:lint": "eslint src/ --max-warnings 0",
+    "test:format": "prettier --check \"src/**/*.ts\"",
+    "preversion": "pnpm run test:lint",
+    "version": "pnpm run format && git add -A src",
+    "clean": "rm -rf ./dist"
+  }
+}

package/lib/HermesClient.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"HermesClient.d.ts","sourceRoot":"","sources":["../src/HermesClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,SAAS,CAAC,CAAC;AAC1D,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,YAAY,CAAC,CAAC;AACrE,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,YAAY,CAAC,CAAC;AAChE,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,iBAAiB,CAAC,CAAC;AAC1E,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,YAAY,CAAC,CAAC;AAChE,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,WAAW,CAAC,CAAC;AAC9D,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,aAAa,CAAC,CAAC;AAClE,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CACjC,OAAO,OAAO,CAAC,0CAA0C,CAC1D,CAAC;AAKF,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AACnC,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC;AACvC,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAC/B,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;AAElC,MAAM,MAAM,kBAAkB,GAAG;IAE/B,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,WAAW,CAAC;CACvB,CAAC;AAEF,qBAAa,YAAY;IACvB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,OAAO,CAAe;IAC9B,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,OAAO,CAAc;IAE7B;;;;;OAKG;gBACS,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB;YAO3C,WAAW;IAuCzB;;;;;;;;;;OAUG;IACG,aAAa,CAAC,EAClB,YAAY,EACZ,GAAG,OAAO,EACX,GAAE;QACD,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,SAAS,CAAC,EAAE,SAAS,CAAC;QACtB,YAAY,CAAC,EAAE,WAAW,CAAC;KACvB,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAarC;;;;;;;;;;OAUG;IACG,sBAAsB,CAAC,EAC3B,YAAY,EACZ,GAAG,OAAO,EACX,GAAE;QACD,QAAQ,CAAC,EAAE,YAAY,CAAC;QACxB,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,YAAY,CAAC,EAAE,WAAW,CAAC;KACvB,GAAG,OAAO,CAAC,aAAa,CAAC;IAY/B;;;;;;;;;;;;OAYG;IACG,qBAAqB,CACzB,GAAG,EAAE,SAAS,EAAE,EAChB,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,EAAE,YAAY,CAAC;QACxB,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,qBAAqB,CAAC,EAAE,OAAO,CAAC;KACjC,EACD,YAAY,CAAC,EAAE,WAAW,GACzB,OAAO,CAAC,WAAW,CAAC;IAcvB;;;;;;;;;;;;;OAaG;IACG,0BAA0B,CAC9B,WAAW,EAAE,aAAa,EAC1B,GAAG,EAAE,SAAS,EAAE,EAChB,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,EAAE,YAAY,CAAC;QACxB,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,qBAAqB,CAAC,EAAE,OAAO,CAAC;KACjC,EACD,YAAY,CAAC,EAAE,WAAW,GACzB,OAAO,CAAC,WAAW,CAAC;IAcvB;;;;;;;;;;;;;;;;OAgBG;IACG,qBAAqB,CACzB,GAAG,EAAE,SAAS,EAAE,EAChB,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,EAAE,YAAY,CAAC;QACxB,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,cAAc,CAAC,EAAE,OAAO,CAAC;QACzB,cAAc,CAAC,EAAE,OAAO,CAAC;QACzB,qBAAqB,CAAC,EAAE,OAAO,CAAC;KACjC,GACA,OAAO,CAAC,WAAW,CAAC;IAuBvB;;;;;;;;;;;;;;OAcG;IACG,cAAc,CAClB,GAAG,EAAE,SAAS,EAAE,EAChB,cAAc,EAAE,MAAM,EACtB,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,EAAE,YAAY,CAAC;QACxB,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,qBAAqB,CAAC,EAAE,OAAO,CAAC;KACjC,EACD,YAAY,CAAC,EAAE,WAAW,GACzB,OAAO,CAAC,aAAa,CAAC;IAkBzB,OAAO,CAAC,qBAAqB;IAW7B,OAAO,CAAC,QAAQ;CAQjB"}