@portabletext/editor 1.49.0 → 1.49.2

package/src/internal-utils/parse-blocks.test.ts

@@ -12,7 +12,7 @@ describe(parseBlock.name, () => {
           keyGenerator: createTestKeyGenerator(),
           schema: compileSchemaDefinition(defineSchema({})),
         },
-        options: {refreshKeys: false},
+        options: {refreshKeys: false, validateFields: true},
       }),
     ).toBe(undefined)
   })
@@ -25,7 +25,7 @@ describe(parseBlock.name, () => {
           keyGenerator: createTestKeyGenerator(),
           schema: compileSchemaDefinition(defineSchema({})),
         },
-        options: {refreshKeys: false},
+        options: {refreshKeys: false, validateFields: true},
       }),
     ).toBe(undefined)
   })
@@ -39,7 +39,7 @@ describe(parseBlock.name, () => {
             keyGenerator: createTestKeyGenerator(),
             schema: compileSchemaDefinition(defineSchema({})),
           },
-          options: {refreshKeys: false},
+          options: {refreshKeys: false, validateFields: true},
         }),
       ).toBe(undefined)
     })
@@ -54,7 +54,7 @@ describe(parseBlock.name, () => {
               defineSchema({blockObjects: [{name: 'image'}]}),
             ),
           },
-          options: {refreshKeys: false},
+          options: {refreshKeys: false, validateFields: true},
         }),
       ).toBe(undefined)
     })
@@ -69,7 +69,7 @@ describe(parseBlock.name, () => {
               defineSchema({blockObjects: [{name: 'image'}]}),
             ),
           },
-          options: {refreshKeys: false},
+          options: {refreshKeys: false, validateFields: true},
         }),
       ).toEqual({
         _key: 'k0',
@@ -87,7 +87,7 @@ describe(parseBlock.name, () => {
             keyGenerator: createTestKeyGenerator(),
             schema: compileSchemaDefinition(defineSchema({})),
           },
-          options: {refreshKeys: false},
+          options: {refreshKeys: false, validateFields: true},
         }),
       ).toEqual({
         _key: 'k0',
@@ -114,7 +114,7 @@ describe(parseBlock.name, () => {
             keyGenerator: createTestKeyGenerator(),
             schema: {...schema, block: {...schema.block, name: 'text'}},
           },
-          options: {refreshKeys: false},
+          options: {refreshKeys: false, validateFields: true},
         }),
       ).toEqual({
         _key: 'k0',
@@ -149,7 +149,7 @@ describe(parseBlock.name, () => {
             keyGenerator: createTestKeyGenerator(),
             schema: compileSchemaDefinition(defineSchema({})),
           },
-          options: {refreshKeys: false},
+          options: {refreshKeys: false, validateFields: true},
         }),
       ).toBe(undefined)
     })
@@ -188,7 +188,7 @@ describe(parseBlock.name, () => {
               }),
             ),
           },
-          options: {refreshKeys: false},
+          options: {refreshKeys: false, validateFields: true},
         }),
       ).toEqual({
         _key: 'k0',
@@ -238,7 +238,7 @@ describe(parseBlock.name, () => {
               defineSchema({lists: [{name: 'bullet'}]}),
             ),
           },
-          options: {refreshKeys: false},
+          options: {refreshKeys: false, validateFields: true},
         }),
       ).toEqual({
         _key: 'k0',
@@ -267,7 +267,7 @@ describe(parseBlock.name, () => {
               defineSchema({lists: [{name: 'bullet'}]}),
             ),
           },
-          options: {refreshKeys: false},
+          options: {refreshKeys: false, validateFields: true},
         }),
       ).toEqual({
         _key: 'k0',
@@ -297,7 +297,7 @@ describe(parseSpan.name, () => {
           schema: compileSchemaDefinition(defineSchema({})),
         },
         markDefKeyMap: new Map(),
-        options: {refreshKeys: false},
+        options: {refreshKeys: false, validateFields: true},
       }),
     ).toBe(undefined)
   })
@@ -311,7 +311,7 @@ describe(parseSpan.name, () => {
           schema: compileSchemaDefinition(defineSchema({})),
         },
         markDefKeyMap: new Map(),
-        options: {refreshKeys: false},
+        options: {refreshKeys: false, validateFields: true},
       }),
     ).toBe(undefined)
   })
@@ -325,7 +325,7 @@ describe(parseSpan.name, () => {
           schema: compileSchemaDefinition(defineSchema({})),
         },
         markDefKeyMap: new Map(),
-        options: {refreshKeys: false},
+        options: {refreshKeys: false, validateFields: true},
       }),
     ).toBe(undefined)
   })
@@ -339,7 +339,7 @@ describe(parseSpan.name, () => {
           schema: compileSchemaDefinition(defineSchema({})),
         },
         markDefKeyMap: new Map(),
-        options: {refreshKeys: false},
+        options: {refreshKeys: false, validateFields: true},
       }),
     ).toBe(undefined)
   })
@@ -353,7 +353,7 @@ describe(parseSpan.name, () => {
           schema: compileSchemaDefinition(defineSchema({})),
         },
         markDefKeyMap: new Map(),
-        options: {refreshKeys: false},
+        options: {refreshKeys: false, validateFields: true},
       }),
     ).toEqual({
       _key: 'k0',
@@ -372,7 +372,7 @@ describe(parseSpan.name, () => {
           schema: compileSchemaDefinition(defineSchema({})),
         },
         markDefKeyMap: new Map(),
-        options: {refreshKeys: false},
+        options: {refreshKeys: false, validateFields: true},
       }),
     ).toEqual({
       _key: 'k0',
@@ -394,7 +394,7 @@ describe(parseSpan.name, () => {
           schema: compileSchemaDefinition(defineSchema({})),
         },
         markDefKeyMap: new Map(),
-        options: {refreshKeys: false},
+        options: {refreshKeys: false, validateFields: true},
       }),
     ).toEqual({
       _key: 'k0',
@@ -418,7 +418,7 @@ describe(parseSpan.name, () => {
           ),
         },
         markDefKeyMap: new Map(),
-        options: {refreshKeys: false},
+        options: {refreshKeys: false, validateFields: true},
       }),
     ).toEqual({
       _key: 'k0',
@@ -442,7 +442,7 @@ describe(parseSpan.name, () => {
           ),
         },
         markDefKeyMap: new Map(),
-        options: {refreshKeys: false},
+        options: {refreshKeys: false, validateFields: true},
       }),
     ).toEqual({
       _key: 'k0',

package/src/internal-utils/parse-blocks.ts

@@ -19,6 +19,7 @@ export function parseBlocks({
   blocks: unknown
   options: {
     refreshKeys: boolean
+    validateFields: boolean
   }
 }): Array<PortableTextBlock> {
   if (!Array.isArray(blocks)) {
@@ -41,6 +42,7 @@ export function parseBlock({
   block: unknown
   options: {
     refreshKeys: boolean
+    validateFields: boolean
   }
 }): PortableTextBlock | undefined {
   return (
@@ -56,7 +58,7 @@ export function parseBlockObject({
 }: {
   blockObject: unknown
   context: Pick<EditorContext, 'keyGenerator' | 'schema'>
-  options: {refreshKeys: boolean}
+  options: {refreshKeys: boolean; validateFields: boolean}
 }): PortableTextObject | undefined {
   if (!isTypedObject(blockObject)) {
     return undefined
@@ -99,7 +101,7 @@ export function isTextBlock(
     parseTextBlock({
       block,
       context: {schema: context.schema, keyGenerator: () => ''},
-      options: {refreshKeys: false},
+      options: {refreshKeys: false, validateFields: false},
     }) !== undefined
   )
 }
@@ -111,12 +113,28 @@ export function parseTextBlock({
 }: {
   block: unknown
   context: Pick<EditorContext, 'keyGenerator' | 'schema'>
-  options: {refreshKeys: boolean}
+  options: {refreshKeys: boolean; validateFields: boolean}
 }): PortableTextTextBlock | undefined {
   if (!isTypedObject(block)) {
     return undefined
   }
 
+  const customFields: Record<string, unknown> = {}
+
+  for (const key of Object.keys(block)) {
+    if (
+      key !== '_type' &&
+      key !== '_key' &&
+      key !== 'children' &&
+      key !== 'markDefs' &&
+      key !== 'style' &&
+      key !== 'listItem' &&
+      key !== 'level'
+    ) {
+      customFields[key] = block[key]
+    }
+  }
+
   if (block._type !== context.schema.block.name) {
     return undefined
   }
@@ -195,6 +213,7 @@ export function parseTextBlock({
             },
           ],
     markDefs,
+    ...(options.validateFields ? {} : customFields),
   }
 
   if (
@@ -235,7 +254,7 @@ export function isSpan(
       span: child,
       markDefKeyMap: new Map(),
       context: {schema: context.schema, keyGenerator: () => ''},
-      options: {refreshKeys: false},
+      options: {refreshKeys: false, validateFields: false},
     }) !== undefined
   )
 }
@@ -249,12 +268,25 @@ export function parseSpan({
   span: unknown
   context: Pick<EditorContext, 'keyGenerator' | 'schema'>
   markDefKeyMap: Map<string, string>
-  options: {refreshKeys: boolean}
+  options: {refreshKeys: boolean; validateFields: boolean}
 }): PortableTextSpan | undefined {
   if (!isTypedObject(span)) {
     return undefined
   }
 
+  const customFields: Record<string, unknown> = {}
+
+  for (const key of Object.keys(span)) {
+    if (
+      key !== '_type' &&
+      key !== '_key' &&
+      key !== 'text' &&
+      key !== 'marks'
+    ) {
+      customFields[key] = span[key]
+    }
+  }
+
   // In reality, the span schema name is always 'span', but we only the check here anyway
   if (span._type !== context.schema.span.name || span._type !== 'span') {
     return undefined
@@ -292,6 +324,7 @@ export function parseSpan({
         : context.keyGenerator(),
     text: typeof span.text === 'string' ? span.text : '',
     marks,
+    ...(options.validateFields ? {} : customFields),
   }
 }
 
@@ -302,7 +335,7 @@ export function parseInlineObject({
 }: {
   inlineObject: unknown
   context: Pick<EditorContext, 'keyGenerator' | 'schema'>
-  options: {refreshKeys: boolean}
+  options: {refreshKeys: boolean; validateFields: boolean}
 }): PortableTextObject | undefined {
   if (!isTypedObject(inlineObject)) {
     return undefined
@@ -333,7 +366,7 @@ export function parseAnnotation({
 }: {
   annotation: TypedObject
   context: Pick<EditorContext, 'keyGenerator' | 'schema'>
-  options: {refreshKeys: boolean}
+  options: {refreshKeys: boolean; validateFields: boolean}
 }): PortableTextObject | undefined {
   if (!isTypedObject(annotation)) {
     return undefined
@@ -366,22 +399,26 @@ function parseObject({
   context: Pick<EditorContext, 'keyGenerator'> & {
     schemaType: EditorSchema['blockObjects'][0]
   }
-  options: {refreshKeys: boolean}
+  options: {refreshKeys: boolean; validateFields: boolean}
 }): PortableTextObject {
+  const {_type, _key, ...customFields} = object
+
   // Validates all props on the object and only takes those that match
   // the name of a field
-  const values = context.schemaType.fields.reduce<Record<string, unknown>>(
-    (fieldValues, field) => {
-      const fieldValue = object[field.name]
-
-      if (fieldValue !== undefined) {
-        fieldValues[field.name] = fieldValue
-      }
-
-      return fieldValues
-    },
-    {},
-  )
+  const values = options.validateFields
+    ? context.schemaType.fields.reduce<Record<string, unknown>>(
+        (fieldValues, field) => {
+          const fieldValue = object[field.name]
+
+          if (fieldValue !== undefined) {
+            fieldValues[field.name] = fieldValue
+          }
+
+          return fieldValues
+        },
+        {},
+      )
+    : customFields
 
   return {
     _type: context.schemaType.name,

package/src/operations/behavior.operation.annotation.add.ts

@@ -31,7 +31,7 @@ export const addAnnotationOperationImplementation: BehaviorOperationImplementati
       ...operation.annotation.value,
     },
     context,
-    options: {refreshKeys: false},
+    options: {refreshKeys: false, validateFields: true},
   })
 
   if (!parsedAnnotation) {

package/src/operations/behavior.operation.block.set.ts

@@ -47,7 +47,7 @@ export const blockSetOperationImplementation: BehaviorOperationImplementation<
       ...parsedBlock,
       ...filteredProps,
     },
-    options: {refreshKeys: false},
+    options: {refreshKeys: false, validateFields: true},
   })
 
   if (!updatedBlock) {

package/src/operations/behavior.operation.block.unset.ts

@@ -46,7 +46,7 @@ export const blockUnsetOperationImplementation: BehaviorOperationImplementation<
     const updatedTextBlock = parseBlock({
       context,
       block: omit(parsedBlock, propsToRemove),
-      options: {refreshKeys: false},
+      options: {refreshKeys: false, validateFields: true},
     })
 
     if (!updatedTextBlock) {
@@ -76,7 +76,7 @@ export const blockUnsetOperationImplementation: BehaviorOperationImplementation<
       parsedBlock,
       operation.props.filter((prop) => prop !== '_type'),
     ),
-    options: {refreshKeys: false},
+    options: {refreshKeys: false, validateFields: true},
   })
 
   if (!updatedBlockObject) {

package/src/operations/behavior.operation.insert-inline-object.ts

@@ -12,7 +12,7 @@ export const insertInlineObjectOperationImplementation: BehaviorOperationImpleme
       _type: operation.inlineObject.name,
       ...(operation.inlineObject.value ?? {}),
     },
-    options: {refreshKeys: false},
+    options: {refreshKeys: false, validateFields: true},
   })
 
   if (!parsedInlineObject) {

package/src/operations/behavior.operation.insert.block.ts

@@ -19,7 +19,7 @@ export const insertBlockOperationImplementation: BehaviorOperationImplementation
   const parsedBlock = parseBlock({
     block: operation.block,
     context,
-    options: {refreshKeys: false},
+    options: {refreshKeys: false, validateFields: true},
   })
 
   if (!parsedBlock) {

package/src/selectors/selector.get-trimmed-selection.test.ts

@@ -34,6 +34,7 @@ function snapshot(
           block,
           options: {
             refreshKeys: false,
+            validateFields: false,
           },
         })
 

package/src/utils/util.merge-text-blocks.ts

@@ -18,7 +18,7 @@ export function mergeTextBlocks({
   const parsedIncomingBlock = parseBlock({
     context,
     block: incomingBlock,
-    options: {refreshKeys: true},
+    options: {refreshKeys: true, validateFields: true},
   })
 
   if (!parsedIncomingBlock || !isTextBlock(context, parsedIncomingBlock)) {