@clxmedia/types 1.11.0 → 1.12.1

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

@@ -27,13 +27,13 @@ export type XperienceRightsData = {
     };
     /** Entity specialist roles mapped to company master IDs where the user has that specialist role */
     entitySpecialistRoles: {
-        [K in SpecialistRole]?: CompanyMasterIds;
+        [K in CLiQTeamRole]?: CompanyMasterIds;
     };
 };
-export type SpecialistRole = "account_mgr" | "implementation" | "search" | "media" | "performance" | "organic_content" | "tcc" | "cat" | "chat";
 export type CompanyMasterIds = number[];
 export type CLiQUserLocatorType = "user" | "group" | "role";
-export type CLiQUserLocatorRoles = `entity_specialist_${SpecialistRole}` | "entity_cs_project_manager" | "entity_cs_stager" | "task_assignee";
+export type CLiQTeamRole = 'account_manager' | 'search_specialist' | 'media_specialist' | 'implementation_specialist' | 'performance_specialist' | 'client_service_lead' | 'ad_operations_lead' | 'project_manager' | 'content_specialist' | 'tcc' | 'cat' | 'chat' | 'stager' | 'digital_strategist';
+export type CLiQUserLocatorRoles = `entity_role_${CLiQTeamRole}` | "task_assignee";
 export type CLiQUserLocatorBase = {
     type: CLiQUserLocatorType;
     value: string;

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

@@ -41,6 +41,7 @@ export type CLXFormSettings = {
     allow: CLXFormAllowable[];
     submit: CLXFormSubmitConfig;
     display: CLXFormSettingsDisplay;
+    gateSatisfiedResponseSlug?: string;
 };
 export type CLXForm = {
     id: number;
@@ -396,6 +397,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 +415,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 +429,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 +445,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 +467,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.11.0",
+  "version": "1.12.1",
   "description": "Conversion Logix TypeScript type definitions",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",