polkadot-js · polkadot-js-bot · Dec 19, 2023 · Dec 19, 2023 · Dec 19, 2023 · Dec 19, 2023
diff --git a/package.json b/package.json
@@ -37,7 +37,7 @@
     "test:one": "polkadot-dev-run-test --env browser"
   },
   "devDependencies": {
-    "@polkadot/dev": "^0.78.1",
+    "@polkadot/dev": "^0.78.2",
     "@types/node": "^20.10.5"
   },
   "resolutions": {

diff --git a/packages/hw-ledger-transports/src/detectOther.ts b/packages/hw-ledger-transports/src/detectOther.ts
diff --git a/...hw-ledger-transports/src/detectPackage.ts → ...hw-ledger-transports/src/packageDetect.ts b/...hw-ledger-transports/src/detectPackage.ts → ...hw-ledger-transports/src/packageDetect.ts
@@ -2,10 +2,10 @@
 // SPDX-License-Identifier: Apache-2.0
 
 // Do not edit, auto-generated by @polkadot/dev
+// (packageInfo imports will be kept as-is, user-editable)
 
 import { detectPackage } from '@polkadot/util';
 
-import others from './detectOther.js';
 import { packageInfo } from './packageInfo.js';
 
-detectPackage(packageInfo, null, others);
+detectPackage(packageInfo, null, []);
diff --git a/packages/hw-ledger/src/detectPackage.ts b/packages/hw-ledger/src/detectPackage.ts
diff --git a/packages/hw-ledger/src/index.ts b/packages/hw-ledger/src/index.ts
@@ -1,6 +1,6 @@
 // Copyright 2017-2023 @polkadot/hw-ledger authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-import './detectPackage.js';
+import './packageDetect.js';
 
 export * from './bundle.js';
diff --git a/packages/hw-ledger/src/detectOther.ts → packages/hw-ledger/src/packageDetect.ts b/packages/hw-ledger/src/detectOther.ts → packages/hw-ledger/src/packageDetect.ts
@@ -1,7 +1,13 @@
 // Copyright 2017-2023 @polkadot/hw-ledger authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
+// Do not edit, auto-generated by @polkadot/dev
+// (packageInfo imports will be kept as-is, user-editable)
+
 import { packageInfo as transportInfo } from '@polkadot/hw-ledger-transports/packageInfo';
+import { detectPackage } from '@polkadot/util';
 import { packageInfo as utilInfo } from '@polkadot/util/packageInfo';
 
-export default [transportInfo, utilInfo];
+import { packageInfo } from './packageInfo.js';
+
+detectPackage(packageInfo, null, [transportInfo, utilInfo]);
diff --git a/packages/keyring/src/detectOther.ts b/packages/keyring/src/detectOther.ts
diff --git a/packages/keyring/src/detectPackage.ts b/packages/keyring/src/detectPackage.ts
diff --git a/packages/keyring/src/index.ts b/packages/keyring/src/index.ts
@@ -1,7 +1,7 @@
 // Copyright 2017-2023 @polkadot/keyring authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-import './detectPackage.js';
+import './packageDetect.js';
 
 import { Keyring } from './bundle.js';
 

diff --git a/packages/keyring/src/packageDetect.ts b/packages/keyring/src/packageDetect.ts
@@ -0,0 +1,13 @@
+// Copyright 2017-2023 @polkadot/keyring authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+// Do not edit, auto-generated by @polkadot/dev
+// (packageInfo imports will be kept as-is, user-editable)
+
+import { detectPackage } from '@polkadot/util';
+import { packageInfo as utilInfo } from '@polkadot/util/packageInfo';
+import { packageInfo as cryptoInfo } from '@polkadot/util-crypto/packageInfo';
+
+import { packageInfo } from './packageInfo.js';
+
+detectPackage(packageInfo, null, [cryptoInfo, utilInfo]);
diff --git a/packages/networks/src/detectOther.ts b/packages/networks/src/detectOther.ts
diff --git a/packages/networks/src/index.ts b/packages/networks/src/index.ts
@@ -3,7 +3,7 @@
 
 // TODO: This was removed, really cannot recall the reason...
 // ... put it back, but keep it removed
-// import './detectPackage';
+// import './packageDetect.js';
 
 export * from './interfaces.js';
 export { packageInfo } from './packageInfo.js';
diff --git a/packages/networks/src/detectPackage.ts → packages/networks/src/packageDetect.ts b/packages/networks/src/detectPackage.ts → packages/networks/src/packageDetect.ts
@@ -2,10 +2,10 @@
 // SPDX-License-Identifier: Apache-2.0
 
 // Do not edit, auto-generated by @polkadot/dev
+// (packageInfo imports will be kept as-is, user-editable)
 
 import { detectPackage } from '@polkadot/util';
 
-import others from './detectOther.js';
 import { packageInfo } from './packageInfo.js';
 
-detectPackage(packageInfo, null, others);
+detectPackage(packageInfo, null, []);
diff --git a/packages/util-crypto/src/detectPackage.ts b/packages/util-crypto/src/detectPackage.ts
diff --git a/packages/util-crypto/src/index.ts b/packages/util-crypto/src/index.ts
@@ -1,6 +1,6 @@
 // Copyright 2017-2023 @polkadot/util-crypto authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-import './detectPackage.js';
+import './packageDetect.js';
 
 export * from './bundle.js';
diff --git a/packages/util-crypto/src/detectOther.ts → packages/util-crypto/src/packageDetect.ts b/packages/util-crypto/src/detectOther.ts → packages/util-crypto/src/packageDetect.ts
@@ -1,8 +1,14 @@
 // Copyright 2017-2023 @polkadot/util-crypto authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
+// Do not edit, auto-generated by @polkadot/dev
+// (packageInfo imports will be kept as-is, user-editable)
+
 import { packageInfo as netInfo } from '@polkadot/networks/packageInfo';
+import { detectPackage } from '@polkadot/util';
 import { packageInfo as utilInfo } from '@polkadot/util/packageInfo';
 import { packageInfo as randomInfo } from '@polkadot/x-randomvalues';
 
-export default [netInfo, utilInfo, randomInfo];
+import { packageInfo } from './packageInfo.js';
+
+detectPackage(packageInfo, null, [netInfo, randomInfo, utilInfo]);
diff --git a/packages/util/src/bundle.ts b/packages/util/src/bundle.ts
@@ -15,6 +15,7 @@ export * from './bi/index.js';
 export * from './bn/index.js';
 export * from './buffer/index.js';
 export * from './compact/index.js';
+export * from './detectPackage.js';
 export * from './extractTime.js';
 export * from './float/index.js';
 export * from './format/index.js';
@@ -32,4 +33,3 @@ export * from './promisify.js';
 export * from './string/index.js';
 export * from './stringify.js';
 export * from './u8a/index.js';
-export * from './versionDetect.js';
diff --git a/packages/util/src/versionDetect.spec.ts → packages/util/src/detectPackage.spec.ts b/packages/util/src/versionDetect.spec.ts → packages/util/src/detectPackage.spec.ts
@@ -3,7 +3,7 @@
 
 /// <reference types="@polkadot/dev-test/globals.d.ts" />
 
-import { detectPackage, POLKADOTJS_DISABLE_ESM_CJS_WARNING_FLAG } from './versionDetect.js';
+import { detectPackage, POLKADOTJS_DISABLE_ESM_CJS_WARNING_FLAG } from './detectPackage.js';
 
 describe('detectPackage', (): void => {
   const PKG = '@polkadot/util';

diff --git a/packages/util/src/detectPackage.ts b/packages/util/src/detectPackage.ts
@@ -1,8 +1,138 @@
 // Copyright 2017-2023 @polkadot/util authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-import others from './detectOther.js';
-import { packageInfo } from './packageInfo.js';
-import { detectPackage } from './versionDetect.js';
+import { xglobal } from '@polkadot/x-global';
 
-detectPackage(packageInfo, null, others);
+import { isFunction } from './is/function.js';
+
+type This = typeof globalThis;
+
+interface VersionPath {
+  path: string;
+  type: string;
+  version: string;
+}
+
+interface PackageInfo extends VersionPath {
+  name: string;
+}
+
+interface PjsChecks extends This {
+  __polkadotjs: Record<string, VersionPath[]>;
+}
+
+type PjsGlobal = This & PjsChecks & Record<string, unknown>;
+type FnString = () => string | undefined;
+
+const DEDUPE = 'Either remove and explicitly install matching versions or dedupe using your package manager.\nThe following conflicting packages were found:';
+
+export const POLKADOTJS_DISABLE_ESM_CJS_WARNING_FLAG = 'POLKADOTJS_DISABLE_ESM_CJS_WARNING';
+
+/** @internal */
+function getEntry (name: string): VersionPath[] {
+  const _global = xglobal as PjsGlobal;
+
+  if (!_global.__polkadotjs) {
+    _global.__polkadotjs = {};
+  }
+
+  if (!_global.__polkadotjs[name]) {
+    _global.__polkadotjs[name] = [];
+  }
+
+  return _global.__polkadotjs[name];
+}
+
+/** @internal */
+function formatDisplay <T extends { version: string }> (all: T[], fmt: (version: string, data: T) => string[]): string {
+  let max = 0;
+
+  for (let i = 0, count = all.length; i < count; i++) {
+    max = Math.max(max, all[i].version.length);
+  }
+
+  return all
+    .map((d) => `\t${fmt(d.version.padEnd(max), d).join('\t')}`)
+    .join('\n');
+}
+
+/** @internal */
+function formatInfo (version: string, { name }: PackageInfo): string[] {
+  return [
+    version,
+    name
+  ];
+}
+
+/** @internal */
+function formatVersion (version: string, { path, type }: VersionPath): string[] {
+  let extracted: string;
+
+  if (path && path.length >= 5) {
+    const nmIndex = path.indexOf('node_modules');
+
+    extracted = nmIndex === -1
+      ? path
+      : path.substring(nmIndex);
+  } else {
+    extracted = '<unknown>';
+  }
+
+  return [
+    `${`${type || ''}`.padStart(3)} ${version}`,
+    extracted
+  ];
+}
+
+/** @internal */
+function getPath (infoPath?: string, pathOrFn?: FnString | string | false | null): string {
+  if (infoPath) {
+    return infoPath;
+  } else if (isFunction(pathOrFn)) {
+    try {
+      return pathOrFn() || '';
+    } catch {
+      return '';
+    }
+  }
+
+  return pathOrFn || '';
+}
+
+/** @internal */
+function warn <T extends { version: string }> (pre: string, all: T[], fmt: (version: string, data: T) => string[]): void {
+  console.warn(`${pre}\n${DEDUPE}\n${formatDisplay(all, fmt)}`);
+}
+
+/**
+ * @name detectPackage
+ * @summary Checks that a specific package is only imported once
+ * @description A `@polkadot/*` version detection utility, checking for one occurrence of a package in addition to checking for dependency versions.
+ */
+export function detectPackage ({ name, path, type, version }: PackageInfo, pathOrFn?: FnString | string | false | null, deps: PackageInfo[] = []): void {
+  if (!name.startsWith('@polkadot')) {
+    throw new Error(`Invalid package descriptor ${name}`);
+  }
+
+  const entry = getEntry(name);
+
+  entry.push({ path: getPath(path, pathOrFn), type, version });
+
+  // if we have more than one entry at DIFFERENT version types then warn. If there is
+  // more than one entry at the same version and ESM/CJS dual warnings are disabled,
+  // then do not display warnings
+  const entriesSameVersion = entry.every((e) => e.version === version);
+  const esmCjsWarningDisabled = xglobal.process?.env?.[POLKADOTJS_DISABLE_ESM_CJS_WARNING_FLAG] === '1';
+  const multipleEntries = entry.length !== 1;
+  const disableWarnings = esmCjsWarningDisabled && entriesSameVersion;
+
+  if (multipleEntries && !disableWarnings) {
+    warn(`${name} has multiple versions, ensure that there is only one installed.`, entry, formatVersion);
+  } else {
+    const mismatches = deps.filter((d) => d && d.version !== version);
+
+    if (mismatches.length) {
+      warn(`${name} requires direct dependencies exactly matching version ${version}.`, mismatches, formatInfo);
+    }
+  }
+}
diff --git a/packages/util/src/index.ts b/packages/util/src/index.ts
@@ -1,6 +1,6 @@
 // Copyright 2017-2023 @polkadot/util authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-import './detectPackage.js';
+import './packageDetect.js';
 
 export * from './bundle.js';
diff --git a/packages/util/src/detectOther.ts → packages/util/src/packageDetect.ts b/packages/util/src/detectOther.ts → packages/util/src/packageDetect.ts
@@ -4,4 +4,7 @@
 import { packageInfo as decoderInfo } from '@polkadot/x-textdecoder';
 import { packageInfo as encoderInfo } from '@polkadot/x-textencoder';
 
-export default [decoderInfo, encoderInfo];
+import { detectPackage } from './detectPackage.js';
+import { packageInfo } from './packageInfo.js';
+
+detectPackage(packageInfo, null, [decoderInfo, encoderInfo]);