Add metadata

[TimoBechtel]

What

Implement a way to add metadata to nodes.

So instead of having a child node directly under each node, e.g.

{
  my: {
     pathTo: {
       some: "value"
     }
   }
}

we'd have an object representing each node:

{
  my: {
    meta: {
      created: "created timestamp",
      owner: "some user id"
    },
    value: {
      pathTo: {
        meta: {},
        value: {
          some: {
            meta: {},
            value: "value"
          }
        }
      }
    }
  }
}

Or as an array maybe?

{
  my: [
    {
      created: "created timestamp",
      owner: "some user id"
    },
    {
      pathTo: []
    }
  ]
}

Why

Currently there is no way to add metadata. To add plugin support, we need some way to add metadata.

This would allow us to add a hole range of new features, like adding a timestamp, a permission / ownership system and more.

[TimoBechtel]

Ok, so there are two ideas of adding/manipulating metadata, which is going to be synchronized between clients:

1. using set:

db.get('path').set('mydata', {type: 'array'});

db.get('path').set('myotherdata', permissions({user: "rw"});

With this approach, it's a little awkward, when you want to set metadata without actually changing data, because then you need to "set" an empty object:

db.get('path').set({}, permissions({user: "r"});

2. adding a method with:

db.get('path').with(permissions({user: "r"}).set('mydata');

And if you only want to change metadata without changing the actual data:

db.get('path').with(permissions({user: "r"}).set();

However, with can also be used in combination with plugins to set a specific context.
'plugin context' and 'meta data' should be considered separat, as the plugin context is only used locally by plugins and the meta data is synchronized across clients. See #8

---

EDIT: moved 2. with modifier function to separate issue: #15

[github-actions]

🎉 This issue has been resolved in version 3.2.0 🎉

The release is available on:

• npm package (@next dist-tag)
• GitHub release

Your semantic-release bot 📦🚀