@skyvern/client 1.0.3 → 1.0.6

package/README.md

@@ -12,6 +12,7 @@ The Skyvern TypeScript library provides convenient access to the Skyvern APIs fr
 - [Usage](#usage)
 - [Request and Response Types](#request-and-response-types)
 - [Exception Handling](#exception-handling)
+- [File Uploads](#file-uploads)
 - [Advanced](#advanced)
   - [Additional Headers](#additional-headers)
   - [Additional Query String Parameters](#additional-query-string-parameters)
@@ -81,6 +82,50 @@ try {
 }
 ```
 
+## File Uploads
+
+You can upload files using the client:
+
+```typescript
+import { createReadStream } from "fs";
+import { SkyvernClient } from "@skyvern/client";
+import * as fs from "fs";
+
+const client = new SkyvernClient({ apiKey: "YOUR_API_KEY" });
+await client.uploadFile({
+    file: fs.createReadStream("/path/to/your/file")
+});
+```
+The client accepts a variety of types for file upload parameters:
+* Stream types: `fs.ReadStream`, `stream.Readable`, and `ReadableStream`
+* Buffered types: `Buffer`, `Blob`, `File`, `ArrayBuffer`, `ArrayBufferView`, and `Uint8Array`
+
+### Metadata
+
+You can configure metadata when uploading a file:
+```typescript
+const file: Uploadable.WithMetadata = {
+    data: createReadStream("path/to/file"),
+    filename: "my-file",       // optional
+    contentType: "audio/mpeg", // optional
+    contentLength: 1949,       // optional
+};
+```
+
+Alternatively, you can upload a file directly from a file path:
+```typescript
+const file : Uploadable.FromPath = {
+    path: "path/to/file",
+    filename: "my-file",        // optional
+    contentType: "audio/mpeg",  // optional
+    contentLength: 1949,        // optional
+};
+```
+
+The metadata is used to set the `Content-Length`, `Content-Type`, and `Content-Disposition` headers. If not provided, the client will attempt to determine them automatically.
+For example, `fs.ReadStream` has a `path` property which the SDK uses to retrieve the file size from the filesystem without loading it into memory.
+
+
 ## Advanced
 
 ### Additional Headers

package/dist/cjs/Client.d.ts

@@ -101,6 +101,7 @@ export declare class SkyvernClient {
      *         page_size: 1,
      *         only_saved_tasks: true,
      *         only_workflows: true,
+     *         only_templates: true,
      *         search_key: "search_key",
      *         title: "title",
      *         folder_id: "folder_id",
@@ -184,6 +185,7 @@ export declare class SkyvernClient {
      * Retry sending the webhook for a run
      *
      * @param {string} runId - The id of the task run or the workflow run.
+     * @param {Skyvern.RetryRunWebhookRequest} request
      * @param {SkyvernClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Skyvern.UnprocessableEntityError}
@@ -191,7 +193,7 @@ export declare class SkyvernClient {
      * @example
      *     await client.retryRunWebhook("tsk_123")
      */
-    retryRunWebhook(runId: string, requestOptions?: SkyvernClient.RequestOptions): core.HttpResponsePromise<unknown>;
+    retryRunWebhook(runId: string, request?: Skyvern.RetryRunWebhookRequest, requestOptions?: SkyvernClient.RequestOptions): core.HttpResponsePromise<unknown>;
     private __retryRunWebhook;
     /**
      * Get timeline for a run (workflow run or task_v2 run)
@@ -208,6 +210,20 @@ export declare class SkyvernClient {
      */
     getRunTimeline(runId: string, requestOptions?: SkyvernClient.RequestOptions): core.HttpResponsePromise<Skyvern.WorkflowRunTimeline[]>;
     private __getRunTimeline;
+    /**
+     * @param {Skyvern.BodyUploadFileV1UploadFilePost} request
+     * @param {SkyvernClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Skyvern.UnprocessableEntityError}
+     *
+     * @example
+     *     import { createReadStream } from "fs";
+     *     await client.uploadFile({
+     *         file: fs.createReadStream("/path/to/your/file")
+     *     })
+     */
+    uploadFile(request: Skyvern.BodyUploadFileV1UploadFilePost, requestOptions?: SkyvernClient.RequestOptions): core.HttpResponsePromise<Skyvern.UploadFileResponse>;
+    private __uploadFile;
     /**
      * Get all browser profiles for the organization
      *

package/dist/cjs/Client.js

@@ -56,8 +56,8 @@ class SkyvernClient {
                 "x-api-key": _options === null || _options === void 0 ? void 0 : _options.apiKey,
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@skyvern/client",
-                "X-Fern-SDK-Version": "1.0.3",
-                "User-Agent": "@skyvern/client/1.0.3",
+                "X-Fern-SDK-Version": "1.0.6",
+                "User-Agent": "@skyvern/client/1.0.6",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });
@@ -363,6 +363,7 @@ class SkyvernClient {
      *         page_size: 1,
      *         only_saved_tasks: true,
      *         only_workflows: true,
+     *         only_templates: true,
      *         search_key: "search_key",
      *         title: "title",
      *         folder_id: "folder_id",
@@ -375,7 +376,7 @@ class SkyvernClient {
     __getWorkflows() {
         return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
-            const { page, page_size: pageSize, only_saved_tasks: onlySavedTasks, only_workflows: onlyWorkflows, search_key: searchKey, title, folder_id: folderId, status, template, } = request;
+            const { page, page_size: pageSize, only_saved_tasks: onlySavedTasks, only_workflows: onlyWorkflows, only_templates: onlyTemplates, search_key: searchKey, title, folder_id: folderId, status, template, } = request;
             const _queryParams = {};
             if (page != null) {
                 _queryParams.page = page.toString();
@@ -389,6 +390,9 @@ class SkyvernClient {
             if (onlyWorkflows != null) {
                 _queryParams.only_workflows = onlyWorkflows.toString();
             }
+            if (onlyTemplates != null) {
+                _queryParams.only_templates = onlyTemplates.toString();
+            }
             if (searchKey != null) {
                 _queryParams.search_key = searchKey;
             }
@@ -779,6 +783,7 @@ class SkyvernClient {
      * Retry sending the webhook for a run
      *
      * @param {string} runId - The id of the task run or the workflow run.
+     * @param {Skyvern.RetryRunWebhookRequest} request
      * @param {SkyvernClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Skyvern.UnprocessableEntityError}
@@ -786,10 +791,10 @@ class SkyvernClient {
      * @example
      *     await client.retryRunWebhook("tsk_123")
      */
-    retryRunWebhook(runId, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__retryRunWebhook(runId, requestOptions));
+    retryRunWebhook(runId, request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__retryRunWebhook(runId, request, requestOptions));
     }
-    __retryRunWebhook(runId, requestOptions) {
+    __retryRunWebhook(runId, request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
             const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "x-api-key": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.apiKey) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.apiKey }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
@@ -797,7 +802,10 @@ class SkyvernClient {
                 url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.SkyvernEnvironment.Cloud, `v1/runs/${core.url.encodePathParam(runId)}/retry_webhook`),
                 method: "POST",
                 headers: _headers,
+                contentType: "application/json",
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: request != null ? request : undefined,
                 timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
                 maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -899,6 +907,72 @@ class SkyvernClient {
             }
         });
     }
+    /**
+     * @param {Skyvern.BodyUploadFileV1UploadFilePost} request
+     * @param {SkyvernClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Skyvern.UnprocessableEntityError}
+     *
+     * @example
+     *     import { createReadStream } from "fs";
+     *     await client.uploadFile({
+     *         file: fs.createReadStream("/path/to/your/file")
+     *     })
+     */
+    uploadFile(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__uploadFile(request, requestOptions));
+    }
+    __uploadFile(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+            const _request = yield core.newFormData();
+            yield _request.appendFile("file", request.file);
+            const _maybeEncodedRequest = yield _request.getRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({ "x-api-key": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.apiKey) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.apiKey }, _maybeEncodedRequest.headers)), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.SkyvernEnvironment.Cloud, "v1/upload_file"),
+                method: "POST",
+                headers: _headers,
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "file",
+                duplex: _maybeEncodedRequest.duplex,
+                body: _maybeEncodedRequest.body,
+                timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
+                maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 422:
+                        throw new Skyvern.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.SkyvernError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.SkyvernError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.SkyvernTimeoutError("Timeout exceeded when calling POST /v1/upload_file.");
+                case "unknown":
+                    throw new errors.SkyvernError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     /**
      * Get all browser profiles for the organization
      *

package/dist/cjs/api/client/requests/BodyUploadFileV1UploadFilePost.d.ts

@@ -0,0 +1,10 @@
+import type * as core from "../../../core/index.js";
+/**
+ * @example
+ *     {
+ *         file: fs.createReadStream("/path/to/your/file")
+ *     }
+ */
+export interface BodyUploadFileV1UploadFilePost {
+    file: core.file.Uploadable;
+}

package/dist/cjs/api/client/requests/BodyUploadFileV1UploadFilePost.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/client/requests/GetWorkflowsRequest.d.ts

@@ -6,6 +6,7 @@ import type * as Skyvern from "../../index.js";
  *         page_size: 1,
  *         only_saved_tasks: true,
  *         only_workflows: true,
+ *         only_templates: true,
  *         search_key: "search_key",
  *         title: "title",
  *         folder_id: "folder_id",
@@ -17,6 +18,7 @@ export interface GetWorkflowsRequest {
     page_size?: number;
     only_saved_tasks?: boolean;
     only_workflows?: boolean;
+    only_templates?: boolean;
     /** Unified search across workflow title, folder name, and parameter metadata (key, description, default_value). */
     search_key?: string;
     /** Deprecated: use search_key instead. */

package/dist/cjs/api/client/requests/index.d.ts

@@ -1,3 +1,4 @@
+export type { BodyUploadFileV1UploadFilePost } from "./BodyUploadFileV1UploadFilePost.js";
 export type { CreateBrowserProfileRequest } from "./CreateBrowserProfileRequest.js";
 export type { CreateBrowserSessionRequest } from "./CreateBrowserSessionRequest.js";
 export type { CreateCredentialRequest } from "./CreateCredentialRequest.js";

package/dist/cjs/api/types/Action.d.ts

@@ -33,6 +33,7 @@ export interface Action {
     verified?: boolean;
     click_context?: Skyvern.ClickContext;
     totp_timing_info?: Record<string, unknown>;
+    has_mini_agent?: boolean;
     created_at?: string;
     modified_at?: string;
     created_by?: string;

package/dist/cjs/api/types/Artifact.d.ts

@@ -11,6 +11,7 @@ export interface Artifact {
     step_id?: string;
     workflow_run_id?: string;
     workflow_run_block_id?: string;
+    run_id?: string;
     observer_cruise_id?: string;
     observer_thought_id?: string;
     ai_suggestion_id?: string;

package/dist/cjs/api/types/PromptAction.d.ts

@@ -5,7 +5,7 @@ export interface PromptAction {
     /** The prompt to send to the LLM */
     prompt: string;
     /** Optional JSON schema to structure the response */
-    schema?: Record<string, unknown>;
+    response_schema?: Record<string, unknown>;
     /** Optional model configuration */
     model?: Record<string, unknown>;
 }

package/dist/cjs/api/types/RetryRunWebhookRequest.d.ts

@@ -0,0 +1,4 @@
+export interface RetryRunWebhookRequest {
+    /** Optional webhook URL to send the payload to instead of the stored configuration */
+    webhook_url?: string;
+}

package/dist/cjs/api/types/RetryRunWebhookRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/UploadFileResponse.d.ts

@@ -0,0 +1,6 @@
+export interface UploadFileResponse {
+    /** S3 URI where the file was uploaded */
+    s3_uri: string;
+    /** Presigned URL to access the uploaded file */
+    presigned_url: string;
+}

package/dist/cjs/api/types/UploadFileResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/Workflow.d.ts

@@ -6,6 +6,7 @@ export interface Workflow {
     workflow_permanent_id: string;
     version: number;
     is_saved_task: boolean;
+    is_template?: boolean;
     description?: string;
     workflow_definition: Skyvern.WorkflowDefinition;
     proxy_location?: Workflow.ProxyLocation;

package/dist/cjs/api/types/index.d.ts

@@ -96,6 +96,7 @@ export * from "./PdfParserBlockYaml.js";
 export * from "./PromptAction.js";
 export * from "./PromptBranchCriteria.js";
 export * from "./ProxyLocation.js";
+export * from "./RetryRunWebhookRequest.js";
 export * from "./RunEngine.js";
 export * from "./RunSdkActionRequestAction.js";
 export * from "./RunSdkActionResponse.js";
@@ -127,6 +128,7 @@ export * from "./ThoughtType.js";
 export * from "./TotpCode.js";
 export * from "./TotpType.js";
 export * from "./UploadFileAction.js";
+export * from "./UploadFileResponse.js";
 export * from "./UploadToS3Block.js";
 export * from "./UploadToS3BlockYaml.js";
 export * from "./UrlBlock.js";

package/dist/cjs/api/types/index.js

@@ -112,6 +112,7 @@ __exportStar(require("./PdfParserBlockYaml.js"), exports);
 __exportStar(require("./PromptAction.js"), exports);
 __exportStar(require("./PromptBranchCriteria.js"), exports);
 __exportStar(require("./ProxyLocation.js"), exports);
+__exportStar(require("./RetryRunWebhookRequest.js"), exports);
 __exportStar(require("./RunEngine.js"), exports);
 __exportStar(require("./RunSdkActionRequestAction.js"), exports);
 __exportStar(require("./RunSdkActionResponse.js"), exports);
@@ -143,6 +144,7 @@ __exportStar(require("./ThoughtType.js"), exports);
 __exportStar(require("./TotpCode.js"), exports);
 __exportStar(require("./TotpType.js"), exports);
 __exportStar(require("./UploadFileAction.js"), exports);
+__exportStar(require("./UploadFileResponse.js"), exports);
 __exportStar(require("./UploadToS3Block.js"), exports);
 __exportStar(require("./UploadToS3BlockYaml.js"), exports);
 __exportStar(require("./UrlBlock.js"), exports);

package/dist/cjs/core/exports.d.ts

@@ -0,0 +1 @@
+export * from "./file/exports.js";

package/dist/cjs/core/exports.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./file/exports.js"), exports);

package/dist/cjs/core/file/exports.d.ts

@@ -0,0 +1 @@
+export type { Uploadable } from "./types.js";

package/dist/cjs/core/file/exports.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/core/file/file.d.ts

@@ -0,0 +1,10 @@
+import type { Uploadable } from "./types.js";
+export declare function toBinaryUploadRequest(file: Uploadable): Promise<{
+    body: Uploadable.FileLike;
+    headers?: Record<string, string>;
+}>;
+export declare function toMultipartDataPart(file: Uploadable): Promise<{
+    data: Uploadable.FileLike;
+    filename?: string;
+    contentType?: string;
+}>;

package/dist/cjs/core/file/file.js

@@ -0,0 +1,221 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toBinaryUploadRequest = toBinaryUploadRequest;
+exports.toMultipartDataPart = toMultipartDataPart;
+function toBinaryUploadRequest(file) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { data, filename, contentLength, contentType } = yield getFileWithMetadata(file);
+        const request = {
+            body: data,
+            headers: {},
+        };
+        if (filename) {
+            request.headers["Content-Disposition"] = `attachment; filename="${filename}"`;
+        }
+        if (contentType) {
+            request.headers["Content-Type"] = contentType;
+        }
+        if (contentLength != null) {
+            request.headers["Content-Length"] = contentLength.toString();
+        }
+        return request;
+    });
+}
+function toMultipartDataPart(file) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { data, filename, contentType } = yield getFileWithMetadata(file, {
+            noSniffFileSize: true,
+        });
+        return {
+            data,
+            filename,
+            contentType,
+        };
+    });
+}
+function getFileWithMetadata(file_1) {
+    return __awaiter(this, arguments, void 0, function* (file, { noSniffFileSize } = {}) {
+        var _a, _b, _c, _d, _e;
+        if (isFileLike(file)) {
+            return getFileWithMetadata({
+                data: file,
+            }, { noSniffFileSize });
+        }
+        if ("path" in file) {
+            const fs = yield Promise.resolve().then(() => __importStar(require("fs")));
+            if (!fs || !fs.createReadStream) {
+                throw new Error("File path uploads are not supported in this environment.");
+            }
+            const data = fs.createReadStream(file.path);
+            const contentLength = (_a = file.contentLength) !== null && _a !== void 0 ? _a : (noSniffFileSize === true ? undefined : yield tryGetFileSizeFromPath(file.path));
+            const filename = (_b = file.filename) !== null && _b !== void 0 ? _b : getNameFromPath(file.path);
+            return {
+                data,
+                filename,
+                contentType: file.contentType,
+                contentLength,
+            };
+        }
+        if ("data" in file) {
+            const data = file.data;
+            const contentLength = (_c = file.contentLength) !== null && _c !== void 0 ? _c : (yield tryGetContentLengthFromFileLike(data, {
+                noSniffFileSize,
+            }));
+            const filename = (_d = file.filename) !== null && _d !== void 0 ? _d : tryGetNameFromFileLike(data);
+            return {
+                data,
+                filename,
+                contentType: (_e = file.contentType) !== null && _e !== void 0 ? _e : tryGetContentTypeFromFileLike(data),
+                contentLength,
+            };
+        }
+        throw new Error(`Invalid FileUpload of type ${typeof file}: ${JSON.stringify(file)}`);
+    });
+}
+function isFileLike(value) {
+    return (isBuffer(value) ||
+        isArrayBufferView(value) ||
+        isArrayBuffer(value) ||
+        isUint8Array(value) ||
+        isBlob(value) ||
+        isFile(value) ||
+        isStreamLike(value) ||
+        isReadableStream(value));
+}
+function tryGetFileSizeFromPath(path) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const fs = yield Promise.resolve().then(() => __importStar(require("fs")));
+            if (!fs || !fs.promises || !fs.promises.stat) {
+                return undefined;
+            }
+            const fileStat = yield fs.promises.stat(path);
+            return fileStat.size;
+        }
+        catch (_fallbackError) {
+            return undefined;
+        }
+    });
+}
+function tryGetNameFromFileLike(data) {
+    if (isNamedValue(data)) {
+        return data.name;
+    }
+    if (isPathedValue(data)) {
+        return getNameFromPath(data.path.toString());
+    }
+    return undefined;
+}
+function tryGetContentLengthFromFileLike(data_1) {
+    return __awaiter(this, arguments, void 0, function* (data, { noSniffFileSize } = {}) {
+        if (isBuffer(data)) {
+            return data.length;
+        }
+        if (isArrayBufferView(data)) {
+            return data.byteLength;
+        }
+        if (isArrayBuffer(data)) {
+            return data.byteLength;
+        }
+        if (isBlob(data)) {
+            return data.size;
+        }
+        if (isFile(data)) {
+            return data.size;
+        }
+        if (noSniffFileSize === true) {
+            return undefined;
+        }
+        if (isPathedValue(data)) {
+            return yield tryGetFileSizeFromPath(data.path.toString());
+        }
+        return undefined;
+    });
+}
+function tryGetContentTypeFromFileLike(data) {
+    if (isBlob(data)) {
+        return data.type;
+    }
+    if (isFile(data)) {
+        return data.type;
+    }
+    return undefined;
+}
+function getNameFromPath(path) {
+    const lastForwardSlash = path.lastIndexOf("/");
+    const lastBackSlash = path.lastIndexOf("\\");
+    const lastSlashIndex = Math.max(lastForwardSlash, lastBackSlash);
+    return lastSlashIndex >= 0 ? path.substring(lastSlashIndex + 1) : path;
+}
+function isNamedValue(value) {
+    return typeof value === "object" && value != null && "name" in value;
+}
+function isPathedValue(value) {
+    return typeof value === "object" && value != null && "path" in value;
+}
+function isStreamLike(value) {
+    return typeof value === "object" && value != null && ("read" in value || "pipe" in value);
+}
+function isReadableStream(value) {
+    return typeof value === "object" && value != null && "getReader" in value;
+}
+function isBuffer(value) {
+    return typeof Buffer !== "undefined" && Buffer.isBuffer && Buffer.isBuffer(value);
+}
+function isArrayBufferView(value) {
+    return typeof ArrayBuffer !== "undefined" && ArrayBuffer.isView(value);
+}
+function isArrayBuffer(value) {
+    return typeof ArrayBuffer !== "undefined" && value instanceof ArrayBuffer;
+}
+function isUint8Array(value) {
+    return typeof Uint8Array !== "undefined" && value instanceof Uint8Array;
+}
+function isBlob(value) {
+    return typeof Blob !== "undefined" && value instanceof Blob;
+}
+function isFile(value) {
+    return typeof File !== "undefined" && value instanceof File;
+}

package/dist/cjs/core/file/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./file.js";
+export * from "./types.js";