@teambit/component 1.0.227 → 1.0.229

package/dist/show/files.fragment.d.ts

@@ -0,0 +1,14 @@
+import { ShowFragment } from './show-fragment';
+import { Component } from '../component';
+export declare class FilesFragment implements ShowFragment {
+    renderRow(component: Component): Promise<{
+        title: string;
+        content: string;
+    }>;
+    json(component: Component): Promise<{
+        title: string;
+        json: string[];
+    }>;
+    private getRelativePaths;
+    weight: number;
+}

package/dist/show/id.fragment.d.ts

@@ -0,0 +1,13 @@
+import { ShowFragment } from './show-fragment';
+import { Component } from '../component';
+export declare class IDFragment implements ShowFragment {
+    renderRow(component: Component): Promise<{
+        title: string;
+        content: string;
+    }>;
+    json(component: Component): Promise<{
+        title: string;
+        json: string;
+    }>;
+    weight: number;
+}

package/dist/show/index.d.ts

@@ -0,0 +1,8 @@
+export { ShowFragment, ShowRow, JSONRow as ShowJSONRow } from './show-fragment';
+export { ShowCmd } from './show.cmd';
+export { MainFileFragment } from './main-file.fragment';
+export { NameFragment } from './name.fragment';
+export { IDFragment } from './id.fragment';
+export { ScopeFragment } from './scope.fragment';
+export { FilesFragment } from './files.fragment';
+export { ExtensionsFragment } from './extensions.fragment';

package/dist/show/main-file.fragment.d.ts

@@ -0,0 +1,9 @@
+import { ShowFragment } from './show-fragment';
+import { Component } from '../component';
+export declare class MainFileFragment implements ShowFragment {
+    renderRow(component: Component): Promise<{
+        title: string;
+        content: any;
+    }>;
+    weight: number;
+}

package/dist/show/name.fragment.d.ts

@@ -0,0 +1,9 @@
+import { ShowFragment } from './show-fragment';
+import { Component } from '../component';
+export declare class NameFragment implements ShowFragment {
+    renderRow(component: Component): Promise<{
+        title: string;
+        content: string;
+    }>;
+    weight: number;
+}

package/dist/show/scope.fragment.d.ts

@@ -0,0 +1,10 @@
+import { ShowFragment } from './show-fragment';
+import { Component } from '../component';
+export declare class ScopeFragment implements ShowFragment {
+    renderRow(component: Component): Promise<{
+        title: string;
+        content: string;
+    }>;
+    getRow(): void;
+    weight: number;
+}

package/dist/show/show-fragment.d.ts

@@ -0,0 +1,37 @@
+import { Component } from '../component';
+export interface ShowFragment {
+    /**
+     * render a row into the `show` CLI.
+     */
+    renderRow(component: Component): Promise<ShowRow>;
+    /**
+     * return a json output.
+     */
+    json?(component: Component): Promise<JSONRow>;
+    /**
+     * weight is used to determine the position of the fragment
+     * within the `show` table.
+     */
+    weight?: number;
+}
+export interface JSONRow {
+    /**
+     * name of the field.
+     */
+    title: string;
+    /**
+     * json content.
+     * TODO: change this from any to a more structured type (e.g. Serializable).
+     */
+    json: any;
+}
+export interface ShowRow {
+    /**
+     * title of the fragment
+     */
+    title: string;
+    /**
+     * content to render within the fragment.
+     */
+    content: string;
+}

package/dist/show/show.cmd.d.ts

@@ -0,0 +1,26 @@
+import { Command, CommandOptions } from '@teambit/cli';
+import { ComponentMain } from '../component.main.runtime';
+export declare class ShowCmd implements Command {
+    private component;
+    name: string;
+    description: string;
+    alias: string;
+    group: string;
+    arguments: {
+        name: string;
+        description: string;
+    }[];
+    options: CommandOptions;
+    constructor(component: ComponentMain);
+    private getComponent;
+    useLegacy(id: string, json?: boolean, remote?: boolean, compare?: boolean): Promise<string>;
+    report([idStr]: [string], { legacy, remote, compare }: {
+        legacy: boolean;
+        remote: boolean;
+        compare: boolean;
+    }): Promise<string>;
+    json([idStr]: [string], { remote, legacy }: {
+        remote: boolean;
+        legacy: boolean;
+    }): Promise<any>;
+}

package/dist/snap/author.d.ts

@@ -0,0 +1,17 @@
+/**
+ * author type.
+ */
+export type Author = {
+    /**
+     * author full name (for example: "Ran Mizrahi")
+     */
+    displayName: string;
+    /**
+     * author username (for example: "ranm8")
+     */
+    name?: string;
+    /**
+     * author email in a proper format (e.g. "ran@bit.dev")
+     */
+    email: string;
+};

package/dist/snap/index.d.ts

@@ -0,0 +1,2 @@
+export { Author } from './author';
+export { Snap, SnapProps } from './snap';

package/dist/snap/snap.d.ts

@@ -0,0 +1,56 @@
+import { Author } from './author';
+export type SnapProps = {
+    hash: string;
+    timestamp: string;
+    parents: string[];
+    author: Author;
+    message: string;
+};
+/**
+ * `Snap` represents a sealed state of the component in the working tree.
+ */
+export declare class Snap {
+    /**
+     * hash of the snap.
+     */
+    readonly hash: string;
+    /**
+     * date time of the snap.
+     */
+    readonly timestamp: Date;
+    /**
+     * parent snap
+     */
+    readonly parents: string[];
+    /**
+     * author of the component `Snap`.
+     */
+    readonly author: Author;
+    /**
+     * message added by the `Snap` author.
+     */
+    readonly message: string;
+    constructor(
+    /**
+     * hash of the snap.
+     */
+    hash: string, 
+    /**
+     * date time of the snap.
+     */
+    timestamp: Date, 
+    /**
+     * parent snap
+     */
+    parents: string[], 
+    /**
+     * author of the component `Snap`.
+     */
+    author: Author, 
+    /**
+     * message added by the `Snap` author.
+     */
+    message: string);
+    static fromObject(snapObject: SnapProps): Snap;
+    toObject(): SnapProps;
+}

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;