@oracle/oraclejet-core-pack 14.0.0

package/oj-c/avatar/__webdriver__/AvatarWebElement.js

@@ -0,0 +1,32 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+exports.__esModule = true;
+exports.AvatarWebElement = void 0;
+var AvatarWebElementBase_1 = require("./AvatarWebElementBase");
+/**
+ * The component WebElement for [oj-c-avatar](../../../oj-c/docs/oj.Avatar.html).
+ * Do not instantiate this class directly, instead, use
+ * [findAvatar](../modules.html#findAvatar).
+ */
+var AvatarWebElement = /** @class */ (function (_super) {
+    __extends(AvatarWebElement, _super);
+    function AvatarWebElement() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    return AvatarWebElement;
+}(AvatarWebElementBase_1.AvatarWebElementBase));
+exports.AvatarWebElement = AvatarWebElement;

package/oj-c/avatar/__webdriver__/AvatarWebElementBase.js

@@ -0,0 +1,87 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+exports.__esModule = true;
+exports.AvatarWebElementBase = void 0;
+var elements_1 = require("@oracle/oraclejet-webdriver/elements");
+/**
+ * This is the base class for oj-c-avatar WebElement, and is generated from the
+ * component's metadata. Do not modify these contents since they'll be replaced
+ * during the next generation.
+ * Put overrides into the WebElements's subclass, AvatarWebElement.ts.
+ */
+var AvatarWebElementBase = /** @class */ (function (_super) {
+    __extends(AvatarWebElementBase, _super);
+    function AvatarWebElementBase() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    /**
+     * Gets the value of <code>background</code> property.
+     * Specifies the background of the avatar.
+     * @return The value of <code>background</code> property.
+     *
+     */
+    AvatarWebElementBase.prototype.getBackground = function () {
+        return this.getProperty('background');
+    };
+    /**
+     * Gets the value of <code>initials</code> property.
+     * Specifies the initials of the avatar.
+     * @return The value of <code>initials</code> property.
+     *
+     */
+    AvatarWebElementBase.prototype.getInitials = function () {
+        return this.getProperty('initials');
+    };
+    /**
+     * Gets the value of <code>size</code> property.
+     * Specifies the size of the avatar.
+     * @return The value of <code>size</code> property.
+     *
+     */
+    AvatarWebElementBase.prototype.getSizeProperty = function () {
+        return this.getProperty('size');
+    };
+    /**
+     * Gets the value of <code>src</code> property.
+     * Specifies the source for the image of the avatar.
+     * @return The value of <code>src</code> property.
+     *
+     */
+    AvatarWebElementBase.prototype.getSrc = function () {
+        return this.getProperty('src');
+    };
+    /**
+     * Gets the value of <code>iconClass</code> property.
+     * The icon class to be displayed.
+     * @return The value of <code>iconClass</code> property.
+     *
+     */
+    AvatarWebElementBase.prototype.getIconClass = function () {
+        return this.getProperty('iconClass');
+    };
+    /**
+     * Gets the value of <code>shape</code> property.
+     * Specifies the shape of the avatar.
+     * @return The value of <code>shape</code> property.
+     *
+     */
+    AvatarWebElementBase.prototype.getShape = function () {
+        return this.getProperty('shape');
+    };
+    return AvatarWebElementBase;
+}(elements_1.OjWebElement));
+exports.AvatarWebElementBase = AvatarWebElementBase;

package/oj-c/avatar/__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.findAvatar = exports.AvatarWebElement = void 0;
+var oraclejet_webdriver_1 = require("@oracle/oraclejet-webdriver");
+var AvatarWebElement_1 = require("./AvatarWebElement");
+exports.AvatarWebElement = AvatarWebElement_1.AvatarWebElement;
+/**
+ * Retrieve an instance of [[AvatarWebElement]].
+ * @example
+ * ```javascript
+ * import { findAvatar } from '@oracle/oraclejet-core-pack/webdriver';
+ * const el = await findAvatar(driver, By.id('my-oj-c-avatar'));
+ * ```
+ * @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 findAvatar(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 AvatarWebElement_1.AvatarWebElement)) return [3 /*break*/, 3];
+                    return [4 /*yield*/, webEl.getTagName()];
+                case 2:
+                    tagName = _a.sent();
+                    throw Error("findAvatar(".concat(by, ") created ").concat(webEl.constructor.name, " for <").concat(tagName, ">, but expected ").concat(AvatarWebElement_1.AvatarWebElement.name));
+                case 3: return [2 /*return*/, webEl];
+            }
+        });
+    });
+}
+exports.findAvatar = findAvatar;
+(0, oraclejet_webdriver_1.register)('oj-c-avatar', AvatarWebElement_1.AvatarWebElement);

package/oj-c/avatar/avatar-styles.css

@@ -0,0 +1,10 @@
+oj-c-avatar:not(.oj-complete) {
+  visibility: hidden;
+}
+
+oj-c-avatar[hidden] {
+  display: none;
+}
+oj-c-avatar {
+  display: inline-block;
+}

package/oj-c/avatar/avatar.js

@@ -0,0 +1,27 @@
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+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/UNSAFE_Avatar", "ojs/ojvcomponent", "css!oj-c/avatar/avatar-styles.css"], function (require, exports, jsx_runtime_1, translationBundle_1, UNSAFE_Avatar_1, ojvcomponent_1) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.Avatar = void 0;
+    translationBundle_1 = __importDefault(translationBundle_1);
+    exports.Avatar = (0, ojvcomponent_1.registerCustomElement)('oj-c-avatar', (_a) => {
+        var { src, iconClass, initials, shape = 'square', background = 'neutral', size = 'md' } = _a, otherProps = __rest(_a, ["src", "iconClass", "initials", "shape", "background", "size"]);
+        const icon = iconClass ? (0, jsx_runtime_1.jsx)("span", { class: iconClass }) : null;
+        return ((0, jsx_runtime_1.jsx)(ojvcomponent_1.Root, { children: (0, jsx_runtime_1.jsx)(UNSAFE_Avatar_1.Avatar, Object.assign({ src: src !== null && src !== void 0 ? src : undefined, background: background, size: size, initials: initials !== null && initials !== void 0 ? initials : undefined, shape: shape, accessibleLabel: otherProps['aria-label'] }, { children: icon })) }));
+    }, "Avatar", { "properties": { "background": { "type": "string", "enumValues": ["neutral", "orange", "green", "teal", "blue", "slate", "pink", "purple", "lilac", "gray"] }, "initials": { "type": "string|null" }, "size": { "type": "string", "enumValues": ["2xs", "xs", "sm", "md", "lg", "xl", "2xl"] }, "src": { "type": "string|null" }, "iconClass": { "type": "string" }, "shape": { "type": "string", "enumValues": ["circle", "square"] } }, "extension": { "_OBSERVED_GLOBAL_PROPS": ["aria-label"] } }, { "shape": "square", "background": "neutral", "size": "md" }, {
+        '@oracle/oraclejet-preact': translationBundle_1.default
+    });
+});

package/oj-c/avatar/component.json

@@ -0,0 +1,227 @@
+{
+  "name": "avatar",
+  "version": "1.0.0",
+  "jetVersion": "^14.0.0",
+  "type": "composite",
+  "pack": "oj-c",
+  "implements": [
+    "CAvatarElement"
+  ],
+  "description": "An avatar represents a person or entity as initials or an image.",
+  "displayName": "Avatar",
+  "help": "oj-c.Avatar.html",
+  "main": "oj-c/avatar",
+  "extension": {
+    "vbdt": {
+      "module": "oj-c/avatar"
+    },
+    "oracle": {
+      "icon": "oj-ux-ico-avatar",
+      "uxSpecs": [
+        "avatar"
+      ]
+    }
+  },
+  "propertyLayout": [
+    {
+      "propertyGroup": "common",
+      "items": [
+        "size",
+        "background"
+      ]
+    }
+  ],
+  "since": "13.0.0",
+  "properties": {
+    "background": {
+      "type": "string",
+      "description": "Specifies the background of the avatar.",
+      "displayName": "Background",
+      "help": "#background",
+      "propertyEditorValues": {
+        "neutral": {
+          "description": "Neutral background (default, if unspecified)",
+          "displayName": "Neutral"
+        },
+        "orange": {
+          "description": "Orange background",
+          "displayName": "Orange"
+        },
+        "green": {
+          "description": "Green background",
+          "displayName": "Green"
+        },
+        "teal": {
+          "description": "Teal background",
+          "displayName": "Teal"
+        },
+        "blue": {
+          "description": "Blue background",
+          "displayName": "Blue"
+        },
+        "slate": {
+          "description": "Slate background",
+          "displayName": "Slate"
+        },
+        "pink": {
+          "description": "Pink background",
+          "displayName": "Pink"
+        },
+        "purple": {
+          "description": "Purple background",
+          "displayName": "Purple"
+        },
+        "lilac": {
+          "description": "Lilac background",
+          "displayName": "Lilac"
+        },
+        "gray": {
+          "description": "Gray background",
+          "displayName": "Gray"
+        }
+      },
+      "enumValues": [
+        "neutral",
+        "orange",
+        "green",
+        "teal",
+        "blue",
+        "slate",
+        "pink",
+        "purple",
+        "lilac",
+        "gray"
+      ],
+      "value": "neutral"
+    },
+    "initials": {
+      "type": "string|null",
+      "description": "Specifies the initials of the avatar.",
+      "displayName": "Initials",
+      "help": "#initials",
+      "translatable": true
+    },
+    "size": {
+      "type": "string",
+      "description": "Specifies the size of the avatar.",
+      "displayName": "Size",
+      "help": "#size",
+      "propertyEditorValues": {
+        "2xs": {
+          "description": "extra, extra small avatar",
+          "displayName": "Extra Extra Small"
+        },
+        "xs": {
+          "description": "extra small avatar",
+          "displayName": "Extra Small"
+        },
+        "sm": {
+          "description": "small avatar",
+          "displayName": "Small"
+        },
+        "md": {
+          "description": "medium avatar (default, if unspecified)",
+          "displayName": "Medium"
+        },
+        "lg": {
+          "description": "large avatar",
+          "displayName": "Large"
+        },
+        "xl": {
+          "description": "extra large avatar",
+          "displayName": "Extra Large"
+        },
+        "2xl": {
+          "description": "extra, extra large avatar",
+          "displayName": "Extra Extra Large"
+        }
+      },
+      "enumValues": [
+        "2xs",
+        "xs",
+        "sm",
+        "md",
+        "lg",
+        "xl",
+        "2xl"
+      ],
+      "value": "md"
+    },
+    "src": {
+      "type": "string|null",
+      "description": "Specifies the source for the image of the avatar.",
+      "displayName": "Src",
+      "help": "#src"
+    },
+    "iconClass": {
+      "type": "string",
+      "description": "The icon class to be displayed.",
+      "displayName": "Icon Class",
+      "help": "#iconClass"
+    },
+    "shape": {
+      "type": "string",
+      "description": "Specifies the shape of the avatar.",
+      "displayName": "Shape",
+      "help": "#shape",
+      "propertyEditorValues": {
+        "square": {
+          "description": "square avatar (default, if unspecified)",
+          "displayName": "Square Avatar"
+        },
+        "circle": {
+          "description": "circular avatar",
+          "displayName": "Circular Avatar"
+        }
+      },
+      "enumValues": [
+        "circle",
+        "square"
+      ],
+      "value": "square"
+    }
+  },
+  "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/avatar/index.js

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

package/oj-c/avatar.js

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

package/oj-c/button/__tests__/button.test.js

@@ -0,0 +1,20 @@
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+define(["require", "exports", "preact/jsx-runtime", "@jest/globals", "@testing-library/preact", "@testing-library/user-event", "../button"], function (require, exports, jsx_runtime_1, globals_1, preact_1, user_event_1, button_1) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    user_event_1 = __importDefault(user_event_1);
+    (0, globals_1.describe)('oj-c Button', () => {
+        (0, globals_1.test)('invokes onClick listener', (done) => {
+            function onClick(evt) {
+                (0, globals_1.expect)(evt.target).toEqual(button);
+                done();
+            }
+            const content = (0, preact_1.render)((0, jsx_runtime_1.jsx)(button_1.Button, Object.assign({ onOjAction: onClick }, { children: "Click me" })));
+            const button = content.getByRole('button');
+            user_event_1.default.click(button);
+        });
+        (0, globals_1.afterEach)(preact_1.cleanup);
+    });
+});

package/oj-c/button/__webdriver__/ButtonWebElement.js

@@ -0,0 +1,96 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+exports.__esModule = true;
+exports.ButtonWebElement = void 0;
+var ButtonWebElementBase_1 = require("./ButtonWebElementBase");
+/**
+ * The component WebElement for [oj-c-button](../../../oj-c/docs/oj.Button.html).
+ * Do not instantiate this class directly, instead, use
+ * [findButton](../modules.html#findButton).
+ */
+var ButtonWebElement = /** @class */ (function (_super) {
+    __extends(ButtonWebElement, _super);
+    function ButtonWebElement() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    // Put overrides here
+    /**
+     * Sets the value of <code>label</code> property.
+     * Text to show in the button.
+     * @param label The value to set for <code>label</code>
+     * @deprecated Since 14.0.0. Do not use this method to change the button label. It will be removed in the next release.
+     */
+    ButtonWebElement.prototype.changeLabel = function (label) {
+        return this.setProperty('label', label);
+    };
+    /**
+     * Sets the value of <code>disabled</code> property.
+     * Specifies that the button element should be disabled.
+     * @param disabled The value to set for <code>disabled</code>
+     * @deprecated Since 14.0.0. Do not use this method to disable the button. It will be removed in the next release.
+     */
+    ButtonWebElement.prototype.changeDisabled = function (disabled) {
+        return this.setProperty('disabled', disabled);
+    };
+    /**
+     * Sets the value of <code>width</code> property.
+     * Specifies that the button style width
+     * @param width The value to set for <code>width</code>
+     * @deprecated Since 14.0.0. Do not use this method to change the button width. It will be removed in the next release.
+     */
+    ButtonWebElement.prototype.changeWidth = function (width) {
+        return this.setProperty('width', width);
+    };
+    /**
+     * Sets the value of <code>display</code> property.
+     * Display just the label, the icons, or all. Label is used as tooltip and should be set in all cases.
+     * @param display The value to set for <code>display</code>
+     * @deprecated Since 14.0.0. Do not use this method to change the button display. It will be removed in the next release.
+     */
+    ButtonWebElement.prototype.changeDisplay = function (display) {
+        return this.setProperty('display', display);
+    };
+    /**
+     * Sets the value of <code>size</code> property.
+     * Size of button
+     * @param size The value to set for <code>size</code>
+     * @deprecated Since 14.0.0. Do not use this method to change the button size. It will be removed in the next release.
+     */
+    ButtonWebElement.prototype.changeSizeProperty = function (size) {
+        return this.setProperty('size', size);
+    };
+    /**
+     * Sets the value of <code>edge</code> property.
+     * Specifies whether the button is attached to an edge. For example setting edge='bottom' can be used to attach a button to the bottom of a card. The button is then stretched to 100% width, and borders adjusted.
+     * @param edge The value to set for <code>edge</code>
+     * @deprecated Since 14.0.0. Do not use this method to change the button edge. It will be removed in the next release.
+     */
+    ButtonWebElement.prototype.changeEdge = function (edge) {
+        return this.setProperty('edge', edge);
+    };
+    /**
+     * Sets the value of <code>chroming</code> property.
+     * Indicates in what states the button has variants in background and border.
+     * @param chroming The value to set for <code>chroming</code>
+     * @deprecated Since 14.0.0. Do not use this method to change the button chroming. It will be removed in the next release.
+     */
+    ButtonWebElement.prototype.changeChroming = function (chroming) {
+        return this.setProperty('chroming', chroming);
+    };
+    return ButtonWebElement;
+}(ButtonWebElementBase_1.ButtonWebElementBase));
+exports.ButtonWebElement = ButtonWebElement;