invenio-vocabularies 1.2.0__py2.py3-none-any.whl → 6.3.1__py2.py3-none-any.whl

invenio_vocabularies/assets/semantic-ui/js/invenio_vocabularies/src/contrib/forms/Funding/FundingField.js

@@ -0,0 +1,223 @@
+// This file is part of InvenioVocabularies
+// Copyright (C) 2021-2024 CERN.
+// Copyright (C) 2021 Northwestern University.
+//
+// Invenio is free software; you can redistribute it and/or modify it
+// under the terms of the MIT License; see LICENSE file for more details.
+
+import React from "react";
+import PropTypes from "prop-types";
+import { FieldArray, getIn } from "formik";
+import { HTML5Backend } from "react-dnd-html5-backend";
+import { DndProvider } from "react-dnd";
+import { Button, Form, Icon, List } from "semantic-ui-react";
+import { FieldLabel } from "react-invenio-forms";
+
+import { FundingFieldItem } from "./FundingFieldItem";
+import FundingModal from "./FundingModal";
+
+import { i18next } from "@translations/invenio_rdm_records/i18next";
+
+import Overridable from "react-overridable";
+
+function FundingFieldForm(props) {
+  const {
+    label,
+    labelIcon,
+    fieldPath,
+    form: { values },
+    move: formikArrayMove,
+    push: formikArrayPush,
+    remove: formikArrayRemove,
+    replace: formikArrayReplace,
+    required,
+    deserializeAward: deserializeAwardFunc,
+    deserializeFunder: deserializeFunderFunc,
+    computeFundingContents: computeFundingContentsFunc,
+    searchConfig,
+  } = props;
+
+  const deserializeAward = deserializeAwardFunc
+    ? deserializeAwardFunc
+    : (award) => ({
+        title: award?.title_l10n,
+        number: award.number,
+        funder: award.funder ?? "",
+        id: award.id,
+        ...(award.identifiers && { identifiers: award.identifiers }),
+        ...(award.acronym && { acronym: award.acronym }),
+      });
+
+  const deserializeFunder = deserializeFunderFunc
+    ? deserializeFunderFunc
+    : (funder) => ({
+        id: funder.id,
+        name: funder.name,
+        ...(funder.pid && { pid: funder.pid }),
+        ...(funder.country && { country: funder.country }),
+        ...(funder.identifiers && { identifiers: funder.identifiers }),
+      });
+
+  const computeFundingContents = computeFundingContentsFunc
+    ? computeFundingContentsFunc
+    : (funding) => {
+        let headerContent,
+          descriptionContent = "";
+        let awardOrFunder = "award";
+        if (funding.award) {
+          headerContent = funding.award.title;
+        }
+
+        if (funding.funder) {
+          const funderName =
+            funding?.funder?.name ?? funding.funder?.title ?? funding?.funder?.id ?? "";
+          descriptionContent = funderName;
+          if (!headerContent) {
+            awardOrFunder = "funder";
+            headerContent = funderName;
+            descriptionContent = "";
+          }
+        }
+
+        return { headerContent, descriptionContent, awardOrFunder };
+      };
+  return (
+    <DndProvider backend={HTML5Backend}>
+      <Form.Field required={required}>
+        <FieldLabel htmlFor={fieldPath} icon={labelIcon} label={label} />
+        <List>
+          {getIn(values, fieldPath, []).map((value, index) => {
+            const key = `${fieldPath}.${index}`;
+            // if award does not exist or has no id, it's a custom one
+            const awardType = value?.award?.id ? "standard" : "custom";
+            return (
+              <FundingFieldItem
+                key={key}
+                {...{
+                  index,
+                  compKey: key,
+                  fundingItem: value,
+                  awardType,
+                  moveFunding: formikArrayMove,
+                  replaceFunding: formikArrayReplace,
+                  removeFunding: formikArrayRemove,
+                  searchConfig: searchConfig,
+                  computeFundingContents: computeFundingContents,
+                  deserializeAward: deserializeAward,
+                  deserializeFunder: deserializeFunder,
+                }}
+              />
+            );
+          })}
+        </List>
+
+        <Overridable id="InvenioVocabularies.FundingField.AddAwardFundingModal.Container">
+          <FundingModal
+            searchConfig={searchConfig}
+            trigger={
+              <Button
+                type="button"
+                key="custom"
+                icon
+                labelPosition="left"
+                className="mb-5"
+              >
+                <Icon name="add" />
+                {i18next.t("Add")}
+              </Button>
+            }
+            onAwardChange={(selectedFunding) => {
+              formikArrayPush(selectedFunding);
+            }}
+            mode="standard"
+            action="add"
+            deserializeAward={deserializeAward}
+            deserializeFunder={deserializeFunder}
+            computeFundingContents={computeFundingContents}
+          />
+        </Overridable>
+
+        <Overridable id="InvenioVocabularies.FundingField.AddCustomFundingModal.Container">
+          <FundingModal
+            searchConfig={searchConfig}
+            trigger={
+              <Button type="button" key="custom" icon labelPosition="left">
+                <Icon name="add" />
+                {i18next.t("Add custom")}
+              </Button>
+            }
+            onAwardChange={(selectedFunding) => {
+              formikArrayPush(selectedFunding);
+            }}
+            mode="custom"
+            action="add"
+            deserializeAward={deserializeAward}
+            deserializeFunder={deserializeFunder}
+            computeFundingContents={computeFundingContents}
+          />
+        </Overridable>
+      </Form.Field>
+    </DndProvider>
+  );
+}
+
+FundingFieldForm.propTypes = {
+  label: PropTypes.node,
+  labelIcon: PropTypes.node,
+  fieldPath: PropTypes.string.isRequired,
+  form: PropTypes.object,
+  move: PropTypes.func,
+  push: PropTypes.func,
+  remove: PropTypes.func,
+  replace: PropTypes.func,
+  required: PropTypes.bool,
+  deserializeAward: PropTypes.func,
+  deserializeFunder: PropTypes.func,
+  computeFundingContents: PropTypes.func,
+  searchConfig: PropTypes.object,
+};
+
+FundingFieldForm.defaultProps = {
+  label: undefined,
+  labelIcon: undefined,
+  form: undefined,
+  move: undefined,
+  push: undefined,
+  remove: undefined,
+  replace: undefined,
+  required: undefined,
+  deserializeAward: undefined,
+  deserializeFunder: undefined,
+  computeFundingContents: undefined,
+  searchConfig: undefined,
+};
+
+export function FundingField(props) {
+  const { fieldPath } = props;
+  return (
+    <FieldArray
+      name={fieldPath}
+      component={(formikProps) => <FundingFieldForm {...formikProps} {...props} />}
+    />
+  );
+}
+
+FundingField.propTypes = {
+  fieldPath: PropTypes.string.isRequired,
+  label: PropTypes.string,
+  labelIcon: PropTypes.string,
+  searchConfig: PropTypes.object.isRequired,
+  required: PropTypes.bool,
+  deserializeAward: PropTypes.func,
+  deserializeFunder: PropTypes.func,
+  computeFundingContents: PropTypes.func,
+};
+
+FundingField.defaultProps = {
+  label: "Awards",
+  labelIcon: "money bill alternate outline",
+  required: false,
+  deserializeAward: undefined,
+  deserializeFunder: undefined,
+  computeFundingContents: undefined,
+};

invenio_vocabularies/assets/semantic-ui/js/invenio_vocabularies/src/contrib/forms/Funding/FundingField.test.js

@@ -0,0 +1 @@
+it("can contain tests", () => {});

invenio_vocabularies/assets/semantic-ui/js/invenio_vocabularies/src/contrib/forms/Funding/FundingFieldItem.js

@@ -0,0 +1,152 @@
+// This file is part of InvenioVocabularies
+// Copyright (C) 2021-2023 CERN.
+// Copyright (C) 2021 Northwestern University.
+// Copyright (C) 2021 Graz University of Technology.
+//
+// Invenio is free software; you can redistribute it and/or modify it
+// under the terms of the MIT License; see LICENSE file for more details.
+
+import { i18next } from "@translations/invenio_rdm_records/i18next";
+import React from "react";
+import { useDrag, useDrop } from "react-dnd";
+import { Button, Icon, Label, List, Ref } from "semantic-ui-react";
+
+import FundingModal from "./FundingModal";
+import PropTypes from "prop-types";
+
+export const FundingFieldItem = ({
+  compKey,
+  index,
+  fundingItem,
+  awardType,
+  moveFunding,
+  replaceFunding,
+  removeFunding,
+  searchConfig,
+  deserializeAward,
+  deserializeFunder,
+  computeFundingContents,
+}) => {
+  const dropRef = React.useRef(null);
+  // eslint-disable-next-line no-unused-vars
+  const [_, drag, preview] = useDrag({
+    item: { index, type: "award" },
+  });
+  const [{ hidden }, drop] = useDrop({
+    accept: "award",
+    hover(item, monitor) {
+      if (!dropRef.current) {
+        return;
+      }
+      const dragIndex = item.index;
+      const hoverIndex = index;
+
+      // Don't replace items with themselves
+      if (dragIndex === hoverIndex) {
+        return;
+      }
+
+      if (monitor.isOver({ shallow: true })) {
+        moveFunding(dragIndex, hoverIndex);
+        item.index = hoverIndex;
+      }
+    },
+    collect: (monitor) => ({
+      hidden: monitor.isOver({ shallow: true }),
+    }),
+  });
+
+  let { headerContent, descriptionContent, awardOrFunder } =
+    computeFundingContents(fundingItem);
+
+  // Initialize the ref explicitely
+  drop(dropRef);
+  return (
+    <Ref innerRef={dropRef} key={compKey}>
+      <List.Item
+        key={compKey}
+        className={hidden ? "deposit-drag-listitem hidden" : "deposit-drag-listitem"}
+      >
+        <List.Content floated="right">
+          <FundingModal
+            searchConfig={searchConfig}
+            onAwardChange={(selectedFunding) => {
+              replaceFunding(index, selectedFunding);
+            }}
+            mode={awardType}
+            action="edit"
+            trigger={
+              <Button size="mini" primary type="button">
+                {i18next.t("Edit")}
+              </Button>
+            }
+            deserializeAward={deserializeAward}
+            deserializeFunder={deserializeFunder}
+            computeFundingContents={computeFundingContents}
+            initialFunding={fundingItem}
+          />
+          <Button size="mini" type="button" onClick={() => removeFunding(index)}>
+            {i18next.t("Remove")}
+          </Button>
+        </List.Content>
+
+        <Ref innerRef={drag}>
+          <List.Icon name="bars" className="drag-anchor" />
+        </Ref>
+        <Ref innerRef={preview}>
+          <List.Content>
+            <List.Header>
+              <>
+                <span className="mr-5">{headerContent}</span>
+
+                {awardOrFunder === "award"
+                  ? fundingItem?.award?.number && (
+                      <Label basic size="mini" className="mr-5">
+                        {fundingItem.award.number}
+                      </Label>
+                    )
+                  : ""}
+                {awardOrFunder === "award"
+                  ? fundingItem?.award?.url && (
+                      <a
+                        href={`${fundingItem.award.url}`}
+                        target="_blank"
+                        rel="noopener noreferrer"
+                        aria-label={i18next.t("Open external link")}
+                      >
+                        <Icon link name="external alternate" />
+                      </a>
+                    )
+                  : ""}
+              </>
+            </List.Header>
+            <List.Description>
+              {descriptionContent ? descriptionContent : <br />}
+            </List.Description>
+          </List.Content>
+        </Ref>
+      </List.Item>
+    </Ref>
+  );
+};
+
+FundingFieldItem.propTypes = {
+  compKey: PropTypes.any,
+  index: PropTypes.number,
+  fundingItem: PropTypes.object,
+  awardType: PropTypes.string,
+  moveFunding: PropTypes.func.isRequired,
+  replaceFunding: PropTypes.func.isRequired,
+  removeFunding: PropTypes.func.isRequired,
+  searchConfig: PropTypes.object.isRequired,
+  deserializeAward: PropTypes.func.isRequired,
+  deserializeFunder: PropTypes.func.isRequired,
+  computeFundingContents: PropTypes.func.isRequired,
+};
+
+FundingFieldItem.defaultProps = {
+  compKey: undefined,
+  index: undefined,
+  fundingItem: undefined,
+  awardType: undefined,
+};

invenio_vocabularies/assets/semantic-ui/js/invenio_vocabularies/src/contrib/forms/Funding/FundingModal.js

@@ -0,0 +1,270 @@
+// This file is part of InvenioVocabularies
+// Copyright (C) 2021-2024 CERN.
+// Copyright (C) 2021 Northwestern University.
+//
+// Invenio is free software; you can redistribute it and/or modify it
+// under the terms of the MIT License; see LICENSE file for more details.
+
+import { i18next } from "@translations/invenio_rdm_records/i18next";
+import { Formik } from "formik";
+import PropTypes from "prop-types";
+import React, { useState } from "react";
+import {
+  EmptyResults,
+  Error,
+  InvenioSearchApi,
+  Pagination,
+  ReactSearchKit,
+  ResultsLoader,
+  SearchBar,
+} from "react-searchkit";
+import { Grid, Modal, Container, Button } from "semantic-ui-react";
+import * as Yup from "yup";
+import { AwardResults } from "./AwardResults";
+import CustomAwardForm from "./CustomAwardForm";
+import { FunderDropdown } from "./FunderDropdown";
+import { NoAwardResults } from "./NoAwardResults";
+
+const ModalTypes = {
+  STANDARD: "standard",
+  CUSTOM: "custom",
+};
+
+const ModalActions = {
+  ADD: "add",
+  EDIT: "edit",
+};
+
+const StandardSchema = Yup.object().shape({
+  selectedFunding: Yup.object().shape({
+    funder: Yup.object().shape({
+      id: Yup.string().required(),
+    }),
+    award: Yup.object().shape({
+      id: Yup.string().required(),
+    }),
+  }),
+});
+
+const CustomFundingSchema = Yup.object().shape({
+  selectedFunding: Yup.object().shape({
+    funder: Yup.object().shape({
+      id: Yup.string().required(i18next.t("Funder is required.")),
+    }),
+    award: Yup.object().shape({
+      title: Yup.string().test({
+        name: "testTitle",
+        message: i18next.t("Title must be set alongside number."),
+        test: function testTitle(value) {
+          const { number } = this.parent;
+
+          if (number && !value) {
+            return false;
+          }
+
+          return true;
+        },
+      }),
+      number: Yup.string().test({
+        name: "testNumber",
+        message: i18next.t("Number must be set alongside title."),
+        test: function testNumber(value) {
+          const { title } = this.parent;
+
+          if (title && !value) {
+            return false;
+          }
+
+          return true;
+        },
+      }),
+      url: Yup.string()
+        .url(i18next.t("URL must be valid."))
+        .test({
+          name: "validateUrlDependencies",
+          message: i18next.t("URL must be set alongside title and number."),
+          test: function testUrl(value) {
+            const { title, number } = this.parent;
+
+            if (value && value !== "" && !title && !number) {
+              return false;
+            }
+
+            return true;
+          },
+        }),
+    }),
+  }),
+});
+
+function FundingModal({
+  action,
+  mode: initialMode,
+  trigger,
+  onAwardChange,
+  searchConfig,
+  deserializeAward,
+  deserializeFunder,
+  computeFundingContents,
+  ...props
+}) {
+  const [open, setOpen] = useState(false);
+  const [mode, setMode] = useState(initialMode);
+  const openModal = () => setOpen(true);
+  const closeModal = () => {
+    setMode(initialMode);
+    setOpen(false);
+  };
+  const onSubmit = (values, formikBag) => {
+    formikBag.setSubmitting(false);
+    formikBag.resetForm();
+    setMode(initialMode);
+    closeModal();
+    onAwardChange(values.selectedFunding);
+  };
+
+  const searchApi = new InvenioSearchApi(searchConfig.searchApi);
+  const customObject = mode === ModalTypes.CUSTOM ? props.initialFunding : {};
+  const initialFunding = {
+    selectedFunding: action === ModalActions.EDIT ? customObject : {},
+  };
+
+  const FundingSchema =
+    mode === ModalTypes.CUSTOM ? CustomFundingSchema : StandardSchema;
+
+  return (
+    <Formik
+      initialValues={initialFunding}
+      onSubmit={onSubmit}
+      validationSchema={FundingSchema}
+      validateOnChange={false}
+      validateOnBlur={false}
+      enableReinitialize
+    >
+      {({ values, resetForm, handleSubmit }) => (
+        <Modal
+          role="dialog"
+          centered={false}
+          onOpen={openModal}
+          open={open}
+          trigger={React.cloneElement(trigger, {
+            "aria-expanded": open,
+            "aria-haspopup": "dialog",
+          })}
+          onClose={closeModal}
+          closeIcon
+          closeOnDimmerClick={false}
+        >
+          <Modal.Header as="h2" className="pt-10 pb-10">
+            {mode === "standard"
+              ? i18next.t("Add standard award/grant")
+              : i18next.t("Add custom funding")}
+          </Modal.Header>
+          <Modal.Content>
+            {mode === ModalTypes.STANDARD && (
+              <ReactSearchKit
+                searchApi={searchApi}
+                appName="awards"
+                urlHandlerApi={{ enabled: false }}
+                initialQueryState={searchConfig.initialQueryState}
+              >
+                <Grid className="m-0">
+                  <Grid.Row>
+                    <Grid.Column width={11} floated="left" verticalAlign="middle">
+                      <SearchBar
+                        placeholder={i18next.t("Search for awards/grants")}
+                        autofocus
+                        actionProps={{
+                          icon: "search",
+                          content: null,
+                          className: "search",
+                        }}
+                      />
+                    </Grid.Column>
+                    <Grid.Column width={5} floated="right" textAlign="right">
+                      <FunderDropdown />
+                    </Grid.Column>
+                  </Grid.Row>
+
+                  <Grid.Column width={16} className="pb-0">
+                    <ResultsLoader>
+                      <EmptyResults />
+                      <Error />
+                      <AwardResults
+                        deserializeAward={deserializeAward}
+                        deserializeFunder={deserializeFunder}
+                        computeFundingContents={computeFundingContents}
+                      />
+                    </ResultsLoader>
+                    <Container textAlign="center" className="rel-mb-1">
+                      <Pagination />
+                    </Container>
+                  </Grid.Column>
+
+                  <Grid.Column width={16} textAlign="center" className="pt-0 pb-0">
+                    <NoAwardResults
+                      switchToCustom={() => {
+                        resetForm();
+                        setMode(ModalTypes.CUSTOM);
+                      }}
+                    />
+                  </Grid.Column>
+                </Grid>
+              </ReactSearchKit>
+            )}
+            {mode === ModalTypes.CUSTOM && (
+              <CustomAwardForm
+                deserializeFunder={deserializeFunder}
+                selectedFunding={values.selectedFunding}
+              />
+            )}
+          </Modal.Content>
+          <Modal.Actions>
+            <Button
+              onClick={() => {
+                resetForm();
+                closeModal();
+              }}
+              icon="remove"
+              content={i18next.t("Cancel")}
+              floated="left"
+            />
+            <Button
+              onClick={(event) => handleSubmit(event)}
+              primary
+              icon="checkmark"
+              content={
+                action === ModalActions.ADD ? i18next.t("Add") : i18next.t("Change")
+              }
+            />
+          </Modal.Actions>
+        </Modal>
+      )}
+    </Formik>
+  );
+}
+
+FundingModal.propTypes = {
+  mode: PropTypes.oneOf(["standard", "custom"]).isRequired,
+  action: PropTypes.oneOf(["add", "edit"]).isRequired,
+  trigger: PropTypes.object.isRequired,
+  onAwardChange: PropTypes.func.isRequired,
+  searchConfig: PropTypes.shape({
+    searchApi: PropTypes.shape({
+      axios: PropTypes.shape({
+        headers: PropTypes.object,
+      }),
+    }).isRequired,
+    initialQueryState: PropTypes.object.isRequired,
+  }).isRequired,
+  deserializeAward: PropTypes.func.isRequired,
+  deserializeFunder: PropTypes.func.isRequired,
+  computeFundingContents: PropTypes.func.isRequired,
+  initialFunding: PropTypes.object,
+};
+
+FundingModal.defaultProps = {
+  initialFunding: undefined,
+};
+
+export default FundingModal;

invenio_vocabularies/assets/semantic-ui/js/invenio_vocabularies/src/contrib/forms/Funding/NoAwardResults.js

@@ -0,0 +1,37 @@
+// This file is part of InvenioVocabularies
+// Copyright (C) 2021-2024 CERN.
+// Copyright (C) 2021 Northwestern University.
+//
+// Invenio is free software; you can redistribute it and/or modify it
+// under the terms of the MIT License; see LICENSE file for more details.
+
+import PropTypes from "prop-types";
+import React from "react";
+import { Segment } from "semantic-ui-react";
+import { i18next } from "@translations/invenio_rdm_records/i18next";
+
+export function NoAwardResults({ switchToCustom }) {
+  return (
+    <Segment
+      basic
+      content={
+        <p>
+          {i18next.t("Did not find your award/grant? ")}
+          <a
+            href="/"
+            onClick={(e) => {
+              e.preventDefault();
+              switchToCustom();
+            }}
+          >
+            {i18next.t("Add a custom award/grant.")}
+          </a>
+        </p>
+      }
+    />
+  );
+}
+
+NoAwardResults.propTypes = {
+  switchToCustom: PropTypes.func.isRequired,
+};

invenio_vocabularies/assets/semantic-ui/js/invenio_vocabularies/src/contrib/forms/Funding/index.js

@@ -0,0 +1,8 @@
+// This file is part of InvenioVocabularies
+// Copyright (C) 2021-2023 CERN.
+// Copyright (C) 2021 Northwestern University.
+//
+// Invenio is free software; you can redistribute it and/or modify it
+// under the terms of the MIT License; see LICENSE file for more details.
+
+export { FundingField } from "./FundingField";

invenio_vocabularies/assets/semantic-ui/js/invenio_vocabularies/src/contrib/forms/index.js

@@ -0,0 +1,7 @@
+// This file is part of InvenioVocabularies
+// Copyright (C) 2023 CERN.
+//
+// Invenio is free software; you can redistribute it and/or modify it
+// under the terms of the MIT License; see LICENSE file for more details.
+
+export { FundingField } from "./Funding";