@portabletext/sanity-bridge 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,47 @@
+# `@portabletext/sanity-bridge`
+
+A TypeScript library for converting between Sanity schemas and Portable Text schemas, enabling seamless integration between Sanity CMS and Portable Text editors.
+
+## Installation
+
+```bash
+npm install @portabletext/sanity-bridge
+```
+
+**Peer Dependencies:**
+
+```bash
+npm install @sanity/schema @sanity/types
+```
+
+## Usage
+
+### Convert Sanity Schema to Portable Text Schema
+
+```ts
+import {
+  createPortableTextMemberSchemaTypes,
+  portableTextMemberSchemaTypesToSchema,
+} from '@portabletext/sanity-bridge'
+
+// Extract Portable Text member types from Sanity schema
+const memberTypes = createPortableTextMemberSchemaTypes(sanityPortableTextType)
+
+// Convert to first-class Portable Text schema
+const portableTextSchema = portableTextMemberSchemaTypesToSchema(memberTypes)
+```
+
+### Convert Portable Text Schema to Sanity Schema
+
+```ts
+import {compileSchemaDefinitionToPortableTextMemberSchemaTypes} from '@portabletext/sanity-bridge'
+
+// Convert Portable Text schema definition to Sanity types
+const sanityMemberTypes =
+  compileSchemaDefinitionToPortableTextMemberSchemaTypes({
+    styles: [{name: 'normal'}, {name: 'h1'}],
+    decorators: [{name: 'strong'}, {name: 'em'}],
+    annotations: [{name: 'link'}],
+    blockObjects: [{name: 'image', fields: [{name: 'url', type: 'url'}]}],
+  })
+```

package/dist/index.cjs

@@ -0,0 +1,255 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: !0 });
+var schema = require("@sanity/schema"), types = require("@sanity/types"), startCase = require("lodash.startcase"), getRandomValues = require("get-random-values-esm");
+function _interopDefaultCompat(e) {
+  return e && typeof e == "object" && "default" in e ? e : { default: e };
+}
+var startCase__default = /* @__PURE__ */ _interopDefaultCompat(startCase), getRandomValues__default = /* @__PURE__ */ _interopDefaultCompat(getRandomValues);
+function createPortableTextMemberSchemaTypes(portableTextType) {
+  if (!portableTextType)
+    throw new Error("Parameter 'portabletextType' missing (required)");
+  const blockType = portableTextType.of?.find(findBlockType);
+  if (!blockType)
+    throw new Error("Block type is not defined in this schema (required)");
+  const childrenField = blockType.fields?.find(
+    (field) => field.name === "children"
+  );
+  if (!childrenField)
+    throw new Error("Children field for block type found in schema (required)");
+  const ofType = childrenField.type.of;
+  if (!ofType)
+    throw new Error(
+      "Valid types for block children not found in schema (required)"
+    );
+  const spanType = ofType.find((memberType) => memberType.name === "span");
+  if (!spanType)
+    throw new Error("Span type not found in schema (required)");
+  const inlineObjectTypes = ofType.filter(
+    (memberType) => memberType.name !== "span"
+  ) || [], blockObjectTypes = portableTextType.of?.filter(
+    (field) => field.name !== blockType.name
+  ) || [];
+  return {
+    styles: resolveEnabledStyles(blockType),
+    decorators: resolveEnabledDecorators(spanType),
+    lists: resolveEnabledListItems(blockType),
+    block: blockType,
+    span: spanType,
+    portableText: portableTextType,
+    inlineObjects: inlineObjectTypes,
+    blockObjects: blockObjectTypes,
+    annotations: spanType.annotations
+  };
+}
+function resolveEnabledStyles(blockType) {
+  const styleField = blockType.fields?.find(
+    (btField) => btField.name === "style"
+  );
+  if (!styleField)
+    throw new Error(
+      "A field with name 'style' is not defined in the block type (required)."
+    );
+  const textStyles = styleField.type.options?.list && styleField.type.options.list?.filter(
+    (style) => style.value
+  );
+  if (!textStyles || textStyles.length === 0)
+    throw new Error(
+      "The style fields need at least one style defined. I.e: {title: 'Normal', value: 'normal'}."
+    );
+  return textStyles;
+}
+function resolveEnabledDecorators(spanType) {
+  return spanType.decorators;
+}
+function resolveEnabledListItems(blockType) {
+  const listField = blockType.fields?.find(
+    (btField) => btField.name === "listItem"
+  );
+  if (!listField)
+    throw new Error(
+      "A field with name 'listItem' is not defined in the block type (required)."
+    );
+  const listItems = listField.type.options?.list && listField.type.options.list.filter((list) => list.value);
+  if (!listItems)
+    throw new Error("The list field need at least to be an empty array");
+  return listItems;
+}
+function findBlockType(type) {
+  return type.type ? findBlockType(type.type) : type.name === "block" ? type : null;
+}
+function portableTextMemberSchemaTypesToSchema(schema2) {
+  return {
+    annotations: schema2.annotations.map((annotation) => ({
+      name: annotation.name,
+      fields: annotation.fields.map((field) => ({
+        name: field.name,
+        type: field.type.jsonType,
+        title: field.type.title
+      })),
+      title: annotation.title
+    })),
+    block: {
+      name: schema2.block.name
+    },
+    blockObjects: schema2.blockObjects.map((blockObject) => ({
+      name: blockObject.name,
+      fields: blockObject.fields.map((field) => ({
+        name: field.name,
+        type: field.type.jsonType,
+        title: field.type.title
+      })),
+      title: blockObject.title
+    })),
+    decorators: schema2.decorators.map((decorator) => ({
+      name: decorator.value,
+      title: decorator.title,
+      value: decorator.value
+    })),
+    inlineObjects: schema2.inlineObjects.map((inlineObject) => ({
+      name: inlineObject.name,
+      fields: inlineObject.fields.map((field) => ({
+        name: field.name,
+        type: field.type.jsonType,
+        title: field.type.title
+      })),
+      title: inlineObject.title
+    })),
+    span: {
+      name: schema2.span.name
+    },
+    styles: schema2.styles.map((style) => ({
+      name: style.value,
+      title: style.title,
+      value: style.value
+    })),
+    lists: schema2.lists.map((list) => ({
+      name: list.value,
+      title: list.title,
+      value: list.value
+    }))
+  };
+}
+const keyGenerator = () => randomKey(12), getByteHexTable = /* @__PURE__ */ (() => {
+  let table;
+  return () => {
+    if (table)
+      return table;
+    table = [];
+    for (let i = 0; i < 256; ++i)
+      table[i] = (i + 256).toString(16).slice(1);
+    return table;
+  };
+})();
+function whatwgRNG(length = 16) {
+  const rnds8 = new Uint8Array(length);
+  return getRandomValues__default.default(rnds8), rnds8;
+}
+function randomKey(length) {
+  const table = getByteHexTable();
+  return whatwgRNG(length).reduce((str, n) => str + table[n], "").slice(0, length);
+}
+const temporaryImageName = `tmp-${keyGenerator()}-image`, temporaryUrlName = `tmp-${keyGenerator()}-url`, temporaryObjectNames = {
+  image: temporaryImageName,
+  url: temporaryUrlName
+}, objectNames = {
+  [temporaryImageName]: "image",
+  [temporaryUrlName]: "url"
+}, defaultObjectTitles = {
+  image: "Image",
+  url: "URL"
+};
+function compileSchemaDefinitionToPortableTextMemberSchemaTypes(definition) {
+  const blockObjects = definition?.blockObjects?.map(
+    (blockObject) => types.defineType({
+      type: "object",
+      // Very naive way to work around `SanitySchema.compile` adding default
+      // fields to objects with certain names.
+      name: temporaryObjectNames[blockObject.name] ?? blockObject.name,
+      title: blockObject.title === void 0 ? (
+        // This avoids the default title which is a title case of the object name
+        defaultObjectTitles[blockObject.name]
+      ) : blockObject.title,
+      fields: blockObject.fields?.map((field) => ({
+        name: field.name,
+        type: field.type,
+        title: field.title ?? startCase__default.default(field.name)
+      })) ?? []
+    })
+  ) ?? [], inlineObjects = definition?.inlineObjects?.map(
+    (inlineObject) => types.defineType({
+      type: "object",
+      // Very naive way to work around `SanitySchema.compile` adding default
+      // fields to objects with certain names.
+      name: temporaryObjectNames[inlineObject.name] ?? inlineObject.name,
+      title: inlineObject.title === void 0 ? (
+        // This avoids the default title which is a title case of the object name
+        defaultObjectTitles[inlineObject.name]
+      ) : inlineObject.title,
+      fields: inlineObject.fields?.map((field) => ({
+        name: field.name,
+        type: field.type,
+        title: field.title ?? startCase__default.default(field.name)
+      })) ?? []
+    })
+  ) ?? [], portableTextSchema = types.defineField({
+    type: "array",
+    name: "portable-text",
+    of: [
+      ...blockObjects.map((blockObject) => ({ type: blockObject.name })),
+      {
+        type: "block",
+        name: "block",
+        of: inlineObjects.map((inlineObject) => ({ type: inlineObject.name })),
+        marks: {
+          decorators: definition?.decorators?.map((decorator) => ({
+            title: decorator.title ?? startCase__default.default(decorator.name),
+            value: decorator.name
+          })) ?? [],
+          annotations: definition?.annotations?.map((annotation) => ({
+            name: annotation.name,
+            type: "object",
+            title: annotation.title,
+            fields: annotation.fields?.map((field) => ({
+              name: field.name,
+              title: field.title ?? startCase__default.default(field.name),
+              type: field.type
+            })) ?? []
+          })) ?? []
+        },
+        lists: definition?.lists?.map((list) => ({
+          value: list.name,
+          title: list.title ?? startCase__default.default(list.name)
+        })) ?? [],
+        styles: definition?.styles?.map((style) => ({
+          value: style.name,
+          title: style.title ?? startCase__default.default(style.name)
+        })) ?? []
+      }
+    ]
+  }), schema$1 = schema.Schema.compile({
+    types: [portableTextSchema, ...blockObjects, ...inlineObjects]
+  }).get("portable-text"), pteSchema = createPortableTextMemberSchemaTypes(schema$1);
+  return {
+    ...pteSchema,
+    blockObjects: pteSchema.blockObjects.map(
+      (blockObject) => objectNames[blockObject.name] !== void 0 ? {
+        ...blockObject,
+        name: objectNames[blockObject.name],
+        type: {
+          ...blockObject.type,
+          name: objectNames[blockObject.name]
+        }
+      } : blockObject
+    ),
+    inlineObjects: pteSchema.inlineObjects.map(
+      (inlineObject) => objectNames[inlineObject.name] !== void 0 ? {
+        ...inlineObject,
+        name: objectNames[inlineObject.name]
+      } : inlineObject
+    )
+  };
+}
+exports.compileSchemaDefinitionToPortableTextMemberSchemaTypes = compileSchemaDefinitionToPortableTextMemberSchemaTypes;
+exports.createPortableTextMemberSchemaTypes = createPortableTextMemberSchemaTypes;
+exports.portableTextMemberSchemaTypesToSchema = portableTextMemberSchemaTypesToSchema;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":["../src/portable-text-member-schema-types.ts","../src/portable-text-member-schema-types-to-schema.ts","../src/key-generator.ts","../src/schema-definition-to-portable-text-member-schema-types.ts"],"sourcesContent":["import type {\n  ArraySchemaType,\n  BlockDecoratorDefinition,\n  BlockListDefinition,\n  BlockSchemaType,\n  BlockStyleDefinition,\n  ObjectSchemaType,\n  PortableTextBlock,\n  SchemaType,\n  SpanSchemaType,\n} from '@sanity/types'\n\n/**\n * @public\n * Sanity-specific schema types for Portable Text.\n */\nexport type PortableTextMemberSchemaTypes = {\n  annotations: (ObjectSchemaType & {i18nTitleKey?: string})[]\n  block: ObjectSchemaType\n  blockObjects: ObjectSchemaType[]\n  decorators: BlockDecoratorDefinition[]\n  inlineObjects: ObjectSchemaType[]\n  portableText: ArraySchemaType<PortableTextBlock>\n  span: ObjectSchemaType\n  styles: BlockStyleDefinition[]\n  lists: BlockListDefinition[]\n}\n\n/**\n * @public\n * Create Sanity-specific schema types for Portable Text from a Sanity array\n * schema type.\n */\nexport function createPortableTextMemberSchemaTypes(\n  portableTextType: ArraySchemaType<PortableTextBlock>,\n): PortableTextMemberSchemaTypes {\n  if (!portableTextType) {\n    throw new Error(\"Parameter 'portabletextType' missing (required)\")\n  }\n  const blockType = portableTextType.of?.find(findBlockType) as\n    | BlockSchemaType\n    | undefined\n  if (!blockType) {\n    throw new Error('Block type is not defined in this schema (required)')\n  }\n  const childrenField = blockType.fields?.find(\n    (field) => field.name === 'children',\n  ) as {type: ArraySchemaType} | undefined\n  if (!childrenField) {\n    throw new Error('Children field for block type found in schema (required)')\n  }\n  const ofType = childrenField.type.of\n  if (!ofType) {\n    throw new Error(\n      'Valid types for block children not found in schema (required)',\n    )\n  }\n  const spanType = ofType.find((memberType) => memberType.name === 'span') as\n    | ObjectSchemaType\n    | undefined\n  if (!spanType) {\n    throw new Error('Span type not found in schema (required)')\n  }\n  const inlineObjectTypes = (ofType.filter(\n    (memberType) => memberType.name !== 'span',\n  ) || []) as ObjectSchemaType[]\n  const blockObjectTypes = (portableTextType.of?.filter(\n    (field) => field.name !== blockType.name,\n  ) || []) as ObjectSchemaType[]\n  return {\n    styles: resolveEnabledStyles(blockType),\n    decorators: resolveEnabledDecorators(spanType),\n    lists: resolveEnabledListItems(blockType),\n    block: blockType,\n    span: spanType,\n    portableText: portableTextType,\n    inlineObjects: inlineObjectTypes,\n    blockObjects: blockObjectTypes,\n    annotations: (spanType as SpanSchemaType).annotations,\n  }\n}\n\nfunction resolveEnabledStyles(blockType: ObjectSchemaType) {\n  const styleField = blockType.fields?.find(\n    (btField) => btField.name === 'style',\n  )\n  if (!styleField) {\n    throw new Error(\n      \"A field with name 'style' is not defined in the block type (required).\",\n    )\n  }\n  const textStyles =\n    styleField.type.options?.list &&\n    styleField.type.options.list?.filter(\n      (style: {value: string}) => style.value,\n    )\n  if (!textStyles || textStyles.length === 0) {\n    throw new Error(\n      'The style fields need at least one style ' +\n        \"defined. I.e: {title: 'Normal', value: 'normal'}.\",\n    )\n  }\n  return textStyles\n}\n\nfunction resolveEnabledDecorators(spanType: ObjectSchemaType) {\n  return (spanType as any).decorators\n}\n\nfunction resolveEnabledListItems(blockType: ObjectSchemaType) {\n  const listField = blockType.fields?.find(\n    (btField) => btField.name === 'listItem',\n  )\n  if (!listField) {\n    throw new Error(\n      \"A field with name 'listItem' is not defined in the block type (required).\",\n    )\n  }\n  const listItems =\n    listField.type.options?.list &&\n    listField.type.options.list.filter((list: {value: string}) => list.value)\n  if (!listItems) {\n    throw new Error('The list field need at least to be an empty array')\n  }\n  return listItems\n}\n\nfunction findBlockType(type: SchemaType): BlockSchemaType | null {\n  if (type.type) {\n    return findBlockType(type.type)\n  }\n\n  if (type.name === 'block') {\n    return type as BlockSchemaType\n  }\n\n  return null\n}\n","import type {Schema} from '@portabletext/schema'\nimport type {PortableTextMemberSchemaTypes} from './portable-text-member-schema-types'\n\n/**\n * @public\n * Convert Sanity-specific schema types for Portable Text to a first-class\n * Portable Text schema.\n */\nexport function portableTextMemberSchemaTypesToSchema(\n  schema: PortableTextMemberSchemaTypes,\n): Schema {\n  return {\n    annotations: schema.annotations.map((annotation) => ({\n      name: annotation.name,\n      fields: annotation.fields.map((field) => ({\n        name: field.name,\n        type: field.type.jsonType,\n        title: field.type.title,\n      })),\n      title: annotation.title,\n    })),\n    block: {\n      name: schema.block.name,\n    },\n    blockObjects: schema.blockObjects.map((blockObject) => ({\n      name: blockObject.name,\n      fields: blockObject.fields.map((field) => ({\n        name: field.name,\n        type: field.type.jsonType,\n        title: field.type.title,\n      })),\n      title: blockObject.title,\n    })),\n    decorators: schema.decorators.map((decorator) => ({\n      name: decorator.value,\n      title: decorator.title,\n      value: decorator.value,\n    })),\n    inlineObjects: schema.inlineObjects.map((inlineObject) => ({\n      name: inlineObject.name,\n      fields: inlineObject.fields.map((field) => ({\n        name: field.name,\n        type: field.type.jsonType,\n        title: field.type.title,\n      })),\n      title: inlineObject.title,\n    })),\n    span: {\n      name: schema.span.name,\n    },\n    styles: schema.styles.map((style) => ({\n      name: style.value,\n      title: style.title,\n      value: style.value,\n    })),\n    lists: schema.lists.map((list) => ({\n      name: list.value,\n      title: list.title,\n      value: list.value,\n    })),\n  }\n}\n","import getRandomValues from 'get-random-values-esm'\n\nexport const keyGenerator = (): string => randomKey(12)\n\nconst getByteHexTable = (() => {\n  let table: any[]\n  return () => {\n    if (table) {\n      return table\n    }\n\n    table = []\n    for (let i = 0; i < 256; ++i) {\n      table[i] = (i + 0x100).toString(16).slice(1)\n    }\n    return table\n  }\n})()\n\n// WHATWG crypto RNG - https://w3c.github.io/webcrypto/Overview.html\nfunction whatwgRNG(length = 16) {\n  const rnds8 = new Uint8Array(length)\n  getRandomValues(rnds8)\n  return rnds8\n}\n\nfunction randomKey(length?: number): string {\n  const table = getByteHexTable()\n  return whatwgRNG(length)\n    .reduce((str, n) => str + table[n], '')\n    .slice(0, length)\n}\n","import type {SchemaDefinition} from '@portabletext/schema'\nimport {Schema as SanitySchema} from '@sanity/schema'\nimport {defineField, defineType, type ObjectSchemaType} from '@sanity/types'\nimport startCase from 'lodash.startcase'\nimport {keyGenerator} from './key-generator'\nimport {\n  createPortableTextMemberSchemaTypes,\n  type PortableTextMemberSchemaTypes,\n} from './portable-text-member-schema-types'\n\nconst temporaryImageName = `tmp-${keyGenerator()}-image`\nconst temporaryUrlName = `tmp-${keyGenerator()}-url`\n\nconst temporaryObjectNames: Record<string, string> = {\n  image: temporaryImageName,\n  url: temporaryUrlName,\n}\n\nconst objectNames: Record<string, string> = {\n  [temporaryImageName]: 'image',\n  [temporaryUrlName]: 'url',\n}\n\nconst defaultObjectTitles: Record<string, string> = {\n  image: 'Image',\n  url: 'URL',\n}\n\n/**\n * @public\n * Compile a Portable Text schema definition to Sanity-specific schema types for\n * Portable Text.\n */\nexport function compileSchemaDefinitionToPortableTextMemberSchemaTypes(\n  definition?: SchemaDefinition,\n): PortableTextMemberSchemaTypes {\n  const blockObjects =\n    definition?.blockObjects?.map((blockObject) =>\n      defineType({\n        type: 'object',\n        // Very naive way to work around `SanitySchema.compile` adding default\n        // fields to objects with certain names.\n        name: temporaryObjectNames[blockObject.name] ?? blockObject.name,\n        title:\n          blockObject.title === undefined\n            ? // This avoids the default title which is a title case of the object name\n              defaultObjectTitles[blockObject.name]\n            : blockObject.title,\n        fields:\n          blockObject.fields?.map((field) => ({\n            name: field.name,\n            type: field.type,\n            title: field.title ?? startCase(field.name),\n          })) ?? [],\n      }),\n    ) ?? []\n\n  const inlineObjects =\n    definition?.inlineObjects?.map((inlineObject) =>\n      defineType({\n        type: 'object',\n        // Very naive way to work around `SanitySchema.compile` adding default\n        // fields to objects with certain names.\n        name: temporaryObjectNames[inlineObject.name] ?? inlineObject.name,\n\n        title:\n          inlineObject.title === undefined\n            ? // This avoids the default title which is a title case of the object name\n              defaultObjectTitles[inlineObject.name]\n            : inlineObject.title,\n        fields:\n          inlineObject.fields?.map((field) => ({\n            name: field.name,\n            type: field.type,\n            title: field.title ?? startCase(field.name),\n          })) ?? [],\n      }),\n    ) ?? []\n\n  const portableTextSchema = defineField({\n    type: 'array',\n    name: 'portable-text',\n    of: [\n      ...blockObjects.map((blockObject) => ({type: blockObject.name})),\n      {\n        type: 'block',\n        name: 'block',\n        of: inlineObjects.map((inlineObject) => ({type: inlineObject.name})),\n        marks: {\n          decorators:\n            definition?.decorators?.map((decorator) => ({\n              title: decorator.title ?? startCase(decorator.name),\n              value: decorator.name,\n            })) ?? [],\n          annotations:\n            definition?.annotations?.map((annotation) => ({\n              name: annotation.name,\n              type: 'object',\n              title: annotation.title,\n              fields:\n                annotation.fields?.map((field) => ({\n                  name: field.name,\n                  title: field.title ?? startCase(field.name),\n                  type: field.type,\n                })) ?? [],\n            })) ?? [],\n        },\n        lists:\n          definition?.lists?.map((list) => ({\n            value: list.name,\n            title: list.title ?? startCase(list.name),\n          })) ?? [],\n        styles:\n          definition?.styles?.map((style) => ({\n            value: style.name,\n            title: style.title ?? startCase(style.name),\n          })) ?? [],\n      },\n    ],\n  })\n\n  const schema = SanitySchema.compile({\n    types: [portableTextSchema, ...blockObjects, ...inlineObjects],\n  }).get('portable-text')\n\n  const pteSchema = createPortableTextMemberSchemaTypes(schema)\n\n  return {\n    ...pteSchema,\n    blockObjects: pteSchema.blockObjects.map((blockObject) =>\n      objectNames[blockObject.name] !== undefined\n        ? ({\n            ...blockObject,\n            name: objectNames[blockObject.name],\n            type: {\n              ...blockObject.type,\n              name: objectNames[blockObject.name],\n            },\n          } as ObjectSchemaType)\n        : blockObject,\n    ),\n    inlineObjects: pteSchema.inlineObjects.map((inlineObject) =>\n      objectNames[inlineObject.name] !== undefined\n        ? ({\n            ...inlineObject,\n            name: objectNames[inlineObject.name],\n          } as ObjectSchemaType)\n        : inlineObject,\n    ),\n  } satisfies PortableTextMemberSchemaTypes\n}\n"],"names":["schema","getRandomValues","defineType","startCase","defineField","SanitySchema"],"mappings":";;;;;;;AAiCO,SAAS,oCACd,kBAC+B;AAC/B,MAAI,CAAC;AACH,UAAM,IAAI,MAAM,iDAAiD;AAEnE,QAAM,YAAY,iBAAiB,IAAI,KAAK,aAAa;AAGzD,MAAI,CAAC;AACH,UAAM,IAAI,MAAM,qDAAqD;AAEvE,QAAM,gBAAgB,UAAU,QAAQ;AAAA,IACtC,CAAC,UAAU,MAAM,SAAS;AAAA,EAAA;AAE5B,MAAI,CAAC;AACH,UAAM,IAAI,MAAM,0DAA0D;AAE5E,QAAM,SAAS,cAAc,KAAK;AAClC,MAAI,CAAC;AACH,UAAM,IAAI;AAAA,MACR;AAAA,IAAA;AAGJ,QAAM,WAAW,OAAO,KAAK,CAAC,eAAe,WAAW,SAAS,MAAM;AAGvE,MAAI,CAAC;AACH,UAAM,IAAI,MAAM,0CAA0C;AAE5D,QAAM,oBAAqB,OAAO;AAAA,IAChC,CAAC,eAAe,WAAW,SAAS;AAAA,EAAA,KACjC,IACC,mBAAoB,iBAAiB,IAAI;AAAA,IAC7C,CAAC,UAAU,MAAM,SAAS,UAAU;AAAA,EAAA,KACjC,CAAA;AACL,SAAO;AAAA,IACL,QAAQ,qBAAqB,SAAS;AAAA,IACtC,YAAY,yBAAyB,QAAQ;AAAA,IAC7C,OAAO,wBAAwB,SAAS;AAAA,IACxC,OAAO;AAAA,IACP,MAAM;AAAA,IACN,cAAc;AAAA,IACd,eAAe;AAAA,IACf,cAAc;AAAA,IACd,aAAc,SAA4B;AAAA,EAAA;AAE9C;AAEA,SAAS,qBAAqB,WAA6B;AACzD,QAAM,aAAa,UAAU,QAAQ;AAAA,IACnC,CAAC,YAAY,QAAQ,SAAS;AAAA,EAAA;AAEhC,MAAI,CAAC;AACH,UAAM,IAAI;AAAA,MACR;AAAA,IAAA;AAGJ,QAAM,aACJ,WAAW,KAAK,SAAS,QACzB,WAAW,KAAK,QAAQ,MAAM;AAAA,IAC5B,CAAC,UAA2B,MAAM;AAAA,EAAA;AAEtC,MAAI,CAAC,cAAc,WAAW,WAAW;AACvC,UAAM,IAAI;AAAA,MACR;AAAA,IAAA;AAIJ,SAAO;AACT;AAEA,SAAS,yBAAyB,UAA4B;AAC5D,SAAQ,SAAiB;AAC3B;AAEA,SAAS,wBAAwB,WAA6B;AAC5D,QAAM,YAAY,UAAU,QAAQ;AAAA,IAClC,CAAC,YAAY,QAAQ,SAAS;AAAA,EAAA;AAEhC,MAAI,CAAC;AACH,UAAM,IAAI;AAAA,MACR;AAAA,IAAA;AAGJ,QAAM,YACJ,UAAU,KAAK,SAAS,QACxB,UAAU,KAAK,QAAQ,KAAK,OAAO,CAAC,SAA0B,KAAK,KAAK;AAC1E,MAAI,CAAC;AACH,UAAM,IAAI,MAAM,mDAAmD;AAErE,SAAO;AACT;AAEA,SAAS,cAAc,MAA0C;AAC/D,SAAI,KAAK,OACA,cAAc,KAAK,IAAI,IAG5B,KAAK,SAAS,UACT,OAGF;AACT;ACjIO,SAAS,sCACdA,SACQ;AACR,SAAO;AAAA,IACL,aAAaA,QAAO,YAAY,IAAI,CAAC,gBAAgB;AAAA,MACnD,MAAM,WAAW;AAAA,MACjB,QAAQ,WAAW,OAAO,IAAI,CAAC,WAAW;AAAA,QACxC,MAAM,MAAM;AAAA,QACZ,MAAM,MAAM,KAAK;AAAA,QACjB,OAAO,MAAM,KAAK;AAAA,MAAA,EAClB;AAAA,MACF,OAAO,WAAW;AAAA,IAAA,EAClB;AAAA,IACF,OAAO;AAAA,MACL,MAAMA,QAAO,MAAM;AAAA,IAAA;AAAA,IAErB,cAAcA,QAAO,aAAa,IAAI,CAAC,iBAAiB;AAAA,MACtD,MAAM,YAAY;AAAA,MAClB,QAAQ,YAAY,OAAO,IAAI,CAAC,WAAW;AAAA,QACzC,MAAM,MAAM;AAAA,QACZ,MAAM,MAAM,KAAK;AAAA,QACjB,OAAO,MAAM,KAAK;AAAA,MAAA,EAClB;AAAA,MACF,OAAO,YAAY;AAAA,IAAA,EACnB;AAAA,IACF,YAAYA,QAAO,WAAW,IAAI,CAAC,eAAe;AAAA,MAChD,MAAM,UAAU;AAAA,MAChB,OAAO,UAAU;AAAA,MACjB,OAAO,UAAU;AAAA,IAAA,EACjB;AAAA,IACF,eAAeA,QAAO,cAAc,IAAI,CAAC,kBAAkB;AAAA,MACzD,MAAM,aAAa;AAAA,MACnB,QAAQ,aAAa,OAAO,IAAI,CAAC,WAAW;AAAA,QAC1C,MAAM,MAAM;AAAA,QACZ,MAAM,MAAM,KAAK;AAAA,QACjB,OAAO,MAAM,KAAK;AAAA,MAAA,EAClB;AAAA,MACF,OAAO,aAAa;AAAA,IAAA,EACpB;AAAA,IACF,MAAM;AAAA,MACJ,MAAMA,QAAO,KAAK;AAAA,IAAA;AAAA,IAEpB,QAAQA,QAAO,OAAO,IAAI,CAAC,WAAW;AAAA,MACpC,MAAM,MAAM;AAAA,MACZ,OAAO,MAAM;AAAA,MACb,OAAO,MAAM;AAAA,IAAA,EACb;AAAA,IACF,OAAOA,QAAO,MAAM,IAAI,CAAC,UAAU;AAAA,MACjC,MAAM,KAAK;AAAA,MACX,OAAO,KAAK;AAAA,MACZ,OAAO,KAAK;AAAA,IAAA,EACZ;AAAA,EAAA;AAEN;AC3DO,MAAM,eAAe,MAAc,UAAU,EAAE,GAEhD,kBAAmB,uBAAM;AAC7B,MAAI;AACJ,SAAO,MAAM;AACX,QAAI;AACF,aAAO;AAGT,YAAQ,CAAA;AACR,aAAS,IAAI,GAAG,IAAI,KAAK,EAAE;AACzB,YAAM,CAAC,KAAK,IAAI,KAAO,SAAS,EAAE,EAAE,MAAM,CAAC;AAE7C,WAAO;AAAA,EACT;AACF,GAAA;AAGA,SAAS,UAAU,SAAS,IAAI;AAC9B,QAAM,QAAQ,IAAI,WAAW,MAAM;AACnC,SAAAC,yBAAAA,QAAgB,KAAK,GACd;AACT;AAEA,SAAS,UAAU,QAAyB;AAC1C,QAAM,QAAQ,gBAAA;AACd,SAAO,UAAU,MAAM,EACpB,OAAO,CAAC,KAAK,MAAM,MAAM,MAAM,CAAC,GAAG,EAAE,EACrC,MAAM,GAAG,MAAM;AACpB;ACrBA,MAAM,qBAAqB,OAAO,aAAA,CAAc,UAC1C,mBAAmB,OAAO,aAAA,CAAc,QAExC,uBAA+C;AAAA,EACnD,OAAO;AAAA,EACP,KAAK;AACP,GAEM,cAAsC;AAAA,EAC1C,CAAC,kBAAkB,GAAG;AAAA,EACtB,CAAC,gBAAgB,GAAG;AACtB,GAEM,sBAA8C;AAAA,EAClD,OAAO;AAAA,EACP,KAAK;AACP;AAOO,SAAS,uDACd,YAC+B;AAC/B,QAAM,eACJ,YAAY,cAAc;AAAA,IAAI,CAAC,gBAC7BC,MAAAA,WAAW;AAAA,MACT,MAAM;AAAA;AAAA;AAAA,MAGN,MAAM,qBAAqB,YAAY,IAAI,KAAK,YAAY;AAAA,MAC5D,OACE,YAAY,UAAU;AAAA;AAAA,QAElB,oBAAoB,YAAY,IAAI;AAAA,UACpC,YAAY;AAAA,MAClB,QACE,YAAY,QAAQ,IAAI,CAAC,WAAW;AAAA,QAClC,MAAM,MAAM;AAAA,QACZ,MAAM,MAAM;AAAA,QACZ,OAAO,MAAM,SAASC,mBAAAA,QAAU,MAAM,IAAI;AAAA,MAAA,EAC1C,KAAK,CAAA;AAAA,IAAC,CACX;AAAA,EAAA,KACE,IAED,gBACJ,YAAY,eAAe;AAAA,IAAI,CAAC,iBAC9BD,MAAAA,WAAW;AAAA,MACT,MAAM;AAAA;AAAA;AAAA,MAGN,MAAM,qBAAqB,aAAa,IAAI,KAAK,aAAa;AAAA,MAE9D,OACE,aAAa,UAAU;AAAA;AAAA,QAEnB,oBAAoB,aAAa,IAAI;AAAA,UACrC,aAAa;AAAA,MACnB,QACE,aAAa,QAAQ,IAAI,CAAC,WAAW;AAAA,QACnC,MAAM,MAAM;AAAA,QACZ,MAAM,MAAM;AAAA,QACZ,OAAO,MAAM,SAASC,mBAAAA,QAAU,MAAM,IAAI;AAAA,MAAA,EAC1C,KAAK,CAAA;AAAA,IAAC,CACX;AAAA,EAAA,KACE,CAAA,GAED,qBAAqBC,kBAAY;AAAA,IACrC,MAAM;AAAA,IACN,MAAM;AAAA,IACN,IAAI;AAAA,MACF,GAAG,aAAa,IAAI,CAAC,iBAAiB,EAAC,MAAM,YAAY,KAAA,EAAM;AAAA,MAC/D;AAAA,QACE,MAAM;AAAA,QACN,MAAM;AAAA,QACN,IAAI,cAAc,IAAI,CAAC,kBAAkB,EAAC,MAAM,aAAa,KAAA,EAAM;AAAA,QACnE,OAAO;AAAA,UACL,YACE,YAAY,YAAY,IAAI,CAAC,eAAe;AAAA,YAC1C,OAAO,UAAU,SAASD,mBAAAA,QAAU,UAAU,IAAI;AAAA,YAClD,OAAO,UAAU;AAAA,UAAA,EACjB,KAAK,CAAA;AAAA,UACT,aACE,YAAY,aAAa,IAAI,CAAC,gBAAgB;AAAA,YAC5C,MAAM,WAAW;AAAA,YACjB,MAAM;AAAA,YACN,OAAO,WAAW;AAAA,YAClB,QACE,WAAW,QAAQ,IAAI,CAAC,WAAW;AAAA,cACjC,MAAM,MAAM;AAAA,cACZ,OAAO,MAAM,SAASA,mBAAAA,QAAU,MAAM,IAAI;AAAA,cAC1C,MAAM,MAAM;AAAA,YAAA,EACZ,KAAK,CAAA;AAAA,UAAC,EACV,KAAK,CAAA;AAAA,QAAC;AAAA,QAEZ,OACE,YAAY,OAAO,IAAI,CAAC,UAAU;AAAA,UAChC,OAAO,KAAK;AAAA,UACZ,OAAO,KAAK,SAASA,mBAAAA,QAAU,KAAK,IAAI;AAAA,QAAA,EACxC,KAAK,CAAA;AAAA,QACT,QACE,YAAY,QAAQ,IAAI,CAAC,WAAW;AAAA,UAClC,OAAO,MAAM;AAAA,UACb,OAAO,MAAM,SAASA,mBAAAA,QAAU,MAAM,IAAI;AAAA,QAAA,EAC1C,KAAK,CAAA;AAAA,MAAC;AAAA,IACZ;AAAA,EACF,CACD,GAEKH,WAASK,OAAAA,OAAa,QAAQ;AAAA,IAClC,OAAO,CAAC,oBAAoB,GAAG,cAAc,GAAG,aAAa;AAAA,EAAA,CAC9D,EAAE,IAAI,eAAe,GAEhB,YAAY,oCAAoCL,QAAM;AAE5D,SAAO;AAAA,IACL,GAAG;AAAA,IACH,cAAc,UAAU,aAAa;AAAA,MAAI,CAAC,gBACxC,YAAY,YAAY,IAAI,MAAM,SAC7B;AAAA,QACC,GAAG;AAAA,QACH,MAAM,YAAY,YAAY,IAAI;AAAA,QAClC,MAAM;AAAA,UACJ,GAAG,YAAY;AAAA,UACf,MAAM,YAAY,YAAY,IAAI;AAAA,QAAA;AAAA,MACpC,IAEF;AAAA,IAAA;AAAA,IAEN,eAAe,UAAU,cAAc;AAAA,MAAI,CAAC,iBAC1C,YAAY,aAAa,IAAI,MAAM,SAC9B;AAAA,QACC,GAAG;AAAA,QACH,MAAM,YAAY,aAAa,IAAI;AAAA,MAAA,IAErC;AAAA,IAAA;AAAA,EACN;AAEJ;;;;"}

package/dist/index.d.cts

@@ -0,0 +1,38 @@
+import { ArraySchemaType, BlockDecoratorDefinition, BlockListDefinition, BlockStyleDefinition, ObjectSchemaType, PortableTextBlock } from "@sanity/types";
+import { Schema, SchemaDefinition } from "@portabletext/schema";
+/**
+ * @public
+ * Sanity-specific schema types for Portable Text.
+ */
+type PortableTextMemberSchemaTypes = {
+  annotations: (ObjectSchemaType & {
+    i18nTitleKey?: string;
+  })[];
+  block: ObjectSchemaType;
+  blockObjects: ObjectSchemaType[];
+  decorators: BlockDecoratorDefinition[];
+  inlineObjects: ObjectSchemaType[];
+  portableText: ArraySchemaType<PortableTextBlock>;
+  span: ObjectSchemaType;
+  styles: BlockStyleDefinition[];
+  lists: BlockListDefinition[];
+};
+/**
+ * @public
+ * Create Sanity-specific schema types for Portable Text from a Sanity array
+ * schema type.
+ */
+declare function createPortableTextMemberSchemaTypes(portableTextType: ArraySchemaType<PortableTextBlock>): PortableTextMemberSchemaTypes;
+/**
+ * @public
+ * Convert Sanity-specific schema types for Portable Text to a first-class
+ * Portable Text schema.
+ */
+declare function portableTextMemberSchemaTypesToSchema(schema: PortableTextMemberSchemaTypes): Schema;
+/**
+ * @public
+ * Compile a Portable Text schema definition to Sanity-specific schema types for
+ * Portable Text.
+ */
+declare function compileSchemaDefinitionToPortableTextMemberSchemaTypes(definition?: SchemaDefinition): PortableTextMemberSchemaTypes;
+export { type PortableTextMemberSchemaTypes, compileSchemaDefinitionToPortableTextMemberSchemaTypes, createPortableTextMemberSchemaTypes, portableTextMemberSchemaTypesToSchema };

package/dist/index.d.ts

@@ -0,0 +1,38 @@
+import { ArraySchemaType, BlockDecoratorDefinition, BlockListDefinition, BlockStyleDefinition, ObjectSchemaType, PortableTextBlock } from "@sanity/types";
+import { Schema, SchemaDefinition } from "@portabletext/schema";
+/**
+ * @public
+ * Sanity-specific schema types for Portable Text.
+ */
+type PortableTextMemberSchemaTypes = {
+  annotations: (ObjectSchemaType & {
+    i18nTitleKey?: string;
+  })[];
+  block: ObjectSchemaType;
+  blockObjects: ObjectSchemaType[];
+  decorators: BlockDecoratorDefinition[];
+  inlineObjects: ObjectSchemaType[];
+  portableText: ArraySchemaType<PortableTextBlock>;
+  span: ObjectSchemaType;
+  styles: BlockStyleDefinition[];
+  lists: BlockListDefinition[];
+};
+/**
+ * @public
+ * Create Sanity-specific schema types for Portable Text from a Sanity array
+ * schema type.
+ */
+declare function createPortableTextMemberSchemaTypes(portableTextType: ArraySchemaType<PortableTextBlock>): PortableTextMemberSchemaTypes;
+/**
+ * @public
+ * Convert Sanity-specific schema types for Portable Text to a first-class
+ * Portable Text schema.
+ */
+declare function portableTextMemberSchemaTypesToSchema(schema: PortableTextMemberSchemaTypes): Schema;
+/**
+ * @public
+ * Compile a Portable Text schema definition to Sanity-specific schema types for
+ * Portable Text.
+ */
+declare function compileSchemaDefinitionToPortableTextMemberSchemaTypes(definition?: SchemaDefinition): PortableTextMemberSchemaTypes;
+export { type PortableTextMemberSchemaTypes, compileSchemaDefinitionToPortableTextMemberSchemaTypes, createPortableTextMemberSchemaTypes, portableTextMemberSchemaTypesToSchema };

package/dist/index.js

@@ -0,0 +1,254 @@
+import { Schema } from "@sanity/schema";
+import { defineType, defineField } from "@sanity/types";
+import startCase from "lodash.startcase";
+import getRandomValues from "get-random-values-esm";
+function createPortableTextMemberSchemaTypes(portableTextType) {
+  if (!portableTextType)
+    throw new Error("Parameter 'portabletextType' missing (required)");
+  const blockType = portableTextType.of?.find(findBlockType);
+  if (!blockType)
+    throw new Error("Block type is not defined in this schema (required)");
+  const childrenField = blockType.fields?.find(
+    (field) => field.name === "children"
+  );
+  if (!childrenField)
+    throw new Error("Children field for block type found in schema (required)");
+  const ofType = childrenField.type.of;
+  if (!ofType)
+    throw new Error(
+      "Valid types for block children not found in schema (required)"
+    );
+  const spanType = ofType.find((memberType) => memberType.name === "span");
+  if (!spanType)
+    throw new Error("Span type not found in schema (required)");
+  const inlineObjectTypes = ofType.filter(
+    (memberType) => memberType.name !== "span"
+  ) || [], blockObjectTypes = portableTextType.of?.filter(
+    (field) => field.name !== blockType.name
+  ) || [];
+  return {
+    styles: resolveEnabledStyles(blockType),
+    decorators: resolveEnabledDecorators(spanType),
+    lists: resolveEnabledListItems(blockType),
+    block: blockType,
+    span: spanType,
+    portableText: portableTextType,
+    inlineObjects: inlineObjectTypes,
+    blockObjects: blockObjectTypes,
+    annotations: spanType.annotations
+  };
+}
+function resolveEnabledStyles(blockType) {
+  const styleField = blockType.fields?.find(
+    (btField) => btField.name === "style"
+  );
+  if (!styleField)
+    throw new Error(
+      "A field with name 'style' is not defined in the block type (required)."
+    );
+  const textStyles = styleField.type.options?.list && styleField.type.options.list?.filter(
+    (style) => style.value
+  );
+  if (!textStyles || textStyles.length === 0)
+    throw new Error(
+      "The style fields need at least one style defined. I.e: {title: 'Normal', value: 'normal'}."
+    );
+  return textStyles;
+}
+function resolveEnabledDecorators(spanType) {
+  return spanType.decorators;
+}
+function resolveEnabledListItems(blockType) {
+  const listField = blockType.fields?.find(
+    (btField) => btField.name === "listItem"
+  );
+  if (!listField)
+    throw new Error(
+      "A field with name 'listItem' is not defined in the block type (required)."
+    );
+  const listItems = listField.type.options?.list && listField.type.options.list.filter((list) => list.value);
+  if (!listItems)
+    throw new Error("The list field need at least to be an empty array");
+  return listItems;
+}
+function findBlockType(type) {
+  return type.type ? findBlockType(type.type) : type.name === "block" ? type : null;
+}
+function portableTextMemberSchemaTypesToSchema(schema) {
+  return {
+    annotations: schema.annotations.map((annotation) => ({
+      name: annotation.name,
+      fields: annotation.fields.map((field) => ({
+        name: field.name,
+        type: field.type.jsonType,
+        title: field.type.title
+      })),
+      title: annotation.title
+    })),
+    block: {
+      name: schema.block.name
+    },
+    blockObjects: schema.blockObjects.map((blockObject) => ({
+      name: blockObject.name,
+      fields: blockObject.fields.map((field) => ({
+        name: field.name,
+        type: field.type.jsonType,
+        title: field.type.title
+      })),
+      title: blockObject.title
+    })),
+    decorators: schema.decorators.map((decorator) => ({
+      name: decorator.value,
+      title: decorator.title,
+      value: decorator.value
+    })),
+    inlineObjects: schema.inlineObjects.map((inlineObject) => ({
+      name: inlineObject.name,
+      fields: inlineObject.fields.map((field) => ({
+        name: field.name,
+        type: field.type.jsonType,
+        title: field.type.title
+      })),
+      title: inlineObject.title
+    })),
+    span: {
+      name: schema.span.name
+    },
+    styles: schema.styles.map((style) => ({
+      name: style.value,
+      title: style.title,
+      value: style.value
+    })),
+    lists: schema.lists.map((list) => ({
+      name: list.value,
+      title: list.title,
+      value: list.value
+    }))
+  };
+}
+const keyGenerator = () => randomKey(12), getByteHexTable = /* @__PURE__ */ (() => {
+  let table;
+  return () => {
+    if (table)
+      return table;
+    table = [];
+    for (let i = 0; i < 256; ++i)
+      table[i] = (i + 256).toString(16).slice(1);
+    return table;
+  };
+})();
+function whatwgRNG(length = 16) {
+  const rnds8 = new Uint8Array(length);
+  return getRandomValues(rnds8), rnds8;
+}
+function randomKey(length) {
+  const table = getByteHexTable();
+  return whatwgRNG(length).reduce((str, n) => str + table[n], "").slice(0, length);
+}
+const temporaryImageName = `tmp-${keyGenerator()}-image`, temporaryUrlName = `tmp-${keyGenerator()}-url`, temporaryObjectNames = {
+  image: temporaryImageName,
+  url: temporaryUrlName
+}, objectNames = {
+  [temporaryImageName]: "image",
+  [temporaryUrlName]: "url"
+}, defaultObjectTitles = {
+  image: "Image",
+  url: "URL"
+};
+function compileSchemaDefinitionToPortableTextMemberSchemaTypes(definition) {
+  const blockObjects = definition?.blockObjects?.map(
+    (blockObject) => defineType({
+      type: "object",
+      // Very naive way to work around `SanitySchema.compile` adding default
+      // fields to objects with certain names.
+      name: temporaryObjectNames[blockObject.name] ?? blockObject.name,
+      title: blockObject.title === void 0 ? (
+        // This avoids the default title which is a title case of the object name
+        defaultObjectTitles[blockObject.name]
+      ) : blockObject.title,
+      fields: blockObject.fields?.map((field) => ({
+        name: field.name,
+        type: field.type,
+        title: field.title ?? startCase(field.name)
+      })) ?? []
+    })
+  ) ?? [], inlineObjects = definition?.inlineObjects?.map(
+    (inlineObject) => defineType({
+      type: "object",
+      // Very naive way to work around `SanitySchema.compile` adding default
+      // fields to objects with certain names.
+      name: temporaryObjectNames[inlineObject.name] ?? inlineObject.name,
+      title: inlineObject.title === void 0 ? (
+        // This avoids the default title which is a title case of the object name
+        defaultObjectTitles[inlineObject.name]
+      ) : inlineObject.title,
+      fields: inlineObject.fields?.map((field) => ({
+        name: field.name,
+        type: field.type,
+        title: field.title ?? startCase(field.name)
+      })) ?? []
+    })
+  ) ?? [], portableTextSchema = defineField({
+    type: "array",
+    name: "portable-text",
+    of: [
+      ...blockObjects.map((blockObject) => ({ type: blockObject.name })),
+      {
+        type: "block",
+        name: "block",
+        of: inlineObjects.map((inlineObject) => ({ type: inlineObject.name })),
+        marks: {
+          decorators: definition?.decorators?.map((decorator) => ({
+            title: decorator.title ?? startCase(decorator.name),
+            value: decorator.name
+          })) ?? [],
+          annotations: definition?.annotations?.map((annotation) => ({
+            name: annotation.name,
+            type: "object",
+            title: annotation.title,
+            fields: annotation.fields?.map((field) => ({
+              name: field.name,
+              title: field.title ?? startCase(field.name),
+              type: field.type
+            })) ?? []
+          })) ?? []
+        },
+        lists: definition?.lists?.map((list) => ({
+          value: list.name,
+          title: list.title ?? startCase(list.name)
+        })) ?? [],
+        styles: definition?.styles?.map((style) => ({
+          value: style.name,
+          title: style.title ?? startCase(style.name)
+        })) ?? []
+      }
+    ]
+  }), schema = Schema.compile({
+    types: [portableTextSchema, ...blockObjects, ...inlineObjects]
+  }).get("portable-text"), pteSchema = createPortableTextMemberSchemaTypes(schema);
+  return {
+    ...pteSchema,
+    blockObjects: pteSchema.blockObjects.map(
+      (blockObject) => objectNames[blockObject.name] !== void 0 ? {
+        ...blockObject,
+        name: objectNames[blockObject.name],
+        type: {
+          ...blockObject.type,
+          name: objectNames[blockObject.name]
+        }
+      } : blockObject
+    ),
+    inlineObjects: pteSchema.inlineObjects.map(
+      (inlineObject) => objectNames[inlineObject.name] !== void 0 ? {
+        ...inlineObject,
+        name: objectNames[inlineObject.name]
+      } : inlineObject
+    )
+  };
+}
+export {
+  compileSchemaDefinitionToPortableTextMemberSchemaTypes,
+  createPortableTextMemberSchemaTypes,
+  portableTextMemberSchemaTypesToSchema
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/portable-text-member-schema-types.ts","../src/portable-text-member-schema-types-to-schema.ts","../src/key-generator.ts","../src/schema-definition-to-portable-text-member-schema-types.ts"],"sourcesContent":["import type {\n  ArraySchemaType,\n  BlockDecoratorDefinition,\n  BlockListDefinition,\n  BlockSchemaType,\n  BlockStyleDefinition,\n  ObjectSchemaType,\n  PortableTextBlock,\n  SchemaType,\n  SpanSchemaType,\n} from '@sanity/types'\n\n/**\n * @public\n * Sanity-specific schema types for Portable Text.\n */\nexport type PortableTextMemberSchemaTypes = {\n  annotations: (ObjectSchemaType & {i18nTitleKey?: string})[]\n  block: ObjectSchemaType\n  blockObjects: ObjectSchemaType[]\n  decorators: BlockDecoratorDefinition[]\n  inlineObjects: ObjectSchemaType[]\n  portableText: ArraySchemaType<PortableTextBlock>\n  span: ObjectSchemaType\n  styles: BlockStyleDefinition[]\n  lists: BlockListDefinition[]\n}\n\n/**\n * @public\n * Create Sanity-specific schema types for Portable Text from a Sanity array\n * schema type.\n */\nexport function createPortableTextMemberSchemaTypes(\n  portableTextType: ArraySchemaType<PortableTextBlock>,\n): PortableTextMemberSchemaTypes {\n  if (!portableTextType) {\n    throw new Error(\"Parameter 'portabletextType' missing (required)\")\n  }\n  const blockType = portableTextType.of?.find(findBlockType) as\n    | BlockSchemaType\n    | undefined\n  if (!blockType) {\n    throw new Error('Block type is not defined in this schema (required)')\n  }\n  const childrenField = blockType.fields?.find(\n    (field) => field.name === 'children',\n  ) as {type: ArraySchemaType} | undefined\n  if (!childrenField) {\n    throw new Error('Children field for block type found in schema (required)')\n  }\n  const ofType = childrenField.type.of\n  if (!ofType) {\n    throw new Error(\n      'Valid types for block children not found in schema (required)',\n    )\n  }\n  const spanType = ofType.find((memberType) => memberType.name === 'span') as\n    | ObjectSchemaType\n    | undefined\n  if (!spanType) {\n    throw new Error('Span type not found in schema (required)')\n  }\n  const inlineObjectTypes = (ofType.filter(\n    (memberType) => memberType.name !== 'span',\n  ) || []) as ObjectSchemaType[]\n  const blockObjectTypes = (portableTextType.of?.filter(\n    (field) => field.name !== blockType.name,\n  ) || []) as ObjectSchemaType[]\n  return {\n    styles: resolveEnabledStyles(blockType),\n    decorators: resolveEnabledDecorators(spanType),\n    lists: resolveEnabledListItems(blockType),\n    block: blockType,\n    span: spanType,\n    portableText: portableTextType,\n    inlineObjects: inlineObjectTypes,\n    blockObjects: blockObjectTypes,\n    annotations: (spanType as SpanSchemaType).annotations,\n  }\n}\n\nfunction resolveEnabledStyles(blockType: ObjectSchemaType) {\n  const styleField = blockType.fields?.find(\n    (btField) => btField.name === 'style',\n  )\n  if (!styleField) {\n    throw new Error(\n      \"A field with name 'style' is not defined in the block type (required).\",\n    )\n  }\n  const textStyles =\n    styleField.type.options?.list &&\n    styleField.type.options.list?.filter(\n      (style: {value: string}) => style.value,\n    )\n  if (!textStyles || textStyles.length === 0) {\n    throw new Error(\n      'The style fields need at least one style ' +\n        \"defined. I.e: {title: 'Normal', value: 'normal'}.\",\n    )\n  }\n  return textStyles\n}\n\nfunction resolveEnabledDecorators(spanType: ObjectSchemaType) {\n  return (spanType as any).decorators\n}\n\nfunction resolveEnabledListItems(blockType: ObjectSchemaType) {\n  const listField = blockType.fields?.find(\n    (btField) => btField.name === 'listItem',\n  )\n  if (!listField) {\n    throw new Error(\n      \"A field with name 'listItem' is not defined in the block type (required).\",\n    )\n  }\n  const listItems =\n    listField.type.options?.list &&\n    listField.type.options.list.filter((list: {value: string}) => list.value)\n  if (!listItems) {\n    throw new Error('The list field need at least to be an empty array')\n  }\n  return listItems\n}\n\nfunction findBlockType(type: SchemaType): BlockSchemaType | null {\n  if (type.type) {\n    return findBlockType(type.type)\n  }\n\n  if (type.name === 'block') {\n    return type as BlockSchemaType\n  }\n\n  return null\n}\n","import type {Schema} from '@portabletext/schema'\nimport type {PortableTextMemberSchemaTypes} from './portable-text-member-schema-types'\n\n/**\n * @public\n * Convert Sanity-specific schema types for Portable Text to a first-class\n * Portable Text schema.\n */\nexport function portableTextMemberSchemaTypesToSchema(\n  schema: PortableTextMemberSchemaTypes,\n): Schema {\n  return {\n    annotations: schema.annotations.map((annotation) => ({\n      name: annotation.name,\n      fields: annotation.fields.map((field) => ({\n        name: field.name,\n        type: field.type.jsonType,\n        title: field.type.title,\n      })),\n      title: annotation.title,\n    })),\n    block: {\n      name: schema.block.name,\n    },\n    blockObjects: schema.blockObjects.map((blockObject) => ({\n      name: blockObject.name,\n      fields: blockObject.fields.map((field) => ({\n        name: field.name,\n        type: field.type.jsonType,\n        title: field.type.title,\n      })),\n      title: blockObject.title,\n    })),\n    decorators: schema.decorators.map((decorator) => ({\n      name: decorator.value,\n      title: decorator.title,\n      value: decorator.value,\n    })),\n    inlineObjects: schema.inlineObjects.map((inlineObject) => ({\n      name: inlineObject.name,\n      fields: inlineObject.fields.map((field) => ({\n        name: field.name,\n        type: field.type.jsonType,\n        title: field.type.title,\n      })),\n      title: inlineObject.title,\n    })),\n    span: {\n      name: schema.span.name,\n    },\n    styles: schema.styles.map((style) => ({\n      name: style.value,\n      title: style.title,\n      value: style.value,\n    })),\n    lists: schema.lists.map((list) => ({\n      name: list.value,\n      title: list.title,\n      value: list.value,\n    })),\n  }\n}\n","import getRandomValues from 'get-random-values-esm'\n\nexport const keyGenerator = (): string => randomKey(12)\n\nconst getByteHexTable = (() => {\n  let table: any[]\n  return () => {\n    if (table) {\n      return table\n    }\n\n    table = []\n    for (let i = 0; i < 256; ++i) {\n      table[i] = (i + 0x100).toString(16).slice(1)\n    }\n    return table\n  }\n})()\n\n// WHATWG crypto RNG - https://w3c.github.io/webcrypto/Overview.html\nfunction whatwgRNG(length = 16) {\n  const rnds8 = new Uint8Array(length)\n  getRandomValues(rnds8)\n  return rnds8\n}\n\nfunction randomKey(length?: number): string {\n  const table = getByteHexTable()\n  return whatwgRNG(length)\n    .reduce((str, n) => str + table[n], '')\n    .slice(0, length)\n}\n","import type {SchemaDefinition} from '@portabletext/schema'\nimport {Schema as SanitySchema} from '@sanity/schema'\nimport {defineField, defineType, type ObjectSchemaType} from '@sanity/types'\nimport startCase from 'lodash.startcase'\nimport {keyGenerator} from './key-generator'\nimport {\n  createPortableTextMemberSchemaTypes,\n  type PortableTextMemberSchemaTypes,\n} from './portable-text-member-schema-types'\n\nconst temporaryImageName = `tmp-${keyGenerator()}-image`\nconst temporaryUrlName = `tmp-${keyGenerator()}-url`\n\nconst temporaryObjectNames: Record<string, string> = {\n  image: temporaryImageName,\n  url: temporaryUrlName,\n}\n\nconst objectNames: Record<string, string> = {\n  [temporaryImageName]: 'image',\n  [temporaryUrlName]: 'url',\n}\n\nconst defaultObjectTitles: Record<string, string> = {\n  image: 'Image',\n  url: 'URL',\n}\n\n/**\n * @public\n * Compile a Portable Text schema definition to Sanity-specific schema types for\n * Portable Text.\n */\nexport function compileSchemaDefinitionToPortableTextMemberSchemaTypes(\n  definition?: SchemaDefinition,\n): PortableTextMemberSchemaTypes {\n  const blockObjects =\n    definition?.blockObjects?.map((blockObject) =>\n      defineType({\n        type: 'object',\n        // Very naive way to work around `SanitySchema.compile` adding default\n        // fields to objects with certain names.\n        name: temporaryObjectNames[blockObject.name] ?? blockObject.name,\n        title:\n          blockObject.title === undefined\n            ? // This avoids the default title which is a title case of the object name\n              defaultObjectTitles[blockObject.name]\n            : blockObject.title,\n        fields:\n          blockObject.fields?.map((field) => ({\n            name: field.name,\n            type: field.type,\n            title: field.title ?? startCase(field.name),\n          })) ?? [],\n      }),\n    ) ?? []\n\n  const inlineObjects =\n    definition?.inlineObjects?.map((inlineObject) =>\n      defineType({\n        type: 'object',\n        // Very naive way to work around `SanitySchema.compile` adding default\n        // fields to objects with certain names.\n        name: temporaryObjectNames[inlineObject.name] ?? inlineObject.name,\n\n        title:\n          inlineObject.title === undefined\n            ? // This avoids the default title which is a title case of the object name\n              defaultObjectTitles[inlineObject.name]\n            : inlineObject.title,\n        fields:\n          inlineObject.fields?.map((field) => ({\n            name: field.name,\n            type: field.type,\n            title: field.title ?? startCase(field.name),\n          })) ?? [],\n      }),\n    ) ?? []\n\n  const portableTextSchema = defineField({\n    type: 'array',\n    name: 'portable-text',\n    of: [\n      ...blockObjects.map((blockObject) => ({type: blockObject.name})),\n      {\n        type: 'block',\n        name: 'block',\n        of: inlineObjects.map((inlineObject) => ({type: inlineObject.name})),\n        marks: {\n          decorators:\n            definition?.decorators?.map((decorator) => ({\n              title: decorator.title ?? startCase(decorator.name),\n              value: decorator.name,\n            })) ?? [],\n          annotations:\n            definition?.annotations?.map((annotation) => ({\n              name: annotation.name,\n              type: 'object',\n              title: annotation.title,\n              fields:\n                annotation.fields?.map((field) => ({\n                  name: field.name,\n                  title: field.title ?? startCase(field.name),\n                  type: field.type,\n                })) ?? [],\n            })) ?? [],\n        },\n        lists:\n          definition?.lists?.map((list) => ({\n            value: list.name,\n            title: list.title ?? startCase(list.name),\n          })) ?? [],\n        styles:\n          definition?.styles?.map((style) => ({\n            value: style.name,\n            title: style.title ?? startCase(style.name),\n          })) ?? [],\n      },\n    ],\n  })\n\n  const schema = SanitySchema.compile({\n    types: [portableTextSchema, ...blockObjects, ...inlineObjects],\n  }).get('portable-text')\n\n  const pteSchema = createPortableTextMemberSchemaTypes(schema)\n\n  return {\n    ...pteSchema,\n    blockObjects: pteSchema.blockObjects.map((blockObject) =>\n      objectNames[blockObject.name] !== undefined\n        ? ({\n            ...blockObject,\n            name: objectNames[blockObject.name],\n            type: {\n              ...blockObject.type,\n              name: objectNames[blockObject.name],\n            },\n          } as ObjectSchemaType)\n        : blockObject,\n    ),\n    inlineObjects: pteSchema.inlineObjects.map((inlineObject) =>\n      objectNames[inlineObject.name] !== undefined\n        ? ({\n            ...inlineObject,\n            name: objectNames[inlineObject.name],\n          } as ObjectSchemaType)\n        : inlineObject,\n    ),\n  } satisfies PortableTextMemberSchemaTypes\n}\n"],"names":["SanitySchema"],"mappings":";;;;AAiCO,SAAS,oCACd,kBAC+B;AAC/B,MAAI,CAAC;AACH,UAAM,IAAI,MAAM,iDAAiD;AAEnE,QAAM,YAAY,iBAAiB,IAAI,KAAK,aAAa;AAGzD,MAAI,CAAC;AACH,UAAM,IAAI,MAAM,qDAAqD;AAEvE,QAAM,gBAAgB,UAAU,QAAQ;AAAA,IACtC,CAAC,UAAU,MAAM,SAAS;AAAA,EAAA;AAE5B,MAAI,CAAC;AACH,UAAM,IAAI,MAAM,0DAA0D;AAE5E,QAAM,SAAS,cAAc,KAAK;AAClC,MAAI,CAAC;AACH,UAAM,IAAI;AAAA,MACR;AAAA,IAAA;AAGJ,QAAM,WAAW,OAAO,KAAK,CAAC,eAAe,WAAW,SAAS,MAAM;AAGvE,MAAI,CAAC;AACH,UAAM,IAAI,MAAM,0CAA0C;AAE5D,QAAM,oBAAqB,OAAO;AAAA,IAChC,CAAC,eAAe,WAAW,SAAS;AAAA,EAAA,KACjC,IACC,mBAAoB,iBAAiB,IAAI;AAAA,IAC7C,CAAC,UAAU,MAAM,SAAS,UAAU;AAAA,EAAA,KACjC,CAAA;AACL,SAAO;AAAA,IACL,QAAQ,qBAAqB,SAAS;AAAA,IACtC,YAAY,yBAAyB,QAAQ;AAAA,IAC7C,OAAO,wBAAwB,SAAS;AAAA,IACxC,OAAO;AAAA,IACP,MAAM;AAAA,IACN,cAAc;AAAA,IACd,eAAe;AAAA,IACf,cAAc;AAAA,IACd,aAAc,SAA4B;AAAA,EAAA;AAE9C;AAEA,SAAS,qBAAqB,WAA6B;AACzD,QAAM,aAAa,UAAU,QAAQ;AAAA,IACnC,CAAC,YAAY,QAAQ,SAAS;AAAA,EAAA;AAEhC,MAAI,CAAC;AACH,UAAM,IAAI;AAAA,MACR;AAAA,IAAA;AAGJ,QAAM,aACJ,WAAW,KAAK,SAAS,QACzB,WAAW,KAAK,QAAQ,MAAM;AAAA,IAC5B,CAAC,UAA2B,MAAM;AAAA,EAAA;AAEtC,MAAI,CAAC,cAAc,WAAW,WAAW;AACvC,UAAM,IAAI;AAAA,MACR;AAAA,IAAA;AAIJ,SAAO;AACT;AAEA,SAAS,yBAAyB,UAA4B;AAC5D,SAAQ,SAAiB;AAC3B;AAEA,SAAS,wBAAwB,WAA6B;AAC5D,QAAM,YAAY,UAAU,QAAQ;AAAA,IAClC,CAAC,YAAY,QAAQ,SAAS;AAAA,EAAA;AAEhC,MAAI,CAAC;AACH,UAAM,IAAI;AAAA,MACR;AAAA,IAAA;AAGJ,QAAM,YACJ,UAAU,KAAK,SAAS,QACxB,UAAU,KAAK,QAAQ,KAAK,OAAO,CAAC,SAA0B,KAAK,KAAK;AAC1E,MAAI,CAAC;AACH,UAAM,IAAI,MAAM,mDAAmD;AAErE,SAAO;AACT;AAEA,SAAS,cAAc,MAA0C;AAC/D,SAAI,KAAK,OACA,cAAc,KAAK,IAAI,IAG5B,KAAK,SAAS,UACT,OAGF;AACT;ACjIO,SAAS,sCACd,QACQ;AACR,SAAO;AAAA,IACL,aAAa,OAAO,YAAY,IAAI,CAAC,gBAAgB;AAAA,MACnD,MAAM,WAAW;AAAA,MACjB,QAAQ,WAAW,OAAO,IAAI,CAAC,WAAW;AAAA,QACxC,MAAM,MAAM;AAAA,QACZ,MAAM,MAAM,KAAK;AAAA,QACjB,OAAO,MAAM,KAAK;AAAA,MAAA,EAClB;AAAA,MACF,OAAO,WAAW;AAAA,IAAA,EAClB;AAAA,IACF,OAAO;AAAA,MACL,MAAM,OAAO,MAAM;AAAA,IAAA;AAAA,IAErB,cAAc,OAAO,aAAa,IAAI,CAAC,iBAAiB;AAAA,MACtD,MAAM,YAAY;AAAA,MAClB,QAAQ,YAAY,OAAO,IAAI,CAAC,WAAW;AAAA,QACzC,MAAM,MAAM;AAAA,QACZ,MAAM,MAAM,KAAK;AAAA,QACjB,OAAO,MAAM,KAAK;AAAA,MAAA,EAClB;AAAA,MACF,OAAO,YAAY;AAAA,IAAA,EACnB;AAAA,IACF,YAAY,OAAO,WAAW,IAAI,CAAC,eAAe;AAAA,MAChD,MAAM,UAAU;AAAA,MAChB,OAAO,UAAU;AAAA,MACjB,OAAO,UAAU;AAAA,IAAA,EACjB;AAAA,IACF,eAAe,OAAO,cAAc,IAAI,CAAC,kBAAkB;AAAA,MACzD,MAAM,aAAa;AAAA,MACnB,QAAQ,aAAa,OAAO,IAAI,CAAC,WAAW;AAAA,QAC1C,MAAM,MAAM;AAAA,QACZ,MAAM,MAAM,KAAK;AAAA,QACjB,OAAO,MAAM,KAAK;AAAA,MAAA,EAClB;AAAA,MACF,OAAO,aAAa;AAAA,IAAA,EACpB;AAAA,IACF,MAAM;AAAA,MACJ,MAAM,OAAO,KAAK;AAAA,IAAA;AAAA,IAEpB,QAAQ,OAAO,OAAO,IAAI,CAAC,WAAW;AAAA,MACpC,MAAM,MAAM;AAAA,MACZ,OAAO,MAAM;AAAA,MACb,OAAO,MAAM;AAAA,IAAA,EACb;AAAA,IACF,OAAO,OAAO,MAAM,IAAI,CAAC,UAAU;AAAA,MACjC,MAAM,KAAK;AAAA,MACX,OAAO,KAAK;AAAA,MACZ,OAAO,KAAK;AAAA,IAAA,EACZ;AAAA,EAAA;AAEN;AC3DO,MAAM,eAAe,MAAc,UAAU,EAAE,GAEhD,kBAAmB,uBAAM;AAC7B,MAAI;AACJ,SAAO,MAAM;AACX,QAAI;AACF,aAAO;AAGT,YAAQ,CAAA;AACR,aAAS,IAAI,GAAG,IAAI,KAAK,EAAE;AACzB,YAAM,CAAC,KAAK,IAAI,KAAO,SAAS,EAAE,EAAE,MAAM,CAAC;AAE7C,WAAO;AAAA,EACT;AACF,GAAA;AAGA,SAAS,UAAU,SAAS,IAAI;AAC9B,QAAM,QAAQ,IAAI,WAAW,MAAM;AACnC,SAAA,gBAAgB,KAAK,GACd;AACT;AAEA,SAAS,UAAU,QAAyB;AAC1C,QAAM,QAAQ,gBAAA;AACd,SAAO,UAAU,MAAM,EACpB,OAAO,CAAC,KAAK,MAAM,MAAM,MAAM,CAAC,GAAG,EAAE,EACrC,MAAM,GAAG,MAAM;AACpB;ACrBA,MAAM,qBAAqB,OAAO,aAAA,CAAc,UAC1C,mBAAmB,OAAO,aAAA,CAAc,QAExC,uBAA+C;AAAA,EACnD,OAAO;AAAA,EACP,KAAK;AACP,GAEM,cAAsC;AAAA,EAC1C,CAAC,kBAAkB,GAAG;AAAA,EACtB,CAAC,gBAAgB,GAAG;AACtB,GAEM,sBAA8C;AAAA,EAClD,OAAO;AAAA,EACP,KAAK;AACP;AAOO,SAAS,uDACd,YAC+B;AAC/B,QAAM,eACJ,YAAY,cAAc;AAAA,IAAI,CAAC,gBAC7B,WAAW;AAAA,MACT,MAAM;AAAA;AAAA;AAAA,MAGN,MAAM,qBAAqB,YAAY,IAAI,KAAK,YAAY;AAAA,MAC5D,OACE,YAAY,UAAU;AAAA;AAAA,QAElB,oBAAoB,YAAY,IAAI;AAAA,UACpC,YAAY;AAAA,MAClB,QACE,YAAY,QAAQ,IAAI,CAAC,WAAW;AAAA,QAClC,MAAM,MAAM;AAAA,QACZ,MAAM,MAAM;AAAA,QACZ,OAAO,MAAM,SAAS,UAAU,MAAM,IAAI;AAAA,MAAA,EAC1C,KAAK,CAAA;AAAA,IAAC,CACX;AAAA,EAAA,KACE,IAED,gBACJ,YAAY,eAAe;AAAA,IAAI,CAAC,iBAC9B,WAAW;AAAA,MACT,MAAM;AAAA;AAAA;AAAA,MAGN,MAAM,qBAAqB,aAAa,IAAI,KAAK,aAAa;AAAA,MAE9D,OACE,aAAa,UAAU;AAAA;AAAA,QAEnB,oBAAoB,aAAa,IAAI;AAAA,UACrC,aAAa;AAAA,MACnB,QACE,aAAa,QAAQ,IAAI,CAAC,WAAW;AAAA,QACnC,MAAM,MAAM;AAAA,QACZ,MAAM,MAAM;AAAA,QACZ,OAAO,MAAM,SAAS,UAAU,MAAM,IAAI;AAAA,MAAA,EAC1C,KAAK,CAAA;AAAA,IAAC,CACX;AAAA,EAAA,KACE,CAAA,GAED,qBAAqB,YAAY;AAAA,IACrC,MAAM;AAAA,IACN,MAAM;AAAA,IACN,IAAI;AAAA,MACF,GAAG,aAAa,IAAI,CAAC,iBAAiB,EAAC,MAAM,YAAY,KAAA,EAAM;AAAA,MAC/D;AAAA,QACE,MAAM;AAAA,QACN,MAAM;AAAA,QACN,IAAI,cAAc,IAAI,CAAC,kBAAkB,EAAC,MAAM,aAAa,KAAA,EAAM;AAAA,QACnE,OAAO;AAAA,UACL,YACE,YAAY,YAAY,IAAI,CAAC,eAAe;AAAA,YAC1C,OAAO,UAAU,SAAS,UAAU,UAAU,IAAI;AAAA,YAClD,OAAO,UAAU;AAAA,UAAA,EACjB,KAAK,CAAA;AAAA,UACT,aACE,YAAY,aAAa,IAAI,CAAC,gBAAgB;AAAA,YAC5C,MAAM,WAAW;AAAA,YACjB,MAAM;AAAA,YACN,OAAO,WAAW;AAAA,YAClB,QACE,WAAW,QAAQ,IAAI,CAAC,WAAW;AAAA,cACjC,MAAM,MAAM;AAAA,cACZ,OAAO,MAAM,SAAS,UAAU,MAAM,IAAI;AAAA,cAC1C,MAAM,MAAM;AAAA,YAAA,EACZ,KAAK,CAAA;AAAA,UAAC,EACV,KAAK,CAAA;AAAA,QAAC;AAAA,QAEZ,OACE,YAAY,OAAO,IAAI,CAAC,UAAU;AAAA,UAChC,OAAO,KAAK;AAAA,UACZ,OAAO,KAAK,SAAS,UAAU,KAAK,IAAI;AAAA,QAAA,EACxC,KAAK,CAAA;AAAA,QACT,QACE,YAAY,QAAQ,IAAI,CAAC,WAAW;AAAA,UAClC,OAAO,MAAM;AAAA,UACb,OAAO,MAAM,SAAS,UAAU,MAAM,IAAI;AAAA,QAAA,EAC1C,KAAK,CAAA;AAAA,MAAC;AAAA,IACZ;AAAA,EACF,CACD,GAEK,SAASA,OAAa,QAAQ;AAAA,IAClC,OAAO,CAAC,oBAAoB,GAAG,cAAc,GAAG,aAAa;AAAA,EAAA,CAC9D,EAAE,IAAI,eAAe,GAEhB,YAAY,oCAAoC,MAAM;AAE5D,SAAO;AAAA,IACL,GAAG;AAAA,IACH,cAAc,UAAU,aAAa;AAAA,MAAI,CAAC,gBACxC,YAAY,YAAY,IAAI,MAAM,SAC7B;AAAA,QACC,GAAG;AAAA,QACH,MAAM,YAAY,YAAY,IAAI;AAAA,QAClC,MAAM;AAAA,UACJ,GAAG,YAAY;AAAA,UACf,MAAM,YAAY,YAAY,IAAI;AAAA,QAAA;AAAA,MACpC,IAEF;AAAA,IAAA;AAAA,IAEN,eAAe,UAAU,cAAc;AAAA,MAAI,CAAC,iBAC1C,YAAY,aAAa,IAAI,MAAM,SAC9B;AAAA,QACC,GAAG;AAAA,QACH,MAAM,YAAY,aAAa,IAAI;AAAA,MAAA,IAErC;AAAA,IAAA;AAAA,EACN;AAEJ;"}

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@portabletext/sanity-bridge",
+  "version": "0.0.0",
+  "description": "Convert a Sanity Schema to a Portable Text Schema",
+  "keywords": [
+    "sanity",
+    "portable-text"
+  ],
+  "homepage": "https://www.portabletext.org/",
+  "bugs": {
+    "url": "https://github.com/portabletext/editor/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/portabletext/editor.git",
+    "directory": "packages/sanity-bridge"
+  },
+  "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"
+  ],
+  "dependencies": {
+    "get-random-values-esm": "^1.0.2",
+    "lodash.startcase": "^4.4.0",
+    "@portabletext/schema": "0.0.0"
+  },
+  "devDependencies": {
+    "@sanity/pkg-utils": "^7.11.1",
+    "@sanity/schema": "^4.3.0",
+    "@sanity/types": "^4.3.0",
+    "@types/lodash.startcase": "^4.4.9",
+    "typescript": "^5.9.2"
+  },
+  "peerDependencies": {
+    "@sanity/schema": "^4.3.0",
+    "@sanity/types": "^4.3.0"
+  },
+  "engines": {
+    "node": ">=20.19"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "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/index.ts

@@ -0,0 +1,6 @@
+export {
+  createPortableTextMemberSchemaTypes,
+  type PortableTextMemberSchemaTypes,
+} from './portable-text-member-schema-types'
+export {portableTextMemberSchemaTypesToSchema} from './portable-text-member-schema-types-to-schema'
+export {compileSchemaDefinitionToPortableTextMemberSchemaTypes} from './schema-definition-to-portable-text-member-schema-types'

package/src/key-generator.ts

@@ -0,0 +1,32 @@
+import getRandomValues from 'get-random-values-esm'
+
+export const keyGenerator = (): string => randomKey(12)
+
+const getByteHexTable = (() => {
+  let table: any[]
+  return () => {
+    if (table) {
+      return table
+    }
+
+    table = []
+    for (let i = 0; i < 256; ++i) {
+      table[i] = (i + 0x100).toString(16).slice(1)
+    }
+    return table
+  }
+})()
+
+// WHATWG crypto RNG - https://w3c.github.io/webcrypto/Overview.html
+function whatwgRNG(length = 16) {
+  const rnds8 = new Uint8Array(length)
+  getRandomValues(rnds8)
+  return rnds8
+}
+
+function randomKey(length?: number): string {
+  const table = getByteHexTable()
+  return whatwgRNG(length)
+    .reduce((str, n) => str + table[n], '')
+    .slice(0, length)
+}

package/src/portable-text-member-schema-types-to-schema.ts

@@ -0,0 +1,62 @@
+import type {Schema} from '@portabletext/schema'
+import type {PortableTextMemberSchemaTypes} from './portable-text-member-schema-types'
+
+/**
+ * @public
+ * Convert Sanity-specific schema types for Portable Text to a first-class
+ * Portable Text schema.
+ */
+export function portableTextMemberSchemaTypesToSchema(
+  schema: PortableTextMemberSchemaTypes,
+): Schema {
+  return {
+    annotations: schema.annotations.map((annotation) => ({
+      name: annotation.name,
+      fields: annotation.fields.map((field) => ({
+        name: field.name,
+        type: field.type.jsonType,
+        title: field.type.title,
+      })),
+      title: annotation.title,
+    })),
+    block: {
+      name: schema.block.name,
+    },
+    blockObjects: schema.blockObjects.map((blockObject) => ({
+      name: blockObject.name,
+      fields: blockObject.fields.map((field) => ({
+        name: field.name,
+        type: field.type.jsonType,
+        title: field.type.title,
+      })),
+      title: blockObject.title,
+    })),
+    decorators: schema.decorators.map((decorator) => ({
+      name: decorator.value,
+      title: decorator.title,
+      value: decorator.value,
+    })),
+    inlineObjects: schema.inlineObjects.map((inlineObject) => ({
+      name: inlineObject.name,
+      fields: inlineObject.fields.map((field) => ({
+        name: field.name,
+        type: field.type.jsonType,
+        title: field.type.title,
+      })),
+      title: inlineObject.title,
+    })),
+    span: {
+      name: schema.span.name,
+    },
+    styles: schema.styles.map((style) => ({
+      name: style.value,
+      title: style.title,
+      value: style.value,
+    })),
+    lists: schema.lists.map((list) => ({
+      name: list.value,
+      title: list.title,
+      value: list.value,
+    })),
+  }
+}

package/src/portable-text-member-schema-types.ts

@@ -0,0 +1,138 @@
+import type {
+  ArraySchemaType,
+  BlockDecoratorDefinition,
+  BlockListDefinition,
+  BlockSchemaType,
+  BlockStyleDefinition,
+  ObjectSchemaType,
+  PortableTextBlock,
+  SchemaType,
+  SpanSchemaType,
+} from '@sanity/types'
+
+/**
+ * @public
+ * Sanity-specific schema types for Portable Text.
+ */
+export type PortableTextMemberSchemaTypes = {
+  annotations: (ObjectSchemaType & {i18nTitleKey?: string})[]
+  block: ObjectSchemaType
+  blockObjects: ObjectSchemaType[]
+  decorators: BlockDecoratorDefinition[]
+  inlineObjects: ObjectSchemaType[]
+  portableText: ArraySchemaType<PortableTextBlock>
+  span: ObjectSchemaType
+  styles: BlockStyleDefinition[]
+  lists: BlockListDefinition[]
+}
+
+/**
+ * @public
+ * Create Sanity-specific schema types for Portable Text from a Sanity array
+ * schema type.
+ */
+export function createPortableTextMemberSchemaTypes(
+  portableTextType: ArraySchemaType<PortableTextBlock>,
+): PortableTextMemberSchemaTypes {
+  if (!portableTextType) {
+    throw new Error("Parameter 'portabletextType' missing (required)")
+  }
+  const blockType = portableTextType.of?.find(findBlockType) as
+    | BlockSchemaType
+    | undefined
+  if (!blockType) {
+    throw new Error('Block type is not defined in this schema (required)')
+  }
+  const childrenField = blockType.fields?.find(
+    (field) => field.name === 'children',
+  ) as {type: ArraySchemaType} | undefined
+  if (!childrenField) {
+    throw new Error('Children field for block type found in schema (required)')
+  }
+  const ofType = childrenField.type.of
+  if (!ofType) {
+    throw new Error(
+      'Valid types for block children not found in schema (required)',
+    )
+  }
+  const spanType = ofType.find((memberType) => memberType.name === 'span') as
+    | ObjectSchemaType
+    | undefined
+  if (!spanType) {
+    throw new Error('Span type not found in schema (required)')
+  }
+  const inlineObjectTypes = (ofType.filter(
+    (memberType) => memberType.name !== 'span',
+  ) || []) as ObjectSchemaType[]
+  const blockObjectTypes = (portableTextType.of?.filter(
+    (field) => field.name !== blockType.name,
+  ) || []) as ObjectSchemaType[]
+  return {
+    styles: resolveEnabledStyles(blockType),
+    decorators: resolveEnabledDecorators(spanType),
+    lists: resolveEnabledListItems(blockType),
+    block: blockType,
+    span: spanType,
+    portableText: portableTextType,
+    inlineObjects: inlineObjectTypes,
+    blockObjects: blockObjectTypes,
+    annotations: (spanType as SpanSchemaType).annotations,
+  }
+}
+
+function resolveEnabledStyles(blockType: ObjectSchemaType) {
+  const styleField = blockType.fields?.find(
+    (btField) => btField.name === 'style',
+  )
+  if (!styleField) {
+    throw new Error(
+      "A field with name 'style' is not defined in the block type (required).",
+    )
+  }
+  const textStyles =
+    styleField.type.options?.list &&
+    styleField.type.options.list?.filter(
+      (style: {value: string}) => style.value,
+    )
+  if (!textStyles || textStyles.length === 0) {
+    throw new Error(
+      'The style fields need at least one style ' +
+        "defined. I.e: {title: 'Normal', value: 'normal'}.",
+    )
+  }
+  return textStyles
+}
+
+function resolveEnabledDecorators(spanType: ObjectSchemaType) {
+  return (spanType as any).decorators
+}
+
+function resolveEnabledListItems(blockType: ObjectSchemaType) {
+  const listField = blockType.fields?.find(
+    (btField) => btField.name === 'listItem',
+  )
+  if (!listField) {
+    throw new Error(
+      "A field with name 'listItem' is not defined in the block type (required).",
+    )
+  }
+  const listItems =
+    listField.type.options?.list &&
+    listField.type.options.list.filter((list: {value: string}) => list.value)
+  if (!listItems) {
+    throw new Error('The list field need at least to be an empty array')
+  }
+  return listItems
+}
+
+function findBlockType(type: SchemaType): BlockSchemaType | null {
+  if (type.type) {
+    return findBlockType(type.type)
+  }
+
+  if (type.name === 'block') {
+    return type as BlockSchemaType
+  }
+
+  return null
+}

package/src/schema-definition-to-portable-text-member-schema-types.ts

@@ -0,0 +1,151 @@
+import type {SchemaDefinition} from '@portabletext/schema'
+import {Schema as SanitySchema} from '@sanity/schema'
+import {defineField, defineType, type ObjectSchemaType} from '@sanity/types'
+import startCase from 'lodash.startcase'
+import {keyGenerator} from './key-generator'
+import {
+  createPortableTextMemberSchemaTypes,
+  type PortableTextMemberSchemaTypes,
+} from './portable-text-member-schema-types'
+
+const temporaryImageName = `tmp-${keyGenerator()}-image`
+const temporaryUrlName = `tmp-${keyGenerator()}-url`
+
+const temporaryObjectNames: Record<string, string> = {
+  image: temporaryImageName,
+  url: temporaryUrlName,
+}
+
+const objectNames: Record<string, string> = {
+  [temporaryImageName]: 'image',
+  [temporaryUrlName]: 'url',
+}
+
+const defaultObjectTitles: Record<string, string> = {
+  image: 'Image',
+  url: 'URL',
+}
+
+/**
+ * @public
+ * Compile a Portable Text schema definition to Sanity-specific schema types for
+ * Portable Text.
+ */
+export function compileSchemaDefinitionToPortableTextMemberSchemaTypes(
+  definition?: SchemaDefinition,
+): PortableTextMemberSchemaTypes {
+  const blockObjects =
+    definition?.blockObjects?.map((blockObject) =>
+      defineType({
+        type: 'object',
+        // Very naive way to work around `SanitySchema.compile` adding default
+        // fields to objects with certain names.
+        name: temporaryObjectNames[blockObject.name] ?? blockObject.name,
+        title:
+          blockObject.title === undefined
+            ? // This avoids the default title which is a title case of the object name
+              defaultObjectTitles[blockObject.name]
+            : blockObject.title,
+        fields:
+          blockObject.fields?.map((field) => ({
+            name: field.name,
+            type: field.type,
+            title: field.title ?? startCase(field.name),
+          })) ?? [],
+      }),
+    ) ?? []
+
+  const inlineObjects =
+    definition?.inlineObjects?.map((inlineObject) =>
+      defineType({
+        type: 'object',
+        // Very naive way to work around `SanitySchema.compile` adding default
+        // fields to objects with certain names.
+        name: temporaryObjectNames[inlineObject.name] ?? inlineObject.name,
+
+        title:
+          inlineObject.title === undefined
+            ? // This avoids the default title which is a title case of the object name
+              defaultObjectTitles[inlineObject.name]
+            : inlineObject.title,
+        fields:
+          inlineObject.fields?.map((field) => ({
+            name: field.name,
+            type: field.type,
+            title: field.title ?? startCase(field.name),
+          })) ?? [],
+      }),
+    ) ?? []
+
+  const portableTextSchema = defineField({
+    type: 'array',
+    name: 'portable-text',
+    of: [
+      ...blockObjects.map((blockObject) => ({type: blockObject.name})),
+      {
+        type: 'block',
+        name: 'block',
+        of: inlineObjects.map((inlineObject) => ({type: inlineObject.name})),
+        marks: {
+          decorators:
+            definition?.decorators?.map((decorator) => ({
+              title: decorator.title ?? startCase(decorator.name),
+              value: decorator.name,
+            })) ?? [],
+          annotations:
+            definition?.annotations?.map((annotation) => ({
+              name: annotation.name,
+              type: 'object',
+              title: annotation.title,
+              fields:
+                annotation.fields?.map((field) => ({
+                  name: field.name,
+                  title: field.title ?? startCase(field.name),
+                  type: field.type,
+                })) ?? [],
+            })) ?? [],
+        },
+        lists:
+          definition?.lists?.map((list) => ({
+            value: list.name,
+            title: list.title ?? startCase(list.name),
+          })) ?? [],
+        styles:
+          definition?.styles?.map((style) => ({
+            value: style.name,
+            title: style.title ?? startCase(style.name),
+          })) ?? [],
+      },
+    ],
+  })
+
+  const schema = SanitySchema.compile({
+    types: [portableTextSchema, ...blockObjects, ...inlineObjects],
+  }).get('portable-text')
+
+  const pteSchema = createPortableTextMemberSchemaTypes(schema)
+
+  return {
+    ...pteSchema,
+    blockObjects: pteSchema.blockObjects.map((blockObject) =>
+      objectNames[blockObject.name] !== undefined
+        ? ({
+            ...blockObject,
+            name: objectNames[blockObject.name],
+            type: {
+              ...blockObject.type,
+              name: objectNames[blockObject.name],
+            },
+          } as ObjectSchemaType)
+        : blockObject,
+    ),
+    inlineObjects: pteSchema.inlineObjects.map((inlineObject) =>
+      objectNames[inlineObject.name] !== undefined
+        ? ({
+            ...inlineObject,
+            name: objectNames[inlineObject.name],
+          } as ObjectSchemaType)
+        : inlineObject,
+    ),
+  } satisfies PortableTextMemberSchemaTypes
+}