@tanstack/lit-query 0.0.1 → 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021-present Tanner Linsley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,45 +1,127 @@
 # @tanstack/lit-query
 
-## ⚠️ IMPORTANT NOTICE ⚠️
-
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
-
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
-
-## Purpose
-
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@tanstack/lit-query`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
-
-## What is OIDC Trusted Publishing?
-
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
-
-## Setup Instructions
-
-To properly configure OIDC trusted publishing for this package:
-
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
-
-## DO NOT USE THIS PACKAGE
-
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
-
-## More Information
-
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
-
----
-
-**Maintained for OIDC setup purposes only**
+Lit adapter for `@tanstack/query-core` using Lit reactive controllers.
+
+This package is currently experimental and v0.1. Pin exact versions if you use
+it in production while the API is early.
+
+## Install
+
+```bash
+npm install @tanstack/lit-query @tanstack/query-core lit
+```
+
+For local development in this repository:
+
+```bash
+pnpm install
+pnpm --dir packages/lit-query run build
+```
+
+## Quick Start
+
+```ts
+import { LitElement, html } from 'lit'
+import {
+  QueryClient,
+  QueryClientProvider,
+  createQueryController,
+} from '@tanstack/lit-query'
+
+const client = new QueryClient({
+  defaultOptions: { queries: { retry: false } },
+})
+
+class AppProvider extends QueryClientProvider {
+  constructor() {
+    super()
+    this.client = client
+  }
+}
+customElements.define('app-provider', AppProvider)
+
+class UsersView extends LitElement {
+  private readonly users = createQueryController(this, {
+    queryKey: ['users'],
+    queryFn: async () => {
+      const response = await fetch('/api/users')
+      return response.json() as Promise<Array<{ id: string; name: string }>>
+    },
+  })
+
+  render() {
+    const query = this.users()
+    if (query.isPending) return html`Loading...`
+    if (query.isError) return html`Error`
+    return html`<ul>
+      ${query.data?.map((u) => html`<li>${u.name}</li>`)}
+    </ul>`
+  }
+}
+customElements.define('users-view', UsersView)
+```
+
+## API Surface
+
+- `QueryClientProvider`, `useQueryClient`, `resolveQueryClient`
+- `createQueryController`
+- `createMutationController`
+- `createInfiniteQueryController`
+- `createQueriesController`
+- `useIsFetching`, `useIsMutating`, `useMutationState`
+- `queryOptions`, `infiniteQueryOptions`, `mutationOptions`
+
+## Runnable Examples
+
+This repo includes runnable Lit examples under the top-level `examples/lit`
+directory so they can be surfaced in the docs:
+
+- `examples/lit/basic`: Vite Lit app covering query and mutation primitives.
+- `examples/lit/pagination`: pagination, prefetching, optimistic updates, and error recovery.
+- `examples/lit/ssr`: Lit SSR render, dehydrate, and hydrate flow.
+
+Run an example from the repo root:
+
+```bash
+pnpm --dir examples/lit/basic run dev
+pnpm --dir examples/lit/pagination run dev
+pnpm --dir examples/lit/ssr run dev
+```
+
+Open:
+
+- `http://127.0.0.1:4173/` (basic example)
+- `http://127.0.0.1:4183/` (pagination example app)
+- `http://127.0.0.1:4174/` (SSR example app)
+
+Use a different port (optional):
+
+```bash
+DEMO_PORT=4180 pnpm --dir examples/lit/basic run dev
+PAGINATION_DEMO_PORT=4181 PAGINATION_API_PORT=4182 pnpm --dir examples/lit/pagination run dev
+SSR_PORT=4180 pnpm --dir examples/lit/ssr run dev
+SSR_HOST=0.0.0.0 pnpm --dir examples/lit/ssr run dev
+```
+
+## Integration Smoke
+
+For the framework build smoke used in CI:
+
+```bash
+pnpm --dir integrations/lit-vite run build
+```
+
+## Quality Gates
+
+From the repository root:
+
+```bash
+pnpm --dir packages/lit-query run test:types
+pnpm --dir packages/lit-query run test:lib
+pnpm --dir packages/lit-query run build
+pnpm --dir packages/lit-query run test:build
+```
+
+## License
+
+MIT

package/dist/QueryClientProvider.d.ts

@@ -0,0 +1,85 @@
+import type { QueryClient } from '@tanstack/query-core';
+import type { TemplateResult } from 'lit';
+import { LitElement } from 'lit';
+/**
+ * Lit element that provides a `QueryClient` to descendant Lit Query
+ * controllers through Lit context.
+ *
+ * The `client` is a property, not an attribute. When rendering this element in
+ * a Lit template, bind it with property binding: `.client=${queryClient}`.
+ * The provider throws if it connects without a client, or if an already
+ * connected provider has its client cleared.
+ *
+ * This class is not registered as a custom element by the package. Applications
+ * must register either a subclass or the class itself with
+ * `customElements.define`.
+ *
+ * @example
+ * ```ts
+ * import { html, LitElement } from 'lit'
+ * import { QueryClient, QueryClientProvider } from '@tanstack/lit-query'
+ *
+ * const queryClient = new QueryClient()
+ *
+ * class AppQueryProvider extends QueryClientProvider {
+ *   constructor() {
+ *     super()
+ *     this.client = queryClient
+ *   }
+ * }
+ *
+ * customElements.define('app-query-provider', AppQueryProvider)
+ *
+ * class AppRoot extends LitElement {
+ *   render() {
+ *     return html`<app-query-provider><todos-view></todos-view></app-query-provider>`
+ *   }
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * import { html } from 'lit'
+ * import { QueryClient, QueryClientProvider } from '@tanstack/lit-query'
+ *
+ * const queryClient = new QueryClient()
+ *
+ * customElements.define('query-client-provider', QueryClientProvider)
+ *
+ * const view = html`
+ *   <query-client-provider .client=${queryClient}>
+ *     <todos-view></todos-view>
+ *   </query-client-provider>
+ * `
+ * ```
+ */
+export declare class QueryClientProvider extends LitElement {
+    /** @internal */
+    static properties: {
+        client: {
+            attribute: boolean;
+        };
+    };
+    /**
+     * The `QueryClient` provided to descendant controllers and global fallback
+     * helpers while this provider is connected.
+     *
+     * Bind this as a property in Lit templates with `.client=${queryClient}`.
+     */
+    client: QueryClient;
+    private readonly contextProvider;
+    private mountedClient;
+    constructor();
+    /** @internal */
+    connectedCallback(): void;
+    /** @internal */
+    disconnectedCallback(): void;
+    /** @internal */
+    protected willUpdate(changedProperties: Map<PropertyKey, unknown>): void;
+    /** @internal */
+    render(): TemplateResult;
+    private mountClient;
+    private unmountClient;
+    private requireClient;
+}
+//# sourceMappingURL=QueryClientProvider.d.ts.map

package/dist/QueryClientProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueryClientProvider.d.ts","sourceRoot":"","sources":["../src/QueryClientProvider.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AACvD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,KAAK,CAAA;AACzC,OAAO,EAAE,UAAU,EAAQ,MAAM,KAAK,CAAA;AAQtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,qBAAa,mBAAoB,SAAQ,UAAU;IACjD,gBAAgB;IAChB,MAAM,CAAC,UAAU;;;;MAEhB;IAED;;;;;OAKG;IACK,MAAM,EAAE,WAAW,CAAA;IAE3B,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA4C;IAE5E,OAAO,CAAC,aAAa,CAAyB;;IAS9C,gBAAgB;IAChB,iBAAiB,IAAI,IAAI;IAOzB,gBAAgB;IAChB,oBAAoB,IAAI,IAAI;IAK5B,gBAAgB;IAChB,SAAS,CAAC,UAAU,CAAC,iBAAiB,EAAE,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,GAAG,IAAI;IA+BxE,gBAAgB;IAChB,MAAM,IAAI,cAAc;IAIxB,OAAO,CAAC,WAAW;IAcnB,OAAO,CAAC,aAAa;IAarB,OAAO,CAAC,aAAa;CAOtB"}

package/dist/QueryClientProvider.js

@@ -0,0 +1,137 @@
+import { ContextProvider } from '@lit/context';
+import { LitElement, html } from 'lit';
+import { createMissingQueryClientError, queryClientContext, registerDefaultQueryClient, unregisterDefaultQueryClient, } from './context.js';
+/**
+ * Lit element that provides a `QueryClient` to descendant Lit Query
+ * controllers through Lit context.
+ *
+ * The `client` is a property, not an attribute. When rendering this element in
+ * a Lit template, bind it with property binding: `.client=${queryClient}`.
+ * The provider throws if it connects without a client, or if an already
+ * connected provider has its client cleared.
+ *
+ * This class is not registered as a custom element by the package. Applications
+ * must register either a subclass or the class itself with
+ * `customElements.define`.
+ *
+ * @example
+ * ```ts
+ * import { html, LitElement } from 'lit'
+ * import { QueryClient, QueryClientProvider } from '@tanstack/lit-query'
+ *
+ * const queryClient = new QueryClient()
+ *
+ * class AppQueryProvider extends QueryClientProvider {
+ *   constructor() {
+ *     super()
+ *     this.client = queryClient
+ *   }
+ * }
+ *
+ * customElements.define('app-query-provider', AppQueryProvider)
+ *
+ * class AppRoot extends LitElement {
+ *   render() {
+ *     return html`<app-query-provider><todos-view></todos-view></app-query-provider>`
+ *   }
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * import { html } from 'lit'
+ * import { QueryClient, QueryClientProvider } from '@tanstack/lit-query'
+ *
+ * const queryClient = new QueryClient()
+ *
+ * customElements.define('query-client-provider', QueryClientProvider)
+ *
+ * const view = html`
+ *   <query-client-provider .client=${queryClient}>
+ *     <todos-view></todos-view>
+ *   </query-client-provider>
+ * `
+ * ```
+ */
+export class QueryClientProvider extends LitElement {
+    /** @internal */
+    static properties = {
+        client: { attribute: false },
+    };
+    contextProvider;
+    mountedClient;
+    constructor() {
+        super();
+        this.contextProvider = new ContextProvider(this, {
+            context: queryClientContext,
+        });
+    }
+    /** @internal */
+    connectedCallback() {
+        super.connectedCallback();
+        const client = this.requireClient();
+        this.contextProvider.setValue(client);
+        this.mountClient(client);
+    }
+    /** @internal */
+    disconnectedCallback() {
+        this.unmountClient(this.mountedClient);
+        super.disconnectedCallback();
+    }
+    /** @internal */
+    willUpdate(changedProperties) {
+        if (!changedProperties.has('client')) {
+            return;
+        }
+        const nextClient = this.client;
+        if (!nextClient) {
+            if (this.isConnected) {
+                this.unmountClient(this.mountedClient);
+                // Sentinel: notify active consumers that the provider is now unbound.
+                this.contextProvider.setValue(undefined);
+                throw createMissingQueryClientError();
+            }
+            return;
+        }
+        const previousClient = changedProperties.get('client');
+        if (previousClient && previousClient !== nextClient && this.isConnected) {
+            this.unmountClient(previousClient);
+        }
+        this.contextProvider.setValue(nextClient);
+        if (this.isConnected) {
+            this.mountClient(nextClient);
+        }
+    }
+    /** @internal */
+    render() {
+        return html `<slot></slot>`;
+    }
+    mountClient(client) {
+        if (this.mountedClient === client) {
+            return;
+        }
+        if (this.mountedClient) {
+            this.unmountClient(this.mountedClient);
+        }
+        client.mount();
+        registerDefaultQueryClient(client);
+        this.mountedClient = client;
+    }
+    unmountClient(client) {
+        if (!client) {
+            return;
+        }
+        client.unmount();
+        unregisterDefaultQueryClient(client);
+        if (this.mountedClient === client) {
+            this.mountedClient = undefined;
+        }
+    }
+    requireClient() {
+        if (!this.client) {
+            throw createMissingQueryClientError();
+        }
+        return this.client;
+    }
+}
+//# sourceMappingURL=QueryClientProvider.js.map

package/dist/QueryClientProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueryClientProvider.js","sourceRoot":"","sources":["../src/QueryClientProvider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AAG9C,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,KAAK,CAAA;AACtC,OAAO,EACL,6BAA6B,EAC7B,kBAAkB,EAClB,0BAA0B,EAC1B,4BAA4B,GAC7B,MAAM,cAAc,CAAA;AAErB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,MAAM,OAAO,mBAAoB,SAAQ,UAAU;IACjD,gBAAgB;IAChB,MAAM,CAAC,UAAU,GAAG;QAClB,MAAM,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE;KAC7B,CAAA;IAUgB,eAAe,CAA4C;IAEpE,aAAa,CAAyB;IAE9C;QACE,KAAK,EAAE,CAAA;QACP,IAAI,CAAC,eAAe,GAAG,IAAI,eAAe,CAAC,IAAI,EAAE;YAC/C,OAAO,EAAE,kBAAkB;SAC5B,CAAC,CAAA;IACJ,CAAC;IAED,gBAAgB;IAChB,iBAAiB;QACf,KAAK,CAAC,iBAAiB,EAAE,CAAA;QACzB,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,EAAE,CAAA;QACnC,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;QACrC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;IAC1B,CAAC;IAED,gBAAgB;IAChB,oBAAoB;QAClB,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;QACtC,KAAK,CAAC,oBAAoB,EAAE,CAAA;IAC9B,CAAC;IAED,gBAAgB;IACN,UAAU,CAAC,iBAA4C;QAC/D,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;YACrC,OAAM;QACR,CAAC;QAED,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAA;QAC9B,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;gBACrB,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;gBACtC,sEAAsE;gBACtE,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,SAAmC,CAAC,CAAA;gBAClE,MAAM,6BAA6B,EAAE,CAAA;YACvC,CAAC;YAED,OAAM;QACR,CAAC;QAED,MAAM,cAAc,GAAG,iBAAiB,CAAC,GAAG,CAAC,QAAQ,CAExC,CAAA;QACb,IAAI,cAAc,IAAI,cAAc,KAAK,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACxE,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,CAAA;QACpC,CAAC;QAED,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;QAEzC,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAA;QAC9B,CAAC;IACH,CAAC;IAED,gBAAgB;IAChB,MAAM;QACJ,OAAO,IAAI,CAAA,eAAe,CAAA;IAC5B,CAAC;IAEO,WAAW,CAAC,MAAmB;QACrC,IAAI,IAAI,CAAC,aAAa,KAAK,MAAM,EAAE,CAAC;YAClC,OAAM;QACR,CAAC;QAED,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;QACxC,CAAC;QAED,MAAM,CAAC,KAAK,EAAE,CAAA;QACd,0BAA0B,CAAC,MAAM,CAAC,CAAA;QAClC,IAAI,CAAC,aAAa,GAAG,MAAM,CAAA;IAC7B,CAAC;IAEO,aAAa,CAAC,MAAoB;QACxC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAM;QACR,CAAC;QAED,MAAM,CAAC,OAAO,EAAE,CAAA;QAChB,4BAA4B,CAAC,MAAM,CAAC,CAAA;QAEpC,IAAI,IAAI,CAAC,aAAa,KAAK,MAAM,EAAE,CAAC;YAClC,IAAI,CAAC,aAAa,GAAG,SAAS,CAAA;QAChC,CAAC;IACH,CAAC;IAEO,aAAa;QACnB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,MAAM,6BAA6B,EAAE,CAAA;QACvC,CAAC;QAED,OAAO,IAAI,CAAC,MAAM,CAAA;IACpB,CAAC"}

package/dist/accessor.d.ts

@@ -0,0 +1,32 @@
+/**
+ * A value that can be passed directly or read from a zero-argument getter.
+ *
+ * Lit Query APIs read function accessors during host updates, so the getter can
+ * depend on reactive host state.
+ *
+ * @example
+ * ```ts
+ * const staticKey: Accessor<readonly unknown[]> = ['todos']
+ * const reactiveKey: Accessor<readonly unknown[]> = () => ['todos', this.userId]
+ * ```
+ */
+export type Accessor<T> = T | (() => T);
+export declare function readAccessor<T>(value: Accessor<T>): T;
+/**
+ * A callable accessor with a `current` property for reading the latest
+ * controller result.
+ *
+ * Controller creators and cache state helpers return this shape so render code
+ * can use either `result()` or `result.current`.
+ *
+ * @example
+ * ```ts
+ * const query = this.todos()
+ * const sameQuery = this.todos.current
+ * ```
+ */
+export type ValueAccessor<T> = (() => T) & {
+    readonly current: T;
+};
+export declare function createValueAccessor<T>(getter: () => T): ValueAccessor<T>;
+//# sourceMappingURL=accessor.d.ts.map

package/dist/accessor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"accessor.d.ts","sourceRoot":"","sources":["../src/accessor.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAA;AAEvC,wBAAgB,YAAY,CAAC,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAErD;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG;IACzC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAA;CACpB,CAAA;AAED,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,CAOxE"}

package/dist/accessor.js

@@ -0,0 +1,12 @@
+export function readAccessor(value) {
+    return typeof value === 'function' ? value() : value;
+}
+export function createValueAccessor(getter) {
+    const accessor = (() => getter());
+    Object.defineProperty(accessor, 'current', {
+        get: getter,
+        enumerable: true,
+    });
+    return accessor;
+}
+//# sourceMappingURL=accessor.js.map

package/dist/accessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accessor.js","sourceRoot":"","sources":["../src/accessor.ts"],"names":[],"mappings":"AAcA,MAAM,UAAU,YAAY,CAAI,KAAkB;IAChD,OAAO,OAAO,KAAK,KAAK,UAAU,CAAC,CAAC,CAAE,KAAiB,EAAE,CAAC,CAAC,CAAC,KAAK,CAAA;AACnE,CAAC;AAmBD,MAAM,UAAU,mBAAmB,CAAI,MAAe;IACpD,MAAM,QAAQ,GAAG,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,CAAqB,CAAA;IACrD,MAAM,CAAC,cAAc,CAAC,QAAQ,EAAE,SAAS,EAAE;QACzC,GAAG,EAAE,MAAM;QACX,UAAU,EAAE,IAAI;KACjB,CAAC,CAAA;IACF,OAAO,QAAQ,CAAA;AACjB,CAAC"}

package/dist/context.d.ts

@@ -0,0 +1,59 @@
+import type { QueryClient } from '@tanstack/query-core';
+/**
+ * Lit context key used by `QueryClientProvider` and host-bound APIs to share a
+ * `QueryClient` through the DOM tree.
+ *
+ * Most applications use `QueryClientProvider` instead of interacting with this
+ * context directly.
+ */
+export declare const queryClientContext: {
+    __context__: QueryClient;
+};
+/**
+ * Registers a `QueryClient` as a process-local fallback for APIs that resolve a
+ * client without an explicit argument.
+ *
+ * `QueryClientProvider` calls this automatically while it is connected. Prefer
+ * passing an explicit client or rendering under a provider when possible.
+ *
+ * @param client - The query client to register as the current default.
+ */
+export declare function registerDefaultQueryClient(client: QueryClient): void;
+/**
+ * Unregisters a client previously registered with
+ * `registerDefaultQueryClient`.
+ *
+ * `QueryClientProvider` calls this automatically when it disconnects.
+ *
+ * @param client - The query client registration to release.
+ */
+export declare function unregisterDefaultQueryClient(client: QueryClient): void;
+/**
+ * Returns the registered default `QueryClient`, if exactly one default client is
+ * available.
+ *
+ * @returns The default query client, or `undefined` when there is no registered
+ * client or more than one registered client.
+ */
+export declare function getDefaultQueryClient(): QueryClient | undefined;
+export declare function createMissingQueryClientError(): Error;
+/**
+ * Resolves the current default `QueryClient` registered by a connected
+ * `QueryClientProvider`.
+ *
+ * This helper is useful outside a Lit reactive controller when a single
+ * provider is mounted. It throws if no client is registered or if multiple
+ * clients are mounted and the default would be ambiguous.
+ *
+ * @returns The single registered query client.
+ */
+export declare function useQueryClient(): QueryClient;
+/**
+ * Resolves an explicit `QueryClient` or falls back to `useQueryClient`.
+ *
+ * @param explicit - Optional client supplied by the caller.
+ * @returns The explicit client when provided, otherwise the current default
+ * client.
+ */
+export declare function resolveQueryClient(explicit?: QueryClient): QueryClient;
+//# sourceMappingURL=context.d.ts.map

package/dist/context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../src/context.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAEvD;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB;;CAE9B,CAAA;AAUD;;;;;;;;GAQG;AACH,wBAAgB,0BAA0B,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI,CAGpE;AAED;;;;;;;GAOG;AACH,wBAAgB,4BAA4B,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI,CAkBtE;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,IAAI,WAAW,GAAG,SAAS,CAM/D;AAED,wBAAgB,6BAA6B,IAAI,KAAK,CAErD;AAMD;;;;;;;;;GASG;AACH,wBAAgB,cAAc,IAAI,WAAW,CAW5C;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,CAAC,EAAE,WAAW,GAAG,WAAW,CAEtE"}

package/dist/context.js

@@ -0,0 +1,100 @@
+import { createContext } from '@lit/context';
+/**
+ * Lit context key used by `QueryClientProvider` and host-bound APIs to share a
+ * `QueryClient` through the DOM tree.
+ *
+ * Most applications use `QueryClientProvider` instead of interacting with this
+ * context directly.
+ */
+export const queryClientContext = createContext(Symbol.for('tanstack-query-client'));
+const missingQueryClientMessage = 'No QueryClient available. Pass one explicitly or render within QueryClientProvider.';
+const ambiguousQueryClientMessage = 'Multiple QueryClients are mounted. Pass one explicitly instead of relying on global QueryClient helpers.';
+const registeredClients = new Map();
+let defaultClient;
+/**
+ * Registers a `QueryClient` as a process-local fallback for APIs that resolve a
+ * client without an explicit argument.
+ *
+ * `QueryClientProvider` calls this automatically while it is connected. Prefer
+ * passing an explicit client or rendering under a provider when possible.
+ *
+ * @param client - The query client to register as the current default.
+ */
+export function registerDefaultQueryClient(client) {
+    registeredClients.set(client, (registeredClients.get(client) ?? 0) + 1);
+    defaultClient = client;
+}
+/**
+ * Unregisters a client previously registered with
+ * `registerDefaultQueryClient`.
+ *
+ * `QueryClientProvider` calls this automatically when it disconnects.
+ *
+ * @param client - The query client registration to release.
+ */
+export function unregisterDefaultQueryClient(client) {
+    const count = registeredClients.get(client);
+    if (count === undefined) {
+        return;
+    }
+    if (count > 1) {
+        registeredClients.set(client, count - 1);
+        return;
+    }
+    registeredClients.delete(client);
+    if (defaultClient !== client) {
+        return;
+    }
+    const remaining = [...registeredClients.keys()];
+    defaultClient = remaining.at(-1);
+}
+/**
+ * Returns the registered default `QueryClient`, if exactly one default client is
+ * available.
+ *
+ * @returns The default query client, or `undefined` when there is no registered
+ * client or more than one registered client.
+ */
+export function getDefaultQueryClient() {
+    if (registeredClients.size > 1) {
+        return undefined;
+    }
+    return defaultClient;
+}
+export function createMissingQueryClientError() {
+    return new Error(missingQueryClientMessage);
+}
+function createAmbiguousQueryClientError() {
+    return new Error(ambiguousQueryClientMessage);
+}
+/**
+ * Resolves the current default `QueryClient` registered by a connected
+ * `QueryClientProvider`.
+ *
+ * This helper is useful outside a Lit reactive controller when a single
+ * provider is mounted. It throws if no client is registered or if multiple
+ * clients are mounted and the default would be ambiguous.
+ *
+ * @returns The single registered query client.
+ */
+export function useQueryClient() {
+    const client = getDefaultQueryClient();
+    if (client) {
+        return client;
+    }
+    if (registeredClients.size > 1) {
+        throw createAmbiguousQueryClientError();
+    }
+    throw createMissingQueryClientError();
+}
+/**
+ * Resolves an explicit `QueryClient` or falls back to `useQueryClient`.
+ *
+ * @param explicit - Optional client supplied by the caller.
+ * @returns The explicit client when provided, otherwise the current default
+ * client.
+ */
+export function resolveQueryClient(explicit) {
+    return explicit ?? useQueryClient();
+}
+//# sourceMappingURL=context.js.map

package/dist/context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../src/context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AAG5C;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,aAAa,CAC7C,MAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,CACpC,CAAA;AAED,MAAM,yBAAyB,GAC7B,qFAAqF,CAAA;AACvF,MAAM,2BAA2B,GAC/B,0GAA0G,CAAA;AAE5G,MAAM,iBAAiB,GAAG,IAAI,GAAG,EAAuB,CAAA;AACxD,IAAI,aAAsC,CAAA;AAE1C;;;;;;;;GAQG;AACH,MAAM,UAAU,0BAA0B,CAAC,MAAmB;IAC5D,iBAAiB,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,iBAAiB,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAA;IACvE,aAAa,GAAG,MAAM,CAAA;AACxB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,4BAA4B,CAAC,MAAmB;IAC9D,MAAM,KAAK,GAAG,iBAAiB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IAC3C,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,OAAM;IACR,CAAC;IAED,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;QACd,iBAAiB,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,GAAG,CAAC,CAAC,CAAA;QACxC,OAAM;IACR,CAAC;IAED,iBAAiB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IAChC,IAAI,aAAa,KAAK,MAAM,EAAE,CAAC;QAC7B,OAAM;IACR,CAAC;IAED,MAAM,SAAS,GAAG,CAAC,GAAG,iBAAiB,CAAC,IAAI,EAAE,CAAC,CAAA;IAC/C,aAAa,GAAG,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;AAClC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,qBAAqB;IACnC,IAAI,iBAAiB,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;QAC/B,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,OAAO,aAAa,CAAA;AACtB,CAAC;AAED,MAAM,UAAU,6BAA6B;IAC3C,OAAO,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAA;AAC7C,CAAC;AAED,SAAS,+BAA+B;IACtC,OAAO,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;AAC/C,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,cAAc;IAC5B,MAAM,MAAM,GAAG,qBAAqB,EAAE,CAAA;IACtC,IAAI,MAAM,EAAE,CAAC;QACX,OAAO,MAAM,CAAA;IACf,CAAC;IAED,IAAI,iBAAiB,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;QAC/B,MAAM,+BAA+B,EAAE,CAAA;IACzC,CAAC;IAED,MAAM,6BAA6B,EAAE,CAAA;AACvC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,kBAAkB,CAAC,QAAsB;IACvD,OAAO,QAAQ,IAAI,cAAc,EAAE,CAAA;AACrC,CAAC"}