34029 browser component #34126

nicobytes · 2025-12-17T15:00:35Z

Proposed Changes

This pull request introduces a new DotBrowsingService for browsing sites and folders, refactors several data access services to use consistent API response handling, and adds utility methods for working with file contentlets. The changes improve code consistency, reusability, and support for richer file and folder operations.

New browsing functionality

Added dot-browsing.service.ts, providing methods to retrieve sites and folders as tree nodes, build hierarchical tree structures from paths, and fetch content by folder. This service enables more advanced browsing and selection of site/folder data.
Exported DotBrowsingService in the data access library index for public use.
Added dot-browser-selector.model to the models index for tree node selection event typing. [1] [2]

Refactoring and API consistency

Refactored DotContentletService methods to use strongly typed DotCMSAPIResponse objects, improving type safety and consistency. Added support for retrieving contentlet content if editable as a text file, and integrated with the new upload file service methods. [1] [2] [3] [4] [5] [6] [7]
Refactored DotTagsService to use direct HTTP requests, removed dependency on CoreWebService, and added a new method to fetch tags using the v2 API. [1] [2]

File upload and content extraction enhancements

Updated DotUploadFileService to add methods for uploading assets and automatically extracting text content if the file is editable, streamlining file handling workflows. [1] [2] [3] [4]

Checklist

Tests
Translations
Security Implications Contemplated (add notes if applicable)

…dit mode support - Updated the title custom field template to support a new edit mode using the `DotCustomFieldApi`. - Implemented event listeners for the title box to automatically update the URL and friendly name fields based on the title input. - Improved code structure by separating logic for new edit mode and legacy Dojo implementation. - Ensured backward compatibility by maintaining the original script for non-edit mode scenarios. This change enhances user experience by providing real-time updates and a more modern approach to handling custom fields.

…integration

…template integration

…nd template updates

…:dotCMS/core into 34029-task-migrate-pages-vtls-to-new-api

…logic

… from native field component

…roved dialog functionality and styling

…ment, enhance data access with new utility methods

…vice for improved data access

…e and DotTruncatePathPipe to improve modularity

alwaysmeticulous · 2025-12-17T15:00:40Z

Meticulous was unable to execute a test run for this PR because the most recent commit is associated with multiple PRs. To execute a test run, please try pushing up a new commit that is only associated with this PR.

_{Last updated for commit 13bb7af. This comment will update as new commits are pushed.}

mergify · 2025-12-17T15:01:11Z

⚠️ The sha of the head commit of this PR conflicts with #34125. Mergify cannot evaluate rules on this PR. ⚠️

…d components for enhanced dialog management

…rity and maintainability. Updated mock responses and added tests for contentlet retrieval, locking, and language suggestions. Enhanced test structure with meaningful variable names and consistent use of async patterns.

… improved clarity and maintainability. Updated mock responses and added tests for various upload scenarios, including handling of abort signals and contentlet uploads. Enhanced test structure with meaningful variable names and consistent use of async patterns.

…arity and maintainability. Implemented tests for site and folder retrieval, error handling, and tree structure transformation. Enhanced test structure with meaningful variable names and consistent use of async patterns.

Copilot

Pull request overview

This pull request introduces a new DotBrowsingService for centralized site and folder browsing functionality, refactors multiple data access services to use consistent API response handling with strongly-typed DotCMSAPIResponse objects, and extends the custom field bridge API to support browser modal selection. The changes improve code reusability, type safety, and enable richer file and folder operations across the application.

Centralized browsing logic by extracting site/folder operations from DotEditContentService into a dedicated DotBrowsingService
Enhanced type safety by refactoring services to use DotCMSAPIResponse<T> instead of untyped responses
Extended custom field capabilities with a new openBrowserModal API for content selection within custom fields

Reviewed changes

Copilot reviewed 60 out of 65 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
`core-web/libs/data-access/src/lib/dot-browsing/dot-browsing.service.ts`	New service providing centralized methods for browsing sites, folders, and content with tree node transformations
`core-web/libs/data-access/src/lib/dot-contentlet/dot-contentlet.service.ts`	Refactored to use strongly-typed API responses and added method to retrieve contentlets with text content extraction
`core-web/libs/data-access/src/lib/dot-tags/dot-tags.service.ts`	Removed `CoreWebService` dependency, migrated to direct HTTP calls, added v2 API method
`core-web/libs/data-access/src/lib/dot-upload-file/dot-upload-file.service.ts`	Added methods for uploading assets with automatic content extraction for editable text files
`core-web/libs/ui/src/lib/components/dot-browser-selector/*`	Renamed components and store from "select-existing-file" to "browser-selector" for better semantic clarity
`core-web/libs/ui/src/lib/pipes/dot-truncate-path/*`	Renamed pipe from `TruncatePathPipe` to `DotTruncatePathPipe` for consistency with naming conventions
`core-web/libs/edit-content-bridge/src/lib/bridges/angular-form-bridge.ts`	Added `openBrowserModal` method to enable content selection dialogs from custom fields
`core-web/libs/edit-content-bridge/src/lib/interfaces/*`	New interfaces for browser selector functionality including options, results, and controller
`core-web/libs/edit-content/src/lib/services/dot-edit-content.service.ts`	Delegated browsing operations to `DotBrowsingService`, reducing service complexity
`dotCMS/src/main/webapp/WEB-INF/velocity/static/htmlpage_assets/redirect_custom_field*.vtl`	Split redirect custom field template to support both legacy and new edit modes

Comments suppressed due to low confidence (1)

core-web/libs/ui/src/lib/components/dot-browser-selector/store/browser.store.ts:37

The interface name has a typo. "BrowserSelectorState" is the correct spelling instead of "SelectExisingFileState".

core-web/libs/data-access/src/lib/dot-browsing/dot-browsing.service.ts

… and error handling. Added lint target in project.json, refined ignore patterns in .eslintrc.json, and adjusted TypeScript configurations for better type safety. Enhanced unit tests in DotBrowsingService for error handling and folder retrieval, ensuring consistent use of async patterns and meaningful variable names.

…settings and focus on testing and build targets.

Copilot

Pull request overview

Copilot reviewed 72 out of 77 changed files in this pull request and generated no new comments.

…lderParams for improved type safety and clarity. Updated getContentByFolder method signatures and adjusted related components to streamline content retrieval parameters. Enhanced DotBrowserSelectorComponent to manage folder parameters using Angular's signals for better state management.

…to utilize ContentByFolderParams for improved clarity and type safety. Updated test cases to pass parameters directly, ensuring consistent use of the new structure. Enhanced AngularFormBridge to accept params for better content filtering and retrieval. Streamlined test assertions for better maintainability..

…s for the DotCustomFieldApi modal. Updated the onClose callback to handle the new URL structure, improving the functionality of the page selection feature.

Copilot

Pull request overview

Copilot reviewed 77 out of 81 changed files in this pull request and generated 3 comments.

...c/lib/fields/dot-edit-content-custom-field/components/native-field/native-field.component.ts

...c/lib/fields/dot-edit-content-custom-field/components/iframe-field/iframe-field.component.ts

core-web/libs/data-access/src/lib/dot-browsing/dot-browsing.service.ts

…eldComponent, and NativeFieldComponent. Updated return type description and field accessibility notes for clarity and consistency.

core-web/libs/edit-content/src/lib/utils/functions.util.spec.ts

fmontes · 2025-12-24T21:18:28Z

core-web/libs/data-access/src/lib/dot-browsing/dot-browsing.service.ts

+                return sites.map((site) => ({
+                    key: site.identifier,
+                    label: site.hostname,
+                    data: {
+                        id: site.identifier,
+                        hostname: site.hostname,
+                        path: '',
+                        type: 'site'
+                    },
+                    expandedIcon: 'pi pi-folder-open',
+                    collapsedIcon: 'pi pi-folder',
+                    leaf: false
+                }));


Why are we adding "UI" to a service inside data-access?

This map needs to happen at the component level.

Or this services needs to go with the component... data-access lib is just our endpoints services.

fmontes · 2025-12-24T21:19:27Z

core-web/libs/data-access/src/lib/dot-browsing/dot-browsing.service.ts

+                return sites.map((site) => ({
+                    key: site.identifier,
+                    label: site.hostname,
+                    data: {
+                        id: site.identifier,
+                        hostname: site.hostname,
+                        path: '',
+                        type: 'site'
+                    },
+                    expandedIcon: 'pi pi-folder-open',
+                    collapsedIcon: 'pi pi-folder',
+                    leaf: false
+                }));


Or this services needs to go with the component... data-access lib is just our endpoints services.

fmontes · 2025-12-24T21:21:56Z

core-web/libs/data-access/src/lib/dot-contentlet/dot-contentlet.service.ts

Same as before, this data-access service looks like it doesn't belong here... seems very use case specific beyond "wraps" the endpoints.

nicobytes added 14 commits December 15, 2025 19:19

feat(cachettl): Introduce new cache TTL custom field with modern API …

dd4ac22

…integration

feat(native-field): Add custom field component with SCSS styling and …

063de05

…template integration

Merge branch 'main' into 34029-task-migrate-pages-vtls-to-new-api

9520d7c

feat(dot-edit-content): Enhance native field component with styling a…

bacfdf3

…nd template updates

Merge branch '34029-task-migrate-pages-vtls-to-new-api' of github.com…

c04b1b0

…:dotCMS/core into 34029-task-migrate-pages-vtls-to-new-api

Merge branch 'main' into 34029-task-migrate-pages-vtls-to-new-api

73cbc2c

Merge branch '34029-task-migrate-pages-vtls-to-new-api' of github.com…

8dc9e3c

…:dotCMS/core into 34029-task-migrate-pages-vtls-to-new-api

refactor(template): Clean up CSS comments and improve URL generation …

33398e9

…logic

refactor(dot-edit-content): Remove unnecessary header and console log…

203e088

… from native field component

feat(og-preview): Introduce new Open Graph preview component with imp…

f3fb68e

…roved dialog functionality and styling

feat(dot-browsing): Add DotBrowsingService for site and folder manage…

c10a9ff

…ment, enhance data access with new utility methods

refactor(dot-edit-content): Update imports and utilize DotBrowsingSer…

120a54d

…vice for improved data access

refactor(dot-browser-selector): Update import paths for DotMessagePip…

13bb7af

…e and DotTruncatePathPipe to improve modularity

github-actions bot mentioned this pull request Dec 17, 2025

[TASK] Migrate "Pages" VTLs to new API #34029

Open

10 tasks

nicobytes added 7 commits December 18, 2025 05:11

Merge branch 'main' into 34029-browser-component

c1c68c6

feat(dialog): Integrate DialogService into IframeField and NativeFiel…

e2b077a

…d components for enhanced dialog management

feat(dialog): Integrate DialogService into IframeField and NativeFiel…

f1ac101

…d components for enhanced dialog management

Merge branch 'main' into 34029-browser-component

152e505

Merge branch 'main' into 34029-browser-component

e28ed90

nicobytes marked this pull request as ready for review December 22, 2025 22:48

nicobytes requested a review from Copilot December 22, 2025 22:49

Copilot started reviewing on behalf of nicobytes December 22, 2025 22:49 View session

nicobytes requested review from fmontes and hmoreras December 22, 2025 22:56

Copilot AI reviewed Dec 22, 2025

View reviewed changes

nicobytes added 2 commits December 22, 2025 19:01

Remove linting configuration from project.json to streamline project …

149ede2

…settings and focus on testing and build targets.

nicobytes requested a review from Copilot December 23, 2025 01:46

Copilot started reviewing on behalf of nicobytes December 23, 2025 01:46 View session

Copilot AI reviewed Dec 23, 2025

View reviewed changes

nicobytes requested a review from adrianjm-dotCMS December 23, 2025 15:01

nicobytes requested a review from Copilot December 23, 2025 15:06

Copilot started reviewing on behalf of nicobytes December 23, 2025 15:07 View session

adrianjm-dotCMS approved these changes Dec 23, 2025

View reviewed changes

Enhance redirect_custom_field_new.vtl to include additional parameter…

0a74af3

…s for the DotCustomFieldApi modal. Updated the onClose callback to handle the new URL structure, improving the functionality of the page selection feature.

Copilot AI reviewed Dec 23, 2025

View reviewed changes

fix(docs): in documentation comments for DotBrowsingService, IframeFi…

c1a0a5b

…eldComponent, and NativeFieldComponent. Updated return type description and field accessibility notes for clarity and consistency.

dario-daza reviewed Dec 24, 2025

View reviewed changes

core-web/libs/edit-content/src/lib/utils/functions.util.spec.ts Show resolved Hide resolved

dario-daza approved these changes Dec 24, 2025

View reviewed changes

Merge branch 'main' into 34029-browser-component

1e9bd64

fmontes requested changes Dec 24, 2025

View reviewed changes

34029 browser component #34126

Are you sure you want to change the base?

34029 browser component #34126

Conversation

nicobytes commented Dec 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed Changes

New browsing functionality

Refactoring and API consistency

File upload and content extraction enhancements

Checklist

Uh oh!

alwaysmeticulous bot commented Dec 17, 2025

Uh oh!

mergify bot commented Dec 17, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fmontes Dec 24, 2025

Choose a reason for hiding this comment

Uh oh!

fmontes Dec 24, 2025

Choose a reason for hiding this comment

Uh oh!

fmontes Dec 24, 2025

Choose a reason for hiding this comment

Uh oh!

fmontes Dec 24, 2025

Choose a reason for hiding this comment

Uh oh!

fmontes Dec 24, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

nicobytes commented Dec 17, 2025 •

edited

Loading