@octanejs/sanity-loader 0.1.0

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.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Sanity
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,26 @@
1
+ # @octanejs/sanity-loader
2
+
3
+ Sanity query loading, Live Mode, and Content Source Map hooks for Octane. It is
4
+ the Octane counterpart to `@sanity/react-loader@2.2.1` and delegates the data
5
+ layer to Sanity's framework-neutral `@sanity/core-loader` package.
6
+
7
+ ```sh
8
+ npm install @octanejs/sanity-loader @sanity/client
9
+ pnpm add @octanejs/sanity-loader @sanity/client
10
+ ```
11
+
12
+ ```ts
13
+ import {createQueryStore} from '@octanejs/sanity-loader'
14
+
15
+ export const {loadQuery, setServerClient, useLiveMode, useQuery} =
16
+ createQueryStore({client: false, ssr: true})
17
+ ```
18
+
19
+ Use `loadQuery()` on the server and pass its result as `initial` to `useQuery()`
20
+ for hydration. `useLiveMode()` activates Sanity's browser subscription layer.
21
+ The `browser` export condition replaces server-only methods with descriptive
22
+ errors, while `@octanejs/sanity-loader/rsc` exposes the server-only store.
23
+
24
+ The upstream experimental `@sanity/react-loader/jsx` data-wrapper subpath is not
25
+ part of this first package version. Query loading, live mode, source-map encoding,
26
+ and the browser/server split are included.
package/package.json ADDED
@@ -0,0 +1,60 @@
1
+ {
2
+ "name": "@octanejs/sanity-loader",
3
+ "version": "0.1.0",
4
+ "license": "MIT",
5
+ "type": "module",
6
+ "engines": {
7
+ "node": ">=22.22.2"
8
+ },
9
+ "description": "Sanity query loading and Live Mode hooks for Octane.",
10
+ "author": {
11
+ "name": "Dominic Gannaway",
12
+ "email": "dg@domgan.com"
13
+ },
14
+ "publishConfig": {
15
+ "access": "public"
16
+ },
17
+ "repository": {
18
+ "type": "git",
19
+ "url": "git+https://github.com/octanejs/octane.git",
20
+ "directory": "packages/sanity-loader"
21
+ },
22
+ "main": "src/index.ts",
23
+ "module": "src/index.ts",
24
+ "types": "src/index.ts",
25
+ "files": [
26
+ "src",
27
+ "README.md",
28
+ "LICENSE"
29
+ ],
30
+ "sideEffects": false,
31
+ "exports": {
32
+ ".": {
33
+ "browser": "./src/index.browser.ts",
34
+ "default": "./src/index.ts"
35
+ },
36
+ "./rsc": "./src/rsc.ts",
37
+ "./package.json": "./package.json"
38
+ },
39
+ "dependencies": {
40
+ "@sanity/client": "7.26.2",
41
+ "@sanity/core-loader": "2.2.1",
42
+ "fast-deep-equal": "3.1.3"
43
+ },
44
+ "peerDependencies": {
45
+ "octane": "0.1.50"
46
+ },
47
+ "devDependencies": {
48
+ "@sanity/react-loader": "2.2.1",
49
+ "@tsrx/react": "^0.2.61",
50
+ "esbuild": "^0.28.1",
51
+ "react": "^19.2.7",
52
+ "react-dom": "^19.2.7",
53
+ "vitest": "^4.1.10",
54
+ "octane": "0.1.50"
55
+ },
56
+ "scripts": {
57
+ "test": "vitest run --root ../.. --project sanity-loader --project sanity-loader-ssr",
58
+ "typecheck": "tsgo --noEmit -p tsconfig.json"
59
+ }
60
+ }
@@ -0,0 +1,54 @@
1
+ import {
2
+ createQueryStore as createCoreQueryStore,
3
+ type CreateQueryStoreOptions,
4
+ } from '@sanity/core-loader';
5
+
6
+ import { defineStudioUrlStore } from '../defineStudioUrlStore';
7
+ import { defineUseLiveMode } from '../defineUseLiveMode';
8
+ import { defineUseQuery } from '../defineUseQuery';
9
+ import type {
10
+ NonUndefinedGuard,
11
+ QueryResponseInitial,
12
+ QueryStore,
13
+ UseLiveModeHook,
14
+ UseQueryOptionsDefinedInitial,
15
+ UseQueryOptionsUndefinedInitial,
16
+ } from '../types';
17
+
18
+ export type * from '../types';
19
+
20
+ export const createQueryStore = (options: CreateQueryStoreOptions): QueryStore => {
21
+ const { createFetcherStore, enableLiveMode } = createCoreQueryStore({
22
+ tag: 'octane-loader',
23
+ ...options,
24
+ });
25
+ const studioUrlStore = defineStudioUrlStore(options.client);
26
+ const useQuery = defineUseQuery({ createFetcherStore, studioUrlStore }) as QueryStore['useQuery'];
27
+ const useLiveMode: UseLiveModeHook = defineUseLiveMode({
28
+ enableLiveMode,
29
+ setStudioUrl: studioUrlStore.setStudioUrl,
30
+ });
31
+
32
+ const loadQuery: QueryStore['loadQuery'] = () => {
33
+ throw new Error('The `loadQuery` function is server only.');
34
+ };
35
+ const setServerClient: QueryStore['setServerClient'] = () => {
36
+ throw new Error('The `setServerClient` function is server only.');
37
+ };
38
+
39
+ return { loadQuery, useQuery, setServerClient, useLiveMode };
40
+ };
41
+
42
+ export type {
43
+ NonUndefinedGuard,
44
+ QueryResponseInitial,
45
+ QueryStore,
46
+ UseLiveModeHook,
47
+ UseQueryOptionsDefinedInitial,
48
+ UseQueryOptionsUndefinedInitial,
49
+ };
50
+
51
+ export const { loadQuery, setServerClient, useLiveMode, useQuery } = createQueryStore({
52
+ client: false,
53
+ ssr: true,
54
+ });
@@ -0,0 +1,89 @@
1
+ import type { ClientPerspective, ContentSourceMap, QueryParams } from '@sanity/client';
2
+ import {
3
+ createQueryStore as createCoreQueryStore,
4
+ type CreateQueryStoreOptions,
5
+ } from '@sanity/core-loader';
6
+
7
+ import type { QueryStore } from '../types';
8
+
9
+ export type * from '../types';
10
+
11
+ export const createQueryStore = (options: CreateQueryStoreOptions): QueryStore => {
12
+ if (!options.ssr) {
13
+ throw new Error('When using the server-only entry, the `ssr` option must be `true`.');
14
+ }
15
+ const { setServerClient, unstable__serverClient } = createCoreQueryStore({
16
+ tag: 'octane-loader.rsc',
17
+ ...options,
18
+ });
19
+
20
+ const loadQuery = async <QueryResponseResult>(
21
+ query: string,
22
+ params: QueryParams = {},
23
+ loadOptions: Parameters<QueryStore['loadQuery']>[2] = {},
24
+ ): Promise<{
25
+ data: QueryResponseResult;
26
+ sourceMap: ContentSourceMap | undefined;
27
+ perspective?: ClientPerspective;
28
+ variant?: string;
29
+ }> => {
30
+ const { cache, next, stega, headers, tag } = loadOptions;
31
+ const perspective =
32
+ loadOptions.perspective ||
33
+ unstable__serverClient.instance?.config().perspective ||
34
+ 'published';
35
+ const variant = loadOptions.variant || undefined;
36
+ const useCdn = loadOptions.useCdn ?? unstable__serverClient.instance!.config().useCdn;
37
+ const previewPerspective =
38
+ Array.isArray(perspective) || perspective === 'drafts' || perspective === 'previewDrafts';
39
+
40
+ if (previewPerspective && !unstable__serverClient.canPreviewDrafts) {
41
+ throw new Error(
42
+ `You cannot use 'perspective: ${JSON.stringify(perspective)}' without a token in the server client.`,
43
+ );
44
+ }
45
+
46
+ const response = await unstable__serverClient.instance!.fetch<QueryResponseResult>(
47
+ query,
48
+ params,
49
+ {
50
+ cache: (cache ?? next) ? undefined : ('no-store' as never),
51
+ filterResponse: false,
52
+ next,
53
+ perspective,
54
+ variant,
55
+ useCdn: previewPerspective ? false : useCdn,
56
+ stega,
57
+ headers,
58
+ tag,
59
+ },
60
+ );
61
+ const { result, resultSourceMap } = response as unknown as {
62
+ result: QueryResponseResult;
63
+ resultSourceMap: ContentSourceMap | undefined;
64
+ };
65
+ const payload = (
66
+ resultSourceMap ? { data: result, sourceMap: resultSourceMap } : { data: result }
67
+ ) as {
68
+ data: QueryResponseResult;
69
+ sourceMap: ContentSourceMap | undefined;
70
+ };
71
+ if (previewPerspective) return { ...payload, perspective, variant };
72
+ if (variant) return { ...payload, variant };
73
+ return payload;
74
+ };
75
+
76
+ const useQuery: QueryStore['useQuery'] = () => {
77
+ throw new Error('The `useQuery` hook can only be called from a client component.');
78
+ };
79
+ const useLiveMode: QueryStore['useLiveMode'] = () => {
80
+ throw new Error('The `useLiveMode` hook can only be called from a client component.');
81
+ };
82
+
83
+ return { loadQuery, setServerClient, useQuery, useLiveMode };
84
+ };
85
+
86
+ export const { loadQuery, setServerClient, useLiveMode, useQuery } = createQueryStore({
87
+ client: false,
88
+ ssr: true,
89
+ });
@@ -0,0 +1,113 @@
1
+ import type { QueryParams } from '@sanity/client';
2
+ import {
3
+ createQueryStore as createCoreQueryStore,
4
+ type CreateQueryStoreOptions,
5
+ } from '@sanity/core-loader';
6
+
7
+ import { defineStudioUrlStore } from '../defineStudioUrlStore';
8
+ import { defineUseLiveMode } from '../defineUseLiveMode';
9
+ import { defineUseQuery } from '../defineUseQuery';
10
+ import type {
11
+ NonUndefinedGuard,
12
+ QueryResponseInitial,
13
+ QueryStore,
14
+ UseLiveModeHook,
15
+ UseQueryOptionsDefinedInitial,
16
+ UseQueryOptionsUndefinedInitial,
17
+ } from '../types';
18
+
19
+ export type * from '../types';
20
+
21
+ export const createQueryStore = (options: CreateQueryStoreOptions): QueryStore => {
22
+ const {
23
+ createFetcherStore,
24
+ setServerClient,
25
+ enableLiveMode,
26
+ unstable__cache,
27
+ unstable__serverClient,
28
+ } = createCoreQueryStore({ tag: 'octane-loader', ...options });
29
+ const studioUrlStore = defineStudioUrlStore(options.client);
30
+ const useQuery = defineUseQuery({ createFetcherStore, studioUrlStore }) as QueryStore['useQuery'];
31
+ const useLiveMode: UseLiveModeHook = defineUseLiveMode({
32
+ enableLiveMode,
33
+ setStudioUrl: studioUrlStore.setStudioUrl,
34
+ });
35
+
36
+ const loadQuery = async <QueryResponseResult>(
37
+ query: string,
38
+ params: QueryParams = {},
39
+ loadOptions: Parameters<QueryStore['loadQuery']>[2] = {},
40
+ ): Promise<QueryResponseInitial<QueryResponseResult>> => {
41
+ const { headers, tag } = loadOptions;
42
+ const stega =
43
+ typeof loadOptions.stega === 'boolean'
44
+ ? loadOptions.stega
45
+ : (loadOptions.stega?.enabled ??
46
+ unstable__serverClient.instance?.config().stega?.enabled ??
47
+ false);
48
+ const perspective =
49
+ loadOptions.perspective ||
50
+ unstable__serverClient.instance?.config().perspective ||
51
+ 'published';
52
+ const variant = loadOptions.variant || undefined;
53
+
54
+ if (typeof document !== 'undefined') {
55
+ throw new Error('Cannot use `loadQuery` in a browser environment.');
56
+ }
57
+ if (perspective !== 'published' && !unstable__serverClient.instance) {
58
+ throw new Error(
59
+ 'You cannot use other perspectives than "published" unless you set "ssr: true" and call "setServerClient" first.',
60
+ );
61
+ }
62
+ if (Array.isArray(perspective) || perspective === 'drafts' || perspective === 'previewDrafts') {
63
+ if (!unstable__serverClient.canPreviewDrafts) {
64
+ throw new Error(
65
+ `You cannot use 'perspective: ${JSON.stringify(perspective)}' without a token in the server client.`,
66
+ );
67
+ }
68
+
69
+ const { result, resultSourceMap } =
70
+ await unstable__serverClient.instance!.fetch<QueryResponseResult>(query, params, {
71
+ filterResponse: false,
72
+ resultSourceMap: 'withKeyArraySelector',
73
+ stega,
74
+ perspective,
75
+ variant,
76
+ useCdn: false,
77
+ headers,
78
+ tag,
79
+ });
80
+ return resultSourceMap
81
+ ? { data: result, sourceMap: resultSourceMap, perspective, variant }
82
+ : ({ data: result, perspective, variant } as QueryResponseInitial<QueryResponseResult>);
83
+ }
84
+
85
+ const { result, resultSourceMap } = await unstable__cache.instance.fetch<QueryResponseResult>(
86
+ JSON.stringify({ query, params, perspective, variant, options: { stega } }),
87
+ );
88
+ return resultSourceMap
89
+ ? { data: result, sourceMap: resultSourceMap }
90
+ : ({ data: result } as QueryResponseInitial<QueryResponseResult>);
91
+ };
92
+
93
+ return {
94
+ loadQuery,
95
+ useQuery,
96
+ setServerClient,
97
+ useLiveMode,
98
+ };
99
+ };
100
+
101
+ export type {
102
+ NonUndefinedGuard,
103
+ QueryResponseInitial,
104
+ QueryStore,
105
+ UseLiveModeHook,
106
+ UseQueryOptionsDefinedInitial,
107
+ UseQueryOptionsUndefinedInitial,
108
+ };
109
+
110
+ export const { loadQuery, setServerClient, useLiveMode, useQuery } = createQueryStore({
111
+ client: false,
112
+ ssr: true,
113
+ });
@@ -0,0 +1,35 @@
1
+ import type { CreateQueryStoreOptions } from '@sanity/core-loader';
2
+
3
+ type StudioUrlLike =
4
+ | import('@sanity/client/csm').StudioUrl
5
+ | import('@sanity/client/csm').ResolveStudioUrl
6
+ | undefined;
7
+
8
+ export function defineStudioUrlStore(client: CreateQueryStoreOptions['client']): {
9
+ subscribe: (callback: () => void) => () => void;
10
+ getSnapshot: () => StudioUrlLike;
11
+ getServerSnapshot: () => StudioUrlLike;
12
+ setStudioUrl: (nextStudioUrl: StudioUrlLike) => void;
13
+ } {
14
+ let studioUrl: StudioUrlLike =
15
+ typeof client === 'object' ? client?.config().stega.studioUrl : undefined;
16
+ const serverSnapshot = studioUrl;
17
+ const subscribers = new Set<() => void>();
18
+
19
+ return {
20
+ subscribe(callback) {
21
+ subscribers.add(callback);
22
+ return () => subscribers.delete(callback);
23
+ },
24
+ getSnapshot() {
25
+ return studioUrl;
26
+ },
27
+ getServerSnapshot() {
28
+ return serverSnapshot;
29
+ },
30
+ setStudioUrl(nextStudioUrl) {
31
+ studioUrl = nextStudioUrl;
32
+ subscribers.forEach((callback) => callback());
33
+ },
34
+ };
35
+ }
@@ -0,0 +1,46 @@
1
+ import type { QueryStore } from '@sanity/core-loader';
2
+ import { useEffect } from 'octane';
3
+
4
+ import type { UseLiveModeHook } from './types';
5
+
6
+ export function defineUseLiveMode({
7
+ enableLiveMode,
8
+ setStudioUrl,
9
+ }: Pick<QueryStore, 'enableLiveMode'> & {
10
+ setStudioUrl: (
11
+ studioUrl:
12
+ | import('@sanity/client/csm').StudioUrl
13
+ | import('@sanity/client/csm').ResolveStudioUrl
14
+ | undefined,
15
+ ) => void;
16
+ }): UseLiveModeHook {
17
+ return ({
18
+ allowStudioOrigin,
19
+ client,
20
+ onConnect,
21
+ onDisconnect,
22
+ onPerspective,
23
+ onVariant,
24
+ studioUrl,
25
+ }) => {
26
+ useEffect(() => {
27
+ if (allowStudioOrigin) {
28
+ console.warn('`allowStudioOrigin` is deprecated and no longer needed');
29
+ }
30
+ const disableLiveMode = enableLiveMode({
31
+ client,
32
+ onConnect,
33
+ onDisconnect,
34
+ onPerspective,
35
+ onVariant,
36
+ });
37
+ return () => disableLiveMode();
38
+ }, [allowStudioOrigin, client, onConnect, onDisconnect, onPerspective, onVariant]);
39
+
40
+ useEffect(() => {
41
+ setStudioUrl(
42
+ studioUrl ?? (typeof client === 'object' ? client?.config().stega.studioUrl : undefined),
43
+ );
44
+ }, [studioUrl, client]);
45
+ };
46
+ }
@@ -0,0 +1,86 @@
1
+ import type { QueryParams } from '@sanity/client';
2
+ import type { QueryStore, QueryStoreState } from '@sanity/core-loader';
3
+ import type { EncodeDataAttributeFunction } from '@sanity/core-loader/encode-data-attribute';
4
+ import isEqual from 'fast-deep-equal';
5
+ import { useEffect, useLinkedState, useMemo, useSyncExternalStore } from 'octane';
6
+
7
+ import { defineStudioUrlStore } from './defineStudioUrlStore';
8
+ import type { UseQueryOptions } from './types';
9
+ import { useEncodeDataAttribute } from './useEncodeDataAttribute';
10
+
11
+ export function defineUseQuery({
12
+ createFetcherStore,
13
+ studioUrlStore,
14
+ }: Pick<QueryStore, 'createFetcherStore'> & {
15
+ studioUrlStore: ReturnType<typeof defineStudioUrlStore>;
16
+ }): <QueryResponseResult, QueryResponseError>(
17
+ query: string,
18
+ params?: QueryParams,
19
+ options?: UseQueryOptions<QueryResponseResult>,
20
+ ) => QueryStoreState<QueryResponseResult, QueryResponseError> & {
21
+ encodeDataAttribute: EncodeDataAttributeFunction;
22
+ } {
23
+ const DEFAULT_PARAMS = {};
24
+ type UseQueryArguments<QueryResponseResult> = [
25
+ params?: QueryParams,
26
+ options?: UseQueryOptions<QueryResponseResult>,
27
+ ];
28
+
29
+ return <QueryResponseResult, QueryResponseError>(
30
+ query: string,
31
+ ...args: [...UseQueryArguments<QueryResponseResult>, slot?: symbol]
32
+ ) => {
33
+ const userArgs = typeof args[args.length - 1] === 'symbol' ? args.slice(0, -1) : args;
34
+ const [params = DEFAULT_PARAMS, options = {}] =
35
+ userArgs as UseQueryArguments<QueryResponseResult>;
36
+ const initial = useMemo(
37
+ () =>
38
+ options.initial
39
+ ? { perspective: 'published' as const, variant: undefined, ...options.initial }
40
+ : undefined,
41
+ [options.initial],
42
+ );
43
+ const serializedParams = useMemo(() => JSON.stringify(params), [params]);
44
+
45
+ const fetcher = useMemo(
46
+ () =>
47
+ createFetcherStore<QueryResponseResult, QueryResponseError>(
48
+ query,
49
+ JSON.parse(serializedParams),
50
+ initial,
51
+ ),
52
+ [serializedParams, initial, query],
53
+ );
54
+ const [snapshot, setSnapshot] = useLinkedState<
55
+ typeof fetcher,
56
+ QueryStoreState<QueryResponseResult, QueryResponseError>
57
+ >(fetcher, (currentFetcher) => currentFetcher.value!);
58
+
59
+ useEffect(() => {
60
+ return fetcher.subscribe((nextSnapshot) => {
61
+ setSnapshot((previous) => {
62
+ if (!isEqual(previous.sourceMap, nextSnapshot.sourceMap)) return nextSnapshot;
63
+ if (!isEqual(previous.data, nextSnapshot.data)) return nextSnapshot;
64
+ if (previous.error !== nextSnapshot.error) return nextSnapshot;
65
+ if (previous.loading !== nextSnapshot.loading) return nextSnapshot;
66
+ if (previous.perspective !== nextSnapshot.perspective) return nextSnapshot;
67
+ if (previous.variant !== nextSnapshot.variant) return nextSnapshot;
68
+ return previous;
69
+ });
70
+ });
71
+ }, [fetcher]);
72
+
73
+ const studioUrl = useSyncExternalStore(
74
+ studioUrlStore.subscribe,
75
+ studioUrlStore.getSnapshot,
76
+ studioUrlStore.getServerSnapshot,
77
+ );
78
+ const encodeDataAttribute = useEncodeDataAttribute(
79
+ snapshot.data,
80
+ snapshot.sourceMap,
81
+ studioUrl,
82
+ );
83
+
84
+ return useMemo(() => ({ ...snapshot, encodeDataAttribute }), [snapshot, encodeDataAttribute]);
85
+ };
86
+ }
@@ -0,0 +1,3 @@
1
+ export * from './createQueryStore/client-only';
2
+ export * from './useEncodeDataAttribute';
3
+ export * from '@sanity/core-loader/create-data-attribute';
package/src/index.ts ADDED
@@ -0,0 +1,3 @@
1
+ export * from './createQueryStore/universal';
2
+ export * from './useEncodeDataAttribute';
3
+ export * from '@sanity/core-loader/create-data-attribute';
package/src/rsc.ts ADDED
@@ -0,0 +1,5 @@
1
+ export * from './createQueryStore/server-only';
2
+
3
+ export const useEncodeDataAttribute = (): never => {
4
+ throw new Error('The `useEncodeDataAttribute` hook can only be called from a client component.');
5
+ };
package/src/types.ts ADDED
@@ -0,0 +1,83 @@
1
+ import type {
2
+ ClientPerspective,
3
+ ContentSourceMap,
4
+ QueryParams,
5
+ ResponseQueryOptions,
6
+ } from '@sanity/client';
7
+ import type {
8
+ createQueryStore as createCoreQueryStore,
9
+ EnableLiveModeOptions,
10
+ QueryStoreState,
11
+ } from '@sanity/core-loader';
12
+ import type { EncodeDataAttributeFunction } from '@sanity/core-loader/encode-data-attribute';
13
+
14
+ export type * from '@sanity/core-loader';
15
+
16
+ type WithEncodeDataAttribute = {
17
+ encodeDataAttribute: EncodeDataAttributeFunction;
18
+ };
19
+
20
+ export type UseQueryHook = <QueryResponseResult = unknown, QueryResponseError = unknown>(
21
+ query: string,
22
+ params?: QueryParams,
23
+ options?: UseQueryOptions<QueryResponseResult>,
24
+ ) => QueryStoreState<QueryResponseResult, QueryResponseError> & WithEncodeDataAttribute;
25
+
26
+ export interface QueryResponseInitial<QueryResponseResult> {
27
+ data: QueryResponseResult;
28
+ sourceMap: ContentSourceMap | undefined;
29
+ perspective?: ClientPerspective;
30
+ variant?: string;
31
+ }
32
+
33
+ export interface UseQueryOptions<QueryResponseResult = unknown> {
34
+ initial?: QueryResponseInitial<QueryResponseResult>;
35
+ }
36
+
37
+ export interface UseQueryOptionsUndefinedInitial {
38
+ initial?: undefined;
39
+ }
40
+
41
+ export type NonUndefinedGuard<T> = T extends undefined ? never : T;
42
+
43
+ export interface UseQueryOptionsDefinedInitial<QueryResponseResult = unknown> {
44
+ initial: NonUndefinedGuard<QueryResponseInitial<QueryResponseResult>>;
45
+ }
46
+
47
+ export type UseLiveModeHook = (
48
+ options: EnableLiveModeOptions & {
49
+ studioUrl?:
50
+ | import('@sanity/client/csm').StudioUrl
51
+ | import('@sanity/client/csm').ResolveStudioUrl
52
+ | undefined;
53
+ },
54
+ ) => void;
55
+
56
+ export interface QueryStore {
57
+ loadQuery: <QueryResponseResult>(
58
+ query: string,
59
+ params?: QueryParams,
60
+ options?: Pick<
61
+ ResponseQueryOptions,
62
+ 'perspective' | 'cache' | 'next' | 'useCdn' | 'stega' | 'tag' | 'headers'
63
+ > & {
64
+ variant?: string;
65
+ },
66
+ ) => Promise<QueryResponseInitial<QueryResponseResult>>;
67
+ setServerClient: ReturnType<typeof createCoreQueryStore>['setServerClient'];
68
+ useQuery: {
69
+ <QueryResponseResult = unknown, QueryResponseError = unknown>(
70
+ query: string,
71
+ params?: QueryParams,
72
+ options?: UseQueryOptionsUndefinedInitial,
73
+ ): QueryStoreState<QueryResponseResult, QueryResponseError> & WithEncodeDataAttribute;
74
+ <QueryResponseResult = unknown, QueryResponseError = unknown>(
75
+ query: string,
76
+ params?: QueryParams,
77
+ options?: UseQueryOptionsDefinedInitial<QueryResponseResult>,
78
+ ): Omit<QueryStoreState<QueryResponseResult, QueryResponseError>, 'data'> & {
79
+ data: QueryResponseResult;
80
+ } & WithEncodeDataAttribute;
81
+ };
82
+ useLiveMode: UseLiveModeHook;
83
+ }
@@ -0,0 +1,23 @@
1
+ import {
2
+ defineEncodeDataAttribute,
3
+ type EncodeDataAttributeFunction,
4
+ } from '@sanity/core-loader/encode-data-attribute';
5
+ import { useMemo } from 'octane';
6
+
7
+ export type EncodeDataAttributeCallback = (
8
+ path: import('@sanity/client/csm').StudioPathLike,
9
+ ) => string | undefined;
10
+
11
+ export function useEncodeDataAttribute<QueryResponseResult = unknown>(
12
+ result: QueryResponseResult,
13
+ sourceMap: import('@sanity/client/csm').ContentSourceMap | undefined,
14
+ studioUrl:
15
+ | import('@sanity/client/csm').StudioUrl
16
+ | import('@sanity/client/csm').ResolveStudioUrl
17
+ | undefined,
18
+ ): EncodeDataAttributeFunction {
19
+ return useMemo(
20
+ () => defineEncodeDataAttribute(result, sourceMap, studioUrl),
21
+ [result, sourceMap, studioUrl],
22
+ );
23
+ }