@teambit/importer 0.0.282 → 0.0.283

package/dist/fetch-cmd.d.ts

@@ -0,0 +1,19 @@
+import { Command, CommandOptions } from '@teambit/cli';
+import { ImporterMain } from './importer.main.runtime';
+export declare class FetchCmd implements Command {
+    private importer;
+    name: string;
+    description: string;
+    extendedDescription: string;
+    alias: string;
+    private: boolean;
+    options: CommandOptions;
+    loader: boolean;
+    constructor(importer: ImporterMain);
+    report([ids]: [string[]], { lanes, components, json, fromOriginalScope, }: {
+        lanes?: boolean;
+        components?: boolean;
+        json?: boolean;
+        fromOriginalScope?: boolean;
+    }): Promise<string>;
+}

package/dist/fetch-cmd.js

@@ -0,0 +1,126 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+require("core-js/modules/es.array.iterator.js");
+
+require("core-js/modules/es.promise.js");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.FetchCmd = void 0;
+
+function _defineProperty2() {
+  const data = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+  _defineProperty2 = function () {
+    return data;
+  };
+
+  return data;
+}
+
+function _chalk() {
+  const data = _interopRequireDefault(require("chalk"));
+
+  _chalk = function () {
+    return data;
+  };
+
+  return data;
+}
+
+function _ramda() {
+  const data = _interopRequireDefault(require("ramda"));
+
+  _ramda = function () {
+    return data;
+  };
+
+  return data;
+}
+
+function _mergeVersion() {
+  const data = require("@teambit/legacy/dist/consumer/versions-ops/merge-version/merge-version");
+
+  _mergeVersion = function () {
+    return data;
+  };
+
+  return data;
+}
+
+class FetchCmd {
+  constructor(importer) {
+    this.importer = importer;
+    (0, _defineProperty2().default)(this, "name", 'fetch [ids...]');
+    (0, _defineProperty2().default)(this, "description", `fetch remote objects and store locally`);
+    (0, _defineProperty2().default)(this, "extendedDescription", `for lanes, use "/" as a separator between the remote and the lane name, e.g. teambit.ui/fix-button`);
+    (0, _defineProperty2().default)(this, "alias", '');
+    (0, _defineProperty2().default)(this, "private", true);
+    (0, _defineProperty2().default)(this, "options", [['l', 'lanes', 'EXPERIMENTAL. fetch component objects from lanes. note, it does not save the remote lanes objects locally, only the refs'], ['c', 'components', 'fetch components'], ['j', 'json', 'return the output as JSON'], ['', 'from-original-scopes', 'fetch indirect dependencies from their original scope as opposed to from their dependents']]);
+    (0, _defineProperty2().default)(this, "loader", true);
+  }
+
+  async report([ids = []], {
+    lanes = false,
+    components = false,
+    json = false,
+    fromOriginalScope = false
+  }) {
+    const {
+      dependencies,
+      importDetails
+    } = await this.importer.fetch(ids, lanes, components, fromOriginalScope);
+
+    if (json) {
+      return JSON.stringify({
+        importDetails
+      }, null, 4);
+    }
+
+    if (dependencies && !_ramda().default.isEmpty(dependencies)) {
+      const componentsObj = dependencies.map(_ramda().default.prop('component'));
+      const title = componentsObj.length === 1 ? 'successfully fetched one component' : `successfully fetched ${componentsObj.length} components`;
+      const componentDependencies = componentsObj.map(component => {
+        // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
+        const details = importDetails.find(c => c.id === component.id.toStringWithoutVersion()); // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
+
+        if (!details) throw new Error(`missing details of component ${component.id.toString()}`); // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
+
+        return formatPlainComponentItemWithVersions(component, details);
+      });
+      const componentDependenciesOutput = [_chalk().default.green(title)].concat(componentDependencies).join('\n');
+      return componentDependenciesOutput;
+    }
+
+    return _chalk().default.yellow('nothing to import');
+  }
+
+}
+
+exports.FetchCmd = FetchCmd;
+
+function formatPlainComponentItemWithVersions(component, importDetails) {
+  const status = importDetails.status;
+  const id = component.id.toStringWithoutVersion();
+  const versions = importDetails.versions.length ? `new versions: ${importDetails.versions.join(', ')}` : ''; // $FlowFixMe component.version should be set here
+
+  const usedVersion = status === 'added' ? `, currently used version ${component.version}` : '';
+
+  const getConflictMessage = () => {
+    if (!importDetails.filesStatus) return '';
+    const conflictedFiles = Object.keys(importDetails.filesStatus) // $FlowFixMe file is set
+    // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
+    .filter(file => importDetails.filesStatus[file] === _mergeVersion().FileStatus.manual);
+    if (!conflictedFiles.length) return '';
+    return `(the following files were saved with conflicts ${conflictedFiles.map(file => _chalk().default.bold(file)).join(', ')}) `;
+  };
+
+  const deprecated = importDetails.deprecated ? _chalk().default.yellow('deprecated') : '';
+  const missingDeps = importDetails.missingDeps.length ? _chalk().default.red(`missing dependencies: ${importDetails.missingDeps.map(d => d.toString()).join(', ')}`) : '';
+  return `- ${_chalk().default.green(status)} ${_chalk().default.cyan(id)} ${versions}${usedVersion} ${getConflictMessage()}${deprecated} ${missingDeps}`;
+}
+
+//# sourceMappingURL=fetch-cmd.js.map

package/dist/fetch-cmd.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["FetchCmd","constructor","importer","report","ids","lanes","components","json","fromOriginalScope","dependencies","importDetails","fetch","JSON","stringify","R","isEmpty","componentsObj","map","prop","title","length","componentDependencies","component","details","find","c","id","toStringWithoutVersion","Error","toString","formatPlainComponentItemWithVersions","componentDependenciesOutput","chalk","green","concat","join","yellow","status","versions","usedVersion","version","getConflictMessage","filesStatus","conflictedFiles","Object","keys","filter","file","FileStatus","manual","bold","deprecated","missingDeps","red","d","cyan"],"sources":["fetch-cmd.ts"],"sourcesContent":["import chalk from 'chalk';\nimport R from 'ramda';\nimport { Command, CommandOptions } from '@teambit/cli';\nimport Component from '@teambit/legacy/dist/consumer/component/consumer-component';\nimport { FileStatus } from '@teambit/legacy/dist/consumer/versions-ops/merge-version/merge-version';\nimport { ImporterMain } from './importer.main.runtime';\nimport { ImportDetails, ImportStatus } from './import-components';\n\nexport class FetchCmd implements Command {\n  name = 'fetch [ids...]';\n  description = `fetch remote objects and store locally`;\n  extendedDescription = `for lanes, use \"/\" as a separator between the remote and the lane name, e.g. teambit.ui/fix-button`;\n  alias = '';\n  private = true;\n  options = [\n    [\n      'l',\n      'lanes',\n      'EXPERIMENTAL. fetch component objects from lanes. note, it does not save the remote lanes objects locally, only the refs',\n    ],\n    ['c', 'components', 'fetch components'],\n    ['j', 'json', 'return the output as JSON'],\n    [\n      '',\n      'from-original-scopes',\n      'fetch indirect dependencies from their original scope as opposed to from their dependents',\n    ],\n  ] as CommandOptions;\n  loader = true;\n\n  constructor(private importer: ImporterMain) {}\n\n  async report(\n    [ids = []]: [string[]],\n    {\n      lanes = false,\n      components = false,\n      json = false,\n      fromOriginalScope = false,\n    }: {\n      lanes?: boolean;\n      components?: boolean;\n      json?: boolean;\n      fromOriginalScope?: boolean;\n    }\n  ) {\n    const { dependencies, importDetails } = await this.importer.fetch(ids, lanes, components, fromOriginalScope);\n    if (json) {\n      return JSON.stringify({ importDetails }, null, 4);\n    }\n    if (dependencies && !R.isEmpty(dependencies)) {\n      const componentsObj = dependencies.map(R.prop('component'));\n      const title =\n        componentsObj.length === 1\n          ? 'successfully fetched one component'\n          : `successfully fetched ${componentsObj.length} components`;\n      const componentDependencies = componentsObj.map((component) => {\n        // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!\n        const details = importDetails.find((c) => c.id === component.id.toStringWithoutVersion());\n        // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!\n        if (!details) throw new Error(`missing details of component ${component.id.toString()}`);\n        // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!\n        return formatPlainComponentItemWithVersions(component, details);\n      });\n      const componentDependenciesOutput = [chalk.green(title)].concat(componentDependencies).join('\\n');\n\n      return componentDependenciesOutput;\n    }\n    return chalk.yellow('nothing to import');\n  }\n}\n\nfunction formatPlainComponentItemWithVersions(component: Component, importDetails: ImportDetails) {\n  const status: ImportStatus = importDetails.status;\n  const id = component.id.toStringWithoutVersion();\n  const versions = importDetails.versions.length ? `new versions: ${importDetails.versions.join(', ')}` : '';\n  // $FlowFixMe component.version should be set here\n  const usedVersion = status === 'added' ? `, currently used version ${component.version}` : '';\n  const getConflictMessage = () => {\n    if (!importDetails.filesStatus) return '';\n    const conflictedFiles = Object.keys(importDetails.filesStatus) // $FlowFixMe file is set\n      // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!\n      .filter((file) => importDetails.filesStatus[file] === FileStatus.manual);\n    if (!conflictedFiles.length) return '';\n    return `(the following files were saved with conflicts ${conflictedFiles\n      .map((file) => chalk.bold(file))\n      .join(', ')}) `;\n  };\n  const deprecated = importDetails.deprecated ? chalk.yellow('deprecated') : '';\n  const missingDeps = importDetails.missingDeps.length\n    ? chalk.red(`missing dependencies: ${importDetails.missingDeps.map((d) => d.toString()).join(', ')}`)\n    : '';\n  return `- ${chalk.green(status)} ${chalk.cyan(\n    id\n  )} ${versions}${usedVersion} ${getConflictMessage()}${deprecated} ${missingDeps}`;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAAA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AACA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAGA;EAAA;;EAAA;IAAA;EAAA;;EAAA;AAAA;;AAIO,MAAMA,QAAN,CAAkC;EAsBvCC,WAAW,CAASC,QAAT,EAAiC;IAAA,KAAxBA,QAAwB,GAAxBA,QAAwB;IAAA,8CArBrC,gBAqBqC;IAAA,qDApB7B,wCAoB6B;IAAA,6DAnBrB,oGAmBqB;IAAA,+CAlBpC,EAkBoC;IAAA,iDAjBlC,IAiBkC;IAAA,iDAhBlC,CACR,CACE,GADF,EAEE,OAFF,EAGE,0HAHF,CADQ,EAMR,CAAC,GAAD,EAAM,YAAN,EAAoB,kBAApB,CANQ,EAOR,CAAC,GAAD,EAAM,MAAN,EAAc,2BAAd,CAPQ,EAQR,CACE,EADF,EAEE,sBAFF,EAGE,2FAHF,CARQ,CAgBkC;IAAA,gDAFnC,IAEmC;EAAE;;EAElC,MAANC,MAAM,CACV,CAACC,GAAG,GAAG,EAAP,CADU,EAEV;IACEC,KAAK,GAAG,KADV;IAEEC,UAAU,GAAG,KAFf;IAGEC,IAAI,GAAG,KAHT;IAIEC,iBAAiB,GAAG;EAJtB,CAFU,EAaV;IACA,MAAM;MAAEC,YAAF;MAAgBC;IAAhB,IAAkC,MAAM,KAAKR,QAAL,CAAcS,KAAd,CAAoBP,GAApB,EAAyBC,KAAzB,EAAgCC,UAAhC,EAA4CE,iBAA5C,CAA9C;;IACA,IAAID,IAAJ,EAAU;MACR,OAAOK,IAAI,CAACC,SAAL,CAAe;QAAEH;MAAF,CAAf,EAAkC,IAAlC,EAAwC,CAAxC,CAAP;IACD;;IACD,IAAID,YAAY,IAAI,CAACK,gBAAA,CAAEC,OAAF,CAAUN,YAAV,CAArB,EAA8C;MAC5C,MAAMO,aAAa,GAAGP,YAAY,CAACQ,GAAb,CAAiBH,gBAAA,CAAEI,IAAF,CAAO,WAAP,CAAjB,CAAtB;MACA,MAAMC,KAAK,GACTH,aAAa,CAACI,MAAd,KAAyB,CAAzB,GACI,oCADJ,GAEK,wBAAuBJ,aAAa,CAACI,MAAO,aAHnD;MAIA,MAAMC,qBAAqB,GAAGL,aAAa,CAACC,GAAd,CAAmBK,SAAD,IAAe;QAC7D;QACA,MAAMC,OAAO,GAAGb,aAAa,CAACc,IAAd,CAAoBC,CAAD,IAAOA,CAAC,CAACC,EAAF,KAASJ,SAAS,CAACI,EAAV,CAAaC,sBAAb,EAAnC,CAAhB,CAF6D,CAG7D;;QACA,IAAI,CAACJ,OAAL,EAAc,MAAM,IAAIK,KAAJ,CAAW,gCAA+BN,SAAS,CAACI,EAAV,CAAaG,QAAb,EAAwB,EAAlE,CAAN,CAJ+C,CAK7D;;QACA,OAAOC,oCAAoC,CAACR,SAAD,EAAYC,OAAZ,CAA3C;MACD,CAP6B,CAA9B;MAQA,MAAMQ,2BAA2B,GAAG,CAACC,gBAAA,CAAMC,KAAN,CAAYd,KAAZ,CAAD,EAAqBe,MAArB,CAA4Bb,qBAA5B,EAAmDc,IAAnD,CAAwD,IAAxD,CAApC;MAEA,OAAOJ,2BAAP;IACD;;IACD,OAAOC,gBAAA,CAAMI,MAAN,CAAa,mBAAb,CAAP;EACD;;AA7DsC;;;;AAgEzC,SAASN,oCAAT,CAA8CR,SAA9C,EAAoEZ,aAApE,EAAkG;EAChG,MAAM2B,MAAoB,GAAG3B,aAAa,CAAC2B,MAA3C;EACA,MAAMX,EAAE,GAAGJ,SAAS,CAACI,EAAV,CAAaC,sBAAb,EAAX;EACA,MAAMW,QAAQ,GAAG5B,aAAa,CAAC4B,QAAd,CAAuBlB,MAAvB,GAAiC,iBAAgBV,aAAa,CAAC4B,QAAd,CAAuBH,IAAvB,CAA4B,IAA5B,CAAkC,EAAnF,GAAuF,EAAxG,CAHgG,CAIhG;;EACA,MAAMI,WAAW,GAAGF,MAAM,KAAK,OAAX,GAAsB,4BAA2Bf,SAAS,CAACkB,OAAQ,EAAnE,GAAuE,EAA3F;;EACA,MAAMC,kBAAkB,GAAG,MAAM;IAC/B,IAAI,CAAC/B,aAAa,CAACgC,WAAnB,EAAgC,OAAO,EAAP;IAChC,MAAMC,eAAe,GAAGC,MAAM,CAACC,IAAP,CAAYnC,aAAa,CAACgC,WAA1B,EAAuC;IAC7D;IADsB,CAErBI,MAFqB,CAEbC,IAAD,IAAUrC,aAAa,CAACgC,WAAd,CAA0BK,IAA1B,MAAoCC,0BAAA,CAAWC,MAF3C,CAAxB;IAGA,IAAI,CAACN,eAAe,CAACvB,MAArB,EAA6B,OAAO,EAAP;IAC7B,OAAQ,kDAAiDuB,eAAe,CACrE1B,GADsD,CACjD8B,IAAD,IAAUf,gBAAA,CAAMkB,IAAN,CAAWH,IAAX,CADwC,EAEtDZ,IAFsD,CAEjD,IAFiD,CAE3C,IAFd;EAGD,CATD;;EAUA,MAAMgB,UAAU,GAAGzC,aAAa,CAACyC,UAAd,GAA2BnB,gBAAA,CAAMI,MAAN,CAAa,YAAb,CAA3B,GAAwD,EAA3E;EACA,MAAMgB,WAAW,GAAG1C,aAAa,CAAC0C,WAAd,CAA0BhC,MAA1B,GAChBY,gBAAA,CAAMqB,GAAN,CAAW,yBAAwB3C,aAAa,CAAC0C,WAAd,CAA0BnC,GAA1B,CAA+BqC,CAAD,IAAOA,CAAC,CAACzB,QAAF,EAArC,EAAmDM,IAAnD,CAAwD,IAAxD,CAA8D,EAAjG,CADgB,GAEhB,EAFJ;EAGA,OAAQ,KAAIH,gBAAA,CAAMC,KAAN,CAAYI,MAAZ,CAAoB,IAAGL,gBAAA,CAAMuB,IAAN,CACjC7B,EADiC,CAEjC,IAAGY,QAAS,GAAEC,WAAY,IAAGE,kBAAkB,EAAG,GAAEU,UAAW,IAAGC,WAAY,EAFhF;AAGD"}

package/dist/import-components.d.ts

@@ -0,0 +1,136 @@
+import { LaneId } from '@teambit/lane-id';
+import { BitId, BitIds } from '@teambit/legacy/dist/bit-id';
+import { Consumer } from '@teambit/legacy/dist/consumer';
+import { ComponentWithDependencies, Scope } from '@teambit/legacy/dist/scope';
+import DependencyGraph from '@teambit/legacy/dist/scope/graph/scope-graph';
+import { Lane } from '@teambit/legacy/dist/scope/models';
+import Component from '@teambit/legacy/dist/consumer/component';
+import { FilesStatus, MergeStrategy } from '@teambit/legacy/dist/consumer/versions-ops/merge-version/merge-version';
+import { MergeResultsThreeWay } from '@teambit/legacy/dist/consumer/versions-ops/merge-version/three-way-merge';
+export declare type ImportOptions = {
+    ids: string[];
+    verbose: boolean;
+    merge?: boolean;
+    mergeStrategy?: MergeStrategy;
+    withEnvironments?: boolean;
+    writeToPath?: string;
+    writePackageJson?: boolean;
+    writeConfig: boolean;
+    writeDists?: boolean;
+    override: boolean;
+    installNpmPackages: boolean;
+    objectsOnly: boolean;
+    saveDependenciesAsComponents?: boolean;
+    importDependenciesDirectly?: boolean;
+    importDependents?: boolean;
+    fromOriginalScope?: boolean;
+    saveInLane?: boolean;
+    lanes?: {
+        laneIds: LaneId[];
+        lanes: Lane[];
+    };
+    allHistory?: boolean;
+};
+declare type ComponentMergeStatus = {
+    componentWithDependencies: ComponentWithDependencies;
+    mergeResults: MergeResultsThreeWay | null | undefined;
+};
+declare type ImportedVersions = {
+    [id: string]: string[];
+};
+export declare type ImportStatus = 'added' | 'updated' | 'up to date';
+export declare type ImportDetails = {
+    id: string;
+    versions: string[];
+    latestVersion: string | null;
+    status: ImportStatus;
+    filesStatus: FilesStatus | null | undefined;
+    missingDeps: BitId[];
+    deprecated: boolean;
+    removed?: boolean;
+};
+export declare type ImportResult = {
+    dependencies: ComponentWithDependencies[];
+    envComponents?: Component[];
+    importDetails: ImportDetails[];
+    cancellationMessage?: string;
+};
+export default class ImportComponents {
+    consumer: Consumer;
+    scope: Scope;
+    options: ImportOptions;
+    mergeStatus: {
+        [id: string]: FilesStatus;
+    };
+    private laneObjects;
+    private divergeData;
+    constructor(consumer: Consumer, options: ImportOptions);
+    importComponents(): Promise<ImportResult>;
+    importObjectsOnLane(): Promise<ImportResult>;
+    importSpecificComponents(): Promise<ImportResult>;
+    _fetchDivergeData(componentsWithDependencies: ComponentWithDependencies[]): Promise<void>;
+    _throwForDivergedHistory(): void;
+    /**
+     * it can happen for example when importing a component with `--dependent` flag and the component has
+     * the same dependent with different versions. we only want the one with the higher version
+     */
+    _filterComponentsWithLowerVersions(componentsWithDependencies: ComponentWithDependencies[]): ComponentWithDependencies[];
+    /**
+     * consider the following use cases:
+     * 1) no ids were provided. it should import all the lanes components objects AND main components objects
+     * (otherwise, if main components are not imported and are missing, then bit-status complains about it)
+     * 2) ids are provided with wildcards. we assume the user wants only the ids that are available on the lane.
+     * because a user may entered "bit import scope/*" and this scope has many component on the lane and many not on the lane.
+     * we want to bring only the components on the lane.
+     * 3) ids are provided without wildcards. here, the user knows exactly what's needed and it's ok to get the ids from
+     * main if not found on the lane.
+     */
+    private getBitIdsForLanes;
+    private getBitIdsForNonLanes;
+    private getBitIds;
+    _getDependenciesFromGraph(bitIds: BitId[], graphs: DependencyGraph[]): BitId[];
+    _getDependentsFromGraph(bitIds: BitId[], graphs: DependencyGraph[]): BitId[];
+    _getComponentsGraphs(bitIds: BitId[]): Promise<DependencyGraph[]>;
+    importAccordingToBitMap(): Promise<ImportResult>;
+    private getIdsToImportFromBitmap;
+    /**
+     * author might require bit-components that were installed via a package-manager. in that case,
+     * the objects are not imported until bit build or bit tag was running. this makes sure to get
+     * the objects on 'bit import', so then in the UI, they'll be shown nicely.
+     */
+    getIdsOfDepsInstalledAsPackages(): Promise<BitId[]>;
+    _getCurrentVersions(ids: BitIds): Promise<ImportedVersions>;
+    /**
+     * get import details, includes the diff between the versions array before import and after import
+     */
+    _getImportDetails(currentVersions: ImportedVersions, components: ComponentWithDependencies[]): Promise<ImportDetails[]>;
+    _throwForPotentialIssues(ids: BitIds): Promise<void>;
+    _throwForModifiedOrNewComponents(ids: BitIds): Promise<void>;
+    /**
+     * Model Component id() calculation uses id.toString() for the hash.
+     * If an imported component has scopereadonly name equals to a local name, both will have the exact same
+     * hash and they'll override each other.
+     */
+    _throwForDifferentComponentWithSameName(ids: BitIds): void;
+    _getMergeStatus(componentWithDependencies: ComponentWithDependencies): Promise<ComponentMergeStatus>;
+    /**
+     * 1) when there are conflicts and the strategy is "ours", don't write the imported component to
+     * the filesystem, only update bitmap.
+     *
+     * 2) when there are conflicts and the strategy is "theirs", override the local changes by the
+     * imported component. (similar to --override)
+     *
+     * 3) when there is no conflict or there are conflicts and the strategy is manual, write the files
+     * according to the merge result. (done by applyModifiedVersion())
+     */
+    _updateComponentFilesPerMergeStrategy(componentMergeStatus: ComponentMergeStatus): FilesStatus | null | undefined;
+    /**
+     * update the component files if they are modified and there is a merge strategy.
+     * returns only the components that need to be written to the filesystem
+     */
+    updateAllComponentsAccordingToMergeStrategy(componentsWithDependencies: ComponentWithDependencies[]): Promise<ComponentWithDependencies[]>;
+    _shouldSaveLaneData(): boolean;
+    _saveLaneDataIfNeeded(componentsWithDependencies: ComponentWithDependencies[]): Promise<void>;
+    _writeToFileSystem(componentsWithDependencies: ComponentWithDependencies[]): Promise<void>;
+}
+export {};