git.iko.soy/purescript-indexed-DB
on 808de4f help sign in
.gitignore−2
since splitsnapshots
unifiedsplit
@@ -77,5 +77,3 @@ releases
77.purs*
77.purs*
78.psa*
78.psa*
79dist
79dist
80−.spago
81−test.js
README.md+10−64
@@ -1,40 +1,13 @@
1−PureScript IndexedDB [![](https://img.shields.io/badge/doc-pursuit-60b5cc.svg)](http://pursuit.purescript.org/packages/purescript-indexeddb) [![Build Status](https://travis-ci.org/truqu/purescript-indexedDB.svg?branch=master)](https://travis-ci.org/truqu/purescript-indexedDB)
1+PureScript IndexedDB [![](https://img.shields.io/badge/doc-pursuit-60b5cc.svg)](http://pursuit.purescript.org/packages/purescript-indexeddb) [![Build Status](https://travis-ci.org/truqu/purescript-indexeddb.svg?branch=master)](https://travis-ci.org/truqu/purescript-indexeddb)
2=====
2=====
3
3
4This package offers complete bindings and type-safety upon the [IndexedDB API](https://w3c.github.io/IndexedDB).
4This package offers complete bindings and type-safety upon the [IndexedDB API](https://w3c.github.io/IndexedDB).
5
5
6## Overview
6## Overview
7
7
8−The `IDBCore` and `IDBFactory` are the two entry points required to create and connect to an
9−indexed database. From there, modules are divided such that each of them covers a specific IDB
10−interface.
11−
12−They are designed to be used as qualified imports such that each method gets prefixed with a
13−menaingful namespace (e.g `IDBIndex.get`, `IDBObjectStore.openCursor` ...)
14−
15−Here's a quick example of what it look likes.
16```purescript
8```purescript
17−module Main where
18−
19−import Prelude
20−
21−import Control.Monad.Aff (Aff, launchAff_)
22−import Control.Monad.Aff.Console (CONSOLE, log)
23−import Control.Monad.Eff.Exception (EXCEPTION)
24−import Control.Monad.Eff (Eff)
25−import Data.Maybe (Maybe(..), maybe)
26−
27−import Database.IndexedDB.Core
28−import Database.IndexedDB.IDBFactory as IDBFactory
29−import Database.IndexedDB.IDBDatabase as IDBDatabase
30−import Database.IndexedDB.IDBObjectStore as IDBObjectStore
31−import Database.IndexedDB.IDBIndex as IDBIndex
32−import Database.IndexedDB.IDBTransaction as IDBTransaction
33−import Database.IndexedDB.IDBKeyRange as IDBKeyRange
34−
35−
36main :: Eff (idb :: IDB, exception :: EXCEPTION, console :: CONSOLE) Unit
9main :: Eff (idb :: IDB, exception :: EXCEPTION, console :: CONSOLE) Unit
37−main = launchAff_ do
10+main = launchAff' do
38 db <- IDBFactory.open "db" Nothing { onBlocked : Nothing
11 db <- IDBFactory.open "db" Nothing { onBlocked : Nothing
39 , onUpgradeNeeded : Just onUpgradeNeeded
12 , onUpgradeNeeded : Just onUpgradeNeeded
40 }
13 }
@@ -45,50 +18,23 @@ main = launchAff_ do
45 log $ maybe "not found" id val
18 log $ maybe "not found" id val
46
19
47
20
48−onUpgradeNeeded :: forall e. Database -> Transaction -> { oldVersion :: Int } -> Eff (idb :: IDB, exception :: EXCEPTION | e) Unit
21+onUpgradeNeeded :: forall e. Database -> Transaction -> Eff (idb :: IDB, exception :: EXCEPTION | e) Unit
49−onUpgradeNeeded db _ _ = launchAff_ do
22+onUpgradeNeeded db _ = launchAff' do
50− store <- IDBDatabase.createObjectStore db "store" IDBDatabase.defaultParameters
23+ store <- IDBDatabase.createObjectStore db "store" IDBObjectStore.defaultParameters
51 _ <- IDBObjectStore.add store "patate" (Just 1)
24 _ <- IDBObjectStore.add store "patate" (Just 1)
52 _ <- IDBObjectStore.add store { property: 42 } (Just 2)
25 _ <- IDBObjectStore.add store { property: 42 } (Just 2)
53− _ <- IDBObjectStore.createIndex store "index" ["property"] IDBObjectStore.defaultParameters
26+ _ <- IDBObjectStore.createIndex store "index" ["property"] IDBIndex.defaultParameters
54 pure unit
27 pure unit
55```
28```
56
29
57−## Notes
58−
59−### Errors
60−Errors normally thrown by the IDB\* interfaces are wrapped in the `Aff` Monad as `Error` where
61−the `name` corresponds to the error's name (e.g. "InvalidStateError"). Pattern matching can
62−therefore be done on any error to handle specific errors thrown by the API.
63−
64−### Examples
65−The `test` folder contains a great amount of examples showing practical usage of the IDB\*
66−interfaces. Do not hesitate to have a peek should you wonder how to use one of the module. The
67−wrapper tries to keep as much as possible an API consistent with the original IndexedDB API.
68−Hence, it should be quite straightforward to translate any JavaScript example to a PureScript
69−one.
70−
71## Changelog
30## Changelog
72
31
73−#### v3.0.0
32+- Release incoming
74−
75−- callback to `onUpgradeNeeded` event now provide a record with the database old version.
76−
77−#### v2.0.0
78−
79−- review interface implementation (use of opaque classes to improve readability without compromising
80− the reusability). The API doesn't really change from a user perspective though.
81−
82−- make the Key more opaque (by having an IDBKey instance for Foreign types)
83−
84−- Upgrade purescript-exceptions to 3.1.0 and leverage the new `name` accessor
85−
86
33
87−#### v1.0.0
34+#### TODO
88
35
89−- [Indexed Database API 2.0](https://w3c.github.io/IndexedDB/) totally covered apart from
36+- Add support for `index.getAll` method
90− - `index.getAll` method (and the associated one for the IDBObjectStore)
37+- Complete the specifications with the [official tests list](https://github.com/w3c/web-platform-tests/blob/master/IndexedDB/README.md) provided by W3C
91− - binary keys
92
38
93## Documentation
39## Documentation
94
40
bower.jsonnew file+38
@@ -0,0 +1,38 @@
1+{
2+ "name": "purescript-indexeddb",
3+ "description": "An API wrapper around IndexedDB",
4+ "version": "1.0.0",
5+ "authors": [
6+ "Matthias Benkort <matthias.benkort@truqu.com>"
7+ ],
8+ "ignore": [
9+ "**/.*",
10+ "node_modules",
11+ "bower_components",
12+ "output",
13+ "test",
14+ "dist",
15+ "releases",
16+ "package.json",
17+ "karma.conf.js",
18+ "karma.browserstack.conf.js",
19+ "deploy.sh"
20+ ],
21+ "license": "MIT",
22+ "homepage": "https://github.com/truqu/purescript-indexeddb",
23+ "repository": {
24+ "type": "git",
25+ "url": "git://github.com/KtorZ/purescript-ifrit.git"
26+ },
27+ "dependencies": {
28+ "purescript-maybe": "^3.0.0",
29+ "purescript-aff": "^3.1.0",
30+ "purescript-datetime": "^3.2.0"
31+ },
32+ "devDependencies": {
33+ "purescript-spec": "^1.0.0",
34+ "purescript-psci-support": "^3.0.0",
35+ "purescript-now": "^3.0.0",
36+ "purescript-spec-mocha": "https://github.com/truqu/purescript-spec-mocha.git#0.5.0"
37+ }
38+}
deploy.shnew file+3
@@ -0,0 +1,3 @@
1+#!/bin/sh
2+
3+test -n "$TRAVIS_TAG" && ( yes | pulp publish --no-push )
index.jsdeleted−4
@@ -1,4 +0,0 @@
1−import "fake-indexeddb/auto";
2−import * as Main from './output/Test.Main/index.js';
3−
4−Main.main();
karma.browserstack.conf.jsnew file+91
@@ -0,0 +1,91 @@
1+module.exports = (config) => {
2+ config.set({
3+ browsers: [
4+ 'FirefoxMAC',
5+ 'ChromeMAC',
6+ // 'SafariMAC',
7+ 'OperaMAC',
8+
9+ 'FirefoxWIN',
10+ 'ChromeWIN',
11+ 'OperaWIN',
12+ ],
13+ files: [
14+ 'dist/karma/index.js',
15+ ],
16+ frameworks: [
17+ 'mocha',
18+ ],
19+ plugins: [
20+ 'karma-browserstack-launcher',
21+ 'karma-mocha',
22+ ],
23+ reporters: [
24+ 'dots',
25+ 'BrowserStack',
26+ ],
27+ singleRun: true,
28+ client: {
29+ mocha: {
30+ timeout: 10000,
31+ },
32+ },
33+ browserStack: {
34+ username: process.env.BROWSERSTACK_USERNAME,
35+ accessKey: process.env.BROWSERSTACK_ACCESSKEY,
36+ timeout: 1500,
37+ captureTimeout: 500,
38+ },
39+ customLaunchers: {
40+ FirefoxMAC: {
41+ base: 'BrowserStack',
42+ browser: 'Firefox',
43+ browser_version: '51',
44+ os: 'OS X',
45+ os_version: 'Sierra',
46+ },
47+ ChromeMAC: {
48+ base: 'BrowserStack',
49+ browser: 'Chrome',
50+ browser_version: '58',
51+ os: 'OS X',
52+ os_version: 'Sierra',
53+ },
54+ SafariMAC: {
55+ base: 'BrowserStack',
56+ browser: 'Safari',
57+ browser_version: '10.1',
58+ os: 'OS X',
59+ os_version: 'Sierra',
60+ },
61+ OperaMAC: {
62+ base: 'BrowserStack',
63+ browser: 'Opera',
64+ browser_version: '46',
65+ os: 'OS X',
66+ os_version: 'Sierra',
67+ },
68+ FirefoxWIN: {
69+ base: 'BrowserStack',
70+ browser: 'Firefox',
71+ browser_version: '51',
72+ os: 'WINDOWS',
73+ os_version: '10',
74+ },
75+ ChromeWIN: {
76+ base: 'BrowserStack',
77+ browser: 'Chrome',
78+ browser_version: '58',
79+ os: 'WINDOWS',
80+ os_version: '10',
81+ },
82+ OperaWIN: {
83+ base: 'BrowserStack',
84+ browser: 'Opera',
85+ browser_version: '46',
86+ os: 'WINDOWS',
87+ os_version: '10',
88+ },
89+ },
90+ });
91+};
karma.conf.jsnew file+25
@@ -0,0 +1,25 @@
1+module.exports = config => {
2+ config.set({
3+ autoWatch: true,
4+ singleRun: true,
5+ browsers: ["Chrome"],
6+ files: [
7+ "dist/karma/index.js",
8+ ],
9+ frameworks: [
10+ "mocha",
11+ ],
12+ plugins: [
13+ "karma-chrome-launcher",
14+ "karma-firefox-launcher",
15+ "karma-spec-reporter",
16+ "karma-mocha",
17+ ],
18+ reporters: ["spec"],
19+ client: {
20+ mocha: {
21+ timeout: 10000
22+ }
23+ }
24+ });
25+};
package.json+36−9
@@ -1,15 +1,42 @@
1{
1{
2− "name": "purescript-indexed-DB",
2+ "name": "purescript-indexeddb",
3 "version": "1.0.0",
3 "version": "1.0.0",
4− "main": "index.js",
4+ "description": "A wrapper around the IndexedDB API",
5− "repository": "https://github.com/ilyakooo0/purescript-indexed-DB.git",
6− "author": "iko <mail@iko.soy>",
7− "license": "MIT",
8 "scripts": {
5 "scripts": {
9− "test": "spago build && node index.js"
6+ "prepare:release": "mkdir -p releases/github && cp -r README.md LICENSE src bower.json releases/github",
7+ "test:build": "mkdir -p dist/karma && pulp browserify -j 4 --main \"Test.Main\" -I test --to dist/karma/index.js",
8+ "test:run": "karma start karma.conf.js",
9+ "test:run:browserstack": "karma start karma.browserstack.conf.js",
10+ "test:browserstack": "npm run test:build && npm run test:run:browserstack",
11+ "test": "npm run test:build && npm run test:run",
12+ "start": "find . -type f -regex '.*\\(src\\|test\\).*' ! -regex '.*bower_components.*\\|.*node_modules.*|.*\\.sw.*' | entr -s 'npm run test -s'"
13+ },
14+ "dependencies": {},
15+ "devDependencies": {
16+ "bower": "1.8.0",
17+ "eslint": "3.19.0",
18+ "eslint-config-airbnb": "15.0.1",
19+ "eslint-plugin-import": "2.5.0",
20+ "eslint-plugin-jsx-a11y": "5.0.3",
21+ "eslint-plugin-react": "7.1.0",
22+ "karma": "1.7.0",
23+ "karma-browserstack-launcher": "1.3.0",
24+ "karma-chrome-launcher": "2.1.1",
25+ "karma-firefox-launcher": "1.0.1",
26+ "karma-mocha": "1.3.0",
27+ "karma-spec-reporter": "0.0.31",
28+ "mocha": "3.4.2",
29+ "pulp": "11.0.0",
30+ "purescript": "0.11.5"
10 },
31 },
11− "dependencies": {
32+ "repository": {
12− "fake-indexeddb": "^4.0.1"
33+ "type": "git",
34+ "url": "git+https://github.com/Truqu/purescript-indexeddb.git"
35+ },
36+ "author": "Matthias Benkort <matthias.benkort@truqu.com>",
37+ "license": "MIT",
38+ "bugs": {
39+ "url": "https://github.com/Truqu/purescript-indexeddb/issues"
13 },
40 },
14− "type": "module"
41+ "homepage": "https://github.com/Truqu/purescript-indexeddb#readme"
15}
42}
packages.dhalldeleted−105
@@ -1,105 +0,0 @@
1−{-
2−Welcome to your new Dhall package-set!
3−
4−Below are instructions for how to edit this file for most use
5−cases, so that you don't need to know Dhall to use it.
6−
7−## Use Cases
8−
9−Most will want to do one or both of these options:
10−1. Override/Patch a package's dependency
11−2. Add a package not already in the default package set
12−
13−This file will continue to work whether you use one or both options.
14−Instructions for each option are explained below.
15−
16−### Overriding/Patching a package
17−
18−Purpose:
19−- Change a package's dependency to a newer/older release than the
20− default package set's release
21−- Use your own modified version of some dependency that may
22− include new API, changed API, removed API by
23− using your custom git repo of the library rather than
24− the package set's repo
25−
26−Syntax:
27−where `entityName` is one of the following:
28−- dependencies
29−- repo
30−- version
31−-------------------------------
32−let upstream = --
33−in upstream
34− with packageName.entityName = "new value"
35−-------------------------------
36−
37−Example:
38−-------------------------------
39−let upstream = --
40−in upstream
41− with halogen.version = "master"
42− with halogen.repo = "https://example.com/path/to/git/repo.git"
43−
44− with halogen-vdom.version = "v4.0.0"
45− with halogen-vdom.dependencies = [ "extra-dependency" ] # halogen-vdom.dependencies
46−-------------------------------
47−
48−### Additions
49−
50−Purpose:
51−- Add packages that aren't already included in the default package set
52−
53−Syntax:
54−where `<version>` is:
55−- a tag (i.e. "v4.0.0")
56−- a branch (i.e. "master")
57−- commit hash (i.e. "701f3e44aafb1a6459281714858fadf2c4c2a977")
58−-------------------------------
59−let upstream = --
60−in upstream
61− with new-package-name =
62− { dependencies =
63− [ "dependency1"
64− , "dependency2"
65− ]
66− , repo =
67− "https://example.com/path/to/git/repo.git"
68− , version =
69− "<version>"
70− }
71−-------------------------------
72−
73−Example:
74−-------------------------------
75−let upstream = --
76−in upstream
77− with benchotron =
78− { dependencies =
79− [ "arrays"
80− , "exists"
81− , "profunctor"
82− , "strings"
83− , "quickcheck"
84− , "lcg"
85− , "transformers"
86− , "foldable-traversable"
87− , "exceptions"
88− , "node-fs"
89− , "node-buffer"
90− , "node-readline"
91− , "datetime"
92− , "now"
93− ]
94− , repo =
95− "https://github.com/hdgarrood/purescript-benchotron.git"
96− , version =
97− "v7.0.0"
98− }
99−-------------------------------
100−-}
101−
102−let upstream =
103− https://github.com/purescript/package-sets/releases/download/psc-0.15.4-20221124/packages.dhall
104− sha256:792255bbd8e2141468d967325f3e78246cb7e500bf3ab6d76d5b22dffbb09d49
105−in upstream
spago.dhalldeleted−42
@@ -1,42 +0,0 @@
1−{-
2−Welcome to a Spago project!
3−You can edit this file as you like.
4−
5−Need help? See the following resources:
6−- Spago documentation: https://github.com/purescript/spago
7−- Dhall language tour: https://docs.dhall-lang.org/tutorials/Language-Tour.html
8−
9−When creating a new Spago project, you can use
10−`spago init --no-comments` or `spago init -C`
11−to generate this file without the comments in this block.
12−-}
13−{ name = "indexed-db"
14−, dependencies =
15− [ "aff"
16− , "arrays"
17− , "avar"
18− , "console"
19− , "control"
20− , "datetime"
21− , "effect"
22− , "either"
23− , "enums"
24− , "exceptions"
25− , "foldable-traversable"
26− , "foreign"
27− , "functions"
28− , "identity"
29− , "lists"
30− , "maybe"
31− , "nonempty"
32− , "now"
33− , "nullable"
34− , "prelude"
35− , "read"
36− , "spec"
37− , "transformers"
38− , "tuples"
39− ]
40−, packages = ./packages.dhall
41−, sources = [ "src/**/*.purs", "test/**/*.purs" ]
42−}
src/Database/IndexedDB/Core.js+6−6
@@ -3,7 +3,7 @@ const toArray = function toArray(xs) {
3};
3};
4
4
5
5
6−export function _showCursor(cursor) {
6+exports._showCursor = function _showCursor(cursor) {
7 return '(IDBCursor ' +
7 return '(IDBCursor ' +
8 '{ direction: ' + cursor.direction +
8 '{ direction: ' + cursor.direction +
9 ', key: ' + cursor.key +
9 ', key: ' + cursor.key +
@@ -11,7 +11,7 @@ export function _showCursor(cursor) {
11 ' })';
11 ' })';
12};
12};
13
13
14−export function _showDatabase(db) {
14+exports._showDatabase = function _showDatabase(db) {
15 return '(IDBDatabase ' +
15 return '(IDBDatabase ' +
16 '{ name: ' + db.name +
16 '{ name: ' + db.name +
17 ', objectStoreNames: [' + toArray(db.objectStoreNames).join(', ') + ']' +
17 ', objectStoreNames: [' + toArray(db.objectStoreNames).join(', ') + ']' +
@@ -19,7 +19,7 @@ export function _showDatabase(db) {
19 ' })';
19 ' })';
20};
20};
21
21
22−export function _showIndex(index) {
22+exports._showIndex = function _showIndex(index) {
23 return '(IDBIndex ' +
23 return '(IDBIndex ' +
24 '{ name: ' + index.name +
24 '{ name: ' + index.name +
25 ', keyPath: ' + index.keyPath +
25 ', keyPath: ' + index.keyPath +
@@ -28,7 +28,7 @@ export function _showIndex(index) {
28 ' })';
28 ' })';
29};
29};
30
30
31−export function _showKeyRange(range) {
31+exports._showKeyRange = function _showKeyRange(range) {
32 return '(IDBKeyRange ' +
32 return '(IDBKeyRange ' +
33 '{ lower: ' + range.lower +
33 '{ lower: ' + range.lower +
34 ', upper: ' + range.upper +
34 ', upper: ' + range.upper +
@@ -37,7 +37,7 @@ export function _showKeyRange(range) {
37 ' })';
37 ' })';
38};
38};
39
39
40−export function _showObjectStore(store) {
40+exports._showObjectStore = function _showObjectStore(store) {
41 return '(IDBObjectStore ' +
41 return '(IDBObjectStore ' +
42 '{ autoIncrement: ' + store.autoIncrement +
42 '{ autoIncrement: ' + store.autoIncrement +
43 ', indexNames: [' + toArray(store.indexNames).join(', ') + ']' +
43 ', indexNames: [' + toArray(store.indexNames).join(', ') + ']' +
@@ -46,7 +46,7 @@ export function _showObjectStore(store) {
46 ' })';
46 ' })';
47};
47};
48
48
49−export function _showTransaction(tx) {
49+exports._showTransaction = function _showTransaction(tx) {
50 return '(IDBTransaction ' +
50 return '(IDBTransaction ' +
51 '{ error: ' + tx.error +
51 '{ error: ' + tx.error +
52 ', mode: ' + tx.mode +
52 ', mode: ' + tx.mode +
src/Database/IndexedDB/Core.purs+95−143
@@ -1,72 +1,39 @@
1-- | The Core module gathers types used across the library and provides basic Show instances for
1-- | The Core module gathers types used across the library and provides basic Show instances for
2-- | those types.
2-- | those types.
3−module Database.IndexedDB.Core
3+-- |
4− -- * Effects
4+-- | NOTE:
5− (
5+-- | Errors normally thrown by the IDB* interfaces are wrapped in the `Aff` Monad as `Error`
6− -- IDB
6+-- | where the `message` corresponds to the error's name (e.g. "InvalidStateError").
7+-- | Pattern matching can therefore be done on any error message to handle specific errors thrown
8+-- | by the API.
7
9
8− -- * Types
10+module Database.IndexedDB.Core
11+ ( class FromString, parse
12+ , IDB
13+ , CursorDirection(..)
14+ , CursorSource(..)
9− Database
15+ , Database
10 , Index
16 , Index
11 , KeyCursor
17 , KeyCursor
12 , KeyRange
18 , KeyRange
19+ , KeyPath
13 , ObjectStore
20 , ObjectStore
14 , Transaction
21 , Transaction
15− , ValueCursor
16− , CursorDirection(..)
17− , CursorSource(..)
18− , KeyPath
19 , TransactionMode(..)
22 , TransactionMode(..)
20−
23+ , ValueCursor
21− -- * Classes
22− , class IDBConcreteCursor
23− , class IDBCursor
24− , class IDBDatabase
25− , class IDBIndex
26− , class IDBKeyRange
27− , class IDBTransaction
28− , class IDBObjectStore
29−
30− -- * Re-Exports
31 , module Database.IndexedDB.IDBKey
24 , module Database.IndexedDB.IDBKey
32 ) where
25 ) where
33
26
34−import Prelude (class Show)
27+import Prelude (class Show)
35
28
36−import Data.Maybe (Maybe(..))
29+import Control.Monad.Eff (kind Effect)
37−import Data.String.Read (class Read)
30+import Data.Maybe (Maybe(..))
38
31
39import Database.IndexedDB.IDBKey
32import Database.IndexedDB.IDBKey
40
33
41−--------------------
34+-- | IDB Effects, manifestation that something happened with the IndexedDB
42−-- TYPES
43−--
44−
45−-- | Each origin has an associated set of databases. A database has zero or more object
46−-- | stores which hold the data stored in the database.
47−foreign import data Database :: Type
48−
49−-- | An index allows looking up records in an object store using properties of the values
50−-- | in the object stores records.
51−foreign import data Index :: Type
52−
53−-- | A key range is a continuous interval over some data type used for keys.
54−foreign import data KeyRange :: Type
55−
56−-- | A cursor is used to iterate over a range of records in an index or an object store
57−-- | in a specific direction. A KeyCursor doesn't hold any value.
58−foreign import data KeyCursor :: Type
35+foreign import data IDB :: Effect
59
36
60−-- | A Transaction is used to interact with the data in a database.
61−-- | Whenever data is read or written to the database it is done by using a transaction.
62−foreign import data Transaction :: Type
63−
64−-- | An object store is the primary storage mechanism for storing data in a database.
65−foreign import data ObjectStore :: Type
66−
67−-- | A cursor is used to iterate over a range of records in an index or an object store
68−-- | in a specific direction. A ValueCursor also holds the value corresponding to matching key.
69−foreign import data ValueCursor :: Type
70
37
71-- | A cursor has a direction that determines whether it moves in monotonically
38-- | A cursor has a direction that determines whether it moves in monotonically
72-- | increasing or decreasing order of the record keys when iterated, and if it
39-- | increasing or decreasing order of the record keys when iterated, and if it
@@ -79,6 +46,7 @@ data CursorDirection
79 | Prev
46 | Prev
80 | PrevUnique
47 | PrevUnique
81
48
49+
82-- | If the source of a cursor is an object store, the effective object store of
50-- | If the source of a cursor is an object store, the effective object store of
83-- | the cursor is that object store and the effective key of the cursor is the
51-- | the cursor is that object store and the effective key of the cursor is the
84-- | cursor’s position. If the source of a cursor is an index, the effective object
52-- | cursor’s position. If the source of a cursor is an index, the effective object
@@ -88,155 +56,139 @@ data CursorSource
88 = ObjectStore ObjectStore
56 = ObjectStore ObjectStore
89 | Index Index
57 | Index Index
90
58
91−-- | A key path is a list of strings that defines how to extract a key from a value.
92−-- | A valid key path is one of:
93−-- |
94−-- | - An empty list.
95−-- | - An singleton identifier, which is a string matching the IdentifierName production from the ECMAScript Language Specification [ECMA-262].
96−-- | - A singleton string consisting of two or more identifiers separated by periods (U+002E FULL STOP).
97−-- | - A non-empty list containing only strings conforming to the above requirements.
98−type KeyPath = Array String
99
59
100-- | A transaction has a mode that determines which types of interactions can be performed
60-- | A transaction has a mode that determines which types of interactions can be performed
101-- | upon that transaction. The mode is set when the transaction is created and remains
61-- | upon that transaction. The mode is set when the transaction is created and remains
102-- | fixed for the life of the transaction.
62-- | fixed for the life of the transaction.
103data TransactionMode
63data TransactionMode
104− = ReadOnly -- ^ The transaction is only allowed to read data.
64+ = ReadOnly -- ^ The transaction is only allowed to read data.
105− | ReadWrite -- ^ The transaction is allowed to read, modify and delete data from existing object stores
65+ | ReadWrite -- ^ The transaction is allowed to read, modify and delete data from existing object stores
106− | VersionChange -- ^ The transaction is allowed to read, modify and delete data from existing object stores, and can also create and remove object stores and indexes.
66+ | VersionChange -- ^ The transaction is allowed to read, modify and delete data from existing object stores, and can also create and remove object stores and indexes.
107
67
108−--------------------
109−-- Classes
110−--
111
68
112−-- | A concrete cursor not only shares IDBCursor properties, but also some
113−-- | specific attributes (see KeyCursor or CursorWithValue).
114−class (IDBCursor cursor) <= IDBConcreteCursor cursor
115
69
116−-- | Cursor objects implement the IDBCursor interface.
70+-- | A key path is a list of strings that defines how to extract a key from a value.
117−-- | There is only ever one IDBCursor instance representing a given cursor.
71+-- | A valid key path is one of:
118−-- | There is no limit on how many cursors can be used at the same time.
72+-- |
119−class IDBCursor cursor
73+-- | - An empty list.
74+-- | - An singleton identifier, which is a string matching the IdentifierName production from the ECMAScript Language Specification [ECMA-262].
75+-- | - A singleton string consisting of two or more identifiers separated by periods (U+002E FULL STOP).
76+-- | - A non-empty list containing only strings conforming to the above requirements.
77+type KeyPath = Array String
120
78
121−-- | The IDBDatabase interface represents a connection to a database.
122−class IDBDatabase db
123
79
124−-- | The IDBIndex interface represents an index handle.
80+-- | Each origin has an associated set of databases. A database has zero or more object
125−-- | Any of these methods throw an "TransactionInactiveError" DOMException
81+-- | stores which hold the data stored in the database.
126−-- | if called when the transaction is not active.
82+foreign import data Database :: Type
127−class IDBIndex index
128
83
129−-- | The IDBKeyRange interface represents a key range.
84+-- | An index allows looking up records in an object store using properties of the values
130−class IDBKeyRange range
85+-- | in the object stores records.
86+foreign import data Index :: Type
131
87
132−-- | The IDBtransaction interface.
133−class IDBTransaction tx
134
88
135−-- | The IDBObjectStore interface represents an object store handle.
89+-- | A cursor is used to iterate over a range of records in an index or an object store
136−class IDBObjectStore store
90+-- | in a specific direction. A KeyCursor doesn't hold any value.
91+foreign import data KeyCursor :: Type
137
92
138−--------------------
139−-- INSTANCES
140−--
141
93
142−instance idbCursorKeyCursor :: IDBCursor KeyCursor
94+-- | A key range is a continuous interval over some data type used for keys.
95+foreign import data KeyRange :: Type
143
96
144−instance idbCursorValueCursor :: IDBCursor ValueCursor
145
97
146−instance idbConcreteCursorKeyCursor :: IDBConcreteCursor KeyCursor
98+-- | An object store is the primary storage mechanism for storing data in a database.
99+foreign import data ObjectStore :: Type
147
100
148−instance idbConcreteCursorValueCursor :: IDBConcreteCursor ValueCursor
149
101
150−instance idbDatabaseDatabase :: IDBDatabase Database
102+-- | A Transaction is used to interact with the data in a database.
103+-- | Whenever data is read or written to the database it is done by using a transaction.
104+foreign import data Transaction :: Type
151
105
152−instance idbIndexIndex :: IDBIndex Index
153
106
154−instance idbIndexObjectStore :: IDBIndex ObjectStore
107+-- | A cursor is used to iterate over a range of records in an index or an object store
108+-- | in a specific direction. A ValueCursor also holds the value corresponding to matching key.
109+foreign import data ValueCursor :: Type
155
110
156−instance idbKeyRangeKeyRange :: IDBKeyRange KeyRange
157
111
158−instance idbObjectStoreObjectStore :: IDBObjectStore ObjectStore
112+-- | FromString represents enumerations that can be represented as Strings.
113+class FromString a where
114+ parse :: String -> Maybe a
159
115
160−instance idbTransactionTransaction :: IDBTransaction Transaction
161
116
117+foreign import _showCursor :: forall cursor. cursor -> String
162instance showKeyCursor :: Show KeyCursor where
118instance showKeyCursor :: Show KeyCursor where
163 show = _showCursor
119 show = _showCursor
164
120
121+
165instance showValueCursor :: Show ValueCursor where
122instance showValueCursor :: Show ValueCursor where
166 show = _showCursor
123 show = _showCursor
167
124
125+
126+foreign import _showDatabase
127+ :: Database
128+ -> String
129+instance showDatabase :: Show Database where
130+ show = _showDatabase
131+
132+
133+foreign import _showIndex
134+ :: Index
135+ -> String
168instance showIndex :: Show Index where
136instance showIndex :: Show Index where
169 show = _showIndex
137 show = _showIndex
170
138
139+
140+foreign import _showKeyRange
141+ :: KeyRange
142+ -> String
171instance showKeyRange :: Show KeyRange where
143instance showKeyRange :: Show KeyRange where
172 show = _showKeyRange
144 show = _showKeyRange
173
145
146+
147+foreign import _showObjectStore
148+ :: ObjectStore
149+ -> String
174instance showObjectStore :: Show ObjectStore where
150instance showObjectStore :: Show ObjectStore where
175 show = _showObjectStore
151 show = _showObjectStore
176
152
153+
154+foreign import _showTransaction
155+ :: Transaction
156+ -> String
177instance showTransaction :: Show Transaction where
157instance showTransaction :: Show Transaction where
178 show = _showTransaction
158 show = _showTransaction
179
159
180−instance showDatabase :: Show Database where
181− show = _showDatabase
182
160
183instance showCursorDirection :: Show CursorDirection where
161instance showCursorDirection :: Show CursorDirection where
184 show x =
162 show x =
185 case x of
163 case x of
186− Next -> "next"
164+ Next -> "next"
187 NextUnique -> "nextunique"
165 NextUnique -> "nextunique"
188− Prev -> "prev"
166+ Prev -> "prev"
189 PrevUnique -> "prevunique"
167 PrevUnique -> "prevunique"
190
168
169+
191instance showTransactionMode :: Show TransactionMode where
170instance showTransactionMode :: Show TransactionMode where
192 show x =
171 show x =
193 case x of
172 case x of
194− ReadOnly -> "readonly"
173+ ReadOnly -> "readonly"
195− ReadWrite -> "readwrite"
174+ ReadWrite -> "readwrite"
196 VersionChange -> "versionchange"
175 VersionChange -> "versionchange"
197
176
177+
198−instance readCursorDirection :: Read CursorDirection where
178+instance fromStringCursorDirection :: FromString CursorDirection where
199− read s =
179+ parse s =
200 case s of
180 case s of
201− "next" -> Just Next
181+ "next" -> Just Next
202 "nextunique" -> Just NextUnique
182 "nextunique" -> Just NextUnique
203− "prev" -> Just Prev
183+ "prev" -> Just Prev
204 "prevunique" -> Just PrevUnique
184 "prevunique" -> Just PrevUnique
205− _ -> Nothing
185+ _ -> Nothing
186+
206
187
207−instance readTransactionMode :: Read TransactionMode where
188+instance fromStringTransactionMode :: FromString TransactionMode where
208− read s =
189+ parse s =
209 case s of
190 case s of
210− "readonly" -> Just ReadOnly
191+ "readonly" -> Just ReadOnly
211− "readwrite" -> Just ReadWrite
192+ "readwrite" -> Just ReadWrite
212 "versionchange" -> Just VersionChange
193 "versionchange" -> Just VersionChange
213− _ -> Nothing
194+ _ -> Nothing
214−
215−--------------------
216−-- FFI
217−--
218−
219−foreign import _showCursor
220− :: forall cursor
221− . cursor
222− -> String
223−
224−foreign import _showDatabase
225− :: Database
226− -> String
227−
228−foreign import _showIndex
229− :: Index
230− -> String
231−
232−foreign import _showKeyRange
233− :: KeyRange
234− -> String
235−
236−foreign import _showObjectStore
237− :: ObjectStore
238− -> String
239−
240−foreign import _showTransaction
241− :: Transaction
242− -> String
src/Database/IndexedDB/IDBCursor.js+27−63
@@ -1,6 +1,6 @@
1const errorHandler = function errorHandler(cb) {
1const errorHandler = function errorHandler(cb) {
2 return function _handler(e) {
2 return function _handler(e) {
3− cb(e.target.error);
3+ cb(new Error(e.target.error.name));
4 };
4 };
5};
5};
6
6
@@ -10,135 +10,99 @@ const successHandler = function successHandler(cb) {
10 };
10 };
11};
11};
12
12
13+
13−export function _advance(cursor, count) {
14+exports._advance = function _advance(cursor, count) {
14− return function aff(error, success) {
15+ return function aff(success, error) {
15 try {
16 try {
16 cursor.advance(count);
17 cursor.advance(count);
17 success();
18 success();
18 } catch (e) {
19 } catch (e) {
19− error(e);
20+ error(new Error(e.name));
20 }
21 }
21−
22− return function canceler(_, cancelerError) {
23− cancelerError(new Error("Can't cancel IDB Effects"));
24− };
25 };
22 };
26};
23};
27
24
28−export function _continue(cursor, key) {
25+exports._continue = function _continue(cursor, key) {
29− return function aff(error, success) {
26+ return function aff(success, error) {
30 try {
27 try {
31 cursor.continue(key || undefined);
28 cursor.continue(key || undefined);
32 success();
29 success();
33 } catch (e) {
30 } catch (e) {
34− error(e);
31+ error(new Error(e.name));
35 }
32 }
36−
37− return function canceler(_, cancelerError) {
38− cancelerError(new Error("Can't cancel IDB Effects"));
39− };
40 };
33 };
41};
34};
42
35
43−export function _continuePrimaryKey(cursor, key, primaryKey) {
36+exports._continuePrimaryKey = function _continuePrimaryKey(cursor, key, primaryKey) {
44− return function aff(error, success) {
37+ return function aff(success, error) {
45 try {
38 try {
46 cursor.continuePrimaryKey(key, primaryKey);
39 cursor.continuePrimaryKey(key, primaryKey);
47 success();
40 success();
48 } catch (e) {
41 } catch (e) {
49− error(e);
42+ error(new Error(e.name));
50 }
43 }
51−
52− return function canceler(_, cancelerError) {
53− cancelerError(new Error("Can't cancel IDB Effects"));
54− };
55 };
44 };
56};
45};
57
46
58−export function _delete(cursor) {
47+exports._delete = function _delete(cursor) {
59− return function aff(error, success) {
48+ return function aff(success, error) {
60 try {
49 try {
61 const request = cursor.delete();
50 const request = cursor.delete();
62 request.onsuccess = successHandler(success);
51 request.onsuccess = successHandler(success);
63 request.onerror = errorHandler(error);
52 request.onerror = errorHandler(error);
64 } catch (e) {
53 } catch (e) {
65− error(e);
54+ error(new Error(e.name));
66 }
55 }
67−
68− return function canceler(_, cancelerError) {
69− cancelerError(new Error("Can't cancel IDB Effects"));
70− };
71 };
56 };
72};
57};
73
58
74−export function _direction(fromString, cursor) {
59+exports._direction = function _direction(fromString, cursor) {
75 return fromString(cursor.direction);
60 return fromString(cursor.direction);
76};
61};
77
62
78−export function _key(cursor) {
63+exports._key = function _key(cursor) {
79− return function aff(error, success) {
64+ return function aff(success, error) {
80 try {
65 try {
81 success(cursor.key);
66 success(cursor.key);
82 } catch (e) {
67 } catch (e) {
83− error(e);
68+ error(new Error(e.name));
84 }
69 }
85−
86− return function canceler(_, cancelerError) {
87− cancelerError(new Error("Can't cancel IDB Effects"));
88− };
89 };
70 };
90};
71};
91
72
92−export function _primaryKey(cursor) {
73+exports._primaryKey = function _primaryKey(cursor) {
93− return function aff(error, success) {
74+ return function aff(success, error) {
94 try {
75 try {
95 success(cursor.primaryKey);
76 success(cursor.primaryKey);
96 } catch (e) {
77 } catch (e) {
97− error(e);
78+ error(new Error(e.name));
98 }
79 }
99−
100− return function canceler(_, cancelerError) {
101− cancelerError(new Error("Can't cancel IDB Effects"));
102− };
103 };
80 };
104};
81};
105
82
106−export function _source(IDBObjectStore, IDBIndex, cursor) {
83+exports._source = function _source(IDBObjectStore, IDBIndex, cursor) {
107 switch (cursor.source.constructor.name) {
84 switch (cursor.source.constructor.name) {
108 case 'IDBIndex':
85 case 'IDBIndex':
109 return IDBIndex(cursor.source);
86 return IDBIndex(cursor.source);
110 case 'IDBObjectStore':
87 case 'IDBObjectStore':
111 return IDBObjectStore(cursor.source);
88 return IDBObjectStore(cursor.source);
112 default:
89 default:
113− throw Object.create(Error.prototype, {
114− message: {
115− enumerable: true,
116− value: 'Unable to retrieve the cursor\'s source constructor.',
117− },
118− name: {
119− enumerable: true,
120− value: 'UnexpectedCursorSource',
90+ throw new Error('UnexpectedCursorSource');
121− },
122− });
123 }
91 }
124};
92};
125
93
126−export function _update(cursor, value) {
94+exports._update = function _update(cursor, value) {
127− return function aff(error, success) {
95+ return function aff(success, error) {
128 try {
96 try {
129 const request = cursor.update(value);
97 const request = cursor.update(value);
130 request.onsuccess = successHandler(success);
98 request.onsuccess = successHandler(success);
131 request.onerror = errorHandler(error);
99 request.onerror = errorHandler(error);
132 } catch (e) {
100 } catch (e) {
133− error(e);
101+ error(new Error(e.name));
134 }
102 }
135−
136− return function canceler(_, cancelerError) {
137− cancelerError(new Error("Can't cancel IDB Effects"));
138− };
139 };
103 };
140};
104};
141
105
142−export function _value(cursor) {
106+exports._value = function _value(cursor) {
143 return cursor.value;
107 return cursor.value;
144};
108};
src/Database/IndexedDB/IDBCursor.purs+162−111
@@ -1,186 +1,237 @@
1-- | A cursor is used to iterate over a range of records in an index or
1-- | A cursor is used to iterate over a range of records in an index or
2-- | an object store in a specific direction.
2-- | an object store in a specific direction.
3module Database.IndexedDB.IDBCursor
3module Database.IndexedDB.IDBCursor
4− -- * Interface
5− ( advance
6− , continue
7− , continuePrimaryKey
4+ ( class IDBCursor, advance, continue, continuePrimaryKey, delete, update
8− , delete
9− , update
10−
11− -- * Attributes
12 , direction
5 , direction
13 , key
6 , key
14 , primaryKey
7 , primaryKey
15 , source
8 , source
9+ , direction'
10+ , key'
11+ , primaryKey'
12+ , source'
16 , value
13 , value
17 ) where
14 ) where
18
15
16+import Prelude (Unit, ($), (>>>), map)
17+
18+import Control.Monad.Aff (Aff)
19+import Data.Function.Uncurried as Fn
20+import Data.Function.Uncurried (Fn2, Fn3)
21+import Data.Maybe (Maybe)
22+import Data.Nullable (Nullable, toNullable)
23+import Data.Foreign (Foreign, toForeign, unsafeFromForeign)
24+
19import Database.IndexedDB.Core
25import Database.IndexedDB.Core
26+import Database.IndexedDB.IDBKey.Internal (class IDBKey, Key(..), toKey, extractForeign)
20
27
21−import Data.Function.Uncurried (Fn2, Fn3)
22−import Data.Function.Uncurried as Fn
23−import Data.Maybe (Maybe)
24−import Data.Nullable (Nullable, toNullable)
25−import Data.String.Read (read)
26−import Database.IndexedDB.IDBKey.Internal (class IDBKey, Key, toKey, unsafeFromKey)
27−import Effect.Aff (Aff)
28−import Effect.Aff.Compat (EffectFnAff, fromEffectFnAff)
29−import Foreign (Foreign, unsafeFromForeign, unsafeToForeign)
30−import Prelude (Unit, ($), (>>>), (<<<), map)
31
28
32--------------------
29--------------------
33-- INTERFACES
30-- INTERFACES
34--
31--
32+-- | Cursor objects implement the IDBCursor interface.
33+-- | There is only ever one IDBCursor instance representing a given cursor.
34+-- | There is no limit on how many cursors can be used at the same time.
35+class IDBCursor cursor where
36+ -- | Advances the cursor through the next count records in range.
37+ advance
38+ :: forall e
39+ . cursor
40+ -> Int
41+ -> Aff (idb :: IDB | e) Unit
42+
43+ -- | Advances the cursor to the next record in range matching or after key.
44+ continue
45+ :: forall e k. (IDBKey k)
46+ => cursor
47+ -> Maybe k
48+ -> Aff (idb :: IDB | e) Unit
49+
50+ -- | Advances the cursor to the next record in range matching or after key and primaryKey. Throws an "InvalidAccessError" DOMException if the source is not an index.
51+ continuePrimaryKey
52+ :: forall e k. (IDBKey k)
53+ => cursor
54+ -> k
55+ -> k
56+ -> Aff (idb :: IDB | e) Unit
57+
58+ -- | Delete the record pointed at by the cursor with a new value.
59+ delete
60+ :: forall e
61+ . cursor
62+ -> Aff (idb :: IDB | e) Unit
63+
64+ -- | Update the record pointed at by the cursor with a new value.
65+ -- |
66+ -- | Throws a "DataError" DOMException if the effective object store uses
67+ -- | in-line keys and the key would have changed.
68+ update
69+ :: forall val e
70+ . cursor
71+ -> val
72+ -> Aff (idb :: IDB | e) Key
35
73
36−-- | Advances the cursor through the next count records in range.
37−advance
38− :: forall cursor
39− . (IDBCursor cursor)
40− => cursor
41− -> Int
42− -> Aff Unit
43−advance c =
44− fromEffectFnAff <<< Fn.runFn2 _advance c
45−
46−-- | Advances the cursor to the next record in range matching or after key.
47−continue
48− :: forall k cursor
49− . (IDBKey k)
50− => (IDBCursor cursor)
51− => cursor
52− -> Maybe k
53− -> Aff Unit
54−continue c mk =
55− fromEffectFnAff $ Fn.runFn2 _continue c (toNullable $ map (toKey >>> unsafeFromKey) mk)
56−
57−-- | Advances the cursor to the next record in range matching or after key and primaryKey. Throws an "InvalidAccessError" DOMException if the source is not an index.
58−continuePrimaryKey
59− :: forall k cursor
60− . (IDBKey k)
61− => (IDBCursor cursor)
62− => cursor
63− -> k
64− -> k
65− -> Aff Unit
66−continuePrimaryKey c k1 k2 =
67− fromEffectFnAff $ Fn.runFn3 _continuePrimaryKey c (unsafeFromKey $ toKey k1) (unsafeFromKey $ toKey k2)
68−
69−-- | Delete the record pointed at by the cursor with a new value.
70−delete
71− :: forall cursor
72− . (IDBCursor cursor)
73− => cursor
74− -> Aff Unit
75−delete =
76− fromEffectFnAff <<< _delete
77−
78−-- | Update the record pointed at by the cursor with a new value.
79−-- |
80−-- | Throws a "DataError" DOMException if the effective object store uses
81−-- | in-line keys and the key would have changed.
82−update
83− :: forall val cursor
84− . (IDBCursor cursor)
85− => cursor
86− -> val
87− -> Aff Key
88−update c =
89− map toKey <<< fromEffectFnAff <<< Fn.runFn2 _update c <<< unsafeToForeign
90
74
91--------------------
75--------------------
92-- ATTRIBUTES
76-- ATTRIBUTES
93--
77--
78+-- | Returns the direction (Next|NextUnique|Prev|PrevUnique) of the cursor.
79+direction'
80+ :: KeyCursor
81+ -> CursorDirection
82+direction' =
83+ Fn.runFn2 _direction (parse >>> toNullable)
84+
85+
86+-- | Returns the key of the cursor. Throws a "InvalidStateError" DOMException
87+-- | if the cursor is advancing or is finished.
88+key'
89+ :: forall e
90+ . KeyCursor
91+ -> Aff (idb :: IDB | e) Key
92+key' =
93+ _key >>> map Key
94+
95+
96+-- | Returns the effective key of the cursor. Throws a "InvalidStateError" DOMException
97+-- | if the cursor is advancing or is finished.
98+primaryKey'
99+ :: forall e
100+ . KeyCursor
101+ -> Aff (idb :: IDB | e) Key
102+primaryKey' =
103+ _primaryKey >>> map Key
104+
105+
106+-- | Returns the IDBObjectStore or IDBIndex the cursor was opened from.
107+source'
108+ :: KeyCursor
109+ -> CursorSource
110+source' =
111+ Fn.runFn3 _source ObjectStore Index
112+
113+
114+-- NOTE: Polymorphism not used here cause *we want* those methods to be distincs for
115+-- the concrete types mostly for consistency with the Database.IndexedDB.IDBIndex module
116+-- where the IDBIndex interfaces is shared by Index and ObjectStore, but attributes of
117+-- respective concrete types aren't shared.
118+
94
119
95-- | Returns the direction (Next|NextUnique|Prev|PrevUnique) of the cursor.
120-- | Returns the direction (Next|NextUnique|Prev|PrevUnique) of the cursor.
96direction
121direction
97− :: forall cursor
122+ :: ValueCursor
98− . (IDBConcreteCursor cursor)
99− => cursor
100 -> CursorDirection
123 -> CursorDirection
101direction =
124direction =
102− Fn.runFn2 _direction (read >>> toNullable)
125+ Fn.runFn2 _direction (parse >>> toNullable)
126+
103
127
104-- | Returns the key of the cursor. Throws a "InvalidStateError" DOMException
128-- | Returns the key of the cursor. Throws a "InvalidStateError" DOMException
105-- | if the cursor is advancing or is finished.
129-- | if the cursor is advancing or is finished.
106key
130key
107− :: forall cursor
131+ :: forall e
108− . (IDBConcreteCursor cursor)
132+ . ValueCursor
109− => cursor
133+ -> Aff (idb :: IDB | e) Key
110− -> Aff Key
111key =
134key =
112− map toKey <<< fromEffectFnAff <<< _key
135+ _key >>> map Key
136+
113
137
114-- | Returns the effective key of the cursor. Throws a "InvalidStateError" DOMException
138-- | Returns the effective key of the cursor. Throws a "InvalidStateError" DOMException
115-- | if the cursor is advancing or is finished.
139-- | if the cursor is advancing or is finished.
116primaryKey
140primaryKey
117− :: forall cursor
141+ :: forall e
118− . (IDBConcreteCursor cursor)
142+ . ValueCursor
119− => cursor
143+ -> Aff (idb :: IDB | e) Key
120− -> Aff Key
121primaryKey =
144primaryKey =
122− map toKey <<< fromEffectFnAff <<< _primaryKey
145+ _primaryKey >>> map Key
146+
123
147
124-- | Returns the IDBObjectStore or IDBIndex the cursor was opened from.
148-- | Returns the IDBObjectStore or IDBIndex the cursor was opened from.
125source
149source
126− :: forall cursor
150+ :: ValueCursor
127− . (IDBConcreteCursor cursor)
128− => cursor
129 -> CursorSource
151 -> CursorSource
130source =
152source =
131 Fn.runFn3 _source ObjectStore Index
153 Fn.runFn3 _source ObjectStore Index
132
154
155+
133value
156value
134 :: forall val
157 :: forall val
135− . ValueCursor
158+ . ValueCursor
136 -> val
159 -> val
137value =
160value =
138 _value >>> unsafeFromForeign
161 _value >>> unsafeFromForeign
139
162
163+
140--------------------
164--------------------
141−-- FFI
165+-- INSTANCES
142--
166--
167+instance keyCursorKeyCursor :: IDBCursor KeyCursor where
168+ advance = Fn.runFn2 _advance
169+ continue c mk = Fn.runFn2 _continue c (toNullable $ map (toKey >>> extractForeign) mk)
170+ continuePrimaryKey c k1 k2 = Fn.runFn3 _continuePrimaryKey c (extractForeign $ toKey k1) (extractForeign $ toKey k2)
171+ delete = _delete
172+ update c = toForeign >>> Fn.runFn2 _update c >>> map Key
173+
174+
175+instance valueCursorKeyCursor :: IDBCursor ValueCursor where
176+ advance = Fn.runFn2 _advance
177+ continue c mk = Fn.runFn2 _continue c (toNullable $ map (toKey >>> extractForeign) mk)
178+ continuePrimaryKey c k1 k2 = Fn.runFn3 _continuePrimaryKey c (extractForeign $ toKey k1) (extractForeign $ toKey k2)
179+ delete = _delete
180+ update c = toForeign >>> Fn.runFn2 _update c >>> map Key
143
181
182+
183+--------------------
184+-- FFI
185+--
144foreign import _advance
186foreign import _advance
145− :: forall cursor
187+ :: forall cursor e
146− . Fn2 cursor Int (EffectFnAff Unit)
188+ . Fn2 cursor Int (Aff (idb :: IDB | e) Unit)
189+
147
190
148foreign import _continue
191foreign import _continue
149− :: forall cursor
192+ :: forall cursor e
150− . Fn2 cursor (Nullable Foreign) (EffectFnAff Unit)
193+ . Fn2 cursor (Nullable Foreign) (Aff (idb :: IDB | e) Unit)
194+
151
195
152foreign import _continuePrimaryKey
196foreign import _continuePrimaryKey
153− :: forall cursor
197+ :: forall cursor e
154− . Fn3 cursor Foreign Foreign (EffectFnAff Unit)
198+ . Fn3 cursor Foreign Foreign (Aff (idb :: IDB | e) Unit)
199+
155
200
156foreign import _delete
201foreign import _delete
157− :: forall cursor
202+ :: forall cursor e
158− . cursor
203+ . cursor
159− -> (EffectFnAff Unit)
204+ -> (Aff (idb :: IDB | e) Unit)
205+
160
206
161foreign import _direction
207foreign import _direction
162 :: forall cursor
208 :: forall cursor
163− . Fn2 (String -> Nullable CursorDirection) cursor CursorDirection
209+ . Fn2 (String -> Nullable CursorDirection) cursor CursorDirection
210+
164
211
165foreign import _key
212foreign import _key
166− :: forall cursor
213+ :: forall cursor e
167− . cursor
214+ . cursor
168− -> EffectFnAff Key
215+ -> Aff (idb :: IDB | e) Foreign
216+
169
217
170foreign import _primaryKey
218foreign import _primaryKey
171− :: forall cursor
219+ :: forall cursor e
172− . cursor
220+ . cursor
173− -> EffectFnAff Key
221+ -> Aff (idb :: IDB | e) Foreign
222+
174
223
175foreign import _source
224foreign import _source
176 :: forall cursor
225 :: forall cursor
177− . Fn3 (ObjectStore -> CursorSource) (Index -> CursorSource) cursor CursorSource
226+ . Fn3 (ObjectStore -> CursorSource) (Index -> CursorSource) cursor CursorSource
227+
178
228
179foreign import _update
229foreign import _update
180− :: forall cursor
230+ :: forall cursor e
181− . Fn2 cursor Foreign (EffectFnAff Foreign)
231+ . Fn2 cursor Foreign (Aff (idb :: IDB | e) Foreign)
232+
182
233
183foreign import _value
234foreign import _value
184 :: forall cursor val
235 :: forall cursor val
185− . cursor
236+ . cursor
186 -> val
237 -> val
src/Database/IndexedDB/IDBDatabase.js+28−62
@@ -1,25 +1,21 @@
1−const toArray = function toArray(xs) {
1+const $Core = require('Database.IndexedDB.Core/foreign');
2− return Array.prototype.slice.apply(xs);
2+
3−};
3+const toArray = $Core.toArray;
4
4
5
5
6−export function _close(db) {
6+exports._close = function _close(db) {
7− return function aff(error, success) {
7+ return function aff(success, error) {
8 try {
8 try {
9 db.close();
9 db.close();
10 success();
10 success();
11 } catch (e) {
11 } catch (e) {
12− error(e);
12+ error(new Error(e.name));
13 }
13 }
14−
15− return function canceler(_, cancelerError) {
16− cancelerError(new Error("Can't cancel IDB Effects"));
17− };
18 };
14 };
19};
15};
20
16
21−export function _createObjectStore(db, name, opts) {
17+exports._createObjectStore = function _createObjectStore(db, name, opts) {
22− return function aff(error, success) {
18+ return function aff(success, error) {
23 var keyPath;
19 var keyPath;
24
20
25 try {
21 try {
@@ -43,107 +39,77 @@ export function _createObjectStore(db, name, opts) {
43 });
39 });
44 success(store);
40 success(store);
45 } catch (e) {
41 } catch (e) {
46− error(e);
42+ error(new Error(e.name));
47 }
43 }
48−
49− return function canceler(_, cancelerError) {
50− cancelerError(new Error("Can't cancel IDB Effects"));
51− };
52 };
44 };
53};
45};
54
46
55−export function _deleteObjectStore(db, name) {
47+exports._deleteObjectStore = function _deleteObjectStore(db, name) {
56− return function aff(error, success) {
48+ return function aff(success, error) {
57 try {
49 try {
58 db.deleteObjectStore(name);
50 db.deleteObjectStore(name);
59 success();
51 success();
60 } catch (e) {
52 } catch (e) {
61− error(e);
53+ error(new Error(e.name));
62 }
54 }
63−
64− return function canceler(_, cancelerError) {
65− cancelerError(new Error("Can't cancel IDB Effects"));
66− };
67 };
55 };
68};
56};
69
57
70−export function _name(db) {
58+exports._name = function _name(db) {
71 return db.name;
59 return db.name;
72};
60};
73
61
74−export function _objectStoreNames(db) {
62+exports._objectStoreNames = function _objectStoreNames(db) {
75 return toArray(db.objectStoreNames);
63 return toArray(db.objectStoreNames);
76};
64};
77
65
78−export function _onAbort(db, f) {
66+exports._onAbort = function _onAbort(db, f) {
79− return function aff(error, success) {
67+ return function aff(success) {
80 db.onabort = function onabort() {
68 db.onabort = function onabort() {
81 f();
69 f();
82 };
70 };
83 success();
71 success();
84−
85− return function canceler(_, cancelerError) {
86− cancelerError(new Error("Can't cancel IDB Effects"));
87− };
88 };
72 };
89};
73};
90
74
91−export function _onClose(db, f) {
75+exports._onClose = function _onClose(db, f) {
92− return function aff(error, success) {
76+ return function aff(success) {
93 db.onclose = function onclose() {
77 db.onclose = function onclose() {
94 f();
78 f();
95 };
79 };
96 success();
80 success();
97−
98− return function canceler(_, cancelerError) {
99− cancelerError(new Error("Can't cancel IDB Effects"));
100− };
101 };
81 };
102};
82};
103
83
104−export function _onError(db, f) {
84+exports._onError = function _onError(db, f) {
105− return function aff(error, success) {
85+ return function aff(success) {
106 db.onerror = function onerror(e) {
86 db.onerror = function onerror(e) {
107− f(e.target.error)();
87+ f(new Error(e.target.error.name))();
108 };
88 };
109 success();
89 success();
110−
111− return function canceler(_, cancelerError) {
112− cancelerError(new Error("Can't cancel IDB Effects"));
113− };
114 };
90 };
115};
91};
116
92
117−export function _onVersionChange(db, f) {
93+exports._onVersionChange = function _onVersionChange(db, f) {
118− return function aff(error, success) {
94+ return function aff(success) {
119 db.onversionchange = function onversionchange(e) {
95 db.onversionchange = function onversionchange(e) {
120 f({ oldVersion: e.oldVersion, newVersion: e.newVersion })();
96 f({ oldVersion: e.oldVersion, newVersion: e.newVersion })();
121 };
97 };
122 success();
98 success();
123−
124− return function canceler(_, cancelerError) {
125− cancelerError(new Error("Can't cancel IDB Effects"));
126− };
127 };
99 };
128};
100};
129
101
130−export function _transaction(db, stores, mode) {
102+exports._transaction = function _transaction(db, stores, mode) {
131− return function aff(error, success) {
103+ return function aff(success, error) {
132− var transaction;
133 try {
104 try {
134− transaction = db.transaction(stores, mode);
105+ const transaction = db.transaction(stores, mode);
135 success(transaction);
106 success(transaction);
136 } catch (e) {
107 } catch (e) {
137− error(e);
108+ error(new Error(e.name));
138 }
109 }
139−
140− return function canceler(_, cancelerError, cancelerSuccess) {
141− transaction.abort();
142− cancelerSuccess();
143− };
144 };
110 };
145};
111};
146
112
147−export function _version(db) {
113+exports._version = function _version(db) {
148 return db.version;
114 return db.version;
149};
115};
src/Database/IndexedDB/IDBDatabase.purs+132−132
@@ -1,215 +1,215 @@
1-- | Each origin has an associated set of databases. A database has zero or more object
1-- | Each origin has an associated set of databases. A database has zero or more object
2-- | stores which hold the data stored in the database.
2-- | stores which hold the data stored in the database.
3module Database.IndexedDB.IDBDatabase
3module Database.IndexedDB.IDBDatabase
4− -- * Types
5− ( StoreName
6− , ObjectStoreParameters
7− , defaultParameters
8−
9− -- * Interface
10− , close
11− , createObjectStore
4+ ( class IDBDatabase, close, createObjectStore, deleteObjectStore, transaction
12− , deleteObjectStore
5+ , StoreName
13− , transaction
14−
15− -- * Attributes
16 , name
6 , name
17 , objectStoreNames
7 , objectStoreNames
18 , version
8 , version
19−
20− -- * Event handlers
21 , onAbort
9 , onAbort
22 , onClose
10 , onClose
23 , onError
11 , onError
24 , onVersionChange
12 , onVersionChange
25 ) where
13 ) where
26
14
15+import Prelude (Unit, show)
16+
17+import Control.Monad.Aff (Aff)
18+import Control.Monad.Eff (Eff)
19+import Control.Monad.Eff.Exception (Error)
20+import Data.Function.Uncurried as Fn
21+import Data.Function.Uncurried (Fn2, Fn3)
22+
27import Database.IndexedDB.Core
23import Database.IndexedDB.Core
24+import Database.IndexedDB.IDBObjectStore (IDBObjectStoreParameters)
28
25
29−import Data.Function.Uncurried (Fn2, Fn3)
30−import Data.Function.Uncurried as Fn
31−import Effect (Effect)
32−import Effect.Aff (Aff)
33−import Effect.Aff.Compat (EffectFnAff, fromEffectFnAff)
34−import Effect.Exception (Error)
35−import Prelude (Unit, show, (<<<), ($))
36
26
37--------------------
27--------------------
38−-- TYPES
28+-- INTERFACE
39--
29--
30+-- | The IDBDatabase interface represents a connection to a database.
31+class IDBDatabase db where
32+ -- | Closes the connection once all running transactions have finished.
33+ close
34+ :: forall e
35+ . db
36+ -> Aff (idb :: IDB | e) Unit
37+
38+ -- | Creates a new object store with the given name and options and returns a new IDBObjectStore.
39+ -- |
40+ -- | Throws a "InvalidStateError" DOMException if not called within an upgrade transaction
41+ createObjectStore
42+ :: forall e
43+ . db
44+ -> StoreName
45+ -> IDBObjectStoreParameters
46+ -> Aff (idb :: IDB | e) ObjectStore
47+
48+ -- | Deletes the object store with the given name.
49+ -- |
50+ -- | Throws a "InvalidStateError" DOMException if not called within an upgrade transaction.
51+ deleteObjectStore
52+ :: forall e
53+ . db
54+ -> StoreName
55+ -> Aff (idb :: IDB | e) ObjectStore
56+
57+ -- | Returns a new transaction with the given mode (ReadOnly|ReadWrite)
58+ -- | and scope which in the form of an array of object store names.
59+ transaction
60+ :: forall e
61+ . db
62+ -> Array StoreName
63+ -> TransactionMode
64+ -> Aff (idb :: IDB | e) Transaction
65+
40
66
41-- | Type alias for StoreName
67-- | Type alias for StoreName
42type StoreName = String
68type StoreName = String
43
69
44−-- | Options provided when creating an object store.
45−type ObjectStoreParameters =
46− { keyPath :: KeyPath
47− , autoIncrement :: Boolean
48− }
49−
50−defaultParameters :: ObjectStoreParameters
51−defaultParameters =
52− { keyPath: []
53− , autoIncrement: false
54− }
55−
56−--------------------
57−-- INTERFACE
58−--
59−
60−-- | Closes the connection once all running transactions have finished.
61−close
62− :: forall db
63− . (IDBDatabase db)
64− => db
65− -> Aff Unit
66−close =
67− fromEffectFnAff <<< _close
68−
69−-- | Creates a new object store with the given name and options and returns a new IDBObjectStore.
70−-- |
71−-- | Throws a "InvalidStateError" DOMException if not called within an upgrade transaction
72−createObjectStore
73− :: forall db
74− . (IDBDatabase db)
75− => db
76− -> StoreName
77− -> ObjectStoreParameters
78− -> Aff ObjectStore
79−createObjectStore db name' opts =
80− fromEffectFnAff $ Fn.runFn3 _createObjectStore db name' opts
81−
82−-- | Deletes the object store with the given name.
83−-- |
84−-- | Throws a "InvalidStateError" DOMException if not called within an upgrade transaction.
85−deleteObjectStore
86− :: forall db
87− . (IDBDatabase db)
88− => db
89− -> StoreName
90− -> Aff ObjectStore
91−deleteObjectStore db name' =
92− fromEffectFnAff $ Fn.runFn2 _deleteObjectStore db name'
93−
94−-- | Returns a new transaction with the given mode (ReadOnly|ReadWrite)
95−-- | and scope which in the form of an array of object store names.
96−transaction
97− :: forall db
98− . (IDBDatabase db)
99− => db
100− -> Array StoreName
101− -> TransactionMode
102− -> Aff Transaction
103−transaction db stores mode' =
104− fromEffectFnAff $ Fn.runFn3 _transaction db stores (show mode')
105
70
106--------------------
71--------------------
107-- ATTRIBUTES
72-- ATTRIBUTES
108--
73--
109−
110-- | Returns the name of the database.
74-- | Returns the name of the database.
111name
75name
112− :: Database
76+ :: Database
113− -> String
77+ -> String
114name =
78name =
115 _name
79 _name
116
80
81+
117-- | Returns a list of the names of object stores in the database.
82-- | Returns a list of the names of object stores in the database.
118objectStoreNames
83objectStoreNames
119− :: Database
84+ :: Database
120− -> Array String
85+ -> Array String
121objectStoreNames =
86objectStoreNames =
122 _objectStoreNames
87 _objectStoreNames
123
88
89+
124-- | Returns the version of the database.
90-- | Returns the version of the database.
125version
91version
126− :: Database
92+ :: Database
127− -> Int
93+ -> Int
128version =
94version =
129 _version
95 _version
130
96
97+
131--------------------
98--------------------
132-- EVENT HANDLERS
99-- EVENT HANDLERS
133--
100--
134-- | Event handler for the `abort` event.
101-- | Event handler for the `abort` event.
135onAbort
102onAbort
103+ :: forall e e'
136− :: Database
104+ . Database
137− -> Effect Unit
105+ -> Eff ( | e') Unit
138− -> Aff Unit
106+ -> Aff (idb :: IDB | e) Unit
139onAbort db f =
107onAbort db f =
140− fromEffectFnAff $ Fn.runFn2 _onAbort db f
108+ Fn.runFn2 _onAbort db f
109+
141
110
142-- | Event handler for the `close` event.
111-- | Event handler for the `close` event.
143onClose
112onClose
113+ :: forall e e'
144− :: Database
114+ . Database
145− -> Effect Unit
115+ -> Eff ( | e') Unit
146− -> Aff Unit
116+ -> Aff (idb :: IDB | e) Unit
147onClose db f =
117onClose db f =
148− fromEffectFnAff $ Fn.runFn2 _onClose db f
118+ Fn.runFn2 _onClose db f
119+
149
120
150-- | Event handler for the `error` event.
121-- | Event handler for the `error` event.
151onError
122onError
123+ :: forall e e'
152− :: Database
124+ . Database
153− -> (Error -> Effect Unit)
125+ -> (Error -> Eff ( | e') Unit)
154− -> Aff Unit
126+ -> Aff (idb :: IDB | e) Unit
155onError db f =
127onError db f =
156− fromEffectFnAff $ Fn.runFn2 _onError db f
128+ Fn.runFn2 _onError db f
129+
157
130
158-- | Event handler for the `versionchange` event.
131-- | Event handler for the `versionchange` event.
159onVersionChange
132onVersionChange
133+ :: forall e e'
160− :: Database
134+ . Database
161− -> ( { oldVersion :: Int, newVersion :: Int }
135+ -> ({ oldVersion :: Int, newVersion :: Int }
162− -> Effect Unit
136+ -> Eff ( | e') Unit)
163− )
164− -> Aff Unit
137+ -> Aff (idb :: IDB | e) Unit
165onVersionChange db f =
138onVersionChange db f =
166− fromEffectFnAff $ Fn.runFn2 _onVersionChange db f
139+ Fn.runFn2 _onVersionChange db f
140+
167
141
168--------------------
142--------------------
169−-- FFI
143+-- INSTANCES
170--
144--
145+instance idbDatabaseDatabase :: IDBDatabase Database where
146+ close =
147+ _close
148+
149+ createObjectStore db name' opts =
150+ Fn.runFn3 _createObjectStore db name' opts
151+
152+ deleteObjectStore db name' =
153+ Fn.runFn2 _deleteObjectStore db name'
154+
155+ transaction db stores mode' =
156+ Fn.runFn3 _transaction db stores (show mode')
157+
171
158
159+--------------------
160+-- FFI
161+--
172foreign import _close
162foreign import _close
173− :: forall db
163+ :: forall db e
174− . db
164+ . db
175− -> EffectFnAff Unit
165+ -> Aff (idb :: IDB | e) Unit
166+
176
167
177foreign import _createObjectStore
168foreign import _createObjectStore
178− :: forall db
169+ :: forall db e
179− . Fn3 db String { keyPath :: Array String, autoIncrement :: Boolean } (EffectFnAff ObjectStore)
170+ . Fn3 db String { keyPath :: Array String, autoIncrement :: Boolean } (Aff (idb :: IDB | e) ObjectStore)
171+
180
172
181foreign import _deleteObjectStore
173foreign import _deleteObjectStore
182− :: forall db
174+ :: forall db e
183− . Fn2 db String (EffectFnAff ObjectStore)
175+ . Fn2 db String (Aff (idb :: IDB | e) ObjectStore)
176+
184
177
185foreign import _name
178foreign import _name
186− :: Database
179+ :: Database
187− -> String
180+ -> String
181+
188
182
189foreign import _objectStoreNames
183foreign import _objectStoreNames
190− :: Database
184+ :: Database
191− -> Array String
185+ -> Array String
186+
192
187
193foreign import _onAbort
188foreign import _onAbort
194− :: forall db
189+ :: forall db e e'
195− . Fn2 db (Effect Unit) (EffectFnAff Unit)
190+ . Fn2 db (Eff ( | e') Unit) (Aff (idb :: IDB | e) Unit)
191+
196
192
197foreign import _onClose
193foreign import _onClose
198− :: forall db
194+ :: forall db e e'
199− . Fn2 db (Effect Unit) (EffectFnAff Unit)
195+ . Fn2 db (Eff ( | e') Unit) (Aff (idb :: IDB | e) Unit)
196+
200
197
201foreign import _onError
198foreign import _onError
202− :: forall db
199+ :: forall db e e'
203− . Fn2 db (Error -> Effect Unit) (EffectFnAff Unit)
200+ . Fn2 db (Error -> Eff ( | e') Unit) (Aff (idb :: IDB | e) Unit)
201+
204
202
205foreign import _onVersionChange
203foreign import _onVersionChange
206− :: forall db
204+ :: forall db e e'
207− . Fn2 db ({ oldVersion :: Int, newVersion :: Int } -> Effect Unit) (EffectFnAff Unit)
205+ . Fn2 db ({ oldVersion :: Int, newVersion :: Int } -> Eff ( | e') Unit) (Aff (idb :: IDB | e) Unit)
206+
208
207
209foreign import _transaction
208foreign import _transaction
210− :: forall db
209+ :: forall db e
211− . Fn3 db (Array String) String (EffectFnAff Transaction)
210+ . Fn3 db (Array String) String (Aff (idb :: IDB | e) Transaction)
211+
212
212
213foreign import _version
213foreign import _version
214− :: Database
214+ :: Database
215− -> Int
215+ -> Int
src/Database/IndexedDB/IDBFactory.js+8−21
@@ -1,6 +1,6 @@
1const errorHandler = function errorHandler(cb) {
1const errorHandler = function errorHandler(cb) {
2 return function _handler(e) {
2 return function _handler(e) {
3− cb(e.target.error);
3+ cb(new Error(e.target.error.name));
4 };
4 };
5};
5};
6
6
@@ -14,12 +14,9 @@ const noOp2 = function noOp2() {
14 return noOp;
14 return noOp;
15};
15};
16
16
17−const noOp3 = function noOp3() {
18− return noOp2;
19−};
20
17
21−export function _deleteDatabase(name) {
18+exports._deleteDatabase = function _deleteDatabase(name) {
22− return function aff(error, success) {
19+ return function aff(success, error) {
23 try {
20 try {
24 const request = indexedDB.deleteDatabase(name);
21 const request = indexedDB.deleteDatabase(name);
25
22
@@ -29,19 +26,15 @@ export function _deleteDatabase(name) {
29
26
30 request.onerror = errorHandler(error);
27 request.onerror = errorHandler(error);
31 } catch (e) {
28 } catch (e) {
32− error(e);
29+ error(new Error(e.name));
33 }
30 }
34−
35− return function canceler(_, cancelerError) {
36− cancelerError(new Error("Can't cancel IDB Effects"));
37− };
38 };
31 };
39};
32};
40
33
41−export function _open(fromMaybe, name, mver, req) {
34+exports._open = function _open(fromMaybe, name, mver, req) {
42 const ver = fromMaybe(undefined)(mver);
35 const ver = fromMaybe(undefined)(mver);
43
36
44− return function aff(error, success) {
37+ return function aff(success, error) {
45 try {
38 try {
46 const request = indexedDB.open(name, ver);
39 const request = indexedDB.open(name, ver);
47 request.onsuccess = function onSuccess(e) {
40 request.onsuccess = function onSuccess(e) {
@@ -53,18 +46,12 @@ export function _open(fromMaybe, name, mver, req) {
53 };
46 };
54
47
55 request.onupgradeneeded = function onUpgradeNeeded(e) {
48 request.onupgradeneeded = function onUpgradeNeeded(e) {
56− const meta = { oldVersion: e.oldVersion };
57− // eslint-disable-next-line max-len
58− fromMaybe(noOp3)(req.onUpgradeNeeded)(e.target.result)(e.target.transaction)(meta)();
49+ fromMaybe(noOp2)(req.onUpgradeNeeded)(e.target.result)(e.target.transaction)();
59 };
50 };
60
51
61 request.onerror = errorHandler(error);
52 request.onerror = errorHandler(error);
62 } catch (e) {
53 } catch (e) {
63− error(e);
54+ error(new Error(e.name));
64 }
55 }
65−
66− return function canceler(_, cancelerError) {
67− cancelerError(new Error("Can't cancel IDB Effects"));
68− };
69 };
56 };
70};
57};
src/Database/IndexedDB/IDBFactory.purs+32−36
@@ -1,55 +1,47 @@
1-- | Database objects are accessed through methods on the IDBFactory interface.
1-- | Database objects are accessed through methods on the IDBFactory interface.
2-- | A single object implementing this interface is present in the global scope
2-- | A single object implementing this interface is present in the global scope
3-- | of environments that support Indexed DB operations.
3-- | of environments that support Indexed DB operations.
4−module Database.IndexedDB.IDBFactory
4+module Database.IndexedDB.IDBFactory where
5− -- * Types
6− ( Callbacks
7− , DatabaseName
8− , Version
9
5
10− -- * Interface
6+import Prelude (Unit)
11− , deleteDatabase
7+
12− , open
8+import Control.Monad.Aff (Aff)
13− ) where
9+import Control.Monad.Eff (Eff)
10+import Data.Function.Uncurried as Fn
11+import Data.Function.Uncurried (Fn4)
12+import Data.Maybe (Maybe, fromMaybe)
14
13
15import Database.IndexedDB.Core
14import Database.IndexedDB.Core
16
15
17−import Data.Function.Uncurried (Fn4)
18−import Data.Function.Uncurried as Fn
19−import Data.Maybe (Maybe, fromMaybe)
20−import Effect (Effect)
21−import Effect.Aff (Aff)
22−import Effect.Aff.Compat (EffectFnAff, fromEffectFnAff)
23−import Prelude (Unit, ($), (<<<))
24
16
25--------------------
17--------------------
26−-- TYPES
18+-- INTERFACE
27--
19--
28−
29-- Type alias for binding listeners to an initial open action.
20-- Type alias for binding listeners to an initial open action.
30−type Callbacks =
21+type Callbacks e =
31− { onBlocked :: Maybe (Effect Unit)
22+ { onBlocked :: Maybe (Eff (| e) Unit)
32− , onUpgradeNeeded :: Maybe (Database -> Transaction -> { oldVersion :: Int } -> Effect Unit)
23+ , onUpgradeNeeded :: Maybe (Database -> Transaction -> Eff (| e) Unit)
33 }
24 }
34
25
26+
35-- | Type alias for DatabaseName.
27-- | Type alias for DatabaseName.
36type DatabaseName = String
28type DatabaseName = String
37
29
30+
38-- | Type alias for Version.
31-- | Type alias for Version.
39type Version = Int
32type Version = Int
40
33
41−--------------------
42−-- INTERFACE
43−--
44
34
45-- | Attempts to delete the named database. If the database already exists
35-- | Attempts to delete the named database. If the database already exists
46-- | and there are open connections that don’t close in response to a
36-- | and there are open connections that don’t close in response to a
47-- | `versionchange` event, the request will be blocked until all they close.
37-- | `versionchange` event, the request will be blocked until all they close.
48deleteDatabase
38deleteDatabase
39+ :: forall e
49− :: DatabaseName
40+ . DatabaseName
50− -> Aff Int
41+ -> Aff (idb :: IDB | e) Int
51deleteDatabase =
42deleteDatabase =
52− fromEffectFnAff <<< _deleteDatabase
43+ _deleteDatabase
44+
53
45
54-- | Attempts to open a connection to the named database with the specified version.
46-- | Attempts to open a connection to the named database with the specified version.
55-- | If the database already exists with a lower version and there are open connections
47-- | If the database already exists with a lower version and there are open connections
@@ -60,20 +52,24 @@ deleteDatabase =
60-- | When the version isn't provided (`Nothing`), attempts to open a connection to the
52-- | When the version isn't provided (`Nothing`), attempts to open a connection to the
61-- | named database with the current version, or 1 if it does not already exist.
53-- | named database with the current version, or 1 if it does not already exist.
62open
54open
55+ :: forall e e'
63− :: DatabaseName
56+ . DatabaseName
64− -> Maybe Version
57+ -> Maybe Version
65− -> Callbacks
58+ -> Callbacks e'
66− -> Aff Database
59+ -> Aff (idb :: IDB | e) Database
67open name mver req =
60open name mver req =
68− fromEffectFnAff $ Fn.runFn4 _open fromMaybe name mver req
61+ Fn.runFn4 _open fromMaybe name mver req
62+
69
63
70--------------------
64--------------------
71-- FFI
65-- FFI
72--
66--
73foreign import _deleteDatabase
67foreign import _deleteDatabase
68+ :: forall e
74− :: String
69+ . String
75− -> EffectFnAff Int
70+ -> Aff (idb :: IDB | e) Int
71+
76
72
77foreign import _open
73foreign import _open
78− :: forall a
74+ :: forall a e e'
79− . Fn4 (a -> Maybe a -> a) String (Maybe Int) (Callbacks) (EffectFnAff Database)
75+ . Fn4 (a -> Maybe a -> a) String (Maybe Int) (Callbacks e') (Aff (idb :: IDB | e) Database)
src/Database/IndexedDB/IDBIndex.purs+7−197
@@ -1,206 +1,16 @@
1-- | An index allows looking up records in an object store using properties of the values
1-- | An index allows looking up records in an object store using properties of the values
2-- | in the object stores records.
2-- | in the object stores records.
3module Database.IndexedDB.IDBIndex
3module Database.IndexedDB.IDBIndex
4− -- * Types
4+ ( module Database.IndexedDB.IDBIndex.Internal
5− ( Callbacks
5+ ) where
6−
7− -- * Interface
8− , count
9− , get
10− , getAllKeys
11− , getKey
12− , openCursor
13− , openKeyCursor
14
6
15− -- * Attributes
7+import Database.IndexedDB.IDBIndex.Internal
8+ ( class IDBIndex, count, get, getAllKeys, getKey, openCursor, openKeyCursor
9+ , IDBIndexParameters
16 , keyPath
10 , keyPath
17 , multiEntry
11 , multiEntry
18 , name
12 , name
19 , objectStore
13 , objectStore
20 , unique
14 , unique
21− ) where
15+ , defaultParameters
22−
16+ )
23−import Database.IndexedDB.Core
24−
25−import Data.Function.Uncurried (Fn2, Fn3, Fn4)
26−import Data.Function.Uncurried as Fn
27−import Data.Maybe (Maybe)
28−import Data.Nullable (Nullable, toMaybe, toNullable)
29−import Database.IndexedDB.IDBKey.Internal (Key, toKey)
30−import Effect (Effect)
31−import Effect.Aff (Aff)
32−import Effect.Aff.Compat (EffectFnAff, fromEffectFnAff)
33−import Effect.Exception (Error)
34−import Foreign (Foreign, unsafeFromForeign)
35−import Prelude (Unit, map, show, ($), (>>>))
36−
37−--------------------
38−-- TYPES
39−--
40−
41−-- | Callbacks to manipulate a cursor from an Open*Cursor call
42−type Callbacks cursor =
43− { onSuccess :: cursor -> Effect Unit
44− , onError :: Error -> Effect Unit
45− , onComplete :: Effect Unit
46− }
47−
48−--------------------
49−-- INTERFACES
50−--
51−
52−-- | Retrieves the number of records matching the key range in query.
53−count
54− :: forall index
55− . (IDBIndex index)
56− => index
57− -> Maybe KeyRange
58− -> Aff Int
59−count index range =
60− fromEffectFnAff $ Fn.runFn2 _count index (toNullable range)
61−
62−-- | Retrieves the value of the first record matching the given key range in query.
63−-- |
64−-- | NOTE
65−-- | The coercion from `a` to any type is unsafe and might throw a runtime error if incorrect.
66−get
67− :: forall a index
68− . (IDBIndex index)
69− => index
70− -> KeyRange
71− -> Aff (Maybe a)
72−get index range =
73− map (toMaybe >>> map unsafeFromForeign) $ fromEffectFnAff $ Fn.runFn2 _get index range
74−
75−-- | Retrieves the keys of records matching the given key range in query
76−-- | (up to the number given if given).
77−getAllKeys
78− :: forall index
79− . (IDBIndex index)
80− => index
81− -> Maybe KeyRange
82− -> Maybe Int
83− -> Aff (Array Key)
84−getAllKeys index range n =
85− map (map toKey) $ fromEffectFnAff $ Fn.runFn3 _getAllKeys index (toNullable range) (toNullable n)
86−
87−-- | Retrieves the key of the first record matching the given key or key range in query.
88−getKey
89− :: forall index
90− . (IDBIndex index)
91− => index
92− -> KeyRange
93− -> Aff (Maybe Key)
94−getKey index range =
95− map (toMaybe >>> map toKey) $ fromEffectFnAff $ Fn.runFn2 _getKey index range
96−
97−-- | Opens a ValueCursor over the records matching query, ordered by direction.
98−-- | If query is `Nothing`, all records in index are matched.
99−openCursor
100− :: forall index
101− . (IDBIndex index)
102− => index
103− -> Maybe KeyRange
104− -> CursorDirection
105− -> Callbacks ValueCursor
106− -> Aff Unit
107−openCursor index range dir cb =
108− fromEffectFnAff $ Fn.runFn4 _openCursor index (toNullable range) (show dir) cb
109−
110−-- | Opens a KeyCursor over the records matching query, ordered by direction.
111−-- | If query is `Nothing`, all records in index are matched.
112−openKeyCursor
113− :: forall index
114− . (IDBIndex index)
115− => index
116− -> Maybe KeyRange
117− -> CursorDirection
118− -> Callbacks KeyCursor
119− -> Aff Unit
120−openKeyCursor index range dir cb =
121− fromEffectFnAff $ Fn.runFn4 _openKeyCursor index (toNullable range) (show dir) cb
122−
123−--------------------
124−-- ATTRIBUTES
125−--
126−-- | Returns the key path of the index.
127−keyPath
128− :: Index
129− -> KeyPath
130−keyPath =
131− _keyPath
132−
133−-- | Returns true if the index's multiEntry flag is set.
134−multiEntry
135− :: Index
136− -> Boolean
137−multiEntry =
138− _multiEntry
139−
140−-- | Returns the name of the index.
141−name
142− :: Index
143− -> String
144−name =
145− _name
146−
147−-- | Returns the IDBObjectStore the index belongs to.
148−objectStore
149− :: Index
150− -> ObjectStore
151−objectStore =
152− _objectStore
153−
154−-- | Returns true if the index's unique flag is set.
155−unique
156− :: Index
157− -> Boolean
158−unique =
159− _unique
160−
161−--------------------
162−-- FFI
163−--
164−foreign import _keyPath
165− :: Index
166− -> Array String
167−
168−foreign import _multiEntry
169− :: Index
170− -> Boolean
171−
172−foreign import _name
173− :: Index
174− -> String
175−
176−foreign import _objectStore
177− :: Index
178− -> ObjectStore
179−
180−foreign import _unique
181− :: Index
182− -> Boolean
183−
184−foreign import _count
185− :: forall index
186− . Fn2 index (Nullable KeyRange) (EffectFnAff Int)
187−
188−foreign import _get
189− :: forall index
190− . Fn2 index KeyRange (EffectFnAff (Nullable Foreign))
191−
192−foreign import _getAllKeys
193− :: forall index
194− . Fn3 index (Nullable KeyRange) (Nullable Int) (EffectFnAff (Array Foreign))
195−
196−foreign import _getKey
197− :: forall index
198− . Fn2 index KeyRange (EffectFnAff (Nullable Foreign))
199−
200−foreign import _openCursor
201− :: forall index
202− . Fn4 index (Nullable KeyRange) String (Callbacks ValueCursor) (EffectFnAff Unit)
203−
204−foreign import _openKeyCursor
205− :: forall index
206− . Fn4 index (Nullable KeyRange) String (Callbacks KeyCursor) (EffectFnAff Unit)
src/Database/IndexedDB/IDBIndex.js → src/Database/IndexedDB/IDBIndex/Internal.jsrenamed+28−52
@@ -1,6 +1,6 @@
1const errorHandler = function errorHandler(cb) {
1const errorHandler = function errorHandler(cb) {
2 return function _handler(e) {
2 return function _handler(e) {
3− cb(e.target.error);
3+ cb(new Error(e.target.error.name));
4 };
4 };
5};
5};
6
6
@@ -11,7 +11,7 @@ const successHandler = function successHandler(cb) {
11};
11};
12
12
13
13
14−export function _keyPath(index) {
14+exports._keyPath = function _keyPath(index) {
15 const path = index.keyPath;
15 const path = index.keyPath;
16
16
17 if (Array.isArray(path)) {
17 if (Array.isArray(path)) {
@@ -25,51 +25,43 @@ export function _keyPath(index) {
25 return [];
25 return [];
26};
26};
27
27
28−export function _multiEntry(index) {
28+exports._multiEntry = function _multiEntry(index) {
29 return index.multiEntry;
29 return index.multiEntry;
30};
30};
31
31
32−export function _name(index) {
32+exports._name = function _name(index) {
33 return index.name;
33 return index.name;
34};
34};
35
35
36−export function _objectStore(index) {
36+exports._objectStore = function _objectStore(index) {
37 return index.obectStore;
37 return index.obectStore;
38};
38};
39
39
40−export function _unique(index) {
40+exports._unique = function _unique(index) {
41 return index.unique;
41 return index.unique;
42};
42};
43
43
44−export function _count(index, query) {
44+exports._count = function _count(index, query) {
45− return function aff(error, success) {
45+ return function aff(success, error) {
46 try {
46 try {
47 const request = index.count(query);
47 const request = index.count(query);
48 request.onsuccess = successHandler(success);
48 request.onsuccess = successHandler(success);
49 request.onerror = errorHandler(error);
49 request.onerror = errorHandler(error);
50 } catch (e) {
50 } catch (e) {
51− error(e);
51+ error(new Error(e.name));
52 }
52 }
53−
54− return function canceler(_, cancelerError) {
55− cancelerError(new Error("Can't cancel IDB Effects"));
56− };
57 };
53 };
58};
54};
59
55
60−export function _get(index, range) {
56+exports._get = function _get(index, range) {
61− return function aff(error, success) {
57+ return function aff(success, error) {
62 try {
58 try {
63 const request = index.get(range);
59 const request = index.get(range);
64 request.onsuccess = successHandler(success);
60 request.onsuccess = successHandler(success);
65 request.onerror = errorHandler(error);
61 request.onerror = errorHandler(error);
66 } catch (e) {
62 } catch (e) {
67− error(e);
63+ error(new Error(e.name));
68 }
64 }
69−
70− return function canceler(_, cancelerError) {
71− cancelerError(new Error("Can't cancel IDB Effects"));
72− };
73 };
65 };
74};
66};
75
67
@@ -79,8 +71,8 @@ export function _get(index, range) {
79 *
71 *
80 * However, it may be doable to convert the result to some key / value structure with values of
72 * However, it may be doable to convert the result to some key / value structure with values of
81 * different types.
73 * different types.
82−export function _getAll(index, query, count) {
74+exports._getAll = function _getAll(index, query, count) {
83− return function aff(error, success) {
75+ return function aff(success, error) {
84 const request = index.getAll(query, count);
76 const request = index.getAll(query, count);
85 request.onsuccess = successHandler(success);
77 request.onsuccess = successHandler(success);
86 request.onerror = errorHandler(error);
78 request.onerror = errorHandler(error);
@@ -88,40 +80,32 @@ export function _getAll(index, query, count) {
88};
80};
89*/
81*/
90
82
91−export function _getAllKeys(index, range, count) {
83+exports._getAllKeys = function _getAllKeys(index, range, count) {
92− return function aff(error, success) {
84+ return function aff(success, error) {
93 try {
85 try {
94 const request = index.getAllKeys(range, count || undefined);
86 const request = index.getAllKeys(range, count || undefined);
95 request.onsuccess = successHandler(success);
87 request.onsuccess = successHandler(success);
96 request.onerror = errorHandler(error);
88 request.onerror = errorHandler(error);
97 } catch (e) {
89 } catch (e) {
98− error(e);
90+ error(new Error(e.name));
99 }
91 }
100−
101− return function canceler(_, cancelerError) {
102− cancelerError(new Error("Can't cancel IDB Effects"));
103− };
104 };
92 };
105};
93};
106
94
107−export function _getKey(index, range) {
95+exports._getKey = function _getKey(index, range) {
108− return function aff(error, success) {
96+ return function aff(success, error) {
109 try {
97 try {
110 const request = index.getKey(range);
98 const request = index.getKey(range);
111 request.onsuccess = successHandler(success);
99 request.onsuccess = successHandler(success);
112 request.onerror = errorHandler(error);
100 request.onerror = errorHandler(error);
113 } catch (e) {
101 } catch (e) {
114− error(e);
102+ error(new Error(e.name));
115 }
103 }
116−
117− return function canceler(_, cancelerError) {
118− cancelerError(new Error("Can't cancel IDB Effects"));
119− };
120 };
104 };
121};
105};
122
106
123−export function _openCursor(index, query, dir, cb) {
107+exports._openCursor = function _openCursor(index, query, dir, cb) {
124− return function aff(error, success) {
108+ return function aff(success, error) {
125 try {
109 try {
126 const request = index.openCursor(query, dir);
110 const request = index.openCursor(query, dir);
127 request.onsuccess = function onSuccess(e) {
111 request.onsuccess = function onSuccess(e) {
@@ -132,21 +116,17 @@ export function _openCursor(index, query, dir, cb) {
132 }
116 }
133 };
117 };
134 request.onerror = function onError(e) {
118 request.onerror = function onError(e) {
135− cb.onError(e.target.error);
119+ cb.onError(new Error(e.target.error.name));
136 };
120 };
137 success();
121 success();
138 } catch (e) {
122 } catch (e) {
139− error(e);
123+ error(new Error(e.name));
140 }
124 }
141−
142− return function canceler(_, cancelerError) {
143− cancelerError(new Error("Can't cancel IDB Effects"));
144− };
145 };
125 };
146};
126};
147
127
148−export function _openKeyCursor(index, query, dir, cb) {
128+exports._openKeyCursor = function _openKeyCursor(index, query, dir, cb) {
149− return function aff(error, success) {
129+ return function aff(success, error) {
150 try {
130 try {
151 const request = index.openKeyCursor(query, dir);
131 const request = index.openKeyCursor(query, dir);
152 request.onsuccess = function onSuccess(e) {
132 request.onsuccess = function onSuccess(e) {
@@ -157,15 +137,11 @@ export function _openKeyCursor(index, query, dir, cb) {
157 }
137 }
158 };
138 };
159 request.onerror = function onError(e) {
139 request.onerror = function onError(e) {
160− cb.onError(e.target.error);
140+ cb.onError(new Error(e.target.error.name));
161 };
141 };
162 success();
142 success();
163 } catch (e) {
143 } catch (e) {
164− error(e);
144+ error(new Error(e.name));
165 }
145 }
166−
167− return function canceler(_, cancelerError) {
168− cancelerError(new Error("Can't cancel IDB Effects"));
169− };
170 };
146 };
171};
147};
src/Database/IndexedDB/IDBIndex/Internal.pursnew file+256
@@ -0,0 +1,256 @@
1+-- | An index allows looking up records in an object store using properties of the values
2+-- | in the object stores records.
3+module Database.IndexedDB.IDBIndex.Internal where
4+
5+import Prelude
6+
7+import Control.Monad.Aff (Aff)
8+import Control.Monad.Eff (Eff)
9+import Control.Monad.Eff.Exception (Error)
10+import Data.Foreign (Foreign, unsafeFromForeign)
11+import Data.Function.Uncurried as Fn
12+import Data.Function.Uncurried (Fn2, Fn3, Fn4)
13+import Data.Maybe (Maybe)
14+import Data.Nullable (Nullable, toMaybe, toNullable)
15+
16+import Database.IndexedDB.Core (IDB, CursorDirection, Index, Key, KeyCursor, KeyRange, KeyPath, ObjectStore, ValueCursor)
17+import Database.IndexedDB.IDBKey.Internal (class IDBKey, Key(..))
18+
19+
20+--------------------
21+-- INTERFACES
22+--
23+-- | The IDBIndex interface represents an index handle.
24+-- | Any of these methods throw an "TransactionInactiveError" DOMException
25+-- | if called when the transaction is not active.
26+class IDBIndex index where
27+ -- | Retrieves the number of records matching the key range in query.
28+ count
29+ :: forall e
30+ . index
31+ -> Maybe KeyRange
32+ -> Aff (idb :: IDB | e) Int
33+
34+ -- | Retrieves the value of the first record matching the given key range in query.
35+ -- |
36+ -- | NOTE
37+ -- | The coercion from `a` to any type is unsafe and might throw a runtime error if incorrect.
38+ get
39+ :: forall a e
40+ . index
41+ -> KeyRange
42+ -> Aff (idb :: IDB | e) (Maybe a)
43+
44+ -- | Retrieves the keys of records matching the given key range in query
45+ -- | (up to the number given if given).
46+ getAllKeys
47+ :: forall e
48+ . index
49+ -> Maybe KeyRange
50+ -> Maybe Int
51+ -> Aff (idb :: IDB | e) (Array Key)
52+
53+ -- | Retrieves the key of the first record matching the given key or key range in query.
54+ getKey
55+ :: forall e
56+ . index
57+ -> KeyRange
58+ -> Aff (idb :: IDB | e) (Maybe Key)
59+
60+ -- | Opens a ValueCursor over the records matching query, ordered by direction.
61+ -- | If query is `Nothing`, all records in index are matched.
62+ openCursor
63+ :: forall e e'
64+ . index
65+ -> Maybe KeyRange
66+ -> CursorDirection
67+ -> Callbacks ValueCursor e'
68+ -> Aff (idb :: IDB | e) Unit
69+
70+ -- | Opens a KeyCursor over the records matching query, ordered by direction.
71+ -- | If query is `Nothing`, all records in index are matched.
72+ openKeyCursor
73+ :: forall e e'
74+ . index
75+ -> Maybe KeyRange
76+ -> CursorDirection
77+ -> Callbacks KeyCursor e'
78+ -> Aff (idb :: IDB | e) Unit
79+
80+
81+-- | Flags to set on the index.
82+-- |
83+-- | An index has a `unique` flag. When this flag is set, the index enforces that no
84+-- | two records in the index has the same key. If a record in the index’s referenced
85+-- | object store is attempted to be inserted or modified such that evaluating the index’s
86+-- | key path on the records new value yields a result which already exists in the index,
87+-- | then the attempted modification to the object store fails.
88+-- |
89+-- | An index has a `multiEntry` flag. This flag affects how the index behaves when the
90+-- | result of evaluating the index’s key path yields an array key. If the `multiEntry` flag
91+-- | is unset, then a single record whose key is an array key is added to the index.
92+-- | If the `multiEntry` flag is true, then the one record is added to the index for each
93+-- | of the subkeys.
94+type IDBIndexParameters =
95+ { unique :: Boolean
96+ , multiEntry :: Boolean
97+ }
98+
99+
100+-- | Callbacks to manipulate a cursor from an Open*Cursor call
101+type Callbacks cursor e =
102+ { onSuccess :: cursor -> Eff ( | e) Unit
103+ , onError :: Error -> Eff ( | e) Unit
104+ , onComplete :: Eff ( | e) Unit
105+ }
106+
107+
108+defaultParameters :: IDBIndexParameters
109+defaultParameters =
110+ { unique : false
111+ , multiEntry : false
112+ }
113+
114+
115+--------------------
116+-- ATTRIBUTES
117+--
118+-- | Returns the key path of the index.
119+keyPath
120+ :: Index
121+ -> KeyPath
122+keyPath =
123+ _keyPath
124+
125+
126+-- | Returns true if the index's multiEntry flag is set.
127+multiEntry
128+ :: Index
129+ -> Boolean
130+multiEntry =
131+ _multiEntry
132+
133+
134+-- | Returns the name of the index.
135+name
136+ :: Index
137+ -> String
138+name =
139+ _name
140+
141+
142+-- | Returns the IDBObjectStore the index belongs to.
143+objectStore
144+ :: Index
145+ -> ObjectStore
146+objectStore =
147+ _objectStore
148+
149+
150+-- | Returns true if the index's unique flag is set.
151+unique
152+ :: Index
153+ -> Boolean
154+unique =
155+ _unique
156+
157+
158+--------------------
159+-- INSTANCES
160+--
161+instance idbIndexIndex :: IDBIndex Index where
162+ count index range =
163+ Fn.runFn2 _count index (toNullable range)
164+
165+ get index range =
166+ (toMaybe >>> map unsafeFromForeign) <$> Fn.runFn2 _get index range
167+
168+ getAllKeys index range count =
169+ map Key <$> Fn.runFn3 _getAllKeys index (toNullable range) (toNullable count)
170+
171+ getKey index range =
172+ (toMaybe >>> map Key) <$> Fn.runFn2 _getKey index range
173+
174+ openCursor index range dir cb =
175+ Fn.runFn4 _openCursor index (toNullable range) (show dir) cb
176+
177+ openKeyCursor index range dir cb =
178+ Fn.runFn4 _openKeyCursor index (toNullable range) (show dir) cb
179+
180+
181+instance idbIndexObjectStore :: IDBIndex ObjectStore where
182+ count store range =
183+ Fn.runFn2 _count store (toNullable range)
184+
185+ get store range =
186+ (toMaybe >>> map unsafeFromForeign) <$> Fn.runFn2 _get store range
187+
188+ getAllKeys store range count =
189+ map Key <$> Fn.runFn3 _getAllKeys store (toNullable range) (toNullable count)
190+
191+ getKey store range =
192+ (toMaybe >>> map Key) <$> Fn.runFn2 _getKey store range
193+
194+ openCursor store range dir cb =
195+ Fn.runFn4 _openCursor store (toNullable range) (show dir) cb
196+
197+ openKeyCursor store range dir cb =
198+ Fn.runFn4 _openKeyCursor store (toNullable range) (show dir) cb
199+
200+
201+--------------------
202+-- FFI
203+--
204+foreign import _keyPath
205+ :: Index
206+ -> Array String
207+
208+
209+foreign import _multiEntry
210+ :: Index
211+ -> Boolean
212+
213+
214+foreign import _name
215+ :: Index
216+ -> String
217+
218+
219+foreign import _objectStore
220+ :: Index
221+ -> ObjectStore
222+
223+
224+foreign import _unique
225+ :: Index
226+ -> Boolean
227+
228+
229+foreign import _count
230+ :: forall index e
231+ . Fn2 index (Nullable KeyRange) (Aff (idb :: IDB | e) Int)
232+
233+
234+foreign import _get
235+ :: forall index e
236+ . Fn2 index KeyRange (Aff (idb :: IDB | e) (Nullable Foreign))
237+
238+
239+foreign import _getAllKeys
240+ :: forall index e
241+ . Fn3 index (Nullable KeyRange) (Nullable Int) (Aff (idb :: IDB | e) (Array Foreign))
242+
243+
244+foreign import _getKey
245+ :: forall index e
246+ . Fn2 index KeyRange (Aff (idb :: IDB | e) (Nullable Foreign))
247+
248+
249+foreign import _openCursor
250+ :: forall index e e'
251+ . Fn4 index (Nullable KeyRange) String (Callbacks ValueCursor e') (Aff (idb :: IDB | e) Unit)
252+
253+
254+foreign import _openKeyCursor
255+ :: forall index e e'
256+ . Fn4 index (Nullable KeyRange) String (Callbacks KeyCursor e') (Aff (idb :: IDB | e) Unit)
src/Database/IndexedDB/IDBKey.purs+1−8
@@ -5,11 +5,4 @@ module Database.IndexedDB.IDBKey
5 ( module Database.IndexedDB.IDBKey.Internal
5 ( module Database.IndexedDB.IDBKey.Internal
6 ) where
6 ) where
7
7
8−import Database.IndexedDB.IDBKey.Internal
8+import Database.IndexedDB.IDBKey.Internal(class IDBKey, Key, none, toKey, fromKey, unsafeFromKey)
9− ( class IDBKey
10− , Key
11− , none
12− , toKey
13− , fromKey
14− , unsafeFromKey
15− )
src/Database/IndexedDB/IDBKey/Internal.js+3−3
@@ -1,8 +1,8 @@
1−export function _dateTimeToForeign(y, m, d, h, mi, s, ms) {
1+exports._dateTimeToForeign = function _dateTimeToForeign(y, m, d, h, mi, s, ms) {
2 return new Date(y, m, d, h, mi, s, ms);
2 return new Date(y, m, d, h, mi, s, ms);
3};
3};
4
4
5−export function _readDateTime(parse, right, left, date) {
5+exports._readDateTime = function _readDateTime(parse, right, left, date) {
6 if (Object.getPrototypeOf(date) !== Date.prototype) {
6 if (Object.getPrototypeOf(date) !== Date.prototype) {
7 return left(typeof date);
7 return left(typeof date);
8 }
8 }
@@ -24,7 +24,7 @@ export function _readDateTime(parse, right, left, date) {
24 return right(mdate);
24 return right(mdate);
25};
25};
26
26
27−export function _unsafeReadDateTime(parse, date) {
27+exports._unsafeReadDateTime = function _unsafeReadDateTime(parse, date) {
28 const y = date.getFullYear();
28 const y = date.getFullYear();
29 const m = date.getMonth() + 1;
29 const m = date.getMonth() + 1;
30 const d = date.getDate();
30 const d = date.getDate();
src/Database/IndexedDB/IDBKey/Internal.purs+114−96
@@ -2,37 +2,44 @@
2-- |
2-- |
3-- | NOTE: Binary keys aren't supported yet.
3-- | NOTE: Binary keys aren't supported yet.
4module Database.IndexedDB.IDBKey.Internal
4module Database.IndexedDB.IDBKey.Internal
5− ( Key
5+ ( Key(..)
6− , class IDBKey
6+ , none
7− , toKey
8− , fromKey
9− , unsafeFromKey
7+ , class IDBKey, toKey , fromKey , unsafeFromKey
10− , none
8+ , extractForeign
11− ) where
9+ ) where
12
10
13import Prelude
11import Prelude
14
12
15−import Control.Alt ((<|>))
13+import Control.Alt ((<|>))
16−import Control.Monad.Except (ExceptT(..), runExceptT)
14+import Control.Monad.Except (ExceptT(..), runExceptT)
17−import Data.Date as Date
15+import Data.Date as Date
18−import Data.DateTime (DateTime(..), Time(..))
16+import Data.DateTime (DateTime(..), Time(..))
19−import Data.Either (Either(..), either, isRight)
20−import Data.Enum (fromEnum, toEnum)
17+import Data.Enum (fromEnum, toEnum)
21−import Foreign as Foreign
18+import Data.Foreign as Foreign
22−import Foreign (Foreign, F)
19+import Data.Foreign (Foreign, F)
23−import Data.Function.Uncurried as Fn
20+import Data.Function.Uncurried as Fn
24−import Data.Function.Uncurried (Fn2, Fn4, Fn7)
21+import Data.Function.Uncurried (Fn2, Fn4, Fn7)
25−import Data.Identity (Identity(..))
26−import Data.List.NonEmpty (NonEmptyList(..))
22+import Data.List.NonEmpty (NonEmptyList(..))
27−import Data.List.Types (List(..))
23+import Data.List.Types (List(..))
24+import Data.NonEmpty (NonEmpty(..))
25+import Data.Either (Either(..), either, isRight)
28−import Data.Maybe (Maybe(..))
26+import Data.Maybe (Maybe(..))
29−import Data.NonEmpty (NonEmpty(..))
27+import Data.Identity (Identity(..))
30−import Data.Nullable (Nullable, toNullable)
28+import Data.Nullable (Nullable, toNullable)
31−import Data.Time as Time
29+import Data.Time as Time
32−import Data.Traversable (traverse)
30+import Data.Traversable (traverse)
31+
33
32
34newtype Key = Key Foreign
33newtype Key = Key Foreign
35
34
35+
36+extractForeign
37+ :: Key
38+ -> Foreign
39+extractForeign (Key f) =
40+ f
41+
42+
36--------------------
43--------------------
37-- INTERFACES
44-- INTERFACES
38--
45--
@@ -40,90 +47,94 @@ newtype Key = Key Foreign
40-- | to a known type (e.g if you only strings as keys, or perfectly knows the
47-- | to a known type (e.g if you only strings as keys, or perfectly knows the
41-- | type of a given key).
48-- | type of a given key).
42class IDBKey a where
49class IDBKey a where
43− toKey :: a -> Key
50+ toKey :: a -> Key
44− fromKey :: Key -> F a
51+ fromKey :: Key -> F a
45 unsafeFromKey :: Key -> a
52 unsafeFromKey :: Key -> a
46
53
54+
47none :: Maybe Key
55none :: Maybe Key
48none =
56none =
49 Nothing
57 Nothing
50
58
59+
51--------------------
60--------------------
52-- INSTANCES
61-- INSTANCES
53--
62--
54instance eqKey :: Eq Key where
63instance eqKey :: Eq Key where
55 eq a b = (runExceptT >>> runIdentity >>> isRight) $
64 eq a b = (runExceptT >>> runIdentity >>> isRight) $
56− eq <$> ((fromKey a) :: F Int) <*> fromKey b
65+ eq <$> ((fromKey a) :: F Int) <*> fromKey b
57− <|>
66+ <|>
58− eq <$> ((fromKey a) :: F Number) <*> fromKey b
67+ eq <$> ((fromKey a) :: F Number) <*> fromKey b
59− <|>
68+ <|>
60− eq <$> ((fromKey a) :: F String) <*> fromKey b
69+ eq <$> ((fromKey a) :: F String) <*> fromKey b
61− <|>
70+ <|>
62− eq <$> ((fromKey a) :: F DateTime) <*> fromKey b
71+ eq <$> ((fromKey a) :: F DateTime) <*> fromKey b
63− <|>
72+ <|>
64− eq <$> ((fromKey a) :: F (Array Key)) <*> fromKey b
73+ eq <$> ((fromKey a) :: F (Array Key)) <*> fromKey b
65 where
74 where
66− runIdentity :: forall a. Identity a -> a
75+ runIdentity :: forall a. Identity a -> a
67− runIdentity (Identity x) = x
76+ runIdentity (Identity x) = x
77+
68
78
69instance ordKey :: Ord Key where
79instance ordKey :: Ord Key where
70− compare a b = (runExceptT >>> runIdentity >>> either (const LT) identity) $
80+ compare a b = (runExceptT >>> runIdentity >>> either (const LT) id) $
71− compare <$> ((fromKey a) :: F Int) <*> fromKey b
81+ compare <$> ((fromKey a) :: F Int) <*> fromKey b
72− <|>
82+ <|>
73− compare <$> ((fromKey a) :: F Number) <*> fromKey b
83+ compare <$> ((fromKey a) :: F Number) <*> fromKey b
74− <|>
84+ <|>
75− compare <$> ((fromKey a) :: F String) <*> fromKey b
85+ compare <$> ((fromKey a) :: F String) <*> fromKey b
76− <|>
86+ <|>
77− compare <$> ((fromKey a) :: F DateTime) <*> fromKey b
87+ compare <$> ((fromKey a) :: F DateTime) <*> fromKey b
78− <|>
88+ <|>
79− compare <$> ((fromKey a) :: F (Array Key)) <*> fromKey b
89+ compare <$> ((fromKey a) :: F (Array Key)) <*> fromKey b
80 where
90 where
81− runIdentity :: forall a. Identity a -> a
91+ runIdentity :: forall a. Identity a -> a
82− runIdentity (Identity x) = x
92+ runIdentity (Identity x) = x
93+
83
94
84instance showKey :: Show Key where
95instance showKey :: Show Key where
85 show a = (runExceptT >>> format) $
96 show a = (runExceptT >>> format) $
86− (show <$> (fromKey a :: F Int))
97+ (show <$> (fromKey a :: F Int))
87− <|>
98+ <|>
88− (show <$> (fromKey a :: F Number))
99+ (show <$> (fromKey a :: F Number))
89− <|>
100+ <|>
90− (show <$> (fromKey a :: F String))
101+ (show <$> (fromKey a :: F String))
91− <|>
102+ <|>
92− (show <$> (fromKey a :: F DateTime))
103+ (show <$> (fromKey a :: F DateTime))
93− <|>
104+ <|>
94− (show <$> (fromKey a :: F (Array Key)))
105+ (show <$> (fromKey a :: F (Array Key)))
95 where
106 where
96− format :: forall a. Identity (Either a String) -> String
107+ format :: forall a. Identity (Either a String) -> String
97− format (Identity x) =
108+ format (Identity x) =
98− either (const "(Key)") (\s -> "(Key " <> s <> ")") x
109+ either (const "(Key)") (\s -> "(Key " <> s <> ")") x
110+
99
111
100instance idbKeyKey :: IDBKey Key where
112instance idbKeyKey :: IDBKey Key where
101− toKey = identity
113+ toKey = id
102− fromKey = pure
114+ fromKey = pure
103− unsafeFromKey = identity
115+ unsafeFromKey = id
104
116
105−instance idbKeyForeign :: IDBKey Foreign where
106− toKey = Key
107− fromKey (Key f) = pure f
108− unsafeFromKey (Key f) = f
109
117
110instance idbKeyInt :: IDBKey Int where
118instance idbKeyInt :: IDBKey Int where
111− toKey = Foreign.unsafeToForeign >>> Key
119+ toKey = Foreign.toForeign >>> Key
112− fromKey (Key f) = Foreign.readInt f
120+ fromKey (Key f) = Foreign.readInt f
113 unsafeFromKey (Key f) = Foreign.unsafeFromForeign f
121 unsafeFromKey (Key f) = Foreign.unsafeFromForeign f
114
122
123+
115instance idbKeyNumber :: IDBKey Number where
124instance idbKeyNumber :: IDBKey Number where
116− toKey = Foreign.unsafeToForeign >>> Key
125+ toKey = Foreign.toForeign >>> Key
117− fromKey (Key f) = Foreign.readNumber f
126+ fromKey (Key f) = Foreign.readNumber f
118 unsafeFromKey (Key f) = Foreign.unsafeFromForeign f
127 unsafeFromKey (Key f) = Foreign.unsafeFromForeign f
119
128
129+
120instance idbKeyString :: IDBKey String where
130instance idbKeyString :: IDBKey String where
121− toKey = Foreign.unsafeToForeign >>> Key
131+ toKey = Foreign.toForeign >>> Key
122− fromKey (Key f) = Foreign.readString f
132+ fromKey (Key f) = Foreign.readString f
123 unsafeFromKey (Key f) = Foreign.unsafeFromForeign f
133 unsafeFromKey (Key f) = Foreign.unsafeFromForeign f
124
134
135+
125instance idbKeyDate :: IDBKey DateTime where
136instance idbKeyDate :: IDBKey DateTime where
126− toKey (DateTime d t) = Key $ Fn.runFn7 _dateTimeToForeign
137+ toKey (DateTime d t) = Key $ Fn.runFn7 _dateTimeToForeign
127 (fromEnum $ Date.year d)
138 (fromEnum $ Date.year d)
128 (fromEnum $ Date.month d)
139 (fromEnum $ Date.month d)
129 (fromEnum $ Date.day d)
140 (fromEnum $ Date.day d)
@@ -131,51 +142,58 @@ instance idbKeyDate :: IDBKey DateTime where
131 (fromEnum $ Time.minute t)
142 (fromEnum $ Time.minute t)
132 (fromEnum $ Time.second t)
143 (fromEnum $ Time.second t)
133 (fromEnum $ Time.millisecond t)
144 (fromEnum $ Time.millisecond t)
134− fromKey (Key f) = Fn.runFn4 _readDateTime dateTime dateTimeF dateTimeE f
145+ fromKey (Key f) = Fn.runFn4 _readDateTime dateTime dateTimeF dateTimeE f
135 unsafeFromKey (Key f) = Fn.runFn2 _unsafeReadDateTime dateTime f
146 unsafeFromKey (Key f) = Fn.runFn2 _unsafeReadDateTime dateTime f
136
147
148+
137instance idbKeyArray :: IDBKey a => IDBKey (Array a) where
149instance idbKeyArray :: IDBKey a => IDBKey (Array a) where
138− toKey = Foreign.unsafeToForeign >>> Key
150+ toKey = Foreign.toForeign >>> Key
139− fromKey (Key f) = Foreign.readArray f >>= traverse (Key >>> fromKey)
151+ fromKey (Key f) = Foreign.readArray f >>= traverse (Key >>> fromKey)
140 unsafeFromKey (Key f) = map unsafeFromKey (Foreign.unsafeFromForeign f)
152 unsafeFromKey (Key f) = map unsafeFromKey (Foreign.unsafeFromForeign f)
141
153
154+
142-- FFI constructor to build a DateTime from years, months, days, hours, minutes, seconds and millis
155-- FFI constructor to build a DateTime from years, months, days, hours, minutes, seconds and millis
143dateTime
156dateTime
144− :: Int -- ^ years
157+ :: Int -- ^ years
145− -> Int -- ^ months
158+ -> Int -- ^ months
146− -> Int -- ^ days
159+ -> Int -- ^ days
147− -> Int -- ^ hours
160+ -> Int -- ^ hours
148− -> Int -- ^ minutes
161+ -> Int -- ^ minutes
149− -> Int -- ^ seconds
162+ -> Int -- ^ seconds
150− -> Int -- ^ milliseconds
163+ -> Int -- ^ milliseconds
151− -> Nullable DateTime
164+ -> Nullable DateTime
152dateTime y m d h mi s ms =
165dateTime y m d h mi s ms =
153 toNullable $ DateTime
166 toNullable $ DateTime
154− <$> (Date.canonicalDate <$> toEnum y <*> toEnum m <*> toEnum d)
167+ <$> (Date.canonicalDate <$> toEnum y <*> toEnum m <*> toEnum d)
155− <*> (Time <$> toEnum h <*> toEnum mi <*> toEnum s <*> toEnum ms)
168+ <*> (Time <$> toEnum h <*> toEnum mi <*> toEnum s <*> toEnum ms)
169+
156
170
157-- FFI constructor to convert a JS `Date` into a successful `F DateTime`
171-- FFI constructor to convert a JS `Date` into a successful `F DateTime`
158dateTimeF
172dateTimeF
159− :: DateTime
173+ :: DateTime
160− -> F DateTime
174+ -> F DateTime
161dateTimeF =
175dateTimeF =
162 Right >>> Identity >>> ExceptT
176 Right >>> Identity >>> ExceptT
163
177
178+
164-- FFI constructor to convert a string into an errored `F DateTime`
179-- FFI constructor to convert a string into an errored `F DateTime`
165dateTimeE
180dateTimeE
166− :: String
181+ :: String
167− -> F DateTime
182+ -> F DateTime
168dateTimeE =
183dateTimeE =
169 Foreign.TypeMismatch "Date" >>> flip NonEmpty Nil >>> NonEmptyList >>> Left >>> Identity >>> ExceptT
184 Foreign.TypeMismatch "Date" >>> flip NonEmpty Nil >>> NonEmptyList >>> Left >>> Identity >>> ExceptT
170
185
186+
171--------------------
187--------------------
172-- FFI
188-- FFI
173--
189--
174foreign import _dateTimeToForeign
190foreign import _dateTimeToForeign
175− :: Fn7 Int Int Int Int Int Int Int Foreign
191+ :: Fn7 Int Int Int Int Int Int Int Foreign
192+
176
193
177foreign import _readDateTime
194foreign import _readDateTime
178− :: Fn4 (Int -> Int -> Int -> Int -> Int -> Int -> Int -> Nullable DateTime) (DateTime -> F DateTime) (String -> F DateTime) Foreign (F DateTime)
195+ :: Fn4 (Int -> Int -> Int -> Int -> Int -> Int -> Int -> Nullable DateTime) (DateTime -> F DateTime) (String -> F DateTime) Foreign (F DateTime)
196+
179
197
180foreign import _unsafeReadDateTime
198foreign import _unsafeReadDateTime
181− :: Fn2 (Int -> Int -> Int -> Int -> Int -> Int -> Int -> Nullable DateTime) Foreign DateTime
199+ :: Fn2 (Int -> Int -> Int -> Int -> Int -> Int -> Int -> Nullable DateTime) Foreign DateTime
src/Database/IndexedDB/IDBKeyRange.js+9−9
@@ -1,4 +1,4 @@
1−export function _bound(lower, upper, lowerOpen, upperOpen) {
1+exports._bound = function _bound(lower, upper, lowerOpen, upperOpen) {
2 try {
2 try {
3 return IDBKeyRange.bound(lower, upper, lowerOpen, upperOpen);
3 return IDBKeyRange.bound(lower, upper, lowerOpen, upperOpen);
4 } catch (e) {
4 } catch (e) {
@@ -6,34 +6,34 @@ export function _bound(lower, upper, lowerOpen, upperOpen) {
6 }
6 }
7};
7};
8
8
9−export function _includes(range, key) {
9+exports._includes = function _includes(range, key) {
10 return range.includes(key);
10 return range.includes(key);
11};
11};
12
12
13−export function _lower(range) {
13+exports._lower = function _lower(range) {
14 return range.lower;
14 return range.lower;
15};
15};
16
16
17−export function _lowerBound(lower, open) {
17+exports._lowerBound = function _lowerBound(lower, open) {
18 return IDBKeyRange.lowerBound(lower, open);
18 return IDBKeyRange.lowerBound(lower, open);
19};
19};
20
20
21−export function _lowerOpen(range) {
21+exports._lowerOpen = function _lowerOpen(range) {
22 return range.lowerOpen;
22 return range.lowerOpen;
23};
23};
24
24
25−export function _only(key) {
25+exports._only = function _only(key) {
26 return IDBKeyRange.only(key);
26 return IDBKeyRange.only(key);
27};
27};
28
28
29−export function _upper(range) {
29+exports._upper = function _upper(range) {
30 return range.upper;
30 return range.upper;
31};
31};
32
32
33−export function _upperBound(upper, open) {
33+exports._upperBound = function _upperBound(upper, open) {
34 return IDBKeyRange.upperBound(upper, open);
34 return IDBKeyRange.upperBound(upper, open);
35};
35};
36
36
37−export function _upperOpen(range) {
37+exports._upperOpen = function _upperOpen(range) {
38 return range.upperOpen;
38 return range.upperOpen;
39};
39};
src/Database/IndexedDB/IDBKeyRange.purs+79−81
@@ -1,76 +1,70 @@
1-- | A key has an associated type which is one of: number, date, string, binary, or array.
1-- | A key has an associated type which is one of: number, date, string, binary, or array.
2module Database.IndexedDB.IDBKeyRange
2module Database.IndexedDB.IDBKeyRange
3− -- * Types
3+ ( class IDBKeyRange, includes
4− ( Open
5−
6− -- * Constructors
7 , only
4 , only
8 , lowerBound
5 , lowerBound
9 , upperBound
6 , upperBound
10 , bound
7 , bound
11−
12− -- * Interface
13− , includes
14−
15− -- * Attributes
16 , lower
8 , lower
17 , upper
9 , upper
18 , lowerOpen
10 , lowerOpen
19 , upperOpen
11 , upperOpen
20 ) where
12 ) where
21
13
22−import Prelude (($), (>>>), map)
14+import Prelude
15+
16+import Data.Foreign (Foreign)
17+import Data.Function.Uncurried as Fn
18+import Data.Function.Uncurried (Fn2, Fn4)
19+import Data.Maybe (Maybe)
20+import Data.Nullable (Nullable, toMaybe)
23
21
24−import Foreign (Foreign)
22+import Database.IndexedDB.Core (KeyRange)
25−import Data.Function.Uncurried as Fn
23+import Database.IndexedDB.IDBKey.Internal (class IDBKey, Key(..), toKey, extractForeign)
26−import Data.Function.Uncurried (Fn2, Fn4)
27−import Data.Maybe (Maybe)
28−import Data.Nullable (Nullable, toMaybe)
29
24
30−import Database.IndexedDB.Core (class IDBKeyRange, KeyRange)
31−import Database.IndexedDB.IDBKey.Internal (class IDBKey, Key, toKey, unsafeFromKey)
32
25
33--------------------
26--------------------
34−-- TYPES
27+-- INTERFACES
35--
28--
29+-- | The IDBKeyRange interface represents a key range.
30+class IDBKeyRange range where
31+ -- | Returns true if key is included in the range, and false otherwise.
32+ includes :: forall k. (IDBKey k) => range -> k -> Boolean
36
33
37-- | Type alias for open
34-- | Type alias for open
38type Open = Boolean
35type Open = Boolean
39
36
40−--------------------
41−-- CONSTRUCTORS
42−--
43
37
44-- | Returns a new IDBKeyRange spanning only key.
38-- | Returns a new IDBKeyRange spanning only key.
45only
39only
46− :: forall a
40+ :: forall a. (IDBKey a)
47− . (IDBKey a)
48− => a
41+ => a
49− -> KeyRange
42+ -> KeyRange
50only key =
43only key =
51− _only (unsafeFromKey $ toKey key)
44+ _only (extractForeign $ toKey key)
45+
52
46
53-- | Returns a new IDBKeyRange starting at key with no upper bound.
47-- | Returns a new IDBKeyRange starting at key with no upper bound.
54-- | If `Open` is `true`, key is not included in the range.
48-- | If `Open` is `true`, key is not included in the range.
55lowerBound
49lowerBound
56− :: forall a
50+ :: forall a. (IDBKey a)
57− . (IDBKey a)
58− => a
51+ => a
59− -> Open
52+ -> Open
60− -> KeyRange
53+ -> KeyRange
61lowerBound key open =
54lowerBound key open =
62− Fn.runFn2 _lowerBound (unsafeFromKey $ toKey key) open
55+ Fn.runFn2 _lowerBound (extractForeign $ toKey key) open
56+
63
57
64-- | Returns a new IDBKeyRange with no lower bound and ending at key.
58-- | Returns a new IDBKeyRange with no lower bound and ending at key.
65-- | If `Open` is `true`, key is not included in the range.
59-- | If `Open` is `true`, key is not included in the range.
66upperBound
60upperBound
67− :: forall a
61+ :: forall a. (IDBKey a)
68− . (IDBKey a)
69− => a
62+ => a
70− -> Open
63+ -> Open
71− -> KeyRange
64+ -> KeyRange
72upperBound key open =
65upperBound key open =
73− Fn.runFn2 _upperBound (unsafeFromKey $ toKey key) open
66+ Fn.runFn2 _upperBound (extractForeign $ toKey key) open
67+
74
68
75-- | Returns a new IDBKeyRange spanning from `lower` to `upper`.
69-- | Returns a new IDBKeyRange spanning from `lower` to `upper`.
76-- | If `lowerOpen` is `true`, `lower` is not included in the range.
70-- | If `lowerOpen` is `true`, `lower` is not included in the range.
@@ -78,93 +72,97 @@ upperBound key open =
78-- |
72-- |
79-- | It throws a `DataError` if the bound is invalid.
73-- | It throws a `DataError` if the bound is invalid.
80bound
74bound
81− :: forall key
75+ :: forall a. (IDBKey a)
82− . (IDBKey key)
83− => { lower :: key, upper :: key, lowerOpen :: Boolean, upperOpen :: Boolean }
76+ => { lower :: a, upper :: a, lowerOpen :: Boolean, upperOpen :: Boolean }
84− -> Maybe KeyRange
77+ -> Maybe KeyRange
85bound { lower: key1, upper: key2, lowerOpen: open1, upperOpen: open2 } =
78bound { lower: key1, upper: key2, lowerOpen: open1, upperOpen: open2 } =
86 toMaybe
79 toMaybe
87− $ Fn.runFn4 _bound (unsafeFromKey $ toKey key1) (unsafeFromKey $ toKey key2) open1 open2
80+ $ Fn.runFn4 _bound (extractForeign $ toKey key1) (extractForeign $ toKey key2) open1 open2
88
81
89−--------------------
90−-- INTERFACE
91−--
92−
93−-- | Returns true if key is included in the range, and false otherwise.
94−includes
95− :: forall key range
96− . (IDBKey key)
97− => (IDBKeyRange range)
98− => range
99− -> key
100− -> Boolean
101−includes range =
102− toKey >>> unsafeFromKey >>> Fn.runFn2 _includes range
103
82
104--------------------
83--------------------
105-- ATTRIBUTES
84-- ATTRIBUTES
106--
85--
107-- | Returns lower bound if any.
86-- | Returns lower bound if any.
108lower
87lower
109− :: KeyRange
88+ :: KeyRange
110− -> Maybe Key
89+ -> Maybe Key
111lower =
90lower =
112− _lower >>> toMaybe >>> map toKey
91+ _lower >>> toMaybe >>> map Key
92+
113
93
114-- | Returns upper bound if any.
94-- | Returns upper bound if any.
115upper
95upper
116− :: KeyRange
96+ :: KeyRange
117− -> Maybe Key
97+ -> Maybe Key
118upper =
98upper =
119− _upper >>> toMaybe >>> map toKey
99+ _upper >>> toMaybe >>> map Key
100+
120
101
121-- | Returns true if the lower open flag is set, false otherwise.
102-- | Returns true if the lower open flag is set, false otherwise.
122lowerOpen
103lowerOpen
123− :: KeyRange
104+ :: KeyRange
124− -> Boolean
105+ -> Boolean
125lowerOpen =
106lowerOpen =
126 _lowerOpen
107 _lowerOpen
127
108
109+
128-- | Returns true if the upper open flag is set, false otherwise.
110-- | Returns true if the upper open flag is set, false otherwise.
129upperOpen
111upperOpen
130− :: KeyRange
112+ :: KeyRange
131− -> Boolean
113+ -> Boolean
132upperOpen =
114upperOpen =
133 _upperOpen
115 _upperOpen
134
116
117+
135--------------------
118--------------------
136−-- FFI
119+-- INSTANCES
137--
120--
121+instance idbKeyRangeKeyRange :: IDBKeyRange KeyRange where
122+ includes range =
123+ toKey >>> extractForeign >>> Fn.runFn2 _includes range
138
124
139−foreign import _only
140− :: Foreign
141− -> KeyRange
142−
143−foreign import _lowerBound
144− :: Fn2 Foreign Boolean KeyRange
145−
146−foreign import _upperBound
147− :: Fn2 Foreign Boolean KeyRange
148
125
126+--------------------
127+-- FFI
128+--
149foreign import _bound
129foreign import _bound
150 :: Fn4 Foreign Foreign Boolean Boolean (Nullable KeyRange)
130 :: Fn4 Foreign Foreign Boolean Boolean (Nullable KeyRange)
151
131
132+
152foreign import _includes
133foreign import _includes
153 :: forall range
134 :: forall range
154− . Fn2 range Foreign Boolean
135+ . Fn2 range Foreign Boolean
136+
155
137
156foreign import _lower
138foreign import _lower
157 :: KeyRange
139 :: KeyRange
158 -> Nullable Foreign
140 -> Nullable Foreign
159
141
142+
160−foreign import _upper
143+foreign import _lowerBound
161− :: KeyRange
144+ :: Fn2 Foreign Boolean KeyRange
162− -> Nullable Foreign
145+
163
146
164foreign import _lowerOpen
147foreign import _lowerOpen
165 :: KeyRange
148 :: KeyRange
166 -> Boolean
149 -> Boolean
167
150
151+
152+foreign import _only
153+ :: Foreign
154+ -> KeyRange
155+
156+
157+foreign import _upper
158+ :: KeyRange
159+ -> Nullable Foreign
160+
161+
162+foreign import _upperBound
163+ :: Fn2 Foreign Boolean KeyRange
164+
165+
168foreign import _upperOpen
166foreign import _upperOpen
169 :: KeyRange
167 :: KeyRange
170 -> Boolean
168 -> Boolean
src/Database/IndexedDB/IDBObjectStore.js+28−55
@@ -1,6 +1,6 @@
1const errorHandler = function errorHandler(cb) {
1const errorHandler = function errorHandler(cb) {
2 return function _handler(e) {
2 return function _handler(e) {
3− cb(e.target.error);
3+ cb(new Error(e.target.error.name));
4 };
4 };
5};
5};
6
6
@@ -15,44 +15,36 @@ const toArray = function toArray(xs) {
15};
15};
16
16
17
17
18−export function _add(store, value, key) {
18+exports._add = function _add(store, value, key) {
19− return function aff(error, success) {
19+ return function aff(success, error) {
20 try {
20 try {
21 const request = store.add(value, key || undefined);
21 const request = store.add(value, key || undefined);
22 request.onsuccess = successHandler(success);
22 request.onsuccess = successHandler(success);
23 request.onerror = errorHandler(error);
23 request.onerror = errorHandler(error);
24 } catch (e) {
24 } catch (e) {
25− error(e);
25+ error(new Error(e.name));
26 }
26 }
27−
28− return function canceler(_, cancelerError) {
29− cancelerError(new Error("Can't cancel IDB Effects"));
30− };
31 };
27 };
32};
28};
33
29
34−export function _autoIncrement(store) {
30+exports._autoIncrement = function _autoIncrement(store) {
35 return store.autoIncrement;
31 return store.autoIncrement;
36};
32};
37
33
38−export function _clear(store) {
34+exports._clear = function _clear(store) {
39− return function aff(error, success) {
35+ return function aff(success, error) {
40 try {
36 try {
41 const request = store.clear();
37 const request = store.clear();
42 request.onsuccess = successHandler(success);
38 request.onsuccess = successHandler(success);
43 request.onerror = errorHandler(error);
39 request.onerror = errorHandler(error);
44 } catch (e) {
40 } catch (e) {
45− error(e);
41+ error(new Error(e.name));
46 }
42 }
47−
48− return function canceler(_, cancelerError) {
49− cancelerError(new Error("Can't cancel IDB Effects"));
50− };
51 };
43 };
52};
44};
53
45
54−export function _createIndex(store, name, path, params) {
46+exports._createIndex = function _createIndex(store, name, path, params) {
55− return function aff(error, success) {
47+ return function aff(success, error) {
56 var keyPath;
48 var keyPath;
57
49
58 try {
50 try {
@@ -72,66 +64,50 @@ export function _createIndex(store, name, path, params) {
72 const index = store.createIndex(name, keyPath, params);
64 const index = store.createIndex(name, keyPath, params);
73 success(index);
65 success(index);
74 } catch (e) {
66 } catch (e) {
75− error(e);
67+ error(new Error(e.name));
76 }
68 }
77−
78− return function canceler(_, cancelerError) {
79− cancelerError(new Error("Can't cancel IDB Effects"));
80− };
81 };
69 };
82};
70};
83
71
84−export function _deleteIndex(store, name) {
72+exports._deleteIndex = function _deleteIndex(store, name) {
85− return function aff(error, success) {
73+ return function aff(success, error) {
86 try {
74 try {
87 store.deleteIndex(name);
75 store.deleteIndex(name);
88 success();
76 success();
89 } catch (e) {
77 } catch (e) {
90− error(e);
78+ error(new Error(e.name));
91 }
79 }
92−
93− return function canceler(_, cancelerError) {
94− cancelerError(new Error("Can't cancel IDB Effects"));
95− };
96 };
80 };
97};
81};
98
82
99−export function _delete(store, query) {
83+exports._delete = function _delete(store, query) {
100− return function aff(error, success) {
84+ return function aff(success, error) {
101 try {
85 try {
102 const request = store.delete(query);
86 const request = store.delete(query);
103 request.onsuccess = successHandler(success);
87 request.onsuccess = successHandler(success);
104 request.onerror = errorHandler(error);
88 request.onerror = errorHandler(error);
105 } catch (e) {
89 } catch (e) {
106− error(e);
90+ error(new Error(e.name));
107 }
91 }
108−
109− return function canceler(_, cancelerError) {
110− cancelerError(new Error("Can't cancel IDB Effects"));
111− };
112 };
92 };
113};
93};
114
94
115−export function _index(store, name) {
95+exports._index = function _index(store, name) {
116− return function aff(error, success) {
96+ return function aff(success, error) {
117 try {
97 try {
118 const index = store.index(name);
98 const index = store.index(name);
119 success(index);
99 success(index);
120 } catch (e) {
100 } catch (e) {
121− error(e);
101+ error(new Error(e.name));
122 }
102 }
123−
124− return function canceler(_, cancelerError) {
125− cancelerError(new Error("Can't cancel IDB Effects"));
126− };
127 };
103 };
128};
104};
129
105
130−export function _indexNames(store) {
106+exports._indexNames = function _indexNames(store) {
131 return toArray(store.indexNames);
107 return toArray(store.indexNames);
132};
108};
133
109
134−export function _keyPath(store) {
110+exports._keyPath = function _keyPath(store) {
135 const path = store.keyPath;
111 const path = store.keyPath;
136
112
137 if (Array.isArray(path)) {
113 if (Array.isArray(path)) {
@@ -145,26 +121,23 @@ export function _keyPath(store) {
145 return [];
121 return [];
146};
122};
147
123
148−export function _name(store) {
124+exports._name = function _name(store) {
149 return store.name;
125 return store.name;
150};
126};
151
127
152−export function _put(store, value, key) {
128+exports._put = function _put(store, value, key) {
153− return function aff(error, success) {
129+ return function aff(success, error) {
154 try {
130 try {
155 const request = store.put(value, key || undefined);
131 const request = store.put(value, key || undefined);
156 request.onsuccess = successHandler(success);
132 request.onsuccess = successHandler(success);
157 request.onerror = errorHandler(error);
133 request.onerror = errorHandler(error);
158 } catch (e) {
134 } catch (e) {
159− error(e);
135+ error(new Error(e.name));
160 }
136 }
161−
162− return function canceler(_, cancelerError) {
163− cancelerError(new Error("Can't cancel IDB Effects"));
164− };
165 };
137 };
166};
138};
167
139
168−export function _transaction(store) {
140+exports._transaction = function _transaction(store) {
169 return store.transaction;
141 return store.transaction;
170};
142};
143+
src/Database/IndexedDB/IDBObjectStore.purs+156−160
@@ -1,170 +1,124 @@
1-- | An object store is the primary storage mechanism for storing data in a database.
1-- | An object store is the primary storage mechanism for storing data in a database.
2module Database.IndexedDB.IDBObjectStore
2module Database.IndexedDB.IDBObjectStore
3− -- * Types
3+ ( class IDBObjectStore, add, clear, createIndex, delete, deleteIndex, index, put
4− ( IndexName
4+ , module Database.IndexedDB.IDBIndex.Internal
5− , IndexParameters
5+ , IDBObjectStoreParameters
6− , defaultParameters
6+ , IndexName
7−
8− -- * Interface
9− , add
10− , clear
11− , createIndex
12− , delete
13− , deleteIndex
14− , index
15− , put
16−
17− -- * Attributes
18 , autoIncrement
7 , autoIncrement
19 , indexNames
8 , indexNames
20 , keyPath
9 , keyPath
21 , name
10 , name
22 , transaction
11 , transaction
23−
12+ , defaultParameters
24− -- * Re-Exports
25− , module Database.IndexedDB.IDBIndex
26 ) where
13 ) where
27
14
15+import Prelude (Unit, ($), (<$>), (>>>))
16+
17+import Control.Monad.Aff (Aff)
18+import Data.Foreign (Foreign)
19+import Data.Function.Uncurried as Fn
20+import Data.Function.Uncurried (Fn2, Fn3, Fn4)
21+import Data.Maybe (Maybe)
22+import Data.Nullable (Nullable, toNullable)
23+
28−import Database.IndexedDB.Core
24+import Database.IndexedDB.Core (IDB, Index, KeyRange, KeyPath, ObjectStore, Transaction)
25+import Database.IndexedDB.IDBIndex.Internal (class IDBIndex, IDBIndexParameters, count, get, getAllKeys, getKey, openCursor, openKeyCursor)
26+import Database.IndexedDB.IDBKey.Internal (class IDBKey, Key(Key), extractForeign, toKey)
29
27
30−import Data.Function.Uncurried (Fn2, Fn3, Fn4)
31−import Data.Function.Uncurried as Fn
32−import Data.Maybe (Maybe)
33−import Data.Nullable (Nullable, toNullable)
34−import Database.IndexedDB.IDBIndex (count, get, getAllKeys, getKey, openCursor, openKeyCursor)
35−import Database.IndexedDB.IDBKey.Internal (class IDBKey, Key, unsafeFromKey, toKey)
36−import Effect.Aff (Aff)
37−import Effect.Aff.Compat (EffectFnAff, fromEffectFnAff)
38−import Foreign (Foreign)
39−import Prelude (Unit, map, ($), (<$>), (>>>), (<<<))
40
28
41--------------------
29--------------------
42−-- TYPES
30+-- INTERFACES
43--
31--
32+-- | The IDBObjectStore interface represents an object store handle.
33+class IDBObjectStore store where
34+ -- | Adds or updates a record in store with the given value and key.
35+ -- |
36+ -- | If the store uses in-line keys and key is specified a "DataError" DOMException
37+ -- | will be thrown.
38+ -- |
39+ -- | If add() is used, and if a record with the key already exists the request will fail,
40+ -- | with a "ConstraintError" DOMException.
41+ add
42+ :: forall v k e. (IDBKey k)
43+ => store
44+ -> v
45+ -> Maybe k
46+ -> Aff (idb :: IDB | e) Key
47+
48+ -- | Deletes all records in store.
49+ clear
50+ :: forall e
51+ . store
52+ -> Aff (idb :: IDB | e) Unit
53+
54+ -- | Creates a new index in store with the given name, keyPath and options and
55+ -- | returns a new IDBIndex. If the keyPath and options define constraints that
56+ -- | cannot be satisfied with the data already in store the upgrade transaction
57+ -- | will abort with a "ConstraintError" DOMException.
58+ -- |
59+ -- | Throws an "InvalidStateError" DOMException if not called within an upgrade transaction.
60+ createIndex
61+ :: forall e
62+ . store
63+ -> IndexName
64+ -> KeyPath
65+ -> IDBIndexParameters
66+ -> Aff (idb :: IDB | e) Index
67+
68+ -- | Deletes records in store with the given key or in the given key range in query.
69+ delete
70+ :: forall e
71+ . store
72+ -> KeyRange
73+ -> Aff (idb :: IDB | e) Unit
74+
75+ -- | Deletes the index in store with the given name.
76+ -- |
77+ -- | Throws an "InvalidStateError" DOMException if not called within an upgrade transaction.
78+ deleteIndex
79+ :: forall e
80+ . store
81+ -> IndexName
82+ -> Aff (idb :: IDB | e) Unit
83+
84+ -- | Returns an IDBIndex for the index named name in store.
85+ index
86+ :: forall e
87+ . store
88+ -> IndexName
89+ -> Aff (idb :: IDB | e) Index
90+
91+ -- | Adds or updates a record in store with the given value and key.
92+ -- |
93+ -- | If the store uses in-line keys and key is specified a "DataError" DOMException
94+ -- | will be thrown.
95+ -- |
96+ -- | If put() is used, any existing record with the key will be replaced.
97+ put
98+ :: forall v k e. (IDBKey k)
99+ => store
100+ -> v
101+ -> Maybe k
102+ -> Aff (idb :: IDB | e) Key
103+
44
104
45-- | Type alias for IndexName
105-- | Type alias for IndexName
46type IndexName = String
106type IndexName = String
47
107
48−-- | Flags to set on the index.
108+
49−-- |
109+-- | Options provided when creating an object store.
50−-- | An index has a `unique` flag. When this flag is set, the index enforces that no
110+type IDBObjectStoreParameters =
51−-- | two records in the index has the same key. If a record in the index’s referenced
111+ { keyPath :: KeyPath
52−-- | object store is attempted to be inserted or modified such that evaluating the index’s
112+ , autoIncrement :: Boolean
53−-- | key path on the records new value yields a result which already exists in the index,
54−-- | then the attempted modification to the object store fails.
55−-- |
56−-- | An index has a `multiEntry` flag. This flag affects how the index behaves when the
57−-- | result of evaluating the index’s key path yields an array key. If the `multiEntry` flag
58−-- | is unset, then a single record whose key is an array key is added to the index.
59−-- | If the `multiEntry` flag is true, then the one record is added to the index for each
60−-- | of the subkeys.
61−type IndexParameters =
62− { unique :: Boolean
63− , multiEntry :: Boolean
64 }
113 }
65
114
115+
66−defaultParameters :: IndexParameters
116+defaultParameters :: IDBObjectStoreParameters
67defaultParameters =
117defaultParameters =
68− { unique: false
118+ { keyPath : []
69− , multiEntry: false
119+ , autoIncrement : false
70 }
120 }
71
121
72−--------------------
73−-- INTERFACES
74−--
75−
76−-- | Adds or updates a record in store with the given value and key.
77−-- |
78−-- | If the store uses in-line keys and key is specified a "DataError" DOMException
79−-- | will be thrown.
80−-- |
81−-- | If add() is used, and if a record with the key already exists the request will fail,
82−-- | with a "ConstraintError" DOMException.
83−add
84− :: forall key val store
85− . (IDBKey key)
86− => (IDBObjectStore store)
87− => store
88− -> val
89− -> Maybe key
90− -> Aff Key
91−add store value key =
92− map toKey $ fromEffectFnAff $ Fn.runFn3 _add store value (toNullable $ (toKey >>> unsafeFromKey) <$> key)
93−
94−-- | Deletes all records in store.
95−clear
96− :: forall store
97− . (IDBObjectStore store)
98− => store
99− -> Aff Unit
100−clear =
101− fromEffectFnAff <<< _clear
102−
103−-- | Creates a new index in store with the given name, keyPath and options and
104−-- | returns a new IDBIndex. If the keyPath and options define constraints that
105−-- | cannot be satisfied with the data already in store the upgrade transaction
106−-- | will abort with a "ConstraintError" DOMException.
107−-- |
108−-- | Throws an "InvalidStateError" DOMException if not called within an upgrade transaction.
109−createIndex
110− :: forall store
111− . (IDBObjectStore store)
112− => store
113− -> IndexName
114− -> KeyPath
115− -> IndexParameters
116− -> Aff Index
117−createIndex store name' path params =
118− fromEffectFnAff $ Fn.runFn4 _createIndex store name' path params
119−
120−-- | Deletes records in store with the given key or in the given key range in query.
121−delete
122− :: forall store
123− . (IDBObjectStore store)
124− => store
125− -> KeyRange
126− -> Aff Unit
127−delete store range =
128− fromEffectFnAff $ Fn.runFn2 _delete store range
129−
130−-- | Deletes the index in store with the given name.
131−-- |
132−-- | Throws an "InvalidStateError" DOMException if not called within an upgrade transaction.
133−deleteIndex
134− :: forall store
135− . (IDBObjectStore store)
136− => store
137− -> IndexName
138− -> Aff Unit
139−deleteIndex store name' =
140− fromEffectFnAff $ Fn.runFn2 _deleteIndex store name'
141−
142−-- | Returns an IDBIndex for the index named name in store.
143−index
144− :: forall store
145− . (IDBObjectStore store)
146− => store
147− -> IndexName
148− -> Aff Index
149−index store name' =
150− fromEffectFnAff $ Fn.runFn2 _index store name'
151−
152−-- | Adds or updates a record in store with the given value and key.
153−-- |
154−-- | If the store uses in-line keys and key is specified a "DataError" DOMException
155−-- | will be thrown.
156−-- |
157−-- | If put() is used, any existing record with the key will be replaced.
158−put
159− :: forall val key store
160− . (IDBKey key)
161− => (IDBObjectStore store)
162− => store
163− -> val
164− -> Maybe key
165− -> Aff Key
166−put store value key =
167− map toKey $ fromEffectFnAff $ Fn.runFn3 _put store value (toNullable $ (toKey >>> unsafeFromKey) <$> key)
168
122
169--------------------
123--------------------
170-- ATTRIBUTES
124-- ATTRIBUTES
@@ -176,6 +130,7 @@ autoIncrement
176autoIncrement =
130autoIncrement =
177 _autoIncrement
131 _autoIncrement
178
132
133+
179--| Returns a list of the names of indexes in the store.
134--| Returns a list of the names of indexes in the store.
180indexNames
135indexNames
181 :: ObjectStore
136 :: ObjectStore
@@ -183,6 +138,7 @@ indexNames
183indexNames =
138indexNames =
184 _indexNames
139 _indexNames
185
140
141+
186-- | Returns the key path of the store, or empty array if none
142-- | Returns the key path of the store, or empty array if none
187keyPath
143keyPath
188 :: ObjectStore
144 :: ObjectStore
@@ -190,6 +146,7 @@ keyPath
190keyPath =
146keyPath =
191 _keyPath
147 _keyPath
192
148
149+
193-- | Returns the name of the store.
150-- | Returns the name of the store.
194name
151name
195 :: ObjectStore
152 :: ObjectStore
@@ -197,6 +154,7 @@ name
197name =
154name =
198 _name
155 _name
199
156
157+
200-- | Returns the associated transaction.
158-- | Returns the associated transaction.
201transaction
159transaction
202 :: ObjectStore
160 :: ObjectStore
@@ -204,53 +162,91 @@ transaction
204transaction =
162transaction =
205 _transaction
163 _transaction
206
164
165+
166+--------------------
167+-- INSTANCES
168+--
169+instance idbObjectStoreObjectStore :: IDBObjectStore ObjectStore where
170+ add store value key =
171+ Key <$> Fn.runFn3 _add store value (toNullable $ (toKey >>> extractForeign) <$> key)
172+
173+ clear =
174+ _clear
175+
176+ createIndex store name' path params =
177+ Fn.runFn4 _createIndex store name' path params
178+
179+ delete store range =
180+ Fn.runFn2 _delete store range
181+
182+ deleteIndex store name' =
183+ Fn.runFn2 _deleteIndex store name'
184+
185+ index store name' =
186+ Fn.runFn2 _index store name'
187+
188+ put store value key =
189+ Key <$> Fn.runFn3 _put store value (toNullable $ (toKey >>> extractForeign) <$> key)
190+
191+
207--------------------
192--------------------
208-- FFI
193-- FFI
209--
194--
210foreign import _add
195foreign import _add
211− :: forall val store
196+ :: forall value e
212− . Fn3 store val (Nullable Foreign) (EffectFnAff Foreign)
197+ . Fn3 ObjectStore value (Nullable Foreign) (Aff (idb :: IDB | e) Foreign)
198+
213
199
214foreign import _autoIncrement
200foreign import _autoIncrement
215 :: ObjectStore
201 :: ObjectStore
216 -> Boolean
202 -> Boolean
217
203
204+
218foreign import _clear
205foreign import _clear
219− :: forall store
206+ :: forall e
220− . store
207+ . ObjectStore
221− -> EffectFnAff Unit
208+ -> Aff (idb :: IDB | e) Unit
209+
222
210
223foreign import _createIndex
211foreign import _createIndex
224− :: forall store
212+ :: forall e
225− . Fn4 store String (Array String) { unique :: Boolean, multiEntry :: Boolean } (EffectFnAff Index)
213+ . Fn4 ObjectStore String (Array String) { unique :: Boolean, multiEntry :: Boolean } (Aff (idb :: IDB | e) Index)
214+
226
215
227foreign import _delete
216foreign import _delete
228− :: forall store
217+ :: forall e
229− . Fn2 store KeyRange (EffectFnAff Unit)
218+ . Fn2 ObjectStore KeyRange (Aff (idb :: IDB | e) Unit)
219+
230
220
231foreign import _deleteIndex
221foreign import _deleteIndex
232− :: forall store
222+ :: forall e
233− . Fn2 store String (EffectFnAff Unit)
223+ . Fn2 ObjectStore String (Aff (idb :: IDB | e) Unit)
224+
234
225
235foreign import _index
226foreign import _index
236− :: forall store
227+ :: forall e
237− . Fn2 store String (EffectFnAff Index)
228+ . Fn2 ObjectStore String (Aff (idb :: IDB | e) Index)
229+
238
230
239foreign import _indexNames
231foreign import _indexNames
240 :: ObjectStore
232 :: ObjectStore
241 -> Array String
233 -> Array String
242
234
235+
243foreign import _keyPath
236foreign import _keyPath
244 :: ObjectStore
237 :: ObjectStore
245 -> Array String
238 -> Array String
246
239
240+
247foreign import _name
241foreign import _name
248 :: ObjectStore
242 :: ObjectStore
249 -> String
243 -> String
250
244
245+
251foreign import _put
246foreign import _put
252− :: forall val store
247+ :: forall value e
253− . Fn3 store val (Nullable Foreign) (EffectFnAff Foreign)
248+ . Fn3 ObjectStore value (Nullable Foreign) (Aff (idb :: IDB | e) Foreign)
249+
254
250
255foreign import _transaction
251foreign import _transaction
256 :: ObjectStore
252 :: ObjectStore
src/Database/IndexedDB/IDBTransaction.js+18−38
@@ -1,29 +1,25 @@
1−export function _abort(tx) {
1+exports._abort = function _abort(tx) {
2− return function aff(error, success) {
2+ return function aff(success, error) {
3 try {
3 try {
4 tx.abort();
4 tx.abort();
5 success();
5 success();
6 } catch (e) {
6 } catch (e) {
7− error(e);
7+ error(new Error(e.name));
8 }
8 }
9−
10− return function canceler(_, cancelerError) {
11− cancelerError(new Error("Can't cancel IDB Effects"));
12− };
13 };
9 };
14};
10};
15
11
16−export function _db(tx) {
12+exports._db = function _db(tx) {
17 return tx.db;
13 return tx.db;
18};
14};
19
15
20−export function _error(tx) {
16+exports._error = function _error(tx) {
21 return tx.error == null
17 return tx.error == null
22 ? null
18 ? null
23− : tx.error;
19+ : new Error(tx.error.name);
24};
20};
25
21
26−export function _mode(ReadOnly, ReadWrite, VersionChange, tx) {
22+exports._mode = function _mode(ReadOnly, ReadWrite, VersionChange, tx) {
27 if (tx.mode === 'readwrite') {
23 if (tx.mode === 'readwrite') {
28 return ReadWrite;
24 return ReadWrite;
29 } else if (tx.mode === 'versionchange') {
25 } else if (tx.mode === 'versionchange') {
@@ -33,60 +29,44 @@ export function _mode(ReadOnly, ReadWrite, VersionChange, tx) {
33 return ReadOnly;
29 return ReadOnly;
34};
30};
35
31
36−export function _objectStore(tx, name) {
32+exports._objectStore = function _objectStore(tx, name) {
37− return function aff(error, success) {
33+ return function aff(success, error) {
38 try {
34 try {
39 const store = tx.objectStore(name);
35 const store = tx.objectStore(name);
40 success(store);
36 success(store);
41 } catch (e) {
37 } catch (e) {
42− error(e);
38+ error(new Error(e.name));
43 }
39 }
44−
45− return function canceler(_, cancelerError) {
46− cancelerError(new Error("Can't cancel IDB Effects"));
47− };
48 };
40 };
49};
41};
50
42
51−export function _objectStoreNames(tx) {
43+exports._objectStoreNames = function _objectStoreNames(tx) {
52 return tx.objectStoreNames;
44 return tx.objectStoreNames;
53};
45};
54
46
55−export function _onAbort(tx, f) {
47+exports._onAbort = function _onAbort(tx, f) {
56− return function aff(error, success) {
48+ return function aff(success) {
57 tx.onabort = function onabort() {
49 tx.onabort = function onabort() {
58 f();
50 f();
59 };
51 };
60 success();
52 success();
61−
62− return function canceler(_, cancelerError) {
63− cancelerError(new Error("Can't cancel IDB Effects"));
64− };
65 };
53 };
66};
54};
67
55
68−export function _onComplete(tx, f) {
56+exports._onComplete = function _onComplete(tx, f) {
69− return function aff(error, success) {
57+ return function aff(success) {
70 tx.oncomplete = function oncomplete() {
58 tx.oncomplete = function oncomplete() {
71 f();
59 f();
72 };
60 };
73 success();
61 success();
74−
75− return function canceler(_, cancelerError) {
76− cancelerError(new Error("Can't cancel IDB Effects"));
77− };
78 };
62 };
79};
63};
80
64
81−export function _onError(tx, f) {
65+exports._onError = function _onError(tx, f) {
82− return function aff(error, success) {
66+ return function aff(success) {
83 tx.onerror = function onerror(e) {
67 tx.onerror = function onerror(e) {
84− f(e.target.error)();
68+ f(new Error(e.target.error.name))();
85 };
69 };
86 success();
70 success();
87−
88− return function canceler(_, cancelerError) {
89− cancelerError(new Error("Can't cancel IDB Effects"));
90− };
91 };
71 };
92};
72};
src/Database/IndexedDB/IDBTransaction.purs+83−66
@@ -1,66 +1,58 @@
1−-- | An object store is the primary storage mechanism for storing data in a database.
1+-- | A Transaction is used to interact with the data in a database.
2+-- | Whenever data is read or written to the database it is done by using a transaction.
2module Database.IndexedDB.IDBTransaction
3module Database.IndexedDB.IDBTransaction
3− -- * Interface
4− ( abort
5− , objectStore
4+ (class IDBTransaction, abort, objectStore
6−
7− -- * Attributes
8 , error
5 , error
9 , mode
6 , mode
10−
11− -- * Event Handlers
12 , onAbort
7 , onAbort
13 , onComplete
8 , onComplete
14 , onError
9 , onError
15 ) where
10 ) where
16
11
12+import Prelude (Unit, (>>>))
13+
14+import Control.Monad.Aff (Aff)
15+import Control.Monad.Eff (Eff)
16+import Control.Monad.Eff.Exception (Error)
17+import Data.Function.Uncurried as Fn
18+import Data.Function.Uncurried (Fn2, Fn4)
19+import Data.Maybe (Maybe)
20+import Data.Nullable (Nullable, toMaybe)
21+
17−import Database.IndexedDB.Core
22+import Database.IndexedDB.Core (IDB, Database, ObjectStore, Transaction, TransactionMode(..))
18
23
19−import Data.Function.Uncurried (Fn2, Fn4)
20−import Data.Function.Uncurried as Fn
21−import Data.Maybe (Maybe)
22−import Data.Nullable (Nullable, toMaybe)
23−import Effect (Effect)
24−import Effect.Aff (Aff)
25−import Effect.Aff.Compat (EffectFnAff, fromEffectFnAff)
26−import Effect.Exception (Error)
27−import Prelude (Unit, ($), (<<<), (>>>))
28
24
29--------------------
25--------------------
30-- INTERFACES
26-- INTERFACES
31--
27--
28+-- | The IDBtransaction interface.
29+class IDBTransaction tx where
30+ -- | Aborts the transaction. All pending requests will fail with a "AbortError"
31+ -- | DOMException and all changes made to the database will be reverted.
32+ abort
33+ :: forall e
34+ . tx
35+ -> Aff (idb :: IDB | e) Unit
36+
37+ -- | Returns an IDBObjectStore in the transaction's scope.
38+ objectStore
39+ :: forall e
40+ . tx
41+ -> String
42+ -> Aff (idb :: IDB | e) ObjectStore
32
43
33−-- | Aborts the transaction. All pending requests will fail with a "AbortError"
34−-- | DOMException and all changes made to the database will be reverted.
35−abort
36− :: forall tx
37− . (IDBTransaction tx)
38− => tx
39− -> Aff Unit
40−abort =
41− fromEffectFnAff <<< _abort
42−
43−-- | Returns an IDBObjectStore in the transaction's scope.
44−objectStore
45− :: forall tx
46− . (IDBTransaction tx)
47− => tx
48− -> String
49− -> Aff ObjectStore
50−objectStore tx name =
51− fromEffectFnAff $ Fn.runFn2 _objectStore tx name
52
44
53--------------------
45--------------------
54-- ATTRIBUTES
46-- ATTRIBUTES
55--
47--
56−
57−--- | Returns the transaction’s connection.
48+-- | Returns the transaction’s connection.
58db
49db
59 :: Transaction
50 :: Transaction
60 -> Database
51 -> Database
61db =
52db =
62 _db
53 _db
63
54
55+
64-- | If the transaction was aborted, returns the error (a DOMException) providing the reason.
56-- | If the transaction was aborted, returns the error (a DOMException) providing the reason.
65error
57error
66 :: Transaction
58 :: Transaction
@@ -76,6 +68,7 @@ mode
76mode =
68mode =
77 Fn.runFn4 _mode ReadOnly ReadWrite VersionChange
69 Fn.runFn4 _mode ReadOnly ReadWrite VersionChange
78
70
71+
79-- | Returns a list of the names of object stores in the transaction’s scope.
72-- | Returns a list of the names of object stores in the transaction’s scope.
80-- | For an upgrade transaction this is all object stores in the database.
73-- | For an upgrade transaction this is all object stores in the database.
81objectStoreNames
74objectStoreNames
@@ -87,67 +80,91 @@ objectStoreNames =
87--------------------
80--------------------
88-- EVENT HANDLERS
81-- EVENT HANDLERS
89--
82--
90−
91-- | Event handler for the `abort` event.
83-- | Event handler for the `abort` event.
92onAbort
84onAbort
85+ :: forall e e'
93− :: Transaction
86+ . Transaction
94− -> Effect Unit
87+ -> Eff ( | e') Unit
95− -> Aff Unit
88+ -> Aff (idb :: IDB | e) Unit
96−onAbort db' f =
89+onAbort db f =
97− fromEffectFnAff $ Fn.runFn2 _onAbort db' f
90+ Fn.runFn2 _onAbort db f
91+
98
92
99-- | Event handler for the `complete` event.
93-- | Event handler for the `complete` event.
100onComplete
94onComplete
95+ :: forall e e'
101− :: Transaction
96+ . Transaction
102− -> Effect Unit
97+ -> Eff ( | e') Unit
103− -> Aff Unit
98+ -> Aff (idb :: IDB | e) Unit
104−onComplete db' f =
99+onComplete db f =
105− fromEffectFnAff $ Fn.runFn2 _onComplete db' f
100+ Fn.runFn2 _onComplete db f
101+
106
102
107-- | Event handler for the `error` event.
103-- | Event handler for the `error` event.
108onError
104onError
105+ :: forall e e'
109− :: Transaction
106+ . Transaction
110− -> (Error -> Effect Unit)
107+ -> (Error -> Eff ( | e') Unit)
111− -> Aff Unit
108+ -> Aff (idb :: IDB | e) Unit
112onError db' f =
109onError db' f =
113− fromEffectFnAff $ Fn.runFn2 _onError db' f
110+ Fn.runFn2 _onError db' f
111+
114
112
115--------------------
113--------------------
116−-- FFI
114+-- INSTANCES
117--
115--
116+instance idbTransactionTransaction :: IDBTransaction Transaction where
117+ objectStore tx name =
118+ Fn.runFn2 _objectStore tx name
118
119
120+ abort =
121+ _abort
122+
123+
124+--------------------
125+-- FFI
126+--
119foreign import _abort
127foreign import _abort
120− :: forall tx
128+ :: forall tx e
121− . tx
129+ . tx
122− -> EffectFnAff Unit
130+ -> Aff (idb :: IDB | e) Unit
131+
123
132
124foreign import _db
133foreign import _db
125 :: Transaction
134 :: Transaction
126 -> Database
135 -> Database
127
136
137+
128foreign import _error
138foreign import _error
129 :: Transaction
139 :: Transaction
130 -> (Nullable Error)
140 -> (Nullable Error)
131
141
142+
132foreign import _mode
143foreign import _mode
133 :: Fn4 TransactionMode TransactionMode TransactionMode Transaction TransactionMode
144 :: Fn4 TransactionMode TransactionMode TransactionMode Transaction TransactionMode
134
145
146+
135foreign import _objectStoreNames
147foreign import _objectStoreNames
136 :: Transaction
148 :: Transaction
137 -> Array String
149 -> Array String
138
150
151+
139foreign import _objectStore
152foreign import _objectStore
140− :: forall tx
153+ :: forall tx e
141− . Fn2 tx String (EffectFnAff ObjectStore)
154+ . Fn2 tx String (Aff (idb :: IDB | e) ObjectStore)
155+
142
156
143foreign import _onAbort
157foreign import _onAbort
144− :: forall tx
158+ :: forall tx e e'
145− . Fn2 tx (Effect Unit) (EffectFnAff Unit)
159+ . Fn2 tx (Eff ( | e') Unit) (Aff (idb :: IDB | e) Unit)
160+
146
161
147foreign import _onComplete
162foreign import _onComplete
148− :: forall tx
163+ :: forall tx e e'
149− . Fn2 tx (Effect Unit) (EffectFnAff Unit)
164+ . Fn2 tx (Eff ( | e') Unit) (Aff (idb :: IDB | e) Unit)
165+
150
166
151foreign import _onError
167foreign import _onError
152− :: forall tx
168+ :: forall tx e e'
153− . Fn2 tx (Error -> Effect Unit) (EffectFnAff Unit)
169+ . Fn2 tx (Error -> Eff ( | e') Unit) (Aff (idb :: IDB | e) Unit)
170+
test/Main.purs+904−974
@@ -2,1060 +2,995 @@ module Test.Main where
2
2
3import Prelude
3import Prelude
4
4
5−import Data.Array (head, drop)
5+import Control.Monad.Aff (Aff, launchAff, forkAff, delay, attempt)
6+import Control.Monad.Aff.AVar (AVAR, makeVar, makeVar', modifyVar, peekVar, putVar, takeVar)
7+import Control.Monad.Aff.Console (log)
8+import Control.Monad.Eff (Eff)
9+import Control.Monad.Eff.Class (liftEff)
10+import Control.Monad.Eff.Exception (EXCEPTION, message)
11+import Control.Monad.Eff.Now (NOW, now)
6−import Data.Date as Date
12+import Data.Date as Date
7−import Data.DateTime (DateTime(..), Time(..))
13+import Data.DateTime as DateTime
14+import Data.DateTime (DateTime(..), Time(..))
8−import Data.DateTime.Instant (toDateTime)
15+import Data.DateTime.Instant (toDateTime)
9−import Data.Either (Either(..))
16+import Data.Either (Either(..))
10−import Data.Enum (toEnum)
17+import Data.Enum (toEnum)
11−import Data.Maybe (Maybe(..), isNothing, maybe)
18+import Data.Maybe (Maybe(..), isNothing, maybe)
19+import Data.Array (head, drop)
12−import Data.Time.Duration (Milliseconds(..))
20+import Data.Time.Duration (Milliseconds(..))
13−import Data.Traversable (traverse)
21+import Data.Traversable (traverse)
14−import Data.Tuple (Tuple(..), uncurry)
22+import Data.Tuple (Tuple(..), uncurry)
15−import Database.IndexedDB.Core (CursorDirection(..), Database, Index, ObjectStore, Transaction, TransactionMode(..))
16−import Database.IndexedDB.IDBCursor as IDBCursor
17−import Database.IndexedDB.IDBDatabase as IDBDatabase
18−import Database.IndexedDB.IDBFactory as IDBFactory
19−import Database.IndexedDB.IDBIndex as IDBIndex
20−import Database.IndexedDB.IDBKey (Key, none, toKey)
21−import Database.IndexedDB.IDBKeyRange as IDBKeyRange
22−import Database.IndexedDB.IDBObjectStore as IDBObjectStore
23−import Database.IndexedDB.IDBTransaction as IDBTransaction
24−import Effect (Effect)
25−import Effect.Aff (Aff, attempt, delay, forkAff, launchAff, launchAff_)
26−import Effect.Aff.AVar (AVar)
27−import Effect.Aff.AVar as AVar
28−import Effect.Class (liftEffect)
29−import Effect.Console (log)
30−import Effect.Exception (name)
31−import Effect.Now (now)
32−import Test.Spec (describe, it)
23+import Test.Spec (describe, describeOnly, it)
33−import Test.Spec.Assertions (shouldEqual, fail)
24+import Test.Spec.Assertions (shouldEqual, fail)
34−import Test.Spec.Reporter (consoleReporter)
25+import Test.Spec.Mocha (MOCHA, runMocha)
35−import Test.Spec.Runner (runSpec)
26+
27+import Database.IndexedDB.Core
28+import Database.IndexedDB.IDBKey
29+import Database.IndexedDB.IDBCursor as IDBCursor
30+import Database.IndexedDB.IDBDatabase as IDBDatabase
31+import Database.IndexedDB.IDBFactory as IDBFactory
32+import Database.IndexedDB.IDBIndex as IDBIndex
33+import Database.IndexedDB.IDBKeyRange as IDBKeyRange
34+import Database.IndexedDB.IDBObjectStore as IDBObjectStore
35+import Database.IndexedDB.IDBTransaction as IDBTransaction
36
36
37−infixr 7 Tuple as :+:
38
37
39−launchAff' :: forall a. Aff a -> Effect Unit
38+infixr 7 Tuple as :+:
40−launchAff' =
41− launchAff_ <<< void
42
39
43−modifyAVar :: forall a. (a -> a) -> AVar a -> Aff Unit
40+launchAff' :: forall a e. Aff e a -> Eff (exception :: EXCEPTION | e) Unit
44−modifyAVar fn v = do
41+launchAff' aff =
45− val <- AVar.take v
42+ pure unit <* (launchAff aff)
46− AVar.put (fn val) v
47
43
48−main :: Effect Unit
44+-- main :: forall eff. Eff (now :: NOW, mocha :: MOCHA, idb :: IDB, exception :: EXCEPTION, avar :: AVAR | eff) Unit
49−main = do
45+main = runMocha do
50− launchAff_ $ runSpec [ consoleReporter ] $ do
51− describe "IDBFactory" do
46+ describe "IDBFactory" do
52− let
47+ let
53 tearDown name version db = do
48 tearDown name version db = do
54 IDBDatabase.close db
49 IDBDatabase.close db
55 version' <- IDBFactory.deleteDatabase name
50 version' <- IDBFactory.deleteDatabase name
56− liftEffect $ log $ show version'
57 version' `shouldEqual` version
51 version' `shouldEqual` version
58
52
59− it "open default" do
53+ it "open default" do
60− let
61− name = "db-default"
54+ let name = "db-default"
62 version = 1
55 version = 1
63− db <- IDBFactory.open name Nothing
56+ db <- IDBFactory.open name Nothing
64− { onUpgradeNeeded: Nothing
57+ { onUpgradeNeeded : Nothing
65− , onBlocked: Nothing
58+ , onBlocked : Nothing
66− }
59+ }
67− IDBDatabase.name db `shouldEqual` name
60+ IDBDatabase.name db `shouldEqual` name
68− tearDown name version db
61+ tearDown name version db
69
62
70− it "open specific version" do
71− let
72− name = "db-specific"
73− version = 14
74− db <- IDBFactory.open name (Just version)
75− { onUpgradeNeeded: Nothing
76− , onBlocked: Nothing
77− }
78− IDBDatabase.name db `shouldEqual` name
79− tearDown name version db
80
63
81− it "open specific version -> close -> open latest" do
64+ it "open specific version" do
82− let
83− name = "db-latest"
65+ let name = "db-specific"
84 version = 14
66 version = 14
85− db01 <- IDBFactory.open name (Just version)
67+ db <- IDBFactory.open name (Just version)
86− { onUpgradeNeeded: Nothing
68+ { onUpgradeNeeded : Nothing
87− , onBlocked: Nothing
69+ , onBlocked : Nothing
88− }
70+ }
89− IDBDatabase.name db01 `shouldEqual` name
71+ IDBDatabase.name db `shouldEqual` name
90− IDBDatabase.close db01
91− db02 <- IDBFactory.open name Nothing
92− { onUpgradeNeeded: Nothing
93− , onBlocked: Nothing
94− }
95− tearDown name version db02
72+ tearDown name version db
96
73
74+
75+ it "open specific version -> close -> open latest" do
76+ let name = "db-latest"
77+ version = 14
78+ db <- IDBFactory.open name (Just version)
79+ { onUpgradeNeeded : Nothing
80+ , onBlocked : Nothing
81+ }
82+ IDBDatabase.name db `shouldEqual` name
83+ IDBDatabase.close db
84+ db <- IDBFactory.open name Nothing
85+ { onUpgradeNeeded : Nothing
86+ , onBlocked : Nothing
87+ }
88+ tearDown name version db
89+
90+
97− it "open + onUpgradeNeed" do
91+ it "open + onUpgradeNeed" do
98− let
99− name = "db-upgrade-needed"
92+ let name = "db-upgrade-needed"
100 version = 1
93 version = 1
101− callback (Tuple varName varVersion) db _ { oldVersion } = do
94+ callback var db _ = do
102− _ <- launchAff $ modifyAVar (const $ IDBDatabase.name db) varName
95+ _ <- launchAff $ modifyVar (const $ IDBDatabase.name db) var
103− _ <- launchAff $ modifyAVar (const $ oldVersion) varVersion
104 pure unit
96 pure unit
105− varName <- AVar.new "-"
97+ var <- makeVar' "-"
106− varVersion <- AVar.new (-1)
107− db <- IDBFactory.open name Nothing
98+ db <- IDBFactory.open name Nothing
108− { onUpgradeNeeded: Just (callback (Tuple varName varVersion))
99+ { onUpgradeNeeded : Just (callback var)
109− , onBlocked: Nothing
100+ , onBlocked : Nothing
110− }
101+ }
111− name' <- AVar.read varName
102+ name <- peekVar var
112− version' <- AVar.read varVersion
113− name' `shouldEqual` name
103+ name `shouldEqual` name
114− version' `shouldEqual` 0
115− tearDown name version db
104+ tearDown name version db
116−
105+
106+
117− it "open + onBlocked" do
107+ it "open + onBlocked" do
118− let
119− name = "db-blocked"
108+ let name = "db-blocked"
120 version = 14
109 version = 14
121 callback var = do
110 callback var = do
122− _ <- launchAff $ modifyAVar (const $ "db-blocked") var
111+ _ <- launchAff $ modifyVar (const $ "db-blocked") var
123 pure unit
112 pure unit
124
113
125− var <- AVar.new "-"
114+ var <- makeVar' "-"
126− db01 <- IDBFactory.open name Nothing
115+ db01 <- IDBFactory.open name Nothing
127− { onUpgradeNeeded: Nothing
116+ { onUpgradeNeeded : Nothing
128− , onBlocked: Nothing
117+ , onBlocked : Nothing
129− }
118+ }
130− _ <- forkAff do
119+ _ <- forkAff do
131− delay (Milliseconds 100.0)
120+ delay (Milliseconds 100.0)
132− IDBDatabase.close db01
121+ IDBDatabase.close db01
133
122
134− db02 <- IDBFactory.open name (Just version)
123+ db02 <- IDBFactory.open name (Just version)
135− { onUpgradeNeeded: Nothing
124+ { onUpgradeNeeded : Nothing
136− , onBlocked: Just (callback var)
125+ , onBlocked : Just (callback var)
137− }
126+ }
138− name' <- AVar.read var
127+ name <- peekVar var
139− name' `shouldEqual` name
128+ name `shouldEqual` name
140− tearDown name version db02
129+ tearDown name version db02
141−
130+
142− describe "IDBKeyRange" do
131+ describe "IDBKeyRange" do
143− it "only(int)" do
132+ it "only(int)" do
144− let
145− key = 14
133+ let key = 14
146 range = IDBKeyRange.only key
134 range = IDBKeyRange.only key
147− IDBKeyRange.includes range (toKey key) `shouldEqual` true
135+ IDBKeyRange.includes range (toKey key) `shouldEqual` true
148
136
149− it "only(string)" do
137+ it "only(string)" do
150− let
151− key = "patate"
138+ let key = "patate"
152 range = IDBKeyRange.only key
139 range = IDBKeyRange.only key
153− IDBKeyRange.includes range (toKey key) `shouldEqual` true
140+ IDBKeyRange.includes range (toKey key) `shouldEqual` true
154
141
155− it "only(float)" do
142+ it "only(float)" do
156− let
157− key = 14.42
143+ let key = 14.42
158 range = IDBKeyRange.only key
144 range = IDBKeyRange.only key
159− IDBKeyRange.includes range (toKey key) `shouldEqual` true
145+ IDBKeyRange.includes range (toKey key) `shouldEqual` true
160
146
161− it "only(date)" do
147+ it "only(date)" do
162− let
163− mkey = DateTime
148+ let mkey = DateTime
164 <$> (Date.canonicalDate <$> toEnum 2017 <*> toEnum 6 <*> toEnum 23)
149 <$> (Date.canonicalDate <$> toEnum 2017 <*> toEnum 6 <*> toEnum 23)
165 <*> (Time <$> toEnum 17 <*> toEnum 59 <*> toEnum 34 <*> toEnum 42)
150 <*> (Time <$> toEnum 17 <*> toEnum 59 <*> toEnum 34 <*> toEnum 42)
166
151
167− case mkey of
152+ case mkey of
168− Nothing ->
153+ Nothing ->
169− fail "unable to create datetime"
154+ fail "unable to create datetime"
170− Just key -> do
155+ Just key -> do
171− let range = IDBKeyRange.only key
156+ let range = IDBKeyRange.only key
172− IDBKeyRange.includes range (toKey key) `shouldEqual` true
157+ IDBKeyRange.includes range (toKey key) `shouldEqual` true
173
158
174− it "only([int])" do
159+ it "only([int])" do
175− let
176− key = [ 14, 42 ]
160+ let key = [14, 42]
177 range = IDBKeyRange.only key
161 range = IDBKeyRange.only key
178− IDBKeyRange.includes range (toKey key) `shouldEqual` true
162+ IDBKeyRange.includes range (toKey key) `shouldEqual` true
179
163
180− it "only([string])" do
164+ it "only([string])" do
181− let
182− key = [ "patate", "autruche" ]
165+ let key = ["patate", "autruche"]
183 range = IDBKeyRange.only key
166 range = IDBKeyRange.only key
184− IDBKeyRange.includes range (toKey key) `shouldEqual` true
167+ IDBKeyRange.includes range (toKey key) `shouldEqual` true
185
168
186− it "lowerBound(14, open)" do
169+ it "lowerBound(14, open)" do
187− let
188− key = 14
170+ let key = 14
189− open = true
171+ open = true
190 range = IDBKeyRange.lowerBound key open
172 range = IDBKeyRange.lowerBound key open
191− IDBKeyRange.includes range (toKey (key + 1)) `shouldEqual` true
173+ IDBKeyRange.includes range (toKey (key + 1)) `shouldEqual` true
192− IDBKeyRange.includes range (toKey key) `shouldEqual` (not open)
174+ IDBKeyRange.includes range (toKey key) `shouldEqual` (not open)
193− IDBKeyRange.includes range (toKey (key - 1)) `shouldEqual` false
175+ IDBKeyRange.includes range (toKey (key - 1)) `shouldEqual` false
194−
176+
195− it "lowerBound(14, close)" do
177+ it "lowerBound(14, close)" do
196− let
197− key = 14
178+ let key = 14
198− open = false
179+ open = false
199 range = IDBKeyRange.lowerBound key open
180 range = IDBKeyRange.lowerBound key open
200− IDBKeyRange.includes range (toKey (key + 1)) `shouldEqual` true
181+ IDBKeyRange.includes range (toKey (key + 1)) `shouldEqual` true
201− IDBKeyRange.includes range (toKey key) `shouldEqual` (not open)
182+ IDBKeyRange.includes range (toKey key) `shouldEqual` (not open)
202− IDBKeyRange.includes range (toKey (key - 1)) `shouldEqual` false
183+ IDBKeyRange.includes range (toKey (key - 1)) `shouldEqual` false
203−
184+
204− it "upperBound(14, open)" do
185+ it "upperBound(14, open)" do
205− let
206− key = 14
186+ let key = 14
207− open = true
187+ open = true
208 range = IDBKeyRange.upperBound key open
188 range = IDBKeyRange.upperBound key open
209− IDBKeyRange.includes range (toKey (key + 1)) `shouldEqual` false
189+ IDBKeyRange.includes range (toKey (key + 1)) `shouldEqual` false
210− IDBKeyRange.includes range (toKey key) `shouldEqual` (not open)
190+ IDBKeyRange.includes range (toKey key) `shouldEqual` (not open)
211− IDBKeyRange.includes range (toKey (key - 1)) `shouldEqual` true
191+ IDBKeyRange.includes range (toKey (key - 1)) `shouldEqual` true
212−
192+
213− it "upperBound(14, close)" do
193+ it "upperBound(14, close)" do
214− let
215− key = 14
194+ let key = 14
216− open = false
195+ open = false
217 range = IDBKeyRange.upperBound key open
196 range = IDBKeyRange.upperBound key open
218− IDBKeyRange.includes range (toKey (key + 1)) `shouldEqual` false
197+ IDBKeyRange.includes range (toKey (key + 1)) `shouldEqual` false
219− IDBKeyRange.includes range (toKey key) `shouldEqual` (not open)
198+ IDBKeyRange.includes range (toKey key) `shouldEqual` (not open)
220− IDBKeyRange.includes range (toKey (key - 1)) `shouldEqual` true
199+ IDBKeyRange.includes range (toKey (key - 1)) `shouldEqual` true
221−
200+
222− it "bound(42, 14, open, open) => Nothing" do
201+ it "bound(42, 14, open, open) => Nothing" do
223− let
224− lower = 42
202+ let lower = 42
225− upper = 14
203+ upper = 14
226 lowerOpen = true
204 lowerOpen = true
227 upperOpen = true
205 upperOpen = true
228− mrange = IDBKeyRange.bound { lower, upper, lowerOpen, upperOpen }
206+ mrange = IDBKeyRange.bound { lower, upper, lowerOpen, upperOpen }
229− isNothing mrange `shouldEqual` true
207+ isNothing mrange `shouldEqual` true
230
208
231− it "bound(14, 42, open, open)" do
209+ it "bound(14, 42, open, open)" do
232− let
233− lower = 14
210+ let lower = 14
234− upper = 42
211+ upper = 42
235 lowerOpen = true
212 lowerOpen = true
236 upperOpen = true
213 upperOpen = true
237− mrange = IDBKeyRange.bound { lower, upper, lowerOpen, upperOpen }
214+ mrange = IDBKeyRange.bound { lower, upper, lowerOpen, upperOpen }
238− case mrange of
215+ case mrange of
239− Nothing ->
216+ Nothing ->
240− fail "invalid range provided"
217+ fail "invalid range provided"
241− Just range -> do
218+ Just range -> do
242− IDBKeyRange.includes range (toKey (lower + 1)) `shouldEqual` true
219+ IDBKeyRange.includes range (toKey (lower + 1)) `shouldEqual` true
243− IDBKeyRange.includes range (toKey (upper - 1)) `shouldEqual` true
220+ IDBKeyRange.includes range (toKey (upper - 1)) `shouldEqual` true
244− IDBKeyRange.includes range (toKey (lower - 1)) `shouldEqual` false
221+ IDBKeyRange.includes range (toKey (lower - 1)) `shouldEqual` false
245− IDBKeyRange.includes range (toKey (upper + 1)) `shouldEqual` false
222+ IDBKeyRange.includes range (toKey (upper + 1)) `shouldEqual` false
246− IDBKeyRange.includes range (toKey lower) `shouldEqual` (not lowerOpen)
223+ IDBKeyRange.includes range (toKey lower) `shouldEqual` (not lowerOpen)
247− IDBKeyRange.includes range (toKey upper) `shouldEqual` (not upperOpen)
224+ IDBKeyRange.includes range (toKey upper) `shouldEqual` (not upperOpen)
248−
225+
249− it "bound(14, 42, open, close)" do
226+ it "bound(14, 42, open, close)" do
250− let
251− lower = 14
227+ let lower = 14
252− upper = 42
228+ upper = 42
253 lowerOpen = true
229 lowerOpen = true
254 upperOpen = false
230 upperOpen = false
255− mrange = IDBKeyRange.bound { lower, upper, lowerOpen, upperOpen }
231+ mrange = IDBKeyRange.bound { lower, upper, lowerOpen, upperOpen }
256− case mrange of
232+ case mrange of
257− Nothing ->
233+ Nothing ->
258− fail "invalid range provided"
234+ fail "invalid range provided"
259− Just range -> do
235+ Just range -> do
260− IDBKeyRange.includes range (toKey (lower + 1)) `shouldEqual` true
236+ IDBKeyRange.includes range (toKey (lower + 1)) `shouldEqual` true
261− IDBKeyRange.includes range (toKey (upper - 1)) `shouldEqual` true
237+ IDBKeyRange.includes range (toKey (upper - 1)) `shouldEqual` true
262− IDBKeyRange.includes range (toKey (lower - 1)) `shouldEqual` false
238+ IDBKeyRange.includes range (toKey (lower - 1)) `shouldEqual` false
263− IDBKeyRange.includes range (toKey (upper + 1)) `shouldEqual` false
239+ IDBKeyRange.includes range (toKey (upper + 1)) `shouldEqual` false
264− IDBKeyRange.includes range (toKey lower) `shouldEqual` (not lowerOpen)
240+ IDBKeyRange.includes range (toKey lower) `shouldEqual` (not lowerOpen)
265− IDBKeyRange.includes range (toKey upper) `shouldEqual` (not upperOpen)
241+ IDBKeyRange.includes range (toKey upper) `shouldEqual` (not upperOpen)
266−
242+
267− it "bound(14, 42, close, open)" do
243+ it "bound(14, 42, close, open)" do
268− let
269− lower = 14
244+ let lower = 14
270− upper = 42
245+ upper = 42
271 lowerOpen = false
246 lowerOpen = false
272 upperOpen = true
247 upperOpen = true
273− mrange = IDBKeyRange.bound { lower, upper, lowerOpen, upperOpen }
248+ mrange = IDBKeyRange.bound { lower, upper, lowerOpen, upperOpen }
274− case mrange of
249+ case mrange of
275− Nothing ->
250+ Nothing ->
276− fail "invalid range provided"
251+ fail "invalid range provided"
277− Just range -> do
252+ Just range -> do
278− IDBKeyRange.includes range (toKey (lower + 1)) `shouldEqual` true
253+ IDBKeyRange.includes range (toKey (lower + 1)) `shouldEqual` true
279− IDBKeyRange.includes range (toKey (upper - 1)) `shouldEqual` true
254+ IDBKeyRange.includes range (toKey (upper - 1)) `shouldEqual` true
280− IDBKeyRange.includes range (toKey (lower - 1)) `shouldEqual` false
255+ IDBKeyRange.includes range (toKey (lower - 1)) `shouldEqual` false
281− IDBKeyRange.includes range (toKey (upper + 1)) `shouldEqual` false
256+ IDBKeyRange.includes range (toKey (upper + 1)) `shouldEqual` false
282− IDBKeyRange.includes range (toKey lower) `shouldEqual` (not lowerOpen)
257+ IDBKeyRange.includes range (toKey lower) `shouldEqual` (not lowerOpen)
283− IDBKeyRange.includes range (toKey upper) `shouldEqual` (not upperOpen)
258+ IDBKeyRange.includes range (toKey upper) `shouldEqual` (not upperOpen)
284−
259+
285− it "bound(14, 42, close, close)" do
260+ it "bound(14, 42, close, close)" do
286− let
287− lower = 14
261+ let lower = 14
288− upper = 42
262+ upper = 42
289 lowerOpen = false
263 lowerOpen = false
290 upperOpen = false
264 upperOpen = false
291− mrange = IDBKeyRange.bound { lower, upper, lowerOpen, upperOpen }
265+ mrange = IDBKeyRange.bound { lower, upper, lowerOpen, upperOpen }
292− case mrange of
266+ case mrange of
293− Nothing ->
267+ Nothing ->
294− fail "invalid range provided"
268+ fail "invalid range provided"
295− Just range -> do
269+ Just range -> do
296− IDBKeyRange.includes range (toKey (lower + 1)) `shouldEqual` true
270+ IDBKeyRange.includes range (toKey (lower + 1)) `shouldEqual` true
297− IDBKeyRange.includes range (toKey (upper - 1)) `shouldEqual` true
271+ IDBKeyRange.includes range (toKey (upper - 1)) `shouldEqual` true
298− IDBKeyRange.includes range (toKey (lower - 1)) `shouldEqual` false
272+ IDBKeyRange.includes range (toKey (lower - 1)) `shouldEqual` false
299− IDBKeyRange.includes range (toKey (upper + 1)) `shouldEqual` false
273+ IDBKeyRange.includes range (toKey (upper + 1)) `shouldEqual` false
300− IDBKeyRange.includes range (toKey lower) `shouldEqual` (not lowerOpen)
274+ IDBKeyRange.includes range (toKey lower) `shouldEqual` (not lowerOpen)
301− IDBKeyRange.includes range (toKey upper) `shouldEqual` (not upperOpen)
275+ IDBKeyRange.includes range (toKey upper) `shouldEqual` (not upperOpen)
302−
276+
303− it "can access attributes of a range" do
277+ it "can access attributes of a range" do
304− let range = IDBKeyRange.lowerBound 14 false
278+ let range = IDBKeyRange.lowerBound 14 false
305− IDBKeyRange.lower range `shouldEqual` (Just $ toKey 14)
279+ IDBKeyRange.lower range `shouldEqual` (Just $ toKey 14)
306− IDBKeyRange.upper range `shouldEqual` none
280+ IDBKeyRange.upper range `shouldEqual` none
307− IDBKeyRange.lowerOpen range `shouldEqual` false
281+ IDBKeyRange.lowerOpen range `shouldEqual` false
308− IDBKeyRange.upperOpen range `shouldEqual` true
282+ IDBKeyRange.upperOpen range `shouldEqual` true
309−
283+
310− describe "IDBDatabase" do
284+ describe "IDBDatabase" do
311− let
285+ let
312 tearDown db = do
286 tearDown db = do
313 IDBDatabase.close db
287 IDBDatabase.close db
314 _ <- IDBFactory.deleteDatabase (IDBDatabase.name db)
288 _ <- IDBFactory.deleteDatabase (IDBDatabase.name db)
315 pure unit
289 pure unit
316
290
317 setup storeParams = do
291 setup storeParams = do
318− let
319− onUpgradeNeeded var db _ _ = launchAff' do
292+ let onUpgradeNeeded var db _ = launchAff' do
320− store <- IDBDatabase.createObjectStore db "store" storeParams
293+ store <- IDBDatabase.createObjectStore db "store" storeParams
321− _ <- AVar.put { db, store } var
294+ _ <- putVar var { db, store }
322− pure unit
295+ pure unit
323−
296+
324− var <- AVar.empty
297+ var <- makeVar
325− _ <- IDBFactory.open "db" Nothing
298+ db <- IDBFactory.open "db" Nothing
326− { onUpgradeNeeded: Just (onUpgradeNeeded var)
299+ { onUpgradeNeeded : Just (onUpgradeNeeded var)
327− , onBlocked: Nothing
300+ , onBlocked : Nothing
328 }
301 }
329
302
330− AVar.take var
303+ takeVar var
331−
304+
332− it "createObjectStore (keyPath: [], autoIncrement: true)" do
305+ it "createObjectStore (keyPath: [], autoIncrement: true)" do
333− { db, store } <- setup { keyPath: [], autoIncrement: true }
306+ { db, store } <- setup { keyPath: [], autoIncrement: true }
334− IDBObjectStore.name store `shouldEqual` "store"
307+ IDBObjectStore.name store `shouldEqual` "store"
335− IDBObjectStore.keyPath store `shouldEqual` []
308+ IDBObjectStore.keyPath store `shouldEqual` []
336− IDBObjectStore.autoIncrement store `shouldEqual` true
309+ IDBObjectStore.autoIncrement store `shouldEqual` true
337− IDBObjectStore.indexNames store `shouldEqual` []
310+ IDBObjectStore.indexNames store `shouldEqual` []
338− tearDown db
311+ tearDown db
339−
312+
340− it "createObjectStore (keyPath: [\"patate\"], autoIncrement: true)" do
313+ it "createObjectStore (keyPath: [\"patate\"], autoIncrement: true)" do
341− { db, store } <- setup { keyPath: [ "patate" ], autoIncrement: true }
314+ { db, store } <- setup { keyPath: ["patate"], autoIncrement: true }
342− IDBObjectStore.name store `shouldEqual` "store"
315+ IDBObjectStore.name store `shouldEqual` "store"
343− IDBObjectStore.keyPath store `shouldEqual` [ "patate" ]
316+ IDBObjectStore.keyPath store `shouldEqual` ["patate"]
344− IDBObjectStore.autoIncrement store `shouldEqual` true
317+ IDBObjectStore.autoIncrement store `shouldEqual` true
345− IDBObjectStore.indexNames store `shouldEqual` []
318+ IDBObjectStore.indexNames store `shouldEqual` []
346− tearDown db
319+ tearDown db
347−
320+
348− it "createObjectStore (keyPath: [\"a\", \"b\"], autoIncrement: false)" do
321+ it "createObjectStore (keyPath: [\"a\", \"b\"], autoIncrement: false)" do
349− { db, store } <- setup { keyPath: [ "patate", "autruche" ], autoIncrement: false }
322+ { db, store } <- setup { keyPath: ["patate", "autruche"], autoIncrement: false }
350− IDBObjectStore.name store `shouldEqual` "store"
323+ IDBObjectStore.name store `shouldEqual` "store"
351− IDBObjectStore.keyPath store `shouldEqual` [ "patate", "autruche" ]
324+ IDBObjectStore.keyPath store `shouldEqual` ["patate", "autruche"]
352− IDBObjectStore.autoIncrement store `shouldEqual` false
325+ IDBObjectStore.autoIncrement store `shouldEqual` false
353− IDBObjectStore.indexNames store `shouldEqual` []
326+ IDBObjectStore.indexNames store `shouldEqual` []
354− tearDown db
327+ tearDown db
355−
328+
356− it "deleteObjectStore" do
329+ it "deleteObjectStore" do
357− let
358− onUpgradeNeeded var db _ _ = launchAff' do
330+ let onUpgradeNeeded var db _ = launchAff' do
359 _ <- IDBDatabase.deleteObjectStore db "store"
331 _ <- IDBDatabase.deleteObjectStore db "store"
360− AVar.put true var
332+ putVar var true
361−
333+
362− var <- AVar.empty
334+ var <- makeVar
363− { db } <- setup IDBDatabase.defaultParameters
335+ { db, store } <- setup IDBObjectStore.defaultParameters
364− IDBDatabase.close db
336+ IDBDatabase.close db
365− db' <- IDBFactory.open "db" (Just 999)
366− { onUpgradeNeeded: Just (onUpgradeNeeded var)
337+ db <- IDBFactory.open "db" (Just 999) { onUpgradeNeeded : Just (onUpgradeNeeded var)
367− , onBlocked: Nothing
338+ , onBlocked : Nothing
368− }
339+ }
369− deleted <- AVar.take var
340+ deleted <- takeVar var
370− deleted `shouldEqual` true
341+ deleted `shouldEqual` true
371− tearDown db'
342+ tearDown db
372
343
344+
373− describe "IDBObjectStore" do
345+ describe "IDBObjectStore" do
374− let
346+ let
375 tearDown db = do
347 tearDown db = do
376 IDBDatabase.close db
348 IDBDatabase.close db
377 _ <- IDBFactory.deleteDatabase (IDBDatabase.name db)
349 _ <- IDBFactory.deleteDatabase (IDBDatabase.name db)
378 pure unit
350 pure unit
379
351
380 setup { storeParams, onUpgradeNeeded } = do
352 setup { storeParams, onUpgradeNeeded } = do
381− let
382− onUpgradeNeeded' var db _ _ = launchAff' do
353+ let onUpgradeNeeded' var db _ = launchAff' do
383− store <- IDBDatabase.createObjectStore db "store" storeParams
354+ store <- IDBDatabase.createObjectStore db "store" storeParams
384− liftEffect $ maybe (pure unit) identity (onUpgradeNeeded <*> pure db <*> pure store)
355+ liftEff $ maybe (pure unit) id (onUpgradeNeeded <*> pure db <*> pure store)
385− AVar.put { db, store } var
356+ putVar var { db, store }
386−
357+
387− var <- AVar.empty
358+ var <- makeVar
388− _ <- IDBFactory.open "db" Nothing
359+ db <- IDBFactory.open "db" Nothing
389− { onUpgradeNeeded: Just (onUpgradeNeeded' var)
360+ { onUpgradeNeeded : Just (onUpgradeNeeded' var)
390− , onBlocked: Nothing
361+ , onBlocked : Nothing
391 }
362 }
392
363
393− AVar.take var
364+ takeVar var
394−
365+
395− it "add()" do
366+ it "add()" do
396− date <- liftEffect $ toDateTime <$> now
367+ date <- liftEff $ toDateTime <$> now
397− { db } <- setup
368+ { db } <- setup
398− { storeParams: { autoIncrement: true, keyPath: [] }
369+ { storeParams: { autoIncrement: true, keyPath: [] }
399− , onUpgradeNeeded: Just $ \_ store -> launchAff' do
370+ , onUpgradeNeeded: Just $ \_ store -> launchAff' do
400− -- no key
371+ -- no key
401− key <- IDBObjectStore.add store "patate" none
372+ key <- IDBObjectStore.add store "patate" none
402− (toKey 1) `shouldEqual` key
373+ (toKey 1) `shouldEqual` key
403−
374+
404− -- int key
375+ -- int key
405− key' <- IDBObjectStore.add store "patate" (Just 14)
376+ key <- IDBObjectStore.add store "patate" (Just 14)
406− (toKey 14) `shouldEqual` key'
377+ (toKey 14) `shouldEqual` key
407−
378+
408− -- number key
379+ -- number key
409− key'' <- IDBObjectStore.add store "patate" (Just 14.42)
380+ key <- IDBObjectStore.add store "patate" (Just 14.42)
410− (toKey 14.42) `shouldEqual` key''
381+ (toKey 14.42) `shouldEqual` key
411−
382+
412− -- string key
383+ -- string key
413− key''' <- IDBObjectStore.add store "patate" (Just "key")
384+ key <- IDBObjectStore.add store "patate" (Just "key")
414− (toKey "key") `shouldEqual` key'''
385+ (toKey "key") `shouldEqual` key
415−
386+
416− -- date key
387+ -- date key
417− key'''' <- IDBObjectStore.add store "patate" (Just date)
388+ key <- IDBObjectStore.add store "patate" (Just date)
418− (toKey date) `shouldEqual` key''''
389+ (toKey date) `shouldEqual` key
419−
390+
420− -- array key
391+ -- array key
421− key''''' <- IDBObjectStore.add store "patate" (Just $ toKey [ 14, 42 ])
392+ key <- IDBObjectStore.add store "patate" (Just $ toKey [14, 42])
422− (toKey [ 14, 42 ]) `shouldEqual` key'''''
393+ (toKey [14, 42]) `shouldEqual` key
423− }
394+ }
424− tearDown db
395+ tearDown db
425−
396+
426− it "clear()" do
397+ it "clear()" do
427− { db } <- setup
398+ { db } <- setup
428− { storeParams: IDBDatabase.defaultParameters
399+ { storeParams: IDBObjectStore.defaultParameters
429− , onUpgradeNeeded: Just $ \_ store -> launchAff' do
400+ , onUpgradeNeeded: Just $ \_ store -> launchAff' do
430− key <- IDBObjectStore.add store "patate" (Just 14)
401+ key <- IDBObjectStore.add store "patate" (Just 14)
431− _ <- IDBObjectStore.clear store
402+ _ <- IDBObjectStore.clear store
432− val <- IDBObjectStore.get store (IDBKeyRange.only key)
403+ val <- IDBObjectStore.get store (IDBKeyRange.only key)
433− val `shouldEqual` (Nothing :: Maybe String)
404+ val `shouldEqual` (Nothing :: Maybe String)
405+ }
406+ tearDown db
407+
408+ it "count()" do
409+ { db } <- setup
410+ { storeParams: IDBObjectStore.defaultParameters
411+ , onUpgradeNeeded: Just $ \_ store -> launchAff' do
412+ key <- IDBObjectStore.add store "patate" (Just 14)
413+ key <- IDBObjectStore.add store "autruche" (Just 42)
414+ n <- IDBObjectStore.count store Nothing
415+ n `shouldEqual` 2
416+ }
417+ tearDown db
418+
419+ it "getKey()" do
420+ { db } <- setup
421+ { storeParams: IDBObjectStore.defaultParameters
422+ , onUpgradeNeeded: Just $ \_ store -> launchAff' do
423+ key <- IDBObjectStore.add store "patate" (Just 14)
424+ mkey <- IDBObjectStore.getKey store (IDBKeyRange.only 14)
425+ mkey `shouldEqual` (Just key)
426+
427+ mkey <- IDBObjectStore.getKey store (IDBKeyRange.only 42)
428+ mkey `shouldEqual` none
434 }
429 }
435− tearDown db
430+ tearDown db
436−
431+
437− it "count()" do
432+ it "getAllKeys()" do
438− { db } <- setup
433+ { db } <- setup
439− { storeParams: IDBDatabase.defaultParameters
440− , onUpgradeNeeded: Just $ \_ store -> launchAff' do
441− _ <- IDBObjectStore.add store "patate" (Just 14)
442− _ <- IDBObjectStore.add store "autruche" (Just 42)
443− n <- IDBObjectStore.count store Nothing
444− n `shouldEqual` 2
445− }
446− tearDown db
447−
448− it "getKey()" do
449− { db } <- setup
450− { storeParams: IDBDatabase.defaultParameters
434+ { storeParams: IDBObjectStore.defaultParameters
451− , onUpgradeNeeded: Just $ \_ store -> launchAff' do
452− key <- IDBObjectStore.add store "patate" (Just 14)
453− mkey <- IDBObjectStore.getKey store (IDBKeyRange.only 14)
454− mkey `shouldEqual` (Just key)
455−
456− mkey' <- IDBObjectStore.getKey store (IDBKeyRange.only 42)
457− mkey' `shouldEqual` none
458− }
459− tearDown db
460−
461− it "getAllKeys()" do
462− { db } <- setup
463− { storeParams: IDBDatabase.defaultParameters
464− , onUpgradeNeeded: Just $ \_ store -> launchAff' do
435+ , onUpgradeNeeded: Just $ \_ store -> launchAff' do
465− key1 <- IDBObjectStore.add store "patate" (Just 14)
436+ key1 <- IDBObjectStore.add store "patate" (Just 14)
466− key2 <- IDBObjectStore.add store "autruche" (Just 42)
437+ key2 <- IDBObjectStore.add store "autruche" (Just 42)
467− key3 <- IDBObjectStore.add store 14 (Just 1337)
438+ key3 <- IDBObjectStore.add store 14 (Just 1337)
468−
439+
469− -- no bounds
440+ -- no bounds
470− keys <- IDBObjectStore.getAllKeys store Nothing Nothing
441+ keys <- IDBObjectStore.getAllKeys store Nothing Nothing
471− keys `shouldEqual` [ key1, key2, key3 ]
442+ keys `shouldEqual` [key1, key2, key3]
472−
443+
473− -- lower bound
444+ -- lower bound
474− keys' <- IDBObjectStore.getAllKeys store (Just $ IDBKeyRange.lowerBound 14 true) Nothing
445+ keys <- IDBObjectStore.getAllKeys store (Just $ IDBKeyRange.lowerBound 14 true) Nothing
475− keys' `shouldEqual` [ key2, key3 ]
446+ keys `shouldEqual` [key2, key3]
476−
447+
477− -- upper bound
448+ -- upper bound
478− keys'' <- IDBObjectStore.getAllKeys store (Just $ IDBKeyRange.upperBound 42 false) Nothing
449+ keys <- IDBObjectStore.getAllKeys store (Just $ IDBKeyRange.upperBound 42 false) Nothing
479− keys'' `shouldEqual` [ key1, key2 ]
450+ keys `shouldEqual` [key1, key2]
480−
451+
481− -- count
452+ -- count
482− keys''' <- IDBObjectStore.getAllKeys store (Just $ IDBKeyRange.lowerBound 1 true) (Just 2)
453+ keys <- IDBObjectStore.getAllKeys store (Just $ IDBKeyRange.lowerBound 1 true) (Just 2)
483− keys''' `shouldEqual` [ key1, key2 ]
454+ keys `shouldEqual` [key1, key2]
484− }
455+ }
485− tearDown db
456+ tearDown db
486−
457+
487− it "openCursor()" do
458+ it "openCursor()" do
488− let
459+ let cb =
489− cb =
490− { onSuccess: const $ pure unit
460+ { onSuccess : const $ pure unit
491− , onError: show >>> fail >>> launchAff'
461+ , onError : show >>> fail >>> launchAff'
492 , onComplete: pure unit
462 , onComplete: pure unit
493 }
463 }
494− { db } <- setup
464+ { db } <- setup
495− { storeParams: IDBDatabase.defaultParameters
465+ { storeParams: IDBObjectStore.defaultParameters
496− , onUpgradeNeeded: Just $ \_ store -> launchAff' do
466+ , onUpgradeNeeded: Just $ \_ store -> launchAff' do
497− _ <- IDBObjectStore.openCursor store Nothing Next cb
467+ _ <- IDBObjectStore.openCursor store Nothing Next cb
498− _ <- IDBObjectStore.openCursor store Nothing NextUnique cb
468+ _ <- IDBObjectStore.openCursor store Nothing NextUnique cb
499− _ <- IDBObjectStore.openCursor store Nothing Prev cb
469+ _ <- IDBObjectStore.openCursor store Nothing Prev cb
500− _ <- IDBObjectStore.openCursor store Nothing PrevUnique cb
470+ _ <- IDBObjectStore.openCursor store Nothing PrevUnique cb
501− _ <- IDBObjectStore.openCursor store (Just $ IDBKeyRange.upperBound 1 true) Next cb
471+ _ <- IDBObjectStore.openCursor store (Just $ IDBKeyRange.upperBound 1 true) Next cb
502− pure unit
472+ pure unit
503− }
473+ }
504− tearDown db
474+ tearDown db
505
475
506− it "openKeyCursor()" do
476+ it "openKeyCursor()" do
507− let
477+ let cb =
508− cb =
509− { onSuccess: const $ pure unit
478+ { onSuccess : const $ pure unit
510− , onError: show >>> fail >>> launchAff'
479+ , onError : show >>> fail >>> launchAff'
511 , onComplete: pure unit
480 , onComplete: pure unit
512 }
481 }
513− { db } <- setup
482+ { db } <- setup
514− { storeParams: IDBDatabase.defaultParameters
483+ { storeParams: IDBObjectStore.defaultParameters
515− , onUpgradeNeeded: Just $ \_ store -> launchAff' do
484+ , onUpgradeNeeded: Just $ \_ store -> launchAff' do
516− _ <- IDBObjectStore.openKeyCursor store Nothing Next cb
485+ _ <- IDBObjectStore.openKeyCursor store Nothing Next cb
517− _ <- IDBObjectStore.openKeyCursor store Nothing NextUnique cb
486+ _ <- IDBObjectStore.openKeyCursor store Nothing NextUnique cb
518− _ <- IDBObjectStore.openKeyCursor store Nothing Prev cb
487+ _ <- IDBObjectStore.openKeyCursor store Nothing Prev cb
519− _ <- IDBObjectStore.openKeyCursor store Nothing PrevUnique cb
488+ _ <- IDBObjectStore.openKeyCursor store Nothing PrevUnique cb
520− _ <- IDBObjectStore.openKeyCursor store (Just $ IDBKeyRange.lowerBound 1 true) Next cb
489+ _ <- IDBObjectStore.openKeyCursor store (Just $ IDBKeyRange.lowerBound 1 true) Next cb
521− pure unit
490+ pure unit
522− }
491+ }
523− tearDown db
492+ tearDown db
524
493
525− describe "IDBIndex" do
494+ describe "IDBIndex" do
526− let
495+ let
527 tearDown db = do
496 tearDown db = do
528 IDBDatabase.close db
497 IDBDatabase.close db
529 _ <- IDBFactory.deleteDatabase (IDBDatabase.name db)
498 _ <- IDBFactory.deleteDatabase (IDBDatabase.name db)
530 pure unit
499 pure unit
531
500
532− setup
533− :: forall value
501+ setup :: forall value e e'.
534− . { storeParams :: { keyPath :: Array String, autoIncrement :: Boolean }
502+ { storeParams :: { keyPath :: Array String, autoIncrement :: Boolean }
535− , indexParams :: { unique :: Boolean, multiEntry :: Boolean }
503+ , indexParams :: { unique :: Boolean, multiEntry :: Boolean }
536− , values :: Array (Tuple value (Maybe Key))
504+ , values :: Array (Tuple value (Maybe Key))
537− , keyPath :: Array String
505+ , keyPath :: Array String
538− , onUpgradeNeeded :: Maybe (Database -> Transaction -> Index -> Effect Unit)
506+ , onUpgradeNeeded :: Maybe (Database -> Transaction -> Index -> Eff (idb :: IDB, avar :: AVAR, exception :: EXCEPTION | e') Unit)
539− }
540− -> Aff { db :: Database, index :: Index, store :: ObjectStore }
507+ } -> Aff (idb :: IDB, avar :: AVAR | e) { db :: Database, index :: Index, store :: ObjectStore }
541 setup { storeParams, indexParams, values, keyPath, onUpgradeNeeded } = do
508 setup { storeParams, indexParams, values, keyPath, onUpgradeNeeded } = do
542− let
543− onUpgradeNeeded' var db tx _ = launchAff' do
509+ let onUpgradeNeeded' var db tx = launchAff' do
544− store <- IDBDatabase.createObjectStore db "store" storeParams
510+ store <- IDBDatabase.createObjectStore db "store" storeParams
545− _ <- traverse (uncurry (IDBObjectStore.add store)) values
511+ _ <- traverse (uncurry (IDBObjectStore.add store)) values
546− index <- IDBObjectStore.createIndex store "index" keyPath indexParams
512+ index <- IDBObjectStore.createIndex store "index" keyPath indexParams
547− liftEffect $ maybe (pure unit) identity (onUpgradeNeeded <*> pure db <*> pure tx <*> pure index)
513+ liftEff $ maybe (pure unit) id (onUpgradeNeeded <*> pure db <*> pure tx <*> pure index)
548− AVar.put { db, index, store } var
514+ putVar var { db, index, store }
549−
515+
550− var <- AVar.empty
516+ var <- makeVar
551− _ <- IDBFactory.open "db" Nothing
517+ db <- IDBFactory.open "db" Nothing
552− { onUpgradeNeeded: Just (onUpgradeNeeded' var)
518+ { onUpgradeNeeded : Just (onUpgradeNeeded' var)
553− , onBlocked: Nothing
519+ , onBlocked : Nothing
554 }
520 }
555− AVar.take var
521+ takeVar var
556−
522+
523+
557− it "returns an IDBIndex and the properties are set correctly" do
524+ it "returns an IDBIndex and the properties are set correctly" do
558− { db, index } <- setup
525+ { db, index } <- setup
559− { storeParams: IDBDatabase.defaultParameters
526+ { storeParams : IDBObjectStore.defaultParameters
560− , indexParams: IDBObjectStore.defaultParameters
527+ , indexParams : IDBIndex.defaultParameters
561− , onUpgradeNeeded: Nothing
528+ , onUpgradeNeeded : Nothing
562− , keyPath: []
529+ , keyPath : []
563− , values: []
530+ , values : []
564− }
531+ }
565− IDBIndex.name index `shouldEqual` "index"
532+ IDBIndex.name index `shouldEqual` "index"
566− IDBIndex.keyPath index `shouldEqual` []
533+ IDBIndex.keyPath index `shouldEqual` []
567− IDBIndex.unique index `shouldEqual` IDBObjectStore.defaultParameters.unique
534+ IDBIndex.unique index `shouldEqual` IDBIndex.defaultParameters.unique
568− IDBIndex.multiEntry index `shouldEqual` IDBObjectStore.defaultParameters.multiEntry
535+ IDBIndex.multiEntry index `shouldEqual` IDBIndex.defaultParameters.multiEntry
569− tearDown db
536+ tearDown db
570−
537+
571− it "attempt to create an index that requires unique values on an object store already contains duplicates" do
538+ it "attempt to create an index that requires unique values on an object store already contains duplicates" do
572− let onAbort var = launchAff' (AVar.put true var)
539+ let onAbort var = launchAff' (putVar var true)
573− txVar <- AVar.empty
540+ txVar <- makeVar
574− dbVar <- AVar.empty
541+ dbVar <- makeVar
575− res <- attempt $ setup
542+ res <- attempt $ setup
576− { storeParams: IDBDatabase.defaultParameters
543+ { storeParams : IDBObjectStore.defaultParameters
577− , indexParams:
544+ , indexParams : { unique : true
578− { unique: true
579− , multiEntry: false
545+ , multiEntry : false
580− }
546+ }
581− , keyPath: [ "indexedProperty" ]
547+ , keyPath : ["indexedProperty"]
582− , values:
583− [ { indexedProperty: "bar" } :+: (Just $ toKey 1)
548+ , values : [ { indexedProperty: "bar" } :+: (Just $ toKey 1)
584− , { indexedProperty: "bar" } :+: (Just $ toKey 2)
549+ , { indexedProperty: "bar" } :+: (Just $ toKey 2)
585− ]
550+ ]
586− , onUpgradeNeeded: Just $ \db tx _ -> launchAff' do
551+ , onUpgradeNeeded : Just $ \db tx _ -> launchAff' do
587− IDBTransaction.onAbort tx (onAbort txVar)
552+ IDBTransaction.onAbort tx (onAbort txVar)
588− IDBDatabase.onAbort db (onAbort dbVar)
553+ IDBDatabase.onAbort db (onAbort dbVar)
589− }
554+ }
590− case res of
555+ case res of
591− Right _ ->
556+ Right _ ->
592− fail "expected abort"
557+ fail "expected abort"
593− _ -> do
558+ _ -> do
594− shouldEqual true =<< AVar.take txVar
559+ shouldEqual true =<< takeVar txVar
595− shouldEqual true =<< AVar.take dbVar
560+ shouldEqual true =<< takeVar dbVar
596−
561+
562+
597− it "the index is usable right after being made" do
563+ it "the index is usable right after being made" do
598− { db } <- setup
564+ { db } <- setup
599− { storeParams:
565+ { storeParams : { keyPath : ["key"]
600− { keyPath: [ "key" ]
601− , autoIncrement: false
566+ , autoIncrement : false
602− }
567+ }
603− , indexParams: IDBObjectStore.defaultParameters
568+ , indexParams : IDBIndex.defaultParameters
604− , keyPath: [ "indexedProperty" ]
569+ , keyPath : ["indexedProperty"]
605− , values:
606− [ { key: "key1", indexedProperty: "indexed_1" } :+: Nothing
570+ , values : [ { key: "key1", indexedProperty: "indexed_1" } :+: Nothing
607− , { key: "key2", indexedProperty: "indexed_2" } :+: Nothing
571+ , { key: "key2", indexedProperty: "indexed_2" } :+: Nothing
608− , { key: "key3", indexedProperty: "indexed_3" } :+: Nothing
572+ , { key: "key3", indexedProperty: "indexed_3" } :+: Nothing
609− ]
573+ ]
610− , onUpgradeNeeded: Just $ \_ _ index -> launchAff' do
574+ , onUpgradeNeeded : Just $ \_ _ index -> launchAff' do
611− val <- IDBIndex.get index (IDBKeyRange.only "indexed_2")
575+ val <- IDBIndex.get index (IDBKeyRange.only "indexed_2")
612− ((\r -> r.key) <$> val) `shouldEqual` (Just $ toKey "key2")
576+ ((\r -> r.key) <$> val) `shouldEqual` (Just $ toKey "key2")
613− }
577+ }
614− tearDown db
578+ tearDown db
615−
579+
616− it "empty keyPath" do
580+ it "empty keyPath" do
617− { db } <- setup
581+ { db } <- setup
618− { storeParams: IDBDatabase.defaultParameters
582+ { storeParams : IDBObjectStore.defaultParameters
619− , indexParams: IDBObjectStore.defaultParameters
583+ , indexParams : IDBIndex.defaultParameters
620− , keyPath: []
584+ , keyPath : []
621− , values:
622− [ "object_1" :+: (Just $ toKey 1)
585+ , values : [ "object_1" :+: (Just $ toKey 1)
623− , "object_2" :+: (Just $ toKey 2)
586+ , "object_2" :+: (Just $ toKey 2)
624− , "object_3" :+: (Just $ toKey 3)
587+ , "object_3" :+: (Just $ toKey 3)
625− ]
588+ ]
626− , onUpgradeNeeded: Just $ \_ _ index -> launchAff' do
589+ , onUpgradeNeeded : Just $ \_ _ index -> launchAff' do
627− val <- IDBIndex.get index (IDBKeyRange.only "object_3")
590+ val <- IDBIndex.get index (IDBKeyRange.only "object_3")
628− val `shouldEqual` (Just "object_3")
591+ val `shouldEqual` (Just "object_3")
629− }
592+ }
630− tearDown db
593+ tearDown db
631−
594+
632− it "index can be valid keys [date]" do
595+ it "index can be valid keys [date]" do
633− date <- liftEffect $ toDateTime <$> now
596+ date <- liftEff $ toDateTime <$> now
634− { db } <- setup
597+ { db } <- setup
635− { storeParams:
598+ { storeParams : { keyPath: ["key"]
636− { keyPath: [ "key" ]
637− , autoIncrement: false
599+ , autoIncrement: false
638− }
600+ }
639− , indexParams: IDBObjectStore.defaultParameters
601+ , indexParams : IDBIndex.defaultParameters
640− , keyPath: [ "i" ]
602+ , keyPath : ["i"]
641− , values:
642− [ { key: "date", i: (toKey date) } :+: Nothing
603+ , values : [ { key: "date", i: (toKey date) } :+: Nothing
643− ]
604+ ]
644− , onUpgradeNeeded: Just $ \_ _ index -> launchAff' do
605+ , onUpgradeNeeded : Just $ \_ _ index -> launchAff' do
645− val <- IDBIndex.get index (IDBKeyRange.only date)
606+ val <- IDBIndex.get index (IDBKeyRange.only date)
646− ((\r -> r.key) <$> val) `shouldEqual` (Just "date")
607+ ((\r -> r.key) <$> val) `shouldEqual` (Just "date")
647− }
608+ }
648− tearDown db
609+ tearDown db
649−
610+
650− it "index can be valid keys [num]" do
611+ it "index can be valid keys [num]" do
651− let num = 14
612+ let num = 14
652− { db } <- setup
613+ { db } <- setup
653− { storeParams:
614+ { storeParams : { keyPath: ["key"]
654− { keyPath: [ "key" ]
655− , autoIncrement: false
615+ , autoIncrement: false
656− }
616+ }
657− , indexParams: IDBObjectStore.defaultParameters
617+ , indexParams : IDBIndex.defaultParameters
658− , keyPath: [ "i" ]
618+ , keyPath : ["i"]
659− , values:
660− [ { key: "num", i: (toKey num) } :+: Nothing
619+ , values : [ { key: "num", i: (toKey num) } :+: Nothing
661− ]
620+ ]
662− , onUpgradeNeeded: Just $ \_ _ index -> launchAff' do
621+ , onUpgradeNeeded : Just $ \_ _ index -> launchAff' do
663− val <- IDBIndex.get index (IDBKeyRange.only num)
622+ val <- IDBIndex.get index (IDBKeyRange.only num)
664− ((\r -> r.key) <$> val) `shouldEqual` (Just "num")
623+ ((\r -> r.key) <$> val) `shouldEqual` (Just "num")
665− }
624+ }
666− tearDown db
625+ tearDown db
667−
626+
668− it "index can be valid keys [array]" do
627+ it "index can be valid keys [array]" do
669− let array = [ "patate", "autruche" ]
628+ let array = ["patate", "autruche"]
670− { db } <- setup
629+ { db } <- setup
671− { storeParams:
630+ { storeParams : { keyPath: ["key"]
672− { keyPath: [ "key" ]
673− , autoIncrement: false
631+ , autoIncrement: false
674− }
632+ }
675− , indexParams: IDBObjectStore.defaultParameters
633+ , indexParams : IDBIndex.defaultParameters
676− , keyPath: [ "i" ]
634+ , keyPath : ["i"]
677− , values:
678− [ { key: "array", i: (toKey array) } :+: Nothing
635+ , values : [ { key: "array", i: (toKey array) } :+: Nothing
679− ]
636+ ]
680− , onUpgradeNeeded: Just $ \_ _ index -> launchAff' do
637+ , onUpgradeNeeded : Just $ \_ _ index -> launchAff' do
681− val <- IDBIndex.get index (IDBKeyRange.only array)
638+ val <- IDBIndex.get index (IDBKeyRange.only array)
682− ((\r -> r.key) <$> val) `shouldEqual` (Just "array")
639+ ((\r -> r.key) <$> val) `shouldEqual` (Just "array")
683− }
640+ }
684− tearDown db
641+ tearDown db
685−
642+
686− it "openKeyCursor() - throw InvalidStateError on index deleted by aborted upgrade" do
643+ it "openKeyCursor() - throw InvalidStateError on index deleted by aborted upgrade" do
687− res <- attempt $ setup
644+ res <- attempt $ setup
688− { storeParams: { keyPath: [ "key" ], autoIncrement: false }
645+ { storeParams : { keyPath: ["key"], autoIncrement: false }
689− , indexParams: IDBObjectStore.defaultParameters
646+ , indexParams : IDBIndex.defaultParameters
690− , keyPath: [ "indexedProperty" ]
647+ , keyPath : ["indexedProperty"]
691− , values:
692− [ { key: 14, indexedProperty: "patate" } :+: Nothing
648+ , values : [ { key: 14, indexedProperty: "patate" } :+: Nothing
693− ]
649+ ]
694− , onUpgradeNeeded: Just $ \db tx index -> launchAff' do
650+ , onUpgradeNeeded : Just $ \db tx index -> launchAff' do
695− let
651+ let cb =
696− cb =
697− { onSuccess: const $ pure unit
652+ { onSuccess : const $ pure unit
698− , onError: show >>> fail >>> launchAff'
653+ , onError : show >>> fail >>> launchAff'
699 , onComplete: pure unit
654 , onComplete: pure unit
700 }
655 }
701− IDBTransaction.onAbort tx (pure unit)
656+ IDBTransaction.onAbort tx (pure unit)
702− IDBDatabase.onAbort db (pure unit)
657+ IDBDatabase.onAbort db (pure unit)
703− IDBTransaction.abort tx
658+ IDBTransaction.abort tx
704− cursor <- attempt $ IDBIndex.openKeyCursor index Nothing Next cb
659+ cursor <- attempt $ IDBIndex.openKeyCursor index Nothing Next cb
705− case cursor of
660+ case cursor of
706− Right _ -> fail "expected InvalidStateError"
661+ Right _ -> fail "expected InvalidStateError"
707− Left err -> name err `shouldEqual` "InvalidStateError"
662+ Left err -> message err `shouldEqual` "InvalidStateError"
708− }
663+ }
709− case res of
664+ case res of
710− Right _ -> fail "expected InvalidStateError"
665+ Right _ -> fail "expected InvalidStateError"
711− _ -> pure unit
666+ _ -> pure unit
712−
667+
713− it "openKeyCursor() - throw TransactionInactiveError on aborted transaction" do
668+ it "openKeyCursor() - throw TransactionInactiveError on aborted transaction" do
714− { db } <- setup
669+ { db } <- setup
715− { storeParams: { keyPath: [ "key" ], autoIncrement: false }
670+ { storeParams : { keyPath: ["key"], autoIncrement: false }
716− , indexParams: IDBObjectStore.defaultParameters
671+ , indexParams : IDBIndex.defaultParameters
717− , keyPath: [ "indexedProperty" ]
672+ , keyPath : ["indexedProperty"]
718− , values:
719− [ { key: 14, indexedProperty: "patate" } :+: Nothing
673+ , values : [ { key: 14, indexedProperty: "patate" } :+: Nothing
720− ]
674+ ]
721− , onUpgradeNeeded: Nothing
675+ , onUpgradeNeeded : Nothing
722− }
676+ }
723− let
677+ let cb =
724− cb =
725− { onSuccess: const $ pure unit
678+ { onSuccess : const $ pure unit
726− , onError: show >>> fail >>> launchAff'
679+ , onError : show >>> fail >>> launchAff'
727 , onComplete: pure unit
680 , onComplete: pure unit
728 }
681 }
729− tx <- IDBDatabase.transaction db [ "store" ] ReadOnly
682+ tx <- IDBDatabase.transaction db ["store"] ReadOnly
730− store <- IDBTransaction.objectStore tx "store"
683+ store <- IDBTransaction.objectStore tx "store"
731− index <- IDBObjectStore.index store "index"
684+ index <- IDBObjectStore.index store "index"
732− IDBTransaction.onAbort tx (pure unit)
685+ IDBTransaction.onAbort tx (pure unit)
733− IDBTransaction.abort tx
686+ IDBTransaction.abort tx
734− cursor <- attempt $ IDBIndex.openKeyCursor index Nothing Next cb
687+ cursor <- attempt $ IDBIndex.openKeyCursor index Nothing Next cb
735− case cursor of
688+ case cursor of
736− Right _ -> fail "expected TransactionInactiveError"
689+ Right _ -> fail "expected TransactionInactiveError"
737− Left err -> name err `shouldEqual` "TransactionInactiveError"
690+ Left err -> message err `shouldEqual` "TransactionInactiveError"
738−
691+
739− tearDown db
692+ tearDown db
740−
693+
741− it "openKeyCursor() - throw InvalidStateError when the index is deleted" do
694+ it "openKeyCursor() - throw InvalidStateError when the index is deleted" do
742− { db } <- setup
695+ { db } <- setup
743− { storeParams: { keyPath: [ "key" ], autoIncrement: false }
696+ { storeParams : { keyPath: ["key"], autoIncrement: false }
744− , indexParams: IDBObjectStore.defaultParameters
697+ , indexParams : IDBIndex.defaultParameters
745− , keyPath: [ "indexedProperty" ]
698+ , keyPath : ["indexedProperty"]
746− , values:
747− [ { key: 14, indexedProperty: "patate" } :+: Nothing
699+ , values : [ { key: 14, indexedProperty: "patate" } :+: Nothing
748− ]
700+ ]
749− , onUpgradeNeeded: Just $ \_ tx index -> launchAff' do
701+ , onUpgradeNeeded : Just $ \db tx index -> launchAff' do
750− let
702+ let cb =
751− cb =
752− { onSuccess: const $ pure unit
703+ { onSuccess : const $ pure unit
753− , onError: show >>> fail >>> launchAff'
704+ , onError : show >>> fail >>> launchAff'
754 , onComplete: pure unit
705 , onComplete: pure unit
755 }
706 }
756− store <- IDBTransaction.objectStore tx "store"
707+ store <- IDBTransaction.objectStore tx "store"
757− IDBObjectStore.deleteIndex store "index"
708+ IDBObjectStore.deleteIndex store "index"
758− cursor <- attempt $ IDBIndex.openKeyCursor index Nothing Next cb
709+ cursor <- attempt $ IDBIndex.openKeyCursor index Nothing Next cb
759− case cursor of
710+ case cursor of
760− Right _ -> fail "expected InvalidStateError"
711+ Right _ -> fail "expected InvalidStateError"
761− Left err -> name err `shouldEqual` "InvalidStateError"
712+ Left err -> message err `shouldEqual` "InvalidStateError"
762− }
713+ }
763−
714+
764− tearDown db
715+ tearDown db
765−
716+
766− it "openCursor() - throw InvalidStateError on index deleted by aborted upgrade" do
717+ it "openCursor() - throw InvalidStateError on index deleted by aborted upgrade" do
767− res <- attempt $ setup
718+ res <- attempt $ setup
768− { storeParams: { keyPath: [ "key" ], autoIncrement: false }
719+ { storeParams : { keyPath: ["key"], autoIncrement: false }
769− , indexParams: IDBObjectStore.defaultParameters
720+ , indexParams : IDBIndex.defaultParameters
770− , keyPath: [ "indexedProperty" ]
721+ , keyPath : ["indexedProperty"]
771− , values:
772− [ { key: 14, indexedProperty: "patate" } :+: Nothing
722+ , values : [ { key: 14, indexedProperty: "patate" } :+: Nothing
773− ]
723+ ]
774− , onUpgradeNeeded: Just $ \db tx index -> launchAff' do
724+ , onUpgradeNeeded : Just $ \db tx index -> launchAff' do
775− let
725+ let cb =
776− cb =
777− { onSuccess: const $ pure unit
726+ { onSuccess : const $ pure unit
778− , onError: show >>> fail >>> launchAff'
727+ , onError : show >>> fail >>> launchAff'
779 , onComplete: pure unit
728 , onComplete: pure unit
780 }
729 }
781− IDBTransaction.onAbort tx (pure unit)
730+ IDBTransaction.onAbort tx (pure unit)
782− IDBDatabase.onAbort db (pure unit)
731+ IDBDatabase.onAbort db (pure unit)
783− IDBTransaction.abort tx
732+ IDBTransaction.abort tx
784− cursor <- attempt $ IDBIndex.openCursor index Nothing Next cb
733+ cursor <- attempt $ IDBIndex.openCursor index Nothing Next cb
785− case cursor of
734+ case cursor of
786− Right _ -> fail "expected InvalidStateError"
735+ Right _ -> fail "expected InvalidStateError"
787− Left err -> name err `shouldEqual` "InvalidStateError"
736+ Left err -> message err `shouldEqual` "InvalidStateError"
788− }
737+ }
789− case res of
738+ case res of
790− Right _ -> fail "expected InvalidStateError"
739+ Right _ -> fail "expected InvalidStateError"
791− _ -> pure unit
740+ _ -> pure unit
792−
741+
793− it "openCursor() - throw TransactionInactiveError on aborted transaction" do
742+ it "openCursor() - throw TransactionInactiveError on aborted transaction" do
794− { db } <- setup
743+ { db } <- setup
795− { storeParams: { keyPath: [ "key" ], autoIncrement: false }
744+ { storeParams : { keyPath: ["key"], autoIncrement: false }
796− , indexParams: IDBObjectStore.defaultParameters
745+ , indexParams : IDBIndex.defaultParameters
797− , keyPath: [ "indexedProperty" ]
746+ , keyPath : ["indexedProperty"]
798− , values:
799− [ { key: 14, indexedProperty: "patate" } :+: Nothing
747+ , values : [ { key: 14, indexedProperty: "patate" } :+: Nothing
800− ]
748+ ]
801− , onUpgradeNeeded: Nothing
749+ , onUpgradeNeeded : Nothing
802− }
750+ }
803− let
751+ let cb =
804− cb =
805− { onSuccess: const $ pure unit
752+ { onSuccess : const $ pure unit
806− , onError: show >>> fail >>> launchAff'
753+ , onError : show >>> fail >>> launchAff'
807 , onComplete: pure unit
754 , onComplete: pure unit
808 }
755 }
809− tx <- IDBDatabase.transaction db [ "store" ] ReadOnly
756+ tx <- IDBDatabase.transaction db ["store"] ReadOnly
810− store <- IDBTransaction.objectStore tx "store"
757+ store <- IDBTransaction.objectStore tx "store"
811− index <- IDBObjectStore.index store "index"
758+ index <- IDBObjectStore.index store "index"
812− IDBTransaction.onAbort tx (pure unit)
759+ IDBTransaction.onAbort tx (pure unit)
813− IDBTransaction.abort tx
760+ IDBTransaction.abort tx
814− cursor <- attempt $ IDBIndex.openCursor index Nothing Next cb
761+ cursor <- attempt $ IDBIndex.openCursor index Nothing Next cb
815− case cursor of
762+ case cursor of
816− Right _ -> fail "expected TransactionInactiveError"
763+ Right _ -> fail "expected TransactionInactiveError"
817− Left err -> name err `shouldEqual` "TransactionInactiveError"
764+ Left err -> message err `shouldEqual` "TransactionInactiveError"
818−
765+
819− tearDown db
766+ tearDown db
820−
767+
821− it "openCursor() - throw InvalidStateError when the index is deleted" do
768+ it "openCursor() - throw InvalidStateError when the index is deleted" do
822− { db } <- setup
769+ { db } <- setup
823− { storeParams: { keyPath: [ "key" ], autoIncrement: false }
770+ { storeParams : { keyPath: ["key"], autoIncrement: false }
824− , indexParams: IDBObjectStore.defaultParameters
771+ , indexParams : IDBIndex.defaultParameters
825− , keyPath: [ "indexedProperty" ]
772+ , keyPath : ["indexedProperty"]
826− , values:
827− [ { key: 14, indexedProperty: "patate" } :+: Nothing
773+ , values : [ { key: 14, indexedProperty: "patate" } :+: Nothing
828− ]
774+ ]
829− , onUpgradeNeeded: Just $ \db tx index -> launchAff' do
775+ , onUpgradeNeeded : Just $ \db tx index -> launchAff' do
830− let
776+ let cb =
831− cb =
832− { onSuccess: const $ pure unit
777+ { onSuccess : const $ pure unit
833− , onError: show >>> fail >>> launchAff'
778+ , onError : show >>> fail >>> launchAff'
834 , onComplete: pure unit
779 , onComplete: pure unit
835 }
780 }
836− store <- IDBTransaction.objectStore tx "store"
781+ store <- IDBTransaction.objectStore tx "store"
837− IDBObjectStore.deleteIndex store "index"
782+ IDBObjectStore.deleteIndex store "index"
838− cursor <- attempt $ IDBIndex.openCursor index Nothing Next cb
783+ cursor <- attempt $ IDBIndex.openCursor index Nothing Next cb
839− case cursor of
784+ case cursor of
840− Right _ -> fail "expected InvalidStateError"
785+ Right _ -> fail "expected InvalidStateError"
841− Left err -> name err `shouldEqual` "InvalidStateError"
786+ Left err -> message err `shouldEqual` "InvalidStateError"
842− }
787+ }
843−
788+
844− tearDown db
789+ tearDown db
845−
790+
846− it "getKey() - multiEntry - adding keys" do
791+ it "getKey() - multiEntry - adding keys" do
847− { db } <- setup
792+ { db } <- setup
848− { storeParams: IDBDatabase.defaultParameters
793+ { storeParams : IDBObjectStore.defaultParameters
849− , indexParams: { unique: false, multiEntry: true }
794+ , indexParams : { unique: false, multiEntry: true }
850− , keyPath: [ "name" ]
795+ , keyPath : ["name"]
851− , values:
852− [ { name: [ "patate", "autruche" ] } :+: (Just $ toKey 1)
796+ , values : [ { name: ["patate", "autruche"] } :+: (Just $ toKey 1)
853− , { name: [ "bob" ] } :+: (Just $ toKey 2)
797+ , { name: ["bob"] } :+: (Just $ toKey 2)
854− ]
798+ ]
855− , onUpgradeNeeded: Just $ \_ _ index -> launchAff' do
799+ , onUpgradeNeeded : Just $ \_ _ index -> launchAff' do
856− key <- IDBIndex.getKey index (IDBKeyRange.only "patate")
800+ key <- IDBIndex.getKey index (IDBKeyRange.only "patate")
857− key `shouldEqual` (Just $ toKey 1)
801+ key `shouldEqual` (Just $ toKey 1)
858−
802+
859− key' <- IDBIndex.getKey index (IDBKeyRange.only "autruche")
803+ key <- IDBIndex.getKey index (IDBKeyRange.only "autruche")
860− key' `shouldEqual` (Just $ toKey 1)
804+ key `shouldEqual` (Just $ toKey 1)
861−
805+
862− key'' <- IDBIndex.getKey index (IDBKeyRange.only "bob")
806+ key <- IDBIndex.getKey index (IDBKeyRange.only "bob")
863− key'' `shouldEqual` (Just $ toKey 2)
807+ key `shouldEqual` (Just $ toKey 2)
864− }
808+ }
865− tearDown db
809+ tearDown db
866−
810+
811+
867− it "get() - returns the record with the first key in the range" do
812+ it "get() - returns the record with the first key in the range" do
868− { db } <- setup
813+ { db } <- setup
869− { storeParams: { keyPath: [ "key" ], autoIncrement: false }
814+ { storeParams : { keyPath: ["key"], autoIncrement: false }
870− , indexParams: IDBObjectStore.defaultParameters
815+ , indexParams : IDBIndex.defaultParameters
871− , keyPath: [ "indexedProperty" ]
816+ , keyPath : ["indexedProperty"]
872− , values:
873− [ { key: 14, indexedProperty: "patate" } :+: Nothing
817+ , values : [ { key: 14, indexedProperty: "patate" } :+: Nothing
874− , { key: 42, indexedProperty: "autruche" } :+: Nothing
818+ , { key: 42, indexedProperty: "autruche" } :+: Nothing
875− , { key: 1337, indexedProperty: "baguette" } :+: Nothing
819+ , { key: 1337, indexedProperty: "baguette" } :+: Nothing
876− ]
820+ ]
877− , onUpgradeNeeded: Nothing
821+ , onUpgradeNeeded : Nothing
878− }
822+ }
879−
823+
880− tx <- IDBDatabase.transaction db [ "store" ] ReadOnly
824+ tx <- IDBDatabase.transaction db ["store"] ReadOnly
881− store <- IDBTransaction.objectStore tx "store"
825+ store <- IDBTransaction.objectStore tx "store"
882− index <- IDBObjectStore.index store "index"
826+ index <- IDBObjectStore.index store "index"
883− val <- IDBIndex.get index (IDBKeyRange.lowerBound "autruche" false)
827+ val <- IDBIndex.get index (IDBKeyRange.lowerBound "autruche" false)
884− ((\r -> r.key) <$> val) `shouldEqual` (Just 42)
828+ ((\r -> r.key) <$> val) `shouldEqual` (Just 42)
885−
829+
886− tearDown db
830+ tearDown db
887−
831+
888− describe "IDBCursor" do
832+ describe "IDBCursor" do
889− let
833+ let
890 tearDown db = do
834 tearDown db = do
891 IDBDatabase.close db
835 IDBDatabase.close db
892 _ <- IDBFactory.deleteDatabase (IDBDatabase.name db)
836 _ <- IDBFactory.deleteDatabase (IDBDatabase.name db)
893 pure unit
837 pure unit
894
838
895− setup
896− :: forall value
839+ setup :: forall value e e'.
897− . { storeParams :: { keyPath :: Array String, autoIncrement :: Boolean }
840+ { storeParams :: { keyPath :: Array String, autoIncrement :: Boolean }
898− , indexParams :: { unique :: Boolean, multiEntry :: Boolean }
841+ , indexParams :: { unique :: Boolean, multiEntry :: Boolean }
899− , values :: Array (Tuple value (Maybe Key))
842+ , values :: Array (Tuple value (Maybe Key))
900− , keyPath :: Array String
843+ , keyPath :: Array String
901− , onUpgradeNeeded :: Maybe (Database -> Transaction -> Index -> Effect Unit)
844+ , onUpgradeNeeded :: Maybe (Database -> Transaction -> Index -> Eff (idb :: IDB, avar :: AVAR, exception :: EXCEPTION | e') Unit)
902− }
903− -> Aff { db :: Database, index :: Index, store :: ObjectStore }
845+ } -> Aff (idb :: IDB, avar :: AVAR | e) { db :: Database, index :: Index, store :: ObjectStore }
904 setup { storeParams, indexParams, values, keyPath, onUpgradeNeeded } = do
846 setup { storeParams, indexParams, values, keyPath, onUpgradeNeeded } = do
905− let
906− onUpgradeNeeded' var db tx _ = launchAff' do
847+ let onUpgradeNeeded' var db tx = launchAff' do
907− store <- IDBDatabase.createObjectStore db "store" storeParams
848+ store <- IDBDatabase.createObjectStore db "store" storeParams
908− _ <- traverse (uncurry (IDBObjectStore.add store)) values
849+ _ <- traverse (uncurry (IDBObjectStore.add store)) values
909− index <- IDBObjectStore.createIndex store "index" keyPath indexParams
850+ index <- IDBObjectStore.createIndex store "index" keyPath indexParams
910− liftEffect $ maybe (pure unit) identity (onUpgradeNeeded <*> pure db <*> pure tx <*> pure index)
851+ liftEff $ maybe (pure unit) id (onUpgradeNeeded <*> pure db <*> pure tx <*> pure index)
911− AVar.put { db, index, store } var
852+ putVar var { db, index, store }
912−
853+
913− var <- AVar.empty
854+ var <- makeVar
914− db <- IDBFactory.open "db" Nothing
855+ db <- IDBFactory.open "db" Nothing
915− { onUpgradeNeeded: Just (onUpgradeNeeded' var)
856+ { onUpgradeNeeded : Just (onUpgradeNeeded' var)
916− , onBlocked: Nothing
857+ , onBlocked : Nothing
917 }
858 }
918− AVar.take var
859+ takeVar var
919−
860+
920− it "continue() - iterate to the next record" do
861+ it "continue() - iterate to the next record" do
921− { db } <- setup
862+ { db } <- setup
922− { storeParams: IDBDatabase.defaultParameters
923− , indexParams: IDBObjectStore.defaultParameters
863+ { storeParams : IDBObjectStore.defaultParameters
864+ , indexParams : IDBIndex.defaultParameters
924− , keyPath: []
865+ , keyPath : []
925− , values:
926− [ "cupcake" :+: (Just $ toKey 4)
866+ , values : [ "cupcake" :+: (Just $ toKey 4)
927− , "pancake" :+: (Just $ toKey 2)
867+ , "pancake" :+: (Just $ toKey 2)
928− , "pie" :+: (Just $ toKey 1)
868+ , "pie" :+: (Just $ toKey 1)
929− , "pie" :+: (Just $ toKey 3)
869+ , "pie" :+: (Just $ toKey 3)
930− ]
870+ ]
931− , onUpgradeNeeded: Nothing
871+ , onUpgradeNeeded: Nothing
932− }
872+ }
933− let
934− cb vdone vvals =
873+ let cb vdone vvals =
935 { onComplete: launchAff' do
874 { onComplete: launchAff' do
936− AVar.put unit vdone
875+ putVar vdone unit
937
876
938− , onError: \error -> launchAff' do
877+ , onError: \error -> launchAff' do
939 fail $ "unexpected error: " <> show error
878 fail $ "unexpected error: " <> show error
940
879
941 , onSuccess: \cursor -> launchAff' do
880 , onSuccess: \cursor -> launchAff' do
942− vals <- AVar.take vvals
881+ vals <- takeVar vvals
943 pure (IDBCursor.value cursor) >>= shouldEqual (maybe "" _.v $ head vals)
882 pure (IDBCursor.value cursor) >>= shouldEqual (maybe "" _.v $ head vals)
944− IDBCursor.primaryKey cursor >>= shouldEqual (maybe (toKey 0) _.k $ head vals)
883+ IDBCursor.primaryKey cursor >>= shouldEqual (maybe (toKey 0) _.k $ head vals)
945− AVar.put (drop 1 vals) vvals
884+ putVar vvals (drop 1 vals)
946 IDBCursor.continue cursor none
885 IDBCursor.continue cursor none
947 }
886 }
948− vdone <- AVar.empty
887+ vdone <- makeVar
949− vvals <- AVar.new
888+ vvals <- makeVar'
950− [ { v: "pie", k: toKey 1 }
889+ [ { v: "pie" , k: toKey 1 }
951− , { v: "pancake", k: toKey 2 }
890+ , { v: "pancake", k: toKey 2 }
952− , { v: "pie", k: toKey 3 }
891+ , { v: "pie" , k: toKey 3 }
953− , { v: "cupcake", k: toKey 4 }
892+ , { v: "cupcake", k: toKey 4 }
954− ]
893+ ]
955− tx <- IDBDatabase.transaction db [ "store" ] ReadOnly
894+ tx <- IDBDatabase.transaction db ["store"] ReadOnly
956− store <- IDBTransaction.objectStore tx "store"
895+ store <- IDBTransaction.objectStore tx "store"
957− IDBObjectStore.openCursor store Nothing Next (cb vdone vvals)
896+ IDBObjectStore.openCursor store Nothing Next (cb vdone vvals)
958− AVar.take vdone
897+ takeVar vdone
959− tearDown db
898+ tearDown db
960−
899+
961− it "continue() - attempt to iterate in the wrong direction" do
900+ it "continue() - attempt to iterate in the wrong direction" do
962− { db } <- setup
901+ { db } <- setup
963− { storeParams: IDBDatabase.defaultParameters
902+ { storeParams : IDBObjectStore.defaultParameters
964− , indexParams: IDBObjectStore.defaultParameters
903+ , indexParams : IDBIndex.defaultParameters
965− , keyPath: []
904+ , keyPath : []
966− , values:
967− [ "cupcake" :+: (Just $ toKey 4)
905+ , values : [ "cupcake" :+: (Just $ toKey 4)
968− , "pancake" :+: (Just $ toKey 2)
906+ , "pancake" :+: (Just $ toKey 2)
969− , "pie" :+: (Just $ toKey 1)
907+ , "pie" :+: (Just $ toKey 1)
970− , "pie" :+: (Just $ toKey 3)
908+ , "pie" :+: (Just $ toKey 3)
971− ]
909+ ]
972− , onUpgradeNeeded: Nothing
910+ , onUpgradeNeeded: Nothing
973− }
911+ }
974− let
975− cb vdone =
912+ let cb vdone =
976 { onComplete: launchAff' do
913 { onComplete: launchAff' do
977 fail $ "shouldn't complete"
914 fail $ "shouldn't complete"
978
915
979− , onError: \error -> launchAff' do
916+ , onError: \error -> launchAff' do
980 fail $ "unexpected error: " <> show error
917 fail $ "unexpected error: " <> show error
981
918
982 , onSuccess: \cursor -> launchAff' do
919 , onSuccess: \cursor -> launchAff' do
983 res <- attempt $ IDBCursor.continue cursor (Just 1)
920 res <- attempt $ IDBCursor.continue cursor (Just 1)
984 case res of
921 case res of
985− Left err -> do
922+ Left err -> do
986− name err `shouldEqual` "DataError"
923+ message err `shouldEqual` "DataError"
987− AVar.put unit vdone
924+ putVar vdone unit
988 Right _ -> do
925 Right _ -> do
989 fail "expected continue to fail"
926 fail "expected continue to fail"
990 }
927 }
991− vdone <- AVar.empty
928+ vdone <- makeVar
992− tx <- IDBDatabase.transaction db [ "store" ] ReadOnly
929+ tx <- IDBDatabase.transaction db ["store"] ReadOnly
993− store <- IDBTransaction.objectStore tx "store"
930+ store <- IDBTransaction.objectStore tx "store"
994− IDBObjectStore.openCursor store Nothing Next (cb vdone)
931+ IDBObjectStore.openCursor store Nothing Next (cb vdone)
995− AVar.take vdone
932+ takeVar vdone
996− tearDown db
933+ tearDown db
997−
934+
935+
998− it "advance() - iterate cursor number of times specified by count" do
936+ it "advance() - iterate cursor number of times specified by count" do
999− { db } <- setup
937+ { db } <- setup
1000− { storeParams: { keyPath: [ "pKey" ], autoIncrement: false }
938+ { storeParams : { keyPath: ["pKey"], autoIncrement: false }
1001− , indexParams: IDBObjectStore.defaultParameters
939+ , indexParams : IDBIndex.defaultParameters
1002− , keyPath: []
940+ , keyPath : []
1003− , values:
1004− [ { pKey: "pkey_0", iKey: "ikey_0" } :+: Nothing
941+ , values : [ { pKey: "pkey_0", iKey: "ikey_0" } :+: Nothing
1005− , { pKey: "pkey_1", iKey: "ikey_1" } :+: Nothing
942+ , { pKey: "pkey_1", iKey: "ikey_1" } :+: Nothing
1006− , { pKey: "pkey_2", iKey: "ikey_2" } :+: Nothing
943+ , { pKey: "pkey_2", iKey: "ikey_2" } :+: Nothing
1007− , { pKey: "pkey_3", iKey: "ikey_3" } :+: Nothing
944+ , { pKey: "pkey_3", iKey: "ikey_3" } :+: Nothing
1008− ]
945+ ]
1009− , onUpgradeNeeded: Nothing
946+ , onUpgradeNeeded: Nothing
1010− }
947+ }
1011− let
1012− cb vdone vjump =
948+ let cb vdone vjump =
1013 { onComplete: launchAff' do
949 { onComplete: launchAff' do
1014− AVar.put unit vdone
950+ putVar vdone unit
1015
951
1016− , onError: \error -> launchAff' do
952+ , onError: \error -> launchAff' do
1017 fail $ "unexpected error: " <> show error
953 fail $ "unexpected error: " <> show error
1018
954
1019 , onSuccess: \cursor -> launchAff' do
955 , onSuccess: \cursor -> launchAff' do
1020− jump <- AVar.take vjump
956+ jump <- takeVar vjump
1021− if jump then do
957+ if jump
958+ then do
1022− IDBCursor.advance cursor 3
959+ IDBCursor.advance cursor 3
1023− else do
960+ else do
1024− let value = IDBCursor.value cursor
961+ let value = IDBCursor.value cursor
1025− value.pKey `shouldEqual` "pkey_3"
962+ value.pKey `shouldEqual` "pkey_3"
1026− value.iKey `shouldEqual` "ikey_3"
963+ value.iKey `shouldEqual` "ikey_3"
1027− IDBCursor.continue cursor none
964+ IDBCursor.continue cursor none
1028− AVar.put false vjump
965+ putVar vjump false
1029 }
966 }
1030− vdone <- AVar.empty
967+ vdone <- makeVar
1031− vjump <- AVar.new true
968+ vjump <- makeVar' true
1032− tx <- IDBDatabase.transaction db [ "store" ] ReadOnly
969+ tx <- IDBDatabase.transaction db ["store"] ReadOnly
1033− store <- IDBTransaction.objectStore tx "store"
970+ store <- IDBTransaction.objectStore tx "store"
1034− IDBObjectStore.openCursor store Nothing Next (cb vdone vjump)
971+ IDBObjectStore.openCursor store Nothing Next (cb vdone vjump)
1035− AVar.take vdone
972+ takeVar vdone
1036− tearDown db
973+ tearDown db
1037−
974+
1038− it "delete() - remove a record from the object store" do
975+ it "delete() - remove a record from the object store" do
1039− { db } <- setup
976+ { db } <- setup
1040− { storeParams: { keyPath: [ "pKey" ], autoIncrement: false }
977+ { storeParams : { keyPath: ["pKey"], autoIncrement: false }
1041− , indexParams: IDBObjectStore.defaultParameters
978+ , indexParams : IDBIndex.defaultParameters
1042− , keyPath: []
979+ , keyPath : []
1043− , values:
1044− [ { pKey: "pkey_0", iKey: "ikey_0" } :+: Nothing
980+ , values : [ { pKey: "pkey_0", iKey: "ikey_0" } :+: Nothing
1045− , { pKey: "pkey_1", iKey: "ikey_1" } :+: Nothing
981+ , { pKey: "pkey_1", iKey: "ikey_1" } :+: Nothing
1046− , { pKey: "pkey_2", iKey: "ikey_2" } :+: Nothing
982+ , { pKey: "pkey_2", iKey: "ikey_2" } :+: Nothing
1047− , { pKey: "pkey_3", iKey: "ikey_3" } :+: Nothing
983+ , { pKey: "pkey_3", iKey: "ikey_3" } :+: Nothing
1048− ]
984+ ]
1049− , onUpgradeNeeded: Nothing
985+ , onUpgradeNeeded: Nothing
1050− }
986+ }
1051− let
1052− cb vdone store =
987+ let cb vdone store =
1053 { onComplete: launchAff' do
988 { onComplete: launchAff' do
1054 mval <- map _.pKey <$> IDBIndex.get store (IDBKeyRange.only "pkey_0")
989 mval <- map _.pKey <$> IDBIndex.get store (IDBKeyRange.only "pkey_0")
1055 mval `shouldEqual` (Nothing :: Maybe String)
990 mval `shouldEqual` (Nothing :: Maybe String)
1056− AVar.put unit vdone
991+ putVar vdone unit
1057
992
1058− , onError: \error -> launchAff' do
993+ , onError: \error -> launchAff' do
1059 fail $ "unexpected error: " <> show error
994 fail $ "unexpected error: " <> show error
1060
995
1061 , onSuccess: \cursor -> launchAff' do
996 , onSuccess: \cursor -> launchAff' do
@@ -1064,31 +999,29 @@ main = do
1064 IDBCursor.delete cursor
999 IDBCursor.delete cursor
1065 IDBCursor.advance cursor 4
1000 IDBCursor.advance cursor 4
1066 }
1001 }
1067− vdone <- AVar.empty
1002+ vdone <- makeVar
1068− tx <- IDBDatabase.transaction db [ "store" ] ReadWrite
1003+ tx <- IDBDatabase.transaction db ["store"] ReadWrite
1069− store <- IDBTransaction.objectStore tx "store"
1004+ store <- IDBTransaction.objectStore tx "store"
1070− IDBObjectStore.openCursor store Nothing Next (cb vdone store)
1005+ IDBObjectStore.openCursor store Nothing Next (cb vdone store)
1071− AVar.take vdone
1006+ takeVar vdone
1072− tearDown db
1007+ tearDown db
1073−
1008+
1074− it "update() - modify a record in the object store" do
1009+ it "update() - modify a record in the object store" do
1075− { db } <- setup
1010+ { db } <- setup
1076− { storeParams: { keyPath: [ "pKey" ], autoIncrement: false }
1011+ { storeParams : { keyPath: ["pKey"], autoIncrement: false }
1077− , indexParams: IDBObjectStore.defaultParameters
1012+ , indexParams : IDBIndex.defaultParameters
1078− , keyPath: []
1013+ , keyPath : []
1079− , values:
1080− [ { pKey: "pkey_0", iKey: "ikey_0" } :+: Nothing
1014+ , values : [ { pKey: "pkey_0", iKey: "ikey_0" } :+: Nothing
1081− ]
1015+ ]
1082− , onUpgradeNeeded: Nothing
1016+ , onUpgradeNeeded: Nothing
1083− }
1017+ }
1084− let
1085− cb vdone store =
1018+ let cb vdone store =
1086 { onComplete: launchAff' do
1019 { onComplete: launchAff' do
1087 mval <- map _.iKey <$> IDBIndex.get store (IDBKeyRange.only "pkey_0")
1020 mval <- map _.iKey <$> IDBIndex.get store (IDBKeyRange.only "pkey_0")
1088 mval `shouldEqual` (Just "patate")
1021 mval `shouldEqual` (Just "patate")
1089− AVar.put unit vdone
1022+ putVar vdone unit
1090
1023
1091− , onError: \error -> launchAff' do
1024+ , onError: \error -> launchAff' do
1092 fail $ "unexpected error: " <> show error
1025 fail $ "unexpected error: " <> show error
1093
1026
1094 , onSuccess: \cursor -> launchAff' do
1027 , onSuccess: \cursor -> launchAff' do
@@ -1098,44 +1031,41 @@ main = do
1098 key `shouldEqual` toKey "pkey_0"
1031 key `shouldEqual` toKey "pkey_0"
1099 IDBCursor.advance cursor 4
1032 IDBCursor.advance cursor 4
1100 }
1033 }
1101− vdone <- AVar.empty
1034+ vdone <- makeVar
1102− tx <- IDBDatabase.transaction db [ "store" ] ReadWrite
1035+ tx <- IDBDatabase.transaction db ["store"] ReadWrite
1103− store <- IDBTransaction.objectStore tx "store"
1036+ store <- IDBTransaction.objectStore tx "store"
1104− IDBObjectStore.openCursor store Nothing Next (cb vdone store)
1037+ IDBObjectStore.openCursor store Nothing Next (cb vdone store)
1105− AVar.take vdone
1038+ takeVar vdone
1106− tearDown db
1039+ tearDown db
1107−
1040+
1108− it "update() - throw ReadOnlyError after update on ReadOnly transaction" do
1041+ it "update() - throw ReadOnlyError after update on ReadOnly transaction" do
1109− { db } <- setup
1042+ { db } <- setup
1110− { storeParams: { keyPath: [ "pKey" ], autoIncrement: false }
1043+ { storeParams : { keyPath: ["pKey"], autoIncrement: false }
1111− , indexParams: IDBObjectStore.defaultParameters
1044+ , indexParams : IDBIndex.defaultParameters
1112− , keyPath: []
1045+ , keyPath : []
1113− , values:
1114− [ { pKey: "pkey_0", iKey: "ikey_0" } :+: Nothing
1046+ , values : [ { pKey: "pkey_0", iKey: "ikey_0" } :+: Nothing
1115− ]
1047+ ]
1116− , onUpgradeNeeded: Nothing
1048+ , onUpgradeNeeded: Nothing
1117− }
1049+ }
1118− let
1119− cb vdone =
1050+ let cb vdone =
1120 { onComplete: launchAff' do
1051 { onComplete: launchAff' do
1121 fail $ "shouldn't complete"
1052 fail $ "shouldn't complete"
1122
1053
1123− , onError: \error -> launchAff' do
1054+ , onError: \error -> launchAff' do
1124 fail $ "unexpected error: " <> show error
1055 fail $ "unexpected error: " <> show error
1125
1056
1126 , onSuccess: \cursor -> launchAff' do
1057 , onSuccess: \cursor -> launchAff' do
1127 res <- attempt $ IDBCursor.update cursor "patate"
1058 res <- attempt $ IDBCursor.update cursor "patate"
1128 case res of
1059 case res of
1129 Left err -> do
1060 Left err -> do
1130− name err `shouldEqual` "ReadOnlyError"
1061+ message err `shouldEqual` "ReadOnlyError"
1131− AVar.put unit vdone
1062+ putVar vdone unit
1132 Right _ ->
1063 Right _ ->
1133 fail $ "expected ReadOnlyError"
1064 fail $ "expected ReadOnlyError"
1134 }
1065 }
1135− vdone <- AVar.empty
1066+ vdone <- makeVar
1136− tx <- IDBDatabase.transaction db [ "store" ] ReadOnly
1067+ tx <- IDBDatabase.transaction db ["store"] ReadOnly
1137− store <- IDBTransaction.objectStore tx "store"
1068+ store <- IDBTransaction.objectStore tx "store"
1138− IDBObjectStore.openCursor store Nothing Next (cb vdone)
1069+ IDBObjectStore.openCursor store Nothing Next (cb vdone)
1139− AVar.take vdone
1070+ takeVar vdone
1140− tearDown db
1071+ tearDown db
1141−
yarn.lockdeleted−81
@@ -1,81 +0,0 @@
1−# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
2−# yarn lockfile v1
3−
4−
5−base64-arraybuffer-es6@^0.7.0:
6− version "0.7.0"
7− resolved "https://registry.yarnpkg.com/base64-arraybuffer-es6/-/base64-arraybuffer-es6-0.7.0.tgz#dbe1e6c87b1bf1ca2875904461a7de40f21abc86"
8− integrity sha512-ESyU/U1CFZDJUdr+neHRhNozeCv72Y7Vm0m1DCbjX3KBjT6eYocvAJlSk6+8+HkVwXlT1FNxhGW6q3UKAlCvvw==
9−
10−domexception@^1.0.1:
11− version "1.0.1"
12− resolved "https://registry.yarnpkg.com/domexception/-/domexception-1.0.1.tgz#937442644ca6a31261ef36e3ec677fe805582c90"
13− integrity sha512-raigMkn7CJNNo6Ihro1fzG7wr3fHuYVytzquZKX5n0yizGsTcYgzdIUwj1X9pK0VvjeihV+XiclP+DjwbsSKug==
14− dependencies:
15− webidl-conversions "^4.0.2"
16−
17−fake-indexeddb@^4.0.1:
18− version "4.0.1"
19− resolved "https://registry.yarnpkg.com/fake-indexeddb/-/fake-indexeddb-4.0.1.tgz#09bb2468e21d0832b2177e894765fb109edac8fb"
20− integrity sha512-hFRyPmvEZILYgdcLBxVdHLik4Tj3gDTu/g7s9ZDOiU3sTNiGx+vEu1ri/AMsFJUZ/1sdRbAVrEcKndh3sViBcA==
21− dependencies:
22− realistic-structured-clone "^3.0.0"
23−
24−lodash@^4.7.0:
25− version "4.17.21"
26− resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.21.tgz#679591c564c3bffaae8454cf0b3df370c3d6911c"
27− integrity sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==
28−
29−punycode@^2.1.1:
30− version "2.3.0"
31− resolved "https://registry.yarnpkg.com/punycode/-/punycode-2.3.0.tgz#f67fa67c94da8f4d0cfff981aee4118064199b8f"
32− integrity sha512-rRV+zQD8tVFys26lAGR9WUuS4iUAngJScM+ZRSKtvl5tKeZ2t5bvdNFdNHBW9FWR4guGHlgmsZ1G7BSm2wTbuA==
33−
34−realistic-structured-clone@^3.0.0:
35− version "3.0.0"
36− resolved "https://registry.yarnpkg.com/realistic-structured-clone/-/realistic-structured-clone-3.0.0.tgz#7b518049ce2dad41ac32b421cd297075b00e3e35"
37− integrity sha512-rOjh4nuWkAqf9PWu6JVpOWD4ndI+JHfgiZeMmujYcPi+fvILUu7g6l26TC1K5aBIp34nV+jE1cDO75EKOfHC5Q==
38− dependencies:
39− domexception "^1.0.1"
40− typeson "^6.1.0"
41− typeson-registry "^1.0.0-alpha.20"
42−
43−tr46@^2.1.0:
44− version "2.1.0"
45− resolved "https://registry.yarnpkg.com/tr46/-/tr46-2.1.0.tgz#fa87aa81ca5d5941da8cbf1f9b749dc969a4e240"
46− integrity sha512-15Ih7phfcdP5YxqiB+iDtLoaTz4Nd35+IiAv0kQ5FNKHzXgdWqPoTIqEDDJmXceQt4JZk6lVPT8lnDlPpGDppw==
47− dependencies:
48− punycode "^2.1.1"
49−
50−typeson-registry@^1.0.0-alpha.20:
51− version "1.0.0-alpha.39"
52− resolved "https://registry.yarnpkg.com/typeson-registry/-/typeson-registry-1.0.0-alpha.39.tgz#9e0f5aabd5eebfcffd65a796487541196f4b1211"
53− integrity sha512-NeGDEquhw+yfwNhguLPcZ9Oj0fzbADiX4R0WxvoY8nGhy98IbzQy1sezjoEFWOywOboj/DWehI+/aUlRVrJnnw==
54− dependencies:
55− base64-arraybuffer-es6 "^0.7.0"
56− typeson "^6.0.0"
57− whatwg-url "^8.4.0"
58−
59−typeson@^6.0.0, typeson@^6.1.0:
60− version "6.1.0"
61− resolved "https://registry.yarnpkg.com/typeson/-/typeson-6.1.0.tgz#5b2a53705a5f58ff4d6f82f965917cabd0d7448b"
62− integrity sha512-6FTtyGr8ldU0pfbvW/eOZrEtEkczHRUtduBnA90Jh9kMPCiFNnXIon3vF41N0S4tV1HHQt4Hk1j4srpESziCaA==
63−
64−webidl-conversions@^4.0.2:
65− version "4.0.2"
66− resolved "https://registry.yarnpkg.com/webidl-conversions/-/webidl-conversions-4.0.2.tgz#a855980b1f0b6b359ba1d5d9fb39ae941faa63ad"
67− integrity sha512-YQ+BmxuTgd6UXZW3+ICGfyqRyHXVlD5GtQr5+qjiNW7bF0cqrzX500HVXPBOvgXb5YnzDd+h0zqyv61KUD7+Sg==
68−
69−webidl-conversions@^6.1.0:
70− version "6.1.0"
71− resolved "https://registry.yarnpkg.com/webidl-conversions/-/webidl-conversions-6.1.0.tgz#9111b4d7ea80acd40f5270d666621afa78b69514"
72− integrity sha512-qBIvFLGiBpLjfwmYAaHPXsn+ho5xZnGvyGvsarywGNc8VyQJUMHJ8OBKGGrPER0okBeMDaan4mNBlgBROxuI8w==
73−
74−whatwg-url@^8.4.0:
75− version "8.7.0"
76− resolved "https://registry.yarnpkg.com/whatwg-url/-/whatwg-url-8.7.0.tgz#656a78e510ff8f3937bc0bcbe9f5c0ac35941b77"
77− integrity sha512-gAojqb/m9Q8a5IV96E3fHJM70AzCkgt4uXYX2O7EmuyOnLrViCQlsEBmF9UQIu3/aeAIp2U17rtbpZWNntQqdg==
78− dependencies:
79− lodash "^4.7.0"
80− tr46 "^2.1.0"
81− webidl-conversions "^6.1.0"