@teambit/component 0.0.551 → 0.0.556

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();
-  }
-}

package/component.ui.runtime.tsx

@@ -1,216 +0,0 @@
-import PubsubAspect, { PubsubUI, BitBaseEvent } from '@teambit/pubsub';
-import PreviewAspect, { ClickInsideAnIframeEvent } from '@teambit/preview';
-import { MenuItemSlot, MenuItem } from '@teambit/ui-foundation.ui.main-dropdown';
-import { Slot } from '@teambit/harmony';
-import { NavigationSlot, RouteSlot } from '@teambit/ui-foundation.ui.react-router.slot-router';
-import { NavLinkProps } from '@teambit/base-ui.routing.nav-link';
-import { UIRuntime } from '@teambit/ui';
-import { isBrowser } from '@teambit/ui-foundation.ui.is-browser';
-import React from 'react';
-import { RouteProps } from 'react-router-dom';
-import CommandBarAspect, { CommandBarUI, CommandEntry } from '@teambit/command-bar';
-import copy from 'copy-to-clipboard';
-import { ComponentAspect } from './component.aspect';
-import { Component, ComponentPageElement, ComponentPageSlot } from './ui/component';
-import { Menu, NavPlugin, OrderedNavigationSlot } from './ui/menu';
-import { AspectSection } from './aspect.section';
-import { ComponentModel } from './ui';
-
-export type Server = {
-  env: string;
-  url: string;
-};
-
-export type ComponentMeta = {
-  id: string;
-};
-
-export const componentIdUrlRegex = '[\\w\\/-]*[\\w-]';
-
-export class ComponentUI {
-  readonly routePath = `/:componentId(${componentIdUrlRegex})`;
-
-  constructor(
-    /**
-     * Pubsub aspects
-     */
-    private pubsub: PubsubUI,
-
-    private routeSlot: RouteSlot,
-
-    private navSlot: OrderedNavigationSlot,
-
-    /**
-     * slot for registering a new widget to the menu.
-     */
-    private widgetSlot: OrderedNavigationSlot,
-
-    private menuItemSlot: MenuItemSlot,
-
-    private pageItemSlot: ComponentPageSlot,
-
-    private commandBarUI: CommandBarUI
-  ) {
-    if (isBrowser) this.registerPubSub();
-  }
-
-  /**
-   * the current visible component
-   */
-  private activeComponent?: ComponentModel;
-
-  private copyNpmId = () => {
-    const packageName = this.activeComponent?.packageName;
-    if (packageName) {
-      const version = this.activeComponent?.id.version;
-      const versionString = version ? `@${version}` : '';
-      copy(`${packageName}${versionString}`);
-    }
-  };
-
-  /**
-   * key bindings used by component aspect
-   */
-  private keyBindings: CommandEntry[] = [
-    {
-      id: 'component.copyBitId', // TODO - extract to a component!
-      handler: () => {
-        copy(this.activeComponent?.id.toString() || '');
-      },
-      displayName: 'Copy component ID',
-      keybinding: '.',
-    },
-    {
-      id: 'component.copyNpmId', // TODO - extract to a component!
-      handler: this.copyNpmId,
-      displayName: 'Copy component package name',
-      keybinding: ',',
-    },
-  ];
-
-  private menuItems: MenuItem[] = [
-    {
-      category: 'general',
-      title: 'Open command bar',
-      keyChar: 'mod+k',
-      handler: () => this.commandBarUI?.run('command-bar.open'),
-    },
-    {
-      category: 'general',
-      title: 'Toggle component list',
-      keyChar: 'alt+s',
-      handler: () => this.commandBarUI?.run('sidebar.toggle'),
-    },
-    {
-      category: 'workflow',
-      title: 'Copy component ID',
-      keyChar: '.',
-      handler: () => this.commandBarUI?.run('component.copyBitId'),
-    },
-    {
-      category: 'workflow',
-      title: 'Copy component package name',
-      keyChar: ',',
-      handler: () => this.commandBarUI?.run('component.copyNpmId'),
-    },
-  ];
-
-  registerPubSub() {
-    this.pubsub.sub(PreviewAspect.id, (be: BitBaseEvent<any>) => {
-      if (be.type === ClickInsideAnIframeEvent.TYPE) {
-        const event = new MouseEvent('mousedown', {
-          view: window,
-          bubbles: true,
-          cancelable: true,
-        });
-
-        const body = document.body;
-        body?.dispatchEvent(event);
-      }
-    });
-  }
-
-  handleComponentChange = (activeComponent?: ComponentModel) => {
-    this.activeComponent = activeComponent;
-  };
-
-  getComponentUI(host: string) {
-    return (
-      <Component
-        routeSlot={this.routeSlot}
-        containerSlot={this.pageItemSlot}
-        onComponentChange={this.handleComponentChange}
-        host={host}
-      />
-    );
-  }
-
-  getMenu(host: string) {
-    return (
-      <Menu navigationSlot={this.navSlot} widgetSlot={this.widgetSlot} host={host} menuItemSlot={this.menuItemSlot} />
-    );
-  }
-
-  registerRoute(route: RouteProps) {
-    this.routeSlot.register(route);
-    return this;
-  }
-
-  registerNavigation(nav: NavLinkProps, order?: number) {
-    this.navSlot.register({
-      props: nav,
-      order,
-    });
-  }
-
-  registerWidget(widget: NavLinkProps, order?: number) {
-    this.widgetSlot.register({ props: widget, order });
-  }
-
-  registerMenuItem = (menuItems: MenuItem[]) => {
-    this.menuItemSlot.register(menuItems);
-  };
-
-  registerPageItem = (...items: ComponentPageElement[]) => {
-    this.pageItemSlot.register(items);
-  };
-
-  static dependencies = [PubsubAspect, CommandBarAspect];
-
-  static runtime = UIRuntime;
-
-  static slots = [
-    Slot.withType<RouteProps>(),
-    Slot.withType<NavPlugin>(),
-    Slot.withType<NavigationSlot>(),
-    Slot.withType<MenuItemSlot>(),
-    Slot.withType<ComponentPageSlot>(),
-  ];
-
-  static async provider(
-    [pubsub, commandBarUI]: [PubsubUI, CommandBarUI],
-    config,
-    [routeSlot, navSlot, widgetSlot, menuItemSlot, pageSlot]: [
-      RouteSlot,
-      OrderedNavigationSlot,
-      OrderedNavigationSlot,
-      MenuItemSlot,
-      ComponentPageSlot
-    ]
-  ) {
-    // TODO: refactor ComponentHost to a separate extension (including sidebar, host, graphql, etc.)
-    // TODO: add contextual hook for ComponentHost @uri/@oded
-    const componentUI = new ComponentUI(pubsub, routeSlot, navSlot, widgetSlot, menuItemSlot, pageSlot, commandBarUI);
-    const section = new AspectSection();
-
-    componentUI.commandBarUI.addCommand(...componentUI.keyBindings);
-    componentUI.registerMenuItem(componentUI.menuItems);
-    componentUI.registerRoute(section.route);
-    componentUI.registerWidget(section.navigationLink, section.order);
-    return componentUI;
-  }
-}
-
-export default ComponentUI;
-
-ComponentAspect.addRuntime(ComponentUI);

package/config.ts

@@ -1,34 +0,0 @@
-import { Compilers, Testers } from '@teambit/legacy/dist/consumer/config/abstract-config';
-import { ComponentOverridesData } from '@teambit/legacy/dist/consumer/config/component-overrides';
-import { ExtensionDataList } from '@teambit/legacy/dist/consumer/config/extension-data';
-import { PathLinux } from '@teambit/legacy/dist/utils/path';
-// import { CustomResolvedPath } from '@teambit/legacy/dist/consumer/component/consumer-component';
-// import { ComponentOverridesData } from '@teambit/legacy/dist/consumer/config/component-overrides';
-
-type LegacyConfigProps = {
-  lang?: string;
-  compiler?: string | Compilers;
-  tester?: string | Testers;
-  bindingPrefix: string;
-  extensions?: ExtensionDataList;
-  overrides?: ComponentOverridesData;
-};
-
-/**
- * in-memory representation of the component configuration.
- */
-export default class Config {
-  constructor(
-    /**
-     * version main file
-     */
-    readonly main: PathLinux,
-
-    /**
-     * configured extensions
-     */
-    readonly extensions: ExtensionDataList,
-
-    readonly legacyProperties?: LegacyConfigProps
-  ) {}
-}

package/dependencies/dependencies.ts

@@ -1,74 +0,0 @@
-/* eslint-disable max-classes-per-file */
-import { BitError } from '@teambit/bit-error';
-import { BitId } from '@teambit/legacy-bit-id';
-
-const DEV_ENV = 'development';
-const RUNTIME_ENV = 'runtime';
-
-// type Environment = DEV_ENV | RUNTIME_ENV;
-type Environment = 'development' | 'runtime';
-// type WrappingMethod = 'component' | 'package';
-
-export class DependencyId extends BitId {}
-
-export class Dependency {
-  constructor(public id: DependencyId) {}
-}
-
-export class PackageDependency extends Dependency {}
-
-export class ComponentDependency extends Dependency {}
-
-export class DependencyList extends Array<Dependency> {
-  /**
-   * Get only package dependencies
-   *
-   * @readonly
-   * @memberof DependencyList
-   */
-  get packages(): PackageDependency[] {
-    return this.filter((dep) => dep instanceof PackageDependency);
-  }
-
-  get components(): ComponentDependency[] {
-    return this.filter((dep) => dep instanceof ComponentDependency);
-  }
-
-  static fromArray(dependencies: Dependency[]): DependencyList {
-    return new DependencyList(...dependencies);
-  }
-}
-
-export class Dependencies {
-  constructor(public runtime: DependencyList, public dev: DependencyList, public peer: DependencyList) {}
-
-  private getByEnvironment(env: Environment): DependencyList {
-    if (env === DEV_ENV) {
-      return DependencyList.fromArray(this.runtime.concat(this.dev).concat(this.peer));
-    }
-    if (env === RUNTIME_ENV) {
-      return DependencyList.fromArray(this.runtime.concat(this.peer));
-    }
-    throw new BitError(`env ${env} is not supported`);
-  }
-
-  /**
-   * Get dependencies needed for development environnement such as runtime, dev and peer
-   *
-   * @returns {DependencyList}
-   * @memberof Dependencies
-   */
-  computeDev(): DependencyList {
-    return this.getByEnvironment(DEV_ENV);
-  }
-
-  /**
-   * Get dependencies needed for runtime environnement such as runtime and peer
-   *
-   * @returns {DependencyList}
-   * @memberof Dependencies
-   */
-  computeRuntime(): DependencyList {
-    return this.getByEnvironment(RUNTIME_ENV);
-  }
-}

package/dependencies/index.ts

@@ -1 +0,0 @@
-export { Dependencies } from './dependencies';

package/exceptions/could-not-find-latest.ts

@@ -1,8 +0,0 @@
-export class CouldNotFindLatest extends Error {
-  constructor(semverArray: string[]) {
-    super(`could not find latest semver in array: ${semverArray.join(', ')}`);
-  }
-  report() {
-    return this.message;
-  }
-}

package/exceptions/host-not-found.ts

@@ -1,14 +0,0 @@
-export class HostNotFound extends Error {
-  constructor(
-    /**
-     * name of the host.
-     */
-    private hostName: string
-  ) {
-    super();
-  }
-
-  toString() {
-    return `[component] error: host '${this.hostName}' was not found`;
-  }
-}

package/exceptions/index.ts

@@ -1,4 +0,0 @@
-// eslint-disable-next-line import/prefer-default-export
-export { default as NothingToSnap } from './nothing-to-snap';
-export { HostNotFound } from './host-not-found';
-export { CouldNotFindLatest } from './could-not-find-latest';

package/exceptions/nothing-to-snap.ts

@@ -1 +0,0 @@
-export default class NothingToSnap extends Error {}

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/host/component-host-model.ts

@@ -1,9 +0,0 @@
-import { ComponentModel } from '../ui';
-
-export class ComponentHostModel {
-  constructor(readonly name: string, readonly components: ComponentModel[]) {}
-
-  static from(data: any) {
-    return new ComponentHostModel(data.getHost.name, ComponentModel.fromArray(data.getHost.list));
-  }
-}

package/host/index.ts

@@ -1,2 +0,0 @@
-export { useComponentHost } from './use-component-host';
-export * from './component-host-model';

package/host/use-component-host.ts

@@ -1,39 +0,0 @@
-import { useDataQuery } from '@teambit/ui-foundation.ui.hooks.use-data-query';
-import { gql } from '@apollo/client';
-
-import { ComponentHostModel } from './component-host-model';
-
-const COMPONENT_HOST = gql`
-  {
-    getHost {
-      id # used for GQL caching
-      name
-      list {
-        id {
-          name
-          version
-          scope
-        }
-        deprecation {
-          isDeprecate
-        }
-        env {
-          id
-          icon
-        }
-      }
-    }
-  }
-`;
-
-export function useComponentHost() {
-  const { data, loading } = useDataQuery(COMPONENT_HOST);
-
-  if (!data || loading) {
-    return {};
-  }
-
-  const host = ComponentHostModel.from(data);
-
-  return { host };
-}