@faasjs/knex 8.0.0-beta.7 → 8.0.0-beta.8

package/README.md

@@ -25,10 +25,12 @@ npm install @faasjs/knex
 ## Classes
 
 - [Knex](classes/Knex.md)
+- [KnexSchema](classes/KnexSchema.md)
 
 ## Type Aliases
 
 - [KnexConfig](type-aliases/KnexConfig.md)
+- [MountedKnexAdapter](type-aliases/MountedKnexAdapter.md)
 - [MountFaasKnexOptions](type-aliases/MountFaasKnexOptions.md)
 
 ## Variables

package/dist/index.cjs

@@ -27,12 +27,12 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 
 //#endregion
 let node_crypto = require("node:crypto");
-let _faasjs_func = require("@faasjs/func");
+let node_fs = require("node:fs");
+let node_path = require("node:path");
 let _faasjs_node_utils = require("@faasjs/node-utils");
 let knex = require("knex");
 knex = __toESM(knex);
-let node_fs = require("node:fs");
-let node_path = require("node:path");
+let _faasjs_func = require("@faasjs/func");
 
 //#region src/pglite.ts
 function parsePgliteConnection(connection) {
@@ -105,20 +105,7 @@ function unmountFaasKnex(name = "knex") {
 }
 
 //#endregion
-//#region src/index.ts
-/**
-* FaasJS's sql plugin, base on [Knex](https://knexjs.org/).
-*
-* [![License: MIT](https://img.shields.io/npm/l/@faasjs/knex.svg)](https://github.com/faasjs/faasjs/blob/main/packages/knex/LICENSE)
-* [![NPM Version](https://img.shields.io/npm/v/@faasjs/knex.svg)](https://www.npmjs.com/package/@faasjs/knex)
-*
-* ## Install
-*
-* ```sh
-* npm install @faasjs/knex
-* ```
-* @packageDocumentation
-*/
+//#region src/plugin.ts
 /**
 * Origin [knex](https://knexjs.org/) instance.
 */
@@ -299,8 +286,49 @@ async function raw(sql, bindings = []) {
 	return useKnex().raw(sql, bindings);
 }
 
+//#endregion
+//#region src/schema.ts
+const DefaultMigratorConfig = {
+	directory: "./src/db/migrations",
+	extension: "ts"
+};
+/**
+* Migration helper for FaasJS's knex plugin.
+*/
+var KnexSchema = class {
+	knex;
+	constructor(knex) {
+		this.knex = knex;
+	}
+	getAdapter() {
+		if (!this.knex.adapter) throw Error(`[${this.knex.name}] Client not initialized.`);
+		return this.knex.adapter;
+	}
+	getMigratorConfig() {
+		return Object.assign({}, DefaultMigratorConfig, this.knex.config?.migrations || Object.create(null));
+	}
+	async migrateLatest() {
+		return this.getAdapter().migrate.latest(this.getMigratorConfig());
+	}
+	async migrateRollback() {
+		return this.getAdapter().migrate.rollback(this.getMigratorConfig());
+	}
+	async migrateStatus() {
+		return this.getAdapter().migrate.status(this.getMigratorConfig());
+	}
+	async migrateCurrentVersion() {
+		return this.getAdapter().migrate.currentVersion(this.getMigratorConfig());
+	}
+	async migrateMake(name) {
+		const migrationName = name?.trim();
+		if (!migrationName) throw Error("[KnexSchema] Missing migration name. Usage: npm run migrate:make -- create_users");
+		return this.getAdapter().migrate.make(migrationName, this.getMigratorConfig());
+	}
+};
+
 //#endregion
 exports.Knex = Knex;
+exports.KnexSchema = KnexSchema;
 exports.createPgliteKnex = createPgliteKnex;
 exports.initPostgresTypeParsers = initPostgresTypeParsers;
 exports.mountFaasKnex = mountFaasKnex;

package/dist/index.d.ts

@@ -1,8 +1,13 @@
-import { InvokeData, MountData, Next, Plugin, UseifyPlugin } from "@faasjs/func";
 import knex, { Knex as Knex$1, Knex as OriginKnex } from "knex";
+import { InvokeData, MountData, Next, Plugin, UseifyPlugin } from "@faasjs/func";
 import { Logger } from "@faasjs/logger";
 
 //#region src/pglite.d.ts
+type MountedKnexAdapter = {
+  adapter: Knex$1;
+  query: Knex$1;
+  config: Record<string, unknown>;
+};
 type MountFaasKnexOptions = {
   /** key of `globalThis.FaasJS_Knex`, default is `knex` */name?: string; /** optional config metadata passed through to `@faasjs/knex` */
   config?: Record<string, unknown>;
@@ -21,7 +26,7 @@ declare function mountFaasKnex(db: Knex$1, options?: MountFaasKnexOptions): void
  */
 declare function unmountFaasKnex(name?: string): void;
 //#endregion
-//#region src/index.d.ts
+//#region src/plugin.d.ts
 /**
  * Origin [knex](https://knexjs.org/) instance.
  */
@@ -69,4 +74,28 @@ declare function transaction<TResult = any>(scope: (trx: OriginKnex.Transaction<
 }): Promise<TResult>;
 declare function raw<TResult = any>(sql: string, bindings?: OriginKnex.RawBinding[] | OriginKnex.ValueDict): Promise<OriginKnex.Raw<TResult>>;
 //#endregion
-export { Knex, KnexConfig, type MountFaasKnexOptions, type OriginKnex, createPgliteKnex, initPostgresTypeParsers, mountFaasKnex, originKnex, query, raw, transaction, unmountFaasKnex, useKnex };
+//#region src/schema.d.ts
+/**
+ * Migration helper for FaasJS's knex plugin.
+ */
+declare class KnexSchema {
+  readonly knex: {
+    name: string;
+    adapter?: Knex$1;
+    config: Knex$1.Config;
+  };
+  constructor(knex: {
+    name: string;
+    adapter?: Knex$1;
+    config: Knex$1.Config;
+  });
+  private getAdapter;
+  private getMigratorConfig;
+  migrateLatest(): Promise<any>;
+  migrateRollback(): Promise<any>;
+  migrateStatus(): Promise<number>;
+  migrateCurrentVersion(): Promise<string>;
+  migrateMake(name: string): Promise<string>;
+}
+//#endregion
+export { Knex, KnexConfig, KnexSchema, MountFaasKnexOptions, MountedKnexAdapter, type OriginKnex, createPgliteKnex, initPostgresTypeParsers, mountFaasKnex, originKnex, query, raw, transaction, unmountFaasKnex, useKnex };

package/dist/index.mjs

@@ -1,9 +1,9 @@
 import { randomUUID } from "node:crypto";
-import { usePlugin } from "@faasjs/func";
-import { deepMerge, loadPackage } from "@faasjs/node-utils";
-import knex from "knex";
 import { mkdirSync } from "node:fs";
 import { dirname, resolve } from "node:path";
+import { deepMerge, loadPackage } from "@faasjs/node-utils";
+import knex from "knex";
+import { usePlugin } from "@faasjs/func";
 
 //#region src/pglite.ts
 function parsePgliteConnection(connection) {
@@ -76,20 +76,7 @@ function unmountFaasKnex(name = "knex") {
 }
 
 //#endregion
-//#region src/index.ts
-/**
-* FaasJS's sql plugin, base on [Knex](https://knexjs.org/).
-*
-* [![License: MIT](https://img.shields.io/npm/l/@faasjs/knex.svg)](https://github.com/faasjs/faasjs/blob/main/packages/knex/LICENSE)
-* [![NPM Version](https://img.shields.io/npm/v/@faasjs/knex.svg)](https://www.npmjs.com/package/@faasjs/knex)
-*
-* ## Install
-*
-* ```sh
-* npm install @faasjs/knex
-* ```
-* @packageDocumentation
-*/
+//#region src/plugin.ts
 /**
 * Origin [knex](https://knexjs.org/) instance.
 */
@@ -271,4 +258,44 @@ async function raw(sql, bindings = []) {
 }
 
 //#endregion
-export { Knex, createPgliteKnex, initPostgresTypeParsers, mountFaasKnex, originKnex, query, raw, transaction, unmountFaasKnex, useKnex };
+//#region src/schema.ts
+const DefaultMigratorConfig = {
+	directory: "./src/db/migrations",
+	extension: "ts"
+};
+/**
+* Migration helper for FaasJS's knex plugin.
+*/
+var KnexSchema = class {
+	knex;
+	constructor(knex) {
+		this.knex = knex;
+	}
+	getAdapter() {
+		if (!this.knex.adapter) throw Error(`[${this.knex.name}] Client not initialized.`);
+		return this.knex.adapter;
+	}
+	getMigratorConfig() {
+		return Object.assign({}, DefaultMigratorConfig, this.knex.config?.migrations || Object.create(null));
+	}
+	async migrateLatest() {
+		return this.getAdapter().migrate.latest(this.getMigratorConfig());
+	}
+	async migrateRollback() {
+		return this.getAdapter().migrate.rollback(this.getMigratorConfig());
+	}
+	async migrateStatus() {
+		return this.getAdapter().migrate.status(this.getMigratorConfig());
+	}
+	async migrateCurrentVersion() {
+		return this.getAdapter().migrate.currentVersion(this.getMigratorConfig());
+	}
+	async migrateMake(name) {
+		const migrationName = name?.trim();
+		if (!migrationName) throw Error("[KnexSchema] Missing migration name. Usage: npm run migrate:make -- create_users");
+		return this.getAdapter().migrate.make(migrationName, this.getMigratorConfig());
+	}
+};
+
+//#endregion
+export { Knex, KnexSchema, createPgliteKnex, initPostgresTypeParsers, mountFaasKnex, originKnex, query, raw, transaction, unmountFaasKnex, useKnex };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faasjs/knex",
-  "version": "8.0.0-beta.7",
+  "version": "8.0.0-beta.8",
   "license": "MIT",
   "type": "module",
   "main": "dist/index.cjs",
@@ -31,15 +31,15 @@
   ],
   "peerDependencies": {
     "knex": "*",
-    "@faasjs/func": ">=8.0.0-beta.7",
-    "@faasjs/logger": ">=8.0.0-beta.7",
-    "@faasjs/node-utils": ">=8.0.0-beta.7"
+    "@faasjs/func": ">=8.0.0-beta.8",
+    "@faasjs/logger": ">=8.0.0-beta.8",
+    "@faasjs/node-utils": ">=8.0.0-beta.8"
   },
   "devDependencies": {
     "knex": "*",
-    "@faasjs/func": ">=8.0.0-beta.7",
-    "@faasjs/logger": ">=8.0.0-beta.7",
-    "@faasjs/node-utils": ">=8.0.0-beta.7",
+    "@faasjs/func": ">=8.0.0-beta.8",
+    "@faasjs/logger": ">=8.0.0-beta.8",
+    "@faasjs/node-utils": ">=8.0.0-beta.8",
     "better-sqlite3": "*",
     "knex-pglite": "*",
     "@types/pg": "*",