Record<string, string> as valid query select argument

[sderrow]

Summary

A Record<string, string> is a valid argument to Query.select, but Typescript currently rejects it since it doesn't overlap with string | string[] | Record<string, number | boolean | object>.

Examples

import mongoose from "mongoose";

export const selectTypeTest = async (): Promise<void> => {
  type Test = {
    _id: mongoose.Types.ObjectId;

    testProp: string;

    createdAt: number;
    updatedAt: number;
  };

  const schema = new mongoose.Schema<Test>(
    {
      testProp: { type: String },
      createdAt: { type: Number },
      updatedAt: { type: Number },
    },
    {
      timestamps: { currentTime: () => new Date().valueOf() },
    }
  );

  const M = mongoose.model<Test>("Test", schema);

  await M.create({ testProp: "hello" });

  const myDoc = await M.findOne({}).select({ _id: 0, renamed: "$testProp" }).lean().exec();

  /*
  myDoc successfully returns { renamed: "hello" }

  But we get the following Typescript error anyway:

  Argument of type '{ _id: number; renamed: string; }' is not assignable to parameter of type 'string | string[] | Record<string, number | boolean | object>'.
  Types of property 'renamed' are incompatible.
    Type 'string' is not assignable to type 'number | boolean | object | undefined'.
  */
};