@star-insure/sdk 0.1.0

package/dist/types/models/claims/ClaimRequest.d.ts

@@ -0,0 +1,267 @@
+import { Condition, Frequency, VehicleType } from "../../api";
+export declare type ClaimRequestStatus = 'new' | 'draft' | 'in-progress' | 'exported';
+export interface ClaimRequest {
+    id: string;
+    reference: string;
+    'status': ClaimRequestStatus;
+    'submitted_at': string;
+    'reminder_sent_at': string;
+    'claim_number': string;
+    'policyholder': string;
+    'policy_number': string;
+    'policy_cover_number': string;
+    'policy_version_number': string;
+    'policy_contact_name': string;
+    'mobile': string;
+    'email': string;
+    'alternative_contact': string;
+    'broker_firm': string;
+    'broker_name': string;
+    'address': string;
+    'terms_accepted': boolean;
+}
+export interface DamageClaimRequest extends ClaimRequest {
+    'vehicle_registration': string;
+    'vehicle_vin': string;
+    'vehicle_make': string;
+    'vehicle_model': string;
+    'vehicle_year': string | number;
+    'vehicle_type': VehicleType;
+    'finance_company': string;
+    'finance_phone': string;
+    'driver_name': string;
+    'driver_dob': string;
+    'driver_relationship': string;
+    'driver_licence_number': string;
+    'driver_licence_version': string;
+    'driver_licence_issuer': string;
+    'was_intoxicated': boolean;
+    'intoxicated_details': string;
+    'has_conviction': boolean;
+    'conviction_details': string;
+    'has_recent_claim': boolean;
+    'incident_details': Incident[];
+    'was_disqualified': boolean;
+    'disqualified_details': string;
+    'was_vehicle_used_without_consent': boolean;
+    'vehicle_used_without_consent_details': string;
+    'has_existing_vehicle_damage': boolean;
+    'existing_vehicle_damage_details': string;
+    'was_refused_insurance': boolean;
+    'refused_insurance_details': string;
+    'has_additional_information': boolean;
+    'additional_information_details': string;
+    'accident_location': string;
+    'accident_suburb': string;
+    'accident_happened_at': string;
+    'accident_speed': string;
+    'impact_speed': string;
+    'road_surface': string;
+    'weather_conditions': string;
+    'had_passengers': boolean;
+    'passenger_details': Passenger[];
+    'has_witnesses': boolean;
+    'witness_details': Witness[];
+    'accident_description': string;
+    'is_vehicle_drivable': boolean;
+    'vehicle_drivable_details': string;
+    'was_warning_given': boolean;
+    'warning_given_details': string;
+    'was_third_party_responsible': boolean;
+    'third_party_responsible_details': string;
+    'was_third_party_involved': boolean;
+    'third_party_vehicle_registration': string;
+    'third_party_vehicle_owner': string;
+    'third_party_vehicle_make': string;
+    'third_party_vehicle_model': string;
+    'third_party_vehicle_driver_name': string;
+    'third_party_vehicle_driver_mobile': string;
+    'third_party_vehicle_driver_phone': string;
+    'third_party_vehicle_driver_address': string;
+    'third_party_vehicle_insurance_company': string;
+    'third_party_vehicle_damage': string;
+    'third_party_details_provided': string;
+    'were_police_notified': boolean;
+    'did_police_attend': boolean;
+    'police_officer_name': string;
+    'police_officer_email': string;
+    'police_reference': string;
+    'police_station_address': string;
+    'police_did_test': boolean;
+    'police_issued_notice': boolean;
+    'repairer_name': string;
+    'repairer_phone': string;
+    'repairer_email': string;
+    'is_claiming_protective_gear': boolean;
+    'is_protective_gear_insured_elsewhere': boolean;
+    'protective_gear_details': ClaimItem[];
+    'is_claiming_contents': boolean;
+    'is_contents_insured_elsewhere': boolean;
+    'contents_details': ClaimItem[];
+}
+export interface Incident {
+    'year': string;
+    'month': string;
+    'description': string;
+}
+export interface Passenger {
+    'name': string;
+    'phone'?: string;
+    'email'?: string;
+    'address'?: string;
+}
+export interface Witness {
+    'name': string;
+    'phone'?: string;
+    'email'?: string;
+    'address'?: string;
+}
+export interface ClaimItem {
+    'description': string;
+    'purchased_from'?: string;
+    'age'?: string;
+    'purchase_price'?: string;
+    'replacement_cost'?: string;
+}
+export interface GlassClaimRequest extends ClaimRequest {
+    'vehicle_registration': string;
+    'vehicle_vin': string;
+    'vehicle_make': string;
+    'vehicle_model': string;
+    'vehicle_year': string | number;
+    'accident_location': string;
+    'accident_happened_at': string;
+    'accident_description': string;
+    'repairer_name': string;
+    'repairer_phone': string;
+    'repairer_email': string;
+}
+export interface TheftClaimRequest extends ClaimRequest {
+    'vehicle_registration': string;
+    'vehicle_vin': string;
+    'vehicle_make': string;
+    'vehicle_model': string;
+    'vehicle_year': string | number;
+    'vehicle_type': VehicleType;
+    'finance_company': string;
+    'finance_phone': string;
+    'is_leased': boolean;
+    'lease_name': string;
+    'lease_address': string;
+    'lease_phone': string;
+    'lease_number': string;
+    'lease_payment_amount': string | number;
+    'lease_payment_frequency': Frequency;
+    'has_conviction': boolean;
+    'conviction_details': string;
+    'has_recent_claim': boolean;
+    'incident_details': Incident[];
+    'was_disqualified': boolean;
+    'disqualified_details': string;
+    'was_vehicle_used_without_consent': boolean;
+    'vehicle_used_without_consent_details': string;
+    'has_existing_vehicle_damage': boolean;
+    'existing_vehicle_damage_details': string;
+    'was_refused_insurance': boolean;
+    'refused_insurance_details': string;
+    'has_additional_information': boolean;
+    'additional_information_details': string;
+    'vehicle_purchased_on': string;
+    'vehicle_purchased_from': string;
+    'vehicle_purchased_price': string | number;
+    'vehicle_value': number;
+    'was_vehicle_for_sale': boolean;
+    'vehicle_first_asking_price': string | number;
+    'vehicle_last_asking_price': string | number;
+    'vehicle_sale_duration': string;
+    'vehicle_purchaser_name': string;
+    'vehicle_purchaser_address': string;
+    'vehicle_purchaser_phone': string;
+    'vehicle_hp_cc_rating': string;
+    'vehicle_transmission': string;
+    'vehicle_engine_number': string;
+    'vehicle_has_air_conditioning': boolean;
+    'vehicle_has_cng': boolean;
+    'vehicle_has_lpg': boolean;
+    'vehicle_colour': string;
+    'vehicle_colour_changes': string;
+    'was_vehicle_repaired': boolean;
+    'vehicle_repaired_damage_details': string;
+    'vehicle_repairer': string;
+    'vehicle_repaired_on': string;
+    'was_vehicle_damaged': boolean;
+    'vehicle_damage_details': string;
+    'vehicle_tyre_condition_front_right': Condition;
+    'vehicle_tyre_condition_front_left': Condition;
+    'vehicle_tyre_condition_rear_right': Condition;
+    'vehicle_tyre_condition_rear_left': Condition;
+    'vehicle_tyre_condition_spare': string;
+    'wheel_assembly_details': string;
+    'is_vehicle_radio_original': boolean;
+    'vehicle_radio_make': string;
+    'vehicle_radio_location': string;
+    'vehicle_radio_fixing': string;
+    'vehicle_speaker_make': string;
+    'accessory_details': Accessory[];
+    'identifiable_contents_details': Contents[];
+    'vehicle_serviced_by': string;
+    'has_service_invoices': boolean;
+    'vehicle_wof_issued_by': string;
+    'vehicle_wof_issued_on': string;
+    'vehicle_wof_expires_on': string;
+    'vehicle_floor_type': string;
+    'vehicle_interior_details': string;
+    'vehicle_seatbelt_type': string;
+    'vehicle_seatbelt_condition': Condition;
+    'vehicle_engine_condition': Condition;
+    'vehicle_gearbox_condition': Condition;
+    'vehicle_transmission_condition': Condition;
+    'vehicle_suspension_condition': Condition;
+    'vehicle_steering_condition': Condition;
+    'vehicle_seats_condition': Condition;
+    'vehicle_trims_condition': Condition;
+    'vehicle_body_condition': Condition;
+    'vehicle_paint_condition': Condition;
+    'vehicle_dashboard_condition': Condition;
+    'vehicle_engine_oil_per_month': string;
+    'vehicle_ran_well': boolean;
+    'theft_details': string;
+    'theft_happened_on': string;
+    'theft_discovered_on': string;
+    'vehicle_last_used_by': string;
+    'were_windows_up': boolean;
+    'windows_down_details': string;
+    'were_doors_locked': boolean;
+    'doors_unlocked_details': string;
+    'has_theft_evidence': boolean;
+    'theft_evidence_details': string;
+    'has_steering_lock': boolean;
+    'has_alarm': boolean;
+    'was_alarm_active': boolean;
+    'alarm_inactive_details': string;
+    'was_boot_locked': boolean;
+    'boot_unlocked_details': string;
+    'keys_count': string;
+    'key_holder_name': string;
+    'key_holder_phone': string;
+    'key_holder_address': string;
+    'keys_location': string;
+    'policyholder_whereabouts_details': string;
+    'were_police_notified': boolean;
+    'did_police_attend': boolean;
+    'police_officer_name': string;
+    'police_officer_email': string;
+    'police_reference': string;
+    'police_station_address': string;
+    'is_claiming_contents': boolean;
+    'is_contents_insured_elsewhere': boolean;
+    'contents_details': ClaimItem[];
+}
+export interface Accessory {
+    'description': string;
+    'age': string;
+    'condition': string;
+}
+export interface Contents {
+    'description': string;
+}

package/dist/types/models/claims/index.d.ts

@@ -0,0 +1 @@
+export * from './ClaimRequest';

package/dist/types/models/index.d.ts

@@ -0,0 +1,3 @@
+export * from './auth';
+export * from './claims';
+export * from './oracle';

package/dist/types/models/oracle/Risk.d.ts

@@ -0,0 +1,7 @@
+export interface RiskDisplayValue {
+    id: number;
+    created_at: string;
+    updated_at: string;
+    RI_CODE: string;
+    value: string;
+}

package/dist/types/models/oracle/TableData.d.ts

@@ -0,0 +1,8 @@
+export interface TableDataDisplayValue {
+    id: number;
+    created_at: string;
+    updated_at: string;
+    tbl_type: string;
+    tbl_code: string;
+    value: string;
+}

package/dist/types/models/oracle/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Risk';
+export * from './TableData';

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

@@ -0,0 +1,130 @@
+export declare type QuoteRequestStatus = 'new' | 'draft' | 'in-progress' | 'with-customer' | 'sold' | 'bound' | 'customer-modified' | 'closed';
+export declare type QuoteRequestSource = 'web' | 'phone' | 'show' | 'existing-customer' | 'mighway' | 'agent' | 'entry-form' | 'bularangi';
+export declare type QuoteRequestAutomatch = 'QUOTE' | 'EMAIL' | 'REGISTRATION' | 'DUPLICATE' | null;
+export interface QuoteRequestUser {
+    id: number;
+    name: string;
+    email: string;
+}
+export interface QuoteRequestUserGroup {
+    id: number;
+    name: string;
+}
+export interface QuoteRequest {
+    id: string;
+    reference: string;
+    client_number: string;
+    first_name: string;
+    last_name: string;
+    phone: string;
+    mobile: string;
+    email: string;
+    license: string;
+    license_other: string | null;
+    has_automatch: boolean;
+    automatch_by: QuoteRequestAutomatch;
+    automatch_client_id: string | null;
+    promo_code: string | null;
+    club_membership_number: string;
+    broker_fee: number;
+    length_of_insurance: string | null;
+    theme: string | null;
+    created_at: string;
+    updated_at: string;
+    dob: string;
+    sold_at: string | null;
+    sent_at: string | null;
+    pricing_expires_at: string | null;
+    follow_up_at: string | null;
+    status_id: QuoteRequestStatus;
+    source_id: QuoteRequestSource;
+    resubmit_id: QuoteRequest['id'] | null;
+    referrer_id: QuoteRequestReferrer['id'] | null;
+    referrer_category_id: QuoteRequestReferrerCategory['id'] | null;
+    staff_member_id: QuoteRequestUser['id'] | null;
+    agent_id: QuoteRequestUser['id'] | null;
+    agent_firm_id: QuoteRequestUserGroup['id'] | null;
+    broker_firm_id: QuoteRequestUserGroup['id'] | null;
+    broker_id: QuoteRequestUser['id'] | null;
+    club_id: Club['id'] | null;
+    lead_id: Lead['id'] | null;
+    status?: QuoteRequestStatus;
+    source?: QuoteRequestSource;
+    declaration?: QuoteRequestDeclaration;
+    street_address?: StreetAddress;
+    postal_address?: PostalAddress;
+    resubmit?: QuoteRequest;
+    referrer?: QuoteRequestReferrer;
+    referrer_category?: QuoteRequestReferrerCategory;
+    staff_member?: QuoteRequestUser;
+    agent?: QuoteRequestUser;
+    agent_firm?: QuoteRequestUserGroup;
+    broker?: QuoteRequestUser;
+    broker_firm?: QuoteRequestUserGroup;
+    club?: Club;
+    lead?: Lead;
+}
+export interface QuoteRequestReferrer {
+    id: number;
+    name: string;
+    category_id: QuoteRequestReferrerCategory['id'];
+    category?: QuoteRequestReferrerCategory;
+}
+export interface QuoteRequestReferrerCategory {
+    id: number;
+    name: string;
+}
+export interface Club {
+    id: number;
+    name: string;
+}
+export interface StreetAddress {
+    id: number;
+    address: string | null;
+    unit: string | null;
+    suburb: string | null;
+    city: string | null;
+    post_code: string | null;
+}
+export interface PostalAddress {
+    id: number;
+    postal_line_1: string | null;
+    postal_line_2: string | null;
+    postal_line_3: string | null;
+    postal_line_4: string | null;
+}
+export interface Lead {
+    id: number;
+    first_name: string;
+    last_name: string;
+    email: string;
+    mobile: string;
+    status: string;
+    source: string;
+    postal_address_id: PostalAddress['id'];
+    current_insurer: string | null;
+    current_insurance_expires_at: string | null;
+    current_insurance_is_monthly: boolean;
+    vehicle_details: string | null;
+    notes: string | null;
+    import_data: string | null;
+}
+export interface QuoteRequestDeclaration {
+    id: number;
+    quote_request_id: QuoteRequest['id'];
+    had_incident: boolean;
+    has_demerit_points: boolean;
+    demerit_points: string | null;
+    has_lost_license: boolean;
+    lost_license_details: string | null;
+    was_refused_insurance: boolean;
+    refused_insurance_details: string | null;
+    has_criminal_conviction: boolean;
+    criminal_conviction_details: string | null;
+    has_vehicle_modifications: boolean;
+    vehicle_modifications_details: string | null;
+    has_previous_insurer: boolean;
+    previous_insurer_details: string | null;
+    previous_insurer_expires_at: string | null;
+    additional_details: string | null;
+}

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

@@ -0,0 +1 @@
+export * from './QuoteRequest';

package/package.json

@@ -0,0 +1,65 @@
+{
+    "name": "@star-insure/sdk",
+    "description": "The SDK for Star Insure client apps with shared helper functions and TypeScript definitions.",
+    "author": "alexclark_nz",
+    "version": "0.1.0",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/star-insure/sdk"
+    },
+    "main": "dist/index.js",
+    "typings": "dist/index.d.ts",
+    "files": [
+        "dist",
+        "src"
+    ],
+    "engines": {
+        "node": ">=10"
+    },
+    "scripts": {
+        "dev": "tsdx watch",
+        "start": "tsdx watch",
+        "build": "tsdx build",
+        "test": "tsdx test",
+        "lint": "tsdx lint",
+        "prepare": "tsdx build",
+        "size": "size-limit",
+        "analyze": "size-limit --why"
+    },
+    "husky": {
+        "hooks": {
+            "pre-commit": "tsdx lint"
+        }
+    },
+    "prettier": {
+        "printWidth": 80,
+        "semi": true,
+        "singleQuote": true,
+        "trailingComma": "es5"
+    },
+    "module": "dist/starinsure-sdk.esm.js",
+    "size-limit": [
+        {
+            "path": "dist/starinsure-sdk.cjs.production.min.js",
+            "limit": "10 KB"
+        },
+        {
+            "path": "dist/starinsure-sdk.esm.js",
+            "limit": "10 KB"
+        }
+    ],
+    "devDependencies": {
+        "@size-limit/preset-small-lib": "^7.0.8",
+        "husky": "^8.0.1",
+        "np": "^7.6.1",
+        "size-limit": "^7.0.8",
+        "tsdx": "^0.14.1",
+        "tslib": "^2.4.0",
+        "typescript": "^3.9.10"
+    },
+    "dependencies": {
+        "@inertiajs/inertia": "^0.11.0",
+        "date-fns": "^2.28.0"
+    }
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from './types';
+export * from './lib';

package/src/lib/dates.ts

@@ -0,0 +1,15 @@
+import { format } from "date-fns";
+
+/**
+ * Formats a date like "Jan 1, 2022"
+ */
+export function formatDateNice(date: string) {
+    return format(new Date(date), "MMM d, yyyy");
+}
+
+/**
+ * Formats a date like "01/01/2022 9:50AM"
+ */
+export function formatDateForTable(date: string) {
+    return format(new Date(date), 'dd/MM/yyyy h:mma');
+}

package/src/lib/index.ts

@@ -0,0 +1,2 @@
+export * from './dates';
+export * from './money';

package/src/lib/money.ts

@@ -0,0 +1,72 @@
+/**
+ * Safely rounds a number
+ */
+export function round(value: number): number {
+    return Number(Math.round(parseFloat(value + 'e' + 2)) + 'e-' + 2)
+}
+
+/**
+ * Gets the GST value from a number
+ */
+export function getGst(value: number): number {
+    return round(value * 3 / 23);
+}
+
+/**
+ * Adds GST to a number
+ */
+export function addGst(value: number): number {
+    return round(value * 1.15);
+}
+
+/**
+ * Subtracts GST from a number
+ */
+export function subtractGst(value: number): number {
+    return round(value - getGst(value));
+}
+
+/**
+ * Calculates the various GST values on a figure
+ */
+export function gstCalc(input: number|string): {
+    gst: number,
+    amountInclusive: number,
+    amountExclusive: number
+} {
+    let value = input;
+
+    if (typeof value === 'string') {
+        value = parseFloat(value.replace(/[^0-9.]/g, ''));
+    }
+
+    value = round(value);
+
+    return {
+        gst: getGst(value),
+        amountInclusive: addGst(value),
+        amountExclusive: subtractGst(value)
+    }
+}
+
+/**
+ * Formats a value nicely
+ */
+ export function formatMoney(value: string|number, decimals: number = 2): string {
+    let toFormat = value;
+    if (typeof value === 'string') {
+        toFormat = value.replace(/[^\d.-]/g, '')
+    }
+
+    return Number(toFormat).toLocaleString('en', {
+        minimumFractionDigits: decimals,
+        maximumFractionDigits: decimals,
+    });
+}
+
+/**
+ * Turns a formatted value in to a float
+ */
+export function formatNumber(value: string): number {
+    return parseFloat(value.replace(/[^0-9.]/g, ''));
+}

package/src/types/api/auth.ts

@@ -0,0 +1,10 @@
+import { User, Group } from "../models";
+
+export type Audience = 'administrator' | 'staff' | 'broker' | 'agent';
+
+export interface AuthContext {
+    user?: User;
+    audience?: Audience;
+    group?: Group;
+    permissions: string[];
+}

package/src/types/api/enums.ts

@@ -0,0 +1,5 @@
+export type VehicleType = 'car' | 'motorcycle' | 'motorhome';
+
+export type Frequency = 'daily' | 'weekly' | 'fortnightly' | 'monthly' | 'quarterly' | 'annually';
+
+export type Condition = 'poor' | 'fair' | 'good';

package/src/types/api/index.ts

@@ -0,0 +1,34 @@
+export * from './auth';
+export * from './enums';
+
+export interface ApiResponse<T = any> {
+    data: T;
+    meta: Meta;
+    links: Links;
+    status: number;
+    ok: boolean;
+}
+
+export interface Meta {
+    current_page: number;
+    from: number;
+    last_page: number;
+    links: PaginationLink[];
+    path: string;
+    per_page: number;
+    to: number;
+    total: number;
+}
+
+export interface Links {
+    first: string;
+    last: string;
+    prev: string | null;
+    next: string | null;
+}
+
+export interface PaginationLink {
+    url: string | null;
+    label: string;
+    active: boolean;
+}

package/src/types/index.ts

@@ -0,0 +1,3 @@
+export * from './models';
+export * from './api';
+export * from './misc';

package/src/types/misc/index.ts

@@ -0,0 +1,10 @@
+export * from './inertia';
+
+export type FormStatus = 'idle' | 'processing' | 'success' | 'error';
+
+export interface Toast {
+    _id?: string;
+    message: string;
+    status?: 'success' | 'error' | 'default' | 'warning';
+    timeout?: number;
+}

package/src/types/misc/inertia.ts

@@ -0,0 +1,9 @@
+import type { ErrorBag, Errors, Page, PageProps as PagePropsInterface } from "@inertiajs/inertia";
+import { AuthContext } from '../..';
+
+export interface PageProps extends Page<PagePropsInterface> {
+    props: {
+        auth: AuthContext;
+        errors: Errors & ErrorBag;
+    }
+}

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

@@ -0,0 +1,11 @@
+import { Role, Permission, User } from ".";
+
+export interface Group {
+    id: number;
+    name: string;
+    code: string;
+    'x_code': string;
+    role?: Role;
+    permissions?: Permission[];
+    users?: User[];
+}