[core-rest-pipeline] Add conditional exports

common/tools/dev-tool/src/commands/run/bundle.ts

@@ -39,6 +39,11 @@ export const commandInfo = makeCommandInfo(
       default: true,
       description: "include a polyfill for Node.js builtin modules",
     },
+    "output-cjs-ext": {
+      kind: "boolean",
+      default: false,
+      description: "use .cjs extension for bundle output. default is .js extension",
+    },
   }
 );
 
@@ -72,7 +77,7 @@ export default leafCommand(commandInfo, async (options) => {
       const bundle = await rollup.rollup(baseConfig);
 
       await bundle.write({
-        file: "dist/index.js",
+        file: `dist/index.${options["output-cjs-ext"] ? "cjs" : "js"}`,
         format: "cjs",
         sourcemap: true,
         exports: "named",

common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-main-is-cjs.md

@@ -1,6 +1,6 @@
 # ts-package-json-main-is-cjs
 
-Requires `main` in `package.json` to be point to a CommonJS or UMD module. In this case, its assumed that it points to `"dist/index.js"`.
+Requires `main` in `package.json` to be point to a CommonJS or UMD module. In this case, its assumed that it points to `"dist/index.js"` or `"dist/index.cjs"`.
 
 This rule is fixable using the `--fix` option.
 
@@ -14,6 +14,14 @@ This rule is fixable using the `--fix` option.
 }
 ```
 
+### Good
+
+```json
+{
+  "main": "dist/index.cjs"
+}
+```
+
 ### Bad
 
 ```json

common/tools/eslint-plugin-azure-sdk/src/rules/ts-package-json-main-is-cjs.ts

@@ -45,10 +45,10 @@ export = {
             const nodeValue = node.value as Literal;
             const main = nodeValue.value as string;
 
-            if (!/^(\.\/)?dist\/index\.js$/.test(main)) {
+            if (!/^(\.\/)?dist\/index\.(c)?js$/.test(main)) {
               context.report({
                 node: nodeValue,
-                message: `main is set to ${main} when it should be set to dist/index.js`,
+                message: `main is set to ${main} when it should be set to dist/index.js or dist/index.cjs`,
                 fix: (fixer: Rule.RuleFixer): Rule.Fix =>
                   fixer.replaceText(nodeValue, `"dist/index.js"`),
               });

common/tools/eslint-plugin-azure-sdk/src/rules/ts-use-interface-parameters.ts

@@ -286,18 +286,17 @@ export = {
                 const symbol = typeChecker
                   .getTypeAtLocation(converter.get(node as TSESTree.Node))
                   .getSymbol();
-                const overloads =
-                  symbol?.declarations
-                    ? symbol.declarations
-                        .filter(
-                          (declaration: Declaration): boolean =>
-                            reverter.get(declaration as TSNode) !== undefined
-                        )
-                        .map((declaration: Declaration): FunctionExpression => {
-                          const method = reverter.get(declaration as TSNode) as MethodDefinition;
-                          return method.value;
-                        })
-                    : [];
+                const overloads = symbol?.declarations
+                  ? symbol.declarations
+                      .filter(
+                        (declaration: Declaration): boolean =>
+                          reverter.get(declaration as TSNode) !== undefined
+                      )
+                      .map((declaration: Declaration): FunctionExpression => {
+                        const method = reverter.get(declaration as TSNode) as MethodDefinition;
+                        return method.value;
+                      })
+                  : [];
                 evaluateOverloads(
                   overloads,
                   converter,
@@ -326,13 +325,12 @@ export = {
                 const symbol = typeChecker
                   .getTypeAtLocation(converter.get(node as TSESTree.Node))
                   .getSymbol();
-                const overloads =
-                  symbol?.declarations
-                    ? symbol.declarations.map(
-                        (declaration: Declaration): FunctionDeclaration =>
-                          reverter.get(declaration as TSNode) as FunctionDeclaration
-                      )
-                    : [];
+                const overloads = symbol?.declarations
+                  ? symbol.declarations.map(
+                      (declaration: Declaration): FunctionDeclaration =>
+                        reverter.get(declaration as TSNode) as FunctionDeclaration
+                    )
+                  : [];
                 evaluateOverloads(
                   overloads,
                   converter,

common/tools/eslint-plugin-azure-sdk/tests/rules/ts-package-json-main-is-cjs.ts

@@ -263,6 +263,16 @@ ruleTester.run("ts-package-json-main-is-cjs", rule, {
       code: '{"main": "./dist/index.js"}',
       filename: "package.json",
     },
+    {
+      // correct format #1
+      code: '{"main": "dist/index.cjs"}',
+      filename: "package.json",
+    },
+    {
+      // correct format #2
+      code: '{"main": "./dist/index.cjs"}',
+      filename: "package.json",
+    },
     {
       // a full example package.json (taken from https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/eventhub/event-hubs/package.json with "scripts" removed for testing purposes)
       code: examplePackageGood,
@@ -300,7 +310,8 @@ ruleTester.run("ts-package-json-main-is-cjs", rule, {
       filename: "package.json",
       errors: [
         {
-          message: "main is set to dist//index.js when it should be set to dist/index.js",
+          message:
+            "main is set to dist//index.js when it should be set to dist/index.js or dist/index.cjs",
         },
       ],
       output: '{"main": "dist/index.js"}',
@@ -310,7 +321,8 @@ ruleTester.run("ts-package-json-main-is-cjs", rule, {
       filename: "package.json",
       errors: [
         {
-          message: "main is set to .dist/index.js when it should be set to dist/index.js",
+          message:
+            "main is set to .dist/index.js when it should be set to dist/index.js or dist/index.cjs",
         },
       ],
       output: '{"main": "dist/index.js"}',
@@ -320,7 +332,8 @@ ruleTester.run("ts-package-json-main-is-cjs", rule, {
       filename: "package.json",
       errors: [
         {
-          message: "main is set to /dist/index.js when it should be set to dist/index.js",
+          message:
+            "main is set to /dist/index.js when it should be set to dist/index.js or dist/index.cjs",
         },
       ],
       output: '{"main": "dist/index.js"}',
@@ -331,7 +344,7 @@ ruleTester.run("ts-package-json-main-is-cjs", rule, {
       filename: "package.json",
       errors: [
         {
-          message: "main is set to dist when it should be set to dist/index.js",
+          message: "main is set to dist when it should be set to dist/index.js or dist/index.cjs",
         },
       ],
       output: '{"main": "dist/index.js"}',
@@ -341,7 +354,8 @@ ruleTester.run("ts-package-json-main-is-cjs", rule, {
       filename: "package.json",
       errors: [
         {
-          message: "main is set to index.js when it should be set to dist/index.js",
+          message:
+            "main is set to index.js when it should be set to dist/index.js or dist/index.cjs",
         },
       ],
       output: '{"main": "dist/index.js"}',
@@ -351,7 +365,8 @@ ruleTester.run("ts-package-json-main-is-cjs", rule, {
       filename: "package.json",
       errors: [
         {
-          message: "main is set to dist/src/index.js when it should be set to dist/index.js",
+          message:
+            "main is set to dist/src/index.js when it should be set to dist/index.js or dist/index.cjs",
         },
       ],
       output: '{"main": "dist/index.js"}',
@@ -362,7 +377,8 @@ ruleTester.run("ts-package-json-main-is-cjs", rule, {
       filename: "package.json",
       errors: [
         {
-          message: "main is set to index.js when it should be set to dist/index.js",
+          message:
+            "main is set to index.js when it should be set to dist/index.js or dist/index.cjs",
         },
       ],
       output: examplePackageGood,

sdk/core/core-rest-pipeline/CHANGELOG.md

@@ -1,9 +1,11 @@
 # Release History
 
-## 1.9.2 (Unreleased)
+## 1.10.0 (Unreleased)
 
 ### Features Added
 
+- Added conditional exports for CommonJS and ESM. [#22804](https://github.com/Azure/azure-sdk-for-js/pull/22804)
+
 ### Breaking Changes
 
 ### Bugs Fixed

sdk/core/core-rest-pipeline/package.json

@@ -1,10 +1,18 @@
 {
   "name": "@azure/core-rest-pipeline",
-  "version": "1.9.2",
+  "version": "1.10.0",
   "description": "Isomorphic client library for making HTTP requests in node.js and browser.",
   "sdk-type": "client",
-  "main": "dist/index.js",
+  "main": "dist/index.cjs",
   "module": "dist-esm/src/index.js",
+  "type": "module",
+  "export": {
+    ".": {
+      "types": "core-rest-pipeline.shims.d.ts",
+      "require": "./dist/index.cjs",
+      "import": "./dist-esm/src/index.js"
+    }
+  },
   "browser": {
     "./dist-esm/src/defaultHttpClient.js": "./dist-esm/src/defaultHttpClient.browser.js",
     "./dist-esm/src/policies/decompressResponsePolicy.js": "./dist-esm/src/policies/decompressResponsePolicy.browser.js",
@@ -14,7 +22,7 @@
     "./dist-esm/src/util/userAgentPlatform.js": "./dist-esm/src/util/userAgentPlatform.browser.js"
   },
   "react-native": {
-    "./dist/index.js": "./dist-esm/src/index.js",
+    "./dist/index.cjs": "./dist-esm/src/index.js",
     "./dist-esm/src/defaultHttpClient.js": "./dist-esm/src/defaultHttpClient.native.js",
     "./dist-esm/src/util/userAgentPlatform.js": "./dist-esm/src/util/userAgentPlatform.native.js"
   },
@@ -29,9 +37,9 @@
   "scripts": {
     "audit": "node ../../../common/scripts/rush-audit.js && rimraf node_modules package-lock.json && npm i --package-lock-only 2>&1 && npm audit",
     "build:samples": "echo Obsolete",
-    "build:test": "tsc -p . && dev-tool run bundle",
+    "build:test": "tsc -p . && dev-tool run bundle --output-cjs-ext=true",
     "build:types": "downlevel-dts types/latest/ types/3.1/",
-    "build": "npm run clean && tsc -p . && dev-tool run bundle && api-extractor run --local && npm run build:types",
+    "build": "npm run clean && tsc -p . && dev-tool run bundle --output-cjs-ext=true && api-extractor run --local && npm run build:types",
     "check-format": "prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"*.{js,json}\"",
     "clean": "rimraf dist dist-* temp types *.tgz *.log",
     "execute:samples": "echo skipped",
@@ -45,15 +53,17 @@
     "pack": "npm pack 2>&1",
     "test:browser": "npm run clean && npm run build:test && npm run unit-test:browser && npm run integration-test:browser",
     "test:node": "npm run clean && tsc -p . && npm run unit-test:node && npm run integration-test:node",
-    "test": "npm run clean && tsc -p . && npm run unit-test:node && dev-tool run bundle && npm run unit-test:browser && npm run integration-test",
-    "unit-test:browser": "karma start --single-run",
-    "unit-test:node": "mocha -r esm -r ts-node/register --reporter ../../../common/tools/mocha-multi-reporter.js --timeout 1200000 --full-trace  --exclude \"test/**/browser/*.spec.ts\" \"test/**/*.spec.ts\"",
+    "test": "npm run clean && tsc -p . && npm run unit-test:node && dev-tool run bundle --output-cjs-ext=true && npm run unit-test:browser && npm run integration-test",
+    "unit-test:browser": "karma start karma.conf.cjs --single-run",
+    "unit-test:node": "mocha --reporter ../../../common/tools/mocha-multi-reporter.js --timeout 1200000 --full-trace  --exclude \"test/**/browser/*.spec.ts\" \"test/**/*.spec.ts\"",
     "unit-test": "npm run unit-test:node && npm run unit-test:browser"
   },
   "files": [
     "dist/",
     "dist-esm/src/",
+    "types/3.1/src/",
     "types/3.1/core-rest-pipeline.d.ts",
+    "types/latest/src/",
     "types/latest/core-rest-pipeline.d.ts",
     "core-rest-pipeline.shims.d.ts",
     "core-rest-pipeline.shims-3_1.d.ts",
@@ -125,15 +135,19 @@
     "karma-sourcemap-loader": "^0.3.8",
     "karma": "^6.3.0",
     "mocha-junit-reporter": "^2.0.0",
-    "mocha": "^7.1.1",
+    "mocha": "^10.0.0",
     "prettier": "^2.5.1",
     "puppeteer": "^14.0.0",
     "rimraf": "^3.0.0",
     "sinon": "^9.0.2",
     "source-map-support": "^0.5.9",
-    "typescript": "~4.6.0",
+    "ts-node": "^10.0.0",
+    "typescript": "~4.7.0",
     "util": "^0.12.1"
   },
+  "mocha": {
+    "loader": "ts-node/esm"
+  },
   "//sampleConfiguration": {
     "skipFolder": true,
     "disableDocsMs": true,

sdk/core/core-rest-pipeline/src/constants.ts

@@ -1,6 +1,6 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-export const SDK_VERSION: string = "1.9.2";
+export const SDK_VERSION: string = "1.10.0";
 
 export const DEFAULT_RETRY_POLICY_COUNT = 3;

sdk/core/core-rest-pipeline/src/createPipelineFromOptions.ts

@@ -1,21 +1,21 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-import { LogPolicyOptions, logPolicy } from "./policies/logPolicy";
-import { Pipeline, createEmptyPipeline } from "./pipeline";
-import { PipelineRetryOptions, TlsSettings } from "./interfaces";
-import { RedirectPolicyOptions, redirectPolicy } from "./policies/redirectPolicy";
-import { UserAgentPolicyOptions, userAgentPolicy } from "./policies/userAgentPolicy";
+import { LogPolicyOptions, logPolicy } from "./policies/logPolicy.js";
+import { Pipeline, createEmptyPipeline } from "./pipeline.js";
+import { PipelineRetryOptions, TlsSettings } from "./interfaces.js";
+import { RedirectPolicyOptions, redirectPolicy } from "./policies/redirectPolicy.js";
+import { UserAgentPolicyOptions, userAgentPolicy } from "./policies/userAgentPolicy.js";
 
-import { ProxySettings } from ".";
-import { decompressResponsePolicy } from "./policies/decompressResponsePolicy";
-import { defaultRetryPolicy } from "./policies/defaultRetryPolicy";
-import { formDataPolicy } from "./policies/formDataPolicy";
+import { ProxySettings } from "./interfaces.js";
+import { decompressResponsePolicy } from "./policies/decompressResponsePolicy.js";
+import { defaultRetryPolicy } from "./policies/defaultRetryPolicy.js";
+import { formDataPolicy } from "./policies/formDataPolicy.js";
 import { isNode } from "@azure/core-util";
-import { proxyPolicy } from "./policies/proxyPolicy";
-import { setClientRequestIdPolicy } from "./policies/setClientRequestIdPolicy";
-import { tlsPolicy } from "./policies/tlsPolicy";
-import { tracingPolicy } from "./policies/tracingPolicy";
+import { proxyPolicy } from "./policies/proxyPolicy.js";
+import { setClientRequestIdPolicy } from "./policies/setClientRequestIdPolicy.js";
+import { tlsPolicy } from "./policies/tlsPolicy.js";
+import { tracingPolicy } from "./policies/tracingPolicy.js";
 
 /**
  * Defines options that are used to configure the HTTP pipeline for

sdk/core/core-rest-pipeline/src/defaultHttpClient.browser.ts

@@ -1,8 +1,8 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-import { HttpClient } from "./interfaces";
-import { createFetchHttpClient } from "./fetchHttpClient";
+import { HttpClient } from "./interfaces.js";
+import { createFetchHttpClient } from "./fetchHttpClient.js";
 
 /**
  * Create the correct HttpClient for the current environment.

sdk/core/core-rest-pipeline/src/defaultHttpClient.native.ts

@@ -1,8 +1,8 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-import { HttpClient } from "./interfaces";
-import { createXhrHttpClient } from "./xhrHttpClient";
+import { HttpClient } from "./interfaces.js";
+import { createXhrHttpClient } from "./xhrHttpClient.js";
 
 /**
  * Create the correct HttpClient for the current environment.