@stonyx/orm 0.2.1-alpha.3 → 0.2.1-alpha.31

package/src/hooks.js

@@ -0,0 +1,124 @@
+/*
+ * Copyright 2025 Stone Costa
+ *
+ * Licensed under the Apache License, Version 2.0 (the 'License');
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Middleware-based hooks registry for ORM operations.
+ * Unlike event-based hooks, middleware hooks run sequentially and can halt operations.
+ */
+
+// Map of "operation:model" -> handler[]
+const beforeHooks = new Map();
+const afterHooks = new Map();
+
+/**
+ * Register a before hook middleware that runs before the operation executes.
+ *
+ * @param {string} operation - Operation name: 'create', 'update', 'delete', 'get', or 'list'
+ * @param {string} model - Model name (e.g., 'user', 'animal')
+ * @param {Function} handler - Middleware function (context) => any
+ *   - Return undefined to continue to next hook/handler
+ *   - Return any value to halt operation (integer = HTTP status, object = response body)
+ * @returns {Function} Unsubscribe function
+ */
+export function beforeHook(operation, model, handler) {
+  const key = `${operation}:${model}`;
+  if (!beforeHooks.has(key)) {
+    beforeHooks.set(key, []);
+  }
+  beforeHooks.get(key).push(handler);
+
+  // Return unsubscribe function
+  return () => {
+    const hooks = beforeHooks.get(key);
+    if (hooks) {
+      const index = hooks.indexOf(handler);
+      if (index > -1) hooks.splice(index, 1);
+    }
+  };
+}
+
+/**
+ * Register an after hook middleware that runs after the operation completes.
+ * After hooks cannot halt operations (they run after completion).
+ *
+ * @param {string} operation - Operation name
+ * @param {string} model - Model name
+ * @param {Function} handler - Middleware function (context) => void
+ * @returns {Function} Unsubscribe function
+ */
+export function afterHook(operation, model, handler) {
+  const key = `${operation}:${model}`;
+  if (!afterHooks.has(key)) {
+    afterHooks.set(key, []);
+  }
+  afterHooks.get(key).push(handler);
+
+  // Return unsubscribe function
+  return () => {
+    const hooks = afterHooks.get(key);
+    if (hooks) {
+      const index = hooks.indexOf(handler);
+      if (index > -1) hooks.splice(index, 1);
+    }
+  };
+}
+
+/**
+ * Get all before hooks for an operation:model combination.
+ * @param {string} operation
+ * @param {string} model
+ * @returns {Function[]}
+ */
+export function getBeforeHooks(operation, model) {
+  const key = `${operation}:${model}`;
+  return beforeHooks.get(key) || [];
+}
+
+/**
+ * Get all after hooks for an operation:model combination.
+ * @param {string} operation
+ * @param {string} model
+ * @returns {Function[]}
+ */
+export function getAfterHooks(operation, model) {
+  const key = `${operation}:${model}`;
+  return afterHooks.get(key) || [];
+}
+
+/**
+ * Clear registered hooks for a specific operation:model.
+ *
+ * @param {string} operation - Operation name
+ * @param {string} model - Model name
+ * @param {string} [type] - 'before' or 'after' (if omitted, clears both)
+ */
+export function clearHook(operation, model, type) {
+  const key = `${operation}:${model}`;
+  if (!type || type === 'before') {
+    beforeHooks.set(key, []);
+  }
+  if (!type || type === 'after') {
+    afterHooks.set(key, []);
+  }
+}
+
+/**
+ * Clear all hooks (useful for testing).
+ */
+export function clearAllHooks() {
+  beforeHooks.clear();
+  afterHooks.clear();
+}

package/src/index.js

@@ -15,14 +15,24 @@
  */
 
 import Model from './model.js';
+import View from './view.js';
 import Serializer from './serializer.js';
 
 import attr from './attr.js';
 import belongsTo from './belongs-to.js';
 import hasMany from './has-many.js';
 import { createRecord, updateRecord } from './manage-record.js';
+import { count, avg, sum, min, max } from './aggregates.js';
 
 export { default } from './main.js';
 export { store, relationships } from './main.js';
-export { Model, Serializer }; // base classes
-export { attr, belongsTo, hasMany, createRecord, updateRecord }; // helpers
+export { Model, View, Serializer }; // base classes
+export { attr, belongsTo, hasMany, createRecord, updateRecord }; // helpers
+export { count, avg, sum, min, max }; // aggregate helpers
+export { beforeHook, afterHook, clearHook, clearAllHooks } from './hooks.js'; // middleware hooks
+
+// Store API:
+// store.get(model, id)   — sync, memory-only
+// store.find(model, id)  — async, MySQL for memory:false models
+// store.findAll(model)   — async, all records
+// store.query(model, conditions) — async, always hits MySQL

package/src/main.js

@@ -19,10 +19,12 @@ import config from 'stonyx/config';
 import log from 'stonyx/log';
 import { forEachFileImport } from '@stonyx/utils/file';
 import { kebabCaseToPascalCase, pluralize } from '@stonyx/utils/string';
+import { registerPluralName } from './plural-registry.js';
 import setupRestServer from './setup-rest-server.js';
 import baseTransforms from './transforms.js';
 import Store from './store.js';
 import Serializer from './serializer.js';
+import { setup } from '@stonyx/events';
 
 const defaultOptions = {
   dbType: 'json'
@@ -35,6 +37,7 @@ export default class Orm {
   
   models = {};
   serializers = {};
+  views = {};
   transforms = { ...baseTransforms };
   warnings = new Set();
 
@@ -65,7 +68,10 @@ export default class Orm {
         // Transforms keep their original name, everything else gets converted to PascalCase with the type suffix
         const alias = type === 'Transform' ? name : `${kebabCaseToPascalCase(name)}${type}`;
 
-        if (type === 'Model') Orm.store.set(name, new Map());
+        if (type === 'Model') {
+          Orm.store.set(name, new Map());
+          registerPluralName(name, exported);
+        }
 
         return this[pluralize(lowerCaseType)][alias] = exported;
       }, { ignoreAccessFailure: true, rawName: true, recursive: true, recursiveNaming: true });
@@ -74,10 +80,44 @@ export default class Orm {
     // Wait for imports before db & rest server setup
     await Promise.all(promises);
 
-    if (this.options.dbType !== 'none') {
+    // Discover views from paths.view (separate from model/serializer/transform)
+    if (paths.view) {
+      await forEachFileImport(paths.view, (exported, { name }) => {
+        const alias = `${kebabCaseToPascalCase(name)}View`;
+        Orm.store.set(name, new Map());
+        registerPluralName(name, exported);
+        this.views[alias] = exported;
+      }, { ignoreAccessFailure: true, rawName: true, recursive: true, recursiveNaming: true });
+    }
+
+    // Setup event names for hooks after models are loaded
+    const eventNames = [];
+    const operations = ['list', 'get', 'create', 'update', 'delete'];
+    const viewOperations = ['list', 'get'];
+    const timings = ['before', 'after'];
+
+    for (const modelName of Orm.store.data.keys()) {
+      const isView = this.isView(modelName);
+      const ops = isView ? viewOperations : operations;
+
+      for (const timing of timings) {
+        for (const operation of ops) {
+          eventNames.push(`${timing}:${operation}:${modelName}`);
+        }
+      }
+    }
+
+    setup(eventNames);
+
+    if (config.orm.mysql) {
+      const { default: MysqlDB } = await import('./mysql/mysql-db.js');
+      this.mysqlDb = new MysqlDB();
+      this.db = this.mysqlDb;
+      promises.push(this.mysqlDb.init());
+    } else if (this.options.dbType !== 'none') {
       const db = new DB();
       this.db = db;
-      
+
       promises.push(db.init());
     }
 
@@ -85,10 +125,29 @@ export default class Orm {
       promises.push(setupRestServer(restServer.route, paths.access, restServer.metaRoute));
     }
 
+    // Wire up memory resolver so store.find() can check model memory flags
+    Orm.store._memoryResolver = (modelName) => {
+      const { modelClass } = this.getRecordClasses(modelName);
+      return modelClass?.memory === true;
+    };
+
+    // Wire up MySQL reference for on-demand queries from store.find()/findAll()
+    if (this.mysqlDb) {
+      Orm.store._mysqlDb = this.mysqlDb;
+    }
+
     Orm.ready = await Promise.all(promises);
     Orm.initialized = true;
   }
 
+  async startup() {
+    if (this.mysqlDb) await this.mysqlDb.startup();
+  }
+
+  async shutdown() {
+    if (this.mysqlDb) await this.mysqlDb.shutdown();
+  }
+
   static get db() {
     if (!Orm.initialized) throw new Error('ORM has not been initialized yet');
 
@@ -97,13 +156,27 @@ export default class Orm {
 
   getRecordClasses(modelName) {
     const modelClassPrefix = kebabCaseToPascalCase(modelName);
-  
+
+    // Check views first, then models
+    const viewClass = this.views[`${modelClassPrefix}View`];
+    if (viewClass) {
+      return {
+        modelClass: viewClass,
+        serializerClass: this.serializers[`${modelClassPrefix}Serializer`] || Serializer
+      };
+    }
+
     return {
       modelClass: this.models[`${modelClassPrefix}Model`],
       serializerClass: this.serializers[`${modelClassPrefix}Serializer`] || Serializer
     };
   }
 
+  isView(modelName) {
+    const modelClassPrefix = kebabCaseToPascalCase(modelName);
+    return !!this.views[`${modelClassPrefix}View`];
+  }
+
   // Queue warnings to avoid the same error from being logged in the same iteration
   warn(message) {
     this.warnings.add(message);

package/src/manage-record.js

@@ -14,6 +14,11 @@ export function createRecord(modelName, rawData={}, userOptions={}) {
 
   if (!initialized && !options.isDbRecord) throw new Error('ORM is not ready');
 
+  // Guard: read-only views cannot have records created directly
+  if (orm?.isView?.(modelName) && !options.isDbRecord) {
+    throw new Error(`Cannot create records for read-only view '${modelName}'`);
+  }
+
   const modelStore = store.get(modelName);
   const globalRelationships = relationships.get('global');
   const pendingRelationships = relationships.get('pending');
@@ -83,6 +88,12 @@ export function createRecord(modelName, rawData={}, userOptions={}) {
 export function updateRecord(record, rawData, userOptions={}) {
   if (!rawData) throw new Error('rawData must be passed in to updateRecord call');
 
+  // Guard: read-only views cannot be updated
+  const modelName = record?.__model?.__name;
+  if (modelName && Orm.instance?.isView?.(modelName)) {
+    throw new Error(`Cannot update records for read-only view '${modelName}'`);
+  }
+
   const options = { ...defaultOptions, ...userOptions, update:true };
 
   record.serialize(rawData, options);
@@ -90,14 +101,29 @@ export function updateRecord(record, rawData, userOptions={}) {
 
 /**
  * gets the next available id based on last record entry.
- * 
- * Note/TODO: Records going into a db should get their id from the db instead
- * Atm, i think the best way to do that would be as an id override that happens after the
- * record is created
+ *
+ * In MySQL mode with numeric IDs, assigns a temporary pending ID.
+ * MySQL's AUTO_INCREMENT provides the real ID after INSERT.
  */
 function assignRecordId(modelName, rawData) {
   if (rawData.id) return;
 
+  // In MySQL mode with numeric IDs, defer to MySQL auto-increment
+  if (Orm.instance?.mysqlDb && !isStringIdModel(modelName)) {
+    rawData.id = `__pending_${Date.now()}_${Math.random()}`;
+    rawData.__pendingMysqlId = true;
+    return;
+  }
+
   const modelStore = Array.from(store.get(modelName).values());
   rawData.id = modelStore.length ? modelStore.at(-1).id + 1 : 1;
 }
+
+function isStringIdModel(modelName) {
+  const { modelClass } = Orm.instance.getRecordClasses(modelName);
+  if (!modelClass) return false;
+
+  const model = new modelClass(modelName);
+
+  return model.id?.type === 'string';
+}

package/src/migrate.js

@@ -0,0 +1,72 @@
+import config from 'stonyx/config';
+import Orm from '@stonyx/orm';
+import { createFile, createDirectory, readFile, updateFile, deleteDirectory } from '@stonyx/utils/file';
+import { dbKey } from './db.js';
+import path from 'path';
+
+function getCollectionKeys() {
+  const SchemaClass = Orm.instance.models[`${dbKey}Model`];
+  const instance = new SchemaClass();
+  const keys = [];
+
+  for (const key of Object.keys(instance)) {
+    if (key === '__name' || key === 'id') continue;
+    if (typeof instance[key] === 'function') keys.push(key);
+  }
+
+  return keys;
+}
+
+function getDirPath() {
+  const { rootPath } = config;
+  const { file, directory } = config.orm.db;
+  const dbDir = path.dirname(path.resolve(`${rootPath}/${file}`));
+
+  return path.join(dbDir, directory);
+}
+
+export async function fileToDirectory() {
+  const { rootPath } = config;
+  const { file } = config.orm.db;
+  const dbFilePath = path.resolve(`${rootPath}/${file}`);
+  const collectionKeys = getCollectionKeys();
+  const dirPath = getDirPath();
+
+  // Read full data from db.json
+  const data = await readFile(dbFilePath, { json: true });
+
+  // Create directory and write each collection
+  await createDirectory(dirPath);
+
+  await Promise.all(collectionKeys.map(key =>
+    createFile(path.join(dirPath, `${key}.json`), data[key] || [], { json: true })
+  ));
+
+  // Overwrite db.json with empty-array skeleton
+  const skeleton = {};
+  for (const key of collectionKeys) skeleton[key] = [];
+
+  await updateFile(dbFilePath, skeleton, { json: true });
+}
+
+export async function directoryToFile() {
+  const { rootPath } = config;
+  const { file } = config.orm.db;
+  const dbFilePath = path.resolve(`${rootPath}/${file}`);
+  const collectionKeys = getCollectionKeys();
+  const dirPath = getDirPath();
+
+  // Read each collection from the directory
+  const assembled = {};
+
+  await Promise.all(collectionKeys.map(async key => {
+    const filePath = path.join(dirPath, `${key}.json`);
+    assembled[key] = await readFile(filePath, { json: true });
+  }));
+
+  // Overwrite db.json with full assembled data
+  await updateFile(dbFilePath, assembled, { json: true });
+
+  // Remove the directory
+  await deleteDirectory(dirPath);
+}

package/src/model-property.js

@@ -22,8 +22,8 @@ export default class ModelProperty {
       return this._value = newValue;
     }
 
-    if (newValue === undefined || newValue === null) return;
+    if (newValue === undefined) return;
 
-    this._value = Orm.instance.transforms[this.type](newValue);
+    this._value = newValue === null ? null : Orm.instance.transforms[this.type](newValue);
   }
 }

package/src/model.js

@@ -1,6 +1,17 @@
 import { attr } from '@stonyx/orm';
 
 export default class Model {
+  /**
+   * Controls whether records of this model are loaded into memory on startup.
+   *
+   * - true  → loaded on boot, kept in store
+   * - false → never cached; find() always queries MySQL (default)
+   *
+   * Override in subclass: static memory = true;
+   */
+  static memory = false;
+  static pluralName = undefined;
+
   id = attr('number');
 
   constructor(name) {

package/src/mysql/connection.js

@@ -0,0 +1,28 @@
+let pool = null;
+
+export async function getPool(mysqlConfig) {
+  if (pool) return pool;
+
+  const mysql = await import('mysql2/promise');
+
+  pool = mysql.createPool({
+    host: mysqlConfig.host,
+    port: mysqlConfig.port,
+    user: mysqlConfig.user,
+    password: mysqlConfig.password,
+    database: mysqlConfig.database,
+    connectionLimit: mysqlConfig.connectionLimit,
+    waitForConnections: true,
+    enableKeepAlive: true,
+    keepAliveInitialDelay: 10000,
+  });
+
+  return pool;
+}
+
+export async function closePool() {
+  if (!pool) return;
+
+  await pool.end();
+  pool = null;
+}