@valtown/sdk 2.1.0 → 3.0.0

package/src/resources/vals/files.ts

@@ -1,9 +1,11 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import * as Core from '../../core';
-import { PageCursorURL, type PageCursorURLParams } from '../../pagination';
-import { type Response } from '../../_shims/index';
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { PageCursorURL, type PageCursorURLParams, PagePromise } from '../../core/pagination';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
 
 export class Files extends APIResource {
   /**
@@ -17,13 +19,9 @@ export class Files extends APIResource {
    * );
    * ```
    */
-  create(
-    valId: string,
-    params: FileCreateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<FileCreateResponse> {
+  create(valID: string, params: FileCreateParams, options?: RequestOptions): APIPromise<FileCreateResponse> {
     const { path: path_, branch_id, ...body } = params;
-    return this._client.post(`/v2/vals/${valId}/files`, {
+    return this._client.post(path`/v2/vals/${valID}/files`, {
       query: { path: path_, branch_id },
       body,
       ...options,
@@ -46,11 +44,11 @@ export class Files extends APIResource {
    * ```
    */
   retrieve(
-    valId: string,
+    valID: string,
     query: FileRetrieveParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<FileRetrieveResponsesPageCursorURL, FileRetrieveResponse> {
-    return this._client.getAPIList(`/v2/vals/${valId}/files`, FileRetrieveResponsesPageCursorURL, {
+    options?: RequestOptions,
+  ): PagePromise<FileRetrieveResponsesPageCursorURL, FileRetrieveResponse> {
+    return this._client.getAPIList(path`/v2/vals/${valID}/files`, PageCursorURL<FileRetrieveResponse>, {
       query,
       ...options,
     });
@@ -67,13 +65,9 @@ export class Files extends APIResource {
    * );
    * ```
    */
-  update(
-    valId: string,
-    params: FileUpdateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<FileUpdateResponse> {
+  update(valID: string, params: FileUpdateParams, options?: RequestOptions): APIPromise<FileUpdateResponse> {
     const { path: path_, branch_id, ...body } = params;
-    return this._client.put(`/v2/vals/${valId}/files`, {
+    return this._client.put(path`/v2/vals/${valID}/files`, {
       query: { path: path_, branch_id },
       body,
       ...options,
@@ -93,12 +87,12 @@ export class Files extends APIResource {
    * );
    * ```
    */
-  delete(valId: string, params: FileDeleteParams, options?: Core.RequestOptions): Core.APIPromise<void> {
+  delete(valID: string, params: FileDeleteParams, options?: RequestOptions): APIPromise<void> {
     const { path: path_, recursive, branch_id } = params;
-    return this._client.delete(`/v2/vals/${valId}/files`, {
+    return this._client.delete(path`/v2/vals/${valID}/files`, {
       query: { path: path_, recursive, branch_id },
       ...options,
-      headers: { Accept: '*/*', ...options?.headers },
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
@@ -116,11 +110,7 @@ export class Files extends APIResource {
    * console.log(content);
    * ```
    */
-  getContent(
-    valId: string,
-    params: FileGetContentParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<Response> {
+  getContent(valID: string, params: FileGetContentParams, options?: RequestOptions): APIPromise<Response> {
     const {
       'Cache-Control': cacheControl,
       'If-Match': ifMatch,
@@ -129,24 +119,26 @@ export class Files extends APIResource {
       'If-Unmodified-Since': ifUnmodifiedSince,
       ...query
     } = params;
-    return this._client.get(`/v2/vals/${valId}/files/content`, {
+    return this._client.get(path`/v2/vals/${valID}/files/content`, {
       query,
       ...options,
-      headers: {
-        Accept: 'application/octet-stream',
-        ...(cacheControl != null ? { 'Cache-Control': cacheControl } : undefined),
-        ...(ifMatch != null ? { 'If-Match': ifMatch } : undefined),
-        ...(ifModifiedSince != null ? { 'If-Modified-Since': ifModifiedSince } : undefined),
-        ...(ifNoneMatch != null ? { 'If-None-Match': ifNoneMatch } : undefined),
-        ...(ifUnmodifiedSince != null ? { 'If-Unmodified-Since': ifUnmodifiedSince } : undefined),
-        ...options?.headers,
-      },
+      headers: buildHeaders([
+        {
+          Accept: 'application/octet-stream',
+          ...(cacheControl != null ? { 'Cache-Control': cacheControl } : undefined),
+          ...(ifMatch != null ? { 'If-Match': ifMatch } : undefined),
+          ...(ifModifiedSince != null ? { 'If-Modified-Since': ifModifiedSince } : undefined),
+          ...(ifNoneMatch != null ? { 'If-None-Match': ifNoneMatch } : undefined),
+          ...(ifUnmodifiedSince != null ? { 'If-Unmodified-Since': ifUnmodifiedSince } : undefined),
+        },
+        options?.headers,
+      ]),
       __binaryResponse: true,
     });
   }
 }
 
-export class FileRetrieveResponsesPageCursorURL extends PageCursorURL<FileRetrieveResponse> {}
+export type FileRetrieveResponsesPageCursorURL = PageCursorURL<FileRetrieveResponse>;
 
 /**
  * A File or Directory's Metadata
@@ -459,14 +451,12 @@ export interface FileGetContentParams {
   'If-Unmodified-Since'?: string;
 }
 
-Files.FileRetrieveResponsesPageCursorURL = FileRetrieveResponsesPageCursorURL;
-
 export declare namespace Files {
   export {
     type FileCreateResponse as FileCreateResponse,
     type FileRetrieveResponse as FileRetrieveResponse,
     type FileUpdateResponse as FileUpdateResponse,
-    FileRetrieveResponsesPageCursorURL as FileRetrieveResponsesPageCursorURL,
+    type FileRetrieveResponsesPageCursorURL as FileRetrieveResponsesPageCursorURL,
     type FileCreateParams as FileCreateParams,
     type FileRetrieveParams as FileRetrieveParams,
     type FileUpdateParams as FileUpdateParams,

package/src/resources/vals/index.ts

@@ -1,16 +1,17 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export {
-  BranchListResponsesPageCursorURL,
   Branches,
   type BranchCreateResponse,
   type BranchRetrieveResponse,
   type BranchListResponse,
   type BranchCreateParams,
+  type BranchRetrieveParams,
   type BranchListParams,
+  type BranchDeleteParams,
+  type BranchListResponsesPageCursorURL,
 } from './branches';
 export {
-  EnvironmentVariableListResponsesPageCursorURL,
   EnvironmentVariables,
   type EnvironmentVariableCreateResponse,
   type EnvironmentVariableUpdateResponse,
@@ -18,9 +19,10 @@ export {
   type EnvironmentVariableCreateParams,
   type EnvironmentVariableUpdateParams,
   type EnvironmentVariableListParams,
+  type EnvironmentVariableDeleteParams,
+  type EnvironmentVariableListResponsesPageCursorURL,
 } from './environment-variables';
 export {
-  FileRetrieveResponsesPageCursorURL,
   Files,
   type FileCreateResponse,
   type FileRetrieveResponse,
@@ -30,5 +32,6 @@ export {
   type FileUpdateParams,
   type FileDeleteParams,
   type FileGetContentParams,
+  type FileRetrieveResponsesPageCursorURL,
 } from './files';
 export { Vals, type ValCreateParams, type ValListParams } from './vals';

package/src/resources/vals/vals.ts

@@ -1,16 +1,17 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import * as Core from '../../core';
+import { APIResource } from '../../core/resource';
 import * as Shared from '../shared';
 import { ValsCursor } from '../shared';
 import * as BranchesAPI from './branches';
 import {
   BranchCreateParams,
   BranchCreateResponse,
+  BranchDeleteParams,
   BranchListParams,
   BranchListResponse,
   BranchListResponsesPageCursorURL,
+  BranchRetrieveParams,
   BranchRetrieveResponse,
   Branches,
 } from './branches';
@@ -18,6 +19,7 @@ import * as EnvironmentVariablesAPI from './environment-variables';
 import {
   EnvironmentVariableCreateParams,
   EnvironmentVariableCreateResponse,
+  EnvironmentVariableDeleteParams,
   EnvironmentVariableListParams,
   EnvironmentVariableListResponse,
   EnvironmentVariableListResponsesPageCursorURL,
@@ -38,7 +40,11 @@ import {
   FileUpdateResponse,
   Files,
 } from './files';
-import { type CursorParams } from '../../pagination';
+import { APIPromise } from '../../core/api-promise';
+import { Cursor, type CursorParams, PagePromise } from '../../core/pagination';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
 
 /**
  * Vals are a collaborative folder of runnable JavaScript, TypeScript, and JSX modules
@@ -61,7 +67,7 @@ export class Vals extends APIResource {
    * });
    * ```
    */
-  create(body: ValCreateParams, options?: Core.RequestOptions): Core.APIPromise<Shared.Val> {
+  create(body: ValCreateParams, options?: RequestOptions): APIPromise<Shared.Val> {
     return this._client.post('/v2/vals', { body, ...options });
   }
 
@@ -75,8 +81,8 @@ export class Vals extends APIResource {
    * );
    * ```
    */
-  retrieve(valId: string, options?: Core.RequestOptions): Core.APIPromise<Shared.Val> {
-    return this._client.get(`/v2/vals/${valId}`, options);
+  retrieve(valID: string, options?: RequestOptions): APIPromise<Shared.Val> {
+    return this._client.get(path`/v2/vals/${valID}`, options);
   }
 
   /**
@@ -90,8 +96,8 @@ export class Vals extends APIResource {
    * }
    * ```
    */
-  list(query: ValListParams, options?: Core.RequestOptions): Core.PagePromise<ValsCursor, Shared.Val> {
-    return this._client.getAPIList('/v2/vals', ValsCursor, { query, ...options });
+  list(query: ValListParams, options?: RequestOptions): PagePromise<ValsCursor, Shared.Val> {
+    return this._client.getAPIList('/v2/vals', Cursor<Shared.Val>, { query, ...options });
   }
 
   /**
@@ -104,10 +110,10 @@ export class Vals extends APIResource {
    * );
    * ```
    */
-  delete(valId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
-    return this._client.delete(`/v2/vals/${valId}`, {
+  delete(valID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/v2/vals/${valID}`, {
       ...options,
-      headers: { Accept: '*/*', ...options?.headers },
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 }
@@ -144,11 +150,8 @@ export interface ValListParams extends CursorParams {
 }
 
 Vals.Branches = Branches;
-Vals.BranchListResponsesPageCursorURL = BranchListResponsesPageCursorURL;
 Vals.Files = Files;
-Vals.FileRetrieveResponsesPageCursorURL = FileRetrieveResponsesPageCursorURL;
 Vals.EnvironmentVariables = EnvironmentVariables;
-Vals.EnvironmentVariableListResponsesPageCursorURL = EnvironmentVariableListResponsesPageCursorURL;
 
 export declare namespace Vals {
   export { type ValCreateParams as ValCreateParams, type ValListParams as ValListParams };
@@ -158,9 +161,11 @@ export declare namespace Vals {
     type BranchCreateResponse as BranchCreateResponse,
     type BranchRetrieveResponse as BranchRetrieveResponse,
     type BranchListResponse as BranchListResponse,
-    BranchListResponsesPageCursorURL as BranchListResponsesPageCursorURL,
+    type BranchListResponsesPageCursorURL as BranchListResponsesPageCursorURL,
     type BranchCreateParams as BranchCreateParams,
+    type BranchRetrieveParams as BranchRetrieveParams,
     type BranchListParams as BranchListParams,
+    type BranchDeleteParams as BranchDeleteParams,
   };
 
   export {
@@ -168,7 +173,7 @@ export declare namespace Vals {
     type FileCreateResponse as FileCreateResponse,
     type FileRetrieveResponse as FileRetrieveResponse,
     type FileUpdateResponse as FileUpdateResponse,
-    FileRetrieveResponsesPageCursorURL as FileRetrieveResponsesPageCursorURL,
+    type FileRetrieveResponsesPageCursorURL as FileRetrieveResponsesPageCursorURL,
     type FileCreateParams as FileCreateParams,
     type FileRetrieveParams as FileRetrieveParams,
     type FileUpdateParams as FileUpdateParams,
@@ -181,11 +186,12 @@ export declare namespace Vals {
     type EnvironmentVariableCreateResponse as EnvironmentVariableCreateResponse,
     type EnvironmentVariableUpdateResponse as EnvironmentVariableUpdateResponse,
     type EnvironmentVariableListResponse as EnvironmentVariableListResponse,
-    EnvironmentVariableListResponsesPageCursorURL as EnvironmentVariableListResponsesPageCursorURL,
+    type EnvironmentVariableListResponsesPageCursorURL as EnvironmentVariableListResponsesPageCursorURL,
     type EnvironmentVariableCreateParams as EnvironmentVariableCreateParams,
     type EnvironmentVariableUpdateParams as EnvironmentVariableUpdateParams,
     type EnvironmentVariableListParams as EnvironmentVariableListParams,
+    type EnvironmentVariableDeleteParams as EnvironmentVariableDeleteParams,
   };
 }
 
-export { ValsCursor };
+export { type ValsCursor };

package/src/tsconfig.json

@@ -4,8 +4,8 @@
   // via declaration maps
   "include": ["index.ts"],
   "compilerOptions": {
-    "target": "es2015",
-    "lib": ["DOM"],
+    "target": "ES2015",
+    "lib": ["DOM", "DOM.Iterable", "ES2018"],
     "moduleResolution": "node"
   }
 }

package/src/uploads.ts

@@ -1,255 +1,2 @@
-import { type RequestOptions } from './core';
-import {
-  FormData,
-  File,
-  type Blob,
-  type FilePropertyBag,
-  getMultipartRequestOptions,
-  type FsReadStream,
-  isFsReadStream,
-} from './_shims/index';
-import { MultipartBody } from './_shims/MultipartBody';
-export { fileFromPath } from './_shims/index';
-
-type BlobLikePart = string | ArrayBuffer | ArrayBufferView | BlobLike | Uint8Array | DataView;
-export type BlobPart = string | ArrayBuffer | ArrayBufferView | Blob | Uint8Array | DataView;
-
-/**
- * Typically, this is a native "File" class.
- *
- * We provide the {@link toFile} utility to convert a variety of objects
- * into the File class.
- *
- * For convenience, you can also pass a fetch Response, or in Node,
- * the result of fs.createReadStream().
- */
-export type Uploadable = FileLike | ResponseLike | FsReadStream;
-
-/**
- * Intended to match web.Blob, node.Blob, node-fetch.Blob, etc.
- */
-export interface BlobLike {
-  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/size) */
-  readonly size: number;
-  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/type) */
-  readonly type: string;
-  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/text) */
-  text(): Promise<string>;
-  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/slice) */
-  slice(start?: number, end?: number): BlobLike;
-  // unfortunately @types/node-fetch@^2.6.4 doesn't type the arrayBuffer method
-}
-
-/**
- * Intended to match web.File, node.File, node-fetch.File, etc.
- */
-export interface FileLike extends BlobLike {
-  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/File/lastModified) */
-  readonly lastModified: number;
-  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/File/name) */
-  readonly name: string;
-}
-
-/**
- * Intended to match web.Response, node.Response, node-fetch.Response, etc.
- */
-export interface ResponseLike {
-  url: string;
-  blob(): Promise<BlobLike>;
-}
-
-export const isResponseLike = (value: any): value is ResponseLike =>
-  value != null &&
-  typeof value === 'object' &&
-  typeof value.url === 'string' &&
-  typeof value.blob === 'function';
-
-export const isFileLike = (value: any): value is FileLike =>
-  value != null &&
-  typeof value === 'object' &&
-  typeof value.name === 'string' &&
-  typeof value.lastModified === 'number' &&
-  isBlobLike(value);
-
-/**
- * The BlobLike type omits arrayBuffer() because @types/node-fetch@^2.6.4 lacks it; but this check
- * adds the arrayBuffer() method type because it is available and used at runtime
- */
-export const isBlobLike = (value: any): value is BlobLike & { arrayBuffer(): Promise<ArrayBuffer> } =>
-  value != null &&
-  typeof value === 'object' &&
-  typeof value.size === 'number' &&
-  typeof value.type === 'string' &&
-  typeof value.text === 'function' &&
-  typeof value.slice === 'function' &&
-  typeof value.arrayBuffer === 'function';
-
-export const isUploadable = (value: any): value is Uploadable => {
-  return isFileLike(value) || isResponseLike(value) || isFsReadStream(value);
-};
-
-export type ToFileInput = Uploadable | Exclude<BlobLikePart, string> | AsyncIterable<BlobLikePart>;
-
-/**
- * Helper for creating a {@link File} to pass to an SDK upload method from a variety of different data formats
- * @param value the raw content of the file.  Can be an {@link Uploadable}, {@link BlobLikePart}, or {@link AsyncIterable} of {@link BlobLikePart}s
- * @param {string=} name the name of the file. If omitted, toFile will try to determine a file name from bits if possible
- * @param {Object=} options additional properties
- * @param {string=} options.type the MIME type of the content
- * @param {number=} options.lastModified the last modified timestamp
- * @returns a {@link File} with the given properties
- */
-export async function toFile(
-  value: ToFileInput | PromiseLike<ToFileInput>,
-  name?: string | null | undefined,
-  options?: FilePropertyBag | undefined,
-): Promise<FileLike> {
-  // If it's a promise, resolve it.
-  value = await value;
-
-  // If we've been given a `File` we don't need to do anything
-  if (isFileLike(value)) {
-    return value;
-  }
-
-  if (isResponseLike(value)) {
-    const blob = await value.blob();
-    name ||= new URL(value.url).pathname.split(/[\\/]/).pop() ?? 'unknown_file';
-
-    // we need to convert the `Blob` into an array buffer because the `Blob` class
-    // that `node-fetch` defines is incompatible with the web standard which results
-    // in `new File` interpreting it as a string instead of binary data.
-    const data = isBlobLike(blob) ? [(await blob.arrayBuffer()) as any] : [blob];
-
-    return new File(data, name, options);
-  }
-
-  const bits = await getBytes(value);
-
-  name ||= getName(value) ?? 'unknown_file';
-
-  if (!options?.type) {
-    const type = (bits[0] as any)?.type;
-    if (typeof type === 'string') {
-      options = { ...options, type };
-    }
-  }
-
-  return new File(bits, name, options);
-}
-
-async function getBytes(value: ToFileInput): Promise<Array<BlobPart>> {
-  let parts: Array<BlobPart> = [];
-  if (
-    typeof value === 'string' ||
-    ArrayBuffer.isView(value) || // includes Uint8Array, Buffer, etc.
-    value instanceof ArrayBuffer
-  ) {
-    parts.push(value);
-  } else if (isBlobLike(value)) {
-    parts.push(await value.arrayBuffer());
-  } else if (
-    isAsyncIterableIterator(value) // includes Readable, ReadableStream, etc.
-  ) {
-    for await (const chunk of value) {
-      parts.push(chunk as BlobPart); // TODO, consider validating?
-    }
-  } else {
-    throw new Error(
-      `Unexpected data type: ${typeof value}; constructor: ${value?.constructor
-        ?.name}; props: ${propsForError(value)}`,
-    );
-  }
-
-  return parts;
-}
-
-function propsForError(value: any): string {
-  const props = Object.getOwnPropertyNames(value);
-  return `[${props.map((p) => `"${p}"`).join(', ')}]`;
-}
-
-function getName(value: any): string | undefined {
-  return (
-    getStringFromMaybeBuffer(value.name) ||
-    getStringFromMaybeBuffer(value.filename) ||
-    // For fs.ReadStream
-    getStringFromMaybeBuffer(value.path)?.split(/[\\/]/).pop()
-  );
-}
-
-const getStringFromMaybeBuffer = (x: string | Buffer | unknown): string | undefined => {
-  if (typeof x === 'string') return x;
-  if (typeof Buffer !== 'undefined' && x instanceof Buffer) return String(x);
-  return undefined;
-};
-
-const isAsyncIterableIterator = (value: any): value is AsyncIterableIterator<unknown> =>
-  value != null && typeof value === 'object' && typeof value[Symbol.asyncIterator] === 'function';
-
-export const isMultipartBody = (body: any): body is MultipartBody =>
-  body && typeof body === 'object' && body.body && body[Symbol.toStringTag] === 'MultipartBody';
-
-/**
- * Returns a multipart/form-data request if any part of the given request body contains a File / Blob value.
- * Otherwise returns the request as is.
- */
-export const maybeMultipartFormRequestOptions = async <T = Record<string, unknown>>(
-  opts: RequestOptions<T>,
-): Promise<RequestOptions<T | MultipartBody>> => {
-  if (!hasUploadableValue(opts.body)) return opts;
-
-  const form = await createForm(opts.body);
-  return getMultipartRequestOptions(form, opts);
-};
-
-export const multipartFormRequestOptions = async <T = Record<string, unknown>>(
-  opts: RequestOptions<T>,
-): Promise<RequestOptions<T | MultipartBody>> => {
-  const form = await createForm(opts.body);
-  return getMultipartRequestOptions(form, opts);
-};
-
-export const createForm = async <T = Record<string, unknown>>(body: T | undefined): Promise<FormData> => {
-  const form = new FormData();
-  await Promise.all(Object.entries(body || {}).map(([key, value]) => addFormValue(form, key, value)));
-  return form;
-};
-
-const hasUploadableValue = (value: unknown): boolean => {
-  if (isUploadable(value)) return true;
-  if (Array.isArray(value)) return value.some(hasUploadableValue);
-  if (value && typeof value === 'object') {
-    for (const k in value) {
-      if (hasUploadableValue((value as any)[k])) return true;
-    }
-  }
-  return false;
-};
-
-const addFormValue = async (form: FormData, key: string, value: unknown): Promise<void> => {
-  if (value === undefined) return;
-  if (value == null) {
-    throw new TypeError(
-      `Received null for "${key}"; to pass null in FormData, you must use the string 'null'`,
-    );
-  }
-
-  // TODO: make nested formats configurable
-  if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
-    form.append(key, String(value));
-  } else if (isUploadable(value)) {
-    const file = await toFile(value);
-    form.append(key, file as File);
-  } else if (Array.isArray(value)) {
-    await Promise.all(value.map((entry) => addFormValue(form, key + '[]', entry)));
-  } else if (typeof value === 'object') {
-    await Promise.all(
-      Object.entries(value).map(([name, prop]) => addFormValue(form, `${key}[${name}]`, prop)),
-    );
-  } else {
-    throw new TypeError(
-      `Invalid value given to form, expected a string, number, boolean, object, Array, File or Blob but got ${value} instead`,
-    );
-  }
-};
+/** @deprecated Import from ./core/uploads instead */
+export * from './core/uploads';

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '2.1.0'; // x-release-please-version
+export const VERSION = '3.0.0'; // x-release-please-version

package/uploads.d.mts

@@ -0,0 +1,2 @@
+export * from "./core/uploads.mjs";
+//# sourceMappingURL=uploads.d.mts.map

package/uploads.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.mts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/uploads.d.ts

@@ -1,75 +1,2 @@
-import { type RequestOptions } from "./core.js";
-import { FormData, type Blob, type FilePropertyBag, type FsReadStream } from "./_shims/index.js";
-import { MultipartBody } from "./_shims/MultipartBody.js";
-export { fileFromPath } from "./_shims/index.js";
-type BlobLikePart = string | ArrayBuffer | ArrayBufferView | BlobLike | Uint8Array | DataView;
-export type BlobPart = string | ArrayBuffer | ArrayBufferView | Blob | Uint8Array | DataView;
-/**
- * Typically, this is a native "File" class.
- *
- * We provide the {@link toFile} utility to convert a variety of objects
- * into the File class.
- *
- * For convenience, you can also pass a fetch Response, or in Node,
- * the result of fs.createReadStream().
- */
-export type Uploadable = FileLike | ResponseLike | FsReadStream;
-/**
- * Intended to match web.Blob, node.Blob, node-fetch.Blob, etc.
- */
-export interface BlobLike {
-    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/size) */
-    readonly size: number;
-    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/type) */
-    readonly type: string;
-    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/text) */
-    text(): Promise<string>;
-    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/slice) */
-    slice(start?: number, end?: number): BlobLike;
-}
-/**
- * Intended to match web.File, node.File, node-fetch.File, etc.
- */
-export interface FileLike extends BlobLike {
-    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/File/lastModified) */
-    readonly lastModified: number;
-    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/File/name) */
-    readonly name: string;
-}
-/**
- * Intended to match web.Response, node.Response, node-fetch.Response, etc.
- */
-export interface ResponseLike {
-    url: string;
-    blob(): Promise<BlobLike>;
-}
-export declare const isResponseLike: (value: any) => value is ResponseLike;
-export declare const isFileLike: (value: any) => value is FileLike;
-/**
- * The BlobLike type omits arrayBuffer() because @types/node-fetch@^2.6.4 lacks it; but this check
- * adds the arrayBuffer() method type because it is available and used at runtime
- */
-export declare const isBlobLike: (value: any) => value is BlobLike & {
-    arrayBuffer(): Promise<ArrayBuffer>;
-};
-export declare const isUploadable: (value: any) => value is Uploadable;
-export type ToFileInput = Uploadable | Exclude<BlobLikePart, string> | AsyncIterable<BlobLikePart>;
-/**
- * Helper for creating a {@link File} to pass to an SDK upload method from a variety of different data formats
- * @param value the raw content of the file.  Can be an {@link Uploadable}, {@link BlobLikePart}, or {@link AsyncIterable} of {@link BlobLikePart}s
- * @param {string=} name the name of the file. If omitted, toFile will try to determine a file name from bits if possible
- * @param {Object=} options additional properties
- * @param {string=} options.type the MIME type of the content
- * @param {number=} options.lastModified the last modified timestamp
- * @returns a {@link File} with the given properties
- */
-export declare function toFile(value: ToFileInput | PromiseLike<ToFileInput>, name?: string | null | undefined, options?: FilePropertyBag | undefined): Promise<FileLike>;
-export declare const isMultipartBody: (body: any) => body is MultipartBody;
-/**
- * Returns a multipart/form-data request if any part of the given request body contains a File / Blob value.
- * Otherwise returns the request as is.
- */
-export declare const maybeMultipartFormRequestOptions: <T = Record<string, unknown>>(opts: RequestOptions<T>) => Promise<RequestOptions<MultipartBody | T>>;
-export declare const multipartFormRequestOptions: <T = Record<string, unknown>>(opts: RequestOptions<T>) => Promise<RequestOptions<MultipartBody | T>>;
-export declare const createForm: <T = Record<string, unknown>>(body: T | undefined) => Promise<FormData>;
+export * from "./core/uploads.js";
 //# sourceMappingURL=uploads.d.ts.map