@sanity/client 5.2.0 → 5.2.1

package/src/http/request.ts

@@ -2,11 +2,11 @@ import {getIt, type Middlewares} from 'get-it'
 import {jsonRequest, jsonResponse, observable, progress} from 'get-it/middleware'
 import {Observable} from 'rxjs'
 
-import type {FIXME, HttpRequest, RequestOptions} from '../types'
+import type {Any, HttpRequest, RequestOptions} from '../types'
 import {ClientError, ServerError} from './errors'
 
 const httpError = {
-  onResponse: (res: FIXME) => {
+  onResponse: (res: Any) => {
     if (res.statusCode >= 500) {
       throw new ServerError(res)
     } else if (res.statusCode >= 400) {
@@ -18,7 +18,7 @@ const httpError = {
 }
 
 const printWarnings = {
-  onResponse: (res: FIXME) => {
+  onResponse: (res: Any) => {
     const warn = res.headers['x-sanity-warning']
     const warnings = Array.isArray(warn) ? warn : [warn]
     warnings.filter(Boolean).forEach((msg) => console.warn(msg)) // eslint-disable-line no-console
@@ -39,7 +39,7 @@ export function defineHttpRequest(envMiddleware: Middlewares): HttpRequest {
   ])
 
   function httpRequest(options: RequestOptions, requester = request) {
-    return requester({maxRedirects: 0, ...options} as FIXME)
+    return requester({maxRedirects: 0, ...options} as Any)
   }
 
   httpRequest.defaultRequester = request

package/src/http/requestOptions.ts

@@ -1,11 +1,11 @@
 import type {RequestOptions} from 'get-it'
 
-import type {FIXME} from '../types'
+import type {Any} from '../types'
 
 const projectHeader = 'X-Sanity-Project-ID'
 
-export default (config: FIXME, overrides: FIXME = {}): Omit<RequestOptions, 'url'> => {
-  const headers: FIXME = {}
+export function requestOptions(config: Any, overrides: Any = {}): Omit<RequestOptions, 'url'> {
+  const headers: Any = {}
 
   const token = overrides.token || config.token
   if (token) {

package/src/index.browser.ts

@@ -2,6 +2,7 @@ import envMiddleware from './http/browserMiddleware'
 import {defineHttpRequest} from './http/request'
 import {SanityClient} from './SanityClient'
 import type {ClientConfig} from './types'
+import {printNoDefaultExport} from './warnings'
 
 export * from './data/patch'
 export * from './data/transaction'
@@ -17,4 +18,11 @@ export const requester = httpRequest.defaultRequester
 /** @public */
 export const createClient = (config: ClientConfig) => new SanityClient(httpRequest, config)
 
-export {migrationNotice as default} from './migrationNotice'
+/**
+ * @public
+ * @deprecated Use the named export `createClient` instead of the `default` export
+ */
+export default function deprecatedCreateClient(config: ClientConfig) {
+  printNoDefaultExport()
+  return new SanityClient(httpRequest, config)
+}

package/src/index.ts

@@ -2,6 +2,7 @@ import envMiddleware from './http/nodeMiddleware'
 import {defineHttpRequest} from './http/request'
 import {SanityClient} from './SanityClient'
 import type {ClientConfig} from './types'
+import {printNoDefaultExport} from './warnings'
 
 export * from './data/patch'
 export * from './data/transaction'
@@ -17,4 +18,11 @@ export const requester = httpRequest.defaultRequester
 /** @public */
 export const createClient = (config: ClientConfig) => new SanityClient(httpRequest, config)
 
-export {migrationNotice as default} from './migrationNotice'
+/**
+ * @public
+ * @deprecated Use the named export `createClient` instead of the `default` export
+ */
+export default function deprecatedCreateClient(config: ClientConfig) {
+  printNoDefaultExport()
+  return new SanityClient(httpRequest, config)
+}

package/src/types.ts

@@ -4,7 +4,7 @@ import type {Requester} from 'get-it'
  * Used to tag types that is set to `any` as a temporary measure, but should be replaced with proper typings in the future
  * @internal
  */
-export type FIXME = any // eslint-disable-line @typescript-eslint/no-explicit-any
+export type Any = any // eslint-disable-line @typescript-eslint/no-explicit-any
 
 /** @public */
 export interface RequestOptions {
@@ -13,8 +13,8 @@ export interface RequestOptions {
   tag?: string
   headers?: Record<string, string>
   method?: string
-  query?: FIXME
-  body?: FIXME
+  query?: Any
+  body?: Any
   signal?: AbortSignal
 }
 
@@ -155,7 +155,7 @@ export interface SanityReference {
 }
 
 /** @internal */
-export type SanityDocument<T extends Record<string, FIXME> = Record<string, FIXME>> = {
+export type SanityDocument<T extends Record<string, Any> = Record<string, Any>> = {
   [P in keyof T]: T[P]
 } & {
   _id: string
@@ -212,11 +212,11 @@ export interface SanityImageAssetDocument extends SanityAssetDocument {
     }
     image?: {
       _type: 'sanity.imageExifTags'
-      [key: string]: FIXME
+      [key: string]: Any
     }
     exif?: {
       _type: 'sanity.imageExifMetadata'
-      [key: string]: FIXME
+      [key: string]: Any
     }
   }
 }
@@ -224,10 +224,10 @@ export interface SanityImageAssetDocument extends SanityAssetDocument {
 /** @public */
 export interface ErrorProps {
   message: string
-  response: FIXME
+  response: Any
   statusCode: number
-  responseBody: FIXME
-  details: FIXME
+  responseBody: Any
+  details: Any
 }
 
 /** @public */
@@ -337,32 +337,31 @@ export interface CurrentSanityUser {
 }
 
 /** @public */
-export type SanityDocumentStub<T extends Record<string, FIXME> = Record<string, FIXME>> = {
+export type SanityDocumentStub<T extends Record<string, Any> = Record<string, Any>> = {
   [P in keyof T]: T[P]
 } & {
   _type: string
 }
 
 /** @public */
-export type IdentifiedSanityDocumentStub<T extends Record<string, FIXME> = Record<string, FIXME>> =
-  {
-    [P in keyof T]: T[P]
-  } & {
-    _id: string
-  } & SanityDocumentStub
+export type IdentifiedSanityDocumentStub<T extends Record<string, Any> = Record<string, Any>> = {
+  [P in keyof T]: T[P]
+} & {
+  _id: string
+} & SanityDocumentStub
 
 /** @internal */
 export type InsertPatch =
-  | {before: string; items: FIXME[]}
-  | {after: string; items: FIXME[]}
-  | {replace: string; items: FIXME[]}
+  | {before: string; items: Any[]}
+  | {after: string; items: Any[]}
+  | {replace: string; items: Any[]}
 
 // Note: this is actually incorrect/invalid, but implemented as-is for backwards compatibility
 /** @internal */
 export interface PatchOperations {
-  set?: {[key: string]: FIXME}
-  setIfMissing?: {[key: string]: FIXME}
-  diffMatchPatch?: {[key: string]: FIXME}
+  set?: {[key: string]: Any}
+  setIfMissing?: {[key: string]: Any}
+  diffMatchPatch?: {[key: string]: Any}
   unset?: string[]
   inc?: {[key: string]: number}
   dec?: {[key: string]: number}
@@ -371,7 +370,7 @@ export interface PatchOperations {
 }
 
 /** @public */
-export type QueryParams = {[key: string]: FIXME}
+export type QueryParams = {[key: string]: Any}
 /** @internal */
 export type MutationSelection = {query: string; params?: QueryParams} | {id: string | string[]}
 /** @internal */
@@ -380,7 +379,7 @@ export type PatchSelection = string | string[] | MutationSelection
 export type PatchMutationOperation = PatchOperations & MutationSelection
 
 /** @public */
-export type Mutation<R extends Record<string, FIXME> = Record<string, FIXME>> =
+export type Mutation<R extends Record<string, Any> = Record<string, Any>> =
   | {create: SanityDocumentStub<R>}
   | {createOrReplace: IdentifiedSanityDocumentStub<R>}
   | {createIfNotExists: IdentifiedSanityDocumentStub<R>}
@@ -388,7 +387,7 @@ export type Mutation<R extends Record<string, FIXME> = Record<string, FIXME>> =
   | {patch: PatchMutationOperation}
 
 /** @public */
-export type MutationEvent<R extends Record<string, FIXME> = Record<string, FIXME>> = {
+export type MutationEvent<R extends Record<string, Any> = Record<string, Any>> = {
   type: 'mutation'
   documentId: string
   eventId: string
@@ -428,7 +427,7 @@ export type WelcomeEvent = {
 }
 
 /** @public */
-export type ListenEvent<R extends Record<string, FIXME>> =
+export type ListenEvent<R extends Record<string, Any>> =
   | MutationEvent<R>
   | ChannelErrorEvent
   | DisconnectEvent
@@ -517,7 +516,7 @@ export type AllDocumentIdsMutationOptions = BaseMutationOptions & {
 }
 
 /** @internal */
-export type AttributeSet = {[key: string]: FIXME}
+export type AttributeSet = {[key: string]: Any}
 
 /** @internal */
 export type TransactionFirstDocumentMutationOptions = BaseMutationOptions & {
@@ -564,6 +563,6 @@ export interface RawRequestOptions {
   headers?: {[key: string]: string}
   timeout?: number
   proxy?: string
-  body?: FIXME
+  body?: Any
   maxRedirects?: number
 }

package/src/util/defaults.ts

@@ -1,10 +1,10 @@
-import type {FIXME} from '../types'
+import type {Any} from '../types'
 
-export default (obj: FIXME, defaults: FIXME) =>
+export default (obj: Any, defaults: Any) =>
   Object.keys(defaults)
     .concat(Object.keys(obj))
     .reduce((target, prop) => {
       target[prop] = typeof obj[prop] === 'undefined' ? defaults[prop] : obj[prop]
 
       return target
-    }, {} as FIXME)
+    }, {} as Any)

package/src/util/getSelection.ts

@@ -1,6 +1,6 @@
 import type {MutationSelection} from '../types'
 
-export default function getSelection(sel: unknown): MutationSelection {
+export function getSelection(sel: unknown): MutationSelection {
   if (typeof sel === 'string' || Array.isArray(sel)) {
     return {id: sel}
   }

package/src/util/once.ts

@@ -1,9 +1,9 @@
-import type {FIXME} from '../types'
+import type {Any} from '../types'
 
-export default (fn: FIXME) => {
+export function once(fn: Any) {
   let didCall = false
-  let returnValue: FIXME
-  return (...args: FIXME[]) => {
+  let returnValue: Any
+  return (...args: Any[]) => {
     if (didCall) {
       return returnValue
     }

package/src/util/pick.ts

@@ -1,7 +1,7 @@
-import {FIXME} from '../types'
+import {Any} from '../types'
 
-export default (obj: FIXME, props: FIXME) =>
-  props.reduce((selection: FIXME, prop: FIXME) => {
+export const pick = (obj: Any, props: Any) =>
+  props.reduce((selection: Any, prop: Any) => {
     if (typeof obj[prop] === 'undefined') {
       return selection
     }

package/src/validators.ts

@@ -1,4 +1,4 @@
-import type {FIXME, InitializedClientConfig} from './types'
+import type {Any, InitializedClientConfig} from './types'
 
 const VALID_ASSET_TYPES = ['image', 'file']
 const VALID_INSERT_LOCATIONS = ['before', 'after', 'replace']
@@ -23,7 +23,7 @@ export const validateAssetType = (type: string) => {
   }
 }
 
-export const validateObject = (op: string, val: FIXME) => {
+export const validateObject = (op: string, val: Any) => {
   if (val === null || typeof val !== 'object' || Array.isArray(val)) {
     throw new Error(`${op}() takes an object of properties`)
   }
@@ -35,7 +35,7 @@ export const validateDocumentId = (op: string, id: string) => {
   }
 }
 
-export const requireDocumentId = (op: string, doc: Record<string, FIXME>) => {
+export const requireDocumentId = (op: string, doc: Record<string, Any>) => {
   if (!doc._id) {
     throw new Error(`${op}() requires that the document contains an ID ("_id" property)`)
   }
@@ -43,7 +43,7 @@ export const requireDocumentId = (op: string, doc: Record<string, FIXME>) => {
   validateDocumentId(op, doc._id)
 }
 
-export const validateInsert = (at: string, selector: string, items: FIXME[]) => {
+export const validateInsert = (at: string, selector: string, items: Any[]) => {
   const signature = 'insert(at, selector, items)'
   if (VALID_INSERT_LOCATIONS.indexOf(at) === -1) {
     const valid = VALID_INSERT_LOCATIONS.map((loc) => `"${loc}"`).join(', ')

package/src/warnings.ts

@@ -1,10 +1,10 @@
-import generateHelpUrl from './generateHelpUrl'
-import {FIXME} from './types'
-import once from './util/once'
+import {generateHelpUrl} from './generateHelpUrl'
+import {Any} from './types'
+import {once} from './util/once'
 
 const createWarningPrinter = (message: string[]) =>
   // eslint-disable-next-line no-console
-  once((...args: FIXME[]) => console.warn(message.join(' '), ...args))
+  once((...args: Any[]) => console.warn(message.join(' '), ...args))
 
 export const printCdnWarning = createWarningPrinter([
   'You are not using the Sanity CDN. That means your data is always fresh, but the CDN is faster and',
@@ -24,3 +24,7 @@ export const printNoApiVersionSpecifiedWarning = createWarningPrinter([
   'Using the Sanity client without specifying an API version is deprecated.',
   `See ${generateHelpUrl('js-client-api-version')}`,
 ])
+
+export const printNoDefaultExport = createWarningPrinter([
+  'The default export of @sanity/client has been deprecated. Use the named export `createClient` instead',
+])

package/umd/sanityClient.js

@@ -3185,7 +3185,7 @@
     return httpRequest;
   }
   const projectHeader = "X-Sanity-Project-ID";
-  var getRequestOptions = function (config) {
+  function requestOptions(config) {
     let overrides = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
     const headers = {};
     const token = overrides.token || config.token;
@@ -3204,7 +3204,7 @@
       json: true,
       withCredentials
     });
-  };
+  }
   function getSelection(sel) {
     if (typeof sel === "string" || Array.isArray(sel)) {
       return {
@@ -3280,7 +3280,7 @@
     }
     return tag;
   };
-  var encodeQueryString = _ref => {
+  const encodeQueryString = _ref => {
     let {
       query,
       params = {},
@@ -3885,7 +3885,7 @@
         ...options.query
       };
     }
-    const reqOptions = getRequestOptions(config, Object.assign({}, options, {
+    const reqOptions = requestOptions(config, Object.assign({}, options, {
       url: _getUrl(client, uri, useCdn)
     }));
     const request = new Observable(subscriber =>
@@ -4041,7 +4041,7 @@
   function generateHelpUrl(slug) {
     return BASE_URL + slug;
   }
-  var once = fn => {
+  function once(fn) {
     let didCall = false;
     let returnValue;
     return function () {
@@ -4052,7 +4052,7 @@
       didCall = true;
       return returnValue;
     };
-  };
+  }
   const createWarningPrinter = message =>
   // eslint-disable-next-line no-console
   once(function () {
@@ -4064,6 +4064,7 @@
   const printCdnWarning = createWarningPrinter(["You are not using the Sanity CDN. That means your data is always fresh, but the CDN is faster and", "cheaper. Think about it! For more info, see ".concat(generateHelpUrl("js-client-cdn-configuration"), " "), "To hide this warning, please set the `useCdn` option to either `true` or `false` when creating", "the client."]);
   const printBrowserTokenWarning = createWarningPrinter(["You have configured Sanity client to use a token in the browser. This may cause unintentional security issues.", "See ".concat(generateHelpUrl("js-client-browser-token"), " for more information and how to hide this warning.")]);
   const printNoApiVersionSpecifiedWarning = createWarningPrinter(["Using the Sanity client without specifying an API version is deprecated.", "See ".concat(generateHelpUrl("js-client-api-version"))]);
+  const printNoDefaultExport = createWarningPrinter(["The default export of @sanity/client has been deprecated. Use the named export `createClient` instead"]);
   const defaultCdnHost = "apicdn.sanity.io";
   const defaultConfig = {
     apiHost: "https://api.sanity.io",
@@ -4133,7 +4134,7 @@
     target[prop] = typeof obj[prop] === "undefined" ? defaults[prop] : obj[prop];
     return target;
   }, {});
-  var pick = (obj, props) => props.reduce((selection, prop) => {
+  const pick = (obj, props) => props.reduce((selection, prop) => {
     if (typeof obj[prop] === "undefined") {
       return selection;
     }
@@ -4818,12 +4819,13 @@
   let SanityClient = _SanityClient;
   _clientConfig2 = new WeakMap();
   _httpRequest2 = new WeakMap();
-  function migrationNotice() {
-    throw new TypeError("The default export of @sanity/client has been deprecated. Use the named export `createClient` instead");
-  }
   const httpRequest = defineHttpRequest(envMiddleware);
   const requester = httpRequest.defaultRequester;
   const createClient = config => new SanityClient(httpRequest, config);
+  function deprecatedCreateClient(config) {
+    printNoDefaultExport();
+    return new SanityClient(httpRequest, config);
+  }
 
   exports.BasePatch = BasePatch;
   exports.BaseTransaction = BaseTransaction;
@@ -4836,7 +4838,7 @@
   exports.ServerError = ServerError;
   exports.Transaction = Transaction;
   exports.createClient = createClient;
-  exports.default = migrationNotice;
+  exports.default = deprecatedCreateClient;
   exports.requester = requester;
 
   Object.defineProperty(exports, '__esModule', { value: true });