Describe the bug With the new release of Lyra is not possible to restore an instance from a file.

/home/mateonunez/source/lyra/just/node_modules/.pnpm/@[email protected]/node_modules/@lyrasearch/lyra/dist/cjs/src/lyra.js:403
        if (!(index in lyra.tokenOccurrencies))
                    ^

TypeError: Cannot use 'in' operator to search for 'name' in undefined
    at search (/home/mateonunez/source/lyra/just/node_modules/.pnpm/@[email protected]/node_modules/@lyrasearch/lyra/dist/cjs/src/lyra.js:403:21)
    at Object.<anonymous> (/home/mateonunez/source/lyra/just/just.js:12:18)
    at Module._compile (node:internal/modules/cjs/loader:1159:14)
    at Module._extensions..js (node:internal/modules/cjs/loader:1213:10)
    at Module.load (node:internal/modules/cjs/loader:1037:32)
    at Module._load (node:internal/modules/cjs/loader:878:12)
    at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:81:12)
    at node:internal/main/run_main_module:23:47

Node.js v18.12.1

To Reproduce Steps to reproduce the behavior:

1. Create a new project, add lyra and plugin-data-persistence dependencies.
2. Create a new instance of Lyra and save it to a file.
3. Restore that file.
4. Make a search.

or just copy this code:

const { create, insert, search } = require('@lyrasearch/lyra')
const { persistToFile, restoreFromFile } = require('@lyrasearch/plugin-data-persistence')

const db = create({ schema: { name: 'string', age: 'string' }})
insert(db, { name: 'john doe', age: '27' })
insert(db, { name: 'jenny doe', age: '27' })

const filePath = persistToFile(db, 'json', './db.json');
const results = search(db, { term: 'joh' });
const db2 = restoreFromFile('json', filePath);
const results2 = search(db2, { term: 'jen' });

console.log(results, filePath, results2)

Expected behavior The plugin should restore a Lyra instance from a file.

Desktop:

• Node v18.12.1
• Lyra v0.3.1
• plugin-data-persistence v0.0.3

This PR updates the official documentation link on the README.

As reported on #5 is necessary to update the website voice into the repository details by removing the docs prefix.

DefaultLanguage is not properly restored. As such, when you set the indexer to Arabic and save to disk, searches won't work on restore. Unless you go out of your way and manually change the defaultLanguage prop of the restoredInstance to Arabic. This change is dependent on having the lyra save also change (I will open another pull request for that):

export function save<S extends PropertiesSchema>(lyra: Lyra<S>): Data<S> {
  return {
    index: lyra.index,
    defaultLanguage: lyra.defaultLanguage, <--- this needs to be added.
    docs: lyra.docs,
    nodes: lyra.nodes,
    schema: lyra.schema,
    frequencies: lyra.frequencies,
    tokenOccurrencies: lyra.tokenOccurrencies,
  };
}

This PR adds a new test, bringing the coverage to 98.38% (current is 97.58%).

The test checks that the exception raised when trying to retrieve a database using an unsupported format is correct.

I wanna use this memory persistence feature for my app. But, can't import this plugin into Next.js, always getting below error

./node_modules/@lyrasearch/plugin-data-persistence/dist/node/esm/node-bun/index.js:1:0
Module not found: Can't resolve 'fs'

Hi, I'm not sure that this issue depends on this plugin, but I want to know if there is a way to avoid it so we can track similar issues.

This problem is generated when I've tried to restore a previously saved Lyra instance.

This is the code:

import { create, insert } from '@lyrasearch/lyra'
import { restoreFromFile, persistToFile } from '@lyrasearch/plugin-data-persistence'

const db = create({
  schema: {
    author: 'string',
    quote: 'string'
  }
})

insert(db, {
  author: 'Poseidon',
  quote: 'Sea'
})

persistToFile(db, 'binary', './test.msp')

const db2 = restoreFromFile('binary', './test.msp')

The error is present only with the binary format which uses msgpack. There's another way to avoid it keep using binary formats?

After the merge of https://github.com/LyraSearch/docs/pull/2, it's necessary to update the docs link removing the docs prefix.

From: https://docs.lyrajs.io/docs/plugins/plugin-data-persistence To: https://docs.lyrajs.io/plugins/plugin-data-persistence/

Previously posted in the lyra repo:

From an API perspective, if I was creating a persistence package, I would want the ability to persist on each change to the database. It might be nice if a lyra DB was an event emitter for that reason. I could imagine a disk persistence package working like:

const persist = (db, format) => {
  saveToDisk(db, format);

  db.addEventListener('change', () => {
    saveToDisk(db, format);
  });
};

That way a user would only need to call persist once and not manage calling it every time they inserted, removed, etc.

As for now, the plugin runs on Node.js, but it will need to run on any browser/runtime. We should probably create different builds for different runtimes and environments to support a broader range of possibilities.

Things to know:

• dpack is a strategic dependency and it's supported in browsers, Node.js and Bun. We need to bundle it in some way to make the support available in Deno