Phase 2: Schema-Based Form System
- Add ModuleSettingsController with GET/POST/schema endpoints
- Create SchemaField component supporting 8 field types (text, textarea, email, url, number, toggle, checkbox, select)
- Create SchemaForm component for automatic form generation from schema
- Add ModuleSettings page with dynamic routing (/settings/modules/:moduleId)
- Add useModuleSettings React hook for settings management
- Implement NewsletterSettings as example with 8 configurable fields
- Add has_settings flag to module registry
- Settings stored as woonoow_module_{module_id}_settings
Phase 3: Advanced Features
- Create windowAPI.ts exposing React, hooks, components, icons, utils to addons via window.WooNooW
- Add DynamicComponentLoader for loading external React components
- Create TypeScript definitions (woonoow-addon.d.ts) for addon developers
- Initialize Window API in App.tsx on mount
- Enable custom React components for addon settings pages
Phase 4: Production Polish & Example
- Create complete Biteship addon example demonstrating both approaches:
* Schema-based settings (no build required)
* Custom React component (with build)
- Add comprehensive README with installation and testing guide
- Include package.json with esbuild configuration
- Demonstrate window.WooNooW API usage in custom component
Bug Fixes:
- Fix footer newsletter form visibility (remove redundant module check)
- Fix footer contact_data and social_links not saving (parameter name mismatch: snake_case vs camelCase)
- Fix useModules hook returning undefined (remove .data wrapper, add fallback)
- Add optional chaining to footer settings rendering
- Fix TypeScript errors in woonoow-addon.d.ts (use any for external types)
Files Added (15):
- includes/Api/ModuleSettingsController.php
- includes/Modules/NewsletterSettings.php
- admin-spa/src/components/forms/SchemaField.tsx
- admin-spa/src/components/forms/SchemaForm.tsx
- admin-spa/src/routes/Settings/ModuleSettings.tsx
- admin-spa/src/hooks/useModuleSettings.ts
- admin-spa/src/lib/windowAPI.ts
- admin-spa/src/components/DynamicComponentLoader.tsx
- types/woonoow-addon.d.ts
- examples/biteship-addon/biteship-addon.php
- examples/biteship-addon/src/Settings.jsx
- examples/biteship-addon/package.json
- examples/biteship-addon/README.md
- PHASE_2_3_4_SUMMARY.md
Files Modified (11):
- admin-spa/src/App.tsx
- admin-spa/src/hooks/useModules.ts
- admin-spa/src/routes/Appearance/Footer.tsx
- admin-spa/src/routes/Settings/Modules.tsx
- customer-spa/src/hooks/useModules.ts
- customer-spa/src/layouts/BaseLayout.tsx
- customer-spa/src/components/NewsletterForm.tsx
- includes/Api/Routes.php
- includes/Api/ModulesController.php
- includes/Core/ModuleRegistry.php
- woonoow.php
API Endpoints Added:
- GET /woonoow/v1/modules/{module_id}/settings
- POST /woonoow/v1/modules/{module_id}/settings
- GET /woonoow/v1/modules/{module_id}/schema
For Addon Developers:
- Schema-based: Define settings via woonoow/module_settings_schema filter
- Custom React: Build component using window.WooNooW API, externalize react/react-dom
- Both approaches use same storage and retrieval methods
- TypeScript definitions provided for type safety
- Complete working example (Biteship) included
146 lines
5.5 KiB
PHP
146 lines
5.5 KiB
PHP
<?php
|
|
namespace WooNooW\Api;
|
|
|
|
use WP_REST_Request;
|
|
use WP_REST_Response;
|
|
use WooNooW\Api\CheckoutController;
|
|
use WooNooW\Api\OrdersController;
|
|
use WooNooW\Api\AnalyticsController;
|
|
use WooNooW\Api\AuthController;
|
|
use WooNooW\Api\PaymentsController;
|
|
use WooNooW\Api\StoreController;
|
|
use WooNooW\Api\ShippingController;
|
|
use WooNooW\Api\TaxController;
|
|
use WooNooW\Api\PickupLocationsController;
|
|
use WooNooW\Api\EmailController;
|
|
use WooNooW\Api\DeveloperController;
|
|
use WooNooW\Api\SystemController;
|
|
use WooNooW\Api\NotificationsController;
|
|
use WooNooW\Api\ActivityLogController;
|
|
use WooNooW\Api\ProductsController;
|
|
use WooNooW\Api\CouponsController;
|
|
use WooNooW\Api\CustomersController;
|
|
use WooNooW\Api\NewsletterController;
|
|
use WooNooW\Api\ModulesController;
|
|
use WooNooW\Api\ModuleSettingsController;
|
|
use WooNooW\Frontend\ShopController;
|
|
use WooNooW\Frontend\CartController as FrontendCartController;
|
|
use WooNooW\Frontend\AccountController;
|
|
use WooNooW\Frontend\AddressController;
|
|
use WooNooW\Frontend\WishlistController;
|
|
use WooNooW\Frontend\HookBridge;
|
|
use WooNooW\Api\Controllers\SettingsController;
|
|
use WooNooW\Api\Controllers\CartController as ApiCartController;
|
|
use WooNooW\Admin\AppearanceController;
|
|
|
|
class Routes {
|
|
public static function init() {
|
|
// Initialize controllers (register action hooks)
|
|
OrdersController::init();
|
|
AppearanceController::init();
|
|
|
|
// Initialize CartController auth bypass (must be before rest_api_init)
|
|
FrontendCartController::init();
|
|
|
|
add_action('rest_api_init', function () {
|
|
$namespace = 'woonoow/v1';
|
|
|
|
// Auth endpoints (public - no permission check)
|
|
register_rest_route( $namespace, '/auth/login', [
|
|
'methods' => 'POST',
|
|
'callback' => [ AuthController::class, 'login' ],
|
|
'permission_callback' => '__return_true',
|
|
] );
|
|
|
|
register_rest_route( $namespace, '/auth/logout', [
|
|
'methods' => 'POST',
|
|
'callback' => [ AuthController::class, 'logout' ],
|
|
'permission_callback' => '__return_true',
|
|
] );
|
|
|
|
register_rest_route( $namespace, '/auth/check', [
|
|
'methods' => 'GET',
|
|
'callback' => [ AuthController::class, 'check' ],
|
|
'permission_callback' => '__return_true',
|
|
] );
|
|
|
|
// Defer to controllers to register their endpoints
|
|
CheckoutController::register();
|
|
OrdersController::register();
|
|
AnalyticsController::register_routes();
|
|
|
|
// Settings controller
|
|
$settings_controller = new SettingsController();
|
|
$settings_controller->register_routes();
|
|
|
|
// Payments controller
|
|
$payments_controller = new PaymentsController();
|
|
$payments_controller->register_routes();
|
|
|
|
// Store controller
|
|
$store_controller = new StoreController();
|
|
$store_controller->register_routes();
|
|
|
|
// Shipping controller
|
|
$shipping_controller = new ShippingController();
|
|
$shipping_controller->register_routes();
|
|
|
|
// Tax controller
|
|
$tax_controller = new TaxController();
|
|
$tax_controller->register_routes();
|
|
|
|
// Pickup locations controller
|
|
$pickup_controller = new PickupLocationsController();
|
|
$pickup_controller->register_routes();
|
|
|
|
// Email controller
|
|
$email_controller = new EmailController();
|
|
$email_controller->register_routes();
|
|
|
|
// Developer controller
|
|
$developer_controller = new DeveloperController();
|
|
$developer_controller->register_routes();
|
|
|
|
// System controller
|
|
$system_controller = new SystemController();
|
|
$system_controller->register_routes();
|
|
|
|
// Notifications controller
|
|
$notifications_controller = new NotificationsController();
|
|
$notifications_controller->register_routes();
|
|
|
|
// Activity Log controller
|
|
$activity_log_controller = new ActivityLogController();
|
|
$activity_log_controller->register_routes();
|
|
|
|
// Products controller
|
|
ProductsController::register_routes();
|
|
|
|
// Coupons controller
|
|
CouponsController::register_routes();
|
|
|
|
// Customers controller
|
|
CustomersController::register_routes();
|
|
|
|
// Newsletter controller
|
|
NewsletterController::register_routes();
|
|
|
|
// Modules controller
|
|
$modules_controller = new ModulesController();
|
|
$modules_controller->register_routes();
|
|
|
|
// Module Settings controller
|
|
$module_settings_controller = new ModuleSettingsController();
|
|
$module_settings_controller->register_routes();
|
|
|
|
// Frontend controllers (customer-facing)
|
|
ShopController::register_routes();
|
|
FrontendCartController::register_routes();
|
|
AccountController::register_routes();
|
|
AddressController::register_routes();
|
|
WishlistController::register_routes();
|
|
HookBridge::register_routes();
|
|
});
|
|
}
|
|
}
|