@star-insure/sdk 2.5.2 → 3.0.0

package/package.json

@@ -2,7 +2,7 @@
     "name": "@star-insure/sdk",
     "description": "The SDK for Star Insure client apps with shared helper functions and TypeScript definitions.",
     "author": "alexclark_nz",
-    "version": "2.5.2",
+    "version": "3.0.0",
     "license": "MIT",
     "repository": {
         "type": "git",

package/src/lib/auth.tsx

@@ -14,5 +14,15 @@ interface AppPage extends Page {
 export function useAuth(): AuthContext {
     const { props } = usePage() as AppPage;
 
-    return props.auth;
+    /**
+     * Check if the user has permission to perform the given ability.
+     */
+    function can(ability: string): boolean {
+        return props.auth.permissions.includes(ability);
+    }
+
+    return {
+        ...props.auth,
+        can,
+    };
 }

package/src/types/api/auth.ts

@@ -1,11 +1,37 @@
-import { User, Group } from "../models";
+export type UserContext =
+  | 'staff'
+  | 'broker'
+  | 'agent'
+  | 'security'
+  | 'customer';
 
-export type UserContext = 'administrator' | 'staff' | 'broker' | 'agent' | 'security' | 'customer';
+type AuthUser = {
+  id: number;
+  name: string;
+  email: string;
+  is_group_admin: boolean;
+  umbrella_filter?: string;
+  oracle_user_id?: string;
+  groups: AuthGroup[];
+};
+
+type AuthGroup = {
+  id: number;
+  name: string;
+  code: string;
+  role: AuthRole;
+};
+
+type AuthRole = {
+  name: string;
+  context: string;
+};
 
 export interface AuthContext {
-    user?: User;
-    context?: UserContext;
-    group?: Group;
-    permissions: string[];
-    is_app?: boolean;
+  user?: AuthUser;
+  context: UserContext;
+  group?: AuthGroup;
+  permissions: string[];
+  is_app?: boolean;
+  can: (permission: string) => boolean;
 }

package/src/types/models/auth/User.ts

@@ -1,14 +1,15 @@
-import { Group } from ".";
+import { Group } from '.';
 
 export interface User {
-    id: number;
-    oracle_user_id?: string;
-    name: string;
-    email: string;
-    mobile?: string;
-    direct_dial?: string;
-    position?: string;
-    is_group_admin?: boolean;
-    umbrella_filter?: string;
-    groups?: Group[];
+  id: number;
+  oracle_user_id?: string;
+  name: string;
+  email: string;
+  mobile?: string;
+  direct_dial?: string;
+  position?: string;
+  is_group_admin?: boolean;
+  umbrella_filter?: string;
+  groups?: Group[];
+  permissions?: string[];
 }