@finos/legend-server-sdlc/src/models/configuration/ProjectDependency.ts

Legend SDLC 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 { createModelSchema, list, optional, primitive } from 'serializr';
import {
  type Hashable,
  hashArray,
  uuid,
  SerializationFactory,
  usingModelSchema,
} from '@finos/legend-shared';
import { observable, action, computed, makeObservable } from 'mobx';
import { GAV_DELIMITER } from '@finos/legend-storage';
import { SDLC_HASH_STRUCTURE } from '../../SDLC_HashUtils.js';
import { ProjectDependencyExclusion } from './ProjectDependencyExclusion.js';

export class ProjectDependency implements Hashable {
  readonly _UUID = uuid();
  projectId: string;
  versionId: string;
  exclusions: ProjectDependencyExclusion[] | undefined;

  constructor(
    projectId: string,
    versionId?: string,
    exclusions?: ProjectDependencyExclusion[],
  ) {
    makeObservable(this, {
      projectId: observable,
      versionId: observable,
      exclusions: observable,
      setProjectId: action,
      setVersionId: action,
      setExclusions: action,
      hashCode: computed,
    });

    this.projectId = projectId;
    this.versionId = versionId ?? '0.0.0';
    this.exclusions = exclusions?.length ? exclusions : undefined;
  }

  static readonly serialization = new SerializationFactory(
    createModelSchema(ProjectDependency, {
      projectId: primitive(),
      versionId: primitive(),
      exclusions: optional(
        list(usingModelSchema(ProjectDependencyExclusion.serialization.schema)),
      ),
    }),
  );

  setProjectId(projectId: string): void {
    this.projectId = projectId;
  }

  setVersionId(id: string): void {
    this.versionId = id;
  }

  setExclusions(exclusions: ProjectDependencyExclusion[]): void {
    this.exclusions = exclusions.length > 0 ? exclusions : undefined;
  }

  get groupId(): string | undefined {
    return this.projectId.split(GAV_DELIMITER)[0];
  }

  get artifactId(): string | undefined {
    return this.projectId.split(GAV_DELIMITER)[1];
  }

  get exclusionsList(): ProjectDependencyExclusion[] | undefined {
    return this.exclusions;
  }

  get hashCode(): string {
    return hashArray([
      SDLC_HASH_STRUCTURE.PROJECT_DEPENDENCY,
      this.projectId,
      this.versionId,
      hashArray(this.exclusions ?? []),
    ]);
  }
}