@open-kingdom/shared-backend-data-access-database-setup 0.0.2-0

package/README.md

@@ -0,0 +1,77 @@
+# data-access-database-setup
+
+This library provides a configurable database setup module for NestJS applications using Drizzle ORM with SQLite.
+
+## Features
+
+- Dynamic module configuration for database setup
+- Configurable schema injection
+- SQLite database configuration with Drizzle ORM
+- Example schema implementation
+
+## Usage
+
+### Basic Usage
+
+```typescript
+import { Module } from '@nestjs/common';
+import { DatabaseSetupModule } from '@open-kingdom/shared-backend-data-access-database-setup';
+import { mySchema } from './my-schema';
+
+@Module({
+  imports: [
+    DatabaseSetupModule.register({
+      schema: mySchema,
+      tag: 'MY_DB',
+      filename: 'my-app.db',
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+### Using the Example Schema
+
+```typescript
+import { Module } from '@nestjs/common';
+import { DatabaseSetupModule, exampleSchema } from '@open-kingdom/shared-backend-data-access-database-setup';
+
+@Module({
+  imports: [
+    DatabaseSetupModule.register({
+      schema: exampleSchema,
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+### Configuration Options
+
+The `DatabaseSetupModule.register()` method accepts the following options:
+
+- `schema`: **Required** - The database schema object containing table definitions
+- `tag`: **Optional** - Database connection tag (defaults to 'DB_DEV')
+- `filename`: **Optional** - SQLite database filename (defaults to 'demo.db')
+
+## Schema Definition
+
+Your schema should be defined using Drizzle ORM's table builders:
+
+```typescript
+import { sqliteTable, text, integer } from 'drizzle-orm/sqlite-core';
+
+export const users = sqliteTable('users', {
+  id: integer('id').primaryKey({ autoIncrement: true }),
+  username: text('username').notNull().unique(),
+  email: text('email').notNull().unique(),
+});
+
+export const mySchema = {
+  users,
+};
+```
+
+## Running unit tests
+
+Run `nx test data-access-database-setup` to execute the unit tests via [Jest](https://jestjs.io).

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './lib/data-access-database-setup.module';
+export type { DatabaseSetupModuleOptions } from './lib/data-access-database-setup.module';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,yCAAyC,CAAC;AACxD,YAAY,EAAE,0BAA0B,EAAE,MAAM,yCAAyC,CAAC"}

package/dist/lib/data-access-database-setup.module.d.ts

@@ -0,0 +1,10 @@
+import { DynamicModule } from '@nestjs/common';
+export type SchemaConfig = Record<string, unknown>;
+export interface DatabaseSetupModuleOptions {
+    schema: SchemaConfig;
+    filename?: string;
+}
+export declare class DatabaseSetupModule {
+    static register(options: DatabaseSetupModuleOptions): DynamicModule;
+}
+//# sourceMappingURL=data-access-database-setup.module.d.ts.map

package/dist/lib/data-access-database-setup.module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-access-database-setup.module.d.ts","sourceRoot":"","sources":["../../src/lib/data-access-database-setup.module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAKvD,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AACnD,MAAM,WAAW,0BAA0B;IACzC,MAAM,EAAE,YAAY,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,qBACa,mBAAmB;IAC9B,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,0BAA0B,GAAG,aAAa;CAcpE"}

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@open-kingdom/shared-backend-data-access-database-setup",
+  "version": "0.0.2-0",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "development": "./src/index.ts",
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "!**/*.tsbuildinfo"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "tslib": "^2.3.0",
+    "@knaadh/nestjs-drizzle-better-sqlite3": "^1.2.0",
+    "drizzle-orm": "^0.44.5"
+  },
+  "nx": {
+    "name": "@open-kingdom/shared-backend-data-access-database-setup",
+    "targets": {
+      "build": {
+        "executor": "@nx/js:tsc",
+        "outputs": [
+          "{options.outputPath}"
+        ],
+        "options": {
+          "outputPath": "dist/libs/shared/backend/data-access-database-setup",
+          "tsConfig": "libs/shared/backend/data-access-database-setup/tsconfig.lib.json",
+          "packageJson": "libs/shared/backend/data-access-database-setup/package.json",
+          "main": "libs/shared/backend/data-access-database-setup/src/index.ts",
+          "assets": [
+            "libs/shared/backend/data-access-database-setup/*.md"
+          ]
+        }
+      }
+    },
+    "tags": [
+      "type:data-access",
+      "scope:shared",
+      "environment:backend"
+    ]
+  }
+}