@ethlete/query 4.6.0 → 4.7.0

package/index.d.ts

@@ -1,5 +1,6 @@
 export * from './lib/auth';
 export * from './lib/class-validator';
+export * from './lib/devtools';
 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/devtools/components/public-api.d.ts

@@ -0,0 +1 @@
+export * from './query-devtools/public-api';

package/lib/devtools/components/query-devtools/public-api.d.ts

@@ -0,0 +1 @@
+export * from './query-devtools.component';

package/lib/devtools/components/query-devtools/query-devtools.component.d.ts

@@ -0,0 +1,28 @@
+import { TrackByFunction } from '@angular/core';
+import { AnyQuery } from '../../../query';
+import { QueryClientDevtoolsOptions } from '../../utils';
+import * as i0 from "@angular/core";
+export declare class QueryDevtoolsComponent {
+    protected readonly _destroy$: import("rxjs").Observable<boolean>;
+    protected readonly queryClientConfigs: QueryClientDevtoolsOptions[];
+    protected readonly isOpen: import("@angular/core").WritableSignal<boolean>;
+    protected showResponse: import("@angular/core").WritableSignal<boolean>;
+    protected showRawResponse: import("@angular/core").WritableSignal<boolean>;
+    protected readonly selectedClientId: import("@angular/core").WritableSignal<number>;
+    protected readonly selectedQueryPath: import("@angular/core").WritableSignal<string | null>;
+    protected readonly selectedClientConfig: import("@angular/core").Signal<QueryClientDevtoolsOptions>;
+    protected readonly queryStore: import("@angular/core").Signal<import("@ethlete/query").QueryStore>;
+    private readonly _queries$;
+    protected readonly queries: import("@angular/core").Signal<AnyQuery[] | undefined>;
+    protected readonly selectedQuery: import("@angular/core").Signal<AnyQuery | null>;
+    constructor();
+    protected trackByClient: TrackByFunction<QueryClientDevtoolsOptions>;
+    protected trackByQuery: TrackByFunction<AnyQuery>;
+    protected toggleOpen(): void;
+    protected toggleShowResponse(): void;
+    protected toggleShowRawResponse(): void;
+    protected selectClient(clientId: number): void;
+    protected selectQuery(query: AnyQuery): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<QueryDevtoolsComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<QueryDevtoolsComponent, "et-query-devtools", never, {}, {}, never, never, true, never>;
+}

package/lib/devtools/index.d.ts

@@ -0,0 +1 @@
+export * from './public-api';

package/lib/devtools/public-api.d.ts

@@ -0,0 +1,2 @@
+export * from './components/public-api';
+export * from './utils/public-api';

package/lib/devtools/utils/index.d.ts

@@ -0,0 +1 @@
+export * from './public-api';

package/lib/devtools/utils/public-api.d.ts

@@ -0,0 +1 @@
+export * from './query-client.utils';

package/lib/devtools/utils/query-client.utils.d.ts

@@ -0,0 +1,12 @@
+import { InjectionToken } from '@angular/core';
+import { QueryClient } from '../../query-client';
+export interface QueryClientDevtoolsOptions {
+    displayName?: string;
+    client: QueryClient;
+}
+export declare const QUERY_CLIENT_DEVTOOLS_TOKEN: InjectionToken<QueryClientDevtoolsOptions[]>;
+export declare const provideQueryClientForDevtools: (queryClient: QueryClientDevtoolsOptions) => {
+    provide: InjectionToken<QueryClientDevtoolsOptions[]>;
+    useValue: QueryClientDevtoolsOptions;
+    multi: boolean;
+};

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

@@ -5,17 +5,12 @@ import { BaseArguments, ExecuteQueryOptions, GqlQueryConfig, PollConfig, QueryAu
 export declare class Query<Response, Arguments extends BaseArguments | undefined, Route extends RouteType<Arguments>, Store extends EntityStore<unknown>, Data, Id> {
     private _client;
     private _queryConfig;
-    private _routeWithParams;
     private _args;
     private _currentId;
     private _pollingSubscription;
     private _requestSubscription;
     private _onAbort$;
     private _currentPollConfig;
-    /**
-     * @internal
-     */
-    _isPollingPaused: boolean;
     private readonly _state$;
     private get _nextId();
     get state$(): Observable<QueryState<Data>>;
@@ -28,28 +23,21 @@ export declare class Query<Response, Arguments extends BaseArguments | undefined
     get rawState(): QueryState<Response>;
     get isExpired(): boolean;
     get isInUse(): boolean;
+    get _subscriberCount(): number;
     get isPolling(): boolean;
     get autoRefreshOnConfig(): Readonly<QueryAutoRefreshConfig>;
+    get store(): Store | null;
+    constructor(_client: QueryClient, _queryConfig: RestQueryConfig<Route, Response, Arguments, Store, Data, Id> | GqlQueryConfig<Route, Response, Arguments, Store, Data, Id>, 
     /**
      * @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);
+    _routeWithParams: Route, _args: Arguments);
     execute(options?: ExecuteQueryOptions): this;
     abort(): this;
     poll(config: PollConfig): this;
     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;

package/lib/query-client/query-client.d.ts

@@ -6,7 +6,6 @@ import { RequestHeaders, RequestHeadersMethodMap } from '../request';
 import { QueryClientConfig } from './query-client.types';
 export declare class QueryClient {
     private _clientConfig;
-    private readonly _store;
     get config(): QueryClientConfig;
     get authProvider(): AuthProvider | null;
     get authProvider$(): import("rxjs").Observable<AuthProvider | null>;

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

@@ -19,6 +19,11 @@ export interface QueryClientConfig {
          * Log query state garbage collector runs.
          */
         queryStateGarbageCollector?: boolean;
+        /**
+         * Log if subscriptions are made to queries that are in the `prepared` state.
+         * This usually indicates that the `.execute()` method was forgotten.
+         */
+        preparedQuerySubscriptions?: boolean;
     };
     /**
      * Request options.

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

@@ -1,10 +1,11 @@
 import { AnyQuery } from '../query';
 export declare class QueryStore {
     private _config?;
-    private readonly _store;
     private _garbageCollector;
     private _isInLowResourceMode;
     private _lastBlurTimestamp;
+    private _storeChange$;
+    readonly storeChange$: import("rxjs").Observable<string>;
     constructor(_config?: {
         enableChangeLogging?: boolean | undefined;
         enableGarbageCollectorLogging?: boolean | undefined;

package/package.json

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