@lorikeetai/node-sdk 0.1.0 → 0.2.0

package/src/_shims/node-runtime.ts

@@ -1,67 +1,67 @@
 /**
  * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
  */
-import * as nf from 'node-fetch'
-import * as fd from 'formdata-node'
-import { type File, type FilePropertyBag } from 'formdata-node'
-import KeepAliveAgent from 'agentkeepalive'
-import { AbortController as AbortControllerPolyfill } from 'abort-controller'
-import { ReadStream as FsReadStream } from 'node:fs'
-import { type Agent } from 'node:http'
-import { FormDataEncoder } from 'form-data-encoder'
-import { Readable } from 'node:stream'
-import { type RequestOptions } from '../core'
-import { MultipartBody } from './MultipartBody'
-import { type Shims } from './registry'
-import { ReadableStream } from 'node:stream/web'
+import * as nf from 'node-fetch';
+import * as fd from 'formdata-node';
+import { type File, type FilePropertyBag } from 'formdata-node';
+import KeepAliveAgent from 'agentkeepalive';
+import { AbortController as AbortControllerPolyfill } from 'abort-controller';
+import { ReadStream as FsReadStream } from 'node:fs';
+import { type Agent } from 'node:http';
+import { FormDataEncoder } from 'form-data-encoder';
+import { Readable } from 'node:stream';
+import { type RequestOptions } from '../core';
+import { MultipartBody } from './MultipartBody';
+import { type Shims } from './registry';
+import { ReadableStream } from 'node:stream/web';
 
-type FileFromPathOptions = Omit<FilePropertyBag, 'lastModified'>
+type FileFromPathOptions = Omit<FilePropertyBag, 'lastModified'>;
 
-let fileFromPathWarned = false
+let fileFromPathWarned = false;
 
 /**
  * @deprecated use fs.createReadStream('./my/file.txt') instead
  */
-async function fileFromPath(path: string): Promise<File>
-async function fileFromPath(path: string, filename?: string): Promise<File>
-async function fileFromPath(path: string, options?: FileFromPathOptions): Promise<File>
-async function fileFromPath(path: string, filename?: string, options?: FileFromPathOptions): Promise<File>
+async function fileFromPath(path: string): Promise<File>;
+async function fileFromPath(path: string, filename?: string): Promise<File>;
+async function fileFromPath(path: string, options?: FileFromPathOptions): Promise<File>;
+async function fileFromPath(path: string, filename?: string, options?: FileFromPathOptions): Promise<File>;
 async function fileFromPath(path: string, ...args: any[]): Promise<File> {
   // this import fails in environments that don't handle export maps correctly, like old versions of Jest
-  const { fileFromPath: _fileFromPath } = await import('formdata-node/file-from-path')
+  const { fileFromPath: _fileFromPath } = await import('formdata-node/file-from-path');
 
   if (!fileFromPathWarned) {
-    console.warn(`fileFromPath is deprecated; use fs.createReadStream(${JSON.stringify(path)}) instead`)
-    fileFromPathWarned = true
+    console.warn(`fileFromPath is deprecated; use fs.createReadStream(${JSON.stringify(path)}) instead`);
+    fileFromPathWarned = true;
   }
   // @ts-ignore
-  return await _fileFromPath(path, ...args)
+  return await _fileFromPath(path, ...args);
 }
 
-const defaultHttpAgent: Agent = new KeepAliveAgent({ keepAlive: true, timeout: 5 * 60 * 1000 })
-const defaultHttpsAgent: Agent = new KeepAliveAgent.HttpsAgent({ keepAlive: true, timeout: 5 * 60 * 1000 })
+const defaultHttpAgent: Agent = new KeepAliveAgent({ keepAlive: true, timeout: 5 * 60 * 1000 });
+const defaultHttpsAgent: Agent = new KeepAliveAgent.HttpsAgent({ keepAlive: true, timeout: 5 * 60 * 1000 });
 
 async function getMultipartRequestOptions<T = Record<string, unknown>>(
   form: fd.FormData,
   opts: RequestOptions<T>,
 ): Promise<RequestOptions<T>> {
-  const encoder = new FormDataEncoder(form)
-  const readable = Readable.from(encoder)
-  const body = new MultipartBody(readable)
+  const encoder = new FormDataEncoder(form);
+  const readable = Readable.from(encoder);
+  const body = new MultipartBody(readable);
   const headers = {
     ...opts.headers,
     ...encoder.headers,
     'Content-Length': encoder.contentLength,
-  }
+  };
 
-  return { ...opts, body: body as any, headers }
+  return { ...opts, body: body as any, headers };
 }
 
 export function getRuntime(): Shims {
   // Polyfill global object if needed.
   if (typeof AbortController === 'undefined') {
     // @ts-expect-error (the types are subtly different, but compatible in practice)
-    globalThis.AbortController = AbortControllerPolyfill
+    globalThis.AbortController = AbortControllerPolyfill;
   }
   return {
     kind: 'node',
@@ -77,5 +77,5 @@ export function getRuntime(): Shims {
     getDefaultAgent: (url: string): Agent => (url.startsWith('https') ? defaultHttpsAgent : defaultHttpAgent),
     fileFromPath,
     isFsReadStream: (value: any): value is FsReadStream => value instanceof FsReadStream,
-  }
+  };
 }

package/src/_shims/node-types.d.ts

@@ -1,42 +1,42 @@
 /**
  * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
  */
-import * as nf from 'node-fetch'
-import * as fd from 'formdata-node'
+import * as nf from 'node-fetch';
+import * as fd from 'formdata-node';
 
-export { type Agent } from 'node:http'
-export { type Readable } from 'node:stream'
-export { type ReadStream as FsReadStream } from 'node:fs'
-export { ReadableStream } from 'node:stream/web'
+export { type Agent } from 'node:http';
+export { type Readable } from 'node:stream';
+export { type ReadStream as FsReadStream } from 'node:fs';
+export { ReadableStream } from 'node:stream/web';
 
-export const fetch: typeof nf.default
+export const fetch: typeof nf.default;
 
-export type Request = nf.Request
-export type RequestInfo = nf.RequestInfo
-export type RequestInit = nf.RequestInit
+export type Request = nf.Request;
+export type RequestInfo = nf.RequestInfo;
+export type RequestInit = nf.RequestInit;
 
-export type Response = nf.Response
-export type ResponseInit = nf.ResponseInit
-export type ResponseType = nf.ResponseType
-export type BodyInit = nf.BodyInit
-export type Headers = nf.Headers
-export type HeadersInit = nf.HeadersInit
+export type Response = nf.Response;
+export type ResponseInit = nf.ResponseInit;
+export type ResponseType = nf.ResponseType;
+export type BodyInit = nf.BodyInit;
+export type Headers = nf.Headers;
+export type HeadersInit = nf.HeadersInit;
 
-type EndingType = 'native' | 'transparent'
+type EndingType = 'native' | 'transparent';
 export interface BlobPropertyBag {
-  endings?: EndingType
-  type?: string
+  endings?: EndingType;
+  type?: string;
 }
 
 export interface FilePropertyBag extends BlobPropertyBag {
-  lastModified?: number
+  lastModified?: number;
 }
 
-export type FileFromPathOptions = Omit<FilePropertyBag, 'lastModified'>
+export type FileFromPathOptions = Omit<FilePropertyBag, 'lastModified'>;
 
-export type FormData = fd.FormData
-export const FormData: typeof fd.FormData
-export type File = fd.File
-export const File: typeof fd.File
-export type Blob = fd.Blob
-export const Blob: typeof fd.Blob
+export type FormData = fd.FormData;
+export const FormData: typeof fd.FormData;
+export type File = fd.File;
+export const File: typeof fd.File;
+export type Blob = fd.Blob;
+export const Blob: typeof fd.Blob;

package/src/_shims/registry.ts

@@ -1,67 +1,67 @@
 /**
  * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
  */
-import { type RequestOptions } from '../core'
+import { type RequestOptions } from '../core';
 
 export interface Shims {
-  kind: string
-  fetch: any
-  Request: any
-  Response: any
-  Headers: any
-  FormData: any
-  Blob: any
-  File: any
-  ReadableStream: any
+  kind: string;
+  fetch: any;
+  Request: any;
+  Response: any;
+  Headers: any;
+  FormData: any;
+  Blob: any;
+  File: any;
+  ReadableStream: any;
   getMultipartRequestOptions: <T = Record<string, unknown>>(
     form: Shims['FormData'],
     opts: RequestOptions<T>,
-  ) => Promise<RequestOptions<T>>
-  getDefaultAgent: (url: string) => any
+  ) => Promise<RequestOptions<T>>;
+  getDefaultAgent: (url: string) => any;
   fileFromPath:
     | ((path: string, filename?: string, options?: {}) => Promise<Shims['File']>)
-    | ((path: string, options?: {}) => Promise<Shims['File']>)
-  isFsReadStream: (value: any) => boolean
+    | ((path: string, options?: {}) => Promise<Shims['File']>);
+  isFsReadStream: (value: any) => boolean;
 }
 
-export let auto = false
-export let kind: Shims['kind'] | undefined = undefined
-export let fetch: Shims['fetch'] | undefined = undefined
-export let Request: Shims['Request'] | undefined = undefined
-export let Response: Shims['Response'] | undefined = undefined
-export let Headers: Shims['Headers'] | undefined = undefined
-export let FormData: Shims['FormData'] | undefined = undefined
-export let Blob: Shims['Blob'] | undefined = undefined
-export let File: Shims['File'] | undefined = undefined
-export let ReadableStream: Shims['ReadableStream'] | undefined = undefined
-export let getMultipartRequestOptions: Shims['getMultipartRequestOptions'] | undefined = undefined
-export let getDefaultAgent: Shims['getDefaultAgent'] | undefined = undefined
-export let fileFromPath: Shims['fileFromPath'] | undefined = undefined
-export let isFsReadStream: Shims['isFsReadStream'] | undefined = undefined
+export let auto = false;
+export let kind: Shims['kind'] | undefined = undefined;
+export let fetch: Shims['fetch'] | undefined = undefined;
+export let Request: Shims['Request'] | undefined = undefined;
+export let Response: Shims['Response'] | undefined = undefined;
+export let Headers: Shims['Headers'] | undefined = undefined;
+export let FormData: Shims['FormData'] | undefined = undefined;
+export let Blob: Shims['Blob'] | undefined = undefined;
+export let File: Shims['File'] | undefined = undefined;
+export let ReadableStream: Shims['ReadableStream'] | undefined = undefined;
+export let getMultipartRequestOptions: Shims['getMultipartRequestOptions'] | undefined = undefined;
+export let getDefaultAgent: Shims['getDefaultAgent'] | undefined = undefined;
+export let fileFromPath: Shims['fileFromPath'] | undefined = undefined;
+export let isFsReadStream: Shims['isFsReadStream'] | undefined = undefined;
 
 export function setShims(shims: Shims, options: { auto: boolean } = { auto: false }) {
   if (auto) {
     throw new Error(
       `you must \`import '@lorikeetai/node-sdk/shims/${shims.kind}'\` before importing anything else from @lorikeetai/node-sdk`,
-    )
+    );
   }
   if (kind) {
     throw new Error(
       `can't \`import '@lorikeetai/node-sdk/shims/${shims.kind}'\` after \`import '@lorikeetai/node-sdk/shims/${kind}'\``,
-    )
+    );
   }
-  auto = options.auto
-  kind = shims.kind
-  fetch = shims.fetch
-  Request = shims.Request
-  Response = shims.Response
-  Headers = shims.Headers
-  FormData = shims.FormData
-  Blob = shims.Blob
-  File = shims.File
-  ReadableStream = shims.ReadableStream
-  getMultipartRequestOptions = shims.getMultipartRequestOptions
-  getDefaultAgent = shims.getDefaultAgent
-  fileFromPath = shims.fileFromPath
-  isFsReadStream = shims.isFsReadStream
+  auto = options.auto;
+  kind = shims.kind;
+  fetch = shims.fetch;
+  Request = shims.Request;
+  Response = shims.Response;
+  Headers = shims.Headers;
+  FormData = shims.FormData;
+  Blob = shims.Blob;
+  File = shims.File;
+  ReadableStream = shims.ReadableStream;
+  getMultipartRequestOptions = shims.getMultipartRequestOptions;
+  getDefaultAgent = shims.getDefaultAgent;
+  fileFromPath = shims.fileFromPath;
+  isFsReadStream = shims.isFsReadStream;
 }

package/src/_shims/web-runtime.ts

@@ -1,9 +1,9 @@
 /**
  * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
  */
-import { MultipartBody } from './MultipartBody'
-import { type RequestOptions } from '../core'
-import { type Shims } from './registry'
+import { MultipartBody } from './MultipartBody';
+import { type RequestOptions } from '../core';
+import { type Shims } from './registry';
 
 export function getRuntime({ manuallyImported }: { manuallyImported?: boolean } = {}): Shims {
   const recommendation =
@@ -12,24 +12,24 @@ export function getRuntime({ manuallyImported }: { manuallyImported?: boolean }
     : `Add one of these imports before your first \`import … from '@lorikeetai/node-sdk'\`:
 - \`import '@lorikeetai/node-sdk/shims/node'\` (if you're running on Node)
 - \`import '@lorikeetai/node-sdk/shims/web'\` (otherwise)
-`
+`;
 
-  let _fetch, _Request, _Response, _Headers
+  let _fetch, _Request, _Response, _Headers;
   try {
     // @ts-ignore
-    _fetch = fetch
+    _fetch = fetch;
     // @ts-ignore
-    _Request = Request
+    _Request = Request;
     // @ts-ignore
-    _Response = Response
+    _Response = Response;
     // @ts-ignore
-    _Headers = Headers
+    _Headers = Headers;
   } catch (error) {
     throw new Error(
       `this environment is missing the following Web Fetch API type: ${
         (error as any).message
       }. ${recommendation}`,
-    )
+    );
   }
 
   return {
@@ -46,7 +46,7 @@ export function getRuntime({ manuallyImported }: { manuallyImported?: boolean }
           constructor() {
             throw new Error(
               `file uploads aren't supported in this environment yet as 'FormData' is undefined. ${recommendation}`,
-            )
+            );
           }
         }
       ),
@@ -56,7 +56,7 @@ export function getRuntime({ manuallyImported }: { manuallyImported?: boolean }
           constructor() {
             throw new Error(
               `file uploads aren't supported in this environment yet as 'Blob' is undefined. ${recommendation}`,
-            )
+            );
           }
         }
       ),
@@ -68,7 +68,7 @@ export function getRuntime({ manuallyImported }: { manuallyImported?: boolean }
           constructor() {
             throw new Error(
               `file uploads aren't supported in this environment yet as 'File' is undefined. ${recommendation}`,
-            )
+            );
           }
         }
       ),
@@ -80,7 +80,7 @@ export function getRuntime({ manuallyImported }: { manuallyImported?: boolean }
           constructor() {
             throw new Error(
               `streaming isn't supported in this environment yet as 'ReadableStream' is undefined. ${recommendation}`,
-            )
+            );
           }
         }
       ),
@@ -96,8 +96,8 @@ export function getRuntime({ manuallyImported }: { manuallyImported?: boolean }
     fileFromPath: () => {
       throw new Error(
         'The `fileFromPath` function is only supported in Node. See the README for more details: https://www.github.com/optechai/node-sdk#file-uploads',
-      )
+      );
     },
     isFsReadStream: (value: any) => false,
-  }
+  };
 }

package/src/_shims/web-types.d.ts

@@ -1,83 +1,83 @@
 /**
  * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
  */
-export type Agent = any
+export type Agent = any;
 
-declare const _fetch: typeof fetch
-export { _fetch as fetch }
+declare const _fetch: typeof fetch;
+export { _fetch as fetch };
 
-type _Request = Request
-export { _Request as Request }
+type _Request = Request;
+export { _Request as Request };
 
-type _RequestInfo = RequestInfo
-export { type _RequestInfo as RequestInfo }
+type _RequestInfo = RequestInfo;
+export { type _RequestInfo as RequestInfo };
 
-type _RequestInit = RequestInit
-export { type _RequestInit as RequestInit }
+type _RequestInit = RequestInit;
+export { type _RequestInit as RequestInit };
 
-type _Response = Response
-export { _Response as Response }
+type _Response = Response;
+export { _Response as Response };
 
-type _ResponseInit = ResponseInit
-export { type _ResponseInit as ResponseInit }
+type _ResponseInit = ResponseInit;
+export { type _ResponseInit as ResponseInit };
 
-type _ResponseType = ResponseType
-export { type _ResponseType as ResponseType }
+type _ResponseType = ResponseType;
+export { type _ResponseType as ResponseType };
 
-type _BodyInit = BodyInit
-export { type _BodyInit as BodyInit }
+type _BodyInit = BodyInit;
+export { type _BodyInit as BodyInit };
 
-type _Headers = Headers
-export { _Headers as Headers }
+type _Headers = Headers;
+export { _Headers as Headers };
 
-type _HeadersInit = HeadersInit
-export { type _HeadersInit as HeadersInit }
+type _HeadersInit = HeadersInit;
+export { type _HeadersInit as HeadersInit };
 
-type EndingType = 'native' | 'transparent'
+type EndingType = 'native' | 'transparent';
 
 export interface BlobPropertyBag {
-  endings?: EndingType
-  type?: string
+  endings?: EndingType;
+  type?: string;
 }
 
 export interface FilePropertyBag extends BlobPropertyBag {
-  lastModified?: number
+  lastModified?: number;
 }
 
-export type FileFromPathOptions = Omit<FilePropertyBag, 'lastModified'>
+export type FileFromPathOptions = Omit<FilePropertyBag, 'lastModified'>;
 
-type _FormData = FormData
-declare const _FormData: typeof FormData
-export { _FormData as FormData }
+type _FormData = FormData;
+declare const _FormData: typeof FormData;
+export { _FormData as FormData };
 
-type _File = File
-declare const _File: typeof File
-export { _File as File }
+type _File = File;
+declare const _File: typeof File;
+export { _File as File };
 
-type _Blob = Blob
-declare const _Blob: typeof Blob
-export { _Blob as Blob }
+type _Blob = Blob;
+declare const _Blob: typeof Blob;
+export { _Blob as Blob };
 
 export declare class Readable {
-  readable: boolean
-  readonly readableEnded: boolean
-  readonly readableFlowing: boolean | null
-  readonly readableHighWaterMark: number
-  readonly readableLength: number
-  readonly readableObjectMode: boolean
-  destroyed: boolean
-  read(size?: number): any
-  pause(): this
-  resume(): this
-  isPaused(): boolean
-  destroy(error?: Error): this
-  [Symbol.asyncIterator](): AsyncIterableIterator<any>
+  readable: boolean;
+  readonly readableEnded: boolean;
+  readonly readableFlowing: boolean | null;
+  readonly readableHighWaterMark: number;
+  readonly readableLength: number;
+  readonly readableObjectMode: boolean;
+  destroyed: boolean;
+  read(size?: number): any;
+  pause(): this;
+  resume(): this;
+  isPaused(): boolean;
+  destroy(error?: Error): this;
+  [Symbol.asyncIterator](): AsyncIterableIterator<any>;
 }
 
 export declare class FsReadStream extends Readable {
-  path: {} // node type is string | Buffer
+  path: {}; // node type is string | Buffer
 }
 
-type _ReadableStream<R = any> = ReadableStream<R>
-declare const _ReadableStream: typeof ReadableStream
-export { _ReadableStream as ReadableStream }
+type _ReadableStream<R = any> = ReadableStream<R>;
+declare const _ReadableStream: typeof ReadableStream;
+export { _ReadableStream as ReadableStream };