core-services-sdk 1.3.63 → 1.3.65
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/package.json +1 -1
- package/src/core/normalize-phone-number.js +144 -25
- package/src/postgresql/core/get-table-name.js +10 -0
- package/src/postgresql/filters/apply-filter-object.js +19 -0
- package/src/postgresql/filters/apply-filter-snake-case.js +16 -0
- package/src/postgresql/filters/apply-filter.js +33 -0
- package/src/postgresql/filters/operators.js +32 -0
- package/src/postgresql/index.js +5 -2
- package/src/postgresql/modifiers/apply-order-by.js +19 -0
- package/src/postgresql/modifiers/apply-pagination.js +12 -0
- package/src/postgresql/pagination/paginate.js +48 -0
- package/tests/core/normalize-phone-number.unit.test.js +45 -0
- package/tests/postgresql/apply-filter-snake-case.integration.test.js +220 -0
- package/tests/postgresql/apply-filter.integration.test.js +34 -353
- package/tests/postgresql/core/get-table-name.unit.test.js +20 -0
- package/tests/postgresql/filters/apply-filter-object.test.js +23 -0
- package/tests/postgresql/filters/operators.unit.test.js +23 -0
- package/tests/postgresql/modifiers/apply-order-by.test.js +80 -0
- package/tests/postgresql/modifiers/apply-pagination.unit.test.js +18 -0
- package/tests/postgresql/paginate.integration.test.js +10 -18
- package/tests/postgresql/pagination/paginate.js +48 -0
- package/tests/postgresql/validate-schema.integration.test.js +9 -5
- package/types/core/normalize-phone-number.d.ts +97 -27
- package/types/postgresql/apply-filter.d.ts +131 -20
- package/types/postgresql/core/get-table-name.d.ts +10 -0
- package/types/postgresql/filters/apply-filter-object.d.ts +15 -0
- package/types/postgresql/filters/apply-filter-snake-case.d.ts +14 -0
- package/types/postgresql/filters/apply-filter.d.ts +15 -0
- package/types/postgresql/filters/operators.d.ts +14 -0
- package/types/postgresql/index.d.ts +5 -2
- package/types/postgresql/modifiers/apply-order-by.d.ts +17 -0
- package/types/postgresql/modifiers/apply-pagination.d.ts +17 -0
- package/types/postgresql/pagination/paginate.d.ts +29 -0
- package/src/postgresql/apply-filter.js +0 -275
- package/src/postgresql/paginate.js +0 -61
|
@@ -1,275 +0,0 @@
|
|
|
1
|
-
import { toSnakeCase } from '../core/case-mapper.js'
|
|
2
|
-
|
|
3
|
-
/**
|
|
4
|
-
* @typedef {Object} OperatorFunction
|
|
5
|
-
* @property {import('knex').Knex.QueryBuilder} query - Knex query builder instance
|
|
6
|
-
* @property {string} key - Column name (qualified with table name)
|
|
7
|
-
* @property {*} value - Value to compare against
|
|
8
|
-
* @returns {import('knex').Knex.QueryBuilder} Modified query builder
|
|
9
|
-
*/
|
|
10
|
-
|
|
11
|
-
/**
|
|
12
|
-
* Map of filter operators to their corresponding Knex query builder methods.
|
|
13
|
-
* Each operator function applies a WHERE condition to the query.
|
|
14
|
-
*
|
|
15
|
-
* @type {Object<string, OperatorFunction>}
|
|
16
|
-
* @private
|
|
17
|
-
*/
|
|
18
|
-
const OPERATORS = {
|
|
19
|
-
/**
|
|
20
|
-
* Array membership operator. Checks if column value is in the provided array.
|
|
21
|
-
* @param {import('knex').Knex.QueryBuilder} q - Query builder
|
|
22
|
-
* @param {string} key - Column name
|
|
23
|
-
* @param {Array<*>} value - Array of values to match
|
|
24
|
-
* @returns {import('knex').Knex.QueryBuilder} Query with WHERE IN clause
|
|
25
|
-
*/
|
|
26
|
-
in: (q, key, value) => q.whereIn(key, value),
|
|
27
|
-
|
|
28
|
-
/**
|
|
29
|
-
* Not in array operator. Checks if column value is NOT in the provided array.
|
|
30
|
-
* @param {import('knex').Knex.QueryBuilder} q - Query builder
|
|
31
|
-
* @param {string} key - Column name
|
|
32
|
-
* @param {Array<*>} value - Array of values to exclude
|
|
33
|
-
* @returns {import('knex').Knex.QueryBuilder} Query with WHERE NOT IN clause
|
|
34
|
-
*/
|
|
35
|
-
nin: (q, key, value) => q.whereNotIn(key, value),
|
|
36
|
-
|
|
37
|
-
/**
|
|
38
|
-
* Equality operator. Checks if column value equals the provided value.
|
|
39
|
-
* @param {import('knex').Knex.QueryBuilder} q - Query builder
|
|
40
|
-
* @param {string} key - Column name
|
|
41
|
-
* @param {*} value - Value to match
|
|
42
|
-
* @returns {import('knex').Knex.QueryBuilder} Query with WHERE = clause
|
|
43
|
-
*/
|
|
44
|
-
eq: (q, key, value) => q.where(key, '=', value),
|
|
45
|
-
|
|
46
|
-
/**
|
|
47
|
-
* Not equal operator. Checks if column value does not equal the provided value.
|
|
48
|
-
* @param {import('knex').Knex.QueryBuilder} q - Query builder
|
|
49
|
-
* @param {string} key - Column name
|
|
50
|
-
* @param {*} value - Value to exclude
|
|
51
|
-
* @returns {import('knex').Knex.QueryBuilder} Query with WHERE != clause
|
|
52
|
-
*/
|
|
53
|
-
ne: (q, key, value) => q.where(key, '!=', value),
|
|
54
|
-
|
|
55
|
-
/**
|
|
56
|
-
* Not equal operator (alias for `ne`). Checks if column value does not equal the provided value.
|
|
57
|
-
* @param {import('knex').Knex.QueryBuilder} q - Query builder
|
|
58
|
-
* @param {string} key - Column name
|
|
59
|
-
* @param {*} value - Value to exclude
|
|
60
|
-
* @returns {import('knex').Knex.QueryBuilder} Query with WHERE != clause
|
|
61
|
-
*/
|
|
62
|
-
neq: (q, key, value) => q.where(key, '!=', value),
|
|
63
|
-
|
|
64
|
-
/**
|
|
65
|
-
* Greater than operator. Checks if column value is greater than the provided value.
|
|
66
|
-
* @param {import('knex').Knex.QueryBuilder} q - Query builder
|
|
67
|
-
* @param {string} key - Column name
|
|
68
|
-
* @param {number|string|Date} value - Value to compare against
|
|
69
|
-
* @returns {import('knex').Knex.QueryBuilder} Query with WHERE > clause
|
|
70
|
-
*/
|
|
71
|
-
gt: (q, key, value) => q.where(key, '>', value),
|
|
72
|
-
|
|
73
|
-
/**
|
|
74
|
-
* Greater than or equal operator. Checks if column value is greater than or equal to the provided value.
|
|
75
|
-
* @param {import('knex').Knex.QueryBuilder} q - Query builder
|
|
76
|
-
* @param {string} key - Column name
|
|
77
|
-
* @param {number|string|Date} value - Value to compare against
|
|
78
|
-
* @returns {import('knex').Knex.QueryBuilder} Query with WHERE >= clause
|
|
79
|
-
*/
|
|
80
|
-
gte: (q, key, value) => q.where(key, '>=', value),
|
|
81
|
-
|
|
82
|
-
/**
|
|
83
|
-
* Less than operator. Checks if column value is less than the provided value.
|
|
84
|
-
* @param {import('knex').Knex.QueryBuilder} q - Query builder
|
|
85
|
-
* @param {string} key - Column name
|
|
86
|
-
* @param {number|string|Date} value - Value to compare against
|
|
87
|
-
* @returns {import('knex').Knex.QueryBuilder} Query with WHERE < clause
|
|
88
|
-
*/
|
|
89
|
-
lt: (q, key, value) => q.where(key, '<', value),
|
|
90
|
-
|
|
91
|
-
/**
|
|
92
|
-
* Less than or equal operator. Checks if column value is less than or equal to the provided value.
|
|
93
|
-
* @param {import('knex').Knex.QueryBuilder} q - Query builder
|
|
94
|
-
* @param {string} key - Column name
|
|
95
|
-
* @param {number|string|Date} value - Value to compare against
|
|
96
|
-
* @returns {import('knex').Knex.QueryBuilder} Query with WHERE <= clause
|
|
97
|
-
*/
|
|
98
|
-
lte: (q, key, value) => q.where(key, '<=', value),
|
|
99
|
-
|
|
100
|
-
/**
|
|
101
|
-
* Case-sensitive pattern matching operator. Uses SQL LIKE for pattern matching.
|
|
102
|
-
* Supports wildcards: `%` (any sequence) and `_` (single character).
|
|
103
|
-
* @param {import('knex').Knex.QueryBuilder} q - Query builder
|
|
104
|
-
* @param {string} key - Column name
|
|
105
|
-
* @param {string} value - Pattern to match (e.g., '%invoice%')
|
|
106
|
-
* @returns {import('knex').Knex.QueryBuilder} Query with WHERE LIKE clause
|
|
107
|
-
*/
|
|
108
|
-
like: (q, key, value) => q.where(key, 'like', value),
|
|
109
|
-
|
|
110
|
-
/**
|
|
111
|
-
* Case-insensitive pattern matching operator. Uses PostgreSQL ILIKE for pattern matching.
|
|
112
|
-
* Supports wildcards: `%` (any sequence) and `_` (single character).
|
|
113
|
-
* @param {import('knex').Knex.QueryBuilder} q - Query builder
|
|
114
|
-
* @param {string} key - Column name
|
|
115
|
-
* @param {string} value - Pattern to match (e.g., '%invoice%')
|
|
116
|
-
* @returns {import('knex').Knex.QueryBuilder} Query with WHERE ILIKE clause
|
|
117
|
-
*/
|
|
118
|
-
ilike: (q, key, value) => q.where(key, 'ilike', value),
|
|
119
|
-
|
|
120
|
-
/**
|
|
121
|
-
* Null check operator. Checks if column value is NULL or NOT NULL based on the boolean value.
|
|
122
|
-
* @param {import('knex').Knex.QueryBuilder} q - Query builder
|
|
123
|
-
* @param {string} key - Column name
|
|
124
|
-
* @param {boolean} value - If true, checks for NULL; if false, checks for NOT NULL
|
|
125
|
-
* @returns {import('knex').Knex.QueryBuilder} Query with WHERE NULL or WHERE NOT NULL clause
|
|
126
|
-
*/
|
|
127
|
-
isNull: (q, key, value) => (value ? q.whereNull(key) : q.whereNotNull(key)),
|
|
128
|
-
|
|
129
|
-
/**
|
|
130
|
-
* Not null check operator. Checks if column value is NOT NULL or NULL based on the boolean value.
|
|
131
|
-
* @param {import('knex').Knex.QueryBuilder} q - Query builder
|
|
132
|
-
* @param {string} key - Column name
|
|
133
|
-
* @param {boolean} value - If true, checks for NOT NULL; if false, checks for NULL
|
|
134
|
-
* @returns {import('knex').Knex.QueryBuilder} Query with WHERE NOT NULL or WHERE NULL clause
|
|
135
|
-
*/
|
|
136
|
-
isNotNull: (q, key, value) =>
|
|
137
|
-
value ? q.whereNotNull(key) : q.whereNull(key),
|
|
138
|
-
}
|
|
139
|
-
|
|
140
|
-
/**
|
|
141
|
-
* Applies filter operators from an object to a Knex query.
|
|
142
|
-
* Processes each operator in the value object and applies the corresponding WHERE clause.
|
|
143
|
-
* Unknown operators are silently ignored.
|
|
144
|
-
*
|
|
145
|
-
* @param {import('knex').Knex.QueryBuilder} q - Knex query builder instance
|
|
146
|
-
* @param {string} qualifiedKey - Fully qualified column name (e.g., "table.column")
|
|
147
|
-
* @param {Object<string, *>} value - Object containing operator-value pairs
|
|
148
|
-
* @returns {import('knex').Knex.QueryBuilder} Modified query builder with applied filters
|
|
149
|
-
* @private
|
|
150
|
-
*
|
|
151
|
-
* @example
|
|
152
|
-
* // Apply multiple operators on the same field
|
|
153
|
-
* applyFilterObject(query, 'assets.price', { gte: 100, lte: 200 })
|
|
154
|
-
* // Results in: WHERE assets.price >= 100 AND assets.price <= 200
|
|
155
|
-
*/
|
|
156
|
-
const applyFilterObject = (q, qualifiedKey, value) => {
|
|
157
|
-
return Object.entries(value).reduce(
|
|
158
|
-
(q, [operator, val]) =>
|
|
159
|
-
OPERATORS[operator] ? OPERATORS[operator](q, qualifiedKey, val) : q,
|
|
160
|
-
q,
|
|
161
|
-
)
|
|
162
|
-
}
|
|
163
|
-
|
|
164
|
-
/**
|
|
165
|
-
* Builds a Knex query with MongoDB-style filter operators.
|
|
166
|
-
* Pure utility function that can be used across repositories.
|
|
167
|
-
*
|
|
168
|
-
* This function converts camelCase filter keys to snake_case and applies
|
|
169
|
-
* various filter operators to build SQL WHERE clauses. All column names
|
|
170
|
-
* are automatically qualified with the provided table name.
|
|
171
|
-
*
|
|
172
|
-
* **Supported Operators:**
|
|
173
|
-
* - `eq` - Equality (default for simple values)
|
|
174
|
-
* - `ne` / `neq` - Not equal
|
|
175
|
-
* - `in` - Array membership (or pass array directly)
|
|
176
|
-
* - `nin` - Not in array
|
|
177
|
-
* - `gt` - Greater than
|
|
178
|
-
* - `gte` - Greater than or equal
|
|
179
|
-
* - `lt` - Less than
|
|
180
|
-
* - `lte` - Less than or equal
|
|
181
|
-
* - `like` - Case-sensitive pattern matching (SQL LIKE)
|
|
182
|
-
* - `ilike` - Case-insensitive pattern matching (PostgreSQL ILIKE)
|
|
183
|
-
* - `isNull` - Check if field is NULL
|
|
184
|
-
* - `isNotNull` - Check if field is NOT NULL
|
|
185
|
-
*
|
|
186
|
-
* **Key Features:**
|
|
187
|
-
* - Automatic camelCase to snake_case conversion for filter keys
|
|
188
|
-
* - Qualified column names (table.column format)
|
|
189
|
-
* - Multiple operators can be applied to the same field
|
|
190
|
-
* - Unknown operators are silently ignored
|
|
191
|
-
* - Arrays are automatically converted to IN clauses
|
|
192
|
-
*
|
|
193
|
-
* @param {Object} params - Function parameters
|
|
194
|
-
* @param {import('knex').Knex.QueryBuilder} params.query - Knex query builder instance to apply filters to
|
|
195
|
-
* @param {Object<string, *>} params.filter - Filter object with camelCase keys (will be converted to snake_case)
|
|
196
|
-
* Filter values can be:
|
|
197
|
-
* - Simple values (string, number, boolean) → treated as equality
|
|
198
|
-
* - Arrays → treated as IN operator
|
|
199
|
-
* - Objects with operator keys → apply specific operators
|
|
200
|
-
* @param {string} params.tableName - Table name used to qualify column names (e.g., "assets" → "assets.column_name")
|
|
201
|
-
* @returns {import('knex').Knex.QueryBuilder} Modified query builder with applied WHERE clauses
|
|
202
|
-
*
|
|
203
|
-
* @throws {TypeError} If query is not a valid Knex QueryBuilder instance
|
|
204
|
-
*
|
|
205
|
-
* @example
|
|
206
|
-
* // Simple equality - converts to WHERE assets.status = 'active'
|
|
207
|
-
* const query = db('assets').select('*')
|
|
208
|
-
* applyFilter({ query, filter: { status: 'active' }, tableName: 'assets' })
|
|
209
|
-
*
|
|
210
|
-
* @example
|
|
211
|
-
* // Not equal - converts to WHERE assets.status != 'deleted'
|
|
212
|
-
* applyFilter({ query, filter: { status: { ne: 'deleted' } }, tableName: 'assets' })
|
|
213
|
-
*
|
|
214
|
-
* @example
|
|
215
|
-
* // Array/IN operator - converts to WHERE assets.status IN ('active', 'pending')
|
|
216
|
-
* applyFilter({ query, filter: { status: ['active', 'pending'] }, tableName: 'assets' })
|
|
217
|
-
*
|
|
218
|
-
* @example
|
|
219
|
-
* // Explicit IN operator
|
|
220
|
-
* applyFilter({ query, filter: { status: { in: ['active', 'pending'] } }, tableName: 'assets' })
|
|
221
|
-
*
|
|
222
|
-
* @example
|
|
223
|
-
* // Not in array - converts to WHERE assets.status NOT IN ('deleted', 'archived')
|
|
224
|
-
* applyFilter({ query, filter: { status: { nin: ['deleted', 'archived'] } }, tableName: 'assets' })
|
|
225
|
-
*
|
|
226
|
-
* @example
|
|
227
|
-
* // Range operators - converts to WHERE assets.price >= 100 AND assets.price <= 200
|
|
228
|
-
* applyFilter({ query, filter: { price: { gte: 100, lte: 200 } }, tableName: 'assets' })
|
|
229
|
-
*
|
|
230
|
-
* @example
|
|
231
|
-
* // Pattern matching (case-sensitive) - converts to WHERE assets.name LIKE '%invoice%'
|
|
232
|
-
* applyFilter({ query, filter: { name: { like: '%invoice%' } }, tableName: 'assets' })
|
|
233
|
-
*
|
|
234
|
-
* @example
|
|
235
|
-
* // Pattern matching (case-insensitive) - converts to WHERE assets.name ILIKE '%invoice%'
|
|
236
|
-
* applyFilter({ query, filter: { name: { ilike: '%invoice%' } }, tableName: 'assets' })
|
|
237
|
-
*
|
|
238
|
-
* @example
|
|
239
|
-
* // Null checks - converts to WHERE assets.deleted_at IS NULL
|
|
240
|
-
* applyFilter({ query, filter: { deletedAt: { isNull: true } }, tableName: 'assets' })
|
|
241
|
-
*
|
|
242
|
-
* @example
|
|
243
|
-
* // Multiple filters - converts to WHERE assets.status = 'active' AND assets.type = 'invoice' AND assets.price >= 100
|
|
244
|
-
* applyFilter({
|
|
245
|
-
* query,
|
|
246
|
-
* filter: {
|
|
247
|
-
* status: 'active',
|
|
248
|
-
* type: 'invoice',
|
|
249
|
-
* price: { gte: 100 }
|
|
250
|
-
* },
|
|
251
|
-
* tableName: 'assets'
|
|
252
|
-
* })
|
|
253
|
-
*
|
|
254
|
-
* @example
|
|
255
|
-
* // camelCase conversion - deletedAt converts to deleted_at
|
|
256
|
-
* applyFilter({ query, filter: { deletedAt: { isNull: true } }, tableName: 'assets' })
|
|
257
|
-
* // SQL: WHERE assets.deleted_at IS NULL
|
|
258
|
-
*/
|
|
259
|
-
export function applyFilter({ query, filter, tableName }) {
|
|
260
|
-
const convertedFilter = toSnakeCase(filter)
|
|
261
|
-
|
|
262
|
-
return Object.entries(convertedFilter).reduce((q, [key, value]) => {
|
|
263
|
-
const qualifiedKey = `${tableName}.${key}`
|
|
264
|
-
|
|
265
|
-
if (value && typeof value === 'object' && !Array.isArray(value)) {
|
|
266
|
-
return applyFilterObject(q, qualifiedKey, value)
|
|
267
|
-
}
|
|
268
|
-
|
|
269
|
-
if (Array.isArray(value)) {
|
|
270
|
-
return OPERATORS.in(q, qualifiedKey, value)
|
|
271
|
-
}
|
|
272
|
-
|
|
273
|
-
return OPERATORS.eq(q, qualifiedKey, value)
|
|
274
|
-
}, query)
|
|
275
|
-
}
|
|
@@ -1,61 +0,0 @@
|
|
|
1
|
-
import { toSnakeCase } from '../core/case-mapper.js'
|
|
2
|
-
import { normalizeNumberOrDefault } from '../core/normalize-premitives-types-or-default.js'
|
|
3
|
-
|
|
4
|
-
/**
|
|
5
|
-
* Generic pagination utility.
|
|
6
|
-
*
|
|
7
|
-
* @async
|
|
8
|
-
* @param {Object} params
|
|
9
|
-
* @param {Object} params.db
|
|
10
|
-
* @param {string} params.tableName
|
|
11
|
-
* @param {number} [params.page=1]
|
|
12
|
-
* @param {number} [params.limit=10]
|
|
13
|
-
* @param {Object} [params.filter={}]
|
|
14
|
-
* @param {Object} [params.orderBy]
|
|
15
|
-
* @param {string} params.orderBy.column
|
|
16
|
-
* @param {'asc'|'desc'} [params.orderBy.direction='asc']
|
|
17
|
-
* @returns {Promise<{
|
|
18
|
-
* list: any[],
|
|
19
|
-
* totalCount: number,
|
|
20
|
-
* totalPages: number,
|
|
21
|
-
* currentPage: number,
|
|
22
|
-
* hasNext: boolean,
|
|
23
|
-
* hasPrevious: boolean
|
|
24
|
-
* }>}
|
|
25
|
-
*/
|
|
26
|
-
|
|
27
|
-
export const sqlPaginate = async ({
|
|
28
|
-
db,
|
|
29
|
-
mapRow,
|
|
30
|
-
orderBy,
|
|
31
|
-
page = 1,
|
|
32
|
-
limit = 10,
|
|
33
|
-
tableName,
|
|
34
|
-
filter = {},
|
|
35
|
-
} = {}) => {
|
|
36
|
-
const offset = (page - 1) * limit
|
|
37
|
-
|
|
38
|
-
const query = orderBy?.column
|
|
39
|
-
? db(tableName)
|
|
40
|
-
.select('*')
|
|
41
|
-
.where(toSnakeCase(filter))
|
|
42
|
-
.orderBy(orderBy.column, orderBy.direction || 'asc')
|
|
43
|
-
: db(tableName).select('*').where(toSnakeCase(filter))
|
|
44
|
-
|
|
45
|
-
const [rows, countResult] = await Promise.all([
|
|
46
|
-
query.limit(limit).offset(offset),
|
|
47
|
-
db(tableName).where(toSnakeCase(filter)).count('* as count').first(),
|
|
48
|
-
])
|
|
49
|
-
|
|
50
|
-
const totalCount = normalizeNumberOrDefault(countResult?.count || 0)
|
|
51
|
-
const totalPages = Math.ceil(totalCount / limit)
|
|
52
|
-
|
|
53
|
-
return {
|
|
54
|
-
list: mapRow ? rows.map(mapRow) : rows,
|
|
55
|
-
totalCount,
|
|
56
|
-
totalPages,
|
|
57
|
-
currentPage: page,
|
|
58
|
-
hasPrevious: page > 1,
|
|
59
|
-
hasNext: page < totalPages,
|
|
60
|
-
}
|
|
61
|
-
}
|