@vscode/python-environments 1.0.0 → 1.3.0

package/out/esm/main.mjs

@@ -0,0 +1,96 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+import { extensions } from 'vscode';
+/**
+ * Enum representing the kinds of environment changes.
+ */
+export var EnvironmentChangeKind;
+(function (EnvironmentChangeKind) {
+    /**
+     * Indicates that an environment was added.
+     */
+    EnvironmentChangeKind["add"] = "add";
+    /**
+     * Indicates that an environment was removed.
+     */
+    EnvironmentChangeKind["remove"] = "remove";
+})(EnvironmentChangeKind || (EnvironmentChangeKind = {}));
+/**
+ * Enum representing the kinds of package changes.
+ */
+export var PackageChangeKind;
+(function (PackageChangeKind) {
+    /**
+     * Indicates that a package was added.
+     */
+    PackageChangeKind["add"] = "add";
+    /**
+     * Indicates that a package was removed.
+     */
+    PackageChangeKind["remove"] = "remove";
+})(PackageChangeKind || (PackageChangeKind = {}));
+/**
+ * Error thrown when a package manager cannot list available package versions.
+ *
+ * This distinguishes an *unsupported capability* from an *operational failure* (such as a
+ * failed command, a network error, or malformed/unparseable output). Consumers of
+ * {@link PythonPackageGetterApi.getPackageAvailableVersions} should treat this specific error
+ * as a signal to fall back to manual version entry, while letting any other error propagate.
+ *
+ * The {@link code} property carries a stable, string-literal discriminator so the error can be
+ * recognized reliably across extension bundle boundaries, where `instanceof` may fail because
+ * each bundle can load its own copy of this class. Prefer {@link isPackageVersionLookupNotSupportedError}
+ * over a bare `instanceof` check for that reason.
+ */
+export class PackageVersionLookupNotSupportedError extends Error {
+    constructor(message) {
+        super(message ?? 'The package manager does not support looking up available package versions.');
+        /**
+         * Stable discriminator identifying this error type across bundle boundaries.
+         */
+        this.code = 'PackageVersionLookupNotSupported';
+        this.name = 'PackageVersionLookupNotSupportedError';
+        // Preserve the prototype chain when this class is transpiled to older targets so that
+        // `instanceof` continues to work within a single bundle.
+        Object.setPrototypeOf(this, PackageVersionLookupNotSupportedError.prototype);
+    }
+}
+/**
+ * Type guard reporting whether an error represents unsupported package version lookup.
+ *
+ * Uses the stable {@link PackageVersionLookupNotSupportedError.code} discriminator, so it returns
+ * `true` even when the error crossed an extension bundle boundary and `instanceof` would fail.
+ *
+ * @param error The value to test.
+ * @returns `true` if `error` is a {@link PackageVersionLookupNotSupportedError} (or a structurally
+ *          equivalent error carrying the same `code`).
+ */
+export function isPackageVersionLookupNotSupportedError(error) {
+    return (error instanceof PackageVersionLookupNotSupportedError ||
+        (typeof error === 'object' &&
+            error !== null &&
+            'code' in error &&
+            error.code === 'PackageVersionLookupNotSupported'));
+}
+export const EXTENSION_ID = 'ms-python.vscode-python-envs';
+export var PythonEnvironments;
+(function (PythonEnvironments) {
+    /**
+     * Returns the API exposed by the Python Environments extension in VS Code.
+     */
+    async function api() {
+        const extension = extensions.getExtension(EXTENSION_ID);
+        if (extension === undefined) {
+            throw new Error(`Python Environments extension (${EXTENSION_ID}) is not installed or is disabled`);
+        }
+        if (!extension.isActive) {
+            await extension.activate();
+        }
+        const api = extension.exports;
+        if (!api) {
+            throw new Error(`Python Environments extension (${EXTENSION_ID}) did not expose its API. Ensure "python.useEnvironmentsExtension" is enabled and reload the window.`);
+        }
+        return api;
+    }
+    PythonEnvironments.api = api;
+})(PythonEnvironments || (PythonEnvironments = {}));

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@vscode/python-environments",
     "description": "An API facade for the Python Environments extension in VS Code",
-    "version": "1.0.0",
+    "version": "1.3.0",
     "author": {
         "name": "Microsoft Corporation"
     },
@@ -11,8 +11,18 @@
         "API",
         "Environments"
     ],
-    "main": "./out/main.js",
-    "types": "./out/main.d.ts",
+    "main": "./out/cjs/main.cjs",
+    "types": "./out/cjs/main.d.ts",
+    "exports": {
+        "import": {
+            "types": "./out/esm/main.d.ts",
+            "default": "./out/esm/main.mjs"
+        },
+        "require": {
+            "types": "./out/cjs/main.d.ts",
+            "default": "./out/cjs/main.cjs"
+        }
+    },
     "engines": {
         "node": ">=22.21.1",
         "vscode": "^1.110.0"
@@ -30,12 +40,19 @@
         "prepublishOnly": "echo \"⛔ Can only publish from a secure pipeline ⛔\" && node -e \"process.exitCode = 1\"",
         "prepack": "npm run all:publish",
         "all:publish": "git clean -xfd . && npm install && npm run compile",
-        "compile": "tsc -b ./tsconfig.json",
-        "clean": "node -e \"const fs = require('fs'); fs.rmSync('./out', { recursive: true, force: true });\""
+        "compile": "npm run compile:esm && npm run compile:cjs",
+        "compile:esm": "tsc -b ./tsconfig.esm.json && mve out/esm/main.js out/esm/main.mjs",
+        "compile:cjs": "tsc -b ./tsconfig.cjs.json && mve out/cjs/main.js out/cjs/main.cjs",
+        "clean": "node -e \"const fs = require('fs'); fs.rmSync('./out', { recursive: true, force: true });\"",
+        "test:package": "node ./scripts/test-package.cjs"
     },
     "devDependencies": {
         "@types/node": "^22.0.0",
         "@types/vscode": "^1.99.0",
+        "mve": "^0.1.2",
         "typescript": "^5.1.3"
+    },
+    "dependencies": {
+        "@renovatebot/pep440": "^3.1.0"
     }
 }

package/out/main.js

@@ -1,54 +0,0 @@
-"use strict";
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PythonEnvironments = exports.EXTENSION_ID = exports.PackageChangeKind = exports.EnvironmentChangeKind = void 0;
-const vscode_1 = require("vscode");
-/**
- * Enum representing the kinds of environment changes.
- */
-var EnvironmentChangeKind;
-(function (EnvironmentChangeKind) {
-    /**
-     * Indicates that an environment was added.
-     */
-    EnvironmentChangeKind["add"] = "add";
-    /**
-     * Indicates that an environment was removed.
-     */
-    EnvironmentChangeKind["remove"] = "remove";
-})(EnvironmentChangeKind || (exports.EnvironmentChangeKind = EnvironmentChangeKind = {}));
-/**
- * Enum representing the kinds of package changes.
- */
-var PackageChangeKind;
-(function (PackageChangeKind) {
-    /**
-     * Indicates that a package was added.
-     */
-    PackageChangeKind["add"] = "add";
-    /**
-     * Indicates that a package was removed.
-     */
-    PackageChangeKind["remove"] = "remove";
-})(PackageChangeKind || (exports.PackageChangeKind = PackageChangeKind = {}));
-exports.EXTENSION_ID = 'ms-python.vscode-python-envs';
-// eslint-disable-next-line @typescript-eslint/no-namespace
-var PythonEnvironments;
-(function (PythonEnvironments) {
-    /**
-     * Returns the API exposed by the Python Environments extension in VS Code.
-     */
-    async function api() {
-        const extension = vscode_1.extensions.getExtension(exports.EXTENSION_ID);
-        if (extension === undefined) {
-            throw new Error(`Python Environments extension is not installed or is disabled`);
-        }
-        if (!extension.isActive) {
-            await extension.activate();
-        }
-        const pythonEnvsApi = extension.exports;
-        return pythonEnvsApi;
-    }
-    PythonEnvironments.api = api;
-})(PythonEnvironments || (exports.PythonEnvironments = PythonEnvironments = {}));