@star-insure/sdk 4.3.1 → 4.3.2

package/dist/lib/fetch.d.ts

@@ -0,0 +1,20 @@
+declare type FetchOptions = {
+    url: string;
+    method?: 'GET' | 'POST' | 'PUT' | 'DELETE';
+    params?: Record<string, any>;
+    headers?: Record<string, string>;
+};
+declare 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/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": "4.3.1",
+    "version": "4.3.2",
     "license": "MIT",
     "repository": {
         "type": "git",

package/src/lib/fetch.tsx

@@ -0,0 +1,81 @@
+import React from 'react';
+import { usePage } from './page';
+
+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 function useFetch<T = any>({
+    url: baseUrl,
+    method = 'GET',
+    params = {},
+    headers = {},
+}: FetchOptions): FetcherFunction<T> {
+    const { access_token } = usePage().props;
+
+    let url = baseUrl;
+
+    if (method === 'GET') {
+        const queryParams = new URLSearchParams(params);
+        url = `${url}?${queryParams.toString()}`;
+    }
+
+    return React.useMemo(
+        () => async () => {
+            const res = await fetch(url, {
+                method,
+                headers: {
+                    'Content-Type': 'application/json',
+                    Accept: 'application/json',
+                    Authorization: access_token ? `Bearer ${access_token}` : '',
+                    ...headers,
+                },
+                body: Object.keys(params).length > 0 && method !== 'GET' ? JSON.stringify(params) : null,
+            });
+
+            const { ok } = res;
+            const body = await res.text();
+
+            let parsedBody: T | string = body;
+
+            try {
+                parsedBody = JSON.parse(body) as T;
+            } catch (error) {
+                // Response wasn't JSON, just use the text version.
+            }
+
+            const message = typeof parsedBody === 'string' ? parsedBody : undefined;
+
+            if (!ok) {
+                return {
+                    ok,
+                    message,
+                };
+            }
+
+            const data = typeof parsedBody !== 'string' ? parsedBody : undefined;
+
+            return { ok, data, message };
+        },
+        [access_token, url, params, headers, method],
+    );
+}