import { combineLatest as observableCombineLatest, Observable, interval } from 'rxjs'; import { filter, find, map, switchMap, take, takeWhile, debounce, debounceTime } from 'rxjs/operators'; import { hasNoValue, hasValue, hasValueOperator, isNotEmpty } from '../../shared/empty.util'; import { SearchResult } from '../../shared/search/models/search-result.model'; import { PaginatedList } from '../data/paginated-list.model'; import { RemoteData } from '../data/remote-data'; import { MetadataField } from '../metadata/metadata-field.model'; import { MetadataSchema } from '../metadata/metadata-schema.model'; import { BrowseDefinition } from './browse-definition.model'; import { DSpaceObject } from './dspace-object.model'; import { InjectionToken } from '@angular/core'; import { MonoTypeOperatorFunction, SchedulerLike } from 'rxjs/internal/types'; /** * Use this method instead of the RxJs debounceTime if you're waiting for debouncing in tests; * debounceTime doesn't work with fakeAsync/tick anymore as of Angular 13.2.6 & RxJs 7.5.5 * Workaround suggested in https://github.com/angular/angular/issues/44351#issuecomment-1107454054 * todo: remove once the above issue is fixed */ export const debounceTimeWorkaround = (dueTime: number, scheduler?: SchedulerLike): MonoTypeOperatorFunction => { return debounce(() => interval(dueTime, scheduler)); }; export const DEBOUNCE_TIME_OPERATOR = new InjectionToken<(dueTime: number) => (source: Observable) => Observable>('debounceTime', { providedIn: 'root', factory: () => debounceTime }); export const getRemoteDataPayload = () => (source: Observable>): Observable => source.pipe(map((remoteData: RemoteData) => remoteData.payload)); export const getPaginatedListPayload = () => (source: Observable>): Observable => source.pipe(map((list: PaginatedList) => list.page)); export const getAllCompletedRemoteData = () => (source: Observable>): Observable> => source.pipe(filter((rd: RemoteData) => hasValue(rd) && rd.hasCompleted)); export const getFirstCompletedRemoteData = () => (source: Observable>): Observable> => source.pipe(getAllCompletedRemoteData(), take(1)); export const takeUntilCompletedRemoteData = () => (source: Observable>): Observable> => source.pipe(takeWhile((rd: RemoteData) => hasNoValue(rd) || rd.isLoading, true)); export const getFirstSucceededRemoteData = () => (source: Observable>): Observable> => source.pipe(filter((rd: RemoteData) => rd.hasSucceeded), take(1)); export const getFirstSucceededRemoteWithNotEmptyData = () => (source: Observable>): Observable> => source.pipe(find((rd: RemoteData) => rd.hasSucceeded && isNotEmpty(rd.payload))); /** * Get the first successful remotely retrieved object * * You usually don't want to use this, it is a code smell. * Work with the RemoteData object instead, that way you can * handle loading and errors correctly. * * These operators were created as a first step in refactoring * out all the instances where this is used incorrectly. */ export const getFirstSucceededRemoteDataPayload = () => (source: Observable>): Observable => source.pipe( getFirstSucceededRemoteData(), getRemoteDataPayload() ); /** * Get the first successful remotely retrieved object with not empty payload * * You usually don't want to use this, it is a code smell. * Work with the RemoteData object instead, that way you can * handle loading and errors correctly. * * These operators were created as a first step in refactoring * out all the instances where this is used incorrectly. */ export const getFirstSucceededRemoteDataWithNotEmptyPayload = () => (source: Observable>): Observable => source.pipe( getFirstSucceededRemoteWithNotEmptyData(), getRemoteDataPayload() ); /** * Get the all successful remotely retrieved objects * * You usually don't want to use this, it is a code smell. * Work with the RemoteData object instead, that way you can * handle loading and errors correctly. * * These operators were created as a first step in refactoring * out all the instances where this is used incorrectly. */ export const getAllSucceededRemoteDataPayload = () => (source: Observable>): Observable => source.pipe( getAllSucceededRemoteData(), getRemoteDataPayload() ); /** * Get the first successful remotely retrieved paginated list * as an array * * You usually don't want to use this, it is a code smell. * Work with the RemoteData object instead, that way you can * handle loading and errors correctly. * * You also don't want to ignore pagination and simply use the * page as an array. * * These operators were created as a first step in refactoring * out all the instances where this is used incorrectly. */ export const getFirstSucceededRemoteListPayload = () => (source: Observable>>): Observable => source.pipe( getFirstSucceededRemoteData(), getRemoteDataPayload(), getPaginatedListPayload() ); /** * Get all successful remotely retrieved paginated lists * as arrays * * You usually don't want to use this, it is a code smell. * Work with the RemoteData object instead, that way you can * handle loading and errors correctly. * * You also don't want to ignore pagination and simply use the * page as an array. * * These operators were created as a first step in refactoring * out all the instances where this is used incorrectly. */ export const getAllSucceededRemoteListPayload = () => (source: Observable>>): Observable => source.pipe( getAllSucceededRemoteData(), getRemoteDataPayload(), getPaginatedListPayload() ); export const getFinishedRemoteData = () => (source: Observable>): Observable> => source.pipe(find((rd: RemoteData) => !rd.isLoading)); export const getAllSucceededRemoteData = () => (source: Observable>): Observable> => source.pipe(filter((rd: RemoteData) => rd.hasSucceeded)); export const toDSpaceObjectListRD = () => (source: Observable>>>): Observable>> => source.pipe( filter((rd: RemoteData>>) => rd.hasSucceeded), map((rd: RemoteData>>) => { const dsoPage: T[] = rd.payload.page.filter((result) => hasValue(result)).map((searchResult: SearchResult) => searchResult.indexableObject); const payload = Object.assign(rd.payload, { page: dsoPage }) as PaginatedList; return Object.assign(rd, { payload: payload }); }) ); /** * Get the browse links from a definition by ID given an array of all definitions * @param {string} definitionID * @returns {(source: Observable>) => Observable} */ export const getBrowseDefinitionLinks = (definitionID: string) => (source: Observable>>): Observable => source.pipe( getRemoteDataPayload(), getPaginatedListPayload(), map((browseDefinitions: BrowseDefinition[]) => browseDefinitions .find((def: BrowseDefinition) => def.id === definitionID) ), map((def: BrowseDefinition) => { if (isNotEmpty(def)) { return def._links; } else { throw new Error(`No metadata browse definition could be found for id '${definitionID}'`); } }) ); /** * Get the first occurrence of an object within a paginated list */ export const getFirstOccurrence = () => (source: Observable>>): Observable> => source.pipe( map((rd) => Object.assign(rd, { payload: rd.payload.page.length > 0 ? rd.payload.page[0] : undefined })) ); /** * Operator for turning the current page of bitstreams into an array */ export const paginatedListToArray = () => (source: Observable>>): Observable => source.pipe( hasValueOperator(), map((objectRD: RemoteData>) => objectRD.payload.page.filter((object: T) => hasValue(object))) ); /** * Operator for turning a list of metadata fields into an array of string representing their schema.element.qualifier string */ export const metadataFieldsToString = () => (source: Observable>>): Observable => source.pipe( hasValueOperator(), map((fieldRD: RemoteData>) => { return fieldRD.payload.page.filter((object: MetadataField) => hasValue(object)); }), switchMap((fields: MetadataField[]) => { const fieldSchemaArray = fields.map((field: MetadataField) => { return field.schema.pipe( getFirstSucceededRemoteDataPayload(), map((schema: MetadataSchema) => ({ field, schema })) ); }); return isNotEmpty(fieldSchemaArray) ? observableCombineLatest(fieldSchemaArray) : [[]]; }), map((fieldSchemaArray: { field: MetadataField, schema: MetadataSchema }[]): string[] => { return fieldSchemaArray.map((fieldSchema: { field: MetadataField, schema: MetadataSchema }) => fieldSchema.schema.prefix + '.' + fieldSchema.field.toString()); }) );