update readme, fix imports

Author: michaelgoeke

README.md

@@ -1,11 +1,11 @@
-# @dnvgl-electricgrid/sqljs-documentstore
+# sqljs-documentstore
 
-`@dnvgl-electricgrid/sqljs-documentstore` Minimal, encrypted, sql friendly typed document store, with support for indexed columns. Protects against transactional conflicts.  
+`sqljs-documentstore` Minimal, encrypted, sql friendly typed document store, with support for indexed columns. Protects against transactional conflicts.  
 The schema for each table is [id, json, ...indexedColumns]
 
 
 ## Install
-`npm install --save @dnvgl-electricgrid/sqljs-documentstore`
+`npm install --save sqljs-documentstore`
 
 ## Usage
 
@@ -18,12 +18,16 @@ exported pieces:
 -----
 ### Getting started
 
-first, load your database
-recommend creating a wrapping "DocumentStores" class as shown below:
+first, load your database  
 ```ts
-const database = await sqljsHelpers.load('mydb', await sqlite());
-const lockedDatabase = new LockedDatabase(database, () => sqljsHelpers.save('mydb', database));
+const sqlJsStatic = await sqlite({ locateFile: (file: string) => `${import.meta.env.BASE_URL}assets/${file}` }); //ensure sql-wasm.wasm is placed in dist/assets/ folder
+const {key, database} = await sqljsPersistence.load('mydb', 'mySecretDbKey', sqlJsStatic);
 
+const flush = flushHelpers.createAsyncFlushQueue(() => sqljsPersistence.save('mydb', key, database));
+const lockedDatabase = new LockedDatabase(database, flush);
+```
+recommend creating a wrapping "DocumentStores" class as shown below:
+```ts
 public class DocumentStores extends Db {
   public CustomerData = new TypedDocumentStore(this.db, 'CustomerData', <CustomerData>{}, {
     name: x => x.name,
@@ -40,4 +44,48 @@ public class DocumentStores extends Db {
 }
 ```
 
-see [examples.md] (https://github.com/dnvgl-opensource/sqljs-documentstore/docs/examples.md) for usage examples.
+usage example
+```ts
+  interface CustomerData {
+      id: string;
+      name: string;
+      address: string;
+      orders: any[];//OrderData[];
+  }
+
+
+  function exampleUsage() {
+    const db = DocumentStores.Instance;
+    const allCustomers = ds.CustomerData.getAll(); // returns CustomerData[]
+    
+    const dave_id = 'abc123';
+
+    db.txn('create Dave', txnId => {
+      db.CustomerData.set(txnId, { id: dave_id, name: 'Dave', address: '1 infinity lp', orders: [{ id: 1, description: 'first order' }]});
+    });
+
+    const dave = db.CustomerData.get(dave_id); // returns <CustomerData>
+    const maybe_dave = db.CustomerData.tryGet(dave_id); //returns <CustomerData?> assert it's not null before using
+
+    db.txn('update Dave', txnId => {
+      db.CustomerData.update(txnId, dave_id, x => {
+        x.name += ' the great';
+        x.address = 'cloud 9';
+      });
+    });
+
+    const itemsWithOrders = db.CustomerData.query(x => `where ${x.orderCount} >= ?`, [1]);
+    const indexValuesOnly = db.CustomerData.queryIndexes(x => `where ${x.orderCount} > 0`); //fetch just index columns (strongly typed as index type - {id, name, orderCount} in this case) useful if table has large quantities of data and you only need, e.g. the ids that match a query
+    const customerIds = new Set(indexValuesOnly.map(x => x.id));
+  }
+
+    //use txnAsync when you want to have a transactional scope around actions that are async
+  async function exampleUsageAsync() {
+    const db = DocumentStores.Instance;
+    await db.txnAsync('fetch in the middle of a txn', txnId => {
+      const newData = await fetch(.../* actual params go here */);
+      db.CustomerData.insertMany(newData); //use insertMany if data is not expected to exist already
+      db.CustomerData.setMany(newData); //insert new rows, update if already exist
+    });
+  }
+```

docs/examples.md

@@ -1,6 +1,6 @@
 {
-  "name": "@dnvgl-electricgrid/sqljs-documentstore",
-  "version": "1.0.0",
+  "name": "sqljs-documentstore",
+  "version": "1.1.0",
   "description": "Minimal, encrypted, sql friendly typed document store, with support for indexed columns. Protects against transactional conflicts",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -22,13 +22,15 @@
     "Generic",
     "ES7"
   ],
+  "repository": "https://github.com/dnv-opensource/sqljs-documentstore",
+  "author": "Michael Goeke",
   "license": "MIT",
+  "private": false,
   "dependencies": {
     "async-lock": "^1.4.1",
     "idb-keyval": "^6.2.2",
     "lodash": "^4.17.21",
     "sql.js": "^1.13.0"
-
   },
   "devDependencies": {
     "@types/async-lock": "^1.4.2",

package.json

@@ -1,5 +1,5 @@
 import {BindParams, QueryExecResult, type Database} from 'sql.js';
-import AsyncLock from "async-lock";
+import * as AsyncLock from "async-lock";
 
 export class LockedDatabase implements ILockedDatabase {
   lock = new AsyncLock();

src/LockedDatabase.ts

@@ -1,6 +1,6 @@
 /* eslint-disable no-use-before-define */
 /* eslint-disable lines-between-class-members */
-import _ from 'lodash';
+import * as _ from 'lodash';
 import { ILockedDatabase } from './LockedDatabase';
 import { sqljsHelpers } from './sqljsHelpers';
 import { SqlValue } from 'sql.js';

src/TypedDocumentStore.ts

@@ -1,4 +1,4 @@
-import sqlite from 'sql.js';
+import * as sqlite from 'sql.js';
 import { createStore, get, getMany, setMany } from 'idb-keyval';
 
 export interface EncryptedDataItem {

src/sqljsHelpers.ts

@@ -6,7 +6,6 @@
     "strict": true,
     "experimentalDecorators": true,
     "emitDecoratorMetadata": true,
-    "allowSyntheticDefaultImports": true,
     "lib": ["es6", "dom", "esnext.asynciterable"],
     "sourceMap": true,
     "declaration": true,