Skip to content

Commit bce4f27

Browse files
authored
[Storage] Fix api-extractor related issues (#7174)
- Fixed warnings caused by not exporting `OperationTracingOptions` * fix api-extractor `ae-forgotten-export` warnings by exporting those types * Rename file datalake typing rollup file * Only pack the rolled up typed definition files
1 parent f42f9ba commit bce4f27

File tree

16 files changed

+645
-114
lines changed

16 files changed

+645
-114
lines changed

sdk/storage/storage-blob/package.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@
1616
"os": false,
1717
"process": false
1818
},
19-
"types": "./typings/latest/src/index.d.ts",
19+
"types": "./typings/latest/storage-blob.d.ts",
2020
"typesVersions": {
2121
"<3.6": {
2222
"*": [
23-
"./typings/3.1/src/index.d.ts"
23+
"./typings/3.1/storage-blob.d.ts"
2424
]
2525
}
2626
},
@@ -30,13 +30,13 @@
3030
"scripts": {
3131
"audit": "node ../../../common/scripts/rush-audit.js && rimraf node_modules package-lock.json && npm i --package-lock-only 2>&1 && npm audit",
3232
"build:autorest": "autorest ./swagger/README.md --typescript --package-version=12.2.0 [email protected]/[email protected]",
33-
"build:es6": "tsc -p tsconfig.json && npm run build:types",
33+
"build:es6": "tsc -p tsconfig.json",
3434
"build:nodebrowser": "rollup -c 2>&1",
3535
"build:samples": "npm run clean && npm run build:es6 && cross-env ONLY_NODE=true rollup -c 2>&1 && npm run build:prep-samples",
3636
"build:prep-samples": "node ../../../common/scripts/prep-samples.js && cd samples && tsc",
3737
"build:test": "npm run build:es6 && rollup -c rollup.test.config.js 2>&1",
3838
"build:types": "downlevel-dts typings/latest typings/3.1",
39-
"build": "npm run build:es6 && npm run build:nodebrowser && api-extractor run --local",
39+
"build": "npm run build:es6 && npm run build:nodebrowser && api-extractor run --local && npm run build:types",
4040
"check-format": "prettier --list-different --config ../../.prettierrc.json \"src/**/*.ts\" \"test/**/*.ts\" \"*.{js,json}\"",
4141
"clean": "rimraf dist dist-esm dist-test typings temp dist-browser/*.js* dist-browser/*.zip statistics.html coverage coverage-browser .nyc_output *.tgz *.log test*.xml TEST*.xml",
4242
"clean:samples": "rimraf samples/javascript/node_modules samples/typescript/node_modules samples/typescript/dist samples/typescript/package-lock.json samples/javascript/package-lock.json",
@@ -64,8 +64,8 @@
6464
"BreakingChanges.md",
6565
"dist/",
6666
"dist-esm/src/",
67-
"typings/latest/src",
68-
"typings/3.1/src",
67+
"typings/latest/storage-blob.d.ts",
68+
"typings/3.1/storage-blob.d.ts",
6969
"README.md",
7070
"LICENSE"
7171
],

sdk/storage/storage-blob/review/storage-blob.api.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1200,7 +1200,6 @@ export type BlockListType = 'committed' | 'uncommitted' | 'all';
12001200

12011201
// @public
12021202
export interface CommonOptions {
1203-
// Warning: (ae-forgotten-export) The symbol "OperationTracingOptions" needs to be exported by the entry point index.d.ts
12041203
tracingOptions?: OperationTracingOptions;
12051204
}
12061205

@@ -1755,6 +1754,11 @@ export interface ModifiedAccessConditions {
17551754
// @public
17561755
export function newPipeline(credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline;
17571756

1757+
// @public (undocumented)
1758+
export interface OperationTracingOptions {
1759+
spanOptions?: SpanOptions;
1760+
}
1761+
17581762
// @public
17591763
export interface PageBlobClearPagesHeaders {
17601764
blobSequenceNumber?: number;

sdk/storage/storage-blob/src/index.browser.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ export * from "./Pipeline";
1818
export * from "./policies/AnonymousCredentialPolicy";
1919
export * from "./policies/CredentialPolicy";
2020
export * from "./StorageRetryPolicyFactory";
21-
export { CommonOptions } from "./StorageClient";
21+
export { CommonOptions, OperationTracingOptions } from "./StorageClient";
2222
export * from "./generatedModels";
2323
export { RestError };
2424
export {

sdk/storage/storage-blob/src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export * from "./policies/CredentialPolicy";
2929
export * from "./StorageRetryPolicyFactory";
3030
export * from "./policies/StorageSharedKeyCredentialPolicy";
3131
export * from "./SASQueryParameters";
32-
export { CommonOptions } from "./StorageClient";
32+
export { CommonOptions, OperationTracingOptions } from "./StorageClient";
3333
export * from "./generatedModels";
3434
export {
3535
AppendBlobRequestConditions,

sdk/storage/storage-file-datalake/api-extractor.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"dtsRollup": {
1212
"enabled": true,
1313
"untrimmedFilePath": "",
14-
"publicTrimmedFilePath": "./typings/latest/storage-datalake.d.ts"
14+
"publicTrimmedFilePath": "./typings/latest/storage-file-datalake.d.ts"
1515
},
1616
"messages": {
1717
"tsdocMessageReporting": {

sdk/storage/storage-file-datalake/package.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55
"sdk-type": "client",
66
"main": "./dist/index.js",
77
"module": "./dist-esm/src/index.js",
8-
"types": "./typings/latest/src/index.d.ts",
8+
"types": "./typings/latest/storage-file-datalake.d.ts",
99
"typesVersions": {
1010
"<3.6": {
1111
"*": [
12-
"./typings/3.1/src/index.d.ts"
12+
"./typings/3.1/storage-file-datalake.d.ts"
1313
]
1414
}
1515
},
@@ -28,13 +28,13 @@
2828
"scripts": {
2929
"audit": "node ../../../common/scripts/rush-audit.js && rimraf node_modules package-lock.json && npm i --package-lock-only 2>&1 && npm audit",
3030
"build:autorest": "autorest ./swagger/README.md --typescript [email protected]/[email protected]",
31-
"build:es6": "tsc -p tsconfig.json && npm run build:types",
31+
"build:es6": "tsc -p tsconfig.json",
3232
"build:nodebrowser": "rollup -c 2>&1",
3333
"build:js-samples": "npm run clean && npm run build:es6 && cross-env ONLY_NODE=true rollup -c 2>&1",
3434
"build:ts-samples": "npm run clean && cd samples && tsc -p . ",
3535
"build:test": "npm run build:es6 && rollup -c rollup.test.config.js 2>&1",
3636
"build:types": "downlevel-dts typings/latest typings/3.1",
37-
"build": "npm run build:es6 && npm run build:nodebrowser && api-extractor run --local",
37+
"build": "npm run build:es6 && npm run build:nodebrowser && api-extractor run --local && npm run build:types",
3838
"check-format": "prettier --list-different --config ../../.prettierrc.json \"src/**/*.ts\" \"test/**/*.ts\" \"*.{js,json}\"",
3939
"clean": "rimraf dist dist-esm dist-test typings temp dist-browser/*.js* dist-browser/*.zip statistics.html coverage coverage-browser .nyc_output *.tgz *.log test*.xml TEST*.xml",
4040
"extract-api": "tsc -p . && api-extractor run --local",
@@ -58,8 +58,8 @@
5858
"BreakingChanges.md",
5959
"dist/",
6060
"dist-esm/src/",
61-
"typings/latest/src",
62-
"typings/3.1/src",
61+
"typings/latest/storage-file-datalake.d.ts",
62+
"typings/3.1/storage-file-datalake.d.ts",
6363
"README.md",
6464
"LICENSE"
6565
],

sdk/storage/storage-file-datalake/src/index.browser.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ export * from "./policies/AnonymousCredentialPolicy";
1313
export * from "./policies/CredentialPolicy";
1414
export * from "./StorageRetryPolicyFactory";
1515
export * from "./models";
16-
export { CommonOptions } from "./StorageClient";
16+
export { CommonOptions, OperationTracingOptions } from "./StorageClient";
1717
export { ToBlobEndpointHostMappings, ToDfsEndpointHostMappings } from "./utils/constants";
1818
export { RestError } from "@azure/core-http";
1919
export { logger } from "./log";

sdk/storage/storage-file-share/package.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@
1515
"os": false,
1616
"process": false
1717
},
18-
"types": "./typings/latest/src/index.d.ts",
18+
"types": "./typings/latest/storage-file-share.d.ts",
1919
"typesVersions": {
2020
"<3.6": {
2121
"*": [
22-
"./typings/3.1/src/index.d.ts"
22+
"./typings/3.1/storage-file-share.d.ts"
2323
]
2424
}
2525
},
@@ -29,13 +29,13 @@
2929
"scripts": {
3030
"audit": "node ../../../common/scripts/rush-audit.js && rimraf node_modules package-lock.json && npm i --package-lock-only 2>&1 && npm audit",
3131
"build:autorest": "autorest ./swagger/README.md --typescript --package-version=12.2.0 [email protected]/[email protected]",
32-
"build:es6": "tsc -p tsconfig.json && npm run build:types",
32+
"build:es6": "tsc -p tsconfig.json",
3333
"build:nodebrowser": "rollup -c 2>&1",
3434
"build:samples": "npm run clean && npm run build:es6 && cross-env ONLY_NODE=true rollup -c 2>&1 && npm run build:prep-samples",
3535
"build:prep-samples": "node ../../../common/scripts/prep-samples.js && cd samples && tsc",
3636
"build:test": "npm run build:es6 && rollup -c rollup.test.config.js 2>&1",
3737
"build:types": "downlevel-dts typings/latest typings/3.1",
38-
"build": "npm run build:es6 && npm run build:nodebrowser && api-extractor run --local",
38+
"build": "npm run build:es6 && npm run build:nodebrowser && api-extractor run --local && npm run build:types",
3939
"check-format": "prettier --list-different --config ../../.prettierrc.json \"src/**/*.ts\" \"test/**/*.ts\" \"*.{js,json}\"",
4040
"clean": "rimraf dist dist-esm dist-test typings temp dist-browser/*.js* dist-browser/*.zip statistics.html coverage coverage-browser .nyc_output *.tgz *.log test*.xml TEST*.xml",
4141
"clean:samples": "rimraf samples/javascript/node_modules samples/typescript/node_modules samples/typescript/dist samples/typescript/package-lock.json samples/javascript/package-lock.json",
@@ -63,8 +63,8 @@
6363
"ThirdPartyNotices.txt",
6464
"dist/",
6565
"dist-esm/src/",
66-
"typings/latest/src",
67-
"typings/3.1/src",
66+
"typings/latest/storage-file-share.d.ts",
67+
"typings/3.1/storage-file-share.d.ts",
6868
"README.md",
6969
"LICENSE"
7070
],

0 commit comments

Comments
 (0)