@platecms/delta-cast 0.13.0 → 1.2.0

package/package.json

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

package/src/lib/schemas/schema.json

@@ -174,9 +174,38 @@
                 },
                 {
                     "$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"
@@ -305,6 +334,9 @@
         },
         "InlineContent": {
             "anyOf": [
+                {
+                    "$ref": "#/definitions/CasSuggestion"
+                },
                 {
                     "$ref": "#/definitions/Bold"
                 },
@@ -334,6 +366,9 @@
                 },
                 {
                     "$ref": "#/definitions/InternalLink"
+                },
+                {
+                    "$ref": "#/definitions/ContentValueSuggestion"
                 }
             ]
         },

package/src/lib/schemas/schema.ts

@@ -26,6 +26,8 @@ export interface InlineContentMap {
   contentValue: InterpolatedContentValue;
   externalLink: ExternalLink;
   internalLink: InternalLink;
+  casSuggestion: CasSuggestion;
+  contentValueSuggestion: ContentValueSuggestion;
 }
 
 export interface Parent extends UnistParent {
@@ -200,6 +202,20 @@ 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";
 

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

@@ -52,7 +52,7 @@ describe("validateCast", () => {
       ],
       [
         "valid interpolated content value",
-        { type: "contentValue", prn: "prn:plate-dev:1234:cxc:test:abcd" } satisfies InterpolatedContentValue,
+        { type: "contentValue", prn: "prn:plate-dev:1234:cms:test:abcd" } satisfies InterpolatedContentValue,
       ],
       [
         "valid external link",
@@ -67,7 +67,7 @@ describe("validateCast", () => {
         {
           type: "internalLink",
           url: "https://www.hotet.getplate.rocks/blogs",
-          prn: "prn:plate-dev:1234:cxc:test:abcd",
+          prn: "prn:plate-dev:1234:cms:test:abcd",
           children: [{ type: "text", value: "Internal link" }],
         } satisfies InternalLink,
       ],
@@ -76,7 +76,7 @@ describe("validateCast", () => {
         {
           type: "internalLink",
           url: "https://www.hotet.getplate.rocks/blogs#123",
-          prn: "prn:plate-dev:1234:cxc:test:abcd",
+          prn: "prn:plate-dev:1234:cms:test:abcd",
           children: [{ type: "text", value: "Internal link" }],
         } satisfies InternalLink,
       ],

package/src/lib/validate-cast.ts

@@ -213,7 +213,7 @@ function assertValidContent(value: unknown): asserts value is Content {
 
 /**
  * Validates a CAST object.
- * @remarks Doesn't (and can't) check for circular references. This is done in the Content Experience Center when validating the CAST.
+ * @remarks Doesn't (and can't) check for circular references. This is done in the Content Management Center when validating the CAST.
  */
 export function validateCast(value: unknown): void {
   assertNonNullObject(value);