@teambit/envs 0.0.0-3e44e878fae3f5f31fce2dc240a57a798e67137e

package/dist/env.plugin.js

@@ -0,0 +1,92 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.EnvPlugin = void 0;
+function _component() {
+  const data = require("@teambit/component");
+  _component = function () {
+    return data;
+  };
+  return data;
+}
+function _cli() {
+  const data = require("@teambit/cli");
+  _cli = function () {
+    return data;
+  };
+  return data;
+}
+function _lodash() {
+  const data = require("lodash");
+  _lodash = function () {
+    return data;
+  };
+  return data;
+}
+function _serviceHandlerContext() {
+  const data = require("./services/service-handler-context");
+  _serviceHandlerContext = function () {
+    return data;
+  };
+  return data;
+}
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+class EnvPlugin {
+  constructor(envSlot, servicesRegistry, loggerMain, workerMain, harmony) {
+    this.envSlot = envSlot;
+    this.servicesRegistry = servicesRegistry;
+    this.loggerMain = loggerMain;
+    this.workerMain = workerMain;
+    this.harmony = harmony;
+    _defineProperty(this, "pattern", '*.bit-env.*');
+    _defineProperty(this, "runtimes", [_cli().MainRuntime.name]);
+  }
+  createContext(envId) {
+    return new (_serviceHandlerContext().ServiceHandlerContext)(envId, this.loggerMain, this.workerMain, this.harmony);
+  }
+  transformToLegacyEnv(envId, env) {
+    const envComponentId = _component().ComponentID.fromString(envId);
+    const envContext = this.createContext(envComponentId);
+    const allServices = (0, _lodash().flatten)(this.servicesRegistry.values());
+    const transformers = allServices.reduce((acc, service) => {
+      if (!service.transform) return acc;
+      const currTransformer = service.transform(env, envContext);
+      if (!currTransformer) return acc;
+      return _objectSpread(_objectSpread({}, acc), currTransformer);
+    }, {});
+    return _objectSpread(_objectSpread({}, transformers), {}, {
+      name: env.name,
+      icon: env.icon,
+      __path: env.__path,
+      __resolvedPath: env.__resolvedPath,
+      __getDescriptor: async () => {
+        return {
+          type: env.type || env.name
+        };
+      },
+      id: envId
+    });
+  }
+  register(object, aspect) {
+    const env = this.transformToLegacyEnv(aspect.id, object);
+    // This is required when we call it manually and the aspect id fn return the wrong
+    // id
+    // We call the set directly because when we call it manually during install
+    // the aspect id fn return the wrong id
+    // Please do not change this without consulting @GiladShoham
+    // This manual call from install is required to make sure we re-load the envs
+    // when they move to another location in the node_modules
+    // during process is still running (like during bit new, bit switch, bit server)
+    this.envSlot.map.set(aspect.id, env);
+    return;
+  }
+}
+exports.EnvPlugin = EnvPlugin;
+
+//# sourceMappingURL=env.plugin.js.map

package/dist/env.plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_component","data","require","_cli","_lodash","_serviceHandlerContext","ownKeys","e","r","t","Object","keys","getOwnPropertySymbols","o","filter","getOwnPropertyDescriptor","enumerable","push","apply","_objectSpread","arguments","length","forEach","_defineProperty","getOwnPropertyDescriptors","defineProperties","defineProperty","_toPropertyKey","value","configurable","writable","i","_toPrimitive","Symbol","toPrimitive","call","TypeError","String","Number","EnvPlugin","constructor","envSlot","servicesRegistry","loggerMain","workerMain","harmony","MainRuntime","name","createContext","envId","EnvContext","transformToLegacyEnv","env","envComponentId","ComponentID","fromString","envContext","allServices","flatten","values","transformers","reduce","acc","service","transform","currTransformer","icon","__path","__resolvedPath","__getDescriptor","type","id","register","object","aspect","map","set","exports"],"sources":["env.plugin.ts"],"sourcesContent":["import { PluginDefinition } from '@teambit/aspect-loader';\nimport { Harmony } from '@teambit/harmony';\nimport { ComponentID } from '@teambit/component';\nimport { WorkerMain } from '@teambit/worker';\nimport { MainRuntime } from '@teambit/cli';\nimport { LoggerMain } from '@teambit/logger';\nimport { flatten } from 'lodash';\nimport { ServiceHandlerContext as EnvContext } from './services/service-handler-context';\nimport { Env } from './env-interface';\nimport { EnvsRegistry, ServicesRegistry } from './environments.main.runtime';\n\nexport class EnvPlugin implements PluginDefinition {\n  constructor(\n    private envSlot: EnvsRegistry,\n    private servicesRegistry: ServicesRegistry,\n    private loggerMain: LoggerMain,\n    private workerMain: WorkerMain,\n    private harmony: Harmony\n  ) {}\n\n  pattern = '*.bit-env.*';\n\n  runtimes = [MainRuntime.name];\n\n  private createContext(envId: ComponentID) {\n    return new EnvContext(envId, this.loggerMain, this.workerMain, this.harmony);\n  }\n\n  private transformToLegacyEnv(envId: string, env: Env) {\n    const envComponentId = ComponentID.fromString(envId);\n    const envContext = this.createContext(envComponentId);\n    const allServices = flatten(this.servicesRegistry.values());\n    const transformers = allServices.reduce((acc, service) => {\n      if (!service.transform) return acc;\n      const currTransformer = service.transform(env, envContext);\n      if (!currTransformer) return acc;\n      return { ...acc, ...currTransformer };\n    }, {});\n\n    return {\n      ...transformers,\n      name: env.name,\n      icon: env.icon,\n      __path: env.__path,\n      __resolvedPath: env.__resolvedPath,\n      __getDescriptor: async () => {\n        return {\n          type: env.type || env.name,\n        };\n      },\n      id: envId,\n    };\n  }\n\n  register(object: any, aspect: { id: string }) {\n    const env = this.transformToLegacyEnv(aspect.id, object);\n    // This is required when we call it manually and the aspect id fn return the wrong\n    // id\n    // We call the set directly because when we call it manually during install\n    // the aspect id fn return the wrong id\n    // Please do not change this without consulting @GiladShoham\n    // This manual call from install is required to make sure we re-load the envs\n    // when they move to another location in the node_modules\n    // during process is still running (like during bit new, bit switch, bit server)\n    this.envSlot.map.set(aspect.id, env);\n    return;\n  }\n}\n"],"mappings":";;;;;;AAEA,SAAAA,WAAA;EAAA,MAAAC,IAAA,GAAAC,OAAA;EAAAF,UAAA,YAAAA,CAAA;IAAA,OAAAC,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAE,KAAA;EAAA,MAAAF,IAAA,GAAAC,OAAA;EAAAC,IAAA,YAAAA,CAAA;IAAA,OAAAF,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAG,QAAA;EAAA,MAAAH,IAAA,GAAAC,OAAA;EAAAE,OAAA,YAAAA,CAAA;IAAA,OAAAH,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AACA,SAAAI,uBAAA;EAAA,MAAAJ,IAAA,GAAAC,OAAA;EAAAG,sBAAA,YAAAA,CAAA;IAAA,OAAAJ,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAAyF,SAAAK,QAAAC,CAAA,EAAAC,CAAA,QAAAC,CAAA,GAAAC,MAAA,CAAAC,IAAA,CAAAJ,CAAA,OAAAG,MAAA,CAAAE,qBAAA,QAAAC,CAAA,GAAAH,MAAA,CAAAE,qBAAA,CAAAL,CAAA,GAAAC,CAAA,KAAAK,CAAA,GAAAA,CAAA,CAAAC,MAAA,WAAAN,CAAA,WAAAE,MAAA,CAAAK,wBAAA,CAAAR,CAAA,EAAAC,CAAA,EAAAQ,UAAA,OAAAP,CAAA,CAAAQ,IAAA,CAAAC,KAAA,CAAAT,CAAA,EAAAI,CAAA,YAAAJ,CAAA;AAAA,SAAAU,cAAAZ,CAAA,aAAAC,CAAA,MAAAA,CAAA,GAAAY,SAAA,CAAAC,MAAA,EAAAb,CAAA,UAAAC,CAAA,WAAAW,SAAA,CAAAZ,CAAA,IAAAY,SAAA,CAAAZ,CAAA,QAAAA,CAAA,OAAAF,OAAA,CAAAI,MAAA,CAAAD,CAAA,OAAAa,OAAA,WAAAd,CAAA,IAAAe,eAAA,CAAAhB,CAAA,EAAAC,CAAA,EAAAC,CAAA,CAAAD,CAAA,SAAAE,MAAA,CAAAc,yBAAA,GAAAd,MAAA,CAAAe,gBAAA,CAAAlB,CAAA,EAAAG,MAAA,CAAAc,yBAAA,CAAAf,CAAA,KAAAH,OAAA,CAAAI,MAAA,CAAAD,CAAA,GAAAa,OAAA,WAAAd,CAAA,IAAAE,MAAA,CAAAgB,cAAA,CAAAnB,CAAA,EAAAC,CAAA,EAAAE,MAAA,CAAAK,wBAAA,CAAAN,CAAA,EAAAD,CAAA,iBAAAD,CAAA;AAAA,SAAAgB,gBAAAhB,CAAA,EAAAC,CAAA,EAAAC,CAAA,YAAAD,CAAA,GAAAmB,cAAA,CAAAnB,CAAA,MAAAD,CAAA,GAAAG,MAAA,CAAAgB,cAAA,CAAAnB,CAAA,EAAAC,CAAA,IAAAoB,KAAA,EAAAnB,CAAA,EAAAO,UAAA,MAAAa,YAAA,MAAAC,QAAA,UAAAvB,CAAA,CAAAC,CAAA,IAAAC,CAAA,EAAAF,CAAA;AAAA,SAAAoB,eAAAlB,CAAA,QAAAsB,CAAA,GAAAC,YAAA,CAAAvB,CAAA,uCAAAsB,CAAA,GAAAA,CAAA,GAAAA,CAAA;AAAA,SAAAC,aAAAvB,CAAA,EAAAD,CAAA,2BAAAC,CAAA,KAAAA,CAAA,SAAAA,CAAA,MAAAF,CAAA,GAAAE,CAAA,CAAAwB,MAAA,CAAAC,WAAA,kBAAA3B,CAAA,QAAAwB,CAAA,GAAAxB,CAAA,CAAA4B,IAAA,CAAA1B,CAAA,EAAAD,CAAA,uCAAAuB,CAAA,SAAAA,CAAA,YAAAK,SAAA,yEAAA5B,CAAA,GAAA6B,MAAA,GAAAC,MAAA,EAAA7B,CAAA;AAIlF,MAAM8B,SAAS,CAA6B;EACjDC,WAAWA,CACDC,OAAqB,EACrBC,gBAAkC,EAClCC,UAAsB,EACtBC,UAAsB,EACtBC,OAAgB,EACxB;IAAA,KALQJ,OAAqB,GAArBA,OAAqB;IAAA,KACrBC,gBAAkC,GAAlCA,gBAAkC;IAAA,KAClCC,UAAsB,GAAtBA,UAAsB;IAAA,KACtBC,UAAsB,GAAtBA,UAAsB;IAAA,KACtBC,OAAgB,GAAhBA,OAAgB;IAAAtB,eAAA,kBAGhB,aAAa;IAAAA,eAAA,mBAEZ,CAACuB,kBAAW,CAACC,IAAI,CAAC;EAJ1B;EAMKC,aAAaA,CAACC,KAAkB,EAAE;IACxC,OAAO,KAAIC,8CAAU,EAACD,KAAK,EAAE,IAAI,CAACN,UAAU,EAAE,IAAI,CAACC,UAAU,EAAE,IAAI,CAACC,OAAO,CAAC;EAC9E;EAEQM,oBAAoBA,CAACF,KAAa,EAAEG,GAAQ,EAAE;IACpD,MAAMC,cAAc,GAAGC,wBAAW,CAACC,UAAU,CAACN,KAAK,CAAC;IACpD,MAAMO,UAAU,GAAG,IAAI,CAACR,aAAa,CAACK,cAAc,CAAC;IACrD,MAAMI,WAAW,GAAG,IAAAC,iBAAO,EAAC,IAAI,CAAChB,gBAAgB,CAACiB,MAAM,CAAC,CAAC,CAAC;IAC3D,MAAMC,YAAY,GAAGH,WAAW,CAACI,MAAM,CAAC,CAACC,GAAG,EAAEC,OAAO,KAAK;MACxD,IAAI,CAACA,OAAO,CAACC,SAAS,EAAE,OAAOF,GAAG;MAClC,MAAMG,eAAe,GAAGF,OAAO,CAACC,SAAS,CAACZ,GAAG,EAAEI,UAAU,CAAC;MAC1D,IAAI,CAACS,eAAe,EAAE,OAAOH,GAAG;MAChC,OAAA3C,aAAA,CAAAA,aAAA,KAAY2C,GAAG,GAAKG,eAAe;IACrC,CAAC,EAAE,CAAC,CAAC,CAAC;IAEN,OAAA9C,aAAA,CAAAA,aAAA,KACKyC,YAAY;MACfb,IAAI,EAAEK,GAAG,CAACL,IAAI;MACdmB,IAAI,EAAEd,GAAG,CAACc,IAAI;MACdC,MAAM,EAAEf,GAAG,CAACe,MAAM;MAClBC,cAAc,EAAEhB,GAAG,CAACgB,cAAc;MAClCC,eAAe,EAAE,MAAAA,CAAA,KAAY;QAC3B,OAAO;UACLC,IAAI,EAAElB,GAAG,CAACkB,IAAI,IAAIlB,GAAG,CAACL;QACxB,CAAC;MACH,CAAC;MACDwB,EAAE,EAAEtB;IAAK;EAEb;EAEAuB,QAAQA,CAACC,MAAW,EAAEC,MAAsB,EAAE;IAC5C,MAAMtB,GAAG,GAAG,IAAI,CAACD,oBAAoB,CAACuB,MAAM,CAACH,EAAE,EAAEE,MAAM,CAAC;IACxD;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA,IAAI,CAAChC,OAAO,CAACkC,GAAG,CAACC,GAAG,CAACF,MAAM,CAACH,EAAE,EAAEnB,GAAG,CAAC;IACpC;EACF;AACF;AAACyB,OAAA,CAAAtC,SAAA,GAAAA,SAAA","ignoreList":[]}

package/dist/environment.d.ts

@@ -0,0 +1,201 @@
+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 { ModifyPackageJsonFunc, 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[];
+    /**
+     * in case the static "getPackageJsonProps" is not enough, and the package.json props need to be modified
+     * per component, use this function.
+     */
+    modifyPackageJson?: ModifyPackageJsonFunc;
+}
+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/environment.js

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.hasCompiler = hasCompiler;
+// TODO: @gilad refactor to an abstract env.
+
+/**
+ * add a custom type and include all properties from within the environment.
+ */
+
+function hasCompiler(obj) {
+  return typeof obj.getCompiler === 'function';
+}
+
+//# sourceMappingURL=environment.js.map

package/dist/environment.js.map

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

package/dist/environments.aspect.d.ts

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

package/dist/environments.aspect.js

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.EnvsAspect = void 0;
+function _harmony() {
+  const data = require("@teambit/harmony");
+  _harmony = function () {
+    return data;
+  };
+  return data;
+}
+const EnvsAspect = exports.EnvsAspect = _harmony().Aspect.create({
+  id: 'teambit.envs/envs'
+});
+
+//# sourceMappingURL=environments.aspect.js.map

package/dist/environments.aspect.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_harmony","data","require","EnvsAspect","exports","Aspect","create","id"],"sources":["environments.aspect.ts"],"sourcesContent":["import { Aspect } from '@teambit/harmony';\n\nexport const EnvsAspect = Aspect.create({\n  id: 'teambit.envs/envs',\n});\n"],"mappings":";;;;;;AAAA,SAAAA,SAAA;EAAA,MAAAC,IAAA,GAAAC,OAAA;EAAAF,QAAA,YAAAA,CAAA;IAAA,OAAAC,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEO,MAAME,UAAU,GAAAC,OAAA,CAAAD,UAAA,GAAGE,iBAAM,CAACC,MAAM,CAAC;EACtCC,EAAE,EAAE;AACN,CAAC,CAAC","ignoreList":[]}

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;

package/dist/environments.graphql.js

@@ -0,0 +1,36 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.environmentsSchema = environmentsSchema;
+function _graphqlTag() {
+  const data = require("graphql-tag");
+  _graphqlTag = function () {
+    return data;
+  };
+  return data;
+}
+function environmentsSchema(environments) {
+  return {
+    typeDefs: (0, _graphqlTag().gql)`
+      extend type Component {
+        env: ExtensionDescriptor
+      }
+
+      type ExtensionDescriptor {
+        id: String
+        icon: String
+      }
+    `,
+    resolvers: {
+      Component: {
+        env: component => {
+          return environments.getDescriptor(component);
+        }
+      }
+    }
+  };
+}
+
+//# sourceMappingURL=environments.graphql.js.map

package/dist/environments.graphql.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_graphqlTag","data","require","environmentsSchema","environments","typeDefs","gql","resolvers","Component","env","component","getDescriptor"],"sources":["environments.graphql.ts"],"sourcesContent":["import { Component } from '@teambit/component';\nimport { Schema } from '@teambit/graphql';\nimport { gql } from 'graphql-tag';\n\nimport { EnvsMain } from './environments.main.runtime';\n\nexport function environmentsSchema(environments: EnvsMain): Schema {\n  return {\n    typeDefs: gql`\n      extend type Component {\n        env: ExtensionDescriptor\n      }\n\n      type ExtensionDescriptor {\n        id: String\n        icon: String\n      }\n    `,\n    resolvers: {\n      Component: {\n        env: (component: Component) => {\n          return environments.getDescriptor(component);\n        },\n      },\n    },\n  };\n}\n"],"mappings":";;;;;;AAEA,SAAAA,YAAA;EAAA,MAAAC,IAAA,GAAAC,OAAA;EAAAF,WAAA,YAAAA,CAAA;IAAA,OAAAC,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAIO,SAASE,kBAAkBA,CAACC,YAAsB,EAAU;EACjE,OAAO;IACLC,QAAQ,EAAE,IAAAC,iBAAG;AACjB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,KAAK;IACDC,SAAS,EAAE;MACTC,SAAS,EAAE;QACTC,GAAG,EAAGC,SAAoB,IAAK;UAC7B,OAAON,YAAY,CAACO,aAAa,CAACD,SAAS,CAAC;QAC9C;MACF;IACF;EACF,CAAC;AACH","ignoreList":[]}