@oneblink/apps-react 12.0.0 → 13.0.0-beta.10

package/dist/utils/read-only-form-elements.d.ts

@@ -0,0 +1,37 @@
+import { FormTypes } from '@oneblink/types';
+type FormElementWithEditability = FormTypes.FormElement | FormTypes.LookupFormElement;
+export declare function checkIsFormElementIdEditable(element: FormElementWithEditability, editableFormElementIds?: string[]): boolean;
+/**
+ * Whether this element, or anything nested inside it, can be changed.
+ *
+ * When `editableFormElementIds` is omitted, every element is treated as
+ * editable. When it is provided, only listed ids and containers that wrap them
+ * are editable. Used to skip validating what the user has no way to correct.
+ */
+export declare function checkIsFormElementEditable(element: FormElementWithEditability, editableFormElementIds?: string[]): boolean;
+/**
+ * Whether a form element’s own controls should be locked.
+ *
+ * An id in `editableFormElementIds` always wins. When that list is provided,
+ * every other element is locked (whitelist). Otherwise the whole-form read-only
+ * flag and the element’s own `readOnly` apply.
+ */
+export declare function checkIsFormElementReadOnly(element: FormElementWithEditability, { isFormReadOnly, isInheritedReadOnly, editableFormElementIds, }?: {
+    isFormReadOnly?: boolean;
+    isInheritedReadOnly?: boolean;
+    editableFormElementIds?: string[];
+}): boolean;
+/**
+ * Whether lookups (and reverse geocode) must not run for this element.
+ *
+ * Definition `readOnly` and inherited container locks still allow submitter
+ * lookups from prefills, defaults, and chained lookup buttons. Lookups are
+ * blocked on a read-only form, or when a whitelist is provided and this id is
+ * not on it (an approver must not re-run a lookup that could overwrite
+ * persisted answers). An id in the whitelist always wins.
+ */
+export declare function checkAreLookupsDisallowed(element: FormElementWithEditability, { isFormReadOnly, editableFormElementIds, }?: {
+    isFormReadOnly?: boolean;
+    editableFormElementIds?: string[];
+}): boolean;
+export {};

package/dist/utils/read-only-form-elements.js

@@ -0,0 +1,63 @@
+export function checkIsFormElementIdEditable(element, editableFormElementIds) {
+    return (editableFormElementIds === null || editableFormElementIds === void 0 ? void 0 : editableFormElementIds.includes(element.id)) === true;
+}
+function checkHasEditableFormElement(elements, editableFormElementIds) {
+    return elements.some((element) => checkIsFormElementIdEditable(element, editableFormElementIds) ||
+        ('elements' in element &&
+            Array.isArray(element.elements) &&
+            checkHasEditableFormElement(element.elements, editableFormElementIds)));
+}
+/**
+ * Whether this element, or anything nested inside it, can be changed.
+ *
+ * When `editableFormElementIds` is omitted, every element is treated as
+ * editable. When it is provided, only listed ids and containers that wrap them
+ * are editable. Used to skip validating what the user has no way to correct.
+ */
+export function checkIsFormElementEditable(element, editableFormElementIds) {
+    if (editableFormElementIds === undefined) {
+        return true;
+    }
+    return (checkIsFormElementIdEditable(element, editableFormElementIds) ||
+        ('elements' in element &&
+            Array.isArray(element.elements) &&
+            checkHasEditableFormElement(element.elements, editableFormElementIds)));
+}
+/**
+ * Whether a form element’s own controls should be locked.
+ *
+ * An id in `editableFormElementIds` always wins. When that list is provided,
+ * every other element is locked (whitelist). Otherwise the whole-form read-only
+ * flag and the element’s own `readOnly` apply.
+ */
+export function checkIsFormElementReadOnly(element, { isFormReadOnly, isInheritedReadOnly, editableFormElementIds, } = {}) {
+    if (checkIsFormElementIdEditable(element, editableFormElementIds)) {
+        return false;
+    }
+    if (editableFormElementIds !== undefined) {
+        return true;
+    }
+    if (isFormReadOnly || isInheritedReadOnly) {
+        return true;
+    }
+    return 'readOnly' in element && element.readOnly === true;
+}
+/**
+ * Whether lookups (and reverse geocode) must not run for this element.
+ *
+ * Definition `readOnly` and inherited container locks still allow submitter
+ * lookups from prefills, defaults, and chained lookup buttons. Lookups are
+ * blocked on a read-only form, or when a whitelist is provided and this id is
+ * not on it (an approver must not re-run a lookup that could overwrite
+ * persisted answers). An id in the whitelist always wins.
+ */
+export function checkAreLookupsDisallowed(element, { isFormReadOnly, editableFormElementIds, } = {}) {
+    if (checkIsFormElementIdEditable(element, editableFormElementIds)) {
+        return false;
+    }
+    if (editableFormElementIds !== undefined) {
+        return true;
+    }
+    return isFormReadOnly === true;
+}
+//# sourceMappingURL=read-only-form-elements.js.map

package/dist/utils/read-only-form-elements.js.map

@@ -0,0 +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

@@ -1,7 +1,7 @@
 {
   "name": "@oneblink/apps-react",
   "description": "Helper functions for OneBlink apps in ReactJS.",
-  "version": "12.0.0",
+  "version": "13.0.0-beta.10",
   "author": "OneBlink <developers@oneblink.io> (https://oneblink.io)",
   "bugs": {
     "url": "https://github.com/oneblink/apps-react/issues"
@@ -13,7 +13,7 @@
     "@emotion/styled": "^11.14.1",
     "@nylas/react": "^3.1.2",
     "@oneblink/sdk-core": "^10.1.0-beta.9",
-    "@oneblink/storage": "^8.0.0-beta.2",
+    "@oneblink/storage": "^9.0.0-beta.4",
     "@react-google-maps/api": "^2.20.8",
     "@react-input/mask": "^2.0.4",
     "@sentry/browser": "^10.38.0",
@@ -68,6 +68,7 @@
     "@types/lodash.orderby": "^4.6.9",
     "@types/lodash.throttle": "^4.1.9",
     "@types/react": "^19.2.13",
+    "@types/react-dom": "^19.2.5",
     "@types/react-google-recaptcha": "^2.1.9",
     "@types/react-router-dom": "^5.3.3",
     "@types/react-signature-canvas": "^1.0.7",
@@ -140,6 +141,6 @@
     "test": "vitest",
     "types": "npm i -D github:oneblink/types",
     "typescript": "tsc --noEmit",
-    "update-dependents": "oneblink-release update-dependents --force"
+    "update-dependents": "oneblink-release update-dependents --force-update-dependency"
   }
 }