Typescript types don't support dot syntax for $pull

[fschucht]

Do you want to request a feature or report a bug?
Bug

What is the current behavior?
Using findOneAndUpdate, findByIdAndUpdate, updateOne or updateMany with the $pull operator and dot syntax causes a Typescript compilation error. The syntax itself works both with mongoose (if the typescript error is silenced) and within the mongo console. Using a nested object does not work in this case as it's not supported my mongo.

If the current behavior is a bug, please provide the steps to reproduce.

import { ObjectId } from 'mongodb';
import mongoose, { Document, Schema } from 'mongoose';

interface ActorInterface {
  type: string;
  id: ObjectId;
}

interface TagInterface {
  value: string;
  actor: ActorInterface;
}

interface PostInterface extends Document {
  tags: TagInterface[]
}

const postSchema = new Schema({
  tags: [{
    value: String,
    actor: {
      type: String,
      id: Schema.Types.ObjectId
    }
  }]
})

const postModel = mongoose.model<PostInterface>('Post', postSchema)

function removeTagsByActor(postId: ObjectId, actorId: ObjectId) {
  return postModel.findOneAndUpdate({
    _id: postId
  }, {
    $pull: {
      tags: {
        'actor.id': actorId // <-- compilation error
      }
    }
  })
}

Resulting error:

Type '{ 'actor.id': any; }' is not assignable to type 'Partial<Pick<Pick<_LeanDocument<TagInterface>, "value" | "actor">, "value" | "actor">> | { value?: QuerySelector<string> | undefined; actor?: QuerySelector<...> | undefined; } | undefined'.
  Object literal may only specify known properties, and ''actor.id'' does not exist in type 'Partial<Pick<Pick<_LeanDocument<TagInterface>, "value" | "actor">, "value" | "actor">> | { value?: QuerySelector<string> | undefined; actor?: QuerySelector<...> | undefined; }'.ts(2322)

tsconfig.json:

{
  "compilerOptions": {
    "module": "commonjs",
    "resolveJsonModule": true,
    "declaration": true,
    "removeComments": true,
    "emitDecoratorMetadata": true,
    "experimentalDecorators": true,
    "noImplicitAny": false,
    "noImplicitThis": false,
    "strictNullChecks": true,
    "allowSyntheticDefaultImports": true,
    "strictPropertyInitialization": false,
    "strictBindCallApply": true,
    "strictFunctionTypes": false,
    "target": "es2017",
    "sourceMap": true,
    "outDir": "./dist",
    "baseUrl": "./",
    "incremental": true,
    "typeRoots": [
      "./typings",
      "./node_modules/@types"
    ],
    "esModuleInterop": true,
  },
  "exclude": [
    "node_modules",
    "dist",
    "./typings"
  ]
}

What is the expected behavior?
There should be no compilation error and the dot syntax should be allowed.

What are the versions of Node.js, Mongoose and MongoDB you are using? Note that "latest" is not a version.

• Mongoose: 8.11.18
• Node.js: 12.8.0
• Typescript: 4.1.3

[AntoRin]

Were you able to find a solution? I just ran into this error, and have no idea why this happens.

[fschucht]

@AntoRin We updated to version 5.12.0 which solved the issue for us.

[AntoRin]

@AntoRin We updated to version 5.12.0 which solved the issue for us.

Thanks for responding, @fschucht . I myself am using 5.12.2, but the problem persists. The transpiled build works without any problem, so I guess I should just ignore the error.