@mobx-query/core 0.2.0

package/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

package/README.md

@@ -0,0 +1,98 @@
+# DISCLAIMER: This project is still in development and I don't know when I'm going to finish it, but still feel free to check it out.
+
+# mobx-query
+
+**Combine the best of react-query and mobx** — mobx-query provides a thin integration layer that uses React Query for fetching/invalidations and MobX for storing and mutating observable entities. It supports optimistic mutations with automatic rollbacks on error and automatic invalidation of dependent queries on success.
+
+# Features
+
+- Normalize query responses into a single observable Map per collection.
+  
+- Hooks make it easy to work with data. Use [useSuspenseQueryEntitiesList](#sample-section) and [useSuspenseQueryEntity](#sample-section) to fetch and hydrate entities. For mutations, [useCreateMutation](#sample-section) and [useDeleteMutation](#sample-section) handle collection-level changes with optimistic updates and invalidations, while [useUpdateMutation](#sample-section) lets you update a single entity directly.
+  
+- Optimistic updates with automatic query invalidation on successful mutations and rollbacks on error.
+  
+- Fine-grained, mutable entities powered by MobX (observable fields & actions).
+
+# Quick example
+
+Create the observable entity and wire it into a collection.
+
+```ts
+// Your observable entity 
+class Todo {
+  id: number;
+  userId: number;
+  @observable accessor title: string;
+  @observable accessor isCompleted: boolean;
+
+  constructor(data: TodoDTO) {
+    this.id = data.id;
+    this.userId = data.userId;
+    this.title = data.title;
+    this.isCompleted = data.completed;
+  }
+}
+
+// Collection for a Todo entity
+class TodosCollection extends EntityCollection<TodoDTO, Todo> {
+  constructor() {
+    super("todos", queryClient, {
+      getEntityId: (todo) => todo.id,
+      hydrate: (todo) => new Todo(todo), // wrap data from queries into observable states
+    });
+  }
+
+  useTodosByUserIdQuery(userId: number) {
+    return this.useSuspenseQueryEntitiesList(getTodosByUserId, userId);
+  }
+
+  useDeleteTodoMutation(entity: TodoHydrated) {
+    return this.useDeleteMutation(entity, (entity) => deleteTodo(entity.id));
+  }
+}
+
+type TodoHydrated = EntityHydrated<Todo>;
+
+const todosCollection = new TodosCollection();
+```
+
+Use hook from a collection to fetch and retrieve obserbable data
+
+```ts
+const TodosList: React.FC<{ userId: number }> = () => {
+  const todos = todosCollection.useTodosByUserIdQuery(userId);
+
+   return <List items={todos} />;
+};
+```
+
+Mutate entity with automatic queries invalidation on mutation success and rollback on error
+
+```ts
+const TodoListItem: React.FC<{ todo: TodoHydrated }> = ({ todo }) => {
+  const deleteTodo = todosCollection.useDeleteTodoMutation(todo);
+
+  const update = todo.useUpdateMutation(entity => updateTodo(entity));
+
+  const handleEditTitle = () => {
+    const value = prompt("Update title", todo.title);
+
+    if (value) {
+      todo.title = value;
+      update();
+    }
+  };
+
+  return (
+    <div>
+      {todo.title}
+      <button onClick={handleEditTitle}>
+        Edit
+      </button>
+      <button onClick={deleteTodo}>
+        Delete
+      </button>
+    </div>
+  );
+};

package/eslint.config.js

@@ -0,0 +1,29 @@
+import js from "@eslint/js";
+import globals from "globals";
+import reactHooks from "eslint-plugin-react-hooks";
+import reactRefresh from "eslint-plugin-react-refresh";
+import tseslint from "typescript-eslint";
+import { globalIgnores } from "eslint/config";
+
+export default tseslint.config([
+  globalIgnores(["dist"]),
+  {
+    files: ["**/*.{ts,tsx}"],
+    extends: [
+      js.configs.recommended,
+      tseslint.configs.recommended,
+      reactHooks.configs["recommended-latest"],
+      reactRefresh.configs.vite,
+    ],
+    languageOptions: {
+      ecmaVersion: 2020,
+      globals: globals.browser,
+    },
+    rules: {
+      "@typescript-eslint/no-explicit-any": "off",
+      "@typescript-eslint/no-unsafe-function-type": "off",
+      "react-hooks/rules-of-hooks": "off",
+      "@typescript-eslint/no-empty-object-type": "off",
+    },
+  },
+]);

package/index.html

@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Vite + React + TS</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@mobx-query/core",
+  "version": "0.2.0",
+  "type": "module",
+  "author": "smashboy",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc -b && vite build",
+    "lint": "eslint .",
+    "preview": "vite preview"
+  },
+  "exports": {
+    "./client": {
+      "import": "./dist/client.js"
+    },
+    "./entity": {
+      "import": "./dist/entity.js"
+    },
+    "./mutations": {
+      "import": "./dist/mutations.js"
+    },
+    "./queries": {
+      "import": "./dist/queries.js"
+    },
+    "./react": {
+      "import": "./dist/react.js"
+    },
+    "./utils": {
+      "import": "./dist/utils.js"
+    }
+  },
+  "dependencies": {
+    "@babel/plugin-proposal-decorators": "^7.28.0",
+    "@tanstack/react-query": "^5.90.21",
+    "@tanstack/react-query-devtools": "^5.91.3",
+    "mobx": "^6.13.7",
+    "mobx-react-lite": "^4.1.0",
+    "mobx-react-observer": "^1.1.0",
+    "react": "^19.1.1",
+    "react-dom": "^19.1.1"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.33.0",
+    "@types/node": "^25.3.0",
+    "@types/react": "^19.1.10",
+    "@types/react-dom": "^19.1.7",
+    "@vitejs/plugin-react": "^5.0.0",
+    "eslint": "^9.33.0",
+    "eslint-plugin-react-hooks": "^5.2.0",
+    "eslint-plugin-react-refresh": "^0.4.20",
+    "globals": "^16.3.0",
+    "typescript": "~5.8.3",
+    "typescript-eslint": "^8.39.1",
+    "vite": "^7.1.2"
+  }
+}

package/public/vite.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="31.88" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 257"><defs><linearGradient id="IconifyId1813088fe1fbc01fb466" x1="-.828%" x2="57.636%" y1="7.652%" y2="78.411%"><stop offset="0%" stop-color="#41D1FF"></stop><stop offset="100%" stop-color="#BD34FE"></stop></linearGradient><linearGradient id="IconifyId1813088fe1fbc01fb467" x1="43.376%" x2="50.316%" y1="2.242%" y2="89.03%"><stop offset="0%" stop-color="#FFEA83"></stop><stop offset="8.333%" stop-color="#FFDD35"></stop><stop offset="100%" stop-color="#FFA800"></stop></linearGradient></defs><path fill="url(#IconifyId1813088fe1fbc01fb466)" d="M255.153 37.938L134.897 252.976c-2.483 4.44-8.862 4.466-11.382.048L.875 37.958c-2.746-4.814 1.371-10.646 6.827-9.67l120.385 21.517a6.537 6.537 0 0 0 2.322-.004l117.867-21.483c5.438-.991 9.574 4.796 6.877 9.62Z"></path><path fill="url(#IconifyId1813088fe1fbc01fb467)" d="M185.432.063L96.44 17.501a3.268 3.268 0 0 0-2.634 3.014l-5.474 92.456a3.268 3.268 0 0 0 3.997 3.378l24.777-5.718c2.318-.535 4.413 1.507 3.936 3.838l-7.361 36.047c-.495 2.426 1.782 4.5 4.151 3.78l15.304-4.649c2.372-.72 4.652 1.36 4.15 3.788l-11.698 56.621c-.732 3.542 3.979 5.473 5.943 2.437l1.313-2.028l72.516-144.72c1.215-2.423-.88-5.186-3.54-4.672l-25.505 4.922c-2.396.462-4.435-1.77-3.759-4.114l16.646-57.705c.677-2.35-1.37-4.583-3.769-4.113Z"></path></svg>

package/src/App.tsx

@@ -0,0 +1,5 @@
+const App = () => {
+  return <div />;
+};
+
+export default App;

package/src/api/constants.ts

@@ -0,0 +1 @@
+export const API_URL = "https://jsonplaceholder.typicode.com";

package/src/api/fetch.ts

@@ -0,0 +1,29 @@
+import { API_URL } from "./constants";
+
+export interface ApiFetchOptions {
+  method?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+  params?: Map<string, string>;
+}
+
+export async function apiFetch<R = unknown>(
+  path: string,
+  options?: ApiFetchOptions
+) {
+  const url = new URL(API_URL);
+
+  url.pathname = path;
+
+  if (options?.params && options.params.size > 0) {
+    for (const [key, value] of options.params.entries()) {
+      url.searchParams.append(key, value);
+    }
+  }
+
+  const res = await fetch(url.toString(), {
+    method: options?.method || "GET",
+  });
+
+  const json = await res.json();
+
+  return json as R;
+}

package/src/api/todos.ts

@@ -0,0 +1,14 @@
+import { apiFetch } from "./fetch";
+import type { TodoDTO } from "./types";
+
+export function getTodosByUserId(userId: number) {
+  return apiFetch<TodoDTO[]>("/todos", {
+    params: new Map([["userId", userId.toString()]]),
+  });
+}
+
+export async function deleteTodo(todoId: number) {
+  return apiFetch<void>(`/todos/${todoId}`, {
+    method: "DELETE",
+  });
+}

package/src/api/types.ts

@@ -0,0 +1,30 @@
+export interface UserDTO {
+  id: number;
+  name: string;
+  username: string;
+  email: string;
+  address: {
+    street: string;
+    suite: string;
+    city: string;
+    zipcode: string;
+    geo: {
+      lat: string;
+      lng: string;
+    };
+  };
+  phone: string;
+  website: string;
+  company: {
+    name: string;
+    catchPhrase: string;
+    bs: string;
+  };
+}
+
+export interface TodoDTO {
+  id: number;
+  title: string;
+  completed: boolean;
+  userId: number;
+}

package/src/api/users.ts

@@ -0,0 +1,19 @@
+import { wait } from "../utils";
+import { apiFetch } from "./fetch";
+import type { UserDTO } from "./types";
+
+export function getAllUsers() {
+  return apiFetch<UserDTO[]>("/users");
+}
+
+export function getUserById(userId: number) {
+  return apiFetch<UserDTO>(`/users/${userId}`);
+}
+
+export async function deleteUser(userId: number) {
+  await wait(1500);
+
+  return apiFetch<void>(`/users/${userId}`, {
+    method: "DELETE",
+  });
+}

package/src/assets/react.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="35.93" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 228"><path fill="#00D8FF" d="M210.483 73.824a171.49 171.49 0 0 0-8.24-2.597c.465-1.9.893-3.777 1.273-5.621c6.238-30.281 2.16-54.676-11.769-62.708c-13.355-7.7-35.196.329-57.254 19.526a171.23 171.23 0 0 0-6.375 5.848a155.866 155.866 0 0 0-4.241-3.917C100.759 3.829 77.587-4.822 63.673 3.233C50.33 10.957 46.379 33.89 51.995 62.588a170.974 170.974 0 0 0 1.892 8.48c-3.28.932-6.445 1.924-9.474 2.98C17.309 83.498 0 98.307 0 113.668c0 15.865 18.582 31.778 46.812 41.427a145.52 145.52 0 0 0 6.921 2.165a167.467 167.467 0 0 0-2.01 9.138c-5.354 28.2-1.173 50.591 12.134 58.266c13.744 7.926 36.812-.22 59.273-19.855a145.567 145.567 0 0 0 5.342-4.923a168.064 168.064 0 0 0 6.92 6.314c21.758 18.722 43.246 26.282 56.54 18.586c13.731-7.949 18.194-32.003 12.4-61.268a145.016 145.016 0 0 0-1.535-6.842c1.62-.48 3.21-.974 4.76-1.488c29.348-9.723 48.443-25.443 48.443-41.52c0-15.417-17.868-30.326-45.517-39.844Zm-6.365 70.984c-1.4.463-2.836.91-4.3 1.345c-3.24-10.257-7.612-21.163-12.963-32.432c5.106-11 9.31-21.767 12.459-31.957c2.619.758 5.16 1.557 7.61 2.4c23.69 8.156 38.14 20.213 38.14 29.504c0 9.896-15.606 22.743-40.946 31.14Zm-10.514 20.834c2.562 12.94 2.927 24.64 1.23 33.787c-1.524 8.219-4.59 13.698-8.382 15.893c-8.067 4.67-25.32-1.4-43.927-17.412a156.726 156.726 0 0 1-6.437-5.87c7.214-7.889 14.423-17.06 21.459-27.246c12.376-1.098 24.068-2.894 34.671-5.345a134.17 134.17 0 0 1 1.386 6.193ZM87.276 214.515c-7.882 2.783-14.16 2.863-17.955.675c-8.075-4.657-11.432-22.636-6.853-46.752a156.923 156.923 0 0 1 1.869-8.499c10.486 2.32 22.093 3.988 34.498 4.994c7.084 9.967 14.501 19.128 21.976 27.15a134.668 134.668 0 0 1-4.877 4.492c-9.933 8.682-19.886 14.842-28.658 17.94ZM50.35 144.747c-12.483-4.267-22.792-9.812-29.858-15.863c-6.35-5.437-9.555-10.836-9.555-15.216c0-9.322 13.897-21.212 37.076-29.293c2.813-.98 5.757-1.905 8.812-2.773c3.204 10.42 7.406 21.315 12.477 32.332c-5.137 11.18-9.399 22.249-12.634 32.792a134.718 134.718 0 0 1-6.318-1.979Zm12.378-84.26c-4.811-24.587-1.616-43.134 6.425-47.789c8.564-4.958 27.502 2.111 47.463 19.835a144.318 144.318 0 0 1 3.841 3.545c-7.438 7.987-14.787 17.08-21.808 26.988c-12.04 1.116-23.565 2.908-34.161 5.309a160.342 160.342 0 0 1-1.76-7.887Zm110.427 27.268a347.8 347.8 0 0 0-7.785-12.803c8.168 1.033 15.994 2.404 23.343 4.08c-2.206 7.072-4.956 14.465-8.193 22.045a381.151 381.151 0 0 0-7.365-13.322Zm-45.032-43.861c5.044 5.465 10.096 11.566 15.065 18.186a322.04 322.04 0 0 0-30.257-.006c4.974-6.559 10.069-12.652 15.192-18.18ZM82.802 87.83a323.167 323.167 0 0 0-7.227 13.238c-3.184-7.553-5.909-14.98-8.134-22.152c7.304-1.634 15.093-2.97 23.209-3.984a321.524 321.524 0 0 0-7.848 12.897Zm8.081 65.352c-8.385-.936-16.291-2.203-23.593-3.793c2.26-7.3 5.045-14.885 8.298-22.6a321.187 321.187 0 0 0 7.257 13.246c2.594 4.48 5.28 8.868 8.038 13.147Zm37.542 31.03c-5.184-5.592-10.354-11.779-15.403-18.433c4.902.192 9.899.29 14.978.29c5.218 0 10.376-.117 15.453-.343c-4.985 6.774-10.018 12.97-15.028 18.486Zm52.198-57.817c3.422 7.8 6.306 15.345 8.596 22.52c-7.422 1.694-15.436 3.058-23.88 4.071a382.417 382.417 0 0 0 7.859-13.026a347.403 347.403 0 0 0 7.425-13.565Zm-16.898 8.101a358.557 358.557 0 0 1-12.281 19.815a329.4 329.4 0 0 1-23.444.823c-7.967 0-15.716-.248-23.178-.732a310.202 310.202 0 0 1-12.513-19.846h.001a307.41 307.41 0 0 1-10.923-20.627a310.278 310.278 0 0 1 10.89-20.637l-.001.001a307.318 307.318 0 0 1 12.413-19.761c7.613-.576 15.42-.876 23.31-.876H128c7.926 0 15.743.303 23.354.883a329.357 329.357 0 0 1 12.335 19.695a358.489 358.489 0 0 1 11.036 20.54a329.472 329.472 0 0 1-11 20.722Zm22.56-122.124c8.572 4.944 11.906 24.881 6.52 51.026c-.344 1.668-.73 3.367-1.15 5.09c-10.622-2.452-22.155-4.275-34.23-5.408c-7.034-10.017-14.323-19.124-21.64-27.008a160.789 160.789 0 0 1 5.888-5.4c18.9-16.447 36.564-22.941 44.612-18.3ZM128 90.808c12.625 0 22.86 10.235 22.86 22.86s-10.235 22.86-22.86 22.86s-22.86-10.235-22.86-22.86s10.235-22.86 22.86-22.86Z"></path></svg>

package/src/index.css

@@ -0,0 +1,60 @@
+:root {
+  font-family: system-ui, Avenir, Helvetica, Arial, sans-serif;
+  line-height: 1.5;
+  font-weight: 400;
+
+  color-scheme: light dark;
+  color: rgba(255, 255, 255, 0.87);
+  background-color: #242424;
+
+  font-synthesis: none;
+  text-rendering: optimizeLegibility;
+  -webkit-font-smoothing: antialiased;
+  -moz-osx-font-smoothing: grayscale;
+}
+
+a {
+  font-weight: 500;
+  color: #646cff;
+  text-decoration: inherit;
+}
+a:hover {
+  color: #535bf2;
+}
+
+h1 {
+  font-size: 3.2em;
+  line-height: 1.1;
+}
+
+button {
+  border-radius: 8px;
+  border: 1px solid transparent;
+  padding: 0.6em 1.2em;
+  font-size: 1em;
+  font-weight: 500;
+  font-family: inherit;
+  background-color: #1a1a1a;
+  cursor: pointer;
+  transition: border-color 0.25s;
+}
+button:hover {
+  border-color: #646cff;
+}
+button:focus,
+button:focus-visible {
+  outline: 4px auto -webkit-focus-ring-color;
+}
+
+@media (prefers-color-scheme: light) {
+  :root {
+    color: #213547;
+    background-color: #ffffff;
+  }
+  a:hover {
+    color: #747bff;
+  }
+  button {
+    background-color: #f9f9f9;
+  }
+}

package/src/libs/mobx-query/client/MQClient.ts

@@ -0,0 +1,75 @@
+import { type EntityConstructorAny, EntityCollection } from "../entity";
+import type { MQClientContextRegistered } from "./types";
+import {
+  OptimisticMutationErrorStrategy,
+  OptimisticMutationInvalidationStrategy,
+} from "../mutations";
+
+export interface MQClientOptions {
+  invalidationStrategy?: OptimisticMutationInvalidationStrategy;
+  errorStrategy?: OptimisticMutationErrorStrategy;
+  invalidateOnError?: boolean;
+}
+
+export interface MQClientProps<T> extends MQClientOptions {
+  context: MQClientContextRegistered;
+  entities: EntityConstructorAny[];
+  rootStore: () => T;
+}
+
+export const __MOBX_QUERY__: {
+  state: Map<string, EntityCollection>;
+  context: MQClientContextRegistered | null;
+  options: Required<MQClientOptions>;
+} = {
+  state: new Map(),
+  context: null,
+  options: {
+    invalidationStrategy:
+      OptimisticMutationInvalidationStrategy.REFERENCED_QUERIES,
+    errorStrategy: OptimisticMutationErrorStrategy.ROLLBACK,
+    invalidateOnError: true,
+  },
+};
+
+export class MQClient<T> {
+  readonly rootStore: T;
+
+  constructor(props: MQClientProps<T>) {
+    __MOBX_QUERY__.context = props.context;
+
+    for (const entity of props.entities) {
+      __MOBX_QUERY__.state.set(
+        entity.name,
+        new EntityCollection(entity, props.context.queryClient),
+      );
+    }
+
+    // if (process.env.NODE_ENV === 'development') {
+    //   setupMobxDevtoolsV2()
+    // }
+
+    __MOBX_QUERY__.options.invalidationStrategy =
+      props.invalidationStrategy ??
+      OptimisticMutationInvalidationStrategy.REFERENCED_QUERIES;
+    __MOBX_QUERY__.options.errorStrategy =
+      props.errorStrategy ?? OptimisticMutationErrorStrategy.ROLLBACK;
+    __MOBX_QUERY__.options.invalidateOnError = props.invalidateOnError ?? true;
+
+    this.rootStore = props.rootStore();
+  }
+
+  getEntityCollection<TEntityConstructor extends EntityConstructorAny>(
+    entity: TEntityConstructor,
+  ) {
+    const collection = __MOBX_QUERY__.state.get(
+      entity.name,
+    ) as EntityCollection<TEntityConstructor>;
+
+    if (!collection) {
+      throw new Error(`Entity collection not found for entity ${entity.name}`);
+    }
+
+    return collection;
+  }
+}

package/src/libs/mobx-query/client/MQClientAccessor.ts

@@ -0,0 +1,74 @@
+import { __MOBX_QUERY__ } from "./MQClient";
+import type {
+  DefaultError,
+  MutationOptions,
+  QueryClient,
+} from "@tanstack/react-query";
+import type { MQClientContextRegistered } from "./types";
+import type { EntityCollection, EntityConstructorAny } from "../entity";
+import type { MutationFn } from "../mutations";
+
+export abstract class MQClientAccessor {
+  protected readonly queryClient: QueryClient;
+  protected readonly context: MQClientContextRegistered;
+  private readonly globalState: Map<string, EntityCollection>;
+
+  constructor() {
+    if (!__MOBX_QUERY__) {
+      throw new Error("Client not found");
+    }
+
+    if (!__MOBX_QUERY__.context) {
+      throw new Error("MQClientContext is required");
+    }
+
+    this.queryClient = __MOBX_QUERY__.context.queryClient;
+    this.globalState = __MOBX_QUERY__.state;
+    this.context = __MOBX_QUERY__.context;
+  }
+
+  protected getEntityCollection<
+    TEntityConstructor extends EntityConstructorAny = EntityConstructorAny,
+  >(
+    entityConstructor: TEntityConstructor,
+  ): EntityCollection<TEntityConstructor> {
+    const collection = this.globalState.get(entityConstructor.name);
+
+    if (!collection) {
+      throw new Error(
+        `Entity collection not found for entity ${entityConstructor.name}`,
+      );
+    }
+
+    return collection as unknown as EntityCollection<TEntityConstructor>;
+  }
+
+  protected runSyncMutation<
+    TInput,
+    TError = DefaultError,
+    TMutateResult = unknown,
+  >(
+    input: TInput,
+    mutationFn: MutationFn<TInput>,
+    options?: MutationOptions<void, TError, TInput, TMutateResult>,
+  ) {
+    this.queryClient
+      .getMutationCache()
+      .build<void, TError, TInput, TMutateResult>(this.queryClient, {
+        mutationFn: (input) => mutationFn(input, this.context),
+        onError: options?.onError,
+        onMutate: options?.onMutate,
+        onSuccess: options?.onSuccess,
+        onSettled: options?.onSettled,
+        gcTime: options?.gcTime,
+        meta: options?.meta,
+        networkMode: options?.networkMode,
+        retry: options?.retry,
+        retryDelay: options?.retryDelay,
+        scope: options?.scope,
+        mutationKey: options?.mutationKey,
+      })
+      .execute(input)
+      .catch((error) => console.log("runSyncMutation error", error));
+  }
+}

package/src/libs/mobx-query/client/index.ts

@@ -0,0 +1,8 @@
+import { MQClient } from "./MQClient";
+import { MQClientAccessor } from "./MQClientAccessor";
+
+import type { MQClientContext, MQClientContextRegistered } from "./types";
+
+export { MQClient, MQClientAccessor };
+
+export type { MQClientContext, MQClientContextRegistered };

package/src/libs/mobx-query/client/types.ts

@@ -0,0 +1,37 @@
+import { QueryClient } from '@tanstack/react-query'
+
+export interface MQClientContext {
+  queryClient: QueryClient
+}
+
+/**
+ * Global namespace that users can augment to register their custom context type.
+ *
+ * @example
+ * ```ts
+ * declare global {
+ *   namespace MobXQuery {
+ *     interface RegisteredContext {
+ *       context: MyCustomContext
+ *     }
+ *   }
+ * }
+ * ```
+ */
+declare global {
+  // eslint-disable-next-line @typescript-eslint/no-namespace
+  namespace MobXQuery {
+    // eslint-disable-next-line @typescript-eslint/no-empty-object-type
+    interface RegisteredContext {}
+  }
+}
+
+/**
+ * Extracts the user's registered context type or falls back to base MQClientContext.
+ * This allows users to define their context type once via global namespace augmentation.
+ */
+export type MQClientContextRegistered = MobXQuery.RegisteredContext extends {
+  context: infer TContext extends MQClientContext
+}
+  ? TContext
+  : MQClientContext