@simtlix/simfinity-js 3.7.0 → 3.8.0

package/README.md

@@ -24,6 +24,8 @@ Generated single-reference reads can be batched within a request. Models with an
 
 Generated models store enum internal values with their own type (numbers, booleans or strings; other combinations as given) and support embedded fields named `type`. Embedded types that contain each other are rejected with `INVALID_MODEL` (`Embedded cycle at …`) when a generated model reaches them, and always in transactional mode; in the default mode, a cycle that only supplied models reach is not checked. Range filters, sorts and aggregates on numeric and boolean enums follow that type; PostgreSQL uses their text form. Earlier versions stored numeric and boolean enum values as strings; convert existing documents once as described in the [schema guide](https://simtlix.github.io/simfinity.js/guide/schema.html#what-gets-generated).
 
+Virtual fields (`extensions: { virtual: true }`, with the field's own `resolve`) get no path, no `[]` default and no index in generated models, on entities and embedded types, and no entry in the transactional integrity registry, so they need no `relation` in either mode and documents look the same with or without them. Generated writes never set or unset them, and Mongoose's strict mode drops a value that a controller assigns to a generated document for one. An embedded type whose members are all virtual becomes a strict subdocument without paths rather than a Mixed path, so nothing is stored for it but the `_id` of list items. With a generated model, values stored before a field became virtual stay in the documents: Mongoose drops an `$unset` of a path the model does not declare, so remove them with a driver-level update, such as `getModel(Type).collection.updateMany({}, { $unset: { busyRanges: '' } })`, or with `updateMany(filter, update, { strict: false })`; a generated update that sets an embedded parent rewrites it, which drops the stored keys of its virtual members. A supplied model keeps the paths it declares: documents stored earlier keep their values for the field, which nothing reads or writes until `$unset` removes them, and an index on such a path stays until you drop it. `buildQuery()` rejects a path through a virtual field with `INVALID_FILTER_FIELD` (400).
+
 The facade registers generated models on your application's default Mongoose instance and does not change global Mongoose options such as `strictQuery`. Supplied models may use another connection, such as one from `mongoose.createConnection()`: generated mutations and `saveObject()` use the model's connection, and, in the default `referentialIntegrity: 'off'` mode, custom mutations use the default connection unless it is unused, never opened and without compiled models, also on its `useDb()` descendants, and the registered models share one MongoDB client; with transactional reference integrity they use the first protected model's connection. `createMongoAdapter().castId` accepts only an ObjectId or its 24-character hexadecimal string and throws `NOT_VALID_ID` (400) otherwise; create new identifiers with `new mongoose.Types.ObjectId()`. Owned transactions retry transient failures after a short random delay, and a write conflict that outlasts the retries fails with `TRANSACTION_RETRY_EXCEEDED` (409).
 
 Mongoose 8.24.2 or later within version 8 is required to exclude the update-casting prototype-pollution vulnerability. Existing applications should update Mongoose and their dependency lockfile, then run `npm audit`; upgrading Simfinity does not refresh every transitive dependency already locked by the application.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simtlix/simfinity-js",
-  "version": "3.7.0",
+  "version": "3.8.0",
   "description": "MongoDB/Mongoose adapter and compatibility facade for Simfinity GraphQL APIs",
   "main": "src/index.js",
   "types": "./types/index.d.ts",
@@ -29,8 +29,8 @@
     "owner": "simtlix"
   },
   "dependencies": {
-    "@simtlix/simfinity-core": "3.7.0",
-    "@simtlix/simfinity-mcp": "3.7.0"
+    "@simtlix/simfinity-core": "3.8.0",
+    "@simtlix/simfinity-mcp": "3.8.0"
   },
   "files": [
     "src",

package/src/mongo/models.js

@@ -12,7 +12,7 @@ import {
 } from 'graphql';
 import mongoose from 'mongoose';
 import { SimfinityError } from '@simtlix/simfinity-core';
-import { getFieldStorageName } from '@simtlix/simfinity-core/internal/relation-storage';
+import { getFieldStorageName, isVirtualField } from '@simtlix/simfinity-core/internal/relation-storage';
 
 const isNonNullOfType = (fieldEntryType, graphQLType) => (
   fieldEntryType instanceof GraphQLNonNull && fieldEntryType.ofType instanceof graphQLType
@@ -97,11 +97,24 @@ const assertNoEmbeddedCycle = (gqlType, entryType, ancestors, fieldPath) => {
   if (ancestors.includes(entryType)) throw new SimfinityError(`Embedded cycle at ${fieldPath}`, 'INVALID_MODEL', 400);
 };
 
+// Mongoose reads an empty definition, `{}` or `[{}]`, as Mixed, which stores any keys. An embedded
+// type whose members are all virtual has such a definition, so it gets a strict subdocument without
+// paths instead: no value of its virtual members, or any other key, is stored. A list item keeps its
+// `_id`, as other embedded list items do. Embedded types without virtual members keep their
+// definition, even an empty one.
+const storedEmbeddedDefinition = (entryType, definition, list) => {
+  if (Object.keys(definition).length || !Object.values(entryType.getFields()).some(isVirtualField)) return definition;
+  return list ? new mongoose.Schema({}) : new mongoose.Schema({}, { _id: false });
+};
+
 const generateSchemaDefinition = (gqlType, nested = false, ancestors = [], path = gqlType.name) => {
   const argTypes = gqlType.getFields();
   const schemaArg = {};
 
   for (const [fieldEntryName, fieldEntry] of Object.entries(argTypes)) {
+    // A virtual field is resolved by its own resolver and stored nowhere, on entities and embedded
+    // types alike: it gets no path, so no `[]` default and no ObjectId index either.
+    if (isVirtualField(fieldEntry)) continue;
     const { type } = fieldEntry;
 
     if (matchesScalar(type, GraphQLID)) {
@@ -123,9 +136,10 @@ const generateSchemaDefinition = (gqlType, nested = false, ancestors = [], path
           const entryType = unwrapNonNull(type);
           const fieldPath = `${path}.${fieldEntryName}`;
           assertNoEmbeddedCycle(gqlType, entryType, ancestors, fieldPath);
-          const definition = generateSchemaDefinition(entryType, true, [...ancestors, gqlType], fieldPath);
+          const definition = storedEmbeddedDefinition(entryType,
+            generateSchemaDefinition(entryType, true, [...ancestors, gqlType], fieldPath), false);
           // A nested object under a `type` key can only be a subdocument; like other embedded objects, it has no _id.
-          schemaArg[fieldEntryName] = nested && fieldEntryName === 'type'
+          schemaArg[fieldEntryName] = nested && fieldEntryName === 'type' && !(definition instanceof mongoose.Schema)
             ? new mongoose.Schema(definition, { _id: false })
             : definition;
         }
@@ -137,7 +151,8 @@ const generateSchemaDefinition = (gqlType, nested = false, ancestors = [], path
           assertEmbeddedFieldName(gqlType, fieldEntryName);
           const fieldPath = `${path}.${fieldEntryName}`;
           assertNoEmbeddedCycle(gqlType, itemType, ancestors, fieldPath);
-          schemaArg[fieldEntryName] = [generateSchemaDefinition(itemType, true, [...ancestors, gqlType], fieldPath)];
+          schemaArg[fieldEntryName] = [storedEmbeddedDefinition(itemType,
+            generateSchemaDefinition(itemType, true, [...ancestors, gqlType], fieldPath), true)];
         }
       } else if (listItemMatchesScalar(type, GraphQLID)) {
         schemaArg[fieldEntryName] = [mongoose.Schema.Types.ObjectId];
@@ -186,7 +201,7 @@ const findObjectIdFields = (schemaDefinition, parentPath = '') => {
     if (definition === mongoose.Schema.Types.ObjectId) {
       objectIdFields.push(currentPath);
     } else if (Array.isArray(definition)) {
-      const arrayElement = definition[0];
+      const arrayElement = definition[0] instanceof mongoose.Schema ? definition[0].obj : definition[0];
       if (typeof arrayElement === 'object' && arrayElement !== null) {
         objectIdFields.push(...findObjectIdFields(arrayElement, currentPath));
       }

package/src/mongo/queries.js

@@ -9,7 +9,7 @@ import mongoose from 'mongoose';
 
 import { SimfinityError, QLOperator, paginationStages } from '@simtlix/simfinity-core';
 import {
-  getFieldStorageName, getListShape, hasStoredIdentity, normalizeConnectionField,
+  getFieldStorageName, getListShape, hasStoredIdentity, isVirtualField, normalizeConnectionField,
 } from '@simtlix/simfinity-core/internal/relation-storage';
 
 import { castObjectId } from './ids.js';
@@ -140,6 +140,12 @@ const resolveQueryPath = (gqltype, path, aggregationsIncluded) => {
   for (const [index, part] of parts.entries()) {
     const field = Object.hasOwn(currentType.getFields(), part) ? currentType.getFields()[part] : null;
     if (!field) throw filterError(`Unknown query field: ${path}`, 'INVALID_FILTER_FIELD');
+    // Core rejects generated and trusted paths through a virtual field before the adapter runs. A
+    // native buildQuery() or buildFilterGroupMatch() call fails here, instead of matching storage
+    // that does not exist.
+    if (isVirtualField(field)) {
+      throw filterError(`Query path ${path} uses the virtual field ${currentType.name}.${part}, which is not stored`, 'INVALID_FILTER_FIELD');
+    }
     const fieldType = getNamedType(field.type);
     const relation = field.extensions?.relation;
     if (fieldType instanceof GraphQLObjectType) {

package/types/index.d.ts

@@ -46,6 +46,8 @@ export type {
   ScopeParams,
   TypePermissions,
   TypeScopes,
+  VirtualFieldDeclaration,
+  VirtualFieldOptions,
 } from '@simtlix/simfinity-core';
 export * from '@simtlix/simfinity-mcp';
 export { default as mcp } from '@simtlix/simfinity-mcp';
@@ -163,6 +165,13 @@ export function addNoEndpointType(gqltype: GraphQLObjectType): void;
  * Embedded types that contain each other throw INVALID_MODEL (400, `Embedded cycle at …`) when a
  * generated model's embedded fields reach them, and always in transactional mode; in default mode a
  * cycle that only supplied models reach is not checked.
+ * Invalid virtual field declarations (`extensions.virtual`, see `VirtualFieldOptions`) throw
+ * INVALID_MODEL (400) before models are created, in both referentialIntegrity modes. A virtual field
+ * gets no path, `[]` default or index in generated models, on entities and embedded types, and no
+ * entry in the transactional integrity registry, so it needs no `relation` in either mode; generated
+ * writes never set or unset it. A supplied model keeps the paths it declares. A readOnly field with
+ * arguments and its own resolver that is not virtual, and is not a reference or collection, logs a
+ * `Configuration issue` warning once.
  * A generated input that would have no fields is left out with a warning, together with the
  * collection operation, embedded field or add/update/state-action mutation that would take it; a
  * non-null embedded field whose embedded type has no writable fields throws INVALID_MODEL (400)
@@ -296,6 +305,7 @@ export interface FilterGroupInput {
  * pipeline. `input.aggregation` filters a field named `aggregation`; the aggregate stage is never
  * built here. An embedded `.id` path uses the declared `id` member, except for entity types embedded
  * as lists and supplied subdocument schemas without an `id` path, which use the subdocument `_id`.
+ * A filter, condition or sort path through a virtual field rejects with `INVALID_FILTER_FIELD` (400).
  */
 export function buildQuery(
   input: Record<string, any>,
@@ -303,7 +313,10 @@ export function buildQuery(
   isCount?: boolean,
 ): Promise<Array<Record<string, any>>>;
 
-/** Translate a QLFilterGroup into a MongoDB `$match` expression, collecting required lookups. */
+/**
+ * Translate a QLFilterGroup into a MongoDB `$match` expression, collecting required lookups. A
+ * condition path through a virtual field rejects with `INVALID_FILTER_FIELD` (400).
+ */
 export function buildFilterGroupMatch(
   filterGroup: FilterGroupInput,
   gqltype: GraphQLObjectType,