oilpriceapi 0.7.0 → 0.8.2

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

@@ -0,0 +1,108 @@
+"use strict";
+/**
+ * Energy Intelligence - Drilling Productivity Resource
+ *
+ * Access EIA Drilling Productivity Report data including new well production,
+ * legacy decline rates, and DUC well inventories by basin.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EIDrillingProductivityResource = void 0;
+const errors_js_1 = require("../../errors.js");
+/**
+ * EI Drilling Productivity Resource
+ *
+ * Access EIA Drilling Productivity Report data for major US basins.
+ *
+ * @example
+ * ```typescript
+ * const client = new OilPriceAPI({ apiKey: 'your_key' });
+ *
+ * // Get latest productivity data
+ * const latest = await client.ei.drillingProductivity.latest();
+ * console.log(`Basin: ${latest.basin}`);
+ * console.log(`New well oil: ${latest.new_well_oil_production} bpd/rig`);
+ *
+ * // Get DUC wells
+ * const duc = await client.ei.drillingProductivity.ducWells();
+ * duc.forEach(d => console.log(`${d.basin}: ${d.duc_count} DUC wells`));
+ * ```
+ */
+class EIDrillingProductivityResource {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * List all drilling productivity records
+     *
+     * @returns Array of productivity records
+     */
+    async list() {
+        const response = await this.client["request"]("/v1/ei/drilling_productivities", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get a specific productivity record
+     *
+     * @param id - Record ID
+     * @returns Productivity record
+     */
+    async get(id) {
+        if (!id || typeof id !== "string") {
+            throw new errors_js_1.ValidationError("Record ID must be a non-empty string");
+        }
+        return this.client["request"](`/v1/ei/drilling_productivities/${id}`, {});
+    }
+    /**
+     * Get latest drilling productivity data
+     *
+     * @returns Latest productivity record
+     */
+    async latest() {
+        return this.client["request"]("/v1/ei/drilling_productivities/latest", {});
+    }
+    /**
+     * Get drilling productivity summary
+     *
+     * @returns Productivity summary across all basins
+     */
+    async summary() {
+        return this.client["request"]("/v1/ei/drilling_productivities/summary", {});
+    }
+    /**
+     * Get DUC well inventories
+     *
+     * @returns Array of DUC well counts by basin
+     */
+    async ducWells() {
+        const response = await this.client["request"]("/v1/ei/drilling_productivities/duc_wells", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get productivity by basin
+     *
+     * @returns Array of productivity data by basin
+     */
+    async byBasin() {
+        const response = await this.client["request"]("/v1/ei/drilling_productivities/by_basin", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get historical productivity data
+     *
+     * @returns Array of historical productivity metrics
+     */
+    async historical() {
+        const response = await this.client["request"]("/v1/ei/drilling_productivities/historical", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get productivity trends
+     *
+     * @returns Array of productivity trends by basin
+     */
+    async trends() {
+        const response = await this.client["request"]("/v1/ei/drilling_productivities/trends", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+}
+exports.EIDrillingProductivityResource = EIDrillingProductivityResource;

package/dist/cjs/resources/ei/forecasts.js

@@ -0,0 +1,106 @@
+"use strict";
+/**
+ * Energy Intelligence - Forecasts Resource
+ *
+ * Access EIA and IEA price and production forecasts with historical accuracy metrics.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EIForecastsResource = void 0;
+const errors_js_1 = require("../../errors.js");
+/**
+ * EI Forecasts Resource
+ *
+ * Access EIA and IEA price and production forecasts.
+ *
+ * @example
+ * ```typescript
+ * const client = new OilPriceAPI({ apiKey: 'your_key' });
+ *
+ * // Get latest forecasts
+ * const latest = await client.ei.forecasts.latest();
+ * console.log(`Latest forecast: ${latest.forecast_value} ${latest.unit}`);
+ *
+ * // Get price forecasts
+ * const prices = await client.ei.forecasts.prices();
+ * prices.forEach(p => console.log(`${p.commodity}: $${p.forecast_price} (${p.source})`));
+ * ```
+ */
+class EIForecastsResource {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * List all forecast records
+     *
+     * @returns Array of forecast records
+     */
+    async list() {
+        const response = await this.client["request"]("/v1/ei/forecasts", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get a specific forecast record
+     *
+     * @param id - Record ID
+     * @returns Forecast record
+     */
+    async get(id) {
+        if (!id || typeof id !== "string") {
+            throw new errors_js_1.ValidationError("Record ID must be a non-empty string");
+        }
+        return this.client["request"](`/v1/ei/forecasts/${id}`, {});
+    }
+    /**
+     * Get latest forecast data
+     *
+     * @returns Latest forecast record
+     */
+    async latest() {
+        return this.client["request"]("/v1/ei/forecasts/latest", {});
+    }
+    /**
+     * Get forecast summary
+     *
+     * @returns Forecast summary statistics
+     */
+    async summary() {
+        return this.client["request"]("/v1/ei/forecasts/summary", {});
+    }
+    /**
+     * Get price forecasts
+     *
+     * @returns Array of price forecasts
+     */
+    async prices() {
+        const response = await this.client["request"]("/v1/ei/forecasts/prices", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get production forecasts
+     *
+     * @returns Array of production forecasts
+     */
+    async production() {
+        const response = await this.client["request"]("/v1/ei/forecasts/production", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get historical forecast data
+     *
+     * @returns Array of historical forecasts with accuracy
+     */
+    async historical() {
+        const response = await this.client["request"]("/v1/ei/forecasts/historical", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Compare forecasts from different sources
+     *
+     * @returns Array of forecast comparisons
+     */
+    async compare() {
+        const response = await this.client["request"]("/v1/ei/forecasts/compare", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+}
+exports.EIForecastsResource = EIForecastsResource;

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

@@ -0,0 +1,155 @@
+"use strict";
+/**
+ * Energy Intelligence - FracFocus Resource
+ *
+ * Access hydraulic fracturing disclosure data including chemicals, operators,
+ * and well-level information from the FracFocus registry.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EIFracFocusResource = void 0;
+const errors_js_1 = require("../../errors.js");
+/**
+ * EI FracFocus Resource
+ *
+ * Access hydraulic fracturing disclosure data from the FracFocus registry.
+ *
+ * @example
+ * ```typescript
+ * const client = new OilPriceAPI({ apiKey: 'your_key' });
+ *
+ * // Get latest disclosure
+ * const latest = await client.ei.fracFocus.latest();
+ * console.log(`Well: ${latest.well_name} (API: ${latest.api_number})`);
+ *
+ * // Get disclosures by state
+ * const states = await client.ei.fracFocus.byState();
+ * states.forEach(s => console.log(`${s.state}: ${s.disclosure_count} disclosures`));
+ *
+ * // Get chemicals for a specific well
+ * const chemicals = await client.ei.fracFocus.chemicals('42-123-12345');
+ * chemicals.forEach(c => console.log(`${c.chemical_name}: ${c.concentration_percent}%`));
+ *
+ * // Search disclosures
+ * const results = await client.ei.fracFocus.search({
+ *   state: 'Texas',
+ *   operator: 'EOG Resources'
+ * });
+ * ```
+ */
+class EIFracFocusResource {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * List all FracFocus disclosure records
+     *
+     * @returns Array of disclosure records
+     */
+    async list() {
+        const response = await this.client["request"]("/v1/ei/frac-focus", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get a specific FracFocus disclosure record
+     *
+     * @param id - Record ID
+     * @returns Disclosure record
+     */
+    async get(id) {
+        if (!id || typeof id !== "string") {
+            throw new errors_js_1.ValidationError("Record ID must be a non-empty string");
+        }
+        return this.client["request"](`/v1/ei/frac-focus/${id}`, {});
+    }
+    /**
+     * Get latest FracFocus disclosure
+     *
+     * @returns Latest disclosure record
+     */
+    async latest() {
+        return this.client["request"]("/v1/ei/frac-focus/latest", {});
+    }
+    /**
+     * Get FracFocus summary
+     *
+     * @returns Disclosure summary statistics
+     */
+    async summary() {
+        return this.client["request"]("/v1/ei/frac-focus/summary", {});
+    }
+    /**
+     * Get disclosures by state
+     *
+     * @returns Array of disclosures grouped by state
+     */
+    async byState() {
+        const response = await this.client["request"]("/v1/ei/frac-focus/by-state", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get disclosures by operator
+     *
+     * @returns Array of disclosures grouped by operator
+     */
+    async byOperator() {
+        const response = await this.client["request"]("/v1/ei/frac-focus/by-operator", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get chemical usage statistics
+     *
+     * @returns Array of chemicals used in fracturing
+     */
+    async byChemical() {
+        const response = await this.client["request"]("/v1/ei/frac-focus/by-chemical", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Search FracFocus disclosures
+     *
+     * @param query - Search query parameters
+     * @returns Array of matching disclosure records
+     */
+    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.start_date)
+            params.start_date = query.start_date;
+        if (query.end_date)
+            params.end_date = query.end_date;
+        const response = await this.client["request"]("/v1/ei/frac-focus/search", params);
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get chemicals used in a specific well
+     *
+     * @param id - Disclosure record ID
+     * @returns Array of chemicals used in the well
+     */
+    async chemicals(id) {
+        if (!id || typeof id !== "string") {
+            throw new errors_js_1.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;
+    }
+    /**
+     * Get FracFocus disclosures for a specific well by API number
+     *
+     * @param apiNumber - API well number (e.g., "42-123-12345")
+     * @returns Array of disclosure records for the well
+     */
+    async forWell(apiNumber) {
+        if (!apiNumber || typeof apiNumber !== "string") {
+            throw new errors_js_1.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;
+    }
+}
+exports.EIFracFocusResource = EIFracFocusResource;

package/dist/cjs/resources/ei/index.js

@@ -0,0 +1,98 @@
+"use strict";
+/**
+ * Energy Intelligence Resource
+ *
+ * Comprehensive energy market intelligence including rig counts, inventories,
+ * OPEC production, drilling productivity, forecasts, well permits, and FracFocus data.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EIFracFocusResource = exports.EIWellPermitsResource = exports.EIForecastsResource = exports.EIDrillingProductivityResource = exports.EIOPECProductionResource = exports.EIOilInventoriesResource = exports.EIRigCountsResource = exports.EnergyIntelligenceResource = void 0;
+const rig_counts_js_1 = require("./rig-counts.js");
+Object.defineProperty(exports, "EIRigCountsResource", { enumerable: true, get: function () { return rig_counts_js_1.EIRigCountsResource; } });
+const oil_inventories_js_1 = require("./oil-inventories.js");
+Object.defineProperty(exports, "EIOilInventoriesResource", { enumerable: true, get: function () { return oil_inventories_js_1.EIOilInventoriesResource; } });
+const opec_production_js_1 = require("./opec-production.js");
+Object.defineProperty(exports, "EIOPECProductionResource", { enumerable: true, get: function () { return opec_production_js_1.EIOPECProductionResource; } });
+const drilling_productivity_js_1 = require("./drilling-productivity.js");
+Object.defineProperty(exports, "EIDrillingProductivityResource", { enumerable: true, get: function () { return drilling_productivity_js_1.EIDrillingProductivityResource; } });
+const forecasts_js_1 = require("./forecasts.js");
+Object.defineProperty(exports, "EIForecastsResource", { enumerable: true, get: function () { return forecasts_js_1.EIForecastsResource; } });
+const well_permits_js_1 = require("./well-permits.js");
+Object.defineProperty(exports, "EIWellPermitsResource", { enumerable: true, get: function () { return well_permits_js_1.EIWellPermitsResource; } });
+const frac_focus_js_1 = require("./frac-focus.js");
+Object.defineProperty(exports, "EIFracFocusResource", { enumerable: true, get: function () { return frac_focus_js_1.EIFracFocusResource; } });
+const errors_js_1 = require("../../errors.js");
+/**
+ * Energy Intelligence Resource
+ *
+ * Access comprehensive energy market intelligence from EIA, Baker Hughes,
+ * FracFocus, and other authoritative sources.
+ *
+ * @example
+ * ```typescript
+ * import { OilPriceAPI } from 'oilpriceapi';
+ *
+ * const client = new OilPriceAPI({ apiKey: 'your_key' });
+ *
+ * // Rig counts
+ * const rigCounts = await client.ei.rigCounts.latest();
+ * console.log(`Total rigs: ${rigCounts.total_rigs}`);
+ *
+ * // Oil inventories
+ * const inventories = await client.ei.oilInventories.latest();
+ * console.log(`Crude stocks: ${inventories.level} ${inventories.unit}`);
+ *
+ * // OPEC production
+ * const opec = await client.ei.opecProduction.total();
+ * console.log(`OPEC production: ${opec.total_production_bpd} bpd`);
+ *
+ * // Well timeline
+ * const timeline = await client.ei.wellTimeline('42-123-12345');
+ * timeline.events.forEach(e => {
+ *   console.log(`${e.date}: ${e.event_type}`);
+ * });
+ * ```
+ */
+class EnergyIntelligenceResource {
+    constructor(client) {
+        this.client = client;
+        this.rigCounts = new rig_counts_js_1.EIRigCountsResource(client);
+        this.oilInventories = new oil_inventories_js_1.EIOilInventoriesResource(client);
+        this.opecProduction = new opec_production_js_1.EIOPECProductionResource(client);
+        this.drillingProductivity = new drilling_productivity_js_1.EIDrillingProductivityResource(client);
+        this.forecasts = new forecasts_js_1.EIForecastsResource(client);
+        this.wellPermits = new well_permits_js_1.EIWellPermitsResource(client);
+        this.fracFocus = new frac_focus_js_1.EIFracFocusResource(client);
+    }
+    /**
+     * Get well timeline by API number
+     *
+     * Returns chronological timeline of events for a specific well including
+     * permits, drilling, completion, production, and FracFocus disclosures.
+     *
+     * @param apiNumber - API well number (e.g., "42-123-12345")
+     * @returns Well timeline with events
+     *
+     * @throws {NotFoundError} If well not found
+     * @throws {OilPriceAPIError} If API request fails
+     *
+     * @example
+     * ```typescript
+     * const timeline = await client.ei.wellTimeline('42-123-12345');
+     * console.log(`Well: ${timeline.well_name}`);
+     * console.log(`Operator: ${timeline.operator}`);
+     * console.log(`Events: ${timeline.events.length}`);
+     *
+     * timeline.events.forEach(event => {
+     *   console.log(`${event.date}: ${event.event_type} - ${event.description}`);
+     * });
+     * ```
+     */
+    async wellTimeline(apiNumber) {
+        if (!apiNumber || typeof apiNumber !== "string") {
+            throw new errors_js_1.ValidationError("API number must be a non-empty string");
+        }
+        return this.client["request"](`/v1/ei/wells/${apiNumber}/timeline`, {});
+    }
+}
+exports.EnergyIntelligenceResource = EnergyIntelligenceResource;

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

@@ -0,0 +1,97 @@
+"use strict";
+/**
+ * Energy Intelligence - Oil Inventories Resource
+ *
+ * Access EIA crude oil inventory data including total US stocks, Cushing levels,
+ * and regional breakdowns.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EIOilInventoriesResource = void 0;
+const errors_js_1 = require("../../errors.js");
+/**
+ * EI Oil Inventories Resource
+ *
+ * Access EIA crude oil and petroleum product inventory data.
+ *
+ * @example
+ * ```typescript
+ * const client = new OilPriceAPI({ apiKey: 'your_key' });
+ *
+ * // Get latest inventories
+ * const latest = await client.ei.oilInventories.latest();
+ * console.log(`Total crude: ${latest.level} ${latest.unit}`);
+ *
+ * // Get Cushing stocks
+ * const cushing = await client.ei.oilInventories.cushing();
+ * console.log(`Cushing: ${cushing.level} ${cushing.unit}`);
+ * ```
+ */
+class EIOilInventoriesResource {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * List all oil inventory records
+     *
+     * @returns Array of inventory records
+     */
+    async list() {
+        const response = await this.client["request"]("/v1/ei/oil_inventories", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get a specific inventory record
+     *
+     * @param id - Record ID
+     * @returns Inventory record
+     */
+    async get(id) {
+        if (!id || typeof id !== "string") {
+            throw new errors_js_1.ValidationError("Record ID must be a non-empty string");
+        }
+        return this.client["request"](`/v1/ei/oil_inventories/${id}`, {});
+    }
+    /**
+     * Get latest oil inventory data
+     *
+     * @returns Latest inventory record
+     */
+    async latest() {
+        return this.client["request"]("/v1/ei/oil_inventories/latest", {});
+    }
+    /**
+     * Get inventory summary
+     *
+     * @returns Inventory summary across all products
+     */
+    async summary() {
+        return this.client["request"]("/v1/ei/oil_inventories/summary", {});
+    }
+    /**
+     * Get inventories by product type
+     *
+     * @returns Array of inventories by product
+     */
+    async byProduct() {
+        const response = await this.client["request"]("/v1/ei/oil_inventories/by_product", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get historical inventory data
+     *
+     * @returns Array of historical inventory levels
+     */
+    async historical() {
+        const response = await this.client["request"]("/v1/ei/oil_inventories/historical", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get Cushing, OK inventory data
+     *
+     * @returns Cushing inventory data
+     */
+    async cushing() {
+        return this.client["request"]("/v1/ei/oil_inventories/cushing", {});
+    }
+}
+exports.EIOilInventoriesResource = EIOilInventoriesResource;

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

@@ -0,0 +1,97 @@
+"use strict";
+/**
+ * Energy Intelligence - OPEC Production Resource
+ *
+ * Access OPEC crude oil production data by country with historical trends.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EIOPECProductionResource = void 0;
+const errors_js_1 = require("../../errors.js");
+/**
+ * EI OPEC Production Resource
+ *
+ * Access OPEC crude oil production data and analytics.
+ *
+ * @example
+ * ```typescript
+ * const client = new OilPriceAPI({ apiKey: 'your_key' });
+ *
+ * // Get total OPEC production
+ * const total = await client.ei.opecProduction.total();
+ * console.log(`Total OPEC: ${total.total_production_bpd} bpd`);
+ *
+ * // Get top producers
+ * const top = await client.ei.opecProduction.topProducers();
+ * top.forEach(p => console.log(`${p.rank}. ${p.country}: ${p.production_bpd} bpd`));
+ * ```
+ */
+class EIOPECProductionResource {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * List all OPEC production records
+     *
+     * @returns Array of production records
+     */
+    async list() {
+        const response = await this.client["request"]("/v1/ei/opec_productions", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get a specific production record
+     *
+     * @param id - Record ID
+     * @returns Production record
+     */
+    async get(id) {
+        if (!id || typeof id !== "string") {
+            throw new errors_js_1.ValidationError("Record ID must be a non-empty string");
+        }
+        return this.client["request"](`/v1/ei/opec_productions/${id}`, {});
+    }
+    /**
+     * Get latest OPEC production data
+     *
+     * @returns Latest production record
+     */
+    async latest() {
+        return this.client["request"]("/v1/ei/opec_productions/latest", {});
+    }
+    /**
+     * Get total OPEC production
+     *
+     * @returns Total OPEC production summary
+     */
+    async total() {
+        return this.client["request"]("/v1/ei/opec_productions/total", {});
+    }
+    /**
+     * Get production by country
+     *
+     * @returns Array of production by country
+     */
+    async byCountry() {
+        const response = await this.client["request"]("/v1/ei/opec_productions/by_country", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get historical production data
+     *
+     * @returns Array of historical production levels
+     */
+    async historical() {
+        const response = await this.client["request"]("/v1/ei/opec_productions/historical", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+    /**
+     * Get top OPEC producers
+     *
+     * @returns Array of top producing countries
+     */
+    async topProducers() {
+        const response = await this.client["request"]("/v1/ei/opec_productions/top_producers", {});
+        return Array.isArray(response) ? response : response.data;
+    }
+}
+exports.EIOPECProductionResource = EIOPECProductionResource;