@wp-typia/project-tools 0.13.4 → 0.15.0

package/templates/_shared/compound/persistence/src/blocks/{{slugKebabCase}}/transport.ts.mustache

@@ -0,0 +1,254 @@
+import {
+	type EndpointCallOptions,
+	resolveRestRouteUrl,
+} from '@wp-typia/rest';
+
+export type PersistenceTransportTarget = 'editor' | 'frontend';
+export type PersistenceTransportOperation = 'read' | 'write';
+
+export interface PersistenceTransportOptions {
+	restNonce?: string;
+	transportTarget?: PersistenceTransportTarget;
+}
+
+interface EndpointWithPath {
+	path: string;
+}
+
+type PersistenceTransportResolver = (
+	endpoint: EndpointWithPath,
+	request?: unknown,
+	options?: PersistenceTransportOptions
+) => EndpointCallOptions;
+
+interface PersistenceTransportTargetResolvers {
+	read: PersistenceTransportResolver;
+	write: PersistenceTransportResolver;
+}
+
+// Replace any of these base URLs to route a given target through a contract-compatible proxy or BFF.
+const EDITOR_READ_BASE_URL: string | undefined = undefined;
+const EDITOR_WRITE_BASE_URL: string | undefined = undefined;
+const FRONTEND_READ_BASE_URL: string | undefined = undefined;
+const FRONTEND_WRITE_BASE_URL: string | undefined = undefined;
+
+function resolveEndpointUrl(
+	endpointPath: string,
+	baseUrl?: string
+): string {
+	if ( typeof baseUrl === 'string' && baseUrl.trim().length > 0 ) {
+		const origin =
+			typeof window !== 'undefined' ? window.location.origin : 'http://localhost';
+		const resolvedBaseUrl = new URL( baseUrl.trim(), origin );
+		const [ pathWithQuery, hash = '' ] = endpointPath.split( '#', 2 );
+		const [ rawPath, rawQuery = '' ] = pathWithQuery.split( '?', 2 );
+		const normalizedEndpointPath = rawPath.replace( /^\/+/, '' );
+
+		if ( resolvedBaseUrl.searchParams.has( 'rest_route' ) ) {
+			const restRouteBase = resolvedBaseUrl.searchParams.get( 'rest_route' ) ?? '/';
+			const normalizedRestRouteBase = restRouteBase
+				.replace( /^\/+/, '' )
+				.replace( /\/+$/, '' );
+			const nextRestRoute = normalizedRestRouteBase.length > 0
+				? `/${ normalizedRestRouteBase }/${ normalizedEndpointPath }`
+				: `/${ normalizedEndpointPath }`;
+			resolvedBaseUrl.searchParams.set( 'rest_route', nextRestRoute );
+		} else {
+			const basePath = resolvedBaseUrl.pathname.endsWith( '/' )
+				? resolvedBaseUrl.pathname
+				: `${ resolvedBaseUrl.pathname }/`;
+			resolvedBaseUrl.pathname = `${ basePath }${ normalizedEndpointPath }`;
+		}
+
+		for ( const [ key, value ] of new URLSearchParams( rawQuery ) ) {
+			resolvedBaseUrl.searchParams.append( key, value );
+		}
+
+		if ( hash ) {
+			resolvedBaseUrl.hash = hash;
+		}
+
+		return resolvedBaseUrl.toString();
+	}
+
+	return resolveRestRouteUrl( endpointPath );
+}
+
+function isPlainObject(
+	value: unknown
+): value is Record< string, unknown > {
+	if ( Object.prototype.toString.call( value ) !== '[object Object]' ) {
+		return false;
+	}
+
+	const prototype = Object.getPrototypeOf( value );
+	return prototype === null || prototype === Object.prototype;
+}
+
+function encodeRequestQuery( request: unknown ): string {
+	if ( request === undefined || request === null ) {
+		return '';
+	}
+
+	if ( request instanceof URLSearchParams ) {
+		return request.toString();
+	}
+
+	if ( ! isPlainObject( request ) ) {
+		throw new Error(
+			'Persistence transport read requests must be plain objects or URLSearchParams.'
+		);
+	}
+
+	const params = new URLSearchParams();
+
+	for ( const [ key, value ] of Object.entries( request ) ) {
+		if ( value === undefined || value === null ) {
+			continue;
+		}
+
+		if ( Array.isArray( value ) ) {
+			for ( const item of value ) {
+				params.append( key, String( item ) );
+			}
+			continue;
+		}
+
+		params.set( key, String( value ) );
+	}
+
+	return params.toString();
+}
+
+function joinUrlWithQuery(
+	url: string,
+	query: string
+): string {
+	if ( ! query ) {
+		return url;
+	}
+
+	const nextUrl = new URL(
+		url,
+		typeof window !== 'undefined' ? window.location.origin : 'http://localhost'
+	);
+
+	for ( const [ key, value ] of new URLSearchParams( query ) ) {
+		nextUrl.searchParams.append( key, value );
+	}
+
+	return nextUrl.toString();
+}
+
+export function resolveRestNonce( fallback?: string ): string | undefined {
+	if ( typeof fallback === 'string' && fallback.length > 0 ) {
+		return fallback;
+	}
+
+	if ( typeof window === 'undefined' ) {
+		return undefined;
+	}
+
+	const wpApiSettings = ( window as typeof window & {
+		wpApiSettings?: { nonce?: string };
+	} ).wpApiSettings;
+
+	return typeof wpApiSettings?.nonce === 'string' && wpApiSettings.nonce.length > 0
+		? wpApiSettings.nonce
+		: undefined;
+}
+
+function buildCallOptions( {
+	baseUrl,
+	endpoint,
+	includeRestNonce,
+	operation,
+	options,
+	request,
+}: {
+	baseUrl?: string;
+	endpoint: EndpointWithPath;
+	includeRestNonce: boolean;
+	operation: PersistenceTransportOperation;
+	options?: PersistenceTransportOptions;
+	request?: unknown;
+} ): EndpointCallOptions {
+	const nonce = includeRestNonce ? resolveRestNonce( options?.restNonce ) : undefined;
+	const requestOptions: EndpointCallOptions['requestOptions'] = {};
+
+	if ( nonce ) {
+		requestOptions.headers = {
+			'X-WP-Nonce': nonce,
+		};
+	}
+
+	if ( typeof baseUrl === 'string' && baseUrl.trim().length > 0 ) {
+		const endpointUrl = resolveEndpointUrl( endpoint.path, baseUrl );
+		requestOptions.url =
+			operation === 'read'
+				? joinUrlWithQuery( endpointUrl, encodeRequestQuery( request ) )
+				: endpointUrl;
+	}
+
+	return Object.keys( requestOptions ).length > 0
+		? {
+				requestOptions,
+			}
+		: {};
+}
+
+export const persistenceTransportTargets: Record<
+	PersistenceTransportTarget,
+	PersistenceTransportTargetResolvers
+> = {
+	editor: {
+		read: ( endpoint, request, options ) =>
+			buildCallOptions( {
+				baseUrl: EDITOR_READ_BASE_URL,
+				endpoint,
+				includeRestNonce: {{isAuthenticatedPersistencePolicy}},
+				operation: 'read',
+				options,
+				request,
+			} ),
+		write: ( endpoint, request, options ) =>
+			buildCallOptions( {
+				baseUrl: EDITOR_WRITE_BASE_URL,
+				endpoint,
+				includeRestNonce: {{isAuthenticatedPersistencePolicy}},
+				operation: 'write',
+				options,
+				request,
+			} ),
+	},
+	frontend: {
+		read: ( endpoint, request, options ) =>
+			buildCallOptions( {
+				baseUrl: FRONTEND_READ_BASE_URL,
+				endpoint,
+				includeRestNonce: false,
+				operation: 'read',
+				options,
+				request,
+			} ),
+		write: ( endpoint, request, options ) =>
+			buildCallOptions( {
+				baseUrl: FRONTEND_WRITE_BASE_URL,
+				endpoint,
+				includeRestNonce: {{isAuthenticatedPersistencePolicy}},
+				operation: 'write',
+				options,
+				request,
+			} ),
+	},
+};
+
+export function resolveTransportCallOptions(
+	target: PersistenceTransportTarget,
+	operation: PersistenceTransportOperation,
+	endpoint: EndpointWithPath,
+	request?: unknown,
+	options?: PersistenceTransportOptions
+): EndpointCallOptions {
+	return persistenceTransportTargets[ target ][ operation ]( endpoint, request, options );
+}

package/templates/_shared/compound/persistence/src/blocks/{{slugKebabCase}}/types.ts.mustache

@@ -32,25 +32,30 @@ export interface {{pascalCase}}Attributes {
 
 export interface {{pascalCase}}Context {
 	buttonLabel: string;
+	bootstrapReady: boolean;
 	canWrite: boolean;
 	count: number;
+	error: string;
+	isBootstrapping: boolean;
+	isLoading: boolean;
+	isSaving: boolean;
 	persistencePolicy: 'authenticated' | 'public';
 	postId: number;
-	publicWriteExpiresAt?: number;
-	publicWriteToken?: string;
 	resourceKey: string;
-	restNonce?: string;
 	showCount: boolean;
 	storage: 'post-meta' | 'custom-table';
+	client?: {{pascalCase}}ClientState;
 }
 
 export interface {{pascalCase}}State {
-	canWrite: boolean;
-	count: number;
-	error?: string;
 	isHydrated: boolean;
-	isLoading: boolean;
-	isSaving: boolean;
+}
+
+export interface {{pascalCase}}ClientState {
+	bootstrapError: string;
+	writeExpiry: number;
+	writeNonce: string;
+	writeToken: string;
 }
 
 export type {{pascalCase}}ValidationResult = ValidationResult< {{pascalCase}}Attributes >;

package/templates/_shared/compound/persistence-auth/{{slugKebabCase}}.php.mustache

@@ -192,6 +192,105 @@ function {{phpPrefix}}_build_state_response( $post_id, $resource_key, $count ) {
 	);
 }
 
+function {{phpPrefix}}_block_tree_has_resource_key( $blocks, $block_name, $resource_key ) {
+	if ( ! is_array( $blocks ) ) {
+		return false;
+	}
+
+	foreach ( $blocks as $block ) {
+		if ( ! is_array( $block ) ) {
+			continue;
+		}
+
+		if ( (string) ( $block['blockName'] ?? '' ) === $block_name ) {
+			$attributes = isset( $block['attrs'] ) && is_array( $block['attrs'] ) ? $block['attrs'] : array();
+			$candidate_resource_key = array_key_exists( 'resourceKey', $attributes )
+				? (string) $attributes['resourceKey']
+				: 'primary';
+			if ( (string) $resource_key === $candidate_resource_key ) {
+				return true;
+			}
+		}
+
+		if (
+			isset( $block['innerBlocks'] ) &&
+			{{phpPrefix}}_block_tree_has_resource_key( $block['innerBlocks'], $block_name, $resource_key )
+		) {
+			return true;
+		}
+	}
+
+	return false;
+}
+
+function {{phpPrefix}}_get_rendered_block_instance_key( $post_id, $block_name, $resource_key ) {
+	return 'wpt_pri_' . md5( implode( '|', array( (string) $block_name, (int) $post_id, (string) $resource_key ) ) );
+}
+
+function {{phpPrefix}}_record_rendered_block_instance( $post_id, $block_name, $resource_key ) {
+	if ( $post_id <= 0 || '' === (string) $resource_key || '' === (string) $block_name ) {
+		return;
+	}
+
+	set_transient(
+		{{phpPrefix}}_get_rendered_block_instance_key( $post_id, $block_name, $resource_key ),
+		1,
+		5 * MINUTE_IN_SECONDS
+	);
+}
+
+function {{phpPrefix}}_has_rendered_block_instance( $post_id, $resource_key ) {
+	if ( $post_id <= 0 || '' === (string) $resource_key ) {
+		return false;
+	}
+
+	if (
+		false !== get_transient(
+			{{phpPrefix}}_get_rendered_block_instance_key(
+				$post_id,
+				'{{namespace}}/{{slugKebabCase}}',
+				$resource_key
+			)
+		)
+	) {
+		return true;
+	}
+
+	$post = get_post( $post_id );
+	if ( ! ( $post instanceof WP_Post ) ) {
+		return false;
+	}
+
+	return {{phpPrefix}}_block_tree_has_resource_key(
+		parse_blocks( (string) $post->post_content ),
+		'{{namespace}}/{{slugKebabCase}}',
+		(string) $resource_key
+	);
+}
+
+function {{phpPrefix}}_build_bootstrap_response( $post_id, $resource_key ) {
+	$post          = get_post( $post_id );
+	$can_read_post =
+		$post instanceof WP_Post &&
+		(
+			is_post_publicly_viewable( $post ) ||
+			current_user_can( 'read_post', $post->ID )
+		);
+	$can_write = $post_id > 0 &&
+		is_user_logged_in() &&
+		$can_read_post &&
+		{{phpPrefix}}_has_rendered_block_instance( (int) $post_id, (string) $resource_key );
+	$response  = array(
+		'canWrite' => $can_write,
+	);
+
+	if ( $can_write ) {
+		$response['restNonce'] = wp_create_nonce( 'wp_rest' );
+	}
+
+	return $response;
+}
+
 // Route handlers are the main product-level extension point for parent-block request/response shaping.
 function {{phpPrefix}}_handle_get_state( WP_REST_Request $request ) {
 	$payload = {{phpPrefix}}_validate_and_sanitize_request(
@@ -218,6 +317,34 @@ function {{phpPrefix}}_handle_get_state( WP_REST_Request $request ) {
 	);
 }
 
+function {{phpPrefix}}_handle_get_bootstrap( WP_REST_Request $request ) {
+	$payload = {{phpPrefix}}_validate_and_sanitize_request(
+		array(
+			'postId'      => $request->get_param( 'postId' ),
+			'resourceKey' => $request->get_param( 'resourceKey' ),
+		),
+		{{phpPrefix}}_get_rest_build_dir(),
+		'bootstrap-query',
+		'query'
+	);
+
+	if ( is_wp_error( $payload ) ) {
+		return $payload;
+	}
+
+	$response = rest_ensure_response(
+		{{phpPrefix}}_build_bootstrap_response(
+			(int) $payload['postId'],
+			(string) $payload['resourceKey']
+		)
+	);
+
+	$response->header( 'Cache-Control', 'no-store, no-cache, must-revalidate, max-age=0, s-maxage=0' );
+	$response->header( 'Pragma', 'no-cache' );
+	$response->header( 'Vary', 'Cookie' );
+	return $response;
+}
+
 function {{phpPrefix}}_handle_write_state( WP_REST_Request $request ) {
 	$payload = {{phpPrefix}}_validate_and_sanitize_request(
 		$request->get_json_params(),
@@ -267,6 +394,18 @@ function {{phpPrefix}}_register_routes() {
 			),
 		)
 	);
+
+	register_rest_route(
+		'{{namespace}}/v1',
+		'/{{slugKebabCase}}/bootstrap',
+		array(
+			array(
+				'methods'             => WP_REST_Server::READABLE,
+				'callback'            => '{{phpPrefix}}_handle_get_bootstrap',
+				'permission_callback' => '__return_true',
+			),
+		)
+	);
 }
 
 function {{phpPrefix}}_register_blocks() {

package/templates/_shared/compound/persistence-public/{{slugKebabCase}}.php.mustache

@@ -195,6 +195,126 @@ function {{phpPrefix}}_build_state_response( $post_id, $resource_key, $count ) {
 	);
 }
 
+function {{phpPrefix}}_block_tree_has_resource_key( $blocks, $block_name, $resource_key ) {
+	if ( ! is_array( $blocks ) ) {
+		return false;
+	}
+
+	foreach ( $blocks as $block ) {
+		if ( ! is_array( $block ) ) {
+			continue;
+		}
+
+		if ( (string) ( $block['blockName'] ?? '' ) === $block_name ) {
+			$attributes = isset( $block['attrs'] ) && is_array( $block['attrs'] ) ? $block['attrs'] : array();
+			$candidate_resource_key = array_key_exists( 'resourceKey', $attributes )
+				? (string) $attributes['resourceKey']
+				: 'primary';
+			if ( (string) $resource_key === $candidate_resource_key ) {
+				return true;
+			}
+		}
+
+		if (
+			isset( $block['innerBlocks'] ) &&
+			{{phpPrefix}}_block_tree_has_resource_key( $block['innerBlocks'], $block_name, $resource_key )
+		) {
+			return true;
+		}
+	}
+
+	return false;
+}
+
+function {{phpPrefix}}_get_rendered_block_instance_key( $post_id, $block_name, $resource_key ) {
+	return 'wpt_pri_' . md5( implode( '|', array( (string) $block_name, (int) $post_id, (string) $resource_key ) ) );
+}
+
+function {{phpPrefix}}_record_rendered_block_instance( $post_id, $block_name, $resource_key ) {
+	if ( $post_id <= 0 || '' === (string) $resource_key || '' === (string) $block_name ) {
+		return;
+	}
+
+	set_transient(
+		{{phpPrefix}}_get_rendered_block_instance_key( $post_id, $block_name, $resource_key ),
+		1,
+		5 * MINUTE_IN_SECONDS
+	);
+}
+
+function {{phpPrefix}}_has_rendered_block_instance( $post_id, $resource_key ) {
+	if ( $post_id <= 0 || '' === (string) $resource_key ) {
+		return false;
+	}
+
+	if (
+		false !== get_transient(
+			{{phpPrefix}}_get_rendered_block_instance_key(
+				$post_id,
+				'{{namespace}}/{{slugKebabCase}}',
+				$resource_key
+			)
+		)
+	) {
+		return true;
+	}
+
+	$post = get_post( $post_id );
+	if ( ! ( $post instanceof WP_Post ) ) {
+		return false;
+	}
+
+	if ( ! is_post_publicly_viewable( $post ) ) {
+		return false;
+	}
+
+	return {{phpPrefix}}_block_tree_has_resource_key(
+		parse_blocks( (string) $post->post_content ),
+		'{{namespace}}/{{slugKebabCase}}',
+		(string) $resource_key
+	);
+}
+
+function {{phpPrefix}}_build_bootstrap_response( $post_id, $resource_key ) {
+	$response = array(
+		'canWrite' => false,
+	);
+	$post = get_post( $post_id );
+
+	if (
+		$post_id <= 0 ||
+		! ( $post instanceof WP_Post ) ||
+		! is_post_publicly_viewable( $post ) ||
+		! function_exists( '{{phpPrefix}}_create_public_write_token' ) ||
+		! {{phpPrefix}}_has_rendered_block_instance( (int) $post_id, (string) $resource_key )
+	) {
+		return $response;
+	}
+
+	$public_write = {{phpPrefix}}_create_public_write_token( (int) $post_id, (string) $resource_key );
+	if ( ! is_array( $public_write ) ) {
+		return $response;
+	}
+
+	$token      = isset( $public_write['token'] ) ? (string) $public_write['token'] : '';
+	$expires_at = isset( $public_write['expiresAt'] ) ? (int) $public_write['expiresAt'] : 0;
+	$is_expired = $expires_at > 0 && $expires_at <= time();
+
+	if ( '' !== $token && $expires_at > 0 && ! $is_expired ) {
+		$response['publicWriteToken'] = $token;
+		$response['canWrite']         = true;
+	}
+
+	if ( $expires_at > 0 ) {
+		$response['publicWriteExpiresAt'] = $expires_at;
+		if ( $is_expired ) {
+			$response['canWrite'] = false;
+		}
+	}
+
+	return $response;
+}
+
 // Route handlers are the main product-level extension point for parent-block request/response shaping.
 function {{phpPrefix}}_handle_get_state( WP_REST_Request $request ) {
 	$payload = {{phpPrefix}}_validate_and_sanitize_request(
@@ -221,6 +341,33 @@ function {{phpPrefix}}_handle_get_state( WP_REST_Request $request ) {
 	);
 }
 
+function {{phpPrefix}}_handle_get_bootstrap( WP_REST_Request $request ) {
+	$payload = {{phpPrefix}}_validate_and_sanitize_request(
+		array(
+			'postId'      => $request->get_param( 'postId' ),
+			'resourceKey' => $request->get_param( 'resourceKey' ),
+		),
+		{{phpPrefix}}_get_rest_build_dir(),
+		'bootstrap-query',
+		'query'
+	);
+
+	if ( is_wp_error( $payload ) ) {
+		return $payload;
+	}
+
+	$response = rest_ensure_response(
+		{{phpPrefix}}_build_bootstrap_response(
+			(int) $payload['postId'],
+			(string) $payload['resourceKey']
+		)
+	);
+
+	$response->header( 'Cache-Control', 'no-store, no-cache, must-revalidate, max-age=0, s-maxage=0' );
+	$response->header( 'Pragma', 'no-cache' );
+	return $response;
+}
+
 function {{phpPrefix}}_handle_write_state( WP_REST_Request $request ) {
 	$payload = {{phpPrefix}}_validate_and_sanitize_request(
 		$request->get_json_params(),
@@ -285,6 +432,18 @@ function {{phpPrefix}}_register_routes() {
 			),
 		)
 	);
+
+	register_rest_route(
+		'{{namespace}}/v1',
+		'/{{slugKebabCase}}/bootstrap',
+		array(
+			array(
+				'methods'             => WP_REST_Server::READABLE,
+				'callback'            => '{{phpPrefix}}_handle_get_bootstrap',
+				'permission_callback' => '__return_true',
+			),
+		)
+	);
 }
 
 function {{phpPrefix}}_register_blocks() {