@teambit/component 1.0.228 → 1.0.229

package/dist/state.d.ts

@@ -0,0 +1,65 @@
+import { IssuesList } from '@teambit/component-issues';
+import ComponentFS from './component-fs';
+import { Config } from './config';
+import { AspectList } from './aspect-list';
+export declare class State {
+    /**
+     * component configuration which is later generated to a component `package.json` and `bit.json`.
+     * @deprecated please use `aspects` instead.
+     */
+    readonly config: Config;
+    /**
+     * list of aspects configured on the component.
+     */
+    private _aspects;
+    /**
+     * in-memory representation of the component current filesystem.
+     */
+    readonly filesystem: ComponentFS;
+    /**
+     * dependency graph of the component current. ideally package dependencies would be also placed here.
+     */
+    readonly dependencies: any;
+    /**
+     * instance of legacy consumer component.
+     */
+    readonly _consumer: any;
+    constructor(
+    /**
+     * component configuration which is later generated to a component `package.json` and `bit.json`.
+     * @deprecated please use `aspects` instead.
+     */
+    config: Config, 
+    /**
+     * list of aspects configured on the component.
+     */
+    _aspects: AspectList, 
+    /**
+     * in-memory representation of the component current filesystem.
+     */
+    filesystem: ComponentFS, 
+    /**
+     * dependency graph of the component current. ideally package dependencies would be also placed here.
+     */
+    dependencies: any, 
+    /**
+     * instance of legacy consumer component.
+     */
+    _consumer: any);
+    /**
+     * get the main file of the component.
+     */
+    get mainFile(): import("@teambit/legacy/dist/consumer/component/sources").AbstractVinyl;
+    /**
+     * calculate the hash of this state
+     */
+    get hash(): string;
+    get issues(): IssuesList;
+    /**
+     * @deprecated please use `component.isModified`.
+     * the way it's implemented here is unreliable and will only work if in the legacy the "isModified" was calculated.
+     */
+    get isModified(): boolean;
+    get aspects(): AspectList;
+    set aspects(aspects: AspectList);
+}

package/dist/store.d.ts

@@ -0,0 +1,3 @@
+import { ExtensionDataList } from '@teambit/legacy/dist/consumer/config/extension-data';
+export declare class Store extends ExtensionDataList {
+}

package/dist/tag/index.d.ts

@@ -0,0 +1 @@
+export { Tag } from './tag';

package/dist/tag/tag.d.ts

@@ -0,0 +1,32 @@
+import { SemVer } from 'semver';
+export type TagProps = {
+    hash: string;
+    version: string;
+};
+/**
+ * `Tag` provides a sematic reference to a specific state `Snap` in the working tree.
+ */
+export declare class Tag {
+    /**
+     * tag hash, can be used to load it by component-factory.getSnap
+     */
+    readonly hash: string;
+    /**
+     * sematic version of the snap.
+     */
+    readonly version: SemVer;
+    constructor(
+    /**
+     * tag hash, can be used to load it by component-factory.getSnap
+     */
+    hash: string, 
+    /**
+     * sematic version of the snap.
+     */
+    version: SemVer);
+    /**
+     * create a plain tag object.
+     */
+    toObject(): TagProps;
+    static fromObject(tag: TagProps): Tag;
+}

package/dist/tag-map.d.ts

@@ -0,0 +1,35 @@
+import { SemVer } from 'semver';
+import { Hash } from './hash';
+import { Tag } from './tag';
+export declare class TagMap extends Map<SemVer, Tag> {
+    /**
+     * get snap by hash.
+     */
+    byHash(hash: Hash): Tag | undefined;
+    /**
+     * e.g.
+     * {
+     *   alpha: '1.0.0-alpha.5',
+     *   dev: '2.2.4-dev.37
+     * }
+     */
+    getPreReleaseLatestTags(): {
+        [preRelease: string]: string;
+    };
+    /**
+     * Get a map that map snap hash to tag
+     */
+    getHashMap(): Map<Hash, Tag>;
+    /**
+     * get the latest semver from the tag map.
+     */
+    getLatest(): string;
+    isEmpty(): boolean;
+    /**
+     * get an array of all tags.
+     */
+    toArray(): Tag[];
+    byVersion(version: string): Tag | undefined;
+    static fromArray(tags: Tag[]): TagMap;
+    static empty(): TagMap;
+}

package/dist/ui/aspect-page/aspect-page.d.ts

@@ -0,0 +1 @@
+export declare function AspectPage(): import("react/jsx-runtime").JSX.Element;

package/dist/ui/aspect-page/index.d.ts

@@ -0,0 +1 @@
+export { AspectPage } from './aspect-page';

package/dist/ui/component-error/component-error.d.ts

@@ -0,0 +1,20 @@
+export declare class ComponentError {
+    /**
+     * http status code of error
+     */
+    readonly code: number;
+    /**
+     * error message of the error
+     */
+    readonly message?: string | undefined;
+    constructor(
+    /**
+     * http status code of error
+     */
+    code: number, 
+    /**
+     * error message of the error
+     */
+    message?: string | undefined);
+    renderError(): import("react/jsx-runtime").JSX.Element;
+}

package/dist/ui/component-error/index.d.ts

@@ -0,0 +1 @@
+export { ComponentError } from './component-error';

package/dist/ui/component-model/component-model.d.ts

@@ -0,0 +1,186 @@
+import { Composition, CompositionProps } from '@teambit/compositions';
+import { DeprecationInfo } from '@teambit/deprecation';
+import { Descriptor } from '@teambit/envs';
+import { ComponentID, ComponentIdObj } from '@teambit/component-id';
+import { LegacyComponentLog } from '@teambit/legacy-component-log';
+import { ComponentPreviewSize } from '@teambit/preview';
+import { TagMap } from '../../tag-map';
+import { TagProps } from '../../tag/tag';
+export type ComponentModelProps = {
+    id: ComponentIdObj;
+    description: string;
+    buildStatus?: string;
+    server?: ComponentServer;
+    displayName: string;
+    packageName: string;
+    compositions?: CompositionProps[];
+    tags?: TagProps[];
+    issuesCount?: number;
+    status?: any;
+    deprecation?: DeprecationInfo;
+    env?: Descriptor;
+    labels?: string[];
+    host?: string;
+    latest?: string;
+    preview?: ComponentPreview;
+    logs?: LegacyComponentLog[];
+    size?: ComponentPreviewSize;
+};
+export type ComponentPreview = {
+    includesEnvTemplate?: boolean;
+    isScaling?: boolean;
+    onlyOverview?: boolean;
+    legacyHeader?: boolean;
+    useNameParam?: boolean;
+    skipIncludes?: boolean;
+};
+export type ComponentServer = {
+    env: string;
+    /**
+     * Full dev server url.
+     */
+    url?: string;
+    /**
+     * host of the component server (used mostly by cloud providers for remote scopes)
+     */
+    host?: string;
+    /**
+     * This is used mostly by cloud to proxy requests to the correct scope.
+     */
+    basePath?: string;
+};
+export declare class ComponentModel {
+    /**
+     * id of the component
+     */
+    readonly id: ComponentID;
+    /**
+     * display name of the component.
+     */
+    readonly displayName: string;
+    /**
+     * package name of the component.
+     */
+    readonly packageName: string;
+    /**
+     * the component server.
+     */
+    readonly server: ComponentServer | undefined;
+    /**
+     * array of compositions
+     */
+    readonly compositions: Composition[];
+    /**
+     * tags of the component.
+     */
+    readonly tags: TagMap;
+    /**
+     * component build status
+     */
+    readonly buildStatus?: string | undefined;
+    /**
+     * issues of component.
+     */
+    readonly issuesCount?: number | undefined;
+    /**
+     * status of component.
+     */
+    readonly status?: any;
+    /**
+     * deprecation info of the component.
+     */
+    readonly deprecation?: DeprecationInfo | undefined;
+    /**
+     * env descriptor.
+     */
+    readonly environment?: Descriptor | undefined;
+    /**
+     * description of the component.
+     */
+    readonly description: string;
+    readonly labels: string[];
+    /**
+     * host of the component
+     */
+    readonly host?: string | undefined;
+    /**
+     *
+     * size preview
+     */
+    readonly size?: ComponentPreviewSize | undefined;
+    /**
+     * latest version of component
+     */
+    readonly latest?: string | undefined;
+    readonly preview?: ComponentPreview | undefined;
+    readonly logs?: LegacyComponentLog[] | undefined;
+    constructor(
+    /**
+     * id of the component
+     */
+    id: ComponentID, 
+    /**
+     * display name of the component.
+     */
+    displayName: string, 
+    /**
+     * package name of the component.
+     */
+    packageName: string, 
+    /**
+     * the component server.
+     */
+    server: ComponentServer | undefined, 
+    /**
+     * array of compositions
+     */
+    compositions: Composition[], 
+    /**
+     * tags of the component.
+     */
+    tags: TagMap, 
+    /**
+     * component build status
+     */
+    buildStatus?: string | undefined, 
+    /**
+     * issues of component.
+     */
+    issuesCount?: number | undefined, 
+    /**
+     * status of component.
+     */
+    status?: any, 
+    /**
+     * deprecation info of the component.
+     */
+    deprecation?: DeprecationInfo | undefined, 
+    /**
+     * env descriptor.
+     */
+    environment?: Descriptor | undefined, 
+    /**
+     * description of the component.
+     */
+    description?: string, labels?: string[], 
+    /**
+     * host of the component
+     */
+    host?: string | undefined, 
+    /**
+     *
+     * size preview
+     */
+    size?: ComponentPreviewSize | undefined, 
+    /**
+     * latest version of component
+     */
+    latest?: string | undefined, preview?: ComponentPreview | undefined, logs?: LegacyComponentLog[] | undefined);
+    get version(): string;
+    /**
+     * create an instance of a component from a plain object.
+     */
+    static from({ id, server, displayName, compositions, packageName, tags, deprecation, buildStatus, env, status, issuesCount, description, labels, host, latest, preview, size, logs, }: ComponentModelProps): ComponentModel;
+    static fromArray(componentsProps: ComponentModelProps[]): ComponentModel[];
+    static empty(): ComponentModel;
+}

package/dist/ui/component-model/index.d.ts

@@ -0,0 +1 @@
+export { ComponentModel, ComponentModelProps } from './component-model';

package/dist/ui/component-searcher/component-result.d.ts

@@ -0,0 +1,16 @@
+import React, { ComponentType } from 'react';
+import { ComponentModel } from '../component-model';
+export type ComponentPluginProps = React.HTMLAttributes<HTMLDivElement> & {
+    component: ComponentModel;
+};
+export type ComponentResultPlugin = {
+    key: string;
+    start?: ComponentType<ComponentPluginProps>;
+    end?: ComponentType<ComponentPluginProps>;
+};
+type ComponentResultProps = {
+    component: ComponentModel;
+    plugins?: ComponentResultPlugin[];
+};
+export declare function ComponentResult({ component, plugins }: ComponentResultProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/ui/component-searcher/component-searcher.d.ts

@@ -0,0 +1,22 @@
+import { SearchResult, FuzzySearchItem, FuzzySearcher } from '@teambit/explorer.ui.command-bar';
+import type { SearchProvider } from '@teambit/command-bar';
+import { ComponentResultPlugin } from './component-result';
+import { ComponentModel } from '../component-model';
+export type { ComponentResultPlugin };
+type ComponentSearchIdx = {
+    name: string;
+    displayName: string;
+    component: ComponentModel;
+};
+type ComponentSearcherOptions = {
+    navigate: (path: string) => void;
+    resultPlugins?: ComponentResultPlugin[];
+};
+export declare class ComponentSearcher extends FuzzySearcher<ComponentModel, ComponentSearchIdx> implements SearchProvider {
+    options: ComponentSearcherOptions;
+    constructor(options: ComponentSearcherOptions);
+    updatePlugins(plugins: ComponentResultPlugin[]): void;
+    test(term: string): boolean;
+    protected toSearchableItem(item: ComponentModel): ComponentSearchIdx;
+    protected toSearchResult: ({ item }: FuzzySearchItem<ComponentSearchIdx>) => SearchResult;
+}

package/dist/ui/component-searcher/index.d.ts

@@ -0,0 +1,2 @@
+export { ComponentSearcher } from './component-searcher';
+export type { ComponentResultPlugin } from './component-searcher';

package/dist/ui/component.d.ts

@@ -0,0 +1,26 @@
+import { ReactNode } from 'react';
+import { RouteProps } from 'react-router-dom';
+import type { RouteSlot } from '@teambit/ui-foundation.ui.react-router.slot-router';
+import { SlotRegistry } from '@teambit/harmony';
+import { UseComponentType, Filters } from './use-component';
+import { ComponentModel } from './component-model';
+export type ComponentPageSlot = SlotRegistry<ComponentPageElement[]>;
+export type ComponentPageElement = {
+    type: 'before' | 'after';
+    content: ReactNode;
+};
+export type ComponentProps = {
+    containerSlot?: ComponentPageSlot;
+    routeSlot: RouteSlot;
+    overriddenRoutes?: RouteProps[];
+    host: string;
+    onComponentChange?: (activeComponent?: ComponentModel) => void;
+    useComponent?: UseComponentType;
+    useComponentFilters?: () => Filters;
+    path?: string;
+    componentIdStr?: string | (() => string | undefined);
+};
+/**
+ * main UI component of the Component extension.
+ */
+export declare function Component({ routeSlot, overriddenRoutes, containerSlot, host, onComponentChange, componentIdStr, useComponent, path, useComponentFilters, }: ComponentProps): import("react/jsx-runtime").JSX.Element;

package/dist/ui/context/component-context.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+import type { ComponentDescriptor } from '@teambit/component-descriptor';
+import { ComponentModel } from '../component-model';
+export declare const ComponentContext: React.Context<ComponentModel>;
+export declare const ComponentDescriptorContext: React.Context<ComponentDescriptor | undefined>;
+export declare const useComponentDescriptor: () => ComponentDescriptor | undefined;

package/dist/ui/context/component-provider.d.ts

@@ -0,0 +1,25 @@
+import { ReactNode } from 'react';
+import type { ComponentDescriptor } from '@teambit/component-descriptor';
+import { ComponentModel } from '../component-model';
+export type ComponentProviderProps = {
+    /**
+     * component model.
+     */
+    component: ComponentModel;
+    /**
+     * component children.
+     */
+    children: ReactNode;
+};
+export declare function ComponentProvider({ component, children }: ComponentProviderProps): import("react/jsx-runtime").JSX.Element;
+export type ComponentDescriptorProviderProps = {
+    /**
+     * component model.
+     */
+    componentDescriptor?: ComponentDescriptor;
+    /**
+     * component children.
+     */
+    children: ReactNode;
+};
+export declare function ComponentDescriptorProvider({ componentDescriptor, children }: ComponentDescriptorProviderProps): import("react/jsx-runtime").JSX.Element;

package/dist/ui/context/index.d.ts

@@ -0,0 +1,3 @@
+export { ComponentContext, ComponentDescriptorContext, useComponentDescriptor } from './component-context';
+export { ComponentProvider, ComponentDescriptorProvider } from './component-provider';
+export type { ComponentProviderProps, ComponentDescriptorProviderProps } from './component-provider';

package/dist/ui/index.d.ts

@@ -0,0 +1,12 @@
+export { CollapsibleMenuNav, MenuNavProps } from './menu';
+export { Component } from './component';
+export { ConsumeMethodSlot, ComponentMenu, VersionRelatedDropdowns } from './menu';
+export { ComponentModel, ComponentModelProps } from './component-model';
+export { ComponentContext, ComponentProvider } from './context';
+export { TopBarNav } from './top-bar-nav';
+export { useComponent } from './use-component';
+export { componentIdFields, componentOverviewFields, componentFields, componentFieldsWithLogs, COMPONENT_QUERY_LOG_FIELDS, GET_COMPONENT, GET_COMPONENT_WITH_LOGS, } from './use-component.fragments';
+export { useIdFromLocation } from './use-component-from-location';
+export type { LogFilter, Filters, UseComponentOptions, ComponentQueryResult, UseComponentType, ComponentLogs, ComponentLogsResult, } from './use-component.model';
+export { useComponentQuery } from './use-component-query';
+export { useComponentLogs } from './use-component-logs';

package/dist/ui/menu/index.d.ts

@@ -0,0 +1,3 @@
+export { CollapsibleMenuNav, MenuNavProps } from './menu-nav';
+export { ComponentMenu, VersionRelatedDropdowns, RightSideMenuItem, RightSideMenuSlot } from './menu';
+export type { NavPlugin, OrderedNavigationSlot, ConsumePlugin, ConsumeMethodSlot, ConsumePluginProps, } from './nav-plugin';

package/dist/ui/menu/menu-nav.d.ts

@@ -0,0 +1,23 @@
+import React from 'react';
+import { NavPlugin, OrderedNavigationSlot } from './nav-plugin';
+export type MenuNavProps = {
+    /**
+     * @deprecated
+     * use @property navPlugins
+     */
+    navigationSlot?: OrderedNavigationSlot;
+    /**
+     * @deprecated
+     * use @property widgetPlugins
+     */
+    widgetSlot?: OrderedNavigationSlot;
+    navPlugins?: [string, NavPlugin][];
+    widgetPlugins?: [string, NavPlugin][];
+    /**
+     * A className to pass to the secondary nav, i.e dropdown
+     */
+    secondaryNavClassName?: string;
+    activeTabIndex?: number;
+    alwaysShowActiveTab?: boolean;
+} & React.HTMLAttributes<HTMLElement>;
+export declare function CollapsibleMenuNav({ navigationSlot, widgetSlot, navPlugins, widgetPlugins, className, secondaryNavClassName, activeTabIndex, alwaysShowActiveTab, children, }: MenuNavProps): import("react/jsx-runtime").JSX.Element;

package/dist/ui/menu/menu.d.ts

@@ -0,0 +1,97 @@
+import React, { ReactNode } from 'react';
+import { SlotRegistry } from '@teambit/harmony';
+import { DropdownComponentVersion, GetActiveTabIndex } from '@teambit/component.ui.version-dropdown';
+import { MenuItemSlot } from '@teambit/ui-foundation.ui.main-dropdown';
+import { LanesModel } from '@teambit/lanes.ui.models.lanes-model';
+import { UseComponentType, Filters } from '../use-component';
+import { OrderedNavigationSlot, ConsumeMethodSlot } from './nav-plugin';
+import { ComponentID } from '../..';
+export type RightSideMenuItem = {
+    item: ReactNode;
+    order: number;
+};
+export type RightSideMenuSlot = SlotRegistry<RightSideMenuItem[]>;
+export type MenuProps = {
+    className?: string;
+    /**
+     * skip the right side.
+     */
+    skipRightSide?: boolean;
+    /**
+     * custom render the right side
+     */
+    RightNode?: React.ReactNode;
+    /**
+     * slot for top bar menu nav items
+     */
+    navigationSlot: OrderedNavigationSlot;
+    /**
+     * right side navigation menu item slot
+     */
+    widgetSlot: OrderedNavigationSlot;
+    /**
+     * right side menu item slot
+     */
+    rightSideMenuSlot: RightSideMenuSlot;
+    /**
+     * workspace or scope
+     */
+    host: string;
+    /**
+     * main dropdown item slot
+     */
+    menuItemSlot: MenuItemSlot;
+    consumeMethodSlot: ConsumeMethodSlot;
+    componentIdStr?: string | (() => string | undefined);
+    useComponent?: UseComponentType;
+    useComponentFilters?: () => Filters;
+    useLanes?: () => {
+        loading?: boolean;
+        lanesModel?: LanesModel;
+    };
+    path?: string;
+};
+/**
+ * top bar menu.
+ */
+export declare function ComponentMenu({ navigationSlot, widgetSlot, className, host, menuItemSlot, consumeMethodSlot, rightSideMenuSlot, componentIdStr, skipRightSide, RightNode, useComponent, path, useComponentFilters, }: MenuProps): import("react/jsx-runtime").JSX.Element;
+export type VersionRelatedDropdownsProps = {
+    componentId?: string;
+    consumeMethods?: ConsumeMethodSlot;
+    componentFilters?: Filters;
+    useComponent?: UseComponentVersions;
+    className?: string;
+    loading?: boolean;
+    host: string;
+    useLanes?: () => {
+        loading?: boolean;
+        lanesModel?: LanesModel;
+    };
+    dropdownOptions?: {
+        showVersionDetails?: boolean;
+        getActiveTabIndex?: GetActiveTabIndex;
+    };
+};
+export type UseComponentVersionsProps = {
+    skip?: boolean;
+    id?: string;
+    initialLoad?: boolean;
+};
+export type UseComponentVersionProps = {
+    skip?: boolean;
+    version?: string;
+};
+export type UseComponentVersions = (props?: UseComponentVersionsProps) => UseComponentVersionsResult;
+export type UseComponentVersion = (props?: UseComponentVersionProps) => DropdownComponentVersion | undefined;
+export type UseComponentVersionsResult = {
+    tags?: DropdownComponentVersion[];
+    snaps?: DropdownComponentVersion[];
+    id?: ComponentID;
+    packageName?: string;
+    latest?: string;
+    currentVersion?: string;
+    loading?: boolean;
+};
+export declare function defaultLoadVersions(host: string, componentId?: string, componentFilters?: Filters, useComponent?: UseComponentType, loadingFromProps?: boolean): UseComponentVersions;
+export declare const defaultLoadCurrentVersion: (props: VersionRelatedDropdownsProps) => UseComponentVersion;
+export declare function VersionRelatedDropdowns(props: VersionRelatedDropdownsProps): import("react/jsx-runtime").JSX.Element;

package/dist/ui/menu/nav-plugin.d.ts

@@ -0,0 +1,28 @@
+import { SlotRegistry } from '@teambit/harmony';
+import type { LinkProps } from '@teambit/base-react.navigation.link';
+import type { ConsumeMethod } from '@teambit/ui-foundation.ui.use-box.menu';
+import { LaneModel } from '@teambit/lanes.ui.models.lanes-model';
+import { ComponentID, ComponentModel } from '../..';
+export type NavPluginProps = {
+    displayName?: string;
+    ignoreQueryParams?: boolean;
+} & LinkProps;
+export type NavPlugin = {
+    props: NavPluginProps;
+    order?: number;
+};
+export type OrderedNavigationSlot = SlotRegistry<NavPlugin>;
+export type ConsumePluginOptions = {
+    viewedLane?: LaneModel;
+    hide?: boolean;
+    disableInstall?: boolean;
+};
+export type ConsumePluginProps = {
+    id: ComponentID;
+    packageName: string;
+    latest?: string;
+    componentModel?: ComponentModel;
+    options?: ConsumePluginOptions;
+};
+export type ConsumePlugin = (props: ConsumePluginProps) => ConsumeMethod | undefined;
+export type ConsumeMethodSlot = SlotRegistry<ConsumePlugin[]>;

package/dist/ui/top-bar-nav/index.d.ts

@@ -0,0 +1 @@
+export * from './top-bar-nav';

package/dist/ui/top-bar-nav/top-bar-nav.d.ts

@@ -0,0 +1,2 @@
+import { NavPluginProps } from '../menu/nav-plugin';
+export declare function TopBarNav({ href, className, activeClassName, children, displayName, ignoreQueryParams, ...rest }: NavPluginProps): import("react/jsx-runtime").JSX.Element;

package/dist/ui/use-component-from-location.d.ts

@@ -0,0 +1 @@
+export declare function useIdFromLocation(url?: string, deriveScopeFromSearchParams?: boolean): string | undefined;

package/dist/ui/use-component-logs.d.ts

@@ -0,0 +1,16 @@
+import { ComponentLogsResult, Filters } from './use-component.model';
+export declare function useComponentLogs(componentId: string, host: string, filters?: Filters, skipFromProps?: boolean): ComponentLogsResult;
+export declare function useComponentLogsInit(componentId: string, host: string, filters?: Filters, skip?: boolean): {
+    logOffset: number | undefined;
+    variables: {
+        id: string;
+        extensionId: string;
+        logOffset: any;
+        logLimit: number | undefined;
+        logType: string | undefined;
+        logHead: string | undefined;
+        logSort: string | undefined;
+        logTakeHeadFromComponent: boolean | undefined;
+    };
+    skip: boolean | undefined;
+};