@opengeoweb/api 9.8.0 → 9.10.0

package/index.esm.js

@@ -424,9 +424,7 @@ typeof SuppressedError === "function" ? SuppressedError : function (error, suppr
 var generateRandomId = function generateRandomId() {
   return "-".concat(Math.random().toString(36).substr(2, 9));
 };
-var useApi = function useApi(
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-apiCall, params) {
+var useApi = function useApi(apiCall, params, callbacks) {
   var _useIsMounted = useIsMounted(),
     isMounted = _useIsMounted.isMounted;
   var _React$useState = React.useState(generateRandomId()),
@@ -445,9 +443,12 @@ apiCall, params) {
     result = _React$useState8[0],
     setResult = _React$useState8[1];
   var debouncedParams = useDebounce(JSON.stringify(params), 300);
+  // trick so that we don't have to include this in the useEffect dependency array (as it is likely that callbacks changes on every render)
+  var callbacksRef = React.useRef();
+  callbacksRef.current = callbacks;
   var fetchApiData = function fetchApiData(_params) {
     return __awaiter(void 0, void 0, void 0, /*#__PURE__*/_regeneratorRuntime().mark(function _callee() {
-      var response;
+      var _a, _b, _c, _d, response, data;
       return _regeneratorRuntime().wrap(function _callee$(_context) {
         while (1) switch (_context.prev = _context.next) {
           case 0:
@@ -459,9 +460,11 @@ apiCall, params) {
           case 5:
             response = _context.sent;
             if (isMounted.current) {
-              setResult(Array.isArray(response) ? response.map(function (d) {
+              data = Array.isArray(response) ? response.map(function (d) {
                 return d.data;
-              }) : response.data);
+              }) : response.data;
+              (_b = (_a = callbacksRef.current) === null || _a === void 0 ? void 0 : _a.onSuccess) === null || _b === void 0 ? void 0 : _b.call(_a, data);
+              setResult(data);
               setIsloading(false);
               setError(null);
             }
@@ -474,6 +477,7 @@ apiCall, params) {
               if (axios.isCancel(_context.t0)) {
                 setIsloading(false);
               } else {
+                (_d = (_c = callbacksRef.current) === null || _c === void 0 ? void 0 : _c.onError) === null || _d === void 0 ? void 0 : _d.call(_c, _context.t0);
                 setError(_context.t0);
                 setIsloading(false);
               }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opengeoweb/api",
-  "version": "9.8.0",
+  "version": "9.10.0",
   "description": "GeoWeb API library for the opengeoweb project",
   "license": "Apache-2.0",
   "repository": {

package/src/lib/components/ApiContext/types.d.ts

@@ -12,12 +12,12 @@ export interface Credentials {
     keep_session_alive_at?: number;
     has_connection_issue?: boolean;
 }
-export type ApiUrls = {
+export interface ApiUrls {
     baseURL?: string;
     appURL?: string;
     authTokenURL?: string;
     authClientId?: string;
-};
+}
 export interface ApiModule {
     auth?: Credentials;
     onSetAuth?: (cred: Credentials) => void;

package/src/lib/components/apihooks/useApi.d.ts

@@ -1,12 +1,36 @@
 import { ConfigType } from '@opengeoweb/shared';
-export type ApiParams = string | ConfigType | {
-    [key: string]: string | undefined;
-} | null;
-export interface ApiHookProps {
-    isLoading: boolean;
-    error: Error;
-    result: any;
+export type ApiParams = string | ConfigType | Record<string, string | undefined> | null;
+interface BaseApiHookProps {
     fetchApiData?: (params: ApiParams) => Promise<void>;
     clearResults?: () => void;
 }
-export declare const useApi: (apiCall?: ((params?: ApiParams, id?: string) => Promise<any>) | undefined, params?: ApiParams) => ApiHookProps;
+type PendingApiHookProps = BaseApiHookProps & {
+    isLoading: true;
+    result: null;
+    error: null;
+};
+type DoneApiHookProps<R> = BaseApiHookProps & {
+    isLoading: false;
+    result: R;
+    error: null;
+};
+type ErrorApiHookProps = BaseApiHookProps & {
+    isLoading: false;
+    result: null;
+    error: Error;
+};
+export type ApiHookProps<TData> = ErrorApiHookProps | PendingApiHookProps | DoneApiHookProps<TData>;
+interface Callbacks<TData> {
+    onSuccess?: (data: TData) => void;
+    onError?: (e: Error) => void;
+}
+export declare const useApi: <TResponse extends {
+    data: unknown;
+} | {
+    data: unknown;
+}[], TResult = TResponse extends {
+    data: infer TData;
+}[] ? TData[] : TResponse extends {
+    data: infer TData_1;
+} ? TData_1 : never>(apiCall?: ((params?: ApiParams, id?: string) => Promise<TResponse>) | undefined, params?: ApiParams, callbacks?: Callbacks<TResult> | undefined) => ApiHookProps<TResult>;
+export {};