From 5058548ecbcf527955e4a210a2f9e9b15a818d00 Mon Sep 17 00:00:00 2001 From: Milo Thurston Date: Fri, 5 Jul 2024 16:24:43 +0100 Subject: [PATCH 1/5] Allow organisations to be downloaded in csv #2362 --- .../Records/Search/Header/SummaryDownload.vue | 53 +++++++++++++++++-- 1 file changed, 50 insertions(+), 3 deletions(-) diff --git a/src/components/Records/Search/Header/SummaryDownload.vue b/src/components/Records/Search/Header/SummaryDownload.vue index c2b1fa3ec0..94875b6a32 100644 --- a/src/components/Records/Search/Header/SummaryDownload.vue +++ b/src/components/Records/Search/Header/SummaryDownload.vue @@ -16,7 +16,7 @@ class="info mr-10" v-on="on" > - + Download @@ -25,9 +25,51 @@

+ + + + Do you need information on organisations? + + + Selecting "yes" here will add a FAIRsharing record's organisations to your download file. This will increase + the file size as each organisation will require a separate line. Select "no" to download without organisations. + + + + + + + Yes + + + No + + + Cancel + + + + + + + - - - @@ -8977,13 +553,5 @@ - - - - \ No newline at end of file diff --git a/documentation/html/Static.html b/documentation/html/Static.html index dcca9fec30..21dd52d3d2 100644 --- a/documentation/html/Static.html +++ b/documentation/html/Static.html @@ -54,7 +54,7 @@ @@ -237,7 +237,7 @@
Type:
@@ -389,9 +389,9 @@ - Documentation generated by JSDoc 4.0.3 + Documentation generated by JSDoc 3.6.11 - on Fri Jul 5th 2024 + on Wed Sep 27th 2023 using the DocStrap template. diff --git a/documentation/html/classes.list.html b/documentation/html/classes.list.html index 202cb41224..4e30ab9dcf 100644 --- a/documentation/html/classes.list.html +++ b/documentation/html/classes.list.html @@ -30,2120 +30,67 @@ - - - - - -
-
- - -
- -
- - -

Classes

-
- -
- -

- -

- - -
- - -
-
- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -

Classes

- -
-
ExternalRESTClients
-
- -
GraphQLClient
-
- -
RESTClient
-
-
- - - - - -

Namespaces

- -
-
Static
-
-
- - - -

Members

- -
- -
-
-

<constant> buildFacets

- - -
-
- -
-

Given an object containing the raw facets coming from the client and a mapping object , build the ready to use facets -for usage by the Vue components.

-
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - -
- - - -
-
-

<constant> buildFilters

- - -
-
- -
-

Given a searchFairsharingRecords aggregations array, build the values used by the advanced search widgets

-
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - -
- - - -
-
-

filtersStore :Object

- - -
-
- -
-

The searchFilters store trigger a single field query to searchFairsharingRecords, gets the aggregation array and -builds the filtering system to be used by advanced search functions.

-
- - - -
Type:
-
    -
  • - -Object - - - -
  • -
- - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - -
- - - -
-
-

introspectionStore :Object

- - -
-
- -
-

The introspection store is related to the introspection query that let us know which fields/types are allowed by the searchFairsharingRecords query

-
- - - -
Type:
-
    -
  • - -Object - - - -
  • -
- - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - -
- - - -
-
-

<constant> paramsAreExpired

- - -
-
- -
-

Compares the given date with now and returns true if it greater than the given timer

-
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - -
- - - -
-
-

recordStore :Object

- - -
-
- -
-

The record store handles the requests related to record (fairsharingRecord).

-
- - - -
Type:
-
    -
  • - -Object - - - -
  • -
- - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - -
- - - -
-
-

<constant> recordTypes

- - -
-
- -
-

Mixin to filter the records types based on the registry -{{computed: {getRecordTypes: Computed}, methods: {filteredRecordTypes(*): *[]}}}

-
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - -
- - - -
-
-

recordsStore :Object

- - -
-
- -
-

The records store handles the requests related to records (searchFairsharingRecords and fairsharingRecord).

-
- - - -
Type:
-
    -
  • - -Object - - - -
  • -
- - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - -
- - - -
-
-

states :Object

- - -
-
- - - -
Type:
-
    -
  • - -Object - - - -
  • -
- - - -
- - -
Properties:
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
errors - - -String - - - - -

collects errors while introspecting.

searchQueryParameters - - -object - - - - -

filters query parameters object coming from API.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - -
- -
- - - -

Methods

- -
- -
-
-

hackSearch()

- - -
-
- - -
-

Convert a prop from the old system into that used by the new. Useful when old search links -have been deployed elsewhere in the internet or in print (as long as we know about them).

-
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - -
-

String - new form of the old prop

-
- - - - - - - -
- - - -
-
-

hasValue(val)

- - -
-
- - -
-

Assess if the string is of a certain value (useful to compare passwords)

-
- - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
val - - -String - - - - -

the value to evaluate the string against

- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -function - - - -
-
- - - - - -
- - - -
-
-

isAllowedSize()

- - -
-
- - -
-

Assess if the given file has the correct allowed size

-
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -function - - - -
-
- - - - - -
- - - -
-
-

isEmail()

- - -
-
- - -
-

Assess email patterns.

-
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -function - - - -
-
- - - - - -
- - - -
-
-

isEmailOrUrl()

- - -
-
- - -
-

Assess email or email patterns.

-
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -function - - - -
-
- - - - - -
- - - -
-
-

isImage()

- - -
-
- - -
-

Assess if the given file has the correct extension

-
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -function - - - -
-
- - - - - -
- - - -
-
-

isLongEnough(length)

- - -
-
- - -
-

Assess if the string is long enough.

-
- - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
length - - -Number - - - - -

the length to evaluate the string against.

- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -function - - - -
-
- - - - - -
- - - -
-
-

isMastodon()

- - -
-
- - -
-

Assess mastodon username @user@server.

-
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -function - - - -
-
- - - - - -
- - - -
-
-

isOrcid()

- - -
-
- - -
-

Assess ORCID patterns. Can be empty if required is false.

-
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -function - - - -
-
- - - - - -
- - - -
-
-

isRequired()

- - -
-
- - -
-

Assess the presence of the field

-
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
+ + + + + +
+ +
-function +
+
+
- - +
+
+ +
+ +
+ - +

Classes

+
+
- - +

+ +

- -
-
-

isUrl()

- - -
-
- - -
-

Assess URL patterns.

-
- - +
- +
+
- + - +
@@ -2173,16 +120,6 @@

isUrl()

- -
Source:
-
- -
@@ -2193,56 +130,43 @@

isUrl()

+ +
+

Classes

+
+
GraphQLClient
+
+
-
Returns:
- - - - -
-
- Type -
-
- -function - - - -
-
+ - + - +

Methods

- +

-

parseParam(param, paramVal)

+

registryIcons()

-
-

Given a type and a value, parse the value with the expected type.

-
- @@ -2257,8 +181,6 @@
Parameters:
- Name - Type @@ -2275,32 +197,6 @@
Parameters:
- param - - - - - -Object - - - - - - - - - - -

the parameter types allowed

- - - - - - - paramVal - @@ -2316,7 +212,7 @@
Parameters:
-

the value to be parsed

+

registryName

@@ -2360,8 +256,8 @@
Parameters:
@@ -2390,7 +286,9 @@
Returns:
-

paramVal - the parse value

+
    +
  • icon name for registry
  • +
@@ -2402,12 +300,6 @@
Returns:
String -| - -Number -| - -Boolean @@ -2418,32 +310,19 @@
Returns:
-
Example
- -

Example usage of parseParam

- -
parseParam({name: "Boolean"}, "true");
- // return True
- - -

-

removeItem(item, arrayList)

+

registryName()

-
-

Removes an item from the array

-
- @@ -2458,8 +337,6 @@
Parameters:
- Name - Type @@ -2476,28 +353,14 @@
Parameters:
- item - - - - - - - - - + +String - - - - arrayList - - @@ -2505,7 +368,7 @@
Parameters:
- +

registryName

@@ -2549,8 +412,8 @@
Parameters:
@@ -2580,7 +443,7 @@
Returns:
    -
  • updated array without the item
  • +
  • display name for registry
@@ -2592,119 +455,7 @@
Returns:
-Array - - - -
-
- - - - - - - - - -
-
-

uniqueValues()

- - -
-
- - -
-

Removes duplicate values in a set and returns unique values

-
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - -
-

Array with non-duplicate values

-
- - - -
-
- Type -
-
- -Array +String @@ -2771,7 +522,7 @@ Documentation generated by JSDoc 4.0.3 - on Fri Jul 5th 2024 + on Thu Jul 4th 2024 using the DocStrap template. diff --git a/documentation/html/components_Records_Record_Collections.vue.html b/documentation/html/components_Records_Record_Collections.vue.html index d6be7f62a5..e1be14d9e5 100644 --- a/documentation/html/components_Records_Record_Collections.vue.html +++ b/documentation/html/components_Records_Record_Collections.vue.html @@ -54,7 +54,7 @@ @@ -208,13 +208,12 @@

Source: components/Records/Record/Collections.vue

</template> <script> -import {mapState} from "vuex"; - import SectionTitle from '@/components/Records/Record/SectionTitle'; +import {mapState} from "vuex"; +import stringUtils from "@/utils/stringUtils" import RecordStatus from "@/components/Records/Shared/RecordStatus"; -import recordRelationShipsDefinitions from "@/data/RecordRelationShipsDefinitions.json"; import recordTabUtils from "@/utils/recordTabUtils"; -import stringUtils from "@/utils/stringUtils" +import recordRelationShipsDefinitions from "@/data/RecordRelationShipsDefinitions.json"; export default { name: "Collections", @@ -355,9 +354,9 @@ - Documentation generated by JSDoc 4.0.3 + Documentation generated by JSDoc 3.6.11 - on Fri Jul 5th 2024 + on Wed Sep 27th 2023 using the DocStrap template. diff --git a/documentation/html/components_Records_Record_RelatedContent.vue.html b/documentation/html/components_Records_Record_RelatedContent.vue.html index 402fab01b8..152471d20e 100644 --- a/documentation/html/components_Records_Record_RelatedContent.vue.html +++ b/documentation/html/components_Records_Record_RelatedContent.vue.html @@ -54,7 +54,7 @@ @@ -215,7 +215,7 @@

Source: components/Records/Record/RelatedContent.vue

{{ item.subject }} </p> </v-card> - </router-link> + </router-link>. </template> </v-virtual-scroll> </v-tab-item> @@ -225,13 +225,12 @@

Source: components/Records/Record/RelatedContent.vue

</template> <script> -import {mapState} from "vuex"; - import SectionTitle from '@/components/Records/Record/SectionTitle'; +import {mapState} from "vuex"; +import stringUtils from "@/utils/stringUtils" import RecordStatus from "@/components/Records/Shared/RecordStatus"; -import recordRelationShipsDefinitions from "@/data/RecordRelationShipsDefinitions.json"; import recordTabUtils from "@/utils/recordTabUtils"; -import stringUtils from "@/utils/stringUtils"; +import recordRelationShipsDefinitions from "@/data/RecordRelationShipsDefinitions.json"; export default { name: "RelatedContent", @@ -264,14 +263,8 @@

Source: components/Records/Record/RelatedContent.vue

}, methods: { /** Dynamically sets data for each tabs based on the data received from recordAssociations and reverseAssociations*/ - // This code is a bit of a mess due to multiple rewrites related to vague/changing requirements. It would be better - // off being re-written or replaced with the original plan (a single table for all relations, with filters). prepareTabsData() { const _module = this; - // A policy may recommend collections; other records may be collected. - if (_module.currentRecord['fairsharingRecord'].registry === 'Policy') { - _module.$set(_module.tabsData.tabs, 'related_collections', {registry: ["Collection"], data: [], count:0}); - } if (Object.keys(_module.currentRecord['fairsharingRecord']).includes('recordAssociations') || Object.keys(_module.currentRecord['fairsharingRecord']).includes('reverseRecordAssociations')) { Object.keys(_module.tabsData.tabs).forEach(tabName => { @@ -281,12 +274,6 @@

Source: components/Records/Record/RelatedContent.vue

).filter(item => _module.tabsData.tabs[tabName].registry.includes(item.registry)) // This replacement code is rather clunky, as it performs an operation in three stages, but it is at // least readable (well, by this non-javascript-programmer). - // 0. This hack is related to this comment: - // https://github.com/FAIRsharing/fairsharing.github.io/pull/2255#issuecomment-1963978178 - if (tabName === 'related_collections') { - _module.tabsData.tabs['related_collections'].data = _module.tabsData.tabs['related_collections'].data - .filter((item) => item.recordAssociationLabel === 'recommends'); - } // 1. Create a hash with keys for each linked record ID of all the relations, containing an // array of all relations. let duplicates = {}; @@ -375,9 +362,9 @@ - Documentation generated by JSDoc 4.0.3 + Documentation generated by JSDoc 3.6.11 - on Fri Jul 5th 2024 + on Wed Sep 27th 2023 using the DocStrap template. diff --git a/documentation/html/components_Records_Search_Header_FilterChips.vue.html b/documentation/html/components_Records_Search_Header_FilterChips.vue.html index 49bed203af..277854b7e9 100644 --- a/documentation/html/components_Records_Search_Header_FilterChips.vue.html +++ b/documentation/html/components_Records_Search_Header_FilterChips.vue.html @@ -54,7 +54,7 @@ @@ -121,10 +121,9 @@

Source: components/Records/Search/Header/FilterChips.vue< <script> import {throttle} from "lodash" - -import extraFilterChips from "@/data/extraFilterChips.json" -import filterMapping from "@/data/FiltersLabelMapping.json" import filterChipsUtils from "@/utils/filterChipsUtils"; +import filterMapping from "@/data/FiltersLabelMapping.json" +import extraFilterChips from "@/data/extraFilterChips.json" export default { name: "FilterChips", @@ -251,9 +250,9 @@

- Documentation generated by JSDoc 4.0.3 + Documentation generated by JSDoc 3.6.11 - on Fri Jul 5th 2024 + on Wed Sep 27th 2023 using the DocStrap template. diff --git a/documentation/html/components_Records_Search_Header_Pagination.vue.html b/documentation/html/components_Records_Search_Header_Pagination.vue.html index b4dc6cf422..732a951d94 100644 --- a/documentation/html/components_Records_Search_Header_Pagination.vue.html +++ b/documentation/html/components_Records_Search_Header_Pagination.vue.html @@ -54,7 +54,7 @@ @@ -257,9 +257,9 @@ - Documentation generated by JSDoc 4.0.3 + Documentation generated by JSDoc 3.6.11 - on Fri Jul 5th 2024 + on Wed Sep 27th 2023 using the DocStrap template. diff --git a/documentation/html/components_Records_Search_Header_Sorting.vue.html b/documentation/html/components_Records_Search_Header_Sorting.vue.html index d8e1666f70..0f20d90068 100644 --- a/documentation/html/components_Records_Search_Header_Sorting.vue.html +++ b/documentation/html/components_Records_Search_Header_Sorting.vue.html @@ -54,7 +54,7 @@ @@ -213,9 +213,9 @@ - Documentation generated by JSDoc 4.0.3 + Documentation generated by JSDoc 3.6.11 - on Fri Jul 5th 2024 + on Wed Sep 27th 2023 using the DocStrap template. diff --git a/documentation/html/components_Records_Search_Input_AdvancedSearch_AdvancedSearchDialogBox.vue.html b/documentation/html/components_Records_Search_Input_AdvancedSearch_AdvancedSearchDialogBox.vue.html index ec343293ef..64d10f1348 100644 --- a/documentation/html/components_Records_Search_Input_AdvancedSearch_AdvancedSearchDialogBox.vue.html +++ b/documentation/html/components_Records_Search_Input_AdvancedSearch_AdvancedSearchDialogBox.vue.html @@ -483,7 +483,7 @@ Documentation generated by JSDoc 4.0.3 - on Fri Jul 5th 2024 + on Thu May 16th 2024 using the DocStrap template. diff --git a/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Domains.vue.html b/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Domains.vue.html index a9db7953b7..1f5ea9ad06 100644 --- a/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Domains.vue.html +++ b/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Domains.vue.html @@ -98,7 +98,6 @@

Source: components/Records/Search/Input/AdvancedSearch/Qu v-model="model" :item-value="itemValue" :item-list="getSearchDomains" - :loading="getLoadingStatus" @input="selectedValue" @fetchData="getResults" /> @@ -131,7 +130,7 @@

Source: components/Records/Search/Input/AdvancedSearch/Qu }, computed: { - ...mapGetters("domainsSearch", ["getSearchDomains", "getLoadingStatus"]), + ...mapGetters("domainsSearch", ["getSearchDomains"]), ...mapGetters("advancedSearch", ["getEditDialogStatus"]), model: { @@ -223,7 +222,7 @@

Documentation generated by JSDoc 4.0.3 - on Fri Jul 5th 2024 + on Thu May 16th 2024 using the DocStrap template. diff --git a/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Licences.vue.html b/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Licences.vue.html index 1dc3593bd5..9fe4c05b03 100644 --- a/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Licences.vue.html +++ b/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Licences.vue.html @@ -98,7 +98,6 @@

Source: components/Records/Search/Input/AdvancedSearch/Qu v-model="model" :item-value="itemValue" :item-list="getSearchLicences" - :loading="getLoadingStatus" @input="selectedValue" @fetchData="getResults" /> @@ -131,7 +130,7 @@

Source: components/Records/Search/Input/AdvancedSearch/Qu }, computed: { - ...mapGetters("licencesSearch", ["getSearchLicences", "getLoadingStatus"]), + ...mapGetters("licencesSearch", ["getSearchLicences"]), ...mapGetters("advancedSearch", ["getEditDialogStatus"]), model: { @@ -226,7 +225,7 @@

Documentation generated by JSDoc 4.0.3 - on Fri Jul 5th 2024 + on Thu May 16th 2024 using the DocStrap template. diff --git a/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Organisations.vue.html b/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Organisations.vue.html index 1122c5e5c4..9689151404 100644 --- a/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Organisations.vue.html +++ b/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Organisations.vue.html @@ -98,7 +98,6 @@

Source: components/Records/Search/Input/AdvancedSearch/Qu v-model="model" :item-value="itemValue" :item-list="getSearchOrganisations" - :loading="getLoadingStatus" @input="selectedValue" @fetchData="getResults" /> @@ -131,7 +130,7 @@

Source: components/Records/Search/Input/AdvancedSearch/Qu }, computed: { - ...mapGetters("organisationSearch", ["getSearchOrganisations", "getLoadingStatus"]), + ...mapGetters("organisationSearch", ["getSearchOrganisations"]), ...mapGetters("advancedSearch", ["getEditDialogStatus"]), model: { @@ -228,7 +227,7 @@

Documentation generated by JSDoc 4.0.3 - on Fri Jul 5th 2024 + on Thu May 16th 2024 using the DocStrap template. diff --git a/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Subject.vue.html b/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Subject.vue.html index 6070a98855..e0c87466d0 100644 --- a/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Subject.vue.html +++ b/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Subject.vue.html @@ -98,7 +98,6 @@

Source: components/Records/Search/Input/AdvancedSearch/Qu v-model="model" :item-value="itemValue" :item-list="getSearchSubjects" - :loading="getLoadingStatus" @input="selectedValue" @fetchData="getResults" /> @@ -131,7 +130,7 @@

Source: components/Records/Search/Input/AdvancedSearch/Qu }, computed: { - ...mapGetters("subjectSearch", ["getSearchSubjects", "getLoadingStatus"]), + ...mapGetters("subjectSearch", ["getSearchSubjects"]), ...mapGetters("advancedSearch", ["getEditDialogStatus"]), model: { get() { @@ -225,7 +224,7 @@

Documentation generated by JSDoc 4.0.3 - on Fri Jul 5th 2024 + on Thu May 16th 2024 using the DocStrap template. diff --git a/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Taxonomies.vue.html b/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Taxonomies.vue.html index d70d88aa86..0839a5f384 100644 --- a/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Taxonomies.vue.html +++ b/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Taxonomies.vue.html @@ -98,7 +98,6 @@

Source: components/Records/Search/Input/AdvancedSearch/Qu v-model="model" :item-value="itemValue" :item-list="getSearchTaxonomies" - :loading="getLoadingStatus" @input="selectedValue" @fetchData="getResults" /> @@ -131,7 +130,7 @@

Source: components/Records/Search/Input/AdvancedSearch/Qu }, computed: { - ...mapGetters("taxonomiesSearch", ["getSearchTaxonomies", "getLoadingStatus"]), + ...mapGetters("taxonomiesSearch", ["getSearchTaxonomies"]), ...mapGetters("advancedSearch", ["getEditDialogStatus"]), model: { @@ -226,7 +225,7 @@

Documentation generated by JSDoc 4.0.3 - on Fri Jul 5th 2024 + on Thu May 16th 2024 using the DocStrap template. diff --git a/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_UserDefinedTag.vue.html b/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_UserDefinedTag.vue.html index 3ea300865c..0f0a6c55ac 100644 --- a/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_UserDefinedTag.vue.html +++ b/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_UserDefinedTag.vue.html @@ -98,7 +98,6 @@

Source: components/Records/Search/Input/AdvancedSearch/Qu v-model="model" :item-value="itemValue" :item-list="getSearchUserDefinedTags" - :loading="getLoadingStatus" @input="selectedValue" @fetchData="getResults" /> @@ -131,7 +130,7 @@

Source: components/Records/Search/Input/AdvancedSearch/Qu }, computed: { - ...mapGetters("userDefinedTagsSearch", ["getSearchUserDefinedTags", "getLoadingStatus"]), + ...mapGetters("userDefinedTagsSearch", ["getSearchUserDefinedTags"]), ...mapGetters("advancedSearch", ["getEditDialogStatus"]), model: { @@ -226,7 +225,7 @@

Documentation generated by JSDoc 4.0.3 - on Fri Jul 5th 2024 + on Thu May 16th 2024 using the DocStrap template. diff --git a/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderView.vue.html b/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderView.vue.html index 75575e78b4..6aab534e80 100644 --- a/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderView.vue.html +++ b/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderView.vue.html @@ -144,7 +144,6 @@

Source: components/Records/Search/Input/AdvancedSearch/Qu import { uniqueValues } from "@/utils/advancedSearchUtils"; import { - Countries, DataAccessCondition, DatabaseRecordType, DataCuration, @@ -158,7 +157,8 @@

Source: components/Records/Search/Input/AdvancedSearch/Qu StandardRecordType, Subject, Taxonomies, - UserDefinedTag} from "./QueryBuilderComponents"; + UserDefinedTag, +} from "./QueryBuilderComponents"; export default { name: "QueryBuilderView", components: { QueryBuilder }, @@ -255,12 +255,6 @@

Source: components/Records/Search/Input/AdvancedSearch/Qu component: Licences, initialValue: () => [], }, - { - identifier: "countries", - name: "Countries", - component: Countries, - initialValue: () => [], - }, { identifier: "organisations", name: "Organisations", @@ -650,7 +644,7 @@

Documentation generated by JSDoc 4.0.3 - on Fri Jul 5th 2024 + on Thu May 16th 2024 using the DocStrap template. diff --git a/documentation/html/components_Records_Search_Input_FilterAutocomplete.vue.html b/documentation/html/components_Records_Search_Input_FilterAutocomplete.vue.html index f3ee29adfb..8337ee8dad 100644 --- a/documentation/html/components_Records_Search_Input_FilterAutocomplete.vue.html +++ b/documentation/html/components_Records_Search_Input_FilterAutocomplete.vue.html @@ -54,7 +54,7 @@ @@ -142,7 +142,6 @@

Source: components/Records/Search/Input/FilterAutocomplet <script> import {mapGetters, mapState} from 'vuex' - import clearString from '@/utils/stringUtils' export default { @@ -313,9 +312,9 @@

- Documentation generated by JSDoc 4.0.3 + Documentation generated by JSDoc 3.6.11 - on Fri Jul 5th 2024 + on Wed Sep 27th 2023 using the DocStrap template. diff --git a/documentation/html/components_Records_Search_Input_FilterButton.vue.html b/documentation/html/components_Records_Search_Input_FilterButton.vue.html index 000fbba00d..451543f3f4 100644 --- a/documentation/html/components_Records_Search_Input_FilterButton.vue.html +++ b/documentation/html/components_Records_Search_Input_FilterButton.vue.html @@ -54,7 +54,7 @@ @@ -122,7 +122,6 @@

Source: components/Records/Search/Input/FilterButton.vue< <script> import { isEqual } from "lodash"; import { mapActions } from 'vuex' - import currentParameter from "@/utils/currentParameterMixin.js" export default { @@ -277,9 +276,9 @@

- Documentation generated by JSDoc 4.0.3 + Documentation generated by JSDoc 3.6.11 - on Fri Jul 5th 2024 + on Wed Sep 27th 2023 using the DocStrap template. diff --git a/documentation/html/components_Records_Search_Input_SearchInput.vue.html b/documentation/html/components_Records_Search_Input_SearchInput.vue.html index 6402247577..9c120d8a44 100644 --- a/documentation/html/components_Records_Search_Input_SearchInput.vue.html +++ b/documentation/html/components_Records_Search_Input_SearchInput.vue.html @@ -54,7 +54,7 @@ @@ -136,12 +136,10 @@

Source: components/Records/Search/Input/SearchInput.vue import {mapGetters, mapState} from "vuex" - -import StringSearch from "@/components/Records/Search/Input/StringSearch"; import filterMapping from "@/data/FiltersLabelMapping.json"; - import FilterAutocomplete from "./FilterAutocomplete"; import FilterButtons from "./FilterButtons"; +import StringSearch from "@/components/Records/Search/Input/StringSearch"; export default { name: "SearchInput", @@ -283,9 +281,9 @@

- Documentation generated by JSDoc 4.0.3 + Documentation generated by JSDoc 3.6.11 - on Fri Jul 5th 2024 + on Wed Sep 27th 2023 using the DocStrap template. diff --git a/documentation/html/global.html b/documentation/html/global.html index cdc4c544ba..db56128a35 100644 --- a/documentation/html/global.html +++ b/documentation/html/global.html @@ -31,2099 +31,66 @@ - -
- -
- -
- -
-
- - -
-
- - -
- -
- - -

Global

-
- -
- -

- -

- - -
- - -
-
- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - - - - - - - -

Members

- -
- -
-
-

<constant> buildFacets

- - -
-
- -
-

Given an object containing the raw facets coming from the client and a mapping object , build the ready to use facets -for usage by the Vue components.

-
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - -
- - - -
-
-

<constant> buildFilters

- - -
-
- -
-

Given a searchFairsharingRecords aggregations array, build the values used by the advanced search widgets

-
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - -
- - - -
-
-

filtersStore :Object

- - -
-
- -
-

The searchFilters store trigger a single field query to searchFairsharingRecords, gets the aggregation array and -builds the filtering system to be used by advanced search functions.

-
- - - -
Type:
-
    -
  • - -Object - - - -
  • -
- - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - -
- - - -
-
-

introspectionStore :Object

- - -
-
- -
-

The introspection store is related to the introspection query that let us know which fields/types are allowed by the searchFairsharingRecords query

-
- - - -
Type:
-
    -
  • - -Object - - - -
  • -
- - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - -
- - - -
-
-

<constant> paramsAreExpired

- - -
-
- -
-

Compares the given date with now and returns true if it greater than the given timer

-
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - -
- - - -
-
-

recordStore :Object

- - -
-
- -
-

The record store handles the requests related to record (fairsharingRecord).

-
- - - -
Type:
-
    -
  • - -Object - - - -
  • -
- - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - -
- - - -
-
-

<constant> recordTypes

- - -
-
- -
-

Mixin to filter the records types based on the registry -{{computed: {getRecordTypes: Computed}, methods: {filteredRecordTypes(*): *[]}}}

-
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - -
- - - -
-
-

recordsStore :Object

- - -
-
- -
-

The records store handles the requests related to records (searchFairsharingRecords and fairsharingRecord).

-
- - - -
Type:
-
    -
  • - -Object - - - -
  • -
- - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - -
- - - -
-
-

states :Object

- - -
-
- - - -
Type:
-
    -
  • - -Object - - - -
  • -
- - - -
- - -
Properties:
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
errors - - -String - - - - -

collects errors while introspecting.

searchQueryParameters - - -object - - - - -

filters query parameters object coming from API.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - -
- -
- - - -

Methods

- -
- -
-
-

hackSearch()

- - -
-
- - -
-

Convert a prop from the old system into that used by the new. Useful when old search links -have been deployed elsewhere in the internet or in print (as long as we know about them).

-
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - -
-

String - new form of the old prop

-
- - - - - - - -
- - - -
-
-

hasValue(val)

- - -
-
- - -
-

Assess if the string is of a certain value (useful to compare passwords)

-
- - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
val - - -String - - - - -

the value to evaluate the string against

- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -function - - - -
-
- - - - - -
- - - -
-
-

isAllowedSize()

- - -
-
- - -
-

Assess if the given file has the correct allowed size

-
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -function - - - -
-
- - - - - -
- - - -
-
-

isEmail()

- - -
-
- - -
-

Assess email patterns.

-
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -function - - - -
-
- - - - - -
- - - -
-
-

isEmailOrUrl()

- - -
-
- - -
-

Assess email or email patterns.

-
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -function - - - -
-
- - - - - -
- - - -
-
-

isImage()

- - -
-
- - -
-

Assess if the given file has the correct extension

-
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -function - - - -
-
- - - - - -
- - - -
-
-

isLongEnough(length)

- - -
-
- - -
-

Assess if the string is long enough.

-
- - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
length - - -Number - - - - -

the length to evaluate the string against.

- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -function - - - -
-
- - - - - -
- - - -
-
-

isMastodon()

- - -
-
- - -
-

Assess mastodon username @user@server.

-
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -function - - - -
-
- - - - - -
- - - -
-
-

isOrcid()

- - -
-
- - -
-

Assess ORCID patterns. Can be empty if required is false.

-
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -function - - - -
-
- - - - - -
- - - -
-
-

isRequired()

- - -
-
- - -
-

Assess the presence of the field

-
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
+ Classes + + + + + + + +
+ +
-function +
+
+
- - +
+
+ +
+ +
+ - +

Global

+
+
- - +

+ +

- -
-
-

isUrl()

- - -
-
- - -
-

Assess URL patterns.

-
- - +
- +
+
- + - +
@@ -2153,16 +120,6 @@

isUrl()

- -
Source:
-
- -
@@ -2173,7 +130,9 @@

isUrl()

+ +
@@ -2184,45 +143,23 @@

isUrl()

-
Returns:
- - - - -
-
- Type -
-
- -function - - -
-
- - - + - +

Methods

- +

-

parseParam(param, paramVal)

+

registryIcons()

-
-

Given a type and a value, parse the value with the expected type.

-
- @@ -2237,8 +174,6 @@
Parameters:
- Name - Type @@ -2255,32 +190,6 @@
Parameters:
- param - - - - - -Object - - - - - - - - - - -

the parameter types allowed

- - - - - - - paramVal - @@ -2296,7 +205,7 @@
Parameters:
-

the value to be parsed

+

registryName

@@ -2340,8 +249,8 @@
Parameters:
@@ -2370,7 +279,9 @@
Returns:
-

paramVal - the parse value

+
    +
  • icon name for registry
  • +
@@ -2382,12 +293,6 @@
Returns:
String -| - -Number -| - -Boolean @@ -2398,32 +303,19 @@
Returns:
-
Example
- -

Example usage of parseParam

- -
parseParam({name: "Boolean"}, "true");
- // return True
- - -

-

removeItem(item, arrayList)

+

registryName()

-
-

Removes an item from the array

-
- @@ -2438,8 +330,6 @@
Parameters:
- Name - Type @@ -2456,28 +346,14 @@
Parameters:
- item - - - - - - - - - + +String - - - - arrayList - - @@ -2485,7 +361,7 @@
Parameters:
- +

registryName

@@ -2529,8 +405,8 @@
Parameters:
@@ -2560,7 +436,7 @@
Returns:
    -
  • updated array without the item
  • +
  • display name for registry
@@ -2572,119 +448,7 @@
Returns:
-Array - - - -
-
- - - - - - - - - -
-
-

uniqueValues()

- - -
-
- - -
-

Removes duplicate values in a set and returns unique values

-
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- -
- - - - - - - -
- - - - - - - - - - - - - -
Returns:
- - -
-

Array with non-duplicate values

-
- - - -
-
- Type -
-
- -Array +String @@ -2751,7 +515,7 @@ Documentation generated by JSDoc 4.0.3 - on Fri Jul 5th 2024 + on Thu Jul 4th 2024 using the DocStrap template. diff --git a/documentation/html/index.html b/documentation/html/index.html index d4f63dab05..5e76067a86 100644 --- a/documentation/html/index.html +++ b/documentation/html/index.html @@ -30,31 +30,17 @@ -
- - + + - - - @@ -1237,13 +219,5 @@ - - - - diff --git a/documentation/html/lib_GraphClient_GraphClient.js.html b/documentation/html/lib_GraphClient_GraphClient.js.html index d8ebae80f9..408994bf88 100644 --- a/documentation/html/lib_GraphClient_GraphClient.js.html +++ b/documentation/html/lib_GraphClient_GraphClient.js.html @@ -30,31 +30,17 @@ +
+ +
+
+ + +
+
+ + +
+ +
+ + +

Classes

+
+ +
+ +

+ +

+ + +
+ + +
+
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +

Classes

+ +
+
ExternalRESTClients
+
+ +
GraphQLClient
+
+ +
RESTClient
+
+
+ + + + + +

Namespaces

+ +
+
Static
+
+
+ + + +

Members

+ +
+ +
+
+

<constant> buildFacets

+ + +
+
+ +
+

Given an object containing the raw facets coming from the client and a mapping object , build the ready to use facets +for usage by the Vue components.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<constant> buildFilters

+ + +
+
+ +
+

Given a searchFairsharingRecords aggregations array, build the values used by the advanced search widgets

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

filtersStore :Object

+ + +
+
+ +
+

The searchFilters store trigger a single field query to searchFairsharingRecords, gets the aggregation array and +builds the filtering system to be used by advanced search functions.

+
+ + + +
Type:
+
    +
  • + +Object + + + +
  • +
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

introspectionStore :Object

+ + +
+
+ +
+

The introspection store is related to the introspection query that let us know which fields/types are allowed by the searchFairsharingRecords query

+
+ + + +
Type:
+
    +
  • + +Object + + + +
  • +
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<constant> paramsAreExpired

+ + +
+
+ +
+

Compares the given date with now and returns true if it greater than the given timer

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

recordStore :Object

+ + +
+
+ +
+

The record store handles the requests related to record (fairsharingRecord).

+
+ + + +
Type:
+
    +
  • + +Object + + + +
  • +
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<constant> recordTypes

+ + +
+
+ +
+

Mixin to filter the records types based on the registry +{{computed: {getRecordTypes: Computed}, methods: {filteredRecordTypes(*): *[]}}}

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

recordsStore :Object

+ + +
+
+ +
+

The records store handles the requests related to records (searchFairsharingRecords and fairsharingRecord).

+
+ + + +
Type:
+
    +
  • + +Object + + + +
  • +
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

states :Object

+ + +
+
+ + + +
Type:
+
    +
  • + +Object + + + +
  • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
errors + + +String + + + + +

collects errors while introspecting.

searchQueryParameters + + +object + + + + +

filters query parameters object coming from API.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ +
+ + + +

Methods

+ +
+ +
+
+

hackSearch()

+ + +
+
+ + +
+

Convert a prop from the old system into that used by the new. Useful when old search links +have been deployed elsewhere in the internet or in print (as long as we know about them).

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

String - new form of the old prop

+
+ + + + + + + +
+ + + +
+
+

hasValue(val)

+ + +
+
+ + +
+

Assess if the string is of a certain value (useful to compare passwords)

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
val + + +String + + + + +

the value to evaluate the string against

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +function + + + +
+
+ + + + + +
+ + + +
+
+

isAllowedSize()

+ + +
+
+ + +
+

Assess if the given file has the correct allowed size

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +function + + + +
+
+ + + + + +
+ + + +
+
+

isEmail()

+ + +
+
+ + +
+

Assess email patterns.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +function + + + +
+
+ + + + + +
+ + + +
+
+

isEmailOrUrl()

+ + +
+
+ + +
+

Assess email or email patterns.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +function + + + +
+
+ + + + + +
+ + + +
+
+

isImage()

+ + +
+
+ + +
+

Assess if the given file has the correct extension

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +function + + + +
+
+ + + + + +
+ + + +
+
+

isLongEnough(length)

+ + +
+
+ + +
+

Assess if the string is long enough.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
length + + +Number + + + + +

the length to evaluate the string against.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +function + + + +
+
+ + + + + +
+ + + +
+
+

isMastodon()

+ + +
+
+ + +
+

Assess mastodon username @user@server.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +function + + + +
+
+ + + + + +
+ + + +
+
+

isOrcid()

+ + +
+
+ + +
+

Assess ORCID patterns. Can be empty if required is false.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +function + + + +
+
+ + + + + +
+ + + +
+
+

isRequired()

+ + +
+
+ + +
+

Assess the presence of the field

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +function -
-
-
-
+ + - -
- -
- -

Classes

-
+ -
-

- -

+ + + +
+
+

isUrl()

+ + +
+
+ + +
+

Assess URL patterns.

+
-
+ -
-
- - + + + +
@@ -120,6 +2173,16 @@

+ +
Source:
+
+ +
@@ -130,43 +2193,56 @@

- -
-

Classes

-
-
GraphQLClient
-
-
- +
Returns:
+ + + +
+
+ Type +
+
+ +function + - + +
+
+ + + -

Methods

+ -
+
-

registryIcons()

+

parseParam(param, paramVal)

+
+

Given a type and a value, parse the value with the expected type.

+
+ @@ -181,6 +2257,8 @@
Parameters:
+ Name + Type @@ -197,6 +2275,32 @@
Parameters:
+ param + + + + + +Object + + + + + + + + + + +

the parameter types allowed

+ + + + + + + paramVal + @@ -212,7 +2316,7 @@
Parameters:
-

registryName

+

the value to be parsed

@@ -256,8 +2360,8 @@
Parameters:
@@ -286,9 +2390,7 @@
Returns:
-
    -
  • icon name for registry
  • -
+

paramVal - the parse value

@@ -300,6 +2402,12 @@
Returns:
String +| + +Number +| + +Boolean @@ -310,19 +2418,32 @@
Returns:
+
Example
+ +

Example usage of parseParam

+ +
parseParam({name: "Boolean"}, "true");
+ // return True
+ + +

-

registryName()

+

removeItem(item, arrayList)

+
+

Removes an item from the array

+
+ @@ -337,6 +2458,8 @@
Parameters:
+ Name + Type @@ -353,14 +2476,28 @@
Parameters:
+ item + - -String + + + + + + + + + + + + arrayList + + @@ -368,7 +2505,7 @@
Parameters:
-

registryName

+ @@ -412,8 +2549,8 @@
Parameters:
@@ -443,7 +2580,7 @@
Returns:
    -
  • display name for registry
  • +
  • updated array without the item
@@ -455,7 +2592,119 @@
Returns:
-String +Array + + + +
+
+ + + + + + + + + +
+
+

uniqueValues()

+ + +
+
+ + +
+

Removes duplicate values in a set and returns unique values

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Array with non-duplicate values

+
+ + + +
+
+ Type +
+
+ +Array @@ -522,7 +2771,7 @@ Documentation generated by JSDoc 4.0.3 - on Thu Jul 4th 2024 + on Mon Jul 15th 2024 using the DocStrap template. diff --git a/documentation/html/components_Records_Record_Collections.vue.html b/documentation/html/components_Records_Record_Collections.vue.html index e1be14d9e5..eeb8198253 100644 --- a/documentation/html/components_Records_Record_Collections.vue.html +++ b/documentation/html/components_Records_Record_Collections.vue.html @@ -54,7 +54,7 @@ @@ -208,12 +208,13 @@

Source: components/Records/Record/Collections.vue

</template> <script> -import SectionTitle from '@/components/Records/Record/SectionTitle'; import {mapState} from "vuex"; -import stringUtils from "@/utils/stringUtils" + +import SectionTitle from '@/components/Records/Record/SectionTitle'; import RecordStatus from "@/components/Records/Shared/RecordStatus"; -import recordTabUtils from "@/utils/recordTabUtils"; import recordRelationShipsDefinitions from "@/data/RecordRelationShipsDefinitions.json"; +import recordTabUtils from "@/utils/recordTabUtils"; +import stringUtils from "@/utils/stringUtils" export default { name: "Collections", @@ -354,9 +355,9 @@ - Documentation generated by JSDoc 3.6.11 + Documentation generated by JSDoc 4.0.3 - on Wed Sep 27th 2023 + on Mon Jul 15th 2024 using the DocStrap template. diff --git a/documentation/html/components_Records_Record_RelatedContent.vue.html b/documentation/html/components_Records_Record_RelatedContent.vue.html index 152471d20e..f8cca2e92f 100644 --- a/documentation/html/components_Records_Record_RelatedContent.vue.html +++ b/documentation/html/components_Records_Record_RelatedContent.vue.html @@ -54,7 +54,7 @@ @@ -215,7 +215,7 @@

Source: components/Records/Record/RelatedContent.vue

{{ item.subject }} </p> </v-card> - </router-link>. + </router-link> </template> </v-virtual-scroll> </v-tab-item> @@ -225,12 +225,13 @@

Source: components/Records/Record/RelatedContent.vue

</template> <script> -import SectionTitle from '@/components/Records/Record/SectionTitle'; import {mapState} from "vuex"; -import stringUtils from "@/utils/stringUtils" + +import SectionTitle from '@/components/Records/Record/SectionTitle'; import RecordStatus from "@/components/Records/Shared/RecordStatus"; -import recordTabUtils from "@/utils/recordTabUtils"; import recordRelationShipsDefinitions from "@/data/RecordRelationShipsDefinitions.json"; +import recordTabUtils from "@/utils/recordTabUtils"; +import stringUtils from "@/utils/stringUtils"; export default { name: "RelatedContent", @@ -263,8 +264,14 @@

Source: components/Records/Record/RelatedContent.vue

}, methods: { /** Dynamically sets data for each tabs based on the data received from recordAssociations and reverseAssociations*/ + // This code is a bit of a mess due to multiple rewrites related to vague/changing requirements. It would be better + // off being re-written or replaced with the original plan (a single table for all relations, with filters). prepareTabsData() { const _module = this; + // A policy may recommend collections; other records may be collected. + if (_module.currentRecord['fairsharingRecord'].registry === 'Policy') { + _module.$set(_module.tabsData.tabs, 'related_collections', {registry: ["Collection"], data: [], count:0}); + } if (Object.keys(_module.currentRecord['fairsharingRecord']).includes('recordAssociations') || Object.keys(_module.currentRecord['fairsharingRecord']).includes('reverseRecordAssociations')) { Object.keys(_module.tabsData.tabs).forEach(tabName => { @@ -274,6 +281,12 @@

Source: components/Records/Record/RelatedContent.vue

).filter(item => _module.tabsData.tabs[tabName].registry.includes(item.registry)) // This replacement code is rather clunky, as it performs an operation in three stages, but it is at // least readable (well, by this non-javascript-programmer). + // 0. This hack is related to this comment: + // https://github.com/FAIRsharing/fairsharing.github.io/pull/2255#issuecomment-1963978178 + if (tabName === 'related_collections') { + _module.tabsData.tabs['related_collections'].data = _module.tabsData.tabs['related_collections'].data + .filter((item) => item.recordAssociationLabel === 'recommends'); + } // 1. Create a hash with keys for each linked record ID of all the relations, containing an // array of all relations. let duplicates = {}; @@ -362,9 +375,9 @@ - Documentation generated by JSDoc 3.6.11 + Documentation generated by JSDoc 4.0.3 - on Wed Sep 27th 2023 + on Mon Jul 15th 2024 using the DocStrap template. diff --git a/documentation/html/components_Records_Search_Header_FilterChips.vue.html b/documentation/html/components_Records_Search_Header_FilterChips.vue.html index 277854b7e9..0b71aa0a2d 100644 --- a/documentation/html/components_Records_Search_Header_FilterChips.vue.html +++ b/documentation/html/components_Records_Search_Header_FilterChips.vue.html @@ -54,7 +54,7 @@ @@ -121,9 +121,10 @@

Source: components/Records/Search/Header/FilterChips.vue< <script> import {throttle} from "lodash" -import filterChipsUtils from "@/utils/filterChipsUtils"; -import filterMapping from "@/data/FiltersLabelMapping.json" + import extraFilterChips from "@/data/extraFilterChips.json" +import filterMapping from "@/data/FiltersLabelMapping.json" +import filterChipsUtils from "@/utils/filterChipsUtils"; export default { name: "FilterChips", @@ -250,9 +251,9 @@

- Documentation generated by JSDoc 3.6.11 + Documentation generated by JSDoc 4.0.3 - on Wed Sep 27th 2023 + on Mon Jul 15th 2024 using the DocStrap template. diff --git a/documentation/html/components_Records_Search_Header_Pagination.vue.html b/documentation/html/components_Records_Search_Header_Pagination.vue.html index 732a951d94..35b7d566c8 100644 --- a/documentation/html/components_Records_Search_Header_Pagination.vue.html +++ b/documentation/html/components_Records_Search_Header_Pagination.vue.html @@ -54,7 +54,7 @@ @@ -257,9 +257,9 @@ - Documentation generated by JSDoc 3.6.11 + Documentation generated by JSDoc 4.0.3 - on Wed Sep 27th 2023 + on Mon Jul 15th 2024 using the DocStrap template. diff --git a/documentation/html/components_Records_Search_Header_Sorting.vue.html b/documentation/html/components_Records_Search_Header_Sorting.vue.html index 0f20d90068..81e24d1bd8 100644 --- a/documentation/html/components_Records_Search_Header_Sorting.vue.html +++ b/documentation/html/components_Records_Search_Header_Sorting.vue.html @@ -54,7 +54,7 @@ @@ -213,9 +213,9 @@ - Documentation generated by JSDoc 3.6.11 + Documentation generated by JSDoc 4.0.3 - on Wed Sep 27th 2023 + on Mon Jul 15th 2024 using the DocStrap template. diff --git a/documentation/html/components_Records_Search_Input_AdvancedSearch_AdvancedSearchDialogBox.vue.html b/documentation/html/components_Records_Search_Input_AdvancedSearch_AdvancedSearchDialogBox.vue.html index 64d10f1348..aee0f7668f 100644 --- a/documentation/html/components_Records_Search_Input_AdvancedSearch_AdvancedSearchDialogBox.vue.html +++ b/documentation/html/components_Records_Search_Input_AdvancedSearch_AdvancedSearchDialogBox.vue.html @@ -483,7 +483,7 @@ Documentation generated by JSDoc 4.0.3 - on Thu May 16th 2024 + on Mon Jul 15th 2024 using the DocStrap template. diff --git a/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Countries.vue.html b/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Countries.vue.html index 5aeaa17340..4aed8066df 100644 --- a/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Countries.vue.html +++ b/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Countries.vue.html @@ -226,11 +226,7 @@ Documentation generated by JSDoc 4.0.3 -<<<<<<< HEAD - on Fri Jul 5th 2024 -======= - on Wed Jul 10th 2024 ->>>>>>> dev + on Mon Jul 15th 2024 using the DocStrap template. diff --git a/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Domains.vue.html b/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Domains.vue.html index 1f5ea9ad06..c08032dfd5 100644 --- a/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Domains.vue.html +++ b/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Domains.vue.html @@ -98,6 +98,7 @@

Source: components/Records/Search/Input/AdvancedSearch/Qu v-model="model" :item-value="itemValue" :item-list="getSearchDomains" + :loading="getLoadingStatus" @input="selectedValue" @fetchData="getResults" /> @@ -130,7 +131,7 @@

Source: components/Records/Search/Input/AdvancedSearch/Qu }, computed: { - ...mapGetters("domainsSearch", ["getSearchDomains"]), + ...mapGetters("domainsSearch", ["getSearchDomains", "getLoadingStatus"]), ...mapGetters("advancedSearch", ["getEditDialogStatus"]), model: { @@ -222,7 +223,7 @@

Documentation generated by JSDoc 4.0.3 - on Thu May 16th 2024 + on Mon Jul 15th 2024 using the DocStrap template. diff --git a/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Licences.vue.html b/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Licences.vue.html index 9fe4c05b03..ae938baaab 100644 --- a/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Licences.vue.html +++ b/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Licences.vue.html @@ -98,6 +98,7 @@

Source: components/Records/Search/Input/AdvancedSearch/Qu v-model="model" :item-value="itemValue" :item-list="getSearchLicences" + :loading="getLoadingStatus" @input="selectedValue" @fetchData="getResults" /> @@ -130,7 +131,7 @@

Source: components/Records/Search/Input/AdvancedSearch/Qu }, computed: { - ...mapGetters("licencesSearch", ["getSearchLicences"]), + ...mapGetters("licencesSearch", ["getSearchLicences", "getLoadingStatus"]), ...mapGetters("advancedSearch", ["getEditDialogStatus"]), model: { @@ -225,7 +226,7 @@

Documentation generated by JSDoc 4.0.3 - on Thu May 16th 2024 + on Mon Jul 15th 2024 using the DocStrap template. diff --git a/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Organisations.vue.html b/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Organisations.vue.html index 9689151404..3b301a1c0b 100644 --- a/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Organisations.vue.html +++ b/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Organisations.vue.html @@ -98,6 +98,7 @@

Source: components/Records/Search/Input/AdvancedSearch/Qu v-model="model" :item-value="itemValue" :item-list="getSearchOrganisations" + :loading="getLoadingStatus" @input="selectedValue" @fetchData="getResults" /> @@ -130,7 +131,7 @@

Source: components/Records/Search/Input/AdvancedSearch/Qu }, computed: { - ...mapGetters("organisationSearch", ["getSearchOrganisations"]), + ...mapGetters("organisationSearch", ["getSearchOrganisations", "getLoadingStatus"]), ...mapGetters("advancedSearch", ["getEditDialogStatus"]), model: { @@ -227,7 +228,7 @@

Documentation generated by JSDoc 4.0.3 - on Thu May 16th 2024 + on Mon Jul 15th 2024 using the DocStrap template. diff --git a/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Subject.vue.html b/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Subject.vue.html index e0c87466d0..1140f824c9 100644 --- a/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Subject.vue.html +++ b/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Subject.vue.html @@ -98,6 +98,7 @@

Source: components/Records/Search/Input/AdvancedSearch/Qu v-model="model" :item-value="itemValue" :item-list="getSearchSubjects" + :loading="getLoadingStatus" @input="selectedValue" @fetchData="getResults" /> @@ -130,7 +131,7 @@

Source: components/Records/Search/Input/AdvancedSearch/Qu }, computed: { - ...mapGetters("subjectSearch", ["getSearchSubjects"]), + ...mapGetters("subjectSearch", ["getSearchSubjects", "getLoadingStatus"]), ...mapGetters("advancedSearch", ["getEditDialogStatus"]), model: { get() { @@ -224,7 +225,7 @@

Documentation generated by JSDoc 4.0.3 - on Thu May 16th 2024 + on Mon Jul 15th 2024 using the DocStrap template. diff --git a/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Taxonomies.vue.html b/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Taxonomies.vue.html index 0839a5f384..d3d44575e7 100644 --- a/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Taxonomies.vue.html +++ b/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_Taxonomies.vue.html @@ -98,6 +98,7 @@

Source: components/Records/Search/Input/AdvancedSearch/Qu v-model="model" :item-value="itemValue" :item-list="getSearchTaxonomies" + :loading="getLoadingStatus" @input="selectedValue" @fetchData="getResults" /> @@ -130,7 +131,7 @@

Source: components/Records/Search/Input/AdvancedSearch/Qu }, computed: { - ...mapGetters("taxonomiesSearch", ["getSearchTaxonomies"]), + ...mapGetters("taxonomiesSearch", ["getSearchTaxonomies", "getLoadingStatus"]), ...mapGetters("advancedSearch", ["getEditDialogStatus"]), model: { @@ -225,7 +226,7 @@

Documentation generated by JSDoc 4.0.3 - on Thu May 16th 2024 + on Mon Jul 15th 2024 using the DocStrap template. diff --git a/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_UserDefinedTag.vue.html b/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_UserDefinedTag.vue.html index 0f0a6c55ac..1af5e15480 100644 --- a/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_UserDefinedTag.vue.html +++ b/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderComponents_UserDefinedTag.vue.html @@ -98,6 +98,7 @@

Source: components/Records/Search/Input/AdvancedSearch/Qu v-model="model" :item-value="itemValue" :item-list="getSearchUserDefinedTags" + :loading="getLoadingStatus" @input="selectedValue" @fetchData="getResults" /> @@ -130,7 +131,7 @@

Source: components/Records/Search/Input/AdvancedSearch/Qu }, computed: { - ...mapGetters("userDefinedTagsSearch", ["getSearchUserDefinedTags"]), + ...mapGetters("userDefinedTagsSearch", ["getSearchUserDefinedTags", "getLoadingStatus"]), ...mapGetters("advancedSearch", ["getEditDialogStatus"]), model: { @@ -225,7 +226,7 @@

Documentation generated by JSDoc 4.0.3 - on Thu May 16th 2024 + on Mon Jul 15th 2024 using the DocStrap template. diff --git a/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderView.vue.html b/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderView.vue.html index 6aab534e80..2631dde9e9 100644 --- a/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderView.vue.html +++ b/documentation/html/components_Records_Search_Input_AdvancedSearch_QueryBuilderView.vue.html @@ -144,6 +144,7 @@

Source: components/Records/Search/Input/AdvancedSearch/Qu import { uniqueValues } from "@/utils/advancedSearchUtils"; import { + Countries, DataAccessCondition, DatabaseRecordType, DataCuration, @@ -157,8 +158,7 @@

Source: components/Records/Search/Input/AdvancedSearch/Qu StandardRecordType, Subject, Taxonomies, - UserDefinedTag, -} from "./QueryBuilderComponents"; + UserDefinedTag} from "./QueryBuilderComponents"; export default { name: "QueryBuilderView", components: { QueryBuilder }, @@ -255,6 +255,12 @@

Source: components/Records/Search/Input/AdvancedSearch/Qu component: Licences, initialValue: () => [], }, + { + identifier: "countries", + name: "Countries", + component: Countries, + initialValue: () => [], + }, { identifier: "organisations", name: "Organisations", @@ -644,7 +650,7 @@

Documentation generated by JSDoc 4.0.3 - on Thu May 16th 2024 + on Mon Jul 15th 2024 using the DocStrap template. diff --git a/documentation/html/components_Records_Search_Input_FilterAutocomplete.vue.html b/documentation/html/components_Records_Search_Input_FilterAutocomplete.vue.html index 8337ee8dad..280e148347 100644 --- a/documentation/html/components_Records_Search_Input_FilterAutocomplete.vue.html +++ b/documentation/html/components_Records_Search_Input_FilterAutocomplete.vue.html @@ -54,7 +54,7 @@ @@ -142,6 +142,7 @@

Source: components/Records/Search/Input/FilterAutocomplet <script> import {mapGetters, mapState} from 'vuex' + import clearString from '@/utils/stringUtils' export default { @@ -312,9 +313,9 @@

- Documentation generated by JSDoc 3.6.11 + Documentation generated by JSDoc 4.0.3 - on Wed Sep 27th 2023 + on Mon Jul 15th 2024 using the DocStrap template. diff --git a/documentation/html/components_Records_Search_Input_FilterButton.vue.html b/documentation/html/components_Records_Search_Input_FilterButton.vue.html index 451543f3f4..4195aab733 100644 --- a/documentation/html/components_Records_Search_Input_FilterButton.vue.html +++ b/documentation/html/components_Records_Search_Input_FilterButton.vue.html @@ -54,7 +54,7 @@ @@ -122,6 +122,7 @@

Source: components/Records/Search/Input/FilterButton.vue< <script> import { isEqual } from "lodash"; import { mapActions } from 'vuex' + import currentParameter from "@/utils/currentParameterMixin.js" export default { @@ -276,9 +277,9 @@

- Documentation generated by JSDoc 3.6.11 + Documentation generated by JSDoc 4.0.3 - on Wed Sep 27th 2023 + on Mon Jul 15th 2024 using the DocStrap template. diff --git a/documentation/html/components_Records_Search_Input_SearchInput.vue.html b/documentation/html/components_Records_Search_Input_SearchInput.vue.html index 9c120d8a44..bd342548c2 100644 --- a/documentation/html/components_Records_Search_Input_SearchInput.vue.html +++ b/documentation/html/components_Records_Search_Input_SearchInput.vue.html @@ -54,7 +54,7 @@ @@ -136,10 +136,12 @@

Source: components/Records/Search/Input/SearchInput.vue import {mapGetters, mapState} from "vuex" + +import StringSearch from "@/components/Records/Search/Input/StringSearch"; import filterMapping from "@/data/FiltersLabelMapping.json"; + import FilterAutocomplete from "./FilterAutocomplete"; import FilterButtons from "./FilterButtons"; -import StringSearch from "@/components/Records/Search/Input/StringSearch"; export default { name: "SearchInput", @@ -281,9 +283,9 @@

- Documentation generated by JSDoc 3.6.11 + Documentation generated by JSDoc 4.0.3 - on Wed Sep 27th 2023 + on Mon Jul 15th 2024 using the DocStrap template. diff --git a/documentation/html/global.html b/documentation/html/global.html index db56128a35..9eb0328999 100644 --- a/documentation/html/global.html +++ b/documentation/html/global.html @@ -30,17 +30,31 @@ -
-
+
+
+ + +
+ +
+ + +

Global

+
+ +
+ +

+ +

+ + +
+ + +
+
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + + + + + + + +

Members

+ +
+ +
+
+

<constant> buildFacets

+ + +
+
+ +
+

Given an object containing the raw facets coming from the client and a mapping object , build the ready to use facets +for usage by the Vue components.

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<constant> buildFilters

+ + +
+
+ +
+

Given a searchFairsharingRecords aggregations array, build the values used by the advanced search widgets

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

filtersStore :Object

+ + +
+
+ +
+

The searchFilters store trigger a single field query to searchFairsharingRecords, gets the aggregation array and +builds the filtering system to be used by advanced search functions.

+
+ + + +
Type:
+
    +
  • + +Object + + + +
  • +
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

introspectionStore :Object

+ + +
+
+ +
+

The introspection store is related to the introspection query that let us know which fields/types are allowed by the searchFairsharingRecords query

+
+ + + +
Type:
+
    +
  • + +Object + + + +
  • +
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<constant> paramsAreExpired

+ + +
+
+ +
+

Compares the given date with now and returns true if it greater than the given timer

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

recordStore :Object

+ + +
+
+ +
+

The record store handles the requests related to record (fairsharingRecord).

+
+ + + +
Type:
+
    +
  • + +Object + + + +
  • +
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

<constant> recordTypes

+ + +
+
+ +
+

Mixin to filter the records types based on the registry +{{computed: {getRecordTypes: Computed}, methods: {filteredRecordTypes(*): *[]}}}

+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

recordsStore :Object

+ + +
+
+ +
+

The records store handles the requests related to records (searchFairsharingRecords and fairsharingRecord).

+
+ + + +
Type:
+
    +
  • + +Object + + + +
  • +
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ + + +
+
+

states :Object

+ + +
+
+ + + +
Type:
+
    +
  • + +Object + + + +
  • +
+ + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
errors + + +String + + + + +

collects errors while introspecting.

searchQueryParameters + + +object + + + + +

filters query parameters object coming from API.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + +
+ +
+ + + +

Methods

+ +
+ +
+
+

hackSearch()

+ + +
+
+ + +
+

Convert a prop from the old system into that used by the new. Useful when old search links +have been deployed elsewhere in the internet or in print (as long as we know about them).

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

String - new form of the old prop

+
+ + + + + + + +
+ + + +
+
+

hasValue(val)

+ + +
+
+ + +
+

Assess if the string is of a certain value (useful to compare passwords)

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
val + + +String + + + + +

the value to evaluate the string against

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +function + + + +
+
+ + + + + +
+ + + +
+
+

isAllowedSize()

+ + +
+
+ + +
+

Assess if the given file has the correct allowed size

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +function + + + +
+
+ + + + + +
+ + + +
+
+

isEmail()

+ + +
+
+ + +
+

Assess email patterns.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +function + + + +
+
+ + + + + +
+ + + +
+
+

isEmailOrUrl()

+ + +
+
+ + +
+

Assess email or email patterns.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +function + + + +
+
+ + + + + +
+ + + +
+
+

isImage()

+ + +
+
+ + +
+

Assess if the given file has the correct extension

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +function + + + +
+
+ + + + + +
+ + + +
+
+

isLongEnough(length)

+ + +
+
+ + +
+

Assess if the string is long enough.

+
+ + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
length + + +Number + + + + +

the length to evaluate the string against.

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +function + + + +
+
+ + + + + +
+ + + +
+
+

isMastodon()

+ + +
+
+ + +
+

Assess mastodon username @user@server.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +function + + + +
+
+ + + + + +
+ + + +
+
+

isOrcid()

+ + +
+
+ + +
+

Assess ORCID patterns. Can be empty if required is false.

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +function + + + +
+
+ + + + + +
+ + + +
+
+

isRequired()

+ + +
+
+ + +
+

Assess the presence of the field

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + -
+ -
- +
-

Global

-
-
-

- -

- + -
+ + + + + -
-
+
Returns:
+ + + + +
+
+ Type +
+
+ +function + + + +
+
+ + + +
+ + +
+
+

isUrl()

+ + +
+
+ + +
+

Assess URL patterns.

+
+ + + + + + + + + +
@@ -120,6 +2153,16 @@

+ +
Source:
+
+ +
@@ -130,9 +2173,7 @@

- -
@@ -143,23 +2184,45 @@

- +

Returns:
+ + + +
+
+ Type +
+
+ +function + + + +
+
+ + + -

Methods

+
-
+
-

registryIcons()

+

parseParam(param, paramVal)

+
+

Given a type and a value, parse the value with the expected type.

+
+ @@ -174,6 +2237,8 @@
Parameters:
+ Name + Type @@ -190,6 +2255,32 @@
Parameters:
+ param + + + + + +Object + + + + + + + + + + +

the parameter types allowed

+ + + + + + + paramVal + @@ -205,7 +2296,7 @@
Parameters:
-

registryName

+

the value to be parsed

@@ -249,8 +2340,8 @@
Parameters:
@@ -279,9 +2370,7 @@
Returns:
-
    -
  • icon name for registry
  • -
+

paramVal - the parse value

@@ -293,6 +2382,12 @@
Returns:
String +| + +Number +| + +Boolean @@ -303,19 +2398,32 @@
Returns:
+
Example
+ +

Example usage of parseParam

+ +
parseParam({name: "Boolean"}, "true");
+ // return True
+ + +

-

registryName()

+

removeItem(item, arrayList)

+
+

Removes an item from the array

+
+ @@ -330,6 +2438,8 @@
Parameters:
+ Name + Type @@ -346,14 +2456,28 @@
Parameters:
+ item + - -String + + + + + + + + + + + + arrayList + + @@ -361,7 +2485,7 @@
Parameters:
-

registryName

+ @@ -405,8 +2529,8 @@
Parameters:
@@ -436,7 +2560,7 @@
Returns:
    -
  • display name for registry
  • +
  • updated array without the item
@@ -448,7 +2572,119 @@
Returns:
-String +Array + + + +
+
+ + + + + +
+ + + +
+
+

uniqueValues()

+ + +
+
+ + +
+

Removes duplicate values in a set and returns unique values

+
+ + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+

Array with non-duplicate values

+
+ + + +
+
+ Type +
+
+ +Array @@ -515,7 +2751,7 @@ Documentation generated by JSDoc 4.0.3 - on Thu Jul 4th 2024 + on Mon Jul 15th 2024 using the DocStrap template. diff --git a/documentation/html/index.html b/documentation/html/index.html index 5e76067a86..81f43c6b00 100644 --- a/documentation/html/index.html +++ b/documentation/html/index.html @@ -30,17 +30,31 @@ +
+ + - - + + + @@ -219,5 +1237,13 @@

Source: lib/Client/RESTClient.js

+ + + + diff --git a/documentation/html/lib_GraphClient_GraphClient.js.html b/documentation/html/lib_GraphClient_GraphClient.js.html index 408994bf88..d22bb59437 100644 --- a/documentation/html/lib_GraphClient_GraphClient.js.html +++ b/documentation/html/lib_GraphClient_GraphClient.js.html @@ -30,17 +30,31 @@