@teambit/compositions 0.0.555 → 0.0.559

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "@teambit/compositions",
3
- "version": "0.0.555",
3
+ "version": "0.0.559",
4
4
  "homepage": "https://bit.dev/teambit/compositions/compositions",
5
5
  "main": "dist/index.js",
6
6
  "componentId": {
7
7
  "scope": "teambit.compositions",
8
8
  "name": "compositions",
9
- "version": "0.0.555"
9
+ "version": "0.0.559"
10
10
  },
11
11
  "dependencies": {
12
12
  "@teambit/harmony": "0.2.11",
@@ -23,32 +23,32 @@
23
23
  "@teambit/documenter.ui.heading": "4.1.1",
24
24
  "@teambit/documenter.ui.property-table": "4.1.3",
25
25
  "@teambit/evangelist.elements.icon": "1.0.2",
26
- "@teambit/component": "0.0.555",
27
- "@teambit/compositions.model.composition-id": "0.0.463",
28
- "@teambit/graphql": "0.0.555",
29
- "@teambit/cli": "0.0.386",
30
- "@teambit/dev-files": "0.0.555",
31
- "@teambit/preview": "0.0.555",
32
- "@teambit/schema": "0.0.555",
33
- "@teambit/workspace": "0.0.555",
34
- "@teambit/ui-foundation.ui.constants.z-indexes": "0.0.463",
35
- "@teambit/envs": "0.0.555",
36
- "@teambit/compositions.ui.compositions-menu-bar": "0.0.140",
37
- "@teambit/compositions.ui.hooks.use-composition": "0.0.140",
26
+ "@teambit/component": "0.0.559",
27
+ "@teambit/compositions.model.composition-id": "0.0.466",
28
+ "@teambit/graphql": "0.0.559",
29
+ "@teambit/cli": "0.0.389",
30
+ "@teambit/dev-files": "0.0.559",
31
+ "@teambit/preview": "0.0.559",
32
+ "@teambit/schema": "0.0.559",
33
+ "@teambit/workspace": "0.0.559",
34
+ "@teambit/ui-foundation.ui.constants.z-indexes": "0.0.466",
35
+ "@teambit/envs": "0.0.559",
36
+ "@teambit/compositions.ui.compositions-menu-bar": "0.0.143",
37
+ "@teambit/compositions.ui.hooks.use-composition": "0.0.143",
38
38
  "@teambit/design.ui.alert-card": "0.0.13",
39
39
  "@teambit/design.ui.empty-box": "0.0.352",
40
40
  "@teambit/design.ui.input.option-button": "0.0.26",
41
41
  "@teambit/design.ui.separator": "0.0.351",
42
42
  "@teambit/design.ui.surfaces.status-message-card": "0.0.6",
43
- "@teambit/docs.ui.queries.get-docs": "0.0.463",
44
- "@teambit/mdx.ui.mdx-layout": "0.0.467",
45
- "@teambit/panels": "0.0.386",
46
- "@teambit/preview.ui.component-preview": "0.0.463",
47
- "@teambit/ui-foundation.ui.buttons.collapser": "0.0.168",
48
- "@teambit/ui-foundation.ui.hooks.use-is-mobile": "0.0.156",
49
- "@teambit/ui": "0.0.555",
50
- "@teambit/compositions.model.composition-type": "0.0.464",
51
- "@teambit/compositions.ui.composition-card": "0.0.469"
43
+ "@teambit/docs.ui.queries.get-docs": "0.0.466",
44
+ "@teambit/mdx.ui.mdx-layout": "0.0.470",
45
+ "@teambit/panels": "0.0.389",
46
+ "@teambit/preview.ui.component-preview": "0.0.466",
47
+ "@teambit/ui-foundation.ui.buttons.collapser": "0.0.171",
48
+ "@teambit/ui-foundation.ui.hooks.use-is-mobile": "0.0.159",
49
+ "@teambit/ui": "0.0.559",
50
+ "@teambit/compositions.model.composition-type": "0.0.467",
51
+ "@teambit/compositions.ui.composition-card": "0.0.472"
52
52
  },
53
53
  "devDependencies": {
54
54
  "@types/react": "^17.0.8",
@@ -59,10 +59,10 @@
59
59
  "@types/jest": "^26.0.0",
60
60
  "@types/react-dom": "^17.0.5",
61
61
  "@types/node": "12.20.4",
62
- "@teambit/compositions.aspect-docs.compositions": "0.0.105"
62
+ "@teambit/compositions.aspect-docs.compositions": "0.0.108"
63
63
  },
64
64
  "peerDependencies": {
65
- "@teambit/legacy": "1.0.172",
65
+ "@teambit/legacy": "1.0.175",
66
66
  "react-dom": "^16.8.0 || ^17.0.0",
67
67
  "react": "^16.8.0 || ^17.0.0"
68
68
  },
@@ -90,12 +90,27 @@
90
90
  "react": "-"
91
91
  },
92
92
  "peerDependencies": {
93
- "@teambit/legacy": "1.0.172",
93
+ "@teambit/legacy": "1.0.175",
94
94
  "react-dom": "^16.8.0 || ^17.0.0",
95
95
  "react": "^16.8.0 || ^17.0.0"
96
96
  }
97
97
  }
98
98
  },
99
+ "files": [
100
+ "dist",
101
+ "!dist/tsconfig.tsbuildinfo",
102
+ "**/*.md",
103
+ "**/*.mdx",
104
+ "**/*.js",
105
+ "**/*.json",
106
+ "**/*.sass",
107
+ "**/*.scss",
108
+ "**/*.less",
109
+ "**/*.css",
110
+ "**/*.css",
111
+ "**/*.jpeg",
112
+ "**/*.gif"
113
+ ],
99
114
  "private": false,
100
115
  "engines": {
101
116
  "node": ">=12.22.0"
package/tsconfig.json CHANGED
@@ -15,9 +15,9 @@
15
15
  "skipLibCheck": true,
16
16
  "moduleResolution": "node",
17
17
  "esModuleInterop": true,
18
- "outDir": "dist",
19
18
  "composite": true,
20
19
  "emitDeclarationOnly": true,
20
+ "outDir": "dist",
21
21
  "experimentalDecorators": true,
22
22
  "emitDecoratorMetadata": true,
23
23
  "allowSyntheticDefaultImports": true,
@@ -1,29 +0,0 @@
1
- import { Section } from '@teambit/component';
2
- import React from 'react';
3
- import { Compositions } from './compositions';
4
- import type { CompositionsUI, CompositionsMenuSlot, EmptyStateSlot } from './compositions.ui.runtime';
5
-
6
- type Options = { menuBarWidgetSlot: CompositionsMenuSlot };
7
-
8
- export class CompositionsSection implements Section {
9
- constructor(
10
- /**
11
- * simulations ui extension.
12
- */
13
- private compositions: CompositionsUI,
14
- private options: Options,
15
- private emptyStateSlot: EmptyStateSlot
16
- ) {}
17
-
18
- navigationLink = {
19
- href: '~compositions',
20
- children: 'Compositions',
21
- };
22
-
23
- route = {
24
- path: '~compositions',
25
- children: <Compositions menuBarWidgets={this.options.menuBarWidgetSlot} emptyState={this.emptyStateSlot} />,
26
- };
27
-
28
- order = 20;
29
- }
package/composition.ts DELETED
@@ -1,44 +0,0 @@
1
- import { humanizeCompositionId } from '@teambit/compositions.model.composition-id';
2
-
3
- export type CompositionProps = {
4
- identifier: string;
5
- filepath?: string;
6
- displayName?: string;
7
- };
8
-
9
- export class Composition {
10
- constructor(
11
- /**
12
- * identifier of the composition
13
- */
14
- readonly identifier: string,
15
-
16
- /**
17
- * file path in which the composition is contained.
18
- */
19
- readonly filepath?: string,
20
-
21
- /**
22
- * set explicit display name
23
- */
24
- private _displayName?: string
25
- ) {}
26
-
27
- get displayName() {
28
- return this._displayName || humanizeCompositionId(this.identifier);
29
- }
30
-
31
- toObject() {
32
- return {
33
- identifier: this.identifier,
34
- filepath: this.filepath,
35
- displayName: this._displayName,
36
- };
37
- }
38
-
39
- static fromArray(compositions: CompositionProps[]): Composition[] {
40
- return compositions.map((composition) => {
41
- return new Composition(composition.identifier, composition.filepath, composition.displayName);
42
- });
43
- }
44
- }
@@ -1,9 +0,0 @@
1
- import { Aspect } from '@teambit/harmony';
2
-
3
- export const CompositionsAspect = Aspect.create({
4
- id: 'teambit.compositions/compositions',
5
- dependencies: [],
6
- defaultConfig: {},
7
- });
8
-
9
- export default CompositionsAspect;
@@ -1,32 +0,0 @@
1
- import { Component } from '@teambit/component';
2
- import { Schema } from '@teambit/graphql';
3
- import gql from 'graphql-tag';
4
-
5
- import { CompositionsMain } from './compositions.main.runtime';
6
-
7
- export function compositionsSchema(compositions: CompositionsMain): Schema {
8
- return {
9
- typeDefs: gql`
10
- extend type Component {
11
- compositions: [Composition]
12
- }
13
-
14
- type Subscription {
15
- compositionAdded: Composition
16
- }
17
-
18
- type Composition {
19
- filepath: String
20
- identifier: String
21
- displayName: String
22
- }
23
- `,
24
- resolvers: {
25
- Component: {
26
- compositions: (component: Component) => {
27
- return compositions.getCompositions(component);
28
- },
29
- },
30
- },
31
- };
32
- }
@@ -1,164 +0,0 @@
1
- import { join } from 'path';
2
- import { MainRuntime } from '@teambit/cli';
3
- import { Component, ComponentAspect, ComponentMap, AspectData } from '@teambit/component';
4
- import { GraphqlAspect, GraphqlMain } from '@teambit/graphql';
5
- import { PreviewAspect, PreviewMain } from '@teambit/preview';
6
- import { SchemaAspect, SchemaMain } from '@teambit/schema';
7
- import { Workspace, WorkspaceAspect } from '@teambit/workspace';
8
- import { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';
9
- import { flatten } from '@teambit/legacy/dist/utils';
10
- import { DevFilesAspect, DevFilesMain } from '@teambit/dev-files';
11
- import { Composition } from './composition';
12
- import { CompositionsAspect } from './compositions.aspect';
13
- import { compositionsSchema } from './compositions.graphql';
14
- import { CompositionPreviewDefinition } from './compositions.preview-definition';
15
-
16
- export type CompositionsConfig = {
17
- /**
18
- * glob pattern to detect composition files. This includes all related files, like styles and jsons.
19
- * @example ['/*.composition?(s).*']
20
- */
21
- compositionFilePattern: string[];
22
- /**
23
- * glob pattern to select Preview files. this will only include files matched by compositionFilePattern.
24
- * @example ['*.{t,j}s', '*.{t,j}sx']
25
- */
26
- compositionPreviewFilePattern: string[];
27
- };
28
-
29
- /**
30
- * the component documentation extension.
31
- */
32
- export class CompositionsMain {
33
- constructor(
34
- /**
35
- * Glob pattern to select all composition files
36
- */
37
- private compositionFilePattern: string[],
38
-
39
- /**
40
- * Glob pattern to select composition preview files
41
- */
42
- private previewFilePattern: string[],
43
-
44
- /**
45
- * envs extension.
46
- */
47
- private preview: PreviewMain,
48
-
49
- /**
50
- * workspace extension.
51
- */
52
- private workspace: Workspace,
53
-
54
- /**
55
- * schema extension.
56
- */
57
- private schema: SchemaMain,
58
-
59
- private devFiles: DevFilesMain
60
- ) {}
61
-
62
- /**
63
- * returns an array of doc file paths for a set of components.
64
- */
65
- getPreviewFiles(components: Component[]): ComponentMap<AbstractVinyl[]> {
66
- return ComponentMap.as<AbstractVinyl[]>(components, (component) => {
67
- // this includes non executables, like `button.compositions.module.scss` or `presets.compositions.json`
68
- const compositionFiles = component.state.filesystem.byGlob(this.compositionFilePattern);
69
-
70
- // select only relevant preview files (.tsx, etc)
71
- const previewFiles = new Set(
72
- component.state.filesystem.byGlob(this.previewFilePattern).map((file) => file.relative)
73
- );
74
- const files = compositionFiles.filter((file) => previewFiles.has(file.relative));
75
-
76
- return files;
77
- });
78
- }
79
-
80
- /**
81
- * get component compositions.
82
- */
83
- getCompositions(component: Component): Composition[] {
84
- const entry = component.state.aspects.get(CompositionsAspect.id);
85
- if (!entry) return [];
86
- const compositions = entry.data.compositions;
87
- if (!compositions) return [];
88
-
89
- return Composition.fromArray(compositions);
90
- }
91
-
92
- /**
93
- * read composition from the component source code.
94
- */
95
- readCompositions(component: Component): Composition[] {
96
- const maybeFiles = this.getPreviewFiles([component]).byComponent(component);
97
-
98
- if (!maybeFiles) return [];
99
- const [, files] = maybeFiles;
100
- return flatten(
101
- files.map((file) => {
102
- return this.computeCompositions(component, file);
103
- })
104
- );
105
- }
106
-
107
- async onComponentLoad(component: Component): Promise<AspectData> {
108
- const compositions = this.readCompositions(component);
109
- return {
110
- compositions: compositions.map((composition) => composition.toObject()),
111
- };
112
- }
113
-
114
- private computeCompositions(component: Component, file: AbstractVinyl): Composition[] {
115
- // :TODO hacked for a specific file extension now until david will take care in the compiler.
116
- const pathArray = file.path.split('.');
117
- pathArray[pathArray.length - 1] = 'js';
118
-
119
- const module = this.schema.parseModule(join(this.workspace.componentDir(component.id), file.relative));
120
- return module.exports.map((exportModel) => {
121
- const displayName = exportModel.staticProperties?.get('compositionName');
122
-
123
- return new Composition(
124
- exportModel.identifier,
125
- file.relative,
126
- typeof displayName === 'string' ? displayName : undefined
127
- );
128
- });
129
- }
130
-
131
- static defaultConfig: CompositionsConfig = {
132
- compositionFilePattern: ['**/*.composition?(s).*'],
133
- compositionPreviewFilePattern: ['**/*.{t,j}s?(x)'],
134
- };
135
-
136
- static runtime = MainRuntime;
137
- static dependencies = [PreviewAspect, GraphqlAspect, WorkspaceAspect, SchemaAspect, DevFilesAspect, ComponentAspect];
138
-
139
- static async provider(
140
- [preview, graphql, workspace, schema, devFiles]: [PreviewMain, GraphqlMain, Workspace, SchemaMain, DevFilesMain],
141
- config: CompositionsConfig
142
- ) {
143
- const compositions = new CompositionsMain(
144
- config.compositionFilePattern,
145
- config.compositionPreviewFilePattern,
146
- preview,
147
- workspace,
148
- schema,
149
- devFiles
150
- );
151
- devFiles.registerDevPattern(config.compositionFilePattern);
152
-
153
- graphql.register(compositionsSchema(compositions));
154
- preview.registerDefinition(new CompositionPreviewDefinition(compositions));
155
-
156
- if (workspace) {
157
- workspace.onComponentLoad(compositions.onComponentLoad.bind(compositions));
158
- }
159
-
160
- return compositions;
161
- }
162
- }
163
-
164
- CompositionsAspect.addRuntime(CompositionsMain);
@@ -1,21 +0,0 @@
1
- import { Component, ComponentMap } from '@teambit/component';
2
- import { ExecutionContext } from '@teambit/envs';
3
- import { PreviewDefinition } from '@teambit/preview';
4
- import { AbstractVinyl } from '@teambit/legacy/dist/consumer/component/sources';
5
-
6
- import { CompositionsMain } from './compositions.main.runtime';
7
-
8
- export class CompositionPreviewDefinition implements PreviewDefinition {
9
- readonly prefix = 'compositions';
10
-
11
- constructor(private compositions: CompositionsMain) {}
12
-
13
- async renderTemplatePath(context: ExecutionContext): Promise<string> {
14
- return context.env.getMounter();
15
- }
16
-
17
- async getModuleMap(components: Component[]): Promise<ComponentMap<AbstractVinyl[]>> {
18
- const map = this.compositions.getPreviewFiles(components);
19
- return map.filter((value) => value.length !== 0);
20
- }
21
- }
@@ -1,67 +0,0 @@
1
- import {
2
- PreviewAspect,
3
- PreviewPreview,
4
- RenderingContext,
5
- PreviewRuntime,
6
- PreviewModule,
7
- ModuleFile,
8
- } from '@teambit/preview';
9
- import head from 'lodash.head';
10
-
11
- import { CompositionsAspect } from './compositions.aspect';
12
-
13
- export class CompositionsPreview {
14
- constructor(
15
- /**
16
- * preview extension.
17
- */
18
- private preview: PreviewPreview
19
- ) {}
20
-
21
- render(componentId: string, modules: PreviewModule, otherPreviewDefs, context: RenderingContext) {
22
- if (!modules.componentMap[componentId]) return;
23
-
24
- const compositions = this.selectPreviewModel(componentId, modules);
25
- const active = this.getActiveComposition(compositions);
26
-
27
- modules.mainModule.default(active, context);
28
- }
29
-
30
- /** gets relevant information for this preview to render */
31
- selectPreviewModel(componentId: string, previewModule: PreviewModule) {
32
- const files = previewModule.componentMap[componentId] || [];
33
-
34
- // allow compositions to come from many files. It is assumed they will have unique named
35
- const combined = Object.assign({}, ...files);
36
- return combined;
37
- }
38
-
39
- private getActiveComposition(module: ModuleFile) {
40
- const chosen = window.location.hash.split('&')[1];
41
-
42
- if (!chosen) {
43
- const first = head(Object.values(module));
44
- return first;
45
- }
46
-
47
- return module[chosen];
48
- }
49
-
50
- static runtime = PreviewRuntime;
51
-
52
- static dependencies = [PreviewAspect];
53
-
54
- static async provider([preview]: [PreviewPreview]) {
55
- const compPreview = new CompositionsPreview(preview);
56
- preview.registerPreview({
57
- name: 'compositions',
58
- render: compPreview.render.bind(compPreview),
59
- selectPreviewModel: compPreview.selectPreviewModel.bind(compPreview),
60
- default: true,
61
- });
62
-
63
- return compPreview;
64
- }
65
- }
66
-
67
- CompositionsAspect.addRuntime(CompositionsPreview);
package/compositions.tsx DELETED
@@ -1,185 +0,0 @@
1
- import React, { useContext, useEffect, useState, useMemo, useRef, ReactNode } from 'react';
2
- import head from 'lodash.head';
3
- import queryString from 'query-string';
4
- import { ThemeContext } from '@teambit/documenter.theme.theme-context';
5
- import { SplitPane, Pane, Layout } from '@teambit/base-ui.surfaces.split-pane.split-pane';
6
- import { HoverSplitter } from '@teambit/base-ui.surfaces.split-pane.hover-splitter';
7
- import { ComponentContext, ComponentModel } from '@teambit/component';
8
- import { PropTable } from '@teambit/documenter.ui.property-table';
9
- import { Tab, TabContainer, TabList, TabPanel } from '@teambit/panels';
10
- import { useDocs } from '@teambit/docs.ui.queries.get-docs';
11
- import { Collapser } from '@teambit/ui-foundation.ui.buttons.collapser';
12
- import { EmptyBox } from '@teambit/design.ui.empty-box';
13
- import { toPreviewUrl } from '@teambit/preview.ui.component-preview';
14
- import { useIsMobile } from '@teambit/ui-foundation.ui.hooks.use-is-mobile';
15
- import { CompositionsMenuBar } from '@teambit/compositions.ui.compositions-menu-bar';
16
- import { CompositionContextProvider } from '@teambit/compositions.ui.hooks.use-composition';
17
- import { MDXLayout } from '@teambit/mdx.ui.mdx-layout';
18
- import { Separator } from '@teambit/design.ui.separator';
19
- import { H1 } from '@teambit/documenter.ui.heading';
20
- import { AlertCard } from '@teambit/design.ui.alert-card';
21
- import { NativeLink } from '@teambit/base-ui.routing.native-link';
22
- import { OptionButton } from '@teambit/design.ui.input.option-button';
23
- import { StatusMessageCard } from '@teambit/design.ui.surfaces.status-message-card';
24
- import { EmptyStateSlot } from './compositions.ui.runtime';
25
- import { Composition } from './composition';
26
- import styles from './compositions.module.scss';
27
- import { ComponentComposition } from './ui';
28
- import { CompositionsPanel } from './ui/compositions-panel/compositions-panel';
29
- import type { CompositionsMenuSlot } from './compositions.ui.runtime';
30
-
31
- export type MenuBarWidget = {
32
- location: 'start' | 'end';
33
- content: ReactNode;
34
- };
35
- export type CompositionsProp = { menuBarWidgets?: CompositionsMenuSlot; emptyState?: EmptyStateSlot };
36
-
37
- export function Compositions({ menuBarWidgets, emptyState }: CompositionsProp) {
38
- const component = useContext(ComponentContext);
39
- const [selected, selectComposition] = useState(head(component.compositions));
40
- const selectedRef = useRef(selected);
41
- selectedRef.current = selected;
42
-
43
- const properties = useDocs(component.id);
44
-
45
- // reset selected composition when component changes.
46
- // this does trigger renderer, but perf seems to be ok
47
- useEffect(() => {
48
- const prevId = selectedRef.current?.identifier;
49
- const next = component.compositions.find((c) => c.identifier === prevId) || component.compositions[0];
50
-
51
- selectComposition(next);
52
- }, [component]);
53
- const isMobile = useIsMobile();
54
- const showSidebar = !isMobile && component.compositions.length > 0;
55
- const [isSidebarOpen, setSidebarOpenness] = useState(showSidebar);
56
-
57
- const sidebarOpenness = isSidebarOpen ? Layout.row : Layout.left;
58
-
59
- const compositionUrl = toPreviewUrl(component, 'compositions');
60
- const currentCompositionUrl = toPreviewUrl(component, 'compositions', selected?.identifier);
61
-
62
- const [compositionParams, setCompositionParams] = useState<Record<string, any>>({});
63
- const queryParams = useMemo(() => queryString.stringify(compositionParams), [compositionParams]);
64
-
65
- // collapse sidebar when empty, reopen when not
66
- useEffect(() => setSidebarOpenness(showSidebar), [showSidebar]);
67
-
68
- return (
69
- <CompositionContextProvider queryParams={compositionParams} setQueryParams={setCompositionParams}>
70
- <SplitPane layout={sidebarOpenness} size="85%" className={styles.compositionsPage}>
71
- <Pane className={styles.left}>
72
- <CompositionsMenuBar menuBarWidgets={menuBarWidgets} className={styles.menuBar}>
73
- <NativeLink external href={currentCompositionUrl} className={styles.openInNewTab}>
74
- <OptionButton icon="open-tab" />
75
- </NativeLink>
76
- </CompositionsMenuBar>
77
- <CompositionContent
78
- emptyState={emptyState}
79
- component={component}
80
- selected={selected}
81
- queryParams={queryParams}
82
- />
83
- </Pane>
84
- <HoverSplitter className={styles.splitter}>
85
- <Collapser
86
- placement="left"
87
- isOpen={isSidebarOpen}
88
- onMouseDown={(e) => e.stopPropagation()} // avoid split-pane drag
89
- onClick={() => setSidebarOpenness((x) => !x)}
90
- tooltipContent={`${isSidebarOpen ? 'Hide' : 'Show'} side compositions`}
91
- className={styles.collapser}
92
- />
93
- </HoverSplitter>
94
- <Pane className={styles.right}>
95
- <ThemeContext>
96
- <TabContainer className={styles.tabsContainer}>
97
- <TabList className={styles.tabs}>
98
- <Tab>compositions</Tab>
99
- <Tab>properties</Tab>
100
- </TabList>
101
- <TabPanel className={styles.tabContent}>
102
- <CompositionsPanel
103
- onSelectComposition={selectComposition}
104
- url={compositionUrl}
105
- compositions={component.compositions}
106
- active={selected}
107
- className={styles.compost}
108
- />
109
- </TabPanel>
110
- <TabPanel className={styles.tabContent}>
111
- {properties && properties.length > 0 ? <PropTable rows={properties} showListView /> : <div />}
112
- </TabPanel>
113
- </TabContainer>
114
- </ThemeContext>
115
- </Pane>
116
- </SplitPane>
117
- </CompositionContextProvider>
118
- );
119
- }
120
-
121
- type CompositionContentProps = {
122
- component: ComponentModel;
123
- selected?: Composition;
124
- queryParams?: string | string[];
125
- emptyState?: EmptyStateSlot;
126
- };
127
-
128
- function CompositionContent({ component, selected, queryParams, emptyState }: CompositionContentProps) {
129
- const env = component.environment?.id;
130
- const EmptyStateTemplate = emptyState?.get(env || ''); // || defaultTemplate;
131
-
132
- if (component.compositions.length === 0 && component.host === 'teambit.workspace/workspace' && EmptyStateTemplate) {
133
- return (
134
- <div className={styles.noCompositionsPage}>
135
- <div>
136
- <H1 className={styles.title}>Compositions</H1>
137
- <Separator isPresentational className={styles.separator} />
138
- <AlertCard
139
- level="info"
140
- title="There are no
141
- compositions for this Component. Learn how to add compositions:"
142
- >
143
- <MDXLayout>
144
- <EmptyStateTemplate />
145
- </MDXLayout>
146
- </AlertCard>
147
- </div>
148
- </div>
149
- );
150
- }
151
-
152
- if (component?.buildStatus === 'pending' && component?.host === 'teambit.scope/scope')
153
- return (
154
- <StatusMessageCard className={styles.buildStatusMessage} status="PROCESSING" title="component preview pending">
155
- this might take some time
156
- </StatusMessageCard>
157
- );
158
- if (component?.buildStatus === 'failed' && component?.host === 'teambit.scope/scope')
159
- return (
160
- <StatusMessageCard
161
- className={styles.buildStatusMessage}
162
- status="FAILURE"
163
- title="failed to get component preview "
164
- ></StatusMessageCard>
165
- );
166
-
167
- if (component.compositions.length === 0) {
168
- return (
169
- <EmptyBox
170
- title="There are no compositions for this component."
171
- linkText="Learn how to create compositions"
172
- link="https://harmony-docs.bit.dev/compositions/overview/"
173
- />
174
- );
175
- }
176
-
177
- return (
178
- <ComponentComposition
179
- className={styles.compositionsIframe}
180
- component={component}
181
- composition={selected}
182
- queryParams={queryParams}
183
- />
184
- );
185
- }
@@ -1,53 +0,0 @@
1
- import type { ReactNode } from 'react';
2
- import { ComponentType } from 'react';
3
- import { Slot, SlotRegistry } from '@teambit/harmony';
4
- import { ComponentAspect, ComponentUI } from '@teambit/component';
5
- import { UIRuntime } from '@teambit/ui';
6
- import { CompositionsSection } from './composition.section';
7
- import { CompositionsAspect } from './compositions.aspect';
8
- import { MenuBarWidget } from './compositions';
9
-
10
- export type CompositionsMenuSlot = SlotRegistry<MenuBarWidget[]>;
11
- export type EmptyStateSlot = SlotRegistry<ComponentType>;
12
-
13
- export class CompositionsUI {
14
- constructor(private menuBarWidgetSlot: CompositionsMenuSlot, private emptyStateSlot: EmptyStateSlot) {}
15
-
16
- /**
17
- * register a new tester empty state. this allows to register a different empty state from each environment for example.
18
- */
19
- registerEmptyState(emptyStateComponent: ComponentType) {
20
- this.emptyStateSlot.register(emptyStateComponent);
21
- return this;
22
- }
23
-
24
- registerMenuWidget(...widget: MenuBarWidget[]) {
25
- this.menuBarWidgetSlot.register(widget);
26
- }
27
-
28
- static dependencies = [ComponentAspect];
29
- static runtime = UIRuntime;
30
- static slots = [Slot.withType<ReactNode>(), Slot.withType<ComponentType>()];
31
-
32
- static async provider(
33
- [component]: [ComponentUI],
34
- config: {},
35
- [compositionMenuSlot, emptyStateSlot]: [CompositionsMenuSlot, EmptyStateSlot]
36
- ) {
37
- const compositions = new CompositionsUI(compositionMenuSlot, emptyStateSlot);
38
- const section = new CompositionsSection(
39
- compositions,
40
- { menuBarWidgetSlot: compositions.menuBarWidgetSlot },
41
- emptyStateSlot
42
- );
43
-
44
- component.registerRoute(section.route);
45
- component.registerNavigation(section.navigationLink, section.order);
46
-
47
- return compositions;
48
- }
49
- }
50
-
51
- export default CompositionsUI;
52
-
53
- CompositionsAspect.addRuntime(CompositionsUI);
package/index.ts DELETED
@@ -1,10 +0,0 @@
1
- import { CompositionsAspect } from './compositions.aspect';
2
-
3
- export { CompositionsAspect };
4
- export type { CompositionsMain } from './compositions.main.runtime';
5
- export type { CompositionsUI, CompositionsMenuSlot } from './compositions.ui.runtime';
6
- export { Composition, CompositionProps } from './composition';
7
- export type { CompositionsPreview } from './compositions.preview.runtime';
8
- export { CompositionsOverview } from './ui/compositions-overview';
9
- export { ComponentComposition } from './ui';
10
- export default CompositionsAspect;
package/types/asset.d.ts DELETED
@@ -1,29 +0,0 @@
1
- declare module '*.png' {
2
- const value: any;
3
- export = value;
4
- }
5
- declare module '*.svg' {
6
- import type { FunctionComponent, SVGProps } from 'react';
7
-
8
- export const ReactComponent: FunctionComponent<SVGProps<SVGSVGElement> & { title?: string }>;
9
- const src: string;
10
- export default src;
11
- }
12
-
13
- // @TODO Gilad
14
- declare module '*.jpg' {
15
- const value: any;
16
- export = value;
17
- }
18
- declare module '*.jpeg' {
19
- const value: any;
20
- export = value;
21
- }
22
- declare module '*.gif' {
23
- const value: any;
24
- export = value;
25
- }
26
- declare module '*.bmp' {
27
- const value: any;
28
- export = value;
29
- }
package/types/style.d.ts DELETED
@@ -1,42 +0,0 @@
1
- declare module '*.module.css' {
2
- const classes: { readonly [key: string]: string };
3
- export default classes;
4
- }
5
- declare module '*.module.scss' {
6
- const classes: { readonly [key: string]: string };
7
- export default classes;
8
- }
9
- declare module '*.module.sass' {
10
- const classes: { readonly [key: string]: string };
11
- export default classes;
12
- }
13
-
14
- declare module '*.module.less' {
15
- const classes: { readonly [key: string]: string };
16
- export default classes;
17
- }
18
-
19
- declare module '*.less' {
20
- const classes: { readonly [key: string]: string };
21
- export default classes;
22
- }
23
-
24
- declare module '*.css' {
25
- const classes: { readonly [key: string]: string };
26
- export default classes;
27
- }
28
-
29
- declare module '*.sass' {
30
- const classes: { readonly [key: string]: string };
31
- export default classes;
32
- }
33
-
34
- declare module '*.scss' {
35
- const classes: { readonly [key: string]: string };
36
- export default classes;
37
- }
38
-
39
- declare module '*.mdx' {
40
- const component: any;
41
- export default component;
42
- }
@@ -1,60 +0,0 @@
1
- import React, { useMemo } from 'react';
2
- import { ComponentModel } from '@teambit/component';
3
- import { ComponentPreview } from '@teambit/preview.ui.component-preview';
4
-
5
- import { Composition } from '../composition';
6
-
7
- export type ComponentCompositionProps = {
8
- /**
9
- * HTML class
10
- */
11
- className?: string;
12
-
13
- /**
14
- * component to render.
15
- */
16
- component: ComponentModel;
17
-
18
- /**
19
- * composition to use for component rendering.
20
- */
21
- composition?: Composition;
22
-
23
- /**
24
- * Additional query params to append at the end of the *hash*. Changing this property will not reload the composition.
25
- */
26
- queryParams?: string | string[];
27
-
28
- /**
29
- * skip hot reload
30
- */
31
- hotReload?: boolean;
32
- };
33
-
34
- export function ComponentComposition({
35
- component,
36
- composition,
37
- hotReload,
38
- className,
39
- queryParams = [],
40
- }: ComponentCompositionProps) {
41
- const compositionParams = useMemo(() => (composition ? [composition.identifier] : []).concat(queryParams), [
42
- composition?.identifier,
43
- queryParams,
44
- ]);
45
-
46
- return (
47
- <ComponentPreview
48
- className={className}
49
- component={component}
50
- style={{ width: '100%', height: '100%' }}
51
- previewName="compositions"
52
- queryParams={compositionParams}
53
- hotReload={hotReload}
54
- />
55
- );
56
- }
57
-
58
- ComponentComposition.defaultProps = {
59
- skipHotReload: true,
60
- };
@@ -1,21 +0,0 @@
1
- import React from 'react';
2
- import { CompositionCard } from '@teambit/compositions.ui.composition-card';
3
- import { CompositionsModule } from '@teambit/compositions.model.composition-type';
4
-
5
- import styles from './compositions-overview.module.scss';
6
-
7
- export type CompositionsOverviewProps = {
8
- compositions?: CompositionsModule;
9
- compositionCardClass?: string;
10
- };
11
-
12
- export function CompositionsOverview({ compositions, compositionCardClass }: CompositionsOverviewProps) {
13
- return (
14
- <div className={styles.background}>
15
- {compositions &&
16
- Object.entries(compositions).map(([key, composition]) => (
17
- <CompositionCard key={key} Composition={composition} name={key} className={compositionCardClass} />
18
- ))}
19
- </div>
20
- );
21
- }
@@ -1 +0,0 @@
1
- export * from './compositions-overview';
@@ -1,58 +0,0 @@
1
- import { Icon } from '@teambit/evangelist.elements.icon';
2
- import classNames from 'classnames';
3
- import React, { useCallback } from 'react';
4
-
5
- import { Composition } from '../../composition';
6
- import styles from './compositions-panel.module.scss';
7
-
8
- export type CompositionsPanelProps = {
9
- compositions: Composition[];
10
- onSelectComposition: (composition: Composition) => void;
11
- active?: Composition;
12
- url: string;
13
- } & React.HTMLAttributes<HTMLUListElement>;
14
-
15
- export function CompositionsPanel({
16
- url,
17
- compositions,
18
- onSelectComposition: onSelect,
19
- active,
20
- className,
21
- ...rest
22
- }: CompositionsPanelProps) {
23
- const handleSelect = useCallback(
24
- (selected: Composition) => {
25
- onSelect && onSelect(selected);
26
- },
27
- [onSelect]
28
- );
29
-
30
- return (
31
- <ul {...rest} className={classNames(className)}>
32
- {compositions.map((composition) => {
33
- // TODO - move to composition panel node
34
- return (
35
- <li
36
- key={composition.identifier}
37
- className={classNames(styles.linkWrapper, composition === active && styles.active)}
38
- >
39
- <a className={styles.panelLink} onClick={() => handleSelect(composition)}>
40
- <span className={styles.box}></span>
41
- <span className={styles.name}>{composition.displayName}</span>
42
- </a>
43
- <div className={styles.right}>
44
- <a
45
- className={styles.panelLink}
46
- target="_blank"
47
- rel="noopener noreferrer"
48
- href={`${url}&${composition.identifier}`}
49
- >
50
- <Icon className={styles.icon} of="open-tab" />
51
- </a>
52
- </div>
53
- </li>
54
- );
55
- })}
56
- </ul>
57
- );
58
- }
File without changes
@@ -1,22 +0,0 @@
1
- import classNames from 'classnames';
2
- import React from 'react';
3
-
4
- import styles from './compositions-panel-node.module.scss';
5
-
6
- export type CompositionsPanelNodeProps = {
7
- name: string;
8
- onClick: (event: React.MouseEvent<HTMLAnchorElement>) => void;
9
- isActive: boolean;
10
- } & React.HTMLAttributes<HTMLLIElement>;
11
-
12
- export function CompositionsPanelNode({ name, onClick, isActive, ...rest }: CompositionsPanelNodeProps) {
13
- return (
14
- <li {...rest}>
15
- <div className={classNames(styles.linkWrapper, { [styles.active]: isActive })}>
16
- <a className={styles.panelLink} onClick={onClick}>
17
- {name}
18
- </a>
19
- </div>
20
- </li>
21
- );
22
- }
@@ -1 +0,0 @@
1
- export * from './compositions-panel-node';
package/ui/index.ts DELETED
@@ -1 +0,0 @@
1
- export { ComponentComposition } from './composition-preview';
@@ -1,14 +0,0 @@
1
- // import gql from 'graphql-tag';
2
- // import { ComponentModel } from '../../component';
3
- // import { Composition } from '../composition';
4
- // import { useDataQuery } from '../../ui';
5
-
6
- // const GET_COMPOSITIONS = gql`
7
- // compositions: {
8
-
9
- // }
10
- // `;
11
-
12
- // export function useCompositions(component: ComponentModel): Composition[] | [] {
13
- // useDataQuery();
14
- // }