@contello/sdk-client 8.21.2 → 8.22.0

package/dist/index.cjs

@@ -1,7 +1,9 @@
 "use strict";
+var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __export = (target, all) => {
   for (var name in all)
@@ -15,6 +17,14 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
@@ -26,6 +36,62 @@ module.exports = __toCommonJS(index_exports);
 
 // src/client.ts
 var import_graphql_ws = require("graphql-ws");
+var import_rxjs2 = require("rxjs");
+
+// src/diagnostics.ts
+var import_node_diagnostics_channel = __toESM(require("diagnostics_channel"), 1);
+var channels = {
+  start: "contello:sdk.start",
+  end: "contello:sdk.end",
+  error: "contello:sdk.error",
+  /** subscribe to decorate outgoing GraphQL WebSocket messages (e.g. inject traceparent) */
+  message: "contello:sdk.message"
+};
+var onStart = import_node_diagnostics_channel.default.channel(channels.start);
+var onEnd = import_node_diagnostics_channel.default.channel(channels.end);
+var onError = import_node_diagnostics_channel.default.channel(channels.error);
+var onMessage = import_node_diagnostics_channel.default.channel(channels.message);
+function hasOperationSubscribers() {
+  return onStart.hasSubscribers || onEnd.hasSubscribers || onError.hasSubscribers;
+}
+function getWrap() {
+  if (!hasOperationSubscribers()) {
+    return void 0;
+  }
+  return (name, fn) => {
+    const start = performance.now();
+    onStart.publish({ name });
+    let result;
+    try {
+      result = fn();
+    } catch (error) {
+      onError.publish({ name, error, durationMs: performance.now() - start });
+      throw error;
+    }
+    if (result instanceof Promise) {
+      return result.then(
+        (r) => {
+          onEnd.publish({ name, durationMs: performance.now() - start });
+          return r;
+        },
+        (error) => {
+          onError.publish({ name, error, durationMs: performance.now() - start });
+          throw error;
+        }
+      );
+    }
+    onEnd.publish({ name, durationMs: performance.now() - start });
+    return result;
+  };
+}
+function decorateMessage(message) {
+  if (!onMessage.hasSubscribers) {
+    return message;
+  }
+  const msg = { message };
+  onMessage.publish(msg);
+  return msg.message;
+}
 
 // src/pool.ts
 var ConnectionPool = class {
@@ -79,7 +145,7 @@ var ConnectionPool = class {
 
 // src/sdk.ts
 var import_rxjs = require("rxjs");
-var createSdk = (client, middlewares, getSdk) => {
+var createSdk = (client, getSdk) => {
   return getSdk((doc, vars, options) => {
     if (options) {
       console.warn("options are not supported yet");
@@ -96,28 +162,16 @@ var createSdk = (client, middlewares, getSdk) => {
       throw new Error("No operation definition found");
     }
     const kind = operationDef.operation;
-    const executeRequest = () => {
+    const execute = () => {
       const wsClient = client();
-      return new import_rxjs.Observable((obs) => wsClient.subscribe({ query, variables: vars }, obs));
+      const res = new import_rxjs.Observable((obs) => wsClient.subscribe({ query, variables: vars }, obs));
+      return kind !== "subscription" ? (0, import_rxjs.firstValueFrom)(res) : res;
     };
-    const request = {
-      kind,
-      operationName: operationDef.name?.value ?? "",
-      query,
-      variables: vars || {}
-    };
-    const executeWithMiddlewares = (middlewares2, index) => {
-      if (index >= middlewares2.length) {
-        return executeRequest();
-      }
-      const middleware = middlewares2[index];
-      if (middleware?.onRequest) {
-        return middleware.onRequest(request, () => executeWithMiddlewares(middlewares2, index + 1));
-      }
-      return executeWithMiddlewares(middlewares2, index + 1);
-    };
-    const res = executeWithMiddlewares(middlewares, 0);
-    return kind !== "subscription" ? (0, import_rxjs.firstValueFrom)(res) : res;
+    const wrapFn = getWrap();
+    if (wrapFn && kind !== "subscription") {
+      return wrapFn(`sdk:${operationDef.name?.value ?? ""}`, execute);
+    }
+    return execute();
   });
 };
 
@@ -140,13 +194,7 @@ var ContelloSdkClient = class {
           shouldRetry: () => true,
           jsonMessageReplacer: (key, value) => {
             if (!key) {
-              let message = value;
-              for (const middleware of params.middlewares ?? []) {
-                if (middleware.onOutgoingMessage) {
-                  message = middleware.onOutgoingMessage(message);
-                }
-              }
-              return message;
+              return decorateMessage(value);
             }
             return value;
           },
@@ -165,7 +213,7 @@ var ContelloSdkClient = class {
       },
       pooling?.enabled === false ? 1 : pooling?.size ?? 5
     );
-    this._sdk = { sdk: createSdk(() => this._pool.get(), params.middlewares ?? [], getSdk) };
+    this._sdk = { sdk: createSdk(() => this._pool.get(), getSdk) };
   }
   get sdk() {
     return this._sdk.sdk;
@@ -176,6 +224,25 @@ var ContelloSdkClient = class {
   async disconnect() {
     await this._pool.disconnect();
   }
+  /**
+   * Subscribes to a raw GraphQL operation against the connection pool.
+   * Returns an Observable that emits each result's data.
+   */
+  subscribe(query, variables) {
+    const wsClient = this._pool.get();
+    return new import_rxjs2.Observable((obs) => wsClient.subscribe({ query, variables }, obs)).pipe(
+      (0, import_rxjs2.map)((r) => r.data)
+    );
+  }
+  /**
+   * Executes a raw GraphQL query/mutation and returns the first result.
+   * Convenience wrapper around subscribe + firstValueFrom.
+   */
+  execute(query, variables) {
+    const fn = () => (0, import_rxjs2.firstValueFrom)(this.subscribe(query, variables));
+    const wrap = getWrap();
+    return wrap ? wrap("sdk:execute", fn) : fn();
+  }
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/index.d.cts

@@ -1,16 +1,6 @@
 import { Observable } from 'rxjs';
 import { DocumentNode, ExecutionResult } from 'graphql';
 
-type ContelloSdkClientMiddleware = {
-    onRequest?: (request: {
-        kind: 'query' | 'mutation' | 'subscription';
-        operationName: string;
-        query: string;
-        variables: Record<string, any>;
-    }, next: () => Observable<any>) => Observable<any>;
-    onOutgoingMessage?: (message: any) => any;
-};
-
 type Requester<C = any, E = unknown> = <R, V>(doc: DocumentNode, vars?: V, options?: C) => Promise<ExecutionResult<R, E>> | Observable<ExecutionResult<R, E>>;
 
 type ClientEventContext = {
@@ -21,7 +11,6 @@ type ContelloSdkClientParams = {
     url: string;
     project: string;
     token: string;
-    middlewares?: ContelloSdkClientMiddleware[] | undefined;
     pooling?: {
         enabled?: boolean | undefined;
         size?: number | undefined;
@@ -45,6 +34,16 @@ declare class ContelloSdkClient<T> {
     get sdk(): T;
     connect(): Promise<void>;
     disconnect(): Promise<void>;
+    /**
+     * Subscribes to a raw GraphQL operation against the connection pool.
+     * Returns an Observable that emits each result's data.
+     */
+    subscribe<TData>(query: string, variables?: Record<string, unknown> | undefined): Observable<TData>;
+    /**
+     * Executes a raw GraphQL query/mutation and returns the first result.
+     * Convenience wrapper around subscribe + firstValueFrom.
+     */
+    execute<TData>(query: string, variables?: Record<string, unknown> | undefined): Promise<TData>;
 }
 
-export { ContelloSdkClient, type ContelloSdkClientMiddleware, type ContelloSdkClientParams };
+export { ContelloSdkClient, type ContelloSdkClientParams };

package/dist/index.d.ts

@@ -1,16 +1,6 @@
 import { Observable } from 'rxjs';
 import { DocumentNode, ExecutionResult } from 'graphql';
 
-type ContelloSdkClientMiddleware = {
-    onRequest?: (request: {
-        kind: 'query' | 'mutation' | 'subscription';
-        operationName: string;
-        query: string;
-        variables: Record<string, any>;
-    }, next: () => Observable<any>) => Observable<any>;
-    onOutgoingMessage?: (message: any) => any;
-};
-
 type Requester<C = any, E = unknown> = <R, V>(doc: DocumentNode, vars?: V, options?: C) => Promise<ExecutionResult<R, E>> | Observable<ExecutionResult<R, E>>;
 
 type ClientEventContext = {
@@ -21,7 +11,6 @@ type ContelloSdkClientParams = {
     url: string;
     project: string;
     token: string;
-    middlewares?: ContelloSdkClientMiddleware[] | undefined;
     pooling?: {
         enabled?: boolean | undefined;
         size?: number | undefined;
@@ -45,6 +34,16 @@ declare class ContelloSdkClient<T> {
     get sdk(): T;
     connect(): Promise<void>;
     disconnect(): Promise<void>;
+    /**
+     * Subscribes to a raw GraphQL operation against the connection pool.
+     * Returns an Observable that emits each result's data.
+     */
+    subscribe<TData>(query: string, variables?: Record<string, unknown> | undefined): Observable<TData>;
+    /**
+     * Executes a raw GraphQL query/mutation and returns the first result.
+     * Convenience wrapper around subscribe + firstValueFrom.
+     */
+    execute<TData>(query: string, variables?: Record<string, unknown> | undefined): Promise<TData>;
 }
 
-export { ContelloSdkClient, type ContelloSdkClientMiddleware, type ContelloSdkClientParams };
+export { ContelloSdkClient, type ContelloSdkClientParams };

package/dist/index.js

@@ -1,5 +1,61 @@
 // src/client.ts
 import { createClient } from "graphql-ws";
+import { Observable as Observable2, firstValueFrom as firstValueFrom2, map } from "rxjs";
+
+// src/diagnostics.ts
+import dc from "diagnostics_channel";
+var channels = {
+  start: "contello:sdk.start",
+  end: "contello:sdk.end",
+  error: "contello:sdk.error",
+  /** subscribe to decorate outgoing GraphQL WebSocket messages (e.g. inject traceparent) */
+  message: "contello:sdk.message"
+};
+var onStart = dc.channel(channels.start);
+var onEnd = dc.channel(channels.end);
+var onError = dc.channel(channels.error);
+var onMessage = dc.channel(channels.message);
+function hasOperationSubscribers() {
+  return onStart.hasSubscribers || onEnd.hasSubscribers || onError.hasSubscribers;
+}
+function getWrap() {
+  if (!hasOperationSubscribers()) {
+    return void 0;
+  }
+  return (name, fn) => {
+    const start = performance.now();
+    onStart.publish({ name });
+    let result;
+    try {
+      result = fn();
+    } catch (error) {
+      onError.publish({ name, error, durationMs: performance.now() - start });
+      throw error;
+    }
+    if (result instanceof Promise) {
+      return result.then(
+        (r) => {
+          onEnd.publish({ name, durationMs: performance.now() - start });
+          return r;
+        },
+        (error) => {
+          onError.publish({ name, error, durationMs: performance.now() - start });
+          throw error;
+        }
+      );
+    }
+    onEnd.publish({ name, durationMs: performance.now() - start });
+    return result;
+  };
+}
+function decorateMessage(message) {
+  if (!onMessage.hasSubscribers) {
+    return message;
+  }
+  const msg = { message };
+  onMessage.publish(msg);
+  return msg.message;
+}
 
 // src/pool.ts
 var ConnectionPool = class {
@@ -53,7 +109,7 @@ var ConnectionPool = class {
 
 // src/sdk.ts
 import { Observable, firstValueFrom } from "rxjs";
-var createSdk = (client, middlewares, getSdk) => {
+var createSdk = (client, getSdk) => {
   return getSdk((doc, vars, options) => {
     if (options) {
       console.warn("options are not supported yet");
@@ -70,28 +126,16 @@ var createSdk = (client, middlewares, getSdk) => {
       throw new Error("No operation definition found");
     }
     const kind = operationDef.operation;
-    const executeRequest = () => {
+    const execute = () => {
       const wsClient = client();
-      return new Observable((obs) => wsClient.subscribe({ query, variables: vars }, obs));
+      const res = new Observable((obs) => wsClient.subscribe({ query, variables: vars }, obs));
+      return kind !== "subscription" ? firstValueFrom(res) : res;
     };
-    const request = {
-      kind,
-      operationName: operationDef.name?.value ?? "",
-      query,
-      variables: vars || {}
-    };
-    const executeWithMiddlewares = (middlewares2, index) => {
-      if (index >= middlewares2.length) {
-        return executeRequest();
-      }
-      const middleware = middlewares2[index];
-      if (middleware?.onRequest) {
-        return middleware.onRequest(request, () => executeWithMiddlewares(middlewares2, index + 1));
-      }
-      return executeWithMiddlewares(middlewares2, index + 1);
-    };
-    const res = executeWithMiddlewares(middlewares, 0);
-    return kind !== "subscription" ? firstValueFrom(res) : res;
+    const wrapFn = getWrap();
+    if (wrapFn && kind !== "subscription") {
+      return wrapFn(`sdk:${operationDef.name?.value ?? ""}`, execute);
+    }
+    return execute();
   });
 };
 
@@ -114,13 +158,7 @@ var ContelloSdkClient = class {
           shouldRetry: () => true,
           jsonMessageReplacer: (key, value) => {
             if (!key) {
-              let message = value;
-              for (const middleware of params.middlewares ?? []) {
-                if (middleware.onOutgoingMessage) {
-                  message = middleware.onOutgoingMessage(message);
-                }
-              }
-              return message;
+              return decorateMessage(value);
             }
             return value;
           },
@@ -139,7 +177,7 @@ var ContelloSdkClient = class {
       },
       pooling?.enabled === false ? 1 : pooling?.size ?? 5
     );
-    this._sdk = { sdk: createSdk(() => this._pool.get(), params.middlewares ?? [], getSdk) };
+    this._sdk = { sdk: createSdk(() => this._pool.get(), getSdk) };
   }
   get sdk() {
     return this._sdk.sdk;
@@ -150,6 +188,25 @@ var ContelloSdkClient = class {
   async disconnect() {
     await this._pool.disconnect();
   }
+  /**
+   * Subscribes to a raw GraphQL operation against the connection pool.
+   * Returns an Observable that emits each result's data.
+   */
+  subscribe(query, variables) {
+    const wsClient = this._pool.get();
+    return new Observable2((obs) => wsClient.subscribe({ query, variables }, obs)).pipe(
+      map((r) => r.data)
+    );
+  }
+  /**
+   * Executes a raw GraphQL query/mutation and returns the first result.
+   * Convenience wrapper around subscribe + firstValueFrom.
+   */
+  execute(query, variables) {
+    const fn = () => firstValueFrom2(this.subscribe(query, variables));
+    const wrap = getWrap();
+    return wrap ? wrap("sdk:execute", fn) : fn();
+  }
 };
 export {
   ContelloSdkClient

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contello/sdk-client",
-  "version": "8.21.2",
+  "version": "8.22.0",
   "description": "GraphQL SDK client for Contello CMS with WebSocket transport and connection pooling",
   "type": "module",
   "license": "MIT",
@@ -23,8 +23,8 @@
   },
   "devDependencies": {
     "rxjs": "^7.8.2",
-    "graphql": "^16.11.0",
-    "graphql-ws": "^6.0.6"
+    "graphql": "^16.13.1",
+    "graphql-ws": "^6.0.7"
   },
   "files": [
     "dist"