@forinda/kickjs-drizzle 2.0.1 → 2.1.0
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/dist/index.d.mts +340 -0
- package/dist/index.d.mts.map +1 -0
- package/dist/index.mjs +297 -0
- package/dist/index.mjs.map +1 -0
- package/package.json +27 -10
- package/dist/drizzle.adapter.d.ts +0 -51
- package/dist/drizzle.adapter.d.ts.map +0 -1
- package/dist/index.d.ts +0 -6
- package/dist/index.d.ts.map +0 -1
- package/dist/index.js +0 -168
- package/dist/query-adapter.d.ts +0 -241
- package/dist/query-adapter.d.ts.map +0 -1
- package/dist/types.d.ts +0 -42
- package/dist/types.d.ts.map +0 -1
package/dist/index.d.mts
ADDED
|
@@ -0,0 +1,340 @@
|
|
|
1
|
+
|
|
2
|
+
import { AdapterContext, AppAdapter, MaybePromise, ParsedQuery, QueryBuilderAdapter } from "@forinda/kickjs";
|
|
3
|
+
|
|
4
|
+
//#region src/types.d.ts
|
|
5
|
+
/** DI token for resolving the Drizzle database instance from the container */
|
|
6
|
+
declare const DRIZZLE_DB: unique symbol;
|
|
7
|
+
interface DrizzleAdapterOptions<TDb = unknown> {
|
|
8
|
+
/**
|
|
9
|
+
* Drizzle database instance — the return value of `drizzle()`.
|
|
10
|
+
* Preserves the full type so services can inject it type-safely.
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```ts
|
|
14
|
+
* import { drizzle } from 'drizzle-orm/better-sqlite3'
|
|
15
|
+
* import * as schema from './schema'
|
|
16
|
+
*
|
|
17
|
+
* const db = drizzle({ client: sqlite, schema })
|
|
18
|
+
* // db is BetterSQLite3Database<typeof schema>
|
|
19
|
+
*
|
|
20
|
+
* new DrizzleAdapter({ db })
|
|
21
|
+
* // TDb is inferred as BetterSQLite3Database<typeof schema>
|
|
22
|
+
* ```
|
|
23
|
+
*/
|
|
24
|
+
db: TDb;
|
|
25
|
+
/** Enable query logging (default: false) */
|
|
26
|
+
logging?: boolean;
|
|
27
|
+
/**
|
|
28
|
+
* Optional shutdown function to close the underlying connection pool.
|
|
29
|
+
* Drizzle doesn't expose a universal disconnect — this lets you pass your
|
|
30
|
+
* driver's cleanup (e.g., `pool.end()` for postgres, `client.close()` for libsql).
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* ```ts
|
|
34
|
+
* const pool = new Pool({ connectionString: '...' })
|
|
35
|
+
* const db = drizzle(pool)
|
|
36
|
+
*
|
|
37
|
+
* new DrizzleAdapter({
|
|
38
|
+
* db,
|
|
39
|
+
* onShutdown: () => pool.end(),
|
|
40
|
+
* })
|
|
41
|
+
* ```
|
|
42
|
+
*/
|
|
43
|
+
onShutdown?: () => MaybePromise<any>;
|
|
44
|
+
}
|
|
45
|
+
//#endregion
|
|
46
|
+
//#region src/drizzle.adapter.d.ts
|
|
47
|
+
/**
|
|
48
|
+
* Drizzle ORM adapter — registers a Drizzle database instance in the DI
|
|
49
|
+
* container and manages its lifecycle.
|
|
50
|
+
*
|
|
51
|
+
* Works with any Drizzle driver: `drizzle-orm/postgres-js`, `drizzle-orm/node-postgres`,
|
|
52
|
+
* `drizzle-orm/mysql2`, `drizzle-orm/better-sqlite3`, `drizzle-orm/libsql`, etc.
|
|
53
|
+
*
|
|
54
|
+
* The adapter is generic — the db type is inferred from what you pass in,
|
|
55
|
+
* so services can inject the fully-typed database instance.
|
|
56
|
+
*
|
|
57
|
+
* @example
|
|
58
|
+
* ```ts
|
|
59
|
+
* import { drizzle } from 'drizzle-orm/better-sqlite3'
|
|
60
|
+
* import * as schema from './schema'
|
|
61
|
+
* import { DrizzleAdapter } from '@forinda/kickjs-drizzle'
|
|
62
|
+
*
|
|
63
|
+
* const db = drizzle({ client: sqlite, schema })
|
|
64
|
+
*
|
|
65
|
+
* bootstrap({
|
|
66
|
+
* modules,
|
|
67
|
+
* adapters: [
|
|
68
|
+
* new DrizzleAdapter({ db, onShutdown: () => sqlite.close() }),
|
|
69
|
+
* ],
|
|
70
|
+
* })
|
|
71
|
+
* ```
|
|
72
|
+
*
|
|
73
|
+
* Inject the typed db instance in services:
|
|
74
|
+
* ```ts
|
|
75
|
+
* import type { BetterSQLite3Database } from 'drizzle-orm/better-sqlite3'
|
|
76
|
+
* import * as schema from './schema'
|
|
77
|
+
*
|
|
78
|
+
* @Service()
|
|
79
|
+
* class UserService {
|
|
80
|
+
* constructor(@Inject(DRIZZLE_DB) private db: BetterSQLite3Database<typeof schema>) {}
|
|
81
|
+
* }
|
|
82
|
+
* ```
|
|
83
|
+
*/
|
|
84
|
+
declare class DrizzleAdapter<TDb = unknown> implements AppAdapter {
|
|
85
|
+
private options;
|
|
86
|
+
name: string;
|
|
87
|
+
private db;
|
|
88
|
+
private onShutdown?;
|
|
89
|
+
constructor(options: DrizzleAdapterOptions<TDb>);
|
|
90
|
+
/** Register the Drizzle db instance in the DI container */
|
|
91
|
+
beforeStart({
|
|
92
|
+
container
|
|
93
|
+
}: AdapterContext): void;
|
|
94
|
+
/** Close the underlying connection on shutdown */
|
|
95
|
+
shutdown(): Promise<void>;
|
|
96
|
+
}
|
|
97
|
+
//#endregion
|
|
98
|
+
//#region src/query-adapter.d.ts
|
|
99
|
+
/**
|
|
100
|
+
* Configuration for the Drizzle query builder adapter.
|
|
101
|
+
*
|
|
102
|
+
* Unlike Prisma which uses its own query builder API, Drizzle uses SQL-like
|
|
103
|
+
* operators (`eq`, `gt`, `like`, etc.) from `drizzle-orm`. This adapter
|
|
104
|
+
* produces a config object that can be spread into Drizzle's `select().from().where()`.
|
|
105
|
+
*/
|
|
106
|
+
interface DrizzleQueryConfig {
|
|
107
|
+
/** The Drizzle table schema object (e.g., `users` from your schema) */
|
|
108
|
+
table: Record<string, any>;
|
|
109
|
+
/** Columns to search across when a search string is provided */
|
|
110
|
+
searchColumns?: string[];
|
|
111
|
+
}
|
|
112
|
+
/**
|
|
113
|
+
* Type-safe Drizzle query configuration using Column objects.
|
|
114
|
+
*
|
|
115
|
+
* Use this instead of `DrizzleQueryConfig` for type-safe column references
|
|
116
|
+
* that are validated at compile time. Column objects carry `dataType` metadata
|
|
117
|
+
* enabling automatic type coercion of filter values.
|
|
118
|
+
*
|
|
119
|
+
* @example
|
|
120
|
+
* ```ts
|
|
121
|
+
* import { users } from './schema'
|
|
122
|
+
* import type { DrizzleColumnQueryConfig } from '@forinda/kickjs-drizzle'
|
|
123
|
+
*
|
|
124
|
+
* const config: DrizzleColumnQueryConfig = {
|
|
125
|
+
* columns: {
|
|
126
|
+
* status: users.status,
|
|
127
|
+
* isActive: users.isActive,
|
|
128
|
+
* createdAt: users.createdAt,
|
|
129
|
+
* },
|
|
130
|
+
* sortable: {
|
|
131
|
+
* name: users.name,
|
|
132
|
+
* createdAt: users.createdAt,
|
|
133
|
+
* },
|
|
134
|
+
* searchColumns: [users.firstName, users.lastName, users.email],
|
|
135
|
+
* baseCondition: eq(users.tenantId, tenantId),
|
|
136
|
+
* }
|
|
137
|
+
* ```
|
|
138
|
+
*/
|
|
139
|
+
interface DrizzleColumnQueryConfig {
|
|
140
|
+
/**
|
|
141
|
+
* Map of filterable field names to Drizzle Column objects.
|
|
142
|
+
* Keys are the query parameter names, values are the actual schema columns.
|
|
143
|
+
* The column's `dataType` is used for automatic type coercion.
|
|
144
|
+
*/
|
|
145
|
+
columns: Record<string, any>;
|
|
146
|
+
/**
|
|
147
|
+
* Map of sortable field names to Drizzle Column objects.
|
|
148
|
+
* If not provided, falls back to `columns` for sort lookups.
|
|
149
|
+
*/
|
|
150
|
+
sortable?: Record<string, any>;
|
|
151
|
+
/**
|
|
152
|
+
* Column objects to search across when a search string is provided.
|
|
153
|
+
* Each entry should be a Drizzle Column (not a string).
|
|
154
|
+
*/
|
|
155
|
+
searchColumns?: any[];
|
|
156
|
+
/**
|
|
157
|
+
* A pre-built SQL condition that is always prepended to the WHERE clause.
|
|
158
|
+
* Use for scoping queries by tenant, workspace, or other invariants.
|
|
159
|
+
*
|
|
160
|
+
* @example
|
|
161
|
+
* ```ts
|
|
162
|
+
* baseCondition: and(eq(tasks.tenantId, tid), eq(tasks.workspaceId, wid))
|
|
163
|
+
* ```
|
|
164
|
+
*/
|
|
165
|
+
baseCondition?: any;
|
|
166
|
+
}
|
|
167
|
+
/**
|
|
168
|
+
* Configuration type for defining query param schemas with Drizzle Column objects.
|
|
169
|
+
*
|
|
170
|
+
* Used in constants files to define which columns are filterable, sortable, and searchable.
|
|
171
|
+
* This type is consumed by both `DrizzleQueryAdapter.buildFromColumns()` and `@ApiQueryParams()`.
|
|
172
|
+
*
|
|
173
|
+
* @example
|
|
174
|
+
* ```ts
|
|
175
|
+
* import type { DrizzleQueryParamsConfig } from '@forinda/kickjs-drizzle'
|
|
176
|
+
* import { tasks } from '@/db/schema'
|
|
177
|
+
*
|
|
178
|
+
* export const TASK_QUERY_CONFIG: DrizzleQueryParamsConfig = {
|
|
179
|
+
* columns: {
|
|
180
|
+
* status: tasks.status,
|
|
181
|
+
* priority: tasks.priority,
|
|
182
|
+
* },
|
|
183
|
+
* sortable: {
|
|
184
|
+
* title: tasks.title,
|
|
185
|
+
* createdAt: tasks.createdAt,
|
|
186
|
+
* },
|
|
187
|
+
* searchColumns: [tasks.title, tasks.key],
|
|
188
|
+
* }
|
|
189
|
+
* ```
|
|
190
|
+
*/
|
|
191
|
+
interface DrizzleQueryParamsConfig {
|
|
192
|
+
/** Filterable columns: keys are query param names, values are Drizzle Column objects */
|
|
193
|
+
columns: Record<string, any>;
|
|
194
|
+
/** Sortable columns: keys are query param names, values are Drizzle Column objects */
|
|
195
|
+
sortable?: Record<string, any>;
|
|
196
|
+
/** Columns for text search */
|
|
197
|
+
searchColumns?: any[];
|
|
198
|
+
/** Optional base condition for scoping (tenant, workspace, etc.) */
|
|
199
|
+
baseCondition?: any;
|
|
200
|
+
}
|
|
201
|
+
/**
|
|
202
|
+
* Convert a DrizzleQueryParamsConfig into a string-based QueryFieldConfig.
|
|
203
|
+
* Useful for passing to `@ApiQueryParams()` or other APIs that expect string arrays.
|
|
204
|
+
*
|
|
205
|
+
* @example
|
|
206
|
+
* ```ts
|
|
207
|
+
* import { toQueryFieldConfig } from '@forinda/kickjs-drizzle'
|
|
208
|
+
*
|
|
209
|
+
* const fieldConfig = toQueryFieldConfig(TASK_QUERY_CONFIG)
|
|
210
|
+
* // → { filterable: ['status', 'priority'], sortable: ['title', 'createdAt'], searchable: [] }
|
|
211
|
+
* ```
|
|
212
|
+
*/
|
|
213
|
+
declare function toQueryFieldConfig(config: DrizzleQueryParamsConfig): {
|
|
214
|
+
filterable: string[];
|
|
215
|
+
sortable: string[];
|
|
216
|
+
searchable: string[];
|
|
217
|
+
};
|
|
218
|
+
/**
|
|
219
|
+
* Result shape compatible with Drizzle's query builder.
|
|
220
|
+
* Use with `db.select().from(table).where(result.where).orderBy(...result.orderBy).limit(result.limit).offset(result.offset)`
|
|
221
|
+
*/
|
|
222
|
+
interface DrizzleQueryResult {
|
|
223
|
+
/** SQL condition — pass to `.where()` */
|
|
224
|
+
where?: any;
|
|
225
|
+
/** Array of order expressions — spread into `.orderBy()` */
|
|
226
|
+
orderBy: any[];
|
|
227
|
+
/** Row limit — pass to `.limit()` */
|
|
228
|
+
limit: number;
|
|
229
|
+
/** Row offset — pass to `.offset()` */
|
|
230
|
+
offset: number;
|
|
231
|
+
}
|
|
232
|
+
/**
|
|
233
|
+
* Drizzle operator functions required by the query adapter.
|
|
234
|
+
* Pass these from your `drizzle-orm` import to avoid version coupling.
|
|
235
|
+
*
|
|
236
|
+
* @example
|
|
237
|
+
* ```ts
|
|
238
|
+
* import { eq, ne, gt, gte, lt, lte, ilike, inArray, between, and, or, asc, desc } from 'drizzle-orm'
|
|
239
|
+
*
|
|
240
|
+
* const adapter = new DrizzleQueryAdapter({
|
|
241
|
+
* eq, ne, gt, gte, lt, lte, ilike, inArray, between, and, or, asc, desc,
|
|
242
|
+
* })
|
|
243
|
+
* ```
|
|
244
|
+
*/
|
|
245
|
+
interface DrizzleOps {
|
|
246
|
+
eq: (column: any, value: any) => any;
|
|
247
|
+
ne: (column: any, value: any) => any;
|
|
248
|
+
gt: (column: any, value: any) => any;
|
|
249
|
+
gte: (column: any, value: any) => any;
|
|
250
|
+
lt: (column: any, value: any) => any;
|
|
251
|
+
lte: (column: any, value: any) => any;
|
|
252
|
+
ilike: (column: any, value: string) => any;
|
|
253
|
+
inArray: (column: any, values: any[]) => any;
|
|
254
|
+
between?: (column: any, min: any, max: any) => any;
|
|
255
|
+
and: (...conditions: any[]) => any;
|
|
256
|
+
or: (...conditions: any[]) => any;
|
|
257
|
+
asc: (column: any) => any;
|
|
258
|
+
desc: (column: any) => any;
|
|
259
|
+
}
|
|
260
|
+
/**
|
|
261
|
+
* Translates a ParsedQuery into Drizzle-compatible query parts.
|
|
262
|
+
*
|
|
263
|
+
* Supports two modes:
|
|
264
|
+
* 1. **String-based** (legacy): `build(parsed, { table, searchColumns })` — looks up columns by string name
|
|
265
|
+
* 2. **Column-based** (recommended): `buildFromColumns(parsed, config)` — uses actual Column objects for type safety
|
|
266
|
+
*
|
|
267
|
+
* @example
|
|
268
|
+
* ```ts
|
|
269
|
+
* // String-based (legacy)
|
|
270
|
+
* const query = adapter.build(parsed, { table: users, searchColumns: ['name', 'email'] })
|
|
271
|
+
*
|
|
272
|
+
* // Column-based (recommended)
|
|
273
|
+
* const query = adapter.buildFromColumns(parsed, {
|
|
274
|
+
* columns: { status: users.status, isActive: users.isActive },
|
|
275
|
+
* searchColumns: [users.name, users.email],
|
|
276
|
+
* baseCondition: eq(users.tenantId, tid),
|
|
277
|
+
* })
|
|
278
|
+
*
|
|
279
|
+
* const results = await db
|
|
280
|
+
* .select().from(users)
|
|
281
|
+
* .where(query.where)
|
|
282
|
+
* .orderBy(...query.orderBy)
|
|
283
|
+
* .limit(query.limit)
|
|
284
|
+
* .offset(query.offset)
|
|
285
|
+
* ```
|
|
286
|
+
*/
|
|
287
|
+
declare class DrizzleQueryAdapter implements QueryBuilderAdapter<DrizzleQueryResult, DrizzleQueryConfig> {
|
|
288
|
+
private ops;
|
|
289
|
+
readonly name = "DrizzleQueryAdapter";
|
|
290
|
+
constructor(ops: DrizzleOps);
|
|
291
|
+
/**
|
|
292
|
+
* Build query from string-based config (legacy API).
|
|
293
|
+
* Prefer `buildFromColumns()` for type safety.
|
|
294
|
+
*/
|
|
295
|
+
build(parsed: ParsedQuery, config?: DrizzleQueryConfig): DrizzleQueryResult;
|
|
296
|
+
/**
|
|
297
|
+
* Build query using Column objects for type-safe filtering, sorting, and search.
|
|
298
|
+
*
|
|
299
|
+
* Features over `build()`:
|
|
300
|
+
* - Column references validated at compile time
|
|
301
|
+
* - Automatic type coercion based on `column.dataType` (boolean, number, date)
|
|
302
|
+
* - `baseCondition` support for tenant/workspace scoping
|
|
303
|
+
* - Native `between` operator support
|
|
304
|
+
* - Separate `sortable` map so filterable and sortable columns can differ
|
|
305
|
+
*
|
|
306
|
+
* @example
|
|
307
|
+
* ```ts
|
|
308
|
+
* const query = adapter.buildFromColumns(parsed, {
|
|
309
|
+
* columns: { status: tasks.status, priority: tasks.priority },
|
|
310
|
+
* sortable: { title: tasks.title, createdAt: tasks.createdAt },
|
|
311
|
+
* searchColumns: [tasks.title, tasks.key],
|
|
312
|
+
* baseCondition: eq(tasks.workspaceId, wid),
|
|
313
|
+
* })
|
|
314
|
+
* ```
|
|
315
|
+
*/
|
|
316
|
+
buildFromColumns(parsed: ParsedQuery, config: DrizzleColumnQueryConfig): DrizzleQueryResult;
|
|
317
|
+
/** Map a single FilterItem to a Drizzle condition using string-based table lookup */
|
|
318
|
+
private buildFilter;
|
|
319
|
+
/**
|
|
320
|
+
* Map a FilterItem to a Drizzle condition using a Column object.
|
|
321
|
+
* Coerces values based on `column.dataType` for type-safe filtering.
|
|
322
|
+
*/
|
|
323
|
+
private buildColumnFilter;
|
|
324
|
+
/** Build Drizzle orderBy from SortItem[] */
|
|
325
|
+
private buildSort;
|
|
326
|
+
/** Attempt to coerce a string value to a number or boolean if appropriate */
|
|
327
|
+
private coerce;
|
|
328
|
+
/**
|
|
329
|
+
* Coerce a string value based on the column's dataType.
|
|
330
|
+
*
|
|
331
|
+
* - `'boolean'` → `true`/`false`
|
|
332
|
+
* - `'number'` / `'bigint'` → `Number(value)`
|
|
333
|
+
* - `'date'` → `new Date(value)` (ISO 8601 strings)
|
|
334
|
+
* - Everything else → original string
|
|
335
|
+
*/
|
|
336
|
+
private coerceByDataType;
|
|
337
|
+
}
|
|
338
|
+
//#endregion
|
|
339
|
+
export { DRIZZLE_DB, DrizzleAdapter, type DrizzleAdapterOptions, type DrizzleColumnQueryConfig, type DrizzleOps, DrizzleQueryAdapter, type DrizzleQueryConfig, type DrizzleQueryParamsConfig, type DrizzleQueryResult, toQueryFieldConfig };
|
|
340
|
+
//# sourceMappingURL=index.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.mts","names":[],"sources":["../src/types.ts","../src/drizzle.adapter.ts","../src/query-adapter.ts"],"mappings":";;;;;cAGa,UAAA;AAAA,UAEI,qBAAA;EAF4B;;;;AAE7C;;;;;;;;;;;;EAiBE,EAAA,EAAI,GAAA;;EAGJ,OAAA;ECiBW;;;;;;;;;;;;;;;;EDCX,UAAA,SAAmB,YAAA;AAAA;;;;AAxCrB;;;;;AAEA;;;;;;;;;;;;;;;ACqCA;;;;;;;;;;;;;;;;cAAa,cAAA,2BAAyC,UAAA;EAAA,QAKhC,OAAA;EAJpB,IAAA;EAAA,QACQ,EAAA;EAAA,QACA,UAAA;cAEY,OAAA,EAAS,qBAAA,CAAsB,GAAA;EAMrC;EAAd,WAAA,CAAA;IAAc;EAAA,GAAa,cAAA;EAAA;EAWrB,QAAA,CAAA,GAAY,OAAA;AAAA;;;;;AD7DpB;;;;;UEMiB,kBAAA;EFJqB;EEMpC,KAAA,EAAO,MAAA;EFgCwB;EE9B/B,aAAA;AAAA;;;;;;;;;;AD6BF;;;;;;;;;;;;;;;;;;UCCiB,wBAAA;EDIoC;;;;;ECEnD,OAAA,EAAS,MAAA;EDeH;;;;ECTN,QAAA,GAAW,MAAA;;;AA9Cb;;EAoDE,aAAA;EAlDa;;;;;;AAgCf;;;EA6BE,aAAA;AAAA;;;;;;;;AA2BF;;;;;;;;;;;;AAuBA;;;;;UAvBiB,wBAAA;EAwBf;EAtBA,OAAA,EAAS,MAAA;EAwBT;EAtBA,QAAA,GAAW,MAAA;EAsBD;EApBV,aAAA;EAmCiC;EAjCjC,aAAA;AAAA;;;;;;;AAyDF;;;;;;iBA1CgB,kBAAA,CAAmB,MAAA,EAAQ,wBAAA;EACzC,UAAA;EACA,QAAA;EACA,UAAA;AAAA;;;;;UAee,kBAAA;EA6Bf;EA3BA,KAAA;EA2BkB;EAzBlB,OAAA;EA0BM;EAxBN,KAAA;EAyBA;EAvBA,MAAA;AAAA;;;;;;;;;;;;;;UAgBe,UAAA;EACf,EAAA,GAAK,MAAA,OAAa,KAAA;EAClB,EAAA,GAAK,MAAA,OAAa,KAAA;EAClB,EAAA,GAAK,MAAA,OAAa,KAAA;EAClB,GAAA,GAAM,MAAA,OAAa,KAAA;EACnB,EAAA,GAAK,MAAA,OAAa,KAAA;EAClB,GAAA,GAAM,MAAA,OAAa,KAAA;EACnB,KAAA,GAAQ,MAAA,OAAa,KAAA;EACrB,OAAA,GAAU,MAAA,OAAa,MAAA;EACvB,OAAA,IAAW,MAAA,OAAa,GAAA,OAAU,GAAA;EAClC,GAAA,MAAS,UAAA;EACT,EAAA,MAAQ,UAAA;EACR,GAAA,GAAM,MAAA;EACN,IAAA,GAAO,MAAA;AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;cA8BI,mBAAA,YAA+B,mBAAA,CAC1C,kBAAA,EACA,kBAAA;EAAA,QAIoB,GAAA;EAAA,SAFX,IAAA;cAEW,GAAA,EAAK,UAAA;;;;;EAMzB,KAAA,CACE,MAAA,EAAQ,WAAA,EACR,MAAA,GAAQ,kBAAA,GACP,kBAAA;;;;;;;;;;;;;;;;;;;;;EA4DH,gBAAA,CAAiB,MAAA,EAAQ,WAAA,EAAa,MAAA,EAAQ,wBAAA,GAA2B,kBAAA;;UAqDjE,WAAA;;;;;UA0CA,iBAAA;;UA2CA,SAAA;;UAWA,MAAA;;;;;;;;;UAgBA,gBAAA;AAAA"}
|
package/dist/index.mjs
ADDED
|
@@ -0,0 +1,297 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @forinda/kickjs-drizzle v2.1.0
|
|
3
|
+
*
|
|
4
|
+
* Copyright (c) Felix Orinda
|
|
5
|
+
*
|
|
6
|
+
* This source code is licensed under the MIT license found in the
|
|
7
|
+
* LICENSE file in the root directory of this source tree.
|
|
8
|
+
*
|
|
9
|
+
* @license MIT
|
|
10
|
+
*/
|
|
11
|
+
import { Logger, Scope } from "@forinda/kickjs";
|
|
12
|
+
//#region src/types.ts
|
|
13
|
+
/** DI token for resolving the Drizzle database instance from the container */
|
|
14
|
+
const DRIZZLE_DB = Symbol("DrizzleDB");
|
|
15
|
+
//#endregion
|
|
16
|
+
//#region src/drizzle.adapter.ts
|
|
17
|
+
const log = Logger.for("DrizzleAdapter");
|
|
18
|
+
/**
|
|
19
|
+
* Drizzle ORM adapter — registers a Drizzle database instance in the DI
|
|
20
|
+
* container and manages its lifecycle.
|
|
21
|
+
*
|
|
22
|
+
* Works with any Drizzle driver: `drizzle-orm/postgres-js`, `drizzle-orm/node-postgres`,
|
|
23
|
+
* `drizzle-orm/mysql2`, `drizzle-orm/better-sqlite3`, `drizzle-orm/libsql`, etc.
|
|
24
|
+
*
|
|
25
|
+
* The adapter is generic — the db type is inferred from what you pass in,
|
|
26
|
+
* so services can inject the fully-typed database instance.
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
* ```ts
|
|
30
|
+
* import { drizzle } from 'drizzle-orm/better-sqlite3'
|
|
31
|
+
* import * as schema from './schema'
|
|
32
|
+
* import { DrizzleAdapter } from '@forinda/kickjs-drizzle'
|
|
33
|
+
*
|
|
34
|
+
* const db = drizzle({ client: sqlite, schema })
|
|
35
|
+
*
|
|
36
|
+
* bootstrap({
|
|
37
|
+
* modules,
|
|
38
|
+
* adapters: [
|
|
39
|
+
* new DrizzleAdapter({ db, onShutdown: () => sqlite.close() }),
|
|
40
|
+
* ],
|
|
41
|
+
* })
|
|
42
|
+
* ```
|
|
43
|
+
*
|
|
44
|
+
* Inject the typed db instance in services:
|
|
45
|
+
* ```ts
|
|
46
|
+
* import type { BetterSQLite3Database } from 'drizzle-orm/better-sqlite3'
|
|
47
|
+
* import * as schema from './schema'
|
|
48
|
+
*
|
|
49
|
+
* @Service()
|
|
50
|
+
* class UserService {
|
|
51
|
+
* constructor(@Inject(DRIZZLE_DB) private db: BetterSQLite3Database<typeof schema>) {}
|
|
52
|
+
* }
|
|
53
|
+
* ```
|
|
54
|
+
*/
|
|
55
|
+
var DrizzleAdapter = class {
|
|
56
|
+
name = "DrizzleAdapter";
|
|
57
|
+
db;
|
|
58
|
+
onShutdown;
|
|
59
|
+
constructor(options) {
|
|
60
|
+
this.options = options;
|
|
61
|
+
this.db = options.db;
|
|
62
|
+
this.onShutdown = options.onShutdown;
|
|
63
|
+
}
|
|
64
|
+
/** Register the Drizzle db instance in the DI container */
|
|
65
|
+
beforeStart({ container }) {
|
|
66
|
+
if (this.options.logging) log.info("Query logging enabled");
|
|
67
|
+
container.registerFactory(DRIZZLE_DB, () => this.db, Scope.SINGLETON);
|
|
68
|
+
log.info("Drizzle database registered in DI container");
|
|
69
|
+
}
|
|
70
|
+
/** Close the underlying connection on shutdown */
|
|
71
|
+
async shutdown() {
|
|
72
|
+
if (this.onShutdown) {
|
|
73
|
+
await this.onShutdown();
|
|
74
|
+
log.info("Drizzle connection closed");
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
};
|
|
78
|
+
//#endregion
|
|
79
|
+
//#region src/query-adapter.ts
|
|
80
|
+
/**
|
|
81
|
+
* Convert a DrizzleQueryParamsConfig into a string-based QueryFieldConfig.
|
|
82
|
+
* Useful for passing to `@ApiQueryParams()` or other APIs that expect string arrays.
|
|
83
|
+
*
|
|
84
|
+
* @example
|
|
85
|
+
* ```ts
|
|
86
|
+
* import { toQueryFieldConfig } from '@forinda/kickjs-drizzle'
|
|
87
|
+
*
|
|
88
|
+
* const fieldConfig = toQueryFieldConfig(TASK_QUERY_CONFIG)
|
|
89
|
+
* // → { filterable: ['status', 'priority'], sortable: ['title', 'createdAt'], searchable: [] }
|
|
90
|
+
* ```
|
|
91
|
+
*/
|
|
92
|
+
function toQueryFieldConfig(config) {
|
|
93
|
+
return {
|
|
94
|
+
filterable: Object.keys(config.columns),
|
|
95
|
+
sortable: config.sortable ? Object.keys(config.sortable) : [],
|
|
96
|
+
searchable: config.searchColumns ? config.searchColumns.map((col) => col.name ?? "").filter(Boolean) : []
|
|
97
|
+
};
|
|
98
|
+
}
|
|
99
|
+
/**
|
|
100
|
+
* Translates a ParsedQuery into Drizzle-compatible query parts.
|
|
101
|
+
*
|
|
102
|
+
* Supports two modes:
|
|
103
|
+
* 1. **String-based** (legacy): `build(parsed, { table, searchColumns })` — looks up columns by string name
|
|
104
|
+
* 2. **Column-based** (recommended): `buildFromColumns(parsed, config)` — uses actual Column objects for type safety
|
|
105
|
+
*
|
|
106
|
+
* @example
|
|
107
|
+
* ```ts
|
|
108
|
+
* // String-based (legacy)
|
|
109
|
+
* const query = adapter.build(parsed, { table: users, searchColumns: ['name', 'email'] })
|
|
110
|
+
*
|
|
111
|
+
* // Column-based (recommended)
|
|
112
|
+
* const query = adapter.buildFromColumns(parsed, {
|
|
113
|
+
* columns: { status: users.status, isActive: users.isActive },
|
|
114
|
+
* searchColumns: [users.name, users.email],
|
|
115
|
+
* baseCondition: eq(users.tenantId, tid),
|
|
116
|
+
* })
|
|
117
|
+
*
|
|
118
|
+
* const results = await db
|
|
119
|
+
* .select().from(users)
|
|
120
|
+
* .where(query.where)
|
|
121
|
+
* .orderBy(...query.orderBy)
|
|
122
|
+
* .limit(query.limit)
|
|
123
|
+
* .offset(query.offset)
|
|
124
|
+
* ```
|
|
125
|
+
*/
|
|
126
|
+
var DrizzleQueryAdapter = class {
|
|
127
|
+
name = "DrizzleQueryAdapter";
|
|
128
|
+
constructor(ops) {
|
|
129
|
+
this.ops = ops;
|
|
130
|
+
}
|
|
131
|
+
/**
|
|
132
|
+
* Build query from string-based config (legacy API).
|
|
133
|
+
* Prefer `buildFromColumns()` for type safety.
|
|
134
|
+
*/
|
|
135
|
+
build(parsed, config = {}) {
|
|
136
|
+
const result = {
|
|
137
|
+
orderBy: [],
|
|
138
|
+
limit: parsed.pagination.limit,
|
|
139
|
+
offset: parsed.pagination.offset
|
|
140
|
+
};
|
|
141
|
+
const conditions = [];
|
|
142
|
+
for (const filter of parsed.filters) {
|
|
143
|
+
const condition = this.buildFilter(config.table, filter);
|
|
144
|
+
if (condition) conditions.push(condition);
|
|
145
|
+
}
|
|
146
|
+
if (parsed.search && config.searchColumns && config.searchColumns.length > 0) {
|
|
147
|
+
const searchConditions = config.searchColumns.filter((col) => config.table[col]).map((col) => this.ops.ilike(config.table[col], `%${parsed.search}%`));
|
|
148
|
+
if (searchConditions.length > 0) conditions.push(this.ops.or(...searchConditions));
|
|
149
|
+
}
|
|
150
|
+
if (conditions.length === 1) result.where = conditions[0];
|
|
151
|
+
else if (conditions.length > 1) result.where = this.ops.and(...conditions);
|
|
152
|
+
result.orderBy = this.buildSort(config.table, parsed.sort);
|
|
153
|
+
return result;
|
|
154
|
+
}
|
|
155
|
+
/**
|
|
156
|
+
* Build query using Column objects for type-safe filtering, sorting, and search.
|
|
157
|
+
*
|
|
158
|
+
* Features over `build()`:
|
|
159
|
+
* - Column references validated at compile time
|
|
160
|
+
* - Automatic type coercion based on `column.dataType` (boolean, number, date)
|
|
161
|
+
* - `baseCondition` support for tenant/workspace scoping
|
|
162
|
+
* - Native `between` operator support
|
|
163
|
+
* - Separate `sortable` map so filterable and sortable columns can differ
|
|
164
|
+
*
|
|
165
|
+
* @example
|
|
166
|
+
* ```ts
|
|
167
|
+
* const query = adapter.buildFromColumns(parsed, {
|
|
168
|
+
* columns: { status: tasks.status, priority: tasks.priority },
|
|
169
|
+
* sortable: { title: tasks.title, createdAt: tasks.createdAt },
|
|
170
|
+
* searchColumns: [tasks.title, tasks.key],
|
|
171
|
+
* baseCondition: eq(tasks.workspaceId, wid),
|
|
172
|
+
* })
|
|
173
|
+
* ```
|
|
174
|
+
*/
|
|
175
|
+
buildFromColumns(parsed, config) {
|
|
176
|
+
const result = {
|
|
177
|
+
orderBy: [],
|
|
178
|
+
limit: parsed.pagination.limit,
|
|
179
|
+
offset: parsed.pagination.offset
|
|
180
|
+
};
|
|
181
|
+
const conditions = [];
|
|
182
|
+
if (config.baseCondition) conditions.push(config.baseCondition);
|
|
183
|
+
for (const filter of parsed.filters) {
|
|
184
|
+
const column = config.columns[filter.field];
|
|
185
|
+
if (!column) continue;
|
|
186
|
+
const condition = this.buildColumnFilter(column, filter);
|
|
187
|
+
if (condition) conditions.push(condition);
|
|
188
|
+
}
|
|
189
|
+
if (parsed.search && config.searchColumns && config.searchColumns.length > 0) {
|
|
190
|
+
const searchConditions = config.searchColumns.map((col) => this.ops.ilike(col, `%${parsed.search}%`));
|
|
191
|
+
if (searchConditions.length > 0) conditions.push(this.ops.or(...searchConditions));
|
|
192
|
+
}
|
|
193
|
+
if (conditions.length === 1) result.where = conditions[0];
|
|
194
|
+
else if (conditions.length > 1) result.where = this.ops.and(...conditions);
|
|
195
|
+
const sortMap = config.sortable ?? config.columns;
|
|
196
|
+
result.orderBy = parsed.sort.filter((item) => sortMap[item.field]).map((item) => item.direction === "desc" ? this.ops.desc(sortMap[item.field]) : this.ops.asc(sortMap[item.field]));
|
|
197
|
+
return result;
|
|
198
|
+
}
|
|
199
|
+
/** Map a single FilterItem to a Drizzle condition using string-based table lookup */
|
|
200
|
+
buildFilter(table, filter) {
|
|
201
|
+
const column = table[filter.field];
|
|
202
|
+
if (!column) return null;
|
|
203
|
+
const value = this.coerce(filter.value);
|
|
204
|
+
switch (filter.operator) {
|
|
205
|
+
case "eq": return this.ops.eq(column, value);
|
|
206
|
+
case "neq": return this.ops.ne(column, value);
|
|
207
|
+
case "gt": return this.ops.gt(column, value);
|
|
208
|
+
case "gte": return this.ops.gte(column, value);
|
|
209
|
+
case "lt": return this.ops.lt(column, value);
|
|
210
|
+
case "lte": return this.ops.lte(column, value);
|
|
211
|
+
case "contains": return this.ops.ilike(column, `%${filter.value}%`);
|
|
212
|
+
case "starts": return this.ops.ilike(column, `${filter.value}%`);
|
|
213
|
+
case "ends": return this.ops.ilike(column, `%${filter.value}`);
|
|
214
|
+
case "in": {
|
|
215
|
+
const values = filter.value.split(",").map((v) => this.coerce(v.trim()));
|
|
216
|
+
return this.ops.inArray(column, values);
|
|
217
|
+
}
|
|
218
|
+
case "between": {
|
|
219
|
+
const [min, max] = filter.value.split(",").map((v) => this.coerce(v.trim()));
|
|
220
|
+
return this.ops.and(this.ops.gte(column, min), this.ops.lte(column, max));
|
|
221
|
+
}
|
|
222
|
+
default: return this.ops.eq(column, value);
|
|
223
|
+
}
|
|
224
|
+
}
|
|
225
|
+
/**
|
|
226
|
+
* Map a FilterItem to a Drizzle condition using a Column object.
|
|
227
|
+
* Coerces values based on `column.dataType` for type-safe filtering.
|
|
228
|
+
*/
|
|
229
|
+
buildColumnFilter(column, filter) {
|
|
230
|
+
const value = this.coerceByDataType(filter.value, column.dataType);
|
|
231
|
+
switch (filter.operator) {
|
|
232
|
+
case "eq": return this.ops.eq(column, value);
|
|
233
|
+
case "neq": return this.ops.ne(column, value);
|
|
234
|
+
case "gt": return this.ops.gt(column, value);
|
|
235
|
+
case "gte": return this.ops.gte(column, value);
|
|
236
|
+
case "lt": return this.ops.lt(column, value);
|
|
237
|
+
case "lte": return this.ops.lte(column, value);
|
|
238
|
+
case "contains": return this.ops.ilike(column, `%${filter.value}%`);
|
|
239
|
+
case "starts": return this.ops.ilike(column, `${filter.value}%`);
|
|
240
|
+
case "ends": return this.ops.ilike(column, `%${filter.value}`);
|
|
241
|
+
case "in": {
|
|
242
|
+
const values = filter.value.split(",").map((v) => this.coerceByDataType(v.trim(), column.dataType));
|
|
243
|
+
return this.ops.inArray(column, values);
|
|
244
|
+
}
|
|
245
|
+
case "between": {
|
|
246
|
+
const [minStr, maxStr] = filter.value.split(",").map((v) => v.trim());
|
|
247
|
+
const min = this.coerceByDataType(minStr, column.dataType);
|
|
248
|
+
const max = this.coerceByDataType(maxStr, column.dataType);
|
|
249
|
+
if (this.ops.between) return this.ops.between(column, min, max);
|
|
250
|
+
return this.ops.and(this.ops.gte(column, min), this.ops.lte(column, max));
|
|
251
|
+
}
|
|
252
|
+
default: return this.ops.eq(column, value);
|
|
253
|
+
}
|
|
254
|
+
}
|
|
255
|
+
/** Build Drizzle orderBy from SortItem[] */
|
|
256
|
+
buildSort(table, sort) {
|
|
257
|
+
return sort.filter((item) => table[item.field]).map((item) => item.direction === "desc" ? this.ops.desc(table[item.field]) : this.ops.asc(table[item.field]));
|
|
258
|
+
}
|
|
259
|
+
/** Attempt to coerce a string value to a number or boolean if appropriate */
|
|
260
|
+
coerce(value) {
|
|
261
|
+
if (value === "true") return true;
|
|
262
|
+
if (value === "false") return false;
|
|
263
|
+
const num = Number(value);
|
|
264
|
+
if (!Number.isNaN(num) && value.trim() !== "") return num;
|
|
265
|
+
return value;
|
|
266
|
+
}
|
|
267
|
+
/**
|
|
268
|
+
* Coerce a string value based on the column's dataType.
|
|
269
|
+
*
|
|
270
|
+
* - `'boolean'` → `true`/`false`
|
|
271
|
+
* - `'number'` / `'bigint'` → `Number(value)`
|
|
272
|
+
* - `'date'` → `new Date(value)` (ISO 8601 strings)
|
|
273
|
+
* - Everything else → original string
|
|
274
|
+
*/
|
|
275
|
+
coerceByDataType(value, dataType) {
|
|
276
|
+
if (!dataType) return this.coerce(value);
|
|
277
|
+
switch (dataType) {
|
|
278
|
+
case "boolean": return value === "true" || value === "1";
|
|
279
|
+
case "number":
|
|
280
|
+
case "bigint": {
|
|
281
|
+
const num = Number(value);
|
|
282
|
+
return Number.isNaN(num) ? value : num;
|
|
283
|
+
}
|
|
284
|
+
case "date":
|
|
285
|
+
case "localDate":
|
|
286
|
+
case "localDateTime": {
|
|
287
|
+
const date = new Date(value);
|
|
288
|
+
return Number.isNaN(date.getTime()) ? value : date;
|
|
289
|
+
}
|
|
290
|
+
default: return value;
|
|
291
|
+
}
|
|
292
|
+
}
|
|
293
|
+
};
|
|
294
|
+
//#endregion
|
|
295
|
+
export { DRIZZLE_DB, DrizzleAdapter, DrizzleQueryAdapter, toQueryFieldConfig };
|
|
296
|
+
|
|
297
|
+
//# sourceMappingURL=index.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.mjs","names":[],"sources":["../src/types.ts","../src/drizzle.adapter.ts","../src/query-adapter.ts"],"sourcesContent":["import type { MaybePromise } from '@forinda/kickjs'\n\n/** DI token for resolving the Drizzle database instance from the container */\nexport const DRIZZLE_DB = Symbol('DrizzleDB')\n\nexport interface DrizzleAdapterOptions<TDb = unknown> {\n /**\n * Drizzle database instance — the return value of `drizzle()`.\n * Preserves the full type so services can inject it type-safely.\n *\n * @example\n * ```ts\n * import { drizzle } from 'drizzle-orm/better-sqlite3'\n * import * as schema from './schema'\n *\n * const db = drizzle({ client: sqlite, schema })\n * // db is BetterSQLite3Database<typeof schema>\n *\n * new DrizzleAdapter({ db })\n * // TDb is inferred as BetterSQLite3Database<typeof schema>\n * ```\n */\n db: TDb\n\n /** Enable query logging (default: false) */\n logging?: boolean\n\n /**\n * Optional shutdown function to close the underlying connection pool.\n * Drizzle doesn't expose a universal disconnect — this lets you pass your\n * driver's cleanup (e.g., `pool.end()` for postgres, `client.close()` for libsql).\n *\n * @example\n * ```ts\n * const pool = new Pool({ connectionString: '...' })\n * const db = drizzle(pool)\n *\n * new DrizzleAdapter({\n * db,\n * onShutdown: () => pool.end(),\n * })\n * ```\n */\n onShutdown?: () => MaybePromise<any>\n}\n","import { Logger, type AppAdapter, type AdapterContext, Scope } from '@forinda/kickjs'\nimport { DRIZZLE_DB, type DrizzleAdapterOptions } from './types'\n\nconst log = Logger.for('DrizzleAdapter')\n\n/**\n * Drizzle ORM adapter — registers a Drizzle database instance in the DI\n * container and manages its lifecycle.\n *\n * Works with any Drizzle driver: `drizzle-orm/postgres-js`, `drizzle-orm/node-postgres`,\n * `drizzle-orm/mysql2`, `drizzle-orm/better-sqlite3`, `drizzle-orm/libsql`, etc.\n *\n * The adapter is generic — the db type is inferred from what you pass in,\n * so services can inject the fully-typed database instance.\n *\n * @example\n * ```ts\n * import { drizzle } from 'drizzle-orm/better-sqlite3'\n * import * as schema from './schema'\n * import { DrizzleAdapter } from '@forinda/kickjs-drizzle'\n *\n * const db = drizzle({ client: sqlite, schema })\n *\n * bootstrap({\n * modules,\n * adapters: [\n * new DrizzleAdapter({ db, onShutdown: () => sqlite.close() }),\n * ],\n * })\n * ```\n *\n * Inject the typed db instance in services:\n * ```ts\n * import type { BetterSQLite3Database } from 'drizzle-orm/better-sqlite3'\n * import * as schema from './schema'\n *\n * @Service()\n * class UserService {\n * constructor(@Inject(DRIZZLE_DB) private db: BetterSQLite3Database<typeof schema>) {}\n * }\n * ```\n */\nexport class DrizzleAdapter<TDb = unknown> implements AppAdapter {\n name = 'DrizzleAdapter'\n private db: TDb\n private onShutdown?: () => void | Promise<void>\n\n constructor(private options: DrizzleAdapterOptions<TDb>) {\n this.db = options.db\n this.onShutdown = options.onShutdown\n }\n\n /** Register the Drizzle db instance in the DI container */\n beforeStart({ container }: AdapterContext): void {\n if (this.options.logging) {\n log.info('Query logging enabled')\n }\n\n container.registerFactory(DRIZZLE_DB, () => this.db, Scope.SINGLETON)\n\n log.info('Drizzle database registered in DI container')\n }\n\n /** Close the underlying connection on shutdown */\n async shutdown(): Promise<void> {\n if (this.onShutdown) {\n await this.onShutdown()\n log.info('Drizzle connection closed')\n }\n }\n}\n","import type { QueryBuilderAdapter, ParsedQuery, FilterItem, SortItem } from '@forinda/kickjs'\n\n/**\n * Configuration for the Drizzle query builder adapter.\n *\n * Unlike Prisma which uses its own query builder API, Drizzle uses SQL-like\n * operators (`eq`, `gt`, `like`, etc.) from `drizzle-orm`. This adapter\n * produces a config object that can be spread into Drizzle's `select().from().where()`.\n */\nexport interface DrizzleQueryConfig {\n /** The Drizzle table schema object (e.g., `users` from your schema) */\n table: Record<string, any>\n /** Columns to search across when a search string is provided */\n searchColumns?: string[]\n}\n\n/**\n * Type-safe Drizzle query configuration using Column objects.\n *\n * Use this instead of `DrizzleQueryConfig` for type-safe column references\n * that are validated at compile time. Column objects carry `dataType` metadata\n * enabling automatic type coercion of filter values.\n *\n * @example\n * ```ts\n * import { users } from './schema'\n * import type { DrizzleColumnQueryConfig } from '@forinda/kickjs-drizzle'\n *\n * const config: DrizzleColumnQueryConfig = {\n * columns: {\n * status: users.status,\n * isActive: users.isActive,\n * createdAt: users.createdAt,\n * },\n * sortable: {\n * name: users.name,\n * createdAt: users.createdAt,\n * },\n * searchColumns: [users.firstName, users.lastName, users.email],\n * baseCondition: eq(users.tenantId, tenantId),\n * }\n * ```\n */\nexport interface DrizzleColumnQueryConfig {\n /**\n * Map of filterable field names to Drizzle Column objects.\n * Keys are the query parameter names, values are the actual schema columns.\n * The column's `dataType` is used for automatic type coercion.\n */\n columns: Record<string, any>\n\n /**\n * Map of sortable field names to Drizzle Column objects.\n * If not provided, falls back to `columns` for sort lookups.\n */\n sortable?: Record<string, any>\n\n /**\n * Column objects to search across when a search string is provided.\n * Each entry should be a Drizzle Column (not a string).\n */\n searchColumns?: any[]\n\n /**\n * A pre-built SQL condition that is always prepended to the WHERE clause.\n * Use for scoping queries by tenant, workspace, or other invariants.\n *\n * @example\n * ```ts\n * baseCondition: and(eq(tasks.tenantId, tid), eq(tasks.workspaceId, wid))\n * ```\n */\n baseCondition?: any\n}\n\n/**\n * Configuration type for defining query param schemas with Drizzle Column objects.\n *\n * Used in constants files to define which columns are filterable, sortable, and searchable.\n * This type is consumed by both `DrizzleQueryAdapter.buildFromColumns()` and `@ApiQueryParams()`.\n *\n * @example\n * ```ts\n * import type { DrizzleQueryParamsConfig } from '@forinda/kickjs-drizzle'\n * import { tasks } from '@/db/schema'\n *\n * export const TASK_QUERY_CONFIG: DrizzleQueryParamsConfig = {\n * columns: {\n * status: tasks.status,\n * priority: tasks.priority,\n * },\n * sortable: {\n * title: tasks.title,\n * createdAt: tasks.createdAt,\n * },\n * searchColumns: [tasks.title, tasks.key],\n * }\n * ```\n */\nexport interface DrizzleQueryParamsConfig {\n /** Filterable columns: keys are query param names, values are Drizzle Column objects */\n columns: Record<string, any>\n /** Sortable columns: keys are query param names, values are Drizzle Column objects */\n sortable?: Record<string, any>\n /** Columns for text search */\n searchColumns?: any[]\n /** Optional base condition for scoping (tenant, workspace, etc.) */\n baseCondition?: any\n}\n\n/**\n * Convert a DrizzleQueryParamsConfig into a string-based QueryFieldConfig.\n * Useful for passing to `@ApiQueryParams()` or other APIs that expect string arrays.\n *\n * @example\n * ```ts\n * import { toQueryFieldConfig } from '@forinda/kickjs-drizzle'\n *\n * const fieldConfig = toQueryFieldConfig(TASK_QUERY_CONFIG)\n * // → { filterable: ['status', 'priority'], sortable: ['title', 'createdAt'], searchable: [] }\n * ```\n */\nexport function toQueryFieldConfig(config: DrizzleQueryParamsConfig): {\n filterable: string[]\n sortable: string[]\n searchable: string[]\n} {\n return {\n filterable: Object.keys(config.columns),\n sortable: config.sortable ? Object.keys(config.sortable) : [],\n searchable: config.searchColumns\n ? config.searchColumns.map((col) => col.name ?? '').filter(Boolean)\n : [],\n }\n}\n\n/**\n * Result shape compatible with Drizzle's query builder.\n * Use with `db.select().from(table).where(result.where).orderBy(...result.orderBy).limit(result.limit).offset(result.offset)`\n */\nexport interface DrizzleQueryResult {\n /** SQL condition — pass to `.where()` */\n where?: any\n /** Array of order expressions — spread into `.orderBy()` */\n orderBy: any[]\n /** Row limit — pass to `.limit()` */\n limit: number\n /** Row offset — pass to `.offset()` */\n offset: number\n}\n\n/**\n * Drizzle operator functions required by the query adapter.\n * Pass these from your `drizzle-orm` import to avoid version coupling.\n *\n * @example\n * ```ts\n * import { eq, ne, gt, gte, lt, lte, ilike, inArray, between, and, or, asc, desc } from 'drizzle-orm'\n *\n * const adapter = new DrizzleQueryAdapter({\n * eq, ne, gt, gte, lt, lte, ilike, inArray, between, and, or, asc, desc,\n * })\n * ```\n */\nexport interface DrizzleOps {\n eq: (column: any, value: any) => any\n ne: (column: any, value: any) => any\n gt: (column: any, value: any) => any\n gte: (column: any, value: any) => any\n lt: (column: any, value: any) => any\n lte: (column: any, value: any) => any\n ilike: (column: any, value: string) => any\n inArray: (column: any, values: any[]) => any\n between?: (column: any, min: any, max: any) => any\n and: (...conditions: any[]) => any\n or: (...conditions: any[]) => any\n asc: (column: any) => any\n desc: (column: any) => any\n}\n\n/**\n * Translates a ParsedQuery into Drizzle-compatible query parts.\n *\n * Supports two modes:\n * 1. **String-based** (legacy): `build(parsed, { table, searchColumns })` — looks up columns by string name\n * 2. **Column-based** (recommended): `buildFromColumns(parsed, config)` — uses actual Column objects for type safety\n *\n * @example\n * ```ts\n * // String-based (legacy)\n * const query = adapter.build(parsed, { table: users, searchColumns: ['name', 'email'] })\n *\n * // Column-based (recommended)\n * const query = adapter.buildFromColumns(parsed, {\n * columns: { status: users.status, isActive: users.isActive },\n * searchColumns: [users.name, users.email],\n * baseCondition: eq(users.tenantId, tid),\n * })\n *\n * const results = await db\n * .select().from(users)\n * .where(query.where)\n * .orderBy(...query.orderBy)\n * .limit(query.limit)\n * .offset(query.offset)\n * ```\n */\nexport class DrizzleQueryAdapter implements QueryBuilderAdapter<\n DrizzleQueryResult,\n DrizzleQueryConfig\n> {\n readonly name = 'DrizzleQueryAdapter'\n\n constructor(private ops: DrizzleOps) {}\n\n /**\n * Build query from string-based config (legacy API).\n * Prefer `buildFromColumns()` for type safety.\n */\n build(\n parsed: ParsedQuery,\n config: DrizzleQueryConfig = {} as DrizzleQueryConfig,\n ): DrizzleQueryResult {\n const result: DrizzleQueryResult = {\n orderBy: [],\n limit: parsed.pagination.limit,\n offset: parsed.pagination.offset,\n }\n\n // Build where conditions\n const conditions: any[] = []\n\n // Filters\n for (const filter of parsed.filters) {\n const condition = this.buildFilter(config.table, filter)\n if (condition) conditions.push(condition)\n }\n\n // Search\n if (parsed.search && config.searchColumns && config.searchColumns.length > 0) {\n const searchConditions = config.searchColumns\n .filter((col) => config.table[col])\n .map((col) => this.ops.ilike(config.table[col], `%${parsed.search}%`))\n\n if (searchConditions.length > 0) {\n conditions.push(this.ops.or(...searchConditions))\n }\n }\n\n // Combine conditions\n if (conditions.length === 1) {\n result.where = conditions[0]\n } else if (conditions.length > 1) {\n result.where = this.ops.and(...conditions)\n }\n\n // Sort\n result.orderBy = this.buildSort(config.table, parsed.sort)\n\n return result\n }\n\n /**\n * Build query using Column objects for type-safe filtering, sorting, and search.\n *\n * Features over `build()`:\n * - Column references validated at compile time\n * - Automatic type coercion based on `column.dataType` (boolean, number, date)\n * - `baseCondition` support for tenant/workspace scoping\n * - Native `between` operator support\n * - Separate `sortable` map so filterable and sortable columns can differ\n *\n * @example\n * ```ts\n * const query = adapter.buildFromColumns(parsed, {\n * columns: { status: tasks.status, priority: tasks.priority },\n * sortable: { title: tasks.title, createdAt: tasks.createdAt },\n * searchColumns: [tasks.title, tasks.key],\n * baseCondition: eq(tasks.workspaceId, wid),\n * })\n * ```\n */\n buildFromColumns(parsed: ParsedQuery, config: DrizzleColumnQueryConfig): DrizzleQueryResult {\n const result: DrizzleQueryResult = {\n orderBy: [],\n limit: parsed.pagination.limit,\n offset: parsed.pagination.offset,\n }\n\n const conditions: any[] = []\n\n // Prepend base condition (tenant/workspace scoping)\n if (config.baseCondition) {\n conditions.push(config.baseCondition)\n }\n\n // Filters — resolve column from the columns map\n for (const filter of parsed.filters) {\n const column = config.columns[filter.field]\n if (!column) continue\n const condition = this.buildColumnFilter(column, filter)\n if (condition) conditions.push(condition)\n }\n\n // Search — use Column objects directly\n if (parsed.search && config.searchColumns && config.searchColumns.length > 0) {\n const searchConditions = config.searchColumns.map((col) =>\n this.ops.ilike(col, `%${parsed.search}%`),\n )\n if (searchConditions.length > 0) {\n conditions.push(this.ops.or(...searchConditions))\n }\n }\n\n // Combine conditions\n if (conditions.length === 1) {\n result.where = conditions[0]\n } else if (conditions.length > 1) {\n result.where = this.ops.and(...conditions)\n }\n\n // Sort — use sortable map, falling back to columns\n const sortMap = config.sortable ?? config.columns\n result.orderBy = parsed.sort\n .filter((item) => sortMap[item.field])\n .map((item) =>\n item.direction === 'desc'\n ? this.ops.desc(sortMap[item.field])\n : this.ops.asc(sortMap[item.field]),\n )\n\n return result\n }\n\n /** Map a single FilterItem to a Drizzle condition using string-based table lookup */\n private buildFilter(table: Record<string, any>, filter: FilterItem): any {\n const column = table[filter.field]\n if (!column) return null\n\n const value = this.coerce(filter.value)\n\n switch (filter.operator) {\n case 'eq':\n return this.ops.eq(column, value)\n case 'neq':\n return this.ops.ne(column, value)\n case 'gt':\n return this.ops.gt(column, value)\n case 'gte':\n return this.ops.gte(column, value)\n case 'lt':\n return this.ops.lt(column, value)\n case 'lte':\n return this.ops.lte(column, value)\n case 'contains':\n return this.ops.ilike(column, `%${filter.value}%`)\n case 'starts':\n return this.ops.ilike(column, `${filter.value}%`)\n case 'ends':\n return this.ops.ilike(column, `%${filter.value}`)\n case 'in': {\n const values = filter.value.split(',').map((v) => this.coerce(v.trim()))\n return this.ops.inArray(column, values)\n }\n case 'between': {\n const [min, max] = filter.value.split(',').map((v) => this.coerce(v.trim()))\n return this.ops.and(this.ops.gte(column, min), this.ops.lte(column, max))\n }\n default:\n return this.ops.eq(column, value)\n }\n }\n\n /**\n * Map a FilterItem to a Drizzle condition using a Column object.\n * Coerces values based on `column.dataType` for type-safe filtering.\n */\n private buildColumnFilter(column: any, filter: FilterItem): any {\n const value = this.coerceByDataType(filter.value, column.dataType)\n\n switch (filter.operator) {\n case 'eq':\n return this.ops.eq(column, value)\n case 'neq':\n return this.ops.ne(column, value)\n case 'gt':\n return this.ops.gt(column, value)\n case 'gte':\n return this.ops.gte(column, value)\n case 'lt':\n return this.ops.lt(column, value)\n case 'lte':\n return this.ops.lte(column, value)\n case 'contains':\n return this.ops.ilike(column, `%${filter.value}%`)\n case 'starts':\n return this.ops.ilike(column, `${filter.value}%`)\n case 'ends':\n return this.ops.ilike(column, `%${filter.value}`)\n case 'in': {\n const values = filter.value\n .split(',')\n .map((v) => this.coerceByDataType(v.trim(), column.dataType))\n return this.ops.inArray(column, values)\n }\n case 'between': {\n const [minStr, maxStr] = filter.value.split(',').map((v) => v.trim())\n const min = this.coerceByDataType(minStr, column.dataType)\n const max = this.coerceByDataType(maxStr, column.dataType)\n if (this.ops.between) {\n return this.ops.between(column, min, max)\n }\n return this.ops.and(this.ops.gte(column, min), this.ops.lte(column, max))\n }\n default:\n return this.ops.eq(column, value)\n }\n }\n\n /** Build Drizzle orderBy from SortItem[] */\n private buildSort(table: Record<string, any>, sort: SortItem[]): any[] {\n return sort\n .filter((item) => table[item.field])\n .map((item) =>\n item.direction === 'desc'\n ? this.ops.desc(table[item.field])\n : this.ops.asc(table[item.field]),\n )\n }\n\n /** Attempt to coerce a string value to a number or boolean if appropriate */\n private coerce(value: string): string | number | boolean {\n if (value === 'true') return true\n if (value === 'false') return false\n const num = Number(value)\n if (!Number.isNaN(num) && value.trim() !== '') return num\n return value\n }\n\n /**\n * Coerce a string value based on the column's dataType.\n *\n * - `'boolean'` → `true`/`false`\n * - `'number'` / `'bigint'` → `Number(value)`\n * - `'date'` → `new Date(value)` (ISO 8601 strings)\n * - Everything else → original string\n */\n private coerceByDataType(value: string, dataType?: string): string | number | boolean | Date {\n if (!dataType) return this.coerce(value)\n\n switch (dataType) {\n case 'boolean':\n return value === 'true' || value === '1'\n case 'number':\n case 'bigint': {\n const num = Number(value)\n return Number.isNaN(num) ? value : num\n }\n case 'date':\n case 'localDate':\n case 'localDateTime': {\n const date = new Date(value)\n return Number.isNaN(date.getTime()) ? value : date\n }\n default:\n return value\n }\n }\n}\n"],"mappings":";;;;;;;;;;;;;AAGA,MAAa,aAAa,OAAO,YAAY;;;ACA7C,MAAM,MAAM,OAAO,IAAI,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuCxC,IAAa,iBAAb,MAAiE;CAC/D,OAAO;CACP;CACA;CAEA,YAAY,SAA6C;AAArC,OAAA,UAAA;AAClB,OAAK,KAAK,QAAQ;AAClB,OAAK,aAAa,QAAQ;;;CAI5B,YAAY,EAAE,aAAmC;AAC/C,MAAI,KAAK,QAAQ,QACf,KAAI,KAAK,wBAAwB;AAGnC,YAAU,gBAAgB,kBAAkB,KAAK,IAAI,MAAM,UAAU;AAErE,MAAI,KAAK,8CAA8C;;;CAIzD,MAAM,WAA0B;AAC9B,MAAI,KAAK,YAAY;AACnB,SAAM,KAAK,YAAY;AACvB,OAAI,KAAK,4BAA4B;;;;;;;;;;;;;;;;;;ACuD3C,SAAgB,mBAAmB,QAIjC;AACA,QAAO;EACL,YAAY,OAAO,KAAK,OAAO,QAAQ;EACvC,UAAU,OAAO,WAAW,OAAO,KAAK,OAAO,SAAS,GAAG,EAAE;EAC7D,YAAY,OAAO,gBACf,OAAO,cAAc,KAAK,QAAQ,IAAI,QAAQ,GAAG,CAAC,OAAO,QAAQ,GACjE,EAAE;EACP;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0EH,IAAa,sBAAb,MAGE;CACA,OAAgB;CAEhB,YAAY,KAAyB;AAAjB,OAAA,MAAA;;;;;;CAMpB,MACE,QACA,SAA6B,EAAE,EACX;EACpB,MAAM,SAA6B;GACjC,SAAS,EAAE;GACX,OAAO,OAAO,WAAW;GACzB,QAAQ,OAAO,WAAW;GAC3B;EAGD,MAAM,aAAoB,EAAE;AAG5B,OAAK,MAAM,UAAU,OAAO,SAAS;GACnC,MAAM,YAAY,KAAK,YAAY,OAAO,OAAO,OAAO;AACxD,OAAI,UAAW,YAAW,KAAK,UAAU;;AAI3C,MAAI,OAAO,UAAU,OAAO,iBAAiB,OAAO,cAAc,SAAS,GAAG;GAC5E,MAAM,mBAAmB,OAAO,cAC7B,QAAQ,QAAQ,OAAO,MAAM,KAAK,CAClC,KAAK,QAAQ,KAAK,IAAI,MAAM,OAAO,MAAM,MAAM,IAAI,OAAO,OAAO,GAAG,CAAC;AAExE,OAAI,iBAAiB,SAAS,EAC5B,YAAW,KAAK,KAAK,IAAI,GAAG,GAAG,iBAAiB,CAAC;;AAKrD,MAAI,WAAW,WAAW,EACxB,QAAO,QAAQ,WAAW;WACjB,WAAW,SAAS,EAC7B,QAAO,QAAQ,KAAK,IAAI,IAAI,GAAG,WAAW;AAI5C,SAAO,UAAU,KAAK,UAAU,OAAO,OAAO,OAAO,KAAK;AAE1D,SAAO;;;;;;;;;;;;;;;;;;;;;;CAuBT,iBAAiB,QAAqB,QAAsD;EAC1F,MAAM,SAA6B;GACjC,SAAS,EAAE;GACX,OAAO,OAAO,WAAW;GACzB,QAAQ,OAAO,WAAW;GAC3B;EAED,MAAM,aAAoB,EAAE;AAG5B,MAAI,OAAO,cACT,YAAW,KAAK,OAAO,cAAc;AAIvC,OAAK,MAAM,UAAU,OAAO,SAAS;GACnC,MAAM,SAAS,OAAO,QAAQ,OAAO;AACrC,OAAI,CAAC,OAAQ;GACb,MAAM,YAAY,KAAK,kBAAkB,QAAQ,OAAO;AACxD,OAAI,UAAW,YAAW,KAAK,UAAU;;AAI3C,MAAI,OAAO,UAAU,OAAO,iBAAiB,OAAO,cAAc,SAAS,GAAG;GAC5E,MAAM,mBAAmB,OAAO,cAAc,KAAK,QACjD,KAAK,IAAI,MAAM,KAAK,IAAI,OAAO,OAAO,GAAG,CAC1C;AACD,OAAI,iBAAiB,SAAS,EAC5B,YAAW,KAAK,KAAK,IAAI,GAAG,GAAG,iBAAiB,CAAC;;AAKrD,MAAI,WAAW,WAAW,EACxB,QAAO,QAAQ,WAAW;WACjB,WAAW,SAAS,EAC7B,QAAO,QAAQ,KAAK,IAAI,IAAI,GAAG,WAAW;EAI5C,MAAM,UAAU,OAAO,YAAY,OAAO;AAC1C,SAAO,UAAU,OAAO,KACrB,QAAQ,SAAS,QAAQ,KAAK,OAAO,CACrC,KAAK,SACJ,KAAK,cAAc,SACf,KAAK,IAAI,KAAK,QAAQ,KAAK,OAAO,GAClC,KAAK,IAAI,IAAI,QAAQ,KAAK,OAAO,CACtC;AAEH,SAAO;;;CAIT,YAAoB,OAA4B,QAAyB;EACvE,MAAM,SAAS,MAAM,OAAO;AAC5B,MAAI,CAAC,OAAQ,QAAO;EAEpB,MAAM,QAAQ,KAAK,OAAO,OAAO,MAAM;AAEvC,UAAQ,OAAO,UAAf;GACE,KAAK,KACH,QAAO,KAAK,IAAI,GAAG,QAAQ,MAAM;GACnC,KAAK,MACH,QAAO,KAAK,IAAI,GAAG,QAAQ,MAAM;GACnC,KAAK,KACH,QAAO,KAAK,IAAI,GAAG,QAAQ,MAAM;GACnC,KAAK,MACH,QAAO,KAAK,IAAI,IAAI,QAAQ,MAAM;GACpC,KAAK,KACH,QAAO,KAAK,IAAI,GAAG,QAAQ,MAAM;GACnC,KAAK,MACH,QAAO,KAAK,IAAI,IAAI,QAAQ,MAAM;GACpC,KAAK,WACH,QAAO,KAAK,IAAI,MAAM,QAAQ,IAAI,OAAO,MAAM,GAAG;GACpD,KAAK,SACH,QAAO,KAAK,IAAI,MAAM,QAAQ,GAAG,OAAO,MAAM,GAAG;GACnD,KAAK,OACH,QAAO,KAAK,IAAI,MAAM,QAAQ,IAAI,OAAO,QAAQ;GACnD,KAAK,MAAM;IACT,MAAM,SAAS,OAAO,MAAM,MAAM,IAAI,CAAC,KAAK,MAAM,KAAK,OAAO,EAAE,MAAM,CAAC,CAAC;AACxE,WAAO,KAAK,IAAI,QAAQ,QAAQ,OAAO;;GAEzC,KAAK,WAAW;IACd,MAAM,CAAC,KAAK,OAAO,OAAO,MAAM,MAAM,IAAI,CAAC,KAAK,MAAM,KAAK,OAAO,EAAE,MAAM,CAAC,CAAC;AAC5E,WAAO,KAAK,IAAI,IAAI,KAAK,IAAI,IAAI,QAAQ,IAAI,EAAE,KAAK,IAAI,IAAI,QAAQ,IAAI,CAAC;;GAE3E,QACE,QAAO,KAAK,IAAI,GAAG,QAAQ,MAAM;;;;;;;CAQvC,kBAA0B,QAAa,QAAyB;EAC9D,MAAM,QAAQ,KAAK,iBAAiB,OAAO,OAAO,OAAO,SAAS;AAElE,UAAQ,OAAO,UAAf;GACE,KAAK,KACH,QAAO,KAAK,IAAI,GAAG,QAAQ,MAAM;GACnC,KAAK,MACH,QAAO,KAAK,IAAI,GAAG,QAAQ,MAAM;GACnC,KAAK,KACH,QAAO,KAAK,IAAI,GAAG,QAAQ,MAAM;GACnC,KAAK,MACH,QAAO,KAAK,IAAI,IAAI,QAAQ,MAAM;GACpC,KAAK,KACH,QAAO,KAAK,IAAI,GAAG,QAAQ,MAAM;GACnC,KAAK,MACH,QAAO,KAAK,IAAI,IAAI,QAAQ,MAAM;GACpC,KAAK,WACH,QAAO,KAAK,IAAI,MAAM,QAAQ,IAAI,OAAO,MAAM,GAAG;GACpD,KAAK,SACH,QAAO,KAAK,IAAI,MAAM,QAAQ,GAAG,OAAO,MAAM,GAAG;GACnD,KAAK,OACH,QAAO,KAAK,IAAI,MAAM,QAAQ,IAAI,OAAO,QAAQ;GACnD,KAAK,MAAM;IACT,MAAM,SAAS,OAAO,MACnB,MAAM,IAAI,CACV,KAAK,MAAM,KAAK,iBAAiB,EAAE,MAAM,EAAE,OAAO,SAAS,CAAC;AAC/D,WAAO,KAAK,IAAI,QAAQ,QAAQ,OAAO;;GAEzC,KAAK,WAAW;IACd,MAAM,CAAC,QAAQ,UAAU,OAAO,MAAM,MAAM,IAAI,CAAC,KAAK,MAAM,EAAE,MAAM,CAAC;IACrE,MAAM,MAAM,KAAK,iBAAiB,QAAQ,OAAO,SAAS;IAC1D,MAAM,MAAM,KAAK,iBAAiB,QAAQ,OAAO,SAAS;AAC1D,QAAI,KAAK,IAAI,QACX,QAAO,KAAK,IAAI,QAAQ,QAAQ,KAAK,IAAI;AAE3C,WAAO,KAAK,IAAI,IAAI,KAAK,IAAI,IAAI,QAAQ,IAAI,EAAE,KAAK,IAAI,IAAI,QAAQ,IAAI,CAAC;;GAE3E,QACE,QAAO,KAAK,IAAI,GAAG,QAAQ,MAAM;;;;CAKvC,UAAkB,OAA4B,MAAyB;AACrE,SAAO,KACJ,QAAQ,SAAS,MAAM,KAAK,OAAO,CACnC,KAAK,SACJ,KAAK,cAAc,SACf,KAAK,IAAI,KAAK,MAAM,KAAK,OAAO,GAChC,KAAK,IAAI,IAAI,MAAM,KAAK,OAAO,CACpC;;;CAIL,OAAe,OAA0C;AACvD,MAAI,UAAU,OAAQ,QAAO;AAC7B,MAAI,UAAU,QAAS,QAAO;EAC9B,MAAM,MAAM,OAAO,MAAM;AACzB,MAAI,CAAC,OAAO,MAAM,IAAI,IAAI,MAAM,MAAM,KAAK,GAAI,QAAO;AACtD,SAAO;;;;;;;;;;CAWT,iBAAyB,OAAe,UAAqD;AAC3F,MAAI,CAAC,SAAU,QAAO,KAAK,OAAO,MAAM;AAExC,UAAQ,UAAR;GACE,KAAK,UACH,QAAO,UAAU,UAAU,UAAU;GACvC,KAAK;GACL,KAAK,UAAU;IACb,MAAM,MAAM,OAAO,MAAM;AACzB,WAAO,OAAO,MAAM,IAAI,GAAG,QAAQ;;GAErC,KAAK;GACL,KAAK;GACL,KAAK,iBAAiB;IACpB,MAAM,OAAO,IAAI,KAAK,MAAM;AAC5B,WAAO,OAAO,MAAM,KAAK,SAAS,CAAC,GAAG,QAAQ;;GAEhD,QACE,QAAO"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@forinda/kickjs-drizzle",
|
|
3
|
-
"version": "2.0
|
|
3
|
+
"version": "2.1.0",
|
|
4
4
|
"description": "Drizzle ORM adapter with DI integration, transaction support, and query building for KickJS",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"kickjs",
|
|
@@ -41,20 +41,37 @@
|
|
|
41
41
|
"vite"
|
|
42
42
|
],
|
|
43
43
|
"type": "module",
|
|
44
|
-
"main": "dist/index.
|
|
45
|
-
"types": "dist/index.d.
|
|
44
|
+
"main": "dist/index.mjs",
|
|
45
|
+
"types": "dist/index.d.mts",
|
|
46
46
|
"exports": {
|
|
47
47
|
".": {
|
|
48
|
-
"import": "./dist/index.
|
|
49
|
-
"types": "./dist/index.d.
|
|
48
|
+
"import": "./dist/index.mjs",
|
|
49
|
+
"types": "./dist/index.d.mts"
|
|
50
50
|
}
|
|
51
51
|
},
|
|
52
52
|
"files": [
|
|
53
53
|
"dist"
|
|
54
54
|
],
|
|
55
|
+
"wireit": {
|
|
56
|
+
"build": {
|
|
57
|
+
"command": "tsdown",
|
|
58
|
+
"files": [
|
|
59
|
+
"src/**/*.ts",
|
|
60
|
+
"tsdown.config.ts",
|
|
61
|
+
"tsconfig.json",
|
|
62
|
+
"package.json"
|
|
63
|
+
],
|
|
64
|
+
"output": [
|
|
65
|
+
"dist/**"
|
|
66
|
+
],
|
|
67
|
+
"dependencies": [
|
|
68
|
+
"../core:build"
|
|
69
|
+
]
|
|
70
|
+
}
|
|
71
|
+
},
|
|
55
72
|
"dependencies": {
|
|
56
73
|
"reflect-metadata": "^0.2.2",
|
|
57
|
-
"@forinda/kickjs": "2.0
|
|
74
|
+
"@forinda/kickjs": "2.1.0"
|
|
58
75
|
},
|
|
59
76
|
"peerDependencies": {
|
|
60
77
|
"drizzle-orm": ">=0.30.0"
|
|
@@ -81,11 +98,11 @@
|
|
|
81
98
|
"url": "https://github.com/forinda/kick-js/issues"
|
|
82
99
|
},
|
|
83
100
|
"scripts": {
|
|
84
|
-
"build": "
|
|
85
|
-
"
|
|
86
|
-
"
|
|
101
|
+
"build": "wireit",
|
|
102
|
+
"dev": "tsdown --watch",
|
|
103
|
+
"test": "vitest run --passWithNoTests",
|
|
87
104
|
"typecheck": "tsc --noEmit",
|
|
88
|
-
"clean": "rm -rf dist .
|
|
105
|
+
"clean": "rm -rf dist .wireit",
|
|
89
106
|
"lint": "tsc --noEmit"
|
|
90
107
|
}
|
|
91
108
|
}
|
|
@@ -1,51 +0,0 @@
|
|
|
1
|
-
import { type AppAdapter, type AdapterContext } from '@forinda/kickjs';
|
|
2
|
-
import { type DrizzleAdapterOptions } from './types';
|
|
3
|
-
/**
|
|
4
|
-
* Drizzle ORM adapter — registers a Drizzle database instance in the DI
|
|
5
|
-
* container and manages its lifecycle.
|
|
6
|
-
*
|
|
7
|
-
* Works with any Drizzle driver: `drizzle-orm/postgres-js`, `drizzle-orm/node-postgres`,
|
|
8
|
-
* `drizzle-orm/mysql2`, `drizzle-orm/better-sqlite3`, `drizzle-orm/libsql`, etc.
|
|
9
|
-
*
|
|
10
|
-
* The adapter is generic — the db type is inferred from what you pass in,
|
|
11
|
-
* so services can inject the fully-typed database instance.
|
|
12
|
-
*
|
|
13
|
-
* @example
|
|
14
|
-
* ```ts
|
|
15
|
-
* import { drizzle } from 'drizzle-orm/better-sqlite3'
|
|
16
|
-
* import * as schema from './schema'
|
|
17
|
-
* import { DrizzleAdapter } from '@forinda/kickjs-drizzle'
|
|
18
|
-
*
|
|
19
|
-
* const db = drizzle({ client: sqlite, schema })
|
|
20
|
-
*
|
|
21
|
-
* bootstrap({
|
|
22
|
-
* modules,
|
|
23
|
-
* adapters: [
|
|
24
|
-
* new DrizzleAdapter({ db, onShutdown: () => sqlite.close() }),
|
|
25
|
-
* ],
|
|
26
|
-
* })
|
|
27
|
-
* ```
|
|
28
|
-
*
|
|
29
|
-
* Inject the typed db instance in services:
|
|
30
|
-
* ```ts
|
|
31
|
-
* import type { BetterSQLite3Database } from 'drizzle-orm/better-sqlite3'
|
|
32
|
-
* import * as schema from './schema'
|
|
33
|
-
*
|
|
34
|
-
* @Service()
|
|
35
|
-
* class UserService {
|
|
36
|
-
* constructor(@Inject(DRIZZLE_DB) private db: BetterSQLite3Database<typeof schema>) {}
|
|
37
|
-
* }
|
|
38
|
-
* ```
|
|
39
|
-
*/
|
|
40
|
-
export declare class DrizzleAdapter<TDb = unknown> implements AppAdapter {
|
|
41
|
-
private options;
|
|
42
|
-
name: string;
|
|
43
|
-
private db;
|
|
44
|
-
private onShutdown?;
|
|
45
|
-
constructor(options: DrizzleAdapterOptions<TDb>);
|
|
46
|
-
/** Register the Drizzle db instance in the DI container */
|
|
47
|
-
beforeStart({ container }: AdapterContext): void;
|
|
48
|
-
/** Close the underlying connection on shutdown */
|
|
49
|
-
shutdown(): Promise<void>;
|
|
50
|
-
}
|
|
51
|
-
//# sourceMappingURL=drizzle.adapter.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"drizzle.adapter.d.ts","sourceRoot":"","sources":["../src/drizzle.adapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,KAAK,UAAU,EAAE,KAAK,cAAc,EAAS,MAAM,iBAAiB,CAAA;AACrF,OAAO,EAAc,KAAK,qBAAqB,EAAE,MAAM,SAAS,CAAA;AAIhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,qBAAa,cAAc,CAAC,GAAG,GAAG,OAAO,CAAE,YAAW,UAAU;IAKlD,OAAO,CAAC,OAAO;IAJ3B,IAAI,SAAmB;IACvB,OAAO,CAAC,EAAE,CAAK;IACf,OAAO,CAAC,UAAU,CAAC,CAA4B;gBAE3B,OAAO,EAAE,qBAAqB,CAAC,GAAG,CAAC;IAKvD,2DAA2D;IAC3D,WAAW,CAAC,EAAE,SAAS,EAAE,EAAE,cAAc,GAAG,IAAI;IAUhD,kDAAkD;IAC5C,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;CAMhC"}
|
package/dist/index.d.ts
DELETED
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
export { DrizzleAdapter } from './drizzle.adapter';
|
|
2
|
-
export { DrizzleQueryAdapter, toQueryFieldConfig } from './query-adapter';
|
|
3
|
-
export { DRIZZLE_DB } from './types';
|
|
4
|
-
export type { DrizzleAdapterOptions } from './types';
|
|
5
|
-
export type { DrizzleQueryConfig, DrizzleColumnQueryConfig, DrizzleQueryParamsConfig, DrizzleQueryResult, DrizzleOps, } from './query-adapter';
|
|
6
|
-
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAClD,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AACzE,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AACpC,YAAY,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAA;AACpD,YAAY,EACV,kBAAkB,EAClB,wBAAwB,EACxB,wBAAwB,EACxB,kBAAkB,EAClB,UAAU,GACX,MAAM,iBAAiB,CAAA"}
|
package/dist/index.js
DELETED
|
@@ -1,168 +0,0 @@
|
|
|
1
|
-
import { Logger as l, Scope as c } from "@forinda/kickjs";
|
|
2
|
-
var u = /* @__PURE__ */ Symbol("DrizzleDB"), h = l.for("DrizzleAdapter"), d = class {
|
|
3
|
-
name = "DrizzleAdapter";
|
|
4
|
-
db;
|
|
5
|
-
onShutdown;
|
|
6
|
-
constructor(e) {
|
|
7
|
-
this.options = e, this.db = e.db, this.onShutdown = e.onShutdown;
|
|
8
|
-
}
|
|
9
|
-
beforeStart({ container: e }) {
|
|
10
|
-
this.options.logging && h.info("Query logging enabled"), e.registerFactory(u, () => this.db, c.SINGLETON), h.info("Drizzle database registered in DI container");
|
|
11
|
-
}
|
|
12
|
-
async shutdown() {
|
|
13
|
-
this.onShutdown && (await this.onShutdown(), h.info("Drizzle connection closed"));
|
|
14
|
-
}
|
|
15
|
-
};
|
|
16
|
-
function b(e) {
|
|
17
|
-
return {
|
|
18
|
-
filterable: Object.keys(e.columns),
|
|
19
|
-
sortable: e.sortable ? Object.keys(e.sortable) : [],
|
|
20
|
-
searchable: e.searchColumns ? e.searchColumns.map((s) => s.name ?? "").filter(Boolean) : []
|
|
21
|
-
};
|
|
22
|
-
}
|
|
23
|
-
var m = class {
|
|
24
|
-
name = "DrizzleQueryAdapter";
|
|
25
|
-
constructor(e) {
|
|
26
|
-
this.ops = e;
|
|
27
|
-
}
|
|
28
|
-
build(e, s = {}) {
|
|
29
|
-
const t = {
|
|
30
|
-
orderBy: [],
|
|
31
|
-
limit: e.pagination.limit,
|
|
32
|
-
offset: e.pagination.offset
|
|
33
|
-
}, r = [];
|
|
34
|
-
for (const o of e.filters) {
|
|
35
|
-
const i = this.buildFilter(s.table, o);
|
|
36
|
-
i && r.push(i);
|
|
37
|
-
}
|
|
38
|
-
if (e.search && s.searchColumns && s.searchColumns.length > 0) {
|
|
39
|
-
const o = s.searchColumns.filter((i) => s.table[i]).map((i) => this.ops.ilike(s.table[i], `%${e.search}%`));
|
|
40
|
-
o.length > 0 && r.push(this.ops.or(...o));
|
|
41
|
-
}
|
|
42
|
-
return r.length === 1 ? t.where = r[0] : r.length > 1 && (t.where = this.ops.and(...r)), t.orderBy = this.buildSort(s.table, e.sort), t;
|
|
43
|
-
}
|
|
44
|
-
buildFromColumns(e, s) {
|
|
45
|
-
const t = {
|
|
46
|
-
orderBy: [],
|
|
47
|
-
limit: e.pagination.limit,
|
|
48
|
-
offset: e.pagination.offset
|
|
49
|
-
}, r = [];
|
|
50
|
-
s.baseCondition && r.push(s.baseCondition);
|
|
51
|
-
for (const i of e.filters) {
|
|
52
|
-
const n = s.columns[i.field];
|
|
53
|
-
if (!n) continue;
|
|
54
|
-
const a = this.buildColumnFilter(n, i);
|
|
55
|
-
a && r.push(a);
|
|
56
|
-
}
|
|
57
|
-
if (e.search && s.searchColumns && s.searchColumns.length > 0) {
|
|
58
|
-
const i = s.searchColumns.map((n) => this.ops.ilike(n, `%${e.search}%`));
|
|
59
|
-
i.length > 0 && r.push(this.ops.or(...i));
|
|
60
|
-
}
|
|
61
|
-
r.length === 1 ? t.where = r[0] : r.length > 1 && (t.where = this.ops.and(...r));
|
|
62
|
-
const o = s.sortable ?? s.columns;
|
|
63
|
-
return t.orderBy = e.sort.filter((i) => o[i.field]).map((i) => i.direction === "desc" ? this.ops.desc(o[i.field]) : this.ops.asc(o[i.field])), t;
|
|
64
|
-
}
|
|
65
|
-
buildFilter(e, s) {
|
|
66
|
-
const t = e[s.field];
|
|
67
|
-
if (!t) return null;
|
|
68
|
-
const r = this.coerce(s.value);
|
|
69
|
-
switch (s.operator) {
|
|
70
|
-
case "eq":
|
|
71
|
-
return this.ops.eq(t, r);
|
|
72
|
-
case "neq":
|
|
73
|
-
return this.ops.ne(t, r);
|
|
74
|
-
case "gt":
|
|
75
|
-
return this.ops.gt(t, r);
|
|
76
|
-
case "gte":
|
|
77
|
-
return this.ops.gte(t, r);
|
|
78
|
-
case "lt":
|
|
79
|
-
return this.ops.lt(t, r);
|
|
80
|
-
case "lte":
|
|
81
|
-
return this.ops.lte(t, r);
|
|
82
|
-
case "contains":
|
|
83
|
-
return this.ops.ilike(t, `%${s.value}%`);
|
|
84
|
-
case "starts":
|
|
85
|
-
return this.ops.ilike(t, `${s.value}%`);
|
|
86
|
-
case "ends":
|
|
87
|
-
return this.ops.ilike(t, `%${s.value}`);
|
|
88
|
-
case "in": {
|
|
89
|
-
const o = s.value.split(",").map((i) => this.coerce(i.trim()));
|
|
90
|
-
return this.ops.inArray(t, o);
|
|
91
|
-
}
|
|
92
|
-
case "between": {
|
|
93
|
-
const [o, i] = s.value.split(",").map((n) => this.coerce(n.trim()));
|
|
94
|
-
return this.ops.and(this.ops.gte(t, o), this.ops.lte(t, i));
|
|
95
|
-
}
|
|
96
|
-
default:
|
|
97
|
-
return this.ops.eq(t, r);
|
|
98
|
-
}
|
|
99
|
-
}
|
|
100
|
-
buildColumnFilter(e, s) {
|
|
101
|
-
const t = this.coerceByDataType(s.value, e.dataType);
|
|
102
|
-
switch (s.operator) {
|
|
103
|
-
case "eq":
|
|
104
|
-
return this.ops.eq(e, t);
|
|
105
|
-
case "neq":
|
|
106
|
-
return this.ops.ne(e, t);
|
|
107
|
-
case "gt":
|
|
108
|
-
return this.ops.gt(e, t);
|
|
109
|
-
case "gte":
|
|
110
|
-
return this.ops.gte(e, t);
|
|
111
|
-
case "lt":
|
|
112
|
-
return this.ops.lt(e, t);
|
|
113
|
-
case "lte":
|
|
114
|
-
return this.ops.lte(e, t);
|
|
115
|
-
case "contains":
|
|
116
|
-
return this.ops.ilike(e, `%${s.value}%`);
|
|
117
|
-
case "starts":
|
|
118
|
-
return this.ops.ilike(e, `${s.value}%`);
|
|
119
|
-
case "ends":
|
|
120
|
-
return this.ops.ilike(e, `%${s.value}`);
|
|
121
|
-
case "in": {
|
|
122
|
-
const r = s.value.split(",").map((o) => this.coerceByDataType(o.trim(), e.dataType));
|
|
123
|
-
return this.ops.inArray(e, r);
|
|
124
|
-
}
|
|
125
|
-
case "between": {
|
|
126
|
-
const [r, o] = s.value.split(",").map((a) => a.trim()), i = this.coerceByDataType(r, e.dataType), n = this.coerceByDataType(o, e.dataType);
|
|
127
|
-
return this.ops.between ? this.ops.between(e, i, n) : this.ops.and(this.ops.gte(e, i), this.ops.lte(e, n));
|
|
128
|
-
}
|
|
129
|
-
default:
|
|
130
|
-
return this.ops.eq(e, t);
|
|
131
|
-
}
|
|
132
|
-
}
|
|
133
|
-
buildSort(e, s) {
|
|
134
|
-
return s.filter((t) => e[t.field]).map((t) => t.direction === "desc" ? this.ops.desc(e[t.field]) : this.ops.asc(e[t.field]));
|
|
135
|
-
}
|
|
136
|
-
coerce(e) {
|
|
137
|
-
if (e === "true") return !0;
|
|
138
|
-
if (e === "false") return !1;
|
|
139
|
-
const s = Number(e);
|
|
140
|
-
return !Number.isNaN(s) && e.trim() !== "" ? s : e;
|
|
141
|
-
}
|
|
142
|
-
coerceByDataType(e, s) {
|
|
143
|
-
if (!s) return this.coerce(e);
|
|
144
|
-
switch (s) {
|
|
145
|
-
case "boolean":
|
|
146
|
-
return e === "true" || e === "1";
|
|
147
|
-
case "number":
|
|
148
|
-
case "bigint": {
|
|
149
|
-
const t = Number(e);
|
|
150
|
-
return Number.isNaN(t) ? e : t;
|
|
151
|
-
}
|
|
152
|
-
case "date":
|
|
153
|
-
case "localDate":
|
|
154
|
-
case "localDateTime": {
|
|
155
|
-
const t = new Date(e);
|
|
156
|
-
return Number.isNaN(t.getTime()) ? e : t;
|
|
157
|
-
}
|
|
158
|
-
default:
|
|
159
|
-
return e;
|
|
160
|
-
}
|
|
161
|
-
}
|
|
162
|
-
};
|
|
163
|
-
export {
|
|
164
|
-
u as DRIZZLE_DB,
|
|
165
|
-
d as DrizzleAdapter,
|
|
166
|
-
m as DrizzleQueryAdapter,
|
|
167
|
-
b as toQueryFieldConfig
|
|
168
|
-
};
|
package/dist/query-adapter.d.ts
DELETED
|
@@ -1,241 +0,0 @@
|
|
|
1
|
-
import type { QueryBuilderAdapter, ParsedQuery } from '@forinda/kickjs';
|
|
2
|
-
/**
|
|
3
|
-
* Configuration for the Drizzle query builder adapter.
|
|
4
|
-
*
|
|
5
|
-
* Unlike Prisma which uses its own query builder API, Drizzle uses SQL-like
|
|
6
|
-
* operators (`eq`, `gt`, `like`, etc.) from `drizzle-orm`. This adapter
|
|
7
|
-
* produces a config object that can be spread into Drizzle's `select().from().where()`.
|
|
8
|
-
*/
|
|
9
|
-
export interface DrizzleQueryConfig {
|
|
10
|
-
/** The Drizzle table schema object (e.g., `users` from your schema) */
|
|
11
|
-
table: Record<string, any>;
|
|
12
|
-
/** Columns to search across when a search string is provided */
|
|
13
|
-
searchColumns?: string[];
|
|
14
|
-
}
|
|
15
|
-
/**
|
|
16
|
-
* Type-safe Drizzle query configuration using Column objects.
|
|
17
|
-
*
|
|
18
|
-
* Use this instead of `DrizzleQueryConfig` for type-safe column references
|
|
19
|
-
* that are validated at compile time. Column objects carry `dataType` metadata
|
|
20
|
-
* enabling automatic type coercion of filter values.
|
|
21
|
-
*
|
|
22
|
-
* @example
|
|
23
|
-
* ```ts
|
|
24
|
-
* import { users } from './schema'
|
|
25
|
-
* import type { DrizzleColumnQueryConfig } from '@forinda/kickjs-drizzle'
|
|
26
|
-
*
|
|
27
|
-
* const config: DrizzleColumnQueryConfig = {
|
|
28
|
-
* columns: {
|
|
29
|
-
* status: users.status,
|
|
30
|
-
* isActive: users.isActive,
|
|
31
|
-
* createdAt: users.createdAt,
|
|
32
|
-
* },
|
|
33
|
-
* sortable: {
|
|
34
|
-
* name: users.name,
|
|
35
|
-
* createdAt: users.createdAt,
|
|
36
|
-
* },
|
|
37
|
-
* searchColumns: [users.firstName, users.lastName, users.email],
|
|
38
|
-
* baseCondition: eq(users.tenantId, tenantId),
|
|
39
|
-
* }
|
|
40
|
-
* ```
|
|
41
|
-
*/
|
|
42
|
-
export interface DrizzleColumnQueryConfig {
|
|
43
|
-
/**
|
|
44
|
-
* Map of filterable field names to Drizzle Column objects.
|
|
45
|
-
* Keys are the query parameter names, values are the actual schema columns.
|
|
46
|
-
* The column's `dataType` is used for automatic type coercion.
|
|
47
|
-
*/
|
|
48
|
-
columns: Record<string, any>;
|
|
49
|
-
/**
|
|
50
|
-
* Map of sortable field names to Drizzle Column objects.
|
|
51
|
-
* If not provided, falls back to `columns` for sort lookups.
|
|
52
|
-
*/
|
|
53
|
-
sortable?: Record<string, any>;
|
|
54
|
-
/**
|
|
55
|
-
* Column objects to search across when a search string is provided.
|
|
56
|
-
* Each entry should be a Drizzle Column (not a string).
|
|
57
|
-
*/
|
|
58
|
-
searchColumns?: any[];
|
|
59
|
-
/**
|
|
60
|
-
* A pre-built SQL condition that is always prepended to the WHERE clause.
|
|
61
|
-
* Use for scoping queries by tenant, workspace, or other invariants.
|
|
62
|
-
*
|
|
63
|
-
* @example
|
|
64
|
-
* ```ts
|
|
65
|
-
* baseCondition: and(eq(tasks.tenantId, tid), eq(tasks.workspaceId, wid))
|
|
66
|
-
* ```
|
|
67
|
-
*/
|
|
68
|
-
baseCondition?: any;
|
|
69
|
-
}
|
|
70
|
-
/**
|
|
71
|
-
* Configuration type for defining query param schemas with Drizzle Column objects.
|
|
72
|
-
*
|
|
73
|
-
* Used in constants files to define which columns are filterable, sortable, and searchable.
|
|
74
|
-
* This type is consumed by both `DrizzleQueryAdapter.buildFromColumns()` and `@ApiQueryParams()`.
|
|
75
|
-
*
|
|
76
|
-
* @example
|
|
77
|
-
* ```ts
|
|
78
|
-
* import type { DrizzleQueryParamsConfig } from '@forinda/kickjs-drizzle'
|
|
79
|
-
* import { tasks } from '@/db/schema'
|
|
80
|
-
*
|
|
81
|
-
* export const TASK_QUERY_CONFIG: DrizzleQueryParamsConfig = {
|
|
82
|
-
* columns: {
|
|
83
|
-
* status: tasks.status,
|
|
84
|
-
* priority: tasks.priority,
|
|
85
|
-
* },
|
|
86
|
-
* sortable: {
|
|
87
|
-
* title: tasks.title,
|
|
88
|
-
* createdAt: tasks.createdAt,
|
|
89
|
-
* },
|
|
90
|
-
* searchColumns: [tasks.title, tasks.key],
|
|
91
|
-
* }
|
|
92
|
-
* ```
|
|
93
|
-
*/
|
|
94
|
-
export interface DrizzleQueryParamsConfig {
|
|
95
|
-
/** Filterable columns: keys are query param names, values are Drizzle Column objects */
|
|
96
|
-
columns: Record<string, any>;
|
|
97
|
-
/** Sortable columns: keys are query param names, values are Drizzle Column objects */
|
|
98
|
-
sortable?: Record<string, any>;
|
|
99
|
-
/** Columns for text search */
|
|
100
|
-
searchColumns?: any[];
|
|
101
|
-
/** Optional base condition for scoping (tenant, workspace, etc.) */
|
|
102
|
-
baseCondition?: any;
|
|
103
|
-
}
|
|
104
|
-
/**
|
|
105
|
-
* Convert a DrizzleQueryParamsConfig into a string-based QueryFieldConfig.
|
|
106
|
-
* Useful for passing to `@ApiQueryParams()` or other APIs that expect string arrays.
|
|
107
|
-
*
|
|
108
|
-
* @example
|
|
109
|
-
* ```ts
|
|
110
|
-
* import { toQueryFieldConfig } from '@forinda/kickjs-drizzle'
|
|
111
|
-
*
|
|
112
|
-
* const fieldConfig = toQueryFieldConfig(TASK_QUERY_CONFIG)
|
|
113
|
-
* // → { filterable: ['status', 'priority'], sortable: ['title', 'createdAt'], searchable: [] }
|
|
114
|
-
* ```
|
|
115
|
-
*/
|
|
116
|
-
export declare function toQueryFieldConfig(config: DrizzleQueryParamsConfig): {
|
|
117
|
-
filterable: string[];
|
|
118
|
-
sortable: string[];
|
|
119
|
-
searchable: string[];
|
|
120
|
-
};
|
|
121
|
-
/**
|
|
122
|
-
* Result shape compatible with Drizzle's query builder.
|
|
123
|
-
* Use with `db.select().from(table).where(result.where).orderBy(...result.orderBy).limit(result.limit).offset(result.offset)`
|
|
124
|
-
*/
|
|
125
|
-
export interface DrizzleQueryResult {
|
|
126
|
-
/** SQL condition — pass to `.where()` */
|
|
127
|
-
where?: any;
|
|
128
|
-
/** Array of order expressions — spread into `.orderBy()` */
|
|
129
|
-
orderBy: any[];
|
|
130
|
-
/** Row limit — pass to `.limit()` */
|
|
131
|
-
limit: number;
|
|
132
|
-
/** Row offset — pass to `.offset()` */
|
|
133
|
-
offset: number;
|
|
134
|
-
}
|
|
135
|
-
/**
|
|
136
|
-
* Drizzle operator functions required by the query adapter.
|
|
137
|
-
* Pass these from your `drizzle-orm` import to avoid version coupling.
|
|
138
|
-
*
|
|
139
|
-
* @example
|
|
140
|
-
* ```ts
|
|
141
|
-
* import { eq, ne, gt, gte, lt, lte, ilike, inArray, between, and, or, asc, desc } from 'drizzle-orm'
|
|
142
|
-
*
|
|
143
|
-
* const adapter = new DrizzleQueryAdapter({
|
|
144
|
-
* eq, ne, gt, gte, lt, lte, ilike, inArray, between, and, or, asc, desc,
|
|
145
|
-
* })
|
|
146
|
-
* ```
|
|
147
|
-
*/
|
|
148
|
-
export interface DrizzleOps {
|
|
149
|
-
eq: (column: any, value: any) => any;
|
|
150
|
-
ne: (column: any, value: any) => any;
|
|
151
|
-
gt: (column: any, value: any) => any;
|
|
152
|
-
gte: (column: any, value: any) => any;
|
|
153
|
-
lt: (column: any, value: any) => any;
|
|
154
|
-
lte: (column: any, value: any) => any;
|
|
155
|
-
ilike: (column: any, value: string) => any;
|
|
156
|
-
inArray: (column: any, values: any[]) => any;
|
|
157
|
-
between?: (column: any, min: any, max: any) => any;
|
|
158
|
-
and: (...conditions: any[]) => any;
|
|
159
|
-
or: (...conditions: any[]) => any;
|
|
160
|
-
asc: (column: any) => any;
|
|
161
|
-
desc: (column: any) => any;
|
|
162
|
-
}
|
|
163
|
-
/**
|
|
164
|
-
* Translates a ParsedQuery into Drizzle-compatible query parts.
|
|
165
|
-
*
|
|
166
|
-
* Supports two modes:
|
|
167
|
-
* 1. **String-based** (legacy): `build(parsed, { table, searchColumns })` — looks up columns by string name
|
|
168
|
-
* 2. **Column-based** (recommended): `buildFromColumns(parsed, config)` — uses actual Column objects for type safety
|
|
169
|
-
*
|
|
170
|
-
* @example
|
|
171
|
-
* ```ts
|
|
172
|
-
* // String-based (legacy)
|
|
173
|
-
* const query = adapter.build(parsed, { table: users, searchColumns: ['name', 'email'] })
|
|
174
|
-
*
|
|
175
|
-
* // Column-based (recommended)
|
|
176
|
-
* const query = adapter.buildFromColumns(parsed, {
|
|
177
|
-
* columns: { status: users.status, isActive: users.isActive },
|
|
178
|
-
* searchColumns: [users.name, users.email],
|
|
179
|
-
* baseCondition: eq(users.tenantId, tid),
|
|
180
|
-
* })
|
|
181
|
-
*
|
|
182
|
-
* const results = await db
|
|
183
|
-
* .select().from(users)
|
|
184
|
-
* .where(query.where)
|
|
185
|
-
* .orderBy(...query.orderBy)
|
|
186
|
-
* .limit(query.limit)
|
|
187
|
-
* .offset(query.offset)
|
|
188
|
-
* ```
|
|
189
|
-
*/
|
|
190
|
-
export declare class DrizzleQueryAdapter implements QueryBuilderAdapter<DrizzleQueryResult, DrizzleQueryConfig> {
|
|
191
|
-
private ops;
|
|
192
|
-
readonly name = "DrizzleQueryAdapter";
|
|
193
|
-
constructor(ops: DrizzleOps);
|
|
194
|
-
/**
|
|
195
|
-
* Build query from string-based config (legacy API).
|
|
196
|
-
* Prefer `buildFromColumns()` for type safety.
|
|
197
|
-
*/
|
|
198
|
-
build(parsed: ParsedQuery, config?: DrizzleQueryConfig): DrizzleQueryResult;
|
|
199
|
-
/**
|
|
200
|
-
* Build query using Column objects for type-safe filtering, sorting, and search.
|
|
201
|
-
*
|
|
202
|
-
* Features over `build()`:
|
|
203
|
-
* - Column references validated at compile time
|
|
204
|
-
* - Automatic type coercion based on `column.dataType` (boolean, number, date)
|
|
205
|
-
* - `baseCondition` support for tenant/workspace scoping
|
|
206
|
-
* - Native `between` operator support
|
|
207
|
-
* - Separate `sortable` map so filterable and sortable columns can differ
|
|
208
|
-
*
|
|
209
|
-
* @example
|
|
210
|
-
* ```ts
|
|
211
|
-
* const query = adapter.buildFromColumns(parsed, {
|
|
212
|
-
* columns: { status: tasks.status, priority: tasks.priority },
|
|
213
|
-
* sortable: { title: tasks.title, createdAt: tasks.createdAt },
|
|
214
|
-
* searchColumns: [tasks.title, tasks.key],
|
|
215
|
-
* baseCondition: eq(tasks.workspaceId, wid),
|
|
216
|
-
* })
|
|
217
|
-
* ```
|
|
218
|
-
*/
|
|
219
|
-
buildFromColumns(parsed: ParsedQuery, config: DrizzleColumnQueryConfig): DrizzleQueryResult;
|
|
220
|
-
/** Map a single FilterItem to a Drizzle condition using string-based table lookup */
|
|
221
|
-
private buildFilter;
|
|
222
|
-
/**
|
|
223
|
-
* Map a FilterItem to a Drizzle condition using a Column object.
|
|
224
|
-
* Coerces values based on `column.dataType` for type-safe filtering.
|
|
225
|
-
*/
|
|
226
|
-
private buildColumnFilter;
|
|
227
|
-
/** Build Drizzle orderBy from SortItem[] */
|
|
228
|
-
private buildSort;
|
|
229
|
-
/** Attempt to coerce a string value to a number or boolean if appropriate */
|
|
230
|
-
private coerce;
|
|
231
|
-
/**
|
|
232
|
-
* Coerce a string value based on the column's dataType.
|
|
233
|
-
*
|
|
234
|
-
* - `'boolean'` → `true`/`false`
|
|
235
|
-
* - `'number'` / `'bigint'` → `Number(value)`
|
|
236
|
-
* - `'date'` → `new Date(value)` (ISO 8601 strings)
|
|
237
|
-
* - Everything else → original string
|
|
238
|
-
*/
|
|
239
|
-
private coerceByDataType;
|
|
240
|
-
}
|
|
241
|
-
//# sourceMappingURL=query-adapter.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"query-adapter.d.ts","sourceRoot":"","sources":["../src/query-adapter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,WAAW,EAAwB,MAAM,iBAAiB,CAAA;AAE7F;;;;;;GAMG;AACH,MAAM,WAAW,kBAAkB;IACjC,uEAAuE;IACvE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC1B,gEAAgE;IAChE,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;CACzB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAE5B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAE9B;;;OAGG;IACH,aAAa,CAAC,EAAE,GAAG,EAAE,CAAA;IAErB;;;;;;;;OAQG;IACH,aAAa,CAAC,EAAE,GAAG,CAAA;CACpB;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,wBAAwB;IACvC,wFAAwF;IACxF,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC5B,sFAAsF;IACtF,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC9B,8BAA8B;IAC9B,aAAa,CAAC,EAAE,GAAG,EAAE,CAAA;IACrB,oEAAoE;IACpE,aAAa,CAAC,EAAE,GAAG,CAAA;CACpB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,wBAAwB,GAAG;IACpE,UAAU,EAAE,MAAM,EAAE,CAAA;IACpB,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,UAAU,EAAE,MAAM,EAAE,CAAA;CACrB,CAQA;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,yCAAyC;IACzC,KAAK,CAAC,EAAE,GAAG,CAAA;IACX,4DAA4D;IAC5D,OAAO,EAAE,GAAG,EAAE,CAAA;IACd,qCAAqC;IACrC,KAAK,EAAE,MAAM,CAAA;IACb,uCAAuC;IACvC,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,KAAK,GAAG,CAAA;IACpC,EAAE,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,KAAK,GAAG,CAAA;IACpC,EAAE,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,KAAK,GAAG,CAAA;IACpC,GAAG,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,KAAK,GAAG,CAAA;IACrC,EAAE,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,KAAK,GAAG,CAAA;IACpC,GAAG,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,KAAK,GAAG,CAAA;IACrC,KAAK,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,KAAK,GAAG,CAAA;IAC1C,OAAO,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IAC5C,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,KAAK,GAAG,CAAA;IAClD,GAAG,EAAE,CAAC,GAAG,UAAU,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IAClC,EAAE,EAAE,CAAC,GAAG,UAAU,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACjC,GAAG,EAAE,CAAC,MAAM,EAAE,GAAG,KAAK,GAAG,CAAA;IACzB,IAAI,EAAE,CAAC,MAAM,EAAE,GAAG,KAAK,GAAG,CAAA;CAC3B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAAa,mBAAoB,YAAW,mBAAmB,CAC7D,kBAAkB,EAClB,kBAAkB,CACnB;IAGa,OAAO,CAAC,GAAG;IAFvB,QAAQ,CAAC,IAAI,yBAAwB;gBAEjB,GAAG,EAAE,UAAU;IAEnC;;;OAGG;IACH,KAAK,CACH,MAAM,EAAE,WAAW,EACnB,MAAM,GAAE,kBAA6C,GACpD,kBAAkB;IAwCrB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,gBAAgB,CAAC,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,wBAAwB,GAAG,kBAAkB;IAoD3F,qFAAqF;IACrF,OAAO,CAAC,WAAW;IAsCnB;;;OAGG;IACH,OAAO,CAAC,iBAAiB;IA0CzB,4CAA4C;IAC5C,OAAO,CAAC,SAAS;IAUjB,6EAA6E;IAC7E,OAAO,CAAC,MAAM;IAQd;;;;;;;OAOG;IACH,OAAO,CAAC,gBAAgB;CAqBzB"}
|
package/dist/types.d.ts
DELETED
|
@@ -1,42 +0,0 @@
|
|
|
1
|
-
import type { MaybePromise } from '@forinda/kickjs';
|
|
2
|
-
/** DI token for resolving the Drizzle database instance from the container */
|
|
3
|
-
export declare const DRIZZLE_DB: unique symbol;
|
|
4
|
-
export interface DrizzleAdapterOptions<TDb = unknown> {
|
|
5
|
-
/**
|
|
6
|
-
* Drizzle database instance — the return value of `drizzle()`.
|
|
7
|
-
* Preserves the full type so services can inject it type-safely.
|
|
8
|
-
*
|
|
9
|
-
* @example
|
|
10
|
-
* ```ts
|
|
11
|
-
* import { drizzle } from 'drizzle-orm/better-sqlite3'
|
|
12
|
-
* import * as schema from './schema'
|
|
13
|
-
*
|
|
14
|
-
* const db = drizzle({ client: sqlite, schema })
|
|
15
|
-
* // db is BetterSQLite3Database<typeof schema>
|
|
16
|
-
*
|
|
17
|
-
* new DrizzleAdapter({ db })
|
|
18
|
-
* // TDb is inferred as BetterSQLite3Database<typeof schema>
|
|
19
|
-
* ```
|
|
20
|
-
*/
|
|
21
|
-
db: TDb;
|
|
22
|
-
/** Enable query logging (default: false) */
|
|
23
|
-
logging?: boolean;
|
|
24
|
-
/**
|
|
25
|
-
* Optional shutdown function to close the underlying connection pool.
|
|
26
|
-
* Drizzle doesn't expose a universal disconnect — this lets you pass your
|
|
27
|
-
* driver's cleanup (e.g., `pool.end()` for postgres, `client.close()` for libsql).
|
|
28
|
-
*
|
|
29
|
-
* @example
|
|
30
|
-
* ```ts
|
|
31
|
-
* const pool = new Pool({ connectionString: '...' })
|
|
32
|
-
* const db = drizzle(pool)
|
|
33
|
-
*
|
|
34
|
-
* new DrizzleAdapter({
|
|
35
|
-
* db,
|
|
36
|
-
* onShutdown: () => pool.end(),
|
|
37
|
-
* })
|
|
38
|
-
* ```
|
|
39
|
-
*/
|
|
40
|
-
onShutdown?: () => MaybePromise<any>;
|
|
41
|
-
}
|
|
42
|
-
//# sourceMappingURL=types.d.ts.map
|
package/dist/types.d.ts.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAEnD,8EAA8E;AAC9E,eAAO,MAAM,UAAU,eAAsB,CAAA;AAE7C,MAAM,WAAW,qBAAqB,CAAC,GAAG,GAAG,OAAO;IAClD;;;;;;;;;;;;;;;OAeG;IACH,EAAE,EAAE,GAAG,CAAA;IAEP,4CAA4C;IAC5C,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;;;;;;;;;;;;;;OAeG;IACH,UAAU,CAAC,EAAE,MAAM,YAAY,CAAC,GAAG,CAAC,CAAA;CACrC"}
|