@teambit/envs 0.0.0-3e44e878fae3f5f31fce2dc240a57a798e67137e

package/services/index.ts

@@ -0,0 +1,13 @@
+export {
+  Service as EnvService,
+  ServiceExecutionResult,
+  TransformationMap as ServiceTransformationMap,
+} from './service';
+export { ConcreteService } from './concrete-service';
+export {
+  ServiceHandler,
+  ServiceHandlerFactory,
+  AsyncServiceHandlerFactory,
+  reduceServiceHandlersFactories,
+} from './service-handler';
+export { ServiceHandlerContext } from './service-handler-context';

package/services/service-handler-context.ts

@@ -0,0 +1,40 @@
+import { ComponentID } from '@teambit/component';
+import { Harmony } from '@teambit/harmony';
+import { Logger, LoggerMain } from '@teambit/logger';
+import { WorkerMain } from '@teambit/worker';
+
+export class ServiceHandlerContext {
+  constructor(
+    /**
+     * id of the environment defined in the context.
+     */
+    readonly envId: ComponentID,
+    readonly loggerMain: LoggerMain,
+    readonly workerMain: WorkerMain,
+    readonly harmony: Harmony
+  ) {}
+
+  /**
+   * return a logger instance for the env.
+   */
+  createLogger(name?: string): Logger {
+    const loggerName = name ? `${this.envId.toString()}::${name}` : this.envId.toString();
+
+    return this.loggerMain.createLogger(loggerName);
+  }
+
+  /**
+   * get an instance of an aspect. make sure it is loaded prior to requesting it.
+   */
+  getAspect<T>(aspectId: string) {
+    return this.harmony.get<T>(aspectId);
+  }
+
+  /**
+   * create worker for the env context.
+   */
+  createWorker<T>(name: string, path: string) {
+    const worker = this.workerMain.declareWorker<T>(name, path);
+    return worker;
+  }
+}

package/services/service-handler.ts

@@ -0,0 +1,41 @@
+import { ServiceHandlerContext } from './service-handler-context';
+
+/**
+ * definition of the service handler.
+ */
+export type ServiceHandlerFactory<T> = (context: ServiceHandlerContext) => ServiceHandler & T;
+export type AsyncServiceHandlerFactory<T> = (context: ServiceHandlerContext) => Promise<ServiceHandler & T>;
+
+export interface ServiceHandler {
+  /**
+   * name of the service. e.g. 'typescript-compiler'
+   */
+  name?: string;
+  /**
+   * version of the service. optional.
+   */
+  version?: () => string;
+
+  /**
+   * config of the service. e.g. tsconfig.json
+   */
+  // config?: string;
+}
+
+export type ReduceFactoryCallback<T> = (acc: T, value: T) => ServiceHandler & T;
+export function reduceServiceHandlersFactories<T>(
+  factories: ServiceHandlerFactory<T>[],
+  callback: ReduceFactoryCallback<T>
+): ServiceHandlerFactory<T> {
+  if (!factories.length) throw new Error('no factories were provided');
+  const result: ServiceHandlerFactory<T> = (context: ServiceHandlerContext) => {
+    // @ts-ignore
+    const initialVal = factories.shift()(context);
+    const reduced: ServiceHandler & T = factories.reduce((acc, currFactory) => {
+      const curr = currFactory(context);
+      return callback(acc, curr);
+    }, initialVal);
+    return reduced;
+  };
+  return result;
+}

package/services/service.ts

@@ -0,0 +1,79 @@
+import { Component } from '@teambit/component';
+import { Env } from '../env-interface';
+import { Environment } from '../environment';
+import { ServiceHandler } from './service-handler';
+import { ServiceHandlerContext } from './service-handler-context';
+
+export type EnvContext = {
+  components: Component[];
+};
+
+export interface ServiceExecutionResult {
+  errors?: Error[];
+}
+
+export type ServiceTransformHandlerFactory<T> = (
+  handlerContext?: any
+) => (ServiceHandler & T) | Promise<ServiceHandler & T>;
+
+/**
+ * definition of the service handler type
+ * This used to define new types of handlers like
+ * Compiler, Tester, Preview, etc.
+ */
+export type TransformationMap = {
+  /**
+   * The name of the function that will be called on the service run/run once later.
+   * This func will be exist on the final env object
+   */
+  [funcName: string]: ServiceTransformHandlerFactory<any>;
+};
+
+/**
+ * services allows to reuse and standardize services for development environments.
+ * examples for services can be: `linting`, `compilation`, `build`, and others which offer
+ * standard services to environments such as `react`, `angular` and `vue` and different compositions of each for
+ * more concrete needs.
+ *
+ * `TData` - type of data returned by the service handler.
+ * `TOpts` is the type of options passed to the environment through execution.
+ * `TExecResponse` is the execution result of the service.
+ */
+export interface Service<TExecResponse extends ServiceExecutionResult, TData = {}, TOpts = {}> {
+  /**
+   * name of the service. (e.g. `compile`, `test`, etc.)
+   */
+  name?: string;
+
+  /**
+   * description of the env.
+   */
+  description?: string;
+
+  /**
+   * create a string to describe to service in the env cli.
+   */
+  render?(env: Environment, context: EnvContext[]): string | Promise<string>;
+
+  /**
+   * get service data from an environment.
+   */
+  getDescriptor?(environment: Environment, context?: EnvContext[]): TData | undefined | Promise<TData | undefined>;
+
+  /**
+   * executes a service on a subset of components.
+   */
+  run?(context: EnvContext, options?: TOpts): Promise<TExecResponse>;
+
+  /**
+   * run the service only once.
+   */
+  runOnce?(context: EnvContext[], options?: TOpts): Promise<any>;
+
+  /**
+   * Return a map of functions that will be called on the service run/run once later.
+   * @param env the original env plugin object
+   * @param context ServiceHandlerContext(EnvContext)
+   */
+  transform?(env: Env, context: ServiceHandlerContext): TransformationMap | undefined;
+}

package/types/asset.d.ts

@@ -0,0 +1,41 @@
+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;
+}
+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;
+}
+declare module '*.otf' {
+  const value: any;
+  export = value;
+}
+declare module '*.woff' {
+  const value: any;
+  export = value;
+}
+declare module '*.woff2' {
+  const value: any;
+  export = value;
+}

package/types/style.d.ts

@@ -0,0 +1,42 @@
+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;
+}