@wp-typia/project-tools 0.24.4 → 0.24.5

package/dist/runtime/add/cli-add-workspace-rest-php-templates.js

@@ -0,0 +1,359 @@
+import { quotePhpString } from "../shared/php-utils.js";
+import { toTitleCase } from "../shared/string-case.js";
+import { buildRestResourceControllerBootstrapSource, buildRestResourceControllerClassSource, buildRestResourceRouteRegistrations, } from "./cli-add-workspace-rest-resource-php-routing-template.js";
+export { buildWorkspaceRestSchemaHelperPhpSource, } from "./cli-add-workspace-rest-schema-helper-php-template.js";
+/**
+ * Build the PHP route/controller glue for generated workspace REST resources.
+ *
+ * @param restResourceSlug Normalized REST resource slug.
+ * @param namespace WordPress REST namespace, such as `vendor/v1`.
+ * @param phpPrefix Plugin PHP function prefix.
+ * @param methods REST operations to expose.
+ * @param options Optional generated route and controller customizations.
+ * @returns A complete PHP source file for the generated REST resource.
+ */
+export function buildRestResourcePhpSource(restResourceSlug, namespace, phpPrefix, methods, options) {
+    const restResourceTitle = toTitleCase(restResourceSlug);
+    const restResourcePhpId = restResourceSlug.replace(/-/g, "_");
+    const canWriteFunctionName = `${phpPrefix}_${restResourcePhpId}_can_manage_rest_resource`;
+    const getItemsFunctionName = `${phpPrefix}_${restResourcePhpId}_get_rest_resource_items`;
+    const validatePayloadFunctionName = `${phpPrefix}_${restResourcePhpId}_validate_rest_resource_payload`;
+    const normalizeItemFunctionName = `${phpPrefix}_${restResourcePhpId}_normalize_rest_resource_item`;
+    const saveItemsFunctionName = `${phpPrefix}_${restResourcePhpId}_save_rest_resource_items`;
+    const getOptionNameFunctionName = `${phpPrefix}_${restResourcePhpId}_get_rest_resource_option_name`;
+    const listHandlerName = `${phpPrefix}_${restResourcePhpId}_handle_list_rest_resource`;
+    const readHandlerName = `${phpPrefix}_${restResourcePhpId}_handle_read_rest_resource`;
+    const createHandlerName = `${phpPrefix}_${restResourcePhpId}_handle_create_rest_resource`;
+    const updateHandlerName = `${phpPrefix}_${restResourcePhpId}_handle_update_rest_resource`;
+    const deleteHandlerName = `${phpPrefix}_${restResourcePhpId}_handle_delete_rest_resource`;
+    const registerRoutesFunctionName = `${phpPrefix}_${restResourcePhpId}_register_rest_routes`;
+    const controllerVariableName = options.controllerClass ? "$controller" : undefined;
+    const routeRegistrations = buildRestResourceRouteRegistrations(restResourceSlug, methods, {
+        canWriteFunctionName,
+        createHandlerName,
+        deleteHandlerName,
+        listHandlerName,
+        readHandlerName,
+        updateHandlerName,
+    }, {
+        ...(controllerVariableName ? { controllerVariableName } : {}),
+        ...(options.permissionCallback
+            ? { permissionCallback: options.permissionCallback }
+            : {}),
+        routePattern: options.routePattern,
+    });
+    const controllerClassSource = options.controllerClass
+        ? buildRestResourceControllerClassSource({
+            controllerClass: options.controllerClass,
+            ...(options.controllerExtends
+                ? { controllerExtends: options.controllerExtends }
+                : {}),
+            functions: {
+                canWriteFunctionName,
+                createHandlerName,
+                deleteHandlerName,
+                listHandlerName,
+                readHandlerName,
+                updateHandlerName,
+            },
+        })
+        : "";
+    const controllerBootstrapSource = buildRestResourceControllerBootstrapSource(options.controllerClass);
+    return `<?php
+if ( ! defined( 'ABSPATH' ) ) {
+\treturn;
+}
+
+if ( ! function_exists( '${getOptionNameFunctionName}' ) ) {
+\tfunction ${getOptionNameFunctionName}() {
+\t\treturn ${quotePhpString(`${phpPrefix}_${restResourcePhpId}_rest_resource_items`)};
+\t}
+}
+
+if ( ! function_exists( '${normalizeItemFunctionName}' ) ) {
+\tfunction ${normalizeItemFunctionName}( array $item ) {
+\t\treturn array(
+\t\t\t'id'        => isset( $item['id'] ) ? (int) $item['id'] : 0,
+\t\t\t'title'     => isset( $item['title'] ) ? (string) $item['title'] : '',
+\t\t\t'content'   => isset( $item['content'] ) ? (string) $item['content'] : '',
+\t\t\t'status'    => isset( $item['status'] ) && 'published' === $item['status'] ? 'published' : 'draft',
+\t\t\t'updatedAt' => isset( $item['updatedAt'] ) ? (string) $item['updatedAt'] : gmdate( 'c' ),
+\t\t);
+\t}
+}
+
+if ( ! function_exists( '${getItemsFunctionName}' ) ) {
+\tfunction ${getItemsFunctionName}() {
+\t\t$seed_items = array(
+\t\t\tarray(
+\t\t\t\t'id'        => 1,
+\t\t\t\t'title'     => ${quotePhpString(`${restResourceTitle} Starter`)},
+\t\t\t\t'content'   => ${quotePhpString(`Replace this seeded ${restResourceTitle.toLowerCase()} content with your plugin data source.`)},
+\t\t\t\t'status'    => 'draft',
+\t\t\t\t'updatedAt' => '2026-01-01T00:00:00Z',
+\t\t\t),
+\t\t);
+\t\t$items = get_option( ${getOptionNameFunctionName}(), $seed_items );
+
+\t\tif ( ! is_array( $items ) ) {
+\t\t\t$items = $seed_items;
+\t\t}
+
+\t\treturn array_values(
+\t\t\tarray_map(
+\t\t\t\t'${normalizeItemFunctionName}',
+\t\t\t\tarray_filter(
+\t\t\t\t\t$items,
+\t\t\t\t\t'is_array'
+\t\t\t\t)
+\t\t\t)
+\t\t);
+\t}
+}
+
+if ( ! function_exists( '${saveItemsFunctionName}' ) ) {
+\tfunction ${saveItemsFunctionName}( array $items ) {
+\t\tupdate_option(
+\t\t\t${getOptionNameFunctionName}(),
+\t\t\tarray_values(
+\t\t\t\tarray_map(
+\t\t\t\t\t'${normalizeItemFunctionName}',
+\t\t\t\t\t$items
+\t\t\t\t)
+\t\t\t),
+\t\t\tfalse
+\t\t);
+\t}
+}
+
+if ( ! function_exists( '${validatePayloadFunctionName}' ) ) {
+\tfunction ${validatePayloadFunctionName}( $value, $schema_name, $param_name ) {
+\t\tif ( ! function_exists( '${phpPrefix}_validate_and_sanitize_rest_payload' ) ) {
+\t\t\treturn new WP_Error(
+\t\t\t\t'missing_rest_schema_helper',
+\t\t\t\t'Missing REST schema helper. Ensure inc/rest-schema.php is loaded before REST resources.',
+\t\t\t\tarray( 'status' => 500 )
+\t\t\t);
+\t\t}
+
+\t\treturn ${phpPrefix}_validate_and_sanitize_rest_payload(
+\t\t\t$value,
+\t\t\t$schema_name,
+\t\t\t$param_name,
+\t\t\tarray( 'resource' => ${quotePhpString(restResourceSlug)} )
+\t\t);
+\t}
+}
+
+if ( ! function_exists( '${canWriteFunctionName}' ) ) {
+\tfunction ${canWriteFunctionName}() {
+\t\treturn current_user_can( 'edit_posts' );
+\t}
+}
+
+if ( ! function_exists( '${listHandlerName}' ) ) {
+\tfunction ${listHandlerName}( WP_REST_Request $request ) {
+\t\t$payload_input = array();
+\t\t$page          = $request->get_param( 'page' );
+\t\t$per_page      = $request->get_param( 'perPage' );
+\t\t$search        = $request->get_param( 'search' );
+
+\t\tif ( null !== $page ) {
+\t\t\t$payload_input['page'] = $page;
+\t\t}
+\t\tif ( null !== $per_page ) {
+\t\t\t$payload_input['perPage'] = $per_page;
+\t\t}
+\t\tif ( null !== $search ) {
+\t\t\t$payload_input['search'] = $search;
+\t\t}
+
+\t\t$payload = ${validatePayloadFunctionName}(
+\t\t\t$payload_input,
+\t\t\t'list-query',
+\t\t\t'query'
+\t\t);
+
+\t\tif ( is_wp_error( $payload ) ) {
+\t\t\treturn $payload;
+\t\t}
+
+\t\t$page     = isset( $payload['page'] ) ? max( 1, (int) $payload['page'] ) : 1;
+\t\t$per_page = isset( $payload['perPage'] ) ? min( 50, max( 1, (int) $payload['perPage'] ) ) : 10;
+\t\t$search   = isset( $payload['search'] ) ? strtolower( (string) $payload['search'] ) : '';
+\t\t$items    = ${getItemsFunctionName}();
+
+\t\tif ( '' !== $search ) {
+\t\t\t$items = array_values(
+\t\t\t\tarray_filter(
+\t\t\t\t\t$items,
+\t\t\t\t\tstatic function ( $item ) use ( $search ) {
+\t\t\t\t\t\treturn false !== strpos( strtolower( (string) ( $item['title'] ?? '' ) ), $search ) ||
+\t\t\t\t\t\t\tfalse !== strpos( strtolower( (string) ( $item['content'] ?? '' ) ), $search );
+\t\t\t\t\t}
+\t\t\t\t)
+\t\t\t);
+\t\t}
+
+\t\t$total = count( $items );
+\t\t$items = array_slice( $items, ( $page - 1 ) * $per_page, $per_page );
+
+\t\treturn rest_ensure_response(
+\t\t\tarray(
+\t\t\t\t'items'   => $items,
+\t\t\t\t'page'    => $page,
+\t\t\t\t'perPage' => $per_page,
+\t\t\t\t'total'   => $total,
+\t\t\t)
+\t\t);
+\t}
+}
+
+if ( ! function_exists( '${readHandlerName}' ) ) {
+\tfunction ${readHandlerName}( WP_REST_Request $request ) {
+\t\t$payload = ${validatePayloadFunctionName}(
+\t\t\tarray(
+\t\t\t\t'id' => $request->get_param( 'id' ),
+\t\t\t),
+\t\t\t'read-query',
+\t\t\t'query'
+\t\t);
+
+\t\tif ( is_wp_error( $payload ) ) {
+\t\t\treturn $payload;
+\t\t}
+
+\t\tforeach ( ${getItemsFunctionName}() as $item ) {
+\t\t\tif ( (int) $item['id'] === (int) $payload['id'] ) {
+\t\t\t\treturn rest_ensure_response( $item );
+\t\t\t}
+\t\t}
+
+\t\treturn new WP_Error( 'rest_not_found', 'Resource not found.', array( 'status' => 404 ) );
+\t}
+}
+
+if ( ! function_exists( '${createHandlerName}' ) ) {
+\tfunction ${createHandlerName}( WP_REST_Request $request ) {
+\t\t$payload = ${validatePayloadFunctionName}( $request->get_json_params(), 'create-request', 'body' );
+\t\tif ( is_wp_error( $payload ) ) {
+\t\t\treturn $payload;
+\t\t}
+
+\t\t$items   = ${getItemsFunctionName}();
+\t\t$next_id = 1;
+\t\tforeach ( $items as $item ) {
+\t\t\t$next_id = max( $next_id, (int) $item['id'] + 1 );
+\t\t}
+
+\t\t$record = ${normalizeItemFunctionName}(
+\t\t\tarray(
+\t\t\t\t'id'        => $next_id,
+\t\t\t\t'title'     => (string) $payload['title'],
+\t\t\t\t'content'   => isset( $payload['content'] ) ? (string) $payload['content'] : '',
+\t\t\t\t'status'    => isset( $payload['status'] ) ? (string) $payload['status'] : 'draft',
+\t\t\t\t'updatedAt' => gmdate( 'c' ),
+\t\t\t)
+\t\t);
+
+\t\t$items[] = $record;
+\t\t${saveItemsFunctionName}( $items );
+
+\t\treturn rest_ensure_response( $record );
+\t}
+}
+
+if ( ! function_exists( '${updateHandlerName}' ) ) {
+\tfunction ${updateHandlerName}( WP_REST_Request $request ) {
+\t\t$query = ${validatePayloadFunctionName}(
+\t\t\tarray(
+\t\t\t\t'id' => $request->get_param( 'id' ),
+\t\t\t),
+\t\t\t'update-query',
+\t\t\t'query'
+\t\t);
+\t\tif ( is_wp_error( $query ) ) {
+\t\t\treturn $query;
+\t\t}
+
+\t\t$payload = ${validatePayloadFunctionName}( $request->get_json_params(), 'update-request', 'body' );
+\t\tif ( is_wp_error( $payload ) ) {
+\t\t\treturn $payload;
+\t\t}
+
+\t\t$items = ${getItemsFunctionName}();
+\t\tforeach ( $items as $index => $item ) {
+\t\t\tif ( (int) $item['id'] !== (int) $query['id'] ) {
+\t\t\t\tcontinue;
+\t\t\t}
+
+\t\t\t$items[ $index ] = ${normalizeItemFunctionName}(
+\t\t\t\tarray(
+\t\t\t\t\t'id'        => $item['id'],
+\t\t\t\t\t'title'     => isset( $payload['title'] ) ? (string) $payload['title'] : (string) $item['title'],
+\t\t\t\t\t'content'   => array_key_exists( 'content', $payload ) ? (string) $payload['content'] : (string) $item['content'],
+\t\t\t\t\t'status'    => isset( $payload['status'] ) ? (string) $payload['status'] : (string) $item['status'],
+\t\t\t\t\t'updatedAt' => gmdate( 'c' ),
+\t\t\t\t)
+\t\t\t);
+
+\t\t\t${saveItemsFunctionName}( $items );
+\t\t\treturn rest_ensure_response( $items[ $index ] );
+\t\t}
+
+\t\treturn new WP_Error( 'rest_not_found', 'Resource not found.', array( 'status' => 404 ) );
+\t}
+}
+
+if ( ! function_exists( '${deleteHandlerName}' ) ) {
+\tfunction ${deleteHandlerName}( WP_REST_Request $request ) {
+\t\t$query = ${validatePayloadFunctionName}(
+\t\t\tarray(
+\t\t\t\t'id' => $request->get_param( 'id' ),
+\t\t\t),
+\t\t\t'delete-query',
+\t\t\t'query'
+\t\t);
+\t\tif ( is_wp_error( $query ) ) {
+\t\t\treturn $query;
+\t\t}
+
+\t\t$items       = ${getItemsFunctionName}();
+\t\t$filtered    = array_values(
+\t\t\tarray_filter(
+\t\t\t\t$items,
+\t\t\t\tstatic function ( $item ) use ( $query ) {
+\t\t\t\t\treturn (int) $item['id'] !== (int) $query['id'];
+\t\t\t\t}
+\t\t\t)
+\t\t);
+\t\t$was_deleted = count( $filtered ) !== count( $items );
+
+\t\tif ( ! $was_deleted ) {
+\t\t\treturn new WP_Error( 'rest_not_found', 'Resource not found.', array( 'status' => 404 ) );
+\t\t}
+
+\t\t${saveItemsFunctionName}( $filtered );
+
+\t\treturn rest_ensure_response(
+\t\t\tarray(
+\t\t\t\t'deleted' => true,
+\t\t\t\t'id'      => (int) $query['id'],
+\t\t\t)
+\t\t);
+\t}
+}
+
+${controllerClassSource}
+if ( ! function_exists( '${registerRoutesFunctionName}' ) ) {
+\tfunction ${registerRoutesFunctionName}() {
+\t\t$namespace = ${quotePhpString(namespace)};
+
+${controllerBootstrapSource}
+${routeRegistrations}
+\t}
+}
+
+add_action( 'rest_api_init', '${registerRoutesFunctionName}' );
+`;
+}

package/dist/runtime/add/cli-add-workspace-rest-resource-php-routing-template.d.ts

@@ -0,0 +1,33 @@
+import { type RestResourceMethodId } from "./cli-add-shared.js";
+export interface RestResourcePhpFunctionNames {
+    canWriteFunctionName: string;
+    createHandlerName: string;
+    deleteHandlerName: string;
+    listHandlerName: string;
+    readHandlerName: string;
+    updateHandlerName: string;
+}
+/**
+ * Build the `register_rest_route` calls for generated REST resource PHP files.
+ */
+export declare function buildRestResourceRouteRegistrations(restResourceSlug: string, methods: RestResourceMethodId[], functions: RestResourcePhpFunctionNames, options: {
+    controllerVariableName?: string;
+    permissionCallback?: string;
+    routePattern: string;
+}): string;
+/**
+ * Normalize a configured PHP class name into a global `::class` reference.
+ */
+export declare function toPhpClassConstantReference(classReference: string): string;
+/**
+ * Build an optional controller shim class for generated REST resource handlers.
+ */
+export declare function buildRestResourceControllerClassSource(options: {
+    controllerClass: string;
+    controllerExtends?: string;
+    functions: RestResourcePhpFunctionNames;
+}): string;
+/**
+ * Build the controller instantiation block used inside REST route registration.
+ */
+export declare function buildRestResourceControllerBootstrapSource(controllerClass: string | undefined): string;

package/dist/runtime/add/cli-add-workspace-rest-resource-php-routing-template.js

@@ -0,0 +1,145 @@
+import { quotePhpString } from "../shared/php-utils.js";
+/**
+ * Build the `register_rest_route` calls for generated REST resource PHP files.
+ */
+export function buildRestResourceRouteRegistrations(restResourceSlug, methods, functions, options) {
+    const collectionRoutes = [];
+    const itemRoutes = [];
+    const readPermissionCallback = options.permissionCallback
+        ? quotePhpString(options.permissionCallback)
+        : quotePhpString("__return_true");
+    const writePermissionCallback = options.permissionCallback
+        ? quotePhpString(options.permissionCallback)
+        : options.controllerVariableName
+            ? `array( ${options.controllerVariableName}, 'can_manage_rest_resource' )`
+            : quotePhpString(functions.canWriteFunctionName);
+    const buildRouteCallback = (functionName, methodName) => options.controllerVariableName
+        ? `array( ${options.controllerVariableName}, '${methodName}' )`
+        : quotePhpString(functionName);
+    if (methods.includes("list")) {
+        collectionRoutes.push(`\t\tarray(
+\t\t\t'methods'             => WP_REST_Server::READABLE,
+\t\t\t'callback'            => ${buildRouteCallback(functions.listHandlerName, "list_items")},
+\t\t\t'permission_callback' => ${readPermissionCallback},
+\t\t)`);
+    }
+    if (methods.includes("create")) {
+        collectionRoutes.push(`\t\tarray(
+\t\t\t'methods'             => WP_REST_Server::CREATABLE,
+\t\t\t'callback'            => ${buildRouteCallback(functions.createHandlerName, "create_item")},
+\t\t\t'permission_callback' => ${writePermissionCallback},
+\t\t)`);
+    }
+    if (methods.includes("read")) {
+        itemRoutes.push(`\t\tarray(
+\t\t\t'methods'             => WP_REST_Server::READABLE,
+\t\t\t'callback'            => ${buildRouteCallback(functions.readHandlerName, "read_item")},
+\t\t\t'permission_callback' => ${readPermissionCallback},
+\t\t)`);
+    }
+    if (methods.includes("update")) {
+        itemRoutes.push(`\t\tarray(
+\t\t\t'methods'             => WP_REST_Server::EDITABLE,
+\t\t\t'callback'            => ${buildRouteCallback(functions.updateHandlerName, "update_item")},
+\t\t\t'permission_callback' => ${writePermissionCallback},
+\t\t)`);
+    }
+    if (methods.includes("delete")) {
+        itemRoutes.push(`\t\tarray(
+\t\t\t'methods'             => WP_REST_Server::DELETABLE,
+\t\t\t'callback'            => ${buildRouteCallback(functions.deleteHandlerName, "delete_item")},
+\t\t\t'permission_callback' => ${writePermissionCallback},
+\t\t)`);
+    }
+    const registrations = [];
+    if (collectionRoutes.length > 0) {
+        registrations.push(`\tregister_rest_route(
+\t\t$namespace,
+\t\t'/${restResourceSlug}',
+\t\tarray(
+${collectionRoutes.join(",\n")}
+\t\t)
+\t);`);
+    }
+    if (itemRoutes.length > 0) {
+        registrations.push(`\tregister_rest_route(
+\t\t$namespace,
+\t\t${quotePhpString(options.routePattern)},
+\t\tarray(
+${itemRoutes.join(",\n")}
+\t\t)
+\t);`);
+    }
+    return registrations.join("\n\n");
+}
+function normalizeGlobalPhpClassName(classReference) {
+    const normalized = classReference.startsWith("\\")
+        ? classReference.slice(1)
+        : classReference;
+    return /^[A-Za-z_][A-Za-z0-9_]*$/u.test(normalized) ? normalized : undefined;
+}
+/**
+ * Normalize a configured PHP class name into a global `::class` reference.
+ */
+export function toPhpClassConstantReference(classReference) {
+    const normalized = classReference.startsWith("\\")
+        ? classReference
+        : `\\${classReference}`;
+    return `${normalized}::class`;
+}
+/**
+ * Build an optional controller shim class for generated REST resource handlers.
+ */
+export function buildRestResourceControllerClassSource(options) {
+    const controllerClassName = normalizeGlobalPhpClassName(options.controllerClass);
+    if (!controllerClassName) {
+        return "";
+    }
+    const extendsClause = options.controllerExtends
+        ? ` extends ${options.controllerExtends.startsWith("\\") ? options.controllerExtends : `\\${options.controllerExtends}`}`
+        : "";
+    return `
+if ( ! class_exists( ${quotePhpString(controllerClassName)} ) ) {
+\tclass ${controllerClassName}${extendsClause} {
+\t\tpublic function can_manage_rest_resource() {
+\t\t\treturn ${options.functions.canWriteFunctionName}();
+\t\t}
+
+\t\tpublic function list_items( WP_REST_Request $request ) {
+\t\t\treturn ${options.functions.listHandlerName}( $request );
+\t\t}
+
+\t\tpublic function read_item( WP_REST_Request $request ) {
+\t\t\treturn ${options.functions.readHandlerName}( $request );
+\t\t}
+
+\t\tpublic function create_item( WP_REST_Request $request ) {
+\t\t\treturn ${options.functions.createHandlerName}( $request );
+\t\t}
+
+\t\tpublic function update_item( WP_REST_Request $request ) {
+\t\t\treturn ${options.functions.updateHandlerName}( $request );
+\t\t}
+
+\t\tpublic function delete_item( WP_REST_Request $request ) {
+\t\t\treturn ${options.functions.deleteHandlerName}( $request );
+\t\t}
+\t}
+}
+`;
+}
+/**
+ * Build the controller instantiation block used inside REST route registration.
+ */
+export function buildRestResourceControllerBootstrapSource(controllerClass) {
+    if (!controllerClass) {
+        return "";
+    }
+    return `\t\t$controller_class = ${toPhpClassConstantReference(controllerClass)};
+\t\tif ( ! class_exists( $controller_class ) ) {
+\t\t\treturn;
+\t\t}
+\t\t$controller = new $controller_class();
+
+`;
+}

package/dist/runtime/add/cli-add-workspace-rest-resource-sync-anchors.d.ts

@@ -0,0 +1,9 @@
+import type { WorkspaceProject } from "../workspace/workspace-project.js";
+/**
+ * Ensure sync-rest can repair and validate plugin-level REST resources.
+ *
+ * @param workspace Workspace project whose sync-rest script should be patched.
+ * @returns A promise that resolves after the sync-rest script is updated.
+ * @throws When the generated sync-rest anchors cannot be found.
+ */
+export declare function ensureRestResourceSyncScriptAnchors(workspace: WorkspaceProject): Promise<void>;