@teambit/api-server 0.0.0-e8287ed72e2b99e42d753c493df21297eff042bb → 0.0.0-e8938184c00c8a31108c548d2a737c4c0fabbff4

package/.npmignore

@@ -0,0 +1,18 @@
+dist/tsconfig.tsbuildinfo
+dist/tsconfig.json
+/tsconfig.json
+
+package-tar/
+.bit-capsule-ready
+/*.ts
+artifacts/*
+!artifacts/env-template
+!artifacts/ui-bundle
+!artifacts/preview-bundle
+package-tar/
+.bit-capsule-ready
+/*.ts
+artifacts/*
+!artifacts/env-template
+!artifacts/ui-bundle
+!artifacts/preview-bundle

package/dist/api-for-ide.d.ts

@@ -1,31 +1,60 @@
-import { CompFiles, Workspace, FilesStatus } from '@teambit/workspace';
-import { PathOsBasedAbsolute, PathOsBasedRelative } from '@teambit/legacy.utils';
-import { SnappingMain } from '@teambit/snapping';
-import { LanesMain } from '@teambit/lanes';
-import { InstallMain } from '@teambit/install';
-import { ExportMain } from '@teambit/export';
-import { CheckoutMain } from '@teambit/checkout';
-import { ComponentLogMain, FileHashDiffFromParent } from '@teambit/component-log';
-import { LaneLog } from '@teambit/objects';
-import { ComponentCompareMain } from '@teambit/component-compare';
-import { GeneratorMain, PromptOption, PromptResults } from '@teambit/generator';
-import { RemoveMain } from '@teambit/remove';
-import { ConfigMain } from '@teambit/config';
-import { ApplicationMain } from '@teambit/application';
-import { DeprecationMain } from '@teambit/deprecation';
-import { EnvsMain } from '@teambit/envs';
-import { GraphMain } from '@teambit/graph';
-import { ScopeMain } from '@teambit/scope';
-import { ComponentMain } from '@teambit/component';
-import { SchemaMain } from '@teambit/schema';
-import { Logger } from '@teambit/logger';
+import type { CompFiles, Workspace, FilesStatus } from '@teambit/workspace';
+import type { PathOsBasedAbsolute, PathOsBasedRelative } from '@teambit/legacy.utils';
+import type { SnappingMain } from '@teambit/snapping';
+import type { LanesMain } from '@teambit/lanes';
+import type { InstallMain } from '@teambit/install';
+import type { ExportMain } from '@teambit/export';
+import type { CheckoutMain } from '@teambit/checkout';
+import type { ComponentLogMain, FileHashDiffFromParent } from '@teambit/component-log';
+import type { LaneLog } from '@teambit/objects';
+import type { ComponentCompareMain } from '@teambit/component-compare';
+import type { GenerateResult, GeneratorMain, PromptOption, PromptResults, TemplateDescriptor } from '@teambit/generator';
+import type { RemoveMain } from '@teambit/remove';
+import type { ConfigMain } from '@teambit/config';
+import type { ApplicationMain } from '@teambit/application';
+import type { DeprecationMain } from '@teambit/deprecation';
+import type { EnvsMain } from '@teambit/envs';
+import type { GraphMain } from '@teambit/graph';
+import type { ScopeMain } from '@teambit/scope';
+import type { ComponentMain, ComponentMap } from '@teambit/component';
+import type { SchemaMain } from '@teambit/schema';
+import type { Logger } from '@teambit/logger';
+type LaneDiffForIDEResult = {
+    newCompsFrom: string[];
+    newCompsTo: string[];
+    compsWithDiff: {
+        id: string;
+        hasDiff: boolean;
+        filesDiff: {
+            filePath: string;
+            status: string;
+            fromContent?: string;
+            toContent?: string;
+        }[];
+        fieldsDiff?: {
+            fieldName: string;
+            diffOutput: string;
+        }[] | null;
+    }[];
+    compsWithNoChanges: string[];
+    toLaneName: string;
+    fromLaneName: string;
+    failures: {
+        id: string;
+        msg: string;
+    }[];
+};
 type PathLinux = string;
 type PathFromLastSnap = {
     [relativeToWorkspace: PathLinux]: string;
 };
+type ObjectPathsFromLastSnap = {
+    [relativeToWorkspace: PathLinux]: string;
+};
 type InitSCMEntry = {
     filesStatus: FilesStatus;
     pathsFromLastSnap: PathFromLastSnap;
+    objectPathsFromLastSnap: ObjectPathsFromLastSnap;
     compDir: PathLinux;
 };
 type DataToInitSCM = {
@@ -128,8 +157,8 @@ export declare class APIForIDE {
         [relativePath: string]: string;
     }>;
     catObject(hash: string): Promise<string>;
-    logFile(filePath: string): Promise<import("@teambit/component-log/component-log.main.runtime").FileLog[]>;
-    blame(filePath: string): Promise<import("@teambit/component-log/component-log.main.runtime").BlameLineInfo[]>;
+    logFile(filePath: string): Promise<import("@teambit/component-log/dist/component-log.main.runtime").FileLog[]>;
+    blame(filePath: string): Promise<import("@teambit/component-log/dist/component-log.main.runtime").BlameLineInfo[]>;
     changedFilesFromParent(id: string): Promise<FileHashDiffFromParent[]>;
     getConfigForDiff(id: string): Promise<{
         version?: string;
@@ -141,9 +170,12 @@ export declare class APIForIDE {
     getCompFilesDirPathFromLastSnapUsingCompFiles(compFiles: CompFiles): Promise<{
         [relativePath: string]: string;
     }>;
+    getCompFileObjectPathsFromLastSnap(compFiles: CompFiles): {
+        [relativePath: string]: string;
+    };
     warmWorkspaceCache(): Promise<void>;
     clearCache(): Promise<void>;
-    install(options?: {}, packages?: string[]): Promise<import("@teambit/component").ComponentMap<string>>;
+    install(options?: {}, packages?: string[]): Promise<ComponentMap<string>>;
     export(): Promise<{
         componentsIds: string[];
         removedIds: string[];
@@ -156,9 +188,10 @@ export declare class APIForIDE {
         skipped: string[] | undefined;
         failed: string[] | undefined;
     }>;
-    getTemplates(): Promise<import("@teambit/generator/generator.main.runtime").TemplateDescriptor[]>;
+    importObjectsIfOutdatedAgainstBitmap(): Promise<void>;
+    getTemplates(): Promise<TemplateDescriptor[]>;
     getPromptOptionsForTemplate(templateName: string): Promise<PromptOption[] | undefined>;
-    createComponent(templateName: string, idIncludeScope: string, promptResults?: PromptResults): Promise<import("@teambit/generator").GenerateResult[]>;
+    createComponent(templateName: string, idIncludeScope: string, promptResults?: PromptResults): Promise<GenerateResult[]>;
     removeComponent(componentsPattern: string): Promise<import("@teambit/legacy.scope").RemovedObjectSerialized>;
     deleteComponents(componentsPattern: string, opts: any): Promise<string[]>;
     deprecateComponent(id: string, newId?: string, range?: string): Promise<boolean>;
@@ -170,13 +203,30 @@ export declare class APIForIDE {
     }>;
     private adjustCheckoutResultsToIde;
     getModifiedByConfig(): Promise<ModifiedByConfig[]>;
-    getDataToInitSCM(): Promise<DataToInitSCM>;
+    getDataToInitSCM(options?: {
+        useHashes?: boolean;
+    }): Promise<DataToInitSCM>;
     getFilesStatus(id: string): Promise<FilesStatus>;
     getCompFilesDirPathFromLastSnapForAllComps(): Promise<{
         [relativePath: string]: string;
     }>;
+    getLaneHistoryForIDE(laneName?: string): Promise<{
+        entries: {
+            id: string;
+            date: string;
+            username: string | undefined;
+            email: string | undefined;
+            message: string | undefined;
+            components: string[];
+            deleted: string[] | undefined;
+        }[];
+        isMain: boolean;
+    }>;
+    getLaneHistoryDiffForIDE(fromHistoryId: string, toHistoryId: string, laneName?: string): Promise<LaneDiffForIDEResult>;
+    getLaneDiffForIDE(): Promise<LaneDiffForIDEResult>;
+    private toLaneDiffForIDEResult;
     getCurrentLaneName(includeScope?: boolean): string;
-    tagOrSnap(message?: string): Promise<import("@teambit/snapping").TagResults | import("@teambit/snapping").SnapResults | null>;
+    tagOrSnap(message?: string): Promise<import("@teambit/snapping").SnapResults | import("@teambit/snapping").TagResults | null>;
     tag(message?: string): Promise<string[]>;
     snap(message?: string): Promise<string[]>;
     getCompDetails(id: string, includeSchema?: boolean): Promise<Record<string, any>>;

package/dist/api-for-ide.js

@@ -81,6 +81,13 @@ function _componentModules() {
   };
   return data;
 }
+function _lanesModules() {
+  const data = require("@teambit/lanes.modules.diff");
+  _lanesModules = function () {
+    return data;
+  };
+  return data;
+}
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
@@ -390,6 +397,15 @@ class APIForIDE {
     }));
     return results;
   }
+  getCompFileObjectPathsFromLastSnap(compFiles) {
+    if (!compFiles.id.hasVersion()) return {}; // it's a new component.
+    const repo = this.workspace.scope.legacyScope.objects;
+    const results = {};
+    for (const modelFile of compFiles.modelFiles) {
+      results[(0, _legacy().pathJoinLinux)(compFiles.compDir, modelFile.relativePath)] = repo.objectPath(modelFile.file);
+    }
+    return results;
+  }
   async warmWorkspaceCache() {
     await this.workspace.warmCache();
   }
@@ -430,6 +446,9 @@ class APIForIDE {
     });
     return this.adjustCheckoutResultsToIde(results);
   }
+  async importObjectsIfOutdatedAgainstBitmap() {
+    return this.workspace.importObjectsIfOutdatedAgainstBitmap();
+  }
   async getTemplates() {
     const templates = await this.generator.listTemplates();
     return templates;
@@ -517,16 +536,25 @@ class APIForIDE {
     }));
     return (0, _lodash().compact)(results);
   }
-  async getDataToInitSCM() {
+  async getDataToInitSCM(options) {
+    const useHashes = options?.useHashes;
+    if (useHashes) {
+      // clean up old materialized files since hash-based reads don't need them
+      const lastSnapDir = _path().default.join(this.workspace.scope.path, FILES_HISTORY_DIR, LAST_SNAP_DIR);
+      await _fsExtra().default.remove(lastSnapDir);
+    }
     const ids = this.workspace.listIds();
     const results = {};
     await (0, _pMap().default)(ids, async id => {
       const compFiles = await this.workspace.getFilesModification(id);
-      const pathsFromLastSnap = await this.getCompFilesDirPathFromLastSnapUsingCompFiles(compFiles);
+      // only compute object paths when the extension supports direct object reads, otherwise materialize files to disk
+      const objectPathsFromLastSnap = useHashes ? this.getCompFileObjectPathsFromLastSnap(compFiles) : {};
+      const pathsFromLastSnap = useHashes ? {} : await this.getCompFilesDirPathFromLastSnapUsingCompFiles(compFiles);
       const idStr = id.toStringWithoutVersion();
       results[idStr] = {
         filesStatus: compFiles.getFilesStatus(),
         pathsFromLastSnap,
+        objectPathsFromLastSnap,
         compDir: compFiles.compDir
       };
     }, {
@@ -551,6 +579,81 @@ class APIForIDE {
     });
     return results;
   }
+  async getLaneHistoryForIDE(laneName) {
+    const laneId = laneName ? await this.lanes.parseLaneId(laneName) : this.workspace.getCurrentLaneId();
+    if (laneId.isDefault()) {
+      return {
+        entries: [],
+        isMain: true
+      };
+    }
+    await this.lanes.importLaneHistory(laneId);
+    const laneHistory = await this.lanes.getLaneHistory(laneId);
+    const historyIds = laneHistory.getHistoryIds();
+    const history = laneHistory.getHistory();
+    const entries = historyIds.map(id => {
+      const item = history[id];
+      return {
+        id,
+        date: item.log.date,
+        username: item.log.username,
+        email: item.log.email,
+        message: item.log.message,
+        components: item.components,
+        deleted: item.deleted
+      };
+    });
+    return {
+      entries,
+      isMain: false
+    };
+  }
+  async getLaneHistoryDiffForIDE(fromHistoryId, toHistoryId, laneName) {
+    const laneId = laneName ? await this.lanes.parseLaneId(laneName) : this.workspace.getCurrentLaneId();
+    if (laneId.isDefault()) {
+      throw new Error('lane history diff is not available on main');
+    }
+    await this.lanes.importLaneHistory(laneId);
+    const laneHistory = await this.lanes.getLaneHistory(laneId);
+    const laneObj = await this.lanes.loadLane(laneId);
+    if (!laneObj) throw new Error(`unable to find lane "${laneId.toString()}"`);
+    const diffGenerator = new (_lanesModules().LaneDiffGenerator)(this.workspace, this.scope, this.componentCompare);
+    const diffResults = await diffGenerator.generateDiffHistory(laneObj, laneHistory, fromHistoryId, toHistoryId);
+    return this.toLaneDiffForIDEResult(diffResults);
+  }
+  async getLaneDiffForIDE() {
+    const currentLaneId = this.workspace.getCurrentLaneId();
+    if (currentLaneId.isDefault()) {
+      throw new Error('lane diff is not available on main');
+    }
+    const diffGenerator = new (_lanesModules().LaneDiffGenerator)(this.workspace, this.scope, this.componentCompare);
+    const diffResults = await diffGenerator.generate([]);
+    return this.toLaneDiffForIDEResult(diffResults);
+  }
+  toLaneDiffForIDEResult(diffResults) {
+    return {
+      newCompsFrom: diffResults.newCompsFrom,
+      newCompsTo: diffResults.newCompsTo,
+      compsWithDiff: diffResults.compsWithDiff.map(d => ({
+        id: d.id.toString(),
+        hasDiff: d.hasDiff,
+        filesDiff: (d.filesDiff || []).map(f => ({
+          filePath: f.filePath,
+          status: f.status,
+          fromContent: f.status === 'UNCHANGED' ? undefined : f.fromContent,
+          toContent: f.status === 'UNCHANGED' ? undefined : f.toContent
+        })),
+        fieldsDiff: d.fieldsDiff
+      })),
+      compsWithNoChanges: diffResults.compsWithNoChanges,
+      toLaneName: diffResults.toLaneName,
+      fromLaneName: diffResults.fromLaneName,
+      failures: diffResults.failures.map(f => ({
+        id: f.id.toString(),
+        msg: f.msg
+      }))
+    };
+  }
   getCurrentLaneName(includeScope = false) {
     const currentLaneId = this.workspace.getCurrentLaneId();
     if (!includeScope) return currentLaneId.name;