increase 0.5.0 → 0.7.0

package/src/_shims/fetch.node.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+import * as nf from 'node-fetch';
+
+// Use builtin web types if present; else node-fetch types
+
+/**
+ * >>> Confused? <<<
+ *
+ * If you're getting errors from these types, try adding "lib": ["DOM"]
+ * to your tsconfig.json, or otherwise configure the appropriate builtin
+ * `fetch` types for your environment.
+ */
+
+// @ts-ignore
+type _fetch = unknown extends typeof fetch ? typeof nf.default : typeof fetch;
+// @ts-ignore
+type _Request = unknown extends Request ? nf.Request : Request;
+// @ts-ignore
+type _RequestInfo = unknown extends RequestInfo ? nf.RequestInfo : RequestInfo;
+// @ts-ignore
+type _RequestInit = unknown extends RequestInit ? nf.RequestInit : RequestInit;
+// @ts-ignore
+type _Response = unknown extends Response ? nf.Response : Response;
+// @ts-ignore
+type _ResponseInit = unknown extends ResponseInit ? nf.ResponseInit : ResponseInit;
+// @ts-ignore
+type _BodyInit = unknown extends BodyInit ? nf.BodyInit : BodyInit;
+// @ts-ignore
+type _Headers = unknown extends Headers ? nf.Headers : Headers;
+// @ts-ignore
+type _HeadersInit = unknown extends HeadersInit ? nf.HeadersInit : HeadersInit;
+
+declare const _fetch: _fetch;
+declare const _Request: {
+  prototype: _Request;
+  new (input: _RequestInfo | URL, init?: _RequestInit): _Request;
+};
+declare const _Response: {
+  prototype: _Response;
+  new (body?: _BodyInit | null, init?: _ResponseInit): _Response;
+};
+declare const _Headers: {
+  prototype: _Headers;
+  new (init?: _HeadersInit): _Headers;
+};
+
+export const isPolyfilled = false;
+
+export { _fetch as fetch, _Request as Request, _Response as Response, _Headers as Headers };
+export type { _RequestInit as RequestInit, _RequestInfo as RequestInfo, _BodyInit as BodyInit };

package/src/_shims/fetch.node.js

@@ -0,0 +1,12 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+const nf = require('node-fetch');
+
+exports.fetch = nf.default;
+exports.Request = nf.Request;
+exports.Response = nf.Response;
+exports.Headers = nf.Headers;
+
+exports.isPolyfilled = true;

package/src/_shims/fetch.node.mjs

@@ -0,0 +1,14 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+import * as nf from 'node-fetch';
+
+const _fetch = nf.default;
+const _Request = nf.Request;
+const _Response = nf.Response;
+const _Headers = nf.Headers;
+
+export { _fetch as fetch, _Request as Request, _Response as Response, _Headers as Headers };
+
+export const isPolyfilled = true;

package/src/_shims/fileFromPath.node.ts

@@ -0,0 +1,29 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+import { fileFromPath as _fileFromPath } from 'formdata-node/file-from-path';
+import type { File, FilePropertyBag } from './formdata.node.js';
+
+export type FileFromPathOptions = Omit<FilePropertyBag, 'lastModified'>;
+
+let warned = false;
+
+/**
+ * @deprecated use fs.createReadStream('./my/file.txt') instead
+ */
+export async function fileFromPath(path: string): Promise<File>;
+export async function fileFromPath(path: string, filename?: string): Promise<File>;
+export async function fileFromPath(path: string, options?: FileFromPathOptions): Promise<File>;
+export async function fileFromPath(
+  path: string,
+  filename?: string,
+  options?: FileFromPathOptions,
+): Promise<File>;
+export async function fileFromPath(path: string, ...args: any[]): Promise<File> {
+  if (!warned) {
+    console.warn(`fileFromPath is deprecated; use fs.createReadStream(${JSON.stringify(path)}) instead`);
+    warned = true;
+  }
+  return await _fileFromPath(path, ...args);
+}

package/src/_shims/fileFromPath.ts

@@ -0,0 +1,29 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ *
+ * This is a stub that gets replaced by fileFromPath.node.js for node environments
+ * in the package export map
+ */
+
+import type { FilePropertyBag, File } from './formdata.js';
+
+export type FileFromPathOptions = Omit<FilePropertyBag, 'lastModified'>;
+
+/**
+ * This is a stub for non-node environments that just throws an error.
+ * In node environments, this module will be replaced by util/node/fileFromPath by the
+ * package import map.
+ */
+export async function fileFromPath(path: string): Promise<File>;
+export async function fileFromPath(path: string, filename?: string): Promise<File>;
+export async function fileFromPath(path: string, options?: FileFromPathOptions): Promise<File>;
+export async function fileFromPath(
+  path: string,
+  filename?: string,
+  options?: FileFromPathOptions,
+): Promise<File>;
+export async function fileFromPath(): Promise<File> {
+  throw new Error(
+    'The `fileFromPath` function is only supported in Node. See the README for more details: https://www.github.com/increase/increase-node#file-uploads',
+  );
+}

package/src/_shims/formdata.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+import type { BlobPart } from '../uploads';
+
+type EndingType = 'native' | 'transparent';
+
+export interface BlobPropertyBag {
+  endings?: EndingType;
+  type?: string;
+}
+
+export interface FilePropertyBag extends BlobPropertyBag {
+  lastModified?: number;
+}
+
+// Use builtin web types if present; else never (user should
+// add appropriate lib or types to tsconfig)
+
+// @ts-ignore
+type _FormData = unknown extends FormData ? never : FormData;
+// @ts-ignore
+type _File = unknown extends File ? never : File;
+// @ts-ignore
+type _Blob = unknown extends Blob ? never : Blob;
+
+declare const _FormData: {
+  new (form?: any): _FormData;
+  prototype: _FormData;
+};
+declare const _File: {
+  new (fileBits: BlobPart[], fileName: string, options?: FilePropertyBag | undefined): _File;
+  prototype: _File;
+};
+declare const _Blob: {
+  new (blobParts?: BlobPart[] | undefined, options?: BlobPropertyBag | undefined): _Blob;
+  prototype: _Blob;
+};
+
+export const isPolyfilled = false;
+
+export { _FormData as FormData, _File as File, _Blob as Blob };

package/src/_shims/formdata.js

@@ -0,0 +1,9 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+exports.FormData = FormData;
+exports.File = File;
+exports.Blob = Blob;
+
+exports.isPolyfilled = false;

package/src/_shims/formdata.mjs

@@ -0,0 +1,11 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+const _FormData = FormData;
+const _File = File;
+const _Blob = Blob;
+
+export { _FormData as FormData, _File as File, _Blob as Blob };
+
+export const isPolyfilled = false;

package/src/_shims/formdata.node.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+import * as fd from 'formdata-node';
+
+import type { BlobPart } from '../uploads';
+
+type EndingType = 'native' | 'transparent';
+
+export interface BlobPropertyBag {
+  endings?: EndingType;
+  type?: string;
+}
+
+export interface FilePropertyBag extends BlobPropertyBag {
+  lastModified?: number;
+}
+
+// Use builtin web types if present; else formdata-node types
+
+// @ts-ignore
+type _FormData = unknown extends FormData ? fd.FormData : FormData;
+// @ts-ignore
+type _File = unknown extends File ? fd.File : File;
+// @ts-ignore
+type _Blob = unknown extends Blob ? fd.Blob : Blob;
+
+declare const _FormData: {
+  new (form?: any): _FormData;
+  prototype: _FormData;
+};
+declare const _File: {
+  new (fileBits: BlobPart[], fileName: string, options?: FilePropertyBag | undefined): _File;
+  prototype: _File;
+};
+declare const _Blob: {
+  new (blobParts?: BlobPart[] | undefined, options?: BlobPropertyBag | undefined): _Blob;
+  prototype: _Blob;
+};
+
+export const isPolyfilled = false;
+
+export { _FormData as FormData, _File as File, _Blob as Blob };

package/src/_shims/formdata.node.js

@@ -0,0 +1,11 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+const fd = require('formdata-node');
+
+exports.FormData = fd.FormData;
+exports.File = fd.File;
+exports.Blob = fd.Blob;
+
+exports.isPolyfilled = true;

package/src/_shims/formdata.node.mjs

@@ -0,0 +1,9 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+import { FormData, File, Blob } from 'formdata-node';
+
+export { FormData, File, Blob };
+
+export const isPolyfilled = true;

package/src/_shims/getMultipartRequestOptions.node.ts

@@ -0,0 +1,25 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+import { FormData } from './formdata.node.js';
+import type { RequestOptions } from '../core';
+import { Readable } from 'node:stream';
+import { FormDataEncoder } from 'form-data-encoder';
+import { MultipartBody } from '../uploads';
+
+export async function getMultipartRequestOptions<T extends {} = Record<string, unknown>>(
+  form: FormData,
+  opts: RequestOptions<T>,
+): Promise<RequestOptions<T>> {
+  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 };
+}

package/src/_shims/getMultipartRequestOptions.ts

@@ -0,0 +1,14 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+import { FormData } from './formdata.js';
+import type { RequestOptions } from '../core';
+import { MultipartBody } from '../uploads';
+
+export async function getMultipartRequestOptions<T extends {} = Record<string, unknown>>(
+  form: FormData,
+  opts: RequestOptions<T>,
+): Promise<RequestOptions<T>> {
+  return { ...opts, body: new MultipartBody(form) as any };
+}

package/src/_shims/node-readable.node.ts

@@ -0,0 +1,10 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+export type { Readable } from 'node:stream';
+import { ReadStream as FsReadStream } from 'node:fs';
+export type { FsReadStream };
+
+export function isFsReadStream(value: any): value is FsReadStream {
+  return value instanceof FsReadStream;
+}

package/src/_shims/node-readable.ts

@@ -0,0 +1,30 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+// shim these Node types to avoid importing @types/node and polluting the user's
+// type environment in non-node projects
+
+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
+}
+
+export function isFsReadStream(value: any): value is FsReadStream {
+  return false;
+}