@dotcms/client 1.5.5-next.2260 → 1.5.5-next.2266

package/index.cjs.js

@@ -2310,6 +2310,19 @@ function mapContentResponse(responseData, keys) {
         return accumulator;
     }, {});
 }
+/**
+ * Returns a shallow copy of the object with every key whose value is `undefined` removed.
+ *
+ * `undefined` is not valid JSON, so keeping such keys breaks consumers that serialize the value
+ * (e.g. Next.js Pages Router `getServerSideProps`/`getStaticProps`). `null` and other falsy values
+ * are preserved since they serialize fine.
+ *
+ * @param {Record<string, unknown>} object - Source object to clean
+ * @returns {Record<string, unknown>} New object without `undefined` values
+ */
+function removeUndefinedValues(object) {
+    return Object.fromEntries(Object.entries(object).filter(([, value]) => value !== undefined));
+}
 /**
  * Executes a GraphQL query against the DotCMS API.
  *
@@ -2429,12 +2442,10 @@ class PageClient extends BaseApiClient {
             additionalQueries: contentQuery,
             verbose
         });
-        const normalizedUrl = url.startsWith('/') ? url : `/${url}`;
-        const requestVariables = {
-            // The url is expected to have a leading slash to comply on VanityURL Matching, some frameworks like Angular will not add the leading slash
-            url: normalizedUrl,
-            // Translate the UVE_MODE key ('EDIT' | 'PREVIEW' | ...) to the value the backend PageMode enum expects ('EDIT_MODE' | 'PREVIEW_MODE' | ...)
-            mode: types.UVE_MODE[mode],
+        const newURL = url.startsWith('/') ? url : `/${url}`;
+        const requestVariables = removeUndefinedValues({
+            url: newURL,
+            mode: types.UVE_MODE[mode], // Translate the UVE_MODE key ('EDIT' | 'PREVIEW' | ...) to the value the backend PageMode enum expects ('EDIT_MODE' | 'PREVIEW_MODE' | ...)
             languageId,
             personaId,
             fireRules,
@@ -2442,7 +2453,7 @@ class PageClient extends BaseApiClient {
             siteId,
             variantName,
             ...variables
-        };
+        });
         const requestHeaders = this.requestOptions.headers;
         const requestBody = JSON.stringify({ query: completeQuery, variables: requestVariables });
         try {
@@ -2458,12 +2469,12 @@ class PageClient extends BaseApiClient {
                     .filter((error) => !error.extensions?.code)
                     .forEach((error) => {
                     if (verbose) {
-                        logVerboseError(normalizedUrl, error.message, {
+                        logVerboseError(newURL, error.message, {
                             variables: requestVariables
                         });
                     }
                     else {
-                        consola.consola.error(`[DotCMS GraphQL Error] ${normalizedUrl}: `, error.message);
+                        consola.consola.error(`[DotCMS GraphQL Error] ${newURL}: `, error.message);
                     }
                 });
             }
@@ -2489,19 +2500,19 @@ class PageClient extends BaseApiClient {
                     const status = structuredError.extensions?.status ??
                         (code === 'NOT_FOUND' ? 404 : code === 'PERMISSION_DENIED' ? 403 : 400);
                     const message = code === 'NOT_FOUND'
-                        ? `Page '${normalizedUrl}' was not found`
+                        ? `Page '${newURL}' was not found`
                         : code === 'PERMISSION_DENIED'
-                            ? `Permission denied: you do not have access to page '${normalizedUrl}'. Verify the page permissions in dotCMS and that the auth token has sufficient access.`
-                            : `Page '${normalizedUrl}' could not be loaded (${code})`;
+                            ? `Permission denied: you do not have access to page '${newURL}'. Verify the page permissions in dotCMS and that the auth token has sufficient access.`
+                            : `Page '${newURL}' could not be loaded (${code})`;
                     if (verbose) {
-                        logVerboseError(normalizedUrl, message, {
+                        logVerboseError(newURL, message, {
                             status,
                             code,
                             variables: requestVariables
                         });
                     }
                     else {
-                        consola.consola.error(`[DotCMS GraphQL Error] ${normalizedUrl}: `, message);
+                        consola.consola.error(`[DotCMS GraphQL Error] ${newURL}: `, message);
                     }
                     throw new types.DotErrorPage(message, status, code, undefined, {
                         query: completeQuery,
@@ -2515,10 +2526,10 @@ class PageClient extends BaseApiClient {
                 : null;
             const styleEditorSchemas = pageResponse ? pageResponse.page.styleEditorSchemas : [];
             if (!pageResponse) {
-                throw new types.DotErrorPage(`Page '${normalizedUrl}' was not found`, 404, 'NOT_FOUND', new types.DotHttpError({
+                throw new types.DotErrorPage(`Page '${newURL}' was not found`, 404, 'NOT_FOUND', new types.DotHttpError({
                     status: 404,
                     statusText: 'Not Found',
-                    message: `Page '${normalizedUrl}' was not found`,
+                    message: `Page '${newURL}' was not found`,
                     data: response.errors
                 }), { query: completeQuery, variables: requestVariables });
             }
@@ -2540,9 +2551,9 @@ class PageClient extends BaseApiClient {
                 throw error;
             }
             if (error instanceof types.DotHttpError) {
-                throw new types.DotErrorPage(`Page request failed for URL '${normalizedUrl}': ${error.message}`, error.status, 'UNKNOWN', error, { query: completeQuery, variables: requestVariables });
+                throw new types.DotErrorPage(`Page request failed for URL '${newURL}': ${error.message}`, error.status, 'UNKNOWN', error, { query: completeQuery, variables: requestVariables });
             }
-            throw new types.DotErrorPage(`Page request failed for URL '${normalizedUrl}': ${error instanceof Error ? error.message : 'Unknown error'}`, 500, 'UNKNOWN', undefined, { query: completeQuery, variables: requestVariables });
+            throw new types.DotErrorPage(`Page request failed for URL '${newURL}': ${error instanceof Error ? error.message : 'Unknown error'}`, 500, 'UNKNOWN', undefined, { query: completeQuery, variables: requestVariables });
         }
     }
 }

package/index.esm.js

@@ -2308,6 +2308,19 @@ function mapContentResponse(responseData, keys) {
         return accumulator;
     }, {});
 }
+/**
+ * Returns a shallow copy of the object with every key whose value is `undefined` removed.
+ *
+ * `undefined` is not valid JSON, so keeping such keys breaks consumers that serialize the value
+ * (e.g. Next.js Pages Router `getServerSideProps`/`getStaticProps`). `null` and other falsy values
+ * are preserved since they serialize fine.
+ *
+ * @param {Record<string, unknown>} object - Source object to clean
+ * @returns {Record<string, unknown>} New object without `undefined` values
+ */
+function removeUndefinedValues(object) {
+    return Object.fromEntries(Object.entries(object).filter(([, value]) => value !== undefined));
+}
 /**
  * Executes a GraphQL query against the DotCMS API.
  *
@@ -2427,12 +2440,10 @@ class PageClient extends BaseApiClient {
             additionalQueries: contentQuery,
             verbose
         });
-        const normalizedUrl = url.startsWith('/') ? url : `/${url}`;
-        const requestVariables = {
-            // The url is expected to have a leading slash to comply on VanityURL Matching, some frameworks like Angular will not add the leading slash
-            url: normalizedUrl,
-            // Translate the UVE_MODE key ('EDIT' | 'PREVIEW' | ...) to the value the backend PageMode enum expects ('EDIT_MODE' | 'PREVIEW_MODE' | ...)
-            mode: UVE_MODE[mode],
+        const newURL = url.startsWith('/') ? url : `/${url}`;
+        const requestVariables = removeUndefinedValues({
+            url: newURL,
+            mode: UVE_MODE[mode], // Translate the UVE_MODE key ('EDIT' | 'PREVIEW' | ...) to the value the backend PageMode enum expects ('EDIT_MODE' | 'PREVIEW_MODE' | ...)
             languageId,
             personaId,
             fireRules,
@@ -2440,7 +2451,7 @@ class PageClient extends BaseApiClient {
             siteId,
             variantName,
             ...variables
-        };
+        });
         const requestHeaders = this.requestOptions.headers;
         const requestBody = JSON.stringify({ query: completeQuery, variables: requestVariables });
         try {
@@ -2456,12 +2467,12 @@ class PageClient extends BaseApiClient {
                     .filter((error) => !error.extensions?.code)
                     .forEach((error) => {
                     if (verbose) {
-                        logVerboseError(normalizedUrl, error.message, {
+                        logVerboseError(newURL, error.message, {
                             variables: requestVariables
                         });
                     }
                     else {
-                        consola.error(`[DotCMS GraphQL Error] ${normalizedUrl}: `, error.message);
+                        consola.error(`[DotCMS GraphQL Error] ${newURL}: `, error.message);
                     }
                 });
             }
@@ -2487,19 +2498,19 @@ class PageClient extends BaseApiClient {
                     const status = structuredError.extensions?.status ??
                         (code === 'NOT_FOUND' ? 404 : code === 'PERMISSION_DENIED' ? 403 : 400);
                     const message = code === 'NOT_FOUND'
-                        ? `Page '${normalizedUrl}' was not found`
+                        ? `Page '${newURL}' was not found`
                         : code === 'PERMISSION_DENIED'
-                            ? `Permission denied: you do not have access to page '${normalizedUrl}'. Verify the page permissions in dotCMS and that the auth token has sufficient access.`
-                            : `Page '${normalizedUrl}' could not be loaded (${code})`;
+                            ? `Permission denied: you do not have access to page '${newURL}'. Verify the page permissions in dotCMS and that the auth token has sufficient access.`
+                            : `Page '${newURL}' could not be loaded (${code})`;
                     if (verbose) {
-                        logVerboseError(normalizedUrl, message, {
+                        logVerboseError(newURL, message, {
                             status,
                             code,
                             variables: requestVariables
                         });
                     }
                     else {
-                        consola.error(`[DotCMS GraphQL Error] ${normalizedUrl}: `, message);
+                        consola.error(`[DotCMS GraphQL Error] ${newURL}: `, message);
                     }
                     throw new DotErrorPage(message, status, code, undefined, {
                         query: completeQuery,
@@ -2513,10 +2524,10 @@ class PageClient extends BaseApiClient {
                 : null;
             const styleEditorSchemas = pageResponse ? pageResponse.page.styleEditorSchemas : [];
             if (!pageResponse) {
-                throw new DotErrorPage(`Page '${normalizedUrl}' was not found`, 404, 'NOT_FOUND', new DotHttpError({
+                throw new DotErrorPage(`Page '${newURL}' was not found`, 404, 'NOT_FOUND', new DotHttpError({
                     status: 404,
                     statusText: 'Not Found',
-                    message: `Page '${normalizedUrl}' was not found`,
+                    message: `Page '${newURL}' was not found`,
                     data: response.errors
                 }), { query: completeQuery, variables: requestVariables });
             }
@@ -2538,9 +2549,9 @@ class PageClient extends BaseApiClient {
                 throw error;
             }
             if (error instanceof DotHttpError) {
-                throw new DotErrorPage(`Page request failed for URL '${normalizedUrl}': ${error.message}`, error.status, 'UNKNOWN', error, { query: completeQuery, variables: requestVariables });
+                throw new DotErrorPage(`Page request failed for URL '${newURL}': ${error.message}`, error.status, 'UNKNOWN', error, { query: completeQuery, variables: requestVariables });
             }
-            throw new DotErrorPage(`Page request failed for URL '${normalizedUrl}': ${error instanceof Error ? error.message : 'Unknown error'}`, 500, 'UNKNOWN', undefined, { query: completeQuery, variables: requestVariables });
+            throw new DotErrorPage(`Page request failed for URL '${newURL}': ${error instanceof Error ? error.message : 'Unknown error'}`, 500, 'UNKNOWN', undefined, { query: completeQuery, variables: requestVariables });
         }
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcms/client",
-  "version": "1.5.5-next.2260",
+  "version": "1.5.5-next.2266",
   "description": "Official JavaScript library for interacting with DotCMS REST APIs.",
   "repository": {
     "type": "git",

package/src/lib/client/page/utils.d.ts

@@ -27,6 +27,17 @@ export declare function buildQuery(queryData: Record<string, string>): string;
  * @returns {Record<string, unknown> | undefined} New object containing only the specified keys
  */
 export declare function mapContentResponse(responseData: Record<string, unknown> | undefined, keys: string[]): Record<string, unknown> | undefined;
+/**
+ * Returns a shallow copy of the object with every key whose value is `undefined` removed.
+ *
+ * `undefined` is not valid JSON, so keeping such keys breaks consumers that serialize the value
+ * (e.g. Next.js Pages Router `getServerSideProps`/`getStaticProps`). `null` and other falsy values
+ * are preserved since they serialize fine.
+ *
+ * @param {Record<string, unknown>} object - Source object to clean
+ * @returns {Record<string, unknown>} New object without `undefined` values
+ */
+export declare function removeUndefinedValues(object: Record<string, unknown>): Record<string, unknown>;
 /**
  * Executes a GraphQL query against the DotCMS API.
  *