@querykitjs/web 1.0.0 → 2.0.1

package/dist/url-BpslCTRx.d.ts

@@ -1,180 +0,0 @@
-import * as _querykitjs_core from '@querykitjs/core';
-
-/**
- * Filter/query DSL tiplari — `@querykitjs/core`dan, entity maydoni (`FieldKey`)
- * bilan ixtisoslashtirilgan. querykit backend (`@querykitjs/drizzle-pg`) qabul
- * qiladigan wire-format bilan mos (`{key, operation, value}`).
- */
-
-type FilterOperator = _querykitjs_core.FilterOperator;
-type FilterScalar = _querykitjs_core.FilterScalar;
-type FilterValue = _querykitjs_core.FilterValue;
-/** Entity ustun (maydon) kaliti. */
-type FieldKey<T> = Extract<keyof T, string>;
-/** Bitta maydon sharti (`operation` default `"="`). */
-type FieldCondition<T = Record<string, unknown>> = _querykitjs_core.FieldCondition<FieldKey<T>>;
-type AndGroup<T = Record<string, unknown>> = _querykitjs_core.AndGroup<FieldKey<T>>;
-type OrGroup<T = Record<string, unknown>> = _querykitjs_core.OrGroup<FieldKey<T>>;
-type NotGroup<T = Record<string, unknown>> = _querykitjs_core.NotGroup<FieldKey<T>>;
-/** Filter daraxti tuguni: shart yoki mantiqiy guruh. */
-type FilterNode<T = Record<string, unknown>> = _querykitjs_core.FilterNode<FieldKey<T>>;
-/**
- * Public filter: daraxt/tugun yoki flat massiv. Flat massiv implicit `AND` va
- * legacy backend (idistr) `IFilter[]` bilan to'liq mos.
- */
-type Filter<T = Record<string, unknown>> = _querykitjs_core.Filter<FieldKey<T>>;
-type SortDirection = _querykitjs_core.SortDirection;
-interface Sort {
-    name?: string;
-    direction?: SortDirection;
-}
-/** Sort kirishi: `"-createdAt"` (sortType string) yoki `{ name, direction }`. */
-type SortInput = string | Sort;
-interface Params<T = Record<string, unknown>> {
-    filter?: Filter<T>;
-    sort?: SortInput;
-    columns?: Record<string, boolean>;
-    /** Yuklanadigan relationlar (default `with` deb yuboriladi). */
-    with?: Record<string, unknown>;
-    /** Soft-delete qilingan qatorlarni ham qo'shish (backend read'lari uchun). */
-    withDeleted?: boolean;
-}
-/** Offset (sahifali) paginatsiya kirishi. */
-interface ListParams<T = Record<string, unknown>> extends Params<T> {
-    page?: number;
-    perPage?: number;
-}
-/** Infinite-scroll (limit + offset) paginatsiya kirishi. */
-interface InfiniteParams<T = Record<string, unknown>> extends Params<T> {
-    limit?: number;
-    offset?: number;
-}
-/** Cursor (keyset) paginatsiya kirishi. */
-interface CursorParams<T = Record<string, unknown>> extends Params<T> {
-    limit?: number;
-    cursor?: string | null;
-    cursorKey?: string;
-    order?: SortDirection;
-    direction?: "forward" | "backward";
-}
-/** Normalizatsiya qilingan payload (default field nomlari bilan). */
-interface QueryPayload {
-    filter: FilterNode | FieldCondition[];
-    sort: Sort;
-    columns: Record<string, boolean>;
-    with: Record<string, unknown>;
-}
-interface ListPayload extends QueryPayload {
-    page: number;
-    perPage: number;
-}
-interface InfinitePayload extends QueryPayload {
-    limit: number;
-    offset: number;
-}
-/** Cursor payload — `sort` o'rniga `order`/`direction` boshqaradi. */
-interface CursorPayload {
-    filter: FilterNode | FieldCondition[];
-    columns: Record<string, boolean>;
-    with: Record<string, unknown>;
-    limit: number;
-    cursor: string | null;
-    order: SortDirection;
-    direction: "forward" | "backward";
-    cursorKey?: string;
-}
-/**
- * Xom (server, snake_case) meta tiplari — `@querykitjs/core`dan (adapter shu
- * shaklda qaytaradi). Server ba'zi maydonlarni bermasligi mumkinligi uchun
- * mapper'lar `Partial` qabul qiladi.
- */
-type RawMeta = Partial<_querykitjs_core.OffsetMeta>;
-type RawInfiniteMeta = Partial<_querykitjs_core.InfiniteMeta>;
-type RawCursorMeta = Partial<_querykitjs_core.CursorMeta>;
-/** Offset (list) — normalizatsiya qilingan meta (camelCase). */
-interface Meta {
-    totalPages: number;
-    totalCount: number;
-    currentPage: number;
-    perPage: number;
-    hasNext: boolean;
-    hasPrev: boolean;
-}
-/** Infinite-scroll — normalizatsiya qilingan meta. */
-interface InfiniteMeta {
-    limit: number;
-    offset: number;
-    count: number;
-    hasMore: boolean;
-    nextOffset: number | null;
-}
-/** Cursor — normalizatsiya qilingan meta. */
-interface CursorMeta {
-    limit: number;
-    hasNext: boolean;
-    hasPrev: boolean;
-    nextCursor: string | null;
-    prevCursor: string | null;
-}
-
-/**
- * Bitta list maydonining deklarativ ta'rifi: URL param → filter shartiga qanday
- * aylantirilishi. `key` berilmasa param nomi ishlatiladi; `operation` default `=`.
- */
-interface FieldDescriptor {
-    /** Backend ustun kaliti (default — schema'dagi param nomi). */
-    key?: string;
-    /** Filter operatori (default `"="`). */
-    operation?: FilterOperator;
-    /** String qiymatni trim qilish. */
-    trim?: boolean;
-    /** Diapazon: `[fromParam, toParam]` URL param nomlari → `>=` va `<=` shartlar. */
-    range?: [string, string];
-}
-/** URL param → {@link FieldDescriptor} tavsiflar to'plami. */
-type ListSchema = Record<string, FieldDescriptor>;
-/**
- * List filter schema'sini e'lon qiladi (identity helper — tiplarni saqlaydi).
- * URL param'larni `{key, operation}` shartlariga bog'laydi, shu bilan har
- * sahifada qo'lda `IFilter[]` qurishni bartaraf qiladi.
- *
- * @example
- * ```ts
- * const buyersSchema = defineListSchema({
- *   id: { operation: "=" },
- *   buyerName: { operation: "%_%", trim: true },
- *   status: { operation: "=" },
- *   createdAt: { range: ["fromDate", "toDate"] },
- * });
- * ```
- */
-declare function defineListSchema<S extends ListSchema>(schema: S): S;
-
-/** URL param nomlari (sahifa/o'lcham/sort) — sozlanadigan. */
-interface UrlConfig {
-    pageParam?: string;
-    sizeParam?: string;
-    sortParam?: string;
-}
-/** `"-createdAt"` → `{ name, direction }` (bo'sh bo'lsa `undefined`). */
-declare function decodeSort(value: string | null | undefined): Sort | undefined;
-/** `{ name, direction }` → `"-createdAt"` / `"createdAt"` (nomsiz bo'lsa `""`). */
-declare function encodeSort(sort: Sort): string;
-/** Schema + searchParams → `FieldCondition[]` (bo'sh param'lar tashlanadi). */
-declare function schemaToFilter(schema: ListSchema, searchParams: URLSearchParams): FieldCondition[];
-/** searchParams → normalizatsiyalanmagan {@link ListParams} (filter/sort/page/perPage). */
-declare function readListParams(schema: ListSchema, searchParams: URLSearchParams, url?: UrlConfig): ListParams;
-/** searchParams → to'liq, yuborishga tayyor {@link ListPayload}. */
-declare function searchParamsToPayload(schema: ListSchema, searchParams: URLSearchParams, url?: UrlConfig): ListPayload;
-/** Filter param'ini o'rnatadi/o'chiradi va `page`ni reset qiladi. */
-declare function setParam(searchParams: URLSearchParams, name: string, value: string | null | undefined, url?: UrlConfig): URLSearchParams;
-/** Sahifani o'rnatadi (`page` reset qilinmaydi). */
-declare function setPage(searchParams: URLSearchParams, page: number, url?: UrlConfig): URLSearchParams;
-/** Sahifa o'lchamini o'rnatadi va `page`ni reset qiladi. */
-declare function setSize(searchParams: URLSearchParams, size: number, url?: UrlConfig): URLSearchParams;
-/** Sortni o'rnatadi (`"-createdAt"` yoki `{name,direction}`) va `page`ni reset qiladi. */
-declare function setSort(searchParams: URLSearchParams, sort: SortInput, url?: UrlConfig): URLSearchParams;
-/** Barcha list param'larini tozalaydi (ixtiyoriy saqlanadigan kalitlar bilan). */
-declare function resetParams(searchParams: URLSearchParams, keep?: string[]): URLSearchParams;
-
-export { type AndGroup as A, setSize as B, type CursorParams as C, setSort as D, type FieldKey as F, type InfiniteParams as I, type ListParams as L, type Meta as M, type NotGroup as N, type OrGroup as O, type Params as P, type QueryPayload as Q, type RawCursorMeta as R, type Sort as S, type UrlConfig as U, type CursorPayload as a, type InfinitePayload as b, type ListPayload as c, type Filter as d, type FieldCondition as e, type FilterNode as f, type SortInput as g, type CursorMeta as h, type RawInfiniteMeta as i, type InfiniteMeta as j, type RawMeta as k, type FieldDescriptor as l, type FilterOperator as m, type FilterScalar as n, type FilterValue as o, type ListSchema as p, type SortDirection as q, decodeSort as r, defineListSchema as s, encodeSort as t, readListParams as u, resetParams as v, schemaToFilter as w, searchParamsToPayload as x, setPage as y, setParam as z };