@teambit/component 1.0.108 → 1.0.109

package/component.ts

@@ -1,319 +0,0 @@
-import { AnyFS } from '@teambit/any-fs';
-import { capitalize } from '@teambit/toolbox.string.capitalize';
-import { SemVer } from 'semver';
-import { ComponentID } from '@teambit/component-id';
-import { BitError } from '@teambit/bit-error';
-import { BuildStatus } from '@teambit/legacy/dist/constants';
-
-import { slice } from 'lodash';
-import { ComponentFactory } from './component-factory';
-import ComponentFS from './component-fs';
-// import { NothingToSnap } from './exceptions';
-import { Config as ComponentConfig } from './config';
-// eslint-disable-next-line import/no-cycle
-import { Snap } from './snap';
-import { State } from './state';
-import { TagMap } from './tag-map';
-import { Tag } from './tag';
-import { CouldNotFindLatest } from './exceptions';
-import { IComponent, RawComponentMetadata } from './component-interface';
-// import { Author } from './types';
-
-type SnapsIterableOpts = {
-  firstParentOnly?: boolean;
-  stopFn?: (snap: Snap) => Promise<boolean>;
-};
-
-export type InvalidComponent = { id: ComponentID; err: Error };
-
-/**
- * in-memory representation of a component.
- */
-export class Component implements IComponent {
-  constructor(
-    /**
-     * component ID represented by the `ComponentId` type.
-     */
-    readonly id: ComponentID,
-
-    /**
-     * head version of the component. can be `null` for new components.
-     */
-    readonly head: Snap | null = null,
-
-    /**
-     * state of the component.
-     */
-    private _state: State,
-
-    /**
-     * tags of the component.
-     */
-    readonly tags: TagMap = new TagMap(),
-
-    /**
-     * the component factory
-     */
-    private factory: ComponentFactory
-  ) {}
-
-  get mainFile() {
-    return this.state.mainFile;
-  }
-
-  get state(): State {
-    return this._state;
-  }
-
-  set state(state: State) {
-    this._state = state;
-  }
-
-  /**
-   * component configuration which is later generated to a component `package.json` and `bit.json`.
-   */
-  get config(): ComponentConfig {
-    return this.state.config;
-  }
-
-  /**
-   * in-memory representation of the component current filesystem.
-   */
-  get filesystem(): ComponentFS {
-    return this.state.filesystem;
-  }
-
-  /**
-   * build status of the component
-   */
-  get buildStatus(): BuildStatus {
-    return this._state._consumer.buildStatus;
-  }
-
-  get headTag() {
-    if (!this.head) return undefined;
-    return this.tags.byHash(this.head.hash);
-  }
-
-  get latest(): string | undefined {
-    if (!this.head) return undefined;
-    try {
-      return this.tags.getLatest();
-    } catch (err: any) {
-      if (err instanceof CouldNotFindLatest) {
-        return this.head.hash;
-      }
-      throw err;
-    }
-  }
-
-  /**
-   * get aspect data from current state.
-   */
-  get(id: string): RawComponentMetadata | undefined {
-    return this.state.aspects.get(id)?.serialize();
-  }
-
-  async getLogs(filter?: { type?: string; offset?: number; limit?: number; head?: string; sort?: string }) {
-    const allLogs = await this.factory.getLogs(this.id, false, filter?.head);
-
-    if (!filter) return allLogs;
-
-    const { type, limit, offset, sort } = filter;
-
-    const typeFilter = (snap) => {
-      if (type === 'tag') return snap.tag;
-      if (type === 'snap') return !snap.tag;
-      return true;
-    };
-
-    let filteredLogs = (type && allLogs.filter(typeFilter)) || allLogs;
-    if (sort !== 'asc') filteredLogs = filteredLogs.reverse();
-
-    if (limit) {
-      filteredLogs = slice(filteredLogs, offset, limit + (offset || 0));
-    }
-
-    return filteredLogs;
-  }
-
-  stringify(): string {
-    return JSON.stringify({
-      id: this.id,
-      head: this.head,
-    });
-  }
-
-  /**
-   * record component changes in the `Scope`.
-   */
-  // snap(author: Author, message = '') {
-  // if (!this.isModified()) throw new NothingToSnap();
-  // const snap = new Snap(this, author, message);
-
-  // return new Component(this.id, snap, snap.state);
-  // }
-
-  /**
-   * display name of the component.
-   */
-  get displayName() {
-    const tokens = this.id.name.split('-').map((token) => capitalize(token));
-    return tokens.join(' ');
-  }
-
-  /**
-   * tag a component `Snap` with a semantic version. we follow SemVer specs as defined [here](https://semver.org/)).
-   */
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  tag(version: SemVer) {
-    // const snap = this.snap();
-    // const tag = new Tag(version, snap);
-    // this.tags.set(tag);
-  }
-
-  /**
-   * determines whether this component is modified in the workspace.
-   */
-  isModified(): Promise<boolean> {
-    return this.factory.isModified(this);
-  }
-
-  /**
-   * whether a component is marked as deleted.
-   */
-  isDeleted(): boolean {
-    return this.state._consumer.isRemoved();
-  }
-
-  /**
-   * is component isOutdated
-   */
-  isOutdated(): boolean {
-    if (!this.latest) return false;
-    const latestTag = this.tags.byVersion(this.latest);
-    if (!latestTag) return false;
-    if (this.head?.hash !== latestTag?.hash) return true;
-    return false;
-  }
-
-  /**
-   * determines whether this component is new.
-   */
-  isNew(): Promise<boolean> {
-    return Promise.resolve(this.head === null);
-  }
-
-  // TODO: @david after snap we need to make sure to refactor here.
-  loadState(snapId: string): Promise<State> {
-    return this.factory.getState(this.id, snapId);
-  }
-
-  loadSnap(snapId?: string): Promise<Snap> {
-    const snapToGet = snapId || this.head?.hash;
-    if (!snapToGet) {
-      throw new BitError('could not load snap for new components');
-    }
-    return this.factory.getSnap(this.id, snapToGet);
-  }
-
-  /**
-   * Get iterable which iterate over snap parents lazily
-   * @param snapId
-   * @param options
-   */
-  snapsIterable(snapId?: string, options: SnapsIterableOpts = {}): AsyncIterable<Snap> {
-    const snapToStart = snapId || this.head?.hash;
-    let nextSnaps = [snapToStart];
-    let done;
-    if (!snapToStart) {
-      done = true;
-    }
-
-    const iterator: AsyncIterator<Snap> = {
-      next: async () => {
-        if (done) {
-          return { value: undefined, done };
-        }
-        const currSnapId = nextSnaps.shift();
-        const snap = await this.loadSnap(currSnapId);
-        if (snap.parents && snap.parents.length) {
-          if (options.firstParentOnly) {
-            nextSnaps.push(snap.parents[0]);
-          } else {
-            nextSnaps = nextSnaps.concat(snap.parents);
-          }
-        }
-        if (!nextSnaps.length) {
-          done = true;
-        } else if (options.stopFn) {
-          done = await options.stopFn(snap);
-        }
-        return { value: snap, done: undefined };
-      },
-    };
-    return {
-      [Symbol.asyncIterator]: () => iterator,
-    };
-  }
-
-  /**
-   * traverse recursively from the provided snap (or head) upwards until it finds a tag
-   * @param snapToStartFrom
-   */
-  async getClosestTag(snapToStartFrom?: string): Promise<Tag | undefined> {
-    const tagsHashMap = this.tags.getHashMap();
-    const stopFn = async (snap: Snap) => {
-      if (tagsHashMap.has(snap.hash)) {
-        return true;
-      }
-      return false;
-    };
-    const iterable = this.snapsIterable(snapToStartFrom, { firstParentOnly: true, stopFn });
-    const snaps: Snap[] = [];
-    for await (const snap of iterable) {
-      snaps.push(snap);
-    }
-    if (snaps.length) {
-      const hashOfLastSnap = snaps[snaps.length - 1].hash;
-      return tagsHashMap.get(hashOfLastSnap);
-    }
-    return undefined;
-  }
-
-  /**
-   * checkout the component to a different version in its working tree.
-   */
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  checkout(version: SemVer) {}
-
-  /**
-   * examine difference between two components.
-   */
-  // diff(other: Component): Difference {}
-
-  /**
-   * merge two different components
-   */
-  // merge(other: Component): Component {}
-
-  /**
-   * write a component to a given file system.
-   * @param path root path to write the component
-   * @param fs instance of any fs to use.
-   */
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  write(path: string, fs?: AnyFS) {}
-
-  /**
-   *
-   * Check if 2 components are equal
-   * @param {Component} component
-   * @returns {boolean}
-   * @memberof Component
-   */
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  equals(component: Component): boolean {
-    return component.id.toString() === this.id.toString();
-  }
-}

package/config.ts

@@ -1,24 +0,0 @@
-import { ExtensionDataList } from '@teambit/legacy/dist/consumer/config/extension-data';
-import { PathLinuxRelative, PathOsBasedRelative } from '@teambit/legacy/dist/utils/path';
-
-/**
- * in-memory representation of the component configuration.
- */
-export class Config {
-  constructor(private consumerComponent: any) {}
-
-  /**
-   * component main file
-   * when loaded from the workspace, it's PathOsBasedRelative. otherwise, PathLinuxRelative.
-   */
-  get main(): PathLinuxRelative | PathOsBasedRelative {
-    return this.consumerComponent.mainFile;
-  }
-
-  /**
-   * configured extensions
-   */
-  get extensions(): ExtensionDataList {
-    return this.consumerComponent.extensions;
-  }
-}

package/get-component-opts.ts

@@ -1,14 +0,0 @@
-import React from 'react';
-import { RouteProps } from 'react-router-dom';
-import type { UseComponentType, Filters } from './ui/use-component';
-
-export type GetComponentsOptions = {
-  useComponent?: UseComponentType;
-  componentId?: string | (() => string | undefined);
-  useComponentFilters?: () => Filters;
-  path?: string;
-  skipRightSide?: boolean;
-  RightNode?: React.ReactNode;
-  className?: string;
-  routes?: RouteProps[];
-};

package/hash.ts

@@ -1,4 +0,0 @@
-/**
- * type for representing content-addressable filesystem hashes.
- */
-export type Hash = string;

package/history-graph.ts

@@ -1 +0,0 @@
-export default class HistoryGraph {}

package/index.ts

@@ -1,50 +0,0 @@
-import { ComponentAspect } from './component.aspect';
-
-export type { GetComponentsOptions } from './get-component-opts';
-export type { UseComponentType } from './ui/use-component';
-export { useComponentHost } from './host';
-export { Component, InvalidComponent } from './component';
-export { ComponentID } from '@teambit/component-id';
-export { default as ComponentFS } from './component-fs';
-export type { Config as ComponentConfig } from './config';
-export type {
-  ComponentFactory,
-  ResolveAspectsOptions,
-  FilterAspectsOptions,
-  LoadAspectsOptions,
-} from './component-factory';
-export type { AspectList } from './aspect-list';
-export { AspectEntry, AspectData, ResolveComponentIdFunc } from './aspect-entry';
-// TODO: check why it's not working when using the index in snap dir like this:
-// export { Snap, Author } from './snap';
-export { Snap, SnapProps } from './snap/snap';
-export type { Author } from './snap/author';
-// TODO: check why it's not working when using the index in tag dir like this:
-// export { Tag } from './tag';
-export { Tag, TagProps } from './tag/tag';
-export type { IComponent } from './component-interface';
-export { State } from './state';
-export type { Hash } from './hash';
-export { TagMap } from './tag-map';
-export { ComponentMap } from './component-map';
-export type { ComponentMain } from './component.main.runtime';
-export type { ComponentUI } from './component.ui.runtime';
-export type { Section } from './section';
-export { ComponentContext, ComponentDescriptorContext, useComponentDescriptor } from './ui/context/component-context';
-export type { ComponentProviderProps, ComponentDescriptorProviderProps } from './ui/context';
-export { ComponentProvider, ComponentDescriptorProvider } from './ui/context';
-export { componentFields, componentIdFields, componentOverviewFields } from './ui';
-export type { NavPlugin, ConsumePlugin, MenuNavProps } from './ui/menu';
-export { CollapsibleMenuNav, ComponentMenu, VersionRelatedDropdowns } from './ui/menu';
-export type { RegisteredComponentRoute, ComponentUrlParams } from './component.route';
-export type { ComponentModelProps } from './ui/component-model';
-export { ComponentModel } from './ui/component-model';
-export { TopBarNav } from './ui/top-bar-nav';
-export type { ShowFragment, ShowRow, ShowJSONRow } from './show';
-export { Config } from './config';
-export { useComponent, useIdFromLocation, useComponentLogs, ComponentLogsResult, Filters } from './ui';
-
-// export { AspectList } from './aspect-list';
-// export { AspectEntry } from './aspect-entry';
-export { ComponentAspect };
-export default ComponentAspect;

package/state.ts

@@ -1,88 +0,0 @@
-import { IssuesList } from '@teambit/component-issues';
-import { ComponentID } from '@teambit/component-id';
-import ComponentFS from './component-fs';
-import { Config } from './config';
-import { AspectList } from './aspect-list';
-import { MainFileNotFound } from './exceptions';
-
-export class State {
-  constructor(
-    /**
-     * component configuration which is later generated to a component `package.json` and `bit.json`.
-     * @deprecated please use `aspects` instead.
-     */
-    readonly config: Config,
-
-    /**
-     * list of aspects configured on the component.
-     */
-    private _aspects: AspectList,
-
-    /**
-     * in-memory representation of the component current filesystem.
-     */
-    readonly filesystem: ComponentFS,
-
-    /**
-     * dependency graph of the component current. ideally package dependencies would be also placed here.
-     */
-    // readonly dependencies: Dependencies
-    readonly dependencies,
-
-    /**
-     * instance of legacy consumer component.
-     */
-    readonly _consumer: any
-  ) {}
-
-  /**
-   * get the main file of the component.
-   */
-  get mainFile() {
-    const file = this.filesystem.files.find((componentFile) => {
-      return componentFile.relative === this._consumer.mainFile;
-    });
-
-    if (!file) throw new MainFileNotFound(ComponentID.fromLegacy(this._consumer.id), this._consumer.mainFile);
-
-    return file;
-  }
-
-  /**
-   * calculate the hash of this state
-   */
-  get hash() {
-    return '';
-  }
-
-  get issues(): IssuesList {
-    return (this._consumer.issues ||= new IssuesList());
-  }
-
-  /**
-   * @deprecated please use `component.isModified`.
-   * the way it's implemented here is unreliable and will only work if in the legacy the "isModified" was calculated.
-   */
-  get isModified(): boolean {
-    return this._consumer._isModified;
-  }
-
-  get aspects(): AspectList {
-    return this._aspects;
-  }
-
-  set aspects(aspects: AspectList) {
-    this._aspects = aspects;
-  }
-
-  // static fromLegacy(consumerComponent: ConsumerComponent) {
-  //   return new State(
-  //     new Config(consumerComponent.mainFile, consumerComponent.extensions),
-  //     consumerComponent.version || 'new',
-  //     ComponentFS.fromVinyls(consumerComponent.files),
-  //     Store.fromArray([]),
-  //     consumerComponent.dependencies,
-  //     consumerComponent
-  //   );
-  // }
-}

package/store.ts

@@ -1,3 +0,0 @@
-import { ExtensionDataList } from '@teambit/legacy/dist/consumer/config/extension-data';
-
-export class Store extends ExtensionDataList {}

package/tag-map.ts

@@ -1,87 +0,0 @@
-import { getLatestVersion } from '@teambit/legacy/dist/utils/semver-helper';
-import { SemVer, maxSatisfying } from 'semver';
-
-import { CouldNotFindLatest } from './exceptions';
-import { Hash } from './hash';
-import { Tag } from './tag';
-
-export class TagMap extends Map<SemVer, Tag> {
-  /**
-   * get snap by hash.
-   */
-  byHash(hash: Hash) {
-    const tag = Array.from(this.values()).find((currTag) => currTag.hash === hash);
-    return tag;
-  }
-
-  /**
-   * e.g.
-   * {
-   *   alpha: '1.0.0-alpha.5',
-   *   dev: '2.2.4-dev.37
-   * }
-   */
-  getPreReleaseLatestTags(): { [preRelease: string]: string } {
-    const preReleaseTagsWithAllVersions = this.toArray().reduce((acc, current) => {
-      const preReleases = current.version.prerelease;
-      if (!preReleases.length) return acc;
-      if (preReleases.length !== 2) {
-        // it could be length 1, e.g. 1.0.0-0, we ignore it.
-        // it could also be length > 2, e.g. 1.0.0-dev.1.alpha.1, we don't support it for now.
-        return acc;
-      }
-      if (typeof preReleases[0] !== 'string') return acc;
-      (acc[preReleases[0]] ||= []).push(current.version.raw);
-      return acc;
-    }, {});
-    return Object.keys(preReleaseTagsWithAllVersions).reduce((acc, current) => {
-      acc[current] = maxSatisfying<string>(preReleaseTagsWithAllVersions[current], '*', { includePrerelease: true });
-      return acc;
-    }, {});
-  }
-
-  /**
-   * Get a map that map snap hash to tag
-   */
-  getHashMap(): Map<Hash, Tag> {
-    const res: Map<Hash, Tag> = new Map();
-    this.forEach((tag: Tag) => {
-      res.set(tag.hash, tag);
-    });
-    return res;
-  }
-
-  /**
-   * get the latest semver from the tag map.
-   */
-  getLatest(): string {
-    const versions = this.toArray().map((tag) => tag.version.raw);
-    if (this.isEmpty()) throw new CouldNotFindLatest(versions);
-    return getLatestVersion(versions);
-  }
-
-  isEmpty() {
-    return this.size === 0;
-  }
-
-  /**
-   * get an array of all tags.
-   */
-  toArray(): Tag[] {
-    return Array.from(this.values());
-  }
-
-  byVersion(version: string): Tag | undefined {
-    const versions = this.toArray().map((tag) => tag);
-    return versions.find((tag) => tag.version.raw === version);
-  }
-
-  static fromArray(tags: Tag[]) {
-    const tuples: [SemVer, Tag][] = tags.map((tag) => [tag.version, tag]);
-    return new TagMap(tuples);
-  }
-
-  static empty() {
-    return new TagMap();
-  }
-}