npm - pulse-ts-sdk - Versions diffs - 0.0.52 → 0.0.54 - Mend

pulse-ts-sdk 0.0.52 → 0.0.54

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (88) hide show

package/README.md +44 -3
package/dist/cjs/BaseClient.js +2 -2
package/dist/cjs/Client.d.ts +8 -10
package/dist/cjs/Client.js +113 -16
package/dist/cjs/api/client/index.d.ts +1 -0
package/dist/cjs/api/client/index.js +17 -0
package/dist/cjs/api/{types/ExtractMultipartInput.d.ts → client/requests/ExtractAsyncRequest.d.ts} +13 -7
package/dist/{esm/api/types/ExtractJsonInput.d.mts → cjs/api/client/requests/ExtractRequest.d.ts} +13 -9
package/dist/cjs/api/client/requests/index.d.ts +2 -0
package/dist/cjs/api/{types/JsonSource.js → client/requests/index.js} +0 -1
package/dist/cjs/api/index.d.ts +1 -0
package/dist/cjs/api/index.js +1 -0
package/dist/cjs/api/types/ExtractInput.d.ts +63 -1
package/dist/cjs/api/types/ExtractSource.d.ts +9 -0
package/dist/cjs/api/types/index.d.ts +1 -5
package/dist/cjs/api/types/index.js +1 -5
package/dist/cjs/core/exports.d.ts +1 -0
package/dist/cjs/core/exports.js +1 -0
package/dist/cjs/core/file/exports.d.ts +1 -0
package/dist/cjs/core/file/exports.js +2 -0
package/dist/cjs/core/file/file.d.ts +10 -0
package/dist/cjs/core/file/file.js +221 -0
package/dist/cjs/core/file/index.d.ts +2 -0
package/dist/cjs/core/file/index.js +18 -0
package/dist/cjs/core/file/types.d.ts +66 -0
package/dist/cjs/core/file/types.js +2 -0
package/dist/cjs/core/form-data-utils/FormDataWrapper.d.ts +15 -0
package/dist/cjs/core/form-data-utils/FormDataWrapper.js +185 -0
package/dist/cjs/core/form-data-utils/encodeAsFormParameter.d.ts +1 -0
package/dist/cjs/core/form-data-utils/encodeAsFormParameter.js +12 -0
package/dist/cjs/core/form-data-utils/index.d.ts +2 -0
package/dist/cjs/core/form-data-utils/index.js +20 -0
package/dist/cjs/core/index.d.ts +2 -0
package/dist/cjs/core/index.js +3 -1
package/dist/cjs/version.d.ts +1 -1
package/dist/cjs/version.js +1 -1
package/dist/esm/BaseClient.mjs +2 -2
package/dist/esm/Client.d.mts +8 -10
package/dist/esm/Client.mjs +114 -17
package/dist/esm/api/client/index.d.mts +1 -0
package/dist/esm/api/client/index.mjs +1 -0
package/dist/esm/api/{types/ExtractMultipartInput.d.mts → client/requests/ExtractAsyncRequest.d.mts} +13 -7
package/dist/{cjs/api/types/ExtractJsonInput.d.ts → esm/api/client/requests/ExtractRequest.d.mts} +13 -9
package/dist/esm/api/client/requests/index.d.mts +2 -0
package/dist/esm/api/client/requests/index.mjs +1 -0
package/dist/esm/api/index.d.mts +1 -0
package/dist/esm/api/index.mjs +1 -0
package/dist/esm/api/types/ExtractInput.d.mts +63 -1
package/dist/esm/api/types/ExtractSource.d.mts +9 -0
package/dist/esm/api/types/index.d.mts +1 -5
package/dist/esm/api/types/index.mjs +1 -5
package/dist/esm/core/exports.d.mts +1 -0
package/dist/esm/core/exports.mjs +1 -0
package/dist/esm/core/file/exports.d.mts +1 -0
package/dist/esm/core/file/exports.mjs +1 -0
package/dist/esm/core/file/file.d.mts +10 -0
package/dist/esm/core/file/file.mjs +184 -0
package/dist/esm/core/file/index.d.mts +2 -0
package/dist/esm/core/file/index.mjs +2 -0
package/dist/esm/core/file/types.d.mts +66 -0
package/dist/esm/core/file/types.mjs +1 -0
package/dist/esm/core/form-data-utils/FormDataWrapper.d.mts +15 -0
package/dist/esm/core/form-data-utils/FormDataWrapper.mjs +147 -0
package/dist/esm/core/form-data-utils/encodeAsFormParameter.d.mts +1 -0
package/dist/esm/core/form-data-utils/encodeAsFormParameter.mjs +9 -0
package/dist/esm/core/form-data-utils/index.d.mts +2 -0
package/dist/esm/core/form-data-utils/index.mjs +2 -0
package/dist/esm/core/index.d.mts +2 -0
package/dist/esm/core/index.mjs +2 -0
package/dist/esm/version.d.mts +1 -1
package/dist/esm/version.mjs +1 -1
package/package.json +1 -1
package/reference.md +4 -8
package/dist/cjs/api/types/ExtractAsyncInput.d.ts +0 -1
package/dist/cjs/api/types/JsonSource.d.ts +0 -7
package/dist/cjs/api/types/MultipartSource.d.ts +0 -10
package/dist/cjs/api/types/MultipartSource.js +0 -3
package/dist/esm/api/types/ExtractAsyncInput.d.mts +0 -1
package/dist/esm/api/types/JsonSource.d.mts +0 -7
package/dist/esm/api/types/JsonSource.mjs +0 -2
package/dist/esm/api/types/MultipartSource.d.mts +0 -10
package/dist/esm/api/types/MultipartSource.mjs +0 -2
/package/dist/cjs/api/{types/ExtractAsyncInput.js → client/requests/ExtractAsyncRequest.js} +0 -0
/package/dist/cjs/api/{types/ExtractJsonInput.js → client/requests/ExtractRequest.js} +0 -0
/package/dist/cjs/api/types/{ExtractMultipartInput.js → ExtractSource.js} +0 -0
/package/dist/esm/api/{types/ExtractAsyncInput.mjs → client/requests/ExtractAsyncRequest.mjs} +0 -0
/package/dist/esm/api/{types/ExtractJsonInput.mjs → client/requests/ExtractRequest.mjs} +0 -0
/package/dist/esm/api/types/{ExtractMultipartInput.mjs → ExtractSource.mjs} +0 -0

package/dist/esm/core/file/types.d.mts ADDED Viewed

@@ -0,0 +1,66 @@
+/**
+ * A file that can be uploaded. Can be a file-like object (stream, buffer, blob, etc.),
+ * a path to a file, or an object with a file-like object and metadata.
+ */
+export type Uploadable = Uploadable.FileLike | Uploadable.FromPath | Uploadable.WithMetadata;
+export declare namespace Uploadable {
+    /**
+     * Various file-like objects that can be used to upload a file.
+     */
+    type FileLike = ArrayBuffer | ArrayBufferLike | ArrayBufferView | Uint8Array | import("buffer").Buffer | import("buffer").Blob | import("buffer").File | import("stream").Readable | import("stream/web").ReadableStream | globalThis.Blob | globalThis.File | ReadableStream;
+    /**
+     * A file path with optional metadata, used for uploading a file from the file system.
+     */
+    type FromPath = {
+        /** The path to the file to upload */
+        path: string;
+        /**
+         * Optional override for the file name (defaults to basename of path).
+         * This is used to set the `Content-Disposition` header in upload requests.
+         */
+        filename?: string;
+        /**
+         * Optional MIME type of the file (e.g., 'image/jpeg', 'text/plain').
+         * This is used to set the `Content-Type` header in upload requests.
+         */
+        contentType?: string;
+        /**
+         * Optional file size in bytes.
+         * If not provided, the file size will be determined from the file system.
+         * The content length is used to set the `Content-Length` header in upload requests.
+         */
+        contentLength?: number;
+    };
+    /**
+     * A file-like object with metadata, used for uploading files.
+     */
+    type WithMetadata = {
+        /** The file data */
+        data: FileLike;
+        /**
+         * Optional override for the file name (defaults to basename of path).
+         * This is used to set the `Content-Disposition` header in upload requests.
+         */
+        filename?: string;
+        /**
+         * Optional MIME type of the file (e.g., 'image/jpeg', 'text/plain').
+         * This is used to set the `Content-Type` header in upload requests.
+         *
+         * If not provided, the content type may be determined from the data itself.
+         * * If the data is a `File`, `Blob`, or similar, the content type will be determined from the file itself, if the type is set.
+         * * Any other data type will not have a content type set, and the upload request will use `Content-Type: application/octet-stream` instead.
+         */
+        contentType?: string;
+        /**
+         * Optional file size in bytes.
+         * The content length is used to set the `Content-Length` header in upload requests.
+         * If the content length is not provided and cannot be determined, the upload request will not include the `Content-Length` header, but will use `Transfer-Encoding: chunked` instead.
+         *
+         * If not provided, the file size will be determined depending on the data type.
+         * * If the data is of type `fs.ReadStream` (`createReadStream`), the size will be determined from the file system.
+         * * If the data is a `Buffer`, `ArrayBuffer`, `Uint8Array`, `Blob`, `File`, or similar, the size will be determined from the data itself.
+         * * If the data is a `Readable` or `ReadableStream`, the size will not be determined.
+         */
+        contentLength?: number;
+    };
+}

package/dist/esm/core/file/types.mjs ADDED Viewed

	@@ -0,0 +1 @@
1	+ export {};

package/dist/esm/core/form-data-utils/FormDataWrapper.d.mts ADDED Viewed

@@ -0,0 +1,15 @@
+import { type Uploadable } from "../../core/file/index.mjs";
+interface FormDataRequest<Body> {
+    body: Body;
+    headers: Record<string, string>;
+    duplex?: "half";
+}
+export declare function newFormData(): Promise<FormDataWrapper>;
+export declare class FormDataWrapper {
+    private fd;
+    setup(): Promise<void>;
+    append(key: string, value: unknown): void;
+    appendFile(key: string, value: Uploadable): Promise<void>;
+    getRequest(): FormDataRequest<FormData>;
+}
+export {};

package/dist/esm/core/form-data-utils/FormDataWrapper.mjs ADDED Viewed

@@ -0,0 +1,147 @@
+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());
+    });
+};
+var __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
+import { toMultipartDataPart } from "../../core/file/index.mjs";
+import { toJson } from "../../core/json.mjs";
+import { RUNTIME } from "../runtime/index.mjs";
+export function newFormData() {
+    return __awaiter(this, void 0, void 0, function* () {
+        return new FormDataWrapper();
+    });
+}
+export class FormDataWrapper {
+    constructor() {
+        this.fd = new FormData();
+    }
+    setup() {
+        return __awaiter(this, void 0, void 0, function* () {
+            // noop
+        });
+    }
+    append(key, value) {
+        this.fd.append(key, String(value));
+    }
+    appendFile(key, value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data, filename, contentType } = yield toMultipartDataPart(value);
+            const blob = yield convertToBlob(data, contentType);
+            if (filename) {
+                this.fd.append(key, blob, filename);
+            }
+            else {
+                this.fd.append(key, blob);
+            }
+        });
+    }
+    getRequest() {
+        return {
+            body: this.fd,
+            headers: {},
+            duplex: "half",
+        };
+    }
+}
+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 ArrayBuffer.isView(value);
+}
+function streamToBuffer(stream) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a, stream_1, stream_1_1;
+        var _b, e_1, _c, _d;
+        if (RUNTIME.type === "node") {
+            const { Readable } = yield import("stream");
+            if (stream instanceof Readable) {
+                const chunks = [];
+                try {
+                    for (_a = true, stream_1 = __asyncValues(stream); stream_1_1 = yield stream_1.next(), _b = stream_1_1.done, !_b; _a = true) {
+                        _d = stream_1_1.value;
+                        _a = false;
+                        const chunk = _d;
+                        chunks.push(Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk));
+                    }
+                }
+                catch (e_1_1) { e_1 = { error: e_1_1 }; }
+                finally {
+                    try {
+                        if (!_a && !_b && (_c = stream_1.return)) yield _c.call(stream_1);
+                    }
+                    finally { if (e_1) throw e_1.error; }
+                }
+                return Buffer.concat(chunks);
+            }
+        }
+        if (isReadableStream(stream)) {
+            const reader = stream.getReader();
+            const chunks = [];
+            try {
+                while (true) {
+                    const { done, value } = yield reader.read();
+                    if (done)
+                        break;
+                    chunks.push(value);
+                }
+            }
+            finally {
+                reader.releaseLock();
+            }
+            const totalLength = chunks.reduce((sum, chunk) => sum + chunk.length, 0);
+            const result = new Uint8Array(totalLength);
+            let offset = 0;
+            for (const chunk of chunks) {
+                result.set(chunk, offset);
+                offset += chunk.length;
+            }
+            return Buffer.from(result);
+        }
+        throw new Error(`Unsupported stream type: ${typeof stream}. Expected Node.js Readable stream or Web ReadableStream.`);
+    });
+}
+function convertToBlob(value, contentType) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (isStreamLike(value) || isReadableStream(value)) {
+            const buffer = yield streamToBuffer(value);
+            return new Blob([buffer], { type: contentType });
+        }
+        if (value instanceof Blob) {
+            return value;
+        }
+        if (isBuffer(value)) {
+            return new Blob([value], { type: contentType });
+        }
+        if (value instanceof ArrayBuffer) {
+            return new Blob([value], { type: contentType });
+        }
+        if (isArrayBufferView(value)) {
+            return new Blob([value], { type: contentType });
+        }
+        if (typeof value === "string") {
+            return new Blob([value], { type: contentType });
+        }
+        if (typeof value === "object" && value !== null) {
+            return new Blob([toJson(value)], { type: contentType !== null && contentType !== void 0 ? contentType : "application/json" });
+        }
+        return new Blob([String(value)], { type: contentType });
+    });
+}

package/dist/esm/core/form-data-utils/encodeAsFormParameter.d.mts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export declare function encodeAsFormParameter(value: unknown): Record<string, string>;

package/dist/esm/core/form-data-utils/encodeAsFormParameter.mjs ADDED Viewed

@@ -0,0 +1,9 @@
+import { toQueryString } from "../url/qs.mjs";
+export function encodeAsFormParameter(value) {
+    const stringified = toQueryString(value, { encode: false });
+    const keyValuePairs = stringified.split("&").map((pair) => {
+        const [key, value] = pair.split("=");
+        return [key, value];
+    });
+    return Object.fromEntries(keyValuePairs);
+}

package/dist/esm/core/form-data-utils/index.d.mts ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ export { encodeAsFormParameter } from "./encodeAsFormParameter.mjs";
2	+ export * from "./FormDataWrapper.mjs";

package/dist/esm/core/form-data-utils/index.mjs ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ export { encodeAsFormParameter } from "./encodeAsFormParameter.mjs";
2	+ export * from "./FormDataWrapper.mjs";

package/dist/esm/core/index.d.mts CHANGED Viewed

@@ -1,6 +1,8 @@
 export * from "./auth/index.mjs";
 export * from "./base64.mjs";
 export * from "./fetcher/index.mjs";
+export * as file from "./file/index.mjs";
+export * from "./form-data-utils/index.mjs";
 export * as logging from "./logging/index.mjs";
 export * from "./runtime/index.mjs";
 export * as url from "./url/index.mjs";

package/dist/esm/core/index.mjs CHANGED Viewed

@@ -1,6 +1,8 @@
 export * from "./auth/index.mjs";
 export * from "./base64.mjs";
 export * from "./fetcher/index.mjs";
+export * as file from "./file/index.mjs";
+export * from "./form-data-utils/index.mjs";
 export * as logging from "./logging/index.mjs";
 export * from "./runtime/index.mjs";
 export * as url from "./url/index.mjs";

package/dist/esm/version.d.mts CHANGED Viewed

	@@ -1 +1 @@
1	- export declare const SDK_VERSION = "0.0.52";
1	+ export declare const SDK_VERSION = "0.0.54";

package/dist/esm/version.mjs CHANGED Viewed

	@@ -1 +1 @@
1	- export const SDK_VERSION = "0.0.52";
1	+ export const SDK_VERSION = "0.0.54";

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
     "name": "pulse-ts-sdk",
-    "version": "0.0.52",
+    "version": "0.0.54",
     "private": false,
     "repository": {
         "type": "git",

package/reference.md CHANGED Viewed

@@ -28,9 +28,7 @@ extraction based on user-provided schemas and extraction options.
 <dd>
 ```typescript
-await client.extract({
-    fileUrl: "fileUrl"
-});
+await client.extract({});
 ```
 </dd>
@@ -46,7 +44,7 @@ await client.extract({
 <dl>
 <dd>
-**request:** `Pulse.ExtractJsonInput`
+**request:** `Pulse.ExtractRequest`
 </dd>
 </dl>
@@ -95,9 +93,7 @@ clients can poll for completion status.
 <dd>
 ```typescript
-await client.extractAsync({
-    fileUrl: "fileUrl"
-});
+await client.extractAsync({});
 ```
 </dd>
@@ -113,7 +109,7 @@ await client.extractAsync({
 <dl>
 <dd>
-**request:** `Pulse.ExtractJsonInput`
+**request:** `Pulse.ExtractAsyncRequest`
 </dd>
 </dl>

package/dist/cjs/api/types/ExtractAsyncInput.d.ts DELETED Viewed

	@@ -1 +0,0 @@
1	- export type ExtractAsyncInput = unknown;

package/dist/cjs/api/types/JsonSource.d.ts DELETED Viewed

@@ -1,7 +0,0 @@
-/**
- * Document source definition for JSON requests.
- */
-export interface JsonSource {
-    /** Public or pre-signed URL that Pulse will download and extract. */
-    fileUrl: string;
-}

package/dist/cjs/api/types/MultipartSource.d.ts DELETED Viewed

@@ -1,10 +0,0 @@
-/**
- * Document source definition for multipart/form-data requests. Provide exactly one of `file` (direct upload) or `fileUrl` (remote URL).
- */
-export type MultipartSource = {
-    file: string;
-    fileUrl?: unknown | undefined;
-} | {
-    fileUrl: string;
-    file?: unknown | undefined;
-};

package/dist/cjs/api/types/MultipartSource.js DELETED Viewed

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

package/dist/esm/api/types/ExtractAsyncInput.d.mts DELETED Viewed

	@@ -1 +0,0 @@
1	- export type ExtractAsyncInput = unknown;

package/dist/esm/api/types/JsonSource.d.mts DELETED Viewed

@@ -1,7 +0,0 @@
-/**
- * Document source definition for JSON requests.
- */
-export interface JsonSource {
-    /** Public or pre-signed URL that Pulse will download and extract. */
-    fileUrl: string;
-}

package/dist/esm/api/types/JsonSource.mjs DELETED Viewed

	@@ -1,2 +0,0 @@
1	- // This file was auto-generated by Fern from our API Definition.
2	- export {};

package/dist/esm/api/types/MultipartSource.d.mts DELETED Viewed

@@ -1,10 +0,0 @@
-/**
- * Document source definition for multipart/form-data requests. Provide exactly one of `file` (direct upload) or `fileUrl` (remote URL).
- */
-export type MultipartSource = {
-    file: string;
-    fileUrl?: unknown | undefined;
-} | {
-    fileUrl: string;
-    file?: unknown | undefined;
-};

package/dist/esm/api/types/MultipartSource.mjs DELETED Viewed

	@@ -1,2 +0,0 @@
1	- // This file was auto-generated by Fern from our API Definition.
2	- export {};

/package/dist/cjs/api/{types/ExtractAsyncInput.js → client/requests/ExtractAsyncRequest.js} RENAMED Viewed

File without changes

/package/dist/cjs/api/{types/ExtractJsonInput.js → client/requests/ExtractRequest.js} RENAMED Viewed

File without changes

/package/dist/cjs/api/types/{ExtractMultipartInput.js → ExtractSource.js} RENAMED Viewed

File without changes

/package/dist/esm/api/{types/ExtractAsyncInput.mjs → client/requests/ExtractAsyncRequest.mjs} RENAMED Viewed

File without changes

/package/dist/esm/api/{types/ExtractJsonInput.mjs → client/requests/ExtractRequest.mjs} RENAMED Viewed

File without changes

/package/dist/esm/api/types/{ExtractMultipartInput.mjs → ExtractSource.mjs} RENAMED Viewed

File without changes