@sentry/cli 2.58.4 → 3.0.0

package/js/releases/index.d.ts

@@ -1,61 +1,45 @@
-export = Releases;
-/**
- * @typedef {import('../types').SentryCliUploadSourceMapsOptions} SentryCliUploadSourceMapsOptions
- * @typedef {import('../types').SourceMapsPathDescriptor} SourceMapsPathDescriptor
- * @typedef {import('../types').SentryCliNewDeployOptions} SentryCliNewDeployOptions
- * @typedef {import('../types').SentryCliCommitsOptions} SentryCliCommitsOptions
- */
+import { SentryCliCommitsOptions, SentryCliNewDeployOptions, SentryCliOptions, SentryCliUploadSourceMapsOptions } from '../types';
 /**
  * Manages releases and release artifacts on Sentry.
- * @namespace SentryReleases
  */
-declare class Releases {
-    /**
-     * Creates a new `Releases` instance.
-     *
-     * @param {Object} [options] More options to pass to the CLI
-     */
-    constructor(options?: any);
-    options: any;
-    configFile: any;
+export declare class Releases {
+    options: SentryCliOptions;
+    private configFile;
+    constructor(options: SentryCliOptions, configFile: string | null);
     /**
      * Registers a new release with sentry.
      *
      * The given release name should be unique and deterministic. It can later be used to
      * upload artifacts, such as source maps.
      *
-     * @param {string} release Unique name of the new release.
-     * @param {{projects?: string[]}} [options] The list of project slugs for a release.
-     * @returns {Promise<string>} A promise that resolves when the release has been created.
-     * @memberof SentryReleases
+     * @param release Unique name of the new release.
+     * @param options The list of project slugs for a release.
+     * @returns A promise that resolves when the release has been created.
      */
-    "new"(release: string, options?: {
+    new(release: string, options: {
         projects?: string[];
     }): Promise<string>;
     /**
      * Specifies the set of commits covered in this release.
      *
-     * @param {string} release Unique name of the release
-     * @param {SentryCliCommitsOptions} options A set of options to configure the commits to include
-     * @returns {Promise<string>} A promise that resolves when the commits have been associated
-     * @memberof SentryReleases
+     * @param release Unique name of the release
+     * @param options A set of options to configure the commits to include
+     * @returns A promise that resolves when the commits have been associated
      */
     setCommits(release: string, options: SentryCliCommitsOptions): Promise<string>;
     /**
      * Marks this release as complete. This should be called once all artifacts has been
      * uploaded.
      *
-     * @param {string} release Unique name of the release.
-     * @returns {Promise<string>} A promise that resolves when the release has been finalized.
-     * @memberof SentryReleases
+     * @param release Unique name of the release.
+     * @returns A promise that resolves when the release has been finalized.
      */
     finalize(release: string): Promise<string>;
     /**
      * Creates a unique, deterministic version identifier based on the project type and
      * source files. This identifier can be used as release name.
      *
-     * @returns {Promise<string>} A promise that resolves to the version string.
-     * @memberof SentryReleases
+     * @returns A promise that resolves to the version string.
      */
     proposeVersion(): Promise<string>;
     /**
@@ -85,23 +69,18 @@ declare class Releases {
      *   ext: ['js', 'map', 'jsbundle', 'bundle'],  // override file extensions to scan for
      *   projects: ['node'],        // provide a list of projects
      *   decompress: false          // decompress gzip files before uploading
-     *   live: true                 // whether to inherit stdio to display `sentry-cli` output directly.
      * });
      *
-     * @param {string} release Unique name of the release.
-     * @param {SentryCliUploadSourceMapsOptions & {live?: boolean | 'rejectOnError'}} options Options to configure the source map upload.
-     * @returns {Promise<string[]>} A promise that resolves when the upload has completed successfully.
-     * @memberof SentryReleases
+     * @param release Unique name of the release.
+     * @param options Options to configure the source map upload.
+     * @returns A promise that resolves when the upload has completed successfully.
      */
-    uploadSourceMaps(release: string, options: SentryCliUploadSourceMapsOptions & {
-        live?: boolean | "rejectOnError";
-    }): Promise<string[]>;
+    uploadSourceMaps(release: string, options: SentryCliUploadSourceMapsOptions): Promise<string[]>;
     /**
      * List all deploys for a given release.
      *
-     * @param {string} release Unique name of the release.
-     * @returns {Promise<string>} A promise that resolves when the list comes back from the server.
-     * @memberof SentryReleases
+     * @param release Unique name of the release.
+     * @returns A promise that resolves when the list comes back from the server.
      */
     listDeploys(release: string): Promise<string>;
     /**
@@ -121,28 +100,19 @@ declare class Releases {
      *   url: 'https://example.com', // URL that points to the deployment
      * });
      *
-     * @param {string} release Unique name of the release.
-     * @param {SentryCliNewDeployOptions} options Options to configure the new release deploy.
-     * @returns {Promise<string>} A promise that resolves when the deploy has been created.
-     * @memberof SentryReleases
+     * @param release Unique name of the release.
+     * @param options Options to configure the new release deploy.
+     * @returns A promise that resolves when the deploy has been created.
      */
     newDeploy(release: string, options: SentryCliNewDeployOptions): Promise<string>;
     /**
      * See {helper.execute} docs.
-     * @param {string[]} args Command line arguments passed to `sentry-cli`.
-     * @param {boolean | 'rejectOnError'} live can be set to:
-     *  - `true` to inherit stdio to display `sentry-cli` output directly.
-     *  - `false` to not inherit stdio and return the output as a string.
-     *  - `'rejectOnError'` to inherit stdio and reject the promise if the command
+     * @param args Command line arguments passed to `sentry-cli`.
+     * @param live can be set to:
+     *  - `true` to inherit stdio and reject the promise if the command
      *    exits with a non-zero exit code.
-     * @returns {Promise<string>} A promise that resolves to the standard output.
+     *  - `false` to not inherit stdio and return the output as a string.
+     * @returns A promise that resolves to the standard output.
      */
-    execute(args: string[], live: boolean | "rejectOnError"): Promise<string>;
-}
-declare namespace Releases {
-    export { SentryCliUploadSourceMapsOptions, SourceMapsPathDescriptor, SentryCliNewDeployOptions, SentryCliCommitsOptions };
+    execute(args: string[], live: boolean): Promise<string>;
 }
-type SentryCliUploadSourceMapsOptions = import("../types").SentryCliUploadSourceMapsOptions;
-type SourceMapsPathDescriptor = import("../types").SourceMapsPathDescriptor;
-type SentryCliNewDeployOptions = import("../types").SentryCliNewDeployOptions;
-type SentryCliCommitsOptions = import("../types").SentryCliCommitsOptions;

package/js/releases/index.js

@@ -8,44 +8,22 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-const helper = require('../helper');
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Releases = void 0;
+const deploys_1 = require("./options/deploys");
+const uploadSourcemaps_1 = require("./options/uploadSourcemaps");
+const helper = require("../helper");
 /**
  * Default arguments for the `--ignore` option.
- * @type {string[]}
  */
 const DEFAULT_IGNORE = ['node_modules'];
-/**
- * Schema for the `upload-sourcemaps` command.
- * @type {import('../helper').OptionsSchema}
- */
-const SOURCEMAPS_SCHEMA = require('./options/uploadSourcemaps');
-/**
- * Schema for the `deploys new` command.
- * @type {import('../helper').OptionsSchema}
- */
-const DEPLOYS_SCHEMA = require('./options/deploys');
-/**
- * @typedef {import('../types').SentryCliUploadSourceMapsOptions} SentryCliUploadSourceMapsOptions
- * @typedef {import('../types').SourceMapsPathDescriptor} SourceMapsPathDescriptor
- * @typedef {import('../types').SentryCliNewDeployOptions} SentryCliNewDeployOptions
- * @typedef {import('../types').SentryCliCommitsOptions} SentryCliCommitsOptions
- */
 /**
  * Manages releases and release artifacts on Sentry.
- * @namespace SentryReleases
  */
 class Releases {
-    /**
-     * Creates a new `Releases` instance.
-     *
-     * @param {Object} [options] More options to pass to the CLI
-     */
-    constructor(options) {
-        this.options = options || {};
-        if (typeof this.options.configFile === 'string') {
-            this.configFile = this.options.configFile;
-        }
-        delete this.options.configFile;
+    constructor(options = {}, configFile) {
+        this.options = options;
+        this.configFile = configFile;
     }
     /**
      * Registers a new release with sentry.
@@ -53,10 +31,9 @@ class Releases {
      * The given release name should be unique and deterministic. It can later be used to
      * upload artifacts, such as source maps.
      *
-     * @param {string} release Unique name of the new release.
-     * @param {{projects?: string[]}} [options] The list of project slugs for a release.
-     * @returns {Promise<string>} A promise that resolves when the release has been created.
-     * @memberof SentryReleases
+     * @param release Unique name of the new release.
+     * @param options The list of project slugs for a release.
+     * @returns A promise that resolves when the release has been created.
      */
     new(release, options) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -67,10 +44,9 @@ class Releases {
     /**
      * Specifies the set of commits covered in this release.
      *
-     * @param {string} release Unique name of the release
-     * @param {SentryCliCommitsOptions} options A set of options to configure the commits to include
-     * @returns {Promise<string>} A promise that resolves when the commits have been associated
-     * @memberof SentryReleases
+     * @param release Unique name of the release
+     * @param options A set of options to configure the commits to include
+     * @returns A promise that resolves when the commits have been associated
      */
     setCommits(release, options) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -97,9 +73,8 @@ class Releases {
      * Marks this release as complete. This should be called once all artifacts has been
      * uploaded.
      *
-     * @param {string} release Unique name of the release.
-     * @returns {Promise<string>} A promise that resolves when the release has been finalized.
-     * @memberof SentryReleases
+     * @param release Unique name of the release.
+     * @returns A promise that resolves when the release has been finalized.
      */
     finalize(release) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -110,8 +85,7 @@ class Releases {
      * Creates a unique, deterministic version identifier based on the project type and
      * source files. This identifier can be used as release name.
      *
-     * @returns {Promise<string>} A promise that resolves to the version string.
-     * @memberof SentryReleases
+     * @returns A promise that resolves to the version string.
      */
     proposeVersion() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -146,13 +120,11 @@ class Releases {
      *   ext: ['js', 'map', 'jsbundle', 'bundle'],  // override file extensions to scan for
      *   projects: ['node'],        // provide a list of projects
      *   decompress: false          // decompress gzip files before uploading
-     *   live: true                 // whether to inherit stdio to display `sentry-cli` output directly.
      * });
      *
-     * @param {string} release Unique name of the release.
-     * @param {SentryCliUploadSourceMapsOptions & {live?: boolean | 'rejectOnError'}} options Options to configure the source map upload.
-     * @returns {Promise<string[]>} A promise that resolves when the upload has completed successfully.
-     * @memberof SentryReleases
+     * @param release Unique name of the release.
+     * @param options Options to configure the source map upload.
+     * @returns A promise that resolves when the upload has completed successfully.
      */
     uploadSourceMaps(release, options) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -188,7 +160,7 @@ class Releases {
                     .concat(['--release', release]);
                 return uploadPaths.map((path) => 
                 // `execute()` is async and thus we're returning a promise here
-                this.execute(helper.prepareCommand([...args, path], SOURCEMAPS_SCHEMA, newOptions), options.live != null ? options.live : true));
+                this.execute(helper.prepareCommand([...args, path], uploadSourcemaps_1.SOURCEMAPS_OPTIONS, newOptions), true));
             });
             // `uploads` is an array of Promise arrays, which needs to be flattened
             // before being passed to `Promise.all()`. (`Array.flat()` doesn't exist in
@@ -201,9 +173,8 @@ class Releases {
     /**
      * List all deploys for a given release.
      *
-     * @param {string} release Unique name of the release.
-     * @returns {Promise<string>} A promise that resolves when the list comes back from the server.
-     * @memberof SentryReleases
+     * @param release Unique name of the release.
+     * @returns A promise that resolves when the list comes back from the server.
      */
     listDeploys(release) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -227,10 +198,9 @@ class Releases {
      *   url: 'https://example.com', // URL that points to the deployment
      * });
      *
-     * @param {string} release Unique name of the release.
-     * @param {SentryCliNewDeployOptions} options Options to configure the new release deploy.
-     * @returns {Promise<string>} A promise that resolves when the deploy has been created.
-     * @memberof SentryReleases
+     * @param release Unique name of the release.
+     * @param options Options to configure the new release deploy.
+     * @returns A promise that resolves when the deploy has been created.
      */
     newDeploy(release, options) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -238,18 +208,17 @@ class Releases {
                 throw new Error('options.env must be a valid name');
             }
             const args = ['releases', 'deploys', release, 'new'];
-            return this.execute(helper.prepareCommand(args, DEPLOYS_SCHEMA, options), null);
+            return this.execute(helper.prepareCommand(args, deploys_1.DEPLOYS_OPTIONS, options), null);
         });
     }
     /**
      * See {helper.execute} docs.
-     * @param {string[]} args Command line arguments passed to `sentry-cli`.
-     * @param {boolean | 'rejectOnError'} live can be set to:
-     *  - `true` to inherit stdio to display `sentry-cli` output directly.
-     *  - `false` to not inherit stdio and return the output as a string.
-     *  - `'rejectOnError'` to inherit stdio and reject the promise if the command
+     * @param args Command line arguments passed to `sentry-cli`.
+     * @param live can be set to:
+     *  - `true` to inherit stdio and reject the promise if the command
      *    exits with a non-zero exit code.
-     * @returns {Promise<string>} A promise that resolves to the standard output.
+     *  - `false` to not inherit stdio and return the output as a string.
+     * @returns A promise that resolves to the standard output.
      */
     execute(args, live) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -257,4 +226,4 @@ class Releases {
         });
     }
 }
-module.exports = Releases;
+exports.Releases = Releases;

package/js/releases/options/deploys.d.ts

@@ -1,2 +1,29 @@
-declare const _exports: import("../../helper").OptionsSchema;
-export = _exports;
+/**
+ * Schema for the `deploys new` command.
+ */
+export declare const DEPLOYS_OPTIONS: {
+    env: {
+        param: string;
+        type: "string";
+    };
+    started: {
+        param: string;
+        type: "number";
+    };
+    finished: {
+        param: string;
+        type: "number";
+    };
+    time: {
+        param: string;
+        type: "number";
+    };
+    name: {
+        param: string;
+        type: "string";
+    };
+    url: {
+        param: string;
+        type: "string";
+    };
+};

package/js/releases/options/deploys.js

@@ -1,7 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEPLOYS_OPTIONS = void 0;
 /**
- * @type {import('../../helper').OptionsSchema}
+ * Schema for the `deploys new` command.
  */
-module.exports = {
+exports.DEPLOYS_OPTIONS = {
     env: {
         param: '--env',
         type: 'string',

package/js/releases/options/uploadSourcemaps.d.ts

@@ -1,2 +1,58 @@
-declare const _exports: import("../../helper").OptionsSchema;
-export = _exports;
+/**
+ * Schema for the `upload-sourcemaps` command.
+ */
+export declare const SOURCEMAPS_OPTIONS: {
+    ignore: {
+        param: string;
+        type: "array";
+    };
+    ignoreFile: {
+        param: string;
+        type: "string";
+    };
+    dist: {
+        param: string;
+        type: "string";
+    };
+    decompress: {
+        param: string;
+        type: "boolean";
+    };
+    rewrite: {
+        param: string;
+        invertedParam: string;
+        type: "boolean";
+    };
+    sourceMapReference: {
+        invertedParam: string;
+        type: "boolean";
+    };
+    dedupe: {
+        invertedParam: string;
+        type: "boolean";
+    };
+    stripPrefix: {
+        param: string;
+        type: "array";
+    };
+    stripCommonPrefix: {
+        param: string;
+        type: "boolean";
+    };
+    validate: {
+        param: string;
+        type: "boolean";
+    };
+    urlPrefix: {
+        param: string;
+        type: "string";
+    };
+    urlSuffix: {
+        param: string;
+        type: "string";
+    };
+    ext: {
+        param: string;
+        type: "array";
+    };
+};

package/js/releases/options/uploadSourcemaps.js

@@ -1,7 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SOURCEMAPS_OPTIONS = void 0;
 /**
- * @type {import('../../helper').OptionsSchema}
+ * Schema for the `upload-sourcemaps` command.
  */
-module.exports = {
+exports.SOURCEMAPS_OPTIONS = {
     ignore: {
         param: '--ignore',
         type: 'array',
@@ -55,8 +58,4 @@ module.exports = {
         param: '--ext',
         type: 'array',
     },
-    useArtifactBundle: {
-        param: '--use-artifact-bundle',
-        type: 'boolean',
-    },
 };

package/js/types.d.ts

@@ -4,7 +4,7 @@
 /**
  * Options for configuring the Sentry CLI
  */
-export interface SentryCliOptions {
+export type SentryCliOptions = {
     /**
      * The URL of the Sentry instance you are connecting to. Defaults to https://sentry.io/.
      * This value will update `SENTRY_URL` env variable.
@@ -15,13 +15,6 @@ export interface SentryCliOptions {
      * This value will update `SENTRY_AUTH_TOKEN` env variable.
      */
     authToken?: string;
-    /**
-     * API key to authenticate any HTTP requests to Sentry (legacy authentication method).
-     * This value will update `SENTRY_API_KEY` env variable.
-     * @deprecated Use auth-token-based authentication via `authToken` instead.
-     *     This option is scheduled for removal in the next major release.
-     */
-    apiKey?: string;
     /**
      * Sentry DSN.
      * This value will update `SENTRY_DSN` env variable.
@@ -56,7 +49,7 @@ export interface SentryCliOptions {
      * This value does not set any env variable, and is overridden by `customHeader`.
      */
     headers?: Record<string, string>;
-}
+};
 /**
  * Custom upload-sourcemaps options for a particular `include` path. In this
  * case `paths` takes the place of `include` in the options so as to make it
@@ -68,7 +61,7 @@ export type SourceMapsPathDescriptor = Omit<SentryCliUploadSourceMapsOptions, 'i
 /**
  * Options for uploading source maps
  */
-export interface SentryCliUploadSourceMapsOptions {
+export type SentryCliUploadSourceMapsOptions = {
     /**
      * One or more paths that Sentry CLI should scan recursively for sources.
      * It will upload all .map files and match associated .js files.
@@ -141,19 +134,11 @@ export interface SentryCliUploadSourceMapsOptions {
      * Usually your build number.
      */
     dist?: string;
-    /**
-     * Force use of new Artifact Bundles upload, that enables use of Debug ID for Source Maps discovery,
-     * even when the Sentry server does not declare support for it.
-     *
-     * @deprecated This option is deprecated and will be removed in the next major version. Sentry CLI
-     *     should always respect what the server says it supports.
-     */
-    useArtifactBundle?: boolean;
-}
+};
 /**
  * Options for creating a new deployment
  */
-export interface SentryCliNewDeployOptions {
+export type SentryCliNewDeployOptions = {
     /**
      * Environment for this release. Values that make sense here would be `production` or `staging`.
      */
@@ -178,11 +163,11 @@ export interface SentryCliNewDeployOptions {
      * URL that points to the deployment.
      */
     url?: string;
-}
+};
 /**
  * Options for setting commits on a release
  */
-export interface SentryCliCommitsOptions {
+export type SentryCliCommitsOptions = {
     /**
      * Automatically choose the associated commit (uses the current commit). Overrides other setCommit options.
      */
@@ -210,21 +195,4 @@ export interface SentryCliCommitsOptions {
      * When the flag is set, command will not fail and just exit silently if no new commits for a given release have been found.
      */
     ignoreEmpty?: boolean;
-}
-/**
- * Release management interface
- */
-export interface SentryCliReleases {
-    new (release: string, options?: {
-        projects: string[];
-    } | string[]): Promise<string>;
-    setCommits(release: string, options: SentryCliCommitsOptions): Promise<string>;
-    finalize(release: string): Promise<string>;
-    proposeVersion(): Promise<string>;
-    uploadSourceMaps(release: string, options: SentryCliUploadSourceMapsOptions & {
-        live?: boolean | 'rejectOnError';
-    }): Promise<string[]>;
-    listDeploys(release: string): Promise<string>;
-    newDeploy(release: string, options: SentryCliNewDeployOptions): Promise<string>;
-    execute(args: string[], live: boolean | 'rejectOnError'): Promise<string>;
-}
+};

package/js/types.js

@@ -1,4 +1,5 @@
+"use strict";
 /**
  * TypeScript type definitions for @sentry/cli
  */
-export {};
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@sentry/cli",
-  "version": "2.58.4",
+  "version": "3.0.0",
   "description": "A command line utility to work with Sentry. https://docs.sentry.io/hosted/learn/cli/",
   "repository": "git://github.com/getsentry/sentry-cli.git",
   "homepage": "https://docs.sentry.io/hosted/learn/cli/",
   "author": "Sentry",
   "license": "FSL-1.1-MIT",
   "engines": {
-    "node": ">= 10"
+    "node": ">= 18"
   },
   "main": "js/index.js",
   "types": "js/index.d.ts",
@@ -15,10 +15,9 @@
     "sentry-cli": "bin/sentry-cli"
   },
   "dependencies": {
-    "https-proxy-agent": "^5.0.0",
-    "node-fetch": "^2.6.7",
     "progress": "^2.0.3",
     "proxy-from-env": "^1.1.0",
+    "undici": "^6.22.0",
     "which": "^2.0.2"
   },
   "devDependencies": {
@@ -29,22 +28,22 @@
     "jest": "^27.5.1",
     "npm-run-all": "^4.1.5",
     "prettier": "2.8.8",
+    "ts-jest": "^27.1.5",
     "typescript": "5.8.3"
   },
   "optionalDependencies": {
-    "@sentry/cli-darwin": "2.58.4",
-    "@sentry/cli-linux-arm": "2.58.4",
-    "@sentry/cli-linux-arm64": "2.58.4",
-    "@sentry/cli-linux-i686": "2.58.4",
-    "@sentry/cli-linux-x64": "2.58.4",
-    "@sentry/cli-win32-i686": "2.58.4",
-    "@sentry/cli-win32-x64": "2.58.4",
-    "@sentry/cli-win32-arm64": "2.58.4"
+    "@sentry/cli-darwin": "3.0.0",
+    "@sentry/cli-linux-arm": "3.0.0",
+    "@sentry/cli-linux-arm64": "3.0.0",
+    "@sentry/cli-linux-i686": "3.0.0",
+    "@sentry/cli-linux-x64": "3.0.0",
+    "@sentry/cli-win32-i686": "3.0.0",
+    "@sentry/cli-win32-x64": "3.0.0",
+    "@sentry/cli-win32-arm64": "3.0.0"
   },
   "scripts": {
     "postinstall": "node ./scripts/install.js",
     "build": "tsc",
-    "install-cli": "node ./scripts/install.js",
     "prepack": "npm run build",
     "fix": "npm-run-all fix:eslint fix:prettier",
     "fix:eslint": "eslint --fix bin/* scripts/**/*.js lib/**/*.js",