@upstash/redis 1.19.1 → 1.19.2

package/README.md

@@ -83,8 +83,9 @@ console.log(data)
 
 ## Troubleshooting
 
-We have a [dedicated page](https://docs.upstash.com/troubleshooting) for common
-problems. If you can't find a solution, please
+We have a
+[dedicated page](https://docs.upstash.com/redis/sdks/javascriptsdk/troubleshooting)
+for common problems. If you can't find a solution, please
 [open an issue](https://github.com/upstash/upstash-redis/issues/new).
 
 ## Docs

package/esm/pkg/http.js

@@ -61,6 +61,23 @@ export class HttpClient {
             };
         }
     }
+    mergeTelemetry(telemetry) {
+        function merge(obj, key, value) {
+            if (!value) {
+                return obj;
+            }
+            if (obj[key]) {
+                obj[key] = [obj[key], value].join(",");
+            }
+            else {
+                obj[key] = value;
+            }
+            return obj;
+        }
+        this.headers = merge(this.headers, "Upstash-Telemetry-Runtime", telemetry.runtime);
+        this.headers = merge(this.headers, "Upstash-Telemetry-Platform", telemetry.platform);
+        this.headers = merge(this.headers, "Upstash-Telemetry-Sdk", telemetry.sdk);
+    }
     async request(req) {
         const requestOptions = {
             method: "POST",

package/esm/pkg/redis.js

@@ -43,6 +43,24 @@ export class Redis {
                 this.client.request = (req) => middleware(req, makeRequest);
             }
         });
+        /**
+         * Technically this is not private, we can hide it from intellisense by doing this
+         */
+        Object.defineProperty(this, "addTelemetry", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (telemetry) => {
+                try {
+                    // @ts-ignore - The `Requester` interface does not know about this method but it will be there
+                    // as long as the user uses the standard HttpClient
+                    this.client.mergeTelemetry(telemetry);
+                }
+                catch {
+                    // ignore
+                }
+            }
+        });
         /**
          * Create a new pipeline that allows you to send requests in bulk.
          *

package/esm/version.js

@@ -1 +1 @@
-export const VERSION = "v1.19.1";
+export const VERSION = "v1.19.2";

package/package.json

@@ -3,7 +3,7 @@
   "main": "./script/platforms/nodejs.js",
   "types": "./types/platforms/nodejs.d.ts",
   "name": "@upstash/redis",
-  "version": "v1.19.1",
+  "version": "v1.19.2",
   "description": "An HTTP/REST based Redis client built on top of Upstash REST API.",
   "repository": {
     "type": "git",

package/script/pkg/http.js

@@ -64,6 +64,23 @@ class HttpClient {
             };
         }
     }
+    mergeTelemetry(telemetry) {
+        function merge(obj, key, value) {
+            if (!value) {
+                return obj;
+            }
+            if (obj[key]) {
+                obj[key] = [obj[key], value].join(",");
+            }
+            else {
+                obj[key] = value;
+            }
+            return obj;
+        }
+        this.headers = merge(this.headers, "Upstash-Telemetry-Runtime", telemetry.runtime);
+        this.headers = merge(this.headers, "Upstash-Telemetry-Platform", telemetry.platform);
+        this.headers = merge(this.headers, "Upstash-Telemetry-Sdk", telemetry.sdk);
+    }
     async request(req) {
         const requestOptions = {
             method: "POST",

package/script/pkg/redis.js

@@ -46,6 +46,24 @@ class Redis {
                 this.client.request = (req) => middleware(req, makeRequest);
             }
         });
+        /**
+         * Technically this is not private, we can hide it from intellisense by doing this
+         */
+        Object.defineProperty(this, "addTelemetry", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (telemetry) => {
+                try {
+                    // @ts-ignore - The `Requester` interface does not know about this method but it will be there
+                    // as long as the user uses the standard HttpClient
+                    this.client.mergeTelemetry(telemetry);
+                }
+                catch {
+                    // ignore
+                }
+            }
+        });
         /**
          * Create a new pipeline that allows you to send requests in bulk.
          *

package/script/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = "v1.19.1";
+exports.VERSION = "v1.19.2";

package/types/pkg/http.d.ts

@@ -1,3 +1,4 @@
+import { Telemetry } from "./types.js";
 export declare type UpstashRequest = {
     path?: string[];
     /**
@@ -67,23 +68,7 @@ export declare type HttpClientConfig = {
     options?: Options;
     retry?: RetryConfig;
     agent?: any;
-    telemetry?: {
-        /**
-         * Upstash-Telemetry-Sdk
-         * @example @upstash/redis@v1.1.1
-         */
-        sdk?: string;
-        /**
-         * Upstash-Telemetry-Platform
-         * @example cloudflare
-         */
-        platform?: string;
-        /**
-         * Upstash-Telemetry-Runtime
-         * @example node@v18
-         */
-        runtime?: string;
-    };
+    telemetry?: Telemetry;
 } & RequesterConfig;
 export declare class HttpClient implements Requester {
     baseUrl: string;
@@ -98,5 +83,6 @@ export declare class HttpClient implements Requester {
         backoff: (retryCount: number) => number;
     };
     constructor(config: HttpClientConfig);
+    mergeTelemetry(telemetry: Telemetry): void;
     request<TResult>(req: UpstashRequest): Promise<UpstashResponse<TResult>>;
 }

package/types/pkg/redis.d.ts

@@ -33,6 +33,10 @@ export declare class Redis {
      * Wrap a new middleware around the HTTP client.
      */
     use: <TResult = unknown>(middleware: (r: UpstashRequest, next: <TResult_1 = unknown>(req: UpstashRequest) => Promise<UpstashResponse<TResult_1>>) => Promise<UpstashResponse<TResult>>) => void;
+    /**
+     * Technically this is not private, we can hide it from intellisense by doing this
+     */
+    private addTelemetry;
     createScript(script: string): Script;
     /**
      * Create a new pipeline that allows you to send requests in bulk.

package/types/pkg/types.d.ts

@@ -1 +1,18 @@
 export declare type CommandArgs<TCommand extends new (...args: any) => any> = ConstructorParameters<TCommand>[0];
+export declare type Telemetry = {
+    /**
+     * Upstash-Telemetry-Sdk
+     * @example @upstash/redis@v1.1.1
+     */
+    sdk?: string;
+    /**
+     * Upstash-Telemetry-Platform
+     * @example cloudflare
+     */
+    platform?: string;
+    /**
+     * Upstash-Telemetry-Runtime
+     * @example node@v18
+     */
+    runtime?: string;
+};

package/types/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "v1.19.1";
+export declare const VERSION = "v1.19.2";