@finos/legend-application-studio/src/stores/project-view/ProjectViewerEditorMode.ts

Legend Studio 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 {
  generateViewEntityRoute,
  generateViewProjectByGAVRoute,
  generateViewRevisionRoute,
  generateViewVersionRoute,
} from '../../__lib__/LegendStudioNavigation.js';
import { EditorMode } from '../editor/EditorMode.js';
import type { ProjectViewerStore } from './ProjectViewerStore.js';
import type { ProjectDependency } from '@finos/legend-server-sdlc';
import {
  MASTER_SNAPSHOT_ALIAS,
  SNAPSHOT_VERSION_ALIAS,
} from '@finos/legend-server-depot';
import { guaranteeNonNullable } from '@finos/legend-shared';
import {
  LegendSourceType,
  type LegendGAVSourceInfo,
  type LegendProjectIdSourceInfo,
  type LegendSourceInfo,
} from '@finos/legend-storage';

export class ProjectViewerEditorMode extends EditorMode {
  viewerStore: ProjectViewerStore;

  constructor(viewerStore: ProjectViewerStore) {
    super();
    this.viewerStore = viewerStore;
  }

  generateElementLink(elementPath: string): string {
    return this.viewerStore.projectGAVCoordinates
      ? generateViewProjectByGAVRoute(
          this.viewerStore.projectGAVCoordinates.groupId,
          this.viewerStore.projectGAVCoordinates.artifactId,
          this.viewerStore.projectGAVCoordinates.versionId,
          elementPath,
        )
      : this.viewerStore.version
        ? generateViewVersionRoute(
            this.viewerStore.editorStore.sdlcState.activeProject.projectId,
            this.viewerStore.version.id.id,
            elementPath,
          )
        : this.viewerStore.revision
          ? generateViewRevisionRoute(
              this.viewerStore.editorStore.sdlcState.activeProject.projectId,
              this.viewerStore.revision.id,
              elementPath,
            )
          : generateViewEntityRoute(
              this.viewerStore.editorStore.sdlcState.activeProject.projectId,
              elementPath,
            );
  }

  generateDependencyElementLink(
    elementPath: string,
    dependencyProject: ProjectDependency,
  ): string {
    return generateViewProjectByGAVRoute(
      guaranteeNonNullable(dependencyProject.groupId),
      guaranteeNonNullable(dependencyProject.artifactId),
      dependencyProject.versionId === MASTER_SNAPSHOT_ALIAS
        ? SNAPSHOT_VERSION_ALIAS
        : dependencyProject.versionId,
      elementPath,
    );
  }

  override get isInitialized(): boolean {
    return (
      Boolean(
        this.viewerStore.editorStore.sdlcState.currentProject &&
          this.viewerStore.editorStore.sdlcState.currentWorkspace,
      ) || Boolean(this.viewerStore.projectGAVCoordinates)
    );
  }

  override get disableEditing(): boolean {
    return true;
  }

  override get supportSdlcOperations(): boolean {
    return !this.viewerStore.projectGAVCoordinates;
  }

  getSourceInfo(): LegendSourceInfo | undefined {
    if (this.viewerStore.editorStore.sdlcState.currentProject) {
      return {
        sourceType: LegendSourceType.PROJECT_PROJECTID,
        projectId:
          this.viewerStore.editorStore.sdlcState.currentProject.projectId,
      } as LegendProjectIdSourceInfo;
    } else if (this.viewerStore.projectGAVCoordinates) {
      return {
        sourceType: LegendSourceType.PROJECT_GAV,
        groupId: this.viewerStore.projectGAVCoordinates.groupId,
        artifactId: this.viewerStore.projectGAVCoordinates.artifactId,
        versionId: this.viewerStore.projectGAVCoordinates.versionId,
      } as LegendGAVSourceInfo;
    } else {
      return undefined;
    }
  }
}