validate options and support env

unjs · May 5, 2023 · ca64677 · ca64677
1 parent c8e12de
commit ca64677
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 7 deletions.
diff --git a/docs/content/6.drivers/vercel-kv.md b/docs/content/6.drivers/vercel-kv.md
@@ -8,9 +8,10 @@ import vercelKVDriver from "unstorage/drivers/vercel-kv";
 
 const storage = createStorage({
   driver: vercelKVDriver({
-    // base: "unstorage",
-    url: "https://<your-project-slug>.kv.vercel-storage.com",
-    token: "<your secret token>",
+    // url: "https://<your-project-slug>.kv.vercel-storage.com", // KV_REST_API_URL
+    // token: "<your secret token>", // KV_REST_API_TOKEN
+    // base: "test",
+    // env: "KV",
   }),
 });
 ```
@@ -29,7 +30,9 @@ To use, you will need to install `@vercel/kv` dependency in your project:
 
 **Options:**
 
-- `base`: Optional prefix to use for all keys. Can be used for namespacing.
-- `url`: Url to use for connecting to your Vercel KV store. It has the format `https://<your-project-slug>.kv.vercel-storage.com`
+- `url`: Rest API URL to use for connecting to your Vercel KV store. Default is `KV_REST_API_URL`.
+- `token`: Rest API Token to use for connecting to your Vercel KV store. Default is `KV_REST_API_TOKEN`.
+- `base`: [optional] Prefix to use for all keys. Can be used for namespacing.
+- `env`: [optional] Flag to customzize environment variable prefix (Default is `KV`). Set to `false` to disable env inference for `url` and `token` options.
 
 See [@upstash/redis](https://docs.upstash.com/redis/sdks/javascriptsdk/advanced) for all available options.
diff --git a/src/drivers/vercel-kv.ts b/src/drivers/vercel-kv.ts
@@ -4,8 +4,9 @@ import type { RedisConfigNodejs } from "@upstash/redis";
 
 import { defineDriver, normalizeKey, joinKeys } from "./utils";
 
-export interface VercelKVOptions extends RedisConfigNodejs {
+export interface VercelKVOptions extends Partial<RedisConfigNodejs> {
   base?: string;
+  env?: false | string;
 }
 
 export default defineDriver<VercelKVOptions>((opts) => {
@@ -14,7 +15,22 @@ export default defineDriver<VercelKVOptions>((opts) => {
 
   let _client: VercelKV;
   const getClient = () => {
-    if (!_client  ) {
+    if (!_client) {
+      const envPrefix = typeof process !== "undefined" && opts.env !== false ? `${opts.env || "KV"}_` : "";
+      if (!opts.url) {
+        if (envPrefix && process.env[envPrefix + 'REST_API_URL']) {
+          opts.url = process.env[envPrefix + 'REST_API_URL'];
+        } else {
+          throw new Error('[unstorage] [vercel-kv] missing required `url` option or `KV_REST_API_URL` env.');
+        }
+      }
+      if (!opts.token) {
+        if (envPrefix && process.env[envPrefix + 'REST_API_TOKEN']) {
+          opts.token = process.env[envPrefix + 'REST_API_TOKEN'];
+        } else {
+          throw new Error('[unstorage] [vercel-kv] missing required `token` option or `KV_REST_API_TOKEN` env.');
+        }
+      }
       _client = createClient(opts);
     }
     return _client;