@clxmedia/types 1.0.171 → 1.0.173

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

@@ -4,7 +4,7 @@ export type CLXFormSelectOption = {
     label: string;
 };
 export type CLXFormSelectOptions = CLXFormSelectOption[];
-export type CLXFormMode = 'edit' | 'preview' | 'live';
+export type CLXFormMode = "edit" | "preview" | "live";
 export type CLXFormErrorMsg = string | null;
 export type CLXFormFormattingResponse = {
     errorMsg: CLXFormErrorMsg[];
@@ -20,9 +20,9 @@ export type CLXFormState = {
     mode: CLXFormMode;
     locked: boolean;
 };
-export type CLXFormSubmitAction = 'lock' | 'reset' | 'snapshot' | 'notify';
-export type CLXFormAllowable = 'share' | 'reset';
-export type CLXFormSectionFormat = 'tabs' | 'accordion';
+export type CLXFormSubmitAction = "lock" | "reset" | "snapshot" | "notify";
+export type CLXFormAllowable = "share" | "reset";
+export type CLXFormSectionFormat = "tabs" | "accordion";
 export type CLXFormSettingsDisplay = {
     sectionFormat: CLXFormSectionFormat;
     hideNavButtons?: boolean;
@@ -48,9 +48,9 @@ export type CLXForm = {
     description?: string;
     settings?: CLXFormSettings;
 };
-export type CLXFormResponseType = 'STRING' | 'NUMBER' | 'STRING_ARRAY' | 'CONTACT' | 'CONTACT_ARRAY' | 'BOOLEAN' | 'FILE' | 'DATE' | 'SCHEDULE' | 'COMPOUND' | 'MULTI_COMPOUND' | 'ANY';
-export type CLXFormFieldType = 'text' | 'textarea' | 'boolean' | 'select' | 'multiselect' | 'file' | 'contact' | 'date' | 'schedule' | 'compound';
-export type CLXFormSelectType = 'select' | 'radio' | 'checkbox' | 'freeform';
+export type CLXFormResponseType = "STRING" | "NUMBER" | "STRING_ARRAY" | "CONTACT" | "CONTACT_ARRAY" | "BOOLEAN" | "FILE" | "DATE" | "SCHEDULE" | "COMPOUND" | "MULTI_COMPOUND" | "ANY";
+export type CLXFormFieldType = "text" | "textarea" | "credential" | "boolean" | "select" | "multiselect" | "file" | "contact" | "date" | "schedule" | "compound";
+export type CLXFormSelectType = "select" | "radio" | "checkbox" | "freeform";
 export type CLXFormConditionSubjectEntry = {
     value: string;
     label: string;
@@ -85,15 +85,15 @@ export type CLXContactCard = {
     phone: string | null;
 };
 export type CLXFormResponseStringValue = CLXFormResponseValueBase & {
-    type: 'STRING';
+    type: "STRING";
     value: string;
 };
 export type CLXFormResponseDateValue = CLXFormResponseValueBase & {
-    type: 'DATE';
+    type: "DATE";
     value: CLXFormDateTime;
 };
 export type CLXFormResponseScheduleValue = CLXFormResponseValueBase & {
-    type: 'SCHEDULE';
+    type: "SCHEDULE";
     value: {
         sunday: CLXFormTimeRange;
         monday: CLXFormTimeRange;
@@ -105,29 +105,29 @@ export type CLXFormResponseScheduleValue = CLXFormResponseValueBase & {
     };
 };
 export type CLXFormResponseNumberValue = CLXFormResponseValueBase & {
-    type: 'NUMBER';
+    type: "NUMBER";
     value: number;
 };
 export type CLXFormResponseFileValue = CLXFormResponseValueBase & {
-    type: 'FILE';
+    type: "FILE";
     value: CLXFormsFileDescriptors;
 };
 export type CLXFormResponseBooleanValue = CLXFormResponseValueBase & {
-    type: 'BOOLEAN';
+    type: "BOOLEAN";
     value: boolean;
 };
 export type CLXFormResponseStringArrayValue = CLXFormResponseValueBase & {
-    type: 'STRING_ARRAY';
+    type: "STRING_ARRAY";
     value: string[];
 };
 export type CLXFormResponseSingleCompoundValue = CLXFormResponseValueBase & {
-    type: 'COMPOUND';
+    type: "COMPOUND";
     value: {
         [innerKey: string]: CLXFormResponseStringValue | CLXFormResponseNumberValue | CLXFormResponseDateValue | CLXFormResponseBooleanValue;
     };
 };
 export type CLXFormResponseCompoundValue = CLXFormResponseValueBase & {
-    type: 'MULTI_COMPOUND';
+    type: "MULTI_COMPOUND";
     value: {
         [outerKey: string]: {
             [innerKey: string]: CLXFormResponseStringValue | CLXFormResponseNumberValue | CLXFormResponseDateValue | CLXFormResponseBooleanValue;
@@ -135,15 +135,15 @@ export type CLXFormResponseCompoundValue = CLXFormResponseValueBase & {
     };
 };
 export type CLXFormResponseAnyValue = CLXFormResponseValueBase & {
-    type: 'ANY';
+    type: "ANY";
     value: any;
 };
 export type CLXFormResponseContactValue = CLXFormResponseValueBase & {
-    type: 'CONTACT';
+    type: "CONTACT";
     value: CLXContactCard;
 };
 export type CLXFormResponseContactArrayValue = CLXFormResponseValueBase & {
-    type: 'CONTACT_ARRAY';
+    type: "CONTACT_ARRAY";
     value: CLXContactCard[];
 };
 export type CLXFormResponseValue = CLXFormResponseStringValue | CLXFormResponseStringArrayValue | CLXFormResponseNumberValue | CLXFormResponseDateValue | CLXFormResponseContactValue | CLXFormResponseContactArrayValue | CLXFormResponseCompoundValue | CLXFormResponseSingleCompoundValue | CLXFormResponseScheduleValue | CLXFormResponseFileValue | CLXFormResponseBooleanValue | CLXFormResponseAnyValue;
@@ -154,109 +154,114 @@ export type CLXFormField = {
     type: CLXFormFieldType;
     response_type: CLXFormResponseType;
 };
-export type CLXFieldMasks = 'phone' | 'email' | 'name' | 'number' | 'none' | 'url';
+export type CLXFieldMasks = "phone" | "email" | "name" | "number" | "none" | "url";
 export type CLXPlainFormFieldBase = CLXFormField & {
-    type: 'text';
+    type: "text";
     mask: CLXFieldMasks;
 };
 export declare enum CLXFormFieldFileTypes {
-    'bmp' = "bmp",
-    'csv' = "csv",
-    'doc' = "doc",
-    'docx' = "docx",
-    'gif' = "gif",
-    'jpeg' = "jpeg",
-    'jpg' = "jpg",
-    'json' = "json",
-    'mp4' = "mp4",
-    'pdf' = "pdf",
-    'png' = "png",
-    'ppt' = "ppt",
-    'pptx' = "pptx",
-    'rtf' = "rtf",
-    'svg' = "svg",
-    'tif' = "tif",
-    'tiff' = "tiff",
-    'txt' = "txt",
-    'webm' = "webm",
-    'webp' = "webp",
-    'xls' = "xls",
-    'xlsx' = "xlsx",
-    'xml' = "xml",
-    'zip' = "zip"
+    "bmp" = "bmp",
+    "csv" = "csv",
+    "doc" = "doc",
+    "docx" = "docx",
+    "gif" = "gif",
+    "jpeg" = "jpeg",
+    "jpg" = "jpg",
+    "json" = "json",
+    "mp4" = "mp4",
+    "pdf" = "pdf",
+    "png" = "png",
+    "ppt" = "ppt",
+    "pptx" = "pptx",
+    "rtf" = "rtf",
+    "svg" = "svg",
+    "tif" = "tif",
+    "tiff" = "tiff",
+    "txt" = "txt",
+    "webm" = "webm",
+    "webp" = "webp",
+    "xls" = "xls",
+    "xlsx" = "xlsx",
+    "xml" = "xml",
+    "zip" = "zip"
 }
 export type CLXFileFormField = CLXFormField & {
-    type: 'file';
-    response_type: 'FILE';
+    type: "file";
+    response_type: "FILE";
     max_files?: number;
     allowed_file_types?: CLXFormFieldFileTypes[];
 };
+export type CLXCredentialFormField = CLXFormField & {
+    type: "credential";
+    response_type: "STRING";
+};
 export type CLXContactFormFieldBase = CLXFormField & {
-    type: 'contact';
-    response_type: 'CONTACT' | 'CONTACT_ARRAY';
+    type: "contact";
+    response_type: "CONTACT" | "CONTACT_ARRAY";
     email_required?: boolean;
     phone_required?: boolean;
     allow_multiple: boolean;
 };
 export type CLXContactFormField = CLXContactFormFieldBase & {
-    response_type: 'CONTACT';
+    response_type: "CONTACT";
     allow_multiple: false;
 };
 export type CLXMultipleContactFormField = CLXContactFormFieldBase & {
-    response_type: 'CONTACT_ARRAY';
+    response_type: "CONTACT_ARRAY";
     allow_multiple: true;
 };
 export type CLXDateFormField = CLXFormField & {
-    type: 'date';
-    response_type: 'DATE';
+    type: "date";
+    response_type: "DATE";
     include_time: boolean;
 };
 export type CLXScheduleFormField = CLXFormField & {
-    type: 'schedule';
-    response_type: 'SCHEDULE';
+    type: "schedule";
+    response_type: "SCHEDULE";
 };
 export type CLXTextFormFieldBase = CLXPlainFormFieldBase & {
-    type: 'text';
-    mask: 'phone' | 'email' | 'name' | 'url' | 'none';
-    response_type: 'STRING' | 'STRING_ARRAY';
+    type: "text";
+    mask: "phone" | "email" | "name" | "url" | "none";
+    response_type: "STRING" | "STRING_ARRAY";
     multiple: boolean;
+    character_limit?: number;
 };
 export type CLXTextFormField = CLXTextFormFieldBase & {
-    response_type: 'STRING';
+    response_type: "STRING";
     multiple: false;
 };
 export type CLXMultipleTextFormField = CLXTextFormFieldBase & {
-    response_type: 'STRING_ARRAY';
+    response_type: "STRING_ARRAY";
     multiple: true;
 };
 export type CLXNumberFormField = CLXPlainFormFieldBase & {
-    type: 'text';
-    mask: 'number';
-    response_type: 'NUMBER';
+    type: "text";
+    mask: "number";
+    response_type: "NUMBER";
     rounding?: number;
 };
 export type CLXTextAreaFormField = CLXFormField & {
-    type: 'textarea';
-    response_type: 'STRING';
+    type: "textarea";
+    response_type: "STRING";
 };
 export type CLXSelectableFormField = CLXFormField & {
     select_type: CLXFormSelectType;
 };
 export type CLXBooleanFormField = CLXSelectableFormField & {
-    type: 'boolean';
-    select_type: 'select' | 'radio';
-    response_type: 'BOOLEAN';
+    type: "boolean";
+    select_type: "select" | "radio";
+    response_type: "BOOLEAN";
 };
 export type CLXSelectFormField = CLXSelectableFormField & {
-    type: 'select';
-    response_type: 'STRING';
-    select_type: 'select' | 'radio';
+    type: "select";
+    response_type: "STRING";
+    select_type: "select" | "radio";
     options: CLXFormSelectOptions;
 };
 export type CLXMultiSelectFormField = CLXSelectableFormField & {
-    type: 'multiselect';
-    response_type: 'STRING_ARRAY';
-    select_type: 'checkbox' | 'freeform';
+    type: "multiselect";
+    response_type: "STRING_ARRAY";
+    select_type: "checkbox" | "freeform";
     options: CLXFormSelectOptions;
     max_select?: number;
 };
@@ -266,19 +271,19 @@ export type CLXCompoundableFormField = (CLXTextFormField | CLXNumberFormField |
     is_required?: boolean;
 };
 export type CLXCompoundFormField = CLXSelectableFormField & {
-    type: 'multiselect';
-    response_type: 'MULTI_COMPOUND';
+    type: "multiselect";
+    response_type: "MULTI_COMPOUND";
     options: CLXFormSelectOptions;
     compound_fields: CLXCompoundableFormField[];
     max_select?: number;
 };
 export type CLXSingleCompoundFormField = CLXFormField & {
-    type: 'compound';
-    response_type: 'COMPOUND';
+    type: "compound";
+    response_type: "COMPOUND";
     compound_fields: CLXCompoundableFormField[];
 };
 export type CLXFormQuestionResponseOptions = {
-    field: CLXTextFormField | CLXNumberFormField | CLXDateFormField | CLXScheduleFormField | CLXContactFormField | CLXMultipleContactFormField | CLXSingleCompoundFormField | CLXFileFormField | CLXCompoundFormField | CLXTextAreaFormField | CLXBooleanFormField | CLXSelectFormField | CLXMultiSelectFormField | CLXMultipleTextFormField;
+    field: CLXTextFormField | CLXNumberFormField | CLXDateFormField | CLXScheduleFormField | CLXCredentialFormField | CLXContactFormField | CLXMultipleContactFormField | CLXSingleCompoundFormField | CLXFileFormField | CLXCompoundFormField | CLXTextAreaFormField | CLXBooleanFormField | CLXSelectFormField | CLXMultiSelectFormField | CLXMultipleTextFormField;
     has_parent?: boolean;
     allow_reset?: boolean;
     tags?: string[];
@@ -300,7 +305,7 @@ export type CLXFormPortableResponse = {
 export type CLXFormPortableResponses = {
     [questionSlug: string]: CLXFormPortableResponse;
 };
-export type CLXRuleComparison = 'stringEquals' | 'stringExists' | 'stringContains' | 'stringStartsWith' | 'stringEndsWith' | 'stringInList' | 'stringNotInList' | 'stringListContainsAll' | 'stringListContainsAny' | 'stringListContainsNone' | 'stringListEntryEquals' | 'stringListEntryContains' | 'stringListEntryStartsWith' | 'stringListEntryEndsWith' | 'dateEquals' | 'dateBefore' | 'dateAfter' | 'booleanEquals' | 'fileExists' | 'numberEquals' | 'numberGreaterThan' | 'numberLessThan';
+export type CLXRuleComparison = "stringEquals" | "stringExists" | "stringContains" | "stringStartsWith" | "stringEndsWith" | "stringInList" | "stringNotInList" | "stringListContainsAll" | "stringListContainsAny" | "stringListContainsNone" | "stringListEntryEquals" | "stringListEntryContains" | "stringListEntryStartsWith" | "stringListEntryEndsWith" | "dateEquals" | "dateBefore" | "dateAfter" | "booleanEquals" | "fileExists" | "numberEquals" | "numberGreaterThan" | "numberLessThan";
 export type CLXFormRuleDefinition = {
     subject: string;
     target: CLXFormResponseValue;
@@ -314,52 +319,52 @@ export type CLXFormRuleInstanceBase = {
 export type CLXFormRuleStringComparisonInstance = CLXFormRuleInstanceBase & {
     subject: CLXFormResponseStringValue;
     target: CLXFormResponseStringValue;
-    comparisonType: 'stringEquals' | 'stringContains' | 'stringStartsWith' | 'stringEndsWith';
+    comparisonType: "stringEquals" | "stringContains" | "stringStartsWith" | "stringEndsWith";
 };
 export type CLXFormRuleStringExistsComparisonInstance = CLXFormRuleInstanceBase & {
     subject: CLXFormResponseStringValue;
     target: CLXFormResponseBooleanValue;
-    comparisonType: 'stringExists';
+    comparisonType: "stringExists";
 };
 export type CLXFormRuleStringListToStringListInstance = CLXFormRuleInstanceBase & {
     subject: CLXFormResponseStringArrayValue;
     target: CLXFormResponseStringArrayValue;
-    comparisonType: 'stringListContainsAll' | 'stringListContainsAny' | 'stringListContainsNone';
+    comparisonType: "stringListContainsAll" | "stringListContainsAny" | "stringListContainsNone";
 };
 export type CLXFormRuleStringInListInstance = CLXFormRuleInstanceBase & {
     subject: CLXFormResponseStringValue;
     target: CLXFormResponseStringArrayValue;
-    comparisonType: 'stringInList' | 'stringNotInList';
+    comparisonType: "stringInList" | "stringNotInList";
 };
 export type CLXFormRuleFileExistsInstance = CLXFormRuleInstanceBase & {
     subject: CLXFormResponseFileValue;
     target: CLXFormResponseBooleanValue;
-    comparisonType: 'fileExists';
+    comparisonType: "fileExists";
 };
 export type CLXFormRuleDateComparisonInstance = CLXFormRuleInstanceBase & {
     subject: CLXFormResponseDateValue;
     target: CLXFormResponseDateValue;
-    comparisonType: 'dateEquals' | 'dateBefore' | 'dateAfter';
+    comparisonType: "dateEquals" | "dateBefore" | "dateAfter";
 };
 export type CLXFormRuleStringListComparisonInstance = CLXFormRuleInstanceBase & {
     subject: CLXFormResponseStringArrayValue;
     target: CLXFormResponseStringValue;
-    comparisonType: 'stringListEntryEquals' | 'stringListEntryContains' | 'stringListEntryStartsWith' | 'stringListEntryEndsWith';
+    comparisonType: "stringListEntryEquals" | "stringListEntryContains" | "stringListEntryStartsWith" | "stringListEntryEndsWith";
 };
 export type CLXFormRuleBooleanEqualsInstance = CLXFormRuleInstanceBase & {
     subject: CLXFormResponseBooleanValue;
     target: CLXFormResponseBooleanValue;
-    comparisonType: 'booleanEquals';
+    comparisonType: "booleanEquals";
 };
 export type CLXFormRuleNumberComparisonInstance = CLXFormRuleInstanceBase & {
     subject: CLXFormResponseNumberValue;
     target: CLXFormResponseNumberValue;
-    comparisonType: 'numberEquals' | 'numberGreaterThan' | 'numberLessThan';
+    comparisonType: "numberEquals" | "numberGreaterThan" | "numberLessThan";
 };
 export type CLXFormRuleInstance = CLXFormRuleStringComparisonInstance | CLXFormRuleStringExistsComparisonInstance | CLXFormRuleStringInListInstance | CLXFormRuleFileExistsInstance | CLXFormRuleDateComparisonInstance | CLXFormRuleStringListToStringListInstance | CLXFormRuleStringListComparisonInstance | CLXFormRuleBooleanEqualsInstance | CLXFormRuleNumberComparisonInstance;
 export type CLXFormRuleSet = {
     rules: (CLXFormRuleDefinition | CLXFormRuleSet)[];
-    combinator?: 'and' | 'or';
+    combinator?: "and" | "or";
 };
 export type CLXConditionalOverride = {
     ruleset: CLXFormRuleSet;

package/package.json

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