@iamkirbki/database-handler-core 3.1.4 → 4.0.1
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/abstract/Model.d.ts +42 -16
- package/dist/abstract/Model.d.ts.map +1 -1
- package/dist/abstract/Model.js +159 -32
- package/dist/abstract/{Schema.d.ts → SchemaTableBuilder.d.ts} +3 -8
- package/dist/abstract/SchemaTableBuilder.d.ts.map +1 -0
- package/dist/abstract/{Schema.js → SchemaTableBuilder.js} +1 -3
- package/dist/base/Database.d.ts +13 -0
- package/dist/base/Database.d.ts.map +1 -0
- package/dist/base/Database.js +27 -0
- package/dist/base/Query.d.ts +43 -0
- package/dist/base/Query.d.ts.map +1 -0
- package/dist/base/Query.js +87 -0
- package/dist/base/Record.d.ts +23 -0
- package/dist/base/Record.d.ts.map +1 -0
- package/dist/base/Record.js +72 -0
- package/dist/base/Table.d.ts +27 -0
- package/dist/base/Table.d.ts.map +1 -0
- package/dist/base/Table.js +128 -0
- package/dist/helpers/QueryStatementBuilder.d.ts +4 -35
- package/dist/helpers/QueryStatementBuilder.d.ts.map +1 -1
- package/dist/helpers/QueryStatementBuilder.js +6 -37
- package/dist/index.d.ts +13 -9
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +8 -8
- package/dist/interfaces/IController.d.ts +8 -0
- package/dist/interfaces/IController.d.ts.map +1 -0
- package/dist/interfaces/IController.js +1 -0
- package/dist/interfaces/IDatabaseAdapter.d.ts.map +1 -1
- package/dist/interfaces/IMigration.d.ts +6 -0
- package/dist/interfaces/IMigration.d.ts.map +1 -0
- package/dist/interfaces/IMigration.js +1 -0
- package/dist/interfaces/ISchemaBuilder.d.ts +7 -0
- package/dist/interfaces/ISchemaBuilder.d.ts.map +1 -0
- package/dist/interfaces/ISchemaBuilder.js +1 -0
- package/dist/runtime/Container.d.ts +12 -0
- package/dist/runtime/Container.d.ts.map +1 -0
- package/dist/runtime/Container.js +29 -0
- package/dist/runtime/Repository.d.ts +18 -0
- package/dist/runtime/Repository.d.ts.map +1 -0
- package/dist/runtime/Repository.js +110 -0
- package/dist/types/index.d.ts +1 -4
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/index.js +1 -0
- package/dist/types/model.d.ts +71 -0
- package/dist/types/model.d.ts.map +1 -0
- package/dist/types/model.js +2 -0
- package/dist/types/table.d.ts +6 -2
- package/dist/types/table.d.ts.map +1 -1
- package/package.json +5 -4
- package/dist/Database.d.ts +0 -98
- package/dist/Database.d.ts.map +0 -1
- package/dist/Database.js +0 -126
- package/dist/Query.d.ts +0 -143
- package/dist/Query.d.ts.map +0 -1
- package/dist/Query.js +0 -205
- package/dist/Record.d.ts +0 -125
- package/dist/Record.d.ts.map +0 -1
- package/dist/Record.js +0 -174
- package/dist/Table.d.ts +0 -158
- package/dist/Table.d.ts.map +0 -1
- package/dist/Table.js +0 -258
- package/dist/abstract/Controller.d.ts +0 -13
- package/dist/abstract/Controller.d.ts.map +0 -1
- package/dist/abstract/Controller.js +0 -6
- package/dist/abstract/Migration.d.ts +0 -6
- package/dist/abstract/Migration.d.ts.map +0 -1
- package/dist/abstract/Migration.js +0 -2
- package/dist/abstract/Schema.d.ts.map +0 -1
- package/dist/abstract/User.d.ts +0 -8
- package/dist/abstract/User.d.ts.map +0 -1
- package/dist/abstract/User.js +0 -6
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
/** Model configuration and types */
|
|
2
|
+
import Model from "../abstract/Model";
|
|
3
|
+
import { columnType } from "./index";
|
|
4
|
+
export type ModelEventType = 'retrieved' | 'creating' | 'created' | 'updating' | 'updated' | 'saving' | 'saved' | 'deleting' | 'deleted' | 'restoring' | 'restored' | 'forceDeleting' | 'forceDeleted';
|
|
5
|
+
export type ModelEventHandler<T> = (model: T) => void | Promise<void>;
|
|
6
|
+
export interface ModelObserver<T> {
|
|
7
|
+
retrieved?(model: T): void | Promise<void>;
|
|
8
|
+
creating?(model: T): void | Promise<void>;
|
|
9
|
+
created?(model: T): void | Promise<void>;
|
|
10
|
+
updating?(model: T): void | Promise<void>;
|
|
11
|
+
updated?(model: T): void | Promise<void>;
|
|
12
|
+
saving?(model: T): void | Promise<void>;
|
|
13
|
+
saved?(model: T): void | Promise<void>;
|
|
14
|
+
deleting?(model: T): void | Promise<void>;
|
|
15
|
+
deleted?(model: T): void | Promise<void>;
|
|
16
|
+
restoring?(model: T): void | Promise<void>;
|
|
17
|
+
restored?(model: T): void | Promise<void>;
|
|
18
|
+
forceDeleting?(model: T): void | Promise<void>;
|
|
19
|
+
forceDeleted?(model: T): void | Promise<void>;
|
|
20
|
+
}
|
|
21
|
+
export interface ModelScope {
|
|
22
|
+
(query: any): void;
|
|
23
|
+
}
|
|
24
|
+
export interface ModelConfig {
|
|
25
|
+
/** Table name - defaults to lowercase class name */
|
|
26
|
+
table: string;
|
|
27
|
+
/** Primary key column - defaults to 'id' */
|
|
28
|
+
primaryKey: string;
|
|
29
|
+
/** Whether to auto-increment primary key - defaults to true */
|
|
30
|
+
incrementing?: boolean;
|
|
31
|
+
/** Primary key type - defaults to 'number' */
|
|
32
|
+
keyType?: 'string' | 'number';
|
|
33
|
+
/** Enable automatic timestamp management - defaults to true */
|
|
34
|
+
timestamps?: boolean;
|
|
35
|
+
/** Created at column name - defaults to 'created_at' */
|
|
36
|
+
createdAtColumn?: string;
|
|
37
|
+
/** Updated at column name - defaults to 'updated_at' */
|
|
38
|
+
updatedAtColumn?: string;
|
|
39
|
+
/** Deleted at column name for soft deletes - defaults to 'deleted_at' */
|
|
40
|
+
deletedAtColumn?: string;
|
|
41
|
+
/** Database connection name */
|
|
42
|
+
connection?: string;
|
|
43
|
+
/** Mass assignable attributes (whitelist) */
|
|
44
|
+
fillable?: string[];
|
|
45
|
+
/** Guarded attributes (blacklist) - defaults to ['*'] if fillable is empty */
|
|
46
|
+
guarded?: string[];
|
|
47
|
+
/** Hidden attributes when serializing */
|
|
48
|
+
hidden?: string[];
|
|
49
|
+
/** Visible attributes when serializing (overrides hidden) */
|
|
50
|
+
visible?: string[];
|
|
51
|
+
/** Append computed attributes when serializing */
|
|
52
|
+
appends?: string[];
|
|
53
|
+
/** Default attribute values */
|
|
54
|
+
attributes?: Record<string, any>;
|
|
55
|
+
/** Date format for serialization */
|
|
56
|
+
dateFormat?: string;
|
|
57
|
+
}
|
|
58
|
+
export type relation = {
|
|
59
|
+
type: 'hasOne' | 'hasMany' | 'belongsTo';
|
|
60
|
+
model: unknown & Model<columnType>;
|
|
61
|
+
foreignKey: string;
|
|
62
|
+
localKey?: string;
|
|
63
|
+
};
|
|
64
|
+
export interface SoftDeletable {
|
|
65
|
+
deleted_at?: string | Date | null;
|
|
66
|
+
}
|
|
67
|
+
export type ModelWithTimestamps = {
|
|
68
|
+
created_at?: string;
|
|
69
|
+
updated_at?: string;
|
|
70
|
+
};
|
|
71
|
+
//# sourceMappingURL=model.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../../src/types/model.ts"],"names":[],"mappings":"AAAA,oCAAoC;AAEpC,OAAO,KAAK,MAAM,sBAAsB,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAErC,MAAM,MAAM,cAAc,GACpB,WAAW,GACX,UAAU,GACV,SAAS,GACT,UAAU,GACV,SAAS,GACT,QAAQ,GACR,OAAO,GACP,UAAU,GACV,SAAS,GACT,WAAW,GACX,UAAU,GACV,eAAe,GACf,cAAc,CAAC;AAErB,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAEtE,MAAM,WAAW,aAAa,CAAC,CAAC;IAC5B,SAAS,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3C,QAAQ,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1C,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzC,QAAQ,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1C,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzC,MAAM,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxC,KAAK,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACvC,QAAQ,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1C,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzC,SAAS,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3C,QAAQ,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1C,aAAa,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/C,YAAY,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACjD;AAED,MAAM,WAAW,UAAU;IACvB,CAAC,KAAK,EAAE,GAAG,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,WAAW;IACxB,oDAAoD;IACpD,KAAK,EAAE,MAAM,CAAC;IAEd,4CAA4C;IAC5C,UAAU,EAAE,MAAM,CAAC;IAEnB,+DAA+D;IAC/D,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB,8CAA8C;IAC9C,OAAO,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAE9B,+DAA+D;IAC/D,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,wDAAwD;IACxD,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,wDAAwD;IACxD,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,yEAAyE;IACzE,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,+BAA+B;IAC/B,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,6CAA6C;IAC7C,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpB,8EAA8E;IAC9E,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnB,yCAAyC;IACzC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB,6DAA6D;IAC7D,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnB,kDAAkD;IAClD,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnB,+BAA+B;IAC/B,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAEjC,oCAAoC;IACpC,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,MAAM,QAAQ,GAAG;IACnB,IAAI,EAAE,QAAQ,GAAG,SAAS,GAAG,WAAW,CAAC;IACzC,KAAK,EAAE,OAAO,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB,CAAA;AAED,MAAM,WAAW,aAAa;IAC1B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAC;CACrC;AAED,MAAM,MAAM,mBAAmB,GAAG;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB,CAAA"}
|
package/dist/types/table.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { QueryWhereParameters } from "index";
|
|
2
|
-
import Table from "../Table.js";
|
|
1
|
+
import { QueryValues, QueryWhereParameters } from "../index";
|
|
2
|
+
import Table from "../base/Table.js";
|
|
3
3
|
export type TableColumnInfo = {
|
|
4
4
|
cid: number;
|
|
5
5
|
name: string;
|
|
@@ -8,6 +8,9 @@ export type TableColumnInfo = {
|
|
|
8
8
|
dflt_value: unknown;
|
|
9
9
|
pk: number;
|
|
10
10
|
};
|
|
11
|
+
export type columnType = {
|
|
12
|
+
[key: string]: QueryValues;
|
|
13
|
+
};
|
|
11
14
|
export type ReadableTableColumnInfo = {
|
|
12
15
|
name: string;
|
|
13
16
|
type: string;
|
|
@@ -25,5 +28,6 @@ export type Join = {
|
|
|
25
28
|
fromTable: Table;
|
|
26
29
|
joinType: 'INNER' | 'LEFT' | 'RIGHT' | 'FULL';
|
|
27
30
|
on: QueryWhereParameters | QueryWhereParameters[];
|
|
31
|
+
where?: QueryWhereParameters | QueryWhereParameters[];
|
|
28
32
|
};
|
|
29
33
|
//# sourceMappingURL=table.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"table.d.ts","sourceRoot":"","sources":["../../src/types/table.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,OAAO,CAAC;
|
|
1
|
+
{"version":3,"file":"table.d.ts","sourceRoot":"","sources":["../../src/types/table.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,oBAAoB,EAAE,MAAM,OAAO,CAAC;AAC1D,OAAO,KAAK,MAAM,kBAAkB,CAAC;AAErC,MAAM,MAAM,eAAe,GAAG;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,OAAO,CAAC;IACpB,EAAE,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAAA;CAAE,CAAC;AAExD,MAAM,MAAM,uBAAuB,GAAG;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC;IAClB,YAAY,EAAE,OAAO,CAAC;IACtB,YAAY,EAAE,OAAO,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,aAAa,CAAC,EAAE,OAAO,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,IAAI,GAAG;IACf,SAAS,EAAE,KAAK,CAAC;IACjB,QAAQ,EAAE,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;IAC9C,EAAE,EAAE,oBAAoB,GAAG,oBAAoB,EAAE,CAAC;IAClD,KAAK,CAAC,EAAE,oBAAoB,GAAG,oBAAoB,EAAE,CAAC;CACzD,CAAA"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@iamkirbki/database-handler-core",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "4.0.1",
|
|
4
4
|
"author": "iamkirbki",
|
|
5
5
|
"description": "Core database abstractions and interfaces",
|
|
6
6
|
"license": "ISC",
|
|
@@ -19,13 +19,14 @@
|
|
|
19
19
|
],
|
|
20
20
|
"repository": {
|
|
21
21
|
"type": "git",
|
|
22
|
-
"url": "https://github.com/IamKirbki/
|
|
22
|
+
"url": "https://github.com/IamKirbki/npm-database-handler.git",
|
|
23
23
|
"directory": "packages/core"
|
|
24
24
|
},
|
|
25
25
|
"scripts": {
|
|
26
|
-
"build": "tsc"
|
|
26
|
+
"build": "tsc --build && tsc-alias"
|
|
27
27
|
},
|
|
28
28
|
"devDependencies": {
|
|
29
|
-
"typescript": "^5.9.3"
|
|
29
|
+
"typescript": "^5.9.3",
|
|
30
|
+
"tsc-alias": "^1.8.16"
|
|
30
31
|
}
|
|
31
32
|
}
|
package/dist/Database.d.ts
DELETED
|
@@ -1,98 +0,0 @@
|
|
|
1
|
-
import Table from "./Table.js";
|
|
2
|
-
import Query from "./Query.js";
|
|
3
|
-
import IDatabaseAdapter from "./interfaces/IDatabaseAdapter.js";
|
|
4
|
-
/**
|
|
5
|
-
* Main Database class for interacting with SQLite databases
|
|
6
|
-
*
|
|
7
|
-
* @example
|
|
8
|
-
* ```typescript
|
|
9
|
-
* import { Database } from 'kirbkis-bettersqlite3-handler';
|
|
10
|
-
*
|
|
11
|
-
* // Create or open a database
|
|
12
|
-
* const db = new Database('./myapp.db');
|
|
13
|
-
*
|
|
14
|
-
* // Access a table
|
|
15
|
-
* const users = db.Table('users');
|
|
16
|
-
*
|
|
17
|
-
* // Create a new table
|
|
18
|
-
* const posts = db.CreateTable('posts');
|
|
19
|
-
* ```
|
|
20
|
-
*/
|
|
21
|
-
export default class Database {
|
|
22
|
-
adapter: IDatabaseAdapter;
|
|
23
|
-
/**
|
|
24
|
-
* Creates a new Database instance
|
|
25
|
-
*
|
|
26
|
-
* @param dbPath - Path to the SQLite database file (absolute or relative to process.cwd())
|
|
27
|
-
*
|
|
28
|
-
* @example
|
|
29
|
-
* ```typescript
|
|
30
|
-
* // Relative path
|
|
31
|
-
* const db = new Database('./data/app.db');
|
|
32
|
-
*
|
|
33
|
-
* // Absolute path
|
|
34
|
-
* const db = new Database('/var/data/app.db');
|
|
35
|
-
*
|
|
36
|
-
* // In-memory database
|
|
37
|
-
* const db = new Database(':memory:');
|
|
38
|
-
* ```
|
|
39
|
-
*/
|
|
40
|
-
constructor(adapter: IDatabaseAdapter);
|
|
41
|
-
/**
|
|
42
|
-
* Get a Table instance to interact with an existing table
|
|
43
|
-
*
|
|
44
|
-
* @param name - Name of the table
|
|
45
|
-
* @returns Table instance for querying and manipulating data
|
|
46
|
-
* @throws Error if the table does not exist
|
|
47
|
-
*
|
|
48
|
-
* @example
|
|
49
|
-
* ```typescript
|
|
50
|
-
* const users = await db.Table('users');
|
|
51
|
-
* const allUsers = await users.Records();
|
|
52
|
-
* ```
|
|
53
|
-
*/
|
|
54
|
-
Table(name: string): Promise<Table>;
|
|
55
|
-
/**
|
|
56
|
-
* Create a new table with specified columns
|
|
57
|
-
* Validates table name, column names, and column types before creation
|
|
58
|
-
* Uses CREATE TABLE IF NOT EXISTS to avoid errors if table already exists
|
|
59
|
-
*
|
|
60
|
-
* @param name - Name of the table to create
|
|
61
|
-
* @param columns - Object mapping column names to their type definitions
|
|
62
|
-
* @returns Table instance for the newly created table
|
|
63
|
-
* @throws Error if table name, column names, or column types are invalid
|
|
64
|
-
*
|
|
65
|
-
* @example
|
|
66
|
-
* ```typescript
|
|
67
|
-
* // Create a users table
|
|
68
|
-
* const users = await db.CreateTable('users', {
|
|
69
|
-
* id: 'INTEGER PRIMARY KEY AUTOINCREMENT',
|
|
70
|
-
* name: 'TEXT NOT NULL',
|
|
71
|
-
* email: 'TEXT UNIQUE',
|
|
72
|
-
* age: 'INTEGER',
|
|
73
|
-
* created_at: 'DATETIME DEFAULT CURRENT_TIMESTAMP'
|
|
74
|
-
* });
|
|
75
|
-
*
|
|
76
|
-
* // Table is now ready to use
|
|
77
|
-
* await users.Insert({ name: 'John', email: 'john@example.com', age: 30 });
|
|
78
|
-
* ```
|
|
79
|
-
*/
|
|
80
|
-
CreateTable(name: string, columns: object): Promise<Table>;
|
|
81
|
-
/**
|
|
82
|
-
* Create a Query object for executing custom SQL queries
|
|
83
|
-
*
|
|
84
|
-
* @param table - Table object for validation and context
|
|
85
|
-
* @param query - The SQL query string with ? placeholders
|
|
86
|
-
* @returns Query instance for executing the query
|
|
87
|
-
*
|
|
88
|
-
* @example
|
|
89
|
-
* ```typescript
|
|
90
|
-
* const users = db.Table('users');
|
|
91
|
-
* const query = db.Query(users, 'SELECT * FROM users WHERE age > ? AND status = ?');
|
|
92
|
-
* query.Parameters = { age: 18, status: 'active' };
|
|
93
|
-
* const results = query.All();
|
|
94
|
-
* ```
|
|
95
|
-
*/
|
|
96
|
-
Query(table: Table, query: string): Query;
|
|
97
|
-
}
|
|
98
|
-
//# sourceMappingURL=Database.d.ts.map
|
package/dist/Database.d.ts.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"Database.d.ts","sourceRoot":"","sources":["../src/Database.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,YAAY,CAAC;AAC/B,OAAO,KAAK,MAAM,YAAY,CAAC;AAC/B,OAAO,gBAAgB,MAAM,kCAAkC,CAAC;AAEhE;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,OAAO,OAAO,QAAQ;IACpB,OAAO,EAAE,gBAAgB,CAAC;IAEjC;;;;;;;;;;;;;;;;OAgBG;gBACS,OAAO,EAAE,gBAAgB;IAIrC;;;;;;;;;;;;OAYG;IACU,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAKhD;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACU,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAmBvE;;;;;;;;;;;;;;OAcG;IACI,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,GAAG,KAAK;CAGjD"}
|
package/dist/Database.js
DELETED
|
@@ -1,126 +0,0 @@
|
|
|
1
|
-
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
2
|
-
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
3
|
-
return new (P || (P = Promise))(function (resolve, reject) {
|
|
4
|
-
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
5
|
-
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
6
|
-
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
7
|
-
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
8
|
-
});
|
|
9
|
-
};
|
|
10
|
-
import Table from "./Table.js";
|
|
11
|
-
import Query from "./Query.js";
|
|
12
|
-
/**
|
|
13
|
-
* Main Database class for interacting with SQLite databases
|
|
14
|
-
*
|
|
15
|
-
* @example
|
|
16
|
-
* ```typescript
|
|
17
|
-
* import { Database } from 'kirbkis-bettersqlite3-handler';
|
|
18
|
-
*
|
|
19
|
-
* // Create or open a database
|
|
20
|
-
* const db = new Database('./myapp.db');
|
|
21
|
-
*
|
|
22
|
-
* // Access a table
|
|
23
|
-
* const users = db.Table('users');
|
|
24
|
-
*
|
|
25
|
-
* // Create a new table
|
|
26
|
-
* const posts = db.CreateTable('posts');
|
|
27
|
-
* ```
|
|
28
|
-
*/
|
|
29
|
-
export default class Database {
|
|
30
|
-
/**
|
|
31
|
-
* Creates a new Database instance
|
|
32
|
-
*
|
|
33
|
-
* @param dbPath - Path to the SQLite database file (absolute or relative to process.cwd())
|
|
34
|
-
*
|
|
35
|
-
* @example
|
|
36
|
-
* ```typescript
|
|
37
|
-
* // Relative path
|
|
38
|
-
* const db = new Database('./data/app.db');
|
|
39
|
-
*
|
|
40
|
-
* // Absolute path
|
|
41
|
-
* const db = new Database('/var/data/app.db');
|
|
42
|
-
*
|
|
43
|
-
* // In-memory database
|
|
44
|
-
* const db = new Database(':memory:');
|
|
45
|
-
* ```
|
|
46
|
-
*/
|
|
47
|
-
constructor(adapter) {
|
|
48
|
-
this.adapter = adapter;
|
|
49
|
-
}
|
|
50
|
-
/**
|
|
51
|
-
* Get a Table instance to interact with an existing table
|
|
52
|
-
*
|
|
53
|
-
* @param name - Name of the table
|
|
54
|
-
* @returns Table instance for querying and manipulating data
|
|
55
|
-
* @throws Error if the table does not exist
|
|
56
|
-
*
|
|
57
|
-
* @example
|
|
58
|
-
* ```typescript
|
|
59
|
-
* const users = await db.Table('users');
|
|
60
|
-
* const allUsers = await users.Records();
|
|
61
|
-
* ```
|
|
62
|
-
*/
|
|
63
|
-
Table(name) {
|
|
64
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
65
|
-
return yield Table.create(name, this.adapter);
|
|
66
|
-
});
|
|
67
|
-
}
|
|
68
|
-
// TODO Make primary key required
|
|
69
|
-
/**
|
|
70
|
-
* Create a new table with specified columns
|
|
71
|
-
* Validates table name, column names, and column types before creation
|
|
72
|
-
* Uses CREATE TABLE IF NOT EXISTS to avoid errors if table already exists
|
|
73
|
-
*
|
|
74
|
-
* @param name - Name of the table to create
|
|
75
|
-
* @param columns - Object mapping column names to their type definitions
|
|
76
|
-
* @returns Table instance for the newly created table
|
|
77
|
-
* @throws Error if table name, column names, or column types are invalid
|
|
78
|
-
*
|
|
79
|
-
* @example
|
|
80
|
-
* ```typescript
|
|
81
|
-
* // Create a users table
|
|
82
|
-
* const users = await db.CreateTable('users', {
|
|
83
|
-
* id: 'INTEGER PRIMARY KEY AUTOINCREMENT',
|
|
84
|
-
* name: 'TEXT NOT NULL',
|
|
85
|
-
* email: 'TEXT UNIQUE',
|
|
86
|
-
* age: 'INTEGER',
|
|
87
|
-
* created_at: 'DATETIME DEFAULT CURRENT_TIMESTAMP'
|
|
88
|
-
* });
|
|
89
|
-
*
|
|
90
|
-
* // Table is now ready to use
|
|
91
|
-
* await users.Insert({ name: 'John', email: 'john@example.com', age: 30 });
|
|
92
|
-
* ```
|
|
93
|
-
*/
|
|
94
|
-
CreateTable(name, columns) {
|
|
95
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
96
|
-
const names = Object.keys(columns || {}).map((colName) => {
|
|
97
|
-
return colName;
|
|
98
|
-
});
|
|
99
|
-
const colsDef = names.map(colName => {
|
|
100
|
-
const colType = columns[colName];
|
|
101
|
-
return `"${colName}" ${colType}`;
|
|
102
|
-
}).join(", ");
|
|
103
|
-
const stmt = yield this.adapter.prepare(`CREATE TABLE IF NOT EXISTS "${name}" (${colsDef});`);
|
|
104
|
-
yield stmt.run();
|
|
105
|
-
return yield Table.create(name, this.adapter, true);
|
|
106
|
-
});
|
|
107
|
-
}
|
|
108
|
-
/**
|
|
109
|
-
* Create a Query object for executing custom SQL queries
|
|
110
|
-
*
|
|
111
|
-
* @param table - Table object for validation and context
|
|
112
|
-
* @param query - The SQL query string with ? placeholders
|
|
113
|
-
* @returns Query instance for executing the query
|
|
114
|
-
*
|
|
115
|
-
* @example
|
|
116
|
-
* ```typescript
|
|
117
|
-
* const users = db.Table('users');
|
|
118
|
-
* const query = db.Query(users, 'SELECT * FROM users WHERE age > ? AND status = ?');
|
|
119
|
-
* query.Parameters = { age: 18, status: 'active' };
|
|
120
|
-
* const results = query.All();
|
|
121
|
-
* ```
|
|
122
|
-
*/
|
|
123
|
-
Query(table, query) {
|
|
124
|
-
return new Query(table, query, this.adapter);
|
|
125
|
-
}
|
|
126
|
-
}
|
package/dist/Query.d.ts
DELETED
|
@@ -1,143 +0,0 @@
|
|
|
1
|
-
import Table from "./Table.js";
|
|
2
|
-
import { QueryCondition } from "./types/index.js";
|
|
3
|
-
import Record from "./Record.js";
|
|
4
|
-
import IDatabaseAdapter from "./interfaces/IDatabaseAdapter.js";
|
|
5
|
-
/**
|
|
6
|
-
* Query class for executing custom SQL queries
|
|
7
|
-
*
|
|
8
|
-
* Features:
|
|
9
|
-
* - Supports named parameters using @fieldName syntax
|
|
10
|
-
* - Provides type-safe query execution (Run, All, Get)
|
|
11
|
-
* - Transaction support for atomic multi-insert/update operations
|
|
12
|
-
*
|
|
13
|
-
* @example
|
|
14
|
-
* ```typescript
|
|
15
|
-
* const users = db.Table('users');
|
|
16
|
-
*
|
|
17
|
-
* // SELECT query with parameters
|
|
18
|
-
* const query = db.Query(users, 'SELECT * FROM users WHERE age > @age AND status = @status');
|
|
19
|
-
* query.Parameters = { age: 18, status: 'active' };
|
|
20
|
-
* const results = query.All();
|
|
21
|
-
*
|
|
22
|
-
* // INSERT query
|
|
23
|
-
* const insert = db.Query(users, 'INSERT INTO users (name, email) VALUES (@name, @email)');
|
|
24
|
-
* insert.Parameters = { name: 'John', email: 'john@example.com' };
|
|
25
|
-
* insert.Run();
|
|
26
|
-
*
|
|
27
|
-
* // Transaction for multiple inserts
|
|
28
|
-
* insert.Transaction([
|
|
29
|
-
* { name: 'John', email: 'john@example.com' },
|
|
30
|
-
* { name: 'Jane', email: 'jane@example.com' }
|
|
31
|
-
* ]);
|
|
32
|
-
* ```
|
|
33
|
-
*/
|
|
34
|
-
export default class Query {
|
|
35
|
-
readonly Table: Table;
|
|
36
|
-
private readonly adapter;
|
|
37
|
-
private query;
|
|
38
|
-
private _parameters;
|
|
39
|
-
get Parameters(): QueryCondition;
|
|
40
|
-
set Parameters(value: QueryCondition);
|
|
41
|
-
/**
|
|
42
|
-
* Creates a Query instance (usually called via db.Query() method)
|
|
43
|
-
*
|
|
44
|
-
* @param Table - Table instance for validation context
|
|
45
|
-
* @param Query - SQL query string with @fieldName placeholders for parameters
|
|
46
|
-
* @param DB - Database connection instance
|
|
47
|
-
*
|
|
48
|
-
* @example
|
|
49
|
-
* ```typescript
|
|
50
|
-
* // Direct instantiation (not recommended - use db.Query() instead)
|
|
51
|
-
* const query = new Query(
|
|
52
|
-
* usersTable,
|
|
53
|
-
* 'SELECT * FROM users WHERE id = @id',
|
|
54
|
-
* db
|
|
55
|
-
* );
|
|
56
|
-
* query.Parameters = { id: 1 };
|
|
57
|
-
*
|
|
58
|
-
* // Recommended approach
|
|
59
|
-
* const query = db.Query(usersTable, 'SELECT * FROM users WHERE id = @id');
|
|
60
|
-
* query.Parameters = { id: 1 };
|
|
61
|
-
* ```
|
|
62
|
-
*/
|
|
63
|
-
constructor(Table: Table, Query: string, adapter: IDatabaseAdapter);
|
|
64
|
-
/**
|
|
65
|
-
* Execute a query that modifies data (INSERT, UPDATE, DELETE)
|
|
66
|
-
*
|
|
67
|
-
* @template Type - Expected return type (typically { lastInsertRowid: number, changes: number })
|
|
68
|
-
* @returns Result object with lastInsertRowid and changes count
|
|
69
|
-
*
|
|
70
|
-
* @example
|
|
71
|
-
* ```typescript
|
|
72
|
-
* // INSERT query
|
|
73
|
-
* const query = db.Query(users, 'INSERT INTO users (name, age) VALUES (@name, @age)');
|
|
74
|
-
* query.Parameters = { name: 'John', age: 30 };
|
|
75
|
-
* const result = query.Run<{ lastInsertRowid: number, changes: number }>();
|
|
76
|
-
* console.log(`Inserted ID: ${result.lastInsertRowid}`);
|
|
77
|
-
*
|
|
78
|
-
* // UPDATE query
|
|
79
|
-
* const update = db.Query(users, 'UPDATE users SET age = @age WHERE id = @id');
|
|
80
|
-
* update.Parameters = { age: 31, id: 1 };
|
|
81
|
-
* const updateResult = update.Run<{ changes: number }>();
|
|
82
|
-
* console.log(`Updated ${updateResult.changes} rows`);
|
|
83
|
-
* ```
|
|
84
|
-
*/
|
|
85
|
-
Run<Type>(): Promise<Type>;
|
|
86
|
-
/**
|
|
87
|
-
* Execute a SELECT query and return all matching rows as Record objects
|
|
88
|
-
* Each row is wrapped in a Record instance for convenient updates/deletes
|
|
89
|
-
*
|
|
90
|
-
* @template Type - Expected row type
|
|
91
|
-
* @returns Array of Record objects containing the query results
|
|
92
|
-
*
|
|
93
|
-
* @example
|
|
94
|
-
* ```typescript
|
|
95
|
-
* interface User {
|
|
96
|
-
* id: number;
|
|
97
|
-
* name: string;
|
|
98
|
-
* age: number;
|
|
99
|
-
* }
|
|
100
|
-
*
|
|
101
|
-
* const query = db.Query(users, 'SELECT * FROM users WHERE age > @age');
|
|
102
|
-
* query.Parameters = { age: 18 };
|
|
103
|
-
* const results = query.All<User>();
|
|
104
|
-
*
|
|
105
|
-
* // Each result is a Record object
|
|
106
|
-
* results.forEach(user => {
|
|
107
|
-
* console.log(user.values); // { id: 1, name: 'John', age: 30 }
|
|
108
|
-
* user.Update({ age: 31 }); // Can update directly
|
|
109
|
-
* });
|
|
110
|
-
* ```
|
|
111
|
-
*/
|
|
112
|
-
All<Type>(): Promise<Record<Type>[]>;
|
|
113
|
-
private convertParamsToObject;
|
|
114
|
-
private convertIdToString;
|
|
115
|
-
/**
|
|
116
|
-
* Execute a SELECT query and return the first matching row as a Record object
|
|
117
|
-
* Returns undefined if no rows match the query
|
|
118
|
-
*
|
|
119
|
-
* @template Type - Expected row type
|
|
120
|
-
* @returns Single Record object or undefined if no match found
|
|
121
|
-
*
|
|
122
|
-
* @example
|
|
123
|
-
* ```typescript
|
|
124
|
-
* interface User {
|
|
125
|
-
* id: number;
|
|
126
|
-
* name: string;
|
|
127
|
-
* email: string;
|
|
128
|
-
* }
|
|
129
|
-
*
|
|
130
|
-
* const query = db.Query(users, 'SELECT * FROM users WHERE id = @id');
|
|
131
|
-
* query.Parameters = { id: 1 };
|
|
132
|
-
* const user = query.Get<User>();
|
|
133
|
-
*
|
|
134
|
-
* if (user) {
|
|
135
|
-
* console.log(user.values); // { id: 1, name: 'John', email: 'john@example.com' }
|
|
136
|
-
* user.Update({ email: 'newemail@example.com' });
|
|
137
|
-
* }
|
|
138
|
-
* ```
|
|
139
|
-
*/
|
|
140
|
-
Get<Type>(): Promise<Record<Type> | undefined>;
|
|
141
|
-
Transaction(paramList: QueryCondition[]): Promise<void>;
|
|
142
|
-
}
|
|
143
|
-
//# sourceMappingURL=Query.d.ts.map
|
package/dist/Query.d.ts.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"Query.d.ts","sourceRoot":"","sources":["../src/Query.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,YAAY,CAAC;AAC/B,OAAO,EAAE,cAAc,EAAwB,MAAM,kBAAkB,CAAC;AACxE,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,gBAAgB,MAAM,kCAAkC,CAAC;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,CAAC,OAAO,OAAO,KAAK;IACxB,SAAgB,KAAK,EAAE,KAAK,CAAC;IAC7B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAmB;IAC3C,OAAO,CAAC,KAAK,CAAc;IAC3B,OAAO,CAAC,WAAW,CAAsB;IAEzC,IAAW,UAAU,IAAI,cAAc,CAEtC;IAED,IAAW,UAAU,CAAC,KAAK,EAAE,cAAc,EAE1C;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;gBACS,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,gBAAgB;IAMlE;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,GAAG,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC;IAKvC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACU,GAAG,CAAC,IAAI,KAAK,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;IAMjD,OAAO,CAAC,qBAAqB;IAa7B,OAAO,CAAC,iBAAiB;IAQzB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACU,GAAG,CAAC,IAAI,KAAK,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC;IAM9C,WAAW,CAAC,SAAS,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;CAiBrE"}
|