{"_id":"@allnulled/browsie","_rev":"4-e7162566913e176c2f4c1dd7f9f8a405","name":"@allnulled/browsie","dist-tags":{"latest":"1.0.4"},"versions":{"1.0.0":{"name":"@allnulled/browsie","version":"1.0.0","keywords":[],"author":{"name":"allnulled"},"license":"WTFPL","_id":"@allnulled/browsie@1.0.0","maintainers":[{"name":"allnulled","email":"todosanulados@gmail.com"}],"dist":{"shasum":"a16e22a6b0ed52d1b0524491d2c2f8e8d257539b","tarball":"https://registry.npmjs.org/@allnulled/browsie/-/browsie-1.0.0.tgz","fileCount":5,"integrity":"sha512-7MUQA+3ltdoAoBfzc6Yl7mKoTgNQC8Z7tQO6zo1ulpFy2lqNY23WTWnEatawMIa52OsJDxIzLYe26ur4DWm1bw==","signatures":[{"sig":"MEQCIEyDHR44mlVZOeqciI3jiYGzH9PFbjVplvETRi75bnf1AiAaov0xaDRegHmvCc+gwv52qIula9s727bVHSwa2mfwFw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":13430},"main":"browsie.js","gitHead":"e435b9cefa1d1d263f8d7dfa7936f879134ecc03","scripts":{"test":"npx http-server -c-1 . -o test.html"},"_npmUser":{"name":"allnulled","email":"todosanulados@gmail.com"},"_npmVersion":"9.6.7","description":"IndexedDB wrapper.","directories":{},"_nodeVersion":"18.17.1","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/browsie_1.0.0_1735064778852_0.559550141090456","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"@allnulled/browsie","version":"1.0.1","keywords":[],"author":{"name":"allnulled"},"license":"WTFPL","_id":"@allnulled/browsie@1.0.1","maintainers":[{"name":"allnulled","email":"todosanulados@gmail.com"}],"dist":{"shasum":"1fbf9ba6b6dc1e2ca3ac597bafca790eceb70de2","tarball":"https://registry.npmjs.org/@allnulled/browsie/-/browsie-1.0.1.tgz","fileCount":5,"integrity":"sha512-pDv0nHIcsFOnfP5Tl1I94ILRp1liGhHid4qMGfwwaq/qBiadH3iA/KeFud868qHaBobsj9EvYHjCdMRtJndQng==","signatures":[{"sig":"MEUCIGHLCrfxvnNhXumt3uhBIJLW6FQjyyydqQLhu5+oFO4gAiEA2Xhn9x0T+AsoO4zlAi1hG/Xn8ntzDzGpeiApR+L8UuA=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":22252},"main":"browsie.js","gitHead":"fd5e69305468710cece5528e0af3d8bda4e1babc","scripts":{"test":"npx http-server -c-1 . -o test.html"},"_npmUser":{"name":"allnulled","email":"todosanulados@gmail.com"},"_npmVersion":"9.6.7","description":"IndexedDB wrapper.","directories":{},"_nodeVersion":"18.17.1","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/browsie_1.0.1_1735076111414_0.6389527892408773","host":"s3://npm-registry-packages-npm-production"}},"1.0.2":{"name":"@allnulled/browsie","version":"1.0.2","keywords":[],"author":{"name":"allnulled"},"license":"WTFPL","_id":"@allnulled/browsie@1.0.2","maintainers":[{"name":"allnulled","email":"todosanulados@gmail.com"}],"dist":{"shasum":"ed4b15e81802bb52cf2becf36955522e6f2d776c","tarball":"https://registry.npmjs.org/@allnulled/browsie/-/browsie-1.0.2.tgz","fileCount":5,"integrity":"sha512-IDdW9hGnRJWfdUys63r0vJhLcngRudlX2ktsKczLNbdEnGy+UJxPm2K3eE0j97kpDs/bbAxl0d4D2fr66U/7BA==","signatures":[{"sig":"MEUCIQCd/FwLcMhyr1uuLETHJmDuoYTOBhVxqb1q6niqZgb6WgIgYyQg/xyr9ZJn9vS3dTiKqBHNV3fWxVBTmkEbjfZOdIo=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":22259},"main":"browsie.js","gitHead":"85de7f8573487024563bcf3ce0b06bb7b9465744","scripts":{"test":"npx http-server -c-1 . -o test.html"},"_npmUser":{"name":"allnulled","email":"todosanulados@gmail.com"},"_npmVersion":"9.6.7","description":"IndexedDB wrapper.","directories":{},"_nodeVersion":"18.17.1","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/browsie_1.0.2_1735076884608_0.19016371308469582","host":"s3://npm-registry-packages-npm-production"}},"1.0.3":{"name":"@allnulled/browsie","version":"1.0.3","keywords":[],"author":{"name":"allnulled"},"license":"WTFPL","_id":"@allnulled/browsie@1.0.3","maintainers":[{"name":"allnulled","email":"todosanulados@gmail.com"}],"dist":{"shasum":"a7f88ea9dc248d0f4d168a0a7352ba2009b7194b","tarball":"https://registry.npmjs.org/@allnulled/browsie/-/browsie-1.0.3.tgz","fileCount":8,"integrity":"sha512-wAq3LPUGI8crfjV3oJ26ChLCVuq3gLoGD+Lz+D3gHdXOlswL11wZF9AiPa+Lr9CfvaXAs5FpKNhzKusebmv/Tw==","signatures":[{"sig":"MEUCIARsxhoy5HL4VHrw9prxi+jsz+P3C2H+61n+ljpXokekAiEAnWMKojsXHSKfBIABxFxrtL0sv+ISOmQuflxAoXNMSHg=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":183601},"main":"browsie.bundled.js","gitHead":"06dbcaf0bd84e27862fd1827bccac9f4243a88b9","scripts":{"test":"npx http-server -c-1 . -o test.html","build":"npx htmlbundler --list bundlelist.js --module none --id none --wrap false --output browsie.bundled.js"},"_npmUser":{"name":"allnulled","email":"todosanulados@gmail.com"},"_npmVersion":"9.6.7","description":"IndexedDB wrapper.","directories":{},"_nodeVersion":"18.17.1","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/browsie_1.0.3_1737568046501_0.4140750251204035","host":"s3://npm-registry-packages-npm-production"}},"1.0.4":{"name":"@allnulled/browsie","version":"1.0.4","description":"IndexedDB wrapper.","main":"browsie.bundled.js","scripts":{"build":"npx htmlbundler --list bundlelist.js --module none --id none --wrap false --output browsie.bundled.js","test":"npx http-server -c-1 . -o test.html"},"keywords":[],"author":{"name":"allnulled"},"license":"WTFPL","gitHead":"dd57437e2f8f0704cba235086944e8dcceef9914","_id":"@allnulled/browsie@1.0.4","_nodeVersion":"18.17.1","_npmVersion":"9.6.7","dist":{"integrity":"sha512-d3H22V7NHfROLBfAJpyUlSWr6e0odO3OUKTm2CyVXCCzfwKrw/B03/HcnA9zZASA/4ZC6zc6DHC0bCLVWZ5Wuw==","shasum":"2b352e72656aed4943d05047a7a2bdedf911f538","tarball":"https://registry.npmjs.org/@allnulled/browsie/-/browsie-1.0.4.tgz","fileCount":8,"unpackedSize":184876,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIG1WYf4WnCHz3bASPjy22e2tUOqjfDgPKSf47ijk4pltAiEAi7jPKBYUtfDLaSw+2pNZBgePZlv+6Kwe7ddqPsYeLyE="}]},"_npmUser":{"name":"allnulled","email":"todosanulados@gmail.com"},"directories":{},"maintainers":[{"name":"allnulled","email":"todosanulados@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/browsie_1.0.4_1737573569771_0.04338180905665179"},"_hasShrinkwrap":false}},"time":{"created":"2024-12-24T18:26:18.774Z","modified":"2025-01-22T19:19:30.165Z","1.0.0":"2024-12-24T18:26:19.060Z","1.0.1":"2024-12-24T21:35:11.597Z","1.0.2":"2024-12-24T21:48:04.806Z","1.0.3":"2025-01-22T17:47:26.718Z","1.0.4":"2025-01-22T19:19:29.978Z"},"author":{"name":"allnulled"},"license":"WTFPL","keywords":[],"description":"IndexedDB wrapper.","maintainers":[{"name":"allnulled","email":"todosanulados@gmail.com"}],"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<script src=\"node_modules/@allnulled/browsie/browsie.bundled.js\"></script>\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 => 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 => 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 => 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 => 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(() => {\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> 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.","readmeFilename":"README.md"}