@edgestore/server 0.7.0-canary.0 → 0.7.0-canary.1

package/dist/providers/aws/index.d.ts

@@ -1,4 +1,5 @@
-import { type MaybePromise, type Provider, type RequestUploadParams } from '@edgestore/shared';
+import { type S3ClientConfig } from '@aws-sdk/client-s3';
+import { type MaybePromise, type Provider as EdgeStoreProvider, type RequestUploadParams } from '@edgestore/shared';
 type ProviderUploadedFileInfo = RequestUploadParams['fileInfo'];
 export type AWSOverwritePathFnArgs = {
     esBucketName: string;
@@ -7,11 +8,20 @@ export type AWSOverwritePathFnArgs = {
 };
 export type AWSOverwritePathFn = (args: AWSOverwritePathFnArgs) => MaybePromise<string>;
 export type AWSProviderOptions = {
+    /**
+     * AWS SDK credentials (or credentials provider) to use for S3 requests.
+     *
+     * If unset, the AWS SDK will use its default credential provider chain
+     * (environment variables, shared config files, instance/task roles, etc).
+     */
+    credentials?: S3ClientConfig['credentials'];
     /**
      * Access key for AWS credentials.
      * Can also be set via the `ES_AWS_ACCESS_KEY_ID` environment variable.
      *
      * If unset, the SDK will attempt to use the default credentials provider chain.
+     *
+     * @deprecated Pass `credentials` instead.
      */
     accessKeyId?: string;
     /**
@@ -19,6 +29,8 @@ export type AWSProviderOptions = {
      * Can also be set via the `ES_AWS_SECRET_ACCESS_KEY` environment variable.
      *
      * If unset, the SDK will attempt to use the default credentials provider chain.
+     *
+     * @deprecated Pass `credentials` instead.
      */
     secretAccessKey?: string;
     /**
@@ -63,6 +75,6 @@ export type AWSProviderOptions = {
      */
     overwritePath?: AWSOverwritePathFn;
 };
-export declare function AWSProvider(options?: AWSProviderOptions): Provider;
+export declare function AWSProvider(options?: AWSProviderOptions): EdgeStoreProvider;
 export {};
 //# sourceMappingURL=index.d.ts.map

package/dist/providers/aws/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/providers/aws/index.ts"],"names":[],"mappings":"AAOA,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,QAAQ,EACb,KAAK,mBAAmB,EACzB,MAAM,mBAAmB,CAAC;AAK3B,KAAK,wBAAwB,GAAG,mBAAmB,CAAC,UAAU,CAAC,CAAC;AAEhE,MAAM,MAAM,sBAAsB,GAAG;IAEnC,YAAY,EAAE,MAAM,CAAC;IAErB,QAAQ,EAAE,wBAAwB,CAAC;IAEnC,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,CAC/B,IAAI,EAAE,sBAAsB,KACzB,YAAY,CAAC,MAAM,CAAC,CAAC;AAE1B,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,aAAa,CAAC,EAAE,kBAAkB,CAAC;CACpC,CAAC;AAEF,wBAAgB,WAAW,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,QAAQ,CAwIlE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/providers/aws/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,KAAK,cAAc,EACpB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,QAAQ,IAAI,iBAAiB,EAClC,KAAK,mBAAmB,EACzB,MAAM,mBAAmB,CAAC;AAK3B,KAAK,wBAAwB,GAAG,mBAAmB,CAAC,UAAU,CAAC,CAAC;AAEhE,MAAM,MAAM,sBAAsB,GAAG;IAEnC,YAAY,EAAE,MAAM,CAAC;IAErB,QAAQ,EAAE,wBAAwB,CAAC;IAEnC,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,CAC/B,IAAI,EAAE,sBAAsB,KACzB,YAAY,CAAC,MAAM,CAAC,CAAC;AAE1B,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;;OAKG;IACH,WAAW,CAAC,EAAE,cAAc,CAAC,aAAa,CAAC,CAAC;IAC5C;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,aAAa,CAAC,EAAE,kBAAkB,CAAC;CACpC,CAAC;AAEF,wBAAgB,WAAW,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,CA0I3E"}

package/dist/providers/aws/index.js

@@ -6,12 +6,12 @@ var uuid = require('uuid');
 var shared = require('../../adapters/shared.js');
 
 function AWSProvider(options) {
-    const { accessKeyId = shared.getEnv('ES_AWS_ACCESS_KEY_ID'), secretAccessKey = shared.getEnv('ES_AWS_SECRET_ACCESS_KEY'), region = shared.getEnv('ES_AWS_REGION'), bucketName = shared.getEnv('ES_AWS_BUCKET_NAME'), endpoint = shared.getEnv('ES_AWS_ENDPOINT'), forcePathStyle = shared.getEnv('ES_AWS_FORCE_PATH_STYLE') === 'true', overwritePath } = options ?? {};
+    const { credentials: credentialsFromOptions, accessKeyId = shared.getEnv('ES_AWS_ACCESS_KEY_ID'), secretAccessKey = shared.getEnv('ES_AWS_SECRET_ACCESS_KEY'), region = shared.getEnv('ES_AWS_REGION'), bucketName = shared.getEnv('ES_AWS_BUCKET_NAME'), endpoint = shared.getEnv('ES_AWS_ENDPOINT'), forcePathStyle = shared.getEnv('ES_AWS_FORCE_PATH_STYLE') === 'true', overwritePath } = options ?? {};
     const baseUrl = options?.baseUrl ?? shared.getEnv('EDGE_STORE_BASE_URL') ?? (endpoint ? `${endpoint}/${bucketName}` : `https://${bucketName}.s3.${region}.amazonaws.com`);
-    const credentials = accessKeyId && secretAccessKey ? {
+    const credentials = credentialsFromOptions ?? (accessKeyId && secretAccessKey ? {
         accessKeyId,
         secretAccessKey
-    } : undefined;
+    } : undefined);
     const s3Client = new clientS3.S3Client({
         region,
         credentials,

package/dist/providers/aws/index.mjs

@@ -4,12 +4,12 @@ import { v4 } from 'uuid';
 import { getEnv } from '../../adapters/shared.mjs';
 
 function AWSProvider(options) {
-    const { accessKeyId = getEnv('ES_AWS_ACCESS_KEY_ID'), secretAccessKey = getEnv('ES_AWS_SECRET_ACCESS_KEY'), region = getEnv('ES_AWS_REGION'), bucketName = getEnv('ES_AWS_BUCKET_NAME'), endpoint = getEnv('ES_AWS_ENDPOINT'), forcePathStyle = getEnv('ES_AWS_FORCE_PATH_STYLE') === 'true', overwritePath } = options ?? {};
+    const { credentials: credentialsFromOptions, accessKeyId = getEnv('ES_AWS_ACCESS_KEY_ID'), secretAccessKey = getEnv('ES_AWS_SECRET_ACCESS_KEY'), region = getEnv('ES_AWS_REGION'), bucketName = getEnv('ES_AWS_BUCKET_NAME'), endpoint = getEnv('ES_AWS_ENDPOINT'), forcePathStyle = getEnv('ES_AWS_FORCE_PATH_STYLE') === 'true', overwritePath } = options ?? {};
     const baseUrl = options?.baseUrl ?? getEnv('EDGE_STORE_BASE_URL') ?? (endpoint ? `${endpoint}/${bucketName}` : `https://${bucketName}.s3.${region}.amazonaws.com`);
-    const credentials = accessKeyId && secretAccessKey ? {
+    const credentials = credentialsFromOptions ?? (accessKeyId && secretAccessKey ? {
         accessKeyId,
         secretAccessKey
-    } : undefined;
+    } : undefined);
     const s3Client = new S3Client({
         region,
         credentials,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@edgestore/server",
-  "version": "0.7.0-canary.0",
+  "version": "0.7.0-canary.1",
   "description": "Upload files with ease from React/Next.js",
   "homepage": "https://edgestore.dev",
   "license": "MIT",
@@ -109,7 +109,7 @@
     "!**/__tests__"
   ],
   "dependencies": {
-    "@edgestore/shared": "0.7.0-canary.0",
+    "@edgestore/shared": "0.7.0-canary.1",
     "@panva/hkdf": "^1.0.4",
     "cookie": "^0.7.0",
     "jose": "^4.13.1",

package/src/providers/aws/index.ts

@@ -3,11 +3,12 @@ import {
   HeadObjectCommand,
   PutObjectCommand,
   S3Client,
+  type S3ClientConfig,
 } from '@aws-sdk/client-s3';
 import { getSignedUrl } from '@aws-sdk/s3-request-presigner';
 import {
   type MaybePromise,
-  type Provider,
+  type Provider as EdgeStoreProvider,
   type RequestUploadParams,
 } from '@edgestore/shared';
 import { v4 as uuidv4 } from 'uuid';
@@ -30,11 +31,20 @@ export type AWSOverwritePathFn = (
 ) => MaybePromise<string>;
 
 export type AWSProviderOptions = {
+  /**
+   * AWS SDK credentials (or credentials provider) to use for S3 requests.
+   *
+   * If unset, the AWS SDK will use its default credential provider chain
+   * (environment variables, shared config files, instance/task roles, etc).
+   */
+  credentials?: S3ClientConfig['credentials'];
   /**
    * Access key for AWS credentials.
    * Can also be set via the `ES_AWS_ACCESS_KEY_ID` environment variable.
    *
    * If unset, the SDK will attempt to use the default credentials provider chain.
+   *
+   * @deprecated Pass `credentials` instead.
    */
   accessKeyId?: string;
   /**
@@ -42,6 +52,8 @@ export type AWSProviderOptions = {
    * Can also be set via the `ES_AWS_SECRET_ACCESS_KEY` environment variable.
    *
    * If unset, the SDK will attempt to use the default credentials provider chain.
+   *
+   * @deprecated Pass `credentials` instead.
    */
   secretAccessKey?: string;
   /**
@@ -87,8 +99,9 @@ export type AWSProviderOptions = {
   overwritePath?: AWSOverwritePathFn;
 };
 
-export function AWSProvider(options?: AWSProviderOptions): Provider {
+export function AWSProvider(options?: AWSProviderOptions): EdgeStoreProvider {
   const {
+    credentials: credentialsFromOptions,
     accessKeyId = getEnv('ES_AWS_ACCESS_KEY_ID'),
     secretAccessKey = getEnv('ES_AWS_SECRET_ACCESS_KEY'),
     region = getEnv('ES_AWS_REGION'),
@@ -106,12 +119,13 @@ export function AWSProvider(options?: AWSProviderOptions): Provider {
       : `https://${bucketName}.s3.${region}.amazonaws.com`);
 
   const credentials =
-    accessKeyId && secretAccessKey
+    credentialsFromOptions ??
+    (accessKeyId && secretAccessKey
       ? {
           accessKeyId,
           secretAccessKey,
         }
-      : undefined;
+      : undefined);
   const s3Client = new S3Client({
     region,
     credentials,