@teambit/preview 1.0.228 → 1.0.230

package/dist/artifact-file-middleware.d.ts

@@ -0,0 +1,12 @@
+import type { Middleware } from '@teambit/express';
+import type { Logger } from '@teambit/logger';
+export type PreviewUrlParams = {
+    /**
+     * preview name like overview or composition
+     */
+    previewName?: string;
+    /** `/preview/:filePath(*)` */
+    filePath?: string;
+};
+export type GetCacheControlFunc = (filePath: string, contents: string, mimeType?: string | null) => string | undefined;
+export declare function getArtifactFileMiddleware(logger: Logger, getCacheControlFunc?: GetCacheControlFunc): Middleware;

package/dist/bundler/chunks.d.ts

@@ -0,0 +1,17 @@
+import type { BundlerEntryMap } from '@teambit/bundler';
+export declare const CHUNK_NAMES: {
+    previewRoot: string;
+    peers: string;
+};
+type TemplateEntryOptions = {
+    previewRootPath: string;
+    peers: string | string[];
+    previewModules: {
+        name: string;
+        entry: string;
+        /** other preview modules to includes */
+        include?: string[];
+    }[];
+};
+export declare function generateTemplateEntries(options: TemplateEntryOptions): BundlerEntryMap;
+export {};

package/dist/bundler/create-peer-link.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/bundler/create-peers-link.d.ts

@@ -0,0 +1,2 @@
+export declare function writePeerLink(peers: string[], workdir: string): Promise<string>;
+export declare function generatePeerLink(peers: string[]): string;

package/dist/bundler/html-plugin.d.ts

@@ -0,0 +1,5 @@
+import type { BundlerHtmlConfig } from '@teambit/bundler';
+import { PreviewDefinition } from '../preview-definition';
+export declare function generateHtmlConfig(previewDef: PreviewDefinition, options: {
+    dev?: boolean;
+}): BundlerHtmlConfig;

package/dist/bundler/html-template.d.ts

@@ -0,0 +1,2 @@
+/** html template for Previews (docs, compositions, etc) */
+export declare function html(title: string): string;

package/dist/bundling-strategy.d.ts

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

package/dist/component-preview.d.ts

@@ -0,0 +1,2 @@
+import { ComponentPreview } from '@teambit/preview.ui.component-preview';
+export { ComponentPreview };

package/dist/component-preview.route.d.ts

@@ -0,0 +1,20 @@
+/// <reference types="express" />
+import type { NextFunction, Request, Response, Route } from '@teambit/express';
+import type { Logger } from '@teambit/logger';
+import { PreviewMain } from './preview.main.runtime';
+import type { PreviewUrlParams } from './artifact-file-middleware';
+export declare class ComponentPreviewRoute implements Route {
+    /**
+     * preview extension.
+     */
+    private preview;
+    private logger;
+    constructor(
+    /**
+     * preview extension.
+     */
+    preview: PreviewMain, logger: Logger);
+    route: string;
+    method: string;
+    middlewares: (import("@teambit/express").Middleware | ((req: Request<PreviewUrlParams>, res: Response, next: NextFunction) => Promise<void | import("express").Response<any, Record<string, any>>>))[];
+}

package/dist/env-preview-template.task.d.ts

@@ -0,0 +1,45 @@
+import { BuildContext, BuiltTaskResult, BuildTask, TaskLocation, ComponentResult } from '@teambit/builder';
+import { AspectLoaderMain } from '@teambit/aspect-loader';
+import { BundlerContext, BundlerResult } from '@teambit/bundler';
+import type { EnvsMain } from '@teambit/envs';
+import { Logger } from '@teambit/logger';
+import { DependencyResolverMain } from '@teambit/dependency-resolver';
+import type { PreviewMain } from './preview.main.runtime';
+export type ModuleExpose = {
+    name: string;
+    path: string;
+    include?: string[];
+};
+export declare const GENERATE_ENV_TEMPLATE_TASK_NAME = "GenerateEnvTemplate";
+export declare class EnvPreviewTemplateTask implements BuildTask {
+    private preview;
+    private envs;
+    private aspectLoader;
+    private dependencyResolver;
+    private logger;
+    aspectId: string;
+    name: string;
+    location: TaskLocation;
+    constructor(preview: PreviewMain, envs: EnvsMain, aspectLoader: AspectLoaderMain, dependencyResolver: DependencyResolverMain, logger: Logger);
+    execute(context: BuildContext): Promise<BuiltTaskResult>;
+    private runBundlerForGroups;
+    private shouldUseDefaultBundler;
+    private getEnvTargetFromComponent;
+    private generateEntries;
+    computeResults(context: BundlerContext, results: BundlerResult[]): Promise<{
+        componentsResults: ComponentResult[];
+        artifacts: {
+            name: string;
+            globPatterns: string[];
+            rootDir: string;
+        }[];
+    }>;
+    private getPreviewModules;
+    private computeOutputPath;
+}
+export declare function getArtifactDirectory(): string;
+export declare function getArtifactDef(): {
+    name: string;
+    globPatterns: string[];
+    rootDir: string;
+}[];

package/dist/env-template.route.d.ts

@@ -0,0 +1,25 @@
+/// <reference types="express" />
+import type { NextFunction, Request, Response } from '@teambit/express';
+import type { ComponentUrlParams, RegisteredComponentRoute } from '@teambit/component';
+import type { Logger } from '@teambit/logger';
+import type { PreviewMain } from './preview.main.runtime';
+type UrlParams = ComponentUrlParams & {
+    filePath?: string;
+};
+export declare class EnvTemplateRoute implements RegisteredComponentRoute {
+    /**
+     * preview extension.
+     */
+    private preview;
+    private logger;
+    constructor(
+    /**
+     * preview extension.
+     */
+    preview: PreviewMain, logger: Logger);
+    route: string;
+    method: string;
+    resolveComponent: boolean;
+    middlewares: (import("@teambit/express").Middleware | ((req: Request<UrlParams>, res: Response, next: NextFunction) => Promise<void | import("express").Response<any, Record<string, any>>>))[];
+}
+export {};

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

@@ -0,0 +1,12 @@
+import { BitBaseEvent } from '@teambit/pubsub';
+declare class ClickInsideAnIframeEventData {
+    private clickEvent;
+    constructor(clickEvent: any);
+}
+export declare class ClickInsideAnIframeEvent extends BitBaseEvent<ClickInsideAnIframeEventData> {
+    readonly timestamp: number;
+    readonly clickEvent: any;
+    static readonly TYPE = "click-inside-an-iframe";
+    constructor(timestamp: number, clickEvent: any);
+}
+export {};

package/dist/events/index.d.ts

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

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

@@ -0,0 +1,4 @@
+export declare class BundlingStrategyNotFound extends Error {
+    private strategyName;
+    constructor(strategyName: string);
+}

package/dist/exceptions/index.d.ts

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

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

@@ -0,0 +1,5 @@
+import { BitError } from '@teambit/bit-error';
+import { ComponentID } from '@teambit/component';
+export declare class PreviewArtifactNotFound extends BitError {
+    constructor(componentId: ComponentID);
+}

package/dist/exceptions/preview-not-found.d.ts

@@ -0,0 +1,3 @@
+export declare class PreviewNotFound extends Error {
+    constructor(name: string | null);
+}

package/dist/exceptions/preview-output-file-not-found.d.ts

@@ -0,0 +1,5 @@
+import { BitError } from '@teambit/bit-error';
+import { ComponentID } from '@teambit/component';
+export declare class PreviewOutputFileNotFound extends BitError {
+    constructor(componentId: ComponentID, filePath: string);
+}

package/dist/execution-ref.d.ts

@@ -0,0 +1,11 @@
+import { Component, ComponentID } from '@teambit/component';
+import type { ExecutionContext } from '@teambit/envs';
+export declare class ExecutionRef {
+    executionCtx: ExecutionContext;
+    constructor(executionCtx: ExecutionContext);
+    currentComponents: Component[];
+    add(added: Component): void;
+    remove(removed: ComponentID): void;
+    update(next: Component): void;
+    get(id: ComponentID): Component | undefined;
+}

package/dist/generate-link.d.ts

@@ -0,0 +1,9 @@
+import type { ComponentMap } from '@teambit/component';
+export type MainModulesMap = {
+    /**
+     * Path to default module in case there is no specific module for the current environment.
+     */
+    default: string;
+    [envId: string]: string;
+};
+export declare function generateLink(prefix: string, componentMap: ComponentMap<string[]>, mainModulesMap?: MainModulesMap, isSplitComponentBundle?: boolean): string;

package/dist/gql/fetch-component-aspects.d.ts

@@ -0,0 +1 @@
+export declare function fetchComponentAspects(componentId: string): Promise<string[] | undefined>;

package/dist/html-utils.d.ts

@@ -0,0 +1,6 @@
+export declare function loadScript({ src }: {
+    src: string;
+}): Promise<void>;
+export declare function loadLink({ href }: {
+    href: string;
+}): Promise<void>;

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+export { PreviewAspect as default, PreviewAspect, PreviewRuntime } from './preview.aspect';
+export * from './events';
+export type { PreviewEnv, Preview } from './preview-env';
+export type { PreviewMain, EnvPreviewConfig, ComponentPreviewSize, PreviewStrategyName, PreviewFiles, ComponentPreviewMetaData, } from './preview.main.runtime';
+export type { PreviewPreview, RenderingContextOptions, RenderingContextProvider } from './preview.preview.runtime';
+export type { PreviewDefinition } from './preview-definition';
+export type { PreviewModule, ModuleFile } from './types/preview-module';
+export type { RenderingContext } from './rendering-context';
+export { ENV_PREVIEW_STRATEGY_NAME, COMPONENT_PREVIEW_STRATEGY_NAME } from './strategies/strategies-names';

package/dist/mk-temp-dir.d.ts

@@ -0,0 +1 @@
+export declare function makeTempDir(prefix?: string): string;

package/dist/pre-bundle-utils.d.ts

@@ -0,0 +1,12 @@
+import { UIRoot } from '@teambit/ui';
+import { SlotRegistry } from '@teambit/harmony';
+import { ArtifactDefinition } from '@teambit/builder';
+export type UIRootRegistry = SlotRegistry<UIRoot>;
+export declare const BUNDLE_HASH_FILENAME = ".hash";
+export declare function readBundleHash(bundleId: string, bundleDir: string, aspectDir: string): string;
+export declare function createBundleHash(uiRoot: UIRoot, runtime: string): Promise<string>;
+export declare function generateBundleHash(uiRoot: UIRoot, runtime: string, outputPath: string): Promise<void>;
+export declare function getBundleArtifactDirectory(bundleDir: string, aspectDir: string): string;
+export declare function getBundleArtifactDef(bundleDir: string, aspectDir: string): ArtifactDefinition;
+export declare function getBundlePath(bundleId: string, bundleDir: string, aspectDir: string): string | undefined;
+export declare function clearConsole(): void;

package/dist/pre-bundle.d.ts

@@ -0,0 +1,8 @@
+import { AspectDefinition } from '@teambit/aspect-loader';
+import webpack from 'webpack';
+export declare const RUNTIME_NAME = "preview";
+export declare const PUBLIC_DIR: string;
+export declare const UIROOT_ASPECT_ID = "teambit.workspace/workspace";
+export declare const generatePreBundlePreviewEntry: (aspectDefs: AspectDefinition[], rootExtensionName: string, runtimeName: string, rootAspectId: string, dir: string) => string;
+export declare function buildPreBundlePreview(resolvedAspects: AspectDefinition[], customOutputDir?: string): Promise<webpack.Stats>;
+export declare function generateBundlePreviewEntry(rootAspectId: string, previewPreBundlePath: string, config: object): Promise<string>;

package/dist/pre-bundle.task.d.ts

@@ -0,0 +1,15 @@
+import { BuildContext, BuildTask, BuiltTaskResult, TaskLocation } from '@teambit/builder';
+import { Logger } from '@teambit/logger';
+import { UiMain } from '@teambit/ui';
+export declare const BUNDLE_TASK_NAME = "PreBundlePreview";
+export declare const BUNDLE_DIR = "ui-bundle";
+export declare class PreBundlePreviewTask implements BuildTask {
+    private ui;
+    private logger;
+    aspectId: string;
+    name: string;
+    location: TaskLocation;
+    constructor(ui: UiMain, logger: Logger);
+    execute(context: BuildContext): Promise<BuiltTaskResult>;
+    private generateHash;
+}

package/dist/{preview-1712805335812.js → preview-1712891953391.js}

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

package/dist/preview-artifact.d.ts

@@ -0,0 +1,8 @@
+import { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';
+export declare class PreviewArtifact {
+    private artifacts;
+    constructor(artifacts: AbstractVinyl[]);
+    getPaths(): string[];
+    getFile(path: string): AbstractVinyl | undefined;
+    getFileEndsWith(path: string): AbstractVinyl | undefined;
+}

package/dist/preview-assets.route.d.ts

@@ -0,0 +1,19 @@
+/// <reference types="express" />
+import type { Request, Response, Route } from '@teambit/express';
+import type { Logger } from '@teambit/logger';
+import { PreviewMain } from './preview.main.runtime';
+export declare class PreviewAssetsRoute implements Route {
+    /**
+     * preview extension.
+     */
+    private preview;
+    private logger;
+    constructor(
+    /**
+     * preview extension.
+     */
+    preview: PreviewMain, logger: Logger);
+    route: string;
+    method: string;
+    middlewares: ((req: Request, res: Response) => Promise<import("express").Response<any, Record<string, any>>>)[];
+}

package/dist/preview-context.d.ts

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

package/dist/preview-definition.d.ts

@@ -0,0 +1,34 @@
+import type { Component, ComponentMap } from '@teambit/component';
+import type { Environment, ExecutionContext } from '@teambit/envs';
+import type { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';
+export interface PreviewDefinition {
+    /**
+     * extension preview prefix
+     */
+    prefix: string;
+    /**
+     * which other extension modules to include in the preview context.
+     */
+    include?: string[];
+    /**
+     * path of the default template to be executed.
+     */
+    renderTemplatePath: (context: ExecutionContext) => Promise<string | undefined>;
+    /**
+     * get the template by env.
+     * TODO: refactor `renderTemplatePath` to accept only an env and remove this method.
+     */
+    renderTemplatePathByEnv: (env: Environment) => Promise<string | undefined>;
+    /**
+     * get all files to require in the preview runtime.
+     */
+    getModuleMap(components: Component[]): Promise<ComponentMap<AbstractVinyl[]>>;
+    /**
+     * Whether to include the peers chunk in the output html
+     */
+    includePeers?: boolean;
+    /**
+     * Get metadata for the preview
+     */
+    getMetadata?: (component: Component) => Promise<unknown>;
+}

package/dist/preview-env.d.ts

@@ -0,0 +1,39 @@
+import { Bundler, BundlerContext, DevServer, DevServerContext } from '@teambit/bundler';
+import { AsyncEnvHandler, EnvHandler } from '@teambit/envs';
+/**
+ * interface for implementing component previews
+ * using bit's development environments.
+ */
+export interface PreviewEnv {
+    preview(): EnvHandler<Preview>;
+}
+export type Preview = {
+    /**
+     * return an instance of a mounter.
+     */
+    getMounter: () => string;
+    /**
+     * return a path to a docs template.
+     */
+    getDocsTemplate: () => string;
+    /**
+     * return a dev server instance to use for previews.
+     */
+    getDevServer: (context: DevServerContext) => EnvHandler<DevServer> | AsyncEnvHandler<DevServer>;
+    /**
+     * return an instance for a preview bundler.
+     */
+    getBundler: (context: BundlerContext) => EnvHandler<Bundler> | AsyncEnvHandler<Bundler>;
+    /**
+     * return the id of the dev server.
+     * used for deduplication of dev servers
+     */
+    getDevEnvId: () => string;
+    /**
+     * dependencies that will bundled as part of the env template and will configured as externals for the component bundle
+     * these dependencies will be available in the preview on the window.
+     * these dependencies will have only one instance on the page.
+     * for dev server these dependencies will be aliased
+     */
+    getHostDependencies: () => string[];
+};

package/dist/preview-modules.d.ts

@@ -0,0 +1 @@
+export { PreviewModules, linkModules, PREVIEW_MODULES } from '@teambit/preview.modules.preview-modules';

package/dist/preview-type.d.ts

@@ -0,0 +1,25 @@
+import { ComponentID } from '@teambit/component-id';
+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: ComponentID, envId: 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.aspect.d.ts

@@ -0,0 +1,4 @@
+import { Aspect, RuntimeDefinition } from '@teambit/harmony';
+export declare const PreviewRuntime: RuntimeDefinition;
+export declare const PreviewAspect: Aspect;
+export default PreviewAspect;

package/dist/preview.composition.d.ts

@@ -0,0 +1 @@
+export declare const Logo: () => import("react/jsx-runtime").JSX.Element;

package/dist/preview.d.ts

@@ -0,0 +1,11 @@
+import { Bundler, BundlerContext, DevServer, DevServerContext } from '@teambit/bundler';
+export interface Preview {
+    /**
+     * get a dev server instance of the.
+     */
+    getDevServer(context: DevServerContext): DevServer;
+    /**
+     * get bundler instance.
+     */
+    getBundler(context: BundlerContext): Bundler;
+}

package/dist/preview.graphql.d.ts

@@ -0,0 +1,32 @@
+import { Component } from '@teambit/component';
+import { PreviewMain } from './preview.main.runtime';
+export declare function previewSchema(previewExtension: PreviewMain): {
+    typeDefs: import("graphql").DocumentNode;
+    resolvers: {
+        Component: {
+            preview: (component: Component) => {
+                component: Component;
+            };
+        };
+        Preview: {
+            includesEnvTemplate: ({ component }: {
+                component: any;
+            }) => Promise<boolean>;
+            isScaling: ({ component }: {
+                component: any;
+            }) => Promise<boolean>;
+            legacyHeader: ({ component }: {
+                component: any;
+            }) => Promise<boolean>;
+            onlyOverview: ({ component }: {
+                component: any;
+            }) => Promise<boolean>;
+            useNameParam: ({ component }: {
+                component: any;
+            }) => Promise<boolean>;
+            skipIncludes: ({ component }: {
+                component: any;
+            }) => Promise<boolean>;
+        };
+    };
+};