@teambit/component 0.0.554 → 0.0.558

package/aspect.section.tsx

@@ -1,16 +0,0 @@
-import React from 'react';
-import { MenuWidgetIcon } from '@teambit/ui-foundation.ui.menu-widget-icon';
-import { Section } from './section';
-import { AspectPage } from './ui/aspect-page';
-
-export class AspectSection implements Section {
-  route = {
-    path: '~aspect',
-    children: <AspectPage />,
-  };
-  navigationLink = {
-    href: '~aspect',
-    children: <MenuWidgetIcon icon="configuration" tooltipContent="Configuration" />,
-  };
-  order = 50;
-}

package/component-factory.ts

@@ -1,106 +0,0 @@
-import { BitId } from '@teambit/legacy-bit-id';
-import LegacyGraph from '@teambit/legacy/dist/scope/graph/graph';
-import ConsumerComponent from '@teambit/legacy/dist/consumer/component';
-import type { ComponentLog } from '@teambit/legacy/dist/scope/models/model-component';
-import type { AspectDefinition } from '@teambit/aspect-loader';
-import { ComponentID } from '@teambit/component-id';
-import { Component, InvalidComponent } from './component';
-import { State } from './state';
-import { Snap } from './snap';
-
-export interface ComponentFactory {
-  /**
-   * name of the component host.
-   */
-  name: string;
-
-  /**
-   * path to the component host.
-   */
-  path: string;
-
-  isLegacy: boolean;
-
-  /**
-   * resolve a `string` component ID to an instance of a ComponentID.
-   */
-  resolveComponentId(id: string | ComponentID | BitId): Promise<ComponentID>;
-
-  /**
-   * resolve multiple `string` component ID to an instance of a ComponentID.
-   */
-  resolveMultipleComponentIds(ids: (string | ComponentID | BitId)[]): Promise<ComponentID[]>;
-
-  /**
-   * returns a component by ID.
-   */
-  get(
-    id: ComponentID | string,
-    withState?: boolean,
-    consumerComponent?: ConsumerComponent
-  ): Promise<Component | undefined>;
-
-  /**
-   * returns many components by ids.
-   */
-  getMany(ids: ComponentID[]): Promise<Component[]>;
-
-  /**
-   * returns many components by their legacy representation.
-   */
-  getManyByLegacy(components: ConsumerComponent[]): Promise<Component[]>;
-
-  /**
-   * get a component from a remote without importing it
-   */
-  getRemoteComponent?: (id: ComponentID) => Promise<Component>;
-
-  getLegacyGraph(ids?: ComponentID[]): Promise<LegacyGraph>;
-
-  getLogs(id: ComponentID): Promise<ComponentLog[]>;
-
-  /**
-   * returns a specific state of a component by hash or semver.
-   */
-  getState(id: ComponentID, snapId: string): Promise<State>;
-
-  /**
-   * returns a specific snap of a component by hash.
-   */
-  getSnap(id: ComponentID, snapId: string): Promise<Snap>;
-
-  /**
-   * load extension.
-   */
-  loadAspects: (ids: string[], throwOnError: boolean) => Promise<void>;
-
-  /**
-   * Resolve dirs for aspects
-   */
-  resolveAspects: (runtimeName?: string, componentIds?: ComponentID[]) => Promise<AspectDefinition[]>;
-
-  /**
-   * list all components in the host.
-   */
-  list(filter?: { offset: number; limit: number }): Promise<Component[]>;
-
-  /**
-   * list invalid components, such as components with missing files on the fs.
-   */
-  listInvalid(): Promise<InvalidComponent[]>;
-
-  listIds(): Promise<ComponentID[]>;
-
-  hasId(componentId: ComponentID): Promise<boolean>;
-
-  /**
-   * Check if the host has the id, if no, search for the id in inner host (for example, workspace will search in the scope)
-   * @param componentId
-   */
-  hasIdNested(componentId: ComponentID, includeCache?: boolean): Promise<boolean>;
-
-  /**
-   * determine whether host should be the prior one in case multiple hosts persist.
-   */
-  priority?: boolean;
-}

package/component-fs.ts

@@ -1,60 +0,0 @@
-import { MemoryFS } from '@teambit/any-fs';
-import type { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';
-import { auto } from '@teambit/legacy/dist/utils/eol';
-import path from 'path';
-import minimatch from 'minimatch';
-
-/**
- * The virtual component filesystem
- */
-export default class ComponentFS extends MemoryFS {
-  constructor(
-    /**
-     * array of all fs files.
-     */
-    readonly files: AbstractVinyl[]
-  ) {
-    super();
-  }
-  /**
-   * hash to represent all contents within this filesystem volume.
-   */
-  get hash() {
-    return '';
-  }
-
-  /**
-   * filter all component files by regex.
-   */
-  byRegex(extension: RegExp): AbstractVinyl[] {
-    return this.files.filter((file) => file.path.match(extension));
-  }
-
-  /**
-   * filter all files using an array of glob patterns.
-   */
-  byGlob(patterns: string[]) {
-    return this.files.filter((file) => {
-      return patterns.find((pattern) => {
-        const match = minimatch(file.relative, pattern);
-        return match;
-      });
-    });
-  }
-
-  toObject() {}
-
-  toJSON() {}
-
-  static fromVinyls(files: AbstractVinyl[]) {
-    const fs = new ComponentFS(files);
-    files.forEach((file) => {
-      let dirPath = file.relativeDir;
-      if (!dirPath.startsWith('/')) dirPath = path.join('/', dirPath);
-      fs.mkdirpSync(dirPath);
-      fs.writeFileSync(`/${file.relative}`, auto(file.contents || ''));
-    });
-
-    return fs;
-  }
-}

package/component-map/component-map.ts

@@ -1,106 +0,0 @@
-import { ComponentID } from '@teambit/component-id';
-import { Component } from '../component';
-
-/**
- * allows to index components -> values.
- */
-export class ComponentMap<T> {
-  constructor(readonly hashMap: Map<string, [Component, T]>) {}
-
-  /**
-   * @deprecated please use `get` instead
-   */
-  byComponent(component: Component) {
-    return this.hashMap.get(component.id.toString());
-  }
-
-  get components() {
-    return this.toArray().map(([component]) => component);
-  }
-
-  /**
-   * get a value for a component.
-   */
-  get(component: Component) {
-    return this.hashMap.get(component.id.toString());
-  }
-
-  /**
-   * get a value by the component-id
-   */
-  getValueByComponentId(componentId: ComponentID): T | null {
-    const tuple = this.hashMap.get(componentId.toString());
-    if (!tuple) return null;
-    return tuple[1];
-  }
-
-  /**
-   * returns an array.
-   */
-  toArray() {
-    return Array.from(this.hashMap.values());
-  }
-
-  /**
-   * map entries and return a new component map.
-   */
-  map<NewType>(predicate: (value: T, component: Component) => NewType): ComponentMap<NewType> {
-    const tuples: [string, [Component, NewType]][] = this.toArray().map(([component, value]) => {
-      const newValue = predicate(value, component);
-      return [component.id.toString(), [component, newValue]];
-    });
-
-    return new ComponentMap(new Map(tuples));
-  }
-  /**
-   * flatten values of all components into a single array.
-   */
-  flattenValue(): T[] {
-    return this.toArray().reduce((acc: T[], [, value]) => {
-      acc = acc.concat(value);
-      return acc;
-    }, []);
-  }
-
-  /**
-   * filter all components with empty values and return a new map.
-   */
-  filter(predicate: (value: T) => boolean): ComponentMap<T> {
-    const tuples = this.toArray().filter(([, value]) => {
-      return predicate(value);
-    });
-
-    const asMap: [string, [Component, T]][] = tuples.map(([component, value]) => {
-      return [component.id.toString(), [component, value]];
-    });
-
-    return new ComponentMap(new Map(asMap));
-  }
-
-  /**
-   * get all component ids.
-   */
-  keys() {
-    return this.hashMap.keys();
-  }
-
-  static create<U>(rawMap: [Component, U][]) {
-    const newMap: [string, [Component, U]][] = rawMap.map(([component, data]) => {
-      return [component.id.toString(), [component, data]];
-    });
-    return new ComponentMap(new Map(newMap));
-  }
-
-  /**
-   * create a component map from components and a value predicate.
-   * @param components components to zip into the map.
-   * @param predicate predicate for returning desired value.
-   */
-  static as<U>(components: Component[], predicate: (component: Component) => U): ComponentMap<U> {
-    const tuples: [string, [Component, U]][] = components.map((component) => {
-      return [component.id.toString(), [component, predicate(component)]];
-    });
-
-    return new ComponentMap(new Map(tuples));
-  }
-}

package/component-map/index.ts

@@ -1 +0,0 @@
-export { ComponentMap } from './component-map';

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.docs.mdx

@@ -1,8 +0,0 @@
----
-description: Component aspect for Bit components
-labels: ['component', 'bit', 'extension', 'aspect']
----
-
-import { Component } from '@teambit/component.aspect-docs.component';
-
-<Component />

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