@portabletext/schema 2.0.0 → 2.0.1

package/dist/index.d.ts

@@ -206,4 +206,5 @@ interface PortableTextObject {
   _key: string;
   [other: string]: unknown;
 }
-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 PortableTextBlock, type PortableTextObject, type PortableTextSpan, type PortableTextTextBlock, type Schema, type SchemaDefinition, type StyleDefinition, type StyleSchemaType, type TypedObject, compileSchema, defineSchema, isSpan, isTextBlock, isTypedObject };
+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 PortableTextBlock, type PortableTextObject, type PortableTextSpan, type PortableTextTextBlock, type Schema, type SchemaDefinition, type StyleDefinition, type StyleSchemaType, type TypedObject, compileSchema, defineSchema, isSpan, isTextBlock, isTypedObject };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/schema.ts","../src/define-schema.ts","../src/compile-schema.ts","../src/types.ts"],"sourcesContent":[],"mappings":"AAGA;;;AAQwB,KARZ,MAAA,GAQY;EAAd,KAAA,EAAA;IACa,IAAA,EAAA,MAAA;IAAd,MAAA,CAAA,EANI,aAMJ,CANkB,eAMlB,CAAA;EACmB,CAAA;EAAd,IAAA,EAAA;IACe,IAAA,EAAA,MAAA;EAAd,CAAA;EACe,MAAA,EAJpB,aAIoB,CAJN,eAIM,CAAA;EAAd,KAAA,EAHP,aAGO,CAHO,cAGP,CAAA;EACe,UAAA,EAHjB,aAGiB,CAHH,mBAGG,CAAA;EAAd,WAAA,EAFF,aAEE,CAFY,oBAEZ,CAAA;EAAa,YAAA,EADd,aACc,CADA,qBACA,CAAA;EAMlB,aAAA,EANK,aAMU,CANI,sBAMa,CAAA;AAW5C,CAAA;AAWA;AAWA;;AACwB,KAlCZ,eAAA,GAAkB,cAkCN,GAAA;EAAd;;AAMV;;EACwB,KAAA,EAAA,MAAA;CAAd;;AAMV;;AACwB,KArCZ,cAAA,GAAiB,cAqCL,GAAA;EAAd;;AAMV;AAOA;;AC9EA,CAAA;;;;AAKW,KDkCC,mBAAA,GAAsB,cClCvB,GAAA;EACa;;;;EAEM,KAAA,EAAA,MAAA;CAAd;;;;AAEE,KDwCN,oBAAA,GAAuB,cCxCjB,GAAA;EAAa,MAAA,EDyCrB,aCzCqB,CDyCP,eCzCO,CAAA;AA0B/B,CAAA;;;;AAEoB,KDmBR,qBAAA,GAAwB,cCnBhB,GAAA;EAOR,MAAA,EDaF,aCbiB,CDaH,eCbG,CAAA;CACD;;;;AAMd,KDYA,sBAAA,GAAyB,cCZX,GAAA;EACA,MAAA,EDYhB,aCZgB,CDYF,eCZE,CAAA;CAAiB;;;AAM3C;AAC0B,KDWd,eAAA,GAAkB,cCXJ,GAAA;EAAiB,IAAA,EAAA,QAAA,GAAA,QAAA,GAAA,SAAA,GAAA,OAAA,GAAA,QAAA;CACvC;;AAKJ;;AAC2C,KDW/B,cAAA,GCX+B;EACvC,IAAA,EAAA,MAAA;EACqB,KAAA,CAAA,EAAA,MAAA;CAAd;;;;AD/DD,KCNE,gBAAA,GDMF;EACa,KAAA,CAAA,EAAA;IAAd,IAAA,CAAA,EAAA,MAAA;IACmB,MAAA,CAAA,ECLf,aDKe,CCLD,eDKC,CAAA;EAAd,CAAA;EACe,MAAA,CAAA,ECJlB,aDIkB,CCJJ,eDII,CAAA;EAAd,KAAA,CAAA,ECHL,aDGK,CCHS,cDGT,CAAA;EACe,UAAA,CAAA,ECHf,aDGe,CCHD,mBDGC,CAAA;EAAd,WAAA,CAAA,ECFA,aDEA,CCFc,oBDEd,CAAA;EACe,YAAA,CAAA,ECFd,aDEc,CCFA,qBDEA,CAAA;EAAd,aAAA,CAAA,ECDC,aDCD,CCDe,sBDCf,CAAA;CAAa;AAM9B;AAWA;AAWA;AAWA;;;;;AAOA;;;;;AAOA;;;;;AAOA;AAOA;;AC9EA;;AAGa,iBAiCG,YAjCH,CAAA,gCAiCgD,gBAjChD,CAAA,CAAA,UAAA,EAkCC,iBAlCD,CAAA,EAmCV,iBAnCU;;;;AAGH,KAuCE,eAvCF,CAAA,wBAwCgB,cAxChB,GAwCiC,cAxCjC,CAAA,GAyCN,eAzCM;;;;AAEM,KA4CJ,cA5CI,CAAA,wBA6CU,cA7CV,GA6C2B,cA7C3B,CAAA,GA8CZ,eA9CY;;;;AAEE,KAiDN,mBAjDM,CAAA,wBAkDQ,cAlDR,GAkDyB,cAlDzB,CAAA,GAmDd,eAnDc;;AA0BlB;;AACc,KA6BF,oBA7BE,CAAA,wBA8BY,cA9BZ,GA8B6B,cA9B7B,CAAA,GA+BV,eA/BU,GAAA;EACX,MAAA,CAAA,EA+BQ,aA/BR,CA+BsB,eA/BtB,CAAA;CAAiB;AAOpB;;;AAEI,KA4BQ,qBA5BR,CAAA,wBA6BsB,cA7BtB,GA6BuC,cA7BvC,CAAA,GA8BA,eA9BA,GAAA;EAAe,MAAA,CAAA,EA+BR,aA/BQ,CA+BM,eA/BN,CAAA;AAKnB,CAAA;;;;AAEmB,KA8BP,sBA9BO,CAAA,wBA+BO,cA/BP,GA+BwB,cA/BxB,CAAA,GAgCf,eAhCe,GAAA;EAKP,MAAA,CAAA,EA4BD,aA5BoB,CA4BN,eA5BM,CAAA;CACL;;;;ADrDH,iBENP,aAAA,CFMO,UAAA,EENmB,gBFMnB,CAAA,EENsC,MFMtC;;;;AADb,UGNO,WAAA,CHMP;EACa,CAAA,GAAA,EAAA,MAAA,CAAA,EAAA,OAAA;EAAd,KAAA,EAAA,MAAA;;;;;AAGqB,iBGFd,aAAA,CHEc,MAAA,EAAA,OAAA,CAAA,EAAA,MAAA,IGF4B,WHE5B;;;;AACA,KGQlB,iBAAA,GAAoB,qBHRF,GGQ0B,kBHR1B;AAM9B;AAWA;AAWA;AAWY,UG1BK,qBH0Be,CAAA,SGzBrB,gBHyBqB,GGzBF,kBHyBE,CAAA,CAAA;EAAG,KAAA,EAAA,MAAA;EACX,IAAA,EAAA,MAAA;EAAd,QAAA,EGtBE,MHsBF,EAAA;EAAa,QAAA,CAAA,EGrBV,kBHqBU,EAAA;EAMX,QAAA,CAAA,EAAA,MAAA;EAAwB,KAAA,CAAA,EAAA,MAAA;EACZ,KAAA,CAAA,EAAA,MAAA;;;AAMxB;;AACwB,iBG1BR,WAAA,CH0BQ,OAAA,EAAA;EAAd,MAAA,EGzBU,MHyBV;CAAa,EAAA,KAAA,EAAA,OAAA,CAAA,EAAA,KAAA,IGvBX,qBHuBW;AAMvB;AAOA;;AC9EY,UE6DK,gBAAA,CF7DW;EAGD,IAAA,EAAA,MAAA;EAAd,KAAA,EAAA,MAAA;EAEY,IAAA,EAAA,MAAA;EAAd,KAAA,CAAA,EAAA,MAAA,EAAA;;;;;AAGmB,iBE+Dd,MAAA,CF/Dc,OAAA,EAAA;EAAd,MAAA,EEgEI,MFhEJ;CACe,EAAA,KAAA,EAAA,OAAA,CAAA,EAAA,KAAA,IEiEnB,gBFjEmB;;;;AACA,UEmFd,kBAAA,CFnFc;EA0Bf,KAAA,EAAA,MAAA;EAA6C,IAAA,EAAA,MAAA;EAC/C,CAAA,KAAA,EAAA,MAAA,CAAA,EAAA,OAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@portabletext/schema",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Portable Text Schema",
   "keywords": [
     "portabletext",
@@ -29,13 +29,13 @@
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
-    "dist",
-    "src"
+    "dist"
   ],
   "devDependencies": {
-    "@sanity/pkg-utils": "^9.0.0",
+    "@sanity/pkg-utils": "^10.1.1",
+    "@sanity/tsconfig": "^1.0.0",
     "typescript": "5.9.3",
-    "vitest": "^4.0.5"
+    "vitest": "^4.0.14"
   },
   "engines": {
     "node": ">=20.19 <22 || >=22.12"

package/src/compile-schema.test.ts

@@ -1,46 +0,0 @@
-import {describe, expect, test, vi} from 'vitest'
-import {compileSchema} from './compile-schema'
-
-describe(compileSchema.name, () => {
-  describe('block fields', () => {
-    test('reserved fields are ignored and warned about', () => {
-      const consoleWarnSpy = vi
-        .spyOn(console, 'warn')
-        .mockImplementation(() => {})
-
-      expect(
-        compileSchema({block: {fields: [{name: '_type', type: 'string'}]}}),
-      ).toEqual({
-        block: {name: 'block'},
-        span: {name: 'span'},
-        styles: [{value: 'normal', name: 'normal', title: 'Normal'}],
-        lists: [],
-        decorators: [],
-        annotations: [],
-        blockObjects: [],
-        inlineObjects: [],
-      })
-
-      expect(consoleWarnSpy).toHaveBeenCalledWith(
-        '"_type" is a reserved field name on Portable Text blocks',
-      )
-
-      consoleWarnSpy.mockRestore()
-    })
-
-    test('custom fields are included', () => {
-      expect(
-        compileSchema({block: {fields: [{name: 'foo', type: 'string'}]}}),
-      ).toEqual({
-        block: {name: 'block', fields: [{name: 'foo', type: 'string'}]},
-        span: {name: 'span'},
-        styles: [{value: 'normal', name: 'normal', title: 'Normal'}],
-        lists: [],
-        decorators: [],
-        annotations: [],
-        blockObjects: [],
-        inlineObjects: [],
-      })
-    })
-  })
-})

package/src/compile-schema.ts

@@ -1,68 +0,0 @@
-import type {SchemaDefinition} from './define-schema'
-import type {FieldDefinition, Schema} from './schema'
-
-/**
- * @public
- */
-export function compileSchema(definition: SchemaDefinition): Schema {
-  const styles = (definition.styles ?? []).map((style) => ({
-    ...style,
-    value: style.name,
-  }))
-
-  const blockFields: Array<FieldDefinition> = []
-
-  if (definition.block?.fields) {
-    for (const field of definition.block.fields) {
-      if (
-        field.name === '_type' ||
-        field.name === '_key' ||
-        field.name === 'children' ||
-        field.name === 'markDefs' ||
-        field.name === 'style' ||
-        field.name === 'listItem' ||
-        field.name === 'level'
-      ) {
-        console.warn(
-          `"${field.name}" is a reserved field name on Portable Text blocks`,
-        )
-        continue
-      }
-
-      blockFields.push(field)
-    }
-  }
-
-  return {
-    block: {
-      name: definition.block?.name ?? 'block',
-      ...(blockFields.length > 0 ? {fields: blockFields} : {}),
-    },
-    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

@@ -1,94 +0,0 @@
-import type {BaseDefinition, FieldDefinition} from './schema'
-
-/**
- * @public
- */
-export type SchemaDefinition = {
-  block?: {
-    name?: string
-    fields?: ReadonlyArray<FieldDefinition>
-  }
-  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

@@ -1,30 +0,0 @@
-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'
-export {isSpan, isTextBlock, isTypedObject} from './types'
-export type {
-  PortableTextBlock,
-  PortableTextObject,
-  PortableTextSpan,
-  PortableTextTextBlock,
-  TypedObject,
-} from './types'

package/src/schema.ts

@@ -1,87 +0,0 @@
-/**
- * @public
- */
-export type Schema = {
-  block: {
-    name: string
-    fields?: ReadonlyArray<FieldDefinition>
-  }
-  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
-}

package/src/types.ts

@@ -1,103 +0,0 @@
-import type {Schema} from './schema'
-
-/**
- * @public
- */
-export interface TypedObject {
-  [key: string]: unknown
-  _type: string
-}
-
-/**
- * @public
- */
-export function isTypedObject(object: unknown): object is TypedObject {
-  return isRecord(object) && typeof object._type === 'string'
-}
-
-function isRecord(value: unknown): value is Record<string, unknown> {
-  return !!value && (typeof value === 'object' || typeof value === 'function')
-}
-
-/**
- * @public
- */
-export type PortableTextBlock = PortableTextTextBlock | PortableTextObject
-
-/**
- * @public
- */
-export interface PortableTextTextBlock<
-  TChild = PortableTextSpan | PortableTextObject,
-> {
-  _type: string
-  _key: string
-  children: TChild[]
-  markDefs?: PortableTextObject[]
-  listItem?: string
-  style?: string
-  level?: number
-}
-
-/**
- * @public
- */
-export function isTextBlock(
-  context: {schema: Schema},
-  block: unknown,
-): block is PortableTextTextBlock {
-  if (!isTypedObject(block)) {
-    return false
-  }
-
-  if (block._type !== context.schema.block.name) {
-    return false
-  }
-
-  if (!Array.isArray(block.children)) {
-    return false
-  }
-
-  return true
-}
-
-/**
- * @public
- */
-export interface PortableTextSpan {
-  _key: string
-  _type: 'span'
-  text: string
-  marks?: string[]
-}
-
-/**
- * @public
- */
-export function isSpan(
-  context: {schema: Schema},
-  child: unknown,
-): child is PortableTextSpan {
-  if (!isTypedObject(child)) {
-    return false
-  }
-
-  if (child._type !== context.schema.span.name) {
-    return false
-  }
-
-  if (typeof child.text !== 'string') {
-    return false
-  }
-
-  return true
-}
-
-/**
- * @public
- */
-export interface PortableTextObject {
-  _type: string
-  _key: string
-  [other: string]: unknown
-}