[KeyVault] Common folder

eng/.docsettings.yml

@@ -7,6 +7,7 @@ omitted_paths:
   - sdk/identity/identity/test/manual-integration/*
   - sdk/test-utils/perfstress/README.md
   - sdk/keyvault/*/test/README.md
+  - sdk/keyvault/keyvault-common/*
   - sdk/appconfiguration/*/test/README.md
   - sdk/eventhub/*/test/README.md
   - sdk/search/*/test/README.md

rush.json

@@ -422,6 +422,11 @@
       "projectFolder": "sdk/identity/identity",
       "versionPolicyName": "client"
     },
+    {
+      "packageName": "@azure/keyvault-common",
+      "projectFolder": "sdk/keyvault/keyvault-common",
+      "versionPolicyName": "utility"
+    },
     {
       "packageName": "@azure/keyvault-certificates",
       "projectFolder": "sdk/keyvault/keyvault-certificates",

sdk/keyvault/keyvault-certificates/.eslintrc.json

@@ -4,6 +4,8 @@
   "ignorePatterns": ["src/core"],
   "rules": {
     "@typescript-eslint/no-this-alias": "off",
-    "no-invalid-this": "off"
+    "no-invalid-this": "off",
+    "@azure/azure-sdk/ts-package-json-module": "warn",
+    "@azure/azure-sdk/ts-package-json-files-required": "warn"
   }
 }

sdk/keyvault/keyvault-certificates/api-extractor.json

@@ -1,6 +1,6 @@
 {
   "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-  "mainEntryPointFilePath": "types/src/index.d.ts",
+  "mainEntryPointFilePath": "types/keyvault-certificates/src/index.d.ts",
   "docModel": {
     "enabled": false
   },

sdk/keyvault/keyvault-certificates/package.json

@@ -20,15 +20,17 @@
     "url": "https://github.com/Azure/azure-sdk-for-js/issues"
   },
   "main": "./dist/index.js",
-  "module": "dist-esm/src/index.js",
+  "module": "dist-esm/keyvault-certificates/src/index.js",
   "types": "./types/keyvault-certificates.d.ts",
   "engines": {
     "node": ">=8.0.0"
   },
   "files": [
-    "types/keyvault-certificates.d.ts",
+    "types/",
     "dist/",
-    "dist-esm/src",
+    "dist-browser/",
+    "dist-esm/keyvault-certificates/src",
+    "dist-esm/keyvault-common/src",
     "README.md",
     "LICENSE"
   ],
@@ -52,8 +54,8 @@
     "extract-api": "tsc -p . && api-extractor run --local",
     "format": "prettier --write --config ../../.prettierrc.json \"src/**/*.ts\" \"samples/*.ts\" \"test/**/*.ts\" \"*.{js,json}\"",
     "integration-test:browser": "karma start --single-run",
-    "integration-test:node": "nyc mocha -r esm --require source-map-support/register --reporter ../../../common/tools/mocha-multi-reporter.js --timeout 180000 --full-trace dist-esm/test/*.test.js",
-    "integration-test:node:no-timeout": "nyc mocha -r esm --require source-map-support/register --reporter ../../../common/tools/mocha-multi-reporter.js --no-timeouts --full-trace dist-esm/test/*.test.js",
+    "integration-test:node": "nyc mocha -r esm --require source-map-support/register --reporter ../../../common/tools/mocha-multi-reporter.js --timeout 180000 --full-trace dist-esm/keyvault-certificates/test/*.test.js",
+    "integration-test:node:no-timeout": "nyc mocha -r esm --require source-map-support/register --reporter ../../../common/tools/mocha-multi-reporter.js --no-timeouts --full-trace dist-esm/keyvault-certificates/test/*.test.js",
     "integration-test": "npm run integration-test:node && npm run integration-test:browser",
     "lint:fix": "eslint package.json api-extractor.json src test --ext .ts --fix --fix-type [problem,suggestion]",
     "lint": "eslint package.json api-extractor.json src test --ext .ts -f html -o keyvault-certificates-lintReport.html",

sdk/keyvault/keyvault-certificates/rollup.base.config.js

@@ -33,7 +33,7 @@ export function nodeConfig(test = false) {
   const externalNodeBuiltins = ["crypto", "fs", "os", "url", "assert"];
   const additionalExternals = ["keytar"];
   const baseConfig = {
-    input: "dist-esm/src/index.js",
+    input: "dist-esm/keyvault-certificates/src/index.js",
     external: depNames.concat(externalNodeBuiltins, additionalExternals),
     output: {
       file: "dist/index.js",
@@ -57,7 +57,7 @@ export function nodeConfig(test = false) {
 
   if (test) {
     // entry point is every test file
-    baseConfig.input = ["dist-esm/test/*.test.js"];
+    baseConfig.input = ["dist-esm/keyvault-certificates/test/*.test.js"];
     baseConfig.plugins.unshift(
       multiEntry({ exports: false }),
       json() // This allows us to import/require the package.json file, to get the version and test it against the user agent.
@@ -83,7 +83,7 @@ export function nodeConfig(test = false) {
 
 export function browserConfig(test = false) {
   const baseConfig = {
-    input: "dist-esm/src/index.js",
+    input: "dist-esm/keyvault-certificates/src/index.js",
     output: {
       file: "dist-browser/azure-keyvault-certificates.js",
       banner: banner,
@@ -131,7 +131,7 @@ export function browserConfig(test = false) {
   baseConfig.external = ["fs", "fs-extra", "child_process", "path", "crypto", "constants"];
   if (test) {
     baseConfig.external.push("os");
-    baseConfig.input = ["dist-esm/test/*.test.js"];
+    baseConfig.input = ["dist-esm/keyvault-certificates/test/*.test.js"];
     baseConfig.plugins.unshift(
       multiEntry({ exports: false }),
       json() // This allows us to import/require the package.json file, to get the version and test it against the user agent.

sdk/keyvault/keyvault-certificates/src/index.ts

@@ -7,6 +7,8 @@
 // This file makes more sense if ordered based on how meaningful are some methods in relation to others.
 /* eslint-disable @typescript-eslint/member-ordering */
 
+/// <reference lib="esnext.asynciterable" />
+
 import {
   TokenCredential,
   isTokenCredential,
@@ -140,8 +142,7 @@ import { SDK_VERSION } from "./core/utils/constants";
 import { parseKeyvaultIdentifier as parseKeyvaultEntityIdentifier } from "./core/utils";
 import "@azure/core-paging";
 import { PageSettings, PagedAsyncIterableIterator } from "@azure/core-paging";
-import { challengeBasedAuthenticationPolicy } from "./core/challengeBasedAuthenticationPolicy";
-
+import { challengeBasedAuthenticationPolicy } from "../../keyvault-common/src";
 import { CreateCertificatePoller } from "./lro/create/poller";
 import { CertificateOperationPoller } from "./lro/operation/poller";
 import { DeleteCertificatePoller } from "./lro/delete/poller";

sdk/keyvault/keyvault-certificates/test/challengeBasedAuthenticationPolicy.test.ts

@@ -10,9 +10,9 @@ import {
   AuthenticationChallengeCache,
   AuthenticationChallenge,
   parseWWWAuthenticate
-} from "../src/core/challengeBasedAuthenticationPolicy";
+} from "../../keyvault-common/src";
 import { createSandbox } from "sinon";
-import { testPollerProperties } from './utils/recorderUtils';
+import { testPollerProperties } from "./utils/recorderUtils";
 
 // Following the philosophy of not testing the insides if we can test the outsides...
 // I present you with this "Get Out of Jail Free" card (in reference to Monopoly).
@@ -56,10 +56,16 @@ describe("Challenge based authentication tests", () => {
     // Now we run what would be a normal use of the client.
     // Here we will create two keys, then flush them.
     // testClient.flushCertificate deletes, then purges the keys.
-    const certificateName = testClient.formatName(`${certificatePrefix}-${this!.test!.title}-${certificateSuffix}`);
+    const certificateName = testClient.formatName(
+      `${certificatePrefix}-${this!.test!.title}-${certificateSuffix}`
+    );
     const certificateNames = [`${certificateName}-0`, `${certificateName}-1`];
     for (const name of certificateNames) {
-      const poller = await client.beginCreateCertificate(name, basicCertificatePolicy, testPollerProperties);
+      const poller = await client.beginCreateCertificate(
+        name,
+        basicCertificatePolicy,
+        testPollerProperties
+      );
       await poller.pollUntilDone();
     }
     for (const name of certificateNames) {
@@ -76,15 +82,21 @@ describe("Challenge based authentication tests", () => {
   });
 
   it("Authentication should work for parallel requests", async function() {
-    const certificateName = testClient.formatName(`${certificatePrefix}-${this!.test!.title}-${certificateSuffix}`);
+    const certificateName = testClient.formatName(
+      `${certificatePrefix}-${this!.test!.title}-${certificateSuffix}`
+    );
     const certificateNames = [`${certificateName}-0`, `${certificateName}-1`];
 
     const sandbox = createSandbox();
     const spy = sandbox.spy(AuthenticationChallengeCache.prototype, "setCachedChallenge");
     const spyEqualTo = sandbox.spy(AuthenticationChallenge.prototype, "equalTo");
 
     const promises = certificateNames.map((name) => {
-      const promise = client.beginCreateCertificate(name, basicCertificatePolicy, testPollerProperties);
+      const promise = client.beginCreateCertificate(
+        name,
+        basicCertificatePolicy,
+        testPollerProperties
+      );
       return { promise, name };
     });
 

sdk/keyvault/keyvault-certificates/tsconfig.json

@@ -3,9 +3,9 @@
   "compilerOptions": {
     "declarationDir": "./types",
     "outDir": "./dist-esm",
-    "lib": ["dom", "esnext.asynciterable"],
+    "lib": ["dom"],
     "resolveJsonModule": true
   },
-  "exclude": ["node_modules", "./types/**/*.d.ts", "./samples/**/*.ts"],
-  "include": ["./src/**/*.ts", "./test/**/*.ts"]
+  "exclude": ["node_modules", "../keyvault-common/node_modules", "./samples/**/*.ts"],
+  "include": ["./src/**/*.ts", "./test/**/*.ts", "../keyvault-common/**/*.ts"]
 }

sdk/keyvault/keyvault-common/index.ts

@@ -0,0 +1,4 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License. See License.txt in the project root for license information.
+
+export * from "./src";

sdk/keyvault/keyvault-common/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@azure/keyvault-common",
+  "sideEffects": false,
+  "private": true,
+  "author": "Microsoft Corporation",
+  "version": "1.0.0",
+  "license": "MIT",
+  "description": "Common internal functionality for all of the Azure Key Vault clients in the Azure SDK for JavaScript",
+  "repository": "github:Azure/azure-sdk-for-js",
+  "main": "./src/index.ts",
+  "module": "dist-esm/index.js",
+  "types": "./types/index.d.ts",
+  "engines": {
+    "node": ">=8.0.0"
+  },
+  "scripts": {
+    "audit": "echo skipped",
+    "build:minify": "echo skipped",
+    "build:samples": "echo skipped",
+    "build:es6": "tsc -p tsconfig.json",
+    "build:nodebrowser": "echo skipped",
+    "build:test": "echo skipped",
+    "build": "npm run extract-api && npm run build:es6 && npm run build:nodebrowser",
+    "check-format": "prettier --list-different --config ../../.prettierrc.json \"src/**/*.ts\" \"test/**/*.ts\" \"*.{js,json}\"",
+    "clean": "rimraf dist-esm dist-test typings *.tgz *.log samples/typescript/dist",
+    "execute:js-samples": "echo skipped",
+    "execute:ts-samples": "echo skipped",
+    "execute:samples": "npm run build:samples && npm run execute:js-samples && npm run execute:ts-samples",
+    "extract-api": "echo skipped",
+    "format": "prettier --write --config ../../.prettierrc.json \"src/**/*.ts\" \"*.{js,json}\"",
+    "integration-test:browser": "echo skipped",
+    "integration-test:node": "echo skipped",
+    "integration-test:node:no-timeout": "echo skipped",
+    "integration-test": "npm run integration-test:node && npm run integration-test:browser",
+    "lint:fix": "eslint package.json src --ext .ts --fix --fix-type [problem,suggestion]",
+    "lint": "eslint src --ext .ts -f html -o search-lintReport.html || exit 0",
+    "lint:terminal": "eslint src --ext .ts",
+    "pack": "npm pack 2>&1",
+    "prebuild": "npm run clean",
+    "test:browser": "npm run clean && npm run build:test && npm run unit-test:browser",
+    "test:node": "npm run clean && npm run build:test && npm run unit-test:node",
+    "test": "npm run clean && npm run build:test && npm run unit-test",
+    "unit-test:browser": "echo skipped",
+    "unit-test:node": "echo skipped",
+    "unit-test:node:no-timeout": "echo skipped",
+    "unit-test": "npm run unit-test:node && npm run unit-test:browser"
+  },
+  "dependencies": {
+    "@azure/core-http": "^1.1.1",
+    "tslib": "^2.0.0"
+  },
+  "devDependencies": {
+    "typescript": "~3.9.3"
+  }
+}

sdk/keyvault/keyvault-certificates/src/core/challengeBasedAuthenticationPolicy.ts → sdk/keyvault/keyvault-common/src/challengeBasedAuthenticationPolicy.ts

@@ -6,7 +6,7 @@ import {
   BaseRequestPolicy,
   RequestPolicy,
   RequestPolicyOptions,
-  RequestPolicyFactory
+  RequestPolicyFactory,
 } from "@azure/core-http";
 import { Constants } from "@azure/core-http";
 import { HttpOperationResponse } from "@azure/core-http";
@@ -78,7 +78,7 @@ export function challengeBasedAuthenticationPolicy(
         tokenCache,
         challengeCache
       );
-    }
+    },
   };
 }
 
@@ -103,7 +103,7 @@ export function parseWWWAuthenticate(wwwAuthenticate: string): ParsedWWWAuthenti
   const parsed = keyValues.reduce<ParsedWWWAuthenticate>(
     (result, [key, value]: string[]) => ({
       ...result,
-      [key]: value.slice(1, -1)
+      [key]: value.slice(1, -1),
     }),
     {}
   );

sdk/keyvault/keyvault-common/src/index.ts

@@ -0,0 +1,4 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License. See License.txt in the project root for license information.
+
+export * from "./challengeBasedAuthenticationPolicy";

sdk/keyvault/keyvault-common/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "extends": "../../../tsconfig.package",
+  "compilerOptions": {
+    "declarationDir": "./types",
+    "outDir": "./dist-esm",
+    "lib": ["dom"],
+    "resolveJsonModule": true
+  },
+  "exclude": ["node_modules"],
+  "include": ["./src/**/*.ts"]
+}

sdk/keyvault/keyvault-keys/.eslintrc.json

@@ -4,6 +4,8 @@
   "ignorePatterns": ["src/core"],
   "rules": {
     "@typescript-eslint/no-this-alias": "off",
-    "no-invalid-this": "off"
+    "no-invalid-this": "off",
+    "@azure/azure-sdk/ts-package-json-module": "warn",
+    "@azure/azure-sdk/ts-package-json-files-required": "warn"
   }
 }

sdk/keyvault/keyvault-keys/api-extractor.json

@@ -1,6 +1,6 @@
 {
   "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-  "mainEntryPointFilePath": "types/src/index.d.ts",
+  "mainEntryPointFilePath": "types/keyvault-keys/src/index.d.ts",
   "docModel": {
     "enabled": false
   },

sdk/keyvault/keyvault-keys/package.json

@@ -20,18 +20,12 @@
     "url": "https://github.com/Azure/azure-sdk-for-js/issues"
   },
   "main": "./dist/index.js",
-  "module": "dist-esm/src/index.js",
+  "module": "dist-esm/keyvault-keys/src/index.js",
   "types": "./types/keyvault-keys.d.ts",
   "engines": {
     "node": ">=8.0.0"
   },
-  "files": [
-    "types/keyvault-keys.d.ts",
-    "dist/",
-    "dist-esm/src",
-    "README.md",
-    "LICENSE"
-  ],
+  "files": ["types/keyvault-keys.d.ts", "types/", "dist/", "dist-browser/", "dist-esm/keyvault-keys/src", "dist-esm/keyvault-common/src", "README.md", "LICENSE"],
   "browser": {
     "os": false,
     "process": false
@@ -52,8 +46,8 @@
     "extract-api": "tsc -p . && api-extractor run --local",
     "format": "prettier --write --config ../../.prettierrc.json \"src/**/*.ts\" \"test/**/*.ts\" \"*.{js,json}\"",
     "integration-test:browser": "karma start --single-run",
-    "integration-test:node": "nyc mocha -r esm --require source-map-support/register --reporter ../../../common/tools/mocha-multi-reporter.js --timeout 180000 --full-trace dist-esm/test/*.test.js",
-    "integration-test:node:no-timeout": "nyc mocha -r esm --require source-map-support/register --reporter ../../../common/tools/mocha-multi-reporter.js --no-timeouts --full-trace dist-esm/test/*.test.js",
+    "integration-test:node": "nyc mocha -r esm --require source-map-support/register --reporter ../../../common/tools/mocha-multi-reporter.js --timeout 180000 --full-trace dist-esm/keyvault-keys/test/*.test.js",
+    "integration-test:node:no-timeout": "nyc mocha -r esm --require source-map-support/register --reporter ../../../common/tools/mocha-multi-reporter.js --no-timeouts --full-trace dist-esm/keyvault-keys/test/*.test.js",
     "integration-test": "npm run integration-test:node && npm run integration-test:browser",
     "lint:fix": "eslint package.json api-extractor.json src test --ext .ts --fix --fix-type [problem,suggestion]",
     "lint": "eslint package.json api-extractor.json src test --ext .ts -f html -o keyvault-keys-lintReport.html",

sdk/keyvault/keyvault-keys/rollup.base.config.js

@@ -33,7 +33,7 @@ export function nodeConfig(test = false) {
   const externalNodeBuiltins = ["crypto", "fs", "os", "url", "assert"];
   const additionalExternals = ["keytar"];
   const baseConfig = {
-    input: "dist-esm/src/index.js",
+    input: "dist-esm/keyvault-keys/src/index.js",
     external: depNames.concat(externalNodeBuiltins, additionalExternals),
     output: {
       file: "dist/index.js",
@@ -57,7 +57,7 @@ export function nodeConfig(test = false) {
 
   if (test) {
     // entry point is every test file
-    baseConfig.input = ["dist-esm/test/*.test.js"];
+    baseConfig.input = ["dist-esm/keyvault-keys/test/*.test.js"];
     baseConfig.plugins.unshift(
       multiEntry({ exports: false }),
       json() // This allows us to import/require the package.json file, to get the version and test it against the user agent.
@@ -83,7 +83,7 @@ export function nodeConfig(test = false) {
 
 export function browserConfig(test = false) {
   const baseConfig = {
-    input: "dist-esm/src/index.js",
+    input: "dist-esm/keyvault-keys/src/index.js",
     output: {
       file: "dist-browser/azure-keyvault-keys.js",
       banner: banner,
@@ -128,7 +128,7 @@ export function browserConfig(test = false) {
 
   baseConfig.external = ["fs-extra", "path", "crypto", "constants"];
   if (test) {
-    baseConfig.input = ["dist-esm/test/*.test.js"];
+    baseConfig.input = ["dist-esm/keyvault-keys/test/*.test.js"];
     baseConfig.plugins.unshift(
       multiEntry({ exports: false }),
       json() // This allows us to import/require the package.json file, to get the version and test it against the user agent.