Skip to content

Commit 46795c8

Browse files
authored
[computeschedule] Update computeschedule projects to use snippets extraction (Azure#32596)
### Packages impacted by this PR - @azure/arm-computeschedule ### Issues associated with this PR - Azure#32416 ### Describe the problem that is addressed by this PR Updates all projects under `computeschedule` to use snippets extraction. ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? ### Are there test cases added in this PR? _(If not, why?)_ ### Provide a list of related PRs _(if any)_ ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ ### Checklists - [ ] Added impacted package name to the issue description - [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_ - [ ] Added a changelog (if necessary)
1 parent 54cc75d commit 46795c8

29 files changed

+193
-153
lines changed

sdk/computeschedule/arm-computeschedule/README.md

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -46,20 +46,28 @@ Set the values of the client ID, tenant ID, and client secret of the AAD applica
4646

4747
For more information about how to create an Azure AD Application check out [this guide](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).
4848

49-
```javascript
50-
const { ComputeScheduleClient } = require("@azure/arm-computeschedule");
51-
const { DefaultAzureCredential } = require("@azure/identity");
52-
// For client-side applications running in the browser, use InteractiveBrowserCredential instead of DefaultAzureCredential. See https://aka.ms/azsdk/js/identity/examples for more details.
49+
Using Node.js and Node-like environments, you can use the `DefaultAzureCredential` class to authenticate the client.
50+
51+
```ts snippet:ReadmeSampleCreateClient_Node
52+
import { ComputeScheduleClient } from "@azure/arm-computeschedule";
53+
import { DefaultAzureCredential } from "@azure/identity";
5354

5455
const subscriptionId = "00000000-0000-0000-0000-000000000000";
5556
const client = new ComputeScheduleClient(new DefaultAzureCredential(), subscriptionId);
57+
```
58+
59+
or browser environments, use the `InteractiveBrowserCredential` from the `@azure/identity` package to authenticate.
5660

57-
// For client-side applications running in the browser, use this code instead:
58-
// const credential = new InteractiveBrowserCredential({
59-
// tenantId: "<YOUR_TENANT_ID>",
60-
// clientId: "<YOUR_CLIENT_ID>"
61-
// });
62-
// const client = new ComputeScheduleClient(credential, subscriptionId);
61+
```ts snippet:ReadmeSampleCreateClient_Browser
62+
import { InteractiveBrowserCredential } from "@azure/identity";
63+
import { ComputeScheduleClient } from "@azure/arm-computeschedule";
64+
65+
const subscriptionId = "00000000-0000-0000-0000-000000000000";
66+
const credential = new InteractiveBrowserCredential({
67+
tenantId: "<YOUR_TENANT_ID>",
68+
clientId: "<YOUR_CLIENT_ID>",
69+
});
70+
const client = new ComputeScheduleClient(credential, subscriptionId);
6371
```
6472

6573
### JavaScript Bundle
@@ -78,8 +86,9 @@ To use this client library in the browser, first you need to use a bundler. For
7886

7987
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`:
8088

81-
```javascript
82-
const { setLogLevel } = require("@azure/logger");
89+
```ts snippet:SetLogLevel
90+
import { setLogLevel } from "@azure/logger";
91+
8392
setLogLevel("info");
8493
```
8594

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,31 @@
11
{
22
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3-
"mainEntryPointFilePath": "./dist/esm/index.d.ts",
4-
"docModel": { "enabled": true },
5-
"apiReport": { "enabled": true, "reportFolder": "./review" },
3+
"mainEntryPointFilePath": "dist/esm/index.d.ts",
4+
"docModel": {
5+
"enabled": true
6+
},
7+
"apiReport": {
8+
"enabled": true,
9+
"reportFolder": "./review"
10+
},
611
"dtsRollup": {
712
"enabled": true,
813
"untrimmedFilePath": "",
9-
"publicTrimmedFilePath": "./types/arm-computeschedule.d.ts"
14+
"publicTrimmedFilePath": "dist/arm-computeschedule.d.ts"
1015
},
1116
"messages": {
12-
"tsdocMessageReporting": { "default": { "logLevel": "none" } },
17+
"tsdocMessageReporting": {
18+
"default": {
19+
"logLevel": "none"
20+
}
21+
},
1322
"extractorMessageReporting": {
14-
"ae-missing-release-tag": { "logLevel": "none" },
15-
"ae-unresolved-link": { "logLevel": "none" }
23+
"ae-missing-release-tag": {
24+
"logLevel": "none"
25+
},
26+
"ae-unresolved-link": {
27+
"logLevel": "none"
28+
}
1629
}
1730
}
1831
}

sdk/computeschedule/arm-computeschedule/package.json

Lines changed: 39 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
"sideEffects": false,
99
"autoPublish": false,
1010
"tshy": {
11+
"project": "./tsconfig.src.json",
1112
"exports": {
1213
"./package.json": "./package.json",
1314
".": "./src/index.ts",
@@ -21,8 +22,7 @@
2122
"browser",
2223
"react-native"
2324
],
24-
"selfLink": false,
25-
"project": "./tsconfig.src.json"
25+
"selfLink": false
2626
},
2727
"type": "module",
2828
"keywords": [
@@ -36,10 +36,10 @@
3636
"author": "Microsoft Corporation",
3737
"license": "MIT",
3838
"files": [
39-
"dist",
39+
"dist/",
4040
"README.md",
4141
"LICENSE",
42-
"review/*",
42+
"review/",
4343
"CHANGELOG.md"
4444
],
4545
"sdk-type": "mgmt",
@@ -57,52 +57,53 @@
5757
]
5858
},
5959
"dependencies": {
60-
"@azure/core-util": "^1.9.2",
61-
"@azure-rest/core-client": "^2.1.0",
62-
"@azure/core-auth": "^1.6.0",
63-
"@azure/core-rest-pipeline": "^1.5.0",
64-
"@azure/logger": "^1.0.0",
60+
"@azure-rest/core-client": "^2.3.2",
61+
"@azure/core-auth": "^1.9.0",
62+
"@azure/core-rest-pipeline": "^1.18.2",
63+
"@azure/core-util": "^1.11.0",
64+
"@azure/logger": "^1.1.4",
6565
"tslib": "^2.6.2"
6666
},
6767
"devDependencies": {
68-
"dotenv": "^16.0.0",
68+
"@azure-tools/test-credential": "^2.0.0",
69+
"@azure-tools/test-recorder": "^4.1.0",
70+
"@azure-tools/test-utils-vitest": "^1.0.0",
71+
"@azure/dev-tool": "^1.0.0",
72+
"@azure/eslint-plugin-azure-sdk": "^3.0.0",
73+
"@azure/identity": "^4.5.0",
6974
"@types/node": "^18.0.0",
75+
"@vitest/browser": "^2.1.8",
76+
"@vitest/coverage-istanbul": "^2.1.8",
77+
"dotenv": "^16.0.0",
7078
"eslint": "^9.9.0",
71-
"prettier": "^3.2.5",
79+
"playwright": "^1.49.1",
7280
"typescript": "~5.7.2",
73-
"@azure/identity": "^4.2.1",
74-
"@vitest/browser": "^2.0.5",
75-
"@vitest/coverage-istanbul": "^2.0.5",
76-
"playwright": "^1.41.2",
77-
"vitest": "^2.0.5",
78-
"@azure-tools/test-credential": "^2.0.0",
79-
"@azure-tools/test-recorder": "^4.0.0",
80-
"@azure/dev-tool": "^1.0.0",
81-
"@azure/eslint-plugin-azure-sdk": "^3.0.0"
81+
"vitest": "^2.1.8"
8282
},
8383
"scripts": {
84-
"clean": "dev-tool run vendored rimraf --glob dist dist-browser dist-esm test-dist temp types *.tgz *.log",
85-
"extract-api": "dev-tool run vendored rimraf review && dev-tool run vendored mkdirp ./review && dev-tool run extract-api",
86-
"pack": "npm pack 2>&1",
87-
"lint": "echo skipped",
88-
"lint:fix": "echo skipped",
89-
"unit-test": "npm run unit-test:node && npm run unit-test:browser",
90-
"unit-test:browser": "npm run build:test && dev-tool run test:vitest --browser",
91-
"unit-test:node": "dev-tool run test:vitest",
92-
"integration-test": "npm run integration-test:node && npm run integration-test:browser",
93-
"integration-test:browser": "echo skipped",
94-
"integration-test:node": "echo skipped",
84+
"build": "npm run clean && dev-tool run build-package && dev-tool run vendored mkdirp ./review && dev-tool run extract-api",
9585
"build:samples": "tsc -p tsconfig.samples.json && dev-tool samples publish -f",
86+
"build:test": "npm run clean && dev-tool run build-package && dev-tool run build-test",
9687
"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}\" \"samples-dev/*.ts\"",
88+
"clean": "dev-tool run vendored rimraf --glob dist dist-browser dist-esm test-dist temp types *.tgz *.log",
9789
"execute:samples": "dev-tool samples run samples-dev",
90+
"extract-api": "dev-tool run vendored rimraf review && dev-tool run vendored mkdirp ./review && dev-tool run extract-api",
9891
"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}\" \"samples-dev/*.ts\"",
9992
"generate:client": "echo skipped",
100-
"test:browser": "npm run clean && npm run build:test && npm run unit-test:browser && npm run integration-test:browser",
93+
"integration-test": "npm run integration-test:node && npm run integration-test:browser",
94+
"integration-test:browser": "echo skipped",
95+
"integration-test:node": "dev-tool run test:vitest --esm",
96+
"lint": "echo skipped",
97+
"lint:fix": "echo skipped",
10198
"minify": "dev-tool run vendored uglifyjs -c -m --comments --source-map \"content='./dist/index.js.map'\" -o ./dist/index.min.js ./dist/index.js",
102-
"build:test": "npm run clean && dev-tool run build-package && dev-tool run build-test",
103-
"build": "npm run clean && dev-tool run build-package && dev-tool run vendored mkdirp ./review && dev-tool run extract-api",
99+
"pack": "npm pack 2>&1",
100+
"test": "npm run clean && dev-tool run build-package && npm run unit-test:node && dev-tool run bundle && npm run unit-test:browser && npm run integration-test",
101+
"test:browser": "npm run clean && npm run build:test && npm run unit-test:browser && npm run integration-test:browser",
104102
"test:node": "npm run clean && dev-tool run build-package && npm run unit-test:node && npm run integration-test:node",
105-
"test": "npm run clean && dev-tool run build-package && npm run unit-test:node && dev-tool run bundle && npm run unit-test:browser && npm run integration-test"
103+
"unit-test": "npm run unit-test:node && npm run unit-test:browser",
104+
"unit-test:browser": "echo skipped",
105+
"unit-test:node": "dev-tool run test:vitest",
106+
"update-snippets": "dev-tool run update-snippets"
106107
},
107108
"//sampleConfiguration": {
108109
"productName": "@azure/arm-computeschedule",
@@ -153,5 +154,7 @@
153154
},
154155
"main": "./dist/commonjs/index.js",
155156
"types": "./dist/commonjs/index.d.ts",
156-
"module": "./dist/esm/index.js"
157+
"module": "./dist/esm/index.js",
158+
"browser": "./dist/browser/index.js",
159+
"react-native": "./dist/react-native/index.js"
157160
}

sdk/computeschedule/arm-computeschedule/samples-dev/operationsListSample.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ async function operationsListMaxGeneratedByMaximumSetRuleGeneratedByMaximumSetRu
1515
const subscriptionId = "00000000-0000-0000-0000-00000000000";
1616
const client = new ComputeScheduleClient(credential, subscriptionId);
1717
const resArray = new Array();
18-
for await (let item of client.operations.list()) {
18+
for await (const item of client.operations.list()) {
1919
resArray.push(item);
2020
}
2121

@@ -33,16 +33,16 @@ async function operationsListMaxGeneratedByMaximumSetRuleGeneratedByMinimumSetRu
3333
const subscriptionId = "00000000-0000-0000-0000-00000000000";
3434
const client = new ComputeScheduleClient(credential, subscriptionId);
3535
const resArray = new Array();
36-
for await (let item of client.operations.list()) {
36+
for await (const item of client.operations.list()) {
3737
resArray.push(item);
3838
}
3939

4040
console.log(resArray);
4141
}
4242

4343
async function main(): Promise<void> {
44-
operationsListMaxGeneratedByMaximumSetRuleGeneratedByMaximumSetRule();
45-
operationsListMaxGeneratedByMaximumSetRuleGeneratedByMinimumSetRule();
44+
await operationsListMaxGeneratedByMaximumSetRuleGeneratedByMaximumSetRule();
45+
await operationsListMaxGeneratedByMaximumSetRuleGeneratedByMinimumSetRule();
4646
}
4747

4848
main().catch(console.error);

sdk/computeschedule/arm-computeschedule/samples-dev/scheduledActionsVirtualMachinesCancelOperationsSample.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ async function scheduledActionsVirtualMachinesCancelOperationsGeneratedByMaximum
3939
}
4040

4141
async function main(): Promise<void> {
42-
scheduledActionsVirtualMachinesCancelOperationsGeneratedByMaximumSetRuleGeneratedByMaximumSetRule();
43-
scheduledActionsVirtualMachinesCancelOperationsGeneratedByMaximumSetRuleGeneratedByMinimumSetRule();
42+
await scheduledActionsVirtualMachinesCancelOperationsGeneratedByMaximumSetRuleGeneratedByMaximumSetRule();
43+
await scheduledActionsVirtualMachinesCancelOperationsGeneratedByMaximumSetRuleGeneratedByMinimumSetRule();
4444
}
4545

4646
main().catch(console.error);

sdk/computeschedule/arm-computeschedule/samples-dev/scheduledActionsVirtualMachinesExecuteDeallocateSample.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ async function scheduledActionsVirtualMachinesExecuteDeallocateGeneratedByMaximu
5555
}
5656

5757
async function main(): Promise<void> {
58-
scheduledActionsVirtualMachinesExecuteDeallocateGeneratedByMaximumSetRuleGeneratedByMaximumSetRule();
59-
scheduledActionsVirtualMachinesExecuteDeallocateGeneratedByMaximumSetRuleGeneratedByMinimumSetRule();
58+
await scheduledActionsVirtualMachinesExecuteDeallocateGeneratedByMaximumSetRuleGeneratedByMaximumSetRule();
59+
await scheduledActionsVirtualMachinesExecuteDeallocateGeneratedByMaximumSetRuleGeneratedByMinimumSetRule();
6060
}
6161

6262
main().catch(console.error);

sdk/computeschedule/arm-computeschedule/samples-dev/scheduledActionsVirtualMachinesExecuteHibernateSample.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ async function scheduledActionsVirtualMachinesExecuteHibernateGeneratedByMaximum
5555
}
5656

5757
async function main(): Promise<void> {
58-
scheduledActionsVirtualMachinesExecuteHibernateGeneratedByMaximumSetRuleGeneratedByMaximumSetRule();
59-
scheduledActionsVirtualMachinesExecuteHibernateGeneratedByMaximumSetRuleGeneratedByMinimumSetRule();
58+
await scheduledActionsVirtualMachinesExecuteHibernateGeneratedByMaximumSetRuleGeneratedByMaximumSetRule();
59+
await scheduledActionsVirtualMachinesExecuteHibernateGeneratedByMaximumSetRuleGeneratedByMinimumSetRule();
6060
}
6161

6262
main().catch(console.error);

sdk/computeschedule/arm-computeschedule/samples-dev/scheduledActionsVirtualMachinesExecuteStartSample.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ async function scheduledActionsVirtualMachinesExecuteStartGeneratedByMaximumSetR
5555
}
5656

5757
async function main(): Promise<void> {
58-
scheduledActionsVirtualMachinesExecuteStartGeneratedByMaximumSetRuleGeneratedByMaximumSetRule();
59-
scheduledActionsVirtualMachinesExecuteStartGeneratedByMaximumSetRuleGeneratedByMinimumSetRule();
58+
await scheduledActionsVirtualMachinesExecuteStartGeneratedByMaximumSetRuleGeneratedByMaximumSetRule();
59+
await scheduledActionsVirtualMachinesExecuteStartGeneratedByMaximumSetRuleGeneratedByMinimumSetRule();
6060
}
6161

6262
main().catch(console.error);

sdk/computeschedule/arm-computeschedule/samples-dev/scheduledActionsVirtualMachinesGetOperationErrorsSample.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ async function csScheduledActionsVirtualMachinesGetOperationErrorsMin(): Promise
3737
}
3838

3939
async function main(): Promise<void> {
40-
csScheduledActionsVirtualMachinesGetOperationErrorsMax();
41-
csScheduledActionsVirtualMachinesGetOperationErrorsMin();
40+
await csScheduledActionsVirtualMachinesGetOperationErrorsMax();
41+
await csScheduledActionsVirtualMachinesGetOperationErrorsMin();
4242
}
4343

4444
main().catch(console.error);

sdk/computeschedule/arm-computeschedule/samples-dev/scheduledActionsVirtualMachinesGetOperationStatusSample.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ async function scheduledActionsVirtualMachinesGetOperationStatusGeneratedByMinim
4242
}
4343

4444
async function main(): Promise<void> {
45-
scheduledActionsVirtualMachinesGetOperationStatusGeneratedByMinimumSetRuleGeneratedByMaximumSetRule();
46-
scheduledActionsVirtualMachinesGetOperationStatusGeneratedByMinimumSetRule();
45+
await scheduledActionsVirtualMachinesGetOperationStatusGeneratedByMinimumSetRuleGeneratedByMaximumSetRule();
46+
await scheduledActionsVirtualMachinesGetOperationStatusGeneratedByMinimumSetRule();
4747
}
4848

4949
main().catch(console.error);

0 commit comments

Comments
 (0)