forj 0.1.0 → 0.1.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "forj",
   "description": "SQLite ORM and Query Builder whitout dependencies",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "type": "module",
   "main": "src/index.ts",
   "files": ["src"],

package/src/migrations/blueprint.ts

@@ -1,3 +1,4 @@
+import pluralize from 'pluralize'
 import Column from './column'
 import ForeignKey from './foreign-key'
 import { tableName } from '../utils'
@@ -127,8 +128,22 @@ export class Blueprint {
     return this.softDelete(columnType, name)
   }
 
-  foreign(column: string) {
-    const fk: ForeignKeyDefinition = { column, references: '', on: '' }
+  foreignId(name: string) {
+    const opts = { name, type: 'INTEGER', onDelete: 'CASCADE', onUpdate: 'RESTRICT' } as ColumnDefinition
+    const sufixIndex = name.lastIndexOf('_id')
+
+    if (sufixIndex > -1)
+      return this.#column({
+        ...opts,
+        references: name.substring(sufixIndex + 1),
+        on: pluralize(name.substring(0, sufixIndex)),
+      })
+
+    return this.#column(opts)
+  }
+
+  foreign(name: string) {
+    const fk: ForeignKeyDefinition = { name, references: '', on: '' }
     this.#foreignKeys.push(fk)
     return new ForeignKey(fk)
   }

package/src/migrations/builder.ts

@@ -88,6 +88,9 @@ export default class SchemaBuilder {
     if (column.raw)
       sql += ' '+ column.raw
 
+    if (column.references && column.on)
+      sql += this.#foreignKey(column, true)
+
     // if (column.comment)
     //   sql += ` COMMENT '${column.comment.replace(/'/g, "''")}'`
 
@@ -128,8 +131,8 @@ export default class SchemaBuilder {
     }
   }
 
-  static #foreignKey(fk: ForeignKeyDefinition): string {
-    let sql = `FOREIGN KEY (${fk.column}) REFERENCES ${fk.on}(${fk.references})`
+  static #foreignKey(fk: ColumnDefinition | ForeignKeyDefinition, column: boolean = false): string {
+    let sql = (column ? '' : `FOREIGN KEY (${fk.name})`) +` REFERENCES ${fk.on}(${fk.references})`
 
     if (fk.onDelete)
       sql += ` ON DELETE ${fk.onDelete.toUpperCase()}`

package/src/migrations/foreign-key.ts

@@ -1,4 +1,4 @@
-import type { ForeignKeyDefinition } from './types'
+import type { ForeignKeyDefinition, ForeignKeyAction } from './types'
 
 export default class ForeignKey {
   constructor(private fk: ForeignKeyDefinition) {}
@@ -13,12 +13,12 @@ export default class ForeignKey {
     return this
   }
 
-  onDelete(action: 'cascade' | 'set null' | 'restrict' | 'no action') {
+  onDelete(action: ForeignKeyAction) {
     this.fk.onDelete = action;
     return this;
   }
 
-  onUpdate(action: 'cascade' | 'set null' | 'restrict' | 'no action') {
+  onUpdate(action: ForeignKeyAction) {
     this.fk.onUpdate = action
     return this
   }

package/src/migrations/types.ts

@@ -6,7 +6,7 @@ export type BlueprintFn = (table: Blueprint) => void
 
 // TODO: refactor bellow
 
-export interface ColumnDefinition {
+export type ColumnDefinition = {
   name: string,
   type: string,
   length?: number,
@@ -19,26 +19,30 @@ export interface ColumnDefinition {
   index?: boolean,
   comment?: string,
   raw?: string,
+  references?: string,
+  on?: string,
+  onDelete?: ForeignKeyAction,
+  onUpdate?: ForeignKeyAction,
 }
 
-export interface IndexDefinition {
+export type IndexDefinition = {
   columns: string[],
   type: 'index' | 'unique' | 'primary',
   name?: string,
 }
 
-export interface ForeignKeyDefinition {
-  column: string,
+export type ForeignKeyDefinition = {
+  name: string,
   references: string,
   on: string,
-  onDelete?: 'cascade' | 'set null' | 'restrict' | 'no action',
-  onUpdate?: 'cascade' | 'set null' | 'restrict' | 'no action',
+  onDelete?: ForeignKeyAction,
+  onUpdate?: ForeignKeyAction,
 }
 
 export type QueueType = 'pending' | 'migrated'
 export type Queue = Record<QueueType, MigrationInfo[]>
 
-export interface MigrationInfo {
+export type MigrationInfo = {
   timestamp: number,
   name: string,
   className: string,
@@ -48,7 +52,7 @@ export interface MigrationInfo {
   migrated: boolean,
 }
 
-export interface MigrationRecord {
+export type MigrationRecord = {
   migration: string;
   batch: number;
   executed_at: Date;
@@ -64,6 +68,8 @@ export type MigrationClass = {
   // getMigrationName?(): string;
 }
 
+export type ForeignKeyAction = 'cascade' | 'set null' | 'restrict' | 'no action' | 'CASCADE' | 'SET NULL' | 'RESTRICT' | 'NO ACTION'
+
 // export interface SchemaConnection {
 //   execute(sql: string): Promise<any>,
 //   query(sql: string): Promise<any[]>,