Skip to content

Commit f73b3d8

Browse files
authored
new-generator-for-eventgrid-track2 (Azure#18833)
* new-generator-for-eventgrid-track2 * GA
1 parent e45f08e commit f73b3d8

30 files changed

+464
-543
lines changed

common/config/rush/pnpm-lock.yaml

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 6 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -1,88 +1,11 @@
1-
## Release History
2-
3-
### 13.0.0-beta.2 (Unreleased)
4-
5-
#### Features Added
6-
7-
#### Breaking Changes
8-
9-
#### Bugs Fixed
10-
11-
#### Other Changes
12-
13-
### 13.0.0-beta.1 (2021-11-16)
14-
15-
**Features**
16-
17-
- Added Type Alias Enum18
18-
- Added Type Alias Enum19
19-
- Added Type Alias Enum20
20-
- Added Type Alias Enum21
21-
- Type Alias ExtensionTopic has a new parameter systemData
22-
- Added Enum KnownEnum18
23-
- Added Enum KnownEnum19
24-
- Added Enum KnownEnum20
25-
- Added Enum KnownEnum21
26-
27-
**Breaking Changes**
28-
29-
- Removed operation group EventChannels
30-
- Removed operation group PartnerNamespaces
31-
- Removed operation group PartnerRegistrations
32-
- Removed operation group PartnerTopicEventSubscriptions
33-
- Removed operation group PartnerTopics
34-
- Operation PrivateEndpointConnections.beginDelete has a new signature
35-
- Operation PrivateEndpointConnections.beginDeleteAndWait has a new signature
36-
- Operation PrivateEndpointConnections.beginUpdate has a new signature
37-
- Operation PrivateEndpointConnections.beginUpdateAndWait has a new signature
38-
- Operation PrivateEndpointConnections.get has a new signature
39-
- Operation PrivateEndpointConnections.listByResource has a new signature
40-
- Interface DomainUpdateParameters no longer has parameter sku
41-
- Interface Operation no longer has parameter isDataAction
42-
- Interface TopicUpdateParameters no longer has parameter sku
43-
- Class EventGridManagementClient no longer has parameter eventChannels
44-
- Class EventGridManagementClient no longer has parameter partnerNamespaces
45-
- Class EventGridManagementClient no longer has parameter partnerRegistrations
46-
- Class EventGridManagementClient no longer has parameter partnerTopicEventSubscriptions
47-
- Class EventGridManagementClient no longer has parameter partnerTopics
48-
- Type Alias Domain no longer has parameter sku
49-
- Type Alias Topic no longer has parameter sku
50-
- Type Alias Topic no longer has parameter kind
51-
- Type Alias Topic no longer has parameter extendedLocation
52-
- Removed Enum KnownEnum25
53-
- Removed Enum KnownEnum26
54-
- Removed Enum KnownEnum27
55-
- Removed Enum KnownEnum28
56-
- Removed Enum KnownEventChannelProvisioningState
57-
- Removed Enum KnownPartnerNamespaceProvisioningState
58-
- Removed Enum KnownPartnerRegistrationProvisioningState
59-
- Removed Enum KnownPartnerRegistrationVisibilityState
60-
- Removed Enum KnownPartnerTopicActivationState
61-
- Removed Enum KnownPartnerTopicProvisioningState
62-
- Removed Enum KnownPartnerTopicReadinessState
63-
- Removed Enum KnownResourceKind
64-
- Removed Enum KnownSku
65-
- Enum KnownAdvancedFilterOperatorType no longer has value IsNotNull
66-
- Enum KnownAdvancedFilterOperatorType no longer has value IsNullOrUndefined
67-
- Enum KnownAdvancedFilterOperatorType no longer has value NumberInRange
68-
- Enum KnownAdvancedFilterOperatorType no longer has value NumberNotInRange
69-
- Enum KnownAdvancedFilterOperatorType no longer has value StringNotBeginsWith
70-
- Enum KnownAdvancedFilterOperatorType no longer has value StringNotContains
71-
- Enum KnownAdvancedFilterOperatorType no longer has value StringNotEndsWith
72-
731
# Release History
2+
3+
## 13.0.0 (2021-12-09)
744

75-
### 12.0.0-beta.1 (2021-10-09)
76-
77-
This is the first preview for the new version of the `@azure/arm-eventgrid` package that follows the new [guidelines for TypeScript SDKs](https://azure.github.io/azure-sdk/typescript_introduction.html) for Azure services.
5+
The package of @azure/arm-eventgrid is using our next generation design principles since version 13.0.0, which contains breaking changes.
786

79-
While this package remains auto generated, the SDK generator itself has undergone changes to comply with the above guidelines in order to generate packages that are idiomatic to the JavaScript/TypeScript ecosystem and consistent with other packages for Azure services. For more on this, please see [State of the Azure SDK 2021](https://devblogs.microsoft.com/azure-sdk/state-of-the-azure-sdk-2021/).
7+
To understand the detail of the change, please refer to [Changelog](https://aka.ms/js-track2-changelog).
808

81-
Please note that this version has breaking changes, all of which were made after careful consideration during the authoring of the guidelines and user studies.
9+
To migrate the existing applications to the latest version, please refer to [Migration Guide](https://aka.ms/js-track2-migration-guide).
8210

83-
**Noteworthy changes and features**
84-
- Authentication: The packages `@azure/ms-rest-nodeauth` or `@azure/ms-rest-browserauth` are no longer supported. Use package [@azure/identity](https://www.npmjs.com/package/@azure/identity) instead. Select a credential from Azure Identity examples based on the authentication method of your choice.
85-
- Callbacks: Method overloads that used callbacks have been removed and the use of promises is encouraged instead.
86-
- List operations now return an iterable result that follows the `PagedAsyncIterableIterator` interface as opposed to the previous model where you had to make a new request using the link to the next page.
87-
- Long running operations i.e. the Lro related object returned by methods whose names started with `begin`, now uses `pollUntilDone` to check whether the request is finished, instead of `pollUntilFinished`. To get the final result, use the corresponding method that will have the suffix `AndWait`.
88-
- The SDK only supports ECMAScript 2015 (ES6) and beyond, all projects that referenced this SDK should be upgraded to use ES6.
11+
To learn more, please refer to our documentation [Quick Start](https://aka.ms/js-track2-quickstart).

sdk/eventgrid/arm-eventgrid/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,10 @@ const subscriptionId = "00000000-0000-0000-0000-000000000000";
5353
const client = new EventGridManagementClient(new DefaultAzureCredential(), subscriptionId);
5454
```
5555

56+
57+
### JavaScript Bundle
58+
To use this client library in the browser, first you need to use a bundler. For details on how to do this, please refer to our [bundling documentation](https://aka.ms/AzureSDKBundling).
59+
5660
## Key concepts
5761

5862
### EventGridManagementClient
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"commit": "48e3687f073bee2cdc03b1bab8b2cbbee07dcf49",
2+
"commit": "d710fb7f40338ca6ef00e0a9680be0a3d4cf5059",
33
"readme": "specification/eventgrid/resource-manager/readme.md",
4-
"autorest_command": "autorest --version=3.1.3 --typescript --modelerfour.lenient-model-deduplication --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=D:\\mydev\\azure-sdk-for-js ../azure-rest-api-specs/specification/eventgrid/resource-manager/readme.md --use=@autorest/typescript@6.0.0-beta.14",
4+
"autorest_command": "autorest --version=3.1.3 --typescript --modelerfour.lenient-model-deduplication --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=D:\\mydev\\azure-sdk-for-js ../azure-rest-api-specs/specification/eventgrid/resource-manager/readme.md --use=@autorest/typescript@6.0.0-alpha.16.20211130.1",
55
"repository_url": "https://github.com/Azure/azure-rest-api-specs.git",
6-
"use": "@autorest/typescript@6.0.0-beta.14"
6+
"use": "@autorest/typescript@6.0.0-alpha.16.20211130.1"
77
}

sdk/eventgrid/arm-eventgrid/package.json

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,8 @@
33
"sdk-type": "mgmt",
44
"author": "Microsoft Corporation",
55
"description": "A generated SDK for EventGridManagementClient.",
6-
"version": "13.0.0-beta.2",
7-
"engines": {
8-
"node": ">=12.0.0"
9-
},
6+
"version": "13.0.0",
7+
"engines": { "node": ">=12.0.0" },
108
"dependencies": {
119
"@azure/core-lro": "^2.2.0",
1210
"@azure/abort-controller": "^1.0.0",
@@ -16,13 +14,7 @@
1614
"@azure/core-rest-pipeline": "^1.1.0",
1715
"tslib": "^2.2.0"
1816
},
19-
"keywords": [
20-
"node",
21-
"azure",
22-
"typescript",
23-
"browser",
24-
"isomorphic"
25-
],
17+
"keywords": ["node", "azure", "typescript", "browser", "isomorphic"],
2618
"license": "MIT",
2719
"main": "./dist/index.js",
2820
"module": "./dist-esm/src/index.js",
@@ -38,6 +30,7 @@
3830
"rollup-plugin-sourcemaps": "^0.4.2",
3931
"typescript": "~4.2.0",
4032
"uglify-js": "^3.4.9",
33+
"rimraf": "^3.0.0",
4134
"@azure/identity": "^2.0.1",
4235
"@azure-tools/test-recorder": "^1.0.0",
4336
"mocha": "^7.1.1",
@@ -48,9 +41,7 @@
4841
"type": "git",
4942
"url": "https://github.com/Azure/azure-sdk-for-js.git"
5043
},
51-
"bugs": {
52-
"url": "https://github.com/Azure/azure-sdk-for-js/issues"
53-
},
44+
"bugs": { "url": "https://github.com/Azure/azure-sdk-for-js/issues" },
5445
"files": [
5546
"dist/**/*.js",
5647
"dist/**/*.js.map",
@@ -77,7 +68,7 @@
7768
"extract-api": "api-extractor run --local",
7869
"lint": "echo skipped",
7970
"audit": "echo skipped",
80-
"clean": "echo skipped",
71+
"clean": "rimraf dist dist-browser dist-esm test-dist temp types *.tgz *.log",
8172
"build:node": "echo skipped",
8273
"build:browser": "echo skipped",
8374
"build:test": "echo skipped",
@@ -92,7 +83,7 @@
9283
"unit-test:node": "cross-env TEST_MODE=playback npm run integration-test:node",
9384
"unit-test:browser": "echo skipped",
9485
"integration-test": "npm run integration-test:node && npm run integration-test:browser",
95-
"integration-test:node": "mocha -r esm --require ts-node/register --timeout 1200000 --full-trace test/*.ts",
86+
"integration-test:node": "mocha -r esm --require ts-node/register --timeout 1200000 --full-trace test/*.ts --reporter ../../../common/tools/mocha-multi-reporter.js",
9687
"integration-test:browser": "echo skipped",
9788
"docs": "echo skipped"
9889
},

0 commit comments

Comments
 (0)