Merge branch 'release/23.10.0'

Author: adlius

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [23.10.0] - 2023-08-28
+### Added
+- Added search improvement routes and related components
+
 ## [23.09.0] - 2023-08-16
 ### Changed
 - Added Google Tag Manager
@@ -1936,6 +1940,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 - Quick Files
 
+[23.10.0]: https://github.com/CenterForOpenScience/ember-osf-web/releases/tag/23.10.0
 [23.09.0]: https://github.com/CenterForOpenScience/ember-osf-web/releases/tag/23.09.0
 [23.08.0]: https://github.com/CenterForOpenScience/ember-osf-web/releases/tag/23.08.0
 [23.07.0]: https://github.com/CenterForOpenScience/ember-osf-web/releases/tag/23.07.0

app/adapters/index-card-search.ts

@@ -0,0 +1,12 @@
+import ShareAdapter from './share-adapter';
+export default class IndexCardSearchAdapter extends ShareAdapter {
+    pathForType() {
+        return 'index-card-search';
+    }
+}
+
+declare module 'ember-data/types/registries/adapter' {
+    export default interface AdapterRegistry {
+        'index-card-search': IndexCardSearchAdapter;
+    } // eslint-disable-line semi
+}

app/adapters/index-card.ts

@@ -0,0 +1,13 @@
+import ShareAdapter from './share-adapter';
+
+export default class IndexCardAdapter extends ShareAdapter {
+    pathForType() {
+        return 'index-card';
+    }
+}
+
+declare module 'ember-data/types/registries/adapter' {
+    export default interface AdapterRegistry {
+        'index-card': IndexCardAdapter;
+    } // eslint-disable-line semi
+}

app/adapters/index-value-search.ts

@@ -0,0 +1,13 @@
+import ShareAdapter from './share-adapter';
+
+export default class IndexValueSearchAdapter extends ShareAdapter {
+    pathForType() {
+        return 'index-value-search';
+    }
+}
+
+declare module 'ember-data/types/registries/adapter' {
+    export default interface AdapterRegistry {
+        'index-value-search': IndexValueSearchAdapter;
+    } // eslint-disable-line semi
+}

app/adapters/related-property-path.ts

@@ -0,0 +1,10 @@
+import ShareAdapter from './share-adapter';
+
+export default class RelatedPropertyPathAdapter extends ShareAdapter {
+}
+
+declare module 'ember-data/types/registries/adapter' {
+    export default interface AdapterRegistry {
+        'related-property-path': RelatedPropertyPathAdapter;
+    } // eslint-disable-line semi
+}

app/adapters/search-result.ts

@@ -0,0 +1,10 @@
+import ShareAdapter from './share-adapter';
+
+export default class SearchResultAdapter extends ShareAdapter {
+}
+
+declare module 'ember-data/types/registries/adapter' {
+    export default interface AdapterRegistry {
+        'search-result': SearchResultAdapter;
+    } // eslint-disable-line semi
+}

app/adapters/share-adapter.ts

@@ -0,0 +1,7 @@
+import JSONAPIAdapter from '@ember-data/adapter/json-api';
+import config from 'ember-get-config';
+
+export default class ShareAdapter extends JSONAPIAdapter {
+    host = config.OSF.shareBaseUrl.replace(/\/$/, ''); // Remove trailing slash to avoid // in URLs
+    namespace = 'api/v3';
+}

app/app.ts

@@ -56,6 +56,7 @@ const App = Application.extend({
                     'osf-router',
                 ],
                 externalRoutes: {
+                    search: 'search',
                     'guid-registration': 'guid-registration',
                     'guid-registration.analytics': 'guid-registration.analytics',
                     'guid-registration.forks': 'guid-registration.forks',

app/dashboard/template.hbs

@@ -239,7 +239,7 @@
             <OsfLink
                 data-analytics-name='noteworthy_search'
                 local-class='btn btn-default'
-                @href='/search/?q=*'
+                @route='search'
             >
                 {{t 'dashboard.noteworthy.search_more'}}
             </OsfLink>

app/helpers/get-localized-property.ts

@@ -0,0 +1,40 @@
+import Helper from '@ember/component/helper';
+import { inject as service } from '@ember/service';
+import IntlService from 'ember-intl/services/intl';
+
+import { LanguageText } from 'ember-osf-web/models/index-card';
+
+/**
+ * This helper is used to get a locale-appropriate string for a property from a metadata hash.
+ * It is used to fetch metadata fields from a index-card's resourceMetadata attribute, but can be used for any
+ * hash that contains an array of LangaugeText objects.
+ * If the property is not found, the first value in the array is returned, or if the property is found,
+ * but there is no locale-appropriate value, the first value in the array is returned.
+ *
+ * @example
+ * ```handlebars
+ * {{get-localized-property indexCard.resourceMetadata 'title'}}
+ * ```
+ *  where `indexCard` is an index-card model instance.
+ * @class get-localized-property
+ * @param {Object} metadataHash The metadata hash to search for the property
+ * @param {String} propertyName The name of the property to search for
+ * @return {String} The locale-appropriate string or the first value in the array or 'Not provided' message
+ */
+export default class GetLocalizedPropertyHelper extends Helper {
+    @service intl!: IntlService;
+
+    compute([metadataHash, propertyName]: [Record<string, LanguageText[]>, string]): string {
+        const locale = this.intl.locale;
+        const valueOptions = metadataHash?.[propertyName];
+        if (!metadataHash || !valueOptions || valueOptions.length === 0) {
+            return this.intl.t('helpers.get-localized-property.not-provided');
+        }
+
+        const index = valueOptions.findIndex((valueOption: LanguageText) => valueOption['@language'] === locale);
+        if (index === -1) {
+            return valueOptions[0]['@value'];
+        }
+        return valueOptions[index]['@value'];
+    }
+}