@mixedbread/sdk 0.1.0-alpha.10

package/src/_shims/registry.ts

@@ -0,0 +1,67 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+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;
+  getMultipartRequestOptions: <T = Record<string, unknown>>(
+    form: Shims['FormData'],
+    opts: RequestOptions<T>,
+  ) => 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;
+}
+
+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 '@mixedbread/sdk/shims/${shims.kind}'\` before importing anything else from @mixedbread/sdk`,
+    );
+  }
+  if (kind) {
+    throw new Error(
+      `can't \`import '@mixedbread/sdk/shims/${shims.kind}'\` after \`import '@mixedbread/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;
+}

package/src/_shims/web-runtime.ts

@@ -0,0 +1,103 @@
+/**
+ * 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';
+
+export function getRuntime({ manuallyImported }: { manuallyImported?: boolean } = {}): Shims {
+  const recommendation =
+    manuallyImported ?
+      `You may need to use polyfills`
+    : `Add one of these imports before your first \`import … from '@mixedbread/sdk'\`:
+- \`import '@mixedbread/sdk/shims/node'\` (if you're running on Node)
+- \`import '@mixedbread/sdk/shims/web'\` (otherwise)
+`;
+
+  let _fetch, _Request, _Response, _Headers;
+  try {
+    // @ts-ignore
+    _fetch = fetch;
+    // @ts-ignore
+    _Request = Request;
+    // @ts-ignore
+    _Response = Response;
+    // @ts-ignore
+    _Headers = Headers;
+  } catch (error) {
+    throw new Error(
+      `this environment is missing the following Web Fetch API type: ${
+        (error as any).message
+      }. ${recommendation}`,
+    );
+  }
+
+  return {
+    kind: 'web',
+    fetch: _fetch,
+    Request: _Request,
+    Response: _Response,
+    Headers: _Headers,
+    FormData:
+      // @ts-ignore
+      typeof FormData !== 'undefined' ? FormData : (
+        class FormData {
+          // @ts-ignore
+          constructor() {
+            throw new Error(
+              `file uploads aren't supported in this environment yet as 'FormData' is undefined. ${recommendation}`,
+            );
+          }
+        }
+      ),
+    Blob:
+      typeof Blob !== 'undefined' ? Blob : (
+        class Blob {
+          constructor() {
+            throw new Error(
+              `file uploads aren't supported in this environment yet as 'Blob' is undefined. ${recommendation}`,
+            );
+          }
+        }
+      ),
+    File:
+      // @ts-ignore
+      typeof File !== 'undefined' ? File : (
+        class File {
+          // @ts-ignore
+          constructor() {
+            throw new Error(
+              `file uploads aren't supported in this environment yet as 'File' is undefined. ${recommendation}`,
+            );
+          }
+        }
+      ),
+    ReadableStream:
+      // @ts-ignore
+      typeof ReadableStream !== 'undefined' ? ReadableStream : (
+        class ReadableStream {
+          // @ts-ignore
+          constructor() {
+            throw new Error(
+              `streaming isn't supported in this environment yet as 'ReadableStream' is undefined. ${recommendation}`,
+            );
+          }
+        }
+      ),
+    getMultipartRequestOptions: async <T = Record<string, unknown>>(
+      // @ts-ignore
+      form: FormData,
+      opts: RequestOptions<T>,
+    ): Promise<RequestOptions<T>> => ({
+      ...opts,
+      body: new MultipartBody(form) as any,
+    }),
+    getDefaultAgent: (url: string) => undefined,
+    fileFromPath: () => {
+      throw new Error(
+        'The `fileFromPath` function is only supported in Node. See the README for more details: https://www.github.com/mixedbread-ai/mixedbread-ts#file-uploads',
+      );
+    },
+    isFsReadStream: (value: any) => false,
+  };
+}

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

@@ -0,0 +1,83 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+export type Agent = any;
+
+declare const _fetch: typeof fetch;
+export { _fetch as fetch };
+
+type _Request = Request;
+export { _Request as Request };
+
+type _RequestInfo = RequestInfo;
+export { type _RequestInfo as RequestInfo };
+
+type _RequestInit = RequestInit;
+export { type _RequestInit as RequestInit };
+
+type _Response = Response;
+export { _Response as Response };
+
+type _ResponseInit = ResponseInit;
+export { type _ResponseInit as ResponseInit };
+
+type _ResponseType = ResponseType;
+export { type _ResponseType as ResponseType };
+
+type _BodyInit = BodyInit;
+export { type _BodyInit as BodyInit };
+
+type _Headers = Headers;
+export { _Headers as Headers };
+
+type _HeadersInit = HeadersInit;
+export { type _HeadersInit as HeadersInit };
+
+type EndingType = 'native' | 'transparent';
+
+export interface BlobPropertyBag {
+  endings?: EndingType;
+  type?: string;
+}
+
+export interface FilePropertyBag extends BlobPropertyBag {
+  lastModified?: number;
+}
+
+export type FileFromPathOptions = Omit<FilePropertyBag, 'lastModified'>;
+
+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 _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>;
+}
+
+export declare class FsReadStream extends Readable {
+  path: {}; // node type is string | Buffer
+}
+
+type _ReadableStream<R = any> = ReadableStream<R>;
+declare const _ReadableStream: typeof ReadableStream;
+export { _ReadableStream as ReadableStream };

package/src/_shims/web-types.js

@@ -0,0 +1,3 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */

package/src/_shims/web-types.mjs

@@ -0,0 +1,3 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */