@rushstack/rush-amazon-s3-build-cache-plugin 0.0.0 → 5.57.0-dev.1

package/CHANGELOG.json

@@ -0,0 +1,11 @@
+{
+  "name": "@rushstack/rush-amazon-s3-build-cache-plugin",
+  "entries": [
+    {
+      "version": "0.0.1",
+      "tag": "@rushstack/rush-amazon-s3-build-cache-plugin_v0.0.1",
+      "date": "Thu, 11 Nov 2021 16:07:47 GMT",
+      "comments": {}
+    }
+  ]
+}

package/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Change Log - @rushstack/rush-amazon-s3-build-cache-plugin
+
+This log was last generated on Thu, 11 Nov 2021 16:07:47 GMT and should not be manually modified.
+
+## 0.0.1
+Thu, 11 Nov 2021 16:07:47 GMT
+
+_Initial release_
+

package/LICENSE

@@ -0,0 +1,24 @@
+@rushstack/rush-amazon-s3-build-cache-plugin
+
+Copyright (c) Microsoft Corporation. All rights reserved.
+
+MIT License
+
+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.

package/README.md

@@ -0,0 +1,9 @@
+# @rushstack/rush-amazon-s3-build-cache-plugin
+
+This is a Rush plugin for using Amazon S3 as cloud build cache provider during the "build" and "rebuild" command.
+
+## Links
+
+- [CHANGELOG.md](
+  https://github.com/microsoft/rushstack/blob/master/rush-plugins/rush-amazon-s3-build-cache-plugin/CHANGELOG.md) - Find
+  out what's new in the latest version

package/dist/rush-amazon-s3-build-cache-plugin.d.ts

@@ -0,0 +1,14 @@
+import type { IRushPlugin } from '@rushstack/rush-sdk';
+import type { RushConfiguration } from '@rushstack/rush-sdk';
+import type { RushSession } from '@rushstack/rush-sdk';
+
+/**
+ * @public
+ */
+declare class RushAmazonS3BuildCachePlugin implements IRushPlugin {
+    pluginName: string;
+    apply(rushSession: RushSession, rushConfig: RushConfiguration): void;
+}
+export default RushAmazonS3BuildCachePlugin;
+
+export { }

package/lib/AmazonS3BuildCacheProvider.d.ts

@@ -0,0 +1,28 @@
+/// <reference types="node" />
+import { ITerminal } from '@rushstack/node-core-library';
+import { ICloudBuildCacheProvider, RushSession } from '@rushstack/rush-sdk';
+export interface IAmazonS3BuildCacheProviderOptions {
+    s3Bucket: string;
+    s3Region: string;
+    s3Prefix?: string;
+    isCacheWriteAllowed: boolean;
+}
+export declare class AmazonS3BuildCacheProvider implements ICloudBuildCacheProvider {
+    private readonly _options;
+    private readonly _s3Prefix;
+    private readonly _environmentCredential;
+    private readonly _isCacheWriteAllowedByConfiguration;
+    private __credentialCacheId;
+    private _rushSession;
+    get isCacheWriteAllowed(): boolean;
+    private __s3Client;
+    constructor(options: IAmazonS3BuildCacheProviderOptions, rushSession: RushSession);
+    private get _credentialCacheId();
+    private _getS3ClientAsync;
+    tryGetCacheEntryBufferByIdAsync(terminal: ITerminal, cacheId: string): Promise<Buffer | undefined>;
+    trySetCacheEntryBufferAsync(terminal: ITerminal, cacheId: string, objectBuffer: Buffer): Promise<boolean>;
+    updateCachedCredentialAsync(terminal: ITerminal, credential: string): Promise<void>;
+    updateCachedCredentialInteractiveAsync(terminal: ITerminal): Promise<void>;
+    deleteCachedCredentialsAsync(terminal: ITerminal): Promise<void>;
+}
+//# sourceMappingURL=AmazonS3BuildCacheProvider.d.ts.map

package/lib/AmazonS3BuildCacheProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AmazonS3BuildCacheProvider.d.ts","sourceRoot":"","sources":["../src/AmazonS3BuildCacheProvider.ts"],"names":[],"mappings":";AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AACzD,OAAO,EACL,wBAAwB,EAGxB,WAAW,EAIZ,MAAM,qBAAqB,CAAC;AAK7B,MAAM,WAAW,kCAAkC;IACjD,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,mBAAmB,EAAE,OAAO,CAAC;CAC9B;AAED,qBAAa,0BAA2B,YAAW,wBAAwB;IACzE,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAqC;IAC9D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAqB;IAC/C,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAAqB;IAC5D,OAAO,CAAC,QAAQ,CAAC,mCAAmC,CAAU;IAC9D,OAAO,CAAC,mBAAmB,CAAqB;IAChD,OAAO,CAAC,YAAY,CAAc;IAElC,IAAW,mBAAmB,IAAI,OAAO,CAExC;IAED,OAAO,CAAC,UAAU,CAA6B;gBAE5B,OAAO,EAAE,kCAAkC,EAAE,WAAW,EAAE,WAAW;IAQxF,OAAO,KAAK,kBAAkB,GAY7B;YAEa,iBAAiB;IA2ClB,+BAA+B,CAC1C,QAAQ,EAAE,SAAS,EACnB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAUjB,2BAA2B,CACtC,QAAQ,EAAE,SAAS,EACnB,OAAO,EAAE,MAAM,EACf,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,OAAO,CAAC;IAgBN,2BAA2B,CAAC,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAYnF,sCAAsC,CAAC,QAAQ,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAS1E,4BAA4B,CAAC,QAAQ,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;CAW9E"}

package/lib/AmazonS3BuildCacheProvider.js

@@ -0,0 +1,112 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AmazonS3BuildCacheProvider = void 0;
+const rush_sdk_1 = require("@rushstack/rush-sdk");
+const AmazonS3Client_1 = require("./AmazonS3Client");
+const WebClient_1 = require("./WebClient");
+class AmazonS3BuildCacheProvider {
+    constructor(options, rushSession) {
+        this._rushSession = rushSession;
+        this._options = options;
+        this._s3Prefix = options.s3Prefix;
+        this._environmentCredential = rush_sdk_1.EnvironmentConfiguration.buildCacheCredential;
+        this._isCacheWriteAllowedByConfiguration = options.isCacheWriteAllowed;
+    }
+    get isCacheWriteAllowed() {
+        var _a;
+        return (_a = rush_sdk_1.EnvironmentConfiguration.buildCacheWriteAllowed) !== null && _a !== void 0 ? _a : this._isCacheWriteAllowedByConfiguration;
+    }
+    get _credentialCacheId() {
+        if (!this.__credentialCacheId) {
+            const cacheIdParts = ['aws-s3', this._options.s3Region, this._options.s3Bucket];
+            if (this._isCacheWriteAllowedByConfiguration) {
+                cacheIdParts.push('cacheWriteAllowed');
+            }
+            this.__credentialCacheId = cacheIdParts.join('|');
+        }
+        return this.__credentialCacheId;
+    }
+    async _getS3ClientAsync() {
+        var _a;
+        if (!this.__s3Client) {
+            let credentials = AmazonS3Client_1.AmazonS3Client.tryDeserializeCredentials(this._environmentCredential);
+            if (!credentials) {
+                let cacheEntry;
+                await rush_sdk_1.CredentialCache.usingAsync({
+                    supportEditing: false
+                }, (credentialsCache) => {
+                    cacheEntry = credentialsCache.tryGetCacheEntry(this._credentialCacheId);
+                });
+                if (cacheEntry) {
+                    const expirationTime = (_a = cacheEntry.expires) === null || _a === void 0 ? void 0 : _a.getTime();
+                    if (expirationTime && expirationTime < Date.now()) {
+                        throw new Error('Cached Amazon S3 credentials have expired. ' +
+                            `Update the credentials by running "rush ${rush_sdk_1.RushConstants.updateCloudCredentialsCommandName}".`);
+                    }
+                    else {
+                        credentials = AmazonS3Client_1.AmazonS3Client.tryDeserializeCredentials(cacheEntry === null || cacheEntry === void 0 ? void 0 : cacheEntry.credential);
+                    }
+                }
+                else if (this._isCacheWriteAllowedByConfiguration) {
+                    throw new Error("An Amazon S3 credential hasn't been provided, or has expired. " +
+                        `Update the credentials by running "rush ${rush_sdk_1.RushConstants.updateCloudCredentialsCommandName}", ` +
+                        `or provide an <AccessKeyId>:<SecretAccessKey> pair in the ` +
+                        `${rush_sdk_1.EnvironmentVariableNames.RUSH_BUILD_CACHE_CREDENTIAL} environment variable`);
+                }
+            }
+            this.__s3Client = new AmazonS3Client_1.AmazonS3Client(credentials, this._options, new WebClient_1.WebClient());
+        }
+        return this.__s3Client;
+    }
+    async tryGetCacheEntryBufferByIdAsync(terminal, cacheId) {
+        try {
+            const client = await this._getS3ClientAsync();
+            return await client.getObjectAsync(this._s3Prefix ? `${this._s3Prefix}/${cacheId}` : cacheId);
+        }
+        catch (e) {
+            terminal.writeWarningLine(`Error getting cache entry from S3: ${e}`);
+            return undefined;
+        }
+    }
+    async trySetCacheEntryBufferAsync(terminal, cacheId, objectBuffer) {
+        if (!this.isCacheWriteAllowed) {
+            terminal.writeErrorLine('Writing to S3 cache is not allowed in the current configuration.');
+            return false;
+        }
+        try {
+            const client = await this._getS3ClientAsync();
+            await client.uploadObjectAsync(this._s3Prefix ? `${this._s3Prefix}/${cacheId}` : cacheId, objectBuffer);
+            return true;
+        }
+        catch (e) {
+            terminal.writeWarningLine(`Error uploading cache entry to S3: ${e}`);
+            return false;
+        }
+    }
+    async updateCachedCredentialAsync(terminal, credential) {
+        await rush_sdk_1.CredentialCache.usingAsync({
+            supportEditing: true
+        }, async (credentialsCache) => {
+            credentialsCache.setCacheEntry(this._credentialCacheId, credential);
+            await credentialsCache.saveIfModifiedAsync();
+        });
+    }
+    async updateCachedCredentialInteractiveAsync(terminal) {
+        throw new Error('The interactive cloud credentials flow is not supported for Amazon S3.\n' +
+            'Provide your credentials to rush using the --credential flag instead. Credentials must be ' +
+            'in the form of <ACCESS KEY ID>:<SECRET ACCESS KEY> or ' +
+            '<ACCESS KEY ID>:<SECRET ACCESS KEY>:<SESSION TOKEN>.');
+    }
+    async deleteCachedCredentialsAsync(terminal) {
+        await rush_sdk_1.CredentialCache.usingAsync({
+            supportEditing: true
+        }, async (credentialsCache) => {
+            credentialsCache.deleteCacheEntry(this._credentialCacheId);
+            await credentialsCache.saveIfModifiedAsync();
+        });
+    }
+}
+exports.AmazonS3BuildCacheProvider = AmazonS3BuildCacheProvider;
+//# sourceMappingURL=AmazonS3BuildCacheProvider.js.map

package/lib/AmazonS3BuildCacheProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AmazonS3BuildCacheProvider.js","sourceRoot":"","sources":["../src/AmazonS3BuildCacheProvider.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAG3D,kDAQ6B;AAE7B,qDAAwE;AACxE,2CAAwC;AASxC,MAAa,0BAA0B;IAcrC,YAAmB,OAA2C,EAAE,WAAwB;QACtF,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAChC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC;QAClC,IAAI,CAAC,sBAAsB,GAAG,mCAAwB,CAAC,oBAAoB,CAAC;QAC5E,IAAI,CAAC,mCAAmC,GAAG,OAAO,CAAC,mBAAmB,CAAC;IACzE,CAAC;IAZD,IAAW,mBAAmB;;QAC5B,OAAO,MAAA,mCAAwB,CAAC,sBAAsB,mCAAI,IAAI,CAAC,mCAAmC,CAAC;IACrG,CAAC;IAYD,IAAY,kBAAkB;QAC5B,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE;YAC7B,MAAM,YAAY,GAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YAE1F,IAAI,IAAI,CAAC,mCAAmC,EAAE;gBAC5C,YAAY,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;aACxC;YAED,IAAI,CAAC,mBAAmB,GAAG,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACnD;QAED,OAAO,IAAI,CAAC,mBAAmB,CAAC;IAClC,CAAC;IAEO,KAAK,CAAC,iBAAiB;;QAC7B,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YACpB,IAAI,WAAW,GAAqC,+BAAc,CAAC,yBAAyB,CAC1F,IAAI,CAAC,sBAAsB,CAC5B,CAAC;YAEF,IAAI,CAAC,WAAW,EAAE;gBAChB,IAAI,UAA6C,CAAC;gBAClD,MAAM,0BAAe,CAAC,UAAU,CAC9B;oBACE,cAAc,EAAE,KAAK;iBACtB,EACD,CAAC,gBAAiC,EAAE,EAAE;oBACpC,UAAU,GAAG,gBAAgB,CAAC,gBAAgB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;gBAC1E,CAAC,CACF,CAAC;gBAEF,IAAI,UAAU,EAAE;oBACd,MAAM,cAAc,GAAuB,MAAA,UAAU,CAAC,OAAO,0CAAE,OAAO,EAAE,CAAC;oBACzE,IAAI,cAAc,IAAI,cAAc,GAAG,IAAI,CAAC,GAAG,EAAE,EAAE;wBACjD,MAAM,IAAI,KAAK,CACb,6CAA6C;4BAC3C,2CAA2C,wBAAa,CAAC,iCAAiC,IAAI,CACjG,CAAC;qBACH;yBAAM;wBACL,WAAW,GAAG,+BAAc,CAAC,yBAAyB,CAAC,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,UAAU,CAAC,CAAC;qBAChF;iBACF;qBAAM,IAAI,IAAI,CAAC,mCAAmC,EAAE;oBACnD,MAAM,IAAI,KAAK,CACb,gEAAgE;wBAC9D,2CAA2C,wBAAa,CAAC,iCAAiC,KAAK;wBAC/F,4DAA4D;wBAC5D,GAAG,mCAAwB,CAAC,2BAA2B,uBAAuB,CACjF,CAAC;iBACH;aACF;YAED,IAAI,CAAC,UAAU,GAAG,IAAI,+BAAc,CAAC,WAAW,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,qBAAS,EAAE,CAAC,CAAC;SACnF;QAED,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAEM,KAAK,CAAC,+BAA+B,CAC1C,QAAmB,EACnB,OAAe;QAEf,IAAI;YACF,MAAM,MAAM,GAAmB,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC9D,OAAO,MAAM,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,SAAS,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;SAC/F;QAAC,OAAO,CAAC,EAAE;YACV,QAAQ,CAAC,gBAAgB,CAAC,sCAAsC,CAAC,EAAE,CAAC,CAAC;YACrE,OAAO,SAAS,CAAC;SAClB;IACH,CAAC;IAEM,KAAK,CAAC,2BAA2B,CACtC,QAAmB,EACnB,OAAe,EACf,YAAoB;QAEpB,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE;YAC7B,QAAQ,CAAC,cAAc,CAAC,kEAAkE,CAAC,CAAC;YAC5F,OAAO,KAAK,CAAC;SACd;QAED,IAAI;YACF,MAAM,MAAM,GAAmB,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC9D,MAAM,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,SAAS,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;YACxG,OAAO,IAAI,CAAC;SACb;QAAC,OAAO,CAAC,EAAE;YACV,QAAQ,CAAC,gBAAgB,CAAC,sCAAsC,CAAC,EAAE,CAAC,CAAC;YACrE,OAAO,KAAK,CAAC;SACd;IACH,CAAC;IAEM,KAAK,CAAC,2BAA2B,CAAC,QAAmB,EAAE,UAAkB;QAC9E,MAAM,0BAAe,CAAC,UAAU,CAC9B;YACE,cAAc,EAAE,IAAI;SACrB,EACD,KAAK,EAAE,gBAAiC,EAAE,EAAE;YAC1C,gBAAgB,CAAC,aAAa,CAAC,IAAI,CAAC,kBAAkB,EAAE,UAAU,CAAC,CAAC;YACpE,MAAM,gBAAgB,CAAC,mBAAmB,EAAE,CAAC;QAC/C,CAAC,CACF,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,sCAAsC,CAAC,QAAmB;QACrE,MAAM,IAAI,KAAK,CACb,0EAA0E;YACxE,4FAA4F;YAC5F,wDAAwD;YACxD,sDAAsD,CACzD,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,4BAA4B,CAAC,QAAmB;QAC3D,MAAM,0BAAe,CAAC,UAAU,CAC9B;YACE,cAAc,EAAE,IAAI;SACrB,EACD,KAAK,EAAE,gBAAiC,EAAE,EAAE;YAC1C,gBAAgB,CAAC,gBAAgB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;YAC3D,MAAM,gBAAgB,CAAC,mBAAmB,EAAE,CAAC;QAC/C,CAAC,CACF,CAAC;IACJ,CAAC;CACF;AAhJD,gEAgJC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\r\n// See LICENSE in the project root for license information.\r\n\r\nimport { ITerminal } from '@rushstack/node-core-library';\r\nimport {\r\n  ICloudBuildCacheProvider,\r\n  ICredentialCacheEntry,\r\n  CredentialCache,\r\n  RushSession,\r\n  RushConstants,\r\n  EnvironmentVariableNames,\r\n  EnvironmentConfiguration\r\n} from '@rushstack/rush-sdk';\r\n\r\nimport { AmazonS3Client, IAmazonS3Credentials } from './AmazonS3Client';\r\nimport { WebClient } from './WebClient';\r\n\r\nexport interface IAmazonS3BuildCacheProviderOptions {\r\n  s3Bucket: string;\r\n  s3Region: string;\r\n  s3Prefix?: string;\r\n  isCacheWriteAllowed: boolean;\r\n}\r\n\r\nexport class AmazonS3BuildCacheProvider implements ICloudBuildCacheProvider {\r\n  private readonly _options: IAmazonS3BuildCacheProviderOptions;\r\n  private readonly _s3Prefix: string | undefined;\r\n  private readonly _environmentCredential: string | undefined;\r\n  private readonly _isCacheWriteAllowedByConfiguration: boolean;\r\n  private __credentialCacheId: string | undefined;\r\n  private _rushSession: RushSession;\r\n\r\n  public get isCacheWriteAllowed(): boolean {\r\n    return EnvironmentConfiguration.buildCacheWriteAllowed ?? this._isCacheWriteAllowedByConfiguration;\r\n  }\r\n\r\n  private __s3Client: AmazonS3Client | undefined;\r\n\r\n  public constructor(options: IAmazonS3BuildCacheProviderOptions, rushSession: RushSession) {\r\n    this._rushSession = rushSession;\r\n    this._options = options;\r\n    this._s3Prefix = options.s3Prefix;\r\n    this._environmentCredential = EnvironmentConfiguration.buildCacheCredential;\r\n    this._isCacheWriteAllowedByConfiguration = options.isCacheWriteAllowed;\r\n  }\r\n\r\n  private get _credentialCacheId(): string {\r\n    if (!this.__credentialCacheId) {\r\n      const cacheIdParts: string[] = ['aws-s3', this._options.s3Region, this._options.s3Bucket];\r\n\r\n      if (this._isCacheWriteAllowedByConfiguration) {\r\n        cacheIdParts.push('cacheWriteAllowed');\r\n      }\r\n\r\n      this.__credentialCacheId = cacheIdParts.join('|');\r\n    }\r\n\r\n    return this.__credentialCacheId;\r\n  }\r\n\r\n  private async _getS3ClientAsync(): Promise<AmazonS3Client> {\r\n    if (!this.__s3Client) {\r\n      let credentials: IAmazonS3Credentials | undefined = AmazonS3Client.tryDeserializeCredentials(\r\n        this._environmentCredential\r\n      );\r\n\r\n      if (!credentials) {\r\n        let cacheEntry: ICredentialCacheEntry | undefined;\r\n        await CredentialCache.usingAsync(\r\n          {\r\n            supportEditing: false\r\n          },\r\n          (credentialsCache: CredentialCache) => {\r\n            cacheEntry = credentialsCache.tryGetCacheEntry(this._credentialCacheId);\r\n          }\r\n        );\r\n\r\n        if (cacheEntry) {\r\n          const expirationTime: number | undefined = cacheEntry.expires?.getTime();\r\n          if (expirationTime && expirationTime < Date.now()) {\r\n            throw new Error(\r\n              'Cached Amazon S3 credentials have expired. ' +\r\n                `Update the credentials by running \"rush ${RushConstants.updateCloudCredentialsCommandName}\".`\r\n            );\r\n          } else {\r\n            credentials = AmazonS3Client.tryDeserializeCredentials(cacheEntry?.credential);\r\n          }\r\n        } else if (this._isCacheWriteAllowedByConfiguration) {\r\n          throw new Error(\r\n            \"An Amazon S3 credential hasn't been provided, or has expired. \" +\r\n              `Update the credentials by running \"rush ${RushConstants.updateCloudCredentialsCommandName}\", ` +\r\n              `or provide an <AccessKeyId>:<SecretAccessKey> pair in the ` +\r\n              `${EnvironmentVariableNames.RUSH_BUILD_CACHE_CREDENTIAL} environment variable`\r\n          );\r\n        }\r\n      }\r\n\r\n      this.__s3Client = new AmazonS3Client(credentials, this._options, new WebClient());\r\n    }\r\n\r\n    return this.__s3Client;\r\n  }\r\n\r\n  public async tryGetCacheEntryBufferByIdAsync(\r\n    terminal: ITerminal,\r\n    cacheId: string\r\n  ): Promise<Buffer | undefined> {\r\n    try {\r\n      const client: AmazonS3Client = await this._getS3ClientAsync();\r\n      return await client.getObjectAsync(this._s3Prefix ? `${this._s3Prefix}/${cacheId}` : cacheId);\r\n    } catch (e) {\r\n      terminal.writeWarningLine(`Error getting cache entry from S3: ${e}`);\r\n      return undefined;\r\n    }\r\n  }\r\n\r\n  public async trySetCacheEntryBufferAsync(\r\n    terminal: ITerminal,\r\n    cacheId: string,\r\n    objectBuffer: Buffer\r\n  ): Promise<boolean> {\r\n    if (!this.isCacheWriteAllowed) {\r\n      terminal.writeErrorLine('Writing to S3 cache is not allowed in the current configuration.');\r\n      return false;\r\n    }\r\n\r\n    try {\r\n      const client: AmazonS3Client = await this._getS3ClientAsync();\r\n      await client.uploadObjectAsync(this._s3Prefix ? `${this._s3Prefix}/${cacheId}` : cacheId, objectBuffer);\r\n      return true;\r\n    } catch (e) {\r\n      terminal.writeWarningLine(`Error uploading cache entry to S3: ${e}`);\r\n      return false;\r\n    }\r\n  }\r\n\r\n  public async updateCachedCredentialAsync(terminal: ITerminal, credential: string): Promise<void> {\r\n    await CredentialCache.usingAsync(\r\n      {\r\n        supportEditing: true\r\n      },\r\n      async (credentialsCache: CredentialCache) => {\r\n        credentialsCache.setCacheEntry(this._credentialCacheId, credential);\r\n        await credentialsCache.saveIfModifiedAsync();\r\n      }\r\n    );\r\n  }\r\n\r\n  public async updateCachedCredentialInteractiveAsync(terminal: ITerminal): Promise<void> {\r\n    throw new Error(\r\n      'The interactive cloud credentials flow is not supported for Amazon S3.\\n' +\r\n        'Provide your credentials to rush using the --credential flag instead. Credentials must be ' +\r\n        'in the form of <ACCESS KEY ID>:<SECRET ACCESS KEY> or ' +\r\n        '<ACCESS KEY ID>:<SECRET ACCESS KEY>:<SESSION TOKEN>.'\r\n    );\r\n  }\r\n\r\n  public async deleteCachedCredentialsAsync(terminal: ITerminal): Promise<void> {\r\n    await CredentialCache.usingAsync(\r\n      {\r\n        supportEditing: true\r\n      },\r\n      async (credentialsCache: CredentialCache) => {\r\n        credentialsCache.deleteCacheEntry(this._credentialCacheId);\r\n        await credentialsCache.saveIfModifiedAsync();\r\n      }\r\n    );\r\n  }\r\n}\r\n"]}

package/lib/AmazonS3Client.d.ts

@@ -0,0 +1,31 @@
+/// <reference types="node" />
+import { IAmazonS3BuildCacheProviderOptions } from './AmazonS3BuildCacheProvider';
+import { WebClient } from './WebClient';
+export interface IAmazonS3Credentials {
+    accessKeyId: string;
+    secretAccessKey: string;
+    sessionToken: string | undefined;
+}
+export declare class AmazonS3Client {
+    private readonly _credentials;
+    private readonly _s3Bucket;
+    private readonly _s3Region;
+    private readonly _webClient;
+    constructor(credentials: IAmazonS3Credentials | undefined, options: IAmazonS3BuildCacheProviderOptions, webClient: WebClient);
+    static tryDeserializeCredentials(credentialString: string | undefined): IAmazonS3Credentials | undefined;
+    getObjectAsync(objectName: string): Promise<Buffer | undefined>;
+    uploadObjectAsync(objectName: string, objectBuffer: Buffer): Promise<void>;
+    private _makeRequestAsync;
+    _getSha256Hmac(key: string | Buffer, data: string): Buffer;
+    _getSha256Hmac(key: string | Buffer, data: string, encoding: 'hex'): string;
+    private _getSha256;
+    private _getIsoDateString;
+    private _throwS3Error;
+    private _getHost;
+    /**
+     * Validates a S3 bucket name.
+     * {@link https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-s3-bucket-naming-requirements.html}
+     */
+    private _validateBucketName;
+}
+//# sourceMappingURL=AmazonS3Client.d.ts.map

package/lib/AmazonS3Client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AmazonS3Client.d.ts","sourceRoot":"","sources":["../src/AmazonS3Client.ts"],"names":[],"mappings":";AAMA,OAAO,EAAE,kCAAkC,EAAE,MAAM,8BAA8B,CAAC;AAClF,OAAO,EAAsC,SAAS,EAAE,MAAM,aAAa,CAAC;AAS5E,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,MAAM,CAAC;IACxB,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;CAClC;AAOD,qBAAa,cAAc;IACzB,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAmC;IAChE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IAEnC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAY;gBAGrC,WAAW,EAAE,oBAAoB,GAAG,SAAS,EAC7C,OAAO,EAAE,kCAAkC,EAC3C,SAAS,EAAE,SAAS;WAYR,yBAAyB,CACrC,gBAAgB,EAAE,MAAM,GAAG,SAAS,GACnC,oBAAoB,GAAG,SAAS;IAiBtB,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAa/D,iBAAiB,CAAC,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;YAWzE,iBAAiB;IAkGxB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;IAC1D,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,GAAG,MAAM;IAWlF,OAAO,CAAC,UAAU;IAWlB,OAAO,CAAC,iBAAiB;IAazB,OAAO,CAAC,aAAa;IAIrB,OAAO,CAAC,QAAQ;IAQhB;;;OAGG;IACH,OAAO,CAAC,mBAAmB;CAsC5B"}

package/lib/AmazonS3Client.js

@@ -0,0 +1,226 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AmazonS3Client = void 0;
+const crypto = __importStar(require("crypto"));
+const fetch = __importStar(require("node-fetch"));
+const CONTENT_HASH_HEADER_NAME = 'x-amz-content-sha256';
+const DATE_HEADER_NAME = 'x-amz-date';
+const HOST_HEADER_NAME = 'host';
+const SECURITY_TOKEN_HEADER_NAME = 'x-amz-security-token';
+const DEFAULT_S3_REGION = 'us-east-1';
+class AmazonS3Client {
+    constructor(credentials, options, webClient) {
+        this._credentials = credentials;
+        this._validateBucketName(options.s3Bucket);
+        this._s3Bucket = options.s3Bucket;
+        this._s3Region = options.s3Region;
+        this._webClient = webClient;
+    }
+    static tryDeserializeCredentials(credentialString) {
+        if (!credentialString) {
+            return undefined;
+        }
+        const fields = credentialString.split(':');
+        if (fields.length < 2 || fields.length > 3) {
+            throw new Error('Amazon S3 credential is in an unexpected format.');
+        }
+        return {
+            accessKeyId: fields[0],
+            secretAccessKey: fields[1],
+            sessionToken: fields[2]
+        };
+    }
+    async getObjectAsync(objectName) {
+        const response = await this._makeRequestAsync('GET', objectName);
+        if (response.ok) {
+            return await response.buffer();
+        }
+        else if (response.status === 404) {
+            return undefined;
+        }
+        else if (response.status === 403 && !this._credentials) {
+            return undefined;
+        }
+        else {
+            this._throwS3Error(response);
+        }
+    }
+    async uploadObjectAsync(objectName, objectBuffer) {
+        if (!this._credentials) {
+            throw new Error('Credentials are required to upload objects to S3.');
+        }
+        const response = await this._makeRequestAsync('PUT', objectName, objectBuffer);
+        if (!response.ok) {
+            this._throwS3Error(response);
+        }
+    }
+    async _makeRequestAsync(verb, objectName, body) {
+        const isoDateString = this._getIsoDateString();
+        const bodyHash = this._getSha256(body);
+        const host = this._getHost();
+        const headers = new fetch.Headers();
+        headers.set(DATE_HEADER_NAME, isoDateString.dateTime);
+        headers.set(CONTENT_HASH_HEADER_NAME, bodyHash);
+        if (this._credentials) {
+            // Compute the authorization header. See https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-header-based-auth.html
+            const signedHeaderNames = [HOST_HEADER_NAME, CONTENT_HASH_HEADER_NAME, DATE_HEADER_NAME];
+            const canonicalHeaders = [
+                `${HOST_HEADER_NAME}:${host}`,
+                `${CONTENT_HASH_HEADER_NAME}:${bodyHash}`,
+                `${DATE_HEADER_NAME}:${isoDateString.dateTime}`
+            ];
+            // Handle signing with temporary credentials (via sts:assume-role)
+            if (this._credentials.sessionToken) {
+                signedHeaderNames.push(SECURITY_TOKEN_HEADER_NAME);
+                canonicalHeaders.push(`${SECURITY_TOKEN_HEADER_NAME}:${this._credentials.sessionToken}`);
+            }
+            const signedHeaderNamesString = signedHeaderNames.join(';');
+            // The canonical request looks like this:
+            //  GET
+            // /test.txt
+            //
+            // host:examplebucket.s3.amazonaws.com
+            // range:bytes=0-9
+            // x-amz-content-sha256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
+            // x-amz-date:20130524T000000Z
+            //
+            // host;range;x-amz-content-sha256;x-amz-date
+            // e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
+            const canonicalRequest = [
+                verb,
+                `/${objectName}`,
+                '',
+                ...canonicalHeaders,
+                '',
+                signedHeaderNamesString,
+                bodyHash
+            ].join('\n');
+            const canonicalRequestHash = this._getSha256(canonicalRequest);
+            const scope = `${isoDateString.date}/${this._s3Region}/s3/aws4_request`;
+            // The string to sign looks like this:
+            // AWS4-HMAC-SHA256
+            // 20130524T423589Z
+            // 20130524/us-east-1/s3/aws4_request
+            // 7344ae5b7ee6c3e7e6b0fe0640412a37625d1fbfff95c48bbb2dc43964946972
+            const stringToSign = [
+                'AWS4-HMAC-SHA256',
+                isoDateString.dateTime,
+                scope,
+                canonicalRequestHash
+            ].join('\n');
+            const dateKey = this._getSha256Hmac(`AWS4${this._credentials.secretAccessKey}`, isoDateString.date);
+            const dateRegionKey = this._getSha256Hmac(dateKey, this._s3Region);
+            const dateRegionServiceKey = this._getSha256Hmac(dateRegionKey, 's3');
+            const signingKey = this._getSha256Hmac(dateRegionServiceKey, 'aws4_request');
+            const signature = this._getSha256Hmac(signingKey, stringToSign, 'hex');
+            const authorizationHeader = `AWS4-HMAC-SHA256 Credential=${this._credentials.accessKeyId}/${scope},SignedHeaders=${signedHeaderNamesString},Signature=${signature}`;
+            headers.set('Authorization', authorizationHeader);
+            if (this._credentials.sessionToken) {
+                // Handle signing with temporary credentials (via sts:assume-role)
+                headers.set('X-Amz-Security-Token', this._credentials.sessionToken);
+            }
+        }
+        const webFetchOptions = {
+            verb,
+            headers
+        };
+        if (verb === 'PUT') {
+            webFetchOptions.body = body;
+        }
+        const response = await this._webClient.fetchAsync(`https://${host}/${objectName}`, webFetchOptions);
+        return response;
+    }
+    _getSha256Hmac(key, data, encoding) {
+        const hash = crypto.createHmac('sha256', key);
+        hash.update(data);
+        if (encoding) {
+            return hash.digest(encoding);
+        }
+        else {
+            return hash.digest();
+        }
+    }
+    _getSha256(data) {
+        if (data) {
+            const hash = crypto.createHash('sha256');
+            hash.update(data);
+            return hash.digest('hex');
+        }
+        else {
+            // This is the null SHA256 hash
+            return 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855';
+        }
+    }
+    _getIsoDateString(date = new Date()) {
+        let dateString = date.toISOString();
+        dateString = dateString.replace(/[-:]/g, ''); // Remove separator characters
+        dateString = dateString.substring(0, 15); // Drop milliseconds
+        // dateTime is an ISO8601 date. It looks like "20130524T423589"
+        // date is an ISO date. It looks like "20130524"
+        return {
+            dateTime: `${dateString}Z`,
+            date: dateString.substring(0, 8)
+        };
+    }
+    _throwS3Error(response) {
+        throw new Error(`Amazon S3 responded with status code ${response.status} (${response.statusText})`);
+    }
+    _getHost() {
+        if (this._s3Region === DEFAULT_S3_REGION) {
+            return `${this._s3Bucket}.s3.amazonaws.com`;
+        }
+        else {
+            return `${this._s3Bucket}.s3-${this._s3Region}.amazonaws.com`;
+        }
+    }
+    /**
+     * Validates a S3 bucket name.
+     * {@link https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-s3-bucket-naming-requirements.html}
+     */
+    _validateBucketName(s3BucketName) {
+        if (!s3BucketName) {
+            throw new Error('A S3 bucket name must be provided');
+        }
+        if (!s3BucketName.match(/^[a-z\d-.]{3,63}$/)) {
+            throw new Error(`The bucket name "${s3BucketName}" is invalid. A S3 bucket name must only contain lowercase ` +
+                'alphanumerical characters, dashes, and periods and must be between 3 and 63 characters long.');
+        }
+        if (!s3BucketName.match(/^[a-z\d]/)) {
+            throw new Error(`The bucket name "${s3BucketName}" is invalid. A S3 bucket name must start with a lowercase ` +
+                'alphanumerical character.');
+        }
+        if (s3BucketName.match(/-$/)) {
+            throw new Error(`The bucket name "${s3BucketName}" is invalid. A S3 bucket name must not end in a dash.`);
+        }
+        if (s3BucketName.match(/(\.\.)|(\.-)|(-\.)/)) {
+            throw new Error(`The bucket name "${s3BucketName}" is invalid. A S3 bucket name must not have consecutive periods or ` +
+                'dashes adjacent to periods.');
+        }
+        if (s3BucketName.match(/^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/)) {
+            throw new Error(`The bucket name "${s3BucketName}" is invalid. A S3 bucket name must not be formatted as an IP address.`);
+        }
+    }
+}
+exports.AmazonS3Client = AmazonS3Client;
+//# sourceMappingURL=AmazonS3Client.js.map

package/lib/AmazonS3Client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AmazonS3Client.js","sourceRoot":"","sources":["../src/AmazonS3Client.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;;;;;;;;;;;;;;;;;AAE3D,+CAAiC;AACjC,kDAAoC;AAKpC,MAAM,wBAAwB,GAA2B,sBAAsB,CAAC;AAChF,MAAM,gBAAgB,GAAiB,YAAY,CAAC;AACpD,MAAM,gBAAgB,GAAW,MAAM,CAAC;AACxC,MAAM,0BAA0B,GAA2B,sBAAsB,CAAC;AAElF,MAAM,iBAAiB,GAAgB,WAAW,CAAC;AAanD,MAAa,cAAc;IAOzB,YACE,WAA6C,EAC7C,OAA2C,EAC3C,SAAoB;QAEpB,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAEhC,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAE3C,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC;QAClC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC;QAElC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC9B,CAAC;IAEM,MAAM,CAAC,yBAAyB,CACrC,gBAAoC;QAEpC,IAAI,CAAC,gBAAgB,EAAE;YACrB,OAAO,SAAS,CAAC;SAClB;QAED,MAAM,MAAM,GAAa,gBAAgB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACrD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;YAC1C,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;SACrE;QAED,OAAO;YACL,WAAW,EAAE,MAAM,CAAC,CAAC,CAAC;YACtB,eAAe,EAAE,MAAM,CAAC,CAAC,CAAC;YAC1B,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC;SACxB,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,UAAkB;QAC5C,MAAM,QAAQ,GAAmB,MAAM,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QACjF,IAAI,QAAQ,CAAC,EAAE,EAAE;YACf,OAAO,MAAM,QAAQ,CAAC,MAAM,EAAE,CAAC;SAChC;aAAM,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE;YAClC,OAAO,SAAS,CAAC;SAClB;aAAM,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;YACxD,OAAO,SAAS,CAAC;SAClB;aAAM;YACL,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;SAC9B;IACH,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,UAAkB,EAAE,YAAoB;QACrE,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;SACtE;QAED,MAAM,QAAQ,GAAmB,MAAM,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC;QAC/F,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;YAChB,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;SAC9B;IACH,CAAC;IAEO,KAAK,CAAC,iBAAiB,CAC7B,IAAmB,EACnB,UAAkB,EAClB,IAAa;QAEb,MAAM,aAAa,GAAmB,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC/D,MAAM,QAAQ,GAAW,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAC/C,MAAM,IAAI,GAAW,IAAI,CAAC,QAAQ,EAAE,CAAC;QACrC,MAAM,OAAO,GAAkB,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;QACnD,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAC;QACtD,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,QAAQ,CAAC,CAAC;QAEhD,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,sHAAsH;YACtH,MAAM,iBAAiB,GAAa,CAAC,gBAAgB,EAAE,wBAAwB,EAAE,gBAAgB,CAAC,CAAC;YACnG,MAAM,gBAAgB,GAAa;gBACjC,GAAG,gBAAgB,IAAI,IAAI,EAAE;gBAC7B,GAAG,wBAAwB,IAAI,QAAQ,EAAE;gBACzC,GAAG,gBAAgB,IAAI,aAAa,CAAC,QAAQ,EAAE;aAChD,CAAC;YAEF,kEAAkE;YAClE,IAAI,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE;gBAClC,iBAAiB,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;gBACnD,gBAAgB,CAAC,IAAI,CAAC,GAAG,0BAA0B,IAAI,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,CAAC,CAAC;aAC1F;YAED,MAAM,uBAAuB,GAAW,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAEpE,yCAAyC;YACzC,OAAO;YACP,YAAY;YACZ,EAAE;YACF,sCAAsC;YACtC,kBAAkB;YAClB,wFAAwF;YACxF,8BAA8B;YAC9B,EAAE;YACF,6CAA6C;YAC7C,mEAAmE;YACnE,MAAM,gBAAgB,GAAW;gBAC/B,IAAI;gBACJ,IAAI,UAAU,EAAE;gBAChB,EAAE;gBACF,GAAG,gBAAgB;gBACnB,EAAE;gBACF,uBAAuB;gBACvB,QAAQ;aACT,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACb,MAAM,oBAAoB,GAAW,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;YAEvE,MAAM,KAAK,GAAW,GAAG,aAAa,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,kBAAkB,CAAC;YAChF,sCAAsC;YACtC,mBAAmB;YACnB,mBAAmB;YACnB,qCAAqC;YACrC,mEAAmE;YACnE,MAAM,YAAY,GAAW;gBAC3B,kBAAkB;gBAClB,aAAa,CAAC,QAAQ;gBACtB,KAAK;gBACL,oBAAoB;aACrB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAEb,MAAM,OAAO,GAAW,IAAI,CAAC,cAAc,CACzC,OAAO,IAAI,CAAC,YAAY,CAAC,eAAe,EAAE,EAC1C,aAAa,CAAC,IAAI,CACnB,CAAC;YACF,MAAM,aAAa,GAAW,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YAC3E,MAAM,oBAAoB,GAAW,IAAI,CAAC,cAAc,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;YAC9E,MAAM,UAAU,GAAW,IAAI,CAAC,cAAc,CAAC,oBAAoB,EAAE,cAAc,CAAC,CAAC;YACrF,MAAM,SAAS,GAAW,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC;YAE/E,MAAM,mBAAmB,GAAW,+BAA+B,IAAI,CAAC,YAAY,CAAC,WAAW,IAAI,KAAK,kBAAkB,uBAAuB,cAAc,SAAS,EAAE,CAAC;YAE5K,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,mBAAmB,CAAC,CAAC;YAClD,IAAI,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE;gBAClC,kEAAkE;gBAClE,OAAO,CAAC,GAAG,CAAC,sBAAsB,EAAE,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;aACrE;SACF;QAED,MAAM,eAAe,GAAwC;YAC3D,IAAI;YACJ,OAAO;SACR,CAAC;QACF,IAAI,IAAI,KAAK,KAAK,EAAE;YACjB,eAAoC,CAAC,IAAI,GAAG,IAAI,CAAC;SACnD;QAED,MAAM,QAAQ,GAAmB,MAAM,IAAI,CAAC,UAAU,CAAC,UAAU,CAC/D,WAAW,IAAI,IAAI,UAAU,EAAE,EAC/B,eAAe,CAChB,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAIM,cAAc,CAAC,GAAoB,EAAE,IAAY,EAAE,QAAgB;QACxE,MAAM,IAAI,GAAgB,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QAC3D,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAClB,IAAI,QAAQ,EAAE;YACZ,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;SAC9B;aAAM;YACL,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;SACtB;IACH,CAAC;IAEO,UAAU,CAAC,IAAsB;QACvC,IAAI,IAAI,EAAE;YACR,MAAM,IAAI,GAAgB,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;YACtD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAClB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;SAC3B;aAAM;YACL,+BAA+B;YAC/B,OAAO,kEAAkE,CAAC;SAC3E;IACH,CAAC;IAEO,iBAAiB,CAAC,OAAa,IAAI,IAAI,EAAE;QAC/C,IAAI,UAAU,GAAW,IAAI,CAAC,WAAW,EAAE,CAAC;QAC5C,UAAU,GAAG,UAAU,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,8BAA8B;QAC5E,UAAU,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,oBAAoB;QAE9D,+DAA+D;QAC/D,gDAAgD;QAChD,OAAO;YACL,QAAQ,EAAE,GAAG,UAAU,GAAG;YAC1B,IAAI,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC;SACjC,CAAC;IACJ,CAAC;IAEO,aAAa,CAAC,QAAwB;QAC5C,MAAM,IAAI,KAAK,CAAC,wCAAwC,QAAQ,CAAC,MAAM,KAAK,QAAQ,CAAC,UAAU,GAAG,CAAC,CAAC;IACtG,CAAC;IAEO,QAAQ;QACd,IAAI,IAAI,CAAC,SAAS,KAAK,iBAAiB,EAAE;YACxC,OAAO,GAAG,IAAI,CAAC,SAAS,mBAAmB,CAAC;SAC7C;aAAM;YACL,OAAO,GAAG,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,SAAS,gBAAgB,CAAC;SAC/D;IACH,CAAC;IAED;;;OAGG;IACK,mBAAmB,CAAC,YAAoB;QAC9C,IAAI,CAAC,YAAY,EAAE;YACjB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;SACtD;QAED,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,mBAAmB,CAAC,EAAE;YAC5C,MAAM,IAAI,KAAK,CACb,oBAAoB,YAAY,6DAA6D;gBAC3F,8FAA8F,CACjG,CAAC;SACH;QAED,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE;YACnC,MAAM,IAAI,KAAK,CACb,oBAAoB,YAAY,6DAA6D;gBAC3F,2BAA2B,CAC9B,CAAC;SACH;QAED,IAAI,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;YAC5B,MAAM,IAAI,KAAK,CACb,oBAAoB,YAAY,wDAAwD,CACzF,CAAC;SACH;QAED,IAAI,YAAY,CAAC,KAAK,CAAC,oBAAoB,CAAC,EAAE;YAC5C,MAAM,IAAI,KAAK,CACb,oBAAoB,YAAY,sEAAsE;gBACpG,6BAA6B,CAChC,CAAC;SACH;QAED,IAAI,YAAY,CAAC,KAAK,CAAC,sCAAsC,CAAC,EAAE;YAC9D,MAAM,IAAI,KAAK,CACb,oBAAoB,YAAY,wEAAwE,CACzG,CAAC;SACH;IACH,CAAC;CACF;AA7PD,wCA6PC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\r\n// See LICENSE in the project root for license information.\r\n\r\nimport * as crypto from 'crypto';\r\nimport * as fetch from 'node-fetch';\r\n\r\nimport { IAmazonS3BuildCacheProviderOptions } from './AmazonS3BuildCacheProvider';\r\nimport { IGetFetchOptions, IPutFetchOptions, WebClient } from './WebClient';\r\n\r\nconst CONTENT_HASH_HEADER_NAME: 'x-amz-content-sha256' = 'x-amz-content-sha256';\r\nconst DATE_HEADER_NAME: 'x-amz-date' = 'x-amz-date';\r\nconst HOST_HEADER_NAME: 'host' = 'host';\r\nconst SECURITY_TOKEN_HEADER_NAME: 'x-amz-security-token' = 'x-amz-security-token';\r\n\r\nconst DEFAULT_S3_REGION: 'us-east-1' = 'us-east-1';\r\n\r\nexport interface IAmazonS3Credentials {\r\n  accessKeyId: string;\r\n  secretAccessKey: string;\r\n  sessionToken: string | undefined;\r\n}\r\n\r\ninterface IIsoDateString {\r\n  date: string;\r\n  dateTime: string;\r\n}\r\n\r\nexport class AmazonS3Client {\r\n  private readonly _credentials: IAmazonS3Credentials | undefined;\r\n  private readonly _s3Bucket: string;\r\n  private readonly _s3Region: string;\r\n\r\n  private readonly _webClient: WebClient;\r\n\r\n  public constructor(\r\n    credentials: IAmazonS3Credentials | undefined,\r\n    options: IAmazonS3BuildCacheProviderOptions,\r\n    webClient: WebClient\r\n  ) {\r\n    this._credentials = credentials;\r\n\r\n    this._validateBucketName(options.s3Bucket);\r\n\r\n    this._s3Bucket = options.s3Bucket;\r\n    this._s3Region = options.s3Region;\r\n\r\n    this._webClient = webClient;\r\n  }\r\n\r\n  public static tryDeserializeCredentials(\r\n    credentialString: string | undefined\r\n  ): IAmazonS3Credentials | undefined {\r\n    if (!credentialString) {\r\n      return undefined;\r\n    }\r\n\r\n    const fields: string[] = credentialString.split(':');\r\n    if (fields.length < 2 || fields.length > 3) {\r\n      throw new Error('Amazon S3 credential is in an unexpected format.');\r\n    }\r\n\r\n    return {\r\n      accessKeyId: fields[0],\r\n      secretAccessKey: fields[1],\r\n      sessionToken: fields[2]\r\n    };\r\n  }\r\n\r\n  public async getObjectAsync(objectName: string): Promise<Buffer | undefined> {\r\n    const response: fetch.Response = await this._makeRequestAsync('GET', objectName);\r\n    if (response.ok) {\r\n      return await response.buffer();\r\n    } else if (response.status === 404) {\r\n      return undefined;\r\n    } else if (response.status === 403 && !this._credentials) {\r\n      return undefined;\r\n    } else {\r\n      this._throwS3Error(response);\r\n    }\r\n  }\r\n\r\n  public async uploadObjectAsync(objectName: string, objectBuffer: Buffer): Promise<void> {\r\n    if (!this._credentials) {\r\n      throw new Error('Credentials are required to upload objects to S3.');\r\n    }\r\n\r\n    const response: fetch.Response = await this._makeRequestAsync('PUT', objectName, objectBuffer);\r\n    if (!response.ok) {\r\n      this._throwS3Error(response);\r\n    }\r\n  }\r\n\r\n  private async _makeRequestAsync(\r\n    verb: 'GET' | 'PUT',\r\n    objectName: string,\r\n    body?: Buffer\r\n  ): Promise<fetch.Response> {\r\n    const isoDateString: IIsoDateString = this._getIsoDateString();\r\n    const bodyHash: string = this._getSha256(body);\r\n    const host: string = this._getHost();\r\n    const headers: fetch.Headers = new fetch.Headers();\r\n    headers.set(DATE_HEADER_NAME, isoDateString.dateTime);\r\n    headers.set(CONTENT_HASH_HEADER_NAME, bodyHash);\r\n\r\n    if (this._credentials) {\r\n      // Compute the authorization header. See https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-header-based-auth.html\r\n      const signedHeaderNames: string[] = [HOST_HEADER_NAME, CONTENT_HASH_HEADER_NAME, DATE_HEADER_NAME];\r\n      const canonicalHeaders: string[] = [\r\n        `${HOST_HEADER_NAME}:${host}`,\r\n        `${CONTENT_HASH_HEADER_NAME}:${bodyHash}`,\r\n        `${DATE_HEADER_NAME}:${isoDateString.dateTime}`\r\n      ];\r\n\r\n      // Handle signing with temporary credentials (via sts:assume-role)\r\n      if (this._credentials.sessionToken) {\r\n        signedHeaderNames.push(SECURITY_TOKEN_HEADER_NAME);\r\n        canonicalHeaders.push(`${SECURITY_TOKEN_HEADER_NAME}:${this._credentials.sessionToken}`);\r\n      }\r\n\r\n      const signedHeaderNamesString: string = signedHeaderNames.join(';');\r\n\r\n      // The canonical request looks like this:\r\n      //  GET\r\n      // /test.txt\r\n      //\r\n      // host:examplebucket.s3.amazonaws.com\r\n      // range:bytes=0-9\r\n      // x-amz-content-sha256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855\r\n      // x-amz-date:20130524T000000Z\r\n      //\r\n      // host;range;x-amz-content-sha256;x-amz-date\r\n      // e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855\r\n      const canonicalRequest: string = [\r\n        verb,\r\n        `/${objectName}`,\r\n        '', // we don't use query strings for these requests\r\n        ...canonicalHeaders,\r\n        '',\r\n        signedHeaderNamesString,\r\n        bodyHash\r\n      ].join('\\n');\r\n      const canonicalRequestHash: string = this._getSha256(canonicalRequest);\r\n\r\n      const scope: string = `${isoDateString.date}/${this._s3Region}/s3/aws4_request`;\r\n      // The string to sign looks like this:\r\n      // AWS4-HMAC-SHA256\r\n      // 20130524T423589Z\r\n      // 20130524/us-east-1/s3/aws4_request\r\n      // 7344ae5b7ee6c3e7e6b0fe0640412a37625d1fbfff95c48bbb2dc43964946972\r\n      const stringToSign: string = [\r\n        'AWS4-HMAC-SHA256',\r\n        isoDateString.dateTime,\r\n        scope,\r\n        canonicalRequestHash\r\n      ].join('\\n');\r\n\r\n      const dateKey: Buffer = this._getSha256Hmac(\r\n        `AWS4${this._credentials.secretAccessKey}`,\r\n        isoDateString.date\r\n      );\r\n      const dateRegionKey: Buffer = this._getSha256Hmac(dateKey, this._s3Region);\r\n      const dateRegionServiceKey: Buffer = this._getSha256Hmac(dateRegionKey, 's3');\r\n      const signingKey: Buffer = this._getSha256Hmac(dateRegionServiceKey, 'aws4_request');\r\n      const signature: string = this._getSha256Hmac(signingKey, stringToSign, 'hex');\r\n\r\n      const authorizationHeader: string = `AWS4-HMAC-SHA256 Credential=${this._credentials.accessKeyId}/${scope},SignedHeaders=${signedHeaderNamesString},Signature=${signature}`;\r\n\r\n      headers.set('Authorization', authorizationHeader);\r\n      if (this._credentials.sessionToken) {\r\n        // Handle signing with temporary credentials (via sts:assume-role)\r\n        headers.set('X-Amz-Security-Token', this._credentials.sessionToken);\r\n      }\r\n    }\r\n\r\n    const webFetchOptions: IGetFetchOptions | IPutFetchOptions = {\r\n      verb,\r\n      headers\r\n    };\r\n    if (verb === 'PUT') {\r\n      (webFetchOptions as IPutFetchOptions).body = body;\r\n    }\r\n\r\n    const response: fetch.Response = await this._webClient.fetchAsync(\r\n      `https://${host}/${objectName}`,\r\n      webFetchOptions\r\n    );\r\n\r\n    return response;\r\n  }\r\n\r\n  public _getSha256Hmac(key: string | Buffer, data: string): Buffer;\r\n  public _getSha256Hmac(key: string | Buffer, data: string, encoding: 'hex'): string;\r\n  public _getSha256Hmac(key: string | Buffer, data: string, encoding?: 'hex'): Buffer | string {\r\n    const hash: crypto.Hash = crypto.createHmac('sha256', key);\r\n    hash.update(data);\r\n    if (encoding) {\r\n      return hash.digest(encoding);\r\n    } else {\r\n      return hash.digest();\r\n    }\r\n  }\r\n\r\n  private _getSha256(data?: string | Buffer): string {\r\n    if (data) {\r\n      const hash: crypto.Hash = crypto.createHash('sha256');\r\n      hash.update(data);\r\n      return hash.digest('hex');\r\n    } else {\r\n      // This is the null SHA256 hash\r\n      return 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855';\r\n    }\r\n  }\r\n\r\n  private _getIsoDateString(date: Date = new Date()): IIsoDateString {\r\n    let dateString: string = date.toISOString();\r\n    dateString = dateString.replace(/[-:]/g, ''); // Remove separator characters\r\n    dateString = dateString.substring(0, 15); // Drop milliseconds\r\n\r\n    // dateTime is an ISO8601 date. It looks like \"20130524T423589\"\r\n    // date is an ISO date. It looks like \"20130524\"\r\n    return {\r\n      dateTime: `${dateString}Z`,\r\n      date: dateString.substring(0, 8)\r\n    };\r\n  }\r\n\r\n  private _throwS3Error(response: fetch.Response): never {\r\n    throw new Error(`Amazon S3 responded with status code ${response.status} (${response.statusText})`);\r\n  }\r\n\r\n  private _getHost(): string {\r\n    if (this._s3Region === DEFAULT_S3_REGION) {\r\n      return `${this._s3Bucket}.s3.amazonaws.com`;\r\n    } else {\r\n      return `${this._s3Bucket}.s3-${this._s3Region}.amazonaws.com`;\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Validates a S3 bucket name.\r\n   * {@link https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-s3-bucket-naming-requirements.html}\r\n   */\r\n  private _validateBucketName(s3BucketName: string): void {\r\n    if (!s3BucketName) {\r\n      throw new Error('A S3 bucket name must be provided');\r\n    }\r\n\r\n    if (!s3BucketName.match(/^[a-z\\d-.]{3,63}$/)) {\r\n      throw new Error(\r\n        `The bucket name \"${s3BucketName}\" is invalid. A S3 bucket name must only contain lowercase ` +\r\n          'alphanumerical characters, dashes, and periods and must be between 3 and 63 characters long.'\r\n      );\r\n    }\r\n\r\n    if (!s3BucketName.match(/^[a-z\\d]/)) {\r\n      throw new Error(\r\n        `The bucket name \"${s3BucketName}\" is invalid. A S3 bucket name must start with a lowercase ` +\r\n          'alphanumerical character.'\r\n      );\r\n    }\r\n\r\n    if (s3BucketName.match(/-$/)) {\r\n      throw new Error(\r\n        `The bucket name \"${s3BucketName}\" is invalid. A S3 bucket name must not end in a dash.`\r\n      );\r\n    }\r\n\r\n    if (s3BucketName.match(/(\\.\\.)|(\\.-)|(-\\.)/)) {\r\n      throw new Error(\r\n        `The bucket name \"${s3BucketName}\" is invalid. A S3 bucket name must not have consecutive periods or ` +\r\n          'dashes adjacent to periods.'\r\n      );\r\n    }\r\n\r\n    if (s3BucketName.match(/^\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}$/)) {\r\n      throw new Error(\r\n        `The bucket name \"${s3BucketName}\" is invalid. A S3 bucket name must not be formatted as an IP address.`\r\n      );\r\n    }\r\n  }\r\n}\r\n"]}

package/lib/RushAmazonS3BuildCachePlugin.d.ts

@@ -0,0 +1,30 @@
+import type { IRushPlugin, RushSession, RushConfiguration } from '@rushstack/rush-sdk';
+/**
+ * @public
+ */
+export interface IAmazonS3ConfigurationJson {
+    /**
+     * The Amazon S3 region of the bucket to use for build cache (e.g. "us-east-1").
+     */
+    s3Region: string;
+    /**
+     * The name of the bucket in Amazon S3 to use for build cache.
+     */
+    s3Bucket: string;
+    /**
+     * An optional prefix ("folder") for cache items.
+     */
+    s3Prefix?: string;
+    /**
+     * If set to true, allow writing to the cache. Defaults to false.
+     */
+    isCacheWriteAllowed?: boolean;
+}
+/**
+ * @public
+ */
+export declare class RushAmazonS3BuildCachePlugin implements IRushPlugin {
+    pluginName: string;
+    apply(rushSession: RushSession, rushConfig: RushConfiguration): void;
+}
+//# sourceMappingURL=RushAmazonS3BuildCachePlugin.d.ts.map

package/lib/RushAmazonS3BuildCachePlugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RushAmazonS3BuildCachePlugin.d.ts","sourceRoot":"","sources":["../src/RushAmazonS3BuildCachePlugin.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAUvF;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED;;GAEG;AACH,qBAAa,4BAA6B,YAAW,WAAW;IACvD,UAAU,EAAE,MAAM,CAAe;IAEjC,KAAK,CAAC,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,iBAAiB,GAAG,IAAI;CAsB5E"}

package/lib/RushAmazonS3BuildCachePlugin.js

@@ -0,0 +1,31 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RushAmazonS3BuildCachePlugin = void 0;
+const node_core_library_1 = require("@rushstack/node-core-library");
+const AmazonS3BuildCacheProviderModule = node_core_library_1.Import.lazy('./AmazonS3BuildCacheProvider', require);
+const PLUGIN_NAME = 'AmazonS3BuildCachePlugin';
+/**
+ * @public
+ */
+class RushAmazonS3BuildCachePlugin {
+    constructor() {
+        this.pluginName = PLUGIN_NAME;
+    }
+    apply(rushSession, rushConfig) {
+        rushSession.hooks.initialize.tap(PLUGIN_NAME, () => {
+            rushSession.registerCloudBuildCacheProviderFactory('amazon-s3', (buildCacheConfig) => {
+                const { amazonS3Configuration } = buildCacheConfig;
+                return new AmazonS3BuildCacheProviderModule.AmazonS3BuildCacheProvider({
+                    s3Region: amazonS3Configuration.s3Region,
+                    s3Bucket: amazonS3Configuration.s3Bucket,
+                    s3Prefix: amazonS3Configuration.s3Prefix,
+                    isCacheWriteAllowed: !!amazonS3Configuration.isCacheWriteAllowed
+                }, rushSession);
+            });
+        });
+    }
+}
+exports.RushAmazonS3BuildCachePlugin = RushAmazonS3BuildCachePlugin;
+//# sourceMappingURL=RushAmazonS3BuildCachePlugin.js.map

package/lib/RushAmazonS3BuildCachePlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RushAmazonS3BuildCachePlugin.js","sourceRoot":"","sources":["../src/RushAmazonS3BuildCachePlugin.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,oEAAsD;AAItD,MAAM,gCAAgC,GAAkD,0BAAM,CAAC,IAAI,CACjG,8BAA8B,EAC9B,OAAO,CACR,CAAC;AAEF,MAAM,WAAW,GAAW,0BAA0B,CAAC;AA2BvD;;GAEG;AACH,MAAa,4BAA4B;IAAzC;QACS,eAAU,GAAW,WAAW,CAAC;IAwB1C,CAAC;IAtBQ,KAAK,CAAC,WAAwB,EAAE,UAA6B;QAClE,WAAW,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,WAAW,EAAE,GAAG,EAAE;YACjD,WAAW,CAAC,sCAAsC,CAChD,WAAW,EACX,CAAC,gBAAgB,EAA8B,EAAE;gBAI/C,MAAM,EAAE,qBAAqB,EAAE,GAAG,gBAA+B,CAAC;gBAClE,OAAO,IAAI,gCAAgC,CAAC,0BAA0B,CACpE;oBACE,QAAQ,EAAE,qBAAqB,CAAC,QAAQ;oBACxC,QAAQ,EAAE,qBAAqB,CAAC,QAAQ;oBACxC,QAAQ,EAAE,qBAAqB,CAAC,QAAQ;oBACxC,mBAAmB,EAAE,CAAC,CAAC,qBAAqB,CAAC,mBAAmB;iBACjE,EACD,WAAW,CACZ,CAAC;YACJ,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAzBD,oEAyBC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\r\n// See LICENSE in the project root for license information.\r\n\r\nimport { Import } from '@rushstack/node-core-library';\r\nimport type { IRushPlugin, RushSession, RushConfiguration } from '@rushstack/rush-sdk';\r\nimport type { AmazonS3BuildCacheProvider } from './AmazonS3BuildCacheProvider';\r\n\r\nconst AmazonS3BuildCacheProviderModule: typeof import('./AmazonS3BuildCacheProvider') = Import.lazy(\r\n  './AmazonS3BuildCacheProvider',\r\n  require\r\n);\r\n\r\nconst PLUGIN_NAME: string = 'AmazonS3BuildCachePlugin';\r\n\r\n/**\r\n * @public\r\n */\r\nexport interface IAmazonS3ConfigurationJson {\r\n  /**\r\n   * The Amazon S3 region of the bucket to use for build cache (e.g. \"us-east-1\").\r\n   */\r\n  s3Region: string;\r\n\r\n  /**\r\n   * The name of the bucket in Amazon S3 to use for build cache.\r\n   */\r\n  s3Bucket: string;\r\n\r\n  /**\r\n   * An optional prefix (\"folder\") for cache items.\r\n   */\r\n  s3Prefix?: string;\r\n\r\n  /**\r\n   * If set to true, allow writing to the cache. Defaults to false.\r\n   */\r\n  isCacheWriteAllowed?: boolean;\r\n}\r\n\r\n/**\r\n * @public\r\n */\r\nexport class RushAmazonS3BuildCachePlugin implements IRushPlugin {\r\n  public pluginName: string = PLUGIN_NAME;\r\n\r\n  public apply(rushSession: RushSession, rushConfig: RushConfiguration): void {\r\n    rushSession.hooks.initialize.tap(PLUGIN_NAME, () => {\r\n      rushSession.registerCloudBuildCacheProviderFactory(\r\n        'amazon-s3',\r\n        (buildCacheConfig): AmazonS3BuildCacheProvider => {\r\n          type IBuildCache = typeof buildCacheConfig & {\r\n            amazonS3Configuration: IAmazonS3ConfigurationJson;\r\n          };\r\n          const { amazonS3Configuration } = buildCacheConfig as IBuildCache;\r\n          return new AmazonS3BuildCacheProviderModule.AmazonS3BuildCacheProvider(\r\n            {\r\n              s3Region: amazonS3Configuration.s3Region,\r\n              s3Bucket: amazonS3Configuration.s3Bucket,\r\n              s3Prefix: amazonS3Configuration.s3Prefix,\r\n              isCacheWriteAllowed: !!amazonS3Configuration.isCacheWriteAllowed\r\n            },\r\n            rushSession\r\n          );\r\n        }\r\n      );\r\n    });\r\n  }\r\n}\r\n"]}

package/lib/WebClient.d.ts

@@ -0,0 +1,49 @@
+/// <reference types="node" />
+import * as fetch from 'node-fetch';
+/**
+ * For use with {@link WebClient}.
+ */
+export declare type WebClientResponse = fetch.Response;
+/**
+ * For use with {@link WebClient}.
+ */
+export interface IWebFetchOptionsBase {
+    timeoutMs?: number;
+    verb?: 'GET' | 'PUT';
+    headers?: fetch.Headers;
+}
+/**
+ * For use with {@link WebClient}.
+ */
+export interface IGetFetchOptions extends IWebFetchOptionsBase {
+    verb: 'GET' | never;
+}
+/**
+ * For use with {@link WebClient}.
+ */
+export interface IPutFetchOptions extends IWebFetchOptionsBase {
+    verb: 'PUT';
+    body?: Buffer;
+}
+/**
+ * For use with {@link WebClient}.
+ */
+export declare enum WebClientProxy {
+    None = 0,
+    Detect = 1,
+    Fiddler = 2
+}
+/**
+ * A helper for issuing HTTP requests.
+ */
+export declare class WebClient {
+    readonly standardHeaders: fetch.Headers;
+    accept: string | undefined;
+    userAgent: string | undefined;
+    proxy: WebClientProxy;
+    constructor();
+    static mergeHeaders(target: fetch.Headers, source: fetch.Headers): void;
+    addBasicAuthHeader(userName: string, password: string): void;
+    fetchAsync(url: string, options?: IGetFetchOptions | IPutFetchOptions): Promise<WebClientResponse>;
+}
+//# sourceMappingURL=WebClient.d.ts.map

package/lib/WebClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebClient.d.ts","sourceRoot":"","sources":["../src/WebClient.ts"],"names":[],"mappings":";AAaA,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC;AAMpC;;GAEG;AACH,oBAAY,iBAAiB,GAAG,KAAK,CAAC,QAAQ,CAAC;AAE/C;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC;IACrB,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,oBAAoB;IAC5D,IAAI,EAAE,KAAK,GAAG,KAAK,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,oBAAoB;IAC5D,IAAI,EAAE,KAAK,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,oBAAY,cAAc;IACxB,IAAI,IAAA;IACJ,MAAM,IAAA;IACN,OAAO,IAAA;CACR;AAED;;GAEG;AACH,qBAAa,SAAS;IACpB,SAAgB,eAAe,EAAE,KAAK,CAAC,OAAO,CAAuB;IAE9D,MAAM,EAAE,MAAM,GAAG,SAAS,CAAS;IACnC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAgE;IAE7F,KAAK,EAAE,cAAc,CAAyB;;WAIvC,YAAY,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,OAAO,GAAG,IAAI;IAMvE,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI;IAOtD,UAAU,CACrB,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,gBAAgB,GAAG,gBAAgB,GAC5C,OAAO,CAAC,iBAAiB,CAAC;CAsD9B"}

package/lib/WebClient.js

@@ -0,0 +1,112 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebClient = exports.WebClientProxy = void 0;
+// ===================================================================================================================
+// AS A TEMPORARY WORKAROUND, THIS FILE WAS COPY+PASTED FROM THE "rush-lib" PROJECT.
+//
+// Eventually we plan to convert it into a more generic API for "node-core-library" or
+// else replace it with a third party solution such as Axios.  See the discussion here:
+// https://github.com/microsoft/rushstack/pull/3036#discussion_r758010126
+// ===================================================================================================================
+const os = __importStar(require("os"));
+const process = __importStar(require("process"));
+const fetch = __importStar(require("node-fetch"));
+const node_core_library_1 = require("@rushstack/node-core-library");
+const createHttpsProxyAgent = node_core_library_1.Import.lazy('https-proxy-agent', require);
+/**
+ * For use with {@link WebClient}.
+ */
+var WebClientProxy;
+(function (WebClientProxy) {
+    WebClientProxy[WebClientProxy["None"] = 0] = "None";
+    WebClientProxy[WebClientProxy["Detect"] = 1] = "Detect";
+    WebClientProxy[WebClientProxy["Fiddler"] = 2] = "Fiddler";
+})(WebClientProxy = exports.WebClientProxy || (exports.WebClientProxy = {}));
+/**
+ * A helper for issuing HTTP requests.
+ */
+class WebClient {
+    constructor() {
+        this.standardHeaders = new fetch.Headers();
+        this.accept = '*/*';
+        this.userAgent = `rush node/${process.version} ${os.platform()} ${os.arch()}`;
+        this.proxy = WebClientProxy.Detect;
+    }
+    static mergeHeaders(target, source) {
+        source.forEach((value, name) => {
+            target.set(name, value);
+        });
+    }
+    addBasicAuthHeader(userName, password) {
+        this.standardHeaders.set('Authorization', 'Basic ' + Buffer.from(userName + ':' + password).toString('base64'));
+    }
+    async fetchAsync(url, options) {
+        const headers = new fetch.Headers();
+        WebClient.mergeHeaders(headers, this.standardHeaders);
+        if (options === null || options === void 0 ? void 0 : options.headers) {
+            WebClient.mergeHeaders(headers, options.headers);
+        }
+        if (this.userAgent) {
+            headers.set('user-agent', this.userAgent);
+        }
+        if (this.accept) {
+            headers.set('accept', this.accept);
+        }
+        let proxyUrl = '';
+        switch (this.proxy) {
+            case WebClientProxy.Detect:
+                if (process.env.HTTPS_PROXY) {
+                    proxyUrl = process.env.HTTPS_PROXY;
+                }
+                else if (process.env.HTTP_PROXY) {
+                    proxyUrl = process.env.HTTP_PROXY;
+                }
+                break;
+            case WebClientProxy.Fiddler:
+                // For debugging, disable cert validation
+                // eslint-disable-next-line
+                process.env['NODE_TLS_REJECT_UNAUTHORIZED'] = '0';
+                proxyUrl = 'http://localhost:8888/';
+                break;
+        }
+        let agent = undefined;
+        if (proxyUrl) {
+            agent = createHttpsProxyAgent(proxyUrl);
+        }
+        const timeoutMs = (options === null || options === void 0 ? void 0 : options.timeoutMs) !== undefined ? options.timeoutMs : 15 * 1000; // 15 seconds
+        const requestInit = {
+            method: options === null || options === void 0 ? void 0 : options.verb,
+            headers: headers,
+            agent: agent,
+            timeout: timeoutMs
+        };
+        const putOptions = options;
+        if (putOptions === null || putOptions === void 0 ? void 0 : putOptions.body) {
+            requestInit.body = putOptions.body;
+        }
+        return await fetch.default(url, requestInit);
+    }
+}
+exports.WebClient = WebClient;
+//# sourceMappingURL=WebClient.js.map

package/lib/WebClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebClient.js","sourceRoot":"","sources":["../src/WebClient.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;;;;;;;;;;;;;;;;;AAE3D,sHAAsH;AACtH,oFAAoF;AACpF,EAAE;AACF,sFAAsF;AACtF,uFAAuF;AACvF,yEAAyE;AACzE,sHAAsH;AAEtH,uCAAyB;AACzB,iDAAmC;AACnC,kDAAoC;AAEpC,oEAAsD;AAEtD,MAAM,qBAAqB,GAAuC,0BAAM,CAAC,IAAI,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;AA+B5G;;GAEG;AACH,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,mDAAI,CAAA;IACJ,uDAAM,CAAA;IACN,yDAAO,CAAA;AACT,CAAC,EAJW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAIzB;AAED;;GAEG;AACH,MAAa,SAAS;IAQpB;QAPgB,oBAAe,GAAkB,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;QAE9D,WAAM,GAAuB,KAAK,CAAC;QACnC,cAAS,GAAuB,aAAa,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC;QAE7F,UAAK,GAAmB,cAAc,CAAC,MAAM,CAAC;IAE/B,CAAC;IAEhB,MAAM,CAAC,YAAY,CAAC,MAAqB,EAAE,MAAqB;QACrE,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;YAC7B,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,kBAAkB,CAAC,QAAgB,EAAE,QAAgB;QAC1D,IAAI,CAAC,eAAe,CAAC,GAAG,CACtB,eAAe,EACf,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,GAAG,GAAG,GAAG,QAAQ,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CACrE,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,UAAU,CACrB,GAAW,EACX,OAA6C;QAE7C,MAAM,OAAO,GAAkB,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;QAEnD,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAEtD,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,EAAE;YACpB,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;SAClD;QAED,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;SAC3C;QACD,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;SACpC;QAED,IAAI,QAAQ,GAAW,EAAE,CAAC;QAE1B,QAAQ,IAAI,CAAC,KAAK,EAAE;YAClB,KAAK,cAAc,CAAC,MAAM;gBACxB,IAAI,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE;oBAC3B,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC;iBACpC;qBAAM,IAAI,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE;oBACjC,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC;iBACnC;gBACD,MAAM;YAER,KAAK,cAAc,CAAC,OAAO;gBACzB,yCAAyC;gBACzC,2BAA2B;gBAC3B,OAAO,CAAC,GAAG,CAAC,8BAA8B,CAAC,GAAG,GAAG,CAAC;gBAClD,QAAQ,GAAG,wBAAwB,CAAC;gBACpC,MAAM;SACT;QAED,IAAI,KAAK,GAA2B,SAAS,CAAC;QAC9C,IAAI,QAAQ,EAAE;YACZ,KAAK,GAAG,qBAAqB,CAAC,QAAQ,CAAC,CAAC;SACzC;QAED,MAAM,SAAS,GAAW,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,MAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC,aAAa;QACzG,MAAM,WAAW,GAAsB;YACrC,MAAM,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI;YACrB,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,KAAK;YACZ,OAAO,EAAE,SAAS;SACnB,CAAC;QACF,MAAM,UAAU,GAAiC,OAAuC,CAAC;QACzF,IAAI,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,IAAI,EAAE;YACpB,WAAW,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;SACpC;QAED,OAAO,MAAM,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;IAC/C,CAAC;CACF;AAhFD,8BAgFC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\r\n// See LICENSE in the project root for license information.\r\n\r\n// ===================================================================================================================\r\n// AS A TEMPORARY WORKAROUND, THIS FILE WAS COPY+PASTED FROM THE \"rush-lib\" PROJECT.\r\n//\r\n// Eventually we plan to convert it into a more generic API for \"node-core-library\" or\r\n// else replace it with a third party solution such as Axios.  See the discussion here:\r\n// https://github.com/microsoft/rushstack/pull/3036#discussion_r758010126\r\n// ===================================================================================================================\r\n\r\nimport * as os from 'os';\r\nimport * as process from 'process';\r\nimport * as fetch from 'node-fetch';\r\nimport * as http from 'http';\r\nimport { Import } from '@rushstack/node-core-library';\r\n\r\nconst createHttpsProxyAgent: typeof import('https-proxy-agent') = Import.lazy('https-proxy-agent', require);\r\n\r\n/**\r\n * For use with {@link WebClient}.\r\n */\r\nexport type WebClientResponse = fetch.Response;\r\n\r\n/**\r\n * For use with {@link WebClient}.\r\n */\r\nexport interface IWebFetchOptionsBase {\r\n  timeoutMs?: number;\r\n  verb?: 'GET' | 'PUT';\r\n  headers?: fetch.Headers;\r\n}\r\n\r\n/**\r\n * For use with {@link WebClient}.\r\n */\r\nexport interface IGetFetchOptions extends IWebFetchOptionsBase {\r\n  verb: 'GET' | never;\r\n}\r\n\r\n/**\r\n * For use with {@link WebClient}.\r\n */\r\nexport interface IPutFetchOptions extends IWebFetchOptionsBase {\r\n  verb: 'PUT';\r\n  body?: Buffer;\r\n}\r\n\r\n/**\r\n * For use with {@link WebClient}.\r\n */\r\nexport enum WebClientProxy {\r\n  None,\r\n  Detect,\r\n  Fiddler\r\n}\r\n\r\n/**\r\n * A helper for issuing HTTP requests.\r\n */\r\nexport class WebClient {\r\n  public readonly standardHeaders: fetch.Headers = new fetch.Headers();\r\n\r\n  public accept: string | undefined = '*/*';\r\n  public userAgent: string | undefined = `rush node/${process.version} ${os.platform()} ${os.arch()}`;\r\n\r\n  public proxy: WebClientProxy = WebClientProxy.Detect;\r\n\r\n  public constructor() {}\r\n\r\n  public static mergeHeaders(target: fetch.Headers, source: fetch.Headers): void {\r\n    source.forEach((value, name) => {\r\n      target.set(name, value);\r\n    });\r\n  }\r\n\r\n  public addBasicAuthHeader(userName: string, password: string): void {\r\n    this.standardHeaders.set(\r\n      'Authorization',\r\n      'Basic ' + Buffer.from(userName + ':' + password).toString('base64')\r\n    );\r\n  }\r\n\r\n  public async fetchAsync(\r\n    url: string,\r\n    options?: IGetFetchOptions | IPutFetchOptions\r\n  ): Promise<WebClientResponse> {\r\n    const headers: fetch.Headers = new fetch.Headers();\r\n\r\n    WebClient.mergeHeaders(headers, this.standardHeaders);\r\n\r\n    if (options?.headers) {\r\n      WebClient.mergeHeaders(headers, options.headers);\r\n    }\r\n\r\n    if (this.userAgent) {\r\n      headers.set('user-agent', this.userAgent);\r\n    }\r\n    if (this.accept) {\r\n      headers.set('accept', this.accept);\r\n    }\r\n\r\n    let proxyUrl: string = '';\r\n\r\n    switch (this.proxy) {\r\n      case WebClientProxy.Detect:\r\n        if (process.env.HTTPS_PROXY) {\r\n          proxyUrl = process.env.HTTPS_PROXY;\r\n        } else if (process.env.HTTP_PROXY) {\r\n          proxyUrl = process.env.HTTP_PROXY;\r\n        }\r\n        break;\r\n\r\n      case WebClientProxy.Fiddler:\r\n        // For debugging, disable cert validation\r\n        // eslint-disable-next-line\r\n        process.env['NODE_TLS_REJECT_UNAUTHORIZED'] = '0';\r\n        proxyUrl = 'http://localhost:8888/';\r\n        break;\r\n    }\r\n\r\n    let agent: http.Agent | undefined = undefined;\r\n    if (proxyUrl) {\r\n      agent = createHttpsProxyAgent(proxyUrl);\r\n    }\r\n\r\n    const timeoutMs: number = options?.timeoutMs !== undefined ? options.timeoutMs : 15 * 1000; // 15 seconds\r\n    const requestInit: fetch.RequestInit = {\r\n      method: options?.verb,\r\n      headers: headers,\r\n      agent: agent,\r\n      timeout: timeoutMs\r\n    };\r\n    const putOptions: IPutFetchOptions | undefined = options as IPutFetchOptions | undefined;\r\n    if (putOptions?.body) {\r\n      requestInit.body = putOptions.body;\r\n    }\r\n\r\n    return await fetch.default(url, requestInit);\r\n  }\r\n}\r\n"]}

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+import { RushAmazonS3BuildCachePlugin } from './RushAmazonS3BuildCachePlugin';
+export default RushAmazonS3BuildCachePlugin;
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AAE9E,eAAe,4BAA4B,CAAC"}

package/lib/index.js

@@ -0,0 +1,7 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+const RushAmazonS3BuildCachePlugin_1 = require("./RushAmazonS3BuildCachePlugin");
+exports.default = RushAmazonS3BuildCachePlugin_1.RushAmazonS3BuildCachePlugin;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;AAE3D,iFAA8E;AAE9E,kBAAe,2DAA4B,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\r\n// See LICENSE in the project root for license information.\r\n\r\nimport { RushAmazonS3BuildCachePlugin } from './RushAmazonS3BuildCachePlugin';\r\n\r\nexport default RushAmazonS3BuildCachePlugin;\r\n"]}

package/lib/schemas/amazon-s3-config.schema.json

@@ -0,0 +1,32 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "Configuration for build cache with Amazon S3 configuration",
+
+  "type": "object",
+
+  "additionalProperties": false,
+
+  "required": ["s3Region", "s3Bucket"],
+
+  "properties": {
+    "s3Region": {
+      "type": "string",
+      "description": "(Required) The Amazon S3 region of the bucket to use for build cache (e.g. \"us-east-1\")."
+    },
+
+    "s3Bucket": {
+      "type": "string",
+      "description": "(Required) The name of the bucket in Amazon S3 to use for build cache."
+    },
+
+    "s3Prefix": {
+      "type": "string",
+      "description": "An optional prefix (\"folder\") for cache items."
+    },
+
+    "isCacheWriteAllowed": {
+      "type": "boolean",
+      "description": "If set to true, allow writing to the cache. Defaults to false."
+    }
+  }
+}

package/lib/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.18.19"
+    }
+  ]
+}

package/package.json

@@ -1,5 +1,32 @@
 {
-  "license": "MIT",
-  "name": "@rushstack/rush-amazon-s3-build-cache-plugin",
-  "version": "0.0.0"
+	"name": "@rushstack/rush-amazon-s3-build-cache-plugin",
+	"version": "5.57.0-dev.1",
+	"description": "Rush plugin for Amazon S3 cloud build cache",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/microsoft/rushstack/tree/master/heft-plugins/heft-webpack5-plugin"
+	},
+	"homepage": "https://rushjs.io",
+	"main": "lib/index.js",
+	"types": "lib/index.d.ts",
+	"license": "MIT",
+	"dependencies": {
+		"@rushstack/node-core-library": "3.43.2",
+		"@rushstack/rush-sdk": "5.57.0-dev.1",
+		"https-proxy-agent": "~5.0.0",
+		"node-fetch": "2.6.2"
+	},
+	"devDependencies": {
+		"@microsoft/rush-lib": "5.57.0-dev.1",
+		"@rushstack/eslint-config": "2.4.5",
+		"@rushstack/heft": "0.42.3",
+		"@rushstack/heft-node-rig": "1.2.31",
+		"@types/heft-jest": "1.0.1",
+		"@types/node": "12.20.24",
+		"@types/node-fetch": "1.6.9"
+	},
+	"scripts": {
+		"build": "heft test --clean",
+		"start": "heft test --clean --watch"
+	}
 }