@fedpulse/sdk 1.0.0

package/dist/types/types/exclusions.d.ts

@@ -0,0 +1,81 @@
+/**
+ * Types for the Exclusions domain (/v1/exclusions).
+ */
+import type { PaginationParams } from './common.js';
+export interface Exclusion {
+    exclusionId: string;
+    uei?: string | null;
+    cage?: string | null;
+    name?: string | null;
+    legalName?: string | null;
+    exclusionType?: string | null;
+    exclusionProgram?: string | null;
+    exclusionAction?: string | null;
+    agencyCode?: string | null;
+    agency?: string | null;
+    effectiveDate?: string | null;
+    expirationDate?: string | null;
+    terminationDate?: string | null;
+    terminatedBy?: string | null;
+    address?: {
+        street?: string | null;
+        city?: string | null;
+        state?: string | null;
+        zip?: string | null;
+        country?: string | null;
+    } | null;
+    ctCode?: string | null;
+    additionalRemarks?: string | null;
+    crossReferenceList?: string[] | null;
+    rawJson?: unknown;
+}
+export interface ComplianceCheckEntity {
+    /** Unique Entity Identifier (12-char alphanumeric). */
+    uei?: string;
+    /** CAGE code. */
+    cage?: string;
+    /** Legal entity name (enables fuzzy matching). */
+    name?: string;
+}
+export interface ComplianceCheckResult {
+    input: ComplianceCheckEntity;
+    excluded: boolean;
+    /** Confidence level when matched by name (0–1). Present when fuzzy match used. */
+    matchConfidence?: number | null;
+    /** The matched exclusion record, or null if not excluded / no match. */
+    exclusion: Exclusion | null;
+    /** Human-readable explanation of the result. */
+    message: string;
+}
+export interface ExclusionsStats {
+    total: number;
+    active: number;
+    expired: number;
+    byType: Array<{
+        type: string;
+        count: number;
+    }>;
+    byAgency: Array<{
+        agency: string;
+        count: number;
+    }>;
+}
+export interface ListExclusionsParams extends PaginationParams {
+    /** Search by entity name or legal name. */
+    q?: string;
+    /** Filter by Unique Entity Identifier. */
+    uei?: string;
+    /** Filter by CAGE code. */
+    cage?: string;
+    /** Filter by excluding agency code or name. */
+    agency?: string;
+    /** Only return active exclusions (not yet terminated/expired). */
+    activeOnly?: boolean;
+}
+export interface BulkComplianceCheckParams {
+    /** List of entities to check (1–100). Each must include at least one of uei, cage, or name. */
+    entities: ComplianceCheckEntity[];
+    /** Enable fuzzy name matching (default: true). Recommended when only names are available. */
+    fuzzyMatch?: boolean;
+}
+//# sourceMappingURL=exclusions.d.ts.map

package/dist/types/types/exclusions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"exclusions.d.ts","sourceRoot":"","sources":["../../../src/types/exclusions.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAIpD,MAAM,WAAW,SAAS;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,OAAO,CAAC,EAAE;QACR,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACvB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACrB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACtB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACpB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB,GAAG,IAAI,CAAC;IACT,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,kBAAkB,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IACrC,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAID,MAAM,WAAW,qBAAqB;IACpC,uDAAuD;IACvD,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,iBAAiB;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kDAAkD;IAClD,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,qBAAqB,CAAC;IAC7B,QAAQ,EAAE,OAAO,CAAC;IAClB,kFAAkF;IAClF,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,wEAAwE;IACxE,SAAS,EAAE,SAAS,GAAG,IAAI,CAAC;IAC5B,gDAAgD;IAChD,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC/C,QAAQ,EAAE,KAAK,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACpD;AAID,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC5D,2CAA2C;IAC3C,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,0CAA0C;IAC1C,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,2BAA2B;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,+CAA+C;IAC/C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kEAAkE;IAClE,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,yBAAyB;IACxC,+FAA+F;IAC/F,QAAQ,EAAE,qBAAqB,EAAE,CAAC;IAClC,6FAA6F;IAC7F,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB"}

package/dist/types/types/index.d.cts

@@ -0,0 +1,12 @@
+/**
+ * Barrel export for all FedPulse SDK TypeScript types.
+ */
+export type * from './common.cjs';
+export type * from './opportunities.cjs';
+export type * from './exclusions.cjs';
+export type * from './entities.cjs';
+export type * from './intelligence.cjs';
+export type * from './assistance.cjs';
+export type * from './analytics.cjs';
+export type * from './webhooks.cjs';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/types/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Barrel export for all FedPulse SDK TypeScript types.
+ */
+export type * from './common.js';
+export type * from './opportunities.js';
+export type * from './exclusions.js';
+export type * from './entities.js';
+export type * from './intelligence.js';
+export type * from './assistance.js';
+export type * from './analytics.js';
+export type * from './webhooks.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,mBAAmB,aAAa,CAAC;AACjC,mBAAmB,oBAAoB,CAAC;AACxC,mBAAmB,iBAAiB,CAAC;AACrC,mBAAmB,eAAe,CAAC;AACnC,mBAAmB,mBAAmB,CAAC;AACvC,mBAAmB,iBAAiB,CAAC;AACrC,mBAAmB,gBAAgB,CAAC;AACpC,mBAAmB,eAAe,CAAC"}

package/dist/types/types/intelligence.d.cts

@@ -0,0 +1,104 @@
+/**
+ * Types for the Intelligence domain (/v1/intelligence).
+ */
+import type { AiCategory } from './opportunities.cjs';
+export interface AgencyRelationship {
+    agency: string;
+    contractCount: number;
+    totalAwardAmount: number;
+    lastAwardDate?: string | null;
+}
+export interface ContractHistoryItem {
+    noticeId: string;
+    title: string;
+    agency?: string | null;
+    awardAmount?: number | null;
+    awardDate?: string | null;
+    naicsCode?: string | null;
+}
+export interface RiskIndicator {
+    type: string;
+    description: string;
+    severity: 'low' | 'medium' | 'high';
+    detectedAt?: string | null;
+}
+export interface EntityIntelProfile {
+    uei: string;
+    legalBusinessName: string;
+    cage?: string | null;
+    hasActiveExclusion: boolean;
+    exclusionSummary?: string | null;
+    registrationStatus?: string | null;
+    registrationExpiresAt?: string | null;
+    /** Number of awarded contracts found. */
+    contractCount: number;
+    /** Total value of awarded contracts in cents. */
+    totalAwardAmount: number;
+    /** Average award contract value in cents. */
+    averageAwardAmount: number;
+    agencyRelationships: AgencyRelationship[];
+    recentContracts: ContractHistoryItem[];
+    topNaicsCodes: Array<{
+        naicsCode: string;
+        count: number;
+    }>;
+    certifications: string[];
+    riskIndicators: RiskIndicator[];
+    aiCategories?: AiCategory[] | null;
+    lastUpdated: string;
+}
+export interface MarketAwardee {
+    name: string;
+    uei?: string | null;
+    awardCount: number;
+    totalAwardAmount: number;
+    marketShare: number;
+}
+export interface MarketAgency {
+    agency: string;
+    awardCount: number;
+    totalAwardAmount: number;
+}
+export interface SetAsideBreakdown {
+    setAsideType: string;
+    count: number;
+    percentage: number;
+}
+export interface MarketAnalysis {
+    naicsCode: string;
+    naicsDescription?: string | null;
+    /** Total market size (sum of all award amounts) in cents. */
+    totalMarketSize: number;
+    /** Average award value in cents. */
+    averageAwardValue: number;
+    /** Total number of contracts in the analysis window. */
+    contractCount: number;
+    /** Number of currently open/active solicitations. */
+    activeOpportunities: number;
+    topAwardees: MarketAwardee[];
+    topAgencies: MarketAgency[];
+    setAsideBreakdown: SetAsideBreakdown[];
+    recentTrends: Array<{
+        period: string;
+        contractCount: number;
+        totalAwardAmount: number;
+    }>;
+    lastUpdated: string;
+}
+export interface CompliancePackage {
+    uei: string;
+    legalBusinessName?: string | null;
+    excluded: boolean;
+    exclusionDetails?: import('./exclusions.js').Exclusion | null;
+    registrationActive: boolean;
+    registrationExpiresAt?: string | null;
+    hasActiveExclusion: boolean;
+    riskScore: number;
+    riskLevel: 'low' | 'medium' | 'high';
+    riskIndicators: RiskIndicator[];
+    checkedAt: string;
+}
+export interface ComplianceCheckRequestParams {
+    uei: string;
+}
+//# sourceMappingURL=intelligence.d.ts.map

package/dist/types/types/intelligence.d.ts

@@ -0,0 +1,104 @@
+/**
+ * Types for the Intelligence domain (/v1/intelligence).
+ */
+import type { AiCategory } from './opportunities.js';
+export interface AgencyRelationship {
+    agency: string;
+    contractCount: number;
+    totalAwardAmount: number;
+    lastAwardDate?: string | null;
+}
+export interface ContractHistoryItem {
+    noticeId: string;
+    title: string;
+    agency?: string | null;
+    awardAmount?: number | null;
+    awardDate?: string | null;
+    naicsCode?: string | null;
+}
+export interface RiskIndicator {
+    type: string;
+    description: string;
+    severity: 'low' | 'medium' | 'high';
+    detectedAt?: string | null;
+}
+export interface EntityIntelProfile {
+    uei: string;
+    legalBusinessName: string;
+    cage?: string | null;
+    hasActiveExclusion: boolean;
+    exclusionSummary?: string | null;
+    registrationStatus?: string | null;
+    registrationExpiresAt?: string | null;
+    /** Number of awarded contracts found. */
+    contractCount: number;
+    /** Total value of awarded contracts in cents. */
+    totalAwardAmount: number;
+    /** Average award contract value in cents. */
+    averageAwardAmount: number;
+    agencyRelationships: AgencyRelationship[];
+    recentContracts: ContractHistoryItem[];
+    topNaicsCodes: Array<{
+        naicsCode: string;
+        count: number;
+    }>;
+    certifications: string[];
+    riskIndicators: RiskIndicator[];
+    aiCategories?: AiCategory[] | null;
+    lastUpdated: string;
+}
+export interface MarketAwardee {
+    name: string;
+    uei?: string | null;
+    awardCount: number;
+    totalAwardAmount: number;
+    marketShare: number;
+}
+export interface MarketAgency {
+    agency: string;
+    awardCount: number;
+    totalAwardAmount: number;
+}
+export interface SetAsideBreakdown {
+    setAsideType: string;
+    count: number;
+    percentage: number;
+}
+export interface MarketAnalysis {
+    naicsCode: string;
+    naicsDescription?: string | null;
+    /** Total market size (sum of all award amounts) in cents. */
+    totalMarketSize: number;
+    /** Average award value in cents. */
+    averageAwardValue: number;
+    /** Total number of contracts in the analysis window. */
+    contractCount: number;
+    /** Number of currently open/active solicitations. */
+    activeOpportunities: number;
+    topAwardees: MarketAwardee[];
+    topAgencies: MarketAgency[];
+    setAsideBreakdown: SetAsideBreakdown[];
+    recentTrends: Array<{
+        period: string;
+        contractCount: number;
+        totalAwardAmount: number;
+    }>;
+    lastUpdated: string;
+}
+export interface CompliancePackage {
+    uei: string;
+    legalBusinessName?: string | null;
+    excluded: boolean;
+    exclusionDetails?: import('./exclusions.js').Exclusion | null;
+    registrationActive: boolean;
+    registrationExpiresAt?: string | null;
+    hasActiveExclusion: boolean;
+    riskScore: number;
+    riskLevel: 'low' | 'medium' | 'high';
+    riskIndicators: RiskIndicator[];
+    checkedAt: string;
+}
+export interface ComplianceCheckRequestParams {
+    uei: string;
+}
+//# sourceMappingURL=intelligence.d.ts.map

package/dist/types/types/intelligence.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"intelligence.d.ts","sourceRoot":"","sources":["../../../src/types/intelligence.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAIrD,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;IACtB,gBAAgB,EAAE,MAAM,CAAC;IACzB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAC;IACpC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,kBAAkB;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,iBAAiB,EAAE,MAAM,CAAC;IAC1B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,yCAAyC;IACzC,aAAa,EAAE,MAAM,CAAC;IACtB,iDAAiD;IACjD,gBAAgB,EAAE,MAAM,CAAC;IACzB,6CAA6C;IAC7C,kBAAkB,EAAE,MAAM,CAAC;IAC3B,mBAAmB,EAAE,kBAAkB,EAAE,CAAC;IAC1C,eAAe,EAAE,mBAAmB,EAAE,CAAC;IACvC,aAAa,EAAE,KAAK,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC3D,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,cAAc,EAAE,aAAa,EAAE,CAAC;IAChC,YAAY,CAAC,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;IACnC,WAAW,EAAE,MAAM,CAAC;CACrB;AAID,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,MAAM,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,iBAAiB;IAChC,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,6DAA6D;IAC7D,eAAe,EAAE,MAAM,CAAC;IACxB,oCAAoC;IACpC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,wDAAwD;IACxD,aAAa,EAAE,MAAM,CAAC;IACtB,qDAAqD;IACrD,mBAAmB,EAAE,MAAM,CAAC;IAC5B,WAAW,EAAE,aAAa,EAAE,CAAC;IAC7B,WAAW,EAAE,YAAY,EAAE,CAAC;IAC5B,iBAAiB,EAAE,iBAAiB,EAAE,CAAC;IACvC,YAAY,EAAE,KAAK,CAAC;QAClB,MAAM,EAAE,MAAM,CAAC;QACf,aAAa,EAAE,MAAM,CAAC;QACtB,gBAAgB,EAAE,MAAM,CAAC;KAC1B,CAAC,CAAC;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAID,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,QAAQ,EAAE,OAAO,CAAC;IAClB,gBAAgB,CAAC,EAAE,OAAO,iBAAiB,EAAE,SAAS,GAAG,IAAI,CAAC;IAC9D,kBAAkB,EAAE,OAAO,CAAC;IAC5B,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,kBAAkB,EAAE,OAAO,CAAC;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAC;IACrC,cAAc,EAAE,aAAa,EAAE,CAAC;IAChC,SAAS,EAAE,MAAM,CAAC;CACnB;AAID,MAAM,WAAW,4BAA4B;IAC3C,GAAG,EAAE,MAAM,CAAC;CACb"}

package/dist/types/types/opportunities.d.cts

@@ -0,0 +1,149 @@
+/**
+ * Types for the Opportunities domain (/v1/opportunities).
+ */
+import type { PaginationParams, FieldsParam } from './common.cjs';
+export type AiCategory = 'technology' | 'defense' | 'construction' | 'professional-services' | 'logistics' | 'medical' | 'research' | 'energy' | 'environmental' | 'education-training' | 'intelligence-surveillance' | 'space-aviation' | 'maritime' | 'agriculture-food' | 'other';
+export type AiDifficulty = 'easy' | 'medium' | 'hard' | 'unknown';
+export interface Opportunity {
+    noticeId: string;
+    solicitationNumber?: string | null;
+    solNumber?: string | null;
+    baseNoticeId?: string | null;
+    title: string;
+    noticeType?: string | null;
+    type?: string | null;
+    baseType?: string | null;
+    descriptionRaw?: string | null;
+    descriptionClean?: string | null;
+    postedDate?: string | null;
+    responseDeadline?: string | null;
+    archiveDate?: string | null;
+    modifiedDate?: string | null;
+    naicsCode?: string | null;
+    classificationCode?: string | null;
+    setAsideType?: string | null;
+    setAsideDescription?: string | null;
+    department?: string | null;
+    subTier?: string | null;
+    office?: string | null;
+    officeAddress?: unknown;
+    awardDate?: string | null;
+    awardNumber?: string | null;
+    awardAmount?: string | number | null;
+    awardAmountRaw?: string | null;
+    awardeeName?: string | null;
+    awardeeUei?: string | null;
+    awardeeCage?: string | null;
+    awardeeCity?: string | null;
+    awardeeState?: string | null;
+    awardeeZip?: string | null;
+    contactName?: string | null;
+    contactTitle?: string | null;
+    contactEmail?: string | null;
+    contactPhone?: string | null;
+    popCity?: string | null;
+    popState?: string | null;
+    popZip?: string | null;
+    popCountry?: string | null;
+    popAddress?: string | null;
+    samUiLink?: string | null;
+    resourceLinks?: unknown;
+    isActive?: boolean | null;
+    dataSource?: string | null;
+    sourceFile?: string | null;
+    aiTags?: string[] | null;
+    aiCategory?: AiCategory | null;
+    aiDifficulty?: AiDifficulty | null;
+    aiSummary?: string | null;
+    aiEnrichedAt?: string | null;
+}
+export type OpportunitiesStatsGroupBy = 'department' | 'naics' | 'setAsideType' | 'postedYear' | 'aiCategory' | 'aiDifficulty';
+export interface OpportunityStatsItem {
+    group: string | null;
+    count: number;
+    totalAwardAmount?: number | null;
+}
+export interface OpportunitiesStats {
+    groupBy: OpportunitiesStatsGroupBy;
+    items: OpportunityStatsItem[];
+}
+/** ISO date string: `YYYY-MM-DD` */
+type ISODate = string;
+export interface ListOpportunitiesParams extends PaginationParams, FieldsParam {
+    /** Full-text search query. */
+    q?: string;
+    /** NAICS code(s) — 2–6 digits. */
+    naics?: string | string[];
+    /** Department/agency name (substring match). */
+    agency?: string;
+    /** Office name (substring match). */
+    office?: string;
+    /** Set-aside type code(s) (e.g. '8A', 'WOSB'). */
+    setAside?: string | string[];
+    /** SAM.gov notice type(s) (e.g. 'Solicitation', 'Award Notice'). */
+    noticeType?: string | string[];
+    /** Results posted on or after this date (YYYY-MM-DD). */
+    postedAfter?: ISODate;
+    /** Results posted on or before this date (YYYY-MM-DD). */
+    postedBefore?: ISODate;
+    /** Response deadline on or after this date (YYYY-MM-DD). */
+    deadlineAfter?: ISODate;
+    /** Place of performance (2-letter US state code or full state name). */
+    state?: string;
+    /** Minimum award amount in **cents** (integer). */
+    minAward?: number;
+    /** Maximum award amount in **cents** (integer). */
+    maxAward?: number;
+    /** Data source filter (e.g. 'sam.gov'). */
+    dataSource?: string;
+    /** Filter by AI-assigned category (requires enrichment to have run). */
+    aiCategory?: AiCategory;
+    /** Filter by AI-assigned tag(s). */
+    aiTag?: string | string[];
+    /** Filter by AI-assigned difficulty. */
+    aiDifficulty?: AiDifficulty;
+    /** Sort field. Default: 'postedDate'. */
+    sort?: 'postedDate' | 'awardAmount' | 'responseDeadline';
+    /** Sort direction. Default: 'desc'. */
+    dir?: 'asc' | 'desc';
+}
+export interface GetOpportunitiesStatsParams {
+    /** Dimension to group results by. Default: 'department'. */
+    groupBy?: OpportunitiesStatsGroupBy;
+    /** Maximum number of groups to return (1–100). Default: 25. */
+    limit?: number;
+    /** Filter by data source. */
+    dataSource?: string;
+}
+export type ExportFormat = 'ndjson' | 'csv';
+export type ExportStatus = 'pending' | 'running' | 'done' | 'failed';
+export interface CreateExportParams {
+    /** Output format. Developer plan supports CSV only; Professional/Enterprise support all. */
+    format: ExportFormat;
+    /** Same filters as the opportunities search endpoint. */
+    q?: string;
+    naics?: string | string[];
+    agency?: string;
+    setAside?: string | string[];
+    noticeType?: string | string[];
+    postedAfter?: ISODate;
+    postedBefore?: ISODate;
+    state?: string;
+    minAward?: number;
+    maxAward?: number;
+    dataSource?: string;
+    aiCategory?: AiCategory;
+    aiDifficulty?: AiDifficulty;
+}
+export interface ExportJob {
+    exportId: string;
+    status: ExportStatus;
+    format: ExportFormat;
+    createdAt: string;
+    startedAt?: string | null;
+    completedAt?: string | null;
+    outputBytes?: number | null;
+    errorMessage?: string | null;
+}
+export {};
+//# sourceMappingURL=opportunities.d.ts.map

package/dist/types/types/opportunities.d.ts

@@ -0,0 +1,149 @@
+/**
+ * Types for the Opportunities domain (/v1/opportunities).
+ */
+import type { PaginationParams, FieldsParam } from './common.js';
+export type AiCategory = 'technology' | 'defense' | 'construction' | 'professional-services' | 'logistics' | 'medical' | 'research' | 'energy' | 'environmental' | 'education-training' | 'intelligence-surveillance' | 'space-aviation' | 'maritime' | 'agriculture-food' | 'other';
+export type AiDifficulty = 'easy' | 'medium' | 'hard' | 'unknown';
+export interface Opportunity {
+    noticeId: string;
+    solicitationNumber?: string | null;
+    solNumber?: string | null;
+    baseNoticeId?: string | null;
+    title: string;
+    noticeType?: string | null;
+    type?: string | null;
+    baseType?: string | null;
+    descriptionRaw?: string | null;
+    descriptionClean?: string | null;
+    postedDate?: string | null;
+    responseDeadline?: string | null;
+    archiveDate?: string | null;
+    modifiedDate?: string | null;
+    naicsCode?: string | null;
+    classificationCode?: string | null;
+    setAsideType?: string | null;
+    setAsideDescription?: string | null;
+    department?: string | null;
+    subTier?: string | null;
+    office?: string | null;
+    officeAddress?: unknown;
+    awardDate?: string | null;
+    awardNumber?: string | null;
+    awardAmount?: string | number | null;
+    awardAmountRaw?: string | null;
+    awardeeName?: string | null;
+    awardeeUei?: string | null;
+    awardeeCage?: string | null;
+    awardeeCity?: string | null;
+    awardeeState?: string | null;
+    awardeeZip?: string | null;
+    contactName?: string | null;
+    contactTitle?: string | null;
+    contactEmail?: string | null;
+    contactPhone?: string | null;
+    popCity?: string | null;
+    popState?: string | null;
+    popZip?: string | null;
+    popCountry?: string | null;
+    popAddress?: string | null;
+    samUiLink?: string | null;
+    resourceLinks?: unknown;
+    isActive?: boolean | null;
+    dataSource?: string | null;
+    sourceFile?: string | null;
+    aiTags?: string[] | null;
+    aiCategory?: AiCategory | null;
+    aiDifficulty?: AiDifficulty | null;
+    aiSummary?: string | null;
+    aiEnrichedAt?: string | null;
+}
+export type OpportunitiesStatsGroupBy = 'department' | 'naics' | 'setAsideType' | 'postedYear' | 'aiCategory' | 'aiDifficulty';
+export interface OpportunityStatsItem {
+    group: string | null;
+    count: number;
+    totalAwardAmount?: number | null;
+}
+export interface OpportunitiesStats {
+    groupBy: OpportunitiesStatsGroupBy;
+    items: OpportunityStatsItem[];
+}
+/** ISO date string: `YYYY-MM-DD` */
+type ISODate = string;
+export interface ListOpportunitiesParams extends PaginationParams, FieldsParam {
+    /** Full-text search query. */
+    q?: string;
+    /** NAICS code(s) — 2–6 digits. */
+    naics?: string | string[];
+    /** Department/agency name (substring match). */
+    agency?: string;
+    /** Office name (substring match). */
+    office?: string;
+    /** Set-aside type code(s) (e.g. '8A', 'WOSB'). */
+    setAside?: string | string[];
+    /** SAM.gov notice type(s) (e.g. 'Solicitation', 'Award Notice'). */
+    noticeType?: string | string[];
+    /** Results posted on or after this date (YYYY-MM-DD). */
+    postedAfter?: ISODate;
+    /** Results posted on or before this date (YYYY-MM-DD). */
+    postedBefore?: ISODate;
+    /** Response deadline on or after this date (YYYY-MM-DD). */
+    deadlineAfter?: ISODate;
+    /** Place of performance (2-letter US state code or full state name). */
+    state?: string;
+    /** Minimum award amount in **cents** (integer). */
+    minAward?: number;
+    /** Maximum award amount in **cents** (integer). */
+    maxAward?: number;
+    /** Data source filter (e.g. 'sam.gov'). */
+    dataSource?: string;
+    /** Filter by AI-assigned category (requires enrichment to have run). */
+    aiCategory?: AiCategory;
+    /** Filter by AI-assigned tag(s). */
+    aiTag?: string | string[];
+    /** Filter by AI-assigned difficulty. */
+    aiDifficulty?: AiDifficulty;
+    /** Sort field. Default: 'postedDate'. */
+    sort?: 'postedDate' | 'awardAmount' | 'responseDeadline';
+    /** Sort direction. Default: 'desc'. */
+    dir?: 'asc' | 'desc';
+}
+export interface GetOpportunitiesStatsParams {
+    /** Dimension to group results by. Default: 'department'. */
+    groupBy?: OpportunitiesStatsGroupBy;
+    /** Maximum number of groups to return (1–100). Default: 25. */
+    limit?: number;
+    /** Filter by data source. */
+    dataSource?: string;
+}
+export type ExportFormat = 'ndjson' | 'csv';
+export type ExportStatus = 'pending' | 'running' | 'done' | 'failed';
+export interface CreateExportParams {
+    /** Output format. Developer plan supports CSV only; Professional/Enterprise support all. */
+    format: ExportFormat;
+    /** Same filters as the opportunities search endpoint. */
+    q?: string;
+    naics?: string | string[];
+    agency?: string;
+    setAside?: string | string[];
+    noticeType?: string | string[];
+    postedAfter?: ISODate;
+    postedBefore?: ISODate;
+    state?: string;
+    minAward?: number;
+    maxAward?: number;
+    dataSource?: string;
+    aiCategory?: AiCategory;
+    aiDifficulty?: AiDifficulty;
+}
+export interface ExportJob {
+    exportId: string;
+    status: ExportStatus;
+    format: ExportFormat;
+    createdAt: string;
+    startedAt?: string | null;
+    completedAt?: string | null;
+    outputBytes?: number | null;
+    errorMessage?: string | null;
+}
+export {};
+//# sourceMappingURL=opportunities.d.ts.map

package/dist/types/types/opportunities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"opportunities.d.ts","sourceRoot":"","sources":["../../../src/types/opportunities.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAc,WAAW,EAAE,MAAM,aAAa,CAAC;AAI7E,MAAM,MAAM,UAAU,GAClB,YAAY,GACZ,SAAS,GACT,cAAc,GACd,uBAAuB,GACvB,WAAW,GACX,SAAS,GACT,UAAU,GACV,QAAQ,GACR,eAAe,GACf,oBAAoB,GACpB,2BAA2B,GAC3B,gBAAgB,GAChB,UAAU,GACV,kBAAkB,GAClB,OAAO,CAAC;AAEZ,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAC;AAIlE,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IACrC,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC1B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IACzB,UAAU,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;IAC/B,YAAY,CAAC,EAAE,YAAY,GAAG,IAAI,CAAC;IACnC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAID,MAAM,MAAM,yBAAyB,GACjC,YAAY,GACZ,OAAO,GACP,cAAc,GACd,YAAY,GACZ,YAAY,GACZ,cAAc,CAAC;AAEnB,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,yBAAyB,CAAC;IACnC,KAAK,EAAE,oBAAoB,EAAE,CAAC;CAC/B;AAID,oCAAoC;AACpC,KAAK,OAAO,GAAG,MAAM,CAAC;AAEtB,MAAM,WAAW,uBAAwB,SAAQ,gBAAgB,EAAE,WAAW;IAC5E,8BAA8B;IAC9B,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,kCAAkC;IAClC,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC1B,gDAAgD;IAChD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,qCAAqC;IACrC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kDAAkD;IAClD,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC7B,oEAAoE;IACpE,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC/B,yDAAyD;IACzD,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,0DAA0D;IAC1D,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,4DAA4D;IAC5D,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,wEAAwE;IACxE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,mDAAmD;IACnD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,mDAAmD;IACnD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,2CAA2C;IAC3C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,wEAAwE;IACxE,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,oCAAoC;IACpC,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC1B,wCAAwC;IACxC,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,yCAAyC;IACzC,IAAI,CAAC,EAAE,YAAY,GAAG,aAAa,GAAG,kBAAkB,CAAC;IACzD,uCAAuC;IACvC,GAAG,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,2BAA2B;IAC1C,4DAA4D;IAC5D,OAAO,CAAC,EAAE,yBAAyB,CAAC;IACpC,+DAA+D;IAC/D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,6BAA6B;IAC7B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAID,MAAM,MAAM,YAAY,GAAG,QAAQ,GAAG,KAAK,CAAC;AAC5C,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,SAAS,GAAG,MAAM,GAAG,QAAQ,CAAC;AAErE,MAAM,WAAW,kBAAkB;IACjC,4FAA4F;IAC5F,MAAM,EAAE,YAAY,CAAC;IACrB,yDAAyD;IACzD,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC7B,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC/B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B;AAED,MAAM,WAAW,SAAS;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,YAAY,CAAC;IACrB,MAAM,EAAE,YAAY,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B"}