@teambit/workspace 0.0.554 → 0.0.555

package/dist/build-graph-from-fs.d.ts

@@ -15,6 +15,36 @@ export declare class GraphFromFsBuilder {
     private shouldThrowOnMissingDep;
     private consumer;
     constructor(workspace: Workspace, logger: Logger, ignoreIds?: BitIds, shouldLoadItsDeps?: ShouldIgnoreFunc | undefined);
+    /**
+     * create a graph with all dependencies and flattened dependencies of the given components.
+     * the nodes are components and the edges has a label of the dependency type.
+     *
+     * the way how it is done is iterations by depths. each depth we gather all the dependencies of
+     * that depths, make sure all objects exist and then check their dependencies for the next depth.
+     * once there is no dependency left, we're on the last depth level and the graph is ready.
+     *
+     * for example, imagine the following graph:
+     * A1 -> A2 -> A3
+     * B1 -> B2 -> B3
+     * C1 -> C2 -> C3
+     *
+     * where the buildGraph is given [A1, B1, C1].
+     * first, it saves all these components as nodes in the graph. then, it finds the dependencies of
+     * the next level, in this case they're [A2, B2, C2]. it runs `importMany` in case some objects
+     * are missing. then, it loads them all (some from FS, some from the model) and sets the edges
+     * between the component and the dependencies.
+     * once done, it finds all their dependencies, which are [A3, B3, C3] and repeat the process
+     * above. since there are no more dependencies, the graph is completed.
+     * in this case, the total depth levels are 3.
+     *
+     * even with a huge project, there are not many depth levels. by iterating through depth levels
+     * we keep performance sane as the importMany doesn't run multiple time and therefore the round
+     * trips to the remotes are minimal.
+     *
+     * normally, one importMany of the seeders is enough as importMany knows to fetch all flattened.
+     * however, since this buildGraph is performed on the workspace, a dependency may be new or
+     * modified and as such, we don't know its flattened yet.
+     */
     buildGraph(ids: BitId[]): Promise<LegacyGraph>;
     private getAllDepsUnfiltered;
     private getAllDepsFiltered;

package/dist/install.cmd.d.ts

@@ -1,17 +1,23 @@
 import { Command, CommandOptions } from '@teambit/cli';
-import { DependencyLifecycleType } from '@teambit/dependency-resolver';
+import { WorkspaceDependencyLifecycleType } from '@teambit/dependency-resolver';
 import { Logger } from '@teambit/logger';
 import { Workspace } from './workspace';
 declare type InstallCmdOptions = {
     variants: string;
-    type: DependencyLifecycleType;
+    type: WorkspaceDependencyLifecycleType;
     skipDedupe: boolean;
     skipImport: boolean;
     updateExisting: boolean;
     savePrefix: string;
 };
 export default class InstallCmd implements Command {
+    /**
+     * workspace extension.
+     */
     private workspace;
+    /**
+     * logger extension.
+     */
     private logger;
     name: string;
     description: string;
@@ -19,7 +25,15 @@ export default class InstallCmd implements Command {
     group: string;
     shortDescription: string;
     options: CommandOptions;
-    constructor(workspace: Workspace, logger: Logger);
+    constructor(
+    /**
+     * workspace extension.
+     */
+    workspace: Workspace, 
+    /**
+     * logger extension.
+     */
+    logger: Logger);
     report([packages]: [string[]], options: InstallCmdOptions): Promise<string>;
 }
 export {};

package/dist/install.cmd.js.map

@@ -1 +1 @@
-{"version":3,"sources":["install.cmd.tsx"],"names":["InstallCmd","constructor","workspace","logger","report","packages","options","startTime","Date","now","console","chalk","cyan","name","installOpts","variants","lifecycleType","type","dedupe","skipDedupe","import","skipImport","updateExisting","savePrefix","components","install","endTime","executionTime","calculateTime","toArray","length","toString","diff"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAGA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAae,MAAMA,UAAN,CAAoC;AAejDC,EAAAA,WAAW;AACT;AACJ;AACA;AACYC,EAAAA,SAJC;AAMT;AACJ;AACA;AACYC,EAAAA,MATC,EAUT;AAAA,SANQD,SAMR,GANQA,SAMR;AAAA,SADQC,MACR,GADQA,MACR;AAAA,kDAxBK,uBAwBL;AAAA,yDAvBY,4CAuBZ;AAAA,mDAtBM,IAsBN;AAAA,mDArBM,aAqBN;AAAA,8DApBiB,EAoBjB;AAAA,qDAnBQ,CACR,CAAC,GAAD,EAAM,qBAAN,EAA6B,mCAA7B,CADQ,EAER,CAAC,GAAD,EAAM,sBAAN,EAA8B,2CAA9B,CAFQ,EAGR,CAAC,GAAD,EAAM,kCAAN,EAA0C,gDAA1C,CAHQ,EAIR,CAAC,EAAD,EAAK,0BAAL,EAAiC,iEAAjC,CAJQ,EAKR,CAAC,EAAD,EAAK,0BAAL,EAAiC,4CAAjC,CALQ,EAMR,CAAC,EAAD,EAAK,0BAAL,EAAiC,6CAAjC,CANQ,CAmBR;AAAE;;AAEQ,QAANC,MAAM,CAAC,CAACC,QAAQ,GAAG,EAAZ,CAAD,EAA8BC,OAA9B,EAA0D;AACpE,UAAMC,SAAS,GAAGC,IAAI,CAACC,GAAL,EAAlB;AACA,SAAKN,MAAL,CAAYO,OAAZ,CAAqB,oDAAmDC,iBAAMC,IAAN,CAAW,KAAKV,SAAL,CAAeW,IAA1B,CAAgC,GAAxG;AACA,UAAMC,WAAoC,GAAG;AAC3CC,MAAAA,QAAQ,EAAET,OAAO,CAACS,QADyB;AAE3CC,MAAAA,aAAa,EAAEV,OAAO,CAACW,IAFoB;AAG3CC,MAAAA,MAAM,EAAE,CAACZ,OAAO,CAACa,UAH0B;AAI3CC,MAAAA,MAAM,EAAE,CAACd,OAAO,CAACe,UAJ0B;AAK3CC,MAAAA,cAAc,EAAEhB,OAAO,CAACgB,cALmB;AAM3CC,MAAAA,UAAU,EAAEjB,OAAO,CAACiB;AANuB,KAA7C;AAQA,UAAMC,UAAU,GAAG,MAAM,KAAKtB,SAAL,CAAeuB,OAAf,CAAuBpB,QAAvB,EAAiCS,WAAjC,CAAzB;AACA,UAAMY,OAAO,GAAGlB,IAAI,CAACC,GAAL,EAAhB;AACA,UAAMkB,aAAa,GAAGC,aAAa,CAACrB,SAAD,EAAYmB,OAAZ,CAAnC;AACA,WAAQ,0CAAyCf,iBAAMC,IAAN,CAC/CY,UAAU,CAACK,OAAX,GAAqBC,MAArB,CAA4BC,QAA5B,EAD+C,CAE/C,oBAAmBpB,iBAAMC,IAAN,CAAWe,aAAa,CAACI,QAAd,EAAX,CAAqC,UAF1D;AAGD;;AA5CgD;;;;AA+CnD,SAASH,aAAT,CAAuBrB,SAAvB,EAA0CmB,OAA1C,EAA2D;AACzD,QAAMM,IAAI,GAAGN,OAAO,GAAGnB,SAAvB;AACA,SAAOyB,IAAI,GAAG,IAAd;AACD","sourcesContent":["import { Command, CommandOptions } from '@teambit/cli';\nimport { DependencyLifecycleType } from '@teambit/dependency-resolver';\nimport { Logger } from '@teambit/logger';\nimport chalk from 'chalk';\n\nimport { Workspace, WorkspaceInstallOptions } from './workspace';\n\ntype InstallCmdOptions = {\n  variants: string;\n  type: DependencyLifecycleType;\n  skipDedupe: boolean;\n  skipImport: boolean;\n  updateExisting: boolean;\n  savePrefix: string;\n};\n\nexport default class InstallCmd implements Command {\n  name = 'install [packages...]';\n  description = 'install development workspace dependencies';\n  alias = 'in';\n  group = 'development';\n  shortDescription = '';\n  options = [\n    ['v', 'variants <variants>', 'add packages to specific variants'],\n    ['t', 'type [lifecycleType]', 'runtime (default), dev or peer dependency'],\n    ['u', 'update-existing [updateExisting]', 'update existing dependencies version and types'],\n    ['', 'save-prefix [savePrefix]', 'set the prefix to use when adding dependency to workspace.jsonc'],\n    ['', 'skip-dedupe [skipDedupe]', 'do not dedupe dependencies on installation'],\n    ['', 'skip-import [skipImport]', 'do not import bit objects post installation'],\n  ] as CommandOptions;\n\n  constructor(\n    /**\n     * workspace extension.\n     */\n    private workspace: Workspace,\n\n    /**\n     * logger extension.\n     */\n    private logger: Logger\n  ) {}\n\n  async report([packages = []]: [string[]], options: InstallCmdOptions) {\n    const startTime = Date.now();\n    this.logger.console(`Resolving component dependencies for workspace: '${chalk.cyan(this.workspace.name)}'`);\n    const installOpts: WorkspaceInstallOptions = {\n      variants: options.variants,\n      lifecycleType: options.type,\n      dedupe: !options.skipDedupe,\n      import: !options.skipImport,\n      updateExisting: options.updateExisting,\n      savePrefix: options.savePrefix,\n    };\n    const components = await this.workspace.install(packages, installOpts);\n    const endTime = Date.now();\n    const executionTime = calculateTime(startTime, endTime);\n    return `Successfully resolved dependencies for ${chalk.cyan(\n      components.toArray().length.toString()\n    )} component(s) in ${chalk.cyan(executionTime.toString())} seconds`;\n  }\n}\n\nfunction calculateTime(startTime: number, endTime: number) {\n  const diff = endTime - startTime;\n  return diff / 1000;\n}\n"]}
+{"version":3,"sources":["install.cmd.tsx"],"names":["InstallCmd","constructor","workspace","logger","report","packages","options","startTime","Date","now","console","chalk","cyan","name","installOpts","variants","lifecycleType","type","dedupe","skipDedupe","import","skipImport","updateExisting","savePrefix","components","install","endTime","executionTime","calculateTime","toArray","length","toString","diff"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAGA;AAAA;;AAAA;AAAA;AAAA;;AAAA;AAAA;;AAae,MAAMA,UAAN,CAAoC;AAejDC,EAAAA,WAAW;AACT;AACJ;AACA;AACYC,EAAAA,SAJC;AAMT;AACJ;AACA;AACYC,EAAAA,MATC,EAUT;AAAA,SANQD,SAMR,GANQA,SAMR;AAAA,SADQC,MACR,GADQA,MACR;AAAA,kDAxBK,uBAwBL;AAAA,yDAvBY,4CAuBZ;AAAA,mDAtBM,IAsBN;AAAA,mDArBM,aAqBN;AAAA,8DApBiB,EAoBjB;AAAA,qDAnBQ,CACR,CAAC,GAAD,EAAM,qBAAN,EAA6B,mCAA7B,CADQ,EAER,CAAC,GAAD,EAAM,sBAAN,EAA8B,2CAA9B,CAFQ,EAGR,CAAC,GAAD,EAAM,kCAAN,EAA0C,gDAA1C,CAHQ,EAIR,CAAC,EAAD,EAAK,0BAAL,EAAiC,iEAAjC,CAJQ,EAKR,CAAC,EAAD,EAAK,0BAAL,EAAiC,4CAAjC,CALQ,EAMR,CAAC,EAAD,EAAK,0BAAL,EAAiC,6CAAjC,CANQ,CAmBR;AAAE;;AAEQ,QAANC,MAAM,CAAC,CAACC,QAAQ,GAAG,EAAZ,CAAD,EAA8BC,OAA9B,EAA0D;AACpE,UAAMC,SAAS,GAAGC,IAAI,CAACC,GAAL,EAAlB;AACA,SAAKN,MAAL,CAAYO,OAAZ,CAAqB,oDAAmDC,iBAAMC,IAAN,CAAW,KAAKV,SAAL,CAAeW,IAA1B,CAAgC,GAAxG;AACA,UAAMC,WAAoC,GAAG;AAC3CC,MAAAA,QAAQ,EAAET,OAAO,CAACS,QADyB;AAE3CC,MAAAA,aAAa,EAAEV,OAAO,CAACW,IAFoB;AAG3CC,MAAAA,MAAM,EAAE,CAACZ,OAAO,CAACa,UAH0B;AAI3CC,MAAAA,MAAM,EAAE,CAACd,OAAO,CAACe,UAJ0B;AAK3CC,MAAAA,cAAc,EAAEhB,OAAO,CAACgB,cALmB;AAM3CC,MAAAA,UAAU,EAAEjB,OAAO,CAACiB;AANuB,KAA7C;AAQA,UAAMC,UAAU,GAAG,MAAM,KAAKtB,SAAL,CAAeuB,OAAf,CAAuBpB,QAAvB,EAAiCS,WAAjC,CAAzB;AACA,UAAMY,OAAO,GAAGlB,IAAI,CAACC,GAAL,EAAhB;AACA,UAAMkB,aAAa,GAAGC,aAAa,CAACrB,SAAD,EAAYmB,OAAZ,CAAnC;AACA,WAAQ,0CAAyCf,iBAAMC,IAAN,CAC/CY,UAAU,CAACK,OAAX,GAAqBC,MAArB,CAA4BC,QAA5B,EAD+C,CAE/C,oBAAmBpB,iBAAMC,IAAN,CAAWe,aAAa,CAACI,QAAd,EAAX,CAAqC,UAF1D;AAGD;;AA5CgD;;;;AA+CnD,SAASH,aAAT,CAAuBrB,SAAvB,EAA0CmB,OAA1C,EAA2D;AACzD,QAAMM,IAAI,GAAGN,OAAO,GAAGnB,SAAvB;AACA,SAAOyB,IAAI,GAAG,IAAd;AACD","sourcesContent":["import { Command, CommandOptions } from '@teambit/cli';\nimport { WorkspaceDependencyLifecycleType } from '@teambit/dependency-resolver';\nimport { Logger } from '@teambit/logger';\nimport chalk from 'chalk';\n\nimport { Workspace, WorkspaceInstallOptions } from './workspace';\n\ntype InstallCmdOptions = {\n  variants: string;\n  type: WorkspaceDependencyLifecycleType;\n  skipDedupe: boolean;\n  skipImport: boolean;\n  updateExisting: boolean;\n  savePrefix: string;\n};\n\nexport default class InstallCmd implements Command {\n  name = 'install [packages...]';\n  description = 'install development workspace dependencies';\n  alias = 'in';\n  group = 'development';\n  shortDescription = '';\n  options = [\n    ['v', 'variants <variants>', 'add packages to specific variants'],\n    ['t', 'type [lifecycleType]', 'runtime (default), dev or peer dependency'],\n    ['u', 'update-existing [updateExisting]', 'update existing dependencies version and types'],\n    ['', 'save-prefix [savePrefix]', 'set the prefix to use when adding dependency to workspace.jsonc'],\n    ['', 'skip-dedupe [skipDedupe]', 'do not dedupe dependencies on installation'],\n    ['', 'skip-import [skipImport]', 'do not import bit objects post installation'],\n  ] as CommandOptions;\n\n  constructor(\n    /**\n     * workspace extension.\n     */\n    private workspace: Workspace,\n\n    /**\n     * logger extension.\n     */\n    private logger: Logger\n  ) {}\n\n  async report([packages = []]: [string[]], options: InstallCmdOptions) {\n    const startTime = Date.now();\n    this.logger.console(`Resolving component dependencies for workspace: '${chalk.cyan(this.workspace.name)}'`);\n    const installOpts: WorkspaceInstallOptions = {\n      variants: options.variants,\n      lifecycleType: options.type,\n      dedupe: !options.skipDedupe,\n      import: !options.skipImport,\n      updateExisting: options.updateExisting,\n      savePrefix: options.savePrefix,\n    };\n    const components = await this.workspace.install(packages, installOpts);\n    const endTime = Date.now();\n    const executionTime = calculateTime(startTime, endTime);\n    return `Successfully resolved dependencies for ${chalk.cyan(\n      components.toArray().length.toString()\n    )} component(s) in ${chalk.cyan(executionTime.toString())} seconds`;\n  }\n}\n\nfunction calculateTime(startTime: number, endTime: number) {\n  const diff = endTime - startTime;\n  return diff / 1000;\n}\n"]}

package/dist/link/link.cmd.d.ts

@@ -9,7 +9,13 @@ declare type LinkCommandOpts = {
     skipFetchingObjects?: boolean;
 };
 export declare class LinkCommand implements Command {
+    /**
+     * workspace extension.
+     */
     private workspace;
+    /**
+     * logger extension.
+     */
     private logger;
     name: string;
     alias: string;
@@ -18,7 +24,15 @@ export declare class LinkCommand implements Command {
     group: string;
     private: boolean;
     options: CommandOptions;
-    constructor(workspace: Workspace, logger: Logger);
+    constructor(
+    /**
+     * workspace extension.
+     */
+    workspace: Workspace, 
+    /**
+     * logger extension.
+     */
+    logger: Logger);
     report([ids]: [string[]], opts: LinkCommandOpts): Promise<string>;
     json([ids]: [string[]], opts: LinkCommandOpts): Promise<LinkResults>;
 }

package/dist/types.d.ts

@@ -2,12 +2,33 @@ interface VendorConfig {
     directory: string;
 }
 export interface WorkspaceExtConfig {
+    /**
+     * name of the workspace.
+     */
     name: string;
+    /**
+     * path to icon.
+     */
     icon: string;
+    /**
+     * applies only on bit.dev. configure the main owner of your workspace
+     */
     defaultOwner: string;
+    /**
+     * set the default scope when there is no matching for the component in the components array.
+     */
     defaultScope: string;
+    /**
+     * set the default directory when there is no matching for the component in the components array.
+     */
     defaultDirectory: string;
+    /**
+     * set the default structure of components in your project
+     */
     vendor: VendorConfig;
+    /**
+     * All component extensions applied by default on all components in the workspace (except vendor components)
+     */
     extensions: {
         [extensionsId: string]: string;
     };

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

@@ -15,11 +15,42 @@ export declare type WorkspaceProps = {
     icon: string;
 };
 export declare class Workspace {
+    /**
+     * name of the workspace.
+     */
     readonly name: string;
+    /**
+     * absolute path of the workspace.
+     */
     readonly path: string;
+    /**
+     * icon of the workspace.
+     */
     readonly icon: string;
+    /**
+     * components container in the workspace.
+     */
     readonly components: ComponentModel[];
-    constructor(name: string, path: string, icon: string, components: ComponentModel[]);
+    constructor(
+    /**
+     * name of the workspace.
+     */
+    name: string, 
+    /**
+     * absolute path of the workspace.
+     */
+    path: string, 
+    /**
+     * icon of the workspace.
+     */
+    icon: string, 
+    /**
+     * components container in the workspace.
+     */
+    components: ComponentModel[]);
+    /**
+     * return a component from the workspace.
+     */
     getComponent(id: ComponentID): ComponentModel | undefined;
     static from({ name, path, components, icon }: WorkspaceProps): Workspace;
     static empty(): Workspace;

package/dist/ui/workspace/workspace-provider.d.ts

@@ -1,7 +1,16 @@
 import { ReactNode } from 'react';
 import { Workspace } from './workspace-model';
 export declare type WorkspaceProviderProps = {
+    /**
+     * workspace model.
+     */
     workspace: Workspace;
+    /**
+     * react children.
+     */
     children: ReactNode;
 };
+/**
+ * context provider of the workspace
+ */
 export declare function WorkspaceProvider({ workspace, children }: WorkspaceProviderProps): JSX.Element;

package/dist/ui/workspace/workspace.d.ts

@@ -8,4 +8,7 @@ export declare type WorkspaceProps = {
     workspaceUI: WorkspaceUI;
     onSidebarTogglerChange: (callback: () => void) => void;
 };
+/**
+ * main workspace component.
+ */
 export declare function Workspace({ routeSlot, menuSlot, sidebar, workspaceUI, onSidebarTogglerChange }: WorkspaceProps): JSX.Element;

package/dist/watch/output-formatter.d.ts

@@ -1,3 +1,9 @@
 import { OnComponentEventResult } from '../on-component-events';
 export declare const formatWatchPathsSortByComponent: (trackDirs: any) => string;
+/**
+ * todo: this was implemented incorrectly.
+ * the original idea of `SerializableResults` was to have each one of the aspects registered to the slot, the
+ * ability to have their own formatting to their results, and then `toString()` method to print them.
+ * Here, the printing is specifically to the Compiler aspect. It should move to where it belongs.
+ */
 export declare function formatCompileResults(compileResults: OnComponentEventResult[], verbose: boolean): string;

package/dist/watch/watch.cmd.d.ts

@@ -9,8 +9,17 @@ export declare type WatchCmdOpts = {
     checkTypes?: string | boolean;
 };
 export declare class WatchCommand implements Command {
+    /**
+     * logger extension.
+     */
     private pubsub;
+    /**
+     * logger extension.
+     */
     private logger;
+    /**
+     * watcher extension.
+     */
     private watcher;
     msgs: {
         onAll: (event: any, path: any) => void;
@@ -27,7 +36,19 @@ export declare class WatchCommand implements Command {
     group: string;
     shortDescription: string;
     options: CommandOptions;
-    constructor(pubsub: PubsubMain, logger: Logger, watcher: Watcher);
+    constructor(
+    /**
+     * logger extension.
+     */
+    pubsub: PubsubMain, 
+    /**
+     * logger extension.
+     */
+    logger: Logger, 
+    /**
+     * watcher extension.
+     */
+    watcher: Watcher);
     private registerToEvents;
     private eventsListener;
     report(cliArgs: [], watchCmdOpts: WatchCmdOpts): Promise<string>;

package/dist/watch/watcher.d.ts

@@ -34,6 +34,9 @@ export declare class Watcher {
     get consumer(): Consumer;
     watchAll(opts: WatchOptions): Promise<unknown>;
     private handleChange;
+    /**
+     * if .bitmap changed, it's possible that a new component has been added. trigger onComponentAdd.
+     */
     private handleBitmapChanges;
     private executeWatchOperationsOnRemove;
     private executeWatchOperationsOnComponent;
@@ -42,6 +45,12 @@ export declare class Watcher {
     private creatOnComponentAddEvent;
     private completeWatch;
     private isComponentWatchedExternally;
+    /**
+     * if a file was added/remove, once the component is loaded, it changes .bitmap, and then the
+     * entire cache is invalidated and the consumer is reloaded.
+     * when a file just changed, no need to reload the consumer, it is enough to just delete the
+     * component from the cache (both, workspace and consumer)
+     */
     private getComponentIdAndClearItsCache;
     private findTrackDirByFilePathRecursively;
     private createWatcher;

package/dist/workspace-component/component-status.d.ts

@@ -4,14 +4,70 @@ export declare type ModifyInfo = {
     hasModifiedDependencies: boolean;
 };
 export declare class ComponentStatus {
+    /**
+     * is the component modified.
+     */
     readonly modifyInfo: ModifyInfo;
+    /**
+     * is the new component new.
+     */
     readonly isNew: boolean;
+    /**
+     * is the component deleted from the workspace.
+     */
     readonly isDeleted: boolean;
+    /**
+     * is the component staged.
+     */
     readonly isStaged: boolean;
+    /**
+     * does the component exists in the workspace.
+     */
     readonly isInWorkspace: boolean;
+    /**
+     * does the component exists in the scope.
+     */
     readonly isInScope: boolean;
+    /**
+     * does the component is outdated (pending for update).
+     */
     readonly isOutdated: boolean;
+    /**
+     *  the component is not authored and not imported.
+     */
     readonly nested?: boolean | undefined;
-    constructor(modifyInfo: ModifyInfo, isNew: boolean, isDeleted: boolean, isStaged: boolean, isInWorkspace: boolean, isInScope: boolean, isOutdated: boolean, nested?: boolean | undefined);
+    constructor(
+    /**
+     * is the component modified.
+     */
+    modifyInfo: ModifyInfo, 
+    /**
+     * is the new component new.
+     */
+    isNew: boolean, 
+    /**
+     * is the component deleted from the workspace.
+     */
+    isDeleted: boolean, 
+    /**
+     * is the component staged.
+     */
+    isStaged: boolean, 
+    /**
+     * does the component exists in the workspace.
+     */
+    isInWorkspace: boolean, 
+    /**
+     * does the component exists in the scope.
+     */
+    isInScope: boolean, 
+    /**
+     * does the component is outdated (pending for update).
+     */
+    isOutdated: boolean, 
+    /**
+     *  the component is not authored and not imported.
+     */
+    nested?: boolean | undefined);
     static fromLegacy(status: LegacyComponentStatus, hasModifiedDependencies: boolean, isOutdated: boolean): ComponentStatus;
 }

package/dist/workspace-component/workspace-component-loader.d.ts

@@ -20,6 +20,13 @@ export declare class WorkspaceComponentLoader {
     clearComponentCache(id: ComponentID): void;
     private loadOne;
     private saveInCache;
+    /**
+     * make sure that not only the id-str match, but also the legacy-id.
+     * this is needed because the ComponentID.toString() is the same whether or not the legacy-id has
+     * scope-name, as it includes the defaultScope if the scope is empty.
+     * as a result, when out-of-sync is happening and the id is changed to include scope-name in the
+     * legacy-id, the component is the cache has the old id.
+     */
     private getFromCache;
     private getConsumerComponent;
     private isComponentNotExistsError;

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

@@ -3,12 +3,47 @@ import { IssuesList } from '@teambit/component-issues';
 import { Workspace } from '../workspace';
 import { ComponentStatus } from './component-status';
 export declare class WorkspaceComponent extends Component {
+    /**
+     * 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;
+    /**
+     * tags of the component.
+     */
     readonly tags: TagMap;
+    /**
+     * workspace extension.
+     */
     readonly workspace: Workspace;
-    constructor(id: ComponentID, head: Snap | null, workspaceState: State, tags: TagMap, workspace: Workspace);
+    constructor(
+    /**
+     * component ID represented by the `ComponentId` type.
+     */
+    id: ComponentID, 
+    /**
+     * head version of the component. can be `null` for new components.
+     */
+    head: Snap | null, 
+    /**
+     * state of the component.
+     */
+    workspaceState: State, 
+    /**
+     * tags of the component.
+     */
+    tags: TagMap, 
+    /**
+     * workspace extension.
+     */
+    workspace: Workspace);
     getStatus(): Promise<ComponentStatus>;
+    /**
+     * get all issues reported on the component.
+     */
     getIssues(): IssuesList | null;
     static fromComponent(component: Component, workspace: Workspace): WorkspaceComponent;
 }