Misleading types in the example from the docs when calling insertOne

[vitaliy-grusha]

Code Editor: VSCode latest
Typescript version: 4.9.5

Code:

import Papr, { types, schema } from './index';
const papr = new Papr();

const userSchema = schema({
  age: types.number(),
  firstName: types.string({ required: true }),
  lastName: types.string({ required: true }),
});
const UserModel = papr.model('users', userSchema);

async function insert() {
  const test = await UserModel.insertOne({
    firstName: 'John',
  });
  return test;
}

The schema defines firstName and lastName as required fields, but in the argument doc in insertOne whose fields are optional:

This can be temporarily fixed by providing an empty object for the defaults option in the schema:

const userSchema = schema({
  age: types.number(),
  firstName: types.string({ required: true }),
  lastName: types.string({ required: true }),
}, { defaults: {} });

It's better to somehow fix this in the types, perhaps by removing Partial from DocumentForInsertWithoutDefaults, which would result in this:

export type DocumentForInsertWithoutDefaults<TSchema, TDefaults extends Partial<TSchema>> = Omit<
  OptionalId<TSchema>,
  keyof TDefaults
> &
 Pick<TSchema, keyof TDefaults & keyof TSchema>;

Could this change break any logic? All tests are passing.

[joshuat]

It actually seems to be resolved by adding an empty object to options, not necessarily options.defaults. Very odd, definitely worth investigating further.