@portabletext/schema 2.1.0 → 2.2.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2016 - 2025 Sanity.io
+Copyright (c) 2016 - 2026 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

package/dist/index.d.ts

@@ -66,10 +66,81 @@ type InlineObjectSchemaType = BaseDefinition & {
 };
 /**
  * @public
+ * Describes a member type within an array field's `of`.
+ *
+ * Three forms:
+ * - `BlockOfDefinition` (`type: 'block'`) - declares a nested text block,
+ *   with PTE sub-schema configurable inline.
+ * - `InlineObjectOfDefinition` (`type: 'object'`) - inline-declares an
+ *   object shape at this position. `name` is the type identity; `fields`
+ *   defines the shape.
+ * - `ReferenceOfDefinition` (`type: <name>`) - a bare reference to a type
+ *   declared in `blockObjects` or `inlineObjects` at the schema root.
+ */
+type OfDefinition = BlockOfDefinition | InlineObjectOfDefinition | ReferenceOfDefinition;
+/**
+ * @public
+ * An `of` member with `type: 'block'` -- supports nested PTE sub-schema.
+ *
+ * When this entry appears in a container field's `of`, it declares a nested
+ * text block. Each sub-schema field is inherited from the root schema when
+ * absent, or fully overrides root when defined. Resolution happens at
+ * `compileSchema` time; after compilation, all fields are populated and can
+ * be read directly without merging.
+ */
+type BlockOfDefinition = {
+  type: 'block';
+  name?: string;
+  title?: string;
+  styles?: ReadonlyArray<BaseDefinition>;
+  decorators?: ReadonlyArray<BaseDefinition>;
+  annotations?: ReadonlyArray<BaseDefinition & {
+    fields?: ReadonlyArray<FieldDefinition>;
+  }>;
+  lists?: ReadonlyArray<BaseDefinition>;
+  inlineObjects?: ReadonlyArray<BaseDefinition & {
+    fields?: ReadonlyArray<FieldDefinition>;
+  }>;
+};
+/**
+ * @public
+ * An `of` member with `type: 'object'` -- inline-declares an object shape.
+ *
+ * `name` is the type identity at this position. `fields` defines the shape.
+ * Use this when the type only needs to exist at this nesting position. For
+ * types referenced from multiple positions, declare them once at the schema
+ * root (`blockObjects`) and use a `ReferenceOfDefinition` at each call site.
+ */
+type InlineObjectOfDefinition = {
+  type: 'object';
+  name: string;
+  title?: string;
+  fields: ReadonlyArray<FieldDefinition>;
+};
+/**
+ * @public
+ * An `of` member referencing a type declared elsewhere by name.
+ *
+ * `type` is the lookup key. Resolves to the matching entry in the schema's
+ * `blockObjects` or `inlineObjects`. Self-references and cycles are
+ * supported via cycle detection on the resolver walk.
+ *
+ * Throws at `compileSchema` time when the referenced type isn't declared.
  */
-type FieldDefinition = BaseDefinition & {
-  type: 'string' | 'number' | 'boolean' | 'array' | 'object';
+type ReferenceOfDefinition = {
+  type: string;
+  name?: string;
+  title?: string;
 };
+/**
+ * @public
+ */
+type FieldDefinition = (BaseDefinition & {
+  type: 'array';
+  of?: ReadonlyArray<OfDefinition>;
+}) | (BaseDefinition & {
+  type: 'string' | 'number' | 'boolean' | 'object';
+});
 /**
  * @public
  */
@@ -150,6 +221,25 @@ type InlineObjectDefinition<TBaseDefinition extends BaseDefinition = BaseDefinit
  * @public
  */
 declare function compileSchema(definition: SchemaDefinition): Schema;
+/**
+ * Derive the resolved sub-schema for a container field's `of` declaration.
+ *
+ * Containers declare which types are allowed inside them via the `of`
+ * array on a child field. `getSubSchema(schema, of)` returns the resolved
+ * `Schema` view that applies inside such a container, so operations and
+ * validators that ask "what's allowed at this position?" can treat the
+ * result like any other top-level `Schema`.
+ *
+ * The `{type: 'block'}` entry (if present) supplies the resolved
+ * styles, decorators, annotations, lists, and inlineObjects. Non-block
+ * `of` members become the schema's block objects. When there is no
+ * `{type: 'block'}` entry the returned schema still carries the root
+ * schema's `block` and `span` names but every validation list is
+ * empty.
+ *
+ * @public
+ */
+declare function getSubSchema(schema: Schema, of: ReadonlyArray<OfDefinition>): Schema;
 /**
  * @public
  */
@@ -217,5 +307,5 @@ interface PortableTextListBlock extends PortableTextTextBlock {
   listItem: string;
   level: number;
 }
-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 PortableTextChild, type PortableTextListBlock, 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 BlockOfDefinition, type DecoratorDefinition, type DecoratorSchemaType, type FieldDefinition, type InlineObjectDefinition, type InlineObjectOfDefinition, type InlineObjectSchemaType, type ListDefinition, type ListSchemaType, type OfDefinition, type PortableTextBlock, type PortableTextChild, type PortableTextListBlock, type PortableTextObject, type PortableTextSpan, type PortableTextTextBlock, type ReferenceOfDefinition, type Schema, type SchemaDefinition, type StyleDefinition, type StyleSchemaType, type TypedObject, compileSchema, defineSchema, getSubSchema, isSpan, isTextBlock, isTypedObject };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +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;;;AAQd;;AAC2C,KEwD/B,iBAAA,GAAoB,gBFxDW,GEwDQ,kBFxDR;;;AAM3C;AAC0B,UEsDT,qBAAA,SAA8B,qBFtDrB,CAAA;EAAiB,QAAA,EAAA,MAAA;EACvC,KAAA,EAAA,MAAA"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/schema.ts","../src/define-schema.ts","../src/compile-schema.ts","../src/get-sub-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;;AAgBV;;EAEI,KAAA,EAAA,MAAA;CACA;;AAYJ;;AAIW,KA7DC,mBAAA,GAAsB,cA6DvB,GAAA;EACkB;;;;EAEE,KAAA,EAAA,MAAA;CADf;;;;AAK6B,KAzDjC,oBAAA,GAAuB,cAyDU,GAAA;EAAd,MAAA,EAxDrB,aAwDqB,CAxDP,eAwDO,CAAA;CADb;;AAclB;AAiBA;AASY,KAzFA,qBAAA,GAAwB,cAyFT,GAAA;EACtB,MAAA,EAzFK,aAyFL,CAzFmB,eAyFnB,CAAA;CAEoB;;;;AASb,KA9FA,sBAAA,GAAyB,cA8FX,GAAA;UA7FhB,cAAc;ACjExB,CAAA;;;;;;;;;;;;;;AAUkB,KDuEN,YAAA,GACR,iBCxEc,GDyEd,wBCzEc,GD0Ed,qBC1Ec;;AA0BlB;;;;;AASA;;;;AAEmB,KDiDP,iBAAA,GCjDO;EAKP,IAAA,EAAA,OAAA;EACc,IAAA,CAAA,EAAA,MAAA;EAAiB,KAAA,CAAA,EAAA,MAAA;EACvC,MAAA,CAAA,ED8CO,aC9CP,CD8CqB,cC9CrB,CAAA;EAAe,UAAA,CAAA,ED+CJ,aC/CI,CD+CU,cC/CV,CAAA;EAKP,WAAA,CAAA,ED2CI,aC3Ce,CD4C3B,cC5C2B,GAAA;IACL,MAAA,CAAA,ED2CK,aC3CL,CD2CmB,eC3CnB,CAAA;EAAiB,CAAA,CAAA;EACvC,KAAA,CAAA,ED4CM,aC5CN,CD4CoB,cC5CpB,CAAA;EAAe,aAAA,CAAA,ED6CD,aC7CC,CD8Cf,cC9Ce,GAAA;IAKP,MAAA,CAAA,EDyCmB,aCzCC,CDyCa,eCzCb,CAAA;EACN,CAAA,CAAA;CAAiB;;;;;AAQ3C;;;;;AAGW,KD0CC,wBAAA,GC1CD;EAAa,IAAA,EAAA,QAAA;EAMZ,IAAA,EAAA,MAAA;EACc,KAAA,CAAA,EAAA,MAAA;EAAiB,MAAA,EDuCjC,aCvCiC,CDuCnB,eCvCmB,CAAA;CACvC;;;;;ACiCJ;;ACxDA;;;;AAGG,KHuES,qBAAA,GGvET;EAAM,IAAA,EAAA,MAAA;;EClEQ,KAAA,CAAA,EAAA,MAAW;AAQ5B,CAAA;AAWA;AAKA;;AAC8B,KJyHlB,eAAA,GIzHkB,CJ0HzB,cI1HyB,GAAA;EAIlB,IAAA,EAAA,OAAA;EACC,EAAA,CAAA,EJuHF,aIvHE,CJuHY,YIvHZ,CAAA;CAAkB,CAAA,GAAA,CJyH1B,cIzH0B,GAAA;EASf,IAAA,EAAA,QAAW,GAAA,QAAA,GACP,SAER,GAAA,QAAA;AAmBZ,CAAA,CAAA;AAUA;AAsBA;AASA;AAKiB,KJmDL,cAAA,GInD2B;;;;;;;AJrG7B,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;;;;;AAiBA;;;;;AAeY,iBC5DI,YD4Da,CAAA,gCC5DgC,gBD4DhC,CAAA,CAAA,UAAA,EC3Df,iBD2De,CAAA,EC1D1B,iBD0D0B;;;;AAKd,KCxDH,eDwDG,CAAA,wBCvDW,cDuDX,GCvD4B,cDuD5B,CAAA,GCtDX,eDsDW;;;;AACC,KClDJ,cDkDI,CAAA,wBCjDU,cDiDV,GCjD2B,cDiD3B,CAAA,GChDZ,eDgDY;;;;AAK6B,KChDjC,mBDgDiC,CAAA,wBC/CnB,cD+CmB,GC/CF,cD+CE,CAAA,GC9CzC,eD8CyC;;;;AAajC,KCtDA,oBDsDwB,CAAA,wBCrDV,cDyDhB,GCzDiC,cDyDpB,CAAA,GCxDnB,eDwDmB,GAAA;EAaX,MAAA,CAAA,ECpED,aDoEC,CCpEa,eDoEQ,CAAA;AASjC,CAAA;;;;AAKK,KC5EO,qBD4EP,CAAA,wBC3EqB,cD2ErB,GC3EsC,cD2EtC,CAAA,GC1ED,eD0EC,GAAA;EAAc,MAAA,CAAA,ECzER,aDyEQ,CCzEM,eDyEN,CAAA;AAOnB,CAAA;;AC9JA;;AAGa,KAiFD,sBAjFC,CAAA,wBAkFa,cAlFb,GAkF8B,cAlF9B,CAAA,GAmFT,eAnFS,GAAA;EAEY,MAAA,CAAA,EAkFd,aAlFc,CAkFA,eAlFA,CAAA;CAAd;;;;ADEY,iBEgHP,aAAA,CFhHO,UAAA,EEgHmB,gBFhHnB,CAAA,EEgHsC,MFhHtC;;;;;;;;;;;;;;;;AAUvB;AAWA;AAWA;AAWY,iBGaI,YAAA,CHbgB,MAAA,EGctB,MHdsB,EAAA,EAAA,EGe1B,aHf0B,CGeZ,YHfY,CAAA,CAAA,EGgB7B,MHhB6B;;;;AA5CtB,UINO,WAAA,CJMP;EACa,CAAA,GAAA,EAAA,MAAA,CAAA,EAAA,OAAA;EAAd,KAAA,EAAA,MAAA;;;;;AAGqB,iBIFd,aAAA,CJEc,MAAA,EAAA,OAAA,CAAA,EAAA,MAAA,IIF4B,WJE5B;;;;AACA,KIQlB,iBAAA,GAAoB,qBJRF,GIQ0B,kBJR1B;AAM9B;AAWA;AAWA;AAWY,UI1BK,qBJ0Be,CAAA,SIzBrB,gBJyBqB,GIzBF,kBJyBE,CAAA,CAAA;EAAG,KAAA,EAAA,MAAA;EACX,IAAA,EAAA,MAAA;EAAd,QAAA,EItBE,MJsBF,EAAA;EAAa,QAAA,CAAA,EIrBV,kBJqBU,EAAA;EAMX,QAAA,CAAA,EAAA,MAAA;EAAwB,KAAA,CAAA,EAAA,MAAA;EACZ,KAAA,CAAA,EAAA,MAAA;;;AAMxB;;AACwB,iBI1BR,WAAA,CJ0BQ,OAAA,EAAA;EAAd,MAAA,EIzBU,MJyBV;CAAa,EAAA,KAAA,EAAA,OAAA,CAAA,EAAA,KAAA,IIvBX,qBJuBW;AAgBvB;;;AAGI,UIvBa,gBAAA,CJuBb;EAAqB,IAAA,EAAA,MAAA;EAYb,KAAA,EAAA,MAAA;EAIa,IAAA,EAAA,MAAA;EAAd,KAAA,CAAA,EAAA,MAAA,EAAA;;;;;AAGoB,iBIhCf,MAAA,CJgCe,OAAA,EAAA;EADf,MAAA,EI9BI,MJ8BJ;CAGQ,EAAA,KAAA,EAAA,OAAA,CAAA,EAAA,KAAA,II/BZ,gBJ+BY;;;;AAEO,UIdd,kBAAA,CJcc;EADb,KAAA,EAAA,MAAA;EAAa,IAAA,EAAA,MAAA;EAcnB,CAAA,KAAA,EAAA,MAAA,CAAA,EAAA,OAAA;AAiBZ;AASA;;;AAGW,KI/CC,iBAAA,GAAoB,gBJ+CrB,GI/CwC,kBJ+CxC;;;AASX;UInDiB,qBAAA,SAA8B;EH3GnC,QAAA,EAAA,MAAA;EAGe,KAAA,EAAA,MAAA"}

package/dist/index.js

@@ -1,8 +1,75 @@
+function isBlockOfMember(member) {
+  return member.type === "block";
+}
+function isInlineObjectOfMember(member) {
+  return member.type === "object";
+}
+function compileOfMember(member, inheritance) {
+  return isBlockOfMember(member) ? compileBlockOfMember(member, inheritance) : isInlineObjectOfMember(member) ? compileInlineObjectOfMember(member, inheritance) : member;
+}
+function compileBlockOfMember(member, inheritance) {
+  return {
+    ...member,
+    styles: member.styles ? member.styles.map((style) => ({ ...style, value: style.name })) : inheritance.styles,
+    decorators: member.decorators ? member.decorators.map((decorator) => ({
+      ...decorator,
+      value: decorator.name
+    })) : inheritance.decorators,
+    annotations: member.annotations ? member.annotations.map((annotation) => ({
+      ...annotation,
+      fields: annotation.fields?.map(
+        (field) => compileField(field, inheritance)
+      ) ?? []
+    })) : inheritance.annotations,
+    lists: member.lists ? member.lists.map((list) => ({ ...list, value: list.name })) : inheritance.lists,
+    inlineObjects: member.inlineObjects ? member.inlineObjects.map((inlineObject) => ({
+      ...inlineObject,
+      fields: inlineObject.fields?.map(
+        (field) => compileField(field, inheritance)
+      ) ?? []
+    })) : inheritance.inlineObjects
+  };
+}
+function compileInlineObjectOfMember(member, inheritance) {
+  return {
+    ...member,
+    fields: member.fields.map((field) => compileField(field, inheritance))
+  };
+}
+function compileField(field, inheritance) {
+  return field.type === "array" && field.of ? {
+    ...field,
+    of: field.of.map((member) => compileOfMember(member, inheritance))
+  } : field;
+}
+function compileBaseDefinitionWithValue(definition) {
+  return { ...definition, value: definition.name };
+}
 function compileSchema(definition) {
-  const styles = (definition.styles ?? []).map((style) => ({
-    ...style,
-    value: style.name
-  })), blockFields = [];
+  const userStyles = (definition.styles ?? []).map(
+    compileBaseDefinitionWithValue
+  ), styles = userStyles.some((style) => style.value === "normal") ? userStyles : [
+    { value: "normal", name: "normal", title: "Normal" },
+    ...userStyles
+  ], lists = (definition.lists ?? []).map(compileBaseDefinitionWithValue), decorators = (definition.decorators ?? []).map(
+    compileBaseDefinitionWithValue
+  ), annotationsShallow = (definition.annotations ?? []).map(
+    (annotation) => ({
+      ...annotation,
+      fields: annotation.fields ?? []
+    })
+  ), inlineObjectsShallow = (definition.inlineObjects ?? []).map(
+    (inlineObject) => ({
+      ...inlineObject,
+      fields: inlineObject.fields ?? []
+    })
+  ), inheritance = {
+    styles,
+    decorators,
+    annotations: annotationsShallow,
+    lists,
+    inlineObjects: inlineObjectsShallow
+  }, blockFields = [];
   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") {
@@ -11,7 +78,7 @@ function compileSchema(definition) {
         );
         continue;
       }
-      blockFields.push(field);
+      blockFields.push(compileField(field, inheritance));
     }
   return {
     block: {
@@ -21,29 +88,69 @@ function compileSchema(definition) {
     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
-    })),
+    styles,
+    lists,
+    decorators,
     annotations: (definition.annotations ?? []).map((annotation) => ({
       ...annotation,
-      fields: annotation.fields ?? []
+      fields: annotation.fields?.map((field) => compileField(field, inheritance)) ?? []
     })),
     blockObjects: (definition.blockObjects ?? []).map((blockObject) => ({
       ...blockObject,
-      fields: blockObject.fields ?? []
+      fields: blockObject.fields?.map((field) => compileField(field, inheritance)) ?? []
     })),
     inlineObjects: (definition.inlineObjects ?? []).map((inlineObject) => ({
       ...inlineObject,
-      fields: inlineObject.fields ?? []
+      fields: inlineObject.fields?.map((field) => compileField(field, inheritance)) ?? []
     }))
   };
 }
+function asNamedTypes(resolved) {
+  if (resolved)
+    return resolved.map((entry) => ({ ...entry, value: entry.name }));
+}
+function asFieldedTypes(resolved) {
+  if (resolved)
+    return resolved.map(
+      (entry) => ({ ...entry, fields: entry.fields ?? [] })
+    );
+}
+function getSubSchema(schema, of) {
+  const blockMember = of.find(
+    (member) => member.type === "block"
+  ), blockObjects = of.filter(
+    (member) => member.type !== "block"
+  ).map((member) => {
+    const objectMember = member;
+    return {
+      name: objectMember.name ?? objectMember.type,
+      title: objectMember.title,
+      fields: objectMember.fields ?? []
+    };
+  });
+  return blockMember ? {
+    block: {
+      name: blockMember.name ?? schema.block.name,
+      fields: schema.block.fields
+    },
+    span: { name: schema.span.name },
+    styles: asNamedTypes(blockMember.styles) ?? schema.styles,
+    decorators: asNamedTypes(blockMember.decorators) ?? schema.decorators,
+    annotations: asFieldedTypes(blockMember.annotations) ?? schema.annotations,
+    lists: asNamedTypes(blockMember.lists) ?? schema.lists,
+    inlineObjects: asFieldedTypes(blockMember.inlineObjects) ?? schema.inlineObjects,
+    blockObjects
+  } : {
+    block: { name: schema.block.name, fields: schema.block.fields },
+    span: { name: schema.span.name },
+    styles: [],
+    decorators: [],
+    annotations: [],
+    lists: [],
+    inlineObjects: [],
+    blockObjects
+  };
+}
 function defineSchema(definition) {
   return definition;
 }
@@ -62,6 +169,7 @@ function isSpan(context, child) {
 export {
   compileSchema,
   defineSchema,
+  getSubSchema,
   isSpan,
   isTextBlock,
   isTypedObject

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../src/compile-schema.ts","../src/define-schema.ts","../src/types.ts"],"sourcesContent":["import type {SchemaDefinition} from './define-schema'\nimport type {FieldDefinition, 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  const blockFields: Array<FieldDefinition> = []\n\n  if (definition.block?.fields) {\n    for (const field of definition.block.fields) {\n      if (\n        field.name === '_type' ||\n        field.name === '_key' ||\n        field.name === 'children' ||\n        field.name === 'markDefs' ||\n        field.name === 'style' ||\n        field.name === 'listItem' ||\n        field.name === 'level'\n      ) {\n        console.warn(\n          `\"${field.name}\" is a reserved field name on Portable Text blocks`,\n        )\n        continue\n      }\n\n      blockFields.push(field)\n    }\n  }\n\n  return {\n    block: {\n      name: definition.block?.name ?? 'block',\n      ...(blockFields.length > 0 ? {fields: blockFields} : {}),\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    fields?: ReadonlyArray<FieldDefinition>\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","import type {Schema} from './schema'\n\n/**\n * @public\n */\nexport interface TypedObject {\n  [key: string]: unknown\n  _type: string\n}\n\n/**\n * @public\n */\nexport function isTypedObject(object: unknown): object is TypedObject {\n  return isRecord(object) && typeof object._type === 'string'\n}\n\nfunction isRecord(value: unknown): value is Record<string, unknown> {\n  return !!value && (typeof value === 'object' || typeof value === 'function')\n}\n\n/**\n * @public\n */\nexport type PortableTextBlock = PortableTextTextBlock | PortableTextObject\n\n/**\n * @public\n */\nexport interface PortableTextTextBlock<\n  TChild = PortableTextSpan | PortableTextObject,\n> {\n  _type: string\n  _key: string\n  children: TChild[]\n  markDefs?: PortableTextObject[]\n  listItem?: string\n  style?: string\n  level?: number\n}\n\n/**\n * @public\n */\nexport function isTextBlock(\n  context: {schema: Schema},\n  block: unknown,\n): block is PortableTextTextBlock {\n  if (!isTypedObject(block)) {\n    return false\n  }\n\n  if (block._type !== context.schema.block.name) {\n    return false\n  }\n\n  if (!Array.isArray(block.children)) {\n    return false\n  }\n\n  return true\n}\n\n/**\n * @public\n */\nexport interface PortableTextSpan {\n  _key: string\n  _type: 'span'\n  text: string\n  marks?: string[]\n}\n\n/**\n * @public\n */\nexport function isSpan(\n  context: {schema: Schema},\n  child: unknown,\n): child is PortableTextSpan {\n  if (!isTypedObject(child)) {\n    return false\n  }\n\n  if (child._type !== context.schema.span.name) {\n    return false\n  }\n\n  if (typeof child.text !== 'string') {\n    return false\n  }\n\n  return true\n}\n\n/**\n * @public\n */\nexport interface PortableTextObject {\n  _type: string\n  _key: string\n  [other: string]: unknown\n}\n\n/**\n * @public\n */\nexport type PortableTextChild = PortableTextSpan | PortableTextObject\n\n/**\n * @public\n */\nexport interface PortableTextListBlock extends PortableTextTextBlock {\n  listItem: string\n  level: number\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,GAEI,cAAsC,CAAA;AAE5C,MAAI,WAAW,OAAO;AACpB,eAAW,SAAS,WAAW,MAAM,QAAQ;AAC3C,UACE,MAAM,SAAS,WACf,MAAM,SAAS,UACf,MAAM,SAAS,cACf,MAAM,SAAS,cACf,MAAM,SAAS,WACf,MAAM,SAAS,cACf,MAAM,SAAS,SACf;AACA,gBAAQ;AAAA,UACN,IAAI,MAAM,IAAI;AAAA,QAAA;AAEhB;AAAA,MACF;AAEA,kBAAY,KAAK,KAAK;AAAA,IACxB;AAGF,SAAO;AAAA,IACL,OAAO;AAAA,MACL,MAAM,WAAW,OAAO,QAAQ;AAAA,MAChC,GAAI,YAAY,SAAS,IAAI,EAAC,QAAQ,YAAA,IAAe,CAAA;AAAA,IAAC;AAAA,IAExD,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;AC1BO,SAAS,aACd,YACmB;AACnB,SAAO;AACT;AChCO,SAAS,cAAc,QAAwC;AACpE,SAAO,SAAS,MAAM,KAAK,OAAO,OAAO,SAAU;AACrD;AAEA,SAAS,SAAS,OAAkD;AAClE,SAAO,CAAC,CAAC,UAAU,OAAO,SAAU,YAAY,OAAO,SAAU;AACnE;AAyBO,SAAS,YACd,SACA,OACgC;AAShC,SARI,EAAA,CAAC,cAAc,KAAK,KAIpB,MAAM,UAAU,QAAQ,OAAO,MAAM,QAIrC,CAAC,MAAM,QAAQ,MAAM,QAAQ;AAKnC;AAeO,SAAS,OACd,SACA,OAC2B;AAS3B,SARI,EAAA,CAAC,cAAc,KAAK,KAIpB,MAAM,UAAU,QAAQ,OAAO,KAAK,QAIpC,OAAO,MAAM,QAAS;AAK5B;"}
+{"version":3,"file":"index.js","sources":["../src/compile-schema.ts","../src/get-sub-schema.ts","../src/define-schema.ts","../src/types.ts"],"sourcesContent":["import type {SchemaDefinition} from './define-schema'\nimport type {\n  AnnotationSchemaType,\n  BaseDefinition,\n  BlockOfDefinition,\n  DecoratorSchemaType,\n  FieldDefinition,\n  InlineObjectOfDefinition,\n  InlineObjectSchemaType,\n  ListSchemaType,\n  OfDefinition,\n  Schema,\n  StyleSchemaType,\n} from './schema'\n\n/**\n * Resolved root schema fields used to fill in unspecified fields on nested\n * `BlockOfDefinition` entries. This is a view into the root schema captured\n * before the `of` tree is walked, so nested blocks inherit the final\n * post-compile values (e.g. `styles` with `normal` prepended).\n */\ntype BlockInheritance = {\n  styles: ReadonlyArray<StyleSchemaType>\n  decorators: ReadonlyArray<DecoratorSchemaType>\n  annotations: ReadonlyArray<AnnotationSchemaType>\n  lists: ReadonlyArray<ListSchemaType>\n  inlineObjects: ReadonlyArray<InlineObjectSchemaType>\n}\n\nfunction isBlockOfMember(member: OfDefinition): member is BlockOfDefinition {\n  return member.type === 'block'\n}\n\nfunction isInlineObjectOfMember(\n  member: OfDefinition,\n): member is InlineObjectOfDefinition {\n  return member.type === 'object'\n}\n\nfunction compileOfMember(\n  member: OfDefinition,\n  inheritance: BlockInheritance,\n): OfDefinition {\n  if (isBlockOfMember(member)) {\n    return compileBlockOfMember(member, inheritance)\n  }\n  if (isInlineObjectOfMember(member)) {\n    return compileInlineObjectOfMember(member, inheritance)\n  }\n  // Reference: pass through unchanged. The resolver looks up by `type`.\n  return member\n}\n\nfunction compileBlockOfMember(\n  member: BlockOfDefinition,\n  inheritance: BlockInheritance,\n): BlockOfDefinition {\n  return {\n    ...member,\n    styles: member.styles\n      ? member.styles.map((style) => ({...style, value: style.name}))\n      : inheritance.styles,\n    decorators: member.decorators\n      ? member.decorators.map((decorator) => ({\n          ...decorator,\n          value: decorator.name,\n        }))\n      : inheritance.decorators,\n    annotations: member.annotations\n      ? member.annotations.map((annotation) => ({\n          ...annotation,\n          fields:\n            annotation.fields?.map((field) =>\n              compileField(field, inheritance),\n            ) ?? [],\n        }))\n      : inheritance.annotations,\n    lists: member.lists\n      ? member.lists.map((list) => ({...list, value: list.name}))\n      : inheritance.lists,\n    inlineObjects: member.inlineObjects\n      ? member.inlineObjects.map((inlineObject) => ({\n          ...inlineObject,\n          fields:\n            inlineObject.fields?.map((field) =>\n              compileField(field, inheritance),\n            ) ?? [],\n        }))\n      : inheritance.inlineObjects,\n  }\n}\n\nfunction compileInlineObjectOfMember(\n  member: InlineObjectOfDefinition,\n  inheritance: BlockInheritance,\n): InlineObjectOfDefinition {\n  return {\n    ...member,\n    fields: member.fields.map((field) => compileField(field, inheritance)),\n  }\n}\n\nfunction compileField(\n  field: FieldDefinition,\n  inheritance: BlockInheritance,\n): FieldDefinition {\n  if (field.type === 'array' && field.of) {\n    return {\n      ...field,\n      of: field.of.map((member) => compileOfMember(member, inheritance)),\n    }\n  }\n  return field\n}\n\nfunction compileBaseDefinitionWithValue<T extends BaseDefinition>(\n  definition: T,\n): T & {value: string} {\n  return {...definition, value: definition.name}\n}\n\n/**\n * @public\n */\nexport function compileSchema(definition: SchemaDefinition): Schema {\n  const userStyles = (definition.styles ?? []).map(\n    compileBaseDefinitionWithValue,\n  )\n  const styles = !userStyles.some((style) => style.value === 'normal')\n    ? [\n        {value: 'normal', name: 'normal', title: 'Normal'} as StyleSchemaType,\n        ...userStyles,\n      ]\n    : userStyles\n\n  const lists = (definition.lists ?? []).map(compileBaseDefinitionWithValue)\n  const decorators = (definition.decorators ?? []).map(\n    compileBaseDefinitionWithValue,\n  )\n\n  // Annotations and inline objects may contain array fields whose `of`\n  // includes `{type: 'block'}`. Those nested blocks must inherit from the\n  // fully-resolved root. So we build `inheritance` first using the shallow\n  // (not-yet-resolved) annotations/inlineObjects — nested blocks inherit from\n  // the top-level schema, not from a sibling annotation's schema. Then we\n  // resolve annotations, block objects, and inline objects using that view.\n  const annotationsShallow = (definition.annotations ?? []).map(\n    (annotation) => ({\n      ...annotation,\n      fields: (annotation.fields ?? []) as ReadonlyArray<FieldDefinition>,\n    }),\n  )\n  const inlineObjectsShallow = (definition.inlineObjects ?? []).map(\n    (inlineObject) => ({\n      ...inlineObject,\n      fields: (inlineObject.fields ?? []) as ReadonlyArray<FieldDefinition>,\n    }),\n  )\n\n  const inheritance: BlockInheritance = {\n    styles,\n    decorators,\n    annotations: annotationsShallow,\n    lists,\n    inlineObjects: inlineObjectsShallow,\n  }\n\n  const blockFields: Array<FieldDefinition> = []\n\n  if (definition.block?.fields) {\n    for (const field of definition.block.fields) {\n      if (\n        field.name === '_type' ||\n        field.name === '_key' ||\n        field.name === 'children' ||\n        field.name === 'markDefs' ||\n        field.name === 'style' ||\n        field.name === 'listItem' ||\n        field.name === 'level'\n      ) {\n        console.warn(\n          `\"${field.name}\" is a reserved field name on Portable Text blocks`,\n        )\n        continue\n      }\n\n      blockFields.push(compileField(field, inheritance))\n    }\n  }\n\n  return {\n    block: {\n      name: definition.block?.name ?? 'block',\n      ...(blockFields.length > 0 ? {fields: blockFields} : {}),\n    },\n    span: {\n      name: 'span',\n    },\n    styles,\n    lists,\n    decorators,\n    annotations: (definition.annotations ?? []).map((annotation) => ({\n      ...annotation,\n      fields:\n        annotation.fields?.map((field) => compileField(field, inheritance)) ??\n        [],\n    })),\n    blockObjects: (definition.blockObjects ?? []).map((blockObject) => ({\n      ...blockObject,\n      fields:\n        blockObject.fields?.map((field) => compileField(field, inheritance)) ??\n        [],\n    })),\n    inlineObjects: (definition.inlineObjects ?? []).map((inlineObject) => ({\n      ...inlineObject,\n      fields:\n        inlineObject.fields?.map((field) => compileField(field, inheritance)) ??\n        [],\n    })),\n  }\n}\n","import type {\n  AnnotationSchemaType,\n  BaseDefinition,\n  BlockObjectSchemaType,\n  DecoratorSchemaType,\n  InlineObjectSchemaType,\n  ListSchemaType,\n  OfDefinition,\n  Schema,\n  StyleSchemaType,\n} from './schema'\n\ntype ResolvedBlockOfDefinition = {\n  type: 'block'\n  name?: string\n  styles?: ReadonlyArray<BaseDefinition>\n  decorators?: ReadonlyArray<BaseDefinition>\n  annotations?: ReadonlyArray<\n    BaseDefinition & {fields?: ReadonlyArray<unknown>}\n  >\n  lists?: ReadonlyArray<BaseDefinition>\n  inlineObjects?: ReadonlyArray<\n    BaseDefinition & {fields?: ReadonlyArray<unknown>}\n  >\n}\n\nfunction asNamedTypes<\n  T extends StyleSchemaType | DecoratorSchemaType | ListSchemaType,\n>(resolved: ReadonlyArray<BaseDefinition> | undefined): Array<T> | undefined {\n  if (!resolved) {\n    return undefined\n  }\n  return resolved.map((entry) => ({...entry, value: entry.name}) as T)\n}\n\nfunction asFieldedTypes<\n  T extends AnnotationSchemaType | InlineObjectSchemaType,\n>(\n  resolved:\n    | ReadonlyArray<BaseDefinition & {fields?: ReadonlyArray<unknown>}>\n    | undefined,\n): Array<T> | undefined {\n  if (!resolved) {\n    return undefined\n  }\n  return resolved.map(\n    (entry) => ({...entry, fields: entry.fields ?? []}) as unknown as T,\n  )\n}\n\n/**\n * Derive the resolved sub-schema for a container field's `of` declaration.\n *\n * Containers declare which types are allowed inside them via the `of`\n * array on a child field. `getSubSchema(schema, of)` returns the resolved\n * `Schema` view that applies inside such a container, so operations and\n * validators that ask \"what's allowed at this position?\" can treat the\n * result like any other top-level `Schema`.\n *\n * The `{type: 'block'}` entry (if present) supplies the resolved\n * styles, decorators, annotations, lists, and inlineObjects. Non-block\n * `of` members become the schema's block objects. When there is no\n * `{type: 'block'}` entry the returned schema still carries the root\n * schema's `block` and `span` names but every validation list is\n * empty.\n *\n * @public\n */\nexport function getSubSchema(\n  schema: Schema,\n  of: ReadonlyArray<OfDefinition>,\n): Schema {\n  const blockMember = of.find(\n    (member): member is OfDefinition & ResolvedBlockOfDefinition =>\n      member.type === 'block',\n  )\n\n  const blockObjects: ReadonlyArray<BlockObjectSchemaType> = of\n    .filter(\n      (member): member is OfDefinition & {type: string} =>\n        member.type !== 'block',\n    )\n    .map((member) => {\n      const objectMember = member as {\n        type: string\n        name?: string\n        title?: string\n        fields?: ReadonlyArray<unknown>\n      }\n      return {\n        name: objectMember.name ?? objectMember.type,\n        title: objectMember.title,\n        fields: (objectMember.fields ?? []) as BlockObjectSchemaType['fields'],\n      }\n    })\n\n  if (!blockMember) {\n    return {\n      block: {name: schema.block.name, fields: schema.block.fields},\n      span: {name: schema.span.name},\n      styles: [],\n      decorators: [],\n      annotations: [],\n      lists: [],\n      inlineObjects: [],\n      blockObjects,\n    }\n  }\n\n  return {\n    block: {\n      name: blockMember.name ?? schema.block.name,\n      fields: schema.block.fields,\n    },\n    span: {name: schema.span.name},\n    styles: asNamedTypes<StyleSchemaType>(blockMember.styles) ?? schema.styles,\n    decorators:\n      asNamedTypes<DecoratorSchemaType>(blockMember.decorators) ??\n      schema.decorators,\n    annotations:\n      asFieldedTypes<AnnotationSchemaType>(blockMember.annotations) ??\n      schema.annotations,\n    lists: asNamedTypes<ListSchemaType>(blockMember.lists) ?? schema.lists,\n    inlineObjects:\n      asFieldedTypes<InlineObjectSchemaType>(blockMember.inlineObjects) ??\n      schema.inlineObjects,\n    blockObjects,\n  }\n}\n","import type {BaseDefinition, FieldDefinition} from './schema'\n\n/**\n * @public\n */\nexport type SchemaDefinition = {\n  block?: {\n    name?: string\n    fields?: ReadonlyArray<FieldDefinition>\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","import type {Schema} from './schema'\n\n/**\n * @public\n */\nexport interface TypedObject {\n  [key: string]: unknown\n  _type: string\n}\n\n/**\n * @public\n */\nexport function isTypedObject(object: unknown): object is TypedObject {\n  return isRecord(object) && typeof object._type === 'string'\n}\n\nfunction isRecord(value: unknown): value is Record<string, unknown> {\n  return !!value && (typeof value === 'object' || typeof value === 'function')\n}\n\n/**\n * @public\n */\nexport type PortableTextBlock = PortableTextTextBlock | PortableTextObject\n\n/**\n * @public\n */\nexport interface PortableTextTextBlock<\n  TChild = PortableTextSpan | PortableTextObject,\n> {\n  _type: string\n  _key: string\n  children: TChild[]\n  markDefs?: PortableTextObject[]\n  listItem?: string\n  style?: string\n  level?: number\n}\n\n/**\n * @public\n */\nexport function isTextBlock(\n  context: {schema: Schema},\n  block: unknown,\n): block is PortableTextTextBlock {\n  if (!isTypedObject(block)) {\n    return false\n  }\n\n  if (block._type !== context.schema.block.name) {\n    return false\n  }\n\n  if (!Array.isArray(block.children)) {\n    return false\n  }\n\n  return true\n}\n\n/**\n * @public\n */\nexport interface PortableTextSpan {\n  _key: string\n  _type: 'span'\n  text: string\n  marks?: string[]\n}\n\n/**\n * @public\n */\nexport function isSpan(\n  context: {schema: Schema},\n  child: unknown,\n): child is PortableTextSpan {\n  if (!isTypedObject(child)) {\n    return false\n  }\n\n  if (child._type !== context.schema.span.name) {\n    return false\n  }\n\n  if (typeof child.text !== 'string') {\n    return false\n  }\n\n  return true\n}\n\n/**\n * @public\n */\nexport interface PortableTextObject {\n  _type: string\n  _key: string\n  [other: string]: unknown\n}\n\n/**\n * @public\n */\nexport type PortableTextChild = PortableTextSpan | PortableTextObject\n\n/**\n * @public\n */\nexport interface PortableTextListBlock extends PortableTextTextBlock {\n  listItem: string\n  level: number\n}\n"],"names":[],"mappings":"AA6BA,SAAS,gBAAgB,QAAmD;AAC1E,SAAO,OAAO,SAAS;AACzB;AAEA,SAAS,uBACP,QACoC;AACpC,SAAO,OAAO,SAAS;AACzB;AAEA,SAAS,gBACP,QACA,aACc;AACd,SAAI,gBAAgB,MAAM,IACjB,qBAAqB,QAAQ,WAAW,IAE7C,uBAAuB,MAAM,IACxB,4BAA4B,QAAQ,WAAW,IAGjD;AACT;AAEA,SAAS,qBACP,QACA,aACmB;AACnB,SAAO;AAAA,IACL,GAAG;AAAA,IACH,QAAQ,OAAO,SACX,OAAO,OAAO,IAAI,CAAC,WAAW,EAAC,GAAG,OAAO,OAAO,MAAM,KAAA,EAAM,IAC5D,YAAY;AAAA,IAChB,YAAY,OAAO,aACf,OAAO,WAAW,IAAI,CAAC,eAAe;AAAA,MACpC,GAAG;AAAA,MACH,OAAO,UAAU;AAAA,IAAA,EACjB,IACF,YAAY;AAAA,IAChB,aAAa,OAAO,cAChB,OAAO,YAAY,IAAI,CAAC,gBAAgB;AAAA,MACtC,GAAG;AAAA,MACH,QACE,WAAW,QAAQ;AAAA,QAAI,CAAC,UACtB,aAAa,OAAO,WAAW;AAAA,MAAA,KAC5B,CAAA;AAAA,IAAC,EACR,IACF,YAAY;AAAA,IAChB,OAAO,OAAO,QACV,OAAO,MAAM,IAAI,CAAC,UAAU,EAAC,GAAG,MAAM,OAAO,KAAK,KAAA,EAAM,IACxD,YAAY;AAAA,IAChB,eAAe,OAAO,gBAClB,OAAO,cAAc,IAAI,CAAC,kBAAkB;AAAA,MAC1C,GAAG;AAAA,MACH,QACE,aAAa,QAAQ;AAAA,QAAI,CAAC,UACxB,aAAa,OAAO,WAAW;AAAA,MAAA,KAC5B,CAAA;AAAA,IAAC,EACR,IACF,YAAY;AAAA,EAAA;AAEpB;AAEA,SAAS,4BACP,QACA,aAC0B;AAC1B,SAAO;AAAA,IACL,GAAG;AAAA,IACH,QAAQ,OAAO,OAAO,IAAI,CAAC,UAAU,aAAa,OAAO,WAAW,CAAC;AAAA,EAAA;AAEzE;AAEA,SAAS,aACP,OACA,aACiB;AACjB,SAAI,MAAM,SAAS,WAAW,MAAM,KAC3B;AAAA,IACL,GAAG;AAAA,IACH,IAAI,MAAM,GAAG,IAAI,CAAC,WAAW,gBAAgB,QAAQ,WAAW,CAAC;AAAA,EAAA,IAG9D;AACT;AAEA,SAAS,+BACP,YACqB;AACrB,SAAO,EAAC,GAAG,YAAY,OAAO,WAAW,KAAA;AAC3C;AAKO,SAAS,cAAc,YAAsC;AAClE,QAAM,cAAc,WAAW,UAAU,CAAA,GAAI;AAAA,IAC3C;AAAA,EAAA,GAEI,SAAU,WAAW,KAAK,CAAC,UAAU,MAAM,UAAU,QAAQ,IAK/D,aAJA;AAAA,IACE,EAAC,OAAO,UAAU,MAAM,UAAU,OAAO,SAAA;AAAA,IACzC,GAAG;AAAA,EAAA,GAIH,SAAS,WAAW,SAAS,CAAA,GAAI,IAAI,8BAA8B,GACnE,cAAc,WAAW,cAAc,CAAA,GAAI;AAAA,IAC/C;AAAA,EAAA,GASI,sBAAsB,WAAW,eAAe,CAAA,GAAI;AAAA,IACxD,CAAC,gBAAgB;AAAA,MACf,GAAG;AAAA,MACH,QAAS,WAAW,UAAU,CAAA;AAAA,IAAC;AAAA,EACjC,GAEI,wBAAwB,WAAW,iBAAiB,CAAA,GAAI;AAAA,IAC5D,CAAC,kBAAkB;AAAA,MACjB,GAAG;AAAA,MACH,QAAS,aAAa,UAAU,CAAA;AAAA,IAAC;AAAA,EACnC,GAGI,cAAgC;AAAA,IACpC;AAAA,IACA;AAAA,IACA,aAAa;AAAA,IACb;AAAA,IACA,eAAe;AAAA,EAAA,GAGX,cAAsC,CAAA;AAE5C,MAAI,WAAW,OAAO;AACpB,eAAW,SAAS,WAAW,MAAM,QAAQ;AAC3C,UACE,MAAM,SAAS,WACf,MAAM,SAAS,UACf,MAAM,SAAS,cACf,MAAM,SAAS,cACf,MAAM,SAAS,WACf,MAAM,SAAS,cACf,MAAM,SAAS,SACf;AACA,gBAAQ;AAAA,UACN,IAAI,MAAM,IAAI;AAAA,QAAA;AAEhB;AAAA,MACF;AAEA,kBAAY,KAAK,aAAa,OAAO,WAAW,CAAC;AAAA,IACnD;AAGF,SAAO;AAAA,IACL,OAAO;AAAA,MACL,MAAM,WAAW,OAAO,QAAQ;AAAA,MAChC,GAAI,YAAY,SAAS,IAAI,EAAC,QAAQ,YAAA,IAAe,CAAA;AAAA,IAAC;AAAA,IAExD,MAAM;AAAA,MACJ,MAAM;AAAA,IAAA;AAAA,IAER;AAAA,IACA;AAAA,IACA;AAAA,IACA,cAAc,WAAW,eAAe,CAAA,GAAI,IAAI,CAAC,gBAAgB;AAAA,MAC/D,GAAG;AAAA,MACH,QACE,WAAW,QAAQ,IAAI,CAAC,UAAU,aAAa,OAAO,WAAW,CAAC,KAClE,CAAA;AAAA,IAAC,EACH;AAAA,IACF,eAAe,WAAW,gBAAgB,CAAA,GAAI,IAAI,CAAC,iBAAiB;AAAA,MAClE,GAAG;AAAA,MACH,QACE,YAAY,QAAQ,IAAI,CAAC,UAAU,aAAa,OAAO,WAAW,CAAC,KACnE,CAAA;AAAA,IAAC,EACH;AAAA,IACF,gBAAgB,WAAW,iBAAiB,CAAA,GAAI,IAAI,CAAC,kBAAkB;AAAA,MACrE,GAAG;AAAA,MACH,QACE,aAAa,QAAQ,IAAI,CAAC,UAAU,aAAa,OAAO,WAAW,CAAC,KACpE,CAAA;AAAA,IAAC,EACH;AAAA,EAAA;AAEN;AClMA,SAAS,aAEP,UAA2E;AAC3E,MAAK;AAGL,WAAO,SAAS,IAAI,CAAC,WAAW,EAAC,GAAG,OAAO,OAAO,MAAM,KAAA,EAAW;AACrE;AAEA,SAAS,eAGP,UAGsB;AACtB,MAAK;AAGL,WAAO,SAAS;AAAA,MACd,CAAC,WAAW,EAAC,GAAG,OAAO,QAAQ,MAAM,UAAU,GAAC;AAAA,IAAC;AAErD;AAoBO,SAAS,aACd,QACA,IACQ;AACR,QAAM,cAAc,GAAG;AAAA,IACrB,CAAC,WACC,OAAO,SAAS;AAAA,EAAA,GAGd,eAAqD,GACxD;AAAA,IACC,CAAC,WACC,OAAO,SAAS;AAAA,EAAA,EAEnB,IAAI,CAAC,WAAW;AACf,UAAM,eAAe;AAMrB,WAAO;AAAA,MACL,MAAM,aAAa,QAAQ,aAAa;AAAA,MACxC,OAAO,aAAa;AAAA,MACpB,QAAS,aAAa,UAAU,CAAA;AAAA,IAAC;AAAA,EAErC,CAAC;AAEH,SAAK,cAaE;AAAA,IACL,OAAO;AAAA,MACL,MAAM,YAAY,QAAQ,OAAO,MAAM;AAAA,MACvC,QAAQ,OAAO,MAAM;AAAA,IAAA;AAAA,IAEvB,MAAM,EAAC,MAAM,OAAO,KAAK,KAAA;AAAA,IACzB,QAAQ,aAA8B,YAAY,MAAM,KAAK,OAAO;AAAA,IACpE,YACE,aAAkC,YAAY,UAAU,KACxD,OAAO;AAAA,IACT,aACE,eAAqC,YAAY,WAAW,KAC5D,OAAO;AAAA,IACT,OAAO,aAA6B,YAAY,KAAK,KAAK,OAAO;AAAA,IACjE,eACE,eAAuC,YAAY,aAAa,KAChE,OAAO;AAAA,IACT;AAAA,EAAA,IA7BO;AAAA,IACL,OAAO,EAAC,MAAM,OAAO,MAAM,MAAM,QAAQ,OAAO,MAAM,OAAA;AAAA,IACtD,MAAM,EAAC,MAAM,OAAO,KAAK,KAAA;AAAA,IACzB,QAAQ,CAAA;AAAA,IACR,YAAY,CAAA;AAAA,IACZ,aAAa,CAAA;AAAA,IACb,OAAO,CAAA;AAAA,IACP,eAAe,CAAA;AAAA,IACf;AAAA,EAAA;AAuBN;ACvFO,SAAS,aACd,YACmB;AACnB,SAAO;AACT;AChCO,SAAS,cAAc,QAAwC;AACpE,SAAO,SAAS,MAAM,KAAK,OAAO,OAAO,SAAU;AACrD;AAEA,SAAS,SAAS,OAAkD;AAClE,SAAO,CAAC,CAAC,UAAU,OAAO,SAAU,YAAY,OAAO,SAAU;AACnE;AAyBO,SAAS,YACd,SACA,OACgC;AAShC,SARI,EAAA,CAAC,cAAc,KAAK,KAIpB,MAAM,UAAU,QAAQ,OAAO,MAAM,QAIrC,CAAC,MAAM,QAAQ,MAAM,QAAQ;AAKnC;AAeO,SAAS,OACd,SACA,OAC2B;AAS3B,SARI,EAAA,CAAC,cAAc,KAAK,KAIpB,MAAM,UAAU,QAAQ,OAAO,KAAK,QAIpC,OAAO,MAAM,QAAS;AAK5B;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@portabletext/schema",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Portable Text Schema",
   "keywords": [
     "portabletext",
@@ -20,10 +20,7 @@
   "sideEffects": false,
   "type": "module",
   "exports": {
-    ".": {
-      "source": "./src/index.ts",
-      "default": "./dist/index.js"
-    },
+    ".": "./dist/index.js",
     "./package.json": "./package.json"
   },
   "main": "./dist/index.js",
@@ -32,10 +29,10 @@
     "dist"
   ],
   "devDependencies": {
-    "@sanity/pkg-utils": "^10.1.2",
-    "@sanity/tsconfig": "^2.0.0",
+    "@sanity/pkg-utils": "^10.2.1",
+    "@sanity/tsconfig": "^2.1.0",
     "typescript": "5.9.3",
-    "vitest": "^4.0.14"
+    "vitest": "^4.1.4"
   },
   "engines": {
     "node": ">=20.19 <22 || >=22.12"