oilpriceapi 0.2.0 → 0.3.0

package/dist/client.d.ts

@@ -1,4 +1,4 @@
-import type { OilPriceAPIConfig, Price, LatestPricesOptions, HistoricalPricesOptions } from './types.js';
+import type { OilPriceAPIConfig, Price, LatestPricesOptions, HistoricalPricesOptions, Commodity, CommoditiesResponse, CategoriesResponse } from './types.js';
 /**
  * Official Node.js client for Oil Price API
  *
@@ -93,4 +93,42 @@ export declare class OilPriceAPI {
      * ```
      */
     getHistoricalPrices(options?: HistoricalPricesOptions): Promise<Price[]>;
+    /**
+     * Get metadata for all supported commodities
+     *
+     * @returns Object containing array of commodities
+     *
+     * @example
+     * ```typescript
+     * const response = await client.getCommodities();
+     * console.log(response.commodities); // Array of commodity objects
+     * ```
+     */
+    getCommodities(): Promise<CommoditiesResponse>;
+    /**
+     * Get all commodity categories with their commodities
+     *
+     * @returns Object with category keys mapped to category objects
+     *
+     * @example
+     * ```typescript
+     * const categories = await client.getCommodityCategories();
+     * console.log(categories.oil.name); // "Oil"
+     * console.log(categories.oil.commodities.length); // 11
+     * ```
+     */
+    getCommodityCategories(): Promise<CategoriesResponse>;
+    /**
+     * Get metadata for a specific commodity by code
+     *
+     * @param code - Commodity code (e.g., "WTI_USD", "BRENT_CRUDE_USD")
+     * @returns Commodity metadata object
+     *
+     * @example
+     * ```typescript
+     * const commodity = await client.getCommodity('WTI_USD');
+     * console.log(commodity.name); // "WTI Crude Oil"
+     * ```
+     */
+    getCommodity(code: string): Promise<Commodity>;
 }

package/dist/client.js

@@ -121,7 +121,7 @@ export class OilPriceAPI {
                         headers: {
                             'Authorization': `Bearer ${this.apiKey}`,
                             'Content-Type': 'application/json',
-                            'User-Agent': 'oilpriceapi-node/0.2.0',
+                            'User-Agent': 'oilpriceapi-node/0.3.0',
                         },
                         signal: controller.signal,
                     });
@@ -288,4 +288,48 @@ export class OilPriceAPI {
         }
         return this.request('/v1/prices', params);
     }
+    /**
+     * Get metadata for all supported commodities
+     *
+     * @returns Object containing array of commodities
+     *
+     * @example
+     * ```typescript
+     * const response = await client.getCommodities();
+     * console.log(response.commodities); // Array of commodity objects
+     * ```
+     */
+    async getCommodities() {
+        return this.request('/v1/commodities', {});
+    }
+    /**
+     * Get all commodity categories with their commodities
+     *
+     * @returns Object with category keys mapped to category objects
+     *
+     * @example
+     * ```typescript
+     * const categories = await client.getCommodityCategories();
+     * console.log(categories.oil.name); // "Oil"
+     * console.log(categories.oil.commodities.length); // 11
+     * ```
+     */
+    async getCommodityCategories() {
+        return this.request('/v1/commodities/categories', {});
+    }
+    /**
+     * Get metadata for a specific commodity by code
+     *
+     * @param code - Commodity code (e.g., "WTI_USD", "BRENT_CRUDE_USD")
+     * @returns Commodity metadata object
+     *
+     * @example
+     * ```typescript
+     * const commodity = await client.getCommodity('WTI_USD');
+     * console.log(commodity.name); // "WTI Crude Oil"
+     * ```
+     */
+    async getCommodity(code) {
+        return this.request(`/v1/commodities/${code}`, {});
+    }
 }

package/dist/index.d.ts

@@ -6,5 +6,5 @@
  * @packageDocumentation
  */
 export { OilPriceAPI } from './client.js';
-export type { OilPriceAPIConfig, RetryStrategy, Price, LatestPricesOptions, HistoricalPricesOptions, HistoricalPeriod, } from './types.js';
+export type { OilPriceAPIConfig, RetryStrategy, Price, LatestPricesOptions, HistoricalPricesOptions, HistoricalPeriod, Commodity, CommoditiesResponse, CommodityCategory, CategoriesResponse, } from './types.js';
 export { OilPriceAPIError, AuthenticationError, RateLimitError, NotFoundError, ServerError, TimeoutError, } from './errors.js';

package/dist/types.d.ts

@@ -143,3 +143,71 @@ export interface HistoricalPricesOptions {
      */
     endDate?: string;
 }
+/**
+ * Represents commodity metadata
+ */
+export interface Commodity {
+    /**
+     * Unique commodity identifier
+     */
+    code: string;
+    /**
+     * Human-readable commodity name
+     */
+    name: string;
+    /**
+     * Base currency for pricing
+     */
+    currency: string;
+    /**
+     * Commodity category (e.g., "oil", "gas", "renewable")
+     */
+    category: string;
+    /**
+     * Detailed description
+     */
+    description?: string;
+    /**
+     * Unit of measurement (e.g., "barrel", "gallon")
+     */
+    unit: string;
+    /**
+     * Detailed unit description
+     */
+    unit_description?: string;
+    /**
+     * Storage multiplier for price values
+     */
+    multiplier?: number;
+    /**
+     * Price validation ranges
+     */
+    validation?: {
+        min: number;
+        max: number;
+    };
+    /**
+     * Threshold for significant price change alerts
+     */
+    price_change_threshold?: number;
+}
+/**
+ * Response from /v1/commodities endpoint
+ */
+export interface CommoditiesResponse {
+    commodities: Commodity[];
+}
+/**
+ * Category with its commodities
+ */
+export interface CommodityCategory {
+    name: string;
+    commodities: Commodity[];
+}
+/**
+ * Response from /v1/commodities/categories endpoint
+ * Returns object with category keys mapped to CommodityCategory objects
+ */
+export interface CategoriesResponse {
+    [categoryKey: string]: CommodityCategory;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oilpriceapi",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Official Node.js SDK for Oil Price API - Real-time and historical oil & commodity prices",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -40,7 +40,7 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/OilpriceAPI/oilpriceapi-node.git"
+    "url": "git+https://github.com/OilpriceAPI/oilpriceapi-node.git"
   },
   "bugs": {
     "url": "https://github.com/OilpriceAPI/oilpriceapi-node/issues"