@teambit/envs 1.0.228 → 1.0.230

package/dist/context/context.d.ts

@@ -0,0 +1,44 @@
+import { EnvDefinition } from '../env-definition';
+import { Environment } from '../environment';
+import { EnvRuntime, Runtime } from '../runtime';
+export type ServiceMap<T> = {
+    [env: string]: T;
+};
+export declare class ExecutionContext {
+    /**
+     * upper scope of all environment contexts.
+     */
+    readonly upper: Runtime;
+    /**
+     * runtime instance of the environment.
+     */
+    readonly envRuntime: EnvRuntime;
+    /**
+     * components applied in the execution context.
+     */
+    components: import("@teambit/component").Component[];
+    constructor(
+    /**
+     * upper scope of all environment contexts.
+     */
+    upper: Runtime, 
+    /**
+     * runtime instance of the environment.
+     */
+    envRuntime: EnvRuntime, 
+    /**
+     * components applied in the execution context.
+     */
+    components?: import("@teambit/component").Component[]);
+    relatedContexts: string[];
+    /**
+     * extension ID of the environment
+     */
+    get id(): string;
+    /**
+     * environment instance.
+     */
+    get env(): Environment;
+    get envDefinition(): EnvDefinition;
+    apply<T>(name: string, args: any[]): T;
+}

package/dist/context/index.d.ts

@@ -0,0 +1 @@
+export { ExecutionContext } from './context';

package/dist/env-definition.d.ts

@@ -0,0 +1,41 @@
+import { Environment } from './environment';
+/**
+ * API for component development environment.
+ */
+export declare class EnvDefinition {
+    /**
+     * id of the env.
+     */
+    readonly id: string;
+    /**
+     * env instance.
+     */
+    readonly env: Environment;
+    constructor(
+    /**
+     * id of the env.
+     */
+    id: string, 
+    /**
+     * env instance.
+     */
+    env: Environment);
+    /**
+     * get icon of the env.
+     */
+    get icon(): string;
+    /**
+     * get the name of the env.
+     */
+    get name(): string | undefined;
+    /**
+     * get the description of the env.
+     */
+    get description(): string | undefined;
+    toObject(): {
+        id: string;
+        description: string | undefined;
+        name: string | undefined;
+        icon: string;
+    };
+}

package/dist/env-interface.d.ts

@@ -0,0 +1,4 @@
+import { EnvHandler } from '.';
+export interface Env {
+    [key: string]: EnvHandler<unknown> | any;
+}

package/dist/env-service-list.d.ts

@@ -0,0 +1,35 @@
+import { EnvDefinition } from './env-definition';
+import { EnvService } from './services';
+export declare class EnvServiceList {
+    /**
+     * environment
+     */
+    readonly env: EnvDefinition;
+    /**
+     * services available on the env.
+     */
+    readonly services: [string, EnvService<any>][];
+    constructor(
+    /**
+     * environment
+     */
+    env: EnvDefinition, 
+    /**
+     * services available on the env.
+     */
+    services: [string, EnvService<any>][]);
+    toObject(): {
+        env: {
+            id: string;
+            description: string | undefined;
+            name: string | undefined;
+            icon: string;
+        };
+        services: {
+            id: string;
+            name: string | undefined;
+            description: string | undefined;
+            data: {} | Promise<{} | undefined> | undefined;
+        }[];
+    };
+}

package/dist/env.composition.d.ts

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

package/dist/env.fragment.d.ts

@@ -0,0 +1,17 @@
+import { ShowFragment, Component } from '@teambit/component';
+import { EnvsMain } from './environments.main.runtime';
+export declare class EnvFragment implements ShowFragment {
+    private envs;
+    constructor(envs: EnvsMain);
+    readonly title = "env";
+    renderRow(component: Component): Promise<{
+        title: string;
+        content: string;
+    }>;
+    json(component: Component): Promise<{
+        title: string;
+        json: string;
+    }>;
+    private getEnvId;
+    weight: number;
+}

package/dist/env.plugin.d.ts

@@ -0,0 +1,18 @@
+import { PluginDefinition } from '@teambit/aspect-loader';
+import { Aspect, Harmony } from '@teambit/harmony';
+import { WorkerMain } from '@teambit/worker';
+import { LoggerMain } from '@teambit/logger';
+import { EnvsRegistry, ServicesRegistry } from './environments.main.runtime';
+export declare class EnvPlugin implements PluginDefinition {
+    private envSlot;
+    private servicesRegistry;
+    private loggerMain;
+    private workerMain;
+    private harmony;
+    constructor(envSlot: EnvsRegistry, servicesRegistry: ServicesRegistry, loggerMain: LoggerMain, workerMain: WorkerMain, harmony: Harmony);
+    pattern: string;
+    runtimes: string[];
+    private createContext;
+    private transformToLegacyEnv;
+    register(object: any, aspect: Aspect): void;
+}

package/dist/environment.d.ts

@@ -0,0 +1,196 @@
+import type { Linter, LinterContext } from '@teambit/linter';
+import type { Formatter, FormatterContext } from '@teambit/formatter';
+import type { Tester } from '@teambit/tester';
+import type { Compiler } from '@teambit/compiler';
+import type { Bundler, BundlerContext, DevServer, DevServerContext } from '@teambit/bundler';
+import type { BuildTask } from '@teambit/builder';
+import type { SchemaExtractor } from '@teambit/schema';
+import type { WebpackConfigTransformer } from '@teambit/webpack';
+import type { PackageJsonProps } from '@teambit/pkg';
+import type { DependencyDetector, EnvPolicyConfigObject } from '@teambit/dependency-resolver';
+import type { Capsule } from '@teambit/isolator';
+import type { Component } from '@teambit/component';
+import { EnvPreviewConfig } from '@teambit/preview';
+import { SchemaNodeTransformer, SchemaTransformer } from '@teambit/typescript';
+export type EnvDescriptor = {
+    type: string;
+};
+/**
+ * add a custom type and include all properties from within the environment.
+ */
+export interface Environment {
+    /**
+     * name of the environment.
+     */
+    name?: string;
+    /**
+     * description of the environment.
+     */
+    description?: string;
+    /**
+     * icon of the environment.
+     */
+    icon?: string;
+    [key: string]: any;
+    /**
+     * Returns the Environment descriptor
+     * Required for any task
+     */
+    __getDescriptor?: () => Promise<EnvDescriptor>;
+    /**
+     * Returns a schema generator instance
+     */
+    getSchemaExtractor?: (config?: any, tsserverPath?: string, contextPath?: string, schemaTransformers?: SchemaTransformer[], apiTransformers?: SchemaNodeTransformer[]) => SchemaExtractor;
+    /**
+     * Returns the dev patterns to match doc files
+     */
+    getDocsDevPatterns?: (component: Component) => string[];
+    /**
+     * Returns the dev patterns to match composition files
+     */
+    getCompositionsDevPatterns?: (component: Component) => string[];
+    /**
+     * Returns additional dev patterns for the component.
+     * Patterns that were provided by getDocsDevPatterns, getTestsDevPatterns will be considered as dev files as well, without need to add them here.
+     */
+    getDevPatterns?: (component: Component) => string[];
+}
+export interface DependenciesEnv extends Environment {
+    /**
+     * Returns the list of dependencies
+     * Required for any task
+     */
+    getDependencies?: () => EnvPolicyConfigObject | Promise<EnvPolicyConfigObject>;
+    /**
+     * Returns a list of additional test host dependencies
+     * this will be added to the tester context
+     * This can be used in cases when you want specific dependencies to be resolved from the env during testing
+     * but you don't want these dependencies as peer dependencies of the component (as they are not used during runtime)
+     * An example for this is @angular/compiler, which during running tests you want to resolve from the env, but you don't
+     * need it during component runtime.
+     */
+    getAdditionalTestHostDependencies?: () => string[] | Promise<string[]>;
+    /**
+     * Returns a list of additional host dependencies
+     * this list will be provided as globals on the window after bit preview bundle
+     * by default bit will merge this list with the peers from the getDependencies function
+     */
+    getAdditionalHostDependencies?: () => string[] | Promise<string[]>;
+    /**
+     * Returns a list of dependency detectors
+     * this list will be used to detect all the dependencies in each file of the component
+     */
+    getDepDetectors?: () => DependencyDetector[] | null;
+}
+export type GetNpmIgnoreContext = {
+    capsule: Capsule;
+    component: Component;
+};
+export interface PackageEnv extends Environment {
+    /**
+     * define the package json properties to add to each component.
+     * Used by `bit link` to augment package.json with new properties
+     */
+    getPackageJsonProps?: () => PackageJsonProps;
+    /**
+     * return `.npmignore` entries to be written before packing the component
+     */
+    getNpmIgnore?: (npmIgnoreContext?: GetNpmIgnoreContext) => string[];
+}
+export interface LinterEnv extends Environment {
+    /**
+     * Returns & configures the linter to use (ESLint, ...)
+     * Required for `bit lint`
+     */
+    getLinter?: (context: LinterContext, transformers: any[]) => Linter;
+}
+export interface FormatterEnv extends Environment {
+    /**
+     * Returns & configures the formatter to use (prettier, ...)
+     * Required for `bit format`
+     */
+    getFormatter?: (context: FormatterContext, transformers: any[]) => Formatter;
+}
+export interface PreviewEnv extends Environment {
+    /**
+     * Returns a paths to a function which mounts a given component to DOM
+     * Required for `bit start` & `bit build`
+     */
+    getMounter?: () => string;
+    /**
+     * Returns a path to a docs template.
+     * Required for `bit start` & `bit build`
+     */
+    getDocsTemplate?: () => string;
+    /**
+     * Returns a bundler for the preview.
+     * Required for `bit build` & `bit start`
+     */
+    getBundler?: (context: BundlerContext, transformers: any[]) => Promise<Bundler>;
+    /**
+     * Returns preview config like the strategy name to use when bundling the components for the preview
+     */
+    getPreviewConfig?: () => EnvPreviewConfig;
+    /**
+     * Returns a bundler for the env template.
+     * this bundler will be used to bundle the docs/compositions (or other preview) apps
+     * Required for `bit build` & `bit tag`
+     */
+    getTemplateBundler?: (context: BundlerContext, transformers?: any[]) => Promise<Bundler>;
+}
+export type PipeServiceModifiersMap = Record<string, PipeServiceModifier>;
+export interface PipeServiceModifier {
+    transformers?: Function[];
+    module?: any;
+}
+export interface BuilderEnv extends PreviewEnv {
+    /**
+     * @deprecated Fatal: a breaking API was introduced. Use getBuildPipe() instead.
+     */
+    getPipe?: () => BuildTask[];
+    /**
+     * Returns the component build pipeline
+     * Either `getBuildPipe`, `getTagPipe`, or `getSnapPipe` is required for `bit build`
+     */
+    getBuildPipe?: (modifiersMap?: PipeServiceModifiersMap) => BuildTask[];
+    /**
+     * Returns the component tag pipeline
+     * Either `getBuildPipe`, `getTagPipe`, or `getSnapPipe` is required for `bit build`
+     */
+    getTagPipe?: (modifiersMap?: PipeServiceModifiersMap) => BuildTask[];
+    /**
+     * Returns the component snap pipeline
+     * Either `getBuildPipe`, `getTagPipe`, or `getSnapPipe` is required for `bit build`
+     */
+    getSnapPipe?: (modifiersMap?: PipeServiceModifiersMap) => BuildTask[];
+}
+export interface TesterEnv extends Environment {
+    /**
+     * Returns a tester
+     * Required for `bit start` & `bit test`
+     */
+    getTester?: (path: string, tester: any) => Tester;
+    /**
+     * Returns the dev patterns to match test files
+     */
+    getTestsDevPatterns?: (component: Component) => string[];
+}
+export interface CompilerEnv {
+    /**
+     * Returns a compiler
+     * Required for making and reading dists, especially for `bit compile`
+     */
+    getCompiler: () => Compiler;
+}
+export declare function hasCompiler(obj: Environment): obj is CompilerEnv;
+export interface DevEnv extends PreviewEnv {
+    /**
+     * Required for `bit start`
+     */
+    getDevEnvId?: (context?: any) => string;
+    /**
+     * Returns and configures the dev server
+     * Required for `bit start`
+     */
+    getDevServer?: (context: DevServerContext, transformers: WebpackConfigTransformer[]) => DevServer | Promise<DevServer>;
+}

package/dist/environments.aspect.d.ts

@@ -0,0 +1,2 @@
+import { Aspect } from '@teambit/harmony';
+export declare const EnvsAspect: Aspect;

package/dist/environments.graphql.d.ts

@@ -0,0 +1,3 @@
+import { Schema } from '@teambit/graphql';
+import { EnvsMain } from './environments.main.runtime';
+export declare function environmentsSchema(environments: EnvsMain): Schema;