chore: change @beta tags to @public (#514)

Author: colepeters

packages/react/src/hooks/document/useApplyDocumentActions.ts

@@ -12,7 +12,7 @@ import {createCallbackHook} from '../helpers/createCallbackHook'
 import type {useEditDocument} from './useEditDocument'
 
 /**
- * @beta
+ * @public
  */
 interface UseApplyDocumentActions {
   (): <
@@ -28,7 +28,7 @@ interface UseApplyDocumentActions {
 }
 
 /**
- * @beta
+ * @public
  *
  * Provides a stable callback function for applying one or more document actions.
  *

packages/react/src/hooks/document/useDocument.ts

@@ -57,7 +57,7 @@ interface UseDocument {
   /**
    * ## useDocument via Type Inference (Recommended)
    *
-   * @beta
+   * @public
    *
    * The preferred way to use this hook when working with Sanity Typegen.
    *
@@ -132,7 +132,7 @@ interface UseDocument {
     : {data: SanityDocumentResult<TDocumentType, TDataset, TProjectId> | null}
 
   /**
-   * @beta
+   * @public
    *
    * ## useDocument via Explicit Types
    *
@@ -202,7 +202,7 @@ interface UseDocument {
 }
 
 /**
- * @beta
+ * @public
  * Reads and subscribes to a document's realtime state, incorporating both local and remote changes.
  *
  * This hook comes in two main flavors to suit your needs:

packages/react/src/hooks/document/useDocumentEvent.ts

@@ -4,7 +4,7 @@ import {useCallback, useEffect, useInsertionEffect, useRef} from 'react'
 import {useSanityInstance} from '../context/useSanityInstance'
 
 /**
- * @beta
+ * @public
  */
 export interface UseDocumentEventOptions<
   TDataset extends string = string,
@@ -15,7 +15,7 @@ export interface UseDocumentEventOptions<
 
 /**
  *
- * @beta
+ * @public
  *
  * Subscribes an event handler to events in your application's document store.
  *

packages/react/src/hooks/document/useDocumentSyncStatus.ts

@@ -46,7 +46,7 @@ type UseDocumentSyncStatus = {
 }
 
 /**
- * @beta
+ * @public
  * @function
  */
 export const useDocumentSyncStatus: UseDocumentSyncStatus = createStateSourceHook({

packages/react/src/hooks/document/useEditDocument.ts

@@ -18,7 +18,7 @@ type Updater<TValue> = TValue | ((currentValue: TValue) => TValue)
 
 // Overload 1: No path, relies on Typegen
 /**
- * @beta
+ * @public
  * Edit an entire document, relying on Typegen for the type.
  *
  * @param options - Document options including `documentId`, `documentType`, and optionally `projectId`/`dataset`.
@@ -37,7 +37,7 @@ export function useEditDocument<
 
 // Overload 2: Path provided, relies on Typegen
 /**
- * @beta
+ * @public
  * Edit a specific path within a document, relying on Typegen for the type.
  *
  * @param options - Document options including `documentId`, `documentType`, `path`, and optionally `projectId`/`dataset`.
@@ -57,7 +57,7 @@ export function useEditDocument<
 
 // Overload 3: Explicit type, no path
 /**
- * @beta
+ * @public
  * Edit an entire document with an explicit type `TData`.
  *
  * @param options - Document options including `documentId` and optionally `projectId`/`dataset`.
@@ -70,7 +70,7 @@ export function useEditDocument<TData>(
 
 // Overload 4: Explicit type, path provided
 /**
- * @beta
+ * @public
  * Edit a specific path within a document with an explicit type `TData`.
  *
  * @param options - Document options including `documentId`, `path`, and optionally `projectId`/`dataset`.
@@ -82,7 +82,7 @@ export function useEditDocument<TData>(
 ): (nextValue: Updater<TData>) => Promise<ActionsResult>
 
 /**
- * @beta
+ * @public
  * Provides a stable function to apply edits to a document or a specific path within it.
  *
  * @category Documents

packages/react/src/hooks/documents/useDocuments.ts

@@ -16,7 +16,7 @@ const DEFAULT_BATCH_SIZE = 25
 /**
  * Configuration options for the useDocuments hook
  *
- * @beta
+ * @public
  * @category Types
  */
 export interface DocumentsOptions<
@@ -50,7 +50,7 @@ export interface DocumentsOptions<
 /**
  * Return value from the useDocuments hook
  *
- * @beta
+ * @public
  * @category Types
  */
 export interface DocumentsResponse<
@@ -85,7 +85,7 @@ export interface DocumentsResponse<
  * with infinite scrolling support. The number of document handles returned per batch is customizable,
  * and additional batches can be loaded using the supplied `loadMore` function.
  *
- * @beta
+ * @public
  * @category Documents
  * @param options - Configuration options for the infinite list
  * @returns An object containing the list of document handles, the loading state, the total count of retrieved document handles, and a function to load more

packages/react/src/hooks/paginatedDocuments/usePaginatedDocuments.ts

@@ -9,7 +9,7 @@ import {useQuery} from '../query/useQuery'
 /**
  * Configuration options for the usePaginatedDocuments hook
  *
- * @beta
+ * @public
  * @category Types
  */
 export interface PaginatedDocumentsOptions<
@@ -39,7 +39,7 @@ export interface PaginatedDocumentsOptions<
 /**
  * Return value from the usePaginatedDocuments hook
  *
- * @beta
+ * @public
  * @category Types
  */
 export interface PaginatedDocumentsResponse<
@@ -130,7 +130,7 @@ export interface PaginatedDocumentsResponse<
  * with support for traditional paginated interfaces. The number of document handles returned per page is customizable,
  * while page navigation is handled via the included navigation functions.
  *
- * @beta
+ * @public
  * @category Documents
  * @param options - Configuration options for the paginated list
  * @returns An object containing the list of document handles, pagination details, and functions to navigate between pages

packages/react/src/hooks/preview/useDocumentPreview.tsx

@@ -5,7 +5,7 @@ import {distinctUntilChanged, EMPTY, Observable, startWith, switchMap} from 'rxj
 import {useSanityInstance} from '../context/useSanityInstance'
 
 /**
- * @beta
+ * @public
  * @category Types
  */
 export interface useDocumentPreviewOptions extends DocumentHandle {
@@ -17,7 +17,7 @@ export interface useDocumentPreviewOptions extends DocumentHandle {
 }
 
 /**
- * @beta
+ * @public
  * @category Types
  */
 export interface useDocumentPreviewResults {
@@ -28,7 +28,7 @@ export interface useDocumentPreviewResults {
 }
 
 /**
- * @beta
+ * @public
  *
  * Returns the preview values of a document (specified via a `DocumentHandle`),
  * including the document’s `title`, `subtitle`, `media`, and `status`. These values are live and will update in realtime.

packages/react/src/hooks/projection/useDocumentProjection.ts

@@ -59,7 +59,7 @@ export interface useDocumentProjectionResults<TData> {
 
 // Overload 1: Relies on Typegen
 /**
- * @beta
+ * @public
  * Fetch a projection, relying on Typegen for the return type based on the handle and projection.
  *
  * @category Documents
@@ -127,7 +127,7 @@ export function useDocumentProjection<
 
 // Overload 2: Explicit type provided
 /**
- * @beta
+ * @public
  * Fetch a projection with an explicitly defined return type `TData`.
  *
  * @param options - Options including the document handle properties (`documentId`, etc.) and the `projection`.

packages/react/src/hooks/query/useQuery.ts

@@ -12,7 +12,7 @@ import {useSanityInstance} from '../context/useSanityInstance'
 
 // Overload 1: Inferred Type (using Typegen)
 /**
- * @beta
+ * @public
  * Executes a GROQ query, inferring the result type from the query string and options.
  * Leverages Sanity Typegen if configured for enhanced type safety.
  *
@@ -81,7 +81,7 @@ export function useQuery<
 
 // Overload 2: Explicit Type Provided
 /**
- * @beta
+ * @public
  * Executes a GROQ query with an explicitly provided result type `TData`.
  *
  * @param options - Configuration for the query, including `query`, optional `params`, `projectId`, `dataset`, etc.
@@ -116,7 +116,7 @@ export function useQuery<TData>(options: QueryOptions): {
 }
 
 /**
- * @beta
+ * @public
  * Fetches data and subscribes to real-time updates using a GROQ query.
  *
  * @remarks