chore(sanity): remove beta and unstable from comments and tasks (#6478)

* chore(sanity): remove beta and unstable from comments and tasks * chore(test-studio): remove unneeded config * chore(sanity): fix comment
sanity-io · Apr 30, 2024 · f92ba3e · f92ba3e
1 parent e618da3
commit f92ba3e
Show file tree

Hide file tree

Showing 8 changed files with 35 additions and 17 deletions.
diff --git a/dev/test-studio/sanity.config.ts b/dev/test-studio/sanity.config.ts
@@ -90,8 +90,7 @@ const sharedSettings = definePlugin({
       return prev
     },
     newDocumentOptions,
-
-    unstable_comments: {
+    comments: {
       enabled: true,
     },
     badges: (prev, context) => (context.schemaType === 'author' ? [CustomBadge, ...prev] : prev),
@@ -157,7 +156,7 @@ export default defineConfig([
       enabled: true,
       inputDateTimeFormat: 'MM/dd/yy h:mm a',
     },
-    unstable_tasks: {
+    tasks: {
       enabled: true,
     },
   },

diff --git a/packages/sanity/src/core/comments/hooks/useResolveCommentsEnabled.ts b/packages/sanity/src/core/comments/hooks/useResolveCommentsEnabled.ts
@@ -27,7 +27,7 @@ export function useResolveCommentsEnabled(
   // Check if the projects plan has the feature enabled
   const {enabled: featureEnabled, isLoading, error} = useFeatureEnabled('studioComments')
 
-  const {enabled} = useSource().document.unstable_comments
+  const {enabled} = useSource().document.comments
   // Check if the feature is enabled for the current document in the config
   const enabledFromConfig = useMemo(
     () => enabled({documentType, documentId: getPublishedId(documentId)}),

diff --git a/packages/sanity/src/core/comments/plugin/inspector/CommentsInspectorHeader.tsx b/packages/sanity/src/core/comments/plugin/inspector/CommentsInspectorHeader.tsx
@@ -4,7 +4,6 @@ import {forwardRef, useCallback} from 'react'
 import {styled} from 'styled-components'
 
 import {Button, MenuButton, MenuItem} from '../../../../ui-components'
-import {BetaBadge} from '../../../components'
 import {useTranslation} from '../../../i18n'
 import {commentsLocaleNamespace} from '../../i18n'
 import {type CommentStatus, type CommentsUIMode} from '../../types'
@@ -39,8 +38,6 @@ export const CommentsInspectorHeader = forwardRef(function CommentsInspectorHead
           <Text as="h1" size={1} weight="medium">
             {t('feature-name')}
           </Text>
-
-          <BetaBadge />
         </Flex>
 
         <Flex flex="none" padding={1} gap={2}>

diff --git a/packages/sanity/src/core/config/configPropertyReducers.ts b/packages/sanity/src/core/config/configPropertyReducers.ts
@@ -293,14 +293,15 @@ export const documentCommentsEnabledReducer = (opts: {
   // That is, if a plugin returns true, but the next plugin returns false, the result will be false.
   // The last plugin 'wins'.
   const result = flattenedConfig.reduce((acc, {config: innerConfig}) => {
-    const resolver = innerConfig.document?.unstable_comments?.enabled
+    const resolver =
+      innerConfig.document?.comments?.enabled ?? innerConfig.document?.unstable_comments?.enabled
 
     if (!resolver && typeof resolver !== 'boolean') return acc
     if (typeof resolver === 'function') return resolver(context)
     if (typeof resolver === 'boolean') return resolver
 
     throw new Error(
-      `Expected \`document.unstable_comments.enabled\` to be a boolean or a function, but received ${getPrintableType(
+      `Expected \`document.comments.enabled\` to be a boolean or a function, but received ${getPrintableType(
         resolver,
       )}`,
     )

diff --git a/packages/sanity/src/core/config/prepareConfig.ts b/packages/sanity/src/core/config/prepareConfig.ts
@@ -533,7 +533,7 @@ function resolveSource({
           propertyName: 'document.unstable_languageFilter',
           reducer: documentLanguageFilterReducer,
         }),
-
+      /** @todo this is deprecated so it will eventually be removed */
       unstable_comments: {
         enabled: (partialContext) => {
           return documentCommentsEnabledReducer({
@@ -543,6 +543,15 @@ function resolveSource({
           })
         },
       },
+      comments: {
+        enabled: (partialContext) => {
+          return documentCommentsEnabledReducer({
+            context: partialContext,
+            config,
+            initialValue: true,
+          })
+        },
+      },
     },
 
     form: {

diff --git a/packages/sanity/src/core/config/resolveDefaultPlugins.ts b/packages/sanity/src/core/config/resolveDefaultPlugins.ts
@@ -29,6 +29,7 @@ export function getDefaultPluginsOptions(
     tasks: {
       enabled: true,
       ...workspace.unstable_tasks,
+      ...workspace.tasks,
     },
     scheduledPublishing: {
       ...DEFAULT_SCHEDULED_PUBLISH_PLUGIN_OPTIONS,

diff --git a/packages/sanity/src/core/config/types.ts b/packages/sanity/src/core/config/types.ts
@@ -291,10 +291,15 @@ export interface DocumentPluginOptions {
    */
   newDocumentOptions?: NewDocumentOptionsResolver
 
-  /** @internal */
+  /** @deprecated Use `comments` instead */
   unstable_comments?: {
     enabled: boolean | ((context: DocumentCommentsEnabledContext) => boolean)
   }
+
+  /** @internal */
+  comments?: {
+    enabled: boolean | ((context: DocumentCommentsEnabledContext) => boolean)
+  }
 }
 
 /**
@@ -433,10 +438,13 @@ export interface WorkspaceOptions extends SourceOptions {
    */
   unstable_sources?: SourceOptions[]
   /**
-   * @hidden
-   * @beta
+   * @deprecated Use `tasks` instead
    */
   unstable_tasks?: DefaultPluginsWorkspaceOptions['tasks']
+  /**
+   * @internal
+   */
+  tasks?: DefaultPluginsWorkspaceOptions['tasks']
 
   /**
    * @hidden
@@ -654,10 +662,15 @@ export interface Source {
      */
     inspectors: (props: PartialContext<DocumentInspectorContext>) => DocumentInspector[]
 
-    /** @internal */
+    /** @deprecated  Use `comments` instead */
     unstable_comments: {
       enabled: (props: DocumentCommentsEnabledContext) => boolean
     }
+
+    /** @internal */
+    comments: {
+      enabled: (props: DocumentCommentsEnabledContext) => boolean
+    }
   }
 
   /** @internal */
@@ -756,7 +769,7 @@ export interface Source {
     i18next: i18n
   }
   /** @beta */
-  tasks?: WorkspaceOptions['unstable_tasks']
+  tasks?: WorkspaceOptions['tasks']
   /** @beta */
   serverActions?: WorkspaceOptions['unstable_serverActions']
 }

diff --git a/packages/sanity/src/core/tasks/components/sidebar/TasksSidebarHeader.tsx b/packages/sanity/src/core/tasks/components/sidebar/TasksSidebarHeader.tsx
@@ -10,7 +10,6 @@ import {
 import {useCallback} from 'react'
 
 import {Button} from '../../../../ui-components'
-import {BetaBadge} from '../../../components'
 import {useTranslation} from '../../../i18n'
 import {useTasksEnabled, useTasksNavigation} from '../../context'
 import {tasksLocaleNamespace} from '../../i18n'
@@ -65,7 +64,6 @@ export function TasksSidebarHeader(props: TasksSidebarHeaderProps) {
             </Box>
           </>
         )}
-        <BetaBadge marginLeft={2} />
       </Flex>
       {(viewMode === 'create' || viewMode === 'draft') && <TasksHeaderDraftsMenu />}
       {viewMode === 'edit' && <TasksActiveTabNavigation items={allItems} />}