diff --git a/packages/@azure/keyvault/README.md b/packages/@azure/keyvault/README.md index ce21ccb6e763..bba3eba215bb 100644 --- a/packages/@azure/keyvault/README.md +++ b/packages/@azure/keyvault/README.md @@ -1,102 +1,83 @@ -## Azure KeyVaultClient SDK for JavaScript - -This package contains an isomorphic SDK for KeyVaultClient. - -### Currently supported environments - -- Node.js version 6.x.x or higher -- Browser JavaScript - -### How to Install - -``` -npm install @azure/keyvault -``` - -### How to use - -#### nodejs - Authentication, client creation and getKey as an example written in TypeScript. - -##### Install @azure/ms-rest-nodeauth - -``` -npm install @azure/ms-rest-nodeauth -``` - -##### Sample code - -```ts -import * as msRest from "@azure/ms-rest-js"; -import * as msRestAzure from "@azure/ms-rest-azure-js"; -import * as msRestNodeAuth from "@azure/ms-rest-nodeauth"; -import { KeyVaultClient, KeyVaultModels, KeyVaultMappers } from "@azure/keyvault"; -const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"]; - -msRestNodeAuth.interactiveLogin().then((creds) => { - const client = new KeyVaultClient(creds, subscriptionId); - const vaultBaseUrl = "testvaultBaseUrl"; - const keyName = "testkeyName"; - const keyVersion = "testkeyVersion"; - client.getKey(vaultBaseUrl, keyName, keyVersion).then((result) => { - console.log("The result is:"); - console.log(result); - }); -}).catch((err) => { - console.error(err); -}); -``` - -#### browser - Authentication, client creation and getKey as an example written in JavaScript. - -##### Install @azure/ms-rest-browserauth - -``` -npm install @azure/ms-rest-browserauth -``` - -##### Sample code - -See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to Azure in the browser. - -- index.html -```html - - - - @azure/keyvault sample - - - - - - - - -``` - -## Related projects - -- [Microsoft Azure SDK for Javascript](https://github.com/Azure/azure-sdk-for-js) +# Azure KeyVaultClient SDK for JavaScript +This package contains an isomorphic SDK for KeyVaultClient. + +## Currently supported environments +- Node.js version 6.x.x or higher +- Browser JavaScript + +## How to Install +``` +npm install @azure/keyvault +``` + + +## How to use + +### nodejs - Authentication, client creation and getKey as an example written in TypeScript. + +```ts +import * as msRest from "ms-rest-js"; +import * as msRestAzure from "ms-rest-azure-js"; +import * as msRestNodeAuth from "ms-rest-nodeauth"; +import { KeyVaultClient, KeyVaultModels, KeyVaultMappers } from "@azure/keyvault"; +const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"]; + +msRestNodeAuth.interactiveLogin().then((creds) => { + const client = new KeyVaultClient(creds, subscriptionId); + const vaultBaseUrl = "testvaultBaseUrl"; + const keyName = "testkeyName"; + const keyVersion = "testkeyVersion"; + client.getKey(vaultBaseUrl, keyName, keyVersion).then((result) => { + console.log("The result is:"); + console.log(result); + }); +}).catch((err) => { + console.error(err); +}); +``` + +### browser - Authentication, client creation and getKey as an example written in JavaScript. +See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to Azure in the browser. + +- index.html +```html + + + + @azure/keyvault sample + + + + + + + + + +``` + +# Related projects + - [Microsoft Azure SDK for Javascript](https://github.com/Azure/azure-sdk-for-js) diff --git a/packages/@azure/keyvault/lib/keyVaultClient.ts b/packages/@azure/keyvault/lib/keyVaultClient.ts index a9ad2d29bd3e..51350a92b8fa 100644 --- a/packages/@azure/keyvault/lib/keyVaultClient.ts +++ b/packages/@azure/keyvault/lib/keyVaultClient.ts @@ -8,8 +8,8 @@ * regenerated. */ -import * as msRest from "@azure/ms-rest-js"; -import * as msRestAzure from "@azure/ms-rest-azure-js"; +import * as msRest from "ms-rest-js"; +import * as msRestAzure from "ms-rest-azure-js"; import * as Models from "./models"; import * as Mappers from "./models/mappers"; import * as Parameters from "./models/parameters"; @@ -384,7 +384,7 @@ class KeyVaultClient extends KeyVaultClientContext { * protection with an asymmetric key can be performed using public portion of the key. This * operation is supported for asymmetric keys as a convenience for callers that have a * key-reference but do not have access to the public key material. This operation requires the - * keys/encypt permission. + * keys/encrypt permission. * @summary Encrypts an arbitrary sequence of bytes using an encryption key that is stored in a key * vault. * @param vaultBaseUrl The vault name, for example https://myvault.vault.azure.net. diff --git a/packages/@azure/keyvault/lib/keyVaultClientContext.ts b/packages/@azure/keyvault/lib/keyVaultClientContext.ts index 9f84cabf70ce..06e476b5c4d1 100644 --- a/packages/@azure/keyvault/lib/keyVaultClientContext.ts +++ b/packages/@azure/keyvault/lib/keyVaultClientContext.ts @@ -8,8 +8,8 @@ * regenerated. */ -import * as msRest from "@azure/ms-rest-js"; -import * as msRestAzure from "@azure/ms-rest-azure-js"; +import * as msRest from "ms-rest-js"; +import * as msRestAzure from "ms-rest-azure-js"; const packageName = "@azure/keyvault"; const packageVersion = "0.1.0"; diff --git a/packages/@azure/keyvault/lib/models/index.ts b/packages/@azure/keyvault/lib/models/index.ts index 9bf0e4c254a8..bc63a925d52e 100644 --- a/packages/@azure/keyvault/lib/models/index.ts +++ b/packages/@azure/keyvault/lib/models/index.ts @@ -8,8 +8,8 @@ * regenerated. */ -import { BaseResource, CloudError } from "@azure/ms-rest-azure-js"; -import * as msRest from "@azure/ms-rest-js"; +import { BaseResource, CloudError } from "ms-rest-azure-js"; +import * as msRest from "ms-rest-js"; export { BaseResource, CloudError }; @@ -612,7 +612,7 @@ export interface X509CertificateProperties { */ keyUsage?: KeyUsageType[]; /** - * @member {number} [validityInMonths] The duration that the ceritifcate is + * @member {number} [validityInMonths] The duration that the certificate is * valid in months. */ validityInMonths?: number; @@ -968,7 +968,7 @@ export interface AdministratorDetails { */ lastName?: string; /** - * @member {string} [emailAddress] Email addresss. + * @member {string} [emailAddress] Email address. */ emailAddress?: string; /** @@ -1061,7 +1061,7 @@ export interface IssuerBundle { */ export interface Contact { /** - * @member {string} [emailAddress] Email addresss. + * @member {string} [emailAddress] Email address. */ emailAddress?: string; /** @@ -2943,7 +2943,8 @@ export interface DeletedStorageListResult extends Array { /** - * @member {string} [nextLink] The URL to get the next set of SAS defintions. + * @member {string} [nextLink] The URL to get the next set of SAS + * definitions. * **NOTE: This property will not be serialized. It can only be populated by * the server.** */ diff --git a/packages/@azure/keyvault/lib/models/mappers.ts b/packages/@azure/keyvault/lib/models/mappers.ts index 24f9fd6f7a97..f2ee44868373 100644 --- a/packages/@azure/keyvault/lib/models/mappers.ts +++ b/packages/@azure/keyvault/lib/models/mappers.ts @@ -8,8 +8,8 @@ * regenerated. */ -import { CloudErrorMapper, BaseResourceMapper } from "@azure/ms-rest-azure-js"; -import * as msRest from "@azure/ms-rest-js"; +import { CloudErrorMapper, BaseResourceMapper } from "ms-rest-azure-js"; +import * as msRest from "ms-rest-js"; export const CloudError = CloudErrorMapper; export const BaseResource = BaseResourceMapper; diff --git a/packages/@azure/keyvault/lib/models/parameters.ts b/packages/@azure/keyvault/lib/models/parameters.ts index d09462859f3e..69ebfc35e6fa 100644 --- a/packages/@azure/keyvault/lib/models/parameters.ts +++ b/packages/@azure/keyvault/lib/models/parameters.ts @@ -8,7 +8,7 @@ * regenerated. */ -import * as msRest from "@azure/ms-rest-js"; +import * as msRest from "ms-rest-js"; export const acceptLanguage: msRest.OperationParameter = { parameterPath: "acceptLanguage", diff --git a/packages/@azure/keyvault/package.json b/packages/@azure/keyvault/package.json index 10ab98ebe309..e1aa8323f597 100644 --- a/packages/@azure/keyvault/package.json +++ b/packages/@azure/keyvault/package.json @@ -4,8 +4,8 @@ "description": "KeyVaultClient Library with typescript type definitions for node.js and browser.", "version": "0.1.0", "dependencies": { - "@azure/ms-rest-azure-js": "^1.1.0", - "@azure/ms-rest-js": "^1.1.0", + "ms-rest-azure-js": "^1.0.181", + "ms-rest-js": "^1.0.460", "tslib": "^1.9.3" }, "keywords": [ diff --git a/packages/@azure/keyvault/rollup.config.js b/packages/@azure/keyvault/rollup.config.js index 96e7f2fb0991..40ef155d5590 100644 --- a/packages/@azure/keyvault/rollup.config.js +++ b/packages/@azure/keyvault/rollup.config.js @@ -4,15 +4,15 @@ import nodeResolve from "rollup-plugin-node-resolve"; */ const config = { input: './esm/keyVaultClient.js', - external: ["@azure/ms-rest-js", "@azure/ms-rest-azure-js"], + external: ["ms-rest-js", "ms-rest-azure-js"], output: { file: "./dist/keyvault.js", format: "umd", name: "Azure.Keyvault", sourcemap: true, globals: { - "@azure/ms-rest-js": "msRest", - "@azure/ms-rest-azure-js": "msRestAzure" + "ms-rest-js": "msRest", + "ms-rest-azure-js": "msRestAzure" }, banner: `/* * Copyright (c) Microsoft Corporation. All rights reserved. diff --git a/packages/@azure/keyvault/tsconfig.json b/packages/@azure/keyvault/tsconfig.json index 51ea90961ce5..f32d1664f320 100644 --- a/packages/@azure/keyvault/tsconfig.json +++ b/packages/@azure/keyvault/tsconfig.json @@ -14,6 +14,6 @@ "outDir": "./esm", "importHelpers": true }, - "include": ["./lib/**/*.ts"], + "include": ["./lib/**/*"], "exclude": ["node_modules"] }