vuec8
TypeScript icon, indicating that this package has built-in type declarations

0.0.4 • Public • Published

VueC8

Introduction

VueC8 is a small and pragmatic solution to create real time bindings between a Macrometa data platform (C8) and your Vue application. Making it straightforward to always keep your local data in sync with remotes databases.

Why

While JSC8 does provide an API to keep your local data in sync with any changes happening in the remote database, it is more tedious. Here is the code you need to write to keep your local state in sync with C8DB without using Vuec8. Let's take the example of binding a collection.

To explore more you can visit jsc8_tutorial

Fabric = require('jsc8')
fabric = new Fabric("MY-Macrometa-URL");
...
...
fabric.login(email, password)
          .then(() => {
}
...
...

new Vue({
	data: () => ({
		todo: []
	}),
	created() {
		fabric.query(`C8QL query`)
    		.then((cursor: ArrayCursor) => {
				this.todo= cursor
			});
		const subscription = fabric.collection('Collection Name');

		subscription.onchange({
			onmessage:function onchange(documentMsg){
				// Write logic here to manage the updated document
			}
		},
		URL);
		},
	//manage unsubscribe onDestroy.
})

Now let's look at the equivalent code with vuec8:

Vue.use(vuec8, {
        auth: {
		  email: 'EMAIL',
          password: 'PASSWORD',
        },
        config: 'URL OR CONFIG obj',
      })

new Vue({
	el: '#app',
	data: {
		todo: [],
	},
	c8db: {
		todo: 'collectionName',
	},
})

## Download and Install JavaScript Client

Installation

In order to get started make sure to install the latest version of vuec8

yarn add vuec8
## - or - 
npm install vuec8

Or from source

git clone https://github.com/macrometacorp/vuec8.git
cd VueC8
npm install
npm run build

Plugin

VueC8 must be installed as a Vue plugin

import { vuec8 } from "vuec8";

Vue.use(vuec8, {
        auth: {
		  email: 'EMAIL',
          password: 'PASSWORD',
        },
        config: 'URL OR CONFIG obj',
      })

API

1. Plugin Options

{
  "auth": {
    "email": "EMAIL",
    "password": "PASSWORD",
  },
  "fabricName": "fabricName",
  "config": "url"
}
  • config : string or string[] or Config

2. Vue component Macrometa database (C8DB) is injected into your vue object, you can assign c8db a object or a function which returns a object. object keys should be same as the keys defined in your vue data object and the values should be of Type

string | {
      collection: string;
      filter?: Array<{
                      fieldPath: string;
                      opStr: "<" | "<=" | "==" | ">=" | ">";
                      value: any;
                    }>;
      documentId?: string;
      fabricName?: string;
    }
  • fabricName If fabric name is not assigned it will use the fabricName assigned in Plugin options, if fabricName in plugin options is also not assigned it will take as default fabricName (_system)

  • filter will AND the conditions together. eg: [{//condition 1},{ //condition 2}] : FILTER condition 1 AND condition 2

  • documentId if documentId is assigned it will fetch a specific document in a collection.

new Vue{
...
    data:{
        todo:[],
    },
    c8db:{
        todo: "collection"
    },
...
}

or

new Vue{
...
    data:{
        todo:[],
    },
    c8db:{
        todo: {
        fabricName: "fabric",
        collection : "collection",
        filter:[{
                    fieldPath: "value",
                    opStr: "<",
                    value: 5
            }]
        }
    },
...
}

3. c8Refs

  • vuec8 adds c8Refs in every component where c8db is initialized. c8Refs will have reference to you collection & fabric instance for the a every data key referenced in Macrometa platform. jsc8 has complete guide on fabric & collection instance.
new Vue{
...
    data:{
        todo:[],
    },
    c8db:{
        todo: "collection"
    },
    updated(){
      // It can be used to handle customized behavior.
        this.$c8Refs.todo._collection // collection reference for todo
        this.$c8Refs.todo._fabric // fabric reference for tod
    },
...
}

Package Sidebar

Install

npm i vuec8

Weekly Downloads

1

Version

0.0.4

License

Apache-2.0

Unpacked Size

848 kB

Total Files

17

Last publish

Collaborators

  • rachitpsolanki