first commit

Author: root

Gruntfile.js

@@ -0,0 +1,35 @@
+/* global module:false */
+module.exports = function(grunt) {
+
+    // Grunt configuration
+    grunt.initConfig({
+        pkg: grunt.file.readJSON('package.json'),
+        meta: {
+            banner: '/*! Cache API Key/Value Store v<%= pkg.version %>\n * (c) https://github.com/optimalisatie */\n'
+        },
+
+        // closure compiler
+        "closure-compiler": {
+            "cache-api-keyval": {
+                closurePath: 'closure-compiler',
+                js: 'src/cache-api-keyval.js',
+                jsOutputFile: 'dist/cache-api-keyval.js',
+                maxBuffer: 10000,
+                options: {
+                    compilation_level: 'ADVANCED_OPTIMIZATIONS',
+                    language_in: 'ECMASCRIPT5_STRICT',
+                    externs: ['cache-api-keyval.ext.js'],
+                    define: ['DEBUG=false']
+                }
+            }
+        }
+    });
+
+    // Load Dependencies
+    require('matchdep').filterDev('grunt-*').forEach(grunt.loadNpmTasks);
+
+    grunt.registerTask('build', [
+        'closure-compiler:cache-api-keyval'
+    ]);
+    grunt.registerTask('default', ['']);
+};

LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2018 github.com/optimalisatie
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished
+to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,58 @@
+![Version](https://img.shields.io/github/release/optimalisatie/cache-api-keyval-store.svg)
+
+# Cache API Key/Value store
+
+Fast and efficient key/value store with +50MB storage capacity in [most browsers](https://developer.mozilla.org/en-US/docs/Web/API/Cache#Browser_compatibility), expiration and JSON object data-type.
+
+It’s currently available in Chrome >= 40, Firefox >=39 and Opera >= 27.
+
+Safari and Edge recently introduced support for it.
+
+# Install
+
+```
+npm install --save cache-api-keyval
+```
+
+# Use
+
+```html
+<script src="/cache-api-keyval.js"></script>
+<script>
+
+// load database
+var db = new CacheApiDB('my-store', { namespace: 'optional' });
+
+if (db.supported) { // Cache API supported by browser
+
+    // set JSON object data
+    db.set('key', { json: 'object' }); 
+
+    // set text data with expiration in 24 hours
+    db.set('key2', 'string', 86400); 
+
+    // get data from cache
+    db.get('key').then(function(json) {
+        console.log('json cache data', json);
+    });
+
+    // prune expired cache entries
+    db.prune();
+
+}
+</script>
+```
+
+## Fallback storage
+
+To enable a fallback storage for browsers that do not support Cache API, you can define a constructor on global variable `CacheApiDBFallback`. The constructor needs to provide 4 methods: `set`, `get`, `del` and `prune`.
+
+```js
+window.CacheApiDBFallback = function(store, options) {
+    
+    this.get = function(key) { /* return key from store */ }
+    this.set = function(key,data,expire) { /* set key in store */ }
+    this.det = function(key) { /* delete key from store */ }
+    this.prune = function() { /* cleanup database */ }
+};
+```

cache-api-keyval.ext.js

@@ -0,0 +1,21 @@
+// Closure Compiler externs
+// @link https://developers.google.com/closure/compiler/
+
+window.CacheApiDB = global.CacheApiDB = this.CacheApiDB = self.CacheApiDB = function(store, options) {
+
+    options.namespace = '';
+
+    return {
+        supported: false,
+        get: function() {},
+        set: function() {},
+        del: function() {},
+        prune: function() {}
+    }
+}
+
+var cache_headers = {
+    "x-date": '',
+    "x-expire": '',
+    "Content-Type": ''
+};

dist/cache-api-keyval.js

@@ -0,0 +1,7 @@
+WARNING - unknown @define variable DEBUG
+
+cache-api-keyval.ext.js:4: WARNING - name global is not defined in the externs.
+window.CacheApiDB = global.CacheApiDB = this.CacheApiDB = self.CacheApiDB = function(store, options) {
+                    ^
+
+0 error(s), 2 warning(s)

dist/cache-api-keyval.js.report.txt

@@ -0,0 +1,31 @@
+{
+    "name": "cache-api-keyval",
+    "version": "1.0.1",
+    "description": "Cache API key/value store with expiration and JSON object data-type storage.",
+    "author": {
+        "name": "info@optimization.team",
+        "email": "info@optimization.team",
+        "web": "optimization.team"
+    },
+    "keywords": ["Cache", "IndexedDB", "Cache API", "CacheStorage", "keyvalue", "keyval", "key/value"],
+
+    "homepage": "https://github.com/optimalisatie/",
+    "copyright": "Copyright (C) 2018 Optimization.Team, Utrecht, NLD",
+    "main": "cache-api-keyval.js",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/optimalisatie/exec.js.git"
+    },
+    "engines": {
+        "node": "~0.10"
+    },
+    "dependencies": {
+
+    },
+    "devDependencies": {
+        "grunt": "latest",
+        "grunt-closure-compiler": "latest",
+        "matchdep": "latest",
+        "merge": "latest"
+    }
+}