invenio-vocabularies 9.1.2__py2.py3-none-any.whl

invenio_vocabularies/assets/semantic-ui/js/invenio_vocabularies/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": "^1.0.0"
+  }
+}

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

@@ -0,0 +1,95 @@
+// 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.
+
+import React from "react";
+import PropTypes from "prop-types";
+import _get from "lodash/get";
+import { Item, Header, Radio, Label, Icon } from "semantic-ui-react";
+import { withState } from "react-searchkit";
+import { FastField } from "formik";
+
+export const AwardResults = withState(
+  ({
+    currentResultsState: results,
+    deserializeAward,
+    deserializeFunder,
+    computeFundingContents,
+  }) => {
+    return (
+      <FastField name="selectedFunding">
+        {({ form: { values, setFieldValue } }) => {
+          return (
+            <Item.Group>
+              {results.data.hits.map((award) => {
+                let funder = award?.funder;
+                const deserializedAward = deserializeAward(award);
+                const deserializedFunder = deserializeFunder(funder);
+                const funding = {
+                  award: deserializedAward,
+                  funder: deserializedFunder,
+                };
+                let { headerContent, descriptionContent, awardOrFunder } =
+                  computeFundingContents(funding);
+
+                return (
+                  <Item
+                    key={deserializedAward.id}
+                    onClick={() => setFieldValue("selectedFunding", funding)}
+                    className="license-item"
+                  >
+                    <Radio
+                      checked={
+                        _get(values, "selectedFunding.award.id") === funding.award.id
+                      }
+                      onChange={() => setFieldValue("selectedFunding", funding)}
+                    />
+                    <Item.Content className="license-item-content">
+                      <Header size="small">
+                        {headerContent}
+                        {awardOrFunder === "award"
+                          ? award.number && (
+                              <Label basic size="mini">
+                                {award.number}
+                              </Label>
+                            )
+                          : ""}
+                        {awardOrFunder === "award"
+                          ? award.url && (
+                              <a
+                                href={`${award.url}`}
+                                target="_blank"
+                                rel="noopener noreferrer"
+                              >
+                                <Icon
+                                  link
+                                  name="external alternate"
+                                  className="spaced-left"
+                                />
+                              </a>
+                            )
+                          : ""}
+                      </Header>
+                      <Item.Description className="license-item-description">
+                        {descriptionContent}
+                      </Item.Description>
+                    </Item.Content>
+                  </Item>
+                );
+              })}
+            </Item.Group>
+          );
+        }}
+      </FastField>
+    );
+  }
+);
+
+AwardResults.propTypes = {
+  deserializeAward: PropTypes.func.isRequired,
+  deserializeFunder: PropTypes.func.isRequired,
+  computeFundingContents: PropTypes.func.isRequired,
+};

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

@@ -0,0 +1,139 @@
+// 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 { Form, Header } from "semantic-ui-react";
+import { TextField, RemoteSelectField } from "react-invenio-forms";
+import { i18next } from "@translations/invenio_vocabularies/i18next";
+import _isEmpty from "lodash/isEmpty";
+
+import Overridable from "react-overridable";
+
+function CustomAwardForm({ deserializeFunder, selectedFunding }) {
+  function deserializeFunderToDropdown(funderItem) {
+    const funderName = funderItem?.name;
+    const funderPID = funderItem?.id;
+    const funderCountry = funderItem?.country_name ?? funderItem?.country;
+
+    if (!funderName && !funderPID) {
+      return {};
+    }
+
+    return {
+      text: [funderName, funderCountry, funderPID].filter((val) => val).join(", "),
+      value: funderItem.id,
+      key: funderItem.id,
+      ...(funderName && { name: funderName }),
+      ...(funderPID && { pid: funderPID }),
+    };
+  }
+
+  function serializeFunderFromDropdown(funderDropObject) {
+    return {
+      id: funderDropObject.key,
+      ...(funderDropObject.name && { name: funderDropObject.name }),
+      ...(funderDropObject.pid && { pid: funderDropObject.pid }),
+    };
+  }
+
+  return (
+    <Form>
+      <Overridable
+        id="InvenioVocabularies.CustomAwardForm.RemoteSelectField.Container"
+        fieldPath="selectedFunding.funder.id"
+      >
+        <RemoteSelectField
+          fieldPath="selectedFunding.funder.id"
+          suggestionAPIUrl="/api/funders"
+          suggestionAPIHeaders={{
+            Accept: "application/vnd.inveniordm.v1+json",
+          }}
+          placeholder={i18next.t("Search for a funder by name")}
+          serializeSuggestions={(funders) => {
+            return funders.map((funder) =>
+              deserializeFunderToDropdown(deserializeFunder(funder))
+            );
+          }}
+          searchInput={{
+            autoFocus: _isEmpty(selectedFunding),
+          }}
+          label={i18next.t("Funder")}
+          noQueryMessage={i18next.t("Search for funder...")}
+          clearable
+          allowAdditions={false}
+          multiple={false}
+          selectOnBlur={false}
+          selectOnNavigation={false}
+          required
+          search={(options) => options}
+          isFocused
+          onValueChange={({ formikProps }, selectedFundersArray) => {
+            if (selectedFundersArray.length === 1) {
+              const selectedFunder = selectedFundersArray[0];
+              if (selectedFunder) {
+                const deserializedFunder = serializeFunderFromDropdown(selectedFunder);
+                formikProps.form.setFieldValue(
+                  "selectedFunding.funder",
+                  deserializedFunder
+                );
+              }
+            }
+          }}
+        />
+      </Overridable>
+      <Overridable id="InvenioVocabularies.CustomAwardForm.AwardInformationHeader.Container">
+        <Header as="h3" size="small">
+          {i18next.t("Additional information")} ({i18next.t("optional")})
+        </Header>
+      </Overridable>
+      <Form.Group widths="equal">
+        <Overridable
+          id="InvenioVocabularies.CustomAwardForm.AwardNumberTextField.Container"
+          fieldPath="selectedFunding.award.number"
+        >
+          <TextField
+            label={i18next.t("Number")}
+            placeholder={i18next.t("Award/Grant number")}
+            fieldPath="selectedFunding.award.number"
+          />
+        </Overridable>
+        <Overridable
+          id="InvenioVocabularies.CustomAwardForm.AwardTitleTextField.Container"
+          fieldPath="selectedFunding.award.title"
+        >
+          <TextField
+            label={i18next.t("Title")}
+            placeholder={i18next.t("Award/Grant Title")}
+            fieldPath="selectedFunding.award.title"
+          />
+        </Overridable>
+        <Overridable
+          id="InvenioVocabularies.CustomAwardForm.AwardUrlTextField.Container"
+          fieldPath="selectedFunding.award.url"
+        >
+          <TextField
+            label={i18next.t("URL")}
+            placeholder={i18next.t("Award/Grant URL")}
+            fieldPath="selectedFunding.award.url"
+          />
+        </Overridable>
+      </Form.Group>
+    </Form>
+  );
+}
+
+CustomAwardForm.propTypes = {
+  deserializeFunder: PropTypes.func.isRequired,
+  selectedFunding: PropTypes.object,
+};
+
+CustomAwardForm.defaultProps = {
+  selectedFunding: undefined,
+};
+
+export default CustomAwardForm;

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

@@ -0,0 +1,87 @@
+// 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.
+
+import React from "react";
+
+import { Dropdown } from "semantic-ui-react";
+import { withState } from "react-searchkit";
+import { i18next } from "@translations/invenio_vocabularies/i18next";
+
+export const FunderDropdown = withState(
+  ({ currentResultsState: awardsList, updateQueryState, currentQueryState }) => {
+    const [fundersFromFacets] = useFundersFromFacets(awardsList);
+
+    /**
+     * Trigger on funder selection.
+     * Updated the query state to filter by the selected funder.
+     *
+     * @param {*} event
+     * @param {*} data
+     */
+    function onFunderSelect(event, data) {
+      let newFilter = [];
+
+      if (data && data.value !== "") {
+        newFilter = ["funders", data.value];
+      }
+      updateQueryState({ ...currentQueryState, filters: newFilter, page: 1 });
+    }
+
+    /**
+     * Custom hook, triggered when the awards list changes.
+     * It retrieves funders from new award's facets.
+     *
+     * @param {object} awards
+     *
+     * @returns {object[]} an array of objects, each representing a facetted funder.
+     */
+    function useFundersFromFacets(awards) {
+      const [result, setResult] = React.useState([]);
+      React.useEffect(() => {
+        /**
+         * Retrieves funders from awards facets and sets the result in state 'result'.
+         */
+        function getFundersFromAwardsFacet() {
+          if (awards.loading) {
+            setResult([]);
+            return;
+          }
+
+          const funders = awards.data.aggregations?.funders?.buckets.map((agg) => {
+            return {
+              key: agg.key,
+              value: agg.key,
+              text: agg.label,
+            };
+          });
+          setResult(funders);
+        }
+
+        getFundersFromAwardsFacet();
+      }, [awards]);
+
+      return [result];
+    }
+
+    return (
+      <Dropdown
+        placeholder={i18next.t("Funder")}
+        search
+        selection
+        clearable
+        scrolling
+        multiple={false}
+        options={fundersFromFacets || []}
+        allowAdditions={false}
+        onChange={onFunderSelect}
+        fluid
+        selectOnBlur={false}
+        selectOnNavigation={false}
+      />
+    );
+  }
+);

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

@@ -0,0 +1,244 @@
+// This file is part of InvenioVocabularies
+// Copyright (C) 2021-2025 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, FeedbackLabel } from "react-invenio-forms";
+
+import { FundingFieldItem } from "./FundingFieldItem";
+import FundingModal from "./FundingModal";
+
+import { i18next } from "@translations/invenio_vocabularies/i18next";
+
+import Overridable from "react-overridable";
+
+function FundingFieldForm(props) {
+  const {
+    label,
+    labelIcon,
+    fieldPath,
+    form: { values, errors, initialErrors, initialValues },
+    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 };
+      };
+
+  const fundingList = getIn(values, fieldPath, []);
+  const formikInitialValues = getIn(initialValues, fieldPath, []);
+
+  const error = getIn(errors, fieldPath, null);
+  const initialError = getIn(initialErrors, fieldPath, null);
+  const fundingError = error || (fundingList === formikInitialValues && initialError);
+
+  let className = "";
+  if (fundingError) {
+    className = typeof fundingError !== "string" ? fundingError.severity : "error";
+  }
+
+  return (
+    <DndProvider backend={HTML5Backend}>
+      <Form.Field required={required} className={className}>
+        <FieldLabel htmlFor={fieldPath} icon={labelIcon} label={label} />
+        <List>
+          {fundingList.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 ${className}`}
+              >
+                <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"
+                className={className}
+              >
+                <Icon name="add" />
+                {i18next.t("Add custom")}
+              </Button>
+            }
+            onAwardChange={(selectedFunding) => {
+              formikArrayPush(selectedFunding);
+            }}
+            mode="custom"
+            action="add"
+            deserializeAward={deserializeAward}
+            deserializeFunder={deserializeFunder}
+            computeFundingContents={computeFundingContents}
+          />
+        </Overridable>
+
+        {fundingError && <FeedbackLabel fieldPath={fieldPath} />}
+      </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", () => {});