From 88d943f9fe72c08acd03425a736fda22e88d7701 Mon Sep 17 00:00:00 2001 From: Michael Young Date: Mon, 22 May 2023 21:04:45 +0000 Subject: [PATCH 1/2] docs(packages): add api-extractor to public packages --- .eslintrc.js | 3 ++- .gitignore | 2 ++ api-extractor.json | 14 ++++++-------- api-extractor.packages.json | 10 ++++++++++ packages/cloudfront-signer/api-extractor.json | 4 ++++ packages/cloudfront-signer/package.json | 1 + packages/credential-providers/api-extractor.json | 4 ++++ packages/credential-providers/package.json | 1 + packages/fetch-http-handler/api-extractor.json | 4 ++++ packages/fetch-http-handler/package.json | 1 + packages/hash-node/api-extractor.json | 4 ++++ packages/hash-node/package.json | 1 + .../middleware-bucket-endpoint/api-extractor.json | 4 ++++ packages/middleware-bucket-endpoint/package.json | 1 + packages/middleware-endpoint/api-extractor.json | 4 ++++ packages/middleware-endpoint/package.json | 1 + packages/middleware-retry/api-extractor.json | 4 ++++ packages/middleware-retry/package.json | 1 + packages/middleware-stack/api-extractor.json | 4 ++++ packages/middleware-stack/package.json | 1 + packages/node-http-handler/api-extractor.json | 4 ++++ packages/node-http-handler/package.json | 1 + .../polly-request-presigner/api-extractor.json | 4 ++++ packages/polly-request-presigner/package.json | 1 + packages/rds-signer/api-extractor.json | 4 ++++ packages/rds-signer/package.json | 1 + packages/s3-presigned-post/api-extractor.json | 4 ++++ packages/s3-presigned-post/package.json | 1 + packages/s3-request-presigner/api-extractor.json | 4 ++++ packages/s3-request-presigner/package.json | 1 + packages/shared-ini-file-loader/api-extractor.json | 4 ++++ packages/shared-ini-file-loader/package.json | 1 + packages/signature-v4-crt/api-extractor.json | 4 ++++ packages/signature-v4-crt/package.json | 1 + .../signature-v4-multi-region/api-extractor.json | 4 ++++ packages/signature-v4-multi-region/package.json | 1 + packages/signature-v4/api-extractor.json | 4 ++++ packages/signature-v4/package.json | 1 + packages/smithy-client/api-extractor.json | 4 ++++ packages/smithy-client/package.json | 1 + packages/token-providers/api-extractor.json | 4 ++++ packages/token-providers/package.json | 1 + packages/types/api-extractor.json | 4 ++++ packages/types/package.json | 1 + packages/util-create-request/api-extractor.json | 4 ++++ packages/util-create-request/package.json | 1 + packages/util-dynamodb/api-extractor.json | 4 ++++ packages/util-dynamodb/package.json | 1 + packages/util-retry/api-extractor.json | 4 ++++ packages/util-retry/package.json | 1 + packages/xhr-http-handler/api-extractor.json | 4 ++++ packages/xhr-http-handler/package.json | 1 + 52 files changed, 140 insertions(+), 9 deletions(-) create mode 100644 api-extractor.packages.json create mode 100644 packages/cloudfront-signer/api-extractor.json create mode 100644 packages/credential-providers/api-extractor.json create mode 100644 packages/fetch-http-handler/api-extractor.json create mode 100644 packages/hash-node/api-extractor.json create mode 100644 packages/middleware-bucket-endpoint/api-extractor.json create mode 100644 packages/middleware-endpoint/api-extractor.json create mode 100644 packages/middleware-retry/api-extractor.json create mode 100644 packages/middleware-stack/api-extractor.json create mode 100644 packages/node-http-handler/api-extractor.json create mode 100644 packages/polly-request-presigner/api-extractor.json create mode 100644 packages/rds-signer/api-extractor.json create mode 100644 packages/s3-presigned-post/api-extractor.json create mode 100644 packages/s3-request-presigner/api-extractor.json create mode 100644 packages/shared-ini-file-loader/api-extractor.json create mode 100644 packages/signature-v4-crt/api-extractor.json create mode 100644 packages/signature-v4-multi-region/api-extractor.json create mode 100644 packages/signature-v4/api-extractor.json create mode 100644 packages/smithy-client/api-extractor.json create mode 100644 packages/token-providers/api-extractor.json create mode 100644 packages/types/api-extractor.json create mode 100644 packages/util-create-request/api-extractor.json create mode 100644 packages/util-dynamodb/api-extractor.json create mode 100644 packages/util-retry/api-extractor.json create mode 100644 packages/xhr-http-handler/api-extractor.json diff --git a/.eslintrc.js b/.eslintrc.js index f9d6aa56555d9..91d9874cf3e91 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -8,7 +8,7 @@ module.exports = { // Uses the recommended rules from the @typescript-eslint/eslint-plugin "plugin:@typescript-eslint/recommended", ], - plugins: ["@typescript-eslint", "simple-import-sort", "eslint-plugin-sort-export-all"], + plugins: ["@typescript-eslint", "simple-import-sort", "eslint-plugin-sort-export-all", "eslint-plugin-tsdoc"], rules: { /** Turn off strict enforcement */ "@typescript-eslint/ban-types": "off", @@ -23,6 +23,7 @@ module.exports = { /** Warnings */ "@typescript-eslint/no-namespace": "warn", + "tsdoc/syntax": "warn", /** Errors */ "simple-import-sort/imports": "error", diff --git a/.gitignore b/.gitignore index b5bcd17299e91..8b84b88bfeb31 100644 --- a/.gitignore +++ b/.gitignore @@ -65,6 +65,8 @@ benchmark/size/raw etc/ temp/ +temp-packages/ +temp-lib/ # Gradle composite build properties codegen/local.properties diff --git a/api-extractor.json b/api-extractor.json index 33444c5fef260..e45ee36fdb7d0 100644 --- a/api-extractor.json +++ b/api-extractor.json @@ -60,9 +60,7 @@ * This would direct API Extractor to embed those types directly in the .d.ts rollup, as if they had been * local files for library1. */ - "bundledPackages": [ - // "@aws-sdk/types", "@aws-sdk/util-waiter", "@aws-sdk/smithy-client" - ], + // "bundledPackages": ["@aws-sdk/types", "@aws-sdk/util-waiter", "@aws-sdk/smithy-client", "@aws-smithy/types"], /** * Specifies what type of newlines API Extractor should use when writing output files. By default, the output files @@ -178,7 +176,7 @@ * SUPPORTED TOKENS: , , * DEFAULT VALUE: "/temp/" */ - "reportTempFolder": "./temp/" + "reportTempFolder": "./temp/", /** * Whether "forgotten exports" should be included in the API report file. Forgotten exports are declarations @@ -187,7 +185,7 @@ * * DEFAULT VALUE: "false" */ - // "includeForgottenExports": false + "includeForgottenExports": true }, /** @@ -217,7 +215,7 @@ * * DEFAULT VALUE: "false" */ - // "includeForgottenExports": false, + // "includeForgottenExports": true /** * The base URL where the project's source code can be viewed on a website such as GitHub or @@ -243,7 +241,7 @@ /** * (REQUIRED) Whether to generate the .d.ts rollup file. */ - "enabled": true + "enabled": false, /** * Specifies the output path for a .d.ts rollup file to be generated without any trimming. @@ -257,7 +255,7 @@ * SUPPORTED TOKENS: , , * DEFAULT VALUE: "/dist/.d.ts" */ - // "untrimmedFilePath": "/dist/.d.ts", + "untrimmedFilePath": "./dist/.d.ts" /** * Specifies the output path for a .d.ts rollup file to be generated with trimming for an "alpha" release. diff --git a/api-extractor.packages.json b/api-extractor.packages.json new file mode 100644 index 0000000000000..3be5d1f72ee98 --- /dev/null +++ b/api-extractor.packages.json @@ -0,0 +1,10 @@ +{ + "extends": "./api-extractor.json", + "docModel": { + "apiJsonFilePath": "./temp-packages/.api.json" + }, + "apiReport": { + "reportFolder": "./temp-packages/", + "reportTempFolder": "./temp-packages/" + } +} diff --git a/packages/cloudfront-signer/api-extractor.json b/packages/cloudfront-signer/api-extractor.json new file mode 100644 index 0000000000000..b03e22a16a06e --- /dev/null +++ b/packages/cloudfront-signer/api-extractor.json @@ -0,0 +1,4 @@ +{ + "extends": "../../api-extractor.packages.json", + "mainEntryPointFilePath": "./dist-types/index.d.ts" +} diff --git a/packages/cloudfront-signer/package.json b/packages/cloudfront-signer/package.json index cc855c68f2520..9bb9580ead1eb 100644 --- a/packages/cloudfront-signer/package.json +++ b/packages/cloudfront-signer/package.json @@ -9,6 +9,7 @@ "build:types": "tsc -p tsconfig.types.json", "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4", "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo", + "extract:docs": "api-extractor run --local", "test": "jest" }, "main": "./dist-cjs/index.js", diff --git a/packages/credential-providers/api-extractor.json b/packages/credential-providers/api-extractor.json new file mode 100644 index 0000000000000..b03e22a16a06e --- /dev/null +++ b/packages/credential-providers/api-extractor.json @@ -0,0 +1,4 @@ +{ + "extends": "../../api-extractor.packages.json", + "mainEntryPointFilePath": "./dist-types/index.d.ts" +} diff --git a/packages/credential-providers/package.json b/packages/credential-providers/package.json index 7184d8e163e08..eccad3690e244 100644 --- a/packages/credential-providers/package.json +++ b/packages/credential-providers/package.json @@ -15,6 +15,7 @@ "build:types": "tsc -p tsconfig.types.json", "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4", "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo", + "extract:docs": "api-extractor run --local", "test": "jest" }, "keywords": [ diff --git a/packages/fetch-http-handler/api-extractor.json b/packages/fetch-http-handler/api-extractor.json new file mode 100644 index 0000000000000..b03e22a16a06e --- /dev/null +++ b/packages/fetch-http-handler/api-extractor.json @@ -0,0 +1,4 @@ +{ + "extends": "../../api-extractor.packages.json", + "mainEntryPointFilePath": "./dist-types/index.d.ts" +} diff --git a/packages/fetch-http-handler/package.json b/packages/fetch-http-handler/package.json index bd4f75cd4f8d9..afc346144236d 100644 --- a/packages/fetch-http-handler/package.json +++ b/packages/fetch-http-handler/package.json @@ -10,6 +10,7 @@ "build:types": "tsc -p tsconfig.types.json", "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4", "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo", + "extract:docs": "api-extractor run --local", "test": "jest --coverage && karma start karma.conf.js" }, "author": { diff --git a/packages/hash-node/api-extractor.json b/packages/hash-node/api-extractor.json new file mode 100644 index 0000000000000..b03e22a16a06e --- /dev/null +++ b/packages/hash-node/api-extractor.json @@ -0,0 +1,4 @@ +{ + "extends": "../../api-extractor.packages.json", + "mainEntryPointFilePath": "./dist-types/index.d.ts" +} diff --git a/packages/hash-node/package.json b/packages/hash-node/package.json index b37f2b3bc5f55..ca45c7bcfcc15 100644 --- a/packages/hash-node/package.json +++ b/packages/hash-node/package.json @@ -9,6 +9,7 @@ "build:types": "tsc -p tsconfig.types.json", "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4", "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo", + "extract:docs": "api-extractor run --local", "test": "jest" }, "main": "./dist-cjs/index.js", diff --git a/packages/middleware-bucket-endpoint/api-extractor.json b/packages/middleware-bucket-endpoint/api-extractor.json new file mode 100644 index 0000000000000..b03e22a16a06e --- /dev/null +++ b/packages/middleware-bucket-endpoint/api-extractor.json @@ -0,0 +1,4 @@ +{ + "extends": "../../api-extractor.packages.json", + "mainEntryPointFilePath": "./dist-types/index.d.ts" +} diff --git a/packages/middleware-bucket-endpoint/package.json b/packages/middleware-bucket-endpoint/package.json index cd38188b65244..727e1821c81d4 100644 --- a/packages/middleware-bucket-endpoint/package.json +++ b/packages/middleware-bucket-endpoint/package.json @@ -9,6 +9,7 @@ "build:types": "tsc -p tsconfig.types.json", "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4", "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo", + "extract:docs": "api-extractor run --local", "test": "jest" }, "main": "./dist-cjs/index.js", diff --git a/packages/middleware-endpoint/api-extractor.json b/packages/middleware-endpoint/api-extractor.json new file mode 100644 index 0000000000000..b03e22a16a06e --- /dev/null +++ b/packages/middleware-endpoint/api-extractor.json @@ -0,0 +1,4 @@ +{ + "extends": "../../api-extractor.packages.json", + "mainEntryPointFilePath": "./dist-types/index.d.ts" +} diff --git a/packages/middleware-endpoint/package.json b/packages/middleware-endpoint/package.json index ae388431f9f5f..d2954ba865432 100644 --- a/packages/middleware-endpoint/package.json +++ b/packages/middleware-endpoint/package.json @@ -9,6 +9,7 @@ "build:types": "tsc -p tsconfig.types.json", "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4", "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo", + "extract:docs": "api-extractor run --local", "test": "jest --passWithNoTests", "test:integration": "jest -c jest.config.integ.js" }, diff --git a/packages/middleware-retry/api-extractor.json b/packages/middleware-retry/api-extractor.json new file mode 100644 index 0000000000000..b03e22a16a06e --- /dev/null +++ b/packages/middleware-retry/api-extractor.json @@ -0,0 +1,4 @@ +{ + "extends": "../../api-extractor.packages.json", + "mainEntryPointFilePath": "./dist-types/index.d.ts" +} diff --git a/packages/middleware-retry/package.json b/packages/middleware-retry/package.json index 402e2a2658905..40ea0689b1cf2 100644 --- a/packages/middleware-retry/package.json +++ b/packages/middleware-retry/package.json @@ -9,6 +9,7 @@ "build:types": "tsc -p tsconfig.types.json", "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4", "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo", + "extract:docs": "api-extractor run --local", "test": "jest", "test:integration": "jest -c jest.config.integ.js" }, diff --git a/packages/middleware-stack/api-extractor.json b/packages/middleware-stack/api-extractor.json new file mode 100644 index 0000000000000..b03e22a16a06e --- /dev/null +++ b/packages/middleware-stack/api-extractor.json @@ -0,0 +1,4 @@ +{ + "extends": "../../api-extractor.packages.json", + "mainEntryPointFilePath": "./dist-types/index.d.ts" +} diff --git a/packages/middleware-stack/package.json b/packages/middleware-stack/package.json index 707b79ff49c55..beceaa6552de3 100644 --- a/packages/middleware-stack/package.json +++ b/packages/middleware-stack/package.json @@ -10,6 +10,7 @@ "build:types": "tsc -p tsconfig.types.json", "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4", "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo", + "extract:docs": "api-extractor run --local", "test": "jest", "test:integration": "jest -c jest.config.integ.js --passWithNoTests" }, diff --git a/packages/node-http-handler/api-extractor.json b/packages/node-http-handler/api-extractor.json new file mode 100644 index 0000000000000..b03e22a16a06e --- /dev/null +++ b/packages/node-http-handler/api-extractor.json @@ -0,0 +1,4 @@ +{ + "extends": "../../api-extractor.packages.json", + "mainEntryPointFilePath": "./dist-types/index.d.ts" +} diff --git a/packages/node-http-handler/package.json b/packages/node-http-handler/package.json index a2b251b97f281..0bceab5ef71d7 100644 --- a/packages/node-http-handler/package.json +++ b/packages/node-http-handler/package.json @@ -10,6 +10,7 @@ "build:types": "tsc -p tsconfig.types.json", "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4", "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo", + "extract:docs": "api-extractor run --local", "test": "jest --coverage" }, "author": { diff --git a/packages/polly-request-presigner/api-extractor.json b/packages/polly-request-presigner/api-extractor.json new file mode 100644 index 0000000000000..b03e22a16a06e --- /dev/null +++ b/packages/polly-request-presigner/api-extractor.json @@ -0,0 +1,4 @@ +{ + "extends": "../../api-extractor.packages.json", + "mainEntryPointFilePath": "./dist-types/index.d.ts" +} diff --git a/packages/polly-request-presigner/package.json b/packages/polly-request-presigner/package.json index a7e86b66f6f40..b9d8c0f76a2c3 100644 --- a/packages/polly-request-presigner/package.json +++ b/packages/polly-request-presigner/package.json @@ -9,6 +9,7 @@ "build:types": "tsc -p tsconfig.types.json", "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4", "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo", + "extract:docs": "api-extractor run --local", "test": "jest" }, "main": "./dist-cjs/index.js", diff --git a/packages/rds-signer/api-extractor.json b/packages/rds-signer/api-extractor.json new file mode 100644 index 0000000000000..b03e22a16a06e --- /dev/null +++ b/packages/rds-signer/api-extractor.json @@ -0,0 +1,4 @@ +{ + "extends": "../../api-extractor.packages.json", + "mainEntryPointFilePath": "./dist-types/index.d.ts" +} diff --git a/packages/rds-signer/package.json b/packages/rds-signer/package.json index 6892dd2bed561..be8b24599450a 100644 --- a/packages/rds-signer/package.json +++ b/packages/rds-signer/package.json @@ -13,6 +13,7 @@ "build:types": "tsc -p tsconfig.types.json", "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4", "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo", + "extract:docs": "api-extractor run --local", "test": "jest" }, "engines": { diff --git a/packages/s3-presigned-post/api-extractor.json b/packages/s3-presigned-post/api-extractor.json new file mode 100644 index 0000000000000..b03e22a16a06e --- /dev/null +++ b/packages/s3-presigned-post/api-extractor.json @@ -0,0 +1,4 @@ +{ + "extends": "../../api-extractor.packages.json", + "mainEntryPointFilePath": "./dist-types/index.d.ts" +} diff --git a/packages/s3-presigned-post/package.json b/packages/s3-presigned-post/package.json index accf50c09e31f..f938203cfe438 100644 --- a/packages/s3-presigned-post/package.json +++ b/packages/s3-presigned-post/package.json @@ -9,6 +9,7 @@ "build:types": "tsc -p tsconfig.types.json", "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4", "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo", + "extract:docs": "api-extractor run --local", "test": "jest", "test:e2e": "jest -c jest.config.e2e.js" }, diff --git a/packages/s3-request-presigner/api-extractor.json b/packages/s3-request-presigner/api-extractor.json new file mode 100644 index 0000000000000..b03e22a16a06e --- /dev/null +++ b/packages/s3-request-presigner/api-extractor.json @@ -0,0 +1,4 @@ +{ + "extends": "../../api-extractor.packages.json", + "mainEntryPointFilePath": "./dist-types/index.d.ts" +} diff --git a/packages/s3-request-presigner/package.json b/packages/s3-request-presigner/package.json index 7a8c941a63c24..f0987e7df87f7 100644 --- a/packages/s3-request-presigner/package.json +++ b/packages/s3-request-presigner/package.json @@ -9,6 +9,7 @@ "build:types": "tsc -p tsconfig.types.json", "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4", "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo", + "extract:docs": "api-extractor run --local", "test": "jest" }, "main": "./dist-cjs/index.js", diff --git a/packages/shared-ini-file-loader/api-extractor.json b/packages/shared-ini-file-loader/api-extractor.json new file mode 100644 index 0000000000000..b03e22a16a06e --- /dev/null +++ b/packages/shared-ini-file-loader/api-extractor.json @@ -0,0 +1,4 @@ +{ + "extends": "../../api-extractor.packages.json", + "mainEntryPointFilePath": "./dist-types/index.d.ts" +} diff --git a/packages/shared-ini-file-loader/package.json b/packages/shared-ini-file-loader/package.json index 7f2591c139bb4..b95abe34beccc 100644 --- a/packages/shared-ini-file-loader/package.json +++ b/packages/shared-ini-file-loader/package.json @@ -22,6 +22,7 @@ "build:types": "tsc -p tsconfig.types.json", "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4", "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo", + "extract:docs": "api-extractor run --local", "test": "jest" }, "author": { diff --git a/packages/signature-v4-crt/api-extractor.json b/packages/signature-v4-crt/api-extractor.json new file mode 100644 index 0000000000000..b03e22a16a06e --- /dev/null +++ b/packages/signature-v4-crt/api-extractor.json @@ -0,0 +1,4 @@ +{ + "extends": "../../api-extractor.packages.json", + "mainEntryPointFilePath": "./dist-types/index.d.ts" +} diff --git a/packages/signature-v4-crt/package.json b/packages/signature-v4-crt/package.json index 43aff679fbba2..935a5dbc7d973 100644 --- a/packages/signature-v4-crt/package.json +++ b/packages/signature-v4-crt/package.json @@ -13,6 +13,7 @@ "build:types": "tsc -p tsconfig.types.json", "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4", "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo", + "extract:docs": "api-extractor run --local", "test": "jest --coverage" }, "author": { diff --git a/packages/signature-v4-multi-region/api-extractor.json b/packages/signature-v4-multi-region/api-extractor.json new file mode 100644 index 0000000000000..b03e22a16a06e --- /dev/null +++ b/packages/signature-v4-multi-region/api-extractor.json @@ -0,0 +1,4 @@ +{ + "extends": "../../api-extractor.packages.json", + "mainEntryPointFilePath": "./dist-types/index.d.ts" +} diff --git a/packages/signature-v4-multi-region/package.json b/packages/signature-v4-multi-region/package.json index f4599a84ac341..bdf7b97f038c0 100644 --- a/packages/signature-v4-multi-region/package.json +++ b/packages/signature-v4-multi-region/package.json @@ -9,6 +9,7 @@ "build:types": "tsc -p tsconfig.types.json", "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4", "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo", + "extract:docs": "api-extractor run --local", "test": "jest" }, "main": "./dist-cjs/index.js", diff --git a/packages/signature-v4/api-extractor.json b/packages/signature-v4/api-extractor.json new file mode 100644 index 0000000000000..b03e22a16a06e --- /dev/null +++ b/packages/signature-v4/api-extractor.json @@ -0,0 +1,4 @@ +{ + "extends": "../../api-extractor.packages.json", + "mainEntryPointFilePath": "./dist-types/index.d.ts" +} diff --git a/packages/signature-v4/package.json b/packages/signature-v4/package.json index b767b331ff79e..14864b280b40d 100644 --- a/packages/signature-v4/package.json +++ b/packages/signature-v4/package.json @@ -13,6 +13,7 @@ "build:types": "tsc -p tsconfig.types.json", "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4", "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo", + "extract:docs": "api-extractor run --local", "test": "jest --coverage" }, "author": { diff --git a/packages/smithy-client/api-extractor.json b/packages/smithy-client/api-extractor.json new file mode 100644 index 0000000000000..b03e22a16a06e --- /dev/null +++ b/packages/smithy-client/api-extractor.json @@ -0,0 +1,4 @@ +{ + "extends": "../../api-extractor.packages.json", + "mainEntryPointFilePath": "./dist-types/index.d.ts" +} diff --git a/packages/smithy-client/package.json b/packages/smithy-client/package.json index 9f21ef1d233de..366eb70ca1e6a 100644 --- a/packages/smithy-client/package.json +++ b/packages/smithy-client/package.json @@ -9,6 +9,7 @@ "build:types": "tsc -p tsconfig.types.json", "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4", "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo", + "extract:docs": "api-extractor run --local", "test": "jest --passWithNoTests" }, "main": "./dist-cjs/index.js", diff --git a/packages/token-providers/api-extractor.json b/packages/token-providers/api-extractor.json new file mode 100644 index 0000000000000..b03e22a16a06e --- /dev/null +++ b/packages/token-providers/api-extractor.json @@ -0,0 +1,4 @@ +{ + "extends": "../../api-extractor.packages.json", + "mainEntryPointFilePath": "./dist-types/index.d.ts" +} diff --git a/packages/token-providers/package.json b/packages/token-providers/package.json index ae5d2821328dd..f2691caa0c4ce 100644 --- a/packages/token-providers/package.json +++ b/packages/token-providers/package.json @@ -13,6 +13,7 @@ "build:types": "tsc -p tsconfig.types.json", "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4", "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo", + "extract:docs": "api-extractor run --local", "test": "jest" }, "keywords": [ diff --git a/packages/types/api-extractor.json b/packages/types/api-extractor.json new file mode 100644 index 0000000000000..b03e22a16a06e --- /dev/null +++ b/packages/types/api-extractor.json @@ -0,0 +1,4 @@ +{ + "extends": "../../api-extractor.packages.json", + "mainEntryPointFilePath": "./dist-types/index.d.ts" +} diff --git a/packages/types/package.json b/packages/types/package.json index 96609e3f5a84c..b1f5a1fdb44ff 100755 --- a/packages/types/package.json +++ b/packages/types/package.json @@ -13,6 +13,7 @@ "build:types": "tsc -p tsconfig.types.json", "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4", "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo", + "extract:docs": "api-extractor run --local", "test": "tsc -p tsconfig.test.json" }, "author": { diff --git a/packages/util-create-request/api-extractor.json b/packages/util-create-request/api-extractor.json new file mode 100644 index 0000000000000..b03e22a16a06e --- /dev/null +++ b/packages/util-create-request/api-extractor.json @@ -0,0 +1,4 @@ +{ + "extends": "../../api-extractor.packages.json", + "mainEntryPointFilePath": "./dist-types/index.d.ts" +} diff --git a/packages/util-create-request/package.json b/packages/util-create-request/package.json index a454ca8ac09c8..6153ad5ad5421 100644 --- a/packages/util-create-request/package.json +++ b/packages/util-create-request/package.json @@ -9,6 +9,7 @@ "build:types": "tsc -p tsconfig.types.json", "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4", "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo", + "extract:docs": "api-extractor run --local", "test": "jest" }, "main": "./dist-cjs/index.js", diff --git a/packages/util-dynamodb/api-extractor.json b/packages/util-dynamodb/api-extractor.json new file mode 100644 index 0000000000000..b03e22a16a06e --- /dev/null +++ b/packages/util-dynamodb/api-extractor.json @@ -0,0 +1,4 @@ +{ + "extends": "../../api-extractor.packages.json", + "mainEntryPointFilePath": "./dist-types/index.d.ts" +} diff --git a/packages/util-dynamodb/package.json b/packages/util-dynamodb/package.json index 4c1bab4f822f9..2998af8e0c1aa 100644 --- a/packages/util-dynamodb/package.json +++ b/packages/util-dynamodb/package.json @@ -9,6 +9,7 @@ "build:types": "tsc -p tsconfig.types.json", "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4", "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo", + "extract:docs": "api-extractor run --local", "test": "jest" }, "main": "./dist-cjs/index.js", diff --git a/packages/util-retry/api-extractor.json b/packages/util-retry/api-extractor.json new file mode 100644 index 0000000000000..b03e22a16a06e --- /dev/null +++ b/packages/util-retry/api-extractor.json @@ -0,0 +1,4 @@ +{ + "extends": "../../api-extractor.packages.json", + "mainEntryPointFilePath": "./dist-types/index.d.ts" +} diff --git a/packages/util-retry/package.json b/packages/util-retry/package.json index ed11d48cf10ff..0f39cf4e40288 100644 --- a/packages/util-retry/package.json +++ b/packages/util-retry/package.json @@ -12,6 +12,7 @@ "build:types": "tsc -p tsconfig.types.json", "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4", "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo", + "extract:docs": "api-extractor run --local", "test": "jest" }, "keywords": [ diff --git a/packages/xhr-http-handler/api-extractor.json b/packages/xhr-http-handler/api-extractor.json new file mode 100644 index 0000000000000..b03e22a16a06e --- /dev/null +++ b/packages/xhr-http-handler/api-extractor.json @@ -0,0 +1,4 @@ +{ + "extends": "../../api-extractor.packages.json", + "mainEntryPointFilePath": "./dist-types/index.d.ts" +} diff --git a/packages/xhr-http-handler/package.json b/packages/xhr-http-handler/package.json index c820629ea256e..fd3d724bb1099 100644 --- a/packages/xhr-http-handler/package.json +++ b/packages/xhr-http-handler/package.json @@ -10,6 +10,7 @@ "build:types": "tsc -p tsconfig.types.json", "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4", "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo", + "extract:docs": "api-extractor run --local", "test": "jest --coverage" }, "author": "AWS SDK for JavaScript Team (https://aws.amazon.com/javascript/)", From 02bfdcf1cc40e4f4454615c4305cf2da7186e989 Mon Sep 17 00:00:00 2001 From: Michael Young Date: Tue, 23 May 2023 12:56:45 +0000 Subject: [PATCH 2/2] docs(abort-controller): add api-extractor to abort-controller --- packages/abort-controller/api-extractor.json | 4 ++++ packages/abort-controller/package.json | 1 + 2 files changed, 5 insertions(+) create mode 100644 packages/abort-controller/api-extractor.json diff --git a/packages/abort-controller/api-extractor.json b/packages/abort-controller/api-extractor.json new file mode 100644 index 0000000000000..b03e22a16a06e --- /dev/null +++ b/packages/abort-controller/api-extractor.json @@ -0,0 +1,4 @@ +{ + "extends": "../../api-extractor.packages.json", + "mainEntryPointFilePath": "./dist-types/index.d.ts" +} diff --git a/packages/abort-controller/package.json b/packages/abort-controller/package.json index 810fb21117fdf..82d0c9c534b67 100644 --- a/packages/abort-controller/package.json +++ b/packages/abort-controller/package.json @@ -13,6 +13,7 @@ "build:types": "tsc -p tsconfig.types.json", "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4", "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo", + "extract:docs": "api-extractor run --local", "test": "jest" }, "author": {