@ethlete/query 4.5.0 → 4.6.1

package/index.d.ts

@@ -1,4 +1,5 @@
 export * from './lib/auth';
+export * from './lib/class-validator';
 export * from './lib/directives';
 export * from './lib/entity';
 export * from './lib/gql';

package/lib/auth/auth-provider.types.d.ts

@@ -5,11 +5,6 @@ export interface AuthProvider {
      * This will automatically get injected into every query that has the `secure` property set to `true`.
      */
     header: Record<string, string>;
-    /**
-     * Cleanup function that gets called once the auth provider gets destroyed.
-     * @internal
-     */
-    cleanUp(): void;
 }
 export interface AuthProviderBasicConfig {
     /**

package/lib/auth/bearer-auth-provider.d.ts

@@ -18,8 +18,4 @@ export declare class BearerAuthProvider<T extends AnyQueryCreator> implements Au
     enableCookie(): void;
     disableCookie(): void;
     private _prepareForRefresh;
-    /**
-     * @internal
-     */
-    _refreshQuery(): import("../query").Query<any, any, any, any, any, any> | null | undefined;
 }

package/lib/class-validator/class-validator.types.d.ts

@@ -0,0 +1,6 @@
+import { HttpStatusCode } from '../request';
+export interface ClassValidatorError {
+    statusCode: HttpStatusCode;
+    message: string[];
+    error: string;
+}

package/lib/class-validator/class-validator.utils.d.ts

@@ -0,0 +1,2 @@
+import { ClassValidatorError } from './class-validator.types';
+export declare const isClassValidatorError: (error: unknown) => error is ClassValidatorError;

package/lib/class-validator/index.d.ts

@@ -0,0 +1,2 @@
+export * from './class-validator.types';
+export * from './class-validator.utils';

package/lib/directives/query.directive.d.ts

@@ -1,17 +1,17 @@
 import { OnDestroy, OnInit } from '@angular/core';
-import { AnyQuery, AnyQueryCollection, QueryOf } from '../query';
+import { AnyQuery, AnyQueryCollection, QueryCollectionKeysOf, QueryOf } from '../query';
 import { QueryDataOf } from '../query-creator';
 import { RequestError, RequestProgress } from '../request';
 import * as i0 from "@angular/core";
-interface QueryContext<Q extends AnyQuery | null> {
+interface QueryContext<Q extends AnyQuery | AnyQueryCollection | null> {
     /**
      * The queries's response data.
      */
-    $implicit: QueryDataOf<Q> | null;
+    $implicit: QueryDataOf<QueryOf<Q>> | null;
     /**
      * The queries's response data.
      */
-    etQuery: QueryDataOf<Q> | null;
+    etQuery: QueryDataOf<QueryOf<Q>> | null;
     /**
      * Is true when the query is triggered by user interaction.
      */
@@ -28,6 +28,10 @@ interface QueryContext<Q extends AnyQuery | null> {
      * The query's error state.
      */
     error: RequestError<unknown> | null;
+    /**
+     * The query's scope (only available when the query is a collection)
+     */
+    scope: QueryCollectionKeysOf<Q> | null;
 }
 export declare class QueryDirective<Q extends AnyQuery | AnyQueryCollection | null> implements OnInit, OnDestroy {
     private _mainTemplateRef;
@@ -43,7 +47,7 @@ export declare class QueryDirective<Q extends AnyQuery | AnyQueryCollection | nu
     get cache(): boolean;
     set cache(v: boolean);
     private _cache;
-    static ngTemplateContextGuard<Q extends AnyQuery | AnyQueryCollection | null>(dir: QueryDirective<Q>, ctx: unknown): ctx is QueryContext<QueryOf<Q>>;
+    static ngTemplateContextGuard<Q extends AnyQuery | AnyQueryCollection | null>(dir: QueryDirective<Q>, ctx: unknown): ctx is QueryContext<Q>;
     ngOnInit(): void;
     ngOnDestroy(): void;
     private _subscribeToQuery;

package/lib/entity/entity-store.d.ts

@@ -7,17 +7,21 @@ export declare class EntityStore<T> {
     constructor(_config: EntityStoreConfig);
     select(key: EntityKey): Observable<T | null>;
     select(keys: EntityKey[]): Observable<T[]>;
+    select(keys: EntityKey[][]): Observable<T[]>;
     /**
      * **Note:** Prefer `select` over `selectWhere` when possible.
      */
     selectWhere(predicate: (value: T) => boolean): Observable<T[]>;
     set(key: EntityKey, value: T): void;
     set(keys: EntityKey[], values: T[]): void;
+    set(keys: EntityKey[][], values: T[][]): void;
     remove(key: EntityKey): void;
     remove(keys: EntityKey[]): void;
+    remove(keys: EntityKey[][]): void;
     logState(): void;
     private _select;
     private _selectMany;
     private _set;
     private _remove;
+    private _normalizeKeys;
 }

package/lib/entity/entity.types.d.ts

@@ -3,3 +3,23 @@ export interface EntityStoreConfig {
     name: string;
     logActions?: boolean;
 }
+export interface InsertFromConfig<OriginStoreType, OriginKeys extends keyof NonNullable<OriginStoreType>, IdFn extends (value: NonNullable<OriginStoreType>) => EntityKey | EntityKey[]> {
+    /**
+     * The property key of which the value should be replaced.
+     */
+    for: OriginKeys;
+    /**
+     * A function that returns the id of the entity. Can also return an array of ids.
+     */
+    id: IdFn;
+}
+export interface RemoveFromConfig<T> {
+    /**
+     * The where function to select the entities to remove.
+     */
+    where: (entity: T) => boolean;
+    /**
+     * A function that returns the id of the entity.
+     */
+    id: (entity: T) => EntityKey;
+}

package/lib/entity/entity.utils.d.ts

@@ -1,2 +1,12 @@
 import { Paginated } from '@ethlete/types';
+import { EntityStore } from './entity-store';
+import { EntityKey, InsertFromConfig, RemoveFromConfig } from './entity.types';
 export declare function mapToPaginated<T>(response: Paginated<T>): import("rxjs").OperatorFunction<unknown, Paginated<T>>;
+/**
+ * Use an other store to represent a property of the current entity.
+ */
+export declare const insertFrom: <OriginStoreType, OriginKeys extends keyof NonNullable<OriginStoreType>, SubStoreType extends NonNullable<OriginStoreType>[OriginKeys] extends (infer U)[] ? U : NonNullable<OriginStoreType>[OriginKeys], IdFn extends (value: NonNullable<OriginStoreType>) => EntityKey | EntityKey[], ComputedEntityType extends ReturnType<IdFn> extends unknown[] ? OriginStoreType : Omit<OriginStoreType, OriginKeys> & { [K in OriginKeys]: SubStoreType | null; }>(store: EntityStore<SubStoreType>, { for: key, id }: InsertFromConfig<OriginStoreType, OriginKeys, IdFn>) => import("rxjs").OperatorFunction<OriginStoreType, ComputedEntityType | null>;
+/**
+ * Remove entities from a store based on a where function.
+ */
+export declare const removeFrom: <T>(store: EntityStore<T>, { where, id }: RemoveFromConfig<T>) => void;

package/lib/query/query.d.ts

@@ -12,10 +12,6 @@ export declare class Query<Response, Arguments extends BaseArguments | undefined
     private _requestSubscription;
     private _onAbort$;
     private _currentPollConfig;
-    /**
-     * @internal
-     */
-    _isPollingPaused: boolean;
     private readonly _state$;
     private get _nextId();
     get state$(): Observable<QueryState<Data>>;
@@ -30,14 +26,6 @@ export declare class Query<Response, Arguments extends BaseArguments | undefined
     get isInUse(): boolean;
     get isPolling(): boolean;
     get autoRefreshOnConfig(): Readonly<QueryAutoRefreshConfig>;
-    /**
-     * @internal
-     */
-    get _enableSmartPolling(): boolean;
-    /**
-     * @internal
-     */
-    get _arguments(): Arguments;
     get store(): Store | null;
     constructor(_client: QueryClient, _queryConfig: RestQueryConfig<Route, Response, Arguments, Store, Data, Id> | GqlQueryConfig<Route, Response, Arguments, Store, Data, Id>, _routeWithParams: Route, _args: Arguments);
     execute(options?: ExecuteQueryOptions): this;
@@ -46,10 +34,6 @@ export declare class Query<Response, Arguments extends BaseArguments | undefined
     stopPolling(): this;
     pausePolling(): this;
     resumePolling(): this;
-    /**
-     * @internal
-     */
-    _destroy(): void;
     private _getBearerAuthProvider;
     private _updateEntityState;
     private _transformState;

package/lib/query/query.types.d.ts

@@ -196,20 +196,6 @@ export interface ExecuteQueryOptions {
      * @default false
      */
     skipCache?: boolean;
-    /**
-     * The trigger type for this query.
-     * - `program`: The query was triggered by the user.
-     * - `poll`: The query was triggered by polling.
-     * - `auto`: The query was triggered by an auto refresh event.
-     * @default 'program'
-     * @internal
-     */
-    _triggeredVia?: QueryTrigger;
-    /**
-     * Whether this is a retry of an unauthorized request.
-     * @internal
-     */
-    _isUnauthorizedRetry?: boolean;
 }
 export type RouteType<Arguments extends BaseArguments | undefined> = Arguments extends {
     pathParams: infer PathParams;
@@ -288,6 +274,7 @@ export type AnyQueryCollection = QueryCollectionOf<AnyQueryCreatorCollection>;
 export type QueryOf<T extends AnyQueryCollection | AnyQuery | null> = T extends AnyQuery ? T : T extends AnyQueryCollection ? T['query'] : never;
 export type AnyQueryCollectionResponse<T extends AnyQueryCollection> = QueryResponseOf<T['query']>;
 export type AnyQueryCollectionData<T extends AnyQueryCollection> = QueryDataOf<T['query']>;
+export type QueryCollectionKeysOf<T extends AnyQueryCollection | AnyQuery | null> = T extends AnyQueryCollection ? T['type'] : never;
 export interface ResetPageOnErrorOperatorConfig<J extends QueryForm<any>> {
     /**
      * The query form to reset the page of.

package/lib/query/query.utils.d.ts

@@ -30,6 +30,10 @@ export declare const isAutoRefresh: (state: QueryState | null | undefined) => bo
 export declare const mergeHeaders: (...headers: Array<RequestHeaders | null | undefined>) => RequestHeaders | null | undefined;
 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>;
 export declare const isQuery: <T extends AnyQuery>(query: unknown) => query is T;
+export declare const isQueryCollection: <T extends {
+    type: string;
+    query: import("@ethlete/query").Query<any, any, any, any, any, any>;
+}>(query: unknown) => query is T;
 export declare const createQueryCollection: <T extends AnyQueryCreatorCollection, R extends QueryCollectionOf<T>>(queryMap: T) => BehaviorSubject<R | null>;
 export declare const extractQuery: <T extends AnyQuery | {
     type: string;

package/lib/symfony/symfony.utils.d.ts

@@ -1,3 +1,5 @@
+import { FormViolationListView } from '@ethlete/types';
 import { SymfonyError } from './symfony.types';
 export declare const isSymfonyError: (error: unknown) => error is SymfonyError;
 export declare const isSymfonyPagerfantaOutOfRangeError: (error: unknown) => error is SymfonyError;
+export declare const isSymfonyFormViolationListError: (error: unknown) => error is FormViolationListView;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethlete/query",
-  "version": "4.5.0",
+  "version": "4.6.1",
   "dependencies": {
     "tslib": "^2.5.0"
   },