@stonyx/orm 0.2.1-beta.20 → 0.2.1-beta.21

package/.claude/index.md

@@ -65,6 +65,7 @@ stonyx-orm/
 │   ├── migrate.js                # JSON DB mode migration (file <-> directory)
 │   ├── commands.js               # CLI commands (db:migrate-*, etc.)
 │   ├── utils.js                  # Pluralize wrapper for dasherized names
+│   ├── plural-registry.js        # Plural name registry (populated at init, supports Model.pluralName overrides)
 │   ├── exports/
 │   │   └── db.js                 # Convenience re-export of DB instance
 │   └── mysql/
@@ -150,6 +151,7 @@ The ORM supports two storage modes, configured via `db.mode`:
 - Models: `{PascalCase}Model` (e.g., `AnimalModel`)
 - Serializers: `{PascalCase}Serializer` (e.g., `AnimalSerializer`)
 - Transforms: Original filename (e.g., `animal.js`)
+- Plural names: Auto-pluralized by default (e.g., `animal` → `animals`). Override with `static pluralName` on the model class (e.g., `static pluralName = 'people'`). All call sites use `getPluralName()` from the plural registry, **not** `pluralize()` directly.
 
 ---
 

package/.claude/usage-patterns.md

@@ -31,6 +31,23 @@ export default class AnimalModel extends Model {
 - Use `hasMany(modelName)` for one-to-many
 - Getters work as computed properties
 - Relationships auto-establish bidirectionally
+- Override auto-pluralization with `static pluralName` (see [Overriding Plural Names](#overriding-plural-names))
+
+### Overriding Plural Names
+
+By default, model names are auto-pluralized (e.g., `animal` → `animals`) for REST routes, JSON:API URLs, and DB table names. When auto-pluralization produces the wrong result, override it with `static pluralName`:
+
+```javascript
+import { Model, attr } from '@stonyx/orm';
+
+export default class PersonModel extends Model {
+  static pluralName = 'people';
+
+  name = attr('string');
+}
+```
+
+The override is picked up automatically during ORM initialization — no additional registration is needed. All internal call sites (REST routes, JSON:API type references, MySQL table names, foreign key references) use the overridden value.
 
 ## 2. Serializers (Data Transformation)
 

package/README.md

@@ -109,6 +109,22 @@ export default class OwnerModel extends Model {
 }
 ```
 
+### Overriding Plural Names
+
+By default, model names are auto-pluralized for REST routes, JSON:API URLs, and DB table names (e.g., `animal` → `animals`). When auto-pluralization produces the wrong result, override it with `static pluralName`:
+
+```js
+import { Model, attr } from '@stonyx/orm';
+
+export default class PersonModel extends Model {
+  static pluralName = 'people';
+
+  name = attr('string');
+}
+```
+
+The override is picked up automatically during ORM initialization. All routes, JSON:API type references, and MySQL table names will use the overridden value.
+
 ## Serializers
 
 Based on the following sample payload structure which represents a poorly structure third-party data source:

package/package.json

@@ -4,7 +4,7 @@
     "stonyx-async",
     "stonyx-module"
   ],
-  "version": "0.2.1-beta.20",
+  "version": "0.2.1-beta.21",
   "description": "",
   "main": "src/main.js",
   "type": "module",

package/src/main.js

@@ -19,6 +19,7 @@ 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';
@@ -66,7 +67,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 });

package/src/model.js

@@ -10,6 +10,7 @@ export default class Model {
    * Override in subclass: static memory = false;
    */
   static memory = true;
+  static pluralName = undefined;
 
   id = attr('number');
 

package/src/mysql/mysql-db.js

@@ -6,7 +6,7 @@ import { buildInsert, buildUpdate, buildDelete, buildSelect } from './query-buil
 import { createRecord, store } from '@stonyx/orm';
 import { confirm } from '@stonyx/utils/prompt';
 import { readFile } from '@stonyx/utils/file';
-import { pluralize } from '../utils.js';
+import { getPluralName } from '../plural-registry.js';
 import config from 'stonyx/config';
 import log from 'stonyx/log';
 import path from 'path';
@@ -17,7 +17,7 @@ const defaultDeps = {
   introspectModels, getTopologicalOrder, schemasToSnapshot,
   loadLatestSnapshot, detectSchemaDrift,
   buildInsert, buildUpdate, buildDelete, buildSelect,
-  createRecord, store, confirm, readFile, pluralize, config, log, path
+  createRecord, store, confirm, readFile, getPluralName, config, log, path
 };
 
 export default class MysqlDB {

package/src/mysql/schema-introspector.js

@@ -1,7 +1,7 @@
 import Orm from '@stonyx/orm';
 import { getMysqlType } from './type-map.js';
 import { camelCaseToKebabCase } from '@stonyx/utils/string';
-import { pluralize } from '../utils.js';
+import { getPluralName } from '../plural-registry.js';
 import { dbKey } from '../db.js';
 
 function getRelationshipInfo(property) {
@@ -51,15 +51,16 @@ export function introspectModels() {
 
     // Build foreign keys from belongsTo relationships
     for (const relName of Object.keys(relationships.belongsTo)) {
+      const modelName = camelCaseToKebabCase(relName);
       const fkColumn = `${relName}_id`;
       foreignKeys[fkColumn] = {
-        references: pluralize(relName),
+        references: getPluralName(modelName),
         column: 'id',
       };
     }
 
     schemas[name] = {
-      table: pluralize(name),
+      table: getPluralName(name),
       idType,
       columns,
       foreignKeys,
@@ -130,7 +131,7 @@ export function getTopologicalOrder(schemas) {
 
     // Visit dependencies (belongsTo targets) first
     for (const relName of Object.keys(schema.relationships.belongsTo)) {
-      visit(relName);
+      visit(camelCaseToKebabCase(relName));
     }
 
     order.push(name);

package/src/orm-request.js

@@ -1,7 +1,7 @@
 import { Request } from '@stonyx/rest-server';
 import Orm, { createRecord, updateRecord, store } from '@stonyx/orm';
 import { camelCaseToKebabCase } from '@stonyx/utils/string';
-import { pluralize } from './utils.js';
+import { getPluralName } from './plural-registry.js';
 import { getBeforeHooks, getAfterHooks } from './hooks.js';
 import config from 'stonyx/config';
 
@@ -215,7 +215,7 @@ export default class OrmRequest extends Request {
 
     this.model = model;
     this.access = access;
-    const pluralizedModel = pluralize(model);
+    const pluralizedModel = getPluralName(model);
 
     const modelRelationships = getModelRelationships(model);
 

package/src/plural-registry.js

@@ -0,0 +1,12 @@
+import { pluralize } from './utils.js';
+
+const registry = new Map();
+
+export function registerPluralName(modelName, modelClass) {
+  const plural = modelClass.pluralName || pluralize(modelName);
+  registry.set(modelName, plural);
+}
+
+export function getPluralName(modelName) {
+  return registry.get(modelName) || pluralize(modelName);
+}

package/src/record.js

@@ -1,7 +1,7 @@
 import { store } from './index.js';
 import { getComputedProperties } from "./serializer.js";
 import { camelCaseToKebabCase } from '@stonyx/utils/string';
-import { pluralize } from './utils.js';
+import { getPluralName } from './plural-registry.js';
 export default class Record {
   __data = {};
   __relationships = {};
@@ -57,7 +57,7 @@ export default class Record {
     const { fields, baseUrl } = options;
     const { __data:data } = this;
     const modelName = this.__model.__name;
-    const pluralizedModelName = pluralize(modelName);
+    const pluralizedModelName = getPluralName(modelName);
     const recordId = data.id;
     const relationships = {};
     const attributes = {};

package/src/setup-rest-server.js

@@ -5,7 +5,7 @@ import MetaRequest from './meta-request.js';
 import RestServer from '@stonyx/rest-server';
 import { forEachFileImport } from '@stonyx/utils/file';
 import { dbKey } from './db.js';
-import { pluralize } from './utils.js';
+import { getPluralName } from './plural-registry.js';
 import log from 'stonyx/log';
 
 export default async function(route, accessPath, metaRoute) {
@@ -43,7 +43,7 @@ export default async function(route, accessPath, metaRoute) {
 
   // Configure endpoints for models with access configuration
   for (const [model, access] of Object.entries(accessFiles)) {
-    const pluralizedModel = pluralize(model);
+    const pluralizedModel = getPluralName(model);
     const modelName = name === 'index' ? pluralizedModel : `${name}/${pluralizedModel}`;
     RestServer.instance.mountRoute(OrmRequest, { name: modelName, options: { model, access } });
   }