oilpriceapi 0.6.0 → 0.8.2

package/dist/resources/ei/index.d.ts

@@ -0,0 +1,140 @@
+/**
+ * Energy Intelligence Resource
+ *
+ * Comprehensive energy market intelligence including rig counts, inventories,
+ * OPEC production, drilling productivity, forecasts, well permits, and FracFocus data.
+ */
+import type { OilPriceAPI } from "../../client.js";
+import { EIRigCountsResource } from "./rig-counts.js";
+import { EIOilInventoriesResource } from "./oil-inventories.js";
+import { EIOPECProductionResource } from "./opec-production.js";
+import { EIDrillingProductivityResource } from "./drilling-productivity.js";
+import { EIForecastsResource } from "./forecasts.js";
+import { EIWellPermitsResource } from "./well-permits.js";
+import { EIFracFocusResource } from "./frac-focus.js";
+/**
+ * Well timeline event
+ */
+export interface WellTimelineEvent {
+    /** Event type */
+    event_type: string;
+    /** Event date */
+    date: string;
+    /** Event description */
+    description?: string;
+    /** Source of data */
+    source?: string;
+    /** Additional metadata */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Well timeline data
+ */
+export interface WellTimeline {
+    /** API well number */
+    api_number: string;
+    /** Well name */
+    well_name?: string;
+    /** Operator */
+    operator?: string;
+    /** State */
+    state?: string;
+    /** Timeline events */
+    events: WellTimelineEvent[];
+}
+/**
+ * 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}`);
+ * });
+ * ```
+ */
+export declare class EnergyIntelligenceResource {
+    private client;
+    /**
+     * Baker Hughes rig count data
+     */
+    readonly rigCounts: EIRigCountsResource;
+    /**
+     * EIA crude oil inventory data
+     */
+    readonly oilInventories: EIOilInventoriesResource;
+    /**
+     * OPEC production data
+     */
+    readonly opecProduction: EIOPECProductionResource;
+    /**
+     * EIA drilling productivity report data
+     */
+    readonly drillingProductivity: EIDrillingProductivityResource;
+    /**
+     * EIA and IEA forecast data
+     */
+    readonly forecasts: EIForecastsResource;
+    /**
+     * Well permit data
+     */
+    readonly wellPermits: EIWellPermitsResource;
+    /**
+     * FracFocus disclosure data
+     */
+    readonly fracFocus: EIFracFocusResource;
+    constructor(client: OilPriceAPI);
+    /**
+     * 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}`);
+     * });
+     * ```
+     */
+    wellTimeline(apiNumber: string): Promise<WellTimeline>;
+}
+export type { RigCountRecord, RigCountByBasin, RigCountByState, HistoricalRigCount, } from "./rig-counts.js";
+export type { OilInventoryRecord, OilInventorySummary, InventoryByProduct, HistoricalInventory, CushingInventory, } from "./oil-inventories.js";
+export type { OPECProductionRecord, TotalOPECProduction, ProductionByCountry, HistoricalProduction, TopProducer, } from "./opec-production.js";
+export type { DrillingProductivityRecord, DrillingProductivitySummary, DUCWellInventory, ProductivityByBasin, HistoricalProductivity, ProductivityTrend, } from "./drilling-productivity.js";
+export type { ForecastRecord, ForecastSummary, PriceForecast, ProductionForecast, HistoricalForecast, ForecastComparison, } from "./forecasts.js";
+export type { WellPermitRecord, WellPermitSummary, PermitsByState, PermitsByOperator, PermitsByFormation, WellPermitSearchQuery, } from "./well-permits.js";
+export type { FracFocusRecord, FracFocusSummary, DisclosuresByState, DisclosuresByOperator, ChemicalUsage, WellChemical, FracFocusSearchQuery, } from "./frac-focus.js";
+export { EIRigCountsResource, EIOilInventoriesResource, EIOPECProductionResource, EIDrillingProductivityResource, EIForecastsResource, EIWellPermitsResource, EIFracFocusResource, };

package/dist/resources/ei/index.js

@@ -0,0 +1,88 @@
+/**
+ * Energy Intelligence Resource
+ *
+ * Comprehensive energy market intelligence including rig counts, inventories,
+ * OPEC production, drilling productivity, forecasts, well permits, and FracFocus data.
+ */
+import { EIRigCountsResource } from "./rig-counts.js";
+import { EIOilInventoriesResource } from "./oil-inventories.js";
+import { EIOPECProductionResource } from "./opec-production.js";
+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
+ *
+ * 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}`);
+ * });
+ * ```
+ */
+export class EnergyIntelligenceResource {
+    constructor(client) {
+        this.client = client;
+        this.rigCounts = new EIRigCountsResource(client);
+        this.oilInventories = new EIOilInventoriesResource(client);
+        this.opecProduction = new EIOPECProductionResource(client);
+        this.drillingProductivity = new EIDrillingProductivityResource(client);
+        this.forecasts = new EIForecastsResource(client);
+        this.wellPermits = new EIWellPermitsResource(client);
+        this.fracFocus = new 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 ValidationError("API number must be a non-empty string");
+        }
+        return this.client["request"](`/v1/ei/wells/${apiNumber}/timeline`, {});
+    }
+}
+export { EIRigCountsResource, EIOilInventoriesResource, EIOPECProductionResource, EIDrillingProductivityResource, EIForecastsResource, EIWellPermitsResource, EIFracFocusResource, };

package/dist/resources/ei/oil-inventories.d.ts

@@ -0,0 +1,155 @@
+/**
+ * Energy Intelligence - Oil Inventories Resource
+ *
+ * Access EIA crude oil inventory data including total US stocks, Cushing levels,
+ * and regional breakdowns.
+ */
+import type { OilPriceAPI } from "../../client.js";
+/**
+ * Oil inventory record
+ */
+export interface OilInventoryRecord {
+    /** Record ID */
+    id: string;
+    /** Inventory level in thousand barrels */
+    level: number;
+    /** Unit of measurement */
+    unit: string;
+    /** Product type (e.g., "crude_oil", "gasoline", "distillate") */
+    product?: string;
+    /** Location (e.g., "US_TOTAL", "CUSHING", "PADD1") */
+    location?: string;
+    /** Change from previous week */
+    change?: number;
+    /** Report date */
+    date: string;
+    /** ISO timestamp */
+    timestamp: string;
+    /** Additional metadata */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Oil inventory summary
+ */
+export interface OilInventorySummary {
+    /** Total US crude oil stocks */
+    total_crude: number;
+    /** Cushing stocks */
+    cushing?: number;
+    /** SPR stocks */
+    spr?: number;
+    /** Total products */
+    total_products?: number;
+    /** Unit */
+    unit: string;
+    /** As of date */
+    as_of_date: string;
+}
+/**
+ * Inventory by product type
+ */
+export interface InventoryByProduct {
+    /** Product type */
+    product: string;
+    /** Inventory level */
+    level: number;
+    /** Change from previous week */
+    change?: number;
+    /** Unit */
+    unit: string;
+    /** Date */
+    date: string;
+}
+/**
+ * Historical inventory data point
+ */
+export interface HistoricalInventory {
+    /** Date */
+    date: string;
+    /** Inventory level */
+    level: number;
+    /** Change */
+    change?: number;
+    /** Unit */
+    unit: string;
+}
+/**
+ * Cushing inventory data
+ */
+export interface CushingInventory {
+    /** Inventory level */
+    level: number;
+    /** Change from previous week */
+    change?: number;
+    /** Percentage of capacity */
+    capacity_percent?: number;
+    /** Unit */
+    unit: string;
+    /** Date */
+    date: string;
+}
+/**
+ * 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}`);
+ * ```
+ */
+export declare class EIOilInventoriesResource {
+    private client;
+    constructor(client: OilPriceAPI);
+    /**
+     * List all oil inventory records
+     *
+     * @returns Array of inventory records
+     */
+    list(): Promise<OilInventoryRecord[]>;
+    /**
+     * Get a specific inventory record
+     *
+     * @param id - Record ID
+     * @returns Inventory record
+     */
+    get(id: string): Promise<OilInventoryRecord>;
+    /**
+     * Get latest oil inventory data
+     *
+     * @returns Latest inventory record
+     */
+    latest(): Promise<OilInventoryRecord>;
+    /**
+     * Get inventory summary
+     *
+     * @returns Inventory summary across all products
+     */
+    summary(): Promise<OilInventorySummary>;
+    /**
+     * Get inventories by product type
+     *
+     * @returns Array of inventories by product
+     */
+    byProduct(): Promise<InventoryByProduct[]>;
+    /**
+     * Get historical inventory data
+     *
+     * @returns Array of historical inventory levels
+     */
+    historical(): Promise<HistoricalInventory[]>;
+    /**
+     * Get Cushing, OK inventory data
+     *
+     * @returns Cushing inventory data
+     */
+    cushing(): Promise<CushingInventory>;
+}

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

@@ -0,0 +1,93 @@
+/**
+ * Energy Intelligence - Oil Inventories Resource
+ *
+ * Access EIA crude oil inventory data including total US stocks, Cushing levels,
+ * and regional breakdowns.
+ */
+import { ValidationError } from "../../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}`);
+ * ```
+ */
+export 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 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", {});
+    }
+}

package/dist/resources/ei/opec-production.d.ts

@@ -0,0 +1,146 @@
+/**
+ * Energy Intelligence - OPEC Production Resource
+ *
+ * Access OPEC crude oil production data by country with historical trends.
+ */
+import type { OilPriceAPI } from "../../client.js";
+/**
+ * OPEC production record
+ */
+export interface OPECProductionRecord {
+    /** Record ID */
+    id: string;
+    /** Country name */
+    country?: string;
+    /** Production volume in barrels per day */
+    production_bpd: number;
+    /** Unit of measurement */
+    unit: string;
+    /** Change from previous month */
+    change?: number;
+    /** Report date */
+    date: string;
+    /** Month */
+    month?: string;
+    /** ISO timestamp */
+    timestamp: string;
+    /** Additional metadata */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Total OPEC production
+ */
+export interface TotalOPECProduction {
+    /** Total production in barrels per day */
+    total_production_bpd: number;
+    /** Change from previous month */
+    change?: number;
+    /** Unit */
+    unit: string;
+    /** As of date */
+    as_of_date: string;
+}
+/**
+ * Production by country
+ */
+export interface ProductionByCountry {
+    /** Country name */
+    country: string;
+    /** Production in barrels per day */
+    production_bpd: number;
+    /** Change from previous month */
+    change?: number;
+    /** Percentage of total OPEC production */
+    percentage?: number;
+    /** Date */
+    date: string;
+}
+/**
+ * Historical production data point
+ */
+export interface HistoricalProduction {
+    /** Date */
+    date: string;
+    /** Production in barrels per day */
+    production_bpd: number;
+    /** Change */
+    change?: number;
+}
+/**
+ * Top producer data
+ */
+export interface TopProducer {
+    /** Country name */
+    country: string;
+    /** Production in barrels per day */
+    production_bpd: number;
+    /** Percentage of total */
+    percentage: number;
+    /** Rank */
+    rank: number;
+}
+/**
+ * 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`));
+ * ```
+ */
+export declare class EIOPECProductionResource {
+    private client;
+    constructor(client: OilPriceAPI);
+    /**
+     * List all OPEC production records
+     *
+     * @returns Array of production records
+     */
+    list(): Promise<OPECProductionRecord[]>;
+    /**
+     * Get a specific production record
+     *
+     * @param id - Record ID
+     * @returns Production record
+     */
+    get(id: string): Promise<OPECProductionRecord>;
+    /**
+     * Get latest OPEC production data
+     *
+     * @returns Latest production record
+     */
+    latest(): Promise<OPECProductionRecord>;
+    /**
+     * Get total OPEC production
+     *
+     * @returns Total OPEC production summary
+     */
+    total(): Promise<TotalOPECProduction>;
+    /**
+     * Get production by country
+     *
+     * @returns Array of production by country
+     */
+    byCountry(): Promise<ProductionByCountry[]>;
+    /**
+     * Get historical production data
+     *
+     * @returns Array of historical production levels
+     */
+    historical(): Promise<HistoricalProduction[]>;
+    /**
+     * Get top OPEC producers
+     *
+     * @returns Array of top producing countries
+     */
+    topProducers(): Promise<TopProducer[]>;
+}