Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions attw.json
Original file line number Diff line number Diff line change
Expand Up @@ -328,6 +328,7 @@
"webscopeio__react-textarea-autocomplete",
"when",
"wnumb",
"wordpress__server-side-render",
"yargs-parser",
"yargs-parser/v20",
"yargs/v16",
Expand Down
2 changes: 1 addition & 1 deletion types/nodemailer/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"@types/node": "*"
},
"devDependencies": {
"@aws-sdk/client-sesv2": "^3.839.0",
"@aws-sdk/client-sesv2": "^3.985.0",
"@types/nodemailer": "workspace:."
},
"owners": [
Expand Down
5 changes: 5 additions & 0 deletions types/wordpress__server-side-render/.npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
*
!**/*.d.ts
!**/*.d.cts
!**/*.d.mts
!**/*.d.*.ts
84 changes: 84 additions & 0 deletions types/wordpress__server-side-render/index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
import type { ComponentType, JSX, PropsWithChildren } from "react";

export interface ServerSideRenderProps {
/** The identifier of the block to be serverside rendered. */
block: string;
/** The block attributes to be sent to the server for rendering. */
attributes?: Record<string, unknown> | null;
/** Additional classes to apply to the wrapper element. */
className?: string;
/** 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, string | number | boolean | undefined>;
/** Whether to remove block support attributes before sending. */
skipBlockSupportAttributes?: boolean;
/** Component rendered when the API response is empty. */
EmptyResponsePlaceholder?: ComponentType<ServerSideRenderProps>;
/** Component rendered when the API response is an error. */
ErrorResponsePlaceholder?: ComponentType<ServerSideRenderProps & { message: string }>;
/** Component rendered while the API request is loading. */
LoadingResponsePlaceholder?: ComponentType<PropsWithChildren<ServerSideRenderProps>>;
}

/** A component that renders server-side content for blocks. */
export function ServerSideRender(props: ServerSideRenderProps): JSX.Element;

/**
* @deprecated Use `ServerSideRender` non-default export instead:
* ```js
* import { ServerSideRender } from '@wordpress/server-side-render';
* ```
*/
declare const ServerSideRenderDefault: typeof ServerSideRender;
export default ServerSideRenderDefault;

export type UseServerSideRenderArgs = Pick<
ServerSideRenderProps,
"block" | "attributes" | "httpMethod" | "urlQueryArgs" | "skipBlockSupportAttributes"
>;

export type ServerSideRenderStatus = "idle" | "loading" | "success" | "error";

export interface ServerSideRenderResponse {
/** The current request status: 'idle', 'loading', 'success', or 'error'. */
status: ServerSideRenderStatus;
/** The rendered block content (available when status is 'success'). */
content?: string;
/** The error message (available when status is 'error'). */
error?: string;
}

/**
* 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>;
* }
* ```
*/
export function useServerSideRender(args: UseServerSideRenderArgs): ServerSideRenderResponse;
20 changes: 20 additions & 0 deletions types/wordpress__server-side-render/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"private": true,
"name": "@types/wordpress__server-side-render",
"version": "6.15.9999",
"projects": [
"https://github.com/WordPress/gutenberg/tree/HEAD/packages/server-side-render/README.md"
],
"dependencies": {
"@types/react": "^18"
},
"devDependencies": {
"@types/wordpress__server-side-render": "workspace:."
},
"owners": [
{
"name": "Rafał Całka",
"githubUsername": "rafaucau"
}
]
}
20 changes: 20 additions & 0 deletions types/wordpress__server-side-render/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"compilerOptions": {
"module": "node16",
"lib": [
"es6"
],
"jsx": "preserve",
"noImplicitAny": true,
"noImplicitThis": true,
"strictFunctionTypes": true,
"strictNullChecks": true,
"types": [],
"noEmit": true,
"forceConsistentCasingInFileNames": true
},
"files": [
"index.d.ts",
"wordpress__server-side-render-tests.tsx"
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import { ServerSideRender, useServerSideRender } from "@wordpress/server-side-render";

<ServerSideRender
block="my/block"
className="my-block"
ErrorResponsePlaceholder={(props) => <p>An error occurred while loading {props.block}: {props.message}</p>}
/>;

function MyServerSideRender({ attributes, block }: { attributes: Record<string, unknown>; block: string }) {
const { content, status, error } = useServerSideRender({
attributes,
block,
});

return <code>{content}</code>;
}