V2: Introduce connect-query-core package

packages/connect-query-core/.eslintignore

@@ -0,0 +1,3 @@
+dist
+coverage
+src/gen

packages/connect-query-core/README.md

@@ -0,0 +1,3 @@
+# @connectrpc/connect-query-core
+
+This package provides the core functionality for the Connect Query API. It exposes all the necessary functions to use with the different variants of the tanstack/query packages. Documentation for these APIs can be found in the main repo readme at https://github.com/connectrpc/connect-query-es and covers any non-hook functions (anything that doesn't start with `use`).

packages/connect-query-core/buf.gen.yaml

@@ -0,0 +1,12 @@
+# buf.gen.yaml defines a local generation template.
+# For details, see https://buf.build/docs/configuration/v2/buf-gen-yaml
+version: v2
+inputs:
+  - directory: proto
+# Deletes the directories specified in the `out` field for all plugins before running code generation.
+clean: true
+plugins:
+  - local: protoc-gen-es
+    out: src/gen
+    opt:
+      - target=ts

packages/connect-query-core/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@connectrpc/connect-query-core",
+  "version": "2.0.0-rc.2",
+  "description": "Core of connect-query, framework agnostic helpers for typescript safe queries.",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/connectrpc/connect-query-es.git",
+    "directory": "packages/connect-query-core"
+  },
+  "scripts": {
+    "clean": "rm -rf ./dist/*",
+    "build": "npm run build:cjs && npm run build:esm",
+    "build:cjs": "tsc --project tsconfig.build.json --module commonjs --moduleResolution node10 --verbatimModuleSyntax false --outDir ./dist/cjs --declarationDir ./dist/cjs && echo >./dist/cjs/package.json '{\"type\":\"commonjs\"}'",
+    "build:esm": "tsc --project tsconfig.build.json",
+    "generate": "buf generate",
+    "test": "vitest --run",
+    "test:watch": "vitest --watch",
+    "format": "prettier . --write --ignore-path ./.eslintignore && eslint . --fix && license-header",
+    "attw": "attw --pack"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/cjs/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    }
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.15.2",
+    "@bufbuild/buf": "1.43.0",
+    "@bufbuild/jest-environment-jsdom": "^0.1.1",
+    "@bufbuild/protobuf": "^2.2.0",
+    "@bufbuild/protoc-gen-es": "^2.2.0",
+    "@connectrpc/connect": "^2.0.0-rc.1",
+    "@connectrpc/connect-web": "^2.0.0-rc.1",
+    "typescript": "^5.5.4"
+  },
+  "peerDependencies": {
+    "@bufbuild/protobuf": "2.x",
+    "@connectrpc/connect": "^2.0.0-rc.1",
+    "@tanstack/query-core": "5.x"
+  }
+}

packages/connect-query-core/proto/bigint.proto

@@ -0,0 +1,30 @@
+// Copyright 2021-2023 The Connect Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+import "google/protobuf/empty.proto";
+
+service BigIntService {
+  rpc Count(CountRequest) returns (CountResponse);
+  rpc GetCount(google.protobuf.Empty) returns (CountResponse);
+}
+
+message CountRequest {
+  int64 add = 1;
+}
+
+message CountResponse {
+  int64 count = 1;
+}

packages/connect-query-core/proto/eliza.proto

@@ -0,0 +1,38 @@
+// Copyright 2021-2023 The Connect Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package connectrpc.eliza.v1;
+
+// ElizaService provides a way to talk to Eliza, a port of the DOCTOR script
+// for Joseph Weizenbaum's original ELIZA program. Created in the mid-1960s at
+// the MIT Artificial Intelligence Laboratory, ELIZA demonstrates the
+// superficiality of human-computer communication. DOCTOR simulates a
+// psychotherapist, and is commonly found as an Easter egg in emacs
+// distributions.
+service ElizaService {
+  // Say is a unary RPC. Eliza responds to the prompt with a single sentence.
+  rpc Say(SayRequest) returns (SayResponse) {}
+}
+
+// SayRequest is a single-sentence request.
+message SayRequest {
+  string sentence = 1;
+}
+
+// SayResponse is a single-sentence response.
+message SayResponse {
+  string sentence = 1;
+}

packages/connect-query-core/proto/list.proto

@@ -0,0 +1,30 @@
+// Copyright 2021-2023 The Connect Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+service ListService {
+  rpc List(ListRequest) returns (ListResponse);
+}
+
+message ListRequest {
+  int64 page = 1;
+  bool preview = 2;
+}
+
+message ListResponse {
+  int64 page = 1;
+  repeated string items = 2;
+}
+

packages/connect-query-core/proto/proto2.proto

@@ -0,0 +1,21 @@
+// Copyright 2021-2023 The Connect Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto2";
+package test;
+
+message Proto2Message {
+  optional string string_field = 1;
+  optional int32 int32_field = 3;
+}

packages/connect-query-core/proto/proto3.proto

@@ -0,0 +1,49 @@
+// Copyright 2021-2023 The Connect Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+package test;
+
+// Note: We do not exhaust all field types
+message Proto3Message {
+  string string_field = 1;
+  bytes bytes_field = 2;
+  int32 int32_field = 3;
+  int64 int64_field = 4;
+  double double_field = 5;
+  bool bool_field = 6;
+  Proto3Enum enum_field = 7;
+  Proto3Message message_field = 8;
+
+  optional string optional_string_field = 9;
+
+  repeated string repeated_string_field = 17;
+  repeated Proto3Message repeated_message_field = 18;
+  repeated Proto3Enum repeated_enum_field = 19;
+
+  oneof either {
+    string oneof_string_field = 31;
+    int32 oneof_int32_field = 33;
+  }
+
+  map<string, int64> map_string_int64_field = 39;
+  map<string, Proto3Message> map_string_message_field = 40;
+  map<string, Proto3Enum> map_string_enum_field = 41;
+}
+
+enum Proto3Enum {
+  PROTO3_ENUM_UNSPECIFIED = 0;
+  PROTO3_ENUM_YES = 1;
+  PROTO3_ENUM_NO = 2;
+}

packages/connect-query/src/connect-query-key.test.ts → packages/connect-query-core/src/connect-query-key.test.ts

@@ -14,12 +14,12 @@
 
 import { create } from "@bufbuild/protobuf";
 import type { Transport } from "@connectrpc/connect";
-import { skipToken } from "@tanstack/react-query";
 import { describe, expect, it } from "vitest";
 
 import { createConnectQueryKey } from "./connect-query-key.js";
 import { ElizaService, SayRequestSchema } from "./gen/eliza_pb.js";
 import { ListRequestSchema, ListService } from "./gen/list_pb.js";
+import { skipToken } from "./index.js";
 import { createMessageKey } from "./message-key.js";
 import { createTransportKey } from "./transport-key.js";
 

packages/connect-query/src/connect-query-key.ts → packages/connect-query-core/src/connect-query-key.ts

@@ -18,7 +18,7 @@ import type {
   MessageInitShape,
 } from "@bufbuild/protobuf";
 import type { Transport } from "@connectrpc/connect";
-import type { SkipToken } from "@tanstack/react-query";
+import type { SkipToken } from "@tanstack/query-core";
 
 import { createMessageKey } from "./message-key.js";
 import { createTransportKey } from "./transport-key.js";

packages/connect-query/src/create-infinite-query-options.ts → packages/connect-query-core/src/create-infinite-query-options.ts

@@ -24,8 +24,8 @@ import type {
   QueryFunction,
   QueryKey,
   SkipToken,
-} from "@tanstack/react-query";
-import { skipToken } from "@tanstack/react-query";
+} from "@tanstack/query-core";
+import { skipToken } from "@tanstack/query-core";
 
 import { callUnaryMethod } from "./call-unary-method.js";
 import {

packages/connect-query/src/create-query-options.test.ts → packages/connect-query-core/src/create-query-options.test.ts

@@ -12,12 +12,13 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import { skipToken } from "@tanstack/react-query";
+import { skipToken as tanstackSkipToken } from "@tanstack/query-core";
 import { describe, expect, expectTypeOf, it } from "vitest";
 
 import { createConnectQueryKey } from "./connect-query-key.js";
 import { createQueryOptions } from "./create-query-options.js";
 import { ElizaService } from "./gen/eliza_pb.js";
+import { skipToken } from "./index.js";
 import { mockEliza } from "./test/test-utils.js";
 
 // TODO: maybe create a helper to take a service and method and generate this.
@@ -33,6 +34,14 @@ describe("createQueryOptions", () => {
     expect(opt.queryFn).toBe(skipToken);
     expectTypeOf(opt.queryFn).toEqualTypeOf(skipToken);
   });
+
+  it("honors skipToken directly from tanstack", () => {
+    const opt = createQueryOptions(sayMethodDescriptor, tanstackSkipToken, {
+      transport: mockedElizaTransport,
+    });
+    expect(opt.queryFn).toBe(tanstackSkipToken);
+  });
+
   it("sets queryKey", () => {
     const want = createConnectQueryKey({
       schema: sayMethodDescriptor,

packages/connect-query/src/create-query-options.ts → packages/connect-query-core/src/create-query-options.ts

@@ -20,8 +20,8 @@ import type {
 } from "@bufbuild/protobuf";
 import { create } from "@bufbuild/protobuf";
 import type { Transport } from "@connectrpc/connect";
-import type { QueryFunction, SkipToken } from "@tanstack/react-query";
-import { skipToken } from "@tanstack/react-query";
+import type { QueryFunction, SkipToken } from "@tanstack/query-core";
+import { skipToken } from "@tanstack/query-core";
 
 import { callUnaryMethod } from "./call-unary-method.js";
 import type { ConnectQueryKey } from "./connect-query-key.js";