@rockrms/obsidian-framework 17.0.43 → 17.2.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (263) hide show
  1. package/package.json +1 -1
  2. package/types/Controls/Grid/Columns/attributeColumns.partial.d.ts +1 -1
  3. package/types/Controls/Grid/Columns/booleanColumn.partial.d.ts +3 -3
  4. package/types/Controls/Grid/Columns/buttonColumn.partial.d.ts +38 -4
  5. package/types/Controls/Grid/Columns/column.partial.d.ts +3 -3
  6. package/types/Controls/Grid/Columns/copyColumn.partial.d.ts +4 -4
  7. package/types/Controls/Grid/Columns/currencyColumn.partial.d.ts +3 -3
  8. package/types/Controls/Grid/Columns/dateColumn.partial.d.ts +3 -3
  9. package/types/Controls/Grid/Columns/dateTimeColumn.partial.d.ts +3 -3
  10. package/types/Controls/Grid/Columns/deleteColumn.partial.d.ts +4 -4
  11. package/types/Controls/Grid/Columns/editColumn.partial.d.ts +4 -4
  12. package/types/Controls/Grid/Columns/highlightDetailColumn.partial.d.ts +3 -3
  13. package/types/Controls/Grid/Columns/htmlColumn.partial.d.ts +3 -3
  14. package/types/Controls/Grid/Columns/labelColumn.partial.d.ts +3 -3
  15. package/types/Controls/Grid/Columns/numberBadgeColumn.partial.d.ts +3 -3
  16. package/types/Controls/Grid/Columns/numberColumn.partial.d.ts +3 -3
  17. package/types/Controls/Grid/Columns/personColumn.partial.d.ts +20 -3
  18. package/types/Controls/Grid/Columns/reorderColumn.partial.d.ts +4 -4
  19. package/types/Controls/Grid/Columns/rockFieldColumn.partial.d.ts +3 -3
  20. package/types/Controls/Grid/Columns/securityColumn.partial.d.ts +4 -4
  21. package/types/Controls/Grid/Columns/selectColumn.partial.d.ts +4 -4
  22. package/types/Controls/Grid/Columns/textColumn.partial.d.ts +3 -3
  23. package/types/Controls/Grid/grid.partial.obs.d.ts +2 -2
  24. package/types/Controls/Internal/EmailEditor/api.d.ts +27 -16
  25. package/types/Controls/Internal/EmailEditor/componentPropertyPanel.partial.obs.d.ts +12 -1
  26. package/types/Controls/Internal/EmailEditor/emailEditor.partial.obs.d.ts +29 -2
  27. package/types/Controls/Internal/EmailEditor/multiSelectButtonGroup.partial.obs.d.ts +2 -2
  28. package/types/Controls/Internal/EmailEditor/overlay.obs.d.ts +4 -4
  29. package/types/Controls/Internal/EmailEditor/properties/inlineSwitchProperty.partial.obs.d.ts +1 -1
  30. package/types/Controls/Internal/EmailEditor/properties/innerHtmlProperty.partial.obs.d.ts +10 -0
  31. package/types/Controls/Internal/EmailEditor/properties/togglablePropertyGroup.partial.obs.d.ts +1 -1
  32. package/types/Controls/Internal/EmailEditor/propertyPanels/buttonComponentPropertyPanel.partial.obs.d.ts +2 -0
  33. package/types/Controls/Internal/EmailEditor/propertyPanels/codeComponentPropertyPanel.partial.obs.d.ts +14 -1
  34. package/types/Controls/Internal/EmailEditor/propertyPanels/imageComponentPropertyPanel.partial.obs.d.ts +2 -0
  35. package/types/Controls/Internal/EmailEditor/propertyPanels/rowComponentPropertyPanel.partial.obs.d.ts +2 -0
  36. package/types/Controls/Internal/EmailEditor/propertyPanels/rsvpComponentPropertyPanel.partial.obs.d.ts +2 -0
  37. package/types/Controls/Internal/EmailEditor/propertyPanels/textComponentPropertyPanel.partial.obs.d.ts +12 -1
  38. package/types/Controls/Internal/EmailEditor/propertyPanels/videoComponentPropertyPanel.partial.obs.d.ts +2 -0
  39. package/types/Controls/Internal/EmailEditor/sidePanel.partial.obs.d.ts +21 -1
  40. package/types/Controls/Internal/EmailEditor/singleSelectButtonGroup.partial.obs.d.ts +3 -3
  41. package/types/Controls/Internal/EmailEditor/textFormatPicker.partial.obs.d.ts +1 -1
  42. package/types/Controls/Internal/EmailEditor/types.d.ts +1 -0
  43. package/types/Controls/Internal/EmailEditor/utils.partial.d.ts +32 -5
  44. package/types/Controls/Internal/Notes/note.partial.obs.d.ts +34 -0
  45. package/types/Controls/Internal/Notes/noteEditor.partial.obs.d.ts +103 -0
  46. package/types/Controls/Internal/Notes/noteList.partial.obs.d.ts +24 -0
  47. package/types/Controls/Internal/Notes/types.partial.d.ts +63 -0
  48. package/types/Controls/Internal/Notes/utils.partial.d.ts +93 -0
  49. package/types/Controls/Internal/attributeMatrixEditor.obs.d.ts +1 -1
  50. package/types/Controls/Internal/notesContainer.obs.d.ts +247 -0
  51. package/types/Controls/Internal/treeListItem.obs.d.ts +1 -1
  52. package/types/Controls/NoteEditor/editSourceCodePlugin.partial.obs.d.ts +1 -1
  53. package/types/Controls/NoteEditor/mergeFieldPlugin.partial.obs.d.ts +18 -0
  54. package/types/Controls/accountPicker.obs.d.ts +2 -2
  55. package/types/Controls/achievementTypePicker.obs.d.ts +3 -3
  56. package/types/Controls/adaptiveMessagePicker.obs.d.ts +3 -3
  57. package/types/Controls/addressControl.obs.d.ts +1 -1
  58. package/types/Controls/aiProviderPicker.obs.d.ts +3 -3
  59. package/types/Controls/assessmentTypePicker.obs.d.ts +3 -3
  60. package/types/Controls/assetStorageProviderPicker.obs.d.ts +3 -3
  61. package/types/Controls/badgeComponentPicker.obs.d.ts +3 -3
  62. package/types/Controls/badgePicker.obs.d.ts +3 -3
  63. package/types/Controls/baseAsyncPicker.obs.d.ts +6 -6
  64. package/types/Controls/binaryFilePicker.obs.d.ts +9 -3
  65. package/types/Controls/binaryFileTypePicker.obs.d.ts +3 -3
  66. package/types/Controls/buttonDropDownList.obs.d.ts +2 -2
  67. package/types/Controls/buttonGroup.obs.d.ts +2 -2
  68. package/types/Controls/campusAccountAmountPicker.obs.d.ts +0 -27
  69. package/types/Controls/campusPicker.obs.d.ts +4 -4
  70. package/types/Controls/categorizedValuePicker.obs.d.ts +1 -1
  71. package/types/Controls/categorizedValuePickerDropDownLevel.obs.d.ts +1 -1
  72. package/types/Controls/checkBox.obs.d.ts +1 -0
  73. package/types/Controls/checkBoxList.obs.d.ts +3 -3
  74. package/types/Controls/codeEditor.obs.d.ts +6 -6
  75. package/types/Controls/colorSelector.obs.d.ts +1 -1
  76. package/types/Controls/componentPicker.obs.d.ts +4 -4
  77. package/types/Controls/connectionRequestPicker.obs.d.ts +0 -8
  78. package/types/Controls/contentChannelItemPicker.obs.d.ts +3 -3
  79. package/types/Controls/contentDropDownPicker.obs.d.ts +1 -1
  80. package/types/Controls/copyButton.obs.d.ts +3 -3
  81. package/types/Controls/customSelect.obs.d.ts +52 -52
  82. package/types/Controls/dataViewPicker.obs.d.ts +3 -3
  83. package/types/Controls/datePicker.obs.d.ts +4 -4
  84. package/types/Controls/datePickerBase.obs.d.ts +3 -3
  85. package/types/Controls/dayOfWeekPicker.obs.d.ts +1 -1
  86. package/types/Controls/definedValuePicker.obs.d.ts +4 -4
  87. package/types/Controls/dropDownList.obs.d.ts +6 -6
  88. package/types/Controls/dropDownMenu.obs.d.ts +3 -3
  89. package/types/Controls/electronicSignature.obs.d.ts +44 -2
  90. package/types/Controls/emailEditor.d.ts +2 -2
  91. package/types/Controls/entityPicker.obs.d.ts +1 -1
  92. package/types/Controls/entityTypePicker.obs.d.ts +3 -3
  93. package/types/Controls/ethnicityPicker.obs.d.ts +3 -3
  94. package/types/Controls/eventCalendarPicker.obs.d.ts +3 -3
  95. package/types/Controls/eventItemPicker.obs.d.ts +4 -4
  96. package/types/Controls/fieldTypePicker.obs.d.ts +3 -3
  97. package/types/Controls/financialGatewayPicker.obs.d.ts +4 -4
  98. package/types/Controls/financialStatementTemplatePicker.obs.d.ts +3 -3
  99. package/types/Controls/genderPicker.obs.d.ts +4 -4
  100. package/types/Controls/geoPicker.obs.d.ts +1 -1
  101. package/types/Controls/gradePicker.obs.d.ts +3 -3
  102. package/types/Controls/groupAndRolePicker.obs.d.ts +4 -4
  103. package/types/Controls/groupMemberPicker.obs.d.ts +3 -3
  104. package/types/Controls/groupRolePicker.obs.d.ts +3 -3
  105. package/types/Controls/groupTypeGroupPicker.obs.d.ts +4 -4
  106. package/types/Controls/groupTypePicker.obs.d.ts +3 -3
  107. package/types/Controls/highlightLabel.obs.d.ts +6 -6
  108. package/types/Controls/htmlEditor.obs.d.ts +38 -1
  109. package/types/Controls/imageEditor.obs.d.ts +2 -2
  110. package/types/Controls/inlineRangeSlider.obs.d.ts +2 -2
  111. package/types/Controls/inlineSwitch.obs.d.ts +9 -0
  112. package/types/Controls/interactionChannelPicker.obs.d.ts +3 -3
  113. package/types/Controls/interactionComponentPicker.obs.d.ts +3 -3
  114. package/types/Controls/kpi.obs.d.ts +3 -3
  115. package/types/Controls/lavaCommandPicker.obs.d.ts +3 -3
  116. package/types/Controls/listBox.obs.d.ts +2 -2
  117. package/types/Controls/listItems.obs.d.ts +1 -1
  118. package/types/Controls/locationItemPicker.obs.d.ts +1 -1
  119. package/types/Controls/locationList.obs.d.ts +3 -3
  120. package/types/Controls/mediaElementPicker.obs.d.ts +4 -4
  121. package/types/Controls/mediaPlayer.obs.d.ts +4 -4
  122. package/types/Controls/mediaSelector.obs.d.ts +2 -2
  123. package/types/Controls/mergeFieldPicker.obs.d.ts +1 -1
  124. package/types/Controls/modal.obs.d.ts +19 -1
  125. package/types/Controls/noteTextEditor.obs.d.ts +1 -1
  126. package/types/Controls/numberBox.obs.d.ts +1 -1
  127. package/types/Controls/numberUpDown.obs.d.ts +2 -2
  128. package/types/Controls/pagePicker.obs.d.ts +1 -1
  129. package/types/Controls/panel.obs.d.ts +3 -3
  130. package/types/Controls/personAvatar.obs.d.ts +90 -0
  131. package/types/Controls/personBasicEditor.obs.d.ts +0 -11
  132. package/types/Controls/personLink.obs.d.ts +3 -3
  133. package/types/Controls/phoneNumberBox.obs.d.ts +1 -1
  134. package/types/Controls/phoneNumberBoxWithSms.obs.d.ts +11 -0
  135. package/types/Controls/popOver.obs.d.ts +6 -6
  136. package/types/Controls/racePicker.obs.d.ts +3 -3
  137. package/types/Controls/radioButton.obs.d.ts +1 -1
  138. package/types/Controls/radioButtonList.obs.d.ts +3 -3
  139. package/types/Controls/rangeSlider.obs.d.ts +3 -3
  140. package/types/Controls/registrationInstanceBasePicker.obs.d.ts +3 -3
  141. package/types/Controls/reminderTypePicker.obs.d.ts +3 -3
  142. package/types/Controls/remoteAuthsPicker.obs.d.ts +3 -3
  143. package/types/Controls/rockButton.obs.d.ts +13 -4
  144. package/types/Controls/rockField.obs.d.ts +23 -0
  145. package/types/Controls/rockForm.obs.d.ts +8 -1
  146. package/types/Controls/rockFormField.obs.d.ts +1 -1
  147. package/types/Controls/rockSuspense.obs.d.ts +1 -1
  148. package/types/Controls/sectionContainer.obs.d.ts +1 -1
  149. package/types/Controls/sectionHeader.obs.d.ts +1 -1
  150. package/types/Controls/smsMessageEditor.obs.d.ts +20 -2
  151. package/types/Controls/socialSecurityNumberBox.obs.d.ts +1 -1
  152. package/types/Controls/stepProgramPicker.obs.d.ts +3 -3
  153. package/types/Controls/stepStatusPicker.obs.d.ts +3 -3
  154. package/types/Controls/stepTypePicker.obs.d.ts +3 -3
  155. package/types/Controls/streakTypePicker.obs.d.ts +3 -3
  156. package/types/Controls/structuredContentEditor.obs.d.ts +2 -2
  157. package/types/Controls/switch.obs.d.ts +9 -0
  158. package/types/Controls/tabbedBar.obs.d.ts +10 -0
  159. package/types/Controls/textBox.obs.d.ts +2 -2
  160. package/types/Controls/timePicker.obs.d.ts +2 -2
  161. package/types/Controls/treeItemPicker.obs.d.ts +2 -2
  162. package/types/Controls/treeList.obs.d.ts +1 -1
  163. package/types/Controls/valueFilter.obs.d.ts +1 -1
  164. package/types/Controls/wordCloud.obs.d.ts +3 -3
  165. package/types/Controls/workflowBasePicker.obs.d.ts +3 -3
  166. package/types/Controls/workflowTypePicker.obs.d.ts +2 -2
  167. package/types/Controls/yearPicker.obs.d.ts +2 -2
  168. package/types/Core/Reporting/fieldFilter.d.ts +84 -0
  169. package/types/Enums/Blocks/Communication/CommunicationEntryWizard/pushOpenAction.d.ts +3 -3
  170. package/types/Enums/Blocks/Communication/CommunicationTemplateDetail/pushOpenAction.d.ts +15 -0
  171. package/types/Enums/Cms/mediaElementQuality.d.ts +28 -0
  172. package/types/Enums/Communication/Chat/chatNotificationMode.d.ts +13 -0
  173. package/types/Enums/Mobile/locationPermissionStatus.d.ts +15 -0
  174. package/types/Enums/Observability/featureFlags.d.ts +13 -0
  175. package/types/Enums/Observability/traceLevel.d.ts +24 -0
  176. package/types/Enums/Security/loginFailureReason.d.ts +2 -2
  177. package/types/Enums/Workflow/interactiveActionContinueMode.d.ts +33 -0
  178. package/types/Enums/Workflow/interactiveMessageType.d.ts +33 -0
  179. package/types/FieldTypes/financialTransactionField.partial.d.ts +7 -0
  180. package/types/FieldTypes/financialTransactionFieldComponents.d.ts +30 -0
  181. package/types/FieldTypes/htmlField.partial.d.ts +2 -1
  182. package/types/FieldTypes/htmlFieldComponents.d.ts +1 -0
  183. package/types/PageState/state.d.ts +1 -0
  184. package/types/SystemGuids/fieldType.d.ts +2 -0
  185. package/types/SystemGuids/group.d.ts +4 -0
  186. package/types/SystemGuids/groupRole.d.ts +4 -0
  187. package/types/SystemGuids/groupType.d.ts +2 -0
  188. package/types/SystemGuids/serviceJob.d.ts +15 -0
  189. package/types/Templates/detailBlock.d.ts +2 -2
  190. package/types/Templates/rockBlock.partial.d.ts +4 -4
  191. package/types/Types/Reporting/fieldFilterAttributeData.d.ts +29 -0
  192. package/types/Utility/block.d.ts +3 -1
  193. package/types/Utility/page.d.ts +1 -0
  194. package/types/Utility/stringUtils.d.ts +17 -0
  195. package/types/Utility/tooltip.d.ts +6 -0
  196. package/types/ViewModels/Blocks/Administration/SystemConfiguration/observabilityConfigurationBag.d.ts +7 -2
  197. package/types/ViewModels/Blocks/CheckIn/CheckInKiosk/webKioskBag.d.ts +6 -0
  198. package/types/ViewModels/Blocks/CheckIn/CheckInScheduleBuilder/cloneScheduleBag.d.ts +4 -0
  199. package/types/ViewModels/Blocks/CheckIn/Config/CheckinTypeDetail/checkInGeneralSettingsBag.d.ts +9 -0
  200. package/types/ViewModels/Blocks/CheckIn/Config/CheckinTypeDetail/checkinTypeDetailOptionsBag.d.ts +3 -0
  201. package/types/ViewModels/Blocks/Cms/LayoutBlockList/layoutBlockListOptionsBag.d.ts +26 -0
  202. package/types/ViewModels/Blocks/Cms/MediaAccountDetail/mediaAccountBag.d.ts +3 -0
  203. package/types/ViewModels/Blocks/Cms/MediaElementDetail/mediaElementBag.d.ts +89 -0
  204. package/types/ViewModels/Blocks/Cms/MediaElementDetail/mediaElementDetailOptionsBag.d.ts +26 -0
  205. package/types/ViewModels/Blocks/Cms/MediaElementList/mediaElementListOptionsBag.d.ts +28 -0
  206. package/types/ViewModels/Blocks/Communication/Chat/ChatView/chatPersonDataBag.d.ts +43 -0
  207. package/types/ViewModels/Blocks/Communication/Chat/ChatView/chatPersonSettingsBag.d.ts +31 -0
  208. package/types/ViewModels/Blocks/Communication/Chat/ChatView/chatViewConfigurationBag.d.ts +46 -0
  209. package/types/ViewModels/Blocks/Communication/Chat/ChatView/chatViewInitializationBox.d.ts +42 -0
  210. package/types/ViewModels/Blocks/Communication/CommunicationEntry/communicationEntryInitializationBox.d.ts +3 -0
  211. package/types/ViewModels/Blocks/Communication/CommunicationEntryWizard/communicationEntryWizardCommunicationBag.d.ts +1 -1
  212. package/types/ViewModels/Blocks/Communication/CommunicationTemplateDetail/communicationTemplateDetailCommunicationTemplateBag.d.ts +117 -0
  213. package/types/ViewModels/Blocks/Communication/CommunicationTemplateDetail/communicationTemplateDetailGetPreviewMessageRequestBag.d.ts +31 -0
  214. package/types/ViewModels/Blocks/Communication/CommunicationTemplateDetail/communicationTemplateDetailInitializationBox.d.ts +166 -0
  215. package/types/ViewModels/Blocks/Communication/SmsConversations/smsConversationsInitializationBox.d.ts +1 -1
  216. package/types/ViewModels/Blocks/Communication/SmsConversations/smsConversationsSaveNoteBag.d.ts +1 -1
  217. package/types/ViewModels/Blocks/Core/DeviceDetail/deviceBag.d.ts +3 -0
  218. package/types/ViewModels/Blocks/Core/DeviceDetail/deviceDetailOptionsBag.d.ts +3 -0
  219. package/types/ViewModels/Blocks/Core/LocationDetail/locationBag.d.ts +3 -0
  220. package/types/ViewModels/Blocks/Core/Notes/notesInitializationBox.d.ts +2 -2
  221. package/types/ViewModels/Blocks/Engagement/StepProgramList/stepProgramListOptionsBag.d.ts +2 -0
  222. package/types/ViewModels/Blocks/Event/RegistrationEntry/registrantBag.d.ts +3 -0
  223. package/types/ViewModels/Blocks/Finance/FinancialAccountDetail/financialAccountBag.d.ts +6 -0
  224. package/types/ViewModels/Blocks/Group/Scheduling/GroupScheduleToolbox/performScheduleRowActionRequestBag.d.ts +4 -0
  225. package/types/ViewModels/Blocks/{Cms/BlockList/blockListOptionsBag.d.ts → Security/LoginHistory/loginHistoryOptionsBag.d.ts} +2 -2
  226. package/types/ViewModels/Blocks/Tv/TvPageList/tvPageListOptionsBag.d.ts +3 -0
  227. package/types/ViewModels/Blocks/Workflow/WorkflowEntry/workflowEntryOptionsBag.d.ts +39 -0
  228. package/types/ViewModels/Blocks/blockActionContextBag.d.ts +7 -0
  229. package/types/ViewModels/CheckIn/kioskBag.d.ts +6 -0
  230. package/types/ViewModels/{Blocks/Core/Notes → Controls}/saveNoteRequestBag.d.ts +2 -2
  231. package/types/ViewModels/Finance/savedAccountTokenBag.d.ts +3 -0
  232. package/types/ViewModels/Reporting/chartNumericDataPointBag.d.ts +37 -0
  233. package/types/ViewModels/Rest/CheckIn/proximityBeaconBag.d.ts +49 -0
  234. package/types/ViewModels/Rest/CheckIn/proximityCheckInOptionsBag.d.ts +56 -0
  235. package/types/ViewModels/Rest/Controls/assessmentTypePickerGetAssessmentTypesOptionsBag.d.ts +3 -0
  236. package/types/ViewModels/Rest/Controls/assetManagerGetFilesResultsBag.d.ts +5 -2
  237. package/types/ViewModels/Rest/Controls/binaryFilePickerGetBinaryFilesOptionsBag.d.ts +6 -0
  238. package/types/ViewModels/Rest/Controls/campusAccountAmountPickerGetAccountsResultItemBag.d.ts +0 -7
  239. package/types/ViewModels/Rest/Controls/emailEditorCreateAttendanceOccurrenceOptionsBag.d.ts +6 -0
  240. package/types/ViewModels/Rest/Controls/emailEditorDeleteEmailSectionOptionsBag.d.ts +6 -0
  241. package/types/ViewModels/Rest/Controls/emailEditorEmailSectionBag.d.ts +6 -0
  242. package/types/ViewModels/Rest/Controls/emailEditorGetAllEmailSectionsOptionsBag.d.ts +31 -0
  243. package/types/ViewModels/Rest/Controls/emailEditorGetAttendanceOccurrenceOptionsBag.d.ts +6 -0
  244. package/types/ViewModels/Rest/Controls/emailEditorGetEmailSectionOptionsBag.d.ts +6 -0
  245. package/types/ViewModels/Rest/Controls/emailEditorGetFutureAttendanceOccurrencesOptionsBag.d.ts +6 -0
  246. package/types/ViewModels/Rest/Controls/emailEditorRegisterRsvpRecipientsOptionsBag.d.ts +6 -0
  247. package/types/ViewModels/Rest/Controls/personBasicEditorBag.d.ts +3 -0
  248. package/types/ViewModels/Rest/Controls/reminderTypePickerGetReminderTypesOptionsBag.d.ts +3 -0
  249. package/types/ViewModels/Rest/Controls/stepStatusPickerGetStepStatusesOptionsBag.d.ts +3 -0
  250. package/types/ViewModels/Rest/Controls/stepTypePickerGetStepTypesOptionsBag.d.ts +3 -0
  251. package/types/ViewModels/Workflow/entryFormButtonBag.d.ts +37 -0
  252. package/types/ViewModels/Workflow/entryFormFieldBag.d.ts +61 -0
  253. package/types/ViewModels/Workflow/entryFormSectionBag.d.ts +54 -0
  254. package/types/ViewModels/Workflow/interactiveActionBag.d.ts +99 -0
  255. package/types/ViewModels/Workflow/interactiveActionDataBag.d.ts +61 -0
  256. package/types/ViewModels/Workflow/interactiveActionExceptionBag.d.ts +37 -0
  257. package/types/ViewModels/Workflow/interactiveMessageBag.d.ts +39 -0
  258. package/types/ViewModels/Workflow/personEntryConfigurationBag.d.ts +128 -0
  259. package/types/ViewModels/Workflow/personEntryValuesBag.d.ts +44 -0
  260. /package/types/Enums/{Blocks/Communication/CommunicationEntryWizard → Communication}/communicationType.d.ts +0 -0
  261. /package/types/ViewModels/{Blocks/Core/Notes → Controls}/noteBag.d.ts +0 -0
  262. /package/types/ViewModels/{Blocks/Core/Notes → Controls}/noteEditBag.d.ts +0 -0
  263. /package/types/ViewModels/{Blocks/Core/Notes → Controls}/noteTypeBag.d.ts +0 -0
@@ -34,6 +34,17 @@ declare const _default: import("vue").DefineComponent<{
34
34
  type: PropType<boolean>;
35
35
  default: boolean;
36
36
  };
37
+ /**
38
+ * If `true` then the field will be marked as required even if the
39
+ * attribute is not. If `false` then the field will not be required
40
+ * even if the attribute wants to be. If the default of `undefined` then
41
+ * the value from the attribute will be used.
42
+ */
43
+ requiredOverride: {
44
+ type: PropType<boolean>;
45
+ default: undefined;
46
+ required: false;
47
+ };
37
48
  }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
38
49
  "update:modelValue": (value: string) => void;
39
50
  updateConfigurationValue: (key: string, value: string) => void;
@@ -70,6 +81,17 @@ declare const _default: import("vue").DefineComponent<{
70
81
  type: PropType<boolean>;
71
82
  default: boolean;
72
83
  };
84
+ /**
85
+ * If `true` then the field will be marked as required even if the
86
+ * attribute is not. If `false` then the field will not be required
87
+ * even if the attribute wants to be. If the default of `undefined` then
88
+ * the value from the attribute will be used.
89
+ */
90
+ requiredOverride: {
91
+ type: PropType<boolean>;
92
+ default: undefined;
93
+ required: false;
94
+ };
73
95
  }>> & {
74
96
  "onUpdate:modelValue"?: ((value: string) => any) | undefined;
75
97
  onUpdateConfigurationValue?: ((key: string, value: string) => any) | undefined;
@@ -80,5 +102,6 @@ declare const _default: import("vue").DefineComponent<{
80
102
  isCondensed: boolean;
81
103
  dataEntryMode: DataEntryMode;
82
104
  isEscaped: boolean;
105
+ requiredOverride: boolean;
83
106
  }, {}>;
84
107
  export default _default;
@@ -1,5 +1,10 @@
1
1
  import { PropType } from "vue";
2
2
  import { FormError } from "@Obsidian/Utility/form";
3
+ /**
4
+ * Submits the form and waits until both validation and the onSubmit
5
+ * callback have completed before returning.
6
+ */
7
+ declare function submitForm(): Promise<void>;
3
8
  declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
4
9
  /** True if the form should attempt to submit. */
5
10
  submit: {
@@ -24,7 +29,9 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
24
29
  type: PropType<() => void | PromiseLike<void>>;
25
30
  required: false;
26
31
  };
27
- }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
32
+ }, {
33
+ submitForm: typeof submitForm;
34
+ }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
28
35
  validationChanged: (errors: FormError[]) => void;
29
36
  visibleValidationChanged: (errors: FormError[]) => void;
30
37
  "update:submit": (value: boolean) => void;
@@ -107,11 +107,11 @@ declare const _default: import("vue").DefineComponent<{
107
107
  }>>, {
108
108
  label: string;
109
109
  help: string;
110
+ watchDeep: boolean;
110
111
  disableLabel: boolean;
111
112
  rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
112
113
  formGroupClasses: string;
113
114
  validationTitle: string;
114
115
  isRequiredIndicatorHidden: boolean;
115
- watchDeep: boolean;
116
116
  }, {}>;
117
117
  export default _default;
@@ -22,8 +22,8 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
22
22
  default: number;
23
23
  };
24
24
  }>> & {
25
- onLoaded?: (() => any) | undefined;
26
25
  onTimeout?: (() => any) | undefined;
26
+ onLoaded?: (() => any) | undefined;
27
27
  onReady?: (() => any) | undefined;
28
28
  }, {
29
29
  delay: number;
@@ -38,9 +38,9 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
38
38
  }>> & {
39
39
  "onUpdate:modelValue"?: ((value: boolean) => any) | undefined;
40
40
  }, {
41
- description: string;
42
41
  title: string;
43
42
  modelValue: boolean;
43
+ description: string;
44
44
  toggleText: string;
45
45
  }, {}>, {
46
46
  actions?(_: {}): any;
@@ -26,8 +26,8 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
26
26
  default: boolean;
27
27
  };
28
28
  }>>, {
29
- description: string;
30
29
  title: string;
30
+ description: string;
31
31
  isSeparatorHidden: boolean;
32
32
  }, {}>, {
33
33
  actions?(_: {}): any;
@@ -22,6 +22,15 @@ declare const _default: import("vue").DefineComponent<{
22
22
  type: PropType<string[] | undefined>;
23
23
  required: false;
24
24
  };
25
+ /**
26
+ * A list of common merge field to show below the picker for easy access. Should be an array of strings
27
+ * and the strings should be in the following format: "FieldName^Label|Icon", where the FieldName is the
28
+ * name of the merge field, Label is the text to display on the button, and Icon is the CSS class for icon.
29
+ */
30
+ commonMergeFields: {
31
+ type: PropType<string[] | undefined>;
32
+ required: false;
33
+ };
25
34
  shortLinkCheckToken: {
26
35
  type: PropType<((token: string, siteId: number) => Promise<string>) | null | undefined>;
27
36
  };
@@ -125,6 +134,15 @@ declare const _default: import("vue").DefineComponent<{
125
134
  type: PropType<string[] | undefined>;
126
135
  required: false;
127
136
  };
137
+ /**
138
+ * A list of common merge field to show below the picker for easy access. Should be an array of strings
139
+ * and the strings should be in the following format: "FieldName^Label|Icon", where the FieldName is the
140
+ * name of the merge field, Label is the text to display on the button, and Icon is the CSS class for icon.
141
+ */
142
+ commonMergeFields: {
143
+ type: PropType<string[] | undefined>;
144
+ required: false;
145
+ };
128
146
  shortLinkCheckToken: {
129
147
  type: PropType<((token: string, siteId: number) => Promise<string>) | null | undefined>;
130
148
  };
@@ -209,9 +227,8 @@ declare const _default: import("vue").DefineComponent<{
209
227
  "onUpdate:modelValue"?: ((value: string) => any) | undefined;
210
228
  }, {
211
229
  label: string;
212
- help: string;
213
- toolbar: ToolbarConfig;
214
230
  disabled: boolean;
231
+ help: string;
215
232
  disableLabel: boolean;
216
233
  rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
217
234
  formGroupClasses: string;
@@ -219,6 +236,7 @@ declare const _default: import("vue").DefineComponent<{
219
236
  isRequiredIndicatorHidden: boolean;
220
237
  editorHeight: number;
221
238
  startInCodeEditorMode: boolean;
239
+ toolbar: ToolbarConfig;
222
240
  countDownMaxChars: number;
223
241
  isCharacterCountShown: boolean;
224
242
  isCountDownShown: boolean;
@@ -17,7 +17,7 @@ declare const _default: import("vue").DefineComponent<{
17
17
  }>> & {
18
18
  "onUpdate:modelValue"?: ((value: string) => any) | undefined;
19
19
  }, {
20
- rules: ValidationRule | ValidationRule[];
21
20
  modelValue: string;
21
+ rules: ValidationRule | ValidationRule[];
22
22
  }, {}>;
23
23
  export default _default;
@@ -123,17 +123,17 @@ declare const _default: import("vue").DefineComponent<{
123
123
  }, {
124
124
  label: string;
125
125
  help: string;
126
- columnCount: number;
127
- multiple: boolean;
128
126
  disableLabel: boolean;
129
127
  rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
130
128
  formGroupClasses: string;
131
129
  validationTitle: string;
132
130
  isRequiredIndicatorHidden: boolean;
131
+ multiple: boolean;
133
132
  enhanceForLongLists: boolean;
134
- lazyMode: import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode;
135
133
  showBlankItem: boolean;
136
134
  blankValue: string;
135
+ lazyMode: import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode;
137
136
  displayStyle: import("@Obsidian/Enums/Controls/pickerDisplayStyle").PickerDisplayStyle;
137
+ columnCount: number;
138
138
  }, {}>;
139
139
  export default _default;
@@ -137,18 +137,18 @@ declare const _default: import("vue").DefineComponent<{
137
137
  }, {
138
138
  label: string;
139
139
  help: string;
140
- columnCount: number;
141
- multiple: boolean;
142
140
  disableLabel: boolean;
143
141
  rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
144
142
  formGroupClasses: string;
145
143
  validationTitle: string;
146
144
  isRequiredIndicatorHidden: boolean;
145
+ multiple: boolean;
147
146
  enhanceForLongLists: boolean;
148
- lazyMode: import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode;
149
147
  showBlankItem: boolean;
150
148
  blankValue: string;
149
+ lazyMode: import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode;
151
150
  displayStyle: import("@Obsidian/Enums/Controls/pickerDisplayStyle").PickerDisplayStyle;
151
+ columnCount: number;
152
152
  stepProgramGuid: string | null;
153
153
  }, {}>;
154
154
  export default _default;
@@ -131,18 +131,18 @@ declare const _default: import("vue").DefineComponent<{
131
131
  }, {
132
132
  label: string;
133
133
  help: string;
134
- columnCount: number;
135
- multiple: boolean;
136
134
  disableLabel: boolean;
137
135
  rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
138
136
  formGroupClasses: string;
139
137
  validationTitle: string;
140
138
  isRequiredIndicatorHidden: boolean;
139
+ multiple: boolean;
141
140
  enhanceForLongLists: boolean;
142
- lazyMode: import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode;
143
141
  showBlankItem: boolean;
144
142
  blankValue: string;
143
+ lazyMode: import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode;
145
144
  displayStyle: import("@Obsidian/Enums/Controls/pickerDisplayStyle").PickerDisplayStyle;
145
+ columnCount: number;
146
146
  stepProgramGuid: string | null;
147
147
  }, {}>;
148
148
  export default _default;
@@ -123,17 +123,17 @@ declare const _default: import("vue").DefineComponent<{
123
123
  }, {
124
124
  label: string;
125
125
  help: string;
126
- columnCount: number;
127
- multiple: boolean;
128
126
  disableLabel: boolean;
129
127
  rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
130
128
  formGroupClasses: string;
131
129
  validationTitle: string;
132
130
  isRequiredIndicatorHidden: boolean;
131
+ multiple: boolean;
133
132
  enhanceForLongLists: boolean;
134
- lazyMode: import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode;
135
133
  showBlankItem: boolean;
136
134
  blankValue: string;
135
+ lazyMode: import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode;
137
136
  displayStyle: import("@Obsidian/Enums/Controls/pickerDisplayStyle").PickerDisplayStyle;
137
+ columnCount: number;
138
138
  }, {}>;
139
139
  export default _default;
@@ -90,14 +90,14 @@ declare const _default: import("vue").DefineComponent<{
90
90
  "onUpdate:modelValue"?: ((value: string) => any) | undefined;
91
91
  }, {
92
92
  label: string;
93
- help: string;
94
93
  disabled: boolean;
94
+ help: string;
95
+ modelValue: string;
95
96
  disableLabel: boolean;
96
97
  rules: ValidationRule | ValidationRule[];
97
98
  formGroupClasses: string;
98
99
  validationTitle: string;
99
100
  isRequiredIndicatorHidden: boolean;
100
- modelValue: string;
101
101
  toolsGuid: string | null;
102
102
  }, {}>;
103
103
  export default _default;
@@ -8,6 +8,10 @@ declare const _default: import("vue").DefineComponent<{
8
8
  type: PropType<string>;
9
9
  default: string;
10
10
  };
11
+ help: {
12
+ type: PropType<string>;
13
+ default: string;
14
+ };
11
15
  }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
12
16
  "update:modelValue": (value: boolean) => void;
13
17
  }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
@@ -19,9 +23,14 @@ declare const _default: import("vue").DefineComponent<{
19
23
  type: PropType<string>;
20
24
  default: string;
21
25
  };
26
+ help: {
27
+ type: PropType<string>;
28
+ default: string;
29
+ };
22
30
  }>> & {
23
31
  "onUpdate:modelValue"?: ((value: boolean) => any) | undefined;
24
32
  }, {
25
33
  text: string;
34
+ help: string;
26
35
  }, {}>;
27
36
  export default _default;
@@ -16,6 +16,11 @@ declare const _default: import("vue").DefineComponent<{
16
16
  type: PropType<"tabs" | "pills">;
17
17
  default: string;
18
18
  };
19
+ /** The key for the selected tab to be tracked in the Query String. */
20
+ selectedTabQueryParameterKey: {
21
+ type: StringConstructor;
22
+ required: false;
23
+ };
19
24
  }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
20
25
  "update:modelValue": (value: string) => void;
21
26
  }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
@@ -34,6 +39,11 @@ declare const _default: import("vue").DefineComponent<{
34
39
  type: PropType<"tabs" | "pills">;
35
40
  default: string;
36
41
  };
42
+ /** The key for the selected tab to be tracked in the Query String. */
43
+ selectedTabQueryParameterKey: {
44
+ type: StringConstructor;
45
+ required: false;
46
+ };
37
47
  }>> & {
38
48
  "onUpdate:modelValue"?: ((value: string) => any) | undefined;
39
49
  }, {
@@ -193,9 +193,8 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
193
193
  }, {
194
194
  type: string;
195
195
  label: string;
196
- size: "small" | "medium" | "large";
197
- help: string;
198
196
  placeholder: string;
197
+ help: string;
199
198
  disableLabel: boolean;
200
199
  rules: ValidationRule | ValidationRule[];
201
200
  formGroupClasses: string;
@@ -209,6 +208,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
209
208
  inputGroupClasses: string;
210
209
  rows: number;
211
210
  textMode: string;
211
+ size: "small" | "medium" | "large";
212
212
  allowHtml: boolean;
213
213
  isClearable: boolean;
214
214
  canExceedMaxLength: boolean;
@@ -75,13 +75,13 @@ declare const _default: import("vue").DefineComponent<{
75
75
  "onUpdate:modelValue"?: ((_value: TimePickerValue) => any) | undefined;
76
76
  }, {
77
77
  label: string;
78
- help: string;
79
78
  disabled: boolean;
79
+ help: string;
80
+ modelValue: TimePickerValue;
80
81
  disableLabel: boolean;
81
82
  rules: ValidationRule | ValidationRule[];
82
83
  formGroupClasses: string;
83
84
  validationTitle: string;
84
85
  isRequiredIndicatorHidden: boolean;
85
- modelValue: TimePickerValue;
86
86
  }, {}>;
87
87
  export default _default;
@@ -123,14 +123,14 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
123
123
  "onUpdate:showPopup"?: ((_value: boolean) => any) | undefined;
124
124
  onValueSelected?: (() => any) | undefined;
125
125
  }, {
126
- multiple: boolean;
127
- blankValue: string;
128
126
  showPopup: boolean;
129
127
  iconCssClass: string;
130
128
  fullWidth: boolean;
129
+ multiple: boolean;
131
130
  disableFolderSelection: boolean;
132
131
  autoExpand: boolean;
133
132
  showChildCount: boolean;
133
+ blankValue: string;
134
134
  }, {}>, {
135
135
  pickerContentSuperHeader?(_: {}): any;
136
136
  pickerContentHeader?(_: {}): any;
@@ -126,8 +126,8 @@ declare const _default: import("vue").DefineComponent<{
126
126
  "onTreeitem-collapsed"?: ((value: TreeItemBag) => any) | undefined;
127
127
  "onUpdate:items"?: ((value: TreeItemBag[]) => any) | undefined;
128
128
  }, {
129
- multiple: boolean;
130
129
  modelValue: string[];
130
+ multiple: boolean;
131
131
  disableFolderSelection: boolean;
132
132
  initiallyExpanded: string[];
133
133
  autoExpand: boolean;
@@ -95,12 +95,12 @@ declare const _default: import("vue").DefineComponent<{
95
95
  }, {
96
96
  label: string;
97
97
  help: string;
98
+ modelValue: Partial<CompoundFilterExpression>;
98
99
  disableLabel: boolean;
99
100
  rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
100
101
  formGroupClasses: string;
101
102
  validationTitle: string;
102
103
  isRequiredIndicatorHidden: boolean;
103
- modelValue: Partial<CompoundFilterExpression>;
104
104
  comparisonTypes: ComparisonItem[];
105
105
  hideFilterMode: boolean;
106
106
  }, {}>;
@@ -214,19 +214,19 @@ declare const _default: import("vue").DefineComponent<{
214
214
  onBeginDraw?: (() => any) | undefined;
215
215
  onEndDraw?: (() => any) | undefined;
216
216
  }, {
217
- animationDuration: number;
218
- height: string | number;
219
217
  width: string | number;
218
+ height: string | number;
220
219
  words: string[];
221
- colors: string[];
222
220
  angleCount: number;
223
221
  minimumAngle: number;
224
222
  maximumAngle: number;
225
223
  fontName: string;
226
224
  minimumFontSize: number;
227
225
  maximumFontSize: number;
226
+ colors: string[];
228
227
  wordPadding: number;
229
228
  autoClear: boolean;
229
+ animationDuration: number;
230
230
  minimumUpdateInterval: number;
231
231
  }, {}>;
232
232
  export default _default;
@@ -137,18 +137,18 @@ declare const _default: import("vue").DefineComponent<{
137
137
  }, {
138
138
  label: string;
139
139
  help: string;
140
- columnCount: number;
141
- multiple: boolean;
142
140
  disableLabel: boolean;
143
141
  rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
144
142
  formGroupClasses: string;
145
143
  validationTitle: string;
146
144
  isRequiredIndicatorHidden: boolean;
145
+ multiple: boolean;
147
146
  enhanceForLongLists: boolean;
148
- lazyMode: import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode;
149
147
  showBlankItem: boolean;
150
148
  blankValue: string;
149
+ lazyMode: import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode;
151
150
  displayStyle: import("@Obsidian/Enums/Controls/pickerDisplayStyle").PickerDisplayStyle;
151
+ columnCount: number;
152
152
  workflowTypeGuid: string | null;
153
153
  }, {}>;
154
154
  export default _default;
@@ -90,14 +90,14 @@ declare const _default: import("vue").DefineComponent<{
90
90
  "onUpdate:modelValue"?: ((_value: ListItemBag | ListItemBag[] | null) => any) | undefined;
91
91
  }, {
92
92
  label: string;
93
- help: string;
94
- multiple: boolean;
95
93
  disabled: boolean;
94
+ help: string;
96
95
  disableLabel: boolean;
97
96
  rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
98
97
  formGroupClasses: string;
99
98
  validationTitle: string;
100
99
  isRequiredIndicatorHidden: boolean;
100
+ multiple: boolean;
101
101
  includeInactiveItems: boolean;
102
102
  }, {}>;
103
103
  export default _default;
@@ -73,13 +73,13 @@ declare const _default: import("vue").DefineComponent<{
73
73
  "onUpdate:modelValue"?: ((val: string) => any) | undefined;
74
74
  }, {
75
75
  label: string;
76
- help: string;
77
76
  disabled: boolean;
77
+ help: string;
78
+ modelValue: string | null;
78
79
  disableLabel: boolean;
79
80
  rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
80
81
  formGroupClasses: string;
81
82
  validationTitle: string;
82
83
  isRequiredIndicatorHidden: boolean;
83
- modelValue: string | null;
84
84
  }, {}>;
85
85
  export default _default;
@@ -1,3 +1,4 @@
1
+ import { FieldFilterAttributeData } from "@Obsidian/Types/Reporting/fieldFilterAttributeData";
1
2
  import { FieldFilterGroupBag } from "@Obsidian/ViewModels/Reporting/fieldFilterGroupBag";
2
3
  import { FieldFilterRuleBag } from "@Obsidian/ViewModels/Reporting/fieldFilterRuleBag";
3
4
  import { FieldFilterSourceBag } from "@Obsidian/ViewModels/Reporting/fieldFilterSourceBag";
@@ -20,3 +21,86 @@ export declare function getFilterGroupTitleHtml(group: FieldFilterGroupBag): str
20
21
  * @returns A plain text string that represents the rule in a human friendly format.
21
22
  */
22
23
  export declare function getFilterRuleDescription(rule: FieldFilterRuleBag, sources: FieldFilterSourceBag[]): string;
24
+ /**
25
+ * Provides filtering logic for {@link FieldFilterGroupBag} objects. This can
26
+ * either perform a one-time check against a single instance or build a
27
+ * function that can be used repeatedly against different objects.
28
+ */
29
+ export declare class FieldFilterFunctionBuilder<T = unknown> {
30
+ /**
31
+ * Checks if the object matches the rule(s) provided by the filter.
32
+ *
33
+ * @param instance The object to be checked to determine if it matches the filter.
34
+ * @param filter The rule(s) that describe the filter conditions.
35
+ *
36
+ * @returns `true` if the object matched the rules; otherwise `false`.
37
+ */
38
+ isMatch(instance: T, filter: FieldFilterGroupBag): boolean;
39
+ /**
40
+ * Gets a reusable function that can be called on various objects to determine
41
+ * if they match the provided filter.
42
+ *
43
+ * @param filter The rule(s) that describe the filter conditions.
44
+ *
45
+ * @returns A function that can be called to determine if an object matches the filter.
46
+ */
47
+ getIsMatchFunction(filter: FieldFilterGroupBag): (instance: T) => boolean;
48
+ /**
49
+ * Determines if the object matches the filter rule group.
50
+ *
51
+ * @param instance The object to be checked to determine if it matches the filter.
52
+ * @param filter The rule(s) that describe the filter conditions.
53
+ *
54
+ * @returns `true` if the object matched the rules; otherwise `false`.
55
+ */
56
+ protected isGroupMatch(instance: T, filter: FieldFilterGroupBag): boolean;
57
+ /**
58
+ * Determines if the object matches a single filter rule.
59
+ *
60
+ * @param instance The object to be checked to determine if it matches the filter.
61
+ * @param rule The single rule that describes the filter condition.
62
+ *
63
+ * @returns `true` if the object matched the rule; otherwise `false`.
64
+ */
65
+ protected isRuleMatch(instance: T, rule: FieldFilterRuleBag): boolean;
66
+ /**
67
+ * Determines if the object matches a single property rule.
68
+ *
69
+ * @param instance The object to be checked to determine if it matches the filter.
70
+ * @param rule The single rule that describes the filter condition.
71
+ *
72
+ * @returns `true` if the object matched the rule; otherwise `false`.
73
+ */
74
+ protected isRulePropertyMatch(instance: T, rule: FieldFilterRuleBag): boolean;
75
+ /**
76
+ * Determines if the object matches a single attribute rule.
77
+ *
78
+ * @param instance The object to be checked to determine if it matches the filter.
79
+ * @param rule The single rule that describes the filter condition.
80
+ *
81
+ * @returns `true` if the object matched the rule; otherwise `false`.
82
+ */
83
+ protected isRuleAttributeMatch(instance: T, rule: FieldFilterRuleBag): boolean;
84
+ /**
85
+ * Gets the required data which describes the attribute. This is used to
86
+ * load the field type and provide the configuration values when calling
87
+ * the compare function on the field.
88
+ *
89
+ * @param instance The object to be checked to determine if it matches the filter.
90
+ * @param rule The single rule that describes the filter condition.
91
+ *
92
+ * @returns An object that describes the attribute details or `undefined` if
93
+ * the attribute could not be found.
94
+ */
95
+ protected getInstanceAttributeData(instance: T, rule: FieldFilterRuleBag): FieldFilterAttributeData | undefined;
96
+ /**
97
+ * Gets the current value of the attribute on the object. The value must
98
+ * be in public edit format in order for the filter to work correctly.
99
+ *
100
+ * @param instance The object to be checked to determine if it matches the filter.
101
+ * @param rule The single rule that describes the filter condition.
102
+ *
103
+ * @returns A string that represents the current edit value.
104
+ */
105
+ protected getInstanceAttributeValue(instance: T, rule: FieldFilterRuleBag): string | undefined;
106
+ }
@@ -1,4 +1,4 @@
1
- /** The Push Open Action used by the Communication Entry block. */
1
+ /** The Push Open Action used by the Communication Entry Wizard block. */
2
2
  export declare const PushOpenAction: {
3
3
  /** No action */
4
4
  readonly NoAction: 0;
@@ -9,7 +9,7 @@ export declare const PushOpenAction: {
9
9
  /** Link to URL */
10
10
  readonly LinkToUrl: 3;
11
11
  };
12
- /** The Push Open Action used by the Communication Entry block. */
12
+ /** The Push Open Action used by the Communication Entry Wizard block. */
13
13
  export declare const PushOpenActionDescription: Record<number, string>;
14
- /** The Push Open Action used by the Communication Entry block. */
14
+ /** The Push Open Action used by the Communication Entry Wizard block. */
15
15
  export type PushOpenAction = typeof PushOpenAction[keyof typeof PushOpenAction];
@@ -0,0 +1,15 @@
1
+ /** The Push Open Action used by the Template Detail block. */
2
+ export declare const PushOpenAction: {
3
+ /** No action */
4
+ readonly NoAction: 0;
5
+ /** Show details */
6
+ readonly ShowDetails: 1;
7
+ /** Link to mobile page */
8
+ readonly LinkToMobilePage: 2;
9
+ /** Link to URL */
10
+ readonly LinkToUrl: 3;
11
+ };
12
+ /** The Push Open Action used by the Template Detail block. */
13
+ export declare const PushOpenActionDescription: Record<number, string>;
14
+ /** The Push Open Action used by the Template Detail block. */
15
+ export type PushOpenAction = typeof PushOpenAction[keyof typeof PushOpenAction];
@@ -0,0 +1,28 @@
1
+ /** The quality of the media file. */
2
+ export declare const MediaElementQuality: {
3
+ /** Any other file type not already defined. */
4
+ readonly Other: 0;
5
+ /** An audio file that contains no video. */
6
+ readonly Audio: 1;
7
+ /**
8
+ * The URL is actually an i-frame embed URL that will be
9
+ * used to play the video.
10
+ */
11
+ readonly Embed: 2;
12
+ /** Standard Definition video is defined as below 720p. */
13
+ readonly SD: 3;
14
+ /** High Definition video is defined as 720p or higher. */
15
+ readonly HD: 4;
16
+ /** Ultra High Definition video is defined as 4K or higher. */
17
+ readonly UltraHD: 5;
18
+ /**
19
+ * HTTP Live Streaming quality, this is for m3u8 streams that adapt
20
+ * to the user's available bandwidth to show the best quality
21
+ * available.
22
+ */
23
+ readonly HLS: 6;
24
+ };
25
+ /** The quality of the media file. */
26
+ export declare const MediaElementQualityDescription: Record<number, string>;
27
+ /** The quality of the media file. */
28
+ export type MediaElementQuality = typeof MediaElementQuality[keyof typeof MediaElementQuality];