@piveau/sdk-vue 0.0.0-alpha.0 → 0.0.0-alpha.2

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 (3) hide show
  1. package/dist/index.d.mts +8 -8
  2. package/dist/index.d.ts +8 -8
  3. package/package.json +11 -12
package/dist/index.d.mts CHANGED
@@ -111,6 +111,12 @@ interface UseSearchFactoryReturn<TFacetNames extends string, TModelSchema, TGett
111
111
  };
112
112
  queryParams: SearchParamsRef;
113
113
  }
114
+ interface UseSearchParams<TFacetNames extends string> {
115
+ queryParams?: SearchParamsRef;
116
+ selectedFacets?: FacetRef<TFacetNames>;
117
+ additionalParams?: MaybeRefOrGetter<any>;
118
+ headers?: MaybeRefOrGetter<Record<string, string>>;
119
+ }
114
120
 
115
121
  type _UseQueryReturnType<TData, TError> = UseQueryReturnType<TData, TError>;
116
122
  interface ResourceSearchOptions<TFacetNames extends string, TIndex extends string = string, TModelSchema = any> {
@@ -138,14 +144,8 @@ interface CreateUseResourceSearchParams<TFacetNames extends string, TGettersTree
138
144
  }
139
145
  declare function defineResourceSearchOptions<TFacetNames extends string, TIndex extends string = string, TModelSchema = any>(options: ResourceSearchOptions<TFacetNames, TIndex, TModelSchema>): ResourceSearchOptions<TFacetNames, TIndex, TModelSchema>;
140
146
  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>;
147
+ useSearch: (params: UseSearchParams<string>) => UseSearchFactoryReturn<string, TModelSchema, TGettersTree>;
148
+ useResources: (params: UseSearchParams<string>) => UseSearchFactoryReturn<string, TModelSchema, TGettersTree>;
149
149
  useResource: (resourceId: MaybeRefOrGetter<string>) => UseResourceResult<TModelSchema, ResourceSearchOptions<TFacetNames, TIndex, TModelSchema>, TGettersTree, UseResourceResultBase<TModelSchema, ResourceSearchOptions<TFacetNames, TIndex, TModelSchema>, TGettersTree>>;
150
150
  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
151
  refSyncedWithRouteQueryFacet: <T_1 extends string[]>(searchParam: TFacetNames, defaultValue?: MaybeRefOrGetter<T_1> | undefined) => Ref<string[]>;
package/dist/index.d.ts CHANGED
@@ -111,6 +111,12 @@ interface UseSearchFactoryReturn<TFacetNames extends string, TModelSchema, TGett
111
111
  };
112
112
  queryParams: SearchParamsRef;
113
113
  }
114
+ interface UseSearchParams<TFacetNames extends string> {
115
+ queryParams?: SearchParamsRef;
116
+ selectedFacets?: FacetRef<TFacetNames>;
117
+ additionalParams?: MaybeRefOrGetter<any>;
118
+ headers?: MaybeRefOrGetter<Record<string, string>>;
119
+ }
114
120
 
115
121
  type _UseQueryReturnType<TData, TError> = UseQueryReturnType<TData, TError>;
116
122
  interface ResourceSearchOptions<TFacetNames extends string, TIndex extends string = string, TModelSchema = any> {
@@ -138,14 +144,8 @@ interface CreateUseResourceSearchParams<TFacetNames extends string, TGettersTree
138
144
  }
139
145
  declare function defineResourceSearchOptions<TFacetNames extends string, TIndex extends string = string, TModelSchema = any>(options: ResourceSearchOptions<TFacetNames, TIndex, TModelSchema>): ResourceSearchOptions<TFacetNames, TIndex, TModelSchema>;
140
146
  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>;
147
+ useSearch: (params: UseSearchParams<string>) => UseSearchFactoryReturn<string, TModelSchema, TGettersTree>;
148
+ useResources: (params: UseSearchParams<string>) => UseSearchFactoryReturn<string, TModelSchema, TGettersTree>;
149
149
  useResource: (resourceId: MaybeRefOrGetter<string>) => UseResourceResult<TModelSchema, ResourceSearchOptions<TFacetNames, TIndex, TModelSchema>, TGettersTree, UseResourceResultBase<TModelSchema, ResourceSearchOptions<TFacetNames, TIndex, TModelSchema>, TGettersTree>>;
150
150
  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
151
  refSyncedWithRouteQueryFacet: <T_1 extends string[]>(searchParam: TFacetNames, defaultValue?: MaybeRefOrGetter<T_1> | undefined) => Ref<string[]>;
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.0",
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.2",
5
+ "description": "",
6
+ "author": "",
7
+ "license": "ISC",
9
8
  "keywords": [],
10
9
  "sideEffects": false,
11
10
  "exports": {
@@ -28,22 +27,18 @@
28
27
  "files": [
29
28
  "dist"
30
29
  ],
31
- "scripts": {
32
- "build": "unbuild",
33
- "test": "echo \"Error: no test specified\" && exit 1"
34
- },
35
30
  "peerDependencies": {
36
31
  "vue": ">=3.0.0",
37
32
  "vue-router": ">=4.0.0"
38
33
  },
39
34
  "dependencies": {
40
- "@piveau/sdk-core": "workspace:^",
41
35
  "@tanstack/vue-query": "^5.24.1",
42
36
  "@vueuse/core": "^10.8.0",
43
37
  "@vueuse/router": "^10.9.0",
44
38
  "pinia": "^2.1.7",
45
39
  "vue-demi": ">=0.14.7",
46
- "zod": "^3.22.4"
40
+ "zod": "^3.22.4",
41
+ "@piveau/sdk-core": "^0.0.0-alpha.2"
47
42
  },
48
43
  "devDependencies": {
49
44
  "msw": "^2.2.1",
@@ -51,5 +46,9 @@
51
46
  "unbuild": "^2.0.0",
52
47
  "vue": "^3.4.20",
53
48
  "vue-router": "^4.2.5"
49
+ },
50
+ "scripts": {
51
+ "build": "unbuild",
52
+ "test": "echo \"Error: no test specified\" && exit 1"
54
53
  }
55
- }
54
+ }