oilpriceapi 0.5.0 → 0.5.3

package/README.md

@@ -625,12 +625,15 @@ All errors extend `OilPriceAPIError`:
 
 The API provides prices for the following commodities:
 
-- **Crude Oil**: WTI, Brent Crude
-- **Refined Products**: Gasoline, Diesel (state averages + station-level), Heating Oil, Jet Fuel
-- **Natural Gas**: US Natural Gas, EU Natural Gas, UK Natural Gas
-- **And more...**
-
-See the [full list of commodities](https://www.oilpriceapi.com/commodities) in the documentation.
+- **Crude Oil**: `WTI_USD`, `BRENT_CRUDE_USD`
+- **Refined Products**: `GASOLINE_USD`, `DIESEL_USD` (state averages + station-level), `HEATING_OIL_USD`, `JET_FUEL_USD`
+- **Natural Gas**: `NATURAL_GAS_USD`, `DUTCH_TTF_EUR`, `NATURAL_GAS_GBP`
+- **Coal** (8 Endpoints):
+  - **US Spot**: `CAPP_COAL_USD`, `PRB_COAL_USD`, `ILLINOIS_COAL_USD`
+  - **International**: `NEWCASTLE_COAL_USD`, `COKING_COAL_USD`, `CME_COAL_USD`
+  - **Historical**: `NYMEX_APPALACHIAN_USD`, `NYMEX_WESTERN_RAIL_USD`
+
+See the [full list of 79 commodities](https://www.oilpriceapi.com/commodities) in the documentation.
 
 ## Pricing & Rate Limits
 

package/dist/client.js

@@ -1,6 +1,7 @@
 import { OilPriceAPIError, AuthenticationError, RateLimitError, NotFoundError, ServerError, TimeoutError, } from './errors.js';
 import { DieselResource } from './resources/diesel.js';
 import { AlertsResource } from './resources/alerts.js';
+import { SDK_VERSION, SDK_NAME, buildUserAgent } from './version.js';
 /**
  * Official Node.js client for Oil Price API
  *
@@ -126,10 +127,9 @@ export class OilPriceAPI {
                         headers: {
                             'Authorization': `Bearer ${this.apiKey}`,
                             'Content-Type': 'application/json',
-                            'User-Agent': 'oilpriceapi-node/0.5.0',
-                            'X-SDK-Language': 'javascript',
-                            'X-SDK-Version': '0.5.0',
-                            'X-Client-Type': 'sdk',
+                            'User-Agent': buildUserAgent(),
+                            'X-Api-Client': SDK_NAME,
+                            'X-Client-Version': SDK_VERSION,
                         },
                         signal: controller.signal,
                     });
@@ -294,7 +294,14 @@ export class OilPriceAPI {
         if (options?.endDate) {
             params.end_date = options.endDate;
         }
-        return this.request('/v1/prices', params);
+        // CRITICAL FIX (December 17, 2025):
+        // Use /v1/prices/past_year endpoint instead of /v1/prices
+        // The /v1/prices endpoint does NOT correctly handle start_date/end_date parameters
+        // This was the same bug that affected the Python SDK (fixed in v1.4.4)
+        // Issue: SDK was returning wrong dates for historical queries
+        // Root Cause: Backend has_scope :by_period not working on /v1/prices
+        // Solution: Use /v1/prices/past_year which uses direct WHERE clauses
+        return this.request('/v1/prices/past_year', params);
     }
     /**
      * Get metadata for all supported commodities

package/dist/index.d.ts

@@ -6,6 +6,7 @@
  * @packageDocumentation
  */
 export { OilPriceAPI } from './client.js';
+export { SDK_VERSION, SDK_NAME } from './version.js';
 export type { OilPriceAPIConfig, RetryStrategy, Price, LatestPricesOptions, HistoricalPricesOptions, HistoricalPeriod, Commodity, CommoditiesResponse, CommodityCategory, CategoriesResponse, } from './types.js';
 export type { DieselPrice, DieselStation, DieselStationsResponse, GetDieselStationsOptions, } from './resources/diesel.js';
 export type { PriceAlert, CreateAlertParams, UpdateAlertParams, AlertOperator, WebhookTestResponse, } from './resources/alerts.js';

package/dist/index.js

@@ -6,4 +6,5 @@
  * @packageDocumentation
  */
 export { OilPriceAPI } from './client.js';
+export { SDK_VERSION, SDK_NAME } from './version.js';
 export { OilPriceAPIError, AuthenticationError, RateLimitError, NotFoundError, ServerError, TimeoutError, } from './errors.js';

package/dist/version.d.ts

@@ -0,0 +1,18 @@
+/**
+ * SDK Version - centralized to ensure consistency across all headers
+ *
+ * This version must be updated when publishing a new release.
+ * It's used in:
+ * - User-Agent header: oilpriceapi-node/{version}
+ * - X-Client-Version header
+ * - Package.json (should match)
+ */
+export declare const SDK_VERSION = "0.5.3";
+/**
+ * SDK identifier used in User-Agent and X-Api-Client headers
+ */
+export declare const SDK_NAME = "oilpriceapi-node";
+/**
+ * Build the full User-Agent string
+ */
+export declare function buildUserAgent(): string;

package/dist/version.js

@@ -0,0 +1,20 @@
+/**
+ * SDK Version - centralized to ensure consistency across all headers
+ *
+ * This version must be updated when publishing a new release.
+ * It's used in:
+ * - User-Agent header: oilpriceapi-node/{version}
+ * - X-Client-Version header
+ * - Package.json (should match)
+ */
+export const SDK_VERSION = '0.5.3';
+/**
+ * SDK identifier used in User-Agent and X-Api-Client headers
+ */
+export const SDK_NAME = 'oilpriceapi-node';
+/**
+ * Build the full User-Agent string
+ */
+export function buildUserAgent() {
+    return `${SDK_NAME}/${SDK_VERSION} node/${process.version}`;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oilpriceapi",
-  "version": "0.5.0",
+  "version": "0.5.3",
   "description": "Official Node.js SDK for Oil Price API - Real-time and historical oil & commodity prices",
   "type": "module",
   "main": "./dist/index.js",
@@ -55,6 +55,7 @@
   },
   "devDependencies": {
     "@types/node": "^20.10.0",
+    "@vitest/coverage-v8": "^1.0.0",
     "typescript": "^5.3.0",
     "vitest": "^1.0.0"
   }