@platecms/delta-cast 0.8.0 → 0.9.0

package/package.json

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

package/src/lib/schemas/schema.json

@@ -52,6 +52,47 @@
             },
             "type": "object"
         },
+        "CasSuggestion": {
+            "description": "A CAS suggestion node.",
+            "properties": {
+                "data": {
+                    "$ref": "#/definitions/Data",
+                    "description": "Info from the ecosystem."
+                },
+                "message": {
+                    "description": "A message explaining the suggestion.",
+                    "type": "string"
+                },
+                "method": {
+                    "description": "The method or algorithm that created the suggestion (e.g. \"database; reusable\")",
+                    "type": "string"
+                },
+                "original": {
+                    "description": "The original content that is suggested to be replaced.",
+                    "items": {
+                        "$ref": "#/definitions/Content"
+                    },
+                    "type": "array"
+                },
+                "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."
+                },
+                "suggested": {
+                    "description": "The suggested replacement content.",
+                    "items": {
+                        "$ref": "#/definitions/Content"
+                    },
+                    "type": "array"
+                },
+                "type": {
+                    "const": "casSuggestion",
+                    "description": "Node type.",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
         "Code": {
             "properties": {
                 "children": {
@@ -101,6 +142,9 @@
                 {
                     "$ref": "#/definitions/ListItem"
                 },
+                {
+                    "$ref": "#/definitions/CasSuggestion"
+                },
                 {
                     "$ref": "#/definitions/Bold"
                 },

package/src/lib/schemas/schema.ts

@@ -1,6 +1,6 @@
 import { Node, Literal as UnistLiteral, Parent as UnistParent } from "unist";
 
-export type Content = BlockContent | InlineContent;
+export type Content = BlockContent | CasSuggestion | InlineContent;
 
 export type BlockContent = BlockContentMap[keyof BlockContentMap];
 export type InlineContent = InlineContentMap[keyof InlineContentMap];
@@ -232,3 +232,30 @@ export interface InternalLink extends Parent {
 
   target?: "_parent" | "_top" | "blank" | "self";
 }
+
+/**
+ * A CAS suggestion node.
+ */
+export interface CasSuggestion extends Node {
+  type: "casSuggestion";
+
+  /**
+   * The original content that is suggested to be replaced.
+   */
+  original: Content[];
+
+  /**
+   * The suggested replacement content.
+   */
+  suggested: Content[];
+
+  /**
+   * A message explaining the suggestion.
+   */
+  message: string;
+
+  /**
+   * The method or algorithm that created the suggestion (e.g. "database; reusable")
+   */
+  method: string;
+}

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

@@ -2,6 +2,7 @@ import { validateCast } from "./validate-cast";
 import {
   Blockquote,
   Bold,
+  CasSuggestion,
   Code,
   Content,
   ExternalLink,
@@ -99,6 +100,16 @@ describe("validateCast", () => {
         "valid blockquote",
         { type: "blockquote", children: [{ type: "text", value: "Blockquote text" }] } satisfies Blockquote,
       ],
+      [
+        "valid cas suggestion",
+        {
+          type: "casSuggestion",
+          original: [{ type: "text", value: "Original text" }],
+          suggested: [{ type: "text", value: "Suggested text" }],
+          message: "This is a suggestion",
+          method: "database; reusable",
+        } satisfies CasSuggestion,
+      ],
     ])("validates a %s", (_, input) => {
       const root: Root = { type: "root", children: [input as Content] };
       expect(() => validateCast(root)).not.toThrow();
@@ -317,6 +328,66 @@ describe("validateCast", () => {
           children: [{ type: "listItem", children: "notAnArray" as unknown as InlineContent[] }],
         } satisfies Root,
       ],
+      [
+        "invalid cas suggestion - original not an array",
+        {
+          type: "root",
+          children: [
+            {
+              type: "casSuggestion",
+              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[],
+              message: "This is a suggestion",
+              method: "database; reusable",
+            },
+          ],
+        } satisfies Root,
+      ],
+      [
+        "invalid cas suggestion - message not a string",
+        {
+          type: "root",
+          children: [
+            {
+              type: "casSuggestion",
+              original: [{ type: "text", value: "Original text" }],
+              suggested: [{ type: "text", value: "Suggested text" }],
+              message: null as unknown as string,
+              method: "database; reusable",
+            },
+          ],
+        } satisfies Root,
+      ],
+      [
+        "invalid cas suggestion - method not a string",
+        {
+          type: "root",
+          children: [
+            {
+              type: "casSuggestion",
+              original: [{ type: "text", value: "Original text" }],
+              suggested: [{ type: "text", value: "Suggested text" }],
+              message: "This is a suggestion",
+              method: 123 as unknown as string,
+            },
+          ],
+        } satisfies Root,
+      ],
     ])("throws an error for %s", (_, input) => {
       expect(() => validateCast(input)).toThrow(InvalidCastError);
     });

package/src/lib/validate-cast.ts

@@ -1,4 +1,5 @@
 import {
+  CasSuggestion,
   Code,
   Content,
   ExternalLink,
@@ -137,6 +138,35 @@ function assertValidInternalLink(value: unknown): asserts value is InternalLink
   link.children.forEach(assertTextNode);
 }
 
+function assertValidCasSuggestion(value: unknown): asserts value is CasSuggestion {
+  assertNonNullObject(value);
+
+  const suggestion = value as CasSuggestion;
+
+  // Validate required fields
+  if (!Array.isArray(suggestion.original)) {
+    throw new InvalidCastError("Invalid casSuggestion: original must be an array");
+  }
+
+  if (!Array.isArray(suggestion.suggested)) {
+    throw new InvalidCastError("Invalid casSuggestion: suggested must be an array");
+  }
+
+  if (typeof suggestion.message !== "string") {
+    throw new InvalidCastError("Invalid casSuggestion: message must be a string");
+  }
+
+  if (typeof suggestion.method !== "string") {
+    throw new InvalidCastError("Invalid casSuggestion: 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 {
   assertNonNullObject(value);
   const content = value as Content;
@@ -157,6 +187,9 @@ function assertValidContent(value: unknown): asserts value is Content {
     case "internalLink":
       assertValidInternalLink(content);
       break;
+    case "casSuggestion":
+      assertValidCasSuggestion(content);
+      break;
     case "heading":
       assertValidHeading(content);
       break;