@teambit/component 0.0.551 → 0.0.556

package/dist/tag/tag.d.ts

@@ -3,10 +3,30 @@ export declare type TagProps = {
     hash: string;
     version: string;
 };
+/**
+ * `Tag` provides a sematic reference to a specific state `Snap` in the working tree.
+ */
 export declare class Tag {
+    /**
+     * tag hash, can be used to load it by component-factory.getSnap
+     */
     readonly hash: string;
+    /**
+     * sematic version of the snap.
+     */
     readonly version: SemVer;
-    constructor(hash: string, version: SemVer);
+    constructor(
+    /**
+     * tag hash, can be used to load it by component-factory.getSnap
+     */
+    hash: string, 
+    /**
+     * sematic version of the snap.
+     */
+    version: SemVer);
+    /**
+     * create a plain tag object.
+     */
     toObject(): TagProps;
     static fromObject(tag: TagProps): Tag;
 }

package/dist/tag-map.d.ts

@@ -2,13 +2,32 @@ import { SemVer } from 'semver';
 import { Hash } from './hash';
 import { Tag } from './tag';
 export declare class TagMap extends Map<SemVer, Tag> {
+    /**
+     * get snap by hash.
+     */
     byHash(hash: Hash): Tag | undefined;
+    /**
+     * e.g.
+     * {
+     *   alpha: '1.0.0-alpha.5',
+     *   dev: '2.2.4-dev.37
+     * }
+     */
     getPreReleaseLatestTags(): {
         [preRelease: string]: string;
     };
+    /**
+     * Get a map that map snap hash to tag
+     */
     getHashMap(): Map<Hash, Tag>;
+    /**
+     * get the latest semver from the tag map.
+     */
     getLatest(): string;
     isEmpty(): boolean;
+    /**
+     * get an array of all tags.
+     */
     toArray(): Tag[];
     byVersion(version: string): Tag | undefined;
     static fromArray(tags: Tag[]): TagMap;

package/dist/ui/component-error/component-error.d.ts

@@ -1,6 +1,20 @@
 export declare class ComponentError {
+    /**
+     * http status code of error
+     */
     readonly code: number;
+    /**
+     * error message of the error
+     */
     readonly message?: string | undefined;
-    constructor(code: number, message?: string | undefined);
+    constructor(
+    /**
+     * http status code of error
+     */
+    code: number, 
+    /**
+     * error message of the error
+     */
+    message?: string | undefined);
     renderError(): JSX.Element;
 }

package/dist/ui/component-model/component-model.d.ts

@@ -26,23 +26,124 @@ export declare type ComponentServer = {
     url: string;
 };
 export declare class ComponentModel {
+    /**
+     * id of the component
+     */
     readonly id: ComponentID;
+    /**
+     * display name of the component.
+     */
     readonly displayName: string;
+    /**
+     * package name of the component.
+     */
     readonly packageName: string;
+    /**
+     * the component server.
+     */
     readonly server: ComponentServer | undefined;
+    /**
+     * array of compositions
+     */
     readonly compositions: Composition[];
+    /**
+     * tags of the component.
+     */
     readonly tags: TagMap;
+    /**
+     * component build status
+     */
     readonly buildStatus?: string | undefined;
+    /**
+     * issues of component.
+     */
     readonly issuesCount?: number | undefined;
+    /**
+     * elements url
+     */
     readonly elementsUrl?: string | undefined;
+    /**
+     * status of component.
+     */
     readonly status?: any;
+    /**
+     * deprecation info of the component.
+     */
     readonly deprecation?: DeprecationInfo | undefined;
+    /**
+     * env descriptor.
+     */
     readonly environment?: Descriptor | undefined;
+    /**
+     * description of the component.
+     */
     readonly description: string;
     readonly labels: string[];
+    /**
+     * host of the component
+     */
     readonly host?: string | undefined;
-    constructor(id: ComponentID, displayName: string, packageName: string, server: ComponentServer | undefined, compositions: Composition[], tags: TagMap, buildStatus?: string | undefined, issuesCount?: number | undefined, elementsUrl?: string | undefined, status?: any, deprecation?: DeprecationInfo | undefined, environment?: Descriptor | undefined, description?: string, labels?: string[], host?: string | undefined);
+    constructor(
+    /**
+     * id of the component
+     */
+    id: ComponentID, 
+    /**
+     * display name of the component.
+     */
+    displayName: string, 
+    /**
+     * package name of the component.
+     */
+    packageName: string, 
+    /**
+     * the component server.
+     */
+    server: ComponentServer | undefined, 
+    /**
+     * array of compositions
+     */
+    compositions: Composition[], 
+    /**
+     * tags of the component.
+     */
+    tags: TagMap, 
+    /**
+     * component build status
+     */
+    buildStatus?: string | undefined, 
+    /**
+     * issues of component.
+     */
+    issuesCount?: number | undefined, 
+    /**
+     * elements url
+     */
+    elementsUrl?: string | undefined, 
+    /**
+     * status of component.
+     */
+    status?: any, 
+    /**
+     * deprecation info of the component.
+     */
+    deprecation?: DeprecationInfo | undefined, 
+    /**
+     * env descriptor.
+     */
+    environment?: Descriptor | undefined, 
+    /**
+     * description of the component.
+     */
+    description?: string, labels?: string[], 
+    /**
+     * host of the component
+     */
+    host?: string | undefined);
     get version(): string;
+    /**
+     * create an instance of a component from a plain object.
+     */
     static from({ id, server, displayName, compositions, packageName, elementsUrl, tags, deprecation, buildStatus, env, status, issuesCount, description, labels, host, }: ComponentModelProps): ComponentModel;
     static fromArray(componentsProps: ComponentModelProps[]): ComponentModel[];
     static empty(): ComponentModel;

package/dist/ui/component.d.ts

@@ -13,4 +13,7 @@ export declare type ComponentProps = {
     host: string;
     onComponentChange?: (activeComponent?: ComponentModel) => void;
 };
+/**
+ * main UI component of the Component extension.
+ */
 export declare function Component({ routeSlot, containerSlot, host, onComponentChange }: ComponentProps): JSX.Element;

package/dist/ui/context/component-provider.d.ts

@@ -1,7 +1,13 @@
 import { ReactNode } from 'react';
 import { ComponentModel } from '../component-model';
 export declare type ComponentProviderProps = {
+    /**
+     * component model.
+     */
     component: ComponentModel;
+    /**
+     * component children.
+     */
     children: ReactNode;
 };
 export declare function ComponentProvider({ component, children }: ComponentProviderProps): JSX.Element;

package/dist/ui/menu/menu.d.ts

@@ -2,9 +2,21 @@ import { MenuItemSlot } from '@teambit/ui-foundation.ui.main-dropdown';
 import { OrderedNavigationSlot } from './nav-plugin';
 export declare type MenuProps = {
     className?: string;
+    /**
+     * slot for top bar menu nav items
+     */
     navigationSlot: OrderedNavigationSlot;
+    /**
+     * right side menu item slot
+     */
     widgetSlot: OrderedNavigationSlot;
     host: string;
+    /**
+     * main dropdown item slot
+     */
     menuItemSlot: MenuItemSlot;
 };
+/**
+ * top bar menu.
+ */
 export declare function Menu({ navigationSlot, widgetSlot, className, host, menuItemSlot }: MenuProps): JSX.Element;

package/dist/ui/use-component-query.d.ts

@@ -1,5 +1,6 @@
 import { ComponentModel } from './component-model';
 import { ComponentError } from './component-error';
+/** provides data to component ui page, making sure both variables and return value are safely typed and memoized */
 export declare function useComponentQuery(componentId: string, host: string): {
     component: ComponentModel | undefined;
     error: ComponentError | undefined;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/component",
-  "version": "0.0.551",
+  "version": "0.0.556",
   "homepage": "https://bit.dev/teambit/component/component",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.component",
     "name": "component",
-    "version": "0.0.551"
+    "version": "0.0.556"
   },
   "dependencies": {
     "lodash": "4.17.21",
@@ -26,38 +26,38 @@
     "@teambit/base-ui.routing.nav-link": "1.0.0",
     "@teambit/documenter.ui.heading": "4.1.1",
     "@teambit/documenter.ui.separator": "4.1.1",
-    "@teambit/component-id": "0.0.372",
-    "@teambit/ui-foundation.ui.menu-widget-icon": "0.0.461",
-    "@teambit/aspect-loader": "0.0.551",
-    "@teambit/legacy-bit-id": "0.0.371",
-    "@teambit/toolbox.string.capitalize": "0.0.456",
-    "@teambit/cli": "0.0.382",
-    "@teambit/config": "0.0.393",
-    "@teambit/express": "0.0.471",
-    "@teambit/graphql": "0.0.551",
-    "@teambit/bit-error": "0.0.368",
-    "@teambit/command-bar": "0.0.551",
-    "@teambit/preview": "0.0.551",
-    "@teambit/pubsub": "0.0.551",
-    "@teambit/ui-foundation.ui.is-browser": "0.0.459",
-    "@teambit/ui-foundation.ui.main-dropdown": "0.0.459",
-    "@teambit/ui-foundation.ui.react-router.slot-router": "0.0.461",
-    "@teambit/ui": "0.0.551",
-    "@teambit/component-issues": "0.0.17",
-    "@teambit/ui-foundation.ui.hooks.use-data-query": "0.0.460",
-    "@teambit/cli-table": "0.0.5",
-    "@teambit/ui-foundation.ui.react-router.use-query": "0.0.459",
+    "@teambit/component-id": "0.0.377",
+    "@teambit/ui-foundation.ui.menu-widget-icon": "0.0.466",
+    "@teambit/aspect-loader": "0.0.556",
+    "@teambit/legacy-bit-id": "0.0.376",
+    "@teambit/toolbox.string.capitalize": "0.0.461",
+    "@teambit/cli": "0.0.387",
+    "@teambit/config": "0.0.398",
+    "@teambit/express": "0.0.476",
+    "@teambit/graphql": "0.0.556",
+    "@teambit/bit-error": "0.0.373",
+    "@teambit/command-bar": "0.0.556",
+    "@teambit/preview": "0.0.556",
+    "@teambit/pubsub": "0.0.556",
+    "@teambit/ui-foundation.ui.is-browser": "0.0.464",
+    "@teambit/ui-foundation.ui.main-dropdown": "0.0.464",
+    "@teambit/ui-foundation.ui.react-router.slot-router": "0.0.466",
+    "@teambit/ui": "0.0.556",
+    "@teambit/component-issues": "0.0.22",
+    "@teambit/ui-foundation.ui.hooks.use-data-query": "0.0.465",
+    "@teambit/cli-table": "0.0.10",
+    "@teambit/ui-foundation.ui.react-router.use-query": "0.0.464",
     "@teambit/design.ui.empty-box": "0.0.352",
-    "@teambit/harmony.ui.aspect-box": "0.0.459",
+    "@teambit/harmony.ui.aspect-box": "0.0.464",
     "@teambit/design.ui.pages.not-found": "0.0.352",
     "@teambit/design.ui.pages.server-error": "0.0.352",
-    "@teambit/compositions": "0.0.551",
-    "@teambit/deprecation": "0.0.551",
-    "@teambit/envs": "0.0.551",
-    "@teambit/component.ui.version-dropdown": "0.0.463",
-    "@teambit/ui-foundation.ui.use-box.dropdown": "0.0.80",
-    "@teambit/ui-foundation.ui.use-box.menu": "0.0.80",
-    "@teambit/ui-foundation.ui.react-router.extend-path": "0.0.459"
+    "@teambit/compositions": "0.0.556",
+    "@teambit/deprecation": "0.0.556",
+    "@teambit/envs": "0.0.556",
+    "@teambit/component.ui.version-dropdown": "0.0.468",
+    "@teambit/ui-foundation.ui.use-box.dropdown": "0.0.85",
+    "@teambit/ui-foundation.ui.use-box.menu": "0.0.85",
+    "@teambit/ui-foundation.ui.react-router.extend-path": "0.0.464"
   },
   "devDependencies": {
     "@types/lodash": "4.14.165",
@@ -72,11 +72,11 @@
     "@types/jest": "^26.0.0",
     "@types/react-dom": "^17.0.5",
     "@types/node": "12.20.4",
-    "@teambit/component.aspect-docs.component": "0.0.101"
+    "@teambit/component.aspect-docs.component": "0.0.106"
   },
   "peerDependencies": {
     "@apollo/client": "^3.0.0",
-    "@teambit/legacy": "1.0.169",
+    "@teambit/legacy": "1.0.173",
     "react-dom": "^16.8.0 || ^17.0.0",
     "react": "^16.8.0 || ^17.0.0"
   },
@@ -104,12 +104,18 @@
         "react": "-"
       },
       "peerDependencies": {
-        "@teambit/legacy": "1.0.169",
+        "@teambit/legacy": "1.0.173",
         "react-dom": "^16.8.0 || ^17.0.0",
         "react": "^16.8.0 || ^17.0.0"
       }
     }
   },
+  "files": [
+    "dist",
+    "!dist/tsconfig.tsbuildinfo",
+    "README.md",
+    "README.mdx"
+  ],
   "private": false,
   "engines": {
     "node": ">=12.22.0"

package/aspect-entry.ts

@@ -1,67 +0,0 @@
-import { ExtensionDataEntry } from '@teambit/legacy/dist/consumer/config/extension-data';
-import { ComponentID } from '@teambit/component-id';
-
-export type Serializable = {
-  toString(): string;
-};
-
-export type SerializableMap = {
-  [key: string]: Serializable;
-};
-
-export type AspectData = {
-  [key: string]: any;
-};
-
-export class AspectEntry {
-  constructor(public id: ComponentID, private legacyEntry: ExtensionDataEntry) {}
-
-  get legacy() {
-    return this.legacyEntry;
-  }
-
-  get isLegacy(): boolean {
-    if (this.config?.__legacy) return true;
-    return false;
-  }
-
-  get config() {
-    return this.legacy.config;
-  }
-
-  set config(config) {
-    this.legacy.config = config;
-  }
-
-  get data(): { [key: string]: any } {
-    return this.legacy.data;
-  }
-
-  get isRemoved(): boolean {
-    return this.legacy.isRemoved;
-  }
-
-  // eslint-disable-next-line @typescript-eslint/adjacent-overload-signatures
-  set data(val: { [key: string]: any }) {
-    this.legacy.data = val;
-  }
-
-  transform(newData: SerializableMap): AspectEntry {
-    const newEntry = this.clone();
-    newEntry.data = newData;
-    return new AspectEntry(this.id, newEntry.legacy);
-  }
-
-  clone(): AspectEntry {
-    return new AspectEntry(this.id, this.legacyEntry.clone());
-  }
-
-  serialize() {
-    return {
-      id: this.id.toString(),
-      config: this.config,
-      data: this.data,
-      icon: 'https://static.bit.dev/extensions-icons/default.svg', // TODO @gilad - once you connect the icon here please use this url as the default icon
-    };
-  }
-}

package/aspect-list.ts

@@ -1,100 +0,0 @@
-import { isEmpty } from 'lodash';
-import { ExtensionDataList, ExtensionDataEntry } from '@teambit/legacy/dist/consumer/config/extension-data';
-import { ComponentID } from '@teambit/component-id';
-import { AspectEntry, SerializableMap } from './aspect-entry';
-
-/**
- * list of aspects, each may have data and artifacts saved per component.
- */
-export class AspectList {
-  constructor(readonly entries: AspectEntry[]) {}
-
-  addEntry(aspectId: ComponentID, data: SerializableMap = {}) {
-    const extensionDataEntry = new ExtensionDataEntry(undefined, aspectId._legacy, undefined, {}, data);
-    const entry = new AspectEntry(aspectId, extensionDataEntry);
-    this.entries.push(entry);
-    return entry;
-  }
-
-  /**
-   * get all ids as strings from the aspect list.
-   */
-  get ids(): string[] {
-    const list = this.entries.map((entry) => entry.id.toString());
-    return list;
-  }
-
-  /**
-   * get an aspect from the list using a serialized ID.
-   */
-  get(id: string): AspectEntry | undefined {
-    return this.entries.find((entry) => {
-      return entry.legacy.stringId === id;
-    });
-  }
-
-  /**
-   * find aspect by component ID.
-   */
-  find(id: ComponentID, ignoreVersion = false): AspectEntry | undefined {
-    return this.entries.find((aspectEntry) => {
-      return id.isEqual(aspectEntry.id, { ignoreVersion });
-    });
-  }
-
-  /**
-   * transform an aspect list into a new one.
-   */
-  map(predicate: (entry: AspectEntry) => AspectEntry) {
-    const entries = this.entries.map(predicate);
-    return new AspectList(entries);
-  }
-
-  /**
-   * transform an aspect list into a new one.
-   */
-  async pmap(predicate: (entry: AspectEntry) => Promise<AspectEntry>) {
-    const entriesP = this.entries.map(predicate);
-    const entries = await Promise.all(entriesP);
-    return new AspectList(entries);
-  }
-
-  toConfigObject() {
-    const res = {};
-    this.entries.forEach((entry) => {
-      if (entry.config && !isEmpty(entry.config)) {
-        res[entry.id.toString()] = entry.config;
-      }
-    });
-    return res;
-  }
-
-  serialize() {
-    const serializedEntries = this.entries.map((entry) => entry.serialize());
-    return serializedEntries;
-  }
-
-  toLegacy(): ExtensionDataList {
-    const legacyEntries = this.entries.map((entry) => entry.legacy);
-    return ExtensionDataList.fromArray(legacyEntries);
-  }
-
-  stringIds(): string[] {
-    const ids = this.entries.map((entry) => entry.id.toString());
-    return ids;
-  }
-
-  static fromLegacyExtensions(legacyDataList: ExtensionDataList, scope?: string): AspectList {
-    const newEntries = legacyDataList.map((entry) => {
-      return new AspectEntry(getAspectId(entry, scope), entry);
-    });
-
-    return new AspectList(newEntries);
-  }
-}
-
-function getAspectId(entry: ExtensionDataEntry, scope?: string) {
-  if (!entry.extensionId && entry.name) return ComponentID.fromString(entry.name);
-  if (entry.extensionId) return ComponentID.fromLegacy(entry.extensionId, scope);
-  throw new Error('aspect cannot be loaded without setting an ID');
-}

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