@teambit/tester 1.0.227 → 1.0.229

package/dist/exceptions/index.d.ts

@@ -0,0 +1,2 @@
+export { NoTestFilesFound } from './no-test-files-found';
+export { NoMatchingComponents } from './no-matching-components';

package/dist/exceptions/no-matching-components.d.ts

@@ -0,0 +1,3 @@
+export declare class NoMatchingComponents extends Error {
+    constructor(pattern: string);
+}

package/dist/exceptions/no-test-files-found.d.ts

@@ -0,0 +1,4 @@
+import { BitError } from '@teambit/bit-error';
+export declare class NoTestFilesFound extends BitError {
+    constructor(testRegex: string);
+}

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+import { TesterAspect } from './tester.aspect';
+export { Tests } from './tester';
+export type { TesterEnv } from './tester-env';
+export type { Tester, TesterContext, CallbackFn, SpecFiles, ComponentPatternsMap, ComponentsResults, ComponentPatternsEntry, } from './tester';
+export type { TesterMain } from './tester.main.runtime';
+export type { TesterUI, EmptyStateSlot } from './tester.ui.runtime';
+export { TesterAspect };
+export default TesterAspect;

package/dist/{preview-1712719054377.js → preview-1712822929999.js}

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

package/dist/test.cmd.d.ts

@@ -0,0 +1,35 @@
+import { Command, CommandOptions } from '@teambit/cli';
+import { Logger } from '@teambit/logger';
+import { Workspace } from '@teambit/workspace';
+import type { TesterMain } from './tester.main.runtime';
+type TestFlags = {
+    watch: boolean;
+    debug: boolean;
+    all: boolean;
+    unmodified: boolean;
+    env?: string;
+    scope?: string;
+    junit?: string;
+    coverage?: boolean;
+};
+export declare class TestCmd implements Command {
+    private tester;
+    private workspace;
+    private logger;
+    name: string;
+    description: string;
+    helpUrl: string;
+    arguments: {
+        name: string;
+        description: string;
+    }[];
+    alias: string;
+    group: string;
+    options: CommandOptions;
+    constructor(tester: TesterMain, workspace: Workspace, logger: Logger);
+    report([userPattern]: [string], { watch, debug, all, env, scope, junit, coverage, unmodified }: TestFlags): Promise<"" | {
+        code: number;
+        data: string;
+    }>;
+}
+export {};

package/dist/tester-env.d.ts

@@ -0,0 +1,5 @@
+import { EnvHandler } from '@teambit/envs';
+import { Tester } from './tester';
+export interface TesterEnv {
+    tester(): EnvHandler<Tester>;
+}

package/dist/tester.aspect.d.ts

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

package/dist/tester.composition.d.ts

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

package/dist/tester.d.ts

@@ -0,0 +1,151 @@
+import { Component, ComponentID, ComponentMap } from '@teambit/component';
+import { ExecutionContext } from '@teambit/envs';
+import { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';
+import { TestsResult } from '@teambit/tests-results';
+export declare class Tests {
+    components: ComponentsResults[];
+    constructor(components: ComponentsResults[]);
+    get errors(): Error[];
+}
+export type ComponentsResults = {
+    /**
+     * component id.
+     */
+    componentId: ComponentID;
+    /**
+     * test results for the component.
+     */
+    results?: TestsResult;
+    /**
+     * aggregated errors from all files
+     */
+    errors?: Error[];
+    /**
+     * loading.
+     */
+    loading?: boolean;
+};
+export type SpecFiles = ComponentMap<AbstractVinyl[]>;
+export type ComponentPatternsEntry = {
+    /**
+     * component directory in the workspace.
+     */
+    componentDir: string;
+    /**
+     * paths to test files.
+     */
+    paths: {
+        path: string;
+        relative: string;
+    }[];
+    /**
+     * root dir of the package in bit_roots.
+     */
+    packageRootDir: string;
+};
+export type ComponentPatternsMap = ComponentMap<ComponentPatternsEntry>;
+export interface TesterContext extends ExecutionContext {
+    /**
+     * whether the tester run for release (during bit build/tag) or not (during bit test command).
+     */
+    release: boolean;
+    /**
+     * list of components to test.
+     */
+    components: Component[];
+    /**
+     * component workspace.
+     */
+    /**
+     * defines whether tester is expected to run in quiet mode.
+     */
+    quiet?: boolean;
+    /**
+     * list of spec files to test.
+     */
+    specFiles: SpecFiles;
+    /**
+     * list of source spec files to test.
+     */
+    sourceSpecFiles?: SpecFiles;
+    /**
+     * rootPath of the component workspace or the capsule root dir (during build).
+     */
+    rootPath: string;
+    /**
+     * determines whether tester is expected to run in debug mode.
+     */
+    debug?: boolean;
+    /**
+     * is start from ui
+     */
+    ui?: boolean;
+    /**
+     * determines whether to start the tester in watch mode.
+     */
+    watch?: boolean;
+    /**
+     * whether the tester should show code coverage
+     */
+    coverage?: boolean;
+    /**
+     * array of patterns to test.
+     */
+    patterns: ComponentPatternsMap;
+    /**
+     * array of source files patterns to test.
+     */
+    sourcePatterns?: ComponentPatternsMap;
+    /**
+     *
+     * additional test host dependencies
+     * 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.
+     */
+    additionalHostDependencies?: string[];
+}
+/**
+ * tester interface allows extensions to implement a component tester into bit.
+ */
+export interface Tester {
+    /**
+     * display name of the tester.
+     */
+    displayName?: string;
+    /**
+     * icon of the tester.
+     */
+    icon?: string;
+    /**
+     * serialized config of the tester.
+     */
+    displayConfig?(): string;
+    /**
+     * path to the config in the filesystem.
+     */
+    configPath?: string;
+    /**
+     * id of the tester.
+     */
+    id: string;
+    /**
+     * on test run complete. (applies only during watch)
+     * @param callback
+     */
+    onTestRunComplete?(callback: CallbackFn): Promise<void>;
+    /**
+     * execute tests on all components in the given execution context.
+     */
+    test(context: TesterContext): Promise<Tests>;
+    /**
+     * watch tests on all components
+     */
+    watch?(context: TesterContext): Promise<Tests>;
+    /**
+     * return the tester version.
+     */
+    version(): string;
+}
+export type CallbackFn = (testSuite: Tests) => void;

package/dist/tester.graphql.d.ts

@@ -0,0 +1,3 @@
+import { GraphqlMain, Schema } from '@teambit/graphql';
+import { TesterMain } from './tester.main.runtime';
+export declare function testerSchema(tester: TesterMain, graphql: GraphqlMain): Schema;

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

@@ -0,0 +1,152 @@
+import { CLIMain } from '@teambit/cli';
+import { Component, IComponent } from '@teambit/component';
+import { EnvsExecutionResult, EnvsMain } from '@teambit/envs';
+import { LoggerMain } from '@teambit/logger';
+import { Workspace } from '@teambit/workspace';
+import { GraphqlMain } from '@teambit/graphql';
+import { BuilderMain } from '@teambit/builder';
+import { UiMain } from '@teambit/ui';
+import { DevFilesMain } from '@teambit/dev-files';
+import { TestsResult } from '@teambit/tests-results';
+import { ComponentsResults, CallbackFn, Tests } from './tester';
+import { TesterService } from './tester.service';
+import { TesterTask } from './tester.task';
+export type TesterExtensionConfig = {
+    /**
+     * regex of the text environment.
+     */
+    testRegex: string;
+    /**
+     * determine whether to watch on start.
+     */
+    watchOnStart: boolean;
+    patterns: string[];
+};
+export type TesterOptions = {
+    /**
+     * start the tester in watch mode.
+     */
+    watch: boolean;
+    /**
+     * start the tester in debug mode.
+     */
+    debug: boolean;
+    /**
+     * start the tester in debug mode.
+     */
+    ui?: boolean;
+    /**
+     * initiate the tester on given env.
+     */
+    env?: string;
+    /**
+     * generate JUnit files on the specified dir
+     */
+    junit?: string;
+    /**
+     * show code coverage
+     */
+    coverage?: boolean;
+    callback?: CallbackFn;
+};
+export declare class TesterMain {
+    private patterns;
+    /**
+     * graphql extension.
+     */
+    private graphql;
+    /**
+     * envs extension.
+     */
+    private envs;
+    /**
+     * workspace extension.
+     */
+    private workspace;
+    /**
+     * tester service.
+     */
+    readonly service: TesterService;
+    /**
+     * build task.
+     */
+    readonly task: TesterTask;
+    private devFiles;
+    private builder;
+    static runtime: import("@teambit/harmony").RuntimeDefinition;
+    static dependencies: import("@teambit/harmony").Aspect[];
+    constructor(patterns: string[], 
+    /**
+     * graphql extension.
+     */
+    graphql: GraphqlMain, 
+    /**
+     * envs extension.
+     */
+    envs: EnvsMain, 
+    /**
+     * workspace extension.
+     */
+    workspace: Workspace, 
+    /**
+     * tester service.
+     */
+    service: TesterService, 
+    /**
+     * build task.
+     */
+    task: TesterTask, devFiles: DevFilesMain, builder: BuilderMain);
+    _testsResults: {
+        [componentId: string]: ComponentsResults;
+    } | undefined[];
+    test(components: Component[], opts?: TesterOptions): Promise<EnvsExecutionResult<Tests>>;
+    private generateJUnit;
+    /**
+     * watch all components for changes and test upon each.
+     */
+    watch(components: Component[], opts?: TesterOptions): Promise<EnvsExecutionResult<Tests>>;
+    uiWatch(): Promise<EnvsExecutionResult<Tests>>;
+    getTestsResults(component: IComponent, idHasVersion?: boolean): Promise<{
+        testsResults?: TestsResult;
+        loading: boolean;
+    } | undefined>;
+    private getTestsResultsFromState;
+    /**
+     * Get the tests patterns from the config. (used as default patterns in case the env does not provide them via getTestsDevPatterns)
+     * @returns
+     */
+    getPatterns(): string[];
+    getComponentDevPatterns(component: Component): {
+        name: string;
+        pattern: string[];
+    };
+    getDevPatternToRegister(): (component: Component) => {
+        name: string;
+        pattern: string[];
+    };
+    /**
+     * get all test files of a component.
+     */
+    getTestFiles(component: Component): import("@teambit/legacy/dist/consumer/component/sources").AbstractVinyl[];
+    private getOptions;
+    static defaultConfig: {
+        /**
+         * default test regex for which files tester to apply on.
+         */
+        patterns: string[];
+        /**
+         * determine whether to watch on start.
+         */
+        watchOnStart: boolean;
+    };
+    static provider([cli, envs, workspace, loggerAspect, graphql, ui, devFiles, builder]: [
+        CLIMain,
+        EnvsMain,
+        Workspace,
+        LoggerMain,
+        GraphqlMain,
+        UiMain,
+        DevFilesMain,
+        BuilderMain
+    ], config: TesterExtensionConfig): Promise<TesterMain>;
+}

package/dist/tester.service.d.ts

@@ -0,0 +1,51 @@
+import { Logger } from '@teambit/logger';
+import { EnvService, ExecutionContext, EnvDefinition, Env, EnvContext, ServiceTransformationMap } from '@teambit/envs';
+import { Workspace } from '@teambit/workspace';
+import { PubSubEngine } from 'graphql-subscriptions';
+import { DevFilesMain } from '@teambit/dev-files';
+import { Tester, Tests, CallbackFn } from './tester';
+import { TesterOptions } from './tester.main.runtime';
+export declare const OnTestsChanged = "OnTestsChanged";
+type TesterTransformationMap = ServiceTransformationMap & {
+    getTester: () => Tester;
+};
+export type TesterDescriptor = {
+    /**
+     * id of the tester (e.g. jest/mocha)
+     */
+    id: string;
+    /**
+     * display name of the tester (e.g. Jest / Mocha)
+     */
+    displayName: string;
+    /**
+     * icon of the configured tester.
+     */
+    icon: string;
+    /**
+     * string containing the config for display.
+     */
+    config: string;
+    version?: string;
+};
+export declare class TesterService implements EnvService<Tests, TesterDescriptor> {
+    readonly workspace: Workspace;
+    private logger;
+    private pubsub;
+    private devFiles;
+    name: string;
+    constructor(workspace: Workspace, logger: Logger, pubsub: PubSubEngine, devFiles: DevFilesMain);
+    _callback: CallbackFn | undefined;
+    render(env: EnvDefinition): string;
+    getDescriptor(environment: EnvDefinition): {
+        id: string;
+        displayName: string;
+        icon: string;
+        config: string;
+        version: string;
+    } | undefined;
+    transform(env: Env, context: EnvContext): TesterTransformationMap | undefined;
+    onTestRunComplete(callback: CallbackFn): void;
+    run(context: ExecutionContext, options: TesterOptions): Promise<Tests>;
+}
+export {};

package/dist/tester.task.d.ts

@@ -0,0 +1,19 @@
+import { BuildContext, BuiltTaskResult, BuildTask } from '@teambit/builder';
+import { DevFilesMain } from '@teambit/dev-files';
+/**
+ * tester build task. Allows to test components during component build.
+ */
+export declare class TesterTask implements BuildTask {
+    readonly aspectId: string;
+    private devFiles;
+    readonly name = "TestComponents";
+    readonly dependencies: string[];
+    constructor(aspectId: string, devFiles: DevFilesMain);
+    execute(context: BuildContext): Promise<BuiltTaskResult>;
+}
+export declare function getJUnitArtifactPath(): string;
+export declare function getArtifactDef(): {
+    name: string;
+    globPatterns: string[];
+    rootDir: string;
+}[];

package/dist/tester.ui.runtime.d.ts

@@ -0,0 +1,21 @@
+import React, { ComponentType } from 'react';
+import { SlotRegistry } from '@teambit/harmony';
+import { ComponentUI } from '@teambit/component';
+import { ComponentCompareUI } from '@teambit/component-compare';
+export type EmptyStateSlot = SlotRegistry<ComponentType>;
+export declare class TesterUI {
+    private component;
+    private emptyStateSlot;
+    static dependencies: import("@teambit/harmony").Aspect[];
+    static runtime: import("@teambit/harmony").RuntimeDefinition;
+    stageKey?: string;
+    constructor(component: ComponentUI, emptyStateSlot: EmptyStateSlot);
+    /**
+     * register a new tester empty state. this allows to register a different empty state from each environment for example.
+     */
+    registerEmptyState(emptyStateComponent: ComponentType): this;
+    getTesterCompare(): import("react/jsx-runtime").JSX.Element;
+    static slots: ((registerFn: () => string) => SlotRegistry<React.ComponentType>)[];
+    static provider([component, componentCompare]: [ComponentUI, ComponentCompareUI], config: any, [emptyStateSlot]: [EmptyStateSlot]): Promise<TesterUI>;
+}
+export default TesterUI;

package/dist/tests.section.d.ts

@@ -0,0 +1,15 @@
+import { Section } from '@teambit/component';
+import { EmptyStateSlot } from './tester.ui.runtime';
+export declare class TestsSection implements Section {
+    private emptyStateSlot;
+    constructor(emptyStateSlot: EmptyStateSlot);
+    route: {
+        path: string;
+        element: import("react/jsx-runtime").JSX.Element;
+    };
+    navigationLink: {
+        href: string;
+        children: string;
+    };
+    order: number;
+}

package/dist/utils/detect-spec-files.d.ts

@@ -0,0 +1,6 @@
+import { Component } from '@teambit/component';
+import { DevFilesMain } from '@teambit/dev-files';
+/**
+ * detect test files in components
+ */
+export declare function detectTestFiles(component: Component, devFiles: DevFilesMain): import("@teambit/legacy/dist/consumer/component/sources").AbstractVinyl[];

package/dist/utils/index.d.ts

@@ -0,0 +1 @@
+export { detectTestFiles } from './detect-spec-files';

package/dist/utils/junit-generator.d.ts

@@ -0,0 +1,2 @@
+import { ComponentsResults } from '../tester';
+export declare function testsResultsToJUnitFormat(components: ComponentsResults[]): string;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/tester",
-  "version": "1.0.227",
+  "version": "1.0.229",
   "homepage": "https://bit.cloud/teambit/defender/tester",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.defender",
     "name": "tester",
-    "version": "1.0.227"
+    "version": "1.0.229"
   },
   "dependencies": {
     "chalk": "2.4.2",
@@ -23,17 +23,17 @@
     "@teambit/tests-results": "1.0.4",
     "@teambit/defender.ui.test-compare-section": "0.0.100",
     "@teambit/bit-error": "0.0.404",
-    "@teambit/cli": "0.0.860",
-    "@teambit/logger": "0.0.953",
-    "@teambit/workspace": "1.0.227",
-    "@teambit/envs": "1.0.227",
-    "@teambit/component": "1.0.227",
-    "@teambit/graphql": "1.0.227",
-    "@teambit/builder": "1.0.227",
-    "@teambit/dev-files": "1.0.227",
-    "@teambit/ui": "1.0.227",
-    "@teambit/compiler": "1.0.227",
-    "@teambit/component-compare": "1.0.227",
+    "@teambit/cli": "0.0.862",
+    "@teambit/logger": "0.0.955",
+    "@teambit/workspace": "1.0.229",
+    "@teambit/envs": "1.0.229",
+    "@teambit/component": "1.0.229",
+    "@teambit/graphql": "1.0.229",
+    "@teambit/builder": "1.0.229",
+    "@teambit/dev-files": "1.0.229",
+    "@teambit/ui": "1.0.229",
+    "@teambit/compiler": "1.0.229",
+    "@teambit/component-compare": "1.0.229",
     "@teambit/defender.ui.test-compare": "0.0.262",
     "@teambit/defender.ui.test-page": "0.0.40"
   },
@@ -44,7 +44,7 @@
     "@types/mocha": "9.1.0",
     "chai": "4.3.0",
     "@teambit/defender.content.tester-overview": "1.95.0",
-    "@teambit/harmony.envs.core-aspect-env": "0.0.30"
+    "@teambit/harmony.envs.core-aspect-env": "0.0.33"
   },
   "peerDependencies": {
     "react": "^17.0.0 || ^18.0.0",

package/tsconfig.json

@@ -20,8 +20,7 @@
     "emitDeclarationOnly": true,
     "strict": true,
     "strictPropertyInitialization": false,
-    "noImplicitAny": false,
-    "composite": true
+    "noImplicitAny": false
   },
   "exclude": [
     "artifacts",
@@ -36,40 +35,5 @@
   "include": [
     "**/*",
     "**/*.json"
-  ],
-  "references": [
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_cli@0.0.860"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_logger@0.0.953"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.workspace_workspace@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.envs_envs@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_component@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_graphql@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.pipelines_builder@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_dev-files@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.ui-foundation_ui@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.compilation_compiler@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_component-compare@1.0.227"
-    }
   ]
 }