@credal/sdk 0.1.8 → 0.1.10

package/dist/esm/api/resources/search/client/requests/SearchDocumentCollectionRequest.d.mts

@@ -1,4 +1,4 @@
-import * as Credal from "../../../../index.mjs";
+import type * as Credal from "../../../../index.mjs";
 /**
  * @example
  *     {

package/dist/esm/api/resources/search/client/requests/SearchDocumentCollectionRequest.mjs

@@ -1,2 +1,2 @@
 // This file was auto-generated by Fern from our API Definition.
-import * as Credal from "../../../../index.mjs";
+export {};

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

@@ -1 +1 @@
-export { type SearchDocumentCollectionRequest } from "./SearchDocumentCollectionRequest.mjs";
+export type { SearchDocumentCollectionRequest } from "./SearchDocumentCollectionRequest.mjs";

package/dist/esm/api/resources/search/client/requests/index.mjs

@@ -1 +1 @@
-export {} from "./SearchDocumentCollectionRequest.mjs";
+export {};

package/dist/esm/api/resources/search/index.d.mts

@@ -1,2 +1,2 @@
-export * from "./types/index.mjs";
 export * from "./client/index.mjs";
+export * from "./types/index.mjs";

package/dist/esm/api/resources/search/index.mjs

@@ -1,2 +1,2 @@
-export * from "./types/index.mjs";
 export * from "./client/index.mjs";
+export * from "./types/index.mjs";

package/dist/esm/api/resources/search/types/DocumentCollectionSearchResult.d.mts

@@ -1,4 +1,4 @@
-import * as Credal from "../../../index.mjs";
+import type * as Credal from "../../../index.mjs";
 export interface DocumentCollectionSearchResult {
     documentId: string;
     documentName: string;

package/dist/esm/api/resources/search/types/DocumentCollectionSearchResult.mjs

@@ -1,2 +1,2 @@
 // This file was auto-generated by Fern from our API Definition.
-import * as Credal from "../../../index.mjs";
+export {};

package/dist/esm/api/resources/search/types/SearchDocumentCollectionResponse.d.mts

@@ -1,4 +1,4 @@
-import * as Credal from "../../../index.mjs";
+import type * as Credal from "../../../index.mjs";
 export interface SearchDocumentCollectionResponse {
     searchTermsUsed: string[];
     structuredFiltersApplied: Credal.SingleFieldFilter[];

package/dist/esm/api/resources/search/types/SearchDocumentCollectionResponse.mjs

@@ -1,2 +1,2 @@
 // This file was auto-generated by Fern from our API Definition.
-import * as Credal from "../../../index.mjs";
+export {};

package/dist/esm/api/resources/search/types/SingleFieldFilter.d.mts

@@ -1,4 +1,4 @@
-import * as Credal from "../../../index.mjs";
+import type * as Credal from "../../../index.mjs";
 export interface SingleFieldFilter {
     field: string;
     operator: Credal.Operator;

package/dist/esm/api/resources/search/types/SingleFieldFilter.mjs

@@ -1,2 +1,2 @@
 // This file was auto-generated by Fern from our API Definition.
-import * as Credal from "../../../index.mjs";
+export {};

package/dist/esm/api/resources/search/types/index.d.mts

@@ -1,5 +1,5 @@
 export * from "./DocumentCollectionSearchOptions.mjs";
-export * from "./SearchDocumentCollectionResponse.mjs";
 export * from "./DocumentCollectionSearchResult.mjs";
+export * from "./SearchDocumentCollectionResponse.mjs";
 export * from "./SearchResultChunk.mjs";
 export * from "./SingleFieldFilter.mjs";

package/dist/esm/api/resources/search/types/index.mjs

@@ -1,5 +1,5 @@
 export * from "./DocumentCollectionSearchOptions.mjs";
-export * from "./SearchDocumentCollectionResponse.mjs";
 export * from "./DocumentCollectionSearchResult.mjs";
+export * from "./SearchDocumentCollectionResponse.mjs";
 export * from "./SearchResultChunk.mjs";
 export * from "./SingleFieldFilter.mjs";

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

@@ -1,6 +1,6 @@
 import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
 import * as core from "../../../../core/index.mjs";
-import * as Credal from "../../../index.mjs";
+import type * as Credal from "../../../index.mjs";
 export declare namespace Users {
     interface Options extends BaseClientOptions {
     }

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

@@ -8,10 +8,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import * as environments from "../../../../environments.mjs";
-import * as core from "../../../../core/index.mjs";
-import * as Credal from "../../../index.mjs";
 import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../core/headers.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as environments from "../../../../environments.mjs";
 import * as errors from "../../../../errors/index.mjs";
 export class Users {
     constructor(_options = {}) {
@@ -44,7 +43,7 @@ export class Users {
     __metadata(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), 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/users/metadata"),
                 method: "PATCH",
@@ -87,7 +86,7 @@ export class Users {
     _getAuthorizationHeader() {
         return __awaiter(this, void 0, void 0, function* () {
             var _a;
-            const bearer = (_a = (yield core.Supplier.get(this._options.apiKey))) !== null && _a !== void 0 ? _a : process === null || process === void 0 ? void 0 : process.env["CREDAL_API_KEY"];
+            const bearer = (_a = (yield core.Supplier.get(this._options.apiKey))) !== null && _a !== void 0 ? _a : process === null || process === void 0 ? void 0 : process.env.CREDAL_API_KEY;
             if (bearer == null) {
                 throw new errors.CredalError({
                     message: "Please specify a bearer by either passing it in to the constructor or initializing a CREDAL_API_KEY environment variable",

package/dist/esm/api/resources/users/index.d.mts

@@ -1,2 +1,2 @@
-export * from "./types/index.mjs";
 export * from "./client/index.mjs";
+export * from "./types/index.mjs";

package/dist/esm/api/resources/users/index.mjs

@@ -1,2 +1,2 @@
-export * from "./types/index.mjs";
 export * from "./client/index.mjs";
+export * from "./types/index.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/fetcher/EndpointSupplier.d.mts

@@ -1,5 +1,5 @@
 import type { EndpointMetadata } from "./EndpointMetadata.mjs";
-import { Supplier } from "./Supplier.mjs";
+import type { Supplier } from "./Supplier.mjs";
 type EndpointSupplierFn<T> = (arg: {
     endpointMetadata: EndpointMetadata;
 }) => T | Promise<T>;

package/dist/esm/core/fetcher/EndpointSupplier.mjs

@@ -7,7 +7,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { Supplier } from "./Supplier.mjs";
 export const EndpointSupplier = {
     get: (supplier, arg) => __awaiter(void 0, void 0, void 0, function* () {
         if (typeof supplier === "function") {

package/dist/esm/core/fetcher/Fetcher.mjs

@@ -43,6 +43,7 @@ function getHeaders(args) {
 }
 export function fetcherImpl(args) {
     return __awaiter(this, void 0, void 0, function* () {
+        var _a;
         const url = createRequestUrl(args.url, args.queryParameters);
         const requestBody = yield getRequestBody({
             body: args.body,
@@ -74,7 +75,7 @@ export function fetcherImpl(args) {
             }
         }
         catch (error) {
-            if (args.abortSignal != null && args.abortSignal.aborted) {
+            if ((_a = args.abortSignal) === null || _a === void 0 ? void 0 : _a.aborted) {
                 return {
                     ok: false,
                     error: {

package/dist/esm/core/fetcher/getErrorResponseBody.mjs

@@ -25,9 +25,10 @@ export function getErrorResponseBody(response) {
             case "application/ld+json":
             case "application/problem+json":
             case "application/vnd.api+json":
-            case "text/json":
+            case "text/json": {
                 const text = yield response.text();
                 return text.length > 0 ? fromJson(text) : undefined;
+            }
             default:
                 if (contentType.startsWith("application/vnd.") && contentType.endsWith("+json")) {
                     const text = yield response.text();

package/dist/esm/core/fetcher/getResponseBody.mjs

@@ -7,9 +7,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+import { fromJson } from "../json.mjs";
 import { getBinaryResponse } from "./BinaryResponse.mjs";
 import { isResponseWithBody } from "./ResponseWithBody.mjs";
-import { fromJson } from "../json.mjs";
 export function getResponseBody(response, responseType) {
     return __awaiter(this, void 0, void 0, function* () {
         if (!isResponseWithBody(response)) {
@@ -33,10 +33,10 @@ export function getResponseBody(response, responseType) {
         const text = yield response.text();
         if (text.length > 0) {
             try {
-                let responseBody = fromJson(text);
+                const responseBody = fromJson(text);
                 return responseBody;
             }
-            catch (err) {
+            catch (_err) {
                 return {
                     ok: false,
                     error: {

package/dist/esm/core/fetcher/makeRequest.mjs

@@ -11,7 +11,7 @@ import { anySignal, getTimeoutSignal } from "./signals.mjs";
 export const makeRequest = (fetchFn, url, method, headers, requestBody, timeoutMs, abortSignal, withCredentials, duplex) => __awaiter(void 0, void 0, void 0, function* () {
     const signals = [];
     // Add timeout signal
-    let timeoutAbortId = undefined;
+    let timeoutAbortId;
     if (timeoutMs != null) {
         const { signal, abortId } = getTimeoutSignal(timeoutMs);
         timeoutAbortId = abortId;
@@ -21,7 +21,7 @@ export const makeRequest = (fetchFn, url, method, headers, requestBody, timeoutM
     if (abortSignal != null) {
         signals.push(abortSignal);
     }
-    let newSignals = anySignal(signals);
+    const newSignals = anySignal(signals);
     const response = yield fetchFn(url, {
         method: method,
         headers,

package/dist/esm/core/fetcher/requestWithRetries.mjs

@@ -27,12 +27,12 @@ function getRetryDelayFromHeaders(response, retryAttempt) {
     if (retryAfter) {
         // Parse as number of seconds...
         const retryAfterSeconds = parseInt(retryAfter, 10);
-        if (!isNaN(retryAfterSeconds) && retryAfterSeconds > 0) {
+        if (!Number.isNaN(retryAfterSeconds) && retryAfterSeconds > 0) {
             return Math.min(retryAfterSeconds * 1000, MAX_RETRY_DELAY);
         }
         // ...or as an HTTP date; both are valid
         const retryAfterDate = new Date(retryAfter);
-        if (!isNaN(retryAfterDate.getTime())) {
+        if (!Number.isNaN(retryAfterDate.getTime())) {
             const delay = retryAfterDate.getTime() - Date.now();
             if (delay > 0) {
                 return Math.min(Math.max(delay, 0), MAX_RETRY_DELAY);
@@ -43,7 +43,7 @@ function getRetryDelayFromHeaders(response, retryAttempt) {
     const rateLimitReset = response.headers.get("X-RateLimit-Reset");
     if (rateLimitReset) {
         const resetTime = parseInt(rateLimitReset, 10);
-        if (!isNaN(resetTime)) {
+        if (!Number.isNaN(resetTime)) {
             // Assume Unix timestamp in epoch seconds
             const delay = resetTime * 1000 - Date.now();
             if (delay > 0) {

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;
+}>;

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

@@ -0,0 +1,184 @@
+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());
+    });
+};
+export 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;
+    });
+}
+export 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 import("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 import("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/esm/core/file/index.d.mts

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

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

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

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

@@ -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

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

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

@@ -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 {};