@cccsaurora/howler-ui 2.19.0-dev.1000 → 2.19.0-dev.1023

package/api/action/index.d.ts

@@ -1,10 +1,11 @@
+import { type HowlerRefreshParam } from '@cccsaurora/howler-ui/api';
 import * as execute from '@cccsaurora/howler-ui/api/action/execute';
 import * as operations from '@cccsaurora/howler-ui/api/action/operations';
 import type { Action } from '@cccsaurora/howler-ui/models/entities/generated/Action';
 export declare const uri: (id?: string) => string;
 export declare const get: (id: string) => Promise<Action>;
-export declare const post: (data: Action) => Promise<Action>;
-export declare const put: (id: string, data: Action) => Promise<Action>;
-export declare const patch: (id: string, data: Action) => Promise<Action>;
-export declare const del: (id: string) => Promise<void>;
+export declare const post: (data: Action, refresh?: HowlerRefreshParam) => Promise<Action>;
+export declare const put: (id: string, data: Action, refresh?: HowlerRefreshParam) => Promise<Action>;
+export declare const patch: (id: string, data: Action, refresh?: HowlerRefreshParam) => Promise<Action>;
+export declare const del: (id: string, refresh?: HowlerRefreshParam) => Promise<void>;
 export { execute, operations };

package/api/action/index.js

@@ -13,16 +13,16 @@ export const get = (id) => {
     })
         .then(res => res.items[0]);
 };
-export const post = (data) => {
-    return hpost(uri(), data);
+export const post = (data, refresh) => {
+    return hpost(uri(), data, {}, refresh ? new URLSearchParams({ refresh }) : undefined);
 };
-export const put = (id, data) => {
-    return hput(uri(id), data);
+export const put = (id, data, refresh) => {
+    return hput(uri(id), data, {}, refresh ? new URLSearchParams({ refresh }) : undefined);
 };
-export const patch = (id, data) => {
-    return hpatch(uri(id), data);
+export const patch = (id, data, refresh) => {
+    return hpatch(uri(id), data, {}, refresh ? new URLSearchParams({ refresh }) : undefined);
 };
-export const del = (id) => {
-    return hdelete(uri(id));
+export const del = (id, refresh) => {
+    return hdelete(uri(id), undefined, undefined, refresh ? new URLSearchParams({ refresh }) : undefined);
 };
 export { execute, operations };

package/api/analytic/index.d.ts

@@ -1,3 +1,4 @@
+import { type HowlerRefreshParam } from '@cccsaurora/howler-ui/api';
 import * as comments from '@cccsaurora/howler-ui/api/analytic/comments';
 import * as favourite from '@cccsaurora/howler-ui/api/analytic/favourite';
 import * as notebooks from '@cccsaurora/howler-ui/api/analytic/notebooks';
@@ -7,6 +8,6 @@ import type { Analytic } from '@cccsaurora/howler-ui/models/entities/generated/A
 export type EditOptions = Pick<Analytic, 'description' | 'rule' | 'rule_crontab' | 'triage_settings'>;
 export declare const uri: (id?: string) => string;
 export declare const get: (id?: string) => Promise<Analytic> | Promise<Analytic[]>;
-export declare const put: (id: string, editData: EditOptions) => Promise<Analytic>;
-export declare const del: (id: string) => Promise<any>;
+export declare const put: (id: string, editData: EditOptions, refresh?: HowlerRefreshParam) => Promise<Analytic>;
+export declare const del: (id: string, refresh?: HowlerRefreshParam) => Promise<void>;
 export { comments, favourite, notebooks, owner, rules };

package/api/analytic/index.js

@@ -10,10 +10,10 @@ export const uri = (id) => {
 export const get = (id) => {
     return id ? hget(uri(id)) : hget(uri());
 };
-export const put = (id, editData) => {
-    return hput(uri(id), editData);
+export const put = (id, editData, refresh) => {
+    return hput(uri(id), editData, undefined, refresh ? new URLSearchParams({ refresh }) : undefined);
 };
-export const del = (id) => {
-    return hdelete(uri(id));
+export const del = (id, refresh) => {
+    return hdelete(uri(id), undefined, undefined, refresh ? new URLSearchParams({ refresh }) : undefined);
 };
 export { comments, favourite, notebooks, owner, rules };

package/api/analytic/owner.d.ts

@@ -1,5 +1,6 @@
+import { type HowlerRefreshParam } from '@cccsaurora/howler-ui/api';
 import type { Analytic } from '@cccsaurora/howler-ui/models/entities/generated/Analytic';
 export declare const uri: (id: string) => string;
 export declare const post: (id: string, body: {
     username: string;
-}) => Promise<Analytic>;
+}, refresh?: HowlerRefreshParam) => Promise<Analytic>;

package/api/analytic/owner.js

@@ -3,6 +3,6 @@ import { uri as parentUri } from '@cccsaurora/howler-ui/api/analytic';
 export const uri = (id) => {
     return joinAllUri(parentUri(), id, 'owner');
 };
-export const post = (id, body) => {
-    return hpost(uri(id), body);
+export const post = (id, body, refresh) => {
+    return hpost(uri(id), body, undefined, refresh ? new URLSearchParams({ refresh }) : undefined);
 };

package/api/analytic/rules.d.ts

@@ -1,3 +1,4 @@
+import { type HowlerRefreshParam } from '@cccsaurora/howler-ui/api';
 import type { Analytic } from '@cccsaurora/howler-ui/models/entities/generated/Analytic';
 export declare const uri: () => string;
-export declare const post: (body: Pick<Analytic, "description" | "name" | "rule" | "rule_type" | "rule_crontab">) => Promise<Analytic>;
+export declare const post: (body: Pick<Analytic, "description" | "name" | "rule" | "rule_type" | "rule_crontab">, refresh?: HowlerRefreshParam) => Promise<Analytic>;

package/api/analytic/rules.js

@@ -3,6 +3,6 @@ import { uri as parentUri } from '@cccsaurora/howler-ui/api/analytic';
 export const uri = () => {
     return joinUri(parentUri(), 'rules');
 };
-export const post = (body) => {
-    return hpost(uri(), body);
+export const post = (body, refresh) => {
+    return hpost(uri(), body, undefined, refresh ? new URLSearchParams({ refresh }) : undefined);
 };

package/api/dossier/index.d.ts

@@ -1,8 +1,9 @@
+import { type HowlerRefreshParam } from '@cccsaurora/howler-ui/api';
 import type { Dossier } from '@cccsaurora/howler-ui/models/entities/generated/Dossier';
 import * as hit from './hit';
 export declare const uri: (id?: string) => string;
 export declare const get: (id?: string) => Promise<Dossier | Dossier[]>;
-export declare const post: (newData: Partial<Dossier>) => Promise<Dossier>;
-export declare const put: (id: string, dossier: Partial<Dossier>) => Promise<Dossier>;
-export declare const del: (id: string) => Promise<void>;
+export declare const post: (newData: Partial<Dossier>, refresh?: HowlerRefreshParam) => Promise<Dossier>;
+export declare const put: (id: string, dossier: Partial<Dossier>, refresh?: HowlerRefreshParam) => Promise<Dossier>;
+export declare const del: (id: string, refresh?: HowlerRefreshParam) => Promise<void>;
 export { hit };

package/api/dossier/index.js

@@ -7,13 +7,13 @@ export const uri = (id) => {
 export const get = (id) => {
     return hget(uri(id));
 };
-export const post = (newData) => {
-    return hpost(uri(), newData);
+export const post = (newData, refresh) => {
+    return hpost(uri(), newData, undefined, refresh ? new URLSearchParams({ refresh }) : undefined);
 };
-export const put = (id, dossier) => {
-    return hput(uri(id), dossier);
+export const put = (id, dossier, refresh) => {
+    return hput(uri(id), dossier, undefined, refresh ? new URLSearchParams({ refresh }) : undefined);
 };
-export const del = (id) => {
-    return hdelete(uri(id));
+export const del = (id, refresh) => {
+    return hdelete(uri(id), undefined, undefined, refresh ? new URLSearchParams({ refresh }) : undefined);
 };
 export { hit };

package/api/hit/index.d.ts

@@ -1,3 +1,4 @@
+import { type HowlerRefreshParam } from '@cccsaurora/howler-ui/api';
 import * as assign from '@cccsaurora/howler-ui/api/hit/assign';
 import * as comments from '@cccsaurora/howler-ui/api/hit/comments';
 import * as labels from '@cccsaurora/howler-ui/api/hit/labels';
@@ -28,8 +29,8 @@ interface PostResponse {
         error: string;
     }[];
 }
-export declare const post: (hits: Hit[]) => Promise<PostResponse>;
-export declare const del: (ids: string[]) => Promise<{
+export declare const post: (hits: Hit[], refresh?: HowlerRefreshParam) => Promise<PostResponse>;
+export declare const del: (ids: string[], refresh?: HowlerRefreshParam) => Promise<{
     success: boolean;
 }>;
 export { assign, comments, labels, overwrite, transition };

package/api/hit/index.js

@@ -14,10 +14,10 @@ export const get = (id, metadata) => {
     }
     return hget(uri(id), params);
 };
-export const post = (hits) => {
-    return hpost(uri(), hits);
+export const post = (hits, refresh) => {
+    return hpost(uri(), hits, undefined, refresh ? new URLSearchParams({ refresh }) : undefined);
 };
-export const del = (ids) => {
-    return hdelete(uri(), ids);
+export const del = (ids, refresh) => {
+    return hdelete(uri(), ids, undefined, refresh ? new URLSearchParams({ refresh }) : undefined);
 };
 export { assign, comments, labels, overwrite, transition };

package/api/hit/labels.d.ts

@@ -1,5 +1,6 @@
+import { type HowlerRefreshParam } from '@cccsaurora/howler-ui/api';
 import type { LabelActionBody } from '@cccsaurora/howler-ui/api/hit';
 import type { Hit } from '@cccsaurora/howler-ui/models/entities/generated/Hit';
 export declare const uri: (id: string, category: string) => string;
-export declare const put: (id: string, category: string, body: LabelActionBody) => Promise<Hit>;
-export declare const del: (id: string, category: string, body: LabelActionBody) => Promise<Hit>;
+export declare const put: (id: string, category: string, body: LabelActionBody, refresh?: HowlerRefreshParam) => Promise<Hit>;
+export declare const del: (id: string, category: string, body: LabelActionBody, refresh?: HowlerRefreshParam) => Promise<Hit>;

package/api/hit/labels.js

@@ -3,9 +3,9 @@ import { uri as parentUri } from '@cccsaurora/howler-ui/api/hit';
 export const uri = (id, category) => {
     return joinAllUri(parentUri(), id, 'labels', category);
 };
-export const put = (id, category, body) => {
-    return hput(uri(id, category), body);
+export const put = (id, category, body, refresh) => {
+    return hput(uri(id, category), body, undefined, refresh ? new URLSearchParams({ refresh }) : undefined);
 };
-export const del = (id, category, body) => {
-    return hdelete(uri(id, category), body);
+export const del = (id, category, body, refresh) => {
+    return hdelete(uri(id, category), body, undefined, refresh ? new URLSearchParams({ refresh }) : undefined);
 };

package/api/hit/overwrite.d.ts

@@ -1,3 +1,4 @@
+import { type HowlerRefreshParam } from '@cccsaurora/howler-ui/api';
 import type { Hit } from '@cccsaurora/howler-ui/models/entities/generated/Hit';
 export declare const uri: (id: string) => string;
-export declare const put: <T extends Hit = Hit>(id: string, body: Partial<T>) => Promise<T>;
+export declare const put: <T extends Hit = Hit>(id: string, body: Partial<T>, refresh?: HowlerRefreshParam) => Promise<T>;

package/api/hit/overwrite.js

@@ -3,6 +3,6 @@ import { uri as parentUri } from '@cccsaurora/howler-ui/api/hit';
 export const uri = (id) => {
     return joinAllUri(parentUri(), id, 'overwrite');
 };
-export const put = (id, body) => {
-    return hput(uri(id), body);
+export const put = (id, body, refresh) => {
+    return hput(uri(id), body, undefined, refresh ? new URLSearchParams({ refresh }) : undefined);
 };

package/api/hit/transition.d.ts

@@ -1,4 +1,5 @@
+import { type HowlerRefreshParam } from '@cccsaurora/howler-ui/api';
 import type { HitTransitionBody } from '@cccsaurora/howler-ui/api/hit';
 import type { Hit } from '@cccsaurora/howler-ui/models/entities/generated/Hit';
 export declare const uri: (id: string) => string;
-export declare const post: (id: string, body: HitTransitionBody) => Promise<Hit>;
+export declare const post: (id: string, body: HitTransitionBody, refresh?: HowlerRefreshParam) => Promise<Hit>;

package/api/hit/transition.js

@@ -3,6 +3,6 @@ import { uri as parentUri } from '@cccsaurora/howler-ui/api/hit';
 export const uri = (id) => {
     return joinAllUri(parentUri(), id, 'transition');
 };
-export const post = (id, body) => {
-    return hpost(uri(id), body);
+export const post = (id, body, refresh) => {
+    return hpost(uri(id), body, undefined, refresh ? new URLSearchParams({ refresh }) : undefined);
 };

package/api/index.d.ts

@@ -38,6 +38,7 @@ export type HowlerResponse<R> = {
     api_server_version: string;
     api_status_code: number;
 };
+export type HowlerRefreshParam = 'true' | 'false' | 'wait_for';
 /**
  * The base section of the Howler API uri.
  *
@@ -106,7 +107,7 @@ export declare const hget: <R = any>(_uri: string, searchParams?: URLSearchParam
  * @param body - the body of the request.
  * @returns the `api_response` object of the returned {@link HowlerResponse}.
  */
-export declare const hpost: <R = any>(_uri: string, body: any, headers?: HeadersInit) => Promise<R>;
+export declare const hpost: <R = any>(_uri: string, body: any, headers?: HeadersInit, searchParams?: URLSearchParams) => Promise<R>;
 /**
  * Peform an HTTP PUT for the specified uri and body data.
  *
@@ -116,7 +117,7 @@ export declare const hpost: <R = any>(_uri: string, body: any, headers?: Headers
  * @param body - the body of the request.
  * @returns the `api_response` object of the returned {@link HowlerResponse}.
  */
-export declare const hput: <R = any>(_uri: string, body: any, headers?: HeadersInit) => Promise<R>;
+export declare const hput: <R = any>(_uri: string, body: any, headers?: HeadersInit, searchParams?: URLSearchParams) => Promise<R>;
 /**
  * Peform an HTTP PATCH for the specified uri and body data.
  *
@@ -126,7 +127,7 @@ export declare const hput: <R = any>(_uri: string, body: any, headers?: HeadersI
  * @param body - the body of the request.
  * @returns the `api_response` object of the returned {@link HowlerResponse}.
  */
-export declare const hpatch: <R = any>(_uri: string, body: any, headers?: HeadersInit) => Promise<R>;
+export declare const hpatch: <R = any>(_uri: string, body: any, headers?: HeadersInit, searchParams?: URLSearchParams) => Promise<R>;
 /**
  * Performa an HTTP DELETE for the specified uri.
  *
@@ -135,7 +136,7 @@ export declare const hpatch: <R = any>(_uri: string, body: any, headers?: Header
  * @param _uri - the uri to fetch.
  * @returns the `api_response` object of the returned {@link HowlerResponse}.
  */
-export declare const hdelete: <R = any>(_uri: string, body?: any, headers?: HeadersInit) => Promise<R>;
+export declare const hdelete: <R = any>(_uri: string, body?: any, headers?: HeadersInit, searchParams?: URLSearchParams) => Promise<R>;
 /**
  * Default export exposing the howler rest api
  */

package/api/index.js

@@ -196,8 +196,8 @@ export const hget = (_uri, searchParams, headers = {}) => {
  * @param body - the body of the request.
  * @returns the `api_response` object of the returned {@link HowlerResponse}.
  */
-export const hpost = (_uri, body, headers = {}) => {
-    return hfetch(_uri, 'post', body, undefined, headers);
+export const hpost = (_uri, body, headers = {}, searchParams) => {
+    return hfetch(_uri, 'post', body, searchParams, headers);
 };
 /**
  * Peform an HTTP PUT for the specified uri and body data.
@@ -208,8 +208,8 @@ export const hpost = (_uri, body, headers = {}) => {
  * @param body - the body of the request.
  * @returns the `api_response` object of the returned {@link HowlerResponse}.
  */
-export const hput = (_uri, body, headers = {}) => {
-    return hfetch(_uri, 'put', body, undefined, headers);
+export const hput = (_uri, body, headers = {}, searchParams) => {
+    return hfetch(_uri, 'put', body, searchParams, headers);
 };
 /**
  * Peform an HTTP PATCH for the specified uri and body data.
@@ -220,8 +220,8 @@ export const hput = (_uri, body, headers = {}) => {
  * @param body - the body of the request.
  * @returns the `api_response` object of the returned {@link HowlerResponse}.
  */
-export const hpatch = (_uri, body, headers = {}) => {
-    return hfetch(_uri, 'patch', body, undefined, headers);
+export const hpatch = (_uri, body, headers = {}, searchParams) => {
+    return hfetch(_uri, 'patch', body, searchParams, headers);
 };
 /**
  * Performa an HTTP DELETE for the specified uri.
@@ -231,8 +231,8 @@ export const hpatch = (_uri, body, headers = {}) => {
  * @param _uri - the uri to fetch.
  * @returns the `api_response` object of the returned {@link HowlerResponse}.
  */
-export const hdelete = (_uri, body = null, headers = {}) => {
-    return hfetch(_uri, 'delete', body, undefined, headers);
+export const hdelete = (_uri, body = null, headers = {}, searchParams) => {
+    return hfetch(_uri, 'delete', body, searchParams, headers);
 };
 /**
  * Default export exposing the howler rest api

package/api/overview/index.d.ts

@@ -1,6 +1,7 @@
+import { type HowlerRefreshParam } from '@cccsaurora/howler-ui/api';
 import type { Overview } from '@cccsaurora/howler-ui/models/entities/generated/Overview';
 export declare const uri: (id?: string) => string;
 export declare const get: () => Promise<Overview[]>;
-export declare const post: (newData: Partial<Overview>) => Promise<Overview>;
-export declare const put: (id: string, content: string) => Promise<Overview>;
-export declare const del: (id: string) => Promise<void>;
+export declare const post: (newData: Partial<Overview>, refresh?: HowlerRefreshParam) => Promise<Overview>;
+export declare const put: (id: string, content: string, refresh?: HowlerRefreshParam) => Promise<Overview>;
+export declare const del: (id: string, refresh?: HowlerRefreshParam) => Promise<void>;

package/api/overview/index.js

@@ -5,12 +5,12 @@ export const uri = (id) => {
 export const get = () => {
     return hget(uri());
 };
-export const post = (newData) => {
-    return hpost(uri(), newData);
+export const post = (newData, refresh) => {
+    return hpost(uri(), newData, undefined, refresh ? new URLSearchParams({ refresh }) : undefined);
 };
-export const put = (id, content) => {
-    return hput(uri(id), { content });
+export const put = (id, content, refresh) => {
+    return hput(uri(id), { content }, undefined, refresh ? new URLSearchParams({ refresh }) : undefined);
 };
-export const del = (id) => {
-    return hdelete(uri(id));
+export const del = (id, refresh) => {
+    return hdelete(uri(id), undefined, undefined, refresh ? new URLSearchParams({ refresh }) : undefined);
 };

package/api/search/overview.d.ts

@@ -1,4 +1,4 @@
 import type { HowlerSearchRequest, HowlerSearchResponse } from '@cccsaurora/howler-ui/api/search';
-import type { Template } from '@cccsaurora/howler-ui/models/entities/generated/Template';
+import type { Overview } from '@cccsaurora/howler-ui/models/entities/generated/Overview';
 export declare const uri: () => string;
-export declare const post: (request?: HowlerSearchRequest) => Promise<HowlerSearchResponse<Template>>;
+export declare const post: (request?: HowlerSearchRequest) => Promise<HowlerSearchResponse<Overview>>;

package/api/template/index.d.ts

@@ -1,6 +1,7 @@
+import { type HowlerRefreshParam } from '@cccsaurora/howler-ui/api';
 import type { Template } from '@cccsaurora/howler-ui/models/entities/generated/Template';
 export declare const uri: (id?: string) => string;
 export declare const get: () => Promise<Template[]>;
-export declare const post: (newData: Partial<Template>) => Promise<Template>;
-export declare const put: (id: string, newFields: string[]) => Promise<Template>;
-export declare const del: (id: string) => Promise<void>;
+export declare const post: (newData: Partial<Template>, refresh?: HowlerRefreshParam) => Promise<Template>;
+export declare const put: (id: string, newFields: string[], refresh?: HowlerRefreshParam) => Promise<Template>;
+export declare const del: (id: string, refresh?: HowlerRefreshParam) => Promise<void>;

package/api/template/index.js

@@ -5,12 +5,12 @@ export const uri = (id) => {
 export const get = () => {
     return hget(uri());
 };
-export const post = (newData) => {
-    return hpost(uri(), newData);
+export const post = (newData, refresh) => {
+    return hpost(uri(), newData, undefined, refresh ? new URLSearchParams({ refresh }) : undefined);
 };
-export const put = (id, newFields) => {
-    return hput(uri(id), newFields);
+export const put = (id, newFields, refresh) => {
+    return hput(uri(id), newFields, undefined, refresh ? new URLSearchParams({ refresh }) : undefined);
 };
-export const del = (id) => {
-    return hdelete(uri(id));
+export const del = (id, refresh) => {
+    return hdelete(uri(id), undefined, undefined, refresh ? new URLSearchParams({ refresh }) : undefined);
 };

package/api/user/index.d.ts

@@ -1,3 +1,4 @@
+import { type HowlerRefreshParam } from '@cccsaurora/howler-ui/api';
 import * as avatar from '@cccsaurora/howler-ui/api/user/avatar';
 import * as groups from '@cccsaurora/howler-ui/api/user/groups';
 import * as whoami from '@cccsaurora/howler-ui/api/user/whoami';
@@ -6,5 +7,5 @@ export declare const uri: (username?: string) => string;
 export declare const get: (username: string) => Promise<HowlerUser>;
 export declare const put: (username: string, newData: Partial<HowlerUser> | {
     new_pass: string;
-}) => Promise<any>;
+}, refresh?: HowlerRefreshParam) => Promise<any>;
 export { avatar, groups, whoami };

package/api/user/index.js

@@ -9,7 +9,7 @@ export const uri = (username) => {
 export const get = (username) => {
     return hget(uri(username));
 };
-export const put = (username, newData) => {
-    return hput(uri(username), newData);
+export const put = (username, newData, refresh) => {
+    return hput(uri(username), newData, undefined, refresh ? new URLSearchParams({ refresh }) : undefined);
 };
 export { avatar, groups, whoami };

package/api/view/index.d.ts

@@ -1,8 +1,9 @@
+import { type HowlerRefreshParam } from '@cccsaurora/howler-ui/api';
 import * as favourite from '@cccsaurora/howler-ui/api/view/favourite';
 import type { View } from '@cccsaurora/howler-ui/models/entities/generated/View';
 export declare const uri: (id?: string) => string;
 export declare const get: () => Promise<View[]>;
-export declare const post: (newData: Partial<View>) => Promise<View>;
-export declare const put: (id: string, partialView: Partial<Omit<View, "view_id">>) => Promise<View>;
-export declare const del: (id: string) => Promise<void>;
+export declare const post: (newData: Partial<View>, refresh?: HowlerRefreshParam) => Promise<View>;
+export declare const put: (id: string, partialView: Partial<Omit<View, "view_id">>, refresh?: HowlerRefreshParam) => Promise<View>;
+export declare const del: (id: string, refresh?: HowlerRefreshParam) => Promise<void>;
 export { favourite };

package/api/view/index.js

@@ -6,13 +6,13 @@ export const uri = (id) => {
 export const get = () => {
     return hget(uri());
 };
-export const post = (newData) => {
-    return hpost(uri(), newData);
+export const post = (newData, refresh) => {
+    return hpost(uri(), newData, undefined, refresh ? new URLSearchParams({ refresh }) : undefined);
 };
-export const put = (id, partialView) => {
-    return hput(uri(id), partialView);
+export const put = (id, partialView, refresh) => {
+    return hput(uri(id), partialView, undefined, refresh ? new URLSearchParams({ refresh }) : undefined);
 };
-export const del = (id) => {
-    return hdelete(uri(id));
+export const del = (id, refresh) => {
+    return hdelete(uri(id), undefined, undefined, refresh ? new URLSearchParams({ refresh }) : undefined);
 };
 export { favourite };

package/components/app/providers/SearchResponseProvider.d.ts

@@ -0,0 +1,21 @@
+import type { HowlerSearchRequest, HowlerSearchResponse } from '@cccsaurora/howler-ui/api/search';
+import type { DispatchApiConfig } from '@cccsaurora/howler-ui/components/hooks/useMyApi';
+import { type PropsWithChildren } from 'react';
+export type SearchResponseState<T> = HowlerSearchResponse<T> & {
+    removeCount: number;
+};
+export type SearchResponseContextType<T> = {
+    push: (item: T) => void;
+    remove: (id: string) => void;
+    replace: (id: string, item: T) => void;
+    request: (endpoint: (request: HowlerSearchRequest) => Promise<HowlerSearchResponse<T>>, requestData: HowlerSearchRequest, config?: DispatchApiConfig) => Promise<HowlerSearchResponse<T>>;
+    getSearchRequestData: (requestData: Partial<HowlerSearchRequest>) => Partial<HowlerSearchRequest>;
+    response: SearchResponseState<T> | null;
+};
+export declare const SearchResponseContext: import("react").Context<SearchResponseContextType<any>>;
+type SearchResponseProviderProps<T> = PropsWithChildren<{
+    idField: string;
+    initialResponse?: SearchResponseState<T>;
+}>;
+declare const SearchResponseProvider: <T>({ children, idField: idField, initialResponse }: SearchResponseProviderProps<T>) => import("react/jsx-runtime").JSX.Element;
+export default SearchResponseProvider;

package/components/app/providers/SearchResponseProvider.js

@@ -0,0 +1,81 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import useMyApi from '@cccsaurora/howler-ui/components/hooks/useMyApi';
+import { createContext, useCallback, useState } from 'react';
+export const SearchResponseContext = createContext(null);
+const SearchResponseProvider = ({ children, idField: idField, initialResponse = null }) => {
+    const { dispatchApi } = useMyApi();
+    const [response, setResponse] = useState(initialResponse);
+    const request = useCallback(async (endpoint, requestData, config) => {
+        const _response = await dispatchApi(endpoint(requestData), config);
+        setResponse(_prevResponse => ({
+            ..._response,
+            removeCount: _response.offset <= _prevResponse?.offset ? 0 : (_prevResponse?.removeCount ?? 0)
+        }));
+        return _response;
+    }, [dispatchApi]);
+    const getSearchRequestData = useCallback((requestData) => {
+        const modifiedRequest = { ...requestData };
+        if (response?.removeCount) {
+            if (response.offset < modifiedRequest.offset) {
+                modifiedRequest.offset = Math.max(0, modifiedRequest.offset - response.removeCount);
+            }
+        }
+        return modifiedRequest;
+    }, [response]);
+    const push = useCallback((item) => {
+        setResponse(_response => {
+            if (_response === null) {
+                return _response;
+            }
+            const filteredItems = _response.items.filter(v => v[idField] !== item[idField]);
+            const itemExists = filteredItems.length < _response.items.length;
+            filteredItems.push(item);
+            return {
+                items: filteredItems.length <= _response.rows ? filteredItems : _response.items,
+                offset: _response.offset,
+                rows: _response.rows,
+                total: itemExists ? _response.total : _response.total + 1,
+                removeCount: itemExists ? _response.removeCount : Math.max(_response.removeCount - 1, 0)
+            };
+        });
+    }, [idField]);
+    const replace = useCallback((id, item) => {
+        if (item[idField] !== undefined && id !== item[idField]) {
+            throw new Error('Item id is defined but id does not match the id provided to replace function');
+        }
+        const newItem = {
+            ...item,
+            [idField]: item[idField] !== undefined ? item[idField] : id
+        };
+        setResponse(_response => {
+            if (_response === null) {
+                return _response;
+            }
+            return {
+                items: _response.items.map(v => (v[idField] === id ? newItem : v)),
+                offset: _response.offset,
+                rows: _response.rows,
+                total: _response.total,
+                removeCount: _response.removeCount
+            };
+        });
+    }, [idField]);
+    const remove = useCallback((id) => {
+        setResponse(_response => {
+            if (_response === null) {
+                return _response;
+            }
+            const filteredItems = _response.items.filter(v => v[idField] !== id);
+            const itemExists = filteredItems.length < _response.items.length;
+            return {
+                items: filteredItems,
+                offset: _response.offset,
+                rows: _response.rows,
+                total: itemExists ? _response.total - 1 : _response.total,
+                removeCount: itemExists ? _response.removeCount + 1 : _response.removeCount
+            };
+        });
+    }, [idField]);
+    return (_jsx(SearchResponseContext.Provider, { value: { push, remove, replace, request, getSearchRequestData, response }, children: children }));
+};
+export default SearchResponseProvider;

package/components/app/providers/SearchResponseProvider.test.d.ts

@@ -0,0 +1 @@
+export {};