@react-native-windows/telemetry 0.66.1 → 0.68.0-preview.2

package/lib-commonjs/test/versionUtils.test.js

@@ -0,0 +1,111 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * @format
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const versionUtils = __importStar(require("../utils/versionUtils"));
+const path_1 = __importDefault(require("path"));
+const semver_1 = __importDefault(require("semver"));
+function expectValidVersion(version, expectSemVer) {
+    expect(version).not.toBeNull();
+    expect(version).toBeDefined();
+    if (expectSemVer) {
+        expect(semver_1.default.valid(version)).toBe(version);
+    }
+    else {
+        version.split('.').forEach((s) => {
+            const tryParseInt = () => {
+                parseInt(s, 10);
+            };
+            expect(tryParseInt).not.toThrow();
+        });
+    }
+}
+test('getNodeVersion() is valid', async () => {
+    const version = await versionUtils.getNodeVersion();
+    expectValidVersion(version, true);
+});
+test('getNpmVersion() is valid', async () => {
+    const version = await versionUtils.getNpmVersion();
+    if (version) {
+        expectValidVersion(version, true);
+    }
+});
+test('getYarnVersion() is valid', async () => {
+    const version = await versionUtils.getYarnVersion();
+    if (version) {
+        expectValidVersion(version, true);
+    }
+});
+test('getVisualStudioVersion() is valid', async () => {
+    const version = await versionUtils.getVisualStudioVersion();
+    expectValidVersion(version, false);
+});
+test('getVersionOfNpmPackage() of empty string is null', async () => {
+    const version = await versionUtils.getVersionOfNpmPackage('');
+    expect(version).toBeNull();
+});
+test('getVersionOfNpmPackage() of invalid package is null', async () => {
+    const version = await versionUtils.getVersionOfNpmPackage('invalidpackage');
+    expect(version).toBeNull();
+});
+test('getVersionOfNpmPackage() of valid package is valid', async () => {
+    const version = await versionUtils.getVersionOfNpmPackage('jest');
+    expectValidVersion(version, true);
+});
+test('getVersionsOfNuGetPackages() of valid package in packages.config is valid', async () => {
+    const projectFile = path_1.default.resolve(__dirname, 'projects/UsesPackagesConfig/UsesPackagesConfig.vcxproj');
+    const versions = await versionUtils.getVersionsOfNuGetPackages(projectFile, [
+        'Microsoft.Windows.CppWinRT',
+    ]);
+    expect(versions).not.toBeNull();
+    expectValidVersion(versions['Microsoft.Windows.CppWinRT'], false);
+});
+test('getVersionsOfNuGetPackages() of invalid package in packages.config is invalid', async () => {
+    const projectFile = path_1.default.resolve(__dirname, 'projects/UsesPackagesConfig/UsesPackagesConfig.vcxproj');
+    const versions = await versionUtils.getVersionsOfNuGetPackages(projectFile, [
+        'Invalid.Package',
+    ]);
+    expect(versions).toStrictEqual({});
+});
+test('getVersionsOfNuGetPackages() of valid package in project is valid', async () => {
+    const projectFile = path_1.default.resolve(__dirname, 'projects/UsesPackageReference/UsesPackageReference.csproj');
+    const versions = await versionUtils.getVersionsOfNuGetPackages(projectFile, [
+        'Microsoft.NETCore.UniversalWindowsPlatform',
+    ]);
+    expect(versions).not.toBeNull();
+    expectValidVersion(versions['Microsoft.NETCore.UniversalWindowsPlatform'], false);
+});
+test('getVersionsOfNuGetPackages() of invalid package in project is invalid', async () => {
+    const projectFile = path_1.default.resolve(__dirname, 'projects/UsesPackageReference/UsesPackageReference.csproj');
+    const versions = await versionUtils.getVersionsOfNuGetPackages(projectFile, [
+        'Invalid.Package',
+    ]);
+    expect(versions).toStrictEqual({});
+});
+//# sourceMappingURL=versionUtils.test.js.map

package/lib-commonjs/test/versionUtils.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"versionUtils.test.js","sourceRoot":"","sources":["../../src/test/versionUtils.test.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;;;;;;;;;;;;;;;;;;;AAEH,oEAAsD;AAEtD,gDAAwB;AACxB,oDAA4B;AAE5B,SAAS,kBAAkB,CAAC,OAAsB,EAAE,YAAqB;IACvE,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;IAC/B,MAAM,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,CAAC;IAC9B,IAAI,YAAY,EAAE;QAChB,MAAM,CAAC,gBAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;KAC7C;SAAM;QACL,OAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YAChC,MAAM,WAAW,GAAG,GAAG,EAAE;gBACvB,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YAClB,CAAC,CAAC;YACF,MAAM,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QACpC,CAAC,CAAC,CAAC;KACJ;AACH,CAAC;AAED,IAAI,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE;IAC3C,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC,cAAc,EAAE,CAAC;IACpD,kBAAkB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;AACpC,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,0BAA0B,EAAE,KAAK,IAAI,EAAE;IAC1C,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC,aAAa,EAAE,CAAC;IACnD,IAAI,OAAO,EAAE;QACX,kBAAkB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;KACnC;AACH,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE;IAC3C,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC,cAAc,EAAE,CAAC;IACpD,IAAI,OAAO,EAAE;QACX,kBAAkB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;KACnC;AACH,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,mCAAmC,EAAE,KAAK,IAAI,EAAE;IACnD,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC,sBAAsB,EAAE,CAAC;IAC5D,kBAAkB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;AACrC,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,kDAAkD,EAAE,KAAK,IAAI,EAAE;IAClE,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC,sBAAsB,CAAC,EAAE,CAAC,CAAC;IAC9D,MAAM,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC;AAC7B,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;IACrE,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,CAAC;IAC5E,MAAM,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC;AAC7B,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;IACpE,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;IAClE,kBAAkB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;AACpC,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,2EAA2E,EAAE,KAAK,IAAI,EAAE;IAC3F,MAAM,WAAW,GAAG,cAAI,CAAC,OAAO,CAC9B,SAAS,EACT,wDAAwD,CACzD,CAAC;IACF,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,0BAA0B,CAAC,WAAW,EAAE;QAC1E,4BAA4B;KAC7B,CAAC,CAAC;IACH,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;IAChC,kBAAkB,CAAC,QAAQ,CAAC,4BAA4B,CAAC,EAAE,KAAK,CAAC,CAAC;AACpE,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,+EAA+E,EAAE,KAAK,IAAI,EAAE;IAC/F,MAAM,WAAW,GAAG,cAAI,CAAC,OAAO,CAC9B,SAAS,EACT,wDAAwD,CACzD,CAAC;IACF,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,0BAA0B,CAAC,WAAW,EAAE;QAC1E,iBAAiB;KAClB,CAAC,CAAC;IACH,MAAM,CAAC,QAAQ,CAAC,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;AACrC,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,mEAAmE,EAAE,KAAK,IAAI,EAAE;IACnF,MAAM,WAAW,GAAG,cAAI,CAAC,OAAO,CAC9B,SAAS,EACT,2DAA2D,CAC5D,CAAC;IACF,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,0BAA0B,CAAC,WAAW,EAAE;QAC1E,4CAA4C;KAC7C,CAAC,CAAC;IACH,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;IAChC,kBAAkB,CAChB,QAAQ,CAAC,4CAA4C,CAAC,EACtD,KAAK,CACN,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,uEAAuE,EAAE,KAAK,IAAI,EAAE;IACvF,MAAM,WAAW,GAAG,cAAI,CAAC,OAAO,CAC9B,SAAS,EACT,2DAA2D,CAC5D,CAAC;IACF,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,0BAA0B,CAAC,WAAW,EAAE;QAC1E,iBAAiB;KAClB,CAAC,CAAC;IACH,MAAM,CAAC,QAAQ,CAAC,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;AACrC,CAAC,CAAC,CAAC","sourcesContent":["/**\n * Copyright (c) Microsoft Corporation.\n * Licensed under the MIT License.\n *\n * @format\n */\n\nimport * as versionUtils from '../utils/versionUtils';\n\nimport path from 'path';\nimport semver from 'semver';\n\nfunction expectValidVersion(version: string | null, expectSemVer: boolean) {\n  expect(version).not.toBeNull();\n  expect(version).toBeDefined();\n  if (expectSemVer) {\n    expect(semver.valid(version)).toBe(version);\n  } else {\n    version!.split('.').forEach((s) => {\n      const tryParseInt = () => {\n        parseInt(s, 10);\n      };\n      expect(tryParseInt).not.toThrow();\n    });\n  }\n}\n\ntest('getNodeVersion() is valid', async () => {\n  const version = await versionUtils.getNodeVersion();\n  expectValidVersion(version, true);\n});\n\ntest('getNpmVersion() is valid', async () => {\n  const version = await versionUtils.getNpmVersion();\n  if (version) {\n    expectValidVersion(version, true);\n  }\n});\n\ntest('getYarnVersion() is valid', async () => {\n  const version = await versionUtils.getYarnVersion();\n  if (version) {\n    expectValidVersion(version, true);\n  }\n});\n\ntest('getVisualStudioVersion() is valid', async () => {\n  const version = await versionUtils.getVisualStudioVersion();\n  expectValidVersion(version, false);\n});\n\ntest('getVersionOfNpmPackage() of empty string is null', async () => {\n  const version = await versionUtils.getVersionOfNpmPackage('');\n  expect(version).toBeNull();\n});\n\ntest('getVersionOfNpmPackage() of invalid package is null', async () => {\n  const version = await versionUtils.getVersionOfNpmPackage('invalidpackage');\n  expect(version).toBeNull();\n});\n\ntest('getVersionOfNpmPackage() of valid package is valid', async () => {\n  const version = await versionUtils.getVersionOfNpmPackage('jest');\n  expectValidVersion(version, true);\n});\n\ntest('getVersionsOfNuGetPackages() of valid package in packages.config is valid', async () => {\n  const projectFile = path.resolve(\n    __dirname,\n    'projects/UsesPackagesConfig/UsesPackagesConfig.vcxproj',\n  );\n  const versions = await versionUtils.getVersionsOfNuGetPackages(projectFile, [\n    'Microsoft.Windows.CppWinRT',\n  ]);\n  expect(versions).not.toBeNull();\n  expectValidVersion(versions['Microsoft.Windows.CppWinRT'], false);\n});\n\ntest('getVersionsOfNuGetPackages() of invalid package in packages.config is invalid', async () => {\n  const projectFile = path.resolve(\n    __dirname,\n    'projects/UsesPackagesConfig/UsesPackagesConfig.vcxproj',\n  );\n  const versions = await versionUtils.getVersionsOfNuGetPackages(projectFile, [\n    'Invalid.Package',\n  ]);\n  expect(versions).toStrictEqual({});\n});\n\ntest('getVersionsOfNuGetPackages() of valid package in project is valid', async () => {\n  const projectFile = path.resolve(\n    __dirname,\n    'projects/UsesPackageReference/UsesPackageReference.csproj',\n  );\n  const versions = await versionUtils.getVersionsOfNuGetPackages(projectFile, [\n    'Microsoft.NETCore.UniversalWindowsPlatform',\n  ]);\n  expect(versions).not.toBeNull();\n  expectValidVersion(\n    versions['Microsoft.NETCore.UniversalWindowsPlatform'],\n    false,\n  );\n});\n\ntest('getVersionsOfNuGetPackages() of invalid package in project is invalid', async () => {\n  const projectFile = path.resolve(\n    __dirname,\n    'projects/UsesPackageReference/UsesPackageReference.csproj',\n  );\n  const versions = await versionUtils.getVersionsOfNuGetPackages(projectFile, [\n    'Invalid.Package',\n  ]);\n  expect(versions).toStrictEqual({});\n});\n"]}

package/lib-commonjs/utils/basePropUtils.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ * @format
+ */
+/**
+ * Gets a telemetry-safe stable device ID.
+ * @returns A telemetry-safe stable device ID.
+ */
+export declare function deviceId(): Promise<string>;
+/**
+ * Gets the device locale.
+ * @returns The device locale.
+ */
+export declare function deviceLocale(): Promise<string>;
+/**
+ * Gets the device's number of CPUs.
+ * @returns The device's number of CPUs.
+ */
+export declare function deviceNumCPUs(): number;
+/**
+ * Gets the device's total memory in bytes.
+ * @returns The device's total memory in bytes.
+ */
+export declare function deviceTotalMemory(): number;
+/**
+ * Gets the free space of the give drive in bytes.
+ * @param drivePath A path on the drive to check.
+ * @returns The free space of the give drive in bytes.
+ */
+export declare function deviceDiskFreeSpace(drivePath?: string | null): number;
+/**
+ * Gets the telemetry sample rate.
+ * @returns The telemetry sample rate.
+ */
+export declare function sampleRate(): number;
+/**
+ * Gets whether or not telemetry events are captured when running in CI.
+ * @returns Whether or not telemetry events are captured when running in CI.
+ */
+export declare function captureCI(): boolean;
+/**
+ * Gets the whether the process is currently running in CI.
+ * @returns Whether the process is currently running in CI.
+ */
+export declare function isCI(): boolean;
+/**
+ * Gets the type of CI the process is running under.
+ * @returns The type of CI the process is running under.
+ */
+export declare function ciType(): string;
+/**
+ * Gets whether the process is running on a Microsoft owned machine.
+ * @returns Whether the process is running on a Microsoft owned machine.
+ */
+export declare function isMsftInternal(): boolean;
+/**
+ * Gets whether the process is running as part of our CLI tests.
+ * @returns Whether the process is running as part of our CLI tests.
+ */
+export declare function isCliTest(): boolean;
+/**
+ * Gets a stable session ID for correlating telemetry events.
+ * @returns A stable session ID for correlating telemetry events.
+ */
+export declare function getSessionId(): string;

package/lib-commonjs/utils/basePropUtils.js

@@ -0,0 +1,131 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ * @format
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSessionId = exports.isCliTest = exports.isMsftInternal = exports.ciType = exports.isCI = exports.captureCI = exports.sampleRate = exports.deviceDiskFreeSpace = exports.deviceTotalMemory = exports.deviceNumCPUs = exports.deviceLocale = exports.deviceId = void 0;
+const child_process_1 = require("child_process");
+const os_1 = require("os");
+const ci_info_1 = __importDefault(require("ci-info"));
+const crypto_1 = require("crypto");
+const node_machine_id_1 = require("node-machine-id");
+const os_locale_1 = __importDefault(require("os-locale"));
+/**
+ * Gets a telemetry-safe stable device ID.
+ * @returns A telemetry-safe stable device ID.
+ */
+async function deviceId() {
+    return await (0, node_machine_id_1.machineId)(false);
+}
+exports.deviceId = deviceId;
+/**
+ * Gets the device locale.
+ * @returns The device locale.
+ */
+async function deviceLocale() {
+    return await (0, os_locale_1.default)();
+}
+exports.deviceLocale = deviceLocale;
+/**
+ * Gets the device's number of CPUs.
+ * @returns The device's number of CPUs.
+ */
+function deviceNumCPUs() {
+    return (0, os_1.cpus)().length;
+}
+exports.deviceNumCPUs = deviceNumCPUs;
+/**
+ * Gets the device's total memory in bytes.
+ * @returns The device's total memory in bytes.
+ */
+function deviceTotalMemory() {
+    return (0, os_1.totalmem)();
+}
+exports.deviceTotalMemory = deviceTotalMemory;
+/**
+ * Gets the free space of the give drive in bytes.
+ * @param drivePath A path on the drive to check.
+ * @returns The free space of the give drive in bytes.
+ */
+function deviceDiskFreeSpace(drivePath) {
+    try {
+        const out = (0, child_process_1.execSync)(`dir /-C ${drivePath !== null && drivePath !== void 0 ? drivePath : process.cwd()}`)
+            .toString()
+            .split('\r\n');
+        const line = out[out.length - 2];
+        const result = line.match(/(\d+) [^\d]+(\d+) /);
+        if (result && result.length > 2) {
+            return Number(result[2]);
+        }
+    }
+    catch (_a) { }
+    return -1;
+}
+exports.deviceDiskFreeSpace = deviceDiskFreeSpace;
+/**
+ * Gets the telemetry sample rate.
+ * @returns The telemetry sample rate.
+ */
+function sampleRate() {
+    return 100;
+}
+exports.sampleRate = sampleRate;
+/**
+ * Gets whether or not telemetry events are captured when running in CI.
+ * @returns Whether or not telemetry events are captured when running in CI.
+ */
+function captureCI() {
+    // Only capture events in CI if running tests
+    return isCliTest();
+}
+exports.captureCI = captureCI;
+/**
+ * Gets the whether the process is currently running in CI.
+ * @returns Whether the process is currently running in CI.
+ */
+function isCI() {
+    return ci_info_1.default.isCI;
+}
+exports.isCI = isCI;
+/**
+ * Gets the type of CI the process is running under.
+ * @returns The type of CI the process is running under.
+ */
+function ciType() {
+    var _a;
+    return ci_info_1.default.isCI ? (_a = ci_info_1.default.name) !== null && _a !== void 0 ? _a : 'Unknown' : 'None';
+}
+exports.ciType = ciType;
+/**
+ * Gets whether the process is running on a Microsoft owned machine.
+ * @returns Whether the process is running on a Microsoft owned machine.
+ */
+function isMsftInternal() {
+    return (process.env.UserDNSDomain !== undefined &&
+        process.env.UserDNSDomain.toLowerCase().endsWith('corp.microsoft.com'));
+}
+exports.isMsftInternal = isMsftInternal;
+/**
+ * Gets whether the process is running as part of our CLI tests.
+ * @returns Whether the process is running as part of our CLI tests.
+ */
+function isCliTest() {
+    return (process.env.RNW_CLI_TEST !== undefined &&
+        process.env.RNW_CLI_TEST.toLowerCase().trim() === 'true');
+}
+exports.isCliTest = isCliTest;
+let sessionId;
+/**
+ * Gets a stable session ID for correlating telemetry events.
+ * @returns A stable session ID for correlating telemetry events.
+ */
+function getSessionId() {
+    return (sessionId !== null && sessionId !== void 0 ? sessionId : (sessionId = (0, crypto_1.randomBytes)(16).toString('hex').padStart(32, '0')));
+}
+exports.getSessionId = getSessionId;
+//# sourceMappingURL=basePropUtils.js.map

package/lib-commonjs/utils/basePropUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"basePropUtils.js","sourceRoot":"","sources":["../../src/utils/basePropUtils.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;;;;AAEH,iDAAuC;AACvC,2BAAkC;AAElC,sDAAyB;AACzB,mCAAmC;AACnC,qDAA0C;AAC1C,0DAAiC;AAEjC;;;GAGG;AACI,KAAK,UAAU,QAAQ;IAC5B,OAAO,MAAM,IAAA,2BAAS,EAAC,KAAK,CAAC,CAAC;AAChC,CAAC;AAFD,4BAEC;AAED;;;GAGG;AACI,KAAK,UAAU,YAAY;IAChC,OAAO,MAAM,IAAA,mBAAQ,GAAE,CAAC;AAC1B,CAAC;AAFD,oCAEC;AAED;;;GAGG;AACH,SAAgB,aAAa;IAC3B,OAAO,IAAA,SAAI,GAAE,CAAC,MAAM,CAAC;AACvB,CAAC;AAFD,sCAEC;AAED;;;GAGG;AACH,SAAgB,iBAAiB;IAC/B,OAAO,IAAA,aAAQ,GAAE,CAAC;AACpB,CAAC;AAFD,8CAEC;AAED;;;;GAIG;AACH,SAAgB,mBAAmB,CAAC,SAAyB;IAC3D,IAAI;QACF,MAAM,GAAG,GAAG,IAAA,wBAAQ,EAAC,WAAW,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC;aAC1D,QAAQ,EAAE;aACV,KAAK,CAAC,MAAM,CAAC,CAAC;QACjB,MAAM,IAAI,GAAG,GAAG,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QACjC,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;QAChD,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;YAC/B,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;SAC1B;KACF;IAAC,WAAM,GAAE;IACV,OAAO,CAAC,CAAC,CAAC;AACZ,CAAC;AAZD,kDAYC;AAED;;;GAGG;AACH,SAAgB,UAAU;IACxB,OAAO,GAAG,CAAC;AACb,CAAC;AAFD,gCAEC;AAED;;;GAGG;AACH,SAAgB,SAAS;IACvB,6CAA6C;IAC7C,OAAO,SAAS,EAAE,CAAC;AACrB,CAAC;AAHD,8BAGC;AAED;;;GAGG;AACH,SAAgB,IAAI;IAClB,OAAO,iBAAE,CAAC,IAAI,CAAC;AACjB,CAAC;AAFD,oBAEC;AAED;;;GAGG;AACH,SAAgB,MAAM;;IACpB,OAAO,iBAAE,CAAC,IAAI,CAAC,CAAC,CAAC,MAAA,iBAAE,CAAC,IAAI,mCAAI,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC;AACjD,CAAC;AAFD,wBAEC;AAED;;;GAGG;AACH,SAAgB,cAAc;IAC5B,OAAO,CACL,OAAO,CAAC,GAAG,CAAC,aAAa,KAAK,SAAS;QACvC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CACvE,CAAC;AACJ,CAAC;AALD,wCAKC;AAED;;;GAGG;AACH,SAAgB,SAAS;IACvB,OAAO,CACL,OAAO,CAAC,GAAG,CAAC,YAAY,KAAK,SAAS;QACtC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,KAAK,MAAM,CACzD,CAAC;AACJ,CAAC;AALD,8BAKC;AAED,IAAI,SAA6B,CAAC;AAElC;;;GAGG;AACH,SAAgB,YAAY;IAC1B,OAAO,CACL,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,CAAC,SAAS,GAAG,IAAA,oBAAW,EAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,CAC7E,CAAC;AACJ,CAAC;AAJD,oCAIC","sourcesContent":["/**\n * Copyright (c) Microsoft Corporation.\n * Licensed under the MIT License.\n * @format\n */\n\nimport {execSync} from 'child_process';\nimport {totalmem, cpus} from 'os';\n\nimport ci from 'ci-info';\nimport {randomBytes} from 'crypto';\nimport {machineId} from 'node-machine-id';\nimport osLocale from 'os-locale';\n\n/**\n * Gets a telemetry-safe stable device ID.\n * @returns A telemetry-safe stable device ID.\n */\nexport async function deviceId(): Promise<string> {\n  return await machineId(false);\n}\n\n/**\n * Gets the device locale.\n * @returns The device locale.\n */\nexport async function deviceLocale(): Promise<string> {\n  return await osLocale();\n}\n\n/**\n * Gets the device's number of CPUs.\n * @returns The device's number of CPUs.\n */\nexport function deviceNumCPUs(): number {\n  return cpus().length;\n}\n\n/**\n * Gets the device's total memory in bytes.\n * @returns The device's total memory in bytes.\n */\nexport function deviceTotalMemory(): number {\n  return totalmem();\n}\n\n/**\n * Gets the free space of the give drive in bytes.\n * @param drivePath A path on the drive to check.\n * @returns The free space of the give drive in bytes.\n */\nexport function deviceDiskFreeSpace(drivePath?: string | null): number {\n  try {\n    const out = execSync(`dir /-C ${drivePath ?? process.cwd()}`)\n      .toString()\n      .split('\\r\\n');\n    const line = out[out.length - 2];\n    const result = line.match(/(\\d+) [^\\d]+(\\d+) /);\n    if (result && result.length > 2) {\n      return Number(result[2]);\n    }\n  } catch {}\n  return -1;\n}\n\n/**\n * Gets the telemetry sample rate.\n * @returns The telemetry sample rate.\n */\nexport function sampleRate(): number {\n  return 100;\n}\n\n/**\n * Gets whether or not telemetry events are captured when running in CI.\n * @returns Whether or not telemetry events are captured when running in CI.\n */\nexport function captureCI(): boolean {\n  // Only capture events in CI if running tests\n  return isCliTest();\n}\n\n/**\n * Gets the whether the process is currently running in CI.\n * @returns Whether the process is currently running in CI.\n */\nexport function isCI(): boolean {\n  return ci.isCI;\n}\n\n/**\n * Gets the type of CI the process is running under.\n * @returns The type of CI the process is running under.\n */\nexport function ciType(): string {\n  return ci.isCI ? ci.name ?? 'Unknown' : 'None';\n}\n\n/**\n * Gets whether the process is running on a Microsoft owned machine.\n * @returns Whether the process is running on a Microsoft owned machine.\n */\nexport function isMsftInternal(): boolean {\n  return (\n    process.env.UserDNSDomain !== undefined &&\n    process.env.UserDNSDomain.toLowerCase().endsWith('corp.microsoft.com')\n  );\n}\n\n/**\n * Gets whether the process is running as part of our CLI tests.\n * @returns Whether the process is running as part of our CLI tests.\n */\nexport function isCliTest(): boolean {\n  return (\n    process.env.RNW_CLI_TEST !== undefined &&\n    process.env.RNW_CLI_TEST.toLowerCase().trim() === 'true'\n  );\n}\n\nlet sessionId: string | undefined;\n\n/**\n * Gets a stable session ID for correlating telemetry events.\n * @returns A stable session ID for correlating telemetry events.\n */\nexport function getSessionId(): string {\n  return (\n    sessionId ?? (sessionId = randomBytes(16).toString('hex').padStart(32, '0'))\n  );\n}\n"]}

package/lib-commonjs/{CodedError.d.ts → utils/errorUtils.d.ts}

@@ -3,12 +3,14 @@
  * Licensed under the MIT License.
  * @format
  */
+import * as appInsights from 'applicationinsights';
 export declare const CodedErrors: {
     Success: number;
+    Unknown: number;
     UnsupportedReactNativeVersion: number;
     UserCancel: number;
     NoReactNativeFound: number;
-    NoPackageJSon: number;
+    NoPackageJson: number;
     NoLatestReactNativeWindows: number;
     NoAutoMatchingReactNativeWindows: number;
     IncompatibleOptions: number;
@@ -19,12 +21,6 @@ export declare const CodedErrors: {
     CopyProjectTemplateNoSourcePath: number;
     CopyProjectTemplateNoDestPath: number;
     CopyProjectTemplateNoProjectName: number;
-    NoWindowsConfig: number;
-    IncompleteConfig: number;
-    InvalidConfig: number;
-    NeedAutolinking: number;
-    AddProjectToSolution: number;
-    Autolinking: number;
     MinSDKVersionNotMet: number;
     BadSDKVersionFormat: number;
     NoSDK: number;
@@ -45,7 +41,12 @@ export declare const CodedErrors: {
     UninstallAppOnDeviceFailure: number;
     DeployRecipeFailure: number;
     AppStartupFailure: number;
-    Unknown: number;
+    NoWindowsConfig: number;
+    IncompleteConfig: number;
+    InvalidConfig: number;
+    NeedAutolinking: number;
+    AddProjectToSolution: number;
+    Autolinking: number;
 };
 export declare type CodedErrorType = keyof typeof CodedErrors;
 /**
@@ -56,6 +57,24 @@ export declare type CodedErrorType = keyof typeof CodedErrors;
  * @param data any additional metadata that is safe to collect for telemetry purposes.
  */
 export declare class CodedError extends Error {
+    readonly type: CodedErrorType;
     readonly data?: Record<string, any> | undefined;
     constructor(type: CodedErrorType, message: string, data?: Record<string, any> | undefined);
 }
+/**
+ * Tries to parse an error code out of an error message.
+ * @param msg An error message to process.
+ * @returns The parsed error code.
+ */
+export declare function tryGetErrorCode(msg: string): string | undefined;
+/**
+ * Sanitize an error message by anonymizing any paths that appear between quotes (''), brackets ([]), or double quotes ("").
+ * @param msg The error message to sanitize.
+ * @return The message with any paths anonymized.
+ */
+export declare function sanitizeErrorMessage(msg: string): string;
+/**
+ * Sanitizes an error stack frame.
+ * @param frame
+ */
+export declare function sanitizeErrorStackFrame(frame: appInsights.Contracts.StackFrame): void;

package/lib-commonjs/utils/errorUtils.js

@@ -0,0 +1,164 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ * @format
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sanitizeErrorStackFrame = exports.sanitizeErrorMessage = exports.tryGetErrorCode = exports.CodedError = exports.CodedErrors = void 0;
+const sanitizeUtils = __importStar(require("./sanitizeUtils"));
+// Note: All CLI commands will set process.exitCode to the numerical value of
+// a thrown CodedError. However node reserves codes 1-192 as per:
+// https://nodejs.org/api/process.html#process_exit_codes so we shouldn't
+// override those as other tools may be monitoring the error code
+exports.CodedErrors = {
+    Success: 0,
+    Unknown: -1,
+    // init
+    UnsupportedReactNativeVersion: 1000,
+    UserCancel: 1001,
+    NoReactNativeFound: 1002,
+    NoPackageJson: 1003,
+    NoLatestReactNativeWindows: 1004,
+    NoAutoMatchingReactNativeWindows: 1005,
+    IncompatibleOptions: 1006,
+    NoReactNativeDependencies: 1007,
+    NoMatchingPackageVersion: 1008,
+    // run-windows
+    NoSolution: 2000,
+    // Project generation
+    NoPropertyInProject: 2100,
+    CopyProjectTemplateNoSourcePath: 2101,
+    CopyProjectTemplateNoDestPath: 2102,
+    CopyProjectTemplateNoProjectName: 2103,
+    // SDK requirements
+    MinSDKVersionNotMet: 2200,
+    BadSDKVersionFormat: 2201,
+    NoSDK: 2202,
+    // Build
+    NoMSBuild: 2300,
+    NoVSWhere: 2301,
+    MSBuildError: 2302,
+    // Deploy
+    NoAppPackage: 2400,
+    NoAppxManifest: 2401,
+    NoDevice: 2402,
+    AppDidNotDeploy: 2403,
+    InvalidDevicesOutput: 2404,
+    RemoveOldAppVersionFailure: 2405,
+    EnableDevModeFailure: 2406,
+    InstallAppFailure: 2407,
+    InstallAppDependenciesFailure: 2408,
+    CheckNetIsolationFailure: 2409,
+    InstallAppToDeviceFailure: 2410,
+    UninstallAppOnDeviceFailure: 2411,
+    DeployRecipeFailure: 2412,
+    // Launch
+    AppStartupFailure: 2500,
+    // autolink-windows
+    NoWindowsConfig: 3000,
+    IncompleteConfig: 3001,
+    InvalidConfig: 3002,
+    NeedAutolinking: 3003,
+    AddProjectToSolution: 3004,
+    Autolinking: 3005,
+};
+/**
+ * Represents an error whose message might contain user-originating content,
+ * therefore when transmitting telemetry, only the type should be sent.
+ * @param type a stable ID identifying the type of error.
+ * @param message the error text. This should only be used for display to the user.
+ * @param data any additional metadata that is safe to collect for telemetry purposes.
+ */
+class CodedError extends Error {
+    constructor(type, message, data) {
+        super(message);
+        this.type = type;
+        this.data = data;
+        this.name = type;
+    }
+}
+exports.CodedError = CodedError;
+/**
+ * Tries to parse an error code out of an error message.
+ * @param msg An error message to process.
+ * @returns The parsed error code.
+ */
+function tryGetErrorCode(msg) {
+    const errorRegEx = /error (\w+\d+):/gi;
+    const m = errorRegEx.exec(msg);
+    return m ? m[1] : undefined;
+}
+exports.tryGetErrorCode = tryGetErrorCode;
+/**
+ * Sanitize an error message by anonymizing any paths that appear between quotes (''), brackets ([]), or double quotes ("").
+ * @param msg The error message to sanitize.
+ * @return The message with any paths anonymized.
+ */
+function sanitizeErrorMessage(msg) {
+    const cpuThreadId = /^\d+(:\d+)?>/g;
+    msg = msg.replace(cpuThreadId, '');
+    const parts = msg.split(/['[\]"]/g);
+    const clean = [];
+    const pathRegEx = /(['["]?)([A-Za-z]:|\\)[\\/]([^<>:;,?"*\t\r\n|/\\]+[\\/])+([^<>:;,?"*\t\r\n|]+\/?(['["]?))/gi;
+    for (const part of parts) {
+        if (pathRegEx.test(part)) {
+            pathRegEx.lastIndex = -1;
+            let matches;
+            let noPath = '';
+            let last = 0;
+            while ((matches = pathRegEx.exec(part))) {
+                noPath +=
+                    part.substr(last, matches.index - last) +
+                        sanitizeUtils.getAnonymizedPath(matches[0]);
+                last = matches.index + matches[0].length;
+            }
+            if (noPath !== '') {
+                clean.push(noPath);
+            }
+        }
+        else if (part !== '') {
+            clean.push(part);
+        }
+    }
+    return clean.join('').trim();
+}
+exports.sanitizeErrorMessage = sanitizeErrorMessage;
+/**
+ * Sanitizes an error stack frame.
+ * @param frame
+ */
+function sanitizeErrorStackFrame(frame) {
+    const parens = frame.method.indexOf('(');
+    if (parens !== -1) {
+        // case 1: method === 'methodName (rootOfThePath'
+        frame.method = frame.method.substr(0, parens).trim();
+    }
+    else {
+        // case 2: method === <no_method> or something without '(', fileName is full path
+    }
+    // anonymize the filename
+    frame.fileName = sanitizeUtils.getAnonymizedPath(frame.fileName);
+    frame.assembly = '';
+}
+exports.sanitizeErrorStackFrame = sanitizeErrorStackFrame;
+//# sourceMappingURL=errorUtils.js.map

package/lib-commonjs/utils/errorUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errorUtils.js","sourceRoot":"","sources":["../../src/utils/errorUtils.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;;;;;;;;;;;;;;;;;;;;AAIH,+DAAiD;AAEjD,6EAA6E;AAC7E,iEAAiE;AACjE,yEAAyE;AACzE,iEAAiE;AAEpD,QAAA,WAAW,GAAG;IACzB,OAAO,EAAE,CAAC;IACV,OAAO,EAAE,CAAC,CAAC;IAEX,OAAO;IACP,6BAA6B,EAAE,IAAI;IACnC,UAAU,EAAE,IAAI;IAChB,kBAAkB,EAAE,IAAI;IACxB,aAAa,EAAE,IAAI;IACnB,0BAA0B,EAAE,IAAI;IAChC,gCAAgC,EAAE,IAAI;IACtC,mBAAmB,EAAE,IAAI;IACzB,yBAAyB,EAAE,IAAI;IAC/B,wBAAwB,EAAE,IAAI;IAE9B,cAAc;IACd,UAAU,EAAE,IAAI;IAChB,qBAAqB;IACrB,mBAAmB,EAAE,IAAI;IACzB,+BAA+B,EAAE,IAAI;IACrC,6BAA6B,EAAE,IAAI;IACnC,gCAAgC,EAAE,IAAI;IACtC,mBAAmB;IACnB,mBAAmB,EAAE,IAAI;IACzB,mBAAmB,EAAE,IAAI;IACzB,KAAK,EAAE,IAAI;IACX,QAAQ;IACR,SAAS,EAAE,IAAI;IACf,SAAS,EAAE,IAAI;IACf,YAAY,EAAE,IAAI;IAClB,SAAS;IACT,YAAY,EAAE,IAAI;IAClB,cAAc,EAAE,IAAI;IACpB,QAAQ,EAAE,IAAI;IACd,eAAe,EAAE,IAAI;IACrB,oBAAoB,EAAE,IAAI;IAC1B,0BAA0B,EAAE,IAAI;IAChC,oBAAoB,EAAE,IAAI;IAC1B,iBAAiB,EAAE,IAAI;IACvB,6BAA6B,EAAE,IAAI;IACnC,wBAAwB,EAAE,IAAI;IAC9B,yBAAyB,EAAE,IAAI;IAC/B,2BAA2B,EAAE,IAAI;IACjC,mBAAmB,EAAE,IAAI;IACzB,SAAS;IACT,iBAAiB,EAAE,IAAI;IAEvB,mBAAmB;IACnB,eAAe,EAAE,IAAI;IACrB,gBAAgB,EAAE,IAAI;IACtB,aAAa,EAAE,IAAI;IACnB,eAAe,EAAE,IAAI;IACrB,oBAAoB,EAAE,IAAI;IAC1B,WAAW,EAAE,IAAI;CAClB,CAAC;AAIF;;;;;;GAMG;AACH,MAAa,UAAW,SAAQ,KAAK;IACnC,YACkB,IAAoB,EACpC,OAAe,EACC,IAA0B;QAE1C,KAAK,CAAC,OAAO,CAAC,CAAC;QAJC,SAAI,GAAJ,IAAI,CAAgB;QAEpB,SAAI,GAAJ,IAAI,CAAsB;QAG1C,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AATD,gCASC;AAED;;;;GAIG;AACH,SAAgB,eAAe,CAAC,GAAW;IACzC,MAAM,UAAU,GAAG,mBAAmB,CAAC;IACvC,MAAM,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC/B,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAC9B,CAAC;AAJD,0CAIC;AAED;;;;GAIG;AACH,SAAgB,oBAAoB,CAAC,GAAW;IAC9C,MAAM,WAAW,GAAG,eAAe,CAAC;IACpC,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;IACnC,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACpC,MAAM,KAAK,GAAG,EAAE,CAAC;IACjB,MAAM,SAAS,GACb,6FAA6F,CAAC;IAChG,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;QACxB,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YACxB,SAAS,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC;YACzB,IAAI,OAA+B,CAAC;YACpC,IAAI,MAAM,GAAG,EAAE,CAAC;YAChB,IAAI,IAAI,GAAG,CAAC,CAAC;YACb,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE;gBACvC,MAAM;oBACJ,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,OAAQ,CAAC,KAAK,GAAG,IAAI,CAAC;wBACxC,aAAa,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC9C,IAAI,GAAG,OAAQ,CAAC,KAAK,GAAG,OAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;aAC5C;YACD,IAAI,MAAM,KAAK,EAAE,EAAE;gBACjB,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;aACpB;SACF;aAAM,IAAI,IAAI,KAAK,EAAE,EAAE;YACtB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAClB;KACF;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;AAC/B,CAAC;AA3BD,oDA2BC;AAED;;;GAGG;AACH,SAAgB,uBAAuB,CACrC,KAAuC;IAEvC,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACzC,IAAI,MAAM,KAAK,CAAC,CAAC,EAAE;QACjB,iDAAiD;QACjD,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC;KACtD;SAAM;QACL,iFAAiF;KAClF;IACD,yBAAyB;IACzB,KAAK,CAAC,QAAQ,GAAG,aAAa,CAAC,iBAAiB,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACjE,KAAK,CAAC,QAAQ,GAAG,EAAE,CAAC;AACtB,CAAC;AAbD,0DAaC","sourcesContent":["/**\n * Copyright (c) Microsoft Corporation.\n * Licensed under the MIT License.\n * @format\n */\n\nimport * as appInsights from 'applicationinsights';\n\nimport * as sanitizeUtils from './sanitizeUtils';\n\n// Note: All CLI commands will set process.exitCode to the numerical value of\n// a thrown CodedError. However node reserves codes 1-192 as per:\n// https://nodejs.org/api/process.html#process_exit_codes so we shouldn't\n// override those as other tools may be monitoring the error code\n\nexport const CodedErrors = {\n  Success: 0,\n  Unknown: -1,\n\n  // init\n  UnsupportedReactNativeVersion: 1000,\n  UserCancel: 1001,\n  NoReactNativeFound: 1002,\n  NoPackageJson: 1003,\n  NoLatestReactNativeWindows: 1004,\n  NoAutoMatchingReactNativeWindows: 1005,\n  IncompatibleOptions: 1006,\n  NoReactNativeDependencies: 1007,\n  NoMatchingPackageVersion: 1008,\n\n  // run-windows\n  NoSolution: 2000,\n  // Project generation\n  NoPropertyInProject: 2100,\n  CopyProjectTemplateNoSourcePath: 2101,\n  CopyProjectTemplateNoDestPath: 2102,\n  CopyProjectTemplateNoProjectName: 2103,\n  // SDK requirements\n  MinSDKVersionNotMet: 2200,\n  BadSDKVersionFormat: 2201,\n  NoSDK: 2202,\n  // Build\n  NoMSBuild: 2300,\n  NoVSWhere: 2301,\n  MSBuildError: 2302,\n  // Deploy\n  NoAppPackage: 2400,\n  NoAppxManifest: 2401,\n  NoDevice: 2402,\n  AppDidNotDeploy: 2403,\n  InvalidDevicesOutput: 2404,\n  RemoveOldAppVersionFailure: 2405,\n  EnableDevModeFailure: 2406,\n  InstallAppFailure: 2407,\n  InstallAppDependenciesFailure: 2408,\n  CheckNetIsolationFailure: 2409,\n  InstallAppToDeviceFailure: 2410,\n  UninstallAppOnDeviceFailure: 2411,\n  DeployRecipeFailure: 2412,\n  // Launch\n  AppStartupFailure: 2500,\n\n  // autolink-windows\n  NoWindowsConfig: 3000,\n  IncompleteConfig: 3001,\n  InvalidConfig: 3002,\n  NeedAutolinking: 3003,\n  AddProjectToSolution: 3004,\n  Autolinking: 3005,\n};\n\nexport type CodedErrorType = keyof typeof CodedErrors;\n\n/**\n * Represents an error whose message might contain user-originating content,\n * therefore when transmitting telemetry, only the type should be sent.\n * @param type a stable ID identifying the type of error.\n * @param message the error text. This should only be used for display to the user.\n * @param data any additional metadata that is safe to collect for telemetry purposes.\n */\nexport class CodedError extends Error {\n  constructor(\n    public readonly type: CodedErrorType,\n    message: string,\n    public readonly data?: Record<string, any>,\n  ) {\n    super(message);\n    this.name = type;\n  }\n}\n\n/**\n * Tries to parse an error code out of an error message.\n * @param msg An error message to process.\n * @returns The parsed error code.\n */\nexport function tryGetErrorCode(msg: string): string | undefined {\n  const errorRegEx = /error (\\w+\\d+):/gi;\n  const m = errorRegEx.exec(msg);\n  return m ? m[1] : undefined;\n}\n\n/**\n * Sanitize an error message by anonymizing any paths that appear between quotes (''), brackets ([]), or double quotes (\"\").\n * @param msg The error message to sanitize.\n * @return The message with any paths anonymized.\n */\nexport function sanitizeErrorMessage(msg: string): string {\n  const cpuThreadId = /^\\d+(:\\d+)?>/g;\n  msg = msg.replace(cpuThreadId, '');\n  const parts = msg.split(/['[\\]\"]/g);\n  const clean = [];\n  const pathRegEx =\n    /(['[\"]?)([A-Za-z]:|\\\\)[\\\\/]([^<>:;,?\"*\\t\\r\\n|/\\\\]+[\\\\/])+([^<>:;,?\"*\\t\\r\\n|]+\\/?(['[\"]?))/gi;\n  for (const part of parts) {\n    if (pathRegEx.test(part)) {\n      pathRegEx.lastIndex = -1;\n      let matches: RegExpExecArray | null;\n      let noPath = '';\n      let last = 0;\n      while ((matches = pathRegEx.exec(part))) {\n        noPath +=\n          part.substr(last, matches!.index - last) +\n          sanitizeUtils.getAnonymizedPath(matches[0]);\n        last = matches!.index + matches![0].length;\n      }\n      if (noPath !== '') {\n        clean.push(noPath);\n      }\n    } else if (part !== '') {\n      clean.push(part);\n    }\n  }\n  return clean.join('').trim();\n}\n\n/**\n * Sanitizes an error stack frame.\n * @param frame\n */\nexport function sanitizeErrorStackFrame(\n  frame: appInsights.Contracts.StackFrame,\n): void {\n  const parens = frame.method.indexOf('(');\n  if (parens !== -1) {\n    // case 1: method === 'methodName (rootOfThePath'\n    frame.method = frame.method.substr(0, parens).trim();\n  } else {\n    // case 2: method === <no_method> or something without '(', fileName is full path\n  }\n  // anonymize the filename\n  frame.fileName = sanitizeUtils.getAnonymizedPath(frame.fileName);\n  frame.assembly = '';\n}\n"]}

package/lib-commonjs/utils/optionUtils.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ * @format
+ */
+export declare type OptionSanitizer = (key: string, value: any) => any;
+export declare type YargsOptionsType = Record<string, any>;
+export interface CommanderOptionsType extends Record<string, any> {
+    logging?: boolean;
+    telemetry?: boolean;
+}
+/**
+ * Converts a raw Commander arg name ('--no-bad-dog') into an options property name ('badDog').
+ * @param name The raw Commander arg name.
+ * @returns The options name.
+ */
+export declare function commanderNameToOptionName(name: string): string;
+/**
+ * Converts a yargs-parsed options object into an options object suitable for telemetry.
+ * @param options The options object as parsed by yargs.
+ * @param sanitizer Function to sanitize the option values for telemetry.
+ * @returns An options object suitable for telemetry.
+ */
+export declare function yargsOptionsToOptions(options: YargsOptionsType, sanitizer?: OptionSanitizer): Record<string, any>;
+/**
+ * Converts a Commander-parsed options object into an options object suitable for telemetry.
+ * @param options The options object as parsed by Commander.
+ * @param sanitizer Function to sanitize the option values for telemetry.
+ * @returns An options object suitable for telemetry.
+ */
+export declare function commanderOptionsToOptions(options: CommanderOptionsType, sanitizer?: OptionSanitizer): Record<string, any>;
+/**
+ * Checks whether the given command-line args contains the given option key.
+ * @param key The option key to look for.
+ * @param argv The raw command-line args.
+ * @returns Whether the given command-line args contains the given option key.
+ */
+export declare function argsContainsOption(key: string, argv: string[]): boolean;
+/**
+ * Filters down a given set of options to only include those that were present in the command-line args.
+ * @param options The full set of options.
+ * @param argv The raw command-line args.
+ * @returns The filtered set of options.
+ */
+export declare function optionsToArgs(options: Record<string, any>, argv: string[]): Record<string, any>;