@oracle/oraclejet-core-pack 14.0.0

package/oj-c/message-toast/__webdriver__/index.js

@@ -0,0 +1,74 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+exports.__esModule = true;
+exports.findMessageToast = exports.MessageToastWebElement = void 0;
+var oraclejet_webdriver_1 = require("@oracle/oraclejet-webdriver");
+var MessageToastWebElement_1 = require("./MessageToastWebElement");
+exports.MessageToastWebElement = MessageToastWebElement_1.MessageToastWebElement;
+/**
+ * Retrieve an instance of [[MessageToastWebElement]].
+ * @example
+ * ```javascript
+ * import { findMessageToast } from '@oracle/oraclejet-core-pack/webdriver';
+ * const el = await findMessageToast(driver, By.id('my-oj-c-message-toast'));
+ * ```
+ * @param driver A WebDriver/WebElement instance from where the element will be
+ * searched. If WebDriver is passed, the element will be searched globally in the
+ * document. If WebElement is passed, the search will be relative to this element.
+ * @param by The locator with which to find the element
+ */
+function findMessageToast(driver, by) {
+    return __awaiter(this, void 0, void 0, function () {
+        var webEl, tagName;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, driver.findElement(by)];
+                case 1:
+                    webEl = _a.sent();
+                    if (!!(webEl instanceof MessageToastWebElement_1.MessageToastWebElement)) return [3 /*break*/, 3];
+                    return [4 /*yield*/, webEl.getTagName()];
+                case 2:
+                    tagName = _a.sent();
+                    throw Error("findMessageToast(".concat(by, ") created ").concat(webEl.constructor.name, " for <").concat(tagName, ">, but expected ").concat(MessageToastWebElement_1.MessageToastWebElement.name));
+                case 3: return [2 /*return*/, webEl];
+            }
+        });
+    });
+}
+exports.findMessageToast = findMessageToast;
+(0, oraclejet_webdriver_1.register)('oj-c-message-toast', MessageToastWebElement_1.MessageToastWebElement);

package/oj-c/message-toast/component.json

@@ -0,0 +1,244 @@
+{
+  "name": "message-toast",
+  "version": "1.0.0",
+  "jetVersion": "^14.0.0",
+  "type": "composite",
+  "pack": "oj-c",
+  "implements": [
+    "CMessageToastElement"
+  ],
+  "displayName": "MessageToast",
+  "description": "Toast messages are short, noncritical, auto-dismissible messages that communicate non-disruptive contextual messages.",
+  "help": "oj-c.MessageToast.html",
+  "main": "oj-c/message-toast",
+  "extension": {
+    "vbdt": {
+      "defaultColumns": 2,
+      "minColumns": 1,
+      "module": "oj-c/message-toast"
+    },
+    "oracle": {
+      "icon": "oj-ux-ico-messages",
+      "uxSpecs": [
+        "toast-messages"
+      ]
+    }
+  },
+  "propertyLayout": [
+    {
+      "propertyGroup": "data",
+      "items": [
+        "data"
+      ]
+    }
+  ],
+  "since": "14.0.0",
+  "properties": {
+    "data": {
+      "type": "object",
+      "description": "Data for the Message Toast component.",
+      "displayName": "Data",
+      "help": "#data"
+    },
+    "detailTemplateValue": {
+      "type": "string|function",
+      "description": "A dynamic template key or a function that determines the detail template for the current row.",
+      "displayName": "Current Detail Template",
+      "help": "#detailTemplateValue",
+      "dynamicSlotDef": "MessageToastTemplateContext"
+    },
+    "iconTemplateValue": {
+      "type": "string|function",
+      "description": "A dynamic template key or a function that determines the icon template for the current row.",
+      "displayName": "Current Icon Template",
+      "help": "#iconTemplateValue",
+      "dynamicSlotDef": "MessageToastTemplateContext"
+    },
+    "offset": {
+      "type": "number|object",
+      "description": "Offset for the Message Toast component's position.",
+      "displayName": "Offset",
+      "help": "#offset",
+      "value": 0
+    },
+    "position": {
+      "type": "string",
+      "description": "Position for the Message Toast component.",
+      "displayName": "Position",
+      "help": "#position",
+      "enumValues": [
+        "bottom",
+        "top",
+        "top-start",
+        "top-end",
+        "bottom-start",
+        "bottom-end",
+        "top-left",
+        "top-right",
+        "bottom-left",
+        "bottom-right"
+      ],
+      "value": "bottom"
+    }
+  },
+  "dynamicSlots": {
+    "MessageToastTemplateContext": {
+      "description": "The dynamic template slots for the Toast message.",
+      "displayName": "Dynamic Template Slots",
+      "help": "#dynamicTemplates",
+      "data": {
+        "data": {
+          "type": "any"
+        },
+        "key": {
+          "type": "any"
+        },
+        "metadata": {
+          "type": "object",
+          "properties": {
+            "indexFromParent": {
+              "type": "number"
+            },
+            "isLeaf": {
+              "type": "boolean"
+            },
+            "key": {
+              "type": "any"
+            },
+            "message": {
+              "type": "object",
+              "properties": {
+                "detail": {
+                  "type": "string"
+                },
+                "severity": {
+                  "type": "number|string",
+                  "enumValues": [
+                    "error",
+                    "confirmation",
+                    "info",
+                    "warning",
+                    "fatal"
+                  ]
+                },
+                "summary": {
+                  "type": "string"
+                }
+              }
+            },
+            "parentKey": {
+              "type": "any"
+            },
+            "suggestion": {
+              "type": "object"
+            },
+            "treeDepth": {
+              "type": "number"
+            }
+          }
+        }
+      }
+    }
+  },
+  "events": {
+    "ojClose": {
+      "description": "Event emitted when the user tries to close a message though UI interaction",
+      "help": "#event:ojClose",
+      "detail": {
+        "data": {
+          "type": "any"
+        },
+        "key": {
+          "type": "any"
+        },
+        "metadata": {
+          "type": "object",
+          "properties": {
+            "indexFromParent": {
+              "type": "number"
+            },
+            "isLeaf": {
+              "type": "boolean"
+            },
+            "key": {
+              "type": "any"
+            },
+            "message": {
+              "type": "object",
+              "properties": {
+                "detail": {
+                  "type": "string"
+                },
+                "severity": {
+                  "type": "number|string",
+                  "enumValues": [
+                    "error",
+                    "confirmation",
+                    "info",
+                    "warning",
+                    "fatal"
+                  ]
+                },
+                "summary": {
+                  "type": "string"
+                }
+              }
+            },
+            "parentKey": {
+              "type": "any"
+            },
+            "suggestion": {
+              "type": "object"
+            },
+            "treeDepth": {
+              "type": "number"
+            }
+          }
+        }
+      }
+    }
+  },
+  "methods": {
+    "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/message-toast/index.js

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

package/oj-c/message-toast/message-toast-styles.css

@@ -0,0 +1,8 @@
+oj-c-message-toast:not(.oj-complete){
+  visibility: hidden;
+}
+
+oj-c-message-toast[hidden]
+{
+  display: none;
+}

package/oj-c/message-toast/message-toast.js

@@ -0,0 +1,35 @@
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+define(["require", "exports", "preact/jsx-runtime", '@oracle/oraclejet-preact/translationBundle', "@oracle/oraclejet-preact/hooks/UNSAFE_useMessagesContext", "@oracle/oraclejet-preact/UNSAFE_MessageToast", "oj-c/hooks/UNSAFE_useDataProvider/useDataProvider", "ojs/ojcontext", "ojs/ojvcomponent", "preact/hooks", "css!./message-toast-styles.css"], function (require, exports, jsx_runtime_1, translationBundle_1, UNSAFE_useMessagesContext_1, UNSAFE_MessageToast_1, useDataProvider_1, ojcontext_1, ojvcomponent_1, hooks_1) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.MessageToast = void 0;
+    translationBundle_1 = __importDefault(translationBundle_1);
+    ojcontext_1 = __importDefault(ojcontext_1);
+    exports.MessageToast = (0, ojvcomponent_1.registerCustomElement)('oj-c-message-toast', ({ data, detailTemplateValue, iconTemplateValue, messageTemplates, offset = 0, position = 'bottom', onOjClose }) => {
+        const initialRender = (0, hooks_1.useRef)(true);
+        const rootRef = (0, hooks_1.useRef)();
+        const [dpKey, setDpKey] = (0, hooks_1.useState)(Symbol());
+        const addBusyState = (0, hooks_1.useCallback)((description = 'MessageToast: busyState') => {
+            return rootRef.current
+                ? ojcontext_1.default.getContext(rootRef.current).getBusyContext().addBusyState({ description })
+                : () => { };
+        }, []);
+        (0, hooks_1.useEffect)(() => {
+            if (initialRender.current) {
+                initialRender.current = false;
+                return;
+            }
+            setDpKey(Symbol());
+        }, [data]);
+        const { data: dataArr } = (0, useDataProvider_1.useDataProvider)({
+            data,
+            addBusyState
+        });
+        const messagesContext = (0, hooks_1.useMemo)(() => ({ addBusyState }), []);
+        return ((0, jsx_runtime_1.jsx)(ojvcomponent_1.Root, Object.assign({ ref: rootRef }, { children: (0, jsx_runtime_1.jsx)(UNSAFE_useMessagesContext_1.MessagesContext.Provider, Object.assign({ value: messagesContext }, { children: (0, jsx_runtime_1.jsx)(UNSAFE_MessageToast_1.MessageToast, { data: dataArr, detailRendererKey: detailTemplateValue, iconRendererKey: iconTemplateValue, offset: offset, onClose: onOjClose, position: position, renderers: messageTemplates }, dpKey) })) })));
+    }, "MessageToast", { "properties": { "data": { "type": "object" }, "detailTemplateValue": { "type": "string|function" }, "iconTemplateValue": { "type": "string|function" }, "offset": { "type": "number|object" }, "position": { "type": "string", "enumValues": ["bottom", "top", "top-start", "top-end", "bottom-start", "bottom-end", "top-left", "top-right", "bottom-left", "bottom-right"] } }, "extension": { "_DYNAMIC_SLOT": { "prop": "messageTemplates", "isTemplate": 1 } }, "events": { "ojClose": {} } }, { "offset": 0, "position": "bottom" }, {
+        '@oracle/oraclejet-preact': translationBundle_1.default
+    });
+});

package/oj-c/message-toast.js

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