feat(metadata-view): Bulk download logic only #4237
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,7 +16,7 @@ import partition from 'lodash/partition'; | |
| import uniq from 'lodash/uniq'; | ||
| import uniqueId from 'lodash/uniqueId'; | ||
| import { getBadItemError, getBadPermissionsError, isUserCorrectableError } from '../utils/error'; | ||
| import { getTypedFileId } from '../utils/file'; | ||
| import { handleOnAbort, formatMetadataFieldValue } from './utils'; | ||
| import File from './File'; | ||
| import { | ||
|
|
@@ -90,16 +90,6 @@ class Metadata extends File { | |
| return `${this.getMetadataCacheKey(id)}_classification`; | ||
| } | ||
|
|
||
| /** | ||
| * API URL for metadata | ||
| * | ||
|
|
@@ -115,21 +105,6 @@ class Metadata extends File { | |
| return baseUrl; | ||
| } | ||
|
|
||
| /** | ||
| * API URL for metadata templates for a scope | ||
| * | ||
|
|
@@ -362,23 +337,9 @@ class Metadata extends File { | |
| * @param {string} templateKey - template key | ||
| * @return {Promise} Promise object of metadata template | ||
| */ | ||
| getSchemaByTemplateKey(templateKey: string): Promise<MetadataTemplateSchemaResponse> { | ||
| const url = this.getMetadataTemplateSchemaUrl(templateKey); | ||
| return this.xhr.get({ url }); | ||
| } | ||
|
|
||
| /** | ||
|
|
@@ -825,33 +786,27 @@ class Metadata extends File { | |
| } | ||
|
|
||
| /** | ||
| * API for patching metadata on file | ||
| * | ||
| * @param {BoxItem} file - File object for which we are changing the description | ||
| * @param {Object} template - Metadata template | ||
| * @param {Array} operations - Array of JSON patch operations | ||
| * @param {Function} successCallback - Success callback | ||
| * @param {Function} errorCallback - Error callback | ||
| * @return {Promise} | ||
| */ | ||
| async updateMetadata( | ||
| file: BoxItem, | ||
| template: MetadataTemplate, | ||
| operations: JSONPatchOperations, | ||
| successCallback: Function, | ||
| errorCallback: ElementsErrorCallback, | ||
| ): Promise<void> { | ||
| this.errorCode = ERROR_CODE_UPDATE_METADATA; | ||
| this.successCallback = successCallback; | ||
| this.errorCallback = errorCallback; | ||
|
|
||
| const { id, permissions } = file; | ||
| if (!id || !permissions) { | ||
| this.errorHandler(getBadItemError()); | ||
| return; | ||
|
|
@@ -866,14 +821,11 @@ class Metadata extends File { | |
|
|
||
| try { | ||
| const metadata = await this.xhr.put({ | ||
| url: this.getMetadataUrl(id, template.scope, template.templateKey), | ||
| headers: { | ||
| [HEADER_CONTENT_TYPE]: 'application/json-patch+json', | ||
| }, | ||
| id: getTypedFileId(id), | ||
| data: operations, | ||
| }); | ||
| if (!this.isDestroyed()) { | ||
|
|
@@ -888,63 +840,13 @@ class Metadata extends File { | |
| editor, | ||
| ); | ||
| } | ||
| this.successHandler(editor); | ||
| } | ||
| } catch (e) { | ||
| this.errorHandler(e); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * API for patching metadata on file | ||
| * | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| /** | ||
| * @file ZipDownload class for creating and downloading ZIP archives using Box TypeScript SDK | ||
| * @author Box | ||
| */ | ||
|
|
||
| import { BoxClient, BoxDeveloperTokenAuth } from 'box-typescript-sdk-gen'; | ||
| import { ZipDownloadRequest } from 'box-typescript-sdk-gen/lib/schemas/zipDownloadRequest.generated.d.ts.js'; | ||
|
|
||
coderabbitai[bot] marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| export interface ZipDownloadItem { | ||
| id: string; | ||
| type: 'file' | 'folder'; | ||
| } | ||
|
|
||
| export interface ZipDownloadOptions { | ||
| token: string; | ||
| downloadFileName?: string; | ||
| } | ||
coderabbitai[bot] marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| export interface ZipDownloadResponse { | ||
| downloadUrl?: string; | ||
| statusUrl?: string; | ||
| expiresAt?: string; | ||
| state?: 'in_progress' | 'failed' | 'succeeded'; | ||
| totalCount?: number; | ||
| downloadedCount?: number; | ||
| skippedCount?: number; | ||
| } | ||
|
|
||
| /** | ||
| * ZipDownload class for creating and downloading ZIP archives from Box items | ||
| * Uses the box-typescript-sdk-gen for modern TypeScript support | ||
| */ | ||
| export default class ZipDownloadAPI { | ||
| private client: BoxClient; | ||
|
|
||
| private options: ZipDownloadOptions; | ||
|
|
||
| /** | ||
| * Constructor | ||
| * @param options - Configuration options including auth token | ||
| */ | ||
| constructor(options: ZipDownloadOptions) { | ||
| this.options = options; | ||
|
|
||
| // Initialize Box client with developer token authentication | ||
| const auth = new BoxDeveloperTokenAuth({ token: options.token }); | ||
| this.client = new BoxClient({ | ||
| auth, | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Create a ZIP download request and initiate the download | ||
| * @param items - Array of file and folder items to include in ZIP | ||
| * @returns Promise resolving to the ZIP download response | ||
| */ | ||
| async createZipDownload(items: ZipDownloadItem[]): Promise<ZipDownloadResponse> { | ||
| if (!items || items.length === 0) { | ||
| throw new Error('Items array cannot be empty'); | ||
| } | ||
|
|
||
| // Create the ZIP download request | ||
| const zipRequest: ZipDownloadRequest = { | ||
| items, | ||
| downloadFileName: this.options.downloadFileName, | ||
| }; | ||
|
|
||
| try { | ||
| // Create the ZIP download using the Box SDK | ||
| const zipDownload = await this.client.zipDownloads.createZipDownload(zipRequest); | ||
|
|
||
| // Only download if we have a download URL | ||
| if (zipDownload.downloadUrl) { | ||
| this.downloadZipFile(zipDownload.downloadUrl); | ||
| } | ||
|
|
||
| return zipDownload as unknown as ZipDownloadResponse; | ||
| } catch (error: unknown) { | ||
| const errorMessage = error instanceof Error ? error.message : String(error); | ||
| throw new Error(`Failed to create ZIP download: ${errorMessage}`); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Download the ZIP file bytestream to the user's device using window.open | ||
| * @param url - The URL of the ZIP file to download | ||
| */ | ||
| private downloadZipFile(url: string): void { | ||
| try { | ||
| // Open in new tab - user can save from there | ||
| window.open(url, '_blank', 'noopener,noreferrer'); | ||
|
|
||
| window.focus(); | ||
|
|
||
| // Clean up after a delay to allow the download to start | ||
| setTimeout(() => { | ||
| URL.revokeObjectURL(url); | ||
| }, 1000); | ||
| } catch (error: unknown) { | ||
| const errorMessage = error instanceof Error ? error.message : String(error); | ||
| throw new Error(`Failed to download ZIP file: ${errorMessage}`); | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Move box-typescript-sdk-gen to peerDeps (and devDeps) to avoid bundling the whole SDK.
This is a library; shipping the SDK in dependencies risks duplicate installs and bigger bundles for consumers. Make it a peer, keep a devDep for local builds. Don’t weigh folks down, fool.
Apply this diff:
And add to peerDependencies:
"peerDependencies": { + "box-typescript-sdk-gen": ">=1.17.1",📝 Committable suggestion