@teambit/component 1.0.226 → 1.0.227

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.
Files changed (85) hide show
  1. package/artifacts/__bit_junit.xml +1 -1
  2. package/artifacts/preview/teambit_component_component-preview.js +1 -1
  3. package/artifacts/schema.json +303 -1125
  4. package/dist/{preview-1712632644937.js → preview-1712719054377.js} +2 -2
  5. package/package.json +22 -22
  6. package/tsconfig.json +46 -1
  7. package/dist/aspect-entry.d.ts +0 -39
  8. package/dist/aspect-list.d.ts +0 -43
  9. package/dist/aspect.section.d.ts +0 -13
  10. package/dist/component-factory.d.ts +0 -149
  11. package/dist/component-fs.d.ts +0 -34
  12. package/dist/component-interface.d.ts +0 -22
  13. package/dist/component-map/component-map.d.ts +0 -63
  14. package/dist/component-map/index.d.ts +0 -1
  15. package/dist/component-meta.d.ts +0 -22
  16. package/dist/component.aspect.d.ts +0 -3
  17. package/dist/component.composition.d.ts +0 -1
  18. package/dist/component.d.ts +0 -182
  19. package/dist/component.graphql.d.ts +0 -83
  20. package/dist/component.main.runtime.d.ts +0 -75
  21. package/dist/component.route.d.ts +0 -18
  22. package/dist/component.ui.runtime.d.ts +0 -104
  23. package/dist/config.d.ts +0 -18
  24. package/dist/dependencies/dependencies.d.ts +0 -43
  25. package/dist/dependencies/index.d.ts +0 -1
  26. package/dist/exceptions/could-not-find-latest.d.ts +0 -4
  27. package/dist/exceptions/host-not-found.d.ts +0 -12
  28. package/dist/exceptions/index.d.ts +0 -4
  29. package/dist/exceptions/main-file-not-found.d.ts +0 -14
  30. package/dist/exceptions/nothing-to-snap.d.ts +0 -2
  31. package/dist/get-component-opts.d.ts +0 -13
  32. package/dist/hash.d.ts +0 -4
  33. package/dist/head.d.ts +0 -0
  34. package/dist/history-graph.d.ts +0 -2
  35. package/dist/host/component-host-model.d.ts +0 -7
  36. package/dist/host/index.d.ts +0 -2
  37. package/dist/host/use-component-host.d.ts +0 -6
  38. package/dist/index.d.ts +0 -37
  39. package/dist/on-load.d.ts +0 -0
  40. package/dist/section/index.d.ts +0 -1
  41. package/dist/section/section.d.ts +0 -11
  42. package/dist/show/extensions.fragment.d.ts +0 -13
  43. package/dist/show/files.fragment.d.ts +0 -14
  44. package/dist/show/id.fragment.d.ts +0 -13
  45. package/dist/show/index.d.ts +0 -8
  46. package/dist/show/main-file.fragment.d.ts +0 -9
  47. package/dist/show/name.fragment.d.ts +0 -9
  48. package/dist/show/scope.fragment.d.ts +0 -10
  49. package/dist/show/show-fragment.d.ts +0 -37
  50. package/dist/show/show.cmd.d.ts +0 -26
  51. package/dist/snap/author.d.ts +0 -17
  52. package/dist/snap/index.d.ts +0 -2
  53. package/dist/snap/snap.d.ts +0 -56
  54. package/dist/state.d.ts +0 -65
  55. package/dist/store.d.ts +0 -3
  56. package/dist/tag/index.d.ts +0 -1
  57. package/dist/tag/tag.d.ts +0 -32
  58. package/dist/tag-map.d.ts +0 -35
  59. package/dist/ui/aspect-page/aspect-page.d.ts +0 -1
  60. package/dist/ui/aspect-page/index.d.ts +0 -1
  61. package/dist/ui/component-error/component-error.d.ts +0 -20
  62. package/dist/ui/component-error/index.d.ts +0 -1
  63. package/dist/ui/component-model/component-model.d.ts +0 -186
  64. package/dist/ui/component-model/index.d.ts +0 -1
  65. package/dist/ui/component-searcher/component-result.d.ts +0 -16
  66. package/dist/ui/component-searcher/component-searcher.d.ts +0 -22
  67. package/dist/ui/component-searcher/index.d.ts +0 -2
  68. package/dist/ui/component.d.ts +0 -26
  69. package/dist/ui/context/component-context.d.ts +0 -6
  70. package/dist/ui/context/component-provider.d.ts +0 -25
  71. package/dist/ui/context/index.d.ts +0 -3
  72. package/dist/ui/index.d.ts +0 -12
  73. package/dist/ui/menu/index.d.ts +0 -3
  74. package/dist/ui/menu/menu-nav.d.ts +0 -23
  75. package/dist/ui/menu/menu.d.ts +0 -97
  76. package/dist/ui/menu/nav-plugin.d.ts +0 -28
  77. package/dist/ui/top-bar-nav/index.d.ts +0 -1
  78. package/dist/ui/top-bar-nav/top-bar-nav.d.ts +0 -2
  79. package/dist/ui/use-component-from-location.d.ts +0 -1
  80. package/dist/ui/use-component-logs.d.ts +0 -16
  81. package/dist/ui/use-component-query.d.ts +0 -3
  82. package/dist/ui/use-component.d.ts +0 -3
  83. package/dist/ui/use-component.fragments.d.ts +0 -10
  84. package/dist/ui/use-component.model.d.ts +0 -44
  85. package/dist/ui/use-component.utils.d.ts +0 -1
@@ -1,6 +0,0 @@
1
- /// <reference types="react" />
2
- import type { ComponentDescriptor } from '@teambit/component-descriptor';
3
- import { ComponentModel } from '../component-model';
4
- export declare const ComponentContext: React.Context<ComponentModel>;
5
- export declare const ComponentDescriptorContext: React.Context<ComponentDescriptor | undefined>;
6
- export declare const useComponentDescriptor: () => ComponentDescriptor | undefined;
@@ -1,25 +0,0 @@
1
- import { ReactNode } from 'react';
2
- import type { ComponentDescriptor } from '@teambit/component-descriptor';
3
- import { ComponentModel } from '../component-model';
4
- export type ComponentProviderProps = {
5
- /**
6
- * component model.
7
- */
8
- component: ComponentModel;
9
- /**
10
- * component children.
11
- */
12
- children: ReactNode;
13
- };
14
- export declare function ComponentProvider({ component, children }: ComponentProviderProps): import("react/jsx-runtime").JSX.Element;
15
- export type ComponentDescriptorProviderProps = {
16
- /**
17
- * component model.
18
- */
19
- componentDescriptor?: ComponentDescriptor;
20
- /**
21
- * component children.
22
- */
23
- children: ReactNode;
24
- };
25
- export declare function ComponentDescriptorProvider({ componentDescriptor, children }: ComponentDescriptorProviderProps): import("react/jsx-runtime").JSX.Element;
@@ -1,3 +0,0 @@
1
- export { ComponentContext, ComponentDescriptorContext, useComponentDescriptor } from './component-context';
2
- export { ComponentProvider, ComponentDescriptorProvider } from './component-provider';
3
- export type { ComponentProviderProps, ComponentDescriptorProviderProps } from './component-provider';
@@ -1,12 +0,0 @@
1
- export { CollapsibleMenuNav, MenuNavProps } from './menu';
2
- export { Component } from './component';
3
- export { ConsumeMethodSlot, ComponentMenu, VersionRelatedDropdowns } from './menu';
4
- export { ComponentModel, ComponentModelProps } from './component-model';
5
- export { ComponentContext, ComponentProvider } from './context';
6
- export { TopBarNav } from './top-bar-nav';
7
- export { useComponent } from './use-component';
8
- export { componentIdFields, componentOverviewFields, componentFields, componentFieldsWithLogs, COMPONENT_QUERY_LOG_FIELDS, GET_COMPONENT, GET_COMPONENT_WITH_LOGS, } from './use-component.fragments';
9
- export { useIdFromLocation } from './use-component-from-location';
10
- export type { LogFilter, Filters, UseComponentOptions, ComponentQueryResult, UseComponentType, ComponentLogs, ComponentLogsResult, } from './use-component.model';
11
- export { useComponentQuery } from './use-component-query';
12
- export { useComponentLogs } from './use-component-logs';
@@ -1,3 +0,0 @@
1
- export { CollapsibleMenuNav, MenuNavProps } from './menu-nav';
2
- export { ComponentMenu, VersionRelatedDropdowns, RightSideMenuItem, RightSideMenuSlot } from './menu';
3
- export type { NavPlugin, OrderedNavigationSlot, ConsumePlugin, ConsumeMethodSlot, ConsumePluginProps, } from './nav-plugin';
@@ -1,23 +0,0 @@
1
- import React from 'react';
2
- import { NavPlugin, OrderedNavigationSlot } from './nav-plugin';
3
- export type MenuNavProps = {
4
- /**
5
- * @deprecated
6
- * use @property navPlugins
7
- */
8
- navigationSlot?: OrderedNavigationSlot;
9
- /**
10
- * @deprecated
11
- * use @property widgetPlugins
12
- */
13
- widgetSlot?: OrderedNavigationSlot;
14
- navPlugins?: [string, NavPlugin][];
15
- widgetPlugins?: [string, NavPlugin][];
16
- /**
17
- * A className to pass to the secondary nav, i.e dropdown
18
- */
19
- secondaryNavClassName?: string;
20
- activeTabIndex?: number;
21
- alwaysShowActiveTab?: boolean;
22
- } & React.HTMLAttributes<HTMLElement>;
23
- export declare function CollapsibleMenuNav({ navigationSlot, widgetSlot, navPlugins, widgetPlugins, className, secondaryNavClassName, activeTabIndex, alwaysShowActiveTab, children, }: MenuNavProps): import("react/jsx-runtime").JSX.Element;
@@ -1,97 +0,0 @@
1
- import React, { ReactNode } from 'react';
2
- import { SlotRegistry } from '@teambit/harmony';
3
- import { DropdownComponentVersion, GetActiveTabIndex } from '@teambit/component.ui.version-dropdown';
4
- import { MenuItemSlot } from '@teambit/ui-foundation.ui.main-dropdown';
5
- import { LanesModel } from '@teambit/lanes.ui.models.lanes-model';
6
- import { UseComponentType, Filters } from '../use-component';
7
- import { OrderedNavigationSlot, ConsumeMethodSlot } from './nav-plugin';
8
- import { ComponentID } from '../..';
9
- export type RightSideMenuItem = {
10
- item: ReactNode;
11
- order: number;
12
- };
13
- export type RightSideMenuSlot = SlotRegistry<RightSideMenuItem[]>;
14
- export type MenuProps = {
15
- className?: string;
16
- /**
17
- * skip the right side.
18
- */
19
- skipRightSide?: boolean;
20
- /**
21
- * custom render the right side
22
- */
23
- RightNode?: React.ReactNode;
24
- /**
25
- * slot for top bar menu nav items
26
- */
27
- navigationSlot: OrderedNavigationSlot;
28
- /**
29
- * right side navigation menu item slot
30
- */
31
- widgetSlot: OrderedNavigationSlot;
32
- /**
33
- * right side menu item slot
34
- */
35
- rightSideMenuSlot: RightSideMenuSlot;
36
- /**
37
- * workspace or scope
38
- */
39
- host: string;
40
- /**
41
- * main dropdown item slot
42
- */
43
- menuItemSlot: MenuItemSlot;
44
- consumeMethodSlot: ConsumeMethodSlot;
45
- componentIdStr?: string | (() => string | undefined);
46
- useComponent?: UseComponentType;
47
- useComponentFilters?: () => Filters;
48
- useLanes?: () => {
49
- loading?: boolean;
50
- lanesModel?: LanesModel;
51
- };
52
- path?: string;
53
- };
54
- /**
55
- * top bar menu.
56
- */
57
- export declare function ComponentMenu({ navigationSlot, widgetSlot, className, host, menuItemSlot, consumeMethodSlot, rightSideMenuSlot, componentIdStr, skipRightSide, RightNode, useComponent, path, useComponentFilters, }: MenuProps): import("react/jsx-runtime").JSX.Element;
58
- export type VersionRelatedDropdownsProps = {
59
- componentId?: string;
60
- consumeMethods?: ConsumeMethodSlot;
61
- componentFilters?: Filters;
62
- useComponent?: UseComponentVersions;
63
- className?: string;
64
- loading?: boolean;
65
- host: string;
66
- useLanes?: () => {
67
- loading?: boolean;
68
- lanesModel?: LanesModel;
69
- };
70
- dropdownOptions?: {
71
- showVersionDetails?: boolean;
72
- getActiveTabIndex?: GetActiveTabIndex;
73
- };
74
- };
75
- export type UseComponentVersionsProps = {
76
- skip?: boolean;
77
- id?: string;
78
- initialLoad?: boolean;
79
- };
80
- export type UseComponentVersionProps = {
81
- skip?: boolean;
82
- version?: string;
83
- };
84
- export type UseComponentVersions = (props?: UseComponentVersionsProps) => UseComponentVersionsResult;
85
- export type UseComponentVersion = (props?: UseComponentVersionProps) => DropdownComponentVersion | undefined;
86
- export type UseComponentVersionsResult = {
87
- tags?: DropdownComponentVersion[];
88
- snaps?: DropdownComponentVersion[];
89
- id?: ComponentID;
90
- packageName?: string;
91
- latest?: string;
92
- currentVersion?: string;
93
- loading?: boolean;
94
- };
95
- export declare function defaultLoadVersions(host: string, componentId?: string, componentFilters?: Filters, useComponent?: UseComponentType, loadingFromProps?: boolean): UseComponentVersions;
96
- export declare const defaultLoadCurrentVersion: (props: VersionRelatedDropdownsProps) => UseComponentVersion;
97
- export declare function VersionRelatedDropdowns(props: VersionRelatedDropdownsProps): import("react/jsx-runtime").JSX.Element;
@@ -1,28 +0,0 @@
1
- import { SlotRegistry } from '@teambit/harmony';
2
- import type { LinkProps } from '@teambit/base-react.navigation.link';
3
- import type { ConsumeMethod } from '@teambit/ui-foundation.ui.use-box.menu';
4
- import { LaneModel } from '@teambit/lanes.ui.models.lanes-model';
5
- import { ComponentID, ComponentModel } from '../..';
6
- export type NavPluginProps = {
7
- displayName?: string;
8
- ignoreQueryParams?: boolean;
9
- } & LinkProps;
10
- export type NavPlugin = {
11
- props: NavPluginProps;
12
- order?: number;
13
- };
14
- export type OrderedNavigationSlot = SlotRegistry<NavPlugin>;
15
- export type ConsumePluginOptions = {
16
- viewedLane?: LaneModel;
17
- hide?: boolean;
18
- disableInstall?: boolean;
19
- };
20
- export type ConsumePluginProps = {
21
- id: ComponentID;
22
- packageName: string;
23
- latest?: string;
24
- componentModel?: ComponentModel;
25
- options?: ConsumePluginOptions;
26
- };
27
- export type ConsumePlugin = (props: ConsumePluginProps) => ConsumeMethod | undefined;
28
- export type ConsumeMethodSlot = SlotRegistry<ConsumePlugin[]>;
@@ -1 +0,0 @@
1
- export * from './top-bar-nav';
@@ -1,2 +0,0 @@
1
- import { NavPluginProps } from '../menu/nav-plugin';
2
- export declare function TopBarNav({ href, className, activeClassName, children, displayName, ignoreQueryParams, ...rest }: NavPluginProps): import("react/jsx-runtime").JSX.Element;
@@ -1 +0,0 @@
1
- export declare function useIdFromLocation(url?: string, deriveScopeFromSearchParams?: boolean): string | undefined;
@@ -1,16 +0,0 @@
1
- import { ComponentLogsResult, Filters } from './use-component.model';
2
- export declare function useComponentLogs(componentId: string, host: string, filters?: Filters, skipFromProps?: boolean): ComponentLogsResult;
3
- export declare function useComponentLogsInit(componentId: string, host: string, filters?: Filters, skip?: boolean): {
4
- logOffset: number | undefined;
5
- variables: {
6
- id: string;
7
- extensionId: string;
8
- logOffset: any;
9
- logLimit: number | undefined;
10
- logType: string | undefined;
11
- logHead: string | undefined;
12
- logSort: string | undefined;
13
- logTakeHeadFromComponent: boolean | undefined;
14
- };
15
- skip: boolean | undefined;
16
- };
@@ -1,3 +0,0 @@
1
- import { ComponentQueryResult, Filters } from './use-component.model';
2
- /** provides data to component ui page, making sure both variables and return value are safely typed and memoized */
3
- export declare function useComponentQuery(componentId: string, host: string, filters?: Filters, skip?: boolean): ComponentQueryResult;
@@ -1,3 +0,0 @@
1
- import { ComponentQueryResult, UseComponentOptions, UseComponentType, Filters } from './use-component.model';
2
- export { UseComponentType, Filters };
3
- export declare function useComponent(host: string, id?: string, options?: UseComponentOptions): ComponentQueryResult;
@@ -1,10 +0,0 @@
1
- export declare const componentIdFields: import("@apollo/client").DocumentNode;
2
- export declare const componentOverviewFields: import("@apollo/client").DocumentNode;
3
- export declare const componentFields: import("@apollo/client").DocumentNode;
4
- export declare const componentFieldsWithLogs: import("@apollo/client").DocumentNode;
5
- export declare const COMPONENT_QUERY_LOG_FIELDS = "\n $logOffset: Int\n $logLimit: Int\n $logType: String\n $logHead: String\n $logSort: String\n $logTakeHeadFromComponent: Boolean\n";
6
- export declare const GET_COMPONENT: import("@apollo/client").DocumentNode;
7
- export declare const GET_COMPONENT_WITH_LOGS: import("@apollo/client").DocumentNode;
8
- export declare const SUB_SUBSCRIPTION_ADDED: import("@apollo/client").DocumentNode;
9
- export declare const SUB_COMPONENT_CHANGED: import("@apollo/client").DocumentNode;
10
- export declare const SUB_COMPONENT_REMOVED: import("@apollo/client").DocumentNode;
@@ -1,44 +0,0 @@
1
- import { ComponentDescriptor } from '@teambit/component-descriptor';
2
- import { LegacyComponentLog } from '@teambit/legacy-component-log';
3
- import { ComponentID } from '../';
4
- import { ComponentError } from './component-error';
5
- import { ComponentModel } from './component-model';
6
- export type LogFilter = {
7
- offset?: number;
8
- limit?: number;
9
- head?: string;
10
- sort?: string;
11
- takeHeadFromComponent?: boolean;
12
- };
13
- export type Filters = {
14
- log?: LogFilter & {
15
- type?: string;
16
- };
17
- loading?: boolean;
18
- };
19
- export type UseComponentOptions = {
20
- version?: string;
21
- logFilters?: Filters;
22
- customUseComponent?: UseComponentType;
23
- skip?: boolean;
24
- };
25
- export type ComponentQueryResult = {
26
- component?: ComponentModel;
27
- componentDescriptor?: ComponentDescriptor;
28
- componentLogs?: ComponentLogs;
29
- loading?: boolean;
30
- error?: ComponentError;
31
- };
32
- export type ComponentLogsResult = {
33
- id?: ComponentID;
34
- componentLogs?: ComponentLogs;
35
- latest?: string;
36
- packageName?: string;
37
- error?: ComponentError;
38
- loading?: boolean;
39
- };
40
- export type ComponentLogs = {
41
- logs?: LegacyComponentLog[];
42
- loading?: boolean;
43
- };
44
- export type UseComponentType = (id: string, host: string, filters?: Filters, skip?: boolean) => ComponentQueryResult;
@@ -1 +0,0 @@
1
- export declare function getOffsetValue(offset: any, limit: any, backwards?: boolean): any;