@teambit/node 1.0.220 → 1.0.221

package/dist/{preview-1712200750105.js → preview-1712287228511.js}

@@ -1,5 +1,5 @@
-import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_node@1.0.220/dist/node.composition.js';
-import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_node@1.0.220/dist/node.docs.mdx';
+import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_node@1.0.221/dist/node.composition.js';
+import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_node@1.0.221/dist/node.docs.mdx';
 
 export const compositions = [compositions_0];
 export const overview = [overview_0];

package/index.ts

@@ -0,0 +1,6 @@
+import jestConfig from './jest/jest.config';
+
+export { jestConfig };
+export type { NodeMain } from './node.main.runtime';
+export type { NodeAppOptions, DeployContext } from './node-app-options';
+export { NodeAspect, NodeAspect as default } from './node.aspect';

package/node-app-options.ts

@@ -0,0 +1,46 @@
+import { DeployFn, AppBuildResult } from '@teambit/application';
+
+export interface DeployContext extends AppBuildResult {
+  metadata: NodeAppMetadata;
+
+  /**
+   * @todo: remove this. it's already part of `metadata`.
+   * it's here only for backward compatibility.
+   */
+  mainFile?: string;
+}
+
+export interface NodeAppMetadata {
+  /**
+   * the main file of the app e.g: dist/app.js
+   */
+  mainFile: string;
+
+  /**
+   * the directory where the artifacts are saved.
+   */
+  artifactsDir: string;
+}
+
+export type NodeAppOptions = {
+  /**
+   * name of the application.
+   */
+  name: string;
+
+  /**
+   * path to entry file of the application.
+   * e.g: '/index.js'
+   */
+  entry: string;
+
+  /**
+   * ranges of ports to use to run the app server.
+   */
+  portRange?: number[];
+
+  /**
+   * deploy function.
+   */
+  deploy?: DeployFn;
+};

package/node.app-type.ts

@@ -0,0 +1,21 @@
+import { Logger } from '@teambit/logger';
+import { ApplicationType } from '@teambit/application';
+import { ReactEnv } from '@teambit/react';
+import { NodeEnv } from './node.env';
+import { NodeApp } from './node.application';
+import type { NodeAppOptions } from './node-app-options';
+
+export class NodeAppType implements ApplicationType<NodeAppOptions> {
+  constructor(readonly name: string, private nodeEnv: NodeEnv & ReactEnv, private logger: Logger) {}
+
+  createApp(options: NodeAppOptions) {
+    return new NodeApp(
+      options.name,
+      options.entry,
+      options.portRange || [3000, 4000],
+      this.nodeEnv,
+      this.logger,
+      options.deploy
+    );
+  }
+}

package/node.application.ts

@@ -0,0 +1,59 @@
+import { execFile } from 'child_process';
+import { parse, join } from 'path';
+import { Logger } from '@teambit/logger';
+import { ReactEnv } from '@teambit/react';
+import { Application, DeployFn, AppBuildContext, AppContext, ApplicationInstance } from '@teambit/application';
+import { Port } from '@teambit/toolbox.network.get-port';
+import { NodeEnv } from './node.env';
+import { DeployContext, NodeAppMetadata } from './node-app-options';
+
+export class NodeApp implements Application {
+  constructor(
+    readonly name: string,
+    readonly entry: string,
+    readonly portRange: number[],
+    readonly nodeEnv: NodeEnv & ReactEnv,
+    readonly logger: Logger,
+    readonly deploy?: DeployFn
+  ) {}
+
+  applicationType = 'node';
+
+  async run(context: AppContext): Promise<ApplicationInstance> {
+    const logger = this.logger;
+    const [from, to] = this.portRange;
+    const port = context.port || (await Port.getPort(from, to));
+    const child = execFile('node', [this.entry, port.toString()], (error) => {
+      if (error) {
+        // @todo: this is causing uncaughtException in the main process. a better way to handle this would be to use promise.
+        // however, since it expects to return a number, it would require a bigger refactor.
+        throw error as Error;
+      }
+    });
+    child.stdout?.on('data', function (data) {
+      logger.console(data.toString());
+    });
+
+    this.logger.console(`${context.appName} is listening on http://localhost:${port}`);
+    return {
+      appName: context.appName,
+      port,
+    };
+  }
+
+  async build(context: AppBuildContext): Promise<DeployContext> {
+    const { base } = parse(this.entry);
+    const { distDir } = this.nodeEnv.getCompiler();
+    const mainFile = join(distDir, base);
+    const metadata: NodeAppMetadata = {
+      mainFile,
+      artifactsDir: context.artifactsDir,
+    };
+    const deployContext: DeployContext = {
+      ...context, // @todo: is this needed?
+      mainFile, // @todo: remove this when possible. only metadata should be used.
+      metadata,
+    };
+    return deployContext;
+  }
+}

package/node.aspect.ts

@@ -0,0 +1,9 @@
+import { Aspect } from '@teambit/harmony';
+
+export const NodeAspect = Aspect.create({
+  id: 'teambit.harmony/node',
+  dependencies: [],
+  defaultConfig: {},
+});
+
+export default NodeAspect;

package/node.env.ts

@@ -0,0 +1,80 @@
+import { DependenciesEnv, PackageEnv, PipeServiceModifier, PipeServiceModifiersMap } from '@teambit/envs';
+import { VariantPolicyConfigObject } from '@teambit/dependency-resolver';
+import { TsConfigTransformer, TypescriptMain } from '@teambit/typescript';
+import { ReactMain } from '@teambit/react';
+import { Tester } from '@teambit/tester';
+import { BuildTask } from '@teambit/builder';
+import { COMPONENT_PREVIEW_STRATEGY_NAME, PreviewStrategyName } from '@teambit/preview';
+import { SchemaExtractor } from '@teambit/schema';
+import { TsConfigSourceFile } from 'typescript';
+
+export const NodeEnvType = 'node';
+
+type GetBuildPipeModifiers = PipeServiceModifiersMap & {
+  tsModifier?: PipeServiceModifier;
+};
+export class NodeEnv implements DependenciesEnv, PackageEnv {
+  constructor(protected tsAspect: TypescriptMain, protected reactAspect: ReactMain) {}
+
+  icon = 'https://static.bit.dev/extensions-icons/nodejs.svg';
+
+  getDependencies(): VariantPolicyConfigObject {
+    return {
+      devDependencies: {
+        '@types/jest': '26.0.20',
+        '@types/node': '12.20.4',
+        // This is added as dev dep since our jest file transformer uses babel plugins that require this to be installed
+        '@babel/runtime': '7.20.0',
+      },
+    };
+  }
+
+  getCompiler(transformers: TsConfigTransformer[] = [], tsModule) {
+    return this.reactAspect.reactEnv.getTsCjsCompiler('dev', transformers, tsModule);
+  }
+
+  /**
+   * returns the component build pipeline.
+   */
+  getBuildPipe(modifiers: GetBuildPipeModifiers = {}): BuildTask[] {
+    const tsTransformers: TsConfigTransformer[] =
+      (modifiers?.tsModifier?.transformers as any as TsConfigTransformer[]) || [];
+    const compilerTask = this.reactAspect.reactEnv.getCjsCompilerTask(tsTransformers, modifiers?.tsModifier?.module);
+
+    const pipeWithoutCompiler = this.reactAspect.reactEnv.getBuildPipeWithoutCompiler();
+    return [compilerTask, ...pipeWithoutCompiler];
+  }
+
+  /**
+   * returns a component tester.
+   */
+  getTester(jestConfigPath: string, jestModulePath?: string): Tester {
+    const config = jestConfigPath || require.resolve('./jest/jest.config');
+    return this.reactAspect.reactEnv.getCjsJestTester(config, jestModulePath);
+  }
+
+  getPreviewConfig() {
+    return {
+      strategyName: COMPONENT_PREVIEW_STRATEGY_NAME as PreviewStrategyName,
+      splitComponentBundle: false,
+    };
+  }
+
+  getPackageJsonProps() {
+    return this.tsAspect.getCjsPackageJsonProps();
+  }
+
+  getSchemaExtractor(tsconfig: TsConfigSourceFile, tsserverPath?: string, contextPath?: string): SchemaExtractor {
+    return this.tsAspect.createSchemaExtractor(
+      this.reactAspect.reactEnv.getTsConfig(tsconfig),
+      tsserverPath,
+      contextPath
+    );
+  }
+
+  async __getDescriptor() {
+    return {
+      type: NodeEnvType,
+    };
+  }
+}

package/node.main.runtime.ts

@@ -0,0 +1,190 @@
+import { Harmony } from '@teambit/harmony';
+import { EnvPolicyConfigObject } from '@teambit/dependency-resolver';
+import { TsConfigSourceFile } from 'typescript';
+import { TsCompilerOptionsWithoutTsConfig, TypescriptAspect, TypescriptMain } from '@teambit/typescript';
+import { ApplicationAspect, ApplicationMain } from '@teambit/application';
+import { merge } from 'lodash';
+import { LoggerAspect, LoggerMain } from '@teambit/logger';
+import { MainRuntime } from '@teambit/cli';
+import { GeneratorAspect, GeneratorMain } from '@teambit/generator';
+import { BuildTask } from '@teambit/builder';
+import { ComponentID } from '@teambit/component-id';
+import { WorkerAspect, WorkerMain } from '@teambit/worker';
+import { Compiler } from '@teambit/compiler';
+import { PackageJsonProps } from '@teambit/pkg';
+import { EnvsAspect, EnvsMain, EnvTransformer, Environment, EnvContext } from '@teambit/envs';
+import { ReactAspect, ReactEnv, ReactMain, UseTypescriptModifiers } from '@teambit/react';
+import { NodeAspect } from './node.aspect';
+import { NodeEnv } from './node.env';
+import { getTemplates } from './node.templates';
+import { NodeAppType } from './node.app-type';
+
+export class NodeMain {
+  constructor(
+    private react: ReactMain,
+
+    private tsAspect: TypescriptMain,
+
+    readonly nodeEnv: NodeEnv,
+
+    private envs: EnvsMain
+  ) {}
+
+  icon() {
+    return 'https://static.bit.dev/extensions-icons/nodejs.svg';
+  }
+
+  /**
+   * @deprecated use useTypescript()
+   * override the TS config of the environment.
+   */
+  overrideTsConfig: (
+    tsconfig: TsConfigSourceFile,
+    compilerOptions?: Partial<TsCompilerOptionsWithoutTsConfig>,
+    tsModule?: any
+  ) => EnvTransformer = this.react.overrideTsConfig.bind(this.react);
+
+  /**
+   * override the jest config of the environment.
+   */
+  overrideJestConfig = this.react.overrideJestConfig.bind(this.react);
+
+  /**
+   * override the env build pipeline.
+   */
+  overrideBuildPipe: (tasks: BuildTask[]) => EnvTransformer = this.react.overrideBuildPipe.bind(this.react);
+
+  /**
+   * override the env compilers list.
+   */
+  overrideCompiler: (compiler: Compiler) => EnvTransformer = this.react.overrideCompiler.bind(this.react);
+
+  /**
+   * override the env compilers tasks in the build pipe.
+   */
+  overrideCompilerTasks: (tasks: BuildTask[]) => EnvTransformer = this.react.overrideCompilerTasks.bind(this.react);
+
+  /**
+   * @deprecated use useTypescript()
+   * override the build ts config.
+   */
+  overrideBuildTsConfig: (
+    tsconfig: any,
+    compilerOptions?: Partial<TsCompilerOptionsWithoutTsConfig>
+  ) => EnvTransformer = this.react.overrideBuildTsConfig.bind(this.react);
+
+  /**
+   * override package json properties.
+   */
+  overridePackageJsonProps: (props: PackageJsonProps) => EnvTransformer = this.react.overridePackageJsonProps.bind(
+    this.react
+  );
+
+  /**
+   * @deprecated - use useWebpack
+   * override the preview config in the env.
+   */
+  overridePreviewConfig = this.react.overridePreviewConfig.bind(this.react);
+
+  /**
+   * @deprecated - use useWebpack
+   * override the dev server configuration.
+   */
+  overrideDevServerConfig = this.react.overrideDevServerConfig.bind(this.react);
+
+  /**
+   * override the env's typescript config for both dev and build time.
+   * Replaces both overrideTsConfig (devConfig) and overrideBuildTsConfig (buildConfig)
+   */
+  useTypescript(modifiers?: UseTypescriptModifiers, tsModule?: any) {
+    const overrides: any = {};
+    const devTransformers = modifiers?.devConfig;
+    if (devTransformers) {
+      overrides.getCompiler = () => this.nodeEnv.getCompiler(devTransformers, tsModule);
+    }
+    const buildTransformers = modifiers?.buildConfig;
+    if (buildTransformers) {
+      const buildPipeModifiers = {
+        tsModifier: {
+          transformers: buildTransformers,
+          module: tsModule,
+        },
+      };
+      overrides.getBuildPipe = () => this.nodeEnv.getBuildPipe(buildPipeModifiers);
+    }
+    return this.envs.override(overrides);
+  }
+
+  /**
+   * override the env's dev server and preview webpack configurations.
+   * Replaces both overrideDevServerConfig and overridePreviewConfig
+   */
+  useWebpack = this.react.useWebpack.bind(this.react);
+
+  /**
+   * An API to mutate the prettier config
+   */
+  usePrettier = this.react.usePrettier.bind(this.react);
+
+  /**
+   * An API to mutate the eslint config
+   */
+  useEslint = this.react.useEslint.bind(this.react);
+
+  /**
+   * override the dependency configuration of the component environment.
+   */
+  overrideDependencies(dependencyPolicy: EnvPolicyConfigObject) {
+    return this.envs.override({
+      getDependencies: () => merge(this.nodeEnv.getDependencies(), dependencyPolicy),
+    });
+  }
+
+  overrideMounter = this.react.overrideMounter.bind(this.react);
+
+  /**
+   * create a new composition of the node environment.
+   */
+  compose(transformers: EnvTransformer[], targetEnv: Environment = {}) {
+    return this.envs.compose(this.envs.merge(targetEnv, this.nodeEnv), transformers);
+  }
+
+  static runtime = MainRuntime;
+  static dependencies = [
+    LoggerAspect,
+    EnvsAspect,
+    ApplicationAspect,
+    ReactAspect,
+    GeneratorAspect,
+    TypescriptAspect,
+    WorkerAspect,
+  ];
+
+  static async provider(
+    [loggerAspect, envs, application, react, generator, tsAspect, workerMain]: [
+      LoggerMain,
+      EnvsMain,
+      ApplicationMain,
+      ReactMain,
+      GeneratorMain,
+      TypescriptMain,
+      WorkerMain
+    ],
+    config,
+    slots,
+    harmony: Harmony
+  ) {
+    const logger = loggerAspect.createLogger(NodeAspect.id);
+    const nodeEnv = envs.merge<NodeEnv, ReactEnv>(new NodeEnv(tsAspect, react), react.reactEnv);
+    envs.registerEnv(nodeEnv);
+    const nodeAppType = new NodeAppType('node-app', nodeEnv, logger);
+    application.registerAppType(nodeAppType);
+    if (generator) {
+      const envContext = new EnvContext(ComponentID.fromString(ReactAspect.id), loggerAspect, workerMain, harmony);
+      generator.registerComponentTemplate(getTemplates(envContext));
+    }
+    return new NodeMain(react, tsAspect, nodeEnv, envs);
+  }
+}
+
+NodeAspect.addRuntime(NodeMain);

package/node.templates.ts

@@ -0,0 +1,29 @@
+import {
+  NodeModuleTemplate,
+  NodeAppTemplate,
+  PlatformTemplate,
+  GraphQLServerTemplate,
+  EntityTemplate,
+  ExpressAppTemplate,
+  NodeEnvTemplate,
+  BitAppTemplate,
+} from '@bitdev/node.generators.node-templates';
+
+import { EnvContext } from '@teambit/envs';
+import { ComponentTemplate, TemplateList } from '@teambit/generator';
+
+const templateListHandler = TemplateList.from([
+  NodeModuleTemplate.from({ env: 'bitdev.node/node-env' }),
+  GraphQLServerTemplate.from({ env: 'bitdev.node/node-env' }),
+  EntityTemplate.from({ env: 'bitdev.node/node-env' }),
+  ExpressAppTemplate.from({ env: 'bitdev.node/node-env' }),
+  BitAppTemplate.from({ env: 'bitdev.node/node-env' }),
+  PlatformTemplate.from({ env: 'bitdev.node/node-env' }),
+  NodeAppTemplate.from({ env: 'bitdev.node/node-env' }),
+  NodeEnvTemplate.from({}),
+]);
+
+export function getTemplates(envContext: EnvContext): ComponentTemplate[] {
+  const templateList = templateListHandler(envContext);
+  return templateList.compute();
+}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/node",
-  "version": "1.0.220",
+  "version": "1.0.221",
   "homepage": "https://bit.cloud/teambit/harmony/node",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.harmony",
     "name": "node",
-    "version": "1.0.220"
+    "version": "1.0.221"
   },
   "dependencies": {
     "typescript": "5.3.3",
@@ -27,24 +27,24 @@
     "@teambit/component-id": "1.2.0",
     "@bitdev/node.generators.node-templates": "1.0.15",
     "@teambit/design.ui.empty-box": "0.0.363",
-    "@teambit/application": "1.0.220",
-    "@teambit/logger": "0.0.951",
-    "@teambit/react": "1.0.220",
+    "@teambit/application": "1.0.221",
+    "@teambit/logger": "0.0.952",
+    "@teambit/react": "1.0.221",
     "@teambit/toolbox.network.get-port": "1.0.6",
-    "@teambit/builder": "1.0.220",
-    "@teambit/dependency-resolver": "1.0.220",
-    "@teambit/envs": "1.0.220",
-    "@teambit/preview": "1.0.220",
-    "@teambit/schema": "1.0.220",
-    "@teambit/tester": "1.0.220",
-    "@teambit/typescript": "1.0.220",
-    "@teambit/cli": "0.0.858",
-    "@teambit/compiler": "1.0.220",
-    "@teambit/generator": "1.0.221",
-    "@teambit/pkg": "1.0.220",
-    "@teambit/worker": "0.0.1162",
-    "@teambit/compositions": "1.0.220",
-    "@teambit/ui": "1.0.220"
+    "@teambit/builder": "1.0.221",
+    "@teambit/dependency-resolver": "1.0.221",
+    "@teambit/envs": "1.0.221",
+    "@teambit/preview": "1.0.221",
+    "@teambit/schema": "1.0.221",
+    "@teambit/tester": "1.0.221",
+    "@teambit/typescript": "1.0.221",
+    "@teambit/cli": "0.0.859",
+    "@teambit/compiler": "1.0.221",
+    "@teambit/generator": "1.0.222",
+    "@teambit/pkg": "1.0.221",
+    "@teambit/worker": "0.0.1163",
+    "@teambit/compositions": "1.0.221",
+    "@teambit/ui": "1.0.221"
   },
   "devDependencies": {
     "@types/react": "^17.0.8",