@clxmedia/types 1.12.0 → 1.12.2

package/dist/core/clxforms/index.d.ts

@@ -2,6 +2,7 @@ import type { XperienceAbility } from "../auth";
 export type CLXFormSelectOption = {
     value: string;
     label: string;
+    conditions?: CLXFormRuleSet;
 };
 export type CLXFormSelectOptions = CLXFormSelectOption[];
 export type CLXFormMode = "edit" | "preview" | "live";
@@ -41,6 +42,7 @@ export type CLXFormSettings = {
     allow: CLXFormAllowable[];
     submit: CLXFormSubmitConfig;
     display: CLXFormSettingsDisplay;
+    gateSatisfiedResponseSlug?: string;
 };
 export type CLXForm = {
     id: number;
@@ -396,6 +398,11 @@ export type CLXFormRuleNumberComparisonInstance = CLXFormRuleInstanceBase & {
     comparisonType: "numberEquals" | "numberGreaterThan" | "numberLessThan";
 };
 export type CLXFormRuleInstance = CLXFormRuleStringComparisonInstance | CLXFormRuleStringExistsComparisonInstance | CLXFormRuleStringInListInstance | CLXFormRuleFileExistsInstance | CLXFormRuleDateComparisonInstance | CLXFormRuleStringListToStringListInstance | CLXFormRuleStringListComparisonInstance | CLXFormRuleBooleanEqualsInstance | CLXFormRuleNumberComparisonInstance;
+/**
+ * A form rule set is a collection of rules/conditions to evaluate.
+ *
+ * The rule set can contain a single rule, a combination of multiple rules, or nested rule sets.
+ */
 export type CLXFormRuleSet = {
     rules: (CLXFormRuleDefinition | CLXFormRuleSet)[];
     combinator?: "and" | "or";
@@ -409,6 +416,10 @@ export type CLXConditionalOverrides = {
         override: number;
     })[];
 };
+/**
+ * Defines the behavior of a question (identified by a question slug) within a form.
+ * E.g. Indicates whether the question is required or if any conditions must be met to enable the question.
+ */
 export type CLXFormQuestionLayout = {
     id: number;
     form_question_slug: string;
@@ -419,6 +430,11 @@ export type CLXFormQuestionLayout = {
     is_complete?: boolean;
     scope?: CLXResponseStoreTarget;
 };
+/**
+ * A form section is a grouping of form questions.
+ *
+ * Conditions can determine whether or not a section is enabled.
+ */
 export type CLXFormSection = {
     id: number;
     name: string;
@@ -430,6 +446,12 @@ export type CLXFormQuestionBundle = {
     question: CLXFormQuestion;
     layout: CLXFormQuestionLayout;
 };
+/**
+ * A form step is composed of one or more form sections.
+ *
+ * Steps are in a defined order, but one form step does not necessarily block the next.
+ * Conditions can determine whether or not a form step is enabled.
+ */
 export type CLXFormStep = {
     id: number;
     name: string;
@@ -446,6 +468,9 @@ export type FormStats = {
     optional: FormStatCount;
     required: FormStatCount;
 };
+/**
+ * Defines the top-level layout of a form, with questions grouped into one or more steps.
+ */
 export type CLXFormLayout = {
     form: CLXForm;
     steps: CLXFormStep[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clxmedia/types",
-  "version": "1.12.0",
+  "version": "1.12.2",
   "description": "Conversion Logix TypeScript type definitions",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",