filter-kit 2.0.0

package/dist/esm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,YAAY,EACV,mBAAmB,EACnB,cAAc,EACd,kBAAkB,EAClB,WAAW,EACX,iBAAiB,EACjB,eAAe,EACf,eAAe,EACf,gBAAgB,GACjB,MAAM,SAAS,CAAC"}

package/dist/esm/index.js

@@ -0,0 +1,2 @@
+export { queryBuilder } from './queryBuilder';
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/dist/esm/queryBuilder.d.ts

@@ -0,0 +1,3 @@
+import { QueryBuilderOptions, QueryBuilderResult } from './types';
+export declare function queryBuilder<T = any>(options: QueryBuilderOptions<T>): Promise<QueryBuilderResult<T>>;
+//# sourceMappingURL=queryBuilder.d.ts.map

package/dist/esm/queryBuilder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryBuilder.d.ts","sourceRoot":"","sources":["../../src/queryBuilder.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAkB,MAAM,SAAS,CAAC;AAQlF,wBAAsB,YAAY,CAAC,CAAC,GAAG,GAAG,EACxC,OAAO,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAC9B,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAwHhC"}

package/dist/esm/queryBuilder.js

@@ -0,0 +1,72 @@
+import { buildSearch } from './filters/buildSearch';
+import { buildPagination } from './filters/buildPagination';
+import { buildSort } from './filters/buildSort';
+import { buildDateFilter } from './filters/buildDateFilter';
+import { buildPopulate } from './filters/buildPopulate';
+import { buildDynamicFilters } from './filters/buildDynamicFilters';
+export async function queryBuilder(options) {
+    var _a, _b;
+    const { model, query, searchFields, searchMode = 'or', allowedFilters, defaultSort = 'createdAt', defaultOrder = 'desc', defaultLimit = 10, maxLimit = 100, populate: optionPopulate, select: optionSelect, dateField, dateFields, lean = false, customFilter, softDelete, withCount = true, } = options;
+    const filterParts = [];
+    const searchFilter = buildSearch(query['search'], searchFields, searchMode);
+    if (Object.keys(searchFilter).length > 0)
+        filterParts.push(searchFilter);
+    // Single dateField (backward compat)
+    if (dateField) {
+        const dateFilter = buildDateFilter(query['from'], query['to'], dateField);
+        if (Object.keys(dateFilter).length > 0)
+            filterParts.push(dateFilter);
+    }
+    // Multiple dateFields
+    for (const cfg of dateFields !== null && dateFields !== void 0 ? dateFields : []) {
+        const dateFilter = buildDateFilter(query[(_a = cfg.fromParam) !== null && _a !== void 0 ? _a : 'from'], query[(_b = cfg.toParam) !== null && _b !== void 0 ? _b : 'to'], cfg.field);
+        if (Object.keys(dateFilter).length > 0)
+            filterParts.push(dateFilter);
+    }
+    const dynamicFilter = buildDynamicFilters(query, allowedFilters, model);
+    if (Object.keys(dynamicFilter).length > 0)
+        filterParts.push(dynamicFilter);
+    if (customFilter && Object.keys(customFilter).length > 0) {
+        filterParts.push(customFilter);
+    }
+    if (softDelete) {
+        const excludeVal = softDelete.value !== undefined ? softDelete.value : true;
+        filterParts.push({ [softDelete.field]: { $ne: excludeVal } });
+    }
+    const filter = filterParts.length > 1
+        ? { $and: filterParts }
+        : filterParts.length === 1
+            ? filterParts[0]
+            : {};
+    const { page, limit, skip } = buildPagination(query['page'], query['limit'], defaultLimit, maxLimit);
+    const sort = buildSort(query['sort'], query['order'], defaultSort, defaultOrder);
+    const populateFields = buildPopulate(query['populate'], optionPopulate);
+    const selectParam = query['select'];
+    const selectValue = selectParam && selectParam.trim() !== ''
+        ? selectParam.replace(/,/g, ' ')
+        : optionSelect;
+    let findQuery = model.find(filter).sort(sort).skip(skip).limit(limit);
+    for (const pop of populateFields) {
+        findQuery = findQuery.populate(pop);
+    }
+    if (selectValue !== undefined && selectValue !== null) {
+        findQuery = findQuery.select(selectValue);
+    }
+    if (lean) {
+        findQuery = findQuery.lean();
+    }
+    const [data, total] = withCount
+        ? await Promise.all([findQuery.exec(), model.countDocuments(filter)])
+        : [await findQuery.exec(), 0];
+    const pages = withCount ? Math.ceil(total / limit) : 0;
+    const pagination = {
+        total,
+        page,
+        limit,
+        pages,
+        hasNext: withCount ? page < pages : false,
+        hasPrev: page > 1,
+    };
+    return { data, pagination };
+}
+//# sourceMappingURL=queryBuilder.js.map

package/dist/esm/queryBuilder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryBuilder.js","sourceRoot":"","sources":["../../src/queryBuilder.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AAEpE,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,OAA+B;;IAE/B,MAAM,EACJ,KAAK,EACL,KAAK,EACL,YAAY,EACZ,UAAU,GAAG,IAAI,EACjB,cAAc,EACd,WAAW,GAAG,WAAW,EACzB,YAAY,GAAG,MAAM,EACrB,YAAY,GAAG,EAAE,EACjB,QAAQ,GAAG,GAAG,EACd,QAAQ,EAAE,cAAc,EACxB,MAAM,EAAE,YAAY,EACpB,SAAS,EACT,UAAU,EACV,IAAI,GAAG,KAAK,EACZ,YAAY,EACZ,UAAU,EACV,SAAS,GAAG,IAAI,GACjB,GAAG,OAAO,CAAC;IAEZ,MAAM,WAAW,GAAqB,EAAE,CAAC;IAEzC,MAAM,YAAY,GAAG,WAAW,CAAC,KAAK,CAAC,QAAQ,CAAuB,EAAE,YAAY,EAAE,UAAU,CAAC,CAAC;IAClG,IAAI,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,MAAM,GAAG,CAAC;QAAE,WAAW,CAAC,IAAI,CAAC,YAA8B,CAAC,CAAC;IAE3F,qCAAqC;IACrC,IAAI,SAAS,EAAE,CAAC;QACd,MAAM,UAAU,GAAG,eAAe,CAChC,KAAK,CAAC,MAAM,CAAuB,EACnC,KAAK,CAAC,IAAI,CAAuB,EACjC,SAAS,CACV,CAAC;QACF,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC;YAAE,WAAW,CAAC,IAAI,CAAC,UAA4B,CAAC,CAAC;IACzF,CAAC;IAED,sBAAsB;IACtB,KAAK,MAAM,GAAG,IAAI,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,EAAE,EAAE,CAAC;QACnC,MAAM,UAAU,GAAG,eAAe,CAChC,KAAK,CAAC,MAAA,GAAG,CAAC,SAAS,mCAAI,MAAM,CAAuB,EACpD,KAAK,CAAC,MAAA,GAAG,CAAC,OAAO,mCAAI,IAAI,CAAuB,EAChD,GAAG,CAAC,KAAK,CACV,CAAC;QACF,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC;YAAE,WAAW,CAAC,IAAI,CAAC,UAA4B,CAAC,CAAC;IACzF,CAAC;IAED,MAAM,aAAa,GAAG,mBAAmB,CAAC,KAAK,EAAE,cAAc,EAAE,KAAK,CAAC,CAAC;IACxE,IAAI,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,MAAM,GAAG,CAAC;QAAE,WAAW,CAAC,IAAI,CAAC,aAA+B,CAAC,CAAC;IAE7F,IAAI,YAAY,IAAI,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACzD,WAAW,CAAC,IAAI,CAAC,YAA8B,CAAC,CAAC;IACnD,CAAC;IAED,IAAI,UAAU,EAAE,CAAC;QACf,MAAM,UAAU,GAAG,UAAU,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;QAC5E,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,EAAE,GAAG,EAAE,UAAU,EAAE,EAAoB,CAAC,CAAC;IAClF,CAAC;IAED,MAAM,MAAM,GACV,WAAW,CAAC,MAAM,GAAG,CAAC;QACpB,CAAC,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE;QACvB,CAAC,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC;YACxB,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;YAChB,CAAC,CAAC,EAAE,CAAC;IAEX,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,eAAe,CAC3C,KAAK,CAAC,MAAM,CAAuB,EACnC,KAAK,CAAC,OAAO,CAAuB,EACpC,YAAY,EACZ,QAAQ,CACT,CAAC;IAEF,MAAM,IAAI,GAAG,SAAS,CACpB,KAAK,CAAC,MAAM,CAAuB,EACnC,KAAK,CAAC,OAAO,CAAuB,EACpC,WAAW,EACX,YAAY,CACb,CAAC;IAEF,MAAM,cAAc,GAAG,aAAa,CAClC,KAAK,CAAC,UAAU,CAAuB,EACvC,cAAc,CACf,CAAC;IAEF,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,CAAuB,CAAC;IAC1D,MAAM,WAAW,GACf,WAAW,IAAI,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE;QACtC,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC;QAChC,CAAC,CAAC,YAAY,CAAC;IAEnB,IAAI,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAEtE,KAAK,MAAM,GAAG,IAAI,cAAc,EAAE,CAAC;QACjC,SAAS,GAAG,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACtC,CAAC;IAED,IAAI,WAAW,KAAK,SAAS,IAAI,WAAW,KAAK,IAAI,EAAE,CAAC;QACtD,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC,WAAkB,CAAC,CAAC;IACnD,CAAC;IAED,IAAI,IAAI,EAAE,CAAC;QACT,SAAS,GAAG,SAAS,CAAC,IAAI,EAAsB,CAAC;IACnD,CAAC;IAED,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,SAAS;QAC7B,CAAC,CAAC,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,IAAI,EAAkB,EAAE,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;QACrF,CAAC,CAAC,CAAC,MAAO,SAAS,CAAC,IAAI,EAAmB,EAAE,CAAC,CAAC,CAAC;IAElD,MAAM,KAAK,GAAG,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAEvD,MAAM,UAAU,GAAmB;QACjC,KAAK;QACL,IAAI;QACJ,KAAK;QACL,KAAK;QACL,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK;QACzC,OAAO,EAAE,IAAI,GAAG,CAAC;KAClB,CAAC;IAEF,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;AAC9B,CAAC"}

package/dist/esm/types.d.ts

@@ -0,0 +1,48 @@
+import { Model, PopulateOptions, ProjectionType } from 'mongoose';
+export type SearchFieldType = 'string' | 'number' | 'exact';
+export interface SearchFieldConfig {
+    field: string;
+    type?: SearchFieldType;
+}
+export type SearchField = string | SearchFieldConfig;
+export interface DateFieldConfig {
+    field: string;
+    fromParam?: string;
+    toParam?: string;
+}
+export interface SoftDeleteConfig {
+    field: string;
+    value?: any;
+}
+export interface QueryBuilderOptions<T = any> {
+    model: Model<T>;
+    query: Record<string, any>;
+    searchFields?: SearchField[];
+    searchMode?: 'or' | 'and';
+    allowedFilters?: string[];
+    defaultSort?: string;
+    defaultOrder?: 'asc' | 'desc';
+    defaultLimit?: number;
+    maxLimit?: number;
+    populate?: string | string[] | PopulateOptions | PopulateOptions[];
+    select?: ProjectionType<T> | string;
+    dateField?: string;
+    dateFields?: DateFieldConfig[];
+    lean?: boolean;
+    customFilter?: Record<string, any>;
+    softDelete?: SoftDeleteConfig;
+    withCount?: boolean;
+}
+export interface PaginationMeta {
+    total: number;
+    page: number;
+    limit: number;
+    pages: number;
+    hasNext: boolean;
+    hasPrev: boolean;
+}
+export interface QueryBuilderResult<T = any> {
+    data: T[];
+    pagination: PaginationMeta;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/esm/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAElE,MAAM,MAAM,eAAe,GAAG,QAAQ,GAAG,QAAQ,GAAG,OAAO,CAAC;AAE5D,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,eAAe,CAAC;CACxB;AAED,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,iBAAiB,CAAC;AAErD,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,GAAG,CAAC;CACb;AAED,MAAM,WAAW,mBAAmB,CAAC,CAAC,GAAG,GAAG;IAC1C,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC3B,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC;IAC7B,UAAU,CAAC,EAAE,IAAI,GAAG,KAAK,CAAC;IAC1B,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAC9B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,eAAe,GAAG,eAAe,EAAE,CAAC;IACnE,MAAM,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;IACpC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,eAAe,EAAE,CAAC;IAC/B,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACnC,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,kBAAkB,CAAC,CAAC,GAAG,GAAG;IACzC,IAAI,EAAE,CAAC,EAAE,CAAC;IACV,UAAU,EAAE,cAAc,CAAC;CAC5B"}

package/dist/esm/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/esm/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "filter-kit",
+  "version": "2.0.0",
+  "description": "Powerful Mongoose query builder — smart search (string + number), deep populate (4 levels), multi-sort, operator filters, date ranges, soft-delete, pagination",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/cjs/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      }
+    }
+  },
+  "files": ["dist"],
+  "scripts": {
+    "clean": "node -e \"require('fs').rmSync('dist', { recursive: true, force: true })\"",
+    "build": "npm run clean && npm run build:cjs && npm run build:esm && node scripts/postbuild.js",
+    "build:cjs": "tsc -p tsconfig.build.json",
+    "build:esm": "tsc -p tsconfig.esm.json",
+    "dev": "tsc -w -p tsconfig.build.json",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage",
+    "lint": "eslint src --ext .ts",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "mongoose", "mongodb", "query-builder", "filter", "pagination",
+    "search", "sorting", "date-filter", "populate", "dynamic-filter",
+    "admin-panel", "rest-api", "express", "nestjs", "mongoose-query",
+    "mongodb-filter", "mongoose-pagination", "mongoose-search",
+    "api-query", "mongoose-utils", "javascript", "typescript"
+  ],
+  "author": "parthpatel2597",
+  "license": "MIT",
+  "peerDependencies": { "mongoose": ">=6.0.0" },
+  "devDependencies": {
+    "@types/jest": "^29.5.0",
+    "@types/node": "^20.0.0",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
+    "eslint": "^8.0.0",
+    "jest": "^29.0.0",
+    "mongoose": "^8.0.0",
+    "ts-jest": "^29.0.0",
+    "typescript": "^5.0.0"
+  }
+}