@ricsam/isolate-fetch 0.1.9 → 0.1.11

package/dist/types/consistency/origins.d.ts

@@ -0,0 +1,179 @@
+/**
+ * Helper functions for creating web objects from different origins.
+ * Used to test that objects behave identically regardless of how they were created.
+ *
+ * Note: The `customFunction` origin is tested where supported. For Response and Request,
+ * this requires constructing the object in the isolate using parameters passed from
+ * a host custom function, since native objects cannot be serialized across the boundary.
+ */
+import { type RuntimeHandle } from "@ricsam/isolate-runtime";
+export type ResponseOrigin = "direct" | "customFunction" | "fetchCallback";
+export type RequestOrigin = "direct" | "customFunction" | "serveRequest";
+export type HeadersOrigin = "direct" | "fromResponse" | "fromRequest";
+export type BlobOrigin = "direct";
+export type FileOrigin = "direct";
+export type URLOrigin = "direct" | "customFunction";
+export type URLSearchParamsOrigin = "direct" | "fromURL" | "fromCustomFunctionURL";
+export type FormDataOrigin = "direct" | "fromResponse";
+export type ReadableStreamOrigin = "direct" | "responseBody" | "blobStream" | "transformReadable";
+export type WritableStreamOrigin = "direct" | "transformWritable";
+export type TransformStreamOrigin = "direct";
+export type TextEncoderStreamOrigin = "direct";
+export type TextDecoderStreamOrigin = "direct";
+export type QueuingStrategyOrigin = "direct";
+export declare const RESPONSE_ORIGINS: ResponseOrigin[];
+export declare const REQUEST_ORIGINS: RequestOrigin[];
+export declare const HEADERS_ORIGINS: HeadersOrigin[];
+export declare const BLOB_ORIGINS: BlobOrigin[];
+export declare const FILE_ORIGINS: FileOrigin[];
+export declare const URL_ORIGINS: URLOrigin[];
+export declare const URLSEARCHPARAMS_ORIGINS: URLSearchParamsOrigin[];
+export declare const FORMDATA_ORIGINS: FormDataOrigin[];
+export declare const READABLE_STREAM_ORIGINS: ReadableStreamOrigin[];
+export declare const WRITABLE_STREAM_ORIGINS: WritableStreamOrigin[];
+export declare const TRANSFORM_STREAM_ORIGINS: TransformStreamOrigin[];
+export declare const TEXT_ENCODER_STREAM_ORIGINS: TextEncoderStreamOrigin[];
+export declare const TEXT_DECODER_STREAM_ORIGINS: TextDecoderStreamOrigin[];
+export declare const QUEUING_STRATEGY_ORIGINS: QueuingStrategyOrigin[];
+export type AbortControllerOrigin = "direct";
+export type AbortSignalOrigin = "direct";
+export declare const ABORT_CONTROLLER_ORIGINS: AbortControllerOrigin[];
+export declare const ABORT_SIGNAL_ORIGINS: AbortSignalOrigin[];
+export interface ConsistencyTestContext {
+    /** The runtime handle */
+    runtime: RuntimeHandle;
+    /** Execute code in the runtime */
+    eval(code: string): Promise<void>;
+    /** Dispatch an HTTP request to the serve() handler */
+    dispatchRequest(request: Request): Promise<Response>;
+    /** Set the mock response for the next fetch call */
+    setMockResponse(response: MockResponse): void;
+    /** Get a result from the isolate via setResult() */
+    getResult<T = unknown>(): T | undefined;
+    /** Clear the stored result */
+    clearResult(): void;
+    /** Dispose all resources */
+    dispose(): Promise<void>;
+}
+export interface MockResponse {
+    status?: number;
+    statusText?: string;
+    body?: string;
+    headers?: Record<string, string>;
+}
+/**
+ * Create a test context for consistency tests.
+ * Provides helpers for creating objects from different origins.
+ */
+export declare function createConsistencyTestContext(): Promise<ConsistencyTestContext>;
+export interface ResponseOptions {
+    status?: number;
+    statusText?: string;
+    headers?: Record<string, string>;
+}
+/**
+ * Create a Response in the isolate from the specified origin.
+ * The Response is stored at globalThis.__testResponse.
+ */
+export declare function getResponseFromOrigin(ctx: ConsistencyTestContext, origin: ResponseOrigin, body: string, options?: ResponseOptions): Promise<void>;
+export interface RequestOptions {
+    method?: string;
+    headers?: Record<string, string>;
+    body?: string;
+}
+/**
+ * Create a Request in the isolate from the specified origin.
+ * The Request is stored at globalThis.__testRequest.
+ */
+export declare function getRequestFromOrigin(ctx: ConsistencyTestContext, origin: RequestOrigin, url: string, options?: RequestOptions): Promise<void>;
+/**
+ * Create Headers in the isolate from the specified origin.
+ * The Headers is stored at globalThis.__testHeaders.
+ */
+export declare function getHeadersFromOrigin(ctx: ConsistencyTestContext, origin: HeadersOrigin, init: Record<string, string>): Promise<void>;
+export interface BlobOptions {
+    type?: string;
+}
+/**
+ * Create a Blob in the isolate from the specified origin.
+ * The Blob is stored at globalThis.__testBlob.
+ */
+export declare function getBlobFromOrigin(ctx: ConsistencyTestContext, origin: BlobOrigin, content: string, options?: BlobOptions): Promise<void>;
+export interface FileOptions {
+    type?: string;
+    lastModified?: number;
+}
+/**
+ * Create a File in the isolate from the specified origin.
+ * The File is stored at globalThis.__testFile.
+ */
+export declare function getFileFromOrigin(ctx: ConsistencyTestContext, origin: FileOrigin, content: string, filename: string, options?: FileOptions): Promise<void>;
+/**
+ * Create FormData in the isolate from the specified origin.
+ * The FormData is stored at globalThis.__testFormData.
+ */
+export declare function getFormDataFromOrigin(ctx: ConsistencyTestContext, origin: FormDataOrigin, entries: Array<[string, string]>): Promise<void>;
+/**
+ * Setup a serve handler that returns the specified response.
+ */
+export declare function setupServeHandler(ctx: ConsistencyTestContext, body: string, options?: ResponseOptions): Promise<void>;
+/**
+ * Dispatch a request and get the Response on the host side.
+ * This tests the host-side conversion of Response from isolate.
+ */
+export declare function getDispatchResponse(ctx: ConsistencyTestContext, body: string, options?: ResponseOptions): Promise<Response>;
+/**
+ * Create a ReadableStream in the isolate from the specified origin.
+ * The ReadableStream is stored at globalThis.__testReadableStream.
+ */
+export declare function getReadableStreamFromOrigin(ctx: ConsistencyTestContext, origin: ReadableStreamOrigin, chunks?: string[]): Promise<void>;
+/**
+ * Create a WritableStream in the isolate from the specified origin.
+ * The WritableStream is stored at globalThis.__testWritableStream.
+ * Also stores written chunks at globalThis.__testWrittenChunks.
+ */
+export declare function getWritableStreamFromOrigin(ctx: ConsistencyTestContext, origin: WritableStreamOrigin): Promise<void>;
+/**
+ * Create a TransformStream in the isolate from the specified origin.
+ * The TransformStream is stored at globalThis.__testTransformStream.
+ */
+export declare function getTransformStreamFromOrigin(ctx: ConsistencyTestContext, _origin: TransformStreamOrigin): Promise<void>;
+/**
+ * Create a TextEncoderStream in the isolate from the specified origin.
+ * The TextEncoderStream is stored at globalThis.__testTextEncoderStream.
+ */
+export declare function getTextEncoderStreamFromOrigin(ctx: ConsistencyTestContext, _origin: TextEncoderStreamOrigin): Promise<void>;
+export interface TextDecoderStreamOptions {
+    fatal?: boolean;
+    ignoreBOM?: boolean;
+}
+/**
+ * Create a TextDecoderStream in the isolate from the specified origin.
+ * The TextDecoderStream is stored at globalThis.__testTextDecoderStream.
+ */
+export declare function getTextDecoderStreamFromOrigin(ctx: ConsistencyTestContext, _origin: TextDecoderStreamOrigin, options?: TextDecoderStreamOptions): Promise<void>;
+/**
+ * Create a ByteLengthQueuingStrategy or CountQueuingStrategy in the isolate.
+ * The strategy is stored at globalThis.__testQueuingStrategy.
+ */
+export declare function getQueuingStrategyFromOrigin(ctx: ConsistencyTestContext, strategyType: "ByteLength" | "Count", highWaterMark?: number): Promise<void>;
+/**
+ * Create a URL in the isolate from the specified origin.
+ * The URL is stored at globalThis.__testURL.
+ */
+export declare function getURLFromOrigin(ctx: ConsistencyTestContext, origin: URLOrigin, urlString: string): Promise<void>;
+/**
+ * Create URLSearchParams in the isolate from the specified origin.
+ * The URLSearchParams is stored at globalThis.__testURLSearchParams.
+ */
+export declare function getURLSearchParamsFromOrigin(ctx: ConsistencyTestContext, origin: URLSearchParamsOrigin, init?: string): Promise<void>;
+/**
+ * Create an AbortController in the isolate from the specified origin.
+ * The AbortController is stored at globalThis.__testAbortController.
+ */
+export declare function getAbortControllerFromOrigin(ctx: ConsistencyTestContext, _origin: AbortControllerOrigin): Promise<void>;
+/**
+ * Create an AbortSignal in the isolate from the specified origin.
+ * The AbortSignal is stored at globalThis.__testAbortSignal.
+ */
+export declare function getAbortSignalFromOrigin(ctx: ConsistencyTestContext, _origin: AbortSignalOrigin): Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ricsam/isolate-fetch",
-  "version": "0.1.9",
+  "version": "0.1.11",
   "main": "./dist/cjs/index.cjs",
   "types": "./dist/types/index.d.ts",
   "exports": {