@prairielearn/aws 1.0.10 → 2.0.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @prairielearn/aws
 
+## 2.0.0
+
+### Major Changes
+
+- 4f30b7e: Publish as native ESM
+
 ## 1.0.10
 
 ### Patch Changes

package/README.md

@@ -14,12 +14,10 @@ Create a config provider with `makeAwsConfigProvider`:
 import { makeAwsConfigProvider } from '@prairielearn/aws';
 import { fromNodeProviderChain } from '@aws-sdk/credential-providers';
 
-import { config } from './config';
-
 const awsConfigProvider = makeAwsConfigProvider({
   credentials: fromNodeProviderChain(),
   getClientConfig: () => ({
-    region: config.awsRegion,
+    region: 'us-east-2',
   }),
 });
 
@@ -59,7 +57,7 @@ For instance, to use [`s3rver`](https://github.com/jamhall/s3rver) when running
 const awsConfigProvider = makeAwsConfigProvider({
   credentials: fromNodeProviderChain(),
   getClientConfig: () => ({
-    region: config.awsRegion,
+    region: 'us-east-2',
   }),
   makeS3ClientConfig: () => {
     if (process.env.NODE_ENV !== 'production') {

package/dist/config.js

@@ -1,12 +1,9 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeAwsConfigProvider = void 0;
-const property_provider_1 = require("@smithy/property-provider");
+import { memoize } from '@smithy/property-provider';
 // Attempt to refresh credentials 5 minutes before they actually expire.
 // This value is the same value that the AWS SDK uses internally:
 // https://github.com/aws/aws-sdk-js-v3/blob/3f8b581af7c0c8146c5b111f92ba6a024310c525/packages/middleware-signing/src/awsAuthConfiguration.ts#L18
 const CREDENTIAL_EXPIRE_WINDOW = 300000;
-function makeAwsConfigProvider({ credentials, getClientConfig, getS3ClientConfig, }) {
+export function makeAwsConfigProvider({ credentials, getClientConfig, getS3ClientConfig, }) {
     // Clients don't share credentials by default, which means that we'll flood
     // the IMDS with requests for credentials if we construct and use a lot of
     // clients in quick succession. IMDS has rate-limiting, so we'll end up failing
@@ -18,7 +15,7 @@ function makeAwsConfigProvider({ credentials, getClientConfig, getS3ClientConfig
     //
     // Memoization is based on the following:
     // https://github.com/aws/aws-sdk-js-v3/blob/3f8b581af7c0c8146c5b111f92ba6a024310c525/packages/middleware-signing/src/awsAuthConfiguration.ts#L257
-    const memoizedCredentials = (0, property_provider_1.memoize)(credentials, (credentials) => credentials.expiration !== undefined &&
+    const memoizedCredentials = memoize(credentials, (credentials) => credentials.expiration !== undefined &&
         credentials.expiration.getTime() - Date.now() < CREDENTIAL_EXPIRE_WINDOW, (credentials) => credentials.expiration !== undefined);
     function makeAwsClientConfig(extraConfig = {}) {
         return {
@@ -39,5 +36,4 @@ function makeAwsConfigProvider({ credentials, getClientConfig, getS3ClientConfig
         makeS3ClientConfig,
     };
 }
-exports.makeAwsConfigProvider = makeAwsConfigProvider;
 //# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";;;AAAA,iEAAoD;AAQpD,wEAAwE;AACxE,iEAAiE;AACjE,iJAAiJ;AACjJ,MAAM,wBAAwB,GAAG,MAAM,CAAC;AAExC,SAAgB,qBAAqB,CAAC,EACpC,WAAW,EACX,eAAe,EACf,iBAAiB,GAKlB;IACC,2EAA2E;IAC3E,0EAA0E;IAC1E,+EAA+E;IAC/E,sBAAsB;IACtB,EAAE;IACF,6EAA6E;IAC7E,6EAA6E;IAC7E,uEAAuE;IACvE,EAAE;IACF,yCAAyC;IACzC,kJAAkJ;IAClJ,MAAM,mBAAmB,GAAG,IAAA,2BAAO,EACjC,WAAW,EACX,CAAC,WAAW,EAAE,EAAE,CACd,WAAW,CAAC,UAAU,KAAK,SAAS;QACpC,WAAW,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,wBAAwB,EAC1E,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,UAAU,KAAK,SAAS,CACtD,CAAC;IAEF,SAAS,mBAAmB,CAAgC,cAAiB,EAAO;QAClF,OAAO;YACL,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,YAAY;YAClC,WAAW,EAAE,mBAAmB;YAChC,GAAG,eAAe,EAAE;YACpB,GAAG,WAAW;SACf,CAAC;IACJ,CAAC;IAED,SAAS,kBAAkB,CAAgC,cAAiB,EAAO;QACjF,OAAO,mBAAmB,CAAC;YACzB,GAAG,CAAC,iBAAiB,EAAE,EAAE,IAAI,EAAE,CAAC;YAChC,GAAG,WAAW;SACf,CAAC,CAAC;IACL,CAAC;IAED,OAAO;QACL,mBAAmB;QACnB,kBAAkB;KACnB,CAAC;AACJ,CAAC;AAhDD,sDAgDC"}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AAQpD,wEAAwE;AACxE,iEAAiE;AACjE,iJAAiJ;AACjJ,MAAM,wBAAwB,GAAG,MAAM,CAAC;AAExC,MAAM,UAAU,qBAAqB,CAAC,EACpC,WAAW,EACX,eAAe,EACf,iBAAiB,GAKlB;IACC,2EAA2E;IAC3E,0EAA0E;IAC1E,+EAA+E;IAC/E,sBAAsB;IACtB,EAAE;IACF,6EAA6E;IAC7E,6EAA6E;IAC7E,uEAAuE;IACvE,EAAE;IACF,yCAAyC;IACzC,kJAAkJ;IAClJ,MAAM,mBAAmB,GAAG,OAAO,CACjC,WAAW,EACX,CAAC,WAAW,EAAE,EAAE,CACd,WAAW,CAAC,UAAU,KAAK,SAAS;QACpC,WAAW,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,wBAAwB,EAC1E,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,UAAU,KAAK,SAAS,CACtD,CAAC;IAEF,SAAS,mBAAmB,CAAgC,cAAiB,EAAO;QAClF,OAAO;YACL,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,YAAY;YAClC,WAAW,EAAE,mBAAmB;YAChC,GAAG,eAAe,EAAE;YACpB,GAAG,WAAW;SACf,CAAC;IACJ,CAAC;IAED,SAAS,kBAAkB,CAAgC,cAAiB,EAAO;QACjF,OAAO,mBAAmB,CAAC;YACzB,GAAG,CAAC,iBAAiB,EAAE,EAAE,IAAI,EAAE,CAAC;YAChC,GAAG,WAAW;SACf,CAAC,CAAC;IACL,CAAC;IAED,OAAO;QACL,mBAAmB;QACnB,kBAAkB;KACnB,CAAC;AACJ,CAAC","sourcesContent":["import { memoize } from '@smithy/property-provider';\nimport { AwsCredentialIdentityProvider } from '@smithy/types';\n\ninterface AwsClientConfig {\n  region: string;\n  [key: string]: any;\n}\n\n// Attempt to refresh credentials 5 minutes before they actually expire.\n// This value is the same value that the AWS SDK uses internally:\n// https://github.com/aws/aws-sdk-js-v3/blob/3f8b581af7c0c8146c5b111f92ba6a024310c525/packages/middleware-signing/src/awsAuthConfiguration.ts#L18\nconst CREDENTIAL_EXPIRE_WINDOW = 300000;\n\nexport function makeAwsConfigProvider({\n  credentials,\n  getClientConfig,\n  getS3ClientConfig,\n}: {\n  credentials: AwsCredentialIdentityProvider;\n  getClientConfig: () => AwsClientConfig;\n  getS3ClientConfig?: () => Record<string, any>;\n}) {\n  // Clients don't share credentials by default, which means that we'll flood\n  // the IMDS with requests for credentials if we construct and use a lot of\n  // clients in quick succession. IMDS has rate-limiting, so we'll end up failing\n  // to get credentials.\n  //\n  // To work around this, we'll share a single credential provider chain across\n  // all clients we create. We'll also memoize the credential provider chain so\n  // that we don't end up making unnecessarily many requests to the IMDS.\n  //\n  // Memoization is based on the following:\n  // https://github.com/aws/aws-sdk-js-v3/blob/3f8b581af7c0c8146c5b111f92ba6a024310c525/packages/middleware-signing/src/awsAuthConfiguration.ts#L257\n  const memoizedCredentials = memoize(\n    credentials,\n    (credentials) =>\n      credentials.expiration !== undefined &&\n      credentials.expiration.getTime() - Date.now() < CREDENTIAL_EXPIRE_WINDOW,\n    (credentials) => credentials.expiration !== undefined,\n  );\n\n  function makeAwsClientConfig<T extends Record<string, any>>(extraConfig: T = {} as T) {\n    return {\n      endpoint: process.env.AWS_ENDPOINT,\n      credentials: memoizedCredentials,\n      ...getClientConfig(),\n      ...extraConfig,\n    };\n  }\n\n  function makeS3ClientConfig<T extends Record<string, any>>(extraConfig: T = {} as T) {\n    return makeAwsClientConfig({\n      ...(getS3ClientConfig?.() ?? {}),\n      ...extraConfig,\n    });\n  }\n\n  return {\n    makeAwsClientConfig,\n    makeS3ClientConfig,\n  };\n}\n"]}

package/dist/index.d.ts

@@ -1 +1 @@
-export { makeAwsConfigProvider } from './config';
+export { makeAwsConfigProvider } from './config.js';

package/dist/index.js

@@ -1,6 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeAwsConfigProvider = void 0;
-var config_1 = require("./config");
-Object.defineProperty(exports, "makeAwsConfigProvider", { enumerable: true, get: function () { return config_1.makeAwsConfigProvider; } });
+export { makeAwsConfigProvider } from './config.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,mCAAiD;AAAxC,+GAAA,qBAAqB,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC","sourcesContent":["export { makeAwsConfigProvider } from './config.js';\n"]}

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@prairielearn/aws",
-  "version": "1.0.10",
+  "version": "2.0.0",
+  "type": "module",
   "main": "dist/index.js",
   "repository": {
     "type": "git",

package/src/index.ts

@@ -1 +1 @@
-export { makeAwsConfigProvider } from './config';
+export { makeAwsConfigProvider } from './config.js';