@piveau/sdk-vue 0.0.0-alpha.1 → 0.0.0-alpha.3

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 +15 -10
  2. package/dist/index.d.ts +15 -10
  3. package/dist/index.mjs +14 -6
  4. package/package.json +5 -6
package/dist/index.d.mts CHANGED
@@ -1,4 +1,4 @@
1
- import { ToRef, Ref, ComputedRef, MaybeRef, MaybeRefOrGetter, InjectionKey, App } from 'vue-demi';
1
+ import { MaybeRefOrGetter, ToRef, Ref, ComputedRef, MaybeRef, InjectionKey, App } from 'vue-demi';
2
2
  import { UseQueryReturnType, QueryClient } from '@tanstack/vue-query';
3
3
  import { GetResourceResult, SearchParamsBase, SearchResult, SearchResultFacetGroup, SearchParams } from '@piveau/sdk-core';
4
4
  import * as z from 'zod';
@@ -31,6 +31,11 @@ type UseResourceResult<TModelSchema = any, TContext = any, TGetterTree extends G
31
31
  isLoading: Ref<boolean> | Ref<true> | Ref<false>;
32
32
  isFetching: Ref<boolean>;
33
33
  };
34
+ interface UseResourceParams {
35
+ additionalParams?: MaybeRefOrGetter<any>;
36
+ headers?: MaybeRefOrGetter<Record<string, string>>;
37
+ }
38
+ type UseResourceFunction = (resourceId: MaybeRefOrGetter<string>, params?: UseResourceParams) => UseResourceResult;
34
39
 
35
40
  type Reffify<T> = {
36
41
  [key in keyof T]: MaybeRef<T[key]>;
@@ -111,6 +116,12 @@ interface UseSearchFactoryReturn<TFacetNames extends string, TModelSchema, TGett
111
116
  };
112
117
  queryParams: SearchParamsRef;
113
118
  }
119
+ interface UseSearchParams<TFacetNames extends string> {
120
+ queryParams?: SearchParamsRef;
121
+ selectedFacets?: FacetRef<TFacetNames>;
122
+ additionalParams?: MaybeRefOrGetter<any>;
123
+ headers?: MaybeRefOrGetter<Record<string, string>>;
124
+ }
114
125
 
115
126
  type _UseQueryReturnType<TData, TError> = UseQueryReturnType<TData, TError>;
116
127
  interface ResourceSearchOptions<TFacetNames extends string, TIndex extends string = string, TModelSchema = any> {
@@ -138,15 +149,9 @@ interface CreateUseResourceSearchParams<TFacetNames extends string, TGettersTree
138
149
  }
139
150
  declare function defineResourceSearchOptions<TFacetNames extends string, TIndex extends string = string, TModelSchema = any>(options: ResourceSearchOptions<TFacetNames, TIndex, TModelSchema>): ResourceSearchOptions<TFacetNames, TIndex, TModelSchema>;
140
151
  declare function createUseResourceSearch<TFacetNames extends string, TGettersTree extends GettersTree<TModelSchema, ResourceSearchOptions<TFacetNames, TIndex, TModelSchema>>, TIndex extends string = string, TModelSchema = any>({ resourceSearchOptions, options, getters, }: CreateUseResourceSearchParams<TFacetNames, TGettersTree, TIndex, TModelSchema>): {
141
- useSearch: (params: {
142
- queryParams?: Reffify<SearchParamsBase> | undefined;
143
- selectedFacets?: FacetRef<string> | undefined;
144
- }) => UseSearchFactoryReturn<string, TModelSchema, TGettersTree>;
145
- useResources: (params: {
146
- queryParams?: Reffify<SearchParamsBase> | undefined;
147
- selectedFacets?: FacetRef<string> | undefined;
148
- }) => UseSearchFactoryReturn<string, TModelSchema, TGettersTree>;
149
- useResource: (resourceId: MaybeRefOrGetter<string>) => UseResourceResult<TModelSchema, ResourceSearchOptions<TFacetNames, TIndex, TModelSchema>, TGettersTree, UseResourceResultBase<TModelSchema, ResourceSearchOptions<TFacetNames, TIndex, TModelSchema>, TGettersTree>>;
152
+ useSearch: (params: UseSearchParams<string>) => UseSearchFactoryReturn<string, TModelSchema, TGettersTree>;
153
+ useResources: (params: UseSearchParams<string>) => UseSearchFactoryReturn<string, TModelSchema, TGettersTree>;
154
+ useResource: UseResourceFunction;
150
155
  refSyncedWithRouteQuery: <T extends string | number, K = T extends string ? string : T extends number ? number : never>(searchParam: keyof SearchParamsBase, defaultValue?: MaybeRefOrGetter<T> | undefined) => Ref<K>;
151
156
  refSyncedWithRouteQueryFacet: <T_1 extends string[]>(searchParam: TFacetNames, defaultValue?: MaybeRefOrGetter<T_1> | undefined) => Ref<string[]>;
152
157
  getters: TGettersTree;
package/dist/index.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { ToRef, Ref, ComputedRef, MaybeRef, MaybeRefOrGetter, InjectionKey, App } from 'vue-demi';
1
+ import { MaybeRefOrGetter, ToRef, Ref, ComputedRef, MaybeRef, InjectionKey, App } from 'vue-demi';
2
2
  import { UseQueryReturnType, QueryClient } from '@tanstack/vue-query';
3
3
  import { GetResourceResult, SearchParamsBase, SearchResult, SearchResultFacetGroup, SearchParams } from '@piveau/sdk-core';
4
4
  import * as z from 'zod';
@@ -31,6 +31,11 @@ type UseResourceResult<TModelSchema = any, TContext = any, TGetterTree extends G
31
31
  isLoading: Ref<boolean> | Ref<true> | Ref<false>;
32
32
  isFetching: Ref<boolean>;
33
33
  };
34
+ interface UseResourceParams {
35
+ additionalParams?: MaybeRefOrGetter<any>;
36
+ headers?: MaybeRefOrGetter<Record<string, string>>;
37
+ }
38
+ type UseResourceFunction = (resourceId: MaybeRefOrGetter<string>, params?: UseResourceParams) => UseResourceResult;
34
39
 
35
40
  type Reffify<T> = {
36
41
  [key in keyof T]: MaybeRef<T[key]>;
@@ -111,6 +116,12 @@ interface UseSearchFactoryReturn<TFacetNames extends string, TModelSchema, TGett
111
116
  };
112
117
  queryParams: SearchParamsRef;
113
118
  }
119
+ interface UseSearchParams<TFacetNames extends string> {
120
+ queryParams?: SearchParamsRef;
121
+ selectedFacets?: FacetRef<TFacetNames>;
122
+ additionalParams?: MaybeRefOrGetter<any>;
123
+ headers?: MaybeRefOrGetter<Record<string, string>>;
124
+ }
114
125
 
115
126
  type _UseQueryReturnType<TData, TError> = UseQueryReturnType<TData, TError>;
116
127
  interface ResourceSearchOptions<TFacetNames extends string, TIndex extends string = string, TModelSchema = any> {
@@ -138,15 +149,9 @@ interface CreateUseResourceSearchParams<TFacetNames extends string, TGettersTree
138
149
  }
139
150
  declare function defineResourceSearchOptions<TFacetNames extends string, TIndex extends string = string, TModelSchema = any>(options: ResourceSearchOptions<TFacetNames, TIndex, TModelSchema>): ResourceSearchOptions<TFacetNames, TIndex, TModelSchema>;
140
151
  declare function createUseResourceSearch<TFacetNames extends string, TGettersTree extends GettersTree<TModelSchema, ResourceSearchOptions<TFacetNames, TIndex, TModelSchema>>, TIndex extends string = string, TModelSchema = any>({ resourceSearchOptions, options, getters, }: CreateUseResourceSearchParams<TFacetNames, TGettersTree, TIndex, TModelSchema>): {
141
- useSearch: (params: {
142
- queryParams?: Reffify<SearchParamsBase> | undefined;
143
- selectedFacets?: FacetRef<string> | undefined;
144
- }) => UseSearchFactoryReturn<string, TModelSchema, TGettersTree>;
145
- useResources: (params: {
146
- queryParams?: Reffify<SearchParamsBase> | undefined;
147
- selectedFacets?: FacetRef<string> | undefined;
148
- }) => UseSearchFactoryReturn<string, TModelSchema, TGettersTree>;
149
- useResource: (resourceId: MaybeRefOrGetter<string>) => UseResourceResult<TModelSchema, ResourceSearchOptions<TFacetNames, TIndex, TModelSchema>, TGettersTree, UseResourceResultBase<TModelSchema, ResourceSearchOptions<TFacetNames, TIndex, TModelSchema>, TGettersTree>>;
152
+ useSearch: (params: UseSearchParams<string>) => UseSearchFactoryReturn<string, TModelSchema, TGettersTree>;
153
+ useResources: (params: UseSearchParams<string>) => UseSearchFactoryReturn<string, TModelSchema, TGettersTree>;
154
+ useResource: UseResourceFunction;
150
155
  refSyncedWithRouteQuery: <T extends string | number, K = T extends string ? string : T extends number ? number : never>(searchParam: keyof SearchParamsBase, defaultValue?: MaybeRefOrGetter<T> | undefined) => Ref<K>;
151
156
  refSyncedWithRouteQueryFacet: <T_1 extends string[]>(searchParam: TFacetNames, defaultValue?: MaybeRefOrGetter<T_1> | undefined) => Ref<string[]>;
152
157
  getters: TGettersTree;
package/dist/index.mjs CHANGED
@@ -302,7 +302,7 @@ function useSearchFactory(options) {
302
302
  }
303
303
 
304
304
  function useResourceFactory(options) {
305
- function useResource(resourceId) {
305
+ const useResource = (resourceId, params) => {
306
306
  const {
307
307
  index,
308
308
  indexSearch = index,
@@ -313,6 +313,10 @@ function useResourceFactory(options) {
313
313
  getters = {},
314
314
  fetcherFn
315
315
  } = options;
316
+ const {
317
+ additionalParams,
318
+ headers
319
+ } = params ?? {};
316
320
  assertQueryClient(qc);
317
321
  const resolvedIndex = computed(() => index ?? indexSearch);
318
322
  const query = useQuery(
@@ -320,15 +324,19 @@ function useResourceFactory(options) {
320
324
  queryKey: computed(() => [
321
325
  "pv-resource",
322
326
  toValue(resolvedIndex),
323
- toValue(resourceId)
327
+ toValue(resourceId),
328
+ ...toValue(additionalParams) ? [toValue(additionalParams)] : [],
329
+ ...toValue(headers) ? [toValue(headers)] : []
324
330
  ]),
325
331
  queryFn: async () => {
326
- const a = await fetcherFn({
332
+ const res = await fetcherFn({
327
333
  baseUrl,
328
334
  resource: toValue(resolvedIndex),
329
- id: toValue(resourceId)
335
+ id: toValue(resourceId),
336
+ additionalParams: toValue(additionalParams),
337
+ headers: toValue(headers)
330
338
  });
331
- return a;
339
+ return res;
332
340
  },
333
341
  // placeholderData: keepPreviousData,
334
342
  initialData() {
@@ -371,7 +379,7 @@ function useResourceFactory(options) {
371
379
  getters: { ...computedGetters }
372
380
  };
373
381
  return obj;
374
- }
382
+ };
375
383
  return useResource;
376
384
  }
377
385
 
package/package.json CHANGED
@@ -1,11 +1,10 @@
1
1
  {
2
2
  "name": "@piveau/sdk-vue",
3
3
  "type": "module",
4
- "version": "0.0.0-alpha.1",
5
- "private": false,
6
- "description": "Asynchronous state management for interacting with piveau services using Vue",
7
- "author": "Fraunhofer FOKUS",
8
- "license": "Apache-2.0",
4
+ "version": "0.0.0-alpha.3",
5
+ "description": "",
6
+ "author": "",
7
+ "license": "ISC",
9
8
  "keywords": [],
10
9
  "sideEffects": false,
11
10
  "exports": {
@@ -39,7 +38,7 @@
39
38
  "pinia": "^2.1.7",
40
39
  "vue-demi": ">=0.14.7",
41
40
  "zod": "^3.22.4",
42
- "@piveau/sdk-core": "^0.0.0-alpha.1"
41
+ "@piveau/sdk-core": "^0.0.0-alpha.3"
43
42
  },
44
43
  "devDependencies": {
45
44
  "msw": "^2.2.1",