V2: Replace MethodInfo with Descriptor Types

packages/connect-web/src/connect-transport.ts

@@ -30,7 +30,8 @@ import type {
   UnaryRequest,
   UnaryResponse,
   ContextValues,
-  MethodInfo,
+  DescMethodUnary,
+  DescMethodStreaming,
 } from "@connectrpc/connect";
 import {
   Code,
@@ -140,7 +141,7 @@ export function createConnectTransport(
   const useBinaryFormat = options.useBinaryFormat ?? false;
   return {
     async unary<I extends DescMessage, O extends DescMessage>(
-      method: MethodInfo<I, O>,
+      method: DescMethodUnary<I, O>,
       signal: AbortSignal | undefined,
       timeoutMs: number | undefined,
       header: HeadersInit | undefined,
@@ -238,7 +239,7 @@ export function createConnectTransport(
     },
 
     async stream<I extends DescMessage, O extends DescMessage>(
-      method: MethodInfo<I, O>,
+      method: DescMethodStreaming<I, O>,
       signal: AbortSignal | undefined,
       timeoutMs: number | undefined,
       header: HeadersInit | undefined,

packages/connect-web/src/grpc-web-transport.ts

@@ -28,7 +28,8 @@ import type {
   UnaryRequest,
   UnaryResponse,
   ContextValues,
-  MethodInfo,
+  DescMethodUnary,
+  DescMethodStreaming,
 } from "@connectrpc/connect";
 import { createContextValues, ConnectError, Code } from "@connectrpc/connect";
 import {
@@ -130,7 +131,7 @@ export function createGrpcWebTransport(
   const useBinaryFormat = options.useBinaryFormat ?? true;
   return {
     async unary<I extends DescMessage, O extends DescMessage>(
-      method: MethodInfo<I, O>,
+      method: DescMethodUnary<I, O>,
       signal: AbortSignal | undefined,
       timeoutMs: number | undefined,
       header: Headers,
@@ -241,7 +242,7 @@ export function createGrpcWebTransport(
     },
 
     async stream<I extends DescMessage, O extends DescMessage>(
-      method: MethodInfo<I, O>,
+      method: DescMethodStreaming<I, O>,
       signal: AbortSignal | undefined,
       timeoutMs: number | undefined,
       header: HeadersInit | undefined,

packages/connect/src/any-client.ts

@@ -12,8 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import type { DescService } from "@bufbuild/protobuf";
-import type { MethodInfo } from "./types.js";
+import type { DescMethod, DescService } from "@bufbuild/protobuf";
 
 /**
  * AnyClient is an arbitrary service client with any method signature.
@@ -25,7 +24,7 @@ export type AnyClient = Record<string, AnyClientMethod>;
 
 type AnyClientMethod = (...args: any[]) => any; // eslint-disable-line @typescript-eslint/no-explicit-any
 
-type CreateAnyClientMethod = (method: MethodInfo) => AnyClientMethod | null;
+type CreateAnyClientMethod = (method: DescMethod) => AnyClientMethod | null;
 
 /**
  * Create any client for the given service.

packages/connect/src/callback-client.ts

@@ -25,7 +25,11 @@ import { Code } from "./code.js";
 import { makeAnyClient } from "./any-client.js";
 import type { CallOptions } from "./call-options.js";
 import { createAsyncIterable } from "./protocol/async-iterable.js";
-import type { MethodInfoServerStreaming, MethodInfoUnary } from "./types.js";
+import type {
+  DescMethodServerStreaming,
+  DescMethodStreaming,
+  DescMethodUnary,
+} from "./types.js";
 
 // prettier-ignore
 /**
@@ -48,8 +52,8 @@ import type { MethodInfoServerStreaming, MethodInfoUnary } from "./types.js";
 export type CallbackClient<Desc extends DescService> =
   {
     [P in keyof Desc["method"]]:
-      Desc["method"][P] extends MethodInfoUnary<infer I, infer O> ? (request: MessageInitShape<I>, callback: (error: ConnectError | undefined, response: MessageShape<O>) => void, options?: CallOptions) => CancelFn
-    : Desc["method"][P] extends MethodInfoServerStreaming<infer I, infer O> ? (request: MessageInitShape<I>, messageCallback: (response: MessageShape<O>) => void, closeCallback: (error: ConnectError | undefined) => void, options?: CallOptions) => CancelFn
+    Desc["method"][P] extends DescMethodUnary<infer I, infer O> ? (request: MessageInitShape<I>, callback: (error: ConnectError | undefined, response: MessageShape<O>) => void, options?: CallOptions) => CancelFn
+    : Desc["method"][P] extends DescMethodServerStreaming<infer I, infer O> ? (request: MessageInitShape<I>, messageCallback: (response: MessageShape<O>) => void, closeCallback: (error: ConnectError | undefined) => void, options?: CallOptions) => CancelFn
     : never;
   }
 
@@ -63,16 +67,19 @@ export function createCallbackClient<T extends DescService>(
   service: T,
   transport: Transport,
 ) {
-  return makeAnyClient(service, (method) => {
-    switch (method.methodKind) {
-      case "unary":
-        return createUnaryFn(transport, method);
-      case "server_streaming":
-        return createServerStreamingFn(transport, method);
-      default:
-        return null;
-    }
-  }) as CallbackClient<T>;
+  return makeAnyClient(
+    service,
+    (method: DescMethodUnary | DescMethodStreaming) => {
+      switch (method.methodKind) {
+        case "unary":
+          return createUnaryFn(transport, method);
+        case "server_streaming":
+          return createServerStreamingFn(transport, method);
+        default:
+          return null;
+      }
+    },
+  ) as CallbackClient<T>;
 }
 
 /**
@@ -89,7 +96,7 @@ type UnaryFn<I extends DescMessage, O extends DescMessage> = (
 
 function createUnaryFn<I extends DescMessage, O extends DescMessage>(
   transport: Transport,
-  method: MethodInfoUnary<I, O>,
+  method: DescMethodUnary<I, O>,
 ): UnaryFn<I, O> {
   return function (requestMessage, callback, options) {
     const abort = new AbortController();
@@ -135,7 +142,7 @@ type ServerStreamingFn<I extends DescMessage, O extends DescMessage> = (
 
 function createServerStreamingFn<I extends DescMessage, O extends DescMessage>(
   transport: Transport,
-  method: MethodInfoServerStreaming<I, O>,
+  method: DescMethodServerStreaming<I, O>,
 ): ServerStreamingFn<I, O> {
   return function (input, onResponse, onClose, options) {
     const abort = new AbortController();

packages/connect/src/implementation.ts

@@ -28,11 +28,11 @@ import {
 import { createContextValues } from "./context-values.js";
 import type { ContextValues } from "./context-values.js";
 import type {
-  MethodInfoBiDiStreaming,
-  MethodInfoClientStreaming,
-  MethodInfo,
-  MethodInfoServerStreaming,
-  MethodInfoUnary,
+  DescMethodBiDiStreaming,
+  DescMethodClientStreaming,
+  DescMethodServerStreaming,
+  DescMethodStreaming,
+  DescMethodUnary,
 } from "./types.js";
 
 // prettier-ignore
@@ -47,11 +47,11 @@ export type ServiceImpl<Desc extends DescService> = {
 /**
  * MethodImpl is the signature of the implementation of an RPC.
  */
-export type MethodImpl<M extends MethodInfo> =
-  M extends MethodInfoUnary<infer I, infer O> ? UnaryImpl<I, O>
-  : M extends MethodInfoServerStreaming<infer I, infer O> ? ServerStreamingImpl<I, O>
-  : M extends MethodInfoClientStreaming<infer I, infer O> ? ClientStreamingImpl<I, O>
-  : M extends MethodInfoBiDiStreaming<infer I, infer O> ? BiDiStreamingImpl<I, O>
+export type MethodImpl<M extends DescMethod> =
+  M extends DescMethodUnary<infer I, infer O> ? UnaryImpl<I, O>
+  : M extends DescMethodServerStreaming<infer I, infer O> ? ServerStreamingImpl<I, O>
+  : M extends DescMethodClientStreaming<infer I, infer O> ? ClientStreamingImpl<I, O>
+  : M extends DescMethodBiDiStreaming<infer I, infer O> ? BiDiStreamingImpl<I, O>
   : never;
 
 /**
@@ -232,15 +232,11 @@ export type BiDiStreamingImpl<I extends DescMessage, O extends DescMessage> = (
  * metadata in a discriminated union type.
  */
 export type MethodImplSpec<I extends DescMessage = DescMessage, O extends DescMessage = DescMessage> =
-  {
-    method: MethodInfo<I, O>;
-  }
-  & (
-    | { kind: "unary"; impl: UnaryImpl<I, O> }
-    | { kind: "server_streaming"; impl: ServerStreamingImpl<I, O> }
-    | { kind: "client_streaming"; impl: ClientStreamingImpl<I, O> }
-    | { kind: "bidi_streaming"; impl: BiDiStreamingImpl<I, O> }
-  );
+  | { kind: "unary";            impl: UnaryImpl<I, O>;            method: DescMethodUnary<I, O> }
+  | { kind: "server_streaming"; impl: ServerStreamingImpl<I, O>;  method: DescMethodServerStreaming<I, O> }
+  | { kind: "client_streaming"; impl: ClientStreamingImpl<I, O>;  method: DescMethodClientStreaming<I, O> }
+  | { kind: "bidi_streaming";   impl: BiDiStreamingImpl<I, O>;    method: DescMethodBiDiStreaming<I, O> }
+;
 
 /**
  * Wraps a user-provided service implementation and provides metadata.
@@ -256,7 +252,7 @@ export type ServiceImplSpec = {
  * Create an MethodImplSpec - a user-provided implementation for a method,
  * wrapped in a discriminated union type along with service and method metadata.
  */
-export function createMethodImplSpec<M extends MethodInfo>(
+export function createMethodImplSpec<M extends DescMethod>(
   method: M,
   impl: MethodImpl<M>,
 ): MethodImplSpec {
@@ -277,7 +273,8 @@ export function createServiceImplSpec<Desc extends DescService>(
 ): ServiceImplSpec {
   const s: ServiceImplSpec = { service, methods: {} };
   for (const method of service.methods) {
-    let fn: MethodImpl<MethodInfo> | undefined = impl[method.localName];
+    let fn: MethodImpl<DescMethodUnary | DescMethodStreaming> | undefined =
+      impl[method.localName];
     if (typeof fn == "function") {
       fn = fn.bind(impl);
     } else {
@@ -287,7 +284,7 @@ export function createServiceImplSpec<Desc extends DescService>(
       };
     }
     s.methods[method.localName] = createMethodImplSpec(
-      method as MethodInfo,
+      method as DescMethodUnary | DescMethodStreaming,
       fn,
     );
   }

packages/connect/src/index.ts

@@ -56,5 +56,4 @@ export {
 } from "./implementation.js";
 export type { ServiceImplSpec, MethodImplSpec } from "./implementation.js";
 export { createRouterTransport } from "./router-transport.js";
-
-export type { MethodInfo } from "./types.js";
+export type { DescMethodUnary, DescMethodStreaming } from "./types.js"; // TODO: Remove once exported from @bufbuild/protobuf

packages/connect/src/interceptor.ts

@@ -14,12 +14,11 @@
 
 import type {
   DescMessage,
-  DescMethod,
   DescService,
   MessageShape,
 } from "@bufbuild/protobuf";
 import type { ContextValues } from "./context-values.js";
-import type { MethodInfo } from "./types.js";
+import type { DescMethodStreaming, DescMethodUnary } from "./types.js";
 
 /**
  * An interceptor can add logic to clients or servers, similar to the decorators
@@ -67,7 +66,7 @@ type AnyFn = (
 export interface UnaryRequest<
   I extends DescMessage = DescMessage,
   O extends DescMessage = DescMessage,
-> extends RequestCommon<I, O> {
+> extends RequestCommon {
   /**
    * The `stream` property discriminates between UnaryRequest and
    * StreamingRequest.
@@ -78,6 +77,11 @@ export interface UnaryRequest<
    * The input message that will be transmitted.
    */
   readonly message: MessageShape<I>;
+
+  /**
+   * Metadata related to the service method that is being called.
+   */
+  readonly method: DescMethodUnary<I, O>;
 }
 
 /**
@@ -87,7 +91,7 @@ export interface UnaryRequest<
 export interface UnaryResponse<
   I extends DescMessage = DescMessage,
   O extends DescMessage = DescMessage,
-> extends ResponseCommon<I, O> {
+> extends ResponseCommon {
   /**
    * The `stream` property discriminates between UnaryResponse and
    * StreamingConn.
@@ -98,6 +102,11 @@ export interface UnaryResponse<
    * The received output message.
    */
   readonly message: MessageShape<O>;
+
+  /**
+   * Metadata related to the service method that is being called.
+   */
+  readonly method: DescMethodUnary<I, O>;
 }
 
 /**
@@ -107,7 +116,7 @@ export interface UnaryResponse<
 export interface StreamRequest<
   I extends DescMessage = DescMessage,
   O extends DescMessage = DescMessage,
-> extends RequestCommon<I, O> {
+> extends RequestCommon {
   /**
    * The `stream` property discriminates between UnaryRequest and
    * StreamingRequest.
@@ -118,6 +127,11 @@ export interface StreamRequest<
    * The input messages that will be transmitted.
    */
   readonly message: AsyncIterable<MessageShape<I>>;
+
+  /**
+   * Metadata related to the service method that is being called.
+   */
+  readonly method: DescMethodStreaming<I, O>;
 }
 
 /**
@@ -127,7 +141,7 @@ export interface StreamRequest<
 export interface StreamResponse<
   I extends DescMessage = DescMessage,
   O extends DescMessage = DescMessage,
-> extends ResponseCommon<I, O> {
+> extends ResponseCommon {
   /**
    * The `stream` property discriminates between UnaryResponse and
    * StreamingConn.
@@ -138,12 +152,17 @@ export interface StreamResponse<
    * The output messages.
    */
   readonly message: AsyncIterable<MessageShape<O>>;
+
+  /**
+   * Metadata related to the service method that is being called.
+   */
+  readonly method: DescMethodStreaming<I, O>;
 }
 
 /**
  * @private
  */
-export interface RequestCommon<I extends DescMessage, O extends DescMessage> {
+export interface RequestCommon {
   /**
    * Metadata related to the service that is being called.
    */
@@ -155,11 +174,6 @@ export interface RequestCommon<I extends DescMessage, O extends DescMessage> {
    */
   readonly requestMethod: string;
 
-  /**
-   * Metadata related to the service method that is being called.
-   */
-  readonly method: MethodInfo<I, O>;
-
   /**
    * The URL the request is going to hit for the clients or the
    * URL received by the server.
@@ -185,17 +199,12 @@ export interface RequestCommon<I extends DescMessage, O extends DescMessage> {
 /**
  * @private
  */
-export interface ResponseCommon<I extends DescMessage, O extends DescMessage> {
+export interface ResponseCommon {
   /**
    * Metadata related to the service that is being called.
    */
   readonly service: DescService;
 
-  /**
-   * Metadata related to the service method that is being called.
-   */
-  readonly method: DescMethod & { readonly input: I; readonly output: O };
-
   /**
    * Headers received from the response.
    */