@teambit/preview 0.0.551 → 0.0.556

package/dist/bundling-strategy.d.ts

@@ -3,7 +3,16 @@ import { Target, BundlerResult, BundlerContext } from '@teambit/bundler';
 import { PreviewDefinition } from './preview-definition';
 import { PreviewTask } from './preview.task';
 export interface BundlingStrategy {
+    /**
+     * name of the bundling strategy.
+     */
     name: string;
+    /**
+     * compute bundling targets for the build context.
+     */
     computeTargets(context: BuildContext, previewDefs: PreviewDefinition[], previewTask: PreviewTask): Promise<Target[]>;
+    /**
+     * compute the results of the bundler.
+     */
     computeResults(context: BundlerContext, results: BundlerResult[], previewTask: PreviewTask): Promise<BuiltTaskResult>;
 }

package/dist/preview-definition.d.ts

@@ -2,7 +2,16 @@ import { Component, ComponentMap } from '@teambit/component';
 import { ExecutionContext } from '@teambit/envs';
 import { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';
 export interface PreviewDefinition {
+    /**
+     * extension preview prefix
+     */
     prefix: string;
+    /**
+     * path of the default template to be executed.
+     */
     renderTemplatePath?: (context: ExecutionContext) => Promise<string>;
+    /**
+     * get all files to require in the preview runtime.
+     */
     getModuleMap(components: Component[]): Promise<ComponentMap<AbstractVinyl[]>>;
 }

package/dist/preview-type.d.ts

@@ -1,9 +1,24 @@
 import { RenderingContext } from './rendering-context';
 import { PreviewModule } from './types/preview-module';
 export interface PreviewType {
+    /**
+     * preview name to register.
+     */
     name: string;
+    /**
+     * preview render method.
+     */
     render(componentId: string, linkedModules: PreviewModule<any>, includedPreviews: string[], renderingContext: RenderingContext): void;
+    /**
+     * determine if this will be the default preview to render.
+     */
     default?: boolean;
+    /**
+     * which other extension modules to include in the preview context.
+     */
     include?: string[];
+    /**
+     * select relevant information to show in preview context
+     */
     selectPreviewModel?: (componentId: string, module: PreviewModule) => any;
 }

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

@@ -19,7 +19,13 @@ export declare type PreviewConfig = {
 };
 export declare type BundlingStrategySlot = SlotRegistry<BundlingStrategy>;
 export declare class PreviewMain {
+    /**
+     * harmony context.
+     */
     private harmony;
+    /**
+     * slot for preview definitions.
+     */
     private previewSlot;
     private ui;
     private envs;
@@ -30,12 +36,27 @@ export declare class PreviewMain {
     private builder;
     private workspace;
     private logger;
-    constructor(harmony: Harmony, previewSlot: PreviewDefinitionRegistry, ui: UiMain, envs: EnvsMain, pkg: PkgMain, aspectLoader: AspectLoaderMain, config: PreviewConfig, bundlingStrategySlot: BundlingStrategySlot, builder: BuilderMain, workspace: Workspace | undefined, logger: Logger);
+    constructor(
+    /**
+     * harmony context.
+     */
+    harmony: Harmony, 
+    /**
+     * slot for preview definitions.
+     */
+    previewSlot: PreviewDefinitionRegistry, ui: UiMain, envs: EnvsMain, pkg: PkgMain, aspectLoader: AspectLoaderMain, config: PreviewConfig, bundlingStrategySlot: BundlingStrategySlot, builder: BuilderMain, workspace: Workspace | undefined, logger: Logger);
     get tempFolder(): string;
     getPreview(component: Component): Promise<PreviewArtifact | undefined>;
     getDefs(): PreviewDefinition[];
     private writeHash;
     private timestamp;
+    /**
+     * write a link to load custom modules dynamically.
+     * @param prefix write
+     * @param moduleMap map of components to module paths to require.
+     * @param defaultModule
+     * @param dirName
+     */
     writeLink(prefix: string, moduleMap: ComponentMap<string[]>, defaultModule: string | undefined, dirName: string): string;
     private executionRefs;
     private getPreviewTarget;
@@ -43,12 +64,29 @@ export declare class PreviewMain {
     writePreviewRuntime(context: {
         components: Component[];
     }): Promise<string>;
+    /**
+     * Filter the aspects to have only aspects that are:
+     * 1. core aspects
+     * 2. configured on the host (workspace/scope)
+     * 3. used by at least one component from the context
+     * @param aspects
+     * @param context
+     */
     private filterAspectsByExecutionContext;
     private getDefaultStrategies;
     private handleComponentChange;
     private handleComponentRemoval;
+    /**
+     * return the configured bundling strategy.
+     */
     getBundlingStrategy(): BundlingStrategy;
+    /**
+     * register a new bundling strategy. default available strategies are `env` and ``
+     */
     registerBundlingStrategy(bundlingStrategy: BundlingStrategy): this;
+    /**
+     * register a new preview definition.
+     */
     registerDefinition(previewDef: PreviewDefinition): void;
     static slots: (((registerFn: () => string) => SlotRegistry<PreviewDefinition>) | ((registerFn: () => string) => SlotRegistry<BundlingStrategy>))[];
     static runtime: import("@teambit/harmony").RuntimeDefinition;

package/dist/preview.preview.runtime.d.ts

@@ -8,14 +8,41 @@ export declare type RenderingContextProvider = () => {
 };
 export declare type RenderingContextSlot = SlotRegistry<RenderingContextProvider>;
 export declare class PreviewPreview {
+    /**
+     * register to pubsub
+     */
     private pubsub;
+    /**
+     * preview slot.
+     */
     private previewSlot;
     private renderingContextSlot;
-    constructor(pubsub: PubsubPreview, previewSlot: PreviewSlot, renderingContextSlot: RenderingContextSlot);
+    constructor(
+    /**
+     * register to pubsub
+     */
+    pubsub: PubsubPreview, 
+    /**
+     * preview slot.
+     */
+    previewSlot: PreviewSlot, renderingContextSlot: RenderingContextSlot);
     private registerClickPubSub;
+    /**
+     * render the preview.
+     */
     render: () => void;
+    /**
+     * register a new preview.
+     */
     registerPreview(preview: PreviewType): this;
+    /**
+     * get the preview rendering context.
+     */
     getRenderingContext(): RenderingContext;
+    /**
+     * allows aspects to add rendering contexts.
+     * render context is available through all preview definitions.
+     */
     registerRenderContext(renderContext: RenderingContextProvider): this;
     getDefault(): string;
     private getPreview;

package/dist/preview.route.d.ts

@@ -3,12 +3,20 @@ import { Request, Response, Route } from '@teambit/express';
 import type { Logger } from '@teambit/logger';
 import { PreviewMain } from './preview.main.runtime';
 declare type UrlParams = {
+    /** `/preview/:previewPath(*)` */
     previewPath?: string;
 };
 export declare class PreviewRoute implements Route {
+    /**
+     * preview extension.
+     */
     private preview;
     private logger;
-    constructor(preview: PreviewMain, logger: Logger);
+    constructor(
+    /**
+     * preview extension.
+     */
+    preview: PreviewMain, logger: Logger);
     route: string;
     method: string;
     middlewares: ((req: Request<UrlParams>, res: Response) => Promise<import("express").Response<any>>)[];

package/dist/preview.task.d.ts

@@ -7,9 +7,23 @@ import { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';
 import { PreviewDefinition } from './preview-definition';
 import { PreviewMain } from './preview.main.runtime';
 export declare class PreviewTask implements BuildTask {
+    /**
+     * bundler extension.
+     */
     private bundler;
+    /**
+     * preview extension.
+     */
     private preview;
-    constructor(bundler: BundlerMain, preview: PreviewMain);
+    constructor(
+    /**
+     * bundler extension.
+     */
+    bundler: BundlerMain, 
+    /**
+     * preview extension.
+     */
+    preview: PreviewMain);
     aspectId: string;
     name: string;
     location: TaskLocation;

package/dist/rendering-context.d.ts

@@ -2,6 +2,9 @@ import { RenderingContextSlot } from './preview.preview.runtime';
 export declare class RenderingContext {
     private contexts;
     constructor(contexts: RenderingContextSlot);
+    /**
+     * obtain rendering context of a specific aspect.
+     */
     get(aspectId: string): {
         [key: string]: any;
     } | undefined;

package/dist/strategies/env-strategy.d.ts

@@ -3,6 +3,9 @@ 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 declare class EnvBundlingStrategy implements BundlingStrategy {
     private preview;
     name: string;

package/dist/types/preview-module.d.ts

@@ -1,7 +1,13 @@
+/**
+ * A full index of the preview data
+ */
 export declare 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 declare type ModuleFile<T = any> = Record<string, T>;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/preview",
-  "version": "0.0.551",
+  "version": "0.0.556",
   "homepage": "https://bit.dev/teambit/preview/preview",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.preview",
     "name": "preview",
-    "version": "0.0.551"
+    "version": "0.0.556"
   },
   "dependencies": {
     "fs-extra": "10.0.0",
@@ -17,26 +17,26 @@
     "mime": "2.5.2",
     "@babel/runtime": "7.12.18",
     "core-js": "^3.0.0",
-    "@teambit/builder": "0.0.551",
-    "@teambit/bundler": "0.0.551",
-    "@teambit/component": "0.0.551",
-    "@teambit/envs": "0.0.551",
-    "@teambit/toolbox.path.to-windows-compatible-path": "0.0.456",
-    "@teambit/aspect-loader": "0.0.551",
-    "@teambit/cli": "0.0.382",
-    "@teambit/logger": "0.0.467",
-    "@teambit/pkg": "0.0.551",
-    "@teambit/pubsub": "0.0.551",
-    "@teambit/ui": "0.0.551",
-    "@teambit/workspace": "0.0.551",
-    "@teambit/component-id": "0.0.372",
-    "@teambit/express": "0.0.471",
-    "@teambit/ui-foundation.ui.pages.static-error": "0.0.43",
-    "@teambit/compiler": "0.0.551",
-    "@teambit/preview.cli.preview-server-status": "0.0.462",
-    "@teambit/preview.cli.webpack-events-listener": "0.0.132",
-    "@teambit/isolator": "0.0.551",
-    "@teambit/bit-error": "0.0.368"
+    "@teambit/builder": "0.0.556",
+    "@teambit/bundler": "0.0.556",
+    "@teambit/component": "0.0.556",
+    "@teambit/envs": "0.0.556",
+    "@teambit/toolbox.path.to-windows-compatible-path": "0.0.461",
+    "@teambit/aspect-loader": "0.0.556",
+    "@teambit/cli": "0.0.387",
+    "@teambit/logger": "0.0.472",
+    "@teambit/pkg": "0.0.556",
+    "@teambit/pubsub": "0.0.556",
+    "@teambit/ui": "0.0.556",
+    "@teambit/workspace": "0.0.556",
+    "@teambit/component-id": "0.0.377",
+    "@teambit/express": "0.0.476",
+    "@teambit/ui-foundation.ui.pages.static-error": "0.0.48",
+    "@teambit/compiler": "0.0.556",
+    "@teambit/preview.cli.preview-server-status": "0.0.467",
+    "@teambit/preview.cli.webpack-events-listener": "0.0.137",
+    "@teambit/isolator": "0.0.556",
+    "@teambit/bit-error": "0.0.373"
   },
   "devDependencies": {
     "@types/fs-extra": "9.0.7",
@@ -49,10 +49,10 @@
     "@types/jest": "^26.0.0",
     "@types/react-dom": "^17.0.5",
     "@types/node": "12.20.4",
-    "@teambit/preview.aspect-docs.preview": "0.0.101"
+    "@teambit/preview.aspect-docs.preview": "0.0.106"
   },
   "peerDependencies": {
-    "@teambit/legacy": "1.0.169",
+    "@teambit/legacy": "1.0.173",
     "react-dom": "^16.8.0 || ^17.0.0",
     "react": "^16.8.0 || ^17.0.0"
   },
@@ -80,12 +80,18 @@
         "react": "-"
       },
       "peerDependencies": {
-        "@teambit/legacy": "1.0.169",
+        "@teambit/legacy": "1.0.173",
         "react-dom": "^16.8.0 || ^17.0.0",
         "react": "^16.8.0 || ^17.0.0"
       }
     }
   },
+  "files": [
+    "dist",
+    "!dist/tsconfig.tsbuildinfo",
+    "README.md",
+    "README.mdx"
+  ],
   "private": false,
   "engines": {
     "node": ">=12.22.0"

package/bundling-strategy.ts

@@ -1,21 +0,0 @@
-import { BuildContext, BuiltTaskResult } from '@teambit/builder';
-import { Target, BundlerResult, BundlerContext } from '@teambit/bundler';
-import { PreviewDefinition } from './preview-definition';
-import { PreviewTask } from './preview.task';
-
-export interface BundlingStrategy {
-  /**
-   * name of the bundling strategy.
-   */
-  name: string;
-
-  /**
-   * compute bundling targets for the build context.
-   */
-  computeTargets(context: BuildContext, previewDefs: PreviewDefinition[], previewTask: PreviewTask): Promise<Target[]>;
-
-  /**
-   * compute the results of the bundler.
-   */
-  computeResults(context: BundlerContext, results: BundlerResult[], previewTask: PreviewTask): Promise<BuiltTaskResult>;
-}

package/events/click-inside-an-iframe.ts

@@ -1,14 +0,0 @@
-/* eslint-disable max-classes-per-file */
-import { BitBaseEvent } from '@teambit/pubsub';
-
-class ClickInsideAnIframeEventData {
-  constructor(private clickEvent: any) {}
-}
-
-export class ClickInsideAnIframeEvent extends BitBaseEvent<ClickInsideAnIframeEventData> {
-  static readonly TYPE = 'click-inside-an-iframe';
-
-  constructor(readonly timestamp = Date.now(), readonly clickEvent) {
-    super(ClickInsideAnIframeEvent.TYPE, '0.0.1', timestamp, new ClickInsideAnIframeEventData(clickEvent));
-  }
-}

package/events/index.ts

@@ -1 +0,0 @@
-export * from './click-inside-an-iframe';

package/exceptions/bundling-strategy-not-found.ts

@@ -1,5 +0,0 @@
-export class BundlingStrategyNotFound extends Error {
-  constructor(private strategyName: string) {
-    super(`bundling strategy with name ${strategyName} was not found`);
-  }
-}

package/exceptions/index.ts

@@ -1,3 +0,0 @@
-export { PreviewNotFound } from './preview-not-found';
-export { PreviewArtifactNotFound } from './preview-artifact-not-found';
-export { BundlingStrategyNotFound } from './bundling-strategy-not-found';

package/exceptions/preview-artifact-not-found.ts

@@ -1,8 +0,0 @@
-import { BitError } from '@teambit/bit-error';
-import { ComponentID } from '@teambit/component';
-
-export class PreviewArtifactNotFound extends BitError {
-  constructor(componentId: ComponentID) {
-    super(`preview for component ${componentId.toString()} was not found`);
-  }
-}

package/exceptions/preview-not-found.ts

@@ -1,5 +0,0 @@
-export class PreviewNotFound extends Error {
-  constructor(name: string | null) {
-    super(`Preview for name: ${name} was not found`);
-  }
-}

package/execution-ref.ts

@@ -1,25 +0,0 @@
-import { Component, ComponentID } from '@teambit/component';
-import type { ExecutionContext } from '@teambit/envs';
-
-// TODO - use workspace.list() instead of this
-export class ExecutionRef {
-  constructor(public executionCtx: ExecutionContext) {
-    this.currentComponents = executionCtx.components;
-  }
-
-  currentComponents: Component[];
-
-  add(added: Component) {
-    this.currentComponents = this.currentComponents.concat(added);
-  }
-  remove(removed: ComponentID) {
-    this.currentComponents = this.currentComponents.filter((c) => c.id.toString() !== removed.toString());
-  }
-  update(next: Component) {
-    this.currentComponents = this.currentComponents.map((c) => (c.equals(next) ? next : c));
-  }
-
-  get(id: ComponentID) {
-    return this.currentComponents.find((x) => x.id.isEqual(id));
-  }
-}

package/generate-link.ts

@@ -1,21 +0,0 @@
-import { toWindowsCompatiblePath } from '@teambit/toolbox.path.to-windows-compatible-path';
-import type { ComponentMap } from '@teambit/component';
-
-// :TODO refactor to building an AST and generate source code based on it.
-export function generateLink(prefix: string, componentMap: ComponentMap<string[]>, defaultModule?: string): string {
-  return `
-import { linkModules } from '${toWindowsCompatiblePath(require.resolve('./preview.preview.runtime'))}';
-import harmony from '${toWindowsCompatiblePath(require.resolve('@teambit/harmony'))}';
-${defaultModule ? `const defaultModule = require('${toWindowsCompatiblePath(defaultModule)}'` : ''});
-linkModules('${prefix}', defaultModule, {
-  ${componentMap
-    .toArray()
-    .map(([component, modulePaths]: any) => {
-      return `'${component.id.fullName}': [${modulePaths
-        .map((path) => `require('${toWindowsCompatiblePath(path)}')`)
-        .join(', ')}]`;
-    })
-    .join(',\n')}
-});  
-`;
-}

package/index.ts

@@ -1,8 +0,0 @@
-export { PreviewAspect as default, PreviewAspect, PreviewRuntime } from './preview.aspect';
-
-export * from './events';
-export type { PreviewMain } from './preview.main.runtime';
-export type { PreviewPreview } from './preview.preview.runtime';
-export { PreviewDefinition } from './preview-definition';
-export type { PreviewModule, ModuleFile } from './types/preview-module';
-export type { RenderingContext } from './rendering-context';

package/mk-temp-dir.ts

@@ -1,7 +0,0 @@
-import { mkdtempSync } from 'fs-extra';
-import { tmpdir } from 'os';
-import { sep } from 'path';
-
-export function makeTempDir(prefix = '') {
-  return mkdtempSync(`${tmpdir()}${sep}${prefix}`);
-}

package/preview-artifact.ts

@@ -1,12 +0,0 @@
-import { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';
-import { pathNormalizeToLinux } from '@teambit/legacy/dist/utils';
-
-export class PreviewArtifact {
-  constructor(private artifacts: AbstractVinyl[]) {}
-
-  getFile(path: string) {
-    return this.artifacts.find((file) => {
-      return pathNormalizeToLinux(file.relative) === path;
-    });
-  }
-}

package/preview-context.ts

@@ -1,5 +0,0 @@
-import { BuildContext } from '@teambit/builder';
-
-export interface PreviewContext extends BuildContext {
-  entries: string[];
-}

package/preview-definition.ts

@@ -1,20 +0,0 @@
-import { Component, ComponentMap } from '@teambit/component';
-import { ExecutionContext } from '@teambit/envs';
-import { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';
-
-export interface PreviewDefinition {
-  /**
-   * extension preview prefix
-   */
-  prefix: string;
-
-  /**
-   * path of the default template to be executed.
-   */
-  renderTemplatePath?: (context: ExecutionContext) => Promise<string>;
-
-  /**
-   * get all files to require in the preview runtime.
-   */
-  getModuleMap(components: Component[]): Promise<ComponentMap<AbstractVinyl[]>>;
-}

package/preview-type.ts

@@ -1,34 +0,0 @@
-import { RenderingContext } from './rendering-context';
-import { PreviewModule } from './types/preview-module';
-
-export interface PreviewType {
-  /**
-   * preview name to register.
-   */
-  name: string;
-
-  /**
-   * preview render method.
-   */
-  render(
-    componentId: string,
-    linkedModules: PreviewModule<any>,
-    includedPreviews: string[],
-    renderingContext: RenderingContext
-  ): void;
-
-  /**
-   * determine if this will be the default preview to render.
-   */
-  default?: boolean;
-
-  /**
-   * which other extension modules to include in the preview context.
-   */
-  include?: string[];
-
-  /**
-   * select relevant information to show in preview context
-   */
-  selectPreviewModel?: (componentId: string, module: PreviewModule) => any;
-}

package/preview.aspect.ts

@@ -1,12 +0,0 @@
-import { Aspect, RuntimeDefinition } from '@teambit/harmony';
-
-export const PreviewRuntime = new RuntimeDefinition('preview');
-
-export const PreviewAspect = Aspect.create({
-  id: 'teambit.preview/preview',
-  dependencies: [],
-  defaultConfig: {},
-  declareRuntime: PreviewRuntime,
-});
-
-export default PreviewAspect;

package/preview.docs.mdx

@@ -1,8 +0,0 @@
----
-description: Handles the bundlings and rendering of component compositions and documentations
-labels: ['core aspect']
----
-
-import { Preview } from '@teambit/preview.aspect-docs.preview';
-
-<Preview />

package/preview.graphql.ts

@@ -1,25 +0,0 @@
-import { Component } from '@teambit/component';
-import gql from 'graphql-tag';
-
-import { PreviewMain } from './preview.main.runtime';
-
-export function previewSchema(previewExtension: PreviewMain) {
-  return {
-    typeDefs: gql`
-      type Preview {
-        url: String!
-      }
-
-      extend type Component {
-        preview: Preview
-      }
-    `,
-    resolvers: {
-      Component: {
-        preview: (component: Component) => {
-          return previewExtension.getPreview(component);
-        },
-      },
-    },
-  };
-}