Update/dokan core store and api (#3053)

* update: User meta api response for dokan core store

* fix: Add resolver method for vendor id in core data

* docs: update Dokan Core Store documentation with complete API reference

* fix: correct comments in resolvers and ApiMeta class

* docs: fix stale comments and add missing JSDoc descriptions

* fix: correct return type annotation and improve docblock formatting

Author: mrabbani

docs/frontend/stores.md

@@ -225,27 +225,145 @@ the global `dokan.{store-name}-store` when your code is bundled.
 
 The `Dokan Core Store` is a `WordPress Data Store` that provides access to the core data of the `Dokan` plugin. This store is available in the `@dokan/stores/core` package.
 
+## Available Selectors
+
+The core store provides the following selectors:
+
+- `getCurrentUser()` - Get the current user object
+- `hasCap(capability)` - Check if the current user has a specific capability
+- `isVendor()` - Check if the current user is a vendor
+- `isVendorStaff()` - Check if the current user is a vendor staff
+- `getStoreSettings()` - Get the store settings
+- `getGlobalSettings()` - Get the global settings
+- `getVendorId()` - Get the vendor ID for the current user
+
+## Available Actions
+
+- `setCurrentUser(user)` - Set the current user
+- `setStoreSettings(settings)` - Set the store settings
+- `setGlobalSettings(settings)` - Set the global settings
+
+## Usage Examples
+
+### Using Selectors
+
 ```js
 import { useSelect } from '@wordpress/data';
 import coreStore from '@dokan/stores/core';
 
 const App = () => {
+    // Get current user
+    const currentUser = useSelect( ( select ) => {
+        return select( coreStore ).getCurrentUser();
+    }, [] );
+
+    // Check if user is a vendor
+    const isVendor = useSelect( ( select ) => {
+        return select( coreStore ).isVendor();
+    }, [] );
+
+    // Check if user is a vendor staff
     const isVendorStaff = useSelect( ( select ) => {
         return select( coreStore ).isVendorStaff();
     }, [] );
-    
-    const getStoreSettings = useSelect( ( select ) => {
+
+    // Check if user has a specific capability
+    const hasCapability = useSelect( ( select ) => {
+        return select( coreStore ).hasCap( 'dokandar' );
+    }, [] );
+
+    // Get store settings
+    const storeSettings = useSelect( ( select ) => {
         return select( coreStore ).getStoreSettings();
     }, [] );
 
-    const currentUser = useSelect( ( select ) => {
-        return select( coreStore ).getCurrentUser();
+    // Get global settings
+    const globalSettings = useSelect( ( select ) => {
+        return select( coreStore ).getGlobalSettings();
     }, [] );
+
+    // Get vendor ID
+    const vendorId = useSelect( ( select ) => {
+        return select( coreStore ).getVendorId();
+    }, [] );
+};
+```
+
+### Using Actions
+
+```js
+import { useDispatch } from '@wordpress/data';
+import coreStore from '@dokan/stores/core';
+
+const App = () => {
+    const { setCurrentUser, setStoreSettings, setGlobalSettings } = useDispatch( coreStore );
+
+    // Update current user
+    const updateUser = ( user ) => {
+        setCurrentUser( user );
+    };
+
+    // Update store settings
+    const updateStoreSettings = ( settings ) => {
+        setStoreSettings( settings );
+    };
+
+    // Update global settings
+    const updateGlobalSettings = ( settings ) => {
+        setGlobalSettings( settings );
+    };
+};
+```
+
+### Using Resolvers (Async Data Fetching)
+
+```js
+import { resolveSelect } from '@wordpress/data';
+import coreStore from '@dokan/stores/core';
+
+const App = () => {
+    // Fetch current user asynchronously
+    const fetchCurrentUser = async () => {
+        await resolveSelect( coreStore ).getCurrentUser();
+    };
+
+    // Fetch store settings asynchronously
+    const fetchStoreSettings = async () => {
+        const settings = await resolveSelect( coreStore ).getStoreSettings();
+        return settings;
+    };
+
+    // Fetch global settings asynchronously
+    const fetchGlobalSettings = async () => {
+        await resolveSelect( coreStore ).getGlobalSettings();
+    };
+
+    // Check capability (triggers user fetch if needed)
+    const checkCapability = async ( capability ) => {
+        await resolveSelect( coreStore ).hasCap( capability );
+    };
+
+    // Check if vendor (triggers user fetch if needed)
+    const checkIsVendor = async () => {
+        await resolveSelect( coreStore ).isVendor();
+    };
+
+    // Check if vendor staff (triggers user fetch if needed)
+    const checkIsVendorStaff = async () => {
+        await resolveSelect( coreStore ).isVendorStaff();
+    };
+
+    // Get vendor ID (triggers user fetch if needed)
+    const fetchVendorId = async () => {
+        await resolveSelect( coreStore ).getVendorId();
+    };
 };
 ```
 
 ## Use Dokan Hooks
 
+For convenience, you can also use the Dokan hooks which provide a simpler API:
+
 ```js
 import { usePermission, useCurrentUser } from '@dokan/hooks';
 
@@ -259,5 +377,4 @@ const App = () => {
     const isDokandar = usePermission('dokandar'); // you can pass string as single permission or pass string[] array for multiple permission checking
     const currentUser = useCurrentUser();
 }
-
 ```

includes/DependencyManagement/Providers/CommonServiceProvider.php

@@ -25,6 +25,7 @@ class CommonServiceProvider extends BaseServiceProvider {
         \WeDevs\Dokan\Order\RefundHandler::class,
         \WeDevs\Dokan\Exceptions\Handler::class,
         \WeDevs\Dokan\Shortcodes\FullWidthVendorLayout::class,
+        \WeDevs\Dokan\Vendor\ApiMeta::class,
 	];
 
 	/**

includes/Utilities/VendorUtil.php

@@ -8,7 +8,7 @@ class VendorUtil {
      *
      * @since 4.0.6
      *
-     * @return void
+     * @return string The default store banner URL.
      */
     public static function get_vendor_default_banner_url(): string {
         // Define the default store banner URL from plugin assets
@@ -52,4 +52,38 @@ public static function get_vendor_default_avatar_url(): string {
          */
         return apply_filters( 'dokan_get_vendor_default_avatar_url', $avatar_url );
     }
+
+
+    /**
+     * Get the vendor/store ID associated with a user.
+     *
+     * This method determines the vendor ID based on the user's role:
+     * - Vendors: Returns their own user ID as the vendor ID
+     * - Vendor staff: Returns their parent vendor's ID (stored in user meta)
+     * - Other users: Returns 0 if not associated with any vendor
+     *
+     * @since DOKAN_SINCE
+     *
+     * @param int $user_id Optional. The user ID to get the vendor ID for. Defaults to 0 (current user).
+     *
+     * @return int The vendor/store ID. Returns 0 if the user is not a vendor or vendor staff,
+     *             or if vendor ID cannot be determined.
+     */
+    public static function get_vendor_id_for_user( int $user_id = 0 ): int {
+        if ( empty( $user_id ) ) {
+            $user_id = dokan_get_current_user_id();
+        }
+
+        if ( dokan_is_user_seller( $user_id, true ) ) {
+            return (int) $user_id;
+        }
+
+        if ( user_can( $user_id, 'vendor_staff' ) ) {
+            $vendor_id = (int) get_user_meta( $user_id, '_vendor_id', true );
+
+            return $vendor_id;
+        }
+
+        return 0;
+    }
 }

includes/Vendor/ApiMeta.php

@@ -0,0 +1,100 @@
+<?php
+
+namespace WeDevs\Dokan\Vendor;
+
+use WeDevs\Dokan\Utilities\VendorUtil;
+
+/**
+ * ApiMeta Class.
+ *
+ * Handles Dokan vendor user meta registration for the REST API.
+ */
+class ApiMeta {
+	/**
+	 * Constructor.
+	 */
+	public function __construct() {
+		add_action( 'rest_api_init', array( $this, 'register_user_data' ) );
+	}
+
+	/**
+	 * Registers Dokan specific user data to the WordPress user API.
+	 *
+	 * @since DOKAN_SINCE
+	 *
+	 * @return void
+	 */
+	public function register_user_data() {
+		register_rest_field(
+			'user',
+			'dokan_meta',
+			array(
+				'get_callback'    => array( $this, 'get_user_data_values' ),
+				'schema'          => null,
+			)
+		);
+	}
+
+	/**
+	 * Fetches the vendor-specific user data values for returning via the REST API.
+	 *
+	 * @since DOKAN_SINCE
+	 *
+	 * @param array $user Current user data from REST API.
+	 * @return array Vendor-specific user data including vendor_id.
+	 */
+	public function get_user_data_values( $user ) {
+		$values = [
+            'vendor_id' => VendorUtil::get_vendor_id_for_user( (int) $user['id'] ),
+        ];
+
+		foreach ( $this->get_user_data_fields() as $field ) {
+			$values[ $field ] = self::get_user_data_field( $user['id'], $field );
+		}
+
+		/**
+		 * Filter the user data values exposed over the WordPress user endpoint.
+		 *
+		 * @since DOKAN_SINCE
+		 *
+		 * @param array $values Array of user data values.
+		 * @param array $user Current user data from REST API.
+		 */
+		return apply_filters( 'dokan_vendor_api_meta_get_user_data_values', $values, $user );
+	}
+
+	/**
+	 * We store some Dokan specific user meta attached to users endpoint,
+	 * so that we can track certain preferences or values for vendors.
+	 * Additional fields can be added in the function below, and then used via Dokan's currentUser data.
+	 *
+	 * @since DOKAN_SINCE
+	 *
+	 * @return array Fields to expose over the WP user endpoint.
+	 */
+	public function get_user_data_fields() {
+		/**
+		 * Filter user data fields exposed over the WordPress user endpoint.
+		 *
+		 * @since DOKAN_SINCE
+		 *
+		 * @param array $fields Array of fields to expose over the WP user endpoint.
+		 */
+		return apply_filters( 'dokan_vendor_get_user_data_fields', [] );
+	}
+
+	/**
+	 * Helper to retrieve user data fields.
+	 *
+	 * @since DOKAN_SINCE
+	 *
+	 * @param int    $user_id  User ID.
+	 * @param string $field Field name.
+	 * @return mixed The user field value.
+	 */
+	public static function get_user_data_field( $user_id, $field ) {
+		$meta_value = get_user_meta( $user_id, $field, true );
+
+		return $meta_value;
+	}
+}

src/stores/core/resolvers.ts

@@ -78,6 +78,15 @@ const resolvers = {
         async ( { resolveSelect } ) => {
             return await resolveSelect.getCurrentUser();
         },
+
+    /**
+     * Get the vendor ID for the current user.
+     */
+    getVendorId:
+        () =>
+        async ( { resolveSelect } ) => {
+            return await resolveSelect.getCurrentUser();
+        },
 };
 
 export default resolvers;

src/stores/core/selectors.ts

@@ -87,6 +87,15 @@ const selectors = {
     getGlobalSettings( state: CoreState ) {
         return state.global;
     },
+
+    /**
+     * Get the vendor ID for the current user.
+     *
+     * @param state
+     */
+    getVendorId( state: CoreState ) {
+        return state.currentUser?.dokan_meta?.vendor_id;
+    },
 };
 
 export default selectors;