@wp-typia/project-tools 0.16.14 → 0.18.0

package/templates/query-loop/inc/query-runtime.php.mustache

@@ -0,0 +1,85 @@
+<?php
+if ( ! defined( 'ABSPATH' ) ) {
+	exit;
+}
+
+function {{phpPrefix}}_get_query_loop_variation_name() {
+	return '{{namespace}}/{{slug}}';
+}
+
+function {{phpPrefix}}_get_query_loop_variation_marker_key() {
+	return 'wpTypiaVariation';
+}
+
+function {{phpPrefix}}_extract_query_loop_request_query( WP_REST_Request $request ) {
+	$params = $request->get_params();
+
+	if ( isset( $params['query'] ) && is_array( $params['query'] ) ) {
+		return $params['query'];
+	}
+
+	return is_array( $params ) ? $params : array();
+}
+
+function {{phpPrefix}}_map_query_loop_custom_query_vars( array $query_vars, array $source_query ) {
+	unset( $query_vars[ {{phpPrefix}}_get_query_loop_variation_marker_key() ] );
+
+	$allowed_custom_query_values = array(
+		// 'featuredOnly' => isset( $source_query['featuredOnly'] ) ? (bool) $source_query['featuredOnly'] : null,
+		// 'eventStatus' => isset( $source_query['eventStatus'] ) ? sanitize_text_field( $source_query['eventStatus'] ) : null,
+	);
+
+	// Mirror only known custom query keys from `src/query-extension.ts` here when
+	// they should affect frontend rendering or editor preview requests. Sanitize
+	// and cast values before copying them into WP_Query vars; do not merge the
+	// raw source query wholesale.
+	foreach ( $allowed_custom_query_values as $key => $value ) {
+		if ( null === $value ) {
+			continue;
+		}
+
+		$query_vars[ $key ] = $value;
+	}
+
+	return $query_vars;
+}
+
+function {{phpPrefix}}_filter_query_loop_block_query_vars( $query_vars, $block, $page ) {
+	if ( ! is_array( $query_vars ) ) {
+		return $query_vars;
+	}
+
+	$attrs = is_array( $block ) && isset( $block['attrs'] ) && is_array( $block['attrs'] )
+		? $block['attrs']
+		: array();
+	$namespace = isset( $attrs['namespace'] ) && is_string( $attrs['namespace'] )
+		? $attrs['namespace']
+		: null;
+	$source_query = isset( $attrs['query'] ) && is_array( $attrs['query'] )
+		? $attrs['query']
+		: array();
+
+	if ( {{phpPrefix}}_get_query_loop_variation_name() !== $namespace ) {
+		return $query_vars;
+	}
+
+	return {{phpPrefix}}_map_query_loop_custom_query_vars( $query_vars, $source_query );
+}
+
+function {{phpPrefix}}_filter_query_loop_editor_preview_query_vars( $query_vars, $request ) {
+	if ( ! is_array( $query_vars ) || ! $request instanceof WP_REST_Request ) {
+		return $query_vars;
+	}
+
+	$source_query = {{phpPrefix}}_extract_query_loop_request_query( $request );
+	$marker_key = {{phpPrefix}}_get_query_loop_variation_marker_key();
+	$variation_name = isset( $source_query[ $marker_key ] ) && is_string( $source_query[ $marker_key ] )
+		? $source_query[ $marker_key ]
+		: null;
+
+	if ( {{phpPrefix}}_get_query_loop_variation_name() !== $variation_name ) {
+		return $query_vars;
+	}
+
+	return {{phpPrefix}}_map_query_loop_custom_query_vars( $query_vars, $source_query );
+}

package/templates/query-loop/package.json.mustache

@@ -0,0 +1,32 @@
+{
+  "name": "{{slug}}",
+  "version": "0.1.0",
+  "packageManager": "bun@1.3.11",
+  "description": "{{description}}",
+  "author": "{{author}}",
+  "license": "GPL-2.0-or-later",
+  "main": "build/index.js",
+  "scripts": {
+    "build": "wp-scripts build --experimental-modules",
+    "start": "wp-scripts start --experimental-modules",
+    "dev": "wp-scripts start --experimental-modules",
+    "lint:js": "wp-scripts lint-js",
+    "lint": "bun run lint:js",
+    "format": "wp-scripts format",
+    "typecheck": "tsc --noEmit"
+  },
+  "devDependencies": {
+    "@wp-typia/block-types": "{{blockTypesPackageVersion}}",
+    "@types/wordpress__block-editor": "^11.5.17",
+    "@types/wordpress__blocks": "^12.5.18",
+    "@wordpress/browserslist-config": "^6.42.0",
+    "@wordpress/scripts": "^30.22.0",
+    "eslint-plugin-jsx-a11y": "^6.10.2",
+    "prettier": "3.8.2",
+    "typescript": "^5.9.2"
+  },
+  "dependencies": {
+    "@wordpress/blocks": "^15.2.0",
+    "@wordpress/i18n": "^6.2.0"
+  }
+}

package/templates/query-loop/src/patterns/grid.php.mustache

@@ -0,0 +1,49 @@
+<?php
+if ( ! defined( 'ABSPATH' ) ) {
+	exit;
+}
+
+$content = sprintf(
+	<<<'HTML'
+<!-- wp:query {"namespace":"{{namespace}}/{{slug}}","query":{"inherit":false,"postType":"{{queryPostType}}","perPage":6,"order":"desc","orderBy":"date","wpTypiaVariation":"{{namespace}}/{{slug}}"},"displayLayout":{"type":"grid","columns":3}} -->
+<div class="wp-block-query">
+	<!-- wp:post-template -->
+	<!-- wp:group {"style":{"spacing":{"blockGap":"0.75rem","padding":{"top":"1rem","right":"1rem","bottom":"1rem","left":"1rem"}}},"layout":{"type":"constrained"}} -->
+	<div class="wp-block-group" style="padding-top:1rem;padding-right:1rem;padding-bottom:1rem;padding-left:1rem">
+		<!-- wp:post-featured-image /-->
+		<!-- wp:post-title {"isLink":true} /-->
+		<!-- wp:post-excerpt /-->
+	</div>
+	<!-- /wp:group -->
+	<!-- /wp:post-template -->
+
+	<!-- wp:query-pagination -->
+	<!-- wp:query-pagination-previous /-->
+	<!-- wp:query-pagination-numbers /-->
+	<!-- wp:query-pagination-next /-->
+	<!-- /wp:query-pagination -->
+
+	<!-- wp:query-no-results -->
+	<!-- wp:paragraph -->
+	<p>%s</p>
+	<!-- /wp:paragraph -->
+	<!-- /wp:query-no-results -->
+</div>
+<!-- /wp:query -->
+HTML,
+	esc_html__( 'No items matched this preset yet.', '{{textDomain}}' )
+);
+
+register_block_pattern(
+	'{{namespace}}/{{slug}}-grid',
+	array(
+		'title'         => __( '{{title}} Grid', '{{textDomain}}' ),
+		'description'   => __( 'A connected grid layout preset for the {{title}} Query Loop variation.', '{{textDomain}}' ),
+		'categories'    => array( '{{slug}}-query-loop' ),
+		'blockTypes'    => array( 'core/query' ),
+		'postTypes'     => array( '{{queryPostType}}' ),
+		'inserter'      => true,
+		'viewportWidth' => 1280,
+		'content'       => $content,
+	)
+);

package/templates/query-loop/src/patterns/list.php.mustache

@@ -0,0 +1,48 @@
+<?php
+if ( ! defined( 'ABSPATH' ) ) {
+	exit;
+}
+
+$content = sprintf(
+	<<<'HTML'
+<!-- wp:query {"namespace":"{{namespace}}/{{slug}}","query":{"inherit":false,"postType":"{{queryPostType}}","perPage":4,"order":"desc","orderBy":"date","wpTypiaVariation":"{{namespace}}/{{slug}}"}} -->
+<div class="wp-block-query">
+	<!-- wp:post-template -->
+	<!-- wp:group {"style":{"spacing":{"blockGap":"1rem","padding":{"top":"1.25rem","bottom":"1.25rem"}}},"layout":{"type":"constrained"}} -->
+	<div class="wp-block-group" style="padding-top:1.25rem;padding-bottom:1.25rem">
+		<!-- wp:post-title {"isLink":true} /-->
+		<!-- wp:post-date /-->
+		<!-- wp:post-excerpt {"moreText":"Continue reading"} /-->
+	</div>
+	<!-- /wp:group -->
+	<!-- /wp:post-template -->
+
+	<!-- wp:query-pagination -->
+	<!-- wp:query-pagination-previous /-->
+	<!-- wp:query-pagination-next /-->
+	<!-- /wp:query-pagination -->
+
+	<!-- wp:query-no-results -->
+	<!-- wp:paragraph -->
+	<p>%s</p>
+	<!-- /wp:paragraph -->
+	<!-- /wp:query-no-results -->
+</div>
+<!-- /wp:query -->
+HTML,
+	esc_html__( 'No items matched this preset yet.', '{{textDomain}}' )
+);
+
+register_block_pattern(
+	'{{namespace}}/{{slug}}-list',
+	array(
+		'title'         => __( '{{title}} List', '{{textDomain}}' ),
+		'description'   => __( 'A connected list layout preset for the {{title}} Query Loop variation.', '{{textDomain}}' ),
+		'categories'    => array( '{{slug}}-query-loop' ),
+		'blockTypes'    => array( 'core/query' ),
+		'postTypes'     => array( '{{queryPostType}}' ),
+		'inserter'      => true,
+		'viewportWidth' => 1280,
+		'content'       => $content,
+	)
+);

package/templates/query-loop/src/query-extension.ts.mustache

@@ -0,0 +1,41 @@
+export type QueryLoopEditorExtensionContext = {
+  variationName: string;
+};
+
+export type QueryLoopCustomQuerySeed = Record<string, unknown>;
+
+/**
+ * Extend the generated Query Loop variation with variation-specific query params.
+ *
+ * Add custom keys here only when the variation should always seed them. Runtime
+ * parity hooks in `inc/query-runtime.php` can read the same keys later from the
+ * Query Loop `query` object.
+ */
+export function getQueryLoopCustomQuerySeed(): QueryLoopCustomQuerySeed {
+  return {};
+}
+
+/**
+ * Add extra inspector controls by key when your custom query seed needs them.
+ *
+ * Keep the generated defaults in `src/index.ts` and return only the additional
+ * control ids that your variation-specific query params rely on.
+ */
+export function getQueryLoopCustomAllowedControls(): string[] {
+  return [];
+}
+
+/**
+ * Register optional editor-only extension hooks for custom Query Loop params.
+ *
+ * This stays a no-op by default. When you need custom inspector UI, add your
+ * `editor.BlockEdit` filters or other editor hooks here so `src/index.ts` can
+ * keep variation registration focused on identity and default query values. If
+ * those hooks introduce frontend-affecting query params, mirror them in
+ * `inc/query-runtime.php` so editor preview and frontend rendering stay aligned.
+ */
+export function registerQueryLoopEditorExtensions(
+  _context: QueryLoopEditorExtensionContext,
+): void {
+  // Add optional editor hooks here when this variation introduces custom query UI.
+}

package/templates/query-loop/webpack.config.js.mustache

@@ -0,0 +1,16 @@
+const path = require("node:path");
+const defaultConfig = require("@wordpress/scripts/config/webpack.config");
+
+const queryLoopEntry = {
+	index: path.resolve(process.cwd(), "src/index.ts"),
+};
+
+module.exports = Array.isArray(defaultConfig)
+	? defaultConfig.map((config) => ({
+			...config,
+			entry: config?.output?.module ? config.entry : queryLoopEntry,
+		}))
+	: {
+			...defaultConfig,
+			entry: queryLoopEntry,
+		};

package/templates/query-loop/{{slugKebabCase}}.php.mustache

@@ -0,0 +1,84 @@
+<?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;
+}
+
+require_once __DIR__ . '/inc/query-runtime.php';
+
+function {{phpPrefix}}_load_textdomain() {
+	load_plugin_textdomain(
+		'{{textDomain}}',
+		false,
+		dirname( plugin_basename( __FILE__ ) ) . '/languages'
+	);
+}
+
+function {{phpPrefix}}_register_query_loop_pattern_category() {
+	if ( ! function_exists( 'register_block_pattern_category' ) ) {
+		return;
+	}
+
+	register_block_pattern_category(
+		'{{slug}}-query-loop',
+		array(
+			'label' => __( '{{title}} Query Loop', '{{textDomain}}' ),
+		)
+	);
+}
+
+function {{phpPrefix}}_register_query_loop_patterns() {
+	if ( ! function_exists( 'register_block_pattern' ) ) {
+		return;
+	}
+
+	foreach ( glob( __DIR__ . '/src/patterns/*.php' ) ?: array() as $pattern_module ) {
+		require $pattern_module;
+	}
+}
+
+function {{phpPrefix}}_register_query_loop_variation_script() {
+	$script_path      = __DIR__ . '/build/index.js';
+	$script_asset_path = __DIR__ . '/build/index.asset.php';
+
+	if ( ! file_exists( $script_path ) || ! file_exists( $script_asset_path ) ) {
+		return;
+	}
+
+	$asset = require $script_asset_path;
+	$handle = '{{phpPrefix}}_query_loop_variation';
+
+	wp_register_script(
+		$handle,
+		plugins_url( 'build/index.js', __FILE__ ),
+		is_array( $asset ) && isset( $asset['dependencies'] ) ? $asset['dependencies'] : array(),
+		is_array( $asset ) && isset( $asset['version'] ) ? $asset['version'] : filemtime( $script_path ),
+		true
+	);
+	wp_set_script_translations( $handle, '{{textDomain}}', __DIR__ . '/languages' );
+}
+
+function {{phpPrefix}}_enqueue_query_loop_variation_script() {
+	{{phpPrefix}}_register_query_loop_variation_script();
+	wp_enqueue_script( '{{phpPrefix}}_query_loop_variation' );
+}
+
+add_action( 'init', '{{phpPrefix}}_load_textdomain' );
+add_action( 'init', '{{phpPrefix}}_register_query_loop_pattern_category' );
+add_action( 'init', '{{phpPrefix}}_register_query_loop_patterns', 20 );
+add_action( 'enqueue_block_editor_assets', '{{phpPrefix}}_enqueue_query_loop_variation_script' );
+add_filter( 'query_loop_block_query_vars', '{{phpPrefix}}_filter_query_loop_block_query_vars', 10, 3 );
+add_filter( 'rest_{{queryPostType}}_query', '{{phpPrefix}}_filter_query_loop_editor_preview_query_vars', 10, 2 );