invenio-administration 6.0.2__py3-none-any.whl

invenio_administration/__init__.py

@@ -0,0 +1,12 @@
+# SPDX-FileCopyrightText: 2022-2024 CERN.
+# SPDX-FileCopyrightText: 2024-2026 Graz University of Technology.
+# SPDX-FileCopyrightText: 2024-2025 KTH Royal Institute of Technology.
+# SPDX-License-Identifier: MIT
+
+"""Invenio module providing extensible administration panel."""
+
+from .ext import InvenioAdministration
+
+__version__ = "6.0.2"
+
+__all__ = ["InvenioAdministration"]

invenio_administration/admin.py

@@ -0,0 +1,124 @@
+# SPDX-FileCopyrightText: 2022-2024 CERN.
+# SPDX-FileCopyrightText: 2023-2024 Graz University of Technology.
+# SPDX-FileCopyrightText: 2024 KTH Royal Institute of Technology.
+# SPDX-License-Identifier: MIT
+
+"""Invenio Administration core admin module."""
+
+from flask import Blueprint
+from flask_menu import current_menu
+from invenio_i18n import lazy_gettext as _
+from werkzeug.utils import import_string
+
+from invenio_administration.menu import AdminMenu
+
+from .views.base import AdminFormView, AdminResourceDetailView, AdminView
+
+
+class Administration:
+    """Admin views core manager."""
+
+    def __init__(
+        self,
+        app=None,
+        name=None,
+        url=None,
+        ui_endpoint=None,
+        base_template=None,
+    ):
+        """Constructor.
+
+        :param app: flask application
+        :param name: application name, defaults to "Admin"
+        :param url: base admin url to register the dashboard view and subviews
+        :param dashboard_view: home page view
+        :param ui_endpoint: base UI endpoint,
+                     leaves flexibility to implement two different admin apps,
+                     or to provide custom endpoint
+        :param base_template: base admin template.
+                     Defaults to "admin/base.html"
+        """
+        super().__init__()
+
+        self.app = app
+        self._views = []
+        self._menu = AdminMenu()
+        self._menu_key = "admin_navigation"
+        self.blueprint = None
+
+        if name is None:
+            name = _("Administration")
+        self.name = name
+
+        self.dashboard_view_class = self.load_admin_dashboard(app)
+        self.endpoint = ui_endpoint or "administration"
+        self.url = url or "/administration"
+        self.base_template = base_template or "invenio_administration/base.html"
+
+        self.create_blueprint()
+
+        if self.dashboard_view_class is not None:
+            self._add_dashboard_view()
+
+    def init_menu(self):
+        """Finalize app.
+
+        This method will be called within the finalize_app entrypoint.
+        """
+        self._menu.register_menu_entries(current_menu, self._menu_key)
+        self._menu.register_admin_entry(current_menu, self.endpoint)
+
+    def load_admin_dashboard(self, app):
+        """Load dashboard view configuration."""
+        dashboard_config = app.config["ADMINISTRATION_DASHBOARD_VIEW"]
+        dashboard_class = import_string(dashboard_config)
+        return dashboard_class
+
+    def create_blueprint(self):
+        """Create Flask blueprint."""
+        # Create blueprint and register rules
+        self.blueprint = Blueprint(
+            self.endpoint,
+            __name__,
+            url_prefix=self.url,
+            template_folder="templates",
+            static_folder="static",
+        )
+
+    @property
+    def views(self):
+        """Registered admin views."""
+        return self._views
+
+    def add_view(self, view, view_instance, *args, **kwargs):
+        """Add a view to admin views."""
+        # Validate view's class and name's uniqueness.
+        if not issubclass(view.view_class, AdminView):
+            raise TypeError(f"View class must be of type {AdminView.__name__}")
+        if any(v.view_class.name == view.view_class.name for v in self.views):
+            raise ValueError(f"View name already registered: {view.view_class.name}")
+
+        self.views.append(view)
+
+        self.blueprint.add_url_rule(
+            rule=view_instance.url,
+            view_func=view,
+        )
+
+        if not isinstance(view_instance, AdminResourceDetailView) and not isinstance(
+            view_instance, AdminFormView
+        ):
+            self._menu.add_view_to_menu(view_instance)
+
+    def _add_dashboard_view(self):
+        """Add the admin dashboard view."""
+        dashboard_instance = self.dashboard_view_class(
+            admin=self, extension_name="invenio-administration"
+        )
+        dashboard_view = self.dashboard_view_class.as_view(
+            self.dashboard_view_class.name,
+            admin=self,
+            extension_name="invenio-administration",
+        )
+
+        self.add_view(dashboard_view, dashboard_instance)

invenio_administration/assets/semantic-ui/js/invenio_administration/.eslintrc.yml

@@ -0,0 +1,6 @@
+# SPDX-FileCopyrightText: 2022 CERN.
+# SPDX-License-Identifier: MIT
+
+extends:
+  - '@inveniosoftware/eslint-config-invenio'
+  - '@inveniosoftware/eslint-config-invenio/prettier'

invenio_administration/assets/semantic-ui/js/invenio_administration/.prettierrc

@@ -0,0 +1 @@
+"@inveniosoftware/eslint-config-invenio/prettier-config.js"

invenio_administration/assets/semantic-ui/js/invenio_administration/index.js

@@ -0,0 +1,6 @@
+/*
+ * SPDX-FileCopyrightText: 2022 CERN.
+ * SPDX-License-Identifier: MIT
+ */
+
+export * from "./src";

invenio_administration/assets/semantic-ui/js/invenio_administration/package.json

@@ -0,0 +1,25 @@
+{
+  "@comment": [
+    "This package.json is needed to run the JS tests, locally and CI."
+  ],
+  "scripts": {
+    "test": "react-scripts test"
+  },
+  "devDependencies": {
+    "@testing-library/jest-dom": "^4.2.0",
+    "@testing-library/react": "^9.5.0",
+    "@testing-library/user-event": "^7.2.0",
+    "axios": "^1.7.7",
+    "coveralls": "^3.0.0",
+    "enzyme": "^3.10.0",
+    "enzyme-adapter-react-16": "^1.15.0",
+    "expect": "^26.0.0",
+    "lodash": "^4.17.0",
+    "luxon": "^1.23.0",
+    "react": "^16.13.0",
+    "react-dom": "^16.13.0",
+    "react-scripts": "^5.0.1",
+    "semantic-ui-react": "^2.1.0",
+    "react-overridable": "^0.0.3"
+  }
+}

invenio_administration/assets/semantic-ui/js/invenio_administration/src/actions/ActionModal.js

@@ -0,0 +1,44 @@
+/*
+ * SPDX-FileCopyrightText: 2022 CERN.
+ * SPDX-License-Identifier: MIT
+ */
+
+import PropTypes from "prop-types";
+import React, { Component } from "react";
+import { Modal } from "semantic-ui-react";
+import Overridable from "react-overridable";
+
+class ActionModal extends Component {
+  render() {
+    const { children, modalOpen, modalProps, resource } = this.props;
+
+    return (
+      <Overridable
+        id="InvenioAdministration.ActionModal.layout"
+        modalOpen={modalOpen}
+        // eslint-disable-next-line react/no-children-prop
+        children={children}
+        resource={resource}
+      >
+        <Modal role="dialog" open={modalOpen} {...modalProps}>
+          {children}
+        </Modal>
+      </Overridable>
+    );
+  }
+}
+
+ActionModal.propTypes = {
+  children: PropTypes.object,
+  modalOpen: PropTypes.bool,
+  modalProps: PropTypes.object,
+  resource: PropTypes.object.isRequired,
+};
+
+ActionModal.defaultProps = {
+  modalOpen: false,
+  modalProps: {},
+  children: null,
+};
+
+export default Overridable.component("InvenioAdministration.ActionModal", ActionModal);

invenio_administration/assets/semantic-ui/js/invenio_administration/src/actions/Actions.js

@@ -0,0 +1,118 @@
+/*
+ * SPDX-FileCopyrightText: 2022-2024 CERN.
+ * SPDX-License-Identifier: MIT
+ */
+
+import Edit from "./Edit";
+import Delete from "./Delete";
+import { DeleteModalTrigger } from "./DeleteModalTrigger";
+import React, { Component } from "react";
+import PropTypes from "prop-types";
+import isEmpty from "lodash/isEmpty";
+import ResourceActions from "./ResourceActions";
+import { Button, Dropdown } from "semantic-ui-react";
+import { i18next } from "@translations/invenio_administration/i18next";
+import _get from "lodash/get";
+
+export class Actions extends Component {
+  render() {
+    const {
+      title,
+      resourceName,
+      actions,
+      resource,
+      successCallback,
+      idKeyPath,
+      editUrl,
+      displayEdit,
+      displayDelete,
+      displayAsDropdown,
+    } = this.props;
+
+    // if number of actions is greater than 3, we display all in a dropdown
+    const _displayAsDropdown =
+      displayAsDropdown ||
+      (displayEdit && displayDelete && Object.keys(actions).length > 1);
+
+    if (_displayAsDropdown) {
+      return (
+        <Dropdown
+          trigger={
+            <Button
+              icon="cog"
+              size="tiny"
+              className="transparent rel-ml-1"
+              aria-label={i18next.t("Open list of actions")}
+            />
+          }
+        >
+          <Dropdown.Menu>
+            {!isEmpty(actions) && (
+              <ResourceActions
+                resource={resource}
+                successCallback={successCallback}
+                idKeyPath={idKeyPath}
+                actions={actions}
+                Element={Dropdown.Item}
+              />
+            )}
+            {displayEdit && <Edit editUrl={editUrl} resource={resource} />}
+            {displayDelete && (
+              <DeleteModalTrigger
+                title={title}
+                resourceName={resourceName}
+                apiEndpoint={_get(resource, "links.self")}
+                resource={resource}
+                successCallback={successCallback}
+                idKeyPath={idKeyPath}
+                Element={Dropdown.Item}
+              />
+            )}
+          </Dropdown.Menu>
+        </Dropdown>
+      );
+    } else {
+      return (
+        <>
+          {!isEmpty(actions) && (
+            <ResourceActions
+              resource={resource}
+              successCallback={successCallback}
+              idKeyPath={idKeyPath}
+              actions={actions}
+            />
+          )}
+          {displayEdit && <Edit editUrl={editUrl} resource={resource} />}
+          {displayDelete && (
+            <Delete
+              successCallback={successCallback}
+              resource={resource}
+              resourceName={resourceName}
+              title={title}
+            />
+          )}
+        </>
+      );
+    }
+  }
+}
+
+Actions.propTypes = {
+  title: PropTypes.string.isRequired,
+  resourceName: PropTypes.string.isRequired,
+  displayEdit: PropTypes.bool,
+  displayDelete: PropTypes.bool,
+  displayAsDropdown: PropTypes.bool,
+  resource: PropTypes.object.isRequired,
+  successCallback: PropTypes.func.isRequired,
+  idKeyPath: PropTypes.string,
+  actions: PropTypes.object.isRequired,
+  editUrl: PropTypes.string.isRequired,
+};
+
+Actions.defaultProps = {
+  displayEdit: true,
+  displayDelete: true,
+  displayAsDropdown: false,
+  idKeyPath: "pid",
+};

invenio_administration/assets/semantic-ui/js/invenio_administration/src/actions/Delete.js

@@ -0,0 +1,67 @@
+/*
+ * SPDX-FileCopyrightText: 2022-2024 CERN.
+ * SPDX-License-Identifier: MIT
+ */
+
+import { DeleteModalTrigger } from "./DeleteModalTrigger";
+import React, { Component } from "react";
+import PropTypes from "prop-types";
+import { Popup } from "semantic-ui-react";
+import { i18next } from "@translations/invenio_administration/i18next";
+import _get from "lodash/get";
+import Overridable from "react-overridable";
+
+class DeleteCmp extends Component {
+  render() {
+    const {
+      disabledMessage,
+      disable,
+      title,
+      resourceName,
+      successCallback,
+      idKeyPath,
+      resource,
+    } = this.props;
+
+    const disabled = disable(resource);
+
+    return (
+      <Popup
+        content={disabledMessage}
+        disabled={!disabled}
+        trigger={
+          <span>
+            <DeleteModalTrigger
+              title={title}
+              resourceName={resourceName}
+              resource={resource}
+              successCallback={successCallback}
+              idKeyPath={idKeyPath}
+              disabled={disabled}
+              apiEndpoint={_get(resource, "links.self")}
+              disabledDeleteMessage={disabledMessage}
+            />
+          </span>
+        }
+      />
+    );
+  }
+}
+
+DeleteCmp.propTypes = {
+  disabledMessage: PropTypes.string,
+  title: PropTypes.string.isRequired,
+  resourceName: PropTypes.string.isRequired,
+  successCallback: PropTypes.func.isRequired,
+  idKeyPath: PropTypes.string,
+  disable: PropTypes.func,
+  resource: PropTypes.object.isRequired,
+};
+
+DeleteCmp.defaultProps = {
+  disabledMessage: i18next.t("Resource is not deletable."),
+  idKeyPath: "pid",
+  disable: () => false,
+};
+
+export default Overridable.component("InvenioAdministration.DeleteAction", DeleteCmp);

invenio_administration/assets/semantic-ui/js/invenio_administration/src/actions/DeleteModal.js

@@ -0,0 +1,118 @@
+/*
+ * SPDX-FileCopyrightText: 2022 CERN.
+ * SPDX-FileCopyrightText: 2024 KTH Royal Institute of Technology.
+ * SPDX-License-Identifier: MIT
+ */
+
+import React, { Component } from "react";
+import PropTypes from "prop-types";
+import { Button, Icon } from "semantic-ui-react";
+import { i18next } from "@translations/invenio_administration/i18next";
+import { Modal } from "semantic-ui-react";
+import isEmpty from "lodash/isEmpty";
+import { ErrorMessage } from "../ui_messages/messages";
+import { NotificationContext } from "../ui_messages/context";
+import Overridable from "react-overridable";
+import { InvenioAdministrationActionsApi } from "../api/actions";
+
+class DeleteModal extends Component {
+  constructor(props) {
+    super(props);
+    this.state = { loading: false, error: undefined };
+    this.cancelButton = React.createRef();
+  }
+
+  componentDidUpdate() {
+    this.cancelButton.current?.focus();
+  }
+
+  static contextType = NotificationContext;
+
+  cleanError = () => {
+    this.setState({ error: undefined });
+  };
+
+  handleOnButtonClick = async () => {
+    const { successCallback, apiEndpoint, toggleModal } = this.props;
+    const { addNotification } = this.context;
+    try {
+      await InvenioAdministrationActionsApi.deleteResource(apiEndpoint);
+      toggleModal(false);
+      addNotification({
+        title: i18next.t("Success"),
+        content: i18next.t("Resource was successfully deleted."),
+        type: "success",
+      });
+      successCallback();
+    } catch (e) {
+      this.setState({
+        error: { header: i18next.t("Action error"), content: e.message, id: e.code },
+      });
+    }
+  };
+
+  resetErrorState = () => {
+    this.setState({ error: undefined });
+  };
+
+  render() {
+    const { loading, error } = this.state;
+    const { modalOpen, toggleModal, children, title } = this.props;
+    return (
+      <Overridable
+        id="DeleteModal.layout"
+        {...this.props}
+        handleOnButtonClick={this.handleOnButtonClick}
+        cleanError={this.cleanError}
+        resetErrorState={this.resetErrorState}
+      >
+        <Modal role="dialog" open={modalOpen}>
+          <Modal.Header as="h2">
+            {i18next.t("Delete {{title}}", { title: title })}
+          </Modal.Header>
+          <Modal.Content>
+            <Modal.Description>
+              {children}
+              {!isEmpty(error) && (
+                <ErrorMessage {...error} removeNotification={this.resetErrorState} />
+              )}
+            </Modal.Description>
+          </Modal.Content>
+          <Modal.Actions>
+            <Button
+              ref={this.cancelButton}
+              icon="cancel"
+              onClick={() => {
+                this.cleanError();
+                toggleModal(false);
+              }}
+              loading={loading}
+              content={i18next.t("Cancel")}
+              floated="left"
+              size="medium"
+            />
+            <Button negative onClick={this.handleOnButtonClick} loading={loading}>
+              <Icon name="trash alternate" />
+              {i18next.t("Delete")}
+            </Button>
+          </Modal.Actions>
+        </Modal>
+      </Overridable>
+    );
+  }
+}
+
+DeleteModal.propTypes = {
+  title: PropTypes.string.isRequired,
+  apiEndpoint: PropTypes.string.isRequired,
+  successCallback: PropTypes.func.isRequired,
+  toggleModal: PropTypes.func.isRequired,
+  modalOpen: PropTypes.bool.isRequired,
+  children: PropTypes.node,
+};
+
+DeleteModal.defaultProps = {
+  children: null,
+};
+
+export default Overridable.component("DeleteModal", DeleteModal);

invenio_administration/assets/semantic-ui/js/invenio_administration/src/actions/DeleteModalTrigger.js

@@ -0,0 +1,97 @@
+/*
+ * SPDX-FileCopyrightText: 2022 CERN.
+ * SPDX-License-Identifier: MIT
+ */
+
+import React, { Component } from "react";
+import PropTypes from "prop-types";
+import { i18next } from "@translations/invenio_administration/i18next";
+import { Button, Icon } from "semantic-ui-react";
+import DeleteModal from "./DeleteModal";
+import { Modal } from "semantic-ui-react";
+import _get from "lodash/get";
+import Overridable from "react-overridable";
+
+export class DeleteModalTrigger extends Component {
+  constructor(props) {
+    super(props);
+    this.state = { modalOpen: false };
+  }
+
+  toggleModal = (open) => {
+    this.setState({ modalOpen: open });
+  };
+
+  render() {
+    const {
+      title,
+      resourceName,
+      apiEndpoint,
+      resource,
+      successCallback,
+      idKeyPath,
+      Element,
+      disabled,
+      disabledDeleteMessage,
+    } = this.props;
+    const { modalOpen } = this.state;
+    const triggerId = `delete-modal-trigger-${resource.id}`;
+    return (
+      <Overridable id="InvenioAdministration.DeleteModalTrigger">
+        <>
+          <Element
+            id={triggerId}
+            disabled={disabled}
+            icon
+            negative
+            onClick={() => this.toggleModal(true)}
+            aria-label={i18next.t("Delete")}
+            aria-controls="delete-modal"
+            aria-expanded={modalOpen}
+            aria-haspopup="dialog"
+            title={disabledDeleteMessage}
+          >
+            <Icon name="trash alternate" />
+          </Element>
+          <DeleteModal
+            id="delete-modal"
+            aria-labelledby={triggerId}
+            title={title}
+            apiEndpoint={apiEndpoint}
+            resource={resource}
+            successCallback={successCallback}
+            idKeyPath={idKeyPath}
+            toggleModal={this.toggleModal}
+            modalOpen={modalOpen}
+          >
+            <Modal.Content>
+              <Modal.Description>
+                {i18next.t("Are you sure you want to delete {{resourceName}}?", {
+                  resourceName: _get(resource, resourceName),
+                })}
+              </Modal.Description>
+            </Modal.Content>
+          </DeleteModal>
+        </>
+      </Overridable>
+    );
+  }
+}
+
+DeleteModalTrigger.propTypes = {
+  title: PropTypes.string.isRequired,
+  resourceName: PropTypes.string.isRequired,
+  apiEndpoint: PropTypes.string.isRequired,
+  resource: PropTypes.object.isRequired,
+  successCallback: PropTypes.func.isRequired,
+  Element: PropTypes.object,
+  idKeyPath: PropTypes.string.isRequired,
+  disabled: PropTypes.bool,
+  disabledDeleteMessage: PropTypes.string,
+};
+
+DeleteModalTrigger.defaultProps = {
+  Element: Button,
+  disabled: false,
+  disabledDeleteMessage: "",
+};

invenio_administration/assets/semantic-ui/js/invenio_administration/src/actions/Edit.js

@@ -0,0 +1,52 @@
+/*
+ * SPDX-FileCopyrightText: 2022 CERN.
+ * SPDX-License-Identifier: MIT
+ */
+
+import PropTypes from "prop-types";
+import React, { Component } from "react";
+import { i18next } from "@translations/invenio_administration/i18next";
+import { Button, Popup, Icon } from "semantic-ui-react";
+import Overridable from "react-overridable";
+
+class EditCmp extends Component {
+  render() {
+    const { display, editUrl, disable, disabledMessage, resource } = this.props;
+    if (!display) {
+      return null;
+    }
+    const disabled = disable(resource);
+
+    return (
+      <Popup
+        content={disabledMessage}
+        disabled={!disabled}
+        trigger={
+          <span className="mr-5">
+            <Button as="a" disabled={disabled} href={editUrl} icon labelPosition="left">
+              <Icon name="pencil" />
+              {i18next.t("Edit")}
+            </Button>
+          </span>
+        }
+      />
+    );
+  }
+}
+
+EditCmp.propTypes = {
+  display: PropTypes.bool,
+  editUrl: PropTypes.string.isRequired,
+  disable: PropTypes.func,
+  disabledMessage: PropTypes.string,
+  resource: PropTypes.object,
+};
+
+EditCmp.defaultProps = {
+  display: true,
+  disable: () => false,
+  disabledMessage: i18next.t("Resource is not editable."),
+  resource: undefined,
+};
+
+export default Overridable.component("InvenioAdministration.EditAction", EditCmp);