oilpriceapi 0.7.0 → 0.8.2

package/dist/resources/webhooks.js

@@ -3,6 +3,8 @@
  *
  * Manage webhook endpoints for real-time event notifications.
  */
+import { ValidationError } from "../errors.js";
+import { verifyWebhookSignature } from "../index.js";
 /**
  * Webhooks Resource
  *
@@ -85,7 +87,7 @@ export class WebhooksResource {
      */
     async get(id) {
         if (!id || typeof id !== "string") {
-            throw new Error("Webhook ID must be a non-empty string");
+            throw new ValidationError("Webhook ID must be a non-empty string");
         }
         const response = await this.client["request"](`/v1/webhooks/${id}`, {});
         return "webhook" in response ? response.webhook : response;
@@ -113,24 +115,17 @@ export class WebhooksResource {
      */
     async create(params) {
         if (!params.name || typeof params.name !== "string") {
-            throw new Error("Webhook name is required");
+            throw new ValidationError("Webhook name is required");
         }
         if (!params.url || !params.url.startsWith("https://")) {
-            throw new Error("Webhook URL must use HTTPS protocol");
+            throw new ValidationError("Webhook URL must use HTTPS protocol");
         }
-        if (!params.events ||
-            !Array.isArray(params.events) ||
-            params.events.length === 0) {
-            throw new Error("At least one event type is required");
+        if (!params.events || !Array.isArray(params.events) || params.events.length === 0) {
+            throw new ValidationError("At least one event type is required");
         }
-        const url = `${this.client["baseUrl"]}/v1/webhooks`;
-        const response = await fetch(url, {
+        const response = await this.client["request"]("/v1/webhooks", {}, {
             method: "POST",
-            headers: {
-                Authorization: `Bearer ${this.client["apiKey"]}`,
-                "Content-Type": "application/json",
-            },
-            body: JSON.stringify({
+            body: {
                 webhook: {
                     name: params.name,
                     url: params.url,
@@ -139,14 +134,9 @@ export class WebhooksResource {
                     secret: params.secret,
                     metadata: params.metadata,
                 },
-            }),
+            },
         });
-        if (!response.ok) {
-            const errorText = await response.text();
-            throw new Error(`Failed to create webhook: ${response.status} ${errorText}`);
-        }
-        const data = (await response.json());
-        return "webhook" in data ? data.webhook : data;
+        return "webhook" in response ? response.webhook : response;
     }
     /**
      * Update a webhook endpoint
@@ -171,32 +161,20 @@ export class WebhooksResource {
      */
     async update(id, params) {
         if (!id || typeof id !== "string") {
-            throw new Error("Webhook ID must be a non-empty string");
+            throw new ValidationError("Webhook ID must be a non-empty string");
         }
         if (params.url !== undefined && !params.url.startsWith("https://")) {
-            throw new Error("Webhook URL must use HTTPS protocol");
+            throw new ValidationError("Webhook URL must use HTTPS protocol");
         }
         if (params.events !== undefined &&
             (!Array.isArray(params.events) || params.events.length === 0)) {
-            throw new Error("Events must be a non-empty array");
+            throw new ValidationError("Events must be a non-empty array");
         }
-        const url = `${this.client["baseUrl"]}/v1/webhooks/${id}`;
-        const response = await fetch(url, {
+        const response = await this.client["request"](`/v1/webhooks/${id}`, {}, {
             method: "PATCH",
-            headers: {
-                Authorization: `Bearer ${this.client["apiKey"]}`,
-                "Content-Type": "application/json",
-            },
-            body: JSON.stringify({
-                webhook: params,
-            }),
+            body: { webhook: params },
         });
-        if (!response.ok) {
-            const errorText = await response.text();
-            throw new Error(`Failed to update webhook: ${response.status} ${errorText}`);
-        }
-        const data = (await response.json());
-        return "webhook" in data ? data.webhook : data;
+        return "webhook" in response ? response.webhook : response;
     }
     /**
      * Delete a webhook endpoint
@@ -214,20 +192,9 @@ export class WebhooksResource {
      */
     async delete(id) {
         if (!id || typeof id !== "string") {
-            throw new Error("Webhook ID must be a non-empty string");
-        }
-        const url = `${this.client["baseUrl"]}/v1/webhooks/${id}`;
-        const response = await fetch(url, {
-            method: "DELETE",
-            headers: {
-                Authorization: `Bearer ${this.client["apiKey"]}`,
-                "Content-Type": "application/json",
-            },
-        });
-        if (!response.ok) {
-            const errorText = await response.text();
-            throw new Error(`Failed to delete webhook: ${response.status} ${errorText}`);
+            throw new ValidationError("Webhook ID must be a non-empty string");
         }
+        await this.client["request"](`/v1/webhooks/${id}`, {}, { method: "DELETE" });
     }
     /**
      * Test a webhook endpoint
@@ -252,21 +219,9 @@ export class WebhooksResource {
      */
     async test(id) {
         if (!id || typeof id !== "string") {
-            throw new Error("Webhook ID must be a non-empty string");
-        }
-        const url = `${this.client["baseUrl"]}/v1/webhooks/${id}/test`;
-        const response = await fetch(url, {
-            method: "POST",
-            headers: {
-                Authorization: `Bearer ${this.client["apiKey"]}`,
-                "Content-Type": "application/json",
-            },
-        });
-        if (!response.ok) {
-            const errorText = await response.text();
-            throw new Error(`Failed to test webhook: ${response.status} ${errorText}`);
+            throw new ValidationError("Webhook ID must be a non-empty string");
         }
-        return response.json();
+        return this.client["request"](`/v1/webhooks/${id}/test`, {}, { method: "POST" });
     }
     /**
      * Get webhook event history
@@ -289,9 +244,47 @@ export class WebhooksResource {
      */
     async events(id) {
         if (!id || typeof id !== "string") {
-            throw new Error("Webhook ID must be a non-empty string");
+            throw new ValidationError("Webhook ID must be a non-empty string");
         }
         const response = await this.client["request"](`/v1/webhooks/${id}/events`, {});
         return Array.isArray(response) ? response : response.events;
     }
+    /**
+     * Verify a webhook signature.
+     *
+     * Validates that a webhook payload was sent by OilPriceAPI by checking
+     * the HMAC-SHA256 signature. Uses constant-time comparison to prevent
+     * timing attacks.
+     *
+     * @param payload - Raw request body (string or Buffer)
+     * @param signature - Value of the X-OilPriceAPI-Signature header (e.g., "sha256=abc123...")
+     * @param secret - Your webhook signing secret
+     * @returns true if signature is valid
+     *
+     * @example
+     * ```typescript
+     * import express from 'express';
+     * import { OilPriceAPI } from 'oilpriceapi';
+     *
+     * const app = express();
+     * const client = new OilPriceAPI({ apiKey: 'your_key' });
+     *
+     * // Use raw body parser for webhook routes
+     * app.post('/webhook', express.raw({ type: 'application/json' }), (req, res) => {
+     *   const signature = req.headers['x-oilpriceapi-signature'] as string;
+     *   const isValid = client.webhooks.verifySignature(req.body, signature, 'your_secret');
+     *
+     *   if (!isValid) {
+     *     return res.status(401).send('Invalid signature');
+     *   }
+     *
+     *   const event = JSON.parse(req.body.toString());
+     *   console.log('Verified webhook:', event.type);
+     *   res.sendStatus(200);
+     * });
+     * ```
+     */
+    verifySignature(payload, signature, secret) {
+        return verifyWebhookSignature(payload, signature, secret);
+    }
 }

package/dist/types.d.ts

@@ -8,8 +8,9 @@ export type RetryStrategy = "exponential" | "linear" | "fixed";
 export interface OilPriceAPIConfig {
     /**
      * Your API key from https://www.oilpriceapi.com
+     * If not provided, reads from OILPRICEAPI_KEY environment variable.
      */
-    apiKey: string;
+    apiKey?: string;
     /**
      * Base URL for the API (optional, for testing)
      * @default "https://api.oilpriceapi.com"

package/dist/version.d.ts

@@ -7,7 +7,7 @@
  * - X-Client-Version header
  * - Package.json (should match)
  */
-export declare const SDK_VERSION = "0.7.0";
+export declare const SDK_VERSION = "0.8.2";
 /**
  * SDK identifier used in User-Agent and X-Api-Client headers
  */

package/dist/version.js

@@ -7,11 +7,11 @@
  * - X-Client-Version header
  * - Package.json (should match)
  */
-export const SDK_VERSION = '0.7.0';
+export const SDK_VERSION = "0.8.2";
 /**
  * SDK identifier used in User-Agent and X-Api-Client headers
  */
-export const SDK_NAME = 'oilpriceapi-node';
+export const SDK_NAME = "oilpriceapi-node";
 /**
  * Build the full User-Agent string
  */

package/package.json

@@ -1,15 +1,20 @@
 {
   "name": "oilpriceapi",
-  "version": "0.7.0",
+  "version": "0.8.2",
   "description": "Official Node.js SDK for Oil Price API - Real-time and historical oil & commodity prices",
   "type": "module",
-  "main": "./dist/index.js",
+  "main": "./dist/cjs/index.js",
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "import": "./dist/index.js",
-      "require": "./dist/index.js",
-      "types": "./dist/index.d.ts"
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      }
     }
   },
   "files": [
@@ -18,9 +23,11 @@
     "LICENSE"
   ],
   "scripts": {
-    "build": "tsc",
+    "build": "tsc && tsc -p tsconfig.cjs.json && echo '{\"type\":\"commonjs\"}' > dist/cjs/package.json",
+    "lint": "eslint src/",
     "test": "vitest run",
     "test:watch": "vitest",
+    "docs": "typedoc",
     "prepublishOnly": "npm run build"
   },
   "keywords": [
@@ -56,7 +63,9 @@
   "devDependencies": {
     "@types/node": "^20.10.0",
     "@vitest/coverage-v8": "^4.0.16",
+    "eslint": "^9.39.4",
     "typescript": "^5.3.0",
+    "typescript-eslint": "^8.57.2",
     "vitest": "^4.0.16"
   }
 }