@teambit/aspect-loader 0.0.554 → 0.0.555

package/dist/aspect-definition.d.ts

@@ -6,12 +6,47 @@ export declare type AspectDefinitionProps = {
     runtimePath: string | null;
 };
 export declare class AspectDefinition {
+    /**
+     * path the the root directory of the aspect module.
+     */
     readonly aspectPath: string;
+    /**
+     * path to the runtime entry
+     */
     readonly runtimePath: string | null;
+    /**
+     * aspect component
+     */
     readonly component?: Component | undefined;
+    /**
+     * id of the component (used instead of component in the case of core aspect)
+     */
     readonly id?: string | undefined;
+    /**
+     * aspect defined using 'file://' protocol
+     */
     readonly local?: boolean | undefined;
-    constructor(aspectPath: string, runtimePath: string | null, component?: Component | undefined, id?: string | undefined, local?: boolean | undefined);
+    constructor(
+    /**
+     * path the the root directory of the aspect module.
+     */
+    aspectPath: string, 
+    /**
+     * path to the runtime entry
+     */
+    runtimePath: string | null, 
+    /**
+     * aspect component
+     */
+    component?: Component | undefined, 
+    /**
+     * id of the component (used instead of component in the case of core aspect)
+     */
+    id?: string | undefined, 
+    /**
+     * aspect defined using 'file://' protocol
+     */
+    local?: boolean | undefined);
     get getId(): string | null;
     static from({ component, aspectPath, runtimePath, id }: AspectDefinitionProps): AspectDefinition;
 }

package/dist/aspect-loader.main.runtime.d.ts

@@ -9,7 +9,13 @@ import { PluginDefinition } from './plugin-definition';
 import { Plugins } from './plugins';
 export declare type PluginDefinitionSlot = SlotRegistry<PluginDefinition[]>;
 export declare type AspectDescriptor = {
+    /**
+     * name of the extension.
+     */
     id: string;
+    /**
+     * icon of the extension.
+     */
     icon?: string;
 };
 export declare type AspectResolver = (component: Component) => Promise<ResolvedAspect>;
@@ -20,13 +26,34 @@ export declare type ResolvedAspect = {
 declare type OnAspectLoadError = (err: Error, id: ComponentID) => Promise<boolean>;
 export declare type OnAspectLoadErrorSlot = SlotRegistry<OnAspectLoadError>;
 export declare type OnLoadRequireableExtension = (requireableExtension: RequireableComponent, manifest: ExtensionManifest | Aspect) => Promise<ExtensionManifest | Aspect>;
+/**
+ * A slot which run during loading the requirable extension (after first manifest calculation)
+ */
 export declare type OnLoadRequireableExtensionSlot = SlotRegistry<OnLoadRequireableExtension>;
 export declare type MainAspect = {
+    /**
+     * path to the main aspect.
+     */
     path: string;
+    /**
+     * version of the aspect.
+     */
     version: string | undefined;
+    /**
+     * package name of the aspect
+     */
     packageName: string | undefined;
+    /**
+     * reference to aspect manifest.
+     */
     aspect: Aspect;
+    /**
+     * The name of the aspect (without the scope prefix)
+     */
     name: string;
+    /**
+     * The name of the aspect
+     */
     id: string;
 };
 export declare class AspectLoaderMain {
@@ -40,6 +67,9 @@ export declare class AspectLoaderMain {
     private getCompiler;
     registerOnAspectLoadErrorSlot(onAspectLoadError: OnAspectLoadError): void;
     registerOnLoadRequireableExtensionSlot(onLoadRequireableExtension: OnLoadRequireableExtension): void;
+    /**
+     * returns whether the aspect-load issue has been fixed.
+     */
     triggerOnAspectLoadError(err: Error, component: Component): Promise<boolean>;
     getRuntimePath(component: Component, modulePath: string, runtime: string): Promise<string | null>;
     isAspectLoaded(id: string): unknown;
@@ -61,7 +91,30 @@ export declare class AspectLoaderMain {
     private failedLoadAspect;
     get failedAspects(): string[];
     private addFailure;
+    /**
+     * run "require" of the component code to get the manifest
+     */
     doRequire(requireableExtension: RequireableComponent): Promise<ExtensionManifest | Aspect>;
+    /**
+     * in case the extension failed to load, prefer to throw an error, unless `throwOnError` param
+     * passed as `false`.
+     * there are cases when throwing an error blocks the user from doing anything else. for example,
+     * when a user develops an extension and deletes the node-modules, the extension on the workspace
+     * cannot be loaded anymore until "bit compile" is running. however, if this function throws an
+     * error, it'll throw for "bit compile" as well, which blocks the user.
+     * for the CI, it is important to throw an error because errors on console can be ignored.
+     * for now, when loading the extension from the workspace the throwOnError is passed as false.
+     * when loading from the scope (CI) it should be true.
+     *
+     * the console printing here is done directly by "console.error" and not by the logger. the reason
+     * is that the logger.console only prints when the loader started (which, btw, happens after
+     * entering this function, so it can't work) and here we want it to be printed regardless of the
+     * rules of starting the loader. e.g. if by mistake the CI got it as throwOnError=false, it's ok
+     * to break the output by the console.error.
+     *
+     * @todo: this is not the final word however about throwing/non throwing errors here.
+     * in some cases, such as "bit tag", it's better not to tag if an extension changes the model.
+     */
     loadRequireableExtensions(requireableExtensions: RequireableComponent[], throwOnError?: boolean): Promise<void>;
     getManifestsFromRequireableExtensions(requireableExtensions: RequireableComponent[], throwOnError?: boolean): Promise<Array<ExtensionManifest | Aspect>>;
     handleExtensionLoadingError(error: Error, idStr: string, throwOnError: boolean): void;
@@ -70,8 +123,15 @@ export declare class AspectLoaderMain {
     getPlugins(component: Component, componentPath: string): Plugins;
     isAspect(manifest: any): boolean;
     isAspectComponent(component: Component): boolean;
+    /**
+     * get or create a global scope, import the non-core aspects, load bit from that scope, create
+     * capsules for the aspects and load them from the capsules.
+     */
     loadAspectsFromGlobalScope(aspectIds: string[]): Promise<Component[]>;
     private prepareManifests;
+    /**
+     * register a plugin.
+     */
     registerPlugins(pluginDefs: PluginDefinition[]): this;
     loadExtensionsByManifests(extensionsManifests: Array<ExtensionManifest | Aspect>, throwOnError?: boolean): Promise<void>;
     static runtime: import("@teambit/harmony").RuntimeDefinition;

package/dist/plugin-definition.d.ts

@@ -1,5 +1,14 @@
 export interface PluginDefinition {
+    /**
+     * regex pattern for detecting the definition file within a component.
+     */
     pattern: string | RegExp;
+    /**
+     * runtimes for the plugin to apply.
+     */
     runtimes: string[];
+    /**
+     * register the plugin to its slot registry.
+     */
     register<T>(object: T): void;
 }

package/dist/plugin.d.ts

@@ -4,6 +4,9 @@ export declare class Plugin {
     readonly path: string;
     constructor(def: PluginDefinition, path: string);
     private _instance;
+    /**
+     * determines whether the plugin supports a certain runtime.
+     */
     supportsRuntime(runtime: string): boolean;
     register(): void;
     require(): unknown;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/aspect-loader",
-  "version": "0.0.554",
+  "version": "0.0.555",
   "homepage": "https://bit.dev/teambit/harmony/aspect-loader",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.harmony",
     "name": "aspect-loader",
-    "version": "0.0.554"
+    "version": "0.0.555"
   },
   "dependencies": {
     "@teambit/harmony": "0.2.11",
@@ -15,15 +15,15 @@
     "fs-extra": "10.0.0",
     "@babel/runtime": "7.12.18",
     "core-js": "^3.0.0",
-    "@teambit/component": "0.0.554",
-    "@teambit/bit": "0.0.556",
-    "@teambit/cli": "0.0.385",
-    "@teambit/envs": "0.0.554",
-    "@teambit/harmony.modules.requireable-component": "0.0.460",
-    "@teambit/legacy-bit-id": "0.0.374",
-    "@teambit/logger": "0.0.470",
-    "@teambit/scope": "0.0.554",
-    "@teambit/bit-error": "0.0.371"
+    "@teambit/component": "0.0.555",
+    "@teambit/bit": "0.0.557",
+    "@teambit/cli": "0.0.386",
+    "@teambit/envs": "0.0.555",
+    "@teambit/harmony.modules.requireable-component": "0.0.461",
+    "@teambit/legacy-bit-id": "0.0.375",
+    "@teambit/logger": "0.0.471",
+    "@teambit/scope": "0.0.555",
+    "@teambit/bit-error": "0.0.372"
   },
   "devDependencies": {
     "@types/lodash": "4.14.165",
@@ -36,7 +36,7 @@
     "@types/node": "12.20.4"
   },
   "peerDependencies": {
-    "@teambit/legacy": "1.0.171",
+    "@teambit/legacy": "1.0.172",
     "react-dom": "^16.8.0 || ^17.0.0",
     "react": "^16.8.0 || ^17.0.0"
   },
@@ -64,7 +64,7 @@
         "react": "-"
       },
       "peerDependencies": {
-        "@teambit/legacy": "1.0.171",
+        "@teambit/legacy": "1.0.172",
         "react-dom": "^16.8.0 || ^17.0.0",
         "react": "^16.8.0 || ^17.0.0"
       }

package/tsconfig.json

@@ -25,7 +25,6 @@
     "strict": true,
     "noImplicitAny": false,
     "rootDir": ".",
-    "removeComments": true,
     "preserveConstEnums": true,
     "resolveJsonModule": true
   },