@wild-framework/database-drizzle 0.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/LICENSE +21 -0
- package/README.md +30 -0
- package/dist/drizzle-driver.d.ts +33 -0
- package/dist/drizzle-driver.d.ts.map +1 -0
- package/dist/drizzle-driver.js +40 -0
- package/dist/drizzle-driver.js.map +1 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +3 -0
- package/dist/index.js.map +1 -0
- package/dist/provider.d.ts +23 -0
- package/dist/provider.d.ts.map +1 -0
- package/dist/provider.js +40 -0
- package/dist/provider.js.map +1 -0
- package/package.json +48 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Wild Framework contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# @wild-framework/database-drizzle
|
|
2
|
+
|
|
3
|
+
Drizzle ORM adapter for [Wild Framework](https://github.com/your-org/wild-framework)'s database package.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
pnpm add @wild-framework/database-drizzle
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```ts
|
|
14
|
+
import { Database } from "@wild-framework/database";
|
|
15
|
+
import { DrizzleProvider, DrizzleDriver } from "@wild-framework/database-drizzle";
|
|
16
|
+
|
|
17
|
+
DrizzleProvider.schema = { users };
|
|
18
|
+
DrizzleProvider.filename = "app.db";
|
|
19
|
+
|
|
20
|
+
app.register(ContainerProvider);
|
|
21
|
+
app.register(DrizzleProvider);
|
|
22
|
+
await app.boot();
|
|
23
|
+
|
|
24
|
+
const db = app.resolve(Database);
|
|
25
|
+
const rows = (db.driver as DrizzleDriver).db.select().from(users).all();
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## License
|
|
29
|
+
|
|
30
|
+
MIT
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import type { DatabaseDriver } from "@wild-framework/database";
|
|
2
|
+
import { type BetterSQLite3Database } from "drizzle-orm/better-sqlite3";
|
|
3
|
+
/**
|
|
4
|
+
* Configuration for the Drizzle driver.
|
|
5
|
+
*/
|
|
6
|
+
export interface DrizzleConfig<TSchema extends Record<string, unknown>> {
|
|
7
|
+
/** SQLite file path or `:memory:`. */
|
|
8
|
+
filename: string;
|
|
9
|
+
/** Optional Drizzle schema object (tables). */
|
|
10
|
+
schema?: TSchema;
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* Drizzle ORM driver implementing `DatabaseDriver` from `@wild-framework/database`.
|
|
14
|
+
*
|
|
15
|
+
* Backed by better-sqlite3. The `db` getter returns the typed Drizzle
|
|
16
|
+
* instance for full ORM queries.
|
|
17
|
+
*/
|
|
18
|
+
export declare class DrizzleDriver<TSchema extends Record<string, unknown>> implements DatabaseDriver {
|
|
19
|
+
private config;
|
|
20
|
+
private sqlite;
|
|
21
|
+
private drizzleDb;
|
|
22
|
+
constructor(config: DrizzleConfig<TSchema>);
|
|
23
|
+
connect(): Promise<void>;
|
|
24
|
+
close(): Promise<void>;
|
|
25
|
+
isConnected(): boolean;
|
|
26
|
+
/**
|
|
27
|
+
* The typed Drizzle instance for queries.
|
|
28
|
+
*
|
|
29
|
+
* Throws if the driver is not connected.
|
|
30
|
+
*/
|
|
31
|
+
get db(): BetterSQLite3Database<TSchema>;
|
|
32
|
+
}
|
|
33
|
+
//# sourceMappingURL=drizzle-driver.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"drizzle-driver.d.ts","sourceRoot":"","sources":["../src/drizzle-driver.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAW,KAAK,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAGjF;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAClE,sCAAsC;IACtC,QAAQ,EAAE,MAAM,CAAC;IACjB,+CAA+C;IAC/C,MAAM,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;;;GAKG;AACH,qBAAa,aAAa,CAAC,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAE,YAAW,cAAc;IAI7E,OAAO,CAAC,MAAM;IAH1B,OAAO,CAAC,MAAM,CAAkC;IAChD,OAAO,CAAC,SAAS,CAA+C;gBAE5C,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC;IAE5C,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAKxB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAM5B,WAAW,IAAI,OAAO;IAItB;;;;OAIG;IACH,IAAI,EAAE,IAAI,qBAAqB,CAAC,OAAO,CAAC,CAKvC;CACJ"}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import { drizzle } from "drizzle-orm/better-sqlite3";
|
|
2
|
+
import Database from "better-sqlite3";
|
|
3
|
+
/**
|
|
4
|
+
* Drizzle ORM driver implementing `DatabaseDriver` from `@wild-framework/database`.
|
|
5
|
+
*
|
|
6
|
+
* Backed by better-sqlite3. The `db` getter returns the typed Drizzle
|
|
7
|
+
* instance for full ORM queries.
|
|
8
|
+
*/
|
|
9
|
+
export class DrizzleDriver {
|
|
10
|
+
config;
|
|
11
|
+
sqlite = null;
|
|
12
|
+
drizzleDb = null;
|
|
13
|
+
constructor(config) {
|
|
14
|
+
this.config = config;
|
|
15
|
+
}
|
|
16
|
+
async connect() {
|
|
17
|
+
this.sqlite = new Database(this.config.filename);
|
|
18
|
+
this.drizzleDb = drizzle(this.sqlite, { schema: this.config.schema });
|
|
19
|
+
}
|
|
20
|
+
async close() {
|
|
21
|
+
this.sqlite?.close();
|
|
22
|
+
this.sqlite = null;
|
|
23
|
+
this.drizzleDb = null;
|
|
24
|
+
}
|
|
25
|
+
isConnected() {
|
|
26
|
+
return this.drizzleDb !== null;
|
|
27
|
+
}
|
|
28
|
+
/**
|
|
29
|
+
* The typed Drizzle instance for queries.
|
|
30
|
+
*
|
|
31
|
+
* Throws if the driver is not connected.
|
|
32
|
+
*/
|
|
33
|
+
get db() {
|
|
34
|
+
if (!this.drizzleDb) {
|
|
35
|
+
throw new Error("Database is not connected. Call connect() first.");
|
|
36
|
+
}
|
|
37
|
+
return this.drizzleDb;
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
//# sourceMappingURL=drizzle-driver.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"drizzle-driver.js","sourceRoot":"","sources":["../src/drizzle-driver.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAA8B,MAAM,4BAA4B,CAAC;AACjF,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AAYtC;;;;;GAKG;AACH,MAAM,OAAO,aAAa;IAIF;IAHZ,MAAM,GAA6B,IAAI,CAAC;IACxC,SAAS,GAA0C,IAAI,CAAC;IAEhE,YAAoB,MAA8B;QAA9B,WAAM,GAAN,MAAM,CAAwB;IAAG,CAAC;IAEtD,KAAK,CAAC,OAAO;QACT,IAAI,CAAC,MAAM,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACjD,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED,KAAK,CAAC,KAAK;QACP,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACnB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;IAC1B,CAAC;IAED,WAAW;QACP,OAAO,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACH,IAAI,EAAE;QACF,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;QACxE,CAAC;QACD,OAAO,IAAI,CAAC,SAAS,CAAC;IAC1B,CAAC;CACJ"}
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,YAAY,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC"}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC"}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import type { Provider, Application } from "@wild-framework/core";
|
|
2
|
+
/**
|
|
3
|
+
* Registers a Drizzle-backed database with the application.
|
|
4
|
+
*
|
|
5
|
+
* Static configuration (no-arg constructor requirement):
|
|
6
|
+
*
|
|
7
|
+
* ```ts
|
|
8
|
+
* DrizzleProvider.schema = { users };
|
|
9
|
+
* DrizzleProvider.filename = "app.db";
|
|
10
|
+
* ```
|
|
11
|
+
*
|
|
12
|
+
* Connects on boot, closes on shutdown.
|
|
13
|
+
*/
|
|
14
|
+
export declare class DrizzleProvider implements Provider {
|
|
15
|
+
/** Drizzle schema object (tables). */
|
|
16
|
+
static schema: Record<string, unknown> | undefined;
|
|
17
|
+
/** SQLite file path. Defaults to in-memory. */
|
|
18
|
+
static filename: string;
|
|
19
|
+
register(app: Application): void;
|
|
20
|
+
boot(app: Application): Promise<void>;
|
|
21
|
+
shutdown(app: Application): Promise<void>;
|
|
22
|
+
}
|
|
23
|
+
//# sourceMappingURL=provider.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAKlE;;;;;;;;;;;GAWG;AACH,qBAAa,eAAgB,YAAW,QAAQ;IAC5C,sCAAsC;IACtC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;IACnD,+CAA+C;IAC/C,MAAM,CAAC,QAAQ,SAAc;IAE7B,QAAQ,CAAC,GAAG,EAAE,WAAW,GAAG,IAAI;IAc1B,IAAI,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAKrC,QAAQ,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;CAIlD"}
|
package/dist/provider.js
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import { Container } from "@wild-framework/container";
|
|
2
|
+
import { Database } from "@wild-framework/database";
|
|
3
|
+
import { DrizzleDriver } from "./drizzle-driver.js";
|
|
4
|
+
/**
|
|
5
|
+
* Registers a Drizzle-backed database with the application.
|
|
6
|
+
*
|
|
7
|
+
* Static configuration (no-arg constructor requirement):
|
|
8
|
+
*
|
|
9
|
+
* ```ts
|
|
10
|
+
* DrizzleProvider.schema = { users };
|
|
11
|
+
* DrizzleProvider.filename = "app.db";
|
|
12
|
+
* ```
|
|
13
|
+
*
|
|
14
|
+
* Connects on boot, closes on shutdown.
|
|
15
|
+
*/
|
|
16
|
+
export class DrizzleProvider {
|
|
17
|
+
/** Drizzle schema object (tables). */
|
|
18
|
+
static schema;
|
|
19
|
+
/** SQLite file path. Defaults to in-memory. */
|
|
20
|
+
static filename = ":memory:";
|
|
21
|
+
register(app) {
|
|
22
|
+
const container = app.resolve(Container);
|
|
23
|
+
const config = {
|
|
24
|
+
filename: DrizzleProvider.filename,
|
|
25
|
+
schema: DrizzleProvider.schema,
|
|
26
|
+
};
|
|
27
|
+
const driver = new DrizzleDriver(config);
|
|
28
|
+
const database = new Database(driver);
|
|
29
|
+
container.singleton(Database, () => database);
|
|
30
|
+
}
|
|
31
|
+
async boot(app) {
|
|
32
|
+
const database = app.resolve(Database);
|
|
33
|
+
await database.connect();
|
|
34
|
+
}
|
|
35
|
+
async shutdown(app) {
|
|
36
|
+
const database = app.resolve(Database);
|
|
37
|
+
await database.close();
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
//# sourceMappingURL=provider.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"provider.js","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AACpD,OAAO,EAAE,aAAa,EAAsB,MAAM,qBAAqB,CAAC;AAExE;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,eAAe;IACxB,sCAAsC;IACtC,MAAM,CAAC,MAAM,CAAsC;IACnD,+CAA+C;IAC/C,MAAM,CAAC,QAAQ,GAAG,UAAU,CAAC;IAE7B,QAAQ,CAAC,GAAgB;QACrB,MAAM,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAEzC,MAAM,MAAM,GAA2C;YACnD,QAAQ,EAAE,eAAe,CAAC,QAAQ;YAClC,MAAM,EAAE,eAAe,CAAC,MAAM;SACjC,CAAC;QAEF,MAAM,MAAM,GAAG,IAAI,aAAa,CAAC,MAAM,CAAC,CAAC;QACzC,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC;QAEtC,SAAS,CAAC,SAAS,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,CAAC;IAClD,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,GAAgB;QACvB,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAW,QAAQ,CAAC,CAAC;QACjD,MAAM,QAAQ,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,GAAgB;QAC3B,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAW,QAAQ,CAAC,CAAC;QACjD,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAC3B,CAAC"}
|
package/package.json
ADDED
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@wild-framework/database-drizzle",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"type": "module",
|
|
5
|
+
"main": "./dist/index.js",
|
|
6
|
+
"types": "./dist/index.d.ts",
|
|
7
|
+
"exports": {
|
|
8
|
+
".": {
|
|
9
|
+
"types": "./dist/index.d.ts",
|
|
10
|
+
"import": "./dist/index.js"
|
|
11
|
+
}
|
|
12
|
+
},
|
|
13
|
+
"files": [
|
|
14
|
+
"dist"
|
|
15
|
+
],
|
|
16
|
+
"publishConfig": {
|
|
17
|
+
"access": "public"
|
|
18
|
+
},
|
|
19
|
+
"license": "MIT",
|
|
20
|
+
"author": "Sphah",
|
|
21
|
+
"repository": {
|
|
22
|
+
"type": "git",
|
|
23
|
+
"url": "git+https://github.com/KhandaSoftware/wild-framework.git"
|
|
24
|
+
},
|
|
25
|
+
"description": "Drizzle ORM adapter for Wild Framework's database package.",
|
|
26
|
+
"keywords": [
|
|
27
|
+
"wild",
|
|
28
|
+
"framework",
|
|
29
|
+
"drizzle",
|
|
30
|
+
"orm",
|
|
31
|
+
"sqlite"
|
|
32
|
+
],
|
|
33
|
+
"dependencies": {
|
|
34
|
+
"drizzle-orm": "^0.38.0",
|
|
35
|
+
"better-sqlite3": "^11.0.0",
|
|
36
|
+
"@wild-framework/container": "0.1.0",
|
|
37
|
+
"@wild-framework/database": "0.1.0",
|
|
38
|
+
"@wild-framework/core": "0.1.0"
|
|
39
|
+
},
|
|
40
|
+
"devDependencies": {
|
|
41
|
+
"@types/better-sqlite3": "^7.6.0"
|
|
42
|
+
},
|
|
43
|
+
"scripts": {
|
|
44
|
+
"build": "tsc",
|
|
45
|
+
"clean": "rm -rf dist",
|
|
46
|
+
"test": "vitest run"
|
|
47
|
+
}
|
|
48
|
+
}
|