@piveau/sdk-vue 0.0.0-alpha.5 → 0.0.0-alpha.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/dist/index.d.mts +14 -0
  2. package/dist/index.d.ts +14 -0
  3. package/dist/index.mjs +22 -5
  4. package/package.json +2 -2
package/dist/index.d.mts CHANGED
@@ -53,6 +53,13 @@ type UseResourceResult<TModelSchema = any, TContext = any, TGetterTree extends G
53
53
  interface UseResourceParams {
54
54
  additionalParams?: MaybeRefOrGetter<any>;
55
55
  headers?: MaybeRefOrGetter<Record<string, string>>;
56
+ queryOptions?: {
57
+ staleTime?: MaybeRef<number>;
58
+ refetchOnWindowFocus?: MaybeRef<boolean>;
59
+ refetchInterval?: MaybeRef<number>;
60
+ suspense?: MaybeRef<boolean>;
61
+ retry?: MaybeRef<number>;
62
+ };
56
63
  }
57
64
  type UseResourceFunction<TContext = any, TModelSchema = any, TGettersTree extends GettersTree<TModelSchema, any> = GettersTree<TModelSchema, any>> = (resourceId: MaybeRefOrGetter<string>, params?: UseResourceParams) => UseResourceResult<TModelSchema, TContext, TGettersTree>;
58
65
  declare function useResourceFactory<TIndex extends string = string, TContext = any, TModelSchema = any, TGettersTree extends GettersTree<TModelSchema, any> = GettersTree<TModelSchema, any>>(options: {
@@ -151,6 +158,13 @@ interface UseSearchParams<TFacetNames extends string> {
151
158
  selectedFacets?: FacetRef<TFacetNames>;
152
159
  additionalParams?: MaybeRefOrGetter<any>;
153
160
  headers?: MaybeRefOrGetter<Record<string, string>>;
161
+ queryOptions?: {
162
+ staleTime?: MaybeRef<number>;
163
+ refetchOnWindowFocus?: MaybeRef<boolean>;
164
+ refetchInterval?: MaybeRef<number>;
165
+ suspense?: MaybeRef<boolean>;
166
+ retry?: MaybeRef<number>;
167
+ };
154
168
  }
155
169
  declare function useSearchFactory<TFacetNames extends string, TIndex extends string = string, TContext = any, TModelSchema = any, TGettersTree extends GettersTree<TModelSchema, any> = GettersTree<TModelSchema, any>>(options: UseSearchFactoryParams<TFacetNames, TIndex, TContext, TModelSchema, TGettersTree>): (params: UseSearchParams<TFacetNames>) => UseSearchFactoryReturn<TFacetNames, TModelSchema, TGettersTree>;
156
170
 
package/dist/index.d.ts CHANGED
@@ -53,6 +53,13 @@ type UseResourceResult<TModelSchema = any, TContext = any, TGetterTree extends G
53
53
  interface UseResourceParams {
54
54
  additionalParams?: MaybeRefOrGetter<any>;
55
55
  headers?: MaybeRefOrGetter<Record<string, string>>;
56
+ queryOptions?: {
57
+ staleTime?: MaybeRef<number>;
58
+ refetchOnWindowFocus?: MaybeRef<boolean>;
59
+ refetchInterval?: MaybeRef<number>;
60
+ suspense?: MaybeRef<boolean>;
61
+ retry?: MaybeRef<number>;
62
+ };
56
63
  }
57
64
  type UseResourceFunction<TContext = any, TModelSchema = any, TGettersTree extends GettersTree<TModelSchema, any> = GettersTree<TModelSchema, any>> = (resourceId: MaybeRefOrGetter<string>, params?: UseResourceParams) => UseResourceResult<TModelSchema, TContext, TGettersTree>;
58
65
  declare function useResourceFactory<TIndex extends string = string, TContext = any, TModelSchema = any, TGettersTree extends GettersTree<TModelSchema, any> = GettersTree<TModelSchema, any>>(options: {
@@ -151,6 +158,13 @@ interface UseSearchParams<TFacetNames extends string> {
151
158
  selectedFacets?: FacetRef<TFacetNames>;
152
159
  additionalParams?: MaybeRefOrGetter<any>;
153
160
  headers?: MaybeRefOrGetter<Record<string, string>>;
161
+ queryOptions?: {
162
+ staleTime?: MaybeRef<number>;
163
+ refetchOnWindowFocus?: MaybeRef<boolean>;
164
+ refetchInterval?: MaybeRef<number>;
165
+ suspense?: MaybeRef<boolean>;
166
+ retry?: MaybeRef<number>;
167
+ };
154
168
  }
155
169
  declare function useSearchFactory<TFacetNames extends string, TIndex extends string = string, TContext = any, TModelSchema = any, TGettersTree extends GettersTree<TModelSchema, any> = GettersTree<TModelSchema, any>>(options: UseSearchFactoryParams<TFacetNames, TIndex, TContext, TModelSchema, TGettersTree>): (params: UseSearchParams<TFacetNames>) => UseSearchFactoryReturn<TFacetNames, TModelSchema, TGettersTree>;
156
170
 
package/dist/index.mjs CHANGED
@@ -166,7 +166,8 @@ function useSearchFactory(options) {
166
166
  queryParams = {},
167
167
  selectedFacets = {},
168
168
  additionalParams = {},
169
- headers = {}
169
+ headers = {},
170
+ queryOptions
170
171
  }) {
171
172
  const {
172
173
  index,
@@ -177,6 +178,13 @@ function useSearchFactory(options) {
177
178
  fetcherFn
178
179
  } = options;
179
180
  assertQueryClient(qc);
181
+ const queryOptionsResolved = {
182
+ staleTime: queryOptions?.staleTime ?? 1e3 * 60 * 2,
183
+ refetchOnWindowFocus: queryOptions?.refetchOnWindowFocus ?? true,
184
+ refetchInterval: queryOptions?.refetchInterval,
185
+ suspense: queryOptions?.suspense,
186
+ retry: queryOptions?.retry
187
+ };
180
188
  const { queryParams: resolvedQueryParams } = useSearchQueryParams(queryParams);
181
189
  const reactiveQueryParams = reactive(resolvedQueryParams);
182
190
  reactiveQueryParams.limit = reactiveQueryParams.limit || 10;
@@ -209,8 +217,8 @@ function useSearchFactory(options) {
209
217
  headers: toValue(headers)
210
218
  })),
211
219
  placeholderData: keepPreviousData,
212
- staleTime: 1e3 * 60 * 2,
213
- enabled
220
+ enabled,
221
+ ...queryOptionsResolved
214
222
  },
215
223
  qc
216
224
  );
@@ -326,9 +334,17 @@ function useResourceFactory(options) {
326
334
  } = options;
327
335
  const {
328
336
  additionalParams,
329
- headers
337
+ headers,
338
+ queryOptions
330
339
  } = params ?? {};
331
340
  assertQueryClient(qc);
341
+ const queryOptionsResolved = {
342
+ staleTime: queryOptions?.staleTime ?? 1e3 * 60 * 2,
343
+ refetchOnWindowFocus: queryOptions?.refetchOnWindowFocus ?? true,
344
+ refetchInterval: queryOptions?.refetchInterval,
345
+ suspense: queryOptions?.suspense,
346
+ retry: queryOptions?.retry
347
+ };
332
348
  const resolvedIndex = computed(() => index ?? indexSearch);
333
349
  const query = useQuery(
334
350
  {
@@ -371,7 +387,8 @@ function useResourceFactory(options) {
371
387
  };
372
388
  return resultObj;
373
389
  },
374
- enabled
390
+ enabled,
391
+ ...queryOptionsResolved
375
392
  },
376
393
  qc
377
394
  );
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@piveau/sdk-vue",
3
3
  "type": "module",
4
- "version": "0.0.0-alpha.5",
4
+ "version": "0.0.0-alpha.6",
5
5
  "description": "",
6
6
  "author": "Duy Minh Vo <duy.minh.vo@fokus.fraunhofer.de>",
7
7
  "license": "Apache-2.0",
@@ -38,7 +38,7 @@
38
38
  "pinia": "^2.1.7",
39
39
  "vue-demi": ">=0.14.7",
40
40
  "zod": "^3.22.4",
41
- "@piveau/sdk-core": "^0.0.0-alpha.5"
41
+ "@piveau/sdk-core": "^0.0.0-alpha.6"
42
42
  },
43
43
  "devDependencies": {
44
44
  "msw": "^2.2.1",