@platecms/delta-cast 1.2.0 → 1.3.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@platecms/delta-cast",
   "description": "Package containing the definition of CAST",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "license": "UNLICENSED",
   "publishConfig": {
     "access": "public"
@@ -22,6 +22,6 @@
     "tslib": "2.8.1"
   },
   "peerDependencies": {
-    "@platecms/delta-plate-resource-notation": "1.2.0"
+    "@platecms/delta-plate-resource-notation": "1.3.0"
   }
 }

package/src/lib/schemas/schema.json

@@ -52,13 +52,16 @@
             },
             "type": "object"
         },
-        "CasSuggestion": {
+        "CastSuggestion": {
             "description": "A CAS suggestion node.",
             "properties": {
                 "data": {
                     "$ref": "#/definitions/Data",
                     "description": "Info from the ecosystem."
                 },
+                "endIndex": {
+                    "type": "number"
+                },
                 "message": {
                     "description": "A message explaining the suggestion.",
                     "type": "string"
@@ -78,15 +81,15 @@
                     "$ref": "#/definitions/Position",
                     "description": "Position of a node in a source document.\n\nNodes that are generated (not in the original source document) must not\nhave a position."
                 },
+                "startIndex": {
+                    "type": "number"
+                },
                 "suggested": {
-                    "description": "The suggested replacement content.",
-                    "items": {
-                        "$ref": "#/definitions/Content"
-                    },
-                    "type": "array"
+                    "$ref": "#/definitions/InterpolatedContentValue",
+                    "description": "The suggested replacement content."
                 },
                 "type": {
-                    "const": "casSuggestion",
+                    "const": "castSuggestion",
                     "description": "Node type.",
                     "type": "string"
                 }
@@ -143,7 +146,7 @@
                     "$ref": "#/definitions/ListItem"
                 },
                 {
-                    "$ref": "#/definitions/CasSuggestion"
+                    "$ref": "#/definitions/CastSuggestion"
                 },
                 {
                     "$ref": "#/definitions/Bold"
@@ -174,38 +177,9 @@
                 },
                 {
                     "$ref": "#/definitions/InternalLink"
-                },
-                {
-                    "$ref": "#/definitions/ContentValueSuggestion"
                 }
             ]
         },
-        "ContentValueSuggestion": {
-            "properties": {
-                "data": {
-                    "$ref": "#/definitions/Data",
-                    "description": "Info from the ecosystem."
-                },
-                "position": {
-                    "$ref": "#/definitions/Position",
-                    "description": "Position of a node in a source document.\n\nNodes that are generated (not in the original source document) must not\nhave a position."
-                },
-                "prn": {
-                    "description": "The PRN (identifier) of the referenced Content Value.",
-                    "type": "string"
-                },
-                "type": {
-                    "const": "contentValueSuggestion",
-                    "description": "Node type.",
-                    "type": "string"
-                },
-                "value": {
-                    "$ref": "#/definitions/Root",
-                    "description": "The nested CAST tree of the referenced Content Value."
-                }
-            },
-            "type": "object"
-        },
         "Data": {
             "description": "Info associated with nodes by the ecosystem.\n\nThis space is guaranteed to never be specified by unist or specifications\nimplementing unist.\nBut you can use it in utilities and plugins to store data.\n\nThis type can be augmented to register custom data.\nFor example:\n\n```ts\ndeclare module 'unist' {\n  interface Data {\n    // `someNode.data.myId` is typed as `number | undefined`\n    myId?: number | undefined\n  }\n}\n```",
             "type": "object"
@@ -335,7 +309,7 @@
         "InlineContent": {
             "anyOf": [
                 {
-                    "$ref": "#/definitions/CasSuggestion"
+                    "$ref": "#/definitions/CastSuggestion"
                 },
                 {
                     "$ref": "#/definitions/Bold"
@@ -366,9 +340,6 @@
                 },
                 {
                     "$ref": "#/definitions/InternalLink"
-                },
-                {
-                    "$ref": "#/definitions/ContentValueSuggestion"
                 }
             ]
         },

package/src/lib/schemas/schema.ts

@@ -1,6 +1,6 @@
 import { Node, Literal as UnistLiteral, Parent as UnistParent } from "unist";
 
-export type Content = BlockContent | CasSuggestion | InlineContent;
+export type Content = BlockContent | CastSuggestion | InlineContent;
 
 export type BlockContent = BlockContentMap[keyof BlockContentMap];
 export type InlineContent = InlineContentMap[keyof InlineContentMap];
@@ -26,8 +26,7 @@ export interface InlineContentMap {
   contentValue: InterpolatedContentValue;
   externalLink: ExternalLink;
   internalLink: InternalLink;
-  casSuggestion: CasSuggestion;
-  contentValueSuggestion: ContentValueSuggestion;
+  castSuggestion: CastSuggestion;
 }
 
 export interface Parent extends UnistParent {
@@ -202,20 +201,6 @@ export interface InterpolatedContentValue extends Node {
   value?: Root;
 }
 
-export interface ContentValueSuggestion extends Node {
-  type: "contentValueSuggestion";
-
-  /**
-   * The PRN (identifier) of the referenced Content Value.
-   */
-  prn: string;
-
-  /**
-   * The nested CAST tree of the referenced Content Value.
-   */
-  value?: Root;
-}
-
 export interface ExternalLink extends Parent {
   type: "externalLink";
 
@@ -252,8 +237,10 @@ export interface InternalLink extends Parent {
 /**
  * A CAS suggestion node.
  */
-export interface CasSuggestion extends Node {
-  type: "casSuggestion";
+export interface CastSuggestion extends Node {
+  startIndex: number;
+  endIndex: number;
+  type: "castSuggestion";
 
   /**
    * The original content that is suggested to be replaced.
@@ -263,7 +250,7 @@ export interface CasSuggestion extends Node {
   /**
    * The suggested replacement content.
    */
-  suggested: Content[];
+  suggested: InterpolatedContentValue;
 
   /**
    * A message explaining the suggestion.

package/src/lib/validate-cast.spec.ts

@@ -2,7 +2,7 @@ import { validateCast } from "./validate-cast";
 import {
   Blockquote,
   Bold,
-  CasSuggestion,
+  CastSuggestion,
   Code,
   Content,
   ExternalLink,
@@ -103,12 +103,18 @@ describe("validateCast", () => {
       [
         "valid cas suggestion",
         {
-          type: "casSuggestion",
+          startIndex: 0,
+          endIndex: 10,
+          type: "castSuggestion",
           original: [{ type: "text", value: "Original text" }],
-          suggested: [{ type: "text", value: "Suggested text" }],
+          suggested: {
+            type: "contentValue",
+            value: { type: "root", children: [{ type: "text", value: "Suggested text" }] },
+            prn: "prn:plate-dev:1234:cms:test:abcd",
+          } satisfies InterpolatedContentValue,
           message: "This is a suggestion",
           method: "database; reusable",
-        } satisfies CasSuggestion,
+        } satisfies CastSuggestion,
       ],
     ])("validates a %s", (_, input) => {
       const root: Root = { type: "root", children: [input as Content] };
@@ -334,24 +340,11 @@ describe("validateCast", () => {
           type: "root",
           children: [
             {
-              type: "casSuggestion",
+              startIndex: 0,
+              endIndex: 10,
+              type: "castSuggestion",
               original: "notAnArray" as unknown as InlineContent[],
-              suggested: [{ type: "text", value: "Suggested text" }],
-              message: "This is a suggestion",
-              method: "database; reusable",
-            },
-          ],
-        } satisfies Root,
-      ],
-      [
-        "invalid cas suggestion - suggested not an array",
-        {
-          type: "root",
-          children: [
-            {
-              type: "casSuggestion",
-              original: [{ type: "text", value: "Original text" }],
-              suggested: "notAnArray" as unknown as InlineContent[],
+              suggested: "notAnArray" as unknown as InterpolatedContentValue,
               message: "This is a suggestion",
               method: "database; reusable",
             },
@@ -364,9 +357,11 @@ describe("validateCast", () => {
           type: "root",
           children: [
             {
-              type: "casSuggestion",
+              startIndex: 0,
+              endIndex: 10,
+              type: "castSuggestion",
               original: [{ type: "text", value: "Original text" }],
-              suggested: [{ type: "text", value: "Suggested text" }],
+              suggested: [{ type: "text", value: "Suggested text" }] as unknown as InterpolatedContentValue,
               message: null as unknown as string,
               method: "database; reusable",
             },
@@ -379,9 +374,11 @@ describe("validateCast", () => {
           type: "root",
           children: [
             {
-              type: "casSuggestion",
+              startIndex: 0,
+              endIndex: 10,
+              type: "castSuggestion",
               original: [{ type: "text", value: "Original text" }],
-              suggested: [{ type: "text", value: "Suggested text" }],
+              suggested: [{ type: "text", value: "Suggested text" }] as unknown as InterpolatedContentValue,
               message: "This is a suggestion",
               method: 123 as unknown as string,
             },

package/src/lib/validate-cast.ts

@@ -1,5 +1,5 @@
 import {
-  CasSuggestion,
+  CastSuggestion,
   Code,
   Content,
   ExternalLink,
@@ -138,37 +138,35 @@ function assertValidInternalLink(value: unknown): asserts value is InternalLink
   link.children.forEach(assertTextNode);
 }
 
-function assertValidCasSuggestion(value: unknown): asserts value is CasSuggestion {
+function assertValidCastSuggestion(value: unknown): asserts value is CastSuggestion {
   assertNonNullObject(value);
 
-  const suggestion = value as CasSuggestion;
+  const suggestion = value as CastSuggestion;
 
   // Validate required fields
   if (!Array.isArray(suggestion.original)) {
-    throw new InvalidCastError("Invalid casSuggestion: original must be an array");
+    throw new InvalidCastError("Invalid castSuggestion: original must be an array");
   }
 
-  if (!Array.isArray(suggestion.suggested)) {
-    throw new InvalidCastError("Invalid casSuggestion: suggested must be an array");
+  if (suggestion.suggested === null) {
+    throw new InvalidCastError("Invalid castSuggestion: suggested must be an array");
   }
 
   if (typeof suggestion.message !== "string") {
-    throw new InvalidCastError("Invalid casSuggestion: message must be a string");
+    throw new InvalidCastError("Invalid castSuggestion: message must be a string");
   }
 
   if (typeof suggestion.method !== "string") {
-    throw new InvalidCastError("Invalid casSuggestion: method must be a string");
+    throw new InvalidCastError("Invalid castSuggestion: method must be a string");
   }
 
   // eslint-disable-next-line @typescript-eslint/no-use-before-define
   suggestion.original.forEach(assertValidContent);
-
-  // eslint-disable-next-line @typescript-eslint/no-use-before-define
-  suggestion.suggested.forEach(assertValidContent);
 }
 
-function assertValidContent(value: unknown): asserts value is Content {
+export function assertValidContent(value: unknown): asserts value is Content {
   assertNonNullObject(value);
+
   const content = value as Content;
   switch (content.type) {
     case "paragraph":
@@ -187,8 +185,8 @@ function assertValidContent(value: unknown): asserts value is Content {
     case "internalLink":
       assertValidInternalLink(content);
       break;
-    case "casSuggestion":
-      assertValidCasSuggestion(content);
+    case "castSuggestion":
+      assertValidCastSuggestion(content);
       break;
     case "heading":
       assertValidHeading(content);