@prisma-next/mongo-query-builder 0.5.0-dev.5 → 0.5.0-dev.50

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "@prisma-next/mongo-query-builder",
-  "version": "0.5.0-dev.5",
+  "version": "0.5.0-dev.50",
   "type": "module",
   "sideEffects": false,
   "description": "Type-safe MongoDB query builder (reads, writes, find-and-modify, pipeline-terminal writes) with document shape tracking",
   "dependencies": {
-    "@prisma-next/mongo-contract": "0.5.0-dev.5",
-    "@prisma-next/contract": "0.5.0-dev.5",
-    "@prisma-next/mongo-query-ast": "0.5.0-dev.5",
-    "@prisma-next/mongo-value": "0.5.0-dev.5"
+    "@prisma-next/contract": "0.5.0-dev.50",
+    "@prisma-next/mongo-query-ast": "0.5.0-dev.50",
+    "@prisma-next/utils": "0.5.0-dev.50",
+    "@prisma-next/mongo-contract": "0.5.0-dev.50",
+    "@prisma-next/mongo-value": "0.5.0-dev.50"
   },
   "devDependencies": {
     "tsdown": "0.18.4",

package/src/builder.ts

@@ -3,6 +3,7 @@ import type {
   ExtractMongoCodecTypes,
   MongoContract,
   MongoContractWithTypeMaps,
+  MongoModelDefinition,
   MongoTypeMaps,
 } from '@prisma-next/mongo-contract';
 import type {
@@ -14,6 +15,7 @@ import type {
   MongoPipelineStage,
   MongoProjectionValue,
   MongoQueryPlan,
+  MongoResultShape,
   MongoUpdatePipelineStage,
   MongoWindowField,
   UpdateResult,
@@ -54,9 +56,12 @@ import {
   UpdateManyCommand,
   UpdateOneCommand,
 } from '@prisma-next/mongo-query-ast/execution';
+import { ifDefined } from '@prisma-next/utils/defined';
 import { createFieldAccessor, type Expression, type FieldAccessor } from './field-accessor';
 import type { FindAndModifyEnabled, LeadingMatch, UpdateEnabled } from './markers';
+import { pipelineSupportsFlatResultShape } from './pipeline-result-shape';
 import type { NestedDocShape } from './resolve-path';
+import { contractModelToMongoResultShape } from './result-shape';
 import type {
   DocField,
   DocShape,
@@ -75,6 +80,7 @@ interface PipelineChainState {
   readonly collection: string;
   readonly stages: ReadonlyArray<MongoPipelineStage>;
   readonly storageHash: string;
+  readonly modelName?: string;
 }
 
 /**
@@ -148,7 +154,6 @@ export class PipelineChain<
       target: 'mongo',
       storageHash: this.#state.storageHash,
       lane: 'mongo-query',
-      paramDescriptors: [],
     };
   }
 
@@ -509,7 +514,6 @@ export class PipelineChain<
       target: 'mongo',
       storageHash: this.#state.storageHash,
       lane: 'mongo-query',
-      paramDescriptors: [],
     };
     return { collection: this.#state.collection, command, meta };
   }
@@ -767,7 +771,6 @@ export class PipelineChain<
       target: 'mongo',
       storageHash: this.#state.storageHash,
       lane: 'mongo-query',
-      paramDescriptors: [],
     };
     return { collection: this.#state.collection, command, meta };
   }
@@ -788,7 +791,6 @@ export class PipelineChain<
       target: 'mongo',
       storageHash: this.#state.storageHash,
       lane: 'mongo-query',
-      paramDescriptors: [],
     };
     return { collection: this.#state.collection, command, meta };
   }
@@ -804,9 +806,24 @@ export class PipelineChain<
       target: 'mongo',
       storageHash: this.#state.storageHash,
       lane: 'mongo-query',
-      paramDescriptors: [],
     };
-    return { collection: this.#state.collection, command, meta };
+    const modelName = this.#state.modelName;
+    const contractNarrow = this.#contract as MongoContract;
+    let resultShape: MongoResultShape | undefined;
+    if (modelName !== undefined) {
+      if (pipelineSupportsFlatResultShape(this.#state.stages)) {
+        const model = contractNarrow.models[modelName] as MongoModelDefinition | undefined;
+        resultShape = model ? contractModelToMongoResultShape(model) : { kind: 'unknown' as const };
+      } else {
+        resultShape = { kind: 'unknown' as const };
+      }
+    }
+    return {
+      collection: this.#state.collection,
+      command,
+      meta,
+      ...ifDefined('resultShape', resultShape),
+    };
   }
 
   /**

package/src/exports/index.ts

@@ -25,6 +25,10 @@ export type {
   ResolvePath,
   ValidPaths,
 } from '../resolve-path';
+export {
+  contractFieldToMongoFieldShape,
+  contractModelToMongoResultShape,
+} from '../result-shape';
 export { CollectionHandle, FilteredCollection } from '../state-classes';
 export type {
   ArrayField,

package/src/pipeline-result-shape.ts

@@ -0,0 +1,15 @@
+import type { MongoPipelineStage } from '@prisma-next/mongo-query-ast/execution';
+
+const identityStageKinds = new Set(['match', 'sort', 'limit', 'skip', 'sample']);
+
+export function pipelineSupportsFlatResultShape(
+  stages: ReadonlyArray<MongoPipelineStage>,
+): boolean {
+  for (const stage of stages) {
+    const k = stage.kind;
+    if (!identityStageKinds.has(k)) {
+      return false;
+    }
+  }
+  return true;
+}

package/src/query.ts

@@ -47,7 +47,6 @@ export function mongoQuery<
         target: 'mongo',
         storageHash: String(storageHash),
         lane: 'mongo-query',
-        paramDescriptors: [],
       };
       return { collection: command.collection, command, meta };
     },

package/src/result-shape.ts

@@ -0,0 +1,63 @@
+import type { ContractField } from '@prisma-next/contract/types';
+import type { MongoModelDefinition } from '@prisma-next/mongo-contract';
+import type { MongoFieldShape, MongoResultShape } from '@prisma-next/mongo-query-ast/execution';
+import {
+  freezeMongoFieldShape,
+  freezeMongoResultShape,
+} from '@prisma-next/mongo-query-ast/execution';
+
+export function contractFieldToMongoFieldShape(field: ContractField): MongoFieldShape {
+  const { type, nullable, many } = field;
+  if (type.kind === 'valueObject' || type.kind === 'union') {
+    return Object.freeze({ kind: 'unknown' as const });
+  }
+  if (type.kind !== 'scalar') {
+    return Object.freeze({ kind: 'unknown' as const });
+  }
+  if (field.dict === true) {
+    return Object.freeze({ kind: 'unknown' as const });
+  }
+  if (many === true) {
+    return freezeMongoFieldShape({
+      kind: 'array',
+      nullable,
+      element: { kind: 'leaf', codecId: type.codecId, nullable: false },
+    });
+  }
+  return freezeMongoFieldShape({
+    kind: 'leaf',
+    codecId: type.codecId,
+    nullable,
+  });
+}
+
+export function contractModelToMongoResultShape(
+  model: MongoModelDefinition,
+  options?: {
+    readonly selection?: readonly string[];
+    readonly includeRelationNames?: readonly string[];
+  },
+): MongoResultShape {
+  const fields: Record<string, MongoFieldShape> = {};
+  for (const rel of options?.includeRelationNames ?? []) {
+    fields[rel] = Object.freeze({ kind: 'unknown' as const });
+  }
+  const modelFields = model.fields;
+  // An explicit empty selection is honored as-is (returns a document shape
+  // with no fields). Only the absence of a selection falls back to the model's
+  // full field set.
+  const keys = options?.selection !== undefined ? options.selection : Object.keys(modelFields);
+
+  for (const key of keys) {
+    if (Object.hasOwn(fields, key)) {
+      continue;
+    }
+    const cf = modelFields[key];
+    if (!cf) {
+      fields[key] = Object.freeze({ kind: 'unknown' as const });
+      continue;
+    }
+    fields[key] = contractFieldToMongoFieldShape(cf);
+  }
+  return freezeMongoResultShape({ kind: 'document', fields });
+}

package/src/state-classes.ts

@@ -71,7 +71,6 @@ function writeMeta(storageHash: string): PlanMeta {
     target: 'mongo',
     storageHash,
     lane: 'mongo-query',
-    paramDescriptors: [],
   };
 }
 
@@ -110,6 +109,7 @@ export class CollectionHandle<
       collection: ctx.collection,
       stages: [],
       storageHash: ctx.storageHash,
+      modelName: modelName as string,
     });
     this.#ctx = ctx;
     this.#modelName = modelName;
@@ -346,6 +346,7 @@ export class FilteredCollection<
       collection: ctx.collection,
       stages: [new MongoMatchStage(leading)],
       storageHash: ctx.storageHash,
+      modelName: modelName as string,
     });
     this.#ctx = ctx;
     this.#modelName = modelName;