@sanity/client 4.0.1-1 → 5.0.0-esm.0

package/src/projects/ProjectsClient.ts

@@ -0,0 +1,45 @@
+import {type Observable} from 'rxjs'
+
+import type {ObservableSanityClient, SanityClient} from '../SanityClient'
+import type {SanityProject} from '../types'
+
+export class BaseProjectsClient {
+  client: SanityClient | ObservableSanityClient
+
+  /**
+   * Fetch a list of projects the authenticated user has access to
+   */
+  list(this: ProjectsClient): Promise<SanityProject[]>
+  list(this: ObservableProjectsClient): Observable<SanityProject[]>
+  list(): Promise<SanityProject[]> | Observable<SanityProject[]> {
+    return this.client.request({uri: '/projects'})
+  }
+
+  /**
+   * Fetch a project by project ID
+   *
+   * @param projectId - ID of the project to fetch
+   */
+  getById(this: ProjectsClient, projectId: string): Promise<SanityProject>
+  getById(this: ObservableProjectsClient, projectId: string): Observable<SanityProject>
+  getById(projectId: string): Promise<SanityProject> | Observable<SanityProject> {
+    return this.client.request({uri: `/projects/${projectId}`})
+  }
+}
+
+export class ObservableProjectsClient extends BaseProjectsClient {
+  client: ObservableSanityClient
+
+  constructor(client: ObservableSanityClient) {
+    super()
+    this.client = client
+  }
+}
+
+export class ProjectsClient extends BaseProjectsClient {
+  client: SanityClient
+  constructor(client: SanityClient) {
+    super()
+    this.client = client
+  }
+}

package/src/types.ts

@@ -0,0 +1,502 @@
+import type {Requester} from 'get-it'
+
+export interface RequestOptions {
+  timeout?: number
+  token?: string
+  tag?: string
+  headers?: Record<string, string>
+  method?: string
+  query?: any
+  body?: any
+}
+
+export interface ClientConfig {
+  projectId?: string
+  dataset?: string
+  useCdn?: boolean
+  token?: string
+  apiHost?: string
+  apiVersion?: string
+  proxy?: string
+  requestTagPrefix?: string
+  ignoreBrowserTokenWarning?: boolean
+  withCredentials?: boolean
+  allowReconfigure?: boolean
+  timeout?: number
+
+  /**
+   * @deprecated Don't use
+   */
+  useProjectHostname?: boolean
+
+  /**
+   * @deprecated Don't use
+   */
+  requester?: Requester
+}
+
+export interface InitializedClientConfig extends ClientConfig {
+  // These are required in the initialized config
+  apiHost: string
+  apiVersion: string
+  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
+   */
+  isDefaultApi: boolean
+  /**
+   * @deprecated Don't use
+   */
+  url: string
+  /**
+   * @deprecated Don't use
+   */
+  cdnUrl: string
+}
+
+export type AssetMetadataType =
+  | 'location'
+  | 'exif'
+  | 'image'
+  | 'palette'
+  | 'lqip'
+  | 'blurhash'
+  | 'none'
+
+export interface UploadClientConfig {
+  /**
+   * Optional request tag for the upload
+   */
+  tag?: string
+
+  /**
+   * Whether or not to preserve the original filename (default: true)
+   */
+  preserveFilename?: boolean
+
+  /**
+   * Filename for this file (optional)
+   */
+  filename?: string
+
+  /**
+   * Milliseconds to wait before timing the request out
+   */
+  timeout?: number
+
+  /**
+   * Mime type of the file
+   */
+  contentType?: string
+
+  /**
+   * Array of metadata parts to extract from asset
+   */
+  extract?: AssetMetadataType[]
+
+  /**
+   * Optional freeform label for the asset. Generally not used.
+   */
+  label?: string
+
+  /**
+   * Optional title for the asset
+   */
+  title?: string
+
+  /**
+   * Optional description for the asset
+   */
+  description?: string
+
+  /**
+   * The credit to person(s) and/or organization(s) required by the supplier of the asset to be used when published
+   */
+  creditLine?: string
+
+  /**
+   * Source data (when the asset is from an external service)
+   */
+  source?: {
+    /**
+     * The (u)id of the asset within the source, i.e. 'i-f323r1E'
+     */
+    id: string
+
+    /**
+     * The name of the source, i.e. 'unsplash'
+     */
+    name: string
+
+    /**
+     * A url to where to find the asset, or get more info about it in the source
+     */
+    url?: string
+  }
+}
+
+export interface SanityReference {
+  _ref: string
+}
+
+export type SanityDocument<T extends Record<string, any> = Record<string, any>> = {
+  [P in keyof T]: T[P]
+} & {
+  _id: string
+  _rev: string
+  _type: string
+  _createdAt: string
+  _updatedAt: string
+}
+
+export interface SanityAssetDocument extends SanityDocument {
+  url: string
+  path: string
+  size: number
+  assetId: string
+  mimeType: string
+  sha1hash: string
+  extension: string
+  uploadId?: string
+  originalFilename?: string
+}
+
+export interface SanityImagePalette {
+  background: string
+  foreground: string
+  population: number
+  title: string
+}
+
+export interface SanityImageAssetDocument extends SanityAssetDocument {
+  metadata: {
+    _type: 'sanity.imageMetadata'
+    hasAlpha: boolean
+    isOpaque: boolean
+    lqip?: string
+    blurHash?: string
+    dimensions: {
+      _type: 'sanity.imageDimensions'
+      aspectRatio: number
+      height: number
+      width: number
+    }
+    palette?: {
+      _type: 'sanity.imagePalette'
+      darkMuted?: SanityImagePalette
+      darkVibrant?: SanityImagePalette
+      dominant?: SanityImagePalette
+      lightMuted?: SanityImagePalette
+      lightVibrant?: SanityImagePalette
+      muted?: SanityImagePalette
+      vibrant?: SanityImagePalette
+    }
+    image?: {
+      _type: 'sanity.imageExifTags'
+      [key: string]: any
+    }
+    exif?: {
+      _type: 'sanity.imageExifMetadata'
+      [key: string]: any
+    }
+  }
+}
+
+export interface ErrorProps {
+  message: string
+  response: any
+  statusCode: number
+  responseBody: any
+  details: any
+}
+
+export type HttpRequest = {
+  defaultRequester: Requester
+  (options: RequestOptions, requester: Requester): ReturnType<Requester>
+}
+
+export interface RequestObservableOptions extends Omit<RequestOptions, 'url'> {
+  url?: string
+  uri?: string
+  canUseCdn?: boolean
+  tag?: string
+}
+
+export interface ProgressEvent {
+  type: 'progress'
+  stage: 'upload' | 'download'
+  percent: number
+  total?: number
+  loaded?: number
+  lengthComputable: boolean
+}
+
+export interface ResponseEvent<T = unknown> {
+  type: 'response'
+  body: T
+  url: string
+  method: string
+  statusCode: number
+  statusMessage?: string
+  headers: Record<string, string>
+}
+
+export type HttpRequestEvent<T = unknown> = ResponseEvent<T> | ProgressEvent
+
+export interface AuthProvider {
+  name: string
+  title: string
+  url: string
+}
+
+export type AuthProviderResponse = {providers: AuthProvider[]}
+
+export type DatasetAclMode = 'public' | 'private' | 'custom'
+
+export type DatasetResponse = {datasetName: string; aclMode: DatasetAclMode}
+export type DatasetsResponse = {name: string; aclMode: DatasetAclMode}[]
+
+export interface SanityProjectMember {
+  id: string
+  role: string
+  isRobot: boolean
+  isCurrentUser: boolean
+}
+
+export interface SanityProject {
+  id: string
+  displayName: string
+  studioHost: string | null
+  organizationId: string | null
+  isBlocked: boolean
+  isDisabled: boolean
+  isDisabledByUser: boolean
+  createdAt: string
+  pendingInvites?: number
+  maxRetentionDays?: number
+  members: SanityProjectMember[]
+  metadata: {
+    color?: string
+    externalStudioHost?: string
+  }
+}
+
+export interface SanityUser {
+  id: string
+  projectId: string
+  displayName: string
+  familyName: string | null
+  givenName: string | null
+  middleName: string | null
+  imageUrl: string | null
+  createdAt: string
+  updatedAt: string
+  isCurrentUser: boolean
+}
+
+export interface CurrentSanityUser {
+  id: string
+  name: string
+  email: string
+  profileImage: string | null
+  role: string
+}
+
+export type SanityDocumentStub<T extends Record<string, any> = Record<string, any>> = {
+  [P in keyof T]: T[P]
+} & {
+  _type: string
+}
+
+export type IdentifiedSanityDocumentStub<T extends Record<string, any> = Record<string, any>> = {
+  [P in keyof T]: T[P]
+} & {
+  _id: string
+} & SanityDocumentStub
+
+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
+export interface PatchOperations {
+  set?: {[key: string]: any}
+  setIfMissing?: {[key: string]: any}
+  diffMatchPatch?: {[key: string]: any}
+  unset?: string[]
+  inc?: {[key: string]: number}
+  dec?: {[key: string]: number}
+  insert?: InsertPatch
+  ifRevisionID?: string
+}
+
+export type QueryParams = {[key: string]: any}
+export type MutationSelection = {query: string; params?: QueryParams} | {id: string | string[]}
+export type PatchSelection = string | string[] | MutationSelection
+export type PatchMutationOperation = PatchOperations & MutationSelection
+
+export type Mutation<R extends Record<string, any> = Record<string, any>> =
+  | {create: SanityDocumentStub<R>}
+  | {createOrReplace: IdentifiedSanityDocumentStub<R>}
+  | {createIfNotExists: IdentifiedSanityDocumentStub<R>}
+  | {delete: MutationSelection}
+  | {patch: PatchMutationOperation}
+
+export type MutationEvent<R extends Record<string, any> = Record<string, any>> = {
+  type: 'mutation'
+  documentId: string
+  eventId: string
+  identity: string
+  mutations: Mutation[]
+  previousRev?: string
+  resultRev?: string
+  result?: SanityDocument<R>
+  previous?: SanityDocument<R> | null
+  effects?: {apply: unknown[]; revert: unknown[]}
+  timestamp: string
+  transactionId: string
+  transition: 'update' | 'appear' | 'disappear'
+  visibility: 'query' | 'transaction'
+}
+
+export type ChannelErrorEvent = {
+  type: 'channelError'
+  message: string
+}
+
+export type DisconnectEvent = {
+  type: 'disconnect'
+  reason: string
+}
+
+export type ReconnectEvent = {
+  type: 'reconnect'
+}
+
+export type WelcomeEvent = {
+  type: 'welcome'
+}
+
+export type ListenEvent<R extends Record<string, any>> =
+  | MutationEvent<R>
+  | ChannelErrorEvent
+  | DisconnectEvent
+  | ReconnectEvent
+  | WelcomeEvent
+
+export type ListenEventName = 'mutation' | 'welcome' | 'reconnect'
+
+export interface ListenOptions {
+  includeResult?: boolean
+  includePreviousRevision?: boolean
+  visibility?: 'sync' | 'async' | 'query'
+  events?: ListenEventName[]
+  effectFormat?: 'mendoza'
+  tag?: string
+}
+
+export type FilteredResponseQueryOptions = RequestOptions & {
+  filterResponse?: true
+}
+
+export type UnfilteredResponseQueryOptions = RequestOptions & {
+  filterResponse: false
+}
+
+export interface RawQueryResponse<R> {
+  q: string
+  ms: number
+  result: R
+}
+
+export type BaseMutationOptions = RequestOptions & {
+  visibility?: 'sync' | 'async' | 'deferred'
+  returnDocuments?: boolean
+  returnFirst?: boolean
+  dryRun?: boolean
+  autoGenerateArrayKeys?: boolean
+  skipCrossDatasetReferenceValidation?: boolean
+}
+
+export type FirstDocumentMutationOptions = BaseMutationOptions & {
+  returnFirst?: true
+  returnDocuments?: true
+}
+
+export type FirstDocumentIdMutationOptions = BaseMutationOptions & {
+  returnFirst?: true
+  returnDocuments: false
+}
+
+export type AllDocumentsMutationOptions = BaseMutationOptions & {
+  returnFirst: false
+  returnDocuments?: true
+}
+
+export type MutationOperation = 'create' | 'delete' | 'update' | 'none'
+
+export interface SingleMutationResult {
+  transactionId: string
+  documentId: string
+  results: {id: string; operation: MutationOperation}[]
+}
+
+export interface MultipleMutationResult {
+  transactionId: string
+  documentIds: string[]
+  results: {id: string; operation: MutationOperation}[]
+}
+
+export type AllDocumentIdsMutationOptions = BaseMutationOptions & {
+  returnFirst: false
+  returnDocuments: false
+}
+
+export type AttributeSet = {[key: string]: any}
+
+export type TransactionFirstDocumentMutationOptions = BaseMutationOptions & {
+  returnFirst: true
+  returnDocuments: true
+}
+
+export type TransactionFirstDocumentIdMutationOptions = BaseMutationOptions & {
+  returnFirst: true
+  returnDocuments?: false
+}
+
+export type TransactionAllDocumentsMutationOptions = BaseMutationOptions & {
+  returnFirst?: false
+  returnDocuments: true
+}
+
+export type TransactionAllDocumentIdsMutationOptions = BaseMutationOptions & {
+  returnFirst?: false
+  returnDocuments?: false
+}
+
+export type TransactionMutationOptions =
+  | TransactionFirstDocumentMutationOptions
+  | TransactionFirstDocumentIdMutationOptions
+  | TransactionAllDocumentsMutationOptions
+  | TransactionAllDocumentIdsMutationOptions
+
+export interface RawRequestOptions {
+  url?: string
+  uri?: string
+  method?: string
+  token?: string
+  json?: boolean
+  tag?: string
+  useGlobalApi?: boolean
+  withCredentials?: boolean
+  query?: {[key: string]: string | string[]}
+  headers?: {[key: string]: string}
+  timeout?: number
+  proxy?: string
+  body?: any
+  maxRedirects?: number
+}

package/src/users/UsersClient.ts

@@ -0,0 +1,46 @@
+import {type Observable} from 'rxjs'
+
+import type {ObservableSanityClient, SanityClient} from '../SanityClient'
+import type {CurrentSanityUser, SanityUser} from '../types'
+
+export class BaseUsersClient {
+  client: SanityClient | ObservableSanityClient
+
+  /**
+   * 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>(
+    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}`})
+  }
+}
+
+export class ObservableUsersClient extends BaseUsersClient {
+  client: ObservableSanityClient
+
+  constructor(client: ObservableSanityClient) {
+    super()
+    this.client = client
+  }
+}
+
+export class UsersClient extends BaseUsersClient {
+  client: SanityClient
+  constructor(client: SanityClient) {
+    super()
+    this.client = client
+  }
+}

package/src/util/defaults.ts

@@ -0,0 +1,8 @@
+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 any)

package/src/util/getSelection.ts

@@ -0,0 +1,21 @@
+import type {MutationSelection} from '../types'
+
+export default function getSelection(sel: unknown): MutationSelection {
+  if (typeof sel === 'string' || Array.isArray(sel)) {
+    return {id: sel}
+  }
+
+  if (typeof sel === 'object' && sel !== null && 'query' in sel && typeof sel.query === 'string') {
+    return 'params' in sel && typeof sel.params === 'object' && sel.params !== null
+      ? {query: sel.query, params: sel.params}
+      : {query: sel.query}
+  }
+
+  const selectionOpts = [
+    '* Document ID (<docId>)',
+    '* Array of document IDs',
+    '* Object containing `query`',
+  ].join('\n')
+
+  throw new Error(`Unknown selection - must be one of:\n\n${selectionOpts}`)
+}

package/src/util/once.ts

@@ -0,0 +1,12 @@
+export default (fn: any) => {
+  let didCall = false
+  let returnValue: any
+  return (...args: any[]) => {
+    if (didCall) {
+      return returnValue
+    }
+    returnValue = fn(...args)
+    didCall = true
+    return returnValue
+  }
+}

package/src/util/pick.ts

@@ -0,0 +1,9 @@
+export default (obj: any, props: any) =>
+  props.reduce((selection: any, prop: any) => {
+    if (typeof obj[prop] === 'undefined') {
+      return selection
+    }
+
+    selection[prop] = obj[prop]
+    return selection
+  }, {})