@oneblink/apps-react 13.0.0-beta.1 → 13.0.0-beta.11

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 (123) hide show
  1. package/dist/OneBlinkFormBase.d.ts +23 -3
  2. package/dist/OneBlinkFormBase.js +351 -193
  3. package/dist/OneBlinkFormBase.js.map +1 -1
  4. package/dist/OneBlinkReadOnlyForm.d.ts +17 -7
  5. package/dist/OneBlinkReadOnlyForm.js +24 -8
  6. package/dist/OneBlinkReadOnlyForm.js.map +1 -1
  7. package/dist/apps/approvals-service.d.ts +2 -60
  8. package/dist/apps/approvals-service.js +1 -181
  9. package/dist/apps/approvals-service.js.map +1 -1
  10. package/dist/apps/services/api/submissions.d.ts +3 -2
  11. package/dist/apps/services/api/submissions.js +3 -6
  12. package/dist/apps/services/api/submissions.js.map +1 -1
  13. package/dist/apps/submission-service.d.ts +11 -5
  14. package/dist/apps/submission-service.js +9 -4
  15. package/dist/apps/submission-service.js.map +1 -1
  16. package/dist/components/renderer/LookupButton.d.ts +1 -2
  17. package/dist/components/renderer/LookupButton.js +7 -6
  18. package/dist/components/renderer/LookupButton.js.map +1 -1
  19. package/dist/components/renderer/LookupNotification.js +31 -24
  20. package/dist/components/renderer/LookupNotification.js.map +1 -1
  21. package/dist/components/renderer/OneBlinkFormElements.d.ts +5 -7
  22. package/dist/components/renderer/OneBlinkFormElements.js +10 -35
  23. package/dist/components/renderer/OneBlinkFormElements.js.map +1 -1
  24. package/dist/components/renderer/PageFormElements.js +8 -3
  25. package/dist/components/renderer/PageFormElements.js.map +1 -1
  26. package/dist/components/renderer/ReverseGeocode.js +6 -11
  27. package/dist/components/renderer/ReverseGeocode.js.map +1 -1
  28. package/dist/form-elements/FormElementABN.js +1 -1
  29. package/dist/form-elements/FormElementABN.js.map +1 -1
  30. package/dist/form-elements/FormElementBSB.js +1 -1
  31. package/dist/form-elements/FormElementBSB.js.map +1 -1
  32. package/dist/form-elements/FormElementBarcodeScanner.js +1 -1
  33. package/dist/form-elements/FormElementBarcodeScanner.js.map +1 -1
  34. package/dist/form-elements/FormElementCalculation.js +1 -0
  35. package/dist/form-elements/FormElementCalculation.js.map +1 -1
  36. package/dist/form-elements/FormElementCheckBoxes.js +1 -1
  37. package/dist/form-elements/FormElementCheckBoxes.js.map +1 -1
  38. package/dist/form-elements/FormElementDate.js +1 -1
  39. package/dist/form-elements/FormElementDate.js.map +1 -1
  40. package/dist/form-elements/FormElementDateTime.js +1 -1
  41. package/dist/form-elements/FormElementDateTime.js.map +1 -1
  42. package/dist/form-elements/FormElementEmail.js +1 -1
  43. package/dist/form-elements/FormElementEmail.js.map +1 -1
  44. package/dist/form-elements/FormElementForm.d.ts +8 -9
  45. package/dist/form-elements/FormElementForm.js +4 -3
  46. package/dist/form-elements/FormElementForm.js.map +1 -1
  47. package/dist/form-elements/FormElementLookupButton.js +4 -3
  48. package/dist/form-elements/FormElementLookupButton.js.map +1 -1
  49. package/dist/form-elements/FormElementNumber.js +1 -1
  50. package/dist/form-elements/FormElementNumber.js.map +1 -1
  51. package/dist/form-elements/FormElementRepeatableSet.d.ts +4 -4
  52. package/dist/form-elements/FormElementRepeatableSet.js +6 -4
  53. package/dist/form-elements/FormElementRepeatableSet.js.map +1 -1
  54. package/dist/form-elements/FormElementSection.d.ts +3 -3
  55. package/dist/form-elements/FormElementSection.js +2 -2
  56. package/dist/form-elements/FormElementSection.js.map +1 -1
  57. package/dist/form-elements/FormElementSelect.js +1 -1
  58. package/dist/form-elements/FormElementSelect.js.map +1 -1
  59. package/dist/form-elements/FormElementSummary.js +2 -0
  60. package/dist/form-elements/FormElementSummary.js.map +1 -1
  61. package/dist/form-elements/FormElementTelephone.js +1 -1
  62. package/dist/form-elements/FormElementTelephone.js.map +1 -1
  63. package/dist/form-elements/FormElementText.js +1 -1
  64. package/dist/form-elements/FormElementText.js.map +1 -1
  65. package/dist/form-elements/FormElementTextarea.js +1 -1
  66. package/dist/form-elements/FormElementTextarea.js.map +1 -1
  67. package/dist/form-elements/FormElementTime.js +1 -1
  68. package/dist/form-elements/FormElementTime.js.map +1 -1
  69. package/dist/hooks/useAreLookupsDisallowed.d.ts +2 -0
  70. package/dist/hooks/useAreLookupsDisallowed.js +12 -0
  71. package/dist/hooks/useAreLookupsDisallowed.js.map +1 -0
  72. package/dist/hooks/useEditableFormElementIds.d.ts +3 -0
  73. package/dist/hooks/useEditableFormElementIds.js +6 -0
  74. package/dist/hooks/useEditableFormElementIds.js.map +1 -0
  75. package/dist/hooks/useFormElementOptions.js +2 -0
  76. package/dist/hooks/useFormElementOptions.js.map +1 -1
  77. package/dist/hooks/useFormIsDirty.d.ts +56 -0
  78. package/dist/hooks/useFormIsDirty.js +121 -0
  79. package/dist/hooks/useFormIsDirty.js.map +1 -0
  80. package/dist/hooks/useFormSubmissionAttempt.d.ts +88 -0
  81. package/dist/hooks/useFormSubmissionAttempt.js +103 -0
  82. package/dist/hooks/useFormSubmissionAttempt.js.map +1 -0
  83. package/dist/hooks/useFormSubmissionAutoSaveState.d.ts +2 -9
  84. package/dist/hooks/useFormSubmissionAutoSaveState.js +4 -2
  85. package/dist/hooks/useFormSubmissionAutoSaveState.js.map +1 -1
  86. package/dist/hooks/useFormValidation.d.ts +1 -1
  87. package/dist/hooks/useFormValidation.js +2 -1
  88. package/dist/hooks/useFormValidation.js.map +1 -1
  89. package/dist/hooks/useInjectPages.d.ts +2 -1
  90. package/dist/hooks/useInjectPages.js.map +1 -1
  91. package/dist/hooks/useIsFormElementReadOnly.d.ts +2 -0
  92. package/dist/hooks/useIsFormElementReadOnly.js +13 -0
  93. package/dist/hooks/useIsFormElementReadOnly.js.map +1 -0
  94. package/dist/hooks/useLookupNotification.d.ts +23 -2
  95. package/dist/hooks/useLookupNotification.js +2 -1
  96. package/dist/hooks/useLookupNotification.js.map +1 -1
  97. package/dist/hooks/useLookups.d.ts +3 -3
  98. package/dist/hooks/useLookups.js +7 -4
  99. package/dist/hooks/useLookups.js.map +1 -1
  100. package/dist/index.d.ts +2 -0
  101. package/dist/index.js +2 -0
  102. package/dist/index.js.map +1 -1
  103. package/dist/services/form-validation/extensions.d.ts +2 -1
  104. package/dist/services/form-validation/extensions.js +2 -1
  105. package/dist/services/form-validation/extensions.js.map +1 -1
  106. package/dist/services/form-validation/validateSubmission.d.ts +2 -1
  107. package/dist/services/form-validation/validateSubmission.js +14 -9
  108. package/dist/services/form-validation/validateSubmission.js.map +1 -1
  109. package/dist/services/getFlowInstanceNodesWithMeta.d.ts +70 -0
  110. package/dist/services/getFlowInstanceNodesWithMeta.js +247 -0
  111. package/dist/services/getFlowInstanceNodesWithMeta.js.map +1 -0
  112. package/dist/types/form.d.ts +17 -3
  113. package/dist/types/form.js.map +1 -1
  114. package/dist/utils/read-only-form-elements.d.ts +37 -0
  115. package/dist/utils/read-only-form-elements.js +63 -0
  116. package/dist/utils/read-only-form-elements.js.map +1 -0
  117. package/package.json +4 -3
  118. package/dist/services/isElementReadOnlyForAudience.d.ts +0 -20
  119. package/dist/services/isElementReadOnlyForAudience.js +0 -46
  120. package/dist/services/isElementReadOnlyForAudience.js.map +0 -1
  121. package/dist/services/resolveFormElementReadOnly.d.ts +0 -10
  122. package/dist/services/resolveFormElementReadOnly.js +0 -17
  123. package/dist/services/resolveFormElementReadOnly.js.map +0 -1
@@ -1 +1 @@
1
- {"version":3,"file":"form.js","sourceRoot":"","sources":["../../src/types/form.ts"],"names":[],"mappings":"","sourcesContent":["import { FormTypes, SubmissionTypes, IntegrationTypes } from '@oneblink/types'\nimport { NewS3SubmissionData } from '@oneblink/types/typescript/submissions'\n\nexport {\n FormElementConditionallyShownElement,\n FormElementConditionallyShown,\n FormElementsConditionallyShown,\n} from '@oneblink/sdk-core/dist/conditionalLogicService'\n\nexport type FormElementKey = string\nexport type RepeatableSetEntryIndex = string\n\nexport type FormElementsValidation = Record<\n FormElementKey,\n FormElementValidation\n>\n\nexport type FormElementValidation =\n | undefined\n | string\n | {\n type: 'formElements'\n formElements: FormElementsValidation | undefined\n }\n | {\n type: 'repeatableSet'\n set: string | undefined\n entries: Record<\n RepeatableSetEntryIndex,\n FormElementsValidation | undefined\n >\n }\n\nexport type ExecutedLookups =\n | {\n [elementName: string]:\n | boolean\n | ExecutedLookups\n | ExecutedLookups[]\n | undefined\n }\n | undefined\n\nexport type ExecutedLookupValue = NonNullable<ExecutedLookups>[string]\n\ntype ValueChangeHandler<U extends Record<string, unknown>> = (\n element: FormTypes.FormElement,\n opts: U,\n idPrefix?: string,\n) => void\n\nexport type FormElementValueChangeHandler<T = unknown> = ValueChangeHandler<{\n value?: T | ((existingValue?: T) => T | undefined)\n}>\n\nexport type SectionState = NewS3SubmissionData['sectionState']\n\nexport type NestedFormElementValueChangeHandler<T = unknown> =\n ValueChangeHandler<{\n value?: T | ((existingValue?: T) => T | undefined)\n /**\n * The executed lookups to preserve when the nested element is changed,\n * setting to undefined indicate the lookup has not been executed.\n */\n executedLookups:\n | ExecutedLookupValue\n | ((currentExecutedLookups: ExecutedLookupValue) => ExecutedLookupValue)\n deleteSection?: boolean\n /**\n * The section state to preserve when the nested element is changed, setting\n * to undefined will not update the section state\n */\n sectionState:\n | SectionState\n | ((currentSectionState: SectionState) => SectionState)\n }>\n\nexport type FormElementLookupHandler = (\n setter: (data: {\n submission: SubmissionTypes.S3SubmissionData['submission']\n elements: FormTypes.FormElement[]\n lastElementUpdated: FormTypes.FormElement | undefined\n executedLookups: ExecutedLookups\n sectionState: SectionState | undefined\n }) => {\n submission: SubmissionTypes.S3SubmissionData['submission']\n elements: FormTypes.FormElement[]\n executedLookups: ExecutedLookups\n },\n) => void\n\nexport type UpdateFormElementsHandler = (\n setter: (element: FormTypes.FormElement[]) => FormTypes.FormElement[],\n) => void\n\nexport type SetFormSubmission = React.Dispatch<\n React.SetStateAction<{\n definition: FormTypes.Form\n submission: SubmissionTypes.S3SubmissionData['submission']\n lastElementUpdated: FormTypes.FormElement | undefined\n executedLookups: ExecutedLookups\n sectionState: SectionState | undefined\n }>\n>\n\nexport type IsDirtyProps = {\n isDirty: boolean\n setIsDirty: () => void\n}\n\nexport type CaptchaType = NonNullable<\n IntegrationTypes.IntegrationRecaptcha['configuration']['domains'][number]['type']\n>\n"]}
1
+ {"version":3,"file":"form.js","sourceRoot":"","sources":["../../src/types/form.ts"],"names":[],"mappings":"","sourcesContent":["import { FormTypes, SubmissionTypes, IntegrationTypes } from '@oneblink/types'\nimport { NewS3SubmissionData } from '@oneblink/types/typescript/submissions'\n\nexport {\n FormElementConditionallyShownElement,\n FormElementConditionallyShown,\n FormElementsConditionallyShown,\n} from '@oneblink/sdk-core/dist/conditionalLogicService'\n\nexport type FormElementKey = string\nexport type RepeatableSetEntryIndex = string\n\nexport type FormElementsValidation = Record<\n FormElementKey,\n FormElementValidation\n>\n\nexport type FormElementValidation =\n | undefined\n | string\n | {\n type: 'formElements'\n formElements: FormElementsValidation | undefined\n }\n | {\n type: 'repeatableSet'\n set: string | undefined\n entries: Record<\n RepeatableSetEntryIndex,\n FormElementsValidation | undefined\n >\n }\n\nexport type ExecutedLookups =\n | {\n [elementName: string]:\n | boolean\n | ExecutedLookups\n | ExecutedLookups[]\n | undefined\n }\n | undefined\n\nexport type ExecutedLookupValue = NonNullable<ExecutedLookups>[string]\n\ntype ValueChangeHandler<U extends Record<string, unknown>> = (\n element: FormTypes.FormElement,\n opts: U,\n idPrefix?: string,\n) => void\n\nexport type FormElementValueChangeHandler<T = unknown> = ValueChangeHandler<{\n value?: T | ((existingValue?: T) => T | undefined)\n /**\n * When true, the value is written without treating it as a user edit (no\n * unsaved-changes flag, last-element tracking, or auto-save).\n */\n isDerivedChange?: boolean\n}>\n\nexport type SectionState = NewS3SubmissionData['sectionState']\n\nexport type NestedFormElementValueChangeHandler<T = unknown> =\n ValueChangeHandler<{\n value?: T | ((existingValue?: T) => T | undefined)\n /**\n * The executed lookups to preserve when the nested element is changed,\n * setting to undefined indicate the lookup has not been executed.\n */\n executedLookups:\n | ExecutedLookupValue\n | ((currentExecutedLookups: ExecutedLookupValue) => ExecutedLookupValue)\n deleteSection?: boolean\n /**\n * The section state to preserve when the nested element is changed, setting\n * to undefined will not update the section state\n */\n sectionState:\n | SectionState\n | ((currentSectionState: SectionState) => SectionState)\n /**\n * When true, the value is written without treating it as a user edit (no\n * unsaved-changes flag, last-element tracking, or auto-save).\n */\n isDerivedChange?: boolean\n }>\n\nexport type SetFormSubmissionOptions = {\n isDerivedChange?: boolean\n}\n\nexport type FormElementLookupHandler = (\n setter: (data: {\n submission: SubmissionTypes.S3SubmissionData['submission']\n elements: FormTypes.FormElement[]\n lastElementUpdated: FormTypes.FormElement | undefined\n executedLookups: ExecutedLookups\n sectionState: SectionState | undefined\n }) => {\n submission: SubmissionTypes.S3SubmissionData['submission']\n elements: FormTypes.FormElement[]\n executedLookups: ExecutedLookups\n },\n options?: SetFormSubmissionOptions,\n) => void\n\nexport type UpdateFormElementsHandler = (\n setter: (element: FormTypes.FormElement[]) => FormTypes.FormElement[],\n) => void\n\nexport type FormSubmissionState = {\n definition: FormTypes.Form\n submission: SubmissionTypes.S3SubmissionData['submission']\n lastElementUpdated: FormTypes.FormElement | undefined\n executedLookups: ExecutedLookups\n sectionState: SectionState | undefined\n}\n\nexport type SetFormSubmission = (\n value: React.SetStateAction<FormSubmissionState>,\n options?: SetFormSubmissionOptions,\n) => void\n\nexport type IsDirtyProps = {\n isDirty: boolean\n setIsDirty: () => void\n}\n\nexport type CaptchaType = NonNullable<\n IntegrationTypes.IntegrationRecaptcha['configuration']['domains'][number]['type']\n>\n"]}
@@ -0,0 +1,37 @@
1
+ import { FormTypes } from '@oneblink/types';
2
+ type FormElementWithEditability = FormTypes.FormElement | FormTypes.LookupFormElement;
3
+ export declare function checkIsFormElementIdEditable(element: FormElementWithEditability, editableFormElementIds?: string[]): boolean;
4
+ /**
5
+ * Whether this element, or anything nested inside it, can be changed.
6
+ *
7
+ * When `editableFormElementIds` is omitted, every element is treated as
8
+ * editable. When it is provided, only listed ids and containers that wrap them
9
+ * are editable. Used to skip validating what the user has no way to correct.
10
+ */
11
+ export declare function checkIsFormElementEditable(element: FormElementWithEditability, editableFormElementIds?: string[]): boolean;
12
+ /**
13
+ * Whether a form element’s own controls should be locked.
14
+ *
15
+ * An id in `editableFormElementIds` always wins. When that list is provided,
16
+ * every other element is locked (whitelist). Otherwise the whole-form read-only
17
+ * flag and the element’s own `readOnly` apply.
18
+ */
19
+ export declare function checkIsFormElementReadOnly(element: FormElementWithEditability, { isFormReadOnly, isInheritedReadOnly, editableFormElementIds, }?: {
20
+ isFormReadOnly?: boolean;
21
+ isInheritedReadOnly?: boolean;
22
+ editableFormElementIds?: string[];
23
+ }): boolean;
24
+ /**
25
+ * Whether lookups (and reverse geocode) must not run for this element.
26
+ *
27
+ * Definition `readOnly` and inherited container locks still allow submitter
28
+ * lookups from prefills, defaults, and chained lookup buttons. Lookups are
29
+ * blocked on a read-only form, or when a whitelist is provided and this id is
30
+ * not on it (an approver must not re-run a lookup that could overwrite
31
+ * persisted answers). An id in the whitelist always wins.
32
+ */
33
+ export declare function checkAreLookupsDisallowed(element: FormElementWithEditability, { isFormReadOnly, editableFormElementIds, }?: {
34
+ isFormReadOnly?: boolean;
35
+ editableFormElementIds?: string[];
36
+ }): boolean;
37
+ export {};
@@ -0,0 +1,63 @@
1
+ export function checkIsFormElementIdEditable(element, editableFormElementIds) {
2
+ return (editableFormElementIds === null || editableFormElementIds === void 0 ? void 0 : editableFormElementIds.includes(element.id)) === true;
3
+ }
4
+ function checkHasEditableFormElement(elements, editableFormElementIds) {
5
+ return elements.some((element) => checkIsFormElementIdEditable(element, editableFormElementIds) ||
6
+ ('elements' in element &&
7
+ Array.isArray(element.elements) &&
8
+ checkHasEditableFormElement(element.elements, editableFormElementIds)));
9
+ }
10
+ /**
11
+ * Whether this element, or anything nested inside it, can be changed.
12
+ *
13
+ * When `editableFormElementIds` is omitted, every element is treated as
14
+ * editable. When it is provided, only listed ids and containers that wrap them
15
+ * are editable. Used to skip validating what the user has no way to correct.
16
+ */
17
+ export function checkIsFormElementEditable(element, editableFormElementIds) {
18
+ if (editableFormElementIds === undefined) {
19
+ return true;
20
+ }
21
+ return (checkIsFormElementIdEditable(element, editableFormElementIds) ||
22
+ ('elements' in element &&
23
+ Array.isArray(element.elements) &&
24
+ checkHasEditableFormElement(element.elements, editableFormElementIds)));
25
+ }
26
+ /**
27
+ * Whether a form element’s own controls should be locked.
28
+ *
29
+ * An id in `editableFormElementIds` always wins. When that list is provided,
30
+ * every other element is locked (whitelist). Otherwise the whole-form read-only
31
+ * flag and the element’s own `readOnly` apply.
32
+ */
33
+ export function checkIsFormElementReadOnly(element, { isFormReadOnly, isInheritedReadOnly, editableFormElementIds, } = {}) {
34
+ if (checkIsFormElementIdEditable(element, editableFormElementIds)) {
35
+ return false;
36
+ }
37
+ if (editableFormElementIds !== undefined) {
38
+ return true;
39
+ }
40
+ if (isFormReadOnly || isInheritedReadOnly) {
41
+ return true;
42
+ }
43
+ return 'readOnly' in element && element.readOnly === true;
44
+ }
45
+ /**
46
+ * Whether lookups (and reverse geocode) must not run for this element.
47
+ *
48
+ * Definition `readOnly` and inherited container locks still allow submitter
49
+ * lookups from prefills, defaults, and chained lookup buttons. Lookups are
50
+ * blocked on a read-only form, or when a whitelist is provided and this id is
51
+ * not on it (an approver must not re-run a lookup that could overwrite
52
+ * persisted answers). An id in the whitelist always wins.
53
+ */
54
+ export function checkAreLookupsDisallowed(element, { isFormReadOnly, editableFormElementIds, } = {}) {
55
+ if (checkIsFormElementIdEditable(element, editableFormElementIds)) {
56
+ return false;
57
+ }
58
+ if (editableFormElementIds !== undefined) {
59
+ return true;
60
+ }
61
+ return isFormReadOnly === true;
62
+ }
63
+ //# sourceMappingURL=read-only-form-elements.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"read-only-form-elements.js","sourceRoot":"","sources":["../../src/utils/read-only-form-elements.ts"],"names":[],"mappings":"AAMA,MAAM,UAAU,4BAA4B,CAC1C,OAAmC,EACnC,sBAAiC;IAEjC,OAAO,CAAA,sBAAsB,aAAtB,sBAAsB,uBAAtB,sBAAsB,CAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,MAAK,IAAI,CAAA;AAC9D,CAAC;AAED,SAAS,2BAA2B,CAClC,QAAiC,EACjC,sBAAiC;IAEjC,OAAO,QAAQ,CAAC,IAAI,CAClB,CAAC,OAAO,EAAE,EAAE,CACV,4BAA4B,CAAC,OAAO,EAAE,sBAAsB,CAAC;QAC7D,CAAC,UAAU,IAAI,OAAO;YACpB,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC;YAC/B,2BAA2B,CACzB,OAAO,CAAC,QAAQ,EAChB,sBAAsB,CACvB,CAAC,CACP,CAAA;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,0BAA0B,CACxC,OAAmC,EACnC,sBAAiC;IAEjC,IAAI,sBAAsB,KAAK,SAAS,EAAE,CAAC;QACzC,OAAO,IAAI,CAAA;IACb,CAAC;IAED,OAAO,CACL,4BAA4B,CAAC,OAAO,EAAE,sBAAsB,CAAC;QAC7D,CAAC,UAAU,IAAI,OAAO;YACpB,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC;YAC/B,2BAA2B,CAAC,OAAO,CAAC,QAAQ,EAAE,sBAAsB,CAAC,CAAC,CACzE,CAAA;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,0BAA0B,CACxC,OAAmC,EACnC,EACE,cAAc,EACd,mBAAmB,EACnB,sBAAsB,MAKpB,EAAE;IAEN,IAAI,4BAA4B,CAAC,OAAO,EAAE,sBAAsB,CAAC,EAAE,CAAC;QAClE,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,sBAAsB,KAAK,SAAS,EAAE,CAAC;QACzC,OAAO,IAAI,CAAA;IACb,CAAC;IAED,IAAI,cAAc,IAAI,mBAAmB,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAA;IACb,CAAC;IAED,OAAO,UAAU,IAAI,OAAO,IAAI,OAAO,CAAC,QAAQ,KAAK,IAAI,CAAA;AAC3D,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,yBAAyB,CACvC,OAAmC,EACnC,EACE,cAAc,EACd,sBAAsB,MAIpB,EAAE;IAEN,IAAI,4BAA4B,CAAC,OAAO,EAAE,sBAAsB,CAAC,EAAE,CAAC;QAClE,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,sBAAsB,KAAK,SAAS,EAAE,CAAC;QACzC,OAAO,IAAI,CAAA;IACb,CAAC;IAED,OAAO,cAAc,KAAK,IAAI,CAAA;AAChC,CAAC","sourcesContent":["import { FormTypes } from '@oneblink/types'\r\n\r\ntype FormElementWithEditability =\r\n | FormTypes.FormElement\r\n | FormTypes.LookupFormElement\r\n\r\nexport function checkIsFormElementIdEditable(\r\n element: FormElementWithEditability,\r\n editableFormElementIds?: string[],\r\n): boolean {\r\n return editableFormElementIds?.includes(element.id) === true\r\n}\r\n\r\nfunction checkHasEditableFormElement(\r\n elements: FormTypes.FormElement[],\r\n editableFormElementIds?: string[],\r\n): boolean {\r\n return elements.some(\r\n (element) =>\r\n checkIsFormElementIdEditable(element, editableFormElementIds) ||\r\n ('elements' in element &&\r\n Array.isArray(element.elements) &&\r\n checkHasEditableFormElement(\r\n element.elements,\r\n editableFormElementIds,\r\n )),\r\n )\r\n}\r\n\r\n/**\r\n * Whether this element, or anything nested inside it, can be changed.\r\n *\r\n * When `editableFormElementIds` is omitted, every element is treated as\r\n * editable. When it is provided, only listed ids and containers that wrap them\r\n * are editable. Used to skip validating what the user has no way to correct.\r\n */\r\nexport function checkIsFormElementEditable(\r\n element: FormElementWithEditability,\r\n editableFormElementIds?: string[],\r\n): boolean {\r\n if (editableFormElementIds === undefined) {\r\n return true\r\n }\r\n\r\n return (\r\n checkIsFormElementIdEditable(element, editableFormElementIds) ||\r\n ('elements' in element &&\r\n Array.isArray(element.elements) &&\r\n checkHasEditableFormElement(element.elements, editableFormElementIds))\r\n )\r\n}\r\n\r\n/**\r\n * Whether a form element’s own controls should be locked.\r\n *\r\n * An id in `editableFormElementIds` always wins. When that list is provided,\r\n * every other element is locked (whitelist). Otherwise the whole-form read-only\r\n * flag and the element’s own `readOnly` apply.\r\n */\r\nexport function checkIsFormElementReadOnly(\r\n element: FormElementWithEditability,\r\n {\r\n isFormReadOnly,\r\n isInheritedReadOnly,\r\n editableFormElementIds,\r\n }: {\r\n isFormReadOnly?: boolean\r\n isInheritedReadOnly?: boolean\r\n editableFormElementIds?: string[]\r\n } = {},\r\n): boolean {\r\n if (checkIsFormElementIdEditable(element, editableFormElementIds)) {\r\n return false\r\n }\r\n\r\n if (editableFormElementIds !== undefined) {\r\n return true\r\n }\r\n\r\n if (isFormReadOnly || isInheritedReadOnly) {\r\n return true\r\n }\r\n\r\n return 'readOnly' in element && element.readOnly === true\r\n}\r\n\r\n/**\r\n * Whether lookups (and reverse geocode) must not run for this element.\r\n *\r\n * Definition `readOnly` and inherited container locks still allow submitter\r\n * lookups from prefills, defaults, and chained lookup buttons. Lookups are\r\n * blocked on a read-only form, or when a whitelist is provided and this id is\r\n * not on it (an approver must not re-run a lookup that could overwrite\r\n * persisted answers). An id in the whitelist always wins.\r\n */\r\nexport function checkAreLookupsDisallowed(\r\n element: FormElementWithEditability,\r\n {\r\n isFormReadOnly,\r\n editableFormElementIds,\r\n }: {\r\n isFormReadOnly?: boolean\r\n editableFormElementIds?: string[]\r\n } = {},\r\n): boolean {\r\n if (checkIsFormElementIdEditable(element, editableFormElementIds)) {\r\n return false\r\n }\r\n\r\n if (editableFormElementIds !== undefined) {\r\n return true\r\n }\r\n\r\n return isFormReadOnly === true\r\n}\r\n"]}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@oneblink/apps-react",
3
3
  "description": "Helper functions for OneBlink apps in ReactJS.",
4
- "version": "13.0.0-beta.1",
4
+ "version": "13.0.0-beta.11",
5
5
  "author": "OneBlink <developers@oneblink.io> (https://oneblink.io)",
6
6
  "bugs": {
7
7
  "url": "https://github.com/oneblink/apps-react/issues"
@@ -13,7 +13,7 @@
13
13
  "@emotion/styled": "^11.14.1",
14
14
  "@nylas/react": "^3.1.2",
15
15
  "@oneblink/sdk-core": "^10.1.0-beta.9",
16
- "@oneblink/storage": "^9.0.0-beta.1",
16
+ "@oneblink/storage": "^9.0.0-beta.4",
17
17
  "@react-google-maps/api": "^2.20.8",
18
18
  "@react-input/mask": "^2.0.4",
19
19
  "@sentry/browser": "^10.38.0",
@@ -68,6 +68,7 @@
68
68
  "@types/lodash.orderby": "^4.6.9",
69
69
  "@types/lodash.throttle": "^4.1.9",
70
70
  "@types/react": "^19.2.13",
71
+ "@types/react-dom": "^19.2.5",
71
72
  "@types/react-google-recaptcha": "^2.1.9",
72
73
  "@types/react-router-dom": "^5.3.3",
73
74
  "@types/react-signature-canvas": "^1.0.7",
@@ -140,6 +141,6 @@
140
141
  "test": "vitest",
141
142
  "types": "npm i -D github:oneblink/types",
142
143
  "typescript": "tsc --noEmit",
143
- "update-dependents": "oneblink-release update-dependents --force"
144
+ "update-dependents": "oneblink-release update-dependents --force-update-dependency"
144
145
  }
145
146
  }
@@ -1,20 +0,0 @@
1
- import { FormTypes } from '@oneblink/types';
2
- type ElementWithEditability = FormTypes.FormElement | FormTypes.LookupFormElement;
3
- export declare function isApproverEditable(element: ElementWithEditability): boolean;
4
- /**
5
- * Whether an audience can change this element or anything nested inside it.
6
- *
7
- * Approvers may only edit elements configured for approver editing, so a
8
- * subtree containing none of them is entirely locked for them. Used to skip
9
- * validating what an audience has no way to correct.
10
- */
11
- export declare function isElementEditableForAudience(element: ElementWithEditability, audience: FormTypes.FormElementHiddenFromAudience): boolean;
12
- /**
13
- * Determine whether a form element should be read only for a given audience.
14
- *
15
- * Approvers may only edit elements explicitly configured for approver editing,
16
- * so every other input is locked. Nested form and info page elements stay
17
- * interactive while they contain an approver editable element.
18
- */
19
- export default function isElementReadOnlyForAudience(element: ElementWithEditability, audience: FormTypes.FormElementHiddenFromAudience): boolean;
20
- export {};
@@ -1,46 +0,0 @@
1
- export function isApproverEditable(element) {
2
- var _a;
3
- return ('approverEditability' in element &&
4
- ((_a = element.approverEditability) === null || _a === void 0 ? void 0 : _a.type) === 'ALL_STEPS');
5
- }
6
- function hasApproverEditableElement(elements) {
7
- return elements.some((element) => isApproverEditable(element) ||
8
- ('elements' in element &&
9
- Array.isArray(element.elements) &&
10
- hasApproverEditableElement(element.elements)));
11
- }
12
- /**
13
- * Whether an audience can change this element or anything nested inside it.
14
- *
15
- * Approvers may only edit elements configured for approver editing, so a
16
- * subtree containing none of them is entirely locked for them. Used to skip
17
- * validating what an audience has no way to correct.
18
- */
19
- export function isElementEditableForAudience(element, audience) {
20
- if (audience !== 'APPROVER') {
21
- return true;
22
- }
23
- return (isApproverEditable(element) ||
24
- ('elements' in element &&
25
- Array.isArray(element.elements) &&
26
- hasApproverEditableElement(element.elements)));
27
- }
28
- /**
29
- * Determine whether a form element should be read only for a given audience.
30
- *
31
- * Approvers may only edit elements explicitly configured for approver editing,
32
- * so every other input is locked. Nested form and info page elements stay
33
- * interactive while they contain an approver editable element.
34
- */
35
- export default function isElementReadOnlyForAudience(element, audience) {
36
- if (audience !== 'APPROVER') {
37
- return false;
38
- }
39
- if ('type' in element &&
40
- (element.type === 'form' || element.type === 'infoPage')) {
41
- return (!isApproverEditable(element) &&
42
- !hasApproverEditableElement(element.elements || []));
43
- }
44
- return !isApproverEditable(element);
45
- }
46
- //# sourceMappingURL=isElementReadOnlyForAudience.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"isElementReadOnlyForAudience.js","sourceRoot":"","sources":["../../src/services/isElementReadOnlyForAudience.ts"],"names":[],"mappings":"AAMA,MAAM,UAAU,kBAAkB,CAAC,OAA+B;;IAChE,OAAO,CACL,qBAAqB,IAAI,OAAO;QAChC,CAAA,MAAA,OAAO,CAAC,mBAAmB,0CAAE,IAAI,MAAK,WAAW,CAClD,CAAA;AACH,CAAC;AAED,SAAS,0BAA0B,CACjC,QAAiC;IAEjC,OAAO,QAAQ,CAAC,IAAI,CAClB,CAAC,OAAO,EAAE,EAAE,CACV,kBAAkB,CAAC,OAAO,CAAC;QAC3B,CAAC,UAAU,IAAI,OAAO;YACpB,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC;YAC/B,0BAA0B,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAClD,CAAA;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,4BAA4B,CAC1C,OAA+B,EAC/B,QAAiD;IAEjD,IAAI,QAAQ,KAAK,UAAU,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAA;IACb,CAAC;IAED,OAAO,CACL,kBAAkB,CAAC,OAAO,CAAC;QAC3B,CAAC,UAAU,IAAI,OAAO;YACpB,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC;YAC/B,0BAA0B,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAChD,CAAA;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,4BAA4B,CAClD,OAA+B,EAC/B,QAAiD;IAEjD,IAAI,QAAQ,KAAK,UAAU,EAAE,CAAC;QAC5B,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IACE,MAAM,IAAI,OAAO;QACjB,CAAC,OAAO,CAAC,IAAI,KAAK,MAAM,IAAI,OAAO,CAAC,IAAI,KAAK,UAAU,CAAC,EACxD,CAAC;QACD,OAAO,CACL,CAAC,kBAAkB,CAAC,OAAO,CAAC;YAC5B,CAAC,0BAA0B,CAAC,OAAO,CAAC,QAAQ,IAAI,EAAE,CAAC,CACpD,CAAA;IACH,CAAC;IAED,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAA;AACrC,CAAC","sourcesContent":["import { FormTypes } from '@oneblink/types'\r\n\r\ntype ElementWithEditability =\r\n | FormTypes.FormElement\r\n | FormTypes.LookupFormElement\r\n\r\nexport function isApproverEditable(element: ElementWithEditability): boolean {\r\n return (\r\n 'approverEditability' in element &&\r\n element.approverEditability?.type === 'ALL_STEPS'\r\n )\r\n}\r\n\r\nfunction hasApproverEditableElement(\r\n elements: FormTypes.FormElement[],\r\n): boolean {\r\n return elements.some(\r\n (element) =>\r\n isApproverEditable(element) ||\r\n ('elements' in element &&\r\n Array.isArray(element.elements) &&\r\n hasApproverEditableElement(element.elements)),\r\n )\r\n}\r\n\r\n/**\r\n * Whether an audience can change this element or anything nested inside it.\r\n *\r\n * Approvers may only edit elements configured for approver editing, so a\r\n * subtree containing none of them is entirely locked for them. Used to skip\r\n * validating what an audience has no way to correct.\r\n */\r\nexport function isElementEditableForAudience(\r\n element: ElementWithEditability,\r\n audience: FormTypes.FormElementHiddenFromAudience,\r\n): boolean {\r\n if (audience !== 'APPROVER') {\r\n return true\r\n }\r\n\r\n return (\r\n isApproverEditable(element) ||\r\n ('elements' in element &&\r\n Array.isArray(element.elements) &&\r\n hasApproverEditableElement(element.elements))\r\n )\r\n}\r\n\r\n/**\r\n * Determine whether a form element should be read only for a given audience.\r\n *\r\n * Approvers may only edit elements explicitly configured for approver editing,\r\n * so every other input is locked. Nested form and info page elements stay\r\n * interactive while they contain an approver editable element.\r\n */\r\nexport default function isElementReadOnlyForAudience(\r\n element: ElementWithEditability,\r\n audience: FormTypes.FormElementHiddenFromAudience,\r\n): boolean {\r\n if (audience !== 'APPROVER') {\r\n return false\r\n }\r\n\r\n if (\r\n 'type' in element &&\r\n (element.type === 'form' || element.type === 'infoPage')\r\n ) {\r\n return (\r\n !isApproverEditable(element) &&\r\n !hasApproverEditableElement(element.elements || [])\r\n )\r\n }\r\n\r\n return !isApproverEditable(element)\r\n}\r\n"]}
@@ -1,10 +0,0 @@
1
- import { FormTypes } from '@oneblink/types';
2
- /**
3
- * Whether a form element’s own controls should be locked for a given audience.
4
- *
5
- * `approverEditability` wins over the element’s `readOnly` flag for approvers,
6
- * so a field can be locked for submitters and still editable during review.
7
- * Whole-form read-only (`useFormIsReadOnly`) is applied by the renderer, not
8
- * here.
9
- */
10
- export default function resolveFormElementReadOnly(element: FormTypes.FormElement, audience: FormTypes.FormElementHiddenFromAudience): boolean;
@@ -1,17 +0,0 @@
1
- import isElementReadOnlyForAudience, { isApproverEditable, } from './isElementReadOnlyForAudience';
2
- /**
3
- * Whether a form element’s own controls should be locked for a given audience.
4
- *
5
- * `approverEditability` wins over the element’s `readOnly` flag for approvers,
6
- * so a field can be locked for submitters and still editable during review.
7
- * Whole-form read-only (`useFormIsReadOnly`) is applied by the renderer, not
8
- * here.
9
- */
10
- export default function resolveFormElementReadOnly(element, audience) {
11
- if (audience === 'APPROVER' && isApproverEditable(element)) {
12
- return false;
13
- }
14
- return (('readOnly' in element && element.readOnly === true) ||
15
- isElementReadOnlyForAudience(element, audience));
16
- }
17
- //# sourceMappingURL=resolveFormElementReadOnly.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"resolveFormElementReadOnly.js","sourceRoot":"","sources":["../../src/services/resolveFormElementReadOnly.ts"],"names":[],"mappings":"AACA,OAAO,4BAA4B,EAAE,EACnC,kBAAkB,GACnB,MAAM,gCAAgC,CAAA;AAEvC;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,UAAU,0BAA0B,CAChD,OAA8B,EAC9B,QAAiD;IAEjD,IAAI,QAAQ,KAAK,UAAU,IAAI,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAAC;QAC3D,OAAO,KAAK,CAAA;IACd,CAAC;IAED,OAAO,CACL,CAAC,UAAU,IAAI,OAAO,IAAI,OAAO,CAAC,QAAQ,KAAK,IAAI,CAAC;QACpD,4BAA4B,CAAC,OAAO,EAAE,QAAQ,CAAC,CAChD,CAAA;AACH,CAAC","sourcesContent":["import { FormTypes } from '@oneblink/types'\nimport isElementReadOnlyForAudience, {\n isApproverEditable,\n} from './isElementReadOnlyForAudience'\n\n/**\n * Whether a form element’s own controls should be locked for a given audience.\n *\n * `approverEditability` wins over the element’s `readOnly` flag for approvers,\n * so a field can be locked for submitters and still editable during review.\n * Whole-form read-only (`useFormIsReadOnly`) is applied by the renderer, not\n * here.\n */\nexport default function resolveFormElementReadOnly(\n element: FormTypes.FormElement,\n audience: FormTypes.FormElementHiddenFromAudience,\n): boolean {\n if (audience === 'APPROVER' && isApproverEditable(element)) {\n return false\n }\n\n return (\n ('readOnly' in element && element.readOnly === true) ||\n isElementReadOnlyForAudience(element, audience)\n )\n}\n"]}