@sanity/sdk 0.0.0-alpha.1

package/dist/index.d.ts

@@ -0,0 +1,339 @@
+import {ClientConfig} from '@sanity/client'
+import {InternalStores} from '../instance/types'
+import {SanityClient} from '@sanity/client'
+import {SanityInstance} from '../instance/types'
+import type {SanityInstance as SanityInstance_2} from './types'
+import {SdkIdentity} from '../instance/types'
+import type {StoreApi} from 'zustand'
+import {Subscribable} from 'rxjs'
+
+/**
+ * Configuration options for creating an auth store.
+ *
+ * @public
+ */
+export declare interface AuthConfig {
+  /**
+   * The initial location href to use when handling auth callbacks.
+   * Defaults to the current window location if available.
+   */
+  initialLocationHref?: string
+  /**
+   * Factory function to create a SanityClient instance.
+   * Defaults to the standard Sanity client factory if not provided.
+   */
+  clientFactory?: (config: ClientConfig) => SanityClient
+  /**
+   * Custom authentication providers to use instead of or in addition to the default ones.
+   * Can be an array of providers or a function that takes the default providers and returns
+   * a modified array or a Promise resolving to one.
+   */
+  providers?: AuthProvider[] | ((prev: AuthProvider[]) => AuthProvider[] | Promise<AuthProvider[]>)
+  /**
+   * The API hostname for requests. Usually leave this undefined, but it can be set
+   * if using a custom domain or CNAME for the API endpoint.
+   */
+  apiHost?: string
+  /**
+   * Storage implementation to persist authentication state.
+   * Defaults to `localStorage` if available.
+   */
+  storageArea?: Storage
+  /**
+   * A callback URL for your application.
+   * If none is provided, the auth API will redirect back to the current location (`location.href`).
+   * When handling callbacks, this URL's pathname is checked to ensure it matches the callback.
+   */
+  callbackUrl?: string
+  /**
+   * A static authentication token to use instead of handling the OAuth flow.
+   * When provided, the auth store will remain in a logged-in state with this token,
+   * ignoring any storage or callback handling.
+   */
+  token?: string
+  /**
+   * The authentication scope.
+   * If set to 'project', requests are scoped to the project-level.
+   * If set to 'org', requests are scoped to the organization-level.
+   * Defaults to 'project'.
+   */
+  authScope?: 'project' | 'org'
+}
+
+/**
+ * Configuration for an authentication provider
+ * @public
+ */
+export declare interface AuthProvider {
+  /**
+   * Unique identifier for the auth provider (e.g., 'google', 'github')
+   */
+  name: string
+  /**
+   * Display name for the auth provider in the UI
+   */
+  title: string
+  /**
+   * Complete authentication URL including callback and token parameters
+   */
+  url: string
+  /**
+   * Optional URL for direct sign-up flow
+   */
+  signUpUrl?: string
+}
+
+/**
+ * Represents the various states the authentication store can be in.
+ *
+ * @public
+ */
+export declare type AuthState =
+  | {
+      type: 'logged-in'
+      token: string
+      currentUser: CurrentUser | null
+    }
+  | {
+      type: 'logging-in'
+      isExchangingToken: boolean
+    }
+  | {
+      type: 'error'
+      error: unknown
+    }
+  | {
+      type: 'logged-out'
+      isDestroyingSession: boolean
+    }
+
+/**
+ * Public interface for the auth store.
+ * @public
+ */
+export declare interface AuthStateSlice {
+  getState: () => AuthState
+  getInitialState: () => AuthState
+  subscribe: (listener: (state: AuthState, prevState: AuthState) => void) => () => void
+}
+
+/**
+ * @public
+ */
+export declare interface AuthStore {
+  authState: AuthStateSlice
+  tokenState: PublicTokenSlice
+  currentUserState: CurrentUserSlice
+  handleCallback: (locationHref?: string) => Promise<string | false>
+  logout: () => Promise<void>
+  dispose: () => void
+  getLoginUrls: () => AuthProvider[] | Promise<AuthProvider[]>
+}
+
+/**
+ * Options used when retrieving a client via getOrCreateClient.
+ * @public
+ */
+export declare interface ClientOptions {
+  apiVersion?: string
+}
+
+/**
+ * Internal state of the client store.
+ * @internal
+ */
+export declare interface ClientState {
+  defaultClient: SanityClient
+  clients: Map<string, SanityClient>
+}
+
+/**
+ * Collection of actions to retrieve or create clients.
+ * @internal
+ */
+export declare interface ClientStore {
+  getOrCreateClient: (options: ClientOptions) => SanityClient
+  receiveToken: (token: string | undefined) => void
+  getClientEvents: (options: ClientOptions) => Subscribable<SanityClient>
+}
+
+/**
+ * Creates a `DocumentListStore` from a `SanityInstance`.
+ *
+ * @public
+ *
+ * See {@link SanityInstance} and {@link DocumentListStore}
+ */
+export declare function createDocumentListStore(instance: SanityInstance): DocumentListStore
+
+/**
+ * Returns a new instance of dependencies required for SanitySDK.
+ *
+ * @public
+ *
+ * @param config - The configuration for this instance
+ *
+ * @returns A new "instance" of a Sanity SDK, used to bind resources/configuration to it
+ */
+export declare function createSanityInstance({
+  projectId,
+  dataset,
+  ...config
+}: SanityConfig): SanityInstance_2
+
+/** @public */
+export declare interface CurrentUser {
+  id: string
+  name: string
+  email: string
+  profileImage?: string
+  provider?: string
+  /** @deprecated use `roles` instead */
+  role: string
+  roles: Role[]
+}
+
+/**
+ * Public interface for the auth store slice that contains the current user.
+ *
+ * @public
+ */
+export declare interface CurrentUserSlice {
+  getState: () => CurrentUser | null
+  getInitialState: () => CurrentUser | null
+  subscribe: (
+    listener: (user: CurrentUser | null, prevUser: CurrentUser | null) => void,
+  ) => () => void
+}
+
+/**
+ * Represents an identifier to a Sanity document, containing its `_id` to pull
+ * the document from content lake and its `_type` to look up its schema type.
+ * @public
+ */
+export declare interface DocumentHandle {
+  _id: string
+  _type: string
+}
+
+/**
+ * Configuration options for filtering and sorting documents in a document list.
+ * @public
+ */
+export declare interface DocumentListOptions {
+  /** GROQ filter expression to query specific documents */
+  filter?: string
+  /** Array of sort ordering specifications to determine the order of results */
+  sort?: SortOrderingItem[]
+}
+
+/**
+ * Represents the current state of a document list, including the query options
+ * and loading status.
+ * @public
+ */
+export declare interface DocumentListState extends DocumentListOptions {
+  /** Array of document handles in the current result set, or null if not yet loaded */
+  result: DocumentHandle[] | null
+  /** Indicates whether the document list is currently loading */
+  isPending: boolean
+}
+
+/**
+ * Manages the state and operations for a list of Sanity documents.
+ * Provides methods to update options, load more documents, and subscribe to
+ * state changes.
+ *
+ * Implements a subscription model where you can register callback functions
+ * to be notified when the document list state changes.
+ * @public
+ */
+export declare interface DocumentListStore extends Subscribable<DocumentListState> {
+  /** Updates the filtering and sorting options for the document list */
+  setOptions: (options: DocumentListOptions) => void
+  /** Retrieves the current state of the document list synchronously */
+  getCurrent: () => DocumentListState
+  /** Loads the next page of documents */
+  loadMore: () => void
+  /** Cleans up resources and subscriptions when the store is no longer needed */
+  dispose: () => void
+}
+
+/**
+ * Retrieves or creates an `AuthStore` for the given `SanityInstance`.
+ *
+ * @param instance - The `SanityInstance` to get or create the `AuthStore` for.
+ * @returns The `AuthStore` associated with the given `SanityInstance`.
+ *
+ * @public
+ */
+export declare const getAuthStore: (instance: SanityInstance) => AuthStore
+
+/**
+ * Retrieve a memoized client based on the apiVersion.
+ * @public
+ */
+export declare const getClient: (options: ClientOptions, instance: SanityInstance) => SanityClient
+
+/**
+ * Creates a subscribable client based on the apiVersion.
+ * The client will update when the underlying store changes (e.g., on user authentication changes).
+ * @public
+ */
+export declare const getSubscribableClient: (
+  options: ClientOptions,
+  instance: SanityInstance,
+) => Subscribable<SanityClient>
+
+export {InternalStores}
+
+/**
+ * Public interface for the token store.
+ *
+ * @public
+ */
+export declare interface PublicTokenSlice {
+  getState: () => string | null
+  getInitialState: () => string | null
+  subscribe: (listener: (token: string | null, prevToken: string | null) => void) => () => void
+}
+
+/** @public */
+export declare interface Role {
+  name: string
+  title: string
+  description?: string
+}
+
+/**
+ * @public
+ */
+export declare interface SanityConfig {
+  projectId: string
+  dataset: string
+  auth?: AuthConfig
+}
+
+export {SanityInstance}
+
+/** @public */
+export declare interface SchemaState {
+  schema: any
+  setSchema: (newSchema: any) => void
+}
+
+/** @public */
+export declare type SchemaStore = StoreApi<SchemaState>
+
+export {SdkIdentity}
+
+/**
+ * Represents a sort ordering configuration.
+ * @public
+ */
+export declare interface SortOrderingItem {
+  field: string
+  direction: 'asc' | 'desc'
+}
+
+export {}