@h3ravel/arquebus 0.3.6 → 0.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@h3ravel/arquebus",
-  "version": "0.3.6",
+  "version": "0.4.0",
   "description": "Arquebus ORM is a Beautiful, expressive ORM inspired by Laravel's Eloquent, designed for TypeScript applications and for the H3ravel Framework.",
   "homepage": "https://h3ravel.toneflix.net/arquebus",
   "bin": {
@@ -16,8 +16,6 @@
   "files": [
     "dist",
     "bin",
-    "src/stubs",
-    "src/migrations/stubs",
     "types"
   ],
   "exports": {
@@ -83,6 +81,16 @@
         "default": "./dist/migrations/index.cjs"
       }
     },
+    "./inspector": {
+      "import": {
+        "types": "./dist/inspector/index.d.ts",
+        "default": "./dist/inspector/index.js"
+      },
+      "require": {
+        "types": "./dist/inspector/index.d.cts",
+        "default": "./dist/inspector/index.cjs"
+      }
+    },
     "./browser": {
       "import": {
         "types": "./dist/browser/index.d.ts",
@@ -172,6 +180,7 @@
     "lint": "eslint . --ext .ts",
     "cmd": "cross-env TEST=true tsx --experimental-specifier-resolution=node src/cli",
     "cmd:watch": "cross-env TEST=true tsx watch --experimental-specifier-resolution=node src/cli",
+    "test": "cross-env vitest --project generic",
     "test:mysql": "cross-env DB=mysql vitest --project node",
     "test:postgres": "cross-env DB=postgres vitest --project node",
     "test:sqlite": "cross-env DB=sqlite vitest --project node",

package/types/query-builder.ts

@@ -3,11 +3,47 @@ import type { ICollection, IPaginator, IPaginatorParams } from './utils'
 import type { TFunction, TGeneric } from './generics'
 
 import type BModel from 'src/browser/model'
+import type { Column } from 'src/inspector/types/column'
+import type { ForeignKey } from 'src/inspector/types/foreign-key'
 import type { Knex } from 'knex'
 import type Model from 'src/model'
+import type { Table } from 'src/inspector/types/table'
 
 export interface SchemaBuilder extends Knex.SchemaBuilder {
     [k: string]: any
+    /**
+     * Retrieve all tables in the current database.
+     */
+    tables (): Promise<string[]>
+    /**
+     * Retrieve the table info for the given table, or all tables if no table is specified.
+     * 
+     * @param table 
+     */
+    tableInfo (table?: string): Promise<Table | Table[]>
+    /**
+     * Retrieve all columns in a given table, or all columns if no table is specified.
+     * 
+     * @param table 
+     */
+    columns (table?: string): Promise<{ table: string, column: string }[]>
+    /**
+     * Retrieve all columns from a given table. Returns all columns if table parameter is undefined.
+     * 
+     * @param table 
+     * @param column 
+     */
+    columnInfo (table?: string, column?: string): Promise<Column[] | Column>
+    /**
+     * Retrieve the primary key column for a given table.
+     * 
+     * @param table 
+     */
+    primary (table: string): Promise<string>
+    /**
+     * Retrieve all configured foreign key constraints
+     */
+    foreignKeys (): Promise<ForeignKey>
 };
 
 interface AsMethod<QB extends AnyQueryBuilder> {
@@ -163,7 +199,7 @@ export interface IQueryBuilder<M extends Model | BModel = Model, R = M[] | M> {
     take (count: number): this;
     limit (count: number): this;
     offset (count: number): this;
-    pluck<X extends Model = any> (column: string): Promise<ICollection<X>>;
+    pluck<X extends Model = any> (column: string): Promise<Array<X>>;
     chunk (count: number, callback: (rows: M[]) => any): Promise<boolean>;
     forPage (page: number, perPage?: number): this;
     paginate<F extends IPaginatorParams> (page?: number, perPage?: number): Promise<IPaginator<M, F>>;

package/src/migrations/stubs/migration-js.stub

@@ -1,21 +0,0 @@
-import { Migration } from '@h3ravel/arquebus'
-
-export default class extends Migration {
-  /**
-    * Run the migrations.
-    * 
-    * @param {(import('@h3ravel/arquebus/types/query-builder').SchemaBuilder)} schema 
-    */
-  async up(schema) {
-    //
-  }
-
-  /**
-    * Reverse the migrations.
-    * 
-    * @param {(import('@h3ravel/arquebus/types/query-builder').SchemaBuilder)} schema 
-    */
-  async down(schema) {
-    //
-  }
-};

package/src/migrations/stubs/migration-ts.stub

@@ -1,18 +0,0 @@
-import { Migration } from '@h3ravel/arquebus'
-import { SchemaBuilder } from '@h3ravel/arquebus/types/query-builder';
-
-export default class extends Migration {
-  /**
-    * Run the migrations.
-    */
-  async up (schema: SchemaBuilder) {
-    //
-  }
-
-  /**
-    * Reverse the migrations.
-    */
-  async down (schema: SchemaBuilder) {
-    //
-  }
-};

package/src/migrations/stubs/migration.create-js.stub

@@ -1,24 +0,0 @@
-import { Migration } from '@h3ravel/arquebus'
-
-export default class extends Migration {
-  /**
-    * Run the migrations.
-    * 
-    * @param {(import('@h3ravel/arquebus/types/query-builder').SchemaBuilder)} schema 
-    */
-  async up(schema) {
-    await schema.createTable('{{ table }}', (table) => {
-      table.increments('id');
-      table.timestamps();
-    });
-  }
-
-  /**
-    * Reverse the migrations.
-    * 
-    * @param {(import('@h3ravel/arquebus/types/query-builder').SchemaBuilder)} schema 
-    */
-  async down(schema) {
-    await schema.dropTableIfExists('{{ table }}');
-  }
-};

package/src/migrations/stubs/migration.create-ts.stub

@@ -1,21 +0,0 @@
-import { Migration } from '@h3ravel/arquebus'
-import { SchemaBuilder } from '@h3ravel/arquebus/types/query-builder';
-
-export default class extends Migration {
-  /**
-    * Run the migrations.
-    */
-  async up(schema: SchemaBuilder) {
-    await schema.createTable('{{ table }}', (table) => {
-      table.increments('id');
-      table.timestamps();
-    });
-  }
-
-  /**
-    * Reverse the migrations.
-    */
-  async down(schema: SchemaBuilder) {
-    await schema.dropTableIfExists('{{ table }}');
-  }
-};

package/src/migrations/stubs/migration.update-js.stub

@@ -1,25 +0,0 @@
-import { Migration } from '@h3ravel/arquebus'
-
-export default class extends Migration {
-  /**
-    * Run the migrations.
-    *
-    * @param {(import('@h3ravel/arquebus/types/query-builder').SchemaBuilder)} schema 
-    */
-  async up(schema) {
-    await schema.table('{{ table }}', (table) => {
-      // 
-    });
-  }
-
-  /**
-    * Reverse the migrations.
-    *
-    * @param {(import('@h3ravel/arquebus/types/query-builder').SchemaBuilder)} schema 
-    */
-  async down(schema) {
-    await schema.table('{{ table }}', (table) => {
-      // 
-    });
-  }
-};

package/src/migrations/stubs/migration.update-ts.stub

@@ -1,22 +0,0 @@
-import { Migration } from '@h3ravel/arquebus'
-import { SchemaBuilder } from '@h3ravel/arquebus/types/query-builder';
-
-export default class extends Migration {
-  /**
-    * Run the migrations.
-    */
-  async up(schema: SchemaBuilder) {
-    await schema.table('{{ table }}', (table) => {
-      // 
-    });
-  }
-
-  /**
-    * Reverse the migrations.
-    */
-  async down(schema: SchemaBuilder) {
-    await schema.table('{{ table }}', (table) => {
-      // 
-    });
-  }
-};

package/src/stubs/arquebus.config-js.stub

@@ -1,25 +0,0 @@
-import { defineConfig } from '@h3ravel/arquebus'
-
-export default defineConfig({
-    client: 'mysql2',
-    connection: {
-        host: 'localhost',
-        database: 'database',
-        user: 'user',
-        password: 'password'
-    },
-    migrations: {
-        table: 'migrations',
-        path: './migrations',
-    },
-    factories: {
-        path: './factories',
-    },
-    seeders: {
-        path: './seeders',
-    },
-    models: {
-        path: './models'
-    }
-})
-

package/src/stubs/arquebus.config-ts.stub

@@ -1,24 +0,0 @@
-import { defineConfig } from '@h3ravel/arquebus'
-
-export default defineConfig({
-    client: 'mysql2',
-    connection: {
-        host: 'localhost',
-        database: 'database',
-        user: 'user',
-        password: 'password'
-    },
-    migrations: {
-        table: 'migrations',
-        path: './migrations',
-    },
-    factories: {
-        path: './factories',
-    },
-    seeders: {
-        path: './seeders',
-    },
-    models: {
-        path: './models'
-    }
-})

package/src/stubs/model-js.stub

@@ -1,5 +0,0 @@
-import { Model } from '@h3ravel/arquebus'
-
-export default class {{ name }} extends Model {
-  //
-}

package/src/stubs/model-ts.stub

@@ -1,5 +0,0 @@
-import { Model } from '@h3ravel/arquebus'
-
-export default class {{ name }} extends Model {
-  //
-}