@oracle/oraclejet-core-pack 17.0.4 → 17.1.0

package/oj-c/FormControlWrapper/FormControlWrapper.js

@@ -0,0 +1,54 @@
+define(["require", "exports", "preact/jsx-runtime", "preact/hooks", "@oracle/oraclejet-preact/hooks/UNSAFE_useFormContext", "ojs/ojvcomponent", "@oracle/oraclejet-preact/UNSAFE_UserAssistance", "@oracle/oraclejet-preact/UNSAFE_Label", "@oracle/oraclejet-preact/UNSAFE_LabelValueLayout", "oj-c/hooks/UNSAFE_useEditableValue/index", "oj-c/hooks/UNSAFE_useMergedFormContext/useMergedFormContext"], function (require, exports, jsx_runtime_1, hooks_1, UNSAFE_useFormContext_1, ojvcomponent_1, UNSAFE_UserAssistance_1, UNSAFE_Label_1, UNSAFE_LabelValueLayout_1, index_1, useMergedFormContext_1) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.FormControlWrapper = void 0;
+    const messagesDefault = [];
+    const displayOptions = {
+        messages: 'display'
+    };
+    function FormControlWrapper({ children, containerReadonly: propContainerReadonly, deferredValidators, disabled = false, labelHint, labelEdge: propLabelEdge, labelStartWidth: propLabelStartWidth, labelWrapping: propLabelWrapping, messagesCustom = messagesDefault, onLabelClick, onMessagesCustomChanged, onValidChanged, onValueChanged, readonly: propReadonly, required = false, userAssistanceDensity: propUserAssistanceDensity, value: propValue }) {
+        const uniqueId = (0, hooks_1.useRef)((0, ojvcomponent_1.getUniqueId)());
+        const labelId = `formControlWrapper-label-${uniqueId.current}`;
+        const userAssistanceId = `formControlWrapper-ua-${uniqueId.current}`;
+        const { containerProps, uadValue, readonlyValue: readonly } = (0, useMergedFormContext_1.useMergedFormContext)({
+            propContainerReadonly,
+            propLabelWrapping,
+            propReadonly,
+            propUserAssistanceDensity
+        });
+        const { methods: editableValueMethods, textFieldProps, value } = (0, index_1.useEditableValue)({
+            defaultDisplayValue: undefined,
+            deferredValidators,
+            disabled,
+            displayOptions,
+            messagesCustom,
+            onMessagesCustomChanged,
+            onValidChanged,
+            onValueChanged,
+            readonly,
+            value: propValue
+        });
+        const { messages, onCommit } = textFieldProps;
+        const { labelEdge: formLabelEdge, labelStartWidth: formLabelStartWidth } = containerProps;
+        const labelEdge = propLabelEdge ?? formLabelEdge;
+        const labelStartWidth = propLabelStartWidth ?? formLabelStartWidth;
+        const userAssistanceDensity = uadValue !== 'compact' ? uadValue : 'reflow';
+        const hasNoValue = value === null ||
+            value === undefined ||
+            (typeof value === 'string' && value === '') ||
+            (Array.isArray(value) && value.length === 0);
+        const requiredShown = required && hasNoValue;
+        const inlineUserAssistance = disabled || readonly ? (userAssistanceDensity !== 'efficient' ? undefined : ((0, jsx_runtime_1.jsx)(UNSAFE_UserAssistance_1.InlineUserAssistance, { id: userAssistanceId, userAssistanceDensity: userAssistanceDensity }))) : ((0, jsx_runtime_1.jsx)(UNSAFE_UserAssistance_1.InlineUserAssistance, { fieldLabel: labelHint, id: userAssistanceId, messages: messages, isRequiredShown: requiredShown, userAssistanceDensity: userAssistanceDensity }));
+        const { showMessages, validate } = editableValueMethods;
+        const rendererContext = {
+            isReadonly: readonly,
+            labelId,
+            userAssistanceId,
+            onCommit,
+            showMessages,
+            validate
+        };
+        return ((0, jsx_runtime_1.jsx)(UNSAFE_useFormContext_1.FormContext.Provider, { value: containerProps, children: (0, jsx_runtime_1.jsxs)(UNSAFE_LabelValueLayout_1.LabelValueLayout, { hasTopUserAssistance: false, label: (0, jsx_runtime_1.jsx)(UNSAFE_Label_1.Label, { id: labelId, isRequiredShown: requiredShown, onClick: onLabelClick, parentComponentVariant: "formComponentWrapper", userAssistanceDensity: userAssistanceDensity, variant: labelEdge, children: labelHint }), labelEdge: labelEdge, labelStartWidth: labelStartWidth, parentComponentVariant: "formComponentWrapper", children: [children(rendererContext), inlineUserAssistance] }) }));
+    }
+    exports.FormControlWrapper = FormControlWrapper;
+});

package/oj-c/FormControlWrapper/index.js

@@ -0,0 +1,6 @@
+define(["require", "exports", "./FormControlWrapper"], function (require, exports, FormControlWrapper_1) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.FormControlWrapper = void 0;
+    Object.defineProperty(exports, "FormControlWrapper", { enumerable: true, get: function () { return FormControlWrapper_1.FormControlWrapper; } });
+});

package/oj-c/InputDateMask.json

@@ -158,7 +158,7 @@
     "tstype": [
       {
         "target": "Type",
-        "value": "oj-c.InputDateMask.DisplayOptions",
+        "value": "oj-c.InputDateMask.DisplayOptionsProps",
         "jsdocOverride": true
       }
     ]
@@ -607,7 +607,18 @@
       "names": [
         "Array<object>|null"
       ]
-    }
+    },
+    "tstype": [
+      {
+        "target": "Type",
+        "value": "Array<AsyncValidator<string>|Validator<string>>|null",
+        "jsdocOverride": true,
+        "module": {
+          "AsyncValidator": "ojvalidator-async",
+          "Validator": "ojvalidator"
+        }
+      }
+    ]
   },
   {
     "memberof": "oj-c.InputDateMask",
@@ -957,10 +968,10 @@
   },
   {
     "memberof": "oj-c.InputDateMask",
-    "id": "oj-c.InputDateMask.DisplayOptions",
-    "name": "DisplayOptions",
+    "id": "oj-c.InputDateMask.DisplayOptionsProps",
+    "name": "DisplayOptionsProps",
     "kind": "typedef",
-    "longname": "oj-c.InputDateMask.DisplayOptions",
+    "longname": "oj-c.InputDateMask.DisplayOptionsProps",
     "scope": "static",
     "description": "Display options for auxiliary content that determines whether or not it should be displayed.",
     "type": {

package/oj-c/InputDatePicker.json

@@ -30,8 +30,11 @@
     "since": "17.0.0",
     "tsdeprecated": [
       {
-        "type": "candidate",
-        "since": "17.0.0"
+        "type": "supersedes",
+        "since": "17.1.0",
+        "value": [
+          "oj-input-date"
+        ]
       }
     ],
     "meta": {
@@ -100,7 +103,7 @@
     "tstype": [
       {
         "target": "Type",
-        "value": "(p: OverflowMessageDetailParameters) => string",
+        "value": "(p: oj-c.InputDatePicker.OverflowMessageDetailParameters) => string",
         "jsdocOverride": true
       }
     ]
@@ -126,7 +129,7 @@
     "tstype": [
       {
         "target": "Type",
-        "value": "(p: UnderflowMessageDetailParameters) => string",
+        "value": "(p: oj-c.InputDatePicker.UnderflowMessageDetailParameters) => string",
         "jsdocOverride": true
       }
     ]
@@ -152,7 +155,7 @@
     "tstype": [
       {
         "target": "Type",
-        "value": "(p: RestrictionMessageDetailParameters) => string",
+        "value": "(p: oj-c.InputDatePicker.RestrictionMessageDetailParameters) => string",
         "jsdocOverride": true
       }
     ]
@@ -178,7 +181,7 @@
     "tstype": [
       {
         "target": "Type",
-        "value": "(date: Required<CalendarDate>) => { state: \"disabled\" | \"enabled\" | \"restricted\"; }",
+        "value": "(date: Required<oj-c.InputDatePicker.CalendarDate>) => { state: \"disabled\" | \"enabled\" | \"restricted\"; }",
         "jsdocOverride": true
       }
     ]
@@ -267,7 +270,7 @@
     "tstype": [
       {
         "target": "Type",
-        "value": "oj-c.InputDatePicker.DisplayOptions",
+        "value": "oj-c.InputDatePicker.DisplayOptionsProps",
         "jsdocOverride": true
       }
     ]
@@ -821,7 +824,18 @@
       "names": [
         "Array<object>|null"
       ]
-    }
+    },
+    "tstype": [
+      {
+        "target": "Type",
+        "value": "Array<AsyncValidator<string>|Validator<string>>|null",
+        "jsdocOverride": true,
+        "module": {
+          "AsyncValidator": "ojvalidator-async",
+          "Validator": "ojvalidator"
+        }
+      }
+    ]
   },
   {
     "memberof": "oj-c.InputDatePicker",
@@ -844,6 +858,49 @@
       ]
     }
   },
+  {
+    "memberof": "oj-c.InputDatePicker",
+    "id": "oj-c.InputDatePicker#weekDisplay",
+    "name": "weekDisplay",
+    "kind": "member",
+    "longname": "oj-c.InputDatePicker#weekDisplay",
+    "optional": true,
+    "scope": "instance",
+    "description": "Whether week of the year will be shown in the DatePicker. The default calculation follows the\nrule for ISO 8601 as follows: The first week of the year is defined as the week that contains\nthe first Thursday. Therefore, if January 1st falls on a Friday, it is considered part of the last week\nof the previous year. Conversely, if December 31st falls on a Wednesday, it is part of week 1 of the following year.",
+    "meta": {
+      "filename": "input-date-picker.tsx",
+      "path": "web/components/oj-c/input-date-picker"
+    },
+    "ojvalues": [
+      {
+        "name": "none",
+        "description": "The week of the year column will not be shown.",
+        "displayName": "None",
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      },
+      {
+        "name": "number",
+        "description": "Will show the week of the year as a number.",
+        "displayName": "Number",
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      }
+    ],
+    "defaultvalue": "\"none\"",
+    "type": {
+      "names": [
+        "\"number\"",
+        "\"none\""
+      ]
+    }
+  },
   {
     "memberof": "oj-c.InputDatePicker",
     "id": "oj-c.InputDatePicker#rawValue",
@@ -1292,10 +1349,57 @@
   },
   {
     "memberof": "oj-c.InputDatePicker",
-    "id": "oj-c.InputDatePicker.DisplayOptions",
-    "name": "DisplayOptions",
+    "id": "oj-c.InputDatePicker.CalendarDate",
+    "name": "CalendarDate",
+    "kind": "typedef",
+    "longname": "oj-c.InputDatePicker.CalendarDate",
+    "scope": "static",
+    "description": "",
+    "type": {
+      "names": [
+        "Object"
+      ]
+    },
+    "meta": {
+      "filename": "input-date-picker.tsx",
+      "path": "web/components/oj-c/input-date-picker"
+    },
+    "properties": [
+      {
+        "name": "year",
+        "optional": true,
+        "type": {
+          "names": [
+            "number"
+          ]
+        }
+      },
+      {
+        "name": "month",
+        "optional": true,
+        "type": {
+          "names": [
+            "number"
+          ]
+        }
+      },
+      {
+        "name": "day",
+        "optional": true,
+        "type": {
+          "names": [
+            "number"
+          ]
+        }
+      }
+    ]
+  },
+  {
+    "memberof": "oj-c.InputDatePicker",
+    "id": "oj-c.InputDatePicker.DisplayOptionsProps",
+    "name": "DisplayOptionsProps",
     "kind": "typedef",
-    "longname": "oj-c.InputDatePicker.DisplayOptions",
+    "longname": "oj-c.InputDatePicker.DisplayOptionsProps",
     "scope": "static",
     "description": "Display options for auxiliary content that determines whether or not it should be displayed.",
     "type": {
@@ -1463,52 +1567,5 @@
         }
       }
     ]
-  },
-  {
-    "memberof": "oj-c.InputDatePicker",
-    "id": "oj-c.InputDatePicker.CalendarDate",
-    "name": "CalendarDate",
-    "kind": "typedef",
-    "longname": "oj-c.InputDatePicker.CalendarDate",
-    "scope": "static",
-    "description": "",
-    "type": {
-      "names": [
-        "Object"
-      ]
-    },
-    "meta": {
-      "filename": "input-date-picker.tsx",
-      "path": "web/components/oj-c/input-date-picker"
-    },
-    "properties": [
-      {
-        "name": "year",
-        "optional": true,
-        "type": {
-          "names": [
-            "number"
-          ]
-        }
-      },
-      {
-        "name": "month",
-        "optional": true,
-        "type": {
-          "names": [
-            "number"
-          ]
-        }
-      },
-      {
-        "name": "day",
-        "optional": true,
-        "type": {
-          "names": [
-            "number"
-          ]
-        }
-      }
-    ]
   }
 ]