@teambit/scope 1.0.227 → 1.0.229

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

@@ -0,0 +1,210 @@
+import type { ComponentUI, ComponentModel } from '@teambit/component';
+import { SlotRegistry } from '@teambit/harmony';
+import type { RouteSlot } from '@teambit/ui-foundation.ui.react-router.slot-router';
+import { SidebarUI, SidebarItem, SidebarItemSlot } from '@teambit/sidebar';
+import { ComponentTreeNode } from '@teambit/component-tree';
+import { UIRootUI as UIRoot, UiUI } from '@teambit/ui';
+import React, { ComponentType, ReactNode } from 'react';
+import { MenuItemSlot, MenuItem } from '@teambit/ui-foundation.ui.main-dropdown';
+import { RouteProps } from 'react-router-dom';
+import { MenuWidget, MenuWidgetSlot } from '@teambit/ui-foundation.ui.menu';
+import { CommandBarUI } from '@teambit/command-bar';
+import { ScopeModel } from '@teambit/scope.models.scope-model';
+import { DrawerType } from '@teambit/ui-foundation.ui.tree.drawer';
+import { LanesModel } from '@teambit/lanes.ui.models.lanes-model';
+import { DrawerWidgetSlot, ComponentFiltersSlot } from '@teambit/component.ui.component-drawer';
+import { ComponentFilters } from '@teambit/component.ui.component-filters.component-filter-context';
+import { ComponentUrlResolver } from '@teambit/component.modules.component-url';
+import { GetScopeOptions } from './get-scope-options';
+export type ScopeBadge = ComponentType;
+export type ScopeBadgeSlot = SlotRegistry<ScopeBadge[]>;
+export type ContextSlot = SlotRegistry<ScopeContextType[]>;
+export type ScopeContextType = ComponentType<{
+    scope: ScopeModel;
+    children: ReactNode;
+}>;
+export type SidebarSlot = SlotRegistry<ComponentTreeNode>;
+export type ScopeOverview = ComponentType;
+export type ScopeOverviewSlot = SlotRegistry<ScopeOverview>;
+export type Corner = ComponentType;
+export type CornerSlot = SlotRegistry<Corner>;
+export type OverviewLine = ComponentType;
+export type OverviewLineSlot = SlotRegistry<OverviewLine[]>;
+export type ScopeUIConfig = {
+    showGallery: boolean;
+    useBoxAction?: string;
+    useBoxIcon?: string;
+};
+export declare class ScopeUI {
+    /**
+     * route slot.
+     */
+    private routeSlot;
+    /**
+     * component ui extension.
+     */
+    private componentUi;
+    /**
+     * menu slot
+     */
+    private menuSlot;
+    private sidebar;
+    private sidebarSlot;
+    private commandBarUI;
+    private scopeBadgeSlot;
+    private menuWidgetSlot;
+    /**
+     * sidebar link slot
+     */
+    private sidebarItemSlot;
+    /**
+     * main dropdown item slot
+     */
+    private menuItemSlot;
+    /**
+     * corner slot
+     */
+    private cornerSlot;
+    /**
+     * overview line slot to add new lines beneath the overview section
+     */
+    private overviewSlot;
+    /**
+     * add a new context to ui
+     */
+    private contextSlot;
+    private drawerWidgetSlot;
+    private drawerComponentsFiltersSlot;
+    constructor(
+    /**
+     * route slot.
+     */
+    routeSlot: RouteSlot, 
+    /**
+     * component ui extension.
+     */
+    componentUi: ComponentUI, 
+    /**
+     * menu slot
+     */
+    menuSlot: RouteSlot, sidebar: SidebarUI, sidebarSlot: SidebarSlot, commandBarUI: CommandBarUI, scopeBadgeSlot: ScopeBadgeSlot, menuWidgetSlot: MenuWidgetSlot, 
+    /**
+     * sidebar link slot
+     */
+    sidebarItemSlot: SidebarItemSlot, 
+    /**
+     * main dropdown item slot
+     */
+    menuItemSlot: MenuItemSlot, 
+    /**
+     * corner slot
+     */
+    cornerSlot: CornerSlot, 
+    /**
+     * overview line slot to add new lines beneath the overview section
+     */
+    overviewSlot: OverviewLineSlot, 
+    /**
+     * add a new context to ui
+     */
+    contextSlot: ContextSlot, drawerWidgetSlot: DrawerWidgetSlot, drawerComponentsFiltersSlot: ComponentFiltersSlot);
+    private setSidebarToggle;
+    /**
+     * register a new badge into the scope overview.
+     */
+    registerBadge(...badges: ScopeBadge[]): this;
+    getScope(options: GetScopeOptions): import("react/jsx-runtime").JSX.Element;
+    /**
+     * register a new line beneath the scope overview section.
+     */
+    registerOverviewLine(...lines: OverviewLine[]): this;
+    /**
+     * register a route to the scope.
+     */
+    registerRoutes(routes: RouteProps[]): this;
+    registerMenuRoutes: (routes: RouteProps[]) => this;
+    private applyMenuRoutes;
+    getScopeMenu(): import("react/jsx-runtime").JSX.Element;
+    private registerExplicitRoutes;
+    registerMenuWidget(...menuItems: MenuWidget[]): void;
+    registerCorner(corner: Corner): void;
+    private componentUrlFunc;
+    registerComponentUrl(func: ComponentUrlResolver): void;
+    /**
+     * register a scope overview.
+     */
+    replaceOverview(): void;
+    /**
+     * register description.
+     */
+    replaceDescription(): void;
+    /**
+     * register metadata section.
+     */
+    replaceMetadataSection(): void;
+    /**
+     * register a metadata item.
+     */
+    registerMetadataItem(): void;
+    replaceComponentGrid(): void;
+    /**
+     * register metadata.
+     */
+    registerMetadata(): void;
+    /**
+     * add a new context to the scope.
+     */
+    addContext(...context: ScopeContextType[]): this;
+    private getContext;
+    registerMenuItem: (menuItems: MenuItem[]) => void;
+    /**
+     * register a sidebar Widget for the scope
+     */
+    registerSidebarWidget: (componentTreeNodes: ComponentTreeNode[]) => this;
+    /**
+     * register a sidebar link to the section above the drawers
+     */
+    registerSidebarLink: (...links: SidebarItem[]) => void;
+    registerDrawers: (...drawer: DrawerType[]) => this;
+    /**
+     * register component filters
+     */
+    registerDrawerComponentFilters: (filters: ComponentFilters) => void;
+    registerDrawerWidgets: (widgets: ReactNode[]) => void;
+    registerDefaultDrawers(assumeScopeInUrl?: boolean, overrideUseComponents?: () => {
+        components: ComponentModel[];
+    }, overrideUseLanes?: () => {
+        lanesModel: LanesModel;
+    }): void;
+    getDefaultDrawer(assumeScopeInUrl?: boolean, overrideUseComponents?: () => {
+        components: ComponentModel[];
+    }, overrideUseLanes?: () => {
+        lanesModel: LanesModel;
+    }): import("@teambit/component.ui.component-drawer").ComponentsDrawer;
+    uiRoot(): UIRoot;
+    listSidebarLinks(): (React.ComponentClass<{}, any> | React.FunctionComponent<{}>)[];
+    /** registers available components */
+    setComponents: (components: ComponentModel[]) => void;
+    private menuItems;
+    static dependencies: import("@teambit/harmony").Aspect[];
+    static runtime: import("@teambit/harmony").RuntimeDefinition;
+    static slots: (((registerFn: () => string) => SlotRegistry<RouteProps>) | ((registerFn: () => string) => SlotRegistry<ComponentTreeNode>) | ((registerFn: () => string) => SlotRegistry<DrawerWidgetSlot>) | ((registerFn: () => string) => SlotRegistry<ScopeBadge>) | ((registerFn: () => string) => SlotRegistry<MenuWidget[]>) | ((registerFn: () => string) => SlotRegistry<CornerSlot>))[];
+    static defaultConfig: {
+        showGallery: boolean;
+    };
+    static provider([ui, componentUi, sidebar, commandBarUI]: [UiUI, ComponentUI, SidebarUI, CommandBarUI], config: ScopeUIConfig, [routeSlot, menuSlot, sidebarSlot, scopeBadgeSlot, menuWidgetSlot, menuItemSlot, sidebarItemSlot, cornerSlot, overviewSlot, contextSlot, drawerWidgetSlot, componentFiltersSlot,]: [
+        RouteSlot,
+        RouteSlot,
+        SidebarSlot,
+        ScopeBadgeSlot,
+        MenuWidgetSlot,
+        MenuItemSlot,
+        SidebarItemSlot,
+        CornerSlot,
+        OverviewLineSlot,
+        ContextSlot,
+        DrawerWidgetSlot,
+        ComponentFiltersSlot
+    ]): Promise<ScopeUI>;
+}
+export default ScopeUI;

package/dist/staged-config.d.ts

@@ -0,0 +1,29 @@
+import { ComponentID, ComponentIdObj } from '@teambit/component-id';
+import { LaneId } from '@teambit/lane-id';
+import { Logger } from '@teambit/logger';
+type Config = Record<string, any> | undefined;
+type ComponentConfig = {
+    id: ComponentID;
+    config: Config;
+};
+type ComponentConfigObj = {
+    id: ComponentIdObj;
+    config: Config;
+};
+export declare class StagedConfig {
+    readonly filePath: string;
+    private componentsConfig;
+    private logger;
+    hasChanged: boolean;
+    constructor(filePath: string, componentsConfig: ComponentConfig[], logger: Logger);
+    static load(scopePath: string, logger: Logger, laneId?: LaneId): Promise<StagedConfig>;
+    toObject(): ComponentConfigObj[];
+    write(): Promise<void>;
+    getConfigPerId(id: ComponentID): Config;
+    getAll(): ComponentConfig[];
+    isEmpty(): boolean;
+    deleteFile(): Promise<void>;
+    addComponentConfig(id: ComponentID, config: Config): void;
+    removeComponentConfig(id: ComponentID): void;
+}
+export {};

package/dist/types.d.ts

@@ -0,0 +1,10 @@
+export type Serializable = {
+    toString(): string;
+};
+export type Metadata = {
+    [key: string]: Serializable;
+};
+export type DataToPersist = {
+    metadata: Metadata;
+    files: string[];
+};

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

@@ -0,0 +1 @@
+export { ScopeMenu, ScopeUseBox } from './menu';

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

@@ -0,0 +1,10 @@
+import { MenuProps } from '@teambit/ui-foundation.ui.menu';
+/**
+ * scope menu.
+ */
+export declare function ScopeMenu({ className, ...rest }: MenuProps): import("react/jsx-runtime").JSX.Element;
+export type ScopeUseBoxProps = {
+    actionName?: string;
+    actionIcon?: string;
+};
+export declare function ScopeUseBox({ actionName, actionIcon }: ScopeUseBoxProps): import("react/jsx-runtime").JSX.Element;

package/dist/ui/scope-overview/index.d.ts

@@ -0,0 +1 @@
+export * from './scope-overview';

package/dist/ui/scope-overview/scope-overview.d.ts

@@ -0,0 +1,31 @@
+import { ComponentType } from 'react';
+import { ScopeID } from '@teambit/scopes.scope-id';
+import { type ComponentCardPluginType, type PluginProps } from '@teambit/explorer.ui.component-card';
+import { ComponentModel } from '@teambit/component';
+import { ComponentDescriptor } from '@teambit/component-descriptor';
+import type { ScopeBadgeSlot, OverviewLineSlot } from '../../scope.ui.runtime';
+export type ScopeOverviewProps = {
+    badgeSlot: ScopeBadgeSlot;
+    overviewSlot: OverviewLineSlot;
+    TargetOverview?: ComponentType;
+};
+export declare class LinkPlugin {
+    link(id: any): any;
+}
+export declare function ScopeOverview({ badgeSlot, overviewSlot, TargetOverview }: ScopeOverviewProps): import("react/jsx-runtime").JSX.Element;
+type ScopeComponentCardProps = {
+    component?: ComponentModel;
+    componentDescriptor?: ComponentDescriptor;
+    plugins?: ComponentCardPluginType<PluginProps>[];
+    scope?: {
+        icon?: string;
+        backgroundIconColor?: string;
+        id: ScopeID;
+    };
+    componentUrl?: string;
+};
+export declare function ScopeComponentCard({ componentDescriptor, plugins }: ScopeComponentCardProps): import("react/jsx-runtime").JSX.Element | null;
+export declare function useCardPlugins({ compModelsById, }: {
+    compModelsById: Map<string, ComponentModel>;
+}): ComponentCardPluginType<PluginProps>[];
+export {};

package/dist/ui/scope.d.ts

@@ -0,0 +1,30 @@
+import { ComponentType, ReactNode } from 'react';
+import 'reset-css';
+import type { RouteSlot } from '@teambit/ui-foundation.ui.react-router.slot-router';
+import type { ScopeModel } from '@teambit/scope.models.scope-model';
+import { ScopeUI, ScopeBadgeSlot, ScopeContextType, CornerSlot, OverviewLineSlot } from '../scope.ui.runtime';
+export type ScopeProps = {
+    routeSlot: RouteSlot;
+    menuSlot: RouteSlot;
+    sidebar: JSX.Element;
+    scopeUi: ScopeUI;
+    badgeSlot: ScopeBadgeSlot;
+    overviewLineSlot: OverviewLineSlot;
+    cornerSlot: CornerSlot;
+    context: ScopeContextType[];
+    TargetScopeOverview?: ComponentType;
+    userUseScopeQuery?: () => {
+        scope: ScopeModel | undefined;
+    };
+    onSidebarTogglerChange: (callback: () => void) => void;
+    TargetCorner?: ComponentType;
+    paneClassName?: string;
+    scopeClassName?: string;
+    PaneWrapper?: ComponentType<{
+        children: ReactNode;
+    }>;
+};
+/**
+ * root component of the scope
+ */
+export declare function Scope({ routeSlot, menuSlot, sidebar, scopeUi, badgeSlot, overviewLineSlot, cornerSlot, PaneWrapper, context, paneClassName, TargetScopeOverview, TargetCorner, onSidebarTogglerChange, userUseScopeQuery, scopeClassName, }: ScopeProps): import("react/jsx-runtime").JSX.Element;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/scope",
-  "version": "1.0.227",
+  "version": "1.0.229",
   "homepage": "https://bit.cloud/teambit/scope/scope",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.scope",
     "name": "scope",
-    "version": "1.0.227"
+    "version": "1.0.229"
   },
   "dependencies": {
     "fs-extra": "10.0.0",
@@ -50,39 +50,39 @@
     "@teambit/scope.ui.scope-details": "0.0.526",
     "@teambit/scopes.scope-id": "0.0.7",
     "@teambit/component.modules.component-url": "0.0.167",
-    "@teambit/scope.models.scope-model": "0.0.507",
-    "@teambit/scope.ui.hooks.scope-context": "0.0.501",
-    "@teambit/aspect-loader": "1.0.227",
-    "@teambit/cli": "0.0.860",
-    "@teambit/compiler": "1.0.227",
-    "@teambit/component": "1.0.227",
-    "@teambit/dependency-resolver": "1.0.227",
-    "@teambit/envs": "1.0.227",
-    "@teambit/global-config": "0.0.863",
+    "@teambit/scope.models.scope-model": "0.0.508",
+    "@teambit/scope.ui.hooks.scope-context": "0.0.502",
+    "@teambit/aspect-loader": "1.0.229",
+    "@teambit/cli": "0.0.862",
+    "@teambit/compiler": "1.0.229",
+    "@teambit/component": "1.0.229",
+    "@teambit/dependency-resolver": "1.0.229",
+    "@teambit/envs": "1.0.229",
+    "@teambit/global-config": "0.0.865",
     "@teambit/harmony.modules.requireable-component": "0.0.497",
-    "@teambit/isolator": "1.0.227",
-    "@teambit/logger": "0.0.953",
-    "@teambit/builder": "1.0.227",
-    "@teambit/express": "0.0.959",
-    "@teambit/graph": "1.0.227",
-    "@teambit/graphql": "1.0.227",
-    "@teambit/ui": "1.0.227",
+    "@teambit/isolator": "1.0.229",
+    "@teambit/logger": "0.0.955",
+    "@teambit/builder": "1.0.229",
+    "@teambit/express": "0.0.961",
+    "@teambit/graph": "1.0.229",
+    "@teambit/graphql": "1.0.229",
+    "@teambit/ui": "1.0.229",
     "@teambit/workspace.modules.match-pattern": "0.0.505",
-    "@teambit/component.ui.component-drawer": "0.0.398",
-    "@teambit/lanes.hooks.use-lane-components": "0.0.261",
+    "@teambit/component.ui.component-drawer": "0.0.399",
+    "@teambit/lanes.hooks.use-lane-components": "0.0.262",
     "@teambit/lanes.hooks.use-lanes": "0.0.264",
     "@teambit/lanes.ui.models.lanes-model": "0.0.216",
-    "@teambit/command-bar": "1.0.227",
-    "@teambit/component-tree": "1.0.227",
+    "@teambit/command-bar": "1.0.229",
+    "@teambit/component-tree": "1.0.229",
     "@teambit/component.ui.component-filters.component-filter-context": "0.0.222",
     "@teambit/component.ui.component-filters.deprecate-filter": "0.0.220",
     "@teambit/component.ui.component-filters.env-filter": "0.0.228",
     "@teambit/component.ui.component-filters.show-main-filter": "0.0.213",
-    "@teambit/sidebar": "1.0.227",
+    "@teambit/sidebar": "1.0.229",
     "@teambit/ui-foundation.ui.react-router.slot-router": "0.0.508",
     "@teambit/ui-foundation.ui.buttons.collapser": "0.0.219",
-    "@teambit/component-descriptor": "0.0.418",
-    "@teambit/preview.ui.preview-placeholder": "0.0.517"
+    "@teambit/component-descriptor": "0.0.419",
+    "@teambit/preview.ui.preview-placeholder": "0.0.518"
   },
   "devDependencies": {
     "@types/fs-extra": "9.0.7",
@@ -92,7 +92,7 @@
     "@types/mocha": "9.1.0",
     "chai": "4.3.0",
     "@teambit/scope.content.scope-overview": "1.95.0",
-    "@teambit/harmony.envs.core-aspect-env": "0.0.30"
+    "@teambit/harmony.envs.core-aspect-env": "0.0.33"
   },
   "peerDependencies": {
     "react": "^17.0.0 || ^18.0.0",

package/tsconfig.json

@@ -20,8 +20,7 @@
     "emitDeclarationOnly": true,
     "strict": true,
     "strictPropertyInitialization": false,
-    "noImplicitAny": false,
-    "composite": true
+    "noImplicitAny": false
   },
   "exclude": [
     "artifacts",
@@ -36,58 +35,5 @@
   "include": [
     "**/*",
     "**/*.json"
-  ],
-  "references": [
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_aspect-loader@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_cli@0.0.860"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.compilation_compiler@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_component@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.envs_envs@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_global-config@0.0.863"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_isolator@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_logger@0.0.953"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.pipelines_builder@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_express@0.0.959"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_graph@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_graphql@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.ui-foundation_ui@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.explorer_command-bar@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_component-tree@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.ui-foundation_sidebar@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_component-descriptor@0.0.418"
-    }
   ]
 }