@teambit/dependency-resolver 1.0.99 → 1.0.100

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/dependency-resolver",
-  "version": "1.0.99",
+  "version": "1.0.100",
   "homepage": "https://bit.cloud/teambit/dependencies/dependency-resolver",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.dependencies",
     "name": "dependency-resolver",
-    "version": "1.0.99"
+    "version": "1.0.100"
   },
   "dependencies": {
     "cli-highlight": "2.1.9",
@@ -36,19 +36,20 @@
     "@teambit/component-id": "1.2.0",
     "@teambit/legacy-bit-id": "1.1.0",
     "@teambit/component-version": "1.0.3",
-    "@teambit/component": "1.0.99",
-    "@teambit/envs": "1.0.99",
-    "@teambit/aspect-loader": "1.0.99",
-    "@teambit/logger": "0.0.926",
-    "@teambit/graphql": "1.0.99",
-    "@teambit/bit": "1.5.30",
-    "@teambit/cli": "0.0.833",
-    "@teambit/config": "0.0.850",
-    "@teambit/global-config": "0.0.835",
+    "@teambit/component": "1.0.100",
+    "@teambit/envs": "1.0.100",
+    "@teambit/aspect-loader": "1.0.100",
+    "@teambit/logger": "0.0.927",
+    "@teambit/graphql": "1.0.100",
+    "@teambit/bit": "1.5.31",
+    "@teambit/cli": "0.0.834",
+    "@teambit/config": "0.0.851",
+    "@teambit/global-config": "0.0.836",
     "@teambit/harmony.modules.requireable-component": "0.0.495",
-    "@teambit/snapping": "1.0.99",
-    "@teambit/isolator": "1.0.99",
-    "@teambit/component-issues": "0.0.131",
+    "@teambit/snapping": "1.0.100",
+    "@teambit/workspace.modules.node-modules-linker": "0.0.155",
+    "@teambit/isolator": "1.0.100",
+    "@teambit/component-issues": "0.0.132",
     "@teambit/component-package-version": "0.0.430"
   },
   "devDependencies": {
@@ -66,11 +67,13 @@
     "@teambit/dependencies.aspect-docs.dependency-resolver": "0.0.174"
   },
   "peerDependencies": {
-    "@teambit/legacy": "1.0.618",
+    "@teambit/legacy": "1.0.619",
     "react": "^16.8.0 || ^17.0.0",
     "react-dom": "^16.8.0 || ^17.0.0"
   },
   "license": "Apache-2.0",
+  "optionalDependencies": {},
+  "peerDependenciesMeta": {},
   "exports": {
     "node": {
       "require": "./dist/index.js",

package/policy/env-policy/env-policy.ts

@@ -1,7 +1,6 @@
 import { validateEnvPolicyConfigObject } from './validate-env-policy';
 import {
   createVariantPolicyEntry,
-  DependencySource,
   VariantPolicyEntry,
   VariantPolicy,
   VariantPolicyConfigObject,
@@ -20,6 +19,7 @@ type EnvJsoncPolicyEntry = {
    * force add to component dependencies even if it's not used by the component.
    */
   force?: boolean;
+  optional?: boolean;
 };
 
 export type EnvJsoncPolicyPeerEntry = EnvJsoncPolicyEntry & {
@@ -62,7 +62,10 @@ export class EnvPolicy extends VariantPolicy {
     if (includeLegacyPeersInSelfPolicy && !configObject.peers && configObject.peerDependencies) {
       selfPeersEntries = handleLegacyPeers(configObject);
     } else {
-      selfPeersEntries = entriesFromKey(configObject, 'peers', 'version', 'runtime', 'env-own', true);
+      selfPeersEntries = entriesFromKey(configObject, 'peers', 'version', 'runtime', {
+        source: 'env-own',
+        force: true,
+      });
     }
     const selfPolicy = VariantPolicy.fromArray(selfPeersEntries);
 
@@ -72,11 +75,13 @@ export class EnvPolicy extends VariantPolicy {
      * Those were always forced on the components as visible dependencies.
      */
     const legacyPolicy = VariantPolicy.fromConfigObject(configObject, { source: 'env', force: true, hidden: false });
-    const componentPeersEntries = entriesFromKey(configObject, 'peers', 'supportedRange', 'peer', 'env');
+    const componentPeersEntries = entriesFromKey(configObject, 'peers', 'supportedRange', 'peer', { source: 'env' });
     const otherKeyNames: EnvJsoncPolicyConfigKey[] = ['dev', 'runtime'];
     const otherEntries: VariantPolicyEntry[] = otherKeyNames.reduce(
       (acc: VariantPolicyEntry[], keyName: EnvJsoncPolicyConfigKey) => {
-        const currEntries = entriesFromKey(configObject, keyName, 'version', keyName as DependencyLifecycleType, 'env');
+        const currEntries = entriesFromKey(configObject, keyName, 'version', keyName as DependencyLifecycleType, {
+          source: 'env',
+        });
         return acc.concat(currEntries);
       },
       []
@@ -96,7 +101,11 @@ function handleLegacyPeers(configObject: VariantPolicyConfigObject): VariantPoli
     return [];
   }
   const entries = Object.entries(configObject.peerDependencies).map(([packageName, version]) => {
-    return createVariantPolicyEntry(packageName, version, 'runtime', 'env-own', false, true);
+    return createVariantPolicyEntry(packageName, version, 'runtime', {
+      source: 'env-own',
+      hidden: false,
+      force: true,
+    });
   });
   return entries;
 }
@@ -106,23 +115,21 @@ function entriesFromKey(
   keyName: EnvJsoncPolicyConfigKey,
   versionKey: VersionKeyName = 'version',
   lifecycleType: DependencyLifecycleType,
-  source: DependencySource = 'env',
-  force?: boolean
+  options: VariantPolicyFromConfigObjectOptions
 ): VariantPolicyEntry[] {
   const configEntries: Array<EnvJsoncPolicyPeerEntry | EnvJsoncPolicyEntry> = configObject[keyName];
   if (!configEntries) {
     return [];
   }
   const entries = configEntries.map((entry) => {
-    return createVariantPolicyEntry(
-      entry.name,
-      entry[versionKey],
-      lifecycleType,
-      source,
-      entry.hidden,
+    return createVariantPolicyEntry(entry.name, entry[versionKey], lifecycleType, {
+      ...options,
+      source: options.source ?? 'env',
+      hidden: entry.hidden,
       // allow override the entry's force value (used for the env itself)
-      force ?? !!entry.force
-    );
+      force: options.force ?? !!entry.force,
+      optional: options.optional ?? !!entry.optional,
+    });
   });
   return entries;
 }

package/policy/index.ts

@@ -7,6 +7,11 @@ export {
   WorkspacePolicyEntry,
   WorkspacePolicyConfigKeysNames,
 } from './workspace-policy';
-export { VariantPolicy, VariantPolicyConfigObject, SerializedVariantPolicy } from './variant-policy';
+export {
+  VariantPolicy,
+  VariantPolicyEntryValue,
+  VariantPolicyConfigObject,
+  SerializedVariantPolicy,
+} from './variant-policy';
 
 export { EnvPolicy, EnvPolicyConfigObject } from './env-policy';

package/policy/variant-policy/index.ts

@@ -4,6 +4,7 @@ export {
   VariantPolicyFromConfigObjectOptions,
   SerializedVariantPolicy,
   VariantPolicyEntry,
+  VariantPolicyEntryValue,
   createVariantPolicyEntry,
   DependencySource,
 } from './variant-policy';

package/policy/variant-policy/variant-policy.ts

@@ -22,6 +22,7 @@ type VariantPolicyLifecycleConfigEntryObject = {
    * force add to component dependencies even if it's not used by the component.
    */
   force?: boolean;
+  optional?: boolean;
 };
 
 export type VariantPolicyConfigEntryValue = VariantPolicyEntryValue | VariantPolicyEntryVersion;
@@ -34,6 +35,7 @@ export type VariantPolicyEntryVersion = SemverVersion;
 export type VariantPolicyEntryValue = {
   version: VariantPolicyEntryVersion;
   resolveFromEnv?: boolean;
+  optional?: boolean;
 };
 
 export type DependencySource = 'auto' | 'env' | 'env-own' | 'slots' | 'config';
@@ -49,6 +51,7 @@ export type VariantPolicyEntry = PolicyEntry & {
    * force add to component dependencies even if it's not used by the component.
    */
   force?: boolean;
+  optional?: boolean;
 };
 
 export type SerializedVariantPolicyEntry = VariantPolicyEntry;
@@ -59,6 +62,7 @@ export interface VariantPolicyFromConfigObjectOptions {
   source?: DependencySource;
   hidden?: boolean;
   force?: boolean;
+  optional?: boolean;
 }
 
 export class VariantPolicy implements Policy<VariantPolicyConfigObject> {
@@ -225,13 +229,10 @@ export class VariantPolicy implements Policy<VariantPolicyConfigObject> {
     return res;
   }
 
-  static fromConfigObject(
-    configObject,
-    { source, hidden, force }: VariantPolicyFromConfigObjectOptions = {}
-  ): VariantPolicy {
-    const runtimeEntries = entriesFromKey(configObject, 'dependencies', source, hidden, force);
-    const devEntries = entriesFromKey(configObject, 'devDependencies', source, hidden, force);
-    const peerEntries = entriesFromKey(configObject, 'peerDependencies', source, hidden, force);
+  static fromConfigObject(configObject, options: VariantPolicyFromConfigObjectOptions = {}): VariantPolicy {
+    const runtimeEntries = entriesFromKey(configObject, 'dependencies', options);
+    const devEntries = entriesFromKey(configObject, 'devDependencies', options);
+    const peerEntries = entriesFromKey(configObject, 'peerDependencies', options);
     const entries = runtimeEntries.concat(devEntries).concat(peerEntries);
     return new VariantPolicy(entries);
   }
@@ -269,9 +270,7 @@ function uniqEntries(entries: Array<VariantPolicyEntry>): Array<VariantPolicyEnt
 function entriesFromKey(
   configObject: VariantPolicyConfigObject,
   keyName: PolicyConfigKeysNames,
-  source?: DependencySource,
-  hidden?: boolean,
-  force?: boolean
+  options: VariantPolicyFromConfigObjectOptions
 ): VariantPolicyEntry[] {
   const obj = configObject[keyName];
   if (!obj) {
@@ -279,24 +278,25 @@ function entriesFromKey(
   }
   const lifecycleType = LIFECYCLE_TYPE_BY_KEY_NAME[keyName];
   if (Array.isArray(obj)) {
-    return entriesFromArrayKey(obj, lifecycleType, source, hidden, force);
+    return entriesFromArrayKey(obj, lifecycleType, options);
   }
-  return entriesFromObjectKey(obj, lifecycleType, source, hidden, force);
+  return entriesFromObjectKey(obj, lifecycleType, options);
 }
 
 function entriesFromObjectKey(
   obj: Record<string, VariantPolicyConfigEntryValue> | undefined,
   lifecycleType: DependencyLifecycleType,
-  source?: DependencySource,
-  hidden?: boolean,
-  force = true
+  options: VariantPolicyFromConfigObjectOptions
 ): VariantPolicyEntry[] {
   if (!obj) {
     return [];
   }
   const entries = Object.entries(obj).map(([depId, value]: [string, VariantPolicyConfigEntryValue]) => {
     if (value) {
-      return createVariantPolicyEntry(depId, value, lifecycleType, source, hidden, force);
+      return createVariantPolicyEntry(depId, value, lifecycleType, {
+        ...options,
+        force: options.force ?? true,
+      });
     }
     return undefined;
   });
@@ -306,23 +306,20 @@ function entriesFromObjectKey(
 function entriesFromArrayKey(
   configEntries: Array<VariantPolicyLifecycleConfigEntryObject> | undefined,
   lifecycleType: DependencyLifecycleType,
-  source: DependencySource = 'config',
-  hidden?: boolean,
-  force?: boolean
+  options: VariantPolicyFromConfigObjectOptions
 ): VariantPolicyEntry[] {
   if (!configEntries) {
     return [];
   }
   const entries = configEntries.map((entry) => {
-    return createVariantPolicyEntry(
-      entry.name,
-      entry.version,
-      lifecycleType,
-      source,
-      hidden ?? !!entry.hidden,
+    return createVariantPolicyEntry(entry.name, entry.version, lifecycleType, {
+      ...options,
+      source: options.source ?? 'config',
+      hidden: Boolean(options.hidden ?? entry.hidden),
       // allow override the entry's force value (used for the env itself)
-      force ?? !!entry.force
-    );
+      force: Boolean(options.force ?? entry.force),
+      optional: Boolean(options.optional ?? entry.optional),
+    });
   });
   return entries;
 }
@@ -331,24 +328,22 @@ export function createVariantPolicyEntry(
   depId: string,
   value: VariantPolicyConfigEntryValue,
   lifecycleType: DependencyLifecycleType,
-  source?: DependencySource,
-  hidden?: boolean,
-  force?: boolean
+  opts: VariantPolicyFromConfigObjectOptions
 ): VariantPolicyEntry {
   const version = typeof value === 'string' ? value : value.version;
   const resolveFromEnv = typeof value === 'string' ? false : value.resolveFromEnv;
+  const optional = typeof value === 'string' ? undefined : value.optional;
 
   const entryValue: VariantPolicyEntryValue = {
     version,
     resolveFromEnv,
   };
   const entry: VariantPolicyEntry = {
+    ...opts,
     dependencyId: depId,
     value: entryValue,
     lifecycleType,
-    source,
-    hidden,
-    force,
+    optional: optional ?? opts.optional,
   };
   return entry;
 }

package/show-fragments/serialize-by-lifecycle.ts

@@ -6,7 +6,7 @@ export function serializeByLifecycle(deps: DependencyList, lifecycle: Dependency
   const longestLength = getLongestDepName(filteredByLifecycle);
   const paddedNames = filteredByLifecycle.dependencies.map((dep) => {
     const paddedName = getNameWithVersion(dep).padEnd(longestLength + 1, '-');
-    return `${paddedName} (${dep.type})`;
+    return `${paddedName} (${dep.type})${dep.optional ? '(optional)' : ''}`;
   });
   return paddedNames.join('\n');
 }