@explorins/pers-shared 2.1.125 → 2.1.127

package/dist/esm/shared-lib/types/filter-options.type.d.ts

@@ -0,0 +1,86 @@
+import { BasePaginationQuery } from '../interfaces/base-pagination.interface';
+import { SortOrder } from '../enum';
+/**
+ * Base filter options shared across all list endpoints.
+ * Extends BasePaginationQuery for pagination/sorting.
+ *
+ * @example
+ * { active: true, tags: ['sports', 'outdoor'], search: 'coffee' }
+ */
+export interface BaseFilterOptions extends BasePaginationQuery {
+    /** Filter by active status */
+    active?: boolean;
+    /** @deprecated Use `active` instead */
+    isActive?: boolean;
+    /** Filter by tag(s) - single tag or array for OR match */
+    tags?: string | string[];
+    /** Free text search */
+    search?: string;
+    /** @deprecated Use `sortBy` instead */
+    sort?: string;
+    /** @deprecated Use `sortOrder` instead */
+    order?: SortOrder;
+}
+/**
+ * Filter options with date range support.
+ * Used by entities with start/end dates (campaigns, redemptions).
+ */
+export interface DateRangeFilterOptions extends BaseFilterOptions {
+    /** Filter items starting on or after this date */
+    startDate?: Date | string;
+    /** Filter items ending on or before this date */
+    endDate?: Date | string;
+    /** Override sortBy with date-aware fields */
+    sortBy?: 'name' | 'createdAt' | 'startDate';
+    /** @deprecated Use `sortBy` instead */
+    sort?: 'name' | 'createdAt' | 'startDate';
+}
+/**
+ * Campaign filter options for API and SDK.
+ *
+ * @example
+ * // Filter by business and date range
+ * { businessId: 'uuid', startDate: '2026-01-01', tags: 'sports' }
+ */
+export interface CampaignFilterOptions extends DateRangeFilterOptions {
+    /** Filter by business engagement */
+    businessId?: string;
+}
+/**
+ * Redemption filter options for API and SDK.
+ *
+ * @example
+ * { active: true, tags: 'voucher', startDate: '2026-01-01' }
+ */
+export interface RedemptionFilterOptions extends DateRangeFilterOptions {
+}
+/**
+ * Business filter options for API and SDK.
+ *
+ * @example
+ * { active: true, tags: ['restaurant', 'cafe'], search: 'coffee' }
+ */
+export interface BusinessFilterOptions extends BaseFilterOptions {
+    /** Sanitize user models (admin only) */
+    sanitize?: 'soft' | 'hard';
+    /** Override sortBy with business-specific fields */
+    sortBy?: 'name' | 'createdAt' | 'businessLegalName';
+}
+/**
+ * Normalizes filter options to use new field names while accepting deprecated ones.
+ * Use at controller level to support both old and new API contracts.
+ *
+ * @example
+ * // In controller
+ * const filters = normalizeFilters({ isActive: true, sort: 'name' });
+ * // Result: { active: true, sortBy: 'name', isActive: true, sort: 'name' }
+ */
+export declare function normalizeFilters<T extends {
+    active?: boolean;
+    isActive?: boolean;
+    sortBy?: string;
+    sort?: string;
+    sortOrder?: SortOrder;
+    order?: SortOrder;
+}>(filters?: T): T | undefined;
+//# sourceMappingURL=filter-options.type.d.ts.map

package/dist/esm/shared-lib/types/filter-options.type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filter-options.type.d.ts","sourceRoot":"","sources":["../../../../src/shared-lib/types/filter-options.type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,yCAAyC,CAAC;AAC9E,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEpC;;;;;;GAMG;AACH,MAAM,WAAW,iBAAkB,SAAQ,mBAAmB;IAC5D,8BAA8B;IAC9B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,uCAAuC;IACvC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,0DAA0D;IAC1D,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACzB,uBAAuB;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,uCAAuC;IACvC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,0CAA0C;IAC1C,KAAK,CAAC,EAAE,SAAS,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,iBAAiB;IAC/D,kDAAkD;IAClD,SAAS,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC;IAC1B,iDAAiD;IACjD,OAAO,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC;IACxB,6CAA6C;IAC7C,MAAM,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,WAAW,CAAC;IAC5C,uCAAuC;IACvC,IAAI,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,WAAW,CAAC;CAC3C;AAED;;;;;;GAMG;AACH,MAAM,WAAW,qBAAsB,SAAQ,sBAAsB;IACnE,oCAAoC;IACpC,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;GAKG;AACH,MAAM,WAAW,uBAAwB,SAAQ,sBAAsB;CAAG;AAE1E;;;;;GAKG;AACH,MAAM,WAAW,qBAAsB,SAAQ,iBAAiB;IAC9D,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC3B,oDAAoD;IACpD,MAAM,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,mBAAmB,CAAC;CACrD;AAED;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,SAAS;IACzC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,KAAK,CAAC,EAAE,SAAS,CAAA;CAClB,EAAE,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS,CAS7B"}

package/dist/esm/shared-lib/types/filter-options.type.js

@@ -0,0 +1,20 @@
+/**
+ * Normalizes filter options to use new field names while accepting deprecated ones.
+ * Use at controller level to support both old and new API contracts.
+ *
+ * @example
+ * // In controller
+ * const filters = normalizeFilters({ isActive: true, sort: 'name' });
+ * // Result: { active: true, sortBy: 'name', isActive: true, sort: 'name' }
+ */
+export function normalizeFilters(filters) {
+    if (!filters)
+        return undefined;
+    return {
+        ...filters,
+        active: filters.active ?? filters.isActive,
+        sortBy: filters.sortBy ?? filters.sort,
+        sortOrder: filters.sortOrder ?? filters.order,
+    };
+}
+//# sourceMappingURL=filter-options.type.js.map

package/dist/esm/shared-lib/types/filter-options.type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filter-options.type.js","sourceRoot":"","sources":["../../../../src/shared-lib/types/filter-options.type.ts"],"names":[],"mappings":"AAyEA;;;;;;;;GAQG;AACH,MAAM,UAAU,gBAAgB,CAO7B,OAAW;IACZ,IAAI,CAAC,OAAO;QAAE,OAAO,SAAS,CAAC;IAE/B,OAAO;QACL,GAAG,OAAO;QACV,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,QAAQ;QAC1C,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,IAAI;QACtC,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,OAAO,CAAC,KAAK;KACzC,CAAC;AACT,CAAC"}

package/dist/esm/shared-lib/types/index.d.ts

@@ -14,4 +14,5 @@ export * from './redemption-include-relation.type';
 export * from './redemption-redeem-include-relation.type';
 export * from './business-membership-include-relation.type';
 export * from './user-include-relation.type';
+export * from './filter-options.type';
 //# sourceMappingURL=index.d.ts.map

package/dist/esm/shared-lib/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/shared-lib/types/index.ts"],"names":[],"mappings":"AACA,cAAc,kBAAkB,CAAC;AACjC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,yBAAyB,CAAC;AACxC,cAAc,WAAW,CAAC;AAC1B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,qCAAqC,CAAC;AACpD,cAAc,kCAAkC,CAAC;AACjD,cAAc,wCAAwC,CAAC;AACvD,cAAc,oCAAoC,CAAC;AACnD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,6CAA6C,CAAC;AAC5D,cAAc,8BAA8B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/shared-lib/types/index.ts"],"names":[],"mappings":"AACA,cAAc,kBAAkB,CAAC;AACjC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,yBAAyB,CAAC;AACxC,cAAc,WAAW,CAAC;AAC1B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,qCAAqC,CAAC;AACpD,cAAc,kCAAkC,CAAC;AACjD,cAAc,wCAAwC,CAAC;AACvD,cAAc,oCAAoC,CAAC;AACnD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,6CAA6C,CAAC;AAC5D,cAAc,8BAA8B,CAAC;AAC7C,cAAc,uBAAuB,CAAC"}

package/dist/esm/shared-lib/types/index.js

@@ -15,4 +15,5 @@ export * from './redemption-include-relation.type.js';
 export * from './redemption-redeem-include-relation.type.js';
 export * from './business-membership-include-relation.type.js';
 export * from './user-include-relation.type.js';
+export * from './filter-options.type.js';
 //# sourceMappingURL=index.js.map

package/dist/esm/shared-lib/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/shared-lib/types/index.ts"],"names":[],"mappings":"AAAA,mDAAmD;AACnD,cAAc,kBAAkB,CAAC;AACjC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,yBAAyB,CAAC;AACxC,cAAc,WAAW,CAAC;AAC1B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,qCAAqC,CAAC;AACpD,cAAc,kCAAkC,CAAC;AACjD,cAAc,wCAAwC,CAAC;AACvD,cAAc,oCAAoC,CAAC;AACnD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,6CAA6C,CAAC;AAC5D,cAAc,8BAA8B,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/shared-lib/types/index.ts"],"names":[],"mappings":"AAAA,mDAAmD;AACnD,cAAc,kBAAkB,CAAC;AACjC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,yBAAyB,CAAC;AACxC,cAAc,WAAW,CAAC;AAC1B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,qCAAqC,CAAC;AACpD,cAAc,kCAAkC,CAAC;AACjD,cAAc,wCAAwC,CAAC;AACvD,cAAc,oCAAoC,CAAC;AACnD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,6CAA6C,CAAC;AAC5D,cAAc,8BAA8B,CAAC;AAC7C,cAAc,uBAAuB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@explorins/pers-shared",
-  "version": "2.1.125",
+  "version": "2.1.127",
   "scripts": {
     "clean": "find dist -type f -delete 2>/dev/null || true",
     "build:esm": "tsc -p tsconfig.esm.json && node scripts/add-js-extensions.js",