@tanstack/lit-query 0.0.1 → 0.2.0

package/dist-cjs/createQueriesController.d.cts

@@ -0,0 +1,144 @@
+import { type DefaultError, type DefinedQueryObserverResult, type OmitKeyof, type QueryFunction, type QueryKey, type QueryObserverOptions, type QueryObserverResult, type ThrowOnError } from '@tanstack/query-core';
+import type { QueryClient } from '@tanstack/query-core';
+import type { ReactiveControllerHost } from 'lit' with { "resolution-mode": "import" };
+import { type Accessor, type ValueAccessor } from './accessor.cjs';
+/**
+ * Options for one query inside `createQueriesController`.
+ *
+ * This mirrors `QueryObserverOptions` and is used by the tuple inference that
+ * maps each input query to its corresponding result.
+ */
+export type CreateQueriesInput<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = QueryObserverOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>;
+type CreateQueriesInputForController<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = OmitKeyof<CreateQueriesInput<TQueryFnData, TError, TData, TQueryKey>, never>;
+type MAXIMUM_DEPTH = 20;
+type SkipTokenForCreateQueries = symbol;
+type GetCreateQueriesInput<T> = T extends {
+    queryFnData: infer TQueryFnData;
+    error?: infer TError;
+    data: infer TData;
+} ? CreateQueriesInputForController<TQueryFnData, TError, TData> : T extends {
+    queryFnData: infer TQueryFnData;
+    error?: infer TError;
+} ? CreateQueriesInputForController<TQueryFnData, TError> : T extends {
+    data: infer TData;
+    error?: infer TError;
+} ? CreateQueriesInputForController<unknown, TError, TData> : T extends [infer TQueryFnData, infer TError, infer TData] ? CreateQueriesInputForController<TQueryFnData, TError, TData> : T extends [infer TQueryFnData, infer TError] ? CreateQueriesInputForController<TQueryFnData, TError> : T extends [infer TQueryFnData] ? CreateQueriesInputForController<TQueryFnData> : T extends {
+    queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey> | SkipTokenForCreateQueries;
+    select?: (data: any) => infer TData;
+    throwOnError?: ThrowOnError<any, infer TError, any, any>;
+} ? CreateQueriesInputForController<TQueryFnData, unknown extends TError ? DefaultError : TError, unknown extends TData ? TQueryFnData : TData, TQueryKey> : CreateQueriesInputForController;
+type GetDefinedOrUndefinedCreateQueriesResult<T, TData, TError = unknown> = T extends {
+    initialData?: infer TInitialData;
+} ? unknown extends TInitialData ? QueryObserverResult<TData, TError> : TInitialData extends TData ? DefinedQueryObserverResult<TData, TError> : TInitialData extends () => infer TInitialDataResult ? unknown extends TInitialDataResult ? QueryObserverResult<TData, TError> : TInitialDataResult extends TData ? DefinedQueryObserverResult<TData, TError> : QueryObserverResult<TData, TError> : QueryObserverResult<TData, TError> : QueryObserverResult<TData, TError>;
+type GetCreateQueriesResult<T> = T extends {
+    queryFnData: any;
+    error?: infer TError;
+    data: infer TData;
+} ? GetDefinedOrUndefinedCreateQueriesResult<T, TData, TError> : T extends {
+    queryFnData: infer TQueryFnData;
+    error?: infer TError;
+} ? GetDefinedOrUndefinedCreateQueriesResult<T, TQueryFnData, TError> : T extends {
+    data: infer TData;
+    error?: infer TError;
+} ? GetDefinedOrUndefinedCreateQueriesResult<T, TData, TError> : T extends [any, infer TError, infer TData] ? GetDefinedOrUndefinedCreateQueriesResult<T, TData, TError> : T extends [infer TQueryFnData, infer TError] ? GetDefinedOrUndefinedCreateQueriesResult<T, TQueryFnData, TError> : T extends [infer TQueryFnData] ? GetDefinedOrUndefinedCreateQueriesResult<T, TQueryFnData> : T extends {
+    queryFn?: QueryFunction<infer TQueryFnData, any> | SkipTokenForCreateQueries;
+    select?: (data: any) => infer TData;
+    throwOnError?: ThrowOnError<any, infer TError, any, any>;
+} ? GetDefinedOrUndefinedCreateQueriesResult<T, unknown extends TData ? TQueryFnData : TData, unknown extends TError ? DefaultError : TError> : QueryObserverResult;
+export type CreateQueriesOptions<T extends Array<any>, TResults extends Array<any> = [], TDepth extends ReadonlyArray<number> = []> = TDepth['length'] extends MAXIMUM_DEPTH ? Array<CreateQueriesInputForController> : T extends [] ? [] : T extends [infer Head] ? [...TResults, GetCreateQueriesInput<Head>] : T extends [infer Head, ...infer Tails] ? CreateQueriesOptions<[
+    ...Tails
+], [
+    ...TResults,
+    GetCreateQueriesInput<Head>
+], [
+    ...TDepth,
+    1
+]> : ReadonlyArray<unknown> extends T ? T : T extends Array<CreateQueriesInputForController<infer TQueryFnData, infer TError, infer TData, infer TQueryKey>> ? Array<CreateQueriesInputForController<TQueryFnData, TError, TData, TQueryKey>> : Array<CreateQueriesInputForController>;
+/**
+ * Tuple of query results inferred from the query inputs passed to
+ * `createQueriesController`.
+ */
+export type CreateQueriesResults<T extends Array<any>, TResults extends Array<any> = [], TDepth extends ReadonlyArray<number> = []> = TDepth['length'] extends MAXIMUM_DEPTH ? Array<QueryObserverResult> : T extends [] ? [] : T extends [infer Head] ? [...TResults, GetCreateQueriesResult<Head>] : T extends [infer Head, ...infer Tails] ? CreateQueriesResults<[
+    ...Tails
+], [
+    ...TResults,
+    GetCreateQueriesResult<Head>
+], [
+    ...TDepth,
+    1
+]> : {
+    [K in keyof T]: GetCreateQueriesResult<T[K]>;
+};
+/**
+ * Options accepted by `createQueriesController`.
+ *
+ * `queries` can be a static list or a getter that returns the current list.
+ * `combine` can reshape the array of query results into a single value for the
+ * returned accessor.
+ */
+export type CreateQueriesControllerOptions<TQueryOptions extends Array<any> = Array<any>, TCombinedResult = CreateQueriesResults<TQueryOptions>> = {
+    /** Query options to observe, or a getter that returns the current options. */
+    queries: Accessor<readonly [...CreateQueriesOptions<TQueryOptions>] | readonly [
+        ...{
+            [K in keyof TQueryOptions]: GetCreateQueriesInput<TQueryOptions[K]>;
+        }
+    ]>;
+    /** Optional function that combines the query result array into one value. */
+    combine?: (result: CreateQueriesResults<TQueryOptions>) => TCombinedResult;
+};
+/**
+ * Accessor returned by `createQueriesController`.
+ *
+ * Call the accessor or read its `current` property to get the latest combined
+ * value.
+ */
+export type QueriesResultAccessor<TCombinedResult> = ValueAccessor<TCombinedResult> & {
+    /** Removes the controller from its Lit host and unsubscribes observers. */
+    destroy: () => void;
+};
+/**
+ * Creates a Lit reactive controller that subscribes the host to multiple
+ * queries.
+ *
+ * The returned accessor is callable and also exposes `current` and `destroy`.
+ * When `options` or `options.queries` is a function, it is re-read during host
+ * updates so the query list can follow reactive host state.
+ *
+ * If `queryClient` is omitted, the controller resolves the client from the
+ * nearest connected `QueryClientProvider`.
+ *
+ * @param host - The Lit reactive controller host that owns the queries
+ * subscription.
+ * @param options - Queries controller options, or a getter that returns options.
+ * @param queryClient - Optional explicit query client. Provide this for
+ * controllers that should not resolve a client from Lit context.
+ * @returns An accessor for the latest query results, or the value returned by
+ * `combine`.
+ *
+ * @example
+ * ```ts
+ * import { LitElement, html } from 'lit'
+ * import { createQueriesController } from '@tanstack/lit-query'
+ *
+ * class DashboardView extends LitElement {
+ *   private readonly dashboard = createQueriesController(this, {
+ *     queries: [
+ *       { queryKey: ['stats'], queryFn: fetchStats },
+ *       { queryKey: ['projects'], queryFn: fetchProjects },
+ *     ],
+ *     combine: ([stats, projects]) => ({
+ *       stats: stats.data,
+ *       projects: projects.data ?? [],
+ *       isPending: stats.isPending || projects.isPending,
+ *     }),
+ *   })
+ *
+ *   render() {
+ *     const dashboard = this.dashboard()
+ *     return html`<p>Projects: ${dashboard.projects.length}</p>`
+ *   }
+ * }
+ * ```
+ */
+export declare function createQueriesController<TQueryOptions extends Array<any>, TCombinedResult = CreateQueriesResults<TQueryOptions>>(host: ReactiveControllerHost, options: Accessor<CreateQueriesControllerOptions<TQueryOptions, TCombinedResult>>, queryClient?: QueryClient): QueriesResultAccessor<TCombinedResult>;
+export {};

package/dist-cjs/createQueriesController.js

@@ -0,0 +1,305 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createQueriesController = createQueriesController;
+const query_core_1 = require("@tanstack/query-core");
+const accessor_js_1 = require("./accessor.js");
+const context_js_1 = require("./context.js");
+const BaseController_js_1 = require("./controllers/BaseController.js");
+function createPendingQueryObserverResult() {
+    return {
+        data: undefined,
+        dataUpdatedAt: 0,
+        error: null,
+        errorUpdatedAt: 0,
+        failureCount: 0,
+        failureReason: null,
+        errorUpdateCount: 0,
+        isError: false,
+        isFetched: false,
+        isFetchedAfterMount: false,
+        isFetching: false,
+        isInitialLoading: false,
+        isLoading: false,
+        isLoadingError: false,
+        isPaused: false,
+        isPending: true,
+        isPlaceholderData: false,
+        isRefetchError: false,
+        isRefetching: false,
+        isStale: true,
+        isEnabled: true,
+        isSuccess: false,
+        fetchStatus: 'idle',
+        status: 'pending',
+        refetch: (() => Promise.reject((0, context_js_1.createMissingQueryClientError)())),
+        promise: Promise.resolve(undefined),
+    };
+}
+function createPlaceholderQueryObserverResult(query) {
+    const initialData = typeof query.initialData === 'function'
+        ? query.initialData()
+        : query.initialData;
+    if (initialData === undefined) {
+        return createPendingQueryObserverResult();
+    }
+    const data = query.select ? query.select(initialData) : initialData;
+    const initialDataUpdatedAt = typeof query.initialDataUpdatedAt === 'function'
+        ? query.initialDataUpdatedAt()
+        : query.initialDataUpdatedAt;
+    return {
+        ...createPendingQueryObserverResult(),
+        data,
+        dataUpdatedAt: initialDataUpdatedAt ?? Date.now(),
+        isPending: false,
+        isInitialLoading: false,
+        isLoading: false,
+        isSuccess: true,
+        status: 'success',
+        promise: Promise.resolve(data),
+    };
+}
+function resolveQueriesOptions(optionsAccessor, client) {
+    const resolvedOptions = (0, accessor_js_1.readAccessor)(optionsAccessor);
+    const resolvedQueries = (0, accessor_js_1.readAccessor)(resolvedOptions.queries);
+    const combine = resolvedOptions.combine;
+    return {
+        queries: resolvedQueries.map((query) => {
+            const defaulted = client.defaultQueryOptions(query);
+            defaulted._optimisticResults =
+                'optimistic';
+            return defaulted;
+        }),
+        combine,
+    };
+}
+class QueriesController extends BaseController_js_1.BaseController {
+    options;
+    observer;
+    unsubscribe;
+    queryClient;
+    explicitInitializationError;
+    placeholderInitialized = false;
+    placeholderRetryableFailure = true;
+    constructor(host, options, queryClient) {
+        super(host, [], queryClient);
+        this.options = options;
+        queueMicrotask(() => {
+            this.placeholderRetryableFailure = false;
+        });
+        if (!queryClient) {
+            return;
+        }
+        if (this.shouldRefreshOnHostUpdate()) {
+            return;
+        }
+        this.tryInitializeExplicitClient(queryClient);
+    }
+    onConnected() {
+        if (!this.syncClient()) {
+            return;
+        }
+        this.refreshOptions();
+        this.subscribe();
+    }
+    onDisconnected() {
+        this.unsubscribeObserver();
+        this.syncClient();
+    }
+    onHostUpdate() {
+        if (!this.shouldRefreshOnHostUpdate()) {
+            return;
+        }
+        if (!this.refreshOptions()) {
+            this.setPlaceholderResult();
+        }
+    }
+    onQueryClientChanged() {
+        if (!this.syncClient() || !this.connectedState) {
+            return;
+        }
+        this.refreshOptions();
+        this.subscribe();
+    }
+    subscribe() {
+        if (!this.observer) {
+            return;
+        }
+        if (this.unsubscribe) {
+            return;
+        }
+        this.unsubscribe = this.observer.subscribe((next) => {
+            const { combine } = this.readResolvedOptions();
+            this.setResult(this.computeResult(next, combine));
+        });
+    }
+    tryInitializeExplicitClient(queryClient) {
+        try {
+            const { queries, combine } = resolveQueriesOptions(this.options, queryClient);
+            const observer = new query_core_1.QueriesObserver(queryClient, queries, {
+                combine,
+            });
+            this.queryClient = queryClient;
+            this.observer = observer;
+            this.result = this.computeResult(observer.getCurrentResult(), combine);
+            this.explicitInitializationError = undefined;
+            this.placeholderInitialized = true;
+            return true;
+        }
+        catch (error) {
+            // Retry after construction completes so late host fields used by
+            // static queries/combine callbacks can finish initializing first.
+            this.explicitInitializationError = error;
+            this.queryClient = undefined;
+            this.observer = undefined;
+            return false;
+        }
+    }
+    retryExplicitInitializationIfNeeded() {
+        if (!this.explicitInitializationError || this.shouldRefreshOnHostUpdate()) {
+            return false;
+        }
+        const explicitClient = this.tryGetQueryClient();
+        if (!explicitClient) {
+            return false;
+        }
+        return this.tryInitializeExplicitClient(explicitClient);
+    }
+    unsubscribeObserver() {
+        this.unsubscribe?.();
+        this.unsubscribe = undefined;
+    }
+    syncClient() {
+        const nextClient = this.tryGetQueryClient();
+        if (!nextClient) {
+            this.unsubscribeObserver();
+            this.queryClient = undefined;
+            this.observer = undefined;
+            this.setPlaceholderResult();
+            return false;
+        }
+        if (nextClient === this.queryClient) {
+            return true;
+        }
+        this.unsubscribeObserver();
+        this.queryClient = nextClient;
+        const { queries, combine } = this.readResolvedOptions();
+        this.observer = new query_core_1.QueriesObserver(this.queryClient, queries, {
+            combine,
+        });
+        this.setResult(this.computeResult(this.observer.getCurrentResult(), combine));
+        this.placeholderInitialized = true;
+        return true;
+    }
+    refreshOptions() {
+        if (!this.syncClient() || !this.observer) {
+            return false;
+        }
+        const { queries, combine } = this.readResolvedOptions();
+        this.observer.setQueries(queries, {
+            combine,
+        });
+        const [rawResult, getCombinedResult] = this.observer.getOptimisticResult(queries, combine);
+        this.setResult(getCombinedResult(rawResult));
+        return true;
+    }
+    readResolvedOptions(client = this.queryClient) {
+        if (!client) {
+            throw (0, context_js_1.createMissingQueryClientError)();
+        }
+        return resolveQueriesOptions(this.options, client);
+    }
+    shouldRefreshOnHostUpdate() {
+        if (typeof this.options === 'function') {
+            return true;
+        }
+        return typeof this.options.queries === 'function';
+    }
+    computeResult(rawResult, combine) {
+        return (combine ? combine(rawResult) : rawResult);
+    }
+    static createPlaceholderResult(optionsAccessor) {
+        const resolvedOptions = (0, accessor_js_1.readAccessor)(optionsAccessor);
+        const queries = (0, accessor_js_1.readAccessor)(resolvedOptions.queries);
+        const placeholders = queries.map((query) => createPlaceholderQueryObserverResult(query));
+        return (resolvedOptions.combine
+            ? resolvedOptions.combine(placeholders)
+            : placeholders);
+    }
+    readCurrent() {
+        if (this.retryExplicitInitializationIfNeeded()) {
+            return this.current;
+        }
+        if (this.explicitInitializationError && !this.placeholderRetryableFailure) {
+            throw this.explicitInitializationError;
+        }
+        if (!this.queryClient && !this.observer && !this.placeholderInitialized) {
+            try {
+                // Early reads can happen during class-field initialization, before
+                // accessors referenced by queries/combine are ready. Retry normally
+                // after construction finishes and only surface errors after that point.
+                this.setPlaceholderResult();
+            }
+            catch (error) {
+                if (!this.placeholderRetryableFailure) {
+                    throw error;
+                }
+            }
+        }
+        return this.current;
+    }
+    setPlaceholderResult() {
+        this.result = QueriesController.createPlaceholderResult(this.options);
+        this.placeholderInitialized = true;
+    }
+}
+/**
+ * Creates a Lit reactive controller that subscribes the host to multiple
+ * queries.
+ *
+ * The returned accessor is callable and also exposes `current` and `destroy`.
+ * When `options` or `options.queries` is a function, it is re-read during host
+ * updates so the query list can follow reactive host state.
+ *
+ * If `queryClient` is omitted, the controller resolves the client from the
+ * nearest connected `QueryClientProvider`.
+ *
+ * @param host - The Lit reactive controller host that owns the queries
+ * subscription.
+ * @param options - Queries controller options, or a getter that returns options.
+ * @param queryClient - Optional explicit query client. Provide this for
+ * controllers that should not resolve a client from Lit context.
+ * @returns An accessor for the latest query results, or the value returned by
+ * `combine`.
+ *
+ * @example
+ * ```ts
+ * import { LitElement, html } from 'lit'
+ * import { createQueriesController } from '@tanstack/lit-query'
+ *
+ * class DashboardView extends LitElement {
+ *   private readonly dashboard = createQueriesController(this, {
+ *     queries: [
+ *       { queryKey: ['stats'], queryFn: fetchStats },
+ *       { queryKey: ['projects'], queryFn: fetchProjects },
+ *     ],
+ *     combine: ([stats, projects]) => ({
+ *       stats: stats.data,
+ *       projects: projects.data ?? [],
+ *       isPending: stats.isPending || projects.isPending,
+ *     }),
+ *   })
+ *
+ *   render() {
+ *     const dashboard = this.dashboard()
+ *     return html`<p>Projects: ${dashboard.projects.length}</p>`
+ *   }
+ * }
+ * ```
+ */
+function createQueriesController(host, options, queryClient) {
+    const controller = new QueriesController(host, options, queryClient);
+    return Object.assign((0, accessor_js_1.createValueAccessor)(() => controller.readCurrent()), {
+        destroy: () => controller.destroy(),
+    });
+}
+//# sourceMappingURL=createQueriesController.js.map

package/dist-cjs/createQueriesController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createQueriesController.js","sourceRoot":"","sources":["../src/createQueriesController.ts"],"names":[],"mappings":";;AAsmBA,0DAkBC;AAxnBD,qDAW6B;AAG7B,+CAKsB;AACtB,6CAA4D;AAC5D,uEAAgE;AAyMhE,SAAS,gCAAgC;IACvC,OAAO;QACL,IAAI,EAAE,SAAS;QACf,aAAa,EAAE,CAAC;QAChB,KAAK,EAAE,IAAI;QACX,cAAc,EAAE,CAAC;QACjB,YAAY,EAAE,CAAC;QACf,aAAa,EAAE,IAAI;QACnB,gBAAgB,EAAE,CAAC;QACnB,OAAO,EAAE,KAAK;QACd,SAAS,EAAE,KAAK;QAChB,mBAAmB,EAAE,KAAK;QAC1B,UAAU,EAAE,KAAK;QACjB,gBAAgB,EAAE,KAAK;QACvB,SAAS,EAAE,KAAK;QAChB,cAAc,EAAE,KAAK;QACrB,QAAQ,EAAE,KAAK;QACf,SAAS,EAAE,IAAI;QACf,iBAAiB,EAAE,KAAK;QACxB,cAAc,EAAE,KAAK;QACrB,YAAY,EAAE,KAAK;QACnB,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,IAAI;QACf,SAAS,EAAE,KAAK;QAChB,WAAW,EAAE,MAAM;QACnB,MAAM,EAAE,SAAS;QACjB,OAAO,EAAE,CAAC,GAAG,EAAE,CACb,OAAO,CAAC,MAAM,CACZ,IAAA,0CAA6B,GAAE,CAChC,CAAmC;QACtC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,SAAkB,CAAC;KACX,CAAA;AACrC,CAAC;AAED,SAAS,oCAAoC,CAC3C,KAA2B;IAE3B,MAAM,WAAW,GACf,OAAO,KAAK,CAAC,WAAW,KAAK,UAAU;QACrC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE;QACrB,CAAC,CAAC,KAAK,CAAC,WAAW,CAAA;IAEvB,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;QAC9B,OAAO,gCAAgC,EAAE,CAAA;IAC3C,CAAC;IAED,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAA;IACnE,MAAM,oBAAoB,GACxB,OAAO,KAAK,CAAC,oBAAoB,KAAK,UAAU;QAC9C,CAAC,CAAC,KAAK,CAAC,oBAAoB,EAAE;QAC9B,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAA;IAEhC,OAAO;QACL,GAAG,gCAAgC,EAAE;QACrC,IAAI;QACJ,aAAa,EAAE,oBAAoB,IAAI,IAAI,CAAC,GAAG,EAAE;QACjD,SAAS,EAAE,KAAK;QAChB,gBAAgB,EAAE,KAAK;QACvB,SAAS,EAAE,KAAK;QAChB,SAAS,EAAE,IAAI;QACf,MAAM,EAAE,SAAS;QACjB,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,IAAa,CAAC;KACjB,CAAA;AAC1B,CAAC;AAED,SAAS,qBAAqB,CAC5B,eAEC,EACD,MAAmB;IAKnB,MAAM,eAAe,GAAG,IAAA,0BAAY,EAAC,eAAe,CAAC,CAAA;IACrD,MAAM,eAAe,GAAG,IAAA,0BAAY,EAAC,eAAe,CAAC,OAAO,CAAC,CAAA;IAC7D,MAAM,OAAO,GACX,eAAe,CAAC,OAA6D,CAAA;IAE/E,OAAO;QACL,OAAO,EAAE,eAAe,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YACrC,MAAM,SAAS,GAAG,MAAM,CAAC,mBAAmB,CAC1C,KAA6B,CAC9B,CACA;YAAC,SAAmD,CAAC,kBAAkB;gBACtE,YAAY,CAAA;YACd,OAAO,SAAS,CAAA;QAClB,CAAC,CAAC;QACF,OAAO;KACR,CAAA;AACH,CAAC;AAED,MAAM,iBAGJ,SAAQ,kCAA+B;IACtB,OAAO,CAEvB;IACO,QAAQ,CAA8C;IACtD,WAAW,CAA0B;IACrC,WAAW,CAAyB;IACpC,2BAA2B,CAAqB;IAChD,sBAAsB,GAAG,KAAK,CAAA;IAC9B,2BAA2B,GAAG,IAAI,CAAA;IAE1C,YACE,IAA4B,EAC5B,OAEC,EACD,WAAyB;QAEzB,KAAK,CAAC,IAAI,EAAE,EAAgC,EAAE,WAAW,CAAC,CAAA;QAC1D,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QAEtB,cAAc,CAAC,GAAG,EAAE;YAClB,IAAI,CAAC,2BAA2B,GAAG,KAAK,CAAA;QAC1C,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,OAAM;QACR,CAAC;QAED,IAAI,IAAI,CAAC,yBAAyB,EAAE,EAAE,CAAC;YACrC,OAAM;QACR,CAAC;QAED,IAAI,CAAC,2BAA2B,CAAC,WAAW,CAAC,CAAA;IAC/C,CAAC;IAES,WAAW;QACnB,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC;YACvB,OAAM;QACR,CAAC;QAED,IAAI,CAAC,cAAc,EAAE,CAAA;QACrB,IAAI,CAAC,SAAS,EAAE,CAAA;IAClB,CAAC;IAES,cAAc;QACtB,IAAI,CAAC,mBAAmB,EAAE,CAAA;QAC1B,IAAI,CAAC,UAAU,EAAE,CAAA;IACnB,CAAC;IAES,YAAY;QACpB,IAAI,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,CAAC;YACtC,OAAM;QACR,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC;YAC3B,IAAI,CAAC,oBAAoB,EAAE,CAAA;QAC7B,CAAC;IACH,CAAC;IAES,oBAAoB;QAC5B,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YAC/C,OAAM;QACR,CAAC;QAED,IAAI,CAAC,cAAc,EAAE,CAAA;QACrB,IAAI,CAAC,SAAS,EAAE,CAAA;IAClB,CAAC;IAEO,SAAS;QACf,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,OAAM;QACR,CAAC;QAED,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,OAAM;QACR,CAAC;QAED,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE;YAClD,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAA;YAC9C,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAA;QACnD,CAAC,CAAC,CAAA;IACJ,CAAC;IAEO,2BAA2B,CAAC,WAAwB;QAC1D,IAAI,CAAC;YACH,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,qBAAqB,CAChD,IAAI,CAAC,OAAO,EACZ,WAAW,CACZ,CAAA;YACD,MAAM,QAAQ,GAAG,IAAI,4BAAe,CAAC,WAAW,EAAE,OAAO,EAAE;gBACzD,OAAO;aACmC,CAAC,CAAA;YAC7C,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;YAC9B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;YACxB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,gBAAgB,EAAE,EAAE,OAAO,CAAC,CAAA;YACtE,IAAI,CAAC,2BAA2B,GAAG,SAAS,CAAA;YAC5C,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAA;YAClC,OAAO,IAAI,CAAA;QACb,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,iEAAiE;YACjE,kEAAkE;YAClE,IAAI,CAAC,2BAA2B,GAAG,KAAK,CAAA;YACxC,IAAI,CAAC,WAAW,GAAG,SAAS,CAAA;YAC5B,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAA;YACzB,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC;IAEO,mCAAmC;QACzC,IAAI,CAAC,IAAI,CAAC,2BAA2B,IAAI,IAAI,CAAC,yBAAyB,EAAE,EAAE,CAAC;YAC1E,OAAO,KAAK,CAAA;QACd,CAAC;QAED,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAA;QAC/C,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,OAAO,KAAK,CAAA;QACd,CAAC;QAED,OAAO,IAAI,CAAC,2BAA2B,CAAC,cAAc,CAAC,CAAA;IACzD,CAAC;IAEO,mBAAmB;QACzB,IAAI,CAAC,WAAW,EAAE,EAAE,CAAA;QACpB,IAAI,CAAC,WAAW,GAAG,SAAS,CAAA;IAC9B,CAAC;IAEO,UAAU;QAChB,MAAM,UAAU,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAA;QAC3C,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,IAAI,CAAC,mBAAmB,EAAE,CAAA;YAC1B,IAAI,CAAC,WAAW,GAAG,SAAS,CAAA;YAC5B,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAA;YACzB,IAAI,CAAC,oBAAoB,EAAE,CAAA;YAC3B,OAAO,KAAK,CAAA;QACd,CAAC;QAED,IAAI,UAAU,KAAK,IAAI,CAAC,WAAW,EAAE,CAAC;YACpC,OAAO,IAAI,CAAA;QACb,CAAC;QAED,IAAI,CAAC,mBAAmB,EAAE,CAAA;QAC1B,IAAI,CAAC,WAAW,GAAG,UAAU,CAAA;QAC7B,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAA;QACvD,IAAI,CAAC,QAAQ,GAAG,IAAI,4BAAe,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,EAAE;YAC7D,OAAO;SACmC,CAAC,CAAA;QAC7C,IAAI,CAAC,SAAS,CACZ,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,gBAAgB,EAAE,EAAE,OAAO,CAAC,CAC9D,CAAA;QACD,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAA;QAClC,OAAO,IAAI,CAAA;IACb,CAAC;IAEO,cAAc;QACpB,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACzC,OAAO,KAAK,CAAA;QACd,CAAC;QAED,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAA;QAEvD,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,EAAE;YAChC,OAAO;SACmC,CAAC,CAAA;QAE7C,MAAM,CAAC,SAAS,EAAE,iBAAiB,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CACtE,OAAO,EACP,OAAO,CACR,CAAA;QAED,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAA;QAC5C,OAAO,IAAI,CAAA;IACb,CAAC;IAEO,mBAAmB,CAAC,MAAM,GAAG,IAAI,CAAC,WAAW;QAInD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAA,0CAA6B,GAAE,CAAA;QACvC,CAAC;QAED,OAAO,qBAAqB,CAC1B,IAAI,CAAC,OAEJ,EACD,MAAM,CACP,CAAA;IACH,CAAC;IAEO,yBAAyB;QAC/B,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;YACvC,OAAO,IAAI,CAAA;QACb,CAAC;QAED,OAAO,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,KAAK,UAAU,CAAA;IACnD,CAAC;IAEO,aAAa,CACnB,SAAqC,EACrC,OAA2D;QAE3D,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAoB,CAAA;IACtE,CAAC;IAEO,MAAM,CAAC,uBAAuB,CACpC,eAEC;QAED,MAAM,eAAe,GAAG,IAAA,0BAAY,EAAC,eAAe,CAAC,CAAA;QACrD,MAAM,OAAO,GAAG,IAAA,0BAAY,EAAC,eAAe,CAAC,OAAO,CAAC,CAAA;QACrD,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CACzC,oCAAoC,CAAC,KAA6B,CAAC,CACpE,CAAA;QACD,OAAO,CACL,eAAe,CAAC,OAAO;YACrB,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,YAAqB,CAAC;YAChD,CAAC,CAAC,YAAY,CACE,CAAA;IACtB,CAAC;IAED,WAAW;QACT,IAAI,IAAI,CAAC,mCAAmC,EAAE,EAAE,CAAC;YAC/C,OAAO,IAAI,CAAC,OAAO,CAAA;QACrB,CAAC;QAED,IAAI,IAAI,CAAC,2BAA2B,IAAI,CAAC,IAAI,CAAC,2BAA2B,EAAE,CAAC;YAC1E,MAAM,IAAI,CAAC,2BAA2B,CAAA;QACxC,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,sBAAsB,EAAE,CAAC;YACxE,IAAI,CAAC;gBACH,mEAAmE;gBACnE,oEAAoE;gBACpE,wEAAwE;gBACxE,IAAI,CAAC,oBAAoB,EAAE,CAAA;YAC7B,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,CAAC,IAAI,CAAC,2BAA2B,EAAE,CAAC;oBACtC,MAAM,KAAK,CAAA;gBACb,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAEO,oBAAoB;QAC1B,IAAI,CAAC,MAAM,GAAG,iBAAiB,CAAC,uBAAuB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACrE,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAA;IACpC,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,SAAgB,uBAAuB,CAIrC,IAA4B,EAC5B,OAEC,EACD,WAAyB;IAEzB,MAAM,UAAU,GAAG,IAAI,iBAAiB,CAAC,IAAI,EAAE,OAAO,EAAE,WAAW,CAAC,CAAA;IAEpE,OAAO,MAAM,CAAC,MAAM,CAClB,IAAA,iCAAmB,EAAC,GAAG,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,EACnD;QACE,OAAO,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE;KACpC,CACF,CAAA;AACH,CAAC"}

package/dist-cjs/createQueryController.d.cts

@@ -0,0 +1,66 @@
+import { type DefaultError, type QueryKey, type QueryObserverOptions, type QueryObserverResult } from '@tanstack/query-core';
+import type { QueryClient } from '@tanstack/query-core';
+import type { ReactiveControllerHost } from 'lit' with { "resolution-mode": "import" };
+import { type Accessor, type ValueAccessor } from './accessor.cjs';
+/**
+ * Options accepted by `createQueryController`.
+ *
+ * This is the Lit adapter shape for `QueryObserverOptions`. It can be passed
+ * directly to `createQueryController`, or wrapped in an `Accessor` when the
+ * options depend on Lit host state.
+ */
+export type CreateQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>;
+/**
+ * Accessor returned by `createQueryController`.
+ *
+ * Call the accessor or read its `current` property to get the latest query
+ * result. The attached methods delegate to the active query observer.
+ */
+export type QueryResultAccessor<TData, TError> = ValueAccessor<QueryObserverResult<TData, TError>> & {
+    /** Refetches the current query. */
+    refetch: QueryObserverResult<TData, TError>['refetch'];
+    /** Resolves with an optimistic query result, fetching first when needed. */
+    suspense: () => Promise<QueryObserverResult<TData, TError>>;
+    /** Removes the controller from its Lit host and unsubscribes observers. */
+    destroy: () => void;
+};
+/**
+ * Creates a Lit reactive controller that subscribes the host to a single query.
+ *
+ * The returned accessor is callable and also exposes `current`, `refetch`,
+ * `suspense`, and `destroy`. When `options` is a function, it is re-read during
+ * host updates so query keys and options can follow reactive host state.
+ *
+ * If `queryClient` is omitted, the controller resolves the client from the
+ * nearest connected `QueryClientProvider`.
+ *
+ * @param host - The Lit reactive controller host that owns the query
+ * subscription.
+ * @param options - Query observer options, or a getter that returns options.
+ * @param queryClient - Optional explicit query client. Provide this for
+ * controllers that should not resolve a client from Lit context.
+ * @returns An accessor for the latest query result with query helper methods.
+ *
+ * @example
+ * ```ts
+ * import { LitElement, html } from 'lit'
+ * import { createQueryController } from '@tanstack/lit-query'
+ *
+ * class TodosView extends LitElement {
+ *   private readonly todos = createQueryController(this, {
+ *     queryKey: ['todos'],
+ *     queryFn: async () => fetch('/api/todos').then((r) => r.json()),
+ *   })
+ *
+ *   render() {
+ *     const query = this.todos()
+ *
+ *     if (query.isPending) return html`Loading...`
+ *     if (query.isError) return html`Error`
+ *
+ *     return html`<ul>${query.data.map((todo) => html`<li>${todo.title}</li>`)}</ul>`
+ *   }
+ * }
+ * ```
+ */
+export declare function createQueryController<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(host: ReactiveControllerHost, options: Accessor<CreateQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>>, queryClient?: QueryClient): QueryResultAccessor<TData, TError>;