@tryfinch/finch-api 2.0.0 → 3.1.0

package/{resources → src/resources}/ats/offers.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '~/core';
-import { APIResource } from '~/resource';
-import { isRequestOptions } from '~/core';
-import * as API from './';
-import { OffersPage, OffersPageParams } from '~/pagination';
+import * as Core from '../../core';
+import { APIResource } from '../../resource';
+import { isRequestOptions } from '../../core';
+import * as API from '.';
+import { OffersPage, OffersPageParams } from '../../pagination';
 
 export class Offers extends APIResource {
   /**

package/{resources → src/resources}/ats/stages.ts

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '~/core';
-import { APIResource } from '~/resource';
-import * as API from './';
-import { SinglePage } from '~/pagination';
+import * as Core from '../../core';
+import { APIResource } from '../../resource';
+import * as API from '.';
+import { SinglePage } from '../../pagination';
 
 export class Stages extends APIResource {
   /**
@@ -18,6 +18,8 @@ export class Stages extends APIResource {
 }
 
 export class StagesSinglePage extends SinglePage<Stage> {}
+// alias so we can export it in the namespace
+type _StagesSinglePage = StagesSinglePage;
 
 export interface Stage {
   id?: string;
@@ -33,5 +35,5 @@ export interface Stage {
 
 export namespace Stages {
   export import Stage = API.Stage;
-  export import StagesSinglePage = API.StagesSinglePage;
+  export type StagesSinglePage = _StagesSinglePage;
 }

package/{resources → src/resources}/hris/benefits/benefits.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '~/core';
-import { APIResource } from '~/resource';
-import { isRequestOptions } from '~/core';
+import * as Core from '../../../core';
+import { APIResource } from '../../../resource';
+import { isRequestOptions } from '../../../core';
 import { Individuals } from './individuals';
-import * as API from './';
-import { SinglePage } from '~/pagination';
+import * as API from '.';
+import { SinglePage } from '../../../pagination';
 
 export class Benefits extends APIResource {
   individuals: Individuals = new Individuals(this.client);
@@ -86,8 +86,12 @@ export class Benefits extends APIResource {
 }
 
 export class CompanyBenefitsSinglePage extends SinglePage<CompanyBenefit> {}
+// alias so we can export it in the namespace
+type _CompanyBenefitsSinglePage = CompanyBenefitsSinglePage;
 
 export class SupportedBenefitsSinglePage extends SinglePage<SupportedBenefit> {}
+// alias so we can export it in the namespace
+type _SupportedBenefitsSinglePage = SupportedBenefitsSinglePage;
 
 export type BenefitFrequency = 'one_time' | 'every_paycheck' | null;
 
@@ -222,8 +226,8 @@ export namespace Benefits {
   export import CreateCompanyBenefitsResponse = API.CreateCompanyBenefitsResponse;
   export import SupportedBenefit = API.SupportedBenefit;
   export import UpdateCompanyBenefitResponse = API.UpdateCompanyBenefitResponse;
-  export import CompanyBenefitsSinglePage = API.CompanyBenefitsSinglePage;
-  export import SupportedBenefitsSinglePage = API.SupportedBenefitsSinglePage;
+  export type CompanyBenefitsSinglePage = _CompanyBenefitsSinglePage;
+  export type SupportedBenefitsSinglePage = _SupportedBenefitsSinglePage;
   export import BenefitCreateParams = API.BenefitCreateParams;
   export import BenefitUpdateParams = API.BenefitUpdateParams;
 

package/{resources → src/resources}/hris/benefits/individuals.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '~/core';
-import { APIResource } from '~/resource';
-import { isRequestOptions } from '~/core';
-import * as Benefits from '~/resources/hris/benefits';
-import * as API from './';
-import { SinglePage } from '~/pagination';
+import * as Core from '../../../core';
+import { APIResource } from '../../../resource';
+import { isRequestOptions } from '../../../core';
+import * as Benefits from './index';
+import * as API from '.';
+import { SinglePage } from '../../../pagination';
 
 export class Individuals extends APIResource {
   /**
@@ -103,10 +103,16 @@ export class Individuals extends APIResource {
 }
 
 export class EnrolledIndividualsSinglePage extends SinglePage<EnrolledIndividual> {}
+// alias so we can export it in the namespace
+type _EnrolledIndividualsSinglePage = EnrolledIndividualsSinglePage;
 
 export class IndividualBenefitsSinglePage extends SinglePage<IndividualBenefit> {}
+// alias so we can export it in the namespace
+type _IndividualBenefitsSinglePage = IndividualBenefitsSinglePage;
 
 export class UnenrolledIndividualsSinglePage extends SinglePage<UnenrolledIndividual> {}
+// alias so we can export it in the namespace
+type _UnenrolledIndividualsSinglePage = UnenrolledIndividualsSinglePage;
 
 export interface EnrolledIndividual {
   body?: EnrolledIndividual.Body;
@@ -239,9 +245,9 @@ export namespace Individuals {
   export import IndividualBenefit = API.IndividualBenefit;
   export import UnenrolledIndividual = API.UnenrolledIndividual;
   export import IndividualEnrolledIDsResponse = API.IndividualEnrolledIDsResponse;
-  export import EnrolledIndividualsSinglePage = API.EnrolledIndividualsSinglePage;
-  export import IndividualBenefitsSinglePage = API.IndividualBenefitsSinglePage;
-  export import UnenrolledIndividualsSinglePage = API.UnenrolledIndividualsSinglePage;
+  export type EnrolledIndividualsSinglePage = _EnrolledIndividualsSinglePage;
+  export type IndividualBenefitsSinglePage = _IndividualBenefitsSinglePage;
+  export type UnenrolledIndividualsSinglePage = _UnenrolledIndividualsSinglePage;
   export import IndividualEnrollManyParams = API.IndividualEnrollManyParams;
   export import IndividualRetrieveManyBenefitsParams = API.IndividualRetrieveManyBenefitsParams;
   export import IndividualUnenrollParams = API.IndividualUnenrollParams;

package/{resources → src/resources}/hris/company.ts

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '~/core';
-import { APIResource } from '~/resource';
-import * as HRIS from '~/resources/hris';
-import * as API from './';
+import * as Core from '../../core';
+import { APIResource } from '../../resource';
+import * as HRIS from './index';
+import * as API from '.';
 
 export class CompanyResource extends APIResource {
   /**

package/{resources → src/resources}/hris/directory.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '~/core';
-import { APIResource } from '~/resource';
-import { isRequestOptions } from '~/core';
-import * as API from './';
-import { IndividualsPage, IndividualsPageParams } from '~/pagination';
+import * as Core from '../../core';
+import { APIResource } from '../../resource';
+import { isRequestOptions } from '../../core';
+import * as API from '.';
+import { IndividualsPage, IndividualsPageParams } from '../../pagination';
 
 export class Directory extends APIResource {
   /**

package/{resources → src/resources}/hris/hris.ts

@@ -1,13 +1,13 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import { APIResource } from '~/resource';
+import { APIResource } from '../../resource';
 import { CompanyResource } from './company';
 import { Payments } from './payments';
 import { PayStatements } from './pay-statements';
 import { Directory } from './directory';
 import { Individuals } from './individuals/individuals';
 import { Benefits } from './benefits/benefits';
-import * as API from './';
+import * as API from '.';
 
 export class HRIS extends APIResource {
   company: CompanyResource = new CompanyResource(this.client);

package/{resources → src/resources}/hris/individuals/employment-data.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '~/core';
-import { APIResource } from '~/resource';
-import * as HRIS from '~/resources/hris';
-import * as API from './';
-import { ResponsesPage } from '~/pagination';
+import * as Core from '../../../core';
+import { APIResource } from '../../../resource';
+import * as HRIS from '../index';
+import * as API from '.';
+import { ResponsesPage } from '../../../pagination';
 
 export class EmploymentData extends APIResource {
   /**
@@ -27,6 +27,8 @@ export class EmploymentData extends APIResource {
 }
 
 export class EmploymentDataResponsesResponsesPage extends ResponsesPage<EmploymentDataResponse> {}
+// alias so we can export it in the namespace
+type _EmploymentDataResponsesResponsesPage = EmploymentDataResponsesResponsesPage;
 
 export interface EmploymentData {
   /**
@@ -182,6 +184,6 @@ export namespace EmploymentDataRetrieveManyParams {
 export namespace EmploymentData {
   export import EmploymentData = API.EmploymentData;
   export import EmploymentDataResponse = API.EmploymentDataResponse;
-  export import EmploymentDataResponsesResponsesPage = API.EmploymentDataResponsesResponsesPage;
+  export type EmploymentDataResponsesResponsesPage = _EmploymentDataResponsesResponsesPage;
   export import EmploymentDataRetrieveManyParams = API.EmploymentDataRetrieveManyParams;
 }

package/{resources → src/resources}/hris/individuals/individuals.ts

@@ -1,12 +1,12 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '~/core';
-import { APIResource } from '~/resource';
-import { isRequestOptions } from '~/core';
-import * as HRIS from '~/resources/hris';
+import * as Core from '../../../core';
+import { APIResource } from '../../../resource';
+import { isRequestOptions } from '../../../core';
+import * as HRIS from '../index';
 import { EmploymentData } from './employment-data';
-import * as API from './';
-import { ResponsesPage } from '~/pagination';
+import * as API from '.';
+import { ResponsesPage } from '../../../pagination';
 
 export class Individuals extends APIResource {
   employmentData: EmploymentData = new EmploymentData(this.client);
@@ -35,6 +35,8 @@ export class Individuals extends APIResource {
 }
 
 export class IndividualResponsesResponsesPage extends ResponsesPage<IndividualResponse> {}
+// alias so we can export it in the namespace
+type _IndividualResponsesResponsesPage = IndividualResponsesResponsesPage;
 
 export interface Individual {
   /**
@@ -123,7 +125,7 @@ export namespace IndividualRetrieveManyParams {
 export namespace Individuals {
   export import Individual = API.Individual;
   export import IndividualResponse = API.IndividualResponse;
-  export import IndividualResponsesResponsesPage = API.IndividualResponsesResponsesPage;
+  export type IndividualResponsesResponsesPage = _IndividualResponsesResponsesPage;
   export import IndividualRetrieveManyParams = API.IndividualRetrieveManyParams;
 
   export import EmploymentData = API.EmploymentData;

package/{resources → src/resources}/hris/pay-statements.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '~/core';
-import { APIResource } from '~/resource';
-import * as HRIS from '~/resources/hris';
-import * as Benefits from '~/resources/hris/benefits';
-import * as API from './';
-import { ResponsesPage } from '~/pagination';
+import * as Core from '../../core';
+import { APIResource } from '../../resource';
+import * as HRIS from './index';
+import * as Benefits from './benefits/index';
+import * as API from '.';
+import { ResponsesPage } from '../../pagination';
 
 export class PayStatements extends APIResource {
   /**
@@ -27,6 +27,8 @@ export class PayStatements extends APIResource {
 }
 
 export class PayStatementResponsesResponsesPage extends ResponsesPage<PayStatementResponse> {}
+// alias so we can export it in the namespace
+type _PayStatementResponsesResponsesPage = PayStatementResponsesResponsesPage;
 
 export interface PayStatement {
   /**
@@ -238,6 +240,6 @@ export namespace PayStatements {
   export import PayStatement = API.PayStatement;
   export import PayStatementResponse = API.PayStatementResponse;
   export import PayStatementResponseBody = API.PayStatementResponseBody;
-  export import PayStatementResponsesResponsesPage = API.PayStatementResponsesResponsesPage;
+  export type PayStatementResponsesResponsesPage = _PayStatementResponsesResponsesPage;
   export import PayStatementRetrieveManyParams = API.PayStatementRetrieveManyParams;
 }

package/{resources → src/resources}/hris/payments.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '~/core';
-import { APIResource } from '~/resource';
-import * as HRIS from '~/resources/hris';
-import * as API from './';
-import { SinglePage } from '~/pagination';
+import * as Core from '../../core';
+import { APIResource } from '../../resource';
+import * as HRIS from './index';
+import * as API from '.';
+import { SinglePage } from '../../pagination';
 
 export class Payments extends APIResource {
   /**
@@ -16,6 +16,8 @@ export class Payments extends APIResource {
 }
 
 export class PaymentsSinglePage extends SinglePage<Payment> {}
+// alias so we can export it in the namespace
+type _PaymentsSinglePage = PaymentsSinglePage;
 
 export interface Payment {
   /**
@@ -75,6 +77,6 @@ export interface PaymentListParams {
 
 export namespace Payments {
   export import Payment = API.Payment;
-  export import PaymentsSinglePage = API.PaymentsSinglePage;
+  export type PaymentsSinglePage = _PaymentsSinglePage;
   export import PaymentListParams = API.PaymentListParams;
 }

package/{resources → src/resources}/providers.ts

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '~/core';
-import { APIResource } from '~/resource';
-import * as API from './';
-import { SinglePage } from '~/pagination';
+import * as Core from '../core';
+import { APIResource } from '../resource';
+import * as API from '.';
+import { SinglePage } from '../pagination';
 
 export class Providers extends APIResource {
   /**
@@ -15,6 +15,8 @@ export class Providers extends APIResource {
 }
 
 export class ProvidersSinglePage extends SinglePage<Provider> {}
+// alias so we can export it in the namespace
+type _ProvidersSinglePage = ProvidersSinglePage;
 
 export interface Provider {
   /**
@@ -61,5 +63,5 @@ export interface Provider {
 
 export namespace Providers {
   export import Provider = API.Provider;
-  export import ProvidersSinglePage = API.ProvidersSinglePage;
+  export type ProvidersSinglePage = _ProvidersSinglePage;
 }

package/{streaming.ts → src/streaming.ts}

@@ -1,5 +1,8 @@
-import type { Response } from '@tryfinch/finch-api/_shims/fetch';
-import { APIResponse, Headers, createResponseHeaders } from '~/core';
+import type { Response } from './_shims/fetch.js';
+
+import { APIResponse, Headers, createResponseHeaders } from './core';
+
+type Bytes = string | ArrayBuffer | Uint8Array | Buffer | null | undefined;
 
 type ServerSentEvent = {
   event: string | null;
@@ -7,6 +10,67 @@ type ServerSentEvent = {
   raw: string[];
 };
 
+export class Stream<Item> implements AsyncIterable<Item>, APIResponse<Stream<Item>> {
+  /** @deprecated - please use the async iterator instead. We plan to add additional helper methods shortly. */
+  response: Response;
+  /** @deprecated - we plan to add a different way to access raw response information shortly. */
+  responseHeaders: Headers;
+  controller: AbortController;
+
+  private decoder: SSEDecoder;
+
+  constructor(response: Response, controller: AbortController) {
+    this.response = response;
+    this.controller = controller;
+    this.decoder = new SSEDecoder();
+    this.responseHeaders = createResponseHeaders(response.headers);
+  }
+
+  private async *iterMessages(): AsyncGenerator<ServerSentEvent, void, unknown> {
+    if (!this.response.body) {
+      this.controller.abort();
+      throw new Error(`Attempted to iterate over a response with no body`);
+    }
+    const lineDecoder = new LineDecoder();
+
+    const iter = readableStreamAsyncIterable<Bytes>(this.response.body);
+    for await (const chunk of iter) {
+      for (const line of lineDecoder.decode(chunk)) {
+        const sse = this.decoder.decode(line);
+        if (sse) yield sse;
+      }
+    }
+
+    for (const line of lineDecoder.flush()) {
+      const sse = this.decoder.decode(line);
+      if (sse) yield sse;
+    }
+  }
+
+  async *[Symbol.asyncIterator](): AsyncIterator<Item, any, undefined> {
+    let done = false;
+    try {
+      for await (const sse of this.iterMessages()) {
+        try {
+          yield JSON.parse(sse.data);
+        } catch (e) {
+          console.error(`Could not parse message into JSON:`, sse.data);
+          console.error(`From chunk:`, sse.raw);
+          throw e;
+        }
+      }
+      done = true;
+    } catch (e) {
+      // If the user calls `stream.controller.abort()`, we should exit without throwing.
+      if (e instanceof Error && e.name === 'AbortError') return;
+      throw e;
+    } finally {
+      // If the user `break`s, abort the ongoing request.
+      if (!done) this.controller.abort();
+    }
+  }
+}
+
 class SSEDecoder {
   private data: string[];
   private event: string | null;
@@ -62,74 +126,6 @@ class SSEDecoder {
   }
 }
 
-export class Stream<Item> implements AsyncIterable<Item>, APIResponse<Stream<Item>> {
-  response: Response;
-  responseHeaders: Headers;
-  controller: AbortController;
-
-  private decoder: SSEDecoder;
-
-  constructor(response: Response, controller: AbortController) {
-    this.response = response;
-    this.controller = controller;
-    this.decoder = new SSEDecoder();
-    this.responseHeaders = createResponseHeaders(response.headers);
-  }
-
-  private async *iterMessages(): AsyncGenerator<ServerSentEvent, void, unknown> {
-    if (!this.response.body) {
-      this.controller.abort();
-      throw new Error(`Attempted to iterate over a response with no body`);
-    }
-
-    const lineDecoder = new LineDecoder();
-
-    for await (const chunk of this.response.body) {
-      let text;
-      if (chunk instanceof Buffer) {
-        text = chunk.toString();
-      } else if ((chunk as any) instanceof Uint8Array) {
-        text = Buffer.from(chunk).toString();
-      } else {
-        text = chunk;
-      }
-
-      for (const line of lineDecoder.decode(text)) {
-        const sse = this.decoder.decode(line);
-        if (sse) yield sse;
-      }
-    }
-
-    for (const line of lineDecoder.flush()) {
-      const sse = this.decoder.decode(line);
-      if (sse) yield sse;
-    }
-  }
-
-  async *[Symbol.asyncIterator](): AsyncIterator<Item, any, undefined> {
-    try {
-      for await (const sse of this.iterMessages()) {
-        try {
-          yield JSON.parse(sse.data);
-        } catch (e) {
-          console.error(`Could not parse message into JSON:`, sse.data);
-          console.error(`From chunk:`, sse.raw);
-          throw e;
-        }
-      }
-    } catch (e) {
-      // If the user calls `stream.controller.abort()`, we should exit without throwing.
-      if (e instanceof Error && e.name === 'AbortError') return;
-      throw e;
-    } finally {
-      // If the user `break`s, abort the ongoing request.
-      this.controller.abort();
-    }
-  }
-}
-
-const NEWLINE_CHARS = '\n\r\x0b\x0c\x1c\x1d\x1e\x85\u2028\u2029';
-
 /**
  * A re-implementation of httpx's `LineDecoder` in Python that handles incrementally
  * reading lines from text.
@@ -137,15 +133,22 @@ const NEWLINE_CHARS = '\n\r\x0b\x0c\x1c\x1d\x1e\x85\u2028\u2029';
  * https://github.com/encode/httpx/blob/920333ea98118e9cf617f246905d7b202510941c/httpx/_decoders.py#L258
  */
 class LineDecoder {
+  // prettier-ignore
+  static NEWLINE_CHARS = new Set(['\n', '\r', '\x0b', '\x0c', '\x1c', '\x1d', '\x1e', '\x85', '\u2028', '\u2029']);
+  static NEWLINE_REGEXP = /\r\n|[\n\r\x0b\x0c\x1c\x1d\x1e\x85\u2028\u2029]/g;
+
   buffer: string[];
   trailingCR: boolean;
+  textDecoder: any; // TextDecoder found in browsers; not typed to avoid pulling in either "dom" or "node" types.
 
   constructor() {
     this.buffer = [];
     this.trailingCR = false;
   }
 
-  decode(text: string): string[] {
+  decode(chunk: Bytes): string[] {
+    let text = this.decodeText(chunk);
+
     if (this.trailingCR) {
       text = '\r' + text;
       this.trailingCR = false;
@@ -159,10 +162,10 @@ class LineDecoder {
       return [];
     }
 
-    const trailing_newline = NEWLINE_CHARS.includes(text.slice(-1));
-    let lines = text.split(/\r\n|[\n\r\x0b\x0c\x1c\x1d\x1e\x85\u2028\u2029]/g);
+    const trailingNewline = LineDecoder.NEWLINE_CHARS.has(text[text.length - 1] || '');
+    let lines = text.split(LineDecoder.NEWLINE_REGEXP);
 
-    if (lines.length === 1 && !trailing_newline) {
+    if (lines.length === 1 && !trailingNewline) {
       this.buffer.push(lines[0]!);
       return [];
     }
@@ -172,13 +175,50 @@ class LineDecoder {
       this.buffer = [];
     }
 
-    if (!trailing_newline) {
+    if (!trailingNewline) {
       this.buffer = [lines.pop() || ''];
     }
 
     return lines;
   }
 
+  decodeText(bytes: Bytes): string {
+    if (bytes == null) return '';
+    if (typeof bytes === 'string') return bytes;
+
+    // Node:
+    if (typeof Buffer !== 'undefined') {
+      if (bytes instanceof Buffer) {
+        return bytes.toString();
+      }
+      if (bytes instanceof Uint8Array) {
+        return Buffer.from(bytes).toString();
+      }
+
+      throw new Error(
+        `Unexpected: received non-Uint8Array (${bytes.constructor.name}) stream chunk in an environment with a global "Buffer" defined, which this library assumes to be Node. Please report this error.`,
+      );
+    }
+
+    // Browser
+    if (typeof TextDecoder !== 'undefined') {
+      if (bytes instanceof Uint8Array || bytes instanceof ArrayBuffer) {
+        this.textDecoder ??= new TextDecoder('utf8');
+        return this.textDecoder.decode(bytes);
+      }
+
+      throw new Error(
+        `Unexpected: received non-Uint8Array/ArrayBuffer (${
+          (bytes as any).constructor.name
+        }) in a web platform. Please report this error.`,
+      );
+    }
+
+    throw new Error(
+      `Unexpected: neither Buffer nor TextDecoder are available as globals. Please report this error.`,
+    );
+  }
+
   flush(): string[] {
     if (!this.buffer.length && !this.trailingCR) {
       return [];
@@ -199,3 +239,36 @@ function partition(str: string, delimiter: string): [string, string, string] {
 
   return [str, '', ''];
 }
+
+/**
+ * Most browsers don't yet have async iterable support for ReadableStream,
+ * and Node has a very different way of reading bytes from its "ReadableStream".
+ *
+ * This polyfill was pulled from https://github.com/MattiasBuelens/web-streams-polyfill/pull/122#issuecomment-1627354490
+ */
+function readableStreamAsyncIterable<T>(stream: any): AsyncIterableIterator<T> {
+  if (stream[Symbol.asyncIterator]) return stream;
+
+  const reader = stream.getReader();
+  return {
+    async next() {
+      try {
+        const result = await reader.read();
+        if (result?.done) reader.releaseLock(); // release lock when stream becomes closed
+        return result;
+      } catch (e) {
+        reader.releaseLock(); // release lock when stream becomes errored
+        throw e;
+      }
+    },
+    async return() {
+      const cancelPromise = reader.cancel();
+      reader.releaseLock();
+      await cancelPromise;
+      return { done: true, value: undefined };
+    },
+    [Symbol.asyncIterator]() {
+      return this;
+    },
+  };
+}