@finos/legend-application-marketplace/lib/__lib__/LegendMarketplaceNavigation.js

Legend Marketplace application core

/**
 * 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 { generatePath } from '@finos/legend-application/browser';
import { addQueryParametersToUrl, stringifyQueryParams, } from '@finos/legend-shared';
import { generateGAVCoordinates } from '@finos/legend-storage';
export var LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN;
(function (LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN) {
    LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN["VENDOR_NAME"] = "vendorName";
    LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN["GAV"] = "gav";
    LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN["DATA_PRODUCT_PATH"] = "path";
    LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN["DATA_PRODUCT_ID"] = "dataProductId";
    LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN["DEPLOYMENT_ID"] = "deploymentId";
    LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN["TERMINAL_ID"] = "terminalId";
    LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN["DATA_CONTRACT_ID"] = "dataContractId";
    LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN["DATA_CONTRACT_TASK_ID"] = "dataContractTaskId";
    LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN["DATA_ACCESS_REQUEST_ID"] = "dataAccessRequestId";
})(LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN || (LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN = {}));
export var LEGEND_MARKETPLACE_SEARCH_RESULTS_QUERY_PARAM_TOKEN;
(function (LEGEND_MARKETPLACE_SEARCH_RESULTS_QUERY_PARAM_TOKEN) {
    LEGEND_MARKETPLACE_SEARCH_RESULTS_QUERY_PARAM_TOKEN["PROVIDER"] = "provider";
    LEGEND_MARKETPLACE_SEARCH_RESULTS_QUERY_PARAM_TOKEN["QUERY"] = "query";
})(LEGEND_MARKETPLACE_SEARCH_RESULTS_QUERY_PARAM_TOKEN || (LEGEND_MARKETPLACE_SEARCH_RESULTS_QUERY_PARAM_TOKEN = {}));
export var LEGEND_MARKETPLACE_LAKEHOUSE_SEARCH_RESULTS_QUERY_PARAM_TOKEN;
(function (LEGEND_MARKETPLACE_LAKEHOUSE_SEARCH_RESULTS_QUERY_PARAM_TOKEN) {
    LEGEND_MARKETPLACE_LAKEHOUSE_SEARCH_RESULTS_QUERY_PARAM_TOKEN["QUERY"] = "query";
    LEGEND_MARKETPLACE_LAKEHOUSE_SEARCH_RESULTS_QUERY_PARAM_TOKEN["USE_PRODUCER_SEARCH"] = "useProducerSearch";
})(LEGEND_MARKETPLACE_LAKEHOUSE_SEARCH_RESULTS_QUERY_PARAM_TOKEN || (LEGEND_MARKETPLACE_LAKEHOUSE_SEARCH_RESULTS_QUERY_PARAM_TOKEN = {}));
export var LEGEND_MARKETPLACE_FIELD_SEARCH_RESULTS_QUERY_PARAM_TOKEN;
(function (LEGEND_MARKETPLACE_FIELD_SEARCH_RESULTS_QUERY_PARAM_TOKEN) {
    LEGEND_MARKETPLACE_FIELD_SEARCH_RESULTS_QUERY_PARAM_TOKEN["QUERY"] = "query";
})(LEGEND_MARKETPLACE_FIELD_SEARCH_RESULTS_QUERY_PARAM_TOKEN || (LEGEND_MARKETPLACE_FIELD_SEARCH_RESULTS_QUERY_PARAM_TOKEN = {}));
export var LEGEND_MARKETPLACE_ENTITLEMENTS_QUERY_PARAM_TOKEN;
(function (LEGEND_MARKETPLACE_ENTITLEMENTS_QUERY_PARAM_TOKEN) {
    LEGEND_MARKETPLACE_ENTITLEMENTS_QUERY_PARAM_TOKEN["SELECTED_TAB"] = "selectedTab";
})(LEGEND_MARKETPLACE_ENTITLEMENTS_QUERY_PARAM_TOKEN || (LEGEND_MARKETPLACE_ENTITLEMENTS_QUERY_PARAM_TOKEN = {}));
export var LEGEND_MARKETPLACE_DATA_APIS_QUERY_PARAM_TOKEN;
(function (LEGEND_MARKETPLACE_DATA_APIS_QUERY_PARAM_TOKEN) {
    LEGEND_MARKETPLACE_DATA_APIS_QUERY_PARAM_TOKEN["QUERY"] = "query";
})(LEGEND_MARKETPLACE_DATA_APIS_QUERY_PARAM_TOKEN || (LEGEND_MARKETPLACE_DATA_APIS_QUERY_PARAM_TOKEN = {}));
export const LEGEND_MARKETPLACE_ROUTE_PATTERN = Object.freeze({
    HOME_PAGE: '/',
    OAUTH_CALLBACK: '/callback',
    // PRODUCTS
    DATA_PRODUCTS: '/dataproducts',
    DATA_APIS: '/data-apis',
    AGENTS: '/agents',
    INVENTORY: '/inventory',
    SUBSCRIPTIONS: '/subscriptions',
    ORDERS: '/orders',
    TERMINAL_PRODUCT: `/terminal/terminalProduct/:${LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN.TERMINAL_ID}`,
    TERMINAL_ADD_ONS: `/terminals-and-addons`,
    // Data Products
    DATA_PRODUCT: `/dataProduct/deployed/:${LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN.DATA_PRODUCT_ID}/:${LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN.DEPLOYMENT_ID}`,
    LEGACY_DATA_PRODUCT: `/dataProduct/legacy/:${LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN.GAV}/:${LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN.DATA_PRODUCT_PATH}`,
    SDLC_DATA_PRODUCT: `/dataProduct/:${LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN.GAV}/:${LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN.DATA_PRODUCT_PATH}`,
    DATA_PRODUCT_SEARCH_RESULTS: '/dataProduct/results',
    FIELD_SEARCH_RESULTS: '/dataProduct/fields/results',
    // Lakehouse
    LAKEHOUSE_ENTITLEMENTS: '/lakehouse/entitlements',
    LAKEHOUSE_ENTITLEMENTS_CONTRACT_TASK: `/lakehouse/entitlements/:${LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN.DATA_CONTRACT_ID}/:${LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN.DATA_CONTRACT_TASK_ID}`,
    LAKEHOUSE_ENTITLEMENTS_WORKFLOW_DATA_ACCESS_REQUEST: `/lakehouse/entitlements/workflowDataAccessRequest/:${LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN.DATA_ACCESS_REQUEST_ID}`,
    LAKEHOUSE_ENTITLEMENTS_PERMIT_DATA_ACCESS_REQUEST: `/lakehouse/entitlements/permitDataAccessRequest/:${LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN.DATA_ACCESS_REQUEST_ID}`,
    LAKEHOUSE_ADMIN: '/lakehouse/admin',
    // Deprecated
    DEPRECATED_LAKEHOUSE: '/lakehouse',
    DEPRECATED_LAKEHOUSE_SEARCH_RESULTS: '/lakehouse/results',
    DEPRECATED_LAKEHOUSE_PRODUCT: `/lakehouse/dataProduct/deployed/:${LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN.DATA_PRODUCT_ID}/:${LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN.DEPLOYMENT_ID}`,
    DEPRECATED_LAKEHOUSE_SDLC_PRODUCT: `/lakehouse/dataProduct/:${LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN.GAV}/:${LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN.DATA_PRODUCT_PATH}`,
});
export const generateLakehouseDataProductPath = (dataProductId, deploymentId) => generatePath(LEGEND_MARKETPLACE_ROUTE_PATTERN.DATA_PRODUCT, {
    dataProductId,
    deploymentId: deploymentId.toString(),
});
export const generateContractPagePath = (dataContractId, dataContractTaskId) => generatePath(LEGEND_MARKETPLACE_ROUTE_PATTERN.LAKEHOUSE_ENTITLEMENTS_CONTRACT_TASK, {
    dataContractId,
    dataContractTaskId,
});
export const generateWorkflowDataAccessRequestPagePath = (dataAccessRequestId) => generatePath(LEGEND_MARKETPLACE_ROUTE_PATTERN.LAKEHOUSE_ENTITLEMENTS_WORKFLOW_DATA_ACCESS_REQUEST, {
    dataAccessRequestId,
});
export const generatePermitDataAccessRequestPagePath = (dataAccessRequestId) => generatePath(LEGEND_MARKETPLACE_ROUTE_PATTERN.LAKEHOUSE_ENTITLEMENTS_PERMIT_DATA_ACCESS_REQUEST, {
    dataAccessRequestId,
});
export const generateLegacyDataProductPath = (gav, path) => generatePath(LEGEND_MARKETPLACE_ROUTE_PATTERN.LEGACY_DATA_PRODUCT, {
    gav,
    path,
});
export const generateSdlcDataProductPath = (gav, path) => generatePath(LEGEND_MARKETPLACE_ROUTE_PATTERN.SDLC_DATA_PRODUCT, {
    gav,
    path,
});
export const generateLakehouseSearchResultsRoute = (query, useProducerSearch) => addQueryParametersToUrl(LEGEND_MARKETPLACE_ROUTE_PATTERN.DATA_PRODUCT_SEARCH_RESULTS, stringifyQueryParams({
    [LEGEND_MARKETPLACE_LAKEHOUSE_SEARCH_RESULTS_QUERY_PARAM_TOKEN.QUERY]: query ? query : undefined,
    [LEGEND_MARKETPLACE_LAKEHOUSE_SEARCH_RESULTS_QUERY_PARAM_TOKEN.USE_PRODUCER_SEARCH]: useProducerSearch ? useProducerSearch : undefined,
}));
export const generateSearchResultsRoute = (provider, query) => addQueryParametersToUrl(LEGEND_MARKETPLACE_ROUTE_PATTERN.DATA_PRODUCT_SEARCH_RESULTS, stringifyQueryParams({
    [LEGEND_MARKETPLACE_SEARCH_RESULTS_QUERY_PARAM_TOKEN.PROVIDER]: provider
        ? provider
        : undefined,
    [LEGEND_MARKETPLACE_SEARCH_RESULTS_QUERY_PARAM_TOKEN.QUERY]: query
        ? query
        : undefined,
}));
export const generateFieldSearchResultsRoute = (query) => addQueryParametersToUrl(LEGEND_MARKETPLACE_ROUTE_PATTERN.FIELD_SEARCH_RESULTS, stringifyQueryParams({
    [LEGEND_MARKETPLACE_FIELD_SEARCH_RESULTS_QUERY_PARAM_TOKEN.QUERY]: query,
}));
export const generateLakehouseEntitlementsRoute = (selectedTab) => addQueryParametersToUrl(LEGEND_MARKETPLACE_ROUTE_PATTERN.LAKEHOUSE_ENTITLEMENTS, stringifyQueryParams({
    [LEGEND_MARKETPLACE_ENTITLEMENTS_QUERY_PARAM_TOKEN.SELECTED_TAB]: selectedTab,
}));
/**
 * @external_application_navigation This depends on Legend Studio routing and is hardcoded so it's potentially brittle
 */
export const EXTERNAL_APPLICATION_NAVIGATION__generateStudioSDLCProjectViewUrl = (studioApplicationUrl, projectId, entityPath) => `${studioApplicationUrl}/view/${projectId}${entityPath ? `/entity/${entityPath}` : ''}`;
/**
 * @external_application_navigation This depends on Ingest Environment swagger URL and is hardcoded so it's potentially brittle
 */
export const EXTERNAL_APPLICATION_NAVIGATION__generateIngestEnvironemntUrl = (baseUrl) => `${baseUrl}/data-product/swagger-ui`;
/**
 * @external_application_navigation This depends on Legend Query routing and is hardcoded so it's potentially brittle
 */
export const EXTERNAL_APPLICATION_NAVIGATION__generateDataSpaceQueryEditorUrl = (queryApplicationUrl, groupId, artifactId, versionId, dataSpacePath, executionContext, runtimePath, classPath) => `${queryApplicationUrl}/extensions/dataspace/${generateGAVCoordinates(groupId, artifactId, versionId)}/${dataSpacePath}/${executionContext}/${runtimePath ? `/${runtimePath}` : ''}${classPath ? `?class=${classPath}` : ''}`;
/**
 * @external_application_navigation This depends on Legend Query routing and is hardcoded so it's potentially brittle
 */
export const EXTERNAL_APPLICATION_NAVIGATION__generateDataProductModelQueryUrl = (queryApplicationUrl, groupId, artifactId, versionId, type, dataProductPath, accessPointId) => `${queryApplicationUrl}/data-product/${type}/${generateGAVCoordinates(groupId, artifactId, versionId)}/${dataProductPath}/${accessPointId}`;
/**
 * @external_application_navigation This depends on Legend Query routing and is hardcoded so it's potentially brittle
 */
export const EXTERNAL_APPLICATION_NAVIGATION__generateDataProductSampleQueryUrl = (queryApplicationUrl, groupId, artifactId, versionId, dataProductPath, sampleQueryId) => `${queryApplicationUrl}/data-product/native/sample-query/${generateGAVCoordinates(groupId, artifactId, versionId)}/${dataProductPath}/${sampleQueryId}`;
//# sourceMappingURL=LegendMarketplaceNavigation.js.map