@portabletext/editor 1.56.0 → 1.57.0

package/README.md

@@ -372,3 +372,22 @@ In order to provide a robust and consistent end-user experience, the editor is b
 4. `cd` into the `sanity` package and run `pnpm link <relative path to the **editor** package in this repo>`
 
 Now, you should be able to run `pnpm dev:test-studio` in the `sanity` repo to test Studio with a locally running Portable Text Editor.
+
+## Other Libraries
+
+This monorepo also contains additional libraries that can be used with the Portable Text Editor:
+
+### `@portabletext/keyboard-shortcuts`
+
+> A TypeScript library for creating platform-aware keyboard shortcuts with automatic detection of Apple vs non-Apple platforms.
+
+- 💻 [./packages/keyboard-shortcuts](./packages/keyboard-shortcuts/)
+- 📦 [@portabletext/keyboard-shortcuts](https://www.npmjs.com/package/@portabletext/keyboard-shortcuts)
+
+### `@portabletext/toolbar`
+
+> Powered by [Behaviors](https://www.portabletext.org/concepts/behavior/) and [State Machines](https://stately.ai/docs/xstate), `@portabletext/toolbar` is a collection of robust React hooks for building toolbars and related UI components
+> for the Portable Text editor.
+
+- 💻 [./packages/toolbar](./packages/toolbar/)
+- 📦 [@portabletext/toolbar](https://www.npmjs.com/package/@portabletext/toolbar)

package/lib/behaviors/index.d.cts

@@ -653,8 +653,7 @@ declare type ExtractNamespace<TType extends string> =
 /**
  * @public
  */
-declare type FieldDefinition = {
-  name: string
+declare type FieldDefinition = BaseDefinition & {
   type: 'string' | 'number' | 'boolean' | 'array' | 'object'
 }
 

package/lib/behaviors/index.d.ts

@@ -653,8 +653,7 @@ declare type ExtractNamespace<TType extends string> =
 /**
  * @public
  */
-declare type FieldDefinition = {
-  name: string
+declare type FieldDefinition = BaseDefinition & {
   type: 'string' | 'number' | 'boolean' | 'array' | 'object'
 }
 

package/lib/index.cjs

@@ -8329,7 +8329,8 @@ function legacySchemaToEditorSchema(schema2) {
       name: annotation.name,
       fields: annotation.fields.map((field) => ({
         name: field.name,
-        type: field.type.jsonType
+        type: field.type.jsonType,
+        title: field.type.title
       })),
       title: annotation.title
     })),
@@ -8340,7 +8341,8 @@ function legacySchemaToEditorSchema(schema2) {
       name: blockObject.name,
       fields: blockObject.fields.map((field) => ({
         name: field.name,
-        type: field.type.jsonType
+        type: field.type.jsonType,
+        title: field.type.title
       })),
       title: blockObject.title
     })),
@@ -8353,7 +8355,8 @@ function legacySchemaToEditorSchema(schema2) {
       name: inlineObject.name,
       fields: inlineObject.fields.map((field) => ({
         name: field.name,
-        type: field.type.jsonType
+        type: field.type.jsonType,
+        title: field.type.title
       })),
       title: inlineObject.title
     })),
@@ -8384,7 +8387,8 @@ function compileSchemaDefinitionToLegacySchema(definition) {
     ) : blockObject.title,
     fields: blockObject.fields?.map((field) => ({
       name: field.name,
-      type: field.type
+      type: field.type,
+      title: field.title ?? startCase__default.default(field.name)
     })) ?? []
   })) ?? [], inlineObjects = definition?.inlineObjects?.map((inlineObject) => types.defineType({
     type: "object",
@@ -8397,7 +8401,8 @@ function compileSchemaDefinitionToLegacySchema(definition) {
     ) : inlineObject.title,
     fields: inlineObject.fields?.map((field) => ({
       name: field.name,
-      type: field.type
+      type: field.type,
+      title: field.title ?? startCase__default.default(field.name)
     })) ?? []
   })) ?? [], portableTextSchema = types.defineField({
     type: "array",
@@ -8421,6 +8426,7 @@ function compileSchemaDefinitionToLegacySchema(definition) {
           title: annotation.title,
           fields: annotation.fields?.map((field) => ({
             name: field.name,
+            title: field.title ?? startCase__default.default(field.name),
             type: field.type
           })) ?? []
         })) ?? []