@portabletext/schema 0.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 - 2024 Sanity.io
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,32 @@
+# `@portabletext/schema`
+
+A TypeScript library for defining and compiling Portable Text schemas with full type safety and editor support.
+
+## Installation
+
+```bash
+npm install @portabletext/schema
+```
+
+## Usage
+
+### Define a Schema
+
+```ts
+import {defineSchema} from '@portabletext/schema'
+
+const schemaDefinition = defineSchema({
+  styles: [{name: 'normal'}, {name: 'h1'}, {name: 'h2'}, {name: 'blockquote'}],
+  decorators: [{name: 'strong'}, {name: 'em'}],
+  annotations: [{name: 'link'}],
+  lists: [{name: 'bullet'}, {name: 'numbered'}],
+})
+```
+
+### Compile Schema
+
+```ts
+import {compileSchema} from '@portabletext/schema'
+
+const schema = compileSchema(schemaDefinition)
+```

package/dist/index.cjs

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: !0 });
+function compileSchema(definition) {
+  const styles = (definition.styles ?? []).map((style) => ({
+    ...style,
+    value: style.name
+  }));
+  return {
+    block: {
+      name: definition.block?.name ?? "block"
+    },
+    span: {
+      name: "span"
+    },
+    styles: styles.some((style) => style.value === "normal") ? styles : [{ value: "normal", name: "normal", title: "Normal" }, ...styles],
+    lists: (definition.lists ?? []).map((list) => ({
+      ...list,
+      value: list.name
+    })),
+    decorators: (definition.decorators ?? []).map((decorator) => ({
+      ...decorator,
+      value: decorator.name
+    })),
+    annotations: (definition.annotations ?? []).map((annotation) => ({
+      ...annotation,
+      fields: annotation.fields ?? []
+    })),
+    blockObjects: (definition.blockObjects ?? []).map((blockObject) => ({
+      ...blockObject,
+      fields: blockObject.fields ?? []
+    })),
+    inlineObjects: (definition.inlineObjects ?? []).map((inlineObject) => ({
+      ...inlineObject,
+      fields: inlineObject.fields ?? []
+    }))
+  };
+}
+function defineSchema(definition) {
+  return definition;
+}
+exports.compileSchema = compileSchema;
+exports.defineSchema = defineSchema;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":["../src/compile-schema.ts","../src/define-schema.ts"],"sourcesContent":["import type {SchemaDefinition} from './define-schema'\nimport type {Schema} from './schema'\n\n/**\n * @public\n */\nexport function compileSchema(definition: SchemaDefinition): Schema {\n  const styles = (definition.styles ?? []).map((style) => ({\n    ...style,\n    value: style.name,\n  }))\n\n  return {\n    block: {\n      name: definition.block?.name ?? 'block',\n    },\n    span: {\n      name: 'span',\n    },\n    styles: !styles.some((style) => style.value === 'normal')\n      ? [{value: 'normal', name: 'normal', title: 'Normal'}, ...styles]\n      : styles,\n    lists: (definition.lists ?? []).map((list) => ({\n      ...list,\n      value: list.name,\n    })),\n    decorators: (definition.decorators ?? []).map((decorator) => ({\n      ...decorator,\n      value: decorator.name,\n    })),\n    annotations: (definition.annotations ?? []).map((annotation) => ({\n      ...annotation,\n      fields: annotation.fields ?? [],\n    })),\n    blockObjects: (definition.blockObjects ?? []).map((blockObject) => ({\n      ...blockObject,\n      fields: blockObject.fields ?? [],\n    })),\n    inlineObjects: (definition.inlineObjects ?? []).map((inlineObject) => ({\n      ...inlineObject,\n      fields: inlineObject.fields ?? [],\n    })),\n  }\n}\n","import type {BaseDefinition, FieldDefinition} from './schema'\n\n/**\n * @public\n */\nexport type SchemaDefinition = {\n  block?: {\n    name: string\n  }\n  styles?: ReadonlyArray<StyleDefinition>\n  lists?: ReadonlyArray<ListDefinition>\n  decorators?: ReadonlyArray<DecoratorDefinition>\n  annotations?: ReadonlyArray<AnnotationDefinition>\n  blockObjects?: ReadonlyArray<BlockObjectDefinition>\n  inlineObjects?: ReadonlyArray<InlineObjectDefinition>\n}\n\n/**\n * @public\n * A helper wrapper that adds editor support, such as autocomplete and type checking, for a schema definition.\n * @example\n * ```ts\n * import { defineSchema } from '@portabletext/editor'\n *\n * const schemaDefinition = defineSchema({\n *  decorators: [{name: 'strong'}, {name: 'em'}, {name: 'underline'}],\n *  annotations: [{name: 'link'}],\n *  styles: [\n *    {name: 'normal'},\n *    {name: 'h1'},\n *    {name: 'h2'},\n *    {name: 'h3'},\n *    {name: 'blockquote'},\n *  ],\n *  lists: [],\n *  inlineObjects: [],\n *  blockObjects: [],\n * }\n * ```\n */\nexport function defineSchema<const TSchemaDefinition extends SchemaDefinition>(\n  definition: TSchemaDefinition,\n): TSchemaDefinition {\n  return definition\n}\n\n/**\n * @public\n */\nexport type StyleDefinition<\n  TBaseDefinition extends BaseDefinition = BaseDefinition,\n> = TBaseDefinition\n\n/**\n * @public\n */\nexport type ListDefinition<\n  TBaseDefinition extends BaseDefinition = BaseDefinition,\n> = TBaseDefinition\n\n/**\n * @public\n */\nexport type DecoratorDefinition<\n  TBaseDefinition extends BaseDefinition = BaseDefinition,\n> = TBaseDefinition\n\n/**\n * @public\n */\nexport type AnnotationDefinition<\n  TBaseDefinition extends BaseDefinition = BaseDefinition,\n> = TBaseDefinition & {\n  fields?: ReadonlyArray<FieldDefinition>\n}\n\n/**\n * @public\n */\nexport type BlockObjectDefinition<\n  TBaseDefinition extends BaseDefinition = BaseDefinition,\n> = TBaseDefinition & {\n  fields?: ReadonlyArray<FieldDefinition>\n}\n\n/**\n * @public\n */\nexport type InlineObjectDefinition<\n  TBaseDefinition extends BaseDefinition = BaseDefinition,\n> = TBaseDefinition & {\n  fields?: ReadonlyArray<FieldDefinition>\n}\n"],"names":[],"mappings":";;AAMO,SAAS,cAAc,YAAsC;AAClE,QAAM,UAAU,WAAW,UAAU,CAAA,GAAI,IAAI,CAAC,WAAW;AAAA,IACvD,GAAG;AAAA,IACH,OAAO,MAAM;AAAA,EAAA,EACb;AAEF,SAAO;AAAA,IACL,OAAO;AAAA,MACL,MAAM,WAAW,OAAO,QAAQ;AAAA,IAAA;AAAA,IAElC,MAAM;AAAA,MACJ,MAAM;AAAA,IAAA;AAAA,IAER,QAAS,OAAO,KAAK,CAAC,UAAU,MAAM,UAAU,QAAQ,IAEpD,SADA,CAAC,EAAC,OAAO,UAAU,MAAM,UAAU,OAAO,SAAA,GAAW,GAAG,MAAM;AAAA,IAElE,QAAQ,WAAW,SAAS,CAAA,GAAI,IAAI,CAAC,UAAU;AAAA,MAC7C,GAAG;AAAA,MACH,OAAO,KAAK;AAAA,IAAA,EACZ;AAAA,IACF,aAAa,WAAW,cAAc,CAAA,GAAI,IAAI,CAAC,eAAe;AAAA,MAC5D,GAAG;AAAA,MACH,OAAO,UAAU;AAAA,IAAA,EACjB;AAAA,IACF,cAAc,WAAW,eAAe,CAAA,GAAI,IAAI,CAAC,gBAAgB;AAAA,MAC/D,GAAG;AAAA,MACH,QAAQ,WAAW,UAAU,CAAA;AAAA,IAAC,EAC9B;AAAA,IACF,eAAe,WAAW,gBAAgB,CAAA,GAAI,IAAI,CAAC,iBAAiB;AAAA,MAClE,GAAG;AAAA,MACH,QAAQ,YAAY,UAAU,CAAA;AAAA,IAAC,EAC/B;AAAA,IACF,gBAAgB,WAAW,iBAAiB,CAAA,GAAI,IAAI,CAAC,kBAAkB;AAAA,MACrE,GAAG;AAAA,MACH,QAAQ,aAAa,UAAU,CAAA;AAAA,IAAC,EAChC;AAAA,EAAA;AAEN;ACHO,SAAS,aACd,YACmB;AACnB,SAAO;AACT;;;"}

package/dist/index.d.cts

@@ -0,0 +1,151 @@
+/**
+ * @public
+ */
+type Schema = {
+  block: {
+    name: string;
+  };
+  span: {
+    name: string;
+  };
+  styles: ReadonlyArray<StyleSchemaType>;
+  lists: ReadonlyArray<ListSchemaType>;
+  decorators: ReadonlyArray<DecoratorSchemaType>;
+  annotations: ReadonlyArray<AnnotationSchemaType>;
+  blockObjects: ReadonlyArray<BlockObjectSchemaType>;
+  inlineObjects: ReadonlyArray<InlineObjectSchemaType>;
+};
+/**
+ * @public
+ */
+type StyleSchemaType = BaseDefinition & {
+  /**
+   * @deprecated
+   * Use `name` instead
+   */
+  value: string;
+};
+/**
+ * @public
+ */
+type ListSchemaType = BaseDefinition & {
+  /**
+   * @deprecated
+   * Use `name` instead
+   */
+  value: string;
+};
+/**
+ * @public
+ */
+type DecoratorSchemaType = BaseDefinition & {
+  /**
+   * @deprecated
+   * Use `name` instead
+   */
+  value: string;
+};
+/**
+ * @public
+ */
+type AnnotationSchemaType = BaseDefinition & {
+  fields: ReadonlyArray<FieldDefinition>;
+};
+/**
+ * @public
+ */
+type BlockObjectSchemaType = BaseDefinition & {
+  fields: ReadonlyArray<FieldDefinition>;
+};
+/**
+ * @public
+ */
+type InlineObjectSchemaType = BaseDefinition & {
+  fields: ReadonlyArray<FieldDefinition>;
+};
+/**
+ * @public
+ */
+type FieldDefinition = BaseDefinition & {
+  type: 'string' | 'number' | 'boolean' | 'array' | 'object';
+};
+/**
+ * @public
+ */
+type BaseDefinition = {
+  name: string;
+  title?: string;
+};
+/**
+ * @public
+ */
+type SchemaDefinition = {
+  block?: {
+    name: string;
+  };
+  styles?: ReadonlyArray<StyleDefinition>;
+  lists?: ReadonlyArray<ListDefinition>;
+  decorators?: ReadonlyArray<DecoratorDefinition>;
+  annotations?: ReadonlyArray<AnnotationDefinition>;
+  blockObjects?: ReadonlyArray<BlockObjectDefinition>;
+  inlineObjects?: ReadonlyArray<InlineObjectDefinition>;
+};
+/**
+ * @public
+ * A helper wrapper that adds editor support, such as autocomplete and type checking, for a schema definition.
+ * @example
+ * ```ts
+ * import { defineSchema } from '@portabletext/editor'
+ *
+ * const schemaDefinition = defineSchema({
+ *  decorators: [{name: 'strong'}, {name: 'em'}, {name: 'underline'}],
+ *  annotations: [{name: 'link'}],
+ *  styles: [
+ *    {name: 'normal'},
+ *    {name: 'h1'},
+ *    {name: 'h2'},
+ *    {name: 'h3'},
+ *    {name: 'blockquote'},
+ *  ],
+ *  lists: [],
+ *  inlineObjects: [],
+ *  blockObjects: [],
+ * }
+ * ```
+ */
+declare function defineSchema<const TSchemaDefinition extends SchemaDefinition>(definition: TSchemaDefinition): TSchemaDefinition;
+/**
+ * @public
+ */
+type StyleDefinition<TBaseDefinition extends BaseDefinition = BaseDefinition> = TBaseDefinition;
+/**
+ * @public
+ */
+type ListDefinition<TBaseDefinition extends BaseDefinition = BaseDefinition> = TBaseDefinition;
+/**
+ * @public
+ */
+type DecoratorDefinition<TBaseDefinition extends BaseDefinition = BaseDefinition> = TBaseDefinition;
+/**
+ * @public
+ */
+type AnnotationDefinition<TBaseDefinition extends BaseDefinition = BaseDefinition> = TBaseDefinition & {
+  fields?: ReadonlyArray<FieldDefinition>;
+};
+/**
+ * @public
+ */
+type BlockObjectDefinition<TBaseDefinition extends BaseDefinition = BaseDefinition> = TBaseDefinition & {
+  fields?: ReadonlyArray<FieldDefinition>;
+};
+/**
+ * @public
+ */
+type InlineObjectDefinition<TBaseDefinition extends BaseDefinition = BaseDefinition> = TBaseDefinition & {
+  fields?: ReadonlyArray<FieldDefinition>;
+};
+/**
+ * @public
+ */
+declare function compileSchema(definition: SchemaDefinition): Schema;
+export { type AnnotationDefinition, type AnnotationSchemaType, type BaseDefinition, type BlockObjectDefinition, type BlockObjectSchemaType, type DecoratorDefinition, type DecoratorSchemaType, type FieldDefinition, type InlineObjectDefinition, type InlineObjectSchemaType, type ListDefinition, type ListSchemaType, type Schema, type SchemaDefinition, type StyleDefinition, type StyleSchemaType, compileSchema, defineSchema };

package/dist/index.d.ts

@@ -0,0 +1,151 @@
+/**
+ * @public
+ */
+type Schema = {
+  block: {
+    name: string;
+  };
+  span: {
+    name: string;
+  };
+  styles: ReadonlyArray<StyleSchemaType>;
+  lists: ReadonlyArray<ListSchemaType>;
+  decorators: ReadonlyArray<DecoratorSchemaType>;
+  annotations: ReadonlyArray<AnnotationSchemaType>;
+  blockObjects: ReadonlyArray<BlockObjectSchemaType>;
+  inlineObjects: ReadonlyArray<InlineObjectSchemaType>;
+};
+/**
+ * @public
+ */
+type StyleSchemaType = BaseDefinition & {
+  /**
+   * @deprecated
+   * Use `name` instead
+   */
+  value: string;
+};
+/**
+ * @public
+ */
+type ListSchemaType = BaseDefinition & {
+  /**
+   * @deprecated
+   * Use `name` instead
+   */
+  value: string;
+};
+/**
+ * @public
+ */
+type DecoratorSchemaType = BaseDefinition & {
+  /**
+   * @deprecated
+   * Use `name` instead
+   */
+  value: string;
+};
+/**
+ * @public
+ */
+type AnnotationSchemaType = BaseDefinition & {
+  fields: ReadonlyArray<FieldDefinition>;
+};
+/**
+ * @public
+ */
+type BlockObjectSchemaType = BaseDefinition & {
+  fields: ReadonlyArray<FieldDefinition>;
+};
+/**
+ * @public
+ */
+type InlineObjectSchemaType = BaseDefinition & {
+  fields: ReadonlyArray<FieldDefinition>;
+};
+/**
+ * @public
+ */
+type FieldDefinition = BaseDefinition & {
+  type: 'string' | 'number' | 'boolean' | 'array' | 'object';
+};
+/**
+ * @public
+ */
+type BaseDefinition = {
+  name: string;
+  title?: string;
+};
+/**
+ * @public
+ */
+type SchemaDefinition = {
+  block?: {
+    name: string;
+  };
+  styles?: ReadonlyArray<StyleDefinition>;
+  lists?: ReadonlyArray<ListDefinition>;
+  decorators?: ReadonlyArray<DecoratorDefinition>;
+  annotations?: ReadonlyArray<AnnotationDefinition>;
+  blockObjects?: ReadonlyArray<BlockObjectDefinition>;
+  inlineObjects?: ReadonlyArray<InlineObjectDefinition>;
+};
+/**
+ * @public
+ * A helper wrapper that adds editor support, such as autocomplete and type checking, for a schema definition.
+ * @example
+ * ```ts
+ * import { defineSchema } from '@portabletext/editor'
+ *
+ * const schemaDefinition = defineSchema({
+ *  decorators: [{name: 'strong'}, {name: 'em'}, {name: 'underline'}],
+ *  annotations: [{name: 'link'}],
+ *  styles: [
+ *    {name: 'normal'},
+ *    {name: 'h1'},
+ *    {name: 'h2'},
+ *    {name: 'h3'},
+ *    {name: 'blockquote'},
+ *  ],
+ *  lists: [],
+ *  inlineObjects: [],
+ *  blockObjects: [],
+ * }
+ * ```
+ */
+declare function defineSchema<const TSchemaDefinition extends SchemaDefinition>(definition: TSchemaDefinition): TSchemaDefinition;
+/**
+ * @public
+ */
+type StyleDefinition<TBaseDefinition extends BaseDefinition = BaseDefinition> = TBaseDefinition;
+/**
+ * @public
+ */
+type ListDefinition<TBaseDefinition extends BaseDefinition = BaseDefinition> = TBaseDefinition;
+/**
+ * @public
+ */
+type DecoratorDefinition<TBaseDefinition extends BaseDefinition = BaseDefinition> = TBaseDefinition;
+/**
+ * @public
+ */
+type AnnotationDefinition<TBaseDefinition extends BaseDefinition = BaseDefinition> = TBaseDefinition & {
+  fields?: ReadonlyArray<FieldDefinition>;
+};
+/**
+ * @public
+ */
+type BlockObjectDefinition<TBaseDefinition extends BaseDefinition = BaseDefinition> = TBaseDefinition & {
+  fields?: ReadonlyArray<FieldDefinition>;
+};
+/**
+ * @public
+ */
+type InlineObjectDefinition<TBaseDefinition extends BaseDefinition = BaseDefinition> = TBaseDefinition & {
+  fields?: ReadonlyArray<FieldDefinition>;
+};
+/**
+ * @public
+ */
+declare function compileSchema(definition: SchemaDefinition): Schema;
+export { type AnnotationDefinition, type AnnotationSchemaType, type BaseDefinition, type BlockObjectDefinition, type BlockObjectSchemaType, type DecoratorDefinition, type DecoratorSchemaType, type FieldDefinition, type InlineObjectDefinition, type InlineObjectSchemaType, type ListDefinition, type ListSchemaType, type Schema, type SchemaDefinition, type StyleDefinition, type StyleSchemaType, compileSchema, defineSchema };

package/dist/index.js

@@ -0,0 +1,43 @@
+function compileSchema(definition) {
+  const styles = (definition.styles ?? []).map((style) => ({
+    ...style,
+    value: style.name
+  }));
+  return {
+    block: {
+      name: definition.block?.name ?? "block"
+    },
+    span: {
+      name: "span"
+    },
+    styles: styles.some((style) => style.value === "normal") ? styles : [{ value: "normal", name: "normal", title: "Normal" }, ...styles],
+    lists: (definition.lists ?? []).map((list) => ({
+      ...list,
+      value: list.name
+    })),
+    decorators: (definition.decorators ?? []).map((decorator) => ({
+      ...decorator,
+      value: decorator.name
+    })),
+    annotations: (definition.annotations ?? []).map((annotation) => ({
+      ...annotation,
+      fields: annotation.fields ?? []
+    })),
+    blockObjects: (definition.blockObjects ?? []).map((blockObject) => ({
+      ...blockObject,
+      fields: blockObject.fields ?? []
+    })),
+    inlineObjects: (definition.inlineObjects ?? []).map((inlineObject) => ({
+      ...inlineObject,
+      fields: inlineObject.fields ?? []
+    }))
+  };
+}
+function defineSchema(definition) {
+  return definition;
+}
+export {
+  compileSchema,
+  defineSchema
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/compile-schema.ts","../src/define-schema.ts"],"sourcesContent":["import type {SchemaDefinition} from './define-schema'\nimport type {Schema} from './schema'\n\n/**\n * @public\n */\nexport function compileSchema(definition: SchemaDefinition): Schema {\n  const styles = (definition.styles ?? []).map((style) => ({\n    ...style,\n    value: style.name,\n  }))\n\n  return {\n    block: {\n      name: definition.block?.name ?? 'block',\n    },\n    span: {\n      name: 'span',\n    },\n    styles: !styles.some((style) => style.value === 'normal')\n      ? [{value: 'normal', name: 'normal', title: 'Normal'}, ...styles]\n      : styles,\n    lists: (definition.lists ?? []).map((list) => ({\n      ...list,\n      value: list.name,\n    })),\n    decorators: (definition.decorators ?? []).map((decorator) => ({\n      ...decorator,\n      value: decorator.name,\n    })),\n    annotations: (definition.annotations ?? []).map((annotation) => ({\n      ...annotation,\n      fields: annotation.fields ?? [],\n    })),\n    blockObjects: (definition.blockObjects ?? []).map((blockObject) => ({\n      ...blockObject,\n      fields: blockObject.fields ?? [],\n    })),\n    inlineObjects: (definition.inlineObjects ?? []).map((inlineObject) => ({\n      ...inlineObject,\n      fields: inlineObject.fields ?? [],\n    })),\n  }\n}\n","import type {BaseDefinition, FieldDefinition} from './schema'\n\n/**\n * @public\n */\nexport type SchemaDefinition = {\n  block?: {\n    name: string\n  }\n  styles?: ReadonlyArray<StyleDefinition>\n  lists?: ReadonlyArray<ListDefinition>\n  decorators?: ReadonlyArray<DecoratorDefinition>\n  annotations?: ReadonlyArray<AnnotationDefinition>\n  blockObjects?: ReadonlyArray<BlockObjectDefinition>\n  inlineObjects?: ReadonlyArray<InlineObjectDefinition>\n}\n\n/**\n * @public\n * A helper wrapper that adds editor support, such as autocomplete and type checking, for a schema definition.\n * @example\n * ```ts\n * import { defineSchema } from '@portabletext/editor'\n *\n * const schemaDefinition = defineSchema({\n *  decorators: [{name: 'strong'}, {name: 'em'}, {name: 'underline'}],\n *  annotations: [{name: 'link'}],\n *  styles: [\n *    {name: 'normal'},\n *    {name: 'h1'},\n *    {name: 'h2'},\n *    {name: 'h3'},\n *    {name: 'blockquote'},\n *  ],\n *  lists: [],\n *  inlineObjects: [],\n *  blockObjects: [],\n * }\n * ```\n */\nexport function defineSchema<const TSchemaDefinition extends SchemaDefinition>(\n  definition: TSchemaDefinition,\n): TSchemaDefinition {\n  return definition\n}\n\n/**\n * @public\n */\nexport type StyleDefinition<\n  TBaseDefinition extends BaseDefinition = BaseDefinition,\n> = TBaseDefinition\n\n/**\n * @public\n */\nexport type ListDefinition<\n  TBaseDefinition extends BaseDefinition = BaseDefinition,\n> = TBaseDefinition\n\n/**\n * @public\n */\nexport type DecoratorDefinition<\n  TBaseDefinition extends BaseDefinition = BaseDefinition,\n> = TBaseDefinition\n\n/**\n * @public\n */\nexport type AnnotationDefinition<\n  TBaseDefinition extends BaseDefinition = BaseDefinition,\n> = TBaseDefinition & {\n  fields?: ReadonlyArray<FieldDefinition>\n}\n\n/**\n * @public\n */\nexport type BlockObjectDefinition<\n  TBaseDefinition extends BaseDefinition = BaseDefinition,\n> = TBaseDefinition & {\n  fields?: ReadonlyArray<FieldDefinition>\n}\n\n/**\n * @public\n */\nexport type InlineObjectDefinition<\n  TBaseDefinition extends BaseDefinition = BaseDefinition,\n> = TBaseDefinition & {\n  fields?: ReadonlyArray<FieldDefinition>\n}\n"],"names":[],"mappings":"AAMO,SAAS,cAAc,YAAsC;AAClE,QAAM,UAAU,WAAW,UAAU,CAAA,GAAI,IAAI,CAAC,WAAW;AAAA,IACvD,GAAG;AAAA,IACH,OAAO,MAAM;AAAA,EAAA,EACb;AAEF,SAAO;AAAA,IACL,OAAO;AAAA,MACL,MAAM,WAAW,OAAO,QAAQ;AAAA,IAAA;AAAA,IAElC,MAAM;AAAA,MACJ,MAAM;AAAA,IAAA;AAAA,IAER,QAAS,OAAO,KAAK,CAAC,UAAU,MAAM,UAAU,QAAQ,IAEpD,SADA,CAAC,EAAC,OAAO,UAAU,MAAM,UAAU,OAAO,SAAA,GAAW,GAAG,MAAM;AAAA,IAElE,QAAQ,WAAW,SAAS,CAAA,GAAI,IAAI,CAAC,UAAU;AAAA,MAC7C,GAAG;AAAA,MACH,OAAO,KAAK;AAAA,IAAA,EACZ;AAAA,IACF,aAAa,WAAW,cAAc,CAAA,GAAI,IAAI,CAAC,eAAe;AAAA,MAC5D,GAAG;AAAA,MACH,OAAO,UAAU;AAAA,IAAA,EACjB;AAAA,IACF,cAAc,WAAW,eAAe,CAAA,GAAI,IAAI,CAAC,gBAAgB;AAAA,MAC/D,GAAG;AAAA,MACH,QAAQ,WAAW,UAAU,CAAA;AAAA,IAAC,EAC9B;AAAA,IACF,eAAe,WAAW,gBAAgB,CAAA,GAAI,IAAI,CAAC,iBAAiB;AAAA,MAClE,GAAG;AAAA,MACH,QAAQ,YAAY,UAAU,CAAA;AAAA,IAAC,EAC/B;AAAA,IACF,gBAAgB,WAAW,iBAAiB,CAAA,GAAI,IAAI,CAAC,kBAAkB;AAAA,MACrE,GAAG;AAAA,MACH,QAAQ,aAAa,UAAU,CAAA;AAAA,IAAC,EAChC;AAAA,EAAA;AAEN;ACHO,SAAS,aACd,YACmB;AACnB,SAAO;AACT;"}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@portabletext/schema",
+  "version": "0.0.0",
+  "description": "Portable Text Schema",
+  "keywords": [
+    "portabletext",
+    "schema"
+  ],
+  "homepage": "https://www.portabletext.org/",
+  "bugs": {
+    "url": "https://github.com/portabletext/editor/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/portabletext/editor.git",
+    "directory": "packages/schema"
+  },
+  "license": "MIT",
+  "author": "Sanity.io <hello@sanity.io>",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "source": "./src/index.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
+  "devDependencies": {
+    "@sanity/pkg-utils": "^7.11.1",
+    "typescript": "^5.9.2"
+  },
+  "scripts": {
+    "build": "pkg-utils build --strict --check --clean",
+    "check:lint": "biome lint .",
+    "check:types": "tsc",
+    "check:types:watch": "tsc --watch",
+    "clean": "del .turbo && del lib && del node_modules",
+    "dev": "pkg-utils watch",
+    "lint:fix": "biome lint --write ."
+  }
+}

package/src/compile-schema.ts

@@ -0,0 +1,44 @@
+import type {SchemaDefinition} from './define-schema'
+import type {Schema} from './schema'
+
+/**
+ * @public
+ */
+export function compileSchema(definition: SchemaDefinition): Schema {
+  const styles = (definition.styles ?? []).map((style) => ({
+    ...style,
+    value: style.name,
+  }))
+
+  return {
+    block: {
+      name: definition.block?.name ?? 'block',
+    },
+    span: {
+      name: 'span',
+    },
+    styles: !styles.some((style) => style.value === 'normal')
+      ? [{value: 'normal', name: 'normal', title: 'Normal'}, ...styles]
+      : styles,
+    lists: (definition.lists ?? []).map((list) => ({
+      ...list,
+      value: list.name,
+    })),
+    decorators: (definition.decorators ?? []).map((decorator) => ({
+      ...decorator,
+      value: decorator.name,
+    })),
+    annotations: (definition.annotations ?? []).map((annotation) => ({
+      ...annotation,
+      fields: annotation.fields ?? [],
+    })),
+    blockObjects: (definition.blockObjects ?? []).map((blockObject) => ({
+      ...blockObject,
+      fields: blockObject.fields ?? [],
+    })),
+    inlineObjects: (definition.inlineObjects ?? []).map((inlineObject) => ({
+      ...inlineObject,
+      fields: inlineObject.fields ?? [],
+    })),
+  }
+}

package/src/define-schema.ts

@@ -0,0 +1,93 @@
+import type {BaseDefinition, FieldDefinition} from './schema'
+
+/**
+ * @public
+ */
+export type SchemaDefinition = {
+  block?: {
+    name: string
+  }
+  styles?: ReadonlyArray<StyleDefinition>
+  lists?: ReadonlyArray<ListDefinition>
+  decorators?: ReadonlyArray<DecoratorDefinition>
+  annotations?: ReadonlyArray<AnnotationDefinition>
+  blockObjects?: ReadonlyArray<BlockObjectDefinition>
+  inlineObjects?: ReadonlyArray<InlineObjectDefinition>
+}
+
+/**
+ * @public
+ * A helper wrapper that adds editor support, such as autocomplete and type checking, for a schema definition.
+ * @example
+ * ```ts
+ * import { defineSchema } from '@portabletext/editor'
+ *
+ * const schemaDefinition = defineSchema({
+ *  decorators: [{name: 'strong'}, {name: 'em'}, {name: 'underline'}],
+ *  annotations: [{name: 'link'}],
+ *  styles: [
+ *    {name: 'normal'},
+ *    {name: 'h1'},
+ *    {name: 'h2'},
+ *    {name: 'h3'},
+ *    {name: 'blockquote'},
+ *  ],
+ *  lists: [],
+ *  inlineObjects: [],
+ *  blockObjects: [],
+ * }
+ * ```
+ */
+export function defineSchema<const TSchemaDefinition extends SchemaDefinition>(
+  definition: TSchemaDefinition,
+): TSchemaDefinition {
+  return definition
+}
+
+/**
+ * @public
+ */
+export type StyleDefinition<
+  TBaseDefinition extends BaseDefinition = BaseDefinition,
+> = TBaseDefinition
+
+/**
+ * @public
+ */
+export type ListDefinition<
+  TBaseDefinition extends BaseDefinition = BaseDefinition,
+> = TBaseDefinition
+
+/**
+ * @public
+ */
+export type DecoratorDefinition<
+  TBaseDefinition extends BaseDefinition = BaseDefinition,
+> = TBaseDefinition
+
+/**
+ * @public
+ */
+export type AnnotationDefinition<
+  TBaseDefinition extends BaseDefinition = BaseDefinition,
+> = TBaseDefinition & {
+  fields?: ReadonlyArray<FieldDefinition>
+}
+
+/**
+ * @public
+ */
+export type BlockObjectDefinition<
+  TBaseDefinition extends BaseDefinition = BaseDefinition,
+> = TBaseDefinition & {
+  fields?: ReadonlyArray<FieldDefinition>
+}
+
+/**
+ * @public
+ */
+export type InlineObjectDefinition<
+  TBaseDefinition extends BaseDefinition = BaseDefinition,
+> = TBaseDefinition & {
+  fields?: ReadonlyArray<FieldDefinition>
+}

package/src/index.ts

@@ -0,0 +1,22 @@
+export {compileSchema} from './compile-schema'
+export {
+  defineSchema,
+  type AnnotationDefinition,
+  type BlockObjectDefinition,
+  type DecoratorDefinition,
+  type InlineObjectDefinition,
+  type ListDefinition,
+  type SchemaDefinition,
+  type StyleDefinition,
+} from './define-schema'
+export type {
+  AnnotationSchemaType,
+  BaseDefinition,
+  BlockObjectSchemaType,
+  DecoratorSchemaType,
+  FieldDefinition,
+  InlineObjectSchemaType,
+  ListSchemaType,
+  Schema,
+  StyleSchemaType,
+} from './schema'

package/src/schema.ts

@@ -0,0 +1,86 @@
+/**
+ * @public
+ */
+export type Schema = {
+  block: {
+    name: string
+  }
+  span: {
+    name: string
+  }
+  styles: ReadonlyArray<StyleSchemaType>
+  lists: ReadonlyArray<ListSchemaType>
+  decorators: ReadonlyArray<DecoratorSchemaType>
+  annotations: ReadonlyArray<AnnotationSchemaType>
+  blockObjects: ReadonlyArray<BlockObjectSchemaType>
+  inlineObjects: ReadonlyArray<InlineObjectSchemaType>
+}
+
+/**
+ * @public
+ */
+export type StyleSchemaType = BaseDefinition & {
+  /**
+   * @deprecated
+   * Use `name` instead
+   */
+  value: string
+}
+
+/**
+ * @public
+ */
+export type ListSchemaType = BaseDefinition & {
+  /**
+   * @deprecated
+   * Use `name` instead
+   */
+  value: string
+}
+
+/**
+ * @public
+ */
+export type DecoratorSchemaType = BaseDefinition & {
+  /**
+   * @deprecated
+   * Use `name` instead
+   */
+  value: string
+}
+
+/**
+ * @public
+ */
+export type AnnotationSchemaType = BaseDefinition & {
+  fields: ReadonlyArray<FieldDefinition>
+}
+
+/**
+ * @public
+ */
+export type BlockObjectSchemaType = BaseDefinition & {
+  fields: ReadonlyArray<FieldDefinition>
+}
+
+/**
+ * @public
+ */
+export type InlineObjectSchemaType = BaseDefinition & {
+  fields: ReadonlyArray<FieldDefinition>
+}
+
+/**
+ * @public
+ */
+export type FieldDefinition = BaseDefinition & {
+  type: 'string' | 'number' | 'boolean' | 'array' | 'object'
+}
+
+/**
+ * @public
+ */
+export type BaseDefinition = {
+  name: string
+  title?: string
+}