@dynamic-labs/assert-package-version 4.0.0-alpha.10

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Dynamic Labs, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# Dynamic Client
+
+Welcome to Dynamic's assert-package-version!

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@dynamic-labs/assert-package-version",
+  "version": "4.0.0-alpha.10",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dynamic-labs/dynamic-auth.git",
+    "directory": "packages/assert-package-version"
+  },
+  "description": "Utility to assert package versions",
+  "bugs": {
+    "url": "https://github.com/dynamic-labs/DynamicAuth/issues"
+  },
+  "homepage": "https://github.com/dynamic-labs/DynamicAuth/main/packages/assert-package-version#readme",
+  "author": "Dynamic Labs, Inc.",
+  "license": "MIT",
+  "main": "./src/index.cjs",
+  "module": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "import": "./src/index.js",
+      "require": "./src/index.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "@dynamic-labs/logger": "4.0.0-alpha.10"
+  },
+  "peerDependencies": {}
+}

package/src/index.cjs

@@ -0,0 +1,10 @@
+'use client'
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var assertPackageVersion = require('./lib/assertPackageVersion/assertPackageVersion.cjs');
+
+
+
+exports.assertPackageVersion = assertPackageVersion.assertPackageVersion;

package/src/index.d.ts

@@ -0,0 +1 @@
+export { assertPackageVersion } from './lib/assertPackageVersion';

package/src/index.js

@@ -0,0 +1,2 @@
+'use client'
+export { assertPackageVersion } from './lib/assertPackageVersion/assertPackageVersion.js';

package/src/lib/assertPackageVersion/assertPackageVersion.cjs

@@ -0,0 +1,78 @@
+'use client'
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var logger$1 = require('@dynamic-labs/logger');
+
+/**
+ * A mapping of package names to their versions.
+ */
+let packageVersions = {};
+const logger = new logger$1.Logger('@dynamic-labs/assert-package-version');
+/**
+ * Timeout ID for batching version checks.
+ */
+exports.versionCheckTimeout = null;
+/**
+ * Asserts that all `@dynamic-labs` packages are on the same version.
+ * Throws an error with instructions if versions mismatch.
+ *
+ * @param {string} packageName - The name of the package to assert.
+ * @param {string} version - The version of the package.
+ */
+const assertPackageVersion = (packageName, version) => {
+    // Update the package version mapping
+    packageVersions[packageName] = version;
+    // Clear any existing timeout
+    if (exports.versionCheckTimeout) {
+        clearTimeout(exports.versionCheckTimeout);
+        exports.versionCheckTimeout = null;
+    }
+    /**
+     * Timeout is set to 100ms to ensure the following:
+     * - All package versions have been imported and registered.
+     * - The environmentId is set in the logger so the error can be captured in DD
+     */
+    const timeout = 100;
+    /**
+     * Set a timeout to batch the version check.
+     * This ensures that the check is executed after all package versions have been imported
+     * and registered.
+     */
+    exports.versionCheckTimeout = setTimeout(() => {
+        const versions = Object.values(packageVersions);
+        const [firstVersion] = versions;
+        const allSameVersion = versions.every((v) => v === firstVersion);
+        if (!allSameVersion) {
+            // Determine the required (target) version
+            const targetVersion = packageVersions['@dynamic-labs/sdk-react-core'] || firstVersion;
+            const errorMessage = getErrorMessage(targetVersion);
+            logger.error(new Error(errorMessage));
+        }
+        exports.versionCheckTimeout = null;
+    }, timeout);
+};
+const getErrorMessage = (targetVersion) => {
+    // Identify packages with mismatched versions
+    const affectedPackages = Object.entries(packageVersions)
+        .filter(([, v]) => v !== targetVersion)
+        .map(([pkgName, installedVersion]) => `- \`${pkgName}\` (installed: **${installedVersion}**, required: **${targetVersion}**)`)
+        .join('\n');
+    // Error message template
+    const errorMessage = `
+🚨 Version Mismatch Error
+
+One or more \`@dynamic-labs\` packages are installed with mismatched versions. All \`@dynamic-labs\` packages must be on the same version to work correctly.
+
+Affected Packages:
+${affectedPackages}
+
+💡 To fix this issue, update all @dynamic-labs/* packages to version \`${targetVersion}\` in your package.json
+💡 Tip: You can use the \`npx dynamic-doctor run\` command to check for other issues with your project setup.
+`;
+    return errorMessage.trim();
+};
+
+exports.assertPackageVersion = assertPackageVersion;
+exports.logger = logger;

package/src/lib/assertPackageVersion/assertPackageVersion.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="node" />
+import { Logger } from '@dynamic-labs/logger';
+export declare const logger: Logger;
+/**
+ * Timeout ID for batching version checks.
+ */
+export declare let versionCheckTimeout: NodeJS.Timeout | null;
+/**
+ * Asserts that all `@dynamic-labs` packages are on the same version.
+ * Throws an error with instructions if versions mismatch.
+ *
+ * @param {string} packageName - The name of the package to assert.
+ * @param {string} version - The version of the package.
+ */
+export declare const assertPackageVersion: (packageName: string, version: string) => void;
+export declare const clearPackageVersionState: () => void;

package/src/lib/assertPackageVersion/assertPackageVersion.js

@@ -0,0 +1,73 @@
+'use client'
+import { Logger } from '@dynamic-labs/logger';
+
+/**
+ * A mapping of package names to their versions.
+ */
+let packageVersions = {};
+const logger = new Logger('@dynamic-labs/assert-package-version');
+/**
+ * Timeout ID for batching version checks.
+ */
+let versionCheckTimeout = null;
+/**
+ * Asserts that all `@dynamic-labs` packages are on the same version.
+ * Throws an error with instructions if versions mismatch.
+ *
+ * @param {string} packageName - The name of the package to assert.
+ * @param {string} version - The version of the package.
+ */
+const assertPackageVersion = (packageName, version) => {
+    // Update the package version mapping
+    packageVersions[packageName] = version;
+    // Clear any existing timeout
+    if (versionCheckTimeout) {
+        clearTimeout(versionCheckTimeout);
+        versionCheckTimeout = null;
+    }
+    /**
+     * Timeout is set to 100ms to ensure the following:
+     * - All package versions have been imported and registered.
+     * - The environmentId is set in the logger so the error can be captured in DD
+     */
+    const timeout = 100;
+    /**
+     * Set a timeout to batch the version check.
+     * This ensures that the check is executed after all package versions have been imported
+     * and registered.
+     */
+    versionCheckTimeout = setTimeout(() => {
+        const versions = Object.values(packageVersions);
+        const [firstVersion] = versions;
+        const allSameVersion = versions.every((v) => v === firstVersion);
+        if (!allSameVersion) {
+            // Determine the required (target) version
+            const targetVersion = packageVersions['@dynamic-labs/sdk-react-core'] || firstVersion;
+            const errorMessage = getErrorMessage(targetVersion);
+            logger.error(new Error(errorMessage));
+        }
+        versionCheckTimeout = null;
+    }, timeout);
+};
+const getErrorMessage = (targetVersion) => {
+    // Identify packages with mismatched versions
+    const affectedPackages = Object.entries(packageVersions)
+        .filter(([, v]) => v !== targetVersion)
+        .map(([pkgName, installedVersion]) => `- \`${pkgName}\` (installed: **${installedVersion}**, required: **${targetVersion}**)`)
+        .join('\n');
+    // Error message template
+    const errorMessage = `
+🚨 Version Mismatch Error
+
+One or more \`@dynamic-labs\` packages are installed with mismatched versions. All \`@dynamic-labs\` packages must be on the same version to work correctly.
+
+Affected Packages:
+${affectedPackages}
+
+💡 To fix this issue, update all @dynamic-labs/* packages to version \`${targetVersion}\` in your package.json
+💡 Tip: You can use the \`npx dynamic-doctor run\` command to check for other issues with your project setup.
+`;
+    return errorMessage.trim();
+};
+
+export { assertPackageVersion, logger, versionCheckTimeout };

package/src/lib/assertPackageVersion/index.d.ts

@@ -0,0 +1 @@
+export { assertPackageVersion } from './assertPackageVersion';