@karta.io/utils 1.0.0-beta.51 → 1.0.0-beta.53

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.
@@ -1,7 +1,11 @@
1
1
  import { Ref, ComputedRef } from 'vue';
2
- export declare function useFilters<T extends Record<string, any>, K extends Record<string, any>>({ config, initialFilters }: {
2
+ export declare function useFilters<T extends Record<string, any>, K extends Record<string, any>>({ config, initialFilters, delay, }: {
3
3
  config: T;
4
4
  initialFilters: K;
5
+ /**
6
+ * 0 — применять сразу, без задержки
7
+ */
8
+ delay?: number;
5
9
  }): {
6
10
  isOpen: Ref<boolean, boolean>;
7
11
  filtersModel: Ref<K, K>;
package/dist/index.cjs CHANGED
@@ -54,6 +54,8 @@ let dayjs_plugin_customParseFormat_js = require("dayjs/plugin/customParseFormat.
54
54
  dayjs_plugin_customParseFormat_js = __toESM(dayjs_plugin_customParseFormat_js, 1);
55
55
  let detect_browser = require("detect-browser");
56
56
  let vue_router = require("vue-router");
57
+ let lodash_isEqual_js = require("lodash/isEqual.js");
58
+ lodash_isEqual_js = __toESM(lodash_isEqual_js, 1);
57
59
  let qs = require("qs");
58
60
  qs = __toESM(qs, 1);
59
61
  //#region src/helpers/appComponentsResolver.ts
@@ -1250,30 +1252,38 @@ var QS_STRINGIFY_PARAMS = {
1250
1252
  skipNulls: true,
1251
1253
  addQueryPrefix: true
1252
1254
  };
1255
+ /**
1256
+ * Задержка перед применением фильтров по умолчанию: серия кликов по чекбоксам даёт один запрос
1257
+ */
1258
+ var FILTERS_APPLY_DELAY = 300;
1253
1259
  var isOpen = (0, vue.ref)(false);
1254
- function useFilters({ config, initialFilters }) {
1260
+ function useFilters({ config, initialFilters, delay = FILTERS_APPLY_DELAY }) {
1255
1261
  const router = (0, vue_router.useRouter)();
1256
1262
  const route = (0, vue_router.useRoute)();
1257
1263
  const parseRouteQuery = (query) => qs.default.parse(query ?? route.query);
1258
- const filtersFromQuery = (0, vue.computed)(() => {
1259
- const parsedRouteQuery = parseRouteQuery();
1260
- if (!parsedRouteQuery.filters) return void 0;
1261
- return Object.entries(config).reduce((accum, [currentKey, currentValue]) => {
1262
- if (!parsedRouteQuery.filters[currentKey]) return accum;
1263
- if (currentValue.type === "ARRAY") {
1264
- const splitValues = parsedRouteQuery.filters[currentKey].split(",");
1265
- const checkedValue = currentValue?.possibleValues ? splitValues.filter((k) => currentValue?.possibleValues?.includes(k)) : splitValues;
1266
- if (!checkedValue?.length) return accum;
1267
- return {
1268
- ...accum,
1269
- [currentKey]: checkedValue
1270
- };
1271
- }
1264
+ /**
1265
+ * Фильтры из строк query: ARRAY — массив значений через запятую, остальные — строкой
1266
+ */
1267
+ const parseFilters = (rawFilters) => Object.entries(config).reduce((accum, [currentKey, currentValue]) => {
1268
+ if (!rawFilters[currentKey]) return accum;
1269
+ if (currentValue.type === "ARRAY") {
1270
+ const splitValues = String(rawFilters[currentKey]).split(",");
1271
+ const checkedValue = currentValue?.possibleValues ? splitValues.filter((k) => currentValue?.possibleValues?.includes(k)) : splitValues;
1272
+ if (!checkedValue?.length) return accum;
1272
1273
  return {
1273
1274
  ...accum,
1274
- [currentKey]: parsedRouteQuery.filters[currentKey]
1275
+ [currentKey]: checkedValue
1275
1276
  };
1276
- }, {});
1277
+ }
1278
+ return {
1279
+ ...accum,
1280
+ [currentKey]: rawFilters[currentKey]
1281
+ };
1282
+ }, {});
1283
+ const filtersFromQuery = (0, vue.computed)(() => {
1284
+ const parsedRouteQuery = parseRouteQuery();
1285
+ if (!parsedRouteQuery.filters) return void 0;
1286
+ return parseFilters(parsedRouteQuery.filters);
1277
1287
  });
1278
1288
  const filtersCount = (0, vue.computed)(() => filtersFromQuery.value ? Object.keys(filtersFromQuery.value).length : 0);
1279
1289
  const setQueryFromFilters = (filters) => {
@@ -1312,42 +1322,82 @@ function useFilters({ config, initialFilters }) {
1312
1322
  filters: filtersFromQuery.value
1313
1323
  };
1314
1324
  };
1315
- const open = () => {
1316
- isOpen.value = true;
1317
- };
1318
- const clear = () => setQueryFromFilters({});
1319
1325
  const filtersModel = (0, vue.ref)({
1320
1326
  ...initialFilters,
1321
1327
  ...filtersFromQuery.value
1322
1328
  });
1329
+ const toQueryFilters = (filters) => Object.fromEntries(Object.entries(filters).map(([key, value]) => [key, value ? String(value) : void 0]));
1330
+ /**
1331
+ * Только поля, изменённые за время задержки. Остальное берётся из URL в момент записи:
1332
+ * на странице бывает несколько useFilters (панель, теги, страница), и каждый пишет в URL
1333
+ * свои изменения, а не свою копию всех фильтров
1334
+ */
1335
+ let pendingChanges;
1336
+ /**
1337
+ * Фильтры из URL с наложенными неприменёнными изменениями — в форме строк query
1338
+ */
1339
+ const getQueryFiltersWithPending = () => ({
1340
+ ...toQueryFilters(filtersFromQuery.value ?? {}),
1341
+ ...pendingChanges
1342
+ });
1343
+ /**
1344
+ * Модель собирается из тех же строк, что уйдут в query, поэтому до push она такая же, как после.
1345
+ * Без изменений модель не пишем: useFilterDate в admin и app зовёт updateMany из computed,
1346
+ * и запись той же модели зациклила бы рендер
1347
+ */
1348
+ const syncFiltersModel = () => {
1349
+ const nextFiltersModel = {
1350
+ ...initialFilters,
1351
+ ...parseFilters(getQueryFiltersWithPending())
1352
+ };
1353
+ if (!(0, lodash_isEqual_js.default)(nextFiltersModel, filtersModel.value)) filtersModel.value = nextFiltersModel;
1354
+ };
1355
+ const applyPendingFilters = (0, _vueuse_core.useDebounceFn)((scheduledPath) => {
1356
+ if (!pendingChanges) return;
1357
+ const filters = getQueryFiltersWithPending();
1358
+ pendingChanges = void 0;
1359
+ /**
1360
+ * Пользователь ушёл на другую страницу: изменения относятся к прежней
1361
+ */
1362
+ if (route.path !== scheduledPath) return;
1363
+ setQueryFromFilters(filters);
1364
+ }, delay);
1365
+ /**
1366
+ * Модель обновляется сразу: следующий клик собирает состояние уже с этим изменением,
1367
+ * иначе второй клик в пределах задержки потеряет первый. Откладывается только router.push.
1368
+ */
1369
+ const applyWithDelay = (changes) => {
1370
+ pendingChanges = {
1371
+ ...pendingChanges,
1372
+ ...toQueryFilters(changes)
1373
+ };
1374
+ syncFiltersModel();
1375
+ applyPendingFilters(route.path);
1376
+ };
1377
+ /**
1378
+ * Компонент размонтировался до конца задержки: применяем сразу, как без задержки
1379
+ */
1380
+ (0, _vueuse_core.tryOnScopeDispose)(applyPendingFilters.flush);
1381
+ const open = () => {
1382
+ isOpen.value = true;
1383
+ };
1384
+ const clear = () => {
1385
+ applyPendingFilters.cancel();
1386
+ pendingChanges = void 0;
1387
+ filtersModel.value = { ...initialFilters };
1388
+ setQueryFromFilters({});
1389
+ };
1323
1390
  const updateOne = (key, value) => {
1324
- setQueryFromFilters({
1325
- ...filtersModel.value,
1326
- [key]: value ? String(value) : void 0
1327
- });
1391
+ applyWithDelay({ [key]: value });
1328
1392
  };
1329
1393
  const updateMany = (filters) => {
1330
- const newFilters = Object.entries(filters).reduce((accum, [currentKey, currentValue]) => {
1331
- return {
1332
- ...accum,
1333
- [currentKey]: currentValue ? String(currentValue) : void 0
1334
- };
1335
- }, {});
1336
- setQueryFromFilters({
1337
- ...filtersModel.value,
1338
- ...newFilters
1339
- });
1394
+ applyWithDelay(filters);
1340
1395
  };
1341
- (0, vue.watch)(filtersFromQuery, (newFilters) => {
1342
- if (!newFilters) {
1343
- filtersModel.value = { ...initialFilters };
1344
- return;
1345
- }
1346
- filtersModel.value = {
1347
- ...initialFilters,
1348
- ...newFilters
1349
- };
1350
- });
1396
+ /**
1397
+ * URL поменял кто-то другой (другой useFilters, «Назад», сброс): модель — новый URL
1398
+ * плюс свои неприменённые изменения
1399
+ */
1400
+ (0, vue.watch)(filtersFromQuery, syncFiltersModel);
1351
1401
  return {
1352
1402
  isOpen,
1353
1403
  filtersModel,
package/dist/index.mjs CHANGED
@@ -5,7 +5,7 @@ import { parsePhoneNumberFromString } from "libphonenumber-js";
5
5
  import snakeCase from "lodash/snakeCase.js";
6
6
  import { computed, createVNode, getCurrentInstance, isRef, nextTick, onBeforeUnmount, onMounted, reactive, ref, render, toValue, watch } from "vue";
7
7
  import { useQuery, useQueryClient } from "@tanstack/vue-query";
8
- import { useBreakpoints, useDebounceFn } from "@vueuse/core";
8
+ import { tryOnScopeDispose, useBreakpoints, useDebounceFn } from "@vueuse/core";
9
9
  import get from "lodash/get.js";
10
10
  import has from "lodash/has.js";
11
11
  import union from "lodash/union.js";
@@ -18,6 +18,7 @@ import isToday from "dayjs/plugin/isToday.js";
18
18
  import customParseFormat from "dayjs/plugin/customParseFormat.js";
19
19
  import { detect } from "detect-browser";
20
20
  import { useRoute, useRouter } from "vue-router";
21
+ import isEqual from "lodash/isEqual.js";
21
22
  import qs from "qs";
22
23
  //#region src/helpers/appComponentsResolver.ts
23
24
  function AppComponentsResolver(options = {}) {
@@ -1213,30 +1214,38 @@ var QS_STRINGIFY_PARAMS = {
1213
1214
  skipNulls: true,
1214
1215
  addQueryPrefix: true
1215
1216
  };
1217
+ /**
1218
+ * Задержка перед применением фильтров по умолчанию: серия кликов по чекбоксам даёт один запрос
1219
+ */
1220
+ var FILTERS_APPLY_DELAY = 300;
1216
1221
  var isOpen = ref(false);
1217
- function useFilters({ config, initialFilters }) {
1222
+ function useFilters({ config, initialFilters, delay = FILTERS_APPLY_DELAY }) {
1218
1223
  const router = useRouter();
1219
1224
  const route = useRoute();
1220
1225
  const parseRouteQuery = (query) => qs.parse(query ?? route.query);
1221
- const filtersFromQuery = computed(() => {
1222
- const parsedRouteQuery = parseRouteQuery();
1223
- if (!parsedRouteQuery.filters) return void 0;
1224
- return Object.entries(config).reduce((accum, [currentKey, currentValue]) => {
1225
- if (!parsedRouteQuery.filters[currentKey]) return accum;
1226
- if (currentValue.type === "ARRAY") {
1227
- const splitValues = parsedRouteQuery.filters[currentKey].split(",");
1228
- const checkedValue = currentValue?.possibleValues ? splitValues.filter((k) => currentValue?.possibleValues?.includes(k)) : splitValues;
1229
- if (!checkedValue?.length) return accum;
1230
- return {
1231
- ...accum,
1232
- [currentKey]: checkedValue
1233
- };
1234
- }
1226
+ /**
1227
+ * Фильтры из строк query: ARRAY — массив значений через запятую, остальные — строкой
1228
+ */
1229
+ const parseFilters = (rawFilters) => Object.entries(config).reduce((accum, [currentKey, currentValue]) => {
1230
+ if (!rawFilters[currentKey]) return accum;
1231
+ if (currentValue.type === "ARRAY") {
1232
+ const splitValues = String(rawFilters[currentKey]).split(",");
1233
+ const checkedValue = currentValue?.possibleValues ? splitValues.filter((k) => currentValue?.possibleValues?.includes(k)) : splitValues;
1234
+ if (!checkedValue?.length) return accum;
1235
1235
  return {
1236
1236
  ...accum,
1237
- [currentKey]: parsedRouteQuery.filters[currentKey]
1237
+ [currentKey]: checkedValue
1238
1238
  };
1239
- }, {});
1239
+ }
1240
+ return {
1241
+ ...accum,
1242
+ [currentKey]: rawFilters[currentKey]
1243
+ };
1244
+ }, {});
1245
+ const filtersFromQuery = computed(() => {
1246
+ const parsedRouteQuery = parseRouteQuery();
1247
+ if (!parsedRouteQuery.filters) return void 0;
1248
+ return parseFilters(parsedRouteQuery.filters);
1240
1249
  });
1241
1250
  const filtersCount = computed(() => filtersFromQuery.value ? Object.keys(filtersFromQuery.value).length : 0);
1242
1251
  const setQueryFromFilters = (filters) => {
@@ -1275,42 +1284,82 @@ function useFilters({ config, initialFilters }) {
1275
1284
  filters: filtersFromQuery.value
1276
1285
  };
1277
1286
  };
1278
- const open = () => {
1279
- isOpen.value = true;
1280
- };
1281
- const clear = () => setQueryFromFilters({});
1282
1287
  const filtersModel = ref({
1283
1288
  ...initialFilters,
1284
1289
  ...filtersFromQuery.value
1285
1290
  });
1291
+ const toQueryFilters = (filters) => Object.fromEntries(Object.entries(filters).map(([key, value]) => [key, value ? String(value) : void 0]));
1292
+ /**
1293
+ * Только поля, изменённые за время задержки. Остальное берётся из URL в момент записи:
1294
+ * на странице бывает несколько useFilters (панель, теги, страница), и каждый пишет в URL
1295
+ * свои изменения, а не свою копию всех фильтров
1296
+ */
1297
+ let pendingChanges;
1298
+ /**
1299
+ * Фильтры из URL с наложенными неприменёнными изменениями — в форме строк query
1300
+ */
1301
+ const getQueryFiltersWithPending = () => ({
1302
+ ...toQueryFilters(filtersFromQuery.value ?? {}),
1303
+ ...pendingChanges
1304
+ });
1305
+ /**
1306
+ * Модель собирается из тех же строк, что уйдут в query, поэтому до push она такая же, как после.
1307
+ * Без изменений модель не пишем: useFilterDate в admin и app зовёт updateMany из computed,
1308
+ * и запись той же модели зациклила бы рендер
1309
+ */
1310
+ const syncFiltersModel = () => {
1311
+ const nextFiltersModel = {
1312
+ ...initialFilters,
1313
+ ...parseFilters(getQueryFiltersWithPending())
1314
+ };
1315
+ if (!isEqual(nextFiltersModel, filtersModel.value)) filtersModel.value = nextFiltersModel;
1316
+ };
1317
+ const applyPendingFilters = useDebounceFn((scheduledPath) => {
1318
+ if (!pendingChanges) return;
1319
+ const filters = getQueryFiltersWithPending();
1320
+ pendingChanges = void 0;
1321
+ /**
1322
+ * Пользователь ушёл на другую страницу: изменения относятся к прежней
1323
+ */
1324
+ if (route.path !== scheduledPath) return;
1325
+ setQueryFromFilters(filters);
1326
+ }, delay);
1327
+ /**
1328
+ * Модель обновляется сразу: следующий клик собирает состояние уже с этим изменением,
1329
+ * иначе второй клик в пределах задержки потеряет первый. Откладывается только router.push.
1330
+ */
1331
+ const applyWithDelay = (changes) => {
1332
+ pendingChanges = {
1333
+ ...pendingChanges,
1334
+ ...toQueryFilters(changes)
1335
+ };
1336
+ syncFiltersModel();
1337
+ applyPendingFilters(route.path);
1338
+ };
1339
+ /**
1340
+ * Компонент размонтировался до конца задержки: применяем сразу, как без задержки
1341
+ */
1342
+ tryOnScopeDispose(applyPendingFilters.flush);
1343
+ const open = () => {
1344
+ isOpen.value = true;
1345
+ };
1346
+ const clear = () => {
1347
+ applyPendingFilters.cancel();
1348
+ pendingChanges = void 0;
1349
+ filtersModel.value = { ...initialFilters };
1350
+ setQueryFromFilters({});
1351
+ };
1286
1352
  const updateOne = (key, value) => {
1287
- setQueryFromFilters({
1288
- ...filtersModel.value,
1289
- [key]: value ? String(value) : void 0
1290
- });
1353
+ applyWithDelay({ [key]: value });
1291
1354
  };
1292
1355
  const updateMany = (filters) => {
1293
- const newFilters = Object.entries(filters).reduce((accum, [currentKey, currentValue]) => {
1294
- return {
1295
- ...accum,
1296
- [currentKey]: currentValue ? String(currentValue) : void 0
1297
- };
1298
- }, {});
1299
- setQueryFromFilters({
1300
- ...filtersModel.value,
1301
- ...newFilters
1302
- });
1356
+ applyWithDelay(filters);
1303
1357
  };
1304
- watch(filtersFromQuery, (newFilters) => {
1305
- if (!newFilters) {
1306
- filtersModel.value = { ...initialFilters };
1307
- return;
1308
- }
1309
- filtersModel.value = {
1310
- ...initialFilters,
1311
- ...newFilters
1312
- };
1313
- });
1358
+ /**
1359
+ * URL поменял кто-то другой (другой useFilters, «Назад», сброс): модель — новый URL
1360
+ * плюс свои неприменённые изменения
1361
+ */
1362
+ watch(filtersFromQuery, syncFiltersModel);
1314
1363
  return {
1315
1364
  isOpen,
1316
1365
  filtersModel,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@karta.io/utils",
3
- "version": "1.0.0-beta.51",
3
+ "version": "1.0.0-beta.53",
4
4
  "description": "karta.io utils for admin and application",
5
5
  "type": "module",
6
6
  "license": "MIT",
@@ -29,24 +29,24 @@
29
29
  "@tanstack/vue-query": "5.101.4",
30
30
  "@vueuse/core": "14.4.0",
31
31
  "async-validator": "4.2.5",
32
- "axios": "1.19.0",
32
+ "axios": "1.20.0",
33
33
  "dayjs": "1.11.21",
34
34
  "detect-browser": "5.3.0",
35
35
  "libphonenumber-js": "1.13.9",
36
36
  "lodash": "4.18.1",
37
37
  "logdown": "3.3.1",
38
38
  "qs": "6.15.3",
39
- "@karta.io/common-data": "1.0.0-beta.51"
39
+ "@karta.io/common-data": "1.0.0-beta.53"
40
40
  },
41
41
  "devDependencies": {
42
- "@karta.io/eslint-config": "1.3.0",
42
+ "@karta.io/eslint-config": "2.3.0",
43
43
  "@types/lodash": "4.17.24",
44
- "eslint": "9.9.1",
44
+ "eslint": "10.10.0",
45
45
  "typescript": "5.9.3",
46
46
  "vite": "8.2.0",
47
47
  "vite-plugin-dts": "5.0.3",
48
48
  "vitest": "4.1.10",
49
- "vue": "3.5.40",
49
+ "vue": "3.5.42",
50
50
  "vue-router": "5.2.0"
51
51
  },
52
52
  "scripts": {
@@ -58,7 +58,6 @@
58
58
  "format": "oxfmt --check",
59
59
  "format:fix": "oxfmt",
60
60
  "fix": "pnpm lint:fix && pnpm format:fix",
61
- "prepush": "pnpm run lint && pnpm run format",
62
61
  "pub": "pnpm build && pnpm publish --no-git-checks --tag latest"
63
62
  }
64
63
  }