@sanity/client 5.0.0-esm.7 → 5.0.0-esm.9

package/src/types.ts

@@ -1,5 +1,11 @@
 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
+
 /** @public */
 export interface RequestOptions {
   timeout?: number
@@ -7,8 +13,8 @@ export interface RequestOptions {
   tag?: string
   headers?: Record<string, string>
   method?: string
-  query?: any
-  body?: any
+  query?: FIXME
+  body?: FIXME
 }
 
 /** @public */
@@ -45,17 +51,16 @@ export interface InitializedClientConfig extends ClientConfig {
   useProjectHostname: boolean
   useCdn: boolean
   // These are added by the initConfig function
-  // @TODO consider moving these to private properties on the class instead of adding them to the config
   /**
-   * @deprecated Don't use
+   * @deprecated Internal, don't use
    */
   isDefaultApi: boolean
   /**
-   * @deprecated Don't use
+   * @deprecated Internal, don't use
    */
   url: string
   /**
-   * @deprecated Don't use
+   * @deprecated Internal, don't use
    */
   cdnUrl: string
 }
@@ -149,7 +154,7 @@ export interface SanityReference {
 }
 
 /** @internal */
-export type SanityDocument<T extends Record<string, any> = Record<string, any>> = {
+export type SanityDocument<T extends Record<string, FIXME> = Record<string, FIXME>> = {
   [P in keyof T]: T[P]
 } & {
   _id: string
@@ -206,11 +211,11 @@ export interface SanityImageAssetDocument extends SanityAssetDocument {
     }
     image?: {
       _type: 'sanity.imageExifTags'
-      [key: string]: any
+      [key: string]: FIXME
     }
     exif?: {
       _type: 'sanity.imageExifMetadata'
-      [key: string]: any
+      [key: string]: FIXME
     }
   }
 }
@@ -218,10 +223,10 @@ export interface SanityImageAssetDocument extends SanityAssetDocument {
 /** @public */
 export interface ErrorProps {
   message: string
-  response: any
+  response: FIXME
   statusCode: number
-  responseBody: any
-  details: any
+  responseBody: FIXME
+  details: FIXME
 }
 
 /** @public */
@@ -331,31 +336,32 @@ export interface CurrentSanityUser {
 }
 
 /** @public */
-export type SanityDocumentStub<T extends Record<string, any> = Record<string, any>> = {
+export type SanityDocumentStub<T extends Record<string, FIXME> = Record<string, FIXME>> = {
   [P in keyof T]: T[P]
 } & {
   _type: string
 }
 
 /** @public */
-export type IdentifiedSanityDocumentStub<T extends Record<string, any> = Record<string, any>> = {
-  [P in keyof T]: T[P]
-} & {
-  _id: string
-} & SanityDocumentStub
+export type IdentifiedSanityDocumentStub<T extends Record<string, FIXME> = Record<string, FIXME>> =
+  {
+    [P in keyof T]: T[P]
+  } & {
+    _id: string
+  } & SanityDocumentStub
 
 /** @internal */
 export type InsertPatch =
-  | {before: string; items: any[]}
-  | {after: string; items: any[]}
-  | {replace: string; items: any[]}
+  | {before: string; items: FIXME[]}
+  | {after: string; items: FIXME[]}
+  | {replace: string; items: FIXME[]}
 
 // Note: this is actually incorrect/invalid, but implemented as-is for backwards compatibility
 /** @internal */
 export interface PatchOperations {
-  set?: {[key: string]: any}
-  setIfMissing?: {[key: string]: any}
-  diffMatchPatch?: {[key: string]: any}
+  set?: {[key: string]: FIXME}
+  setIfMissing?: {[key: string]: FIXME}
+  diffMatchPatch?: {[key: string]: FIXME}
   unset?: string[]
   inc?: {[key: string]: number}
   dec?: {[key: string]: number}
@@ -364,7 +370,7 @@ export interface PatchOperations {
 }
 
 /** @public */
-export type QueryParams = {[key: string]: any}
+export type QueryParams = {[key: string]: FIXME}
 /** @internal */
 export type MutationSelection = {query: string; params?: QueryParams} | {id: string | string[]}
 /** @internal */
@@ -373,7 +379,7 @@ export type PatchSelection = string | string[] | MutationSelection
 export type PatchMutationOperation = PatchOperations & MutationSelection
 
 /** @public */
-export type Mutation<R extends Record<string, any> = Record<string, any>> =
+export type Mutation<R extends Record<string, FIXME> = Record<string, FIXME>> =
   | {create: SanityDocumentStub<R>}
   | {createOrReplace: IdentifiedSanityDocumentStub<R>}
   | {createIfNotExists: IdentifiedSanityDocumentStub<R>}
@@ -381,7 +387,7 @@ export type Mutation<R extends Record<string, any> = Record<string, any>> =
   | {patch: PatchMutationOperation}
 
 /** @public */
-export type MutationEvent<R extends Record<string, any> = Record<string, any>> = {
+export type MutationEvent<R extends Record<string, FIXME> = Record<string, FIXME>> = {
   type: 'mutation'
   documentId: string
   eventId: string
@@ -421,7 +427,7 @@ export type WelcomeEvent = {
 }
 
 /** @public */
-export type ListenEvent<R extends Record<string, any>> =
+export type ListenEvent<R extends Record<string, FIXME>> =
   | MutationEvent<R>
   | ChannelErrorEvent
   | DisconnectEvent
@@ -510,7 +516,7 @@ export type AllDocumentIdsMutationOptions = BaseMutationOptions & {
 }
 
 /** @internal */
-export type AttributeSet = {[key: string]: any}
+export type AttributeSet = {[key: string]: FIXME}
 
 /** @internal */
 export type TransactionFirstDocumentMutationOptions = BaseMutationOptions & {
@@ -557,6 +563,6 @@ export interface RawRequestOptions {
   headers?: {[key: string]: string}
   timeout?: number
   proxy?: string
-  body?: any
+  body?: FIXME
   maxRedirects?: number
 }

package/src/util/defaults.ts

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

package/src/util/once.ts

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

package/src/util/pick.ts

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

package/src/validators.ts

@@ -1,4 +1,4 @@
-import type {InitializedClientConfig} from './types'
+import type {FIXME, 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: any) => {
+export const validateObject = (op: string, val: FIXME) => {
   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, any>) => {
+export const requireDocumentId = (op: string, doc: Record<string, FIXME>) => {
   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, any>) => {
   validateDocumentId(op, doc._id)
 }
 
-export const validateInsert = (at: string, selector: string, items: any[]) => {
+export const validateInsert = (at: string, selector: string, items: FIXME[]) => {
   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,9 +1,10 @@
 import generateHelpUrl from './generateHelpUrl'
+import {FIXME} from './types'
 import once from './util/once'
 
 const createWarningPrinter = (message: string[]) =>
   // eslint-disable-next-line no-console
-  once((...args: any[]) => console.warn(message.join(' '), ...args))
+  once((...args: FIXME[]) => 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',