@star-insure/sdk 6.0.3 → 6.0.5

package/dist/lib/addressFinder.d.ts

@@ -0,0 +1,54 @@
+export interface AddressCompletion {
+    a: string;
+    pxid: string;
+    v: number;
+}
+export interface AddressData {
+    pxid: string;
+    a: string;
+    aims_address_id: string;
+    sufi: number;
+    ta_id: string;
+    ta: string;
+    tasub_id: string;
+    tasub: string;
+    number: string;
+    x: string;
+    y: string;
+    postcode: string;
+    street: string;
+    street_name: string;
+    street_type: string;
+    city: string;
+    suburb: string;
+    region_id: string;
+    region: string;
+    postal_line_1: string;
+    postal_line_2: string;
+    aims_road_section_id: string;
+    rural: string;
+    address_line_1: string;
+    address_line_2?: string;
+    primary_parcel_id: string;
+    meshblock: string;
+    sa1_id: string;
+    sa2_id: string;
+    sa2: string;
+    cb_id: string;
+    cb: string;
+    ward_id: string;
+    ward: string;
+    con_id: string;
+    con: string;
+    maoricon_id: string;
+    maoricon: string;
+    iur_id: string;
+    iur: string;
+    ur_id: string;
+    ur: string;
+    landwater_id: string;
+    landwater: string;
+    success: boolean;
+}
+export declare function autocomplete(search: string): Promise<AddressCompletion[]>;
+export declare function getAddressData(completion: AddressCompletion): Promise<AddressData | null>;

package/dist/lib/auth.d.ts

@@ -0,0 +1,2 @@
+import { AuthContext } from '../types';
+export declare function useAuth(): AuthContext;

package/dist/lib/calculateAge.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Calculate someone's age from a date of birth.
+ */
+export declare function calculateAge(date: string | Date | null | undefined): number;

package/dist/lib/calculatePricing.d.ts

@@ -0,0 +1,19 @@
+import { PolicyEnhancement, QuoteRequestPurchaseOption } from '../types';
+interface CalculationArguments {
+    option: QuoteRequestPurchaseOption;
+    selectedEnhancements: PolicyEnhancement['id'][];
+    brokerFee?: number;
+}
+export declare function calcMonthlyEnhancementPrice(enhancement: PolicyEnhancement): number;
+/**
+ * Fix rounding errors we get from subtracting, and then adding GST back on
+ * (Issues with 2 decimal place rounding)
+ */
+export declare function fixRoundingError(premium: number): number;
+export declare function calcPurchaseOptionPricing({ option, selectedEnhancements, brokerFee }: CalculationArguments): {
+    monthly: number;
+    annually: number;
+    monthlyWithGst: number;
+    annuallyWithGst: number;
+};
+export {};

package/dist/lib/clickOutside.d.ts

@@ -0,0 +1 @@
+export declare function useClickOutside(ref: any, handler: (e: Event) => void): void;

package/dist/lib/dates.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Formats a date like "Jan 1, 2022 at 9:50am"
+ */
+export declare function formatDateNice(date: string | null | undefined, includeTime?: boolean): string;
+/**
+ * Formats a date like "01/01/2022 09:50"
+ */
+export declare function formatDateForTable(date: string | null | undefined, includeTime?: boolean): string;
+/**
+ * Formats a date to Star Insure standard format - dd/mm/yyyy
+ */
+export declare function formatDate(date: Date | string | null | undefined, overrideFormatString?: string): string;
+/**
+ * Formats a dateTime to Star Insure standard format - dd/mm/yyyy hh:mm
+ */
+export declare function formatDateTime(dateTime: Date | string | null | undefined, overrideFormatString?: string): string;
+/**
+ * Attempts to create a date object from a date string
+ */
+export declare function createDate(dateString: Date | string | null | undefined): Date | null;

package/dist/lib/fetch.d.ts

@@ -0,0 +1,20 @@
+type FetchOptions = {
+    url: string;
+    method?: 'GET' | 'POST' | 'PUT' | 'DELETE';
+    params?: Record<string, any>;
+    headers?: Record<string, string>;
+};
+type FetcherFunction<T> = () => Promise<{
+    ok: false;
+    message: string | undefined;
+    data?: undefined;
+} | {
+    ok: true;
+    data?: T;
+    message: string | undefined;
+}>;
+/**
+ * A helper to return a fetch function including default headers and authorization.
+ */
+export declare function useFetch<T = any>({ url: baseUrl, method, params, headers, }: FetchOptions): FetcherFunction<T>;
+export {};

package/dist/lib/index.d.ts

@@ -0,0 +1,14 @@
+export * from './dates';
+export * from './money';
+export * from './vehicles';
+export * from './auth';
+export * from './clickOutside';
+export * from './inertiaOptions';
+export * from './localStorage';
+export * from './toast';
+export * from './quoteRequestForm';
+export * from './quoteRequestOptions';
+export * from './addressFinder';
+export * from './calculateAge';
+export * from './calculatePricing';
+export * from './fetch';

package/dist/lib/inertiaOptions.d.ts

@@ -0,0 +1,6 @@
+import { VisitOptions } from '@inertiajs/core';
+interface Options {
+    successMessage?: string;
+}
+export declare function useInertiaOptions({ successMessage }?: Options): VisitOptions;
+export {};

package/dist/lib/localStorage.d.ts

@@ -0,0 +1 @@
+export declare function useLocalStorage<T>(key: string, initialValue: T): readonly [T, (value: T | ((val: T) => T)) => void];

package/dist/lib/money.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Safely rounds a number
+ */
+export declare function round(value: number): number;
+/**
+ * Gets the GST value from a number
+ */
+export declare function getGst(value: number): number;
+/**
+ * Adds GST to a number
+ */
+export declare function addGst(value: number): number;
+/**
+ * Subtracts GST from a number
+ */
+export declare function subtractGst(value: number): number;
+/**
+ * Calculates the various GST values on a figure
+ */
+export declare function gstCalc(input: number | string): {
+    gst: number;
+    amountInclusive: number;
+    amountExclusive: number;
+};
+/**
+ * Formats a value nicely
+ */
+export declare function formatMoney(value: string | number | null | undefined, decimals?: number): string;
+/**
+ * Turns a formatted value in to a float
+ */
+export declare function formatNumber(value: string): number;

package/dist/lib/page.d.ts

@@ -0,0 +1,19 @@
+import { Page, PageProps } from '@inertiajs/core';
+import { AuthContext, Breadcrumb, Environment } from '../types';
+/**
+ * Add custom props here, that are defined in `app/Http/Middleware/HandleInertiaRequests.php`
+ */
+type CustomPageProps = {
+    env: Environment;
+    breadcrumbs?: Breadcrumb[];
+    links: Record<string, string>;
+    access_token?: string;
+    impersonate_id?: number;
+    csrf_token?: string;
+    auth: AuthContext;
+} & PageProps;
+/**
+ * A wrapper around Inertia's usePage function that gives better type-safety
+ */
+export declare function usePage<T>(): Page<CustomPageProps & T>;
+export {};

package/dist/lib/quoteRequestForm.d.ts

@@ -0,0 +1,21 @@
+import { default as React } from 'react';
+import { InertiaFormProps } from '@inertiajs/react/types/useForm';
+import { QuoteRequest } from '../types';
+type QuoteRequestForm = QuoteRequest & Record<string, any>;
+interface QuoteRequestFormContextInterface {
+    form?: InertiaFormProps<QuoteRequestForm>;
+    handleChange?: (e: React.ChangeEvent<HTMLInputElement | HTMLTextAreaElement | HTMLSelectElement>) => void;
+    clear: () => void;
+}
+export declare const initialData: QuoteRequestForm;
+export declare const QuoteRequestFormContext: React.Context<QuoteRequestFormContextInterface>;
+export declare function QuoteRequestFormProvider({ children }: {
+    children: React.ReactNode;
+}): React.JSX.Element;
+/**
+ * Takes in a quote request and returns data suitable to populate a form
+ * by recursively calling this function, converting null to undefined.
+ */
+export declare function sanitiseQuoteRequestFormData(value: any): any;
+export declare const useQuoteRequestForm: () => QuoteRequestFormContextInterface;
+export {};

package/dist/lib/quoteRequestOptions.d.ts

@@ -0,0 +1,11 @@
+import { default as React } from 'react';
+import { QuoteRequestOptions } from '../types';
+interface QuoteRequestFormContextInterface {
+    options?: QuoteRequestOptions;
+    setOptions: (options: QuoteRequestOptions) => void;
+}
+export declare function QuoteRequestOptionsProvider({ children }: {
+    children: React.ReactNode;
+}): React.JSX.Element;
+export declare const useQuoteRequestOptions: () => QuoteRequestFormContextInterface;
+export {};

package/dist/lib/toast.d.ts

@@ -0,0 +1,10 @@
+import { Toast } from '../types';
+import * as React from 'react';
+interface ToastContextInterface {
+    toasts: Toast[];
+    addToast: (toast: Toast) => void;
+    removeToast: (id: Toast['_id']) => void;
+}
+export declare function ToastProvider({ children }: any): React.JSX.Element;
+export declare const useToast: () => ToastContextInterface;
+export {};

package/dist/lib/vehicles.d.ts

@@ -0,0 +1,2 @@
+import { VehicleType } from '../types';
+export declare function sanitiseVehicleType(inputType: string): VehicleType;