@star-insure/sdk 2.5.2 → 3.0.1

package/dist/types/models/quotes/QuoteRequestVehicle.d.ts

@@ -1,5 +1,5 @@
-import { Product, VehicleType } from "../../api";
-import { QuoteRequestVehicleDriver } from "./QuoteRequestVehicleDriver";
+import { Product, VehicleType } from '../../api';
+import { QuoteRequestVehicleDriver } from './QuoteRequestVehicleDriver';
 export interface QuoteRequestVehicle {
     id?: number;
     vehicle_type?: VehicleType;
@@ -14,6 +14,7 @@ export interface QuoteRequestVehicle {
     owned_duration?: string;
     value?: number;
     storage_location?: string;
+    storage_location_other?: string;
     is_heavy?: boolean;
     quote_request_id?: string;
     drivers?: QuoteRequestVehicleDriver[];

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.1",
     "license": "MIT",
     "repository": {
         "type": "git",

package/src/components/forms/FormTester.tsx

@@ -3,168 +3,212 @@ import { Button } from '../common';
 import { useQuoteRequestForm } from '../../lib';
 
 interface Props {
-    populatePurchaseOptions: boolean;
+  populatePurchaseOptions: boolean;
 }
 
 export default function FormTester({ populatePurchaseOptions = false }: Props) {
-    const { form } = useQuoteRequestForm();
-    const [keys, setKeys] = React.useState<string[]>([]);
-    const [isDev, setDev] = React.useState<boolean>(false);
+  const { form } = useQuoteRequestForm();
+  const [keys, setKeys] = React.useState<string[]>([]);
+  const [isDev, setDev] = React.useState<boolean>(false);
 
-    function handlePopulate() {
-        form?.setData(prevData => ({
-            ...prevData,
-            first_name: 'TEST',
-            last_name: 'TEST',
-            email: 'dev@sual.co.nz',
-            phone: '021 234 5678',
-            mobile: '021 234 5678',
-            dob: '1990-01-01',
-            licence: 'Other',
-            licence_other: 'Test',
-            club_id: 50,
-            club_membership_number: '12345',
-            street_address: {
-                address: '123 Street Name',
-                unit: 'Level 1',
-                suburb: 'Suburb',
-                city: 'Auckland',
-                post_code: '1234',
+  function handlePopulate() {
+    form?.setData(prevData => ({
+      ...prevData,
+      first_name: 'TEST',
+      last_name: 'TEST',
+      email: 'dev@sual.co.nz',
+      phone: '021 234 5678',
+      mobile: '021 234 5678',
+      dob: '1990-01-01',
+      licence: 'Other',
+      licence_other: 'Test',
+      club_id: 50,
+      club_membership_number: '12345',
+      street_address: {
+        address: '123 Street Name',
+        unit: 'Level 1',
+        suburb: 'Suburb',
+        city: 'Auckland',
+        post_code: '1234',
+      },
+      promo_code: 'TEST',
+      declaration: {
+        had_incident: true,
+        incidents: [
+          {
+            description: 'Lorem ipsum dolor sit amet.',
+            month: 'January',
+            year: '2020',
+          },
+        ],
+        has_demerit_points: true,
+        demerit_points: '1-24',
+        has_lost_licence: true,
+        lost_licence_details: 'Lorem ipsum dolor sit amet.',
+        was_refused_insurance: true,
+        refused_insurance_details: 'Lorem ipsum dolor sit amet.',
+        has_criminal_conviction: true,
+        criminal_conviction_details: 'Lorem ipsum dolor sit amet.',
+        has_vehicle_modifications: true,
+        vehicle_modifications_details: 'Lorem ipsum dolor sit amet.',
+        has_previous_insurer: true,
+        previous_insurer_details: 'AA',
+        previous_insurer_expires_at: '2020-01-01',
+        additional_details:
+          'I am a robot, beep boop. Please ignore this submission.',
+      },
+      vehicles: [
+        {
+          make: 'Tesla',
+          model: 'Cybertruck',
+          year: '2023',
+          registration: 'ELMUSK',
+          vehicle_type: 'car',
+          product: 'star-enthusiast-prestige-everyday-plus',
+          value: 100000,
+          is_heavy: false,
+          usage: 'Childrens car',
+          storage_location: 'Carport',
+          has_financially_interested_party: true,
+          financially_interested_party_detail: 'MTA',
+          owned_duration: 'Less than 12 months',
+          main_driver: 'TEST TEST',
+          drivers: [
+            {
+              first_name: 'X Æ',
+              last_name: 'A-12',
+              dob: '2000-05-04',
+              licence: 'Other',
+              licence_other: 'None',
+              relationship: 'Child',
+              key: 'driver-test-key',
             },
-            promo_code: 'TEST',
-            declaration: {
-                had_incident: true,
-                incidents: [{
-                    description: 'Lorem ipsum dolor sit amet.',
-                    month: 'January',
-                    year: '2020',
-                }],
-                has_demerit_points: true,
-                demerit_points: '1-24',
-                has_lost_licence: true,
-                lost_licence_details: 'Lorem ipsum dolor sit amet.',
-                was_refused_insurance: true,
-                refused_insurance_details: 'Lorem ipsum dolor sit amet.',
-                has_criminal_conviction: true,
-                criminal_conviction_details: 'Lorem ipsum dolor sit amet.',
-                has_vehicle_modifications: true,
-                vehicle_modifications_details: 'Lorem ipsum dolor sit amet.',
-                has_previous_insurer: true,
-                previous_insurer_details: 'AA',
-                previous_insurer_expires_at: '2020-01-01',
-                additional_details: 'I am a robot, beep boop. Please ignore this submission.',
-            },
-            vehicles: [
+          ],
+          key: 'vehicle-test-key',
+        },
+      ],
+      purchase_options: populatePurchaseOptions
+        ? [
+            {
+              premium_type: 'annual',
+              level_of_insurance_id: 12,
+              authorised_drivers: 'TEST',
+              excess_details: 'TEST',
+              terms: 'TEST',
+              description: 'This is a test purchase option',
+              premium: 100000,
+              monthly_premium: 8500,
+              show_monthly: true,
+              fsl: 100,
+              sort_order: 1,
+              enhancements: [
                 {
-                    make: 'Tesla',
-                    model: 'Cybertruck',
-                    year: '2023',
-                    registration: 'ELMUSK',
-                    vehicle_type: 'car',
-                    product: 'star-enthusiast-prestige-everyday-plus',
-                    value: 100000,
-                    is_heavy: false,
-                    usage: 'Childrens car',
-                    storage_location: 'Carport',
-                    has_financially_interested_party: true,
-                    financially_interested_party_detail: 'MTA',
-                    owned_duration: 'Less than 12 months',
-                    drivers: [
-                        {
-                            first_name: 'X Æ',
-                            last_name: 'A-12',
-                            dob: '2000-05-04',
-                            licence: 'Other',
-                            licence_other: 'None',
-                            relationship: 'Child',
-                            key: 'driver-test-key',
-                        }
-                    ],
-                    key: 'vehicle-test-key',
+                  name: 'Test enhancement',
+                  premium: 2500,
+                  disable_rounding: false,
+                  description: 'Test enhancement',
+                  auto_select: true,
+                  key: 'enhancement-test-key-1',
                 },
-            ],
-            purchase_options: populatePurchaseOptions ? [
                 {
-                    premium_type: 'annual',
-                    level_of_insurance_id: 12,
-                    authorised_drivers: 'TEST',
-                    excess_details: 'TEST',
-                    terms: 'TEST',
-                    description: 'This is a test purchase option',
-                    premium: 100000,
-                    monthly_premium: 8500,
-                    show_monthly: true,
-                    fsl: 100,
-                    sort_order: 1,
-                    enhancements: [
-                        { name: 'Test enhancement', premium: 2500, disable_rounding: false, description: 'Test enhancement', auto_select: true, key: 'enhancement-test-key-1' },
-                        { name: 'Test enhancement', premium: 5000, disable_rounding: false, description: 'Test enhancement', auto_select: false, key: 'enhancement-test-key-2' }
-                    ],
-                    key: 'purchase-option-test-key-annual'
+                  name: 'Test enhancement',
+                  premium: 5000,
+                  disable_rounding: false,
+                  description: 'Test enhancement',
+                  auto_select: false,
+                  key: 'enhancement-test-key-2',
                 },
+              ],
+              key: 'purchase-option-test-key-annual',
+            },
+            {
+              premium_type: 'total-due',
+              level_of_insurance_id: 13,
+              authorised_drivers: 'TEST',
+              excess_details: 'TEST',
+              terms: 'TEST',
+              description: 'This is a test purchase option',
+              premium: 100000,
+              show_monthly: false,
+              fsl: 100,
+              sort_order: 2,
+              enhancements: [
                 {
-                    premium_type: 'total-due',
-                    level_of_insurance_id: 13,
-                    authorised_drivers: 'TEST',
-                    excess_details: 'TEST',
-                    terms: 'TEST',
-                    description: 'This is a test purchase option',
-                    premium: 100000,
-                    show_monthly: false,
-                    fsl: 100,
-                    sort_order: 2,
-                    enhancements: [
-                        { name: 'Test enhancement', premium: 2500, disable_rounding: false, description: 'Test enhancement', auto_select: true, key: 'enhancement-test-key-3' },
-                        { name: 'Test enhancement', premium: 5000, disable_rounding: false, description: 'Test enhancement', auto_select: false, key: 'enhancement-test-key-4' }
-                    ],
-                    key: 'purchase-option-test-key-total-due'
-                }
-            ] : [],
-        }))
+                  name: 'Test enhancement',
+                  premium: 2500,
+                  disable_rounding: false,
+                  description: 'Test enhancement',
+                  auto_select: true,
+                  key: 'enhancement-test-key-3',
+                },
+                {
+                  name: 'Test enhancement',
+                  premium: 5000,
+                  disable_rounding: false,
+                  description: 'Test enhancement',
+                  auto_select: false,
+                  key: 'enhancement-test-key-4',
+                },
+              ],
+              key: 'purchase-option-test-key-total-due',
+            },
+          ]
+        : [],
+    }));
+  }
+
+  function handleKeydown(e: KeyboardEvent) {
+    if (e.key === 'Escape') {
+      return setKeys([]);
     }
 
-    function handleKeydown(e: KeyboardEvent) {
-        if (e.key === 'Escape') {
-            return setKeys([]);
-        }
+    setKeys(prevKeys => [...prevKeys, e.key]);
+  }
 
-        setKeys(prevKeys => [...prevKeys, e.key]);
+  React.useEffect(() => {
+    // Detect when the user has typed the word "debug"
+    if (keys.join('') === 'debug') {
+      handlePopulate();
     }
+  }, [keys]);
 
-    React.useEffect(() => {
-        // Detect when the user has typed the word "debug"
-        if (keys.join('') === 'debug') {
-            handlePopulate();
-        }
-    }, [keys]);
-
-    React.useEffect(() => {
-        if (typeof window !== 'undefined') {
-            if (window.location.href.includes('dev')
-                || window.location.href.includes('localhost')
-                || window.location.href.includes('test')
-                || window.location.href.includes('local')
-            ) {
-                setDev(true);
-            }
+  React.useEffect(() => {
+    if (typeof window !== 'undefined') {
+      if (
+        window.location.href.includes('dev') ||
+        window.location.href.includes('localhost') ||
+        window.location.href.includes('test') ||
+        window.location.href.includes('local')
+      ) {
+        setDev(true);
+      }
 
-            window.addEventListener('keydown', (e: KeyboardEvent) => handleKeydown(e));
+      window.addEventListener('keydown', (e: KeyboardEvent) =>
+        handleKeydown(e)
+      );
 
-            return () => {
-                window.removeEventListener('keydown', (e: KeyboardEvent) => handleKeydown(e));
-            }
-        }
+      return () => {
+        window.removeEventListener('keydown', (e: KeyboardEvent) =>
+          handleKeydown(e)
+        );
+      };
+    }
 
-        return;
-    }, []);
+    return;
+  }, []);
 
-    if (isDev) {
-        return (
-            <Button onClick={handlePopulate} type="button" status="primary" className="fixed bottom-4 right-4">
-                Populate data
-            </Button>
-        )
-    }
+  if (isDev) {
+    return (
+      <Button
+        onClick={handlePopulate}
+        type="button"
+        status="primary"
+        className="fixed bottom-4 right-4"
+      >
+        Populate data
+      </Button>
+    );
+  }
 
-    return <></>;
+  return <></>;
 }

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[];
 }

package/src/types/models/quotes/QuoteRequestVehicle.ts

@@ -1,23 +1,24 @@
-import { Product, VehicleType } from "../../api";
-import { QuoteRequestVehicleDriver } from "./QuoteRequestVehicleDriver";
+import { Product, VehicleType } from '../../api';
+import { QuoteRequestVehicleDriver } from './QuoteRequestVehicleDriver';
 
 export interface QuoteRequestVehicle {
-    id?: number;
-    vehicle_type?: VehicleType;
-    registration?: string;
-    make?: string;
-    model?: string;
-    year?: string;
-    usage?: string;
-    product?: Product;
-    has_financially_interested_party?: boolean;
-    financially_interested_party_detail?: string;
-    owned_duration?: string;
-    value?: number;
-    storage_location?: string;
-    is_heavy?: boolean;
-    quote_request_id?: string;
-    drivers?: QuoteRequestVehicleDriver[];
-    key?: string;
-    main_driver?: string;
+  id?: number;
+  vehicle_type?: VehicleType;
+  registration?: string;
+  make?: string;
+  model?: string;
+  year?: string;
+  usage?: string;
+  product?: Product;
+  has_financially_interested_party?: boolean;
+  financially_interested_party_detail?: string;
+  owned_duration?: string;
+  value?: number;
+  storage_location?: string;
+  storage_location_other?: string;
+  is_heavy?: boolean;
+  quote_request_id?: string;
+  drivers?: QuoteRequestVehicleDriver[];
+  key?: string;
+  main_driver?: string;
 }