@wp-typia/project-tools 0.11.1

package/templates/_shared/persistence/core/{{slugKebabCase}}.php.mustache

@@ -0,0 +1,336 @@
+<?php
+/**
+ * Plugin Name:       {{title}}
+ * Description:       {{description}}
+ * Version:           0.1.0
+ * Requires at least: 6.7
+ * Tested up to:      6.9
+ * Requires PHP:      8.0
+ * Author:            {{author}}
+ * License:           GPL-2.0-or-later
+ * License URI:       https://www.gnu.org/licenses/gpl-2.0.html
+ * Text Domain:       {{textDomain}}
+ * Domain Path:       /languages
+ */
+
+if ( ! defined( 'ABSPATH' ) ) {
+	exit;
+}
+
+function {{phpPrefix}}_load_textdomain() {
+	load_plugin_textdomain(
+		'{{textDomain}}',
+		false,
+		dirname( plugin_basename( __FILE__ ) ) . '/languages'
+	);
+}
+
+define( '{{phpPrefixUpper}}_DATA_STORAGE_MODE', '{{dataStorageMode}}' );
+
+function {{phpPrefix}}_get_build_dir() {
+	$candidates = array(
+		__DIR__ . '/build',
+		__DIR__ . '/build/{{slugKebabCase}}',
+	);
+
+	foreach ( $candidates as $candidate ) {
+		if ( file_exists( $candidate . '/block.json' ) ) {
+			return $candidate;
+		}
+	}
+
+	return null;
+}
+
+function {{phpPrefix}}_get_counter_table_name() {
+	global $wpdb;
+	return $wpdb->prefix . '{{phpPrefix}}_counters';
+}
+
+function {{phpPrefix}}_get_counter_lock_name( $post_id, $resource_key ) {
+	return 'wpt_pcl_' . md5(
+		'{{phpPrefix}}|' . (int) $post_id . '|' . (string) $resource_key
+	);
+}
+
+function {{phpPrefix}}_with_counter_lock( $post_id, $resource_key, $callback ) {
+	global $wpdb;
+
+	$lock_name = {{phpPrefix}}_get_counter_lock_name( $post_id, $resource_key );
+	$acquired  = (int) $wpdb->get_var(
+		$wpdb->prepare(
+			'SELECT GET_LOCK(%s, 5)',
+			$lock_name
+		)
+	);
+
+	if ( 1 !== $acquired ) {
+		return new WP_Error( 'counter_lock_timeout', 'Could not acquire the counter lock.', array( 'status' => 503 ) );
+	}
+
+	try {
+		return $callback();
+	} finally {
+		$wpdb->get_var(
+			$wpdb->prepare(
+				'SELECT RELEASE_LOCK(%s)',
+				$lock_name
+			)
+		);
+	}
+}
+
+function {{phpPrefix}}_maybe_install_storage() {
+	if ( 'custom-table' !== '{{dataStorageMode}}' ) {
+		return;
+	}
+
+	global $wpdb;
+	require_once ABSPATH . 'wp-admin/includes/upgrade.php';
+
+	$table_name      = {{phpPrefix}}_get_counter_table_name();
+	$charset_collate = $wpdb->get_charset_collate();
+	$sql             = "CREATE TABLE {$table_name} (
+		post_id bigint(20) unsigned NOT NULL,
+		resource_key varchar(100) NOT NULL,
+		count bigint(20) unsigned NOT NULL DEFAULT 0,
+		updated_at datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
+		PRIMARY KEY  (post_id, resource_key)
+	) {$charset_collate};";
+
+	dbDelta( $sql );
+	$table_exists = $wpdb->get_var(
+		$wpdb->prepare(
+			'SHOW TABLES LIKE %s',
+			$table_name
+		)
+	);
+
+	if ( $table_name === $table_exists ) {
+		update_option( '{{phpPrefix}}_storage_version', '1.0.0' );
+	}
+}
+
+function {{phpPrefix}}_ensure_storage_installed() {
+	if ( 'custom-table' === '{{dataStorageMode}}' && '1.0.0' !== get_option( '{{phpPrefix}}_storage_version', '' ) ) {
+		{{phpPrefix}}_maybe_install_storage();
+	}
+}
+
+function {{phpPrefix}}_load_schema( $schema_name ) {
+	$build_dir = {{phpPrefix}}_get_build_dir();
+	if ( ! $build_dir ) {
+		return null;
+	}
+
+	$path = $build_dir . '/api-schemas/' . $schema_name . '.schema.json';
+	if ( ! file_exists( $path ) ) {
+		return null;
+	}
+
+	$decoded = json_decode( file_get_contents( $path ), true );
+	return is_array( $decoded ) ? $decoded : null;
+}
+
+function {{phpPrefix}}_sanitize_rest_schema( $schema ) {
+	if ( ! is_array( $schema ) ) {
+		return $schema;
+	}
+
+	unset( $schema['$schema'], $schema['title'] );
+
+	if ( isset( $schema['properties'] ) && is_array( $schema['properties'] ) ) {
+		foreach ( $schema['properties'] as $key => $property_schema ) {
+			$schema['properties'][ $key ] = {{phpPrefix}}_sanitize_rest_schema( $property_schema );
+		}
+	}
+
+	if ( isset( $schema['items'] ) && is_array( $schema['items'] ) ) {
+		$schema['items'] = {{phpPrefix}}_sanitize_rest_schema( $schema['items'] );
+	}
+
+	return $schema;
+}
+
+function {{phpPrefix}}_validate_and_sanitize_request( $value, $schema_name, $param_name ) {
+	$schema = {{phpPrefix}}_load_schema( $schema_name );
+	if ( ! is_array( $schema ) ) {
+		return new WP_Error( 'missing_schema', 'Missing REST schema.', array( 'status' => 500 ) );
+	}
+
+	$rest_schema = {{phpPrefix}}_sanitize_rest_schema( $schema );
+	$validation  = rest_validate_value_from_schema( $value, $rest_schema, $param_name );
+	if ( is_wp_error( $validation ) ) {
+		return $validation;
+	}
+
+	return rest_sanitize_value_from_schema( $value, $rest_schema, $param_name );
+}
+
+function {{phpPrefix}}_get_counter( $post_id, $resource_key ) {
+	global $wpdb;
+
+	if ( 'custom-table' === '{{dataStorageMode}}' ) {
+		$table_name = {{phpPrefix}}_get_counter_table_name();
+		$count      = $wpdb->get_var(
+			$wpdb->prepare(
+				// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Table name comes from an internal helper.
+				"SELECT count FROM {$table_name} WHERE post_id = %d AND resource_key = %s",
+				$post_id,
+				$resource_key
+			)
+		);
+
+		return null === $count ? 0 : (int) $count;
+	}
+
+	$meta_key = '_' . '{{phpPrefix}}' . '_counter_' . sanitize_key( $resource_key );
+	return (int) get_post_meta( $post_id, $meta_key, true );
+}
+
+function {{phpPrefix}}_increment_counter( $post_id, $resource_key, $delta ) {
+	global $wpdb;
+
+	if ( 'custom-table' === '{{dataStorageMode}}' ) {
+		$table_name    = {{phpPrefix}}_get_counter_table_name();
+		$delta_value   = (int) $delta;
+		$initial_count = max( 0, $delta_value );
+		$result        = $wpdb->query(
+			$wpdb->prepare(
+				// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Table name comes from an internal helper.
+				"INSERT INTO {$table_name} (post_id, resource_key, count, updated_at)
+				VALUES (%d, %s, %d, %s)
+				ON DUPLICATE KEY UPDATE
+					count = GREATEST(0, count + %d),
+					updated_at = VALUES(updated_at)",
+				$post_id,
+				$resource_key,
+				$initial_count,
+				current_time( 'mysql', true ),
+				$delta_value
+			)
+		);
+
+		if ( false === $result ) {
+			return new WP_Error( 'counter_update_failed', 'Failed to update the counter.', array( 'status' => 500 ) );
+		}
+
+		return {{phpPrefix}}_get_counter( $post_id, $resource_key );
+	}
+
+	return {{phpPrefix}}_with_counter_lock(
+		$post_id,
+		$resource_key,
+		function () use ( $delta, $post_id, $resource_key ) {
+			$meta_key   = '_' . '{{phpPrefix}}' . '_counter_' . sanitize_key( $resource_key );
+			$next_count = max( 0, {{phpPrefix}}_get_counter( $post_id, $resource_key ) + (int) $delta );
+			update_post_meta( $post_id, $meta_key, $next_count );
+			return $next_count;
+		}
+	);
+}
+
+function {{phpPrefix}}_build_state_response( $post_id, $resource_key, $count ) {
+	return array(
+		'postId'      => (int) $post_id,
+		'resourceKey' => (string) $resource_key,
+		'count'       => (int) $count,
+		'storage'     => '{{dataStorageMode}}',
+	);
+}
+
+function {{phpPrefix}}_handle_get_state( WP_REST_Request $request ) {
+	$payload = {{phpPrefix}}_validate_and_sanitize_request(
+		array(
+			'postId'      => $request->get_param( 'postId' ),
+			'resourceKey' => $request->get_param( 'resourceKey' ),
+		),
+		'state-query',
+		'query'
+	);
+
+	if ( is_wp_error( $payload ) ) {
+		return $payload;
+	}
+
+	$count = {{phpPrefix}}_get_counter( (int) $payload['postId'], (string) $payload['resourceKey'] );
+	return rest_ensure_response(
+		{{phpPrefix}}_build_state_response(
+			(int) $payload['postId'],
+			(string) $payload['resourceKey'],
+			$count
+		)
+	);
+}
+
+function {{phpPrefix}}_handle_write_state( WP_REST_Request $request ) {
+	$payload = {{phpPrefix}}_validate_and_sanitize_request(
+		$request->get_json_params(),
+		'write-state-request',
+		'body'
+	);
+
+	if ( is_wp_error( $payload ) ) {
+		return $payload;
+	}
+
+	$count = {{phpPrefix}}_increment_counter(
+		(int) $payload['postId'],
+		(string) $payload['resourceKey'],
+		isset( $payload['delta'] ) ? (int) $payload['delta'] : 1
+	);
+
+	if ( is_wp_error( $count ) ) {
+		return $count;
+	}
+
+	return rest_ensure_response(
+		{{phpPrefix}}_build_state_response(
+			(int) $payload['postId'],
+			(string) $payload['resourceKey'],
+			$count
+		)
+	);
+}
+
+function {{phpPrefix}}_deny_write_without_policy() {
+	return new WP_Error(
+		'rest_forbidden',
+		'This scaffold requires an explicit write policy helper before enabling writes.',
+		array( 'status' => 403 )
+	);
+}
+
+function {{phpPrefix}}_register_routes() {
+	register_rest_route(
+		'{{namespace}}/v1',
+		'/{{slugKebabCase}}/state',
+		array(
+			array(
+				'methods'             => WP_REST_Server::READABLE,
+				'callback'            => '{{phpPrefix}}_handle_get_state',
+				'permission_callback' => '__return_true',
+			),
+			array(
+				'methods'             => WP_REST_Server::CREATABLE,
+				'callback'            => '{{phpPrefix}}_handle_write_state',
+				'permission_callback' => '{{phpPrefix}}_deny_write_without_policy',
+			),
+		)
+	);
+}
+
+function {{phpPrefix}}_register_block() {
+	$build_dir = {{phpPrefix}}_get_build_dir();
+	if ( ! $build_dir ) {
+		return;
+	}
+
+	register_block_type( $build_dir );
+}
+
+register_activation_hook( __FILE__, '{{phpPrefix}}_maybe_install_storage' );
+add_action( 'init', '{{phpPrefix}}_load_textdomain' );
+add_action( 'init', '{{phpPrefix}}_ensure_storage_installed' );
+add_action( 'init', '{{phpPrefix}}_register_block' );
+add_action( 'rest_api_init', '{{phpPrefix}}_register_routes' );

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

@@ -0,0 +1,308 @@
+<?php
+/**
+ * Plugin Name:       {{title}}
+ * Description:       {{description}}
+ * Version:           0.1.0
+ * Requires at least: 6.7
+ * Tested up to:      6.9
+ * Requires PHP:      8.0
+ * Author:            {{author}}
+ * License:           GPL-2.0-or-later
+ * License URI:       https://www.gnu.org/licenses/gpl-2.0.html
+ * Text Domain:       {{textDomain}}
+ * Domain Path:       /languages
+ */
+
+if ( ! defined( 'ABSPATH' ) ) {
+	exit;
+}
+
+function {{phpPrefix}}_load_textdomain() {
+	load_plugin_textdomain(
+		'{{textDomain}}',
+		false,
+		dirname( plugin_basename( __FILE__ ) ) . '/languages'
+	);
+}
+
+define( '{{phpPrefixUpper}}_DATA_STORAGE_MODE', '{{dataStorageMode}}' );
+define( '{{phpPrefixUpper}}_PUBLIC_WRITE_TTL', HOUR_IN_SECONDS );
+define( '{{phpPrefixUpper}}_PUBLIC_WRITE_RATE_LIMIT_WINDOW', MINUTE_IN_SECONDS );
+define( '{{phpPrefixUpper}}_PUBLIC_WRITE_RATE_LIMIT_MAX', 10 );
+// These helper files are scaffold-owned plumbing. Customize them only when you are changing auth or request validation behavior.
+require_once __DIR__ . '/inc/rest-shared.php';
+require_once __DIR__ . '/inc/rest-public.php';
+
+function {{phpPrefix}}_get_build_dir() {
+	$candidates = array(
+		__DIR__ . '/build',
+		__DIR__ . '/build/{{slugKebabCase}}',
+	);
+
+	foreach ( $candidates as $candidate ) {
+		if ( file_exists( $candidate . '/block.json' ) ) {
+			return $candidate;
+		}
+	}
+
+	return null;
+}
+
+function {{phpPrefix}}_get_counter_table_name() {
+	global $wpdb;
+	return $wpdb->prefix . '{{phpPrefix}}_counters';
+}
+
+function {{phpPrefix}}_get_counter_lock_name( $post_id, $resource_key ) {
+	return 'wpt_pcl_' . md5(
+		'{{phpPrefix}}|' . (int) $post_id . '|' . (string) $resource_key
+	);
+}
+
+function {{phpPrefix}}_with_counter_lock( $post_id, $resource_key, $callback ) {
+	global $wpdb;
+
+	$lock_name = {{phpPrefix}}_get_counter_lock_name( $post_id, $resource_key );
+	$acquired  = (int) $wpdb->get_var(
+		$wpdb->prepare(
+			'SELECT GET_LOCK(%s, 5)',
+			$lock_name
+		)
+	);
+
+	if ( 1 !== $acquired ) {
+		return new WP_Error( 'counter_lock_timeout', 'Could not acquire the counter lock.', array( 'status' => 503 ) );
+	}
+
+	try {
+		return $callback();
+	} finally {
+		$wpdb->get_var(
+			$wpdb->prepare(
+				'SELECT RELEASE_LOCK(%s)',
+				$lock_name
+			)
+		);
+	}
+}
+
+function {{phpPrefix}}_maybe_install_storage() {
+	if ( 'custom-table' !== '{{dataStorageMode}}' ) {
+		return;
+	}
+
+	global $wpdb;
+	require_once ABSPATH . 'wp-admin/includes/upgrade.php';
+
+	$table_name      = {{phpPrefix}}_get_counter_table_name();
+	$charset_collate = $wpdb->get_charset_collate();
+	$sql             = "CREATE TABLE {$table_name} (
+		post_id bigint(20) unsigned NOT NULL,
+		resource_key varchar(100) NOT NULL,
+		count bigint(20) unsigned NOT NULL DEFAULT 0,
+		updated_at datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
+		PRIMARY KEY  (post_id, resource_key)
+	) {$charset_collate};";
+
+	dbDelta( $sql );
+	$table_exists = $wpdb->get_var(
+		$wpdb->prepare(
+			'SHOW TABLES LIKE %s',
+			$table_name
+		)
+	);
+
+	if ( $table_name === $table_exists ) {
+		update_option( '{{phpPrefix}}_storage_version', '1.0.0' );
+	}
+}
+
+function {{phpPrefix}}_ensure_storage_installed() {
+	if ( 'custom-table' === '{{dataStorageMode}}' && '1.0.0' !== get_option( '{{phpPrefix}}_storage_version', '' ) ) {
+		{{phpPrefix}}_maybe_install_storage();
+	}
+}
+
+function {{phpPrefix}}_get_rest_build_dir() {
+	return {{phpPrefix}}_get_build_dir();
+}
+
+function {{phpPrefix}}_get_counter( $post_id, $resource_key ) {
+	global $wpdb;
+
+	if ( 'custom-table' === '{{dataStorageMode}}' ) {
+		$table_name = {{phpPrefix}}_get_counter_table_name();
+		$count      = $wpdb->get_var(
+			$wpdb->prepare(
+				// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Table name comes from an internal helper.
+				"SELECT count FROM {$table_name} WHERE post_id = %d AND resource_key = %s",
+				$post_id,
+				$resource_key
+			)
+		);
+
+		return null === $count ? 0 : (int) $count;
+	}
+
+	$meta_key = '_' . '{{phpPrefix}}' . '_counter_' . sanitize_key( $resource_key );
+	return (int) get_post_meta( $post_id, $meta_key, true );
+}
+
+// Customize storage helpers here when you need a different backend or aggregate behavior.
+function {{phpPrefix}}_increment_counter( $post_id, $resource_key, $delta ) {
+	global $wpdb;
+
+	if ( 'custom-table' === '{{dataStorageMode}}' ) {
+		$table_name    = {{phpPrefix}}_get_counter_table_name();
+		$delta_value   = (int) $delta;
+		$initial_count = max( 0, $delta_value );
+		$result        = $wpdb->query(
+			$wpdb->prepare(
+				// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Table name comes from an internal helper.
+				"INSERT INTO {$table_name} (post_id, resource_key, count, updated_at)
+				VALUES (%d, %s, %d, %s)
+				ON DUPLICATE KEY UPDATE
+					count = GREATEST(0, count + %d),
+					updated_at = VALUES(updated_at)",
+				$post_id,
+				$resource_key,
+				$initial_count,
+				current_time( 'mysql', true ),
+				$delta_value
+			)
+		);
+
+		if ( false === $result ) {
+			return new WP_Error( 'counter_update_failed', 'Failed to update the counter.', array( 'status' => 500 ) );
+		}
+
+		return {{phpPrefix}}_get_counter( $post_id, $resource_key );
+	}
+
+	return {{phpPrefix}}_with_counter_lock(
+		$post_id,
+		$resource_key,
+		function () use ( $delta, $post_id, $resource_key ) {
+			$meta_key   = '_' . '{{phpPrefix}}' . '_counter_' . sanitize_key( $resource_key );
+			$next_count = max( 0, {{phpPrefix}}_get_counter( $post_id, $resource_key ) + (int) $delta );
+			update_post_meta( $post_id, $meta_key, $next_count );
+			return $next_count;
+		}
+	);
+}
+
+function {{phpPrefix}}_build_state_response( $post_id, $resource_key, $count ) {
+	return array(
+		'postId'      => (int) $post_id,
+		'resourceKey' => (string) $resource_key,
+		'count'       => (int) $count,
+		'storage'     => '{{dataStorageMode}}',
+	);
+}
+
+// Route handlers are the main product-level extension point for request/response shaping.
+function {{phpPrefix}}_handle_get_state( 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(),
+		'state-query',
+		'query'
+	);
+
+	if ( is_wp_error( $payload ) ) {
+		return $payload;
+	}
+
+	$count = {{phpPrefix}}_get_counter( (int) $payload['postId'], (string) $payload['resourceKey'] );
+	return rest_ensure_response(
+		{{phpPrefix}}_build_state_response(
+			(int) $payload['postId'],
+			(string) $payload['resourceKey'],
+			$count
+		)
+	);
+}
+
+function {{phpPrefix}}_handle_write_state( WP_REST_Request $request ) {
+	$payload = {{phpPrefix}}_validate_and_sanitize_request(
+		$request->get_json_params(),
+		{{phpPrefix}}_get_rest_build_dir(),
+		'write-state-request',
+		'body'
+	);
+
+	if ( is_wp_error( $payload ) ) {
+		return $payload;
+	}
+
+	$request_consumed = {{phpPrefix}}_consume_public_write_request_id(
+		(int) $payload['postId'],
+		(string) $payload['resourceKey'],
+		isset( $payload['publicWriteRequestId'] ) ? (string) $payload['publicWriteRequestId'] : ''
+	);
+
+	if ( is_wp_error( $request_consumed ) ) {
+		return $request_consumed;
+	}
+
+	$count = {{phpPrefix}}_increment_counter(
+		(int) $payload['postId'],
+		(string) $payload['resourceKey'],
+		isset( $payload['delta'] ) ? (int) $payload['delta'] : 1
+	);
+
+	if ( is_wp_error( $count ) ) {
+		{{phpPrefix}}_release_public_write_request_id(
+			(int) $payload['postId'],
+			(string) $payload['resourceKey'],
+			isset( $payload['publicWriteRequestId'] ) ? (string) $payload['publicWriteRequestId'] : ''
+		);
+		return $count;
+	}
+
+	return rest_ensure_response(
+		{{phpPrefix}}_build_state_response(
+			(int) $payload['postId'],
+			(string) $payload['resourceKey'],
+			$count
+		)
+	);
+}
+
+// Add or reorganize endpoints here as the REST surface grows.
+function {{phpPrefix}}_register_routes() {
+	register_rest_route(
+		'{{namespace}}/v1',
+		'/{{slugKebabCase}}/state',
+		array(
+			array(
+				'methods'             => WP_REST_Server::READABLE,
+				'callback'            => '{{phpPrefix}}_handle_get_state',
+				'permission_callback' => '__return_true',
+			),
+			array(
+				'methods'             => WP_REST_Server::CREATABLE,
+				'callback'            => '{{phpPrefix}}_handle_write_state',
+				'permission_callback' => '{{phpPrefix}}_can_write_publicly',
+			),
+		)
+	);
+}
+
+function {{phpPrefix}}_register_block() {
+	$build_dir = {{phpPrefix}}_get_build_dir();
+	if ( ! $build_dir ) {
+		return;
+	}
+
+	register_block_type( $build_dir );
+}
+
+register_activation_hook( __FILE__, '{{phpPrefix}}_maybe_install_storage' );
+add_action( 'init', '{{phpPrefix}}_load_textdomain' );
+add_action( 'init', '{{phpPrefix}}_ensure_storage_installed' );
+add_action( 'init', '{{phpPrefix}}_register_block' );
+add_action( 'rest_api_init', '{{phpPrefix}}_register_routes' );

package/templates/_shared/presets/test-preset/.wp-env.test.json.mustache

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://schemas.wp.org/trunk/wp-env.json",
+  "core": null,
+  "port": 8889,
+  "testsEnvironment": false,
+  "plugins": [
+    "."
+  ],
+  "config": {
+    "WP_DEBUG": true,
+    "WP_DEBUG_LOG": true,
+    "WP_DEBUG_DISPLAY": false,
+    "SCRIPT_DEBUG": true,
+    "WP_ENVIRONMENT_TYPE": "local"
+  }
+}

package/templates/_shared/presets/test-preset/playwright.config.ts.mustache

@@ -0,0 +1,22 @@
+import { defineConfig, devices } from "@playwright/test";
+
+export default defineConfig({
+	testDir: "./tests/e2e",
+	reporter: [["list"], ["html", { outputFolder: "playwright-report" }]],
+	timeout: 30_000,
+	expect: {
+		timeout: 10_000,
+	},
+	use: {
+		baseURL: "http://localhost:8889",
+		screenshot: "only-on-failure",
+		trace: "on-first-retry",
+		video: "retain-on-failure",
+	},
+	projects: [
+		{
+			name: "chromium",
+			use: { ...devices["Desktop Chrome"] },
+		},
+	],
+});