@credal/sdk 0.1.5 → 0.1.6

package/dist/cjs/Client.d.ts

@@ -15,7 +15,7 @@ export declare namespace CredalClient {
         baseUrl?: core.Supplier<string>;
         apiKey?: core.Supplier<core.BearerToken | undefined>;
         /** Additional headers to include in requests. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
@@ -28,7 +28,7 @@ export declare namespace CredalClient {
         /** Additional query string parameters to include in the request. */
         queryParams?: Record<string, unknown>;
         /** Additional headers to include in the request. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
 }
 export declare class CredalClient {

package/dist/cjs/Client.js

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

package/dist/cjs/api/resources/copilots/client/Client.d.ts

@@ -11,7 +11,7 @@ export declare namespace Copilots {
         baseUrl?: core.Supplier<string>;
         apiKey?: core.Supplier<core.BearerToken | undefined>;
         /** Additional headers to include in requests. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
@@ -24,7 +24,7 @@ export declare namespace Copilots {
         /** Additional query string parameters to include in the request. */
         queryParams?: Record<string, unknown>;
         /** Additional headers to include in the request. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
 }
 export declare class Copilots {

package/dist/cjs/api/resources/documentCatalog/client/Client.d.ts

@@ -11,7 +11,7 @@ export declare namespace DocumentCatalog {
         baseUrl?: core.Supplier<string>;
         apiKey?: core.Supplier<core.BearerToken | undefined>;
         /** Additional headers to include in requests. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
@@ -24,7 +24,7 @@ export declare namespace DocumentCatalog {
         /** Additional query string parameters to include in the request. */
         queryParams?: Record<string, unknown>;
         /** Additional headers to include in the request. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
 }
 export declare class DocumentCatalog {

package/dist/cjs/api/resources/documentCatalog/client/requests/UploadDocumentContentsRequest.d.ts

@@ -27,12 +27,12 @@ export interface UploadDocumentContentsRequest {
     documentExternalUrl?: string;
     /** Optional JSON representing any custom metadata for this document */
     customMetadata?: Record<string, Credal.CustomMetadataValue>;
-    /** If specified, the document will also be added to the provided document collection. The document does not immediately start appearing in searches of that collection due to an asynchronous embedding process. To await this process and have this endpoint return only when that embedding process is complete, use the `awaitVectorStoreSync` parameter. */
+    /** 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 specified, document contents will be re-uploaded and re-embedded even if the document already exists in Credal */
     forceUpdate?: boolean;
     /** If specified, document will be accessible to everyone within the organization of the uploader */
     internalPublic?: boolean;
-    /** If specified, 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. */
+    /** Document uploads are eventually consistent by default. If specified `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?: boolean;
 }

package/dist/cjs/api/resources/documentCollections/client/Client.d.ts

@@ -11,7 +11,7 @@ export declare namespace DocumentCollections {
         baseUrl?: core.Supplier<string>;
         apiKey?: core.Supplier<core.BearerToken | undefined>;
         /** Additional headers to include in requests. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
@@ -24,7 +24,7 @@ export declare namespace DocumentCollections {
         /** Additional query string parameters to include in the request. */
         queryParams?: Record<string, unknown>;
         /** Additional headers to include in the request. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
 }
 export declare class DocumentCollections {

package/dist/cjs/api/resources/search/client/Client.d.ts

@@ -11,7 +11,7 @@ export declare namespace Search {
         baseUrl?: core.Supplier<string>;
         apiKey?: core.Supplier<core.BearerToken | undefined>;
         /** Additional headers to include in requests. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
@@ -24,7 +24,7 @@ export declare namespace Search {
         /** Additional query string parameters to include in the request. */
         queryParams?: Record<string, unknown>;
         /** Additional headers to include in the request. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
 }
 export declare class Search {

package/dist/cjs/api/resources/users/client/Client.d.ts

@@ -11,7 +11,7 @@ export declare namespace Users {
         baseUrl?: core.Supplier<string>;
         apiKey?: core.Supplier<core.BearerToken | undefined>;
         /** Additional headers to include in requests. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
@@ -24,7 +24,7 @@ export declare namespace Users {
         /** Additional query string parameters to include in the request. */
         queryParams?: Record<string, unknown>;
         /** Additional headers to include in the request. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
 }
 export declare class Users {

package/dist/cjs/core/fetcher/Fetcher.d.ts

@@ -6,7 +6,7 @@ export declare namespace Fetcher {
         url: string;
         method: string;
         contentType?: string;
-        headers?: Record<string, string | Supplier<string | undefined> | undefined>;
+        headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
         queryParameters?: Record<string, unknown>;
         body?: unknown;
         timeoutMs?: number;

package/dist/cjs/core/fetcher/requestWithRetries.js

@@ -19,13 +19,45 @@ function addJitter(delay) {
     const jitterMultiplier = 1 + (Math.random() * 2 - 1) * JITTER_FACTOR;
     return delay * jitterMultiplier;
 }
+function getRetryDelayFromHeaders(response, retryAttempt) {
+    // Check for Retry-After header first (RFC 7231)
+    const retryAfter = response.headers.get("Retry-After");
+    if (retryAfter) {
+        // Parse as number of seconds...
+        const retryAfterSeconds = parseInt(retryAfter, 10);
+        if (!isNaN(retryAfterSeconds)) {
+            // Convert seconds to milliseconds and cap at MAX_RETRY_DELAY
+            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())) {
+            const delay = retryAfterDate.getTime() - Date.now();
+            return Math.min(Math.max(delay, 0), MAX_RETRY_DELAY);
+        }
+    }
+    // Then check for industry-standard X-RateLimit-Reset header
+    const rateLimitReset = response.headers.get("X-RateLimit-Reset");
+    if (rateLimitReset) {
+        const resetTime = parseInt(rateLimitReset, 10);
+        if (!isNaN(resetTime)) {
+            // Assume Unix timestamp in epoch seconds
+            const delay = resetTime * 1000 - Date.now();
+            if (delay > 0) {
+                return Math.min(delay, MAX_RETRY_DELAY);
+            }
+        }
+    }
+    // Fall back to exponential backoff
+    return Math.min(INITIAL_RETRY_DELAY * Math.pow(2, retryAttempt), MAX_RETRY_DELAY);
+}
 function requestWithRetries(requestFn_1) {
     return __awaiter(this, arguments, void 0, function* (requestFn, maxRetries = DEFAULT_MAX_RETRIES) {
         let response = yield requestFn();
         for (let i = 0; i < maxRetries; ++i) {
             if ([408, 429].includes(response.status) || response.status >= 500) {
-                // Calculate base delay using exponential backoff (in milliseconds)
-                const baseDelay = Math.min(INITIAL_RETRY_DELAY * Math.pow(2, i), MAX_RETRY_DELAY);
+                // Get delay from headers or fall back to exponential backoff
+                const baseDelay = getRetryDelayFromHeaders(response, i);
                 // Add jitter to the delay
                 const delayWithJitter = addJitter(baseDelay);
                 yield new Promise((resolve) => setTimeout(resolve, delayWithJitter));

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

@@ -1,3 +1,3 @@
 import * as core from "./index.js";
-export declare function mergeHeaders(...headersArray: (Record<string, string | core.Supplier<string | undefined> | undefined> | undefined)[]): Record<string, string | core.Supplier<string | undefined>>;
-export declare function mergeOnlyDefinedHeaders(...headersArray: (Record<string, string | core.Supplier<string | undefined> | undefined> | undefined)[]): Record<string, string | core.Supplier<string | undefined>>;
+export declare function mergeHeaders(...headersArray: (Record<string, string | core.Supplier<string | null | undefined> | null | undefined> | null | undefined)[]): Record<string, string | core.Supplier<string | null | undefined>>;
+export declare function mergeOnlyDefinedHeaders(...headersArray: (Record<string, string | core.Supplier<string | null | undefined> | null | undefined> | null | undefined)[]): Record<string, string | core.Supplier<string | null | undefined>>;

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.1.5";
+export declare const SDK_VERSION = "0.1.6";

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.5";
+exports.SDK_VERSION = "0.1.6";

package/dist/esm/Client.d.mts

@@ -15,7 +15,7 @@ export declare namespace CredalClient {
         baseUrl?: core.Supplier<string>;
         apiKey?: core.Supplier<core.BearerToken | undefined>;
         /** Additional headers to include in requests. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
@@ -28,7 +28,7 @@ export declare namespace CredalClient {
         /** Additional query string parameters to include in the request. */
         queryParams?: Record<string, unknown>;
         /** Additional headers to include in the request. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
 }
 export declare class CredalClient {

package/dist/esm/Client.mjs

@@ -13,8 +13,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.5",
-                "User-Agent": "@credal/sdk/0.1.5",
+                "X-Fern-SDK-Version": "0.1.6",
+                "User-Agent": "@credal/sdk/0.1.6",
                 "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/copilots/client/Client.d.mts

@@ -11,7 +11,7 @@ export declare namespace Copilots {
         baseUrl?: core.Supplier<string>;
         apiKey?: core.Supplier<core.BearerToken | undefined>;
         /** Additional headers to include in requests. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
@@ -24,7 +24,7 @@ export declare namespace Copilots {
         /** Additional query string parameters to include in the request. */
         queryParams?: Record<string, unknown>;
         /** Additional headers to include in the request. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
 }
 export declare class Copilots {

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

@@ -11,7 +11,7 @@ export declare namespace DocumentCatalog {
         baseUrl?: core.Supplier<string>;
         apiKey?: core.Supplier<core.BearerToken | undefined>;
         /** Additional headers to include in requests. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
@@ -24,7 +24,7 @@ export declare namespace DocumentCatalog {
         /** Additional query string parameters to include in the request. */
         queryParams?: Record<string, unknown>;
         /** Additional headers to include in the request. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
 }
 export declare class DocumentCatalog {

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

@@ -27,12 +27,12 @@ export interface UploadDocumentContentsRequest {
     documentExternalUrl?: string;
     /** Optional JSON representing any custom metadata for this document */
     customMetadata?: Record<string, Credal.CustomMetadataValue>;
-    /** If specified, the document will also be added to the provided document collection. The document does not immediately start appearing in searches of that collection due to an asynchronous embedding process. To await this process and have this endpoint return only when that embedding process is complete, use the `awaitVectorStoreSync` parameter. */
+    /** 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 specified, document contents will be re-uploaded and re-embedded even if the document already exists in Credal */
     forceUpdate?: boolean;
     /** If specified, document will be accessible to everyone within the organization of the uploader */
     internalPublic?: boolean;
-    /** If specified, 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. */
+    /** Document uploads are eventually consistent by default. If specified `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?: boolean;
 }

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

@@ -11,7 +11,7 @@ export declare namespace DocumentCollections {
         baseUrl?: core.Supplier<string>;
         apiKey?: core.Supplier<core.BearerToken | undefined>;
         /** Additional headers to include in requests. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
@@ -24,7 +24,7 @@ export declare namespace DocumentCollections {
         /** Additional query string parameters to include in the request. */
         queryParams?: Record<string, unknown>;
         /** Additional headers to include in the request. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
 }
 export declare class DocumentCollections {

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

@@ -11,7 +11,7 @@ export declare namespace Search {
         baseUrl?: core.Supplier<string>;
         apiKey?: core.Supplier<core.BearerToken | undefined>;
         /** Additional headers to include in requests. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
@@ -24,7 +24,7 @@ export declare namespace Search {
         /** Additional query string parameters to include in the request. */
         queryParams?: Record<string, unknown>;
         /** Additional headers to include in the request. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
 }
 export declare class Search {

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

@@ -11,7 +11,7 @@ export declare namespace Users {
         baseUrl?: core.Supplier<string>;
         apiKey?: core.Supplier<core.BearerToken | undefined>;
         /** Additional headers to include in requests. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
@@ -24,7 +24,7 @@ export declare namespace Users {
         /** Additional query string parameters to include in the request. */
         queryParams?: Record<string, unknown>;
         /** Additional headers to include in the request. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
 }
 export declare class Users {

package/dist/esm/core/fetcher/Fetcher.d.mts

@@ -6,7 +6,7 @@ export declare namespace Fetcher {
         url: string;
         method: string;
         contentType?: string;
-        headers?: Record<string, string | Supplier<string | undefined> | undefined>;
+        headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
         queryParameters?: Record<string, unknown>;
         body?: unknown;
         timeoutMs?: number;

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

@@ -16,13 +16,45 @@ function addJitter(delay) {
     const jitterMultiplier = 1 + (Math.random() * 2 - 1) * JITTER_FACTOR;
     return delay * jitterMultiplier;
 }
+function getRetryDelayFromHeaders(response, retryAttempt) {
+    // Check for Retry-After header first (RFC 7231)
+    const retryAfter = response.headers.get("Retry-After");
+    if (retryAfter) {
+        // Parse as number of seconds...
+        const retryAfterSeconds = parseInt(retryAfter, 10);
+        if (!isNaN(retryAfterSeconds)) {
+            // Convert seconds to milliseconds and cap at MAX_RETRY_DELAY
+            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())) {
+            const delay = retryAfterDate.getTime() - Date.now();
+            return Math.min(Math.max(delay, 0), MAX_RETRY_DELAY);
+        }
+    }
+    // Then check for industry-standard X-RateLimit-Reset header
+    const rateLimitReset = response.headers.get("X-RateLimit-Reset");
+    if (rateLimitReset) {
+        const resetTime = parseInt(rateLimitReset, 10);
+        if (!isNaN(resetTime)) {
+            // Assume Unix timestamp in epoch seconds
+            const delay = resetTime * 1000 - Date.now();
+            if (delay > 0) {
+                return Math.min(delay, MAX_RETRY_DELAY);
+            }
+        }
+    }
+    // Fall back to exponential backoff
+    return Math.min(INITIAL_RETRY_DELAY * Math.pow(2, retryAttempt), MAX_RETRY_DELAY);
+}
 export function requestWithRetries(requestFn_1) {
     return __awaiter(this, arguments, void 0, function* (requestFn, maxRetries = DEFAULT_MAX_RETRIES) {
         let response = yield requestFn();
         for (let i = 0; i < maxRetries; ++i) {
             if ([408, 429].includes(response.status) || response.status >= 500) {
-                // Calculate base delay using exponential backoff (in milliseconds)
-                const baseDelay = Math.min(INITIAL_RETRY_DELAY * Math.pow(2, i), MAX_RETRY_DELAY);
+                // Get delay from headers or fall back to exponential backoff
+                const baseDelay = getRetryDelayFromHeaders(response, i);
                 // Add jitter to the delay
                 const delayWithJitter = addJitter(baseDelay);
                 yield new Promise((resolve) => setTimeout(resolve, delayWithJitter));

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

@@ -1,3 +1,3 @@
 import * as core from "./index.mjs";
-export declare function mergeHeaders(...headersArray: (Record<string, string | core.Supplier<string | undefined> | undefined> | undefined)[]): Record<string, string | core.Supplier<string | undefined>>;
-export declare function mergeOnlyDefinedHeaders(...headersArray: (Record<string, string | core.Supplier<string | undefined> | undefined> | undefined)[]): Record<string, string | core.Supplier<string | undefined>>;
+export declare function mergeHeaders(...headersArray: (Record<string, string | core.Supplier<string | null | undefined> | null | undefined> | null | undefined)[]): Record<string, string | core.Supplier<string | null | undefined>>;
+export declare function mergeOnlyDefinedHeaders(...headersArray: (Record<string, string | core.Supplier<string | null | undefined> | null | undefined> | null | undefined)[]): Record<string, string | core.Supplier<string | null | undefined>>;

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.1.5";
+export declare const SDK_VERSION = "0.1.6";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "0.1.5";
+export const SDK_VERSION = "0.1.6";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@credal/sdk",
-    "version": "0.1.5",
+    "version": "0.1.6",
     "private": false,
     "repository": "github:credal-ai/credal-typescript-sdk",
     "type": "commonjs",