@teambit/pkg 0.0.554 → 0.0.555

package/dist/pack.task.d.ts

@@ -1,6 +1,9 @@
 import { BuildContext, BuiltTaskResult, BuildTask, TaskLocation } from '@teambit/builder';
 import { Logger } from '@teambit/logger';
 import { Packer } from './packer';
+/**
+ * pack components to a .tgz file
+ */
 export declare class PackTask implements BuildTask {
     readonly aspectId: string;
     private packer;

package/dist/package.route.d.ts

@@ -3,8 +3,15 @@ import { Request, Response, Route } from '@teambit/express';
 import { PkgMain } from './pkg.main.runtime';
 export declare const routePath = "package";
 export declare class PackageRoute implements Route {
+    /**
+     * pkg extension.
+     */
     private pkg;
-    constructor(pkg: PkgMain);
+    constructor(
+    /**
+     * pkg extension.
+     */
+    pkg: PkgMain);
     route: string;
     method: string;
     middlewares: ((req: Request, res: Response) => Promise<import("express").Response<any>>)[];

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

@@ -19,12 +19,30 @@ export interface PackageJsonProps {
 }
 export declare type PackageJsonPropsRegistry = SlotRegistry<PackageJsonProps>;
 export declare type PkgExtensionConfig = {};
+/**
+ * Config for variants
+ */
 export declare type ComponentPkgExtensionConfig = {
+    /**
+     * properties to add to the package.json of the component.
+     */
     packageJson: Record<string, any>;
 };
+/**
+ * Data stored in the component
+ */
 export declare type ComponentPkgExtensionData = {
+    /**
+     * properties to add to the package.json of the component.
+     */
     packageJsonModification: Record<string, any>;
+    /**
+     * Final package.json after creating tar file
+     */
     pkgJson?: Record<string, any>;
+    /**
+     * Checksum of the tar file
+     */
     checksum?: string;
 };
 declare type ComponentPackageManifest = {
@@ -41,15 +59,33 @@ declare type VersionPackageManifest = {
     };
 };
 export declare class PkgMain {
+    /**
+     * logger extension
+     */
     readonly logger: Logger;
+    /**
+     * pkg extension configuration.
+     */
     readonly config: PkgExtensionConfig;
+    /**
+     * Registry for changes by other extensions.
+     */
     private packageJsonPropsRegistry;
     private workspace;
     private scope;
     private builder;
+    /**
+     * A utils class to packing components into tarball
+     */
     private packer;
+    /**
+     * envs extension.
+     */
     private envs;
     private componentAspect;
+    /**
+     * keep it as public. external env might want to register it to the snap pipeline
+     */
     publishTask: PublishTask;
     static runtime: import("@teambit/harmony").RuntimeDefinition;
     static dependencies: import("@teambit/harmony").Aspect[];
@@ -67,18 +103,81 @@ export declare class PkgMain {
         ComponentMain,
         GraphqlMain
     ], config: PkgExtensionConfig, [packageJsonPropsRegistry]: [PackageJsonPropsRegistry]): Promise<PkgMain>;
+    /**
+     * get the package name of a component.
+     */
     getPackageName(component: Component): string;
+    /**
+     * returns the package path in the /node_modules/ folder
+     */
     getModulePath(component: Component, options?: {
         absPath?: boolean;
     }): string;
-    constructor(logger: Logger, config: PkgExtensionConfig, packageJsonPropsRegistry: PackageJsonPropsRegistry, workspace: Workspace, scope: ScopeMain, builder: BuilderMain, packer: Packer, envs: EnvsMain, componentAspect: ComponentMain, publishTask: PublishTask);
+    /**
+     *Creates an instance of PkgExtension.
+     * @param {PkgExtensionConfig} config
+     * @param {PackageJsonPropsRegistry} packageJsonPropsRegistry
+     * @param {Packer} packer
+     * @memberof PkgExtension
+     */
+    constructor(
+    /**
+     * logger extension
+     */
+    logger: Logger, 
+    /**
+     * pkg extension configuration.
+     */
+    config: PkgExtensionConfig, 
+    /**
+     * Registry for changes by other extensions.
+     */
+    packageJsonPropsRegistry: PackageJsonPropsRegistry, workspace: Workspace, scope: ScopeMain, builder: BuilderMain, 
+    /**
+     * A utils class to packing components into tarball
+     */
+    packer: Packer, 
+    /**
+     * envs extension.
+     */
+    envs: EnvsMain, componentAspect: ComponentMain, 
+    /**
+     * keep it as public. external env might want to register it to the snap pipeline
+     */
+    publishTask: PublishTask);
+    /**
+     * register changes in the package.json
+     */
     registerPackageJsonNewProps(props: PackageJsonProps): void;
+    /**
+     * Pack a component and generate a tarball suitable for npm registry
+     *
+     * @param {string} componentId
+     * @param {(string | undefined)} scopePath
+     * @param {string} outDir
+     * @param {boolean} [prefix=false]
+     * @param {boolean} [override=false]
+     * @param {boolean} [keep=false]
+     * @returns {Promise<PackResult>}
+     * @memberof PkgExtension
+     */
     packComponent(componentId: string, scopePath: string | undefined, options: PackOptions): Promise<PackResult>;
+    /**
+     * Merge the configs provided by:
+     * 1. envs configured in the component - via getPackageJsonProps method
+     * 2. extensions that registered to the registerPackageJsonNewProps slot (and configured for the component)
+     * 3. props defined by the user (they are the strongest one)
+     */
     mergePackageJsonProps(component: Component): Promise<PackageJsonProps>;
     getPackageJsonModifications(component: Component): Record<string, any>;
     getPkgArtifact(component: Component): Promise<PkgArtifact>;
     getManifest(component: Component): Promise<ComponentPackageManifest>;
     private getAllSnapsManifests;
+    /**
+     * Check if the component should be fetched from bit registry or from another registry
+     * This will usually determined by the latest version of the component
+     * @param component
+     */
     isPublishedToExternalRegistry(component: Component): boolean;
     private getComponentBuildData;
     getSnapManifest(component: Component, snap: Snap): Promise<VersionPackageManifest | undefined>;

package/dist/prepare-packages.task.d.ts

@@ -1,5 +1,8 @@
 import { BuildContext, BuiltTaskResult, BuildTask } from '@teambit/builder';
 import { Logger } from '@teambit/logger';
+/**
+ * prepare packages for publishing.
+ */
 export declare class PreparePackagesTask implements BuildTask {
     readonly aspectId: string;
     private logger;
@@ -7,8 +10,19 @@ export declare class PreparePackagesTask implements BuildTask {
     readonly location = "end";
     constructor(aspectId: string, logger: Logger);
     execute(context: BuildContext): Promise<BuiltTaskResult>;
+    /**
+     * remove the source files and copy the dists files
+     * into the root of the capsule.
+     * this is needed when components import from other components internal paths. without this task,
+     * the internal paths are the source, so node will throw an error when trying to use them. this
+     * task makes sure that the internal paths point to the consumable code (dists).
+     */
     private executeDistAsRootTask;
     private removeSourceFiles;
     private moveDistToRoot;
+    /**
+     * by default, the "main" prop points to the dist file (e.g. "dist/index./js").
+     * here, we have to change it because there is no dist dir anymore.
+     */
     private updatePackageJson;
 }

package/dist/publish-dry-run.task.d.ts

@@ -2,6 +2,9 @@ import { BuildContext, BuiltTaskResult, BuildTask } from '@teambit/builder';
 import { Logger } from '@teambit/logger';
 import { Publisher } from './publisher';
 import { Packer } from './packer';
+/**
+ * publish build task is running "publish --dry-run" to avoid later npm errors during export
+ */
 export declare class PublishDryRunTask implements BuildTask {
     readonly aspectId: string;
     private publisher;

package/dist/publish.task.d.ts

@@ -1,6 +1,9 @@
 import { BuildContext, BuiltTaskResult, BuildTask, TaskLocation } from '@teambit/builder';
 import { Logger } from '@teambit/logger';
 import { Publisher } from './publisher';
+/**
+ * publish components by running "npm publish"
+ */
 export declare class PublishTask implements BuildTask {
     readonly aspectId: string;
     private publisher;

package/dist/publisher.d.ts

@@ -21,6 +21,10 @@ export declare class Publisher {
     private publishOneCapsule;
     private getTagFlagForPreRelease;
     private getComponentCapsules;
+    /**
+     * only components that use pkg extension and configure "publishConfig" with their own registry
+     * or custom "name", should be published. ignore the rest.
+     */
     private getIdsToPublish;
     shouldPublish(extensions: ExtensionDataList): boolean;
     private getExtraArgsFromConfig;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/pkg",
-  "version": "0.0.554",
+  "version": "0.0.555",
   "homepage": "https://bit.dev/teambit/pkg/pkg",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.pkg",
     "name": "pkg",
-    "version": "0.0.554"
+    "version": "0.0.555"
   },
   "dependencies": {
     "chalk": "2.4.2",
@@ -22,20 +22,20 @@
     "p-map-series": "2.1.0",
     "@babel/runtime": "7.12.18",
     "core-js": "^3.0.0",
-    "@teambit/cli": "0.0.385",
-    "@teambit/builder": "0.0.554",
-    "@teambit/logger": "0.0.470",
-    "@teambit/component": "0.0.554",
-    "@teambit/express": "0.0.474",
-    "@teambit/isolator": "0.0.554",
-    "@teambit/scope": "0.0.554",
-    "@teambit/graphql": "0.0.554",
-    "@teambit/bit-error": "0.0.371",
-    "@teambit/dependency-resolver": "0.0.554",
-    "@teambit/envs": "0.0.554",
-    "@teambit/workspace": "0.0.554",
-    "@teambit/compiler": "0.0.554",
-    "@teambit/legacy-bit-id": "0.0.374"
+    "@teambit/cli": "0.0.386",
+    "@teambit/builder": "0.0.555",
+    "@teambit/logger": "0.0.471",
+    "@teambit/component": "0.0.555",
+    "@teambit/express": "0.0.475",
+    "@teambit/isolator": "0.0.555",
+    "@teambit/scope": "0.0.555",
+    "@teambit/graphql": "0.0.555",
+    "@teambit/bit-error": "0.0.372",
+    "@teambit/dependency-resolver": "0.0.555",
+    "@teambit/envs": "0.0.555",
+    "@teambit/workspace": "0.0.555",
+    "@teambit/compiler": "0.0.555",
+    "@teambit/legacy-bit-id": "0.0.375"
   },
   "devDependencies": {
     "@types/mime": "2.0.3",
@@ -47,10 +47,10 @@
     "@types/jest": "^26.0.0",
     "@types/react-dom": "^17.0.5",
     "@types/node": "12.20.4",
-    "@teambit/pkg.aspect-docs.pkg": "0.0.104"
+    "@teambit/pkg.aspect-docs.pkg": "0.0.105"
   },
   "peerDependencies": {
-    "@teambit/legacy": "1.0.171",
+    "@teambit/legacy": "1.0.172",
     "react-dom": "^16.8.0 || ^17.0.0",
     "react": "^16.8.0 || ^17.0.0"
   },
@@ -78,7 +78,7 @@
         "react": "-"
       },
       "peerDependencies": {
-        "@teambit/legacy": "1.0.171",
+        "@teambit/legacy": "1.0.172",
         "react-dom": "^16.8.0 || ^17.0.0",
         "react": "^16.8.0 || ^17.0.0"
       }

package/tsconfig.json

@@ -25,7 +25,6 @@
     "strict": true,
     "noImplicitAny": false,
     "rootDir": ".",
-    "removeComments": true,
     "preserveConstEnums": true,
     "resolveJsonModule": true
   },