@oracle/oraclejet-core-pack 16.0.6 → 16.1.1

package/oj-c/input-month-mask/component.json

@@ -0,0 +1,493 @@
+{
+  "name": "input-month-mask",
+  "version": "16.1.1",
+  "jetVersion": "^16.1.1",
+  "pack": "oj-c",
+  "type": "composite",
+  "dependencyScope": "runtime",
+  "license": "https://opensource.org/licenses/UPL",
+  "implements": [
+    "CInputMonthMaskElement"
+  ],
+  "displayName": "InputMonthMask",
+  "description": "An input month mask field allows a user to individually edit, step, or spin the values of the month and year fields.",
+  "help": "oj-c.InputMonthMask.html",
+  "main": "oj-c/input-month-mask",
+  "extension": {
+    "catalog": {
+      "category": "Forms"
+    },
+    "vbdt": {
+      "module": "oj-c/input-month-mask",
+      "defaultColumns": 6,
+      "minColumns": 2
+    },
+    "oracle": {
+      "icon": "oj-ux-ico-date"
+    }
+  },
+  "propertyLayout": [
+    {
+      "propertyGroup": "common",
+      "items": [
+        "disabled",
+        "labelHint",
+        "readonly",
+        "required"
+      ]
+    },
+    {
+      "propertyGroup": "data",
+      "items": [
+        "value"
+      ]
+    }
+  ],
+  "since": "16.1.0",
+  "properties": {
+    "columnSpan": {
+      "type": "number",
+      "description": "Specifies how many columns this component should span.",
+      "displayName": "Column Span",
+      "help": "#columnSpan",
+      "value": 1
+    },
+    "containerReadonly": {
+      "type": "boolean",
+      "description": "Specifies whether an ancestor container, like oj-c-form-layout, is readonly.",
+      "displayName": "Container Readonly",
+      "help": "#containerReadonly",
+      "binding": {
+        "consume": {
+          "name": "containerReadonly"
+        }
+      }
+    },
+    "dateRangeOverflowMessageDetail": {
+      "type": "function",
+      "description": "Overrides the default validator's rangeOverflow message detail.",
+      "displayName": "Date Range Overflow Message Detail",
+      "help": "#dateRangeOverflowMessageDetail"
+    },
+    "dateRangeUnderflowMessageDetail": {
+      "type": "function",
+      "description": "Overrides the default validator's rangeUnderflow message detail.",
+      "displayName": "Date Range Underflow Message Detail",
+      "help": "#dateRangeUnderflowMessageDetail"
+    },
+    "disabled": {
+      "type": "boolean",
+      "description": "Specifies whether the component is disabled.",
+      "displayName": "Disabled",
+      "help": "#disabled",
+      "value": false
+    },
+    "displayOptions": {
+      "type": "object",
+      "description": "Display options for auxiliary content that determines whether or not it should be displayed.",
+      "displayName": "Display Options",
+      "help": "#displayOptions",
+      "properties": {
+        "messages": {
+          "type": "string",
+          "enumValues": [
+            "none",
+            "display"
+          ],
+          "value": "display"
+        },
+        "validatorHint": {
+          "type": "string",
+          "enumValues": [
+            "none",
+            "display"
+          ],
+          "value": "display"
+        }
+      }
+    },
+    "help": {
+      "type": "object",
+      "description": "Form component help information.",
+      "displayName": "Help",
+      "help": "#help",
+      "properties": {
+        "instruction": {
+          "type": "string",
+          "value": ""
+        }
+      }
+    },
+    "helpHints": {
+      "type": "object",
+      "description": "The helpHints object contains a definition property and a source property.",
+      "displayName": "Help Hints",
+      "help": "#helpHints",
+      "properties": {
+        "definition": {
+          "type": "string",
+          "value": ""
+        },
+        "source": {
+          "type": "string",
+          "value": ""
+        },
+        "sourceText": {
+          "type": "string"
+        }
+      }
+    },
+    "labelEdge": {
+      "type": "string",
+      "description": "Specifies how the label is positioned for the component",
+      "displayName": "Label Edge",
+      "help": "#labelEdge",
+      "propertyEditorValues": {
+        "inside": {
+          "description": "The label floats over the input element, but moves up on focus or when the component has a value (default, if unspecified).",
+          "displayName": "Inside"
+        },
+        "none": {
+          "description": "The component will not create a label, but instead set the aria-label property on the input element.",
+          "displayName": "None"
+        },
+        "start": {
+          "description": "The label will be placed before the start of the component.",
+          "displayName": "Start"
+        },
+        "top": {
+          "description": "The label will be placed on top of the component.",
+          "displayName": "Top"
+        }
+      },
+      "enumValues": [
+        "none",
+        "start",
+        "top",
+        "inside"
+      ],
+      "binding": {
+        "consume": {
+          "name": "containerLabelEdge"
+        }
+      }
+    },
+    "labelHint": {
+      "type": "string",
+      "description": "Represents a hint for rendering a label on the component.",
+      "displayName": "Label Hint",
+      "help": "#labelHint",
+      "required": true,
+      "translatable": true
+    },
+    "labelStartWidth": {
+      "type": "number|string",
+      "description": "The width of the label when labelEdge is 'start'.",
+      "displayName": "Label Start Width",
+      "help": "#labelStartWidth",
+      "binding": {
+        "consume": {
+          "name": "labelWidth"
+        }
+      }
+    },
+    "labelWrapping": {
+      "type": "string",
+      "description": "Should the labels wrap or truncate when there is not enough available space.",
+      "displayName": "Label Wrapping",
+      "help": "#labelWrapping",
+      "propertyEditorValues": {
+        "truncate": {
+          "description": "Label will truncate if needed.",
+          "displayName": "Truncate"
+        },
+        "wrap": {
+          "description": "Label will wrap if needed.",
+          "displayName": "Wrap"
+        }
+      },
+      "enumValues": [
+        "truncate",
+        "wrap"
+      ],
+      "binding": {
+        "consume": {
+          "name": "labelWrapping"
+        }
+      }
+    },
+    "max": {
+      "type": "object|null",
+      "description": "The maximum selectable year and month",
+      "displayName": "Max",
+      "help": "#max",
+      "properties": {
+        "year": {
+          "type": "number"
+        },
+        "month": {
+          "type": "number"
+        }
+      }
+    },
+    "messagesCustom": {
+      "type": "Array<object>",
+      "description": "List of custom component messages",
+      "displayName": "Messages Custom",
+      "help": "#messagesCustom",
+      "extension": {
+        "vbdt": {
+          "itemProperties": {
+            "summary": {
+              "type": "string"
+            },
+            "detail": {
+              "type": "string"
+            },
+            "severity": {
+              "type": "string",
+              "enumValues": [
+                "error",
+                "confirmation",
+                "info",
+                "warning"
+              ]
+            }
+          }
+        }
+      },
+      "writeback": true,
+      "value": []
+    },
+    "min": {
+      "type": "object|null",
+      "description": "The minimum selectable year and month",
+      "displayName": "Min",
+      "help": "#min",
+      "properties": {
+        "year": {
+          "type": "number"
+        },
+        "month": {
+          "type": "number"
+        }
+      }
+    },
+    "readonly": {
+      "type": "boolean",
+      "description": "Whether the component is readonly",
+      "displayName": "Readonly",
+      "help": "#readonly",
+      "binding": {
+        "consume": {
+          "name": "containerReadonly"
+        }
+      },
+      "value": false
+    },
+    "required": {
+      "type": "boolean",
+      "description": "Specifies whether or not the component is required.",
+      "displayName": "Required",
+      "help": "#required",
+      "value": false
+    },
+    "requiredMessageDetail": {
+      "type": "string",
+      "description": "Overrides the default Required error message.",
+      "displayName": "Required Message Detail",
+      "help": "#requiredMessageDetail",
+      "translatable": true
+    },
+    "textAlign": {
+      "type": "string",
+      "description": "Specifies how the text is aligned within the text field",
+      "displayName": "Text Align",
+      "help": "#textAlign",
+      "propertyEditorValues": {
+        "start": {
+          "description": "Aligns text left when reading direction is ltr and right when reading direction is rtl (default, if unspecified).",
+          "displayName": "Start"
+        },
+        "end": {
+          "description": "Aligns text right when reading direction is ltr and left when reading direction is rtl.",
+          "displayName": "End"
+        },
+        "right": {
+          "description": "Aligns text right regardless of reading direction, often used for numbers.",
+          "displayName": "Right"
+        }
+      },
+      "enumValues": [
+        "end",
+        "start",
+        "right"
+      ]
+    },
+    "userAssistanceDensity": {
+      "type": "string",
+      "description": "Specifies the density of the form component's user assistance presentation.",
+      "displayName": "User Assistance Density",
+      "help": "#userAssistanceDensity",
+      "propertyEditorValues": {
+        "reflow": {
+          "description": "Messages, help, hints, and required are all shown inline under the field with no reserved space.",
+          "displayName": "Reflow"
+        },
+        "efficient": {
+          "description": "Messages, help, hints, and required are all shown inline under the field with reserved space.",
+          "displayName": "Efficient"
+        },
+        "compact": {
+          "description": "Messages, help, hints, and required will not be shown inline; they will show in a mode that keeps the screen more compact, like a popup for the messages, and a required icon to indicate Required.",
+          "displayName": "Compact"
+        }
+      },
+      "enumValues": [
+        "compact",
+        "reflow",
+        "efficient"
+      ],
+      "binding": {
+        "consume": {
+          "name": "containerUserAssistanceDensity"
+        }
+      },
+      "value": "reflow"
+    },
+    "validators": {
+      "type": "Array<object>|null",
+      "description": "Specifies the validators for the component.",
+      "displayName": "Validators",
+      "help": "#validators",
+      "value": []
+    },
+    "value": {
+      "type": "object|null",
+      "description": "The value of the component.",
+      "displayName": "Value",
+      "help": "#value",
+      "properties": {
+        "year": {
+          "type": "number"
+        },
+        "month": {
+          "type": "number"
+        }
+      },
+      "writeback": true,
+      "value": null
+    },
+    "rawValue": {
+      "type": "object",
+      "description": "Specifies how the raw value of the component",
+      "displayName": "Raw Value",
+      "help": "#rawValue",
+      "properties": {
+        "year": {
+          "type": "number"
+        },
+        "month": {
+          "type": "number"
+        }
+      },
+      "readOnly": true,
+      "writeback": true
+    },
+    "valid": {
+      "type": "string",
+      "description": "Specifies how the valid state of the component",
+      "displayName": "Valid",
+      "help": "#valid",
+      "propertyEditorValues": {
+        "valid": {
+          "description": "The component is valid",
+          "displayName": "Valid"
+        },
+        "pending": {
+          "description": "The component is waiting for the validation state to be determined. The 'pending' state is set at the start of the validation process.",
+          "displayName": "Pending"
+        },
+        "invalidHidden": {
+          "description": "The component has invalid messages hidden and no invalid messages showing. An invalid message is one with severity 'error'.",
+          "displayName": "Invalid Hidden"
+        },
+        "invalidShown": {
+          "description": "The component has invalid messages showing. An invalid message is one with severity 'error'.",
+          "displayName": "Invalid Shown"
+        }
+      },
+      "enumValues": [
+        "pending",
+        "valid",
+        "invalidHidden",
+        "invalidShown"
+      ],
+      "readOnly": true,
+      "writeback": true
+    }
+  },
+  "methods": {
+    "blur": {
+      "description": "Blurs the field.",
+      "return": "void"
+    },
+    "focus": {
+      "description": "Focuses the field.",
+      "return": "void"
+    },
+    "showMessages": {
+      "description": "Takes all deferred messages and shows them.",
+      "return": "void"
+    },
+    "reset": {
+      "description": "Resets the component by clearing all messages and updating the component's display value using the attribute value.",
+      "return": "void"
+    },
+    "validate": {
+      "description": "If enabled, validates the component's display value using the converter and all validators registered on the component. The Promise resolves to 'valid' if there were no converter parse errors and the component passed all validations, or if the component is disabled or readonly.",
+      "return": "Promise"
+    },
+    "setProperty": {
+      "description": "Sets a property or a single subproperty for complex properties and notifies the component of the change, triggering a corresponding event.",
+      "help": "#setProperty",
+      "params": [
+        {
+          "name": "property",
+          "description": "The property name to set. Supports dot notation for subproperty access.",
+          "type": "string"
+        },
+        {
+          "name": "value",
+          "description": "The new value to set the property to.",
+          "type": "any"
+        }
+      ],
+      "return": "void"
+    },
+    "getProperty": {
+      "description": "Retrieves the value of a property or a subproperty.",
+      "help": "#getProperty",
+      "params": [
+        {
+          "name": "property",
+          "description": "The property name to get. Supports dot notation for subproperty access.",
+          "type": "string"
+        }
+      ],
+      "return": "any"
+    },
+    "setProperties": {
+      "description": "Performs a batch set of properties.",
+      "help": "#setProperties",
+      "params": [
+        {
+          "name": "properties",
+          "description": "An object containing the property and value pairs to set.",
+          "type": "object"
+        }
+      ],
+      "return": "void"
+    }
+  }
+}

package/oj-c/input-month-mask/index.js

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

package/oj-c/input-month-mask/input-month-mask-styles.css

@@ -0,0 +1,14 @@
+oj-c-input-month-mask:not(.oj-complete){
+  visibility: hidden;
+}
+
+oj-c-input-month-mask{
+  display: inline-block;
+  max-width: 100%;
+  width: 100%;
+}
+
+oj-c-input-month-mask[hidden]
+{
+  display: none;
+}

package/oj-c/input-month-mask/input-month-mask.js

@@ -0,0 +1,69 @@
+define(["require", "exports", "preact/jsx-runtime", '@oracle/oraclejet-preact/translationBundle', "@oracle/oraclejet-preact/hooks/UNSAFE_useFormContext", "@oracle/oraclejet-preact/hooks/UNSAFE_useFormVariantContext", "@oracle/oraclejet-preact/hooks/UNSAFE_useTabbableMode", "@oracle/oraclejet-preact/UNSAFE_InputDateMask", "oj-c/editable-value/UNSAFE_useAssistiveText/useAssistiveText", "ojs/ojcontext", "ojs/ojvcomponent", "preact/compat", "preact/hooks", "./useInputMonthMaskPreact", "@oracle/oraclejet-preact/utils/UNSAFE_styles/Layout", "@oracle/oraclejet-preact/utils/UNSAFE_calendarDateUtils", "css!oj-c/input-month-mask/input-month-mask-styles.css"], function (require, exports, jsx_runtime_1, translationBundle_1, UNSAFE_useFormContext_1, UNSAFE_useFormVariantContext_1, UNSAFE_useTabbableMode_1, UNSAFE_InputDateMask_1, useAssistiveText_1, Context, ojvcomponent_1, compat_1, hooks_1, useInputMonthMaskPreact_1, Layout_1, UNSAFE_calendarDateUtils_1) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.InputMonthMask = void 0;
+    const displayOptionsDefault = {
+        messages: 'display',
+        validatorHint: 'display'
+    };
+    const helpDefault = {
+        instruction: ''
+    };
+    const helpHintsDefault = {
+        definition: '',
+        source: ''
+    };
+    const messagesCustomDefault = [];
+    const validatorsDefault = [];
+    const InputMonthMaskImpl = ({ columnSpan = 1, disabled = false, displayOptions = displayOptionsDefault, help = helpDefault, helpHints = helpHintsDefault, messagesCustom = messagesCustomDefault, readonly = false, required = false, userAssistanceDensity = 'reflow', validators = validatorsDefault, value = null, ...otherProps }, ref) => {
+        const rootRef = (0, hooks_1.useRef)();
+        const inputMonthMaskRef = (0, hooks_1.useRef)();
+        const addBusyState = (0, hooks_1.useCallback)((description = 'InputMonthMask: busyState') => {
+            return rootRef.current
+                ? Context.getContext(rootRef.current).getBusyContext().addBusyState({ description })
+                : () => { };
+        }, []);
+        const { inputMonthMaskProps, methods } = (0, useInputMonthMaskPreact_1.useInputMonthMaskPreact)({
+            disabled,
+            displayOptions,
+            messagesCustom,
+            readonly,
+            required,
+            userAssistanceDensity,
+            validators,
+            value,
+            ...otherProps
+        }, addBusyState);
+        (0, hooks_1.useImperativeHandle)(ref, () => ({
+            blur: () => inputMonthMaskRef.current?.blur(),
+            focus: () => inputMonthMaskRef.current?.focus(),
+            ...methods
+        }), [methods]);
+        const assistiveTextProps = (0, useAssistiveText_1.useAssistiveText)({
+            displayOptions,
+            help,
+            helpHints,
+            userAssistanceDensity: inputMonthMaskProps.userAssistanceDensity,
+            validators
+        });
+        const variant = (0, UNSAFE_useFormVariantContext_1.useFormVariantContext)();
+        const containerProps = {
+            isFormLayout: otherProps.containerReadonly !== undefined,
+            isReadonly: otherProps.containerReadonly,
+            labelWrapping: otherProps.labelWrapping
+        };
+        if (!(0, UNSAFE_calendarDateUtils_1.isValidCalendarMonthRequired)(value)) {
+            throw new Error('If the value property is defined, it must be an object with year and month defined.');
+        }
+        if (!(0, UNSAFE_calendarDateUtils_1.isValidCalendarMonthRequired)(otherProps.min)) {
+            throw new Error('If the min property is defined, it must be an object with year and month defined.');
+        }
+        if (!(0, UNSAFE_calendarDateUtils_1.isValidCalendarMonthRequired)(otherProps.max)) {
+            throw new Error('If the max property is defined, it must be an object with year and month defined.');
+        }
+        return ((0, jsx_runtime_1.jsx)(ojvcomponent_1.Root, { id: otherProps.id, ref: rootRef, class: Layout_1.layoutSpanStyles.layoutSpanColumn[columnSpan], children: (0, jsx_runtime_1.jsx)(UNSAFE_useFormContext_1.FormContext.Provider, { value: containerProps, children: (0, jsx_runtime_1.jsx)(UNSAFE_InputDateMask_1.InputDateMask, { ref: inputMonthMaskRef, ...assistiveTextProps, ...inputMonthMaskProps, variant: variant, granularity: "month" }) }) }));
+    };
+    exports.InputMonthMask = (0, ojvcomponent_1.registerCustomElement)('oj-c-input-month-mask', (0, compat_1.forwardRef)(InputMonthMaskImpl), "InputMonthMask", { "properties": { "columnSpan": { "type": "number" }, "containerReadonly": { "type": "boolean", "binding": { "consume": { "name": "containerReadonly" } } }, "dateRangeOverflowMessageDetail": { "type": "function" }, "dateRangeUnderflowMessageDetail": { "type": "function" }, "disabled": { "type": "boolean" }, "displayOptions": { "type": "object", "properties": { "messages": { "type": "string", "enumValues": ["none", "display"] }, "validatorHint": { "type": "string", "enumValues": ["none", "display"] } } }, "help": { "type": "object", "properties": { "instruction": { "type": "string" } } }, "helpHints": { "type": "object", "properties": { "definition": { "type": "string" }, "source": { "type": "string" }, "sourceText": { "type": "string" } } }, "labelEdge": { "type": "string", "enumValues": ["none", "start", "top", "inside"], "binding": { "consume": { "name": "containerLabelEdge" } } }, "labelHint": { "type": "string" }, "labelStartWidth": { "type": "number|string", "binding": { "consume": { "name": "labelWidth" } } }, "labelWrapping": { "type": "string", "enumValues": ["truncate", "wrap"], "binding": { "consume": { "name": "labelWrapping" } } }, "max": { "type": "object|null", "properties": { "year": { "type": "number" }, "month": { "type": "number" } } }, "messagesCustom": { "type": "Array<object>", "writeback": true }, "min": { "type": "object|null", "properties": { "year": { "type": "number" }, "month": { "type": "number" } } }, "readonly": { "type": "boolean", "binding": { "consume": { "name": "containerReadonly" } } }, "required": { "type": "boolean" }, "requiredMessageDetail": { "type": "string" }, "textAlign": { "type": "string", "enumValues": ["end", "start", "right"] }, "userAssistanceDensity": { "type": "string", "enumValues": ["compact", "reflow", "efficient"], "binding": { "consume": { "name": "containerUserAssistanceDensity" } } }, "validators": { "type": "Array<object>|null" }, "value": { "type": "object|null", "properties": { "year": { "type": "number" }, "month": { "type": "number" } }, "writeback": true }, "rawValue": { "type": "object", "properties": { "year": { "type": "number" }, "month": { "type": "number" } }, "readOnly": true, "writeback": true }, "valid": { "type": "string", "enumValues": ["pending", "valid", "invalidHidden", "invalidShown"], "readOnly": true, "writeback": true } }, "extension": { "_WRITEBACK_PROPS": ["messagesCustom", "rawValue", "valid", "value"], "_READ_ONLY_PROPS": ["rawValue", "valid"], "_OBSERVED_GLOBAL_PROPS": ["aria-describedby", "id"] }, "methods": { "blur": {}, "focus": {}, "showMessages": {}, "reset": {}, "validate": {} } }, { "columnSpan": 1, "disabled": false, "displayOptions": { "messages": "display", "validatorHint": "display" }, "help": { "instruction": "" }, "helpHints": { "definition": "", "source": "" }, "messagesCustom": [], "readonly": false, "required": false, "userAssistanceDensity": "reflow", "validators": [], "value": null }, {
+        '@oracle/oraclejet-preact': translationBundle_1.default
+    }, { consume: [UNSAFE_useFormVariantContext_1.FormVariantContext, UNSAFE_useTabbableMode_1.TabbableModeContext] });
+});

package/oj-c/input-month-mask/useImplicitCalendarMonthRangeValidator.js

@@ -0,0 +1,26 @@
+define(["require", "exports", "preact/hooks", "./CalendarMonthRangeValidator", "@oracle/oraclejet-preact/hooks/UNSAFE_useTranslationBundle"], function (require, exports, hooks_1, CalendarMonthRangeValidator_1, UNSAFE_useTranslationBundle_1) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.useImplicitCalendarMonthRangeValidator = void 0;
+    function useImplicitCalendarMonthRangeValidator({ formatObj, dateRangeOverflowMessageDetail, dateRangeUnderflowMessageDetail, max, min }) {
+        const translations = (0, UNSAFE_useTranslationBundle_1.useTranslationBundle)('@oracle/oraclejet-preact');
+        const defaultRangeOverflowMessageDetailFn = translations.inputMonthMask_dateRangeOverflowMessageDetail;
+        const defaultRangeUnderflowMessageDetailFn = translations.inputMonthMask_dateRangeUnderflowMessageDetail;
+        const calendarMonthRangeValidator = (0, hooks_1.useMemo)(() => {
+            if (min !== undefined || max !== undefined) {
+                return new CalendarMonthRangeValidator_1.CalendarMonthRangeValidator({
+                    defaultRangeOverflowMessageDetailFn,
+                    defaultRangeUnderflowMessageDetailFn,
+                    formatObj,
+                    max,
+                    min,
+                    dateRangeOverflowMessageDetail,
+                    dateRangeUnderflowMessageDetail
+                });
+            }
+            return null;
+        }, [formatObj, dateRangeOverflowMessageDetail, dateRangeUnderflowMessageDetail, min, max]);
+        return calendarMonthRangeValidator;
+    }
+    exports.useImplicitCalendarMonthRangeValidator = useImplicitCalendarMonthRangeValidator;
+});