@finos/legend-server-marketplace/src/MarketplaceServerClient.ts

Legend Marketplace server client

/**
 * Copyright (c) 2020-present, Goldman Sachs
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { type PlainObject, AbstractServerClient } from '@finos/legend-shared';
import type { LightProvider, ProviderResult } from './models/Provider.js';
import type { DataProductSearchResult } from './models/DataProduct.js';
import type { Subscription } from './models/Subscription.js';

export interface MarketplaceServerClientConfig {
  serverUrl: string;
  subscriptionUrl: string;
}

interface MarketplaceServerResponse<T> {
  response_code: string;
  status: string;
  results: T;
}

export class MarketplaceServerClient extends AbstractServerClient {
  subscriptionUrl: string;
  constructor(config: MarketplaceServerClientConfig) {
    super({
      baseUrl: config.serverUrl,
      networkClientOptions: {
        // NOTE: with the way we setup this server, we allow any (*) origin for CORS
        // so here we have to explicit omit credentials
        // See https://fetch.spec.whatwg.org/#concept-request-credentials-mode
        credentials: 'omit',
      },
    });

    this.subscriptionUrl = config.subscriptionUrl;
  }

  // ------------------------------------------- Vendors -------------------------------------------

  private _vendors = (): string => `${this.baseUrl}/v1/vendors`;

  getVendors = (): Promise<PlainObject<LightProvider>[]> =>
    this.get(this._vendors());

  getVendorsByCategory = async (
    category: string,
    limit: number,
  ): Promise<PlainObject<ProviderResult>[]> =>
    (
      await this.get<MarketplaceServerResponse<PlainObject<ProviderResult>[]>>(
        `${this.baseUrl}/v1/vendor/category?category=${category}&limit=${limit}`,
      )
    ).results;

  // ------------------------------------------- Search- -------------------------------------------

  private _search = (): string => `${this.baseUrl}/v1/search`;

  semanticSearch = async (
    query: string,
    vendorName: string,
    limit: number,
  ): Promise<PlainObject<DataProductSearchResult>[]> =>
    (
      await this.get<
        MarketplaceServerResponse<PlainObject<DataProductSearchResult>[]>
      >(
        `${this._search()}/semantic/catalog?query=${query}&vendor_name=${vendorName}&limit=${limit}`,
      )
    ).results;

  // ------------------------------------------- Subscriptions -----------------------------------------

  getSubscriptions = async (
    user: string,
  ): Promise<PlainObject<Subscription>[]> =>
    (
      await this.get<{ subscription_feeds: PlainObject<Subscription>[] }>(
        `${this.subscriptionUrl}/v1/service/subscription/${user}`,
      )
    ).subscription_feeds;
}