@ethlete/query 5.8.0 → 5.8.1

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 (37) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/esm2022/index.mjs +4 -2
  3. package/esm2022/lib/devtools/components/query-devtools/index.mjs +2 -0
  4. package/esm2022/lib/devtools/components/query-devtools/query-devtools.component.mjs +3 -3
  5. package/esm2022/lib/devtools/pipes/index.mjs +2 -2
  6. package/esm2022/lib/devtools/pipes/query-short-name.pipe.mjs +3 -3
  7. package/esm2022/lib/devtools/utils/index.mjs +2 -2
  8. package/esm2022/lib/directives/infinity-query-trigger.directive.mjs +3 -3
  9. package/esm2022/lib/directives/infinity-query.directive.mjs +3 -3
  10. package/esm2022/lib/directives/query.directive.mjs +3 -3
  11. package/esm2022/lib/query/query.mjs +1 -1
  12. package/esm2022/lib/query/query.types.mjs +1 -1
  13. package/esm2022/lib/query-creator/query-creator.mjs +1 -1
  14. package/esm2022/lib/request/request.util.mjs +1 -1
  15. package/fesm2022/ethlete-query.mjs +17 -17
  16. package/fesm2022/ethlete-query.mjs.map +1 -1
  17. package/index.d.ts +3 -1
  18. package/lib/devtools/pipes/index.d.ts +1 -1
  19. package/lib/devtools/utils/index.d.ts +1 -1
  20. package/lib/query/query.types.d.ts +1 -0
  21. package/lib/query/query.utils.d.ts +5 -5
  22. package/lib/query-client/query-client.d.ts +8 -8
  23. package/lib/request/request.d.ts +1 -1
  24. package/lib/request/request.util.d.ts +6 -5
  25. package/package.json +5 -5
  26. package/esm2022/lib/devtools/components/public-api.mjs +0 -2
  27. package/esm2022/lib/devtools/components/query-devtools/public-api.mjs +0 -2
  28. package/esm2022/lib/devtools/index.mjs +0 -2
  29. package/esm2022/lib/devtools/pipes/public-api.mjs +0 -2
  30. package/esm2022/lib/devtools/public-api.mjs +0 -4
  31. package/esm2022/lib/devtools/utils/public-api.mjs +0 -2
  32. package/lib/devtools/components/public-api.d.ts +0 -1
  33. package/lib/devtools/index.d.ts +0 -1
  34. package/lib/devtools/pipes/public-api.d.ts +0 -1
  35. package/lib/devtools/public-api.d.ts +0 -3
  36. package/lib/devtools/utils/public-api.d.ts +0 -1
  37. /package/lib/devtools/components/query-devtools/{public-api.d.ts → index.d.ts} +0 -0
package/index.d.ts CHANGED
@@ -1,6 +1,8 @@
1
1
  export * from './lib/auth';
2
2
  export * from './lib/class-validator';
3
- export * from './lib/devtools';
3
+ export * from './lib/devtools/components/query-devtools';
4
+ export * from './lib/devtools/pipes';
5
+ export * from './lib/devtools/utils';
4
6
  export * from './lib/directives';
5
7
  export * from './lib/entity';
6
8
  export * from './lib/gql';
@@ -1 +1 @@
1
- export * from './public-api';
1
+ export * from './query-short-name.pipe';
@@ -1 +1 @@
1
- export * from './public-api';
1
+ export * from './query-client.utils';
@@ -300,6 +300,7 @@ export type RouteType<Arguments extends BaseArguments | undefined> = Arguments e
300
300
  pathParams: infer PathParams;
301
301
  } ? (p: PathParams) => RouteString : RouteString;
302
302
  export type RouteString = `/${string}`;
303
+ export type AnyRoute = ((p: PathParams) => string) | RouteString;
303
304
  export interface PollConfig {
304
305
  /**
305
306
  * The interval in milliseconds to poll the query.
@@ -8,7 +8,7 @@ import { Method, RequestHeaders, RequestHeadersMethodMap } from '../request';
8
8
  import { QueryContainerConfig } from '../utils';
9
9
  import { AnyGqlQueryConfig, AnyQuery, AnyQueryCollectionData, AnyQueryCreatorCollection, AnyRestQueryConfig, BaseArguments, Cancelled, Failure, GqlQueryConfig, Loading, Prepared, QueryCollectionOf, QueryState, QueryStateResponseOf, QueryStateType, ResetPageOnErrorOperatorConfig, RouteType, Success } from './query.types';
10
10
  type OmitNull<T> = T extends null ? never : T;
11
- export declare function filterSuccess(): <T extends QueryState | null, Response_1 extends QueryStateResponseOf<OmitNull<T>>>(source: Observable<T>) => Observable<Success<Response_1>>;
11
+ export declare function filterSuccess(): <T extends QueryState | null, Response extends QueryStateResponseOf<OmitNull<T>>>(source: Observable<T>) => Observable<Success<Response>>;
12
12
  export declare function ignoreAutoRefresh(): <T extends QueryState | null>(source: Observable<T>) => Observable<T>;
13
13
  export declare function filterFailure(): <T extends QueryState | null>(source: Observable<T>) => Observable<Failure>;
14
14
  export declare function filterQueryStates(allowedStates: QueryStateType[]): <T extends QueryState | null>(source: Observable<T>) => Observable<T>;
@@ -29,7 +29,7 @@ export declare const isQueryStateCancelled: (state: QueryState | null | undefine
29
29
  export declare const isQueryStatePrepared: (state: QueryState | null | undefined) => state is Prepared;
30
30
  export declare const isAutoRefresh: (state: QueryState | null | undefined) => boolean;
31
31
  export declare const mergeHeaders: (...headers: Array<RequestHeaders | null | undefined>) => RequestHeaders | null | undefined;
32
- export declare const isGqlQueryConfig: <Response_1, Arguments extends BaseArguments | undefined, Route extends RouteType<Arguments> | undefined, Store extends EntityStore<unknown>, Data, Id>(config: unknown) => config is GqlQueryConfig<Route, Response_1, Arguments, Store, Data, Id>;
32
+ export declare const isGqlQueryConfig: <Response, Arguments extends BaseArguments | undefined, Route extends RouteType<Arguments> | undefined, Store extends EntityStore<unknown>, Data, Id>(config: unknown) => config is GqlQueryConfig<Route, Response, Arguments, Store, Data, Id>;
33
33
  export declare const isQuery: <T extends AnyQuery>(query: unknown) => query is T;
34
34
  export declare const isQueryCollection: <T extends {
35
35
  type: string;
@@ -46,10 +46,10 @@ export declare const extractQuery: <T extends AnyQuery | {
46
46
  query: import("@ethlete/query").Query<any, any, any, any, any, any>;
47
47
  } | null>(v: T) => import("@ethlete/query").Query<any, any, any, any, any, any> | null;
48
48
  export declare const getDefaultHeaders: (headers: RequestHeaders | RequestHeadersMethodMap | null | undefined, method: Method) => RequestHeaders;
49
- export declare const castQueryCreatorTypes: <QC extends AnyQueryCreator, Arguments extends QueryArgsOf<QC>, Response_1 extends QueryResponseOf<QC>, Store extends QueryStoreOf<QC>, Data extends QueryDataOf<QC>, Route extends RouteType<Arguments>, Id extends QueryStoreIdOf<QC>, OverrideArguments extends BaseArguments | undefined, OverrideResponse extends Response_1 | undefined>(config: {
49
+ export declare const castQueryCreatorTypes: <QC extends AnyQueryCreator, Arguments extends QueryArgsOf<QC>, Response extends QueryResponseOf<QC>, Store extends QueryStoreOf<QC>, Data extends QueryDataOf<QC>, Route extends RouteType<Arguments>, Id extends QueryStoreIdOf<QC>, OverrideArguments extends BaseArguments | undefined, OverrideResponse extends Response | undefined>(config: {
50
50
  creator: QC;
51
- args?: OverrideArguments | undefined;
52
- response?: OverrideResponse | undefined;
51
+ args?: OverrideArguments;
52
+ response?: OverrideResponse;
53
53
  }) => QueryCreator<OverrideArguments, OverrideResponse, Route, Store, Data, Id>;
54
54
  export declare const computeQueryMethod: (config: {
55
55
  config: AnyRestQueryConfig | AnyGqlQueryConfig;
@@ -11,14 +11,14 @@ export declare class QueryClient {
11
11
  get authProvider$(): import("rxjs").Observable<AuthProvider | null>;
12
12
  private readonly _authProvider$;
13
13
  constructor(_clientConfig: QueryClientConfig);
14
- get: <Route extends RouteType<Arguments>, Response_1, Id, Data = Response_1, Arguments extends BaseArguments | undefined = undefined, Store extends EntityStore<unknown> = EntityStore<unknown>>(queryConfig: QueryConfigWithoutMethod<Route, Response_1, Arguments, Store, Data, Id>) => QueryCreator<Arguments, Response_1, Route, Store, Data, Id>;
15
- post: <Route extends RouteType<Arguments>, Response_1, Id, Data = Response_1, Arguments extends BaseArguments | undefined = undefined, Store extends EntityStore<unknown> = EntityStore<unknown>>(queryConfig: QueryConfigWithoutMethod<Route, Response_1, Arguments, Store, Data, Id>) => QueryCreator<Arguments, Response_1, Route, Store, Data, Id>;
16
- put: <Route extends RouteType<Arguments>, Response_1, Id, Data = Response_1, Arguments extends BaseArguments | undefined = undefined, Store extends EntityStore<unknown> = EntityStore<unknown>>(queryConfig: QueryConfigWithoutMethod<Route, Response_1, Arguments, Store, Data, Id>) => QueryCreator<Arguments, Response_1, Route, Store, Data, Id>;
17
- patch: <Route extends RouteType<Arguments>, Response_1, Id, Data = Response_1, Arguments extends BaseArguments | undefined = undefined, Store extends EntityStore<unknown> = EntityStore<unknown>>(queryConfig: QueryConfigWithoutMethod<Route, Response_1, Arguments, Store, Data, Id>) => QueryCreator<Arguments, Response_1, Route, Store, Data, Id>;
18
- delete: <Route extends RouteType<Arguments>, Response_1, Id, Data = Response_1, Arguments extends BaseArguments | undefined = undefined, Store extends EntityStore<unknown> = EntityStore<unknown>>(queryConfig: QueryConfigWithoutMethod<Route, Response_1, Arguments, Store, Data, Id>) => QueryCreator<Arguments, Response_1, Route, Store, Data, Id>;
19
- gqlQuery: <Route extends RouteType<Arguments>, Response_1, Id, Data = Response_1, Arguments extends BaseArguments | undefined = undefined, Store extends EntityStore<unknown> = EntityStore<unknown>>(queryConfig: GqlQueryConfigWithoutMethod<Route, Response_1, Arguments, Store, Data, Id>) => QueryCreator<Arguments, Response_1, Route, Store, Data, Id>;
20
- gqlMutate: <Route extends RouteType<Arguments>, Response_1, Id, Data = Response_1, Arguments extends BaseArguments | undefined = undefined, Store extends EntityStore<unknown> = EntityStore<unknown>>(queryConfig: GqlQueryConfigWithoutMethod<Route, Response_1, Arguments, Store, Data, Id>) => QueryCreator<Arguments, Response_1, Route, Store, Data, Id>;
21
- fetch: <Route extends RouteType<Arguments>, Response_1, Arguments extends BaseArguments | undefined, Id, Store extends EntityStore<unknown> = EntityStore<unknown>, Data = Response_1>(queryConfig: RestQueryConfig<Route, Response_1, Arguments, Store, Data, Id> | GqlQueryConfig<Route, Response_1, Arguments, Store, Data, Id>) => QueryCreator<Arguments, Response_1, Route, Store, Data, Id>;
14
+ get: <Route extends RouteType<Arguments>, Response, Id, Data = Response, Arguments extends BaseArguments | undefined = undefined, Store extends EntityStore<unknown> = EntityStore<unknown>>(queryConfig: QueryConfigWithoutMethod<Route, Response, Arguments, Store, Data, Id>) => QueryCreator<Arguments, Response, Route, Store, Data, Id>;
15
+ post: <Route extends RouteType<Arguments>, Response, Id, Data = Response, Arguments extends BaseArguments | undefined = undefined, Store extends EntityStore<unknown> = EntityStore<unknown>>(queryConfig: QueryConfigWithoutMethod<Route, Response, Arguments, Store, Data, Id>) => QueryCreator<Arguments, Response, Route, Store, Data, Id>;
16
+ put: <Route extends RouteType<Arguments>, Response, Id, Data = Response, Arguments extends BaseArguments | undefined = undefined, Store extends EntityStore<unknown> = EntityStore<unknown>>(queryConfig: QueryConfigWithoutMethod<Route, Response, Arguments, Store, Data, Id>) => QueryCreator<Arguments, Response, Route, Store, Data, Id>;
17
+ patch: <Route extends RouteType<Arguments>, Response, Id, Data = Response, Arguments extends BaseArguments | undefined = undefined, Store extends EntityStore<unknown> = EntityStore<unknown>>(queryConfig: QueryConfigWithoutMethod<Route, Response, Arguments, Store, Data, Id>) => QueryCreator<Arguments, Response, Route, Store, Data, Id>;
18
+ delete: <Route extends RouteType<Arguments>, Response, Id, Data = Response, Arguments extends BaseArguments | undefined = undefined, Store extends EntityStore<unknown> = EntityStore<unknown>>(queryConfig: QueryConfigWithoutMethod<Route, Response, Arguments, Store, Data, Id>) => QueryCreator<Arguments, Response, Route, Store, Data, Id>;
19
+ gqlQuery: <Route extends RouteType<Arguments>, Response, Id, Data = Response, Arguments extends BaseArguments | undefined = undefined, Store extends EntityStore<unknown> = EntityStore<unknown>>(queryConfig: GqlQueryConfigWithoutMethod<Route, Response, Arguments, Store, Data, Id>) => QueryCreator<Arguments, Response, Route, Store, Data, Id>;
20
+ gqlMutate: <Route extends RouteType<Arguments>, Response, Id, Data = Response, Arguments extends BaseArguments | undefined = undefined, Store extends EntityStore<unknown> = EntityStore<unknown>>(queryConfig: GqlQueryConfigWithoutMethod<Route, Response, Arguments, Store, Data, Id>) => QueryCreator<Arguments, Response, Route, Store, Data, Id>;
21
+ fetch: <Route extends RouteType<Arguments>, Response, Arguments extends BaseArguments | undefined, Id, Store extends EntityStore<unknown> = EntityStore<unknown>, Data = Response>(queryConfig: RestQueryConfig<Route, Response, Arguments, Store, Data, Id> | GqlQueryConfig<Route, Response, Arguments, Store, Data, Id>) => QueryCreator<Arguments, Response, Route, Store, Data, Id>;
22
22
  setAuthProvider: (authProvider: AuthProvider) => void;
23
23
  setDefaultHeaders: (config: {
24
24
  headers: RequestHeaders | RequestHeadersMethodMap | null;
@@ -1,3 +1,3 @@
1
1
  import { Observable } from 'rxjs';
2
2
  import { RequestConfig, RequestEvent } from './request.types';
3
- export declare const request: <Response_1 = unknown>(config: RequestConfig) => Observable<RequestEvent<Response_1>>;
3
+ export declare const request: <Response = unknown>(config: RequestConfig) => Observable<RequestEvent<Response>>;
@@ -1,13 +1,14 @@
1
- import { BuildQueryStringConfig, Method, QueryParams, RequestError, RequestHeaders, RequestRetryFn } from './request.types';
1
+ import { AnyRoute } from '../query';
2
+ import { BuildQueryStringConfig, Method, PathParams, QueryParams, RequestError, RequestHeaders, RequestRetryFn } from './request.types';
2
3
  export declare const isNaN: (value: unknown) => boolean;
3
4
  export declare const isEmptyString: (value: unknown) => boolean;
4
5
  export declare const isRequestError: <T = unknown>(error: unknown) => error is RequestError<T>;
5
6
  export declare const buildRoute: (options: {
6
7
  base: string;
7
- route: string | ((args: Record<string, unknown>) => string) | null | undefined;
8
- pathParams?: Record<string, unknown> | undefined;
9
- queryParams?: object | undefined;
10
- queryParamConfig?: BuildQueryStringConfig | undefined;
8
+ route: AnyRoute | null | undefined;
9
+ pathParams?: PathParams;
10
+ queryParams?: QueryParams;
11
+ queryParamConfig?: BuildQueryStringConfig;
11
12
  }) => string;
12
13
  export declare const buildQueryString: (params: QueryParams, config?: BuildQueryStringConfig) => string | null;
13
14
  export declare const extractExpiresInSeconds: (headers: RequestHeaders) => number | null;
package/package.json CHANGED
@@ -1,11 +1,11 @@
1
1
  {
2
2
  "name": "@ethlete/query",
3
- "version": "5.8.0",
3
+ "version": "5.8.1",
4
4
  "peerDependencies": {
5
- "@angular/common": "17.2.4",
6
- "@angular/core": "17.2.4",
7
- "@angular/forms": "17.2.4",
8
- "@angular/router": "17.2.4",
5
+ "@angular/common": "17.3.0",
6
+ "@angular/core": "17.3.0",
7
+ "@angular/forms": "17.3.0",
8
+ "@angular/router": "17.3.0",
9
9
  "@ethlete/core": "^4.0.3",
10
10
  "@ethlete/types": "^1.6.2",
11
11
  "rxjs": "^7.8.1"
@@ -1,2 +0,0 @@
1
- export * from './query-devtools/public-api';
2
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHVibGljLWFwaS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uLy4uLy4uL2xpYnMvcXVlcnkvc3JjL2xpYi9kZXZ0b29scy9jb21wb25lbnRzL3B1YmxpYy1hcGkudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsY0FBYyw2QkFBNkIsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbImV4cG9ydCAqIGZyb20gJy4vcXVlcnktZGV2dG9vbHMvcHVibGljLWFwaSc7XG4iXX0=
@@ -1,2 +0,0 @@
1
- export * from './query-devtools.component';
2
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHVibGljLWFwaS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uLy4uLy4uLy4uL2xpYnMvcXVlcnkvc3JjL2xpYi9kZXZ0b29scy9jb21wb25lbnRzL3F1ZXJ5LWRldnRvb2xzL3B1YmxpYy1hcGkudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsY0FBYyw0QkFBNEIsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbImV4cG9ydCAqIGZyb20gJy4vcXVlcnktZGV2dG9vbHMuY29tcG9uZW50JztcbiJdfQ==
@@ -1,2 +0,0 @@
1
- export * from './public-api';
2
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi8uLi8uLi9saWJzL3F1ZXJ5L3NyYy9saWIvZGV2dG9vbHMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsY0FBYyxjQUFjLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyJleHBvcnQgKiBmcm9tICcuL3B1YmxpYy1hcGknO1xuIl19
@@ -1,2 +0,0 @@
1
- export * from './query-short-name.pipe';
2
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHVibGljLWFwaS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uLy4uLy4uL2xpYnMvcXVlcnkvc3JjL2xpYi9kZXZ0b29scy9waXBlcy9wdWJsaWMtYXBpLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLGNBQWMseUJBQXlCLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyJleHBvcnQgKiBmcm9tICcuL3F1ZXJ5LXNob3J0LW5hbWUucGlwZSc7XG4iXX0=
@@ -1,4 +0,0 @@
1
- export * from './components/public-api';
2
- export * from './pipes/public-api';
3
- export * from './utils/public-api';
4
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHVibGljLWFwaS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uLy4uL2xpYnMvcXVlcnkvc3JjL2xpYi9kZXZ0b29scy9wdWJsaWMtYXBpLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLGNBQWMseUJBQXlCLENBQUM7QUFDeEMsY0FBYyxvQkFBb0IsQ0FBQztBQUNuQyxjQUFjLG9CQUFvQixDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiZXhwb3J0ICogZnJvbSAnLi9jb21wb25lbnRzL3B1YmxpYy1hcGknO1xuZXhwb3J0ICogZnJvbSAnLi9waXBlcy9wdWJsaWMtYXBpJztcbmV4cG9ydCAqIGZyb20gJy4vdXRpbHMvcHVibGljLWFwaSc7XG4iXX0=
@@ -1,2 +0,0 @@
1
- export * from './query-client.utils';
2
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHVibGljLWFwaS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uLy4uLy4uL2xpYnMvcXVlcnkvc3JjL2xpYi9kZXZ0b29scy91dGlscy9wdWJsaWMtYXBpLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLGNBQWMsc0JBQXNCLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyJleHBvcnQgKiBmcm9tICcuL3F1ZXJ5LWNsaWVudC51dGlscyc7XG4iXX0=
@@ -1 +0,0 @@
1
- export * from './query-devtools/public-api';
@@ -1 +0,0 @@
1
- export * from './public-api';
@@ -1 +0,0 @@
1
- export * from './query-short-name.pipe';
@@ -1,3 +0,0 @@
1
- export * from './components/public-api';
2
- export * from './pipes/public-api';
3
- export * from './utils/public-api';
@@ -1 +0,0 @@
1
- export * from './query-client.utils';