forked from Azure/azure-sdk-for-js
-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
CodeGen from PR 3421 in test-repo-billy/azure-rest-api-specs
Merge 6651cc7aa36b054765d54e0576c1fe371a1e5396 into 0bc7c1e79795562287755b516934c77fbc1e5759
- Loading branch information
SDKAuto
committed
Aug 8, 2024
1 parent
4aee463
commit 0903fbf
Showing
25 changed files
with
3,381 additions
and
399 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
{ | ||
"plugins": ["@azure/azure-sdk"], | ||
"extends": ["plugin:@azure/azure-sdk/azure-sdk-base"], | ||
"rules": { | ||
"@azure/azure-sdk/ts-modules-only-named": "warn", | ||
"@azure/azure-sdk/ts-apiextractor-json-types": "warn", | ||
"@azure/azure-sdk/ts-package-json-types": "warn", | ||
"@azure/azure-sdk/ts-package-json-engine-is-present": "warn", | ||
"tsdoc/syntax": "warn", | ||
"@azure/azure-sdk/ts-package-json-module": "off", | ||
"@azure/azure-sdk/ts-package-json-files-required": "off", | ||
"@azure/azure-sdk/ts-package-json-main-is-cjs": "off" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2024 Microsoft | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
# Azure DataApi REST client library for JavaScript | ||
|
||
Data API introduces endpoints to manage your API Center resources. | ||
|
||
**Please rely heavily on our [REST client docs](https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/rest-clients.md) to use this library** | ||
|
||
Key links: | ||
|
||
- [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/apicenter/azure-apicenter-rest) | ||
- [Package (NPM)](https://www.npmjs.com/package/@azure-rest/azure-apicenter-rest) | ||
- [API reference documentation](https://docs.microsoft.com/javascript/api/@azure-rest/azure-apicenter-rest?view=azure-node-preview) | ||
- [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/apicenter/azure-apicenter-rest/samples) | ||
|
||
## Getting started | ||
|
||
### Currently supported environments | ||
|
||
- LTS versions of Node.js | ||
|
||
### Prerequisites | ||
|
||
- You must have an [Azure subscription](https://azure.microsoft.com/free/) to use this package. | ||
|
||
### Install the `@azure-rest/azure-apicenter-rest` package | ||
|
||
Install the Azure DataApi REST client REST client library for JavaScript with `npm`: | ||
|
||
```bash | ||
npm install @azure-rest/azure-apicenter-rest | ||
``` | ||
|
||
### Create and authenticate a `DataApiClient` | ||
|
||
To use an [Azure Active Directory (AAD) token credential](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token), | ||
provide an instance of the desired credential type obtained from the | ||
[@azure/identity](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) library. | ||
|
||
To authenticate with AAD, you must first `npm` install [`@azure/identity`](https://www.npmjs.com/package/@azure/identity) | ||
|
||
After setup, you can choose which type of [credential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) from `@azure/identity` to use. | ||
As an example, [DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential) | ||
can be used to authenticate the client. | ||
|
||
Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables: | ||
AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET | ||
|
||
## Troubleshooting | ||
|
||
### Logging | ||
|
||
Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`: | ||
|
||
```javascript | ||
const { setLogLevel } = require("@azure/logger"); | ||
|
||
setLogLevel("info"); | ||
``` | ||
|
||
For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
{ | ||
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", | ||
"mainEntryPointFilePath": "./dist/esm/index.d.ts", | ||
"docModel": { "enabled": true }, | ||
"apiReport": { "enabled": true, "reportFolder": "./review" }, | ||
"dtsRollup": { | ||
"enabled": true, | ||
"untrimmedFilePath": "", | ||
"publicTrimmedFilePath": "./types/azure-apicenter-rest.d.ts" | ||
}, | ||
"messages": { | ||
"tsdocMessageReporting": { "default": { "logLevel": "none" } }, | ||
"extractorMessageReporting": { | ||
"ae-missing-release-tag": { "logLevel": "none" }, | ||
"ae-unresolved-link": { "logLevel": "none" } | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,142 @@ | ||
{ | ||
"name": "@azure-rest/azure-apicenter-rest", | ||
"version": "1.0.0-beta.1", | ||
"description": "azure.ApiCenter Service", | ||
"engines": { | ||
"node": ">=18.0.0" | ||
}, | ||
"sideEffects": false, | ||
"autoPublish": false, | ||
"tshy": { | ||
"exports": { | ||
"./package.json": "./package.json", | ||
".": "./src/index.ts" | ||
}, | ||
"dialects": [ | ||
"esm", | ||
"commonjs" | ||
], | ||
"esmDialects": [ | ||
"browser", | ||
"react-native" | ||
], | ||
"selfLink": false | ||
}, | ||
"type": "module", | ||
"keywords": [ | ||
"node", | ||
"azure", | ||
"cloud", | ||
"typescript", | ||
"browser", | ||
"isomorphic" | ||
], | ||
"author": "Microsoft Corporation", | ||
"license": "MIT", | ||
"files": [ | ||
"dist", | ||
"README.md", | ||
"LICENSE", | ||
"review/*", | ||
"CHANGELOG.md" | ||
], | ||
"sdk-type": "client", | ||
"repository": "github:Azure/azure-sdk-for-js", | ||
"bugs": { | ||
"url": "https://github.com/Azure/azure-sdk-for-js/issues" | ||
}, | ||
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/apicenter/azure-apicenter-rest/README.md", | ||
"prettier": "@azure/eslint-plugin-azure-sdk/prettier.json", | ||
"//metadata": { | ||
"constantPaths": [ | ||
{ | ||
"path": "src/dataApiClient.ts", | ||
"prefix": "userAgentInfo" | ||
} | ||
] | ||
}, | ||
"dependencies": { | ||
"@azure-rest/core-client": "^2.1.0", | ||
"@azure/core-auth": "^1.6.0", | ||
"@azure/core-rest-pipeline": "^1.5.0", | ||
"@azure/logger": "^1.0.0", | ||
"tslib": "^2.6.2", | ||
"@azure/core-lro": "^3.0.0", | ||
"@azure/abort-controller": "^2.1.2", | ||
"@azure/core-paging": "^1.5.0" | ||
}, | ||
"devDependencies": { | ||
"dotenv": "^16.0.0", | ||
"@microsoft/api-extractor": "^7.40.3", | ||
"@types/node": "^18.0.0", | ||
"eslint": "^8.55.0", | ||
"prettier": "^3.2.5", | ||
"rimraf": "^5.0.5", | ||
"mkdirp": "^3.0.1", | ||
"typescript": "~5.5.3", | ||
"tshy": "^1.11.1", | ||
"@azure/core-util": "^1.0.0", | ||
"@azure/identity": "^4.2.1", | ||
"@vitest/browser": "^1.3.1", | ||
"@vitest/coverage-istanbul": "^1.3.1", | ||
"playwright": "^1.41.2", | ||
"vitest": "^1.3.1", | ||
"@azure-tools/test-credential": "^2.0.0", | ||
"@azure-tools/test-recorder": "^4.0.0", | ||
"@azure/dev-tool": "^1.0.0", | ||
"@azure/eslint-plugin-azure-sdk": "^3.0.0" | ||
}, | ||
"scripts": { | ||
"clean": "rimraf --glob dist dist-browser dist-esm test-dist temp types *.tgz *.log", | ||
"extract-api": "rimraf review && mkdirp ./review && dev-tool run extract-api", | ||
"pack": "npm pack 2>&1", | ||
"lint": "eslint package.json api-extractor.json src test --ext .ts --ext .cts --ext .mts", | ||
"lint:fix": "eslint package.json api-extractor.json src test --ext .ts --ext .cts --ext .mts --fix --fix-type [problem,suggestion]", | ||
"unit-test": "npm run unit-test:node && npm run unit-test:browser", | ||
"unit-test:browser": "npm run build:test && dev-tool run test:vitest --browser", | ||
"unit-test:node": "dev-tool run test:vitest", | ||
"integration-test": "npm run integration-test:node && npm run integration-test:browser", | ||
"integration-test:browser": "echo skipped", | ||
"integration-test:node": "echo skipped", | ||
"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 skipped", | ||
"check-format": "dev-tool run vendored prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.{ts,cts,mts}\" \"test/**/*.{ts,cts,mts}\" \"*.{js,cjs,mjs,json}\"", | ||
"execute:samples": "echo skipped", | ||
"format": "dev-tool run vendored prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.{ts,cts,mts}\" \"test/**/*.{ts,cts,mts}\" \"*.{js,cjs,mjs,json}\"", | ||
"generate:client": "echo skipped", | ||
"test:browser": "npm run clean && npm run build:test && npm run unit-test:browser && npm run integration-test:browser", | ||
"minify": "uglifyjs -c -m --comments --source-map \"content='./dist/index.js.map'\" -o ./dist/index.min.js ./dist/index.js", | ||
"build:test": "npm run clean && tshy && dev-tool run build-test", | ||
"build": "npm run clean && tshy && mkdirp ./review && dev-tool run extract-api", | ||
"test:node": "npm run clean && tshy && npm run unit-test:node && npm run integration-test:node", | ||
"test": "npm run clean && tshy && npm run unit-test:node && dev-tool run bundle && npm run unit-test:browser && npm run integration-test" | ||
}, | ||
"exports": { | ||
"./package.json": "./package.json", | ||
".": { | ||
"browser": { | ||
"source": "./src/index.ts", | ||
"types": "./dist/browser/index.d.ts", | ||
"default": "./dist/browser/index.js" | ||
}, | ||
"react-native": { | ||
"source": "./src/index.ts", | ||
"types": "./dist/react-native/index.d.ts", | ||
"default": "./dist/react-native/index.js" | ||
}, | ||
"import": { | ||
"source": "./src/index.ts", | ||
"types": "./dist/esm/index.d.ts", | ||
"default": "./dist/esm/index.js" | ||
}, | ||
"require": { | ||
"source": "./src/index.ts", | ||
"types": "./dist/commonjs/index.d.ts", | ||
"default": "./dist/commonjs/index.js" | ||
} | ||
} | ||
}, | ||
"main": "./dist/commonjs/index.js", | ||
"types": "./dist/commonjs/index.d.ts", | ||
"module": "./dist/esm/index.js" | ||
} |
Oops, something went wrong.