@air/api-rest 0.1.2 → 0.1.3

package/dist/index.cjs

@@ -420,22 +420,23 @@ var Uploads = class {
     });
   }
   async uploadFile(params, options = {}) {
-    const { fileData, fileName, ext, mime, size } = await resolveFileData(params);
+    const meta = await resolveFileMeta(params);
     const uploadResponse = await this.create({
-      fileName,
-      ext,
-      size,
-      mime,
+      fileName: meta.fileName,
+      ext: meta.ext,
+      size: meta.size,
+      mime: meta.mime,
       parentBoardId: options.parentBoardId,
       assetId: options.assetId,
       customFields: options.customFields,
       tags: options.tags
     });
     if (isSmallUpload(uploadResponse)) {
-      await this._uploadSmallFile(uploadResponse.uploadUrl, fileData, options.onProgress, size);
+      const data = await materializeData(meta);
+      await this._uploadSmallFile(uploadResponse.uploadUrl, data, options.onProgress, meta.size);
       return { assetId: uploadResponse.assetId, versionId: uploadResponse.versionId };
     }
-    await this._uploadLargeFile(uploadResponse, fileData, size, options.onProgress);
+    await this._uploadLargeFile(uploadResponse, meta, options.onProgress);
     return { assetId: uploadResponse.assetId, versionId: uploadResponse.versionId };
   }
   async _uploadSmallFile(url, data, onProgress, totalSize) {
@@ -451,42 +452,73 @@ var Uploads = class {
       onProgress({ percentage: 100, uploadedBytes: totalSize, totalBytes: totalSize });
     }
   }
-  async _uploadLargeFile(uploadInfo, data, totalSize, onProgress) {
+  async _uploadLargeFile(uploadInfo, meta, onProgress) {
     const { multiPartUploadId, key } = uploadInfo;
-    const buffer = data instanceof Buffer ? data : Buffer.from(data);
+    const { size: totalSize } = meta;
     const partCount = Math.ceil(totalSize / DEFAULT_PART_SIZE);
     const parts = [];
     let uploadedBytes = 0;
     const fetchFn = this.client.fetchFn;
-    for (let i = 0; i < partCount; i++) {
-      const partNumber = i + 1;
-      const start = i * DEFAULT_PART_SIZE;
-      const end = Math.min(start + DEFAULT_PART_SIZE, totalSize);
-      const chunk = buffer.subarray(start, end);
-      const { url } = await this.getPartUploadUrl({
-        multiPartUploadId,
-        key,
-        partNumber
-      });
-      const response = await fetchFn(url, {
-        method: "PUT",
-        body: chunk
-      });
-      if (!response.ok) {
-        throw new Error(`Part ${partNumber} upload failed with status ${response.status}`);
+    if (meta.source.type === "path") {
+      const fs = await import("fs");
+      const fd = fs.openSync(meta.source.filePath, "r");
+      try {
+        for (let i = 0; i < partCount; i++) {
+          const partNumber = i + 1;
+          const start = i * DEFAULT_PART_SIZE;
+          const end = Math.min(start + DEFAULT_PART_SIZE, totalSize);
+          const length = end - start;
+          const chunk = Buffer.alloc(length);
+          const bytesRead = fs.readSync(fd, chunk, 0, length, start);
+          const body = bytesRead < length ? chunk.subarray(0, bytesRead) : chunk;
+          const { url } = await this.getPartUploadUrl({ multiPartUploadId, key, partNumber });
+          const response = await fetchFn(url, { method: "PUT", body });
+          if (!response.ok) {
+            throw new Error(`Part ${partNumber} upload failed with status ${response.status}`);
+          }
+          const etag = response.headers.get("etag");
+          if (!etag) {
+            throw new Error(`Part ${partNumber} upload did not return an ETag`);
+          }
+          parts.push({ etag, partNumber });
+          uploadedBytes += bytesRead;
+          if (onProgress) {
+            onProgress({
+              percentage: Math.round(uploadedBytes / totalSize * 100),
+              uploadedBytes,
+              totalBytes: totalSize
+            });
+          }
+        }
+      } finally {
+        fs.closeSync(fd);
       }
-      const etag = response.headers.get("etag");
-      if (!etag) {
-        throw new Error(`Part ${partNumber} upload did not return an ETag`);
-      }
-      parts.push({ etag, partNumber });
-      uploadedBytes += chunk.byteLength;
-      if (onProgress) {
-        onProgress({
-          percentage: Math.round(uploadedBytes / totalSize * 100),
-          uploadedBytes,
-          totalBytes: totalSize
-        });
+    } else {
+      const buffer = await materializeData(meta);
+      const buf = buffer instanceof Buffer ? buffer : Buffer.from(buffer);
+      for (let i = 0; i < partCount; i++) {
+        const partNumber = i + 1;
+        const start = i * DEFAULT_PART_SIZE;
+        const end = Math.min(start + DEFAULT_PART_SIZE, totalSize);
+        const chunk = buf.subarray(start, end);
+        const { url } = await this.getPartUploadUrl({ multiPartUploadId, key, partNumber });
+        const response = await fetchFn(url, { method: "PUT", body: chunk });
+        if (!response.ok) {
+          throw new Error(`Part ${partNumber} upload failed with status ${response.status}`);
+        }
+        const etag = response.headers.get("etag");
+        if (!etag) {
+          throw new Error(`Part ${partNumber} upload did not return an ETag`);
+        }
+        parts.push({ etag, partNumber });
+        uploadedBytes += chunk.byteLength;
+        if (onProgress) {
+          onProgress({
+            percentage: Math.round(uploadedBytes / totalSize * 100),
+            uploadedBytes,
+            totalBytes: totalSize
+          });
+        }
       }
     }
     await this.completeMultipart({ multiPartUploadId, key, parts });
@@ -495,16 +527,22 @@ var Uploads = class {
 function isSmallUpload(response) {
   return "uploadUrl" in response;
 }
-async function resolveFileData(params) {
+async function resolveFileMeta(params) {
   if (params.filePath) {
     const fs = await import("fs");
     const path = await import("path");
-    const fileData = fs.readFileSync(params.filePath);
+    const stat = fs.statSync(params.filePath);
     const parsed = path.parse(params.filePath);
     const fileName = params.fileName ?? parsed.name;
     const ext = params.ext ?? parsed.ext.replace(/^\./, "");
     const mime = params.mime ?? guessMime(ext);
-    return { fileData, fileName, ext, mime, size: fileData.byteLength };
+    return {
+      source: { type: "path", filePath: params.filePath },
+      fileName,
+      ext,
+      mime,
+      size: stat.size
+    };
   }
   if (params.buffer) {
     const data = params.buffer instanceof Buffer ? params.buffer : Buffer.from(params.buffer);
@@ -513,7 +551,7 @@ async function resolveFileData(params) {
     }
     const mime = params.mime ?? guessMime(params.ext);
     return {
-      fileData: data,
+      source: { type: "buffer", data },
       fileName: params.fileName,
       ext: params.ext,
       mime,
@@ -521,17 +559,35 @@ async function resolveFileData(params) {
     };
   }
   if (params.file) {
-    const arrayBuffer = await params.file.arrayBuffer();
-    const data = new Uint8Array(arrayBuffer);
     const name = params.file.name;
     const dotIndex = name.lastIndexOf(".");
     const fileName = params.fileName ?? (dotIndex > 0 ? name.substring(0, dotIndex) : name);
     const ext = params.ext ?? (dotIndex > 0 ? name.substring(dotIndex + 1) : "");
     const mime = params.mime ?? (params.file.type || guessMime(ext));
-    return { fileData: data, fileName, ext, mime, size: data.byteLength };
+    return {
+      source: { type: "file", file: params.file },
+      fileName,
+      ext,
+      mime,
+      size: params.file.size
+    };
   }
   throw new Error("One of filePath, buffer, or file must be provided");
 }
+async function materializeData(meta) {
+  switch (meta.source.type) {
+    case "path": {
+      const fs = await import("fs");
+      return fs.readFileSync(meta.source.filePath);
+    }
+    case "buffer":
+      return meta.source.data;
+    case "file": {
+      const arrayBuffer = await meta.source.file.arrayBuffer();
+      return new Uint8Array(arrayBuffer);
+    }
+  }
+}
 function guessMime(ext) {
   const mimeMap = {
     jpg: "image/jpeg",

package/dist/index.d.cts

@@ -341,6 +341,23 @@ interface CompleteMultipartParams {
         partNumber: number;
     }[];
 }
+type FileSource = {
+    type: "path";
+    filePath: string;
+} | {
+    type: "buffer";
+    data: Buffer;
+} | {
+    type: "file";
+    file: File;
+};
+interface FileMeta {
+    source: FileSource;
+    fileName: string;
+    ext: string;
+    mime: string;
+    size: number;
+}
 interface UploadFileParams {
     filePath?: string;
     buffer?: Buffer | ArrayBuffer;
@@ -397,4 +414,4 @@ declare class AirApi extends AirBase {
     constructor(options?: AirApiOptions);
 }
 
-export { type AddBoardAssetsParams, type AddGuestParams, type AddVersionTagParams, AirApi, type AirApiOptions, type Asset, type AssetBoardListParams, type AssetCustomFieldValue, type AssetListParams, type AssetVersion, type AssetVersionDownloadUrl, type AssetVersionListResponse, type AssetVersionUpdateParams, type AssetVersionUrls, Assets, type Board, type BoardCreateParams, type BoardListParams, type BoardUpdateParams, Boards, type CompleteMultipartParams, type CustomField, type CustomFieldCreateParams, type CustomFieldListParams, type CustomFieldType, type CustomFieldUpdateParams, type CustomFieldValue, type CustomFieldValueCreateParams, type CustomFieldValueUpdateParams, CustomFields, type GetPartUploadUrlParams, type GetPartUploadUrlResponse, type Guest, type GuestListParams, type GuestListResponse, type ImportCreateParams, type ImportCreateResponse, type ImportStatus, type ImportStatusResponse, Imports, type LargeUploadResponse, type Role, type RoleListParams, type RoleListResponse, Roles, type SetBoardCustomFieldParams, type SetCustomFieldParams, type SmallUploadResponse, type SmartTag, type Tag, type TagCreateParams, type TagListParams, type TagUpdateParams, Tags, type UpdateGuestParams, type UploadCreateParams, type UploadCreateResponse, type UploadFileOptions, type UploadFileParams, type UploadFileResponse, Uploads };
+export { type AddBoardAssetsParams, type AddGuestParams, type AddVersionTagParams, AirApi, type AirApiOptions, type Asset, type AssetBoardListParams, type AssetCustomFieldValue, type AssetListParams, type AssetVersion, type AssetVersionDownloadUrl, type AssetVersionListResponse, type AssetVersionUpdateParams, type AssetVersionUrls, Assets, type Board, type BoardCreateParams, type BoardListParams, type BoardUpdateParams, Boards, type CompleteMultipartParams, type CustomField, type CustomFieldCreateParams, type CustomFieldListParams, type CustomFieldType, type CustomFieldUpdateParams, type CustomFieldValue, type CustomFieldValueCreateParams, type CustomFieldValueUpdateParams, CustomFields, type FileMeta, type FileSource, type GetPartUploadUrlParams, type GetPartUploadUrlResponse, type Guest, type GuestListParams, type GuestListResponse, type ImportCreateParams, type ImportCreateResponse, type ImportStatus, type ImportStatusResponse, Imports, type LargeUploadResponse, type Role, type RoleListParams, type RoleListResponse, Roles, type SetBoardCustomFieldParams, type SetCustomFieldParams, type SmallUploadResponse, type SmartTag, type Tag, type TagCreateParams, type TagListParams, type TagUpdateParams, Tags, type UpdateGuestParams, type UploadCreateParams, type UploadCreateResponse, type UploadFileOptions, type UploadFileParams, type UploadFileResponse, Uploads };

package/dist/index.d.ts

@@ -341,6 +341,23 @@ interface CompleteMultipartParams {
         partNumber: number;
     }[];
 }
+type FileSource = {
+    type: "path";
+    filePath: string;
+} | {
+    type: "buffer";
+    data: Buffer;
+} | {
+    type: "file";
+    file: File;
+};
+interface FileMeta {
+    source: FileSource;
+    fileName: string;
+    ext: string;
+    mime: string;
+    size: number;
+}
 interface UploadFileParams {
     filePath?: string;
     buffer?: Buffer | ArrayBuffer;
@@ -397,4 +414,4 @@ declare class AirApi extends AirBase {
     constructor(options?: AirApiOptions);
 }
 
-export { type AddBoardAssetsParams, type AddGuestParams, type AddVersionTagParams, AirApi, type AirApiOptions, type Asset, type AssetBoardListParams, type AssetCustomFieldValue, type AssetListParams, type AssetVersion, type AssetVersionDownloadUrl, type AssetVersionListResponse, type AssetVersionUpdateParams, type AssetVersionUrls, Assets, type Board, type BoardCreateParams, type BoardListParams, type BoardUpdateParams, Boards, type CompleteMultipartParams, type CustomField, type CustomFieldCreateParams, type CustomFieldListParams, type CustomFieldType, type CustomFieldUpdateParams, type CustomFieldValue, type CustomFieldValueCreateParams, type CustomFieldValueUpdateParams, CustomFields, type GetPartUploadUrlParams, type GetPartUploadUrlResponse, type Guest, type GuestListParams, type GuestListResponse, type ImportCreateParams, type ImportCreateResponse, type ImportStatus, type ImportStatusResponse, Imports, type LargeUploadResponse, type Role, type RoleListParams, type RoleListResponse, Roles, type SetBoardCustomFieldParams, type SetCustomFieldParams, type SmallUploadResponse, type SmartTag, type Tag, type TagCreateParams, type TagListParams, type TagUpdateParams, Tags, type UpdateGuestParams, type UploadCreateParams, type UploadCreateResponse, type UploadFileOptions, type UploadFileParams, type UploadFileResponse, Uploads };
+export { type AddBoardAssetsParams, type AddGuestParams, type AddVersionTagParams, AirApi, type AirApiOptions, type Asset, type AssetBoardListParams, type AssetCustomFieldValue, type AssetListParams, type AssetVersion, type AssetVersionDownloadUrl, type AssetVersionListResponse, type AssetVersionUpdateParams, type AssetVersionUrls, Assets, type Board, type BoardCreateParams, type BoardListParams, type BoardUpdateParams, Boards, type CompleteMultipartParams, type CustomField, type CustomFieldCreateParams, type CustomFieldListParams, type CustomFieldType, type CustomFieldUpdateParams, type CustomFieldValue, type CustomFieldValueCreateParams, type CustomFieldValueUpdateParams, CustomFields, type FileMeta, type FileSource, type GetPartUploadUrlParams, type GetPartUploadUrlResponse, type Guest, type GuestListParams, type GuestListResponse, type ImportCreateParams, type ImportCreateResponse, type ImportStatus, type ImportStatusResponse, Imports, type LargeUploadResponse, type Role, type RoleListParams, type RoleListResponse, Roles, type SetBoardCustomFieldParams, type SetCustomFieldParams, type SmallUploadResponse, type SmartTag, type Tag, type TagCreateParams, type TagListParams, type TagUpdateParams, Tags, type UpdateGuestParams, type UploadCreateParams, type UploadCreateResponse, type UploadFileOptions, type UploadFileParams, type UploadFileResponse, Uploads };

package/dist/index.js

@@ -364,22 +364,23 @@ var Uploads = class {
     });
   }
   async uploadFile(params, options = {}) {
-    const { fileData, fileName, ext, mime, size } = await resolveFileData(params);
+    const meta = await resolveFileMeta(params);
     const uploadResponse = await this.create({
-      fileName,
-      ext,
-      size,
-      mime,
+      fileName: meta.fileName,
+      ext: meta.ext,
+      size: meta.size,
+      mime: meta.mime,
       parentBoardId: options.parentBoardId,
       assetId: options.assetId,
       customFields: options.customFields,
       tags: options.tags
     });
     if (isSmallUpload(uploadResponse)) {
-      await this._uploadSmallFile(uploadResponse.uploadUrl, fileData, options.onProgress, size);
+      const data = await materializeData(meta);
+      await this._uploadSmallFile(uploadResponse.uploadUrl, data, options.onProgress, meta.size);
       return { assetId: uploadResponse.assetId, versionId: uploadResponse.versionId };
     }
-    await this._uploadLargeFile(uploadResponse, fileData, size, options.onProgress);
+    await this._uploadLargeFile(uploadResponse, meta, options.onProgress);
     return { assetId: uploadResponse.assetId, versionId: uploadResponse.versionId };
   }
   async _uploadSmallFile(url, data, onProgress, totalSize) {
@@ -395,42 +396,73 @@ var Uploads = class {
       onProgress({ percentage: 100, uploadedBytes: totalSize, totalBytes: totalSize });
     }
   }
-  async _uploadLargeFile(uploadInfo, data, totalSize, onProgress) {
+  async _uploadLargeFile(uploadInfo, meta, onProgress) {
     const { multiPartUploadId, key } = uploadInfo;
-    const buffer = data instanceof Buffer ? data : Buffer.from(data);
+    const { size: totalSize } = meta;
     const partCount = Math.ceil(totalSize / DEFAULT_PART_SIZE);
     const parts = [];
     let uploadedBytes = 0;
     const fetchFn = this.client.fetchFn;
-    for (let i = 0; i < partCount; i++) {
-      const partNumber = i + 1;
-      const start = i * DEFAULT_PART_SIZE;
-      const end = Math.min(start + DEFAULT_PART_SIZE, totalSize);
-      const chunk = buffer.subarray(start, end);
-      const { url } = await this.getPartUploadUrl({
-        multiPartUploadId,
-        key,
-        partNumber
-      });
-      const response = await fetchFn(url, {
-        method: "PUT",
-        body: chunk
-      });
-      if (!response.ok) {
-        throw new Error(`Part ${partNumber} upload failed with status ${response.status}`);
+    if (meta.source.type === "path") {
+      const fs = await import("fs");
+      const fd = fs.openSync(meta.source.filePath, "r");
+      try {
+        for (let i = 0; i < partCount; i++) {
+          const partNumber = i + 1;
+          const start = i * DEFAULT_PART_SIZE;
+          const end = Math.min(start + DEFAULT_PART_SIZE, totalSize);
+          const length = end - start;
+          const chunk = Buffer.alloc(length);
+          const bytesRead = fs.readSync(fd, chunk, 0, length, start);
+          const body = bytesRead < length ? chunk.subarray(0, bytesRead) : chunk;
+          const { url } = await this.getPartUploadUrl({ multiPartUploadId, key, partNumber });
+          const response = await fetchFn(url, { method: "PUT", body });
+          if (!response.ok) {
+            throw new Error(`Part ${partNumber} upload failed with status ${response.status}`);
+          }
+          const etag = response.headers.get("etag");
+          if (!etag) {
+            throw new Error(`Part ${partNumber} upload did not return an ETag`);
+          }
+          parts.push({ etag, partNumber });
+          uploadedBytes += bytesRead;
+          if (onProgress) {
+            onProgress({
+              percentage: Math.round(uploadedBytes / totalSize * 100),
+              uploadedBytes,
+              totalBytes: totalSize
+            });
+          }
+        }
+      } finally {
+        fs.closeSync(fd);
       }
-      const etag = response.headers.get("etag");
-      if (!etag) {
-        throw new Error(`Part ${partNumber} upload did not return an ETag`);
-      }
-      parts.push({ etag, partNumber });
-      uploadedBytes += chunk.byteLength;
-      if (onProgress) {
-        onProgress({
-          percentage: Math.round(uploadedBytes / totalSize * 100),
-          uploadedBytes,
-          totalBytes: totalSize
-        });
+    } else {
+      const buffer = await materializeData(meta);
+      const buf = buffer instanceof Buffer ? buffer : Buffer.from(buffer);
+      for (let i = 0; i < partCount; i++) {
+        const partNumber = i + 1;
+        const start = i * DEFAULT_PART_SIZE;
+        const end = Math.min(start + DEFAULT_PART_SIZE, totalSize);
+        const chunk = buf.subarray(start, end);
+        const { url } = await this.getPartUploadUrl({ multiPartUploadId, key, partNumber });
+        const response = await fetchFn(url, { method: "PUT", body: chunk });
+        if (!response.ok) {
+          throw new Error(`Part ${partNumber} upload failed with status ${response.status}`);
+        }
+        const etag = response.headers.get("etag");
+        if (!etag) {
+          throw new Error(`Part ${partNumber} upload did not return an ETag`);
+        }
+        parts.push({ etag, partNumber });
+        uploadedBytes += chunk.byteLength;
+        if (onProgress) {
+          onProgress({
+            percentage: Math.round(uploadedBytes / totalSize * 100),
+            uploadedBytes,
+            totalBytes: totalSize
+          });
+        }
       }
     }
     await this.completeMultipart({ multiPartUploadId, key, parts });
@@ -439,16 +471,22 @@ var Uploads = class {
 function isSmallUpload(response) {
   return "uploadUrl" in response;
 }
-async function resolveFileData(params) {
+async function resolveFileMeta(params) {
   if (params.filePath) {
     const fs = await import("fs");
     const path = await import("path");
-    const fileData = fs.readFileSync(params.filePath);
+    const stat = fs.statSync(params.filePath);
     const parsed = path.parse(params.filePath);
     const fileName = params.fileName ?? parsed.name;
     const ext = params.ext ?? parsed.ext.replace(/^\./, "");
     const mime = params.mime ?? guessMime(ext);
-    return { fileData, fileName, ext, mime, size: fileData.byteLength };
+    return {
+      source: { type: "path", filePath: params.filePath },
+      fileName,
+      ext,
+      mime,
+      size: stat.size
+    };
   }
   if (params.buffer) {
     const data = params.buffer instanceof Buffer ? params.buffer : Buffer.from(params.buffer);
@@ -457,7 +495,7 @@ async function resolveFileData(params) {
     }
     const mime = params.mime ?? guessMime(params.ext);
     return {
-      fileData: data,
+      source: { type: "buffer", data },
       fileName: params.fileName,
       ext: params.ext,
       mime,
@@ -465,17 +503,35 @@ async function resolveFileData(params) {
     };
   }
   if (params.file) {
-    const arrayBuffer = await params.file.arrayBuffer();
-    const data = new Uint8Array(arrayBuffer);
     const name = params.file.name;
     const dotIndex = name.lastIndexOf(".");
     const fileName = params.fileName ?? (dotIndex > 0 ? name.substring(0, dotIndex) : name);
     const ext = params.ext ?? (dotIndex > 0 ? name.substring(dotIndex + 1) : "");
     const mime = params.mime ?? (params.file.type || guessMime(ext));
-    return { fileData: data, fileName, ext, mime, size: data.byteLength };
+    return {
+      source: { type: "file", file: params.file },
+      fileName,
+      ext,
+      mime,
+      size: params.file.size
+    };
   }
   throw new Error("One of filePath, buffer, or file must be provided");
 }
+async function materializeData(meta) {
+  switch (meta.source.type) {
+    case "path": {
+      const fs = await import("fs");
+      return fs.readFileSync(meta.source.filePath);
+    }
+    case "buffer":
+      return meta.source.data;
+    case "file": {
+      const arrayBuffer = await meta.source.file.arrayBuffer();
+      return new Uint8Array(arrayBuffer);
+    }
+  }
+}
 function guessMime(ext) {
   const mimeMap = {
     jpg: "image/jpeg",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@air/api-rest",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "type": "module",
   "description": "Typed REST client for Air API",
   "main": "./dist/index.cjs",