@teambit/pkg 0.0.566 → 0.0.570

package/exceptions/index.ts

@@ -0,0 +1,3 @@
+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

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,14 @@
+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/pack.cmd.tsx

@@ -0,0 +1,68 @@
+// 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/package-dependency/index.ts

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

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

@@ -0,0 +1,71 @@
+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

@@ -0,0 +1,20 @@
+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.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/pkg",
-  "version": "0.0.566",
+  "version": "0.0.570",
   "homepage": "https://bit.dev/teambit/pkg/pkg",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.pkg",
     "name": "pkg",
-    "version": "0.0.566"
+    "version": "0.0.570"
   },
   "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.393",
-    "@teambit/builder": "0.0.566",
-    "@teambit/logger": "0.0.478",
-    "@teambit/component": "0.0.566",
-    "@teambit/express": "0.0.482",
-    "@teambit/isolator": "0.0.566",
-    "@teambit/scope": "0.0.566",
-    "@teambit/graphql": "0.0.566",
-    "@teambit/bit-error": "0.0.379",
-    "@teambit/dependency-resolver": "0.0.566",
-    "@teambit/envs": "0.0.566",
-    "@teambit/workspace": "0.0.566",
-    "@teambit/compiler": "0.0.566",
-    "@teambit/legacy-bit-id": "0.0.382"
+    "@teambit/cli": "0.0.395",
+    "@teambit/builder": "0.0.570",
+    "@teambit/logger": "0.0.482",
+    "@teambit/component": "0.0.570",
+    "@teambit/express": "0.0.486",
+    "@teambit/isolator": "0.0.570",
+    "@teambit/scope": "0.0.570",
+    "@teambit/graphql": "0.0.570",
+    "@teambit/bit-error": "0.0.381",
+    "@teambit/dependency-resolver": "0.0.570",
+    "@teambit/envs": "0.0.570",
+    "@teambit/workspace": "0.0.570",
+    "@teambit/compiler": "0.0.570",
+    "@teambit/legacy-bit-id": "0.0.384"
   },
   "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.112"
+    "@teambit/pkg.aspect-docs.pkg": "0.0.116"
   },
   "peerDependencies": {
-    "@teambit/legacy": "1.0.179",
+    "@teambit/legacy": "1.0.181",
     "react-dom": "^16.8.0 || ^17.0.0",
     "react": "^16.8.0 || ^17.0.0"
   },
@@ -78,27 +78,12 @@
         "react": "-"
       },
       "peerDependencies": {
-        "@teambit/legacy": "1.0.179",
+        "@teambit/legacy": "1.0.181",
         "react-dom": "^16.8.0 || ^17.0.0",
         "react": "^16.8.0 || ^17.0.0"
       }
     }
   },
-  "files": [
-    "dist",
-    "!dist/tsconfig.tsbuildinfo",
-    "**/*.md",
-    "**/*.mdx",
-    "**/*.js",
-    "**/*.json",
-    "**/*.sass",
-    "**/*.scss",
-    "**/*.less",
-    "**/*.css",
-    "**/*.css",
-    "**/*.jpeg",
-    "**/*.gif"
-  ],
   "private": false,
   "engines": {
     "node": ">=12.22.0"

package/pkg.service.tsx

@@ -0,0 +1,39 @@
+import React from 'react';
+import { Text, Newline } from 'ink';
+import { EnvService, EnvDefinition } from '@teambit/envs';
+import highlight from 'cli-highlight';
+
+export type PkgDescriptor = {
+  id: string;
+  displayName: string;
+  config?: string;
+};
+
+export class PkgService implements EnvService<{}, PkgDescriptor> {
+  name = 'Pkg';
+
+  async render(env: EnvDefinition) {
+    const descriptor = this.getDescriptor(env);
+
+    return (
+      <Text key={descriptor?.id}>
+        <Text color="cyan">configured package.json properties: </Text>
+        <Newline />
+        <Text>
+          {descriptor?.config && highlight(descriptor?.config, { language: 'javascript', ignoreIllegals: true })}
+        </Text>
+        <Newline />
+      </Text>
+    );
+  }
+
+  getDescriptor(env: EnvDefinition): PkgDescriptor | undefined {
+    if (!env.env.getPackageJsonProps) return undefined;
+    const props = env.env.getPackageJsonProps();
+    return {
+      id: this.name,
+      config: props ? JSON.stringify(props, null, 2) : undefined,
+      displayName: this.name,
+    };
+  }
+}

package/publish.cmd.tsx

@@ -0,0 +1,57 @@
+import { ComponentResult } from '@teambit/builder';
+import { Command, CommandOptions } from '@teambit/cli';
+import chalk from 'chalk';
+
+import { Publisher, PublisherOptions } from './publisher';
+
+type PublishArgs = [string];
+
+export class PublishCmd implements Command {
+  name = 'publish <componentId>';
+  description = 'publish components to npm (npm publish)';
+  options = [
+    ['d', 'dry-run', 'npm publish --dry-run'],
+    ['', 'allow-staged', 'allow publish components that were not exported yet (not recommended)'],
+    ['j', 'json', 'return the output as JSON'],
+  ] as CommandOptions;
+  shortDescription = '';
+  alias = '';
+  private = true;
+  group = 'collaborate';
+
+  constructor(private publisher: Publisher) {}
+
+  async report(args: PublishArgs, options: PublisherOptions) {
+    const result = await this.json(args, options);
+    const publishResults: ComponentResult[] = result.data;
+    if (!publishResults.length) return 'no components were found candidate for publish';
+
+    const publishOrDryRun = options.dryRun ? 'dry-run' : 'published';
+    const title = chalk.white.bold(`successfully ${publishOrDryRun} the following components\n`);
+    const output = publishResults
+      .map((publishResult) => {
+        const compName = publishResult.component.id.toString();
+        const getData = () => {
+          if (publishResult.errors?.length) {
+            return chalk.red(publishResult.errors.join('\n'));
+          }
+          return chalk.green((publishResult.metadata?.publishedPackage as string) || '');
+        };
+        return `${chalk.bold(compName)}\n${getData()}\n`;
+      })
+      .join('\n');
+    return title + output;
+  }
+
+  async json(
+    [componentId]: PublishArgs,
+    options: PublisherOptions
+  ): Promise<{ data: ComponentResult[]; code: number }> {
+    const compId = typeof componentId === 'string' ? componentId : componentId[0];
+    const packResult = await this.publisher.publish([compId], options);
+    return {
+      data: packResult,
+      code: 0,
+    };
+  }
+}

package/types/asset.d.ts

@@ -0,0 +1,29 @@
+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;
+}
+
+// @TODO Gilad
+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;
+}

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;
+}