@vercel/aws 0.2.0 → 0.2.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @vercel/aws
 
+## 0.2.1
+
+### Patch Changes
+
+- cb11ee2: Update `createOpenSearch` to read `OPENSEARCH_ENDPOINT` and `AWS_REGION` (replacing `OPENSEARCH_DASHBOARD_ENDPOINT` and `OPENSEARCH_REGION`).
+
 ## 0.2.0
 
 ### Minor Changes

package/dist/opensearch.d.ts

@@ -11,12 +11,12 @@ import { Client, type ClientOptions } from '@opensearch-project/opensearch';
 export interface CreateOpenSearchOptions extends Partial<ClientOptions> {
     /**
      * The OpenSearch collection endpoint. Defaults to
-     * `process.env.OPENSEARCH_DASHBOARD_ENDPOINT`.
+     * `process.env.OPENSEARCH_ENDPOINT`.
      */
     endpoint?: string;
     /**
      * The AWS region the collection lives in. Defaults to
-     * `process.env.OPENSEARCH_REGION`.
+     * `process.env.AWS_REGION`.
      */
     region?: string;
     /**

package/dist/opensearch.js

@@ -25,14 +25,14 @@ var import_opensearch = require("@opensearch-project/opensearch");
 var import_aws = require("@opensearch-project/opensearch/aws");
 var import_oidc_aws_credentials_provider = require("@vercel/oidc-aws-credentials-provider");
 function createOpenSearch(opts = {}) {
-  const endpoint = opts.endpoint ?? process.env.OPENSEARCH_DASHBOARD_ENDPOINT;
-  const region = opts.region ?? process.env.OPENSEARCH_REGION;
+  const endpoint = opts.endpoint ?? process.env.OPENSEARCH_ENDPOINT;
+  const region = opts.region ?? process.env.AWS_REGION;
   const roleArn = opts.roleArn ?? process.env.AWS_ROLE_ARN;
   const missing = [];
   if (!endpoint)
-    missing.push("OPENSEARCH_DASHBOARD_ENDPOINT");
+    missing.push("OPENSEARCH_ENDPOINT");
   if (!region)
-    missing.push("OPENSEARCH_REGION");
+    missing.push("AWS_REGION");
   if (!roleArn)
     missing.push("AWS_ROLE_ARN");
   if (missing.length > 0) {

package/dist/opensearch.test.js

@@ -20,11 +20,7 @@ import_vitest.vi.mock("@vercel/oidc-aws-credentials-provider", () => ({
     secretAccessKey: "SECRET_TEST"
   }))
 }));
-const ENV_KEYS = [
-  "OPENSEARCH_DASHBOARD_ENDPOINT",
-  "OPENSEARCH_REGION",
-  "AWS_ROLE_ARN"
-];
+const ENV_KEYS = ["OPENSEARCH_ENDPOINT", "AWS_REGION", "AWS_ROLE_ARN"];
 (0, import_vitest.describe)("createOpenSearch", () => {
   const originalEnv = {};
   (0, import_vitest.beforeEach)(() => {
@@ -44,8 +40,8 @@ const ENV_KEYS = [
     }
   });
   (0, import_vitest.test)("uses Vercel-injected env vars when no options are provided", async () => {
-    process.env.OPENSEARCH_DASHBOARD_ENDPOINT = "https://example.aoss.amazonaws.com";
-    process.env.OPENSEARCH_REGION = "us-east-2";
+    process.env.OPENSEARCH_ENDPOINT = "https://example.aoss.amazonaws.com";
+    process.env.AWS_REGION = "us-east-2";
     process.env.AWS_ROLE_ARN = "arn:aws:iam::1234567890:role/vercel-opensearch";
     const client = (0, import_opensearch.createOpenSearch)();
     (0, import_vitest.expect)(import_aws.AwsSigv4Signer).toHaveBeenCalledTimes(1);
@@ -61,8 +57,8 @@ const ENV_KEYS = [
     ).toBe("https://example.aoss.amazonaws.com");
   });
   (0, import_vitest.test)("explicit options override env", () => {
-    process.env.OPENSEARCH_DASHBOARD_ENDPOINT = "https://env-endpoint.example";
-    process.env.OPENSEARCH_REGION = "us-east-2";
+    process.env.OPENSEARCH_ENDPOINT = "https://env-endpoint.example";
+    process.env.AWS_REGION = "us-east-2";
     process.env.AWS_ROLE_ARN = "arn:aws:iam::1:role/env";
     (0, import_opensearch.createOpenSearch)({
       endpoint: "https://override-endpoint.example",
@@ -75,15 +71,13 @@ const ENV_KEYS = [
   });
   (0, import_vitest.test)("throws a helpful error when env vars are missing", () => {
     (0, import_vitest.expect)(() => (0, import_opensearch.createOpenSearch)()).toThrow(
-      /OPENSEARCH_DASHBOARD_ENDPOINT.*OPENSEARCH_REGION.*AWS_ROLE_ARN/
+      /OPENSEARCH_ENDPOINT.*AWS_REGION.*AWS_ROLE_ARN/
     );
   });
   (0, import_vitest.test)("lists only the missing env vars in the error", () => {
-    process.env.OPENSEARCH_DASHBOARD_ENDPOINT = "https://example";
-    process.env.OPENSEARCH_REGION = "us-east-2";
+    process.env.OPENSEARCH_ENDPOINT = "https://example";
+    process.env.AWS_REGION = "us-east-2";
     (0, import_vitest.expect)(() => (0, import_opensearch.createOpenSearch)()).toThrow(/AWS_ROLE_ARN/);
-    (0, import_vitest.expect)(() => (0, import_opensearch.createOpenSearch)()).not.toThrow(
-      /OPENSEARCH_DASHBOARD_ENDPOINT/
-    );
+    (0, import_vitest.expect)(() => (0, import_opensearch.createOpenSearch)()).not.toThrow(/OPENSEARCH_ENDPOINT/);
   });
 });

package/docs/interfaces/CreateOpenSearchOptions.md

@@ -159,7 +159,7 @@ Defined in: node_modules/.pnpm/@opensearch-project+opensearch@3.3.0/node_modules
 Defined in: [packages/aws/src/opensearch.ts:19](https://github.com/vercel/vercel/blob/main/packages/aws/src/opensearch.ts#L19)
 
 The OpenSearch collection endpoint. Defaults to
-`process.env.OPENSEARCH_DASHBOARD_ENDPOINT`.
+`process.env.OPENSEARCH_ENDPOINT`.
 
 ---
 
@@ -314,7 +314,7 @@ Defined in: node_modules/.pnpm/@opensearch-project+opensearch@3.3.0/node_modules
 Defined in: [packages/aws/src/opensearch.ts:24](https://github.com/vercel/vercel/blob/main/packages/aws/src/opensearch.ts#L24)
 
 The AWS region the collection lives in. Defaults to
-`process.env.OPENSEARCH_REGION`.
+`process.env.AWS_REGION`.
 
 ---
 

package/package.json

@@ -18,7 +18,7 @@
       "require": "./dist/opensearch.js"
     }
   },
-  "version": "0.2.0",
+  "version": "0.2.1",
   "repository": {
     "directory": "packages/aws",
     "type": "git",