chore(client): Remove REST Page API from client.page.get (dotCMS#32098)

This pull request focuses on transitioning the codebase to use the
updated `DotCMSPageResponse` type instead of the deprecated
`DotCMSEditablePage` and `DotCMSGraphQLPageResponse` types, while also
centralizing shared types into `@dotcms/types`. The changes span across
multiple files, including service implementations, tests, and client
APIs, with the goal of improving type consistency and maintainability.

### Transition to `DotCMSPageResponse` Type:

* Updated the `DotPageApiService` to replace `DotCMSGraphQLPageResponse`
with `DotCMSPageResponse` for type annotations and method calls.
(`dot-page-api.service.ts`,
[[1]](diffhunk://#diff-9acb0e7dc2619395c49047164381778d2b6d6c41f58b30aa3cd6a798044007c6L20-R20)
[[2]](diffhunk://#diff-9acb0e7dc2619395c49047164381778d2b6d6c41f58b30aa3cd6a798044007c6L202-R202)
* Refactored `DotCMSEditablePageService` to use `DotCMSPageResponse` for
internal subjects, observables, and mock data in both implementation and
tests. (`dotcms-editable-page.service.ts`,
[[1]](diffhunk://#diff-08ba5e2ca6377757a25ae71539af956c5b47f9f6b918a74bdca06a1e23b7438dL20-R28)
[[2]](diffhunk://#diff-08ba5e2ca6377757a25ae71539af956c5b47f9f6b918a74bdca06a1e23b7438dL63-R62);
`dotcms-editable-page.service.spec.ts`,
[[3]](diffhunk://#diff-9e99be6093c44be0c1ff531e7f2eee75185a56c63cd07e9ec60b8db26d98ccf4L26-R34)
[[4]](diffhunk://#diff-9e99be6093c44be0c1ff531e7f2eee75185a56c63cd07e9ec60b8db26d98ccf4L74-R70)
[[5]](diffhunk://#diff-9e99be6093c44be0c1ff531e7f2eee75185a56c63cd07e9ec60b8db26d98ccf4L87-R83)
[[6]](diffhunk://#diff-9e99be6093c44be0c1ff531e7f2eee75185a56c63cd07e9ec60b8db26d98ccf4L97-R93)

### Centralization of Shared Types:

* Removed redundant type definitions (e.g., `ContentTypeMainFields` and
`Contentlet`) from the SDK and replaced them with imports from
`@dotcms/types`. (`types.ts`,
[[1]](diffhunk://#diff-c8387d8c19477cb41407db77d2aa1068000323ec8c3ddc4390f2b1d791bff64bR1-R2)
[[2]](diffhunk://#diff-c8387d8c19477cb41407db77d2aa1068000323ec8c3ddc4390f2b1d791bff64bL27-L70)
* Consolidated `DotCMSClientConfig`, `RequestOptions`, and other shared
types into `@dotcms/types` and updated imports across client modules.
(`client.ts`,
[[1]](diffhunk://#diff-aa54238655bef05cdd48772e24046f2105dd74b1a20fac91e0b3ca610e3095a6R1-L38);
`content-api.ts`,
[[2]](diffhunk://#diff-7c81d474bc4a2de176c90dd7fc5a3b5584095ce7e19a8ae8e60e1f403f8344feL1-R3);
`navigation-api.ts`,
[[3]](diffhunk://#diff-ccca05575b5095ec6e63c7a7d3be4723cc9ed76a5ddf12197c6ad456b5785dc7L1-R1);
`page-api.spec.ts`,
[[4]](diffhunk://#diff-39f9fdbb6ffc97cc19b942165b9a66d212e4ab0d0e900b639687e28c393be0bcL2-L13)

### Cleanup and Simplification:

* Removed unused or redundant imports and mock implementations in test
files, such as `jest.mock` calls and mock data for deprecated types.
(`navigation-api.spec.ts`,
[[1]](diffhunk://#diff-6efa73174333c167644002586b5144107991d3c681a0bd0e982aefe0eeeca7a5L1-R3);
`page-api.spec.ts`,
[[2]](diffhunk://#diff-39f9fdbb6ffc97cc19b942165b9a66d212e4ab0d0e900b639687e28c393be0bcL28-L40)
[[3]](diffhunk://#diff-39f9fdbb6ffc97cc19b942165b9a66d212e4ab0d0e900b639687e28c393be0bcL58-L67)
* Simplified type annotations and method parameters in client APIs to
use centralized types like `DotCMSNavigationRequestParams`.
(`navigation-api.ts`,
[[1]](diffhunk://#diff-ccca05575b5095ec6e63c7a7d3be4723cc9ed76a5ddf12197c6ad456b5785dc7L37-R19)
[[2]](diffhunk://#diff-ccca05575b5095ec6e63c7a7d3be4723cc9ed76a5ddf12197c6ad456b5785dc7L59-R41)

These changes collectively enhance type safety, reduce redundancy, and
align the codebase with the latest `@dotcms/types` definitions.

Author: zJaaal

core-web/libs/portlets/edit-ema/portlet/src/lib/services/dot-page-api.service.ts

@@ -188,7 +188,7 @@ export class DotPageApiService {
         query: string;
         variables: Record<string, string>;
     }): Observable<{
-        page: DotPageApiResponse;
+        pageAsset: DotPageApiResponse;
         content: Record<string, unknown>;
     }> {
         const headers = {
@@ -202,7 +202,7 @@ export class DotPageApiService {
                 const pageEntity = graphqlToPageEntity({ page } as DotCMSGraphQLPageResponse);
 
                 return {
-                    page: pageEntity,
+                    pageAsset: pageEntity,
                     content
                 };
             })

core-web/libs/portlets/edit-ema/portlet/src/lib/store/features/client/withClient.ts

@@ -27,7 +27,7 @@ export interface ClientConfigState {
         variables: Record<string, string>;
     };
     graphqlResponse: {
-        page: DotPageApiResponse;
+        pageAsset: DotPageApiResponse;
         content?: Record<string, unknown>;
     };
 }
@@ -85,7 +85,7 @@ export function withClient() {
                     // Old customers using graphQL expect only the page.
                     // We can remove this once we are in stable and tell the devs this won't work in new dotCMS versions.
                     if (store.legacyGraphqlResponse()) {
-                        return store.graphqlResponse()?.page;
+                        return store.graphqlResponse()?.pageAsset;
                     }
 
                     return {

core-web/libs/portlets/edit-ema/portlet/src/lib/store/features/editor/save/withSave.ts

@@ -53,7 +53,7 @@ export function withSave() {
                                                   tap((response) =>
                                                       store.setGraphqlResponse(response)
                                                   ),
-                                                  map((response) => response.page)
+                                                  map((response) => response.pageAsset)
                                               );
 
                                     return pageRequest.pipe(

core-web/libs/portlets/edit-ema/portlet/src/lib/store/features/load/withLoad.spec.ts

@@ -246,7 +246,7 @@ describe('withLoad', () => {
             it('should call getGraphQLPage if graphql is present', () => {
                 jest.spyOn(dotPageApiService, 'getGraphQLPage').mockImplementation(() =>
                     of({
-                        page: MOCK_RESPONSE_HEADLESS,
+                        pageAsset: MOCK_RESPONSE_HEADLESS,
                         content: {}
                     })
                 );

core-web/libs/portlets/edit-ema/portlet/src/lib/store/features/load/withLoad.ts

@@ -202,7 +202,7 @@ export function withLoad() {
                                 ? dotPageApiService.get(store.pageParams())
                                 : dotPageApiService.getGraphQLPage(store.$graphqlWithParams()).pipe(
                                       tap((response) => store.setGraphqlResponse(response)),
-                                      map((response) => response.page)
+                                      map((response) => response.pageAsset)
                                   );
 
                             return pageRequest.pipe(

core-web/libs/sdk/angular/next/services/dotcms-editable-page.service.spec.ts

@@ -1,8 +1,8 @@
+import { expect } from '@jest/globals';
 import { createServiceFactory, SpectatorService } from '@ngneat/spectator/jest';
 
-import { updateNavigation } from '@dotcms/client';
-import { UVEEventType, DotCMSEditablePage } from '@dotcms/types';
-import { getUVEState, initUVE, createUVESubscription } from '@dotcms/uve';
+import { UVEEventType, DotCMSPageResponse } from '@dotcms/types';
+import { getUVEState, initUVE, createUVESubscription, updateNavigation } from '@dotcms/uve';
 
 import { DotCMSEditablePageService } from './dotcms-editable-page.service';
 
@@ -11,10 +11,7 @@ import { DotCMSEditablePageService } from './dotcms-editable-page.service';
 jest.mock('@dotcms/uve', () => ({
     getUVEState: jest.fn(),
     initUVE: jest.fn(),
-    createUVESubscription: jest.fn()
-}));
-
-jest.mock('@dotcms/client', () => ({
+    createUVESubscription: jest.fn(),
     updateNavigation: jest.fn()
 }));
 
@@ -23,19 +20,25 @@ describe('DotCMSEditablePageService', () => {
     let service: DotCMSEditablePageService;
     let unsubscribeMock: jest.Mock;
 
-    const mockPageAsset: DotCMSEditablePage = {
-        page: {
-            pageURI: '/test-page',
-            title: 'Test Page'
-        }
-    } as DotCMSEditablePage;
-
-    const mockUpdatedPageAsset: DotCMSEditablePage = {
-        page: {
-            pageURI: '/test-page',
-            title: 'Updated Test Page'
-        }
-    } as DotCMSEditablePage;
+    const mockPageAsset: DotCMSPageResponse = {
+        pageAsset: {
+            page: {
+                pageURI: '/test-page',
+                title: 'Test Page'
+            }
+        },
+        graphql: {}
+    } as DotCMSPageResponse;
+
+    const mockUpdatedPageAsset: DotCMSPageResponse = {
+        pageAsset: {
+            page: {
+                pageURI: '/test-page',
+                title: 'Updated Test Page'
+            }
+        },
+        graphql: {}
+    } as DotCMSPageResponse;
 
     const createService = createServiceFactory({
         service: DotCMSEditablePageService
@@ -71,7 +74,7 @@ describe('DotCMSEditablePageService', () => {
 
         it('should return observable with the initial page asset when UVE state is false', () => {
             (getUVEState as jest.Mock).mockReturnValue(false);
-            let result: DotCMSEditablePage | null = null;
+            let result: DotCMSPageResponse | null = null;
 
             service.listen(mockPageAsset).subscribe((res) => {
                 result = res;
@@ -84,7 +87,7 @@ describe('DotCMSEditablePageService', () => {
         });
 
         it('should emit updated page asset when UVE event occurs', () => {
-            let capturedCallback = (_payload: DotCMSEditablePage): void => {
+            let capturedCallback = (_payload: DotCMSPageResponse): void => {
                 // Empty default implementation
             };
 
@@ -94,7 +97,7 @@ describe('DotCMSEditablePageService', () => {
                 return { unsubscribe: unsubscribeMock };
             });
 
-            const emittedValues: Array<DotCMSEditablePage | null> = [];
+            const emittedValues: Array<DotCMSPageResponse | null> = [];
 
             service.listen(mockPageAsset).subscribe((value) => {
                 emittedValues.push(value);

core-web/libs/sdk/angular/next/services/dotcms-editable-page.service.ts

@@ -4,9 +4,8 @@ import { Injectable } from '@angular/core';
 
 import { finalize } from 'rxjs/operators';
 
-import { updateNavigation } from '@dotcms/client';
-import { UVEEventType, DotCMSEditablePage } from '@dotcms/types';
-import { createUVESubscription, getUVEState, initUVE } from '@dotcms/uve';
+import { UVEEventType, DotCMSPageResponse } from '@dotcms/types';
+import { createUVESubscription, getUVEState, initUVE, updateNavigation } from '@dotcms/uve';
 
 @Injectable({
     providedIn: 'root'
@@ -17,18 +16,18 @@ export class DotCMSEditablePageService {
      * Used internally to track changes to the page data.
      *
      * @private
-     * @type {Subject<DotCMSEditablePage | null>}
+     * @type {Subject<DotCMSPageResponse | null>}
      */
-    #pageAssetSubject = new Subject<DotCMSEditablePage | null>();
+    #responseSubject = new Subject<DotCMSPageResponse | null>();
 
     /**
      * Observable stream of the page asset changes.
      * Exposes the pageAssetSubject as an Observable for subscribers.
      *
      * @private
-     * @type {Observable<DotCMSEditablePage | null>}
+     * @type {Observable<DotCMSPageResponse | null>}
      */
-    #pageAsset$ = this.#pageAssetSubject.asObservable();
+    #response$ = this.#responseSubject.asObservable();
 
     /**
      * Listens for changes to an editable page and returns an Observable that emits the updated page data.
@@ -57,22 +56,22 @@ export class DotCMSEditablePageService {
      * subscription.unsubscribe();
      * ```
      *
-     * @param pageAsset Optional initial page data
+     * @param response Optional initial page data
      * @returns Observable that emits the updated page data or null
      */
-    listen(pageAsset?: DotCMSEditablePage): Observable<DotCMSEditablePage | null> {
+    listen(response?: DotCMSPageResponse): Observable<DotCMSPageResponse | null> {
         if (!getUVEState()) {
-            return of(pageAsset || null);
+            return of(response || null);
         }
 
-        const pageURI = pageAsset?.page?.pageURI ?? '/';
+        const pageURI = response?.pageAsset?.page?.pageURI ?? '/';
 
-        initUVE(pageAsset);
+        initUVE(response);
         updateNavigation(pageURI);
 
         const unsubscribeUVEChanges = this.#listenUVEChanges();
 
-        return this.#pageAsset$.pipe(
+        return this.#response$.pipe(
             finalize(() => {
                 unsubscribeUVEChanges();
             })
@@ -88,7 +87,7 @@ export class DotCMSEditablePageService {
      */
     #listenUVEChanges() {
         const { unsubscribe } = createUVESubscription(UVEEventType.CONTENT_CHANGES, (payload) => {
-            this.#pageAssetSubject.next(payload);
+            this.#responseSubject.next(payload);
         });
 
         return unsubscribe;

core-web/libs/sdk/client/README.md

@@ -127,11 +127,30 @@ const pageData = await client.page.get('/your-page-path', {
 });
 ```
 
+
+### Warning
+
+If you are updating from a version that is lower than `0.0.1-beta.29`, be aware that the response from the `client.page.get` method changed the access to the page value from `page` to `pageAsset`.
+This change was made to avoid redundancy on access inside of `page` object.
+
+#### Before
+
+```javascript
+const { page } = await client.page.get("/")
+```
+
+#### After
+
+```javascript
+const { pageAsset } = await client.page.get("/")
+```
+
+
 #### Example with all options
 
 ```javascript
 // Fetching a page with all available options
-const { page, content } = await client.page.get('/about-us', {
+const { pageAsset, content } = await client.page.get('/about-us', {
     languageId: '1',                 // Language ID (optional)
     siteId: 'demo.dotcms.com',       // Site ID (optional, defaults to the one provided during initialization)
     mode: 'PREVIEW_MODE',            // ADMIN_MODE, PREVIEW_MODE, or LIVE_MODE (optional)
@@ -172,7 +191,7 @@ const { page, content } = await client.page.get('/about-us', {
 });
 
 // Access page data
-console.log(page.containers);
+console.log(pageAsset.containers);
 
 // Access content data
 console.log(content.blogPosts);

core-web/libs/sdk/client/src/lib/client/client.spec.ts

@@ -1,4 +1,6 @@
-import { createDotCMSClient, DotCMSClientConfig, RequestOptions } from './client';
+import { DotCMSClientConfig, RequestOptions } from '@dotcms/types';
+
+import { createDotCMSClient } from './client';
 import { Content } from './content/content-api';
 import { NavigationClient } from './navigation/navigation-api';
 import { PageClient } from './page/page-api';

core-web/libs/sdk/client/src/lib/client/client.ts

@@ -1,41 +1,9 @@
+import { DotCMSClientConfig, RequestOptions } from '@dotcms/types';
+
 import { Content } from './content/content-api';
 import { NavigationClient } from './navigation/navigation-api';
 import { PageClient } from './page/page-api';
 
-/**
- * Options for configuring fetch requests, excluding body and method properties.
- */
-export type RequestOptions = Omit<RequestInit, 'body' | 'method'>;
-
-/**
- * Configuration options for the DotCMS client.
- */
-export interface DotCMSClientConfig {
-    /**
-     * The URL of the dotCMS instance.
-     * Ensure to include the protocol (http or https).
-     * @example `https://demo.dotcms.com`
-     */
-    dotcmsUrl: string;
-
-    /**
-     * The authentication token for requests.
-     * Obtainable from the dotCMS UI.
-     */
-    authToken: string;
-
-    /**
-     * The id of the site you want to interact with. Defaults to the default site if not provided.
-     */
-    siteId?: string;
-
-    /**
-     * Additional options for the fetch request.
-     * @example `{ headers: { 'Content-Type': 'application/json' } }`
-     */
-    requestOptions?: RequestOptions;
-}
-
 /**
  * Parses a string into a URL object.
  *