@api-client/core 0.6.0 → 0.6.3

package/src/runtime/http-engine/FormData.ts

@@ -1,85 +1,206 @@
-/* eslint-disable @typescript-eslint/ban-ts-comment */
-import _FormData from 'form-data';
-import { IMultipartBody, PayloadSerializer } from '../../lib/transformers/PayloadSerializer.js';
+import { IMultipartBody, PayloadSerializer, IBlobMeta, IFileMeta } from '../../lib/transformers/PayloadSerializer.js';
 
-let target: _FormData;
+export interface FormDataResult {
+  /**
+   * The contents of the form data
+   */
+  buffer: Buffer;
+  /**
+   * Content type for the form data.
+   */
+  type: string;
+}
+
+interface IPart {
+  name: string;
+  type: 'file' | 'string';
+  meta?: IBlobMeta | IFileMeta;
+  contents: Buffer;
+}
+
+const DefaultContentType = 'application/octet-stream';
+const LineBreak = '\r\n';
 
 /**
- * Adds a part to the form.
+ * In API Client (old old version of ARC) multipart data is encoded 
+ * as serializable array of buffer views. This class transforms these data
+ * into a valid form data contents as a Buffer and generates content type header with the proper boundary.
  */
-async function _append(part: IMultipartBody): Promise<void> {
-  const { name, value, isFile, type, fileName, enabled } = part;
-  if (enabled === false) {
-    return;
-  }
+export class FormDataNode {
+  protected _boundary?: string;
 
-  let blob;
-  if (isFile) {
-    blob = PayloadSerializer.deserializeBlobBuffer(value);
-    if (blob) {
-      target.append(name, blob, {
-        filename: fileName,
-        knownLength: blob.length,
-        contentType: type,
-      });
+  protected _parts: IPart[] = [];
+
+  get boundary(): string {
+    if (!this._boundary) {
+      this._boundary = this._generateBoundary();
     }
-  } else if (type) {
-    blob = PayloadSerializer.deserializeBlobBuffer(value);
-    if (blob) {
-      target.append(name, blob, 'blob');
+    return this._boundary;
+  }
+
+  protected _generateBoundary(): string {
+    let boundary = '--------------------------';
+    for (let i = 0; i < 24; i++) {
+      boundary += Math.floor(Math.random() * 10).toString(16);
     }
-  } else {
-    target.append(name, value);
+    return boundary;
   }
-}
 
-export interface FormDataResult {
   /**
-   * The contents of the form data
+   * 
+   * @param parts The serialized FormData body
+   * @returns 
    */
-  buffer: Buffer;
+  getBody(parts: IMultipartBody[]): FormDataResult {
+    parts.forEach(part => this._append(part));
+    const buffer = this._generate();
+    return {
+      buffer,
+      type: this.getContentType(),
+    }
+  }
+
   /**
-   * Content type for the form data.
+   * @returns The value of the content type header with the generate boundary.
    */
-  type: string;
-}
-
+  getContentType(): string {
+    return `multipart/form-data; boundary=${this.boundary}`;
+  }
 
-function _getData(): Promise<FormDataResult> {
-  return new Promise((resolve, reject) => {
-    let result: Buffer;
-    target.on('data', (data) => {
-      if (!(data instanceof Buffer)) {
-        data = Buffer.from(data);
-      }
-      if (!result) {
-        result = data;
-      } else {
-        const sum = result.length + data.length;
-        result = Buffer.concat([result, data], sum);
-      }
-    });
-    target.on('error', (err) => reject(err));
-    target.on('end', () => {
-      const ct = target.getHeaders()['content-type'];
-      resolve({
-        buffer: result,
-        type: ct,
+  protected _append(part: IMultipartBody): void {
+    if (part.enabled === false) {
+      return;
+    }
+    if (typeof part.isFile === 'boolean') {
+      this._appendLegacy(part);
+      return;
+    }
+    const { name, value } = part;
+    if (typeof value === 'string') {
+      this._parts.push({
+        name,
+        type: 'string',
+        contents: Buffer.from(value),
       });
+      return;
+    }
+    let buffer: Buffer
+    if (value.type === 'file') {
+      buffer = PayloadSerializer.deserializeFileBuffer(value);
+    } else {
+      buffer = PayloadSerializer.deserializeBlobBuffer(value);
+    }
+    this._parts.push({
+      name,
+      type: 'file',
+      contents: buffer,
+      meta: value.meta,
     });
-    target.resume();
-  });
+  }
+
+  protected _appendLegacy(part: IMultipartBody): void {
+    if (part.isFile) {
+      const buffer = PayloadSerializer.deserializeBlobBufferLegacy(part.value as string);
+      this._parts.push({
+        name: part.name,
+        type: 'file',
+        contents: buffer,
+        meta: {
+          mime: this._readDataUrlMime(part.value as string) || DefaultContentType,
+          name: part.fileName,
+        },
+      });
+    } else if (part.type) {
+      const buffer = PayloadSerializer.deserializeBlobBufferLegacy(part.value as string);
+      this._parts.push({
+        name: part.name,
+        type: 'file',
+        contents: buffer,
+        meta: {
+          mime: part.type || DefaultContentType,
+        },
+      });
+    } else {
+      const buffer = Buffer.from(part.value as string);
+      this._parts.push({
+        name: part.name,
+        type: 'string',
+        contents: buffer,
+      });
+    }
+  }
+
+  protected _readDataUrlMime(dataUrl: string): string | undefined {
+    const arr = dataUrl.split(',');
+    const matchedMime = arr[0].match(/:(.*?);/);
+    if (!matchedMime) {
+      return undefined;
+    }
+    return matchedMime[1];
+  }
+
+  protected _generate(): Buffer {
+    const result: Buffer[] = [];
+    for (const part of this._parts) {
+      result.push(this._getHeader(part));
+      result.push(part.contents);
+      result.push(Buffer.from(LineBreak));
+    }
+    result.push(this._getFooter());
+    return Buffer.concat(result);
+  }
+
+  protected _getHeader(part: IPart): Buffer {
+    const disposition: string[] = [
+      'Content-Disposition: form-data',
+      `name="${part.name}"`,
+    ];
+    let mime: string | undefined;
+    if (part.type === 'file') {
+      const meta = part.meta as IFileMeta;
+      if (meta) {
+        // "blob" is added by browsers by default.
+        disposition.push(`filename="${meta.name || 'blob'}"`);
+        mime = meta.mime || DefaultContentType;
+      }
+    }
+
+    const headers: string[] = [
+      `--${this.boundary}`,
+      disposition.join('; '),
+    ];
+    if (mime) {
+      headers.push(`Content-Type: ${mime}`);
+    }
+    headers.push(LineBreak);
+    return Buffer.from(headers.join(LineBreak));
+  }
+
+  protected _getFooter(): Buffer {
+    return Buffer.from(`--${this.boundary}--`);
+  }
 }
 
+// --7MA4YWxkTrZu0gW
+// Content-Disposition: form-data; name="a"; filename="kubectrl-apimodeling.sh"
+// Content-Type: application/x-shellscript
+
+// {…file content…}
+// --7MA4YWxkTrZu0gW
+// Content-Disposition: form-data; name="t1"
+
+// v1
+// --7MA4YWxkTrZu0gW
+// Content-Disposition: form-data; name="t2"; filename="blob"
+// Content-Type: plain/text
+
+// {…file content…}
+// --7MA4YWxkTrZu0gW--
+
 /**
  * Processes the form data.
  */
-export default async function (parts: IMultipartBody[]): Promise<FormDataResult> {
-  target = new _FormData();
-  const promises: Promise<void>[] = [];
-  parts.forEach((part) => {
-    promises.push(_append(part));
-  });
-  await Promise.all(promises);
-  return _getData();
+export default function (parts: IMultipartBody[]): FormDataResult {
+  const factory = new FormDataNode();
+  return factory.getBody(parts);
 }

package/src/runtime/http-engine/PayloadSupport.ts

@@ -1,6 +1,6 @@
 import formDataConverter from './FormData.js';
 import { Headers } from '../../lib/headers/Headers.js';
-import { Payload, PayloadSerializer, IMultipartBody } from '../../lib/transformers/PayloadSerializer.js';
+import { Payload, PayloadSerializer, IMultipartBody, IFileMeta, IBlobMeta } from '../../lib/transformers/PayloadSerializer.js';
 
 /**
  * A class containing static helper methods to deal with Payload
@@ -8,9 +8,8 @@ import { Payload, PayloadSerializer, IMultipartBody } from '../../lib/transforme
  */
 export class PayloadSupport {
   /**
-   * NormalizeLineEndingsToCRLF
-   * https://code.google.com/p/chromium/codesearch#chromium/src/third_party/WebKit/Source/
-   * platform/text/LineEnding.cpp&rcl=1458041387&l=101
+   * Normalizes line endings to CRLF
+   * https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/platform/wtf/text/line_ending.cc;l=68
    *
    * @param string A string to be normalized.
    * @return normalized string
@@ -41,28 +40,37 @@ export class PayloadSupport {
   /**
    * Transforms the request payload into a `Buffer`
    *
-   * @param payload A payload message
    * @param headers A headers object where to append headers when needed
+   * @param payload A payload message
    * @returns A promise resolved to a `Buffer`.
    */
-  static async payloadToBuffer(payload: Payload, headers: Headers): Promise<Buffer|undefined> {
+  static payloadToBuffer(headers: Headers, payload?: Payload): Buffer | undefined {
     if (!payload) {
-      return;
+      return undefined;
     }
     if (typeof payload === 'string') {
       payload = PayloadSupport.normalizeString(payload);
       return Buffer.from(payload, 'utf8');
     }
-    
+
     if (payload.type === 'string') {
-      return PayloadSupport.payloadToBuffer(payload.data as string, headers);
+      return PayloadSupport.payloadToBuffer(headers, payload.data as string);
     }
 
-    if (['blob', 'file'].includes(payload.type)) {
-      if (!headers.has('content-type') && payload.mime) {
-        headers.set('content-type', payload.mime);
+    if (payload.type === 'file') {
+      const meta = payload.meta as IFileMeta;
+      if (!headers.has('content-type') && meta.mime) {
+        headers.set('content-type', meta.mime);
       }
-      return PayloadSerializer.deserializeBlobBuffer(payload.data as string);
+      return PayloadSerializer.deserializeFileBuffer(payload);
+    }
+
+    if (payload.type === 'blob') {
+      const meta = payload.meta as IBlobMeta;
+      if (!headers.has('content-type') && meta.mime) {
+        headers.set('content-type', meta.mime);
+      }
+      return PayloadSerializer.deserializeBlobBuffer(payload);
     }
 
     if (payload.type === 'buffer') {
@@ -74,11 +82,11 @@ export class PayloadSupport {
     }
 
     if (payload.type === 'formdata') {
-      const result = await formDataConverter(payload.data as IMultipartBody[]);
+      const result = formDataConverter(payload.data as IMultipartBody[]);
       headers.set('Content-Type', result.type);
       return result.buffer;
     }
-    
+
     throw new Error('Unsupported payload message');
   }
 }

package/build/src/lib/transformers/Utils.d.ts

@@ -1,7 +0,0 @@
-/**
- * Converts blob data to base64 string.
- *
- * @param blob File or blob object to be translated to string
- * @return Promise resolved to a base64 string data from the file.
- */
-export declare function blobToDataUrl(blob: Blob): Promise<string>;

package/build/src/lib/transformers/Utils.js

@@ -1,19 +0,0 @@
-/**
- * Converts blob data to base64 string.
- *
- * @param blob File or blob object to be translated to string
- * @return Promise resolved to a base64 string data from the file.
- */
-export function blobToDataUrl(blob) {
-    return new Promise((resolve, reject) => {
-        const reader = new FileReader();
-        reader.onloadend = () => {
-            resolve(String(reader.result));
-        };
-        reader.onerror = () => {
-            reject(new Error('Unable to convert blob to string.'));
-        };
-        reader.readAsDataURL(blob);
-    });
-}
-//# sourceMappingURL=Utils.js.map

package/build/src/lib/transformers/Utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Utils.js","sourceRoot":"","sources":["../../../../src/lib/transformers/Utils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,IAAU;IACtC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;QAChC,MAAM,CAAC,SAAS,GAAG,GAAS,EAAE;YAC5B,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;QACjC,CAAC,CAAC;QACF,MAAM,CAAC,OAAO,GAAG,GAAS,EAAE;YAC1B,MAAM,CAAC,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC,CAAC;QACzD,CAAC,CAAC;QACF,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC,CAAC,CAAC;AACL,CAAC"}

package/src/lib/transformers/Utils.ts

@@ -1,18 +0,0 @@
-/**
- * Converts blob data to base64 string.
- *
- * @param blob File or blob object to be translated to string
- * @return Promise resolved to a base64 string data from the file.
- */
-export function blobToDataUrl(blob: Blob): Promise<string> {
-  return new Promise((resolve, reject) => {
-    const reader = new FileReader();
-    reader.onloadend = (): void => {
-      resolve(String(reader.result));
-    };
-    reader.onerror = (): void => {
-      reject(new Error('Unable to convert blob to string.'));
-    };
-    reader.readAsDataURL(blob);
-  });
-}