@teambit/component 0.0.555 → 0.0.559

package/component-meta.ts

@@ -1,29 +0,0 @@
-import { capitalize } from '@teambit/toolbox.string.capitalize';
-import { ComponentID } from '@teambit/component-id';
-
-export class ComponentMeta {
-  constructor(
-    /**
-     * id the component.
-     */
-    readonly id: ComponentID
-  ) {}
-
-  /**
-   * display name of the component.
-   */
-  get displayName() {
-    const tokens = this.id.name.split('-').map((token) => capitalize(token));
-    return tokens.join(' ');
-  }
-
-  toObject() {
-    return {
-      id: this.id.toObject(),
-    };
-  }
-
-  static from(object: { [key: string]: any }) {
-    return new ComponentMeta(ComponentID.fromObject(object.id));
-  }
-}

package/component.aspect.ts

@@ -1,9 +0,0 @@
-import { Aspect } from '@teambit/harmony';
-
-export const ComponentAspect = Aspect.create({
-  id: 'teambit.component/component',
-  dependencies: [],
-  defaultConfig: {},
-});
-
-export default ComponentAspect;

package/component.graphql.ts

@@ -1,202 +0,0 @@
-import stripAnsi from 'strip-ansi';
-import gql from 'graphql-tag';
-import { GraphQLJSONObject } from 'graphql-type-json';
-import { pathNormalizeToLinux } from '@teambit/legacy/dist/utils';
-
-import { Component } from './component';
-import { ComponentFactory } from './component-factory';
-import { ComponentMain } from './component.main.runtime';
-
-export function componentSchema(componentExtension: ComponentMain) {
-  return {
-    typeDefs: gql`
-      scalar JSON
-      scalar JSONObject
-
-      type ComponentID {
-        name: String!
-        version: String
-        scope: String
-      }
-
-      type Tag {
-        # semver assigned to the tag.
-        version: String!
-
-        # tag hash.
-        hash: String!
-      }
-
-      type Snap {
-        # hash of the snapshot.
-        hash: String!
-
-        # time of the snapshot.
-        timestamp: String!
-
-        # parents of the snap
-        parents: [Snap]!
-
-        # snapper
-        author: Author!
-
-        # snapshot message
-        message: String
-      }
-
-      type LogEntry {
-        message: String!
-        username: String
-        email: String
-        date: String
-        hash: String!
-        tag: String
-        # id: String!
-      }
-
-      type Author {
-        # display name of the snapper.
-        displayName: String!
-
-        # author of the snapper.
-        email: String!
-      }
-
-      type Component {
-        # id of the component.
-        id: ComponentID!
-
-        # head snap of the component.
-        head: Snap
-
-        # head tag of the component.
-        headTag: Tag
-
-        # list of all relative component paths.
-        fs: [String]
-
-        # relative path to the main file of the component
-        mainFile: String
-
-        # return specific file contents by relative file path.
-        getFile(path: String): String
-
-        # latest version of the component.
-        latest: String
-
-        # display name of the component
-        displayName: String!
-
-        # component buildStatus
-        buildStatus: String
-
-        # list of component releases.
-        tags: [Tag]!
-
-        aspects: [Aspect]
-      }
-
-      type Aspect {
-        id: String!
-        icon: String
-        config: JSONObject
-        data: JSONObject
-      }
-
-      type InvalidComponent {
-        id: ComponentID!
-        errorName: String!
-        errorMessage: String!
-      }
-
-      type ComponentHost {
-        id: ID!
-        name: String!
-
-        # load a component.
-        get(id: String!, withState: Boolean): Component
-
-        # list components
-        list(offset: Int, limit: Int): [Component]!
-
-        # list invalid components and their errors
-        listInvalid: [InvalidComponent]!
-
-        # get component logs(snaps) by component id
-        snaps(id: String!): [LogEntry]!
-      }
-
-      type Query {
-        getHost(id: String): ComponentHost
-      }
-    `,
-    resolvers: {
-      JSONObject: GraphQLJSONObject,
-      Component: {
-        id: (component: Component) => component.id.toObject(),
-        displayName: (component: Component) => component.displayName,
-        fs: (component: Component) => {
-          return component.state.filesystem.files.map((file) => file.relative);
-        },
-        getFile: (component: Component, { path }: { path: string }) => {
-          const maybeFile = component.state.filesystem.files.find(
-            (file) => pathNormalizeToLinux(file.relative) === path
-          );
-          if (!maybeFile) return undefined;
-          return maybeFile.contents.toString('utf-8');
-        },
-        mainFile: (component: Component) => {
-          return component.state._consumer.mainFile;
-        },
-        headTag: (component: Component) => component.headTag?.toObject(),
-        latest: (component: Component) => component.latest,
-        tags: (component) => {
-          // graphql doesn't support map types
-          return component.tags.toArray().map((tag) => tag.toObject());
-        },
-        aspects: (component: Component) => {
-          const aspects = component.state.aspects.serialize();
-          return aspects;
-        },
-      },
-      ComponentHost: {
-        get: async (host: ComponentFactory, { id }: { id: string }) => {
-          try {
-            const componentId = await host.resolveComponentId(id);
-            const component = await host.get(componentId);
-            return component;
-          } catch (error: any) {
-            return null;
-          }
-        },
-        snaps: async (host: ComponentFactory, { id }: { id: string }) => {
-          const componentId = await host.resolveComponentId(id);
-          // return (await host.getLogs(componentId)).map(log => ({...log, id: log.hash}))
-          return host.getLogs(componentId);
-        },
-        list: async (host: ComponentFactory, filter?: { offset: number; limit: number }) => {
-          return host.list(filter);
-        },
-        listInvalid: async (host: ComponentFactory) => {
-          const invalidComps = await host.listInvalid();
-          return invalidComps.map(({ id, err }) => ({
-            id,
-            errorName: err.name,
-            errorMessage: err.message ? stripAnsi(err.message) : err.name,
-          }));
-        },
-        id: async (host: ComponentFactory) => {
-          return host.name;
-        },
-        name: async (host: ComponentFactory) => {
-          return host.name;
-        },
-      },
-      Query: {
-        getHost: (componentExt: ComponentMain, { id }: { id: string }) => {
-          return componentExtension.getHost(id);
-        },
-      },
-    },
-  };
-}

package/component.main.runtime.ts

@@ -1,162 +0,0 @@
-import { CLIAspect, CLIMain, MainRuntime } from '@teambit/cli';
-import { ExpressAspect, ExpressMain, Route } from '@teambit/express';
-import { GraphqlAspect, GraphqlMain } from '@teambit/graphql';
-import { Slot, SlotRegistry } from '@teambit/harmony';
-import { ConfigAspect, Config } from '@teambit/config';
-import { ComponentID } from '@teambit/component-id';
-import { flatten, orderBy } from 'lodash';
-import { ExtensionDataList } from '@teambit/legacy/dist/consumer/config';
-import { ComponentFactory } from './component-factory';
-import { ComponentAspect } from './component.aspect';
-import { componentSchema } from './component.graphql';
-import { ComponentRoute } from './component.route';
-import { AspectList } from './aspect-list';
-import { HostNotFound } from './exceptions';
-import { AspectEntry } from './aspect-entry';
-import {
-  ShowCmd,
-  ShowFragment,
-  NameFragment,
-  MainFileFragment,
-  IDFragment,
-  ScopeFragment,
-  FilesFragment,
-  ExtensionsFragment,
-} from './show';
-
-export type ComponentHostSlot = SlotRegistry<ComponentFactory>;
-
-export type ShowFragmentSlot = SlotRegistry<ShowFragment[]>;
-
-export class ComponentMain {
-  constructor(
-    /**
-     * slot for component hosts to register.
-     */
-    private hostSlot: ComponentHostSlot,
-
-    /**
-     * Express Extension
-     */
-    private express: ExpressMain,
-
-    private showFragmentSlot: ShowFragmentSlot
-  ) {}
-
-  /**
-   * register a new component host.
-   */
-  registerHost(host: ComponentFactory) {
-    this.hostSlot.register(host);
-    return this;
-  }
-
-  createAspectList(legacyExtensionDataList: ExtensionDataList, scope?: string) {
-    return AspectList.fromLegacyExtensions(legacyExtensionDataList, scope);
-  }
-
-  createAspectListFromEntries(entries: AspectEntry[]) {
-    return new AspectList(entries);
-  }
-
-  registerRoute(routes: Route[]) {
-    const routeEntries = routes.map((route: Route) => {
-      return new ComponentRoute(route, this);
-    });
-
-    this.express.register(flatten(routeEntries));
-    return this;
-  }
-
-  /**
-   * set the prior host.
-   */
-  setHostPriority(id: string) {
-    const host = this.hostSlot.get(id);
-    if (!host) {
-      throw new HostNotFound(id);
-    }
-
-    this._priorHost = host;
-    return this;
-  }
-
-  /**
-   * get component host by extension ID.
-   */
-  getHost(id?: string): ComponentFactory {
-    if (id) {
-      const host = this.hostSlot.get(id);
-      if (!host) throw new HostNotFound(id);
-      return host;
-    }
-
-    return this.getPriorHost();
-  }
-
-  getRoute(id: ComponentID, routeName: string) {
-    return `/api/${id.toString()}/~aspect/${routeName}`;
-  }
-
-  /**
-   * get the prior host.
-   */
-  private getPriorHost() {
-    if (this._priorHost) return this._priorHost;
-
-    const hosts = this.hostSlot.values();
-    const priorityHost = hosts.find((host) => host.priority);
-    return priorityHost || hosts[0];
-  }
-
-  getShowFragments() {
-    const fragments = orderBy(flatten(this.showFragmentSlot.values()), ['weight', ['asc']]);
-    return fragments;
-  }
-
-  isHost(name: string) {
-    return !!this.hostSlot.get(name);
-  }
-
-  /**
-   * register a show fragment to display further information in the `bit show` command.
-   */
-  registerShowFragments(showFragments: ShowFragment[]) {
-    this.showFragmentSlot.register(showFragments);
-    return this;
-  }
-
-  private _priorHost: ComponentFactory | undefined;
-
-  static slots = [Slot.withType<ComponentFactory>(), Slot.withType<Route[]>(), Slot.withType<ShowFragment[]>()];
-
-  static runtime = MainRuntime;
-  static dependencies = [GraphqlAspect, ExpressAspect, CLIAspect, ConfigAspect];
-
-  static async provider(
-    [graphql, express, cli, configAspect]: [GraphqlMain, ExpressMain, CLIMain, Config],
-    config,
-    [hostSlot, showFragmentSlot]: [ComponentHostSlot, ShowFragmentSlot]
-  ) {
-    const componentExtension = new ComponentMain(hostSlot, express, showFragmentSlot);
-
-    if ((configAspect.workspaceConfig && !configAspect.workspaceConfig.isLegacy) || configAspect.type === 'scope') {
-      cli.unregister('show');
-      cli.register(new ShowCmd(componentExtension));
-    }
-
-    componentExtension.registerShowFragments([
-      new NameFragment(),
-      new MainFileFragment(),
-      new IDFragment(),
-      new ScopeFragment(),
-      new FilesFragment(),
-      new ExtensionsFragment(),
-    ]);
-    graphql.register(componentSchema(componentExtension));
-
-    return componentExtension;
-  }
-}
-
-ComponentAspect.addRuntime(ComponentMain);

package/component.route.ts

@@ -1,26 +0,0 @@
-import { NextFunction, Request, Response, Route } from '@teambit/express';
-
-import { ComponentMain } from './component.main.runtime';
-
-export class ComponentRoute implements Route {
-  constructor(private registerRoute: Route, private componentExtension: ComponentMain) {}
-  dynamicRouteRegex = '/?[^/@]+/[^~]*';
-  readonly route = `/:componentId(${this.dynamicRouteRegex})/~aspect${this.registerRoute.route}`;
-
-  get componentMiddlewares() {
-    return [
-      async (req: Request, res: Response, next: NextFunction) => {
-        const { componentId } = req.params;
-        const host = this.componentExtension.getHost();
-        const compId = await host.resolveComponentId(componentId);
-        const component = await host.get(compId);
-        // @ts-ignore
-        req.component = component;
-        next();
-      },
-    ];
-  }
-
-  method = this.registerRoute.method;
-  middlewares = this.componentMiddlewares.concat(this.registerRoute.middlewares);
-}

package/component.ts

@@ -1,278 +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 { ComponentFactory } from './component-factory';
-import ComponentFS from './component-fs';
-// import { NothingToSnap } from './exceptions';
-import 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 { 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 {
-  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 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.toString();
-      }
-      throw err;
-    }
-  }
-
-  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> {
-    if (!this.head) return Promise.resolve(true);
-    return Promise.resolve(this.state.isModified);
-    // return Promise.resolve(this.state.hash !== this.head.hash);
-  }
-
-  /**
-   * 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();
-  }
-}