@teambit/lanes 1.0.226 → 1.0.227

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

@@ -1,225 +0,0 @@
-import { CLIMain } from '@teambit/cli';
-import { ScopeMain } from '@teambit/scope';
-import { GraphqlMain } from '@teambit/graphql';
-import { ExpressMain } from '@teambit/express';
-import { Workspace } from '@teambit/workspace';
-import { LaneDiffResults } from '@teambit/lanes.modules.diff';
-import { LaneData } from '@teambit/legacy/dist/scope/lanes/lanes';
-import { LaneId } from '@teambit/lane-id';
-import { Logger, LoggerMain } from '@teambit/logger';
-import { DiffOptions } from '@teambit/legacy/dist/consumer/component-ops/components-diff';
-import { MergeStrategy } from '@teambit/legacy/dist/consumer/versions-ops/merge-version';
-import { TrackLane } from '@teambit/legacy/dist/scope/scope-json';
-import { ImporterMain } from '@teambit/importer';
-import { ComponentID } from '@teambit/component-id';
-import { Component, ComponentMain } from '@teambit/component';
-import { Lane, LaneHistory } from '@teambit/legacy/dist/scope/models';
-import { ExportMain } from '@teambit/export';
-import { ComponentCompareMain } from '@teambit/component-compare';
-import { ComponentWriterMain } from '@teambit/component-writer';
-import { RemoveMain } from '@teambit/remove';
-import { MergingMain } from '@teambit/merging';
-import { CheckoutMain } from '@teambit/checkout';
-import { ChangeType } from '@teambit/lanes.entities.lane-diff';
-import ComponentsList, { DivergeDataPerId } from '@teambit/legacy/dist/consumer/component/components-list';
-import { LaneCheckoutOpts } from './lane.cmd';
-export { Lane };
-export type SnapsDistanceObj = {
-    onSource: string[];
-    onTarget: string[];
-    common?: string;
-};
-export type LaneResults = {
-    lanes: LaneData[];
-    currentLane?: string | null;
-};
-export type CreateLaneOptions = {
-    scope?: string;
-    alias?: string;
-    forkLaneNewScope?: boolean;
-};
-export type SwitchLaneOptions = {
-    alias?: string;
-    merge?: MergeStrategy;
-    workspaceOnly?: boolean;
-    pattern?: string;
-    skipDependencyInstallation?: boolean;
-    verbose?: boolean;
-    override?: boolean;
-};
-export type LaneComponentDiffStatus = {
-    componentId: ComponentID;
-    sourceHead: string;
-    targetHead?: string;
-    /**
-     * @deprecated
-     * use changes to get list of all the changes
-     */
-    changeType?: ChangeType;
-    changes?: ChangeType[];
-    upToDate?: boolean;
-    snapsDistance?: SnapsDistanceObj;
-    unrelated?: boolean;
-};
-export type LaneDiffStatusOptions = {
-    skipChanges?: boolean;
-};
-export type LaneDiffStatus = {
-    source: LaneId;
-    target: LaneId;
-    componentsStatus: LaneComponentDiffStatus[];
-};
-export type MarkRemoveOnLaneResult = {
-    removedFromWs: ComponentID[];
-    markedRemoved: ComponentID[];
-};
-export type CreateLaneResult = {
-    laneId: LaneId;
-    hash: string;
-    alias?: string;
-};
-export declare class LanesMain {
-    readonly workspace: Workspace | undefined;
-    private scope;
-    private merging;
-    private componentAspect;
-    logger: Logger;
-    readonly importer: ImporterMain;
-    private exporter;
-    private componentCompare;
-    readonly componentWriter: ComponentWriterMain;
-    private remove;
-    readonly checkout: CheckoutMain;
-    constructor(workspace: Workspace | undefined, scope: ScopeMain, merging: MergingMain, componentAspect: ComponentMain, logger: Logger, importer: ImporterMain, exporter: ExportMain, componentCompare: ComponentCompareMain, componentWriter: ComponentWriterMain, remove: RemoveMain, checkout: CheckoutMain);
-    /**
-     * return the lane data without the deleted components.
-     * the deleted components are filtered out in legacyScope.lanes.getLanesData()
-     */
-    getLanes({ name, remote, merged, showDefaultLane, notMerged, }: {
-        name?: string;
-        remote?: string;
-        merged?: boolean;
-        showDefaultLane?: boolean;
-        notMerged?: boolean;
-    }): Promise<LaneData[]>;
-    parseLaneId(idStr: string): Promise<LaneId>;
-    getLaneHistory(laneId: LaneId): Promise<LaneHistory>;
-    checkoutHistory(historyId: string, options?: LaneCheckoutOpts): Promise<import("@teambit/merging").ApplyVersionResults>;
-    revertHistory(historyId: string, options?: LaneCheckoutOpts): Promise<import("@teambit/merging").ApplyVersionResults>;
-    private getHistoryItemOfCurrentLane;
-    importLaneHistory(laneId: LaneId): Promise<void>;
-    getCurrentLaneName(): string | null;
-    getCurrentLaneNameOrAlias(): string | null;
-    getCurrentLaneId(): LaneId | null;
-    /**
-     * get the currently checked out lane object, if on main - return null.
-     */
-    getCurrentLane(): Promise<Lane | null>;
-    getDefaultLaneId(): LaneId;
-    setCurrentLane(laneId: LaneId, alias?: string, exported?: boolean): void;
-    createLane(name: string, { scope, alias, forkLaneNewScope }?: CreateLaneOptions): Promise<CreateLaneResult>;
-    loadLane(id: LaneId): Promise<Lane | null>;
-    trackLane(localName: string, remoteScope: string, remoteName?: string): Promise<{
-        beforeTrackData?: TrackLane;
-        afterTrackData: TrackLane;
-    }>;
-    aliasLane(laneName: string, alias: string): Promise<{
-        laneId: LaneId;
-    }>;
-    changeScope(remoteScope: string, laneName?: string): Promise<{
-        remoteScopeBefore: string;
-        localName: string;
-    }>;
-    /**
-     * change a lane-name and if possible, export the lane to the remote
-     */
-    rename(newName: string, laneName?: string): Promise<{
-        currentName: string;
-    }>;
-    exportLane(lane: Lane): Promise<void>;
-    importLaneObject(laneId: LaneId, persistIfNotExists?: boolean, includeLaneHistory?: boolean): Promise<Lane>;
-    /**
-     * get the head hash (snap) of main. return undefined if the component exists only on a lane and was never merged to main
-     */
-    getHeadOnMain(componentId: ComponentID): Promise<string | undefined>;
-    /**
-     * fetch the lane object and its components from the remote.
-     * save the objects and the lane to the local scope.
-     * this method doesn't change anything in the workspace.
-     */
-    fetchLaneWithItsComponents(laneId: LaneId): Promise<Lane>;
-    removeLanes(laneNames: string[], opts?: {
-        remote: boolean;
-        force: boolean;
-    }): Promise<string[]>;
-    /**
-     * when deleting a lane object, it is sent into the "trash" directory in the scope.
-     * this method restores it and put it back in the "objects" directory.
-     * as an argument, it needs a hash. the reason for not supporting lane-id is because the trash may have multiple
-     * lanes with the same lane-id but different hashes.
-     */
-    restoreLane(laneHash: string): Promise<void>;
-    /**
-     * switch to a different local or remote lane.
-     * switching to a remote lane also imports and writes the components of that remote lane.
-     * by default, only the components existing on the workspace will be imported from that lane, unless the "getAll"
-     * flag is true.
-     */
-    switchLanes(laneName: string, { alias, merge, pattern, workspaceOnly, skipDependencyInstallation }: SwitchLaneOptions): Promise<import("@teambit/merging").ApplyVersionResults>;
-    /**
-     * the values array may include zero to two values and will be processed as following:
-     * [] => diff between the current lane and default lane. (only inside workspace).
-     * [to] => diff between the current lane (or default-lane when in scope) and "to" lane.
-     * [from, to] => diff between "from" lane and "to" lane.
-     */
-    getDiff(values: string[], diffOptions?: DiffOptions, pattern?: string): Promise<LaneDiffResults>;
-    getLaneComponentModels(lane: LaneData): Promise<Component[]>;
-    getLaneComponentIds(lane: LaneData): Promise<ComponentID[]>;
-    getLaneReadmeComponent(lane: LaneData): Promise<Component | undefined>;
-    removeLaneReadme(laneName?: string): Promise<{
-        result: boolean;
-        message?: string;
-    }>;
-    diffStatus(sourceLaneId: LaneId, targetLaneId?: LaneId, options?: LaneDiffStatusOptions): Promise<LaneDiffStatus>;
-    private componentDiffStatus;
-    componentDiffStatusOld(componentId: ComponentID, sourceHead: string, targetHead?: string, options?: LaneDiffStatusOptions): Promise<LaneComponentDiffStatus>;
-    private recreateNewLaneIfDeleted;
-    addLaneReadme(readmeComponentIdStr: string, laneName?: string): Promise<{
-        result: boolean;
-        message?: string;
-    }>;
-    /**
-     * if the local lane was forked from another lane, this gets the differences between the two.
-     * it also fetches the original lane from the remote to make sure the data is up to date.
-     */
-    listUpdatesFromForked(componentsList: ComponentsList): Promise<DivergeDataPerId[]>;
-    /**
-     * default to remove all of them.
-     * returns true if the lane has changed
-     */
-    removeUpdateDependents(laneId: LaneId, ids?: ComponentID[]): Promise<Boolean>;
-    private getLaneDataOfDefaultLane;
-    get createRoutePath(): string;
-    get deleteRoutePath(): string;
-    get restoreRoutePath(): string;
-    static slots: never[];
-    static dependencies: import("@teambit/harmony").Aspect[];
-    static runtime: import("@teambit/harmony").RuntimeDefinition;
-    static provider([cli, scope, workspace, graphql, merging, component, loggerMain, importer, exporter, express, componentCompare, componentWriter, remove, checkout,]: [
-        CLIMain,
-        ScopeMain,
-        Workspace,
-        GraphqlMain,
-        MergingMain,
-        ComponentMain,
-        LoggerMain,
-        ImporterMain,
-        ExportMain,
-        ExpressMain,
-        ComponentCompareMain,
-        ComponentWriterMain,
-        RemoveMain,
-        CheckoutMain
-    ]): Promise<LanesMain>;
-}
-export default LanesMain;

package/dist/lanes.restore.route.d.ts

@@ -1,13 +0,0 @@
-/// <reference types="express" />
-import { Route, Verb, Request, Response } from '@teambit/express';
-import { Logger } from '@teambit/logger';
-import { LanesMain } from './lanes.main.runtime';
-export declare class LanesRestoreRoute implements Route {
-    private lanes;
-    private logger;
-    constructor(lanes: LanesMain, logger: Logger);
-    method: string;
-    route: string;
-    verb: Verb;
-    middlewares: ((req: Request, res: Response) => Promise<import("express").Response<any, Record<string, any>>>)[];
-}

package/dist/lanes.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/lanes.ui.runtime.d.ts

@@ -1,103 +0,0 @@
-import { RouteProps } from 'react-router-dom';
-import { Harmony, SlotRegistry } from '@teambit/harmony';
-import { type LaneCompareProps as DefaultLaneCompareProps } from '@teambit/lanes.ui.compare.lane-compare';
-import { UiUI } from '@teambit/ui';
-import type { NavigationSlot, RouteSlot } from '@teambit/ui-foundation.ui.react-router.slot-router';
-import { ScopeUI } from '@teambit/scope';
-import { WorkspaceUI } from '@teambit/workspace';
-import { ComponentUI, ComponentID } from '@teambit/component';
-import { MenuWidget, MenuWidgetSlot } from '@teambit/ui-foundation.ui.menu';
-import { LaneOverviewLine, LaneOverviewLineSlot } from '@teambit/lanes.ui.lane-overview';
-import { LanesNavPlugin, LanesOrderedNavigationSlot } from '@teambit/lanes.ui.menus.lanes-overview-menu';
-import { LanesProvider, IgnoreDerivingFromUrl } from '@teambit/lanes.hooks.use-lanes';
-import { LaneId } from '@teambit/lane-id';
-import { ComponentCompareUI } from '@teambit/component-compare';
-export type LaneCompareProps = Partial<DefaultLaneCompareProps>;
-export type LaneProviderIgnoreSlot = SlotRegistry<IgnoreDerivingFromUrl>;
-export declare function useComponentFilters(): {
-    loading: boolean;
-    log?: undefined;
-} | {
-    loading: boolean;
-    log: {
-        head: string;
-    };
-};
-export declare function useLaneComponentIdFromUrl(): ComponentID | undefined | null;
-export declare function useComponentId(): string | undefined;
-export declare class LanesUI {
-    private componentUI;
-    private componentCompareUI;
-    private routeSlot;
-    private navSlot;
-    private menuWidgetSlot;
-    /**
-     * overview line slot to add new lines beneath the overview section
-     */
-    private overviewSlot;
-    private laneProviderIgnoreSlot;
-    private workspace?;
-    private scope?;
-    static dependencies: import("@teambit/harmony").Aspect[];
-    static runtime: import("@teambit/harmony").RuntimeDefinition;
-    static slots: (((registerFn: () => string) => SlotRegistry<RouteProps>) | ((registerFn: () => string) => SlotRegistry<LaneOverviewLineSlot>) | ((registerFn: () => string) => SlotRegistry<NavigationSlot>) | ((registerFn: () => string) => SlotRegistry<LaneProviderIgnoreSlot>))[];
-    constructor(componentUI: ComponentUI, componentCompareUI: ComponentCompareUI, routeSlot: RouteSlot, navSlot: LanesOrderedNavigationSlot, menuWidgetSlot: MenuWidgetSlot, 
-    /**
-     * overview line slot to add new lines beneath the overview section
-     */
-    overviewSlot: LaneOverviewLineSlot, laneProviderIgnoreSlot: LaneProviderIgnoreSlot, workspace?: WorkspaceUI | undefined, scope?: ScopeUI | undefined);
-    private readonly lanesHost;
-    private readonly hostAspect?;
-    private readonly host;
-    private registerHostAspectRoutes;
-    getLaneRoutes(): {
-        path: string;
-        children: import("react/jsx-runtime").JSX.Element;
-    }[];
-    overrideComputeLaneUrl(fn: () => {
-        prefix: string;
-        path: string;
-        getLaneIdFromPathname: (pathname: string) => LaneId | undefined;
-        getLaneUrl: (laneId: LaneId, relative?: boolean) => string;
-        getLaneComponentUrl: (componentId: ComponentID, laneId: LaneId) => string;
-    }): void;
-    getLaneComponent(): import("react/jsx-runtime").JSX.Element;
-    getLaneComponentMenu(): import("react/jsx-runtime").JSX.Element;
-    getLaneOverview(): import("react/jsx-runtime").JSX.Element;
-    getLanesComparePage(): import("react/jsx-runtime").JSX.Element;
-    getMenuRoutes(): {
-        path: string;
-        children: import("react/jsx-runtime").JSX.Element;
-    }[];
-    getLanesOverviewMenu(): import("react/jsx-runtime").JSX.Element;
-    registerMenuWidget(...menuItems: MenuWidget[]): this;
-    registerLaneProviderIgnoreSlot(ignoreFn: IgnoreDerivingFromUrl): this;
-    private registerLanesRoutes;
-    private registerRoutes;
-    getLanesSwitcher(): import("react/jsx-runtime").JSX.Element;
-    getLanesProvider(): typeof LanesProvider;
-    getUseLanes(): import("@teambit/lanes.hooks.use-lanes").UseLanes;
-    private registerLanesDropdown;
-    private renderContext;
-    registerRoute(route: RouteProps): this;
-    /**
-     * register a new line beneath the lane overview section.
-     */
-    registerOverviewLine(...lines: LaneOverviewLine[]): this;
-    registerNavigation(routes: LanesNavPlugin[]): void;
-    getLaneCompare: (props: LaneCompareProps) => import("react/jsx-runtime").JSX.Element | null;
-    static provider([uiUi, componentUI, workspaceUi, scopeUi, componentCompareUI]: [
-        UiUI,
-        ComponentUI,
-        WorkspaceUI,
-        ScopeUI,
-        ComponentCompareUI
-    ], _: any, [routeSlot, overviewSlot, navSlot, menuWidgetSlot, laneProviderIgnoreSlot]: [
-        RouteSlot,
-        LaneOverviewLineSlot,
-        LanesOrderedNavigationSlot,
-        MenuWidgetSlot,
-        LaneProviderIgnoreSlot
-    ], harmony: Harmony): Promise<LanesUI>;
-}
-export default LanesUI;

package/dist/switch-lanes.d.ts

@@ -1,35 +0,0 @@
-import { ComponentID } from '@teambit/component-id';
-import { ApplyVersionResults } from '@teambit/merging';
-import { Lane } from '@teambit/legacy/dist/scope/models';
-import { CheckoutProps } from '@teambit/checkout';
-import { Workspace } from '@teambit/workspace';
-import { Logger } from '@teambit/logger';
-import { LanesMain } from './lanes.main.runtime';
-export type SwitchProps = {
-    laneName: string;
-    ids?: ComponentID[];
-    laneBitIds?: ComponentID[];
-    pattern?: string;
-    existingOnWorkspaceOnly?: boolean;
-    remoteLane?: Lane;
-    localTrackedLane?: string;
-    alias?: string;
-};
-export declare class LaneSwitcher {
-    private workspace;
-    private logger;
-    private switchProps;
-    private checkoutProps;
-    private lanes;
-    private consumer;
-    private laneIdToSwitchTo;
-    private laneToSwitchTo;
-    constructor(workspace: Workspace, logger: Logger, switchProps: SwitchProps, checkoutProps: CheckoutProps, lanes: LanesMain);
-    switch(): Promise<ApplyVersionResults>;
-    private populateSwitchProps;
-    private populatePropsAccordingToRemoteLane;
-    private populatePropsAccordingToDefaultLane;
-    private populatePropsAccordingToLocalLane;
-    private throwForSwitchingToCurrentLane;
-    private saveLanesData;
-}

package/dist/switch.cmd.d.ts

@@ -1,28 +0,0 @@
-import { Command, CommandOptions } from '@teambit/cli';
-import { MergeStrategy } from '@teambit/legacy/dist/consumer/versions-ops/merge-version';
-import { LanesMain } from './lanes.main.runtime';
-export declare class SwitchCmd implements Command {
-    private lanes;
-    name: string;
-    description: string;
-    extendedDescription: string;
-    private: boolean;
-    alias: string;
-    arguments: {
-        name: string;
-        description: string;
-    }[];
-    options: CommandOptions;
-    loader: boolean;
-    constructor(lanes: LanesMain);
-    report([lane]: [string], { alias, merge, getAll, workspaceOnly, skipDependencyInstallation, pattern, json, }: {
-        alias?: string;
-        merge?: MergeStrategy;
-        getAll?: boolean;
-        workspaceOnly?: boolean;
-        skipDependencyInstallation?: boolean;
-        override?: boolean;
-        pattern?: string;
-        json?: boolean;
-    }): Promise<string>;
-}