@teambit/preview 0.0.555 → 0.0.559

package/preview.task.ts

@@ -1,91 +0,0 @@
-import { resolve, join } from 'path';
-import { ExecutionContext } from '@teambit/envs';
-import { BuildContext, BuiltTaskResult, BuildTask, TaskLocation } from '@teambit/builder';
-import { Bundler, BundlerContext, BundlerMain, Target } from '@teambit/bundler';
-import { Compiler } from '@teambit/compiler';
-import { ComponentMap } from '@teambit/component';
-import { Capsule } from '@teambit/isolator';
-import { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';
-import { flatten } from 'lodash';
-import { PreviewDefinition } from './preview-definition';
-import { PreviewMain } from './preview.main.runtime';
-
-export class PreviewTask implements BuildTask {
-  constructor(
-    /**
-     * bundler extension.
-     */
-    private bundler: BundlerMain,
-
-    /**
-     * preview extension.
-     */
-    private preview: PreviewMain
-  ) {}
-
-  aspectId = 'teambit.preview/preview';
-  name = 'GeneratePreview';
-  location: TaskLocation = 'end';
-
-  async execute(context: BuildContext): Promise<BuiltTaskResult> {
-    const defs = this.preview.getDefs();
-    const url = `/preview/${context.envRuntime.id}`;
-    const bundlingStrategy = this.preview.getBundlingStrategy();
-
-    const targets: Target[] = await bundlingStrategy.computeTargets(context, defs, this);
-
-    const bundlerContext: BundlerContext = Object.assign(context, {
-      targets,
-      entry: [],
-      publicPath: this.getPreviewDirectory(context),
-      rootPath: url,
-    });
-
-    const bundler: Bundler = await context.env.getBundler(bundlerContext, []);
-    const bundlerResults = await bundler.run();
-
-    return bundlingStrategy.computeResults(bundlerContext, bundlerResults, this);
-  }
-
-  async computePaths(capsule: Capsule, defs: PreviewDefinition[], context: BuildContext): Promise<string[]> {
-    const previewMain = await this.preview.writePreviewRuntime(context);
-
-    const moduleMapsPromise = defs.map(async (previewDef) => {
-      const moduleMap = await previewDef.getModuleMap([capsule.component]);
-      const paths = this.getPathsFromMap(capsule, moduleMap, context);
-      const template = previewDef.renderTemplatePath ? await previewDef.renderTemplatePath(context) : 'undefined';
-
-      const link = this.preview.writeLink(
-        previewDef.prefix,
-        paths,
-        previewDef.renderTemplatePath ? await previewDef.renderTemplatePath(context) : undefined,
-        capsule.path
-      );
-
-      const files = flatten(paths.toArray().map(([, file]) => file)).concat([link]);
-
-      if (template) return files.concat([template]);
-      return files;
-    });
-
-    const moduleMaps = await Promise.all(moduleMapsPromise);
-
-    return flatten(moduleMaps.concat([previewMain]));
-  }
-
-  getPreviewDirectory(context: ExecutionContext) {
-    const outputPath = resolve(`${context.id}/public`);
-    return outputPath;
-  }
-
-  getPathsFromMap(
-    capsule: Capsule,
-    moduleMap: ComponentMap<AbstractVinyl[]>,
-    context: BuildContext
-  ): ComponentMap<string[]> {
-    const compiler: Compiler = context.env.getCompiler(context);
-    return moduleMap.map((files) => {
-      return files.map((file) => join(capsule.path, compiler.getDistPathBySrcPath(file.relative)));
-    });
-  }
-}

package/rendering-context.ts

@@ -1,12 +0,0 @@
-import { RenderingContextSlot } from './preview.preview.runtime';
-
-export class RenderingContext {
-  constructor(private contexts: RenderingContextSlot) {}
-
-  /**
-   * obtain rendering context of a specific aspect.
-   */
-  get(aspectId: string) {
-    return this.contexts.get(aspectId)?.();
-  }
-}

package/strategies/component-strategy.ts

@@ -1,34 +0,0 @@
-import { BuildContext } from '@teambit/builder';
-import { Target, BundlerResult, BundlerContext } from '@teambit/bundler';
-import { BundlingStrategy } from '../bundling-strategy';
-import { PreviewDefinition } from '../preview-definition';
-import { PreviewTask } from '../preview.task';
-
-export class ComponentBundlingStrategy implements BundlingStrategy {
-  name = 'component';
-
-  computeTargets(context: BuildContext, previewDefs: PreviewDefinition[], previewTask: PreviewTask): Promise<Target[]> {
-    return Promise.all(
-      context.capsuleNetwork.graphCapsules.map(async (capsule) => {
-        return {
-          entries: await previewTask.computePaths(capsule, previewDefs, context),
-          components: [capsule.component],
-          outputPath: capsule.path,
-        };
-      })
-    );
-  }
-
-  async computeResults(context: BundlerContext, results: BundlerResult[], previewTask: PreviewTask) {
-    return {
-      componentsResults: results.map((result) => {
-        return {
-          errors: result.errors,
-          component: result.components[0],
-          warning: result.warnings,
-        };
-      }),
-      artifacts: [{ name: 'preview', globPatterns: [previewTask.getPreviewDirectory(context)] }],
-    };
-  }
-}

package/strategies/env-strategy.ts

@@ -1,118 +0,0 @@
-import { join, resolve } from 'path';
-import { existsSync, mkdirpSync } from 'fs-extra';
-import { flatten } from 'lodash';
-import { ComponentMap } from '@teambit/component';
-import { Compiler } from '@teambit/compiler';
-import { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';
-import { Capsule } from '@teambit/isolator';
-import { BuildContext, ComponentResult } from '@teambit/builder';
-import { BundlerResult, BundlerContext } from '@teambit/bundler';
-import { BundlingStrategy } from '../bundling-strategy';
-import { PreviewDefinition } from '../preview-definition';
-import { PreviewMain } from '../preview.main.runtime';
-
-/**
- * bundles all components in a given env into the same bundle.
- */
-export class EnvBundlingStrategy implements BundlingStrategy {
-  name = 'env';
-
-  constructor(private preview: PreviewMain) {}
-
-  async computeTargets(context: BuildContext, previewDefs: PreviewDefinition[]) {
-    const outputPath = this.getOutputPath(context);
-    if (!existsSync(outputPath)) mkdirpSync(outputPath);
-
-    return [
-      {
-        entries: await this.computePaths(outputPath, previewDefs, context),
-        components: context.components,
-        outputPath,
-      },
-    ];
-  }
-
-  async computeResults(context: BundlerContext, results: BundlerResult[]) {
-    const result = results[0];
-
-    const componentsResults: ComponentResult[] = result.components.map((component) => {
-      return {
-        component,
-        errors: result.errors.map((err) => (typeof err === 'string' ? err : err.message)),
-        warning: result.warnings,
-        startTime: result.startTime,
-        endTime: result.endTime,
-      };
-    });
-
-    const artifacts = this.getArtifactDef(context);
-
-    return {
-      componentsResults,
-      artifacts,
-    };
-  }
-
-  private getArtifactDef(context: BuildContext) {
-    // eslint-disable-next-line @typescript-eslint/prefer-as-const
-    const env: 'env' = 'env';
-    const rootDir = this.getDirName(context);
-
-    return [
-      {
-        name: 'preview',
-        globPatterns: ['public/**'],
-        rootDir,
-        context: env,
-      },
-    ];
-  }
-
-  getDirName(context: BuildContext) {
-    const envName = context.id.replace('/', '__');
-    return `${envName}-preview`;
-  }
-
-  private getOutputPath(context: BuildContext) {
-    return resolve(`${context.capsuleNetwork.capsulesRootDir}/${this.getDirName(context)}`);
-  }
-
-  private getPaths(context: BuildContext, files: AbstractVinyl[], capsule: Capsule) {
-    const compiler: Compiler = context.env.getCompiler();
-    return files.map((file) => join(capsule.path, compiler.getDistPathBySrcPath(file.relative)));
-  }
-
-  private async computePaths(outputPath: string, defs: PreviewDefinition[], context: BuildContext): Promise<string[]> {
-    const previewMain = await this.preview.writePreviewRuntime(context);
-    const moduleMapsPromise = defs.map(async (previewDef) => {
-      const moduleMap = await previewDef.getModuleMap(context.components);
-
-      const paths = ComponentMap.as(context.components, (component) => {
-        const capsule = context.capsuleNetwork.graphCapsules.getCapsule(component.id);
-        const maybeFiles = moduleMap.get(component);
-        if (!maybeFiles || !capsule) return [];
-        const [, files] = maybeFiles;
-        const compiledPaths = this.getPaths(context, files, capsule);
-        return compiledPaths;
-      });
-
-      const template = previewDef.renderTemplatePath ? await previewDef.renderTemplatePath(context) : 'undefined';
-
-      const link = this.preview.writeLink(
-        previewDef.prefix,
-        paths,
-        previewDef.renderTemplatePath ? await previewDef.renderTemplatePath(context) : undefined,
-        outputPath
-      );
-
-      const files = flatten(paths.toArray().map(([, file]) => file)).concat([link]);
-
-      if (template) return files.concat([template]);
-      return files;
-    });
-
-    const moduleMaps = await Promise.all(moduleMapsPromise);
-
-    return flatten(moduleMaps.concat([previewMain]));
-  }
-}

package/strategies/index.ts

@@ -1,2 +0,0 @@
-export { EnvBundlingStrategy } from './env-strategy';
-export { ComponentBundlingStrategy } from './component-strategy';

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/preview-module.ts

@@ -1,15 +0,0 @@
-/**
- * A full index of the preview data
- */
-export type PreviewModule<T = any> = {
-  /** Dictionary mapping components to their module files. */
-  componentMap: Record<string, ModuleFile<T>[]>;
-
-  /** The 'main file' for this Preview type */
-  mainModule: {
-    default: (...args: any[]) => void;
-  };
-};
-
-/** single preview module, e.g. compositions file */
-export type ModuleFile<T = any> = Record<string, T>;

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;
-}