@teambit/envs 0.0.554 → 0.0.555

package/dist/components/env-overview/env-overview.d.ts

@@ -2,4 +2,7 @@ import { EnvDefinition } from '../../env-definition';
 export declare type EnvOverviewProps = {
     envDef: EnvDefinition;
 };
+/**
+ * renders an env overview in the terminal.
+ */
 export declare function EnvOverview({ envDef }: EnvOverviewProps): JSX.Element;

package/dist/context/context.d.ts

@@ -4,12 +4,39 @@ export declare type ServiceMap<T> = {
     [env: string]: T;
 };
 export declare class ExecutionContext {
+    /**
+     * upper scope of all environment contexts.
+     */
     readonly upper: Runtime;
+    /**
+     * runtime instance of the environment.
+     */
     readonly envRuntime: EnvRuntime;
+    /**
+     * components applied in the execution context.
+     */
     components: import("@teambit/component").Component[];
-    constructor(upper: Runtime, envRuntime: EnvRuntime, components?: import("@teambit/component").Component[]);
+    constructor(
+    /**
+     * upper scope of all environment contexts.
+     */
+    upper: Runtime, 
+    /**
+     * runtime instance of the environment.
+     */
+    envRuntime: EnvRuntime, 
+    /**
+     * components applied in the execution context.
+     */
+    components?: import("@teambit/component").Component[]);
     relatedContexts: string[];
+    /**
+     * extension ID of the environment
+     */
     get id(): string;
+    /**
+     * environment instance.
+     */
     get env(): any;
     get envDefinition(): EnvDefinition;
     apply<T>(name: string, args: any[]): T;

package/dist/env-definition.d.ts

@@ -1,10 +1,36 @@
 import { Environment } from './environment';
+/**
+ * API for component development environment.
+ */
 export declare class EnvDefinition {
+    /**
+     * id of the env.
+     */
     readonly id: string;
+    /**
+     * env instance.
+     */
     readonly env: Environment;
-    constructor(id: string, env: Environment);
+    constructor(
+    /**
+     * id of the env.
+     */
+    id: string, 
+    /**
+     * env instance.
+     */
+    env: Environment);
+    /**
+     * get icon of the env.
+     */
     get icon(): string;
+    /**
+     * get the name of the env.
+     */
     get name(): string | undefined;
+    /**
+     * get the description of the env.
+     */
     get description(): string | undefined;
     toObject(): {
         id: string;

package/dist/env-service-list.d.ts

@@ -1,9 +1,23 @@
 import { EnvDefinition } from './env-definition';
 import { EnvService } from './services';
 export declare class EnvServiceList {
+    /**
+     * environment
+     */
     readonly env: EnvDefinition;
+    /**
+     * services available on the env.
+     */
     readonly services: [string, EnvService<any>][];
-    constructor(env: EnvDefinition, services: [string, EnvService<any>][]);
+    constructor(
+    /**
+     * environment
+     */
+    env: EnvDefinition, 
+    /**
+     * services available on the env.
+     */
+    services: [string, EnvService<any>][]);
     toObject(): {
         env: {
             id: string;

package/dist/environment.d.ts

@@ -12,33 +12,88 @@ import { ElementsWrapperContext } from '@teambit/elements';
 export declare type EnvDescriptor = {
     type: string;
 };
+/**
+ * add a custom type and include all properties from within the environment.
+ */
 export interface Environment {
+    /**
+     * name of the environment.
+     */
     name?: string;
+    /**
+     * description of the environment.
+     */
     description?: string;
+    /**
+     * icon of the environment.
+     */
     icon?: string;
     [key: string]: any;
+    /**
+     * Returns the Environment descriptor
+     * Required for any task
+     */
     __getDescriptor?: () => Promise<EnvDescriptor>;
+    /**
+     * Returns a schema generator instance
+     */
     getSchemaExtractor?: (config?: any) => SchemaExtractor;
 }
 export interface DependenciesEnv extends Environment {
+    /**
+     * Returns the list of dependencies
+     * Required for any task
+     */
     getDependencies?: () => VariantPolicyConfigObject | Promise<VariantPolicyConfigObject>;
 }
 export interface PackageEnv extends Environment {
+    /**
+     * define the package json properties to add to each component.
+     * Used by `bit link` to augment package.json with new properties
+     */
     getPackageJsonProps?: () => PackageJsonProps;
 }
 export interface LinterEnv extends Environment {
+    /**
+     * Returns & configures the linter to use (ESLint, ...)
+     * Required for `bit lint`
+     */
     getLinter?: (context: LinterContext, transformers: any[]) => Linter;
 }
 export interface FormatterEnv extends Environment {
+    /**
+     * Returns & configures the formatter to use (prettier, ...)
+     * Required for `bit format`
+     */
     getFormatter?: (context: FormatterContext, transformers: any[]) => Formatter;
 }
 export interface PreviewEnv extends Environment {
+    /**
+     * Returns a paths to a function which mounts a given component to DOM
+     * Required for `bit start` & `bit build`
+     */
     getMounter?: () => string;
+    /**
+     * Returns a path to a docs template.
+     * Required for `bit start` & `bit build`
+     */
     getDocsTemplate?: () => string;
+    /**
+     * Returns a bundler for the preview.
+     * Required for `bit build` & `bit start`
+     */
     getBundler?: (context: BundlerContext, transformers: any[]) => Promise<Bundler>;
 }
 export interface ElementsEnv extends Environment {
+    /**
+     * Returns a function that gets the context and wrap the component with a web component
+     * Required for `bit build`
+     */
     getElementsWrapper: (context: ElementsWrapperContext) => string;
+    /**
+     * Returns a bundler for elements.
+     * Required for `bit build``
+     */
     getElementsBundler: (context: BundlerContext, transformers: any[]) => Promise<Bundler>;
 }
 export declare type PipeServiceModifiersMap = Record<string, PipeServiceModifier>;
@@ -47,19 +102,49 @@ export interface PipeServiceModifier {
     module?: any;
 }
 export interface BuilderEnv extends PreviewEnv {
+    /**
+     * @deprecated Fatal: a breaking API was introduced. Use getBuildPipe() instead.
+     */
     getPipe?: () => BuildTask[];
+    /**
+     * Returns the component build pipeline
+     * Either `getBuildPipe`, `getTagPipe`, or `getSnapPipe` is required for `bit build`
+     */
     getBuildPipe?: (modifiersMap?: PipeServiceModifiersMap) => BuildTask[];
+    /**
+     * Returns the component tag pipeline
+     * Either `getBuildPipe`, `getTagPipe`, or `getSnapPipe` is required for `bit build`
+     */
     getTagPipe?: (modifiersMap?: PipeServiceModifiersMap) => BuildTask[];
+    /**
+     * Returns the component snap pipeline
+     * Either `getBuildPipe`, `getTagPipe`, or `getSnapPipe` is required for `bit build`
+     */
     getSnapPipe?: (modifiersMap?: PipeServiceModifiersMap) => BuildTask[];
 }
 export interface TesterEnv extends Environment {
+    /**
+     * Returns a tester
+     * Required for `bit start` & `bit test`
+     */
     getTester?: (path: string, tester: any) => Tester;
 }
 export interface CompilerEnv {
+    /**
+     * Returns a compiler
+     * Required for making and reading dists, especially for `bit compile`
+     */
     getCompiler: () => Compiler;
 }
 export declare function hasCompiler(obj: Environment): obj is CompilerEnv;
 export interface DevEnv extends PreviewEnv {
+    /**
+     * Required for `bit start`
+     */
     getDevEnvId?: (context?: any) => string;
+    /**
+     * Returns and configures the dev server
+     * Required for `bit start`
+     */
     getDevServer?: (context: DevServerContext, transformers: WebpackConfigTransformer[]) => DevServer | Promise<DevServer>;
 }

package/dist/environments.main.runtime.d.ts

@@ -24,38 +24,114 @@ export declare type Descriptor = {
 };
 export declare const DEFAULT_ENV = "teambit.harmony/node";
 export declare class EnvsMain {
+    /**
+     * environments extension configuration.
+     */
     readonly config: EnvsConfig;
+    /**
+     * harmony context.
+     */
     private context;
+    /**
+     * slot for allowing extensions to register new environment.
+     */
     private envSlot;
     private logger;
     private serviceSlot;
     private componentMain;
     static runtime: import("@teambit/harmony").RuntimeDefinition;
     private alreadyShownWarning;
+    /**
+     * icon of the extension.
+     */
     icon(): string;
-    constructor(config: EnvsConfig, context: Harmony, envSlot: EnvsRegistry, logger: Logger, serviceSlot: ServiceSlot, componentMain: ComponentMain);
+    constructor(
+    /**
+     * environments extension configuration.
+     */
+    config: EnvsConfig, 
+    /**
+     * harmony context.
+     */
+    context: Harmony, 
+    /**
+     * slot for allowing extensions to register new environment.
+     */
+    envSlot: EnvsRegistry, logger: Logger, serviceSlot: ServiceSlot, componentMain: ComponentMain);
+    /**
+     * creates a new runtime environments for a set of components.
+     */
     createEnvironment(components: Component[]): Promise<Runtime>;
+    /**
+     * get the configured default env.
+     */
     getDefaultEnv(): EnvDefinition;
+    /**
+     * compose a new environment from a list of environment transformers.
+     */
     compose(targetEnv: Environment, envTransformers: EnvTransformer[]): Environment;
+    /**
+     * create an env transformer which overrides specific env properties.
+     */
     override(propsToOverride: Environment): EnvTransformer;
+    /**
+     * compose two environments into one.
+     */
     merge<T>(targetEnv: Environment, sourceEnv: Environment): T;
     getEnvData(component: Component): AspectData;
+    /**
+     * Return the id of the env as configured in the envs data (without version by default)
+     * The reason it's not contain version by default is that we want to take the version from the aspect defined on the component itself
+     * As this version is stay up to date during tagging the env along with the component
+     * @param component
+     * @param ignoreVersion
+     */
     private getEnvIdFromEnvsData;
+    /**
+     * get the env id of the given component.
+     */
     getEnvId(component: Component): string;
+    /**
+     * get the env of the given component.
+     * In case you are asking for the env during on load you should use calculateEnv instead
+     */
     getEnv(component: Component): EnvDefinition;
+    /**
+     * get an environment Descriptor.
+     */
     getDescriptor(component: Component): Descriptor | null;
     resolveEnv(component: Component, id: string): ComponentID | undefined;
+    /**
+     * This used to calculate the actual env during the component load.
+     * Do not use it to get the env (use getEnv instead)
+     * This should be used only during on load
+     */
     calculateEnv(component: Component): EnvDefinition;
     getAllEnvsConfiguredOnComponent(component: Component): EnvDefinition[];
+    /**
+     * @deprecated DO NOT USE THIS METHOD ANYMORE!!! (PLEASE USE .calculateEnv() instead!)
+     */
     calculateEnvFromExtensions(extensions: ExtensionDataList): EnvDefinition;
     private getEnvIdFromEnvsConfig;
     private getEnvDefinitionById;
     private getEnvDefinitionByStringId;
     private printWarningIfFirstTime;
+    /**
+     * determines whether an env is registered.
+     */
     isEnvRegistered(id: string): boolean;
+    /**
+     * register a new environment service.
+     */
     registerService(...envServices: EnvService<any>[]): this;
+    /**
+     * get list of services enabled on an env.
+     */
     getServices(env: EnvDefinition): EnvServiceList;
     implements(env: EnvDefinition, service: EnvService<any>): boolean;
+    /**
+     * register an environment.
+     */
     registerEnv(env: Environment): void;
     private createRuntime;
     private aggregateByDefs;

package/dist/runtime/env-runtime.d.ts

@@ -1,8 +1,32 @@
 import { Component } from '@teambit/component';
 import { Environment } from '../environment';
+/**
+ * env runtime is an instance which represent the given env in a
+ */
 export declare class EnvRuntime {
+    /**
+     * ID of the wrapping extension.
+     */
     readonly id: string;
+    /**
+     * environment
+     */
     readonly env: Environment;
+    /**
+     * components to be loaded in the environment
+     */
     readonly components: Component[];
-    constructor(id: string, env: Environment, components: Component[]);
+    constructor(
+    /**
+     * ID of the wrapping extension.
+     */
+    id: string, 
+    /**
+     * environment
+     */
+    env: Environment, 
+    /**
+     * components to be loaded in the environment
+     */
+    components: Component[]);
 }

package/dist/runtime/envs-execution-result.d.ts

@@ -4,8 +4,15 @@ export declare class EnvsExecutionResult<T extends ServiceExecutionResult> {
     readonly results: EnvResult<T>[];
     constructor(results: EnvResult<T>[]);
     hasErrors(): boolean;
+    /**
+     * execution errors.
+     */
     get errors(): Error[];
     getErrorsOfEnv(envResult: EnvResult<T>): Error[];
+    /**
+     * if only one error is found, throw it. otherwise, summarize the errors per env and throw the
+     * output
+     */
     throwErrorsIfExist(): void;
     getEnvErrorsAsString(envResult: EnvResult<T>): string;
 }

package/dist/runtime/runtime.d.ts

@@ -9,17 +9,41 @@ export interface EnvResult<T extends ServiceExecutionResult> {
     error?: Error;
 }
 export declare class Runtime {
+    /**
+     * runtime instances of the environments.
+     */
     readonly runtimeEnvs: EnvRuntime[];
     private logger;
-    constructor(runtimeEnvs: EnvRuntime[], logger: Logger);
+    constructor(
+    /**
+     * runtime instances of the environments.
+     */
+    runtimeEnvs: EnvRuntime[], logger: Logger);
+    /**
+     * execute a service on a specific env.
+     */
     runEnv<T>(envRuntimeId: string, service: EnvService<T>, options?: {
         [key: string]: any;
     }): Promise<EnvsExecutionResult<T>>;
+    /**
+     * execute a service once for all environments.
+     */
     runOnce<T>(service: EnvService<T>, options?: {
         [key: string]: any;
     }): Promise<any>;
     getEnvExecutionContext(): ExecutionContext[];
-    run<T>(service: EnvService<T>, options?: {
+    /**
+     * execute a service on each one of the environments.
+     */
+    run<T>(
+    /**
+     * environment service to execute.
+     */
+    service: EnvService<T>, 
+    /**
+     * options to proxy to the service upon execution.
+     */
+    options?: {
         [key: string]: any;
     }, runtimes?: EnvRuntime[]): Promise<EnvsExecutionResult<T>>;
 }

package/dist/services/concrete-service.d.ts

@@ -1,3 +1,7 @@
+/**
+ * please do not use this.
+ * @deprecated
+ */
 export interface ConcreteService {
     getPackageJsonProps?: () => Record<string, any>;
     dependencies?: () => any;

package/dist/services/service-handler.d.ts

@@ -1,3 +1,6 @@
+/**
+ * definition of the service handler.
+ */
 export interface ServiceHandler {
     identifier: string;
 }

package/dist/services/service.d.ts

@@ -6,11 +6,39 @@ export declare type EnvContext = {
 export interface ServiceExecutionResult {
     errors?: Error[];
 }
+/**
+ * services allows to reuse and standardize services for development environments.
+ * examples for services can be: `linting`, `compilation`, `build`, and others which offer
+ * standard services to environments such as `react`, `angular` and `vue` and different compositions of each for
+ * more concrete needs.
+ *
+ * `TData` - type of data returned by the service handler.
+ * `TOpts` is the type of options passed to the environment through execution.
+ * `TExecResponse` is the execution result of the service.
+ */
 export interface Service<TExecResponse extends ServiceExecutionResult, TData = {}, TOpts = {}> {
+    /**
+     * name of the service. (e.g. `compile`, `test`, etc.)
+     */
     name?: string;
+    /**
+     * description of the env.
+     */
     description?: string;
+    /**
+     * create a string to describe to service in the env cli.
+     */
     render?(env: Environment, context: EnvContext[]): JSX.Element | Promise<JSX.Element>;
+    /**
+     * get service data from an environment.
+     */
     getDescriptor?(environment: Environment, context?: EnvContext[]): TData | undefined | Promise<TData | undefined>;
+    /**
+     * executes a service on a subset of components.
+     */
     run?(context: EnvContext, options?: TOpts): Promise<TExecResponse>;
+    /**
+     *
+     */
     runOnce?(context: EnvContext[], options?: TOpts): Promise<any>;
 }

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/envs",
-  "version": "0.0.554",
+  "version": "0.0.555",
   "homepage": "https://bit.dev/teambit/envs/envs",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.envs",
     "name": "envs",
-    "version": "0.0.554"
+    "version": "0.0.555"
   },
   "dependencies": {
     "@teambit/harmony": "0.2.11",
@@ -16,23 +16,23 @@
     "p-map-series": "2.1.0",
     "@babel/runtime": "7.12.18",
     "core-js": "^3.0.0",
-    "@teambit/component": "0.0.554",
-    "@teambit/builder": "0.0.554",
-    "@teambit/bundler": "0.0.554",
-    "@teambit/compiler": "0.0.554",
-    "@teambit/dependency-resolver": "0.0.554",
-    "@teambit/elements": "0.0.7",
-    "@teambit/formatter": "0.0.105",
-    "@teambit/linter": "0.0.554",
-    "@teambit/pkg": "0.0.554",
-    "@teambit/schema": "0.0.554",
-    "@teambit/tester": "0.0.554",
-    "@teambit/webpack": "0.0.554",
-    "@teambit/graphql": "0.0.554",
-    "@teambit/cli": "0.0.385",
-    "@teambit/logger": "0.0.470",
-    "@teambit/cli-table": "0.0.8",
-    "@teambit/bit-error": "0.0.371"
+    "@teambit/component": "0.0.555",
+    "@teambit/builder": "0.0.555",
+    "@teambit/bundler": "0.0.555",
+    "@teambit/compiler": "0.0.555",
+    "@teambit/dependency-resolver": "0.0.555",
+    "@teambit/elements": "0.0.8",
+    "@teambit/formatter": "0.0.106",
+    "@teambit/linter": "0.0.555",
+    "@teambit/pkg": "0.0.555",
+    "@teambit/schema": "0.0.555",
+    "@teambit/tester": "0.0.555",
+    "@teambit/webpack": "0.0.555",
+    "@teambit/graphql": "0.0.555",
+    "@teambit/cli": "0.0.386",
+    "@teambit/logger": "0.0.471",
+    "@teambit/cli-table": "0.0.9",
+    "@teambit/bit-error": "0.0.372"
   },
   "devDependencies": {
     "@types/react": "^17.0.8",
@@ -42,10 +42,10 @@
     "@types/jest": "^26.0.0",
     "@types/react-dom": "^17.0.5",
     "@types/node": "12.20.4",
-    "@teambit/envs.aspect-docs.envs": "0.0.104"
+    "@teambit/envs.aspect-docs.envs": "0.0.105"
   },
   "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"
   },
@@ -73,7 +73,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
   },