oilpriceapi 0.7.0 → 0.9.0

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"
@@ -239,6 +240,47 @@ export interface Commodity {
 export interface CommoditiesResponse {
     commodities: Commodity[];
 }
+/**
+ * A single price entry from the no-auth demo prices endpoint.
+ */
+export interface DemoPrice {
+    code: string;
+    name: string;
+    price: number;
+    currency: string;
+    updated_at: string;
+    change_24h?: number;
+    source?: string;
+}
+/**
+ * Parsed response from the no-auth `GET /v1/demo/prices` endpoint.
+ */
+export interface DemoPricesResponse {
+    prices: DemoPrice[];
+    meta: {
+        demo_mode?: boolean;
+        rate_limit?: string;
+        available_commodities?: number;
+        [key: string]: unknown;
+    };
+    examples?: unknown;
+}
+/**
+ * Parsed response from the no-auth `GET /v1/demo/commodities` endpoint.
+ */
+export interface DemoCommoditiesResponse {
+    /** Commodities grouped by category key. */
+    commodities: Record<string, Commodity[]>;
+    meta: {
+        /** Total number of demo-listed commodities. */
+        total: number;
+        /** Category keys present in the listing. */
+        categories: string[];
+        /** Commodity codes available on the free demo tier. */
+        free_commodities: string[];
+        [key: string]: unknown;
+    };
+}
 /**
  * Category with its commodities
  */

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.9.0";
 /**
  * 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.9.0";
 /**
  * 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.9.0",
   "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,12 @@
     "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",
+    "test:live": "vitest run --config vitest.live.config.ts",
+    "docs": "typedoc",
     "prepublishOnly": "npm run build"
   },
   "keywords": [
@@ -55,8 +63,15 @@
   },
   "devDependencies": {
     "@types/node": "^20.10.0",
+    "@types/ws": "^8.18.1",
     "@vitest/coverage-v8": "^4.0.16",
+    "eslint": "^9.39.4",
+    "typedoc": "^0.27.9",
     "typescript": "^5.3.0",
+    "typescript-eslint": "^8.57.2",
     "vitest": "^4.0.16"
+  },
+  "dependencies": {
+    "ws": "^8.21.0"
   }
 }