@uniformdev/canvas 20.86.0 → 20.86.1-alpha.2.sha-8bea6cf454

package/dist/index.mjs

@@ -225,6 +225,7 @@ var CANVAS_PERSONALIZE_TYPE = "$personalization";
 var CANVAS_TEST_TYPE = "$test";
 var CANVAS_LOCALIZATION_TYPE = "$localization";
 var CANVAS_SLOT_SECTION_TYPE = "$slotSection";
+var CANVAS_LOOP_TYPE = "$loop";
 var CANVAS_INTENT_TAG_PARAM = "intentTag";
 var CANVAS_LOCALE_TAG_PARAM = "locale";
 var CANVAS_BLOCK_PARAM_TYPE = "$block";
@@ -232,6 +233,9 @@ var CANVAS_PERSONALIZE_SLOT = "pz";
 var CANVAS_TEST_SLOT = "test";
 var CANVAS_LOCALIZATION_SLOT = "localized";
 var CANVAS_SLOT_SECTION_SLOT = "$slotSectionItems";
+var CANVAS_LOOP_SLOT = "body";
+var CANVAS_LOOP_DATA_TYPE = "sys-reserved-loop";
+var CANVAS_ALIAS_DATA_TYPE = "sys-reserved-alias";
 var CANVAS_SLOT_SECTION_NAME_PARAM = "name";
 var CANVAS_SLOT_SECTION_MIN_PARAM = "min";
 var CANVAS_SLOT_SECTION_MAX_PARAM = "max";
@@ -4059,6 +4063,231 @@ function handleRichTextNodeBinding(object, options) {
   return void 0;
 }
 
+// src/utils/wellKnownSystemComponentParameters.ts
+var wellKnownSystemComponentParameters = [
+  {
+    id: CANVAS_COMPONENT_DISPLAY_NAME_PARAM,
+    name: "Display Name",
+    type: "text"
+  },
+  {
+    id: CANVAS_INTENT_TAG_PARAM,
+    name: "Intent Tag",
+    type: "intentTag"
+  },
+  {
+    id: CANVAS_LOCALE_TAG_PARAM,
+    name: "Locale Visibility",
+    type: "localeSelect"
+  },
+  {
+    id: CANVAS_PERSONALIZATION_PARAM,
+    name: "Personalization Criteria",
+    type: CANVAS_PERSONALIZATION_PARAM
+  },
+  {
+    id: CANVAS_ENRICHMENT_TAG_PARAM,
+    name: "Enrichment Tags",
+    type: CANVAS_ENRICHMENT_TAG_PARAM,
+    helpText: "Seeing this component will increase a visitor's score in these enrichments."
+  },
+  {
+    id: CANVAS_TEST_VARIANT_PARAM,
+    name: "A/B Test",
+    type: "testVariant"
+  },
+  {
+    id: CANVAS_VIZ_CONTROL_PARAM,
+    name: "Visibility Control",
+    type: CANVAS_VIZ_CONTROL_PARAM
+  }
+];
+
+// src/utils/wellKnownSystemComponents.ts
+var wellKnownSystemComponents = [
+  {
+    id: CANVAS_PERSONALIZE_TYPE,
+    name: "Personalization",
+    icon: "track",
+    titleParameter: CANVAS_PERSONALIZATION_EVENT_NAME_PARAM,
+    description: "Contains components that will be shown to visitors based on configurable personalization criteria.",
+    slots: [
+      {
+        id: CANVAS_PERSONALIZE_SLOT,
+        inheritAllowedComponents: true,
+        name: "Personalized Variations",
+        allowedComponents: []
+      }
+    ],
+    parameters: [
+      {
+        id: CANVAS_PERSONALIZATION_EVENT_NAME_PARAM,
+        name: "Analytics tracking name",
+        type: "text",
+        typeConfig: {
+          required: true,
+          caption: "Will be sent to your analytics tool. We recommend not changing this once the composition is published."
+        }
+      },
+      {
+        id: CANVAS_PERSONALIZATION_ALGORITHM_PARAM,
+        name: "Selection method",
+        type: CANVAS_PERSONALIZATION_ALGORITHM_TYPE,
+        typeConfig: {
+          required: true
+        }
+      },
+      {
+        id: CANVAS_PERSONALIZATION_TAKE_PARAM,
+        name: "Number of variations to select",
+        type: "number",
+        typeConfig: {
+          regex: "^[0-9]+$",
+          regexMessage: "Please enter a whole number",
+          placeholder: "1"
+        }
+      },
+      {
+        id: CANVAS_HYPOTHESIS_PARAM,
+        name: "Hypothesis",
+        type: "richText",
+        typeConfig: {
+          formatting: {
+            builtIn: ["bold", "italic", "underline"]
+          },
+          elements: {
+            builtIn: ["unorderedList", "orderedList"]
+          }
+        },
+        helpText: "Document the hypothesis or reasoning behind this personalization strategy.",
+        guidance: "Document the hypothesis or reasoning behind this personalization strategy. Not localizable; do not pass a locale when editing."
+      }
+    ]
+  },
+  {
+    id: CANVAS_TEST_TYPE,
+    name: "A/B Test",
+    icon: "style",
+    titleParameter: "test",
+    description: "Contains components that will be shown to visitors randomly based on a configurable traffic split.",
+    slots: [
+      {
+        id: CANVAS_TEST_SLOT,
+        inheritAllowedComponents: true,
+        name: "Test Variations",
+        allowedComponents: []
+      }
+    ],
+    parameters: [
+      {
+        id: "test",
+        name: "Test name",
+        type: "testSelect"
+      },
+      {
+        id: CANVAS_HYPOTHESIS_PARAM,
+        name: "Hypothesis",
+        type: "richText",
+        typeConfig: {
+          formatting: {
+            builtIn: ["bold", "italic", "underline"]
+          },
+          elements: {
+            builtIn: ["unorderedList", "orderedList"]
+          }
+        },
+        helpText: "Document the hypothesis or expected outcome of this A/B test.",
+        guidance: "Document the hypothesis or expected outcome of this A/B test. Not localizable; do not pass a locale when editing."
+      }
+    ]
+  },
+  {
+    id: CANVAS_LOCALIZATION_TYPE,
+    name: "Localization",
+    icon: "globe-alt",
+    description: "Contains components that will be shown based on visitor locale.",
+    slots: [
+      {
+        id: CANVAS_LOCALIZATION_SLOT,
+        inheritAllowedComponents: true,
+        name: "Localized Variations",
+        allowedComponents: []
+      }
+    ]
+  },
+  {
+    id: CANVAS_LOOP_TYPE,
+    name: "Loop",
+    icon: "repeat",
+    description: "Contains components that will be repeated for each item in a list (array) selected from a data resource.",
+    slots: [
+      {
+        id: CANVAS_LOOP_SLOT,
+        inheritAllowedComponents: true,
+        name: "Body",
+        minComponents: 1,
+        allowedComponents: []
+      }
+    ]
+  },
+  {
+    id: CANVAS_SLOT_SECTION_TYPE,
+    name: "Slot Section",
+    icon: "copy-all",
+    titleParameter: CANVAS_SLOT_SECTION_NAME_PARAM,
+    description: "When using this pattern, new components may be added at the location where this component is inserted.",
+    slots: [
+      {
+        id: CANVAS_SLOT_SECTION_SLOT,
+        inheritAllowedComponents: true,
+        name: "Items",
+        allowedComponents: []
+      }
+    ],
+    parameters: [
+      {
+        id: CANVAS_SLOT_SECTION_NAME_PARAM,
+        name: "Name",
+        type: "text"
+      },
+      {
+        id: CANVAS_SLOT_SECTION_MIN_PARAM,
+        name: "Minimum",
+        type: "text"
+      },
+      {
+        id: CANVAS_SLOT_SECTION_MAX_PARAM,
+        name: "Maximum",
+        type: "text"
+      },
+      {
+        id: CANVAS_SLOT_SECTION_GROUP_TYPE_PARAM,
+        name: "Group Type",
+        type: "text"
+      },
+      {
+        id: CANVAS_SLOT_SECTION_SPECIFIC_PARAM,
+        name: "Specific",
+        type: "array"
+      }
+    ]
+  }
+];
+var systemComponentsMetadata = {
+  $personalization: void 0,
+  $test: void 0,
+  $localization: void 0,
+  $loop: void 0,
+  $slotSection: {
+    isAutoAllowed: true,
+    isOnlyAllowedInPatternEditor: true
+  }
+};
+var getComponentMetadata = (type) => {
+  const metadata = systemComponentsMetadata[type];
+  return metadata;
+};
+
 // src/index.ts
 import { ApiClientError as ApiClientError5 } from "@uniformdev/context/api";
 
@@ -4121,6 +4350,7 @@ export {
   ApiClientError5 as ApiClientError,
   BatchEntry,
   BlockFormatError,
+  CANVAS_ALIAS_DATA_TYPE,
   CANVAS_BLOCK_PARAM_TYPE,
   CANVAS_COMPONENT_DISPLAY_NAME_PARAM,
   CANVAS_CONTEXTUAL_EDITING_PARAM,
@@ -4133,6 +4363,9 @@ export {
   CANVAS_LOCALE_TAG_PARAM,
   CANVAS_LOCALIZATION_SLOT,
   CANVAS_LOCALIZATION_TYPE,
+  CANVAS_LOOP_DATA_TYPE,
+  CANVAS_LOOP_SLOT,
+  CANVAS_LOOP_TYPE,
   CANVAS_PERSONALIZATION_ALGORITHM_PARAM,
   CANVAS_PERSONALIZATION_ALGORITHM_TYPE,
   CANVAS_PERSONALIZATION_EVENT_NAME_PARAM,
@@ -4236,6 +4469,7 @@ export {
   generateHash,
   getBlockValue,
   getComponentJsonPointer,
+  getComponentMetadata,
   getComponentPath,
   getDataSourceVariantFromRouteGetParams,
   getEffectivePropertyValue,
@@ -4287,7 +4521,10 @@ export {
   parseVariableExpression,
   projectionToQuery,
   queryToProjection,
+  systemComponentsMetadata,
   version,
   walkNodeTree,
-  walkPropertyValues
+  walkPropertyValues,
+  wellKnownSystemComponentParameters,
+  wellKnownSystemComponents
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/canvas",
-  "version": "20.86.0",
+  "version": "20.86.1-alpha.2.sha-8bea6cf454",
   "description": "Common functionality and types for Uniform Canvas",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -36,9 +36,9 @@
     "svix": "1.96.0"
   },
   "dependencies": {
-    "@uniformdev/assets": "20.86.0",
-    "@uniformdev/context": "20.86.0",
-    "@uniformdev/richtext": "20.86.0",
+    "@uniformdev/assets": "20.86.1-alpha.2.sha-8bea6cf454",
+    "@uniformdev/context": "20.86.1-alpha.2.sha-8bea6cf454",
+    "@uniformdev/richtext": "20.86.1-alpha.2.sha-8bea6cf454",
     "immer": "10.2.0",
     "p-limit": "6.2.0",
     "p-retry": "6.2.1",
@@ -50,5 +50,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "f0e4c0eb0eac24eb1e38a5bd536832f0261b003b"
+  "gitHead": "8bea6cf4541e8618d333a903d992c960a79ebfca"
 }