feat: 🚀 added is plain object function helpers

Author: chantouchsek

jest.config.js

@@ -7,8 +7,8 @@ module.exports = {
     global: {
       lines: 100,
       functions: 100,
-      branches: 91.25,
-      statements: 99.68,
+      branches: 90,
+      statements: 99,
     },
   },
   testEnvironment: 'node',

nuxt/index.js

@@ -4,9 +4,10 @@ module.exports = function nuxtVueApiQueriesModule(moduleOptions = {}) {
   const { apiQueries = {} } = this.options
   const options = Object.assign({}, moduleOptions, apiQueries)
   this.addPlugin({
+    options,
+    ssr: true,
     src: resolve(__dirname, './templates/plugin.js'),
     fileName: join('vue-api-queries.js'),
-    options,
   })
   this.options.build.transpile.push(/^escape-string-regexp/)
 }

nuxt/templates/plugin.js

@@ -1,10 +1,10 @@
 import Vue from 'vue'
 import VueApiQueries, { Validator } from 'vue-api-queries'
 
-const options = <%= serialize(options) %> || {}
-const { errorProperty, parsedQs } = options
+const errorProperty = '<%= options.errorProperty %>'
+const parsedQs = '<%= options.parsedQs %>'
 
 export default function ({ $axios }, inject) {
-  Vue.use(VueApiQueries, { errorProperty, axios: $axios, parsedQs })
+  Vue.use(VueApiQueries, { errorProperty, $axios, parsedQs })
   inject('errors', Validator)
 }

src/__tests__/object.test.ts

@@ -1,4 +1,10 @@
-import { isFile, cloneDeep, hasOwnProperty, merge } from '../util'
+import {
+  isFile,
+  cloneDeep,
+  hasOwnProperty,
+  merge,
+  isPlainObject,
+} from '../util'
 
 describe('Object Test', () => {
   // const { window, File } = global
@@ -45,4 +51,26 @@ describe('cloneDeep', () => {
     const merged = { email: 'chantouchsek.cs83@gmail.com', name: 'Chantouch' }
     expect(merge(obj1, obj2)).toEqual(merged)
   })
+  it('should return `true` if the object is created by the `Object` constructor.', () => {
+    expect(isPlainObject(Object.create({}))).toBeTruthy()
+    expect(isPlainObject(Object.create(Object.prototype))).toBeTruthy()
+    expect(isPlainObject({ foo: 'bar' })).toBeTruthy()
+    expect(isPlainObject({})).toBeTruthy()
+    expect(isPlainObject(Object.create(null))).toBeTruthy()
+  })
+  it('should return `false` if the object is not created by the `Object` constructor.', () => {
+    function Foo(this: any) {
+      this.abc = {}
+    }
+    expect(isPlainObject(/foo/)).toBeFalsy()
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    expect(isPlainObject(function () {})).toBeFalsy()
+    expect(isPlainObject(1)).toBeFalsy()
+    expect(isPlainObject(['foo', 'bar'])).toBeFalsy()
+    expect(isPlainObject([])).toBeFalsy()
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    expect(isPlainObject(new Foo())).toBeFalsy()
+    expect(isPlainObject(null)).toBeFalsy()
+  })
 })

src/index.ts

@@ -19,7 +19,7 @@ class VueApiQueries {
     allowDots: true,
     ignoreQueryPrefix: true,
   }
-  install(Vue: typeof _Vue, options: any = {}) {
+  install(Vue: typeof _Vue, options: Record<string, any> = {}) {
     if (this.installed) return
     this.installed = true
     const defaultOption = merge(
@@ -29,8 +29,8 @@ class VueApiQueries {
       },
       options,
     )
-    const { axios, errorProperty, parsedQs } = defaultOption
-    BaseProxy.$http = axios
+    const { $axios, errorProperty, parsedQs } = defaultOption
+    BaseProxy.$http = $axios
     BaseProxy.$errorProperty = errorProperty || 'errors'
     BaseProxy.$parsedQs = parsedQs || this.parsedQs
     Vue.mixin({

src/util/objects.ts

@@ -68,3 +68,20 @@ export function is(errors: any, error: any): boolean {
     ? error.some((w: string) => is(errors, w))
     : errors.includes(error)
 }
+
+export function isObject(value: any) {
+  return Object.prototype.toString.call(value) === '[object Object]'
+}
+
+export function isPlainObject(value: any) {
+  if (!isObject(value)) return false
+
+  const ctor = value.constructor
+  if (ctor === undefined) return true
+
+  const prot = ctor.prototype
+  console.warn('is obj', isObject(prot))
+  if (!isObject(prot)) return false
+
+  return hasOwnProperty(prot, 'isPrototypeOf')
+}