quasar 2.15.1 → 2.15.3

package/src/plugins/{Screen.json → screen/Screen.json}

@@ -21,20 +21,20 @@
       "type": "Number",
       "desc": "Screen width (in pixels)",
       "reactive": true,
-      "examples": [ 452 ]
+      "examples": [ "452" ]
     },
 
     "height": {
       "type": "Number",
       "desc": "Screen height (in pixels)",
       "reactive": true,
-      "examples": [ 721 ]
+      "examples": [ "721" ]
     },
 
     "name": {
       "type": "String",
       "desc": "Tells current window breakpoint",
-      "values": [ "xs", "sm", "md", "lg", "xl" ],
+      "values": [ "'xs'", "'sm'", "'md'", "'lg'", "'xl'" ],
       "reactive": true
     },
 
@@ -60,9 +60,7 @@
         }
       },
       "reactive": true,
-      "examples": [
-        "{ sm: 600, md: 1024, lg: 1440, xl: 1920 }"
-      ]
+      "examples": [ "{ sm: 600, md: 1024, lg: 1440, xl: 1920 }" ]
     },
 
     "lt": {
@@ -87,9 +85,7 @@
           "desc": "Is current screen width lower than this breakpoint's lowest limit?"
         }
       },
-      "examples": [
-        "{ sm: false, md: true, lg: true, xl: true }"
-      ]
+      "examples": [ "{ sm: false, md: true, lg: true, xl: true }" ]
     },
 
     "gt": {
@@ -114,9 +110,7 @@
           "desc": "Is current screen width greater than this breakpoint's max limit?"
         }
       },
-      "examples": [
-        "{ xs: true, sm: true, md: false, lg: false, xl: false }"
-      ]
+      "examples": [ "{ xs: true, sm: true, md: false, lg: false, xl: false }" ]
     },
 
     "xs": {
@@ -177,7 +171,8 @@
           },
           "required": true
         }
-      }
+      },
+      "returns": null
     },
 
     "setDebounce": {
@@ -188,7 +183,8 @@
           "desc": "Amount in milliseconds",
           "required": true
         }
-      }
+      },
+      "returns": null
     }
   }
 }

package/src/plugins/{LocalStorage.js → storage/LocalStorage.js}

@@ -1,5 +1,5 @@
-import { client } from './Platform.js'
-import { getEmptyStorage, getStorage } from '../utils/private/web-storage.js'
+import { client } from '../platform/Platform.js'
+import { getEmptyStorage, getStorage } from './engine/web-storage.js'
 
 const storage = __QUASAR_SSR_SERVER__ || client.has.webStorage === false
   ? getEmptyStorage()

package/src/plugins/storage/LocalStorage.json

@@ -0,0 +1,5 @@
+{
+  "mixins": [ "plugins/storage/engine/web-storage" ],
+
+  "injection": "$q.localStorage"
+}

package/src/plugins/storage/LocalStorage.test.js

@@ -0,0 +1,323 @@
+import { describe, test, expect } from 'vitest'
+import { mount, config } from '@vue/test-utils'
+
+import LocalStorage from './LocalStorage.js'
+
+const mountPlugin = () => mount({ template: '<div />' })
+
+// We override Quasar install so it installs this plugin
+const quasarVuePlugin = config.global.plugins.find(entry => entry.name === 'Quasar')
+const { install } = quasarVuePlugin
+quasarVuePlugin.install = app => install(app, { plugins: { LocalStorage } })
+
+describe('[LocalStorage API]', () => {
+  describe('[Injection]', () => {
+    test('is injected into $q', () => {
+      const { vm: { $q } } = mountPlugin()
+
+      expect($q.localStorage).toBeDefined()
+      expect($q.localStorage).toBeTypeOf('object')
+      expect(Object.keys($q.localStorage)).not.toHaveLength(0)
+
+      expect(LocalStorage).toMatchObject($q.localStorage)
+    })
+  })
+
+  describe('[Methods]', () => {
+    describe('[(method)hasItem]', () => {
+      test('should be callable', () => {
+        mountPlugin()
+
+        expect(LocalStorage.hasItem('has')).toBe(false)
+        LocalStorage.setItem('has', 'rstoenescu')
+        expect(LocalStorage.hasItem('has')).toBe(true)
+      })
+
+      test('matches $q API', () => {
+        const { vm: { $q } } = mountPlugin()
+        expect($q.localStorage.hasItem).toBe(LocalStorage.hasItem)
+      })
+    })
+
+    describe('[(method)getLength]', () => {
+      test('should be callable', () => {
+        mountPlugin()
+
+        const len = LocalStorage.getLength()
+        expect(len).toBeTypeOf('number')
+
+        LocalStorage.setItem('getLength', 0)
+        expect(LocalStorage.getLength()).toBe(len + 1)
+      })
+
+      test('matches $q API', () => {
+        const { vm: { $q } } = mountPlugin()
+        expect($q.localStorage.getLength).toBe(LocalStorage.getLength)
+      })
+    })
+
+    describe('[(method)getItem]', () => {
+      test('should be callable', () => {
+        mountPlugin()
+
+        expect(
+          LocalStorage.getItem('getItem')
+        ).toBeNull()
+      })
+
+      test('matches $q API', () => {
+        const { vm: { $q } } = mountPlugin()
+        expect($q.localStorage.getItem).toBe(LocalStorage.getItem)
+      })
+    })
+
+    describe('[(method)getIndex]', () => {
+      test('should be callable', () => {
+        mountPlugin()
+
+        // ensure at least one element is defined
+        LocalStorage.setItem('getIndex', 'rstoenescu')
+
+        expect(
+          LocalStorage.getIndex(0)
+        ).$any([
+          expect.any(Number),
+          expect.any(Boolean),
+          expect.any(Date),
+          expect.any(RegExp),
+          expect.any(Function),
+          expect.any(Object),
+          expect.any(Array),
+          expect.any(String)
+        ])
+      })
+
+      test('matches $q API', () => {
+        const { vm: { $q } } = mountPlugin()
+        expect($q.localStorage.getIndex).toBe(LocalStorage.getIndex)
+      })
+    })
+
+    describe('[(method)getKey]', () => {
+      test('should be callable', () => {
+        mountPlugin()
+
+        // ensure at least one element is defined
+        LocalStorage.setItem('getKey', 'rstoenescu')
+
+        expect(
+          LocalStorage.getKey(0)
+        ).toBeTypeOf('string')
+      })
+
+      test('matches $q API', () => {
+        const { vm: { $q } } = mountPlugin()
+        expect($q.localStorage.getKey).toBe(LocalStorage.getKey)
+      })
+    })
+
+    describe('[(method)getAll]', () => {
+      test('should be callable', () => {
+        mountPlugin()
+
+        // ensure at least one element is defined
+        LocalStorage.setItem('getAll', 'rstoenescu')
+
+        const result = LocalStorage.getAll()
+        expect(result).toBeTypeOf('object')
+        expect(Object.keys(result)).not.toHaveLength(0)
+      })
+
+      test('matches $q API', () => {
+        const { vm: { $q } } = mountPlugin()
+        expect($q.localStorage.getAll).toBe(LocalStorage.getAll)
+      })
+    })
+
+    describe('[(method)getAllKeys]', () => {
+      test('should be callable', () => {
+        mountPlugin()
+
+        // ensure at least one element is defined
+        LocalStorage.setItem('getAllKeys', 'rstoenescu')
+
+        expect(
+          Array.isArray(LocalStorage.getAllKeys())
+        ).toBe(true)
+
+        expect(
+          LocalStorage.getAllKeys()
+        ).toContain('getAllKeys')
+      })
+
+      test('matches $q API', () => {
+        const { vm: { $q } } = mountPlugin()
+        expect($q.localStorage.getAllKeys).toBe(LocalStorage.getAllKeys)
+      })
+    })
+
+    describe('[(method)setItem]', () => {
+      test('should be callable', () => {
+        mountPlugin()
+
+        expect(
+          LocalStorage.setItem('set', 'rstoenescu')
+        ).toBeUndefined()
+
+        expect(
+          LocalStorage.getItem('set')
+        ).toBe('rstoenescu')
+      })
+
+      test('matches $q API', () => {
+        const { vm: { $q } } = mountPlugin()
+        expect($q.localStorage.setItem).toBe(LocalStorage.setItem)
+      })
+
+      test('can override value', () => {
+        mountPlugin()
+
+        expect(LocalStorage.setItem('set2', 'rstoenescu'))
+        expect(LocalStorage.getItem('set2')).toBe('rstoenescu')
+
+        expect(LocalStorage.setItem('set2', 'rstoenescu2'))
+        expect(LocalStorage.getItem('set2')).toBe('rstoenescu2')
+      })
+
+      test('can encode + decode a Number', () => {
+        mountPlugin()
+
+        LocalStorage.setItem('Number', 123)
+        expect(LocalStorage.getItem('Number')).toBe(123)
+      })
+
+      test('can encode + decode a Boolean', () => {
+        mountPlugin()
+
+        LocalStorage.setItem('Boolean', true)
+        expect(LocalStorage.getItem('Boolean')).toBe(true)
+      })
+
+      test('can encode + decode a Date', () => {
+        mountPlugin()
+        const date = new Date()
+
+        LocalStorage.setItem('Date', date)
+        expect(
+          LocalStorage.getItem('Date')
+        ).toStrictEqual(date)
+      })
+
+      test('can encode + decode a String', () => {
+        mountPlugin()
+
+        LocalStorage.setItem('String', 'rstoenescu')
+        expect(
+          LocalStorage.getItem('String')
+        ).toBe('rstoenescu')
+      })
+
+      test('can encode + decode a RegExp', () => {
+        mountPlugin()
+
+        LocalStorage.setItem('RegExp', /abc/)
+        expect(
+          LocalStorage.getItem('RegExp')
+        ).toStrictEqual(/abc/)
+      })
+
+      test('can encode + decode a Function', () => {
+        mountPlugin()
+        const fn = () => 5
+
+        LocalStorage.setItem('Function', fn)
+        expect(
+          LocalStorage.getItem('Function')
+        ).toBe(fn.toString())
+      })
+
+      test('can encode + decode an Object', () => {
+        mountPlugin()
+        const obj = { a: 1 }
+
+        LocalStorage.setItem('Object', obj)
+        expect(
+          LocalStorage.getItem('Object')
+        ).toStrictEqual(obj)
+      })
+
+      test('can encode + decode an Array', () => {
+        mountPlugin()
+        const arr = [ 1, 2, 3 ]
+
+        LocalStorage.setItem('Array', arr)
+        expect(
+          LocalStorage.getItem('Array')
+        ).toStrictEqual(arr)
+      })
+    })
+
+    describe('[(method)removeItem]', () => {
+      test('should be callable', () => {
+        mountPlugin()
+
+        LocalStorage.setItem('remove', 5)
+        expect(
+          LocalStorage.getItem('remove')
+        ).toBe(5)
+
+        expect(
+          LocalStorage.removeItem('remove')
+        ).toBeUndefined()
+
+        expect(
+          LocalStorage.getItem('remove')
+        ).toBeNull()
+      })
+
+      test('matches $q API', () => {
+        const { vm: { $q } } = mountPlugin()
+        expect($q.localStorage.removeItem).toBe(LocalStorage.removeItem)
+      })
+    })
+
+    describe('[(method)clear]', () => {
+      test('should be callable', () => {
+        mountPlugin()
+
+        LocalStorage.setItem('clear', 5)
+        expect(LocalStorage.getItem('clear')).toBe(5)
+
+        expect(LocalStorage.clear()).toBeUndefined()
+
+        expect(LocalStorage.getItem('clear')).toBeNull()
+        expect(LocalStorage.getLength()).toBe(0)
+      })
+
+      test('matches $q API', () => {
+        const { vm: { $q } } = mountPlugin()
+        expect($q.localStorage.clear).toBe(LocalStorage.clear)
+      })
+    })
+
+    describe('[(method)isEmpty]', () => {
+      test('should be callable', () => {
+        mountPlugin()
+
+        LocalStorage.setItem('isEmpty', 5)
+        expect(LocalStorage.getItem('isEmpty')).toBe(5)
+
+        expect(LocalStorage.isEmpty()).toBe(false)
+
+        LocalStorage.clear()
+
+        expect(LocalStorage.isEmpty()).toBe(true)
+      })
+
+      test('matches $q API', () => {
+        const { vm: { $q } } = mountPlugin()
+        expect($q.localStorage.isEmpty).toBe(LocalStorage.isEmpty)
+      })
+    })
+  })
+})

package/src/plugins/{SessionStorage.js → storage/SessionStorage.js}

@@ -1,5 +1,5 @@
-import { client } from './Platform.js'
-import { getEmptyStorage, getStorage } from '../utils/private/web-storage.js'
+import { client } from '../platform/Platform.js'
+import { getEmptyStorage, getStorage } from './engine/web-storage.js'
 
 const storage = __QUASAR_SSR_SERVER__ || client.has.webStorage === false
   ? getEmptyStorage()

package/src/plugins/storage/SessionStorage.json

@@ -0,0 +1,5 @@
+{
+  "mixins": [ "plugins/storage/engine/web-storage" ],
+
+  "injection": "$q.sessionStorage"
+}