@vdsbenoit thanks for finding this!

So I have typed the modifyReadResponseOn.added function kind of weirdly:

/**
 * Can be used to modify docs that come in from 'stream' or 'fetch' actions, before they are added to your store data. When returning `undefined` they will be discarded & won't be added to the store data.
 */
export type OnAddedFn = (docData: Record<string, any> | undefined, docMetadata: DocMetadata) => Record<string, any> | void

see source code at:

• https://github.com/cycraft/magnetar/blob/production/packages/core/src/types/modifyReadResponse.ts/#L3-L7

But I don't think we should ever execute the modifyReadResponseOn.added fn when the payload is undefined.

Changing my underlying type to this will fix the issue:

/**
 * Can be used to modify docs that come in from 'stream' or 'fetch' actions, before they are added to your store data. When returning `undefined` they will be discarded & won't be added to the store data.
 */
export type OnAddedFn = (docData: Record<string, any>, docMetadata: DocMetadata) => Record<string, any> | void

So I will do this somewhere this week after checking this won't cause issues.

In the meanwhile you can fix the issue on your end with a workaround of adding a simple ? in the defaults fn payload like so:

export function pokemonDefaults(payload?: Partial<Pokemon>): Pokemon {
  const defaults: Pokemon = { name: '', nickName: '', id: '', level: 0 }

  return { ...defaults, ...payload }
}

see the payload?: : ) that's the workaround that should work for now

Thanks a lot for your quick reply ! I'll try that

@vdsbenoit you can now define the type of your document when inserting separately from the type of your module doc.

 const pokedexModule = magnetar.collection<Pokemon, { insert: Partial<Pokemon> }>('pokedex', 
  modifyPayloadOn: { insert: pokemonDefaults },
  modifyReadResponseOn: { added: pokemonDefaults },
})

this will make it so executing pokedexModule.insert({ name: 'bulbasaur' }) won't cause any issue if this is only a partial of your document.

Does this help you further?

@vdsbenoit on [email protected] I have changed the logic so modifyReadResponseOn.added is no longer executed when a fetch call returns no document.

This means that there is no possibility that the payload of modifyReadResponseOn.added is undefined anymore.

This means that the documentation example is now possible without type issues.

workaround: pokemonDefaults(payload?: Partial<Pokemon>): is no longer needed, you can use pokemonDefaults(payload: Partial<Pokemon>): without the ? again! 🎉

let me know if you have any further issues.

Hi @mesqueeb,

Thanks a lot for the support! Unfortunately, I am no longer working on this personal project for the moment. But I will hopefully get back to it in a couple of months. While I am confident you have fixed my problem, I will get back to you if I still face any issues.

Cheers,

Benoit

Hi,

I'm diving into my side project again (it's for an event that takes place once a year). I upgraded magnetar from 0.5.4 to 0.11.4. I confirm the issue is resolved! Thanks again for your support !