@cliwant/mcp-sam-gov 1.5.0 → 1.6.0

package/src/sam-gov/index.ts

@@ -1,32 +1,32 @@
-/**
- * Vendored copy of @cliwant/mcp-sam-gov/sam-gov.
- *
- * Why vendored: when `@cliwant/mcp-sam-gov` is installed via
- * `npm install -g github:owner/repo`, npm cannot resolve a nested
- * github dep on Windows reliably (it tries to cd into a non-existent
- * directory during the install transaction). Inlining the source
- * eliminates the nested-github-dep issue entirely and keeps install
- * a pure copy.
- *
- * When both packages are published to npm, this file can become a
- * one-line re-export of the upstream package without any consumer
- * changes (the public API surface is identical).
- *
- * Canonical home: https://github.com/cliwant/mcp-sam-gov
- */
-export {
-  SamGovClient,
-  daysUntilResponse,
-  applyResponseDeadlineWindow,
-} from "./client.js";
-export type {
-  SamOpportunity,
-  SamSearchFilters,
-  SamSearchResult,
-  SamProcurementType,
-  SamSetAside,
-  SamLocation,
-  SamPointOfContact,
-  EntitySearchResult,
-  SamGovClientOptions,
-} from "./types.js";
+/**
+ * Vendored copy of @cliwant/mcp-sam-gov/sam-gov.
+ *
+ * Why vendored: when `@cliwant/mcp-sam-gov` is installed via
+ * `npm install -g github:owner/repo`, npm cannot resolve a nested
+ * github dep on Windows reliably (it tries to cd into a non-existent
+ * directory during the install transaction). Inlining the source
+ * eliminates the nested-github-dep issue entirely and keeps install
+ * a pure copy.
+ *
+ * When both packages are published to npm, this file can become a
+ * one-line re-export of the upstream package without any consumer
+ * changes (the public API surface is identical).
+ *
+ * Canonical home: https://github.com/cliwant/mcp-sam-gov
+ */
+export {
+  SamGovClient,
+  daysUntilResponse,
+  applyResponseDeadlineWindow,
+} from "./client.js";
+export type {
+  SamOpportunity,
+  SamSearchFilters,
+  SamSearchResult,
+  SamProcurementType,
+  SamSetAside,
+  SamLocation,
+  SamPointOfContact,
+  EntitySearchResult,
+  SamGovClientOptions,
+} from "./types.js";

package/src/sam-gov/types.ts

@@ -1,152 +1,152 @@
-/**
- * Core types for the @cliwant/mcp-sam-gov/sam-gov client. Mirrors the shapes
- * returned by SAM.gov's two endpoint layers (authenticated v2 and
- * the keyless public HAL endpoints) under one normalized contract.
- */
-
-export type SamProcurementType =
-  | "u" // Justification
-  | "p" // Pre-solicitation
-  | "a" // Award Notice
-  | "r" // Sources Sought
-  | "s" // Special Notice
-  | "o" // Solicitation
-  | "g" // Sale of Surplus
-  | "k" // Combined Synopsis
-  | "i"; // Intent to Bundle
-
-export type SamSetAside =
-  | "SBA"
-  | "SBP"
-  | "8A"
-  | "8AN"
-  | "HZC"
-  | "HZS"
-  | "SDVOSBC"
-  | "SDVOSBS"
-  | "WOSB"
-  | "WOSBSS"
-  | "EDWOSB"
-  | "EDWOSBSS"
-  | "LAS"
-  | "IEE"
-  | "ISBEE"
-  | "BICiv"
-  | "VSA"
-  | "VSS";
-
-export type SamLocation = {
-  streetAddress?: string;
-  streetAddress2?: string;
-  city?: { code?: string; name?: string };
-  state?: { code?: string; name?: string };
-  zip?: string;
-  country?: { code?: string; name?: string };
-};
-
-export type SamPointOfContact = {
-  type?: string;
-  title?: string;
-  fullName?: string;
-  email?: string;
-  phone?: string;
-  fax?: string | null;
-};
-
-export type SamOpportunity = {
-  noticeId: string;
-  title: string;
-  solicitationNumber?: string;
-  fullParentPathName?: string;
-  fullParentPathCode?: string;
-  postedDate?: string;
-  type?: string;
-  baseType?: string;
-  archiveType?: string;
-  archiveDate?: string | null;
-  typeOfSetAsideDescription?: string | null;
-  typeOfSetAside?: string | null;
-  responseDeadLine?: string | null;
-  naicsCode?: string | null;
-  classificationCode?: string | null;
-  active?: "Yes" | "No";
-  pointOfContact?: SamPointOfContact[] | null;
-  description?: string;
-  placeOfPerformance?: SamLocation | null;
-  uiLink?: string;
-  resourceLinks?: string[] | null;
-  /**
-   * Which enrichment sub-fetches DEGRADED on an outage (subset of
-   * ["attachments", "organization"]). Set ONLY when a sub-fetch's HTTP call
-   * failed (non-200 / network / timeout) — the corresponding field
-   * (`resourceLinks` / `fullParentPathName`) is then empty but UNKNOWN, NOT
-   * confirmed-absent. Additive + optional: a healthy notice (incl. a genuine
-   * 200-empty attachment list or empty org path) NEVER sets it. Tool wrappers
-   * read it to emit an honest `_meta.degraded` + a disclosing note instead of
-   * a silent "no attachments"/"no organization" lie.
-   */
-  enrichmentDegraded?: string[];
-};
-
-export type SamSearchFilters = {
-  query?: string;
-  /** MM/DD/YYYY (auth endpoint convention). */
-  postedFrom?: string;
-  postedTo?: string;
-  ptype?: SamProcurementType[];
-  ncode?: string;
-  setAside?: SamSetAside[];
-  organizationName?: string;
-  state?: string;
-  zip?: string;
-  responseDeadlineFrom?: string;
-  responseDeadlineTo?: string;
-  active?: boolean;
-  limit?: number;
-  offset?: number;
-};
-
-export type SamSearchResult = {
-  totalRecords: number;
-  limit: number;
-  offset: number;
-  opportunitiesData: SamOpportunity[];
-  /**
-   * Set ONLY when the search could not run at all (every access tier threw:
-   * HAL down / network / 5xx-after-retry). It disambiguates a TOTAL OUTAGE
-   * from a GENUINE zero — both otherwise present as
-   * `{ totalRecords: 0, opportunitiesData: [] }`. Additive + optional:
-   * existing readers that ignore it are unaffected; a healthy search (incl.
-   * a real 0 or an empty page past the end) NEVER sets it. Tool wrappers use
-   * it to emit an honest `_meta` (`complete:false`, `totalAvailable:null`,
-   * a disclosing note) instead of the silent "0 notices, complete" lie.
-   */
-  degraded?: { reason: string };
-};
-
-export type EntitySearchResult = {
-  entities: Array<{
-    ueiSAM: string;
-    legalBusinessName: string;
-    cageCode?: string;
-    physicalAddress?: { city?: string; stateOrProvinceCode?: string };
-    naics?: string[];
-    setAsides?: string[];
-    activeRegistration?: boolean;
-  }>;
-  totalRecords: number;
-};
-
-export type SamGovClientOptions = {
-  /** SAM.gov public API key. Optional — keyless public endpoints
-   *  cover ~95% of opportunity discovery without one. Set when you
-   *  need the higher rate limit + the full historical archive. */
-  apiKey?: string;
-  /** Override the User-Agent the client sends to SAM.gov. */
-  userAgent?: string;
-  /** Override the underlying fetch (e.g. with `node-fetch` polyfill or
-   *  a wrapper for caching/retries). Defaults to global `fetch`. */
-  fetch?: typeof fetch;
-  /** Optional logger (defaults to a noop). */
-  logger?: { warn?: (msg: string, err?: unknown) => void };
-};
+/**
+ * Core types for the @cliwant/mcp-sam-gov/sam-gov client. Mirrors the shapes
+ * returned by SAM.gov's two endpoint layers (authenticated v2 and
+ * the keyless public HAL endpoints) under one normalized contract.
+ */
+
+export type SamProcurementType =
+  | "u" // Justification
+  | "p" // Pre-solicitation
+  | "a" // Award Notice
+  | "r" // Sources Sought
+  | "s" // Special Notice
+  | "o" // Solicitation
+  | "g" // Sale of Surplus
+  | "k" // Combined Synopsis
+  | "i"; // Intent to Bundle
+
+export type SamSetAside =
+  | "SBA"
+  | "SBP"
+  | "8A"
+  | "8AN"
+  | "HZC"
+  | "HZS"
+  | "SDVOSBC"
+  | "SDVOSBS"
+  | "WOSB"
+  | "WOSBSS"
+  | "EDWOSB"
+  | "EDWOSBSS"
+  | "LAS"
+  | "IEE"
+  | "ISBEE"
+  | "BICiv"
+  | "VSA"
+  | "VSS";
+
+export type SamLocation = {
+  streetAddress?: string;
+  streetAddress2?: string;
+  city?: { code?: string; name?: string };
+  state?: { code?: string; name?: string };
+  zip?: string;
+  country?: { code?: string; name?: string };
+};
+
+export type SamPointOfContact = {
+  type?: string;
+  title?: string;
+  fullName?: string;
+  email?: string;
+  phone?: string;
+  fax?: string | null;
+};
+
+export type SamOpportunity = {
+  noticeId: string;
+  title: string;
+  solicitationNumber?: string;
+  fullParentPathName?: string;
+  fullParentPathCode?: string;
+  postedDate?: string;
+  type?: string;
+  baseType?: string;
+  archiveType?: string;
+  archiveDate?: string | null;
+  typeOfSetAsideDescription?: string | null;
+  typeOfSetAside?: string | null;
+  responseDeadLine?: string | null;
+  naicsCode?: string | null;
+  classificationCode?: string | null;
+  active?: "Yes" | "No";
+  pointOfContact?: SamPointOfContact[] | null;
+  description?: string;
+  placeOfPerformance?: SamLocation | null;
+  uiLink?: string;
+  resourceLinks?: string[] | null;
+  /**
+   * Which enrichment sub-fetches DEGRADED on an outage (subset of
+   * ["attachments", "organization"]). Set ONLY when a sub-fetch's HTTP call
+   * failed (non-200 / network / timeout) — the corresponding field
+   * (`resourceLinks` / `fullParentPathName`) is then empty but UNKNOWN, NOT
+   * confirmed-absent. Additive + optional: a healthy notice (incl. a genuine
+   * 200-empty attachment list or empty org path) NEVER sets it. Tool wrappers
+   * read it to emit an honest `_meta.degraded` + a disclosing note instead of
+   * a silent "no attachments"/"no organization" lie.
+   */
+  enrichmentDegraded?: string[];
+};
+
+export type SamSearchFilters = {
+  query?: string;
+  /** MM/DD/YYYY (auth endpoint convention). */
+  postedFrom?: string;
+  postedTo?: string;
+  ptype?: SamProcurementType[];
+  ncode?: string;
+  setAside?: SamSetAside[];
+  organizationName?: string;
+  state?: string;
+  zip?: string;
+  responseDeadlineFrom?: string;
+  responseDeadlineTo?: string;
+  active?: boolean;
+  limit?: number;
+  offset?: number;
+};
+
+export type SamSearchResult = {
+  totalRecords: number;
+  limit: number;
+  offset: number;
+  opportunitiesData: SamOpportunity[];
+  /**
+   * Set ONLY when the search could not run at all (every access tier threw:
+   * HAL down / network / 5xx-after-retry). It disambiguates a TOTAL OUTAGE
+   * from a GENUINE zero — both otherwise present as
+   * `{ totalRecords: 0, opportunitiesData: [] }`. Additive + optional:
+   * existing readers that ignore it are unaffected; a healthy search (incl.
+   * a real 0 or an empty page past the end) NEVER sets it. Tool wrappers use
+   * it to emit an honest `_meta` (`complete:false`, `totalAvailable:null`,
+   * a disclosing note) instead of the silent "0 notices, complete" lie.
+   */
+  degraded?: { reason: string };
+};
+
+export type EntitySearchResult = {
+  entities: Array<{
+    ueiSAM: string;
+    legalBusinessName: string;
+    cageCode?: string;
+    physicalAddress?: { city?: string; stateOrProvinceCode?: string };
+    naics?: string[];
+    setAsides?: string[];
+    activeRegistration?: boolean;
+  }>;
+  totalRecords: number;
+};
+
+export type SamGovClientOptions = {
+  /** SAM.gov public API key. Optional — keyless public endpoints
+   *  cover ~95% of opportunity discovery without one. Set when you
+   *  need the higher rate limit + the full historical archive. */
+  apiKey?: string;
+  /** Override the User-Agent the client sends to SAM.gov. */
+  userAgent?: string;
+  /** Override the underlying fetch (e.g. with `node-fetch` polyfill or
+   *  a wrapper for caching/retries). Defaults to global `fetch`. */
+  fetch?: typeof fetch;
+  /** Optional logger (defaults to a noop). */
+  logger?: { warn?: (msg: string, err?: unknown) => void };
+};