@teambit/component 1.0.178 → 1.0.179

package/artifacts/schema.json

@@ -2422,7 +2422,7 @@
                 "_legacy": {
                   "scope": "teambit.component",
                   "name": "component",
-                  "version": "1.0.178"
+                  "version": "1.0.179"
                 },
                 "_scope": "teambit.component"
               }
@@ -4165,31 +4165,58 @@
               "line": 157,
               "character": 3
             },
-            "signature": "(method) ComponentFactory.listIds(): Promise<ComponentID[]>",
+            "signature": "(method) ComponentFactory.listIds(): Promise<ComponentID[]> | ComponentID[]",
             "name": "listIds",
             "params": [],
             "returnType": {
-              "__schema": "TypeRefSchema",
+              "__schema": "TypeUnionSchema",
               "location": {
                 "filePath": "component-factory.ts",
                 "line": 157,
                 "character": 14
               },
-              "name": "Promise",
-              "typeArgs": [
+              "types": [
+                {
+                  "__schema": "TypeRefSchema",
+                  "location": {
+                    "filePath": "component-factory.ts",
+                    "line": 157,
+                    "character": 14
+                  },
+                  "name": "Promise",
+                  "typeArgs": [
+                    {
+                      "__schema": "TypeArraySchema",
+                      "location": {
+                        "filePath": "component-factory.ts",
+                        "line": 157,
+                        "character": 22
+                      },
+                      "type": {
+                        "__schema": "TypeRefSchema",
+                        "location": {
+                          "filePath": "component-factory.ts",
+                          "line": 157,
+                          "character": 22
+                        },
+                        "name": "ComponentID"
+                      }
+                    }
+                  ]
+                },
                 {
                   "__schema": "TypeArraySchema",
                   "location": {
                     "filePath": "component-factory.ts",
                     "line": 157,
-                    "character": 22
+                    "character": 39
                   },
                   "type": {
                     "__schema": "TypeRefSchema",
                     "location": {
                       "filePath": "component-factory.ts",
                       "line": 157,
-                      "character": 22
+                      "character": 39
                     },
                     "name": "ComponentID"
                   }
@@ -7951,7 +7978,7 @@
                 "_legacy": {
                   "scope": "teambit.component",
                   "name": "component",
-                  "version": "1.0.178"
+                  "version": "1.0.179"
                 },
                 "_scope": "teambit.component"
               }
@@ -18573,7 +18600,7 @@
                   "_legacy": {
                     "scope": "teambit.component",
                     "name": "component",
-                    "version": "1.0.178"
+                    "version": "1.0.179"
                   },
                   "_scope": "teambit.component"
                 }
@@ -20724,31 +20751,58 @@
                 "line": 157,
                 "character": 3
               },
-              "signature": "(method) ComponentFactory.listIds(): Promise<ComponentID[]>",
+              "signature": "(method) ComponentFactory.listIds(): Promise<ComponentID[]> | ComponentID[]",
               "name": "listIds",
               "params": [],
               "returnType": {
-                "__schema": "TypeRefSchema",
+                "__schema": "TypeUnionSchema",
                 "location": {
                   "filePath": "component-factory.ts",
                   "line": 157,
                   "character": 14
                 },
-                "name": "Promise",
-                "typeArgs": [
+                "types": [
+                  {
+                    "__schema": "TypeRefSchema",
+                    "location": {
+                      "filePath": "component-factory.ts",
+                      "line": 157,
+                      "character": 14
+                    },
+                    "name": "Promise",
+                    "typeArgs": [
+                      {
+                        "__schema": "TypeArraySchema",
+                        "location": {
+                          "filePath": "component-factory.ts",
+                          "line": 157,
+                          "character": 22
+                        },
+                        "type": {
+                          "__schema": "TypeRefSchema",
+                          "location": {
+                            "filePath": "component-factory.ts",
+                            "line": 157,
+                            "character": 22
+                          },
+                          "name": "ComponentID"
+                        }
+                      }
+                    ]
+                  },
                   {
                     "__schema": "TypeArraySchema",
                     "location": {
                       "filePath": "component-factory.ts",
                       "line": 157,
-                      "character": 22
+                      "character": 39
                     },
                     "type": {
                       "__schema": "TypeRefSchema",
                       "location": {
                         "filePath": "component-factory.ts",
                         "line": 157,
-                        "character": 22
+                        "character": 39
                       },
                       "name": "ComponentID"
                     }
@@ -23668,7 +23722,7 @@
                   "_legacy": {
                     "scope": "teambit.component",
                     "name": "component",
-                    "version": "1.0.178"
+                    "version": "1.0.179"
                   },
                   "_scope": "teambit.component"
                 }
@@ -29929,7 +29983,7 @@
                   "_legacy": {
                     "scope": "teambit.component",
                     "name": "component",
-                    "version": "1.0.178"
+                    "version": "1.0.179"
                   },
                   "_scope": "teambit.component"
                 }
@@ -32311,7 +32365,7 @@
   "componentId": {
     "scope": "teambit.component",
     "name": "component",
-    "version": "1.0.178"
+    "version": "1.0.179"
   },
   "taggedModuleExports": []
 }

package/dist/component-factory.d.ts

@@ -116,7 +116,7 @@ export interface ComponentFactory {
      * list invalid components, such as components with missing files on the fs.
      */
     listInvalid(): Promise<InvalidComponent[]>;
-    listIds(): Promise<ComponentID[]>;
+    listIds(): Promise<ComponentID[]> | ComponentID[];
     /**
      * get component-ids matching the given pattern. a pattern can have multiple patterns separated by a comma.
      * it uses multimatch (https://www.npmjs.com/package/multimatch) package for the matching algorithm, which supports

package/dist/component-factory.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sources":["component-factory.ts"],"sourcesContent":["import { Graph } from '@teambit/graph.cleargraph';\nimport { BitId } from '@teambit/legacy-bit-id';\nimport { ComponentID } from '@teambit/component-id';\nimport ConsumerComponent from '@teambit/legacy/dist/consumer/component';\nimport { CompIdGraph } from '@teambit/graph';\nimport type { ComponentLog } from '@teambit/legacy/dist/scope/models/model-component';\nimport type { AspectDefinition } from '@teambit/aspect-loader';\nimport { Component, InvalidComponent } from './component';\nimport { State } from './state';\nimport { Snap } from './snap';\n\nexport type ResolveAspectsOptions = FilterAspectsOptions & {\n  throwOnError?: boolean;\n  useScopeAspectsCapsule?: boolean;\n  workspaceName?: string;\n  skipDeps?: boolean;\n  resolveEnvsFromRoots?: boolean;\n  packageManagerConfigRootDir?: string;\n};\n\nexport type LoadAspectsOptions = {\n  /* `throwOnError` is an optional parameter that can be passed to the loadAspects method in the `ComponentFactory` interface. If\n  set to `true`, it will cause the method to throw an error if an error occurs during its execution. If set to `false`\n  or not provided, the method will print a warning instead of throwing it. */\n  throwOnError?: boolean;\n  /* `hideMissingModuleError` is an optional parameter that can be passed to the `loadAspects` method in the\n  `ComponentFactory` interface. If set to `true`, it will prevent the method from throwing/printing an error if a required module\n  is missing during the loading of an aspect. Instead, it will continue loading the other\n  aspects. If set to `false` or not provided, the method will print/throw an error if a required module is missing.\n  (considering throwOnError as well) */\n  hideMissingModuleError?: boolean;\n\n  /* The `ignoreErrors` property is an optional boolean parameter that can be passed to the `LoadAspectsOptions` object in\n  the `ComponentFactory` interface. If set to `true`, it will cause the `loadAspects` method to ignore any errors that\n  occur during the loading of aspects and continue loading the other aspects. If set to `false` or not provided, the\n  method will print/throw an error if a required module is missing or if any other error occurs during the loading of\n  aspects. */\n  ignoreErrors?: boolean;\n  [key: string]: any;\n};\n\nexport type FilterAspectsOptions = {\n  /**\n   * Do not return results for the core aspects\n   */\n  excludeCore?: boolean;\n  /**\n   * Only return results for the provided list of ids\n   */\n  requestedOnly?: boolean;\n  /**\n   * Only return results for aspects that have a path to the specified runtime name\n   */\n  filterByRuntime?: boolean;\n};\n\nexport interface ComponentFactory {\n  /**\n   * name of the component host.\n   */\n  name: string;\n\n  /**\n   * path to the component host.\n   */\n  path: string;\n\n  isLegacy: boolean;\n\n  /**\n   * resolve a `string` component ID to an instance of a ComponentID.\n   */\n  resolveComponentId(id: string | BitId | ComponentID): Promise<ComponentID>;\n\n  /**\n   * resolve multiple `string` component ID to an instance of a ComponentID.\n   */\n  resolveMultipleComponentIds(ids: (string | BitId | ComponentID)[]): Promise<ComponentID[]>;\n\n  /**\n   * returns a component by ID.\n   */\n  get(id: ComponentID): Promise<Component | undefined>;\n\n  /**\n   * returns the legacy representation of a component with minimal loading.\n   * when loaded from the workspace, it won't run any Harmony hooks and even won't load dependencies.\n   * it's good to get raw aspects data or some basic properties.\n   * use carefully. prefer using `get()` instead.\n   */\n  getLegacyMinimal(id: ComponentID): Promise<ConsumerComponent | undefined>;\n\n  /**\n   * returns many components by ids.\n   */\n  getMany(ids: ComponentID[]): Promise<Component[]>;\n\n  /**\n   * returns many components by their legacy representation.\n   */\n  getManyByLegacy(components: ConsumerComponent[]): Promise<Component[]>;\n\n  /**\n   * get a component from a remote without importing it\n   */\n  getRemoteComponent?: (id: ComponentID) => Promise<Component>;\n\n  /**\n   * important - prefer using `getGraphIds()` if you don't need the component objects.\n   * this method has a performance penalty. it must import all flattened-dependencies objects from the remotes.\n   */\n  getGraph(ids?: ComponentID[], shouldThrowOnMissingDep?: boolean): Promise<Graph<Component, string>>;\n\n  /**\n   * get graph of the given component-ids and all their dependencies (recursively/flattened).\n   * the nodes are ComponentIds and is much faster than `this.getGraph()`.\n   */\n  getGraphIds(ids?: ComponentID[], shouldThrowOnMissingDep?: boolean): Promise<CompIdGraph>;\n\n  getLogs(id: ComponentID, shortHash?: boolean, startsFrom?: string): Promise<ComponentLog[]>;\n\n  /**\n   * returns a specific state of a component by hash or semver.\n   */\n  getState(id: ComponentID, snapId: string): Promise<State>;\n\n  /**\n   * returns a specific snap of a component by hash.\n   */\n  getSnap(id: ComponentID, snapId: string): Promise<Snap>;\n\n  /**\n   * load aspects.\n   * returns the loaded aspect ids including the loaded versions.\n   */\n  loadAspects: (ids: string[], throwOnError?: boolean, neededFor?: string, opts?: any) => Promise<string[]>;\n\n  /**\n   * Resolve dirs for aspects\n   */\n  resolveAspects: (\n    runtimeName?: string,\n    componentIds?: ComponentID[],\n    opts?: ResolveAspectsOptions\n  ) => Promise<AspectDefinition[]>;\n\n  /**\n   * list all components in the host.\n   */\n  list(filter?: { offset: number; limit: number }): Promise<Component[]>;\n\n  /**\n   * list invalid components, such as components with missing files on the fs.\n   */\n  listInvalid(): Promise<InvalidComponent[]>;\n\n  listIds(): Promise<ComponentID[]>;\n\n  /**\n   * get component-ids matching the given pattern. a pattern can have multiple patterns separated by a comma.\n   * it uses multimatch (https://www.npmjs.com/package/multimatch) package for the matching algorithm, which supports\n   * (among others) negate character \"!\" to exclude ids. See the package page for more supported characters.\n   */\n  idsByPattern(pattern: string, throwForNoMatch?: boolean): Promise<ComponentID[]>;\n\n  hasId(componentId: ComponentID): Promise<boolean>;\n\n  /**\n   * Check if the host has the id, if no, search for the id in inner host (for example, workspace will search in the scope)\n   * @param componentId\n   */\n  hasIdNested(componentId: ComponentID, includeCache?: boolean): Promise<boolean>;\n\n  /**\n   * whether a component is not the same as its head.\n   * for a new component, it'll return \"true\" as it has no head yet.\n   * this is relevant for component from the workspace, where it can be locally changed. on the scope it's always false\n   */\n  isModified(component: Component): Promise<boolean>;\n\n  /**\n   * write the component to the filesystem when applicable (no-op for scope).\n   * to change the component-path, specify the \"rootPath\", which should be a relative path inside the workspace.\n   */\n  write(component: Component, rootPath?: string): Promise<void>;\n\n  /**\n   * determine whether host should be the prior one in case multiple hosts persist.\n   */\n  priority?: boolean;\n}\n"],"mappings":""}
+{"version":3,"names":[],"sources":["component-factory.ts"],"sourcesContent":["import { Graph } from '@teambit/graph.cleargraph';\nimport { BitId } from '@teambit/legacy-bit-id';\nimport { ComponentID } from '@teambit/component-id';\nimport ConsumerComponent from '@teambit/legacy/dist/consumer/component';\nimport { CompIdGraph } from '@teambit/graph';\nimport type { ComponentLog } from '@teambit/legacy/dist/scope/models/model-component';\nimport type { AspectDefinition } from '@teambit/aspect-loader';\nimport { Component, InvalidComponent } from './component';\nimport { State } from './state';\nimport { Snap } from './snap';\n\nexport type ResolveAspectsOptions = FilterAspectsOptions & {\n  throwOnError?: boolean;\n  useScopeAspectsCapsule?: boolean;\n  workspaceName?: string;\n  skipDeps?: boolean;\n  resolveEnvsFromRoots?: boolean;\n  packageManagerConfigRootDir?: string;\n};\n\nexport type LoadAspectsOptions = {\n  /* `throwOnError` is an optional parameter that can be passed to the loadAspects method in the `ComponentFactory` interface. If\n  set to `true`, it will cause the method to throw an error if an error occurs during its execution. If set to `false`\n  or not provided, the method will print a warning instead of throwing it. */\n  throwOnError?: boolean;\n  /* `hideMissingModuleError` is an optional parameter that can be passed to the `loadAspects` method in the\n  `ComponentFactory` interface. If set to `true`, it will prevent the method from throwing/printing an error if a required module\n  is missing during the loading of an aspect. Instead, it will continue loading the other\n  aspects. If set to `false` or not provided, the method will print/throw an error if a required module is missing.\n  (considering throwOnError as well) */\n  hideMissingModuleError?: boolean;\n\n  /* The `ignoreErrors` property is an optional boolean parameter that can be passed to the `LoadAspectsOptions` object in\n  the `ComponentFactory` interface. If set to `true`, it will cause the `loadAspects` method to ignore any errors that\n  occur during the loading of aspects and continue loading the other aspects. If set to `false` or not provided, the\n  method will print/throw an error if a required module is missing or if any other error occurs during the loading of\n  aspects. */\n  ignoreErrors?: boolean;\n  [key: string]: any;\n};\n\nexport type FilterAspectsOptions = {\n  /**\n   * Do not return results for the core aspects\n   */\n  excludeCore?: boolean;\n  /**\n   * Only return results for the provided list of ids\n   */\n  requestedOnly?: boolean;\n  /**\n   * Only return results for aspects that have a path to the specified runtime name\n   */\n  filterByRuntime?: boolean;\n};\n\nexport interface ComponentFactory {\n  /**\n   * name of the component host.\n   */\n  name: string;\n\n  /**\n   * path to the component host.\n   */\n  path: string;\n\n  isLegacy: boolean;\n\n  /**\n   * resolve a `string` component ID to an instance of a ComponentID.\n   */\n  resolveComponentId(id: string | BitId | ComponentID): Promise<ComponentID>;\n\n  /**\n   * resolve multiple `string` component ID to an instance of a ComponentID.\n   */\n  resolveMultipleComponentIds(ids: (string | BitId | ComponentID)[]): Promise<ComponentID[]>;\n\n  /**\n   * returns a component by ID.\n   */\n  get(id: ComponentID): Promise<Component | undefined>;\n\n  /**\n   * returns the legacy representation of a component with minimal loading.\n   * when loaded from the workspace, it won't run any Harmony hooks and even won't load dependencies.\n   * it's good to get raw aspects data or some basic properties.\n   * use carefully. prefer using `get()` instead.\n   */\n  getLegacyMinimal(id: ComponentID): Promise<ConsumerComponent | undefined>;\n\n  /**\n   * returns many components by ids.\n   */\n  getMany(ids: ComponentID[]): Promise<Component[]>;\n\n  /**\n   * returns many components by their legacy representation.\n   */\n  getManyByLegacy(components: ConsumerComponent[]): Promise<Component[]>;\n\n  /**\n   * get a component from a remote without importing it\n   */\n  getRemoteComponent?: (id: ComponentID) => Promise<Component>;\n\n  /**\n   * important - prefer using `getGraphIds()` if you don't need the component objects.\n   * this method has a performance penalty. it must import all flattened-dependencies objects from the remotes.\n   */\n  getGraph(ids?: ComponentID[], shouldThrowOnMissingDep?: boolean): Promise<Graph<Component, string>>;\n\n  /**\n   * get graph of the given component-ids and all their dependencies (recursively/flattened).\n   * the nodes are ComponentIds and is much faster than `this.getGraph()`.\n   */\n  getGraphIds(ids?: ComponentID[], shouldThrowOnMissingDep?: boolean): Promise<CompIdGraph>;\n\n  getLogs(id: ComponentID, shortHash?: boolean, startsFrom?: string): Promise<ComponentLog[]>;\n\n  /**\n   * returns a specific state of a component by hash or semver.\n   */\n  getState(id: ComponentID, snapId: string): Promise<State>;\n\n  /**\n   * returns a specific snap of a component by hash.\n   */\n  getSnap(id: ComponentID, snapId: string): Promise<Snap>;\n\n  /**\n   * load aspects.\n   * returns the loaded aspect ids including the loaded versions.\n   */\n  loadAspects: (ids: string[], throwOnError?: boolean, neededFor?: string, opts?: any) => Promise<string[]>;\n\n  /**\n   * Resolve dirs for aspects\n   */\n  resolveAspects: (\n    runtimeName?: string,\n    componentIds?: ComponentID[],\n    opts?: ResolveAspectsOptions\n  ) => Promise<AspectDefinition[]>;\n\n  /**\n   * list all components in the host.\n   */\n  list(filter?: { offset: number; limit: number }): Promise<Component[]>;\n\n  /**\n   * list invalid components, such as components with missing files on the fs.\n   */\n  listInvalid(): Promise<InvalidComponent[]>;\n\n  listIds(): Promise<ComponentID[]> | ComponentID[];\n\n  /**\n   * get component-ids matching the given pattern. a pattern can have multiple patterns separated by a comma.\n   * it uses multimatch (https://www.npmjs.com/package/multimatch) package for the matching algorithm, which supports\n   * (among others) negate character \"!\" to exclude ids. See the package page for more supported characters.\n   */\n  idsByPattern(pattern: string, throwForNoMatch?: boolean): Promise<ComponentID[]>;\n\n  hasId(componentId: ComponentID): Promise<boolean>;\n\n  /**\n   * Check if the host has the id, if no, search for the id in inner host (for example, workspace will search in the scope)\n   * @param componentId\n   */\n  hasIdNested(componentId: ComponentID, includeCache?: boolean): Promise<boolean>;\n\n  /**\n   * whether a component is not the same as its head.\n   * for a new component, it'll return \"true\" as it has no head yet.\n   * this is relevant for component from the workspace, where it can be locally changed. on the scope it's always false\n   */\n  isModified(component: Component): Promise<boolean>;\n\n  /**\n   * write the component to the filesystem when applicable (no-op for scope).\n   * to change the component-path, specify the \"rootPath\", which should be a relative path inside the workspace.\n   */\n  write(component: Component, rootPath?: string): Promise<void>;\n\n  /**\n   * determine whether host should be the prior one in case multiple hosts persist.\n   */\n  priority?: boolean;\n}\n"],"mappings":""}

package/dist/{preview-1709263126667.js → preview-1709349444701.js}

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

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/component",
-  "version": "1.0.178",
+  "version": "1.0.179",
   "homepage": "https://bit.cloud/teambit/component/component",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.component",
     "name": "component",
-    "version": "1.0.178"
+    "version": "1.0.179"
   },
   "dependencies": {
     "@teambit/any-fs": "0.0.5",
@@ -38,35 +38,35 @@
     "@teambit/documenter.ui.separator": "4.1.1",
     "@teambit/design.ui.pages.not-found": "0.0.366",
     "@teambit/design.ui.pages.server-error": "0.0.366",
+    "@teambit/design.ui.styles.ellipsis": "0.0.357",
+    "@teambit/explorer.ui.command-bar": "2.0.14",
     "@teambit/design.navigation.responsive-navbar": "0.0.7",
     "@teambit/base-ui.layout.breakpoints": "1.0.0",
     "@teambit/ui-foundation.ui.use-box.dropdown": "0.0.142",
-    "@teambit/design.ui.styles.ellipsis": "0.0.357",
-    "@teambit/explorer.ui.command-bar": "2.0.14",
-    "@teambit/aspect-loader": "1.0.178",
-    "@teambit/graph": "1.0.178",
+    "@teambit/aspect-loader": "1.0.179",
+    "@teambit/graph": "1.0.179",
     "@teambit/toolbox.path.match-patterns": "0.0.15",
     "@teambit/toolbox.string.capitalize": "0.0.496",
     "@teambit/cli": "0.0.852",
     "@teambit/express": "0.0.951",
-    "@teambit/graphql": "1.0.178",
-    "@teambit/command-bar": "1.0.178",
+    "@teambit/graphql": "1.0.179",
+    "@teambit/command-bar": "1.0.179",
     "@teambit/component-package-version": "0.0.433",
-    "@teambit/preview": "1.0.178",
-    "@teambit/pubsub": "1.0.178",
-    "@teambit/react-router": "1.0.178",
-    "@teambit/ui": "1.0.178",
+    "@teambit/preview": "1.0.179",
+    "@teambit/pubsub": "1.0.179",
+    "@teambit/react-router": "1.0.179",
+    "@teambit/ui": "1.0.179",
     "@teambit/component-issues": "0.0.141",
     "@teambit/cli-table": "0.0.48",
     "@teambit/component-descriptor": "0.0.415",
     "@teambit/harmony.ui.aspect-box": "0.0.507",
-    "@teambit/compositions": "1.0.178",
-    "@teambit/deprecation": "1.0.178",
-    "@teambit/envs": "1.0.178",
+    "@teambit/compositions": "1.0.179",
+    "@teambit/deprecation": "1.0.179",
+    "@teambit/envs": "1.0.179",
+    "@teambit/envs.ui.env-icon": "0.0.505",
     "@teambit/component.ui.version-dropdown": "0.0.855",
     "@teambit/lanes.hooks.use-lanes": "0.0.260",
-    "@teambit/lanes.ui.models.lanes-model": "0.0.212",
-    "@teambit/envs.ui.env-icon": "0.0.505"
+    "@teambit/lanes.ui.models.lanes-model": "0.0.212"
   },
   "devDependencies": {
     "@types/lodash": "4.14.165",