@sanity/assist 1.2.12 → 1.2.14

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/assist",
-  "version": "1.2.12",
+  "version": "1.2.14",
   "description": "",
   "keywords": [
     "sanity",
@@ -64,18 +64,18 @@
     "rxjs-exhaustmap-with-trailing": "^2.1.1"
   },
   "devDependencies": {
-    "@commitlint/cli": "^17.7.2",
-    "@commitlint/config-conventional": "^17.7.0",
+    "@commitlint/cli": "^17.8.1",
+    "@commitlint/config-conventional": "^17.8.1",
     "@rollup/plugin-image": "^3.0.3",
     "@sanity/pkg-utils": "^2.4.10",
     "@sanity/plugin-kit": "^3.1.10",
-    "@sanity/semantic-release-preset": "^4.1.4",
-    "@types/react": "^18.2.27",
-    "@types/styled-components": "^5.1.28",
+    "@sanity/semantic-release-preset": "^4.1.6",
+    "@types/react": "^18.2.37",
+    "@types/styled-components": "^5.1.30",
     "@typescript-eslint/eslint-plugin": "^5.62.0",
     "@typescript-eslint/parser": "^5.62.0",
     "date-fns": "^2.30.0",
-    "eslint": "^8.51.0",
+    "eslint": "^8.53.0",
     "eslint-config-prettier": "^8.10.0",
     "eslint-config-sanity": "^6.0.0",
     "eslint-plugin-prettier": "^4.2.1",
@@ -85,7 +85,7 @@
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "rimraf": "^4.4.0",
-    "sanity": "^3.17.0",
+    "sanity": "^3.19.3",
     "semantic-release": "^21.1.2",
     "styled-components": "^5.3.11",
     "typescript": "^5.2.2",

package/src/plugin.tsx

@@ -45,8 +45,12 @@ export const assist = definePlugin<AssistPluginConfig | void>((config) => {
         }
         return prev
       },
-      unstable_fieldActions: (prev) => {
-        return [...prev, assistFieldActions]
+      unstable_fieldActions: (prev, {documentType, schema}) => {
+        const docSchema = schema.get(documentType)
+        if (docSchema && isSchemaAssistEnabled(docSchema)) {
+          return [...prev, assistFieldActions]
+        }
+        return prev
       },
       unstable_languageFilter: (prev, {documentId, schema, schemaType}) => {
         const docSchema = schema.get(schemaType)

package/src/schemas/index.ts

@@ -1,3 +1,4 @@
+/* eslint-disable camelcase */
 import {
   assistDocumentSchema,
   documentInstructionStatus,
@@ -10,16 +11,54 @@ import {
   userInput,
 } from './assistDocumentSchema'
 import {contextDocumentSchema} from './contextDocumentSchema'
+import {FieldProps, SchemaTypeDefinition, ArrayOfType} from 'sanity'
 
-export const schemaTypes = [
+function excludeComments<T extends SchemaTypeDefinition | ArrayOfType>(type: T): T {
+  const existingRender = (type as any)?.components?.field
+  return {
+    ...type,
+    ...('components' in type
+      ? {
+          components: {
+            ...type.components,
+            field: (props: FieldProps) => {
+              const newProps = {...props, ...{__internal_comments: undefined}}
+              if (typeof existingRender === 'function') {
+                return existingRender(newProps)
+              }
+              return props.renderDefault(newProps)
+            },
+          },
+        }
+      : {}),
+    ...('fields' in type
+      ? {
+          // recursively disable comments in fields
+          fields: type.fields?.map((field) => excludeComments(field)),
+        }
+      : {}),
+    ...('of' in type
+      ? {
+          // recursively disable comments in array items
+          of: type.of?.map((arrayItemType) => excludeComments(arrayItemType)),
+        }
+      : {}),
+  }
+}
+
+const instructionForm = [
   fieldInstructions,
-  assistDocumentSchema,
-  prompt,
-  fieldReference,
   instruction,
+  fieldReference,
+  prompt,
+  userInput,
+  promptContext,
+].map(excludeComments)
+
+export const schemaTypes = [
+  ...instructionForm,
+  assistDocumentSchema,
   documentInstructionStatus,
   instructionTask,
   contextDocumentSchema,
-  userInput,
-  promptContext,
 ]

package/src/schemas/serialize/serializeSchema.test.ts

@@ -23,7 +23,7 @@ const mockStudioTypes = [
 ]
 
 describe('serializeSchema', () => {
-  test('should not serialize excluded document schema', () => {
+  test('should serialize excluded document schema to support exclude: false overrides at the field level', () => {
     const schema = Schema.compile({
       name: 'test',
       types: [
@@ -42,7 +42,20 @@ describe('serializeSchema', () => {
 
     const serializedTypes = serializeSchema(schema, {leanFormat: true})
 
-    expect(serializedTypes).toEqual([])
+    expect(serializedTypes).toEqual([
+      {
+        fields: [
+          {
+            name: 'title',
+            title: 'Title',
+            type: 'string',
+          },
+        ],
+        name: 'article',
+        title: 'Article',
+        type: 'document',
+      },
+    ])
   })
 
   test('should serialize simple schema', () => {

package/src/schemas/serialize/serializeSchema.ts

@@ -29,7 +29,8 @@ export function serializeSchema(schema: Schema, options?: Options): SerializedSc
     .filter((t) => !(hiddenTypes.includes(t) || t.startsWith('sanity.')))
     .map((t) => schema.get(t))
     .filter((t): t is SchemaType => !!t)
-    .filter((t) => isAssistSupported(t))
+    // because a field can override exclude at the type level, we have to also serialize excluded types
+    // so don't do this: .filter((t) => isAssistSupported(t))
     .filter((t) => !t.hidden && !t.readOnly)
     .map((t) => getSchemaStub(t, schema, options))
     .filter((t) => {