@clxmedia/types 1.13.1 → 1.14.0

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

@@ -52,8 +52,8 @@ export type CLXForm = {
     description?: string;
     settings?: CLXFormSettings;
 };
-export type CLXFormResponseType = "STRING" | "NUMBER" | "STRING_ARRAY" | "GRID" | "CONTACT" | "CONTACT_ARRAY" | "BOOLEAN" | "FILE" | "DATE" | "SCHEDULE" | "COMPOUND" | "MULTI_COMPOUND" | "ANY";
-export type CLXFormFieldType = "text" | "textarea" | "credential" | "grid" | "boolean" | "select" | "multiselect" | "file" | "contact" | "date" | "schedule" | "compound";
+export type CLXFormResponseType = "STRING" | "NUMBER" | "STRING_ARRAY" | "GRID" | "CONTACT" | "CONTACT_ARRAY" | "ENTITY" | "ENTITY_ARRAY" | "BOOLEAN" | "FILE" | "DATE" | "SCHEDULE" | "COMPOUND" | "MULTI_COMPOUND" | "ANY";
+export type CLXFormFieldType = "text" | "textarea" | "credential" | "grid" | "boolean" | "select" | "multiselect" | "file" | "contact" | "entity" | "date" | "schedule" | "compound";
 export type CLXFormSelectType = "select" | "radio" | "checkbox" | "freeform";
 export type CLXFormConditionSubjectEntry = {
     value: string;
@@ -93,6 +93,11 @@ export type CLXContactCard = {
     email: string | null;
     phone: string | null;
 };
+export type CLXEntityCard = {
+    master_id: number;
+    name: string;
+    type: 'portfolio' | 'property' | 'person';
+};
 export type CLXGridColumnType = "string" | "number" | "boolean";
 export type CLXGridColumn = {
     title: string;
@@ -167,11 +172,19 @@ export type CLXFormResponseContactArrayValue = CLXFormResponseValueBase & {
     type: "CONTACT_ARRAY";
     value: CLXContactCard[];
 };
+export type CLXFormResponseEntityValue = CLXFormResponseValueBase & {
+    type: "ENTITY";
+    value: CLXEntityCard;
+};
+export type CLXFormResponseEntityArrayValue = CLXFormResponseValueBase & {
+    type: "ENTITY_ARRAY";
+    value: CLXEntityCard[];
+};
 export type CLXFormResponseGridValue = CLXFormResponseValueBase & {
     type: "GRID";
     value: CLXGridData;
 };
-export type CLXFormResponseValue = CLXFormResponseStringValue | CLXFormResponseStringArrayValue | CLXFormResponseNumberValue | CLXFormResponseDateValue | CLXFormResponseGridValue | CLXFormResponseContactValue | CLXFormResponseContactArrayValue | CLXFormResponseCompoundValue | CLXFormResponseSingleCompoundValue | CLXFormResponseScheduleValue | CLXFormResponseFileValue | CLXFormResponseBooleanValue | CLXFormResponseAnyValue;
+export type CLXFormResponseValue = CLXFormResponseStringValue | CLXFormResponseStringArrayValue | CLXFormResponseNumberValue | CLXFormResponseDateValue | CLXFormResponseGridValue | CLXFormResponseContactValue | CLXFormResponseContactArrayValue | CLXFormResponseEntityValue | CLXFormResponseEntityArrayValue | CLXFormResponseCompoundValue | CLXFormResponseSingleCompoundValue | CLXFormResponseScheduleValue | CLXFormResponseFileValue | CLXFormResponseBooleanValue | CLXFormResponseAnyValue;
 export type CLXFormResponses = {
     [questionSlug: string]: CLXFormResponseValue;
 };
@@ -244,6 +257,20 @@ export type CLXMultipleContactFormField = CLXContactFormFieldBase & {
     response_type: "CONTACT_ARRAY";
     allow_multiple: true;
 };
+export type CLXEntityFormFieldBase = CLXFormField & {
+    type: "entity";
+    response_type: "ENTITY" | "ENTITY_ARRAY";
+    allow_multiple: boolean;
+    types?: ('portfolio' | 'property' | 'person')[];
+};
+export type CLXEntityFormField = CLXEntityFormFieldBase & {
+    response_type: "ENTITY";
+    allow_multiple: false;
+};
+export type CLXMultipleEntityFormField = CLXEntityFormFieldBase & {
+    response_type: "ENTITY_ARRAY";
+    allow_multiple: true;
+};
 export type CLXDateFormField = CLXFormField & {
     type: "date";
     response_type: "DATE";
@@ -318,7 +345,7 @@ export type CLXSingleCompoundFormField = CLXFormField & {
     compound_fields: CLXCompoundableFormField[];
 };
 export type CLXFormQuestionResponseOptions = {
-    field: CLXTextFormField | CLXNumberFormField | CLXDateFormField | CLXScheduleFormField | CLXCredentialFormField | CLXGridFormField | CLXContactFormField | CLXMultipleContactFormField | CLXSingleCompoundFormField | CLXFileFormField | CLXCompoundFormField | CLXTextAreaFormField | CLXBooleanFormField | CLXSelectFormField | CLXMultiSelectFormField | CLXMultipleTextFormField;
+    field: CLXTextFormField | CLXNumberFormField | CLXDateFormField | CLXScheduleFormField | CLXCredentialFormField | CLXGridFormField | CLXContactFormField | CLXMultipleContactFormField | CLXEntityFormField | CLXMultipleEntityFormField | CLXSingleCompoundFormField | CLXFileFormField | CLXCompoundFormField | CLXTextAreaFormField | CLXBooleanFormField | CLXSelectFormField | CLXMultiSelectFormField | CLXMultipleTextFormField;
     has_parent?: boolean;
     locked?: boolean;
     tags?: string[];
@@ -373,12 +400,30 @@ export type CLXFormRuleStringListToStringListInstance = CLXFormRuleInstanceBase
     comparisonType: "isAnswered" | "stringListContainsAll" | "stringListContainsAny" | "stringListContainsNone";
     negate?: boolean;
 };
+export type CLXFormRuleEntityInListInstance = CLXFormRuleInstanceBase & {
+    subject: CLXFormResponseEntityValue;
+    target: CLXFormResponseEntityArrayValue;
+    comparisonType: "entityInList" | "isAnswered";
+    negate?: boolean;
+};
 export type CLXFormRuleStringInListInstance = CLXFormRuleInstanceBase & {
     subject: CLXFormResponseStringValue;
     target: CLXFormResponseStringArrayValue;
     comparisonType: "stringInList" | "stringNotInList" | "isAnswered";
     negate?: boolean;
 };
+export type CLXFormRuleEntityComparisonInstance = CLXFormRuleInstanceBase & {
+    subject: CLXFormResponseEntityValue;
+    target: CLXFormResponseEntityValue;
+    comparisonType: "isAnswered" | "entityEquals";
+    negate?: boolean;
+};
+export type CLXFormRuleEntityListToEntityListInstance = CLXFormRuleInstanceBase & {
+    subject: CLXFormResponseEntityArrayValue;
+    target: CLXFormResponseEntityArrayValue;
+    comparisonType: "isAnswered" | "entityListContainsAll" | "entityListContainsAny" | "entityListContainsNone";
+    negate?: boolean;
+};
 export type CLXFormRuleFileExistsInstance = CLXFormRuleInstanceBase & {
     subject: CLXFormResponseFileValue;
     target: CLXFormResponseBooleanValue;
@@ -409,7 +454,7 @@ export type CLXFormRuleNumberComparisonInstance = CLXFormRuleInstanceBase & {
     comparisonType: "numberEquals" | "numberGreaterThan" | "numberLessThan" | "isAnswered";
     negate?: boolean;
 };
-export type CLXFormRuleInstance = CLXFormRuleStringComparisonInstance | CLXFormRuleStringExistsComparisonInstance | CLXFormRuleStringInListInstance | CLXFormRuleFileExistsInstance | CLXFormRuleDateComparisonInstance | CLXFormRuleStringListToStringListInstance | CLXFormRuleStringListComparisonInstance | CLXFormRuleBooleanEqualsInstance | CLXFormRuleNumberComparisonInstance;
+export type CLXFormRuleInstance = CLXFormRuleStringComparisonInstance | CLXFormRuleStringExistsComparisonInstance | CLXFormRuleStringInListInstance | CLXFormRuleEntityInListInstance | CLXFormRuleStringListToStringListInstance | CLXFormRuleEntityComparisonInstance | CLXFormRuleFileExistsInstance | CLXFormRuleDateComparisonInstance | CLXFormRuleStringListToStringListInstance | CLXFormRuleEntityListToEntityListInstance | CLXFormRuleStringListComparisonInstance | CLXFormRuleBooleanEqualsInstance | CLXFormRuleNumberComparisonInstance;
 /**
  * A form rule set is a collection of rules/conditions to evaluate.
  *

package/package.json

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