@finos/legend-application-marketplace/lib/__lib__/LegendMarketplaceNavigation.d.ts

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 type { DataProductAccessType } from '@finos/legend-graph';
export declare enum LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN {
    VENDOR_NAME = "vendorName",
    GAV = "gav",
    DATA_PRODUCT_PATH = "path",
    DATA_PRODUCT_ID = "dataProductId",
    DEPLOYMENT_ID = "deploymentId",
    TERMINAL_ID = "terminalId",
    DATA_CONTRACT_ID = "dataContractId",
    DATA_CONTRACT_TASK_ID = "dataContractTaskId",
    DATA_ACCESS_REQUEST_ID = "dataAccessRequestId"
}
export declare enum LEGEND_MARKETPLACE_SEARCH_RESULTS_QUERY_PARAM_TOKEN {
    PROVIDER = "provider",
    QUERY = "query"
}
export declare enum LEGEND_MARKETPLACE_LAKEHOUSE_SEARCH_RESULTS_QUERY_PARAM_TOKEN {
    QUERY = "query",
    USE_PRODUCER_SEARCH = "useProducerSearch"
}
export declare enum LEGEND_MARKETPLACE_FIELD_SEARCH_RESULTS_QUERY_PARAM_TOKEN {
    QUERY = "query"
}
export declare enum LEGEND_MARKETPLACE_ENTITLEMENTS_QUERY_PARAM_TOKEN {
    SELECTED_TAB = "selectedTab"
}
export declare enum LEGEND_MARKETPLACE_DATA_APIS_QUERY_PARAM_TOKEN {
    QUERY = "query"
}
export type LegendTerminalProductPathParams = {
    [LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN.TERMINAL_ID]: string;
};
export type LakehouseDataProductPathParams = {
    [LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN.DATA_PRODUCT_ID]: string;
    [LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN.DEPLOYMENT_ID]: string;
};
export type LakehouseDataContractTaskPathParams = {
    [LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN.DATA_CONTRACT_ID]: string;
    [LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN.DATA_CONTRACT_TASK_ID]: string;
};
export type LakehouseSDLCDataProductPathParams = {
    [LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN.GAV]: string;
    [LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN.DATA_PRODUCT_PATH]: string;
};
export type LegacyDataProductPathParams = {
    [LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN.GAV]: string;
    [LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN.DATA_PRODUCT_PATH]: string;
};
export type WorkflowDataAccessRequestPathParams = {
    [LEGEND_MARKETPLACE_ROUTE_PATTERN_TOKEN.DATA_ACCESS_REQUEST_ID]: string;
};
export declare const LEGEND_MARKETPLACE_ROUTE_PATTERN: Readonly<{
    HOME_PAGE: "/";
    OAUTH_CALLBACK: "/callback";
    DATA_PRODUCTS: "/dataproducts";
    DATA_APIS: "/data-apis";
    AGENTS: "/agents";
    INVENTORY: "/inventory";
    SUBSCRIPTIONS: "/subscriptions";
    ORDERS: "/orders";
    TERMINAL_PRODUCT: "/terminal/terminalProduct/:terminalId";
    TERMINAL_ADD_ONS: "/terminals-and-addons";
    DATA_PRODUCT: "/dataProduct/deployed/:dataProductId/:deploymentId";
    LEGACY_DATA_PRODUCT: "/dataProduct/legacy/:gav/:path";
    SDLC_DATA_PRODUCT: "/dataProduct/:gav/:path";
    DATA_PRODUCT_SEARCH_RESULTS: "/dataProduct/results";
    FIELD_SEARCH_RESULTS: "/dataProduct/fields/results";
    LAKEHOUSE_ENTITLEMENTS: "/lakehouse/entitlements";
    LAKEHOUSE_ENTITLEMENTS_CONTRACT_TASK: "/lakehouse/entitlements/:dataContractId/:dataContractTaskId";
    LAKEHOUSE_ENTITLEMENTS_WORKFLOW_DATA_ACCESS_REQUEST: "/lakehouse/entitlements/workflowDataAccessRequest/:dataAccessRequestId";
    LAKEHOUSE_ENTITLEMENTS_PERMIT_DATA_ACCESS_REQUEST: "/lakehouse/entitlements/permitDataAccessRequest/:dataAccessRequestId";
    LAKEHOUSE_ADMIN: "/lakehouse/admin";
    DEPRECATED_LAKEHOUSE: "/lakehouse";
    DEPRECATED_LAKEHOUSE_SEARCH_RESULTS: "/lakehouse/results";
    DEPRECATED_LAKEHOUSE_PRODUCT: "/lakehouse/dataProduct/deployed/:dataProductId/:deploymentId";
    DEPRECATED_LAKEHOUSE_SDLC_PRODUCT: "/lakehouse/dataProduct/:gav/:path";
}>;
export declare const generateLakehouseDataProductPath: (dataProductId: string, deploymentId: number) => string;
export declare const generateContractPagePath: (dataContractId: string, dataContractTaskId: string) => string;
export declare const generateWorkflowDataAccessRequestPagePath: (dataAccessRequestId: string) => string;
export declare const generatePermitDataAccessRequestPagePath: (dataAccessRequestId: string) => string;
export declare const generateLegacyDataProductPath: (gav: string, path: string) => string;
export declare const generateSdlcDataProductPath: (gav: string, path: string) => string;
export declare const generateLakehouseSearchResultsRoute: (query: string | undefined, useProducerSearch: boolean) => string;
export declare const generateSearchResultsRoute: (provider: string | undefined, query: string | undefined) => string;
export declare const generateFieldSearchResultsRoute: (query: string | undefined) => string;
export declare const generateLakehouseEntitlementsRoute: (selectedTab: string | undefined) => string;
/**
 * @external_application_navigation This depends on Legend Studio routing and is hardcoded so it's potentially brittle
 */
export declare const EXTERNAL_APPLICATION_NAVIGATION__generateStudioSDLCProjectViewUrl: (studioApplicationUrl: string, projectId: string, entityPath: string | undefined) => string;
/**
 * @external_application_navigation This depends on Ingest Environment swagger URL and is hardcoded so it's potentially brittle
 */
export declare const EXTERNAL_APPLICATION_NAVIGATION__generateIngestEnvironemntUrl: (baseUrl: string) => string;
/**
 * @external_application_navigation This depends on Legend Query routing and is hardcoded so it's potentially brittle
 */
export declare const EXTERNAL_APPLICATION_NAVIGATION__generateDataSpaceQueryEditorUrl: (queryApplicationUrl: string, groupId: string, artifactId: string, versionId: string, dataSpacePath: string, executionContext: string, runtimePath: string | undefined, classPath: string | undefined) => string;
/**
 * @external_application_navigation This depends on Legend Query routing and is hardcoded so it's potentially brittle
 */
export declare const EXTERNAL_APPLICATION_NAVIGATION__generateDataProductModelQueryUrl: (queryApplicationUrl: string, groupId: string, artifactId: string, versionId: string, type: DataProductAccessType, dataProductPath: string, accessPointId: string) => string;
/**
 * @external_application_navigation This depends on Legend Query routing and is hardcoded so it's potentially brittle
 */
export declare const EXTERNAL_APPLICATION_NAVIGATION__generateDataProductSampleQueryUrl: (queryApplicationUrl: string, groupId: string, artifactId: string, versionId: string, dataProductPath: string, sampleQueryId: string) => string;
//# sourceMappingURL=LegendMarketplaceNavigation.d.ts.map