@sentry/wizard 3.12.0 → 3.13.0

package/dist/src/sveltekit/sveltekit-wizard.js

@@ -1,4 +1,27 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -39,102 +62,154 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.runSvelteKitWizard = void 0;
+exports.runSvelteKitWizardWithTelemetry = exports.runSvelteKitWizard = void 0;
 // @ts-ignore - clack is ESM and TS complains about that. It works though
-var prompts_1 = __importDefault(require("@clack/prompts"));
+var clack = __importStar(require("@clack/prompts"));
 var chalk_1 = __importDefault(require("chalk"));
+var Sentry = __importStar(require("@sentry/node"));
 var clack_utils_1 = require("../utils/clack-utils");
 var package_json_1 = require("../utils/package-json");
 var sdk_example_1 = require("./sdk-example");
 var sdk_setup_1 = require("./sdk-setup");
+var telemetry_1 = require("../telemetry");
+var utils_1 = require("./utils");
 function runSvelteKitWizard(options) {
     return __awaiter(this, void 0, void 0, function () {
-        var packageJson, _a, selectedProject, selfHosted, sentryUrl, authToken, svelteConfig, e_1, e_2;
+        return __generator(this, function (_a) {
+            return [2 /*return*/, (0, telemetry_1.withTelemetry)({
+                    enabled: options.telemetryEnabled,
+                    integration: 'sveltekit',
+                }, function () { return runSvelteKitWizardWithTelemetry(options); })];
+        });
+    });
+}
+exports.runSvelteKitWizard = runSvelteKitWizard;
+function runSvelteKitWizardWithTelemetry(options) {
+    return __awaiter(this, void 0, void 0, function () {
+        var packageJson, kitVersion, kitVersionBucket, shouldContinue, _a, selectedProject, selfHosted, sentryUrl, authToken, sdkAlreadyInstalled, svelteConfig, e_1, e_2;
         return __generator(this, function (_b) {
             switch (_b.label) {
                 case 0:
                     (0, clack_utils_1.printWelcome)({
                         wizardName: 'Sentry SvelteKit Wizard',
                         promoCode: options.promoCode,
+                        telemetryEnabled: options.telemetryEnabled,
                     });
-                    return [4 /*yield*/, (0, clack_utils_1.confirmContinueEvenThoughNoGitRepo)()];
+                    return [4 /*yield*/, (0, telemetry_1.traceStep)('detect-git', clack_utils_1.confirmContinueEvenThoughNoGitRepo)];
                 case 1:
                     _b.sent();
                     return [4 /*yield*/, (0, clack_utils_1.getPackageDotJson)()];
                 case 2:
                     packageJson = _b.sent();
-                    return [4 /*yield*/, (0, clack_utils_1.ensurePackageIsInstalled)(packageJson, '@sveltejs/kit', 'Sveltekit')];
+                    return [4 /*yield*/, (0, telemetry_1.traceStep)('detect-framework-version', function () {
+                            return (0, clack_utils_1.ensurePackageIsInstalled)(packageJson, '@sveltejs/kit', 'Sveltekit');
+                        })];
                 case 3:
                     _b.sent();
-                    return [4 /*yield*/, (0, clack_utils_1.getOrAskForProjectData)(options, 'javascript-sveltekit')];
+                    kitVersion = (0, package_json_1.getPackageVersion)('@sveltejs/kit', packageJson);
+                    kitVersionBucket = (0, utils_1.getKitVersionBucket)(kitVersion);
+                    Sentry.setTag('sveltekit-version', kitVersionBucket);
+                    if (!(kitVersionBucket === '0.x')) return [3 /*break*/, 6];
+                    clack.log.warn("It seems you're using a SvelteKit version <1.0.0 which is not supported by Sentry.\nWe recommend upgrading to the latest 1.x version before you continue.");
+                    return [4 /*yield*/, (0, clack_utils_1.abortIfCancelled)(clack.select({
+                            message: 'Do you want to continue anyway?',
+                            options: [
+                                {
+                                    label: 'Yes, continue',
+                                    hint: 'The SDK might not work correctly',
+                                    value: true,
+                                },
+                                { label: "No, I'll upgrade first", value: false },
+                            ],
+                        }))];
                 case 4:
-                    _a = _b.sent(), selectedProject = _a.selectedProject, selfHosted = _a.selfHosted, sentryUrl = _a.sentryUrl, authToken = _a.authToken;
-                    return [4 /*yield*/, (0, clack_utils_1.installPackage)({
-                            packageName: '@sentry/sveltekit',
-                            alreadyInstalled: (0, package_json_1.hasPackageInstalled)('@sentry/sveltekit', packageJson),
-                        })];
+                    shouldContinue = _b.sent();
+                    if (!!shouldContinue) return [3 /*break*/, 6];
+                    return [4 /*yield*/, (0, clack_utils_1.abort)('Exiting Wizard', 0)];
                 case 5:
                     _b.sent();
-                    return [4 /*yield*/, (0, clack_utils_1.addSentryCliConfig)(authToken)];
+                    return [2 /*return*/];
                 case 6:
-                    _b.sent();
-                    return [4 /*yield*/, (0, sdk_setup_1.loadSvelteConfig)()];
+                    Sentry.setTag('svelte-version', (0, utils_1.getSvelteVersionBucket)((0, package_json_1.getPackageVersion)('svelte', packageJson)));
+                    return [4 /*yield*/, (0, clack_utils_1.getOrAskForProjectData)(options, 'javascript-sveltekit')];
                 case 7:
-                    svelteConfig = _b.sent();
-                    _b.label = 8;
+                    _a = _b.sent(), selectedProject = _a.selectedProject, selfHosted = _a.selfHosted, sentryUrl = _a.sentryUrl, authToken = _a.authToken;
+                    sdkAlreadyInstalled = (0, package_json_1.hasPackageInstalled)('@sentry/sveltekit', packageJson);
+                    Sentry.setTag('sdk-already-installed', sdkAlreadyInstalled);
+                    return [4 /*yield*/, (0, telemetry_1.traceStep)('install-sdk', function () {
+                            return (0, clack_utils_1.installPackage)({
+                                packageName: '@sentry/sveltekit',
+                                alreadyInstalled: sdkAlreadyInstalled,
+                            });
+                        })];
                 case 8:
-                    _b.trys.push([8, 10, , 12]);
-                    return [4 /*yield*/, (0, sdk_setup_1.createOrMergeSvelteKitFiles)({
-                            dsn: selectedProject.keys[0].dsn.public,
-                            org: selectedProject.organization.slug,
-                            project: selectedProject.slug,
-                            selfHosted: selfHosted,
-                            url: sentryUrl,
-                        }, svelteConfig)];
+                    _b.sent();
+                    return [4 /*yield*/, (0, telemetry_1.traceStep)('add-cli-config', function () { return (0, clack_utils_1.addSentryCliConfig)(authToken); })];
                 case 9:
                     _b.sent();
-                    return [3 /*break*/, 12];
+                    return [4 /*yield*/, (0, telemetry_1.traceStep)('load-svelte-config', sdk_setup_1.loadSvelteConfig)];
                 case 10:
+                    svelteConfig = _b.sent();
+                    _b.label = 11;
+                case 11:
+                    _b.trys.push([11, 13, , 15]);
+                    return [4 /*yield*/, (0, telemetry_1.traceStep)('configure-sdk', function () {
+                            return (0, sdk_setup_1.createOrMergeSvelteKitFiles)({
+                                dsn: selectedProject.keys[0].dsn.public,
+                                org: selectedProject.organization.slug,
+                                project: selectedProject.slug,
+                                selfHosted: selfHosted,
+                                url: sentryUrl,
+                            }, svelteConfig);
+                        })];
+                case 12:
+                    _b.sent();
+                    return [3 /*break*/, 15];
+                case 13:
                     e_1 = _b.sent();
-                    prompts_1.default.log.error('Error while setting up the SvelteKit SDK:');
-                    prompts_1.default.log.info(chalk_1.default.dim(typeof e_1 === 'object' && e_1 != null && 'toString' in e_1
+                    clack.log.error('Error while setting up the SvelteKit SDK:');
+                    clack.log.info(chalk_1.default.dim(typeof e_1 === 'object' && e_1 != null && 'toString' in e_1
                         ? e_1.toString()
                         : typeof e_1 === 'string'
                             ? e_1
                             : 'Unknown error'));
+                    Sentry.captureException('Error while setting up the SvelteKit SDK');
                     return [4 /*yield*/, (0, clack_utils_1.abort)('Exiting Wizard')];
-                case 11:
+                case 14:
                     _b.sent();
                     return [2 /*return*/];
-                case 12:
-                    _b.trys.push([12, 14, , 16]);
-                    return [4 /*yield*/, (0, sdk_example_1.createExamplePage)(svelteConfig, {
-                            selfHosted: selfHosted,
-                            url: sentryUrl,
-                            orgSlug: selectedProject.organization.slug,
-                            projectId: selectedProject.id,
+                case 15:
+                    _b.trys.push([15, 17, , 19]);
+                    return [4 /*yield*/, (0, telemetry_1.traceStep)('create-example-page', function () {
+                            return (0, sdk_example_1.createExamplePage)(svelteConfig, {
+                                selfHosted: selfHosted,
+                                url: sentryUrl,
+                                orgSlug: selectedProject.organization.slug,
+                                projectId: selectedProject.id,
+                            });
                         })];
-                case 13:
+                case 16:
                     _b.sent();
-                    return [3 /*break*/, 16];
-                case 14:
+                    return [3 /*break*/, 19];
+                case 17:
                     e_2 = _b.sent();
-                    prompts_1.default.log.error('Error while creating an example page to test Sentry:');
-                    prompts_1.default.log.info(chalk_1.default.dim(typeof e_2 === 'object' && e_2 != null && 'toString' in e_2
+                    clack.log.error('Error while creating an example page to test Sentry:');
+                    clack.log.info(chalk_1.default.dim(typeof e_2 === 'object' && e_2 != null && 'toString' in e_2
                         ? e_2.toString()
                         : typeof e_2 === 'string'
                             ? e_2
                             : 'Unknown error'));
+                    Sentry.captureException('Error while creating an example Svelte page to test Sentry');
                     return [4 /*yield*/, (0, clack_utils_1.abort)('Exiting Wizard')];
-                case 15:
+                case 18:
                     _b.sent();
                     return [2 /*return*/];
-                case 16:
-                    prompts_1.default.outro("\n".concat(chalk_1.default.green('Successfully installed the Sentry SvelteKit SDK!'), "\n\n").concat(chalk_1.default.cyan('You can validate your setup by starting your dev environment (`npm run dev`) and visiting "/sentry-example".'), "\n\nCheck out the SDK documentation for further configuration:\nhttps://docs.sentry.io/platforms/javascript/guides/sveltekit/\n  "));
+                case 19:
+                    clack.outro("\n".concat(chalk_1.default.green('Successfully installed the Sentry SvelteKit SDK!'), "\n\n").concat(chalk_1.default.cyan('You can validate your setup by starting your dev environment (`npm run dev`) and visiting "/sentry-example".'), "\n\nCheck out the SDK documentation for further configuration:\nhttps://docs.sentry.io/platforms/javascript/guides/sveltekit/\n  "));
                     return [2 /*return*/];
             }
         });
     });
 }
-exports.runSvelteKitWizard = runSvelteKitWizard;
+exports.runSvelteKitWizardWithTelemetry = runSvelteKitWizardWithTelemetry;
 //# sourceMappingURL=sveltekit-wizard.js.map

package/dist/src/sveltekit/sveltekit-wizard.js.map

@@ -1 +1 @@
-{"version":3,"file":"sveltekit-wizard.js","sourceRoot":"","sources":["../../../src/sveltekit/sveltekit-wizard.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yEAAyE;AACzE,2DAAmC;AACnC,gDAA0B;AAE1B,oDAS8B;AAC9B,sDAA4D;AAE5D,6CAAkD;AAClD,yCAA4E;AAE5E,SAAsB,kBAAkB,CACtC,OAAsB;;;;;;oBAEtB,IAAA,0BAAY,EAAC;wBACX,UAAU,EAAE,yBAAyB;wBACrC,SAAS,EAAE,OAAO,CAAC,SAAS;qBAC7B,CAAC,CAAC;oBAEH,qBAAM,IAAA,gDAAkC,GAAE,EAAA;;oBAA1C,SAA0C,CAAC;oBAEvB,qBAAM,IAAA,+BAAiB,GAAE,EAAA;;oBAAvC,WAAW,GAAG,SAAyB;oBAC7C,qBAAM,IAAA,sCAAwB,EAAC,WAAW,EAAE,eAAe,EAAE,WAAW,CAAC,EAAA;;oBAAzE,SAAyE,CAAC;oBAGxE,qBAAM,IAAA,oCAAsB,EAAC,OAAO,EAAE,sBAAsB,CAAC,EAAA;;oBADzD,KACJ,SAA6D,EADvD,eAAe,qBAAA,EAAE,UAAU,gBAAA,EAAE,SAAS,eAAA,EAAE,SAAS,eAAA;oBAGzD,qBAAM,IAAA,4BAAc,EAAC;4BACnB,WAAW,EAAE,mBAAmB;4BAChC,gBAAgB,EAAE,IAAA,kCAAmB,EAAC,mBAAmB,EAAE,WAAW,CAAC;yBACxE,CAAC,EAAA;;oBAHF,SAGE,CAAC;oBAEH,qBAAM,IAAA,gCAAkB,EAAC,SAAS,CAAC,EAAA;;oBAAnC,SAAmC,CAAC;oBAEf,qBAAM,IAAA,4BAAgB,GAAE,EAAA;;oBAAvC,YAAY,GAAG,SAAwB;;;;oBAG3C,qBAAM,IAAA,uCAA2B,EAC/B;4BACE,GAAG,EAAE,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM;4BACvC,GAAG,EAAE,eAAe,CAAC,YAAY,CAAC,IAAI;4BACtC,OAAO,EAAE,eAAe,CAAC,IAAI;4BAC7B,UAAU,YAAA;4BACV,GAAG,EAAE,SAAS;yBACf,EACD,YAAY,CACb,EAAA;;oBATD,SASC,CAAC;;;;oBAEF,iBAAK,CAAC,GAAG,CAAC,KAAK,CAAC,2CAA2C,CAAC,CAAC;oBAC7D,iBAAK,CAAC,GAAG,CAAC,IAAI,CACZ,eAAK,CAAC,GAAG,CACP,OAAO,GAAC,KAAK,QAAQ,IAAI,GAAC,IAAI,IAAI,IAAI,UAAU,IAAI,GAAC;wBACnD,CAAC,CAAC,GAAC,CAAC,QAAQ,EAAE;wBACd,CAAC,CAAC,OAAO,GAAC,KAAK,QAAQ;4BACvB,CAAC,CAAC,GAAC;4BACH,CAAC,CAAC,eAAe,CACpB,CACF,CAAC;oBACF,qBAAM,IAAA,mBAAK,EAAC,gBAAgB,CAAC,EAAA;;oBAA7B,SAA6B,CAAC;oBAC9B,sBAAO;;;oBAIP,qBAAM,IAAA,+BAAiB,EAAC,YAAY,EAAE;4BACpC,UAAU,YAAA;4BACV,GAAG,EAAE,SAAS;4BACd,OAAO,EAAE,eAAe,CAAC,YAAY,CAAC,IAAI;4BAC1C,SAAS,EAAE,eAAe,CAAC,EAAE;yBAC9B,CAAC,EAAA;;oBALF,SAKE,CAAC;;;;oBAEH,iBAAK,CAAC,GAAG,CAAC,KAAK,CAAC,sDAAsD,CAAC,CAAC;oBACxE,iBAAK,CAAC,GAAG,CAAC,IAAI,CACZ,eAAK,CAAC,GAAG,CACP,OAAO,GAAC,KAAK,QAAQ,IAAI,GAAC,IAAI,IAAI,IAAI,UAAU,IAAI,GAAC;wBACnD,CAAC,CAAC,GAAC,CAAC,QAAQ,EAAE;wBACd,CAAC,CAAC,OAAO,GAAC,KAAK,QAAQ;4BACvB,CAAC,CAAC,GAAC;4BACH,CAAC,CAAC,eAAe,CACpB,CACF,CAAC;oBACF,qBAAM,IAAA,mBAAK,EAAC,gBAAgB,CAAC,EAAA;;oBAA7B,SAA6B,CAAC;oBAC9B,sBAAO;;oBAGT,iBAAK,CAAC,KAAK,CAAC,YACZ,eAAK,CAAC,KAAK,CAAC,kDAAkD,CAAC,iBAE/D,eAAK,CAAC,IAAI,CACV,8GAA8G,CAC/G,sIAIE,CAAC,CAAC;;;;;CACJ;AAnFD,gDAmFC","sourcesContent":["// @ts-ignore - clack is ESM and TS complains about that. It works though\nimport clack from '@clack/prompts';\nimport chalk from 'chalk';\n\nimport {\n  abort,\n  addSentryCliConfig,\n  confirmContinueEvenThoughNoGitRepo,\n  ensurePackageIsInstalled,\n  getOrAskForProjectData,\n  getPackageDotJson,\n  installPackage,\n  printWelcome,\n} from '../utils/clack-utils';\nimport { hasPackageInstalled } from '../utils/package-json';\nimport { WizardOptions } from '../utils/types';\nimport { createExamplePage } from './sdk-example';\nimport { createOrMergeSvelteKitFiles, loadSvelteConfig } from './sdk-setup';\n\nexport async function runSvelteKitWizard(\n  options: WizardOptions,\n): Promise<void> {\n  printWelcome({\n    wizardName: 'Sentry SvelteKit Wizard',\n    promoCode: options.promoCode,\n  });\n\n  await confirmContinueEvenThoughNoGitRepo();\n\n  const packageJson = await getPackageDotJson();\n  await ensurePackageIsInstalled(packageJson, '@sveltejs/kit', 'Sveltekit');\n\n  const { selectedProject, selfHosted, sentryUrl, authToken } =\n    await getOrAskForProjectData(options, 'javascript-sveltekit');\n\n  await installPackage({\n    packageName: '@sentry/sveltekit',\n    alreadyInstalled: hasPackageInstalled('@sentry/sveltekit', packageJson),\n  });\n\n  await addSentryCliConfig(authToken);\n\n  const svelteConfig = await loadSvelteConfig();\n\n  try {\n    await createOrMergeSvelteKitFiles(\n      {\n        dsn: selectedProject.keys[0].dsn.public,\n        org: selectedProject.organization.slug,\n        project: selectedProject.slug,\n        selfHosted,\n        url: sentryUrl,\n      },\n      svelteConfig,\n    );\n  } catch (e: unknown) {\n    clack.log.error('Error while setting up the SvelteKit SDK:');\n    clack.log.info(\n      chalk.dim(\n        typeof e === 'object' && e != null && 'toString' in e\n          ? e.toString()\n          : typeof e === 'string'\n          ? e\n          : 'Unknown error',\n      ),\n    );\n    await abort('Exiting Wizard');\n    return;\n  }\n\n  try {\n    await createExamplePage(svelteConfig, {\n      selfHosted,\n      url: sentryUrl,\n      orgSlug: selectedProject.organization.slug,\n      projectId: selectedProject.id,\n    });\n  } catch (e: unknown) {\n    clack.log.error('Error while creating an example page to test Sentry:');\n    clack.log.info(\n      chalk.dim(\n        typeof e === 'object' && e != null && 'toString' in e\n          ? e.toString()\n          : typeof e === 'string'\n          ? e\n          : 'Unknown error',\n      ),\n    );\n    await abort('Exiting Wizard');\n    return;\n  }\n\n  clack.outro(`\n${chalk.green('Successfully installed the Sentry SvelteKit SDK!')}\n\n${chalk.cyan(\n  'You can validate your setup by starting your dev environment (`npm run dev`) and visiting \"/sentry-example\".',\n)}\n\nCheck out the SDK documentation for further configuration:\nhttps://docs.sentry.io/platforms/javascript/guides/sveltekit/\n  `);\n}\n"]}
+{"version":3,"file":"sveltekit-wizard.js","sourceRoot":"","sources":["../../../src/sveltekit/sveltekit-wizard.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yEAAyE;AACzE,oDAAwC;AACxC,gDAA0B;AAE1B,mDAAuC;AAEvC,oDAU8B;AAC9B,sDAA+E;AAE/E,6CAAkD;AAClD,yCAA4E;AAC5E,0CAAwD;AACxD,iCAAsE;AAEtE,SAAsB,kBAAkB,CACtC,OAAsB;;;YAEtB,sBAAO,IAAA,yBAAa,EAClB;oBACE,OAAO,EAAE,OAAO,CAAC,gBAAgB;oBACjC,WAAW,EAAE,WAAW;iBACzB,EACD,cAAM,OAAA,+BAA+B,CAAC,OAAO,CAAC,EAAxC,CAAwC,CAC/C,EAAC;;;CACH;AAVD,gDAUC;AAED,SAAsB,+BAA+B,CACnD,OAAsB;;;;;;oBAEtB,IAAA,0BAAY,EAAC;wBACX,UAAU,EAAE,yBAAyB;wBACrC,SAAS,EAAE,OAAO,CAAC,SAAS;wBAC5B,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;qBAC3C,CAAC,CAAC;oBAEH,qBAAM,IAAA,qBAAS,EAAC,YAAY,EAAE,gDAAkC,CAAC,EAAA;;oBAAjE,SAAiE,CAAC;oBAE9C,qBAAM,IAAA,+BAAiB,GAAE,EAAA;;oBAAvC,WAAW,GAAG,SAAyB;oBAC7C,qBAAM,IAAA,qBAAS,EAAC,0BAA0B,EAAE;4BAC1C,OAAA,IAAA,sCAAwB,EAAC,WAAW,EAAE,eAAe,EAAE,WAAW,CAAC;wBAAnE,CAAmE,CACpE,EAAA;;oBAFD,SAEC,CAAC;oBAEI,UAAU,GAAG,IAAA,gCAAiB,EAAC,eAAe,EAAE,WAAW,CAAC,CAAC;oBAC7D,gBAAgB,GAAG,IAAA,2BAAmB,EAAC,UAAU,CAAC,CAAC;oBACzD,MAAM,CAAC,MAAM,CAAC,mBAAmB,EAAE,gBAAgB,CAAC,CAAC;yBAEjD,CAAA,gBAAgB,KAAK,KAAK,CAAA,EAA1B,wBAA0B;oBAC5B,KAAK,CAAC,GAAG,CAAC,IAAI,CACZ,2JAA2J,CAC5J,CAAC;oBACqB,qBAAM,IAAA,8BAAgB,EAC3C,KAAK,CAAC,MAAM,CAAC;4BACX,OAAO,EAAE,iCAAiC;4BAC1C,OAAO,EAAE;gCACP;oCACE,KAAK,EAAE,eAAe;oCACtB,IAAI,EAAE,kCAAkC;oCACxC,KAAK,EAAE,IAAI;iCACZ;gCACD,EAAE,KAAK,EAAE,wBAAwB,EAAE,KAAK,EAAE,KAAK,EAAE;6BAClD;yBACF,CAAC,CACH,EAAA;;oBAZK,cAAc,GAAG,SAYtB;yBACG,CAAC,cAAc,EAAf,wBAAe;oBACjB,qBAAM,IAAA,mBAAK,EAAC,gBAAgB,EAAE,CAAC,CAAC,EAAA;;oBAAhC,SAAgC,CAAC;oBACjC,sBAAO;;oBAIX,MAAM,CAAC,MAAM,CACX,gBAAgB,EAChB,IAAA,8BAAsB,EAAC,IAAA,gCAAiB,EAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,CACjE,CAAC;oBAGA,qBAAM,IAAA,oCAAsB,EAAC,OAAO,EAAE,sBAAsB,CAAC,EAAA;;oBADzD,KACJ,SAA6D,EADvD,eAAe,qBAAA,EAAE,UAAU,gBAAA,EAAE,SAAS,eAAA,EAAE,SAAS,eAAA;oBAGnD,mBAAmB,GAAG,IAAA,kCAAmB,EAC7C,mBAAmB,EACnB,WAAW,CACZ,CAAC;oBACF,MAAM,CAAC,MAAM,CAAC,uBAAuB,EAAE,mBAAmB,CAAC,CAAC;oBAE5D,qBAAM,IAAA,qBAAS,EAAC,aAAa,EAAE;4BAC7B,OAAA,IAAA,4BAAc,EAAC;gCACb,WAAW,EAAE,mBAAmB;gCAChC,gBAAgB,EAAE,mBAAmB;6BACtC,CAAC;wBAHF,CAGE,CACH,EAAA;;oBALD,SAKC,CAAC;oBAEF,qBAAM,IAAA,qBAAS,EAAC,gBAAgB,EAAE,cAAM,OAAA,IAAA,gCAAkB,EAAC,SAAS,CAAC,EAA7B,CAA6B,CAAC,EAAA;;oBAAtE,SAAsE,CAAC;oBAElD,qBAAM,IAAA,qBAAS,EAAC,oBAAoB,EAAE,4BAAgB,CAAC,EAAA;;oBAAtE,YAAY,GAAG,SAAuD;;;;oBAG1E,qBAAM,IAAA,qBAAS,EAAC,eAAe,EAAE;4BAC/B,OAAA,IAAA,uCAA2B,EACzB;gCACE,GAAG,EAAE,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM;gCACvC,GAAG,EAAE,eAAe,CAAC,YAAY,CAAC,IAAI;gCACtC,OAAO,EAAE,eAAe,CAAC,IAAI;gCAC7B,UAAU,YAAA;gCACV,GAAG,EAAE,SAAS;6BACf,EACD,YAAY,CACb;wBATD,CASC,CACF,EAAA;;oBAXD,SAWC,CAAC;;;;oBAEF,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,2CAA2C,CAAC,CAAC;oBAC7D,KAAK,CAAC,GAAG,CAAC,IAAI,CACZ,eAAK,CAAC,GAAG,CACP,OAAO,GAAC,KAAK,QAAQ,IAAI,GAAC,IAAI,IAAI,IAAI,UAAU,IAAI,GAAC;wBACnD,CAAC,CAAC,GAAC,CAAC,QAAQ,EAAE;wBACd,CAAC,CAAC,OAAO,GAAC,KAAK,QAAQ;4BACvB,CAAC,CAAC,GAAC;4BACH,CAAC,CAAC,eAAe,CACpB,CACF,CAAC;oBACF,MAAM,CAAC,gBAAgB,CAAC,0CAA0C,CAAC,CAAC;oBACpE,qBAAM,IAAA,mBAAK,EAAC,gBAAgB,CAAC,EAAA;;oBAA7B,SAA6B,CAAC;oBAC9B,sBAAO;;;oBAIP,qBAAM,IAAA,qBAAS,EAAC,qBAAqB,EAAE;4BACrC,OAAA,IAAA,+BAAiB,EAAC,YAAY,EAAE;gCAC9B,UAAU,YAAA;gCACV,GAAG,EAAE,SAAS;gCACd,OAAO,EAAE,eAAe,CAAC,YAAY,CAAC,IAAI;gCAC1C,SAAS,EAAE,eAAe,CAAC,EAAE;6BAC9B,CAAC;wBALF,CAKE,CACH,EAAA;;oBAPD,SAOC,CAAC;;;;oBAEF,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,sDAAsD,CAAC,CAAC;oBACxE,KAAK,CAAC,GAAG,CAAC,IAAI,CACZ,eAAK,CAAC,GAAG,CACP,OAAO,GAAC,KAAK,QAAQ,IAAI,GAAC,IAAI,IAAI,IAAI,UAAU,IAAI,GAAC;wBACnD,CAAC,CAAC,GAAC,CAAC,QAAQ,EAAE;wBACd,CAAC,CAAC,OAAO,GAAC,KAAK,QAAQ;4BACvB,CAAC,CAAC,GAAC;4BACH,CAAC,CAAC,eAAe,CACpB,CACF,CAAC;oBACF,MAAM,CAAC,gBAAgB,CACrB,4DAA4D,CAC7D,CAAC;oBACF,qBAAM,IAAA,mBAAK,EAAC,gBAAgB,CAAC,EAAA;;oBAA7B,SAA6B,CAAC;oBAC9B,sBAAO;;oBAGT,KAAK,CAAC,KAAK,CAAC,YACZ,eAAK,CAAC,KAAK,CAAC,kDAAkD,CAAC,iBAE/D,eAAK,CAAC,IAAI,CACV,8GAA8G,CAC/G,sIAIE,CAAC,CAAC;;;;;CACJ;AAtID,0EAsIC","sourcesContent":["// @ts-ignore - clack is ESM and TS complains about that. It works though\nimport * as clack from '@clack/prompts';\nimport chalk from 'chalk';\n\nimport * as Sentry from '@sentry/node';\n\nimport {\n  abort,\n  abortIfCancelled,\n  addSentryCliConfig,\n  confirmContinueEvenThoughNoGitRepo,\n  ensurePackageIsInstalled,\n  getOrAskForProjectData,\n  getPackageDotJson,\n  installPackage,\n  printWelcome,\n} from '../utils/clack-utils';\nimport { getPackageVersion, hasPackageInstalled } from '../utils/package-json';\nimport { WizardOptions } from '../utils/types';\nimport { createExamplePage } from './sdk-example';\nimport { createOrMergeSvelteKitFiles, loadSvelteConfig } from './sdk-setup';\nimport { traceStep, withTelemetry } from '../telemetry';\nimport { getKitVersionBucket, getSvelteVersionBucket } from './utils';\n\nexport async function runSvelteKitWizard(\n  options: WizardOptions,\n): Promise<void> {\n  return withTelemetry(\n    {\n      enabled: options.telemetryEnabled,\n      integration: 'sveltekit',\n    },\n    () => runSvelteKitWizardWithTelemetry(options),\n  );\n}\n\nexport async function runSvelteKitWizardWithTelemetry(\n  options: WizardOptions,\n): Promise<void> {\n  printWelcome({\n    wizardName: 'Sentry SvelteKit Wizard',\n    promoCode: options.promoCode,\n    telemetryEnabled: options.telemetryEnabled,\n  });\n\n  await traceStep('detect-git', confirmContinueEvenThoughNoGitRepo);\n\n  const packageJson = await getPackageDotJson();\n  await traceStep('detect-framework-version', () =>\n    ensurePackageIsInstalled(packageJson, '@sveltejs/kit', 'Sveltekit'),\n  );\n\n  const kitVersion = getPackageVersion('@sveltejs/kit', packageJson);\n  const kitVersionBucket = getKitVersionBucket(kitVersion);\n  Sentry.setTag('sveltekit-version', kitVersionBucket);\n\n  if (kitVersionBucket === '0.x') {\n    clack.log.warn(\n      \"It seems you're using a SvelteKit version <1.0.0 which is not supported by Sentry.\\nWe recommend upgrading to the latest 1.x version before you continue.\",\n    );\n    const shouldContinue = await abortIfCancelled(\n      clack.select({\n        message: 'Do you want to continue anyway?',\n        options: [\n          {\n            label: 'Yes, continue',\n            hint: 'The SDK might not work correctly',\n            value: true,\n          },\n          { label: \"No, I'll upgrade first\", value: false },\n        ],\n      }),\n    );\n    if (!shouldContinue) {\n      await abort('Exiting Wizard', 0);\n      return;\n    }\n  }\n\n  Sentry.setTag(\n    'svelte-version',\n    getSvelteVersionBucket(getPackageVersion('svelte', packageJson)),\n  );\n\n  const { selectedProject, selfHosted, sentryUrl, authToken } =\n    await getOrAskForProjectData(options, 'javascript-sveltekit');\n\n  const sdkAlreadyInstalled = hasPackageInstalled(\n    '@sentry/sveltekit',\n    packageJson,\n  );\n  Sentry.setTag('sdk-already-installed', sdkAlreadyInstalled);\n\n  await traceStep('install-sdk', () =>\n    installPackage({\n      packageName: '@sentry/sveltekit',\n      alreadyInstalled: sdkAlreadyInstalled,\n    }),\n  );\n\n  await traceStep('add-cli-config', () => addSentryCliConfig(authToken));\n\n  const svelteConfig = await traceStep('load-svelte-config', loadSvelteConfig);\n\n  try {\n    await traceStep('configure-sdk', () =>\n      createOrMergeSvelteKitFiles(\n        {\n          dsn: selectedProject.keys[0].dsn.public,\n          org: selectedProject.organization.slug,\n          project: selectedProject.slug,\n          selfHosted,\n          url: sentryUrl,\n        },\n        svelteConfig,\n      ),\n    );\n  } catch (e: unknown) {\n    clack.log.error('Error while setting up the SvelteKit SDK:');\n    clack.log.info(\n      chalk.dim(\n        typeof e === 'object' && e != null && 'toString' in e\n          ? e.toString()\n          : typeof e === 'string'\n          ? e\n          : 'Unknown error',\n      ),\n    );\n    Sentry.captureException('Error while setting up the SvelteKit SDK');\n    await abort('Exiting Wizard');\n    return;\n  }\n\n  try {\n    await traceStep('create-example-page', () =>\n      createExamplePage(svelteConfig, {\n        selfHosted,\n        url: sentryUrl,\n        orgSlug: selectedProject.organization.slug,\n        projectId: selectedProject.id,\n      }),\n    );\n  } catch (e: unknown) {\n    clack.log.error('Error while creating an example page to test Sentry:');\n    clack.log.info(\n      chalk.dim(\n        typeof e === 'object' && e != null && 'toString' in e\n          ? e.toString()\n          : typeof e === 'string'\n          ? e\n          : 'Unknown error',\n      ),\n    );\n    Sentry.captureException(\n      'Error while creating an example Svelte page to test Sentry',\n    );\n    await abort('Exiting Wizard');\n    return;\n  }\n\n  clack.outro(`\n${chalk.green('Successfully installed the Sentry SvelteKit SDK!')}\n\n${chalk.cyan(\n  'You can validate your setup by starting your dev environment (`npm run dev`) and visiting \"/sentry-example\".',\n)}\n\nCheck out the SDK documentation for further configuration:\nhttps://docs.sentry.io/platforms/javascript/guides/sveltekit/\n  `);\n}\n"]}

package/dist/src/sveltekit/utils.d.ts

@@ -0,0 +1,2 @@
+export declare function getKitVersionBucket(version: string | undefined): 'none' | 'invalid' | '0.x' | '>=1.0.0 <1.24.0' | '>=1.24.0';
+export declare function getSvelteVersionBucket(version: string | undefined): 'none' | 'invalid' | '<3.0.0' | '3.x' | '4.x' | '>4.x';

package/dist/src/sveltekit/utils.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSvelteVersionBucket = exports.getKitVersionBucket = void 0;
+var semver_1 = require("semver");
+function getKitVersionBucket(version) {
+    if (!version) {
+        return 'none';
+    }
+    var minVer = (0, semver_1.minVersion)(version);
+    if (!minVer) {
+        return 'invalid';
+    }
+    if ((0, semver_1.lt)(minVer, '1.0.0')) {
+        return '0.x';
+    }
+    else if ((0, semver_1.lt)(minVer, '1.24.0')) {
+        return '>=1.0.0 <1.24.0';
+    }
+    else {
+        // This is the version when the client-side invalidation fix was released
+        // https://github.com/sveltejs/kit/releases/tag/%40sveltejs%2Fkit%401.24.0
+        // https://github.com/sveltejs/kit/pull/10576
+        return '>=1.24.0';
+    }
+}
+exports.getKitVersionBucket = getKitVersionBucket;
+function getSvelteVersionBucket(version) {
+    if (!version) {
+        return 'none';
+    }
+    var minVer = (0, semver_1.minVersion)(version);
+    if (!minVer) {
+        return 'invalid';
+    }
+    if ((0, semver_1.lt)(minVer, '3.0.0')) {
+        return '<3.0.0';
+    }
+    if ((0, semver_1.lt)(minVer, '4.0.0')) {
+        return '3.x';
+    }
+    if ((0, semver_1.lt)(minVer, '5.0.0')) {
+        return '4.x';
+    }
+    // Svelte 5 isn't released yet but it's being worked on
+    return '>4.x';
+}
+exports.getSvelteVersionBucket = getSvelteVersionBucket;
+//# sourceMappingURL=utils.js.map

package/dist/src/sveltekit/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/sveltekit/utils.ts"],"names":[],"mappings":";;;AAAA,iCAAwC;AAExC,SAAgB,mBAAmB,CACjC,OAA2B;IAE3B,IAAI,CAAC,OAAO,EAAE;QACZ,OAAO,MAAM,CAAC;KACf;IAED,IAAM,MAAM,GAAG,IAAA,mBAAU,EAAC,OAAO,CAAC,CAAC;IACnC,IAAI,CAAC,MAAM,EAAE;QACX,OAAO,SAAS,CAAC;KAClB;IAED,IAAI,IAAA,WAAE,EAAC,MAAM,EAAE,OAAO,CAAC,EAAE;QACvB,OAAO,KAAK,CAAC;KACd;SAAM,IAAI,IAAA,WAAE,EAAC,MAAM,EAAE,QAAQ,CAAC,EAAE;QAC/B,OAAO,iBAAiB,CAAC;KAC1B;SAAM;QACL,yEAAyE;QACzE,0EAA0E;QAC1E,6CAA6C;QAC7C,OAAO,UAAU,CAAC;KACnB;AACH,CAAC;AAtBD,kDAsBC;AAED,SAAgB,sBAAsB,CACpC,OAA2B;IAE3B,IAAI,CAAC,OAAO,EAAE;QACZ,OAAO,MAAM,CAAC;KACf;IAED,IAAM,MAAM,GAAG,IAAA,mBAAU,EAAC,OAAO,CAAC,CAAC;IACnC,IAAI,CAAC,MAAM,EAAE;QACX,OAAO,SAAS,CAAC;KAClB;IAED,IAAI,IAAA,WAAE,EAAC,MAAM,EAAE,OAAO,CAAC,EAAE;QACvB,OAAO,QAAQ,CAAC;KACjB;IACD,IAAI,IAAA,WAAE,EAAC,MAAM,EAAE,OAAO,CAAC,EAAE;QACvB,OAAO,KAAK,CAAC;KACd;IACD,IAAI,IAAA,WAAE,EAAC,MAAM,EAAE,OAAO,CAAC,EAAE;QACvB,OAAO,KAAK,CAAC;KACd;IACD,uDAAuD;IACvD,OAAO,MAAM,CAAC;AAChB,CAAC;AAvBD,wDAuBC","sourcesContent":["import { lt, minVersion } from 'semver';\n\nexport function getKitVersionBucket(\n  version: string | undefined,\n): 'none' | 'invalid' | '0.x' | '>=1.0.0 <1.24.0' | '>=1.24.0' {\n  if (!version) {\n    return 'none';\n  }\n\n  const minVer = minVersion(version);\n  if (!minVer) {\n    return 'invalid';\n  }\n\n  if (lt(minVer, '1.0.0')) {\n    return '0.x';\n  } else if (lt(minVer, '1.24.0')) {\n    return '>=1.0.0 <1.24.0';\n  } else {\n    // This is the version when the client-side invalidation fix was released\n    // https://github.com/sveltejs/kit/releases/tag/%40sveltejs%2Fkit%401.24.0\n    // https://github.com/sveltejs/kit/pull/10576\n    return '>=1.24.0';\n  }\n}\n\nexport function getSvelteVersionBucket(\n  version: string | undefined,\n): 'none' | 'invalid' | '<3.0.0' | '3.x' | '4.x' | '>4.x' {\n  if (!version) {\n    return 'none';\n  }\n\n  const minVer = minVersion(version);\n  if (!minVer) {\n    return 'invalid';\n  }\n\n  if (lt(minVer, '3.0.0')) {\n    return '<3.0.0';\n  }\n  if (lt(minVer, '4.0.0')) {\n    return '3.x';\n  }\n  if (lt(minVer, '5.0.0')) {\n    return '4.x';\n  }\n  // Svelte 5 isn't released yet but it's being worked on\n  return '>4.x';\n}\n"]}

package/dist/src/utils/ast-utils.d.ts

@@ -10,3 +10,73 @@ export declare function findFile(filePath: string, fileTypes?: string[]): string
  * checks for require('@sentry/*') syntax
  */
 export declare function hasSentryContent(program: t.Program): boolean;
+/**
+ * Searches for a property of an ObjectExpression by name
+ *
+ * @param object the ObjectExpression to search in
+ * @param name the name of the property to search for
+ *
+ * @returns the property if it exists
+ */
+export declare function getObjectProperty(object: t.ObjectExpression, name: string): t.Property | undefined;
+/**
+ * Attempts to find a property of an ObjectExpression by name. If it doesn't exist,
+ * the property will be added to the ObjectExpression with the provided default value.
+ *
+ * @param object the parent object expression to search in
+ * @param name the name of the property to search for
+ * @param defaultValue the default value to set if the property doesn't exist
+ *
+ * @returns the
+ */
+export declare function getOrSetObjectProperty(object: t.ObjectExpression, name: string, defaultValue: t.Literal | t.BooleanLiteral | t.StringLiteral | t.ObjectExpression): t.Property;
+/**
+ * Sets a property of an ObjectExpression if it exists, otherwise adds it
+ * to the ObjectExpression. Optionally, a comment can be added to the
+ * property.
+ *
+ * @param object the ObjectExpression to set the property on
+ * @param name the name of the property to set
+ * @param value  the value of the property to set
+ * @param comment (optional) a comment to add to the property
+ */
+export declare function setOrUpdateObjectProperty(object: t.ObjectExpression, name: string, value: t.Literal | t.BooleanLiteral | t.StringLiteral | t.ObjectExpression, comment?: string): void;
+type JsonCParseResult = {
+    jsonObject: t.ObjectExpression;
+    ast: t.Program;
+} | {
+    jsonObject: undefined;
+    ast: undefined;
+};
+/**
+ * Parses a JSON string with (potential) comments (JSON-C) and returns the JS AST
+ * that can be walked and modified with recast like a normal JS AST.
+ *
+ * This is done by wrapping the JSON-C string in parentheses, thereby making it
+ * a JS `Program` with an `ExpressionStatement` as its body. The expression is then
+ * extracted from the AST and returned alongside the AST.
+ *
+ * To preserve as much original formatting as possible, the returned `ast`
+ * property should be passed to {@link `printJsonC`} to get the JSON-C string back.
+ *
+ * If the input is not valid JSON-C, the result will be undefined.
+ *
+ * @see {@link JsonCParseResult}
+ *
+ * @param jsonString a JSON-C string
+ *
+ * @returns a {@link JsonCParseResult}, containing either the JSON-C object and the AST or undefined in both cases
+ */
+export declare function parseJsonC(jsonString: string): JsonCParseResult;
+/**
+ * Takes the AST of a parsed JSON-C "program" and returns the JSON-C string without
+ * any of the temporary JS wrapper code that was previously applied.
+ *
+ * Only use this in conjunction with {@link `parseJsonC`}
+ *
+ * @param ast the `ast` returned from {@link `parseJsonC`}
+ *
+ * @returns the JSON-C string
+ */
+export declare function printJsonC(ast: t.Program): string;
+export {};

package/dist/src/utils/ast-utils.js

@@ -1,4 +1,15 @@
 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -22,10 +33,20 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasSentryContent = exports.findFile = void 0;
+exports.printJsonC = exports.parseJsonC = exports.setOrUpdateObjectProperty = exports.getOrSetObjectProperty = exports.getObjectProperty = exports.hasSentryContent = exports.findFile = void 0;
 var fs = __importStar(require("fs"));
 var recast = __importStar(require("recast"));
+var b = recast.types.builders;
 /**
  * Checks if a file where we don't know its concrete file type yet exists
  * and returns the full path to the file with the correct file type.
@@ -57,4 +78,134 @@ function hasSentryContent(program) {
     return !!foundSentry;
 }
 exports.hasSentryContent = hasSentryContent;
+/**
+ * Searches for a property of an ObjectExpression by name
+ *
+ * @param object the ObjectExpression to search in
+ * @param name the name of the property to search for
+ *
+ * @returns the property if it exists
+ */
+function getObjectProperty(object, name) {
+    return object.properties.find(function (p) {
+        var isObjectProp = p.type === 'Property' || p.type === 'ObjectProperty';
+        if (!isObjectProp) {
+            return false;
+        }
+        var hasMatchingLiteralKey = isObjectProp &&
+            (p.key.type === 'Literal' || p.key.type === 'StringLiteral') &&
+            p.key.value === name;
+        if (hasMatchingLiteralKey) {
+            return true;
+        }
+        // has matching identifier key
+        return isObjectProp && p.key.type === 'Identifier' && p.key.name === name;
+    });
+}
+exports.getObjectProperty = getObjectProperty;
+/**
+ * Attempts to find a property of an ObjectExpression by name. If it doesn't exist,
+ * the property will be added to the ObjectExpression with the provided default value.
+ *
+ * @param object the parent object expression to search in
+ * @param name the name of the property to search for
+ * @param defaultValue the default value to set if the property doesn't exist
+ *
+ * @returns the
+ */
+function getOrSetObjectProperty(object, name, defaultValue) {
+    var existingProperty = getObjectProperty(object, name);
+    if (existingProperty) {
+        return existingProperty;
+    }
+    var newProperty = b.property.from({
+        kind: 'init',
+        key: b.stringLiteral(name),
+        value: defaultValue,
+    });
+    object.properties.push(newProperty);
+    return newProperty;
+}
+exports.getOrSetObjectProperty = getOrSetObjectProperty;
+/**
+ * Sets a property of an ObjectExpression if it exists, otherwise adds it
+ * to the ObjectExpression. Optionally, a comment can be added to the
+ * property.
+ *
+ * @param object the ObjectExpression to set the property on
+ * @param name the name of the property to set
+ * @param value  the value of the property to set
+ * @param comment (optional) a comment to add to the property
+ */
+function setOrUpdateObjectProperty(object, name, value, comment) {
+    var newComments = comment &&
+        comment.split('\n').map(function (c) { return b.commentLine(" ".concat(c), true, false); });
+    var existingProperty = getObjectProperty(object, name);
+    if (existingProperty) {
+        existingProperty.value = value;
+        if (newComments) {
+            existingProperty.comments = __spreadArray(__spreadArray([], ((existingProperty === null || existingProperty === void 0 ? void 0 : existingProperty.comments) || []), true), newComments, true);
+        }
+    }
+    else {
+        object.properties.push(b.objectProperty.from(__assign({ key: b.stringLiteral(name), value: value }, (newComments && {
+            comments: newComments,
+        }))));
+    }
+}
+exports.setOrUpdateObjectProperty = setOrUpdateObjectProperty;
+/**
+ * Parses a JSON string with (potential) comments (JSON-C) and returns the JS AST
+ * that can be walked and modified with recast like a normal JS AST.
+ *
+ * This is done by wrapping the JSON-C string in parentheses, thereby making it
+ * a JS `Program` with an `ExpressionStatement` as its body. The expression is then
+ * extracted from the AST and returned alongside the AST.
+ *
+ * To preserve as much original formatting as possible, the returned `ast`
+ * property should be passed to {@link `printJsonC`} to get the JSON-C string back.
+ *
+ * If the input is not valid JSON-C, the result will be undefined.
+ *
+ * @see {@link JsonCParseResult}
+ *
+ * @param jsonString a JSON-C string
+ *
+ * @returns a {@link JsonCParseResult}, containing either the JSON-C object and the AST or undefined in both cases
+ */
+function parseJsonC(jsonString) {
+    try {
+        var jsTsConfig = "(".concat(jsonString, ")");
+        // no idea why recast returns any here, this is dumb :/
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+        var ast = recast.parse(jsTsConfig.toString()).program;
+        var jsonObject = (ast.body[0].type === 'ExpressionStatement' &&
+            ast.body[0].expression.type === 'ObjectExpression' &&
+            ast.body[0].expression) ||
+            undefined;
+        if (jsonObject) {
+            return { jsonObject: jsonObject, ast: ast };
+        }
+    }
+    catch (_a) {
+        /* empty */
+    }
+    return { jsonObject: undefined, ast: undefined };
+}
+exports.parseJsonC = parseJsonC;
+/**
+ * Takes the AST of a parsed JSON-C "program" and returns the JSON-C string without
+ * any of the temporary JS wrapper code that was previously applied.
+ *
+ * Only use this in conjunction with {@link `parseJsonC`}
+ *
+ * @param ast the `ast` returned from {@link `parseJsonC`}
+ *
+ * @returns the JSON-C string
+ */
+function printJsonC(ast) {
+    var js = recast.print(ast).code;
+    return js.substring(1, js.length - 1);
+}
+exports.printJsonC = printJsonC;
 //# sourceMappingURL=ast-utils.js.map

package/dist/src/utils/ast-utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"ast-utils.js","sourceRoot":"","sources":["../../../src/utils/ast-utils.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qCAAyB;AAEzB,6CAAiC;AAIjC;;;GAGG;AACH,SAAgB,QAAQ,CACtB,QAAgB,EAChB,SAAoD;IAApD,0BAAA,EAAA,aAAuB,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC;IAEpD,OAAO,SAAS;SACb,GAAG,CAAC,UAAC,IAAI,IAAK,OAAA,UAAG,QAAQ,SAAG,IAAI,CAAE,EAApB,CAAoB,CAAC;SACnC,IAAI,CAAC,UAAC,IAAI,IAAK,OAAA,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAnB,CAAmB,CAAC,CAAC;AACzC,CAAC;AAPD,4BAOC;AAED;;GAEG;AACH,SAAgB,gBAAgB,CAAC,OAAkB;IACjD,IAAI,WAAW,GAAwB,KAAK,CAAC;IAC7C,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE;QACpB,kBAAkB,YAAC,IAAI;YACrB,WAAW,GAAG,WAAW,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;YACpE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACtB,CAAC;QACD,YAAY,YAAC,IAAI;;YACf,WAAW;gBACT,WAAW,KAAI,MAAA,IAAI,CAAC,IAAI,CAAC,KAAK,0CAAE,QAAQ,GAAG,UAAU,CAAC,UAAU,CAAC,CAAA,CAAC;YACpE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACtB,CAAC;KACF,CAAC,CAAC;IAEH,OAAO,CAAC,CAAC,WAAW,CAAC;AACvB,CAAC;AAfD,4CAeC","sourcesContent":["import * as fs from 'fs';\n\nimport * as recast from 'recast';\nimport x = recast.types;\nimport t = x.namedTypes;\n\n/**\n * Checks if a file where we don't know its concrete file type yet exists\n * and returns the full path to the file with the correct file type.\n */\nexport function findFile(\n  filePath: string,\n  fileTypes: string[] = ['.js', '.ts', '.mjs', '.cjs'],\n): string | undefined {\n  return fileTypes\n    .map((type) => `${filePath}${type}`)\n    .find((file) => fs.existsSync(file));\n}\n\n/**\n * checks for require('@sentry/*') syntax\n */\nexport function hasSentryContent(program: t.Program): boolean {\n  let foundSentry: boolean | undefined = false;\n  recast.visit(program, {\n    visitStringLiteral(path) {\n      foundSentry = foundSentry || path.node.value.startsWith('@sentry/');\n      this.traverse(path);\n    },\n    visitLiteral(path) {\n      foundSentry =\n        foundSentry || path.node.value?.toString().startsWith('@sentry/');\n      this.traverse(path);\n    },\n  });\n\n  return !!foundSentry;\n}\n"]}
+{"version":3,"file":"ast-utils.js","sourceRoot":"","sources":["../../../src/utils/ast-utils.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qCAAyB;AAEzB,6CAAiC;AAIjC,IAAM,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC;AAEhC;;;GAGG;AACH,SAAgB,QAAQ,CACtB,QAAgB,EAChB,SAAoD;IAApD,0BAAA,EAAA,aAAuB,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC;IAEpD,OAAO,SAAS;SACb,GAAG,CAAC,UAAC,IAAI,IAAK,OAAA,UAAG,QAAQ,SAAG,IAAI,CAAE,EAApB,CAAoB,CAAC;SACnC,IAAI,CAAC,UAAC,IAAI,IAAK,OAAA,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAnB,CAAmB,CAAC,CAAC;AACzC,CAAC;AAPD,4BAOC;AAED;;GAEG;AACH,SAAgB,gBAAgB,CAAC,OAAkB;IACjD,IAAI,WAAW,GAAwB,KAAK,CAAC;IAC7C,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE;QACpB,kBAAkB,YAAC,IAAI;YACrB,WAAW,GAAG,WAAW,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;YACpE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACtB,CAAC;QACD,YAAY,YAAC,IAAI;;YACf,WAAW;gBACT,WAAW,KAAI,MAAA,IAAI,CAAC,IAAI,CAAC,KAAK,0CAAE,QAAQ,GAAG,UAAU,CAAC,UAAU,CAAC,CAAA,CAAC;YACpE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACtB,CAAC;KACF,CAAC,CAAC;IAEH,OAAO,CAAC,CAAC,WAAW,CAAC;AACvB,CAAC;AAfD,4CAeC;AAED;;;;;;;GAOG;AACH,SAAgB,iBAAiB,CAC/B,MAA0B,EAC1B,IAAY;IAEZ,OAAO,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,UAAC,CAAC;QAC9B,IAAM,YAAY,GAAG,CAAC,CAAC,IAAI,KAAK,UAAU,IAAI,CAAC,CAAC,IAAI,KAAK,gBAAgB,CAAC;QAE1E,IAAI,CAAC,YAAY,EAAE;YACjB,OAAO,KAAK,CAAC;SACd;QAED,IAAM,qBAAqB,GACzB,YAAY;YACZ,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,KAAK,SAAS,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,KAAK,eAAe,CAAC;YAC5D,CAAC,CAAC,GAAG,CAAC,KAAK,KAAK,IAAI,CAAC;QAEvB,IAAI,qBAAqB,EAAE;YACzB,OAAO,IAAI,CAAC;SACb;QAED,8BAA8B;QAC9B,OAAO,YAAY,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,KAAK,YAAY,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,KAAK,IAAI,CAAC;IAC5E,CAAC,CAAC,CAAC;AACL,CAAC;AAvBD,8CAuBC;AAED;;;;;;;;;GASG;AACH,SAAgB,sBAAsB,CACpC,MAA0B,EAC1B,IAAY,EACZ,YAIsB;IAEtB,IAAM,gBAAgB,GAAG,iBAAiB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAEzD,IAAI,gBAAgB,EAAE;QACpB,OAAO,gBAAgB,CAAC;KACzB;IAED,IAAM,WAAW,GAAG,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;QAClC,IAAI,EAAE,MAAM;QACZ,GAAG,EAAE,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC;QAC1B,KAAK,EAAE,YAAY;KACpB,CAAC,CAAC;IAEH,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAEpC,OAAO,WAAW,CAAC;AACrB,CAAC;AAxBD,wDAwBC;AAED;;;;;;;;;GASG;AACH,SAAgB,yBAAyB,CACvC,MAA0B,EAC1B,IAAY,EACZ,KAA0E,EAC1E,OAAgB;IAEhB,IAAM,WAAW,GACf,OAAO;QACP,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,WAAW,CAAC,WAAI,CAAC,CAAE,EAAE,IAAI,EAAE,KAAK,CAAC,EAAnC,CAAmC,CAAC,CAAC;IAEtE,IAAM,gBAAgB,GAAG,iBAAiB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAEzD,IAAI,gBAAgB,EAAE;QACpB,gBAAgB,CAAC,KAAK,GAAG,KAAK,CAAC;QAC/B,IAAI,WAAW,EAAE;YACf,gBAAgB,CAAC,QAAQ,mCACpB,CAAC,CAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,QAAQ,KAAI,EAAE,CAAC,SAClC,WAAW,OACf,CAAC;SACH;KACF;SAAM;QACL,MAAM,CAAC,UAAU,CAAC,IAAI,CACpB,CAAC,CAAC,cAAc,CAAC,IAAI,YACnB,GAAG,EAAE,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,EAC1B,KAAK,OAAA,IACF,CAAC,WAAW,IAAI;YACjB,QAAQ,EAAE,WAAW;SACtB,CAAC,EACF,CACH,CAAC;KACH;AACH,CAAC;AA/BD,8DA+BC;AAYD;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,UAAU,CAAC,UAAkB;IAC3C,IAAI;QACF,IAAM,UAAU,GAAG,WAAI,UAAU,MAAG,CAAC;QACrC,uDAAuD;QACvD,sEAAsE;QACtE,IAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC,OAAoB,CAAC;QAErE,IAAM,UAAU,GACd,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,qBAAqB;YACzC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,KAAK,kBAAkB;YAClD,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;YACzB,SAAS,CAAC;QAEZ,IAAI,UAAU,EAAE;YACd,OAAO,EAAE,UAAU,YAAA,EAAE,GAAG,KAAA,EAAE,CAAC;SAC5B;KACF;IAAC,WAAM;QACN,WAAW;KACZ;IACD,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC;AACnD,CAAC;AApBD,gCAoBC;AAED;;;;;;;;;GASG;AACH,SAAgB,UAAU,CAAC,GAAc;IACvC,IAAM,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;IAClC,OAAO,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AACxC,CAAC;AAHD,gCAGC","sourcesContent":["import * as fs from 'fs';\n\nimport * as recast from 'recast';\nimport x = recast.types;\nimport t = x.namedTypes;\n\nconst b = recast.types.builders;\n\n/**\n * Checks if a file where we don't know its concrete file type yet exists\n * and returns the full path to the file with the correct file type.\n */\nexport function findFile(\n  filePath: string,\n  fileTypes: string[] = ['.js', '.ts', '.mjs', '.cjs'],\n): string | undefined {\n  return fileTypes\n    .map((type) => `${filePath}${type}`)\n    .find((file) => fs.existsSync(file));\n}\n\n/**\n * checks for require('@sentry/*') syntax\n */\nexport function hasSentryContent(program: t.Program): boolean {\n  let foundSentry: boolean | undefined = false;\n  recast.visit(program, {\n    visitStringLiteral(path) {\n      foundSentry = foundSentry || path.node.value.startsWith('@sentry/');\n      this.traverse(path);\n    },\n    visitLiteral(path) {\n      foundSentry =\n        foundSentry || path.node.value?.toString().startsWith('@sentry/');\n      this.traverse(path);\n    },\n  });\n\n  return !!foundSentry;\n}\n\n/**\n * Searches for a property of an ObjectExpression by name\n *\n * @param object the ObjectExpression to search in\n * @param name the name of the property to search for\n *\n * @returns the property if it exists\n */\nexport function getObjectProperty(\n  object: t.ObjectExpression,\n  name: string,\n): t.Property | undefined {\n  return object.properties.find((p): p is t.Property => {\n    const isObjectProp = p.type === 'Property' || p.type === 'ObjectProperty';\n\n    if (!isObjectProp) {\n      return false;\n    }\n\n    const hasMatchingLiteralKey =\n      isObjectProp &&\n      (p.key.type === 'Literal' || p.key.type === 'StringLiteral') &&\n      p.key.value === name;\n\n    if (hasMatchingLiteralKey) {\n      return true;\n    }\n\n    // has matching identifier key\n    return isObjectProp && p.key.type === 'Identifier' && p.key.name === name;\n  });\n}\n\n/**\n * Attempts to find a property of an ObjectExpression by name. If it doesn't exist,\n * the property will be added to the ObjectExpression with the provided default value.\n *\n * @param object the parent object expression to search in\n * @param name the name of the property to search for\n * @param defaultValue the default value to set if the property doesn't exist\n *\n * @returns the\n */\nexport function getOrSetObjectProperty(\n  object: t.ObjectExpression,\n  name: string,\n  defaultValue:\n    | t.Literal\n    | t.BooleanLiteral\n    | t.StringLiteral\n    | t.ObjectExpression,\n): t.Property {\n  const existingProperty = getObjectProperty(object, name);\n\n  if (existingProperty) {\n    return existingProperty;\n  }\n\n  const newProperty = b.property.from({\n    kind: 'init',\n    key: b.stringLiteral(name),\n    value: defaultValue,\n  });\n\n  object.properties.push(newProperty);\n\n  return newProperty;\n}\n\n/**\n * Sets a property of an ObjectExpression if it exists, otherwise adds it\n * to the ObjectExpression. Optionally, a comment can be added to the\n * property.\n *\n * @param object the ObjectExpression to set the property on\n * @param name the name of the property to set\n * @param value  the value of the property to set\n * @param comment (optional) a comment to add to the property\n */\nexport function setOrUpdateObjectProperty(\n  object: t.ObjectExpression,\n  name: string,\n  value: t.Literal | t.BooleanLiteral | t.StringLiteral | t.ObjectExpression,\n  comment?: string,\n) {\n  const newComments =\n    comment &&\n    comment.split('\\n').map((c) => b.commentLine(` ${c}`, true, false));\n\n  const existingProperty = getObjectProperty(object, name);\n\n  if (existingProperty) {\n    existingProperty.value = value;\n    if (newComments) {\n      existingProperty.comments = [\n        ...(existingProperty?.comments || []),\n        ...newComments,\n      ];\n    }\n  } else {\n    object.properties.push(\n      b.objectProperty.from({\n        key: b.stringLiteral(name),\n        value,\n        ...(newComments && {\n          comments: newComments,\n        }),\n      }),\n    );\n  }\n}\n\ntype JsonCParseResult =\n  | {\n      jsonObject: t.ObjectExpression;\n      ast: t.Program;\n    }\n  | {\n      jsonObject: undefined;\n      ast: undefined;\n    };\n\n/**\n * Parses a JSON string with (potential) comments (JSON-C) and returns the JS AST\n * that can be walked and modified with recast like a normal JS AST.\n *\n * This is done by wrapping the JSON-C string in parentheses, thereby making it\n * a JS `Program` with an `ExpressionStatement` as its body. The expression is then\n * extracted from the AST and returned alongside the AST.\n *\n * To preserve as much original formatting as possible, the returned `ast`\n * property should be passed to {@link `printJsonC`} to get the JSON-C string back.\n *\n * If the input is not valid JSON-C, the result will be undefined.\n *\n * @see {@link JsonCParseResult}\n *\n * @param jsonString a JSON-C string\n *\n * @returns a {@link JsonCParseResult}, containing either the JSON-C object and the AST or undefined in both cases\n */\nexport function parseJsonC(jsonString: string): JsonCParseResult {\n  try {\n    const jsTsConfig = `(${jsonString})`;\n    // no idea why recast returns any here, this is dumb :/\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access\n    const ast = recast.parse(jsTsConfig.toString()).program as t.Program;\n\n    const jsonObject =\n      (ast.body[0].type === 'ExpressionStatement' &&\n        ast.body[0].expression.type === 'ObjectExpression' &&\n        ast.body[0].expression) ||\n      undefined;\n\n    if (jsonObject) {\n      return { jsonObject, ast };\n    }\n  } catch {\n    /* empty */\n  }\n  return { jsonObject: undefined, ast: undefined };\n}\n\n/**\n * Takes the AST of a parsed JSON-C \"program\" and returns the JSON-C string without\n * any of the temporary JS wrapper code that was previously applied.\n *\n * Only use this in conjunction with {@link `parseJsonC`}\n *\n * @param ast the `ast` returned from {@link `parseJsonC`}\n *\n * @returns the JSON-C string\n */\nexport function printJsonC(ast: t.Program): string {\n  const js = recast.print(ast).code;\n  return js.substring(1, js.length - 1);\n}\n"]}