@chadwin/sdk 0.1.0

package/dist/index.js

@@ -0,0 +1,701 @@
+// src/error.ts
+var APIError = class extends Error {
+  status;
+  code;
+  headers;
+  constructor(message, options = {}) {
+    super(message);
+    this.name = "APIError";
+    this.status = options.status;
+    this.code = options.code;
+    this.headers = options.headers;
+  }
+};
+
+// src/promise.ts
+function createPromiseWithResponse(response) {
+  const promise = response.then(({ data }) => data);
+  Object.defineProperty(promise, "withResponse", {
+    value: () => response
+  });
+  void promise.catch(() => void 0);
+  return promise;
+}
+
+// src/internal/transport.ts
+var ATTEMPT_TIMEOUT_MS = 3e4;
+var MAX_RETRIES = 2;
+var BASE_RETRY_DELAY_MS = 250;
+var MAX_RETRY_DELAY_MS = 3e4;
+var PRODUCTION_BASE_URL = "https://api.chadwin.co";
+var INVALID_BASE_URL_MESSAGE = "baseURL must be an HTTP or HTTPS URL without credentials, a query, or a fragment";
+var SAFE_ERROR_CODE = /^[a-z][a-z0-9_]{0,63}$/;
+var AttemptFailure = class extends Error {
+  constructor(timedOut) {
+    super(timedOut ? "Request timed out" : "Network request failed");
+    this.timedOut = timedOut;
+  }
+  timedOut;
+};
+var HttpTransport = class {
+  #apiKey;
+  #fetch;
+  #baseURL;
+  constructor(options) {
+    this.#apiKey = options.apiKey;
+    this.#baseURL = normalizeBaseURL(options.baseURL ?? PRODUCTION_BASE_URL);
+    this.#fetch = options.fetch ?? ((input, init) => globalThis.fetch(input, init));
+  }
+  request(request) {
+    return createPromiseWithResponse(this.#performRequest(request));
+  }
+  async #performRequest(request) {
+    const url = buildUrl(this.#baseURL, request);
+    let lastFailureWasTimeout = false;
+    for (let attempt = 0; attempt <= MAX_RETRIES; attempt += 1) {
+      let result;
+      try {
+        result = await this.#attempt(url, request.responseType ?? "json");
+      } catch (error) {
+        if (error instanceof APIError) {
+          throw error;
+        }
+        if (!(error instanceof AttemptFailure)) {
+          throw new APIError("API request failed");
+        }
+        lastFailureWasTimeout = error.timedOut;
+        if (attempt === MAX_RETRIES) {
+          throw new APIError(
+            lastFailureWasTimeout ? "API request timed out" : "API request failed"
+          );
+        }
+        await wait(backoffDelay(attempt));
+        continue;
+      }
+      if ("data" in result) {
+        return result;
+      }
+      if (shouldRetry(result.response.status, result.code) && attempt < MAX_RETRIES) {
+        await wait(retryDelay(result.response, attempt));
+        continue;
+      }
+      throw errorFromResponse(result.response, result.code, this.#apiKey);
+    }
+    throw new APIError(
+      lastFailureWasTimeout ? "API request timed out" : "API request failed"
+    );
+  }
+  async #attempt(url, responseType) {
+    const controller = new AbortController();
+    let timedOut = false;
+    const timeout = setTimeout(() => {
+      timedOut = true;
+      controller.abort();
+    }, ATTEMPT_TIMEOUT_MS);
+    try {
+      let response;
+      try {
+        response = await this.#fetch(url, {
+          headers: {
+            authorization: `Bearer ${this.#apiKey}`
+          },
+          method: "GET",
+          signal: controller.signal
+        });
+      } catch {
+        throw new AttemptFailure(timedOut);
+      }
+      if (!response.ok) {
+        return {
+          code: await readErrorCode(response, this.#apiKey),
+          response
+        };
+      }
+      try {
+        const data = responseType === "text" ? await response.text() : await response.json();
+        return { data, response };
+      } catch (error) {
+        if (responseType === "json" && error instanceof SyntaxError) {
+          throw new APIError("API returned an invalid JSON response", {
+            headers: safeErrorHeaders(response.headers, this.#apiKey),
+            status: response.status
+          });
+        }
+        throw new APIError("API returned an invalid response body", {
+          headers: safeErrorHeaders(response.headers, this.#apiKey),
+          status: response.status
+        });
+      }
+    } finally {
+      clearTimeout(timeout);
+    }
+  }
+};
+function normalizeBaseURL(value) {
+  let url;
+  try {
+    url = new URL(value);
+  } catch {
+    throw new TypeError(INVALID_BASE_URL_MESSAGE);
+  }
+  if (url.protocol !== "http:" && url.protocol !== "https:" || url.username || url.password || url.href !== `${url.origin}${url.pathname}`) {
+    throw new TypeError(INVALID_BASE_URL_MESSAGE);
+  }
+  url.pathname = `${url.pathname.replace(/\/+$/, "")}/`;
+  return url;
+}
+function buildUrl(baseURL, request) {
+  const path = request.path.map((segment) => encodeURIComponent(segment)).join("/");
+  const url = new URL(path, baseURL);
+  for (const [key, value] of Object.entries(request.query ?? {})) {
+    if (value === void 0 || value === null) continue;
+    const values = Array.isArray(value) ? value : [value];
+    for (const entry of values) {
+      url.searchParams.append(key, String(entry));
+    }
+  }
+  return url;
+}
+async function readErrorCode(response, apiKey) {
+  try {
+    const body = await response.json();
+    if (body !== null && typeof body === "object" && "error" in body && typeof body.error === "string" && body.error !== apiKey && SAFE_ERROR_CODE.test(body.error)) {
+      return body.error;
+    }
+  } catch {
+  }
+  return void 0;
+}
+function shouldRetry(status, code) {
+  if (code === "billing_period_quota_exceeded") return false;
+  return code === "rate_limited" || status === 502 || status === 503 || status === 504;
+}
+function retryDelay(response, retry) {
+  const retryAfter = response.headers.get("retry-after");
+  if (retryAfter === null) return backoffDelay(retry);
+  const seconds = Number(retryAfter);
+  if (Number.isFinite(seconds) && seconds >= 0) {
+    return Math.min(seconds * 1e3, MAX_RETRY_DELAY_MS);
+  }
+  const date = Date.parse(retryAfter);
+  if (!Number.isNaN(date)) {
+    return Math.min(Math.max(0, date - Date.now()), MAX_RETRY_DELAY_MS);
+  }
+  return backoffDelay(retry);
+}
+function backoffDelay(retry) {
+  return Math.min(BASE_RETRY_DELAY_MS * 2 ** retry, MAX_RETRY_DELAY_MS);
+}
+function wait(milliseconds) {
+  return new Promise((resolve) => setTimeout(resolve, milliseconds));
+}
+function errorFromResponse(response, code, apiKey) {
+  const suffix = code ? ` (${code})` : "";
+  return new APIError(
+    `API request failed with status ${response.status}${suffix}`,
+    {
+      ...code === void 0 ? {} : { code },
+      headers: safeErrorHeaders(response.headers, apiKey),
+      status: response.status
+    }
+  );
+}
+function safeErrorHeaders(headers, apiKey) {
+  const safe = new Headers();
+  for (const [name, value] of headers) {
+    const normalizedName = name.toLowerCase();
+    if (normalizedName === "authorization" || normalizedName === "cookie" || normalizedName === "proxy-authorization" || normalizedName === "set-cookie" || value.includes(apiKey)) {
+      continue;
+    }
+    safe.append(name, value);
+  }
+  return safe;
+}
+
+// src/resources/feeds.ts
+var Feeds = class {
+  companyReports;
+  insiderActivity;
+  insiderTransactions;
+  institutionalFilings;
+  constructor(transport) {
+    this.companyReports = new CompanyReportFeed(transport);
+    this.insiderActivity = new InsiderActivityFeed(transport);
+    this.insiderTransactions = new InsiderTransactionFeed(transport);
+    this.institutionalFilings = new InstitutionalFilingFeed(transport);
+  }
+};
+var CompanyReportFeed = class {
+  constructor(transport) {
+    this.transport = transport;
+  }
+  transport;
+  listLatest(filters = {}) {
+    return this.#request(filters, {});
+  }
+  listAfter({
+    cursor,
+    ...filters
+  }) {
+    return this.#request(filters, { cursor });
+  }
+  startFromNow(filters = {}) {
+    return this.#request(filters, { start: "now" });
+  }
+  #request(filters, mode) {
+    return this.transport.request({
+      path: ["v1", "company-reports", "feed"],
+      query: {
+        ...mode,
+        forms: filters.forms?.join(","),
+        limit: filters.limit
+      }
+    });
+  }
+};
+var InsiderActivityFeed = class {
+  constructor(transport) {
+    this.transport = transport;
+  }
+  transport;
+  listLatest(filters = {}) {
+    return this.#request(filters, {});
+  }
+  listAfter({
+    cursor,
+    ...filters
+  }) {
+    return this.#request(filters, { cursor });
+  }
+  startFromNow(filters = {}) {
+    return this.#request(filters, { start: "now" });
+  }
+  #request(filters, mode) {
+    return this.transport.request({
+      path: ["v1", "insider-activity", "feed"],
+      query: {
+        ...mode,
+        forms: filters.forms?.join(","),
+        limit: filters.limit
+      }
+    });
+  }
+};
+var InsiderTransactionFeed = class {
+  constructor(transport) {
+    this.transport = transport;
+  }
+  transport;
+  listLatest(filters = {}) {
+    return this.#request(filters, {});
+  }
+  listAfter({
+    cursor,
+    ...filters
+  }) {
+    return this.#request(filters, { cursor });
+  }
+  startFromNow(filters = {}) {
+    return this.#request(filters, { start: "now" });
+  }
+  #request(filters, mode) {
+    return this.transport.request({
+      path: ["v1", "insider-transactions", "feed"],
+      query: {
+        ...mode,
+        limit: filters.limit,
+        transaction_codes: filters.transactionCodes?.join(",")
+      }
+    });
+  }
+};
+var InstitutionalFilingFeed = class {
+  constructor(transport) {
+    this.transport = transport;
+  }
+  transport;
+  listLatest(filters = {}) {
+    return this.#request(filters, {});
+  }
+  listAfter({
+    cursor,
+    ...filters
+  }) {
+    return this.#request(filters, { cursor });
+  }
+  startFromNow(filters = {}) {
+    return this.#request(filters, { start: "now" });
+  }
+  #request(filters, mode) {
+    return this.transport.request({
+      path: ["v1", "institutional-holdings", "feed"],
+      query: {
+        ...mode,
+        forms: filters.forms?.join(","),
+        limit: filters.limit
+      }
+    });
+  }
+};
+
+// src/resources/products.ts
+var Companies = class {
+  constructor(transport) {
+    this.transport = transport;
+  }
+  transport;
+  search({ query }) {
+    return this.transport.request({
+      path: ["v1", "companies", "US", "search"],
+      query: { query }
+    });
+  }
+  get({ ticker }) {
+    return this.transport.request({
+      path: ["v1", "companies", "US", ticker]
+    });
+  }
+};
+var CompanyReports = class {
+  constructor(transport) {
+    this.transport = transport;
+  }
+  transport;
+  get({
+    accessionNumber
+  }) {
+    return this.transport.request({
+      path: ["v1", "sec", "company-reports", accessionNumber]
+    });
+  }
+  getByFiscalYear({
+    ticker,
+    fiscalYear
+  }) {
+    return this.transport.request({
+      path: [
+        "v1",
+        "companies",
+        "US",
+        ticker,
+        "reports",
+        "annual",
+        String(fiscalYear)
+      ]
+    });
+  }
+  getHtml({
+    accessionNumber
+  }) {
+    return this.transport.request({
+      path: [
+        "v1",
+        "sec",
+        "company-reports",
+        accessionNumber,
+        "content.html"
+      ],
+      responseType: "text"
+    });
+  }
+};
+var InsiderTransactions = class {
+  constructor(transport) {
+    this.transport = transport;
+  }
+  transport;
+  list({
+    filingDateFrom,
+    filingDateUntil,
+    tickers,
+    transactionCodes
+  }) {
+    return this.transport.request({
+      path: ["v1", "insider-transactions"],
+      query: {
+        from: filingDateFrom,
+        tickers: commaSeparated(tickers),
+        transaction_codes: commaSeparated(transactionCodes),
+        until: filingDateUntil
+      }
+    });
+  }
+  listForCompany({
+    ticker,
+    filingDateFrom,
+    filingDateUntil,
+    transactionCodes
+  }) {
+    return this.transport.request({
+      path: ["v1", "companies", "US", ticker, "insider-transactions"],
+      query: {
+        from: filingDateFrom,
+        transaction_codes: commaSeparated(transactionCodes),
+        until: filingDateUntil
+      }
+    });
+  }
+};
+var InsiderFilings = class {
+  constructor(transport) {
+    this.transport = transport;
+  }
+  transport;
+  get({
+    accessionNumber
+  }) {
+    return this.transport.request({
+      path: ["v1", "sec", "insider-filings", accessionNumber]
+    });
+  }
+};
+var ProposedSales = class {
+  constructor(transport) {
+    this.transport = transport;
+  }
+  transport;
+  list({
+    filingDateFrom,
+    filingDateUntil,
+    tickers
+  }) {
+    return this.transport.request({
+      path: ["v1", "proposed-sales"],
+      query: {
+        from: filingDateFrom,
+        tickers: commaSeparated(tickers),
+        until: filingDateUntil
+      }
+    });
+  }
+  listForCompany({
+    ticker,
+    filingDateFrom,
+    filingDateUntil
+  }) {
+    return this.transport.request({
+      path: ["v1", "companies", "US", ticker, "proposed-sales"],
+      query: { from: filingDateFrom, until: filingDateUntil }
+    });
+  }
+  getFiling({
+    accessionNumber
+  }) {
+    return this.transport.request({
+      path: ["v1", "sec", "proposed-sales", accessionNumber]
+    });
+  }
+};
+var InstitutionalFilings = class {
+  constructor(transport) {
+    this.transport = transport;
+  }
+  transport;
+  get({
+    accessionNumber
+  }) {
+    return this.transport.request({
+      path: ["v1", "sec", "institutional-filings", accessionNumber]
+    });
+  }
+  listHoldings({
+    accessionNumber,
+    cursor,
+    limit
+  }) {
+    return this.transport.request({
+      path: [
+        "v1",
+        "sec",
+        "institutional-filings",
+        accessionNumber,
+        "holdings"
+      ],
+      query: { cursor, limit }
+    });
+  }
+  async *iterateHoldings({
+    accessionNumber,
+    limit
+  }) {
+    let cursor;
+    do {
+      const page = await this.listHoldings({
+        accessionNumber,
+        ...cursor === void 0 ? {} : { cursor },
+        ...limit === void 0 ? {} : { limit }
+      });
+      yield* page.holdings;
+      cursor = page.next_cursor ?? void 0;
+    } while (cursor !== void 0);
+  }
+};
+var InstitutionalManagers = class {
+  constructor(transport) {
+    this.transport = transport;
+  }
+  transport;
+  list({
+    cik,
+    form13fFileNumber,
+    cursor,
+    limit
+  } = {}) {
+    return this.transport.request({
+      path: ["v1", "institutional-holdings", "managers"],
+      query: {
+        cik,
+        cursor,
+        form_13f_file_number: form13fFileNumber,
+        limit
+      }
+    });
+  }
+  get({
+    form13fFileNumber
+  }) {
+    return this.transport.request({
+      path: [
+        "v1",
+        "institutional-holdings",
+        "managers",
+        form13fFileNumber
+      ]
+    });
+  }
+  listPeriods({
+    form13fFileNumber
+  }) {
+    return this.transport.request({
+      path: [
+        "v1",
+        "institutional-holdings",
+        "managers",
+        form13fFileNumber,
+        "periods"
+      ]
+    });
+  }
+  listHoldings({
+    form13fFileNumber,
+    reportPeriod,
+    cursor,
+    limit
+  }) {
+    return this.transport.request({
+      path: [
+        "v1",
+        "institutional-holdings",
+        "managers",
+        form13fFileNumber,
+        "holdings"
+      ],
+      query: { cursor, limit, period: reportPeriod }
+    });
+  }
+  listPositions({
+    form13fFileNumber,
+    reportPeriod,
+    cursor,
+    limit
+  }) {
+    return this.transport.request({
+      path: [
+        "v1",
+        "institutional-holdings",
+        "managers",
+        form13fFileNumber,
+        "positions"
+      ],
+      query: { cursor, limit, period: reportPeriod }
+    });
+  }
+  async *iterate({
+    cik,
+    form13fFileNumber,
+    limit
+  } = {}) {
+    let cursor;
+    do {
+      const page = await this.list({
+        ...cik === void 0 ? {} : { cik },
+        ...cursor === void 0 ? {} : { cursor },
+        ...form13fFileNumber === void 0 ? {} : { form13fFileNumber },
+        ...limit === void 0 ? {} : { limit }
+      });
+      yield* page.managers;
+      cursor = page.next_cursor ?? void 0;
+    } while (cursor !== void 0);
+  }
+  async *iterateHoldings({
+    form13fFileNumber,
+    reportPeriod,
+    limit
+  }) {
+    let cursor;
+    do {
+      const page = await this.listHoldings({
+        form13fFileNumber,
+        reportPeriod,
+        ...cursor === void 0 ? {} : { cursor },
+        ...limit === void 0 ? {} : { limit }
+      });
+      yield* page.holdings;
+      cursor = page.next_cursor ?? void 0;
+    } while (cursor !== void 0);
+  }
+  async *iteratePositions({
+    form13fFileNumber,
+    reportPeriod,
+    limit
+  }) {
+    let cursor;
+    do {
+      const page = await this.listPositions({
+        form13fFileNumber,
+        reportPeriod,
+        ...cursor === void 0 ? {} : { cursor },
+        ...limit === void 0 ? {} : { limit }
+      });
+      yield* page.positions;
+      cursor = page.next_cursor ?? void 0;
+    } while (cursor !== void 0);
+  }
+};
+function commaSeparated(values) {
+  return values?.join(",");
+}
+
+// src/client.ts
+var Chadwin = class {
+  companies;
+  companyReports;
+  feeds;
+  insiderFilings;
+  insiderTransactions;
+  institutionalFilings;
+  institutionalManagers;
+  proposedSales;
+  constructor(options) {
+    if (!options || typeof options.apiKey !== "string" || options.apiKey.trim().length === 0) {
+      throw new TypeError("A non-empty Chadwin API key is required");
+    }
+    const transport = new HttpTransport({
+      apiKey: options.apiKey,
+      ...options.baseURL === void 0 ? {} : { baseURL: options.baseURL }
+    });
+    this.companies = new Companies(transport);
+    this.companyReports = new CompanyReports(transport);
+    this.feeds = new Feeds(transport);
+    this.insiderFilings = new InsiderFilings(transport);
+    this.insiderTransactions = new InsiderTransactions(transport);
+    this.institutionalFilings = new InstitutionalFilings(transport);
+    this.institutionalManagers = new InstitutionalManagers(transport);
+    this.proposedSales = new ProposedSales(transport);
+  }
+};
+export {
+  APIError,
+  Chadwin
+};
+//# sourceMappingURL=index.js.map