connect-query-es

What's Changed

• Pass abort signal to transport for mutations by @paul-sachs in https://github.com/connectrpc/connect-query-es/pull/351

Full Changelog: https://github.com/connectrpc/connect-query-es/compare/v1.3.0...v1.3.1

What's Changed

• Prevent using extendible input type by @paul-sachs in https://github.com/connectrpc/connect-query-es/pull/345
• Expose internal methods used to create query options by @paul-sachs in https://github.com/connectrpc/connect-query-es/pull/343

Full Changelog: https://github.com/connectrpc/connect-query-es/compare/v1.2.0...v1.3.0

What's Changed

• Add a distinguishing factor between infinite query keys and regular query keys by @paul-sachs in https://github.com/connectrpc/connect-query-es/pull/334
• Add support for enabled to useInfiniteQuery by @paul-sachs in https://github.com/connectrpc/connect-query-es/pull/338

Changes to infinite query keys

With https://github.com/connectrpc/connect-query-es/pull/334, we're fixing a bug where the cache of a regular query collides with the cache of an infinite query, which can lead to type mismatches and unexpected failures if you use the same RPC with an infinite query and a regular query.
We are now using a separate query key for infinite queries to solve the issue (we append "infinite" to the key), but this change can potentially affect you:

If you tried to invalidate some infinite queries like queryClient.invalidateQueries({ queryKey: createConnectQueryKey(...), exact: true }), this now only invalidates queries initialized with useQuery. To invalidate infinite queries, you can either set exact to false, or use createConnectInfiniteQueryKey() instead. Also note that this change not only affects invalidateQueries but any operations against the queryClient that interact with the cache using a key (eg, queryClient.setQueriesData, etc.)

Full Changelog: https://github.com/connectrpc/connect-query-es/compare/v1.1.3...v1.2.0

What's Changed

• Add interceptor example to readme by @paul-sachs in https://github.com/connectrpc/connect-query-es/pull/313
• Make sure to take into account enabled queryOption by @paul-sachs in https://github.com/connectrpc/connect-query-es/pull/318

Full Changelog: https://github.com/connectrpc/connect-query-es/compare/v1.1.2...v1.1.3

What's Changed

• Remove ESM wrapper by @paul-sachs in https://github.com/connectrpc/connect-query-es/pull/312

Full Changelog: https://github.com/connectrpc/connect-query-es/compare/v1.1.1...v1.1.2

What's Changed

• Fix dual package hazard in nodejs by @paul-sachs in https://github.com/connectrpc/connect-query-es/pull/310

Full Changelog: https://github.com/connectrpc/connect-query-es/compare/v1.1.0...v1.1.1

What's Changed

• Update imports to include file extensions by @paul-sachs in https://github.com/connectrpc/connect-query-es/pull/299 and https://github.com/connectrpc/connect-query-es/pull/307
• Added support for cjs output by @paul-sachs in https://github.com/connectrpc/connect-query-es/pull/303
• Loosen peer dependency requirement by @paul-sachs in https://github.com/connectrpc/connect-query-es/pull/306

CJS output

By default, protoc-gen-connect-query (and all other plugins based on @bufbuild/protoplugin) generate ECMAScript import and export statements. For use cases where CommonJS is difficult to avoid, a new plugin option has been added named js_import_style which can be used to generate CommonJS require() calls.

Here is an example buf.gen.yaml:

version: v1
plugins:
  # You'll need @bufbuild/protoc-gen-es v1.6.0 or later
  - plugin: es
    out: src/gen
    opt: js_import_style=legacy_commonjs
  - plugin: protoc-gen-connect-query
    out: src/gen
    opt: js_import_style=legacy_commonjs

To view the full PR, see Added support for cjs output by @paul-sachs in https://github.com/connectrpc/connect-query-es/pull/303

Full Changelog: https://github.com/connectrpc/connect-query-es/compare/v1.0.0...v1.1.0

What's Changed

• V1 API: Wrapping react-query by @paul-sachs in https://github.com/connectrpc/connect-query-es/pull/224

V1 Release 🚀

Introducing a whole new API for connect-query. This API ties itself more tightly with the fantastic @tanstack/react-query in order to improve developer experience and reduce bundle size.

At the core of this change is the new MethodUnaryDescriptor type, which is essentially just a self contained description of a service method. The new code generator just outputs one of these per method and those are passed to the hooks/methods. This new additional type brings a huge level of flexibility about how we write additional methods, and it's trivial to write your own hooks/methods around these simple types.

Example usage

import { useQuery } from "@connectrpc/connect-query";
import { say } from "./gen/eliza-ElizaService_connectquery";

...

const { data } = useQuery(say);

Breaking changes

• use*Query hooks now return data instead of just options.
• Many create* methods have been removed.
• protoc-gen-connect-query now outputs very simple method descriptors instead of a bunch of hooks per method.

Reasoning

There are a number of reasons we've decided to make this major breaking change.

1. The API surface is much smaller, leading to less confusion about how to use each method.
2. Smaller core code size and more modular organization leads to better tree shaking (since each generated method doesn't come along with a generated hook).
3. Package names are now explicit about their dependencies, making it easier to develop other packages based on these packages/generated code.
4. More tightly integrating with @tanstack/react-query@5 provides better usage of Suspense versions of the API.
5. New generated code is easier to expand and build your own custom hooks for.

Migration

The migration process is easy but manual:

Before

import { getUserOrganization } from "@apigen/org/alpha/registry/v1alpha1/organization-OrganizationService_connectquery";
import { useQuery } from "@tanstack/react-query";

...

const getUserOrganizationQuery = useQuery({
    ...getUserOrganization.useQuery({
      userId: currentUser?.id,
      organizationId,
    }),
    useErrorBoundary: false,
    enabled: currentUser !== null,
});

After

import { getUserOrganization } from "@apigen/org/alpha/registry/v1alpha1/organization-OrganizationService_connectquery";
import { useQuery } from "@connectrpc/connect-query";

...

const getUserOrganizationQuery = useQuery(getUserOrganization, {
      userId: currentUser?.id,
      organizationId,
    },
    {
      useErrorBoundary: false,
      enabled: currentUser !== null
    }
});

Full Changelog: https://github.com/connectrpc/connect-query-es/compare/v0.6.0...v1.0.0

What's Changed

• Update to react-query@5 by @paul-sachs in https://github.com/connectrpc/connect-query-es/pull/179

Update to react-query@5

This update contains some breaking changes including, but not limited to:

• Removed onError passed to useQuery, this aligns with the removed event handlers in @tanstack/query
• useInfiniteQuery now requires the initial page param to be defined in the input because initialPageParam is required

Full Changelog: https://github.com/connectrpc/connect-query-es/compare/v0.5.3...v0.6.0

What's Changed

• Properly reference imports for module type by @paul-sachs in https://github.com/connectrpc/connect-query-es/pull/217

Full Changelog: https://github.com/connectrpc/connect-query-es/compare/v0.5.2...v0.5.3

What's Changed

• Remove experimental plugin by @paul-sachs in https://github.com/connectrpc/connect-query-es/pull/178
• Add ESM wrapper to avoid dual package hazard by @timostamm in https://github.com/connectrpc/connect-query-es/pull/180
• Fix missing implicit types by @mckelveygreg in https://github.com/connectrpc/connect-query-es/pull/211

New Contributors

• @mckelveygreg made their first contribution in https://github.com/connectrpc/connect-query-es/pull/211

Full Changelog: https://github.com/connectrpc/connect-query-es/compare/v0.5.1...v0.5.2

What's Changed

• Extract React specific dependencies into single file by @paul-sachs in https://github.com/connectrpc/connect-query-es/pull/169
• Split js/ts generator by @paul-sachs in https://github.com/connectrpc/connect-query-es/pull/176

Full Changelog: https://github.com/connectrpc/connect-query-es/compare/v0.4.4...v0.5.1

Summary of breaking changes

Changes in @connectrpc/connect-query

Breaking changes

• Removed UnaryHooks type and replaced with UnaryFunctionsWithHooks
• Updated createUnaryHooks to only return the hooks and not other functions

New functions

createUnaryFunctions

Introduced createUnaryFunctions which can be used with the new createUnaryHooks to do the same thing as the old createUnaryHooks. The reasoning behind this change is to prep the core library, connect-query, to be able to used separately from React itself and this is just the first step in that direction.

Changes in code generated by protoc-gen-connect-query and protoc-gen-connect-query-react

New functions

Each service method now generates two new functions associated to the method:

method.createUseInfiniteQueryOptions

This method creates options that will pass to useInfiniteQuery. It is identical to method.useInfiniteQuery except it needs to be passed a transport directly.

createUseMutationOptions

This method creates options that will pass to useMutation. It is identical to method.useMutation except it needs to be passed a transport directly.

We added these methods to better future-proof the code for incoming changes to React (React Server Components, etc).

Migration

• Replace any usages of the type UnaryHooks with UnaryFunctionsWithHooks
• Find any usages of createUnaryHooks and use a combination of createUnaryHooks and createUnaryFunctions

Before

const say = createUnaryHooks(ExampleService);

After

const say = {
  ...createUnaryHooks(ExampleService),
  ...createUnaryFunctions(ExampleService),
}

What's Changed

• Avoid as const in js extension by @paul-sachs in https://github.com/connectrpc/connect-query-es/pull/167

New Contributors

• @smallsamantha made their first contribution in https://github.com/connectrpc/connect-query-es/pull/163

Full Changelog: https://github.com/connectrpc/connect-query-es/compare/v0.4.3...v0.4.4

What's Changed

• Add testing example to examples directory by @paul-sachs in https://github.com/connectrpc/connect-query-es/pull/125
• Export service type from generated services by @paul-sachs in https://github.com/connectrpc/connect-query-es/pull/159

Testing simplification

Exported serviced type allows you to directly use service with createRouterTransport from @connectrpc/connect with the exported service:

import { createRouterTransport } from "@connectrpc/connect";
import { ElizaService } from "./gen/eliza-ElizaService_connectquery";

...

const transport = createRouterTransport(({ service }) => {
  service(ElizaService, {
    say: () => ({
      sentence: "Hello, world!",
    }),
  });
});

For more details, see example test here.

Full Changelog: https://github.com/connectrpc/connect-query-es/compare/v0.4.2...v0.4.3

What's Changed

To keep Connect well-maintained and responsive to its users' needs over the long term, we're preparing to donate it to a foundation. (More details on that soon!) To cleanly separate Connect from Buf's other code, we're moving development to the connectrpc GitHub organization and to the connectrpc organization on npmjs.com.

This is the first release that publishes packages with the new @connectrpc scope. To make the switch seamless, we are introducing a small tool that updates all references in your project automatically, @connectrpc/connect-migrate.

The switch is as simple as running a single command:

$ npx @connectrpc/connect-migrate@latest
Scanning... ✓
    1 package.json file
    1 lock file
    5 source files
Updating source files... 
  src/client.ts ✓
  src/server.ts ✓
  src/webclient.ts ✓
Updating packages... ✓
  package.json ✓
Updating lock file... 
  package-lock.json ✓

Full Changelog: https://github.com/connectrpc/connect-query-es/compare/v0.4.1...v0.4.2

What's Changed

• Use corepack to guarantee pnpm version by @paul-sachs in https://github.com/bufbuild/connect-query/pull/60
• Update protoc-gen-connect-query to output RPC idempotency by @timostamm in https://github.com/bufbuild/connect-query/pull/63
• Feat: Additional plugin to generate connect-query with hooks by @vctqs1 in https://github.com/bufbuild/connect-query/pull/59
• Update readme with some references to react specific plugin by @paul-sachs in https://github.com/bufbuild/connect-query/pull/64
• Release protoc-gen-connect-query-react by @paul-sachs in https://github.com/bufbuild/connect-query/pull/65
• Add import-hook-form to table of contents in protoc-gen-connect-query-react readme by @vctqs1 in https://github.com/bufbuild/connect-query/pull/68
• Update references by @smaye81 in https://github.com/bufbuild/connect-query/pull/72
• Fix: react-query typescript in connect-query-plugin by @vctqs1 in https://github.com/bufbuild/connect-query/pull/69

New Contributors

• @timostamm made their first contribution in https://github.com/bufbuild/connect-query/pull/63
• @vctqs1 made their first contribution in https://github.com/bufbuild/connect-query/pull/59
• @dependabot made their first contribution in https://github.com/bufbuild/connect-query/pull/66

Full Changelog: https://github.com/bufbuild/connect-query/compare/v0.4.0...v0.4.1