@wordpress/server-side-render 6.16.1-next.v.202602241322.0 → 6.16.1

package/build-types/hook.d.ts

@@ -0,0 +1,68 @@
+export declare function rendererPath(block: string, attributes?: Record<string, unknown> | null, urlQueryArgs?: Record<string, unknown>): string;
+export declare function removeBlockSupportAttributes(attributes: Record<string, unknown> & {
+    style?: Record<string, unknown>;
+}): Record<string, unknown>;
+/**
+ * Server-side render response object.
+ */
+export interface ServerSideRenderResponse {
+    /** The current request status: 'idle', 'loading', 'success', or 'error'. */
+    status: 'idle' | 'loading' | 'success' | 'error';
+    /** The rendered block content (available when status is 'success'). */
+    content?: string;
+    /** The error message (available when status is 'error'). */
+    error?: string;
+}
+/**
+ * Configuration object for the useServerSideRender hook.
+ */
+export interface UseServerSideRenderArgs {
+    /** The block attributes to be sent to the server for rendering. */
+    attributes: Record<string, unknown>;
+    /** The identifier of the block to be serverside rendered. Example: 'core/archives'. */
+    block: string;
+    /** Whether to remove block support attributes before sending. */
+    skipBlockSupportAttributes?: boolean;
+    /** The HTTP method to use ('GET' or 'POST'). Default is 'GET'. */
+    httpMethod?: 'GET' | 'POST';
+    /** Additional query arguments to append to the request URL. */
+    urlQueryArgs?: Record<string, unknown>;
+}
+/**
+ * A hook for server-side rendering a preview of dynamic blocks to display in the editor.
+ *
+ * Handles fetching server-rendered previews for blocks, managing loading states,
+ * and automatically debouncing requests to prevent excessive API calls. It supports both
+ * GET and POST requests, with POST requests used for larger attribute payloads.
+ *
+ * @example
+ * Basic usage:
+ *
+ * ```jsx
+ * import { RawHTML } from '@wordpress/element';
+ * import { useServerSideRender } from '@wordpress/server-side-render';
+ *
+ * function MyServerSideRender( { attributes, block } ) {
+ *   const { content, status, error } = useServerSideRender( {
+ *     attributes,
+ *     block,
+ *   } );
+ *
+ *   if ( status === 'loading' ) {
+ *     return <div>Loading...</div>;
+ *   }
+ *
+ *   if ( status === 'error' ) {
+ *     return <div>Error: { error }</div>;
+ *   }
+ *
+ *   return <RawHTML>{ content }</RawHTML>;
+ * }
+ * ```
+ *
+ * @param args The hook configuration object.
+ *
+ * @return The server-side render response object.
+ */
+export declare function useServerSideRender(args: UseServerSideRenderArgs): ServerSideRenderResponse;
+//# sourceMappingURL=hook.d.ts.map

package/build-types/hook.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hook.d.ts","sourceRoot":"","sources":["../src/hook.ts"],"names":[],"mappings":"AAUA,wBAAgB,YAAY,CAC3B,KAAK,EAAE,MAAM,EACb,UAAU,GAAE,MAAM,CAAE,MAAM,EAAE,OAAO,CAAE,GAAG,IAAW,EACnD,YAAY,GAAE,MAAM,CAAE,MAAM,EAAE,OAAO,CAAO,GAC1C,MAAM,CAMR;AAED,wBAAgB,4BAA4B,CAC3C,UAAU,EAAE,MAAM,CAAE,MAAM,EAAE,OAAO,CAAE,GAAG;IACvC,KAAK,CAAC,EAAE,MAAM,CAAE,MAAM,EAAE,OAAO,CAAE,CAAC;CAClC,GACC,MAAM,CAAE,MAAM,EAAE,OAAO,CAAE,CA0B3B;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACxC,4EAA4E;IAC5E,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC;IACjD,uEAAuE;IACvE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,4DAA4D;IAC5D,KAAK,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACvC,mEAAmE;IACnE,UAAU,EAAE,MAAM,CAAE,MAAM,EAAE,OAAO,CAAE,CAAC;IACtC,uFAAuF;IACvF,KAAK,EAAE,MAAM,CAAC;IACd,iEAAiE;IACjE,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC,kEAAkE;IAClE,UAAU,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAC5B,+DAA+D;IAC/D,YAAY,CAAC,EAAE,MAAM,CAAE,MAAM,EAAE,OAAO,CAAE,CAAC;CACzC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAgB,mBAAmB,CAClC,IAAI,EAAE,uBAAuB,GAC3B,wBAAwB,CA2F1B"}

package/build-types/index.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Internal dependencies
+ */
+import { ServerSideRenderWithPostId } from './server-side-render';
+import { useServerSideRender } from './hook';
+/**
+ * A compatibility layer for the `ServerSideRender` component when used with `wp` global namespace.
+ *
+ * @deprecated Use `ServerSideRender` non-default export instead.
+ *
+ * @example
+ * ```js
+ * import ServerSideRender from '@wordpress/server-side-render';
+ * ```
+ */
+declare const ServerSideRenderCompat: typeof ServerSideRenderWithPostId & {
+    ServerSideRender: typeof ServerSideRenderWithPostId;
+    useServerSideRender: typeof useServerSideRender;
+};
+export { ServerSideRenderWithPostId as ServerSideRender };
+export { useServerSideRender };
+export default ServerSideRenderCompat;
+//# sourceMappingURL=index.d.ts.map

package/build-types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,0BAA0B,EAAE,MAAM,sBAAsB,CAAC;AAClE,OAAO,EAAE,mBAAmB,EAAE,MAAM,QAAQ,CAAC;AAE7C;;;;;;;;;GASG;AACH,QAAA,MAAM,sBAAsB,EACG,OAAO,0BAA0B,GAAG;IACjE,gBAAgB,EAAE,OAAO,0BAA0B,CAAC;IACpD,mBAAmB,EAAE,OAAO,mBAAmB,CAAC;CAChD,CAAC;AAKH,OAAO,EAAE,0BAA0B,IAAI,gBAAgB,EAAE,CAAC;AAC1D,OAAO,EAAE,mBAAmB,EAAE,CAAC;eAChB,sBAAsB"}

package/build-types/server-side-render.d.ts

@@ -0,0 +1,32 @@
+import type { ServerSideRenderProps, ServerSideRenderWithPostIdProps } from './types';
+export declare function ServerSideRender(props: ServerSideRenderProps): import("react").JSX.Element;
+/**
+ * A component that renders server-side content for blocks.
+ *
+ * Note: URL query will include the current post ID when applicable.
+ * This is useful for blocks that depend on the context of the current post for rendering.
+ *
+ * @example
+ * ```jsx
+ * import { ServerSideRender } from '@wordpress/server-side-render';
+ * // Legacy import for WordPress 6.8 and earlier
+ * // import { default as ServerSideRender } from '@wordpress/server-side-render';
+ *
+ * function Example() {
+ *   return (
+ *     <ServerSideRender
+ *       block="core/archives"
+ *       attributes={ { showPostCounts: true } }
+ *       urlQueryArgs={ { customArg: 'value' } }
+ *       className="custom-class"
+ *     />
+ *   );
+ * }
+ * ```
+ *
+ * @param props              Component props.
+ * @param props.urlQueryArgs Additional query arguments to append to the request URL.
+ * @return The rendered server-side content.
+ */
+export declare function ServerSideRenderWithPostId({ urlQueryArgs, ...props }: ServerSideRenderWithPostIdProps): import("react").JSX.Element;
+//# sourceMappingURL=server-side-render.d.ts.map

package/build-types/server-side-render.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"server-side-render.d.ts","sourceRoot":"","sources":["../src/server-side-render.tsx"],"names":[],"mappings":"AAkBA,OAAO,KAAK,EAIX,qBAAqB,EACrB,+BAA+B,EAC/B,MAAM,SAAS,CAAC;AA2DjB,wBAAgB,gBAAgB,CAAE,KAAK,EAAE,qBAAqB,+BA4C7D;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,0BAA0B,CAAE,EAC3C,YAA2B,EAC3B,GAAG,KAAK,EACR,EAAE,+BAA+B,+BA2BjC"}

package/build-types/types.d.ts

@@ -0,0 +1,34 @@
+/**
+ * WordPress dependencies
+ */
+import type React from 'react';
+/**
+ * Internal dependencies
+ */
+import type { UseServerSideRenderArgs } from './hook';
+export interface PlaceholderProps {
+    /** Additional classes to apply to the wrapper element. */
+    className?: string;
+}
+export interface ErrorPlaceholderProps extends PlaceholderProps {
+    /** Error message describing the problem. */
+    message?: string;
+}
+export interface LoadingPlaceholderProps {
+    children?: React.ReactNode;
+}
+export interface ServerSideRenderProps extends UseServerSideRenderArgs {
+    /** Additional classes to apply to the wrapper element. */
+    className?: string;
+    /** Component rendered when the API response is empty. */
+    EmptyResponsePlaceholder?: React.ComponentType<PlaceholderProps>;
+    /** Component rendered when the API response is an error. */
+    ErrorResponsePlaceholder?: React.ComponentType<ErrorPlaceholderProps>;
+    /** Component rendered while the API request is loading. */
+    LoadingResponsePlaceholder?: React.ComponentType<LoadingPlaceholderProps>;
+}
+export interface ServerSideRenderWithPostIdProps extends Omit<ServerSideRenderProps, 'urlQueryArgs'> {
+    /** Additional query arguments to append to the request URL. */
+    urlQueryArgs?: Record<string, unknown>;
+}
+//# sourceMappingURL=types.d.ts.map

package/build-types/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B;;GAEG;AACH,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,QAAQ,CAAC;AAEtD,MAAM,WAAW,gBAAgB;IAChC,0DAA0D;IAC1D,SAAS,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC9D,4CAA4C;IAC5C,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,uBAAuB;IACvC,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;CAC3B;AAED,MAAM,WAAW,qBAAsB,SAAQ,uBAAuB;IACrE,0DAA0D;IAC1D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,yDAAyD;IACzD,wBAAwB,CAAC,EAAE,KAAK,CAAC,aAAa,CAAE,gBAAgB,CAAE,CAAC;IACnE,4DAA4D;IAC5D,wBAAwB,CAAC,EAAE,KAAK,CAAC,aAAa,CAAE,qBAAqB,CAAE,CAAC;IACxE,2DAA2D;IAC3D,0BAA0B,CAAC,EAAE,KAAK,CAAC,aAAa,CAAE,uBAAuB,CAAE,CAAC;CAC5E;AAED,MAAM,WAAW,+BAChB,SAAQ,IAAI,CAAE,qBAAqB,EAAE,cAAc,CAAE;IACrD,+DAA+D;IAC/D,YAAY,CAAC,EAAE,MAAM,CAAE,MAAM,EAAE,OAAO,CAAE,CAAC;CACzC"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wordpress/server-side-render",
-	"version": "6.16.1-next.v.202602241322.0+bce7cff88",
+	"version": "6.16.1",
 	"description": "The component used with WordPress to server-side render a preview of dynamic blocks to display in the editor.",
 	"author": "The WordPress Contributors",
 	"license": "GPL-2.0-or-later",
@@ -43,15 +43,15 @@
 	"wpScript": true,
 	"wpScriptDefaultExport": true,
 	"dependencies": {
-		"@wordpress/api-fetch": "^7.40.1-next.v.202602241322.0+bce7cff88",
-		"@wordpress/blocks": "^15.13.1-next.v.202602241322.0+bce7cff88",
-		"@wordpress/components": "^32.3.1-next.v.202602241322.0+bce7cff88",
-		"@wordpress/compose": "^7.40.1-next.v.202602241322.0+bce7cff88",
-		"@wordpress/data": "^10.40.1-next.v.202602241322.0+bce7cff88",
-		"@wordpress/deprecated": "^4.40.1-next.v.202602241322.0+bce7cff88",
-		"@wordpress/element": "^6.40.1-next.v.202602241322.0+bce7cff88",
-		"@wordpress/i18n": "^6.13.1-next.v.202602241322.0+bce7cff88",
-		"@wordpress/url": "^4.40.1-next.v.202602241322.0+bce7cff88"
+		"@wordpress/api-fetch": "^7.40.1",
+		"@wordpress/blocks": "^15.13.1",
+		"@wordpress/components": "^32.2.1",
+		"@wordpress/compose": "^7.40.1",
+		"@wordpress/data": "^10.40.1",
+		"@wordpress/deprecated": "^4.40.1",
+		"@wordpress/element": "^6.40.1",
+		"@wordpress/i18n": "^6.13.1",
+		"@wordpress/url": "^4.40.1"
 	},
 	"peerDependencies": {
 		"react": "^18.0.0",
@@ -60,5 +60,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "943dde7f0b600ce238726c36284bc9f70ce0ffa4"
+	"gitHead": "adb6623c9f32490cfc73c7ac7f122578c1f10c65"
 }