Implemented useCurrentUser() now has isRole() and isaRole() #202

Author: rizen

app/composables/ving/useCurrentUser.mjs

@@ -1,5 +1,6 @@
 import ua from 'ua-parser-js';
 import { isUndefined } from '#ving/utils/identify.mjs';
+import { RoleOptions } from '#ving/schema/schemas/User.mjs';
 
 export const useCurrentUser = () => useVingRecord({
     id: 'currentUser',
@@ -32,6 +33,22 @@ export const useCurrentUser = () => useVingRecord({
             return response;
         },
 
+        isRole(role) {
+            if (role in this.props) {
+                return this.props[role] || this.props.admin || false;
+            }
+            return false;
+        },
+
+        isaRole(roles) {
+            for (const role of roles) {
+                if (this.isRole(role)) {
+                    return true;
+                }
+            }
+            return false;
+        },
+
         async sendVerifyEmail(redirectAfter) {
             const parser = new ua(navigator.userAgent);
             const response = await useRest(this.links?.self?.href + '/send-verify-email', {

ving/docs/change-log.md

@@ -13,6 +13,7 @@ outline: deep
  * Implemented: apis should use plurals #183
  * NOTE: rest endpoints and pages use plurals like /users instead of /user now. This is a breaking change. Update your APIs and pages to use plurals.
  * Implemented: page generator should link to parent objects in the statistics section #158
+ * Implemented useCurrentUser() now has isRole() and isaRole() #202
 
 ### 2025-01-12
  * Removed pulumi from the project.

ving/docs/subsystems/ui.md

@@ -377,6 +377,28 @@ It also triggers 2 window events for when the user logs in or out.
     });
 ```
 
+#### Extended Functionality
+`useCurrentUser()` as all the same functionality as the `useVingRecord()` composable, but also has a few extra methods:
+
+##### login()
+Logs in a user.
+
+##### logout()
+Logs out a user.
+
+##### isRole(role)
+Returns `true` if the current user has the specified role.
+
+##### isaRole(roles)
+Returns `true` if the current user has any of the specified roles.
+
+##### sendVerifyEmail(redirectAfter)
+Sends a verification email to the user. If `redirectAfter` is passed in, then the user will be redirected to that URL after they verify their email.
+
+##### verifyEmail(verify)
+Verifies a user's email. If `verify` is passed in, then the user will be redirected to that URL after they verify their email.
+
+
 
 ### useMessageBus()
 Connects the browser to the server's [message bus](messagebus). It establishes a connection between your browser and the server, so it needs to be installed in an `onMounted()` handler in your layouts.