Skip to content

Support target_asset_folder for generate archive #717

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 2, 2025
Merged

Support target_asset_folder for generate archive #717

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions lib/utils/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1284,6 +1284,8 @@ function api_download_url(action, params, options) {
* @param {string} [options.target_format="zip"]
* @param {string} [options.target_public_id] public ID of the generated raw resource.
* Relevant only for the create mode. If not specified, random public ID is generated.
* @param {string} [options.target_asset_folder] The folder where the generated file is placed within the Cloudinary repository.
* Not supported for product environments using the legacy fixed folder mode
* @param {boolean} [options.flatten_folders=false] If true, flatten public IDs with folders to be in the root
* of the archive. Add numeric counter to the file name in case of a name conflict.
* @param {boolean} [options.flatten_transformations=false] If true, and multiple transformations are given,
Expand Down Expand Up @@ -1506,6 +1508,7 @@ function archive_params(options = {}) {
tags: options.tags && toArray(options.tags),
target_format: options.target_format,
target_public_id: options.target_public_id,
target_asset_folder: options.target_asset_folder,
target_tags: options.target_tags && toArray(options.target_tags),
timestamp: options.timestamp || exports.timestamp(),
transformations: utils.build_eager(options.transformations),
Expand Down
6 changes: 4 additions & 2 deletions test/integration/api/uploader/archivespec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ const PUBLIC_ID2 = ARCHIVE_TAG + "_2";
const PUBLIC_ID_RAW = ARCHIVE_TAG + "_3";
const FULLY_QUALIFIED_IMAGE = "image/upload/sample";
const FULLY_QUALIFIED_VIDEO = "video/upload/dog";

const TARGET_ASSET_FOLDER = 'test-folder';

describe("archive", function () {
this.timeout(TIMEOUT.LONG);
Expand Down Expand Up @@ -155,12 +155,14 @@ describe("archive", function () {
tags: TEST_TAG,
public_ids: [PUBLIC_ID_RAW, "non-existing-resource"],
resource_type: "raw",
allow_missing: true
allow_missing: true,
target_asset_folder: TARGET_ASSET_FOLDER
});
sinon.assert.calledWith(writeSpy, sinon.match(helper.uploadParamMatcher("tags[]", TEST_TAG)));
sinon.assert.calledWith(writeSpy, sinon.match(helper.uploadParamMatcher("public_ids[]", PUBLIC_ID_RAW)));
sinon.assert.calledWith(writeSpy, sinon.match(helper.uploadParamMatcher("public_ids[]", "non-existing-resource")));
sinon.assert.calledWith(writeSpy, sinon.match(helper.uploadParamMatcher("allow_missing", 1)));
sinon.assert.calledWith(writeSpy, sinon.match(helper.uploadParamMatcher("target_asset_folder", TARGET_ASSET_FOLDER)));
sinon.assert.calledWith(writeSpy, sinon.match(helper.uploadParamMatcher("target_format", "zip")));
});
});
Expand Down
1 change: 1 addition & 0 deletions types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -428,6 +428,7 @@ declare module 'cloudinary' {
tags?: string | string[];
target_format?: TargetArchiveFormat;
target_public_id?: string;
target_asset_folder?: string;
target_tags?: string[];
timestamp?: number;
transformations?: TransformationOptions;
Expand Down