@astral/mobx-query 1.17.1 → 1.18.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -31,6 +31,7 @@
31
31
  - [Создание mutations](#создание-и-использование-mutations)
32
32
  - [Синхронный вызов mutation](#синхронный-вызов-mutation)
33
33
  - [Асинхронный вызов mutation](#асинхронный-вызов-mutation)
34
+ - [Best practices для MutationSet](#best-practices-для-mutationset)
34
35
  - [Кэширование QuerySet и InfiniteQuerySet](#кэширование-queryset-и-infinitequeryset)
35
36
  - [FetchPolicy](#fetchpolicy)
36
37
  - [Как работает кэш](#как-работает-кэш)
@@ -428,6 +429,36 @@ const editDocMutation = docsFetcher.mutations.editDoc.create();
428
429
  await editDocMutation.async({ params: { id: 'docID', name: 'test' } });
429
430
  ```
430
431
 
432
+ ### Best practices для MutationSet
433
+
434
+ #### `Mutation` должен создаваться в конструкторе класса, а не в getter
435
+
436
+ **✅ Valid**
437
+
438
+ ```ts
439
+ class DocStore {
440
+ private readonly creationDocMutation: Mutation<DocsDTO.CreateDocResponse, DocsDTO.CreateDocInput>;
441
+
442
+ public constructor(
443
+ private readonly _docsFetcher: DocsFetcher,
444
+ ) {
445
+ this.creationDocMutation = this._docsFetcher.mutations.createDoc.create();
446
+ }
447
+ }
448
+ ```
449
+
450
+ **❌ Invalid**
451
+
452
+ ```ts
453
+ class DocStore {
454
+ private get creationDocMutation() {
455
+ return this._docsFetcher.mutations.createDoc.create();
456
+ }
457
+ }
458
+ ```
459
+
460
+ Описанный кейс является антипаттерном потому что если на `creationDocMutation` больше не будет подписчиков, то при следующем обращении getter заново создаст `mutation`. Это может привести к нежелательным побочным эффектам.
461
+
431
462
  ## Кэширование QuerySet и InfiniteQuerySet
432
463
 
433
464
  `QuerySet` и `InfiniteQuerySet` позволяет закэшировать данные, которые были получены ранее.
@@ -1,4 +1,5 @@
1
1
  import { isPlainObject } from '@astral/utils';
2
+ import stringify from 'fast-json-stable-stringify';
2
3
  /**
3
4
  * Создает ключи на основе каждого параметра
4
5
  * @param additionalKeys - Создает для каждого параметра отдельный ключ, чтобы по нему можно было инвалидировать query
@@ -10,7 +11,9 @@ export const generateQuerySetKeys = (baseKey, params) => {
10
11
  const resultKeys = [];
11
12
  params.forEach((param) => {
12
13
  if (isPlainObject(param)) {
13
- resultKeys.push(...Object.entries(param).map(([key, value]) => [baseKey, key, value]));
14
+ // Нормализуем объект через стабильную сериализацию для консистентных ключей
15
+ const normalizedParam = JSON.parse(stringify(param));
16
+ resultKeys.push(...Object.entries(normalizedParam).map(([key, value]) => [baseKey, key, value]));
14
17
  }
15
18
  else {
16
19
  resultKeys.push(param);
@@ -1,7 +1,11 @@
1
1
  "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
2
5
  Object.defineProperty(exports, "__esModule", { value: true });
3
6
  exports.generateQuerySetKeys = void 0;
4
7
  const utils_1 = require("@astral/utils");
8
+ const fast_json_stable_stringify_1 = __importDefault(require("fast-json-stable-stringify"));
5
9
  /**
6
10
  * Создает ключи на основе каждого параметра
7
11
  * @param additionalKeys - Создает для каждого параметра отдельный ключ, чтобы по нему можно было инвалидировать query
@@ -13,7 +17,9 @@ const generateQuerySetKeys = (baseKey, params) => {
13
17
  const resultKeys = [];
14
18
  params.forEach((param) => {
15
19
  if ((0, utils_1.isPlainObject)(param)) {
16
- resultKeys.push(...Object.entries(param).map(([key, value]) => [baseKey, key, value]));
20
+ // Нормализуем объект через стабильную сериализацию для консистентных ключей
21
+ const normalizedParam = JSON.parse((0, fast_json_stable_stringify_1.default)(param));
22
+ resultKeys.push(...Object.entries(normalizedParam).map(([key, value]) => [baseKey, key, value]));
17
23
  }
18
24
  else {
19
25
  resultKeys.push(param);
package/package.json CHANGED
@@ -4,12 +4,13 @@
4
4
  "dependencies": {
5
5
  "@astral/utils": "^1.6.1",
6
6
  "@emotion/hash": "0.9.2",
7
- "utility-types": "3.11.0"
7
+ "utility-types": "3.11.0",
8
+ "fast-json-stable-stringify": "2.1.0"
8
9
  },
9
10
  "peerDependencies": {
10
11
  "mobx": "^6.0.0"
11
12
  },
12
- "version": "1.17.1",
13
+ "version": "1.18.1",
13
14
  "author": "Astral.Soft",
14
15
  "license": "MIT",
15
16
  "repository": {