@teambit/application 0.0.197 → 0.0.201

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/application",
-  "version": "0.0.197",
+  "version": "0.0.201",
   "homepage": "https://bit.dev/teambit/harmony/application",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.harmony",
     "name": "application",
-    "version": "0.0.197"
+    "version": "0.0.201"
   },
   "dependencies": {
     "chalk": "2.4.2",
@@ -16,14 +16,14 @@
     "ink": "3.0.8",
     "@babel/runtime": "7.12.18",
     "core-js": "^3.0.0",
-    "@teambit/envs": "0.0.555",
-    "@teambit/cli-table": "0.0.9",
-    "@teambit/cli": "0.0.386",
-    "@teambit/aspect-loader": "0.0.555",
-    "@teambit/builder": "0.0.555",
-    "@teambit/component": "0.0.555",
-    "@teambit/logger": "0.0.471",
-    "@teambit/isolator": "0.0.555"
+    "@teambit/envs": "0.0.559",
+    "@teambit/cli-table": "0.0.12",
+    "@teambit/cli": "0.0.389",
+    "@teambit/aspect-loader": "0.0.559",
+    "@teambit/builder": "0.0.559",
+    "@teambit/component": "0.0.559",
+    "@teambit/logger": "0.0.474",
+    "@teambit/isolator": "0.0.559"
   },
   "devDependencies": {
     "@types/lodash": "4.14.165",
@@ -35,7 +35,7 @@
     "@types/node": "12.20.4"
   },
   "peerDependencies": {
-    "@teambit/legacy": "1.0.172",
+    "@teambit/legacy": "1.0.175",
     "react-dom": "^16.8.0 || ^17.0.0",
     "react": "^16.8.0 || ^17.0.0"
   },
@@ -63,12 +63,27 @@
         "react": "-"
       },
       "peerDependencies": {
-        "@teambit/legacy": "1.0.172",
+        "@teambit/legacy": "1.0.175",
         "react-dom": "^16.8.0 || ^17.0.0",
         "react": "^16.8.0 || ^17.0.0"
       }
     }
   },
+  "files": [
+    "dist",
+    "!dist/tsconfig.tsbuildinfo",
+    "**/*.md",
+    "**/*.mdx",
+    "**/*.js",
+    "**/*.json",
+    "**/*.sass",
+    "**/*.scss",
+    "**/*.less",
+    "**/*.css",
+    "**/*.css",
+    "**/*.jpeg",
+    "**/*.gif"
+  ],
   "private": false,
   "engines": {
     "node": ">=12.22.0"

package/tsconfig.json

@@ -15,9 +15,9 @@
     "skipLibCheck": true,
     "moduleResolution": "node",
     "esModuleInterop": true,
-    "outDir": "dist",
     "composite": true,
     "emitDeclarationOnly": true,
+    "outDir": "dist",
     "experimentalDecorators": true,
     "emitDecoratorMetadata": true,
     "allowSyntheticDefaultImports": true,

package/app-context.ts

@@ -1,8 +0,0 @@
-import { ExecutionContext } from '@teambit/envs';
-
-export interface AppContext extends ExecutionContext {
-  /**
-   * determine whether to serve the application in dev mode.
-   */
-  dev: boolean;
-}

package/app-list.cmd.tsx

@@ -1,34 +0,0 @@
-import { Command, CommandOptions } from '@teambit/cli';
-// import { Logger } from '@teambit/logger';
-import chalk from 'chalk';
-import { CLITable } from '@teambit/cli-table';
-import { ApplicationMain } from './application.main.runtime';
-
-/**
- * @deprecated use AppListCmd class
- */
-export class AppListCmdDeprecated implements Command {
-  name = 'app-list';
-  description = 'DEPRECATED. use "bit app list"';
-  alias = '';
-  group = 'apps';
-  options = [['j', 'json', 'return the component data in json format']] as CommandOptions;
-
-  constructor(private applicationAspect: ApplicationMain) {}
-
-  async report(args: [string], { json }: { json: boolean }) {
-    const apps = this.applicationAspect.listApps();
-    if (json) return JSON.stringify(apps, null, 2);
-    const deprecationStr = `this command is deprecated. please use "bit app list" instead\n`;
-    // eslint-disable-next-line no-console
-    console.log(chalk.red());
-    if (!apps.length) return chalk.yellow(`${deprecationStr}no apps found`);
-
-    const rows = apps.map((app) => {
-      return [app.name];
-    });
-
-    const table = new CLITable([], rows);
-    return deprecationStr + table.render();
-  }
-}

package/app-server.ts

@@ -1,9 +0,0 @@
-import { Application } from './application';
-
-export class AppServer {
-  constructor(private app: Application) {}
-
-  get name() {
-    return this.app.name;
-  }
-}

package/app-type.plugin.ts

@@ -1,14 +0,0 @@
-import { PluginDefinition } from '@teambit/aspect-loader';
-import { MainRuntime } from '@teambit/cli';
-import { ApplicationType } from './application-type';
-import { ApplicationSlot } from './application.main.runtime';
-
-export class AppTypePlugin implements PluginDefinition {
-  constructor(readonly pattern: string, private appType: ApplicationType<unknown>, private appSlot: ApplicationSlot) {}
-
-  runtimes = [MainRuntime.name];
-
-  register(object: any) {
-    this.appSlot.register([this.appType.createApp(object)]);
-  }
-}

package/app.cmd.ts

@@ -1,44 +0,0 @@
-// eslint-disable-next-line max-classes-per-file
-import { Command, CommandOptions } from '@teambit/cli';
-// import { Logger } from '@teambit/logger';
-import chalk from 'chalk';
-import { CLITable } from '@teambit/cli-table';
-import { ApplicationMain } from './application.main.runtime';
-
-export class AppListCmd implements Command {
-  name = 'list';
-  description = 'list all registered applications';
-  alias = '';
-  group = 'apps';
-  options = [['j', 'json', 'return the component data in json format']] as CommandOptions;
-
-  constructor(private applicationAspect: ApplicationMain) {}
-
-  async report(args: [string], { json }: { json: boolean }) {
-    const apps = this.applicationAspect.listApps();
-    if (json) return JSON.stringify(apps, null, 2);
-    if (!apps.length) return chalk.yellow('no apps found');
-
-    const rows = apps.map((app) => {
-      return [app.name];
-    });
-
-    const table = new CLITable([], rows);
-    return table.render();
-  }
-}
-
-export class AppCmd implements Command {
-  name = 'app <sub-command>';
-  description = 'manage applications';
-  alias = '';
-  group = 'apps';
-  commands: Command[] = [];
-  options = [] as CommandOptions;
-
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  async report(args: [string]) {
-    // it should never be here. Yargs throws an error before reaching this method.
-    return `Please specify a sub-command`;
-  }
-}

package/app.plugin.ts

@@ -1,15 +0,0 @@
-import { PluginDefinition } from '@teambit/aspect-loader';
-import { MainRuntime } from '@teambit/cli';
-import { ApplicationSlot } from './application.main.runtime';
-
-export class AppPlugin implements PluginDefinition {
-  constructor(private appSlot: ApplicationSlot) {}
-
-  pattern = '*.app.*';
-
-  runtimes = [MainRuntime.name];
-
-  register(object: any) {
-    return this.appSlot.register([object]);
-  }
-}

package/application-type.ts

@@ -1,13 +0,0 @@
-import { Application } from './application';
-
-export interface ApplicationType<T> {
-  /**
-   * name of the type of the app. e.g. `react-app`
-   */
-  name: string;
-
-  /**
-   * a function that creates the app instance.
-   */
-  createApp(options: T): Application;
-}

package/application.aspect.ts

@@ -1,5 +0,0 @@
-import { Aspect } from '@teambit/harmony';
-
-export const ApplicationAspect = Aspect.create({
-  id: 'teambit.harmony/application',
-});

package/application.main.runtime.ts

@@ -1,203 +0,0 @@
-import { MainRuntime, CLIMain, CLIAspect } from '@teambit/cli';
-import { flatten } from 'lodash';
-import { AspectLoaderMain, AspectLoaderAspect } from '@teambit/aspect-loader';
-import { Slot, SlotRegistry } from '@teambit/harmony';
-import { BuilderAspect, BuilderMain } from '@teambit/builder';
-import { LoggerAspect, LoggerMain } from '@teambit/logger';
-import { EnvsAspect, EnvsMain } from '@teambit/envs';
-import ComponentAspect, { ComponentMain, ComponentID } from '@teambit/component';
-import { ApplicationType } from './application-type';
-import { Application } from './application';
-import { DeploymentProvider } from './deployment-provider';
-import { AppNotFound } from './exceptions';
-import { ApplicationAspect } from './application.aspect';
-import { AppListCmdDeprecated } from './app-list.cmd';
-import { DeployTask } from './deploy.task';
-import { RunCmd } from './run.cmd';
-import { AppService } from './application.service';
-import { AppCmd, AppListCmd } from './app.cmd';
-import { AppPlugin } from './app.plugin';
-import { AppTypePlugin } from './app-type.plugin';
-
-export type ApplicationTypeSlot = SlotRegistry<ApplicationType<unknown>[]>;
-export type ApplicationSlot = SlotRegistry<Application[]>;
-export type DeploymentProviderSlot = SlotRegistry<DeploymentProvider[]>;
-
-export type ApplicationAspectConfig = {};
-
-export type ServeAppOptions = {
-  /**
-   * default port range used to serve applications.
-   */
-  defaultPortRange?: number[];
-
-  /**
-   * determine whether to start the application in dev mode.
-   */
-  dev: boolean;
-};
-
-export class ApplicationMain {
-  constructor(
-    private appSlot: ApplicationSlot,
-    private appTypeSlot: ApplicationTypeSlot,
-    private deploymentProviderSlot: DeploymentProviderSlot,
-    private envs: EnvsMain,
-    private componentAspect: ComponentMain,
-    private appService: AppService,
-    private aspectLoader: AspectLoaderMain
-  ) {}
-
-  /**
-   * register a new app.
-   */
-  registerApp(app: Application) {
-    this.appSlot.register([app]);
-    return this;
-  }
-
-  /**
-   * list all registered apps.
-   */
-  listApps(): Application[] {
-    return flatten(this.appSlot.values());
-  }
-
-  /**
-   * register new deployment provider like netlify, cloudflare pages or custom deployment.
-   */
-  registerDeploymentProvider(provider: DeploymentProvider) {
-    this.deploymentProviderSlot.register([provider]);
-    return this;
-  }
-
-  /**
-   * list all deployment providers
-   */
-  listProviders() {
-    return flatten(this.deploymentProviderSlot.values());
-  }
-
-  /**
-   * get an app.
-   */
-  getApp(appName: string): Application | undefined {
-    const apps = this.listApps();
-    return apps.find((app) => app.name === appName);
-  }
-
-  /**
-   * registers a new app and sets a plugin for it.
-   */
-  registerAppType<T>(appType: ApplicationType<T>) {
-    const plugin = new AppTypePlugin(`*.${appType.name}.*`, appType, this.appSlot);
-    this.aspectLoader.registerPlugins([plugin]);
-    this.appTypeSlot.register([appType]);
-    return this;
-  }
-
-  /**
-   * get an app AspectId.
-   */
-  getAppAspect(appName: string): string | undefined {
-    return this.appSlot.toArray().find(([, apps]) => apps.find((app) => app.name === appName))?.[0];
-  }
-
-  /**
-   * get app to throw.
-   */
-  getAppOrThrow(appName: string) {
-    const app = this.getApp(appName);
-    if (!app) throw new AppNotFound(appName);
-    return app;
-  }
-
-  private computeOptions(opts: Partial<ServeAppOptions>) {
-    const defaultOpts: ServeAppOptions = {
-      dev: false,
-      defaultPortRange: [3100, 3500],
-    };
-
-    return {
-      defaultOpts,
-      ...opts,
-    };
-  }
-
-  async runApp(appName: string, options: Partial<ServeAppOptions> = {}) {
-    const app = this.getAppOrThrow(appName);
-    this.computeOptions(options);
-    const context = await this.createAppContext(appName);
-    if (!context) throw new AppNotFound(appName);
-    const port = await app.run(context);
-    return { app, port };
-  }
-
-  /**
-   * get the component ID of a certain app.
-   */
-  getAppIdOrThrow(appName: string) {
-    const maybeApp = this.appSlot.toArray().find(([, apps]) => {
-      return apps.find((app) => app.name === appName);
-    });
-
-    if (!maybeApp) throw new AppNotFound(appName);
-    return ComponentID.fromString(maybeApp[0]);
-  }
-
-  private async createAppContext(appName: string) {
-    const host = this.componentAspect.getHost();
-    const components = await host.list();
-    const id = this.getAppIdOrThrow(appName);
-    const component = components.find((c) => c.id.isEqual(id));
-    if (!component) throw new AppNotFound(appName);
-
-    const env = await this.envs.createEnvironment([component]);
-    const res = await env.run(this.appService);
-    return res.results[0].data;
-  }
-
-  static runtime = MainRuntime;
-  static dependencies = [CLIAspect, LoggerAspect, BuilderAspect, EnvsAspect, ComponentAspect, AspectLoaderAspect];
-
-  static slots = [
-    Slot.withType<ApplicationType<unknown>[]>(),
-    Slot.withType<Application[]>(),
-    Slot.withType<DeploymentProvider[]>(),
-  ];
-
-  static async provider(
-    [cli, loggerAspect, builder, envs, component, aspectLoader]: [
-      CLIMain,
-      LoggerMain,
-      BuilderMain,
-      EnvsMain,
-      ComponentMain,
-      AspectLoaderMain
-    ],
-    config: ApplicationAspectConfig,
-    [appTypeSlot, appSlot, deploymentProviderSlot]: [ApplicationTypeSlot, ApplicationSlot, DeploymentProviderSlot]
-  ) {
-    const logger = loggerAspect.createLogger(ApplicationAspect.id);
-    const appService = new AppService();
-    const application = new ApplicationMain(
-      appSlot,
-      appTypeSlot,
-      deploymentProviderSlot,
-      envs,
-      component,
-      appService,
-      aspectLoader
-    );
-    const appCmd = new AppCmd();
-    appCmd.commands = [new AppListCmd(application)];
-    aspectLoader.registerPlugins([new AppPlugin(appSlot)]);
-    builder.registerTagTasks([new DeployTask(application)]);
-    cli.registerGroup('apps', 'Applications');
-    cli.register(new RunCmd(application, logger), new AppListCmdDeprecated(application), appCmd);
-
-    return application;
-  }
-}
-
-ApplicationAspect.addRuntime(ApplicationMain);

package/application.service.ts

@@ -1,13 +0,0 @@
-import { EnvService, ExecutionContext } from '@teambit/envs';
-
-export class AppService implements EnvService<any> {
-  name = 'app';
-
-  async run(context: ExecutionContext) {
-    const appContext = Object.assign(context, {
-      dev: true,
-    });
-
-    return appContext;
-  }
-}

package/application.ts

@@ -1,32 +0,0 @@
-import { BuildContext } from '@teambit/builder';
-import { Capsule } from '@teambit/isolator';
-import { AppContext } from './app-context';
-import { DeployContext } from './deploy-context';
-
-export interface Application {
-  /**
-   * name of the application. e.g. ripple-ci.
-   */
-  name: string;
-
-  /**
-   * run the application.
-   */
-  run(context: AppContext): Promise<number>;
-
-  /**
-   * build the application.
-   */
-  build(context: BuildContext, aspectId: string, capsule: Capsule): Promise<DeployContext>;
-
-  /**
-   * application deployment. this is a build task.
-   */
-  deploy?(context: BuildContext): Promise<void>;
-
-  /**
-   * prerender routes of application (will create static file for the route)
-   * e.g ['/plugins', '/learn', '/docs/quick-start]
-   */
-  prerenderRoutes?: string[];
-}

package/deploy-context.ts

@@ -1,11 +0,0 @@
-import { BuildContext } from '@teambit/builder';
-
-export interface DeployContext extends BuildContext {
-  applicationType: string;
-
-  aspectId: string;
-
-  /* the build output */
-
-  publicDir: string | null;
-}

package/deploy.task.ts

@@ -1,49 +0,0 @@
-import mapSeries from 'p-map-series';
-import { Capsule } from '@teambit/isolator';
-import { BuildTask, BuiltTaskResult, BuildContext, ComponentResult } from '@teambit/builder';
-import { ComponentID } from '@teambit/component';
-import { ApplicationAspect } from './application.aspect';
-import { ApplicationMain } from './application.main.runtime';
-import { DeployContext } from './deploy-context';
-
-export const BUILD_UI_TASK = 'build_ui_application';
-
-export class DeployTask implements BuildTask {
-  name = BUILD_UI_TASK;
-  aspectId = ApplicationAspect.id;
-
-  constructor(private application: ApplicationMain) {}
-
-  async execute(context: BuildContext): Promise<BuiltTaskResult> {
-    const apps = this.application.listApps();
-    const componentsResultsUi = await mapSeries(
-      apps,
-      async (app): Promise<ComponentResult | undefined> => {
-        const aspectId = this.application.getAppAspect(app.name);
-        if (!aspectId) return undefined;
-        const capsules = context.capsuleNetwork.seedersCapsules;
-        const capsule = this.getCapsule(capsules, aspectId);
-        if (!capsule) return undefined;
-        const deployContext = await app.build(context, aspectId, capsule);
-        if (!deployContext.publicDir) return undefined;
-        if (app.deploy) await app.deploy(deployContext);
-        await this.deployToProviders(deployContext);
-        return { component: capsule.component, metadata: { publicDir: deployContext.publicDir } };
-      }
-    );
-
-    return {
-      componentsResults: componentsResultsUi.flatMap((f) => (f ? [f] : [])),
-    };
-  }
-
-  private getCapsule(capsules: Capsule[], aspectId: string) {
-    const aspectCapsuleId = ComponentID.fromString(aspectId).toStringWithoutVersion();
-    return capsules.find((capsule) => capsule.component.id.toStringWithoutVersion() === aspectCapsuleId);
-  }
-
-  private async deployToProviders(deployContext: DeployContext) {
-    const providers = this.application.listProviders();
-    await mapSeries(providers, async (provider) => provider.deploy(deployContext));
-  }
-}

package/deployment-provider.ts

@@ -1,5 +0,0 @@
-import { DeployContext } from './deploy-context';
-
-export interface DeploymentProvider {
-  deploy(context: DeployContext): Promise<void>;
-}

package/exceptions/app-not-found.ts

@@ -1,5 +0,0 @@
-export class AppNotFound extends Error {
-  constructor(appName: string) {
-    super(`app ${appName} was not found`);
-  }
-}

package/exceptions/index.ts

@@ -1 +0,0 @@
-export { AppNotFound } from './app-not-found';

package/index.ts

@@ -1,7 +0,0 @@
-export { ApplicationAspect } from './application.aspect';
-export type { ApplicationMain } from './application.main.runtime';
-export type { Application } from './application';
-export { AppContext } from './app-context';
-export { DeploymentProvider } from './deployment-provider';
-export { ApplicationType } from './application-type';
-export { DeployContext } from './deploy-context';

package/run.cmd.tsx

@@ -1,55 +0,0 @@
-import React from 'react';
-import { Command, CommandOptions } from '@teambit/cli';
-import { Text } from 'ink';
-import { Logger } from '@teambit/logger';
-import { ApplicationMain } from './application.main.runtime';
-
-export class RunCmd implements Command {
-  name = 'run <app>';
-  description = 'run an application';
-  alias = 'c';
-  group = 'apps';
-  options = [
-    ['d', 'dev', 'start the application in dev mode.'],
-    ['v', 'verbose', 'showing verbose output for inspection and prints stack trace'],
-  ] as CommandOptions;
-
-  constructor(
-    /**
-     * access to the extension instance.
-     */
-    private application: ApplicationMain,
-
-    private logger: Logger
-  ) {}
-
-  async report(
-    [appName]: [string],
-    { dev }: { dev: boolean; port: string; rebuild: boolean; verbose: boolean; suppressBrowserLaunch: boolean }
-  ): Promise<string> {
-    this.logger.off();
-
-    const { port } = await this.application.runApp(appName, {
-      dev,
-    });
-
-    return `${appName} app is running on http://localhost:${port}`;
-  }
-
-  async render(
-    [appName]: [string],
-    { dev }: { dev: boolean; rebuild: boolean; verbose: boolean; suppressBrowserLaunch: boolean }
-  ): Promise<React.ReactElement> {
-    // remove wds logs until refactoring webpack to a worker through the Worker aspect.
-    const { port } = await this.application.runApp(appName, {
-      dev,
-    });
-
-    return (
-      <Text>
-        {appName} app is running on http://localhost:{port}
-      </Text>
-    );
-    // return <UIServerConsole appName={appName} futureUiServer={uiServer} />;
-  }
-}

package/types/asset.d.ts

@@ -1,29 +0,0 @@
-declare module '*.png' {
-  const value: any;
-  export = value;
-}
-declare module '*.svg' {
-  import type { FunctionComponent, SVGProps } from 'react';
-
-  export const ReactComponent: FunctionComponent<SVGProps<SVGSVGElement> & { title?: string }>;
-  const src: string;
-  export default src;
-}
-
-// @TODO Gilad
-declare module '*.jpg' {
-  const value: any;
-  export = value;
-}
-declare module '*.jpeg' {
-  const value: any;
-  export = value;
-}
-declare module '*.gif' {
-  const value: any;
-  export = value;
-}
-declare module '*.bmp' {
-  const value: any;
-  export = value;
-}

package/types/style.d.ts

@@ -1,42 +0,0 @@
-declare module '*.module.css' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-declare module '*.module.scss' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-declare module '*.module.sass' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.module.less' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.less' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.css' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.sass' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.scss' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.mdx' {
-  const component: any;
-  export default component;
-}