@sanity/client 8.4.0 → 8.5.0

package/src/mediaLibrary/MediaLibraryVideoClient.ts

@@ -10,7 +10,10 @@ import type {
   VideoPlaybackInfo,
 } from '../types'
 
-/** @internal */
+/**
+ * @internal
+ * @inline
+ */
 export class ObservableMediaLibraryVideoClient {
   #client: ObservableSanityClient
   #httpRequest: HttpRequest
@@ -53,7 +56,10 @@ export class ObservableMediaLibraryVideoClient {
   }
 }
 
-/** @internal */
+/**
+ * @internal
+ * @inline
+ */
 export class MediaLibraryVideoClient {
   #client: SanityClient
   #httpRequest: HttpRequest

package/src/projects/ProjectsClient.ts

@@ -15,7 +15,10 @@ type OmittedProjectFields<T extends ListOptions | undefined> =
   | (T extends {includeMembers: false} ? 'members' : never)
   | (T extends {includeFeatures: false} ? 'features' : never)
 
-/** @internal */
+/**
+ * @internal
+ * @inline
+ */
 export class ObservableProjectsClient {
   #client: ObservableSanityClient
   #httpRequest: HttpRequest
@@ -69,7 +72,10 @@ export class ObservableProjectsClient {
   }
 }
 
-/** @internal */
+/**
+ * @internal
+ * @inline
+ */
 export class ProjectsClient {
   #client: SanityClient
   #httpRequest: HttpRequest

package/src/releases/ReleasesClient.ts

@@ -28,7 +28,10 @@ import type {
 } from '../types'
 import {createRelease} from './createRelease'
 
-/** @public */
+/**
+ * @public
+ * @inline
+ */
 export class ObservableReleasesClient {
   #client: ObservableSanityClient
   #httpRequest: HttpRequest
@@ -365,7 +368,10 @@ export class ObservableReleasesClient {
   }
 }
 
-/** @public */
+/**
+ * @public
+ * @inline
+ */
 export class ReleasesClient {
   #client: SanityClient
   #httpRequest: HttpRequest

package/src/types.ts

@@ -635,7 +635,7 @@ export type DatasetAclMode = 'public' | 'private' | 'custom'
 /** @public */
 export type DatasetCreateOptions = {
   aclMode?: DatasetAclMode
-  description?: string
+  description?: string | null
   embeddings?: {
     enabled: boolean
     projection?: string
@@ -645,7 +645,7 @@ export type DatasetCreateOptions = {
 /** @public */
 export type DatasetEditOptions = {
   aclMode?: DatasetAclMode
-  description?: string
+  description?: string | null
 }
 
 /** @public */
@@ -662,12 +662,16 @@ export type EmbeddingsSettingsBody = {
 }
 
 /** @public */
-export type DatasetResponse = {datasetName: string; aclMode: DatasetAclMode; description: string}
+export type DatasetResponse = {
+  datasetName: string
+  aclMode: DatasetAclMode
+  description: string | null
+}
 /** @public */
 export type DatasetsResponse = {
   name: string
   aclMode: DatasetAclMode
-  description: string
+  description?: string
   createdAt: string
   createdByUserId: string
   addonFor: string | null
@@ -2276,8 +2280,47 @@ export type LiveEvent =
   | LiveEventWelcome
   | LiveEventGoAway
 
-/** @public */
-export interface SanityQueries {}
+declare global {
+  /**
+   * Query result types, keyed by GROQ query string. Empty by default, `sanity typegen` registers
+   * the queries it finds:
+   * ```ts
+   * declare global {
+   *   interface SanityQueries {
+   *     '*[_type == "post"]': PostsQueryResult
+   *   }
+   * }
+   * ```
+   * `client.fetch(query)` and `ClientReturn<typeof query>` then resolve to the registered type.
+   *
+   * The registry is a global rather than a module augmentation of `@sanity/client` so that it
+   * does not depend on module resolution: it resolves the same whether `@sanity/client` is a
+   * direct dependency, how many copies of it are installed, and from every subpath export.
+   */
+  interface SanityQueries {}
+}
+
+/**
+ * The query registry as seen from `@sanity/client`. Inherits every query registered on the global
+ * `SanityQueries` interface, and still accepts the older module augmentation form:
+ * ```ts
+ * declare module '@sanity/client' {
+ *   interface SanityQueries {
+ *     '*[_type == "post"]': PostsQueryResult
+ *   }
+ * }
+ * ```
+ * `@sanity/client` releases that predate the global registry only read this interface, so a
+ * generated file that registers queries globally can bridge them with an augmentation that adds
+ * the global as a base type. It is harmless on releases that already inherit it:
+ * ```ts
+ * declare module '@sanity/client' {
+ *   interface SanityQueries extends globalThis.SanityQueries {}
+ * }
+ * ```
+ * @public
+ */
+export interface SanityQueries extends globalThis.SanityQueries {}
 
 /** @public */
 export type ClientReturn<

package/src/users/UsersClient.ts

@@ -4,7 +4,10 @@ import {_request, _requestObservable} from '../data/dataMethods'
 import type {ObservableSanityClient, SanityClient} from '../SanityClient'
 import type {CurrentSanityUser, HttpRequest, SanityUser} from '../types'
 
-/** @public */
+/**
+ * @public
+ * @inline
+ */
 export class ObservableUsersClient {
   #client: ObservableSanityClient
   #httpRequest: HttpRequest
@@ -27,7 +30,10 @@ export class ObservableUsersClient {
   }
 }
 
-/** @public */
+/**
+ * @public
+ * @inline
+ */
 export class UsersClient {
   #client: SanityClient
   #httpRequest: HttpRequest

package/dist/dist-Z8cIRxoB.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"dist-Z8cIRxoB.js","names":[],"sources":["../node_modules/.pnpm/@vercel+stega@1.1.0/node_modules/@vercel/stega/dist/index.mjs"],"sourcesContent":["var p={0:8203,1:8204,2:8205,3:8290,4:8291,5:8288,6:65279,7:8289,8:119155,9:119156,a:119157,b:119158,c:119159,d:119160,e:119161,f:119162},l={0:8203,1:8204,2:8205,3:65279},d={0:String.fromCodePoint(l[0]),1:String.fromCodePoint(l[1]),2:String.fromCodePoint(l[2]),3:String.fromCodePoint(l[3])},u=new Array(4).fill(String.fromCodePoint(l[0])).join(\"\"),g=String.fromCharCode(0);function A(e){let r=JSON.stringify(e),t=new TextEncoder().encode(r),i=\"\";for(let c=0;c<t.length;c++){let n=t[c];i+=d[n>>6&3]+d[n>>4&3]+d[n>>2&3]+d[n&3]}return u+i}function C(e){let r=JSON.stringify(e);return Array.from(r).map(t=>{let i=t.charCodeAt(0);if(i>255)throw new Error(`Only ASCII edit info can be encoded. Error attempting to encode ${r} on character ${t} (${i})`);return Array.from(i.toString(16).padStart(2,\"0\")).map(c=>String.fromCodePoint(p[c])).join(\"\")}).join(\"\")}function I(e){return!Number.isNaN(Number(e))||/[a-z]/i.test(e)&&!/\\d+(?:[-:\\/]\\d+){2}(?:T\\d+(?:[-:\\/]\\d+){1,2}(\\.\\d+)?Z?)?/.test(e)?!1:!!Date.parse(e)}function S(e){try{new URL(e,e.startsWith(\"/\")?\"https://acme.com\":void 0)}catch{return!1}return!0}function y(e,r,t=\"auto\"){return t===!0||t===\"auto\"&&(I(e)||S(e))?e:`${e}${A(r)}`}var m=Object.fromEntries(Object.entries(d).map(e=>[e[1],+e[0]])),T=Object.fromEntries(Object.entries(p).map(e=>e.reverse())),h=`${Object.values(p).map(e=>`\\\\u{${e.toString(16)}}`).join(\"\")}`,x=new RegExp(`[${h}]{4,}`,\"gu\");function X(e){let r=e.match(x);if(r)return E(r[0],!0)[0]}function M(e){let r=e.match(x);if(r)return r.map(t=>E(t)).flat()}function E(e,r=!1){let t=Array.from(e),i=1/0,c=-1;for(let n=0;n<t.length;++n)t[n]===u[0]&&t[n+1]===u[1]&&t[n+2]===u[2]&&t[n+3]===u[3]&&(i=Math.min(i,n),c=Math.max(c,n));if(c===-1)return _(t,r);for(let n=i;n<=c;++n)if(!((t.length-n)%4))try{let f=t.slice(n+4),s=new Uint8Array(f.length/4);for(let o=0;o<s.length;o++)s[o]=m[f[o*4]]<<6|m[f[o*4+1]]<<4|m[f[o*4+2]]<<2|m[f[o*4+3]];let a=new TextDecoder().decode(s);if(r){let o=a.indexOf(g);return o===-1&&(o=a.length),[JSON.parse(a.slice(0,o))]}return a.split(g).filter(Boolean).map(o=>JSON.parse(o))}catch{}return[]}function _(e,r){var f;let t=[];for(let s=e.length*.5;s--;){let a=`${T[e[s*2].codePointAt(0)]}${T[e[s*2+1].codePointAt(0)]}`;t.unshift(String.fromCharCode(parseInt(a,16)))}let i=[],c=[t.join(\"\")],n=10;for(;c.length;){let s=c.shift();try{if(i.push(JSON.parse(s)),r)return i}catch(a){if(!n--)throw a;let o=+((f=a.message.match(/\\sposition\\s(\\d+)$/))==null?void 0:f[1]);if(!o)throw a;c.unshift(s.substring(0,o),s.substring(o))}}return i}function P(e){var r;return{cleaned:e.replace(x,\"\"),encoded:((r=e.match(x))==null?void 0:r[0])||\"\"}}function w(e){return e&&JSON.parse(P(JSON.stringify(e)).cleaned)}export{x as VERCEL_STEGA_REGEX,C as legacyStegaEncode,w as vercelStegaClean,y as vercelStegaCombine,X as vercelStegaDecode,M as vercelStegaDecodeAll,A as vercelStegaEncode,P as vercelStegaSplit};\n"],"x_google_ignoreList":[0],"mappings":"AAAA,IAAI,IAAE;CAAC,GAAE;CAAK,GAAE;CAAK,GAAE;CAAK,GAAE;CAAK,GAAE;CAAK,GAAE;CAAK,GAAE;CAAM,GAAE;CAAK,GAAE;CAAO,GAAE;CAAO,GAAE;CAAO,GAAE;CAAO,GAAE;CAAO,GAAE;CAAO,GAAE;CAAO,GAAE;AAAM,GAAE,IAAE;CAAC,GAAE;CAAK,GAAE;CAAK,GAAE;CAAK,GAAE;AAAK,GAAE,IAAE;CAAC,GAAE,OAAO,cAAc,EAAE,EAAE;CAAE,GAAE,OAAO,cAAc,EAAE,EAAE;CAAE,GAAE,OAAO,cAAc,EAAE,EAAE;CAAE,GAAE,OAAO,cAAc,EAAE,EAAE;AAAC,GAAE,IAAE;;;;;AAAW,CAAC,CAAC,KAAK,OAAO,cAAc,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,EAAE;AAA2B,SAAS,EAAE,GAAE;CAAC,IAAI,IAAE,KAAK,UAAU,CAAC,GAAE,IAAE,IAAI,YAAY,CAAC,CAAC,OAAO,CAAC,GAAE,IAAE;CAAG,KAAI,IAAI,IAAE,GAAE,IAAE,EAAE,QAAO,KAAI;EAAC,IAAI,IAAE,EAAE;EAAG,KAAG,EAAE,KAAG,IAAE,KAAG,EAAE,KAAG,IAAE,KAAG,EAAE,KAAG,IAAE,KAAG,EAAE,IAAE;CAAE;CAAC,OAAO,IAAE;AAAC;AAA6T,SAAS,EAAE,GAAE;CAAC,OAAM,CAAC,OAAO,MAAM,OAAO,CAAC,CAAC,KAAG,SAAS,KAAK,CAAC,KAAG,CAAC,2DAA2D,KAAK,CAAC,IAAE,CAAC,IAAE,CAAC,CAAC,KAAK,MAAM,CAAC;AAAC;AAAC,SAAS,EAAE,GAAE;CAAC,IAAG;EAAC,IAAI,IAAI,GAAE,EAAE,WAAW,GAAG,IAAE,qBAAmB,KAAK,CAAC;CAAC,QAAM;EAAC,OAAM,CAAC;CAAC;CAAC,OAAM,CAAC;AAAC;AAAC,SAAS,EAAE,GAAE,GAAE,IAAE,QAAO;CAAC,OAAO,MAAI,CAAC,KAAG,MAAI,WAAS,EAAE,CAAC,KAAG,EAAE,CAAC,KAAG,IAAE,GAAG,IAAI,EAAE,CAAC;AAAG;AAAO,OAAO,YAAY,OAAO,QAAQ,CAAC,CAAC,CAAC,KAAI,MAAG,CAAC,EAAE,IAAG,CAAC,EAAE,EAAE,CAAC,CAAC,GAAI,OAAO,YAAY,OAAO,QAAQ,CAAC,CAAC,CAAC,KAAI,MAAG,EAAE,QAAQ,CAAC,CAAC;AAAE,IAAA,IAAE,GAAG,OAAO,OAAO,CAAC,CAAC,CAAC,KAAI,MAAG,OAAO,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,KAAI,IAAM,OAAO,IAAI,EAAE,QAAO,IAAI;AAA6lC,SAAS,EAAE,GAAE;CAAO,OAAM;EAAC,SAAQ,EAAE,QAAQ,GAAE,EAAE;EAAE,SAAY,EAAE,MAAM,CAAC,CAAA,GAAkB,MAAK;CAAE;AAAC;AAAC,SAAS,EAAE,GAAE;CAAC,OAAO,KAAG,KAAK,MAAM,EAAE,KAAK,UAAU,CAAC,CAAC,CAAC,CAAC,OAAO;AAAC"}

package/dist/stegaClean-C18wLWau.js

@@ -1,21 +0,0 @@
-import { t as w } from "./dist-Z8cIRxoB.js";
-/**
-* Can take a `result` JSON from a `const {result} = client.fetch(query, params, {filterResponse: false})`
-* and remove all stega-encoded data from it.
-* If the result type has strings branded as `StegaString` (by `ClientReturnStega` or `stegaBrand()`),
-* the brand is stripped and the original string type is restored.
-* @public
-*/
-function stegaClean(result) {
-	return w(result);
-}
-/**
-* Can take a `result` JSON from a `const {result} = client.fetch(query, params, {filterResponse: false})`
-* and remove all stega-encoded data from it.
-* @alpha
-* @deprecated Use `stegaClean` instead
-*/
-const vercelStegaCleanAll = stegaClean;
-export { vercelStegaCleanAll as n, stegaClean as t };
-
-//# sourceMappingURL=stegaClean-C18wLWau.js.map

package/dist/stegaClean-C18wLWau.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"stegaClean-C18wLWau.js","names":["vercelStegaClean"],"sources":["../src/stega/stegaClean.ts"],"sourcesContent":["import {vercelStegaClean} from '@vercel/stega'\n\n/**\n * The result of removing stega-encoded data from a value with `stegaClean()`: strings that were\n * branded as `StegaString` are returned to their original type, everything else is left as-is.\n * @public\n */\nexport type StegaCleaned<T> = 0 extends 1 & T\n  ? T\n  : T extends {readonly ' stegaBrand': infer Original extends string}\n    ? Original\n    : T extends string | number | bigint | boolean | null | undefined\n      ? T\n      : T extends Date | RegExp | ((...args: never[]) => unknown)\n        ? T\n        : T extends readonly unknown[]\n          ? {[Index in keyof T]: StegaCleaned<T[Index]>}\n          : T extends object\n            ? {[K in keyof T]: StegaCleaned<T[K]>}\n            : T\n\n/**\n * Can take a `result` JSON from a `const {result} = client.fetch(query, params, {filterResponse: false})`\n * and remove all stega-encoded data from it.\n * If the result type has strings branded as `StegaString` (by `ClientReturnStega` or `stegaBrand()`),\n * the brand is stripped and the original string type is restored.\n * @public\n */\nexport function stegaClean<Result = unknown>(result: Result): StegaCleaned<Result> {\n  return vercelStegaClean(result) as StegaCleaned<Result>\n}\n\n/**\n * Can take a `result` JSON from a `const {result} = client.fetch(query, params, {filterResponse: false})`\n * and remove all stega-encoded data from it.\n * @alpha\n * @deprecated Use `stegaClean` instead\n */\nexport const vercelStegaCleanAll = stegaClean\n"],"mappings":";;;;;;;;AA4BA,SAAgB,WAA6B,QAAsC;CACjF,OAAOA,EAAiB,MAAM;AAChC;;;;;;;AAQA,MAAa,sBAAsB"}