{"id":23644436,"url":"https://github.com/allnulled/browsie","last_synced_at":"2025-07-24T11:33:22.638Z","repository":{"id":269605606,"uuid":"907964728","full_name":"allnulled/browsie","owner":"allnulled","description":"IndexedDB wrapper.","archived":false,"fork":false,"pushed_at":"2025-01-27T06:25:01.000Z","size":45,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-19T16:14:53.700Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://npmjs.com/@allnulled/browsie","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/allnulled.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-12-24T18:11:41.000Z","updated_at":"2025-01-27T06:25:04.000Z","dependencies_parsed_at":"2024-12-24T19:31:53.391Z","dependency_job_id":"55f32087-d6c1-450f-a3c9-7160024632fd","html_url":"https://github.com/allnulled/browsie","commit_stats":null,"previous_names":["allnulled/browsie"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/allnulled/browsie","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allnulled%2Fbrowsie","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allnulled%2Fbrowsie/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allnulled%2Fbrowsie/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allnulled%2Fbrowsie/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/allnulled","download_url":"https://codeload.github.com/allnulled/browsie/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allnulled%2Fbrowsie/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266834381,"owners_count":23992168,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-24T02:00:09.469Z","response_time":99,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-28T12:20:07.921Z","updated_at":"2025-07-24T11:33:22.560Z","avatar_url":"https://github.com/allnulled.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# browsie\n\nIndexedDB wrapper.\n\n## Installation\n\nDownload from console:\n\n```sh\nnpm i -s @allnulled/browsie\n```\n\nImport from code:\n\n```html\n\u003cscript src=\"node_modules/@allnulled/browsie/browsie.bundled.js\"\u003e\u003c/script\u003e\n```\n\nThe global `window.Browsie` should now be available.\n\n## API\n\n```js\nawait Browsie.listDatabases()\nawait Browsie.deleteDatabase(dbName)\nawait Browsie.createDatabase(dbName, storeDefinition, version = 1, versionUpgrades = [])\nawait Browsie.getSchema(dbName)\nawait Browsie.globMatch(patterns, texts)\nbrowsie = new Browsie(dbName)\nawait browsie.open()\nawait browsie.select(store, filter)\nawait browsie.insert(store, item)\nawait browsie.update(store, id, item)\nawait browsie.delete(store, id)\nawait browsie.insertMany(store, items)\nawait browsie.updateMany(store, filter, item)\nawait browsie.deleteMany(store, filter)\nawait browsie.triggers.register(eventId, triggerId, callback, options)\nawait browsie.triggers.emit(eventId, parameters)\nawait browsie.triggers.unregister(triggerId)\nawait browsie.triggers.load(triggersScript) // For this method, the library occupies like x20 times hahahaha maybe more HAHAHAHAHAH!\n```\n\nOn `storeDefinitions:object` we want an object like:\n\n```js\n{\n  articulos: [\"!nombre\", \"categorias\", \"resumen\", \"fecha\", \"autor\", \"inspiracion\", \"tags\"],\n  productos: [\"!nombre\", \"!modeloId\", \"categorias\", \"descripcion\"]\n}\n```\n\nHere, the `!` is to declare `unique` indexes.\n\nOn `version:integer` we want the current version of the database. This must be updated when a `versionUpgrades` is added.\n\nOn `versionUpgrades:object` we want an object like this:\n\n```js\n{\n  2: function(db) {\n    if (!db.objectStoreNames.contains(\"orders\")) {\n      const ordersStore = db.createObjectStore(\"orders\", {\n        keyPath: \"id\",\n        autoIncrement: true,\n      });\n      ordersStore.createIndex(\"orderDate\", \"orderDate\", { unique: false });\n      ordersStore.createIndex(\"userId\", \"userId\", { unique: false });\n    }\n  }\n}\n```\n\nHere, every version should have its own function.\n\nOn `eventId:string`, triggers section, we want:\n\n  - On `browsie.triggers.register(eventId, ...)`: a selector of events that accepts `*` as magic character.\n  - On `browsie.triggers.emit(eventId, ...)`: the name of the event, that does NOT accept `*` as magic character.\n\nOn `triggersScript:string` we want a [`@allnulled/triggers-script`](https://github.com/allnulled/triggers-script) script as string.\n\n## Example\n\nThis is the test that is ensuring the API right now. There are 3 tests in 1 function: `Data_api`, `Schema_api` and `Triggers_api`.\n\n```js\n(async function main() {\n  try {\n    Data_api: {\n      await Browsie.deleteDatabase(\"browsie_test_data\");\n      await Browsie.createDatabase(\"browsie_test_data\", {\n        articulos: [\"!nombre\", \"categorias\", \"resumen\", \"fecha\", \"autor\", \"inspiracion\", \"tags\"],\n        productos: [\"!nombre\", \"!modeloId\", \"categorias\", \"descripcion\"]\n      }, 2, {\n        2: function(db) {\n          if (!db.objectStoreNames.contains(\"orders\")) {\n            const ordersStore = db.createObjectStore(\"orders\", {\n              keyPath: \"id\",\n              autoIncrement: true,\n            });\n            ordersStore.createIndex(\"orderDate\", \"orderDate\", { unique: false });\n            ordersStore.createIndex(\"userId\", \"userId\", { unique: false });\n          }\n        }\n      });\n      const db = new Browsie(\"browsie_test_data\");\n      await db.open();\n      const id1 = await db.insert(\"articulos\", { nombre: \"Artículo 1\" });\n      const id2 = await db.insert(\"articulos\", { nombre: \"Artículo 2\" });\n      const id3 = await db.insert(\"articulos\", { nombre: \"Artículo 3\" });\n      const selection1 = await db.select(\"articulos\", i =\u003e i);\n      if (selection1.length !== 3) {\n        throw new Error(\"Test falló en aserción 1\");\n      }\n      await db.update(\"articulos\", id1, { nombre: \"Artículo cambiado 1\" });\n      await db.update(\"articulos\", id2, { nombre: \"Artículo cambiado 2\" });\n      await db.update(\"articulos\", id3, { nombre: \"Artículo cambiado 3\" });\n      const selection2 = await db.select(\"articulos\", i =\u003e i);\n      if (selection2.length !== 3) {\n        throw new Error(\"Test falló en aserción 2\");\n      }\n      if (selection2[0].nombre !== \"Artículo cambiado 1\") {\n        throw new Error(\"Test falló en aserción 3\");\n      }\n      await db.delete(\"articulos\", id3);\n      await db.delete(\"articulos\", id2);\n      await db.delete(\"articulos\", id1);\n      const selection3 = await db.select(\"articulos\", i =\u003e i);\n      if (selection3.length !== 0) {\n        throw new Error(\"Test falló en aserción 4\");\n      }\n      await db.insertMany(\"articulos\", [{\n        nombre: \"Papaguata1\",\n        categorias: \"Papaguata, tocolombo, meketino, paquetumba, nonomuni\",\n        resumen: \"wherever\",\n      }, {\n        nombre: \"Papaguata2\",\n        categorias: \"Papaguata, tocolombo, meketino, paquetumba, nonomuni\",\n        resumen: \"wherever\",\n      }, {\n        nombre: \"Papaguata3\",\n        categorias: \"Papaguata, tocolombo, meketino, paquetumba, nonomuni\",\n        resumen: \"wherever\",\n      }]);\n      const selection4 = await db.select(\"articulos\", i =\u003e i);\n      if (selection4.length !== 3) {\n        throw new Error(\"Test falló en aserción 5\");\n      }\n      await db.close();\n    }\n    document.querySelector(\"#test\").textContent += \"\\n[✔] Browsie Data API Tests passed successfully.\";\n    Schema_api: {\n      // let schema = await Browsie.getSchema(\"browsie_test\"); console.log(schema);\n      await Browsie.deleteDatabase(\"browsie_test_schema\");\n      // console.log(\"Create database..\");\n      await Browsie.createDatabase(\"browsie_test_schema\", {\n        tabla1: [\"!uuid\", \"columna1\", \"columna2\", \"columna3\"],\n        tabla2: [\"!uuid\", \"columna1\", \"columna2\", \"columna3\"],\n        tabla3: [\"!uuid\", \"columna1\", \"columna2\", \"columna3\"],\n        tabla4: [\"!uuid\", \"columna1\", \"columna2\", \"columna3\"],\n      });\n      const db = await Browsie.open(\"browsie_test_schema\");\n      await db.insert(\"tabla1\", { uuid: \"1\", columna1: \"a\", columna2: \"b\", columna3: \"c\" });\n      await db.insert(\"tabla2\", { uuid: \"2\", columna1: \"a\", columna2: \"b\", columna3: \"c\" });\n      await db.insert(\"tabla3\", { uuid: \"3\", columna1: \"a\", columna2: \"b\", columna3: \"c\" });\n      await db.insert(\"tabla4\", { uuid: \"4\", columna1: \"a\", columna2: \"b\", columna3: \"c\" });\n      schema = await Browsie.getSchema(\"browsie_test_schema\");\n      console.log(schema);\n      await db.close();\n    }\n    // await Browsie.deleteDatabase(\"browsie_test_data\");\n    // await Browsie.deleteDatabase(\"browsie_test_schema\");\n    document.querySelector(\"#test\").textContent += \"\\n[✔] Browsie Schema API Tests passed successfully.\";\n    Triggers_api: {\n      console.log(await Browsie.globMatch([\n        \"crud.insert.*.users\",\n        \"crud.*.many.users\"\n      ], [\n        \"crud.select.one.users\",\n        \"crud.select.many.users\",\n        \"crud.insert.one.users\",\n        \"crud.insert.many.users\",\n        \"crud.update.one.users\",\n        \"crud.update.many.users\",\n        \"crud.delete.one.users\",\n        \"crud.delete.many.users\",\n      ]));\n      const db = await Browsie.open(\"browsie_test_schema\");\n      let counter = 0;\n      await db.triggers.register(\"crud.insert.one.tabla1\", \"temp1\", function() {\n        console.log(\"triggering temp1\");\n        counter -= 2;\n      }, {\n        priority: 20\n      });\n      await db.triggers.register(\"crud.insert.one.tabla1\", \"temp2\", function() {\n        console.log(\"triggering temp2\");\n        counter *= 10;\n      }, {\n        priority: 10\n      });\n      await db.triggers.register(\"crud.insert.one.tabla1\", \"temp3\", function() {\n        console.log(\"triggering temp3\");\n        counter += 5;\n      }, {\n        priority: 30\n      });\n      await db.insert(\"tabla1\", { uuid: \"5\", columna1: \"a\", columna2: \"b\", columna3: \"c\" });\n      schema = await Browsie.getSchema(\"browsie_test_schema\");\n      console.log(schema);\n      console.log(db);\n      setTimeout(() =\u003e {\n        console.log(counter);\n        if(counter !== 30) {\n          console.error(\"Failed calculus\");\n        } else {\n          console.log(\"Triggers are working fine\");\n        }\n      }, 1000);\n      await db.close();\n    }\n    document.querySelector(\"#test\").textContent += \"\\n[✔] Browsie Triggers API Tests passed successfully.\";\n  } catch (error) {\n    console.log(error);\n  }\n})();\n```\n\nYou can run it using `npm test`.\n\n## The versionation\n\nThis was a stopper when developing, and I want to clarify it.\n\n\u003e The method of versionation IndexedDB uses is a very correct one, in which we print the mutations of the database schema. This creates the ADN along time of the database schema. So it is a good pattern. Despite it can seem annoying at first sight.\n\nThis library implements, via parameters of the `createDatabase` method:\n\n  - `storeDefinition`: a declarative way of defining the first schema shape.\n  - `versionUpgrades`: an imperative way of defining the next database schema modifications.\n  - `version`: current version.\n\nSo.\n\nWhen you want to upgrade a version, to apply a schema mutation, you **append a hardcoded function** into the **versionUpgrades** parameter of the *browsie instance* constructor call.\n\nFinally, to apply the version upgrade, **increase the version** parameter of the same call.\n\nApplying these 2 changes into your code, the database can migrate by itself, and track the ADN, to **keep compatibility** with previous schemas that users can have in their own browsers.\n\nSo it is a good pattern. And we have close it the best way possible no, but close enough.\n\n## The triggerization\n\nWe are using [@allnulled/triggers-api](https://github.com/allnulled/triggers-api) to cover the topic.\n\nThis allows you to use **triggers pattern** in multiple places, for multiple purposes or APIs.\n\nIt is up to you. On `TriggersApi` global, you can find.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fallnulled%2Fbrowsie","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fallnulled%2Fbrowsie","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fallnulled%2Fbrowsie/lists"}