@marteye/studiojs 1.1.13 → 1.1.15

package/dist/utils/multipart-upload.d.ts

@@ -0,0 +1,201 @@
+import { z } from "zod";
+/**
+|--------------------------------------------------
+| START OF MEDIA CRATE CODE
+|--------------------------------------------------
+*/
+export declare const processorPayload: z.ZodObject<{
+    assetPath: z.ZodString;
+    suffix: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    assetPath: string;
+    suffix: string;
+}, {
+    assetPath: string;
+    suffix: string;
+}>;
+export declare const IMAGE_SIZES_VALUES: readonly ["small", "medium", "large"];
+export declare const VIDEO_TASKS_VALUES: readonly ["compressed", "thumbnail"];
+export declare const videoTaskSchema: z.ZodEnum<["compressed", "thumbnail"]>;
+export declare const imageSizeSchema: z.ZodEnum<["small", "medium", "large"]>;
+export type ImageSize = z.infer<typeof imageSizeSchema>;
+export type ProcessorPayload = z.infer<typeof processorPayload>;
+export type VideoVMPayload = ProcessorPayload & {
+    task: VideoTask;
+};
+export type VideoTask = z.infer<typeof videoTaskSchema>;
+export type SupportedFileTypesNames = "image" | "video" | "file";
+export type VariantProcessingState = {
+    fileName: string;
+    thumbHash: string;
+    path: string;
+    url: string;
+    fileType: string;
+    variants: Partial<Record<ImageSize | VideoTask, {
+        url: string;
+        isProcessing: boolean;
+        type: SupportedFileTypesNames;
+    }>>;
+};
+/**
+ |--------------------------------------------------
+ | END OF MEDIA CRATE CODE
+ |--------------------------------------------------
+ */
+type MediaFinishUploadResponse = {
+    message: string;
+    mediaType: string;
+    process: VariantProcessingState;
+};
+export type MediaUploadOptions = {
+    marketId: string;
+    saleId: string;
+    lotId: string;
+    attributeId: string;
+    options?: {
+        bucket?: "raw";
+        parallelParts?: number;
+        baseUrl?: string;
+        progressCallback?: (progress: {
+            /**
+             * The state of the upload
+             */
+            state: "uploading" | "finished" | "failed" | "starting";
+            /**
+             * The progress of the upload
+             */
+            progress: number;
+            /**
+             * The current part number
+             */
+            currentPart?: number;
+            /**
+             * The total parts
+             */
+            totalParts?: number;
+        }) => void;
+    };
+};
+/**
+ * Starts a multipart upload process for a file
+ * @param {Object} params - The parameters for starting the upload
+ * @param {string} params.fileName - Name of the file without extension
+ * @param {string} params.fileMimeType - MIME type of the file
+ * @param {string} params.fileExtension - File extension
+ * @param {MediaUploadOptions} params.options - Upload options including market, sale, lot and attribute IDs
+ * @returns {Promise<{uploadId: string, filePath: string, fileMimeType: string, fileExtension: string, fileName: string}>}
+ * @throws {Error} When upload initialization fails
+ */
+export declare const startUpload: ({ fileName, fileMimeType, fileExtension, token, options, }: {
+    fileName: string;
+    fileMimeType: string;
+    fileExtension: string;
+    token: string;
+    options: MediaUploadOptions;
+}) => Promise<{
+    uploadId: string;
+    filePath: string;
+    fileMimeType: string;
+    fileExtension: string;
+    fileName: string;
+}>;
+export type ChunkedFile = {
+    partNumber: string;
+    chunk: string;
+    fileExtension: string;
+    fileMimeType: string;
+};
+/**
+ * Splits a file into chunks for multipart upload
+ * Note: Native does not have File Prototype, please implement your own chunking logic
+ * @param {File} file - The file to be chunked
+ * @param {number} chunkSize - Size of each chunk in bytes
+ * @returns {Array<ChunkedFile>} Array of chunked file parts
+ */
+export declare const chunkFile: (file: File, chunkSize: number) => Array<ChunkedFile>;
+/**
+ * Uploads a single part/chunk of a file
+ * @param {ChunkedFile} chunkedFile - The chunk of file to upload
+ * @param {string} uploadId - Upload ID from startUpload
+ * @param {string} filePath - Path where file will be stored
+ * @param {MediaUploadOptions} options - Upload options
+ * @returns {Promise<{partNumber: string, eTag: string}>}
+ * @throws {Error} When part upload fails
+ */
+export declare const uploadPart: ({ chunkedFile, uploadId, filePath, options, token, }: {
+    chunkedFile: ChunkedFile;
+    uploadId: string;
+    filePath: string;
+    options: MediaUploadOptions;
+    token: string;
+}) => Promise<{
+    partNumber: string;
+    eTag: string;
+}>;
+/**
+ * Completes a multipart upload by combining all parts
+ * @param {string} filePath - Path where file is stored
+ * @param {string} fileMimeType - MIME type of the file
+ * @param {string} uploadId - Upload ID from startUpload
+ * @param {Array<{partNumber: string, eTag: string}>} sections - Array of successfully uploaded parts
+ * @param {MediaUploadOptions} options - Upload options
+ * @returns {Promise<MediaFinishUploadResponse>}
+ * @throws {Error} When finishing upload fails
+ */
+export declare const finishUpload: ({ filePath, fileMimeType, uploadId, sections, options, token, }: {
+    filePath: string;
+    fileMimeType: string;
+    uploadId: string;
+    sections: Array<{
+        partNumber: string;
+        eTag: string;
+    }>;
+    options: MediaUploadOptions;
+    token: string;
+}) => Promise<MediaFinishUploadResponse>;
+/**
+ * Cancels an in-progress multipart upload
+ * @param {string} uploadId - Upload ID to cancel
+ * @param {string} filePath - Path of the file being uploaded
+ * @param {string} fileMimeType - MIME type of the file
+ * @param {MediaUploadOptions} options - Upload options
+ * @returns {Promise<{data: boolean}>}
+ * @throws {Error} When canceling upload fails
+ */
+export declare const cancelUpload: ({ uploadId, filePath, fileMimeType, options, token, }: {
+    uploadId: string;
+    filePath: string;
+    fileMimeType: string;
+    options: MediaUploadOptions;
+    token: string;
+}) => Promise<{
+    data: boolean;
+}>;
+/**
+ * Deletes a multipart upload
+ * @param {string} fileUrl - The URL of the file to delete
+ * @returns {Promise<{data: boolean}>}
+ * @throws {Error} When deleting upload fails
+ */
+export declare const deleteUpload: (fileUrl: string, token: string) => Promise<{
+    data: boolean;
+}>;
+export type FileInput = {
+    file: File;
+    uploadConfig: MediaUploadOptions;
+};
+export type ChunkedInput = {
+    fileName: string;
+    chunks: ChunkedFile[];
+    uploadConfig: MediaUploadOptions;
+};
+/**
+ * Handles the complete file upload process including chunking and progress tracking -
+ * WEB: Pass in a file and we will chunk it and upload it in parallel
+ * NATIVE: You need to chunk the file yourself.
+ * @param {FileInput | ChunkedInput} input - Either {file, options} or {fileName, chunks, options}
+ * @returns {Promise<MediaFinishUploadResponse>}
+ * @throws {Error} When upload fails
+ */
+export declare const uploadFile: (input: FileInput | ChunkedInput, token: string) => Promise<MediaFinishUploadResponse>;
+export {};

package/package.json

@@ -1,15 +1,25 @@
 {
   "name": "@marteye/studiojs",
-  "version": "1.1.13",
+  "version": "1.1.15",
   "description": "MartEye Studio JavaScript SDK",
   "license": "MIT",
+  "type": "module",
   "source": "src/index.ts",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",
   "types": "dist/index.d.ts",
+  "browser": {
+    "crypto": false
+  },
   "files": [
     "dist"
   ],
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/index.esm.js"
+    }
+  },
   "scripts": {
     "clean": "rm -rf dist",
     "build": "npm run clean && rollup -c",
@@ -22,8 +32,9 @@
     "@rollup/plugin-commonjs": "^25.0.0",
     "@rollup/plugin-node-resolve": "^15.0.0",
     "@rollup/plugin-typescript": "^11.0.0",
-    "@types/jest": "^29.4.0",
+    "@types/jest": "^29.5.14",
     "@types/node": "^18.14.0",
+    "@web-std/file": "^3.0.3",
     "dotenv": "^16.4.7",
     "jest": "^29.4.3",
     "rollup": "^4.0.0",
@@ -34,5 +45,8 @@
   },
   "jest": {
     "preset": "ts-jest"
+  },
+  "dependencies": {
+    "zod": "^3.24.2"
   }
 }