From cdaf482544c831864fd10540e8e8efd3f63880ac Mon Sep 17 00:00:00 2001 From: RitaDias Date: Wed, 11 Sep 2024 10:55:18 +0200 Subject: [PATCH] docs(@sanity): remove @beta tags from migrate --- packages/@sanity/migrate/src/mutations/creators.ts | 6 ------ .../migrate/src/mutations/operations/creators.ts | 11 ----------- 2 files changed, 17 deletions(-) diff --git a/packages/@sanity/migrate/src/mutations/creators.ts b/packages/@sanity/migrate/src/mutations/creators.ts index 56d9552a167..e02d6495d8a 100644 --- a/packages/@sanity/migrate/src/mutations/creators.ts +++ b/packages/@sanity/migrate/src/mutations/creators.ts @@ -20,7 +20,6 @@ import {type NormalizeReadOnlyArray, type Optional, type Tuplify} from './typeUt * Creates a new document. * @param document - The document to be created. * @returns The mutation to create the document. - * @beta */ export function create>( document: Doc, @@ -34,7 +33,6 @@ export function create>( * @param patches - The patches to be applied. * @param options - Optional patch options. * @returns The mutation to patch the document. - * @beta */ export function patch

( id: string, @@ -54,7 +52,6 @@ export function patch

( * @param path - The path where the operation should be applied. * @param operation - The operation to be applied. * @returns The node patch. - * @beta */ export function at(path: Path | string, operation: O): NodePatch { return { @@ -67,7 +64,6 @@ export function at(path: Path | string, operation: O): Node * Creates a document if it does not exist. * @param document - The document to be created. * @returns The mutation operation to create the document if it does not exist. - * @beta */ export function createIfNotExists( document: Doc, @@ -79,7 +75,6 @@ export function createIfNotExists( * Creates or replaces a document. * @param document - The document to be created or replaced. * @returns The mutation operation to create or replace the document. - * @beta */ export function createOrReplace( document: Doc, @@ -91,7 +86,6 @@ export function createOrReplace( * Deletes a document. * @param id - The id of the document to be deleted. * @returns The mutation operation to delete the document. - * @beta */ export function delete_(id: string): DeleteMutation { return {type: 'delete', id} diff --git a/packages/@sanity/migrate/src/mutations/operations/creators.ts b/packages/@sanity/migrate/src/mutations/operations/creators.ts index c56a6ac9433..729112d7b1a 100644 --- a/packages/@sanity/migrate/src/mutations/operations/creators.ts +++ b/packages/@sanity/migrate/src/mutations/operations/creators.ts @@ -21,7 +21,6 @@ import { * @param value - The value to set. * @returns A `set` operation. * {@link https://www.sanity.io/docs/http-patches#6TPENSW3} - * @beta * * @example * ```ts @@ -36,7 +35,6 @@ export const set = (value: T): SetOp => ({type: 'set', value}) * @param value - The value to set if missing. * @returns A `setIfMissing` operation. * {@link https://www.sanity.io/docs/http-patches#A80781bT} - * @beta * @example * ```ts * const setFooIfMissing = setIfMissing('foo') @@ -52,7 +50,6 @@ export const setIfMissing = (value: T): SetIfMissingOp => ({ * Creates an `unset` operation. * @returns An `unset` operation. * {@link https://www.sanity.io/docs/http-patches#xRtBjp8o} - * @beta * * @example * ```ts @@ -66,7 +63,6 @@ export const unset = (): UnsetOp => ({type: 'unset'}) * @param amount - The amount to increment by. * @returns An incrementation operation for numeric values * {@link https://www.sanity.io/docs/http-patches#vIT8WWQo} - * @beta * * @example * ```ts @@ -84,7 +80,6 @@ export const inc = (amount: N = 1 as N): IncOp => * @param amount - The amount to decrement by. * @returns A `dec` operation. * {@link https://www.sanity.io/docs/http-patches#vIT8WWQo} - * @beta * * @example * ```ts @@ -116,7 +111,6 @@ export const diffMatchPatch = (value: string): DiffMatchPatchOp => ({ * @param indexOrReferenceItem - The index or reference item to insert before or after. * @returns An `insert` operation for adding values to arrays * {@link https://www.sanity.io/docs/http-patches#febxf6Fk} - * @beta * * @example * ```ts @@ -147,7 +141,6 @@ export function insert< * @param items - The items to append. * @returns An `insert` operation for adding a value to the end of an array. * {@link https://www.sanity.io/docs/http-patches#Cw4vhD88} - * @beta * * @example * ```ts @@ -165,7 +158,6 @@ export function append>(items: Items | Arr * @param items - The items to prepend. * @returns An `insert` operation for adding a value to the start of an array. * {@link https://www.sanity.io/docs/http-patches#refAUsf0} - * @beta * * @example * ```ts @@ -205,7 +197,6 @@ export function insertBefore< * @param indexOrReferenceItem - The index or reference item to insert after. * @returns An `insert` operation after the provided index or reference item. * {@link https://www.sanity.io/docs/http-patches#0SQmPlb6} - * @beta * * @example * ```ts @@ -230,7 +221,6 @@ export const insertAfter = < * @returns A `truncate` operation. * @remarks - This will be converted to an `unset` patch when submitted to the API * {@link https://www.sanity.io/docs/http-patches#xRtBjp8o} - * @beta * * @example * ```ts @@ -254,7 +244,6 @@ export function truncate(startIndex: number, endIndex?: number): TruncateOp { * @returns A ReplaceOp operation. * @remarks This will be converted to an `insert`/`replace` patch when submitted to the API * {@link https://www.sanity.io/docs/http-patches#GnVSwcPa} - * @beta * * @example * ```ts