box-node-sdk 10.4.0 → 10.5.0

package/src/client.ts

@@ -90,6 +90,7 @@ import { BoxSdkError } from './box/errors';
 import { FetchOptions } from './networking/fetchOptions';
 import { FetchResponse } from './networking/fetchResponse';
 import { BaseUrls } from './networking/baseUrls';
+import { TimeoutConfig } from './networking/timeoutConfig';
 import { ProxyConfig } from './networking/proxyConfig';
 import { AgentOptions } from './internal/utils';
 import { Interceptor } from './networking/interceptors';
@@ -279,6 +280,7 @@ export class BoxClient {
       | 'withExtraHeaders'
       | 'withCustomBaseUrls'
       | 'withProxy'
+      | 'withTimeouts'
       | 'withCustomAgentOptions'
       | 'withInterceptors'
     > &
@@ -739,6 +741,17 @@ export class BoxClient {
       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: TimeoutConfig): BoxClient {
+    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

package/src/managers/archives.ts

@@ -405,6 +405,10 @@ export class ArchivesManager {
      * 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

package/src/networking/boxNetworkClient.ts

@@ -40,6 +40,55 @@ export const shouldIncludeBoxUaHeader = (options: FetchOptions) => {
   );
 };
 
+function createAbortSignalWithTimeout(
+  baseSignal: RequestInit['signal'],
+  timeoutMs: number,
+): {
+  signal: AbortSignal;
+  clearTimeout: () => void;
+  didTimeout: () => boolean;
+} {
+  const controller = new AbortController();
+  const upstream = baseSignal as unknown as AbortSignal | undefined;
+  let timedOut = false;
+
+  const abortFromUpstream = () => {
+    try {
+      (controller as any).abort((upstream as any)?.reason);
+    } catch {
+      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.
+  (timeoutId as any)?.unref?.();
+
+  return {
+    signal: controller.signal,
+    clearTimeout: () => {
+      clearTimeout(timeoutId);
+      if (upstream) upstream.removeEventListener('abort', abortFromUpstream);
+    },
+    didTimeout: () => timedOut,
+  };
+}
+
 type FetchOptionsExtended = FetchOptions & {
   attemptNumber?: number;
   numberOfRetriesOnException?: number;
@@ -193,19 +242,33 @@ export class BoxNetworkClient implements NetworkClient {
         : void 0,
     });
 
+    const timeoutConfig = fetchOptions.networkSession?.timeoutConfig;
+    const timeoutMs = timeoutConfig?.timeoutMs;
+
+    const requestTimeout =
+      timeoutMs != null && timeoutMs > 0
+        ? createAbortSignalWithTimeout(requestInit.signal, timeoutMs)
+        : undefined;
+    const requestInitWithTimeout: RequestInit = requestTimeout
+      ? {
+          ...requestInit,
+          signal: requestTimeout.signal as unknown as RequestInit['signal'],
+        }
+      : requestInit;
+
     try {
-      const response = await nodeFetch(
-        ''.concat(
-          fetchOptions.url,
-          Object.keys(params).length === 0 || fetchOptions.url.endsWith('?')
-            ? ''
-            : '?',
-          new URLSearchParams(params).toString(),
-        ),
-        { ...requestInit, redirect: isBrowser() ? 'follow' : 'manual' },
+      const requestUrl = ''.concat(
+        fetchOptions.url,
+        Object.keys(params).length === 0 || fetchOptions.url.endsWith('?')
+          ? ''
+          : '?',
+        new URLSearchParams(params).toString(),
       );
+      const response = await nodeFetch(requestUrl, {
+        ...requestInitWithTimeout,
+        redirect: isBrowser() ? 'follow' : 'manual',
+      });
 
-      const contentType = response.headers.get('content-type') ?? '';
       const ignoreResponseBody = fetchOptions.followRedirects === false;
 
       let data: SerializedData | undefined;
@@ -244,8 +307,14 @@ export class BoxNetworkClient implements NetworkClient {
     } catch (error) {
       isExceptionCase = true;
       numberOfRetriesOnException++;
-      caughtError = error instanceof Error ? error : new Error(String(error));
+      if (requestTimeout?.didTimeout()) {
+        caughtError = new Error(`Connection timeout after ${timeoutMs}ms`);
+      } else {
+        caughtError = error instanceof Error ? error : new Error(String(error));
+      }
       fetchResponse = fetchResponse ?? { status: 0, headers: {} };
+    } finally {
+      requestTimeout?.clearTimeout();
     }
     const attemptForRetry = isExceptionCase
       ? numberOfRetriesOnException
@@ -263,7 +332,7 @@ export class BoxNetworkClient implements NetworkClient {
         fetchResponse,
         attemptForRetry,
       );
-      await new Promise((resolve) => setTimeout(resolve, retryTimeout));
+      await new Promise((resolve) => setTimeout(resolve, retryTimeout * 1000));
       return this.fetch({
         ...options,
         attemptNumber: attemptNumber + 1,
@@ -325,7 +394,7 @@ export class BoxNetworkClient implements NetworkClient {
       : [];
     if (fetchResponse.status === 0) {
       throw new BoxSdkError({
-        message: `Unexpected Error occurred`,
+        message: caughtError?.message || `Unexpected Error occurred`,
         timestamp: `${Date.now()}`,
         error: caughtError,
       });

package/src/networking/network.ts

@@ -5,6 +5,7 @@ import { Agent } from '../internal/utils';
 import { AgentOptions } from '../internal/utils';
 import { createAgent } from '../internal/utils';
 import { ProxyConfig } from './proxyConfig';
+import { TimeoutConfig } from './timeoutConfig';
 import { BoxNetworkClient } from './boxNetworkClient';
 import { NetworkClient } from './networkClient';
 import { RetryStrategy } from './retries';
@@ -22,6 +23,7 @@ export class NetworkSession {
   readonly networkClient: NetworkClient = new BoxNetworkClient({});
   readonly retryStrategy: RetryStrategy = new BoxRetryStrategy({});
   readonly dataSanitizer: DataSanitizer = new DataSanitizer({});
+  readonly timeoutConfig?: TimeoutConfig;
   constructor(
     fields: Omit<
       NetworkSession,
@@ -40,6 +42,7 @@ export class NetworkSession {
       | 'withNetworkClient'
       | 'withRetryStrategy'
       | 'withDataSanitizer'
+      | 'withTimeoutConfig'
     > &
       Partial<
         Pick<
@@ -81,6 +84,9 @@ export class NetworkSession {
     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.
@@ -122,6 +128,7 @@ export class NetworkSession {
       networkClient: this.networkClient,
       retryStrategy: this.retryStrategy,
       dataSanitizer: this.dataSanitizer,
+      timeoutConfig: this.timeoutConfig,
     });
   }
   /**
@@ -140,6 +147,7 @@ export class NetworkSession {
       networkClient: this.networkClient,
       retryStrategy: this.retryStrategy,
       dataSanitizer: this.dataSanitizer,
+      timeoutConfig: this.timeoutConfig,
     });
   }
   /**
@@ -158,6 +166,7 @@ export class NetworkSession {
       networkClient: this.networkClient,
       retryStrategy: this.retryStrategy,
       dataSanitizer: this.dataSanitizer,
+      timeoutConfig: this.timeoutConfig,
     });
   }
   /**
@@ -176,6 +185,7 @@ export class NetworkSession {
       networkClient: this.networkClient,
       retryStrategy: this.retryStrategy,
       dataSanitizer: this.dataSanitizer,
+      timeoutConfig: this.timeoutConfig,
     });
   }
   /**
@@ -194,6 +204,7 @@ export class NetworkSession {
       networkClient: networkClient,
       retryStrategy: this.retryStrategy,
       dataSanitizer: this.dataSanitizer,
+      timeoutConfig: this.timeoutConfig,
     });
   }
   /**
@@ -212,6 +223,7 @@ export class NetworkSession {
       networkClient: this.networkClient,
       retryStrategy: retryStrategy,
       dataSanitizer: this.dataSanitizer,
+      timeoutConfig: this.timeoutConfig,
     });
   }
   /**
@@ -231,6 +243,26 @@ export class NetworkSession {
       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: TimeoutConfig): NetworkSession {
+    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,
     });
   }
 }
@@ -246,4 +278,5 @@ export interface NetworkSessionInput {
   readonly networkClient?: NetworkClient;
   readonly retryStrategy?: RetryStrategy;
   readonly dataSanitizer?: DataSanitizer;
+  readonly timeoutConfig?: TimeoutConfig;
 }

package/src/networking/timeoutConfig.ts

@@ -0,0 +1,3 @@
+export interface TimeoutConfig {
+  readonly timeoutMs?: number;
+}

package/src/networking/version.ts

@@ -1 +1 @@
-export const sdkVersion = '10.4.0';
+export const sdkVersion = '10.5.0';

package/src/schemas/index.ts

@@ -180,8 +180,8 @@ export * from './skillCard';
 export * from './skillCardsMetadata';
 export * from './uploadPartMini';
 export * from './uploadPart';
-export * from './uploadedPart';
 export * from './uploadParts';
+export * from './uploadedPart';
 export * from './uploadSession';
 export * from './uploadUrl';
 export * from './userBase';
@@ -251,6 +251,9 @@ export * from './aiSingleAgentResponseFull';
 export * from './aiMultipleAgentResponse';
 export * from './userAvatar';
 export * from './watermark';
+export * from './webhookMini';
+export * from './webhooks';
+export * from './webhook';
 export * from './webLinkBase';
 export * from './webLinkMini';
 export * from './webLink';
@@ -285,9 +288,6 @@ export * from './collaborations';
 export * from './appItemAssociatedItem';
 export * from './appItemAssociation';
 export * from './appItemAssociations';
-export * from './webhookMini';
-export * from './webhooks';
-export * from './webhook';
 export * from './workflowMini';
 export * from './workflow';
 export * from './workflows';

package/src/schemas/v2025R0/hubUpdateRequestV2025R0.ts

@@ -25,6 +25,9 @@ export interface HubUpdateRequestV2025R0 {
   /**
    * Indicates if a shared link can be created for the Box Hub. */
   readonly canSharedLinkBeCreated?: boolean;
+  /**
+   * Indicates if a public shared link can be created for the Box Hub. */
+  readonly canPublicSharedLinkBeCreated?: boolean;
   readonly rawData?: SerializedData;
 }
 export function serializeHubUpdateRequestV2025R0(
@@ -38,6 +41,7 @@ export function serializeHubUpdateRequestV2025R0(
       val.isCollaborationRestrictedToEnterprise,
     ['can_non_owners_invite']: val.canNonOwnersInvite,
     ['can_shared_link_be_created']: val.canSharedLinkBeCreated,
+    ['can_public_shared_link_be_created']: val.canPublicSharedLinkBeCreated,
   };
 }
 export function deserializeHubUpdateRequestV2025R0(
@@ -107,6 +111,19 @@ export function deserializeHubUpdateRequestV2025R0(
     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 "HubUpdateRequestV2025R0"',
+    });
+  }
+  const canPublicSharedLinkBeCreated: undefined | boolean =
+    val.can_public_shared_link_be_created == void 0
+      ? void 0
+      : val.can_public_shared_link_be_created;
   return {
     title: title,
     description: description,
@@ -115,5 +132,6 @@ export function deserializeHubUpdateRequestV2025R0(
       isCollaborationRestrictedToEnterprise,
     canNonOwnersInvite: canNonOwnersInvite,
     canSharedLinkBeCreated: canSharedLinkBeCreated,
+    canPublicSharedLinkBeCreated: canPublicSharedLinkBeCreated,
   } satisfies HubUpdateRequestV2025R0;
 }

package/src/schemas/v2025R0/hubV2025R0.ts

@@ -30,6 +30,7 @@ export class HubV2025R0 extends HubBaseV2025R0 {
   readonly isCollaborationRestrictedToEnterprise?: boolean;
   readonly canNonOwnersInvite?: boolean;
   readonly canSharedLinkBeCreated?: boolean;
+  readonly canPublicSharedLinkBeCreated?: boolean;
   constructor(fields: HubV2025R0) {
     super(fields);
     if (fields.title !== undefined) {
@@ -66,6 +67,9 @@ export class HubV2025R0 extends HubBaseV2025R0 {
     if (fields.canSharedLinkBeCreated !== undefined) {
       this.canSharedLinkBeCreated = fields.canSharedLinkBeCreated;
     }
+    if (fields.canPublicSharedLinkBeCreated !== undefined) {
+      this.canPublicSharedLinkBeCreated = fields.canPublicSharedLinkBeCreated;
+    }
   }
 }
 export function serializeHubV2025R0(val: HubV2025R0): SerializedData {
@@ -100,6 +104,7 @@ export function serializeHubV2025R0(val: HubV2025R0): SerializedData {
         val.isCollaborationRestrictedToEnterprise,
       ['can_non_owners_invite']: val.canNonOwnersInvite,
       ['can_shared_link_be_created']: val.canSharedLinkBeCreated,
+      ['can_public_shared_link_be_created']: val.canPublicSharedLinkBeCreated,
     },
   };
 }
@@ -193,6 +198,19 @@ export function deserializeHubV2025R0(val: SerializedData): HubV2025R0 {
     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: undefined | boolean =
+    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',
@@ -225,6 +243,7 @@ export function deserializeHubV2025R0(val: SerializedData): HubV2025R0 {
       isCollaborationRestrictedToEnterprise,
     canNonOwnersInvite: canNonOwnersInvite,
     canSharedLinkBeCreated: canSharedLinkBeCreated,
+    canPublicSharedLinkBeCreated: canPublicSharedLinkBeCreated,
     id: id,
     type: type,
   } satisfies HubV2025R0;

package/src/test/archives.test.ts

@@ -65,7 +65,6 @@ test('testArchivesCreateListDelete', async function testArchivesCreateListDelete
   if (!(archives.entries!.length > 0)) {
     throw new Error('Assertion failed');
   }
-  await client.archives.deleteArchiveByIdV2025R0(archive.id);
   await expect(async () => {
     await client.archives.deleteArchiveByIdV2025R0(archive.id);
   }).rejects.toThrow();

package/src/test/client.test.ts

@@ -37,6 +37,7 @@ import { FileFull } from '@/schemas/fileFull';
 import { ResponseFormat } from '@/networking/fetchOptions';
 import { UserFull } from '@/schemas/userFull';
 import { CreateUserRequestBody } from '@/managers/users';
+import { TimeoutConfig } from '@/networking/timeoutConfig';
 import { getUuid } from '@/internal/utils';
 import { generateByteStream } from '@/internal/utils';
 import { bufferEquals } from '@/internal/utils';
@@ -368,6 +369,22 @@ test('testWithCustomBaseUrls', async function testWithCustomBaseUrls(): Promise<
     await customBaseClient.users.getUserMe();
   }).rejects.toThrow();
 });
+test('testWithTimeoutWhenTimeoutOccurs', async function testWithTimeoutWhenTimeoutOccurs(): Promise<any> {
+  const timeoutMs: number = 1;
+  const clientWithTimeout: BoxClient = client.withTimeouts({
+    timeoutMs: timeoutMs,
+  } satisfies TimeoutConfig);
+  await expect(async () => {
+    await clientWithTimeout.users.getUserMe();
+  }).rejects.toThrow();
+});
+test('testWithTimeoutWhenTimeoutDoesNotOccur', async function testWithTimeoutWhenTimeoutDoesNotOccur(): Promise<any> {
+  const timeoutMs: number = 10000;
+  const clientWithTimeout: BoxClient = client.withTimeouts({
+    timeoutMs: timeoutMs,
+  } satisfies TimeoutConfig);
+  await clientWithTimeout.users.getUserMe();
+});
 test('testWithInterceptors', async function testWithInterceptors(): Promise<any> {
   const user: UserFull = await client.users.getUserMe();
   if (!(user.role == void 0)) {