docs: update drivers examples with both apis

Author: Julien-R44

docs/content/docs/drivers.md

@@ -42,11 +42,11 @@ const verrou = new Verrou({
 import { Verrou, LockFactory } from '@verrou/core'
 import { redisStore } from '@verrou/core/drivers/redis'
 
-const lockFactory = new LockFactory(
-  redisStore({
-    connection: { host: 'localhost', port: 6379 }
-  })
-)
+const store = redisStore({
+  connection: { host: 'localhost', port: 6379 }
+})
+
+const lockFactory = new LockFactory(store)
 ```
 
 :::
@@ -84,8 +84,10 @@ The memory store is a simple in-memory store, so don't use it in a multi-server
 
 Use [async-mutex](https://www.npmjs.com/package/async-mutex) under the hood.
 
+:::codegroup
 
 ```ts
+// title: Verrou API
 import { Verrou } from '@verrou/core'
 import { memoryStore } from '@verrou/core/drivers/memory'
 
@@ -97,19 +99,33 @@ const verrou = new Verrou({
 })
 ```
 
+```ts
+// title: LockFactory API
+import { Verrou, LockFactory } from '@verrou/core'
+import { memoryStore } from '@verrou/core/drivers/memory'
+
+const store = memoryStore()
+const lockFactory = new LockFactory(store)
+```
+
+:::
+
 ## DynamoDB
 
 DynamoDB is also supported by Verrou. You will need to install `@aws-sdk/client-dynamodb` to use this driver.
 
+:::codegroup
+
 ```ts
+// title: Verrou API
 import { Verrou } from '@verrou/core'
 import { dynamodbStore } from '@verrou/core/drivers/dynamodb'
 
 const verrou = new Verrou({
   default: 'dynamo',
   stores: {
     dynamo: {
-      driver: dynamoDbDriver({
+      driver: dynamodbStore({
         endpoint: '...',
         region: 'eu-west-3',
         table: {
@@ -128,6 +144,31 @@ const verrou = new Verrou({
 })
 ```
 
+```ts
+// title: LockFactory API
+import { Verrou, LockFactory } from '@verrou/core'
+import { dynamodbStore } from '@verrou/core/drivers/dynamodb'
+
+const store = dynamodbStore({
+  endpoint: '...',
+  region: 'eu-west-3',
+  table: {
+    // Name of the table where the locks will be stored
+    name: 'locks' 
+  },
+
+  // Credentials to use to connect to DynamoDB
+  credentials: {
+    accessKeyId: '...',
+    secretAccessKey: '...'
+  }
+})
+
+const lockFactory = new LockFactory(store)
+
+```
+:::
+
 The DynamoDB table will be automatically created if it does not exists. Otherwise, you can create it manually and specify the name of the table in the options.
 
 ### Options
@@ -155,88 +196,177 @@ All SQL drivers accept the following options:
 
 You will need to install `pg` to use this driver.
 
+:::codegroup
+
 ```ts
+// title: Verrou API
 import { Verrou } from '@verrou/core'
 import { databaseStore } from '@verrou/core/drivers/database'
 
 const verrou = new Verrou({
   default: 'pg',
   stores: {
     pg: {
-      driver: {
+      driver: databaseStore({
+        dialect: 'pg',
         connection: {
           user: 'root',
           password: 'root',
           database: 'postgres',
           port: 5432 
         }
-      }
+      })
     }
   }
 })
 ```
 
+```ts
+// title: LockFactory API
+import { Verrou, LockFactory } from '@verrou/core'
+import { databaseStore } from '@verrou/core/drivers/database'
+
+const store = databaseStore({
+  dialect: 'pg',
+  connection: {
+    user: 'root',
+    password: 'root',
+    database: 'postgres',
+    port: 5432 
+  }
+})
+const lockFactory = new LockFactory(store)
+```
+
+:::
+
 ### MySQL
 
 You will need to install `mysql2` to use this driver.
 
+:::codegroup
+
 ```ts
+// title: Verrou API
 import { Verrou } from '@verrou/core'
 import { databaseStore } from '@verrou/core/drivers/database'
 
 const verrou = new Verrou({
   default: 'mysql',
   stores: {
     mysql: {
-      driver: {
+      driver: databaseStore({
+        dialect: 'mysql',
         connection: {
           user: 'root', 
           password: 'root', 
           database: 'mysql', 
           port: 3306
         }
-      }
+      })
     }
   }
 })
 ```
 
+```ts
+// title: LockFactory API
+import { Verrou, LockFactory } from '@verrou/core'
+import { databaseStore } from '@verrou/core/drivers/database'
+
+const store = databaseStore({
+  dialect: 'mysql',
+  connection: {
+    user: 'root',
+    password: 'root',
+    database: 'mysql',
+    port: 3306
+  }
+})
+
+const lockFactory = new LockFactory(store)
+```
+
+:::
+
 ### SQLite ( better-sqlite3 )
 
 You will need to install `better-sqlite3` to use this driver.
 
+:::codegroup
+
 ```ts
+// title: Verrou API
 import { Verrou } from '@verrou/core'
 import { databaseStore } from '@verrou/core/drivers/database'
 
 const verrou = new Verrou({
-  default: 'sqlite3',
+  default: 'sqlite',
   stores: {
-    sqlite3: {
-      driver: { connection: { filename: 'cache.sqlite3' } }
+    sqlite: {
+      driver: databaseStore({
+        dialect: 'better-sqlite3',
+        connection: { filename: 'cache.sqlite3' }
+      })
     }
   }
 })
 ```
 
+```ts
+// title: LockFactory API
+import { Verrou, LockFactory } from '@verrou/core'
+import { databaseStore } from '@verrou/core/drivers/database'
+
+const store = databaseStore({
+  dialect: 'better-sqlite3',
+  connection: { filename: 'cache.sqlite3' }
+})
+
+const lockFactory = new LockFactory(store)
+```
+
+:::
+
+
 ### SQLite ( sqlite3 )
 
 You will need to install `sqlite3` to use this driver.
 
+:::codegroup
+
 ```ts
+// title: Verrou API
 import { Verrou } from '@verrou/core'
 import { databaseStore } from '@verrou/core/drivers/database'
 
 const verrou = new Verrou({
   default: 'sqlite',
   stores: {
     sqlite: {
-      driver: { connection: { filename: 'cache.sqlite3' } }
+      driver: databaseStore({
+        connection: { filename: 'cache.sqlite3' }
+      })
     }
   }
 })
 ```
 
+```ts
+// title: LockFactory API
+import { Verrou, LockFactory } from '@verrou/core'
+import { databaseStore } from '@verrou/core/drivers/database'
+
+const store = databaseStore({
+  dialect: 'sqlite',
+  connection: { filename: 'cache.sqlite3' }
+})
+
+const lockFactory = new LockFactory(store)
+```
+
+:::
+
 ### Implementation details
 
 The database drivers use the same strategy as Laravel's Locks. The strategy is fairly simple : Just insert a row and rely on the database primary key constraint to prevent duplicates. If the insert fails, it means the lock already exists. This is briefly explained by Aaron Francis in [this article](https://aaronfrancis.com/2021/the-exceeding-cleverness-of-laravels-database-locks).

docs/content/docs/usage.md

@@ -16,7 +16,7 @@ import { verrou } from './verrou.js'
 const lock = verrou.createLock('my-resource', '1s')
 ```
 
-The first argument is the resource/key to lock. This is an arbitrary string that will be used to identify the lock. The second argument is the duration of the lock. It can be a number of milliseconds, a string like `1s` or `1m` ( see [lukee/ms documentation](https://github.com/lukeed/ms), or even `null` if you want to create a lock that never expires.
+The first argument is the resource/key to lock. This is an arbitrary string that will be used to identify the lock. The second argument is the duration of the lock. It can be a number of milliseconds, a string like `1s` or `1m` ( see [lukeed/ms documentation](https://github.com/lukeed/ms), or even `null` if you want to create a lock that never expires.
 
 Note that the duration you are passing is the duration of the lease. This means that the lock will be automatically released after this duration. This is safe to always pass a duration, even if you are releasing the lock manually afterwards ( see below ). Having a duration will prevent the lock from being stuck forever if the process crashes before releasing it ( We call this a **Deadlock** ).