@trackunit/irisx-proxy 0.0.18 → 0.0.21

package/index.cjs.js

@@ -142,6 +142,9 @@ const useIrisAppProxy = (props) => {
     const [proxyData, setProxyData] = react.useState(null);
     const [mutate, { loading }] = client.useMutation(IrisAppProxyFetchDocument);
     const createRequest = () => {
+        if (!requestOptions) {
+            return;
+        }
         const request = {
             ...requestOptions,
             headers: [{ name: "Accept-Profile", value: "default" }, ...requestOptions.headers],
@@ -162,7 +165,18 @@ const useIrisAppProxy = (props) => {
         var _a, _b;
         try {
             const proxyRequest = request !== null && request !== void 0 ? request : createRequest();
-            if (!proxyRequest) {
+            if (proxyRequest === null) {
+                // Request can't be parsed
+                return;
+            }
+            if (proxyRequest === undefined) {
+                // Request is not provided
+                const localError = {
+                    name: `Error to create request`,
+                    message: "The request doesn't follow IrisAppProxyRequestOptions schema or it's not provided.",
+                };
+                setError(localError);
+                onError && onError(localError);
                 return;
             }
             const { data, errors: gqlErrors } = await mutate({
@@ -334,8 +348,10 @@ const databricksTokenSchema = zod.z.object({
  *                                                 Stored encoded value: `bXlDbGllbnRJZDpteUNsaWVudFNlY3JldA==`
  *                                                 This key must be set up and stored in advance to successfully authenticate.
  * @param {string[]} tableNames - An array of table names that the token will grant access to.
+ * @param onSuccess - A callback function that will be called when the token is successfully retrieved.
+ * @param onError - A callback function that will be called when an error occurs during the token retrieval process.
  */
-const useDatabricksToken = ({ domainBase, encodedClientIdSecretVaultKey, tableNames, }) => {
+const useDatabricksToken = ({ domainBase, encodedClientIdSecretVaultKey, tableNames, onSuccess, onError, }) => {
     const encodedBody = react.useMemo(() => {
         const authorization_details = JSON.stringify(tableNames.map(tableName => ({
             type: "unity_catalog_permission",
@@ -360,6 +376,8 @@ const useDatabricksToken = ({ domainBase, encodedClientIdSecretVaultKey, tableNa
             body: encodedBody,
         },
         responseSchema: databricksTokenSchema,
+        onSuccess,
+        onError,
     });
     return react.useMemo(() => ({
         data: response.data,

package/index.esm.js

@@ -140,6 +140,9 @@ const useIrisAppProxy = (props) => {
     const [proxyData, setProxyData] = useState(null);
     const [mutate, { loading }] = useMutation(IrisAppProxyFetchDocument);
     const createRequest = () => {
+        if (!requestOptions) {
+            return;
+        }
         const request = {
             ...requestOptions,
             headers: [{ name: "Accept-Profile", value: "default" }, ...requestOptions.headers],
@@ -160,7 +163,18 @@ const useIrisAppProxy = (props) => {
         var _a, _b;
         try {
             const proxyRequest = request !== null && request !== void 0 ? request : createRequest();
-            if (!proxyRequest) {
+            if (proxyRequest === null) {
+                // Request can't be parsed
+                return;
+            }
+            if (proxyRequest === undefined) {
+                // Request is not provided
+                const localError = {
+                    name: `Error to create request`,
+                    message: "The request doesn't follow IrisAppProxyRequestOptions schema or it's not provided.",
+                };
+                setError(localError);
+                onError && onError(localError);
                 return;
             }
             const { data, errors: gqlErrors } = await mutate({
@@ -332,8 +346,10 @@ const databricksTokenSchema = z.object({
  *                                                 Stored encoded value: `bXlDbGllbnRJZDpteUNsaWVudFNlY3JldA==`
  *                                                 This key must be set up and stored in advance to successfully authenticate.
  * @param {string[]} tableNames - An array of table names that the token will grant access to.
+ * @param onSuccess - A callback function that will be called when the token is successfully retrieved.
+ * @param onError - A callback function that will be called when an error occurs during the token retrieval process.
  */
-const useDatabricksToken = ({ domainBase, encodedClientIdSecretVaultKey, tableNames, }) => {
+const useDatabricksToken = ({ domainBase, encodedClientIdSecretVaultKey, tableNames, onSuccess, onError, }) => {
     const encodedBody = useMemo(() => {
         const authorization_details = JSON.stringify(tableNames.map(tableName => ({
             type: "unity_catalog_permission",
@@ -358,6 +374,8 @@ const useDatabricksToken = ({ domainBase, encodedClientIdSecretVaultKey, tableNa
             body: encodedBody,
         },
         responseSchema: databricksTokenSchema,
+        onSuccess,
+        onError,
     });
     return useMemo(() => ({
         data: response.data,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/irisx-proxy",
-  "version": "0.0.18",
+  "version": "0.0.21",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {

package/src/useDatabricksToken.d.ts

@@ -1,7 +1,96 @@
+import { z } from "zod";
+import { ProxyError } from "./useIrisAppProxy";
+declare const databricksTokenSchema: z.ZodObject<{
+    access_token: z.ZodString;
+    authorization_details: z.ZodArray<z.ZodObject<{
+        securable_type: z.ZodString;
+        securable_object_name: z.ZodString;
+        operation: z.ZodString;
+        annotations: z.ZodObject<{
+            onlineViewName: z.ZodString;
+            onlineViewId: z.ZodString;
+            onlineViewMetastoreId: z.ZodString;
+            onlineViewClusterId: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            onlineViewName: string;
+            onlineViewId: string;
+            onlineViewMetastoreId: string;
+            onlineViewClusterId: string;
+        }, {
+            onlineViewName: string;
+            onlineViewId: string;
+            onlineViewMetastoreId: string;
+            onlineViewClusterId: string;
+        }>;
+        type: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        securable_type: string;
+        securable_object_name: string;
+        operation: string;
+        annotations: {
+            onlineViewName: string;
+            onlineViewId: string;
+            onlineViewMetastoreId: string;
+            onlineViewClusterId: string;
+        };
+    }, {
+        type: string;
+        securable_type: string;
+        securable_object_name: string;
+        operation: string;
+        annotations: {
+            onlineViewName: string;
+            onlineViewId: string;
+            onlineViewMetastoreId: string;
+            onlineViewClusterId: string;
+        };
+    }>, "many">;
+    scope: z.ZodString;
+    token_type: z.ZodString;
+    expires_in: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    access_token: string;
+    authorization_details: {
+        type: string;
+        securable_type: string;
+        securable_object_name: string;
+        operation: string;
+        annotations: {
+            onlineViewName: string;
+            onlineViewId: string;
+            onlineViewMetastoreId: string;
+            onlineViewClusterId: string;
+        };
+    }[];
+    scope: string;
+    token_type: string;
+    expires_in: number;
+}, {
+    access_token: string;
+    authorization_details: {
+        type: string;
+        securable_type: string;
+        securable_object_name: string;
+        operation: string;
+        annotations: {
+            onlineViewName: string;
+            onlineViewId: string;
+            onlineViewMetastoreId: string;
+            onlineViewClusterId: string;
+        };
+    }[];
+    scope: string;
+    token_type: string;
+    expires_in: number;
+}>;
+export type DatabricksTokenResponse = z.infer<typeof databricksTokenSchema>;
 interface UseDatabricksTokenProps {
     domainBase: string;
     encodedClientIdSecretVaultKey: string;
     tableNames: string[];
+    onSuccess?: (data: DatabricksTokenResponse) => void;
+    onError?: (error: ProxyError) => void;
 }
 /**
  * Hook for retrieving an access token to interact with Databricks.
@@ -13,8 +102,10 @@ interface UseDatabricksTokenProps {
  *                                                 Stored encoded value: `bXlDbGllbnRJZDpteUNsaWVudFNlY3JldA==`
  *                                                 This key must be set up and stored in advance to successfully authenticate.
  * @param {string[]} tableNames - An array of table names that the token will grant access to.
+ * @param onSuccess - A callback function that will be called when the token is successfully retrieved.
+ * @param onError - A callback function that will be called when an error occurs during the token retrieval process.
  */
-export declare const useDatabricksToken: ({ domainBase, encodedClientIdSecretVaultKey, tableNames, }: UseDatabricksTokenProps) => {
+export declare const useDatabricksToken: ({ domainBase, encodedClientIdSecretVaultKey, tableNames, onSuccess, onError, }: UseDatabricksTokenProps) => {
     data: {
         access_token: string;
         authorization_details: {
@@ -34,7 +125,7 @@ export declare const useDatabricksToken: ({ domainBase, encodedClientIdSecretVau
         expires_in: number;
     } | null;
     loading: boolean;
-    error: import("./useIrisAppProxy").ProxyError | null;
+    error: ProxyError | null;
     mutate: (request?: import("./schema").IrisAppProxyRequestOptions) => Promise<{
         data?: {
             access_token: string;
@@ -54,7 +145,7 @@ export declare const useDatabricksToken: ({ domainBase, encodedClientIdSecretVau
             token_type: string;
             expires_in: number;
         } | undefined;
-        error?: import("./useIrisAppProxy").ProxyError;
+        error?: ProxyError;
     } | undefined>;
 };
 export {};

package/src/useIrisAppProxy.d.ts

@@ -1,13 +1,10 @@
 import { z } from "zod";
 import { IrisAppProxyRequestOptions } from "./schema";
 export interface UseIrisAppProxyProps<TResponse> {
-    requestOptions: IrisAppProxyRequestOptions;
     responseSchema: z.ZodType<TResponse>;
+    requestOptions?: IrisAppProxyRequestOptions;
     onSuccess?: (data: TResponse) => void;
-    onError?: (error: {
-        name: string;
-        message: string;
-    }) => void;
+    onError?: (error: ProxyError) => void;
 }
 export interface ProxyError {
     name: string;