chore(deps)!: bump @orama/orama and @orama/plugin-data-persistence to 3.0.5 (#197)

* chore(deps): bump @orama/orama to 3.0.5 and @orama/plugin-data-persistence to 3.0.5

* Update README.

* Remove async calls when orama function is not async. Fix README. Improve .gitignore. Update tests.

Author: afrittella

.gitignore

@@ -140,12 +140,13 @@ dist
 .idea
 
 # DB test
+*.msp
 orama.json
+orama_[0-9]*.json
+orama_test_[0-9]*.json
 
 # Snyk
 .dccache
 package-lock.json
 pnpm-lock.yaml
 yarn.lock
-*.msp
-orama_[0-9]*.json

README.md

@@ -13,17 +13,18 @@ npm install fastify-orama
 ### Compatibility
 
 | Plugin version | Fastify version | Orama version |
-| ------------- |:---------------:|------------:|
-| `^2.0.0` | `^5.0.0` | `^2.0.0` |
-| `^1.0.0` | `^4.0.0` | `^2.0.0` |
+|----------------|:---------------:|--------------:|
+| `^3.0.0`       |    `^5.0.0`     |      `^3.0.0` |
+| `^2.0.0`       |    `^5.0.0`     |      `^2.0.0` |
+| `^1.0.0`       |    `^4.0.0`     |      `^2.0.0` |
 
 ****
 
-
 ## Usage
 
 This plugin adds the `orama` decorator to your Fastify application.
-The decorator exposes all the methods that [the Orama class exposes](https://docs.oramasearch.com/open-source/usage/create).
+The decorator exposes all the methods
+that [the Orama class exposes](https://docs.oramasearch.com/open-source/usage/create).
 
 The `options` object is passed directly to the `Orama.create` constructor,
 so it supports [all the options that Orama supports](https://docs.oramasearch.com/open-source/usage/create).
@@ -46,7 +47,7 @@ app.register(fastifyOrama, {
 app.get('/quotes/:query', async function handler (req, reply) {
   const { params: { query } } = req
 
-  const search = await app.orama.search({
+  const search = app.orama.search({
     term: query,
     properties: ["quote"]
   })
@@ -57,13 +58,13 @@ app.get('/quotes/:query', async function handler (req, reply) {
 app.listen({ port: 3000 })
 ```
 
-
 ## Usage with data persistence
 
 This plugin supports data persistence out of the box.
 You need to pass the `persistence` option to the plugin registration!
 
-This plugin uses [`@oramasearch/plugin-data-persistence`](https://docs.oramasearch.com/open-source/plugins/plugin-data-persistence)
+This plugin uses [
+`@oramasearch/plugin-data-persistence`](https://docs.oramasearch.com/open-source/plugins/plugin-data-persistence)
 under the hood to allow users to `load` or `persist` database instances.
 
 Turning on the `persistence` option will add the `fastify.orama.persist()` method to your Fastify application.
@@ -78,8 +79,8 @@ Its constructor accepts the following options:
 
 - `filePath`: The path to the file where the data will be persisted. Default: `./orama.msp`
 - `format`: The format of the file where the data will be persisted. Default: `binary`
-- `mustExistOnStart`: Whether the file must exist when the plugin is registered or not. Default: `false`. Note that if the file does not exist, you must specify the `schema` option in the plugin registration.
-
+- `mustExistOnStart`: Whether the file must exist when the plugin is registered or not. Default: `false`. Note that if
+  the file does not exist, you must specify the `schema` option in the plugin registration.
 
 ```js
 import Fastify from 'fastify'
@@ -100,10 +101,10 @@ app.register(fastifyOrama, {
   })
 })
 
-app.post('/quotes', async function (req, reply) {
+app.post('/quotes', function (req, reply) {
   const { body: { author, quote } } = req
 
-  await fastify.orama.insert({
+  fastify.orama.insert({
     author,
     quote
   })
@@ -122,7 +123,8 @@ app.listen({ port: 3000 })
 ### PersistenceInMemory
 
 This plugin comes with a `PersistenceInMemory` class that allows you to persist your data in memory.
-This adapter may be useful for testing purposes, when you need to share the same database instance between multiple tests.
+This adapter may be useful for testing purposes, when you need to share the same database instance between multiple
+tests.
 
 Its constructor accepts the following options:
 
@@ -140,7 +142,7 @@ await appOne.register(fastifyOrama, {
 })
 
 // Do some stuff with the database
-await appOne.orama.insert({
+appOne.orama.insert({
   quote: 'Orama and Fastify are awesome together.',
   author: 'Mateo Nunez'
 })
@@ -160,7 +162,7 @@ await appTwo.register(fastifyOrama, {
 })
 
 // The database is persisted between Fastify applications
-const results = await appTwo.orama.search({ term: 'Mateo Nunez' })
+const results = appTwo.orama.search({ term: 'Mateo Nunez' })
 ```
 
 ### Custom persistence
@@ -205,8 +207,8 @@ app.register(fastifyOrama, {
   }
 })
 
-app.get('/genId', async function handler (req, reply) {
-  return { newId: await oramaInternals.uniqueId() }
+app.get('/genId', function handler (req, reply) {
+  return { newId: oramaInternals.uniqueId() }
 })
 ```
 
@@ -233,12 +235,12 @@ await app.register(fastifyOrama, {
 })
 
 const appWithOrama = app.withOrama<typeof mySchema>()
-const id = await appWithOrama.orama.insert({ quote: 'Hello', author: 'World' })
+const id = appWithOrama.orama.insert({ quote: 'Hello', author: 'World' })
 
 appWithOrama.get('/hello', async () => {
 
   const {orama} = appWithOrama
-  const result = await orama.search({ term: 'hello' })
+  const result = orama.search({ term: 'hello' })
 
   return {
     hello: result.hits
@@ -255,8 +257,8 @@ fp(function plugins(fastify) {
   const fastifyWithOrama = fastify.withOrama<typeof mySchema>()
 
   expectType<{
-    insert: (document: PartialSchemaDeep<TypedDocument<Orama<typeof mySchema>>>) => Promise<string>,
-    search: (params: SearchParams<Orama<Schema<typeof mySchema>>, typeof mySchema>) => Promise<Results<Schema<typeof mySchema>>>,
+    insert: (document: PartialSchemaDeep<TypedDocument<Orama<typeof mySchema>>>) => string,
+    search: (params: SearchParams<Orama<Schema<typeof mySchema>>, typeof mySchema>) => Results<Schema<typeof mySchema>>,
     persist?: () => Promise<any>,
   }>(fastifyWithOrama.orama)
 })

index.d.ts

@@ -32,8 +32,8 @@ type FastifyOramaPluginOptions = {
 declare const fastifyOrama: FastifyPluginCallback<FastifyOramaPluginOptions>
 
 interface OramaApi<T> {
-  insert: (document: PartialSchemaDeep<TypedDocument<Orama<T>>>) => Promise<string>,
-  search: (params: SearchParams<Orama<Schema<T>>, T>) => Promise<Results<Schema<T>>>,
+  insert: (document: PartialSchemaDeep<TypedDocument<Orama<T>>>) => string,
+  search: (params: SearchParams<Orama<Schema<T>>, T>) => Results<Schema<T>>,
   persist?: () => Promise<any>,
 }
 

index.js

@@ -48,7 +48,7 @@ async function fastifyOrama (fastify, options) {
       throw new Error('You must provide a schema to create a new database')
     }
 
-    db = await Orama.create(oramaOptions)
+    db = Orama.create(oramaOptions)
   }
 
   function withOrama () {

package.json

@@ -39,8 +39,8 @@
   },
   "homepage": "https://github.com/mateonunez/fastify-orama#readme",
   "dependencies": {
-    "@orama/orama": "^2.0.0",
-    "@orama/plugin-data-persistence": "^2.0.0",
+    "@orama/orama": "^3.0.5",
+    "@orama/plugin-data-persistence": "^3.0.5",
     "fastify-plugin": "^5.0.0"
   },
   "devDependencies": {

test/index.test.js

@@ -28,12 +28,12 @@ it('Should insert and retrieve data using Orama', async () => {
     }
   })
 
-  await fastify.orama.insert({
+  fastify.orama.insert({
     quote: 'Hi there! This is fastify-orama plugin.',
     author: 'Mateo Nunez'
   })
 
-  const search = await fastify.orama.search({
+  const search = fastify.orama.search({
     term: 'fastify-orama'
   })
 

test/orama-proxy.test.js

@@ -19,7 +19,7 @@ it('Should expose all the Orama APIs', async () => {
     }
   })
 
-  const harryPotterId = await fastify.orama.insert({
+  const harryPotterId = fastify.orama.insert({
     title: 'Harry Potter and the Philosopher\'s Stone',
     director: 'Chris Columbus',
     plot: 'Harry Potter, an eleven-year-old orphan, discovers that he is a wizard and is invited to study at Hogwarts. Even as he escapes a dreary life and enters a world of magic, he finds trouble awaiting him.',
@@ -45,25 +45,25 @@ it('Should expose all the Orama APIs', async () => {
     }
   ]
 
-  const docIds = await fastify.orama.insertMultiple(docs, 500)
+  const docIds = fastify.orama.insertMultiple(docs, 500)
   ok(docIds.length === 2, 'the ids are returned')
 
-  const thePrestige = await fastify.orama.getByID(docIds[0])
+  const thePrestige = fastify.orama.getByID(docIds[0])
   strictEqual(thePrestige.title, 'The prestige')
 
-  const docNumber = await fastify.orama.count()
+  const docNumber = fastify.orama.count()
   strictEqual(docNumber, 3)
 
-  const del = await fastify.orama.remove(harryPotterId)
+  const del = fastify.orama.remove(harryPotterId)
   ok(del, 'the document was deleted')
 
-  const docNumberUpdated = await fastify.orama.count()
+  const docNumberUpdated = fastify.orama.count()
   strictEqual(docNumberUpdated, 2)
 
-  const delMultiple = await fastify.orama.removeMultiple(docIds, 500)
+  const delMultiple = fastify.orama.removeMultiple(docIds, 500)
   strictEqual(delMultiple, 2, 'the documents were deleted')
 
-  const docEmpty = await fastify.orama.count()
+  const docEmpty = fastify.orama.count()
   strictEqual(docEmpty, 0)
 })
 
@@ -98,8 +98,8 @@ it('Should not expose Orama internals', async () => {
     }
   })
 
-  fastify.get('/genId', async function handler () {
-    return { newId: await oramaInternals.uniqueId() }
+  fastify.get('/genId', function handler () {
+    return { newId: oramaInternals.uniqueId() }
   })
 
   const response = await fastify.inject('/genId')

test/persistence.test.js

@@ -8,14 +8,14 @@ const { create, insert } = require('@orama/orama')
 const { persistToFile } = require('@orama/plugin-data-persistence/server')
 
 async function buildFakeDb (filePath, format) {
-  const db = await create({
+  const db = create({
     schema: {
       author: 'string',
       quote: 'string'
     }
   })
 
-  await insert(db, {
+  insert(db, {
     author: 'Mateo Nunez',
     quote: 'Hi there! This is fastify-orama plugin.'
   })
@@ -39,7 +39,7 @@ describe('PersistenceInFile', () => {
 
     await fastify.ready()
 
-    const results = await fastify.orama.search({ term: 'fastify-orama' })
+    const results = fastify.orama.search({ term: 'fastify-orama' })
     strictEqual(results.count, 1)
 
     const { document } = results.hits[Object.keys(results.hits)[0]]
@@ -56,7 +56,7 @@ describe('PersistenceInFile', () => {
 
     await fastify.ready()
 
-    const results = await fastify.orama.search({ term: 'fastify-orama' })
+    const results = fastify.orama.search({ term: 'fastify-orama' })
     strictEqual(results.count, 1)
 
     const { document } = results.hits[Object.keys(results.hits)[0]]
@@ -78,11 +78,11 @@ describe('PersistenceInFile', () => {
     await fastify.ready()
 
     {
-      const results = await fastify.orama.search({ term: 'Mateo Nunez' })
+      const results = fastify.orama.search({ term: 'Mateo Nunez' })
       strictEqual(results.count, 0)
     }
 
-    await fastify.orama.insert({
+    fastify.orama.insert({
       quote: 'Orama and Fastify are awesome together.',
       author: 'Mateo Nunez'
     })
@@ -91,7 +91,7 @@ describe('PersistenceInFile', () => {
     strictEqual(path, opts.filePath)
 
     {
-      const results = await fastify.orama.search({ term: 'Mateo Nunez' })
+      const results = fastify.orama.search({ term: 'Mateo Nunez' })
       strictEqual(results.count, 1)
     }
   })
@@ -133,7 +133,7 @@ describe('PersistenceInFile', () => {
 
     await fastify.ready()
 
-    const results = await fastify.orama.search({ term: 'fastify-orama' })
+    const results = fastify.orama.search({ term: 'fastify-orama' })
     strictEqual(results.count, 1)
   })
 })
@@ -149,19 +149,19 @@ describe('PersistenceInMemory', () => {
     await fastifyOne.ready()
 
     {
-      const results = await fastifyOne.orama.search({ term: 'Mateo Nunez' })
+      const results = fastifyOne.orama.search({ term: 'Mateo Nunez' })
       strictEqual(results.count, 0)
     }
 
-    await fastifyOne.orama.insert({
+    fastifyOne.orama.insert({
       quote: 'Orama and Fastify are awesome together.',
       author: 'Mateo Nunez'
     })
 
     const inMemoryDb = await fastifyOne.orama.persist()
 
     {
-      const results = await fastifyOne.orama.search({ term: 'Mateo Nunez' })
+      const results = fastifyOne.orama.search({ term: 'Mateo Nunez' })
       strictEqual(results.count, 1)
     }
 
@@ -177,7 +177,7 @@ describe('PersistenceInMemory', () => {
     await fastifyTwo.ready()
 
     {
-      const results = await fastifyTwo.orama.search({ term: 'Mateo Nunez' })
+      const results = fastifyTwo.orama.search({ term: 'Mateo Nunez' })
       strictEqual(results.count, 1)
     }
   })

test/types/index.test-d.ts

@@ -43,13 +43,13 @@ app.register(fastifyOrama, {
 })
 
 const appWithOrama = app.withOrama<typeof mySchema>()
-const id = await appWithOrama.orama.insert({ quote: 'Hello', author: 'World' })
+const id = appWithOrama.orama.insert({ quote: 'Hello', author: 'World' })
 expectType<string>(id)
 
 appWithOrama.get('/hello', async () => {
 
   const {orama} = appWithOrama
-  const result = await orama.search({ term: 'hello' })
+  const result = orama.search({ term: 'hello' })
 
   expectType<Results<InternalTypedDocument<MySchema>>>(result)
   expectType<string>(result.hits[0].document.author)
@@ -60,17 +60,17 @@ appWithOrama.get('/hello', async () => {
 })
 
 expectType<{
-  insert: (document: PartialSchemaDeep<TypedDocument<Orama<typeof mySchema>>>) => Promise<string>,
-  search: (params: SearchParams<Orama<Schema<typeof mySchema>>, typeof mySchema>) => Promise<Results<Schema<typeof mySchema>>>,
+  insert: (document: PartialSchemaDeep<TypedDocument<Orama<typeof mySchema>>>) => string,
+  search: (params: SearchParams<Orama<Schema<typeof mySchema>>, typeof mySchema>) => Results<Schema<typeof mySchema>>,
   persist?: () => Promise<any>,
 }>(appWithOrama.orama)
 
 fp(function(fastify) {
   const fastifyWithOrama = fastify.withOrama<typeof mySchema>()
 
   expectType<{
-    insert: (document: PartialSchemaDeep<TypedDocument<Orama<typeof mySchema>>>) => Promise<string>,
-    search: (params: SearchParams<Orama<Schema<typeof mySchema>>, typeof mySchema>) => Promise<Results<Schema<typeof mySchema>>>,
+    insert: (document: PartialSchemaDeep<TypedDocument<Orama<typeof mySchema>>>) => string,
+    search: (params: SearchParams<Orama<Schema<typeof mySchema>>, typeof mySchema>) => Results<Schema<typeof mySchema>>,
     persist?: () => Promise<any>,
   }>(fastifyWithOrama.orama)
 })