@teambit/bundler 0.0.549 → 0.0.555

package/dist/bundler.d.ts

@@ -6,7 +6,13 @@ export declare type BundlerResult = {
     errors: Error[];
     warnings: string[];
     components: Component[];
+    /**
+     * timestamp in milliseconds when the task started
+     */
     startTime?: number;
+    /**
+     * timestamp in milliseconds when the task ended
+     */
     endTime?: number;
 };
 export interface Bundler {

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

@@ -11,17 +11,66 @@ export declare type BrowserRuntimeSlot = SlotRegistry<BrowserRuntime>;
 export declare type BundlerConfig = {
     dedicatedEnvDevServers: string[];
 };
+/**
+ * bundler extension.
+ */
 export declare class BundlerMain {
     readonly config: BundlerConfig;
+    /**
+     * Pubsub extension.
+     */
     private pubsub;
+    /**
+     * environments extension.
+     */
     private envs;
+    /**
+     * dev server service.
+     */
     private devService;
+    /**
+     * browser runtime slot.
+     */
     private runtimeSlot;
-    constructor(config: BundlerConfig, pubsub: PubsubMain, envs: EnvsMain, devService: DevServerService, runtimeSlot: BrowserRuntimeSlot);
+    constructor(config: BundlerConfig, 
+    /**
+     * Pubsub extension.
+     */
+    pubsub: PubsubMain, 
+    /**
+     * environments extension.
+     */
+    envs: EnvsMain, 
+    /**
+     * dev server service.
+     */
+    devService: DevServerService, 
+    /**
+     * browser runtime slot.
+     */
+    runtimeSlot: BrowserRuntimeSlot);
+    /**
+     * load all given components in corresponding dev servers.
+     * @param components defaults to all components in the workspace.
+     */
     devServer(components: Component[]): Promise<ComponentServer[]>;
+    /**
+     * get a dev server instance containing a component.
+     * @param component
+     */
     getComponentServer(component: Component): undefined | ComponentServer;
+    /**
+     * compute entry files for bundling components in a given execution context.
+     */
     computeEntries(context: BundlerContext): Promise<string[]>;
+    /**
+     * register a new browser runtime environment.
+     * @param browserRuntime
+     */
     registerTarget(browserRuntime: BrowserRuntime[]): this;
+    /**
+     * component servers.
+     */
     private _componentServers;
     private indexByComponent;
     static slots: ((registerFn: () => string) => SlotRegistry<BrowserRuntime>)[];

package/dist/component-server.d.ts

@@ -3,13 +3,44 @@ import { ExecutionContext } from '@teambit/envs';
 import { PubsubMain } from '@teambit/pubsub';
 import { DevServer } from './dev-server';
 export declare class ComponentServer {
+    /**
+     * browser runtime slot
+     */
     private pubsub;
+    /**
+     * components contained in the existing component server.
+     */
     readonly context: ExecutionContext;
+    /**
+     * port range of the component server.
+     */
     readonly portRange: number[];
+    /**
+     * env dev server.
+     */
     readonly devServer: DevServer;
     errors?: Error[];
-    constructor(pubsub: PubsubMain, context: ExecutionContext, portRange: number[], devServer: DevServer);
+    constructor(
+    /**
+     * browser runtime slot
+     */
+    pubsub: PubsubMain, 
+    /**
+     * components contained in the existing component server.
+     */
+    context: ExecutionContext, 
+    /**
+     * port range of the component server.
+     */
+    portRange: number[], 
+    /**
+     * env dev server.
+     */
+    devServer: DevServer);
     hostname: string | undefined;
+    /**
+     * determine whether component server contains a component.
+     */
     hasComponent(component: Component): Component | undefined;
     get port(): number;
     _port: number;
@@ -17,5 +48,8 @@ export declare class ComponentServer {
     private getHostname;
     private onChange;
     private createComponentsServerStartedEvent;
+    /**
+     * get the url of the component server.
+     */
     get url(): string;
 }

package/dist/dev-server-context.d.ts

@@ -2,8 +2,17 @@ import { Component } from '@teambit/component';
 import { BuildContext } from '@teambit/builder';
 import { ExecutionContext } from '@teambit/envs';
 export declare type Target = {
+    /**
+     * entries of the target.
+     */
     entries: string[];
+    /**
+     * array of components included in the target.
+     */
     components: Component[];
+    /**
+     * output path of the target
+     */
     outputPath: string;
 };
 export interface BundlerContext extends BuildContext {
@@ -12,8 +21,20 @@ export interface BundlerContext extends BuildContext {
     rootPath?: string;
 }
 export interface DevServerContext extends ExecutionContext {
+    /**
+     * array of files to include.
+     */
     entry: string[];
+    /**
+     * public path.
+     */
     publicPath: string;
+    /**
+     * root path of the workspace.
+     */
     rootPath: string;
+    /**
+     * title of the page.
+     */
     title?: string;
 }

package/dist/dev-server.d.ts

@@ -1,11 +1,35 @@
 /// <reference types="node" />
 import { Server } from 'http';
+/**
+ * interface for implementing dev servers.
+ */
 export interface DevServer {
+    /**
+     * attach to given port and start an http server
+     */
     listen(port: number): Server | Promise<Server>;
+    /**
+     * display name of the tester.
+     */
     displayName?: string;
+    /**
+     * icon of the tester.
+     */
     icon?: string;
+    /**
+     * serialized config of the tester.
+     */
     displayConfig?(): string;
+    /**
+     * path to the config in the filesystem.
+     */
     configPath?: string;
+    /**
+     * id of the tester.
+     */
     id: string;
+    /**
+     * return the tester version.
+     */
     version?(): string;
 }

package/dist/dev-server.service.d.ts

@@ -6,21 +6,50 @@ export declare type DevServerServiceOptions = {
     dedicatedEnvDevServers?: string[];
 };
 export declare type DevServerDescriptor = {
+    /**
+     * id of the dev server (e.g. jest/mocha)
+     */
     id: string;
+    /**
+     * display name of the dev server (e.g. Jest / Mocha)
+     */
     displayName: string;
+    /**
+     * icon of the configured dev server.
+     */
     icon: string;
+    /**
+     * string containing the config for display.
+     */
     config: string;
     version?: string;
 };
 export declare class DevServerService implements EnvService<ComponentServer, DevServerDescriptor> {
+    /**
+     * browser runtime slot
+     */
     private pubsub;
+    /**
+     * browser runtime slot
+     */
     private runtimeSlot;
     name: string;
-    constructor(pubsub: PubsubMain, runtimeSlot: BrowserRuntimeSlot);
+    constructor(
+    /**
+     * browser runtime slot
+     */
+    pubsub: PubsubMain, 
+    /**
+     * browser runtime slot
+     */
+    runtimeSlot: BrowserRuntimeSlot);
     render(env: EnvDefinition, context: ExecutionContext[]): Promise<JSX.Element>;
     getDescriptor(environment: EnvDefinition, context?: ExecutionContext[]): Promise<DevServerDescriptor | undefined>;
     runOnce(contexts: ExecutionContext[], { dedicatedEnvDevServers }: DevServerServiceOptions): Promise<ComponentServer[]>;
     mergeContext(): void;
     private getComponentsFromContexts;
+    /**
+     * builds the execution context for the dev server.
+     */
     private buildContext;
 }

package/dist/get-entry.d.ts

@@ -8,4 +8,7 @@ export declare type ComponentDir = {
         relative: boolean;
     }) => PathOsBased | undefined;
 };
+/**
+ * computes the bundler entry.
+ */
 export declare function getEntry(context: ExecutionContext, runtimeSlot: BrowserRuntimeSlot): Promise<string[]>;

package/dist/select-port.d.ts

@@ -1 +1,4 @@
+/**
+ * get an available port between range 3000 to 3200 or from port range
+ */
 export declare function selectPort(range: number[] | number): Promise<number>;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/bundler",
-  "version": "0.0.549",
+  "version": "0.0.555",
   "homepage": "https://bit.dev/teambit/compilation/bundler",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.compilation",
     "name": "bundler",
-    "version": "0.0.549"
+    "version": "0.0.555"
   },
   "dependencies": {
     "@teambit/harmony": "0.2.11",
@@ -15,13 +15,13 @@
     "lodash": "4.17.21",
     "@babel/runtime": "7.12.18",
     "core-js": "^3.0.0",
-    "@teambit/envs": "0.0.549",
-    "@teambit/cli": "0.0.380",
-    "@teambit/component": "0.0.549",
-    "@teambit/graphql": "0.0.549",
-    "@teambit/pubsub": "0.0.549",
-    "@teambit/builder": "0.0.549",
-    "@teambit/toolbox.network.get-port": "0.0.86"
+    "@teambit/envs": "0.0.555",
+    "@teambit/cli": "0.0.386",
+    "@teambit/component": "0.0.555",
+    "@teambit/graphql": "0.0.555",
+    "@teambit/pubsub": "0.0.555",
+    "@teambit/builder": "0.0.555",
+    "@teambit/toolbox.network.get-port": "0.0.90"
   },
   "devDependencies": {
     "@types/lodash": "4.14.165",
@@ -34,7 +34,7 @@
   },
   "peerDependencies": {
     "@apollo/client": "^3.0.0",
-    "@teambit/legacy": "1.0.76",
+    "@teambit/legacy": "1.0.172",
     "react-dom": "^16.8.0 || ^17.0.0",
     "react": "^16.8.0 || ^17.0.0"
   },
@@ -62,7 +62,7 @@
         "react": "-"
       },
       "peerDependencies": {
-        "@teambit/legacy": "1.0.76",
+        "@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
   },