arlas-web-core 19.3.0-dev0 → 20.0.0-beta.4

package/services/collaborativesearch.service.d.ts

@@ -0,0 +1,353 @@
+import { Aggregation, AggregationResponse, CollectionReferenceDescription, Count, ExploreApi, FeatureCollection, Filter, Hits, Search, ComputationRequest, ComputationResponse } from 'arlas-api';
+import { Observable, Subject } from 'rxjs';
+import { CollectionCount } from '../utils/utils';
+import { Collaboration, CollaborationEvent } from '../models/collaboration';
+import { Contributor } from '../models/contributor';
+import { GeohashAggregation, TiledSearch, projType, GeoTileAggregation } from '../models/projections';
+import { ConfigService } from './config.service';
+export declare class CollaborativesearchService {
+    /**
+    * Bus of CollaborationEvent.
+    */
+    collaborationBus: Subject<CollaborationEvent>;
+    /**
+    * Bus of CollaborationEvent.
+    */
+    contribFilterBus: Subject<Contributor>;
+    /**
+    * Registry of Collaborations, Map of contributor identifier,Collaboration.
+    */
+    collaborations: Map<string, Collaboration>;
+    /**
+    * Registry of Contributor, Map of contributor identifier,Contributor.
+    */
+    registry: Map<string, Contributor>;
+    /**
+    * ARLAS SERVER collection used by default by the contributors.
+    */
+    defaultCollection: string;
+    /** ARLAS SERVER collections that declared in the contributos */
+    collections: Set<string>;
+    /**
+    * ARLAS SERVER max age cache used by the collaborativesearchService.
+    */
+    max_age: number;
+    /**
+    * Number of entity return by the collaborativesearchService at any time
+    */
+    countAll: Observable<CollectionCount[]>;
+    /**
+    * Bus number of ongoing subscribe to the collaborativesearchService
+    */
+    ongoingSubscribe: Subject<number>;
+    /**
+    * Bus number of ongoing subscribe to the collaborativesearchService
+    */
+    totalSubscribe: number;
+    /**
+    * Bus of Error.
+    */
+    collaborationErrorBus: Subject<Error>;
+    /**
+    * ARLAS SERVER Explore Api used by the collaborativesearchService.
+    */
+    private exploreApi;
+    /**
+    * Configuration Service used by the collaborativesearchService.
+    */
+    private configService;
+    /**
+    * Configuration object of fetch call. By default all credentials are included.
+    */
+    private fetchOptions;
+    constructor();
+    /**
+    * Return options used to fetch call.
+    * @returns Object.
+    */
+    getFetchOptions(): {
+        credentials: string;
+        signal?: any;
+        responseType?: string;
+        referrerPolicy?: string;
+    };
+    /**
+    * Set the fetch options.
+    * @param fetchOptions : Object.
+    */
+    setFetchOptions(fetchOptions: any): void;
+    /**
+    * Return the ARLAS Explore API.
+    * @returns ExploreApi.
+    */
+    getExploreApi(): ExploreApi;
+    /**
+    * Set the ARLAS Explore API.
+    * @param api : ExploreApi.
+    */
+    setExploreApi(exploreApi: ExploreApi): void;
+    /**
+    * Return the Configuraion Service.
+    * @returns ConfigService.
+    */
+    getConfigService(): ConfigService;
+    /**
+    * Set the Configuraion Service.
+    * @param configService ConfigService.
+    */
+    setConfigService(configService: ConfigService): void;
+    /**
+    *  Register contributor with its identifier in the map contributor registry.
+    */
+    register(identifier: string, contributor: Contributor): void;
+    /**
+    *  Register collections of the given contributor in a collections registry.
+    */
+    registerCollections(contributor: Contributor): void;
+    /**
+    * Add Filter setted by a contributor in the registry of collaboration, notify the collaborationBus of a changement.
+    * @param contributorId  Sting identifier of contributor.
+    * @param collaboration  Collaboration added by the contributor.
+    */
+    setFilter(contributorId: string, collaboration: Collaboration): void;
+    /**
+    * Remove Filter from the registry of collaboration , notify the collaborationBus of a removing changement.
+    * @param contributorId  Sting identifier of contributor.
+    * @param collaboration  Collaboration added by the contributor.
+    */
+    removeFilter(contributorId: string): void;
+    /**
+    * Remove all the collaborations filters,  notify the collaborationBus of a all removing changement.
+    */
+    removeAll(): void;
+    dataModelBuilder(filter: string): Object;
+    urlBuilder(): string;
+    /**
+    * Initialize all the contributor in the state of dataModel.
+    * @param dataModel
+    */
+    setCollaborations(dataModel: Object): void;
+    /**
+    * Retrieve the collaboration from a contributor identifier.
+    * @param contributorId  Identifier of a contributor.
+    * @returns Collaboration.
+    */
+    getCollaboration(contributorId: string): Collaboration;
+    /**
+    * Resolve an ARLAS Server Search or Count request with all the collaborations enabled in the collaboration registry
+    except for the contributor given in second optionnal parameter.
+    * @param projection  Type of projection of ARLAS Server request:Search or Count.
+    * @param contributorId  Identifier contributor to resolve the request without the collaboration of this contributor.
+    * @param filter  ARLAS API filter to resolve the request with this filter in addition.
+    * @param isFlat  Whether flatten json.
+    * @param max_age  Duration of browser cache.
+    * @returns ARLAS Server observable.
+    */
+    resolveButNotHits(projection: [
+        projType.search,
+        Search
+    ] | [projType.count, Count], collaborations: Map<string, Collaboration>, collection: any, contributorId?: string, filter?: Filter, isFlat?: boolean, max_age?: number): Observable<Hits>;
+    /**
+    * Resolve an ARLAS Server Search or Count  request for an optional contributor and optional filters.
+    * @param projection  Type of projection of ARLAS Server request :Search or Count .
+    * @param contributorId  Identifier contributor to resolve the request with the collaboration of this contributor.
+    * @param filter  ARLAS API filter to resolve the request with this filter in addition.
+    * @param isFlat  Whether flatten json.
+    * @param max_age  Duration of browser cache.
+    * @returns ARLAS Server observable.
+    */
+    resolveHits(projection: [
+        projType.search,
+        Search
+    ] | [projType.count, Count], collaborations: Map<string, Collaboration>, collection: any, contributorId?: string, filter?: Filter, isFlat?: boolean, max_age?: number): Observable<Hits>;
+    /**
+    * Resolve an ARLAS Server Search or Count  request for an array of filter.
+    * @param projection  Type of projection of ARLAS Server request :Search or Count .
+    * @param filters  ARLAS API filters to resolve the request with compute
+    * @param isFlat  Whether flatten json.
+    * @param max_age  Duration of browser cache.
+    * @returns ARLAS Server observable.
+    */
+    resolveComputeHits(projection: [
+        projType.search,
+        Search
+    ] | [projType.count, Count], filters: Array<Filter>, collection: any, isFlat?: boolean, max_age?: number): Observable<Hits>;
+    /**
+    * Resolve an ARLAS Server Geosearch or Geoaggregate request with all the collaborations enabled in the collaboration registry
+    except for the contributor given in second optionnal parameter.
+    * @param projection  Type of projection of ARLAS Server request:Geosearch or Geoaggregate.
+    * @param isFlat  Boolean option to isFlat output geojson properties.
+    * @param contributorId  Identifier contributor to resolve the request without the collaboration of this contributor.
+    * @param filter  ARLAS API filter to resolve the request with this filter in addition.
+    * @param max_age  Duration of browser cache.
+    * @returns ARLAS Server observable.
+    */
+    resolveButNotFeatureCollection(projection: [
+        projType.geosearch,
+        Search
+    ] | [projType.tiledgeosearch, TiledSearch] | [projType.geohashgeoaggregate, GeohashAggregation] | [projType.geotilegeoaggregate, GeoTileAggregation] | [projType.geoaggregate, Array<Aggregation>], collaborations: Map<string, Collaboration>, collection: any, isFlat?: boolean, contributorId?: string, filter?: Filter, max_age?: number): Observable<FeatureCollection>;
+    resolveButNotShapefile(projection: [
+        projType.shapeaggregate,
+        Array<Aggregation>
+    ] | [projType.shapesearch, Search], collaborations: Map<string, Collaboration>, collection: any, isFlat?: boolean, contributorId?: string, filter?: Filter, max_age?: number): Observable<ArrayBuffer>;
+    resolveButNotFeatureCollectionWithAbort(projection: [
+        projType.geosearch,
+        Search
+    ] | [projType.tiledgeosearch, TiledSearch] | [projType.geohashgeoaggregate, GeohashAggregation] | [projType.geotilegeoaggregate, GeoTileAggregation] | [projType.geoaggregate, Array<Aggregation>], collaborations: Map<string, Collaboration>, collection: any, isFlat: boolean, abortableSignal: any, contributorId?: string, filter?: Filter, max_age?: number): Observable<FeatureCollection>;
+    /**
+    * Resolve an ARLAS Server Geosearch or Geoaggregate  request for an optional
+    contributor and optional filters.
+    * @param projection  Type of projection of ARLAS Server request :Geosearch or Geoaggregate.
+    * @param isFlat  Boolean option to flat output geojson properties.
+    * @param contributorId  Identifier contributor to resolve the request with the collaboration of this contributor.
+    * @param filter  ARLAS API filter to resolve the request with this filter in addition.
+    * @param max_age  Duration of browser cache.
+    * @returns ARLAS Server observable.
+    */
+    resolveFeatureCollection(projection: [
+        projType.geosearch,
+        Search
+    ] | [projType.tiledgeosearch, TiledSearch] | [projType.geohashgeoaggregate, GeohashAggregation] | [projType.geotilegeoaggregate, GeoTileAggregation] | [projType.geoaggregate, Array<Aggregation>], isFlat: boolean, collaborations: Map<string, Collaboration>, collection: any, contributorId?: string, filter?: Filter, max_age?: number): Observable<FeatureCollection>;
+    /**
+    * Resolve an ARLAS Server Aggregation request with all the collaborations enabled in the collaboration registry
+    except for the contributor given in second optionnal parameter.
+    * @param projection  Type of projection of ARLAS Server request:Aggregation.
+    * @param contributorId  Identifier contributor to resolve the request without the collaboration of this contributor.
+    * @param filter  ARLAS API filter to resolve the request with this filter in addition.
+    * @param isFlat  Whether flatten json.
+    * @param max_age  Duration of browser cache.
+    * @returns ARLAS Server observable.
+    */
+    resolveButNotAggregation(projection: [
+        projType.aggregate,
+        Array<Aggregation>
+    ], collaborations: Map<string, Collaboration>, collection: any, contributorId?: string, filter?: Filter, isFlat?: boolean, max_age?: number): Observable<AggregationResponse>;
+    /**
+    * Resolve an ARLAS Server Aggregation request for an optional contributor and optional filters.
+    * @param projection  Type of projection of ARLAS Server request :Aggregation.
+    * @param contributorId  Identifier contributor to resolve the request with the collaboration of this contributor.
+    * @param filter  ARLAS API filter to resolve the request with this filter in addition.
+    * @param isFlat  Whether flatten json.
+    * @param max_age  Duration of browser cache.
+    * @returns ARLAS Server observable.
+    */
+    resolveAggregation(projection: [
+        projType.aggregate,
+        Array<Aggregation>
+    ], collaborations: Map<string, Collaboration>, collection: any, contributorId?: string, filter?: Filter, isFlat?: boolean, max_age?: number): Observable<AggregationResponse>;
+    /**
+    * Resolve an ARLAS Server Computation request with all the collaborations enabled in the collaboration registry
+    except for the contributor given in second optionnal parameter.
+    * @param projection  Type of projection of ARLAS Server request : ComputationRequest.
+    * @param collaborations  Map<contributorId, itsCollboration>
+    * @param contributorId  Identifier contributor to resolve the request without the collaboration of this contributor.
+    * @param filter  ARLAS API filter to resolve the request with this filter in addition.
+    * @param isFlat  Whether flatten json.
+    * @param max_age  Duration of browser cache.
+    * @returns ARLAS Server observable.
+    */
+    resolveButNotComputation(projection: [
+        projType.compute,
+        ComputationRequest
+    ], collaborations: Map<string, Collaboration>, collection: any, contributorId?: string, filter?: Filter, isFlat?: boolean, max_age?: number): Observable<ComputationResponse>;
+    /**
+    * Enable a contributor collaboration from its identifier.
+    */
+    enable(contributorId: string): void;
+    /**
+    * Disable a contributor collaboration from its identifier.
+    */
+    disable(contributorId: string): void;
+    /**
+    * Retrieve all the contributor identifiers.
+    * @returns List of contributor idenfiers.
+    */
+    getAllContributors(): Array<string>;
+    /**
+    * Retrieve the contributor identifiers for which the collaboration is enabled.
+    * @returns List of contributor idenfiers.
+    */
+    getEnableContributors(): Array<string>;
+    /**
+    * Retrieve the contributor identifiers for which the collaboration is disabled.
+    * @returns List of contributor idenfiers.
+    */
+    getDisableContributors(): Array<string>;
+    /**
+    * Retrieve enabled parameter of collaboration from a contributor identifier.
+    * @returns Contributor collaboration enabled properties.
+    */
+    isEnable(contributorId: string): boolean;
+    /**
+    * Update countAll property.
+    */
+    setCountAll(collaborations: Map<string, Collaboration>): void;
+    /**
+     * Build query parameters from aggregation and filters
+     * @return Url encoded string
+     */
+    getUrl(projection: [
+        projType.geoaggregate | projType.geosearch | projType.aggregate | projType.shapeaggregate | projType.shapesearch | projType.count | projType.geohashgeoaggregate | projType.geotilegeoaggregate | projType.search | projType.tiledgeosearch,
+        Array<Aggregation>
+    ], filters: Array<Filter>, max_age?: number): string;
+    getFinalFilter(filters: Array<Filter>): Filter;
+    /**
+     * Describe the structure and the content of the given collection.
+     * @param collection collection name
+     * @param pretty Whether pretty print or not
+     * @param max_age  Duration of browser cache.s
+     */
+    describe(collection: string, pretty?: boolean, max_age?: number): Observable<CollectionReferenceDescription>;
+    /**
+     * Lists the collections configured in ARLAS.
+     * @param pretty Whether pretty print or not
+     */
+    list(pretty?: boolean): Observable<Array<CollectionReferenceDescription>>;
+    /**
+    * Set enabled value of a collaboration from a contributor identifier.
+    * @param enabled  Enabled collaboration value.
+    * @param contributorId  Contributor identifier.
+    */
+    private setEnable;
+    /**
+    * Resolve an ARLAS Server request for an optional contributor and optional filters.
+    * @param projection  Type of projection of ARLAS Server request.
+    * @param contributorId  Identifier contributor to resolve the request with the collaboration of this contributor.
+    * @param filter  ARLAS API filter to resolve the request with this filter in addition.
+    * @param isFlat  Boolean option to flat output geojson properties.
+    * @returns ARLAS Server observable.
+    */
+    private resolve;
+    /**
+    * Resolve an ARLAS Server request with all the collaborations enabled in the collaboration registry
+    except for the contributor given in second optionnal parameter.
+    * @param projection  Type of projection of ARLAS Server request.
+    * @param contributorId  Identifier contributor to resolve the request without the collaboration of this contributor.
+    * @param filter  ARLAS API filter to resolve the request with this filter in addition.
+    * @param isFlat  Boolean option to flat output geojson properties.
+    * @param max_age  Duration of browser cache.
+    * @returns ARLAS Server observable.
+    */
+    private resolveButNot;
+    /**
+    * Build an ARLAS Server request from an Array of Filter
+    * @param projection  Type of projection of ARLAS Server request.
+    * @param filters   ARLAS API filters list to resolve the request.
+    * @param isFlat  Boolean option to flat output geojson properties.
+    * @returns ARLAS Server observable.
+    */
+    private computeResolve;
+    /**
+    * Build an AggregationsRequest String[] for get mode request
+    * @param aggregationRequest  AggregationsRequest arlas object use in post request.
+    * @returns aggregations as string[].
+    */
+    private buildAggGetParam;
+    /**
+    * Build an filter String[] or string for get mode request
+    * @param field
+    * @param filter
+    * @returns aggregations as string[].
+    */
+    private buildFilterFieldGetParam;
+}