feat(insert): adds custom ID capabilities

[micheleriva]

Highly requested feature, will solve both #220 and #112.

By default, Lyra will check if a field id exists in the document we're trying to insert:

insert(db, {
  id: 'foo-0123', // Will use this ID
  user: 'mitch'
})

if the id field does not exist, it will generate a random one.

We can also override the default id field by passing a function to the insert configuration:

insert(db, {
  id: 'foo-0123',
  user: 'mitch'
}, {
  id: (doc /* the entire document */) => `${doc.user}.01`
})

in that case, the id will be mitch.01. The id configuration function can be either sync or async.

[ShogunPanda]

LGTM!

[vassbence]

In the second example is it required to have the id prop on the doc?

[micheleriva]

In the second example is it required to have the id prop on the doc?

@vassbence nope, as it will get overwritten by the function 🙂 it's only needed if defined in the schema definition

[Zombobot1]

Looks great!