@typespec/ts-http-runtime 1.0.0-alpha.20231110.2 → 1.0.0-alpha.20231115.1

package/types/ts-http-runtime.d.ts

@@ -246,6 +246,20 @@ export declare interface BearerTokenAuthenticationPolicyOptions {
     logger?: TypeSpecRuntimeLogger;
 }
 
+/**
+ * A part of the request body in a multipart request.
+ */
+export declare interface BodyPart {
+    /**
+     * The headers for this part of the multipart request.
+     */
+    headers: HttpHeaders;
+    /**
+     * The body of this part of the multipart request.
+     */
+    body: ((() => ReadableStream<Uint8Array>) | (() => NodeJS.ReadableStream)) | ReadableStream<Uint8Array> | NodeJS.ReadableStream | Uint8Array | Blob;
+}
+
 /**
  * promise.race() wrapper that aborts rest of promises as soon as the first promise settles.
  */
@@ -380,6 +394,70 @@ export declare function createDefaultHttpClient(): HttpClient;
  */
 export declare function createEmptyPipeline(): Pipeline;
 
+/**
+ * Create an object that implements the File interface. This object is intended to be
+ * passed into RequestBodyType.formData, and is not guaranteed to work as expected in
+ * other situations.
+ *
+ * Use this function create a File object for use in RequestBodyType.formData in environments where the global File object is unavailable.
+ *
+ * @param content - the content of the file as a Uint8Array in memory.
+ * @param name - the name of the file.
+ * @param options - optional metadata about the file, e.g. file name, file size, MIME type.
+ */
+export declare function createFile(content: Uint8Array, name: string, options?: CreateFileOptions): File;
+
+/**
+ * Create an object that implements the File interface. This object is intended to be
+ * passed into RequestBodyType.formData, and is not guaranteed to work as expected in
+ * other situations.
+ *
+ * Use this function to:
+ * - Create a File object for use in RequestBodyType.formData in environments where the
+ *   global File object is unavailable.
+ * - Create a File-like object from a readable stream without reading the stream into memory.
+ *
+ * @param stream - the content of the file as a callback returning a stream. When a File object made using createFile is
+ *                  passed in a request's form data map, the stream will not be read into memory
+ *                  and instead will be streamed when the request is made. In the event of a retry, the
+ *                  stream needs to be read again, so this callback SHOULD return a fresh stream if possible.
+ * @param name - the name of the file.
+ * @param options - optional metadata about the file, e.g. file name, file size, MIME type.
+ */
+export declare function createFileFromStream(stream: () => ReadableStream<Uint8Array> | NodeJS.ReadableStream, name: string, options?: CreateFileFromStreamOptions): File;
+
+/**
+ * Extra options for createFile when a stream is being passed in.
+ */
+export declare interface CreateFileFromStreamOptions extends CreateFileOptions {
+    /**
+     * Size of the file represented by the stream in bytes.
+     *
+     * This will be used by the pipeline when calculating the Content-Length header
+     * for the overall request.
+     */
+    size?: number;
+}
+
+/**
+ * Options passed into createFile specifying metadata about the file.
+ */
+export declare interface CreateFileOptions {
+    /**
+     * The MIME type of the file.
+     */
+    type?: string;
+    /**
+     * Last modified time of the file as a UNIX timestamp.
+     * This will default to the current date.
+     */
+    lastModified?: number;
+    /**
+     * relative path of this file when uploading a directory.
+     */
+    webkitRelativePath?: string;
+}
+
 /**
  * Creates an object that satisfies the `HttpHeaders` interface.
  * @param rawHeaders - A simple object representing initial headers
@@ -524,9 +602,10 @@ export declare function formDataPolicy(): PipelinePolicy;
 export declare const formDataPolicyName = "formDataPolicy";
 
 /**
- * Each form data entry can be a string or (in the browser) a Blob.
+ * Each form data entry can be a string, Blob, or a File. If you wish to pass a file with a name but do not have
+ * access to the File class, you can use the createFile helper to create one.
  */
-export declare type FormDataValue = string | Blob;
+export declare type FormDataValue = string | Blob | File;
 
 /**
  * Wrapper object for http request and response. Deserialized object is stored in
@@ -910,6 +989,33 @@ export declare interface LogPolicyOptions {
     logger?: Debugger;
 }
 
+/**
+ * Pipeline policy for multipart requests
+ */
+export declare function multipartPolicy(): PipelinePolicy;
+
+/**
+ * Name of multipart policy
+ */
+export declare const multipartPolicyName = "multipartPolicy";
+
+/**
+ * A request body consisting of multiple parts.
+ */
+export declare interface MultipartRequestBody {
+    /**
+     * The parts of the request body.
+     */
+    parts: BodyPart[];
+    /**
+     * The boundary separating each part of the request body.
+     * If not specified, a random boundary will be generated.
+     *
+     * When specified, '--' will be prepended to the boundary in the request to ensure the boundary follows the specification.
+     */
+    boundary?: string;
+}
+
 /**
  * Helper TypeGuard that checks if the input is an object with the specified property.
  * @param thing - Any object.
@@ -1152,6 +1258,10 @@ export declare interface PipelineRequest {
      * The HTTP body content (if any)
      */
     body?: RequestBodyType;
+    /**
+     * Body for a multipart request.
+     */
+    multipartBody?: MultipartRequestBody;
     /**
      * To simulate a browser form post
      */
@@ -1241,6 +1351,10 @@ export declare interface PipelineRequestOptions {
      * The HTTP body content (if any)
      */
     body?: RequestBodyType;
+    /**
+     * Body for a multipart request.
+     */
+    multipartBody?: MultipartRequestBody;
     /**
      * To simulate a browser form post
      */

package/dist-esm/src/client/helpers/isReadableStream.browser.js

@@ -1,12 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-/**
- * Checks if the body is a ReadableStream supported by browsers
- * @internal
- */
-export function isReadableStream(body) {
-    return Boolean(body &&
-        typeof body.getReader === "function" &&
-        typeof body.tee === "function");
-}
-//# sourceMappingURL=isReadableStream.browser.js.map

package/dist-esm/src/client/helpers/isReadableStream.browser.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"isReadableStream.browser.js","sourceRoot":"","sources":["../../../../src/client/helpers/isReadableStream.browser.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAAC,IAAa;IAC5C,OAAO,OAAO,CACZ,IAAI;QACF,OAAQ,IAAuB,CAAC,SAAS,KAAK,UAAU;QACxD,OAAQ,IAAuB,CAAC,GAAG,KAAK,UAAU,CACrD,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n/**\n * Checks if the body is a ReadableStream supported by browsers\n * @internal\n */\nexport function isReadableStream(body: unknown): body is ReadableStream {\n  return Boolean(\n    body &&\n      typeof (body as ReadableStream).getReader === \"function\" &&\n      typeof (body as ReadableStream).tee === \"function\"\n  );\n}\n"]}

package/dist-esm/src/client/helpers/isReadableStream.js

@@ -1,10 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-/**
- * Checks if the body is a ReadableStream supported by Node
- * @internal
- */
-export function isReadableStream(body) {
-    return Boolean(body) && typeof body.pipe === "function";
-}
-//# sourceMappingURL=isReadableStream.js.map

package/dist-esm/src/client/helpers/isReadableStream.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"isReadableStream.js","sourceRoot":"","sources":["../../../../src/client/helpers/isReadableStream.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAAC,IAAa;IAC5C,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,OAAQ,IAAY,CAAC,IAAI,KAAK,UAAU,CAAC;AACnE,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n/**\n * Checks if the body is a ReadableStream supported by Node\n * @internal\n */\nexport function isReadableStream(body: unknown): body is NodeJS.ReadableStream {\n  return Boolean(body) && typeof (body as any).pipe === \"function\";\n}\n"]}

package/dist-esm/src/policies/formDataPolicy.browser.js

@@ -1,43 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-/**
- * The programmatic identifier of the formDataPolicy.
- */
-export const formDataPolicyName = "formDataPolicy";
-/**
- * A policy that encodes FormData on the request into the body.
- */
-export function formDataPolicy() {
-    return {
-        name: formDataPolicyName,
-        async sendRequest(request, next) {
-            if (request.formData) {
-                const formData = request.formData;
-                const requestForm = new FormData();
-                for (const formKey of Object.keys(formData)) {
-                    const formValue = formData[formKey];
-                    if (Array.isArray(formValue)) {
-                        for (const subValue of formValue) {
-                            requestForm.append(formKey, subValue);
-                        }
-                    }
-                    else {
-                        requestForm.append(formKey, formValue);
-                    }
-                }
-                request.body = requestForm;
-                request.formData = undefined;
-                const contentType = request.headers.get("Content-Type");
-                if (contentType && contentType.indexOf("application/x-www-form-urlencoded") !== -1) {
-                    request.body = new URLSearchParams(requestForm).toString();
-                }
-                else if (contentType && contentType.indexOf("multipart/form-data") !== -1) {
-                    // browser will automatically apply a suitable content-type header
-                    request.headers.delete("Content-Type");
-                }
-            }
-            return next(request);
-        },
-    };
-}
-//# sourceMappingURL=formDataPolicy.browser.js.map

package/dist-esm/src/policies/formDataPolicy.browser.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"formDataPolicy.browser.js","sourceRoot":"","sources":["../../../src/policies/formDataPolicy.browser.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAKlC;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,gBAAgB,CAAC;AAEnD;;GAEG;AACH,MAAM,UAAU,cAAc;IAC5B,OAAO;QACL,IAAI,EAAE,kBAAkB;QACxB,KAAK,CAAC,WAAW,CAAC,OAAwB,EAAE,IAAiB;YAC3D,IAAI,OAAO,CAAC,QAAQ,EAAE;gBACpB,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;gBAClC,MAAM,WAAW,GAAG,IAAI,QAAQ,EAAE,CAAC;gBACnC,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;oBAC3C,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC;oBACpC,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;wBAC5B,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;4BAChC,WAAW,CAAC,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;yBACvC;qBACF;yBAAM;wBACL,WAAW,CAAC,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;qBACxC;iBACF;gBAED,OAAO,CAAC,IAAI,GAAG,WAAW,CAAC;gBAC3B,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC;gBAC7B,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;gBACxD,IAAI,WAAW,IAAI,WAAW,CAAC,OAAO,CAAC,mCAAmC,CAAC,KAAK,CAAC,CAAC,EAAE;oBAClF,OAAO,CAAC,IAAI,GAAG,IAAI,eAAe,CAAC,WAAkB,CAAC,CAAC,QAAQ,EAAE,CAAC;iBACnE;qBAAM,IAAI,WAAW,IAAI,WAAW,CAAC,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,EAAE;oBAC3E,kEAAkE;oBAClE,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;iBACxC;aACF;YACD,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;QACvB,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { PipelineRequest, PipelineResponse, SendRequest } from \"../interfaces\";\nimport { PipelinePolicy } from \"../pipeline\";\n\n/**\n * The programmatic identifier of the formDataPolicy.\n */\nexport const formDataPolicyName = \"formDataPolicy\";\n\n/**\n * A policy that encodes FormData on the request into the body.\n */\nexport function formDataPolicy(): PipelinePolicy {\n  return {\n    name: formDataPolicyName,\n    async sendRequest(request: PipelineRequest, next: SendRequest): Promise<PipelineResponse> {\n      if (request.formData) {\n        const formData = request.formData;\n        const requestForm = new FormData();\n        for (const formKey of Object.keys(formData)) {\n          const formValue = formData[formKey];\n          if (Array.isArray(formValue)) {\n            for (const subValue of formValue) {\n              requestForm.append(formKey, subValue);\n            }\n          } else {\n            requestForm.append(formKey, formValue);\n          }\n        }\n\n        request.body = requestForm;\n        request.formData = undefined;\n        const contentType = request.headers.get(\"Content-Type\");\n        if (contentType && contentType.indexOf(\"application/x-www-form-urlencoded\") !== -1) {\n          request.body = new URLSearchParams(requestForm as any).toString();\n        } else if (contentType && contentType.indexOf(\"multipart/form-data\") !== -1) {\n          // browser will automatically apply a suitable content-type header\n          request.headers.delete(\"Content-Type\");\n        }\n      }\n      return next(request);\n    },\n  };\n}\n"]}