@teambit/builder 1.0.227 → 1.0.229

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.pipelines_builder@1.0.227/dist/builder.composition.js';
-import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.pipelines_builder@1.0.227/dist/builder.docs.mdx';
+import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.pipelines_builder@1.0.229/dist/builder.composition.js';
+import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.pipelines_builder@1.0.229/dist/builder.docs.mdx';
 
 export const compositions = [compositions_0];
 export const overview = [overview_0];

package/dist/storage/default-resolver.d.ts

@@ -0,0 +1,7 @@
+import { Component } from '@teambit/component';
+import { FsArtifact } from '../artifact';
+import { WholeArtifactStorageResolver } from './storage-resolver';
+export declare class DefaultResolver implements WholeArtifactStorageResolver {
+    name: string;
+    store(component: Component, artifact: FsArtifact): Promise<void>;
+}

package/dist/storage/index.d.ts

@@ -0,0 +1,2 @@
+export { WholeArtifactStorageResolver, ArtifactStorageResolver, FileStorageResolver } from './storage-resolver';
+export { DefaultResolver } from './default-resolver';

package/dist/storage/storage-resolver.d.ts

@@ -0,0 +1,26 @@
+import { Component } from '@teambit/component';
+import { ArtifactVinyl } from '@teambit/legacy/dist/consumer/component/sources/artifact';
+import { FsArtifact } from '../artifact';
+export type StoreResult = {
+    [path: string]: string;
+};
+interface BaseStorageResolver {
+    /**
+     * name of the storage resolver.
+     */
+    name: string;
+}
+export interface WholeArtifactStorageResolver extends BaseStorageResolver {
+    /**
+     * store artifacts in the storage.
+     */
+    store(component: Component, artifact: FsArtifact): Promise<StoreResult | undefined | void>;
+}
+export interface FileStorageResolver extends BaseStorageResolver {
+    /**
+     * store artifacts in the storage.
+     */
+    storeFile(component: Component, artifact: FsArtifact, file: ArtifactVinyl): Promise<string | undefined | void>;
+}
+export type ArtifactStorageResolver = FileStorageResolver | WholeArtifactStorageResolver;
+export {};

package/dist/task-results-list.d.ts

@@ -0,0 +1,22 @@
+import { TasksQueue } from './tasks-queue';
+import { TaskResults } from './build-pipe';
+export declare class TaskResultsList {
+    tasksQueue: TasksQueue;
+    /**
+     * results of all tasks executed in the build pipeline.
+     */
+    tasksResults: TaskResults[];
+    capsuleRootDir: string;
+    constructor(tasksQueue: TasksQueue, 
+    /**
+     * results of all tasks executed in the build pipeline.
+     */
+    tasksResults: TaskResults[], capsuleRootDir: string);
+    hasErrors(): boolean;
+    throwErrorsIfExist(): void;
+    /**
+     * group errors from all tasks and show them nicely to the user
+     */
+    getErrorMessageFormatted(): string | null;
+    private aggregateTaskErrorsToOneString;
+}

package/dist/task.d.ts

@@ -0,0 +1,44 @@
+import { BuildContext, BuiltTaskResult } from './build-task';
+import { TaskResultsList } from './task-results-list';
+/**
+ * this is the external interface for task. please make
+ * sure to use only this interface outside of this builder
+ * aspect.
+ */
+export interface Task {
+    /**
+     * names ideally with dashes 'typescript'
+     */
+    name: string;
+    /**
+     * description of what the task does.
+     */
+    description?: string;
+    /**
+     * execute a task in a build context
+     */
+    execute(context: BuildContext): Promise<BuiltTaskResult>;
+    /**
+     * run before the build pipeline has started. this is useful when some preparation are needed to
+     * be done on all envs before the build starts.
+     * e.g. typescript compiler needs to write the tsconfig file. doing it during the task, will
+     * cause dependencies from other envs to get this tsconfig written.
+     */
+    preBuild?(context: BuildContext): Promise<void>;
+    /**
+     * run after the build pipeline completed for all envs. useful for doing some cleanup on the
+     * capsules before the deployment starts.
+     */
+    postBuild?(context: BuildContext, tasksResults: TaskResultsList): Promise<void>;
+    /**
+     * needed if you want the task to be running only after the dependencies were completed
+     * for *all* envs.
+     * normally this is not needed because the build-pipeline runs the tasks in the same order
+     * they're located in the `getBuildPipe()` array and according to the task.location.
+     * the case where this is useful is when a task not only needs to be after another task, but also
+     * after all environments were running that task.
+     * a dependency is task.aspectId. if an aspect has multiple tasks, to be more specific, use
+     * "aspectId:name", e.g. "teambit.compilation/compiler:TypescriptCompiler".
+     */
+    dependencies?: string[];
+}

package/dist/tasks-queue.d.ts

@@ -0,0 +1,16 @@
+import { EnvDefinition } from '@teambit/envs';
+import { BuildTask } from './build-task';
+type EnvTask = {
+    env: EnvDefinition;
+    task: BuildTask;
+};
+export declare class TasksQueue extends Array<EnvTask> {
+    toString(): string;
+    /**
+     * make sure tasks names are valid and there are no duplications
+     */
+    validate(): void;
+    private validateTaskName;
+    private validateDuplications;
+}
+export {};

package/dist/templates/build-task/files/index-file.d.ts

@@ -0,0 +1,2 @@
+import { ComponentContext } from '@teambit/generator';
+export declare function indexFile({ namePascalCase, name }: ComponentContext): string;

package/dist/templates/build-task/files/task-file.d.ts

@@ -0,0 +1,2 @@
+import { ComponentContext } from '@teambit/generator';
+export declare function taskFile({ namePascalCase }: ComponentContext): string;

package/dist/templates/build-task/index.d.ts

@@ -0,0 +1,2 @@
+import { ComponentTemplate } from '@teambit/generator';
+export declare const buildTaskTemplate: ComponentTemplate;

package/dist/types.d.ts

@@ -0,0 +1,32 @@
+import { Component } from '@teambit/component';
+export type TaskMetadata = {
+    [key: string]: any;
+};
+export type ComponentResult = {
+    /**
+     * instance of the component
+     */
+    component: Component;
+    /**
+     * metadata generated during component build.
+     * this eventually gets saved into `aspectsData` prop of the builder aspect data.
+     * it can be retrieved later on by `builder.getDataByAspect()` method.
+     */
+    metadata?: TaskMetadata;
+    /**
+     * returning errors from build tasks will cause a pipeline failure and logs all returned errors.
+     */
+    errors?: Array<Error | string>;
+    /**
+     * warnings generated throughout the build task.
+     */
+    warnings?: string[];
+    /**
+     * timestamp in milliseconds when the task started
+     */
+    startTime?: number;
+    /**
+     * timestamp in milliseconds when the task ended
+     */
+    endTime?: number;
+};

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/builder",
-  "version": "1.0.227",
+  "version": "1.0.229",
   "homepage": "https://bit.cloud/teambit/pipelines/builder",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.pipelines",
     "name": "builder",
-    "version": "1.0.227"
+    "version": "1.0.229"
   },
   "dependencies": {
     "chalk": "2.4.2",
@@ -26,23 +26,23 @@
     "@teambit/harmony": "0.4.6",
     "@teambit/bit-error": "0.0.404",
     "@teambit/component-id": "1.2.0",
-    "@teambit/component": "1.0.227",
-    "@teambit/envs": "1.0.227",
-    "@teambit/logger": "0.0.953",
+    "@teambit/component": "1.0.229",
+    "@teambit/envs": "1.0.229",
+    "@teambit/logger": "0.0.955",
     "@teambit/toolbox.string.capitalize": "0.0.496",
-    "@teambit/tester": "1.0.227",
-    "@teambit/isolator": "1.0.227",
-    "@teambit/cli": "0.0.860",
-    "@teambit/workspace": "1.0.227",
-    "@teambit/aspect-loader": "1.0.227",
-    "@teambit/aspect": "1.0.227",
-    "@teambit/generator": "1.0.228",
-    "@teambit/global-config": "0.0.863",
-    "@teambit/graphql": "1.0.227",
-    "@teambit/scope": "1.0.227",
+    "@teambit/tester": "1.0.229",
+    "@teambit/isolator": "1.0.229",
+    "@teambit/cli": "0.0.862",
+    "@teambit/workspace": "1.0.229",
+    "@teambit/aspect-loader": "1.0.229",
+    "@teambit/aspect": "1.0.229",
+    "@teambit/generator": "1.0.230",
+    "@teambit/global-config": "0.0.865",
+    "@teambit/graphql": "1.0.229",
+    "@teambit/scope": "1.0.229",
     "@teambit/toolbox.array.duplications-finder": "0.0.1",
-    "@teambit/ui": "1.0.227",
-    "@teambit/express": "0.0.959"
+    "@teambit/ui": "1.0.229",
+    "@teambit/express": "0.0.961"
   },
   "devDependencies": {
     "@types/lodash": "4.14.165",
@@ -52,7 +52,7 @@
     "@types/minimatch": "3.0.4",
     "@types/mocha": "9.1.0",
     "chai": "4.3.0",
-    "@teambit/harmony.envs.core-aspect-env": "0.0.30",
+    "@teambit/harmony.envs.core-aspect-env": "0.0.33",
     "@teambit/pipelines.aspect-docs.builder": "0.0.167"
   },
   "peerDependencies": {

package/tsconfig.json

@@ -20,8 +20,7 @@
     "emitDeclarationOnly": true,
     "strict": true,
     "strictPropertyInitialization": false,
-    "noImplicitAny": false,
-    "composite": true
+    "noImplicitAny": false
   },
   "exclude": [
     "artifacts",
@@ -36,52 +35,5 @@
   "include": [
     "**/*",
     "**/*.json"
-  ],
-  "references": [
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_component@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.harmony_logger@0.0.953"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.defender_tester@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_isolator@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_cli@0.0.860"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.workspace_workspace@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_aspect-loader@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_aspect@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.generator_generator@1.0.228"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_global-config@0.0.863"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_graphql@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.scope_scope@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.harmony_express@0.0.959"
-    }
   ]
 }