@trackunit/irisx-proxy 0.0.4 → 0.0.8

package/index.cjs.js

@@ -2,6 +2,7 @@
 
 var zod = require('zod');
 var client = require('@apollo/client');
+var sharedUtils = require('@trackunit/shared-utils');
 var react = require('react');
 
 /**
@@ -114,10 +115,10 @@ const IrisAppProxyFetchDocument = {
 /**
  * Validates and parses the response body.
  *
- * @template T - The type inferred from the response schema.
+ * @template TResponse - The type inferred from the response schema.
  * @param {string} responseBody - The base64-encoded response body from the API.
- * @param {z.ZodType<T>} responseSchema - The Zod schema used to validate and parse the response data.
- * @returns {T | null} The parsed and validated response data of type `T`, or `null` if validation fails.
+ * @param {z.ZodType<TResponse>} responseSchema - The Zod schema used to validate and parse the response data.
+ * @returns {TResponse| null} The parsed and validated response data of type `T`, or `null` if validation fails.
  */
 const validateAndParseResponse = (responseBody, responseSchema) => {
     const decodedBody = atob(responseBody);
@@ -134,9 +135,6 @@ const validateAndParseResponse = (responseBody, responseSchema) => {
  * This hook handles different layers of errors and responses from the provided endpoint through the IrisAppProxy.
  * For the auth token, we recommend saving it using the IrisAppProxyStoreSecrets mutation and including it in the requestOptions as one of the headers.
  * E.g. { name: "Authorization", value: `Bearer {{OAuthToken}}` }
- *
- * @param props - The properties for useIrisAppProxy hook.
- * @returns An object containing chatbot state and functions.
  */
 const useIrisAppProxy = (props) => {
     const { requestOptions, responseSchema, onSuccess, onError } = props;
@@ -226,7 +224,7 @@ const useIrisAppProxy = (props) => {
                 return;
             }
         }
-        catch (error) {
+        catch (err) {
             const localError = {
                 name: "Error",
                 message: JSON.stringify(error, null, 2),
@@ -248,10 +246,10 @@ const useIrisAppProxy = (props) => {
             return headersArray;
         }
         if (Array.isArray(headers)) {
-            return headers.map(([name, value]) => ({ name, value: value.toString() }));
+            return headers.map(([name, value]) => ({ name, value: value }));
         }
         if (typeof headers === "object") {
-            return Object.entries(headers).map(([name, value]) => ({ name, value: value.toString() }));
+            return sharedUtils.objectEntries(headers).map(([name, value]) => ({ name, value: value }));
         }
         return [];
     };

package/index.esm.js

@@ -1,5 +1,6 @@
 import { z } from 'zod';
 import { useMutation } from '@apollo/client';
+import { objectEntries } from '@trackunit/shared-utils';
 import { useState } from 'react';
 
 /**
@@ -112,10 +113,10 @@ const IrisAppProxyFetchDocument = {
 /**
  * Validates and parses the response body.
  *
- * @template T - The type inferred from the response schema.
+ * @template TResponse - The type inferred from the response schema.
  * @param {string} responseBody - The base64-encoded response body from the API.
- * @param {z.ZodType<T>} responseSchema - The Zod schema used to validate and parse the response data.
- * @returns {T | null} The parsed and validated response data of type `T`, or `null` if validation fails.
+ * @param {z.ZodType<TResponse>} responseSchema - The Zod schema used to validate and parse the response data.
+ * @returns {TResponse| null} The parsed and validated response data of type `T`, or `null` if validation fails.
  */
 const validateAndParseResponse = (responseBody, responseSchema) => {
     const decodedBody = atob(responseBody);
@@ -132,9 +133,6 @@ const validateAndParseResponse = (responseBody, responseSchema) => {
  * This hook handles different layers of errors and responses from the provided endpoint through the IrisAppProxy.
  * For the auth token, we recommend saving it using the IrisAppProxyStoreSecrets mutation and including it in the requestOptions as one of the headers.
  * E.g. { name: "Authorization", value: `Bearer {{OAuthToken}}` }
- *
- * @param props - The properties for useIrisAppProxy hook.
- * @returns An object containing chatbot state and functions.
  */
 const useIrisAppProxy = (props) => {
     const { requestOptions, responseSchema, onSuccess, onError } = props;
@@ -224,7 +222,7 @@ const useIrisAppProxy = (props) => {
                 return;
             }
         }
-        catch (error) {
+        catch (err) {
             const localError = {
                 name: "Error",
                 message: JSON.stringify(error, null, 2),
@@ -246,10 +244,10 @@ const useIrisAppProxy = (props) => {
             return headersArray;
         }
         if (Array.isArray(headers)) {
-            return headers.map(([name, value]) => ({ name, value: value.toString() }));
+            return headers.map(([name, value]) => ({ name, value: value }));
         }
         if (typeof headers === "object") {
-            return Object.entries(headers).map(([name, value]) => ({ name, value: value.toString() }));
+            return objectEntries(headers).map(([name, value]) => ({ name, value: value }));
         }
         return [];
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/irisx-proxy",
-  "version": "0.0.4",
+  "version": "0.0.8",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -16,7 +16,8 @@
     "@trackunit/iris-app-build-utilities": "*",
     "@trackunit/react-core-contexts-test": "*",
     "zod": "3.22.4",
-    "jest-fetch-mock": "^3.0.3"
+    "jest-fetch-mock": "^3.0.3",
+    "@trackunit/shared-utils": "*"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",

package/src/useProxy.d.ts

@@ -1,9 +1,9 @@
 import { z } from "zod";
 import { IrisAppProxyRequestOptions } from "./schema";
-export interface UseIrisAppProxyProps<R> {
+export interface UseIrisAppProxyProps<TResponse> {
     requestOptions: IrisAppProxyRequestOptions;
-    responseSchema: z.ZodType<R>;
-    onSuccess?: (data: R) => void;
+    responseSchema: z.ZodType<TResponse>;
+    onSuccess?: (data: TResponse) => void;
     onError?: (error: {
         name: string;
         message: string;
@@ -18,14 +18,11 @@ export interface ProxyError {
  * This hook handles different layers of errors and responses from the provided endpoint through the IrisAppProxy.
  * For the auth token, we recommend saving it using the IrisAppProxyStoreSecrets mutation and including it in the requestOptions as one of the headers.
  * E.g. { name: "Authorization", value: `Bearer {{OAuthToken}}` }
- *
- * @param props - The properties for useIrisAppProxy hook.
- * @returns An object containing chatbot state and functions.
  */
-export declare const useIrisAppProxy: <R>(props: UseIrisAppProxyProps<R>) => {
-    data: R | null;
+export declare const useIrisAppProxy: <TResponse>(props: UseIrisAppProxyProps<TResponse>) => {
+    data: TResponse | null;
     mutate: (request?: IrisAppProxyRequestOptions) => Promise<{
-        data?: R | undefined;
+        data?: TResponse | undefined;
         error?: ProxyError;
     } | undefined>;
     loading: boolean;

package/src/utils.d.ts

@@ -3,20 +3,20 @@ import { ProxyError } from "./useProxy";
 /**
  * Validates and parses the response body.
  *
- * @template T - The type inferred from the response schema.
+ * @template TResponse - The type inferred from the response schema.
  * @param {string} responseBody - The base64-encoded response body from the API.
- * @param {z.ZodType<T>} responseSchema - The Zod schema used to validate and parse the response data.
- * @returns {T | null} The parsed and validated response data of type `T`, or `null` if validation fails.
+ * @param {z.ZodType<TResponse>} responseSchema - The Zod schema used to validate and parse the response data.
+ * @returns {TResponse| null} The parsed and validated response data of type `T`, or `null` if validation fails.
  */
-export declare const validateAndParseResponse: <T>(responseBody: string, responseSchema: z.ZodType<T>) => {
-    data?: T;
+export declare const validateAndParseResponse: <TResponse>(responseBody: string, responseSchema: z.ZodType<TResponse>) => {
+    data?: TResponse;
     error?: ProxyError;
 };
 /**
  * Encodes the given request body as a base64 string.
  *
- * @template R - The type of the request body.
- * @param {R} body - The request body to be encoded.
+ * @template TRequest - The type of the request body.
+ * @param {TRequest} body - The request body to be encoded.
  * @returns {string} The base64-encoded string representation of the request body.
  */
-export declare const parseRequestBodyToBase64: <R>(body: R) => string;
+export declare const parseRequestBodyToBase64: <TRequest>(body: TRequest) => string;