Unify idb-sys and idb into one crate which are enabled with featu…

…res (#19)

* Unify idb-sys and idb into one crate which are enabled with features

* Remove lock file copy

.github/workflows/audit.yml

@@ -6,7 +6,7 @@ jobs:
   audit:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions-rs/audit-check@v1
+      - uses: actions/checkout@v4
+      - uses: rustsec/audit-check@v1.4.1
         with:
           token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/build.yml

@@ -12,37 +12,27 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout sources
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install stable rust toolchain
-        uses: actions-rs/toolchain@v1
+        uses: dtolnay/rust-toolchain@master
         with:
-          profile: minimal
           toolchain: stable
-          target: wasm32-unknown-unknown
+          targets: wasm32-unknown-unknown
       - name: Run cargo build
-        uses: actions-rs/cargo@v1
-        with:
-          command: build
+        run: cargo build --target wasm32-unknown-unknown
   lint:
     name: Lint
     runs-on: ubuntu-latest
     steps:
       - name: Checkout sources
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install stable rust toolchain
-        uses: actions-rs/toolchain@v1
+        uses: dtolnay/rust-toolchain@master
         with:
-          profile: minimal
           toolchain: stable
+          targets: wasm32-unknown-unknown
           components: rustfmt, clippy
-          target: wasm32-unknown-unknown
       - name: Run cargo fmt
-        uses: actions-rs/cargo@v1
-        with:
-          command: fmt
-          args: --all -- --check
+        run: cargo fmt --all -- --check
       - name: Run cargo clippy
-        uses: actions-rs/cargo@v1
-        with:
-          command: clippy
-          args: -- -D warnings
+        run: cargo clippy -- -D warnings

.github/workflows/test.yml

@@ -12,13 +12,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout sources
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install stable rust toolchain
-        uses: actions-rs/toolchain@v1
+        uses: dtolnay/rust-toolchain@master
         with:
-          profile: minimal
           toolchain: stable
-          target: wasm32-unknown-unknown
+          targets: wasm32-unknown-unknown
       - name: Install wasm-pack
         uses: jetli/wasm-pack-action@v0.4.0
       - name: Install just
@@ -30,13 +29,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout sources
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install stable rust toolchain
-        uses: actions-rs/toolchain@v1
+        uses: dtolnay/rust-toolchain@master
         with:
-          profile: minimal
           toolchain: stable
-          target: wasm32-unknown-unknown
+          targets: wasm32-unknown-unknown
       - name: Install wasm-pack
         uses: jetli/wasm-pack-action@v0.4.0
       - name: Install just

Cargo.toml

@@ -1,3 +1,61 @@
-[workspace]
-members = ["idb", "idb-sys"]
-resolver = "2"
+[package]
+name = "idb"
+version = "0.6.0"
+authors = ["Devashish Dixit <devashishdxt@gmail.com>"]
+license = "MIT/Apache-2.0"
+description = "A futures based crate for interacting with IndexedDB on browsers using webassembly"
+homepage = "https://github.com/devashishdxt/idb"
+repository = "https://github.com/devashishdxt/idb"
+categories = ["asynchronous", "database", "wasm", "web-programming"]
+keywords = ["wasm", "indexeddb", "future", "webassembly", "idb"]
+readme = "README.md"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[features]
+default = ["futures"]
+doc = []
+futures = ["tokio"]
+
+[dependencies]
+js-sys = "0.3.67"
+num-traits = "0.2.17"
+thiserror = "1.0.56"
+tokio = { version = "1.35.1", features = ["sync"], optional = true }
+wasm-bindgen = "0.2.90"
+web-sys = { version = "0.3.67", features = [
+    "DomException",
+    "DomStringList",
+    "Event",
+    "IdbCursor",
+    "IdbCursorDirection",
+    "IdbCursorWithValue",
+    "IdbDatabase",
+    "IdbFactory",
+    "IdbIndex",
+    "IdbIndexParameters",
+    "IdbKeyRange",
+    "IdbObjectStore",
+    "IdbObjectStoreParameters",
+    "IdbOpenDbOptions",
+    "IdbOpenDbRequest",
+    "IdbRequestReadyState",
+    "IdbTransaction",
+    "IdbTransactionMode",
+    "IdbVersionChangeEvent",
+    "StorageType",
+] }
+
+[dev-dependencies]
+gloo = { version = "0.11.0", default-features = false, features = [
+    "timers",
+    "futures",
+] }
+serde = "1.0.195"
+serde-wasm-bindgen = "0.6.3"
+serde_json = "1.0.111"
+wasm-bindgen-test = "0.3.40"
+
+[package.metadata.docs.rs]
+all-features = true

Justfile

@@ -8,19 +8,19 @@ alias test := test-chrome
 # Runs browser tests for `idb` using chrome
 test-chrome:
     @echo 'Testing...'
-    cd idb && wasm-pack test --chrome
+    wasm-pack test --chrome
 
 # Runs browser tests for `idb` using chrome (intended for use in CI)
 test-chrome-headless:
     @echo 'Testing...'
-    cd idb && wasm-pack test --headless --chrome
+    wasm-pack test --headless --chrome
 
 # Runs browser tests for `idb` using firefox (intended for use in CI)
 test-firefox-headless:
     @echo 'Testing...'
-    cd idb && wasm-pack test --headless --firefox
+    wasm-pack test --headless --firefox
 
 # Generate readme from doc comments
 readme:
     @echo 'Generating README...'
-    cd idb && cargo readme > ../README.md
+    cargo readme > ../README.md

README.md

@@ -4,19 +4,27 @@ A futures based crate for interacting with IndexedDB on browsers using webassemb
 
 ## Usage
 
-To use `idb`, you need to add the following to your `Cargo.toml`:
+To use `idb`, you need to run following command from your project root:
 
-```toml
-[dependencies]
-idb = "0.5"
+```sh
+cargo add idb
 ```
 
+If you don't want to use `async`/`await` syntax, you can disable the `futures` feature using:
+
+```sh
+cargo add idb --no-default-features
+```
+
+After disabling the `futures` feature, you can use `on_success` and `on_error` methods on requests to attach
+callbacks.
+
 ### Example
 
 To create a new database, you can use [`Factory::open`]:
 
 ```rust
-use idb::{Database, Error, Factory};
+use idb::{Database, DatabaseEvent, Error, Factory, IndexParams, KeyPath, ObjectStoreParams};
 
 async fn create_database() -> Result<Database, Error> {
     // Get a factory instance from global scope
@@ -58,9 +66,10 @@ async fn create_database() -> Result<Database, Error> {
 To add data to an object store, you can use [`ObjectStore::add`]:
 
 ```rust
-use idb::{Database, Error};
+use idb::{Database, Error, TransactionMode};
 use serde::Serialize;
 use serde_wasm_bindgen::Serializer;
+use wasm_bindgen::JsValue;
 
 async fn add_data(database: &Database) -> Result<JsValue, Error> {
     // Create a read-write transaction
@@ -85,7 +94,7 @@ async fn add_data(database: &Database) -> Result<JsValue, Error> {
         .await?;
 
     // Commit the transaction
-    transaction.commit().await?;
+    transaction.commit()?.await?;
 
     Ok(id)
 }
@@ -94,7 +103,11 @@ async fn add_data(database: &Database) -> Result<JsValue, Error> {
 To get data from an object store, you can use [`ObjectStore::get`]:
 
 ```rust
-async fn get_data(database: &Database, id: JsValue) -> Result<Option<serde_json::Value>, Error> {
+use idb::{Database, Error, TransactionMode};
+use serde_json::Value;
+use wasm_bindgen::JsValue;
+
+async fn get_data(database: &Database, id: JsValue) -> Result<Option<Value>, Error> {
     // Create a read-only transaction
     let transaction = database
         .transaction(&["employees"], TransactionMode::ReadOnly)
@@ -104,14 +117,14 @@ async fn get_data(database: &Database, id: JsValue) -> Result<Option<serde_json:
     let store = transaction.object_store("employees").unwrap();
 
     // Get the stored data
-    let stored_employee: Option<JsValue> = store.get(id).await?;
+    let stored_employee: Option<JsValue> = store.get(id)?.await?;
 
     // Deserialize the stored data
-    let stored_employee: Option<serde_json::Value> = stored_employee
+    let stored_employee: Option<Value> = stored_employee
         .map(|stored_employee| serde_wasm_bindgen::from_value(stored_employee).unwrap());
 
-    // Wait for the transaction to complete
-    transaction.done().await?;
+    // Wait for the transaction to complete (alternatively, you can also commit the transaction)
+    transaction.await?;
 
     Ok(stored_employee)
 }