box-node-sdk 10.4.0 → 10.5.0

package/lib/bundle.js

@@ -3622,7 +3622,7 @@
     var browserExports = browser.exports;
     var nodeFetch = /*@__PURE__*/getDefaultExportFromCjs(browserExports);
 
-    const sdkVersion = '10.4.0';
+    const sdkVersion = '10.5.0';
 
     class BoxRetryStrategy {
         constructor(fields) {
@@ -3707,6 +3707,46 @@
             (options.responseFormat === 'binary' ||
                 options.responseFormat === 'no_content'));
     };
+    function createAbortSignalWithTimeout(baseSignal, timeoutMs) {
+        var _a;
+        const controller = new AbortController();
+        const upstream = baseSignal;
+        let timedOut = false;
+        const abortFromUpstream = () => {
+            try {
+                controller.abort(upstream === null || upstream === void 0 ? void 0 : upstream.reason);
+            }
+            catch (_a) {
+                controller.abort();
+            }
+        };
+        if (upstream) {
+            if (upstream.aborted) {
+                abortFromUpstream();
+            }
+            else {
+                upstream.addEventListener('abort', abortFromUpstream, { once: true });
+            }
+        }
+        const timeoutId = setTimeout(() => {
+            timedOut = true;
+            controller.abort();
+        }, timeoutMs);
+        // Node.js timers keep the event loop alive. If the only pending work is this
+        // watchdog timeout, we don't want it to prevent process exit (e.g. short CLI
+        // runs, tests, scripts). `unref()` detaches the timer from the event loop.
+        // It’s a no-op in environments where `unref` isn’t available.
+        (_a = timeoutId === null || timeoutId === void 0 ? void 0 : timeoutId.unref) === null || _a === void 0 ? void 0 : _a.call(timeoutId);
+        return {
+            signal: controller.signal,
+            clearTimeout: () => {
+                clearTimeout(timeoutId);
+                if (upstream)
+                    upstream.removeEventListener('abort', abortFromUpstream);
+            },
+            didTimeout: () => timedOut,
+        };
+    }
     function createRequestInit(options) {
         return __awaiter$1(this, void 0, void 0, function* () {
             var _a, _b;
@@ -3809,11 +3849,18 @@
                         : void 0, multipartData: multipartBuffer
                         ? multipartBufferToStream(multipartBuffer)
                         : void 0 }));
+                const timeoutConfig = (_j = fetchOptions.networkSession) === null || _j === void 0 ? void 0 : _j.timeoutConfig;
+                const timeoutMs = timeoutConfig === null || timeoutConfig === void 0 ? void 0 : timeoutConfig.timeoutMs;
+                const requestTimeout = timeoutMs != null && timeoutMs > 0
+                    ? createAbortSignalWithTimeout(requestInit.signal, timeoutMs)
+                    : undefined;
+                const requestInitWithTimeout = requestTimeout
+                    ? Object.assign(Object.assign({}, requestInit), { signal: requestTimeout.signal }) : requestInit;
                 try {
-                    const response = yield nodeFetch(''.concat(fetchOptions.url, Object.keys(params).length === 0 || fetchOptions.url.endsWith('?')
+                    const requestUrl = ''.concat(fetchOptions.url, Object.keys(params).length === 0 || fetchOptions.url.endsWith('?')
                         ? ''
-                        : '?', new URLSearchParams(params).toString()), Object.assign(Object.assign({}, requestInit), { redirect: isBrowser() ? 'follow' : 'manual' }));
-                    const contentType = (_j = response.headers.get('content-type')) !== null && _j !== void 0 ? _j : '';
+                        : '?', new URLSearchParams(params).toString());
+                    const response = yield nodeFetch(requestUrl, Object.assign(Object.assign({}, requestInitWithTimeout), { redirect: isBrowser() ? 'follow' : 'manual' }));
                     const ignoreResponseBody = fetchOptions.followRedirects === false;
                     let data;
                     let content = generateByteStreamFromBuffer(new Uint8Array().buffer);
@@ -3845,16 +3892,24 @@
                 catch (error) {
                     isExceptionCase = true;
                     numberOfRetriesOnException++;
-                    caughtError = error instanceof Error ? error : new Error(String(error));
+                    if (requestTimeout === null || requestTimeout === void 0 ? void 0 : requestTimeout.didTimeout()) {
+                        caughtError = new Error(`Connection timeout after ${timeoutMs}ms`);
+                    }
+                    else {
+                        caughtError = error instanceof Error ? error : new Error(String(error));
+                    }
                     fetchResponse = fetchResponse !== null && fetchResponse !== void 0 ? fetchResponse : { status: 0, headers: {} };
                 }
+                finally {
+                    requestTimeout === null || requestTimeout === void 0 ? void 0 : requestTimeout.clearTimeout();
+                }
                 const attemptForRetry = isExceptionCase
                     ? numberOfRetriesOnException
                     : attemptNumber;
                 const shouldRetry = yield retryStrategy.shouldRetry(fetchOptions, fetchResponse, attemptForRetry);
                 if (shouldRetry) {
                     const retryTimeout = retryStrategy.retryAfter(fetchOptions, fetchResponse, attemptForRetry);
-                    yield new Promise((resolve) => setTimeout(resolve, retryTimeout));
+                    yield new Promise((resolve) => setTimeout(resolve, retryTimeout * 1000));
                     return this.fetch(Object.assign(Object.assign({}, options), { attemptNumber: attemptNumber + 1, numberOfRetriesOnException: numberOfRetriesOnException, fileStream: fileStreamBuffer
                             ? generateByteStreamFromBuffer(fileStreamBuffer)
                             : void 0, multipartData: multipartBuffer
@@ -3891,7 +3946,7 @@
                     : [];
                 if (fetchResponse.status === 0) {
                     throw new BoxSdkError({
-                        message: `Unexpected Error occurred`,
+                        message: (caughtError === null || caughtError === void 0 ? void 0 : caughtError.message) || `Unexpected Error occurred`,
                         timestamp: `${Date.now()}`,
                         error: caughtError,
                     });
@@ -3976,6 +4031,9 @@
             if (fields.dataSanitizer !== undefined) {
                 this.dataSanitizer = fields.dataSanitizer;
             }
+            if (fields.timeoutConfig !== undefined) {
+                this.timeoutConfig = fields.timeoutConfig;
+            }
         }
         /**
            * Generate a fresh network session by duplicating the existing configuration and network parameters, while also including additional headers to be attached to every API call.
@@ -4013,6 +4071,7 @@
                 networkClient: this.networkClient,
                 retryStrategy: this.retryStrategy,
                 dataSanitizer: this.dataSanitizer,
+                timeoutConfig: this.timeoutConfig,
             });
         }
         /**
@@ -4031,6 +4090,7 @@
                 networkClient: this.networkClient,
                 retryStrategy: this.retryStrategy,
                 dataSanitizer: this.dataSanitizer,
+                timeoutConfig: this.timeoutConfig,
             });
         }
         /**
@@ -4049,6 +4109,7 @@
                 networkClient: this.networkClient,
                 retryStrategy: this.retryStrategy,
                 dataSanitizer: this.dataSanitizer,
+                timeoutConfig: this.timeoutConfig,
             });
         }
         /**
@@ -4067,6 +4128,7 @@
                 networkClient: this.networkClient,
                 retryStrategy: this.retryStrategy,
                 dataSanitizer: this.dataSanitizer,
+                timeoutConfig: this.timeoutConfig,
             });
         }
         /**
@@ -4085,6 +4147,7 @@
                 networkClient: networkClient,
                 retryStrategy: this.retryStrategy,
                 dataSanitizer: this.dataSanitizer,
+                timeoutConfig: this.timeoutConfig,
             });
         }
         /**
@@ -4103,6 +4166,7 @@
                 networkClient: this.networkClient,
                 retryStrategy: retryStrategy,
                 dataSanitizer: this.dataSanitizer,
+                timeoutConfig: this.timeoutConfig,
             });
         }
         /**
@@ -4122,6 +4186,26 @@
                 networkClient: this.networkClient,
                 retryStrategy: this.retryStrategy,
                 dataSanitizer: dataSanitizer,
+                timeoutConfig: this.timeoutConfig,
+            });
+        }
+        /**
+         * Generate a fresh network session by duplicating the existing configuration and network parameters, while also applying timeout config
+         * @param {TimeoutConfig} timeoutConfig
+         * @returns {NetworkSession}
+         */
+        withTimeoutConfig(timeoutConfig) {
+            return new NetworkSession({
+                additionalHeaders: this.additionalHeaders,
+                baseUrls: this.baseUrls,
+                interceptors: this.interceptors,
+                agent: this.agent,
+                agentOptions: this.agentOptions,
+                proxyConfig: this.proxyConfig,
+                networkClient: this.networkClient,
+                retryStrategy: this.retryStrategy,
+                dataSanitizer: this.dataSanitizer,
+                timeoutConfig: timeoutConfig,
             });
         }
     }
@@ -48992,6 +49076,15 @@
         const canSharedLinkBeCreated = val.can_shared_link_be_created == void 0
             ? void 0
             : val.can_shared_link_be_created;
+        if (!(val.can_public_shared_link_be_created == void 0) &&
+            !sdIsBoolean(val.can_public_shared_link_be_created)) {
+            throw new BoxSdkError({
+                message: 'Expecting boolean for "can_public_shared_link_be_created" of type "HubV2025R0"',
+            });
+        }
+        const canPublicSharedLinkBeCreated = val.can_public_shared_link_be_created == void 0
+            ? void 0
+            : val.can_public_shared_link_be_created;
         if (val.id == void 0) {
             throw new BoxSdkError({
                 message: 'Expecting "id" of type "HubV2025R0" to be defined',
@@ -49021,6 +49114,7 @@
             isCollaborationRestrictedToEnterprise: isCollaborationRestrictedToEnterprise,
             canNonOwnersInvite: canNonOwnersInvite,
             canSharedLinkBeCreated: canSharedLinkBeCreated,
+            canPublicSharedLinkBeCreated: canPublicSharedLinkBeCreated,
             id: id,
             type: type,
         };
@@ -49073,6 +49167,7 @@
             ['is_collaboration_restricted_to_enterprise']: val.isCollaborationRestrictedToEnterprise,
             ['can_non_owners_invite']: val.canNonOwnersInvite,
             ['can_shared_link_be_created']: val.canSharedLinkBeCreated,
+            ['can_public_shared_link_be_created']: val.canPublicSharedLinkBeCreated,
         };
     }
 
@@ -51751,6 +51846,10 @@
            * Permanently deletes an archive.
            *
            * To learn more about the archive APIs, see the [Archive API Guide](https://developer.box.com/guides/archives).
+           *
+           * <Danger>
+           * This endpoint is currently unavailable. Please contact support for assistance.
+           * </Danger>
            * @param {string} archiveId The ID of the archive.
           Example: "982312"
            * @param {DeleteArchiveByIdV2025R0OptionalsInput} optionalsInput
@@ -52432,6 +52531,17 @@
                 networkSession: this.networkSession.withProxy(config),
             });
         }
+        /**
+         * Create a new client with custom timeouts that will be used for every API call
+         * @param {TimeoutConfig} config Timeout configuration.
+         * @returns {BoxClient}
+         */
+        withTimeouts(config) {
+            return new BoxClient({
+                auth: this.auth,
+                networkSession: this.networkSession.withTimeoutConfig(config),
+            });
+        }
         /**
          * Create a new client with a custom set of agent options that will be used for every API call
          * @param {AgentOptions} agentOptions Custom set of agent options that will be used for every API call