hydrogen-sanity 4.2.1 → 4.3.1

package/README.md

@@ -204,7 +204,12 @@ const page = await context.sanity.loadQuery<HomePage>(query, params, {
     // display in the subrequest profiler, you can pass that here:
     // debug: {
     //   displayName: 'query Homepage'
-    // }
+    // },
+
+    // You can also pass a function do determine whether or not to cache the response
+    // shouldCacheResult(value){
+    //  return true
+    // },
   },
 
   // ...as well as other request options

package/dist/index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e=require("@sanity/client"),t=require("@sanity/react-loader"),n=require("@shopify/hydrogen"),i=require("./_chunks-cjs/utils.cjs");const r=n.CacheLong();const a=n.CacheLong();Object.defineProperty(exports,"SanityClient",{enumerable:!0,get:function(){return e.SanityClient}}),Object.defineProperty(exports,"createClient",{enumerable:!0,get:function(){return e.createClient}}),exports.createSanityContext=function(a){const{cache:o,waitUntil:s=()=>Promise.resolve(),request:c,preview:l,defaultStrategy:u}=a,d=o?n.createWithCache({cache:o,waitUntil:s,request:c}):null;let p=a.client instanceof e.SanityClient?a.client:e.createClient(a.client);if("1"===p.config().apiVersion&&(console.warn("No API version specified, defaulting to `v2022-03-07` which supports perspectives.\nYou can find the latest version in the Sanity changelog: https://www.sanity.io/changelog"),p=p.withConfig({apiVersion:"v2022-03-07"})),l&&l.enabled){if(!l.token)throw new Error("Enabling preview mode requires a token.");const e=p.withConfig({useCdn:!1,token:l.token,perspective:"previewDrafts",stega:{...p.config().stega,enabled:!0,studioUrl:l.studioUrl}});t.setServerClient(e)}else t.setServerClient(p);return{async loadQuery(e,a,o){const s=l&&l.enabled?n.CacheNone():o?.hydrogen?.cache||u||r,c=await i.h(e,a);return await(d?d(c,s,(async({addDebugData:n})=>{if("development"===process.env.NODE_ENV){n({displayName:o?.hydrogen?.debug?.displayName||"query Sanity"})}return await t.loadQuery(e,a,o)})):t.loadQuery(e,a,o))},client:p,preview:l}},exports.createSanityLoader=function(r){const{withCache:o,preview:s,strategy:c}=r;let l=r.client instanceof e.SanityClient?r.client:e.createClient(r.client);if("1"===l.config().apiVersion&&(console.warn("No API version specified, defaulting to `v2022-03-07` which supports perspectives.\nYou can find the latest version in the Sanity changelog: https://www.sanity.io/changelog"),l=l.withConfig({apiVersion:"v2022-03-07"})),s&&s.enabled){if(!s.token)throw new Error("Enabling preview mode requires a token.");const e=l.withConfig({useCdn:!1,token:s.token,perspective:"previewDrafts",stega:{...l.config().stega,enabled:!0,studioUrl:s.studioUrl}});t.setServerClient(e)}else t.setServerClient(l);return{async loadQuery(e,r,l){const u=s&&s.enabled?n.CacheNone():l?.hydrogen?.cache||c||a,d=await i.h(e,r);return await o(d,u,(async({addDebugData:n})=>{if("development"===process.env.NODE_ENV){n({displayName:l?.hydrogen?.debug?.displayName||"query Sanity"})}return await t.loadQuery(e,r,l)}))},client:l,preview:s}};//# sourceMappingURL=index.cjs.map
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e=require("@sanity/client"),t=require("@sanity/react-loader"),n=require("@shopify/hydrogen"),i=require("./_chunks-cjs/utils.cjs");const r=n.CacheLong();const a=n.CacheLong();Object.defineProperty(exports,"SanityClient",{enumerable:!0,get:function(){return e.SanityClient}}),Object.defineProperty(exports,"createClient",{enumerable:!0,get:function(){return e.createClient}}),exports.createSanityContext=function(a){const{cache:o,waitUntil:s=()=>Promise.resolve(),request:c,preview:l,defaultStrategy:u}=a,d=o?n.createWithCache({cache:o,waitUntil:s,request:c}):null;let h=a.client instanceof e.SanityClient?a.client:e.createClient(a.client);if("1"===h.config().apiVersion&&(console.warn("No API version specified, defaulting to `v2022-03-07` which supports perspectives.\nYou can find the latest version in the Sanity changelog: https://www.sanity.io/changelog"),h=h.withConfig({apiVersion:"v2022-03-07"})),l&&l.enabled){if(!l.token)throw new Error("Enabling preview mode requires a token.");const e=h.withConfig({useCdn:!1,token:l.token,perspective:"previewDrafts",stega:{...h.config().stega,enabled:!0,studioUrl:l.studioUrl}});t.setServerClient(e)}else t.setServerClient(h);return{async loadQuery(e,a,o){if(!d)return await t.loadQuery(e,a,o);const s=l&&l.enabled?n.CacheNone():o?.hydrogen?.cache||u||r,c=await i.h(e,a),h=o?.hydrogen?.shouldCacheResult??(()=>!0),y=async function({addDebugData:n}){if("development"===process.env.NODE_ENV){n({displayName:o?.hydrogen?.debug?.displayName||"query Sanity"})}return await t.loadQuery(e,a,o)};return await("run"in d?d.run({cacheKey:c,cacheStrategy:s,shouldCacheResult:h},y):d(c,s,y))},client:h,preview:l}},exports.createSanityLoader=function(r){const{withCache:o,preview:s,strategy:c}=r;let l=r.client instanceof e.SanityClient?r.client:e.createClient(r.client);if("1"===l.config().apiVersion&&(console.warn("No API version specified, defaulting to `v2022-03-07` which supports perspectives.\nYou can find the latest version in the Sanity changelog: https://www.sanity.io/changelog"),l=l.withConfig({apiVersion:"v2022-03-07"})),s&&s.enabled){if(!s.token)throw new Error("Enabling preview mode requires a token.");const e=l.withConfig({useCdn:!1,token:s.token,perspective:"previewDrafts",stega:{...l.config().stega,enabled:!0,studioUrl:s.studioUrl}});t.setServerClient(e)}else t.setServerClient(l);return{async loadQuery(e,r,l){const u=s&&s.enabled?n.CacheNone():l?.hydrogen?.cache||c||a,d=await i.h(e,r),h=l?.hydrogen?.shouldCacheResult??(()=>!0),y=async function({addDebugData:n}){if("development"===process.env.NODE_ENV){n({displayName:l?.hydrogen?.debug?.displayName||"query Sanity"})}return await t.loadQuery(e,r,l)};return await("run"in o?o.run({cacheKey:d,cacheStrategy:u,shouldCacheResult:h},y):o(d,u,y))},client:l,preview:s}};//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sources":["../src/context.ts","../src/loader.ts"],"sourcesContent":["import {loadQuery, type QueryResponseInitial, setServerClient} from '@sanity/react-loader'\nimport {CacheLong, CacheNone, type CachingStrategy, createWithCache} from '@shopify/hydrogen'\n\nimport {\n  type ClientConfig,\n  createClient,\n  type QueryParams,\n  type QueryWithoutParams,\n  type ResponseQueryOptions,\n  SanityClient,\n} from './client'\nimport {hashQuery} from './utils'\n\nconst DEFAULT_CACHE_STRATEGY = CacheLong()\n\ntype WaitUntil = (promise: Promise<unknown>) => void\n\nexport type CreateSanityContextOptions = {\n  request: Request\n\n  cache?: Cache | undefined\n  waitUntil?: WaitUntil | undefined\n\n  /**\n   * Sanity client or configuration to use.\n   */\n  client: SanityClient | ClientConfig\n\n  /**\n   * The default caching strategy to use for `loadQuery` subrequests.\n   * @see https://shopify.dev/docs/custom-storefronts/hydrogen/caching#caching-strategies\n   *\n   * Defaults to `CacheLong`\n   */\n  defaultStrategy?: CachingStrategy | null\n\n  /**\n   * Configuration for enabling preview mode.\n   */\n  preview?: {enabled: boolean; token: string; studioUrl: string}\n}\n\ninterface RequestInit {\n  hydrogen?: {\n    /**\n     * The caching strategy to use for the subrequest.\n     * @see https://shopify.dev/docs/custom-storefronts/hydrogen/caching#caching-strategies\n     */\n    cache?: CachingStrategy\n\n    /**\n     * Optional debugging information to be displayed in the subrequest profiler.\n     * @see https://shopify.dev/docs/custom-storefronts/hydrogen/debugging/subrequest-profiler#how-to-provide-more-debug-information-for-a-request\n     */\n    debug?: {\n      displayName: string\n    }\n  }\n}\n\ntype HydrogenResponseQueryOptions = Omit<ResponseQueryOptions, 'next' | 'cache'> & {\n  hydrogen?: 'hydrogen' extends keyof RequestInit ? RequestInit['hydrogen'] : never\n}\n\ntype LoadQueryOptions = Pick<\n  HydrogenResponseQueryOptions,\n  'perspective' | 'hydrogen' | 'useCdn' | 'stega' | 'headers' | 'tag'\n>\n\nexport type SanityContext = {\n  /**\n   * Query Sanity using the loader.\n   * @see https://www.sanity.io/docs/loaders\n   */\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  loadQuery<T = any>(\n    query: string,\n    params?: QueryParams,\n    options?: LoadQueryOptions,\n  ): Promise<QueryResponseInitial<T>>\n\n  client: SanityClient\n\n  preview?: CreateSanityContextOptions['preview']\n}\n\n/**\n * @public\n */\nexport function createSanityContext(options: CreateSanityContextOptions): SanityContext {\n  const {cache, waitUntil = () => Promise.resolve(), request, preview, defaultStrategy} = options\n  const withCache = cache ? createWithCache({cache, waitUntil, request}) : null\n  let client =\n    options.client instanceof SanityClient ? options.client : createClient(options.client)\n\n  if (client.config().apiVersion === '1') {\n    console.warn(\n      'No API version specified, defaulting to `v2022-03-07` which supports perspectives.\\nYou can find the latest version in the Sanity changelog: https://www.sanity.io/changelog',\n    )\n    client = client.withConfig({apiVersion: 'v2022-03-07'})\n  }\n\n  if (preview && preview.enabled) {\n    if (!preview.token) {\n      throw new Error('Enabling preview mode requires a token.')\n    }\n\n    const previewClient = client.withConfig({\n      useCdn: false,\n      token: preview.token,\n      perspective: 'previewDrafts' as const,\n      stega: {\n        ...client.config().stega,\n        enabled: true,\n        studioUrl: preview.studioUrl,\n      },\n    })\n\n    setServerClient(previewClient)\n  } else {\n    setServerClient(client)\n  }\n\n  const sanity = {\n    async loadQuery<T>(\n      query: string,\n      params: QueryParams | QueryWithoutParams,\n      loaderOptions?: LoadQueryOptions,\n    ): Promise<QueryResponseInitial<T>> {\n      // Don't store response if preview is enabled\n      const cacheStrategy =\n        preview && preview.enabled\n          ? CacheNone()\n          : loaderOptions?.hydrogen?.cache || defaultStrategy || DEFAULT_CACHE_STRATEGY\n\n      const queryHash = await hashQuery(query, params)\n\n      return await (withCache\n        ? withCache(queryHash, cacheStrategy, async ({addDebugData}) => {\n            if (process.env.NODE_ENV === 'development') {\n              // Name displayed in the subrequest profiler\n              const displayName = loaderOptions?.hydrogen?.debug?.displayName || 'query Sanity'\n\n              addDebugData({\n                displayName,\n              })\n            }\n\n            return await loadQuery<T>(query, params, loaderOptions)\n          })\n        : loadQuery<T>(query, params, loaderOptions))\n    },\n    client,\n    preview,\n  }\n\n  return sanity\n}\n","import {loadQuery, type QueryResponseInitial, setServerClient} from '@sanity/react-loader'\nimport {CacheLong, CacheNone, type CachingStrategy, type WithCache} from '@shopify/hydrogen'\n\nimport {\n  type ClientConfig,\n  createClient,\n  type QueryParams,\n  type QueryWithoutParams,\n  type ResponseQueryOptions,\n  SanityClient,\n} from './client'\nimport {hashQuery} from './utils'\n\nconst DEFAULT_CACHE_STRATEGY = CacheLong()\n\nexport type CreateSanityLoaderOptions = {\n  /**\n   * Cache control utility from `@shopify/hydrogen`.\n   * @see https://shopify.dev/docs/custom-storefronts/hydrogen/caching/third-party\n   */\n  withCache: WithCache\n\n  /**\n   * Sanity client or configuration to use.\n   */\n  client: SanityClient | ClientConfig\n\n  /**\n   * The default caching strategy to use for `loadQuery` subrequests.\n   * @see https://shopify.dev/docs/custom-storefronts/hydrogen/caching#caching-strategies\n   *\n   * Defaults to `CacheLong`\n   */\n  strategy?: CachingStrategy | null\n\n  /**\n   * Configuration for enabling preview mode.\n   */\n  preview?: {enabled: boolean; token: string; studioUrl: string}\n}\n\ninterface RequestInit {\n  hydrogen?: {\n    /**\n     * The caching strategy to use for the subrequest.\n     * @see https://shopify.dev/docs/custom-storefronts/hydrogen/caching#caching-strategies\n     */\n    cache?: CachingStrategy\n\n    /**\n     * Optional debugging information to be displayed in the subrequest profiler.\n     * @see https://shopify.dev/docs/custom-storefronts/hydrogen/debugging/subrequest-profiler#how-to-provide-more-debug-information-for-a-request\n     */\n    debug?: {\n      displayName: string\n    }\n  }\n}\n\ntype HydrogenResponseQueryOptions = Omit<ResponseQueryOptions, 'next' | 'cache'> & {\n  hydrogen?: 'hydrogen' extends keyof RequestInit ? RequestInit['hydrogen'] : never\n}\n\ntype LoadQueryOptions = Pick<\n  HydrogenResponseQueryOptions,\n  'perspective' | 'hydrogen' | 'useCdn' | 'stega' | 'headers' | 'tag'\n>\n\nexport type SanityLoader = {\n  /**\n   * Query Sanity using the loader.\n   * @see https://www.sanity.io/docs/loaders\n   */\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  loadQuery<T = any>(\n    query: string,\n    params?: QueryParams,\n    options?: LoadQueryOptions,\n  ): Promise<QueryResponseInitial<T>>\n\n  client: SanityClient\n\n  preview?: CreateSanityLoaderOptions['preview']\n}\n\n/**\n * @deprecated Use `createSanityContext` instead\n */\nexport function createSanityLoader(options: CreateSanityLoaderOptions): SanityLoader {\n  const {withCache, preview, strategy} = options\n  let client =\n    options.client instanceof SanityClient ? options.client : createClient(options.client)\n\n  if (client.config().apiVersion === '1') {\n    console.warn(\n      'No API version specified, defaulting to `v2022-03-07` which supports perspectives.\\nYou can find the latest version in the Sanity changelog: https://www.sanity.io/changelog',\n    )\n    client = client.withConfig({apiVersion: 'v2022-03-07'})\n  }\n\n  if (preview && preview.enabled) {\n    if (!preview.token) {\n      throw new Error('Enabling preview mode requires a token.')\n    }\n\n    const previewClient = client.withConfig({\n      useCdn: false,\n      token: preview.token,\n      perspective: 'previewDrafts' as const,\n      stega: {\n        ...client.config().stega,\n        enabled: true,\n        studioUrl: preview.studioUrl,\n      },\n    })\n\n    setServerClient(previewClient)\n  } else {\n    setServerClient(client)\n  }\n\n  const sanity = {\n    async loadQuery<T>(\n      query: string,\n      params: QueryParams | QueryWithoutParams,\n      loaderOptions?: LoadQueryOptions,\n    ): Promise<QueryResponseInitial<T>> {\n      // Don't store response if preview is enabled\n      const cacheStrategy =\n        preview && preview.enabled\n          ? CacheNone()\n          : loaderOptions?.hydrogen?.cache || strategy || DEFAULT_CACHE_STRATEGY\n\n      const queryHash = await hashQuery(query, params)\n\n      return await withCache(queryHash, cacheStrategy, async ({addDebugData}) => {\n        // eslint-disable-next-line no-process-env\n        if (process.env.NODE_ENV === 'development') {\n          // Name displayed in the subrequest profiler\n          const displayName = loaderOptions?.hydrogen?.debug?.displayName || 'query Sanity'\n\n          addDebugData({\n            displayName,\n          })\n        }\n\n        return await loadQuery<T>(query, params, loaderOptions)\n      })\n    },\n    client,\n    preview,\n  }\n\n  return sanity\n}\n"],"names":["DEFAULT_CACHE_STRATEGY","CacheLong","Object","defineProperty","exports","enumerable","get","client","SanityClient","createClient","createSanityContext","options","cache","waitUntil","Promise","resolve","request","preview","defaultStrategy","withCache","createWithCache","config","apiVersion","console","warn","withConfig","enabled","token","Error","previewClient","useCdn","perspective","stega","studioUrl","setServerClient","loadQuery","query","params","loaderOptions","cacheStrategy","CacheNone","hydrogen","queryHash","hashQuery","h","async","addDebugData","process","env","NODE_ENV","displayName","debug","createSanityLoader","strategy"],"mappings":"0MAaA,MAAMA,EAAyBC,EAAAA,YCA/B,MAAMD,EAAyBC,EAAAA,YA6I/BC,OAAAC,eAAAC,QAAA,eAAA,CAAAC,YAAA,EAAAC,IAAA,WAAA,OAAAC,EAAAC,YAAA,IAAAN,OAAAC,eAAAC,QAAA,eAAA,CAAAC,YAAA,EAAAC,IAAA,WAAA,OAAAC,EAAAE,YAAA,IAAAL,QAAAM,oBDjEO,SAA6BC,GAC5B,MAAAC,MAACA,YAAOC,EAAY,IAAMC,QAAQC,kBAAWC,UAASC,EAASC,gBAAAA,GAAmBP,EAClFQ,EAAYP,EAAQQ,kBAAgB,CAACR,QAAOC,YAAWG,YAAY,KACrET,IAAAA,EACFI,EAAQJ,kBAAkBC,EAAAA,aAAeG,EAAQJ,OAASE,EAAAA,aAAaE,EAAQJ,QASjF,GAPmC,MAA/BA,EAAOc,SAASC,aAClBC,QAAQC,KACN,gLAEFjB,EAASA,EAAOkB,WAAW,CAACH,WAAY,iBAGtCL,GAAWA,EAAQS,QAAS,CAC9B,IAAKT,EAAQU,MACL,MAAA,IAAIC,MAAM,2CAGZ,MAAAC,EAAgBtB,EAAOkB,WAAW,CACtCK,QAAQ,EACRH,MAAOV,EAAQU,MACfI,YAAa,gBACbC,MAAO,IACFzB,EAAOc,SAASW,MACnBN,SAAS,EACTO,UAAWhB,EAAQgB,aAIvBC,EAAAA,gBAAgBL,EAClB,MACEK,EAAAA,gBAAgB3B,GAGH,MAAA,CACb,eAAM4B,CACJC,EACAC,EACAC,GAGA,MAAMC,EACJtB,GAAWA,EAAQS,QACfc,EAAAA,YACAF,GAAeG,UAAU7B,OAASM,GAAmBlB,EAErD0C,QAAkBC,EAAAC,EAAUR,EAAOC,GAElC,aAAOlB,EACVA,EAAUuB,EAAWH,GAAeM,OAAQC,mBACtC,GAAyB,gBAAzBC,QAAQC,IAAIC,SAA4B,CAI7BH,EAAA,CACXI,YAHkBZ,GAAeG,UAAUU,OAAOD,aAAe,gBAIlE,CAGH,aAAaf,EAAAA,UAAaC,EAAOC,EAAQC,EAAa,IAExDH,EAAAA,UAAaC,EAAOC,EAAQC,GAClC,EAAA/B,OACAA,EACAU,UAIJ,ECHAb,QAAAgD,mBAlEO,SAA4BzC,GACjC,MAAMQ,UAACA,EAAAF,QAAWA,EAASoC,SAAAA,GAAY1C,EACnCJ,IAAAA,EACFI,EAAQJ,kBAAkBC,EAAAA,aAAeG,EAAQJ,OAASE,EAAAA,aAAaE,EAAQJ,QASjF,GAPmC,MAA/BA,EAAOc,SAASC,aAClBC,QAAQC,KACN,gLAEFjB,EAASA,EAAOkB,WAAW,CAACH,WAAY,iBAGtCL,GAAWA,EAAQS,QAAS,CAC9B,IAAKT,EAAQU,MACL,MAAA,IAAIC,MAAM,2CAGZ,MAAAC,EAAgBtB,EAAOkB,WAAW,CACtCK,QAAQ,EACRH,MAAOV,EAAQU,MACfI,YAAa,gBACbC,MAAO,IACFzB,EAAOc,SAASW,MACnBN,SAAS,EACTO,UAAWhB,EAAQgB,aAIvBC,EAAAA,gBAAgBL,EAClB,MACEK,EAAAA,gBAAgB3B,GAGH,MAAA,CACb,eAAM4B,CACJC,EACAC,EACAC,GAGA,MAAMC,EACJtB,GAAWA,EAAQS,QACfc,EAAAA,YACAF,GAAeG,UAAU7B,OAASyC,GAAYrD,EAE9C0C,QAAkBC,EAAAC,EAAUR,EAAOC,GAEzC,aAAalB,EAAUuB,EAAWH,GAAeM,OAAQC,mBAEnD,GAAyB,gBAAzBC,QAAQC,IAAIC,SAA4B,CAI7BH,EAAA,CACXI,YAHkBZ,GAAeG,UAAUU,OAAOD,aAAe,gBAIlE,CAGH,aAAaf,EAAAA,UAAaC,EAAOC,EAAQC,EAAa,GAE1D,EAAA/B,OACAA,EACAU,UAIJ"}
+{"version":3,"file":"index.cjs","sources":["../src/context.ts","../src/loader.ts"],"sourcesContent":["import {loadQuery, type QueryResponseInitial, setServerClient} from '@sanity/react-loader'\nimport {\n  CacheLong,\n  CacheNone,\n  type CachingStrategy,\n  createWithCache,\n  type WithCache,\n} from '@shopify/hydrogen'\n\nimport {\n  type ClientConfig,\n  createClient,\n  type QueryParams,\n  type QueryWithoutParams,\n  type ResponseQueryOptions,\n  SanityClient,\n} from './client'\nimport {hashQuery} from './utils'\n\nconst DEFAULT_CACHE_STRATEGY = CacheLong()\n\ntype WaitUntil = (promise: Promise<unknown>) => void\n\nexport type CreateSanityContextOptions = {\n  request: Request\n\n  cache?: Cache | undefined\n  waitUntil?: WaitUntil | undefined\n\n  /**\n   * Sanity client or configuration to use.\n   */\n  client: SanityClient | ClientConfig\n\n  /**\n   * The default caching strategy to use for `loadQuery` subrequests.\n   * @see https://shopify.dev/docs/custom-storefronts/hydrogen/caching#caching-strategies\n   *\n   * Defaults to `CacheLong`\n   */\n  defaultStrategy?: CachingStrategy | null\n\n  /**\n   * Configuration for enabling preview mode.\n   */\n  preview?: {enabled: boolean; token: string; studioUrl: string}\n}\n\ninterface RequestInit {\n  hydrogen?: {\n    /**\n     * The caching strategy to use for the subrequest.\n     * @see https://shopify.dev/docs/custom-storefronts/hydrogen/caching#caching-strategies\n     */\n    cache?: CachingStrategy\n\n    /**\n     * Optional debugging information to be displayed in the subrequest profiler.\n     * @see https://shopify.dev/docs/custom-storefronts/hydrogen/debugging/subrequest-profiler#how-to-provide-more-debug-information-for-a-request\n     */\n    debug?: {\n      displayName: string\n    }\n  }\n}\n\ntype HydrogenResponseQueryOptions = Omit<ResponseQueryOptions, 'next' | 'cache'> & {\n  hydrogen?: 'hydrogen' extends keyof RequestInit ? RequestInit['hydrogen'] : never\n}\n\ntype LoadQueryOptions<T> = Pick<\n  HydrogenResponseQueryOptions,\n  'perspective' | 'hydrogen' | 'useCdn' | 'stega' | 'headers' | 'tag'\n> & {\n  hydrogen?: {\n    /**\n     * Whether to cache the result of the query or not.\n     * @defaultValue () => true\n     */\n    shouldCacheResult?: (value: QueryResponseInitial<T>) => boolean\n  }\n}\n\nexport type SanityContext = {\n  /**\n   * Query Sanity using the loader.\n   * @see https://www.sanity.io/docs/loaders\n   */\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  loadQuery<T = any>(\n    query: string,\n    params?: QueryParams,\n    options?: LoadQueryOptions<T>,\n  ): Promise<QueryResponseInitial<T>>\n\n  client: SanityClient\n\n  preview?: CreateSanityContextOptions['preview']\n}\n\n/**\n * @public\n */\nexport function createSanityContext(options: CreateSanityContextOptions): SanityContext {\n  const {cache, waitUntil = () => Promise.resolve(), request, preview, defaultStrategy} = options\n  const withCache = cache ? createWithCache({cache, waitUntil, request}) : null\n  let client =\n    options.client instanceof SanityClient ? options.client : createClient(options.client)\n\n  if (client.config().apiVersion === '1') {\n    console.warn(\n      'No API version specified, defaulting to `v2022-03-07` which supports perspectives.\\nYou can find the latest version in the Sanity changelog: https://www.sanity.io/changelog',\n    )\n    client = client.withConfig({apiVersion: 'v2022-03-07'})\n  }\n\n  if (preview && preview.enabled) {\n    if (!preview.token) {\n      throw new Error('Enabling preview mode requires a token.')\n    }\n\n    const previewClient = client.withConfig({\n      useCdn: false,\n      token: preview.token,\n      perspective: 'previewDrafts' as const,\n      stega: {\n        ...client.config().stega,\n        enabled: true,\n        studioUrl: preview.studioUrl,\n      },\n    })\n\n    setServerClient(previewClient)\n  } else {\n    setServerClient(client)\n  }\n\n  const sanity = {\n    async loadQuery<T>(\n      query: string,\n      params: QueryParams | QueryWithoutParams,\n      loaderOptions?: LoadQueryOptions<T>,\n    ): Promise<QueryResponseInitial<T>> {\n      if (!withCache) {\n        return await loadQuery<T>(query, params, loaderOptions)\n      }\n\n      // Don't store response if preview is enabled\n      const cacheStrategy =\n        preview && preview.enabled\n          ? CacheNone()\n          : loaderOptions?.hydrogen?.cache || defaultStrategy || DEFAULT_CACHE_STRATEGY\n\n      const queryHash = await hashQuery(query, params)\n      const shouldCacheResult = loaderOptions?.hydrogen?.shouldCacheResult ?? (() => true)\n\n      const runWithCache = async function runWithCache({\n        addDebugData,\n      }: Parameters<Parameters<WithCache['run']>[1]>[0]): Promise<QueryResponseInitial<T>> {\n        // eslint-disable-next-line no-process-env\n        if (process.env.NODE_ENV === 'development') {\n          // Name displayed in the subrequest profiler\n          const displayName = loaderOptions?.hydrogen?.debug?.displayName || 'query Sanity'\n\n          addDebugData({\n            displayName,\n          })\n        }\n\n        return await loadQuery<T>(query, params, loaderOptions)\n      }\n\n      return await ('run' in withCache\n        ? withCache.run({cacheKey: queryHash, cacheStrategy, shouldCacheResult}, runWithCache)\n        : // @ts-expect-error for compatibility, remove in next major\n          withCache(queryHash, cacheStrategy, runWithCache))\n    },\n    client,\n    preview,\n  }\n\n  return sanity\n}\n","import {loadQuery, type QueryResponseInitial, setServerClient} from '@sanity/react-loader'\nimport {CacheLong, CacheNone, type CachingStrategy, type WithCache} from '@shopify/hydrogen'\n\nimport {\n  type ClientConfig,\n  createClient,\n  type QueryParams,\n  type QueryWithoutParams,\n  type ResponseQueryOptions,\n  SanityClient,\n} from './client'\nimport {hashQuery} from './utils'\n\nconst DEFAULT_CACHE_STRATEGY = CacheLong()\n\nexport type CreateSanityLoaderOptions = {\n  /**\n   * Cache control utility from `@shopify/hydrogen`.\n   * @see https://shopify.dev/docs/custom-storefronts/hydrogen/caching/third-party\n   */\n  withCache: WithCache\n\n  /**\n   * Sanity client or configuration to use.\n   */\n  client: SanityClient | ClientConfig\n\n  /**\n   * The default caching strategy to use for `loadQuery` subrequests.\n   * @see https://shopify.dev/docs/custom-storefronts/hydrogen/caching#caching-strategies\n   *\n   * Defaults to `CacheLong`\n   */\n  strategy?: CachingStrategy | null\n\n  /**\n   * Configuration for enabling preview mode.\n   */\n  preview?: {enabled: boolean; token: string; studioUrl: string}\n}\n\ninterface RequestInit {\n  hydrogen?: {\n    /**\n     * The caching strategy to use for the subrequest.\n     * @see https://shopify.dev/docs/custom-storefronts/hydrogen/caching#caching-strategies\n     */\n    cache?: CachingStrategy\n\n    /**\n     * Optional debugging information to be displayed in the subrequest profiler.\n     * @see https://shopify.dev/docs/custom-storefronts/hydrogen/debugging/subrequest-profiler#how-to-provide-more-debug-information-for-a-request\n     */\n    debug?: {\n      displayName: string\n    }\n  }\n}\n\ntype HydrogenResponseQueryOptions = Omit<ResponseQueryOptions, 'next' | 'cache'> & {\n  hydrogen?: 'hydrogen' extends keyof RequestInit ? RequestInit['hydrogen'] : never\n}\n\ntype LoadQueryOptions<T> = Pick<\n  HydrogenResponseQueryOptions,\n  'perspective' | 'hydrogen' | 'useCdn' | 'stega' | 'headers' | 'tag'\n> & {\n  hydrogen?: {\n    /**\n     * Whether to cache the result of the query or not.\n     * @defaultValue () => true\n     */\n    shouldCacheResult?: (value: QueryResponseInitial<T>) => boolean\n  }\n}\n\nexport type SanityLoader = {\n  /**\n   * Query Sanity using the loader.\n   * @see https://www.sanity.io/docs/loaders\n   */\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  loadQuery<T = any>(\n    query: string,\n    params?: QueryParams,\n    options?: LoadQueryOptions<T>,\n  ): Promise<QueryResponseInitial<T>>\n\n  client: SanityClient\n\n  preview?: CreateSanityLoaderOptions['preview']\n}\n\n/**\n * @deprecated Use `createSanityContext` instead\n */\nexport function createSanityLoader(options: CreateSanityLoaderOptions): SanityLoader {\n  const {withCache, preview, strategy} = options\n  let client =\n    options.client instanceof SanityClient ? options.client : createClient(options.client)\n\n  if (client.config().apiVersion === '1') {\n    console.warn(\n      'No API version specified, defaulting to `v2022-03-07` which supports perspectives.\\nYou can find the latest version in the Sanity changelog: https://www.sanity.io/changelog',\n    )\n    client = client.withConfig({apiVersion: 'v2022-03-07'})\n  }\n\n  if (preview && preview.enabled) {\n    if (!preview.token) {\n      throw new Error('Enabling preview mode requires a token.')\n    }\n\n    const previewClient = client.withConfig({\n      useCdn: false,\n      token: preview.token,\n      perspective: 'previewDrafts' as const,\n      stega: {\n        ...client.config().stega,\n        enabled: true,\n        studioUrl: preview.studioUrl,\n      },\n    })\n\n    setServerClient(previewClient)\n  } else {\n    setServerClient(client)\n  }\n\n  const sanity = {\n    async loadQuery<T>(\n      query: string,\n      params: QueryParams | QueryWithoutParams,\n      loaderOptions?: LoadQueryOptions<T>,\n    ): Promise<QueryResponseInitial<T>> {\n      // Don't store response if preview is enabled\n      const cacheStrategy =\n        preview && preview.enabled\n          ? CacheNone()\n          : loaderOptions?.hydrogen?.cache || strategy || DEFAULT_CACHE_STRATEGY\n\n      const queryHash = await hashQuery(query, params)\n\n      const shouldCacheResult = loaderOptions?.hydrogen?.shouldCacheResult ?? (() => true)\n\n      const runWithCache = async function runWithCache({\n        addDebugData,\n      }: Parameters<Parameters<WithCache['run']>[1]>[0]): Promise<QueryResponseInitial<T>> {\n        // eslint-disable-next-line no-process-env\n        if (process.env.NODE_ENV === 'development') {\n          // Name displayed in the subrequest profiler\n          const displayName = loaderOptions?.hydrogen?.debug?.displayName || 'query Sanity'\n\n          addDebugData({\n            displayName,\n          })\n        }\n\n        return await loadQuery<T>(query, params, loaderOptions)\n      }\n\n      return await ('run' in withCache\n        ? withCache.run({cacheKey: queryHash, cacheStrategy, shouldCacheResult}, runWithCache)\n        : // @ts-expect-error for compatibility, remove in next major\n          withCache(queryHash, cacheStrategy, runWithCache))\n    },\n    client,\n    preview,\n  }\n\n  return sanity\n}\n"],"names":["DEFAULT_CACHE_STRATEGY","CacheLong","Object","defineProperty","exports","enumerable","get","client","SanityClient","createClient","createSanityContext","options","cache","waitUntil","Promise","resolve","request","preview","defaultStrategy","withCache","createWithCache","config","apiVersion","console","warn","withConfig","enabled","token","Error","previewClient","useCdn","perspective","stega","studioUrl","setServerClient","loadQuery","query","params","loaderOptions","cacheStrategy","CacheNone","hydrogen","queryHash","hashQuery","shouldCacheResult","runWithCache","async","addDebugData","process","env","NODE_ENV","displayName","debug","run","cacheKey","createSanityLoader","strategy"],"mappings":"0MAmBA,MAAMA,EAAyBC,EAAAA,YCN/B,MAAMD,EAAyBC,EAAAA,YA8J/BC,OAAAC,eAAAC,QAAA,eAAA,CAAAC,YAAA,EAAAC,IAAA,WAAA,OAAAC,EAAAC,YAAA,IAAAN,OAAAC,eAAAC,QAAA,eAAA,CAAAC,YAAA,EAAAC,IAAA,WAAA,OAAAC,EAAAE,YAAA,IAAAL,QAAAM,oBDpEO,SAA6BC,GAC5B,MAAAC,MAACA,YAAOC,EAAY,IAAMC,QAAQC,kBAAWC,UAASC,EAASC,gBAAAA,GAAmBP,EAClFQ,EAAYP,EAAQQ,kBAAgB,CAACR,QAAOC,YAAWG,YAAY,KACrET,IAAAA,EACFI,EAAQJ,kBAAkBC,EAAAA,aAAeG,EAAQJ,OAASE,EAAAA,aAAaE,EAAQJ,QASjF,GAPmC,MAA/BA,EAAOc,SAASC,aAClBC,QAAQC,KACN,gLAEFjB,EAASA,EAAOkB,WAAW,CAACH,WAAY,iBAGtCL,GAAWA,EAAQS,QAAS,CAC9B,IAAKT,EAAQU,MACL,MAAA,IAAIC,MAAM,2CAGZ,MAAAC,EAAgBtB,EAAOkB,WAAW,CACtCK,QAAQ,EACRH,MAAOV,EAAQU,MACfI,YAAa,gBACbC,MAAO,IACFzB,EAAOc,SAASW,MACnBN,SAAS,EACTO,UAAWhB,EAAQgB,aAIvBC,EAAAA,gBAAgBL,EAClB,MACEK,EAAAA,gBAAgB3B,GAGH,MAAA,CACb,eAAM4B,CACJC,EACAC,EACAC,GAEA,IAAKnB,EACH,aAAagB,EAAAA,UAAaC,EAAOC,EAAQC,GAIrC,MAAAC,EACJtB,GAAWA,EAAQS,QACfc,EAAAA,YACAF,GAAeG,UAAU7B,OAASM,GAAmBlB,EAErD0C,QAAkBC,EAAAA,EAAUP,EAAOC,GACnCO,EAAoBN,GAAeG,UAAUG,mBAAsB,MAAM,GAEzEC,EAAeC,gBAA4BC,aAC/CA,IAGI,GAAyB,gBAAzBC,QAAQC,IAAIC,SAA4B,CAI7BH,EAAA,CACXI,YAHkBb,GAAeG,UAAUW,OAAOD,aAAe,gBAIlE,CAGH,aAAahB,EAAAA,UAAaC,EAAOC,EAAQC,EAC3C,EAEO,aAAO,QAASnB,EACnBA,EAAUkC,IAAI,CAACC,SAAUZ,EAAWH,gBAAeK,qBAAoBC,GAEvE1B,EAAUuB,EAAWH,EAAeM,GAC1C,EAAAtC,OACAA,EACAU,UAIJ,ECXAb,QAAAmD,mBA3EO,SAA4B5C,GACjC,MAAMQ,UAACA,EAAAF,QAAWA,EAASuC,SAAAA,GAAY7C,EACnCJ,IAAAA,EACFI,EAAQJ,kBAAkBC,EAAAA,aAAeG,EAAQJ,OAASE,EAAAA,aAAaE,EAAQJ,QASjF,GAPmC,MAA/BA,EAAOc,SAASC,aAClBC,QAAQC,KACN,gLAEFjB,EAASA,EAAOkB,WAAW,CAACH,WAAY,iBAGtCL,GAAWA,EAAQS,QAAS,CAC9B,IAAKT,EAAQU,MACL,MAAA,IAAIC,MAAM,2CAGZ,MAAAC,EAAgBtB,EAAOkB,WAAW,CACtCK,QAAQ,EACRH,MAAOV,EAAQU,MACfI,YAAa,gBACbC,MAAO,IACFzB,EAAOc,SAASW,MACnBN,SAAS,EACTO,UAAWhB,EAAQgB,aAIvBC,EAAAA,gBAAgBL,EAClB,MACEK,EAAAA,gBAAgB3B,GAGH,MAAA,CACb,eAAM4B,CACJC,EACAC,EACAC,GAGM,MAAAC,EACJtB,GAAWA,EAAQS,QACfc,EAAAA,YACAF,GAAeG,UAAU7B,OAAS4C,GAAYxD,EAE9C0C,QAAkBC,EAAAA,EAAUP,EAAOC,GAEnCO,EAAoBN,GAAeG,UAAUG,mBAAsB,MAAM,GAEzEC,EAAeC,gBAA4BC,aAC/CA,IAGI,GAAyB,gBAAzBC,QAAQC,IAAIC,SAA4B,CAI7BH,EAAA,CACXI,YAHkBb,GAAeG,UAAUW,OAAOD,aAAe,gBAIlE,CAGH,aAAahB,EAAAA,UAAaC,EAAOC,EAAQC,EAC3C,EAEO,aAAO,QAASnB,EACnBA,EAAUkC,IAAI,CAACC,SAAUZ,EAAWH,gBAAeK,qBAAoBC,GAEvE1B,EAAUuB,EAAWH,EAAeM,GAC1C,EAAAtC,OACAA,EACAU,UAIJ"}

package/dist/index.d.cts

@@ -79,15 +79,31 @@ declare type HydrogenResponseQueryOptions_2 = Omit<ResponseQueryOptions, 'next'
   hydrogen?: 'hydrogen' extends keyof RequestInit_3 ? RequestInit_3['hydrogen'] : never
 }
 
-declare type LoadQueryOptions = Pick<
+declare type LoadQueryOptions<T> = Pick<
   HydrogenResponseQueryOptions,
   'perspective' | 'hydrogen' | 'useCdn' | 'stega' | 'headers' | 'tag'
->
+> & {
+  hydrogen?: {
+    /**
+     * Whether to cache the result of the query or not.
+     * @defaultValue () => true
+     */
+    shouldCacheResult?: (value: QueryResponseInitial<T>) => boolean
+  }
+}
 
-declare type LoadQueryOptions_2 = Pick<
+declare type LoadQueryOptions_2<T> = Pick<
   HydrogenResponseQueryOptions_2,
   'perspective' | 'hydrogen' | 'useCdn' | 'stega' | 'headers' | 'tag'
->
+> & {
+  hydrogen?: {
+    /**
+     * Whether to cache the result of the query or not.
+     * @defaultValue () => true
+     */
+    shouldCacheResult?: (value: QueryResponseInitial<T>) => boolean
+  }
+}
 
 declare interface RequestInit_2 {
   hydrogen?: {
@@ -133,7 +149,7 @@ export declare type SanityContext = {
   loadQuery<T = any>(
     query: string,
     params?: QueryParams,
-    options?: LoadQueryOptions,
+    options?: LoadQueryOptions<T>,
   ): Promise<QueryResponseInitial<T>>
   client: SanityClient
   preview?: CreateSanityContextOptions['preview']
@@ -147,7 +163,7 @@ export declare type SanityLoader = {
   loadQuery<T = any>(
     query: string,
     params?: QueryParams,
-    options?: LoadQueryOptions_2,
+    options?: LoadQueryOptions_2<T>,
   ): Promise<QueryResponseInitial<T>>
   client: SanityClient
   preview?: CreateSanityLoaderOptions['preview']

package/dist/index.d.ts

@@ -79,15 +79,31 @@ declare type HydrogenResponseQueryOptions_2 = Omit<ResponseQueryOptions, 'next'
   hydrogen?: 'hydrogen' extends keyof RequestInit_3 ? RequestInit_3['hydrogen'] : never
 }
 
-declare type LoadQueryOptions = Pick<
+declare type LoadQueryOptions<T> = Pick<
   HydrogenResponseQueryOptions,
   'perspective' | 'hydrogen' | 'useCdn' | 'stega' | 'headers' | 'tag'
->
+> & {
+  hydrogen?: {
+    /**
+     * Whether to cache the result of the query or not.
+     * @defaultValue () => true
+     */
+    shouldCacheResult?: (value: QueryResponseInitial<T>) => boolean
+  }
+}
 
-declare type LoadQueryOptions_2 = Pick<
+declare type LoadQueryOptions_2<T> = Pick<
   HydrogenResponseQueryOptions_2,
   'perspective' | 'hydrogen' | 'useCdn' | 'stega' | 'headers' | 'tag'
->
+> & {
+  hydrogen?: {
+    /**
+     * Whether to cache the result of the query or not.
+     * @defaultValue () => true
+     */
+    shouldCacheResult?: (value: QueryResponseInitial<T>) => boolean
+  }
+}
 
 declare interface RequestInit_2 {
   hydrogen?: {
@@ -133,7 +149,7 @@ export declare type SanityContext = {
   loadQuery<T = any>(
     query: string,
     params?: QueryParams,
-    options?: LoadQueryOptions,
+    options?: LoadQueryOptions<T>,
   ): Promise<QueryResponseInitial<T>>
   client: SanityClient
   preview?: CreateSanityContextOptions['preview']
@@ -147,7 +163,7 @@ export declare type SanityLoader = {
   loadQuery<T = any>(
     query: string,
     params?: QueryParams,
-    options?: LoadQueryOptions_2,
+    options?: LoadQueryOptions_2<T>,
   ): Promise<QueryResponseInitial<T>>
   client: SanityClient
   preview?: CreateSanityLoaderOptions['preview']

package/dist/index.js

@@ -1 +1 @@
-import{SanityClient as e,createClient as t}from"@sanity/client";import{SanityClient as n,createClient as i}from"@sanity/client";import{setServerClient as a,loadQuery as o}from"@sanity/react-loader";import{CacheLong as r,createWithCache as s,CacheNone as c}from"@shopify/hydrogen";import{h as l}from"./_chunks-es/utils.js";const p=r();function d(n){const{cache:i,waitUntil:r=()=>Promise.resolve(),request:d,preview:u,defaultStrategy:g}=n,w=i?s({cache:i,waitUntil:r,request:d}):null;let h=n.client instanceof e?n.client:t(n.client);if("1"===h.config().apiVersion&&(console.warn("No API version specified, defaulting to `v2022-03-07` which supports perspectives.\nYou can find the latest version in the Sanity changelog: https://www.sanity.io/changelog"),h=h.withConfig({apiVersion:"v2022-03-07"})),u&&u.enabled){if(!u.token)throw new Error("Enabling preview mode requires a token.");const e=h.withConfig({useCdn:!1,token:u.token,perspective:"previewDrafts",stega:{...h.config().stega,enabled:!0,studioUrl:u.studioUrl}});a(e)}else a(h);return{async loadQuery(e,t,n){const i=u&&u.enabled?c():n?.hydrogen?.cache||g||p,a=await l(e,t);return await(w?w(a,i,(async({addDebugData:i})=>{if("development"===process.env.NODE_ENV){i({displayName:n?.hydrogen?.debug?.displayName||"query Sanity"})}return await o(e,t,n)})):o(e,t,n))},client:h,preview:u}}const u=r();function g(n){const{withCache:i,preview:r,strategy:s}=n;let p=n.client instanceof e?n.client:t(n.client);if("1"===p.config().apiVersion&&(console.warn("No API version specified, defaulting to `v2022-03-07` which supports perspectives.\nYou can find the latest version in the Sanity changelog: https://www.sanity.io/changelog"),p=p.withConfig({apiVersion:"v2022-03-07"})),r&&r.enabled){if(!r.token)throw new Error("Enabling preview mode requires a token.");const e=p.withConfig({useCdn:!1,token:r.token,perspective:"previewDrafts",stega:{...p.config().stega,enabled:!0,studioUrl:r.studioUrl}});a(e)}else a(p);return{async loadQuery(e,t,n){const a=r&&r.enabled?c():n?.hydrogen?.cache||s||u,p=await l(e,t);return await i(p,a,(async({addDebugData:i})=>{if("development"===process.env.NODE_ENV){i({displayName:n?.hydrogen?.debug?.displayName||"query Sanity"})}return await o(e,t,n)}))},client:p,preview:r}}export{n as SanityClient,i as createClient,d as createSanityContext,g as createSanityLoader};//# sourceMappingURL=index.js.map
+import{SanityClient as e,createClient as t}from"@sanity/client";import{SanityClient as n,createClient as i}from"@sanity/client";import{setServerClient as a,loadQuery as o}from"@sanity/react-loader";import{CacheLong as r,createWithCache as s,CacheNone as c}from"@shopify/hydrogen";import{h as l}from"./_chunks-es/utils.js";const u=r();function h(n){const{cache:i,waitUntil:r=()=>Promise.resolve(),request:h,preview:d,defaultStrategy:p}=n,g=i?s({cache:i,waitUntil:r,request:h}):null;let y=n.client instanceof e?n.client:t(n.client);if("1"===y.config().apiVersion&&(console.warn("No API version specified, defaulting to `v2022-03-07` which supports perspectives.\nYou can find the latest version in the Sanity changelog: https://www.sanity.io/changelog"),y=y.withConfig({apiVersion:"v2022-03-07"})),d&&d.enabled){if(!d.token)throw new Error("Enabling preview mode requires a token.");const e=y.withConfig({useCdn:!1,token:d.token,perspective:"previewDrafts",stega:{...y.config().stega,enabled:!0,studioUrl:d.studioUrl}});a(e)}else a(y);return{async loadQuery(e,t,n){if(!g)return await o(e,t,n);const i=d&&d.enabled?c():n?.hydrogen?.cache||p||u,a=await l(e,t),r=n?.hydrogen?.shouldCacheResult??(()=>!0),s=async function({addDebugData:i}){if("development"===process.env.NODE_ENV){i({displayName:n?.hydrogen?.debug?.displayName||"query Sanity"})}return await o(e,t,n)};return await("run"in g?g.run({cacheKey:a,cacheStrategy:i,shouldCacheResult:r},s):g(a,i,s))},client:y,preview:d}}const d=r();function p(n){const{withCache:i,preview:r,strategy:s}=n;let u=n.client instanceof e?n.client:t(n.client);if("1"===u.config().apiVersion&&(console.warn("No API version specified, defaulting to `v2022-03-07` which supports perspectives.\nYou can find the latest version in the Sanity changelog: https://www.sanity.io/changelog"),u=u.withConfig({apiVersion:"v2022-03-07"})),r&&r.enabled){if(!r.token)throw new Error("Enabling preview mode requires a token.");const e=u.withConfig({useCdn:!1,token:r.token,perspective:"previewDrafts",stega:{...u.config().stega,enabled:!0,studioUrl:r.studioUrl}});a(e)}else a(u);return{async loadQuery(e,t,n){const a=r&&r.enabled?c():n?.hydrogen?.cache||s||d,u=await l(e,t),h=n?.hydrogen?.shouldCacheResult??(()=>!0),p=async function({addDebugData:i}){if("development"===process.env.NODE_ENV){i({displayName:n?.hydrogen?.debug?.displayName||"query Sanity"})}return await o(e,t,n)};return await("run"in i?i.run({cacheKey:u,cacheStrategy:a,shouldCacheResult:h},p):i(u,a,p))},client:u,preview:r}}export{n as SanityClient,i as createClient,h as createSanityContext,p as createSanityLoader};//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../src/context.ts","../src/loader.ts"],"sourcesContent":["import {loadQuery, type QueryResponseInitial, setServerClient} from '@sanity/react-loader'\nimport {CacheLong, CacheNone, type CachingStrategy, createWithCache} from '@shopify/hydrogen'\n\nimport {\n  type ClientConfig,\n  createClient,\n  type QueryParams,\n  type QueryWithoutParams,\n  type ResponseQueryOptions,\n  SanityClient,\n} from './client'\nimport {hashQuery} from './utils'\n\nconst DEFAULT_CACHE_STRATEGY = CacheLong()\n\ntype WaitUntil = (promise: Promise<unknown>) => void\n\nexport type CreateSanityContextOptions = {\n  request: Request\n\n  cache?: Cache | undefined\n  waitUntil?: WaitUntil | undefined\n\n  /**\n   * Sanity client or configuration to use.\n   */\n  client: SanityClient | ClientConfig\n\n  /**\n   * The default caching strategy to use for `loadQuery` subrequests.\n   * @see https://shopify.dev/docs/custom-storefronts/hydrogen/caching#caching-strategies\n   *\n   * Defaults to `CacheLong`\n   */\n  defaultStrategy?: CachingStrategy | null\n\n  /**\n   * Configuration for enabling preview mode.\n   */\n  preview?: {enabled: boolean; token: string; studioUrl: string}\n}\n\ninterface RequestInit {\n  hydrogen?: {\n    /**\n     * The caching strategy to use for the subrequest.\n     * @see https://shopify.dev/docs/custom-storefronts/hydrogen/caching#caching-strategies\n     */\n    cache?: CachingStrategy\n\n    /**\n     * Optional debugging information to be displayed in the subrequest profiler.\n     * @see https://shopify.dev/docs/custom-storefronts/hydrogen/debugging/subrequest-profiler#how-to-provide-more-debug-information-for-a-request\n     */\n    debug?: {\n      displayName: string\n    }\n  }\n}\n\ntype HydrogenResponseQueryOptions = Omit<ResponseQueryOptions, 'next' | 'cache'> & {\n  hydrogen?: 'hydrogen' extends keyof RequestInit ? RequestInit['hydrogen'] : never\n}\n\ntype LoadQueryOptions = Pick<\n  HydrogenResponseQueryOptions,\n  'perspective' | 'hydrogen' | 'useCdn' | 'stega' | 'headers' | 'tag'\n>\n\nexport type SanityContext = {\n  /**\n   * Query Sanity using the loader.\n   * @see https://www.sanity.io/docs/loaders\n   */\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  loadQuery<T = any>(\n    query: string,\n    params?: QueryParams,\n    options?: LoadQueryOptions,\n  ): Promise<QueryResponseInitial<T>>\n\n  client: SanityClient\n\n  preview?: CreateSanityContextOptions['preview']\n}\n\n/**\n * @public\n */\nexport function createSanityContext(options: CreateSanityContextOptions): SanityContext {\n  const {cache, waitUntil = () => Promise.resolve(), request, preview, defaultStrategy} = options\n  const withCache = cache ? createWithCache({cache, waitUntil, request}) : null\n  let client =\n    options.client instanceof SanityClient ? options.client : createClient(options.client)\n\n  if (client.config().apiVersion === '1') {\n    console.warn(\n      'No API version specified, defaulting to `v2022-03-07` which supports perspectives.\\nYou can find the latest version in the Sanity changelog: https://www.sanity.io/changelog',\n    )\n    client = client.withConfig({apiVersion: 'v2022-03-07'})\n  }\n\n  if (preview && preview.enabled) {\n    if (!preview.token) {\n      throw new Error('Enabling preview mode requires a token.')\n    }\n\n    const previewClient = client.withConfig({\n      useCdn: false,\n      token: preview.token,\n      perspective: 'previewDrafts' as const,\n      stega: {\n        ...client.config().stega,\n        enabled: true,\n        studioUrl: preview.studioUrl,\n      },\n    })\n\n    setServerClient(previewClient)\n  } else {\n    setServerClient(client)\n  }\n\n  const sanity = {\n    async loadQuery<T>(\n      query: string,\n      params: QueryParams | QueryWithoutParams,\n      loaderOptions?: LoadQueryOptions,\n    ): Promise<QueryResponseInitial<T>> {\n      // Don't store response if preview is enabled\n      const cacheStrategy =\n        preview && preview.enabled\n          ? CacheNone()\n          : loaderOptions?.hydrogen?.cache || defaultStrategy || DEFAULT_CACHE_STRATEGY\n\n      const queryHash = await hashQuery(query, params)\n\n      return await (withCache\n        ? withCache(queryHash, cacheStrategy, async ({addDebugData}) => {\n            if (process.env.NODE_ENV === 'development') {\n              // Name displayed in the subrequest profiler\n              const displayName = loaderOptions?.hydrogen?.debug?.displayName || 'query Sanity'\n\n              addDebugData({\n                displayName,\n              })\n            }\n\n            return await loadQuery<T>(query, params, loaderOptions)\n          })\n        : loadQuery<T>(query, params, loaderOptions))\n    },\n    client,\n    preview,\n  }\n\n  return sanity\n}\n","import {loadQuery, type QueryResponseInitial, setServerClient} from '@sanity/react-loader'\nimport {CacheLong, CacheNone, type CachingStrategy, type WithCache} from '@shopify/hydrogen'\n\nimport {\n  type ClientConfig,\n  createClient,\n  type QueryParams,\n  type QueryWithoutParams,\n  type ResponseQueryOptions,\n  SanityClient,\n} from './client'\nimport {hashQuery} from './utils'\n\nconst DEFAULT_CACHE_STRATEGY = CacheLong()\n\nexport type CreateSanityLoaderOptions = {\n  /**\n   * Cache control utility from `@shopify/hydrogen`.\n   * @see https://shopify.dev/docs/custom-storefronts/hydrogen/caching/third-party\n   */\n  withCache: WithCache\n\n  /**\n   * Sanity client or configuration to use.\n   */\n  client: SanityClient | ClientConfig\n\n  /**\n   * The default caching strategy to use for `loadQuery` subrequests.\n   * @see https://shopify.dev/docs/custom-storefronts/hydrogen/caching#caching-strategies\n   *\n   * Defaults to `CacheLong`\n   */\n  strategy?: CachingStrategy | null\n\n  /**\n   * Configuration for enabling preview mode.\n   */\n  preview?: {enabled: boolean; token: string; studioUrl: string}\n}\n\ninterface RequestInit {\n  hydrogen?: {\n    /**\n     * The caching strategy to use for the subrequest.\n     * @see https://shopify.dev/docs/custom-storefronts/hydrogen/caching#caching-strategies\n     */\n    cache?: CachingStrategy\n\n    /**\n     * Optional debugging information to be displayed in the subrequest profiler.\n     * @see https://shopify.dev/docs/custom-storefronts/hydrogen/debugging/subrequest-profiler#how-to-provide-more-debug-information-for-a-request\n     */\n    debug?: {\n      displayName: string\n    }\n  }\n}\n\ntype HydrogenResponseQueryOptions = Omit<ResponseQueryOptions, 'next' | 'cache'> & {\n  hydrogen?: 'hydrogen' extends keyof RequestInit ? RequestInit['hydrogen'] : never\n}\n\ntype LoadQueryOptions = Pick<\n  HydrogenResponseQueryOptions,\n  'perspective' | 'hydrogen' | 'useCdn' | 'stega' | 'headers' | 'tag'\n>\n\nexport type SanityLoader = {\n  /**\n   * Query Sanity using the loader.\n   * @see https://www.sanity.io/docs/loaders\n   */\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  loadQuery<T = any>(\n    query: string,\n    params?: QueryParams,\n    options?: LoadQueryOptions,\n  ): Promise<QueryResponseInitial<T>>\n\n  client: SanityClient\n\n  preview?: CreateSanityLoaderOptions['preview']\n}\n\n/**\n * @deprecated Use `createSanityContext` instead\n */\nexport function createSanityLoader(options: CreateSanityLoaderOptions): SanityLoader {\n  const {withCache, preview, strategy} = options\n  let client =\n    options.client instanceof SanityClient ? options.client : createClient(options.client)\n\n  if (client.config().apiVersion === '1') {\n    console.warn(\n      'No API version specified, defaulting to `v2022-03-07` which supports perspectives.\\nYou can find the latest version in the Sanity changelog: https://www.sanity.io/changelog',\n    )\n    client = client.withConfig({apiVersion: 'v2022-03-07'})\n  }\n\n  if (preview && preview.enabled) {\n    if (!preview.token) {\n      throw new Error('Enabling preview mode requires a token.')\n    }\n\n    const previewClient = client.withConfig({\n      useCdn: false,\n      token: preview.token,\n      perspective: 'previewDrafts' as const,\n      stega: {\n        ...client.config().stega,\n        enabled: true,\n        studioUrl: preview.studioUrl,\n      },\n    })\n\n    setServerClient(previewClient)\n  } else {\n    setServerClient(client)\n  }\n\n  const sanity = {\n    async loadQuery<T>(\n      query: string,\n      params: QueryParams | QueryWithoutParams,\n      loaderOptions?: LoadQueryOptions,\n    ): Promise<QueryResponseInitial<T>> {\n      // Don't store response if preview is enabled\n      const cacheStrategy =\n        preview && preview.enabled\n          ? CacheNone()\n          : loaderOptions?.hydrogen?.cache || strategy || DEFAULT_CACHE_STRATEGY\n\n      const queryHash = await hashQuery(query, params)\n\n      return await withCache(queryHash, cacheStrategy, async ({addDebugData}) => {\n        // eslint-disable-next-line no-process-env\n        if (process.env.NODE_ENV === 'development') {\n          // Name displayed in the subrequest profiler\n          const displayName = loaderOptions?.hydrogen?.debug?.displayName || 'query Sanity'\n\n          addDebugData({\n            displayName,\n          })\n        }\n\n        return await loadQuery<T>(query, params, loaderOptions)\n      })\n    },\n    client,\n    preview,\n  }\n\n  return sanity\n}\n"],"names":["DEFAULT_CACHE_STRATEGY","CacheLong","createSanityContext","options","cache","waitUntil","Promise","resolve","request","preview","defaultStrategy","withCache","createWithCache","client","SanityClient","createClient","config","apiVersion","console","warn","withConfig","enabled","token","Error","previewClient","useCdn","perspective","stega","studioUrl","setServerClient","loadQuery","query","params","loaderOptions","cacheStrategy","CacheNone","hydrogen","queryHash","hashQuery","async","addDebugData","process","env","NODE_ENV","displayName","debug","createSanityLoader","strategy"],"mappings":"kUAaA,MAAMA,EAAyBC,IA4ExB,SAASC,EAAoBC,GAC5B,MAAAC,MAACA,YAAOC,EAAY,IAAMC,QAAQC,kBAAWC,UAASC,EAASC,gBAAAA,GAAmBP,EAClFQ,EAAYP,EAAQQ,EAAgB,CAACR,QAAOC,YAAWG,YAAY,KACrE,IAAAK,EACFV,EAAQU,kBAAkBC,EAAeX,EAAQU,OAASE,EAAaZ,EAAQU,QASjF,GAPmC,MAA/BA,EAAOG,SAASC,aAClBC,QAAQC,KACN,gLAEFN,EAASA,EAAOO,WAAW,CAACH,WAAY,iBAGtCR,GAAWA,EAAQY,QAAS,CAC9B,IAAKZ,EAAQa,MACL,MAAA,IAAIC,MAAM,2CAGZ,MAAAC,EAAgBX,EAAOO,WAAW,CACtCK,QAAQ,EACRH,MAAOb,EAAQa,MACfI,YAAa,gBACbC,MAAO,IACFd,EAAOG,SAASW,MACnBN,SAAS,EACTO,UAAWnB,EAAQmB,aAIvBC,EAAgBL,EAClB,MACEK,EAAgBhB,GAGH,MAAA,CACb,eAAMiB,CACJC,EACAC,EACAC,GAGA,MAAMC,EACJzB,GAAWA,EAAQY,QACfc,IACAF,GAAeG,UAAUhC,OAASM,GAAmBV,EAErDqC,QAAkBC,EAAUP,EAAOC,GAElC,aAAOrB,EACVA,EAAU0B,EAAWH,GAAeK,OAAQC,mBACtC,GAAyB,gBAAzBC,QAAQC,IAAIC,SAA4B,CAI7BH,EAAA,CACXI,YAHkBX,GAAeG,UAAUS,OAAOD,aAAe,gBAIlE,CAGH,aAAad,EAAaC,EAAOC,EAAQC,EAAa,IAExDH,EAAaC,EAAOC,EAAQC,GAClC,EACApB,SACAJ,UAIJ,CChJA,MAAMT,EAAyBC,IA2ExB,SAAS6C,EAAmB3C,GACjC,MAAMQ,UAACA,EAAAF,QAAWA,EAASsC,SAAAA,GAAY5C,EACnC,IAAAU,EACFV,EAAQU,kBAAkBC,EAAeX,EAAQU,OAASE,EAAaZ,EAAQU,QASjF,GAPmC,MAA/BA,EAAOG,SAASC,aAClBC,QAAQC,KACN,gLAEFN,EAASA,EAAOO,WAAW,CAACH,WAAY,iBAGtCR,GAAWA,EAAQY,QAAS,CAC9B,IAAKZ,EAAQa,MACL,MAAA,IAAIC,MAAM,2CAGZ,MAAAC,EAAgBX,EAAOO,WAAW,CACtCK,QAAQ,EACRH,MAAOb,EAAQa,MACfI,YAAa,gBACbC,MAAO,IACFd,EAAOG,SAASW,MACnBN,SAAS,EACTO,UAAWnB,EAAQmB,aAIvBC,EAAgBL,EAClB,MACEK,EAAgBhB,GAGH,MAAA,CACb,eAAMiB,CACJC,EACAC,EACAC,GAGA,MAAMC,EACJzB,GAAWA,EAAQY,QACfc,IACAF,GAAeG,UAAUhC,OAAS2C,GAAY/C,EAE9CqC,QAAkBC,EAAUP,EAAOC,GAEzC,aAAarB,EAAU0B,EAAWH,GAAeK,OAAQC,mBAEnD,GAAyB,gBAAzBC,QAAQC,IAAIC,SAA4B,CAI7BH,EAAA,CACXI,YAHkBX,GAAeG,UAAUS,OAAOD,aAAe,gBAIlE,CAGH,aAAad,EAAaC,EAAOC,EAAQC,EAAa,GAE1D,EACApB,SACAJ,UAIJ"}
+{"version":3,"file":"index.js","sources":["../src/context.ts","../src/loader.ts"],"sourcesContent":["import {loadQuery, type QueryResponseInitial, setServerClient} from '@sanity/react-loader'\nimport {\n  CacheLong,\n  CacheNone,\n  type CachingStrategy,\n  createWithCache,\n  type WithCache,\n} from '@shopify/hydrogen'\n\nimport {\n  type ClientConfig,\n  createClient,\n  type QueryParams,\n  type QueryWithoutParams,\n  type ResponseQueryOptions,\n  SanityClient,\n} from './client'\nimport {hashQuery} from './utils'\n\nconst DEFAULT_CACHE_STRATEGY = CacheLong()\n\ntype WaitUntil = (promise: Promise<unknown>) => void\n\nexport type CreateSanityContextOptions = {\n  request: Request\n\n  cache?: Cache | undefined\n  waitUntil?: WaitUntil | undefined\n\n  /**\n   * Sanity client or configuration to use.\n   */\n  client: SanityClient | ClientConfig\n\n  /**\n   * The default caching strategy to use for `loadQuery` subrequests.\n   * @see https://shopify.dev/docs/custom-storefronts/hydrogen/caching#caching-strategies\n   *\n   * Defaults to `CacheLong`\n   */\n  defaultStrategy?: CachingStrategy | null\n\n  /**\n   * Configuration for enabling preview mode.\n   */\n  preview?: {enabled: boolean; token: string; studioUrl: string}\n}\n\ninterface RequestInit {\n  hydrogen?: {\n    /**\n     * The caching strategy to use for the subrequest.\n     * @see https://shopify.dev/docs/custom-storefronts/hydrogen/caching#caching-strategies\n     */\n    cache?: CachingStrategy\n\n    /**\n     * Optional debugging information to be displayed in the subrequest profiler.\n     * @see https://shopify.dev/docs/custom-storefronts/hydrogen/debugging/subrequest-profiler#how-to-provide-more-debug-information-for-a-request\n     */\n    debug?: {\n      displayName: string\n    }\n  }\n}\n\ntype HydrogenResponseQueryOptions = Omit<ResponseQueryOptions, 'next' | 'cache'> & {\n  hydrogen?: 'hydrogen' extends keyof RequestInit ? RequestInit['hydrogen'] : never\n}\n\ntype LoadQueryOptions<T> = Pick<\n  HydrogenResponseQueryOptions,\n  'perspective' | 'hydrogen' | 'useCdn' | 'stega' | 'headers' | 'tag'\n> & {\n  hydrogen?: {\n    /**\n     * Whether to cache the result of the query or not.\n     * @defaultValue () => true\n     */\n    shouldCacheResult?: (value: QueryResponseInitial<T>) => boolean\n  }\n}\n\nexport type SanityContext = {\n  /**\n   * Query Sanity using the loader.\n   * @see https://www.sanity.io/docs/loaders\n   */\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  loadQuery<T = any>(\n    query: string,\n    params?: QueryParams,\n    options?: LoadQueryOptions<T>,\n  ): Promise<QueryResponseInitial<T>>\n\n  client: SanityClient\n\n  preview?: CreateSanityContextOptions['preview']\n}\n\n/**\n * @public\n */\nexport function createSanityContext(options: CreateSanityContextOptions): SanityContext {\n  const {cache, waitUntil = () => Promise.resolve(), request, preview, defaultStrategy} = options\n  const withCache = cache ? createWithCache({cache, waitUntil, request}) : null\n  let client =\n    options.client instanceof SanityClient ? options.client : createClient(options.client)\n\n  if (client.config().apiVersion === '1') {\n    console.warn(\n      'No API version specified, defaulting to `v2022-03-07` which supports perspectives.\\nYou can find the latest version in the Sanity changelog: https://www.sanity.io/changelog',\n    )\n    client = client.withConfig({apiVersion: 'v2022-03-07'})\n  }\n\n  if (preview && preview.enabled) {\n    if (!preview.token) {\n      throw new Error('Enabling preview mode requires a token.')\n    }\n\n    const previewClient = client.withConfig({\n      useCdn: false,\n      token: preview.token,\n      perspective: 'previewDrafts' as const,\n      stega: {\n        ...client.config().stega,\n        enabled: true,\n        studioUrl: preview.studioUrl,\n      },\n    })\n\n    setServerClient(previewClient)\n  } else {\n    setServerClient(client)\n  }\n\n  const sanity = {\n    async loadQuery<T>(\n      query: string,\n      params: QueryParams | QueryWithoutParams,\n      loaderOptions?: LoadQueryOptions<T>,\n    ): Promise<QueryResponseInitial<T>> {\n      if (!withCache) {\n        return await loadQuery<T>(query, params, loaderOptions)\n      }\n\n      // Don't store response if preview is enabled\n      const cacheStrategy =\n        preview && preview.enabled\n          ? CacheNone()\n          : loaderOptions?.hydrogen?.cache || defaultStrategy || DEFAULT_CACHE_STRATEGY\n\n      const queryHash = await hashQuery(query, params)\n      const shouldCacheResult = loaderOptions?.hydrogen?.shouldCacheResult ?? (() => true)\n\n      const runWithCache = async function runWithCache({\n        addDebugData,\n      }: Parameters<Parameters<WithCache['run']>[1]>[0]): Promise<QueryResponseInitial<T>> {\n        // eslint-disable-next-line no-process-env\n        if (process.env.NODE_ENV === 'development') {\n          // Name displayed in the subrequest profiler\n          const displayName = loaderOptions?.hydrogen?.debug?.displayName || 'query Sanity'\n\n          addDebugData({\n            displayName,\n          })\n        }\n\n        return await loadQuery<T>(query, params, loaderOptions)\n      }\n\n      return await ('run' in withCache\n        ? withCache.run({cacheKey: queryHash, cacheStrategy, shouldCacheResult}, runWithCache)\n        : // @ts-expect-error for compatibility, remove in next major\n          withCache(queryHash, cacheStrategy, runWithCache))\n    },\n    client,\n    preview,\n  }\n\n  return sanity\n}\n","import {loadQuery, type QueryResponseInitial, setServerClient} from '@sanity/react-loader'\nimport {CacheLong, CacheNone, type CachingStrategy, type WithCache} from '@shopify/hydrogen'\n\nimport {\n  type ClientConfig,\n  createClient,\n  type QueryParams,\n  type QueryWithoutParams,\n  type ResponseQueryOptions,\n  SanityClient,\n} from './client'\nimport {hashQuery} from './utils'\n\nconst DEFAULT_CACHE_STRATEGY = CacheLong()\n\nexport type CreateSanityLoaderOptions = {\n  /**\n   * Cache control utility from `@shopify/hydrogen`.\n   * @see https://shopify.dev/docs/custom-storefronts/hydrogen/caching/third-party\n   */\n  withCache: WithCache\n\n  /**\n   * Sanity client or configuration to use.\n   */\n  client: SanityClient | ClientConfig\n\n  /**\n   * The default caching strategy to use for `loadQuery` subrequests.\n   * @see https://shopify.dev/docs/custom-storefronts/hydrogen/caching#caching-strategies\n   *\n   * Defaults to `CacheLong`\n   */\n  strategy?: CachingStrategy | null\n\n  /**\n   * Configuration for enabling preview mode.\n   */\n  preview?: {enabled: boolean; token: string; studioUrl: string}\n}\n\ninterface RequestInit {\n  hydrogen?: {\n    /**\n     * The caching strategy to use for the subrequest.\n     * @see https://shopify.dev/docs/custom-storefronts/hydrogen/caching#caching-strategies\n     */\n    cache?: CachingStrategy\n\n    /**\n     * Optional debugging information to be displayed in the subrequest profiler.\n     * @see https://shopify.dev/docs/custom-storefronts/hydrogen/debugging/subrequest-profiler#how-to-provide-more-debug-information-for-a-request\n     */\n    debug?: {\n      displayName: string\n    }\n  }\n}\n\ntype HydrogenResponseQueryOptions = Omit<ResponseQueryOptions, 'next' | 'cache'> & {\n  hydrogen?: 'hydrogen' extends keyof RequestInit ? RequestInit['hydrogen'] : never\n}\n\ntype LoadQueryOptions<T> = Pick<\n  HydrogenResponseQueryOptions,\n  'perspective' | 'hydrogen' | 'useCdn' | 'stega' | 'headers' | 'tag'\n> & {\n  hydrogen?: {\n    /**\n     * Whether to cache the result of the query or not.\n     * @defaultValue () => true\n     */\n    shouldCacheResult?: (value: QueryResponseInitial<T>) => boolean\n  }\n}\n\nexport type SanityLoader = {\n  /**\n   * Query Sanity using the loader.\n   * @see https://www.sanity.io/docs/loaders\n   */\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  loadQuery<T = any>(\n    query: string,\n    params?: QueryParams,\n    options?: LoadQueryOptions<T>,\n  ): Promise<QueryResponseInitial<T>>\n\n  client: SanityClient\n\n  preview?: CreateSanityLoaderOptions['preview']\n}\n\n/**\n * @deprecated Use `createSanityContext` instead\n */\nexport function createSanityLoader(options: CreateSanityLoaderOptions): SanityLoader {\n  const {withCache, preview, strategy} = options\n  let client =\n    options.client instanceof SanityClient ? options.client : createClient(options.client)\n\n  if (client.config().apiVersion === '1') {\n    console.warn(\n      'No API version specified, defaulting to `v2022-03-07` which supports perspectives.\\nYou can find the latest version in the Sanity changelog: https://www.sanity.io/changelog',\n    )\n    client = client.withConfig({apiVersion: 'v2022-03-07'})\n  }\n\n  if (preview && preview.enabled) {\n    if (!preview.token) {\n      throw new Error('Enabling preview mode requires a token.')\n    }\n\n    const previewClient = client.withConfig({\n      useCdn: false,\n      token: preview.token,\n      perspective: 'previewDrafts' as const,\n      stega: {\n        ...client.config().stega,\n        enabled: true,\n        studioUrl: preview.studioUrl,\n      },\n    })\n\n    setServerClient(previewClient)\n  } else {\n    setServerClient(client)\n  }\n\n  const sanity = {\n    async loadQuery<T>(\n      query: string,\n      params: QueryParams | QueryWithoutParams,\n      loaderOptions?: LoadQueryOptions<T>,\n    ): Promise<QueryResponseInitial<T>> {\n      // Don't store response if preview is enabled\n      const cacheStrategy =\n        preview && preview.enabled\n          ? CacheNone()\n          : loaderOptions?.hydrogen?.cache || strategy || DEFAULT_CACHE_STRATEGY\n\n      const queryHash = await hashQuery(query, params)\n\n      const shouldCacheResult = loaderOptions?.hydrogen?.shouldCacheResult ?? (() => true)\n\n      const runWithCache = async function runWithCache({\n        addDebugData,\n      }: Parameters<Parameters<WithCache['run']>[1]>[0]): Promise<QueryResponseInitial<T>> {\n        // eslint-disable-next-line no-process-env\n        if (process.env.NODE_ENV === 'development') {\n          // Name displayed in the subrequest profiler\n          const displayName = loaderOptions?.hydrogen?.debug?.displayName || 'query Sanity'\n\n          addDebugData({\n            displayName,\n          })\n        }\n\n        return await loadQuery<T>(query, params, loaderOptions)\n      }\n\n      return await ('run' in withCache\n        ? withCache.run({cacheKey: queryHash, cacheStrategy, shouldCacheResult}, runWithCache)\n        : // @ts-expect-error for compatibility, remove in next major\n          withCache(queryHash, cacheStrategy, runWithCache))\n    },\n    client,\n    preview,\n  }\n\n  return sanity\n}\n"],"names":["DEFAULT_CACHE_STRATEGY","CacheLong","createSanityContext","options","cache","waitUntil","Promise","resolve","request","preview","defaultStrategy","withCache","createWithCache","client","SanityClient","createClient","config","apiVersion","console","warn","withConfig","enabled","token","Error","previewClient","useCdn","perspective","stega","studioUrl","setServerClient","loadQuery","query","params","loaderOptions","cacheStrategy","CacheNone","hydrogen","queryHash","hashQuery","shouldCacheResult","runWithCache","async","addDebugData","process","env","NODE_ENV","displayName","debug","run","cacheKey","createSanityLoader","strategy"],"mappings":"kUAmBA,MAAMA,EAAyBC,IAoFxB,SAASC,EAAoBC,GAC5B,MAAAC,MAACA,YAAOC,EAAY,IAAMC,QAAQC,kBAAWC,UAASC,EAASC,gBAAAA,GAAmBP,EAClFQ,EAAYP,EAAQQ,EAAgB,CAACR,QAAOC,YAAWG,YAAY,KACrE,IAAAK,EACFV,EAAQU,kBAAkBC,EAAeX,EAAQU,OAASE,EAAaZ,EAAQU,QASjF,GAPmC,MAA/BA,EAAOG,SAASC,aAClBC,QAAQC,KACN,gLAEFN,EAASA,EAAOO,WAAW,CAACH,WAAY,iBAGtCR,GAAWA,EAAQY,QAAS,CAC9B,IAAKZ,EAAQa,MACL,MAAA,IAAIC,MAAM,2CAGZ,MAAAC,EAAgBX,EAAOO,WAAW,CACtCK,QAAQ,EACRH,MAAOb,EAAQa,MACfI,YAAa,gBACbC,MAAO,IACFd,EAAOG,SAASW,MACnBN,SAAS,EACTO,UAAWnB,EAAQmB,aAIvBC,EAAgBL,EAClB,MACEK,EAAgBhB,GAGH,MAAA,CACb,eAAMiB,CACJC,EACAC,EACAC,GAEA,IAAKtB,EACH,aAAamB,EAAaC,EAAOC,EAAQC,GAIrC,MAAAC,EACJzB,GAAWA,EAAQY,QACfc,IACAF,GAAeG,UAAUhC,OAASM,GAAmBV,EAErDqC,QAAkBC,EAAUP,EAAOC,GACnCO,EAAoBN,GAAeG,UAAUG,mBAAsB,MAAM,GAEzEC,EAAeC,gBAA4BC,aAC/CA,IAGI,GAAyB,gBAAzBC,QAAQC,IAAIC,SAA4B,CAI7BH,EAAA,CACXI,YAHkBb,GAAeG,UAAUW,OAAOD,aAAe,gBAIlE,CAGH,aAAahB,EAAaC,EAAOC,EAAQC,EAC3C,EAEO,aAAO,QAAStB,EACnBA,EAAUqC,IAAI,CAACC,SAAUZ,EAAWH,gBAAeK,qBAAoBC,GAEvE7B,EAAU0B,EAAWH,EAAeM,GAC1C,EACA3B,SACAJ,UAIJ,CCzKA,MAAMT,EAAyBC,IAmFxB,SAASiD,EAAmB/C,GACjC,MAAMQ,UAACA,EAAAF,QAAWA,EAAS0C,SAAAA,GAAYhD,EACnC,IAAAU,EACFV,EAAQU,kBAAkBC,EAAeX,EAAQU,OAASE,EAAaZ,EAAQU,QASjF,GAPmC,MAA/BA,EAAOG,SAASC,aAClBC,QAAQC,KACN,gLAEFN,EAASA,EAAOO,WAAW,CAACH,WAAY,iBAGtCR,GAAWA,EAAQY,QAAS,CAC9B,IAAKZ,EAAQa,MACL,MAAA,IAAIC,MAAM,2CAGZ,MAAAC,EAAgBX,EAAOO,WAAW,CACtCK,QAAQ,EACRH,MAAOb,EAAQa,MACfI,YAAa,gBACbC,MAAO,IACFd,EAAOG,SAASW,MACnBN,SAAS,EACTO,UAAWnB,EAAQmB,aAIvBC,EAAgBL,EAClB,MACEK,EAAgBhB,GAGH,MAAA,CACb,eAAMiB,CACJC,EACAC,EACAC,GAGM,MAAAC,EACJzB,GAAWA,EAAQY,QACfc,IACAF,GAAeG,UAAUhC,OAAS+C,GAAYnD,EAE9CqC,QAAkBC,EAAUP,EAAOC,GAEnCO,EAAoBN,GAAeG,UAAUG,mBAAsB,MAAM,GAEzEC,EAAeC,gBAA4BC,aAC/CA,IAGI,GAAyB,gBAAzBC,QAAQC,IAAIC,SAA4B,CAI7BH,EAAA,CACXI,YAHkBb,GAAeG,UAAUW,OAAOD,aAAe,gBAIlE,CAGH,aAAahB,EAAaC,EAAOC,EAAQC,EAC3C,EAEO,aAAO,QAAStB,EACnBA,EAAUqC,IAAI,CAACC,SAAUZ,EAAWH,gBAAeK,qBAAoBC,GAEvE7B,EAAU0B,EAAWH,EAAeM,GAC1C,EACA3B,SACAJ,UAIJ"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hydrogen-sanity",
-  "version": "4.2.1",
+  "version": "4.3.1",
   "description": "Sanity.io toolkit for Hydrogen",
   "keywords": [
     "sanity",
@@ -89,10 +89,10 @@
     "groq": "^3.62.3"
   },
   "devDependencies": {
-    "@sanity/pkg-utils": "^6.11.7",
+    "@sanity/pkg-utils": "^6.11.8",
     "@sanity/plugin-kit": "^4.0.18",
     "@sanity/semantic-release-preset": "^4.1.8",
-    "@shopify/hydrogen": "~2024.7.9",
+    "@shopify/hydrogen": "~2024.10.0",
     "@shopify/remix-oxygen": "^2.0.9",
     "@types/react": "^18.3.12",
     "@typescript-eslint/eslint-plugin": "^7.18.0",
@@ -113,7 +113,7 @@
   },
   "peerDependencies": {
     "@sanity/client": "^6.18.0",
-    "@shopify/hydrogen": "^2023.7.0 || ~2024.1.0 || ~2024.4.0 || ~2024.7.0",
+    "@shopify/hydrogen": "^2023.7.0 || ~2024.1.0 || ~2024.4.0 || ~2024.7.0 || ~2024.10.0",
     "@shopify/remix-oxygen": "^1.0.0 || ^2.0.0",
     "groq": "^3.41.0",
     "react": "^18.0.0",

package/src/context.test.ts

@@ -1,5 +1,5 @@
 import type {QueryStore} from '@sanity/react-loader'
-import {CacheShort, WithCache} from '@shopify/hydrogen'
+import {CacheShort, type WithCache} from '@shopify/hydrogen'
 import groq from 'groq'
 import {beforeEach, describe, expect, it, vi} from 'vitest'
 
@@ -25,9 +25,11 @@ let withCache = vi.hoisted<WithCache | null>(() => null)
 
 vi.mock('@shopify/hydrogen', async (importOriginal) => {
   const module = await importOriginal<typeof import('@shopify/hydrogen')>()
-  withCache = vi
-    .fn()
-    .mockImplementation(module.createWithCache({cache, waitUntil: () => Promise.resolve()}))
+  withCache = module.createWithCache({
+    cache,
+    waitUntil: () => Promise.resolve(),
+    request: new Request('https://example.com'),
+  })
 
   return {
     ...module,
@@ -44,6 +46,8 @@ vi.mock('@sanity/react-loader', async (importOriginal) => {
   }
 })
 
+const runWithCache = vi.spyOn(withCache!, 'run')
+
 const client = createClient({projectId: 'my-project-id', dataset: 'my-dataset'})
 
 const query = groq`true`
@@ -73,8 +77,12 @@ describe('the Sanity request context', () => {
     })
 
     await contextWithDefaultStrategy.loadQuery<boolean>(query, params)
-    expect(withCache).toHaveBeenCalledWith(hashedQuery, defaultStrategy, expect.any(Function))
-    expect(cache.put).toHaveBeenCalled()
+    expect(runWithCache).toHaveBeenNthCalledWith(
+      1,
+      expect.objectContaining({cacheKey: hashedQuery, cacheStrategy: defaultStrategy}),
+      expect.any(Function),
+    )
+    expect(cache.put).toHaveBeenCalledOnce()
   })
 
   it('queries should use the cache strategy passed in `loadQuery`', async () => {
@@ -82,8 +90,12 @@ describe('the Sanity request context', () => {
     await sanityContext.loadQuery<boolean>(query, params, {
       hydrogen: {cache: strategy},
     })
-    expect(withCache).toHaveBeenCalledWith(hashedQuery, strategy, expect.any(Function))
-    expect(cache.put).toHaveBeenCalled()
+    expect(runWithCache).toHaveBeenNthCalledWith(
+      1,
+      expect.objectContaining({cacheKey: hashedQuery, cacheStrategy: strategy}),
+      expect.any(Function),
+    )
+    expect(cache.put).toHaveBeenCalledOnce()
   })
 })
 
@@ -122,6 +134,6 @@ describe('when configured for preview', () => {
   it(`shouldn't cache queries`, async () => {
     await previewContext.loadQuery<boolean>(query)
     expect(loadQuery).toHaveBeenCalledOnce()
-    expect(cache.put).not.toHaveBeenCalled()
+    expect(cache.put).not.toHaveBeenCalledOnce()
   })
 })

package/src/context.ts

@@ -1,5 +1,11 @@
 import {loadQuery, type QueryResponseInitial, setServerClient} from '@sanity/react-loader'
-import {CacheLong, CacheNone, type CachingStrategy, createWithCache} from '@shopify/hydrogen'
+import {
+  CacheLong,
+  CacheNone,
+  type CachingStrategy,
+  createWithCache,
+  type WithCache,
+} from '@shopify/hydrogen'
 
 import {
   type ClientConfig,
@@ -62,10 +68,18 @@ type HydrogenResponseQueryOptions = Omit<ResponseQueryOptions, 'next' | 'cache'>
   hydrogen?: 'hydrogen' extends keyof RequestInit ? RequestInit['hydrogen'] : never
 }
 
-type LoadQueryOptions = Pick<
+type LoadQueryOptions<T> = Pick<
   HydrogenResponseQueryOptions,
   'perspective' | 'hydrogen' | 'useCdn' | 'stega' | 'headers' | 'tag'
->
+> & {
+  hydrogen?: {
+    /**
+     * Whether to cache the result of the query or not.
+     * @defaultValue () => true
+     */
+    shouldCacheResult?: (value: QueryResponseInitial<T>) => boolean
+  }
+}
 
 export type SanityContext = {
   /**
@@ -76,7 +90,7 @@ export type SanityContext = {
   loadQuery<T = any>(
     query: string,
     params?: QueryParams,
-    options?: LoadQueryOptions,
+    options?: LoadQueryOptions<T>,
   ): Promise<QueryResponseInitial<T>>
 
   client: SanityClient
@@ -125,8 +139,12 @@ export function createSanityContext(options: CreateSanityContextOptions): Sanity
     async loadQuery<T>(
       query: string,
       params: QueryParams | QueryWithoutParams,
-      loaderOptions?: LoadQueryOptions,
+      loaderOptions?: LoadQueryOptions<T>,
     ): Promise<QueryResponseInitial<T>> {
+      if (!withCache) {
+        return await loadQuery<T>(query, params, loaderOptions)
+      }
+
       // Don't store response if preview is enabled
       const cacheStrategy =
         preview && preview.enabled
@@ -134,21 +152,28 @@ export function createSanityContext(options: CreateSanityContextOptions): Sanity
           : loaderOptions?.hydrogen?.cache || defaultStrategy || DEFAULT_CACHE_STRATEGY
 
       const queryHash = await hashQuery(query, params)
+      const shouldCacheResult = loaderOptions?.hydrogen?.shouldCacheResult ?? (() => true)
+
+      const runWithCache = async function runWithCache({
+        addDebugData,
+      }: Parameters<Parameters<WithCache['run']>[1]>[0]): Promise<QueryResponseInitial<T>> {
+        // eslint-disable-next-line no-process-env
+        if (process.env.NODE_ENV === 'development') {
+          // Name displayed in the subrequest profiler
+          const displayName = loaderOptions?.hydrogen?.debug?.displayName || 'query Sanity'
+
+          addDebugData({
+            displayName,
+          })
+        }
 
-      return await (withCache
-        ? withCache(queryHash, cacheStrategy, async ({addDebugData}) => {
-            if (process.env.NODE_ENV === 'development') {
-              // Name displayed in the subrequest profiler
-              const displayName = loaderOptions?.hydrogen?.debug?.displayName || 'query Sanity'
-
-              addDebugData({
-                displayName,
-              })
-            }
+        return await loadQuery<T>(query, params, loaderOptions)
+      }
 
-            return await loadQuery<T>(query, params, loaderOptions)
-          })
-        : loadQuery<T>(query, params, loaderOptions))
+      return await ('run' in withCache
+        ? withCache.run({cacheKey: queryHash, cacheStrategy, shouldCacheResult}, runWithCache)
+        : // @ts-expect-error for compatibility, remove in next major
+          withCache(queryHash, cacheStrategy, runWithCache))
     },
     client,
     preview,

package/src/loader.test.ts

@@ -33,8 +33,8 @@ function waitUntil() {
   return Promise.resolve()
 }
 
-type WithCache = ReturnType<typeof createWithCache>
-const withCache: WithCache = vi.fn().mockImplementation(createWithCache({cache, waitUntil}))
+const withCache = createWithCache({cache, waitUntil, request: new Request('https://example.com')})
+const runWithCache = vi.spyOn(withCache, 'run')
 
 const client = createClient({projectId: 'my-project-id', dataset: 'my-dataset'})
 
@@ -63,15 +63,23 @@ describe('the loader', () => {
     })
 
     await loaderWithDefaultStrategy.loadQuery<boolean>(query, params)
-    expect(withCache).toHaveBeenCalledWith(hashedQuery, strategy, expect.any(Function))
-    expect(cache.put).toHaveBeenCalled()
+    expect(runWithCache).toHaveBeenNthCalledWith(
+      1,
+      expect.objectContaining({cacheKey: hashedQuery, cacheStrategy: strategy}),
+      expect.any(Function),
+    )
+    expect(cache.put).toHaveBeenCalledOnce()
   })
 
   it('queries should use the cache strategy passed in `loadQuery`', async () => {
     const strategy = CacheShort()
     await loader.loadQuery<boolean>(query, params, {hydrogen: {cache: strategy}})
-    expect(withCache).toHaveBeenCalledWith(hashedQuery, strategy, expect.any(Function))
-    expect(cache.put).toHaveBeenCalled()
+    expect(runWithCache).toHaveBeenNthCalledWith(
+      1,
+      expect.objectContaining({cacheKey: hashedQuery, cacheStrategy: strategy}),
+      expect.any(Function),
+    )
+    expect(cache.put).toHaveBeenCalledOnce()
   })
 })
 
@@ -108,6 +116,6 @@ describe('when configured for preview', () => {
   it(`shouldn't cache queries`, async () => {
     await previewLoader.loadQuery<boolean>(query)
     expect(loadQuery).toHaveBeenCalledOnce()
-    expect(cache.put).not.toHaveBeenCalled()
+    expect(cache.put).not.toHaveBeenCalledOnce()
   })
 })

package/src/loader.ts

@@ -61,10 +61,18 @@ type HydrogenResponseQueryOptions = Omit<ResponseQueryOptions, 'next' | 'cache'>
   hydrogen?: 'hydrogen' extends keyof RequestInit ? RequestInit['hydrogen'] : never
 }
 
-type LoadQueryOptions = Pick<
+type LoadQueryOptions<T> = Pick<
   HydrogenResponseQueryOptions,
   'perspective' | 'hydrogen' | 'useCdn' | 'stega' | 'headers' | 'tag'
->
+> & {
+  hydrogen?: {
+    /**
+     * Whether to cache the result of the query or not.
+     * @defaultValue () => true
+     */
+    shouldCacheResult?: (value: QueryResponseInitial<T>) => boolean
+  }
+}
 
 export type SanityLoader = {
   /**
@@ -75,7 +83,7 @@ export type SanityLoader = {
   loadQuery<T = any>(
     query: string,
     params?: QueryParams,
-    options?: LoadQueryOptions,
+    options?: LoadQueryOptions<T>,
   ): Promise<QueryResponseInitial<T>>
 
   client: SanityClient
@@ -123,7 +131,7 @@ export function createSanityLoader(options: CreateSanityLoaderOptions): SanityLo
     async loadQuery<T>(
       query: string,
       params: QueryParams | QueryWithoutParams,
-      loaderOptions?: LoadQueryOptions,
+      loaderOptions?: LoadQueryOptions<T>,
     ): Promise<QueryResponseInitial<T>> {
       // Don't store response if preview is enabled
       const cacheStrategy =
@@ -133,7 +141,11 @@ export function createSanityLoader(options: CreateSanityLoaderOptions): SanityLo
 
       const queryHash = await hashQuery(query, params)
 
-      return await withCache(queryHash, cacheStrategy, async ({addDebugData}) => {
+      const shouldCacheResult = loaderOptions?.hydrogen?.shouldCacheResult ?? (() => true)
+
+      const runWithCache = async function runWithCache({
+        addDebugData,
+      }: Parameters<Parameters<WithCache['run']>[1]>[0]): Promise<QueryResponseInitial<T>> {
         // eslint-disable-next-line no-process-env
         if (process.env.NODE_ENV === 'development') {
           // Name displayed in the subrequest profiler
@@ -145,7 +157,12 @@ export function createSanityLoader(options: CreateSanityLoaderOptions): SanityLo
         }
 
         return await loadQuery<T>(query, params, loaderOptions)
-      })
+      }
+
+      return await ('run' in withCache
+        ? withCache.run({cacheKey: queryHash, cacheStrategy, shouldCacheResult}, runWithCache)
+        : // @ts-expect-error for compatibility, remove in next major
+          withCache(queryHash, cacheStrategy, runWithCache))
     },
     client,
     preview,