@teambit/compositions 1.0.228 → 1.0.229

package/dist/composition.d.ts

@@ -0,0 +1,47 @@
+export type CompositionProps = {
+    identifier: string;
+    filepath?: string;
+    displayName?: string;
+};
+export type CompositionBrowserMetadata = {
+    displayName?: string;
+    identifier: string;
+};
+export type CompositionBrowserMetadataObject = {
+    compositions: CompositionBrowserMetadata[];
+};
+export declare class Composition {
+    /**
+     * identifier of the composition
+     */
+    readonly identifier: string;
+    /**
+     * file path in which the composition is contained.
+     */
+    readonly filepath?: string | undefined;
+    /**
+     * set explicit display name
+     */
+    private _displayName?;
+    constructor(
+    /**
+     * identifier of the composition
+     */
+    identifier: string, 
+    /**
+     * file path in which the composition is contained.
+     */
+    filepath?: string | undefined, 
+    /**
+     * set explicit display name
+     */
+    _displayName?: string | undefined);
+    get displayName(): string;
+    toObject(): {
+        identifier: string;
+        filepath: string | undefined;
+        displayName: string | undefined;
+    };
+    toBrowserMetaDataObject(): CompositionBrowserMetadata;
+    static fromArray(compositions: CompositionProps[]): Composition[];
+}

package/dist/composition.section.d.ts

@@ -0,0 +1,28 @@
+import { Section } from '@teambit/component';
+import type { CompositionsUI, CompositionsMenuSlot, EmptyStateSlot } from './compositions.ui.runtime';
+type Options = {
+    menuBarWidgetSlot: CompositionsMenuSlot;
+};
+export declare class CompositionsSection implements Section {
+    /**
+     * simulations ui extension.
+     */
+    private compositions;
+    private options;
+    private emptyStateSlot;
+    constructor(
+    /**
+     * simulations ui extension.
+     */
+    compositions: CompositionsUI, options: Options, emptyStateSlot: EmptyStateSlot);
+    navigationLink: {
+        href: string;
+        children: string;
+    };
+    route: {
+        path: string;
+        element: import("react/jsx-runtime").JSX.Element;
+    };
+    order: number;
+}
+export {};

package/dist/compositions.aspect.d.ts

@@ -0,0 +1,3 @@
+import { Aspect } from '@teambit/harmony';
+export declare const CompositionsAspect: Aspect;
+export default CompositionsAspect;

package/dist/compositions.composition.d.ts

@@ -0,0 +1 @@
+export declare const Logo: () => import("react/jsx-runtime").JSX.Element;

package/dist/compositions.d.ts

@@ -0,0 +1,22 @@
+import { ReactNode } from 'react';
+import { ComponentModel } from '@teambit/component';
+import { EmptyStateSlot } from './compositions.ui.runtime';
+import { Composition } from './composition';
+import type { CompositionsMenuSlot } from './compositions.ui.runtime';
+import { ComponentCompositionProps } from './ui/composition-preview';
+export type MenuBarWidget = {
+    location: 'start' | 'end';
+    content: ReactNode;
+};
+export type CompositionsProp = {
+    menuBarWidgets?: CompositionsMenuSlot;
+    emptyState?: EmptyStateSlot;
+};
+export declare function Compositions({ menuBarWidgets, emptyState }: CompositionsProp): import("react/jsx-runtime").JSX.Element;
+export type CompositionContentProps = {
+    component: ComponentModel;
+    selected?: Composition;
+    queryParams?: string | string[];
+    emptyState?: EmptyStateSlot;
+} & ComponentCompositionProps;
+export declare function CompositionContent({ component, selected, queryParams, emptyState, ...componentCompositionProps }: CompositionContentProps): import("react/jsx-runtime").JSX.Element;

package/dist/compositions.graphql.d.ts

@@ -0,0 +1,3 @@
+import { Schema } from '@teambit/graphql';
+import { CompositionsMain } from './compositions.main.runtime';
+export declare function compositionsSchema(compositions: CompositionsMain): Schema;

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

@@ -0,0 +1,110 @@
+import { AspectData, Component, ComponentMap, IComponent } from '@teambit/component';
+import { ScopeMain } from '@teambit/scope';
+import { DevFilesMain } from '@teambit/dev-files';
+import { EnvsMain } from '@teambit/envs';
+import { GraphqlMain } from '@teambit/graphql';
+import { ComponentLoadOptions } from '@teambit/legacy/dist/consumer/component/component-loader';
+import { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';
+import { PreviewMain } from '@teambit/preview';
+import { SchemaMain } from '@teambit/schema';
+import { Workspace } from '@teambit/workspace';
+import { Composition } from './composition';
+export type CompositionsConfig = {
+    /**
+     * glob pattern to detect composition files. This includes all related files, like styles and jsons.
+     * @example ['/*.composition?(s).*']
+     */
+    compositionFilePattern: string[];
+    /**
+     * glob pattern to select Preview files. this will only include files matched by compositionFilePattern.
+     * @example ['*.{t,j}s', '*.{t,j}sx']
+     */
+    compositionPreviewFilePattern: string[];
+};
+/**
+ * the component documentation extension.
+ */
+export declare class CompositionsMain {
+    /**
+     * Glob pattern to select all composition files
+     */
+    private compositionFilePattern;
+    /**
+     * Glob pattern to select composition preview files
+     */
+    private previewFilePattern;
+    /**
+     * envs extension.
+     */
+    private preview;
+    /**
+     * workspace extension.
+     */
+    private workspace;
+    /**
+     * schema extension.
+     */
+    private schema;
+    private devFiles;
+    private envs;
+    constructor(
+    /**
+     * Glob pattern to select all composition files
+     */
+    compositionFilePattern: string[], 
+    /**
+     * Glob pattern to select composition preview files
+     */
+    previewFilePattern: string[], 
+    /**
+     * envs extension.
+     */
+    preview: PreviewMain, 
+    /**
+     * workspace extension.
+     */
+    workspace: Workspace, 
+    /**
+     * schema extension.
+     */
+    schema: SchemaMain, devFiles: DevFilesMain, envs: EnvsMain);
+    /**
+     * returns an array of doc file paths for a set of components.
+     */
+    getPreviewFiles(components: Component[]): ComponentMap<AbstractVinyl[]>;
+    /**
+     * checks if a file matches the composition file pattern.
+     */
+    isCompositionFile(filePath: string): boolean;
+    /**
+     * get component compositions.
+     */
+    getCompositions(component: IComponent): Composition[];
+    /**
+     * read composition from the component source code.
+     */
+    readCompositions(component: Component): Composition[];
+    getCompositionFilePattern(): string[];
+    getComponentDevPatterns(component: Component): {
+        name: string;
+        pattern: string[];
+    };
+    getDevPatternToRegister(): (component: Component) => {
+        name: string;
+        pattern: string[];
+    };
+    onComponentLoad(component: Component, loadOpts?: ComponentLoadOptions): Promise<AspectData | undefined>;
+    private computeCompositions;
+    static defaultConfig: CompositionsConfig;
+    static runtime: import("@teambit/harmony").RuntimeDefinition;
+    static dependencies: import("@teambit/harmony").Aspect[];
+    static provider([preview, graphql, workspace, schema, devFiles, envs, scope]: [
+        PreviewMain,
+        GraphqlMain,
+        Workspace,
+        SchemaMain,
+        DevFilesMain,
+        EnvsMain,
+        ScopeMain
+    ], config: CompositionsConfig): Promise<CompositionsMain>;
+}

package/dist/compositions.preview-definition.d.ts

@@ -0,0 +1,16 @@
+import { Component, ComponentMap } from '@teambit/component';
+import type { ExecutionContext, Environment } from '@teambit/envs';
+import { PreviewDefinition } from '@teambit/preview';
+import { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';
+import { CompositionsMain } from './compositions.main.runtime';
+import { CompositionBrowserMetadataObject } from './composition';
+export declare class CompositionPreviewDefinition implements PreviewDefinition {
+    private compositions;
+    readonly prefix = "compositions";
+    readonly includePeers = true;
+    constructor(compositions: CompositionsMain);
+    renderTemplatePath(context: ExecutionContext): Promise<string | undefined>;
+    renderTemplatePathByEnv(env: Environment): Promise<string | undefined>;
+    getModuleMap(components: Component[]): Promise<ComponentMap<AbstractVinyl[]>>;
+    getMetadata(component: Component): Promise<CompositionBrowserMetadataObject>;
+}

package/dist/compositions.preview.runtime.d.ts

@@ -0,0 +1,22 @@
+import { ComponentID } from '@teambit/component-id';
+import { PreviewPreview, RenderingContext, PreviewModule } from '@teambit/preview';
+import { CompositionBrowserMetadataObject } from './composition';
+export declare class CompositionsPreview {
+    /**
+     * preview extension.
+     */
+    private preview;
+    constructor(
+    /**
+     * preview extension.
+     */
+    preview: PreviewPreview);
+    render(componentId: ComponentID, envId: string, modules: PreviewModule, otherPreviewDefs: any, context: RenderingContext): void;
+    /** gets relevant information for this preview to render */
+    selectPreviewModel(componentFullName: string, previewModule: PreviewModule): any;
+    getMetadata(componentFullName: string, previewModule: PreviewModule): CompositionBrowserMetadataObject | undefined;
+    private getActiveComposition;
+    static runtime: import("@teambit/harmony").RuntimeDefinition;
+    static dependencies: import("@teambit/harmony").Aspect[];
+    static provider([preview]: [PreviewPreview]): Promise<CompositionsPreview>;
+}

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

@@ -0,0 +1,24 @@
+import type { ReactNode } from 'react';
+import { ComponentType } from 'react';
+import { SlotRegistry } from '@teambit/harmony';
+import { ComponentUI } from '@teambit/component';
+import { ComponentCompareUI } from '@teambit/component-compare';
+import { MenuBarWidget } from './compositions';
+export type CompositionsMenuSlot = SlotRegistry<MenuBarWidget[]>;
+export type EmptyStateSlot = SlotRegistry<ComponentType>;
+export declare class CompositionsUI {
+    private menuBarWidgetSlot;
+    private emptyStateSlot;
+    constructor(menuBarWidgetSlot: CompositionsMenuSlot, emptyStateSlot: EmptyStateSlot);
+    /**
+     * register a new tester empty state. this allows to register a different empty state from each environment for example.
+     */
+    registerEmptyState(emptyStateComponent: ComponentType): this;
+    registerMenuWidget(...widget: MenuBarWidget[]): void;
+    getCompositionsCompare: () => import("react/jsx-runtime").JSX.Element;
+    static dependencies: import("@teambit/harmony").Aspect[];
+    static runtime: import("@teambit/harmony").RuntimeDefinition;
+    static slots: ((registerFn: () => string) => SlotRegistry<ReactNode>)[];
+    static provider([component, componentCompare]: [ComponentUI, ComponentCompareUI], config: {}, [compositionMenuSlot, emptyStateSlot]: [CompositionsMenuSlot, EmptyStateSlot]): Promise<CompositionsUI>;
+}
+export default CompositionsUI;

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+import { CompositionsAspect } from './compositions.aspect';
+export { CompositionsAspect };
+export type { CompositionsMain } from './compositions.main.runtime';
+export type { CompositionsUI, CompositionsMenuSlot, EmptyStateSlot } from './compositions.ui.runtime';
+export type { CompositionProps } from './composition';
+export { Composition } from './composition';
+export type { CompositionContentProps } from './compositions';
+export { CompositionContent } from './compositions';
+export type { CompositionsPreview } from './compositions.preview.runtime';
+export { ComponentComposition } from './ui';
+export default CompositionsAspect;

package/dist/{preview-1712805335812.js → preview-1712822929999.js}

@@ -1,5 +1,5 @@
-import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.compositions_compositions@1.0.228/dist/compositions.composition.js';
-import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.compositions_compositions@1.0.228/dist/compositions.docs.mdx';
+import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.compositions_compositions@1.0.229/dist/compositions.composition.js';
+import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.compositions_compositions@1.0.229/dist/compositions.docs.mdx';
 
 export const compositions = [compositions_0];
 export const overview = [overview_0];

package/dist/ui/composition-preview.d.ts

@@ -0,0 +1,9 @@
+import { ComponentPreviewProps } from '@teambit/preview.ui.component-preview';
+import { Composition } from '../composition';
+export type ComponentCompositionProps = {
+    /**
+     * composition to use for component rendering.
+     */
+    composition?: Composition;
+} & ComponentPreviewProps;
+export declare function ComponentComposition({ composition, component, queryParams, ...rest }: ComponentCompositionProps): import("react/jsx-runtime").JSX.Element;

package/dist/ui/compositions-panel/compositions-panel.d.ts

@@ -0,0 +1,27 @@
+import React from 'react';
+import { Composition } from '../../composition';
+export type CompositionsPanelProps = {
+    /**
+     * list of compositions
+     */
+    compositions: Composition[];
+    /**
+     * select composition to display
+     */
+    onSelectComposition: (composition: Composition) => void;
+    /**
+     * the currently active composition
+     */
+    active?: Composition;
+    /**
+     * the url to the base composition. doesntc contain the current composition params
+     */
+    url: string;
+    /**
+     * checks if a component is using the new preview api. if false, doesnt scale to support new preview
+     */
+    isScaling?: boolean;
+    includesEnvTemplate?: boolean;
+    useNameParam?: boolean;
+} & React.HTMLAttributes<HTMLUListElement>;
+export declare function CompositionsPanel({ url, compositions, isScaling, onSelectComposition: onSelect, active, includesEnvTemplate, useNameParam, className, ...rest }: CompositionsPanelProps): import("react/jsx-runtime").JSX.Element;

package/dist/ui/compositions-panel-node/compositions-panel-node.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+export type CompositionsPanelNodeProps = {
+    name: string;
+    onClick: (event: React.MouseEvent<HTMLAnchorElement>) => void;
+    isActive: boolean;
+} & React.HTMLAttributes<HTMLLIElement>;
+export declare function CompositionsPanelNode({ name, onClick, isActive, ...rest }: CompositionsPanelNodeProps): import("react/jsx-runtime").JSX.Element;

package/dist/ui/compositions-panel-node/index.d.ts

@@ -0,0 +1 @@
+export * from './compositions-panel-node';

package/dist/ui/index.d.ts

@@ -0,0 +1 @@
+export { ComponentComposition } from './composition-preview';

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/compositions",
-  "version": "1.0.228",
+  "version": "1.0.229",
   "homepage": "https://bit.cloud/teambit/compositions/compositions",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.compositions",
     "name": "compositions",
-    "version": "1.0.228"
+    "version": "1.0.229"
   },
   "dependencies": {
     "graphql-tag": "2.12.1",
@@ -34,23 +34,23 @@
     "@teambit/compositions.ui.composition-compare": "0.0.255",
     "@teambit/evangelist.elements.icon": "1.0.2",
     "@teambit/ui-foundation.ui.menu-widget-icon": "0.0.502",
-    "@teambit/component": "1.0.228",
+    "@teambit/component": "1.0.229",
     "@teambit/compositions.model.composition-id": "0.0.502",
-    "@teambit/graphql": "1.0.228",
-    "@teambit/cli": "0.0.861",
-    "@teambit/dev-files": "1.0.228",
-    "@teambit/envs": "1.0.228",
-    "@teambit/preview": "1.0.228",
-    "@teambit/schema": "1.0.228",
-    "@teambit/scope": "1.0.228",
+    "@teambit/graphql": "1.0.229",
+    "@teambit/cli": "0.0.862",
+    "@teambit/dev-files": "1.0.229",
+    "@teambit/envs": "1.0.229",
+    "@teambit/preview": "1.0.229",
+    "@teambit/schema": "1.0.229",
+    "@teambit/scope": "1.0.229",
     "@teambit/toolbox.path.match-patterns": "0.0.15",
-    "@teambit/workspace": "1.0.228",
+    "@teambit/workspace": "1.0.229",
     "@teambit/docs.ui.queries.get-docs": "0.0.508",
-    "@teambit/panels": "0.0.863",
+    "@teambit/panels": "0.0.864",
     "@teambit/preview.ui.component-preview": "1.0.5",
     "@teambit/ui-foundation.ui.buttons.collapser": "0.0.219",
-    "@teambit/component-compare": "1.0.228",
-    "@teambit/ui": "1.0.228"
+    "@teambit/component-compare": "1.0.229",
+    "@teambit/ui": "1.0.229"
   },
   "devDependencies": {
     "@types/lodash": "4.14.165",
@@ -59,7 +59,7 @@
     "@types/mocha": "9.1.0",
     "chai": "4.3.0",
     "@teambit/component-id": "1.2.0",
-    "@teambit/harmony.envs.core-aspect-env": "0.0.30",
+    "@teambit/harmony.envs.core-aspect-env": "0.0.33",
     "@teambit/compositions.aspect-docs.compositions": "0.0.167"
   },
   "peerDependencies": {

package/tsconfig.json

@@ -20,8 +20,7 @@
     "emitDeclarationOnly": true,
     "strict": true,
     "strictPropertyInitialization": false,
-    "noImplicitAny": false,
-    "composite": true
+    "noImplicitAny": false
   },
   "exclude": [
     "artifacts",
@@ -36,43 +35,5 @@
   "include": [
     "**/*",
     "**/*.json"
-  ],
-  "references": [
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_component@1.0.228"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_graphql@1.0.228"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_cli@0.0.861"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_dev-files@1.0.228"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.envs_envs@1.0.228"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.preview_preview@1.0.228"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.semantics_schema@1.0.228"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.scope_scope@1.0.228"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.workspace_workspace@1.0.228"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.ui-foundation_panels@0.0.863"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.component_component-compare@1.0.228"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.ui-foundation_ui@1.0.228"
-    }
   ]
 }