V2: Replace MethodUnaryDescriptor with DescMethodUnary from `@buf…

…build/protobuf` (#448)
connectrpc · Oct 9, 2024 · 8a87c00 · 8a87c00
1 parent bf9728f
commit 8a87c00
Show file tree

Hide file tree

Showing 26 changed files with 789 additions and 833 deletions.
diff --git a/examples/react/basic/package.json b/examples/react/basic/package.json
@@ -14,8 +14,8 @@
   },
   "dependencies": {
     "@bufbuild/buf": "1.43.0",
-    "@bufbuild/protobuf": "^2.1.0",
-    "@bufbuild/protoc-gen-es": "^2.1.0",
+    "@bufbuild/protobuf": "^2.2.0",
+    "@bufbuild/protoc-gen-es": "^2.2.0",
     "@connectrpc/connect": "^2.0.0-beta.1",
     "@connectrpc/connect-query": "workspace:*",
     "@connectrpc/connect-web": "^2.0.0-beta.1",
@@ -26,10 +26,10 @@
     "@testing-library/react": "^16.0.1",
     "@types/react": "^18.3.5",
     "@types/react-dom": "^18.3.0",
-    "@vitejs/plugin-react": "^4.3.1",
+    "@vitejs/plugin-react": "^4.3.2",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
     "typescript": "^5.5.4",
-    "vite": "^5.4.7"
+    "vite": "^5.4.8"
   }
 }
diff --git a/examples/react/basic/src/gen/eliza_pb.ts b/examples/react/basic/src/gen/eliza_pb.ts
@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// @generated by protoc-gen-es v2.1.0 with parameter "target=ts"
+// @generated by protoc-gen-es v2.2.0 with parameter "target=ts"
 // @generated from file eliza.proto (package connectrpc.eliza.v1, syntax proto3)
 /* eslint-disable */
 

diff --git a/package.json b/package.json
@@ -26,7 +26,7 @@
     "@typescript-eslint/eslint-plugin": "7.15.0",
     "@typescript-eslint/parser": "7.15.0",
     "@typescript-eslint/utils": "7.15.0",
-    "@vitest/ui": "^2.1.1",
+    "@vitest/ui": "^2.1.2",
     "cspell": "8.14.2",
     "eslint": "8.57.0",
     "eslint-config-prettier": "9.1.0",
@@ -39,7 +39,7 @@
     "prettier": "3.3.3",
     "turbo": "^2.1.1",
     "typescript": "5.5.4",
-    "vitest": "^2.1.1"
+    "vitest": "^2.1.2"
   },
   "engineStrict": true,
   "engines": {

diff --git a/packages/connect-query/package.json b/packages/connect-query/package.json
@@ -31,8 +31,8 @@
     "@arethetypeswrong/cli": "^0.15.4",
     "@bufbuild/buf": "1.43.0",
     "@bufbuild/jest-environment-jsdom": "^0.1.1",
-    "@bufbuild/protobuf": "^2.1.0",
-    "@bufbuild/protoc-gen-es": "^2.1.0",
+    "@bufbuild/protobuf": "^2.2.0",
+    "@bufbuild/protoc-gen-es": "^2.2.0",
     "@connectrpc/connect": "^2.0.0-beta.1",
     "@connectrpc/connect-web": "^2.0.0-beta.1",
     "@tanstack/react-query": "^5.53.3",

diff --git a/packages/connect-query/src/call-unary-method.ts b/packages/connect-query/src/call-unary-method.ts
@@ -14,14 +14,13 @@
 
 import type {
   DescMessage,
+  DescMethodUnary,
   MessageInitShape,
   MessageShape,
 } from "@bufbuild/protobuf";
 import { create } from "@bufbuild/protobuf";
 import type { Transport } from "@connectrpc/connect";
 
-import type { MethodUnaryDescriptor } from "./method-unary-descriptor.js";
-
 /**
  * Call a unary method given its signature and input.
  */
@@ -31,7 +30,7 @@ export async function callUnaryMethod<
   O extends DescMessage,
 >(
   transport: Transport,
-  schema: MethodUnaryDescriptor<I, O>,
+  schema: DescMethodUnary<I, O>,
   input: MessageInitShape<I> | undefined,
   options?: {
     signal?: AbortSignal;

diff --git a/packages/connect-query/src/connect-query-key.ts b/packages/connect-query/src/connect-query-key.ts
@@ -150,9 +150,10 @@ type KeyParams<Desc extends DescMethod | DescService> = Desc extends DescMethod
  *
  * @see ConnectQueryKey for information on the components of Connect-Query's keys.
  */
-export function createConnectQueryKey<Desc extends DescMethod | DescService>(
-  params: KeyParams<Desc>,
-): ConnectQueryKey {
+export function createConnectQueryKey<
+  Desc extends DescMethod | DescService,
+  Params extends KeyParams<Desc>,
+>(params: Params): ConnectQueryKey {
   const props: ConnectQueryKey[1] =
     params.schema.kind == "rpc"
       ? {

diff --git a/packages/connect-query/src/create-infinite-query-options.ts b/packages/connect-query/src/create-infinite-query-options.ts
@@ -14,6 +14,7 @@
 
 import type {
   DescMessage,
+  DescMethodUnary,
   MessageInitShape,
   MessageShape,
 } from "@bufbuild/protobuf";
@@ -32,7 +33,6 @@ import {
   type ConnectQueryKey,
   createConnectQueryKey,
 } from "./connect-query-key.js";
-import type { MethodUnaryDescriptor } from "./method-unary-descriptor.js";
 import { createStructuralSharing } from "./structural-sharing.js";
 import { assert } from "./utils.js";
 
@@ -60,7 +60,7 @@ function createUnaryInfiniteQueryFn<
   ParamKey extends keyof MessageInitShape<I>,
 >(
   transport: Transport,
-  schema: MethodUnaryDescriptor<I, O>,
+  schema: DescMethodUnary<I, O>,
   input: MessageInitShape<I>,
   {
     pageParamKey,
@@ -93,7 +93,7 @@ export function createInfiniteQueryOptions<
   O extends DescMessage,
   ParamKey extends keyof MessageInitShape<I>,
 >(
-  schema: MethodUnaryDescriptor<I, O>,
+  schema: DescMethodUnary<I, O>,
   input:
     | SkipToken
     | (MessageInitShape<I> & Required<Pick<MessageInitShape<I>, ParamKey>>),

diff --git a/packages/connect-query/src/create-query-options.ts b/packages/connect-query/src/create-query-options.ts
@@ -14,6 +14,7 @@
 
 import type {
   DescMessage,
+  DescMethodUnary,
   MessageInitShape,
   MessageShape,
 } from "@bufbuild/protobuf";
@@ -30,12 +31,11 @@ import { skipToken } from "@tanstack/react-query";
 import { callUnaryMethod } from "./call-unary-method.js";
 import type { ConnectQueryKey } from "./connect-query-key.js";
 import { createConnectQueryKey } from "./connect-query-key.js";
-import type { MethodUnaryDescriptor } from "./method-unary-descriptor.js";
 import { createStructuralSharing } from "./structural-sharing.js";
 
 function createUnaryQueryFn<I extends DescMessage, O extends DescMessage>(
   transport: Transport,
-  schema: MethodUnaryDescriptor<I, O>,
+  schema: DescMethodUnary<I, O>,
   input: MessageInitShape<I> | undefined,
 ): QueryFunction<MessageShape<O>, ConnectQueryKey> {
   return async (context) => {
@@ -52,7 +52,7 @@ export function createQueryOptions<
   I extends DescMessage,
   O extends DescMessage,
 >(
-  schema: MethodUnaryDescriptor<I, O>,
+  schema: DescMethodUnary<I, O>,
   input: SkipToken | MessageInitShape<I> | undefined,
   {
     transport,

diff --git a/packages/connect-query/src/gen/bigint_pb.ts b/packages/connect-query/src/gen/bigint_pb.ts
@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// @generated by protoc-gen-es v2.1.0 with parameter "target=ts"
+// @generated by protoc-gen-es v2.2.0 with parameter "target=ts"
 // @generated from file bigint.proto (syntax proto3)
 /* eslint-disable */
 

diff --git a/packages/connect-query/src/gen/eliza_pb.ts b/packages/connect-query/src/gen/eliza_pb.ts
@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// @generated by protoc-gen-es v2.1.0 with parameter "target=ts"
+// @generated by protoc-gen-es v2.2.0 with parameter "target=ts"
 // @generated from file eliza.proto (package connectrpc.eliza.v1, syntax proto3)
 /* eslint-disable */
 

diff --git a/packages/connect-query/src/gen/list_pb.ts b/packages/connect-query/src/gen/list_pb.ts
@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// @generated by protoc-gen-es v2.1.0 with parameter "target=ts"
+// @generated by protoc-gen-es v2.2.0 with parameter "target=ts"
 // @generated from file list.proto (syntax proto3)
 /* eslint-disable */
 

diff --git a/packages/connect-query/src/gen/proto2_pb.ts b/packages/connect-query/src/gen/proto2_pb.ts
@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// @generated by protoc-gen-es v2.1.0 with parameter "target=ts"
+// @generated by protoc-gen-es v2.2.0 with parameter "target=ts"
 // @generated from file proto2.proto (package test, syntax proto2)
 /* eslint-disable */
 

diff --git a/packages/connect-query/src/gen/proto3_pb.ts b/packages/connect-query/src/gen/proto3_pb.ts
@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// @generated by protoc-gen-es v2.1.0 with parameter "target=ts"
+// @generated by protoc-gen-es v2.2.0 with parameter "target=ts"
 // @generated from file proto3.proto (package test, syntax proto3)
 /* eslint-disable */
 

diff --git a/packages/connect-query/src/index.ts b/packages/connect-query/src/index.ts
@@ -25,7 +25,6 @@ export type { UseMutationOptions } from "./use-mutation.js";
 export { useMutation } from "./use-mutation.js";
 export type { ConnectUpdater } from "./utils.js";
 export { callUnaryMethod } from "./call-unary-method.js";
-export type { MethodUnaryDescriptor } from "./method-unary-descriptor.js";
 export { createInfiniteQueryOptions } from "./create-infinite-query-options.js";
 export { createQueryOptions } from "./create-query-options.js";
 export type { UseInfiniteQueryOptions } from "./use-infinite-query.js";

diff --git a/packages/connect-query/src/method-unary-descriptor.ts b/packages/connect-query/src/method-unary-descriptor.ts
diff --git a/packages/connect-query/src/use-infinite-query.ts b/packages/connect-query/src/use-infinite-query.ts
@@ -14,6 +14,7 @@
 
 import type {
   DescMessage,
+  DescMethodUnary,
   MessageInitShape,
   MessageShape,
 } from "@bufbuild/protobuf";
@@ -34,7 +35,6 @@ import {
 import type { ConnectQueryKey } from "./connect-query-key.js";
 import type { ConnectInfiniteQueryOptions } from "./create-infinite-query-options.js";
 import { createInfiniteQueryOptions } from "./create-infinite-query-options.js";
-import type { MethodUnaryDescriptor } from "./method-unary-descriptor.js";
 import { useTransport } from "./use-transport.js";
 
 /**
@@ -68,7 +68,7 @@ export function useInfiniteQuery<
   O extends DescMessage,
   ParamKey extends keyof MessageInitShape<I>,
 >(
-  schema: MethodUnaryDescriptor<I, O>,
+  schema: DescMethodUnary<I, O>,
   input:
     | SkipToken
     | (MessageInitShape<I> & Required<Pick<MessageInitShape<I>, ParamKey>>),
@@ -122,7 +122,7 @@ export function useSuspenseInfiniteQuery<
   O extends DescMessage,
   ParamKey extends keyof MessageInitShape<I>,
 >(
-  schema: MethodUnaryDescriptor<I, O>,
+  schema: DescMethodUnary<I, O>,
   input: MessageInitShape<I> & Required<Pick<MessageInitShape<I>, ParamKey>>,
   {
     transport,

diff --git a/packages/connect-query/src/use-mutation.ts b/packages/connect-query/src/use-mutation.ts
@@ -14,6 +14,7 @@
 
 import type {
   DescMessage,
+  DescMethodUnary,
   MessageInitShape,
   MessageShape,
 } from "@bufbuild/protobuf";
@@ -26,7 +27,6 @@ import { useMutation as tsUseMutation } from "@tanstack/react-query";
 import { useCallback } from "react";
 
 import { callUnaryMethod } from "./call-unary-method.js";
-import type { MethodUnaryDescriptor } from "./method-unary-descriptor.js";
 import { useTransport } from "./use-transport.js";
 
 /**
@@ -54,7 +54,7 @@ export function useMutation<
   O extends DescMessage,
   Ctx = unknown,
 >(
-  schema: MethodUnaryDescriptor<I, O>,
+  schema: DescMethodUnary<I, O>,
   { transport, ...queryOptions }: UseMutationOptions<I, O, Ctx> = {},
 ): UseMutationResult<MessageShape<O>, ConnectError, MessageInitShape<I>, Ctx> {
   const transportFromCtx = useTransport();

diff --git a/packages/connect-query/src/use-query.ts b/packages/connect-query/src/use-query.ts
@@ -14,6 +14,7 @@
 
 import type {
   DescMessage,
+  DescMethodUnary,
   MessageInitShape,
   MessageShape,
 } from "@bufbuild/protobuf";
@@ -32,7 +33,6 @@ import {
 
 import type { ConnectQueryKey } from "./connect-query-key.js";
 import { createQueryOptions } from "./create-query-options.js";
-import type { MethodUnaryDescriptor } from "./method-unary-descriptor.js";
 import { useTransport } from "./use-transport.js";
 
 /**
@@ -62,7 +62,7 @@ export function useQuery<
   O extends DescMessage,
   SelectOutData = MessageShape<O>,
 >(
-  schema: MethodUnaryDescriptor<I, O>,
+  schema: DescMethodUnary<I, O>,
   input?: SkipToken | MessageInitShape<I>,
   { transport, ...queryOptions }: UseQueryOptions<O, SelectOutData> = {},
 ): UseQueryResult<SelectOutData, ConnectError> {
@@ -103,7 +103,7 @@ export function useSuspenseQuery<
   O extends DescMessage,
   SelectOutData = MessageShape<O>,
 >(
-  schema: MethodUnaryDescriptor<I, O>,
+  schema: DescMethodUnary<I, O>,
   input?: MessageInitShape<I>,
   {
     transport,

diff --git a/packages/connect-query/src/utils.ts b/packages/connect-query/src/utils.ts
@@ -14,13 +14,12 @@
 
 import type {
   DescMessage,
+  DescMethodUnary,
   MessageInitShape,
   MessageShape,
 } from "@bufbuild/protobuf";
 import { create, isMessage } from "@bufbuild/protobuf";
 
-import type { MethodUnaryDescriptor } from "./method-unary-descriptor.js";
-
 /**
  * Throws an error with the provided message when the condition is `false`
  */
@@ -64,7 +63,7 @@ export type ConnectUpdater<O extends DescMessage> =
  */
 export const createProtobufSafeUpdater =
   <O extends DescMessage>(
-    schema: Pick<MethodUnaryDescriptor<never, O>, "output">,
+    schema: Pick<DescMethodUnary<never, O>, "output">,
     updater: ConnectUpdater<O>,
   ) =>
   (prev?: MessageShape<O>): MessageShape<O> | undefined => {

diff --git a/packages/protoc-gen-connect-query/package.json b/packages/protoc-gen-connect-query/package.json
@@ -28,15 +28,15 @@
   "preferUnplugged": true,
   "devDependencies": {
     "@bufbuild/buf": "1.43.0",
-    "@bufbuild/protoc-gen-es": "^2.1.0",
+    "@bufbuild/protoc-gen-es": "^2.2.0",
     "@connectrpc/connect": "^2.0.0-beta.1",
     "@connectrpc/connect-query": "workspace:*",
     "@tanstack/react-query": "^5.56.2",
     "typescript": "^5.5.4"
   },
   "dependencies": {
-    "@bufbuild/protobuf": "^2.1.0",
-    "@bufbuild/protoplugin": "^2.1.0"
+    "@bufbuild/protobuf": "^2.2.0",
+    "@bufbuild/protoplugin": "^2.2.0"
   },
   "peerDependencies": {
     "@bufbuild/protoc-gen-es": "1.x"

diff --git a/packages/protoc-gen-connect-query/snapshots/gen_cjs/test_pb.d.ts b/packages/protoc-gen-connect-query/snapshots/gen_cjs/test_pb.d.ts
@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// @generated by protoc-gen-es v2.1.0 with parameter "js_import_style=legacy_commonjs,import_extension=js"
+// @generated by protoc-gen-es v2.2.0 with parameter "js_import_style=legacy_commonjs,import_extension=js"
 // @generated from file test.proto (package test, syntax proto3)
 /* eslint-disable */
 

diff --git a/packages/protoc-gen-connect-query/snapshots/gen_cjs/test_pb.js b/packages/protoc-gen-connect-query/snapshots/gen_cjs/test_pb.js
@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// @generated by protoc-gen-es v2.1.0 with parameter "js_import_style=legacy_commonjs,import_extension=js"
+// @generated by protoc-gen-es v2.2.0 with parameter "js_import_style=legacy_commonjs,import_extension=js"
 // @generated from file test.proto (package test, syntax proto3)
 /* eslint-disable */