@finos/legend-studio
Version:
76 lines • 4 kB
TypeScript
/**
* 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 { WorkspaceType } from '@finos/legend-server-sdlc';
export declare enum LEGEND_STUDIO_PATH_PARAM_TOKEN {
PROJECT_ID = "projectId",
WORKSPACE_ID = "workspaceId",
GROUP_WORKSPACE_ID = "groupWorkspaceId",
REVISION_ID = "revisionId",
VERSION_ID = "versionId",
REVIEW_ID = "reviewId",
ENTITY_PATH = "entityPath",
GAV = "gav"
}
export declare const LEGEND_STUDIO_ROUTE_PATTERN: Readonly<{
VIEW: "/view/:projectId";
VIEW_BY_GAV: "/view/archive/:gav";
VIEW_BY_GAV_ENTITY: "/view/archive/:gav/entity/:entityPath";
VIEW_BY_ENTITY: "/view/:projectId/entity/:entityPath";
VIEW_BY_REVISION: "/view/:projectId/revision/:revisionId";
VIEW_BY_VERSION: "/view/:projectId/version/:versionId";
VIEW_BY_REVISION_ENTITY: "/view/:projectId/revision/:revisionId/entity/:entityPath";
VIEW_BY_VERSION_ENTITY: "/view/:projectId/version/:versionId/entity/:entityPath";
REVIEW: "/review/:projectId/:reviewId";
EDIT: "/edit/:projectId/:workspaceId/";
EDIT_GROUP: "/edit/:projectId/groupWorkspace/:groupWorkspaceId/";
SETUP: "/setup/:projectId?/:workspaceId?";
SETUP_GROUP: "/setup/:projectId/groupWorkspace/:groupWorkspaceId/";
}>;
export interface ReviewPathParams {
[LEGEND_STUDIO_PATH_PARAM_TOKEN.PROJECT_ID]: string;
[LEGEND_STUDIO_PATH_PARAM_TOKEN.REVIEW_ID]: string;
}
export interface ViewerPathParams {
[LEGEND_STUDIO_PATH_PARAM_TOKEN.GAV]?: string;
[LEGEND_STUDIO_PATH_PARAM_TOKEN.PROJECT_ID]?: string;
[LEGEND_STUDIO_PATH_PARAM_TOKEN.VERSION_ID]?: string;
[LEGEND_STUDIO_PATH_PARAM_TOKEN.REVISION_ID]?: string;
[LEGEND_STUDIO_PATH_PARAM_TOKEN.ENTITY_PATH]?: string;
}
export interface CoreEditorPathParams {
[LEGEND_STUDIO_PATH_PARAM_TOKEN.PROJECT_ID]: string;
}
export interface EditorPathParams extends CoreEditorPathParams {
[LEGEND_STUDIO_PATH_PARAM_TOKEN.WORKSPACE_ID]: string;
}
export interface GroupEditorPathParams extends CoreEditorPathParams {
[LEGEND_STUDIO_PATH_PARAM_TOKEN.GROUP_WORKSPACE_ID]: string;
}
export interface SetupPathParams {
[LEGEND_STUDIO_PATH_PARAM_TOKEN.PROJECT_ID]?: string;
[LEGEND_STUDIO_PATH_PARAM_TOKEN.WORKSPACE_ID]?: string;
[LEGEND_STUDIO_PATH_PARAM_TOKEN.GROUP_WORKSPACE_ID]?: string;
}
export declare const generateSetupRoute: (projectId: string | undefined, workspaceId?: string | undefined, workspaceType?: WorkspaceType | undefined) => string;
export declare const generateEditorRoute: (projectId: string, workspaceId: string, workspaceType: WorkspaceType) => string;
export declare const generateReviewRoute: (projectId: string, reviewId: string) => string;
export declare const generateViewProjectRoute: (projectId: string) => string;
export declare const generateViewEntityRoute: (projectId: string, entityPath: string) => string;
export declare const generateViewProjectByGAVRoute: (groupId: string, artifactId: string, versionId: string, entityPath?: string | undefined) => string;
export declare const generateViewProjectEntityByGAVRoute: (groupId: string, artifactId: string, versionId: string) => string;
export declare const generateViewVersionRoute: (projectId: string, versionId: string, entityPath?: string | undefined) => string;
export declare const generateViewRevisionRoute: (projectId: string, revisionId: string, entityPath?: string | undefined) => string;
//# sourceMappingURL=LegendStudioRouter.d.ts.map