@sanity/client 5.0.0-esm.2 → 5.0.0-esm.4

package/src/types.ts

@@ -1,5 +1,6 @@
 import type {Requester} from 'get-it'
 
+/** @public */
 export interface RequestOptions {
   timeout?: number
   token?: string
@@ -10,6 +11,7 @@ export interface RequestOptions {
   body?: any
 }
 
+/** @public */
 export interface ClientConfig {
   projectId?: string
   dataset?: string
@@ -35,6 +37,7 @@ export interface ClientConfig {
   requester?: Requester
 }
 
+/** @public */
 export interface InitializedClientConfig extends ClientConfig {
   // These are required in the initialized config
   apiHost: string
@@ -57,6 +60,7 @@ export interface InitializedClientConfig extends ClientConfig {
   cdnUrl: string
 }
 
+/** @public */
 export type AssetMetadataType =
   | 'location'
   | 'exif'
@@ -66,6 +70,7 @@ export type AssetMetadataType =
   | 'blurhash'
   | 'none'
 
+/** @public */
 export interface UploadClientConfig {
   /**
    * Optional request tag for the upload
@@ -138,10 +143,12 @@ export interface UploadClientConfig {
   }
 }
 
+/** @internal */
 export interface SanityReference {
   _ref: string
 }
 
+/** @internal */
 export type SanityDocument<T extends Record<string, any> = Record<string, any>> = {
   [P in keyof T]: T[P]
 } & {
@@ -152,6 +159,7 @@ export type SanityDocument<T extends Record<string, any> = Record<string, any>>
   _updatedAt: string
 }
 
+/** @internal */
 export interface SanityAssetDocument extends SanityDocument {
   url: string
   path: string
@@ -164,6 +172,7 @@ export interface SanityAssetDocument extends SanityDocument {
   originalFilename?: string
 }
 
+/** @internal */
 export interface SanityImagePalette {
   background: string
   foreground: string
@@ -171,6 +180,7 @@ export interface SanityImagePalette {
   title: string
 }
 
+/** @internal */
 export interface SanityImageAssetDocument extends SanityAssetDocument {
   metadata: {
     _type: 'sanity.imageMetadata'
@@ -205,6 +215,7 @@ export interface SanityImageAssetDocument extends SanityAssetDocument {
   }
 }
 
+/** @public */
 export interface ErrorProps {
   message: string
   response: any
@@ -213,11 +224,13 @@ export interface ErrorProps {
   details: any
 }
 
+/** @public */
 export type HttpRequest = {
   defaultRequester: Requester
   (options: RequestOptions, requester: Requester): ReturnType<Requester>
 }
 
+/** @internal */
 export interface RequestObservableOptions extends Omit<RequestOptions, 'url'> {
   url?: string
   uri?: string
@@ -225,6 +238,7 @@ export interface RequestObservableOptions extends Omit<RequestOptions, 'url'> {
   tag?: string
 }
 
+/** @public */
 export interface ProgressEvent {
   type: 'progress'
   stage: 'upload' | 'download'
@@ -234,6 +248,7 @@ export interface ProgressEvent {
   lengthComputable: boolean
 }
 
+/** @public */
 export interface ResponseEvent<T = unknown> {
   type: 'response'
   body: T
@@ -244,21 +259,28 @@ export interface ResponseEvent<T = unknown> {
   headers: Record<string, string>
 }
 
+/** @public */
 export type HttpRequestEvent<T = unknown> = ResponseEvent<T> | ProgressEvent
 
+/** @internal */
 export interface AuthProvider {
   name: string
   title: string
   url: string
 }
 
+/** @internal */
 export type AuthProviderResponse = {providers: AuthProvider[]}
 
+/** @internal */
 export type DatasetAclMode = 'public' | 'private' | 'custom'
 
+/** @internal */
 export type DatasetResponse = {datasetName: string; aclMode: DatasetAclMode}
+/** @internal */
 export type DatasetsResponse = {name: string; aclMode: DatasetAclMode}[]
 
+/** @internal */
 export interface SanityProjectMember {
   id: string
   role: string
@@ -266,6 +288,7 @@ export interface SanityProjectMember {
   isCurrentUser: boolean
 }
 
+/** @internal */
 export interface SanityProject {
   id: string
   displayName: string
@@ -284,6 +307,7 @@ export interface SanityProject {
   }
 }
 
+/** @internal */
 export interface SanityUser {
   id: string
   projectId: string
@@ -297,6 +321,7 @@ export interface SanityUser {
   isCurrentUser: boolean
 }
 
+/** @internal */
 export interface CurrentSanityUser {
   id: string
   name: string
@@ -305,24 +330,28 @@ export interface CurrentSanityUser {
   role: string
 }
 
+/** @public */
 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, any> = Record<string, any>> = {
   [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[]}
 
 // 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}
@@ -334,11 +363,16 @@ export interface PatchOperations {
   ifRevisionID?: string
 }
 
+/** @public */
 export type QueryParams = {[key: string]: any}
+/** @internal */
 export type MutationSelection = {query: string; params?: QueryParams} | {id: string | string[]}
+/** @internal */
 export type PatchSelection = string | string[] | MutationSelection
+/** @internal */
 export type PatchMutationOperation = PatchOperations & MutationSelection
 
+/** @public */
 export type Mutation<R extends Record<string, any> = Record<string, any>> =
   | {create: SanityDocumentStub<R>}
   | {createOrReplace: IdentifiedSanityDocumentStub<R>}
@@ -346,6 +380,7 @@ export type Mutation<R extends Record<string, any> = Record<string, any>> =
   | {delete: MutationSelection}
   | {patch: PatchMutationOperation}
 
+/** @public */
 export type MutationEvent<R extends Record<string, any> = Record<string, any>> = {
   type: 'mutation'
   documentId: string
@@ -363,24 +398,29 @@ export type MutationEvent<R extends Record<string, any> = Record<string, any>> =
   visibility: 'query' | 'transaction'
 }
 
+/** @public */
 export type ChannelErrorEvent = {
   type: 'channelError'
   message: string
 }
 
+/** @public */
 export type DisconnectEvent = {
   type: 'disconnect'
   reason: string
 }
 
+/** @public */
 export type ReconnectEvent = {
   type: 'reconnect'
 }
 
+/** @public */
 export type WelcomeEvent = {
   type: 'welcome'
 }
 
+/** @public */
 export type ListenEvent<R extends Record<string, any>> =
   | MutationEvent<R>
   | ChannelErrorEvent
@@ -388,8 +428,10 @@ export type ListenEvent<R extends Record<string, any>> =
   | ReconnectEvent
   | WelcomeEvent
 
+/** @public */
 export type ListenEventName = 'mutation' | 'welcome' | 'reconnect'
 
+/** @public */
 export interface ListenOptions {
   includeResult?: boolean
   includePreviousRevision?: boolean
@@ -399,20 +441,24 @@ export interface ListenOptions {
   tag?: string
 }
 
+/** @internal */
 export type FilteredResponseQueryOptions = RequestOptions & {
   filterResponse?: true
 }
 
+/** @internal */
 export type UnfilteredResponseQueryOptions = RequestOptions & {
   filterResponse: false
 }
 
+/** @internal */
 export interface RawQueryResponse<R> {
   q: string
   ms: number
   result: R
 }
 
+/** @internal */
 export type BaseMutationOptions = RequestOptions & {
   visibility?: 'sync' | 'async' | 'deferred'
   returnDocuments?: boolean
@@ -422,68 +468,82 @@ export type BaseMutationOptions = RequestOptions & {
   skipCrossDatasetReferenceValidation?: boolean
 }
 
+/** @internal */
 export type FirstDocumentMutationOptions = BaseMutationOptions & {
   returnFirst?: true
   returnDocuments?: true
 }
 
+/** @internal */
 export type FirstDocumentIdMutationOptions = BaseMutationOptions & {
   returnFirst?: true
   returnDocuments: false
 }
 
+/** @internal */
 export type AllDocumentsMutationOptions = BaseMutationOptions & {
   returnFirst: false
   returnDocuments?: true
 }
 
+/** @internal */
 export type MutationOperation = 'create' | 'delete' | 'update' | 'none'
 
+/** @internal */
 export interface SingleMutationResult {
   transactionId: string
   documentId: string
   results: {id: string; operation: MutationOperation}[]
 }
 
+/** @internal */
 export interface MultipleMutationResult {
   transactionId: string
   documentIds: string[]
   results: {id: string; operation: MutationOperation}[]
 }
 
+/** @internal */
 export type AllDocumentIdsMutationOptions = BaseMutationOptions & {
   returnFirst: false
   returnDocuments: false
 }
 
+/** @internal */
 export type AttributeSet = {[key: string]: any}
 
+/** @internal */
 export type TransactionFirstDocumentMutationOptions = BaseMutationOptions & {
   returnFirst: true
   returnDocuments: true
 }
 
+/** @internal */
 export type TransactionFirstDocumentIdMutationOptions = BaseMutationOptions & {
   returnFirst: true
   returnDocuments?: false
 }
 
+/** @internal */
 export type TransactionAllDocumentsMutationOptions = BaseMutationOptions & {
   returnFirst?: false
   returnDocuments: true
 }
 
+/** @internal */
 export type TransactionAllDocumentIdsMutationOptions = BaseMutationOptions & {
   returnFirst?: false
   returnDocuments?: false
 }
 
+/** @internal */
 export type TransactionMutationOptions =
   | TransactionFirstDocumentMutationOptions
   | TransactionFirstDocumentIdMutationOptions
   | TransactionAllDocumentsMutationOptions
   | TransactionAllDocumentIdsMutationOptions
 
+/** @internal */
 export interface RawRequestOptions {
   url?: string
   uri?: string

package/src/users/UsersClient.ts

@@ -1,10 +1,17 @@
-import {type Observable} from 'rxjs'
+import {type Observable, lastValueFrom} from 'rxjs'
 
+import {_request} from '../data/dataMethods'
 import type {ObservableSanityClient, SanityClient} from '../SanityClient'
-import type {CurrentSanityUser, SanityUser} from '../types'
+import type {CurrentSanityUser, HttpRequest, SanityUser} from '../types'
 
-export class BaseUsersClient {
-  client: SanityClient | ObservableSanityClient
+/** @public */
+export class ObservableUsersClient {
+  #client: ObservableSanityClient
+  #httpRequest: HttpRequest
+  constructor(client: ObservableSanityClient, httpRequest: HttpRequest) {
+    this.#client = client
+    this.#httpRequest = httpRequest
+  }
 
   /**
    * Fetch a user by user ID
@@ -12,35 +19,37 @@ export class BaseUsersClient {
    * @param id - User ID of the user to fetch. If `me` is provided, a minimal response including the users role is returned.
    */
   getById<T extends 'me' | string>(
-    this: UsersClient,
-    id: T
-  ): Promise<T extends 'me' ? CurrentSanityUser : SanityUser>
-  getById<T extends 'me' | string>(
-    this: ObservableUsersClient,
     id: T
-  ): Observable<T extends 'me' ? CurrentSanityUser : SanityUser>
-  getById<T extends 'me' | string>(
-    id: T
-  ):
-    | Promise<T extends 'me' ? CurrentSanityUser : SanityUser>
-    | Observable<T extends 'me' ? CurrentSanityUser : SanityUser> {
-    return this.client.request({uri: `/users/${id}`})
+  ): Observable<T extends 'me' ? CurrentSanityUser : SanityUser> {
+    return _request<T extends 'me' ? CurrentSanityUser : SanityUser>(
+      this.#client,
+      this.#httpRequest,
+      {uri: `/users/${id}`}
+    )
   }
 }
 
-export class ObservableUsersClient extends BaseUsersClient {
-  client: ObservableSanityClient
-
-  constructor(client: ObservableSanityClient) {
-    super()
-    this.client = client
+/** @public */
+export class UsersClient {
+  #client: SanityClient
+  #httpRequest: HttpRequest
+  constructor(client: SanityClient, httpRequest: HttpRequest) {
+    this.#client = client
+    this.#httpRequest = httpRequest
   }
-}
 
-export class UsersClient extends BaseUsersClient {
-  client: SanityClient
-  constructor(client: SanityClient) {
-    super()
-    this.client = client
+  /**
+   * Fetch a user by user ID
+   *
+   * @param id - User ID of the user to fetch. If `me` is provided, a minimal response including the users role is returned.
+   */
+  getById<T extends 'me' | string>(
+    id: T
+  ): Promise<T extends 'me' ? CurrentSanityUser : SanityUser> {
+    return lastValueFrom(
+      _request<T extends 'me' ? CurrentSanityUser : SanityUser>(this.#client, this.#httpRequest, {
+        uri: `/users/${id}`,
+      })
+    )
   }
 }

package/src/validators.ts

@@ -1,3 +1,5 @@
+import type {InitializedClientConfig} from './types'
+
 const VALID_ASSET_TYPES = ['image', 'file']
 const VALID_INSERT_LOCATIONS = ['before', 'after', 'replace']
 
@@ -9,7 +11,7 @@ export const dataset = (name: string) => {
   }
 }
 
-export const projectId = (id: any) => {
+export const projectId = (id: string) => {
   if (!/^[-a-z0-9]+$/i.test(id)) {
     throw new Error('`projectId` can only contain only a-z, 0-9 and dashes')
   }
@@ -57,7 +59,7 @@ export const validateInsert = (at: string, selector: string, items: any[]) => {
   }
 }
 
-export const hasDataset = (config: any): string => {
+export const hasDataset = (config: InitializedClientConfig): string => {
   if (!config.dataset) {
     throw new Error('`dataset` must be provided to perform queries')
   }