@credal/sdk 0.1.9 → 0.1.10

package/dist/cjs/core/form-data-utils/FormDataWrapper.js

@@ -0,0 +1,185 @@
+"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());
+    });
+};
+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); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FormDataWrapper = void 0;
+exports.newFormData = newFormData;
+const index_js_1 = require("../../core/file/index.js");
+const json_js_1 = require("../../core/json.js");
+const index_js_2 = require("../runtime/index.js");
+function newFormData() {
+    return __awaiter(this, void 0, void 0, function* () {
+        return new FormDataWrapper();
+    });
+}
+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 (0, index_js_1.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",
+        };
+    }
+}
+exports.FormDataWrapper = FormDataWrapper;
+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 (index_js_2.RUNTIME.type === "node") {
+            const { Readable } = yield Promise.resolve().then(() => __importStar(require("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([(0, json_js_1.toJson)(value)], { type: contentType !== null && contentType !== void 0 ? contentType : "application/json" });
+        }
+        return new Blob([String(value)], { type: contentType });
+    });
+}

package/dist/cjs/core/form-data-utils/encodeAsFormParameter.d.ts

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

package/dist/cjs/core/form-data-utils/encodeAsFormParameter.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.encodeAsFormParameter = encodeAsFormParameter;
+const qs_js_1 = require("../url/qs.js");
+function encodeAsFormParameter(value) {
+    const stringified = (0, qs_js_1.toQueryString)(value, { encode: false });
+    const keyValuePairs = stringified.split("&").map((pair) => {
+        const [key, value] = pair.split("=");
+        return [key, value];
+    });
+    return Object.fromEntries(keyValuePairs);
+}

package/dist/cjs/core/form-data-utils/index.d.ts

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

package/dist/cjs/core/form-data-utils/index.js

@@ -0,0 +1,20 @@
+"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 });
+exports.encodeAsFormParameter = void 0;
+var encodeAsFormParameter_js_1 = require("./encodeAsFormParameter.js");
+Object.defineProperty(exports, "encodeAsFormParameter", { enumerable: true, get: function () { return encodeAsFormParameter_js_1.encodeAsFormParameter; } });
+__exportStar(require("./FormDataWrapper.js"), exports);

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

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

package/dist/cjs/core/index.js

@@ -36,10 +36,12 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.url = void 0;
+exports.url = exports.file = void 0;
 __exportStar(require("./auth/index.js"), exports);
 __exportStar(require("./base64.js"), exports);
 __exportStar(require("./fetcher/index.js"), exports);
+exports.file = __importStar(require("./file/index.js"));
+__exportStar(require("./form-data-utils/index.js"), exports);
 __exportStar(require("./runtime/index.js"), exports);
 __exportStar(require("./stream/index.js"), exports);
 exports.url = __importStar(require("./url/index.js"));

package/dist/cjs/exports.d.ts

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

package/dist/cjs/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("./core/exports.js"), exports);

package/dist/cjs/index.d.ts

@@ -3,3 +3,4 @@ export type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.js";
 export { CredalClient } from "./Client.js";
 export { CredalEnvironment } from "./environments.js";
 export { CredalError, CredalTimeoutError } from "./errors/index.js";
+export * from "./exports.js";

package/dist/cjs/index.js

@@ -32,6 +32,9 @@ var __importStar = (this && this.__importStar) || (function () {
         return result;
     };
 })();
+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 });
 exports.CredalTimeoutError = exports.CredalError = exports.CredalEnvironment = exports.CredalClient = exports.Credal = void 0;
 exports.Credal = __importStar(require("./api/index.js"));
@@ -42,3 +45,4 @@ Object.defineProperty(exports, "CredalEnvironment", { enumerable: true, get: fun
 var index_js_1 = require("./errors/index.js");
 Object.defineProperty(exports, "CredalError", { enumerable: true, get: function () { return index_js_1.CredalError; } });
 Object.defineProperty(exports, "CredalTimeoutError", { enumerable: true, get: function () { return index_js_1.CredalTimeoutError; } });
+__exportStar(require("./exports.js"), exports);

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.1.9";
+export declare const SDK_VERSION = "0.1.10";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "0.1.9";
+exports.SDK_VERSION = "0.1.10";

package/dist/esm/Client.mjs

@@ -11,8 +11,8 @@ export class CredalClient {
         this._options = Object.assign(Object.assign({}, _options), { headers: mergeHeaders({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@credal/sdk",
-                "X-Fern-SDK-Version": "0.1.9",
-                "User-Agent": "@credal/sdk/0.1.9",
+                "X-Fern-SDK-Version": "0.1.10",
+                "User-Agent": "@credal/sdk/0.1.10",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

package/dist/esm/api/resources/documentCatalog/client/Client.d.mts

@@ -25,6 +25,14 @@ export declare class DocumentCatalog {
      */
     uploadDocumentContents(request: Credal.UploadDocumentContentsRequest, requestOptions?: DocumentCatalog.RequestOptions): core.HttpResponsePromise<Credal.UploadDocumentResponse>;
     private __uploadDocumentContents;
+    /**
+     * Upload a file (PDF, Word, Excel, CSV, PowerPoint) to Credal. Unlike uploadDocumentContents which requires pre-parsed text, this endpoint accepts actual file uploads and automatically parses them using Credal's parsing service.
+     *
+     * @param {Credal.UploadFileRequest} request
+     * @param {DocumentCatalog.RequestOptions} requestOptions - Request-specific configuration.
+     */
+    uploadFile(request: Credal.UploadFileRequest, requestOptions?: DocumentCatalog.RequestOptions): core.HttpResponsePromise<Credal.UploadDocumentResponse>;
+    private __uploadFile;
     /**
      * Sync a document from a source URL. Does not support recursive web search. Reach out to a Credal representative for access.
      *

package/dist/esm/api/resources/documentCatalog/client/Client.mjs

@@ -75,6 +75,90 @@ export class DocumentCatalog {
             }
         });
     }
+    /**
+     * Upload a file (PDF, Word, Excel, CSV, PowerPoint) to Credal. Unlike uploadDocumentContents which requires pre-parsed text, this endpoint accepts actual file uploads and automatically parses them using Credal's parsing service.
+     *
+     * @param {Credal.UploadFileRequest} request
+     * @param {DocumentCatalog.RequestOptions} requestOptions - Request-specific configuration.
+     */
+    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;
+            const _request = yield core.newFormData();
+            yield _request.appendFile("file", request.file);
+            if (request.documentName != null) {
+                _request.append("documentName", request.documentName);
+            }
+            _request.append("uploadAsUserEmail", request.uploadAsUserEmail);
+            _request.append("documentExternalId", request.documentExternalId);
+            if (request.allowedUsersEmailAddresses != null) {
+                _request.append("allowedUsersEmailAddresses", request.allowedUsersEmailAddresses);
+            }
+            if (request.documentExternalUrl != null) {
+                _request.append("documentExternalUrl", request.documentExternalUrl);
+            }
+            if (request.customMetadata != null) {
+                _request.append("customMetadata", request.customMetadata);
+            }
+            if (request.collectionId != null) {
+                _request.append("collectionId", request.collectionId);
+            }
+            if (request.forceUpdate != null) {
+                _request.append("forceUpdate", request.forceUpdate);
+            }
+            if (request.internalPublic != null) {
+                _request.append("internalPublic", request.internalPublic);
+            }
+            if (request.sourceSystemUpdated != null) {
+                _request.append("sourceSystemUpdated", request.sourceSystemUpdated);
+            }
+            if (request.awaitVectorStoreSync != null) {
+                _request.append("awaitVectorStoreSync", request.awaitVectorStoreSync);
+            }
+            const _maybeEncodedRequest = yield _request.getRequest();
+            const _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders(Object.assign({ Authorization: yield this._getAuthorizationHeader() }, _maybeEncodedRequest.headers)), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
+                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.CredalEnvironment.Production, "/v0/catalog/uploadFile"),
+                method: "POST",
+                headers: _headers,
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "file",
+                duplex: _maybeEncodedRequest.duplex,
+                body: _maybeEncodedRequest.body,
+                timeoutMs: ((_g = (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.timeoutInSeconds) !== null && _g !== void 0 ? _g : 60) * 1000,
+                maxRetries: (_h = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _h !== void 0 ? _h : (_j = this._options) === null || _j === void 0 ? void 0 : _j.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") {
+                throw new errors.CredalError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.body,
+                    rawResponse: _response.rawResponse,
+                });
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.CredalError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.CredalTimeoutError("Timeout exceeded when calling POST /v0/catalog/uploadFile.");
+                case "unknown":
+                    throw new errors.CredalError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     /**
      * Sync a document from a source URL. Does not support recursive web search. Reach out to a Credal representative for access.
      *

package/dist/esm/api/resources/documentCatalog/client/requests/UploadFileRequest.d.mts

@@ -0,0 +1,27 @@
+import type * as core from "../../../../../core/index.mjs";
+export interface UploadFileRequest {
+    /** The file to upload. Supported formats: PDF (.pdf), Word (.docx), Excel (.xlsx, .xls), PowerPoint (.pptx, .ppt), CSV (.csv), and text files. */
+    file: core.file.Uploadable;
+    /** The name of the document you want to upload. If not provided, the original filename will be used. */
+    documentName?: string;
+    /** [Legacy] The user on behalf of whom the document should be uploaded. In most cases, this can simply be the email of the developer making the API call. This field will be removed in the future in favor of purely specifying permissions via allowedUsersEmailAddresses. */
+    uploadAsUserEmail: string;
+    /** The external ID of the document. This is typically the ID as it exists in its original external system. Uploads to the same external ID will update the document in Credal. */
+    documentExternalId: string;
+    /** Users allowed to access the document. Can be provided as a JSON array string (e.g., ["user1@example.com","user2@example.com"]) or comma-separated list (e.g., "user1@example.com,user2@example.com"). Unlike Credal's out of the box connectors which reconcile various permissions models from 3rd party software, for custom uploads the caller is responsible for specifying who can access the document and currently flattening groups if applicable. Documents can also be marked as internal public. */
+    allowedUsersEmailAddresses?: string;
+    /** The external URL of the document you want to upload. If provided Credal will link to this URL. */
+    documentExternalUrl?: string;
+    /** Optional JSON string representing any custom metadata for this document (e.g., '{"key1":"value1","key2":"value2"}'). */
+    customMetadata?: string;
+    /** If specified, the document will also be added to the provided document collection. This operation is eventually consistent, meaning the document does not immediately start appearing in searches of that collection due to an asynchronous embedding process. To achieve strong consistency use the `awaitVectorStoreSync` parameter. */
+    collectionId?: string;
+    /** If set to "true", document contents will be re-uploaded and re-embedded even if the document already exists in Credal. */
+    forceUpdate?: string;
+    /** If set to "true", document will be accessible to everyone within the organization of the uploader. */
+    internalPublic?: string;
+    /** ISO 8601 date string indicating when the document was last updated in the source system (e.g., "2025-11-03T21:15:00Z"). */
+    sourceSystemUpdated?: string;
+    /** Document uploads are eventually consistent by default. If set to "true" the API will wait for the vector store to be updated before returning. This is useful if you want to ensure that the document is immediately searchable after this call returns. */
+    awaitVectorStoreSync?: string;
+}

package/dist/esm/api/resources/documentCatalog/client/requests/UploadFileRequest.mjs

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

package/dist/esm/api/resources/documentCatalog/client/requests/index.d.mts

@@ -1 +1,2 @@
 export type { UploadDocumentContentsRequest } from "./UploadDocumentContentsRequest.mjs";
+export type { UploadFileRequest } from "./UploadFileRequest.mjs";

package/dist/esm/core/exports.d.mts

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

package/dist/esm/core/exports.mjs

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

package/dist/esm/core/file/exports.d.mts

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

package/dist/esm/core/file/exports.mjs

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

package/dist/esm/core/file/file.d.mts

@@ -0,0 +1,10 @@
+import type { Uploadable } from "./types.mjs";
+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;
+}>;