Querry KitQuerry Kit
@querry-kit/nuxt GitHub

Getting started

Runtime requirements

The next major release requires Node.js 26.13.0 or newer and drops Node.js 24 support. Upgrade application runtimes and CI before updating. Published package versions remain unchanged until the release workflow runs.

Install the core package and its peers:

pnpm add @querry-kit/nuxt axios @vueuse/core @vueuse/router vue vue-router

Create the HTTP client in the consumer application, where runtime configuration and authentication belong:

import { createApiClient } from '@querry-kit/nuxt/api';

const api = createApiClient({
  apiBaseUrl: runtimeConfig.public.apiBaseUrl,
  getToken: () => authStore.token,
});

The client targets /api/v1, adds Request-Source and Timezone headers, and only sends an Authorization header when getToken returns a token.

OptionDefaultUse it for
apiBaseUrl—The backend origin. A trailing slash is accepted.
getTokenno headerResolving the latest token per request. It may be async.
resolveBaseUrlidentityTenant/workspace host rewriting before the API path is added.
requestSourcewebBackends that distinguish clients through Request-Source.
getTimezonebrowser timezoneAn explicit timezone; return undefined to omit it.

Then model resources once and receive typed CRUD payloads:

type Resources = {
  books: {
    item: { id: string; title: string };
    create: { title: string };
    update: { title?: string };
  };
};

const books = useModuleApi<Resources, 'books'>(api, 'books');
await books.update('book-1', { title: 'New title' });

useModuleApi exposes query, get, findById, count, create, update, and delete. Its endpoint argument accepts either books or /books; identifiers are URL encoded.

Before integrating tables or autocompletes, verify that the backend exposes the required routes and { items, meta } response shape in the controller contract.

TanStack Table is not a direct dependency of these composables; install the dependencies required by your chosen table renderer. Stored table preferences are validated and reset to defaults when malformed or unreadable. Autocomplete reacts to nested query mutations and stops loading when a pending selection is cleared.

Controller Contract