oilpriceapi 0.7.0 → 0.9.0

package/dist/resources/data-sources.d.ts

@@ -14,6 +14,10 @@ export type DataSourceType = "api" | "database" | "file" | "sftp" | "webhook" |
 export type DataSourceStatus = "active" | "paused" | "error" | "pending";
 /**
  * Data source configuration
+ *
+ * NOTE: The API reads `source_type`, `scraper_config`, `status` and `credentials`
+ * (nested under `data_source`). Earlier SDK versions used `type`/`config`/`enabled`,
+ * which the controller silently dropped.
  */
 export interface DataSource {
     /** Unique data source identifier */
@@ -21,63 +25,59 @@ export interface DataSource {
     /** User-friendly name */
     name: string;
     /** Data source type */
-    type: DataSourceType;
-    /** Connection configuration (encrypted) */
-    config: Record<string, unknown>;
-    /** Whether the data source is active */
-    enabled: boolean;
+    source_type: DataSourceType;
+    /** Scraper / connection configuration */
+    scraper_config?: Record<string, unknown>;
     /** Current status */
     status: DataSourceStatus;
     /** Last successful sync timestamp */
     last_sync_at?: string;
     /** Next scheduled sync timestamp */
     next_sync_at?: string;
-    /** Sync frequency in minutes */
-    sync_frequency_minutes?: number;
     /** Number of successful syncs */
-    successful_syncs: number;
+    successful_syncs?: number;
     /** Number of failed syncs */
-    failed_syncs: number;
+    failed_syncs?: number;
     /** Last error message */
     last_error?: string;
-    /** Optional metadata */
-    metadata?: Record<string, unknown>;
     /** ISO timestamp when source was created */
     created_at: string;
     /** ISO timestamp when source was last updated */
     updated_at: string;
 }
 /**
- * Parameters for creating a data source
+ * Parameters for creating a data source.
+ *
+ * Maps to the controller's `data_source_params` strong params:
+ * `source_type`, `name`, `status`, `credentials`, `scraper_config`.
  */
 export interface CreateDataSourceParams {
     /** User-friendly name */
     name: string;
     /** Data source type */
-    type: DataSourceType;
-    /** Connection configuration */
-    config: Record<string, unknown>;
-    /** Whether to enable immediately (default: true) */
-    enabled?: boolean;
-    /** Sync frequency in minutes (default: 60) */
-    sync_frequency_minutes?: number;
-    /** Optional metadata */
-    metadata?: Record<string, unknown>;
+    source_type: DataSourceType;
+    /** Scraper / connection configuration */
+    scraper_config?: Record<string, unknown>;
+    /** Credentials (encrypted server-side) */
+    credentials?: Record<string, unknown>;
+    /** Lifecycle status */
+    status?: DataSourceStatus;
 }
 /**
- * Parameters for updating a data source
+ * Parameters for updating a data source.
+ *
+ * Maps to `data_source_update_params`: `name`, `status`, `credentials`,
+ * `scraper_config` (source_type cannot be changed).
  */
 export interface UpdateDataSourceParams {
     /** User-friendly name */
     name?: string;
-    /** Connection configuration */
-    config?: Record<string, unknown>;
-    /** Whether the data source is active */
-    enabled?: boolean;
-    /** Sync frequency in minutes */
-    sync_frequency_minutes?: number;
-    /** Metadata */
-    metadata?: Record<string, unknown>;
+    /** Scraper / connection configuration */
+    scraper_config?: Record<string, unknown>;
+    /** Credentials (encrypted server-side) */
+    credentials?: Record<string, unknown>;
+    /** Lifecycle status */
+    status?: DataSourceStatus;
 }
 /**
  * Data source test response
@@ -361,5 +361,5 @@ export declare class DataSourcesResource {
      * console.log(`Credential rotation: ${result.success ? 'success' : 'failed'}`);
      * ```
      */
-    rotateCredentials(id: string): Promise<CredentialRotationResponse>;
+    rotateCredentials(id: string, credentials: Record<string, unknown>): Promise<CredentialRotationResponse>;
 }

package/dist/resources/data-sources.js

@@ -3,6 +3,7 @@
  *
  * Manage custom data source integrations for Bring Your Own Source (BYOS) feature.
  */
+import { ValidationError } from "../errors.js";
 /**
  * Data Sources Resource
  *
@@ -86,7 +87,7 @@ export class DataSourcesResource {
      */
     async get(id) {
         if (!id || typeof id !== "string") {
-            throw new Error("Data source ID must be a non-empty string");
+            throw new ValidationError("Data source ID must be a non-empty string");
         }
         const response = await this.client["request"](`/v1/data-sources/${id}`, {});
         return "data_source" in response ? response.data_source : response;
@@ -117,38 +118,24 @@ export class DataSourcesResource {
      */
     async create(params) {
         if (!params.name || typeof params.name !== "string") {
-            throw new Error("Data source name is required");
+            throw new ValidationError("Data source name is required");
         }
-        if (!params.type) {
-            throw new Error("Data source type is required");
+        if (!params.source_type) {
+            throw new ValidationError("Data source source_type is required");
         }
-        if (!params.config || typeof params.config !== "object") {
-            throw new Error("Data source config is required");
-        }
-        const url = `${this.client["baseUrl"]}/v1/data-sources`;
-        const response = await fetch(url, {
+        const response = await this.client["request"]("/v1/data-sources", {}, {
             method: "POST",
-            headers: {
-                Authorization: `Bearer ${this.client["apiKey"]}`,
-                "Content-Type": "application/json",
-            },
-            body: JSON.stringify({
+            body: {
                 data_source: {
                     name: params.name,
-                    type: params.type,
-                    config: params.config,
-                    enabled: params.enabled ?? true,
-                    sync_frequency_minutes: params.sync_frequency_minutes ?? 60,
-                    metadata: params.metadata,
+                    source_type: params.source_type,
+                    status: params.status,
+                    credentials: params.credentials,
+                    scraper_config: params.scraper_config,
                 },
-            }),
+            },
         });
-        if (!response.ok) {
-            const errorText = await response.text();
-            throw new Error(`Failed to create data source: ${response.status} ${errorText}`);
-        }
-        const data = (await response.json());
-        return "data_source" in data ? data.data_source : data;
+        return "data_source" in response ? response.data_source : response;
     }
     /**
      * Update a data source
@@ -173,25 +160,13 @@ export class DataSourcesResource {
      */
     async update(id, params) {
         if (!id || typeof id !== "string") {
-            throw new Error("Data source ID must be a non-empty string");
+            throw new ValidationError("Data source ID must be a non-empty string");
         }
-        const url = `${this.client["baseUrl"]}/v1/data-sources/${id}`;
-        const response = await fetch(url, {
+        const response = await this.client["request"](`/v1/data-sources/${id}`, {}, {
             method: "PATCH",
-            headers: {
-                Authorization: `Bearer ${this.client["apiKey"]}`,
-                "Content-Type": "application/json",
-            },
-            body: JSON.stringify({
-                data_source: params,
-            }),
+            body: { data_source: params },
         });
-        if (!response.ok) {
-            const errorText = await response.text();
-            throw new Error(`Failed to update data source: ${response.status} ${errorText}`);
-        }
-        const data = (await response.json());
-        return "data_source" in data ? data.data_source : data;
+        return "data_source" in response ? response.data_source : response;
     }
     /**
      * Delete a data source
@@ -209,20 +184,9 @@ export class DataSourcesResource {
      */
     async delete(id) {
         if (!id || typeof id !== "string") {
-            throw new Error("Data source ID must be a non-empty string");
-        }
-        const url = `${this.client["baseUrl"]}/v1/data-sources/${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 data source: ${response.status} ${errorText}`);
+            throw new ValidationError("Data source ID must be a non-empty string");
         }
+        await this.client["request"](`/v1/data-sources/${id}`, {}, { method: "DELETE" });
     }
     /**
      * Test a data source connection
@@ -245,21 +209,9 @@ export class DataSourcesResource {
      */
     async test(id) {
         if (!id || typeof id !== "string") {
-            throw new Error("Data source ID must be a non-empty string");
+            throw new ValidationError("Data source ID must be a non-empty string");
         }
-        const url = `${this.client["baseUrl"]}/v1/data-sources/${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 data source: ${response.status} ${errorText}`);
-        }
-        return response.json();
+        return this.client["request"](`/v1/data-sources/${id}/test`, {}, { method: "POST" });
     }
     /**
      * Get data source sync logs
@@ -283,7 +235,7 @@ export class DataSourcesResource {
      */
     async logs(id) {
         if (!id || typeof id !== "string") {
-            throw new Error("Data source ID must be a non-empty string");
+            throw new ValidationError("Data source ID must be a non-empty string");
         }
         const response = await this.client["request"](`/v1/data-sources/${id}/logs`, {});
         return Array.isArray(response) ? response : response.logs;
@@ -307,7 +259,7 @@ export class DataSourcesResource {
      */
     async health(id) {
         if (!id || typeof id !== "string") {
-            throw new Error("Data source ID must be a non-empty string");
+            throw new ValidationError("Data source ID must be a non-empty string");
         }
         return this.client["request"](`/v1/data-sources/${id}/health`, {});
     }
@@ -328,22 +280,15 @@ export class DataSourcesResource {
      * console.log(`Credential rotation: ${result.success ? 'success' : 'failed'}`);
      * ```
      */
-    async rotateCredentials(id) {
+    async rotateCredentials(id, credentials) {
         if (!id || typeof id !== "string") {
-            throw new Error("Data source ID must be a non-empty string");
+            throw new ValidationError("Data source ID must be a non-empty string");
         }
-        const url = `${this.client["baseUrl"]}/v1/data-sources/${id}/rotate-credentials`;
-        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 rotate credentials: ${response.status} ${errorText}`);
+        if (!credentials || typeof credentials !== "object") {
+            throw new ValidationError("New credentials object is required");
         }
-        return response.json();
+        // Route is POST /v1/data-sources/:id/rotate_credentials (underscore) and
+        // the controller does params.require(:credentials).
+        return this.client["request"](`/v1/data-sources/${id}/rotate_credentials`, {}, { method: "POST", body: { credentials } });
     }
 }

package/dist/resources/diesel.d.ts

@@ -1,4 +1,4 @@
-import type { OilPriceAPI } from '../client.js';
+import type { OilPriceAPI } from "../client.js";
 /**
  * Diesel price data for a specific state or region
  */

package/dist/resources/diesel.js

@@ -1,3 +1,4 @@
+import { ValidationError } from "../errors.js";
 /**
  * Diesel Prices resource
  *
@@ -50,9 +51,9 @@ export class DieselResource {
      */
     async getPrice(state) {
         if (!state || state.length !== 2) {
-            throw new Error('State must be a 2-letter US state code (e.g., "CA", "TX")');
+            throw new ValidationError('State must be a 2-letter US state code (e.g., "CA", "TX")');
         }
-        const response = await this.client['request']('/v1/diesel-prices', { state: state.toUpperCase() });
+        const response = await this.client["request"]("/v1/diesel-prices", { state: state.toUpperCase() });
         return response.regional_average;
     }
     /**
@@ -98,47 +99,17 @@ export class DieselResource {
         const { lat, lng, radius = 8047 } = options;
         // Validate coordinates
         if (lat < -90 || lat > 90) {
-            throw new Error('Latitude must be between -90 and 90');
+            throw new ValidationError("Latitude must be between -90 and 90");
         }
         if (lng < -180 || lng > 180) {
-            throw new Error('Longitude must be between -180 and 180');
+            throw new ValidationError("Longitude must be between -180 and 180");
         }
         if (radius < 0 || radius > 50000) {
-            throw new Error('Radius must be between 0 and 50000 meters');
+            throw new ValidationError("Radius must be between 0 and 50000 meters");
         }
-        // Use POST request for stations endpoint
-        const response = await fetch(`${this.client['baseUrl']}/v1/diesel-prices/stations`, {
-            method: 'POST',
-            headers: {
-                'Authorization': `Bearer ${this.client['apiKey']}`,
-                'Content-Type': 'application/json',
-                'User-Agent': 'oilpriceapi-node/0.4.0',
-                'X-SDK-Language': 'javascript',
-                'X-SDK-Version': '0.4.0',
-                'X-Client-Type': 'sdk',
-            },
-            body: JSON.stringify({ lat, lng, radius }),
+        return this.client["request"]("/v1/diesel-prices/stations", {}, {
+            method: "POST",
+            body: { lat, lng, radius },
         });
-        if (!response.ok) {
-            const errorBody = await response.text();
-            let errorMessage = `HTTP ${response.status}: ${response.statusText}`;
-            try {
-                const errorJson = JSON.parse(errorBody);
-                errorMessage = errorJson.message || errorJson.error || errorMessage;
-            }
-            catch {
-                // Use default error message
-            }
-            // Handle specific status codes
-            if (response.status === 403) {
-                throw new Error(`Diesel station queries not available on your plan. ${errorMessage}`);
-            }
-            if (response.status === 429) {
-                throw new Error(`Diesel station query limit exceeded. ${errorMessage}`);
-            }
-            throw new Error(errorMessage);
-        }
-        const data = await response.json();
-        return data;
     }
 }

package/dist/resources/drilling.js

@@ -4,6 +4,7 @@
  * Access US onshore drilling activity data including rig counts, well permits,
  * frac spreads, DUC wells, completions, and production trends by basin.
  */
+import { ValidationError } from "../errors.js";
 /**
  * Drilling Intelligence Resource
  *
@@ -257,7 +258,7 @@ export class DrillingIntelligenceResource {
      */
     async basin(name) {
         if (!name || typeof name !== "string") {
-            throw new Error("Basin name must be a non-empty string");
+            throw new ValidationError("Basin name must be a non-empty string");
         }
         return this.client["request"](`/v1/drilling-intelligence/basin/${name}`, {});
     }

package/dist/resources/ei/drilling-productivity.js

@@ -4,6 +4,7 @@
  * Access EIA Drilling Productivity Report data including new well production,
  * legacy decline rates, and DUC well inventories by basin.
  */
+import { ValidationError } from "../../errors.js";
 /**
  * EI Drilling Productivity Resource
  *
@@ -44,7 +45,7 @@ export class EIDrillingProductivityResource {
      */
     async get(id) {
         if (!id || typeof id !== "string") {
-            throw new Error("Record ID must be a non-empty string");
+            throw new ValidationError("Record ID must be a non-empty string");
         }
         return this.client["request"](`/v1/ei/drilling_productivities/${id}`, {});
     }

package/dist/resources/ei/forecasts.js

@@ -3,6 +3,7 @@
  *
  * Access EIA and IEA price and production forecasts with historical accuracy metrics.
  */
+import { ValidationError } from "../../errors.js";
 /**
  * EI Forecasts Resource
  *
@@ -42,7 +43,7 @@ export class EIForecastsResource {
      */
     async get(id) {
         if (!id || typeof id !== "string") {
-            throw new Error("Record ID must be a non-empty string");
+            throw new ValidationError("Record ID must be a non-empty string");
         }
         return this.client["request"](`/v1/ei/forecasts/${id}`, {});
     }

package/dist/resources/ei/frac-focus.d.ts

@@ -100,18 +100,32 @@ export interface WellChemical {
     mass_lbs?: number;
 }
 /**
- * FracFocus search query
+ * FracFocus search query.
+ *
+ * Maps to the parameters the `search` action actually reads. Note: `operator`
+ * and `chemical` are NOT search params (use the dedicated by-operator /
+ * by-chemical endpoints); state filtering uses `states` (comma-separated, plural).
  */
 export interface FracFocusSearchQuery {
-    /** State filter */
-    state?: string;
-    /** Operator filter */
-    operator?: string;
-    /** Chemical filter */
-    chemical?: string;
-    /** Start date */
+    /** Comma-separated state codes (e.g. 'TX,NM') */
+    states?: string;
+    /** County name (partial match) */
+    county?: string;
+    /** Well name (partial match) */
+    well_name?: string;
+    /** API well number (partial match) */
+    api_number?: string;
+    /** Minimum total base water volume (gallons) */
+    min_water_gallons?: number;
+    /** Latitude for radius search */
+    latitude?: number;
+    /** Longitude for radius search */
+    longitude?: number;
+    /** Radius in miles (1-100, default 10) for lat/lng search */
+    radius_miles?: number;
+    /** Start date (job_start_date >=) */
     start_date?: string;
-    /** End date */
+    /** End date (job_start_date <=) */
     end_date?: string;
 }
 /**

package/dist/resources/ei/frac-focus.js

@@ -4,6 +4,7 @@
  * Access hydraulic fracturing disclosure data including chemicals, operators,
  * and well-level information from the FracFocus registry.
  */
+import { ValidationError } from "../../errors.js";
 /**
  * EI FracFocus Resource
  *
@@ -53,7 +54,7 @@ export class EIFracFocusResource {
      */
     async get(id) {
         if (!id || typeof id !== "string") {
-            throw new Error("Record ID must be a non-empty string");
+            throw new ValidationError("Record ID must be a non-empty string");
         }
         return this.client["request"](`/v1/ei/frac-focus/${id}`, {});
     }
@@ -108,12 +109,22 @@ export class EIFracFocusResource {
      */
     async search(query) {
         const params = {};
-        if (query.state)
-            params.state = query.state;
-        if (query.operator)
-            params.operator = query.operator;
-        if (query.chemical)
-            params.chemical = query.chemical;
+        if (query.states)
+            params.states = query.states;
+        if (query.county)
+            params.county = query.county;
+        if (query.well_name)
+            params.well_name = query.well_name;
+        if (query.api_number)
+            params.api_number = query.api_number;
+        if (query.min_water_gallons !== undefined)
+            params.min_water_gallons = query.min_water_gallons.toString();
+        if (query.latitude !== undefined)
+            params.latitude = query.latitude.toString();
+        if (query.longitude !== undefined)
+            params.longitude = query.longitude.toString();
+        if (query.radius_miles !== undefined)
+            params.radius_miles = query.radius_miles.toString();
         if (query.start_date)
             params.start_date = query.start_date;
         if (query.end_date)
@@ -129,7 +140,7 @@ export class EIFracFocusResource {
      */
     async chemicals(id) {
         if (!id || typeof id !== "string") {
-            throw new Error("Disclosure ID must be a non-empty string");
+            throw new ValidationError("Disclosure ID must be a non-empty string");
         }
         const response = await this.client["request"](`/v1/ei/frac-focus/${id}/chemicals`, {});
         return Array.isArray(response) ? response : response.chemicals;
@@ -142,7 +153,7 @@ export class EIFracFocusResource {
      */
     async forWell(apiNumber) {
         if (!apiNumber || typeof apiNumber !== "string") {
-            throw new Error("API number must be a non-empty string");
+            throw new ValidationError("API number must be a non-empty string");
         }
         const response = await this.client["request"](`/v1/ei/frac-focus/for-well/${apiNumber}`, {});
         return Array.isArray(response) ? response : response.data;

package/dist/resources/ei/index.js

@@ -11,6 +11,7 @@ import { EIDrillingProductivityResource } from "./drilling-productivity.js";
 import { EIForecastsResource } from "./forecasts.js";
 import { EIWellPermitsResource } from "./well-permits.js";
 import { EIFracFocusResource } from "./frac-focus.js";
+import { ValidationError } from "../../errors.js";
 /**
  * Energy Intelligence Resource
  *
@@ -79,7 +80,7 @@ export class EnergyIntelligenceResource {
      */
     async wellTimeline(apiNumber) {
         if (!apiNumber || typeof apiNumber !== "string") {
-            throw new Error("API number must be a non-empty string");
+            throw new ValidationError("API number must be a non-empty string");
         }
         return this.client["request"](`/v1/ei/wells/${apiNumber}/timeline`, {});
     }

package/dist/resources/ei/oil-inventories.js

@@ -4,6 +4,7 @@
  * Access EIA crude oil inventory data including total US stocks, Cushing levels,
  * and regional breakdowns.
  */
+import { ValidationError } from "../../errors.js";
 /**
  * EI Oil Inventories Resource
  *
@@ -43,7 +44,7 @@ export class EIOilInventoriesResource {
      */
     async get(id) {
         if (!id || typeof id !== "string") {
-            throw new Error("Record ID must be a non-empty string");
+            throw new ValidationError("Record ID must be a non-empty string");
         }
         return this.client["request"](`/v1/ei/oil_inventories/${id}`, {});
     }

package/dist/resources/ei/opec-production.js

@@ -3,6 +3,7 @@
  *
  * Access OPEC crude oil production data by country with historical trends.
  */
+import { ValidationError } from "../../errors.js";
 /**
  * EI OPEC Production Resource
  *
@@ -42,7 +43,7 @@ export class EIOPECProductionResource {
      */
     async get(id) {
         if (!id || typeof id !== "string") {
-            throw new Error("Record ID must be a non-empty string");
+            throw new ValidationError("Record ID must be a non-empty string");
         }
         return this.client["request"](`/v1/ei/opec_productions/${id}`, {});
     }

package/dist/resources/ei/rig-counts.js

@@ -3,6 +3,7 @@
  *
  * Access Baker Hughes rig count data with basin, state, and historical breakdowns.
  */
+import { ValidationError } from "../../errors.js";
 /**
  * EI Rig Counts Resource
  *
@@ -46,7 +47,7 @@ export class EIRigCountsResource {
      */
     async get(id) {
         if (!id || typeof id !== "string") {
-            throw new Error("Record ID must be a non-empty string");
+            throw new ValidationError("Record ID must be a non-empty string");
         }
         return this.client["request"](`/v1/ei/rig_counts/${id}`, {});
     }

package/dist/resources/ei/well-permits.d.ts

@@ -84,18 +84,34 @@ export interface PermitsByFormation {
     date: string;
 }
 /**
- * Well permit search query
+ * Well permit search query.
+ *
+ * Maps to the parameters the `search` action actually reads. Note: `operator`
+ * and `formation` are NOT search params (use the dedicated by-operator /
+ * by-formation endpoints); state filtering uses `states` (comma-separated, plural).
  */
 export interface WellPermitSearchQuery {
-    /** State filter */
-    state?: string;
-    /** Operator filter */
-    operator?: string;
-    /** Formation filter */
-    formation?: string;
-    /** Start date */
+    /** Comma-separated state codes (e.g. 'TX,NM') */
+    states?: string;
+    /** County name (partial match) */
+    county?: string;
+    /** Well name (partial match) */
+    well_name?: string;
+    /** Permit type */
+    permit_type?: string;
+    /** Well type */
+    well_type?: string;
+    /** Free-form address (geocoded to lat/lng) */
+    address?: string;
+    /** Latitude for radius search */
+    latitude?: number;
+    /** Longitude for radius search */
+    longitude?: number;
+    /** Radius in miles (1-100, default 10) for lat/lng search */
+    radius_miles?: number;
+    /** Start date (permit_date >=) */
     start_date?: string;
-    /** End date */
+    /** End date (permit_date <=) */
     end_date?: string;
 }
 /**