vue-api-queries v1.2.1

Vue Api Queries.

🔥 If you use Laravel, this package matches perfectly with andersao/l5-repository.

This package helps you quickly to build requests for REST API. Move your logic and backend requests to dedicated classes. Keep your code clean and elegant.

Wouldn't it be great if you could just use your back end to validate forms on the front end? This package provides a BaseProxy class that does exactly that. It can post itself to a configured endpoint and manage errors. The class is meant to be used with a Laravel back end, and it doesn't limit that you need only to work with laravel, Ruby on Rail, NodeJs, ExpressJs, or any other languages.

Take a look at the usage section to view a detailed example on how to use it.

Install

You can install the package via yarn (or npm):

npm install vue-api-queries

yarn add vue-api-queries

Usage

import Vue from 'vue'
import VueApiQueries from 'vue-api-queries'

Vue.use(VueApiQueries)

Nuxt Support

Put it on top of axios module

export default {
  modules: [
    // simple usage
    'vue-api-queries/nuxt',
    // With options
    ['vue-api-queries/nuxt', { errorProperty: 'errors', blockDuplicate: false }],
    '@nuxtjs/axios',
  ],
  apiQueries: { errorProperty: 'errors', blockDuplicate: false },
}

Options

If blockDuplicate enabled, the default option of axios-duplicate-blocker will be:

{
  blockDuplicate: false
  debug: true
  onPageChange: true
  blockByDefault: true
  headerBlockerKey: ''
}

you can overwrite it, by adding in config above.

Note:

baseURL is required.

You can define baseURL at .env just one of them

API_URL=http://localhost::3000/api
API_HOST=http://localhost::3000/api

if your axios already defined in nuxt.config.js

export default {
  axios: {
    baseURL: process.env.API_URL
  }
}

Advance usage

-------------- Todo --------------

Vue plugins

import Vue from 'vue'
import VueApiQueries from 'vue-api-queries'

Vue.use(VueApiQueries)

Note

Error response must look like: or base on errorProperty from config

{
  "errors": {
    "field": [
      "The field is required."
    ]
  }
}

It will create $errors object inside components.

Methods are available:

Using with Vuex

1.Create proxies folder or your prefer folder name for this

~/proxies/NewsProxy.js

import { BaseProxy } from 'vue-api-queries'

class NewsProxy extends BaseProxy {
  constructor(parameters = {}) {
    super('news', parameters)
  }
}

export default NewsProxy

2.Store

• Create news store

1. actions.js
2. getters.js
3. mutation-types.js
4. mutations.js
5. state

actions.js

import { ALL } from './mutation-types'
import { NewsProxy } from '~/proxies'
import { BaseTransformer, PaginationTransformer } from 'vue-api-queries'
import { pagination, notify } from '~/utils'

const proxy = new NewsProxy()

const all = async ({ commit, dispatch }, payload = {}) => {
  const { fn } = payload
  if (typeof fn === 'function') {
    await fn(proxy)
  }
  try {
    const { data, meta } = await proxy.all()
    const all = {
      items: BaseTransformer.fetchCollection(data),
      pagination: PaginationTransformer.fetch(meta)
    }
    await commit(ALL, all)
  } catch (e) {
    const data = { items: [], pagination }
    await commit(ALL, data)
    await notify({ response: e })
  }
}

export default {
  all
}

getters.js

export default {
  all: (state) => state.all
}

mutation-types.js

export const ALL = 'ALL'

export default { ALL }

mutations.js

import { ALL } from './mutation-types'

export default {
  [ALL](state, payload = {}) {
    const { items = [], pagination = {} } = payload
    state.all = items
    state.pagination = pagination
  }
}

state.js

export default () => ({
  all: [],
  pagination: {}
})

How to call in components or pages

• news.vue pages

It can be called in mounted() or asyncData()

• asyncData()

export default {
  async asyncData({ app, store }) {
    const { id = null } = app.$auth.user
    await store.dispatch('news/all', {
      fn: (proxy) => {
        proxy
          .setParameters({
            userId: id,
            include: ['categories']
          })
          .removeParameters(['page', 'limit'])
      }
    })
  }
}

• mounted()

export default {
  mounted() {
    const { id = null } = this.$auth.user
    this.$store.dispatch('news/all', {
      fn: (proxy) => {
        proxy
          .setParameters({
            userId: id,
            include: ['categories']
          })
          .removeParameters(['page', 'limit'])
      }
    })
  }
}

You can set or remove any parameters you like.

Proxy's methods are available

setParameters()

Set parameters with key/value.

Note: If you to pass query string as object that can be response like object format at api side.

Example

const proxy = new ExampleProxy()
const parameters = {
  search: {
    first_name: 'Sek',
    last_name: 'Chantouch'
  },
  page: {
    limit: 20,
    offset: 1
  },
  order: {
    first_name: 'ASC',
    last_name: 'DESC'
  },
  category_id: 6
}
const { data } = proxy.setParameters(parameters).all()
this.data = data

Note: Query object above will transform into query string like:

https://my-web-url.com?search[first_name]=Sek&search[last_name]=Chantouch&page[limit]=10&page[offset]=1&order[first_name]=asc&order[last_name]=desc&category_id=6

if setParameter that value is empty or null it will remove that param for query string

setParameter()

Example 1

const proxy = new ExampleProxy()
const { data } = await proxy.setParameter('page', 1).all()
this.data = data

Expected will be:

{
  "page": 1
}

Example 2

const proxy = new ExampleProxy()
const queryString = 'limit=10&page=1&search[name]=hello'
const { data } = await proxy.setParameter(queryString).all()
this.data = data

Expected will be:

{
  "limit": 10,
  "page": 1,
  "search": {
    "name": "hello"
  }
}

Be sure to use only once in mounted() or asyncData() and asyncData() is only available in NuxtJs

Use proxy in components

• news/_id.vue pages

import { NewsProxy } from '~/proxies'

const proxy = new NewsProxy()

export default {
  methods: {
    async fetchNews(id) {
      try {
        const { data } = await proxy.find(id)
        this.detail = data
      } catch (e) {
        console.log(e)
      }
    }
  },
  mounted() {
    this.fetchNews(this.$route.params.id)
  }
}

Validations

Can use vue-vlidator for client-side validator that inspired by Laravel. Chantouch/vue-vlidator

Errors methods available

It can be called by this.$errors.**

How to use in vue component

<template>
  <v-form v-model='valid' lazy-validation @keydown.native='$errors.onKeydown' @submit.prevent='submit'>
    <v-container>
      <v-row>
        <v-col cols='12' md='4'>
          <v-text-field
            v-model='firstname'
            :error-messages="$errors.first(['firstname'])"
            :counter='10'
            label='First name'
            required
            name='firstname'
          />
        </v-col>
        <v-col cols='12' md='4'>
          <v-text-field
            v-model='lastname'
            :counter='10'
            label='Last name'
            required
            :error-messages="$errors.first(['lastname'])"
          />
        </v-col>
        <v-col cols='12' md='4'>
          <v-text-field
            v-model='email'
            :counter='10'
            label='Email'
            required
            :error-messages="$errors.first('email')"
          />
        </v-col>
        <v-col cols='12' md='4'>
          <v-text-field v-model='email' label='E-mail' required />
        </v-col>
      </v-row>
    </v-container>
  </v-form>
</template>
<script>
export default {
  data: () => ({
    valid: false,
    firstname: '',
    lastname: '',
    email: '',
  }),
  methods: {
    submit() {
      this.$axios.$post('/account/create', {
        firstname: this.firstname,
        lastname: this.lastname,
        email: this.email
      })
    }
  },
  beforeDestroy() {
    this.$errors.flush()
  }
}
</script>

Contact

Email: chantouchsek.cs83@gmail.com

Twitter @DevidCs83