@simtlix/simfinity-js 3.5.5 → 3.5.6

package/README.md

@@ -6,7 +6,7 @@ MongoDB/Mongoose adapter and compatibility facade for Simfinity. This package ge
 npm install @simtlix/simfinity-js graphql@^16.11.0 mongoose@^8.24.2
 ```
 
-`graphql` and `mongoose` are peer dependencies: the facade uses your application's copies, and npm reports an out-of-range version as a peer conflict instead of installing a second copy. The MCP transports (`createMCPServer`, `startStdioMCPServer`, `createHTTPMCPHandler`) need the optional peer `@modelcontextprotocol/sdk@^1.13.0`; install it only when you use them. `generateMCPTools` works without it. The package does not install `graphql-middleware`.
+`graphql` and `mongoose` are peer dependencies: the facade uses your application's copies, and npm reports an out-of-range version as a peer conflict instead of installing a second copy. The MCP transports (`createMCPServer`, `startStdioMCPServer`, `createHTTPMCPHandler`) need the optional peer `@modelcontextprotocol/sdk@^1.31.0`; install it only when you use them. `generateMCPTools` works without it. The package does not install `graphql-middleware`.
 
 ```javascript
 import mongoose from 'mongoose';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simtlix/simfinity-js",
-  "version": "3.5.5",
+  "version": "3.5.6",
   "description": "MongoDB/Mongoose adapter and compatibility facade for Simfinity GraphQL APIs",
   "main": "src/index.js",
   "types": "./types/index.d.ts",
@@ -16,7 +16,7 @@
     "directory": "packages/mongodb"
   },
   "peerDependencies": {
-    "@modelcontextprotocol/sdk": "^1.13.0",
+    "@modelcontextprotocol/sdk": "^1.31.0",
     "graphql": "^16.11.0",
     "mongoose": "^8.24.2"
   },
@@ -29,8 +29,8 @@
     "owner": "simtlix"
   },
   "dependencies": {
-    "@simtlix/simfinity-core": "3.5.5",
-    "@simtlix/simfinity-mcp": "3.5.5"
+    "@simtlix/simfinity-core": "3.5.6",
+    "@simtlix/simfinity-mcp": "3.5.6"
   },
   "files": [
     "src",

package/src/mongo/adapter.js

@@ -1,4 +1,5 @@
 import mongoose from 'mongoose';
+import { SimfinityError } from '@simtlix/simfinity-core';
 import { getListShape, normalizeConnectionField } from '@simtlix/simfinity-core/internal/relation-storage';
 
 import { createMongoModel } from './models.js';
@@ -78,6 +79,13 @@ export const createMongoAdapter = (options) => {
           // self-referencing collections), the child gets a private ObjectId field.
           const connection = normalizeConnectionField(listShape.itemType, relation.connectionField);
           if (!connection.graphqlFieldName) {
+            // Mongoose drops a stored path named constructor, so the link would never be written.
+            if (connection.storageFieldName === 'constructor') {
+              throw new SimfinityError(
+                `${listShape.itemType.name}.constructor cannot be stored on MongoDB: Mongoose drops a stored path named constructor`,
+                'INVALID_MODEL', 400,
+              );
+            }
             addPrivateConnectionField(listShape.itemType.name, connection.storageFieldName);
           }
         }

package/src/mongo/models.js

@@ -11,6 +11,7 @@ import {
   GraphQLString,
 } from 'graphql';
 import mongoose from 'mongoose';
+import { SimfinityError } from '@simtlix/simfinity-core';
 import { getFieldStorageName } from '@simtlix/simfinity-core/internal/relation-storage';
 
 const isNonNullOfType = (fieldEntryType, graphQLType) => (
@@ -71,6 +72,21 @@ const enumStorageType = (enumType, fieldName) => {
   return mongoose.Schema.Types.Mixed;
 };
 
+// Mongoose cannot store some fields named like Object.prototype members, because it looks paths up
+// on plain objects that inherit those members. An embedded object so named fails to build, the items
+// of an embedded list so named come back from the driver as raw BSON buffers whose members read as
+// null, and a stored path named `constructor` is dropped from every write. Other scalars, scalar lists and references with
+// these names are stored as usual.
+const unstorableField = (gqlType, fieldEntryName, reason) => new SimfinityError(
+  `${gqlType.name}.${fieldEntryName} cannot be stored on MongoDB: ${reason}`, 'INVALID_MODEL', 400,
+);
+
+const assertEmbeddedFieldName = (gqlType, fieldEntryName) => {
+  if (fieldEntryName in Object.prototype) {
+    throw unstorableField(gqlType, fieldEntryName, 'embedded fields cannot be named like Object.prototype members');
+  }
+};
+
 const generateSchemaDefinition = (gqlType, nested = false) => {
   const argTypes = gqlType.getFields();
   const schemaArg = {};
@@ -93,6 +109,7 @@ const generateSchemaDefinition = (gqlType, nested = false) => {
         if (!fieldEntry.extensions.relation.embedded) {
           schemaArg[getFieldStorageName(fieldEntryName, fieldEntry)] = mongoose.Schema.Types.ObjectId;
         } else {
+          assertEmbeddedFieldName(gqlType, fieldEntryName);
           const entryType = unwrapNonNull(type);
           if (entryType === gqlType) {
             throw new Error('A type cannot have a field of its same type and embedded');
@@ -108,6 +125,7 @@ const generateSchemaDefinition = (gqlType, nested = false) => {
       const itemType = getListItemType(type);
       if (fieldEntry.extensions && fieldEntry.extensions.relation) {
         if (fieldEntry.extensions.relation.embedded) {
+          assertEmbeddedFieldName(gqlType, fieldEntryName);
           if (itemType === gqlType) {
             throw new Error('A type cannot have a field of its same type and embedded');
           }
@@ -129,6 +147,11 @@ const generateSchemaDefinition = (gqlType, nested = false) => {
     } else if (isGraphQLisoDate(getEffectiveTypeName(unwrapNonNull(type)))) {
       schemaArg[fieldEntryName] = Date;
     }
+
+    // Whichever stored field takes the `constructor` path, also a reference whose connectionField it is.
+    if (Object.hasOwn(schemaArg, 'constructor')) {
+      throw unstorableField(gqlType, fieldEntryName, 'Mongoose drops a stored path named constructor');
+    }
   }
 
   // In a nested definition, Mongoose reads a `type` key as the type of the whole embedded path.