graphor 0.4.1 → 0.4.2

package/src/client.ts

@@ -17,7 +17,7 @@ import * as Uploads from './core/uploads';
 import * as API from './resources/index';
 import { APIPromise } from './core/api-promise';
 import {
-  PartitionMethod,
+  PublicPartitionMethod,
   PublicSource,
   SourceAskParams,
   SourceAskResponse,
@@ -52,14 +52,14 @@ import { isEmptyObj } from './internal/utils/values';
 
 export interface ClientOptions {
   /**
-   * Defaults to process.env['GRAPHOR_API_KEY'].
+   * Defaults to process.env['GRAPHOR_PRD_API_KEY'].
    */
-  apiKey?: string | null | undefined;
+  apiKey?: string | undefined;
 
   /**
    * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
    *
-   * Defaults to process.env['GRAPHOR_BASE_URL'].
+   * Defaults to process.env['GRAPHOR_PRD_BASE_URL'].
    */
   baseURL?: string | null | undefined;
 
@@ -113,7 +113,7 @@ export interface ClientOptions {
   /**
    * Set the log level.
    *
-   * Defaults to process.env['GRAPHOR_LOG'] or 'warn' if it isn't set.
+   * Defaults to process.env['GRAPHOR_PRD_LOG'] or 'warn' if it isn't set.
    */
   logLevel?: LogLevel | undefined;
 
@@ -126,10 +126,10 @@ export interface ClientOptions {
 }
 
 /**
- * API Client for interfacing with the Graphor API.
+ * API Client for interfacing with the Graphor Prd API.
  */
-export class Graphor {
-  apiKey: string | null;
+export class GraphorPrd {
+  apiKey: string;
 
   baseURL: string;
   maxRetries: number;
@@ -144,10 +144,10 @@ export class Graphor {
   private _options: ClientOptions;
 
   /**
-   * API Client for interfacing with the Graphor API.
+   * API Client for interfacing with the Graphor Prd API.
    *
-   * @param {string | null | undefined} [opts.apiKey=process.env['GRAPHOR_API_KEY'] ?? null]
-   * @param {string} [opts.baseURL=process.env['GRAPHOR_BASE_URL'] ?? https://api.graphorlm.com/api/public/v1] - Override the default base URL for the API.
+   * @param {string | undefined} [opts.apiKey=process.env['GRAPHOR_PRD_API_KEY'] ?? undefined]
+   * @param {string} [opts.baseURL=process.env['GRAPHOR_PRD_BASE_URL'] ?? https://graphorlm.com/api/public/v1] - Override the default base URL for the API.
    * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
    * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
    * @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
@@ -156,25 +156,31 @@ export class Graphor {
    * @param {Record<string, string | undefined>} opts.defaultQuery - Default query parameters to include with every request to the API.
    */
   constructor({
-    baseURL = readEnv('GRAPHOR_BASE_URL'),
-    apiKey = readEnv('GRAPHOR_API_KEY') ?? null,
+    baseURL = readEnv('GRAPHOR_PRD_BASE_URL'),
+    apiKey = readEnv('GRAPHOR_PRD_API_KEY'),
     ...opts
   }: ClientOptions = {}) {
+    if (apiKey === undefined) {
+      throw new Errors.GraphorPrdError(
+        "The GRAPHOR_PRD_API_KEY environment variable is missing or empty; either provide it, or instantiate the GraphorPrd client with an apiKey option, like new GraphorPrd({ apiKey: 'My API Key' }).",
+      );
+    }
+
     const options: ClientOptions = {
       apiKey,
       ...opts,
-      baseURL: baseURL || `https://api.graphorlm.com/api/public/v1`,
+      baseURL: baseURL || `https://graphorlm.com/api/public/v1`,
     };
 
     this.baseURL = options.baseURL!;
-    this.timeout = options.timeout ?? Graphor.DEFAULT_TIMEOUT /* 1 minute */;
+    this.timeout = options.timeout ?? GraphorPrd.DEFAULT_TIMEOUT /* 1 minute */;
     this.logger = options.logger ?? console;
     const defaultLogLevel = 'warn';
     // Set default logLevel early so that we can log a warning in parseLogLevel.
     this.logLevel = defaultLogLevel;
     this.logLevel =
       parseLogLevel(options.logLevel, 'ClientOptions.logLevel', this) ??
-      parseLogLevel(readEnv('GRAPHOR_LOG'), "process.env['GRAPHOR_LOG']", this) ??
+      parseLogLevel(readEnv('GRAPHOR_PRD_LOG'), "process.env['GRAPHOR_PRD_LOG']", this) ??
       defaultLogLevel;
     this.fetchOptions = options.fetchOptions;
     this.maxRetries = options.maxRetries ?? 2;
@@ -209,7 +215,7 @@ export class Graphor {
    * Check whether the base URL is set to its default.
    */
   #baseURLOverridden(): boolean {
-    return this.baseURL !== 'https://api.graphorlm.com/api/public/v1';
+    return this.baseURL !== 'https://graphorlm.com/api/public/v1';
   }
 
   protected defaultQuery(): Record<string, string | undefined> | undefined {
@@ -217,22 +223,10 @@ export class Graphor {
   }
 
   protected validateHeaders({ values, nulls }: NullableHeaders) {
-    if (this.apiKey && values.get('authorization')) {
-      return;
-    }
-    if (nulls.has('authorization')) {
-      return;
-    }
-
-    throw new Error(
-      'Could not resolve authentication method. Expected the apiKey to be set. Or for the "Authorization" headers to be explicitly omitted',
-    );
+    return;
   }
 
   protected async authHeaders(opts: FinalRequestOptions): Promise<NullableHeaders | undefined> {
-    if (this.apiKey == null) {
-      return undefined;
-    }
     return buildHeaders([{ Authorization: `Bearer ${this.apiKey}` }]);
   }
 
@@ -249,7 +243,7 @@ export class Graphor {
         if (value === null) {
           return `${encodeURIComponent(key)}=`;
         }
-        throw new Errors.GraphorError(
+        throw new Errors.GraphorPrdError(
           `Cannot stringify type ${typeof value}; Expected string, number, boolean, or null. If you need to pass nested query parameters, you can manually encode them, e.g. { query: { 'foo[key1]': value1, 'foo[key2]': value2 } }, and please open a GitHub issue requesting better support for your use case.`,
         );
       })
@@ -515,7 +509,7 @@ export class Graphor {
     controller: AbortController,
   ): Promise<Response> {
     const { signal, method, ...options } = init || {};
-    const abort = controller.abort.bind(controller);
+    const abort = this._makeAbort(controller);
     if (signal) signal.addEventListener('abort', abort, { once: true });
 
     const timeout = setTimeout(abort, ms);
@@ -685,6 +679,12 @@ export class Graphor {
     return headers.values;
   }
 
+  private _makeAbort(controller: AbortController) {
+    // note: we can't just inline this method inside `fetchWithTimeout()` because then the closure
+    //       would capture all request options, and cause a memory leak.
+    return () => controller.abort();
+  }
+
   private buildBody({ options: { body, headers: rawHeaders } }: { options: FinalRequestOptions }): {
     bodyHeaders: HeadersLike;
     body: BodyInit | undefined;
@@ -722,10 +722,10 @@ export class Graphor {
     }
   }
 
-  static Graphor = this;
+  static GraphorPrd = this;
   static DEFAULT_TIMEOUT = 60000; // 1 minute
 
-  static GraphorError = Errors.GraphorError;
+  static GraphorPrdError = Errors.GraphorPrdError;
   static APIError = Errors.APIError;
   static APIConnectionError = Errors.APIConnectionError;
   static APIConnectionTimeoutError = Errors.APIConnectionTimeoutError;
@@ -744,14 +744,14 @@ export class Graphor {
   sources: API.Sources = new API.Sources(this);
 }
 
-Graphor.Sources = Sources;
+GraphorPrd.Sources = Sources;
 
-export declare namespace Graphor {
+export declare namespace GraphorPrd {
   export type RequestOptions = Opts.RequestOptions;
 
   export {
     Sources as Sources,
-    type PartitionMethod as PartitionMethod,
+    type PublicPartitionMethod as PublicPartitionMethod,
     type PublicSource as PublicSource,
     type SourceListResponse as SourceListResponse,
     type SourceDeleteResponse as SourceDeleteResponse,

package/src/core/api-promise.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { type Graphor } from '../client';
+import { type GraphorPrd } from '../client';
 
 import { type PromiseOrValue } from '../internal/types';
 import { APIResponseProps, defaultParseResponse } from '../internal/parse';
@@ -11,13 +11,13 @@ import { APIResponseProps, defaultParseResponse } from '../internal/parse';
  */
 export class APIPromise<T> extends Promise<T> {
   private parsedPromise: Promise<T> | undefined;
-  #client: Graphor;
+  #client: GraphorPrd;
 
   constructor(
-    client: Graphor,
+    client: GraphorPrd,
     private responsePromise: Promise<APIResponseProps>,
     private parseResponse: (
-      client: Graphor,
+      client: GraphorPrd,
       props: APIResponseProps,
     ) => PromiseOrValue<T> = defaultParseResponse,
   ) {

package/src/core/error.ts

@@ -2,13 +2,13 @@
 
 import { castToError } from '../internal/errors';
 
-export class GraphorError extends Error {}
+export class GraphorPrdError extends Error {}
 
 export class APIError<
   TStatus extends number | undefined = number | undefined,
   THeaders extends Headers | undefined = Headers | undefined,
   TError extends Object | undefined = Object | undefined,
-> extends GraphorError {
+> extends GraphorPrdError {
   /** HTTP status for the response that caused the error */
   readonly status: TStatus;
   /** HTTP headers for the response that caused the error */

package/src/core/resource.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import type { Graphor } from '../client';
+import type { GraphorPrd } from '../client';
 
 export abstract class APIResource {
-  protected _client: Graphor;
+  protected _client: GraphorPrd;
 
-  constructor(client: Graphor) {
+  constructor(client: GraphorPrd) {
     this._client = client;
   }
 }

package/src/index.ts

@@ -1,12 +1,12 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { Graphor as default } from './client';
+export { GraphorPrd as default } from './client';
 
 export { type Uploadable, toFile } from './core/uploads';
 export { APIPromise } from './core/api-promise';
-export { Graphor, type ClientOptions } from './client';
+export { GraphorPrd, type ClientOptions } from './client';
 export {
-  GraphorError,
+  GraphorPrdError,
   APIError,
   APIConnectionError,
   APIConnectionTimeoutError,

package/src/internal/parse.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import type { FinalRequestOptions } from './request-options';
-import { type Graphor } from '../client';
+import { type GraphorPrd } from '../client';
 import { formatRequestDetails, loggerFor } from './utils/log';
 
 export type APIResponseProps = {
@@ -13,7 +13,7 @@ export type APIResponseProps = {
   startTime: number;
 };
 
-export async function defaultParseResponse<T>(client: Graphor, props: APIResponseProps): Promise<T> {
+export async function defaultParseResponse<T>(client: GraphorPrd, props: APIResponseProps): Promise<T> {
   const { response, requestLogID, retryOfRequestLogID, startTime } = props;
   const body = await (async () => {
     // fetch refuses to read the body when the status code is 204.

package/src/internal/shims.ts

@@ -16,7 +16,7 @@ export function getDefaultFetch(): Fetch {
   }
 
   throw new Error(
-    '`fetch` is not defined as a global; Either pass `fetch` to the client, `new Graphor({ fetch })` or polyfill the global, `globalThis.fetch = fetch`',
+    '`fetch` is not defined as a global; Either pass `fetch` to the client, `new GraphorPrd({ fetch })` or polyfill the global, `globalThis.fetch = fetch`',
   );
 }
 

package/src/internal/uploads.ts

@@ -1,6 +1,6 @@
 import { type RequestOptions } from './request-options';
 import type { FilePropertyBag, Fetch } from './builtin-types';
-import type { Graphor } from '../client';
+import type { GraphorPrd } from '../client';
 import { ReadableStreamFrom } from './shims';
 
 export type BlobPart = string | ArrayBuffer | ArrayBufferView | Blob | DataView;
@@ -74,7 +74,7 @@ export const isAsyncIterable = (value: any): value is AsyncIterable<any> =>
  */
 export const maybeMultipartFormRequestOptions = async (
   opts: RequestOptions,
-  fetch: Graphor | Fetch,
+  fetch: GraphorPrd | Fetch,
 ): Promise<RequestOptions> => {
   if (!hasUploadableValue(opts.body)) return opts;
 
@@ -85,7 +85,7 @@ type MultipartFormRequestOptions = Omit<RequestOptions, 'body'> & { body: unknow
 
 export const multipartFormRequestOptions = async (
   opts: MultipartFormRequestOptions,
-  fetch: Graphor | Fetch,
+  fetch: GraphorPrd | Fetch,
 ): Promise<RequestOptions> => {
   return { ...opts, body: await createForm(opts.body, fetch) };
 };
@@ -98,7 +98,7 @@ const supportsFormDataMap = /* @__PURE__ */ new WeakMap<Fetch, Promise<boolean>>
  * This function detects if the fetch function provided supports the global FormData object to avoid
  * confusing error messages later on.
  */
-function supportsFormData(fetchObject: Graphor | Fetch): Promise<boolean> {
+function supportsFormData(fetchObject: GraphorPrd | Fetch): Promise<boolean> {
   const fetch: Fetch = typeof fetchObject === 'function' ? fetchObject : (fetchObject as any).fetch;
   const cached = supportsFormDataMap.get(fetch);
   if (cached) return cached;
@@ -124,7 +124,7 @@ function supportsFormData(fetchObject: Graphor | Fetch): Promise<boolean> {
 
 export const createForm = async <T = Record<string, unknown>>(
   body: T | undefined,
-  fetch: Graphor | Fetch,
+  fetch: GraphorPrd | Fetch,
 ): Promise<FormData> => {
   if (!(await supportsFormData(fetch))) {
     throw new TypeError(

package/src/internal/utils/base64.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { GraphorError } from '../../core/error';
+import { GraphorPrdError } from '../../core/error';
 import { encodeUTF8 } from './bytes';
 
 export const toBase64 = (data: string | Uint8Array | null | undefined): string => {
@@ -18,7 +18,7 @@ export const toBase64 = (data: string | Uint8Array | null | undefined): string =
     return btoa(String.fromCharCode.apply(null, data as any));
   }
 
-  throw new GraphorError('Cannot generate base64 string; Expected `Buffer` or `btoa` to be defined');
+  throw new GraphorPrdError('Cannot generate base64 string; Expected `Buffer` or `btoa` to be defined');
 };
 
 export const fromBase64 = (str: string): Uint8Array => {
@@ -36,5 +36,5 @@ export const fromBase64 = (str: string): Uint8Array => {
     return buf;
   }
 
-  throw new GraphorError('Cannot decode base64 string; Expected `Buffer` or `atob` to be defined');
+  throw new GraphorPrdError('Cannot decode base64 string; Expected `Buffer` or `atob` to be defined');
 };

package/src/internal/utils/log.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { hasOwn } from './values';
-import { type Graphor } from '../../client';
+import { type GraphorPrd } from '../../client';
 import { RequestOptions } from '../request-options';
 
 type LogFn = (message: string, ...rest: unknown[]) => void;
@@ -24,7 +24,7 @@ const levelNumbers = {
 export const parseLogLevel = (
   maybeLevel: string | undefined,
   sourceName: string,
-  client: Graphor,
+  client: GraphorPrd,
 ): LogLevel | undefined => {
   if (!maybeLevel) {
     return undefined;
@@ -60,7 +60,7 @@ const noopLogger = {
 
 let cachedLoggers = /* @__PURE__ */ new WeakMap<Logger, [LogLevel, Logger]>();
 
-export function loggerFor(client: Graphor): Logger {
+export function loggerFor(client: GraphorPrd): Logger {
   const logger = client.logger;
   const logLevel = client.logLevel ?? 'off';
   if (!logger) {

package/src/internal/utils/path.ts

@@ -1,4 +1,4 @@
-import { GraphorError } from '../../core/error';
+import { GraphorPrdError } from '../../core/error';
 
 /**
  * Percent-encode everything that isn't safe to have in a path without encoding safe chars.
@@ -72,7 +72,7 @@ export const createPathTagFunction = (pathEncoder = encodeURIPath) =>
         return acc + spaces + arrows;
       }, '');
 
-      throw new GraphorError(
+      throw new GraphorPrdError(
         `Path parameters result in path with invalid segments:\n${invalidSegments
           .map((e) => e.error)
           .join('\n')}\n${path}\n${underline}`,

package/src/internal/utils/values.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { GraphorError } from '../../core/error';
+import { GraphorPrdError } from '../../core/error';
 
 // https://url.spec.whatwg.org/#url-scheme-string
 const startsWithSchemeRegexp = /^[a-z][a-z0-9+.-]*:/i;
@@ -39,7 +39,7 @@ export function isObj(obj: unknown): obj is Record<string, unknown> {
 
 export const ensurePresent = <T>(value: T | null | undefined): T => {
   if (value == null) {
-    throw new GraphorError(`Expected a value to be given but received ${value} instead.`);
+    throw new GraphorPrdError(`Expected a value to be given but received ${value} instead.`);
   }
 
   return value;
@@ -47,10 +47,10 @@ export const ensurePresent = <T>(value: T | null | undefined): T => {
 
 export const validatePositiveInteger = (name: string, n: unknown): number => {
   if (typeof n !== 'number' || !Number.isInteger(n)) {
-    throw new GraphorError(`${name} must be an integer`);
+    throw new GraphorPrdError(`${name} must be an integer`);
   }
   if (n < 0) {
-    throw new GraphorError(`${name} must be a positive integer`);
+    throw new GraphorPrdError(`${name} must be a positive integer`);
   }
   return n;
 };
@@ -59,14 +59,14 @@ export const coerceInteger = (value: unknown): number => {
   if (typeof value === 'number') return Math.round(value);
   if (typeof value === 'string') return parseInt(value, 10);
 
-  throw new GraphorError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+  throw new GraphorPrdError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
 };
 
 export const coerceFloat = (value: unknown): number => {
   if (typeof value === 'number') return value;
   if (typeof value === 'string') return parseFloat(value);
 
-  throw new GraphorError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+  throw new GraphorPrdError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
 };
 
 export const coerceBoolean = (value: unknown): boolean => {

package/src/resources/index.ts

@@ -2,7 +2,7 @@
 
 export {
   Sources,
-  type PartitionMethod,
+  type PublicPartitionMethod,
   type PublicSource,
   type SourceListResponse,
   type SourceDeleteResponse,

package/src/resources/sources.ts

@@ -106,15 +106,10 @@ export class Sources extends APIResource {
   }
 }
 
-export type PartitionMethod =
-  | 'basic'
-  | 'hi_res'
-  | 'hi_res_ft'
-  | 'mai'
-  | 'graphorlm'
-  | 'ocr'
-  | 'advanced'
-  | 'yolox';
+/**
+ * Partition methods available for public API endpoints.
+ */
+export type PublicPartitionMethod = 'basic' | 'hi_res' | 'hi_res_ft' | 'mai' | 'graphorlm';
 
 export interface PublicSource {
   file_name: string;
@@ -138,7 +133,16 @@ export interface PublicSource {
    */
   file_id?: string | null;
 
-  partition_method?: PartitionMethod | null;
+  partition_method?:
+    | 'basic'
+    | 'hi_res'
+    | 'hi_res_ft'
+    | 'mai'
+    | 'graphorlm'
+    | 'ocr'
+    | 'advanced'
+    | 'yolox'
+    | null;
 }
 
 export type SourceListResponse = Array<PublicSource>;
@@ -471,7 +475,7 @@ export interface SourceParseParams {
   /**
    * The method used to partition the file
    */
-  partition_method?: 'basic' | 'hi_res' | 'hi_res_ft' | 'mai' | 'graphorlm';
+  partition_method?: PublicPartitionMethod;
 }
 
 export interface SourceRetrieveChunksParams {
@@ -499,7 +503,7 @@ export interface SourceUploadParams {
   /**
    * Partition methods available for public API endpoints.
    */
-  partition_method?: 'basic' | 'hi_res' | 'hi_res_ft' | 'mai' | 'graphorlm' | null;
+  partition_method?: PublicPartitionMethod | null;
 }
 
 export interface SourceUploadGitHubParams {
@@ -523,7 +527,7 @@ export interface SourceUploadURLParams {
   /**
    * Partition methods available for public API endpoints.
    */
-  partition_method?: 'basic' | 'hi_res' | 'hi_res_ft' | 'mai' | 'graphorlm' | null;
+  partition_method?: PublicPartitionMethod | null;
 }
 
 export interface SourceUploadYoutubeParams {
@@ -535,7 +539,7 @@ export interface SourceUploadYoutubeParams {
 
 export declare namespace Sources {
   export {
-    type PartitionMethod as PartitionMethod,
+    type PublicPartitionMethod as PublicPartitionMethod,
     type PublicSource as PublicSource,
     type SourceListResponse as SourceListResponse,
     type SourceDeleteResponse as SourceDeleteResponse,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.4.1'; // x-release-please-version
+export const VERSION = '0.4.2'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.4.1";
+export declare const VERSION = "0.4.2";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.4.1";
+export declare const VERSION = "0.4.2";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.4.1'; // x-release-please-version
+exports.VERSION = '0.4.2'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.4.1'; // x-release-please-version
+export const VERSION = '0.4.2'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map