@teambit/objects 0.0.19

package/models/version.ts

@@ -0,0 +1,818 @@
+import { isEmpty, pickBy } from 'lodash';
+import { isSnap } from '@teambit/component-version';
+import { ComponentID, ComponentIdList } from '@teambit/component-id';
+import { LaneId } from '@teambit/lane-id';
+import { v4 } from 'uuid';
+import { BuildStatus, DEFAULT_BUNDLE_FILENAME, Extensions } from '@teambit/legacy.constants';
+import {
+  isSchemaSupport,
+  SchemaFeature,
+  SchemaName,
+  Dependencies,
+  Dependency,
+  ConsumerComponent,
+} from '@teambit/legacy.consumer-component';
+import { getRefsFromExtensions, SourceFile } from '@teambit/component.sources';
+import { ComponentOverridesData } from '@teambit/legacy.consumer-config';
+import { ExtensionDataEntry, ExtensionDataList } from '@teambit/legacy.extension-data';
+import type { Doclet } from '@teambit/semantics.doc-parser';
+import { logger } from '@teambit/legacy.logger';
+import { getStringifyArgs, PathLinux, pathNormalizeToLinux } from '@teambit/legacy.utils';
+import { sha1 } from '@teambit/toolbox.crypto.sha1';
+import { BitObject, Ref, Repository } from '../objects';
+import { ObjectItem } from '../objects/object-list';
+import { BitIdCompIdError, VersionInvalid, validateVersionInstance } from '@teambit/legacy.scope';
+import Source from './source';
+import { DependenciesGraph } from './dependencies-graph';
+import { getBitVersion } from '@teambit/bit.get-bit-version';
+
+export type SourceFileModel = {
+  name: string;
+  relativePath: PathLinux;
+  test: boolean;
+  file: Ref;
+};
+
+export type DistFileModel = SourceFileModel;
+
+export type ArtifactFileModel = {
+  relativePath: PathLinux;
+  file: Ref;
+};
+
+export type Log = {
+  message: string;
+  date: string;
+  username: string | undefined;
+  email: string | undefined;
+};
+
+export type DepEdgeType = 'prod' | 'dev' | 'peer' | 'ext';
+export type DepEdge = { source: ComponentID; target: ComponentID; type: DepEdgeType };
+
+type ExternalHead = { head: Ref; laneId: LaneId };
+type SquashData = { previousParents: Ref[]; laneId: LaneId };
+type VersionOrigin = { id: { scope: string; name: string }; lane?: { scope: string; name: string; hash: string } };
+
+export type VersionProps = {
+  mainFile: PathLinux;
+  files: Array<SourceFileModel>;
+  log: Log;
+  docs?: Doclet[];
+  dependencies?: Dependency[];
+  devDependencies?: Dependency[];
+  peerDependencies?: Dependency[];
+  flattenedDependencies?: ComponentIdList;
+  _flattenedEdges?: DepEdge[];
+  flattenedEdges?: DepEdge[];
+  flattenedEdgesRef?: Ref;
+  dependenciesGraphRef?: Ref;
+  // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
+  packageDependencies?: { [key: string]: string };
+  // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
+  devPackageDependencies?: { [key: string]: string };
+  // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
+  peerPackageDependencies?: { [key: string]: string };
+  bindingPrefix: string;
+  schema?: string;
+  overrides: ComponentOverridesData;
+  packageJsonChangedProps?: Record<string, any>;
+  hash?: string;
+  parents?: Ref[];
+  squashed?: SquashData;
+  unrelated?: ExternalHead;
+  extensions?: ExtensionDataList;
+  buildStatus?: BuildStatus;
+  componentId?: ComponentID;
+  bitVersion?: string;
+  modified?: Log[];
+  origin?: VersionOrigin;
+  hidden?: boolean;
+};
+
+/**
+ * Represent a version model in the scope
+ */
+export default class Version extends BitObject {
+  mainFile: PathLinux;
+  files: Array<SourceFileModel>;
+  log: Log;
+  docs: Doclet[] | undefined;
+  dependencies: Dependencies;
+  devDependencies: Dependencies;
+  peerDependencies: Dependencies;
+  flattenedDependencies: ComponentIdList;
+  dependenciesGraphRef?: Ref;
+  _dependenciesGraph?: DependenciesGraph; // caching for the dependencies graph
+  flattenedEdgesRef?: Ref; // ref to a BitObject Source file, which is a JSON object containing the flattened edge
+  _flattenedEdges?: DepEdge[]; // caching for the flattenedEdges
+  /**
+   * @deprecated
+   * to get the flattenedEdges, please use `this.getFlattenedEdges()`.
+   * this function handles the backward compatibility and provides the flattened edges regardless whether it was saved
+   * the `flattenedEdgesRef` introduced or after.
+   *
+   * the reason this is left here is not for backward compatibility, but for forward compatibility. meaning, if a
+   * Version object created by the new version is parsed by an old version that doesn't support the flattenedEdgesRef,
+   * then, it'll be able to still get the flattenedEdges by this prop.
+   * this is causing duplication currently. the data is kept in both, `this.flattenedEdges` and the file stored in `flattenedEdgesRef`.
+   * so it'll be best to delete this prop as soon as all scopes are deployed with the new version.
+   * (around August 2023 should be safe)
+   */
+  private flattenedEdges: DepEdge[];
+  // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
+  packageDependencies: { [key: string]: string };
+  devPackageDependencies: { [key: string]: string };
+  peerPackageDependencies: { [key: string]: string };
+  bindingPrefix: string;
+  schema: string | undefined;
+  overrides: ComponentOverridesData;
+  packageJsonChangedProps: Record<string, any>;
+  _hash: string; // reason for the underscore prefix is that we already have hash as a method
+  parents: Ref[];
+  squashed?: SquashData; // when a component is squashed during lane-merge
+  unrelated?: ExternalHead; // when a component from a lane was created with the same name/scope as main, this ref points to the component of the lane
+  extensions: ExtensionDataList;
+  buildStatus?: BuildStatus;
+  componentId?: ComponentID; // can help debugging errors when validating Version object
+  bitVersion?: string;
+  modified: Log[] = []; // currently mutation could happen as a result of either "squash" or "sign".
+  origin?: VersionOrigin; // for debugging purposes
+  hidden?: boolean; // whether the version is hidden from commands such as "bit log", "bit blame". (needed for un-meaningful snaps, such as merged-lane snap prior to the tag)
+
+  constructor(props: VersionProps) {
+    super();
+    this.mainFile = props.mainFile;
+    this.files = props.files;
+    this.log = props.log;
+    this.dependencies = new Dependencies(props.dependencies);
+    this.devDependencies = new Dependencies(props.devDependencies);
+    this.peerDependencies = new Dependencies(props.peerDependencies);
+    this.docs = props.docs;
+    this.flattenedDependencies = props.flattenedDependencies || new ComponentIdList();
+    this.flattenedEdges = props.flattenedEdges || [];
+    this.flattenedEdgesRef = props.flattenedEdgesRef;
+    this.dependenciesGraphRef = props.dependenciesGraphRef;
+    this.packageDependencies = props.packageDependencies || {};
+    this.devPackageDependencies = props.devPackageDependencies || {};
+    this.peerPackageDependencies = props.peerPackageDependencies || {};
+    this.bindingPrefix = props.bindingPrefix;
+    this.schema = props.schema;
+    this.overrides = props.overrides || {};
+    this.packageJsonChangedProps = props.packageJsonChangedProps || {};
+    // @ts-ignore yes, props.hash can be undefined here, but it gets populated as soon as Version is created
+    this._hash = props.hash;
+    this.parents = props.parents || [];
+    this.squashed = props.squashed;
+    this.unrelated = props.unrelated;
+    this.extensions = props.extensions || ExtensionDataList.fromArray([]);
+    this.buildStatus = props.buildStatus;
+    this.componentId = props.componentId;
+    this.bitVersion = props.bitVersion;
+    this.modified = props.modified || [];
+    this.origin = props.origin;
+    this.hidden = props.hidden;
+    this.validateVersion();
+  }
+
+  /**
+   * use only this method to get the flattened edges (graph of flattened dependencies).
+   * it's backward compatible with the previous way this was stored on the Version object itself.
+   */
+  async getFlattenedEdges(repo: Repository): Promise<DepEdge[]> {
+    const getWithBackwardCompatibility = async (): Promise<DepEdge[]> => {
+      if (this.flattenedEdgesRef) {
+        // it's possible that there is a ref but the file is not there.
+        // it can happen if the remote-scope uses an older version that doesn't know to collect this ref.
+        // in which case, the client will get the Version object with the ref prop, but not the Source object.
+        const throws = false;
+        const flattenedEdgesSource = (await repo.load(this.flattenedEdgesRef, throws)) as Source | undefined;
+        if (flattenedEdgesSource) {
+          const flattenedEdgesJson = JSON.parse(flattenedEdgesSource.contents.toString());
+          return flattenedEdgesJson.map((item) =>
+            Array.isArray(item) ? Version.depEdgeFromArray(item) : Version.depEdgeFromObject(item)
+          );
+        }
+      }
+      return this.flattenedEdges || [];
+    };
+
+    if (!this._flattenedEdges) {
+      this._flattenedEdges = await getWithBackwardCompatibility();
+    }
+
+    return this._flattenedEdges;
+  }
+
+  async loadDependenciesGraph(repo: Repository): Promise<DependenciesGraph | undefined> {
+    if (!this._dependenciesGraph) {
+      if (this.dependenciesGraphRef) {
+        // it's possible that there is a ref but the file is not there.
+        // it can happen if the remote-scope uses an older version that doesn't know to collect this ref.
+        // in which case, the client will get the Version object with the ref prop, but not the Source object.
+        const throws = false;
+        const dependenciesGraphSource = (await repo.load(this.dependenciesGraphRef, throws)) as Source | undefined;
+        if (dependenciesGraphSource) {
+          this._dependenciesGraph = DependenciesGraph.deserialize(dependenciesGraphSource.contents.toString());
+        }
+      }
+    }
+    return this._dependenciesGraph;
+  }
+
+  validateVersion() {
+    const nonEmptyFields = ['mainFile', 'files'];
+    nonEmptyFields.forEach((field) => {
+      if (!this[field]) {
+        throw new VersionInvalid(`failed creating a version object, the field "${field}" can't be empty`);
+      }
+    });
+  }
+
+  id() {
+    const obj = this.toObject();
+
+    // @todo: remove the entire dependencies.relativePaths from the ID (it's going to be a breaking change)
+    const getDependencies = (deps: Dependencies) => {
+      const clonedDependencies = deps.cloneAsString();
+      // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
+      return clonedDependencies.map((dependency: Dependency) => {
+        return {
+          id: dependency.id,
+          relativePaths: dependency.relativePaths.map((relativePath) => {
+            return {
+              sourceRelativePath: relativePath.sourceRelativePath,
+              destinationRelativePath: relativePath.destinationRelativePath,
+            };
+          }),
+        };
+      });
+    };
+
+    const getExtensions = (extensions: ExtensionDataList) => {
+      const sortedConfigOnly = extensions.sortById().toConfigArray();
+      return sortedConfigOnly;
+    };
+
+    const filterFunction = (val, key) => {
+      if (
+        key === 'devDependencies' ||
+        key === 'extensionDependencies' ||
+        key === 'devPackageDependencies' ||
+        key === 'peerPackageDependencies' ||
+        key === 'overrides' ||
+        key === 'extensions'
+      ) {
+        return !isEmpty(val);
+      }
+      return !!val;
+    };
+
+    return JSON.stringify(
+      pickBy(
+        {
+          mainFile: obj.mainFile,
+          files: obj.files,
+          log: obj.log,
+          dependencies: getDependencies(this.dependencies),
+          devDependencies: getDependencies(this.devDependencies),
+          extensionDependencies: getDependencies(this.extensionDependencies),
+          packageDependencies: obj.packageDependencies,
+          devPackageDependencies: obj.devPackageDependencies,
+          peerPackageDependencies: obj.peerPackageDependencies,
+          bindingPrefix: obj.bindingPrefix,
+          overrides: obj.overrides,
+          extensions: getExtensions(this.extensions),
+        },
+        filterFunction
+      )
+    );
+  }
+
+  calculateHash(): Ref {
+    return new Ref(BitObject.makeHash(this.id()));
+  }
+
+  hash(): Ref {
+    if (!this._hash) {
+      throw new Error('hash is missing from a Version object');
+    }
+    return new Ref(this._hash);
+  }
+
+  get extensionDependencies() {
+    return new Dependencies(this.extensions.extensionsBitIds.map((id) => new Dependency(id, [])));
+  }
+
+  lastModified(): string {
+    if (!this.modified || !this.modified.length) return this.log.date;
+    return this.modified[this.modified.length - 1].date;
+  }
+
+  getAllFlattenedDependencies(): ComponentIdList {
+    return ComponentIdList.fromArray([...this.flattenedDependencies]);
+  }
+
+  getAllDependencies(): Dependency[] {
+    return [
+      ...this.dependencies.dependencies,
+      ...this.devDependencies.dependencies,
+      ...this.extensionDependencies.dependencies,
+    ];
+  }
+
+  get depsIdsGroupedByType(): {
+    dependencies: ComponentIdList;
+    devDependencies: ComponentIdList;
+    peerDependencies: ComponentIdList;
+    extensionDependencies: ComponentIdList;
+  } {
+    return {
+      dependencies: this.dependencies.getAllIds(),
+      devDependencies: this.devDependencies.getAllIds(),
+      peerDependencies: this.peerDependencies.getAllIds(),
+      extensionDependencies: this.extensions.extensionsBitIds,
+    };
+  }
+
+  getAllDependenciesCloned(): Dependencies {
+    const dependencies = [...this.dependencies.getClone(), ...this.devDependencies.getClone()];
+    return new Dependencies(dependencies);
+  }
+
+  getAllDependenciesIds(): ComponentIdList {
+    const allDependencies = Object.values(this.depsIdsGroupedByType).flat();
+    return ComponentIdList.fromArray(allDependencies);
+  }
+
+  getDependenciesIdsExcludeExtensions(): ComponentIdList {
+    return ComponentIdList.fromArray([...this.dependencies.getAllIds(), ...this.devDependencies.getAllIds()]);
+  }
+
+  updateFlattenedDependency(currentId: ComponentID, newId: ComponentID) {
+    const getUpdated = (flattenedDependencies: ComponentIdList): ComponentIdList => {
+      const updatedIds = flattenedDependencies.map((depId) => {
+        if (depId.isEqual(currentId)) return newId;
+        return depId;
+      });
+      return ComponentIdList.fromArray(updatedIds);
+    };
+    this.flattenedDependencies = getUpdated(this.flattenedDependencies);
+  }
+
+  refs(): Ref[] {
+    return this.refsWithOptions();
+  }
+
+  refsWithOptions(includeParents = true, includeArtifacts = true): Ref[] {
+    const allRefs: Ref[] = [];
+    const extractRefsFromFiles = (files) => {
+      const refs = files ? files.map((file) => file.file) : [];
+      return refs;
+    };
+    const files = extractRefsFromFiles(this.files);
+    allRefs.push(...files);
+    if (includeParents) {
+      allRefs.push(...this.parents);
+    }
+    if (includeArtifacts) {
+      const artifacts = getRefsFromExtensions(this.extensions);
+      allRefs.push(...artifacts);
+    }
+    if (this.flattenedEdgesRef) allRefs.push(this.flattenedEdgesRef);
+    if (this.dependenciesGraphRef) allRefs.push(this.dependenciesGraphRef);
+    return allRefs;
+  }
+
+  refsWithoutParents(): Ref[] {
+    const extractRefsFromFiles = (files) => {
+      const refs = files ? files.map((file) => file.file) : [];
+      return refs;
+    };
+    const files = extractRefsFromFiles(this.files);
+    const artifacts = getRefsFromExtensions(this.extensions);
+    return [...files, ...artifacts].filter((ref) => ref);
+  }
+
+  async collectManyObjects(repo: Repository, refs: Ref[]): Promise<ObjectItem[]> {
+    return repo.loadManyRaw(refs);
+  }
+
+  static depEdgeToObject(depEdge: DepEdge): Record<string, any> {
+    return {
+      source: depEdge.source.serialize(),
+      target: depEdge.target.serialize(),
+      type: depEdge.type,
+    };
+  }
+  static depEdgeFromObject(depEdgeObj: Record<string, any>): DepEdge {
+    return {
+      source: ComponentID.fromObject(depEdgeObj.source),
+      target: ComponentID.fromObject(depEdgeObj.target),
+      type: depEdgeObj.type,
+    };
+  }
+  static depEdgeToArray(depEdge: DepEdge): Record<string, any> {
+    return [depEdge.source.toString(), depEdge.target.toString(), depEdge.type];
+  }
+  static depEdgeFromArray(depEdgeArr: string[]): DepEdge {
+    const [sourceStr, targetStr, type] = depEdgeArr;
+    return {
+      source: ComponentID.fromString(sourceStr),
+      target: ComponentID.fromString(targetStr),
+      type: type as DepEdgeType,
+    };
+  }
+  static flattenedEdgeToSource(flattenedEdges?: DepEdge[]): Source | undefined {
+    if (!flattenedEdges) return undefined;
+    // @todo: around August 2024, uncomment this line and delete the next one.
+    // it'll make this object much much smaller (for 604 edges, it's now 143KB, with the array format it's 6KB!)
+    // const flattenedEdgesObj = flattenedEdges.map((f) => Version.depEdgeToArray(f));
+    const flattenedEdgesObj = flattenedEdges.map((f) => Version.depEdgeToObject(f));
+    const flattenedEdgesBuffer = Buffer.from(JSON.stringify(flattenedEdgesObj));
+    return Source.from(flattenedEdgesBuffer);
+  }
+  static dependenciesGraphToSource(dependenciesGraph?: DependenciesGraph): Source | undefined {
+    if (!dependenciesGraph) return undefined;
+    const dependenciesGraphBuffer = Buffer.from(dependenciesGraph.serialize());
+    return Source.from(dependenciesGraphBuffer);
+  }
+
+  toObject() {
+    const _convertFileToObject = (file) => {
+      return {
+        file: file.file.toString(),
+        relativePath: file.relativePath,
+        name: file.name,
+        test: file.test,
+      };
+    };
+
+    return pickBy(
+      {
+        files: this.files ? this.files.map(_convertFileToObject) : null,
+        mainFile: this.mainFile,
+        bindingPrefix: this.bindingPrefix,
+        schema: this.schema,
+        log: {
+          message: this.log.message,
+          date: this.log.date,
+          username: this.log.username,
+          email: this.log.email,
+        },
+        docs: this.docs,
+        dependencies: this.dependencies.cloneAsObject(),
+        devDependencies: this.devDependencies.cloneAsObject(),
+        flattenedDependencies: this.flattenedDependencies.map((dep) => dep.toObject()),
+        flattenedEdges: this.flattenedEdgesRef ? undefined : this.flattenedEdges.map((f) => Version.depEdgeToObject(f)),
+        flattenedEdgesRef: this.flattenedEdgesRef?.toString(),
+        dependenciesGraphRef: this.dependenciesGraphRef?.toString(),
+        extensions: this.extensions.toModelObjects(),
+        packageDependencies: this.packageDependencies,
+        devPackageDependencies: this.devPackageDependencies,
+        peerPackageDependencies: this.peerPackageDependencies,
+        overrides: this.overrides,
+        buildStatus: this.buildStatus,
+        packageJsonChangedProps: this.packageJsonChangedProps,
+        parents: this.parents.map((p) => p.toString()),
+        squashed: this.squashed
+          ? {
+              previousParents: this.squashed.previousParents.map((p) => p.toString()),
+              laneId: this.squashed.laneId.toObject(),
+            }
+          : undefined,
+        unrelated: this.unrelated
+          ? { head: this.unrelated.head.toString(), laneId: this.unrelated.laneId.toObject() }
+          : undefined,
+        bitVersion: this.bitVersion,
+        modified: this.modified,
+        origin: this.origin,
+        hidden: this.hidden,
+      },
+      (val) => !!val
+    );
+  }
+
+  validateBeforePersisting(versionStr: string): void {
+    logger.trace(`validating version object, hash: ${this.hash().hash}`);
+    const version = Version.parse(versionStr, this._hash);
+    version.validate();
+  }
+
+  toBuffer(pretty: boolean): Buffer {
+    const obj = this.toObject();
+    const args = getStringifyArgs(pretty);
+    const str = JSON.stringify(obj, ...args);
+    if (this.validateBeforePersist) this.validateBeforePersisting(str);
+    return Buffer.from(str);
+  }
+  /**
+   * used by the super class BitObject
+   */
+  static parse(contents: string, hash: string): Version {
+    const contentParsed = JSON.parse(contents);
+    const {
+      mainFile,
+      files,
+      bindingPrefix,
+      schema,
+      log,
+      docs,
+      dependencies,
+      devDependencies,
+      flattenedDependencies,
+      flattenedEdges,
+      flattenedEdgesRef,
+      dependenciesGraphRef,
+      flattenedDevDependencies,
+      devPackageDependencies,
+      peerPackageDependencies,
+      packageDependencies,
+      overrides,
+      packageJsonChangedProps,
+      extensions,
+      buildStatus,
+      parents,
+      squashed,
+      unrelated,
+      bitVersion,
+      modified,
+      origin,
+      hidden,
+    } = contentParsed;
+
+    const _getDependencies = (deps = []): Dependency[] => {
+      const getRelativePath = (relativePath) => {
+        if (relativePath.importSpecifiers) {
+          // backward compatibility. Before the massive validation was added, an item of
+          // relativePath.importSpecifiers array could be missing the mainFile property, which is
+          // an invalid ImportSpecifier. (instead the mainFile it had another importSpecifiers object).
+          relativePath.importSpecifiers = relativePath.importSpecifiers.filter(
+            (importSpecifier) => importSpecifier.mainFile
+          );
+          if (!relativePath.importSpecifiers.length) delete relativePath.importSpecifiers;
+        }
+
+        return relativePath;
+      };
+
+      return deps.map((dependency: any) => {
+        if (!dependency.id.scope) {
+          throw new BitIdCompIdError(dependency.id.name);
+        }
+        return new Dependency(
+          ComponentID.fromObject(dependency.id),
+          Array.isArray(dependency.relativePaths)
+            ? dependency.relativePaths.map(getRelativePath)
+            : dependency.relativePaths
+        );
+      });
+    };
+
+    const _getFlattenedDependencies = (deps = []): ComponentID[] => {
+      return deps.map((dep) => ComponentID.fromObject(dep));
+    };
+
+    const _groupFlattenedDependencies = () => {
+      // support backward compatibility. until v15, there was both flattenedDependencies and
+      // flattenedDevDependencies. since then, these both were grouped to one flattenedDependencies
+      const flattenedDeps = _getFlattenedDependencies(flattenedDependencies);
+      const flattenedDevDeps = _getFlattenedDependencies(flattenedDevDependencies);
+      return ComponentIdList.fromArray([...flattenedDeps, ...flattenedDevDeps]);
+    };
+
+    const parseFile = (file) => {
+      return {
+        file: Ref.from(file.file),
+        relativePath: file.relativePath,
+        name: file.name,
+        test: file.test,
+      };
+    };
+    const _getExtensions = (exts = []): ExtensionDataList => {
+      if (exts.length) {
+        const newExts = exts.map((extension: any) => {
+          if (extension.extensionId) {
+            const extensionId = ComponentID.fromObject(extension.extensionId);
+            const entry = new ExtensionDataEntry(undefined, extensionId, undefined, extension.config, extension.data);
+            return entry;
+          }
+          const entry = new ExtensionDataEntry(
+            extension.id,
+            undefined,
+            extension.name,
+            extension.config,
+            extension.data
+          );
+          return entry;
+        });
+        return ExtensionDataList.fromModelObject(newExts);
+      }
+      return new ExtensionDataList();
+    };
+
+    return new Version({
+      mainFile,
+      files: files.map(parseFile),
+      bindingPrefix,
+      schema: schema || undefined,
+      log: {
+        // workaround for a bug where the log.message was saved as boolean when running `bit tag -m ""`
+        // the bug was fixed since v0.1.27, but old objects might still have this bug
+        message: typeof log.message !== 'string' ? '' : log.message,
+        date: log.date,
+        username: log.username,
+        email: log.email,
+      },
+      docs,
+      dependencies: _getDependencies(dependencies),
+      devDependencies: _getDependencies(devDependencies),
+      flattenedDependencies: _groupFlattenedDependencies(),
+      // backward compatibility. before introducing `flattenedEdgesRef`, we only had `flattenedEdges`. see getFlattenedEdges() for more info.
+      flattenedEdges: flattenedEdgesRef ? [] : flattenedEdges?.map((f) => Version.depEdgeFromObject(f)) || [],
+      flattenedEdgesRef: flattenedEdgesRef ? Ref.from(flattenedEdgesRef) : undefined,
+      dependenciesGraphRef: dependenciesGraphRef ? Ref.from(dependenciesGraphRef) : undefined,
+      devPackageDependencies,
+      peerPackageDependencies,
+      packageDependencies,
+      overrides,
+      packageJsonChangedProps,
+      hash,
+      parents: parents ? parents.map((p) => Ref.from(p)) : [],
+      squashed: squashed
+        ? { previousParents: squashed.previousParents.map((r) => Ref.from(r)), laneId: new LaneId(squashed.laneId) }
+        : undefined,
+      unrelated: unrelated ? { head: Ref.from(unrelated.head), laneId: new LaneId(unrelated.laneId) } : undefined,
+      extensions: _getExtensions(extensions),
+      buildStatus,
+      bitVersion,
+      modified,
+      origin,
+      hidden,
+    });
+  }
+
+  /**
+   * used by raw-object.toRealObject()
+   */
+  static from(versionProps: VersionProps, hash: string): Version {
+    return Version.parse(JSON.stringify(versionProps), hash);
+  }
+
+  /**
+   * Create version model object from consumer component
+   * @param {*} param0
+   */
+  static fromComponent({
+    component,
+    files,
+    flattenedEdges,
+    dependenciesGraph,
+  }: {
+    component: ConsumerComponent;
+    files: Array<SourceFileModel>;
+    flattenedEdges?: Source;
+    dependenciesGraph?: Source;
+  }) {
+    const parseFile = (file) => {
+      return {
+        file: file.file.hash(),
+        relativePath: file.relativePath,
+        name: file.name,
+        test: file.test,
+      };
+    };
+
+    if (!component.log) throw new Error('Version.fromComponent - component.log is missing');
+    const version = new Version({
+      mainFile: pathNormalizeToLinux(component.mainFile),
+      files: files.map(parseFile),
+      bindingPrefix: component.bindingPrefix,
+      log: component.log as Log,
+      // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
+      docs: component.docs,
+      dependencies: component.dependencies.get(),
+      devDependencies: component.devDependencies.get(),
+      packageDependencies: component.packageDependencies,
+      devPackageDependencies: component.devPackageDependencies,
+      peerPackageDependencies: component.peerPackageDependencies,
+      dependenciesGraphRef: dependenciesGraph?.hash(),
+      flattenedDependencies: component.flattenedDependencies,
+      // it's safe to remove this line once the version.flattenedEdges prop is deleted
+      flattenedEdges: component.flattenedEdges,
+      flattenedEdgesRef: flattenedEdges?.hash(),
+      schema: component.schema,
+      overrides: component.overrides.componentOverridesData,
+      // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
+      packageJsonChangedProps: component.packageJsonChangedProps,
+      extensions: component.extensions,
+      buildStatus: component.buildStatus,
+      componentId: component.id,
+      bitVersion: getBitVersion(),
+    });
+    if (isSnap(component.version)) {
+      version._hash = component.version as string;
+    } else {
+      version.setNewHash();
+    }
+
+    return version;
+  }
+
+  setNewHash() {
+    this._hash = sha1(v4());
+  }
+
+  get ignoreSharedDir(): boolean {
+    return !isSchemaSupport(SchemaFeature.sharedDir, this.schema);
+  }
+
+  get isLegacy(): boolean {
+    return !this.schema || this.schema === SchemaName.Legacy;
+  }
+
+  get originLaneId(): LaneId | undefined {
+    return this.origin?.lane ? new LaneId({ name: this.origin.lane.name, scope: this.origin.lane.scope }) : undefined;
+  }
+  get originId(): ComponentID | undefined {
+    return this.origin?.id
+      ? ComponentID.fromObject({ scope: this.origin.id.scope, name: this.origin.id.name })
+      : undefined;
+  }
+
+  setDist(dist: Source | undefined) {
+    // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
+    this.dist = dist
+      ? {
+          file: dist.hash(),
+          name: DEFAULT_BUNDLE_FILENAME,
+        }
+      : null;
+  }
+
+  hasParent(ref: Ref) {
+    return this.parents.find((p) => p.toString() === ref.toString());
+  }
+
+  addParent(ref: Ref) {
+    if (this.isLegacy) return;
+    if (this.hasParent(ref)) {
+      return; // make sure to not add twice
+    }
+    this.parents.push(ref);
+  }
+
+  setSquashed(squashData: SquashData, log: Log, replaceMessage?: string) {
+    this.squashed = squashData;
+    this.addModifiedLog(log);
+    if (replaceMessage) {
+      this.addModifiedLog({
+        username: undefined,
+        email: undefined,
+        date: Date.now().toString(),
+        message: `squashing: replacing the original log.message, which was: "${this.log.message || '<empty>'}"`,
+      });
+      this.log.message = replaceMessage;
+    }
+  }
+
+  setUnrelated(externalHead: ExternalHead) {
+    this.unrelated = externalHead;
+  }
+
+  addModifiedLog(log: Log) {
+    this.modified.push(log);
+  }
+
+  addAsOnlyParent(ref: Ref) {
+    if (this.isLegacy) return;
+    this.parents = [ref];
+  }
+
+  removeParent(ref: Ref) {
+    this.parents = this.parents.filter((p) => p.toString() !== ref.toString());
+  }
+
+  removeAllParents() {
+    this.parents = [];
+  }
+
+  modelFilesToSourceFiles(repository: Repository): Promise<SourceFile[]> {
+    return Promise.all(this.files.map((file) => SourceFile.loadFromSourceFileModel(file, repository)));
+  }
+
+  isRemoved(): boolean {
+    return Boolean(this.extensions.findCoreExtension(Extensions.remove)?.config?.removed);
+  }
+  shouldRemoveFromMain(): boolean {
+    return Boolean(this.extensions.findCoreExtension(Extensions.remove)?.config?.removeOnMain);
+  }
+
+  /**
+   * Validate the version model properties, to make sure we are not inserting something
+   * in the wrong format
+   */
+  validate(): void {
+    validateVersionInstance(this);
+  }
+}