@teambit/component 1.0.227 → 1.0.229

package/dist/aspect-entry.d.ts

@@ -0,0 +1,39 @@
+/**
+ * avoid importing any (non-type) legacy code here. otherwise, PreviewTask will throw cryptic errors
+ */
+import type { ExtensionDataEntry } from '@teambit/legacy/dist/consumer/config/extension-data';
+import { ComponentID } from '@teambit/component-id';
+import { RawComponentMetadata } from './component-interface';
+export type Serializable = {
+    toString(): string;
+};
+export type SerializableMap = {
+    [key: string]: Serializable;
+};
+export type AspectData = {
+    [key: string]: any;
+};
+export type ResolveComponentIdFunc = (id: string) => Promise<ComponentID>;
+export declare class AspectEntry {
+    id: ComponentID;
+    private legacyEntry;
+    constructor(id: ComponentID, legacyEntry: ExtensionDataEntry);
+    get legacy(): ExtensionDataEntry;
+    get isLegacy(): boolean;
+    get config(): {
+        [key: string]: any;
+    };
+    set config(config: {
+        [key: string]: any;
+    });
+    get data(): {
+        [key: string]: any;
+    };
+    get isRemoved(): boolean;
+    set data(val: {
+        [key: string]: any;
+    });
+    transform(newData: SerializableMap): AspectEntry;
+    clone(): AspectEntry;
+    serialize(): RawComponentMetadata;
+}

package/dist/aspect-list.d.ts

@@ -0,0 +1,43 @@
+import { ExtensionDataList } 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 declare class AspectList {
+    readonly entries: AspectEntry[];
+    constructor(entries: AspectEntry[]);
+    addEntry(aspectId: ComponentID, data?: SerializableMap): AspectEntry;
+    upsertEntry(aspectId: ComponentID, data?: SerializableMap): AspectEntry;
+    /**
+     * transform an aspect list into a new one without the given aspect ids
+     */
+    withoutEntries(aspectIds: string[]): AspectList;
+    /**
+     * get all ids as strings from the aspect list.
+     */
+    get ids(): string[];
+    /**
+     * get an aspect from the list using a serialized ID.
+     */
+    get(id: string): AspectEntry | undefined;
+    /**
+     * find aspect by component ID.
+     */
+    find(id: ComponentID, ignoreVersion?: boolean): AspectEntry | undefined;
+    /**
+     * transform an aspect list into a new one.
+     */
+    map(predicate: (entry: AspectEntry) => AspectEntry): AspectList;
+    /**
+     * transform an aspect list into a new one.
+     */
+    pmap(predicate: (entry: AspectEntry) => Promise<AspectEntry>): Promise<AspectList>;
+    toConfigObject(): {};
+    serialize(): import("./component-interface").RawComponentMetadata[];
+    filter(ids?: string[]): AspectList;
+    toLegacy(): ExtensionDataList;
+    stringIds(): string[];
+    clone(): AspectList;
+    static fromLegacyExtensions(legacyDataList: ExtensionDataList): AspectList;
+}

package/dist/aspect.section.d.ts

@@ -0,0 +1,13 @@
+import { Section } from './section';
+export declare class AspectSection implements Section {
+    route: {
+        path: string;
+        element: import("react/jsx-runtime").JSX.Element;
+    };
+    navigationLink: {
+        href: string;
+        children: import("react/jsx-runtime").JSX.Element;
+        displayName: string;
+    };
+    order: number;
+}

package/dist/component-factory.d.ts

@@ -0,0 +1,150 @@
+import { Graph } from '@teambit/graph.cleargraph';
+import { BitId } from '@teambit/legacy-bit-id';
+import { ComponentID } from '@teambit/component-id';
+import ConsumerComponent from '@teambit/legacy/dist/consumer/component';
+import { CompIdGraph } from '@teambit/graph';
+import type { ComponentLog } from '@teambit/legacy/dist/scope/models/model-component';
+import type { AspectDefinition } from '@teambit/aspect-loader';
+import type { DependencyList } from '@teambit/dependency-resolver';
+import { Component, InvalidComponent } from './component';
+import { State } from './state';
+import { Snap } from './snap';
+export type ResolveAspectsOptions = FilterAspectsOptions & {
+    throwOnError?: boolean;
+    useScopeAspectsCapsule?: boolean;
+    workspaceName?: string;
+    skipDeps?: boolean;
+    resolveEnvsFromRoots?: boolean;
+    packageManagerConfigRootDir?: string;
+};
+export type LoadAspectsOptions = {
+    throwOnError?: boolean;
+    hideMissingModuleError?: boolean;
+    ignoreErrors?: boolean;
+    [key: string]: any;
+};
+export type FilterAspectsOptions = {
+    /**
+     * Do not return results for the core aspects
+     */
+    excludeCore?: boolean;
+    /**
+     * Only return results for the provided list of ids
+     */
+    requestedOnly?: boolean;
+    /**
+     * Only return results for aspects that have a path to the specified runtime name
+     */
+    filterByRuntime?: boolean;
+};
+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 | BitId | ComponentID): Promise<ComponentID>;
+    /**
+     * resolve multiple `string` component ID to an instance of a ComponentID.
+     */
+    resolveMultipleComponentIds(ids: (string | BitId | ComponentID)[]): Promise<ComponentID[]>;
+    /**
+     * returns a component by ID.
+     */
+    get(id: ComponentID): Promise<Component | undefined>;
+    /**
+     * returns the legacy representation of a component with minimal loading.
+     * when loaded from the workspace, it won't run any Harmony hooks and even won't load dependencies.
+     * it's good to get raw aspects data or some basic properties.
+     * use carefully. prefer using `get()` instead.
+     */
+    getLegacyMinimal(id: ComponentID): Promise<ConsumerComponent | 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>;
+    /**
+     * important - prefer using `getGraphIds()` if you don't need the component objects.
+     * this method has a performance penalty. it must import all flattened-dependencies objects from the remotes.
+     */
+    getGraph(ids?: ComponentID[], shouldThrowOnMissingDep?: boolean): Promise<Graph<Component, string>>;
+    /**
+     * get graph of the given component-ids and all their dependencies (recursively/flattened).
+     * the nodes are ComponentIds and is much faster than `this.getGraph()`.
+     */
+    getGraphIds(ids?: ComponentID[], shouldThrowOnMissingDep?: boolean): Promise<CompIdGraph>;
+    getLogs(id: ComponentID, shortHash?: boolean, startsFrom?: string): Promise<ComponentLog[]>;
+    getDependencies(component: Component): DependencyList;
+    componentPackageName(component: Component): string;
+    /**
+     * 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 aspects.
+     * returns the loaded aspect ids including the loaded versions.
+     */
+    loadAspects: (ids: string[], throwOnError?: boolean, neededFor?: string, opts?: any) => Promise<string[]>;
+    /**
+     * Resolve dirs for aspects
+     */
+    resolveAspects: (runtimeName?: string, componentIds?: ComponentID[], opts?: ResolveAspectsOptions) => 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[]> | ComponentID[];
+    /**
+     * get component-ids matching the given pattern. a pattern can have multiple patterns separated by a comma.
+     * it uses multimatch (https://www.npmjs.com/package/multimatch) package for the matching algorithm, which supports
+     * (among others) negate character "!" to exclude ids. See the package page for more supported characters.
+     */
+    idsByPattern(pattern: string, throwForNoMatch?: boolean): 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>;
+    /**
+     * whether a component is not the same as its head.
+     * for a new component, it'll return "true" as it has no head yet.
+     * this is relevant for component from the workspace, where it can be locally changed. on the scope it's always false
+     */
+    isModified(component: Component): Promise<boolean>;
+    /**
+     * write the component to the filesystem when applicable (no-op for scope).
+     * to change the component-path, specify the "rootPath", which should be a relative path inside the workspace.
+     */
+    write(component: Component, rootPath?: string): Promise<void>;
+    /**
+     * determine whether host should be the prior one in case multiple hosts persist.
+     */
+    priority?: boolean;
+}

package/dist/component-factory.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sources":["component-factory.ts"],"sourcesContent":["import { Graph } from '@teambit/graph.cleargraph';\nimport { BitId } from '@teambit/legacy-bit-id';\nimport { ComponentID } from '@teambit/component-id';\nimport ConsumerComponent from '@teambit/legacy/dist/consumer/component';\nimport { CompIdGraph } from '@teambit/graph';\nimport type { ComponentLog } from '@teambit/legacy/dist/scope/models/model-component';\nimport type { AspectDefinition } from '@teambit/aspect-loader';\nimport type { DependencyList } from '@teambit/dependency-resolver';\nimport { Component, InvalidComponent } from './component';\nimport { State } from './state';\nimport { Snap } from './snap';\n\nexport type ResolveAspectsOptions = FilterAspectsOptions & {\n  throwOnError?: boolean;\n  useScopeAspectsCapsule?: boolean;\n  workspaceName?: string;\n  skipDeps?: boolean;\n  resolveEnvsFromRoots?: boolean;\n  packageManagerConfigRootDir?: string;\n};\n\nexport type LoadAspectsOptions = {\n  /* `throwOnError` is an optional parameter that can be passed to the loadAspects method in the `ComponentFactory` interface. If\n  set to `true`, it will cause the method to throw an error if an error occurs during its execution. If set to `false`\n  or not provided, the method will print a warning instead of throwing it. */\n  throwOnError?: boolean;\n  /* `hideMissingModuleError` is an optional parameter that can be passed to the `loadAspects` method in the\n  `ComponentFactory` interface. If set to `true`, it will prevent the method from throwing/printing an error if a required module\n  is missing during the loading of an aspect. Instead, it will continue loading the other\n  aspects. If set to `false` or not provided, the method will print/throw an error if a required module is missing.\n  (considering throwOnError as well) */\n  hideMissingModuleError?: boolean;\n\n  /* The `ignoreErrors` property is an optional boolean parameter that can be passed to the `LoadAspectsOptions` object in\n  the `ComponentFactory` interface. If set to `true`, it will cause the `loadAspects` method to ignore any errors that\n  occur during the loading of aspects and continue loading the other aspects. If set to `false` or not provided, the\n  method will print/throw an error if a required module is missing or if any other error occurs during the loading of\n  aspects. */\n  ignoreErrors?: boolean;\n  [key: string]: any;\n};\n\nexport type FilterAspectsOptions = {\n  /**\n   * Do not return results for the core aspects\n   */\n  excludeCore?: boolean;\n  /**\n   * Only return results for the provided list of ids\n   */\n  requestedOnly?: boolean;\n  /**\n   * Only return results for aspects that have a path to the specified runtime name\n   */\n  filterByRuntime?: boolean;\n};\n\nexport interface ComponentFactory {\n  /**\n   * name of the component host.\n   */\n  name: string;\n\n  /**\n   * path to the component host.\n   */\n  path: string;\n\n  isLegacy: boolean;\n\n  /**\n   * resolve a `string` component ID to an instance of a ComponentID.\n   */\n  resolveComponentId(id: string | BitId | ComponentID): Promise<ComponentID>;\n\n  /**\n   * resolve multiple `string` component ID to an instance of a ComponentID.\n   */\n  resolveMultipleComponentIds(ids: (string | BitId | ComponentID)[]): Promise<ComponentID[]>;\n\n  /**\n   * returns a component by ID.\n   */\n  get(id: ComponentID): Promise<Component | undefined>;\n\n  /**\n   * returns the legacy representation of a component with minimal loading.\n   * when loaded from the workspace, it won't run any Harmony hooks and even won't load dependencies.\n   * it's good to get raw aspects data or some basic properties.\n   * use carefully. prefer using `get()` instead.\n   */\n  getLegacyMinimal(id: ComponentID): Promise<ConsumerComponent | undefined>;\n\n  /**\n   * returns many components by ids.\n   */\n  getMany(ids: ComponentID[]): Promise<Component[]>;\n\n  /**\n   * returns many components by their legacy representation.\n   */\n  getManyByLegacy(components: ConsumerComponent[]): Promise<Component[]>;\n\n  /**\n   * get a component from a remote without importing it\n   */\n  getRemoteComponent?: (id: ComponentID) => Promise<Component>;\n\n  /**\n   * important - prefer using `getGraphIds()` if you don't need the component objects.\n   * this method has a performance penalty. it must import all flattened-dependencies objects from the remotes.\n   */\n  getGraph(ids?: ComponentID[], shouldThrowOnMissingDep?: boolean): Promise<Graph<Component, string>>;\n\n  /**\n   * get graph of the given component-ids and all their dependencies (recursively/flattened).\n   * the nodes are ComponentIds and is much faster than `this.getGraph()`.\n   */\n  getGraphIds(ids?: ComponentID[], shouldThrowOnMissingDep?: boolean): Promise<CompIdGraph>;\n\n  getLogs(id: ComponentID, shortHash?: boolean, startsFrom?: string): Promise<ComponentLog[]>;\n\n  getDependencies(component: Component): DependencyList;\n\n  /**\n   * returns a specific state of a component by hash or semver.\n   */\n  getState(id: ComponentID, snapId: string): Promise<State>;\n\n  /**\n   * returns a specific snap of a component by hash.\n   */\n  getSnap(id: ComponentID, snapId: string): Promise<Snap>;\n\n  /**\n   * load aspects.\n   * returns the loaded aspect ids including the loaded versions.\n   */\n  loadAspects: (ids: string[], throwOnError?: boolean, neededFor?: string, opts?: any) => Promise<string[]>;\n\n  /**\n   * Resolve dirs for aspects\n   */\n  resolveAspects: (\n    runtimeName?: string,\n    componentIds?: ComponentID[],\n    opts?: ResolveAspectsOptions\n  ) => Promise<AspectDefinition[]>;\n\n  /**\n   * list all components in the host.\n   */\n  list(filter?: { offset: number; limit: number }): Promise<Component[]>;\n\n  /**\n   * list invalid components, such as components with missing files on the fs.\n   */\n  listInvalid(): Promise<InvalidComponent[]>;\n\n  listIds(): Promise<ComponentID[]> | ComponentID[];\n\n  /**\n   * get component-ids matching the given pattern. a pattern can have multiple patterns separated by a comma.\n   * it uses multimatch (https://www.npmjs.com/package/multimatch) package for the matching algorithm, which supports\n   * (among others) negate character \"!\" to exclude ids. See the package page for more supported characters.\n   */\n  idsByPattern(pattern: string, throwForNoMatch?: boolean): Promise<ComponentID[]>;\n\n  hasId(componentId: ComponentID): Promise<boolean>;\n\n  /**\n   * Check if the host has the id, if no, search for the id in inner host (for example, workspace will search in the scope)\n   * @param componentId\n   */\n  hasIdNested(componentId: ComponentID, includeCache?: boolean): Promise<boolean>;\n\n  /**\n   * whether a component is not the same as its head.\n   * for a new component, it'll return \"true\" as it has no head yet.\n   * this is relevant for component from the workspace, where it can be locally changed. on the scope it's always false\n   */\n  isModified(component: Component): Promise<boolean>;\n\n  /**\n   * write the component to the filesystem when applicable (no-op for scope).\n   * to change the component-path, specify the \"rootPath\", which should be a relative path inside the workspace.\n   */\n  write(component: Component, rootPath?: string): Promise<void>;\n\n  /**\n   * determine whether host should be the prior one in case multiple hosts persist.\n   */\n  priority?: boolean;\n}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"names":[],"sources":["component-factory.ts"],"sourcesContent":["import { Graph } from '@teambit/graph.cleargraph';\nimport { BitId } from '@teambit/legacy-bit-id';\nimport { ComponentID } from '@teambit/component-id';\nimport ConsumerComponent from '@teambit/legacy/dist/consumer/component';\nimport { CompIdGraph } from '@teambit/graph';\nimport type { ComponentLog } from '@teambit/legacy/dist/scope/models/model-component';\nimport type { AspectDefinition } from '@teambit/aspect-loader';\nimport type { DependencyList } from '@teambit/dependency-resolver';\nimport { Component, InvalidComponent } from './component';\nimport { State } from './state';\nimport { Snap } from './snap';\n\nexport type ResolveAspectsOptions = FilterAspectsOptions & {\n  throwOnError?: boolean;\n  useScopeAspectsCapsule?: boolean;\n  workspaceName?: string;\n  skipDeps?: boolean;\n  resolveEnvsFromRoots?: boolean;\n  packageManagerConfigRootDir?: string;\n};\n\nexport type LoadAspectsOptions = {\n  /* `throwOnError` is an optional parameter that can be passed to the loadAspects method in the `ComponentFactory` interface. If\n  set to `true`, it will cause the method to throw an error if an error occurs during its execution. If set to `false`\n  or not provided, the method will print a warning instead of throwing it. */\n  throwOnError?: boolean;\n  /* `hideMissingModuleError` is an optional parameter that can be passed to the `loadAspects` method in the\n  `ComponentFactory` interface. If set to `true`, it will prevent the method from throwing/printing an error if a required module\n  is missing during the loading of an aspect. Instead, it will continue loading the other\n  aspects. If set to `false` or not provided, the method will print/throw an error if a required module is missing.\n  (considering throwOnError as well) */\n  hideMissingModuleError?: boolean;\n\n  /* The `ignoreErrors` property is an optional boolean parameter that can be passed to the `LoadAspectsOptions` object in\n  the `ComponentFactory` interface. If set to `true`, it will cause the `loadAspects` method to ignore any errors that\n  occur during the loading of aspects and continue loading the other aspects. If set to `false` or not provided, the\n  method will print/throw an error if a required module is missing or if any other error occurs during the loading of\n  aspects. */\n  ignoreErrors?: boolean;\n  [key: string]: any;\n};\n\nexport type FilterAspectsOptions = {\n  /**\n   * Do not return results for the core aspects\n   */\n  excludeCore?: boolean;\n  /**\n   * Only return results for the provided list of ids\n   */\n  requestedOnly?: boolean;\n  /**\n   * Only return results for aspects that have a path to the specified runtime name\n   */\n  filterByRuntime?: boolean;\n};\n\nexport interface ComponentFactory {\n  /**\n   * name of the component host.\n   */\n  name: string;\n\n  /**\n   * path to the component host.\n   */\n  path: string;\n\n  isLegacy: boolean;\n\n  /**\n   * resolve a `string` component ID to an instance of a ComponentID.\n   */\n  resolveComponentId(id: string | BitId | ComponentID): Promise<ComponentID>;\n\n  /**\n   * resolve multiple `string` component ID to an instance of a ComponentID.\n   */\n  resolveMultipleComponentIds(ids: (string | BitId | ComponentID)[]): Promise<ComponentID[]>;\n\n  /**\n   * returns a component by ID.\n   */\n  get(id: ComponentID): Promise<Component | undefined>;\n\n  /**\n   * returns the legacy representation of a component with minimal loading.\n   * when loaded from the workspace, it won't run any Harmony hooks and even won't load dependencies.\n   * it's good to get raw aspects data or some basic properties.\n   * use carefully. prefer using `get()` instead.\n   */\n  getLegacyMinimal(id: ComponentID): Promise<ConsumerComponent | undefined>;\n\n  /**\n   * returns many components by ids.\n   */\n  getMany(ids: ComponentID[]): Promise<Component[]>;\n\n  /**\n   * returns many components by their legacy representation.\n   */\n  getManyByLegacy(components: ConsumerComponent[]): Promise<Component[]>;\n\n  /**\n   * get a component from a remote without importing it\n   */\n  getRemoteComponent?: (id: ComponentID) => Promise<Component>;\n\n  /**\n   * important - prefer using `getGraphIds()` if you don't need the component objects.\n   * this method has a performance penalty. it must import all flattened-dependencies objects from the remotes.\n   */\n  getGraph(ids?: ComponentID[], shouldThrowOnMissingDep?: boolean): Promise<Graph<Component, string>>;\n\n  /**\n   * get graph of the given component-ids and all their dependencies (recursively/flattened).\n   * the nodes are ComponentIds and is much faster than `this.getGraph()`.\n   */\n  getGraphIds(ids?: ComponentID[], shouldThrowOnMissingDep?: boolean): Promise<CompIdGraph>;\n\n  getLogs(id: ComponentID, shortHash?: boolean, startsFrom?: string): Promise<ComponentLog[]>;\n\n  getDependencies(component: Component): DependencyList;\n\n  componentPackageName(component: Component): string;\n\n  /**\n   * returns a specific state of a component by hash or semver.\n   */\n  getState(id: ComponentID, snapId: string): Promise<State>;\n\n  /**\n   * returns a specific snap of a component by hash.\n   */\n  getSnap(id: ComponentID, snapId: string): Promise<Snap>;\n\n  /**\n   * load aspects.\n   * returns the loaded aspect ids including the loaded versions.\n   */\n  loadAspects: (ids: string[], throwOnError?: boolean, neededFor?: string, opts?: any) => Promise<string[]>;\n\n  /**\n   * Resolve dirs for aspects\n   */\n  resolveAspects: (\n    runtimeName?: string,\n    componentIds?: ComponentID[],\n    opts?: ResolveAspectsOptions\n  ) => Promise<AspectDefinition[]>;\n\n  /**\n   * list all components in the host.\n   */\n  list(filter?: { offset: number; limit: number }): Promise<Component[]>;\n\n  /**\n   * list invalid components, such as components with missing files on the fs.\n   */\n  listInvalid(): Promise<InvalidComponent[]>;\n\n  listIds(): Promise<ComponentID[]> | ComponentID[];\n\n  /**\n   * get component-ids matching the given pattern. a pattern can have multiple patterns separated by a comma.\n   * it uses multimatch (https://www.npmjs.com/package/multimatch) package for the matching algorithm, which supports\n   * (among others) negate character \"!\" to exclude ids. See the package page for more supported characters.\n   */\n  idsByPattern(pattern: string, throwForNoMatch?: boolean): Promise<ComponentID[]>;\n\n  hasId(componentId: ComponentID): Promise<boolean>;\n\n  /**\n   * Check if the host has the id, if no, search for the id in inner host (for example, workspace will search in the scope)\n   * @param componentId\n   */\n  hasIdNested(componentId: ComponentID, includeCache?: boolean): Promise<boolean>;\n\n  /**\n   * whether a component is not the same as its head.\n   * for a new component, it'll return \"true\" as it has no head yet.\n   * this is relevant for component from the workspace, where it can be locally changed. on the scope it's always false\n   */\n  isModified(component: Component): Promise<boolean>;\n\n  /**\n   * write the component to the filesystem when applicable (no-op for scope).\n   * to change the component-path, specify the \"rootPath\", which should be a relative path inside the workspace.\n   */\n  write(component: Component, rootPath?: string): Promise<void>;\n\n  /**\n   * determine whether host should be the prior one in case multiple hosts persist.\n   */\n  priority?: boolean;\n}\n"],"mappings":"","ignoreList":[]}

package/dist/component-fs.d.ts

@@ -0,0 +1,34 @@
+/// <reference types="node" />
+import { MemoryFS } from '@teambit/any-fs';
+import type { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';
+/**
+ * The virtual component filesystem
+ */
+export default class ComponentFS extends MemoryFS {
+    /**
+     * array of all fs files.
+     */
+    readonly files: AbstractVinyl[];
+    constructor(
+    /**
+     * array of all fs files.
+     */
+    files: AbstractVinyl[]);
+    /**
+     * hash to represent all contents within this filesystem volume.
+     */
+    get hash(): string;
+    /**
+     * filter all component files by regex.
+     */
+    byRegex(extension: RegExp): AbstractVinyl[];
+    /**
+     * filter all files using an array of glob patterns.
+     */
+    byGlob(patterns: string[]): AbstractVinyl[];
+    toObject(): {
+        path: string;
+        contents: Buffer;
+    }[];
+    static fromVinyls(files: AbstractVinyl[]): ComponentFS;
+}

package/dist/component-interface.d.ts

@@ -0,0 +1,22 @@
+import { ComponentID } from '@teambit/component-id';
+export interface IComponent {
+    /**
+     * id of the component.
+     */
+    id: ComponentID;
+    /**
+     * get function to retrieve aspect
+     */
+    get(aspectId: string): RawComponentMetadata | undefined;
+    /**
+     * determines whether a component is a modified state.
+     * TODO: consider to remove after handling component descriptors correctly.
+     */
+    isModified(): Promise<boolean>;
+}
+export type RawComponentMetadata = {
+    id: string;
+    config: Record<string, any>;
+    data: Record<string, any>;
+    icon?: string;
+};

package/dist/component-map/component-map.d.ts

@@ -0,0 +1,63 @@
+import { ComponentID } from '@teambit/component-id';
+import { Component } from '../component';
+/**
+ * allows to index components -> values.
+ */
+export declare class ComponentMap<T> {
+    readonly hashMap: Map<string, [Component, T]>;
+    constructor(hashMap: Map<string, [Component, T]>);
+    /**
+     * @deprecated please use `get` instead
+     */
+    byComponent(component: Component): [Component, T] | undefined;
+    get components(): Component[];
+    /**
+     * get a value for a component.
+     */
+    get(component: Component): [Component, T] | undefined;
+    /**
+     * get a value by the component-id
+     */
+    getValueByComponentId(componentId: ComponentID): T | null;
+    /**
+     * returns an array.
+     */
+    toArray(): [Component, T][];
+    /**
+     * map entries and return a new component map.
+     */
+    map<NewType>(predicate: (value: T, component: Component) => NewType): ComponentMap<NewType>;
+    /**
+     * map entries and return a new component map.
+     */
+    asyncMap<NewType>(predicate: (value: T, component: Component) => Promise<NewType>): Promise<ComponentMap<NewType>>;
+    /**
+     * similar to Array.forEach, but here you get both, the value and the component.
+     */
+    forEach(predicate: (value: T, component: Component) => void): void;
+    /**
+     * flatten values of all components into a single array.
+     */
+    flattenValue(): T[];
+    /**
+     * filter all components with empty values and return a new map.
+     */
+    filter(predicate: (value: T) => boolean): ComponentMap<T>;
+    /**
+     * get all component ids.
+     */
+    keys(): IterableIterator<string>;
+    static create<U>(rawMap: [Component, U][]): ComponentMap<U>;
+    /**
+     * 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>;
+    /**
+     * 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 asAsync<U>(components: Component[], predicate: (component: Component) => Promise<U>): Promise<ComponentMap<U>>;
+}

package/dist/component-map/index.d.ts

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

package/dist/component-meta.d.ts

@@ -0,0 +1,22 @@
+import { ComponentID, ComponentIdObj } from '@teambit/component-id';
+export declare class ComponentMeta {
+    /**
+     * id the component.
+     */
+    readonly id: ComponentID;
+    constructor(
+    /**
+     * id the component.
+     */
+    id: ComponentID);
+    /**
+     * display name of the component.
+     */
+    get displayName(): string;
+    toObject(): {
+        id: ComponentIdObj;
+    };
+    static from(object: {
+        [key: string]: any;
+    }): ComponentMeta;
+}

package/dist/component.aspect.d.ts

@@ -0,0 +1,3 @@
+import { Aspect } from '@teambit/harmony';
+export declare const ComponentAspect: Aspect;
+export default ComponentAspect;

package/dist/component.composition.d.ts

@@ -0,0 +1 @@
+export declare const Logo: () => import("react/jsx-runtime").JSX.Element;

package/dist/component.d.ts

@@ -0,0 +1,183 @@
+import { AnyFS } from '@teambit/any-fs';
+import { SemVer } from 'semver';
+import { ComponentID } from '@teambit/component-id';
+import { BuildStatus } from '@teambit/legacy/dist/constants';
+import { ComponentLog } from '@teambit/legacy/dist/scope/models/model-component';
+import type { DependencyList } from '@teambit/dependency-resolver';
+import { ComponentFactory } from './component-factory';
+import ComponentFS from './component-fs';
+import { Config as ComponentConfig } from './config';
+import { Snap } from './snap';
+import { State } from './state';
+import { TagMap } from './tag-map';
+import { Tag } from './tag';
+import { IComponent, RawComponentMetadata } from './component-interface';
+type SnapsIterableOpts = {
+    firstParentOnly?: boolean;
+    stopFn?: (snap: Snap) => Promise<boolean>;
+};
+export type InvalidComponent = {
+    id: ComponentID;
+    err: Error;
+};
+/**
+ * in-memory representation of a component.
+ */
+export declare class Component implements IComponent {
+    /**
+     * component ID represented by the `ComponentId` type.
+     */
+    readonly id: ComponentID;
+    /**
+     * head version of the component. can be `null` for new components.
+     * if on main, returns the head on main.
+     * if on a lane, returns the head on the lane.
+     */
+    readonly head: Snap | null;
+    /**
+     * state of the component.
+     */
+    private _state;
+    /**
+     * tags of the component.
+     */
+    readonly tags: TagMap;
+    /**
+     * the component factory
+     */
+    private factory;
+    constructor(
+    /**
+     * component ID represented by the `ComponentId` type.
+     */
+    id: ComponentID, 
+    /**
+     * head version of the component. can be `null` for new components.
+     * if on main, returns the head on main.
+     * if on a lane, returns the head on the lane.
+     */
+    head: Snap | null, 
+    /**
+     * state of the component.
+     */
+    _state: State, 
+    /**
+     * tags of the component.
+     */
+    tags: TagMap, 
+    /**
+     * the component factory
+     */
+    factory: ComponentFactory);
+    get mainFile(): import("@teambit/legacy/dist/consumer/component/sources").AbstractVinyl;
+    get state(): State;
+    set state(state: State);
+    /**
+     * component configuration which is later generated to a component `package.json` and `bit.json`.
+     */
+    get config(): ComponentConfig;
+    /**
+     * in-memory representation of the component current filesystem.
+     */
+    get filesystem(): ComponentFS;
+    /**
+     * build status of the component
+     */
+    get buildStatus(): BuildStatus;
+    get headTag(): Tag | undefined;
+    get latest(): string | undefined;
+    /**
+     * get aspect data from current state.
+     */
+    get(id: string): RawComponentMetadata | undefined;
+    getLogs(filter?: {
+        type?: string;
+        offset?: number;
+        limit?: number;
+        head?: string;
+        sort?: string;
+    }): Promise<ComponentLog[]>;
+    getDependencies(): DependencyList;
+    getPackageName(): string;
+    stringify(): string;
+    /**
+     * record component changes in the `Scope`.
+     */
+    /**
+     * display name of the component.
+     */
+    get displayName(): string;
+    /**
+     * tag a component `Snap` with a semantic version. we follow SemVer specs as defined [here](https://semver.org/)).
+     */
+    tag(version: SemVer): void;
+    /**
+     * determines whether this component is modified in the workspace.
+     */
+    isModified(): Promise<boolean>;
+    /**
+     * whether a component is marked as deleted.
+     */
+    isDeleted(): boolean;
+    /**
+     * is component isOutdated
+     */
+    isOutdated(): boolean;
+    /**
+     * determines whether this component is new.
+     */
+    isNew(): Promise<boolean>;
+    loadState(snapId: string): Promise<State>;
+    loadSnap(snapId?: string): Promise<Snap>;
+    /**
+     * Get iterable which iterate over snap parents lazily
+     * @param snapId
+     * @param options
+     */
+    snapsIterable(snapId?: string, options?: SnapsIterableOpts): AsyncIterable<Snap>;
+    /**
+     * traverse recursively from the provided snap (or head) upwards until it finds a tag
+     * @param snapToStartFrom
+     */
+    getClosestTag(snapToStartFrom?: string): Promise<Tag | undefined>;
+    /**
+     * id.version can be either a tag or a hash.
+     * if it's a hash, it may have a tag point to it. if it does, return the tag.
+     */
+    getTag(): Tag | undefined;
+    /**
+     * id.version can be either a tag or a hash.
+     * if it's a tag, find the hash it points to.
+     */
+    getSnapHash(): string | undefined;
+    /**
+     * in case a component is new, it returns undefined.
+     * otherwise, it returns the Snap object (hash/parents/log) of the current component (according to the version in the id)
+     */
+    getCurrentSnap(): Promise<Snap | undefined>;
+    /**
+     * checkout the component to a different version in its working tree.
+     */
+    checkout(version: SemVer): void;
+    /**
+     * examine difference between two components.
+     */
+    /**
+     * merge two different components
+     */
+    /**
+     * write a component to a given file system.
+     * @param path root path to write the component
+     * @param fs instance of any fs to use.
+     */
+    write(path: string, fs?: AnyFS): void;
+    /**
+     *
+     * Check if 2 components are equal
+     * @param {Component} component
+     * @returns {boolean}
+     * @memberof Component
+     */
+    equals(component: Component): boolean;
+}
+export {};