@teambit/pkg 0.0.553 → 0.0.557

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/pkg",
-  "version": "0.0.553",
+  "version": "0.0.557",
   "homepage": "https://bit.dev/teambit/pkg/pkg",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.pkg",
     "name": "pkg",
-    "version": "0.0.553"
+    "version": "0.0.557"
   },
   "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.384",
-    "@teambit/builder": "0.0.553",
-    "@teambit/logger": "0.0.469",
-    "@teambit/component": "0.0.553",
-    "@teambit/express": "0.0.473",
-    "@teambit/isolator": "0.0.553",
-    "@teambit/scope": "0.0.553",
-    "@teambit/graphql": "0.0.553",
-    "@teambit/bit-error": "0.0.370",
-    "@teambit/dependency-resolver": "0.0.553",
-    "@teambit/envs": "0.0.553",
-    "@teambit/workspace": "0.0.553",
-    "@teambit/compiler": "0.0.553",
-    "@teambit/legacy-bit-id": "0.0.373"
+    "@teambit/cli": "0.0.388",
+    "@teambit/builder": "0.0.557",
+    "@teambit/logger": "0.0.473",
+    "@teambit/component": "0.0.557",
+    "@teambit/express": "0.0.477",
+    "@teambit/isolator": "0.0.557",
+    "@teambit/scope": "0.0.557",
+    "@teambit/graphql": "0.0.557",
+    "@teambit/bit-error": "0.0.374",
+    "@teambit/dependency-resolver": "0.0.557",
+    "@teambit/envs": "0.0.557",
+    "@teambit/workspace": "0.0.557",
+    "@teambit/compiler": "0.0.557",
+    "@teambit/legacy-bit-id": "0.0.377"
   },
   "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.103"
+    "@teambit/pkg.aspect-docs.pkg": "0.0.107"
   },
   "peerDependencies": {
-    "@teambit/legacy": "1.0.170",
+    "@teambit/legacy": "1.0.174",
     "react-dom": "^16.8.0 || ^17.0.0",
     "react": "^16.8.0 || ^17.0.0"
   },
@@ -78,12 +78,20 @@
         "react": "-"
       },
       "peerDependencies": {
-        "@teambit/legacy": "1.0.170",
+        "@teambit/legacy": "1.0.174",
         "react-dom": "^16.8.0 || ^17.0.0",
         "react": "^16.8.0 || ^17.0.0"
       }
     }
   },
+  "files": [
+    "dist",
+    "!dist/tsconfig.tsbuildinfo",
+    "README.md",
+    "README.mdx",
+    "*.js",
+    "*.json"
+  ],
   "private": false,
   "engines": {
     "node": ">=12.22.0"

package/tsconfig.json

@@ -15,9 +15,9 @@
     "skipLibCheck": true,
     "moduleResolution": "node",
     "esModuleInterop": true,
-    "outDir": "dist",
     "composite": true,
     "emitDeclarationOnly": true,
+    "outDir": "dist",
     "experimentalDecorators": true,
     "emitDecoratorMetadata": true,
     "allowSyntheticDefaultImports": true,
@@ -25,7 +25,6 @@
     "strict": true,
     "noImplicitAny": false,
     "rootDir": ".",
-    "removeComments": true,
     "preserveConstEnums": true,
     "resolveJsonModule": true
   },

package/exceptions/index.ts

@@ -1,3 +0,0 @@
-export { PkgArtifactNotFound } from './pkg-artifact-not-found';
-export { ScopeNotFound } from './scope-not-found';
-export { PackageTarFiletNotFound } from './package-tar-filet-not-found';

package/exceptions/package-tar-filet-not-found.ts

@@ -1,8 +0,0 @@
-import { ComponentID } from '@teambit/component';
-import { BitError } from '@teambit/bit-error';
-
-export class PackageTarFiletNotFound extends BitError {
-  constructor(readonly componentId: ComponentID) {
-    super(`package tar file artifact for component ${componentId.toString()} was not found`);
-  }
-}

package/exceptions/pkg-artifact-not-found.ts

@@ -1,8 +0,0 @@
-import { ComponentID } from '@teambit/component';
-import { BitError } from '@teambit/bit-error';
-
-export class PkgArtifactNotFound extends BitError {
-  constructor(readonly componentId: ComponentID) {
-    super(`pkg artifact for component ${componentId.toString()} was not found`);
-  }
-}

package/exceptions/scope-not-found.ts

@@ -1,14 +0,0 @@
-import { BitError } from '@teambit/bit-error';
-
-export class ScopeNotFound extends BitError {
-  constructor(readonly scopePath?: string) {
-    super(generateMessage(scopePath));
-  }
-}
-
-function generateMessage(scopePath?: string) {
-  if (scopePath) {
-    return `scope not found at ${scopePath}`;
-  }
-  return 'scope not found';
-}

package/index.ts

@@ -1,3 +0,0 @@
-export type { PkgMain, PackageJsonProps } from './pkg.main.runtime';
-export { PackageDependency, PackageDependencyFactory } from './package-dependency';
-export { PkgAspect } from './pkg.aspect';

package/pack.cmd.tsx

@@ -1,68 +0,0 @@
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-import { Command, CommandOptions } from '@teambit/cli';
-import chalk from 'chalk';
-
-import { Packer, PackOptions } from './packer';
-
-type PackArgs = [string, string];
-type PackCmdOptions = {
-  outDir?: string;
-  override?: boolean;
-  prefix?: boolean;
-  keep?: boolean;
-  // useCapsule?: boolean;
-};
-
-export class PackCmd implements Command {
-  name = 'pack <componentId> [scopePath]';
-  description = 'create tar for npm publish';
-  options = [
-    ['d', 'out-dir <out-dir>', 'directory to put the result tar file'],
-    ['o', 'override', 'override existing pack file'],
-    ['k', 'keep', 'should keep isolated environment [default = false]'],
-    ['p', 'prefix', 'keep custom (binding) prefix'],
-    // ['c', 'use-capsule', 'isolate using the capsule and pack on the capsule'],
-    ['j', 'json', 'return the output as JSON'],
-  ] as CommandOptions;
-  shortDescription = '';
-  alias = '';
-  group = 'collaborate';
-
-  constructor(private packer: Packer) {}
-
-  async report(args: PackArgs, options: PackCmdOptions) {
-    const packResult = await this.json(args, options);
-    const warnings: any = packResult.data?.warnings || [];
-    const warningsOutput: any = warnings.map((warning) => chalk.yellow(warning)).join('\n');
-    const errors: any = packResult.data?.errors || [];
-    const errorsOutput: any = errors.map((error) => chalk.yellow(error)).join('\n');
-    const tarPathOutput = packResult.data.metadata?.tarPath
-      ? chalk.green(`tar path for component ${packResult.data.id}: ${packResult.data.metadata?.tarPath}`)
-      : '';
-    return `${warningsOutput}\n${errorsOutput}\n${tarPathOutput}`;
-  }
-
-  async json([componentId, scopePath]: PackArgs, options: PackCmdOptions) {
-    const compId = typeof componentId === 'string' ? componentId : componentId[0];
-    let scopePathStr: string | undefined;
-    if (scopePath) {
-      scopePathStr = typeof scopePath !== 'string' ? scopePath[0] : scopePath;
-    }
-
-    const concreteOpts: PackOptions = {
-      writeOptions: {
-        outDir: options.outDir,
-        override: options.override,
-      },
-      prefix: options.prefix,
-      keep: options.keep,
-      // useCapsule: options.useCapsule,
-    };
-
-    const packResult = await this.packer.packComponent(compId, scopePathStr, concreteOpts);
-    return {
-      data: packResult,
-      code: 0,
-    };
-  }
-}

package/pack.task.ts

@@ -1,24 +0,0 @@
-import { BuildContext, BuiltTaskResult, BuildTask, TaskLocation } from '@teambit/builder';
-import { Logger } from '@teambit/logger';
-import { Packer } from './packer';
-
-/**
- * pack components to a .tgz file
- */
-export class PackTask implements BuildTask {
-  readonly name = 'PackComponents';
-  readonly location: TaskLocation = 'end';
-  constructor(readonly aspectId: string, private packer: Packer, private logger: Logger) {}
-
-  async execute(context: BuildContext): Promise<BuiltTaskResult> {
-    const capsules = context.capsuleNetwork.seedersCapsules;
-    this.logger.info(`going to run pack on ${capsules.length} capsules`);
-    const packResults = await this.packer.packMultipleCapsules(capsules, { override: true }, false, true);
-    const packArtifactsDefs = this.packer.getArtifactDefInCapsule();
-
-    return {
-      componentsResults: packResults,
-      artifacts: [packArtifactsDefs],
-    };
-  }
-}

package/package-dependency/index.ts

@@ -1,2 +0,0 @@
-export { PackageDependency, SerializedPackageDependency } from './package-dependency';
-export { PackageDependencyFactory } from './package-dependency-factory';

package/package-dependency/package-dependency-factory.ts

@@ -1,71 +0,0 @@
-import {
-  DependencyLifecycleType,
-  SerializedDependency,
-  DependencyFactory,
-  DependencyList,
-} from '@teambit/dependency-resolver';
-import LegacyComponent from '@teambit/legacy/dist/consumer/component';
-import { PackageDependency, SerializedPackageDependency } from './package-dependency';
-
-const TYPE = 'package';
-// TODO: think about where is the right place to put this
-export class PackageDependencyFactory implements DependencyFactory {
-  // parse<PackageDependency, SerializedDependency>(serialized: SerializedDependency): PackageDependency {
-  //   return new PackageDependency(serialized.id, serialized.version, serialized.type, serialized.lifecycle as DependencyLifecycleType);
-  // }
-  type: string;
-
-  constructor() {
-    this.type = TYPE;
-  }
-
-  async parse<PackageDependency, S extends SerializedDependency>(serialized: S): Promise<PackageDependency> {
-    // return new PackageDependency(serialized.id, serialized.version, serialized.type, serialized.lifecycle as DependencyLifecycleType) as unknown as PackageDependency;
-    return (new PackageDependency(
-      serialized.id,
-      serialized.version,
-      serialized.lifecycle as DependencyLifecycleType,
-      serialized.source
-    ) as unknown) as PackageDependency;
-  }
-
-  async fromLegacyComponent(legacyComponent: LegacyComponent): Promise<DependencyList> {
-    const runtimePackageDeps = transformLegacyComponentPackageDepsToSerializedDependency(
-      legacyComponent.packageDependencies,
-      'runtime'
-    );
-    const devPackageDeps = transformLegacyComponentPackageDepsToSerializedDependency(
-      legacyComponent.devPackageDependencies,
-      'dev'
-    );
-    const peerPackageDeps = transformLegacyComponentPackageDepsToSerializedDependency(
-      legacyComponent.peerPackageDependencies,
-      'peer'
-    );
-
-    const serializedPackageDeps = runtimePackageDeps.concat(devPackageDeps).concat(peerPackageDeps);
-    const packageDepsP: Promise<PackageDependency>[] = serializedPackageDeps.map((dep) => this.parse(dep));
-    const packageDeps: PackageDependency[] = await Promise.all(packageDepsP);
-    const dependencyList = new DependencyList(packageDeps);
-    return dependencyList;
-  }
-
-  // parse: <PackageDependency, SerializedDependency>(serialized: SerializedDependency) =>  {
-  //   return new PackageDependency(serialized.id, serialized.version, serialized.type, serialized.lifecycle as DependencyLifecycleType);
-  // }
-}
-
-function transformLegacyComponentPackageDepsToSerializedDependency(
-  packageDepObj: Record<string, string>,
-  lifecycle: DependencyLifecycleType
-): SerializedPackageDependency[] {
-  const res = Object.entries(packageDepObj).map(([packageName, version]) => {
-    return {
-      id: packageName,
-      version,
-      __type: TYPE,
-      lifecycle,
-    };
-  });
-  return res;
-}

package/package-dependency/package-dependency.ts

@@ -1,20 +0,0 @@
-import {
-  BaseDependency,
-  SerializedDependency,
-  DependencyLifecycleType,
-  DependencySource,
-} from '@teambit/dependency-resolver';
-
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface SerializedPackageDependency extends SerializedDependency {}
-
-export class PackageDependency extends BaseDependency {
-  constructor(id: string, version: string, lifecycle: DependencyLifecycleType, source?: DependencySource) {
-    super(id, version, lifecycle, source);
-    this._type = 'package';
-  }
-
-  getPackageName() {
-    return this.id;
-  }
-}

package/package.fragment.ts

@@ -1,24 +0,0 @@
-import { Component, ShowFragment } from '@teambit/component';
-import { PkgMain } from './pkg.main.runtime';
-
-export class PackageFragment implements ShowFragment {
-  constructor(private pkg: PkgMain) {}
-
-  title = 'package name';
-
-  async renderRow(component: Component) {
-    return {
-      title: this.title,
-      content: this.pkg.getPackageName(component),
-    };
-  }
-
-  async json(component: Component) {
-    return {
-      title: this.title,
-      json: this.pkg.getPackageName(component),
-    };
-  }
-
-  weight = 3;
-}

package/package.route.ts

@@ -1,32 +0,0 @@
-import { Request, Response, Route } from '@teambit/express';
-import mime from 'mime';
-
-import { PkgMain } from './pkg.main.runtime';
-
-export const routePath = `package`;
-export class PackageRoute implements Route {
-  constructor(
-    /**
-     * pkg extension.
-     */
-    private pkg: PkgMain
-  ) {}
-
-  route = `/${routePath}`;
-  method = 'get';
-
-  middlewares = [
-    async (req: Request, res: Response) => {
-      // @ts-ignore TODO: @guy please fix.
-      const component: any = req.component as any;
-      const file = await this.pkg.getPackageTarFile(component);
-      // TODO: 404 again how to handle.
-      if (!file) return res.status(404).jsonp({ error: 'not found' });
-      const contents = file.contents;
-      const contentType = mime.getType('.tgz');
-      res.set('Content-disposition', `attachment; filename=${file.basename}`);
-      if (contentType) res.set('Content-Type', contentType);
-      return res.send(contents);
-    },
-  ];
-}

package/packer.ts

@@ -1,131 +0,0 @@
-import _ from 'lodash';
-import { ComponentFactory } from '@teambit/component';
-import { ComponentResult, ArtifactDefinition } from '@teambit/builder';
-import { Capsule, IsolatorMain } from '@teambit/isolator';
-import { ScopeMain } from '@teambit/scope';
-import LegacyScope from '@teambit/legacy/dist/scope/scope';
-import { Packer as LegacyPacker, PackWriteOptions, PackOptions } from '@teambit/legacy/dist/pack';
-import { Logger } from '@teambit/logger';
-import pMap from 'p-map';
-
-// @ts-ignore (for some reason the tsc -w not found this)
-import { ScopeNotFound } from './exceptions/scope-not-found';
-
-export { PackOptions };
-
-export type PackResult = Omit<ComponentResult, 'component'>;
-export type PackResultWithId = PackResult & {
-  id: string;
-};
-
-const DEFAULT_TAR_DIR_IN_CAPSULE = 'package-tar';
-const PACK_CONCURRENCY = 10;
-export const TAR_FILE_ARTIFACT_NAME = 'package tar file';
-
-export class Packer {
-  legacyPacker: LegacyPacker;
-  constructor(
-    private isolator: IsolatorMain,
-    private logger: Logger,
-    private host: ComponentFactory,
-    private scope?: ScopeMain
-  ) {
-    this.legacyPacker = new LegacyPacker(this.logger);
-  }
-
-  async packComponent(
-    componentId: string,
-    scopePath: string | undefined,
-    options: PackOptions
-  ): Promise<PackResultWithId> {
-    // By default do not load scope from cache when packing
-    const loadScopeFromCache =
-      options && options.loadScopeFromCache !== undefined ? !!options.loadScopeFromCache : false;
-    const legacyScope = scopePath ? await LegacyScope.load(scopePath, loadScopeFromCache) : this.scope?.legacyScope;
-    if (!legacyScope) {
-      throw new ScopeNotFound(scopePath);
-    }
-    // Or the scope we are operate on is legacy, or the host (workspace) is legacy
-    const isLegacyScope = (scopePath && legacyScope.isLegacy) || this.host.isLegacy;
-
-    // Handle legacy
-    if (isLegacyScope) {
-      const res = await this.legacyPacker.pack(componentId, legacyScope, options);
-      // @ts-ignore
-      return Object.assign({}, res, { id: componentId });
-    }
-
-    const capsule = await this.getCapsule(componentId, legacyScope);
-    const res = await this.packCapsule(capsule, options.writeOptions, options.dryRun);
-
-    return Object.assign({}, _.omit(res, ['component']), { id: componentId });
-  }
-
-  async packMultipleCapsules(
-    capsules: Capsule[],
-    writeOptions: PackWriteOptions = { override: true },
-    dryRun = false,
-    omitFullTarPath = false
-  ): Promise<ComponentResult[]> {
-    // const description = `packing components${dryRun ? ' (dry-run)' : ''}`;
-    const results = pMap(
-      capsules,
-      (capsule) => {
-        return this.packCapsule(capsule, writeOptions, dryRun, omitFullTarPath);
-      },
-      { concurrency: PACK_CONCURRENCY }
-    );
-    return results;
-  }
-
-  async packCapsule(
-    capsule: Capsule,
-    writeOptions: PackWriteOptions = { override: true },
-    dryRun = false,
-    omitFullTarPath = false
-  ): Promise<ComponentResult> {
-    const concreteWriteOpts = writeOptions;
-    // Set the package-tar as out dir to easily read the tar later
-    concreteWriteOpts.outDir = concreteWriteOpts.outDir ?? DEFAULT_TAR_DIR_IN_CAPSULE;
-    const packResult = await this.legacyPacker.npmPack(
-      capsule.path,
-      concreteWriteOpts.outDir || capsule.path,
-      concreteWriteOpts.override,
-      dryRun
-    );
-    const component = capsule.component;
-    const fieldsToRemove: string[] = [];
-    if (omitFullTarPath) {
-      fieldsToRemove.push('tarPath');
-    }
-    // TODO: @gilad please make sure to fix this type error now that I added lodash types
-    const metadata = _(packResult.metadata).omitBy(_.isUndefined).omit(fieldsToRemove).value() as any;
-
-    return {
-      component,
-      metadata,
-      errors: packResult.errors,
-      warnings: packResult.warnings,
-      startTime: packResult.startTime,
-      endTime: packResult.endTime,
-    };
-  }
-
-  getArtifactDefInCapsule(outDir?: string): ArtifactDefinition {
-    const rootDir = outDir || DEFAULT_TAR_DIR_IN_CAPSULE;
-    const def: ArtifactDefinition = {
-      name: TAR_FILE_ARTIFACT_NAME,
-      globPatterns: [`${rootDir}/*.tgz`],
-    };
-    return def;
-  }
-
-  private async getCapsule(componentIdStr: string, legacyScope: LegacyScope): Promise<Capsule> {
-    const componentId = await this.host.resolveComponentId(componentIdStr);
-    const network = await this.isolator.isolateComponents([componentId], { baseDir: this.host.path }, legacyScope);
-    const capsule = network.seedersCapsules.getCapsule(componentId);
-
-    if (!capsule) throw new Error(`capsule not found for ${componentId}`);
-    return capsule;
-  }
-}

package/pkg-artifact.ts

@@ -1,5 +0,0 @@
-import { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';
-
-export class PkgArtifact {
-  constructor(private artifacts: AbstractVinyl[]) {}
-}

package/pkg.aspect.ts

@@ -1,5 +0,0 @@
-import { Aspect } from '@teambit/harmony';
-
-export const PkgAspect = Aspect.create({
-  id: 'teambit.pkg/pkg',
-});

package/pkg.docs.mdx

@@ -1,9 +0,0 @@
----
-displayName: PKG
-description: Generates, packs and publishes component packages
-labels: ['packages', 'aspect', 'pkg']
----
-
-import { Pkg } from '@teambit/pkg.aspect-docs.pkg';
-
-<Pkg />

package/pkg.graphql.ts

@@ -1,59 +0,0 @@
-import { Component } from '@teambit/component';
-import { Schema } from '@teambit/graphql';
-import gql from 'graphql-tag';
-
-import { PkgMain } from './pkg.main.runtime';
-
-export function pkgSchema(pkg: PkgMain): Schema {
-  return {
-    typeDefs: gql`
-      extend type Component {
-        packageManifest: PackageManifest
-
-        # package name of the component.
-        packageName: String!
-      }
-
-      type TarDist {
-        tarball: String
-        shasum: String
-      }
-
-      type VersionsPackageManifest {
-        name: String
-        version: String
-        main: String
-        dependencies: JSONObject
-        devDependencies: JSONObject
-        peerDependencies: JSONObject
-        scripts: JSONObject
-        dist: TarDist
-      }
-
-      type PackageManifest {
-        name: String
-        distTags: JSONObject
-        externalRegistry: Boolean
-        versions(version: String): [VersionsPackageManifest]
-      }
-    `,
-    resolvers: {
-      Component: {
-        packageName: (component: Component) => {
-          return pkg.getPackageName(component);
-        },
-        packageManifest: (component: Component) => {
-          return pkg.getManifest(component);
-        },
-      },
-      PackageManifest: {
-        versions: (parent, { version }) => {
-          if (version) {
-            return parent.versions.filter((v) => v.version === version);
-          }
-          return parent.versions;
-        },
-      },
-    },
-  };
-}