{"_id":"piral-pwa","_rev":"821-b64df792d2c79dd0c3916cdbfb29c7e5","name":"piral-pwa","dist-tags":{"canary":"0.15.0-alpha.4409","next":"0.15.13-beta.5591","latest":"0.15.13"},"versions":{"0.9.0-pre.739":{"name":"piral-pwa","version":"0.9.0-pre.739","keywords":["piral","pilet-api","smapiot","portal","modules","api","extension","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.0-pre.739","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"df681b6f1497bb56dfc8a7cc5819606eb6ece1d6","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.0-pre.739.tgz","fileCount":20,"integrity":"sha512-XplNSQLee6TghSH2oFzAQKU3qshgd8xcIlLxPT4zgmz88+yX73cRlAV8VBL4jxuM/OgZhvm5fL+CAQOLq2wHVA==","signatures":[{"sig":"MEQCIBhsiIXdIX8fZBZ+4cX1egVkVtmQOTAcIvZCs8QC0v4qAiA8ZZbn2zSvgV/O+32fgzfggCok4Vdtt28zQhcA49df1w==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":7027,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdyf0DCRA9TVsSAnZWagAAiaMP/1wp/xaeWG/BJA8PFJ5j\nHfGxjOt1A2cNSQPCUQw0Qn11MRPsBPxH9C9WlWjm/KGUHoYsc9+toGykHcJY\n2ryZ9hTh0tfGC9aecUjIjGOgQ1N6s8BSx4hoI7FimTei+gUGZN555ssuJbRn\nVJ/ohfRXr+oHjq6UYw75JkalmrzgesbPinTxBdQSvXpUkPpmoxehcOOCKMlG\nkol81onA+5i9w+5oWjay2iQujPObYAaTB9gN7DYIrjY/SFpm8czpUuPDzIbJ\nHMeedQH68TH/f4CRqvLi9qSIi/TDFOTKqctcZ5Xznys4xmb1BBvzsd0rj4lY\nB2fNdx7Ysrb9NjQUGGEglgLCSFvGKDUymsxBCH40iDIWn2U2OBR2zL+HuOnG\nagxT9BFUil5QlSSF0NzIsHshLoiuHyW8loptglyp9bpwRtFbvSPCiUmMlO2S\n6Mr3V1kpfRYjtkxxib27gISBrw6KjmlARAw/wny9CK9c1ZA/2uXR8f109d/o\nK1A8Srb48JMUzsQz4h5ZLioQcWQq7TMcUkVGpPH2QB8kjAYz4AN/QYAfZc9q\nFFRM0rGQTlxDOKU4xovIkvDUhqC0/NkVo74SDPmeF9gX1rEvTSOXy3YaGojJ\npwqEKKdrDLjKx7IUctAjLIWLT3zaDu8EZhsdbAK5UGR7h0j2ZMX5CAOUIp6M\nxGfx\r\n=PiFI\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"92414f91e86075e1bddcfcb3f838a61fee60888e","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.16.4/node@v12.13.0+x64 (linux)","description":"Extensions for creating a PWA shell.","directories":{},"_nodeVersion":"12.13.0","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.9.0-pre.739"},"peerDependencies":{"piral-core":"^0.8.0 || ^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.0-pre.739_1573518594805_0.7028361332898985","host":"s3://npm-registry-packages"}},"0.9.0-pre.741":{"name":"piral-pwa","version":"0.9.0-pre.741","keywords":["piral","pilet-api","smapiot","portal","modules","api","extension","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.0-pre.741","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"a7e48ef8dbcd59c3fca5c465ad8cdffcd925a89b","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.0-pre.741.tgz","fileCount":20,"integrity":"sha512-BzGotsnhGcVqecmx9YC/+fK3Qs0I4EoklnPr1moNqJTQVJRmRl79J/WD7z00Zxv2Mxg3+Nkc+LkeA2hPxXR09w==","signatures":[{"sig":"MEQCIHh/h/nYB9yqupMi1Jo8cr/ylQLNP/5kifGAD6SYYCb2AiBAJWENXkv8QjFDXS10YvzPp7BqcUeYraIIyajkkcS45A==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":8070,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdzBNYCRA9TVsSAnZWagAA+50P/2BYdgxPcnSFwsa9T642\nNX71QB3GDeaRWnUfLmdrdeJfJ0jKrgJMnSt2RC8L/ztfyqF9b846z9ynJ8tr\nsWHknfLXwFbPwjtw/PDIsMrk2FLAyXV5HrzxzKmXh5fQjgZ4yUvVC+k8vUWw\n6GCmiGvi1pyB+VD4Qs16ndp19WpCTkJ8rFUyUVKIohh/pFVeSd+0rR+PjRZZ\nLSPUmUk5CU9b0usC18eggFI+hx1qVoj96mTXLB7DZMcgxjc04vHSDr7GwBY+\nnT8SIBsOx9JatQzEMB5WX0DGpP2DL8zJ1ACYGswTsH4SdtmZ2YnCn3guqt6C\nclywcmm/sXAgcMum25+Zf76ZWG4Ip20G/bLUaEaaSu5uP88JB7NtAY3/Jft3\nco1K+YUq/HHFVwl1gL5+sr4yn18r6WpFUgJubAKqqO8xFJWIYbiHRUuhJUmH\nl2tQywscV8g8b/PiP3smJLxF2LImKyo1tZtJp0BdWJEm2vJqRBtv6O/K5wJ1\n+0sHSeYaz61R6lzVMwlg9TULvUQOpiSUlXY66bwTg+xrtnmrz3iP43xxmguF\nyTOPw57EJ6f1IvDHuUPsdckYNKkohGCYweiJJhFDIOZ4w7kf2t8IO/b3mBqN\nSfOneYakiyh3ApAnl+Q71vqO8uPofwfxZHdzkmeGGdLLcERyETaFaDhSulwQ\n7vuw\r\n=954i\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is an extension library that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n(tbd)\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```tsx\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```tsx\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"37356202d903fbbae177da4449f2daa4cd6880d0","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.16.4/node@v12.13.0+x64 (linux)","description":"Extensions for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.9.0-pre.741"},"peerDependencies":{"piral-core":"^0.8.0 || ^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.0-pre.741_1573655383660_0.14114509072040193","host":"s3://npm-registry-packages"}},"0.9.0-pre.742":{"name":"piral-pwa","version":"0.9.0-pre.742","keywords":["piral","pilet-api","smapiot","portal","modules","api","extension","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.0-pre.742","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"4ba1a65fc4735461e43ab768bbf884476b25f4cd","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.0-pre.742.tgz","fileCount":20,"integrity":"sha512-dUSDqr2aEle51GcQn99krGx5P4BgX0nxi6efkD2i55kbmzsuiA8GQq25ndUz1E5HWX8Z45q39O7hdBa2HWY85Q==","signatures":[{"sig":"MEYCIQCRIkE6hwRi9jV6P5OPIoNWyX57/Y/jMh9udBAbd0a7wwIhAOGePxMOQne0Crkf6+wSBgMRYMcqeEocp2sIYJDnuZaj","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":8070,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdzqJZCRA9TVsSAnZWagAA8lwP/jwgUAeKBtQ6MOap+fEP\nqSWU55VzWAaXhBFSjAG1OiPkkk7fbSMVwOyaCswct9knnq3iU+9acfEK3gXz\nUTcuvuEtYKNs32FBs0Zbefu2aH/uWUv3Aho1DVwAET7rt0T0iYtcd2ZcxN3v\nIYUKlWTSCiYcZayE/U86LPT1iUCQfh5BExRddXyJ7BoXLTYRGjBT/i6ola5k\nyXxzI+rb7sK5h63MyAz1DJTbxd0lEOvwrC+grLlKnCUTazj5gN39IUiqkAFD\nEc/2PriTevepljodSxgptIZW4HwjvbsdNi6E1haau8eKJeCr5qwWD+Mv9pop\nyVRvK88O76Qh8y26Z+rtqgoWUG9vTK0zwfg0EDTKZMETClU73mjKDQzASoB3\nuT0ku0EDShxRbj45Szjtooafiq+zUutqax/tyGgIHk+trF3ne8HccpWvThGc\nOqqYVDF6d9lKD6+F3G+t5x0mmw0DZU1famXkI085al+EILyD1CUZtzZuvcuB\nyIPNligp3RFPr/rWX3YHPj0vkjoBx+B3lhuuU/r6etqgeEaDIZZ0RJaQB0UG\nnt2Ytu9LgRi0T1cMKBcjSx3wpngLZJI/zGuuh2QpTjqoTr+2XbUY4SwTja4N\neEyMkdF1V3Z82PFASDNilmm5/O1qw89cR1shuWy+pSiW7kSYHkO3JfaYMy+m\nJxud\r\n=CYjj\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is an extension library that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n(tbd)\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```tsx\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```tsx\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"c3b05a857317462e238b03ff553952b24b0c17c6","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.16.4/node@v12.13.0+x64 (linux)","description":"Extensions for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.9.0-pre.742"},"peerDependencies":{"piral-core":"^0.8.0 || ^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.0-pre.742_1573823065034_0.005481617782093107","host":"s3://npm-registry-packages"}},"0.9.0-pre.746":{"name":"piral-pwa","version":"0.9.0-pre.746","keywords":["piral","pilet-api","smapiot","portal","modules","api","extension","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.0-pre.746","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"e5cd5439f7d37d2283f45da0b6499d4ea0f1f205","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.0-pre.746.tgz","fileCount":20,"integrity":"sha512-5iT1tHO5VgVUTIrlex2ys1IsSQtlrhCe/RP0IIsNtSp6luQJkKDCEo2ruFFpehGJXN+uHctxSOqfMh7TFUxPig==","signatures":[{"sig":"MEUCIFtIDR4U0C/Lss4Wj94I7xWjUQtXmv/tSRr733IcoDyOAiEA+xNiknDWbeqPZ6dB7JWQvHPXcnVEWWjBQxAbX/9zXSs=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":8070,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd0K2FCRA9TVsSAnZWagAAJQMP/i5CwKf3Ya/+hDtTOlpd\n2/Yzl93IXf7tT2lsGkmtPhUKgehbX+axJ8K1zQ6T9/zergEEmNOUOtn3+LvZ\nnwVQlKlggS8BJ1ixmrGKDi1FzLUIuSFzKc3QHPZhEkjak1X8YPhJAIsMKrgA\nXJAsJQ8b8vHb6FtkTA8vX6+fNz3AMF3W81sqkbIaKU8+g4bM8x+0ML5S8oKs\nWlLZHn5W3SqVM8J+SfoKmVEBybPkusq8JcP8dLlEf2td6sr7iL8uIbivSvW8\nc2ujawHAc1ob2nsnviooHKeZl5Dme2IlvypwmZKdqZysgj3LJGrsDrxDz664\np4CD854asvGTt61oAkfADFZeYtLlsmT6J3/D1Oqiot7RddhfTd/0kmR9IHj6\n6hDDIqKgAYsD7A5dL4oyNmJUmVPijxbKwu0w5AMyitNbvWnCYnsAdoA4IDUJ\nZO5HGn5uF1oPhLG9ECj1jswOAoXeudk6oSWmUWd7NmcVjsDp365LG5Z/35uq\nGbMqFUx+33EKbI/0xivFErMJlEVfi3zMUMuGZa+uGTtCsIuIwPmaNR4z+LHc\nSFHby+1UhUNrNbdnvAfaZP05pHwo6F95VSHMgCWzSj6jjAZHjLyuZGiJUYhr\nCmHxlsP2NpqsQY94ri0DBIL1nmdl/B/Tz9EidC4AaaUV7YdTG5Hci8Im8bRt\nlOoI\r\n=12kt\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is an extension library that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n(tbd)\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```tsx\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```tsx\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"d79bf9b30d1f80473bbd6cb8225cbb1156ecb7d7","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.16.4/node@v12.13.0+x64 (linux)","description":"Extensions for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.9.0-pre.746"},"peerDependencies":{"piral-core":"^0.8.0 || ^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.0-pre.746_1573956997288_0.44837593333768355","host":"s3://npm-registry-packages"}},"0.9.0-pre.751":{"name":"piral-pwa","version":"0.9.0-pre.751","keywords":["piral","pilet-api","smapiot","portal","modules","api","extension","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.0-pre.751","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"19cfb9475135ab01b9cf5250ffaf603c651f2838","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.0-pre.751.tgz","fileCount":20,"integrity":"sha512-KEkE3uWwvSb+yvspbC7Fy7+SdV7PyKFlZ7XA8hYEcfexCQz1SORPgf6yh735KjfyYKhurIIASJWfuawUo8yuMw==","signatures":[{"sig":"MEYCIQCGyWzynu4/25xz+cNQ4e2wnZ6BifqFMnyUZ4Iie/kZtwIhAOkQ235hLBlB/JxtDzeXmfHCYQ9id+4FhMSwngaiRl/S","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":8070,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd27QxCRA9TVsSAnZWagAAOm0P/iXJnom2C0NeSRo1DL0N\nAPk/th2yhs3JmCGT1BUZvmhkzGqlM0uTUZKgRA1QiT4g1Yg+Ch0fYQsbBVnG\nlbied6k2/3I/K78jeDh0w+CZE168fbBlpZcSTS7gaSWt596jW48uGOg4uvOs\nAYfrnTqGlM9Vy+FJZwyjtxfm4M3jyPqCRhBgO2xQFLmg4FOz55Oh6Qqno+NU\nfwZk3TwhdAOlnSrluqu9E1ooY8Q/2fS8w6GPuErTKygHN/R1XByusBNwz+l3\nVmZeRDQrrkGAH2gvBFfYnn96AMii0xr67gofg5Wf48c87xkN7ykMWRX1ZQjd\nddHgYd+3TTBAf4r5TyVBGb+z1oZPqPswq1XG2R1CJ75f0Zv8r5BW8MrSOV4S\nIL438HQVZW9e/dy0HDKmp2w66tEpWXXlDacvDqy2b848ISUKJwn9cDA+HAPP\n+QUUzC9k3PBCkpn7oT9ns6KX9xxLO99CeHY3anZIBrXsFSWuL8eI8R9gVyoS\ncaKZCkavVvYbFyZQwklv49DOjrhygcXCzG/TgpuQvAAxDyB+1Ekebsb4FcXh\nmlJyK4CqyyB0p49/cccu+hzy4bzRIK0NrrLgLYbJpq7zlVmf/N+k/un4Tgz9\nOoU/jgorkUY6fLeidE9bZakTlikySviR4RKqHcjYpYEyjt9yNhqMlaJK7cSz\nVuRI\r\n=PfeL\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is an extension library that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n(tbd)\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```tsx\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```tsx\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"461d07d5b5d1f7a3d9512b933f065ea100762889","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.16.4/node@v12.13.0+x64 (linux)","description":"Extensions for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.9.0-pre.751"},"peerDependencies":{"piral-core":"^0.8.0 || ^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.0-pre.751_1574679600921_0.7593606809430375","host":"s3://npm-registry-packages"}},"0.9.0-pre.754":{"name":"piral-pwa","version":"0.9.0-pre.754","keywords":["piral","pilet-api","smapiot","portal","modules","api","extension","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.0-pre.754","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"418875da2dea6947076a5609a3066300116ca783","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.0-pre.754.tgz","fileCount":20,"integrity":"sha512-8nQ8lO+t0tLOZa+x0LsUAaGWmsol3zv4SH66sRiU3qpdFxHtfqa3r982gEaeD2J64pmneKN8M6/AUHC6cmu6YQ==","signatures":[{"sig":"MEYCIQCuzMoY0ptXoHVVifrcfvwmP6jt5Zf4xZOHA2zo1k3qTAIhAMJkznAgBqMq3tYmdVeMt875Go2c1UpQVtCLuub9Jnxo","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":8070,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd3M2uCRA9TVsSAnZWagAALPgP/RVkswL2gM9+S/otcAYj\nisvhGiNaIX6zrGuVsjkeIItVJkSer+CjbgKT8hsHjAaM+6AlWgRAep6OjqzN\nCRah6LxCDG5iBuw5wprMX21c5FRHx6ka5VLk1en8+wzX9mA3C/DCyiXwFwbQ\n9t43Vntc/3bqj08aCAS466Ne54kOAq+L2MNgv74TseywKRb19CHDV9IxE/g6\nNRjX+R2fPvjpAujtlcjHVvl4G4gAl3Bv/Gvi257rQPJfGE67uqe9hFl7vCvr\nH9xTgr+TD5X6Sy5Ogo9s0gFqIVKP9oWZ7kSVtxGB+5146CfZS5TmSs1jKqBW\nbRc8p6qbrb5/4nZggauWPxXeI7GyXnnPDw6HjVDFwalbwabhbJXoTACK3xBO\nRFnUWsrpSxC0ltfbW7pWnnbfJ8aDSCyc9okh/2EkYYgJpwW1LRPAXfMLMpYs\n+Uuz2b9GUiRfPEoSmNenxShbxvt6HknZiGPocHDB0KKPqJmbUXued6mR+JAQ\nDPf1CGXFfLGpBfSh8T2+r1w1XnQbP6B58GQdfqKEMvOAcDzaIKPhy7VXJ+CK\nffe4nEquTjL3JU6b2fxsxnu0gACL1ZCwArexPOIyL+0tNu3KLmuExqveDIFf\nLEbpWYhej/3QDV7URIqW0cPyIcwCnXn0cdUv+I2teKZ9vE5SSozUD5aft2he\nvOkm\r\n=ED64\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is an extension library that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n(tbd)\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```tsx\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```tsx\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"865ce4df79a68d5f8959e013a0ecb037b02c4d8d","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.16.4/node@v12.13.0+x64 (linux)","description":"Extensions for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.9.0-pre.754"},"peerDependencies":{"piral-core":"^0.8.0 || ^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.0-pre.754_1574751661746_0.7890382623399388","host":"s3://npm-registry-packages"}},"0.9.0-pre.755":{"name":"piral-pwa","version":"0.9.0-pre.755","keywords":["piral","pilet-api","smapiot","portal","modules","api","extension","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.0-pre.755","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"076a4bec8af9eaa1566050023c583aafef84df29","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.0-pre.755.tgz","fileCount":20,"integrity":"sha512-VsSz3IM4je/GoROA1dUbpJyWvRrxaezZ2MZ4TtXs5lQtUeRwxZwJuPgSfvCutYEe1OPr2pdFgLmZvUe0xoiH0Q==","signatures":[{"sig":"MEQCIE0ptgbq2R/61+Fy0ixiqWkpfaRq+9uuYHO+T55THRVRAiBzXYkNFslGRhrAuYJA0Jf6/TCEDA14bxwFESIOvZT3pA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":8070,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd3TekCRA9TVsSAnZWagAAEQ8QAJx32fLsjamj4qtnEo/L\nYplGx2WL7aXSh0VFL5aU2k2mzVUvD0RB/gPQ/F7TajIgqyNik9vxRhVyUvrN\n9MCrOTJVtEkYEWSHqXaQxOHAtxhRVu8L1kQbv9uTOQ7ZDnQLBTl2f8O7+JVg\n9pX/KPJ4l09Maseo1iTYoB2IIFIDfSHbHMVwpVOIGbhxyNPG0/PxRpnVwlVa\nWrX9Z6qaB/dMH/LkvshwJ+PmXXCXYw9G0+oYuRhrWLnYYzfKIyiQEYGPf2yL\nSPLjgGhMvXq8NrrWnzZv96CTaPa+pSz3kqXHulmEORu0S9OxfGqPs0O4ygDA\nojDrPCcJrxOhcP1soB4BcrKXoS6CY1u3D4HQipgFFoislw+ik0y45AxzKgj9\nfeB1lNeoJkdhq9migZFSbcQFdx7GLZJi0zfyBu88WFjryj0dABdXjAgSmzQC\nxPQ7JHlafPGYsfTwHeUG1py/3EzednJdwu9imLRwRHd7c62g7hhe0c7jmOVi\n1l2XtlsKZB1kzhqOXoUHh+8ssD59KM7g+0pcXDC2UsKbflRBLFNJuU0p8UfY\nblw+IX/C4PzIUMsGT7v4D6YqS4ycpUxfqwopPd8TpPQvP+Sz96YZ+8YlFIZs\nD6K/vQlwuuPb/pkQ7owrQ+l7uPAVvX/2yq/eod8aPjHc1bE6Hn8WwV7QQjk0\nTpk/\r\n=moeZ\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is an extension library that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n(tbd)\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```tsx\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```tsx\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"d9a89026e93ddb2eec63195a98f0a40ec64400cc","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.16.4/node@v12.13.0+x64 (linux)","description":"Extensions for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.9.0-pre.755"},"peerDependencies":{"piral-core":"^0.8.0 || ^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.0-pre.755_1574778788342_0.9768999815347152","host":"s3://npm-registry-packages"}},"0.9.0-pre.756":{"name":"piral-pwa","version":"0.9.0-pre.756","keywords":["piral","pilet-api","smapiot","portal","modules","api","extension","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.0-pre.756","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"9a03842ab4559a8830d604bb06a95f5c1d472598","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.0-pre.756.tgz","fileCount":20,"integrity":"sha512-hnf7vJwJV8ElKIL9b+G1fyXmTYOlyIx0xUQx5tufeJx5fm0nabQjslqb9FSMfRCWXSjUU+tlKH7jKL9enhSFPQ==","signatures":[{"sig":"MEUCIQD2csxX02XNHRCGh29fhCA9wvcMtzd9A4MJeZB96CQ6pgIgFYs9PTmqU2lulB///srB14jFem1QmiA2nNP+FaLZaw0=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":8070,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd3VTWCRA9TVsSAnZWagAA1T8P/R1jMzG6WBIj/9FAHZmo\noxfE0zzNy7cmEbylqgJRHgnMH/DodY92cvYmIH3k3ABnLR2hpeTne7Qxsspq\nm96xfeZXPw+zqOIsLItkkxHdURWexBg4XMWEp/pHEZFtt/Dphzwr3kk5BrBd\nP868piwBJQVeBT4HkH2aQTfhC4pvznoNCVnOFralCccGFUV0bcHqus7pkHrP\n1jT4dwbNHCJLTypS2UOBJBx9lvtD4RdWYLzMGlrFbgUTItKLRZo5u0vg868b\nZ+JBQoO1TAZEWEg6Obrpp38TaLNFFaC6+tVSSwSS3oYN8CMjA/Gy2H6yXgRE\nZK9Nx+FF5A0AzNsVOOy0FUk5TJ7BKkwB2Dxeg98Jir61G75w6RsNT1iGXYk/\nTvXGcpfnyOTN9V1Ex8BfnXGp5FR4fGqdzjK0ui/n5n1KNEkKaEXCWiNZoofo\nQPIlU2BRv45fRR9GGKbDWV+rpdvwjjv35nTIPiQIXKKREINqUYp0vB4vamWE\nuYAgi7v6D0INjiiYkH0cwwq0cPJEZTuJUxi878P4L6qGaBJIYmh11YHE13TQ\n5Qzk2degkvogi5nVCqf/r+scqsB/g322pO88cyvfzm4qjIDdr52t1oMHoCqt\nxzfoUk8YLxSfiJZIDqbBYh33q+66n09jio64w+KJgvbgtncZF64vYsYiGCJX\nj6OE\r\n=XuiN\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is an extension library that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n(tbd)\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```tsx\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```tsx\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"412a395210f272c7245d8e186970dbb129dc8cd3","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.16.4/node@v12.13.0+x64 (linux)","description":"Extensions for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.9.0-pre.756"},"peerDependencies":{"piral-core":"^0.8.0 || ^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.0-pre.756_1574786262518_0.9283956692682942","host":"s3://npm-registry-packages"}},"0.9.0-pre.757":{"name":"piral-pwa","version":"0.9.0-pre.757","keywords":["piral","pilet-api","smapiot","portal","modules","api","extension","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.0-pre.757","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"27d3f214f8ecd9f1af6d27465524f8d99cea2d1c","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.0-pre.757.tgz","fileCount":21,"integrity":"sha512-NlJkUcE7VwiFjgSOmfJFjcX6qMtjTUY9KfeSU5fHlKhj7hTAnJ+gJC+I0EOI+a5npL/Y4UbBbWm/wqbqsEVVjA==","signatures":[{"sig":"MEUCIQDuKsdu+dr5g2IUDKS+4SH3z4eI2HN/Zc4JVBCGV83GigIgLkVA70+3/mHuGYcKokxvTEvkClAA7fgWjAAdZkOuKRQ=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":16892,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd36gTCRA9TVsSAnZWagAA4+0P/A4qa/9kLb0uHpltXLk0\nBmg+lKpBb1GH6eknXJFqxXXlspBacPFgHYECY7lEhmbb7N0EbAP0S/ig5HFg\n2R2NY4CakB+gQc/ugFW0PiVacTKAj9PjOVQmyk/I7oqQtXyUIX2xqkR768pU\nExkIzMogmazYDErbS2MovLgiEkHjLX+fM3CqFPqqtUDrmjl2s4qKnELbVdDm\nsrd2uuw1ImuaqeGoV1+OnFSW1BMFe0qx4aSo0PJ4G4g/+LZHOWkNjCg/BguL\nBnWnbyTNTlRHe1W9gnLQB4MJ0IHq5On2ytYZnkIXxekrz9YTQrEw2DwKPIJD\n5GjRMaj835Ttm3Dg7H0MTodC8+rUKn//K4yBJn8L/jMiDzEi2TB/JIsvUATb\norl7Y0FYsnM532fQC4pdWeBxtvPDVwHoMnwECJhUzTIbKEoXrxH0syPqsq2n\nmiQXkLiAUovvLdK+/CbNH0Lp6CDVU6sV2jgK526KfYWIrEI1RAC7FF4sa+h3\njSGC1udComD0cg5SXzg4PowQKNVgfHuFz1U5/0bSEEajDj0KQUyNbSvLjDU6\n5bVdLHFUpX/v4NFAhjBr6YY0GZIYgNZ3RDHwZW5A8mRc/ISihilSgCC1JhZC\nSN26iuTzpnqWCWxdMe1kMvl+4X4Ofty22caiOpA4cLj3aFF1T4iil3FY2FER\nWdjH\r\n=lmyY\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is an extension library that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n(tbd)\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```tsx\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```tsx\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"5a508f91c2f538c7be04b4052e13b272bc481fb9","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.16.4/node@v12.13.0+x64 (linux)","description":"Extensions for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.9.0-pre.757"},"peerDependencies":{"piral-core":"^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.0-pre.757_1574938643011_0.5835266509679693","host":"s3://npm-registry-packages"}},"0.9.0-pre.758":{"name":"piral-pwa","version":"0.9.0-pre.758","keywords":["piral","pilet-api","smapiot","portal","modules","api","extension","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.0-pre.758","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"95b0107f6966fd1d957a13e19721cb774ec39107","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.0-pre.758.tgz","fileCount":21,"integrity":"sha512-HPX6oJCvWbWN+YvfnnSO5g7DC1Phr+sF+J0M+i4OgJun/ZIQmILMqIRDdA1hEsJmmVi3FnKcEFCmWRjJhQ+yNQ==","signatures":[{"sig":"MEYCIQDKkzGzdijLeVtJFuVZWcvo4UoZmJwS0jBOjo0UQUrTyQIhAKSlu/T+v9Y2qwSolYernUZ7BxBM8DJEfQvn0/oIVMRZ","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":16892,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd4GchCRA9TVsSAnZWagAAPYoP/2IOnTXNYZnS6aej4Bfe\neFWKUVVMHIGV9vyS98sVnupAMvB3BXqfXKLuBEkqPD+atkop3mXC4dTDBh6f\nZMjZyyl9OorcnA9+20tj8EsUXnVDlRBjkFBtivVtPSX/XSStSjvQo33a/H66\nr1rMrmKXibElAVCbJELuUMqueuG1Kxkjd6CJy/2ViJf1x4uOisK45mshemN+\n/Vg+WAksfhknu9dogbxpKq+qN7UHj+QtSNdxq3xHz/r8vZyBur6yomuXsVRa\nv1LPDjo79SL8uyJm1M3knmUfmDNwzWF9SpWZrHfrvkFvt0H5OgxvRb52XxxN\nuZWlMKRXOzrO578XK2a0TFz4D8h4XvT6QMBj2hYYXUKWPzdavBWkXDXfBbKq\nRAUkX6cw8e9khVduD7t/jTAVabTsd4edi+rF2qRW0nEEbS5mHtLu8oVGRJhf\njDq7qp9Q7mgmsbO11+YZoJYvOIsLFi98dR4gXtBsNBQTre4Qq92XPtZfUF5H\n3jpCBAgdXu0o2QvbGlmcsQARwhW78sqEVraH4OnbQgsB5WNC3aO5j3U3DMdT\nA9PHdba3SnRHW0HhybbOQ2s9eY3Nqku40mweHDDLNd/fUQNv8NUGQfowhAlo\niSh+PRk7yDbQRc55ykVkCTPe4z0YdGDC6FKaHoDR1UQh8iwm1t/otpEREmi/\nRsYh\r\n=+O/A\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is an extension library that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n(tbd)\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```tsx\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```tsx\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"b55b47bf72b559ee4dc3bfa0012252e59eff3161","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.16.4/node@v12.13.0+x64 (linux)","description":"Extensions for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.9.0-pre.758"},"peerDependencies":{"piral-core":"^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.0-pre.758_1574987553413_0.40369369530832877","host":"s3://npm-registry-packages"}},"0.9.0-pre.759":{"name":"piral-pwa","version":"0.9.0-pre.759","keywords":["piral","pilet-api","smapiot","portal","modules","api","extension","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.0-pre.759","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"cb8ef4f4859e62d48915d7af7b71cf7572c23e9c","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.0-pre.759.tgz","fileCount":26,"integrity":"sha512-8I4iE7gO8B4sBu79Zg26zERO8K0vZJ+KRjf/mabXjmxEF9qPqTu7ZBK57tgBlg88+TlPiJ2OrNGUjGiGVYaLTA==","signatures":[{"sig":"MEUCIQDTa9HUaI3IQFl91OT0GSBHHmvOkcaP9afX+NpfFH7mtwIgO9tyLKB9D5E4FWxujUY4cQYZWe4CGJ/9kmCteiz2eac=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":44185,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd4SayCRA9TVsSAnZWagAAJM4P/1U06a6L6JwwegG/dUCa\ntCfDibTVYvTopTww2ALz7PSe4As/5T98D2nOhIF1RDTwRpX0d8piuNye9+kH\ndvxXUOa93MELSe8hSamtch5FqrU/YqDKbh3d8ftTVHP4IQce7S+gm+xNTWdF\nQb1qY7H6OVx/BQUJsw85+b7QaIO5gRk9AIt1JmgFbfuZIFCd3RHhPMjHl/TV\nhUv5F4dB907WUtsi2qFEMJomjg3rPTnboEKbR0ZrbmKESkrF6cnTEgTtZsK9\n5hZp1Hw8wNfuweCEsPQEzDrNIQydFMzHhKLLcdmBbvctOq7D/mGrRrFuo6av\nEGc2VXeHCWIixc/nV3QbmxiHZmCC0MlCPVqLpZnp3Sj5Sjr/8B/uA176GYzv\ntwWeg5bKAd9Znt8QZKGW3KguIrwHG3D1jquDzooFUZJP8RDEQsE8Tx6yhkUQ\n8Dqcu904PvSoHRRoeQTunLS2OtioWfGxRvokGV4PYlsHmvwW1D6WAUYt6Uh4\nYR97R+m4IOVRVqCTbE2Hllnjn71toTxyRx/HJKa5EhSunYtCDue9OsoH+VuN\nYyXU1NaIpwEOgtk/Bbh+G8i4yKRUq160u2lMDfYMoKBT7fUdrJH5/GACR4ea\nLiuowPQdYckLg9M1oHypLS9IXN2APLLXRoMgM3jg2PrJFYNU4GYmVsO0AQTB\nyWMh\r\n=6Vwj\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is an extension library that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n(tbd)\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```tsx\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```tsx\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"7f99fea46690df403c1090aa68b81a29bb5b83aa","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.16.4/node@v12.13.0+x64 (linux)","description":"Extensions for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.9.0-pre.759"},"peerDependencies":{"piral-core":"^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.0-pre.759_1575036594267_0.09823340273007442","host":"s3://npm-registry-packages"}},"0.9.0-pre.763":{"name":"piral-pwa","version":"0.9.0-pre.763","keywords":["piral","pilet-api","smapiot","portal","modules","api","extension","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.0-pre.763","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"7cd5a4652257861dfc2e7b2dca8e328bcbdd1f1a","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.0-pre.763.tgz","fileCount":26,"integrity":"sha512-hc+cUmJMimSBQeb+5iqd/6uFrCThQRytzlaaWXXarHAMPm1NDbn1KRcPdT9cfCSWx+HyxpiBo1ATmBW1Ny3/lw==","signatures":[{"sig":"MEUCICagah4GjoDSo+KwoD2sghGgy0GnrKJSUB81qDxNv8GQAiEAkjlWhOOmDlVXtUur+H95IF0io09KK+Vwrwh9IiTubOM=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47886,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd5T4ZCRA9TVsSAnZWagAAP/8P/1Tevyf7exLM6guhPuO1\n67Jb4KRDrg6L3VrJPvixn7IFmnrTtfpZdVXZxvl2aa2i6JH7Q95z/8kSDpD7\n5NI7Oeh54fvVUBfWGeC8xRpjLprFosHq9Iv2kxiy1KVbvBsEIlYr8ZjiO+lG\nK/Omda0dqUXdd61OfTk/vuljWeV3WcFgmjsbQqJflmdoojNg5FUYsxLg26zA\nCmLvhLr6XOUskUwArP1qAKEksuyyNQCfa8nN+9gep8ZCaMa92ui6nolz0Lzt\nzLsuApqg0iGlGoQjmx/3ukX1cCjzT4qWJit147r7KhWkFDnXoMG3KQXrsVGR\n2YQTgqAVt1VvPikakleMotzina9un2D1elzyVrSQ6cwfZ1IO4GJ7pljXDkB4\nSIBhv2mIxW/GzF9uhdYpD3acMpRKEqwwUWHI70IMs9fktpZODqCmq3zlMtQr\nHQoPMPNygRB/qLz+ZNVUpV6w15v+rLU7WpCNVqzDC+VlvQpeTEkqeQcAHgiO\nIVC4Fk/5GgSjmW2krVPtWZ40xv7XaOeuX1/36TZgn8UEkx9ZdWlqWE6nOlRS\nP2LZncALkndSyZKhUKjrTvztd1OKE/fnVzbZTkemWObzW9cbnks8pXw7n5d3\neLwiQlbAGLgzDjmqIIt3MgVQQ+bV4zzYl4eiRwivCWcHGMTz9qiiw2JidStQ\njP8+\r\n=9BIr\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is an extension library that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\nThe `showAppNotification` API allows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOSX a quick notification appears.\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```tsx\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```tsx\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"244d493ecf0c7986e549b0ee2fe48feb20c52cd9","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.16.4/node@v12.13.0+x64 (linux)","description":"Extensions for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.9.0-pre.763"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.0-pre.763_1575304728897_0.3730436760659894","host":"s3://npm-registry-packages"}},"0.9.0-pre.765":{"name":"piral-pwa","version":"0.9.0-pre.765","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.0-pre.765","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"b1c43745bba495ba9039ed21c7a8b64237cb68fd","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.0-pre.765.tgz","fileCount":26,"integrity":"sha512-XaV3hWvM4stSRiMMwaEPPD6p/62p2/T2BCIava+Qq2ymD5Kdj8M3CWBrlqWSLvTyYPMgxed8puPka8hXpJub7g==","signatures":[{"sig":"MEYCIQCw7UVjl1oLLqyTe1iieZoDcJ9FRabXK0q47V6TPSnrsAIhAP+Kkn+2305EF65yXnwKHwgm8qgvzMvvf7tCfDuWquhK","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47949,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd5j3YCRA9TVsSAnZWagAACd8QAJJRbsU0folEqgDYhcIG\nRc5JQ5Yp7AOn3VZ0lUf+gnyDDoi1wWbBXivKnPltxgftMypR9sz2vZ/kHmK8\nHqm/LysvZ4oZYFP+5FtBrU3Ov3Rw/V7aI+grRqepoSP9zyVj1rs5CYawQJVJ\n6E9Ta+BUQDeST+fLGhJEfqdSEv8RXqBZU235+/1pGozVfuzvLsJwQuVT44PG\njFL9067OPqepN+5OYWh++zGIRpKZBMuHohqdWYw4a7AJO2WhnSHYTKgcMDfp\n9D7MuZSSdxeonLESpTg/qNiafHbvZ+J7pKZ2ih0X9cqtBQUl+HzRFEIwunuq\npa5k5GffjBQk9cUo9X9cbTfIJEcsmP6qiYsMYJdCMn7HZL+Un17617Y8zyXH\nQ162Vqe7QNIlWczf3m9eU5DMcxb/8HnG5Lc5JDXU79KkCUxTw54KiicGRWzV\nsIgzK2gNezriLh3SxxzSKV27a3pWcs0OrqFbOtlod+/EEp3HG+dToYOkEiou\nddAYtxndbK50NT+8chI+bht5+Nhoq92KHhhiqTPEevFkM1P2Dj9vzfQzjYL/\nP0pCsbTpBvpv67Bs4MgYM7FhTnIGLWgv9HIAUtBAJ2NDN6aVjdYWIy0hyBTl\nfEiikYr494xnIasYpuCNAGP7c5RzqCNEt9d3a/VO44J2FdvPfcooIQX4wf4W\ntUTI\r\n=IVRQ\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```tsx\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```tsx\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"81e14b202558d9c3bcf2f8bfdf0b758d0b4b1043","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.16.4/node@v12.13.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.9.0-pre.765"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.0-pre.765_1575370200151_0.958715214401572","host":"s3://npm-registry-packages"}},"0.9.0-pre.767":{"name":"piral-pwa","version":"0.9.0-pre.767","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.0-pre.767","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"3a38ee882b30b31f9ca09e2fe73e53517cf135eb","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.0-pre.767.tgz","fileCount":26,"integrity":"sha512-E8kbcKAS0IM2ywYa/pqqLPPnka056RzdsWiH1v+l7ZHBCxAy3dVZEru5W9SUnSuRHr3Je4ekW1wY7ArjFnQPPw==","signatures":[{"sig":"MEUCIAvqJ+OpB3iVKaboxOfCXC86KGexXgBaRIJhGqnYhfqbAiEAwidfzfb2kljhtJWFmkrq9OMHyES3Vf2Zzs/mUgCGhIk=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47949,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd5mwMCRA9TVsSAnZWagAAK9cQAI1pwmodUACiaa/xq5zQ\nBPq4OxHyQJbdgGF4/JhZenWeoFaj0EKvYXZP3YSOXe6scL2Rp1oW6WW43eOo\n+rxztscIGFlb7KMgdDxO6zRsFtKiMYiLC5CW+gPm50pPtZp9nTL1E4AJ06tV\n3EKtYkQC4juN+LWQJa5aC8UT4btbR4xZ0OsVuozs+LoxbxYwfSQsUCx3h2wM\n5qs+xjMfmCZ2MDKnLbo5KSLnM/ecEAql/Lyny8lkd5ZZMNaX8l/jbv3FPO29\nCjlwlAXtg/UujU7iorernWZjqN1S1+taWIo3uI8qDOnhWADBtvOdv7j0se/b\n8AMCyOLFDx0UhyZhwpRP75idxcUrxo14UPJqQAIolMlbJ66GOfGXB9JGbf2i\nPsVYEJvLTdpH4gM2k8U9CVYVf2f0VYeEWcEMzKA6JDHc08XWGl69jbfzcn76\n9EWrkvFJmtG6GPo4YxUecZ2rGKucTE7Ksw1WtGgqPdE0BwaCm+1NoJfd3Szs\n3r8+lNtANHbOPlr7LTzA2sU4W8uN6UKv9IgGgFYJjAxXVGsuLsMQ2WLVtmFb\nM/gqnX/OYeLHNwHe8ef4QRngcGuPQZbChbGm6CFdGGHVBT3J406ZB3B/WCC2\njk7CTH/MK7Sd2if6hqPyt+TOR3GDYM2a9FzGWT6JmFHHoMjXRcM1Bzh1qckV\ndTpg\r\n=9h5t\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```tsx\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```tsx\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"6c850918cd58a646829f056813dff3bccaba125a","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.16.4/node@v12.13.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.9.0-pre.767"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.0-pre.767_1575382028328_0.48327097621224446","host":"s3://npm-registry-packages"}},"0.9.0-pre.770":{"name":"piral-pwa","version":"0.9.0-pre.770","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.0-pre.770","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"1fdc0f667cb0bb03d6ab11cb45059a9c893ed3d5","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.0-pre.770.tgz","fileCount":26,"integrity":"sha512-wuQCVw++MWC+X4MiHq+i2euRooJn3csFSCSPRY4xgr3VpQ8lCo6aLSsqwsroPh10SWOtQOLGDJKnNczToBj39Q==","signatures":[{"sig":"MEUCIEjHXHDvWf5N3rv1Vg79CYikCoVCoklGaVzgngmMiyOwAiEA0bYKd2bJcazyf9htGpMrkwKgKJdqqD4zMmR8tZ/ucyc=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47949,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd5nkSCRA9TVsSAnZWagAAJe0P/1goyKeCUPxuLbY+aH+H\nAqXO+Hgz7sQED0p3rqnPJRKNGxcE7Uw+qql2Scox6d8eg2kXM9Ykl/J2hWVs\niHB2jpDywwzhNvXz/GdIZJ3St46NtHZ/JDzFPGfvKxahNMbAXxkHOOd+hHAg\ncjO+QptcpUhgAP5SUU+amEoxI6e4ZBl8i8PWFA4PXKK+JugMGsKRTGyxSli/\nw+sRXfFbv1vmYn/0nEwWhc3S4SUhl6Sy3Gl44IHfqwtLvX5j28oqOZFsYEoE\n5YbaKNvYurkx1z78a/dUtSInN1RN8FnTh4szckuYsW/BHDvwlcAXY6/Xoacc\nagoeqsnSSBeXXeqkhllgavSZytCOas7Xgixrhr7RvXr8XOkzkH/B4zRlo1JP\nmvHU8ZgpU69JlMv3sfTD7z3cT2Zc7HXc9MF/n5n52XuS3UPER7MDNXNo/ZDT\nc+RolFoOHt23L4hUy2eadlRjMLQ6e2DzTwtFAAQvkjz4691xRsdk3s0M+V2K\ncRTom7pCuel23T5XFLL0D+Ede6IUPAuS5rV37rfEndSbe7osvB7TibT1Gre+\nPVKS73oTqg3PGHpX/pSy2CnHC41F6ZmVSLbtdg5bxbWC4MAvkZIZxyK2WLoj\nzeUMwdBjuPggzLObThloTkOOSrzvkRpp71JSnqA1v/gF1oLtifFEiVMUUPl0\nvBlf\r\n=B8R4\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```tsx\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```tsx\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"a9d4f01638bda4e99ac9b9328dcfd681ac8c2b3b","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.16.4/node@v12.13.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.9.0-pre.770"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.0-pre.770_1575385361701_0.4259944572470544","host":"s3://npm-registry-packages"}},"0.9.0":{"name":"piral-pwa","version":"0.9.0","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.0","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"bf5496ae1e198b3da899b7d63f8a396047c58a8b","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.0.tgz","fileCount":26,"integrity":"sha512-fPx2leSsBewKFzpq2nVlWUZMDsMOPmjhv5OCVS8HEYcFzJdfLqY0Q0Svaak/Or3lpDcyPIPrsumZGXSTmKXc3w==","signatures":[{"sig":"MEUCIQDAbNn9vapuhNMz80o8Nbvn7RqsioOuRhEhxPy/WQ1tqwIgGLv+2Io9sX94AKKQJZyaTASBVPMnFJV76eMfk/IhbH8=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47933,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd5ofHCRA9TVsSAnZWagAAZRYP/jFkeoA/p+E+B+9sN93o\nVRV0zZpPGHP7EgV9TSGkFVvxEyfIAD7GmGnNMJtYdIvn6H/vcmwgzBYDTjrF\nzMh1si8Yn5izl3zy354dStxCC976JZ6UZjAU/ds+VHgLIJfyz2cwzoU8Fxve\nWt0NtZ0nKohdaIbZxq0HDcs+zKuoCUwL8WG1NNNR0IGFgq16IBF0Ep3q6ixG\nvP2On0meQDP/If259YUMHHMlLTD5jiq7ArDhu3C7EMsQQgjB8HGTLSjtQm2c\nAqcDnjm8sWvPzfEGfqqV9RSV1OqKeRk2HcC19I7S93eeMdNzJuYWOgLzOJoG\n5DYVEPQBC/RiP3ab+kDgr4y71K30rZHGnCCx/uL6iCto93s6nf97KAAb2k/0\n+VwF7Rg1EyFfbC8g1zipZ1ZOLaFJ87f12NRzdQ8da2vSJruYzGpiRGRmuBQq\npdjjEXz/MOR+hUV2Ar/8bOcvexq0a4lgDwAVyBphoZ9HATF/B7LqCIj3LSiW\nK4MCbQVt1W5ld1E0gK5HuE2RV1yNY/uM3mj8mRXHmFHajxH1yte9rGhDIJ7G\nPDzBvD7s1lO8hnwbNN91zmxXJsMVmwQxULRNbhS2aaiZapMCTKohsGa+okIm\nHO1Hvd9rbsg9UDJmbAVcIC9LNCGjiQmJ6o8cYO4jRN+pJVy3/h+ah4V6Zqsi\nIfUw\r\n=X4YJ\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"7ad4b45a83f6f747feee198853377897ce5111b5","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.16.4/node@v12.13.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.0","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.9.0"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.0_1575389127600_0.8170487875715517","host":"s3://npm-registry-packages"}},"0.9.1-pre.779":{"name":"piral-pwa","version":"0.9.1-pre.779","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.1-pre.779","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"6eaef3c47c1c36c1a8d7ff854417686aa4211f64","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.1-pre.779.tgz","fileCount":26,"integrity":"sha512-AhsVh4VN6yEC2d9AV/K1eBNolJD6vrrNDBeRdus+ejQF3SzhRdXWOKpFd0sbAccLXE8N5sS5utyBE0kqE0EuCg==","signatures":[{"sig":"MEUCIBkL+4wjxx0GlTWEU/aRrLj7PYqsyRyOWlAbn1Rt+8iRAiEAyJnDxhuczZEGmCzuCPTuJiB60ex3J7+WpTLbXOSfD/U=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47949,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd6O7XCRA9TVsSAnZWagAAz9wQAKKjhesZut41p+xWYqI8\nrSHOTWjZpDw1yq24PoSAjuJ92CEay/6sq5Xg7W3GDfNIlVG3MDIWbiQyCL65\nz4BOY3WuP47B4pQAyj2mL+fzfAOHg9hBGmbh9yMv+xSL7OYNLPa5lbGt7pQb\nF4U/nIilnTdwOIC15PU0PT/FUz6GVfsqZWYIj/3t6jhdkuJY+B17GRdJwG0l\nY3nvxPo/W0penZrqHAPX6x9q5+esukKULtkKwHl4au0h6Dv1UFQn/+H/LoJ6\niQrOx4YGwS1jj4S4jE3lxzd+m2fOpxJhmlWvkFT+v4D69LjdCe+fnJXAxKoL\n6nrqeu6Koo1B5GEy4aMEi72M2pTNKM8D8P1elyem30rXLZsE7zWlEk8CEjL+\nS/59lw2/tSQVw6ISZ9Frjd8F+QzZG16ICl3/YlK8ZQDYl92mVIhckRvM1Afe\nygVDAdjIoaMHztAhW7gQgam6y7tEDFObkngivh4+QaWb6kBSZ0IGUi4yhty2\nnRWUEQD+pRuBDUMOO3FCFlBcZXtNkDApHOTuVXnh0f4DG0Q2MgsxLHyhoBqd\nWhhiPeJqtQySD0HyKgC0vJZGLxBRe83u7n6rrK3Oq/7xpPImDvKEBMIGVaqQ\nZwYjA3wa6k79rgDHz1hW+pCFScoUggXXt/3mzELH8oPKBdDKYhd8M1c+8IrC\nT3fc\r\n=s+RB\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```tsx\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```tsx\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"8d4e44dfc80a4b8c33a7a1c5b3426556499a7aaa","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.16.4/node@v12.13.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.9.1-pre.779"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.1-pre.779_1575546583227_0.6932972580617351","host":"s3://npm-registry-packages"}},"0.9.1-pre.781":{"name":"piral-pwa","version":"0.9.1-pre.781","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.1-pre.781","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"4d511eb89eb61fb74d484987c45b7884dc1ef867","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.1-pre.781.tgz","fileCount":26,"integrity":"sha512-Sn9eM+mCGLAeXfTcT4V/0AxnU3kE2+PWlc02HeEtgFuqkdV5Jk2bC/VHftfiZJJATWRo2gtG6C78Qzt7KaH1lQ==","signatures":[{"sig":"MEQCIHyKN1tcaBgWgSOJAwQLTUAyPTyMzNzGxkMX+fj1A8nQAiA52bumG+6uarIn0EOtED0rDLGefnoLyBm4kcRAtBeTVw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47949,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd6krNCRA9TVsSAnZWagAAlI0P/0z6c1FuvzIZXgLDVmEO\nyHScfzgx6Fz+I1o7bTRjISJMC3uKn67+mInZLTn00zvFpqGIMnyz5a2CKw/L\n8RDVk/qYZP8CkVh2GgxZZIObRekvqoX5bqnCV7BCEsT4v/7np6KsY74ddkzU\nnUq/2ONHXFqe4+yu/sAvbJevPoR632rOAwMiRZDvDQUs3jYAiGTXBENxOt07\nocmyYZef/6e/XPgYrLtJTkluYfh2XY+XRO0QAcfZgPFH9WZDl2R3jHDTJh13\nPNmL1/zsGrP92OCTk0owd1OVs51yqYUF9hKRR2HCd8SF4swA6V+DlhHj2AdH\nMyBuiTGBNXLsSxVLSJvJF+YrSTR7her0XyPhS8nVwV3MTCcTZAlldy5fEXCY\nCt/fMdlz7gbwpkugn7etAA1g4z0hk/jPue/xIHYYW/JG9yH6kJLvLc0dkCAb\nBNpJ2f0bWJmv5elLoG8ez4RDTACFyvjlcIT9xIWb3xlelI1rgEpCQqeSYYJA\nS2f7UgVBlDlJfCclLdaoGLdFhswCuEBsq0S6wkbLTZuiMOL9Uf3mEqcATRFr\nDtlr9zVEE5qWF90TSYxBRA62PrreDAaEZDUhXSlPA3sVuw5cMT/3xoWf5jBp\nWnHxkMFaiz4YQrhSR6XSAByex/p8yPDJErU+ukpqCg1Jzi5S/9Oke8oGczTo\nk+rU\r\n=roM+\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```tsx\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```tsx\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"f51ad35e2e03757ed03872514a31c256cb8ca353","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.16.4/node@v12.13.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.9.1-pre.781"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.1-pre.781_1575635660948_0.41917661816094265","host":"s3://npm-registry-packages"}},"0.9.1":{"name":"piral-pwa","version":"0.9.1","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.1","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"d65b10ccbe73cb08b79ce361d767cb79d0bc3e3f","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.1.tgz","fileCount":26,"integrity":"sha512-gOwecqrsiXMJUIMMKhMQvEQBWMTy2MQjcO9tsAPwIWIxDaNRYaV1JVGCQLWJMp1TvJRBa2PzkIQFBWaG8LyQZw==","signatures":[{"sig":"MEUCIGl9kscW1K5GM/B8CbFWTIwdTjsF6fHKQl42irjbSOsUAiEAlAHadGYHqct+cM3c/BtKey7FvARu8aBCBfnXMsT4tD8=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47933,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd6lk/CRA9TVsSAnZWagAA64MQAKClN1w7+7TMPUZfBEhN\nUZLmXyHISYXfdWzRE5cM1q+adH2OiYYJBnbERVSA4RK7P53bQoolE3QL6Lcj\nLY3oMeKoaBJDfb9xRZCH+WWn1OoF8LmGu5wIAXEXRBNUYO4vxfyPDiRkh53w\nf9nS3NMkB/n3AaWZPGvYu3Ui86YYlZV0wt2Hm0qi9JIAQrD0alV3JofDoVBt\nHHu9Oqr2ECNpOzbTefyJtc9ZTvSnX8/raojEjXTuKYml+13DXEaASOe9TS9g\nbfzHMemvzXDeTPIqqmAUSzs4rWIStctZLrkaMPHW6ZEGdnfTeopTL+kfhnll\nbvsFfLnLNKg0IcMhEdCrFyFkGkFSd+BpsxvvREqVtMWXHoa46a8987Jl9wZ9\nirVB9ZrFhvf0hlKS8cxaXIV6JPUic+nuL7vV6po2kg0010dbCxXrkkMgg8Vx\ng+fwF9ZWKpTyBXnQe9CBCJoEtYl10OsxG6RCA2jOPIDTnsCX5IpQvPr2oxU/\nNSK2WEiRI3Jw2T+gPeJcv6QT8WmIo1HzylNqZboSaUu0fxsSHVuyx+tMPOWO\naLgJ7xSPGrDiQnxPxROz4jN3r5P9WpHkFYo0nuC3Qrev3fhduH39N3z1ACBT\nLknoOz6tAkMm4MJhVKrd13EEKA/8CKwCXR3aJXW13HUBlIDzKpgvjogvJU5P\nWF+3\r\n=JuRo\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"9103c40ba8d06f7413640c653152d0c7996aef58","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.16.4/node@v12.13.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.0","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.9.1"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.1_1575639358947_0.18156901733285657","host":"s3://npm-registry-packages"}},"0.9.2-pre.785":{"name":"piral-pwa","version":"0.9.2-pre.785","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.2-pre.785","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"e68887488e73449798ad42fd45adeafdcaec2a72","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.2-pre.785.tgz","fileCount":26,"integrity":"sha512-ppzONJXPLrnIjwF/NM2fY94ud2PJa/SmrzYpiCCdQdyKfP51TwZrAQSkrvGsPNC8b2u15S4Do9thAMOoXQVRew==","signatures":[{"sig":"MEUCIQDiKukFIRZInG/rF28PK5bnJHlCcYluoQ07VD7JKrTWuAIge6NYxkA03hVDGQ+XJt5PZTNjG/HQ58TMN77GqXu29FQ=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47949,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd6tDqCRA9TVsSAnZWagAARL8QAI+og2mp5MCRhCbO/Ypu\n49AdQGPsVDgVpSd5DUGNc2qx1JdSoOcSbMFvNj12YtdBJLQqow53GDDcFakX\nOSv3IBr+Hw5y628OyY3WNUifRaeM3YqmvrwsnJfwv9dHUd9G/Cm7D/H5R+or\ncIFnSutB5oSGQ2CWjiuUYdviAbU700MNEo6XP8sMG3+NKaYOi8v4vyobAjKs\nzTjDLpe4Pmkaqr9+5/1wd7IzJ5nHgVPtY8xAgnIwe7R/U/8CzKMLzhGBQHRE\nKR2ums1w/GXV/KqklJ96/XBACJtSNCPPfwYFzy8Y6bDXonTuAFvUy+e2c6vz\nXsdEz84f1VtRloBdojguNBl3g8Zk+9vh0/uPuuyuK35BIAh8iL0V/aUmiFNa\nHXp104MtDPZu+Pq1l/1LLoAXHvRBeeKfxLSFgQu3i2THQgP4TiRHVOyWLggw\nroMwczxYRYnv0T+STrNKGi55/mf1o6JyijgIp2e1LJMbVEupOVwYhpafWuja\nAi4GTwoyuw+ABhOVYhQeI3+Qt1b78wI2T3u5RR3wl1zoyhRpVNhRfHSl5nYV\nXlyrbhHdw0kvEBlFD2LmrEDem5fngVbNsWoiFnH4Gi/m31ffCZTVPlIUUjEn\njtj/pndhC5d4cUyFtGPphesQxgHIb4QsFE/yL6c1ZLEWBm2pksPNrEXIhZ3C\nv46P\r\n=vReP\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```tsx\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```tsx\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"eb5c1159fb61fdc71bbea42469457f91fc08b1a5","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.16.4/node@v12.13.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.9.2-pre.785"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.2-pre.785_1575669994206_0.8546712623646171","host":"s3://npm-registry-packages"}},"0.9.2-pre.787":{"name":"piral-pwa","version":"0.9.2-pre.787","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.2-pre.787","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"19069a45299344a010ee50207ef9316eee57928c","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.2-pre.787.tgz","fileCount":26,"integrity":"sha512-VT+fI0L+FRoYoa+PRd9k7nYEY1A7IxnPJ6fcY4n9UbhY5Yt57rynt3NezBIczjS9mwCFpDG/Tfva+qhYNigQuQ==","signatures":[{"sig":"MEQCIFvQMknoPmKeqfV21QLWjNfYJYaKyUCk9g3UfBQh0CrfAiAXRXA7lJHTKSt00Ubwh041G+6uBycHGLS1qbjoCLs57A==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47949,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd6vBgCRA9TVsSAnZWagAAE5sP/jVidGYjls1jRNNLg+Wx\ngEDEwCqPY8JnPLdPdOTeHVIEPQ8mUssRDFNwiObUaajzNu8Xv3RfchlVSnJP\nvncC8dUute0EURCEZDQr0ccnL5M6Tt6nhhdYQbXEgq5BgFgip9WOxak9nfyJ\njSP9r0FX0ECL0OHeIpVF7RHEnQf9PG1nvH4XtwVsq6fuylL80KsaSbTbi5+w\nbq0pKXAYn+fvXPhO97X7WsWI54EIKA9n2rz+DE+whja7jBkJRcNyS+jb0RBc\nNIJzu0Qe+G2wmFLx5SW3w6Sp9Q+2CFJkl5gwVBTSRp2tuFnuMPFzSEfNu58s\n7i/3dGF6HWkR4ugwUoYZDWt3dY8E/Dz1FCkGG7hBpkVV6P/EOK/f28+Hzmal\nlUMohbobX8OyW1598RoxTa+J2sb+KrLvZecvOE0nUxFuXAZkZfOjLnvMUdJx\nm5pZu5kkNZo5zfZCCeoazZOjJImS0ZEkzzXzAHHRxeu5Krh1Pq7tYhBGWAso\nBwckToJYYN8CoOhVowYh6x4ofwCJmujo1vk1WqdaWy4FkWWKCgLHRYYcL6ih\nc/EhaJeqQtT5dMPvIbUatehH4HZYU1je/Ssn/XI5tqCXC3jqhhfq0lMlv57Q\nqNZXPHyjHw44ref6pntQjnx4SsyDqq3D4hSn1rcHK81pD/onwaJjwrkIUmcB\ntTqC\r\n=DcGE\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```tsx\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```tsx\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"819b12f2defc6cf87e2e2912ea2ab45a1091bdd7","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.16.4/node@v12.13.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.9.2-pre.787"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.2-pre.787_1575678047908_0.22479117042702135","host":"s3://npm-registry-packages"}},"0.9.2-pre.789":{"name":"piral-pwa","version":"0.9.2-pre.789","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.2-pre.789","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"8c48cd59d4d13359a877c9379333ca5fd5894000","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.2-pre.789.tgz","fileCount":26,"integrity":"sha512-Dd6piyR3UsK9e3gdkpgQhO5wkemsad34feQG1o09cQbJYewTtCkuOSsf8I8nEXfEWYEZev1lHDQCep3ivEwhtw==","signatures":[{"sig":"MEUCIHHFTel+ESfhRlvUdaju6gt7y/bOFAKC/c0EBE6ObS2PAiEA7SNqlb8g3aWpTkwNr51NABAO/v6Rflho/49zdxQWWes=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47949,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd6wRoCRA9TVsSAnZWagAADkYP/jny+yAwt2ONXsv8SPOa\n/CmbT+d2KDaXOmCdaoYPcnAdvM8a5foF6LuL5JauSOZX0zG2/9gAmBA6rltO\n1sS1OaWKG91hxK0PrPz3uHA1JNysp6gBclAkOPJwhHD99xQ7pJ+jTSdTwnBN\ng7yV/78ukFGoQQNfJ68pjT/m2YAaQ4sJL9Q8WzOJmTPhZv4CwmTlDqL1Uden\neDmRMCSljwDZ4ugFkp1FjymNO8ZxL33hFWAP2Rcyh2IX0yppJm2wmOxqu0tf\n5loWoL+vm7B9kzJEDuC7leGhhFtvlbdj0c08QUWacGu1aGaxp1oQ72xMqbNe\nmaaqoAso+3O0CEeU6qG+exeXs23wn9NOQR6fbcxzCe6C3nCo+bXjUeO9252q\nZ/Y323mbLiv/yO0F5jhWsXLH23DRfO+ZH9j6YCVa7/KmsGYoZMBg1u2SOrIT\nznVqVq5/NHi5/elMF3oBn2Xl/dI8ss8kWc61MWlzwsrpp8yfIrH3zFrVnLio\nbG0oTg0+UoC5jjaX5IGvMsQhDWT8BkC7m3TJHpTsPUq1S/YhKxohsg1CqnIG\nxsEQ/nZpm/lJw86CF/6FLRzjed8IMRvwVPo+ulkxVJeOU+vZlYgwE+08t11j\n+hXo83y5yFuwc1smr5TGohdJI23YEeuFzr/A9TU8D5nJGtXHGKKCcFobanGW\nKv6T\r\n=Yx7N\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```tsx\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```tsx\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"e1088fd6dbefe529f0bc403454f3ca28a080358f","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.16.4/node@v12.13.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.9.2-pre.789"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.2-pre.789_1575683176250_0.5730918864269798","host":"s3://npm-registry-packages"}},"0.9.2-pre.790":{"name":"piral-pwa","version":"0.9.2-pre.790","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.2-pre.790","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"0d855e49f3944e73712f8dd7c219b63d8d4ab990","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.2-pre.790.tgz","fileCount":26,"integrity":"sha512-1fJOQKg33JtU/8XU4ltWgfwOjFl6pmIhm99Ppvue7JDh5mh2ptVvf2Sn/+xCXZoEyDrAXYZRYoK6Pdoucv+KXw==","signatures":[{"sig":"MEYCIQDskqmrXjaOXSnZiS+iETvyBDPFAMaPnLMY4WenRcb4SAIhALiOy8XXlF8IhDWRe2wVqNJUgY9tZG5AVMO6W7qjcCJE","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47949,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd65teCRA9TVsSAnZWagAA3lwQAIM0rPKO9V2Ilv6S58VL\nsH7yK8vxy3Gtcgy4tdvZOULjB0/3/nTDmXTB5SFr2kY8/714RncbzZ/8DN65\n/8r8VsfiZbBHr09DB78apXqRQ+rtDVlL0u361kaIrsGU3R2Jwzs/sxs2rC4S\ngiskOH+ojB2Zohfm5wSygUs1DpPDKRyXgt43oqZlEBoWp2JrUkPLjct3I+GR\ngj94VDZQN1W9Atr+/1YeyXShhxQqsibfxXwuzWw+OFkc86MEus9KIYq9AuRE\npaitHY6Mqe2zSoyBBF3VHaGShf06TaYLWQP9G2qlvDNkOFVt/GbxpBFnDiZI\nspjvqWz+XOXt4T8E7TVp7TEDVrZ5oYsMVwMQQtm/0fJnPYx2IcmTKSDdJjW9\nTwZVWlp2h8Eeb3gtHPiyRSufGJoRYxEkTxvvCVQmPz+n227UYSOOBd8pqCSl\nOjP1s2/HhvHTD9G5HJQZtgTN2yndNShoW87uk2p+nb5zDtVmGL+Gg4HaRG9u\nxlVY0itEW7dDvkJlL4a5hTh2/BiGbyydjBS7uOFic8H0MSiRxYZ9+KQJ6GL6\nrinVB6bs0S4fwMzff9K8Fdn7tbxk54ZQ3UGnZZ2eq8yxeKp3kqTwWfCyTrqP\nwXa8xOHyPJQflk+YKUdcHlN0Z3nYLMz+ur/DvBORz82N5vhTKsKTiy5N970/\n96QW\r\n=WbKE\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```tsx\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```tsx\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"893836bad195885ee12f34ef449167c68cb19ad4","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.16.4/node@v12.13.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.9.2-pre.790"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.2-pre.790_1575721822056_0.9187155239322551","host":"s3://npm-registry-packages"}},"0.9.2-pre.796":{"name":"piral-pwa","version":"0.9.2-pre.796","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.2-pre.796","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"0043d6fee4df660cd232ee2f10ccb618da760334","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.2-pre.796.tgz","fileCount":26,"integrity":"sha512-k+ZNP5Qc0walkz/AssN4zYe6E82TbLv7783nfideSYlBA2W39L5kxon/UHqEc75GOR8aFpvUaR3LcP59OE5LkA==","signatures":[{"sig":"MEYCIQCvNmVDp6N2GWzISOCnH8+TGK3BS+cJneX0OY9Yx0jM8AIhAISESVIJHPw53GjfA368p5cmG7UygV3yQXoTsgoszAwM","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47949,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd7apoCRA9TVsSAnZWagAA3foP/j4/Yua+bQTmiNzCxEYv\nMRbCmj+aOuyY6QoDLxlVxutYZGxHFNcn8qCLt18/jV35Yt6g6chrgeGyRwHB\nF7H9NB+uoUY8Sit8Iw43+a6uo06kXSvP5BDDN9uieKranYzzBDMU1hJ8OHzc\nRhZElS8LkjIzwpoqk/kbnyYqiQyrcxEJmrSoqe5IbDXjqd44xNWi1NaxqOgw\nMO44+ht6SyVDhbLLSEPBVK9B85MMuZ0zo6Xk37QeVVvQQ3G+keZQ0GQ8bmvA\nZQr6012Ciip7NIHUNXVKCz2WHdyqug1i7Whg6O4s1uDm+YUEOyZyj4n7qs8X\n4+OhlSZ8P2tnJx6Y7JahmxCX3EEPwEy7TrSvX6oXL3WTXbAxK95xcEFxXihI\nNmnctwA/akj0+IcK5q6sNyevGRHh9ZiHoFwekFiKoaWkN7CrmMEq0KOQGWq4\n6dDzrZVa37tA6jHYPYqJ3DYE/diNTiUIq+eyrmdZ/z+Q5DW3YkU/pbICuxoR\niQekfYQitvj3BpEA8hzXjeVv2ZEcmOT+zVHJf1IUiH5mc6l4HMgASgy9hJDb\niy5arBUgGkCZaUNuY1s1sr97iXTWpIU6UrdoN9Dbv6BBAoXPQz9KnLg1Y/n/\neymeXnBm0TQxDttUwSDL++vOgOfYOAb1x54U3FECe51frzuO4IKrCxFCx7qC\nZGu+\r\n=zmTX\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```tsx\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```tsx\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"b23724f27bc5ec384c0f2c1bbb6766aaf32b5596","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.16.4/node@v12.13.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.9.2-pre.796"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.2-pre.796_1575856744534_0.05051826284024363","host":"s3://npm-registry-packages"}},"0.9.2-pre.799":{"name":"piral-pwa","version":"0.9.2-pre.799","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.2-pre.799","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"faeea7b7fbe9de83acc4ef812386e71a0edf8764","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.2-pre.799.tgz","fileCount":26,"integrity":"sha512-AXXtZYAZxGBn8Y3QCPcAKhWAWdnVehX7J0Q9TFe7hKPltIZEUZy2yFtWKjjUNVZe5KUybDmf5Icod7Vm+EUn6Q==","signatures":[{"sig":"MEYCIQD3NxrtHaHliZfXEqfjqCTqumpGaTI41hY0kIh/yOuVuwIhAJC6z4oDN+7ysmiZPLQmrtQGyBFWXKMaGFO5Fufbq4dE","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47969,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd7uBFCRA9TVsSAnZWagAANl0P+QFRZXy86sVx7hOdz68F\nRkkhLk7n9OW+l2QxRq0IXm5Dmdp4sjoWGNa/wDOz0Y177qTGxIT1fA0xo75b\nT4NkgZcZNXwAwRuTsImnN40wCEyng66ZNJsnoEzg0+N6qLD5ff8BJ/p1K151\nZJsCG5QdJxdJvbVP09RAZRXbVecBh7DXhRMi5kJNcAZcYt2jO5EvwEW89OwG\nFqWnb+L+YbrBqUSv+pd9k8QjFjpxE7oGmaHqDx1t5R8LmuXGhFT+GVhiXNjo\nBddnANmLDB5wPlbQEjpWagqEUz1MH8SDs2h5w2/7Fc/9A67KJWbEd6tuog88\nsZT0LQeKvJ2x8VOPBsCWmCm+chojIMl/pCyL9Jq0Mc6Ue9N2vwfz2yfdgnF1\nuYMCXniQJmtQMN1D10xauwD5rnh5lp4u9VQokays51+DrD9MAAde16yqWGm1\nB7fQ2SuzPPl7QiPEx4MJPb9hHZwAZvdt16+M3PR2kahYsuDaySKqF68BG9hT\nd+HCgWpVx18TQpNbv22hGh2Mo00aMAeI1EPGyey4b8tiUTBXC4UzFNFhsZVK\netgh5OKoYn7SxQfqb1k17N07R+ELt57x2Nh8BhuO/Iihtm9A+0BKyNpy32yw\nhjfSlV19YzWt9Ve4EtiFIpukb1LLgb0TfNzWG3rk3f/SzX9oQ2lGgU1gAd8C\ntcG3\r\n=tExO\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"2853163131053dedca749cee0d2e12ab980a82a4","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.16.4/node@v12.13.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.9.2-pre.799"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.2-pre.799_1575936068966_0.8979422114202789","host":"s3://npm-registry-packages"}},"0.9.2-pre.802":{"name":"piral-pwa","version":"0.9.2-pre.802","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.2-pre.802","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"16a32d79ebfb7eb65c63401a5b45c899594a656b","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.2-pre.802.tgz","fileCount":26,"integrity":"sha512-ALzrPmj4/x2iZC2hLYpxDBIOh3FGvdTS3QbAcnGzQSrEwmatDpMvO0VgbKavHDKri5te15FSHAnCyCjtVzgyeQ==","signatures":[{"sig":"MEUCIF/DhwsgiCRJRCGCPz+k+1r84oFg3K+csNU5D+tO6ajaAiEA4DgQmVYEWuLaFKIZ5LDvL5sIoNnV6xFWJD20VZ1Juno=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47969,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd7/LJCRA9TVsSAnZWagAAunUP/jahRVSDcHlOIQ8HOmTQ\n5wq794QKV9SHD3AYQBvpmo52rHlKxwXcsIBQ33V6tY1N7jXdETXOheVGC7/s\nXz94W68i4+SelpBCQF11xQS2PdSN1AQ3SjFsPOUCJX5+HqEeCzZLw7EP2LRz\n7sCfRw7MB4wuyepZ0reb6QKdUqDkWm2o5eaguF/jVysrhZ7Ufeqze2wfx+Zl\nD6YJlDrp/CbzaOBNUFcPBlJ+Ee9H+mdrjLUABte5nl9GGMfysfnTSOqKOsxr\nNOANBLlc5XTGQ3GZzz+GX/g/rFbFyw/TexG2Lm3BsnWYU3qUkXXuc+LFcxSP\nsJo1CfEZ3lq3gpc08D7kUqZEa1NKYR4Zur/47QZujmvOi10NpTIsQUVnER5P\noBzdKgkoMflVFo6coIqijxr+CH6e/gOP/ocfWtBxDhROiELt8LbKA4GTpWgt\ndXCZ0HqizClyYlpUJ9bmzZTzJK2HznatbAF5C6/7Tn/vBYnR82BqXZRuC5+u\nJBhtpupiMjVG8Ss6TkY7IccfppEkJ0OA0kzuUOPY3fJR96/xOFlojUiR4R7T\nhUUYHkXgPirdIzD4tk79s07dIfzcAFWg0+MC6fl0v9oWDp/qSI7SLJ85dxEr\nkOnV62j5NYak5NyE8g+hIgocM09aeNeRy1l54Y6kuq7QxlhVz++1f9KepluF\n/Qka\r\n=ikPh\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"104431a169c589745fb554e4b5daafb4e3935c7f","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.16.4/node@v12.13.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.9.2-pre.802"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.2-pre.802_1576006344984_0.9001997128196588","host":"s3://npm-registry-packages"}},"0.9.2-pre.804":{"name":"piral-pwa","version":"0.9.2-pre.804","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.2-pre.804","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"1e8cb4dea0eb3700c9129bab5dd52345f870e68b","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.2-pre.804.tgz","fileCount":26,"integrity":"sha512-2JlqTZFQO2C/O5WIdQA7LrAfjGa6ZtppYILeRqzrN9Fa6I83OwwNQkRa2F9QX4a3QzTr4B5Qha/vPWZRFJIJOw==","signatures":[{"sig":"MEUCIHpOBovs44NylgAON4CkPCFfXTz+/foeXOHfU1DmvpegAiEAl3oE8J+7MYQzy+esizM38euc5K4LkhjjyQBCco3/7L0=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47969,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd8DZsCRA9TVsSAnZWagAArU0P/jRdHS62RNOTBa4gM4Nk\nteBgCv+aCbEvDu+7akXtdvSFQjg2+2J0z/ptdEXBIbnKQGL6djoPViaBjPkb\n6QMJ9SI2OO1gPwnKnvmQ49+92OIAoedtdwUmwPewlLy5tGmuZ/HDW2q2AcXZ\nUEkzkwbLO87P3AL23SrHRTH/SVJ09fTo+d+Ycx3/lm+NOTpAoc4uPWyC20z3\nNWiJhue3W0NmJKXPBRd4hRFTDTFNGZiXsNt64P6UF11zMZzeOD82iJ4YimTB\nhn0oeUZzCnJWeai0vXd9tiR7rV44FOjw0SrLC18chm5woXmQlRqtady4qhOv\n95OXLsopLKNmhtvcwcrksB8PVBNX94uTFxidmYU9n2bezyFOFhk322m85j2C\nlFJFMmob5XpTF/TooPxZoYrnOeBZeSJ9V2WtLwaXsQ8qyzp8IlRxV1R/cX+b\n55NavNH3e1F29nKAoXJIJinWY/t6cDgp56Hw2s39NnJ3r5E6rkGtizUMAXPO\nLMYdwqX0yzImAeIwrHYfCUE0V8Ljeiz2LTtcjDkTaRrQlasFHHPzz2HOugFO\ntsvKHjgoYaCtD98ePznHhM0U9s5K/NTHUwxamT/Ynf0eKOqwQ109yPUnpJO+\n+unS8tyj/IBD6eXDtLlGXLZAGgXZMgtCkFy4+SQFYpXbTOI9JspaeILR2MdV\njJKw\r\n=ePzJ\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"25a519c7533b07d09c59f0fc2bbb1de1209a7ca4","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.16.4/node@v12.13.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.9.2-pre.804"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.2-pre.804_1576023660365_0.002533235549342816","host":"s3://npm-registry-packages"}},"0.9.2":{"name":"piral-pwa","version":"0.9.2","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.2","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"b67a6920d533ff1840a27c02e4c82a89a66664b7","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.2.tgz","fileCount":26,"integrity":"sha512-yfBHzHoIwFrOPyEnJzXw+yym9d5vvWKHHfMcD3/CPaUVgMeA9ZVpkhli9T82HJN8bF6buophw/tNOIIA2ExQiA==","signatures":[{"sig":"MEQCIHk11VN/f2pcuWQpxcq/wtMWDiCl+YHNnmuUicVbFeBHAiBDNtorIjT6FUYgvebPFTZRvZ2GMFBjUNiVVycHpGzvlQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47953,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd8JPfCRA9TVsSAnZWagAAQNAP/3TXbOTU2zmUUerIeGPD\n5iNFFB3QPDn5ujPi70teK8UA6gvtX0ilsfGYqM7Mft9UCdQROrNvkfGzCxjk\nR6plZherUam7SWmKjl46aCTL1mQV/P6kIkhF5dfvtPgNV5tYdbYNKpHb98FK\n0F7dLGLrsOClYhd2UeOZuU6/m66f5egtPlN97stmhlG+j4jpj/o+1bJ4qVVN\nO/Wb/OKwj2oeFaFryDDJ4ROSya40zGrTNi8ChlYWviuFyNGcE3MRx3PN6Thd\nG379To2MazXmS/JhLLTZZauLuInwrtxB55MJEtdOm1sBOybVn1hTfAESrHEk\nsDvLQ6rMvWtNDN+oQAOK6xqqrJsBxfAWg8pL8J90ZWnTXj7ERXrDUYAL0L9e\nkCMwnH6zcVxGgI3seCZMk/sGB5lJyKN01cqq3cOuU7berFrfL+Pb2sB+GhPJ\nWJZsYwHBNFv4qdyP6Cl9ulFMKoiF3x5qIg4TCmnmDyMvwqCRRxHexr8jCwpm\nox455Hdxyv6iSAYHETmwxx1ch7y51w7KNZSVHYcgHGb0N5m53uBqNUNu8eWk\n8lQLg1KfkoN+SAcbCSt+OYlLkETJh2btHw+jrt46w375cXfuJSF7pP+xq+Ds\nk7QG6jUXidl+8AfdZOXvvKqqkZjGPrcCk98fUbaD5GTG9PUgGIb1GW3VxsMl\nOoTK\r\n=8FS3\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"cea779e782e08b2efd4104b5b6fef0f286779cd5","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.16.4/node@v12.13.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.1","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.9.2"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.2_1576047582602_0.6837556015811603","host":"s3://npm-registry-packages"}},"0.9.3-pre.808":{"name":"piral-pwa","version":"0.9.3-pre.808","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.3-pre.808","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"a9baa132705ee03e115004b506dbc189ca9d59ba","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.3-pre.808.tgz","fileCount":26,"integrity":"sha512-oygxYGj/8CXsYzzkPRNIIumh8Dk8rgtTKb4/bMFgGrj9e9bBvmZOs8MAu6mYNwGD9IaSRkPQMERZtFxPwftskg==","signatures":[{"sig":"MEUCIQChaYylzXkF1RbrnGzJtLAjqTXMAMmStC+Ua625HyTHbgIgGX9TJ0jAG+YAkZum3+63op2f/wO58m1n8AsxfwBeVVk=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47969,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd8t8LCRA9TVsSAnZWagAADVYP/0BIVNnjzLuGGaDdfXrQ\n8VY26/pMFOL+6Sgyo3AH/luc+EdI+XHPI226aIr3XRIx519dJuvnsLMr5C+P\nSTnN2LLflOFwk8mtulk+fucGeW2/iOdjoiA0f3yjj/TtEf4ywalWUQALSGni\nTO2o6rX4zgpj0xs2du9B0791q31IrDrsHs4k52t9D8hdJvF3lA525VmrRk16\nw+AQDMOdQv6i8asQerkCWUXMgcmB6xjxCNSIc29ADDLq40o1p0Qqquht6viY\n+TfY8U0HR8Ng3AjTUNxeRX04VpgkmrerrZ29PUxvGqq7jveOPfHAgNomAR+D\nL/KJFCzi9EKGOL7XIbRCZWPjo/YkBpCpRnGQKO1RQNSmbVxM5OZ6U5vceDI3\nby5Kui5PxR0V3tSYaagLd3bmZwevZzgzV5oaBH5TfYbqvQbn5cB4NdZZjSqD\nLAWHk4AwXvPSJK+mcG9p92pGMv+yPFXZd8A7rRCgixtZdnU9IthvLdK/CvD7\nuA+OMaKVcpxxC/T62EbgCY8/f2jvchMg1mJvdBFZ54aAU2B7GSJmi8PlOg7I\nuv1NlhxEuFmwH5oECpYYbTPgWC0Xh4x1KPbebS5WPyfIf7zeU5AT6N+NCKu4\n2hptgfOx87xajiHpTrQ1MrNhSXimmTHEyQoxK69t/NcKUYVVakN6k/F7pUFc\nIgCb\r\n=psBG\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"987fc7d67c8638ae8897ac281f7dcaf9aa67a295","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.16.4/node@v12.13.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.9.3-pre.808"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.3-pre.808_1576197898694_0.1543045824138667","host":"s3://npm-registry-packages"}},"0.9.3-pre.811":{"name":"piral-pwa","version":"0.9.3-pre.811","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.3-pre.811","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"b440157523137ec1fa11d4964160c8e321914568","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.3-pre.811.tgz","fileCount":26,"integrity":"sha512-OLD3NTTsUev4Rrpz5dluplu6F7k4fyfGojYgUBXAm/wPJM5Ufsvmj3j+xD7V69EFQVeFP6LD1o/Gdf/1OmU4vQ==","signatures":[{"sig":"MEUCIQC4QI5vtu6p8xRpqqjWX2dYktvojv7bSB4Iybqxl81OowIgcM/CRDAFeM2Gdw/bPm8L82itw8N6p8scmSDW+yU+5pU=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47969,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd94qZCRA9TVsSAnZWagAAfUIP/1NS9szGXT5+n2ljiJq+\n+i3wqkzsA14bcxlQaiziCHRFgF4Ibyp3wxdg9yOdUVDtVcA9t5Bvq/Hvr4ws\n1HTmeJDrYxgrF/7f59n92TrNjpMLZQ1mSA737bhh9vQff+OUDfpy3vctkQQh\nDq0J33lGUA1sIBKrQmn/Mdg2tLRFw99dciRqc1aRVpDd1cUBO87Yi/avcCyv\nYllPzLgiHV4tDCdmdJcq0Gy7PgLF/CA2QeHgq7hhjetJaUKJ/YQm6zhgGVT0\n3m2hVIQbicn0X/XvfwcA6szVG1ZbpweyDni/HVTHo0o4V1H7RqpCLwAD3e2Z\nHbW6x7yeqZGBy0tIXDF1R5YXSS4gOmh1D/9Q8koKnLkDHdWx7xub4PZSu1EO\nsfZriKNLSBnb+u6zNxfsYtSw57d9BBseNnhmG6od0SXhCf0SAYkfLk8GcsvC\n1h5atNuAeDgbJGpVhtGx2W8dtVZ9iYid6DjD9RzMBqZKdK5OkCCpzpRaLDkd\nHVjb32hMkTAmLrbb0PU6CJKIkZkxMe5z07ZITmTTK8HjkBTe2iQa8QbliUKr\nrfxV8KWzH+2KGCYJkwovr3dsbGj7jVs21rNXHo4SDkDNwPkQi2lH2WWytEV2\n+A70qjkdwRphMY+N06gcHVlVUSp2ZsfD7cmoFsGNFtte327BvRB7QKVIcIOa\nDCey\r\n=G1b9\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"959564a1187da704f364977b2b1eb4c13075b7e1","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.16.4/node@v12.13.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.9.3-pre.811"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.3-pre.811_1576503960637_0.4549980598853858","host":"s3://npm-registry-packages"}},"0.9.3-pre.813":{"name":"piral-pwa","version":"0.9.3-pre.813","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.3-pre.813","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"c91d1a9a71a6816307983cf4ede25160c1a354fe","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.3-pre.813.tgz","fileCount":26,"integrity":"sha512-pPKqEYK5qdiaJR9IHHaJ92h8/46EHOPyKwRJpFoimyRn7R5LvNu1SaswTw3qYVdyj4ZCcTUpxzLihCSj2w9mAA==","signatures":[{"sig":"MEUCIGLCmwOZ6SdVk7+qJlF0y7T627WXNETbZoTUFkDNEiabAiEA1egqZMm08pc1VDDi/C+M1Ym7XEawqmcdho1uSJcSBPw=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47969,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd9+DGCRA9TVsSAnZWagAAnowP/2B/E3keNw1+XIqQwGLe\nLOEwpt/4I6JV6uRU4/n37yDnYcmAGBgRk8hoYbL6df3wI7hFsHHxHjggGB4U\nkkzUxqv8PNHGu8rmxnS1grboe3+M9yuxsyradSJ8xDU8wucYRwU1lZf9wiob\nyRsmm9iZQaPnIWGRG0hgYQW1aQtlw0vhKIbdaIKTHRPZ2Dwjw5B9ylIWjKVe\n82NnCZaYiZMRsgHBWysxDy9aPq+1zHsYUueREMLPg4uX8kGMdnYmj68Y7MVa\n98G53gAWlE+Um58BBHo/niNZIF4yT5TOSOyolgl2gIHSj9N9zFqiGDFFj8JE\nmQtL2UIEfnATAdVmeZA/bHmx9JoQWH4F7SKnZOwHZsS2eO76MB26WGf6pQVG\nyPfD6AqJpoL8GsGAGRRKDIrx0FLlDDM6um0RrNOdxurWK6aC7VtoNiKtQrIL\nY3m5yfSZE7WWSppxbEA9W3wJl/6bsKsxxFiaX5PSwwjw3p8l9fkwOmR37qoS\ndSvarlVoyJ0C1g9YTTqhFlsArSPmxODSgiDtxl+lSorVf+6IxmoK944gvzr4\n9e8OA+c2/+cUCOYI45Bi8xuSuz9+K7N2uQky//BxDKwZ0tgcP9b/xxYlasxv\ndyhZajREJ50PiuzncWrrW7AMv3t5mW9/uoWy4TTm/FXYt/kpvRDevqcDGzd0\nadDQ\r\n=oqZ9\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"86f602267289f15d7871b033740ea7b8967dcb9c","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.16.4/node@v12.13.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.9.3-pre.813"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.3-pre.813_1576526022501_0.9984790571777593","host":"s3://npm-registry-packages"}},"0.9.3-pre.814":{"name":"piral-pwa","version":"0.9.3-pre.814","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.3-pre.814","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"7cfa2bb856fa5f8b11ece13b2fcd1f5a9c05b112","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.3-pre.814.tgz","fileCount":26,"integrity":"sha512-YBxWmfWqIDvzUQ9v6F/NRdpkvTdgkjR688jwNjBZf43d7pDMZkeefmpa0SRjqmVKxxgEsRDKnMRRjqL2lRPJcQ==","signatures":[{"sig":"MEUCIDZr/tXg53YQEcmCrzSVFivXD7DHbPpCNRYIzmfD7BJ+AiEA8DPRfnSIZbsVk9NDY5bwG88lpmDkEj0kl+0S7Wt/a0M=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47969,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd+BURCRA9TVsSAnZWagAA3j8QAJaYJnRvI0TwSGj1jXqx\nIQmKZGw/qpwGde3aT6dr99e5Vo2jrEXxNxw20XHfF4EaS/tQUQWIpuqoJzot\niYMZq2bCTFFw0H7jqesG/23R0aHLoGHNY8cKvKwczrxcWcAKBeFjAcfAT4Ct\n8Ysb68w1caAeRI7gSV8f1j89BLmBOW0BNCi32tvzjDBSK5NPEyYAfSzSj0mC\nxy+sS14z7KGLTixCZPwiNfMwOr4VZu1ETQVJZ5k+MlIAotfhjz22lxs2B033\nZfHGP8DEg4x4LYKO/iIUWvWCoPJyyD6bZExBxQ3Iu5LutUGF4CC9kQD6yhPs\nueLg6fjmmrkmobfPk5A+jIqXAQ5REmX9ZsMAepSItucOl2NZtPk/80GjCOvl\n/+q3H9oTFg+OwyI4PE/K2gaiIqLXNvMeda5L7XlgA6YP51q3KUgaWc9R+1kZ\nwDi3Wrb6hf37kF2l2NdLc5g9kxVFX0JqS9HeVkQHAX5PLHbl5Htytf69rEV2\nvkE/mOMKX6LEgcC/1f42bxdjuxxCG7w6RNsSrBm27/NnLAtAdmYfq9AGz3Ex\nuRA5iqnFeIByhZoPDTK2qAcsRvFm9dMi7Obku+uOhle0dd1A1YrsYdNLdD+j\nzhYn9J8MCtG3bY6Uk/wFHUKw+v7yYWbi/9ggmLittgO9nMRSWiloT9PefVIp\n8Ppa\r\n=ojvu\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"ffe17d238dc042d56ab11ba94c5d8a64117436ce","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.16.4/node@v12.13.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.9.3-pre.814"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.3-pre.814_1576539409095_0.3119624659678282","host":"s3://npm-registry-packages"}},"0.9.3-pre.816":{"name":"piral-pwa","version":"0.9.3-pre.816","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.3-pre.816","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"651624bb879fde61ca3b97650f107add73ac76dc","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.3-pre.816.tgz","fileCount":26,"integrity":"sha512-snEwDUsgnb8sUA84GI2mLJcdTQKer4HxNIvttL4cc5AscsGVYm8XtOHjWctc8WFuP+wlGDwAZKgJlJLS/idEEA==","signatures":[{"sig":"MEUCIQCiOSC5Vl9Ca1TLncPQnGMCqAoKHkH2r3rA3JKgb0noJQIgBLhEgj4+8gxglA6AC4ILAQRlIVw0GnySvcfy8GQlnKM=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47969,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd+CosCRA9TVsSAnZWagAAFTgP/3HZ9vPODJkW8so1Cki0\nFvlVMHq/OlwCdAoiXpE98LhNQ/uvYtBpm5GoH5IrNTuHD/VxuO1tM0d4gk15\nl9aGM0gDzz1lZJGJgTfGEA4Vnh3EeWoddqghVcVGDUZmBzoZtHxNvygsObc9\nEAMdVmdCf/qXpUH7mD9A2BSwEIdvJo36MpBsIAm6JORrSvLP3zuO1XRbWtTZ\nBj6mqzqI+2eXrOFtwn4VWSRVMwHw2n752Nb1AsNsrPVoIOX0KRUf1XSiBt+5\nT3TdYbQWFjiX6CpVYcMRe3Sx2eoMeVWccblmi4S7tHUc7G6ifSZszhmDiXdo\n15YmGaG0co6bNQAzCIwNU0K0KzluB7DEkYE3kYZAzIzr7skhXZrFWEmczXUI\ntBD+Ayy3GGMVX/p9784JHp5x885iUw996nYDvQPRDhlq/OtfTPW8N1Qo4kTG\nZ+SwqTM9c3RN8VF67jgZzGWhOsTdD1shqRSzB7TKxyNPHBlxh/fPshZwfLrT\n8zTwgpecsLrRrraPeG0ddWXwxFuI7rz1sTdmsr5rytqdrCVvsUxnWlEcDCIV\ngFXTpOwFWqR38pNPwbbMYaTxQZlzuacTiC5FKMlSoxtVd78FhIw/T5m7Qhoa\n7GA2H/b3Rj+ZM3HUcx3DU0YNs9e1DkX9xpmw63iwHpfFwiHA/c6+72yb+6ns\nVIMJ\r\n=ZJhO\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"63d278a1cfaf6788e0befb7a0a110e5a5bf3da2a","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.16.4/node@v12.13.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.9.3-pre.816"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.3-pre.816_1576544812176_0.2797103676015269","host":"s3://npm-registry-packages"}},"0.9.3-pre.818":{"name":"piral-pwa","version":"0.9.3-pre.818","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.3-pre.818","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"8790381327d0445249fcfadb40c42e5b581dd9be","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.3-pre.818.tgz","fileCount":26,"integrity":"sha512-NV4MvXBVwiKLQxhiiPlgGjaOu+lTpWdps/EJLG2Vf9cp1eIDZ5eccvSW7uB2FWN6I4ZON3AKWzj0ztXLBm/rcg==","signatures":[{"sig":"MEQCIAVkMxuHQGw/6uxLVkUrpfICc31SGe8+L2V5eDtaVo9wAiA+6RrdveK657pMBBco3+LSUMT35fL3vc4l8QuBxpjX+g==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47969,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd+O0jCRA9TVsSAnZWagAAHZAP/AolDiZYCO+WDXQCUFH8\neM5MbjYksRh5uo60+nWB0xvp+43uYy9XRL0ygsFQbvKlnpTp/PJZ8B9UAPDW\n4J3go1xmYxdDMqLMnrfnWcRjQtTq116QVW5KSjp3xsRxey5drdfB5tmRHHYq\n+McTCQuNdPCn7kUislKE3dmWtNfuXMI6IfGwVSM56u7E3rL44Ao4A/lp0keV\n3GUoBhkv0+eCgB1tuwWK92PPoacx4CygSUbNgu1kn79NwT2PGkLs6iydFhW5\nFS0zUDd16JtJLtA9PgabBCwWcJ7Aib8ZrbsieEgJTixITSalD6205nKHO212\nW0rLJ7xQXMW9QyLRXpxza9QrtMScpd7ip36uMtnl8B2yCFbiAgUQkoYM8ELO\nhpw0mTdnwCx4Pt1syUOs7mahYDe2mDRWaAdHw5Y+DrHMEPy1ovwuTs4oLyhM\nCHoV91v4ut5fz+Fxio/Fow77RJnVHuOCVKTv3vXOFH6Wps+F4aZtVzBAbYfX\nnq9uFnUy1HK7EroJmHaWMW7r/m/rVPMMUsXycvwbSfy/XPytODJ4DhTbmWg8\njKWDKrMYh1aLzKUlkBeaJvrByI5ac0JLmL3sYtXt+lumXSYG76SFbudfMVCo\nD5lZDgSSowAyZKwdvDl7xnqeRI/MOmYYnNrJ056ySOfWlOB+f2O1KdAR1SCK\npTsB\r\n=wGRk\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"419737e5bd29f42c9b5397d2eac59d7069303903","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.16.4/node@v12.13.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.9.3-pre.818"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.3-pre.818_1576594723516_0.4373318525368528","host":"s3://npm-registry-packages"}},"0.9.3":{"name":"piral-pwa","version":"0.9.3","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.3","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"cf3923dbc73d76ba8e96a9b2a7efc1ae7105ebd8","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.3.tgz","fileCount":26,"integrity":"sha512-k2uYHV59OHzM4tgjSqKPbFLF3HdCIfUSV8V/ZW9PiVtyJV3r0uO6Q40wEwJPYflTflp8VIYzqR2LKqAtq0SffQ==","signatures":[{"sig":"MEYCIQD04FziAXFidcf5mzUlaBowtAP6XNnW7cHCVaKcqBqGIgIhAIBTv5wpUalARxDJFsL/3OqraXiNcQavUpI9EPS0une2","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47953,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd+QcUCRA9TVsSAnZWagAAJJ4P/0oqBIyBK3IyHtkQ0kto\ngdIW5Rh50+8tx5vikFFr+QzvGEYR/uOvdjeasoBDfmAeIpOhulsojeJj9m6a\nn6XC+cgaed6ePtpLEixKB/xQUF+U/Sw+0WMm6GvSDKgvtRlQ9OgNGwQYYtZF\nfVENMTovs3q1qVPjlQB5xSWxaa1HS9BL6t/yk0i+ecJ4O9b4HzjMHf0GhGtt\nYLRmYlm8Twr5UAUtXAyKMWngr6q0D4/2egQkEDmG0d+YEF/naM6MERLyYtjV\ntw91i3K9ux/GbFwkhyDdHX6UT+dMO5LTJvd8dU3OLY2ta1SgW5vIItlTPxaX\nrWy4YIWCipauW53LrYayKHF/j55pWto9tULY3WJymkVaInmAfDPU4IlsAY8s\nIeucQEXk4GZ3nPO9mLtwZpxqd9mVc10lLJbsaXdnOkGOXyymd4etPIRNGwNT\nzr2pQbZzALObT/NC0I6gT+2o89Hclw5T7ZfwCBne/xl12QfoHJohNjNAVJ7t\nD9VObyqspH0bD8UjhBgisGvmyoCvbTLPpX2NVqAmrXoUjXEUZmMVe9l3K7oE\npo6f4/FwwShgku065+143K+D/CpZ55oojNTrkVWOoA868MGjwV4pt/aPjnyY\nWHw/TmzirNisJVgOeef3hyCrKBLH0i7u3Jf1ONCI7/7jZ0AqISLxDDQ5SEjS\nNd40\r\n=RaID\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"a079ff637821eeacd28f1209593b778e370d0366","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.16.4/node@v12.13.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.1","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.9.3"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.3_1576601363834_0.3738090108281149","host":"s3://npm-registry-packages"}},"0.10.0-pre.823":{"name":"piral-pwa","version":"0.10.0-pre.823","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.0-pre.823","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"084b2c3ce046fe793d0d02f22a8d25af775be7c8","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.0-pre.823.tgz","fileCount":26,"integrity":"sha512-KB1wJIwciRmnnLVtEQOmhZq99EWQWayi+KKw62eeikTUa6Yeyf7lBf85JG2brhukXxInGu2OcDPyI9aqsFgGYw==","signatures":[{"sig":"MEQCICAJKG4jOvRoIMEOcePpqpBBGdGe/w79vwJQgsw8uV+pAiAeuxnQyai3GqRrPpWMhsFU2RiObVly6R+aL/m4Q+nEUw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47982,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd+azYCRA9TVsSAnZWagAAhv4P/j1kkVsGnItHkKueXgSr\n/7KtZWDhTxRDkQ7pMIMYGux60J4VYYMHICOWbP46AJ7eIIQBTEoITwKlaLDn\nefFh/iRLtBq9heXAqGOhXUO2Fx5Tof5jo5l0Dx3h0mloaB2ikw2kZxF3tqn3\nvbjsPI5XPQPX482YC9sRhadPanXY9qQd1A30RLMnKHfoSGIErLcLhovr991i\n3mUKGPLpM107AI8tp4oT55KCdyqFONGM4QMxeyEayglNS7Gx1L/mP1EooA2T\naHRkyr1vG9sb/WpnVRfuey38mf+6P7x3hfmkv+J167Vm6ygI8JkIcLU50DEA\nDJdsFlAJET+17PvcVaeGl1rAHOFA1/4X5+hdmnNoP4PITbl0wLvU/aDptppD\nTZCTn+zLEGJ0JeLDa+rW0ftj7ElJ4a/6Gxk6u7o+icKOJ/7tKIMYufsnmd4q\nyH0SnWJvwfObPi3GfsWGglI976JSmIpCReEVumPqe5zl56TElm0gQSfZbn2i\ndsfZyWr6P1q7CMxbRTioBrHiW44Ul8LI0JC6ArWF3ynGyTgvwQ6U6vZttgEp\n20jvsta2zRPdHVnxNAJQ+hUyXUFZAjpLJ8ZHDDyxppkR3X11PZSmkfvbwVIF\nBT8KSgQBzfaPHaS5ehPvpY2wxEFaToGyIl3DBqWyL2/UNnPksWQe+QO0L6sp\nj5ln\r\n=OfEn\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"6ffae5945e28b7d86c7701e25aa3b2698e32a985","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.19.0/node@v12.13.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.10.0-pre.823"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.0-pre.823_1576643799707_0.31236153035426817","host":"s3://npm-registry-packages"}},"0.10.0-pre.827":{"name":"piral-pwa","version":"0.10.0-pre.827","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.0-pre.827","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"3bafea94df7cbb4c131e491e4beb8ea253e3abdd","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.0-pre.827.tgz","fileCount":26,"integrity":"sha512-TlilolGvReEvheoWxXlm1qz7xsrizuOWXYqgEUveE8Gmnpjncpk/DhdqvZrrgWs34OXtUA42fXNc0pEP5ogltw==","signatures":[{"sig":"MEQCIA8Mds9JSvNZMmu4jrYh0VcrmJyPmLdcPg3cxRKlTqXoAiAqImd6CNxT71PaKFvGGgo/AJr8JncL4MRy0iVyCfMwfg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47982,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd/KXUCRA9TVsSAnZWagAA99cP/iCPxRmEGDD+DgKFvGig\ndTUtMj6aQCLY3XO7fmq5OXT+RycUf6JRsHSTHAM+YhvlNaFHJfyDKj01q9ce\nyEKO00lZ52iE+N9UWJHveUAvNITG9rgAW8+IH/Ju6/8L7zqpyyM87ZrqrMNk\n0cvC+5yfVjiOY2KfH28Ec/xSrr0crHsqs5t0W8L0Ub7iQ3UuwOuOAhm7Z69w\nHhmMaxI05l49HmBNLcSyMSddZ4EiPjPqIkXHjJ+VJZtkzKChEMAARBQxXdpj\nJHK8hE38h50uvApOMtzzTPwvX1U2jArBaqNiPn1OUBHUAZr3Me4h2VLirUNS\nJvgsPa4nv+WBv7+zA2ciKNtEI5mLdGDVsusB8z0EO4hzxBFThM3VSgs3ZpA8\nERgMWEaLAMYiAptAyFtXUJpf7I9SEHoHHE1gmDCqrCD4NHKDOJwQ/JEMn4KR\nfqxORxOUwh3t+HOgHvjsnE7Sp2pV5YHX9B8L120epiKzWcbnPs5oBWxChOln\n4OPhlmvw7rPxilS+lVTmWNUI98yawnweCeOboENSQ7QfwHyt6MllRnX3FgBe\nIvfegoZCkRd0sclYHPeGO1yTvMCk4G4fzCUcywskEC6MKv0VPYiklazqbdcL\nzNU/sCERDbiQfRBrVbIj1F720RdHRMI9n7bEIWIVNXxf/NLW6O2/x5CSaUMm\nRIOw\r\n=psDs\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"63305e6256095629479040df80d7616bbdd597ca","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.19.0/node@v12.13.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.10.0-pre.827"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.0-pre.827_1576838612500_0.33943963209082617","host":"s3://npm-registry-packages"}},"0.10.0-pre.828":{"name":"piral-pwa","version":"0.10.0-pre.828","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.0-pre.828","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"e309b025a510ed30150264d460c6b3ce2b389a7b","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.0-pre.828.tgz","fileCount":26,"integrity":"sha512-NHDdoS2+kbB2IS53EWxbVqGIld2qTGULGflbtxpbs70wVZsJZCoyggdMJTMOIF2gLthCjXeHB/zjnABGic6IZw==","signatures":[{"sig":"MEYCIQDA+PLkHsxrPrSO3jKMaFhqw50MQQSOFvffFmS/xMI3sgIhALLkssHhw5Bs8yKTkDDItCiEMX+LuNS7EkAyBvRsK2lq","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47982,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeAADVCRA9TVsSAnZWagAAVtUP/1Q66N+XHZgSxm4UkVBh\nmbscFkONXp6/hQYi9GlsTe32HuQ7R1stfNfS+WXtqgojg4bljBSrpOrjfs7y\nXtvCOuyoYks+/DZ9QJwlTToad9CZ7NQn85/QKhWKxmThnIFrG0aHP+5hvsR3\n54nSxe/s3GvxsxmgwXOxMJ3S9eWVAHVQkaax9++cer9fzDIF5iZD1Wf/Tvr+\n3HSH/8uoWIJb/ATwJd2JLWGj6C4j5jchYC1YP1wF7QQJzpsLNksvar9Vu7JF\nXBefx/FtA1RuuE1TDzDaT+b0PvRJrpQsyt+jT9yYRBhFwHnN0maHoYjif7GL\nvx/KnGt7HoWeHRPsk8oXYFciKbpeHnx/5Q0VQ8IabN3gxu4y7QYzWcq4w4OI\nqzSxn8gLYGc4+vkGqFl5LBabc/xea2PEYp+QJ9rqyDt3ZYn0m1XKKUFCpAN2\nEjxXEvVUdFnC4sA7SmOKoubgF0IDVsv1X04bFg50hBhLAnxLg1OKXTHIk2to\nWam5FC8L5eR8QtdiYE3AaCDN9E1vjFuuewomDtVTmbRBvAWOsUaxTO94Wfrm\nVVdjSe6QEtUlHu8jRfbQfKqIZx3bXZym8FVIhNavPnRt7cszYvwRXhNKbHNO\nSUHtXC7y7ATdJ1FwoPgLb6V61ZI2tMEcAhyToioOC5chL/jE54iH0VBLIuNI\nsLgs\r\n=tUzt\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"a44758f42ec541d9bcb9f8cf39880fcb050c2934","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.19.0/node@v12.13.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.10.0-pre.828"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.0-pre.828_1577058517156_0.8225734905902837","host":"s3://npm-registry-packages"}},"0.10.0-pre.829":{"name":"piral-pwa","version":"0.10.0-pre.829","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.0-pre.829","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"f78a5d71322372d59ba3f6f85c50722462635f19","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.0-pre.829.tgz","fileCount":26,"integrity":"sha512-ToXpKLUtaUZDGx2TennYku/C6YFQugIrZsJThLXF7fnaz165YbILwPG3I+kJ9Uy6frjG+5s4BkLISaRgV1qHcg==","signatures":[{"sig":"MEYCIQCQYnbX5rrjql9a0TAuX+Lchm7K2CskSmWL70sv3LPl7gIhANbSmM/fp4Kag5kWcrMD9sgIvHddVhgqZ5nU7hjwV4tu","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47982,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeA/rFCRA9TVsSAnZWagAA4ewQAKQ8Y6h1hVeY+gH9V6Px\n5M0JTwKTcvN1Pjwg1i590MRnmey5ErrcZjy1hJ4o9u6y27NlnxGv2hr2vNAI\n/uWG/6xqTklijwhBEO4k/U2pPqbtE5SvZax7GOBwtAfPDlp0Db44uc29pe9X\nPo0PIDPuesz0GbsuWw4BCUZM+0mvdkM+jA2Kr0NPwAHy0T4LNZ8KmYpDqNyW\nkRtH+xTbijtaXZ63flD39pZ21uwpJmpedj9KVbiO0wPHWvsl/WE97uLJYn7e\nVHZxWEWEosYnvb6yyEyW6EXiMHp/xwfNS1m7n30ixbTl+YzQC+Bd4o+kjCC+\nq+3l1h8Th8pPGHkvJg35wTwc76EKw/1G2dZ8WyZ7jFJk+3KnPosxNSReFtgY\nqj58xy1VQMoysqywdLdGkKO8zq6I/tXsEwlc/W6HCHf6XKOMwCLKV9+4vpRv\njBOh/EmP31gO9wmZgBhy7dkjhyL4UV73G5so0OZwRV28FeyS5WvXkH1iXPY+\njMTp4zc0DQjFrwu3yvO9hf+O8XofCXD5yUxLk14/0CGs7WM11bFWLfc3V3Oy\nHmElNo63fnaUCAphkNQG2qDr5/pKCjak86fTFLDbPWZnxQv/3zIb9uujXdM5\ngmgfNkhsZfNgUJuA3XIX2Q0TM0l6NJ1RHXQexwtME4caZq64I4u/q/FsLPZI\nSKH2\r\n=5x1m\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"94a14111028167c8f8fc045ee49d305693252090","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.19.0/node@v12.13.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.10.0-pre.829"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.0-pre.829_1577319108914_0.2595642530073363","host":"s3://npm-registry-packages"}},"0.10.0-pre.832":{"name":"piral-pwa","version":"0.10.0-pre.832","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.0-pre.832","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"ec271626dde15eaf875b6ac192d0490615256b08","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.0-pre.832.tgz","fileCount":26,"integrity":"sha512-GC57Hs8QpYX0leRK1QyB6ha+9S8MDyFv/bHgikeN4u+37pZbugNNSinsZPm3CAm7c5E0wV4S8VaS3NSk7wFRqQ==","signatures":[{"sig":"MEYCIQD+/rS2ngpbJ8RxZce4BHxfpbfzuJYPK/wWwm+r/nEj7gIhAJSuVfz23R6C6G7uiFHf4UGl0G7DcHPufZ85fjTdTSqj","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47982,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeCkqLCRA9TVsSAnZWagAAap0P/2mk9F7p71J9/fn5dYL/\n35psHalO9r0yLYOlbTEPKdNW8fB1D9RvfJcNdywzOW0XovSVA4ibcheufi8j\nPSbddSFSl2EIZMneHUYL0Bq/2dpCoIsD4tV0qn+vprLP6sKVc62l+6FcjJlF\n/uF2bEc/qY8WpVWANr76ebBr+Tf4JZzJ5S1+tS9j6++Fst6gfQLsXcyaD6qN\nyj+0FRMvr22z+OBVFyv2mgTw6RnNVHBsfD56ucLkxT/4R4pJ3uhLY2ParlWc\nC2gphle9b/umgrr0gLZoTXBLV6ZukFpmtCvu6YdPXO9qjn06LwgCI8UhquX1\nvFJrtbSjVucnu3A4URSKdpaE/8nP4k7bOg6u7HJdU5MZ3CQLhIiZ+5P7gGWe\n0MQNtdDKympj5WODEza+5jushd9+dXwTjwqxodf1e07MDGDdJdN4TqNhbiMz\n4y1iG9rVMd0jyaqUrJYY1msvm9WspOiPoCTDd0ve5KLME7bBxE88OAcFMARq\nFBgxaDIR56IyYgKG19J0iJOWb2u7/jrR6XeiSCvOUvd37KwaIdlcsvQLIcLn\nrOgE7FyjNw7TmY+cMt4KEwOYevcPxPW1OltAt67fEChE29gvd5SLlvFswJ2j\naxxLMxT7U1H/KVehdZCdwc8emMQ+PWG6N5Jg3BNB6rRTdJ96rS68MY7nQU15\nbbTF\r\n=Rs9b\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"a0cefab34906b64eb9737b210d77aa7aeff78ae0","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.19.0/node@v12.13.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.10.0-pre.832"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.0-pre.832_1577732747486_0.21327235896820707","host":"s3://npm-registry-packages"}},"0.10.0-pre.833":{"name":"piral-pwa","version":"0.10.0-pre.833","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.0-pre.833","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"4acdc8366c36d9b500a3aa049ed3996245fed198","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.0-pre.833.tgz","fileCount":26,"integrity":"sha512-LE4sbnejTILwjsPEd8x1FJeIthMJK7XgA8HmZMSleqe3kJi0UEjcK2251ox+7oojdFKma/fNTTf1uC7zxfTLng==","signatures":[{"sig":"MEYCIQCN952eunTEy3Y6SlB7iCL0+HWcGN6WpR9s5DNi+o8tPwIhAKnFHJlJMB0TfyxQflzz0xyr70Dnt6B6kNIJpWP7pcHN","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47982,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeDtsTCRA9TVsSAnZWagAAomYQAJFE0cCyDllkNa3Yj03O\nusyDEU0Ar0uEwZL5oBB7+6+c33S86umPHj8Tgnt8+rW5yKyuBhcbTLGmsgOt\njHRpqcLYN5K1gi7wggj3fKp/mPdwXLyGCLgJPBE7Q0XMpCJC9NFlAGvJ/UJJ\ns8RS/I4+ThGglek8mEEBbGgt33LV9kqQE4Q8rYOp2CiYg7NlcJlasb+FBgCy\nw8YiLg27EfXr7q8QpOmTdt89Tqxzm7o8SugpOzbY+cHj8468ZvDq3bL2ehjI\n+Vt06BWZ0Eqw6seisOj16IDNt5RxVQlj6fG25CL/Zky/m0L9lEBkgSMpp/GU\nJrH16ylGodNxXDKIl+eeXlu0jHYZDhKBzFgUV2cGgrAkXD/mmLw780z9ymZX\nnbk9rjFyTK1z3fo9QKIDC5F6hYiW6adzF+uaXkXHMCkJN9nY2U3c+v1uYm/W\nnwpVcBOkTUi3jTmsNwj/anrsF/y689l1yYIe9o3SgrkPyxvMlepfN3bxX1Rp\n4tgBql0DHaW4/NR0tdeJc14bvyotL5f6zI2ySXNqf1HDOyuzk3a3ATB8N88w\nwwX0NekprSVqyzaMeqXVX4JqUYEvJFnTr6URmvF/ieQDjRcf8wYdJmO+QdnL\naNp/jzzxFAcPoVS1FaLlTPj8lpONz4VSeg/Av7J6kQ1GUKZ5gy7V8UdPdk98\nlqaZ\r\n=ln86\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"d516ac407b61944d2d3609af92664843535a90e4","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.19.0/node@v12.13.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.10.0-pre.833"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.0-pre.833_1578031890859_0.34435945360448295","host":"s3://npm-registry-packages"}},"0.10.0-pre.836":{"name":"piral-pwa","version":"0.10.0-pre.836","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.0-pre.836","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"d801a378260f0ccd88315ab0974a75112bfda21a","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.0-pre.836.tgz","fileCount":26,"integrity":"sha512-vQVKH+gLXkXKR07y88zNasQBbaOM9cluECe6YLp7Xrfl2seUi9L2SbxLc9FEudcwenF3hq7dPmD/sqlxvctl8Q==","signatures":[{"sig":"MEQCIFW+cfjlGFu6+m10OO+NZjS6YYAM8gZn7qj3FrR6v0THAiBFHHo3YzjDhYz5ZOlbmM8ahYqNoYG4ENcguukTG9TXZA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47982,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeFX0iCRA9TVsSAnZWagAAdYwP/iTQKpcICYIpu+QKIdfc\nYYxQGteLht5kN3PY9OaQYqt2J0xPeCk4MtZLv196YIpMXW0m+iRdYSIoZvXp\nKcXpXH03E45Zhs8fg2mqDG1thq+eKTumhOZxINwU1BTOSipgHR7gga5XvQ89\n2N1NxexWQp29EH7BYrzrzAjOunlW0RDfI5z39hQRbqNiQ0RyuefAbrdfNVjX\nLd3+xSlmO1If9QlWcElJS0PH2e4mmOWBRqn531XWGYz7HmmxCyxMeArRMGE/\ngR+8kuoM2lpk/cKN/2iOyMSyJAV3f7YNwDY8GceF0rzD4P56vf9ZQ3Tq2YJ6\n6km9Qj5B474kxx18yOR4rTzJXBFxO+aubZYe4mjnuYL9mqBqUxV5xFtAxx/L\nhWJp8gMBH5ohsjzHarxbME1Znj54RiITMJfTsfrD5z0BadUXw5Tny2ea97nC\nDfvX36jzRX4ws+uxNc30jx0aZm0G2RGKllfiuWHFVUOPtpRVy5eFjeeF64Qj\nqFOx6FSa+YS82lLCDeSF+9ynWi5pvpmPu4NHJcdhPOU0o7zS/GzSDYhuCq1e\nzr5ot0ux/VgVwYxkTrxS0wcZytx3vCv2+houH3jGTIy0/JrYf3TOO+9wktb7\nk+B1D0nyuh8aBnlpwRfm+PtkruQzfIZR3YJ7UBUNxxGPQ3/lQXrqcvooWxcM\n5lfV\r\n=99me\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"7bc9ac63f57e2c4ac1c984980ffbc9120c9c83a6","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.19.0/node@v12.13.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.10.0-pre.836"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.0-pre.836_1578466593786_0.6377618906134157","host":"s3://npm-registry-packages"}},"0.10.0-pre.837":{"name":"piral-pwa","version":"0.10.0-pre.837","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.0-pre.837","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"21408fc6d18f7e631ec204491baa7f625de9b2da","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.0-pre.837.tgz","fileCount":26,"integrity":"sha512-WymqnMLiBz2YQp0Kwbcu5e+bbPd7m9DijhwLngdESsP8ifwTR3W4e3unlnHSjTiM2OtbanvLs2kjeTZVe7av7g==","signatures":[{"sig":"MEUCIEk3mk38QWUv+bsDO1sI2A4Z06joExPdmQ4k+ASW4Nn6AiEAxEVjoVlS6zcCBnaNHL8dFRaGyXDFbLrq3ZjHz4z1clw=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47982,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeFns1CRA9TVsSAnZWagAA3zkP/2t1WgKhrPa5Ph/My/vA\nefY5RQ3O1C5pZ0fHEGgx8WngVlNmHVT0ZHm+UE3ANnius5Z4nt5G1YX4bExd\nWkLypERfiUGNO/jo5EefIeQsX8UsD7yLMBjo+hye5AVeba5+YpT6MO39wBPX\nAjQ2iv53X2mmdUG3+jEFF0EjVsU48nVxBpoHEdkKoVGtBuQqZBUKKlblXehI\n6RYuChm0g8hcxBYOXjijdSBnNe0TVF6UIw+6LOm1LZMFcGgd8Za7phrcpFo1\n+btvK3BgUxKwJxFuPJ1vbuHRbUY5wKMOgNe8FemUb6O6Kp/XADRIFbjZFFqk\nHBjWd6OuAfDDIvjD/Wak/f8DtnKWB/LLp2ABVCoMu6repry5ZmLQdvK5PQm7\nXzTYxW+vw+BbrSeO+jmJiENKvfDs9sd/LYSWqtKBvq+EtTcY6JTTdBSBFsu5\n+as95NazJovxC1JEveyPnIMkELcXD21LBQhwgrXpTihiTgZ1LBYRPhQNdfHW\nsWHMAknL4PsTf2nwRTTwMIkyk9ZPyLy7auOGDkj7S8T6Exiu7qWnkHf5YbbP\nzqKodRVYQV4KQXcPyW3gMaq2hEMDV06vE5HmfpmygYO7IgXIFSP3ZHhpTcY+\ng/qPEHAsglwpu3VWnTEyosRUXyq/CHq1+QJx9xfJMFc5r2Rt0JYAIeleyzJp\nwyKh\r\n=Aody\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"5e8fd9a6f76c1505c459b18a5a06fcbeaa77f1a8","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.19.0/node@v12.13.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.10.0-pre.837"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.0-pre.837_1578531636901_0.331783048501173","host":"s3://npm-registry-packages"}},"0.10.0-pre.838":{"name":"piral-pwa","version":"0.10.0-pre.838","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.0-pre.838","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"655589a5e58636d7a5e4e34c2200c128f15fb2e5","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.0-pre.838.tgz","fileCount":26,"integrity":"sha512-gSevY1QXdHnXZNMrRjtwHCi4ve2eMnMLo50cfUUf/vwvDhB+EJUQzJjw5F3xAglStY6Om2GV+OGoqHnBJaupBQ==","signatures":[{"sig":"MEUCIGTAj37m6AJkmhDVn9LEcQOAr9sz0K6JaRsrUM7aQwQ1AiEA1nIP5jkl9q/9Q38jpTyM1rmYyUylW1I1DawqozqShc0=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47982,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeGE3WCRA9TVsSAnZWagAAsq0P/20pe18480hCmIPXUdS9\nI82226j82qMT7Rs4gvX/xiFndIsFRbppn++GxG/twTWla0nA+OvXa3FpReDt\n/HwZQPi4Gl2iJ3NhkhXS1zyn2U/PFkSX0in5aP9WCZG4Y6s05Hv5vyMza0nQ\nHM36xNBfqRaigB2J1Le3BKDfgB7bIKxXtMFBENNremkhAacfmSfR9lQmM2rh\nRFEKQnbPu4HeX3nwEE/IdGWa4aRu630ZIYQw7RwoXfP0DUR84krIrgcpqHXq\ncHxKxtdxZObKQLdGjfuoGP4RxnqTQd0yTm8FQoDZr9f13sR5MlZ0o/4OD9AK\nr0y5JPjO10b56E2HWg1ZwMNWkFrytI5OVdSAp7YBu2Rv6rF1hhM0Hc5RqeYB\nyxxsEBThr8RH2SHeJrs5tGKr++irMV5/+ZWFzNfumq0Gxrxj5so89gA7G4CV\njfuuK6ccidmyo0DGVIvkvOKMl59HG8tSZL+h70LRPzfz+SplRJwqbyIXhtrI\nBP0OM6e6xKK0aed07Y1BB88aREaWBEIb2CrpY9JTcHw3n2c69p8ZoT3whXBq\nyyRv0X3CGwr0jB36HBNihLDkplRGChvDrn06tdYgGAVRCI1qdGMr03Y6FeIo\n4kfNmi4c66dFNwcBmJd5NeHpOJoMyCdWZcIWfpGy63mcJphj2C4yKuhqswhv\nY41n\r\n=n0Dz\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"5d2f55dafff3ceb751877958c5691dfbf995ae84","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.19.0/node@v12.13.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.10.0-pre.838"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.0-pre.838_1578651094474_0.09888860924159926","host":"s3://npm-registry-packages"}},"0.10.0-pre.839":{"name":"piral-pwa","version":"0.10.0-pre.839","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.0-pre.839","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"a3065466ca0b9f891bedde27e018ea1297d2f521","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.0-pre.839.tgz","fileCount":20,"integrity":"sha512-SyemOZns2AkNDwuGw4RRuYMbVLPSaANwXf1OCiYcrtx/TGf/aPeqm7ZKRnSOdmNy4sF669frtNAMhz42PHdMlw==","signatures":[{"sig":"MEUCIQC5v6xjCa6cRO8si3iTPcE23jcz3U1imw88FZHrrOs0bgIga3QJi+EtWRiI+Na02fdDSTqOkHxvuL1/YUg+TwGEixw=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":42724,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeG7nZCRA9TVsSAnZWagAAlNgQAIby+jEWhleCEszDOvhK\nyJ43nXXFcGnz/nlrA0SwG8KgnkxOacnhClkhlNUydQwvOAmQQHoSMwBWy2ON\nnw4lK5aZ5DHKwvbt/URY+nnf3enFA40TwE6bjJ041zzpK/TWToP+4M7K6vJf\nknP9rqDSEHWv3wFE20FoLWQrwZVeF5QU3b2d1j6SxJ8ODNAi83G6C6K7/pnS\nRZYt5E9D3nR/lyZA65mHTor2z3FMR0ZQmlxShdyEym2JvhFlUUGWsoL1ReUD\n7vZaNByEbZqYo0/SNvitw0nBtpxLO099lBsimUSoLx3/pilTdrBr7/tOYHAr\nklE2SSLUAWPN1wsZDn6kKW0/EofnN/sC2fYFGw5+iQaaTdNMTNg5hBNvTBBx\nJEmNZ9w1+LmjTDFycT4Az3pVydBo9grmvljSrGTOkt5Fj7i/FkaBgrgmsDxb\nlD47alq2QrfIG2MvS0Jf2xaNy4UOIEJqtlNdLRLGmToSLPPt/z74ff7/IdxZ\nzTdqOkXBK2i40buA9bkNlVni3pfkDLMS1SihKZAoY/qg7HD0ZOJkWRz9ZtrC\nBZ7/nXoDxu7mGFDwdS5c15YZsoNH+3bZMc81xEFvtFj51qjQ5Is3SFNbiavg\nM1NIshpz6q7XiYNy3jPc2dVFWM9gAgxwSvpw82DvBNT4BKL1Y1Ai5UdUbI5S\nIwe6\r\n=vEKQ\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"33cdbbd12fb5819e531ad2e8d4d5eee03d63ec4d","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.19.0/node@v12.13.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.13.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.10.0-pre.839"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.0-pre.839_1578875353449_0.9390681337743549","host":"s3://npm-registry-packages"}},"0.10.0-pre.842":{"name":"piral-pwa","version":"0.10.0-pre.842","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.0-pre.842","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"a52f78c78fbe602542de1c59dd8d14c50408812d","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.0-pre.842.tgz","fileCount":20,"integrity":"sha512-ot2z7Fd9WE5d7qV8W51Ix62h6IAI44P1Cu3YMIER8gXiVTsJqSMRmPcluPnurKIwo4tpgqNLSYXYOmW2zSRd9Q==","signatures":[{"sig":"MEUCIQDR7DXC4oAgRlLPswiXmK23aR+5WMUZrZsqyT5piDQbXwIgR/jO0VbkZmr51qiHDTXgsi9x7fnlKqfaFdgyD03nfWU=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":42724,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeIcs7CRA9TVsSAnZWagAAUxIP/R5s1HDicmVq2aC+gS8x\nwGT1gt8xbck6a4CUx4UOuUmdgnWfUeRVWYtK+EnDwUi8+ksMTKPU8TlW4UTi\numi+GDO7xyt6ntNuILuTmzUCKSq/NB1GZTLvi3DFWfW1gbNWrd9rPSwCCDmt\nlV8To3nVpJKSyMOYwLmtXyYYkBrrAYrVvodEpXbcTIgddKAWFZZzrkcMjS+9\nLN5P2QWhezws+zrPFQnebl/RwCghaGvkVk21To5l7rmnWg/AP8eopHUE0XFj\nezCz7mKEC8485abYAOAwOzhXNRdq182g3sVFwyxKtnLwKc6opDKKTOaOzkdO\nfBQl1/uBIm/+Z1RcDoS28v5fp6ZCElsNzAaepAcwu/oQiZcFwAT8UDDI1LE/\nAtS7IBYOHCKQGChVLL3EAsRJCGhIXdNnCU3bQ2oOFtquM4CujUr1D7wMwgjM\nvNVQ8Cwr+9bTGYeNgbpiDFQzbmn1pnWS7aX3Q1xw+4pWKuUn1HpNl+TyuNc9\nBM1qZgA3tcSgmEnS809GL1+n2hs7UxGJ9VpFyLvQ+l/v3fcKqbGqCvFOm+2m\nolxgcXbr7Jal8RwV2RC4ieZ4vGImxgRkB45Di0FZJqf7vYJTs3nawbNLDjfz\n6o7uZbJN6D2tuuOW7D6sy1KgzppYE6DPyD9YA1oBvNKy0GB0Rps3vChDUV58\ntny6\r\n=bFDD\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"15b240d304e7a079546be98203155ab6287ed2f3","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.19.0/node@v12.14.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.14.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.10.0-pre.842"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.0-pre.842_1579273019334_0.2525959563405198","host":"s3://npm-registry-packages"}},"0.10.0-pre.843":{"name":"piral-pwa","version":"0.10.0-pre.843","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.0-pre.843","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"41fa596b59a2d1119fd30ecf68a2bc3e5c8993bd","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.0-pre.843.tgz","fileCount":20,"integrity":"sha512-jyWeWThr5hN7PhoVCRAm4XlplpLU7q/WA4AexWar9bfaibgLRZr3NgIVli4bcRig35jE+MK3CN7VnGWSFBhNrw==","signatures":[{"sig":"MEUCIFb621rLyvZLge0r28HsKQgolsni4X39t8AbTUz7O9bEAiEAo0g4ymOxMleDTyRP/bGffPogvBJGSTowEYP5LVlIxwU=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":42724,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeIuKHCRA9TVsSAnZWagAAsO8P/jpQ4lLfINGjPLZSy6H1\nYHIpOdbAaXww2K/mYWXEivZR9xY3Z2Ovdd3/JPIuSIoxZPggNe1lUvrnNzfe\nb6rvBgYZ6d1VYQwrzWb8RJRMeRm5HwUXMr2TCtGK4QqoXR/Ne9wHFjiy+7AY\nDh7K+ouNCQDABAz5mdWwwjCuwJek13+B8qX8I/cPWSsnESYtu+aynn5LEeUJ\nQcKt4lJOJpUzXsS0xtTx5nrlIaBxd21o+4AUrkl5SR8+0L00kvw3wLbT3+rH\nN1QhJcg6ImxAHsj83mvsv9/ZA5sHAwUOewPpKanPIdLiBgiQOLLfE1fVwN55\n/IBfYZ1EI4iFp4akpudIrvleA2ahxi5wXWQvNlLGNG9zYPXZe5E1jRnX4J6P\nDan/Kjpa984K1eBuIYo7K8Q99yrjXfxs4L0JX4cMOV1x3BaGmBwBYCltKXZu\nSw5vO0K8gdmCkXfgy3wEVG2GfhKjIMjpT+P4NfS6jVHfkBPrVggnWy1sF3gw\npqn5xX2Me7gEIGDjvMAyaKVYGYN/v+S7MyGhmEEDMtUnZeKlsfLrxh9UK6fE\nVJD4hiUE4kMg6SjSAMpNfdM0C3S35b/TldDHHxpHCCLwTJdvxF9HiNFsYvsa\nBXox/tKd22TLYAkdx4KBCOxYpdiK1ApSmGXZPaqkKc/D2+5ytlbSRl2/aqa0\nELmd\r\n=J0y2\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"e0d6ae67c25cc01ffcd98d3b4f2b5aaac7f5c3fe","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.19.0/node@v12.14.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.14.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.10.0-pre.843"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.0-pre.843_1579344519292_0.9727185747148877","host":"s3://npm-registry-packages"}},"0.9.4":{"name":"piral-pwa","version":"0.9.4","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.4","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"2918a599ce6fb7b0051d96eaf859610e665e7d2b","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.4.tgz","fileCount":26,"integrity":"sha512-Ava8r4GiCStXfq6cca9f47Bym5g6oFPJ8HvUnpRe3jkYe7DwOC6pnHGK3EoRAFAS3zsQKL2RJYSU9c4i7SJc4w==","signatures":[{"sig":"MEUCIQCB8+eiIGupG3VsWqaOrSIWAZRvSCO8cq5gB+SZ/dhb4wIgQkq1WsUcyJO7fDpZjHgtIqVhZOkGwt9WHg7xR3hzOuM=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47953,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeJdJSCRA9TVsSAnZWagAABOIP/01xwQgK65/R3cOU9foN\nUarjEFopagWY+V6CNO8dlH0z0QUgqlwUgN3YriBdtNfSYGXuqFqgvFEZEgs6\nO/jdiNcC486S34uk7efDVU9GyeR9y0K0eVwOsdQxUktiXiIuc87f+3VtYzsI\nFEibZntm2BVOyNZZSpd52v/cayoMQSuSNqu+wkeRQfhJUyRCKEf7stakL/Am\nwOsZ8pTDHnJS8qaCGwcZZ2XXCgIUqqQElYlHG3pa5HfhDTNXDqYq/ipPKNB+\nzjOe9XKi1pXkZxpbGUxpOUX3LjW0YToJQCMiFbY0aW7DVc73j6QE69JqtSL0\nSsZfxc63iTAm+qermi90MINjV7g6vXZSks5hIJkGy++/2UNcP6nX6irqCvJg\njmOEGOKwC5mVi3EkzW7yUW7pQ5TlCcBn5hKVOw1vdmRZq9bv2sFn+pEgU6ou\nEcfo+gM9Bp9IDgzykCKcQDlDTm9iciDi+PZzwLiOpPYxxoShTZac+s7wS2Bz\nRxxSoM/BwyptKk3fJJ+ZOIkKQLh2Caa2eHeh7Da394RwNDWURQ36qAamwlZz\nGO1UBUrjmmGq4iUEwtm6lBifBmKkevj8tX7uCMmE9ShTrCEbcGLqpMTVn9Cr\nl0s+ysztTr/MnrdjuGWboGEbTFjDFd3ZrDSqn/uHPmNV8xzw30K4G1uFHKhe\n2hcj\r\n=zaH1\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"2426a2466d490035811e382e871f1a019eae3513","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.14.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.14.0","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.9.4"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.4_1579536977859_0.17962001148612705","host":"s3://npm-registry-packages"}},"0.10.0-pre.846":{"name":"piral-pwa","version":"0.10.0-pre.846","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.0-pre.846","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"dea61469ef54a80c993f6a719d93865e15fa56da","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.0-pre.846.tgz","fileCount":20,"integrity":"sha512-uUG4mf4Q49xC69CDktNb3hU9HBY+97WysFpWcjarGEeFspe/U5U1sAXTCoLa1QK6Ga6p6hCf2tCnyo+yihglww==","signatures":[{"sig":"MEYCIQC+o0eypYxWwJJVMZ08r3JFKSw+nFISOePx2rzyDJswZAIhAOkt2Cr8zuqoOhNaljMdKVrNVZ8Qml9doErPE55jGbFW","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":42724,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeJfGOCRA9TVsSAnZWagAAHq8P/RDvLHPfGooXmZpgD0Jq\nHION97A10Xete9kPFhORfDAf4b7id9rmlrHyU6fqn7wcjV+rVBAtmqhWP/jj\ntIxaO4+t27eDPJMIzOTwP9O9ycXqDDxa0A1CfQ14ckCsRuLng+CAvn4val5D\nYW/bGFuf9Wx+Eu/7gTQ+ceuN6a0s/DT5ZofuFTvVDPPKM5K+cN5F2Q4AGKmw\nbWp6qT72unD5kqNTrEcKaLs4SPuZFiS8gBRm0yhQPRemeloghq7kdw+ljE/h\nW8h3hG0hv7vFsLFpp0tgYfJ+r/8muj/OI1ggsJHJGSLBfOi6fa17Ht++YXW/\ny6cKjaCyuOVQ+x9k7ymGWzQ+GniSv3xK40ne/8A5PlW2z8R3LGRXD6EqpcRb\naa1d/6WmQa7yogno1VchhKcMDT7AZWI5lAhPpmjxB9QCHddIzDLMDw0ly3I7\nFdtUjPHH01fv1Vx1GwSvLS5snCNTBn/uBXJrwwi6i0uqyHXPaOzuE2ibSgKW\njrRWBbqWg21ogq2MKXkltKodcCj6RTc7pbGA6LcJbl7T/BwPWiyaJj/fF/vy\nQgwUmbuS6RBawWsrgAS4UQO8Hxht2QWdkOSBBCgo3f2rhneh3C2tLF46ejiH\nX3iUsB1we+7hA/DeiFysTjxwqxgTaR0HQLg9BTq+kxgsEwFeCpdvgavrWapa\nSs6A\r\n=sKs3\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Setup and Bootstrapping\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"bf161f59f5b0b218f7443a4cf61534edd2aef929","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.14.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.14.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.10.0-pre.846"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.0-pre.846_1579544973875_0.5944558010350476","host":"s3://npm-registry-packages"}},"0.9.5":{"name":"piral-pwa","version":"0.9.5","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.5","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"f4211f16f52faef442e8b35093349104952a43ab","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.5.tgz","fileCount":26,"integrity":"sha512-pT9L2hYKzyzwJOfcsx5lqkxZtiP3FhHH+JjkcsITQDKyJ1zKwr3DLOjA5GMjCWTQKNPd7ANGFPIf0C6G/mDGIQ==","signatures":[{"sig":"MEYCIQD0g2DGJ3g5Sr4An16HSuDr9+W9Xs1AVTjH4Q/aO2rFpgIhANxs6WwfqJSQ2We8uGtrp37xtN/XS0UNLkMisAp9vnRp","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47953,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeJyk/CRA9TVsSAnZWagAAwmMP/3BoeQGpUkZuQfAtVxGE\nCcIYzVpntppu3oMVTdj+dwU6vdxX9bGz0EQhpFKbjUN9QNPZR/PAP0fIGaiz\nFvTbVXlBBN5JIsyHjUp6FU7P5UIdjSoS/Ojf1b256vAIeW6d8HUZvRtvREVn\nYdfv1M6aEkL0KMvlLZnzBprmdjd+4HI2mCxSnfcqZT04Xez+fNnReQDKxfSJ\nJChLWMLITY9UmJ70aDuBFrRyMfZ8BtCeSjVcLgNp5Flv+YH150GWusJx3meb\nmlb/CcslbGntR9pj4rSu/B/CG4fmqwm2tVT2Klts6mdcLTOAfrHl4eOD0l1l\nqHQkcBEtC3tkf9c/swCA6na6/zFuJoB61Asg6wqADGH6Jpm+FJZ5LhQSa7CG\nYqtvGhT3vUeECs/CeXIfJqm3FuDoIwA9S0h0y9I8PCEQBlTF/CjtGKnZOwhQ\ndJDpcYGiqUNhFN/uUx/egraA3vf3sp0l6zDNVDnpeEFZeJURDZqGbZzqk7pu\nRFB2MsoTdK1K1Uga4qzBbsvsFk1kTlPY2PY6KkxaM/+ToxNqnCtZ8WHYYgZn\nbCEEXWZnV7J30I34RG0rrebWO9qY0tWJSDU9cDwRF6SyzAI6NuaSxrG5zEAY\npRXkstggUhBWu19DMlCL9f8Wo5IZRKSFVZozuocYWPOpEsQQGBpkBChIgCMS\nE+eD\r\n=YvO0\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"1157b1851f65feec8001fcca9307f612328266f3","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.14.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.14.0","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.9.5"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.5_1579624767290_0.9154209541533824","host":"s3://npm-registry-packages"}},"0.9.6":{"name":"piral-pwa","version":"0.9.6","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.6","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"d41c6e2678a123129dcc4670b5d989a0f1ce0bae","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.6.tgz","fileCount":26,"integrity":"sha512-SmeXrJodK7ir3iDgm9xtOo5wwL7cLYnLS0nWjpWV4s4PMyur7iTJrcV4fUeVT8ipape/IWppo2y3n8fmL2RwUw==","signatures":[{"sig":"MEQCIGFmrX19yOpzuNGdC1wr80F8KZkwL7v/UwXSL3eJuvuFAiANG4e5kSPt1hQ9doPJD1D1NycwP5bYNQ3ezrbi/9cOUw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47953,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeKHmvCRA9TVsSAnZWagAABnQP/3nC9njBCOaT2WnFz5f5\n+aEFySCwlDi4lN0VAuDt2sKTxDu+aLeXaSQqmuNx+aCx09oKJY6sESzZhAeN\nQEhUViSusu3X9b/huJLpoz94YRqcbVcqq0uXpGmSEotac9l8hMEzT0KrmzsB\nIVN2w86n2UCy4DFB5UAC1ka54JMd4udXw5W3sqy1lrBgBhxUaepRFC7UQDw0\nkQT+gVDWgXt+aEgnD/9RzOdJRuddTg0rx4NXhlV6RFU4F7TzXDALvJWgP6Ru\nR7ZZ33ti5aVxDnZ3Sw/RskeBCiPcg9/fCS3iWqzOYcZelQ3Xt4FzadWJoNly\nTLkOt1qiO0RT5azGj9LXAsa09HMOT6Iv4lMR9VILvJFsom/m82dZOeS6TUFh\nRge3/CbBU5Sfg+TDL622LGVxUU0JvWLQVbKlvK90cEbzZUU6RV9MBsUJ6str\nrOqLnPCP3n1DujItdQbx/djp/+m6bVn2W2tQYDvJj/LiL9gofW2/dVzdXTfb\n5DRuFAIkrOx6X86YpPj7RjM3ClllVERdDwNLHVgR69jKY/1+ZuEvEVvYj2Tq\ngR+CmNeLMjWospDk2bv645arfdgUTnaAz/67oeqcY67SIKVyEu4v+5h9JoSq\nWBS+hxcNxl7J6VM1pOncyaQRLDnIJ+eSKvg3mFLYGiQbY50Gvke6H6VX4obc\nmJFu\r\n=X1U8\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"fca193d792b4d49b5f8090415a8c7a90d88bfdfa","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.14.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.14.1","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.9.6"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.6_1579710894709_0.5505980245762101","host":"s3://npm-registry-packages"}},"0.10.0-pre.853":{"name":"piral-pwa","version":"0.10.0-pre.853","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.0-pre.853","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"7d801b02bd4b02b4784d2eacbdf6eab590b6d6ac","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.0-pre.853.tgz","fileCount":20,"integrity":"sha512-DIcvxztMcw6FDAA12HW7mLmaYBM4oyCeSfDK1qjmSjUZWwV+fJHH2lELSwOn6U/HoxpSgcCjIfm45qkeCLP/BQ==","signatures":[{"sig":"MEQCIDcJ6NOoTMuDxBYv8QRtPIsrUecJNLGkpWS28cFunaHPAiAtDH9TpNWA70k1IW64yvzCwEwY9LnifqNxSb8xC/F5LA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":43187,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeKOhtCRA9TVsSAnZWagAAQZsP/jh0vLwDTFNDOuPGnKiE\nDNInsDB4i/I0BPfItk9417mjDsgf+8uszZEZtNg0E4WPbNWP6Fu23SXXcl82\nDWb1SQCavKPYqvZ6nWBXUWSoTcPYMJBsV4gaWGZMVkV4ggcb54YYt9w361NQ\n6n4loPUmtd76eQ6leXjpBSqPh5IdtNIbpzO2mv7mmOqSccZtzyihc3qOcuqy\nEXYvl9pSGtir+NpNsBsdgdzKP1PBp8/tIURTXjJm3odNby7x9S7NWavmaynC\nPKFNgo4GNabW3Ywd5/fimGt1NMiNTQZ+LQBvPxdE02Zvcn6r0IccNiUNW0+1\n6hy8win3RizAnx8y2u1SwOq5s6lno+PucVWs7YasrBFTnVJfh9iMR3le9oMO\nSTiRBtD//hGyEQyUPpBAJmmtt/h8Peuybrq0J/Xc6QCJWNVwqbE6bktWeyH3\nwjqUizKuEKgaDgA/JMGzByhjVmu6nl6p/MpyPCXhWtjsCTUmnOa67TOPYLWh\ninIutlsbT6EcbeadItHabOI7HD6W/NMcdTfaTbK45U/2TmrujQje9HwVGpB+\nDKxlnFtCIU6q1qYaYrKU8R4JRrqI92qOcOc+VkdkM2RE6wi4GUPQOp8Ot+Hl\nbh6+aqcxXy3KhHKKlPOYWdEIUi+25Ubpowu6mQjEjvllxuR5Mj9Bu4zT3lVg\n2C+n\r\n=CAGR\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"840155ef91a8f43f65ded5e18985ad25074bdc63","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.14.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.14.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.10.0-pre.853"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.0-pre.853_1579739244777_0.26827414535285965","host":"s3://npm-registry-packages"}},"0.10.0-pre.855":{"name":"piral-pwa","version":"0.10.0-pre.855","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.0-pre.855","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"3352e3a2bc2dfe5252e6946a374ccef77bf0334f","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.0-pre.855.tgz","fileCount":20,"integrity":"sha512-NpqKOYnokcnpRgzUYxkzuHFfCmWeP8J5EMVN9nZbuQx8YIY2LOBGb/RfROHFfiLbqX4ZpR/LNERU7SPyKKTjVQ==","signatures":[{"sig":"MEUCIEhVaDFA3fXw3KG96R4pf+8qArgQ20HEjq+l0PheuPn+AiEAlS1wzExJygtIvkWn9fI+seIUgDZ0FrUBGWSdE6+KZ54=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":43187,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeKjfMCRA9TVsSAnZWagAAjJ8P/jHhXsxl0zMjr0LlTcAB\nfL+854ZMxuTBZGjlS9mHoCHhN8aomkRvLE74NChsaPoHQ1s8K0P2Dki1Utbt\nMF6y4+T2YqQBArkA8cz8kC1uQpamoaAy8d+UVdD+TnEsZzYRcQZbXiDH6TVj\nne9SWqzbf5uL5TIweEwo11aHbIsVmVxSp9KaM/G/xWXtgH4F/2zsz7R+JCyS\nuPiLy11HmHuJNGz7kFYxWKBZ9nhE4BOF9j1TLStB7WmWeGqZRlPixmpxuh7N\nY9xKrMy7kkHwayhEYHySgdnQxMnRk2+rBRkMBlKhYOEsZwvsys2JP/0tHoV/\nS8b4bs+AiHgX5OWVlexcZZTn23OvS6XmN11GLhTvAw9IRz+P2ibdEPAnnwDI\n9bR046Xv3G5LMGNWozWqDZL6fwphXaL964KWkaq67RdMB6DKF1t663oElEL6\n43B6XG1nHEmK/XdJc7t+aIOus0ujRu2D254nMIbPJ4O0n1bw2tdL8IfzTtpr\nHFClbZXCVK3b/sgXIBMEe7HtqfnTYmj2Az+QQNhhlDNPwAyDiFLi0dGAOihC\nFdJRnLvuughQnB5d83WEtb15kOdF8WmB1U2P2S/hpcKDfohZURnlZhuxvfAr\nQ6w7/D2Vo+FSaLjE9g5tmHGYLSvSxHtE7kSETwpcOEm3opsbML+jUUS0jUfQ\n0U7M\r\n=JL6c\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"5f1c30798e884881ced198bcd799c9e4dd084d47","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.14.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.14.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.10.0-pre.855"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.0-pre.855_1579825100369_0.6039131033357372","host":"s3://npm-registry-packages"}},"0.10.0-pre.856":{"name":"piral-pwa","version":"0.10.0-pre.856","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.0-pre.856","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"ae301c0fb15da73139f9b483e179edebf6c29e7d","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.0-pre.856.tgz","fileCount":25,"integrity":"sha512-h/P+O2pXj5oeMIV0slJCYBskx2+0szedkzfyGWGPDvVYMkoMSPJ/y1+UUvmon2Uy2MpZQs7zo3FzwsE3g3DBLg==","signatures":[{"sig":"MEQCIDhxtfi1ClM2pll+N5vVz2cAYOFimditvu/KG31PADFcAiAb/+PlkRJEa/cwbjzImoItr+GmL77RQCbIW86beinyJw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48400,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeKvE3CRA9TVsSAnZWagAAgJQP+QDsPwHt+WL4sp53PC22\nyDkTrOpJw+deBJ9d2ljswwU7UAEtbANd05PvH9yKy+LH4mJ8s0m2ZvVPglYZ\nXEZHUECXhCFLzx4ohlNg5DmnQPg24wPK2SJC3G72oTWz2BQIY9VRzHQfiawS\nzqEpAtJIFYM0uZa5GODpfZhhhZE2AAq9zVb9NVA6bOBBDUQWPrRwVkE6i3VR\nrkMiJGbhw9QX0d0glo2xxJZnxqRbAp3Q98CNyaaxWLoMoBkMCkVbOQcZUmSe\nKG366CJhv/GFBqnihkXawOB/bz6DEuGe5LFt2ux+yBH3rbMB2zlEFQDs2ESR\nmfOvH6DqViaRAisa1+ublwIK3NMU6h29HjGscV5aozghcvQoy1ab/DFwd87Q\nY0IP0R0AcbKgyFfyFbc9a9tZWJ4TG8EZWSEqccaRpEYH9th6EkUkUUMr88l5\nULa0ghGkkpDqh8obkpjP+0JXROoMmjh8XfO+vuc+Esr2gbXAKz7dH5L5c3V2\nuuBsDUz0n8jcizVLPJX9YnXlXLAI2g/uRFEt87ys+heAyJI3oZ38/UxgRyKK\n4RL9/ODGLyXWUgI3r3E4RzSlXBEaWVm80eCr4kNTTdA9HWOEi31xtnR7E+xr\nRs/qxrFTTog+S8k8U/pkSTQrEGKUrNLu77kz6lyw9TQik9LlH26wsrnvRlQB\n5yDw\r\n=1pVh\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"a886f74310f8d4eb6cb10bb665e994594164b666","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.14.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.14.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.10.0-pre.856"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.0-pre.856_1579872566646_0.25827541130537957","host":"s3://npm-registry-packages"}},"0.9.7":{"name":"piral-pwa","version":"0.9.7","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.7","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"9b8d9ad28da7d13bf3f0d4604e0622a912c7fc2f","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.7.tgz","fileCount":26,"integrity":"sha512-iR8o/g24FXIqhdjcnFlREmIzAGScNt2SZZYThnrtSyy8Ovb45qWoihjR/lnTBjc5fmdV8j3Qc2+BGXIQpuykUg==","signatures":[{"sig":"MEUCIEaeH4HcVqetZyPj3/9cvkAZzzdGrsZP6Wg9vM3sbfAEAiEAzQFUEyJmnE47hnidJzR2ryz8THP4Rge2hq99vPLDDC0=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47953,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeLMlQCRA9TVsSAnZWagAAveAQAJ9GF5CJ9d87PagtIYbw\nQWi1mOhkQPP/84LjCqVpSx/IN7CSRG7fdCVas9rEIZCZp6lYUKV5w+yibRYn\nds933Mj9N6ar0ywvOEZVl0hixHmehAv5gfFZAqU4xii3YxMjsyD+QbJAJR0a\n9Lx3OeDCtjAhYKpQWGfJKn8hkQ/eO0KnsUtbAaXq9LJiMn+tE6CMCwtHMKQ/\nrS3gv7ICL0GGYCCzP2Q7eSZAM6YQXw1Z4GAm/dcwhl1C8sjsqfnrDID1EnEw\n9XVThaUcDleUK5ZWxCiZZTKkzFc8ULdQAT7m6V30rJ2YZOueXED+uD7wu8kL\nH1Ow/56aL3rqlWei8e8Zd7HcgnLqwY19dWizDEYwzcI0/URop6uAw9WBeUCC\nLuJozbiv4oJitPmLKOFPMAhTE9jE9Jr1dZOUNBNKnTx86AMTJsk8ErCAVjQM\nFtghi+v3eN3cJ3xGdI8hD03tuJxnXIY/bfqikoM1L9RxO2hG0VpxrgH8oQEJ\nHGTAyIF8booDJWN2j9amgFB43W7aqnjNfT43Pr2r3Od30KvW8ah9L0aSLlLv\nQniBc1BqF0U5YIpiPidfMJp/7oQMshsqJL0QkKnoZSmbqlH+reB1Of4c0dae\ndGOePBKvTfs4Lj3hWe915Wf162ELSoPPF/jHV9r11cMNnOiP334kjf2IkSib\nlrEf\r\n=AZGs\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"c4d1a6be5e020e5031fdf43392a48c341540104b","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.14.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.14.1","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.9.7"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.7_1579993424315_0.35240581605582144","host":"s3://npm-registry-packages"}},"0.10.0-pre.861":{"name":"piral-pwa","version":"0.10.0-pre.861","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.0-pre.861","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"3e656f99e9a7d3e3aa85d0ae643b9253018b883d","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.0-pre.861.tgz","fileCount":25,"integrity":"sha512-aOUS7ZTemkfTq+VxHM9EgLkHTlz+rw4UOYGlCV04iCp2QSDcmeblduuqqwoQn2dshn7UwwarSV6dTX/nQhvAPg==","signatures":[{"sig":"MEUCIQCfBwCP7oxBJe9Kij6VROb0TUn774IPcW3sl0nQ7mCGzgIgUZwA9kefqaD7WwiEDhJ6FW7rjo1R6zBBW37VIlv5p68=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48400,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeLNGDCRA9TVsSAnZWagAAGmYP/3X6hFHYUu0RrD97aWOc\nWi+HPzeQUyyjEEV9eNjXfhhpFiaQ+bECF9BqSi+N7nJPvKbjDabpdngj8JPU\nsxtIALltQJdon/SB30CeqyIY++NGT5mPJql38kaK2J+9IaVeSp20WoHHCN/E\nIr5o/EW+VD9n/6jh/7i236+/STCjKjNyW3g8REMW1T/rsALGf80KJ0Rt52kf\njH55YewrcXXPLNr2n77IAiUq+l9zIA2jjPFx/GJrvvclm85Nu9oQUWcgb861\nIy8w+CDaReiK0N5DiFu4xxCeMjBefzDWhNI6VuddvECo5DN3cZBg508OaJPa\nyNY23zSnRGJuT5LpMThTrBuZC6yEyF0RzqN8R7mfWsclnBI7iBLNnH0/t030\nXV355aNghaln7HVw5JmbB7ICezztzy0apSdT1rbeKc2HK3u5rE5+D+PQMMFj\nv4eW2S3CtmjTElIBIW/g1X6rlL8MhZS+9ghu3spSTM1fa/74fUQ0rhP0rUaV\n/cbMn7c3RJwF1TI6MRaCUTTDeJ89p2Vanqt5rzcQvh2eXKWx8Ftdb7/z/QP2\nBwp3xfG+j7LjB31nksWDwbRQPNgu5cVjTZCDfasM5c+mupPXb4bLN50Vgqye\noola922v4WFANpjI0i7zA2b+4fZwiGEhzmVGsXhALiSgWn6K55B9Qa/HNbJT\n1g95\r\n=7SB9\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"572c61695cf3c9fd99a815889061c0c40b0cdc31","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.14.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.14.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.10.0-pre.861"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.0-pre.861_1579995523454_0.0913101631437212","host":"s3://npm-registry-packages"}},"0.10.0-pre.865":{"name":"piral-pwa","version":"0.10.0-pre.865","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.0-pre.865","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"4c80496dc91113f2e3954d9af16792a8af1bd8ab","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.0-pre.865.tgz","fileCount":25,"integrity":"sha512-oYIYnqEJtaBwx6QY+ButDoOGX3IyH4Zk7zzEsugHRXsAvPwj+f22sH+RLyS55C85BTdvNACIUlxIuV+xue7QtA==","signatures":[{"sig":"MEUCIQCzkSpwg233O8IM26hy8h8fVnSbDshcHciGIagppi/FKwIgecGEWCa7H/n8OxR/Ufr7LeO/DTWPogr2WNXTajNMuh0=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48400,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeLxH/CRA9TVsSAnZWagAAHgMQAJWIHIois6n1Uhsk6mia\nTBLeg06zgXi1n3UC+dLl6Ijmf/0NgnypP+Xham4n5ETNP/Ng91w8B/HhSpwG\ndoRnaTe7cYyPBMsqQfxmLkCZA23+oYGUAkCCC2lOxeTcA7r9aYzh6ixN4aj0\nkFCk3V54X+pVDXADFVlPr1bzDvtZbto2dUKXS6QZkw13fzlqFbSpWgCNRV5I\nMoCgF4vd7VV/xIj2RWG0jLGjfnAUYE1dC4bjtyNOOfbstvCHJ/0TfsTL6MvJ\ndFbSUDYFUciMaGg49CaIek1b9mBOBVLSR5dwOvIJI4onzKGfhZXisiLjztDo\nWOQPWL61V3mVo933NFkEFLbhRST2u94+uDgB/dX05q2HOqZ80rsO+z7qiLNm\nyOu9wP58YpsKWtLEffy/p2bgwlLEqnhjUrlfDuBcyXFC/hZFYJYDSXr5lL5J\n5g0nC3ChrLuwxkWrzCzZrGn2eDHC6opz+1nwAFKEewXqFXJvSHxfTY0o3WL/\nMj35T2Qu+xtkpAJm4Kz2G1yup/cZexQ0WeJRTifE+kJ32cvvbTceepOKumnz\nS2bbVhDjlKpw1c5JKana7FQeWiBE36U54GKWymWFuVO1vRttl+3V6+jdnNZk\nKndTM2cmlz+bap0aAesPHXUqNjE4PVNm+YqW5NgamC/zr1QwkWv7kHNuiwyk\nBxCd\r\n=27kC\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"8b61ba295ee24b9d5615528dd3e6f300b9186102","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.14.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.14.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.10.0-pre.865"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.0-pre.865_1580143102742_0.7387314931236086","host":"s3://npm-registry-packages"}},"0.9.8":{"name":"piral-pwa","version":"0.9.8","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.8","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"6f856e894ed9832413447331ac84391d797c325c","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.8.tgz","fileCount":26,"integrity":"sha512-U8GXW942wPCoOOt+UekPSKm2ncAylmeLtC9G0o1WNvtdozKpsAs/lSRVG/OdZmSitXO1mmTh23tn3/rTeVwcrA==","signatures":[{"sig":"MEYCIQCcjZ9qr5uo5ouNYlqHxYBgxB+dOxPFKj69rkf8w8LqiwIhAOJZnMP/ytFNTzh7kljQeqenqd5whZdlzN1DnHAyFAc2","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47953,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeL2R6CRA9TVsSAnZWagAASYsP/2kX1HVuuxcEujzgj5dG\nyAlIIy1fgrCjX2jg1Y4bo0SFPsNe5xBrh5hfuZAX4DXUCPyVKMyu6VeLFRg0\nhmUnNYw77kfo/ACFh5X4G7McwOdOUdjMpmt3bRccXXfFQrphlXFK9eCKoDLd\nQ7giY2ZR2YJ8sh3xiMagyCjSknwd60pw+HKPkT2rSVBBcRyIdSy1dO940kp7\nnTcxwMGwdXbgW3FFGH5uShi49dSs9CElHkAwFdIzTOu1PId9z4qP8nwtXZgn\n8Hti0TNRgVkZvtSiNw9O5t/DQPPdNCG+k5RG/YtPYs1eSLCGBzmPV3K7Af4d\nL1Jlcr20a4dcDBsRHG7Aia8fyM2x235jmsPg02CvqB2+RrqdqCnwag6ffCBg\ndEH/U8Q3zQyhpqytOWf5eJNzpQGjC8qqbctoYg11+gXyV7cpNWuqBac/sCZh\nFoGZ/9dVrgNA+XJWtzAYFCGjRMro7YwfNItBhCSDGOit9vq4GEvGzIPdYYlx\n4TLwRBMRuvYIJWyTlfjUwwesfZO512MKscFtZhRkZcMVzwaverLRmmsdG+Ho\nNb5Yv3zNWivi3+q9lwgjDFxeCRUnOeEUetWHxvbW3mgot5rvfSOIh8ER/k5F\nTAMXAgGR4T8FDe2mnEDt/6iFdc3FC/zNk1jGlix4aXB0xN/6DfM3qHRnt7ny\njqSE\r\n=0jWR\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"0dba7e38487b43dbd350fb623f51c4449030e1ba","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.14.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.14.1","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.9.8"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.8_1580164217916_0.04440603142732402","host":"s3://npm-registry-packages"}},"0.10.0-pre.870":{"name":"piral-pwa","version":"0.10.0-pre.870","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.0-pre.870","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"819b4963f27f67212d29cdb6b60060ebb8d49f42","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.0-pre.870.tgz","fileCount":25,"integrity":"sha512-zTbF+6tqa0E76SxhdaSVWtZHeNw/ExSWldqqnuK8sR3UyiFCYNSd21hzQIbNLo/109Ei1sRexw6RCRWy7hS3jQ==","signatures":[{"sig":"MEYCIQDEGPT4RDOQ44+P7308l4xKLr+iT7U1tb/ME8b7PYEp8QIhAN/At5000yoDa5o2lrUe7Qf/lozVLEmCic3TaRcDxYe3","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48400,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeL2xmCRA9TVsSAnZWagAAFJYQAKBHajr+uS2Q7euUZopt\nWocFIijuSz/DjtD1v7T/5k+X7lZseETvZyCt44t4uNBiGwCS1eR39UEthZJ2\n0LGRLxlU/Fqb0kBR0BXwmY/gGcbx0OyrdcGvGkQcId7zaGXC36FNXNVMDXA3\nP+Uzu8j5iF5Lf1iPe/qN+TN99FAEXuzbv5rjXf0Zf43GsmQ4j73cUAfvYrEy\nrBa8EP4LhI24GG8wzk5CKr3bPrh2dheM/Z10HLniWn58lXOcDsPKdsKB6gFd\nqaPovt+G1oe0olsvFSoExW/0qIPeaDDS7ATHw5wnFY+rY0iIRcyf14/4m0yA\nf9m9GwWcyXwPu8fus+/wTymEJdaWg1tcRJt3oyNbX2zLrbYsBFaqAo0o/TTq\nB9qRmleUOsk11zlmnoPd2gLSlOHUdw+SyTbNHEZGyNYQJW8NW1OZ+9pvQ5+a\nLehqK4RJhwzBf4cOnikglHggUCczksDKhw+z1CdCrj4Bem081LzGntO60Qe4\nXv35dsX1kdp7+K+BrTpQMvFNt+kYwJXVoNOmocvY2XBfUtS+ndQMaetAe0ce\nz1JTJY+pYOdc9k+RS+w+xel5O8FmSz5fXwrPZWKKVGyi4o6rI3DvR1ik4ojn\nS3mVlvdvjuoNctrayoBrOemAINZy+yUxQW6lAVLdat3Q2PkhXUF+sijDuXGT\nxqh0\r\n=5XKe\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"3f5e9436fc72c2a007c9eaaabca013d0c5288f62","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.14.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.14.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.10.0-pre.870"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.0-pre.870_1580166245881_0.7673874590356309","host":"s3://npm-registry-packages"}},"0.9.9":{"name":"piral-pwa","version":"0.9.9","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.9.9","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"ea7607dfe4a036be6bd84204ba4729f75166fc39","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.9.9.tgz","fileCount":26,"integrity":"sha512-OQ+ymQiBbHqAWGst34UV4mH6VGaeJcAEoyQk3CQuF7BtDyk/w7hMgy+lxMLharikliRIHg7UtE1mqeOBZtf7uw==","signatures":[{"sig":"MEUCIQDSIBXaizmxBex2hRKAcf809TIejvUlMve+zxMkRvpjOwIgIw3zAYKNRdTejW9428n53J+JSFCC8NZ+5Co/glggnIM=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":47953,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeMY3PCRA9TVsSAnZWagAAwKIP/2jM/hc9aQaVcV9vrNFb\nWTrZFX/HSZqKYVrNSpbXavcNJQhZuT12y1V/rJvlaubabkzc/t4ZIR400rbn\nvaTS0VvbNdHhvKAg+xhXc2wXBjJnwIELpiJL1SrheJ0pFH9GH+ZNRKtDaw/s\n5jOMWXn7eDKwOzBOqg4aWEtUB302F0uU9dMdAjLM3LebmzHnj+1hg70Lw/Mq\ntetjtXrxaWJWcnIPS2oB8XB9T4T5hdEns0wFCEVp0gP7joSJGJ6005caC05P\nB/vvxIq7eJYwLyh8Ed8YJeQnUXccBsFnP2qTtyTg1F2cdSkGkiUFH7i/YBJ2\n1dwg7eGwcnqc/7KzNw4v3E0P0HZht/GZufYZ0uGdaqJILNAOEdrvN+J7vu3y\naV2SIJB0RQBF9RiZTYUTK+1iFHl75wCNH9hlfsnbnPhSQU+quQgf9R5AHsDY\nAltrbF+XTAsfI1aAQc7AFGtYhNqnwm4HS21qOQOJPqu6/U6tVsqarH1QCNRd\nVJ8o9apfvMWVYLL5vN8+3aD0GL0aEOc9P6O5bBp1ZBCiA3GxU18scy9G9AD3\nR0X1+43qRj8hevQ9GufxLvZF3kVxF8fliDCIHWv3RSvIw6KKpswxn1XxSmGb\nlHSouJoP0l9ny85htxGnpQHotYAzbnU3anfJK9X/GMiV9U5VN4zc7NiAfoXS\nZa8t\r\n=SWTG\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"07a4d59c9833cfc98b1f086b54abfbf3d65d8282","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.14.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.14.1","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.9.9"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.9.9_1580305871040_0.2269435375741331","host":"s3://npm-registry-packages"}},"0.10.0-pre.877":{"name":"piral-pwa","version":"0.10.0-pre.877","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.0-pre.877","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"0320c4868ff9198368aafc596f6863a0a647d70a","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.0-pre.877.tgz","fileCount":25,"integrity":"sha512-bd33l1sLjtbeQ4bYyEvaJzUchZQaq6U+LG8WrZn595wsQkw8M2fQMq8bCncbxjKjVYZMn/FLCC5OJjc0bT3zrQ==","signatures":[{"sig":"MEQCIGaiG3sNz+VKv53wTH0L3dsuRFJiea7/GuW9AU+I0wHTAiBMn1sXrzwnDKDDaDDGG35dFhn645OgbTJXNjSDHgTXkg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48400,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeMwMsCRA9TVsSAnZWagAAmmgQAJ8eyoW6mYpqSTZJ/wEf\nRPTzidpJqnKvdiK0paLEf8COrRzZZhhqGspO2DPnkPUJzocUCvtOd+rRrXIa\ns0xcdBOF+ALNBVD7sIlNUVSaz5l7mK6yOuXfUZ/OCjx5esLSyfonmmuSFAxq\ntER0KMFELbvT8TQl2Mim+sA5hGaSeM3FVdTzFOnxu8zUaqeWvd+PqdThN2ig\nWlaupDyDU96GNHHk5qrHGE65RE52TA3nRLL4Ssf886sH6afjSRGrWgPfzh2u\ngs96POQRJjcpc975VYVV6aUdbcEmq3Kw5/dG4xOGHKDb4lVx8TQQzvyB2TeF\nzx/diwrdGMMt1/857H/zB350Z35T3HvJfihkvnboODVD+lBPPjFl5bhTiOkn\n9u/Wbw+vbMyobZP4niZc2VqwAdIbxsurkfzHKobZmd0JT7xC8jMPSoyxp0e/\nOoW57AJnEKWFOcL8Nn+kl7/ETL6zhYkDUNZIQWebGGnAOxHRB1kpvuDunp26\nTO5TdSdP9VLODOVYcuFjypy17goZ24LFXBl8z8yXYAx37jtD9dVFKBwZGGIG\n9P1vQJ6Ok08Zdwf34eeh4s/luLwGaI9rSDKCwyhhOWPBEtDRitIhN+WIGaJv\nEuktWpIR2mzdshWPME3Bq7khh1wX8EzD1E1evGbnQJc88bonLAjO0XRr63Jc\nwALp\r\n=0D1K\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"bf1caa3f88f10651f9193c685c7dfd404ff31868","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.14.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"_nodeVersion":"12.14.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.10.0-pre.877"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.0-pre.877_1580401452461_0.8722891625592111","host":"s3://npm-registry-packages"}},"0.10.0-pre.878":{"name":"piral-pwa","version":"0.10.0-pre.878","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.0-pre.878","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"eda4bbbb18bc9835f54319afecb448f0280d43e8","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.0-pre.878.tgz","fileCount":25,"integrity":"sha512-9QgVii9JrIZDRNT7DnG1RWOYjoQTYYxn7mJ1HLyrV1CgRphxU58vuFOaZElgy86Aed9bvbd6DS2DpVjVclDmIQ==","signatures":[{"sig":"MEUCIAUVbVAchzBcwK5Gvhg62dLXeOkpDwiniiYDYi+pDcwhAiEAumztC5CsFEH4uAWjAoRonjZvLL9pg/7dYIDbESBs4Fc=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48424,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeMyjJCRA9TVsSAnZWagAAu78QAInKm8/kTYPivSPZc1oA\n9aroeDCuz7MpMWCx2BfE8aLRwiGL544n3AqSPK1TuCn/jK+RsabSxmyOQnna\ncxIgb9gj0jTPAlJANhMOfG18otox6QN0B/NzuMYps7wBHMQ5+p/j+19hGiYr\nn6dvvySJN4DFwkqpsFB87ShffqhUdZRQYiUgJCSVEBVHD1SBziBbZjqj+36b\nVQ0IOoeZ5ia40ZfrK6ZgkOWc/BEA8EhClZLjzNdPHulc2GcZtS+kCnIJ+0Hq\nztVlQ8EbwHUhGdn3B+HnrZsOyw5aWLSO71FlAF0gLhMyvYqs4JJg82Zrm2nV\nTonS2JjfqkK2u6PVk8st+gCV+wP5InQVQinF47trcuAuOFm8mTFe3zN1PZX/\nNxUBbmr5vyjL0+EopDtxoNuofbGObj4wllCFZJjQAgP/aupOJhpICB4gsTrH\n8GtD1eFO+4zjR/zUfSLaiZU/1JdjB1ldjG7j2RjhhkcJD/MvhRCPMIF6gw9x\naCvMQApuBPp9eHc30iSy84l1KVYxiLsUgvfoEYEbJ997LcTxvGrdFKM7juXL\nfbrQUJIQrmrNpL95shtldDv4GuI4NlV+qbhN1rzvG1cVGE61kkCRrWkuaP80\nwZEI4Sliiy5pa5JJ6fGFBORW3jMBoAEPO50wMQtVovcdagNBelRL0iaGwXrP\nA6KT\r\n=AJdR\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"c7dfbd0aad35eca2b3fea19db8b86ce66859229c","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.14.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.14.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.10.0-pre.878"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.0-pre.878_1580411080710_0.31048963773207716","host":"s3://npm-registry-packages"}},"0.10.0-pre.879":{"name":"piral-pwa","version":"0.10.0-pre.879","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.0-pre.879","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"f9fd1b20bc63c1e4c883f0722428137f44bd6ad7","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.0-pre.879.tgz","fileCount":25,"integrity":"sha512-/NixnEw7L+YmOZ8j8fkHgJ0mQqDIwxM52EAg32cqFHQl90sZx8SllPRyoyT6fvu9cn9b/jbyIP95bm3uyhVh0w==","signatures":[{"sig":"MEQCIEdYPYHE3Ecf+ghPBeHGJHqpmOTloQ+YmzRHXGiKRzUuAiAVRvL9t9kNyAulp2Zq84XEnVn/9pahLBYmXws7jwbkOA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48424,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeM2TNCRA9TVsSAnZWagAASOAP/iioljCiik7bdn24oPH2\n3bMgdE4aTvkd6Pzp8mLpzlnxHerorhrEnYJ1OKh2PtWpYRnPG14NLwlthxqu\njjsCWKhVxo7XhSkjID0m2Ea78m/v4ggwko5t3z6glbbcBm0v4NQXFSoJtgmv\nPhRVLjhleh5xdQZeYf+ELQfxDA+8/yj66QKMhESJoewBObRYqQCkE2odJ5p/\n7mqWUsh2rUyKAsX5fhwo/NJfzCPqUKt7lvuy+WTiqz1dqHEM3/I49O85pYET\nLGfQJMvtd58RwczU/7RmDxU0TFDdluaC35zGhH5kr0V3EJCX40ed8GsNGILe\nBrYpLC2GVvanBoAaslZiQzQcvdeIJ/XFzXa/8Sb8hyOPcuMyH34GyTgDCQpj\nfv4hOmmD/OTjnWqDRIETAv7fTQbypCIBytJ6YXanXwODMDIdfhZQOXjjEDd8\nbeiKt9OLNaGM7EN4hWdtkD0D+JHopo6maDPRO21COeKsXBUk0/6QXns/YddL\nosslohY0M1HZMGfNLOOajUkir7LpYx9HgcBuIWBaSlzdwDb+XadOj8T4C2hP\nxfeMi8XO7u6pz5QVp3dLCqcW0gQzsaLOsqhagMPu2I42Xm1wLG3tBaCniD+1\n78HnH/UKW5PKzAH3sMrinwCu8X/0pgustfz4vIhhRE760WE7SDTwsvuMfy09\nz1AB\r\n=1u5e\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"db25225fec681aab93e9a10ecd3cc34bae1a2fe7","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.14.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.14.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.10.0-pre.879"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.0-pre.879_1580426444511_0.7186081338848072","host":"s3://npm-registry-packages"}},"0.10.0-pre.880":{"name":"piral-pwa","version":"0.10.0-pre.880","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.0-pre.880","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"4b2e707b3500a3c009126781f4008cf3afc10771","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.0-pre.880.tgz","fileCount":25,"integrity":"sha512-JXJFApD+j+EbjI8tAI3ls+DifpQls2QqvHeW90UJgeRyxb+Lj0eto1M98JLbS22TlTY+074K7hTDiLu1LEqVyw==","signatures":[{"sig":"MEYCIQCsl24dg93y5Rkb0gz3YSDdzUhgZBk9lJjid0Rw3RsHgAIhANX1SFbHKpE0PfwI+NfmVwon5m+B3Gn0/S5Sn4jionyN","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48424,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeNAj1CRA9TVsSAnZWagAAGawP/2kDCqkY/AvMJWtdkBrJ\ndCwkCNzGDSrZq5rOMsarBPeNcYPSbhDt2CSXRl+mQV46V7GsPJD5wlvHhV0N\nKEG+NWZp18OkZ8bqmAMhmYdTUB0gBte3ibMfoZrzzVVa0UNla3yXLT9WK9uV\nB14XpNm8n4dusLLWuI0QOrwylAvgdXRu+2Vhfr1bLNP9BsEim+fvzpFnqvXl\nDO18aT/e0h6qGsv9q2ACwL/FGKnsbndG4Yb9GVEnXSgLWJo75JitwIfXF9qh\nZ8M0iBLTQgGPw4HytQVasURqRXf56Ref3mRdxqh0DBqOs1b5p4BkfWHWqwYp\nfx6ALlzKh51dYRM8O66gfeos2gSiMV7B3yALlpMV34tOrKBe2ZERPLi3sDFr\nzliC33LLnmar41q5XHOzErXlvzkO7x3z77MAacfE8Bn71eaIvEjiFqBkU9SE\ndV+0oFB4puB9XcIeS8fFxRGspdDE7bG68A4MIR+PrgV4VQ7GhCtvSTImgved\nuk9UVBx0tJ2ttXMAZKMJlS1+MyP5VZ61vkeYBkmb3/5HKOaEKTvOlgny4A6y\niVgR6HZltVuIZKIO+F783Elv9n9TKwJuvrVtnvzvm7GWcMXAnkXBwGpwpkcP\nzmv7VHhZSu1DjipHat8mi4qJK5uZizjrZhgCQ5FTnPWWIiab/lP902n6Wiv3\nC5Ie\r\n=T9JS\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"922e2bbb5b1447d848e04ea01076760155381b16","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.14.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.14.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.10.0-pre.880"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.0-pre.880_1580468468963_0.6942048231333668","host":"s3://npm-registry-packages"}},"0.10.0-pre.881":{"name":"piral-pwa","version":"0.10.0-pre.881","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.0-pre.881","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"f725af8dd1c43826d4dac0e78244240e2175be34","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.0-pre.881.tgz","fileCount":25,"integrity":"sha512-iwTmhciKr30w8Ty88sGbXF7OXc7bhKOdbun66JL6alVaRwUBUW73K0tjUUM9U5bBhtz6L1gHDt5pxkwaQwoZcA==","signatures":[{"sig":"MEYCIQDXnYat7qnTb6tgJFUqk9mx/PgHc/bKesoQO+NmpalrTwIhAJ6leLmkyIJPkGK84gFdglUJkYyfjUIdMsGnPSLE5u3F","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48424,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeNFNACRA9TVsSAnZWagAA+kcP/3EB9esHDCHBegu8b5RZ\ngS+DhKT4vWWSRAkb3aCj/hXKRFGSPrBtQ2KRj8/nXhAKMybYlAfSH2no9FJm\nX2gQMCtt5wT36X+twNbckUttZnO5a6zZSiNU35s7MWluzdeHKEiTB06Ce3sq\nU3nou4QadA5jZCdbKF1ciahaCiWHXqxA0x6uqNM0jkWEgHA9TRHjxhzxYmx2\nWV9Epg0BqtyMqeitLXvXotxIizmkGCJO0rzq4md77xHOUU9+YE3eeGgleLSq\ndJUdXB7VMpRRvAPd1DOpyGtOhvu9uzjppuNHR7hG9Q9BrymmzukNwj++r7YE\n2vsL+UzU1pOZJnsK75WB3h94poNQ27/LinY7/7rUfcvw3M5cXGj9zsO/rKai\nr0dfHdeloN1nGtL1fuUrzaJiNfyXBr1ALkRb0v1xVvqHd5aweaFVzCtKmBbV\neqpV9WZhHe6ih7oxHRIG6TkdLCWgCZenN7oXf1zDIIpma5on+y7Wp/ArkDKs\nVWqTiWdN2WBpSFGmrl6bVdEk1yalABXfuDkSsTOG3TTDB9QyqlUtX1bxoo3p\nWCy/i9tUpZB9wf8KEhojyQwsZlGr9EQDl47Ob9Ig4lo+vKS6tnD6kJfn3/6I\nFgTKmxpZc51dpDYQswifrYjBI4C4fu+bToTkcUhppMKx8dNCidWevZS7bewZ\n+/BG\r\n=t/A6\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"f2b9b15c8bed663db3300ef34de5a9ad02ab4600","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.14.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.14.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.10.0-pre.881"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.0-pre.881_1580487488107_0.29756915953278873","host":"s3://npm-registry-packages"}},"0.10.0-pre.883":{"name":"piral-pwa","version":"0.10.0-pre.883","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.0-pre.883","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"9d8f651396a424c07261d1336cafba22775450c2","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.0-pre.883.tgz","fileCount":25,"integrity":"sha512-2ORqcN26Kkui366jJQ0KQwxGT0Ttp9+WFtFtmvxYtyXQlZ0Wb7HtvbBxvbNgjy4Vy47t9oqeiCfa3nUxquQYGA==","signatures":[{"sig":"MEUCIQDva8XY/o+pOkcuPsXRFAcvWPQ4hVZu/lfBhEXuNqmw8gIgalZ5XULHgk8iUhSECIWEegDi1dDGtfCuezXK3L7Ytzg=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48424,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeNK3jCRA9TVsSAnZWagAAwsQP/3pvdZn4hY+T4YTu2nu5\nY6+ueY3lPJ048i610QPWXbWXjgJ8TK0K9/baXlrDRAu2IS7wSwyLxHTV3Efz\nOGj34PM9MWiwL+4JykiiGEq9A5DHpyIp3vx5QvsD848S48V30FA3MKAgmt7d\nUroayzoqJvucpD2pbq2wOVs1+uu3X6hIN1NUIntlyW95hQ0JaIrJMlMqszlj\nO44rhwA5GRbqd+zP5neir116Yzx56p/seWncqFGPX5qcddFQlrXKcvxtK5zt\nqGVq21fw4kBLP43OSf6wjnQtWS8jFeX3w5XMnZ+eMbQDR27Xn4r/KevSRh4M\nzNPGciy6YZYcLAIQCNpLiWvxgdTo++vgt96BoBpLUYNXoq6RXmVTeXBYiebY\nuU/k9S6zxqd4VMOqbNIjpJ6RBzRrpUMQRrjJ7RbEKHcdM/1ENcIG2v6qOheo\n8fA5VcUcFNapjtuQVdonlwL1Jv63sPvPLxY/LDjSepL4wELJXz+H5ntptQfA\nm5L3974iRQlgNr2ENTV4oCg88rLAENrOBd5j6SgYkXSI9lOw88+a4wLzA+Nf\nS3al/86/7oO0X0bhGuT6qITO2WUgn7CDm+wUS5Qtn5RpR7YftbvjtvU59QpV\nCbrarHh6gZAHWbqVKdNmqHH0TS98nltBK8BUeI4RfR283TsiGxI84r6OkXdV\nsFI4\r\n=RrC5\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"4de08c8606e75c113f60db38aa5ab3f15f62b7be","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.14.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.14.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.10.0-pre.883"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.0-pre.883_1580510690763_0.21720166210028058","host":"s3://npm-registry-packages"}},"0.10.0-pre.885":{"name":"piral-pwa","version":"0.10.0-pre.885","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.0-pre.885","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"55c324fbb6c009748e249b72004a94536a0cc846","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.0-pre.885.tgz","fileCount":25,"integrity":"sha512-dMZNKF5ZW8O4EpNq+LYUBlzFk/30bVCmYyLVCHe3jcQZwAizOIsHu/HgGCgfBxKloljr1s5UghqrXRRxUINqlA==","signatures":[{"sig":"MEUCIFB35OXi2RQOgx1HejdO4xIXhO9DbKDrmSp61NXqIhLUAiEAhAb+NdfWXs/UNI5J43roM9Ke6zsTLpoakz4kkvpK9GU=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48424,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeNXuMCRA9TVsSAnZWagAAqQYP/3LG+dSzP2Io/7O2FaG1\nVWitI+p9JWgzal3eGrvLBSBjhAxIufTDetMFTH00fnDF7m7wxu7XZIYOmVnC\nf/iasgDKgTWHdvcUHESrJHJDaf/3Q3iCcAvHGQG6hn2VSNSRineXM2/gVscf\n5bFkCRrE5iNdrtvp+AH08yx7l8ahtNIETeYXwahmTku0ajmt02Mhg+NFmp9L\nd8t7syTWwZ7pHq3H/w4/pHY8qRAB7MUNIPt2QWhLucuGpViZXRu5fuVt3x6t\nhJkbxb2uVkfAnszqXCsrnVIfVquu+zKOht4ROOeuav1SVRBvB2SAZ1HhWcUB\nwIhGzVgk72iBhFNvhro3NxKFzHRZufdD4P8QgKIIjTkr8kU1LDjnV4aUoh+J\njVCouKksxWBYvZVM+am9lMR4HrvVUfYqg96rbHYsanj55cBuBbfn6uL0L86Z\nuhW9wv1+7mikjdb+FhNxbw1DJ62O2keR8qByBh90qJQYsEZynqwyhDCicW+b\nB+u5cqerwShVsDuTRsw10q3AWZwps6WbjhQE4nYigSNHzLuzmWhnoElEWK2U\nKqybfMWPiQXqKhV35BmhphN156jVOT97FHD2VTpZPwAnGAC9p44vtuPa9Srf\nbRqPH8JDquoyj/5k7WlFQT9yJNUOsF/dBCFkT3a2v77ePwHNyqfoCSnpgbAd\nPHZE\r\n=8Urm\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"21dd6e46d5478826848c21756a4534b7a1e87ad9","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.14.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.14.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.10.0-pre.885"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.0-pre.885_1580563340152_0.08652323484443492","host":"s3://npm-registry-packages"}},"0.10.0-pre.887":{"name":"piral-pwa","version":"0.10.0-pre.887","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.0-pre.887","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"1f47d568699ca4d2e9854c5df7052db7597d671f","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.0-pre.887.tgz","fileCount":25,"integrity":"sha512-ZglQUYD/WwGU6li86hWvL6Z2X7I168r4ozTTA1BLg9Zd6xNj9RVFnPGEgHPMsaeYSbrUgXfAnvCcYkmX+p3sRg==","signatures":[{"sig":"MEUCIQDjYEeyDUn10RET/KdoeLyHCY06uDr67Y6aVgL1gU1h7AIgHiwrfcpjkpEUIUbSwKQUYwP4Hh+1hM6ROAK7k73XPgs=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48424,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeNn2cCRA9TVsSAnZWagAAoEEQAI4EFs2YuZpNIu3Z0/D7\nfcEwRkD9KcbEVXqa1ad2MW3lQ6fJqWDPbpLsbk+pKvsShN6SgJ7J0L5wElvp\n9j9T+1gNHYBVcpvIx0SENPpc26X8FBe4XqYiim4Httea6L2pTl8+jwKFHul3\nwdnnt1Ui/Cx2YeVKZ5v2DM2BQ6m7sF8ekoYgtHWmVrLJoPgg/C2Sm8lez5vC\nSThKRl7mAHZyutaUbbN0uZYMqR62edKA1s64+2SsqlvojlgPU3wb86DOks8p\nRbxrSJ2KAo9NpYB2WP6XRIfYnEr5kfp3qxc5Uo25M+A9OV/oO4kpjFvybn+8\ncajdfYc0SErCBpERjFA5iQgtKRE0Y522dlONsiSzaSrULGaXGdtpVebgJlV9\ncoD+Q6vkSe9pGS6nY3UMhboEG2P+gZmQ29OuTiOX/SP0VQWOMWowbgYerCL5\nhuUO976hMr+a2tRUA8Jwc5K+qMaxUev8mBDb7dS6lInoBARcE3MrIIknwUOX\nFELkgRI6Q2CamIKXwEVuJzL5yN8fVmME00X1eedLxP6039OxxpnoDejXuzZH\nD1tDFvvcaFPou9vzt9p+JqjXoGw2C7Kg0ml/qCCmJgkKESSjKi4TQ5QWbhL+\nsAoDfS4Yv/0qHQhNT6frrFP0v0nEL1qg/3GWx/rXNgtx/nOifxtTv/QJRiu2\n6pDG\r\n=AEGh\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"a3e3f64790b46519bf28a49e31025cf00fa94fb4","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.14.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.14.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.10.0-pre.887"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.0-pre.887_1580629404404_0.48784088159452343","host":"s3://npm-registry-packages"}},"0.10.0":{"name":"piral-pwa","version":"0.10.0","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.0","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"3b9d793a7de04dba71fccb50aeb1302493f5cf82","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.0.tgz","fileCount":25,"integrity":"sha512-mTc5zPTR/YOkHNMQzMKan66UXxNInPBSzkyZITL40baPc1t1mn3z4z7JK6bvMy2xNmcnajZyhhlh7RZCrDrdGA==","signatures":[{"sig":"MEYCIQCxP5NF0Xt17416HIGEOnLYTOHM3mNEEY+ckAuWEsqctwIhAOjwDUpTyss0P/1p5vXKTBh1dE0scC0LL4VrzrWK5vjF","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48408,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeNqFgCRA9TVsSAnZWagAAmZUP/2t2fs+VgKAVulIcsp4g\nRqVbOAio2A9Jj7UPMnknemExQ6u8gAo9QHn3JCPUont9xkPfZki1GXCLcGPo\n9ozu3K60uYiG4R3S7+7IdokiZ4fqfTsJtdzpKk41qINV9dv+mi4dwqtZBjc3\ne+RIz7ZM1PK9f+3Emfaghi84MK4LX/PyneOOgJVVMnuwhTIqtc6h7kJwDYKx\nVN+d21TLGViOLkMfyDvC0rU9+fOjpFNiM9OoGhRu8vbK0htMp7OC5wRpGquT\nHOIMZrOOLf2E5I1AA0DODdr+FWoHFzuRXhDcXWjejqIgWpgf+e94IvC8sJWq\nWHP6+tdQ7uecTy/AoHvID7dbaohYVKXeTFbw5xtoZC3Iq58VFlTyYJCWa5tz\nC+TzOu4GHhgcgVunmDqz7DtHBo8RezUOt0rkrSrpkDzCTvEwNYQIRQsNCOLh\n3HQYf7HfVcxfvqLcHlne6jw/XFVJ2vplVdhXgeYTSt+eBl5M1br3m6ZC8ojj\nteNRImAibOCK4CHtB8WP3uw4XeZyKuLprniffh7ZRmGxMM+f8fBgsNQhqUTw\nof0T0rrYMcFf8UZlrk7R2TTYdYIWCkbQVWUCe7HuXLHfi5XFFFpckBk55RQm\n5sqJvT8POPzb+hwyePCfhAkhdQfTfK9oNwi44cB15aXbhpjD4e8oq8NHiju6\nPtt9\r\n=mrgI\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"7c5a6e46f285d94749c3d9f4778aab8483435d63","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.14.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.14.1","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.10.0"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.0_1580638560546_0.9012074199698499","host":"s3://npm-registry-packages"}},"0.11.0-pre.891":{"name":"piral-pwa","version":"0.11.0-pre.891","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.0-pre.891","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"c6cdc70ae6b108fd14b720c10f41500e30f48820","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.0-pre.891.tgz","fileCount":25,"integrity":"sha512-qX5Y4Cl7pDN3Naudm1nYY+SChPCplmt4auTNXIZeYlgUcGq6Q4iH75IB9LzatGnmXHxv/yMWloWVYyl0mkea3w==","signatures":[{"sig":"MEQCIAWyLDU+LNzqa9s/gjC35tSWEH/747decPHG/hqaDVabAiA9qL/NyjSNY9jl2baxmvR009t4z0HcY6n8C15qkH8KaQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48424,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeN2rTCRA9TVsSAnZWagAArbQP/3aaMeuEXqchpH6HnGDl\nUyeGXwe3jc/2Liit1CfYlVgWguPhenc9o55TbNAIK9MlDplkBGZTO3FIzUWg\nxGmnx++gpTOyrfj+NFk+j4jNCVoMvST/vE0oWAORLin51pwPwf+Bs8nWmB8z\ng1Ut3l3ugwrsGcKVTcs94mWVeo1EYxt3iaDUsHT/FRzgUMQ4PDCvxBbBHRz9\nDV9cyK5/xKYaN5iG7bWNrlgpU86pJsrGzq3tAQb85qFF4ECFmFOUZsGmyFSt\neBb1DDRVKmhAYX8HWDQgI4F4e+oaoO9NMYCmZHeHcjEcv9RXRFfoSRskMSHW\ncY4SWLH/aOa+UWBG+MgeTzC6AyfcXbj8YLcX5kD8U1r9t5iwmi6O1HNnpT5y\nOngEgWMtUfJH+WxHoYr96B1VRDRrBwWe7sGxos2zhlJuOetfruuzBHKn4el1\nuND/pGmNRxQ9Ip6DT5R5R/8LLO1Y76fxSxXWEBjqi1i94ff7ydAp0S0n2/Bb\nYZQZg/e5mnatdsLO6JDEFuhlLXA5jiE6zZuuBjToIPesyBf2ssAH2bGUbOqj\nzA6KX3mdvoJyEU038OSdijYq/+f5Tct0Zy4LYk1G2oNWm+tmp8BTBL3KJ8Lp\nd2dpZJMiIL6aMc4nNj4bU68QaXrjeONOqdnpqwKe2OmvGDDRY84Rl3gb/qkP\n514z\r\n=5CWv\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"986aaf2b3e2977d7b2718defc713d72d9d87bc8d","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.14.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.14.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.0-pre.891"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.0-pre.891_1580690130745_0.9942341299583686","host":"s3://npm-registry-packages"}},"0.10.1":{"name":"piral-pwa","version":"0.10.1","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.1","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"f8f08473fc022915658367b7d005a5e3bff00091","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.1.tgz","fileCount":25,"integrity":"sha512-JrmOKXMzhPixRcAh7ki8548TR2wCB7rLh/5ObB4wTAKikJGlEzPO2xlBFPxnvmXC3ewc5tcgzak/G9Im04Lpjw==","signatures":[{"sig":"MEYCIQCOz5VGnpJJINuvSLpKsiYagtfKufDYo/246pvR7S9xnwIhANd/39gozkfOdJhw0i+oqIKl3M01a0eJa3CFTadw4+PB","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48408,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeOMfmCRA9TVsSAnZWagAA+RAP/A4rsxBE0VOuLHnsKBt/\n4Tmv+VzNvHdJdUgv8RxPFu9qu6VxBsm6obGFaS4FoBMbZLnMLfYwVKo755r7\nALl4hByL80ZE/gY8z6hWkyLGgIvF7CHW3CeOaeNxBBxGzN9MWFJd8KUPB2u0\nWvLFq5Ovu5EQtEScJCWz3rnyjofkEjWunGF437Zpa1BRrfaXnodaIZPv+yW3\neoO9IxJShnTS4q3bYSjFHbhACUKOMRvJpjh+bC1CrD6724vUWLVvzB2v1mnj\nMtUjB3OEHU54eRWxMPbqcTb660ta5wyMVuO3duKHz6TQZCR5m9YI+lPPtPkg\nkVfmH+pF+7EFQSJWxKfVpWj1JTd2y3HclXOPjgHWNH8f1CTDY1ilzHYZgkcL\nQhI9ZIosxYowtpDjX5Lx7ugPYUuYUi71mHnF67YbKCA4L1S42ROTqycciJO2\nl8fp0kk+ZqGWC+nS7SvGpKllke2BdXN4AZ1dkfBmEEyewew3/ipPwZ1i7yjn\nd3idpnVDkhnJE83NPuGnEqlziQnm4U4d/wYz+VwGBiNXSPsGepRQqJSzBBnR\nrxYHxiQHzXxd7Q14jGE8GpEofT3I/LNKXI0kx7hJScWo0jLVVU7OXFyj9uOH\nvlv4pgonlr0momcergJoCtmRbG1Gs90MqyZJ0RsIl+9EJUTl+/Sv31rczlIv\nnJyX\r\n=FeK2\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"b80789c07712083aa194d9673d0f271a16d671bd","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.14.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.14.1","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.10.1"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.1_1580779493980_0.39206055642370363","host":"s3://npm-registry-packages"}},"0.11.0-pre.894":{"name":"piral-pwa","version":"0.11.0-pre.894","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.0-pre.894","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"1fd5b8db6b3635957d4c5b8ceb23b797b95fcddd","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.0-pre.894.tgz","fileCount":25,"integrity":"sha512-EdgEsgvzoziektYLmJmU1qAtnVP2Yk4+DNihDF4YGFHw/nKRH/makEmdCX02bnCDycKuG3R5Ir4R4Tn7QlaSYw==","signatures":[{"sig":"MEUCIHwtm7i5c3JRkRQnn2qHdYbBL76WBD+k1umkb2vZ/PYcAiEApncYkGN+QHvvMTSjn9fwfDzc/Lga2HD+PZWnH1E22A0=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48424,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeORMUCRA9TVsSAnZWagAAWysP+wSTtqAkPBYqNIfP49+c\nwG9qAmIdI41sqYQ4Jb9/1lJniFcw7WojDwm6ZLZzgM+cr7lWUOap8GRIEs4G\nVPObXaCcWGanOPKijFyutPIcXuv6cHirsIEBQDUTIwYUx+apCi0CVRApDYpw\nKZVZixfzz0z8Fd7LpnPCaG/3F53TX1fQ4SNa9LVVIR+nQ6wX6m6ga71Wvb6C\nBn5EdPVHeY+PvwHRxy2e9T4G+3T+EXHdSuYGnWtJ0NE7GtArKh0mIv/SiGtu\nx2NHt0uGZadEcsYsd4ju1b3W6E/xUNfjWnebIdtJyKSRMMU2utIJjYFMUXA9\nFXwHZqGkxcIPLmJM2GwVgI+UkrBDi/5srst2wPIqwtxVZp+jQDEzXG30C5kX\nNERME3XiQqlxGPNvJAL40+Hf8LNIjjqvX8DBGYIicR7Kd+8tH0YMAljXPAq+\nf61yaOK/40m07SJJ1Y4sR66Et70v5sNbxmAClJy+vmApsgJwWKQiVZZhqWmW\no1yiEzcR/kpZcFTi4zgBieQjf5fFeP8joabdT5F+RxtSJ3L7r+L9RvD62wT0\nzzXaXT+RMVWAZFlojqDJkCo8hK3g/85E7Yi5pmRitzbDHAeFiN9SaD1XuN0t\n06ef06GnICgiXdone3YNjSW3jrQKMrpwob5nymn5XO08jLmXu+AIkNGW6LBZ\njPJx\r\n=7Grw\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"f65d88370c1bfdd90377b7d70b51afdd9e379bc6","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.14.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.14.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.0-pre.894"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.0-pre.894_1580798739803_0.2676572485315514","host":"s3://npm-registry-packages"}},"0.10.2":{"name":"piral-pwa","version":"0.10.2","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.2","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"68534ec652f9250c907108f0f65eba4081797766","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.2.tgz","fileCount":25,"integrity":"sha512-td6/OxaIw4YCEqiEi+TEJSytoiPHe3YYO/9X7F3BrFMxldM1eCpA2WRcNCDdzDY7DfXT/pEaDneqjRytTZGASg==","signatures":[{"sig":"MEUCIG5s3R5nz/rZ0a4iPK0DLTWu8RqGmCNM2gEypgtymWz6AiEA3vwug4XGVhlLtBv0i6tAk+3obEUMpF+N6HDwM2istCQ=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48408,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeOtA4CRA9TVsSAnZWagAApPsP/1GLwnteyc8/P0uyoPjp\nOj6dGitKe5fCDWYIEbZbm9QFfX4E6b5wKorHOfA7Z4ca/WvwgPXyN1BoEyeI\nYuHfA2YV7w7Fr+j7WoLBTQgojdhFTi0OllDNvsfg/GWn/+Z3YjFrW746xUni\ndILiyKE4CbTB4Fx0/NbfxKq6HND6f7UHIixJ0GtTqdO4zEWRwlcTg6mUIWSR\nRK46XR5/VG70dEkGM8KJIn5Y7py6q799hFzN5kX43qL4TSJnNH+IVU1TlOrX\nIVWIQGM07NPNfnPue6tVil6G5XurIjXWxu9bVCQK8lMJXmlwSvzbfISZF/ou\nIuGW91BgWRZvR2c8ReTRP/YitnhxjBz3peaker2Jx1RUL5U/MPUvAmCd78Dp\nWRIEPearXMGvFnSw9hYtCOByRRHEv5y1cxNcom5tmSE3lu8jrvDbA/H5oP0c\n9Ps5cidmJ0w8rpY6OTO/q1wgo3B0s5wvSKQdqGixfjLnnqdiJAjlPT0FjSNE\nBOvrvXbq1tl1NRx+ovUAL9KU+4rKwrDRh1In25+CpPHsjOCrSbY2eDPShSbY\noqtEZ+EFtiEafWEYQlRMmsc9bQOqJa+FVcLSk5VShycReoB4e6GzHdtBqupO\nEb0ZmipGScsYy3MVsIxH1RZDnCU/dmmljCkJgl4x9MF577XdmGkDl+vDiZt2\niBjj\r\n=M1w9\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"d5e91c251ba96740dfe9f8995ed005df19fee923","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.14.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.14.1","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.10.2"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.2_1580912696535_0.6259145504114982","host":"s3://npm-registry-packages"}},"0.11.0-pre.897":{"name":"piral-pwa","version":"0.11.0-pre.897","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.0-pre.897","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"97e986c9f189bda76f252b5d457fe688dc6de974","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.0-pre.897.tgz","fileCount":25,"integrity":"sha512-5Us4HZDR4hdgnOz+bxJTu3wmtS7pPx+Ssdl0zkkj2w/Iq3S+NArSolQQNEdgZpmVBBMbzLb8n/T8ekFGmD8UAg==","signatures":[{"sig":"MEYCIQD1ACw/jlKlM9Cyv+034bWVP5EgXorJui7oddSKd9QIFwIhAJ5Wj2IRh3XXmpKY8S+Hv+pqXnfztBFXUp9TDXHLshRF","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48424,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeO0D2CRA9TVsSAnZWagAAncIP/iKD7OCEvZb877f5Yqx4\nKGI6Zlgo9m3mLmpM6hEsA+080Z1sFZ4NnVpOGH3K+o8w8csemREGBeUR3L7v\n5r0VW4bdU6CwLQg4XddGvLJaXPYBpmB9F5suqQ854j2+2NZ/Mx3byFj9VuEX\nALsVI6U6lG6GitZ5Jn+V1RD7qVsjAvQrPvsa/Zh0A9oBqG5MorySjEBsMEN6\nlt9/BzFwEEgWgTvDtc0OJmf0BIZclOMz2gNr/7vZjyyZKsZ3jKUyGme7ZR+C\nmjJAnDczGfU+AOaQ3BJXTEPTLXXTTYYLaX/2lufNDZM1OJufh5z2KSilbfga\n29O9Rnnjp2+X6T7g2loy6OLHYVL/dadrbVJSm0nEcEczElyizOVSk63WH7NI\nWUvt/2ypvLnCWIp/FNWV5o1RgrrI9VUqFBs6kXpg3i3JzTEicZtds/uAX9sa\n+UZXMB+rEvnO4YFcDgmOez+Rw9IkgvChocamB0C/dvL2K1EMmBPPi06BG36Z\nkFh9xc9hbXdlxo1TE1+yr7JXWVo03EVljJIQg2wmkz6hjRf0GV2LH3NoI7pI\nBbGaULqbNsLD4NjsRPl5Zpu9EyrskzIsaDs4i6kO7jzZ4a5zIZXWNKfX9guv\n86coiJf5jRL1J8wF+aElV9101bxV8ZDj/SJOPWAHLyfBS+nNS2oSjDpoF7dZ\nBsm8\r\n=GimZ\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"b375625e464e4ba5f87d189cf3c31c2f2bbbbb3b","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.14.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.14.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.0-pre.897"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.0-pre.897_1580941557604_0.017041685320164257","host":"s3://npm-registry-packages"}},"0.11.0-pre.902":{"name":"piral-pwa","version":"0.11.0-pre.902","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.0-pre.902","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"6b0824ac4daf8c9a821198e18d2f536a47a6390d","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.0-pre.902.tgz","fileCount":25,"integrity":"sha512-uoICPIJ4RkhuA/vYX2ovCp2ac8cuFq4xMSUwr+sCyyRq6DzkwUoISukb7UV0T5FrY3xshGScFfyrqTtW2MT+Rw==","signatures":[{"sig":"MEUCIG1Yi7fFMRvcjmIlOwmKv0YQTmzYDYkYZOyTVYQzhUi7AiEAoFi8MEbDyuyATtgeGn+EWbrOHwmYgNahSURtBI+b0wU=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48424,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJePTCqCRA9TVsSAnZWagAAvP0P/RyAz7ZpCIgb/pLmSm4j\nO6JrGuMKuybRa9wHLA1MXbJw3Np9fPgwMehhNrfgiVgmO5Qv58OAh370rENj\nuhQSs12N2JNaKqYF/Lor/tHNSr+WbcB0ZQ5ViDSMcWlstp5x6bm30pZCTFvN\n24mJH3hZg3zT8ZbRH0L3s2xoOoT8KJm/SbdrLIlelH6QgykpiWN0qZPc8n4f\nyewGi6DXsUcc2+e+qXLJKTm9CiPUhwlI28gnMvK6fsdubloijTjMbvJQfxMj\nxJI9bX4SxIDhLtmqJn8+KyaJhs1YrpkdCCyAiUwcsV3YWuqe7gKoK2J2Od++\nb8zbvc3DAbRnOHe+ZRmV+F1w4jGXcMPhv7EnOQCObPDRKw64H4la3G8+G/6/\nnKQmYyJDrAeZZGRUN622yjRVskiYX4X8O09fc6HQy7wn3Cye6krhJscdbUlo\na4z+FfG+67iwaaQME5YaLIAGvfOaE/Bu1++o0MloOrv4lBwM2jTIw3T2gSO2\nsWPYZb5FcCYvI2LC89KZRgXW81fDf20At1+9gEy40c1/gFgTzAmDCGG+cs9A\nvxovV62UWXGzQM0ot6yQeebTbpAs2k4Ug9n++PKlMbzAnk56I/Kba5mVfz1q\nf2zPpIPSFbDxUeNE6LE7DHay1koLlx6oyYJ1rZ9z9JaOUJn4kAooIqxEARtr\nAlBw\r\n=T7IG\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"7cbc35af921f49f7d664edaaa70757e5e7e21413","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.14.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.14.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.0-pre.902"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.0-pre.902_1581068458533_0.8208754951454817","host":"s3://npm-registry-packages"}},"0.10.3":{"name":"piral-pwa","version":"0.10.3","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.3","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"5cdac2c18b9c723b79ad3624ac2a0b6f67413de2","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.3.tgz","fileCount":25,"integrity":"sha512-YOLLHoSU6dfLhN6StapNRK8UCXJ9d6jD3kKzmAQaDXo08M8SA3jRUn2qtEqAZVfvYNt6UhJr0zNmqqnrpxgYdQ==","signatures":[{"sig":"MEQCICY48KSs7+mwm6ZpAh8o1LkZ/G0e1OEszyYuK6vOXi13AiA0vhtgOVMVVDVXrJjqguCMi0dC58BLfCf9YXi+Whh0Dg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48408,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeQfV8CRA9TVsSAnZWagAAm1UQAJeFQTw+rkig3oWOZmRY\n36yOTH0fKp4LsexpldOQFpqGUYq9qr5lUKSKMo06Bg9e1PVNDyGzbRlwQeKN\nRZlVoQqFE7t80UlFuyOONyPaATJi2X4LsKzXG23vkVqKYVM7XHp4EySaI83q\nJK37iHJWYBmEMv4kTyCdL1cvdfekKq34Vo6rJte3M7en5CI6YcAQ+EXAThu2\n1TcnsdN3d4VfYymECGsYO7i+DJJdCaSr3wz68hgS0a3lwg3rj3pLr8jmgyCv\nKlYxJ2yO75pwr7MdCkqXVN5BAq4OcnbkWOTZrGiTclJhwFwXhNM3U2tngkAv\nG9FfsR1Gdh4xT4hCVFFtama9U8xL76nkCx26MvwR9/vRrBzZrAUH9lMOL4av\ngPTIKMEc9kTR7Qu2MGRYBh1XO2zKvBK7fPxr6NID2tymi0Zgkj9eklBC5xvT\nsLIIjHo/jFArqzjlgdAka+myanFGfXbbt7eSQIoMAc7G2NuHxmb763K/nj/G\ntJy24fEmka9O7yHjgAzVqliso8wQTjFJcRF8+6fkuS8sWQ+Nx1evjb4zjDFT\n+JWzXqGkT0/oP8bRz6rq3yKE3dwbjMoeOmDvKc0z7+abftEr/0JptMSpgJE/\nGzXJXkVgKwWK1uygPm8qYG2U3iZLJNL6eVdeZcMRmG5X6vvT/Dk0mwOibZIM\nPu8l\r\n=MaUN\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"0ad92f1e5688ada20cd1b1cf2d4ca8d9870524cf","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.14.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.14.1","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.10.3"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.3_1581380987889_0.839561904008354","host":"s3://npm-registry-packages"}},"0.11.0-pre.937":{"name":"piral-pwa","version":"0.11.0-pre.937","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.0-pre.937","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"3e193ada197515c9a5120feaef047c805e790218","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.0-pre.937.tgz","fileCount":25,"integrity":"sha512-I3koAizp3kdVs8XcO8yU001EV3CbCOn6HHoJlK2DO/9wz573gaJri5o7MQDDXL+zczLszfibaTuvFWBXvrZLRQ==","signatures":[{"sig":"MEYCIQCZa/YuKeOaPnlx8HEWU/j0g8w72PQHDSOD+/fP73W/ngIhANFGcNcDhvGZCz7JLPJGm8Vo/vq+335wGVFTdQ1S195y","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48424,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeQf3ACRA9TVsSAnZWagAAlikQAIOe4oJmtYZ2NU2OGail\nP9BswKOyDa9hi3+Ng00m1G/vCRKfbfUERI2y4tCZWQNlhyNpvdzBSXbGXX6B\nUJTzLfXP88Ka/NnzBGbjh9gOIEKdsW0DxqvRJSkvAd6etRcLxEyrRbSaFGBU\nHN/3oxEqRnnWdthNBZteWKOYPnpCVMDCqi30qPNb4WM0vBXSUaV5dDGWQ/0R\n7M77Ew2yWxBhPDQE57BZUcq9kCf1jrRL/0jAHqdBob3ganbAh7jB99riEvVk\nBymZ7sGL0cMsS4hLInp0PD9D9Nr9O6PNvjDFftR/TGcnAFgMcesaYx8efUNT\nKFkCQGiWZ2h/X9H3whXQBCHa6PRCBmKBjy6X6eQs62FTvW2Jfg0dYxhK+3Ot\n2A2anvOE3c30rMbdBcXQjra7FdpfI4WAmyYL6/InVzFV+eKVljEniLMo2sry\np7PnX2Cqr5yQn3VEyF6NYeCVrWJ2hpaUiXTl/4j/rzIZB7iBnlbYCce3K03O\nlfD4amn/RePEbdZSNFHAI0y2fA7r05eugppTOns6BHEVmsMoTJ+iHT2Lh5dt\n3m0laqBmdOR7JYuWQZZ/Nt1qJ4q0PUYaFMdoog2L1aG3s5vFQUYfGsK6MK80\npuCvJJe9tvJqbo9RiEsQhZjKcuCv7trjXBuEG0oVVmU5Jm32tTq0heETHu/2\nczHr\r\n=XIUR\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"cbf15ae350358a406b53eea1774105ab4b02709c","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.14.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.14.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.0-pre.937"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.0-pre.937_1581383103485_0.5951491425499202","host":"s3://npm-registry-packages"}},"0.10.4":{"name":"piral-pwa","version":"0.10.4","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.4","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"ae6500a50a84617a7c773e2328ae2b9323816e24","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.4.tgz","fileCount":25,"integrity":"sha512-FH1UAb46tpNNR2OYwlXS60tDzQCncbEjY0ykufxJ3Zg7ovcE3CD+Ib6ueg4D2rgIbNhFvhYLGDFeoGpR5FQ4AQ==","signatures":[{"sig":"MEYCIQCbQX933gZHc12F3uHrQJ2kosOrOrBROxfUf/tETaECFAIhALiNPXPIcVckAlNJZgvhhHb0aDmA9PxgBa2gk/rOCi/T","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48408,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeQzKeCRA9TVsSAnZWagAAyNcQAIlS+WxBy6f4hVyuMcwn\nTMSTgJjcBjuX1TIAKbPoHwS1TMrKdfI0K5ftjoNYevNQ0UmC3sJ59dH5alSp\nkd9onix8b351C0mLZ5vNxE211sbLnun124yk1fFnEOxhCZ4b9g0OU0KcZIO+\nsUw2P98PibWlrdO4q8RcKUS6FABxIcw74IRhdQX/kTqkW4h7Eh43hTJKnFR4\nAamIalGaO+MOrgTLVEL9Ui7hM7hoMmciLmHQcfylUN8g+VFJKlEk+HAGBTBg\nSBlVMr1VpFxXZCPPaUsNQfY7rtLbKUGitvVrC2Fzp5cdB7GbA4khfg2ppk4k\niHaxeDDKvd2HS7olVUILQVdlHQLFN6BddNMm9K7LpM5EVHByYpHviOu1isI7\npkd72Yzh4ysnIRWmLT7eJqWog765DdK52HK0Ck7CFWC3sFRAob6rmUZyk4Io\nahGnzcj3jMXY+/h5FJCbDdfECl2pFJH+1bFECCBscHuWHTNzPZOFsED1nb4U\nn+jYKinWcMBSHHLVinyfalk9qEJviLVwPZmeV/PvhL5zQngYxXYa9mAhtsyV\nEGEdQKE1byn5BQDl8t0dR5Xp9zAatlDb+hEbWhGBO8Iqc1VeCqhXNWr7jY/I\n2tVeG16P/8EHc7qKlfqz4XjUnVVtN3qpD7e7Zf/BWoWwMHi74qQ6KBVnEgHI\nCKIO\r\n=WMjE\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"e2454461b557445b87633c0cd3b655c0395f711a","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.14.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.14.1","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.10.4"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.4_1581462174124_0.492663328189477","host":"s3://npm-registry-packages"}},"0.11.0-pre.942":{"name":"piral-pwa","version":"0.11.0-pre.942","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.0-pre.942","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"752a4497275969f25cdeb81d6205708ad6a4bbd8","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.0-pre.942.tgz","fileCount":25,"integrity":"sha512-lLz9j256pH8SkSwareFb4642X5gjn2B9tR7Lx5Yzmaba6RnUfSap50Ph8K7bFfP0mqqnyxH1KCUoBTBNuL0Jlw==","signatures":[{"sig":"MEUCIQCGsptvT+/OUOZJ3ytQHHYEe4B/DQZupJbg78cGZtK3AAIgOMt1W+6GVDlpqJip2CVwKA8Q0CTOAr4m2Dddbw2PFvw=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48424,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeQztfCRA9TVsSAnZWagAAuh4P/Rx0FzFrs+BsQ5NzPC0h\nBRKvcTs8AdLa8gCg5zD3NADydSaqNelCrLdtrSsPYFiK8V2vOEbzTnFg3jQC\nkuCFGH71CM88HOQAofdJ8hy4+02d2ledgf335pK16XW0l0o4Gs6Dg7taxNhU\nUZVyo3fsAvjZCbKkGos2dHdKYInPyN+UyXXY28G+x3OqqwkEurm2OlQSRgko\nmw0IEd7yCTxIIdbMw8x9jy562dkWktcn4coEceWnZd1ee45adMotGRK4iBZJ\nXvp8DMff94tG5F63LjzXjPEHK7QOMiKOnP0zMBym0Spw5Y4PPybsiAYt28El\nAWkgMRpawRLsbh/Du2o7L6rvBF455So7+HW/XKQm1+MCpzhkyN8wJmKXRocf\nsh4zhzcEErxYZZXkCYjB4lxnP82M2cIUE8u6iSjBnvn+0Xg7AW+RrU1sRs7e\nNytH6O1M6c+TYzEMadb23TTdzz/lcj42M84n1Xnft9si1PqZEX3x0I45Ca0x\n/H+4cab4EhHHlxwYQYL/pptnwnAwlD2DEhKKrAJW/+vfrKAPRYweiOd38sa6\nqB19fW99kKEpTZxtmM+t+K9xGfjSG7uPmZmKsbQO6q+IsyPjqO+aAX6e6Xn3\npyCdsK4Rfb0R41NET5U383apRzEo0Xhz3lyXdj0zz3MUzGtf1P3FI8T1kxuw\nrlfL\r\n=bq5D\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"d8b76fd7dbc640799c7498884dfbfac8d8209ba1","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.14.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.14.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.0-pre.942"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.0-pre.942_1581464415238_0.7051883158909906","host":"s3://npm-registry-packages"}},"0.10.5":{"name":"piral-pwa","version":"0.10.5","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.5","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"ecfbbe3dcf1703ee23aedea56f1be6828a6dde10","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.5.tgz","fileCount":25,"integrity":"sha512-2DjzLxl+K226i6tH7V5mA/O3FGfHXiUDmQWTEIDbW67Z5WHb4L6kKFClQBbFGT6HzCxuqf4RP7Itc9UGi4q26w==","signatures":[{"sig":"MEYCIQC2WyU50irqUEDtmAa/sScWgcxFk2/VZ2It7Ff+JJzuVAIhAMYvDplHfzFzJsvZwCqYQxLB3CdzaOP7w8TLCWjgvXQT","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48408,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeSDDWCRA9TVsSAnZWagAAmRoQAI5XZkESqX1m1IzlLC9I\njutVc55aLO+87NDCDcE1fYGsmVH3FwtbRGUgBMLlTnx5eKsQFKMoEb0yiLjG\nybaf54ndle3iY1Nf/bQJHoaFQUzmUtJiy9QcV1lCHnQKdvRdGAk+hDqdAZtq\nPO/+gUsSwhJo922avcHvaqZGuvPGAOPjZXMO6Ry8/L4oKZ8dF3KXhBvN2Rqg\nOWNJBu/0/4KazTqfKE80AuE2ipYBREh3XaaHwCmu4pGksmhiSBxBR8HklWE9\nceUlxXKRaoAE7kQJvXAqFTT5OONGhFxejjQFREdJ9FRn+pw1KyzYogVmFX9q\nUX8cUbjm1WGqWZFXDmyhKxTrflwrX0qzRQ2X2mPkKUHlf6Hju2EPLycrO5Ji\naNeKfJIJ2Vzm1FldgckWVgJp89EijU/leVrlELEdtYKEqT5xFuGn5kyDzkTi\nLbV7MGz4D06MG7UsENrhRY2XOmtD1Ui7qYceLyr2dvHz92j8ih96kq5bVvTn\nhiMTsEeql9AJyQAgKcpJIow7aKHdRF0bPW7hYARQHTmsqlrEkCt3RFQBi+/1\nILHwP+YeHou5heaNb9f8H68RBRWJyhC7wMhLZAwg3HKBK7hWkVh+nef6QnSE\npkwczGi10vEEEskwG7gK8x0ubvgRGaWmit86zdvHzxLII+7bIx1aMYjIpYIX\nTOwf\r\n=0eCF\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"77dfb1862c444a44c3d052e7709013c687f72dbf","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.14.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.14.1","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.10.5"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.5_1581789398188_0.4196765257640749","host":"s3://npm-registry-packages"}},"0.11.0-pre.945":{"name":"piral-pwa","version":"0.11.0-pre.945","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.0-pre.945","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"a32ebc014f526857abd63e04fe87f5ab1506f2e3","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.0-pre.945.tgz","fileCount":25,"integrity":"sha512-rI02ryLumvoHTYg+EaJhkpag+CUHrd5LnbglKl2TZFgE6yLvC3bbWgT+A9xoUgmua5GEfPY2UOFdBiMx4oTboQ==","signatures":[{"sig":"MEYCIQD/oG25MAFFA1vj6GhYJmg35gMX4TLwERqpcYc6j8Tq/AIhAPameWOPjQaf25oChdDjEqpgHVCQb/JuPL28qEbirD04","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48424,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeSGiTCRA9TVsSAnZWagAALtYP/3PzbXxLITXNLxBAjdzE\n8FknhqqZk9gPCYZUmHob/s2zIBQ/MnJG2VKnbulDf+mF4StlVqhrzt+G195j\nbMzLotaJ2Tu+jl7YoY6v/Qh335KBhsBgNkzcR9TdoFRSDwWCR4qoi+kZoyA9\nUnvLiQgxYUgN0DtE+RsSSBoz3citLnnRkkutFjeOaxuxM24yBaj8Ct4PXPvq\ng0/S6kufvYFS/q+xaN4EwbYwXHOM1mjqoo3/e3uZd0O1VkV8EKZ3llQu3QgC\n03jRAf+LPYZhwkEY5pVxD+rBOgv7CXk2ZO3bSSq3eXr2CxaFZiBK88q13r+c\nI0Iya4h117Ir8TmNiqlI+egSvz950SMLNL6U5E9IioZYC669TYxYdQq8R7l3\nBHZOoA6Di8dVohqMK65DwMMNpO2dsSNB6rws2/O4dLlR905WLdJ2e2vlU2ux\nxZJHAHGavmvV/xcLcd5GAvKsxsukLb49Kwf1mLhwi9Mw+w6tIcU0TlUvMOn2\nLsHGfHfGbIFe6aBWGn1iiblXsGjfdNOVpYdhhLmh+Wi9rgzaeU3TNc3HVKqo\nBp8K9sEBNzGxJacw3XtG/Rvj9Ox8hwXovsDmH5fiWF4X4fyQN8XyKTRAcIbZ\n3AMmIPES5zKFvCJfSlYLaHjmPnpBhs2Ggxv0DBr1IHKZb/Jw4b535nXezIf4\nMM12\r\n=gwd6\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"ca915d3b6a6136e8060b764162193ed9a94810a2","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.14.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.14.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.0-pre.945"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.0-pre.945_1581803666928_0.5492790225628006","host":"s3://npm-registry-packages"}},"0.11.0-pre.946":{"name":"piral-pwa","version":"0.11.0-pre.946","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.0-pre.946","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"3959db84c3089bd6ea0bf3d7cb0f715be63a9928","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.0-pre.946.tgz","fileCount":25,"integrity":"sha512-LEFi6VJ/GZMeuT2QFikrwph0Pr45Zibtswr4AT047A9DSMm/+PvR/EihTZAuE0hs5kf922qG7K+mQ0BjvhphhA==","signatures":[{"sig":"MEUCIArjVC1GH/lCKD5Re3DbIRPJWKUDczm0/jRvdx7VGUiVAiEAib0H+7+YJ+O4jpluc7WOznDVGJyGhktryQMWOGjnQLY=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48424,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeTFzxCRA9TVsSAnZWagAAjFoP/iVvFgBp9FQ4OlGgBVxS\nu2fArdCksZuuKhoAPy7RWnvqY7R+g5w5DwG0G0822ZfCE8+rqOa6MDno7NJG\nQNnba+N4E3XB2lIyrYHBvXjfZnhNCCSxle78tN3jePRKUaJakez5fLMF3IeZ\nqh5gXYFNZDft6k8IB+k3dhk/4GN7KMDPBzQEYc2Q3Vbu8KC9aRNHO3xh+9n6\nDqx/vV9s/3EIF2yj/r4JKCUM5h0xQfK/HP1V3Pb285PVzewpJmqYI9dWqXOv\ncOW5kQUdFXErsa1NTdGeTuqBqeOtDhIcoa1vWVZSS0NS5rIdnlEiu58/R/nt\nq8uPmgL81s5XCYw4Zq9mMh/DSgtwm0Jb93NJpZZvOWIPX0RGuOCC2a7zDpEU\nZJipUp8zlH/fI2mhDREBTP9pFt1HQksEYrMdKcK0crlYqFDSLLuAcFvoLVz8\ng43NwBD2hHzWRSslGRfyENE29mmxORLFUto/l1llZKUCrlRhI0uOQd4kJwY+\nrCmS+zZ+9fGU4pE2RrbMyJODlKXHlnEjwhfS/b2IMAO+ldrLQmU9wCxRDHf4\neHCGYBRaERANJYxN0/8W4GiNpuzMmvIkf9YqUSvvaHnbQJNaXBrdEMKjgBpw\naSUvw3Mj1PStDNmvfxik61s8rf5j+0Z7Ot4VwIr2gUoBGJXj2WMhKR2q+zIY\nuRvL\r\n=c9Tl\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"57ef718ad4bd78b8be6370d61b9096bdbeed054a","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.0-pre.946"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.0-pre.946_1582062833280_0.7560054730738379","host":"s3://npm-registry-packages"}},"0.10.6":{"name":"piral-pwa","version":"0.10.6","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.6","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"825684babc0b22c2ab52e3c225c6860046af5be1","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.6.tgz","fileCount":25,"integrity":"sha512-AYDKWVPjGskYqzNUvx0RMYnf0hNupnbNPSqa0wzE19YXfCgar4mWF99PIDRi8uVCKDpLYiS0QoFtKUGWMbf06g==","signatures":[{"sig":"MEYCIQD2tupN1MU3EGeEgffD1YLunCKQZve/g+Z03HftAIi39wIhAPewyzRXx6ysCH/dXNWtgoLuxjjGBjyuzytrFVTrRxOY","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48408,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeTv/5CRA9TVsSAnZWagAABtcP/3qW9Rf1e5VvtJwvrGvP\nXZVLSHWz6lBcE4/F0Z+j8lpmKSC9XQRwUn3soDSCjrMS69JMfyYzwE2yJXbE\nX17EaQbbWpY8P1Kv9yq5HvdqJS3Djfi4IzdlBpTgKVhsRNZ93PiHa4+Orb4N\nBqgBxw8lOhudqP2JVwAKVsV1Gqv5jlVt2ToxOp8Fh/LWyMx+HqjM2bVdm22j\nRNC8KBQ9OQcEJ9E/AAT7OBB+x5WnclghUKBQk97StfR+dgDY4Innw65FoboV\nOJSxMXDT7B9EG7El8u9M4uqaFzuSMyWZaoOBiqSIY8MT3SWcgxip5TvsOC7S\nPEEkPi/aOXKXCSHQAcKmSkzp7mela/oG0YQTYgv9+gQyvoeYqANUghEHOxgM\nO1tSJQ8Xh7m0ciFCcjRcLTbzW6ntmMGDP+IMy/yUTDjKnJI5VfDiFJgortdO\nfCLFqO/84583/5mqG9zhcNPCQigEHaaWpGvopVZkdbTuOBn/1ywmZY/GnBxf\nXPAZqHx83wKHm5WXIgVDTm6aYqnDSafg8lF2ZrDTuDNtdVGQhpnutn5+ozEu\nhS32iVP8RY18ejdSd8vLuTMx1lCZaNBM0YuWRCFlFKD8cBjCgx0Lj9iHE7Wf\n0sFmSPW6Uq6cLBXvESaCOc7+Iy4OxEAsJihbShFAbuRNoA2PNzW+w4eZ31zX\nqSsM\r\n=LiqL\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"183d8436966f4c8bb96897e465c8d2372e1be7da","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.0","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.10.6"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.6_1582235640756_0.19387719510361023","host":"s3://npm-registry-packages"}},"0.11.0-pre.956":{"name":"piral-pwa","version":"0.11.0-pre.956","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.0-pre.956","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"db4313a8de3d0a72afb684603e3de94d1f448e0b","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.0-pre.956.tgz","fileCount":25,"integrity":"sha512-U6rOYtw9JO3SUJXXWI1nXTEpL53eQOKG8fyvhp1cOoopo+f+VOu54G9RYVzUyg8RHYxHleh3V/qti0JjJ+mSHw==","signatures":[{"sig":"MEYCIQDorb14cA7z4hLhLozJujAmGWKQZRk75FFKzNxWDyshaQIhALITLIxLpie0gcgkXzuQenll/aYq4AIgHOGIjCBlp+Ja","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48424,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeTwfjCRA9TVsSAnZWagAA/o8QAJFypiVmrk20aTVd2DNM\nIJpoXJZmpDy0Z4qdsJvwR3BTYBV97ywrRNjxIlIns4lDvDJMnSDZKH0Ngvqb\nV+XIJMdm4pztvuk3jYhObeLrk5/gL0rrWIl9Ztx+Pea+ATXXtJeGzS3IWQR9\n2wgDLGZW8R58EMnbmOWgMwJUTZMUh1Qs2VLhTZ5pfuAQ4NamVfR2l/gIy4mE\nG3z9ntAXfYnXrR3bXPEzCqniOwHNpym58g4+4vhots9PtcIlny/PBRMSh+oH\nqI0LqUngjptHi8JpDqTgYdYarPsSrM2HFYFWJl49OsmucwGzk+fu93JLpFS9\nSMGEl9ui1r5xKc0J1NsJHOBwCwRehBbGis3/KGrZXixqggl28dggyQZyOfE6\n0OY4AYloludTQV5QGEa+F335iLB9m0vT/YxdWeiolrYRbA777ezCAIjzlZq9\nYLJKtKLKWnGb66cUN3JWb05Spc1XorwgJf1grfktyLCxgdK8UAEDdrD/HPPe\nM/BYVUexg52pJR/Ofo2acIQ8vDSy8P54yRZ2a+l/f2Af/3Hshlv3abv4VjJz\nxcVn/q/cErI00CECpZiKnvEynDqxUNPuL7cFXWbSkfILZ7LvarSkNqER9Not\nvmaZVyv6CzZpS4u32CCwB3FUnBWa/tiuK2mozk03sUDoseTGMfk1/PnDAP49\nFvWD\r\n=BaE+\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"374a47fbfc650b2c9a739623445c4c942aa5f0db","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.0-pre.956"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.0-pre.956_1582237666451_0.9365289690107812","host":"s3://npm-registry-packages"}},"0.10.7":{"name":"piral-pwa","version":"0.10.7","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.7","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"99b4b10fcc971a2c95b213356c8a427508be5102","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.7.tgz","fileCount":25,"integrity":"sha512-PCgYf58tAWb7+jj6jIv2InqkM+XQa3Pt91Hg/uu0+6WwLsQLrlLreQdJ/yraG2A7dW0otr8tFHrOwGP8g3/wWQ==","signatures":[{"sig":"MEQCH1tkHslJJC3SDOlrk5DhHz1B4qva2RRc6hhx7AWXsMECIQD6nYe8pLrXeTBNejxBfDAFPhAF/P8iPZEQ80wq9BEmIw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48408,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeT5tfCRA9TVsSAnZWagAAcfsQAJyLF1/8bWCIQbTGoyyX\nzCNyVJDaXwWGpoQXdnr2n7aTiu66E6ts8/j0zWf80jVYBsQmZoFTm6b/XOtw\nd9ROHUbjQJLP5hnPNsVVugew7jBoUmJdtbJkRlhTIGv1Kz5pQduqx/r5PYMr\niEKh3servJKdg8shwPaNy2RyowjWeLpUsvOnJUc4kRxzF4VKJj107kANYFKl\nn6xpyjN3cf1B/u19i0UNY5f55VS6OpiqF/yJXkm3b7F9u2fimJ0OSr2fjda8\nL0W7yPTrFoNVzypOcRagA2XalfKSGLbE7M9ZpnBmJSh3nABbT6mIQp9y6bwD\nZ7HoCODdZLI5QEGNvJn5pE5bgcU90Gi+T+eZR6fH66lv6gf82cR3pU8oi6Fy\nPmIGgbN5kAsK9m8eG9ETBZMcpLrzFMo55dO9YBYknJLBAejesMAn4HdXQX//\nA7WC6ninvZLIqDgwIYmhWWe0j7T4vQjEc7/G28o/Em2jSKkLbJrDs4kewufq\nqKcfqJdox+ygZcr+MJjCGcnVJmRT/8gLaBuEkEAbvW0kPpgS0DWrtf6z4U/U\nzHI0sU7/tS8frteCx7J2jOvntCabPcVkcQyC0SgOX6DHXnl4m8I7KWyRyWlo\n5flHd7QEjU1p+qoQgI/LqV+832/wdJyHFhwy4hfi1q19yb7rM/XFsU2lLimJ\ny2/V\r\n=ukSS\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"5032f42229ec16cdee45d4eba49b4714fdc970b4","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.0","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.10.7"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.7_1582275422899_0.18790120709461577","host":"s3://npm-registry-packages"}},"0.11.0-pre.960":{"name":"piral-pwa","version":"0.11.0-pre.960","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.0-pre.960","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"84c2530a6775622e2520ed5ffae78c8ed5a93859","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.0-pre.960.tgz","fileCount":25,"integrity":"sha512-OF9HU1UsBy6KANFg1rWfh8GmAmhQGR5wpiuV/1Z4Wf4ljHNHeRxsRU8JYu/fBa+AtOuCuw1irIP6O27L2Ptt/A==","signatures":[{"sig":"MEYCIQDpdF8uIbO7wfzel8r3oPalQwlAiUi1g+X1b2XEM89RhAIhAI5yiyRliz2bQ2TgOhtDqlOwIE8ZIkU+CrDRf18h+h+3","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48424,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeT9LqCRA9TVsSAnZWagAArfwP/2dO/Ypqm8c6k/7Doltm\nwaSqCbiHKkr8sBwjVbLGrimLIz3aXRSzEBQnXLxDjpLkWVhds6sUE62cOFrn\nJIMjEWH3WP2M+cr2mXSEpI9IrSegKmlVKSJkwJesH3dlP+CKxT9GIc2JmRq3\niS46aOsssUZZ1BYVLzLH/DA8PRxJRhj4UXQ/oHcVZy7bxHM80T9rW94Tg0Bb\nUfZi1LsYQOivOqyKhu3El5c/J/Yw3BlSEnxMqmTLQQ1NbDFcshqGhI0rxXcA\nAx/D5TJp/cc0K3mGVhg7WjgOqHKbRClPol5Qo6yWYJ11AGD5L1xd0qjxwbNj\nh5JjbsZ2A1Loss1xXSt/6oHVgqXfGH0GogYJIAksBcbMCpN/4IlMJhK0NTzJ\nFC5v2JpbmRPAFFz9Z61VyhEDzpbBYvBGtpu1bcLtcQf9MLYtwqc/byfE6UTd\nKCzvydwUNWm43fT6FSQvkHxeRvnH5DT5mZhOIVoZElbBBbH4Y7OslYfEhA+q\n9w8sETG/tf8WqrqWhpgoA4viQvmiiET6pDIzHnP+KhA2/DIMdcrcVcIedxty\niYZzsv/sjSZkbkF5NQHTpbdRCxX7LZa0YsETIjkpYLj7XoVTQunR/MXKv2Ex\nZkLvI8YXqytHaH5I0QlqsM9WGhsoVV5PFxpT6zJAzG3PzhkEmeqz3+5NRCV4\nNAjM\r\n=dMaq\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"ae95c261b5c880bf19529c1361a3cec529f8008d","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.0-pre.960"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.0-pre.960_1582289642355_0.29762030243322823","host":"s3://npm-registry-packages"}},"0.11.0-pre.963":{"name":"piral-pwa","version":"0.11.0-pre.963","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.0-pre.963","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"07e1568d14e59ff631edb83312d3d1222ea13520","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.0-pre.963.tgz","fileCount":25,"integrity":"sha512-g0s6khuixeeGx2ehkFUENSMzsLRbAM75WHZJCqrrS17Iofq99JYdnUy8Gi/kD2GCEPNCAX66zXnjlLCPj/ExKQ==","signatures":[{"sig":"MEUCIHGIRhsO/86CiNO34q+LpPuGX+oYMFGjHwz4dTk8OjzlAiEAgSllimOTbl1uTxAGFpGIhW/awlZ7S0pdwOEiZuOk5aA=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48955,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeUkdsCRA9TVsSAnZWagAAicUQAKErH14vTodV7XQIrzMj\nEl5smzErDFqJ+kYwq2ecifN+xNWVWBTDq/hM8CNmxDZL8iJgMi2MNIIEs/zz\nv9L85aC8yGu0NS+4EqMHw7HlJMmYhgpvuS/QUHBgeZGDGDC/1boiq2/8sqRX\nAEEB6gOLfbNQ4m+mYSQsfzKvVWCFXrPsecUTuUBny3H86C7LpQ5iIIHhaBwq\npqbWhtBd3YNqXj9ukjKLMCNemOHU5SGbkPoe1mOt3xf/0su9Vv+QpmnbXRHM\nQupb3R39aTrCS8Eb1+55lP2tT6jHEPe54/HCtiLpTzT/vZirjXh7OAnvy5Ei\nMT8c88IWwi40/qBsDNgwKLsCXDJzpxePyxgMcOGiwUwnR7V04P088IAQ1+tX\nL6OcGhATi7C2WMqM+5A3hWpS6/853jqq7nvnmZa66msC6YkvZ5VvaO8x9Uhm\ndN0jYbQ/PxFNNcIqujjfdliguEKe4RbOVebjXRTpGdgRsEoVKOuZlLBA82It\n4/0i2d+05h8eYSx4FZJmk+Xv0RyLiWFU+7ZkWwsEGkE37y9Qz8l2YN6Mf72y\nctWbHVOeWduQ42LFSUCGka6YGXJjrpiov+jN8KjfBOJoXcv1Rtb54vt21O2C\ncNZ0Hp6ufHu9Qq1QwRdIq7Jy0Mg08+430YjxZv2Nch3VuCCbprIv/S6D/DWX\nhcAX\r\n=Gdwj\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"e234ba6d0a33bfea0d1d003ea3c4efc5debc5f34","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.0-pre.963"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.0-pre.963_1582450540530_0.6895793159442629","host":"s3://npm-registry-packages"}},"0.10.8":{"name":"piral-pwa","version":"0.10.8","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.8","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"fe4f5ae7ae8f6ac006f01e86fb364b55eeaf3ae5","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.8.tgz","fileCount":25,"integrity":"sha512-LJ+o5OUO7pmoe7pTPG6CFdTdohFh69TQh+S/bwHSs0HSVX8zIa9ABhGpzkfRBj0RLcIibCJ415Z8BueEfRnI4g==","signatures":[{"sig":"MEUCIC+rVKSMJCcOs0KexvJtpyxVCO9AP+UgfD6qES/jB1jOAiEAnTeenVDYdAL2AKddJ7F1Up6mD4wNWH/YQntI1SQJSOI=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48408,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeVUNUCRA9TVsSAnZWagAAIGkQAJSbgF1kx8ndOCvFVSMI\n48r1FZNACuDdrt+dlwpIoHsovb8U0vZn/iX1Crih1ZOR9ejicR5hly3emiV/\njwL1aNQCg3AKC8OBu/1b4Evy+mhm1HeuMXlDXMOa/2r6BaAM5mys3azd+Rs1\n2qxSQuQzL1iY7aTSlMrigXHKNMVBVR104l/L7al9XX7gLDpEkbF077l1jlJr\nLOga+/LWTxURjUmm7agD8lVtd3pVmba5Ja/EIn3nex4PZnBPw8++mDnFKIg/\ned+QG6yY66amS4NAL/1JfIEqZ4kOroltwa42z75s1/sFKQR9PWdSDOHzfs6O\nNV1PemVt54bmafNFIqywaeOiBCxw8s+dk0xnFewP+qctV1kCjhHszUm/6wR1\nCyIZIKrqT9DrJXWUQZZGfze3ahOjWYfqLo0RCcmq/MIF7PmKTBAdVSmYj/9O\n+Db32DHt/ivazRjijCrVwHB0aVU8FuS0Oz9+0tfPyPMROnV2mEoUG/lkp9uL\nNqwvW06632DhFwDehhpktpkfd48QCNvSb42EsUaCdFCDqyMm0k5bpwOhYLsG\nGA8e5fva3Oa/51ph7s1VayMp568gvtvYZlE0s7OuNIa0ISf9q/zfmPjB7Qb5\n/530gBGy/ez0riGiCioS8Dscpa3vQ7I6dlZBwfRMedZwKHSvB/JGRuQjRJsv\nKFR5\r\n=EPeS\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"eb6ac0ed3ecffa9e3574107cb8434961301dd69f","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.0","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.10.8"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.8_1582646100069_0.10027009440788337","host":"s3://npm-registry-packages"}},"0.11.0-pre.970":{"name":"piral-pwa","version":"0.11.0-pre.970","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.0-pre.970","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"b06f6ce97b8bb334208a9585f849e847a1d39a49","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.0-pre.970.tgz","fileCount":25,"integrity":"sha512-WMybqACDX/nn2stofA//GEeXFvpQS2iEbxenfkfZ8Hs0Yr36I4mlU5UhzU6NMtLSn8tkHR/RJswULgP837Ppnw==","signatures":[{"sig":"MEYCIQDKONjlW/9PCRMFDY/yHCf+lfpMio4/hyccACcXkI0VXwIhAMei8spWLY/h0wsTCocFAfZ00D4AzYfZ99dB3Om2PRME","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48955,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeVUt0CRA9TVsSAnZWagAAkewP/0QZ/mbRJyMSOeHiQ9rc\nKNKDkJgFV7Rs2CqYtPBLQGGalw+EJdcSgIRPxtynACX2DEn42/g8ocCwyfrO\nkycJvukOXJkiNmGWPiiqmheq8yzi3Xwske9HwlwcrlINDkR4rYfcifuv2W4D\nR0mw0/m2tWixc7deufgVHKrLSDWRyiekR6XsTmw/64ZPnqsTlDKUpwxpHG2x\nmYTT/cPSUc0uQMEPet5xwg5K6CzI/nHxbE8/agdYBOt+qto+58Lug1v8jsIu\n2lqY2OltJ8FUgg6hSU5JyLgSeMnlkyjfoHo/DyujZJizGOD3xVQJhKXBraU1\ngvqGIsj+dHqCWAtBN1hYL3JvTUGP60oHLD/qXr3L4jU2Bj8gDISPym5sEqey\nALHGdvs5T/lIwXreGRwpOUgC92SQlRcU7TgUcIWgTs+WKGOQXr4fjB32U0Xp\nLv0flx4hdWdw7OQRH+ZrlTp/4BfeK6li1u9fvExKVDlZNYz3gbqe7ZU+Mmsr\nwZ2sw3udnTzs3XctjQLzQxB0EdlnyES2aE93aX28NypzV/q7zMwZVOBTY1Gl\nl1f+5jahiz6gJFCXuVyLMCs42VfZtUpTgBOMqh6S+GJDqtcf/8ywSMl5To5Y\nphVXD3aVmQXrC4J0Ha6j3d23qRQsDlsj12JgYEAsry2c9PMdeoO9RzJvPkrm\nydYA\r\n=6P0N\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"b64bb8c772c15d6b81f35e9775111f519107935e","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.0-pre.970"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.0-pre.970_1582648179560_0.8265929666121659","host":"s3://npm-registry-packages"}},"0.10.9":{"name":"piral-pwa","version":"0.10.9","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.10.9","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"8b1562836d8ebe200f81a15197b0305f6760fdcc","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.10.9.tgz","fileCount":25,"integrity":"sha512-W7J1MDc1OH1m8xgKh+R/0V07YBYzbVzzXp04mzEE/25c/LCWpMQipJTAuBTfVRvE48HaQ1VMfdB37dAnzuI3Og==","signatures":[{"sig":"MEUCIDAklzEH0xIoEbvnByo/AHXfKYpFqZ+y4gL0MRf1EPu8AiEA1/thgEjZCmDD7CpmTQglt6esooVGpAao3E6PMUgh8AA=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48408,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeWPrgCRA9TVsSAnZWagAA2EgQAIq6ssNpNqZuguqHo7FN\nvqDJBI6RMHgjsNbvdXDirnDfMRmteQPw/CPY6cNwQGWXm5tKIORoagX6I5Ot\nirGKWY8gYS2I8WQawbf9Eky17n34jjuPAb6AB8bL2r27ApGESugF2v9fQRcT\n8dXIUZOh4KmI8B6Ywqn9g7iR5aMssxGdW4zpV0JQyHCWPoYce6o8ZUAOECR9\nCOSceWZvgBfUXG98NdEbm1YVsu2OqqrHPJ6VgzsL2a+szoD9MY4BYBXHHDQJ\nir7RTxnhJhhHEtwFMi5UrfJJFS1VguVDcOHm8LnglPnq7iYGhGl7L6587NkQ\noN0dqditKg4AP6LWtLF2/hOsVsIiEB8J29VtHmhM7SYImtqhOA3qdxj4fnpe\nbtJwsHSaJ83MKxVBsMrN0J/lUbQA8caGL6KF2nNFgfR/OI0WnJVeVN9vSknR\ni12RRn76nLylFQaIKdo0N3sUvhbeOzlfzCPxWx8D6e4sCZ8AAVnzQSFediKv\nMmX2kZo8DscOW6YyJc9BKyQymSv9hElwKoyZlBGAWZzV2ilqrw+AB+s/6LFL\n+GHnYgFoLq1OnFQnZvBFm4zbhPp4oQyqgnpcPJi476JVULKkoASrhGuyC+Xk\n3DpGovU88o6Uitak28K0l7WsWdyOsxVq2NhRCZI/l/EJrde3xqfa+Hxpmfdv\nfl+n\r\n=X92q\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"0d7356ee8e244ddfcbdc12109856e2fef963cd41","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.0","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.10.9"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.10.9_1582889696446_0.9068659977458942","host":"s3://npm-registry-packages"}},"0.11.0-pre.973":{"name":"piral-pwa","version":"0.11.0-pre.973","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.0-pre.973","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"a27ceaa2185cf824acb6f40bc2095015a8d3f994","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.0-pre.973.tgz","fileCount":25,"integrity":"sha512-IYuPu21ehlvBo2eWd84ueOd0am2IUXsQoJa1wYlsfe1PwnGcPFubghQgWSjY2KnwgdnAdV4ZC0XzKwmh2ZlPUQ==","signatures":[{"sig":"MEUCIQCTXEe2nahIx6NgEE79s6B8JE3H/Vu36kGh+6u0Ezc+RgIgDM8nxYPzt3wqX7DB7mf/K6+SJrf5D/zV0QLhN+asL8E=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48955,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeWTnWCRA9TVsSAnZWagAACCoP/RfMbsJUJKGu7Tymnaxp\nr90acyhmt3cnFZY0mrGobIytXj4l3y79qxwQJ2XtWQRSO6UTAjQ1sM0rzaJT\n++uVMy76L57HtMOVwLVcma1A4tjlYOSD2aDsnbzu/landsiy6tpP5WzyAZuU\npdlSLsV/grOYdL/qZkhYCv0+HzH34Ao5s+H9s0XYybl3rjCNSXgxwPHYYVlL\n/7mE1n9A+ZYyXV7EPpPxfi7g7O4s1h9WjWFUSdHk0bL/v1kczFGRqcdg5o09\niBCxM2lnxL8cawpqzK//8rGRMCJ5gdLWAQijw2pokPgUIv64KxwYEibX8MSE\n/y0zRuJ0i+Urk4tAh+rWtnLc2u/uZemq2QhvqeTwp1CncqgfVOTYKcRA6vZa\nk9Tp8osmuAlgeyOXTXGrCOUMW1KImLlNWHq/FaiDMvNNiVViP4ZWI4hx9oC5\nCnHTziI/nu6BrxjAOn0S2dlju4v96tgH0l2AwdyX9vWH2dSJLjQTXbYW7SR2\nhm+tZ168H30zP5vVyJ7Y/jv5pJlJbjPFvIcq2lLso8KVPrU+2jPhzyguKg7F\nMj5NjR9/k2MdzBQdg9nHhfiQKr83aoAJ8nuuwTMidzJ4ABlXNhd4JPGi/8rm\nyYw/VmXcU4WaxZhqQu08rgwyHkwM0jxexORbvb25LOtet5SSrS5IvOn5Z5z8\nzs/3\r\n=cFoC\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"f7b8a4f8ba7b8e1fef5bd6361dc7744e18fbb30d","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.0-pre.973"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.0-pre.973_1582905813662_0.2796191859697954","host":"s3://npm-registry-packages"}},"0.11.0-pre.974":{"name":"piral-pwa","version":"0.11.0-pre.974","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.0-pre.974","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"ac67c85abdea0523c93b16bd9a595fd561d4ef7b","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.0-pre.974.tgz","fileCount":25,"integrity":"sha512-WWCLe+TkvT7rRrWk8cehN15AMZYafQwtIGfUWFKV+IuH8FsZDwIXOkVv9cnIMYYgJJwPUXugqgiEQ8kDUQKZeg==","signatures":[{"sig":"MEYCIQDKzQwliuX5lt3nJ1R32QakJkvDcSEwDs1PyaqN3nEUVQIhALOWx1jUhdN9hKzzGD8G3K3RK4Hv4moVfyJ9FMqmmEfn","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48955,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeXgOtCRA9TVsSAnZWagAAxPEP/31LXNy6Cd+6REu+YrQG\n1e/Wxam1VoFmQE49hp0DruOg8Fh3PLJJj4IngkjmEcR/gh79YrxbtUx56FEm\ny5J66SYbMmgJxB2yvI+j9civb98pUKlMG16Hler15m/nX7giT03i6GqE4KoX\ndkbMIBkWCqOloMVdprW2YXKrtY0NvLv2Qhowj4LZmHYDIca1liWxCSe9izlK\nw+aUXfh9rtKMPB+0UBBPijihAZQiaBLUG+dxJ4K1jmnHRtfO4gqKFn8kfWYB\nzwVGxz4q7MsghRufXAP2th0Y627rZ2ic+bamA/Z1GY5wFEmcqn4gPIcWPmAH\n7GgHen8aV1Ik8tsgwClgF+fnW+vLovfQD3HEo0693XChWaM2VRI7T9hZ8Py0\nn8LBotPQixI5a60u7qKWVNYx+5DhW7fBcm30XQv1u+Re7w6Uuru+fmybg3Gp\nzLgtpb2qFgNeKj9lMs2VMs2WY0bQfihiQ/Itd8G+12jyqUfPcBA+/ZiBWzmR\nylOZpPTK5WHFeDmOqOLrSBcbbcJdWTWtem1fI5fr0sDcwg1oGg8UTj2fj2pf\n5SYn17qSPucCZ/fsHkz1fqFiSryfcTHcqd2iNsBBRDEEA4jO1RonTWC8Y62n\nWUHGsKjeMg0j8C36NzklAFBchQLbCs7ExN98jFiu28PuJYD3KTiDqDDt9r00\nB0Kv\r\n=1xZs\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"a5a59058e1fb5962970e40d1ab923bf69821de33","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.0-pre.974"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.0-pre.974_1583219629507_0.7510983883691718","host":"s3://npm-registry-packages"}},"0.11.0-pre.975":{"name":"piral-pwa","version":"0.11.0-pre.975","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.0-pre.975","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"d41d7d037e12310d0dcc069f25d174f3e1470e0f","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.0-pre.975.tgz","fileCount":25,"integrity":"sha512-9cvAW+q4Srr2dZ5xD5cWWtyQFBsa86amwjejGwITjG2qGRL+1JDZz4ssR97kOWZwfDD7qys6jrZzor6N8qFeww==","signatures":[{"sig":"MEQCIC5DK6ubSyglR07qklckTGX6JdkjzDLMwa7wWtkeiAHoAiA0MekzKeOk2a+bb6eSdAPziovLmuGEIeZT38LllnZDTQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48955,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeXvAPCRA9TVsSAnZWagAAj4oP/2O5xCc482V2+wq2TOB0\nsJdtVTrs+0KfwfpR/vy5mXKAmNJDogvD1TvssyMhn5vp0VZ0rziyHLJW75Hx\n+3jqfPQ1hAkodahE13V1TEdVCuE7kFjp8k2VKlh7ZNDgnd2uZzTm/rerHukX\nKx7DCfVw42BOHeH/16nBnDH6G+NFAqUOLG0qK9Y3hNY9Qy1ijneKIC4EFtR2\nVQwkcwOY8eb82xRXDR266fEOAuv9yMSGEKdhsDlVTjV4Zph/fiE39stFykzp\nfhtNAZwn9X903wOuxUOjqU9YbWLYFMB1/H1TG4oscjsoSXli0nJvh204DZ2c\nTTDZd2Ye7mJsAMddUs4BQwMBbQPMSU87sSUORN2cGqdQrJ7+ZOKWoohyqKKW\n99xkO4Ko0WzZFE1LYxKgVN4teoodaSals9aLRiYks+MGcSXvxzr3pBglcTg6\nfeVVWq9xbkj2Gf/Sd1ytSFhLqB6Deae5x/Jad0CMNpZMetWZAXx5hXjOtOSk\n/tVTg88BhEV0+gkQZStgfEAlWzo+SfST4zmNSGuVvcudbTwBWuRCldBE5b5q\nR3KDN+ZaYLyYBjMoxxsyTpMkTDkee7uXHBlbU/Ytb5oA05RyzBr1AKBfB0Xg\nEu3m4USjdelDx9Y5MeUGeW+H0WoWgPnnvXMvKleQDpNht4pG9xOcAqQ2lHR/\nqN8U\r\n=QAxr\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"117ad62fa9b3c0ef32a4e828cb686e91963b533b","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.0-pre.975"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.0-pre.975_1583280143293_0.3213512766113371","host":"s3://npm-registry-packages"}},"0.11.0-pre.979":{"name":"piral-pwa","version":"0.11.0-pre.979","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.0-pre.979","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"9889f69339d6a7631c8b7b5909a62a345c28f96a","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.0-pre.979.tgz","fileCount":25,"integrity":"sha512-8M/h1KKAJqH3yXVZEk+7hZlRCpuXUx+yN4ff8phn1YYmXsLaZzI0U/0wMGd3bQxBWX3WhpxB3xqbkUzghl4qmQ==","signatures":[{"sig":"MEUCIA7VwQ0YyJmzH4JgJjTalPfRI34WkdrTXvqSnhB0NbC5AiEAsKfJmZZwnT2OKPxR5hWPmJLj36U4woah1MtVf9YVgEw=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48966,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeYYN+CRA9TVsSAnZWagAALmYP/jQsRm804Y9nQaoTNnCe\nncrl1KoPWbn3Wd4zTZMirrrlUSQQ4hqRINbBZiGfdu75/a7n43wun3MdVxOf\nHScbw9pF8jyYgEzCmIvjM5U3sZClobELvWxu8reCBbThtzi70juDWDE7+lbb\nKfA4JsQWcptGh00nV3JA44J0Jcxbq2tn1zCrGIMTDdRLkIWR++CM/Oo94EdN\nTnO1a+C8ZUFg1cW5ykuPikjf7QUQnCfXO8bvj5sQRGfb405uE0d2I07wBNB0\n42HVivhaL59NYAnmxEYFB3LEm4+P/4TAZNQTeDcKBxPPoc1U8ImpLxOmBLV0\nLmRBQ6+3pzjXJ39yH19j2CgECgqk3XhV+hnrunGEzTNJpiitXJ/M4VAZjJb/\nixAvud0UkEvWQkHrHGAIqt9MNQNF7nDwhxK6yBW06YIZhVa9yQZLDoBswnBD\n29fQAYJdXcpvgavzaFfDAUaOkd4prMWLo9/y2/hFLLFxb3iyQEKBSpp6r1Lw\nEgc+R27cdtMStbN30aLC9uQ2ouyctUKhNaJi9RXY/Ow8CECzM07NWU/yMZLh\nAfbg/pqqd6/heCGaXj5eHfsFaSUtJmVPTvjVawLQHayeRJ6An0sp1ULeoR54\ndZhKiKDSvmxWrWw6wGSPvasJhF8HH7GIPBWN7pCsfiPCA283G0Op55WhcOgG\nGYwn\r\n=q90G\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"af040b498962a92072851cb10a7d3454d7a09c9c","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.0-pre.979"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.0-pre.979_1583448958391_0.5319386583217136","host":"s3://npm-registry-packages"}},"0.11.0-pre.985":{"name":"piral-pwa","version":"0.11.0-pre.985","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.0-pre.985","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"a2f0b00eec340c2013a4fc9f2eda7bb09cab4bc4","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.0-pre.985.tgz","fileCount":25,"integrity":"sha512-t5C3tI5YV/oOe6Xp68YP6eyTeSrm0TwENPGQ/k18Gy3bzjBlzoaJtBAKYCgO3exmaqU2X3E61WBV/P1Y3VWZ0A==","signatures":[{"sig":"MEUCIQD1/+R2PLTPoyfIXJQTTGULMB83zPudVkKMZTfxaNL/9gIgaCMvk9orpGriioBrYc6f3Jydoxnc3AcyreLgYX1v5sc=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48966,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeZkMCCRA9TVsSAnZWagAAfDwP/jzrS4k56rxYaMj/4F+y\nsM99cGEoe8kKt8FS7jqvZ917CpX++BC0Ejx/+CuQp2MAnXPOcOLzTDrO2Py9\nZJhUUFxSE/pyBB2GzgPwTt1hE91bxEAmjYSVJsf3WYTPBy7ExAVJWDqP32zk\nPQOQibN9TRZ8Y3hIjH9LXymr0RoDAAEOcf0SG4e/1e6SbicV/KPWK8sjG7Wt\n4UM/YhclKiBebqpq/Jo/sHVo3n7E7jkEyzxcDcJIZr1XsxPaCvYwcx+7GVhx\nDV/2X48ywFJIpzo/9JtJeU/+tdmDwSY/kaTtwt6rMR8Qoj87CoWqUmCQ/ob6\nOe6xUxESWTEDKXv6augDy/sHhxLwqvi4ZjKR0nXp7sodlnylK/vexo9zRD4r\nBEj9opwch/KTivd7UfBd4KVDQVSm4jlr/CEmKtN+BMObz/c9aqvQXzZ9I2l3\nusEEHn52O0RPPHdg9U4GY+ZyOoKlMHG3YpvXdGQwbdvLT94UIGAHrbSdvSvk\n6URPYKTh9O5j7IcTy5PVdVoeBBSZiRjiDUzkCsSu7aLR61sGfcI4hLS0gHdx\nNKduomQfqhW1RDwJYe4E3+HmW94M6e1lvge3y1ULKYDvX/USkpOlmM8ZCVSR\n/R7JfIWQm4Y/vBF/z5ygehZRKnELIDa0q1gj6Sf8Y61ruDM66HYZOhlvuCIj\nwfcU\r\n=u1bE\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"bbe8f6adc85b9ea172b23e2970c6574e6b0a0462","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.0-pre.985"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.0-pre.985_1583760130271_0.06867279718352703","host":"s3://npm-registry-packages"}},"0.11.0-pre.987":{"name":"piral-pwa","version":"0.11.0-pre.987","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.0-pre.987","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"b48c94e198dd5a4e55a681f2a524762a1cafb799","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.0-pre.987.tgz","fileCount":25,"integrity":"sha512-mIeAAGGMuTRAGUFK1IXfhGMWTRCnRoj0cMtjD5rn6RcFzMitu8yx7LR+ilPnrX4fUrak6OyPd3+meTtF18tgyA==","signatures":[{"sig":"MEQCIDkiYM6507lTcZo9AEC12ZrXJdarUQEMynYAISA3cP3NAiBChK0GK1nYRYho6mrjz3QLAbaOEepDfrloNIbJt48LrA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48966,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJebIIACRA9TVsSAnZWagAAlZMQAJbzgJVUhJVvD+LVR5Hn\nhxSyAC3Ar+anSWCqPfYSYJnrPVbdI92PnLwAnnNpxpTQM/eVpoXFO6p/Q5s4\nhJ8aTzmnNAOXCQNKDHgcJtg3Os3eTdF1xc9oXWISVB04P6vQoF5OdnP4+OC7\nr0GaYjNBxHAskBQKi0kGPNB2T951bBBOptSzob0ECUs6XCKPDb9I8c1TyHeN\n1Xq1THGMa7M9CV1AnUIi8HEbp5NCJT/axecO+q87DybFqDK0+0M5/dPzMTY/\nx8NY1/1FERfTVZ7JSXVidOU4dnZoeWIngbWPNRng2K4ObPtPz8o+kwkfELha\nKouuHwLOECF8x/aqQuQo09EJ+EYPU0y1Mssc/FFonnHGSGND+GX6FNq5mPT3\nSmoCBhj3kUJY0QLdDC+CP8tUNJqrLviFNLl0meNAWHK80XmzT5hp1rI5On0C\nDFVfoZXWz9w2T31Xx/TXpLCWACVO6QW0i9349FiwsMQMj1VA3piDWGa6TT/H\ni60sy27p9cS6r1HamOHHoMZAVQDEoyCSMLcborhTt2vVDRTCMc6lvxDhYVGl\nEl/+YgF4on6GsWc6arTRh671nt/Vn8Wqbx3w4aF3pk7UnZVV0K1YASEYbe3o\n+80rcYdUh37uDhl3pY3pKR3JaLx9lBCEKYeWMJXKeqKpIdoqf+oEacePDUab\nVlyI\r\n=IcDY\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"633b65eba4ab9268df82c1705339a44ce087f923","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.0-pre.987"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.0-pre.987_1584169472219_0.5701937891772895","host":"s3://npm-registry-packages"}},"0.11.0-pre.988":{"name":"piral-pwa","version":"0.11.0-pre.988","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.0-pre.988","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"82589041d135517a55afcf3e87406023f3d6a51e","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.0-pre.988.tgz","fileCount":25,"integrity":"sha512-ipM8gpTcodwv68/8mbUu2ET2lGwe3J8U/qjF6uEBWUaXsKiqV96dau4BYAnZ+1TzP0/f5biW4KueYVF9mg1rWw==","signatures":[{"sig":"MEUCIQDM1bDqCh3MD3bmccpxvXiRBog9EQnrPFDA0yypG782EAIgNh2HeajY0AegA0ec02VQ9FJgVgMndA9BV8JrR3a9Sh0=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48966,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJecpJ+CRA9TVsSAnZWagAAKVQP/0YKq7HGnkqafs+dAx0K\nw4XbJ+GgYjL3zVK6ZASqs5iH6iLLou+BtQwuGnbeosmR5tEL5GAbktl2qfo2\n7sgzD36Y4yq6VAe9IC6HtGkbyMDNjtYGf6SHoI9yBsKMUro8ZlV2qMM8An0O\ntb/V1C42p4NVCcbCdgwusCt0Epdd1JirMemtTJ5oiglXGyDAxEUrourptp6m\nKYzn6fLmgK3qaKAmFlIbu/61e2PgTgo9Bq1qPnFblAT4hexlkIFljVm1zosv\nt5aVer1cBIIyzPBV3DabmQ49C6izZaDslZRkHb4O4qLg2VU3VGoPFTfDayDV\niDbcfGoAwm54zvTKoToLQRRDl3IKpyXUoQzP9YukNvXH6GyGzL3gsAKdpZjw\nOBixsvfORo+pa1amNUOW+yXvwXpfo9WH+VzLPVvleyox00HIV30K9O5AtoSw\nxe2EZIMpcSShNePp0OwpjA+aJqonbD0GBJu7FEKOx1hWqZaufi4N+xzczSHd\nb2UDYf2I7vdqVoodrjYG6gvxG1qrtga3bWhGWKhoeOHyseescAgfalwTNDAT\nHB3BOP4OSAFgDqpY8HdCQrzzE/ATSTKkF55wQQ3cHTpUgiawm5uZiCtyHutx\n1bnUSxm0aIJlRRMOP6aLsXofVGHtVxWjlxpecGKhAtJsj4T6idbZjnSpBL3A\nQTFk\r\n=o9t4\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"a7462fdb36cf7e7c0df2f79b1e3fb3b24f3334ed","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.0-pre.988"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.0-pre.988_1584566909591_0.604155759907917","host":"s3://npm-registry-packages"}},"0.11.0-pre.989":{"name":"piral-pwa","version":"0.11.0-pre.989","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.0-pre.989","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"c2688d68252e83e51832eaa1df5ce5a4574f7c4b","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.0-pre.989.tgz","fileCount":25,"integrity":"sha512-6zqMhSwAOG+UvKSn667HjHG/hNUHpSF1/iBMbPIBjEcrUbhUDxjIGEXDeHaYoFEBL9bJ4lAtHLD6eDntyecTkg==","signatures":[{"sig":"MEYCIQD7YyHtZKgfo2PvB/p4OiirETbKr57NM9Z15dpJP1S5dQIhAN97LKedJZRKOu86OewoFpQd84mblmoAx9XyeG48kMIk","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48966,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJedKupCRA9TVsSAnZWagAA6qIP/RvpU9aY4Nl2UdiGf4iy\nj7aEdXBsoPMAQPZ0xHj2IEqqa8lmqoFOQJBR6rU3ItOd3uplqJ8eNNr3MhIx\nLC+czqowVyXpTpP8JUj82DoJdVxDlUvFr6E52Mku5LsHK4jb+TiIzFFCXAcd\nJDj1hrrq2Z7SN+RANoaujTG8CtCyYsL0vszGm2TbfAVlGJ8aENscW52+7kYX\n4EtORoTG5cWsHKki1w8sDR5QwhJFXwoIaa9RM0Rd0RLtoNHUYqKgxGTc/t1+\noilxlTgV5UlagMQy5Py+ddji0zr0S6sxrgeZqOqhwfL8JW1VN/a1omq1t8L1\nGChc6Y8S8p/wSCwBdMei+UzH4iNBnTqOqXj87Ke5e2DzhevIYWgKcX5UuSgE\nPjVK4+okbYjxj+ssjBlgQpT0wsXS9TZmPP2TTB7fjCb1lZ8COxhX6CI/5UhC\nPHI9cQudyu/U16CE3lyTtk71OUaEhwt+2AsYiAWJNR/OU0YZ0jwv/GWgveb8\n/+Y2geHlEybkjvdnsgN1GLfrIDRiJwBXQE4ehuP3IsOypUpLuNXgeYyWOpnS\nRkFLLzCv36TIqpTRQqx3f21vIXR0TGiDCfY1P3IThtJP+hNMSxClCgcgzcCH\ndJFWjwvWJnPenLKIRMuW7I/wSmzG4Tr5N5/frnAwacgQdO0sC0yD3wCfJxQy\nTNS7\r\n=OM9q\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"c46659b213a32211b8676196dfd1885bcc06f55b","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.0-pre.989"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.0-pre.989_1584704425390_0.2534306938402682","host":"s3://npm-registry-packages"}},"0.11.0-pre.992":{"name":"piral-pwa","version":"0.11.0-pre.992","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.0-pre.992","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"7cc6df7687299bdf6b41a1ee3bcb74b0b361dfb3","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.0-pre.992.tgz","fileCount":25,"integrity":"sha512-nk1DOyUuxPCF7wpNRDKac5E8JyVWLm7usa7CgM5XRDYfz9YyFQ+Hum1rFIwHoLPXG8Cs1AJgV61XSR+6SRYf7w==","signatures":[{"sig":"MEQCIGv3Ec7MFzSAC/Ty3WR9FzdWTUdRmD9/2fOBHlN+QV8DAiABAHjuIaMGQOpA6Z1SORIgmhOicuo2tNMO9lwSv9MNIA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48966,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJedmGHCRA9TVsSAnZWagAA7/oP/ihVHmyY+Rw+0EucIfzU\nt5ozqkJ9q5/KFoTyq9vGFKKke1JMM8CZ3mxnyCVGmRopRHIQ3EURVkTUoxbM\nEBsE9PxiriLNtHeqvjzyR34vZeF08PTzzQ0RK3otdvr4BvaD10ltiAW6RBfV\nI/poSKd1LNlyl5x9GR72eDecmzyqrAMlv3kn5gJm5IBGgRVAVRVyHNsfaRqq\nxVlS7F63dTw363dBBsQ80s6cEWxV0uZdRF9w2PmLNp7mk00TT3Z1KZwW2Hwn\nmBpvHQDLPX+QFPMyBmCwGuJEeegfYXRTgWu5oU2DXItyOZ8KXni5FYGU2sHZ\nNK0/Hh02l0HEqSuxGZx/gyHsPfcH9clp2BzhS1wPXr9BU6laRBlfpJ2YuSGS\nYGsE6IQOdM/D/yMETMKLtUkqCmODrbDHyVixpXoAMza8i4E2x+j8b6dhTQeD\nMyUMfe1bPhaGsMsKSf59dDykqWtUfroYFiXVEM3ZO2RTFlTKxUYaIPs2Nlon\nwZNzk1096m+wCRV8sBg3KsxBoApGNzuPmDe7g+zzU87nAq5hO0Vz/U5VN2WO\nwCa7HcDkgiWpBNYOUoAVrVCTm8c7I7KsKdB8XFPINOgBsxCQBp+VDRQh/nYX\niXMYAVABcFPAIYrboEGE/pzp1pynsfU/C+0nHjgPr8KXeiya3MYoPUBQFRqg\nj4ih\r\n=N1TV\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"1bc857ce4ee178e56dd7cf7468af180411384aae","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.0-pre.992"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.0-pre.992_1584816519541_0.42232856201417834","host":"s3://npm-registry-packages"}},"0.11.0-pre.994":{"name":"piral-pwa","version":"0.11.0-pre.994","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.0-pre.994","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"a2fb1b6ac2ee5b1134fa8e2b342de7daaebe0947","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.0-pre.994.tgz","fileCount":25,"integrity":"sha512-iqkF+FT+SdV01ktSXzsKeo82fN+BV+wOGPmxmlpX1UnbVw0dhZC4ZJwwydZ89K48hUqNEI4IBOE9QOLViL5CPQ==","signatures":[{"sig":"MEUCIQDgl9S5RS9FOcxNdQAAKJOYItnhHit3QCKEKODmP8t2NgIgEqt9idbNlzwADKW9fhs/YUtc7ZZ1AsVm+qXENiS9fU4=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48966,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJedsuCCRA9TVsSAnZWagAAUWAP/ApE+4UN605g6PqhM7D4\nAmCFiZGdyab7jyZW/u8V7ekfKkBp6j+DdjZyz26VR2CZT5HiO+TU5fJYxGto\ndaT6NweXicsAl0Xtg+hmGsWHgDUhLD78raHFovHL5pzESB72CmwyZxPX51cZ\nCYcYiSf96THGiL2kZ4GHFaI/YUdzGBt+UlJMf4kQFSHEYq10zTPPyOUIGhdt\nnftYHfO8AnJvFilCGMw7DnGVFbeSchGUmN0ILMR+jWZPzzXU6wvbEHxFJAOE\nmPmLfQxSAYd0FkB/F3Hltp5LtwQNj+Ju87Le/Jut6+kL8dmYntQG3T4BBtXB\nfKWt+8mmVQZkI3eojJpiTMYOo7fSgiMw+DzkdK+SOnYsbAPrsngzcc2F+Ato\nRSmLGHqZLCcD3nJKAzeQxhehKTsytow+IGNXbF2t4KzjxfkEetCXsdGBPvEA\nEQA8nhTi4ZfNyZZEZE3eVwLC5QRpjxaGU+HXS4fGVfhd9zLkTCEYjwAOTrP3\nzgq41WHmMq6C6na9NoGCDzcQHqXV+JGt+1YiTb+1Zmcv868Q2DdNPKo7OAXe\nOSa8Nmq2cnKn13Tu/Mye6TAb0Ns0NP6VckTvD9Ue01DVwV78tWbyL929V2qU\nbIcBxa5k8blyhAuP9zgUG2UxgR10y1AT0/L3zpnMfmn3nda0eOvB9tv7gaaV\n6GYz\r\n=Suyf\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"07210f348491032579e35b6eb7bde95ee8047e0e","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.0-pre.994"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.0-pre.994_1584843650403_0.8836593154817383","host":"s3://npm-registry-packages"}},"0.11.0-pre.995":{"name":"piral-pwa","version":"0.11.0-pre.995","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.0-pre.995","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"60dbb39f10b5d191ba2d1866bc115ef4fcd80095","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.0-pre.995.tgz","fileCount":25,"integrity":"sha512-EMs4XuPU1VtTDYtFoiw4+DlgQxftYji6Aj8LEBCn70iVkR2swB/aiTDVjtLTYDCrG54EBXZOoc1GZNGBAxGtAA==","signatures":[{"sig":"MEYCIQDz4Gph9obwcSAzK5Hz0xfWwO54VuBdMPS3Otdvf1e4QwIhAKM8EDXPi5OVX+rnhccicdAQ9gQLrlOap4BoL5YoPSRM","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48966,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJed/G1CRA9TVsSAnZWagAAxP0QAKO5tjWpjCK35LMf8ODX\nnmTgWpuYZu45LRjnuDPhsezPw5dUgbtD+r1+9J4OPE7v6Qd0aWlppbnD2m0y\ng469c6mklgdBdI82M0rub5ObBupZD17X7WY4i2udCoG270nfU9GmYnlG+JR1\ngMB1ngVB3qA75eh3fG8a3i+06VDJV417wZx2B1QgzZHni/kwuwtFglXWVCiw\nV8TjT6Yma4lvP3M8UD26mcq5FBtSGY3Q8jXph4Fs0tdfKPqiMVlPc6kji5gK\nzmId9WhyOz5nLUrQoMXGEtROBD/W5J+kwxqASMprl/qLCDGanTutruB31eOV\nPCz1sl6uM7j+NqWrXrU1o6Gp+uIbGDA5qr7FrDEJMwr3ymFiTDVtXUIUBT9Z\nenESgrk7AFzYvXfNN1ghJSlIhvQq4BxdYSTZKZK/uGiNHFo7pXnXI/ec1wCZ\nrNNSf/bQdjopT2cNn57PHO2FXiad/yHtKdprURvculpy+W8BOh3py51rbxi/\nbaT8tL1DVYLRasl6QdQhXa/t7URb8HSllIWnFlIH30F93tGqO6yrq/3a5RL9\nWKp+IuUc5lr+Ea7SjJpJDq3efUweZw5p0kwF8Fq3WQW1+SWUGoTofAKESl5f\nCTeF5bifcM1140JIZW0EgMrjBE4w9piPzVU48aHSIIxJpQx6BL7qK7VR5Ii7\ntgIb\r\n=237m\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"4ff66d3ac1e6f31274ac1487d56ba63f6c5f0004","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.0-pre.995"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.0-pre.995_1584918964565_0.9127671802918198","host":"s3://npm-registry-packages"}},"0.11.0-pre.997":{"name":"piral-pwa","version":"0.11.0-pre.997","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.0-pre.997","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"b07deb71b0b42f5beec37474c73ace24c5e262da","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.0-pre.997.tgz","fileCount":25,"integrity":"sha512-aS1umOIrpesmNq1efe3Wwoexh9o8MaAWzTvgJPx/n6+/4T3+LInghtRJzjaxrgYWzTqOsG70/YVL8CfuwvRlvQ==","signatures":[{"sig":"MEUCIQDTHGX6MivYjgtJY9hYdJZu/R8+6h2ViLQJxgzfOxzzOQIgS9VxWfX7rzDjPaJKL9cR3Y8Bb/OThRmSDimNuwTAVJU=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48966,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJefUcSCRA9TVsSAnZWagAAEmIP/RcrBG1WAJmr3YzkKLNT\nfHHj0AGaEhXVs++rzPPqAx4sNeODAkoxTDmwgNAnANopvYIihSUii41hWXWs\ni44UuJ5GljDHXnBumuFlHd5iVmyK4fTq0D4CMYroKNQRuwPCihzPU5cUK7QY\nLJZeFr4tdrY1a6CtHV9CBBJt+sJJT/1RNCfNuQnNGC2enFB3R2OaJve6uBNG\nqUW0aNbBB4biGoy7JQEv2SZZHZqAnYiKYsHfKSXkpQgQV975/dA+ku0Ho6qj\nDAZ4Ef2VJ9a5akpReNmEAL8Ai8KWEvi2ZxmIUKSi7UbTYuxwYo65lPNjo7v+\noIeJPQvcEzBo2qbrN19fqU9i9tRV9lyrP/yy3WyKU4kxmefuey0Nh4Px4jp3\nqGlLG427hhLkMQv3lSUoAQ0lEzPsfSIHIfxQCPpv/Yrq3muMTS3e5i+4MuP7\nIxWasDZrbhf/vFoWSRn2r/a6Yi7uvgg/nB25yIMMeVFIT0BAAs3x3/wOOLFD\nR0AJXbQC4SwkBo0BbJeXpXcBMr/y07RLs77Gy0CzGpO9crrDEQOg43KM7WfS\nmZJSxr3/sd1gSUZcHjAu0xC2AdsntuUKLP7uKSl2oM+kvE8sWwZtEx6fKt4y\nGjbrCttEZXTM2K3YElh//1ZzhfGJYRDdTekBkvLwUIjfahsfF5t+Y58M6WHE\nwcBd\r\n=+T8z\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"8aca7104e7ec07b937305210339e283d29b0b518","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.0-pre.997"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.0-pre.997_1585268497642_0.7289405138844887","host":"s3://npm-registry-packages"}},"0.11.0-pre.998":{"name":"piral-pwa","version":"0.11.0-pre.998","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.0-pre.998","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"adb3121c594150e2e5eef330f45536438848554e","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.0-pre.998.tgz","fileCount":25,"integrity":"sha512-1XN9EHguZSX7bZupLLuhei+OSI1MI9wYvrJhu4khJakflARY7tFDf8WrMD2v8pG15PRALe+3i1UUudrENUCgDg==","signatures":[{"sig":"MEUCIQDqLTStuhJjHe28W4H6X0mtBFNqcrb/Op4Bd/i8MDfkDAIgQMYOD9aA9yAhrm2gQ3hynR4Qfenr+I+FVxn+Bfy2vas=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48966,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJef/+zCRA9TVsSAnZWagAAcLUP/2Yp2YgFj78AMP4tQEq7\nBOJ47/c3cChefxFZjprAcaVkatDYkG0wOk+5lsYZys3IWXJqKzXtxxPq1XLN\ndjTFI8TDvswCTonqXpGSuO5whDh0ft63Mf8DOFiJuDbEqbCg2sipIYdG+Scv\nrkhe5VUB8ehZNiBpmFtDWUDrNFDZSPGfHX1cGwIYSDdFDXqDDDoyUMwwEDq2\n9lfTzWuNF1nxdRsGRXXN3QRWw/F2q/76qde3kL29LLf4p3Z7k710V5b/d4xB\ns6ySy9SkXn7hENchgHo7pc6TH4+WucpeI9e3CUaJNYHvCBdDGV8EzsTCre4C\nI/couF4zLyqo+Ll9uwSLo2G4uJDdl0ctswxQ8D0G8WjcFlBwf2z3qAHsKX+T\nmYYv7HZBWsBsuI11m4gBwkruiRqbUL1RFJmOd259V5lbVzmyZk8Xd8brSSvB\nmcHABv61To+zoDsbbFopCSKA3J1m8w5FOCwzsjXzWHXZZuC1ZErl5mvMTxjP\n7J1wF1QRinLW83AjbLQam13oTJCbv+iTtayHb2/auEfjR/DPJ8Kkb+zZyIHP\nfizBSzG28rgzO0PwRtXAN4Fvp0aHeoNsJuPbdf1E5BosIicekOgaly7VGOSU\nCz9g4j0ZDdWtpfh8dIueGvwrxqRnZg9961lGFvzrRMYf3dMQLfefX8xSGit4\nmhOz\r\n=k6dF\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"44884607b9a5e693e13201161b19f586834e3b3b","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.0-pre.998"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.0-pre.998_1585446834948_0.33041932547556896","host":"s3://npm-registry-packages"}},"0.11.0-pre.1007":{"name":"piral-pwa","version":"0.11.0-pre.1007","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.0-pre.1007","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"b18c9600e69816dc5b7ea178a53a7b02a21bf505","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.0-pre.1007.tgz","fileCount":25,"integrity":"sha512-nsU2Ds9PuAtRdAfZ5AI4GNYwqcpAMQyuF/vT0vL7m7NtFHoS9dPZJfCpqJu0IotWwMib38IIrlZJuuhDqaRRjw==","signatures":[{"sig":"MEQCIH1GFbWcrO8JY6jyAXuo0lA7MYgh0GD5zRo5cVI0gfDTAiAZgt3E5TXu1jBLH3E9zjJpmG7SzAe9TW3ex9Buh8l0Ew==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48968,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJegTQBCRA9TVsSAnZWagAAoLkQAI+gCCjrR2r/2FKyeDkm\nGx1sOqygDIfOiu6OHKg4Wng55J33vG7/JT1r5kJanb66Y1k4TBBEogKrkC0F\nGYAjrngUsqJxP1ToF78gLNb2azMGJdwyl5GMEDB+6hFf/iYAo+c+estZEPKf\ndLDUOwX0YosdEitWlhol+6Gt/cPgr5tFU9FFGN5lPVBpnzXm5mY/sTdQ9XpK\ngOj9KpWmXKIII5aY4Hdig56fuR6QA2PhAGSKuO78qKK5NbZ88WxSMt1xJ/jk\n4HpQmdxKGKifQseONqmc0aWcPhs0eE3x2EVlrHhCvcEVdUbHCDYdXilBtVm8\nG1eO1Q/VlSsV4hShsxI1q+91wDXgXxKdpgNbRfRWltfUaxwgohWITckQtkVU\nSsIYkABtq1euem6VlHbYOEEq6/0QZ9BcxGDajah+j5gVkuPMvLfycwHdXukg\nXqcPbER++VhKqGNGZ0GeBeQpAPclNijKsfzKRCM8po4ibE4zwpXtfnHUnVrn\niE8bteuxVy0U4jDclSjDKzvjvlW2yNjC8JRtt6MT+z3x1VE4qZdVnG00DOoR\nYXngs0Rn7ey6KY/vgG1xFyyXHhVVrCMOoHANJH6MYPL/coN2DWUYBOBx5UEd\nshvMPQVQildJ9sjOGrcpU8jSkGHXoUAMKEI6bQyN48EkSfMPgil0JyYV4c+q\nR2qz\r\n=4I4w\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"052d043f9755832a38fb5badc61e4de2b4fd5e91","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.0-pre.1007"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.0-pre.1007_1585525761133_0.5896940193414089","host":"s3://npm-registry-packages"}},"0.11.0-pre.1009":{"name":"piral-pwa","version":"0.11.0-pre.1009","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.0-pre.1009","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"0a432798460062886dd0e8415685d3ebfac612b3","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.0-pre.1009.tgz","fileCount":25,"integrity":"sha512-0nmHRtn0/63M8Mc2MDDq98RwMaPQJwfrNTdmdPMTi1q4y2BvHWbtFo1Hgf4MKdQNLKYQ84KZN/TB/FvBZSzRRA==","signatures":[{"sig":"MEQCIA1ZBrHSAqOjfWVyNdER1e14ohAzVAjS2aJulDGQZ0DIAiAiqnJ62BRl/Pucshe/1qlBTS9TfSSGXMV0BZ+MlaVdoA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48968,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJegodUCRA9TVsSAnZWagAAwr4P/0iEFq/WAin813nCRbeV\nTlmmC5yoJh3FZPBWz1N67QmstAF23K1ufl21rE0tvjI6L2WPd82aefzjQnYL\nskiZ+XrMfjnbATbn94TZvCEWGDrTFeuGSidC44HEUJAYQ4KsnttXHYEXvM83\nUjPvxe+VrIYw3CdyJsN9GSI1RVTBlbL3EWxmvjqvWhyJS+Dj0xQxkbZyHv1D\n80bw8KJ9cczTipY9aNHYwa7/MeiBjqoKbfeJsnSxyhdfu2fBxUeICnsWFNeg\n7SMcgHmBe52LbHJNP5Ryqta61I8wAy3R81XLCrWnT3h5j9IH/hzPbdhCNsf3\n5hd28nZaMIpMbmZyZfC18ItNHCf6v6M2+R4MZyR8Tnh7XQvuev/lOMof4yTR\nHXtb6Y52yoWCgbuKFRtsVFAfOJjFdwOYgsSoes3vmdlOuFJngvAmHiAd+gke\npg/DX0zrMaejaNQohfKz0e2jA8QbjHU9a+hEgRrmVqUwtgam636pS3LL/mXG\n7O9ji3QW5FC726bJ+3EPxNsGlChPcs4N3V3jv2KfQFz34y52m65CWjzk0l0j\nUKl2QL2o8Xq1b6OVF+Q4SsjWfFEVuRF3y5XKJyOOues2O5dRL/+T7ksRZEPR\nAwzLDD/E9ZjGu3VSpmZh3vzSBqjFahPSaKR2ScI3nRYkvIKT0mocxsu+IFiv\nio6v\r\n=lXHJ\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"1874638fd56835dc825f7faab3513aff3c8ddd0b","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.0-pre.1009"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.0-pre.1009_1585612627855_0.8073660303223682","host":"s3://npm-registry-packages"}},"0.11.0-pre.1030":{"name":"piral-pwa","version":"0.11.0-pre.1030","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.0-pre.1030","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"3264f23b36205ee5d3c39bd5965c3b3fd7d8f25f","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.0-pre.1030.tgz","fileCount":25,"integrity":"sha512-Aa5QgNkUphdjhNsmBQavhgocwnb7FCUGsBSE1vIWUdyRotVweVGzUbduzPNo/1IcE29beizygTjOPBpNV5EnQw==","signatures":[{"sig":"MEUCIQD5Ge5n/82bKFsHiTyVzvW2cW/ob4UCKUsvW2AG5lxK7wIgeaKNi0P7xxhkYlTCjBHyuGTGfg6d3wfOtdp9Y2uE0ZM=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48968,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeg1+TCRA9TVsSAnZWagAAqvAP/06wKRdNuGbFs4L8+z5K\ncJ/OTzxSsqBGviZfpvkNNhFyNgwhoOcOotP8KiVpy7yBhvPi8GotToCZfbAa\nKxamfWmL5lpNFGwA+AlWhKq3W0giPTM3mre+DrqFkZ/UAwahFovNz/OgvlYL\ne+Af6b5fe/kaGwzheicZ/KHdb4eBUbV/Y+nUBnzHYw1aIk3+OMOI7tLqEvmq\nLkkCdDp+H3u8biGPKGnU2pyXWk+L8TpvyAHcsXUEwrGB21cEEpUIf8mN1UC2\nhl3hFpfaF7VQIkpMkBXXO2oA96VncAznwm64kJOs/Oskt/W6lC9K6/CSbrNa\nglzyTbT/kO0essr+TGbDN0RCjWy09V95kJkiPoh3/p/S2v9oBl/sMApBvhzg\nZSC3T6B8jVoWPRhBff8Yl8c+mQQCIOAj3pBzCySiJhK0UxmQ8QWnwZWWIMg0\n/im5OWcBkRgSg0mSoFhsEeLs3mKYbYTiO9ZvEH5XzjMXc0+i2gRzgoIU4yAx\nWSaljpJQLJRvCZRZ+MXYTrLvhajdYzXqdlSe2sncxjwjV91AlNRl3XA4ANhf\nV0xsTrssab083eJmlHvhzLJqvEeiS+XCcexMjIouiLUHjS7lSii5cvgX1/Ay\nuSl09dFhkoRicjEm1MONCaMZnaVmVEydkcFgOA3G4eY5aIVOxef53ht/jbGC\nQCQS\r\n=6f7M\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"07cd6733fe26694c4a90ecf582b59915c64fa72a","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.0-pre.1030"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.0-pre.1030_1585667986984_0.33295971808329083","host":"s3://npm-registry-packages"}},"0.11.0-pre.1034":{"name":"piral-pwa","version":"0.11.0-pre.1034","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.0-pre.1034","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"b0892a5ab67996497816b058390a8892e3fdd875","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.0-pre.1034.tgz","fileCount":25,"integrity":"sha512-8X1qHcvfUh4J3q1uI/KfurbabE+H2aWashuIf5sst/SjedKhnQY9Eh8SK4O5EH0F5oOqYd+6yIehr49nF0Eb3w==","signatures":[{"sig":"MEUCIFlX3vS1LNpoW2g773rmZwFxrOWZvoMBmZSQMDkXHXh2AiEAoGefG840Fw4sdBFvdLouE/f+vF+ZzNoLY19lRn7YuBs=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48968,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeg5IqCRA9TVsSAnZWagAAIvQP/j011fheGnMi8LLf3b8Q\nbghzb9NHt/pVA7fTXN+25bMA6Q0pwD20q7qKR2AeBf+kyQZB/ppyAbrl8dhX\np28VsgInoD3Ufpi22CBvlEloRQH3zhWNfBEJBG/MdW7fJmV3U4VKMeRkvN+M\nmhEAdem6gC9DtkCOgule2RHffoRZnns1v3M+qhlwgrLoEIW4Rk8hjCJbBNDI\nQRug2VyH48Q0xMbRezUGtctUM9EJJpR6858z59tckvrAMQsNslJLsnpCEFRt\nu1+wutH2OVu1pJAkXTu27FOKqFyHtuiDIBTGymED9kJk2u2kn5bW1esn16AC\nh361puKuZJ9WfHilzWBAohm68abpKKSssqqbZ7hhnMqYlzUlKU0NzkoBQYVs\nSWO6s+tZKObjkY4vfrjT+JNOKY7EGHpTxCp1uHjGo+Pu4czjD13BeSaY0qMA\nfGdRel83mulJFXR2nYyl+PzEfhy+oqQg05NQVOpARpnqyX4h3wxXlYFfOdBm\nRWAjRLsatgbdRupc4D2WDHSfdgoSBkOygSeabIt7CbexzWfRhvO7gzVHJWR3\n5acZmZEQs8Nu4q/tlTVOj+3Qk9OtGHxo22tJ36UD5sX4aU38EmrnoA8MHwbi\nxA9F+41Ib7ka7Ji5DmB4+tEGgbcRiga8jgKXJ+Om8mYCrVjIPlT/GJPKvjN/\nerBv\r\n=4Yl5\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"035e37243a04ddbdeb0fb918b3ed37086d8b8ced","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.0-pre.1034"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.0-pre.1034_1585680938584_0.6085597600626842","host":"s3://npm-registry-packages"}},"0.11.0":{"name":"piral-pwa","version":"0.11.0","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.0","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"fe67863c06812b71244c4734fe1b20952de8a9bb","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.0.tgz","fileCount":25,"integrity":"sha512-Nyk+B9gQtiFbCxOOhA/q0eKIeA9zMB3afeYf+4wy+C2etTNYdd5s6ql7fxt1yydNcuHjBsnj6VOE9ydZpdeJ8w==","signatures":[{"sig":"MEYCIQC1PXv1b5g76bze0tfzgVpBiUFbEXkPZhi+/ppQwiyIUQIhAMVUWedeJqBjRmR3Kp3Zqs+XEd/h1y+mOeXEfulFmOgD","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48950,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJehC/BCRA9TVsSAnZWagAALcAP/1v4AKpVzZigKSDq4bux\nJXd5OirYJyWAz9LuWWgkmNMjV1hZLnx6ZFtRST7VHDuJlMRPRfZZlMPci9FH\nrwVcCCnNqcBJGhuE44QLjafZfkCqC2RJn9wlJYOO+G0BrrcCvMury6cmmRz+\nGHl8M4HP4VD9wuGLKGMwU/bjBCZLU8KsibaoOTajbWJeTNiXzHBQdQ6o6/qM\nYqNf49h5w2geYRfGoDftp92C4Hlp74mgjOJ6Z1NLWMKdsK0hJ9+5wLVdoVsf\n3We33SHCtIq6yapQANRmRJZKyOpJE0c219tKfLiT+bbDqo8SGJHx+VYJwmyb\n+qC4gn9sV8QyiBbidCcmLvHTjzADqFm0l0AAi9v8pI02jk0mcB/eTH0af/IP\naRUhVFow569/lCWjTaJPUjZQiUAbYiVIAbnpqcZlWfygJZp422PGrIDkGdGd\n3RGQ0cZ1N6CX9L5LWyvkMRidjwkD2h4WnM2WmxZTfxXLhuVRAVDGmt/25+Ry\nlZkHVrgJFCQCwFZYeqmu/f7oqZ/QQpto4hZiKEbGR8UJD3ndzAhdc1ETmGs/\nXJbVUP2m1jXy//1uJDPH/zZygTBvLKnesZR5KLsgUBySAkt6t9iz3SegtUvX\nUlq8tc8ltxO0iO3t9M+Yl4Haj+g1usy34vOdnTZBEZkE2nTXHSNOnTGIFvP6\nfE5u\r\n=8hYA\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"dab519d15986fa1488e1c184d0a664c422787b7f","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.11.0"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.0_1585721280842_0.5353306978657937","host":"s3://npm-registry-packages"}},"0.11.1-pre.1039":{"name":"piral-pwa","version":"0.11.1-pre.1039","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.1-pre.1039","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"e05fb4944c361c8d8a4139f63ebb2e36087a73b9","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.1-pre.1039.tgz","fileCount":25,"integrity":"sha512-GUoDGZNxsMW8XMtqsIgIKKz8o52LwzsdQfxo1duiWxospB+a1h7babIIs6Ok0EYNOYdzsR3NH3eK6/ywAAOBjA==","signatures":[{"sig":"MEQCIAKlVd9XskC0G4peCwvGzzi8/UET7FRMGn6YPdGCAJU9AiAbGdQHZgEKPWzC5nigqAmBH3Q81qq0FmYJDImGT0QSsw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJehFnaCRA9TVsSAnZWagAAVxwP/ijEGWR8y1y3sEv9Lhy2\nnHt90G8i5jAPUpgwPMTKbse4logaETU14ek+4r61GuxvzEQF5O9XU/louSry\nNITOsAJSHR5Y3mAg7mgKLnKpkDP5NQH5cT1iflg4xuooWPzYmuJTFaQ8gm7t\n1DHGAoNi+Nj7GCjHwoJeHFoFTHs3jOJ5PFqs1z/gYNcUQPL0VVWp1vtmhN7C\nIsBU92n5xyHWzO5fGJ5HlROc40eUsE/ubQV2sA512bdeQcDwI+PfTh798Qg3\nu+e7vx3oKaMMkF+bugAVRuEZzAgbJi5hhCEmgUO4n7f1H2vN+5UeRI//rG6r\nlTJOB4AD5+1iVJj9gzoXFr3+A6H8RgGkveoQ9Gf3XhNZmhT+F5tXyXkdItVd\nndoqsPGJmjXsr0SK9eGtVPNPzlcYSdDwNSWmz+bVfTQi4zevIWsfpbCJMjfd\nmvivjY+Rv/NZ8yhocXPT95ap+04fVU6dKMVT5lOtMFRmt6Jz4LSVYrPkKID1\nqTNLTn7u0Ihxd6ONZOgqeeritETbzc4XzNGTH/509DXhPvBGs1KdOm4SZ8bb\nxrqugmUEQtBBKiLgk8qYpv6FPBurYvCT/QhwaCO/XnStgtJ5LLzIc/ppgJ5t\n054cVgTkyiP/4SAu598b6/ex+qPTzsX137CUkIuSgQX+QCmiEHhGOFjDZNyr\nICcK\r\n=nd15\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"9fa59279f63fdaf15eaa5d82627eff741588120f","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.1-pre.1039"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.1-pre.1039_1585732057975_0.22528161278407333","host":"s3://npm-registry-packages"}},"0.11.1-pre.1050":{"name":"piral-pwa","version":"0.11.1-pre.1050","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.1-pre.1050","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"4af7658fab822c590c2fe994ea53a2bc4fc23d92","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.1-pre.1050.tgz","fileCount":25,"integrity":"sha512-C3/sbE/zBNPiOmCqTEyY8j9j9Ewl9isdo7yqyVn2SsQPmht/uXJAFbnP+viGAhDG6/jhc5s1uQ4VsGAobw0GFQ==","signatures":[{"sig":"MEUCIQDNy5NxSwEy2ABNLvpTN8//5PvJcf/hojhBazKEftHGVwIgLQvijVWm2PPIG7qFCu/MBVWLEROG9v90kVVDKzNhpaA=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeis73CRA9TVsSAnZWagAANWUP+wYd3Cbvz/L63ZtDCJZr\no4y0HimOUJOXnZPU+ZDIc6I2aXC4e0IPsCtWtD9Lp5UOJ3o+S+rvo/RNe+JS\nFYoJ9y7I1vs1sEFntqrCRwKTarA8Sm03QttvrtEMhpyaVs0xaNfNUGT3iUgX\nC1ddmzq9xuZFrJV6k/5NO5/CKFtGB9iTRvmGB+pi38geW+XftzXHYhxwZe0K\nRYiqVnYeIJIoffnJ0VhI68Yga2/gpe+RRJQa0l88EbBy6lBg7ZzXzb3n9ISr\n5iOo+ONtDDC3yN5LCCzIclq7tIqxwa7bpNBTBku4QZmuhV+crgrAv/hZGpxT\n8wxLvslwdjk8840oYXrl8xTQYe5Nkm2Gkb+x05e6kuKdP8gujVf0rXB+nYkc\nRcrU9Be0U3RSB2Z3A//PL5UE1Gj6p0/2YaQzM2MvE9IJibrTz5977SUQj6Eb\nptCeYzyL0wzsLGrbu3jM9S1Y0tmS2d8nJ320TOfJdFnFunZGQjKLbUCEz4LI\nW1Y5DDXIZhgtWZEx4ljGoYKfdpduk7DGi7WGzrqJe3GZ2ErAVCBMUa7BdIBs\novOBBin+1K4RRgLpv5tcsUgasTFVEARSEFIPp3Tq7zV7hGG0qmEVu9haoKAK\nS9luRFKgnZccPvCXv3YNIJnzE/RDXII2is2/T0wGlXn3CrdLWQCHzKlkwZVw\nIw+k\r\n=XIPt\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"7dfdde4ea9e8e9469ecbbba473b6a0d1f214e001","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.1-pre.1050"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.1-pre.1050_1586155255478_0.35802515291536774","host":"s3://npm-registry-packages"}},"0.11.1-pre.1053":{"name":"piral-pwa","version":"0.11.1-pre.1053","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.1-pre.1053","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"031ab681a9c61593d1eb092a08d1954d02aa36e4","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.1-pre.1053.tgz","fileCount":25,"integrity":"sha512-KPKvGLYZwFqrwg06AS146pq22IfAC3PjOsb126u6c1KUeNoGu3/frm+Y+2xw86V8Ri3B+3EjIhGp6b0EXuIBOA==","signatures":[{"sig":"MEYCIQDqQVmT4SBGzKDR5jKDEJ4tCTv3fM3Zpa6FbATpzsKrnwIhALVx96+1nhnhczV/xf3eAWgSnkPpmzoAa6a0pugstwqv","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJejbftCRA9TVsSAnZWagAAfa8P/Rz7UUs3zVKvXZ3ES8EK\nJd+2vWfslVMGgeiNntDc0OhrFVFDXyafWLzsvH8m14D5iJ2fwSFXXuNxPSqj\nlFZY6JfJiGBGqCdsIHLBHjd13+jEGVz00ZdY3VJiThB/dOiVVJaQ0SGaFMxO\ny+TXlXhFIpVTC8UBH50Uatuv2m1LMbkgiADUMUv7AMt0K4ZXqQ2TUBPQz8fD\neCvj2pIMp4hJY1Izxy2axZ7JnWkkBiqJuNcksbzZO22MSNHMSE6lu8n6CBxa\nnvPb5grNVonufMwTeiTXtcklAjUWj9Ww0AbfE4ZyNAvSnqOLMHUeAlBMxP7e\nYxldyovo9A7q139jWvZSWKz6P6Lyz5NNV9pud5LIXpZN6skVV/7kjHUBp7fw\nEEQxLvL+EWtMxjL9HYvsA8rrnBHMSwu4Kj7ha4/ZywgfVlKJODD4jGznCkX3\n2rFwT6i5cEGHjgqnlGDb9ql6OYS4XUbhUlW44QlCNOItAQskJPSoNjd9wQxy\nD9GczvvPYwHvBTFB4lFjdPxBKL42EGGENO2/QUqjhrpPae9LHAmmKnifPhs1\n3urJ7xkAGQJmkjFmpKplQqo/Dpjdw5V12L2Z0Clj26Dv/7T+At5tSBSrreqA\nyQV7cznNNtiK1SumFrPvo6agf0NVcfNTU9VR8CbFiSnaYPCr2mun6ozuyEU6\nklBv\r\n=CtLJ\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"02c384db2162e9ecdf276492fce3c47457e2dc7c","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.1-pre.1053"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.1-pre.1053_1586345965086_0.9550803207253775","host":"s3://npm-registry-packages"}},"0.11.1-pre.1055":{"name":"piral-pwa","version":"0.11.1-pre.1055","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.1-pre.1055","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"8be75f8df19bc6a91ccce1300470dbd0ef88172d","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.1-pre.1055.tgz","fileCount":25,"integrity":"sha512-cBDX8UW8eGPH5ocUUMxDSctfO8DtKJ4FawyxX8bntcv8FmKr77e69KtIp8GhpwgBnmqRAQsD6rMHJUVlPjfnEg==","signatures":[{"sig":"MEQCIDblgRNCI8x7qWogzES55HrDjAIDhcihmkGW+PjiO3G3AiAykuPVzA8EAko3WCszouxRMctIAQ++dPsTtcPX3YFjVg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJejh4vCRA9TVsSAnZWagAAeA8P/1DNo+L2po04nD4wKfx9\nvtKogVyd/tVG5bbpIvcljkjdeZp8nWqWWnjnKBkG/x58+4JaSAwtd3FFU0Fz\nzTD7i4dD2i+oeuCQPt5M17mLbBURLP8vGeD4Bw0z7Fe2G/J9ihG8q2BKd9DJ\n93Tn5iOnUv/+gcTN+IyAq0rNDGoYxfbQd7ZnvKBxHi72ncQifubjZShN7FHd\neq+4AjWtpeBymkkrrr2FADRzSqUlQdYgJevouRXD/NWmNvXL33lkzuZADxwC\n7pY4tQaM+JuRrnvDn4/5Vu4Pkf3v9PmMj7cd0nnF/UBsicRnDe5nhYNBIubU\nnqiSdwbhMp2qVQGE7NvIF2W06liZ+aSsHK6OrJt+SG1npr80pAF5Can/eN5Q\nMPcnMoOn+ArDt28uN7vEHapaOCabj41AfVxeYdvIWR3pEZKoJk8hWZVW5jpQ\nYf763ppI0DVtsZO9I1rYGIY256bIOckUm38s4BfnCw3GliQHpGomTA0W0azg\nFzL+ukjnrhb7YsPFA4UK292aIGQAOwmKGgrgL4vfXGxByj4fhP61+TUz/C4Q\ny4Of94D8gqawaTtr8GLyCihMlUzrInCoBUVgorTNgnS8Nb/6lFlBpXTT6FxP\n7bWgXuXpcQhqQB+df2Mlsl1dyCYMeNhXBo6INr8YDq9hVZG/rkUSt2j2pusw\nNFsd\r\n=fnjx\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"8c3fadc6ce15f27a84c3370ee5a6f095ef48d9d5","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.1-pre.1055"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.1-pre.1055_1586372143330_0.1545301107117949","host":"s3://npm-registry-packages"}},"0.11.1":{"name":"piral-pwa","version":"0.11.1","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.1","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"b04c16736cdaea8b9f5bd4128b9532b9c6686565","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.1.tgz","fileCount":25,"integrity":"sha512-XJ9vXWmo6oZqF3BfvtsKRuH6EDXA8pUxPcSyynEL8+FaiBQ4jPhJHusk62C5VUu/EbZdhtd/w1Y3zl62j1r+qg==","signatures":[{"sig":"MEQCIAoReerM2SgpFhNR1H/vD1o3NcdjTimRkfYWzAUTPQZpAiB+JbgoEShQME7T3ExfrGt1xjKJY69m+pnRM36abXRo9Q==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48957,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJejjGNCRA9TVsSAnZWagAADugP/jJqjZRzYqiQ37Y9OwKg\nPHxPJ2B9dWGJnLYH0xbko9hkmabfEgs1aznc0jhAX+4X9vwvbIy7OJuwi8o+\nsMhApaJS5C4JwvMpJ18K11wbf5d2InggEHGd1Fx01YxCXIGdkYjB8r1iVQxZ\nJHgmIMRDTDLPcF+aiNBZWEifeBANh6HUPLgnRq2LPzCSaD846hh2IbnUQHIj\nFaOlSgtD2QXMAJpPwYxaJiJJKVt5hP0nvQHbGoYGpJsKr/PtW6EY+c7ybHex\nvT61Io/fI5Lm7N5K/Yvubai/rsgRDuTIvHU7Jwncfs6wNgWJgmfE+jKwqS9q\nmAjxVHis2cv8v734SlawcN/bmWyPW5pIkXergaR/aH/dXBH0mTaYIw6O0ikG\nIYE58HiU2w0MqAQ6SDsjPVtvc0hYOJyXh1aENOxNlfQodbu/d3Op+1gxgq1t\nzgVjxxt5LvXO2Kn7TC7SfwZCVyJ2EJeRA5xVQXzi2JIYC057ZEiDyxNFaZAM\n8Bc8YxHLqu5E4u2i8ylMeoRff5Jl3N7oxo62o9g2GujLdi4hsyXbx/KMY8b+\nGG6RFLUNc6BHxrOkBNgNB7la6jRS7mjGJ5HH3bFoOWjbCmt7A7XWj8cJY9BM\n5K0xOn+TqjEgyYH1k3eeG8PF8lSMFSvr0Zc09Mi8I8tcEOO1JECFZb3C0Yb8\nP+j8\r\n=zIpB\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"8423e8188c56c532fa01cecc607ab1664018bb15","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.11.1"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.1_1586377100641_0.5611502958928836","host":"s3://npm-registry-packages"}},"0.11.2-pre.1081":{"name":"piral-pwa","version":"0.11.2-pre.1081","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.2-pre.1081","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"1d5aeb39c55b732965ad53a7408b3b572697b8fd","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.2-pre.1081.tgz","fileCount":25,"integrity":"sha512-S7dp6+tCH7Iq6Lccys1KzM+xhC8yE0gMSQ++NukmZLF17vQolYZpeD2lQgGugwvLokXY5vlsEPbf3co8QlUzvw==","signatures":[{"sig":"MEYCIQDvpDDYQienv+Er8h+bYBSO8WA//eoPCL8GfTGTloXL6AIhAOZ8DVDN56aLB6Muxpah0kY+H5Ysgt5jZymqGaN6B7t9","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJekkFSCRA9TVsSAnZWagAA5MUP/jgjBq3k6oX6oqNjN3g6\nFN4sRCCwRQLrOREKDvcDSVKC8zjQEFGXnVNokqZA8SHH9ia/nK5eIRiXb2G9\n29fcpDIuUdByvNy/MJJAi/e8rP0tfXP1ViTv712pUvUdcIQWayqhB7zqG/rc\nhoiz+xK2Hr/8t8VAqX/SY3pdYDQlmDwDawK2qUtSpucARvTHXVJXkD3c4GK3\nGSYXv0X0SaIQUCL1PGjErn083izmg78/prMz/yi6OTBzoJKhmXurUn9/UG2Q\naHkPUCCe+csHSmWfp4B2CTdRve2wQ+rLTNd1ubaq7e6gI2vQhwuKLZLcUfqZ\nwIx+MdN2POs9zfPauHM0UoCbmJ05UWgwbdbe9tTh4keAdCzhTioTk7Q/Gvap\nsJ8YXDbGjLHhaS4NmeP6DUIHSaWpz2QrCD592OfSO0pFtfh5El9xnZ+1X/MH\nobTItmt573zAA1s+X1wxug475WXmMwDdZSANitqHj0jXLkp3kJF600oP+Q39\ngGxUq4NQ/jXd63V+hK4rngy6TH0WiUxxggORMY7ZIkytycWUdaNIJku4NCHw\nHhyvnd5/vusf9l+3+wzOSaHYj2HDjxZZMAJ98fXnxWL/bl+iB4JV6FzCC9M0\nbjwSpQY1u1XqLWNWsRWk/3/GnT1ZTwD/uuOf5MFKsCEcsMttmDULzE01ybAf\nimzO\r\n=f6PC\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"23e7fd9a8f9ee8abaee52fd6572601aa40949f73","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.2-pre.1081"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.2-pre.1081_1586643281598_0.5434053462419153","host":"s3://npm-registry-packages"}},"0.11.2-pre.1094":{"name":"piral-pwa","version":"0.11.2-pre.1094","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.2-pre.1094","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"d79fdc6aad17cc7390faecc5bda27841b6c3b9d0","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.2-pre.1094.tgz","fileCount":25,"integrity":"sha512-aFyfo75/oBESLEMbaN5hoDLGSAvz908U1HRt/heENOtjOaHchFfH6ZiVIBTT34XTagF6yHNbSQAZZpdAthdccw==","signatures":[{"sig":"MEUCIF65mYhBd730qeDZaJ6aHwqWWMnX9p+KUKPAdmWuFlAwAiEApuyu/k0Jep0LyHImtbKVRzDuNuz+3qMndSZ3kyD1a2U=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJemF5HCRA9TVsSAnZWagAA/bsP/3fPOu/nHq5yWYaDSHy0\n0UFfXeN09HpjWQzmxqLK4Y3KiHe8MykcZwhw7JGUWlzk1J7LkkRmXT/MQQCn\nKqPkKrf2rgVcYkuQaIjib7Zu3aHXuHNFpazyltg8Hb9XLptoSvlsjryJCijd\neMCXfI6v7zG8MZWSwP44mVsZxifydPM76SIxXWfOW6fY4mYn8EtHidi+WiCu\nH8dX99gkgxYJt0MBm6oZDTkUKBgN6/+Kg1xmBwjHB7r7GbsdRghwiBhRwiwy\nOkqpSIVvK5yCy6/meGvggc3IqeNGViE+M4qXU9IeuD1aeEgQrVgrz6gT8Ydp\nUppCh0BUmuyzDv8KNOWSdcPXL3fYOvwVMuLqsDxJsTwmCztZtH72qJEDOh5p\nw3XHvXX+EJe5n2JmnWozE86k0zWl1uG3GvZJi6bhyj77bG1Cg+uHaYMh+4pT\nv8xiwqE0w9Ib6iFI5Pj7IgIV7tTb//VPYiZsHXVZdhArmTF0z+kRdnD4P+xf\nYl7SNCc5darumAz7hueKuYizoaaKDOGig3snrgN2VrRHTTXPtdrvGWbNIe7t\nqPpo9OMm/8agNQnaY87Upo+2qf1ZiCN6MXZD6pMbBozJ1RshtZsbIu1H4o77\nGfXoqMmtdhEbTTRpQ3UgoWSfRCuNXJbawRVZzjZd/e5q61psLRWqz3ekWmQQ\nFA7B\r\n=e//H\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"0a1d1ab093ee653fb6ab59bf518c7c977a1eec0e","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.2-pre.1094"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.2-pre.1094_1587043910519_0.18304017535353312","host":"s3://npm-registry-packages"}},"0.11.2-pre.1095":{"name":"piral-pwa","version":"0.11.2-pre.1095","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.2-pre.1095","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"970b7039ae6e536b9bd5705b043fa96ce95c3810","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.2-pre.1095.tgz","fileCount":25,"integrity":"sha512-In94pS/cCifUtgw9/8n2qLBMM0X1S/iTQJBoigQaGsbEfZ39D++ElivG2mb11Krp+9ww/Q872WRKG8jD4Ri6eA==","signatures":[{"sig":"MEYCIQD6R7OT2iYeuVP+W3sNAtdu8wGU4BkwiG59B459M9GzFAIhAMet/pXPKEpPQ+I21UCAQTvxNeseaX+ZIRuz1M8wiVWB","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJem49uCRA9TVsSAnZWagAAn0wP/0gM3wlEXlWlhf0jt6jj\nc+JRlITyGqjlc/s1KRdIM/+oU1Xxp0TdMSCpqJsJNFNZl+veJiPbaCgiEJN7\nMk0pUmq/u7+45HYmgXbQRQQsEZcubij+xrU84w8oLGusNPZk8g6NxTkH9fFg\nXgDZAXI5g1dXLKkMrbs8q1MLwwSS9WmZ73Km4uu4le1AFI7eftrRxjF9MHbW\n/YnCy8K//M5W7o5ui0Bd0B8ihk9UPbcr6fB0Liki8MecR+b/Cu0RFLs6mXb6\nTidbck5npLJJhb2jrmabkUHfACm+XjClqiOSRs0p3IXZlnBWzVDsutKalXL2\nhbgsJWUF3jrsYuY4KiHxle0EhlERnQ1frnoFP62bh8xWSCI8dLUEzF+Kxvy6\nOwkLTNkyf68cyTm56Lm4ohMkh5QK9haCB5joOaCHOV5hSvxP8FpvE73T6wy7\n60z91fkCdtGtAN/n4fU/pFvPADQJvSYaaadU4Dh1GKqyMk/Ry6WfXcWdh7kg\nn6abl7rviC47puBTslDOmo2iFg96sdGYXS0Sdc6CHV4gCd1K3tzC5ADxh6jj\nJXrKD6TOKNqDuquifeg+//iTCKK46AeK0xFKkW5nsrA+x6I5gGMbjQ8Zu5hs\nccZ1Syi1XRwDSJ9pppOtmBnI7a4h5L75aqMqrXZ+rPt1L+DcHvexK6/np2Zj\n1Tsx\r\n=+tiD\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"4dce013bafc1d17b04fb01b04f5fc4785ee22b15","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.2-pre.1095"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.2-pre.1095_1587253102439_0.7045846353623406","host":"s3://npm-registry-packages"}},"0.11.2":{"name":"piral-pwa","version":"0.11.2","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.2","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"8304297b8bedbf74db26a2cf1ffefdae16fec1fd","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.2.tgz","fileCount":25,"integrity":"sha512-0rGUUl6ferimDvRxcvqTcKy0pDiMWttiOE3A6gE2/AymqChGByAKtcqVSK7fPOYV4PO6bWkOg/1Ih/agbhST6g==","signatures":[{"sig":"MEUCICLXLYCgjavxAue+mzi7U385a20axIaAty/ArWAiwB/eAiEAuWlLJpiqxAyRpIytX+izBgFK5GbKq4GTvDPtDbHvhPg=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48957,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJenAgOCRA9TVsSAnZWagAAV/8QAIc/Vw286f1kc6ghP7S6\ngjAgF9sIihNxJ5vw8rTetCz2/VWyb0Qtt324MUUiu/v89jYT9Dep9yl9utk4\nZTTNueF6L03LooPWkrIEzVrJZ5rFeN0TtL9Z7AMwiiq6Swpyb3Mcl/kEchgn\np58A4DbhBUuI26N3sKrQG0a3JR+LoBMZbGZU9EO++df+Fh2XPl3EcXKb4ri8\ncvwyU5XVu3gxGYVJSOllhPfwPmXfRKEN5ID8vWUbOZKHKSGhJuWQ41Wr6Qy6\n6rMXPLXxB17oVyJ9tEUiApThM3ff+pitUUBKBUQUNToRt8nGNg2SbmmaE+Kc\nLsKAHOwY+oxmWRYkieGMuR6gfzscDGRb0RzB9TXMzEaTCK1cxtD70Z+N3RUV\nwmYnT8+I6whVhKRZnzVpByU/TugvCd8MHL/SX5g/JdGkeuWbMOGImIwKp8Ut\n3mdLGXoYoJDC+xy0E7mh569pdmhfd5gcqtw8+2OHBfW0wu4wNb/zJ0REFJW2\njS3tE0UQW6pCTLY0SSBDw2In0T1cS+Q5nApSlB1ScJ5bGeZogY7EP22RpvOi\nunDOy4oBPbCuE3ZuIhouRpCadCZ3f7PSZlQRqT9ED2XOe3K1t9tyV6sKta0X\nzSTggVgpnxH1JO7vwi/nvjR/aHa5wWWIhJSWLwXU7vTh567NbJ+TGAGGhSkb\nrNk4\r\n=OQcm\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"4b61732a1458cce64ca91393e8580dcf3742c0c6","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.11.2"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.2_1587283981634_0.5433362637068708","host":"s3://npm-registry-packages"}},"0.11.3-pre.1099":{"name":"piral-pwa","version":"0.11.3-pre.1099","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.3-pre.1099","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"06d39a84e3527791a64b37825a9507c163468ac8","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.3-pre.1099.tgz","fileCount":25,"integrity":"sha512-XGtg25Foo+vJnUkxOZFM0SDCj9EUNUGmK28LEND0xvGRm+s0jhzhiBiYz0RcWm9BDZ5Y90hEn6cMc4IqMNpX7Q==","signatures":[{"sig":"MEUCIQCatd5HAg9fLH/jwcs3qCMxR5AxJKnRCUW84P4HNQNwngIgGjEJuoTfbZ5sLPZRnv3YNUd0LKkd/6HNmu5PtrJU3CQ=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJenimjCRA9TVsSAnZWagAAgX0P/Rje1Km5PgRdH3iLYJrW\nVSagMRRAuZeowtNySpZW5umtb1wrHMWjKy1+wFuOeL13Ul+g8XD+sOcd7Wze\nar/d1FG/jD6Scojiig5JS+gGfauy7sAEOdv+fMrDRep5lyP4fjhhN+Y1zLv1\nKhQtYmzC66uUzFGiElrvSqJnQhss8VuYtbaHJJ1Y51dwq/V1Dz3sik741jJE\nWN3tWVrM+GBacXadEAY/00uz868/ZIQf6JxhmGngqbcKlwXxdXH+D9drQsGV\n5IRdlizlH2C7ApFShhfmkQ0EK3Gdb68RNr862bVgUV1u1HHOnIER8DIxq9cc\ns5Tw7dngwpQVYGEDDg/xPNgm0TQkLedKya784HsWr/qkTGgV9GuSeDSyIZEj\nPJUvTf0sdLKUFlCaLTzB0dkMmHNfddhqpZRNGsZ0EhgGXBxWbZ28IJslmzxO\nPHSaq903PUzkSLZRxonq6u3hRLcd6KKFwG+v1AAuIlpLtqaoOITyBMekq/xr\npKdGnsSoVJ7hXDC3N3roWO78Mx3Th13jzuF2i77atVtBWG9EQnxWVwLICy1C\nf7AlalxLVI/GFkOlzAptt12QHvMr7h9Q8YRoO1Yt5H1sbw+a3jfojaRTUZwY\nU2T2o6tDQA+EE/sw8bzh/kdjxCijseXaEdzzzVbZ/r0+3LJ+bgv0UmodTTC5\nx2h1\r\n=XyNH\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"54104122704bcb62118f7c7dedb0bcd4ad0e3798","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.3-pre.1099"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.3-pre.1099_1587423650931_0.03827712885917123","host":"s3://npm-registry-packages"}},"0.11.3-pre.1117":{"name":"piral-pwa","version":"0.11.3-pre.1117","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.3-pre.1117","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"030ca345feec90b353abb3f54b941912ad529c5e","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.3-pre.1117.tgz","fileCount":25,"integrity":"sha512-WwTzVTvbQUzkMb/AqE22dthu1SKpYidcyStubHzZ0ChtI4JndfnMRVQWAQoj+epbtYRQiZg0RiXjFJ7nETqvqQ==","signatures":[{"sig":"MEUCIQCRrw9lPprIeY+i4+84RKBGY67LxyKi6KlHyjsLhKUVnAIgTK1IyfeVc3PLoC5nNUxOWwJ9ykLwNDiCZLDNEbm49Ww=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeoBWhCRA9TVsSAnZWagAABLEP/2pvm9cExul2eDikhSTV\nFz3h9OKKGOr3zp5qcbkI5JwbjttUritG+CXAUSArnAYTkqBlqOhmdgxWWsij\n1ofgzu7tK+8cfYc3QMrlM3UqaYxZeSXGz1UVEmKRlYPz10Q3/B2LQVHa1tfZ\ncGyCdHloePs9W2ThJ0/Jy9ahUooIQf/0nCSHXRlzZ1OaCv5VfzqPThD//OMa\nk8LqJuawPiPxUiL3zLvVhCsGcBQyb+SLC47d3FPbGJFvqioKhyDref0JpjMR\ng4JMGQYkZffSEbq1UZJly94eN2700dNt2Q2QwFPIhsDNNZ+mf2uTfBj0wVx6\nAgpEWQbVrXemxdWRj+wgCZ+3EPZUJFaTdkmSQg6tNYFEFGCCQpHAwHxnhh21\narjrUIQRk/0qvnS8H5FHoUWeAG65/0awiWQFuxXm+Dg50CsAhAJ8+NoZmzTQ\nUPIbDU7TF2svJiLu1RUsba1pnChuH9Pm5QblOWfwaTM9RuHfVPPa//VPm3lQ\nnwec6XjgeuvggEFpKN8RfEPbLXiodQ26IkBQ7BpQ15BkE45P5nzqk82lO+NX\n33JTdRhBkatiq2hkSwT9nvbuPnj0NGCIXHEN8vNPnqQO0HRFKGVMLMH4GuzJ\n/Dz+OXSwk94ytQOQFdPti5LZ2dgv7BpW0C1v7mA3Zq7Lb7k8DxeUBxKdZLm0\nbw3L\r\n=efie\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"b5a72285ad07aaa9716bd00a3f09cdf50ac7ee4e","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.3-pre.1117"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.3-pre.1117_1587549600776_0.37753381109128337","host":"s3://npm-registry-packages"}},"0.11.3-pre.1120":{"name":"piral-pwa","version":"0.11.3-pre.1120","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.3-pre.1120","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"22f9de8fa0e1d5ea13c61eccad47b119d9a24cc9","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.3-pre.1120.tgz","fileCount":25,"integrity":"sha512-+aMmAhRE6g0waPWjzfyaJl8BhqEJ3o5KG7NXk12vbApLS6nCFLUMOWpxz7ytZryo0bdvyJZa+uEn5EpBMU9Ong==","signatures":[{"sig":"MEUCIQDThiSkGMf5X3/Hj3aBTeFlnQy1AO5XO1ORuniJnpfUbgIgJcJMR09Lsz8+cg39coJT6xwftIN+fEC3dB9Kx6/PINc=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeoiZuCRA9TVsSAnZWagAApksP/3u4A8wU2BEGdMRuxtkP\nTDMnEuVB8VTVm+y6fTSxqVnhCff6//vFsCrxW9UyoHcTvdC8e8ygYhQQVytf\nmOoIA+nYflrl4gl0t8pvuRK566R+XuZHkX+LkCgS8mhOj5t7BDJd9mJQELg2\nEKaf01Jb+C/MqGaL7veegJB51+xk92E4ylUfSbncEVgf1DL6pLPe3dTMYRm8\niVG8If1h8RHReqrJELdvsA2YyLMiUZzCv41GqYVLnqg4subMjKFeji3lU0OY\n3G4osdzs6DeRpfnmljjwRfy6w/lQPHuUSt1vLrKjeSqhYDSkIKWHhWHoiGDR\nR3kimJKC0thfGeyIjaOC+ubNrSxN3fzsLUaJaIB4qVJvKoJlKLo+EklOjFDx\nISIbLiFqn8jTd0dPObmDWd8kP63pd1a3GhgXXWR2dCKYXDIzaRFyhZJKPqSo\naWKkhBXZ8WotJ3LXjVgu2rZUi0TDTD/pI8dteM0cGQMwEfsVDwamUpb8rGqf\nV8Eg1ukZElQQ/SuwCfOJ1lhWI4SaSbRiAK/p5/74rpRjklypGtXL0hUikZ48\naDa6K4H2GYa+twaKQlpWn2IIrO45d0aBq4T3NaLS41JY8jR8jAxTiEp/kSuW\neUwQRfp0qzuBe2Br3HrLDADgvbqRhhkcIViGt/fonPQnyNFrjnU6llPbdTKX\nAx6c\r\n=7+tD\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"372cfcab109f1329fc446082d0b0f48e2d00f6eb","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.3-pre.1120"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.3-pre.1120_1587684974509_0.516882769333967","host":"s3://npm-registry-packages"}},"0.11.3":{"name":"piral-pwa","version":"0.11.3","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.3","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"3b1af10361fa6b1e6588664388aef35a29ddb2a5","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.3.tgz","fileCount":25,"integrity":"sha512-W47RdaveZrcdmEbh5y3dlmuWhpmxY/hmt0h9yYOdi29K1VQiJtyAPj9ZNp2ctNc1j3BDDXWJ6SsfMAMnS2Jd2A==","signatures":[{"sig":"MEQCIFCHJ0dLyOSlY3R+kEnCk1nR2K3R9R9aYELyTiy45vjCAiANIiQESKeWV1wo3QVY+/W70UZvUpp+LMbtOBp+0ijKNQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48957,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeoqQ5CRA9TVsSAnZWagAAvioP/28eqiVeq/glLyQ9QpNo\nGWaY7fz6ulVzy1reKcJNQ9fq3J5qeGTJ/oxX8k7gGyY+EuhPe9m5xwVBhHKv\nzYBwwITSRyxTzrcKoql5ftCsrVVY1FoHO/L/gRtw5m9eYfXoL2zlAGq0Eu2/\n5U5VTHiuKkEOB+y2q3ZwG4L24TawoglZ61LjRdhXlyrP0zdDkBkmLUkT2kp7\nq431Ao7qSZiGg+pWuRIjlez4wKPzLnY4ALDycow4BOsM5ktOIYEc77uesnhP\nbuNs4I+6vlqS+fn8vHM+Z4PJuT3scjqKTX+Xt3PzT1Ir3ViZg8bPwv/ea8v0\nPZHSg3GYz19/CUo8AaAJY90HjMJwjKp9YPJOI0xyYobAZm47CkLlBSDedVye\n8t9Zf77ioV5YhCqQb7tTFYQ/yya+6unqnmnzlsybPyFYTInhopxuozyzuor8\nZ9DToON8Tn5wBiy+poEkioCbF2Zd+2RbgCaSrOw+d7/SmrPjEu13qkKa/qWF\n0Y/jGNwrQaUyubsQNjDFjxo1FhA+42OudYpTLfO6oDyncpMlZ9SP6+3aAtoO\nNHgTUv0BSgovU6h/MLg88h3YgAxui0yZUCp7Bhe3UUFK/pXj5x+ihh4U/SCR\nFYzC8NkTZp56wd8fL+d6Jgbe0h3p+j905/dIEu9wqjpkCTnV5hhXXVET6v1v\nzJgJ\r\n=lqhB\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"b41a33758bc4e30f57183b3e6033167b2820d3b7","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.11.3"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.3_1587717177563_0.5977431171975416","host":"s3://npm-registry-packages"}},"0.11.4-pre.1124":{"name":"piral-pwa","version":"0.11.4-pre.1124","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.4-pre.1124","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"928d2376c1f5f2d14c79ec80f1474a2504b5210f","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.4-pre.1124.tgz","fileCount":25,"integrity":"sha512-fSasdGvrsJAFQ7SkkNlKgMXMvX3WAY97zKsUI3N2C4uEw1BchIKG0jQm+zooZWd4vsEjb17PEv0KnS4SQu29ag==","signatures":[{"sig":"MEUCIQCcMgAG0xxqArdD4v/XJMSumnIHP6qvo7X4gl6raE//4AIgYjt0tlj8JEJSoNfZmNqjxdv7+pRxYZ3BMSkfau41d/Q=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeo2i3CRA9TVsSAnZWagAAS7EQAIEc8yxqltHKSX7yvdPJ\n711IcUHKrpNmYWi+won+HY4CEngS3ph2EhHeKOTuDnPdiFHgSUjSi90Npm+d\n0BNDaN9zYp0489JXeb46lH1tbo0k/9ciTzzuIMX9rx1qrCX3WeBWN9FFt4FV\nh0XMxPvDUYgX7ZamZ3h1WvcrWGS021TP6PD9vCXsbvkBVt1LiitwV+iCppqO\nkBGsIn74P0J6tS2g+cQBUNZb5qEa+/SK5dpqLqVRnA8T6ROwWm9tuF1qh/yT\n78IOJ7lWOg9j+NKU888wN6dq6Fz6ESjAx1B9vDnGuyXbj5kouFCuUGCJIJWD\nkSOCa6d2f1RLwGyTCa3tMM95fnMbkV3h9nUn3ODoLfDM4J2BQxS71n93iS1b\n3NXTSZR3keB9R0D832jkq2C29fDZ8NPoJEo06RoAAdRrR8PwDjW1k16bfHEW\niMn1R9g4dfLK7UWLZ28Pk7BKxRAWgusN0qQtqS3jIJmJN1Dhrx0x1Cu0i9KW\n1ezz2hdfESs8SxmqN86/dARUVcbRJMgJYx5jOm6MQO8dzuGRDK0vJl0B3D/P\nrYkpRqn+kqDck+5xV7ptGyXnErraZY1NWUBMVpaXaFE4r53w7LwMtNIGjvLT\ng2PypHag/HXYMnwW98PWdqA76wjh56vc+NdNWEYiPdZ8KtZEXJUeEGXW4x+q\nRDpJ\r\n=Sw61\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"3015549938d3a7d3efbb8bb79af928e8a103fc05","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.4-pre.1124"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.4-pre.1124_1587767479541_0.09576745171321233","host":"s3://npm-registry-packages"}},"0.11.4-pre.1127":{"name":"piral-pwa","version":"0.11.4-pre.1127","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.4-pre.1127","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"9279bbc9dc0241a4339168e9cb8d208ad6eef347","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.4-pre.1127.tgz","fileCount":25,"integrity":"sha512-XQURUVFCl2FlzzFXYCVebuzLcPqEEQOJtmxWK5wmVLcMmK2ipq9UjqKflR07lKcMw6weKe/YQEbelTTwqnalDw==","signatures":[{"sig":"MEQCIDur6u7/JCAxawQfH92HBgrsa5urmV9jR4o3lYmx9cDdAiB1HpDiOgavnvFu//ECYKr4FZtBEbzxg+jhRVTQHHNO5g==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeqQaqCRA9TVsSAnZWagAAo1YP+QB78DOSTnuLQCp0LRAb\nCQHooLr5OHJSFm7JwpXTAui5UlbAQGLYD5GBvYbxoesP1+1vO/ZDSxMf5cOy\nC4x+eE9oIMYoU4KZtUNFtdxyItWZlxzgB4C0nQKpTLFc2084Br779rnwMjTz\nehuGRmr5Otk/O9QubcoIwg0aiXxAYhkuXW3DMQjUtEUJ+qxEVCqJmuRJEUkE\nZT1L7UqVgHnW98W3uBirVgylTXRAOe6e17ZFNu0r5JqcYr5i8R/E9IXLvFk6\nliwlmK+rWgUDfhXQJginieKVzSvq3Sk2q7x9KxFw2IvQP0kJgAg57gPgRGRH\nvvRyIeffC+/T/DqngfdlIu9lQEgD90ax83aTyqJLtANZJ/J1R/mbwkTaJPt3\nQMdAaXu7/Y+/A2utQYNtzk3PhMTuFhQo9h8H0T24uH+Ik/DoVnsEwV4WJjht\nf38JZx4U0rjOB2DE8ZIozmh2RRMV6rGYSAD9Zn7GCau8dzeN609gzraqs9Wg\neJVWZV2Z44bHsxvOxJLe/Tk0jZbVfH8iMsjJao2/4B7hYXugUs8L3yq+F7js\ndH8DZTSteAkd1qXg9TMi2HPh7r+xCeh8QB2qhfXH4M3A0OGxLJZmS2MCDToY\naDLmMAePAaVYNBUsNfsjPfiT4ZJrS5rxOLL2DiZTHIPSYbavX8LlHsFuPv+a\nJUBO\r\n=PpKQ\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"7691dca9a0cb411bc472ffdabb09f3847cc8f9d4","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.4-pre.1127"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.4-pre.1127_1588135593790_0.6214199992479528","host":"s3://npm-registry-packages"}},"0.11.4-pre.1128":{"name":"piral-pwa","version":"0.11.4-pre.1128","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.4-pre.1128","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"1f2c509d94ca2c506794aeb7eb5c7e1f927fa56f","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.4-pre.1128.tgz","fileCount":25,"integrity":"sha512-LJhe/RvJaFknWIbgSqvxSmy+QznJ0QjPS0kmIeHUm+GlKWCWFCrWRN0n5AlyA+tFpvOkaoBgjPFMcMyV49UXTQ==","signatures":[{"sig":"MEQCIFG5ZR766LZJge/BfvfzHZqF3DU8+eMU42pY1XK7pOcUAiB2LaYXvF4IJRNyBVV2bgPatUQVCG80xLRSR2P4nlBeBw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeqXTwCRA9TVsSAnZWagAAI9oP/RWqw2YJP9RmQFTCYi57\nz6GUksdNgNU2dJ3LC3jNcqd6E4GTOhOHVxMCTvkDgXfxBKmHFHoqaWaK0VqF\nbsawXR0ZsnbokYPlAic+pIpYGwfHuxksGVa98USV1unkU9j8NFXf9V6FyQUB\n8kcNuGNRtdWhyRzN3xwvGZKPjTHDjKuNhI73NLAbhljwjyOsPgi2d7DncDOm\nK84Yw4Fy5H/h6TJMNKBQtQhOp4rlx4hj4SdL4J60c/kCZ3FM4gCXWX0w7Ryq\nvWyHbsprYVQvBNprjh+35TPeJUZp8T6kLA8a5NA1Sa05Py3i3G3rP+9vRFO/\n/E7/VwIrbICG+PQoamQb+o1wlCGFx/NCBClblKWozyCYYZT2NalgiHGGGCeY\nhvoEqgg3Dv2NSVuMCalZcHj60Wbr00kdTf8xAT9Xk07GW9+azsraFBw32xX3\nUHrtYyS1/uhxRDOexzG9b1y6Id9LEiFvoOPIH6HQpI5dGj7AWnPVrrd0Oeo9\nmd6P1MzkXMP7lLqLegnnn9NnCWQV6RzF9w8Rl+nwGjPGd2moGp7oG0hXKYFJ\nTegMrrfvF9yiG/rHUZ0+JNJt2PUfi0M1kLeBlsdN6o5oW2997rkZAOutdcT9\nSWVdIULVlOnuzICMuytPG8zGrJy2VONRoxSc/Il5zGhZOd4s5GD+wHswdfhZ\nhpzT\r\n=o8L7\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"b704197e9f35e84d59a82b089f4f1839044f2c18","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.4-pre.1128"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.4-pre.1128_1588163823771_0.3999573477952736","host":"s3://npm-registry-packages"}},"0.11.4-pre.1130":{"name":"piral-pwa","version":"0.11.4-pre.1130","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.4-pre.1130","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"8d9208adfb6f4d344e094bb4ae0f8fa091cc6130","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.4-pre.1130.tgz","fileCount":25,"integrity":"sha512-J0nWwXonfndMsx5IO3TotO2EeCmN84zFbdjCbv+1PRL4H8zVq2kkubxZ+/lXOzXmadHKEzoC9kfrTvRsG19V8g==","signatures":[{"sig":"MEYCIQCz/ddWrLYR3Rj0ZQg/CuATHyoFljxAzq1KGhfIJAKSOgIhANgbz0H05xe3wVNoqZCvRkosN8q5IxpAh7jBf+pb8vMP","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeqtI5CRA9TVsSAnZWagAAXQkP/jLQ3HI9HcldwPphrDa9\nGBTzlBZaT+IAzX70kOsDzwQgBZbGiuVb6cfAYOMrybaNrAa+ADvQOxByirV0\ng/sQ7tVpkm5nR+Qu/1aN4r+IaTIkQr4Yb2DW0YWCHv3tswXRhoacOEPOyCUI\nD4ffVazTgDRScGy6VPJcCAXB4ndLdckj45w2Zc0olIm7dv8wjGEMC+uuXJms\njYGhxiKLm2ZA4uyPf/byEaDrxx31eLx10oXaponpqEhVoWIjh4fcZPCLDqT4\nT2xn8NbBQrnzwC6afQOy1byacuItfpBBafwLME8eVyQX4lhsWgKn/IOEq0LF\n0U0wV9aRxNycHc5HHPVBWpMqBTpXAlsYeJHjTles5nhzKZvwDs3xmHSa5yWc\nz/Lqdg+zVJ5ctFrlnb3ORqI5e/F9VKCEkAdFpNSiIpY2DYy2Ekrp7CUFNdgx\n9n7CLuH3eo8Vyx16CX2bXh8xFrhuMq+rdOYZJHcIUvelxl89tunneENiFEtj\nYa98jcMiLp15YD3eRJVpSzQlT9d6NeOYNKg16uPfDCXrG7SMCS2pxb1UO+A4\nfuQ0oZKZtUk7Bm1caCTx+SaBAxTtKXS+w+/KBctoTZtmQchX5A75UbpblQBY\nkr36eoTTM+Yq2e4STNRth/oBrdPyjJ1haSTBDi+cTxOEQDl3Tm6Rjuy35izM\nK93Y\r\n=knfj\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"f827b542687062d5f69ac0d035b3c0e1d48f83c3","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.4-pre.1130"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.4-pre.1130_1588253241301_0.4159741110569457","host":"s3://npm-registry-packages"}},"0.11.4-pre.1131":{"name":"piral-pwa","version":"0.11.4-pre.1131","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.4-pre.1131","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"69c63f5098ccf712aa61799bd2a1dc6ea739c010","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.4-pre.1131.tgz","fileCount":25,"integrity":"sha512-KF+MFwhla25ukuOTPCArIpQSFzeZ8bHwwV5thFjPs2LuQ4JMZNhoeSUkwhQiZ2t/vA0XwzOm79V5XGcrOaLYQg==","signatures":[{"sig":"MEUCIQDvS29cOzKmrgm2rPekOf/LNTvx5A7IxyhZ+y+oE0/GDwIgJHfMzjBxG5XmSy1gK/oepwWWVuIsqroETqM8DKGpPmQ=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeqt8ECRA9TVsSAnZWagAAncUP/09GVGPFocyq+UEwnxxJ\ngPHAlMBwuZ7oXHAYISApyUH/rc4ZMT+XJZtUQvOChev+/47JnVXHH3SJ+dgA\nRJzYsZj5m7P17QC5+FYH8SUcfnvJb3wHh6ntOqniUjcL7fy4w9Z/n3pYbx/K\nju4zPWdAsZ2itY4K4nbJfPhPhfTuxOJJ+/RS3IpIcFXSfZlctLEnGwxsaFvM\nKOtZMGDtZgrUBMA30mxcoh+1b0RTaytEBBHSOkA8UNhbXRIgm5Gk9gG+WN9G\nhIke+8FEcycTybp0LwuJfhFGTTtJ9ndrtpfvydr/tLdjleY0ky//zYRbgyxO\nJyMYTddi/8v1HrB02Pa26CH71D2m9fEKhfd01IuTEgRzCbtUKdR+z2dkZFm6\neN6VG744YzahGNTcNdLFqvycZUSeEhPmvJgiJ+V7GXirtGodVcuRTNmHv6Hg\nDVqpFvhxc9qVEaDVDeYPe3CRfIvJujFMpUidhF6s/nHqTXWKHR/U/fDQeuh7\nV80biO+fC+oh68K8oPekZaNx9mRO0LQIietJy1256z2oILTa3OdPQDt+JEcM\no2sKcpIV0jyafv5hK2hYlj73/ZrekEdOfof02xMXFpHZvKememGCRV415TyK\nVa5kNaMC2SDfkBB8iP4nHHjXdhFNgVUfjE4pHYMQwOt7kO6jbAMVEoCuXDvv\nrFi3\r\n=FOKY\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"dc3c156f8fcf7aeb3be43787bffce84aacd6a3a4","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.4-pre.1131"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.4-pre.1131_1588256516195_0.46575013509898033","host":"s3://npm-registry-packages"}},"0.11.4-pre.1133":{"name":"piral-pwa","version":"0.11.4-pre.1133","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.4-pre.1133","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"125671932e126c2c73b7d9330e683e2cd8a06345","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.4-pre.1133.tgz","fileCount":25,"integrity":"sha512-vOIy7pf43Xd4dHXRYzj+N5Aw9j4ij2iWd9A2ZNg7V9pOsdgJm/jmgcFzBhx6GeCrDf+ciglHDso2qgJXeG02Cg==","signatures":[{"sig":"MEYCIQC+OFDObeiv7nUdiIsZD28z4eGa2MgzYz+fS5Es1htDzwIhAMpyLFho1YX5qHGmo3t5Fbzm8WvSD4tFx5WJ3uSR6srJ","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJere2UCRA9TVsSAnZWagAAnDgQAJ+9ilxkgsVG+49q9v7g\nz6C2TyOBB6gPI3uDyXVUAkANHigEEKLA/xh+ya3RSouCbkQv0jXwFk1iaaUc\ngi/a/oPu2bbmEDgeBtGLKqotplpYMaMxG87lmEyzwjzl6grSTk7QI3wc6327\nsF/lOMrP7uc42h4kzAaEdth3abSUFqpec8Nb35O3FHIHAV+2TbodIfMHA904\nJVBVb69h1u4WTAVpRuagAPR8qz4zGe5PqHVey59OoAmkmE7O/eMahCGNYkeb\nJBmaKfds8eirtO46hqx5NlNGKxAHDZn74D52oY4UtovDDSpfPoNiFIHlK30o\n6new7X7jBKpMTHzsnVbsp8PlnVHhnn4kbJmB8u2+1wqMVT4dpp7ryUXnaJPI\nrPV6ec8MuIUYOJRzNFNlpgRN1dZtGLyt1wzB6YB4hyf4aoDpNJmJbM72Ua7G\nEXM6gdMgzSnhXg7khULhEPYkECC2CJV9x3k4D0EOv+XjPdVk5UfWUm+sfUcb\nz0NDYY4wm3Vh5UoF/CssQeT+mzZ6RU5WEAgojd9kWZghCUv/iI3d/emV1/S+\nbNylTVV5QLqp7zLNf6gg5Uz0FpjJJKIz/HvRwpxtR+HdDGC7IM0V8HHwnuKN\nbdd3llwI2+5znPAruqPcH+UbpSfF0Y3VB3WAkSrSr6rB2selRDkXPtYIhcl3\nqe/t\r\n=bB63\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"355d3fc1899b9d3562e202f679095eef53023026","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.4-pre.1133"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.4-pre.1133_1588456851839_0.6180725083252991","host":"s3://npm-registry-packages"}},"0.11.4-pre.1134":{"name":"piral-pwa","version":"0.11.4-pre.1134","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.4-pre.1134","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"4aa83a66b8715533687c1c7529c233aab2e2e673","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.4-pre.1134.tgz","fileCount":25,"integrity":"sha512-6aFoFwS4hree2f+1k88w5b2ujgJZfPP1erW/oWGIcww4pxXeBuJ1W/SS/EM4MDeQ3e4Wkyqt21gDVdEVnID4+g==","signatures":[{"sig":"MEQCIATyLrt8/yz6GltOwJDq3LV7Q5IE7AYGCATkfmhJlbCNAiBkrV2mE65loE1eBDE0WCpXn6xw/Uj6oIC4SoWcAd2HuQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJesJFsCRA9TVsSAnZWagAAlrAP/RHcCBT0nec+K33PYoU0\nd8NAza3L9lExWat8kqeamiMCIrRuSTo/GgLNFWy9kXGuv5DSlJJLEYlKfCWE\nWuydz62nHExJBCXfG5fftKHGnI9AEzUvFYkyKL8VuB7yl0o+mCsocFhdLb/X\nvjGBrXKS9ZT6bWPTH9xzYE10wtAvvpqsSkdeJZGcOlgDJEoqR09WLpMOgiSb\nQZZkdfApMOm6/v7YI04J4eiARgDniB8j2tYrvPX5Zi3UJwIxzzG22Faeuwky\ngh/V4+Ru1yYNJB7JxnBQYxmgkfwkcUITHLnqxUPVwMsfK5XxEDc4lqwR+6SD\nVggMZHqed7pd6/4kZ2Vz2oPAiLECLkT+IaUJTkSXhv5sAFmlbmM4kZE6b3zU\nViPZeiE+N1uooIkuH+3komMFxEevWJ/9pc7wih8EyMnwJId5vfozrDykMFJ/\naJXbVKDMYivc1o2+eQFe2/+Bhkl0F5aq4ovQ+OoE17iHfs2bTAT4BOzP1o6e\n4YGrEWxs3U/wHSaUvtc/0Jpv7dD723ChjtpaqLXMheMm1k+ntw1Q6ggoXEVa\ngqGI8IL/46146SLd4THTRWjqP4m1xmMhRv52o3kvjKTOpPCBYumsMlWXzLIY\nBOQUr4quOjiFfA0gzA86uyG93iBQHfE8usCV253hB2Y6d63e2SyG1dlK4exZ\nNML9\r\n=EIlA\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"d9908d8b3e18c432243ecd832599c5a34602fff5","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.4-pre.1134"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.4-pre.1134_1588629868332_0.9233101238266095","host":"s3://npm-registry-packages"}},"0.11.4-pre.1138":{"name":"piral-pwa","version":"0.11.4-pre.1138","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.4-pre.1138","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"b45e7a7835e416a4bb920feb4b5f1ff558c90880","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.4-pre.1138.tgz","fileCount":25,"integrity":"sha512-FNmlBu0/Rp4eS7jW/hFJ0yIZoxf1IlqQeIgOvimvEcngLCV0696ar4FzGgbhEkAgh+fZpT1d0/7MOQkYcgZKIg==","signatures":[{"sig":"MEQCICpMpYCwShKvNTT3keB9iyGZSGn962X7W89cQhpfeWVKAiBD5E7xKiXvaz6Lk7M1WQaqodwJlbgQoxSv37IjKQFZSg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJesY+GCRA9TVsSAnZWagAAkHAP/i078xfo6pinCZMiPmdS\nLBanoIqmwmO0Hoa6zEKoWyT3A8NbKbGnkc5TfbCMF+quZCD3RszWLkzog2CV\n9gOk1e/eG9n/MewbdjmbGb49EntAaA73i9b0esVWyIXenkh6lylEK6XhfmME\n6f0a2t4SuDVDc7Wl3kGde0H6QyvFuebTeiTJI6dgCo3G1dL/dIrDuqvqJS8V\n4ZQglwWyNxFsZC8R2T5GtqoYvMkX4YPf5C8YCf6nxutv9sVTz3GkheB6CW/E\neKnaMKvnpExxMppPtb6QF9q+5hDr71YJGz1mzR3sWcE2zDDFEMJQGSzfnOi5\nwxDuFQwTQ0Ts8PdDA0RkSi2Suhj7g5nkPLu5+ptDc3Ff0UJI5xr96KHqhnDn\n/9mNfWTHufhlsWgitMQYS6DD/CrLteSVu2L0FhFk7lEHi6NiqzrH+AEGbLTH\nrHcNqEFn2aq9krMpSkAdRZ8VCnhUYWYN5V3NCdHLw5Clwb1UaNvhnuAMdDFc\ngqwKwOBhYneogODLPxeCDV98b2Dc9H6di7d+kGk03XU9Bg4Fin1oEcZJxI0E\nElHdMP2Dsy0isNKO8ewYw18mfQN6BYV39x8jJh5qwyA1ngiITdSz40Fqfbn4\n7XH6zytyNt8AVB+iQjmQuAXg6NevTGpy2AazQOoEsi7hqk9mu8bqLt5iteev\nYlQ/\r\n=GVKP\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"5f1285eb84470211707ce8589692d921fa3b95ed","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.4-pre.1138"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.4-pre.1138_1588694918581_0.7597862412396701","host":"s3://npm-registry-packages"}},"0.11.4-pre.1139":{"name":"piral-pwa","version":"0.11.4-pre.1139","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.4-pre.1139","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"e1ca66d6309e34476b1b3e31910bd58f4706a071","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.4-pre.1139.tgz","fileCount":25,"integrity":"sha512-WU+aaPp2cA2z7iMh0UZVm6uYy+vc44y17cU75MDh3tOxmpGjXFtNSJLeKig7MwwbzqR1Sb15j3f6DcqEF3T7hQ==","signatures":[{"sig":"MEQCIF+zRswKr6R3/TRlNUtg7BS8DHZFdJmshbPRJrZe5u/yAiArrDdf3ZIJ2DsO5kQO4GKI+whdT44JIGMGLhB7fjHZNg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJesaBSCRA9TVsSAnZWagAAtYIP/i8Sl+wFomQr3kdogrnW\nO8Hr+v3gX5rf/AVZox8fQrRD8vY0LocRQmg9yd7egJkN7yJh8B2SBeH2IL62\nF6R8Z/fV/gCavVmfPIdBlayMS73yFsLU86g4/LWN1TIhubEZ++94FQI7Vlfm\nZVTwjsmibCFSFHFLbuaPd0ZqLS/sKlQ3kR/Li+Y7EwxZQqUYTlN3jO0r7Rn2\nSAIaLuruBr1dIUxg/Y9TnXgHbK2za+wmk9iP4KP+7NI+YQ0rY03RFtshIg1C\n+rrxUL2zKyUpmPuE/f4iRNTKTCijAT15IxcJWfOa+htrTsnFtrYR0fzKE8iQ\nWL9XZ3scetHvgYEy4JrpNLlOwp6KsG6Z6D3uIlEDz9f4xoE1EORsKtWQG/Fh\ntZZyzRL2UBrdgXdWpnrVC7QgYQZoPujBds8KrA/8bLMNBrgxtyCpem1nr7N2\nfPoT19FyY3xC0OH63SdCH3oeTlXSuAYPjp23ZcU/KIoTME8Zbdpxy2zIa9tc\n2DZBdm2tXN2bOB8u45x4O7+Noi+NvjVndX/uFlwogmj85hqkLeR5O20c8twO\nqk3rg/uR0Jx/j32QwtyI9VVXwN7RWoabjKY/X23Rzfo+tZbyVH936kHW5XVW\nVJUXop76OkvwdIG0keZ+wJJMMpwZdPoLS0YJ+iUGqnsSaMlUoU7quIg8GuOT\n3X4X\r\n=kxSi\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"2dc3a2efe561ba73f170543c5af486278100778a","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.1+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.1","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.4-pre.1139"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.4-pre.1139_1588699218322_0.409596223091232","host":"s3://npm-registry-packages"}},"0.11.4-pre.1148":{"name":"piral-pwa","version":"0.11.4-pre.1148","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.4-pre.1148","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"195115495f8687ff3e605efbd2980163ce5dd21a","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.4-pre.1148.tgz","fileCount":25,"integrity":"sha512-yvp6q212Y296pp9iAJDnaextR0O8fbsrNVJQEWnCQOfsmy8qLLLLHYljIzGpeI9pSNygiohmNtWS7PLF/VqA7A==","signatures":[{"sig":"MEUCICiJ1OcFH0FeSFMMoPFb5Wnn+ZpZjy6cuFAzh0yiKLSmAiEA5H3wViK9dizisZmkL9qlUVGW/JRj2X0JvRvzpb6iB2o=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJesp/CCRA9TVsSAnZWagAAvWwP/jrbmJIFRRoLmb+aoYXX\nzim1B/6OTT6jPa0xeWwlnhfRTkcF9PB7+WTN0UMMOGxh6xzGj/9ylaRGUYtO\nBwNP/ZU/TslmYQEbDHoCEQhZDuWpHIm4443tjVpeLot1+Iexe6l5U+gOoL+b\n1yNOSU7LCWZM5TZuF7CRJJiTeFYGwltGn0Bx9RSPs+w90HyuN2hsDdLcJvWb\nVIJW5ZsqdIirgEM/ZWZJcKceYfPzpvNttgfUSdfpjb8b8RO4/5C61MvJFxSP\nBkwJSonaMZIH3UPO4Mk/PZSvkoOCjszIsDodj6XX/9BlGiHCRUF8BnLJ2Wra\n6bn4mBAvwwBHiRHaMcN/cUv4/cBp9FVqhK0L6W0IEyWEEs2RO1kGzNvuhM0+\nTYD2gFo6MUgENoaqpRrtCY0YgTisnmqRslp10+1EN/KNxiwyuLsLox25zrGm\nSj31SZumKwo7v0ZAvdbmLspjz2J1AqoclnGP48gexqZcl01ZzCtdqk5TxKOG\nwZs4xeumpga7KMAX9dplFXK3ooR1SdX1uYE4v11hnqn4dmJCPbZcfbKYlumY\nfBGN5wtQ/N5JxnAyR0lUOJtFZdJbGsKyB9FSvQrh3ceSDA/BcSEqb0/eQ3OE\n4ckBj1XtN70KToLnlSpqoQ0Zg0LFl/0Uv96nfG+XfFFVGOWLfT155YJ4aSYF\n5cMA\r\n=k2kM\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"321a77147c34a096138b46b09d8f07d71dc8c414","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.4-pre.1148"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.4-pre.1148_1588764610017_0.7702571908532327","host":"s3://npm-registry-packages"}},"0.11.4":{"name":"piral-pwa","version":"0.11.4","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.4","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"b95a3bd11254befe7f95f9d39cafc29ab1721809","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.4.tgz","fileCount":25,"integrity":"sha512-27PC/Zi/q7zaKZqpwVfNzYsvKzmfiZIRwYGMi7qkfDTAW6XARrXOEHD2u4M7RGFRxDJRy621ELbj98Ky17x9mQ==","signatures":[{"sig":"MEUCIFo/4CA2xzJAM8nV1QpG/mhxPTyS780optWB+mRO6GrbAiEAkl+Whk90nWAhsg4JO/yXmhHE168CGll2hhjh0RIp5SY=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48957,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJesredCRA9TVsSAnZWagAATsEP/iiwyRrNjVSZkIG/x5LM\nO6GBTGzWdaKaqXmJrCt3c/RFvtjKja+ylhyOcgIECWwTesl/rsRXcHJgoNfv\nHiScNU9IF7VDzw/ad7gEMKo538dyxzpDYYXRrSYV+cz/zxUGKTPWfiCS6Wn3\nQONPed73vQ3O3lcUMuA28pr5mSQnTSAbnnxsaf4/Kg0G6O/nWDJFwjUWnqfl\nDk6ORli3ATLoe7lpr55kidTOTU6ecNHmPAxwAKcjwhPqhN7N8c24FmbcvGsg\nYFQpDtc8lVeU4aj/ClmsGGpv4Ne926nP9HyJLWim4z0xMDJA+X7goMVx3f7S\n/CDGMMps6QOrbPf70Jw6rpu5zWJ0xxBUj1ZrwZkrlP6OLhvwV1vjpG4PQngp\ncHi+urGCQ2yKiEvA/V+aVdYzPJ4KPtOawkMjlOsGV/pDC1MOr35dkXJ6GRdG\nMheKQtt23SilYnRjcWvUWZsNjgog9y+HCMvDdBP4OjATXdo9Q6mUYPmddDEB\nszfETX00Wt2ZcDeiAZCC62mW3WaKdVXPWOLL4OGlw5JAMvIEwl/EHOPoHMZ9\nGyfM5szy0BIjiCBfaFINf/RV8e+wpU+rMrr8u5D26oVyaBnjYXmH1IsJ/mWa\nf088zlYEUJXPKlPb+KtkY+hO9bqdTLt6j8hELnD1o8GoZ1D6UJHj3CyH+v/a\nUJHq\r\n=6IIH\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"f523ec865d0e49fc98375dc223aa893bf30210c4","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.11.4"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.4_1588770716752_0.32704826801918063","host":"s3://npm-registry-packages"}},"0.11.5-pre.1155":{"name":"piral-pwa","version":"0.11.5-pre.1155","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.5-pre.1155","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"1ba3267b95aea0f6d648b6805ddc3783fbbdf76d","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.5-pre.1155.tgz","fileCount":25,"integrity":"sha512-njWqNyKkbuA9ljbTVTXNUwVnpc3VBTpsKvxoisTeasJ4fYRG129IRmKVapoO1tm3GQoIio1fxfLgku2wllJSNw==","signatures":[{"sig":"MEYCIQDBJS6+x/j9VRAsf5IGaeXI2fzJn7kGuAKV54/+jRS9eAIhAIdl8PkcEbJF86eQVKn8fhrKNUC6jwhfpfZizMvJWvvK","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJes9q0CRA9TVsSAnZWagAAqykP/12k4hu+7N6pDqJ9gOr1\nGuUTRJL//ziI//bPgCkC0xfl8YX5dKFtA/qG0WOHjVHNFEm1hampH2CwiOdm\noTSux8WPYPyApci8SAxb4KgihdL4BL3tFfYZFdOOnVsTXM/iUlr8wxnTFORz\nlvD2IkdDyqHSlYluXWtKJheKv7O15Nqu0Hr5SaGUUQV2EHoocWJd8CU5Mu5f\nMjrPawztuoWsdWm2Gl2lj4AwxW30GxaowV7ZP4Iw4ZUspJ3X8nDQy2QYTR57\nfxc/pk5QGLShpQcAMbUQ/gVw1DyW2XhX4c34m+6EIt9Aapi0/Sqd90yAa/GR\nMWHG7aOmEtpuV4pyqQp4acMEXL64OSlKNzEG+GP52sAEJRPRiHRJNTJVaJV1\nlvzLRXYAWrHMflCeqnxxL+xtJrsh00ldKdmSF+g+wgeJiyZqiCqQ0mWx1OG8\nHasvLvJNNJ88fP7Zanogfwh0Rnxps5TNz1QDRNEnh5iyN6QGJA/0wZI7/8WJ\n+ceazfu+/8RVTvRVp0v9AeKtI2F7saOzPhWka+a8age+4f31hexHBoqMzJSy\nvTiG+NucJVNNONfWmmdyv10+sSdujIs96jR/njmJxDfiWQh8QLe/Vk/iD3eq\nZuhhi+OZojaisD3CGxl7pRkrCgXQE0H2YGlVoLuNIjGwqT7453C7oaC7p5CY\nJ8UF\r\n=iEMJ\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"49c7c465afe4ff5c075e6b0cd5d341ec617e03d2","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.5-pre.1155"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.5-pre.1155_1588845235985_0.19349327364214086","host":"s3://npm-registry-packages"}},"0.11.5-pre.1167":{"name":"piral-pwa","version":"0.11.5-pre.1167","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.5-pre.1167","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"cddc75be5314079474969dfc1e0ea76371dd71f3","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.5-pre.1167.tgz","fileCount":25,"integrity":"sha512-GUcUyIEteDGWvG14hP/IPAGFbBnROUnLahWnGsrtljdnKfNBN5DJBcJGLIdEQFskpopJQe0lgq43t9H8+oNUTg==","signatures":[{"sig":"MEYCIQDj0L8gT/O5wS/yAPVMVnfD7zvDIGbB1a/qluesFXRj1gIhAI9YIrltDFcZQl/uU91SMKBhqVb6YYtBcnacEHCK0qoD","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJetz4OCRA9TVsSAnZWagAAQeIP/3H2Oei8sG4Jq6BSaVZO\niq3lirrYs1xXs3n+bd5jVbif1OkdbPkQRaeEW4h1pyTfwrWZEBbuj/sxSS2J\n3/5odh3V9QBcUfJQvP+3L6DNpXZdIXezQ3nzrnqSJCwnOIdvDpv4Mz2z/kQr\ntPWaQ50HBLE7wDczAZKRO2xcY/g/+k3i/GkVij9Vj0U2A6LcpAl8j/C9f7Sd\nJI9dK/7PZnR7D7ITG4yYZShi9MLJJ+V+55klQ9Npaz8om9uNkJlJ7WvnLPO1\nMw6FSe+K0UJxgZWaiPVez/2knry42QHBgg6DLex3R+XNm2ukLUeUfmX6GKnv\nlIHvQ/+xu5qPUJWzG1NgnujtB86ta4/Pl2Apm1OssDnWpjZjD3HAnaA5dtYb\nWu6szw80m43/jYwBR+ad6SaA6hqMqWQzCYD69zxlJUmrVvP3gMacOiHx5j8J\nnVQJuueGow7yvBkWqj+9hRxOfi1cgEAHFeOWF+inHMktUBLs6Cd4mRMZWSvD\npeSCtLBOCvNa+vRhHYG1HyhmfwY7nhN9y50DhzZXr0RKisXynryFaNLJdCL6\naUeFHUi3tv0fyb187q0cSnBiypwnnEFhj+GsWN7WwEKQvwrYlUEW4bSzAp15\nM5nbsDYj7sTb7qAXbospJE6A34FTnSFuAq5pydEGYQddFyjK5l9PiJ14GD/l\nqDns\r\n=kUY5\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"1950b265417698707223cd3e95e1b49946bc8a02","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.5-pre.1167"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.5-pre.1167_1589067277828_0.1758313462329042","host":"s3://npm-registry-packages"}},"0.11.5-pre.1168":{"name":"piral-pwa","version":"0.11.5-pre.1168","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.5-pre.1168","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"fbcf3e9e4d61557589b633b8540ad44a0c6ddece","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.5-pre.1168.tgz","fileCount":25,"integrity":"sha512-wqgFQ+Crt2vltJRlF1jxn9hVsus8izKJ3P8qRueFMlqi5yyzYFX5XfpHA4BvkxH8gAlbkxqbTbGchENdQCTiaA==","signatures":[{"sig":"MEUCIQDQ8ck5Pp+SpQad0eSX2gZnAJ3qhraaQZBVg4XafVsnrgIgdFLJ2VWWS7fcojNkHbaASx0OdxmHk2zz2YD9lVHSDLg=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJet7jKCRA9TVsSAnZWagAAuokP/2/U9VqCPrSuyiUK4ePF\n+15TA+AXD/Fa8IROMKpusXR6v82Cv8JP4W59Kb+2/zw++tIbKnSlQzGbneoV\nsONl8siRpQR/y4T9Af6gZe+SOEchgGyBGRS5iMf6OXAKk+cqsGIblAD5fa54\nsWsBTZNPX4w3D+exc0U8/YJnnWEri0nID4XsyXtAU/z4lqBzIwtSXVu/hvty\nbUw15NHGgPrVOsbaCbCsQJfVfwz3QyT3XMsJIEJ91gMTTXoin/v7iKHawWTZ\nL9L1Dcp7XZGOv/moRNIthr3kXp47y7kSIL057DZXPyb0Mkd1xdrJzF+COuIa\n5mfD6WG8tF7UFcRuumIItvdbJlGotFWa7GgYe3z7RGzdGZvdQDFdklQ0WCZt\noZispx3lN1JcB5/Jm7yfnOyY3rGBWWfc2k2z2qCYIA78NudbG23OAWbS8/oR\n4e7Lqo4nV68AghQdFRwpLjYsXnIP4ibAaRYEJvjXu39Qf95J0Ek7OOY8dYwG\nRSTeAriNUy2BQhWs3/C6FDREK1J3npXZ9XCEc5r4ttgqlC8BpPqOOGzAj5U5\nwlTffLxvP5FPCQS7NtrMs/DxNwQZ8HxbtZOnxaMd1p455KZn7d8NMXQl2ofg\nvQ6ZP61COBFXHKrvKx//se559/JAKx2bj/c7QIIu+hykwc4PJs+0lvwgjCwB\norwW\r\n=h2oo\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"20baecda67f124622a31946239d077393dc78cac","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.5-pre.1168"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.5-pre.1168_1589098698313_0.7749190250282283","host":"s3://npm-registry-packages"}},"0.11.5-pre.1169":{"name":"piral-pwa","version":"0.11.5-pre.1169","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.5-pre.1169","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"c45e87f7e06637bc9caa5e4fb735c530eaeb5c85","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.5-pre.1169.tgz","fileCount":25,"integrity":"sha512-yIkPMSJNXN/1d7gbL4rSFPqdLyFdZv/3Ykkz7yJ9XBUkgoheJ1ZOMFxuMkL6OlgyhZkFt+EgkKe8cZ1lsSeSzw==","signatures":[{"sig":"MEQCIAjjGl1PFVl2S0lyrEq+P5RBG/QxVS0DZgmcLsZ7tJvwAiAOP9NrXgJ8LvaN8mhCreNCmiQTBDLeSZAfGZcZCk5p/g==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeupkbCRA9TVsSAnZWagAAszkP/3vL/TQZAlMnllcOKEDG\nKGOeMKtA9NcwahrHmgnFLJz1qwajVnE/G5FVKeE555LPZWArBiBUDmZLDJ6V\nTlUb6trduNctc55bg1Ao9P6phJh3MPRLJ7yUha9taLm68as2MkCIJgBy02VJ\nPEe0NMCHZjYxT8BBGKkThUsg13EJuNxMIuum+Ndv0RbOli1i3T0XURArruYr\nZAdrSoESDudjhYRFPTFxFH1tNDGDmtdWN0XWEWdHTiuySiKO0+ugYHfSLSGf\nWWIGuY8PUZBJfggwuDZSlaQ/BmPk6cvtV1mIJeM46GAp5i7Nvr0tsejhz7gy\nNqJEU/vyNCXGcLfJEaaiRTkOx9F/HeC6zWz4z/fbjrKHoIASwgNRSKMnKVSE\nHtPlkcUYBCGA9RrRWiENbTjwU7V+5eS87Rmec0fW9VQOq7aWgGIV2nFTHJYF\nd/9HQDsFxKgmbxeTxOrF+XtKYNjIZ2hn8wY2RiPUm+MRuJIkNlQXIgZKwHD/\niM1SoVQi8lWVPpFJZd+vRv25F4DTh8amWERx9XGE4o77bQiv2GQGeKWcQjpK\nPS3swSBDex1gi4qm3v3KQNqYBPAbfyCpAkut0OSSSURDw/fgYA/vNMoIJvga\ntNlI5YhLlL9RzwKBlUP/YBsq+qwDf2OLaUB4QdeSFgTeaCTmCbRUpSBkOJmu\n40LY\r\n=zqU2\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"0263b1f8c975ed206d4b0d33b3cdfccb69d707ef","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.5-pre.1169"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.5-pre.1169_1589287195159_0.2687031479693487","host":"s3://npm-registry-packages"}},"0.11.5-pre.1176":{"name":"piral-pwa","version":"0.11.5-pre.1176","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.5-pre.1176","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"51402bcd826e0d2445771407ae4449ff8cbc92a4","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.5-pre.1176.tgz","fileCount":25,"integrity":"sha512-izfteq0YqIhHC9qfGHRbnJjYDS7mQfVCpIWW9JMf/v0MvufMs6eAhf4VjYmAOALrNXbvJShbLJ3C2/HSgAxzgA==","signatures":[{"sig":"MEUCIF0Q9aPmy8IFnwETHp4r0yXkwDwYV81GhoV63M+Mj79VAiEAhqnvKXO6ukvAj8qbLu8jmPDxCUANBqvbYRczmGW3/T8=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJevBrSCRA9TVsSAnZWagAAL+kP/3jUz636zv1oY8h17sV4\nitjYo/9NPnsxtQO6o8wmk/IvqWwWVLAA0SgRk2nW8zLO6kHEt+NskORk5E0m\nMAKGYbEWRpDX2vq1ZLnhHb3DbZIh7oKao36RQubIGHyfaFPxbxW9GWrPK4l3\nD8bNJD2xMfYLwo80TYZOr3zg4J2MsxzVkrqeIrqs1GmoZOQb4L1B6JAW1Q5/\nqK9ap0YSWi8QgHV2zKwXoQJU7nYOIxTq8drjZoZnReK8XAwadt0djVww/S4r\ncaWo9Ti80HeBs23jXJ8lXkKSklmLce7DrItap54ZSo7zoMGLV7HXnNfqEByp\nZ3Ym3MazAz3GH3rdek1anD+tnR9cr06xVpI8Pgk51Rf6TBr1KHzi33M0DLs8\ng/PEcCtACCXfSfXh4tPjoWRa4eGby1kM5TpK206U1K/0nx3OP8gFoRVUu4zV\na98j0VxLzKACaZzZaJg+haPjFEGKlyNevWCBoot3EEGxywoujJJ7IID0MkHU\nCm3Iioc/WiCpiRO2/V43ooW4dDqirM3ZVpid2taZBwSikcdp60D9rbPxCmhB\n9selYiyqBEMGLcGnARHM2z3FOEN9nNFP4imEykfN3auoMs6YHQlTjHtE15S0\nfF6oPCn7wtmz9bmLGVGcyPXPDaOTcfo7O5AXu9YXijOID+hoPNT2HlbeRPpN\n3Lle\r\n=HZZm\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"ff199927f448e971c6d542850184f5c8a1fca6d1","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.5-pre.1176"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.5-pre.1176_1589385937982_0.4645083581045619","host":"s3://npm-registry-packages"}},"0.11.5-pre.1196":{"name":"piral-pwa","version":"0.11.5-pre.1196","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.5-pre.1196","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"9aab546249191b595a6de7062982a0647618eaf2","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.5-pre.1196.tgz","fileCount":25,"integrity":"sha512-2O1uzBQ1JvuinTANTtet9WPGZRBqKWSFcl3gnfow0w/lWwdmrADGJNDb3S9D3odhu2JavvSmVAbeilckdXKfQw==","signatures":[{"sig":"MEUCIBmyrI4jHYAGgnOXxYOoafT3uKFGDz0TwJIgoAFiZwhuAiEAsc/8BqwcjBhJZnD7xQm22DMwymlYDT09jd9iqWr/UEo=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJevrs2CRA9TVsSAnZWagAAagsQAIkDmkrOQsiG7/G4VJr/\n3UyZH7OUXHz2XnXdEJ3ds27aOYqHSDqvfa2yZvfjGKhCmND7y0xnHZDSRJqV\nzRLEgCJWsu2z1jTN9/uMu321U/msI9NyLTIeSCytXbFefXxlfG51OjU+HDHB\nNezxYa3kUxF0oHR93avVnaM7mmtbA3tiCl2SunRc7ghtYPMADMuInxr/xMHG\nHJfGKGDNiCNj2Ih4RuwcSngNr95nI+UKFnJcKUpogtBbykyFxnMNzqRmhBEi\n3r5blMvSxSbUA+ppSVSsd2gIwUb1vqKeJFj2DW9r0kYSBSlAlQ3IgqBh3/rs\niZptm1g4I0OTawDDkevcwQ7aecX5HlCGF1m3qpZGg9366K2bLAf5D2k4G1kO\nXqaoH7cMKYB1kusST1F9D8GoKsemAn6iFJg7R09pz2iniUlDnx6GowB3E9r3\nON2lINcOrPr3xSYqLO54tUDqLIIbHwNbxT0Kn2I7411oHV3nAAbcuaeQWmTC\nxyBDnO+GEiE1QFN9Qd6mmJJL1oPWurQO1L7kJB+33EhbMY5XblNtNmluI5DK\nDAN7kztJghUHovH5eUepVItOWF61nAZ+x6SkY7rUCQdNykCqExqXYpCg3LtL\nI8d7OtJ/r1/0VYy7DWlU/uOwVmZn5PRIB7VHesHwLoXghD4wSjOBbQ1Mfn3N\nMdEs\r\n=MEos\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"4f47627b317e218147ab7df6cdb40673c94c80c1","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.5-pre.1196"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.5-pre.1196_1589558069834_0.8018556618011214","host":"s3://npm-registry-packages"}},"0.11.5-pre.1201":{"name":"piral-pwa","version":"0.11.5-pre.1201","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.5-pre.1201","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"52b75ba1be6630b03d0c8bb4aa2e89800b757d4f","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.5-pre.1201.tgz","fileCount":25,"integrity":"sha512-cRwjjIhdAeCglQSHMCldOF4oyDS+0HsG2plwt9fJ8pCEiVcwYDln1sH2CvcuwXelG8oODdyV+KCBIpJDlzhFaw==","signatures":[{"sig":"MEYCIQDCfoh6YV2cPAkt8WGAGhITaPyk9uvfyux95jzOmkHP4QIhAJirRWoJRI0cC5PzelhabpT6tjVXLMqhx1vgRRpITolD","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJewudPCRA9TVsSAnZWagAAs3oP/i2xbTMECSZmuZJiNGMk\n66GdtZo9rtTqnW59qbijsFEd0Tpv/2HcvpeUuj0aJZSNXRHPGZ6CQr8aYadq\nfQfyQgFzgFP3jaYfJUyKLrUAFSVW797mrkiPq2fWqNDQwTmwzeR/8MjwHNE6\nYX58iSSXgdhZj2QvdpSCO+qD3CO8sJNFQF7ePvbTA9ZCKf9T21gEY2qust8G\nAsT6sEMiNzZJi8wDjIoytOvXGrAWqV099FkeLr6Y8y03qyrABaj7JtL4V7F+\namxU8V7vEuhyFQVAiXX/oHFGAvVUdniINgoc7tAABtjVfvYooq9Zjf75blg8\n+sTWi2ytAyqXMxbEyIZpiA605x3q9VZ7HCRo1II88hADHH8UQITHqmhkBunL\n4NO/2vdFSQyw2PnKmKs2bbw9G8e+XhQoE4HMzTyn4WoLiFtNRWTyv1y+w7nc\nBl9C83pJJCzK8bIQQOMv0sjDajNzdmhgNz5V0u56C5Gf0uhk8heMwbHRntaL\n6n1NOWt5cNjJ4CFDnzr67y7impdIkV0WAPu51M3+zdIfW7I8dFxipqXjNJw/\nxLu7TyPdDQfAXE+p1+UFrD0H9Gf/bY+sCQL4cRD0ed+PJVPlFeB2LEVEDvuS\nEhP1PgFK1eCzwZ8UXnoQKgVoUTeH/cQOr3keJpmVRCv+taNVCNdimhTXLVBL\nKo6E\r\n=uqwr\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"5b0fd7cd6f1ba29b9e07eef011ee0c158c722282","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.5-pre.1201"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.5-pre.1201_1589831503055_0.0009266659244446807","host":"s3://npm-registry-packages"}},"0.11.5-pre.1203":{"name":"piral-pwa","version":"0.11.5-pre.1203","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.5-pre.1203","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"00d6298e2c5502ef79fa777b9b4e9e9e8df8c4ac","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.5-pre.1203.tgz","fileCount":25,"integrity":"sha512-IIGTQCgYM8n7DKA69WpyCtDdKqbxwD4CtXi+wH970qKuxlP5iziWgzie5iJuLQ3U0Ip7VbGIToi6JltFsHR7SQ==","signatures":[{"sig":"MEQCIHyLocJpcGZMRzD8TEEWNxmkbiKKAA+nKkTbIz1/sny8AiBgzmpAQXYAyd5DEPNAdz2oaaCoOK87yzMjSvTZoARygg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJew4TQCRA9TVsSAnZWagAACYIP/iE7yiSp2Z/3/WNkr7I3\n3loDLlFB/yS0MnTVZdE/XzfC99pFlmPeumVeBNeGjmTl1W2xBcWnD3CHkJsv\nCXjLDzvXgkzqB3Vzmnx5JdnWBPGfUYd+yTs5q4L+r0Xixf4xaGC8HVXKmT3Q\nlyTAB5UhrIP4Y9luLOqtYa67fqyZ+X7jnqvKr/44fUBUB/jYnE/gkUIJeD2d\ndv5eEvxJUOl3XOId/+YAtHkTtRtELoKyr+ggBvbLFzAlHeWn9UTii1fOyRTc\nqRB5WDcTCxWeIZrUNzvohC8bEY8wiKxml+AwOj0q4nYAeKxEUa0e77Jg4ct/\nb1HreSyVLjnGllYNXdFkTGfc1X0IY17H4wrXC0vsNVO/zrMM6ZWTUmf2O9gl\nSdJ/AVGk42UH+Twk9yRkI4zxs2ngZxG/GvDvgHc7FZnENM2vVTYPSCZth5AD\n4q1ReOtduYJ4dcgJ91QTO0FXv2iphYgpznlJff++PJ8gAEl6brI6MLNVRqbd\nlvdKZJKMSwfNbWYhPsVHwbF3A+9Z6nY8NRWLuiJ8adA6//c117ZKz3MKBY23\nXZpqqJz3CjMQvC6nuP5cjP7yikSsBEAmHUJ4tXk0F+6pENwbkjYACA7gTxTz\nbAYONFEPq1rv2U9G13+y1WGHdOq2172cBgYVZVu3LbRsbFV5Y/GfkLqYJeAF\ngiOU\r\n=XyBB\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"83412a884f6e0a29891e85eb059ff449f51bbcd1","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.5-pre.1203"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.5-pre.1203_1589871824029_0.15944019117593156","host":"s3://npm-registry-packages"}},"0.11.5-pre.1204":{"name":"piral-pwa","version":"0.11.5-pre.1204","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.5-pre.1204","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"23be22521fb5d1433d319bb6f94442eb8761a828","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.5-pre.1204.tgz","fileCount":25,"integrity":"sha512-dS0m7L86aomrnl70uTQlsG0rCMjgc+NGLk3kQjFLlaW34jSYpKbwCP60IVNC20NSaY1P9IbP+gpEgVKEpS4fOg==","signatures":[{"sig":"MEQCICaKidI4A1dsy3j3SJ06wif3thMvNxr1jOcKP3t1OYFkAiAyKjKzlXpkiDfIGY/r2WdB4YIdsYDAVlvKtOvdfriVfg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJexDK9CRA9TVsSAnZWagAAqeQP/1w22MzokLNPt2xo1mG7\n/H+T1ZQYUNeo9qjlfoVydiRQqEXGwHB2b6GGv+nxnmID92T8y5MigyLxQovh\ndTR9/9RL5aPZtLpehSP+VXerwfhJAKbMtuF3MM3D9kiet0kjx+jiRbJCBgo+\ndij9n2YuG50rvdOiVPUc3yau0NSEgbjtW3TgBXpuRpalYhVKsNaX95yIZ7TW\nYWf/FmwPpjGnW7hxl8n/2gg4yQ3BkYVHMmuMazw6gK3tZy2kuLwnvTAPhIqn\nKY9ljI0vdfSMNDBh5lgqGGpepEZF8uAnQf2zcBXh1KXlDzC2PTY9oOU/duR1\nm3m0whT5Kkv4g8GdkFsZuKbkYYOi5+iPN26nvepandfGbPSE5IqUsQU/p2FK\n5LWMfFoissozzna3UgZ6d4sN/p3fAsqAOlvJ16A0Mx5ykaBlN6rhVECdJXYp\ni/fw40kmcHu9A6W4Fyd7X1DBXdssq7rKy+yj0y9u884erBmYxltTENrVIDCX\n7fboal/qvgRcBaXIo7DFpZkLtr6h3jCQnjApIBa6ToCNxffZQvwMUvC21hez\nzHRovX6GNxiXnKBjZbE9T0LJgCSOi7vbXgMAj/+KDFNc+cHGNT2OGCPZb6Z5\nhevVpYuiwf8mJtfA62Wg3ZBGIJuAKJZEICLMTl6TUv4LdzeJo6jBSuaFZzRr\ndW5G\r\n=r/rW\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"2562c30b2890a785df141d860398ae59ac935ac8","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.5-pre.1204"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.5-pre.1204_1589916349070_0.7116451038762595","host":"s3://npm-registry-packages"}},"0.11.5-pre.1233":{"name":"piral-pwa","version":"0.11.5-pre.1233","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.5-pre.1233","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"134beb51cc4ef4ba8568c8496c60eaaa3c04dd7c","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.5-pre.1233.tgz","fileCount":25,"integrity":"sha512-48qFcSq8cYxKxvici65xZGpWj6CNY4LKR5rEIcuHgYxaZs6lSjhab+8x0FjY69/7tzyc7U6i82Bq+fmVtTfChw==","signatures":[{"sig":"MEUCIQDPslaS/14K9Bl2sxWJdTFAgFYz1G0urLZAgLZLrO27wAIgTiHKeBXURQPtZTG3evIAAOugnmjfC0gq4xQuFRMfrIQ=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJexp54CRA9TVsSAnZWagAAxd8P/ifyzYR8Nqvqq0DBCSEq\nGwxPtYFB9Twix+vQq5qFV5wTjWQ90ECAUwM7S8/0ipWpwtGLBfQziCLOY4Hk\nuYQdoEvhhaNJ4qA9f5duxQtrGc+Tyd5f7WxQj5OUiWXEhNXngtYanrUQyB3I\nh0RZ9R/Iy/6DiqwRS/EjmFCj7v8ofsoU/NdMRpH8u9xtkTyq976OxcbAAGdF\n5m94wA3fqgPRR34X+zOQ2nHYoTJtYqunaloSnZZsIlBsSlkameymma+RjSfS\n8S/0KNREvTqy435HKKuHNnwPgm0XyR5TmV7pIb5MCz1ZKRmOaqRXYnTI27HA\n/727oCDYtZbmqrLQ+cumEZUoqTdsJxRucvyzdbNm+kiTRXj9/W6UDTwWh30Q\nYv+OJjTrre20926r0SvWjbfTAYveJzqe5WOKoK0u6/nadX1EnYQr5LCy6VjT\nq5moYhhOctFZqaGz8/D88VZutbaz6MVDMiz826oyhPYnOgYkrMscX/j01qDP\nSEJhQT8g9AenIi+7T9DABq9O1ZCr/UwfiGSnnd7Pr791lKWtPgW0ObF8/Y1G\n6MORQ9koHKfcfJgUzGjJGgW+1v+1rT6oEyU0jBGOnu9/7rg1ypKVgZHnBmpJ\nE6c+7EGWyNyJzW/DnfjpKMbw28GiQag9218nnPmm9yHIuL3TrYiBdYvb6pyO\ntq8C\r\n=87Qm\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"8f7a439009e34b485bbb5f2a4e8828252ae44b85","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.5-pre.1233"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.5-pre.1233_1590074999932_0.013226227650039446","host":"s3://npm-registry-packages"}},"0.11.5-pre.1237":{"name":"piral-pwa","version":"0.11.5-pre.1237","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.5-pre.1237","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"245c040d37284764800348d023472b91d1c0756e","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.5-pre.1237.tgz","fileCount":25,"integrity":"sha512-jK2qMW/fQcpLRIrVF2p/cKqa6Paw/jP4zi0aF1LJ6rGViB0UCr8+l4/WzGSeS2zVc4fsjEA61lYHlzq2StYVEA==","signatures":[{"sig":"MEUCIGScgEwLNmR/HFuJXCzIsUzBWFY96t6Zrq19R1irKBytAiEAk3YAGtaqYA6wwg3jCeFdOyFs2rQLJT0m0oy8PIQXuj8=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeyCmLCRA9TVsSAnZWagAA3jAP/R2IVJ42bLVCgjs79hdi\nvFR+Mvt2AwV07UrnDnMrLxVxBvveXlzS5ChMKIrBBPFiVNmjxIdt9Jp73Hat\naCt5JYDAuwLvycUuU5GsEPsZYqrcljiUXVgmK7QH/m0rVrHfjW5SAUvVZbG1\nvxb4/CQUMCRHQEUuo00i1fXESPbHGWU1rZy6PHJPxnp+XqFxwatsL8rUQTfP\nP5NsO5XSiP+nfBWN0SPeoets9x+f5tYeU0A4NuCEXGiPUdcCPQy7HHKPcZZB\nLCHMljo0NGK01JmKFORdxtzeDHMS0cId21etgFTp2lOdPd4Un7K+p6FCaDPb\n3Phd+mtDM9Lvy5oKDkNt4lqVY7+LO7oJYEPAYRsI1pt+p3YvN6vDwJxlaZw4\n0UV7xCV9OgALKPsTEPO3af9jIhJY3I5t/xoZDL5BOllcxrngdjKlechr4NoR\no958WKlMJ9hl/BBpC4B8qeu/cE/NJe/1dzFoWw6v4bt+iaC5PjrIs2wdLw9q\nfGdlsSnZc5ted5CwWMx+2PtVAgiHvZW9pWshXt6HPf+gVRsaPdiFqCL+gtDC\n7oLJkihOIPYDV3vY0cHup9HePClVRAKuc536dGKItcEMcuWQ+QqrghHGHBse\nTr9ec0v9SuI4rQSpyqXnJS8Fzt/noNq+fm7YWz7HNKO10It265Ux81d0q5Mp\nY8Nj\r\n=D94p\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"30ceae60248dd969ea2a3591e221b06cde6ea578","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.5-pre.1237"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.5-pre.1237_1590176139122_0.8856012902118329","host":"s3://npm-registry-packages"}},"0.11.5-pre.1242":{"name":"piral-pwa","version":"0.11.5-pre.1242","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.5-pre.1242","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"31bd9286a6e4b56de97569a52fd0792d63a58d0d","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.5-pre.1242.tgz","fileCount":25,"integrity":"sha512-a4HWyw4JdKdQWDHeWkTImFLyydaROdMtWkfbqfcxCf7gx7V8PpiZt2/yxI++azhSEeQGthbRz7PUgskvModSNA==","signatures":[{"sig":"MEQCIEFdjjkfdSp4kH6hXRhkjy8CqEliawcTwLXtzOo3JVvyAiApbNrcwY6jQUp9/qj//s1EG19P7aJZ7OfgB9AS62dIAg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeyRdeCRA9TVsSAnZWagAAYk0P/jLtSTCUYTGnpbvfXNtn\nUFibiLFzcr7pe3ZtbIeBWYRvBVXBLQP55ifW+RMe5W1/mjmGjtylxW2WcsFb\nFirSqsZBpzH8UpsmB6EcCj83vyYZCBjC5PGAj395NKHymLLs9s/quOkq69WV\nBSD9aPjcdyIuojLWrJ/1G19GQWzCHQal9BxSX6kBvZlr9/bnEbosOoUqVbXt\nyRW3cHbYu1hYTVON2DoqguGTf7Yborjzb/O6E8VvseJbDlMGsVA9W9P6H3NR\nzrCeLrbAgTosLbDnB/tluUcOTWG3Mf+wQSV8CxQjfO9HlCXYSFhSYKdQ+CCV\nqZDhBZRR14Kq8AzN5wuKTIQItbPg9xqDMzSUc3KH2hmbpZeUeIB2ToUaBA3C\ntIcMMFZC89jZfIyPI5149Q5+03qjxdhigiFGkBAXwAfZ7yEBtP8pkVAoNUTE\nJaw18rqhVRst0tWiWjHn331LaaO1moSE8kcieQ3zhCOakLugYd9NxrTwLuxj\niOK9NxFC7O9VKbkLD5BSaREZ77Wj91EWT9bDY2H/BxoGqx+oJVuA+OJ5V0rx\nFSnutdsvHPqSmliEariX1QBxh3UeA1p7/etkgTNNX0rYqbwT57FUa+cZfXUm\nGuPsq0h2fhLA3jkkHFDWx05vbggym66S1bc1FnRO59CN7NTOTvCCr/w6BZ2X\nAhDv\r\n=8g/n\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"cb5d5846435a0d111fe20c54cc899a17b173af2b","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.5-pre.1242"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.5-pre.1242_1590237022571_0.9719625325422914","host":"s3://npm-registry-packages"}},"0.11.5-pre.1243":{"name":"piral-pwa","version":"0.11.5-pre.1243","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.5-pre.1243","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"01aa42e73aa54c89b67225c71e0813d630c882b7","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.5-pre.1243.tgz","fileCount":25,"integrity":"sha512-YszCCuPJCQCziPhz28zFLDvgGqkZevKpI2iK0MWhIkyIWGpoHUS9O+9FHSuOQjcco7BQ2/Id9Vic0ToqHKSisQ==","signatures":[{"sig":"MEQCIFuCh0WPRZ4JWhHBDwLSYnLSZvzq6+97rcd/jw2CKwG8AiAwbgIMmJZoMMupeZdAJyalaHPP6EIHUVz1LQRjMg2I3A==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeyZp8CRA9TVsSAnZWagAAg88P/iyHtETihWfSC0w9AmeR\nQ+zIGGE95q/bSyp2vmjkRBE5iHfKVLfvVTvJh3vlEEJbfMz+s7FK1/qFlPHJ\nNvuXdd2hbspGCWbhKrSPaDkKi0BnscgzUdPMTAe4oDW4uU5tZqQVTTqXg16v\nRfD8a99DXKeIR11r6oZjCYmBzebePKfEqoEGT+XJxenGccW5+dGIBpkxw1Ln\nBkGx9eo2noP0vM2kt6I7ldOaQMu47jibPbPaG0qtuoscQvmxYQXsxEn1rf8E\nxRmaZQJbOSdy7CgQPdQD5p856+D+LEr8EPn3oUNdIIu3xKlJlPakOhYhwMU/\nTDu7cq+DmN31o6RjsR0vV25+WyrEVdp57xD5kVSYAnmjFN4tG8sign6LhfXj\nGCM4RvgdiR3njz6KMReLansTzdAd6HvsLnxQ7UJp//2i7wCQbOJi6cQ/eiWE\n6Zcbgna3eVvUBYkC0u1IIx/btTAzz+woeMTOI/iCA6i6CWz80xk5EFPejFaJ\nipS31FSu5E5LFP0HHewpUEzFRIERM9s1+vxiicgkeqShfTU3jYZJuuII8vWJ\nPKHOPCPOTbBelDWT88wXOQjncNs95rsHA4RIPoXXaWOwBg6Fjouw+1Zj7PTe\nHdmN2EgFnEMyTordYwuuWOpVfz00ML+EheZfsDb+Vlr9Z5f9wXMbIrumKA5A\n8aOZ\r\n=3uxB\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"dce3c40b90d922f8123abff6a763c78b5fc90ec4","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.5-pre.1243"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.5-pre.1243_1590270588080_0.024952813567145737","host":"s3://npm-registry-packages"}},"0.11.5-pre.1244":{"name":"piral-pwa","version":"0.11.5-pre.1244","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.5-pre.1244","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"fbda6e8c9918a98de88fc5b08d7a12aafd9524e3","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.5-pre.1244.tgz","fileCount":25,"integrity":"sha512-RHCnIHqTmRHJ4I50JdhA2GTAAUiWy1vjl1o5QaIWLtFmmfvIUtWSGYNNWYvX2ZxPFDAmy3Gm/Ral6YwD2FAsYw==","signatures":[{"sig":"MEYCIQDMNNj4fDex6kAPz8cS4BtZ5rvEIuQb1TQQsdV2sBpJ9AIhAKHrB8SViF08BrGnbZMkRXg3mfXOlGAHRoA9hOEfTqX5","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeybUuCRA9TVsSAnZWagAAzRMP/0a2pCPmU3ko0/hmH1P4\na+4lQSQ+ZWjkYf8omXCAvTISjmBAsId2if1mOUICEnWMyIvfPCP5wxx5JrCG\nbjqo49K8Es2jdZDmsqut0hXkFZjnNOzkxEQ7+XZglIsldeS2/0047YrRkncQ\n56OS4JWvoPDPwDjve85kUWFQzoE9iMwOsMnxtx6YLxFiCKDbcDCdpWrY6RYh\nm4Qbl3M5HO/VCpStm6mdlsrj1rgWpAUc9OLJMt3+wa3oF3LlACiLkMO5hD63\nAzUbWumXH4viuqllufuFGssEsGbPGagmYdOmona2/T5CPn+5pTam2cyMgSl9\nRQtpOjawgdJl2FzFAlJvzHemd5bZmgfIrOqpEf/DmxcYPMqZ4pH4TS9Ennul\nHCX48DBYn9mwoYYOvRzf+VC3B/O1bm0S/LBBKpNMznowMEHx27f5rZXgJKZR\nQ7/HPdwA3bRv4Un7q0QHf5vSA6l55bbnKuibNDSCbJQOxKsAxu0NF7K9OcmH\nNAJMm6c3x3owIohgF92P3jC/PZCnq+nPDmnafLnM85EFKAn3Ubx/7fOKdTUQ\n2oPVsuwVHxZSWkGJqYahE/INJIgflDTugP+uzx+Kz748CGf38ld97kuJO0DB\nIQQ65Zr3nKrlRG2Xcl61rPJzfDan/yb7MbItuoadGIuCqDnyQ+xB7eDbtDWJ\nTjre\r\n=l80U\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"e62a9ac95348f6a4ed5b5e9ec3a01075bcd63ea2","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.5-pre.1244"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.5-pre.1244_1590277422011_0.9441524465848112","host":"s3://npm-registry-packages"}},"0.11.5-pre.1248":{"name":"piral-pwa","version":"0.11.5-pre.1248","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.5-pre.1248","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"7d81c5f50f270491d20d0b525144a54acede5f17","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.5-pre.1248.tgz","fileCount":25,"integrity":"sha512-btuiotPED3eU2LaAZPd/OT0YnUFNSr0CP8czceEBYGuF55IHhUzaob4uz41JKe2nWjJ9a60zaeLtiTAQHJpIwg==","signatures":[{"sig":"MEUCIQCrYgbgUVGFngh3sxIvqVFmeb//G3ZxJ2lszc8Hwc/zrAIgWEw140xRysWnc2Ny0f5dtLNwjBadl2sAb+3EUOJBbzU=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeyqLCCRA9TVsSAnZWagAAkdMP/jhCCLY//sQ/8lAL9yub\nyH8CljRp0vTljhmhS11owQx5rp9QgdUCn++/Lq5SXFUjN8rRbGq8eLx+iPY4\nklKnYRPriDqyCgXZiA2tQzYXnnTPwxkd1aLdOkKlf/q2Db4kKsjGhCLY5Zg+\nU0PKVUFjwLkmSxeHNf7/OYBr6OLB47g7j81Px+YFZgyGh23jO4YFrJQwh7fR\nwUab4NmtQ2mRrSUGJkx8SoRTHijTLhpKmYIghqUtKuaBCMTiU4BLCVXiUS9y\nM4dil8BMIi2rmgErw75ZiyOD5E0MIj9Xfe6aQd+jqGJAvYSH8PcYTkJQ0qve\naCreZVjsKsclz4WrVOhXoO7vN/QEMSQ4Sd5hP2SYiwkk3XdXKXZaJK+YDy8g\nJf//FLxge4U/s7zl5kXxfuUmLyBmokldLcW58hEvFZkCInkb+v46p9sHbRzw\nU946898FM3vsl9ajSdd5Wm3d3McEbU9lKRn4CkhOpVwZLqQzfrVcXjnLTUQ6\nfvjCAQorcYlFX9zAFMRztR0w4qzRtPhjiQ48ki2gHwiIT9QBy0pf0TMYMOoq\n7VowzZ7Td7dvo7SPQgdVhK30vCr2wDqWRrpNk3eXtlKGS42btZRYJb08kf+X\nPQR/w/LRSxku5Ajl8FGdlvWLy40u1ruyTtZzWYDhRVTqkYew68zog9kPya0t\nAEsU\r\n=CVnY\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"8ffb74f782b7244d4aaac51f0951cd99ab517a90","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.5-pre.1248"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.5-pre.1248_1590338241901_0.9535778244894291","host":"s3://npm-registry-packages"}},"0.11.5-pre.1250":{"name":"piral-pwa","version":"0.11.5-pre.1250","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.5-pre.1250","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"4445a72517a0c9fb44d54445dc42f1a01b50e691","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.5-pre.1250.tgz","fileCount":25,"integrity":"sha512-Wj94MUwdRylUpFg9wx+xOm6M1lKwAsE1X8qDjCAtwKHIMIc/sdWE6Nw2QRvcerS22vZ2gjOoR/6dpRWmcQphZA==","signatures":[{"sig":"MEYCIQC8DY16zIFnaw/3AW649EP3FfVaQZshs17u6rRiYFytGgIhALLFR9LPgqQGr2iDqaV9ID22hxjcULQxl8vbdM3w4Ocj","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeyrnHCRA9TVsSAnZWagAA8O8P/2yil6wxlDP8HEnK0EKu\nImEVhFGMV+cydi9/sj5eVjFR3HEysL3J4n3JWIKk8ypu02L3d2b9WqNMntP6\nchH3hZzel9c0bD8sga8aqDmteoM7gzei7r0pQ6kUiL7wDQmZ86AjnmkNcCgb\n9vknTV/YjRWyNhuvVyc9LkNcCWWHF9+rsf1bv8BzmQKPussvG1Ck9iGy0r0B\n1zvmWAisIRqx7fkTM1kqwBFjYU/A+ib23US8z+/HuiYJidzqii10UVwR8uPs\nsAmosIeC7UVrFrhnVKcMZ5Rmoqw69rVUn5D/3JBwiADP1+dfiTOcJM+zRaUO\nBVclB9sXdvU5M6sHGKK4qqKbWDt74PdQiLnV2hRFMCAMW0JFhSdh5yueJg3M\nakLKIXaEpIXxtWMDV/pWBrjA8CF3dnXX6m7P4Ptb3FvF4VLSnkNeEntoQAKL\nieqoAzNUYj4rdFm7w2Q0UT/EYNCMfim5jJxYRz4jjaVJPtkmU4I+GnohJ+ps\nQ6iyUrUwRmN+vi7aaXc/8z1GWVuhQl5egBh4rSEMpna0J8orsk+qsCPtsAg7\nhaEexKv6cEIsD2khffitsHpYa1bq4oMMQ3h/kmHY++0t//QbYYNLLE6MgiGw\nuAcI0Z74z9juDL24yGvn0s+84QC8AFQgDk10i3jMxI/wq91XNHfuJhh0AtG4\neWoX\r\n=xIfz\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"3f61c14e3877e266b081c0b3f536546a52a41360","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.5-pre.1250"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.5-pre.1250_1590344135064_0.8092839837928067","host":"s3://npm-registry-packages"}},"0.11.5":{"name":"piral-pwa","version":"0.11.5","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.5","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"6cc08173556eb52580348a5f95c1a56b7ff23927","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.5.tgz","fileCount":25,"integrity":"sha512-Gmtw1wAYH4rhRabt9D0uAEGiaodHNtMqp+/4RGbHz0Y79ZxRPUnCL7Pfbma3XeVDe49UmOZ1DDCVVVj9Q1NZyA==","signatures":[{"sig":"MEUCIQCK8RatvVt8IyGLTqBBCHEz/V4I8iNxP2kUeGvQxr7zrgIgTzgIE4sAk5MiaLVo1bL6YI0GUF9GXrPpWBXzRdAU5zo=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48957,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeys+vCRA9TVsSAnZWagAAPLwP/RouDOHkhVdMTR3C8ZQ+\nynIvb9R3z8nYe0SyHVntExHqmWuFvKLHhI+X/5sd/3IB9mZnbsykoRzAkr28\nuDyEvuFYbhylQPsoE6LIs60PvmOnV1BE9rPoLZbQOUAnhpKNTvSGeVo8TqsY\nlArgvBRvca4iAzVKtloFs8Q3oEkzBBmU+ry0nA0bFyuuj9bJY6cMUU26BF6a\ntu7YmPtFee0n4JEuUzcG52lZH4Bf8GbJjeQS+HgXVSfJFvVhpYOz35ZgMX9K\n7m6udrvkAPsdPrUYH2U0vyPqjTf8YlShlyEwO5bTg8FiluFw18NtvCMTvPH5\nm07CgYSq2FsIWE2r0hCQquI+kk9eUyrspFfZBtbRKwmlNX8UX9FwMJtJ6q80\nzEdDHPDPsfOpTsFaIzGVfb0Qh3FJWIPEuSp0Q6fYbux33SAQvEZwpdxXzoha\nOjS/c/bBHJMARVvE8aP0BPhbGUN1iXWAzbad6iaRUDe7zREgu1za9DxqhhLL\nDtD26Dw8+2TfXVx4e0W2G2vYg6/f4XH0H0odmsSUa4jW4HrR8TTwuT+8mdA1\nHLnQtkmA6uc5lwqJyJSHJLRak5OlAY3NljFj+NYs50srwkmrKDylpZFcHKmh\nIEYN98EcsY/zgjE9cmUAcdCyvD+aCXA4IzodTcPzXh6Sn+Va3sVjjxp0JKIK\nv49W\r\n=ckK2\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"1415cbd981dd5f6da4822c9203a7ac6073e3fcf7","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.11.5"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.5_1590349743010_0.7673729490318688","host":"s3://npm-registry-packages"}},"0.11.6-pre.1254":{"name":"piral-pwa","version":"0.11.6-pre.1254","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.6-pre.1254","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"1382460393fd3e2645672d5cae422c86fec4ec9a","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.6-pre.1254.tgz","fileCount":25,"integrity":"sha512-ilE1VMVSs+6riFFG7pJrfjhEipMcSZjLKhs/ykbK/Nv4qhJrlg0MXYtWVNWZdy4z8x/s+EZJocPNdtkm4/uBxw==","signatures":[{"sig":"MEQCIDNnrWqkFSQh7l6vXhUXQhE1qNbZ8y8GVFt2y9nxLgCuAiBbR5LsFD7jOQyyhOexbcifDfKX9jx8UfkRw6ZdNGGLPw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeyvRFCRA9TVsSAnZWagAAjr0P/iPW7dVehU4M0owYG2et\nGeDLBDBbK9QQ2wjpVuq3iQgQACuV2R54gU0nxzh3DnD7ldsf2bD5w6C9XtGm\nm4Tn1zFEMbjwt/+YBmqgyRJJexFONXvhkT1kMSKxNTKW8RbNdKTN40V6MRdZ\nFB1vXrFYvr/fLouIXsq8QacdzBKXmqlcZ5fzv4gRpU2xp21QFumjUZTaEN5T\n+jp6nqcV6YsZ2uumejn4gkWGbKVLx0zCTKxxXXpdsux7g4IVqk9PSpk8rPto\nA2gUt7t7k7aFLzT/ifP21MROYiJRIPSRF3oLOwhCx38vqYo2dStpzjwkeO7T\nmi+eD2pUwrlV8LXdAnCXaG7zSVbPRplNwyIP5M4ue3kG8sfK8uecsId662Qb\nixXPjAu/N0Sr18bSvQWizkRLuVVdL6ggdcYB1MW8r1eIISWC35bvp2dK3Q2h\ntUhUeTw/0Uak+7nt6MqY6AFVA7uvhE2Pcnr9ElqPijxlsucbGEWdK92dh8OS\nngl5XbTmHROhPm4S/Kxoc/mIsjrqmAs6mrZA7Gh5sTWvySuYmA1IkMkaQqx/\nnWSD10YN7cInN5rt/uCGFPahFgnjbmCPVWhza5SFLx/jNwrexPTOrVZX/0Pl\nFGe6lnRWvh9ZQSF2uC7yrgIpd65EGv+lvSSbMHzce/vQwgd64nEamow2ilT6\noW4n\r\n=b5b2\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"c3b46806b56de2b05e29fa8714becd1699184d83","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.6-pre.1254"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.6-pre.1254_1590359109572_0.04992499494648417","host":"s3://npm-registry-packages"}},"0.11.6-pre.1256":{"name":"piral-pwa","version":"0.11.6-pre.1256","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.6-pre.1256","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"de84ccc487f0a99f595865440995697835b0fe4a","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.6-pre.1256.tgz","fileCount":25,"integrity":"sha512-OiJy9+9l2qj+TCSZCtGM2px+Y7602RY2PYIDByK8tGeQVSE6Et7+P98dcJ1wIdY+qNr/65udpOuDaOkkOOEJ/A==","signatures":[{"sig":"MEUCIQCzor5yzFH5khca/1U8NiyGkwzj02hHT6FDSdNlXzZMTQIgWCl293RvGuxWSptjubk/NsYBe8v3oGo1XVbeMEiRy/Y=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJezEHXCRA9TVsSAnZWagAAeOAQAJsSchuUusjY6hoENwUo\n2SAwEvUnnymVJYuIQvzjNptMWV8hQM5tqOGxmvnYO8ZCqk4XrznLM29CO/cK\nAncRuRrZkTzozK0Pc7pcdedEpsN+NOYdefYmEM9tDtKiFmRSnxETdTThCx7M\nuJSe3L5SqWPUU382vjwp65O5JKqD5e5KK7LQ6E6sje57pibsQwRrJzxwE/g+\nVx77/Q9ap65x5IWTA15YUawSYu7LCMRkFH87QdUVsowFt4v+RTii71Hck99P\n7TzLhjoqYwV7rET+lslLAcovPGLa2sjgGJ9bld3dzDNx9JPXWahEBWYYxD8w\nlZjJw0FTYiuT+JDzJZzB1zenbjm73d1FsV7HsamJ7z4OSCCsflUhZuqgDr9e\niFTikd3tbqtTRVKnbTwrlZfJIArXeAVYEmfY0hYhLDo96XbIt4cAvQ5v6AMY\nUc+SGCWAA8lPt8R4vNA/R8McVvs9KjbFv0DBxnmi7ZLcZrLOsGiRUpYlXpmH\nbgf0FNt7wFXds5ZLnYgtVS44pcxeIokHH2Ryz7K1Xxs3WnzBmwNMtPbjPl6o\n0Qo7J7tBrvBT1cuh7FO23IBdvNOw8/x8PPo4qPrqRdDVmMJGvwW/pkHrJW0L\n/oomGYV3C/EdrevkfYIPSupYkMkLRupSwn4fc5sLstZSZsmS0gOarHNU5C3S\nAkNF\r\n=3388\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"9024f89e0cc7daa04895460f922eaf6de5a69ad2","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.6-pre.1256"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.6-pre.1256_1590444502852_0.8131914977337424","host":"s3://npm-registry-packages"}},"0.11.6-pre.1258":{"name":"piral-pwa","version":"0.11.6-pre.1258","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.6-pre.1258","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"7260d2a2b3bd79afbfb7083506d2ea4f91426201","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.6-pre.1258.tgz","fileCount":25,"integrity":"sha512-x9QM6X32Touw3W3BF737x5rE095rJzqQ9KVZ0A9HKI1UAgMI577SwCNw8Eb8CqJozO0hP+UdaOIVrs2iuDa6CA==","signatures":[{"sig":"MEQCIFfLLMAxGrK64DF1JGlOZn8Y9PUZj9NL9WqH8ux5qMRyAiBKWAuC4X9k+F+NC9h5INIHQZQe2sb3yDsL0PeuOzmDJg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJezY7bCRA9TVsSAnZWagAAsUcP/1ujZINK8Bx81W6J+EVP\nCUe1Vjg8695PK9wvu+6RUqozMnkQsyLciqo1qgh6zDL055ehujo94THctVBN\n/z4TJRooipawyFlO0ZBZJgsZxUR+uprKqKmWPlCfSwFVksDupJFKjUF+xD0I\n+Q7nlBJ5DObDsnuYiWVnG+/UmNeM9R4N1YFTj7IbNmmR60ZDVWw5ePhQLjlG\nd6lB5WQC/bUmk9nwFQa9iFm72jcP03D7rPmjb3sItFoHObSo9zQMeweOn/rr\n272abDE5YU5Zzt66GTvLXMU1mn1AgcCG7IgFhwIS4PARFCFG6Zw+E2pFDETO\nbfGVWQa25/Y86iuYMVNT/ey5guZu/YoxWbBjhnhG08JPBVjVhG+y7sWo6UfH\nhr9hdiEtbEpFGhxU6hyrYnPGpm1ZKiVfNixDqHiVRpkk+ug4NCQ2LGg299HB\n5xWfAF/CxMRKBzMNlHkBvewFJ5DF3bzZRs6+2e6cp3W+qmOgUzP0r/uqbZdr\nEYpNp+3EjXbAcclAIDJLS0YooW7sMYGVxefw7dK08uXztIfRolBZrSbDaejz\nywbbAsEPQjphaZVb98dBQFtuu0HRorGjZDBj1D7aQrjyoUvxpxIavsx9hutO\ngpvGopbUa/fq9o1kWR6BQu0nv2am/3HYq6rYoAAvbiggu76gtakz9uCNyGjN\nm3ku\r\n=K3sB\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"7d085afd4dd54a4a14a88af6ff3178eab73a172f","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.6-pre.1258"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.6-pre.1258_1590529755019_0.48713657576362324","host":"s3://npm-registry-packages"}},"0.11.6-pre.1262":{"name":"piral-pwa","version":"0.11.6-pre.1262","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.6-pre.1262","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"e59996e013870e89c44e096582264834486ca5a1","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.6-pre.1262.tgz","fileCount":25,"integrity":"sha512-uy7YI7jtDYnybPkDslgeayTjAiYU1RSvVS4mZP7WcHIpBpoNCXQUBf9i2MZK0zBGvKdFO4/k7f6LjWiNbfyd/g==","signatures":[{"sig":"MEYCIQDiS7eB9TyGWmmt31pl9jBIAWkkGPxAo1tgJ2xW9TtB5AIhAPLdMB9edIUiw++ZgSe/NSox7cWqii/IMCUpHCnIQMoB","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJezmjZCRA9TVsSAnZWagAAoNoP/iEoM0vCHeQrak+RRvIk\n/al63BzF4UxncvIIBdNHc5SGRNXCaXj8iKdOLlLhywiHDCaGw7YQUMCU6X6U\nt7tUqoBNgMciyE9iLpkT5EYwvDKPhRBjAwN3CMO2J+uCBW63ApiniXDoKsqU\nmxKDpbuefPRBroGAtE2CJxU0n2HWFNoQAVsa3I4rJ5ZYuLIM/fFJZBQ1hLRk\nUcUc34lBoWHgCYqwIRzGp1v8wM0f3r+ptPuGPtTXr9WfrGSY+v5bLlXyHsJn\ntmCsa35ehODg6c7DyXQnz9hu0gHEVe4xJTtGLpDPrkKdUfdzPRTfgWBoVu96\nM2GDrDOuQktcIa9UmKjF58r8C83Yq1RM7fU8bOauDpAhL2WJVkAdKf6qfgrY\n6DA6sYos1+hzvA25lJy8A8I79w10BNvUG/RXziOJjiv21yJglN5pOzq+uI5L\ni4xhOOMKJYFVwm/HdmibFxoyZXZgPlFL6gRVu1wgNcuTO0kZKvM9v8rGbLjc\n2sTrINU6ulZQD2IOZ+W0I5ZdA1ULSgDgy0+2cdAWBvD0Hint88ckVj/6+l8K\nnVCFEs6PrExBinoEvElDO7C/rQS5eQs94LJnAhqWfJYdiGxXELjcyI+hqY+a\nNyIhp0Ym5KLJzOBRgYmefSkPK5da/UOoNBvThuelQI6mLAnqM727kMhf4UGZ\nJ0Hl\r\n=WvtV\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"57f96952b32108c312b6179ff23c85684f89a08d","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.6-pre.1262"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.6-pre.1262_1590585560764_0.6033549891785952","host":"s3://npm-registry-packages"}},"0.11.6-pre.1316":{"name":"piral-pwa","version":"0.11.6-pre.1316","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.6-pre.1316","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"75296236f72468fc6d682f2a3f3c4ea812e77212","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.6-pre.1316.tgz","fileCount":25,"integrity":"sha512-7+rkn9gT4jpBlEYp++kiHXGfuY7g9ON5kIKNH/lIgiDtAHYLzNl0StoS8qRGOywU8MrZagRYJoz4kQ/CDOPhBw==","signatures":[{"sig":"MEQCIB7kHXH9hEuWLPHBFC8u+swN19GiOEVluvQjZPRXnU5VAiAw6UYbom3xONpXTE91ZgkMK52RJFhRomPv18rTBfp9AQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe0EQaCRA9TVsSAnZWagAACIgP/3PAdbDYH6IemKgImz/r\nW84IwMF1U215AoiY99kwenC7URbEDL6TKH9rscoYK7yJejiYCCTyUb0ODfaF\n4B0sc/cV10DklAVFaZEwGu9OoJg8Abiy8qOXL/4Q++8YJGiwgad33Kik59R1\ndNeCQi+8/d8BOIWv2NHn6kBtbW8YDsaz+/FAq2dy7Elr1SYlQ4vT86lNpVSh\nz4JskpxtjDzclVaKgQwLle29uKQrg5D82n3Rw0gLVTRF4wpCMzgv3+n7Ehan\nIRZYA3yuMR8FQbfHZfv+E3z1caQ14Bg8qWORJTeeYd3dQSbfyFZeYtFO+WTS\nt4IShaFDAv/g8enaNQlqLnR4de13vG6oD+lMqn+LVQBWFVwQljWEG1iHdP8n\nFDTl9gHaP4jOHVe8dRFdYILPDC0KrqiHVKnIKis6lCHZWHwiLzcpxNODmY1k\nrdW7b705JPdNxMI9xlWuTuTpXAWwVqE1CDCy+J/IwoRP23/V4WTY9akeWEzC\nmr6+rzxasTeqy5qUGxyHz7Y+axEkXtemkSHXCwRxLpmyiVv2cOkOAwchsuga\nZj3s1BdNj+GbmNkQXV4+S9he1BR4xJvvc3ARxm9l8fGcBcVlULXHO+IZUYve\nzo/9nDNCeOKMvMTVa03zeau+QOgS8uLispbX6p5fLQevVVelfji4tIzVdOTw\nyrwC\r\n=UIBw\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"eeb85280d8b6c1975c043abb12dd2436ed409fe5","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.6-pre.1316"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.6-pre.1316_1590707225320_0.8705477534746573","host":"s3://npm-registry-packages"}},"0.11.6-pre.1320":{"name":"piral-pwa","version":"0.11.6-pre.1320","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.6-pre.1320","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"e8281bc6b14ee1041e4ff815c248dec207490a6b","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.6-pre.1320.tgz","fileCount":25,"integrity":"sha512-Qg3aUkajVqfSi+XPt1HcctJpshtD1WXi2YP6VT96SWv3TYZBD9DEm/2Uh2mZKMGG4wDhWvD91S92kQzElgJPeA==","signatures":[{"sig":"MEUCIQDEhqrxmCvR8ZxrjzlU0vOhYmn/cQAqYiZ2kSvP+i1JVgIgRCMgMDWppfwUmSe9eUPVMuv6uguOVwVSuUM+FapvGGk=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe0TlSCRA9TVsSAnZWagAAeocP/RqcjOxPMMskN9cmUmZW\nOH0GuxhIPDoK3VAtolTdxou6YV7Y55rgjpTKWAY5dLw9VpE/kHS1SWrUAvhC\n7IX39x5vwUluK45hLdw2SaRsHAeAXJ9POKVU1wgtdTvV0Fc5F5B90sKyQAiu\nVfnkxV65kl1y1mLjGJhWu21djRhTCuJmI25TnKd720RBz3PRHQbFf61/yXfv\nLqtakiGBNhsNsXBV2mw80y98bKUGatOi8vW4YPwuof59mwzVM0Srmfl7nONQ\nXFAuEQfY0dnuc/vj2qYzqApW96YNrPA5zgdVSR2YW+dXquGJIRzRwwopBliA\noZgPsuSrJ1BTBIWtwK9lKXVQtusoCbsd2Ddpm37lNKtz356iZXGsjwyHDVSz\n2m6Tve+2VzRabpMGslSjy29PEc2OQGiQqIIhECxsavKm/DGQSirDtfBgfqMe\nSU+Qd1N3SIV2aOOre93DgcD7Flnlcd0nSJzKirO7ur6cfm0kOX7Of2F/jcZs\negZco3fWPvhZ9VcGdtxZNPrEQZulCCaDcFhha9BoH/xYF5g6vMMwpjasLnVN\nLoPYPIdpP8QznDsvMJV15uZaV3rCOphyCt4BWhS2dSPPH1TLBASYgpUxxQA1\nFDIgxiT9p7D4+kWV0ES3xfdjDpZkliAH9zPAA0Y0iNBVxEUIC32VHa5jQ7eN\nFU6q\r\n=ecTA\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"0076e4c666c530008b7a820e18e1817012c890a5","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.6-pre.1320"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.6-pre.1320_1590770001820_0.8763199041364731","host":"s3://npm-registry-packages"}},"0.11.6-pre.1322":{"name":"piral-pwa","version":"0.11.6-pre.1322","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.6-pre.1322","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"3545bda2b9173831a7e75e5f9c105064082990c6","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.6-pre.1322.tgz","fileCount":25,"integrity":"sha512-6fi0pVNORWhKeZJRrwnojOmK05K5qrsCsoh/NFaRGI1h/Mi4ePJCaLmgW7GEGCjDmEVi2gokfH3FB9IWubT1cQ==","signatures":[{"sig":"MEUCIHFiX0qfvd601Dylh8SgBOMapTMfQvds/xNtRp/6NpYFAiEA1vbSsIG4sneDZnSE6KsPgs+tOdtdeuseYRvEXmeg27U=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe0XSSCRA9TVsSAnZWagAANgIP/2JuB5neV5nMOCfOXAI2\nF8zXT4ySj6PZFETBZH5g/qVjn972UVsehGit0RO+mwEqG555GmQcoyaU4uLE\nYJ9nspK35WV+T9MGjd7omZNjkZ+e1m99JY9aNHD0DsZ+BBWUNN5Z6lUP3KHy\nmL4mpR2B4WLsrkSMznEo42FVSnkBHE9/2SIUDNdS63NBFxT+TRE4mllJ1get\nmDpEnXfC+T9htQ/ly1xRhYEtOlwEACuSY9o/neRmX1RvGj39HGrE//ZFzrdf\n9xpqBvx6laqwF74UHjcoZEeYqWHdcUZnYvn7JiuPO088mbgqBWNgnADQSqcy\nRVXdIVR8+CJ08NNvLpufrePsy3cEHrhdquz1rc8OKBIID3U/SvVTatLyNsLu\nMbnXTuhKE0vo3/JcC/N5EiKBvoDY4lmPMWBZy813EJHifu/x94A8utKe/UJ8\nRLaAe8D5lpGMsRU8sIwpNTBMSdjf8F+4hoBiNzHrt7wYuCDyBseJ8g7rtRCv\npTlCrkLtq78lLaJQpJ45YcnVxh13F3w5/czAN/Z9Lao3xY4VISQCSy2Hq1dk\n3+Z9NEjTtb6LIfjwYiOvIr7WFOAgWCK90B46vXpWpY6/U0GBbg6cf1OoItzR\npf6YSY5neMYxYFzNvkUOKx5PO+1DW8LkoqWy9HHLCbIK16dzFaU6moaFgQ0l\n+Yqo\r\n=S4oT\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"da50b6a8ac845981a5c38cef9f86d1c400487648","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.6-pre.1322"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.6-pre.1322_1590785169796_0.3423498881817053","host":"s3://npm-registry-packages"}},"0.11.6-pre.1324":{"name":"piral-pwa","version":"0.11.6-pre.1324","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.6-pre.1324","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"1556a6a88f8a52f29956b353732263478f177608","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.6-pre.1324.tgz","fileCount":25,"integrity":"sha512-/a2IkyyvJE9G70KQlkDzCyrEVO0oRkMp55jMooPHngN5TEST2/r+oZhI6/7GO7I4Ge5d1H8WpfPoQWYZ7Ukj/g==","signatures":[{"sig":"MEYCIQD6OXl8tA08nkTnKXVMg/CykK6hBMShH7ZA/Gc8vYIAvgIhAJMIB/kvnMn813srATl5DpvU8ycMcUCaG62wNxePesif","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe1fMdCRA9TVsSAnZWagAA9fUQAJkTYd95MxeZlKTxiAZY\n+bw3Yi3m+MwQqrFd0KGU5DaFDgj+df3gdwY97QJf72aaSWdiuXsHpNjXkh7K\nHqv1ZTFP9Uwab1Eory1OFjh4C3DMsJ3pFVmgLzZxHSsFcWKKIeC9+eN4avY4\nhKL9wdJsfWBKNbYxF3nC3y2kiF4fEx4YkD0aytJlrJ75X48obGzxXKw8umZJ\nXWp8WEf6tk2Bb96wvWd//Q7JBV8zYzPFEl0/epPW4bC4MmtCy7m9P5wmpVsK\nM/PK28+FLxVq5v0nWMkMNnPQg2iBXBlp6X2MJ6RRBWK/351Wby3YU4NAX8fK\ndW0PscP1aLhYF4AQpDJfc0KAim75LbzkT5yiIW4NngQpHNMM0ybn8IR6vCeP\nLZn/Fx9z+r5qqLpwgEVKPqCxbcurnfh6SA1TEnxDY6FF9NLFkz7s4pyLXM4f\npyC3QfZbLGOiHi+AsLlU0iG/Tr7aJsHQKWx1ZD9vi4VyI/oO1SFvlajA9/vH\ndoZ2sA8Bs4wjSPQB+HMQ/1KsqzhwV8XocIOWIP5t6bd//f4CYSWKX4fRGTDg\njDYlSEuFHgf4ZiEVuzE8QG6N85Qfw3SwYGfgcLEvFzqe18AGDVLaK9/SZmcg\nBI5Sv90j+eiGoKm6hJMwP5yIISjKaLdmtixUGOn0ZaYMwseokE/UGSJOL25p\nJATQ\r\n=oxPd\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"310e40de68efdb9b25af6326ec0bf156c3ee9c13","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.6-pre.1324"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.6-pre.1324_1591079708725_0.0593342685557412","host":"s3://npm-registry-packages"}},"0.11.6-pre.1357":{"name":"piral-pwa","version":"0.11.6-pre.1357","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.6-pre.1357","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"73eb5a5002cc7bf2f22d0d3aa8f5241c2b9f5dcb","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.6-pre.1357.tgz","fileCount":25,"integrity":"sha512-3XXXRC1RixIEtKIi1kAJp/A+l/oGM4BOLORXXAD0xrrMlAyitEPB85kTsG1JDkbXNkK/PiJX+Xd0qMfqWiT37Q==","signatures":[{"sig":"MEUCIQCKjsvJWYpAMjSue5C7SrUpPky884q3Albr/EkreKZdkgIgdVUTf/PNWIPZO4zeza9Rv4DVgglC6B+wUAaSnC9L0Yc=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe1mPWCRA9TVsSAnZWagAAaZoP/2OhAcM/pxtFu0PvcjDH\nLEQDj5jkC7/x/bchZN16LVyequC4vnYd8lGEmS82WlRz6/4b1Lf87EN73ya+\nI9ICLx84tLn9QCVAhefXysWfyMI37/ru2g3iHmGQ4bHz3sQct1/DBoW1TH3O\nONPBMUb8KDx4AypPN8fC3m40SX0ceudpWpsGoe4WC/BsERF8KaGO5tmJmPGP\n+seNkFhatFhpft4QtoerRmmGhyMW1lzQ96czFoYvvY8uBAapkZM0coraN3R8\n1wZQmilqKqaAWKbi5IUyoqXxi3zu2IDWdEo6bEB4ZN3bETclLCiX1VvVIKq2\nrSACA3b6f+hwaUslpjajMl2znv1xqu4yK53cr++PSnpkRe9U94xxap4t19Cw\nMqr2BTsdjZlSQ1oTFIlgpmp3a4n9g8GrAfwFDK+2gaGzosNhzVdFFyNc+g5s\nHcHIhr/0XwESpeQb5kRFd6oJ5zaNEm9hs6kIh/IScG6NfS8C6OAD5GZUmVLy\n7rtoVHeeLdvoI6tXtAxlwyfmG3dlYV0War3LuJufa3K3mieuz9ZcBL2aQNw7\nmJTu9RRi9wT6+AyAPXqUpwoGcFpclpF6Sq4zj9+Fs8VyEd3FCEcFumTUWffg\nX8CTTr4rzd5H1R1g6CvEKeWmkyI7hv4Pjy45wONZJ+EiD/8TFTnZRaVoWTzq\nyUt9\r\n=nLYN\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"12666232b5aa8dbdc1972985620f4efae5c1459d","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.6-pre.1357"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.6-pre.1357_1591108565697_0.042105453018629335","host":"s3://npm-registry-packages"}},"0.11.6-pre.1361":{"name":"piral-pwa","version":"0.11.6-pre.1361","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.6-pre.1361","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"a4f6f1fcf8e103a15eb594f7ef710950b4c5e252","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.6-pre.1361.tgz","fileCount":25,"integrity":"sha512-UvpjB0djUFzgHe2p/Cu7f99homTW7v6GEQbzyjp1NhRQmpctFQxHgB9TaeAzVrN5SDGHQaE/4rf33k5gI4jN1w==","signatures":[{"sig":"MEUCIQCSJcRn52o2Fnu+bke1IYwPsVyYtWZJG4h3XJSwdi7ZLAIge8z1yf/BEpgkowNPqR354PJkgWC6RNw7ms/Yk5xtmgg=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe1m86CRA9TVsSAnZWagAAXkIP/RszozTswT7OqlA+uNrI\na5SpsDv4+s9SKvHE0pieDU7qAgTqvetNwo3nNgaR9V+g8H/+XD/4cKlzTpuD\nvsNf7u8Tk9u7qBmj9YkFww2gRPyABdhyJWsGsUyEchBZs/MDTMvTfoIWTXBu\naLxXR17S1M4STOHLVukm/U74LhZUHFfa6ndJlSl2+GHT3jfb623YXsICec0P\nkSQ0YvOO2skvDBGYLVzIbYXldqJs1B0TrIX8nMizRv3fJpa/1KFmA1XnyAzq\nojnpCcI9kU/mICRj9V8FlqS6OQtX6sly8ZcmXZ+M9/eg7llirDoxpdwySeL0\nDTMTlVH8EUOzOC4iyS3v4Bpt6SXwbVuYIZS/elsrhWBzwVbu1OLPRpfmu0ik\nop/G8ogV1h2GPTD6U8CFAakm78LsImrOhD/lqfLxRJY9OMy/bC1meUns2S29\nfw9tBcHxiDv7+UnrRoGJKy/9Cv2Jy+cNsD91zYz7aThlON02LBIqrNsMi+wb\n6XYDBrdHOIunktfh1HuAhjbiBy46n0HabtIEyVC7rIaXMRPe35plA5nbpuwo\nvG26u0MdkYiYSGIt6evs0dXnwUWS+G1c+XkKXzW0buaH3l48c3uflcJMgmPA\nKbkOuo5iWwvMw3AGIRcBfePeFeO9xkdPN530CCCcwunGu7r19+P9A3Kj34wL\ntXz5\r\n=DU5A\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"3af9e744b7700113ff35217fa06e5c2e08113c4f","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.6-pre.1361"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.6-pre.1361_1591111482595_0.8480606916027262","host":"s3://npm-registry-packages"}},"0.11.6-pre.1371":{"name":"piral-pwa","version":"0.11.6-pre.1371","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.6-pre.1371","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"ea30485ba259b70af70787c69f373205ce03a59a","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.6-pre.1371.tgz","fileCount":25,"integrity":"sha512-QpGM/PbFumKIFAsBtScMx41CRrSbSTs0IxcMITLJjkBrDVktUWatFyWLzji8NoKvdxzgX1bnulK68tFzb9xvGg==","signatures":[{"sig":"MEUCIE+QRsaUGwKjknogUV8KYUMLpstYeZAcVyS/HUn6rBNlAiEA3xEFjxppHhEVtG3qsXBcHOgUw30s4nuPXvmEhsiRYms=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe11DaCRA9TVsSAnZWagAAp4sP/3wuqbYU4OuejEV+kF4l\nMCjQAwO6EzmpZpfGyilr7mGqW5pHtrvbLH2gxCu+YDu3ms4eQt77fTVS6vQ5\npfHoNVz8g7BOY+4Xk1mzseJljdGazygOww2ruQpyZwhet9G+w3RmqKPFa/Xe\nBq3b+W5QJUhXICycLPb9vlcOSXjj4coN9neKSMs/rxkGYuxTViIEvhWEwvuV\nnIDiM5WJZLBBa7rohAwHE52X7Cr4bloFzvhovujWeaXLHFr8pVhO9EhTIJ2K\n+TmGXLYD3cNKR0tNVmcpI4xEBMmwG/DlxyyjIudfQDR7V6wj753bnt/6f9oU\nM0tylWpO/k8L145J62FsIQ6kLSsKsehNDRGJ7PXqUy4wBJ85WWyesUr+dOUP\nFLooNbVkYGqzcIzTPAEsToUhuHid/8m7ZkVFmBOOGB4eKQPNmKq/fgTlvWGG\nipmJlfxwel3SnKniw8zTqxUMPdkdiBE14XSjwnQ9NEAAUW3DlGGI6YuFAlrW\nNl1Doku/Isfzws54m35pz7HSBcOoEpoVKa83R6KXogUuWlDDNhTaMUZ/TQ0n\naqQX3+ptH3M3EwYTBNXJM8PS3A8m2AqmvDDP6duuY9pQOZjowvG+ruOuv9Cw\neL7JV6mwMgEH5KDHB1WvijLDl05Hp8h/R/ZLuVKQmxSRlfNcjN+tKqnmVssg\nXjjm\r\n=h8jm\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"03de236167ab3eb62fe565fa7d6b4e2704ccf1a4","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.6-pre.1371"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.6-pre.1371_1591169242340_0.026758720661802293","host":"s3://npm-registry-packages"}},"0.11.6-pre.1372":{"name":"piral-pwa","version":"0.11.6-pre.1372","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.6-pre.1372","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"3e98ac94cca1461d85d59da3f75514c34580b76e","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.6-pre.1372.tgz","fileCount":25,"integrity":"sha512-15FDyftRa4DPrD4jn6MPkkJZ9W5BezhWfXW+wSIgFG0180ToXeQwH3/qBOFL8UqyKN7oNLOlRWZNOIuYkbDSmA==","signatures":[{"sig":"MEYCIQC6DavVW2mlN844C9NlJL7RtLyg/+Te8USmtWhTgAlXfwIhANYwfmrv1o7tsu1j8n9pwfF/kC7Gbx/NFcqmP15Spt+7","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe11V/CRA9TVsSAnZWagAA0TcP/0E20JDgHDaiXRNiYWz6\neVRd6pXqdCrfT6iVD8p2bj6LlpBF4/AzY17MLua73Kpjb4r6yVDjrBe39JwO\n9kGpyAOPJgC/jTiWy7Y9YIPGmKQeBUR5/U/3g9jMKoQ2oPWRFCCR7EE428pr\n8nS/uFAAdkPPUMtuQqdAbNXw5O8xtSE0Ovcmgl19myGIsAjPfyMk0s0a+gr4\nCzqSu978nDCtbyS3O/ux4iSWF+Vd/4zI3PSrnUYYDFo+mx6wQ42S/diZBjaG\npNlgfbqRM84zqOd44faTTl5hhPnAJBcSSZspVEiT1WtNeRSLAWd0tJpib7zb\nFAiPDBxvWT5z+E8puc+Dzyx4iAX6qXn1rdzogL/kQvKnmSwKQWUzGmsKrdNY\nO0DMAEBEI84TPXvwNDEo7cGIpi65tpLUfQ+nXLow1qNtGlkxaSWKDAUnNumY\nBev9EawKey35CyMxmSgXqKiL4i3HA9j+JWELjOfmoY0T242QvWsni506J6Lu\nxpqJYimf1CXjlbYmB+fz0aWhjZEL43iZbRhCFeubkt+b3Y/rNZpiGpY5MqlL\nxNmeajYXsLUcOOZUPLr5kIGLNeXZVTRCy2l3oGReouFf6XcTT1NUmQzoMuMU\njttxedNBDwASXG8D/NTfKDe5ni8SqbgpiwQLZ10iduwxFmt4yoAMsU5/2nI5\neYTt\r\n=sNY3\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"3d8cd3549113ddc046ab13bb8086e2abcf1d0799","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.6-pre.1372"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.6-pre.1372_1591170430626_0.6892334524626587","host":"s3://npm-registry-packages"}},"0.11.6-pre.1377":{"name":"piral-pwa","version":"0.11.6-pre.1377","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.6-pre.1377","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"f71467ee64252bbb2f3e6725687fdba404807960","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.6-pre.1377.tgz","fileCount":25,"integrity":"sha512-+9YMn3yYfevgPkbuf2kQAlqfV7CClQgieE8mMWEfQAPVLzJG5vhe4LDOHvQQ3Uocfco9fppc4PcXefDYZLqREA==","signatures":[{"sig":"MEUCIQCCMr3OgJ2CB0Jbep3RAperq3ofTD1+sMvy/whfjIUBHAIgGJ3iPGnQguTHj13gfeYQGqSrJhC5yLDhrj/TEv3MgBQ=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe16MWCRA9TVsSAnZWagAA6HwP/iJr1WSlGFd7rgxbQg8X\nStd1zv1Q2jJORGxPn3GiE+YxO2NvxK23r9+pe3Kg0rt192pH6AqVbfn3tOF2\n7T5CQJ5hikoW3q1U7pbpv0v9Bgcbx7fcDnSl++1YJcI0nMHYX9ROHo4Y83PC\nMTjiMPZm03WoxN7gAVcUSXgzBMfAIM+vqPdSyLeS6Rf/gIBtnGXqPDIbWJO/\n+WSarLKlWzX49Qz5M4EiwxdkYZevowLd9BTkUq/43RRUGQJuwGRDx5PK8qIK\ndhqjUZ2phzPFOEQ+ztOLQwQOpIBEpqXfpkZ5Nz9aBSwYDuG4q1w/HAhUCfPf\nlKQqsKC1Ihp+SKFB/YsgtDYHvPJ5teB6k3VJAkqaByVB43GLBGTH9Cpp9y8n\nl9k6hgysu4jTQOhylY/AFeM9gud0iTNPAFBlOoOKglSPGmRrkFPHoGQEf/VK\neg4Vu3V4tqRH2JeaarbFxsy2Glz7b5PiKOh+4DqcpGmRKCHXSVLwvI0nizDz\nNDp4a54FxP8gVshWrZorYXZiRMZ5oSzQb9XaNceoyb1V7ROOnm33O9LBJ379\nO9NKt7naN11tWoGTTOXlvV0p7rKrssSG1HPzMQX4gV5ICmuw3pwyM0buVKAw\nz3dfTsI4RqInSn9/2lFHRG0LTV5DnxtOgkylZx6EkPl7PGTQ+Qn1RIYA5fkX\nQk3E\r\n=8G6u\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"2b6ca04d37512ee8bd1355b40cbcdc3bbebe2226","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.6-pre.1377"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.6-pre.1377_1591190293658_0.12718251712826323","host":"s3://npm-registry-packages"}},"0.11.6-pre.1380":{"name":"piral-pwa","version":"0.11.6-pre.1380","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.6-pre.1380","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"e192127b114ba1970f32c8a11c2a194fc3c4f021","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.6-pre.1380.tgz","fileCount":25,"integrity":"sha512-DxS9UYkaiKwMJm87JCPhNOORe6QxMzDLgVWf3QF1HetLuGBCGUQ7xwk3psYKBGSdCCcjqIBHggyDctVBhDiswA==","signatures":[{"sig":"MEQCIC7PgO3xHPUQovPZ/dzeN9GnOFER4tXmSJzOjMP3GUfJAiAqvLuXffBC/JP9b/s8EN6yA5/dMm2OdIiIFlOVFyz2Fg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe2JqrCRA9TVsSAnZWagAABR4P/0luzbC3nJbzvygQZxeu\nfreqk42ZSrQBO6NIwxtt4usXxjdfiHZxjFJvaASz+/0r7oLKrNXCkDvQhMt+\nLmYOphdeCC3oAUYBVyXs0pv1qv5LPXFNbHsKqxCu5I6LAYRCFRaXstplZgTl\nIf6a8/rb0wHSZQAuBc6G2JsmbKon1Aj6U+zfSSjQ3p9c1wKtkn3L0ROczhKz\nCzPxp+enG6MRWp6x4t4MrKcA8ZV00iSyq7SFpho60lgwJbo+Yd1kGnD4MmOc\nAWfTj1TiUJHC9ISNSCt7LOWxDoQYmkjgwdCEwKO/AQOKSKOpnU+OIZmpbodM\n91W1FxANPVH7HBJOueXGjkTj1+ywwZwHIbBA23fNIuEZ/LzgWMyVR3mNN3Pc\n5ILk3G7T4HMHgOqq2/W7E8V17ZCzo/ravd91QZ9LYLJQW0LY+oyAEiA/esQd\ngiK2qN/M7AVlNxBflI+XYUCL/lEERykt5iGNJO2d/aqO/MNsmbJHshnNGNYz\nk9Hr29KdZ3UGw8x65rLW0gjtzJeCTTeRKd7tbm/NYCtdnFF6Z5A7bBlkWsdh\nXnOAUih3Vog+OAM2PLFg/R0sE7NpEAO4eO4t7TZRIIKtb9yGTna5ialJYksx\nulohGTRJ8pIJb13vrf0oaq1+OMhVZcd9H+U9MJP1wNs0wQh/FWhG8Ne44REv\nD7xr\r\n=QToj\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"46e964f9f287fde8db3f319434b9dcaa439abafd","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.6-pre.1380"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.6-pre.1380_1591253674912_0.7272973867998715","host":"s3://npm-registry-packages"}},"0.11.6-pre.1391":{"name":"piral-pwa","version":"0.11.6-pre.1391","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.6-pre.1391","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"6ce16ed6dc4c8a44cd6796ea2c50639e9a9001e9","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.6-pre.1391.tgz","fileCount":25,"integrity":"sha512-wGhleT7zsiCl029QBb3iIX602Gcfx8RW8qIfUic5C1ooMXJoJp9iut4lnd7AesrKMxc4C2fSag4uikBHetP1TQ==","signatures":[{"sig":"MEUCIGhzeEUuHfd/B+r48YOsOsSSL5bYpue1KqygdQcKGrLQAiEA919jDK4cqPy+IISEECLK2BoZ2X5vtuGUQNQhccvMjBo=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe2tEHCRA9TVsSAnZWagAAtOoQAJ8niovI7rxb+VkPhfyG\n7KhR0ZUhhdR/jezrRCywjnHKMUV1+LTBoQbO3SipILA3qXu2+E3/Wk7xPfbJ\niJU4Zz9843N2L/8qt4b3RaiaEscytOLvFVSPPh7ENoa3UBymjg0lGffkOECV\nJfFgCGSdR+1vdGA6HtIUXBU+grcUfFP8mFupfD1oqQkUfECkDYVdsGJsZWBf\n+CflxKWCNM3JtnX1/4fLaWq8QGdtYfFuLSmlz7NE55VVRezDZ+C/bFJveXFe\noW4Njrul5n2T0FGumMY13gNziB/9NRZJgPZStbS71J2/3ITFuaRcgxrLoDpg\nQe/HjfV6ycPjbK7usLndYLhmexM1RYurBQrfgM07SFKPaBe19RAAfIK92HBt\nzpyBekgT9U9ytdxmiLbmuIUmJgeVm2bzLiOJ7y2FJykdi3BnNdyCYvfwBtzj\ngAzzksqxbs7dR3pQwW0jSSFGdtD0n6bfp/xkitzv678a4EY9xHIe5aaq+qrj\nytS/1iUWuDifO4/4yXtNWI34sxxHIEdG7haoXBfQbJzaChfz6iyuEN6viUDb\n8HXXotqmT0E7LAKqXDTwEuy9Du1pP/0jEuxrHnw2dZiOKlPTEITQWyetGglX\nDS9YfO/sX2PSd9wGNw0T3Cu5GrFm+4lFOj2ne6CG2PlEUMhenJC3LZ8sIZ3l\nvZ3G\r\n=oK8D\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"39a70ad2cb9f6c2c588f1c1fff536e4d408f1f21","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.6-pre.1391"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.6-pre.1391_1591398662705_0.05362788476186653","host":"s3://npm-registry-packages"}},"0.11.6-pre.1393":{"name":"piral-pwa","version":"0.11.6-pre.1393","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.6-pre.1393","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"92d043d3f08ed9d5acec08ab5ffbde71c9d8a69e","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.6-pre.1393.tgz","fileCount":25,"integrity":"sha512-QESQXQtVjVHG1pliVc6BD16oAV74TmAqSaImzfhl9TG4Q26gjz/3wqErTMVMCYj9a6XGABXUzOzA54kORxozXQ==","signatures":[{"sig":"MEUCIGyWaidSomyraD1C2GBNnUsP5ISa3ArivdE2eH+ZmnZxAiEAsbUvblVb3VpGHwg35lhrOQRiFdUan21tT6iMWAGCHgo=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe2u0FCRA9TVsSAnZWagAAvh0P/j5aZt9LLKcu1IctzDom\nMFt7yGLNdscl+8XjjLJ7w1X9eBWU/e3ohKY1fBHyHyMlmNRNQOnUAYlj16kk\niD9DeGrw1wpyJJvakpwN8RpNetbdCQaNafbUNnNX1sx5nSpmaxd/mMj5GEPO\nZ14rcLElNmiRoSyTnaDTpajsWEPczkYfn40HZMIv1k1B3wi5gUkE1sTntVxZ\nCdaiIg1nBW6SU05iU3nTminkZ5WIkG139keTPrXn75U4/x/0N03XwOr4G/Rj\nA340eUju/MaoYiDVmV3zjy2gkRJlCGGXpU+Q8fuFNe8F9VX/7mgMOHELDF+M\n/Kqin7L2xyvd2946LdOC9VgyDOhXvPgdyNDmmxPirpqH6m2UZ5CujC2cETsv\nn6plHmdmxRzlrS+bwwZERBdT/ev/aHwoZ4cL7klvl0WlPZSXEX73fNBzGf1P\nUzEA7ATceGqNGlSVadbB4kusDpBEcx0A9MlWW6GgO6L1OkQS3gdIlG0Cw92g\n2h1FXW9dqWnO7O1oTCjOBYj54zk/GuIm5yI0nhDg9EokwQ3pm0+pvY+w7AO2\nI1IUVgWGtnrPGa2Hy6U5QX8groYwz7DUnewTmFgVwpzbY3bSZzxyGU8mNfNV\ndSx82HlsmsW4HJXT0UeK1QreLdNvOFuiJf72kOPxZdMjoFjmt2Y5bL17l39s\n8kl1\r\n=ZhkC\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"33b8cef3ffe2814edd98123de6ebc938390dfca9","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.6-pre.1393"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.6-pre.1393_1591405829167_0.4882504294460004","host":"s3://npm-registry-packages"}},"0.11.6":{"name":"piral-pwa","version":"0.11.6","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.6","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"6f837647ae78a7e5c3e67239986578630d9e5fbc","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.6.tgz","fileCount":25,"integrity":"sha512-r3Gm6T6s9Ny5/KcjygUtDExyTExe7XgejN70pDIbcfEzyo/RD2zDoLt2il8WtZv5snxH4TCKvEVxfPV66U9LZw==","signatures":[{"sig":"MEYCIQCKsMfYDEA/tbnTKJgrCzkkaNgqVQi5dfRaXdXPId5PMQIhAId0VVvA1HFkQtXM8LoGHszdhdgSRpP3++Y2L3LI4z8o","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48957,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe2603CRA9TVsSAnZWagAAq9kQAIjZHjZQXoPdokIVTjm3\nmRmtx42wVn7TbrisVg5mlXHH+ORq81Sg9GuSYUm27pj1p5923mP+CYNWPJZz\ngN5KSaGYn2pE8qwj9OXV4CkHlUaUldQJbC/OKRH4Pj7Wg++tS4XbpAfDw35e\nT/APoKM8mXL9UM153ypPwd8nck1auCO5UFf+Dm35cW76mFb2YePgJz+RZDtq\ncIka6VoJlFlWnfauquLdHCz/6oC2nCJUxj2+eqBFmdjIosVHjXejfxHr360o\n/1wYsxh/DIsGTSvRFuzMTrgWPaEzn4/WPRBznrx8AiMk2zgV8NqdWn1HtxiI\nx6yarJ/qmyrhor6HD45s4SiiWDHK9c9A3hk5YH+1bQEuZzlbHXhYv7EkBM0g\n7lolQDLDbaPRALk51uXZbN4TmKzDwJ/X01xpXKpB/pOWhB+dAHoApfshPb9e\nBCxNJfK1o1TvFR4PuQzLcSilmhR46e9A6SzgHKa5L13OUkwot1DspjvnxOiX\n79sdBdKyJ5tJh0yIhJuK/vp8OMUapuMfGSBlM4Cn6FbIKr6pHbizKshblgja\n75FwogJp5D8Z6NkWrg2JFyvf/f3jUs7c6UwL20VJ9PI6XHICq+tJK1YDpZWv\nq+xTI1D2TWb/uhqQ4MKFIYQTyxPKuemC2g46Hak4qNTdBTC+UBByGhQOOVzp\nT1h2\r\n=Lt5i\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"77f45e01cd4c1ecdf3ea49968c305aeb3279a0fc","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.11.6"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.6_1591455030927_0.21088129829768754","host":"s3://npm-registry-packages"}},"0.11.7-pre.1403":{"name":"piral-pwa","version":"0.11.7-pre.1403","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.7-pre.1403","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"e9ea69e987b300f8ec7c627c5a6d3fcb1e403911","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.7-pre.1403.tgz","fileCount":25,"integrity":"sha512-lYJyjLT8DIW6/yrQ04UO2Nq+uqAERO+RNrCqcGn9Rur7stIeASpwvT/U3C5zGKoQdYwbNb45Wm9CXfwz0qYlSg==","signatures":[{"sig":"MEUCIAWSRd7KNsYcP+1IBspvTjqZmeqsnec9YWqaKwcNnfpxAiEA10w3HUTKun/Els3LvZNoFso7cT0lhuxpCjj3zKt3T3o=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe3OzBCRA9TVsSAnZWagAAjZMP/ihYi54e3rGQbEwWsNCS\n+G73YDSdrCYqm6dWzAv7mrHHAh+PR8eR0YO/HeTwnsIJyapSHPeHHge2YFlT\nu6AD21PM7HzNMRta48kwwLDpLZHMd1Zl1i7bqZlqF99lrVbthvHB2XkbJO9u\njGqBix/dUT7YM7dODH46ycgrz99OKsfQL5J87xCS9RVAhrGyyhRAPEjh1wq2\nxaPgo5xBwpHk94KJT/UwStfq4nPTrofNxs6/psgfzVDmANZArhySjLI45KIL\nUB0OlwReAkC9T4gGHLImVFa6aEF9hg5hB6dIlrFjh0Uvz0YVJ3r+74UcFcyV\n/0Jk8wdI2ptUDZnqRAjIjG7tdxT4iBSQ+xzLQ1wSfrYnBHCO5U+Z1iPr7vBa\nASLVQR8CVoi8EYlaMLp4CyRkMd37Ih/HIoCOx8dJs2XvdiqcWbK60Tmsxxr/\nBS6gQvhTsb9+LNVb1YJePSGesCHeg+Y1g8+KIYWooMy2ShyOZk5m8Ts4kP/N\nXoXCSe5mtK7GHKm8f2WnK+mf5iQx+l/24xNO6ODQJN2GeH2XNNNKlArsSeqn\n8LiOLm4YlV0n0tApSSWYxS7U58ZM6HDawQLHZVaLdjIiH1Ihgd0hf95n5ys4\nLmiEbzj0GKlChbmQ12nQHNcOqa9+ca7Dc1W7OOVpsVq0qVuB3Sk8fYyW7atp\nThn9\r\n=0CmA\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"cf57c1d8e95abd14d40007893d6fe864ccab50dc","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.7-pre.1403"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.7-pre.1403_1591536832746_0.7382896226064832","host":"s3://npm-registry-packages"}},"0.11.7-pre.1404":{"name":"piral-pwa","version":"0.11.7-pre.1404","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.7-pre.1404","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"d6a999072640d0dac61149b8c1ddc030e9f06d47","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.7-pre.1404.tgz","fileCount":25,"integrity":"sha512-rhlxmnTeXtQasElbdlTD9IOrW2OnixukvyC6mvjYx/z8Si7FbaSmxnvwY31idSHTCXl5ooSA7eiDDcJfdxJS/g==","signatures":[{"sig":"MEUCIAfuFL+/+vxgnucHjbMkHoxsXb0D/jN0CwsX7Zui7R8tAiEArXwmvb/ijSMZU2w4qLQA7P7hUemf/XofCZIZh+eO2xM=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe3RSUCRA9TVsSAnZWagAAZLoQAJC9qeuV6NfJfH2JBCYk\nSBcbdyBWPfQtDcifkB3Tr9XO3HNSRAq/5ZCpTbojpXomhMKa6wiQAZs1UaGu\nbOA0GC8TM3Vv16JKWsK9kGMGWsU6dHfqZMF5M29mfoQNRNAC6An+/S9z+T9+\ng6EZskjShxvpduWUY05NTpAEiZ7M3LT8Bi60pS9T8h/+MkenVaWteCHr4a5I\nqSHNnyG0LlNrsJMEdhTxTIhSft/oRhIju3DNSVkAR47PCXtLZKOYv5/4fF2w\n1t2yDmB+TQHRYz82XAQYNlspgkrDiW+QUuFHPI1ozjbCVRLY8tkGVDV5VwOm\nzN3JvXZKDmuWVo+x+5P763Z7y3/XJicjFzddgTvKthT+EJGdBbTZkyKyu3aV\npbBoH/7PiIvR6I9fIM/JCAfKou18ydrM3Nk5DUCpbLydpUuN0BaracshOY4c\nkrdEqvaSMnCUFKgu7DBPOfjGZwjDohfeIl8IvCO646ODxNTEdAv8oONct49w\nfjRtNhPYqohiWMwd9hu+1jBhXU0S3UtD3HlACRFve5Kv17oo9OWY8LbUeUna\nzuZHFTEXpXYdGP1GBSFvimqkCjR1TZ5pn8TQbNFi+xK24RT/Guq6AmxwntoG\n5j9pTfNW+6HDrTF4BNYiOqMl9+0eyeYK3LKv4I1Bq77Vc+iEYknFL8KQd17l\nueVA\r\n=gFIq\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"9641030afeb37eec2c4edfeb3e5bdd830156fe06","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.7-pre.1404"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.7-pre.1404_1591547027805_0.39840698655090256","host":"s3://npm-registry-packages"}},"0.11.7-pre.1406":{"name":"piral-pwa","version":"0.11.7-pre.1406","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.7-pre.1406","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"116cd528745d0bcedd4704709e86ca4cca542426","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.7-pre.1406.tgz","fileCount":25,"integrity":"sha512-COX8kRfNdFUHC63OgG5wvXTDJNdsW4j3qCSpQ0i69IYM7YR+V/Eie+rHu0wGxm/YiPYmGQuWt8sTPr8l3feNfg==","signatures":[{"sig":"MEQCIDUxmJp4C/0Oy+8d13H8wFW0NmIOnEFXhWAWFTZOuqsmAiAaq7cUQRqiHjZ6ELOWRi8RIn3jG4s8iPklVyRZd3n1PA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe3WA5CRA9TVsSAnZWagAA/dEQAISoQuVivd5vw1z1R0cf\nqS1rZpgl3RGdAWNi7eAPly0K4WywlXXBSz6Zn1ukiBFdiDOu6I6mJQqzfdBF\nWmQFYynxvQN5F+kj26yMg5tA6kHDGDW3Nil8w9pqmW+oc4V1mrlc2cRzSIk7\ngFwkGLuxS37j6nRMfnpR2foOPkUwnjKCZIakGIfVda0tpu1Ic4F+TffAyqh+\n3Aq1VZb5NZs5KLfFlBpmvqQY84XTAmaUVssB6QHmbEDIKTsXWd77617rGVtu\n+jiXFFcDEGiUzyi5B4dqXiVw76ml34nWgjVeqWZ9HbPXs0dxjp6k8+vlSiji\nqfOCAmgX1IgO/30cspfIclZVF9rdtJYYPFcPFPEFgGpd4KzYemIJxtC0Y0YE\nMqZQqLfeyUsjS9b+QFJlO9Rc6wO1PC9oqIsXcgpUIk+8FLJPuoQCXrjU2fsp\n1lBvFiFlk5V19qLjdDgxvcy0GPBRqaJU9ynaeCc8UsywvSxaiXaraxgtPKDp\nHAzE48Ra2hUQJfxBOyijYusf7hdIAWcnqz2ugeWEcWx3ViV8cDVNp3ToWFPK\n4tIKRZpu4ZTqtGug1HlZmLayotm6LFGSdMxf/BCKmfKoFtILkrOjGL/glTq0\ni1OWAAH8OATdZD5GeT16Dg3lUP8qnwloY6/FmVN21zrwReY+zBVvSdamUEsC\nmiyD\r\n=fMBI\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"b819942e913b703141154b98ad648faa4ff2abbf","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.7-pre.1406"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.7-pre.1406_1591566392815_0.7547006773966733","host":"s3://npm-registry-packages"}},"0.11.7-pre.1415":{"name":"piral-pwa","version":"0.11.7-pre.1415","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.7-pre.1415","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"cf7d16c464a8f2073a697dbc329718dc98828534","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.7-pre.1415.tgz","fileCount":25,"integrity":"sha512-cwRH7uVtEw0zTqISNg4ISm1sQNS1cXPZuhS9O1Jy8/daqvyZ/kwRSQQ1Oh73H6YkxnYBHjRff6uZeEAMKxQY8A==","signatures":[{"sig":"MEYCIQDdie5ECi34US3awpI0tlovGcMZetgF8nSJyT/lQ2HF/QIhAIp071GEd97lAOImAZ7locGqce+N0kxPHOe8UNcPNrEu","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe4Ic7CRA9TVsSAnZWagAAFhwP/3Y6mWAHqYRllEaJOP7j\nCmBD84MXn46aNvp6mbbCG6bMWe7ue7Hdt8QujuzPbkFKdIws3LGmfeCP4d1B\nrD4bXo42+U2b1PpRATf8EYe2pzXgmwcOeeF+NcUQ0PJApBsl4vnLtUokAtb1\nCuQaGah1XqyrY5yjbJeOf5HY84c7R5C/dAQh/8sav1ra+YoqvobPusTk39Rt\nKAEq+l36AjJFb9rZZop3Slk826bL6yIHsJDQQD59BnQ2LUUC8llyK1Ue6jnw\nXN9tgiosc4bsQw2b66mzGmFt4hfb5ue2Uxl64xxuWW+iZPktj2t7rMCxOBtD\n7AKKXCfujXbXvK1Wr4ywpZGa8uhrXdyhTiMAXbZJEc/XlHans9dN//VgAro8\nHf67WRHDoQnsBzVWULZx7SAYwUW0aYhtNwrhVNFZDb7tZ1YinjYi0qg7jQHV\nmG9DozZlsRIWBj+OgyYm2LHQAYnFpZgE5MsiA4ggyOOBxuqbxmsYBREXEDfc\nWhY17gWs/hqFpBDGXfkGAIP1U8vBDyPqz5CoKLOjthez7mfItxPOCAMpXNa3\ne5waxIQiIloeQ3EgNQC3UyRdopwbjOXT3h3xyeBWa2GRzrI5mCgYsG0mz+n7\nmwItmUzlmyzBGHxRsS0xZMaVBiA0cYajPLJt2f0aHDvhD8SV5EnX3hvZaFtm\n15El\r\n=WoQF\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"d23364acb75206d6b542cd48026e377c4c34d59d","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.7-pre.1415"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.7-pre.1415_1591772986755_0.3565676078424198","host":"s3://npm-registry-packages"}},"0.11.7-pre.1416":{"name":"piral-pwa","version":"0.11.7-pre.1416","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.7-pre.1416","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"2328112f77f10e64eea82e7dd4c8755651a357ce","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.7-pre.1416.tgz","fileCount":25,"integrity":"sha512-8kVoGrQ3ie7ZvmJ3aC2NS6HLBXAeu5rV58vrY+/f2DgJ9iKbYZi68/BL+QvMxFJ6UPXyuGqay0IYy3HU+2QSbA==","signatures":[{"sig":"MEUCICW0Zau6NmQENnfuGUZdWieTfPeMJ5YpBBf0ZnEc+hllAiEA3vpZCHIFPKjzLOrWpxpfxC6p6lV74idCe2pvRKUT/Hc=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe4J8yCRA9TVsSAnZWagAAdgMP/0/PAdyX1iUQR9O7pKqj\nH1PkgcUhAk/V2bredLhKEIWFf3BEQ+nFpZ0wqbBOVdvqyn2vwojt/ySSj1fk\nmxRhrUn3x0HaD4ji44RSaoIS0PgltzBTRgdH4JABIaYGBMvbTPAPJBw8LgMS\niLp2VWLG6+g1kKmIUppzBk4MowZs6QoT3bSCzXh1nJ8TJvyQtN3//U+/iBOE\nKf2JBYfns2e791ckafp5Bf+yVXSNXIQivJJzAqMSyELydu15TjsaVBTVHUW1\nXJe4CDYtmeOnllDo0eSLm+/RuXCAXS12ANOHT57ZagxM0/X4kdBWHF4ylsQb\nbHxgyYx8xcTRCzHmsrErM7w0CjmuuFvpxKZlbqJT5hreYrFUnvUltw5DJ9Vg\nbl+BYx+i9uiQPxaV2Z+ilbW9D5huwjtQUZD2Cmeo8raNT9i/z0hnIVeFEz7J\nwzccHaow1+eYLvxiN9JMUdnVE286jKZLZ/9F3JoyhcVTPN73s1Scv2XUf6W7\nPaVkf+JGLM+m9KogMoUcqO655Glvmr5KPRXIRUUn/x0S67C4Tq8J0M2eZ36X\nfTV3TaIzmM0XVs8Tl+F08Th3nRdaKwKJIs4jvIh0vm5hf4yDEKZkVAtvCZQO\n0suFUzGtnEgXa2k6DwfzUs1QVRhPUKTmwlgLzkH4vv1VgRTOSZWUThdIoPRa\nYl1P\r\n=SRD1\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"8b42780c2a66b8a76acecc1cb61e072f49622de1","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.18.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.18.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.7-pre.1416"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.7-pre.1416_1591779122482_0.41688217656094273","host":"s3://npm-registry-packages"}},"0.11.7-pre.1417":{"name":"piral-pwa","version":"0.11.7-pre.1417","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.7-pre.1417","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"a3457dc0f82de957be5df12e59e3e74d05b65e3f","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.7-pre.1417.tgz","fileCount":25,"integrity":"sha512-yQJYySnoj0D9d4kC1ePDZTNuTQowpGoxhlFRr80yUALap4OZMjAAW4+wnyI8E9sIUghn1WldKTzWqHy6NpoW0w==","signatures":[{"sig":"MEUCIGsRDwPZobgY0R1juNsuqcqUz92d3zRBgRgVwDRhqVUvAiEAoiWapwVNROjIkXK7G9+KUKoyPc9OUqMhl8uqKZ87Hkk=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe4KezCRA9TVsSAnZWagAAVgEQAIn4mH9r23Knc7qBEYAC\nqnxkFxjWRovt4xsZ5P7G919xW7YZEFkkzMTdJ3/U7TiwRkPxScapCLvJs0fY\nGfj9sQbEVdaCf25fAp9gOSyr4Qj2oYVnLj0d0siImpJTYzrhCVjcd2QvX3aR\nRUaROb0+H6Rw6PmJ4NEtDYNBfZdqfMhmYIs0P9vlHO28BroV7oYrw1WUC7wH\nSzsdHRaQRUp8MnK7qvNEMRpLt+/cfL8oTmMeNAJ0HGbfKHt5PTeFbBVNnwxH\na4lPNuw0rNWZiO3Sw/Dt0XiBmOxmYskRqxa86jHd037pBpfgFthbclsCExjT\npn8JXWJ7RXm83flKWUH5B/0xLtOfmEsedQdx4zkgOiGyX0g9nDrzqLYvEw8Y\naNAnrrJ5An3bos4pkDSkxPQRdpzHvGLBJ8T+xlstDEk5L+S+yg7heaul3Cwq\nGfA7tfTIj2GLYGlRHi+Q+xl69Y1v9ck+L6zAnjUrdO/iGj6i/AseFaR7Xy3n\ncdkOz0FtC5upN6o0oouW8+c4TVMRku0ZHKM8cf0cOcNdVKhbG1OQr+8qoF/g\n5pi5+bjJqfXoV9pLZZ+QZ7zY3tFd5uhOVU4d0Tz5XC5MtqwLrjmDIsrWis+A\n/kpp+Wh/5AG/T8oZDtOOJoQWa8fAl0xvi4q3VOs4CrU3b9+bfQL3IO6h6nk+\nyHDB\r\n=m3jq\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"00199cfd5cdc12e23b981bf3b3849ceb4990005c","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.18.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.18.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.7-pre.1417"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.7-pre.1417_1591781298680_0.34910176175044794","host":"s3://npm-registry-packages"}},"0.11.7-pre.1420":{"name":"piral-pwa","version":"0.11.7-pre.1420","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.7-pre.1420","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"efbd8bc7c689c3526d45ccb3dddb109533f21daf","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.7-pre.1420.tgz","fileCount":25,"integrity":"sha512-gviiG+oBN44gMwfiEknEuC1HCDaBNzGW5wvmQ2hfEq9tnmurvsNcYmVhiafHhIJ5Vy9blRcHhfWwGoPQ8rBJgw==","signatures":[{"sig":"MEQCIBubsAcz0/esUasMOnlXV2qTbiZqTU0AZoHrLIEyZWUIAiBjFNCSiGHJ4C4eF6YlPmZl3JMojVciyu0HIjs/gRIKbA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe4M8oCRA9TVsSAnZWagAA40YP/RDW99Oi8CQb20dQhnZM\nz3QjvMqQxGrf73O3BYvnAhjm6QwZ1Py5OlmJDxcVZyYDBVSFYpBS0F4HnNYR\nXw8mho7y/UIrJFBTgVD2+HI2zlDa5jsPsDxgl4QPXRIwHJP+dXa5cHlCnkvD\nCASPcXx7J77S0iOv3/OxVXwDJytJiuRQ2elaovP2zKTnDDIQZLGIwGCKYEy8\nl3oAyIDNAmnsvQcU8/tuiOGu+6TSMYxjzp752SWCgrzrh1Y2QWLumh6SPse1\n824u1b04LBppbTOzMsSAnjqwa3USvkx2vlAnsVJWRJ+IxwnLVrrvve84LZ+X\n09OISUQKcI5naGPw3bCMZhjxLQeuU4cDBAMeS974oQOcVlpP5HzLz15av3Bu\n8JIY3QQQ8ICMGxMxRQRMST9yJrC62xKDco4t+XLU3PfN4W7fbIvx7id4IKiF\nqagQPnvDx2gV7R30PV+xu57t/3mn3+YlmWm666OUlh1tjCd4ZYWywkcGgLfO\n21vEiRnOT2bSNoeRYDkeAwSleiv8M7NTtt/2twkA9KvXDdCE4PN4pfNtkVaS\nA7/c631rcm009DcpljfDENWdW+xCpOB1lHvOjmRES84o9RQal4ozTmFz8B8h\nw940p16bMlxgKMYI5e3ukMD2kADOtLAJjPjFnxKJG0nZquhpUhrKgJvxJjrq\nkZHq\r\n=tJBK\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"8e7837ab12a56161240940e5b746d6625a826ff5","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.18.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.18.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.7-pre.1420"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.7-pre.1420_1591791400406_0.5245364756910529","host":"s3://npm-registry-packages"}},"0.11.7-pre.1421":{"name":"piral-pwa","version":"0.11.7-pre.1421","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.7-pre.1421","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"4df99e7ad7c050fe1a84d3efcbc70ba2167d78fa","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.7-pre.1421.tgz","fileCount":25,"integrity":"sha512-mMizsKRWRCoPpy53YmjVT7UENkFmFfnXMSu1OHoDtjofxKeuBGpETHwpHNi/UNH63FnKHx77xPIK6TcRU+UF1g==","signatures":[{"sig":"MEUCICf6c9VUQ02+dVoKqXWkJTZnTsqBFxeI/EJ4sZ+k0xihAiEA984LBSIQOTjpOOZO6h8NEr+RN9zjuW2P/bKb9SHlTmo=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe4QChCRA9TVsSAnZWagAADxUP/0x73INxJfdsAi3Vt2Nt\n7FJoFGzH5xEsOgrGFwVlMNklv9pe+8D6CNCg4ybIwajuCCCHFif9aZdpX85t\noLyBGclGur+p0XVCObU/tI76TaQQ1ERqtCSC+QVpVkdGLTCO06paU4aBNuXr\n2bc4ImO21sUytFeUEB9P/UKi0xDJwH6o3FWD4xmPG9PxIXheD+1JhViVuAju\nB+IMPHGULbYCdvCJYdGOMbWTJYKXq8i7WeC/oI0h5UmsEuGVPLolPT3oKjK3\nIQ8ovTlnPa1rm5xk6v0F9kyoTKuihzAlEVVnuLE13vLGAZJLtqIMQf84heZ3\nt/C30GNE1bGfPu+0ctWJxjHAY3kVoP4PR/keqDTyvnoSngjmsToDHdjRNyyG\nGcmc8f+hZe5beFNAUqrMx4yRsHJ7cfcSfwh8JC5007GnwGfI/mxq7a4f9gJz\nhcpotUOj2mFWl18VCR3qXaYQ1mMq2iAxp/kAfUbKk3b9ga15vWrBawJDJZ+s\nTyuyOVTfDHhZ44wrb+DPyj6iljsFJgkP6doGBM1KCF0uGGCP9TYOhOhtPMBw\nbB2xSFDEJFIG3Gcbz/iADvWWRkjkHN44JV0vdx+okl1GXWwRHLs98IbQADZ/\nfMxyYIYVcJVlo+VIyfV8EyUOsjXcHa9j+rzbxdcIzQkQoahJVUUYKDxrHZ8b\nkocf\r\n=CC5l\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"f6cb7c22c8a663f0c6ebc8c6ab05f852a6748b9b","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.18.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.18.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.7-pre.1421"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.7-pre.1421_1591804065434_0.9140944532761162","host":"s3://npm-registry-packages"}},"0.11.7-pre.1423":{"name":"piral-pwa","version":"0.11.7-pre.1423","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.7-pre.1423","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"a7f0e2017eb67511db113ff6e41bcd3f02217cbf","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.7-pre.1423.tgz","fileCount":25,"integrity":"sha512-pFfoGvKnQuwOeKmNh22eTXAdWNDZI8XbxW7dP+H698Qzp4mrBjBAeTBmA+eCxEKIhek/f02W01kVo5Pmp7gL3Q==","signatures":[{"sig":"MEUCIQCcdMWPjnNfEhdv16ihJcGRIwz9m1ey3Em+q/FnsOe5gwIgBijIfgmaHFuUCcPqtevB4Z2gqqm5YSmCy9p6e3rrcNs=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe4yxDCRA9TVsSAnZWagAAZtUQAIj5XuiTSOSsFjl3nPTg\nAVpRfnZhzyUIUnbAl6v6zVxUr+fyIV0PsdSvoYikzPuqvLJdjDx0SqNaqGsD\nfvg6JiTz9GjoXPkGWUY0KxP+MFn8pmgljlNTwYQ6woAYK8ScxubSg1mm9m9X\nns4mEki6DXydEGTU5WsKCasK8thFC+FObjU4vyhVY/VtQlMsUvBa3xqYypiz\nD5y4pwTxvVQLhCyxEQD4SOggthM+mOWjAcNgr4h9ppgjdbtcXc4zYez5tddN\nA6ze/KUO/AS4qK1UTXwR08klPirBICZ/QyeGscAnl8nKEqxvbTM1xZMr4gOa\n7qiaWyoWwA+1ilqsY6M0nGdMPpzCKPfngt0J9Xdc5N8LWAvCUGd/fBawGREX\nx1F4rxTfUxotEyu/MiRgyNr1kt5GZX6LZUdrAhKgDkeNpa1/dv50kJGjFmkP\n/NK/7wRLO0CogD20ZKrc2zSJOCA8RiZZ2UY5C1Fboe8TUVsgOy7ofgtOZfFi\n2m/wXt5WfAhENCCFVN5jm2IDvuSotXJU/0SWRF/2NXKs+LZiAZByciYMSdq8\n0Z7wMd6zqWY26KWdEDRTUbuTGkhOpwYDKbIZLNRR6ck1mkDV+qiZpqVMrzUd\nSgVXvDqz+hMOM0mEE+cp5rN3e0VP4RVIG03jhd0z75O4wWDuMF6gCd9UaGEB\nQVIB\r\n=716x\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"f0e7891a9e260c6d99e1b0418f2f877b98d7125b","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.18.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.18.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.7-pre.1423"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.7-pre.1423_1591946307128_0.559728187401852","host":"s3://npm-registry-packages"}},"0.11.7-pre.1424":{"name":"piral-pwa","version":"0.11.7-pre.1424","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.7-pre.1424","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"4ee72d0425030bb0bbbad0850416bc5c5faa8c59","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.7-pre.1424.tgz","fileCount":25,"integrity":"sha512-eNyi4jSS1wXO2BYPqmkFqiPWdH805HnhP2zbEg+9BrVeDCIzMwklu1IsJKsu4l48DgiFAsdELUS44OlaAAxdSQ==","signatures":[{"sig":"MEYCIQCakLu9bXBkzDKylCnW2nyhzhbJSHBpvAuPeGqVr4YbugIhAMosy87DPqUEW9IuYqT9LWZCPUNNfprfywPm0ifZaGKA","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe5paHCRA9TVsSAnZWagAAu94QAIaLjAOtgkpWWCjpMCeF\ncaGWeb5Y+YIDQILjBmEuBB23IXLDAGH+/6aeA2P0V7USVoF0pr2GT7kl+TGL\nt3Bkj4HO387UMhESSFX5DpuRa8F0n/wijNwuoI/FzFWyM2/+wh4cg+mKKzyr\n/BnwvkDeM0DW7XJUi7hEZOui5q8D4aYSKwtFvpBpGKT6doPD3k/rmS9513oc\nB1kIyuiIA54uh8Xk8BNdF1whXp6KWv4OYS9rZD2GuJODEHIRoOmBMFTDOYGR\nqiXQeSyyJGPkR4LjI6Nnxp3x6vsFlPjaZgYgiJsqR9EE9w43+Gf4yoe4FS9O\nJkKakDeEbFoJ0RRpJjy8JluB6bn1sd6hUIQPLQAxxE+ruYWalsUf5UcGdNy0\nBjs75aYxfz5upFYJpNVspcp4seQaG8RMAgioXksBEVK1njPqaaNyRjcqT/r6\nbUTtsyBWn/rEtaUQnggRLdpn5aMZENosM8AevqObBQh+xBDet+/tFORXkIWH\nOZ8V/20UtM13fed/SvqRtT/LCR6kmBr3qurJHvuOh1OYeNjr7VtvleVHBqDP\n90pDJ7g1YI12OlA7LhwcGavaDCu+4pQnWRaKhmh2lDszoE2cNHQCTxtass3W\npqpfsCn2pJT43I8/86OCn+O0l555RDY8X70o0cOy3AT/WBZ/MRzWQyh95bNw\n8Eu+\r\n=nYgD\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"9c69064a69e8e7faf332a8ab069be006afeb9274","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.18.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.18.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.7-pre.1424"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.7-pre.1424_1592170118609_0.20217617505371988","host":"s3://npm-registry-packages"}},"0.11.7-pre.1425":{"name":"piral-pwa","version":"0.11.7-pre.1425","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.7-pre.1425","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"0a38a5cc0c2ca2f593aec171fe87cdb28737e91b","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.7-pre.1425.tgz","fileCount":25,"integrity":"sha512-EpHx4nIGc7hg8t5n+oYWgnxFp7Ogzfb+DiKgPAs/0yS/ZPbyK88DlfQrMXrzvsgzCfHbiQAXXEHaf9LsHhvCtw==","signatures":[{"sig":"MEQCHxxbGh3VWoWKBCf4N7WpErZKNPV5L/aW7HEDfCqT6gMCIQDvkO+Q4P3joWiqv2V2tho9rUKxq2njC4t/XH/VrotZKg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe52j4CRA9TVsSAnZWagAA1VAP/04sPzcY0zNlTcxvPxUm\nOEUYeDj7lJ89mbKx5/58OLqwqSvEDKrVV/gKlik4ytIWMfBSwcOaGFlVXY1b\nxgy/2fdMwbiHCI8mZznA701ZkXUYwngZI2GK8wPQuELn6VywDFNhGlv2dsmH\ncTPKhjhtRpMxCtHhu8/PuxIkTYBUSiOVwySOQhnf2Iqbdt6vQHY4PXEv9D7d\nGZbFl5csA7qR4Z4WRA0TYUWm6I5kCFYPReGU4oBwWZNlit9uWOLpIR2S+rKF\n60oTZhSEX6eT4cXuEAPl5RdDE/nrDzRCwEvNdorxlOyL3/UL2fE/+PxeOXst\nFBZRoXQsuWwRNI6gvBXwlYAo6bQ0Kd/hi/Rrs4YoBrkCoshUU2b46I2I/fBk\nwzOHBPIWT0sud6tjSe7U39r7x4JmuRHdMq84Td4N9l9o9MWZ5cOacNxaTTKM\nfXvyGn4i/HxYc787BnlZ2xOWIL3TkIRRxUOqshA9mm7I64neKBLXSAYFjQ4f\n43SvhTxvLPYkk28+0CfMMGYGZBck/oroXsFrJH0QvvkQa/M5me8u0EFk/pcn\nX1t1jxHx3jFlY+aGsnfTfIwY4wWRU1TWkzUk/WPlc9hb2jVnIHPHIM6YEjld\nrrJxEyyWi2x2f0ZRFJvi8kGwKSJfXubdfqpI6cEKBPo7CFSMEI8DgAcAImVS\n9d6M\r\n=kUwe\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"1289a0e81dbd2bf9034e53d74a992e488b409a6d","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.18.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.18.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.7-pre.1425"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.7-pre.1425_1592223991779_0.39374202303584505","host":"s3://npm-registry-packages"}},"0.11.7-pre.1426":{"name":"piral-pwa","version":"0.11.7-pre.1426","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.7-pre.1426","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"594f94a82ecd4084cda268417f1cbe3bebe2f169","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.7-pre.1426.tgz","fileCount":25,"integrity":"sha512-R/TFjrx89i+uldfdzmKFpYFxgfUHjn+ePfQIicFM6Zk7gvhCojVQcEPyoRP08JS7ssonOrNviPg+M7Ltu1mi3g==","signatures":[{"sig":"MEQCIFBEwkUrFKSmSmeehAEhidTVYsQ72p3EQD6mkUxjzpamAiBPHaY6T2CA4sTTy+mj/MPZ70EXlWStrOEN1o7QhbPEAg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe6AOWCRA9TVsSAnZWagAAaCEQAJYze3GJU4/oi+w7hha7\nhOLAcBNEKK1aT5g11U5KutAvyl9ZuTo3Y8bQmHEiM1Qls0BjDZSp6Nii2Vts\n0AJxIRTni1RdWJb/tTURPQx9Ma53Cd/oKCH/I4THjSGgAEQ4LLx5k0PjNuKf\nljpHmbReRjNXsU0o3R9Unab+snmFASzrfe1/h6daFu5oA+l8+ucZLsdCLhYK\n86yw3jZz/PwYC4zSQF2SRtwP5OGRQblSkqqCqvZ1w/5q2AlZCc74YzScIceM\nYjPGQz9vcwqRx3ulbY5yRLtjWtBu0to3m4JSsrDiaeq4f9UU+voBV8MfLSba\nbMriNOrdnNQU979hASjQJ9Qv0noWLfFJ7XlLmPgd+HCaHuiJPrhXCLjabnlU\nsLztpkBzfDYFJV/3hsuICdJL25xGoXeB87FTf6kSqbfAVul/EvEirluDzWxW\neNlTQ8TcREun9CNfwQ09fB3KMnQVQxZ7RUQzx/C5Fv9uHoPSUJWbSL7oKGS+\nQbS7YXdjKfaleir52MryqY6kdcGg3rfBJ9ZthrlEr3VuB88jvMVH240AvIDr\n+mp39xqq5sOHhE42XaJL7HJ1oCOQ1Rv43er4v5UjNnXDlH2R2Og6I6p56JQ8\n2x8Fj2fw4phGawnGvQxUQfLIpgTHcb5MA5VtjrOZWuDpZWnaSfBL1raXUNYR\nQrzI\r\n=MRAQ\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"1716378284edcaa468e24b8f88f5b91f6cee4121","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.18.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.18.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.7-pre.1426"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.7-pre.1426_1592263573917_0.11735109812530475","host":"s3://npm-registry-packages"}},"0.11.7-pre.1427":{"name":"piral-pwa","version":"0.11.7-pre.1427","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.7-pre.1427","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"8de707c7558bbbd972c5777a02303b6fda23d6d4","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.7-pre.1427.tgz","fileCount":25,"integrity":"sha512-gKlj286lZPHKdnBGjYXFfl5iAKWJgx/RoFV5Fj6D1oylJDC3Td212VaSJv8paioIIbSeL3rlmma1MhLmj9HFMg==","signatures":[{"sig":"MEQCIBoSNRuoES06g1LSeb/WPTQsFnG2QO21yIFM/oUg+9YIAiBOEpUms+bmNjZ270EM3w78SVWMNTaKlvxMK2lAjBcYRg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe6JqyCRA9TVsSAnZWagAAn1sP/iKQ0/W7N6R/foykCPfa\nBFDl/4aXGZJ1GKlusCbhrkM7cI1Oo9yYQ2H2uix9PaLJXtshaDlfx6KVkZWc\n/rXRYDEA8nybI9lv/gKXsmFl6nI3pNREwm4j3pGb9NWX88Q405HtZHqHEDIN\nfU33gC/iFRTRjddaWSj3zFl27+RnFhrVFDi4YImwCwqgFfOLe1ijKAcULgDX\nUo8Mrytertz4vZuqH/IWrfL+fqcMBBL5FIpz8mcDKH5oeW8hNVUuJx1HKCcR\nM5E/6b1jqC5SD35elN8G5zRWb9rPnmZ2bTr7HNs/agW2E+ninK/oul7YKozz\noO0kIqJescrasB8IQIrxJcoGPudKL++48swcwUfb8tO26TlLENsoJSCuEGCn\ncAYzgWIIbEMC3kslnlzYucnSGEGedqfVjpbDB22N3cQ2P+Cg1LEkP9ZX/H+S\n/FYrf+5hDlwXwlcwKywUDdeiNFMJYSShHZYEqi8ZESWY/26HtuN9nRntuUZn\nhukFFj9EYqGres4wmb7nO5PsRbi9eK81zzV3qiML+ZWaf3lMaYV3ZuHPPu4C\ntl5y8rnCvp6U685C3fF1CdKK0s2178VbiaNiU/9xIed3gAXr67v66G1QuMdq\nugUpv/EMp2U6TI8BGTfgsTLSHLlrRmdLh5oO93MAbMu/y+xFdCFCBoR+hhGS\nas60\r\n=hwUz\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"55cad63de2a3d100b5594513c8c3e3a6e15f6a00","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.18.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.18.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.7-pre.1427"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.7-pre.1427_1592302257621_0.5377359579601015","host":"s3://npm-registry-packages"}},"0.11.7-pre.1428":{"name":"piral-pwa","version":"0.11.7-pre.1428","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.7-pre.1428","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"1c2fc4588001bfa0050dc0eb9a676c687114603c","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.7-pre.1428.tgz","fileCount":25,"integrity":"sha512-6hW0XEFe/ND8jQVoay2RWHAj7h42nz7hfeDNzJPcN+Tg50PyaHXOF1cwFenhj99HTvyNkNFKfUoZ06W6x3A/0w==","signatures":[{"sig":"MEYCIQCyEDAtnvA1+SihdawO00w5SivAtXrHkDezcggcaLEQIAIhAL2nSTLz2Qp7nn1fGjlleRbRa7JHUbgXm2wve/9ozBl9","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe6NjfCRA9TVsSAnZWagAAZ80P/1gebLtRB3mxTwOA1Ii5\nkyAxZHH7sc2csKsQ6JwindaaR+8YbTj8lyO9Vp6EGk/Tfy6OYVFmvLkVBh39\nvZ8dROxfWop4/+NokldZwr61s8sZDQ+A0mNIEznj0ihiKxjuelYL/k2XRecw\nzhgkNJqE2fyD8qdfrNx9t/T1sYjWDXWeB1gfZkTfgS9r2iQO0/vV88H8F6BE\n2nGl8HUcDzJiLAyYmRvpjIbDfoYB0OVuRWkRtdUFmWeB6B2UlNZ3LniW1g75\nW5159RLJ5Z6/tvQGJXztuIP4M6pZr+ZWw04CzAJDOo4qDF6m42bXGRfwdRJ2\nNRMRJ4459fKwPrdb+xPoggqN6PodJ5/t6CpV8J9Xzcn9bdQT//YCJ+DhW5jj\n2XrQHwz2bW0Xzx05jeeT/NWUO/RXUwH/pDRuZvE+XJb5+J/ByMiU8Jtzr9zJ\nVwxNsk0AhgLDeivC+xEeIgXnP85i9ZXERhSIugaRLDm3Dr2W0VVMMJ1mbbZy\nK/2bpnBguZJkTDlsQUurcxgonRg5QHoiGBejn42ZNCNKS+KaB6Yuoiea1hj/\nqwIkMmWfjlARWOSZDbzojwrW6hgH7aHVHjcPFeKdsy+r2sjryN/WKUpdrMtO\nWb/R2kQ9RtUKUJRtpWZL7iGd1SL/k6vQGs9bNvdFCFhkRfoUTomU9bH0aOJF\nX0vx\r\n=Eb8p\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"55cad63de2a3d100b5594513c8c3e3a6e15f6a00","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.7-pre.1428"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.7-pre.1428_1592318175129_0.4654192372113062","host":"s3://npm-registry-packages"}},"0.11.7-pre.1429":{"name":"piral-pwa","version":"0.11.7-pre.1429","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.7-pre.1429","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"27230a6e90fb66919b118fe4283c7b4af670d100","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.7-pre.1429.tgz","fileCount":25,"integrity":"sha512-Z99obJR3LpM8gAN2Xvz2yk87HaU/XSXU3JWAF4K+8QR6kPKBTC0AA/e11CsP3uzlNAGEu9QTXLcBsPFmtEq5OA==","signatures":[{"sig":"MEUCIGTjbxUg8zl9YufxisHWjRD1VDume1l6EXPrc8kedN5nAiEAhe5JdhMFYVIkNd4jbR4Dojj0R7Gg2tMyaLoBHYn3M1E=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe6S4FCRA9TVsSAnZWagAAn68P/0fgkcv1n0p6DZgGteDg\nIlw0lcTvrVIOskvjrInt4U+b/mc12bRb4T2Bx390XZDjYzTL+sARvJ/paiFh\nGQTtxat8Q8QLwxe8+T2HcQYkTdUGxqeClJIy33VcH1qrVWmgJyeaTWKTZupl\n7VU3sUHIVInDITyesaD43eWXPLGORyfmKAV/v8smhxZDSR4GoHBp8MbB+682\nW2NjTFQGlx9a56rTw3zDAlWdXdJFoGiQS9DsVka+LwvtWbBKMJ3y2faTJj8E\nTwiL7V8XxyZa2FejUReTteqbRZNhTSZ6Xol9+cRR/CxcXOc3bsUS84lk6G55\nbcmjmS3RIsQOga0p+vl0Y+K8eZB72IlJI2g+BJSLP68HB84gDCFk73VDK4Ey\nH9QiVpedBDIw+XwSNOfrCk6V1et4dw6T3KaNFfrqH7O5/wd976klhBENCH+2\nlUW937jx7odpNFlpdY0PO8K/Rigv1Xy73ME2YBOYIQ3u5ECGB+2Mpe28mXrB\nknZt1YvFtEdMZF0nymdxfYSlTvdrtu6hbMP66/BeHDWhaUfvwfshDgPBaKoM\nXl2FRZE++55PAgs17sUE3n2pWif8TFWhLT0kQlNlEUfOG0q9P7lacD4qrpzO\nruEjcul/GuW2lpPfqRtUW7qWKOi2PRycikRnuO0JZQzo44eHnSwgcFDN9FJo\nNyx3\r\n=dKBH\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"a90898fa14de3452eafbb4642df2ab3bbb49a7d3","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.7-pre.1429"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.7-pre.1429_1592339973204_0.8019805165477312","host":"s3://npm-registry-packages"}},"0.11.7-pre.1430":{"name":"piral-pwa","version":"0.11.7-pre.1430","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.7-pre.1430","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"7f459552bd1b0f87a4d3e0009c1d1861af8f0d0b","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.7-pre.1430.tgz","fileCount":25,"integrity":"sha512-gB8xzTb7SGQ6oTmw3UwAox5Z0Yx1Om//GwhlkHJNId1AaWChVPw7T5+6b6G0pUkM1e/dBMbTLcqkpUYifxwJOw==","signatures":[{"sig":"MEUCIDyll6xs/ez9f1JfP2LR++M2w1r0kIcmv7CuhNubjalUAiEA34MtYweCo+Ijncc1itMRyVFWl5HpKVeIDgYiLqeneu8=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe6q1PCRA9TVsSAnZWagAAp8oP/iLAspVRVRTiieZDf6Op\nNL9skBVXA1Lj+1+spdtjVKczRiR1gGw9MuUCrKliHdRzBNCtJZpjwUjVvlsd\nGwdRcB9JV6p+nLTD1lTAo9kDv8CemCJUGPvNIwpF9XS8nAIqRPWMkrOsL4U3\nvwOuSlMMabeN7bD3De3IJItj31MCf5n827JAh4LBCcoFX62eYJNeGgBN1XS9\n1/c7MhBtjKOXC56TOWgu1E7bk4JW0Y/3LfLF8IBCyrJVc62tKfLSqGP/3fGs\nrGgFATYIIyYrdEQ7leIoLAfAXkHGpYqVL+oeGNPKjja6mXGikYwCk6qLwUgQ\nUfPcbqJbpMI8MF4w4UbEvJbeuBb19df+D8Vg4FIusUeOb+mhWsuK87LspTlC\nFtlSXjOU0Yv3wlVtQy8DP1YxYypvfqljW3y6RVIe9gsBvsZvL4Jy/2L12Mng\nsZmZSlQCyb8KgMORxAlzzyQvWUvFoasJgDQg5+iGPwylZVLUQHNNR9xwjobz\n6UmoPGdNux1MQRqjqqM/Q++QaNe22/qaA3DMgyysQS/1vvEfZw7krKHsZZFl\n68Rhqj2/OaTzCWP47gsEVsN6XvteNiMCNtECzzXZOkA4wlBCQECq1lJSHdn/\nTn8/PkqHdd835iGsaFIi/RA/TweIJgnmvdn96c1GiWycGFog/X4Qu2U4G6Ww\nlJ60\r\n=/u4s\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"dedb7a52ca53e7fb8ef62b6093379229bf2f6c5f","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.7-pre.1430"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.7-pre.1430_1592438095236_0.6271563488577692","host":"s3://npm-registry-packages"}},"0.11.7-pre.1431":{"name":"piral-pwa","version":"0.11.7-pre.1431","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.7-pre.1431","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"2b93a4bd57b10647fdf56807f3d4dad9865b219a","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.7-pre.1431.tgz","fileCount":25,"integrity":"sha512-Vs7U1oj1Y0J1ZcxIcNshGg13HyPMbLNBLYgy3ig3bZGpHs9LBMAstOaw2CgjzxwfynuF45WaBelj+HnVkGWD3w==","signatures":[{"sig":"MEQCIGyaJp5TE77ibUWxwJKK1ZGOut5nQ7GIO664Z8Sx/Sf9AiBa78IoLmkHkZ2UKnhBPIjG9y5Qu0S2G+/WkHkJ4PeDHQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe6w11CRA9TVsSAnZWagAAwyoP/izNIyQauYjbR3AlHERZ\nh/ju01JF6iGz49InNpfP2z4/zccNs1at/AZy5d2kYDu6SqskNcQHuqCNMMb7\no1TGrLHTzQJlPY+J5/ey6wl5jmHOeYb4PpMymTSnlxaEdrrxnI8t6ehG8Gan\nX+/JOvQVpPzIw6fhK1Z5QwmJiIO/7NLuJcQ3MN8V6K6GFeo91XuGh+/lDr07\nxsqwgdhd/caLG1ZfKyxy5g4WkVtFqs4Mhiyt6C2QgE0vIARFYUo2QmYOtz6w\n0GVQSZbwuBN1/qsFTFKm3Gwua1YcdaD1oavZCjgQkm3i21S3MiuOiG4q+qIQ\nS+Vyg8gQijVbuKRlJfcNw8UNsUMcLr+vkf3IkFvMlbRXVTK5Dzp1dy+wu+1k\nD+DUPhncTLJOn/pUCkYmUBGw/MRhW6ox+vYZ0BpDClKxwQMSncnHOV9j0StG\nw/DTwMlPBx/n8XDm4l2J7TaoPX5Cf6Mz4UIAJAcOi/8ast+nSEb/c5gejgKz\nx2USjMWsODxp0pwL1NLWXTcVMYr8+gBijaCpioQP48vjmHj06Ru4dE2jEN9V\nqss9goPQSe97AN5e59OZ+sIP/gLW7avKtZsqHK7Ftgeti2Vdlpt8mZgJKMWR\nTTVc7tqGdz5kT8iNDmHmsrwgByFNRQVGkWZ3j0GgBZ7ZXZpLXaNzItv3hs9R\nSSR9\r\n=+EH3\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"808520d8a271ccf48d0d30c390ec1b678506a92f","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.7-pre.1431"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.7-pre.1431_1592462709495_0.9980527505583745","host":"s3://npm-registry-packages"}},"0.11.7-pre.1433":{"name":"piral-pwa","version":"0.11.7-pre.1433","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.7-pre.1433","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"140491bf54fa1309ba6a0316972b217430e0af22","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.7-pre.1433.tgz","fileCount":25,"integrity":"sha512-RGcw0X50gAH1yYY2cbt5H9AILt2qtSCPcLfADJ42bWMFxKBVaJz6NVgpt2oRMoh/7Iv3D3ipS/n1jW+NlTHniw==","signatures":[{"sig":"MEUCIQCT7PooHZC0DhztlQHoo7sUho8zhNGutbqqMzaSUTe5vQIgAPARPX9u34oYN7b+7K/N8gzUzfWjfXK+4DVffDnjacU=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe7CixCRA9TVsSAnZWagAAupQP/jlG3Yh/slVblcqETUtl\nyNkxjsnFIyLMmJ5pQLhQplsJFu9b7bX+YBc+bVhuO0O/YfdKBquAhkjMitMG\nCS9rnBzr1bZCTMeTafrP1CIS2WqkAvlwNuUJDZErG6zeW3+ZzqBS9xXi23oE\n8A0bt+IoSrkFt+42l8ohZDK6DvVfOawjPXTfK9kAHgv5ZEyJpYN6GiJXFpru\n4AkLsiqPry4klSHQGYOEEo8B2yYJmb8OP1Ylfxwvdjx3W0RG3i/bRerX5vWe\nVBd0jp+sLl2GFxMALXUR+iRH7BYb3L2UyVg2IeqpxVPT7nLzTJV8qlI1YoyB\n46qqypBPPOkVTVcFFQuifCKWO0cXtwXR5631ArWsdnJlxIY42wMlw7mf4VVY\nVRxy8r++D/PLiPBkm8m0ewBSx/M8kQF/u7Nzeof52Qdmnt2RO29B9rkzAj4D\nnnWZkDHQfudvBfv2Vnrsj+fvzTM1iCE2fF34RV5kubuXAH7UB1FLXoxkAUfk\nk9p22/Xt9Zp6yONgZFxxy3m6ktupbD35SpWrHrK+zbED4N54k1f+FuUEE3gM\nADquJoRSvIE1pnBzY8EJsUdhnvP8kVPALfa2Fb7GtIRbGvCLhjNwE8toQAyx\n1WqMobl9wobT1e5fL2vgVgBkQ4q+/hHbgaRUp25R4WxgVToYE5+7eTGxx7uw\ne107\r\n=0uaZ\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"98e8cc1dc1e2680a7798154f033e99bce9222e0a","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.7-pre.1433"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.7-pre.1433_1592535217372_0.8107601072401602","host":"s3://npm-registry-packages"}},"0.11.7-pre.1435":{"name":"piral-pwa","version":"0.11.7-pre.1435","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.7-pre.1435","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"beb7a4da48547837e4a431e25bab668274262994","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.7-pre.1435.tgz","fileCount":25,"integrity":"sha512-O1BQzHSWHjOHa2Y5gv4/ETvtL+780A+8IOeZgj9iNXCYxoOXXHmYwNrnLi5fTegRhbs17HiME5lliWJsHSF3xw==","signatures":[{"sig":"MEUCIQD7kq0YR+n+mtcAiAtaJc5TN+7T08/VNssMUKQgZoKl/gIgHUqqucVkLNdGjROINqbNLQs2MjZt6vYA2GicmZPXzq8=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe7pdDCRA9TVsSAnZWagAAOmcP/16oXyyjsRUzYtF2i2Oj\nd1csPejgwP6xz3uToDGSXviOddCyZLDHckeOp38yHTlvKive/FZ7Mj58ee+f\nEjGnwYqdLCYrXvQAUu+VcFSj6vXbrPzqxNZSHA7XpDNS6wqaXPFOxCGeDjn4\n1Aagi3BySPAsxo6yRkz1Nrvkz8NLv8eHvpumCPHmILVflBtD8tMddD2U3Qwu\n+K+fs2s9jttJPWXYAR8FZlk10EBxCJ7tBylOF2iYieUhxLAXpHuh9sPn3hFS\nW7r1VdN6XV5gSYrAlaUNM0dHaTyV6EAWBzZEKoB+Y48fTBXJopfTq96dbi/D\nAyqfpU230UzC7KtoYO2zp/hqw7rwUoJwEvVz8Qu86gUvyu+AJ3DmVtNDn1LQ\nNJYwEHntUI6Us41qehQ8SKKiq/+ErBXPaBNFRpvrmxR66J8o4T4oXvaYNr5l\nIkRmIkIRQtd9nQ1AMTXXDlCCa7fopiq4zF/R918lYNZ1funRGlFg6Ko1U1Yh\nLNIQeB4HZZHieAitSyv758gXQxYOsbkjZnnkjRRsizvvh+EndXwg+WCVxGws\n4K4sbXxNBoNa5DcOpyNJ/r8yAhH+bXnDnKA/K7b6KtRuJKeMGgSeTOiJmm2P\ndyDFp1D3ORSpk9mAZn7HXp+JVJ68wWw4oqPFgMxtgnr5jc/9PU0Thy2QeYfA\nmvkA\r\n=N3fJ\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"81ac39400bdd054cd87de9b33754a74420deeaca","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.7-pre.1435"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.7-pre.1435_1592694595140_0.25440093543075326","host":"s3://npm-registry-packages"}},"0.11.7-pre.1437":{"name":"piral-pwa","version":"0.11.7-pre.1437","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.7-pre.1437","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"bed5a969175a557678d9dd46506597c2982cd022","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.7-pre.1437.tgz","fileCount":25,"integrity":"sha512-5WjxJmtYctwyB6R6GrhXvkt9PO7eCYhm/f8ta+Vc0KOU/5XCD8YRYhri4us88D9kvGnHy+D47PCajBt5TKVNfw==","signatures":[{"sig":"MEUCIDVWmduKjZs8qvfxDEMpx28PDJpcIEVERFi1XyWjCjIjAiEAwNozihWJo5ndg/4MwnxOqP6knJBoiv6rxyV0H+ex7kk=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe7qxHCRA9TVsSAnZWagAA3GoP/0rzW+azUoe0++QqTKIV\nrCMhazOOWGmIG3kfzHV3KISZxZd4VDaAb2JtPoqjksYxKTZvgTpEqd+gRa/Y\nwPpCUd46+RtmjID+zEK7U4C+YnmDSxa/x3an0UM0UTrULJ8bnpgGAy5ASkVE\nY8PgNfBdLzgqolsTvdiOjCk5glovNn6K1unxPmUnxtI8uWbPBPFkXhAt8hZY\ng9emmA2fvoD2sb5E3Kb3OmCeb22RfOGr9EJaI2dvSrDugKob4+XZwdYy7MYm\neVFsbRJ6IvtSvlfJrX2ptSkKWgra3eIbmUOqi2K4+03AhxF/IVQV0cjtqSYD\nsvqKS2GlkVKE0QWXIk/fxEv64vbtpzjCuQhl1XoeVBAbU0mtLtDQmIjNy4Ex\nrM9xLRfs9WLF+T7vYjra8e6TDh7+l+2bLbw/cYrOkDLPk4CyFEuk/p48GsLy\nHSIot6FII3ysXNK8OtRz7g1GAYw0SG+xLxqqWF8Hi4k3avyOFBkP4iEL4Rup\nl5I+wd4rtwfad3BnTiXjyvlrsc2h+w0FAwTzHTeP0d+gh9Zp0iZaIdPBVQFl\n/bI+PXdbXMHfEKxVdO1A77gYMtiMiAmrfrthpKchR8aS/rcsvGhWAIcWvpIt\nv7x7HqWGuy23zyjkCxhYrSbTo5PPJCFBy1S+BmeRVZdofpDkKYZlDjOv969C\nVhN7\r\n=Mw21\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"7b749bd6b074f1d01bc765dffcf8df521b4e5921","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.7-pre.1437"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.7-pre.1437_1592699974609_0.9494809418806491","host":"s3://npm-registry-packages"}},"0.11.7-pre.1439":{"name":"piral-pwa","version":"0.11.7-pre.1439","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.7-pre.1439","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"7f41c26329be95edc4bc33eb1056088ef41a9cd7","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.7-pre.1439.tgz","fileCount":25,"integrity":"sha512-2inX0yNlYaUC+BFCiw6Sjp+8iZ+xQGBoOJHGQ0/uS/gNrNBZ6BfWBSKkvOhehcPpshlASxXRC7leM8ntgjc65g==","signatures":[{"sig":"MEUCIQDpSd2ltfRGBb+4G9WB0LDlsULb7orYpJMyDozf/RiPxgIgWcwY6xuVxP6mqzlc4aR1rN2xj1YF2ICCF1kUXhRqivY=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe73UJCRA9TVsSAnZWagAAGL8QAKMLdeHHhZyjScCiPKpx\nZw7Z3gP1I6CAYNP2aad0oCvWUz6dwN5S5LqDTvwELqmx4JlocBeA7+XMnUwd\nZoTODot4M9klLEaz8Zwrc00XX6v9KhP2kOCTdjFx+jcJyxJ6OEYolSz3Ng+a\n8JRUNHgf0j9/rjaBM3c/3dAtY79aUG7xE+LyC+KV4iomEaMaltnmqM1pqXkb\n0Y0ve65NllJaI7qFmqOjIagMvIS7QDls1OSAal1eJt/2daZ6LnpsGvbYCJXP\nafcz3PAs6EJGZXOgKviH/l2AF6KTeunPjRUVhvPn2gjgAkAFF0rUPZ8tUx75\ndRF2FH1tVrsjESON0fF8IAjqhNSbfZLTbh61d8pnAT3tJ8xoG4997l0fXwV7\nvug6JaWeY/jqLhrDFtRl9KUfNA3jqw6/txcCXKwjCod/xy0NDhqfin1hzgj7\nTUMEkYomK9JLQGyyl/FT+KKu/t8ee0sY9XsTYO+/A5nzTXtV4LH0q91g5lul\n2NHaDcKpgnGFId6L4hnYBRK1kVoLx9aHjTTjEgZoV/lUtuow0MEFu4aBgSct\nCLUawnnDICopjNv6aTTvpgDFwa2vaE5hT7GaH5yFHwGhC9dmE3En/h+Q2aTN\n5526V18fiZ78ezXbRbAWNcqs+Wq4MfiNNmImSv4LWImX9zzXLZaeCWRjPqv0\nVkU0\r\n=dV5C\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"7eaa59e8d1420a4e02c93868d19b09a5486cb23f","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.7-pre.1439"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.7-pre.1439_1592751369024_0.5597397631648404","host":"s3://npm-registry-packages"}},"0.11.7-pre.1441":{"name":"piral-pwa","version":"0.11.7-pre.1441","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.7-pre.1441","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"077318bf95c389ad51b9943970f837c4e3016d9b","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.7-pre.1441.tgz","fileCount":25,"integrity":"sha512-M91vhYSJAGgv8R7Z3RZFWgLtGg9iFLFK4s1sW1i4xabqC6e6kRvNGa9z74INCRf9bF9gQ2U2Sd0yt0Xr8N40qg==","signatures":[{"sig":"MEUCIHAwSLp33G8ihEVqSyXC+SDr9f+tTxdiZPJT1PMWb/PkAiEAxC2lj5YT6X5Fq7OiNzONJvkXIxLjEw7LCF2uY8yWlik=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe8DqdCRA9TVsSAnZWagAAVVQP/3HdhulrlfUEWj6lBu7k\nWk7/bZdjtopauWYmyFu2AqHXnX860KrRweXvE1H940oX1Ef0Pcrqd8AF8cEF\nNtpLmBa7TLawBqNULHm3Skky9rXHpAOAgXmDEdku/NmfC6liXS69CyNSrlg5\nlqnFTY1Ry/QeJteLV6z7EmSuJZCRDTDINEADO2uyyLOHXGQR5AtATp1mAw18\nJfzVhQR0KwkMKtJoQdeJPS4ZKW3JWbv1F+6oIz5AwnAOh2UQbyMoR2ZxJjs+\ntOuGfhfusJ9K9Z4IWPBCOhEt75+qhGZTFpDLF8qnsFO/y96yJpYvUD8RovpW\ndpVGQVziDQPdaacGAZB9hd9mCbE3Qri5KLF6ItdxbnsDu0RXthzIFvGjHkG7\noaAteCoaUNrWa6/1Awd+EumVlC7hUocjqwfke+UY08pYsYY0B811S4bymwsl\nUegLmWe1/3i+fBE/OFdLWKj+swQiXOCnlLbfXEbEXswMBsHEMnzPG9aqjfLP\njVjwNyYq2jA2spViVpag+cJkU/woQqGA2Ko24itFvukpDS/bu+c9AvSkntwJ\nRtcJxxqQvBl4MNC967GHs01oeFvMmZI8feFPob0C3BqQNqQQs0vZFrcbD4Xn\niCd2lSpur0DZ+nIrgOrRNaAGhKwUcJNRPZ+7G0tnvUs1YLQpdK/4LdmgIHZy\nBkLf\r\n=itJ7\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"a03d56268723e670c630ea48a4fbb19fea7ec09a","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.7-pre.1441"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.7-pre.1441_1592801949441_0.9278144547201335","host":"s3://npm-registry-packages"}},"0.11.7":{"name":"piral-pwa","version":"0.11.7","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.7","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"35ede9d7981bc2ac550f91e7238a5beba1e15fa9","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.7.tgz","fileCount":25,"integrity":"sha512-17VVsxY1LS/2deMw9DWpae9Nazu3zkpR2DldO/n7/axDM4G1aLvFmpiK3S2IMk9wi5SczNmfLI7h9VSb47kFHA==","signatures":[{"sig":"MEUCIQDOWw6JY/dXi90C9XfkVxjsCF+2bQaWVkey6i0alFDNLQIgZ5f2VRE7uNcRFzTem9RPYOJmLGVpemzGEAd31iPEhU8=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48957,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe8FJ+CRA9TVsSAnZWagAAavcP/3HQbovupa3EPXdDFIY3\nYePZ1H63eXyNfxCrFXwsmmk8FVgEoyifYvUQ4Hyb3BnvrFFoYfJOFQPi6Ks5\nc/H9UnSSqQTAtV9oFzHjyPtSyCWZTy06dJeP2lLTz4AFntMpBq+9D0bkm0e3\nJKN3hMv5N6nGwhGQCv3NFLs4tIucirINbQUNae/J7FFc+HJvgcfkRO+Hyd7/\nnqv8puGrWdF3WV+MdEHBs7vZrGDbehpyCgYSdbeho3Qqnw+//kphPcXt1x7r\nzQeqCpfOc3/kMXqXy1Qpk4FaFQC/Z9rzz4rdxYdOCxn4KaIeE+dfnal7Y7sk\njXTdSbN9aXuT2XMNjFPdhwqj7myACuTfDZ/xWIWHhV2+ZMhjjV28Zu0/0Q2G\nYZKeNmhojlfSvOcXIa0k6ZISJYt3wWQEc8aBVA0WZP2U1w+ySp8Tewqxbw69\nchlzBqEyY1bH29ykJ50i02qqlcywznUAQyJEyazyVN4oi9u9wEyoA+lEO/xZ\n1etfTERR8rtofVmrwWfBnA7nkM/A+sFbhLG/PLcIvn4KWHqzKTQwVGyJ5UR5\nqPH1x34luQc/HjAQBg6xjGVx+2VeiaW2dUsjUTZkf0fIXdsPGMiYtxcMLrbZ\nJfiMoOSAkarZEo957KgQSlM30VF/tlda2Q7U+/Q+pSpRqL/L/G8pXbU28dc7\nNJIm\r\n=GhkW\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"cf59b6f518e6bf63f287e7ad918a633ac60cad13","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.11.7"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.7_1592808061676_0.8510552014710808","host":"s3://npm-registry-packages"}},"0.11.8-pre.1446":{"name":"piral-pwa","version":"0.11.8-pre.1446","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.8-pre.1446","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"4546fbc793dce3912337244cdbdb4ee6865a6f58","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.8-pre.1446.tgz","fileCount":25,"integrity":"sha512-s/LXsRwkoyz+kA0zz30HE9zW5jcGJvPRi0efhNsgB1rglETN18dSGidv2iDIcY3ficwyHny+xZKY0pHNjHQQlg==","signatures":[{"sig":"MEYCIQDKtM/GwwnzygRk4k00vI5wuigGk+s3jjhS8VwEKGtPEQIhAJz4nS2LyYXGc1JfQO1Rd7u1lTvL+OjhkpOhwkxYD7VN","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe8LWoCRA9TVsSAnZWagAAwOkP/1A/IsNmAqNwfPZGAcHe\nOR3bIf1sL9ULvybEmaPJbGOB7x6BqeMqIO7dUZ1d7o7VGynEre2SGycA7erS\nv+3Uhe5pw9NioWty5ko086cqd3BTT/Al2+UWyvAi52DlqBjLZKchH9/8YZzz\ntwWPsxj4T6rHdlp0/uoDJZHH5dsfZrM+Cf139rmxzqLcDfjxXMikzpVpDjZf\ntSsnrorj+PSLJUrGBB9DkW0Jyxb0S5ZxS+/ZsRE84tRSZ/tQkU/PZ+i+ndOz\n+gYs1TFOTh9c9BtOwUVw05wxoQ4o3TIfd92HrCHEnPvxdkZW22/FBo1Ck1tk\nHA1fLzj1Tul+JbCtr4VKJWhbFr0HMGZxw/tZTBuYB9PJJhMpU/9CyloHG9yK\naNEm26SU+NTMGjZ1HOWmdyiAEsjnz1O1I5fLM4HkNh/679uTqxqlk/CV/aR+\ncYUoc8tt7SaxkALDGfxSkw9HAb+lSGJWquoebu64uuyRle1RNvtImwv6rE0S\n2AwgOT2GAuOU28iN7sh7KFlA1T31cUT+PbDJpnu6UBzxxVwBwDkq6mYIJ/70\njxALIMjmSA3r/SItM3OWITMTda4fKxBM1w1xyj/v4PMReUzQ8p5oNQLc0Oho\nrJ7wJrgK0fQDM4RcF4IZif5HEk4iVOJ0mOKZHP3pmysLqleVR82keM3D+wYv\nga8Q\r\n=34y3\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"0abd6be5fd40d921815e6c937a2931c0e14d63ed","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.8-pre.1446"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.8-pre.1446_1592833447457_0.05126684319265995","host":"s3://npm-registry-packages"}},"0.11.8-pre.1447":{"name":"piral-pwa","version":"0.11.8-pre.1447","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.8-pre.1447","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"38e1efb4c57eabb4cf32851bdaac3bd3f79b0e51","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.8-pre.1447.tgz","fileCount":25,"integrity":"sha512-o3wZUKr70z8UDqB51aS90N+osUaqyySky1OdBdfguYvZZ797CFhkWWeToImEtxuC1cSmhHibXhldbDyQY7+dnw==","signatures":[{"sig":"MEQCIBj+nEaiafK/OP8Hc+cML/qEeI+LQG9Muoub1+erJz9pAiAuEd/tC4Q/9DHSJ3l35RSoVBG/sRTes5gx+k52lTvkCg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe8xRgCRA9TVsSAnZWagAAopUP/2FFOAmYCtVBoeCE26k4\n1UEAClMgBhhj77lwQ0BWbet6bBNt9sGlHsaDryRjT5AtId0IUX6dy5HSJ/K8\n8+lLnPavD0JTiO6uGBsKZNz19H6hn5FlepiC0anL3PjmWaTxTfCvTTZ6/rh7\nSOgvEg52XEQeIPuLnIiDe/lVspd4yxyhwY8HetCkI4J9DwckfwMqqK8ZSfR5\nh6rKljhXPCJENAKPGmJBpyF6qWnWVubPAO5ukqwS9Hyb3PPoy/JJCplDeoxJ\nrjfADYfRL88Rgetk1xe7bUumrd2YNabtFB58d6+yKah7M5N0b5/IRue5mjEX\nuZFxHJxQnSzkv6bxxbAEh40IacEQBvcCHL5Ggr5ijRFBvITHIWbdwy1jfaCB\njBuF2tCqeFcG/pcZPPVpLmwbaJK+HqPdIYnMIxu3d6s7gGwZQIFUrvIo7iq7\nZgWQ3S9lFgUrdjVJm50Su9/y3lKKeJ7WTzv5A/q/keDcokbgzr/t4AuULDuP\nVjrTkbEVJiD9653kSlE5YX1mpcyz9v5F5OqIshnNWyEcAc00DYuSrG8bfks1\nw/VPWewcKwJk+9Z2/FTVHtST8HdljGw3kVEodX+hrfs3QWNHvgIDIfla6lA9\nXNcYXww7yRlIQ+hWA5msMxIjOGD5znDeLqMddjbcIv46LKeKE0mIADA+8wAm\ny+4P\r\n=WXel\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"5ded0c1cbd61cc1ccee9902e5bd2a7568357578f","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.8-pre.1447"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.8-pre.1447_1592988767795_0.6494185524509966","host":"s3://npm-registry-packages"}},"0.11.8-pre.1521":{"name":"piral-pwa","version":"0.11.8-pre.1521","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.8-pre.1521","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"15f15195e2526836b3964e7d725c54421a0d816c","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.8-pre.1521.tgz","fileCount":25,"integrity":"sha512-EIFnSTZbvnNvWpvaXaTSRXcpXrUThlIA6OUeAEbO+gZxEmClSS8hax7Qw7OjlvDdFqgxKwgfXYZvy/2W0AbPVw==","signatures":[{"sig":"MEUCIQCJG3yYHVQQ5Y7xlyO4k1MDV3g0UzPwFR/oI+jOtEpv0gIgWemt95WQBDCadVQILARXLWbHsDf/EQbJFtnC14GpZuw=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe9ahtCRA9TVsSAnZWagAA9WcP/2Bp8MbkrycRj+Gcim3I\nN6aO61xPARoaikcSu7aXu6BgEnBq7ASPfCh3qsicQR9AV1bI6qEwpoOqwXMO\n/Zseim7sEXyU74xN/+I3M3qEngt2oz4QuAIYO9BxIPNfnW3nRKdJbZuhS6rZ\nK3tsmbdQkKzKLzwHXDDxIK7HY7PVLuambAAyMIkJ98DjmLTv0SwMKlR4DHpE\n4N+hz63ZwIhnFxVh24w7DIajtp7pHeBc9V482bPyeYu5O5qlE3uIAPql7UAG\nawhqAx5/C86KTm/GNHj0I2SrzDp4Wc4ZVO6u6dboAYx5Z1KnamV/5dwesbla\nZ2HR+qQaRbXZLJsDrvpfnpm4NgO4tXeLQRU5fWff2CqxTkjRTkV6tnwLYbcZ\nhqt7UAHaX8bc0uuPYF3TUEwfdp1UrkbdSprpZRZCUjp6f0fyPwYIK6bFJicN\nYAi9n1/K5Tle/8WWrbXH1cbYt4rwH715EC8eRao4F+EY2/Ikar3GBu4f1XU4\nQ/qrL10EPm11JMAU4rCkGmPi4moSec8CCTA6NgHMDt4cYdRJIQg5lgJf1+MM\nLAscxSiRQEAK4ISIGuN8OBURyn5yVtcE+fbqOKBqMd8TBITxQ/mAV9tdgtwS\neP+3Fsqoamd1hh9DdBBNXRdn2fOY00TJMXd4Np0aPabJJvzdTl1sVmaiPmqx\nZ1AP\r\n=X170\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"d172b778da850708e881a3128e7315cc8272f68a","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.8-pre.1521"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.8-pre.1521_1593157740377_0.4902066655219708","host":"s3://npm-registry-packages"}},"0.11.8-pre.1522":{"name":"piral-pwa","version":"0.11.8-pre.1522","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.8-pre.1522","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"30de11e0598cb42466c386929c8cc1ba5fb41211","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.8-pre.1522.tgz","fileCount":25,"integrity":"sha512-RIuLNGFRSzYyaTYHFoc/XhGVJOp3pDjP0W7y6cIg1WQc/tzi2vq0CW4BeGGhK9lnUpmfnuMirxCg8XoKYprmOg==","signatures":[{"sig":"MEUCIDdjAMEksvl46P/QQ8zfU8iPqM9GxES4n2Gi7NjotLeTAiEAnJVyKnlAmjfVDednFN5udD1Kv9MH7aqRGlD6uHj/WHw=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe98+fCRA9TVsSAnZWagAAoHkQAI0Q7WydYCvJH+4LXiEU\nHqfwfw9FVWEgF88NGt8BFU/3fKC9K75aNJAS5bA4dCPP8fWY7BEfI55QKWTA\n8pyxi9/6KlYdrA2kmXWk5vkXzjmIvUYBkqXJmiOufiGQUau6da4bYIwZeC6W\nq+dtAzZOSWcvE/7SF0bB5fuLvB6oBVma2xRWii9uZwMHfDxqkUd8r/DMkGLJ\nqBBGyXyTJQgbYOapNxcwN77AMJM8xkXo4qQPq/OUh+Cj9JUkXAP2G2sL9AIH\nGrplO1DwJSM5wRBiifTKUXCbM15E4eF04cDU78y9UGar5sAV1u6YoVITKIOF\n4lDWipDTRxCs9s5QDhbAcqLReqL2Km0CasTzWIDrHTrizLtyAz1YcO6mhUW0\nLYUq31ikBllWVB9pQb3MA83Wm0X5YZ+Vo0IkGMKASaM89+kkZ/R6+QtFjUXT\naZC3GInU11x0yM5zlVFgy9rwzyA6ZgBQ00/l+T/gn5XZWbuy+2uEgR3x1nLV\n0MGPmpN/BBFC38pXtaKpIjsNXUp4shTc0xpX1dk4T70iMrp/mgy2n1CJXxVc\n2oVrjTOIwVdNst9O/oNF+JWJhtpBXaDNHY+Mu6PsEiSdht9j9HeAl8kj/G9l\nsU0n+dw+aK6OmQwoWz/LVaJmZHMScHS/walndP60n8spe7iC8KbgJhFmCgM+\n9W8U\r\n=5Vj6\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"b354823bd0a3be383ff31c87bebda57fc569188f","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.8-pre.1522"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.8-pre.1522_1593298846845_0.5733778596500467","host":"s3://npm-registry-packages"}},"0.11.8-pre.1548":{"name":"piral-pwa","version":"0.11.8-pre.1548","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.8-pre.1548","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"ec1e8403b79e4c65c291ce16671f557fcc28c8c4","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.8-pre.1548.tgz","fileCount":25,"integrity":"sha512-OxSTJqS9RpXx3VkHOq3jj7d/74jKtB0EN7NuWnTRSmAd1dd7COncRz2ANYG+SZDPn3OjghVL/2Hkd5sG8rSqgQ==","signatures":[{"sig":"MEUCIB34IZp/nCBpTzXurCi4G3MRMqK5UwbzbfaW8y2GyQA5AiEAnbIspxVko6gRokaKxFXHPHeN64q/sNo3nhDjJE2mSYc=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe+m/ECRA9TVsSAnZWagAAIxIP/3Il3eUVkVDYO7UDvMie\n3gJlW2Ehn06kim2LO0toz0wt/zVRvOBoc8dST7esYWzFLiPFGfpyZpWWkBXK\nIT+09FnBBfsJXE+ipwZ/GX6MsEJHR04ekACRWu2mOLdzJx0Z5zoxCBnMYi/W\nXV7pnbFVd2gDPtySxiopD3MnTohYkbHNwAFBIxHQs2IeNMc7+l0SWfb53ZKy\nunlcnuHLs9L0j3lx9tV3ZEYt9xvdqBLfDdqPOZ02bnQFzdo0arU0ylO/lLv2\nK2QxxTSlwEk2Zu0punIBvNZ2hlu1M8L20k//Eb+V1cKBg2cDSLRrB5nqPXl5\nvn5r/jsyuHqfzIKSGDUjjPI+HqFPAbLLvsEgH93bQI50RnmV+kvnS570FKf5\nNuVvGq87n99WvylKO5eWGSL4Ov43FXOgVzixPSzR1hFBzslH4uks1dkogPnB\nH6cnNPYGbUl12CRUN1I5G9UiRZYFRyusxJv5ogLLy/6LF3h1c9kbN+N4bZs5\nD/S9NC2/gpeXP7u8FUTkHGtleqLg3kA8RQqUxgW5m4Udk0yVyYryvLBPKMwa\nX1I/dCKrerKFk0vZ1tTsn4GBxd3gQqsYh3fmfK0ObEuqUgCeYOY6rMdy8G6G\n3hY9l73pgpMyt2buKGE0cUF+ZU7ON5UGsHzZpgamhZhRr/LsAzJt699DNqPo\nmeP7\r\n=1Rjy\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"6971747d4506137f579597e1ebe6ad4bc2488acc","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.8-pre.1548"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.8-pre.1548_1593470916510_0.47819651705513655","host":"s3://npm-registry-packages"}},"0.11.8-pre.1560":{"name":"piral-pwa","version":"0.11.8-pre.1560","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.8-pre.1560","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"9d5a2dc43f8b5a6e897da484dbeb0381c6a43187","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.8-pre.1560.tgz","fileCount":25,"integrity":"sha512-V21UiPrXnH7y5K3HPu0UgnFMrz7vfpdV58w3rOIJ4JJYZy6xyJI3wTF+3q/+6thOj/xHIDtav566GOfEY2zl9g==","signatures":[{"sig":"MEYCIQCYotvUZiBUetRCNiH1qvr2wacDp85bjtGLyfzJGUcBdAIhANHJC2NmkxyS7Q6IUMu++cxE0UM2Yv3WSZXr3TJVQEuu","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe+04FCRA9TVsSAnZWagAAANYP/3kEKw/HV0BQjWKhgBpP\ntv+MSe+2YNwzu/FF1Zk8vaRmjl5zUCYCaMBqAHcoZqxf3lzyV/SSfJLbI5AE\nz4/Nf0PzHjYk/yXu6M5OvUf5OKsLhadLPJydh4DfMkRVYYd8/TLIjqgRsPeB\nTN7gjAMLSO9/RO+U5DjB1ijyPy7qYjrb0z2IdlU4BogsIr9mtKnktvnT8jcF\nWfi0aaKnDGAMfa48euO+LMwauYNPGZsp1op3azjqapON6WlRpEGb7nzKapLk\nkfb7Lq/SPhtOEWYbw0bAIuewqCfVADR1fiAGgoG9wvFh2aSWiMHrhqV8U7GC\njGSQbBPduFWkRnlKh1BrxvkfvKfV3po4A/NXFje4UnVtn4imDRPQXh8d0ntw\nufcBPurw96kxQkrZgFjhySYG6DSznQEUvkOgwP4N4kgaU0yF31TF/kygkxav\nFw9If0862o2q08WHYOOwVt20CjRZtFEgJcW3lgGq5c6W6SNpd/oHZco39VU3\nbRKf8NdfGC3ShmUlMQ7exz82BjGQtPfPgvlu49WnC7b18gmWYkLhykHcdgVe\np1HRuHfsxj2kRUQuucW7500q4u1Ky40NqwJ7etbWEV80HXXl6PsJCeW9IEWV\nc2SVp0/vE6YjtVYAbh9YwQvEybb5zu7fi2NcrAn/xDhHcMjJTqnG6EuXKNTh\n9G+N\r\n=qbDv\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"be78be619fc808f782fc21983131556242bde503","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.8-pre.1560"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.8-pre.1560_1593527813409_0.07567330513581405","host":"s3://npm-registry-packages"}},"0.11.8-pre.1583":{"name":"piral-pwa","version":"0.11.8-pre.1583","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.8-pre.1583","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"e7427dc2947d2f1a0b6341ca957bd16be21dcc6a","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.8-pre.1583.tgz","fileCount":25,"integrity":"sha512-nsod03gul+xwUD7VPxitn0D7M/OIaOxQ2Cw0IEksKHGuPkGV5kt7/VpRd+9NxypW1dOK+x3NFKiQS/yi7Gym2w==","signatures":[{"sig":"MEYCIQCxqXvgKgd7YDCbcmmfAGksvJLPYhk5clH3QHHtOxDnEAIhANGqVyAYhhJXnhOi0x28tKoTERVp27jTIIPoqv0hbKbB","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe/ExICRA9TVsSAnZWagAA0k4P/j3sUiRqTgAtqZZq5rb+\n7mh9iimVIgp4EEP+SZ7S8+8q4ONbp6y9KG4Z9RsRAZFYkBIxZwMEMIXOYoZ8\nvT+949XzBPxYk8PEJnzkOa3Ppieiq/1QnmeENtsAcTJdt2lso1YCJh3uc2Or\nqdN1F7F75SsNyzK3dzjqMV1TMI96xI+u3bcvrDumTlLaPjxRX8HJmF+UwmpP\nzCFmBsltp5Q/acGmL9ulzo9GdoXAKdY0684GgCkofxXF5jjVbVmHGBRRN73n\nD+WwtW4BASWiUvrf41UHkyZKGnPC3yx2SyZjs0aYp4/1Cw0GBnhm2w9TnTQ4\nbwTTt+iMK8roTU8nZpxR/ynoGXm4aAwF8DGLBIvT13jag0s3+Lb1ztFpOm0s\n8FyYW7nEAUwva8IxdsvDzm17SiVTQRKQzXnLa7Y9lHF2wyvnatQiBu+YSuY2\nRow+6Xz3VlroOsKufWqWXDmjntdmZbu0AjraMWWXeBcxMN1S9U/yAw1uFJm5\ndPLkMyidOTOkHhsZQfwVkTF/jUU1WqDDuTzKnAiwmS2e+mNgMUnZ582MVR+H\nNonvlPLEq/zTCw68MWLoKr15/ZISN9Nq/8XCzLt90EhwdtHC/UuRhz5j9Iv/\nG6GEUfT5BfRXoiH6TDD7M5CKbeP7iLNHCgEM95/SEkZ6fmyJDDpuiG4ucNPe\nbzQZ\r\n=Rv1o\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"67ef5310c88379541e595e4818cfe996cba1f252","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.8-pre.1583"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.8-pre.1583_1593592904230_0.26043930124134107","host":"s3://npm-registry-packages"}},"0.11.8-pre.1591":{"name":"piral-pwa","version":"0.11.8-pre.1591","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.8-pre.1591","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"846e8b5f44887bb52b6c5fac021e032f355f1274","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.8-pre.1591.tgz","fileCount":25,"integrity":"sha512-RV5kb93LaKyd4ZiIIoZ9yDvvoT7ikqX55rE00IdtEexxlIPPCdeD7wWcEj4hB59YclokY1BEaU1HeUotu3RMPg==","signatures":[{"sig":"MEYCIQCHGjyfBdF3mgQYeIqBw6m8eeP59YoNxdz8s1zK3ERSrQIhANhHVE2BP8wMQWBu7jWMIGh2Xig6NP9c0Og7zvctQACn","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe/JwFCRA9TVsSAnZWagAA3OMP/1NnBuPoodpYEw2i5DP1\nn+kI1X13qg6Q+QNX/LUO63/bzzf0Mh99grIr29gnElO8cV1j2E0VZZhMTpQ/\nA3bpRGs5QLDbWiQUmHcuiYB53kfaNqdyyEL7LcIYEOgIUa1yTZbzBgMR0OIX\nvRVCyDGm/Q0oyPHPjztvr6R0mo58nbcIkVhC1QNRalkHgRbmP7UTzCFczon5\nRo3YZTi1spmoR4WX2G/bi6PD/o7CAzMv/mfReKUC8FjNgZdx8wpoHabQ/SWj\nJKG+l0Nwnd23Lkj0mLlHdopkDaihuQAx6+cTf16EEdsaLc4ET6V5t4gdV4Zo\nB/pEgRCBlIAnBtVLwBkkKE00VMpE9tIszZF/9xA0frOLyc7vnbbdBp91dhha\n/pfGer/xjdbAxqj0q4XYvx8A0VwClnrPVFZmjfEtALlEcugqLCmcbGFvBHZN\n0pwCNHEg7lkzODcx435loNu48tU0+2iKEdNZqZFnIlXzg54sO7Q/O8Qm8wLI\nrQlc/KVPqQ5SCIF4NgqtkjbyLfJnbwXoa9V97lEnjIZcCanfX7cE1NmFLCqd\nNnNEsK6RObqp20vRa59rQDjKLsY4kSFj2rdV+kMU5ZgUHrfyHrFSbwNfQua+\nVvtxt/FYne1ZmQhH+k1Mdll1UiSns9KSsYyBXoJCmO/Rwxj/Q+38YlyzHo8E\nGDre\r\n=tAI3\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"4f994ed998506d367e90b99ad2ddfca8091f088f","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.8-pre.1591"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.8-pre.1591_1593613316684_0.7589019954996661","host":"s3://npm-registry-packages"}},"0.11.8-pre.1595":{"name":"piral-pwa","version":"0.11.8-pre.1595","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.8-pre.1595","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"f1f43101894f76613f0390dcb34bf020350ab218","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.8-pre.1595.tgz","fileCount":25,"integrity":"sha512-FZYX3qh2RBEoTIR4R3M1Cafwdj0HHR8vrCcA2UcSCHAYlowWCmHWui4+uXXwPrirIh8+05jQ/hEb2v4hU8Mj5g==","signatures":[{"sig":"MEUCIGyMiq+DB0zQVttHlzEDIMz6Beo5OBsSqMjJOzgxiUHNAiEA/rGsDEXSvWJyABM3xFrox/SpHFSzG9XEJW7UsnxmbKw=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe/MevCRA9TVsSAnZWagAAKrYP+QElNkwq6DzouyAF3mja\nr28IxVi+wCK6ChNBu3qHq5KHBI+HEdKEN79y1D2BCahAmIQKcAHKYTwXp3og\nuGfPgnct3weqyFHM35hX5ge0L+EqULzVwqDAwNnPuDigk34OD8W8Ea2uca1i\nIHFgmRyu63V7peDxOSSBGuJkxq03gb3wPTXWp2bUvBJOCxrwt4mmOZd/v/xb\nNwi1qdO7xA/9Alz+PJGOA4IiRul7i5PEX3gVfBECcukGSM2Kn7k8NXSQU/P7\nC7Lj9mI/B/4crucCB0B0QOyHW0Q5iC6QAcoIJnaM1/P+lrJ/H7cAaLb6dcly\n39ln6nWLW7ou3eLgX2dbyG83nU03RfGZ/5734KMZ+woKbIKPs5AUcTGGSOr/\n9Z8jxgKc29b70fhaIYOScgxNz7nDIYfe6rbb7oNlQrNqSufOqz0sUiOj4oxw\nJ/uP0wBmu+WlgXRXZtSfPi7HtXbQV2ZkRSn/tLWJkmgJ7MKB11tfC/bgxHJo\n88NXMLUK1KoIf74dPOxd5BlPhpdHOhbfquOBlnzDJNJKI7HQluq9JeTKGri0\n79nScbhdXRHBS9PCP70EO0lBHua5Q9U+6qn/1CCwo+rN/p6fdOk5vkUvkVmr\nb/xN4TBqSB2SoNr4RrWc08/2pbD0byvZDzN+/XMFrp4aV3S85ZvDmEOLI6ph\n35tD\r\n=YzVe\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"be1abdcc074bcc6f2fbd04949bbbe06de0fc470e","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.8-pre.1595"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.8-pre.1595_1593624494660_0.01655783744935535","host":"s3://npm-registry-packages"}},"0.11.8-pre.1596":{"name":"piral-pwa","version":"0.11.8-pre.1596","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.8-pre.1596","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"32a687cc7611fc84042b1aef30939d5d6ee0be60","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.8-pre.1596.tgz","fileCount":25,"integrity":"sha512-TMTdjWUWMXpGnN1SdlTnvWB/gwy8VAEu0y7jx12WkaBeYufsTTJCgrM79JfAcjZlIpDHuBZCfBbQlChgZb0C1Q==","signatures":[{"sig":"MEYCIQCw4KCtQp4lSP7RZwc0lKRb2pHNeeW3rtQIn5vvlXdiCAIhAPZ6C0vyHFLlKs3wzIoP23k+WWAw6ciJg/sWaQ/T/gks","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe/R0cCRA9TVsSAnZWagAAofIP/0QQARUY8KAFspmVeQbP\nWRHgT9r5yK+5VCJhg19nkG4uB1Qbn7+09aUrmGKn/sELT2D9EJszyWZOyQxU\noIjwr6gTKqNqHPEEVNIlGIG54qQPy4/hQgCH5x0Z2o9evFRQvRmC4AAuLhAs\nAaVZA4ND4QCYT/KcI9xjL2csJUerk1pg2UJoGeFnHgOOclNLUOcCF0dxs/DS\nXadd3qhJpNnp2ElakhB3Gn0tadcK/0wBkzQpfOGL5yMoaCjgoHTG78ZaOSDK\nOJM2yV0TrLJ32/l1THD0SHu1nHQ6lJ6uo4YzJPBhxqAtuSjez0zmCiJa6/lw\nL+Yt+4E2bA6Vr+M8md4KYIl4yXTstEC0XPVPn4PgBnQSR+k0ugZhkMkZsvpp\nDFPt5XBCB9MzKSHEyG9UyyqYoDn5sofUGc/6H9wvbYvk5TZfwSFNtaAU4R0n\nRME5toBIvxtl//hjzufEo2zs9Map0Bnv5Bg2vTtrUP6qvnxyvORAR5RZ+9na\n4n8eNIXC6jmHyhPgxy+h1H0owZwUYuX7XzRDHygyVu7Zgfx9/G5ilcKnhWuC\npJle9tCYoSkEiXi/RvwF9HCLguP8w2d8+qzpzkrAUZpF9CSwJ4YOmWN7ShI1\nm/jfSkOfQnNiy/ZXiWZcrG2Vtz1Jk1UHlaluAfKGQvAyRRPMfqSFQx5EDtkW\nx+U9\r\n=GVoo\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"87719c35ff19f40e26fe55e63553920607c7732e","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.8-pre.1596"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.8-pre.1596_1593646363802_0.39426309454814534","host":"s3://npm-registry-packages"}},"0.11.8-pre.1607":{"name":"piral-pwa","version":"0.11.8-pre.1607","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.8-pre.1607","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"0859252847ce3611623d1419b59869bcece5fea8","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.8-pre.1607.tgz","fileCount":25,"integrity":"sha512-3YDlVgPNdCbP8psJ3oiT0KfYkZMp2Nzi0+3d4zeFL5eRMfDhNMZFsUifU4QO2flLxhzRBir6k6WCSezxF8PM9Q==","signatures":[{"sig":"MEYCIQDkoifayjPDe2bN8bjn3w9nOQciHBVdjQ1rDnB1MXNkoQIhANJf18Fl4iTC/6nm9lvRT1hYUt+xB+/84z91ftL/z84k","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe/y+fCRA9TVsSAnZWagAAeXcQAIJnEg2DZyhqqgoQJOtG\nDAgWGBhBju7OByp4g+92YH4OqOCZEdestvn7DRTlQ6mQxSkrhQWA0oQG1R5V\nhKbP4XSpTaP9K2ujm5/lN/G3UoKdjCVT5ig1i16Ti0ckaSEbg7yfUwhkDeao\nc+9i0iRKw7XcxPyDCKDVQrpRTB7neyUAgYi9ONTp5jh4CAjBTEpBYnqnJpfk\n+J1BezhexfPxbpMtV0AZER96mMdNEJivqI9D/kUwqvS7KAXuwUfdHPMEBfNG\n23CHHPaSYwrqOoVTl4jRgHcYQXGIBlNYk3E3T3GSm2D9bNlXvy2umbpKSrCG\nq1jfCgkvoNpV7zgUypTDtxaV1mgRdsLDu/psBUF8UthADTHQqkMpmC7qv4yC\nIn7rhtKrTdw3dsf7tZ0W5Li9k1YCp+l9Ym6GAafBjfleFc2xms5kNnQJ6Djm\nw5KXCYGLk2dzCTDx6gELqTIGlHe+2rcO2/qf4xBvx3vABC8Cs36XG7ETFEe9\nvgDq5M1hP/DvlT3fWTgC0PI1ltZSt7vbkHWZ/yN3rZfgjdW9VCWqVXMCVYii\nnpyDUTtyM8H/BVmBjR+K5/pI70dKGvg6SN+UhFbQbA9pwpfyqQOsdfb6FwGK\neOr2ywzx+1/d88geCcSpp4teOhojoifTK5q0eHZVWMGvNkSWbx38vm0v+CX/\njdps\r\n=rQWk\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"cedd42b825516601cd989e1493381a91d2e1e5d9","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.8-pre.1607"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.8-pre.1607_1593782175167_0.9084629366475772","host":"s3://npm-registry-packages"}},"0.11.8-pre.1610":{"name":"piral-pwa","version":"0.11.8-pre.1610","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.8-pre.1610","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"b4163439841eb9399e1aa2b651a778af8e713b24","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.8-pre.1610.tgz","fileCount":25,"integrity":"sha512-pmjuomszMU+xM2NHPN3Pd6VYu9Y9npYEvoFvfibphJ/hhA1CCF6uz6MXw+lH6klGTEolV0MbB10K61qbnfqPTA==","signatures":[{"sig":"MEQCICeP9dKHfMXnn2NH/2ZQ6PPLINLWxn2IWXRw9IZYqwICAiA0SfXdwt/0DoFsTANmdmF9uwzE+WvYG/DkzIsz4Tm44w==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe/0rICRA9TVsSAnZWagAADNgP/RoRwQyRYT/NwMDuJoGX\njnEZo9fuhZlNTM3G6EEFhacQsXBD6qlEj4IyyR3PNuedv8XV98YTme72trV0\ncP8M3oxTEJ4Z3zdHpdQ+pRBWyykuaAylkTet29ylU/PWkyXR0v4UqJnXWry+\nmu0ZtcjIrya6LN97cXNxRWdW9HU1p9lS87UJy5OPwyHcFw7hptfRlaEYUMUJ\nLcrIbNJtxb1EvvPx6FiRh0YNNcOsF7JRx2QFtw0S5t/PRxX428DLXjMnxs42\ndUGyV7392JV/PUB6dGMeNl9s8+XH3giVnRz8yp0/q/mhFsTTpQ05A9KWgdef\nLWmJI0mlxMjOkPMuORkbDWuUxNBMl17amuRxZNTMIt+bv/pc0J6BPa65opVk\n9KDu5SaDcwM2yKMWXZA/64BDTVYMLM5KPkzDisekfhyKXjwGD35K0VgfxwXC\nW3pgXNf5yxRO978BLaAJpQjgJTrDIMRVPEA9gj9r+IWJe9XLVfmhF+oz8t3I\n2SP0tda5zAUeTE1XHwRgvMpTvcylDur26D5hVJaKe+0pxc0atSnanVE6Lepv\n/GYQBmLhhPbyXKvl2G4VLzBpWgywPQVJbHAthhsFkFmHQuE/CgXZXtVrblar\nTg99aPjiWRPG+3M/g2fW2Q+K+G5eoCQeMSl+BxAkgfxLp9dGCf4wvTgdJ8mX\naPuS\r\n=kak5\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"655b59b19f9696177163f9bc91d0a1aedb1c831e","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.8-pre.1610"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.8-pre.1610_1593789128253_0.34283470505257796","host":"s3://npm-registry-packages"}},"0.11.8-pre.1611":{"name":"piral-pwa","version":"0.11.8-pre.1611","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.8-pre.1611","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"138f41f3910fc4f661210651f688d89b67275908","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.8-pre.1611.tgz","fileCount":25,"integrity":"sha512-nct8+iF2KB16Kd7+09mYlaf5bVdfxr9wCzBtpl8aRfTdYgxhl2qu3/BcoP8MtN8r6F2b0la+v9WDFJw0+VYUxw==","signatures":[{"sig":"MEYCIQCuPTjU81w6j17jVJFSyKcJLvBNZiKSqs3nXsD+WOwzMwIhAN/pM9ubWq1OCRd1rjzfRWbCFPK6WCslPSKYTm4xeC4X","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfAf82CRA9TVsSAnZWagAAYf0QAJkUkfK1j2L7jWwynnnv\nIGFP/ryv0pbbQzWU79x+zDp6GjFP16qbVjGq69nENF8kc2cetQV0lKX2RFdJ\nbfiZ3bCZZYXl+CxTIG5EaZ/Uyl77NKW9ozYA1g9BKfNGPEb9qZfID5tyMPev\nLdQL/g754F7WCUetfzgX+CwOnjR9YXX+vTo2tfMvpMnqFdy/qabnc4ugLOks\nW87AQFIShey/oNIxm3OWBrzQ62K/ZGnFFFFWw+eP1l3vLl40M0f2BuywSqMR\nc5uMs0VVYw45mNbI2XiIOGWtcj+3LNJR4KzEDXeRJCgaPuyOEEJmKEKMPRjY\nhd9PQhQV1nelwGhI1wa7I4P5aUxYeXFD83sWbayNN7aQQk+ttLXVSxUmQO24\ngYoNd2e8dG9jGxTt8W9KkuW/PED69CvGtmrvDviVG63A9XC9nK80bmUavq1l\n/mV8sIiGvNepxpR374f9cvLLGmcOSSfVPWA8EQsghKX3FBfB3SwqQRNVjR11\nN8JOb8Ki+JbZJ2xXYrljhkpGPvawrVZWxzM+/dbJp28BeAfWEqujun5otYth\n+1utpD27eutXgav83s/J5GwlRlZaZxfLXm8Op5gKspTOBwRQprc62Sj0y+Vi\nZRQ5CIQ/VAqJrV9FgJAPY4I3FrFEoiQrrSb855GQu2Sbtz1OhEA2KPAhcPHQ\nTcec\r\n=beBQ\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"1b11dc71bc8ed0f058a68a19810b7c9460142d3e","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.8-pre.1611"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.8-pre.1611_1593966390047_0.8383534448366734","host":"s3://npm-registry-packages"}},"0.11.8-pre.1616":{"name":"piral-pwa","version":"0.11.8-pre.1616","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.8-pre.1616","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"d62599f16ba1ef86bdb1983a6b372e053282cf74","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.8-pre.1616.tgz","fileCount":25,"integrity":"sha512-RBJNCK4dZWFrQnTujxWOanZprtOiFAZQxpATnDigxa/VvIVMw59/8yFiunl0hxVILn5mVMRJu3IGRSKB1uDFNw==","signatures":[{"sig":"MEQCIB9OXs/fC8E8M+yaJNokO6VlE+YD9EMSytaElOolhAv8AiBiqKPg81diQGVWXCaxmJqB1KBWykfafpHL71XFGJilxg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfAzLBCRA9TVsSAnZWagAA7RsQAI4q63Rhu8rywadd7CRa\nq5I4LEdXXwwYn7dbmhW9BZBXh9yplafAdvJj75ImU8/lHGdFSmdn887m2Zf6\nsNInRk7BWFmn4GcGmGnzm7Aw9HJS7ZZIYeeEg+C/B3IYZK7a3m2Wv+8ScMde\nC2isNekT8SdgKDa1Pu9fHmSr4PTjx6JX7J8nWmrRHJXsKym14dAHhlAkm2j+\nTNRd6bCGu6PiHQ8JUKblS1ZhM87AcgYIxXVKVtFJ8pHKCQLhkZjEayT5/4tq\nGbC0GeAtqRocXjYYRnyBuaqm18b1ES/y5JLox43xv2lmyYSPUWG8Uxw8tLAT\n8NkvX+hcDMVHaDAuiAFjVRfRojTwEsPgEtlvLoHhsHYW7FPsjKoDysFaKWvA\nAoAWBGuugKoQwxGjbjjo0liTXxTR1O8TTIq9fslJN0PjqvqhOPuAEzvaat+v\niN0DWUt5GHNgTLoiAuOzGbnDWRgaWDDuzlaZPumVqrJ/ADNSK8hG89hSaLHR\noFheurIMyOuLVSBYOuWHoaLKlr7/SI5WIZ7Pr034AJ6tE0iIwlFdVFwDX+4n\ni+cAhYAerbIUAUC4H4civfekVZBnwNwvcxj6B1qNbiX8EGEIKlpiZ+/Oo76O\n1jsJZbv/k3Y5V261hdR8hIxGes1qm2oL/cVu2VcpDCigQb5SmVvmt43coY8Z\n+6pQ\r\n=oWGq\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"8c804c01c99c45e0931181fa755117c4cf3a7a9d","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.8-pre.1616"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.8-pre.1616_1594045120564_0.7982964699397774","host":"s3://npm-registry-packages"}},"0.11.8-pre.1618":{"name":"piral-pwa","version":"0.11.8-pre.1618","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.8-pre.1618","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"4806a4ccbd92be57d8d0ccb4b42719493e3d9a09","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.8-pre.1618.tgz","fileCount":25,"integrity":"sha512-miiNysYtofk/jsCs/g5IOFFPKeCKnrQ5xd1hfU7qO6OTxFzYgfeJVov+a53IY5oqOzqjHn+R+2h0CBpL7eSDTA==","signatures":[{"sig":"MEUCIFgnqzJXogOKrpljwAyJFxLSoaLt7f0LbJHkYiYVGjB6AiEA1zYazWeMHnGsoifdv/ZwiHvlxvEy1H+xGplMRZ3kXJk=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfA9yrCRA9TVsSAnZWagAAnjsQAKMwAdO+FdarwPtG6ICH\nemqV3Cdf+3RUwpxZuNGLD3kNgwB5+n22CTbHvptTqyHmnH7JEseHjWJdQrvJ\n1b0TeDu6fFi8Die7vbCMwgqhbbllwRpD76GAUcSuD8xeCDGiPujTbYb7PW9s\nV19alikWNNub55y0RbqWyum8YTTydSUUxWdSEpP8rN15U515ePZJr4GhiK+A\nTyUFgZyMwVeUoJlEaLJjm2igygykrGS4RT+GIWbikLSKetZIechIcv+ewl28\njbQOvrlJAwilS3OMQQ3rkSwz+OYWw+o9I2Hzk1g96dAq2ZG/r2ulLFihnHBs\nIx1FrfdYOWuURcX/HnyzKt7twH6GJRK5SDLFNgmJvd5F9p9Vkvou+1VBGrLB\n4JvP3X/HHhEaj4eVvwopK/1WzwFJe3sS65/1VcYAlg1lIPG6FnHm95ONRfMX\nLTXOzQSQOz3R/DDg5GulN0tmdcC++ovn7lOd9JSaqXaxVw57jmtOO03z1Cl8\nPtcKxDZ+4jXHDr/JBdbfqh7+fR0xV3Ky8E5ShXmEUkx4DzeC71bxk6n/gahl\ntUI1wvEFOHFUkVWkF3CaeLLj/ExTYfgFbfuYYLXML0Z/1rmbr+d3u5orrU2t\nOf331QSvHVXtPM4TvZtNPBdVZ6YsevqsWk0Qmn1hfCzA3nnXkRNBWA3X9zrM\nl+wQ\r\n=C0Xn\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"01bd7ec7c065721d3779103030b25dc66c20a0ec","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.8-pre.1618"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.8-pre.1618_1594088618941_0.15890596113227984","host":"s3://npm-registry-packages"}},"0.11.8-pre.1620":{"name":"piral-pwa","version":"0.11.8-pre.1620","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.8-pre.1620","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"6ed507c0666a368b3bb7530f86c688ea37d51e3d","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.8-pre.1620.tgz","fileCount":25,"integrity":"sha512-BbGgnCuOuHxjnXl2jO/RHRzDIXvwWHJEmMp/xPCYDd7iN15hX7xgJxslHzP/+bfQMrOYfVN6JSKVog932ymK4A==","signatures":[{"sig":"MEQCIENnxQFBynsr0VmifUh9EUXmXSKyGvkB6VUxhlUfffAgAiA0fWzmSjgxXX1vELyPuxmEwqzrpckYat+eBI6VDkWPwA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfBIafCRA9TVsSAnZWagAAsuMP/2nYnJd5RhriOklH+WLv\nu1k3qXCV+cnkecKg78rWWhuxDcfif+cBr3ULY4nGNdXyCqG+M2Ub7/pkSQ0a\nRzaqrfhHvtdUmRG3itIbgPqyo4VbDd8ou4fdqxYcI+5M5cv2OA4rqB+HrQpM\nuMwOkwOSamp+3RxnhkRk5y3FGfjnLzw8TxWMuX+/+puhtinPM/5VHZjWroC5\nm6bZU9dPt+ZgRm2v4BaYV3Oc9Os51FnKu9LCBQNcAE/WJPy2+K35ecCT4XSJ\ndc2tWUnoEHT3wujiGCj9NeNMrG3XvKFglbk0whENZiP6QaRl2Bto5hy5Byng\nSk5R1GTSESO3C32vx216r01c7a2XEHCz8GZ3eTlEONE0N4XcZVjmTHvVSSEi\nVYfXZglGUwql6FXqRORzkdZ0mHRPJne3ldOVs+CAb3PaCNnhcG+m3E2z/Qgn\n4dZisM3GIVV5XohtOC2We9E54kaVg4Fey+HbQcW45lXMmkrvfz3d1KTJ6XGF\nYZ+ri0ADYPJxgYHRMNfLBmpG0JzvuV4hdCU/fEh05CAjyfvXZE6IhvXxrFFz\n13xicagRQqy99FPjRpkPkCwx0flybd4J41DQ7oftHhGTgz9zjZ7PQXToi0Hq\nb3UfXN9grz8eKR0M8vIyyvbLygKQ9ZOYanj2uN8ZgiMNBhe/aQZjY9813rOV\nxCDt\r\n=MEfr\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"e027010f23a5a9fbda79a2c6443d08a378bad1d0","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.8-pre.1620"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.8-pre.1620_1594132127017_0.3906840794017272","host":"s3://npm-registry-packages"}},"0.11.8-pre.1622":{"name":"piral-pwa","version":"0.11.8-pre.1622","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.8-pre.1622","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"dc12e80224d8306196f747541ce300e2a0ece7b5","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.8-pre.1622.tgz","fileCount":25,"integrity":"sha512-iscfwoN5xNl5KJfUGcCVm9o8J5wkNyidzRA9wpZhuJA2VMbx/vCHUym5rQeZsntCmfmGmWPKL1WEbpzp9k+GLw==","signatures":[{"sig":"MEQCIH5izLGhXVu9fKl4cy219+zs4uIuJt4LsJ/y9kwkjCYTAiAve5cOuxEQBYv5ShK/OJjmK13mWaf8WXjcTIz7wi0N3A==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfBYPQCRA9TVsSAnZWagAAa1gP/19U6XzIk85MXMMZg16G\nX5K/6kK/ivQH42v/UAJgSk7O2K1TnpPcPlAWVvw+jz1VrFOpZnACWP4JUdAI\n75QPJv0BzLrKqaUl1ZUUY66yasZ7+LVeuPhUrEcLOKliltE2OH/FP0OCSsD4\nwDwpkrq/V8nsXw3Yvkl2pxSLwssRbwwnfb2Ip6uYUrbI5Gn/4hszAjhJ/2pp\nKnYegmIZ5z84wgg9ELUZFqJCgEj+V7m3K0bDQy6D1QiTZ/wCROBKgC0Bw1YL\n9VkCWNNXLJyoFTvGStrzUBBNNwUwNtJdI6oLO2n6miESgtIMza56fY2Jn7p2\nxeKyYtf+drqntc/p3+448+/jKs9NZ6CMFGpJUtaHRICpq8YcfnkdsVPFUJoV\naRmqMRU7Dl1hOCThJhNWLevigrzIpskQr5GNygkwB9lerPz8xmudcfJT2XUx\nzu/PjlkfNK/LWgn0/Xc6gY9+ok/jjEZg/cUMW8EDDWDhu32CfsSqV23ZuDMd\ntLuzVReDLx7x2DmznuuvmhQbZNE2T5Gz09D0trVFApe/ghY2o394XqekdZKu\n6jr4nZkPRXl14Tsb4oE0cf3jB5T35jEAvOIyyiSs27aEeEN4OJGIs/SPo44Y\nwNdTeQAXXR8na5fxUGhn8Fbt+euNbyPjm74Tc0pluYtGIqWTdSJRYmOrPrhV\n1DKq\r\n=ss6N\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"1a6dd01fef8c367fccebdbdb01245bec0ee260e1","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.8-pre.1622"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.8-pre.1622_1594196944358_0.8636866588851098","host":"s3://npm-registry-packages"}},"0.11.8-pre.1627":{"name":"piral-pwa","version":"0.11.8-pre.1627","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.8-pre.1627","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"38b1406b5d2f392935654411e60206450f308049","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.8-pre.1627.tgz","fileCount":25,"integrity":"sha512-+pRDWDFsWIKv0RgWGO4xX7a+DBgY2+6Iy/DUoXzjzLq7o8QmaG6TaGA5EcCBPaE03TWdbjiwhFY2inL8+wOn8A==","signatures":[{"sig":"MEUCIQCrzKPuC0PLeT7lqYTMqPq9tbjanb8CVke1RSxXP4SKkAIgQnE4B957VjJq+Xl4BnjEJ8grwFm8QUQkCWQxGgTTCuM=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfBdu3CRA9TVsSAnZWagAAC1gP/2v4hoQRJDew3M2w3YNA\n6uBGW11ip2Zken7dYv+d2osBVZ9gKr30Xg7c/h7l397NSkWlv7f4m3+r/ckl\nk+JLdVDriG4VB/0tUQ73ufy4zpz6TrXMDZnnVt79Yc3/R51ydhsno06TWDXp\n1Xexf+2d45akghQ6Rur5QnZrTKzyYRddTmsy9YqFnDVLY0lEIy7Y6hnA82lV\nBOI5Ty3Zq+7ldduj+HlhZ/tYNKaEEZPsldjqB/fNqDVoeUHQ8AHQFFf9ooxK\n395UjlV0eb1Oeta5URgZ51mqSbHvEtFc19HjetMDCKjq375IE/yxfLT9hvoy\nppAssozuIpmASszNYWtwy/nwyU0+4cBcI3D4WLzkmxWz5hPTZZh4Peb7cgXk\n3MYPSszl10zYx7pA6BsN3k6Fw36Lf+rx96sen5GxPjKgXDWVX9tysMpwgjHV\nYgWasvqlfmYU/CTqgfiJ/w6r1ytv5op91w81/SpfoulHk4Dus2c8OJY/LfPv\nXxhL8vQPhLuRMY0Y61tPIu/V9V2zQgIx0wcnl/uCClK3Wq36cf8MM+T3Am9+\njuJEixTDefdPTkUk1dpSDGs0wJ9kBArwLYR3x9O+UIBOLjluEquInI7eqwgl\nU74ALaiG+Z7sFHR4KjxXeb0EXEul8BTTdt2r2d4gyS5lVZEjM9jFRWIwJYE0\nsjP4\r\n=bxJ6\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"e9219a97ebc4918a34d06ddb3c9e0a8e4288c1bb","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.8-pre.1627"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.8-pre.1627_1594219446514_0.18760423208609844","host":"s3://npm-registry-packages"}},"0.11.8-pre.1633":{"name":"piral-pwa","version":"0.11.8-pre.1633","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.8-pre.1633","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"fae295e32cfc72b11edaebd42e430a79a9796c0a","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.8-pre.1633.tgz","fileCount":25,"integrity":"sha512-xsV4ur7OAe1R3ofQgSaKvW9uMyPp1ascdSTlSrdTL0UBBrZ+wsS9bDGE8gbmZzbNP4T6WPFIR6Tj2zN12s76sA==","signatures":[{"sig":"MEQCIBiijHgMtHIcD1cyFxI62BUy5ia42kcMBK1xwObqMwAfAiBiT9Wl2AXES0+76apaI1qrXG+eQEeDnJToSxkb5dp4mg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfBrTBCRA9TVsSAnZWagAAe84QAJWFIo134JPjtJTLBWr8\nCNaowIEEXWFGJiBhy8f/IVwnS7i+DqZkhMFq6GkseZfFhgeciJ49hMNofoQZ\nERyVKmikt3iSl3JrDmjen/Y8zQP1arHbodi8VuWCLYlnTeL+k/yk75b7Ve5V\nyK+XhXywLZmM3hzP+kA3t4obys0F3xhf6IoPG42e3/pgThDXdKhcCAYybtup\nh3lqv5i4mJmM06EtaHFbzBeZcnk7d9gJv6unWhRvzJGVxjsgafpymv5yp8PY\nhvYdOpb4EgD8hYFYHh3HlIEwhAmVHRd3435ApjEN7O7SryJQLnGm/3ruLgZz\nVAfU9yk4JJpJ11dzm1RHYIrQdZMjJWoKj/dyQL0smFLB/Z52hHO7y8sxoOGX\nuJ6LPubelhtdVqQv7SrVC2DShBeFSY6Qqxim8GW6ZKWwd6JpYH20GX1AdhYJ\nRZjWlur+tJGv33830rIMLbFjWwYKxULWtVT7/hT7MgmZhHWMFwfz2zK6CRUK\newcuIwzLi3emoSbRvo2OjpeCNPb3jO/Q78Mzm0hL+RreWFaaTDJs2P3Z8rL1\nPRNScM13LY8hdIjtS0hyaWtkuSEMzfQ37XHYqa4gPX8VNpi+MIvO4/hxDU7/\ngn4c0fPdsVL7cu7UvkaxFxRs83R1KTs8rl+/jt9ZvDVtUL+BRzsQ2jA5DaqL\nimYF\r\n=GqAe\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n extendApi: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"7af569dd3ee4bc88bbb53f4231943b5f382791f0","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.11.8-pre.1633"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.8-pre.1633_1594275009313_0.935409227325813","host":"s3://npm-registry-packages"}},"0.11.8":{"name":"piral-pwa","version":"0.11.8","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.11.8","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"c5ea2d2e0319df7365e8c66ab154180d1e396dad","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.11.8.tgz","fileCount":25,"integrity":"sha512-rIvN0qoGm1KFEnmLco/W5751n8Ax7IxnHcos0lC18X+X5sfod2tkLvuV40FcZAzYMtFJfwYgjHLfC8oz74HtSw==","signatures":[{"sig":"MEYCIQC20xISGYUjNpaucLC5Dqku3nB7wcG2O/mjvHffHhifDAIhANWzK/2f8mvWzTktv6zCAMjDL26fJVUFA78w/W2rSKJV","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48957,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfByrLCRA9TVsSAnZWagAAqpEQAILSifMEnAabTsbanfkh\n9ofx36NTGKO2V2uvBpGrKzBehNNIPqAhTA/AL1UWvkE6FJP/UoURvxakYYvV\n6mSyJajSZOm1JybWHLvbgs4nCHdbFFxmgnIlfd1eFb2HGDLNWd/D1/hkAZvA\nqiLsvRrxcmVVpGjU8GGvaUyozjuNooaFxgyXCEBjT4OuRrqNGEreBqOJulzm\nfjkfDt/6xdG9yWbQn2fJdSedQSNoaMgdTHcgbh+NqjnUT5TR94ZqYexKrwyP\nejOx1lptHTwdf3T4PChHZ1pcyhQ0wb8Paq1p3lLQp5lErCvh4XApshQOFm6R\nD4TULMjPiWgWPzm3jepmlmI3837mqQSO+Edf/DLxhJ183X3u2AFq2s0GB0xS\nJt7x0NX5IK0T/Z2xe/ilGPIhiQZv4y0c759X5voq2MN9GFu+uTPLULanpiso\ngeAGYzdscUa0xd6lk05WNomZCx4KEXZS5sie0YSlEIWVQ527ByXQbesyTM3Z\nq9KUNHiY9cFo2SfgedqjW9dqDaNyeRzqxMm9mjohGiqpPYa2tPICy5I+iHmP\nndlYgK/72+Bq2BWTzzayUqrxHAYmUj3tp8h+byFNcmm3DZniBYfoXQbGx34/\nN4fpi/8SghwgqvEbCW+SbEclUGMIR3iwx/fhHsJIWwPQWlzWqANlvFX0MS47\nLVjM\r\n=dnH7\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"617df77a2d553e455ec66b04936967ff3ce21a47","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.11.8"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^0.9.0 || ^0.10.0 || ^0.11.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.11.8_1594305226410_0.825668651327949","host":"s3://npm-registry-packages"}},"1.0.0-pre.1638":{"name":"piral-pwa","version":"1.0.0-pre.1638","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@1.0.0-pre.1638","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"99eb96ec0a5f332550f7a752163517350489af52","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-1.0.0-pre.1638.tgz","fileCount":25,"integrity":"sha512-TfwW78t7i3CV02dfdQ6DC4Gzr/vCs2zVtRXaowYbZ1bJHsYWitXlL+okiXWPrxNgF2yNCaY8jfPHnKw6cpCCTQ==","signatures":[{"sig":"MEYCIQCWvKCyq8mTGJA86iiIfeFjV3CCPE3JkrbFx3nZB8/wgwIhAPOCeN/m3+N7t0nWNy69nIEzKMTRi3sVqo/Ivktsjebd","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48969,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfB35/CRA9TVsSAnZWagAA+7kP/0KSnxUfnnIIIe/J6ejI\njv0MvB5czyVuxBapDui/khoagDLlxjUeCg9+2HcXCoZ0IK1cDWRK3mVNoE/U\nVxGkKdSI4caKTyLH1tSSdIV2zgg+zPUQhmjkrQVYMKRBGqElm6zEJ6ilfQFV\n+4uu9Q2xFD4VdpBnshx8TZb8Qmbt5YcjlU7CF7pIPTfHgiMez8iRUoyXSzIT\nEn0XkHKKiEtk/tfO10ZuMIDHKsoLFw4JWNPkrR/RhmAqDLNGsmjoi5H/8V3+\n/Dp/xWYuHxwH9NjPddD3dgFYitHXd2JOX9h9xrGsWXsXv1YodMioek+6As3k\nZISUjkbyRep/gkHcoAqxxawupYKCwS0XgHvnZKAyNQu8Y1tCo0brdVSu0Lr2\n1srNMMAr2EYVEdb2PpM8YcDOF+0GQFzWvQXvzvGMJTIQJMS0vvSqrHfKqP7o\nYMY4Y9yU3UwmFsHFu+RJyW0s06NiAybFO5tx8I6aIMBEuRxA+K4LenoSYdWj\n6SkudXUoCXEf2C2dcgIqPpn8Si6ZNUjxTXadE27ASGF7qwtPCTNXtUX+yjyM\nBcsoov0zwP1J/Iaihn7cvqlppbPue3eSdfdEnEBXaS2RMYQm5HItPjLuTc28\nsjMAw0Y+kDFScK2rImx1bNCfd7IenGrGRMx2NdK7trG4JyslaiYrk/JP7scj\n1g1/\r\n=zc3E\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"29ed426e3cbe4b59dbc4b9c7c4ddd071a3f8daf8","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^1.0.0-pre.1638"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^1.0.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_1.0.0-pre.1638_1594326655101_0.14600640808497145","host":"s3://npm-registry-packages"}},"1.0.0-pre.1657":{"name":"piral-pwa","version":"1.0.0-pre.1657","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@1.0.0-pre.1657","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"c92ede7224679708fdac5709a2e3c592ec285b05","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-1.0.0-pre.1657.tgz","fileCount":25,"integrity":"sha512-WXvsrBB5GDW3Rgwt+DHSaV/PRl3tWeH7TY7rYpFxG7Nfvod9F3nkOh226oPJAc+B8XZfsvzlyKTTtYvmH3vAZg==","signatures":[{"sig":"MEUCIQDLWXB43RR1qDvY2zhOerPPR7nc1cHGC1fTIYnneNCl8gIgCX8xropUUJucb6H32beN7IsZd2yqsfCZQ0CYg8YqbZ4=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48969,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfDWyKCRA9TVsSAnZWagAAwVQP/RjSm04qvC7wKyUyxvT4\nuWrAmQRZomKciCrqqKs+AcK8PFI69RL+bSu/7r+H8RR4re8PyGuUkVzMXgr6\noH1IJ+AwIcQyeb3QhtW/+ZErDsSu636utcLKh5kinAUZgcHBtzLWiTtM8l6n\nBZVLdnlwYN7AcAaKT9VFwz0K/7dERvPK+yleD/v1SuhD9i+6TiUHhh3RZp4U\nuLYjdc8dvICdrkp6RTKL45zfuasGv0CAkS4MJ2yCuVPpIxF39DtYn/gq914K\nikuGjDSAKeCGD60uBlWPxPPdOyE8lfWtfHHs1Xqpe9cq6yKlogn96GkjTe8e\n27boNUim9S8qxR20979xsHsctHOwutylQ5DTEKnT2ykH55YYsVc2XqUDVjg8\ny6upPEr6fvEplXVaw9K/DhLbcgNTSVef0NKicSjw+WDDcLwpGHbPpCp4euxb\niOazjUr+o+LWje79LafCBdI3znk+moTl8QCCOl6y4MjdU4ngSJjAtUu8+a8V\nWiECSp85nNzxjXmJL8ukLYKxVF4efUvxZjWG1ykjw8B8WAusykPdlha2NCI2\nCTgp06U3Oo6iHjplQyyNGF+Kgelnf7R1ax567wTvQ3d4zzkSfXfk7/bnxgRb\n8YIdsifDseyBJdBxnE1ZH7kpoWP7S3Tg0K0y8MTeK6ZsnekOnJeoVFhUkqki\nq6AR\r\n=th5t\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"793a4aa660d37f25c1f7eb9951935f23eadca798","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^1.0.0-pre.1657"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^1.0.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_1.0.0-pre.1657_1594715273554_0.65124972453168","host":"s3://npm-registry-packages"}},"1.0.0-pre.1682":{"name":"piral-pwa","version":"1.0.0-pre.1682","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@1.0.0-pre.1682","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"d6fd1263c0187f11bd8590efd04e12c218ccf361","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-1.0.0-pre.1682.tgz","fileCount":25,"integrity":"sha512-0ghubZIR41YRtMcTl4L3QS+AAGIGvCUpTd8rIT6YKLDNRCZbPQkU5f6jutzpO0lVII1BHzpob0MHKX2GGUHz3w==","signatures":[{"sig":"MEYCIQDZBFSTjfdVarcf5wKhMhHTzRW2Oe87mY1ErEzC7RcQEwIhAMe2gUmsXmWLUy/uxhAeGEproc/t0YEBcPv2XJgjx320","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48969,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfEHacCRA9TVsSAnZWagAAP0wP/0cYJeDNWR60hWadirpz\nHiGwo6J/w0N5sUw3nppa1pc9+4+4h22klN0TzomPU/SZtCpmLLtII1JFkDMQ\nHXVqlGCS4jsWK9NYQMQ8oD95pZIonN0jniqkMD0VPkwMMd0TKzhuVFT1RLaw\nCjQY0Z/LP4BveegJ234BZtd/t1mz/qMBdl/j4Iqp5hk7pCpDSMsawmcD7YZO\nAWYHwnY/L5nB7tQxCC08/8YidmfEzPG8Bn/xBwDhfB5jXCFn+CkuaAjJWvOl\nQeLybgSqE56GPd1T2Ku3hwF40ov4uHkPEO3Acn6B/DpFeZmN5B9ggtta8v/Q\nGkwJmUW5G/++OobYDqCET/X3cqID8vTXUPeNa5MnFSDP3MJnRcCk9AzQNSSU\n2/JMPh5ehpSeZrKipJJ2b9uIEmGQdHkOjbtsQgCp9mFfS5l2SA79348sH2It\n3AzBOypneplSTAFFjdOZLymxd6fqfvsAgatk/WOSLfC5FoTWpYf7Q1nlbYlh\nyt6k8KvdH14agG4ambyWYE46UBcQSJ2FLy8WKvxU/D7atXs4FvfFaieEXLbY\nrfM/Nl9oflvbQfrdV0TWNP5HxEf+wHDulLVdHKWOk2da+G0Kd5XPHjANG31U\n7UpGVUwKIDXF/prdmwbkTvrKg0lTpFSRvwWzNsOId9altGw2lSqEir3XUtwO\nshhe\r\n=piGi\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"e55c9bc2d54ad7d868b02c0bcdf6f2a939dc8f10","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^1.0.0-pre.1682"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^1.0.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_1.0.0-pre.1682_1594914459960_0.0113751744330981","host":"s3://npm-registry-packages"}},"1.0.0-pre.1690":{"name":"piral-pwa","version":"1.0.0-pre.1690","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@1.0.0-pre.1690","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"458174a79891c8ddb7b76fda1d05dca717cc2b6e","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-1.0.0-pre.1690.tgz","fileCount":25,"integrity":"sha512-/OrtYgfL2L8vgdCKNdhlo5nAwJGhMYGkHlzuPJOfBys/DXywl7Ie7Kef8keeTj8b8ymKhgRjbEX+TelsgpsQFA==","signatures":[{"sig":"MEYCIQCIMy8TaIkYv68s/fQ22WZX/Zq0oaVIEccOq+mYwST/rAIhAKjYj3iA0x3R1mgB1+CW1OmHeTAHuFNO7geT/aIwCD3n","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48969,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfFVboCRA9TVsSAnZWagAA2cMP/23hoTez+QfvQ9nWmLaq\nNHkeXkLMpQL+Y53tbEJ/WP8N1XpYYbUQWoBVTJluxph18rNQuU4nRjWF5QuO\n2LyClE3G7m2xNoYE4kG/tRCrb1bLDSK9tE8Ac22zWhaslOTyg9vzC1j9bhMX\nt9JaYjjnpVuS3OeKosgNc4xSLu2MfwQW07kTD7Xm5UvoB9jAHK7SkBiIB4bg\nZvIJklOSV/qvrXT5l/V+j4s9kTE/2LqyZgNSg0WLw51jh+wTlveYoQLAXuPg\nuaUOqjsCrXp3tCEgtLeI2U4d+mg//57naNf4cvPY8C1ZTprPAXTFkMYZzECA\nu/UTWM5HlxOOCXAR9PZBrT7rkjvmpyPPRZg5xmzOFYHO5/0uqVJUvXfWGwTj\nGz6H5+3C+3ru0oZpzpJXAcokK2z4P2OfPUBrxfEGZmJ7KDVEZi7SKqs6s6pX\nlLZw9aSK84oUdPjKVNaYB6GIqG5lwRuHF3OLvL6bm7j3p1vzbnSwvUsX14sa\nQE+2PO04E7DjFWXbaNdrsuIO7BYYe5Rf5KdASCC5BrW2BFXw3LrdiKEOXpVM\nuRgr9XtnEBKVCdiuSPmPBCfiCvVq3NaUIjJq9NUAV1adxKZWLT5i2b/uzOBQ\nPmee58mlq125ec6sHCwWzWsth+qPQp9XF24YE7fPehvY9W0LzZTdcCNQuJuX\nsxB3\r\n=g3e/\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n> For authors of pilets\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n## Setup and Bootstrapping\n\n> For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n## Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n## Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"19e33db4fe045aaed5466fd12a868c1e5daf6ef5","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^1.0.0-pre.1690"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^1.0.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_1.0.0-pre.1690_1595234024072_0.6132096990936398","host":"s3://npm-registry-packages"}},"1.0.0-pre.1699":{"name":"piral-pwa","version":"1.0.0-pre.1699","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@1.0.0-pre.1699","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"82cf086f96632b80dabb66e88f605045cf537665","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-1.0.0-pre.1699.tgz","fileCount":25,"integrity":"sha512-ByqM04deQi8O1QWp46MF02WXGLnjj063CygN38RO4CYXCA8yKUlZWvMeZXniFNzqKWkqb2+FaRpgvNUUoQHHcg==","signatures":[{"sig":"MEUCIQC5BXhpVm0CHeui8gznjVWxbaQlpzE7jBmLSDwvN6f/mAIgdPYUrZlyubc2uxv8okau0VcD4i5qcqtWbMZJstQRIcE=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48971,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfIKpQCRA9TVsSAnZWagAAIvYP/1kdpWyY2w0AHAXVjrn/\n1lM1lj722nCA+rZ1LuDCkpjjbYPBNXkntQ956JvoyEMJQEwHabx9pCHUtXxB\nFBejdn+SYhq2ieKAFACuPMwmnC+pOHmcSipgZTIBxhoTbkoNYr8nd8k8AiJz\nr95EO6j1UcQz/RxUHliK7b2AjyQayWpTduL0rWjbyorML/Eal3CgMO8NFbWN\nBIYZ7+QniWj61LaEE04JoovCaWexroGlTjQb+hTtjYRrP1FjTnMLJkBbX329\nBVKHuIzAx57bvYqbafTVBxCtmYO4d+Bpze1ynQADPG5iN+3Im1dt5fD9+emw\nD0C6wC2Wg9CdTF9C2NSC396mkQAr1cMVVVO1aDazmr7taNTAR15Zroa9Snrl\nJBMudBvULI+d3ZU4kl467d2zs8CRIC+f6Q4bMRzOTMhk2GFau1dOpJ6xM1dT\nkKOyzwSMITbWxBphtFb+Y3/UbIzTIbAyJuJSVZsXohwoNyuS6wflCRqfGJY3\nELSuwYi6HgjpblE5CuZ0zpK+gMe6eHkwl46KafzHQMO9j9FaMaf8fPZZFP6p\nI6nn/moJrj6hP7YI7OZzZtg7p3IDjHNxu/35TpKYdq7YO76o5VhhaDZNEQiQ\niYd+4JsUzjsfRjJ/2SYufyEdW5VXBPbbwwjTblF6Ett70QYeBTZETHCzKjJI\nvWxz\r\n=jah0\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"317680d30bf226a6c54a4e05f9420fe666c090df","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^1.0.0-pre.1699"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^1.0.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_1.0.0-pre.1699_1595976272190_0.9354191088131436","host":"s3://npm-registry-packages"}},"1.0.0-pre.1730":{"name":"piral-pwa","version":"1.0.0-pre.1730","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@1.0.0-pre.1730","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"581741831e57a8bdd616fef5b830c12abeeecdf7","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-1.0.0-pre.1730.tgz","fileCount":25,"integrity":"sha512-Mdi1mpGtLl8ZxNAKXl0A0GaBCYg5bIz+hMmlkSh0Onlq3weOIS86ypp410cfZ4LTLBh4YxmNlmf3742Twbmzog==","signatures":[{"sig":"MEUCICO9Y3TBPQkCsJoPJQNNsjV/CgkOvaTyLDYaqaBgE6zgAiEAxNEWx212immEvfrqCTiWjO596tNhwr+hUs1IFBedg3U=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48971,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfLB8wCRA9TVsSAnZWagAALnMP/juHqBSLOWb4+XXNVQ7n\nkUWK4WMK/WD6EWsVbthkvFACMzNGU5u6KXxFkUmvuQeJienQ8NPT40/AwTCd\n+46VjyKWoFcl5vGyy2NqhS8xPP8v/aFrHltkF6fJ8lTmmIZzx5Owyy/xHJHR\nVaKm6dG87zjL5psBizC6Pc/kaUvkKFoPZJw/Z5nl+mT0RpYIb/Lam7uf0fo7\n8BObjKr9OHgol/7ym1LsAbzaINJqDEQ7Fh4n/qy959fMGAAqIM6rX/43PP4i\nHalhIwE7oRgksDJ0qRHNszl/uXAchrHhEDcCT8ExhoTuRSrx8sJFqce8MJsN\nZ70wJP6FxQX5JBBYO8MhVrOVfx9qOeifRW0ZQBp65OjDgF81dFN/mzbdNXCA\n69supLJKWcCRTqikXC1JxEF9NkDJh2OVqPISs91V1cmkAWFcUOZBVtZ5LzTQ\nW5SjfxVYIrkRBZujL4hmI5kAtgPqGpiH+A0aYyn6n2CVMPb0u04VV55g8Va4\nbyMnXCOaMDkOo3VWOgjo33XHNhwUd5ncJXxFzHaSdoHImD5QX/OyHlHUte5M\nCTk7u3ct9GR+CzuN3fEoI1Te4gcy8xIlhZVvXavnGAEQjhfVOd0vQ+/jdtuW\nGqvVLizORa8sILOP7D7vJ00Ji4uLqZkKb4BnME1IO2iMGZSGSUdM0i7E/ebv\nsEW+\r\n=m9KB\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"d4442f3ee3771df77b8904ba5c0ebf8c85b9a9d8","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^1.0.0-pre.1730"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^1.0.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_1.0.0-pre.1730_1596727088327_0.21472101719474113","host":"s3://npm-registry-packages"}},"1.0.0-pre.1746":{"name":"piral-pwa","version":"1.0.0-pre.1746","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@1.0.0-pre.1746","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"c83b72efa37bde2e6a675e66d669ba9109d5ac37","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-1.0.0-pre.1746.tgz","fileCount":25,"integrity":"sha512-ILKzd22UfadSwZovv0ovs5eQCD4BuRzvkOESHFEyBAQSEWaQa8uny1M1zZcqcnWrPymM9w1aa0mAZGIay7OdAQ==","signatures":[{"sig":"MEQCIAOlZ69soqo6nJsBQy09HrHNLDAyx/LF1H0hq96TRVp3AiBmesfCx9anrdMvdMDaHsXsRzI6XAchpQ+UDGSfyppFNA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48927,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfTh5QCRA9TVsSAnZWagAACMEQAINMTOw9qqXIH42RIMl6\nYZEk/t+W8Gx7D/gcgySNDUaDgzYN/Mkkkh7HYGUhxMXF0fRCvJFJoHnMmhDR\ndFU326w/7ilg5miykxYGTX1W7LsW3lIGvMnG5c2haU1DG0+O5ucJRWdg5dRw\nCqCesopMj+6bL/f+MiAy+YoDVEUKkGN+PRB8Vtz/Y2VUH3EkWYJ/CB8BR5in\nfpvJtdbxyfPsbXN9wRFJKljuyH3nPTdgqvrKBzy6XS8B421bFsiqAqVFn89Y\nO5xahIF3The+MVeV9uVLAmEgpFDE9uRAm/O6JLSjiCBczK/RY7W4Rxjo5FLj\njdJVZLMUE4+JNuqmngyRBoqnw2y0ldD+2Eu10xQGtg9+LeZapI6w+K1Iisxi\nRKYxheUd2FtZK/TWlUd7+TgxM57UwTCoHVYQPqGsWPbhQM6LLToWvdkvUgfF\nORwkwDp7aydaUwIWMre51fg+vcZjgk69VyUdbLzcSkRBSRXVn4ZPUX3Mij30\nFXI1JdMcIItQ559eHk5hWz9DL5X3AxFiLftyhSCNNp0BX6mcBcz9Zb5VsMT/\nhX/Hpt5AiUh6/7/lGJA3pxxBhujSUkQll+p1Ey8/jLrB4Iz249naJQIXPwaQ\nmlDXaVAm0C8jm2Jak/rWXfD1bq8aZWZ2RzF6PtyFTxuJsZZVCJdllCwXkINi\n0clS\r\n=9Txf\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"afcd06699b9ef8e041ff984d6fa6c5c94bb33638","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^1.0.0-pre.1746"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^1.0.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_1.0.0-pre.1746_1598955087622_0.5420886215337766","host":"s3://npm-registry-packages"}},"0.12.0-pre.1747":{"name":"piral-pwa","version":"0.12.0-pre.1747","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.12.0-pre.1747","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"94e2dfd5625487f96f88583c19d1ff2a694d52e0","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.12.0-pre.1747.tgz","fileCount":25,"integrity":"sha512-0AxaBmKzBpfg8Z7CKyyTVXxzCb42I/FQgxhSTDE27jSQmmQIqQ+70N8Chcr+lYe9Jn708FW/cw3V2bcu81fOqg==","signatures":[{"sig":"MEUCIQCcXf1ui7k3UzfdCgE1OIPqfhqh4PpCmnKtTkU1lWaIBgIgL9MI1jH1o8Bb5CiPiBjU1uaDV59kdX4MbiZZzpk4VGM=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48929,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfUrgMCRA9TVsSAnZWagAALRwQAKFlbz7+DHvkLZIs0z59\nE1TpLob9TxJ1E3DXeNYZB0/o/zoAkfhkDv/GdBHsqFmaS8IFqYSlpYAL6i/Z\nGSMlTVFG3a0VK67yiXWgVarSZyjHhn5MerZ29gxXf1a5KySKnCnO2o+yIEea\nfDvEjO6N3GqnG/8WbrsPIs+PDrTSyQanfw/68H5mQn9v3TRASKeWStFLqrUY\njY6rkvRdOYysvj4LsAa3vSoztKZOCKJk6/UY8DVKVl9zsnA3NSTm9Ua8cbUh\nLkFlnZxFquvU7CYA9OQC6AmsCQJo3dJb2TJevGV3kxhDIsWHtVZurtOcEwP+\n30wonUH+zJ0AN3axWlcDgvZ2Bq4nx6cYIB9+gHQ92ieTiXVAFqw0kupvSURD\n8tL5BETpr0vGDKsSMv4SbUkN0g7pwqTyS2MRTsWBTXNBTl8dvlGR935R6qIR\nUhjSDxZxYl5bf03eZKG+6A56HGWQuzzyy0Xd0ob6pTSdr10LHZjC96D+BAec\nAQuLk4rPVGfcTH3j2D0P8+FkwFvveWg9SzZg17ju2aK+biDVZfsBaOkrM2D7\nv8cZONSuW6hmUNj+XONvdqekDNnCu0OkNjgU7JTWs0RSdmRfkLFB1f/iuESB\nSW4TibLvFo5EOCVPYLMXu7A5tk+Rn4peP+DaHIhohz6RhPL/i7t44bbvJP6F\ntYOj\r\n=CPeV\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"fe6d8ac1e84c1760cb54355f8fc627bda8625ef0","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.12.0-pre.1747"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^1.0.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.12.0-pre.1747_1599256588471_0.3467050540059775","host":"s3://npm-registry-packages"}},"0.12.0-pre.1748":{"name":"piral-pwa","version":"0.12.0-pre.1748","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.12.0-pre.1748","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"1e2b6f170085270e3baa2a824c43d614bed98cd5","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.12.0-pre.1748.tgz","fileCount":25,"integrity":"sha512-IsvoKPFxIkOQXXp2jthtsRal3XcrYRBdj3/BtLqC0qhni/VvwAQDuLYLY7nmfu0nylsElXy0G/u0hhuRb6tZIQ==","signatures":[{"sig":"MEYCIQCP+ip14j8wrva+1nnN0wrE5psWLe9u8S67u/F/k9awmwIhAKZ38lyHcvvH1/V5yHeecm5cfvxeWer1RHP9om5x/vUg","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48929,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfVriiCRA9TVsSAnZWagAAUykP/3KWgE7f26nM4vaEJQ91\nCYetlHGdjbXhi3CqOTivGbM1jEYI2fWzyt5aHIrB7zqrEGQgm9d8BMUUHg+z\ndWGq1TKHBo9EC+e3tts//tS1LnTdqGTCoWAeu/drq5MVVVRQIt0NrEYfz8ol\nve7KBdZMCzIklmxMgIsefV19Uee9ZAP00tYwvOCyHAcq6TjXxaJqz+tDTvbu\nX+X2JEj/1DmgRgoGVJpkwcr7JG/OmoDPCUBXQ8ckfRAvMULd0+wkdEJRtJA1\nQDPw/hCe83h1z2DkbA5Dd7vDU8wVSnzCUOiwjXzot/M7UJ9lVQntjoAXnas+\nlrZr7PpEogZkAL11hx+b+ydp3C9HTGPOqCcTYq1uY6CYWVJt3zRO0aj3oPOK\nMY66ppTMOWg5Aif/vUILo3+zksr9MPype2X0K3nk+kA4Fq/A5SO3hsUteSXy\nuE0j6sB/FGtRtho2KF7YIAxidWasaO6oOWz3RFOwUcBsXlEkOJBx4XGKF4Oz\n5Aq550nLSZDny39oHzz9kFVopEnLRn8GbbPNgPcxIJo/+/qCyQRwAtFdMe6N\n4IgClexAyn+k8X5jWCDeAc7KbASx8tQM95GMoemEcB7Tr39wzq1Sqdn3mASz\neDPt9APZkP1xlaLND5hU4VlQIliu7zsRKA7U4beipgME0048gjgVriWYbDE0\nKR8H\r\n=F7nv\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"d34d6d2ba17aacef87ae945fbefcb75f923562af","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.12.0-pre.1748"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^1.0.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.12.0-pre.1748_1599518882325_0.6015774938722134","host":"s3://npm-registry-packages"}},"0.12.0-pre.1750":{"name":"piral-pwa","version":"0.12.0-pre.1750","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.12.0-pre.1750","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"a702238c2169e1df6487192be18e12616835cc22","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.12.0-pre.1750.tgz","fileCount":25,"integrity":"sha512-HnHM4NvE8syyhQJL9CIvA9NNvGE2kQdp4w83FjQAICMNiyftJDYol156BP1QkOnoLORuiy68OsMcwHKbXP+Rxw==","signatures":[{"sig":"MEUCIQCjZ90odZ4B+Ihm1oUbKXVDn6KHOCB23tUhMpdS9TbEIwIgEblWpDHeYrdv2vIWdOTZmTMzv9hK7EuPnG4qsTNeyq4=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48929,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfV1i2CRA9TVsSAnZWagAAT6kQAJ3BA6kLLiE9vLIghIUf\n87T/wi9OBuLbZw+HsfpnfVzOlYmpRNY7zJezl3+JnWjxW3g06bFOZhma83wI\nr1wibhIqdaYf1BPM18SwNikTxSsuzJ9Q1/PmdrevxGjL1WBV+rw41Zkln17U\naO9CplnFWKHBlX7VKfM83jokJgsspO/+oGso3mFAVByDxulPkVbfc5r5xRLP\n3sahDy/WoQndFc1lHR3hKNOISfYJBwlNd9YCAU+22Jnzfz+twn55aNWSXcFj\n/f6UFR4cG/u54OJ1t3qATbPnHnm9/z0ZVcD/k6OZzymuo8ql60VmYwuL9b8x\npm/KkmIkrkgcyJAYCEQTUQTrwnP4Qi0unMN6v7rQMzFAnAWpebKsF7ywYAF3\nq1tWcL3tx0GsXfVVfzq/vEOaWT7MnfYFA5t5BuNst2R6GLjUwT3a4SM1VcxO\nGvXWHEU5DFSHOOBYhLp2sFn6nbqm1gCcEPAGIXYos5eQo4Ha8g1+XuLt3Xwf\n0N58DKgzqhcVzK1nPyagfs80a9YUBWQsdcbyv132D2CmaZCSRHEdPjGN5hEc\nRoB9Un6KBsisD7OlDcgg/7c0nCEmqioj9uwLFDeHW5x1xRsTd1/mdkhkj3qo\n5fsKGtXkYeU7h4n37w/IVJ+k11oGR7fDdMiCcGwssc6WNS3cPEfFzYXQvIw1\n8AyQ\r\n=i4io\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"a72888f51ad776b30e4b7fbf86da6833a5f669fa","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.12.0-pre.1750"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^1.0.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.12.0-pre.1750_1599559862157_0.3426443160465926","host":"s3://npm-registry-packages"}},"0.12.0-pre.1754":{"name":"piral-pwa","version":"0.12.0-pre.1754","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.12.0-pre.1754","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"fbbb768f2d156dfc807bf11d3c31d6cecb32c8a1","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.12.0-pre.1754.tgz","fileCount":25,"integrity":"sha512-wDzhwKyXpI37+djNfoXiRWE7mMcdgo7lcJ6jJeDhIr7fNe/L8+0nlRrC9oF/BDRK4o3HjTv6Zh6zTWHNl3p2IQ==","signatures":[{"sig":"MEUCIDWkrjdcPiraU8BnMs0QQWN8mGnV1AiWQArmD2/ziK48AiEAtOqom6gsQrJxLFBM2HJA5YRiwASpGm7EFJQDgXrrRcM=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48929,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfV9soCRA9TVsSAnZWagAATc4P/jUQ6oMZtR8edU++bRKj\nydksbwB1XeRnwzeMwvkYI3/pNBLTatWeYKgXkWLqXP835XnssU/+tdKn0HHP\njr8zmOn+uSnW5z2GSTv/bY1uc2GSLODp3zlZC2Sr4GK/m3ezdZCIiSQViIr3\nDK8vkh+lHoHQhjnv4khEF5Ddgfhe2mgmlNN0C9nhWnrdW5EQy0KVXjChMqzu\n1QZ613Zkf/6Xc9UxNQWPYmbUbzRTZ2QWcMMZTa3TGJ5+EKS6TQFsakol89pu\nz2u7lsRTtRyb2QpwbW+7YSnRCIuWpKRGvVVmx93qSjBP8f6daVk/SD2eLq3x\nXX3y7Mc+qbddDQp0rgfpkDgrKHwKpkCJsKeVO6J6NDXHKaqUKYLaMFu2t0UA\nvuwJBAU+Geh/oSbNzacOQOb60kb/w2OomkL90AekmdGyN6sbfZufucBK1t4W\nuiswrcTGUy5vwZAPK3uZ07RJeZKK/qGpyxSJr7oKwphK2hrMBl8bVs6GqlRa\ngS2XoCkBUfG/X9Lxr4DsSjMlhOyS2UQ3MYYleYpo6r8DaaRNgqFcwOBr2rTs\n1GWtNO9Jlheopb84Mqnr1vUXZIEI1dxaG2tp1p0P8zP59MJ7Qz1qemB+G3ru\nj0i3R3W2gpMFZ/5aUPH9L8C1yBB0Epoyj7Gqfpitu8lbWttNyZuMy8j205z1\nrBwn\r\n=znsa\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"7ed660c31b0ff8fbd83beca98c947f159417d27e","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.12.0-pre.1754"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^1.0.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.12.0-pre.1754_1599593256090_0.8732831839596413","host":"s3://npm-registry-packages"}},"0.12.0":{"name":"piral-pwa","version":"0.12.0","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.12.0","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"8f66a52bc58be0b21e3164947fc461fdeb0c084a","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.12.0.tgz","fileCount":25,"integrity":"sha512-LKojPeVlwmZ8EBjNj64V/ZKjQarvObeXPeEGG0Ua53tho3e9x0fgc6/QySoj3EdZaGfXj4y5bvwQGng2iIbouw==","signatures":[{"sig":"MEYCIQCYdQzH+RrdIvPcVXidzr3LMGXGmRexG3WfYd+OGJcUWQIhALtZJKydcATkUpFK3vdKKy4wAEwnw4ev33AOdOEomXQ9","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":48911,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfWJe9CRA9TVsSAnZWagAAWNcP/AmLxuA4MCJpVnzCA45V\nbVthF/ads+x8Wb8T10An51alXkMVA90T7BkaUJHkC9UBrasEbTnBc9iyrvS2\nJE+KvuQgrk31j55T8MC0NOZiNW1rJ4M1wWV20Pxv6qLQKOathQrxLrsyUKKw\nXO6lcgrPjlftbDgs7YYJEWaorGVANVGRGez0EydpSIAOKnaoel1V5voaft9z\nXUxn5Hsi0tM6QcBzEhtvu0dXzUR+bv/HgaRTkMXUoSwI0nFFidBt++lGWCZb\nTsOfFlSEbCmd5h2lM92/s+XupRqA5/+cKle2CVehzEGWUbuoYjqxpxoQIB0c\n222hOmNAHHFnQ8m0rincvkaTSxwr1b9n3UlTZFmKU9DqRbDuuMqWNoFp2IBL\nsZCLBCPIETAzCrvqMPSsdT6ZCmCGsTAVizdWRCRUja1BclL+cSyQMXT984uu\nhkgP8hiePXy0GrsUORAsYdMCaKsDodi3sa9eedQmCEqVF/LLij/W4DFL+wuc\nAV7KXZBX7c+eufjNZD4U8qXg+qTCuwkpbkgQrJtK7Y8uFqyeDyLxxFPpx+/b\ny+u1tQura98NgkavJEojHYq8j4uuM+evoDflv6QfZG9aW5Thr8dxvtDKhHm7\npMlF38tcQ7mr2ffvDAPytNs/CQ3ZjQ/EBodtjTn0d13OHYHnTr/ToFljxjc/\nh/e7\r\n=s4AG\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"2e08688de476cf93fc4b63d1cbad4a27230cf6fc","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.20.2/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.12.0"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"^1.0.0"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.12.0_1599641532686_0.5560777543944904","host":"s3://npm-registry-packages"}},"0.12.1-pre.1768":{"name":"piral-pwa","version":"0.12.1-pre.1768","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.12.1-pre.1768","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"2ec4d34a4504296553e3cdbafc87de1e2df20a76","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.12.1-pre.1768.tgz","fileCount":25,"integrity":"sha512-CRyEv9pr2EsoDlRCpd20CVAPfhRwti9ALIisAgXXHitY9BkShI//PhsdH5OvKFGcigNIS6zLV1NiYo8Z9MLE1g==","signatures":[{"sig":"MEYCIQDmv4R6B0h8TafHlrZ099cNGLQTnERK1YKql04JLP/OCwIhAOvGOujQc+mo0bIXq2d+SbpGNnDuxsmteXEL2A0UQCiF","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49287,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfYiQbCRA9TVsSAnZWagAAovMQAJCXEj5MWSrzGKUVFIUL\n5ocDE3Zo12g9aVwsRHgwV57m9qFChKXzdfq1Z+FWa3rV6jmZFCWcdKOMcmek\nc6mVhxIcuKKpiJ2daKdbe3rjBmLmVh2enSUDOqnQmD2jrBBQ6/2gzFbe5qIi\n0bSm5vZuucBHUCqowbus3XE4STrLeYIIl8eN4wdd815SCPe+ne0qcx6dz1xw\nILhtlSHwB1GvpQMRGHqWcPs5hJ+dH5nP0eANfhgppLiHZWaMza1ytW+HBcT8\nB5XJ/28ajYh8auSWDf/dS7XOoeMVG4dQ8MGw4ziznbF6BTXGmurKiLRTPxym\nKokqJVa2w2n+hy6PO+P3NCNbQZryHYL3PcH4OZIMXJnbR4EJ3HQjzjQsCJ9G\nnVqCbJ0covxaQtfLGfKgNUuGyqKov5gHJeCcvc2+HGD6PbViCfmlJkjROHQB\nyMF+Q9CPnK7Dk8VNYemSXc+sqOXodW5Bv+t5fasa+zPdqwTJ7pFdsj3Oiq4V\nRvy2jy9UODPtzptef9NtkcdiDjI4tmYd78yGnTCihNX5RD0cIWUdsIFxGFKe\nC1x6xCAfxlSWTp2hEYLQMcWSxl2Cth3GNj1mToLPAZ0/MXJj5SVVVe0OaMnk\nj5bNnOijx0g6GCS+KurN6Y8DAIFovJ5V0fLWreowUfYljmWkperGHDUmeB85\nct5c\r\n=0C0z\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"b3e94d1fc6a541a787506082f6fc9d0b8a89c3f5","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.12.1-pre.1768"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.12.x || 1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.12.1-pre.1768_1600267291188_0.8486942614318311","host":"s3://npm-registry-packages"}},"0.12.1-pre.1770":{"name":"piral-pwa","version":"0.12.1-pre.1770","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.12.1-pre.1770","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"a981421f401390867f699a7e33395e74d6ba4790","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.12.1-pre.1770.tgz","fileCount":25,"integrity":"sha512-uBGI/5BMncepXtzz/UU4qg8lX0H4JubNvRy6NmDV5aVAHMFcvohkhyMbxxWgFCu0RED5HrHuDmVWpg27a5iAtA==","signatures":[{"sig":"MEUCIQD0WBFUn9D/2KXRBKKIhOWko+VAKObXUWBbi0bItKUcfwIgFRLEI8z4uUaI6f8YToOkk57a3JvYaotAMLnW2k2Yc1o=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49287,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfYjGQCRA9TVsSAnZWagAAcF0P/3xSxUg6L09c1wHxsfJH\nrHNkxj7Mh2jFO2LFd4MlLfgA9suAsUyrtGp2KsOjsUIPQPoRjJqZlHIno+W6\nOnXCjxl/MbDPjRcGRELUm7kdV3fNp15yKRI1yvV91YKpQBUK9bv3ipSnCPrb\n+sHuoI2UwEauWgOuzNjDjin7T9LpH1IE+Eut+WkAqEYdnGhLut23p4zBj/hq\nfddD5yqBshlzK1rXC+at50LGVJf2dTMg9N7KhiIwtD6X7mLHldhqpOaPQTU9\nWS7UjWDmke58PvRqpQ6YJNmUGcB9rNeJFSva2LTF8lwEbzvcKSfM04VevKT4\n4SspQA5LAmMrht8DpOpB+BRBkE2MuF3Md4StgGe8AtkXxNlko7B6Rs75iti7\nLKzPxGZSNu+CkZbT0A+xx9fxDDrOoj4144FIL/Zy9k2GecdwbFgqwghYsB39\nbegk2OFaCmDKGPErBQ1NSF800pYfWRqDktN3DC0ga1wfkeNVvfi3A0kwJh+0\n20cZdxpiRCehFQDYHXh1jDmDX/22HEksqpPdvOVJOSLPJCipc5anHolAQD9T\nsRJ0gKuNLVxc/iNVV7lG+ENvx1hTIcKOENEfA3FNrVvk/fGSzOfbmx+IVLqi\n0w7cFEId4e53x+y2pEdzpG0Uli5uY+fvnzAsKSr0f60GCLafZgRkFruzriv6\nB6bW\r\n=4gvj\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"b46d5e5464e032fa25c1b9bbebb83d1856188b9e","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.12.1-pre.1770"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.12.x || 1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.12.1-pre.1770_1600270735811_0.5211087803810353","host":"s3://npm-registry-packages"}},"0.12.1":{"name":"piral-pwa","version":"0.12.1","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.12.1","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"89cba6e625c5ef24e946f3d6fb22e02a360f39d9","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.12.1.tgz","fileCount":25,"integrity":"sha512-lvNfc7RqO6xHOSZPeZYoif6YxDoWOJuWIkHlay8v9myO7J7/DNc0QeVS0RkFzFLQhXvj2L+oe3gXb2s4X/674A==","signatures":[{"sig":"MEYCIQCIhi3nQb5s5qJyydOT+TMzBDs7rYZ3UXBLOMFKak4WxQIhAM9lTWava2Arf0/Cg7LZh2Y/qPcGv4e6HMXEVpb8qGsc","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49269,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfYxq+CRA9TVsSAnZWagAASPgQAIimHOT9pme4dRLcVWn5\n/tgyVb3DjmXq7EdELkTLnuL+mJe9Ig18m/nh8PproEc12hEmMvZDQiYkSP8I\nBBs9KKObnfQV0JJXpZJrH+a1RR9mNngKtTuekuplI4n30dUGh7y0qoMb9pjG\n/OQa3Royz6gqDYnr2StjMnIo3RVCwaIHAnZ9DK+PG4Ew8FPQmLpHEIADWYoJ\nmtXNBivmlweNeY5JdhpSbR6dLLch1jSljuK7ItDUXPgt5xDRTtT0Z3n/BDP1\noijr7WLZZ0uby7K6YE4tU3mLyYuIjh63DGFek9ki/6rgrK7hMKa7A3/lgYP/\nbcDqia/QwU6EidvNXCFFLFoRbERVAL7kIwW+keFtSbxnQjByZS/eAg2wV9NY\nGZ4+kmFjRcOWnQRxRwszStWYajb38LK+dGCcFg1SHeC/D0MfvTVej4SFC4C1\nzDtNPHB5gSA5RdiIheojp3NUqKgHeXz6QjR1wdJFdLTqXpdeVNrDGwNitMmg\nAO7VCZDw8HlYTEXcmCIiAAlGEY5jdfg7eHE4RsVxrEkXgUDR6BPmjNN5ra0E\nliL4CH808OvZUG1IFcAhleQUkH8nPcTpbMemrzABLiNqxwtNZcwtqzU2loFC\nE0wFaIHoRa0bUFLV+Cqm3lv5XOBMGibSPmGPNNKzoglzornJ0NWa6HqTjgTm\npVDh\r\n=1CVx\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"e49eae16f72d7a735f922d47b64247c71c2a0ed6","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.12.1"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.12.x || 1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.12.1_1600330429650_0.8247819358132737","host":"s3://npm-registry-packages"}},"1.0.0-pre.1779":{"name":"piral-pwa","version":"1.0.0-pre.1779","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@1.0.0-pre.1779","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"0cfc1fafb967b7dcedcbac08367f31c5c0e250c4","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-1.0.0-pre.1779.tgz","fileCount":25,"integrity":"sha512-nL2ViOyuWsBBY+JxjbdcOfm629UEEmkbx0PKqkgAu7X1I5CKYj4hEgxCFS9RLtaUtMEH0mJ3IVSXK53dNVXKJQ==","signatures":[{"sig":"MEUCIQCCO7oG8jsC2CHbzZRU9yeuCzgih1PiKngskUXpa3CU9wIgUKy5cEbQe7oIuJ4qP92cFrMjHcqCo0VF6zo6/6c6Uxw=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49285,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfaJfiCRA9TVsSAnZWagAAM5YP/2VzOiDa2Lz03HngtL5R\nKLAAv9d11gl9yl4gDNQpgaOQXPXjEd4djwEW+4BrEvT97YS9F92L2GPMzfu4\ne1hQuoUV0PY5s5b93SuOGqe5PdFaiH1bf17IEkUIPFku9f8c6ti0qqxhjwSD\nWod3pDplJQSiOTDo8guRcUIvtwDn9f8BwTlIGoEW2A2sMzn7Z/J/KRH7OBBe\nXsxGQyiLXbpLNS8T22p3wApWnC1IpZQxVEvV+hEOqpLaTN84+vBLivTTcuLv\n7sO8peY+PXffJsuebR9ScBB/3HJ2CgT78qx3LTtoxill42p5dAhArzUI7Fj/\naSypsEKRIBHjU0kusXe0HmKbDcJ71n2joyBb8cauLQZT2YHSHq+lbkJhQ2IT\nLNgBOQknd8zl0LzutRwuGdExj8ZhdzvJarES9qZzLmpkBWE/xWO9OnNrIGM3\nOhYQgLHuzBe+Zy4r1hdtlnhX2qftwhL9liwnlTkavpTrHefsHe4wJmSo7nTF\n/sgYMmA4XLQUBsGDX4Fhpp7x9lqPlctaZCN5brMBUgeA52Gr6sjNKxLCyPIP\nPv4vGlGz2cFpnrceLlhmFvDqhEZ1z6LyUpvrxauEc9p9LPy69r+7Puj9XA20\ndLjuLMkgCL2kvFzRNZUoYvmu57egzpph9dTjKF6bFdt60OqU4gY26IkNAhb+\n962A\r\n=XmdG\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"a0580aa5ef2345a2091295bff1244676cd4e1f5a","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^1.0.0-pre.1779"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.12.x || 1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_1.0.0-pre.1779_1600690145604_0.8572432133701111","host":"s3://npm-registry-packages"}},"0.12.2-pre.1793":{"name":"piral-pwa","version":"0.12.2-pre.1793","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.12.2-pre.1793","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"8c2f667c5de31bcd6f816f5cae8f896a9329f2a0","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.12.2-pre.1793.tgz","fileCount":25,"integrity":"sha512-fH7QlsnB30X7yd+t2zI77sNoGX0UsqXSVeuh7BRERlqgu6NSd9g3WBRlQnwNubUvQpCvCa6uz05w67E28DFGfQ==","signatures":[{"sig":"MEUCIDZsz6YBOamsifVhL7Gk7Bant7T+JJEpVBvKvjLzQfNDAiEAuyf/CfqCWwWO/RQbkFil/FQImdcV59DkzSqDRndNf+s=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49287,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfboo7CRA9TVsSAnZWagAAmhoP/0iUDIEmHChiNYVxK6P4\n+f0kZhy0+h4dcLgqltka9TUgrOxqqo5RmgPf5d6o5S0ml47lxTooKVie8XUy\nnCDH0EM3Qhaa9x7C7e0SMaP0khLi36cNKynowjf9mLzI8F/MdTV7ELtn2att\nASC8zyj2WNn0qoZDnpqhZ6rtZ39ikiektq+bJNDw5A1aUti967hFRYwHaoAJ\nYNVJoXu3eRLKkr1HkgdpvDTI+WV8SzaiP2wHfc4+9MYdYSdC5BpNrac26XfV\nqNVT0zOBL/5jw1yhAvMrtZ979CgREN/BqfzVMEqwzx/MaSnMqmx2+FcQ/ODT\nUP6Q6w+xoApLbSOCTe+dQ48KXXSMINC5J/r3rUTrmS5q3NlrLAeURWzFVmsz\n0mP2LJvEqHg+gRDYgtXVupqQKykGvkrJQndMrGDWObLMRZjoMBsOrluV5k/b\nmCzb1/iQBJilQviiYgOHJFMjg5Op/2QPHRRYxsrBQDKofpTncazLbJ6o7LNZ\ngYu5bQm28orlc8roJnuL0EYwSTFBbZdMOxx/iB5/b7mi7Iy6WrbqMPS3QmQo\nwiWIiTbAElOxj4RoVoZ90uLeItOlk636U4RBUOAcK6FvrFY5Qp1VMa9aSZjV\nPoKFa/Erb6A4Tm2NtvH+qun5PAt2TsxLHk48FkNwF5eF4TXxN9CUtzRr31h8\neNUZ\r\n=T2Nf\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"a50f6184311434b296b084c47b8eb844d8a47c00","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.12.2-pre.1793"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.12.x || 1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.12.2-pre.1793_1601079867384_0.1137336232231787","host":"s3://npm-registry-packages"}},"0.12.2-pre.1794":{"name":"piral-pwa","version":"0.12.2-pre.1794","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.12.2-pre.1794","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"d7d425a5b3cf39a8d76267456f0c8797097183ff","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.12.2-pre.1794.tgz","fileCount":25,"integrity":"sha512-i2oe9Fsg6E68DslH7togtTgy+toDvqv2XGcR+sOjFCJFmv6X/7vFDmeGAUxwi93Pb4tY7NLgNUdpp0dj9xPA7g==","signatures":[{"sig":"MEQCIHXLE9jY2bbK91VpamMuiaVc5Limjj0rVlrfXftWEEtcAiB+LqJ69k612Zxl9zR2JHEoOjF9sQha7niE6c57O1Bp5Q==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49287,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfbzcyCRA9TVsSAnZWagAAhVwQAIzB/ESCzZV6LJ+7gIZE\nhDG7U9LQhQWTXazZYxPDJGGC0Jw9f08y12pbZj+HrLX/quytNH9XcIpoTTPj\n37H5nfX5rUqw00JlbzB0szZX30haV8ouiT0ZxrGgPyTg+rRn06EaETBFz/rJ\ndr82+d+LAi8TBmpJ5r+MpRdvk+6TdZfo/VPJSaTXJdOmE8mPAdyPsT+VQECU\ndZxLhLxWOoWB9i8DV2FdR/CRY3oY+HcT29mObSDs2Trg/Eka70zKgQus6XEt\ng/ghXpxGwDOtW7Sp4fPMoZ1tn1Ltg+J149wPzzMFMen1uB1f/zJTm83qvzjK\n6+jVkbU+/CJvGUylGOPID7FlMWraUNgz5Tat9XHAzmXIPhSwrmoT69XNlncI\na7a1wrSM3XVHpbHYdkEWz8cT08aNwVqGwytlz7cbL8gMHh1Jha1P9TO0R+P8\nZvLqwOGbUBepfIcLscuxi8rFrZVvmpCWwNbnLqAmm0hGjV/dOn/vpRVYJD4P\nAmWO2IX6a1j1iK9VQs7IFwUJFDL+dP5O48qtqtwm0O5Pvy4bZG8ZVikPO2EM\nH58GqyIUHYpRpFQIp9aSPs8akmL8fbGqbqngSsxCpG5PhyXSsSMx7JUJKIo1\nWbmMue3Yc6W8+ihE9NCNu26+N0VRTbshDk9f3BThhP55JYxXdPD4V7ht1iMY\n7EGU\r\n=pZ/9\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"2fa035d4ddfef7335619a947a89d94991baff445","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.12.2-pre.1794"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.12.x || 1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.12.2-pre.1794_1601124146216_0.8319058349880626","host":"s3://npm-registry-packages"}},"0.12.2-pre.1795":{"name":"piral-pwa","version":"0.12.2-pre.1795","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.12.2-pre.1795","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"a19384f713aa598ae4304e96462525f0900620bc","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.12.2-pre.1795.tgz","fileCount":25,"integrity":"sha512-7ZO4kKkrVZpocgDwbH6bpRYX40+CxOgW89GhFD4RVQQkayGYlVyAnwq14ZixDVjVrBRn1flQ+jbilm4IPoVXUA==","signatures":[{"sig":"MEUCIBosdv2na5ZoFyML/Bnv3Gl0snxcwNpdWAmemQuvfbyMAiEAqdx2vOYrECX4L5uGTHkcF2pCfT+Uwxo+Q15n0iUaGfg=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49287,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfb6JtCRA9TVsSAnZWagAAdHsP/0kVuEyHzV5lKTulWXuW\nk7YXhsRUDh8uwcC1IyivCfqiGxN8ATyiRERQjsqo5RXyqs8Wynwx5twIaMmO\nekIO6gr7P0kebhB30O+SmG6VvCWJzrLKV8Sr6UuhHG5MKfywzoMB/wtPyGP+\nZyMv0WLVakBkHKs48uyGshFGshnhV2x4za8E9fP6Zm4vW7H3/HYqTv7r0HH3\ntwdjvDTPDd3D9nvfkvt3VniNHR3Wr11EKlxfM3fMgpXd/aChFzVeNFmWJKdF\nFY8AcbaZMTYt9KowUyZuQDDBoIByqDwwdQBpv1bKFhbw9L7Pd+N+3HXPau1A\nSE57ow7Ob70AkXO0A73+iskyO/TMafx82BDdxO98PdJomA7t8jRmIOfLCzst\nawkMMZp5BnpbvcFZo4ARVH0bOVgWdjkjXe4nMgHElXbtdPzKUbF/+X5HE1Sn\n5c3ytLq6zHmRMA1ip8r36l+aFXfqaQgUpFXnd64C1dbd70OKic/nGCwJxy5s\nDjMpkL4IQbN8moR9uG27S9hTDSisMCCrFNtDJOIsVW62sC6dF10FnizMc/vf\n+wqo97GnlDSBsrDzBla2cTfA0ANaeFH2pvFyWhqeAn98sYXtWOa0rxuPgP71\nu7Lo32cEnt9DI/214CEkEn1fYKGdPhP5DVtPqr/Exv2QVeIdk67DLn+g7oVl\no52a\r\n=6hry\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"f7669188fcb7364cf457fb0de1d3ab54cacb1699","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.12.2-pre.1795"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.12.x || 1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.12.2-pre.1795_1601151596960_0.4083333407345766","host":"s3://npm-registry-packages"}},"0.12.2":{"name":"piral-pwa","version":"0.12.2","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.12.2","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"1c1dd9bcc4f3ed485e43d2e128aaba3e71ef6032","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.12.2.tgz","fileCount":25,"integrity":"sha512-8H5D9pBeITXghLI8nz1rDhMrro2DDiy5C6FwNqawOoZeZx9Wm93m7NztZsFT+XMZYfK2JY4exBUavAgjWAnXZg==","signatures":[{"sig":"MEQCIB0C31yGI+5sp+2Oa+SibkIu+ap6FOAJlDGZz+JxwTCrAiAAtewogkJ0POV+jS9Kdr9FosnXjT3U+TuFsrnCDq05iQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49269,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfcWPPCRA9TVsSAnZWagAAiRIP/36ZUsJYq/eF/yRq205A\nveLxRqM/aVeD3uZ60ba21fOksLK5kehPug5896a+gqr+mOBvn5TzxvGGMj56\nFdt2/WTAD/Gaxyhtx5pVULYKa1ci+Clc+UaE4DNGKmFVcDnEAfY3RJzBCE+X\ntj+1jLxj1VqUftdn9YpAzzKBYW8DZ0P053jgek1Xm7iRox5gIljbtn1SHIpU\nCrMTd0M/Hcv2H1GPJhOJk3LzwbuU20K75l+kuQIC4oixhUHg3geLua0Hc8CW\nRAP95KmJ5l1h3iIXPeZmJV+F+/33qweL7tAQu5qjaK9amvuXxUE1kqceTFp/\nAkMCzWIEniSn0pw2w7zxHmb+YUFRm4x2Oqm9WRAx57HENlHi6zXWMNx6dakc\nAHawcniv9VV5mFeTFXC/d9f0D6RvNtP5AeWb9JLHtOSCuCMfGOxSUDDhlWn3\nKTFJ/KyFk+DNO+4wcMrosz+AFW+hhYJMdo51vy3s2ITN+8/eZSaV3tb/a45u\nowYQcP+yABlUKBSl6pj1ec1sM0A41E+arqt2yJ4Aal20bncBwJeaXtWQ/oo0\nsVdxJLajTMWA28Bb0CX1Jc4goKXDeOicV2X/qBsM1ZW72/gBeXF5qxTikTvX\nMvUtvWbZ6BMeSuUbmCy4hjphzOMz/qH4ikB2ElqaPtrcfYMkfR74lWT5CqZ9\nXQ+w\r\n=UHgd\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"f80bdf8bb2e29d6f3394567f9607e6607f02c80c","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.12.2"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.12.x || 1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.12.2_1601266638757_0.5423868471836892","host":"s3://npm-registry-packages"}},"0.12.3-pre.1815":{"name":"piral-pwa","version":"0.12.3-pre.1815","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.12.3-pre.1815","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"dc18afe2a41b776f0b2b3f9655893dbcbda174c1","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.12.3-pre.1815.tgz","fileCount":25,"integrity":"sha512-oYraQJVeRV7xZXB6EHVQJqxvD6F+JBUOE92ORkz8p4p1JCQuFll8P1anWySOc5uz/aQ62d5D/CTTRCCR+bAAVw==","signatures":[{"sig":"MEUCIGbSunrdB6zXfjGX8sTpAY3noIAZxWnhaaIZGv9DmSEiAiEAkQOx80BVvCZHdTTDTVnsieFtw00s+CkGd87xPbe/Hck=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49287,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfexOWCRA9TVsSAnZWagAAitkP/2I5d8vSlYjfvcz5H6yp\nAJvOkAeDuLSX11BR0l08wuqS9JP6X9/H2Tivoe9EAynqPj4b7PSOCJzutIeI\nmMm59j6JnjVPt4ggxrYOGtCAAMUdOZEsgzQnLqBEJrXTTIldDbLDkDqSCZF8\nmy17w1NTcTyoCku/ucdH1dURRNYMieT2cxBUWkgg7ZdZPKFcqVFLPzVjeZZe\nlMrUGPtglsbVesFDhY41eBcGc1a84Im/nrRDQxr01/JVUth5y76s0Gw2SDnD\nu/uw0YmngAD8xWIN1wJHG30d348cpIK7xom5T3otKj5yTwniosZjvkQ+xCGh\nGRyvtThsQPjSs5dPUatRTBXGlKdVCdB3obleZzyUCYr5fXogJe94y4yevdOn\neb6Wd4KAGy8GcmgeIS2GcbcW5+tiAXP2iYPluBJt/1VbKSnKmHfk5CGId8Q3\naPf4D/QOSIhZcGGPQZ8RiUzZjY94gvcDFonz+NMghMjCzDVe1jQeknJeAUO9\nikDHjZzuNsWiP3nSw0hRvuAI29mQ/6c0dJXZWFY5PIKceJuJb93s928BJacu\nnNYUlcn+SPvSp9wET75jJQM0eE8ioccoDu/mSxhQmu6F6j2qVtOUeBRIVIjq\ndcVdiJ/nlFdvWGQ10DejVbebUS5sfKDRfto9AjtBFX42LPJdTTivcVEJxvEp\nnueC\r\n=yYms\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"032de6a264fa27180ef96fb3a6230316ff2d3732","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.12.3-pre.1815"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.12.x || 1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.12.3-pre.1815_1601901462613_0.9453449453821476","host":"s3://npm-registry-packages"}},"0.12.3-pre.1816":{"name":"piral-pwa","version":"0.12.3-pre.1816","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.12.3-pre.1816","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"baef00d6d97222ce67b3cd1f01c156ac1ebbdece","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.12.3-pre.1816.tgz","fileCount":25,"integrity":"sha512-or3Y+mBd89qr8Emcw4krcr9Me8Fmt4Me/XygnUo5M3g6lqwnPV9uKivL/Y01Ikxxy080piAFPZnnD3WQTRCJRg==","signatures":[{"sig":"MEUCICkjBua5Cio1/FsD/NzPdHPBqVa5eCSk/G5p09ufsBEBAiEAjU/R2JPXW3HeD14z1AckPJIDTF6CNxkdGPLsAHuoHfk=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49287,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfe8DBCRA9TVsSAnZWagAAwNQQAKIGIEyFgKIkIIfCgi6w\nhaKRMeG7hiwZKahkTK9g54/yC/E1tGuQtoEylWeVMidLeV+sNsJhnoZZuK8l\nE/rSNAXCHtQAwz6HrB2piZEvC/OOycbMs9xKyH6gbVDnsF/20ee5rE1MMp4l\nFd0gtvfMu1dqvLMBGZI3aAovU7wc6g3+KZDUzK9Pdr4APl/FA8FOhWtULvX3\nse6yeHnI9ttP30XpE5uwylwyfIPLXrK0qx3ENy3dRoOob73Y14x3c1kbxHAP\nfKrHZn4eR2hsrI8WQQmH3iJGOr5P8oGnce0Fx86KYgImSy3KwCQ1OeFWTj01\nrSs2Cjy/pYr8ocGwAsmhuj3HZYNOD4IwmEXqWkRk1BCg+KHjdwsImZ77DOB1\nCmVoMyFiCSLnhfTQzTBj32u8JnzWMFV0sFc04SgZCv/DChJ3BES9N+KU6uw6\newkuYFjZBh1wK0pAaYVsVLpZbnWTXEhKAg5j77V23VsysM6xGR9iPuIJ4Ka4\nVSAAQyUkKl6UWGbu4rgmh+XB6NI6HUWabXiYnXhgCRrazVzxEDB9JD8R9fiX\nGBFfkID2l1yEpoaZTnDlmJN507zCYJ1LCBK8t8guY4gp+Sc0ZkRG1zAUTxKf\n+Q8gEPJQ5pogymfKcZgWBmGSfHuJZK5znyEOPKXJFBXZtH8zVgI4mMT2rb6r\n3ErS\r\n=eMTm\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"14e3ee3b98760dee8a5e305cfb52c981d1a28319","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.12.3-pre.1816"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.12.x || 1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.12.3-pre.1816_1601945792486_0.13682523285553083","host":"s3://npm-registry-packages"}},"0.12.3-pre.1817":{"name":"piral-pwa","version":"0.12.3-pre.1817","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.12.3-pre.1817","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"e52d6cc36145c17c1e0ec052290a2e2790b15969","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.12.3-pre.1817.tgz","fileCount":25,"integrity":"sha512-N630IBiwpdD/spIeGdZWUyFW7TGquHhMP7PMXnd3hnABWlfqOwCUcRQvLfolJmorUv2l1HlhE7e7S5zw2w7pVw==","signatures":[{"sig":"MEUCIGt5YSdD+w6iLUm5/yCkBo3PWOrNEcXiHUVjPCZP5Vy0AiEAxvUS08CYtsUz8AWxrQGcC7yP6uqBQkqC7WUra6Qik/w=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49287,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJffPcTCRA9TVsSAnZWagAAz7MP/2JUdh4qMPIQEnSHQkza\nTmgGktau5teEk/z1CJw6fSKu9FSpIRaDqLgkAfJtz61AYgDXRGtiXz701/m8\np06vLeZNJ6xhh0w57FFPSCtR40hvce6M/fq3LVUz9ijItpXbb9cugqYdXr3Y\nm+laQZf1ZfblCi3IfTMoI0wt63csWpEhnJA+OfibbFkXBGzu2y36KZLk0lQq\nx/RMja4RiOTSgQg7R583HesvNv3qTd30G93Rm+HvBd+TbZa2yUcrYpqkzUnf\n63zU4O4TfBi1abLlPx3IfYBdKpBkI8gqQW5enlqr+M/flWhGW+q9VnnXQomk\nrdwdTnGVEDOZbXEKQvJuP2/tXH0tamkkq9dZG3p2f4+4+nnbl74iYcL0zBYu\nW0w19Ixnq7h+17wzReyWCi/KejU2sZXQBZFp5kamaQ68x9veevUYVbRo7Dzs\nW8qnMx71Ve/29G2kDa/9zzSOldWNJLwYmYgDXwe99PHdj62Ayb1oxCP8I4qa\n7AJ7ufWJCxwjmETt7lsv9NMGjpCWq1QowhfcYsv45gB9jonwd+7tNg/5deRX\nqBBILjsSi1MXJBctdD4XeEguBhP9SRncs637hhMA/duHS20YQkMSfNLTv/x5\nQ6Qe6D2aPyFXHM4P8SvEYl0a5/EXBOUUxyYgDnfzIvGsTClxclklKXiaOEWx\nSivU\r\n=Mn/A\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"ac0489a1f8590468d3b3669d9246d7fac1eca763","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.12.3-pre.1817"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.12.x || 1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.12.3-pre.1817_1602025234774_0.9630434631644003","host":"s3://npm-registry-packages"}},"0.12.3-pre.1818":{"name":"piral-pwa","version":"0.12.3-pre.1818","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.12.3-pre.1818","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"c774ff61de55437dfc62147454f970f3815fbc03","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.12.3-pre.1818.tgz","fileCount":25,"integrity":"sha512-0vN9cgMrx4OrmJHyaWrvh5ZL42i5NLsALxlWq3nx2V4Whh/BqtyvRnwbvkspbmaH2bcd3iWsIXPPGvBuFpNk0g==","signatures":[{"sig":"MEUCIHqUnH3NgMF8TmEdqpjnOnNhPNJqDNqleKA020ckczksAiEAmYZmlh9+1qO9jwuto6t9SutCgz7PyOlD9euZEf7Tyx8=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49287,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJffu2OCRA9TVsSAnZWagAAu/8P/2KuLbcwNqAns4p8pFz7\nBZ5Bj9lmXN3FSlsg+7/j3nMrW3j8zLYMgO7tyHTMuhxxujQ4VsIprEOxIeKw\nCBjF1eu23FfiDlHGSkpwWOFfKDNwJwVZdcDjZyck2qB7LqSwbq+9c6Z67IcW\nDg3Gdg3RaKH7a5/SlAl8QkaV26oVSorGy3gFc4lsDCwrDLuXmh0BbONr/xie\n2j4d2rvyPnzXHNaBrDJOdpNpEezP4GpnIQu1Bj4jX90tUFFkKih7MPrR+iO4\ngiuDA2izRC7vBIFs1GoAdtXGsdUjvMTv5+sfyR03xmomOePFeyq1Hivsxcdm\nSqJ+iXOXH/CC/w9C7Pk9F6qwj0/xZ1R9M4LZBmwyJwmuOHTSh/JlONYSr+er\nPcRDnJj/C23vmQORdSGopxDFQzn1MvBunxg22+kN0lpn+Ty+qG5PtIqDtMo7\nu3cI3YeMQXv+etE99UDnz/ZJIO5ipmsx97RnbXx89Dztu+0/x/Q+6Kfw7Knn\nbFCcTYRnDvSItA6aL6W5E/5UDaYvJ72mZiPRN6KrwowY4w+g5f+e2g5iuhov\nrsim5X99Hxu1e4h7n2ppks1QB2xZE3ZvU6zaAVWABQxaoyuTP6Qnw9Jm6ESs\nlbaOffgP5EHNrYABNWRfO1aEDvPBawv0MLdZA2MgT7Lu7dQtcP5Iw6b6jF0x\nmGRy\r\n=OiF8\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"fe5379d49d1992767f3edacf4098e3613386a71e","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.12.3-pre.1818"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.12.x || 1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.12.3-pre.1818_1602153870210_0.3238457382092703","host":"s3://npm-registry-packages"}},"0.12.3-pre.1820":{"name":"piral-pwa","version":"0.12.3-pre.1820","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.12.3-pre.1820","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"5816a279658149ebf8d3fd07b94a43cb075cd081","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.12.3-pre.1820.tgz","fileCount":25,"integrity":"sha512-MYcmP4E1lJG/3Cdl6aqE7jOIuBkDHZuMs+d5m039guhhHkqR9k8WOgggr0mamVLxtt+at09sKrgP4+lT4DiG1w==","signatures":[{"sig":"MEUCICWtq/6yJIyPbeKharDHD8rDojOi4+ci4AYH33dxagwRAiEAm2/e01M4EUyi2laDm0KG04MFL7NR5/r0ZT3A3pygky0=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49287,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfgHumCRA9TVsSAnZWagAAwEcP/RH9UDYHswVg4TBRLkOo\nxpnky0sGK1UR6IfIQHl5O4nfpiW29mwaK6e5WEnWUgyaO1bnoG0DzXs12ETC\npHMVq0NCim7FkHwmmbHMqIYUMd3lAV+CYUEZcJ5nKuDKRuLwHkCd7tfhONzG\nSXebOgxUEnYBNnVOKcvARlatYtSB7Sw5P8I7/biwKnG+slf8mdGg98xcJx4q\nB8ieiS91WgdBccdUfa6wJFYyD9hNWME5mEBRDkLweFjVoZN8cpQ7rBh1OvAH\n5A2Dfjx7Yj+QiDy4hMYn5i+El8rOsv7WunE8AEdEbkwHNkMY+kQDNB1FPSAY\nKXf3zh8pySKX1voqo9fiFvxQ7FJSfGvFVRRKa/Sa45hEix3mmSbH9mVe24/J\n0k0GXNwquOlo2s0qTg6qqafcd/XEkNbjSpkf/9FlrCjr3a/fee1+m6zbvE+t\n+Uto+K679OvAd2riiMxL33XTP1dElJClMSaeFu4owMjEai+BScdBdVBEawE+\nA4EGKou2ygf0QJbDhtGG6uF0mtep3bzQ3z/gKuhs/ZdMY/07WqwJpv3H4hB6\n7mGjlEMuPY05XjzGvD8YLXuHK4zFpLachGVBuk777sN5I/cwkw2lTdQJnxfa\ne1biigvImx2LmKexGVoX+//CYwOyCj95NdqXjxytjRVlbaKhcP0f69AsMuck\nunog\r\n=zam0\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"b1da7ccbf75b527abc897a8c5d6d33c63f156774","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.12.3-pre.1820"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.12.x || 1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.12.3-pre.1820_1602255781720_0.20491183277041847","host":"s3://npm-registry-packages"}},"0.12.3-pre.1826":{"name":"piral-pwa","version":"0.12.3-pre.1826","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.12.3-pre.1826","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"301f019c681187b287bedf64de44b04b29b98885","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.12.3-pre.1826.tgz","fileCount":25,"integrity":"sha512-Y6/pw+8Od+kOnBtOpK+2cqfIU8xtqXSPxM3/GGOBBLA1Tc9WFgDgucuNv1wEOkYM+NjsZNLLpknqrhL2GfNR4Q==","signatures":[{"sig":"MEUCIQCtYRU/s52+13q5NbZHOpSqrQz6by/MChrKBZJwypSXawIgZzxAu419mU+IcviWc8NwWn70TqZItkvP1VcG4jIVfGQ=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49287,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfgPHlCRA9TVsSAnZWagAAeaEP/ig/rD/8WYd3v29vzO6N\nwMR3dIk45vlEavhswCFevjEw4ro0yMqMpGk3tPq7vl2w5+22oGxS/Twfi7Rf\n+1wVoRDjTz/18PvFjNasGCvudS6igQ1MGJNdKuRXmaP9lqCWakPcw3ZUI1xp\n2la6lxQCwvvsqda0nAakhzAISDwgYnYbVvMeXcm5BFGoFvZkoYZsekpJmtZ7\n1XJbdcnkfCBXdCznZ7fr5jEhaGoMgGPdAbkw0uPTolTcMjfcPJ3u0tveUIsF\no3nlwtwpZ6RhHzaP59fF1QiDIJsxN0rRl3M5uq3LzzB6hbs0aQSNZRgtDTKL\nYZ2vRB7LV/MMKijAvLQlukZxV2tgWk0phtE2TZnLFr9oEIwTjPhM+l+FOaD3\nUTfpsqNukPUuWzCprPW/Se1h9UFQgjfEDoAFF8MvM/9xWo1yJ7C8pUxIsNDC\nNpo8gl5lF+2758IQMPy6hHXnA+VbiEu36y6i8lUX/ivSVT6mp6tq6NazqtiE\nXqIIHXTWaR8QBB5BqXGvho+rq7Emm3uRipaOhjyRH2rD5on7Mbx8Q1T8WXPs\nbToEdazQD/X0Cw97/xiY2xGbCClki3cRzXgkH1dB2IXF7XPuLQV+kWDlyqwD\nrB+FEqFpIQOnYo0vstUrq2M+Trx9ujb64WlYh1h0wDGl1b0PoYlIjC01zmKo\n9RMR\r\n=iyRq\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"f986877e0ddda18086ecc83902118def1f43140d","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.12.3-pre.1826"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.12.x || 1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.12.3-pre.1826_1602286052900_0.4636239075595201","host":"s3://npm-registry-packages"}},"0.12.3":{"name":"piral-pwa","version":"0.12.3","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.12.3","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"22197781423c261b88fd7c61f549d9cf12c24771","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.12.3.tgz","fileCount":25,"integrity":"sha512-7Yx4JKA06Psc4QJlWGa5m4M5o7wP6Tbr2N2JXFUzQWMuLUheplfs1qBjP6Iya3vLi4TBKpSVsD3gPK8YO9/kfA==","signatures":[{"sig":"MEYCIQD5rxUJX3S6lw01ED5LBAanV/IxdJqAIHtoV/VuTWDyygIhAPD2hpLmIGJCr18UAzo7laxlbvv4b0zJF4G7t+FETYEE","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49269,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfgPpOCRA9TVsSAnZWagAA4aMP/jKwNbPeRttN1vk+WIq5\n+xqkPHZGSVp8umw6Jpw0B+1QMcykRNmc7oEg8fjczpnUEQWTCmP6xOGbhuTP\nHeugvDxIrV9hHDhPCt/gZIcAYxRmqutBPLJJ416yVrLJ1uJt+whY1P2q7W9y\nELoFrFuOljPEjM9qI795QbXCON1iWAvGDcNcN4dHl0T72P9dr75J7J2im+Wy\nwMWy9SSqP2DU74iuIIkyVvgpQ4LsCvRlEKCpPrMRLZsTvzlZmGoxJw7cHdqF\nBt2J9BR4mOClYUeATM5KKISAZaofAJSXbteV2GTZZTGH7NDT+KRhN+1d0TJk\ny9SU+tI7hB1YjWeHOnFymv8eFRhVY8eZSJAmwKIV2Cj4QQB3Ce6PiJBVlZWx\nSKQZNDbAECh1zrwC7aL/TwxU2QIEDkRNSJH9y9gRDda736I8h37dBfwLXRXa\nhI76VowKMnF097JAMnPLStVPfunCF+Ea41KnyvR0J+7yrqMoQYXBHNNNQd5Z\nFuFbVdpLIziYbzu3r4L3mBRMZXsiOCqHfKh1COM2vO3oo+ktSh2836xSiSBB\nbLrClXzwY+edQe0aBtHnfG+aHch4CcugiCt2TB4uUkcFcGGESzBL3HXE7Q1P\nIBShMJzcI4n0LaCsVZDhKEugr7iSOkDivARlg0Rw3v/iNGUZCYasxqgNB8N+\nRu71\r\n=lMBQ\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"64f9178b0eef6c6ad78f3aa6e410719dc88f3ce3","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.12.3"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.12.x || 1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.12.3_1602288205685_0.3092700207897956","host":"s3://npm-registry-packages"}},"0.12.4-pre.1830":{"name":"piral-pwa","version":"0.12.4-pre.1830","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.12.4-pre.1830","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"37eaf2d804ddfe3c8cbcbd6ffcd4b271cf007370","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.12.4-pre.1830.tgz","fileCount":25,"integrity":"sha512-2gGLNijzu0ZEkwfAZCAGla477NBHf954zohHPDLHjCexOaxLD9spuxzTjJP+6E034mqcLuq3Lgbu6+MIGtpQhw==","signatures":[{"sig":"MEUCIQDMZCHPhDYC4JeMZomDWDlcC5HpvziwKeA6StfR4iEU7gIgMcG8ACS+B7F8+P5usWNxFPERPMDUYHuHd5F4WwGwLq8=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49287,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfhWZZCRA9TVsSAnZWagAA/fYQAJncpXENlFsieipPETIq\nxmgSpWif6vEvCP4HYiFa9/eO6iZ9wP4MFLOsbjPvM2IjCFFgNLZ/ssRmjM5L\n9GfQ9RWaoFAK8mZwOddqBdWXrfH4Bqdbb9a+6BJ3eQcypGOQvSff5h70l3lL\nfpUdYppYvtWvZyvVBz0pcM80pOyz6yCf/8ty74uptOpNkDDO1U7/xVLGoV6D\nroe7D8xBZriEDu7C5tkpdgI7jkZMepdGH87Mo7WWbMr9p8QwEnWsRr3a/UQh\nl8tqiNvN4NruuFwDbi55cy+45j+ftO3Cg/pRQafImbbZ54NlHkbaE4U/uEK+\nyjQFBj3RR8KKFbQ7UhaoVL1S5JIciml6OV5IaAqNClYg//BWZFZpi8hEwNFo\nmR99YmyJI4kUxR4fwvSA3tAtFyD5D/hEIsZmFvaPerF36dK+lr1bfh2P8+Kg\nDOjeBFilmdWanFUMVjHKd+I/nxK6Ccq+VFxHq0tsNftsl+L9HNaf6QqUoPDI\nqa5sjX9T8U8s6oJnCLNp7lowp841yjKrfiY5pLwcM+LLEua+idQ3uNA9JQ6a\nqzKrAbmH3CsqwQOLOO1nzMr55qOVAhRhaltSRYF8lonid6erXdGb00w57hAT\nSpgea9c/oVLa662Ts5pFdUpg2AdodEaMf3q1p7kZ/tdDpOrwDx5YAB3C77uz\nYWzv\r\n=KGNH\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"c0b0d25095a1f4d811b837a1adaee65a4fdba445","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.12.4-pre.1830"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.12.x || 1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.12.4-pre.1830_1602578008987_0.7379560085809067","host":"s3://npm-registry-packages"}},"0.12.4-pre.1836":{"name":"piral-pwa","version":"0.12.4-pre.1836","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.12.4-pre.1836","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"97587068bb0e65a3d5c1c323feb76c7af542dfc5","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.12.4-pre.1836.tgz","fileCount":25,"integrity":"sha512-GDQ182F9Qv51lIXtlfA3wIvxszklp3vbz0xHJVpDMYDAWmhoc2V1yOQxn5A3BARtA6CyMFJTWOrl8St4RwEaOA==","signatures":[{"sig":"MEUCIQD/GPAd22lMOZpOjOIKRmgStv5MnfLQ7gmMTAhLrvvIIgIgaN/PmBfJM7woEzoHOg8IBa7THtYkMsgS0OidKgVab2w=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49287,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfjqihCRA9TVsSAnZWagAAeTIQAI0nZ8DruCoLgoD3QThp\n6tEphjGyXWCW0y/eKmkmgSfc6Ccw1HzhqrsYbMvr7c99zx+qbi+8SydyKLni\nStab72PPPHX7DsSKyMHhH1pSZuyG47NTiuSS5cwxK6mFwNIAHt62/WgoMF2K\neJP0U8CNNFxUmV7iHvwYKHSDQpB//5NWhXU1afSX5e8koZIRJT1vB17qG1yR\nWz/eoPm5sm0IxVy6sEboPsPuPiq9/1LvF/oEP8FVb+QTV845y6NqIM+jw04I\n6V5Cyh0mOJ5ugOSEhaJ97/SDc0QXzKntkr7D3z7uDj6mRgW7yNYBw/ZahHZT\nph0mvKJE/Ogg0GHZbk1JVs05EirCSLYum0ZFowCcd4yci1NuxQQZDBKsN8m1\nGAEos/QK1urPep5ITeSHJ+jBr46h8DSmxYpZ3WHcBgxfsk5GlosUSJ41KgXS\nkyAl0taitVpuEAVZbs4GH4LNGn61rySY0ntcHdjjOroYEWi+b38jYCykljyb\nh7k1b8L3MHXyalXpbfeW4BxhGIN62m9BhjbGctNcMvl9tmKuI00Vx41gCHSL\nOrwGDe4NSlSZKfFuUUMEeMREjcTSjZTvp2b3y+ZYDQNdCFwjRuG6f4KQVBPw\ncpys0w9cs5AcsGWCTi0YYQ0cfDAx6zVvoo0Go11/znrWeYO97JOa9PNooQX3\nEcoG\r\n=gfBf\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"e7e6de252d0a3e1356b0b3e644a3101c0e067228","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.12.4-pre.1836"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.12.x || 1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.12.4-pre.1836_1603184800707_0.7523065203413075","host":"s3://npm-registry-packages"}},"0.12.4-pre.1846":{"name":"piral-pwa","version":"0.12.4-pre.1846","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.12.4-pre.1846","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"38f64bc9c42c6a71afd7850df437d3e53ca03cbd","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.12.4-pre.1846.tgz","fileCount":25,"integrity":"sha512-YarTk1mmtASIrGOvR32GYeYQJM7gg+AL7jowsGdGOifnN0bhP1EGI7XP7Ql3XBjvJmWjX7/QnXXxLV+hPf4xdQ==","signatures":[{"sig":"MEUCIHvVICR15VgzYS7pWHjIlVrhijQ9Sd1kk25cbsknShkKAiEA1ZzgKt1l3X/wvR7QevP4ioJ+Cd06b0Pm4cNKFCK0Hr0=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49287,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfkJ1CCRA9TVsSAnZWagAAA2oP/1XrYTyjEY12OnXh+EOy\nxJkriLlPiYIJkG1Y20vqbQusZX0mhUNxSn5U3RBAqX7r2xAUVdv5EkkxDS0m\n1i4FH/GV+9UTVt1x9JNzv4/bIFKB/3OCMKJ+GMp76eq8LWRqeeEuaBIsCKMY\nO0JZvINehZy1LE4YVL8XghM2d1ViyMeAgpmOuh8KkdbUcomN8qnxpxSt5XDp\neITzXPiVgkZaHAsOTL9z1nu246FWCmXpglPVzdTPbrjNE4cDpgdDb/i+WTbe\nm6m79DH7DK6VIjP9BitMXYdb6ictlL9ltBbgPXdezTuP4gD7j1rshXNh0lPq\ntHNq0M0KZ43xETFPrFJg2D5zEn2302baEpw+7UaquIiqmTD7UTCLW+nbmJiP\njuzeSpOhAzFLjPF/CC0Wy2Sc+58APYNz9YT0d53d8W6/ajjFEdg3rH0k0GSW\nxMX9a3S0F/FsKwiOekLVUBO5tN0cNkbqoKTEspg55Wu1duK1ArR2K1unUefS\nR1/EEVOnMcT/JmOZbCeiC4XUzd0eqSObwbYYV+sKRVgb9mQw/Dkh5BHSHABt\nbOF2w3AshlB8MfpFmRvudJEsHJTHzQ1hH06BpDeS/CWC7zumm4700BeeJJiJ\noT23loeFJd6T8HNWH4LorW5o19OChxpfd97k9cp3f8zJZMqPc8gFk9DiIYAw\npavx\r\n=a7pB\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"3a062a650d5956c981a353ebed506e3fdfa22025","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.12.4-pre.1846"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.12.x || 1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.12.4-pre.1846_1603312961176_0.8919818937446542","host":"s3://npm-registry-packages"}},"0.12.4-pre.1854":{"name":"piral-pwa","version":"0.12.4-pre.1854","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.12.4-pre.1854","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"738c262cf398044edafae237f1a446c870f18b84","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.12.4-pre.1854.tgz","fileCount":25,"integrity":"sha512-rg9HxrPGDMRQfK+scCZpGz+YM+F3tkxy30oRCLWqzQjA7qAILo5z1tpn72zxC1Eih7h1WGmrrvEt3qk286idMA==","signatures":[{"sig":"MEQCIF3tlNeJrijhKkz5oNx80uMhN3JPbsiw1VbdLs3scFa5AiBe6pIyE3qrz4hF5Q6m4kh5ZZpT6GhorrXuQgecA92eig==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49287,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfkuGACRA9TVsSAnZWagAAWIkP+gPCR7QvYO1XT7K1g7w+\noN6+3rR/Z7F036dcSsjQKVG2D8QUOoZ4u0cMBylMnop0w80N6DIymJ+ZbK7Q\nkgdi3QKAEIQBdyPE9O4HYDVycz2nEh8SgZFAa8dFu7M/nj6aZ5ZvtmBU2E+H\n61BExuWwljqH/FYDwH3gU7bq4ph8ypkUXNNxjGrVKmLtCUaPt85karHaIkVT\nHyO84qhsSSSZMMtXIVkf7Ed7MnXH77bwd5qOpMfYwqWWWoaiD9MZNRYQAwQS\nwLxUFfaEGFPaLJxTRi33YBI4VAByvFjrDJgDV3zVpB0anMeDEVkPDiGZXwF2\nTBnILfD4Irq7Hr73wQMum0avzPLAcQ2SOlYdjj3iN0LrOagh8UZsQ+dx3jSC\n+dfuyWtIJiv3nSmpP0iNQVEoCr8lPmNwsexgUB48tzmOP0dQWNUUd4tFqQAS\nT2CswNiVA/wg8mYKwcDs67UuRnEHDmzEwqQIUtKqPn0qvoYc6lXsxhKQuSSe\n4RcMFUAXS8ooU5IxHHN5WpP+1i4rbZvzCMtxmycBt13QhPedXt0eHWp3NAH/\nzztYosDOP+eBroYdSfgJbhhVhexilAtTL0/NvOkw5F8fqbWE1kcKl1iyLk4J\ni6oAidVTEjeC1Skonn6eX6ARiVvrIyrVECQbMvicOwy2Ru2M0d8OXeknEWpG\nBgy6\r\n=zeuY\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"771c641f18e6a3719f3121523261236f7e55dfe5","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.12.4-pre.1854"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.12.x || 1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.12.4-pre.1854_1603461503633_0.8100765830528784","host":"s3://npm-registry-packages"}},"0.12.4-pre.1861":{"name":"piral-pwa","version":"0.12.4-pre.1861","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.12.4-pre.1861","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"2c152f3291377a2331ad0cbc4749ea4b295bab27","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.12.4-pre.1861.tgz","fileCount":25,"integrity":"sha512-fcIatvNVchY1HWm2kSHrP7V5qZKbbFTS9DxufEbWO/WkgHihF06e9gLz53Az+rDg29GIvoi129P+R+T2t2b85g==","signatures":[{"sig":"MEQCIE4laSsAX8Fdq2jpKL1X4cAHYLFIHb+Igub1uMLbVLQnAiAlXw7qtnTJjb00VN1MFkWYj4/wuPZWPvMNgcy3Gz8dbw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49287,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfmKR7CRA9TVsSAnZWagAAWBYP/R82/WyOoFkj6LkOxbJj\nCcoEpdXyywq+YA2NIZ30nH8CYESOQlBgW/NNDhDpQ4xsUKfpMDyDUH6JgbGD\nU+SQYJYL0UF2901X2jE5NbLv+DkmDngZw3X+c5H070Lol8peDj4H7ilTgukY\n+YDri+M2uS/mOiqqCWaVRsaqZ/MY9mPjw7EKYKznHIg1fMvBqDZp/5DUO9D2\nzEXrWY7ZFuJrAZ5dqE4NzrMqmi2d2uGOWYqaT0M14pIgE1dSjtABPp3PFyhb\nTEElHw/kqGQT/G58K+dG5cz8q34HQyxfW9D+HYX4YKypTj//bPlgTWZWp4S3\nAgOH8q57x00UnSBJWa2NaTI3WC8glb8M4aYkMAJjagpQyDeb+TG8INWYtKtF\ncBaRxhhae4IswheCy35MOsHOmhRVDNrDeqP3mZDbX4PTHx6jst709inEOLro\n8BIjYFZqX33LGhbNW7wbHdjKD/Vx6rlG7e80Gl/NUXwPErjawud1ogLaUeHb\nicIvc43XRFuldwnui6Gu4dH9OzWWdCe3Z/sS21AVZCYhomOCTSI+wi9JcFs5\nQyKgW1BDgVulx75VtvykyAvfCpTLdzrb5Ckc0U0eVO62nnEcTGBokHfa61jA\npZlFew16t/pnFWii/USWR2pVOYVzNq18aNA2WZqAdcH7+NXNPJYIsoTT72ND\nb14n\r\n=C3ak\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"6dccbc0749fa624b9528c4bb74701f76bded52e5","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.12.4-pre.1861"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.12.x || 1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.12.4-pre.1861_1603839099137_0.7809080794487395","host":"s3://npm-registry-packages"}},"0.12.4-pre.1862":{"name":"piral-pwa","version":"0.12.4-pre.1862","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.12.4-pre.1862","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"8d48e2e013e288a42d58a233042ff25e43b3773d","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.12.4-pre.1862.tgz","fileCount":25,"integrity":"sha512-Bc7yXNgNUrk2r+Aj9qBVt8mh246Z2ATuViGuGL3KZ78f35kathr2yLI23Eb6rwV97Ksvjmb9yKsGTP+uwJthQQ==","signatures":[{"sig":"MEQCIG8bdIJJVnwxbdBJUvqgOI8yFLHd4P/K++cKbK6oZxEAAiBaUBJ8Oya2KXajcWc6J1YcNKXmuDTFxXPOVJoMUGFc/w==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49287,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfmW8BCRA9TVsSAnZWagAAoJgP/0Zb5retC9EW1Ctg9y+J\nNPLzmzaPNuu5uTQlSXaWZqPWuu5a20GVMjslrpUc/EanRXsbnFKwxPrFBUcK\nahgnRh0yn43bOi9bGZFGAxIEGVeq85SkORdP6wQnbJON0NefbRUNMMpQqerh\nzajNlXWigNVteV3tn1jOjvWRTnbRTtbq+gHetoEJGKZC9qP65kqQBJAAcWhH\n+bWvGs68nSMnffmYzhwVe0PjPGUAdVPDRRn9v5ifcWc0zSm08iJJQGru+MUt\nXksMy3528Wp7x94IQeLTwE2bjU/kRzK36LkVzm2iopngNsXXqHkxmYtBqIiK\n3sLmN8KY5KnbKtt7W+vAP+W7JmIL+B6sp7ijnUYIC7F4Y9sNBhw/aYeMh30T\n9NaMuxWi8G+lPyknUvI/6+9q8KtqAMnlVwj8linn25eJLZuuhMyVKJCyNt1G\nqqm2G2J+Yq5GwVtIeDNIlHzLosbArr1067OHTWi6vs1KFSFflJKTSamH9k+8\nN06z7UFnIFzbGid9yAmOIrxVs0PHJ1pA6rJ/Miz/4Enbe9pv3IDMh5sf6C7E\nU8y1yfVnazlKC9/dXdvDtGjW2MtRu97ooKv8djBzdW/qL+Ovq38nbay98hZE\ntN6NmZ06fTBGPnoNnnPYkGGc2L1r44BrywknnNNqVLxY6sWRTz7FvE+En9GL\n+fg8\r\n=cHyS\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"f88e40b040a1cbe4c587f38c2ecee966619290be","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.12.4-pre.1862"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.12.x || 1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.12.4-pre.1862_1603890945015_0.9814442186403183","host":"s3://npm-registry-packages"}},"0.12.4-pre.1863":{"name":"piral-pwa","version":"0.12.4-pre.1863","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.12.4-pre.1863","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"be7c9b483acc53458e30d490a4c40f5914f92dc7","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.12.4-pre.1863.tgz","fileCount":25,"integrity":"sha512-1lxQxPv523aqWsFAaPIWNnIHoM9j7ZYFrKp0hqfeMys1sITOcr0ihHdCTCmUvprQbQmjhKBhZIzPEhU6nhnsRQ==","signatures":[{"sig":"MEYCIQDSDGtjFwTPJS1HuFulR3xt4ojFVHUYYMYBrtFiqEZNkQIhAN+zfSgbqziyXiDY4GGeSEx90tnFXZP7KOrX2rYTl3lP","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49287,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfmZlzCRA9TVsSAnZWagAATBMQAIG68IpAfDdX27pMg6g9\nD6QRIFWRtbF64kBDsg+wrR65rgeK8KpkODzq1OXR0zWLfxtZrxG/y0rkSNMx\nI6vsP2m1TzuHKSpypEQ+wjI5R/ex0Fy0M2FhR7eZevtATJF5huHjg8xP9LwM\nsUUZBJpJWz4GkA1Pu3vZsyAct2/VvP/9uHw/qQeRMXkScVXhO0DLnypMY+AB\n8X+x8TmvQ+UjlKUCexR6zqRevkaOby98kcZ4aRFo6B7oD/Ek3zM6vKPc5IEp\ncKGbBaTAyInHs6UcFn9/CABa6QRhK+xJStMEb3eBoLIinqISh3in+I1CWsN/\nML5fJsrw4xm+lXvpHMJcItyxS+pL6HnAo3GSb6hQhoK177uBPq2jS6Ucqf2f\n0TNc8Nb1TU6IzHpranG9G4EM0ajCCHWQL6mFDMbAsz77VD/nPW8MGheK+v9j\n3mrl11U2e+EF68Ad4uQ3VQB6/00MmTVZQf2GYcb32gP/6uX+mvsNxQn5kslQ\nWKjlXJYR/P7rl0kV2A3U2doHLgdv/17DIoR2Iautd5zXBwxxRyVhRZOVvYRC\nWAt6t28I9mgCKYKldTwzzuKXOF/pVlfmMe1/31GqSiYKe0DW1xm0lK9l9LUJ\n+x43x3cnVCWKhSO32CVX3aT7vjmS+VzuY/iSgguVCYJYx0BkvcXB2VdC17mN\nwVVQ\r\n=tnzw\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"5f65b95a9547e282467a4811b32b6d76c55736d6","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.12.4-pre.1863"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.12.x || 1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.12.4-pre.1863_1603901810684_0.35148613381392546","host":"s3://npm-registry-packages"}},"0.12.4-pre.1867":{"name":"piral-pwa","version":"0.12.4-pre.1867","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.12.4-pre.1867","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"48dc0cc0130e4a0a882521f7ffb3691495a2563e","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.12.4-pre.1867.tgz","fileCount":25,"integrity":"sha512-AAxXEuXIVrndfV1GObgvyI0i6iGyntMgLRv61derfmToTSMYRVrArlTuxWv9Y5h/Tk1PN8kI//Ni5NKg/q3y6A==","signatures":[{"sig":"MEYCIQC1TFjGJsjlHHx0xEeLtGtl/m9bzD9ujKkwRK3eAgrXuwIhALhrA2c0wSj3e05SpNhp3Gg2LptskKtyQJQQXk6tdLBR","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49287,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfm7xJCRA9TVsSAnZWagAA70UP/3+S2+1NRT9dIq6jP8ne\nGW5PvoHOyI9/uvMBy+uiYK8uTR5lcu5W0KVLoU9nawPmBcF89eVSYXUvE1MB\n4p2/MvaVu3oY2E5W0/L5f6h7eti9YKk/zQMvcdt6cL9cIK+vSdHGYxJbZQnh\nFl7bPnKgBJeInYah+pAGwQKROquiX7ptuAVgIw44ww2BV7UdwL/CNb/XJ+mW\n5gMTwaFrheuc1Qz0LzRSfgwFshXOHsoOffyjzSbfEXADZ64e6mGRO8E8WJTd\nw3WiaG2t+JEjDgVrELCLoD93r8pB6o6gKCzISCFCPCd/FO6ad9JmYxbhckx1\nc3QNKsXiZQNqwx/djvSLue3A4Aq/QyxepxZmLL0D8n2l9/mwRNBGK+Hs6XnR\nZWNcNp6ZiDOT1Yt1hdNAwKex590W2YwzQ+nBap6uqQfqHyH1Oko6oRoK8lb6\nfF1pQctsQON7Da3z5wOS/jrNkWytV0EcMXgyniTLZvD4iLHBecNGDHIcBYwR\nGP3QuYnj7gzVI5a2VZZ1cZrdC0PaVm4rU1KFYBGs1R8uv8Z2SGym7xljREEu\nLOjqjde1A1M9JvVaMoNSIzMaOAp56WY2rGVcls3kA++j1vbefAGMEdNNceNF\nfMj9qvbmGJ1eXnI34GfaflWbC4dtljeJWpyhr7zdPSRQWNh0idnboxPSq9QI\nLlFx\r\n=eU1r\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"c16b40a7f662e0937280fff145bea0a4f59e990c","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.12.4-pre.1867"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.12.x || 1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.12.4-pre.1867_1604041801485_0.17184406329431723","host":"s3://npm-registry-packages"}},"0.12.4-pre.1874":{"name":"piral-pwa","version":"0.12.4-pre.1874","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.12.4-pre.1874","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"c265200f97b89b611df92612f6958c871175508f","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.12.4-pre.1874.tgz","fileCount":25,"integrity":"sha512-mojKB3+TNnEDi6do02bxEsAm/KlfXa6L910TEKPjimCkjhUvKvqG8kwovBGBVhjOCTXzNibFNim5LuJBCqdpOg==","signatures":[{"sig":"MEQCIAtPUt749N4qrQi2M0RevPauDfj0f+Ac+tbmpmJezLukAiA1b5CfQqIpYAXMbhyOg+lGjDku+eqE8/VcPet4DEwUlQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49287,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfqy+DCRA9TVsSAnZWagAAtxAP/2aP27zVtN0ESp/taDNa\nOiY3X49ltZrUMecnih5cxKQbVCUnU9FJCilgpyIAgInfC0kHr5na3YF5C9mU\nl6Nl0YXWBeCAre/I7ndA0i6U2HO8/8D+teqVwvq3GpHjfq6nlWx6fbfUvON0\nR4j85I54Tr4cIVnR1dnrJPVaGyMmrHIbHhg8fZrqXCr1y11HVwuesuT5S42z\nJwGTg3RsfLYyAI7qTGv2tBNoDDfRYeP+W1FWr6qVNvRTEm6HbE2DuvPThHVJ\n2yiWIQxi0XzAFIUpVMceT+9tNQcFhhp2FC+zX3E21ikyGy/qZkv/EqdYLme3\nI3CEqoakwLopBFekIlIl8dot/hmPzEn4mEfbeiv884ZbRNPYajHZjPWzDBZq\n9UCw1gmw4lmJaCRvY+RSEPTj5c9MAmhcpz3zVLMbgwsdN6BBu+3gDHPGmSv+\nJaOacoONxIyd43s4+dkBAvjMWBWR+geDLj22oHU0v0RNU1ODOPOoFomGxAl+\nX/n1zK37pNKthjHRcoMlsKGzQTC6Uyjf0tPIpNsvVcfa1KO3HK/DX5/CT5S2\nmoQ/lFfQadweg9M/eFam0IYsYsVgJ7+VtNfQRaf5fPTM4pulpn0kmtylD2fF\nFBLWQkRA7Ksleb8HzuCWq+N+0KEAq8Pni0R+JJPJvyf8ZSfVWwQYbRpZmG1l\nxbL9\r\n=KiMa\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"fbf8f516b0bb6e3e5c4bccb1fb0b2b59b9949e38","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.12.4-pre.1874"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.12.x || 1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.12.4-pre.1874_1605054338449_0.212924585538663","host":"s3://npm-registry-packages"}},"0.12.4-pre.1875":{"name":"piral-pwa","version":"0.12.4-pre.1875","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.12.4-pre.1875","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"39f611dddb18b9e75b0c7ef71e13941979143efa","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.12.4-pre.1875.tgz","fileCount":25,"integrity":"sha512-fVtHyKu1QdBRDKQBtlo0I3iTZYmuCYAxYxMmcEOWXhFpT7bx7MQpncMZ4BYWn1RO88Vmx3nZjNpPKGiRyHuzYg==","signatures":[{"sig":"MEQCIGdAxoD3D6pmG14obRpbd1LHyiqVJqpfwKEt61MihZPRAiAfRexbpSJ2khOgCS0m3Pmh4l+o12Xc26DbF4jrBvAK1A==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49287,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfrBFUCRA9TVsSAnZWagAAKFIP/jPKYqg6iKrI0uoiqGL4\nTzdyE+fvtHVP9KiwzhSK1DMB+LZN72cLc1OdroKXdfpBokjkf2b0lx3vBkG5\nJDgz5N6YWvflupuVJf4UKWGRJhp5kJR2fqbbLO7xoEBAN3SbvTVMRePr0+mX\nEQy/Bn7HTba8u4TPFjJKhS4AsAO4JhADDmc/t3Vtpkh6ef/CV199tWJccXkZ\nsEqF5nZ6XXc4XB8BXJqxkfHlQ3TwF4675W4pvLWZgWgCsPn1/ayX8dt2Kr3k\n1PcPMFsgO27oo5Vfig3PkFVk36hvR1RiTVelSLSNf0K85p3TS6p/vn+wKGuI\nnk3aZ3UVSZY7sITEh2c8Ic4CMSfoyNqSnUCpZhLEfbM80fWwRE7me5jRNYXN\n5gGv+xOoNsgL5X9r9vAif5pJgFCoksRCyiOXCpSXirsJYgtfvPENXqVLp1eO\nWWmA51svnMXPQxzTNRsC9lLzGHN0xVmmirz8ZFcwOBsgiQiHwALgE9hz8kAZ\nzQzvkXNWrv5c+Btx5IJOJpM7s2j0mV5X8iOiTSE0I99tVnNH/yuynNm/PnMC\nhxsODrXuvf7NWn8q80Tvgk9PL/c8Q9sJgNzvvcIjSKmK9mvhgCsX/HXE+vdT\nrP6mzxr99FPLfWN8WwxgjmJxz+Bea3k41arTs3jqMpSkVXaEJGWOhyHhCk3d\n/nxF\r\n=PA1d\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"4cfade25adaf1d122f7485e1954c5d6fe2f600d2","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.12.4-pre.1875"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.12.x || 1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.12.4-pre.1875_1605112148289_0.5615521317369239","host":"s3://npm-registry-packages"}},"0.12.4-pre.1884":{"name":"piral-pwa","version":"0.12.4-pre.1884","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.12.4-pre.1884","maintainers":[{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"},{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"139ba468740e96f1b09007f361a4ff5553d05d0e","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.12.4-pre.1884.tgz","fileCount":25,"integrity":"sha512-OhL3mhanFhrXkSYyeVWmLMOAB9NhfJpT8obujsRxY7vdgtyWHpfbkC2fWHrpQnehZyjE0X3NNM57S/+1pIp34A==","signatures":[{"sig":"MEYCIQDgGHMc5KaRztHuyKzbFoCpLEeNxDG8EgrPbkIFrpZklgIhAMRZMEnqqkZUGLGH8yyBNwOjbAUg/FMl6mPygSXOew6a","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49287,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfsrZECRA9TVsSAnZWagAA5uIP/3kZS7CYQzfbsRy3cXIE\n/W9Vr4irE/wdF8Jh1D3RuJQ2AYjdxV96J4JMnOIr5+4vZUGE/KEFrK3PavHo\nqGbEYu6STq1yLaKsuN4rk4FYITICpdHxII53Dha/XvmkprzeXs6i1QKuUaaH\nUbR8MSEcIyq+N8y2gv1bK98uWxzApPXGK2CFolp9Ee5R64otPPUqOvlzI4Zk\nFV5AM5Glv2Hgl//r0IVI3W9iQEq+1Kl9jxBsZ2ErrHi7CG/LM9+ywdonwnC4\nxUeiYIA+zmL8ljIyHfwSQ+724+3WvoT0lHOMtewMwqtkNXWHzmTBJYqRioCB\nUti0KQpPRO8JANVu705UJfqPplhMPQp9XiIEcQNb5QGtvr3iC7x0DKnkcuhb\n+jAaBObwwWY8faFGp2aQytvC8kWUNjoL4DPCACXAcVuGGt6Xd05rgsdrWLCc\nIs/1+FNaj2RifU6CUKkYVPWNkHxlDI1SlzgrJTplTNpHZ5QvUT+XBxLVZO5a\nW1czrNQf6XyljLVV+2syvKMqmgD+4kyYopYD3/Mtb8VQPgNkvZLDppwhDTgN\nDQmktPZbEHUiWXKrx6DYu91fR6cOgof4kkHwOtWU/6woomgh4uO8xPg3bA79\n6MIu0PPqKADHUMkIjyUTK/a2DR1ku4aCo8AZWbUsWNjHM8Y8NkIENMwISg9c\nvAoY\r\n=F21l\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"895939b3c748be94b8b6f5b726088406c9420de2","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.12.4-pre.1884"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.12.x || 1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.12.4-pre.1884_1605547588330_0.4459934970356998","host":"s3://npm-registry-packages"}},"0.12.4-pre.1886":{"name":"piral-pwa","version":"0.12.4-pre.1886","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.12.4-pre.1886","maintainers":[{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"},{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"c2df710d64bc4f92cc3db3319f75db243f3461a9","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.12.4-pre.1886.tgz","fileCount":25,"integrity":"sha512-uSVsRP7cO91eB4iNAT2SY1anrmPTv45o2pZMsVh19Zy+KVe/w8GaQiAAlLi+o1ZlszNLJ0soHsEcYUO+7yunRQ==","signatures":[{"sig":"MEQCIBF3UXipnCZA5vpjZNgKeaXvmrd49CeGV+2R3AeuT3R6AiAsCBc7VIg3Qh/EKQO2RwXyt3EBYCdqxk81NH8wkwBZLw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49287,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfs8d/CRA9TVsSAnZWagAAKyMQAI2n3vhKbcLnOLSDPSJr\nDxk3pJqB808OBezYhErBMfa4LliOhLfVLIPZWoS8K9p05Oio1Px+7F1aPKyF\nra1tgGm92abFX9xYpRsEMgi0GjTVhSDH820NssccYKN53sxKQq+ZOT/0tTBu\ns0uBjv1O7wxSLyKOvHg3Z/PMg1ukFyLOKwhGCFTyRSZEy43i2EscNd4EuTJt\njPgaITEWrzsxoDt7A1NDCcB+RMYk1AnvgsoP2gzpiP+PTwfXSEM85J6723PS\ng5d9wF47TqTpmAuEllqqKVx5lZOf9uvC8AaKY1BvCvGt+cKTPpQUtWIjc+TY\nepMR57ya6MY4sVM8M4lNS0AAKZp9WOgbt1Mh9FCgZ8xWRaAdQEoIaBIxOPM3\nH6YuFVI/TvggtaKvP3vcF/oNaAHcyAJLmTbvm13cAEoJh94y0oei1/nSKAEJ\nadjuJmTqs3yWgsHcYJAp+X0MMGuWaofC5Z9PHPO4CY6hv8yNI6AwtmPSotM2\nJ7AYYH0u0U7nEi8Lq/1oiJYrx9clQtPz4fGhCYKUnAwzqvSkxkkxlD9Y8pIu\nH3H2FL6xYGFnBTr0QZAIIGODZMXRV7R4nhyGZq59Mch31CHWKVp5sMlZvMKR\n5AuU4WpyhqzhsN3obXud7MVJvAsnQEP9MAC9c73Y7ZWRqcc2jsU8NtTKRBo6\nQYjD\r\n=t2Hw\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"f7d1a8733ceb62d62905c0ceaf0e9162e70e626f","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.12.4-pre.1886"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.12.x || 1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.12.4-pre.1886_1605617535063_0.12011465398764609","host":"s3://npm-registry-packages"}},"0.12.4-pre.1888":{"name":"piral-pwa","version":"0.12.4-pre.1888","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.12.4-pre.1888","maintainers":[{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"},{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"20b2feb1162e1af337f29d8e6202f48966cdb75c","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.12.4-pre.1888.tgz","fileCount":25,"integrity":"sha512-mceJq+YP7p/BoJAnUATDDDZrS9uZvxTn9HyFbtU39blDVz2saeDxcXGl0LQfLEIgm+ZBGu3cN77sNXJXEz7ZVg==","signatures":[{"sig":"MEUCIQDhUvWDj18c840Kqr5PpKCIrFg1xS3bDLBVqLSoMFMs0wIgeXhYgjJ9Sr2UFp5iGIlmkaUwNX1/OKZNNzmPSXAP/D0=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49287,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJftwoFCRA9TVsSAnZWagAA7CQP/jgHJd7ZsyvjP4UNs448\nfxY0o+xTQU62uujiJRsc5O6vARgskCeCR29TIzOTOW8XINDcb8SxVAYQ7KWH\nPNEnmLELU4LHBkQffzJJb7NBnNK0pD1Qp8e/Q+254kWwCZ2nUxbAkRn2cZJn\nHxolCgOjMS1qphKPLmoPWhRJuKlQdDQVfg7rJZRApnbc7vTwrtUWDouNO46Q\n3EromJCbt2B7C3838TF4pZkHKXS5ddQZe/qbH9u/TwU1eAQdILC1kd/yV4GH\nsnapDLuY+TGwHFugJlEWaWDDwGyyMd4bjuH7+C13iHEN+t6J5gnC9VuhLerN\n5R/MMae4bniZsgB954s2QHpSmyPwNSL0dpE/tAMZBtCt78gTeTJlzB0kLSYZ\n9R+uoQkj7KKBcBpaClMiShuFU4pCWeM4lfIO8kDg70Rx9mccKGvAA32fQ3Af\nlcLGVPjb4WPsPo1zMXj0n24JppffunwwuWD16T/IUgu8gRe4Z+/MxyIadBcD\nyjeKTAEdd7hC2BXJNm74CRiiCW1VSbshpr8Ht/tPlApkHwS/40aEDjfzDMCL\nF6cNqt1JgAag6wwHOkVWaE21HRluaXLJJSajv9gWFbEh1amTWXapZ3bjyJPe\nCT+3oweQbV/unlo7UffRQ50RpDUlaG/R/cqYLrj8ubCphNaC8B1qu/NDNmGY\nW9Cx\r\n=vdRQ\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"ceea58fa7fafc633dacc5225dd245376e45e5a37","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.12.4-pre.1888"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.12.x || 1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.12.4-pre.1888_1605831173493_0.6127568162091326","host":"s3://npm-registry-packages"}},"0.12.4-pre.1890":{"name":"piral-pwa","version":"0.12.4-pre.1890","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.12.4-pre.1890","maintainers":[{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"},{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"7440194798817a0d89688c8f1b42e80e92b2161c","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.12.4-pre.1890.tgz","fileCount":25,"integrity":"sha512-Pl9vOP7+fFx6tJ1x7MogD7dS6TUrx3/CZCxGT2M3/zIs34mnuLne4OB/WbGchQ688FBsrdPJTJM2mHI9eEndCQ==","signatures":[{"sig":"MEQCIAoAdZTDsNhm61qSk9f77BhCO2qHbDDSbhdruPwICRPCAiBEhZLWs4bGrkqv4c36wg3Go6T2qOt7ueApKeGOSyMtaA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49287,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJft6oiCRA9TVsSAnZWagAAGiIP+QAu9oq/Vhm2brT1+0gs\nCl0cunj2t3NqFGP/3FFLGoBCFcHYLdpz84wq4WKnVcewtmRkyQkSyvF9JAHr\nROIYQxzKHDzheslVEhf5NBwCWCqU3MtyahX90tzlmYGc9ecxmia+tikzph5j\nmk4qE17s6XsJ1ZIPM9UjdTVNl4NIoC/tuKtdjBA3ZUIBL3tfSbJnzp9Nz7mA\nKejrgg/ATO7NGF06RZseTKqOZPbwjbAnGzr6eEB6W4V/9xfyz2nIgSn/Hk9G\nBxw6GdbmfQ7vD6rVnWln4inb0U2mZmFGSAnZNJF45d1ICHXdUFDE46oYdjms\n8n15KOiY0EnMUC23Lf3nPIG4elLltU0GeXfOx2z6mvr7XEPiOcXZMO9sZupx\nVr1OHy3Eb6Lt/i2lUjJfCPuWYOyvRfaAj2BbNMRyq6AawhIFJ/NwBcsCS16H\nidup2UujQTo87TzOjnSxPsAQoFgf6hbrSRkIQI/wrV4vbGuePYe9o3SU3LoC\nTWYoj2hgbQ79yXmY8oaKZfnqgKNd2uU/xvhW9W5n5JzJjFBwPCEwbk+CGFOx\nzSd5S4XzwzizLdijH6CABC5zWXgJLdLd+XsgyNxFqt5ODqCzjgKQe92JH3ud\nPH6iAmztnpFxOLfZcPTADh9tIMuCzPLGGltFKR5Ze8BOLRuxDGrvxvJivOi8\nsdyY\r\n=0A9g\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"8af97b82a47583ff6c427ed94499df308149963e","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.12.4-pre.1890"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.12.x || 1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.12.4-pre.1890_1605872162408_0.40246274133519333","host":"s3://npm-registry-packages"}},"0.12.4-pre.1895":{"name":"piral-pwa","version":"0.12.4-pre.1895","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.12.4-pre.1895","maintainers":[{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"},{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"616ab93875b5bf7d3a63f95b0631de2e053c5dae","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.12.4-pre.1895.tgz","fileCount":25,"integrity":"sha512-s57Mxazd4RU0oQ44/OQAR0AwT6KG05Oazh7i1sXZcaeHWEC7OH2rPw3y1OtgwuKSwzcrlNqIRwBhVy47gyQg6A==","signatures":[{"sig":"MEUCIQDmL1PJsVvDbr9qNjBhtJswrvvlQhisrcRfKR7jJ1TbMAIgEcoYxPJrXIngnjCkHHgpoM8KfSQaKRZ7rf2C9IsgXzk=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49287,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfuHZ/CRA9TVsSAnZWagAA2/gP+wfq7fPRDJCbjPuD8ITF\nYmMB1B/PJtbeYHwr2iHh5sgbIKEy8jxsXx/agxwnmFMW7qjAvnkeNByyQkzL\ngkXrBbtQLf75fkVPVtp5T4mVgHQNf1se4tYl2WJ0tRvuNCn0ndGUKjvNUPMb\nNxFQE45btWZkq4rC5upYjsVgvLFQYhMfq+4Rwfax1XZfDs7i7nODfXhk2aVH\nWbTNtl1RrMqNnZmURKKBtBLyYxK9XmeP9lWLZcYJucQwsbOOct6Ilarmwlxj\nTgRVDNozzoImDNl5dnoj+JsXwzNjtlJURAlrhZNw1sawJZTzgR59D4ixY8I+\nVVqdshJZbyBzFwfQGYfUY+bUSTjx/ifw0VQcpImsbzWaxDYUhj7dH//PjQl1\nNv48FQFoLUcfW0vdSAgt9wIyA/HMNodRxa4CyUVshyQSVp9i0qbBYd6xqEkd\nayWsjqgiSDimeeHrJ59Prsl16tX4tVCjcjuHdosYFqU2NDT/U8+XaHPlYkoV\n28iuFK/5zA27+ZMJM+s8n/z0DRHdxzxuzyKEz0RayK7Lp4wzNjrLcyXAxebt\nHuVlpyxYph5Ka3HZKQHv+fzrPVl16W2IzpD69J5hqd3EblVeuNZfVeuM409X\narpz3WwD3xvYAudZKWXYRxzvy31i19U9YIrOWb8sXFRWvHb09jsuGwbprLaT\ntrEu\r\n=SYGS\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"d387a3ed51efe2d20cc172fa9d7c64aab5a16eb4","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.12.4-pre.1895"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.12.x || 1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.12.4-pre.1895_1605924479390_0.44008234029241655","host":"s3://npm-registry-packages"}},"0.12.4":{"name":"piral-pwa","version":"0.12.4","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.12.4","maintainers":[{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"},{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"eac5287939da6aa95426063bb84376071ed30ae2","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.12.4.tgz","fileCount":25,"integrity":"sha512-4b9VVuPTceTOLqrYv5631OG8k+sE58OFvsKgWjE++XylvUsS+gfHTX0ger8SuWK16H9PfubDqFXApD7YoG8eog==","signatures":[{"sig":"MEUCIQCwfHC1chIQPBlzRU2YHeCn2HtMauO/9cG3T8W2ViHubgIgPemsjrbUfKd1imyCtIjz3YnJ/4fEBVlppKZaJqL+N8s=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49269,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfvOqjCRA9TVsSAnZWagAAPDcP/irBIE18eNwUK6hRyKtN\nNQTIUJnfd47tYJenID4q1YR9IGIW8CJpMVLR8Dvu0LsiLHLwKPXK1ZXfkKVe\ncu5rnNx61VnswNQ6Y05oo2LvqndoBgVknjIeIRwdJ0d1mRAc4nxvz0tX9QFZ\nPgbC18jtUTfZwAO104A8n0yNrVZe3iolkUEoe/XEMC3mZp5DKRxw6GKuyMmt\n9dwPiCVI1jIhT4Z5GZOWSgb7XYV2Xs/LUmPcau1tNnj02F0yQfQH8FS2cGcX\nV4ukVAfYbp+bWMkQ6eHluLVoZOjL+LzaKeUYzbCmLB+Ri+92fbpb+h9W/jmO\nCjRGZsfaxjhMohAWpO8GWzuH+t8fLOjus24VakKaILo4GB5Q6cvtTFvUAKHt\nWL0vgVzzw8FhDC3ODo53kBxIkXtxsKUqRyhUB75i7efhCxzPmRfmL+cuR+46\naS7PmlicsHncCbAmpAPnSlkFe3RfeIUZj33gqpnpPxrCwjTTp1a2UHEPr9Ry\n3T5RhCvBBp5MqynZhToaPUBOJHi4nrcaUFsXGyN9KVZ1v699ba9KlcDPZ9N8\nYlWw0P0dtu8YcEb0GzgCMOODTGCMalI9btyjH/4+A1Cc1uXmvrVIHiYgUGU7\nM+drX+mZAKHAF5oiPAH1iQ2e80WpdJqzLCVsZlChqXR4bVtVsEdQNrfWOTpR\nB3YT\r\n=eFXO\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"e288b5b73b5047fe43777d4220724dab12363495","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.12.4"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.12.x || 1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.12.4_1606216354617_0.18733931712426566","host":"s3://npm-registry-packages"}},"1.0.0-pre.1899":{"name":"piral-pwa","version":"1.0.0-pre.1899","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@1.0.0-pre.1899","maintainers":[{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"},{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"5307a379bef9ffb091159ce7b2b4e5ca89060f64","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-1.0.0-pre.1899.tgz","fileCount":25,"integrity":"sha512-jB9afCsO0C8iYlmvS/K/Sw5UTgaJ/XOWFEWXUeOrMnOBj1v1vkZAUoYzaEQQ8g6m01h6ok7/S2O5YcPO7qb40Q==","signatures":[{"sig":"MEYCIQD9XRrp/+Cuu9KOdfK6mT1u4JR9FAO9wlX7Ob2MIUuvDwIhAO7uinIvbfrzxBqzBtx2FNglgYbYMr/D5U6zEe05n2f0","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49285,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfvQsXCRA9TVsSAnZWagAAYNkP/0dALXDOWudCBDNP3y/L\nCMNRQJqEC8CjAjNEhaJl7jP8D+dgxvXEVUiPjrEe1K4dOoiq6VhcO9M7/qxI\nwz/L5/chKbXJjn3rjMb7IJ4+RvIcSxH677LUcKFDMlqe57EBbuOrORzJ90Ld\nfAgPdcmfQFUahJ/PRNP9OA+3G1nx8fSqsWXtbX1O0cJSLAap8nmFDQ/UOzyh\nJFpOScdMXYhlCkC1nqEhpvo3411Dzu8N8T5SnA1u17cOYgWi6yhs52f69Uym\n4uDlft4P8IrvPjQMl5ORXx00tzJ5K4cB5uOv6rz/L6nxA6uUVXWQW/jQkJHE\nzfJCoxLbUbxmsC+QlXfjJ22ld4I/Q+cGJF8UwD7eqGG0OXbJgoLPowPHHSFc\nDs6k4X9WZUYH9WZ4NiH1Ii5gXr3+DaKYOVNyMdHYTfHIXB02TNJn1it1dLes\nftSw8970yBRZ7jqwXbUePOEBQ8MA4mZHt1jRRT/QDPbJ2/f+gJlsRVitlcdD\nEaftCwVy6NKQzjPG28tfUnrL/WhH6sGD6nMIVBj4br2foUwGOr4us/aEr2Vp\nzV69fl4QipiO4PhBJOjk4xKdol49cSWIIsMRq3riV7xH+gxtg8UJQvzMW82W\nADzknclNjW8EAyy8rwoiYZDZCt5pk1z296iT5AO4kVqax27iSmyMUtnbaaL4\nlthL\r\n=SuZq\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"0ef6bf888f3c9c66341b275e54613173c290c652","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^1.0.0-pre.1899"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.12.x || 1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_1.0.0-pre.1899_1606224662534_0.47753016929177017","host":"s3://npm-registry-packages"}},"1.0.0-pre.1959":{"name":"piral-pwa","version":"1.0.0-pre.1959","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@1.0.0-pre.1959","maintainers":[{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"},{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"be988f51776a624175ffb53d5a781ffca150786b","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-1.0.0-pre.1959.tgz","fileCount":25,"integrity":"sha512-/OiC1IZmVXSiQhKS3GmNYl4wyDXZCHuuHjKFT9oseUuzuW3GVOpEjOLbB+sIu3eos40LpbhA4YIYwcHfaKyN9A==","signatures":[{"sig":"MEQCIC0Qi+MbGu0WEe/hzCKRvQ+e8rlG2QEP6Oi4PoWTSzxTAiBXN0KVOoPKAgG/p4KqGdenMwVpdDXXpyd5EyFu2/UXlw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49285,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfz56vCRA9TVsSAnZWagAA0noP/ibckCPnESbnHVD7NGoT\nOmO23SjJ5lDnw3oAO2NH/71XDj5dQickvS6wrksaH0KGGA/0mGBSLcL9LZVj\nMmzQUwt5T8AkknrMAsC5seLitwYnG/HUKy4376l06kBHdw4IAUbURnNF/jRR\n88rAn6lEfBHUBTAcToAJ5QZXO7EX1t00j/a3HjUg2QqqIW1lCTqg4Pka+xvy\nLEJJ9IqVjKqdb7qTrNOz9cAOJm/+6wV4pinFMw7JIwoqvOtnDihxnwpjjrF+\nvQITM8vsmiU5Boed3MEjLFYnb/mt9zNWUi/RKNYOPZ4AVtln7lNaUuMhjjc3\n9ERCxkt0WKDzB0qd0K1W8prt8F9wXuyLHbN3RYF3t1HQ+WwMJyeOHyYIzdUN\nwE4l5t/Ib2rMYNqczcxy4TAEcbb6ux7dH3pdNeZ29AmF52ykByQ5/cu9r20o\n77mLklXCY4F8X8DJ+SYpIuLIcDE0MHwMxDNWzTzs3kz4/+2VsqY4HrglAu8B\no/QqtOL+HskXx+sV2zS0TAe1X37mX1Qsnu/8kQIZcWjN9THwlYXP+Vml6UIE\nojncpYLYgQg2gMN0dSKsGoIDpFwVehgVRDJ1fKzhpK5OyRuUfwo48HvrZyvl\nfxQ7JuFr3cfNeQHAEK/rOqfCUqz4ZEPI2FGEooN74sTvNRfbeeExdubenSkX\nDNwl\r\n=oJWb\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"333131723609a66c76b743ce322542aab1e650a9","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^1.0.0-pre.1959"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.12.x || 1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_1.0.0-pre.1959_1607442095146_0.6347892694688713","host":"s3://npm-registry-packages"}},"1.0.0-pre.1998":{"name":"piral-pwa","version":"1.0.0-pre.1998","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@1.0.0-pre.1998","maintainers":[{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"},{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"8fa0b9816de837f2ad3674b93392add2619e76d0","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-1.0.0-pre.1998.tgz","fileCount":25,"integrity":"sha512-1ZZAwUVAPIwhu9vknYA/MEnCSdpFF/4IN+BMVlh0s6FWldW3mH4xlZ0ihBpA4uy6MXZ7vtn+TWAHAEWn30Ijlg==","signatures":[{"sig":"MEYCIQCYn2ATsdTCczpVgP3+kCVTUtx68A5Rh3IRrq3v7tcJMAIhAIkZ689VFj0reYAalu4wwfmJvgko3rubQGojV0cWmtl9","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49285,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf02PuCRA9TVsSAnZWagAADjMP/jwd865krQCb3HrjzHKN\nN54IuRBNdhTEsLumCbo2oHMF5FNHaHvT9fUrpUr7L2KuQdaCZ+b2ZTh61EBW\n7/WJDKBZDeQ+aYRgTwN02atKXZEP93aL0O6ELArJ00Q3S1+wdpyxRRTcyPj9\nVBKpPax22rzu8bH8mcjmDY/udjH0ItGukwHdhaX3VnZTqFo2UstNDStXxrCP\nrrTCwgH8De89iT6zBAJESgflv5fIuCniLu9fyOBRjHpOIhLyQjiYUzXoHKR7\n1XiCyT1N2d36PUS6KAcGFq3zfsVdzN9CmxEnFi4EhHixb/YHi+/zKYIRNgdY\nIdM9NKaFAEya5E4jtwyfaAAZ6cegRURT5CpI3ZqbFIGl3zqptwdeSHwVIfUX\nmJAqoD+21Bu71agQW81BVu3xyZ5hn97cVL/L+LCxmNtDo1GQVWvGtfql+958\n3bRrBOIkYhdXA8qicSZcb0WOIwlUitPtlZVw05qbkJQ81hJVqlA7YUt3DSv5\nbWgOLYus4NXPKUJYyFFH9AzRe/LYLVx+0P3W6uz5X0wEq1xvAXfFHBSp/Ta5\nFN7127poWOQTnFX/MRmDdCqhXvcPIP0EpfRSQRqnnU3nzsadZNn8Jz2tY9Wr\nUe/sO6BYt3fCUQ7ozZsOUIslxja928Qlkkv23fSP+/F4qffp5eqsbDeDlbQI\n4h4Y\r\n=iYGf\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"bbb2627c1b96262a6e3082d393abe9e324e3829f","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^1.0.0-pre.1998"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.12.x || 1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_1.0.0-pre.1998_1607689198469_0.06150964039772888","host":"s3://npm-registry-packages"}},"1.0.0-pre.2025":{"name":"piral-pwa","version":"1.0.0-pre.2025","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@1.0.0-pre.2025","maintainers":[{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"},{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"7f51603b96967ceb552498b4d1c353f2f4098d0b","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-1.0.0-pre.2025.tgz","fileCount":25,"integrity":"sha512-tRX/f/U6LH0q/4PkpXPyy3OGcCOUiO98lSiWP7rWBIFzl03eVlg7RFvryyk/t9yclXEdDNqdOFP2Dmfgft4LqA==","signatures":[{"sig":"MEUCIQDD3qX2cJnjHf9t7sU/LDyr4/m/pKdCNXbAXZLiNLJQJAIgR2ClGgdw1EZjjE643uOL7abdtn5jeLKWLKb8AbQEnco=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49275,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf1XkrCRA9TVsSAnZWagAArX8QAJrsvOfwqVNUUSdUiY4Y\ni7F5AxdnM4sI9lc9DnlUH9k4OFm4Y8lP9O0fKVdGyArIH+Wvo4ce+s3HWxmJ\npt54XRSG0PJTTENkOl6hVv8wr6jQxwtcJoub1lzU0KdPfK/0DNhz4FxMkVY/\no4LBymBGOlLOggvKgKqgt8Kxv1a4kNNsEyS+boTrW6VHgtzXbvZI/XV581g4\nywpjWJCWQdYoEIxw9nvaOgO3ZOQ8xRmHeJ+srzsp6mR7W5HG0Xc9kZArhPuZ\nYl371ZzoMhkWlH6fd9J80G86U14A1WSLwIXrcrA5DJ6aHI7W8j5DvvmdpdNL\ntuPAhOd09Yw4jsPOv5wluzWBGpLM+qC3gSMJcK1jK+hWj7etTKCXTLZDENlB\n3pjIPV6n6g4rAIoGBy1SS1dFyCB8RCjCQRrnf6RZtx14UylCnZXMHTz2FS86\nviImGdaeDw0BGQzFHXuC1/a+Aq5+IgFAG4dKrNcN+mkJ81q2DCts6nCxe/tD\n1s6/guweY5Y/QGEYBU81iUN8dIutk0Ffk+px21Eirzp01jy2InI8Bwxp/DxK\ni+Lp21upMPUY9MMYFSeHZw36okbaeOxA/9rbCMwOtlAaAEwNN+yxAZeL2UHS\n+VcL168H1uasb394BTYyVRDaaeg8SMjQa9uyybQhbgyrjohiwwR1whwHvPu+\nsqKE\r\n=uH4Z\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"c4c723952e67352c4a737ed122ecfed90796575c","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^1.0.0-pre.2025"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_1.0.0-pre.2025_1607825707265_0.2033465441346365","host":"s3://npm-registry-packages"}},"1.0.0-pre.2028":{"name":"piral-pwa","version":"1.0.0-pre.2028","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@1.0.0-pre.2028","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"99044f4496d00fb4d57d9027288bacf959f17223","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-1.0.0-pre.2028.tgz","fileCount":25,"integrity":"sha512-CpIFSpjmRpJ3H/PNGtiBxsrtLW5EmoHVpAPlRfuw/ggv4pGcRlzolA/oK4Okr7h0Qd6jxrHPd3+mc1zAi/CyHw==","signatures":[{"sig":"MEYCIQDlVp+PsJudWPOlHmU19hMWHHkubDsBwGs29Lxaujp/aQIhAOHrlTTQmkQuij+GdyQHuDnDCikud1fyOrLGbtR2ZQGO","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":49275,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf1g2GCRA9TVsSAnZWagAAcHcP/in37Zv4GN8Ya60mngc/\ntP/li8Q+IVs1jB9LC7YfB+jFN1hDpTuUQW0eXN+laUzpTfuT5sACadu7eYBg\nzFzQPqT3UER3fV3jH5TZROwWRTzxwxn+KQC+QWNnCj0PYGmHj7tTmtGgtoeZ\nLxK/p9Dlyq2dCOYKQ+WtWyVzO8bPu3hmStl0egYiE/0ChDCTcHog5TQ2XnG+\nbLLih+J73fTBVIyNJeNk7LiOgxWuRf31sbcvlODH6LhAtCQoB7mDYACnj9EF\nHT00uIMpu4GGHz4mTGwbDLJddab/idF/tbfPOi/XH6XhShHXOk5FsUpxGWYO\nnvajygOiySoxURychebdE4YMnHFSGynzYz82pl835mDBhvG2F8AqvBWPhbj7\nMWr6f2xGFM5D4DCkPakm6+lKbvcJjDGfq0yizppjEhT7CUODPt+tutgRfDjN\n+UKZl+J5JZE6qjDk54duP1eDxOeB/bwfkbV/doEoQIf8q4ce1MBEneHSNq7x\nhxFL/fj81yIB5T5wGKqZ+RDNl2Pneg/UJNg4SBzFmW9+mrFtfVgERV6zHuXv\nmV8Wx8hdL4YmSvdUyGOwBbeeT5ppAUh36zftsjVRGj5nOlw2WyCqvLp+gVtr\n8JEMbLPk4BVvVTUbqLiMmu1t0zakw9qliPJTOY4m8+cLOi+c+9XZ79dM+Qa/\n6OTd\r\n=F3HC\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that only has a peer dependency to `piral-core`. What `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"8b7cf279cd0a2b73de5ba82d6d0c1143cc00a56c","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"tsc","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\""},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^1.0.0-pre.2028"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"1.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_1.0.0-pre.2028_1607863686359_0.9337628139612455","host":"s3://npm-registry-packages"}},"0.13.0-pre.2244":{"name":"piral-pwa","version":"0.13.0-pre.2244","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.0-pre.2244","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"03dca014fda3ae071a398d620aa9ce53997004ed","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.0-pre.2244.tgz","fileCount":40,"integrity":"sha512-V36qfYfOgCzpu/T8EctuPJrtSOtwsCSv6N9KURGbv4ZPxvYWxb4f6UmqwkUpnx31U1Y+QsGBrduWi/cntFSpeg==","signatures":[{"sig":"MEUCIQDqjSMSMaSyD6QgL+P3mSPZuP36a7kQdD00OWaFf+7LEQIgKcH92UW0yFcNnQtisXEZbdan81ZpHYUOhhv8tDYNfik=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61137,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgU42nCRA9TVsSAnZWagAA73UP+wTkVO0X9uVNqlcPmCfp\n85HLLBNv5mL5kTZvkOud6mBRWz859hV/NMgxO4hTN4nLZSS1iSr0UpcZEqFX\nUAuYHU94fk54m6xWf2H8X18aWkdyc9oavvYKQxRSPG3ElofIZm2MPAcgB5ar\ndokEaJcUF3g/mrm8KkJHZQfG/NPkhDr2IElOX84OHlm2cXSNTLWfnGqtANbu\n0B1UZb/e2TPPW8GjXfFyX5vuscOIzyC/XYE4K3gSw99PtkhUss4IiAvXUg4L\nMnFGq8+55GQxO48N0nCE1mg53y66ELYG/BlE9Z7/G5D4boJrI+bUZF9TKAWb\n8grnigRYXkBUP1CNAfbaAaWn6cGgHH5QYcwbNaKTZ++rDVr9cKMkiF8sEdZn\nJo4ffbVxdaKN4vtweuD80Asv8iAclvtl7FgCS7zoCdEEHrzREAsrbo0lfc2m\ncViMLqTzILZg5UxoP9x9GC5M8SSP8SCVOCf1E2G9DIlQ0rQK6xi+btM2I80H\nvDN53EnzwDApEboUyEinKXP+6YPUmNavVvrbYOUSMlY6x/R8On4LD3KCUJab\nQNJ3lPmUHYwNirNed2eqD87nghTi099W/hrMTPS7Q0EHhm3+Ujx7wfM0Nn+b\nNl+Cj1LjXarp0/cARrAakxAlAAws7unT/Qd+2gI1CRjm4baik1o941l8GvkJ\nV+RO\r\n=hRHZ\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"0fc650912ba35ea5e826c7fe4e70baab7d31c171","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.13.0-pre.2244"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.0-pre.2244_1616088486670_0.15244885566113608","host":"s3://npm-registry-packages"}},"0.13.0-pre.2253":{"name":"piral-pwa","version":"0.13.0-pre.2253","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.0-pre.2253","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"67bae66d812b300551b46859fb591de06c360526","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.0-pre.2253.tgz","fileCount":40,"integrity":"sha512-VL6fQIeZLM0pnuQObqu5zNyQH2gv1COzxRUFa5eOYXf5oQOPFKCiNwSqPENewyDGO9fiusF7j2KdOOvxipsLtw==","signatures":[{"sig":"MEUCID6loZRfZFX119L0plbuS89UFdu1+8eAWgYHkAsERlVjAiEAnOu0OTaLjTWAIxp3nO+KIAGJUCK38vEJ1UlasIRTEso=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61137,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgVUUdCRA9TVsSAnZWagAAvqYQAKRBy3p42g1dwu0YO3+x\nqrtPKnKQunalYYEGuFPwGDosyEUx8Al7i1f623tRz3HBtak3wW6MndV18sGa\nsIpuD1moVWDjhQn4+SdJy9lJ4t+AN7Rq/llD1hLxOFZcefW5RfozKooszJgg\n4QgW4kpWCED5VZ70zrpQS1vphUhmVrpgjnc/6IM5Ycrk2NzUmHuoBAeQWABD\nnC770RKip+WgHtSXtTPqfFE8VQZAouSUcDhHSKxrpU/N/3A17mWM42z+8H3f\nZCy9BRE+larBGyYRVWI4ibgWZBUf/uNjvUTbEZdvHp6S/u/F7K2wDF9fiNtC\ngUbZG0udMe1l9QsMkGVQvTXyDvwg1Z6hI5DmLm1Oq22XBvOjAdqruNYPP9Ch\nMFXtvvY18uf56zMgeZEt2pS1xdQ8DPX9v77CysyKkK2pUvTV3724pE7TL1DP\nRczj7XX+9wsthhDdoy2mRiyzj+m66HrIxlQ57CCBSDS7TI1JkKmbyd7foDya\n11RIi0DuBrTCRkRdrYqi+sJz9yszAHrrbuFB7Sc/mANhn2SKPeCsKtGN4Qrq\n3nObkxOtTRX1qqYbE1e2pwVu2R7QWB1QfFvesuv/Gv63yRSmMDcqL8PVEL6U\n2uiy2ICQgpvsF2m3t1mAauHxBCRM6HLNMdHdiIJDoEG8ZEndt+6OcBQmFvBC\nG0PH\r\n=RNIF\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"c3bdd3a4b45d81a1844f71314298402384a8736b","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.13.0-pre.2253"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.0-pre.2253_1616200988363_0.8075247576162448","host":"s3://npm-registry-packages"}},"0.13.0-pre.2254":{"name":"piral-pwa","version":"0.13.0-pre.2254","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.0-pre.2254","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"3f1cc666df55dd43b91a2f9d1251221553713ca8","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.0-pre.2254.tgz","fileCount":40,"integrity":"sha512-DdPhtjbmlfLCXHf0yVWpxjw16zv2BloyWW1fMkL5hAKUC7TwNXcFxbN0cHeToVsNjtx8vCOmd/ttCatRIGSc+A==","signatures":[{"sig":"MEYCIQCAQ0lPiBMsdHBCrzeymbx5oAniio3ILj5aXYVCWOjI/wIhAMbbCoX0otKzd74+76JonpfLyRIDMsy2tSACr24NE+Ln","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61137,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgVf3ICRA9TVsSAnZWagAA6RIP/0hEMxEoptk0JeXkmaPf\nNJaqB0g6OC4kR/OSP0uIIM9G4wVe82KaUCGgxGw75ngRt3PSKaaziPTaeXSh\n8PFbYknOAmQqdHAfxbr0YFTccGe995SG0+/WErJkJNBEQWeGkDhEiwTZFqpl\nNha0Q2sU+W9Bz+yBzRwH98oDbN64rRz9gUGztSOKAUegf9P6hcVM2ORa4oVv\nrhKcND05ZKdxeQZov/cuT1U8yAbUoURJyYvzEFwPNpAoBHga7gIevCeJsxqs\nJbJ9iMaLfTQNsp8KiLIte26ebcry/BB3F4lXNfO9sgi40yzbU3iS4PnHNol7\nlZkGuQzztHc3r21rbJn7cCXdAKIm/mGcJL8JCV3ObEmKlamwFb1tHhSKpuAP\n51IR1VS6Hshm3tJdSBKB2LuTB8W2TwUtiuwWTNFxJTGc6BWmhj707BMsKm1E\nkq/rUEPaQIjuGznFyzF105NT9m8CFro4EMLa/Cvc1f0GPCfvH3M7sVMTzi6X\noqBcOv6l2zNaRm1IZHcbqBttJ+K27qMDs+vRD3nDeyX+0VSZjiFb36bI1Uj8\nby3wSPv6NfYStbPjd9MFhvVh5OLOaD4Z4WZ6QMouPmcLS0M5Q/6biKuQXmsy\nzPnoMup4z9KFF9RY7lmEsD9Tl/aT8N/01/6PmAA3Vqjgtqt4YvfZ5ARcEcKq\n3E1T\r\n=yJA+\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"915e66bdec60d70e939931bb4010334d23498d1f","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.13.0-pre.2254"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.0-pre.2254_1616248263962_0.23369219519168172","host":"s3://npm-registry-packages"}},"0.13.0-pre.2284":{"name":"piral-pwa","version":"0.13.0-pre.2284","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.0-pre.2284","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"597b40181fb6796c82f51f0688d4e1571a6e641f","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.0-pre.2284.tgz","fileCount":40,"integrity":"sha512-aWJTr/yuh2ULfwMxyAQMO77YIgca3DimaXYauNQyANAzylZ3S/VvJ5Wo7lTrB2fmr5VqybcX5FEDo5rJ6q7vfA==","signatures":[{"sig":"MEYCIQC4qrbYhf/Z5LBJ0XQsmLE6MAxCnb2hvyn9P3g9Rw20EwIhAKqjqYxvGhi5DPYXYPdQffNr5cCGWw6xenDwIJrp/M1k","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61137,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgWhleCRA9TVsSAnZWagAAf8IP/1MvUSXjkdhZkEJuHvLA\nS7Df7jxTnP4jUnuoU8c/dUBxU/J5SSE/j5E0fiZM0lI1sXhEVen1rSRUgs8d\n2GO/NBJsFPY3uEEGHccZCXqirRxmtRvyFTAPF6BPqAXITXfbs40AG5WgrkQ7\ntzMu2ThK1z4b4sY46zhbBT6I8wZfbvWSKR3j1P53iKbgkMwffaJSPKOQb6Tk\nrg79EdUFJnH/rmvTtou3YmKmFJcNMAb8zVNV5DjJQAfN5G4j14s/x3+O92jf\nC7W2vE4PJlIxu0p1yhHnEeY+DNAfazt9MXDl5ns9Y16FucxMsOf2En77jiRN\nWo6yTVGHMTOdxsihxLdQn4VtVuqf//Q2T+cofsPaRg6sRNWTqSGQmo67kKEV\nMDQprg8JvDKDKJr7q3AW1QisbUf5pWWwKCiFTGefjnbWBig2ZEp2NJwvVMUI\nmfzLziPiFol4JEjHM6hr47Z1RVGXnbcnseGC3s6k+DJZwTcjeuo3jIFhxJW4\nGE22rfVrZGKfUJ0rFjQcfqUp2AplwCHJTNO/L4TBlfIAXsnGQvvYJzM9FsPD\nn9FfK/D29Pozi3DZmsk9QMlVGZgOwV11L5VWnnrsAf0jqSGdp9Pdtk/FT0es\nlLE31FxyeVBeRIPe7J/OP4Fd4r+H55ei21+nWWOw/mJLjsvB1s+6dUuIGqBr\nqoVx\r\n=vw7J\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"3b1a2574193c413c7b67e83657c878149a410f0b","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.13.0-pre.2284"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.0-pre.2284_1616517469860_0.4108985267841758","host":"s3://npm-registry-packages"}},"0.13.0-pre.2290":{"name":"piral-pwa","version":"0.13.0-pre.2290","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.0-pre.2290","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"c5c1a3f61cfca10a85c69c8d008780b8e02f8752","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.0-pre.2290.tgz","fileCount":40,"integrity":"sha512-wPqQaEUMqYtKYqoIvrWif+1OCk3V4IObqzVjKESIbFmjaKDRD8EjAzFXRzMh8ypOBBlXTApvu75c278zn8i72w==","signatures":[{"sig":"MEUCIQCgPzzez0kJdSzuo2BLo5rGqIJuJx76rYy3ey5dMHB/8gIgOUJ5WuFqHmXL9tJee9dpqi+4K5ygfkrh1uYiRtFxdIo=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61137,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgWlJyCRA9TVsSAnZWagAAeAQP/3+miEjXJ9gGgWyeCEvU\n8u959D0MHayQskrxfjWx0NvYrOqV6kdBS688qBTADwGKAh5WVuMw2lrcNMvF\nbWpraydqJYZzUHVh4TXdWylvF7e9owGPCEeTv+AUaNB/ap3SM2pX1CyvDqQ7\nVjsljF3bJ3zY6dOJS18FyX6lSmZowroEMS5uQMTmC550tylihyyp6C1hY0gO\n2JtRlbcP7IktMdXXVhpLeOfsy+KO/28iKJeYIhrzteZQn7LzFvfAy6niwvDJ\n3MiGa31Z4gwPIeev1TrgxENQvOliX75EqLf5gTIcIVqrvJP+udgDjGiYQnb8\nrRYvpaOWIcWr3ej3aGSB/ZRpu71/+3wezEmYoUlkrB24pA/9lRCJeiPTPfQv\nwmGz8c7wpnLB2nGEs6m7Jv130bD2q/wSbOJ+CvlQKt9yUIqb9JBDR8jLBVeo\nvOu6ji6OVG35MGIfjv+kjKzuDTE8bcCeNQ8s0TW6CHVOwJ/++MePHXVC7OiI\ntsfkpNje6f7aq5RBHFcconeoD0hG50Yxjykt4EYgU3UQEVWx6lxww26XIDbU\nYnzzMOaM/0FXH2DsKd3czC54/sRbRCXgWIJeRaJri4k9uFzYB+WO81DRC2qw\nPaGKHMw3Oq1CTcgWmJdEWaD8OAeGDRA4fyt7LvXQ4Nb/dpIQ88zqssz59Bfs\n3vUv\r\n=3KOT\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"f5cb5b48fb624f6b9bd3afea3e24534f0d94b3eb","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.13.0-pre.2290"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.0-pre.2290_1616532081642_0.9376465746431994","host":"s3://npm-registry-packages"}},"0.13.0":{"name":"piral-pwa","version":"0.13.0","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.0","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"03f8259e7bdb142bc0c1b60d98892b9f2a842e6c","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.0.tgz","fileCount":40,"integrity":"sha512-fhzEX8ubTe4mHWQWni4iWiwUJdDTsRyHEfPp684U7wCteq73D2w3+Ew6qhTJiFPJ9VLpW04fXiX6+ZHbr4OFRQ==","signatures":[{"sig":"MEUCIQDfwxkz535e3zLfdo6wQykv1Oq0LV1zAIata0eJyjDsoQIgFVsS4ta7f65x1u4/N9SRbLMNQ715treNS2or6RZamjY=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61119,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgWxKICRA9TVsSAnZWagAAAV0P/2YAp5//dG5ey+GweLSE\nEIKv+WEFH5kqGODVCyqhbnGWgLC3Z4AV1uWAXTyySzufWskRl0R3WgcSYOHU\nTczTZsCd1iDzX/cLL0ugLhzLW2fAIeL8H7Zh/1xvtakeREpOboSK2JZydiDU\noHkBDQK50eIjqianVNh9jk81uhLbdMkoEr54Hjq4eaO5MqnWBM7XDJK741x4\naudzHemns1fSB+oB6aVFZhphpSzC+I5lx57laQr+mh1kGrX/pyEXVzwz710V\n/UVJVDNYHK0ZkHGrtfPzUORGEqSY0N3efX0pfnv9e5xK72JnsBARbUzZ/8tx\nSYDSoGlfZhaVvJwwDCzEodn2C3pOoFK5rCN0MR9DpQ2NBr9QvcjSmrPYn9u9\nlGJbHKvbcxke+3CCBG7d/4ikQdHVJgy3WmChBixCCtyzmgkeakX/pwW17vEu\nh1vl6NNTY5ttmr8CreKXNRyDDqI0++NX5vHXDXshu8qLcPRKYoPk8t1gjOWY\nQkGhPwc432VBlTqQ40Rqm0nMWna/BeFMis2oWsKNlBtBb6odJOjf2Rw4DKJp\n1LjVVyMuoFSsBagKxJVFqRLz4LM94jbqhNUIx0ylgLIvQ4iNjUtTBdimYgjF\nq27fCG/88yypVwb0pYWznMYhSruHo+1Ht/s3RKDAYDa2d5am3z0mwD2C+mSb\nKV9y\r\n=RQCu\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","gitHead":"a3dfb71b2cf1e67755e6a3fed0784c9e8012280c","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.13.0"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.0_1616581256470_0.6452004152681716","host":"s3://npm-registry-packages"}},"0.13.1-pre.2307":{"name":"piral-pwa","version":"0.13.1-pre.2307","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.1-pre.2307","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"f67a18d206e758575e58bc15d697115cc8334c47","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.1-pre.2307.tgz","fileCount":40,"integrity":"sha512-i3/JT/SKnZxtaH0n7ZV8KPOAjAatrcKsrsZY2OlznIS85ChiyaZ1cby+/kaEKcJkAAUIVJ/9F2W1+NY+nXKg5A==","signatures":[{"sig":"MEUCIQDGvkKNH3IHNrVfvAYvXp5dg/HgklBhtWGK3toCPYMR+AIgHNuMtYFTkP8IXMYFoF7bFOuXDxiXID9lsA1gBmjyaIM=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61137,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgXMZsCRA9TVsSAnZWagAAiNIQAKRytEEj+FVr7fATGZ3X\nVZrT8ksmN27CJbQ2MhLswrsbsGovYM9wPFRC768NVqhYC2bX4fasclipP96D\nhXwCTDYg6NndatUtHQNUx6cHgdbvsdRBbLaWiYr+kcF+J9cAXh6aD1ukndu1\np+4VbPLb0otOej/a0p3MKnWf633TUaoAM8ev5qA3qRWOSGnWCQwcB3d1oB5F\noQWTy/LLK1jiwP/LA4Gg/LY9Hjyd6+d4Vf3jbtCCRJw5mEz66zneo+iiXkM8\nZur6Wpo3KXE79tdy2FZLcFLLinVGDLvk0oBnEAuo3oUfh5T+2YcEdTVAtN6U\nyGTdJQAYaTxMyW27xZVS0Joap2NcQ5G05B3VVBCB+YDd32NLcOUUgfg/8aXd\nNFFy7mzBimjhCvd9KctX8XWFtTjum6e6dgzcSI6vxO7ZHr2b3ztKe+vpfxFl\nVpV94V4UVQ3hhbnt38EYiE2cSawlS1OBDESF2ncjuKZ7snrlWRWTnDUAktgh\nEdM9/3CV6BKUFGkKod7e1mqfxj9Kf0vHlFe+vDRPuJfOxG8wmF1vbtn3L6LB\nyocvsMVTfObQv+EfoWpQpwMXiXmGjNfW2f9n8WLFtDoAEWcagMvlTEuaeF1K\njsr0yNA4vV4/KNd0pzWnIzIOTqqsGP4kTS0GEprY9D3R4JKi2LAmfN0HgBCN\nX/C4\r\n=ekk8\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"58e51a7f4c0acb05117d380aab6788f2eb965580","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.13.1-pre.2307"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.1-pre.2307_1616692844357_0.7907513921851645","host":"s3://npm-registry-packages"}},"0.13.1-pre.2312":{"name":"piral-pwa","version":"0.13.1-pre.2312","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.1-pre.2312","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"ae31b3d67e1d26e354203bcb775ab76d6e7e68b0","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.1-pre.2312.tgz","fileCount":40,"integrity":"sha512-LHXKzqKs53PzgjKoRfLz/v2jtDfkLWyvcnkkVE/ScpIOoOpQqNZ/cTDgX3FzSSY8H895acD003nls8xka0kkwA==","signatures":[{"sig":"MEUCIGYqG+wtnn2MFFLncr6hUJzTsZBvyPUiMEU6K5ddpsk6AiEAwtfpApV30SSqCnkzsAg4Ehbi8elR1qaKICh0W/WyKqk=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61137,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgXfH/CRA9TVsSAnZWagAAu3YP/jZMvDLJMMYVGDmj9KqP\ntgZ101/rQJPn5rNyU/EP9BsQTStTFPNF4EgcDW2h0uwUE7WC6BY2I6cOEEPY\nYyHYXLGfOzI/KGhWF6hto/oFi3iJwRaJu9PCme/iKw7S19fKtEpu+DLl5qbJ\n2vulHMr4nsSrgy5SthtEJS54b55LEmibLOBG9roVhW6jTml4WrXpw33LqLlg\n0FF3P07U+z6NUXlLsThShBnQeQRI0f7CdtZThVviLFSYHEZZmXbidxFx/orz\ne645ZUI0g1ldI/GQaXC8cD/HAjjVxXun7tMyfMdHLbN0fFaKDt389z1tfSYY\nPQXeGkWbLpqTR4MxuXkEPcOzTq5nSTUpmZmCSopxIA8fVYLA3NC5R3QVNDKC\n8nkdMX+kVboPj3y5m2e3Nc0ogRCspbV8D0SNuXtZBbp5wUpeJib2rxIpFQWY\nhLRECP2WAWzHYLU0HNR4DtTzD8wzeQLFqWPEUJpVOWfPM8oqMGZrRZOgSvQX\n1TgdWj2wgK8ASouGenD78AxdADo54yJUFNbQ9VxkYatPWvjY6CVsKLZCst12\nJ1Eo2O8B9Ilj6fj/gmT9IY6Q46yzqK2Tn4fuWltAN4ZdV3arT9C5tYxTs0Jw\n9mOAhRjyTZqIlbh+buZSZFfeQj0Tk1Pl0LLtFOwqDJSSHiW0lkqvsPXtENCP\nyWaH\r\n=Y4QV\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"30828c5195ef70d3e10dbbf23e5569ad2ea1168c","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.13.1-pre.2312"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.1-pre.2312_1616769534623_0.5544999948802618","host":"s3://npm-registry-packages"}},"0.13.1-pre.2323":{"name":"piral-pwa","version":"0.13.1-pre.2323","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.1-pre.2323","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"1bc8163e441322e8b5fef02bc0c449333f16f2d1","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.1-pre.2323.tgz","fileCount":40,"integrity":"sha512-XfGCP+4CqsdQgDUm82USKTJ/aZVo831dYwqKNCCm+sxYsvXAEopJswh+c9WsONpKI8uv+grdePljC0Z2qxOfMA==","signatures":[{"sig":"MEQCIBAmI/UkgPH8bfaHZvCmV1kiD8kd2vZSQLLKGca/aiQEAiA3TmQ/GRMoffLVAwidmrLNupuDrip2sb4i3n9yrusqBw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61144,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgYzLgCRA9TVsSAnZWagAApI4P/0VxgFtHlWtH0xvpN8ji\nzZshQ5wJ+AC8erOo7ECos7i2LhqWV3thIo3oqqV5/jiJfpjOeTnZSD3dWB1j\nt0k5j8ySZf7bvqrW6w+Rglf7kVvnDPM0gsfSCtJqwwhgh3NBvkSASKZcsD7I\n3fxjTBsX8MoqmrO/EQOeRhRpvM81LCOAPa0oE2K8ZX/mcYiQxUzg1rDe2NnE\nbgTHf4G67RXKh9tX5XpmN8eaKCtSWd0/lrtB3yOYg3TDy/ivA5fRJ2H8cEHQ\n1WGWlDBl1NBMcPa8b0cwMNLBfHk2uZAVlhvPs81ZTEUHHteqnzfpRbLoyheO\nHx0l4agXs/LrTOuuo98cQ8nW9gEc43mlj4PDghWg1uLIy/UW6YNm5dEfTdv9\nZgZf7fdrWmY4gfmKisgGXDwTKOk0n2cfMBWCivDrVZ9bwwaI6JsAd0ARt9+Y\n5PG3/cKhIh6xbTxJdunK22g/BYyx7/n+nsxlzgDuayz10jd6XdlQ1LGoaZJ1\nILIiqnPClhBH72+e309lJ81VdQjQr7K5/1gX6THtG+LzaVqc8f/DzZAZ792S\nMDOj4zo6y+aWz2Gowp289yjyoNa1KXdUbz3jVhFWmKfaTMPiBNcpjPjv5juz\nqdpmY8uDj9ibyEFao069QbZlAQA5ZRL7sZXSAnbvJth+8rE3dlQ0mYblGJds\n3vEw\r\n=ow0p\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"9a196b66a29c4fd0ba09fd95382d7340550443cd","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.13.1-pre.2323"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.1-pre.2323_1617113823827_0.16957318771403096","host":"s3://npm-registry-packages"}},"0.13.1-pre.2326":{"name":"piral-pwa","version":"0.13.1-pre.2326","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.1-pre.2326","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"0fb481c042a71d6ac3e5589da7640df39a239e31","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.1-pre.2326.tgz","fileCount":40,"integrity":"sha512-es7kgeIChwTbe8H4pIY6dPsWuSUISI8UqQBr5Yyxf8ut0ml/RDzyKCqzhaC//XPlmNoR1/CI4PLSJgUPzR0Gbw==","signatures":[{"sig":"MEQCIHbQpaahfU0sPqJ3XRZdvqEQhuGogdc2CHT4gn+wTLzeAiAtl/EQ7lXwFY/oc2IJcZdboFEiCf56w733NSuwMsxfGw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61144,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgZFZsCRA9TVsSAnZWagAAZBcP/ipoxEqgfA42Sko0TUNt\nIwf3K1UsJyOTQZyjTmlIaXEimtgxDyzQBM6Xf5SwqOufYAAF24gtvFGhhXW9\nhoeJSR9PZeJf/5i2gI2LUJPhq00dGPgZjWMy4kFBWycm/rQGe4PhNVumgrWi\nty2k/f/F0riW4r5kqoMkOJGp6wwVHaq0/EXYL0HYomxKeiqV0HsdmJYa/ah9\nYj6E9jj9qZn1kFJkp/66q0+OmMpff6gII4P7tPWrP49U45vVHxbAJKc5/l5o\n+dGk5vhkkzR3JVgKE7TDHaQYbc1D5FSfhm+t3cZ83z2d3KxDyqyzgL9Z0JPu\noTzo8Xc90OnSKKz0qh2pyJl0W10U5vqIYFqq/ZVZ3b25dK/mXXFpd1sW93SA\nC4XVDosiV3c2NZ182jnoYpkzpsMNyGlsnW0Dh4CzzuOo/KDgXbxyjd3mdVYQ\nxv/QWOvBoFhqgIxB6LwO4p767tTrqRfJUOzqcusArzyG8wHZsfgnJLINhy3t\nfoiCyo9C3GM9PwyD7sX9vGVamq0Y356w1PvQNU5SatazvJrxvEVg2Nk0hq6+\nt3FcJGIkzZPDbBc3Fiiom5UdWuGMuqtCAW+LAWSBwdcK9vApUFXr1oqy6OPE\n02B15XC8zjyMdx1CBFEJ3BinIiLhUakvFTHRpW8oEzEyx2tqstE2x44B8VpO\n120z\r\n=Uw5G\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"ea0e572e5985084152c4ce824ae3102ed1ba6731","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.13.1-pre.2326"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.1-pre.2326_1617188458568_0.7016183132765776","host":"s3://npm-registry-packages"}},"0.13.1-pre.2329":{"name":"piral-pwa","version":"0.13.1-pre.2329","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.1-pre.2329","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"6775778e5c102e6157bf3ae3eb1f9764c581e698","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.1-pre.2329.tgz","fileCount":40,"integrity":"sha512-Nr8ZnIEHCOI4Y7P44rt7UWAw13IQwyZG1hESlP26YBuKf5xsPHOdtaI3be4OtxhPAIxNhkjZtA/s6CcDKItZYg==","signatures":[{"sig":"MEYCIQCfbvX3o9jgBJSCOXU/VbfjE82diYmeaIAF2RRfs4ObsgIhAOV794jPATDeJy1nNRY2MysbT6V2g62zGHvysINLjzZB","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61144,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgc4qECRA9TVsSAnZWagAARBMP/39FUJ42EjPmhyzJceEG\nRSffTGqrNWgwGwxLtpblerrqUnbkM8OBCSCPyT4or74nDBAqip+cLbJSf4Fk\nsxUuVc28m3vXQPq8eDpiAjapvhPx4+TVbCxSjVLtNuMhUrZ/4CWxn96Y9uEh\n8kangHbeJjekHWnwAgsng/CdDDluStoMbqrbDqx+W1c6Na8xZ6solLvs52rj\nRnHxnCj9pME0NaIn6UrcCPO+/TB/IzI8fcrY2tZf8R7dYcMmVdvRn3LxeRYe\nkd4ltIf7g5pMtKAKFrKGduE8zbPGDyf9L4zyAuaaDugiGgi7dD86bPnUh4jU\nUtAyMhSwj/Fw///Ags/Bwj41QDi3cFuF8ipBSg5FRim0xmS9ng5l1xZ/K1KJ\nJGo/Ms9Ze7lI20GRHGTbLTMFOxCzAmFUV0aJsIC66gXOqYC5ZDa4x67CuBnn\njt6GYcAR1DhZJnRwdOl4w3HuQPNTnP5I7qBe1EOLJ4A6IFbrHYlmkdbTUmjx\nDTDihQVZocqS6VfDc1BBGXvffcMAFT3cB4l2IeQfCw5JUL9q0UEteLUqtlEP\nM0+rcseHCQes7uJxFRfyC2aLQD4u5Tq6BBhqrMTZapbotBe94w/6jVBYb3oL\neKQ3T6gijg2LqhSn5673yEenihrWiFpw7cVGQ/yHvuue7PKzmspo0wM1yBzK\n0Yjp\r\n=j/Z1\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"483fe6bcf7f522fd2d423d4d4aff680cac16cd46","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.13.1-pre.2329"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.1-pre.2329_1618184835981_0.5096235254511674","host":"s3://npm-registry-packages"}},"0.13.1-pre.2330":{"name":"piral-pwa","version":"0.13.1-pre.2330","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.1-pre.2330","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"71dbc2d6816ddb4fb240079d8e8b2dacf8bcfafd","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.1-pre.2330.tgz","fileCount":40,"integrity":"sha512-+n4SBkeMkhUtsV+rmjmF2OsCqac9nKnXkPwKErnIZTbxIAqjEpZ4vh3sLeR7B7k9NmXplmEG7BFXvkfDvsyjKg==","signatures":[{"sig":"MEYCIQCmv4X0ItZlBiQ3x52WYSTRtuGoZDKJCEIZMTDzzx2gGQIhAKzKA2t2qLP7UOGa4CXbb1cpkpoPv87iGkCimXnfHBP1","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61144,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgdEUSCRA9TVsSAnZWagAAnfsP/A1THeGOt25EFPHj/Mdc\nYK4838nOImFTYAGUrsviyccvXpYsl+n+D06+Y8KQWbxmNzqC3AC2G2edCeBq\naMaUVQ9bXpyLJE0OkrhvOsQz09eAFWTNwqYR6HSSmmRCqfjBbSK7y2S13ZQ4\nM+wuCWVEXZA/Ol4mZ3FXE627njEAurSBauCIfiamMocY7YTaob5V3MvW2VI3\nvxo/8QJdR5s/E6dAiFnkq85SMl+CtnhxbCIlDUb+4vca+1J9oG4bjOVP0BDe\n07VAJiAJl8JjJOYmppMm19Os5MBTnvZC4XWoR8vUNflUpahqfSAkJjKcOhls\nMLyGNJNUInsXqD7xFiyxDp+aiDu95laOPUVFv5iAyr7eXWDGtwcJwOUd2mgU\ntrYOAznidQWAqSUnQN7ILZuKNg0azJEm9T3bkbCvaT4ZzKT9nJ3gbQbPk9BO\n9/4MULZ2M8Ucf/wCi3FPlJmd5O4jvNj1IufC8ZId1LhSFqIIsbMNy8bd5jN5\n4aMWh8hT6vCln6CwD446mfJGL5PXEGWyW2ads3gK3rJMwTtYXhyyT2ROcqNH\nYdl7W3AJZ/0gJlaFnN8NCADzboyw9TYU6RxEiODAxgazZMwds+ATjfpnIptv\nYW2Ydp9yJIWVnudnR+6j2aaFj3RPzfKTA/V54WCdqbKYG4DHd10QpxB3JhPz\nHYtp\r\n=fvo/\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"89b2928224f69d0cc534f02f3a9d2d8ffb5d9245","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.13.1-pre.2330"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.1-pre.2330_1618232594005_0.20055476739611722","host":"s3://npm-registry-packages"}},"0.13.1-pre.2336":{"name":"piral-pwa","version":"0.13.1-pre.2336","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.1-pre.2336","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"40344265bec7c9aba656bc0549814f98b0969425","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.1-pre.2336.tgz","fileCount":40,"integrity":"sha512-gxrt5lsrupVUvdJA1LGWN1bHyVKucTYMnNBZaI4RtdSCdCz37LXgbIoVE7l0h3rMkeJa2NkLQBGNHHpB32mmyA==","signatures":[{"sig":"MEUCIESAC3NHOG0FxQmakiiySJWzGW+VFczC2a8wu1ZLMbUGAiEA1KpcTuYHHRq0Y0Gwxgu31n7FDhrr4YMvawBWDnLndsc=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61144,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgdbYmCRA9TVsSAnZWagAAyzkP/jggb/1IH+a2/kcOGv9d\nOkKiHzk5fg8AhqzYu8K3w6dk8QaMXTDrrI8yMIkOHjAcMIEQDmJ6D+Kx9UnW\n6EQe5+76WY3/I0pckmW72ADstpMgS2e3mrrSdXFI8qsQCpKBfXT8ClN7qAwO\nidT1e0AOUBaIIlkXK7xucuEnXgiLRQlGhM1SDkCZKMuFSBsy9inA6MnAJ11Y\nZZww3mPFN5jyXzDVYskluL5mCv1XW2eaQ95TsMmGpRduXnWV1NIAyYJ4Mwoq\nkU7tdX3ry/klVQjMvCsBN/bDcMEjDxzVYunDK7qZtMzusMXiXBvYPUdEc3Vn\noWeQkCIlpwKlNqYZ/Kizg4jX8cihJoOpAETYqfQV1fYSbiVipn7DPg0S7yiD\nNM9AmaR9NohdOdMobC+z9rFdap2eDJ4hLW055V82+JoKKxYy2M2T0JzZ0Rut\nK4zBzgpCdQ4GYvN3HR9997K2FJmnz/OjCoffBI+8iLw0/kci7sTZFh/IT35+\n+CoGCKMoLLMUxg+njJyKu+W76ja61htUgpqbohVMixnwW/QWqqIZTa8qT/dX\n/PUTHCggVHaG+uVJxldNed8GsSwDAkL0naniwwY28B6bgO619C0MEJIEtKsM\nakcPSk3doAKYem2XET9DkDX2QDalniehj08QSM/E00TxCCYNTd2KfCjgJHHR\nPAoh\r\n=qGOe\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"fedc0f2d9c1cbcb9fb70cb4e356b639fd4983ec1","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.13.1-pre.2336"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.1-pre.2336_1618327077658_0.6844172017321641","host":"s3://npm-registry-packages"}},"0.13.1":{"name":"piral-pwa","version":"0.13.1","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.1","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"4a5f22232926d512f42aa04f0eae4622b264f90d","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.1.tgz","fileCount":40,"integrity":"sha512-/Fp+7zK9QFrZIx4OgKcOCUAeFb0WGOJYcH6JzY3zMj0tfsf8VMIYfVIdntr+Q10YkdBr2YHEiX5PUzGcFQjcRA==","signatures":[{"sig":"MEYCIQDNe0sJEXl8cBA9OlguUNsIXmGWa9bu8EoF+aY1pPB01wIhAKGmizA56dt03p0HlzCcA1IGXaUY2wW455qvF5MS5h7o","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61126,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgdcZACRA9TVsSAnZWagAAcHQP/icBA2QlAFZLseu09vFF\nzPNe5cpLfIGZMaFDjfXeSqKCblsKp7Y5oJsTuAQDggWcVng4vImT9ZyoGgGX\nCzCgvBTJL1Ycv3vTGQPmJ9T09wKGQCDdch89XcpOEB/ohmCxt5V88ARroMb1\nrITzGVgEysTzm09UKOfATXXW7/LwOY+n/vvhT76o2bpoTMFgD64KeL+hqiqL\n5v/TQZiBtmnThOFCtcV5rJ76ImLooeSrbJbhpEi6NZKJQxkW55piKB8h+u9V\niX64YUxAU2pmTGQrIjIZ5FCY3eVW07roLG0MHxVyl2ITnRa4nUtwb9cjSvkk\nUqn/ZTsr/iFYehZxkorehz1RQwtxX9fYqEbN52pYVxKdNhquo2wyYUwjyLpE\nx9WkBEosLnUFvA27PKI3GfvNXcrxXY6LYTTBOgWfS2NoZ2ux67TJ20vrSetG\n+Oynyv0b0DJzSon5Oxfc9cr/4YBEeTPbsb6CC3eZwpVBd1pdVkdco5jNFzm6\nj2a9Ap6raqrHMjIJuaaEjxkh3uolr1bN3l3KNaiZ64lhdB9tjTyrEE8uZOkj\nIgs6xzPoFX2PGGG/WII/s2hYmcnn8PfNmZX5GXQqvyeYuomqOwSygrR5bagl\nvU4r77rlBdhjxkxGwAV63edt3tiBZVkCEVx75qFEe1lkJh6sj5YXl63b4SOu\n88AE\r\n=dP4v\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","gitHead":"15662b1ed58b606a41f5fd59699720acc347ce7e","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.13.1"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.1_1618331200195_0.9416264626238464","host":"s3://npm-registry-packages"}},"0.13.2-pre.2341":{"name":"piral-pwa","version":"0.13.2-pre.2341","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.2-pre.2341","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"d927f173aee0c45a8c44731e8cc8a6b91e395d16","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.2-pre.2341.tgz","fileCount":40,"integrity":"sha512-gD8I5QHew9Sp3LuZZAAjRW9IunnUkyD2G4CxapADvzJWqesrVmOJfp8ks/IoNkOPz0Eb/JByuNhdPJ5kMswKbw==","signatures":[{"sig":"MEQCIHDZi4fg4KqVrLHYxux3lLf7RKQyLoff3juaivyJGls8AiB+ZLNwFPZPT5nkhAt7Lcdtggdf/grHVjeyl7rEtMkf6g==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61144,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgdh5kCRA9TVsSAnZWagAALPcQAIQNmVpMMgfzskyiux5U\nV+n8a5aGx01LA5KL7PPnm9wSYxqrxlZ9Nj1USD6lpnQKFAaYDb+T7U1VdbJp\nGfNiyI2+8nOjOA7tlyjuEiE2xQwr5AHUimLXo2DIA44rxxO1FEvvUyE2nA/V\nS91KC7EgYnQUHbkyuOjLuqaWL7gdaNOgKHzce+oAmMlwm3qd47KhNKUsag/P\n9BF+glQPkhKc/7XLegNMsXB/OQbaclwYrBWfpu27dfzmSqoIZviOxdEEed9O\nyYhC6tZIzsCMq6Tz2OCa2e6WM8/Bkd7KBhRRCuvR57hI/IT2XNtIChV6/wCv\naNWK0EHNaHM1O2WKQieKQS2qD/PDFIFmKgcM4GsqVNNBYaFdAbg/XD9WYZTA\nbM0CxhmWYqxlBmmZbLAjEOU2GGvBKz4cGQUriC1C7LYlv+EFTLUvda9vjy6I\nNlVxdUeS/MHRDVeif8NeZcXURZAU1HSl3KdXjJDr2QvPJiDE8ldNSmrwbrA6\n15fqce5uasINdMayVVtPqEjD+JsSNTIbY9mF+APb3qTvINz8EGBG0XZTnCNU\nj/GwHDlpdsGepZaok483Q/n5hOllcbf3k6V0wXdQRCfHueLsVZs+uABE9VNa\nWDnCDQd/c447EOTD4BvGmeQ80AOTtpuXCc9JzuNYg1VAYAcJnwy1ghK/4DZR\nXC3V\r\n=BKOk\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"e049aa0620536d97bb88536f3e3bac233d03ae40","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.13.2-pre.2341"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.2-pre.2341_1618353764133_0.41871548209845044","host":"s3://npm-registry-packages"}},"0.13.2-pre.2352":{"name":"piral-pwa","version":"0.13.2-pre.2352","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.2-pre.2352","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"0aa0bd4d798051f341c22d771432aff6619b4db7","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.2-pre.2352.tgz","fileCount":40,"integrity":"sha512-/kQalNsIwsHzh9t1iwiX47ECa8SfBHUu+9vnXoTUXytGLE7orUP9epWlVoJ4cJhedLKM5xOh6s5vUE5mLDVwjw==","signatures":[{"sig":"MEYCIQCz2YuiS71jcXxVeEmZSEZ6SlltqDmxiMNjVITM++EUdwIhAPdAtOSn1w5TRo6eq2LlM4XRJ5jTVMT/hX/nh1i7dcpI","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61144,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgeF4oCRA9TVsSAnZWagAA3wQP/1PM6A2Vzy+CfqLpBKPI\n5CQj9o5YiVwgXKhY1F9dLubLeZdFsLAWbB6oF0BlB8Ecdab4Bz7z2PrWc9I2\nfGTnFXnSOYedfSTwdfpxTRueGvkWill9bc8XoFLwyOdegBTMQHZZEsCHTFj2\ndZTRvHEi6zN+NLrG7vp05tjkLSKhiP/vOnP0vzjDxrbo2e9oL9zSEgBKQuqE\nZ3P0fGDwHm/0LIvMH++NgOxgLjnNPIbY5Sh4+5m+R9IC+kDx7Kj2VUKVquWM\nlhskEi9obwuE3WzhinCmoe99OWIqMT/VHi9nVwgUtkc0nVor78PJ7SJgtnw6\nq8Zk17zMmY1KMI/69ZXu7pnS9o0kbtj5csTRGOuN8XAiX98OQeE2K2PweAXs\nfOm0IG1O9TxamwSS7jWPWYXWidLLhruZZSh4E3VX922pXNkRoSHykTAbGevr\nZU33w4xtmLfhv2w4Ewlu3/SGZQjLQJmc6g5ZI1BvD+hjulfalDe+tiT9sCUh\n+96hyD8ckALjhCDIOToffBzBrTJ4lLmJtgEWHj93hPl7LaVGMff0OBZ1hhjF\nrWH0mLrnvPlHrdBIv5dVg1R2PZqupdspasJQ80UfYOrvIIUyOEi9yrEEkQdb\nc2oZBwRDQk97c/CJAUZg94rGU+ekqKp4pDmh51U32sY2Ikpxh/AGEIwAVj2r\na53D\r\n=vQRU\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"a24affb07e9d190d9a876258e451908b7763d4c0","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.13.2-pre.2352"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.2-pre.2352_1618501160294_0.9771590080272916","host":"s3://npm-registry-packages"}},"0.13.2-pre.2364":{"name":"piral-pwa","version":"0.13.2-pre.2364","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.2-pre.2364","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"d77f88f185cbefa0d33d40c9a998215e11beaaff","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.2-pre.2364.tgz","fileCount":40,"integrity":"sha512-YvWXuMVLtaCPSpwdVv4xUr3KUGpr5PV9GJxBOzTAoHB/l2S+bwhdDpcVOj85aYqOx8hFWWneH25VgkfWmqZIkQ==","signatures":[{"sig":"MEQCIEKja0SIqFVAv83j1nYWegGlPS3M2OqkpX0JaSGleoAMAiBze6kMEmYvsl6RG/KCY1kaUD9g3P9gxFe+bUYGwFDcgg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61144,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgefLJCRA9TVsSAnZWagAAxkYP/jQCFpnfhJF1Xfo1eaUL\nrLA6v3TE3xu8ztMYq35X0FgstDBFH2l3Ot9lKDCHpMEwfqTkKBQrw9Rs6xzr\nUl4mXXHa79vcn75230Njfmmqh7UbpMe+sDw/oXLWJRC7Y8T3qVunITeA/TTQ\nI7pYt7wf9Azv9RnIktLQF6ZEKfHCUDatXDqnIYNLEmv9bVnVWfPqEuhLt968\n0N7Oym73eHc9YHI+PRwU7BK/eMvuwQHHsjTljPelQc1C5BERUOJb2ywzGzC7\nfQWOTRurz2Nbrx2Zyh4Xgb+qxx3CfqLYOnPHRajWLvRl6CUL8PklIX8YbdYd\nQ3Hh7BaM0jvD4969z272pUqTAHV3UshmMcy84NVBXblFEzI6afBPvYA2eBm5\nImNxtKg5nkoJU0XMMurbC7wz5ezYAhb3rxNS8xuqC19VK88gNdfDl8JyCQyZ\ncVACLA08Rpi+jIVthn+VNnuvM2d+z0F2nLQw/UgXs4RW+7dojTiOe+Wmj7Ja\nm4fBsMeCrRazYyF5b5fI7d9fvk1AAroJn3Oui8BaMKuwgZThXWfDszdAIvLv\nCwsRGUs1X4VorFIyK5yXnm3ouGmxrWIgAWke5/a6K1SNvECrVQV5JB8WTQgR\n05oJg6benMMnt9ZAuLxFuDft7jgPSXCxZJiq3yf4W4wE0JnhhmxkhTX8OpQs\naZHq\r\n=OFst\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"77ba433aec0e8ced646267d90ffa2bf7a64c4041","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.13.2-pre.2364"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.2-pre.2364_1618604744914_0.6423953064352808","host":"s3://npm-registry-packages"}},"0.13.2-pre.2383":{"name":"piral-pwa","version":"0.13.2-pre.2383","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.2-pre.2383","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"4625ef75de8542b099dc11cf4bf6ea6dc3ff6b4e","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.2-pre.2383.tgz","fileCount":40,"integrity":"sha512-5RcYqRoRVSc3mWetRqoWuZ1qCWWycocmPdagQOmwh7Inev5TL4/tpgnIAjeOkaH2pljAcXQv4j9SeQvCJdYoaQ==","signatures":[{"sig":"MEQCICosBr7HrgWXUozKcTQRhbPNyQXEUkHgQAjUEQKOHxl1AiA0Dcdf9KThx/gsKmay5+VFvbHE0g1jY7iBaP9FK1/DgA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61144,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgftVVCRA9TVsSAnZWagAABh4P/0wPd9/iIqs/YKFWnI79\n9fabZVCzTnvWhg1GHgLbibHDdo2MBLftusjR5vUTGmuG7G9zRHyag9l30yxp\nAZDei2o1hyyRJpYjs2bxBLm/6Vb/hAPBoPR/muqOEg1Z8HHOJEQIRthDaujC\nHf6FRnMvsB/GH/P6S3KcPsLp9h8pLX9ip5LpYDNfdtUVcpN0dDiAxw4rzyU4\niKCfhWp8Wu4kF7DxAabyi357hEf+aHuDs/DSQ+2N1QpphRBWW2k3YHh1MwGm\naTtn0blSvhxUFK1lyz4yfJDkkze3+SEtaxznW8wVjBH1LTIr8+92TdXeqyud\n7vqc3xt29neYdqfRMIS62cGIhtKvDojhmeH3YLVyB08ig86qJKWeuTKvHIZl\nwzKJSbAWezn0c1YVZkm3gtNW6tknRMUWYw5WezNDhJHJMxLLna41JVa6rvZ+\nJoZ3DEmjf8z6VnjqCefN77g0fX6CvqSckRN/dKgm+heifzTc0p09/CtiSu0g\nAneLrTDdvOS9uMKjRzul2GJ7Skzi0Sw4++E2KI4pqDNYA/6O5XLEfkpeOb54\nXdMVonz4jphW6Li8/wupVtvIqZa3qL8bghisaA+SmKpWRltY3bacwcuETgMV\ngL6BUrUgqxQyn00hu12ENUZpaLVUKuQOy2KPB8tKiTAK4fiVibikPpvgCPWg\nkj+r\r\n=iVap\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"0867b27ba96060520f946a4ac0155e569b64c151","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.13.2-pre.2383"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.2-pre.2383_1618924884514_0.4507374846463097","host":"s3://npm-registry-packages"}},"0.13.2-pre.2387":{"name":"piral-pwa","version":"0.13.2-pre.2387","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.2-pre.2387","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"8ab41a65144391077edb82b2cd25616ecca0b3bd","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.2-pre.2387.tgz","fileCount":40,"integrity":"sha512-teju8puY/CQO0xZ04/UMB67jelQzyd1macM931oIGwZq2vsCEb6+c7w67YaB+cNCS1PeXE9qH5Q2XQBYEDaLTw==","signatures":[{"sig":"MEUCIEMlLc7B5IRAjVFIsjvRKa2hnlH9+FwodWKLUxE3tSCUAiEA0JImTJLyBQxCbSaEdTvXhNifqKc0L9A7X++yQ3MQjaw=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61144,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJggf8gCRA9TVsSAnZWagAAmHcP/RKhvVilbmvAkDR1fL2T\nce0YmhJmfqyY89MxdIhUSHmqZQmzELytjSvlp/A5kDeVkF3GOdY4zw/vWfvt\nwviD7ZaoL8vJrcXMVfLBRx/MlYcqkv6qKTIPzIOzzIEUAP2As4JIkLw01vgG\nzmmNi4R8uwAXqvyggcsByXSq9QME0vo1ClA37hC9JX9CdLk5ZUEPEniYEuzd\n3/XCCpl/WDmYJQndB0INGXj0g/NUGEDExj8UCqS711KgR5L/Zqtl4fMHVFsL\n4BOfIFZItyhordIYL0x3sun9KWwAxosXZ59ZiESp/kkV/TkngdU3OGVKTpTe\ndeK+Tqkwj5wtX/fY2oIALfPMbgo1ari220fUo7HT/C72xOa4KWe9SYSdbT9a\n3ds6U14dKWZt47nH/QULlQDX9beVLqn6qmJG8kwurpTw6sqb5elJzK1yelIF\nFYJSn3E3zG5vowbwFkFG2ZkvEPz41Is6cbMWGLy+IOmUN6dDmYf826qmrvOE\noy+TfFw1iylNhpZZmzgEiO8FbfztX7hK7RokRxvlDGXcXgcM3fERU1J/0jZM\nvV/OtqtS2LnJn9vDL5hcysXF2DJVkKyQ/XB0dKCM3uPLGgBeECHuN4rAk8gU\nVhQPwxtvtKmFrU0ItBAd8xRGvJnn4uOcAhOLJ2Ce9toOiE5fYHrU3UltDCr9\nfdaB\r\n=mqIZ\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"4647051168368325b28f995586bf49659b86efa3","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.13.2-pre.2387"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.2-pre.2387_1619132192094_0.24936425794453188","host":"s3://npm-registry-packages"}},"0.13.2":{"name":"piral-pwa","version":"0.13.2","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.2","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"46b078548c5c3b5c995cd2a35c37b5f4334653e8","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.2.tgz","fileCount":40,"integrity":"sha512-tQA5IwbaHVvq5w5sl9PBP66Dc45qB6rjDU5Bj4QqtnGdetYa+0GPLsUWAK7j1u7a1sgAAJzSpzmXGDVJ6e2pqA==","signatures":[{"sig":"MEYCIQDBabmBHF5BKac4TKXP/4TJ9bph09+20NSIWkRsdhxT+wIhALhKZo87HqPHVDc6N+r7Zb7ZN0gIW5DozGZRx5rgSpXW","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61126,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgiDlMCRA9TVsSAnZWagAAuVMP/0huKkmYcCIorMmJnDWZ\noblAXm5I0wNqgrr8e4cD3DEBsa9cKdG0SzvW8S3dJlPI0fLEmu1XQPLX6BLn\n5uws7FF02vge6od3GOiH2hiU6GVBNu1cj0d7v1/2n7Y66QYdohZjeeeebTk6\nhmo7PYimhMuO1Pmiupw2y9zbUvuhAFNbaVur8xO3SMuQK1phKQh5uVXwgnFL\nkBQ0ZLnYb+NjgjyLnIa5s2MLYpjyhqoAm8efG9/IXBPivL69fA+duw6P11A/\nkjnWdomAtgYNKZ+UowBgzeE9SIwCrJ5gn86Eq0x0MQgoDSbUchgOpkynUI7B\nBLS0rKbHkmUf4YPGAuEkNgxdm5c2IGaHcfdWeW2ZaWf/Fx35rJImrUwL8DHQ\nnC8iw1jSj7MpN4eGuFAfUOo5EcuOxHFktTISYew9a1sG+NZb6MG3Xlo2hNPd\ncsAgXGJ0D9mlNKJB2kkBNSEKK04XK0IPxp7czKaCS1F/0c90OWVxeviNjwrz\n0feGdiPHwJQNpVY3Y+hwDe5uYI9uRmi5WamXIWg4M42BH7U4xH0ehBIgMB+U\nnBLpTM7QJ2lQTha6dv3me2M91OQj35xRdUnL0Mg+NxhJjHilGt68Je6oBStX\n6XNyagqSHFLv9nt7/73UE6KoOF4+rPSZrOTFCBX1UJY6BTfBrUTSu6u2Inek\nDgVE\r\n=r+Uk\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","gitHead":"4326e3f73451063ee3b531c4372a59c72e73b1bb","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.13.2"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.2_1619540299571_0.5330378631728756","host":"s3://npm-registry-packages"}},"0.13.3-pre.2417":{"name":"piral-pwa","version":"0.13.3-pre.2417","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.3-pre.2417","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"bed76dd9e6bb080ca39d8988b987f6051dbaccc0","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.3-pre.2417.tgz","fileCount":40,"integrity":"sha512-LvW7BXYDJTBfz2xl/6Ca9uqCU9/MUllqhed4aTdApugOeg1BPQftsF7qrb7+IpyW2rdc/5ABazRlpLc7TSUAYw==","signatures":[{"sig":"MEUCIQDUwnQAZ97NkNZewKWSuOP740CUyYZ0mOaCvUc4WySkGgIgKUnQslpdV9jFQA0DWtZFATcYkfB3jAECgHExMKM8oLs=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61144,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgkRWICRA9TVsSAnZWagAAYKAQAIIcvS1HqF9a08qSRAJ+\nfunGymexb1XDh/VtzKuoCWwnJWqv3807VYESoY7a4T2VWuf73k2DxpuyZxSt\nrCN4EkvkI/Fxj5mEecxl8ZxPs1dIJMo/N/xRIfVjHdt95eh5zmdJ00ibOIxY\n9F8H+n9mZRlyKVYEX30RWJIOfDV+jwhzVuqeQRh2lo4sltVdo1CYpJA4s4V7\nq/6SBD6QUZ26vMKrL3KDqYlGXZ7ixI0kH0fMx9fsaqKEFXHo/M2yyRMl2rC9\nbErChCU9xPRr/pKC5VtIdKmte24KaNFPF2p+TqBDEawW2RcIathrDf51MTNP\nTH3qqbsSJzJ5Mpd8xDTBVKT2rCGqN6Lh3zV5u7D6IvIF/Ji7YdHQsb7E7Sam\n0e/jgz3DI5D5hZJAqzkaaJJyiT5qJdclb4C7YBZqpNMBzUHi1Pg+TW0FekD7\n8eMVIZgcIXcqu4jvONbZtrX4+SSC+THMBwXfE4lww4JrK+Q8t8ThtqkhQ67c\nJi6IpDBt7Ux8owC0glADku1bf4m7BoMvUbrgqS21LtGMCuDeTWGGYySEY3kD\nGCsocklCYK5b1eJScUZhMczGS2ZlesoqQeGcEDrGfVqgiRxkTWfe66Dgjk1M\nwTyCcHz41tdatzSz+kSAJA7Z/8azJ0DGDreQAzK28Ra4MI1YvQ4lZ71AD7pZ\nOwMC\r\n=rxyi\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"17fb2d8b6b9ce724a71636cc1521af928a3ba279","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.13.3-pre.2417"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.3-pre.2417_1620120968438_0.3413042819297838","host":"s3://npm-registry-packages"}},"0.13.3-pre.2419":{"name":"piral-pwa","version":"0.13.3-pre.2419","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.3-pre.2419","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"a96adcd2b68466439f82d91769339780ff700d9e","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.3-pre.2419.tgz","fileCount":40,"integrity":"sha512-PAlgbfBbTmHXVhiQshrbR/4HmcyKkO4hhlzR1NB8wmSFS87gOYFzm5/6ry9N5WstCCPG2PK2OJAwBE7DZPnL9A==","signatures":[{"sig":"MEQCIGFvMSgpG6FIt8VFr08cpBsXP/SVYFKammJhQFzvch26AiByUNGkD53/4kmCXmSxMCIPf01YivzBy59OHhmynyNyig==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61144,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgkSniCRA9TVsSAnZWagAAc1wQAKE54XjWt3inD2D9A+LK\nuJ5h90Bp+8BY6KbzGJAKStoEh/mVoxeSs64XpdWy6bQOs3KcbWCfQbzB6oJO\ndwwVMrMrMQv1R9x47dZ/uj1+bt313wVuYwimHVCw3xy2iSB0X/82zyJRp806\nNowVLLyszPczQKO+TFu0rEpPSJRIGq++ov3o79tXYkyAIz/jyVV53teJ+VFZ\nQF56Oc3LSHzIGQFI7axJaf+t9wRB0MjF9+fuCp08wBByUBTgqjvTDhTiPokx\nOMxIcNeG4IA2sILXmnybCdR82AXJrYQfi+KyJ5oteKhSQQQnkeln5vOiQh1r\n0VxDzMzJT/tHBEONsCaJW0V6lhQxxF98e5mQSHWfRnGgqyU7Iu5Eeisheykb\n7eXiSnsg5N2m/MHd+CjyNXxdyx2uwy+s4Ja4xtXPNPbu1WUuKbPGhbvxAevB\n+delyZoZDm2tixqFSESpb9Ps6peHq5oAGuDdJEGs7P0cx3E0lBfT2/EsfZ4F\ngDIQyApam9ZssXEM4NT+2sSq9nMZ5ljzSWc9HT2Pv9FzYAnGOLdS/StOdnQn\n4k6Nh39TdFYLBHABe1eM4WZhVywN5N1ehrJawGd70qFSFEvmehWwWi6XhpOA\nPQxCntdoMIrmFouSiw117n5e8UYp2KJ25+GoHl9MTtXIWot2Oa/Y1gTrCsX6\naF/3\r\n=RCJm\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"8aac729bb51da8426a373d5e22f2e857860ba7bb","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.13.3-pre.2419"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.3-pre.2419_1620126178091_0.3562178025620617","host":"s3://npm-registry-packages"}},"0.13.3-pre.2433":{"name":"piral-pwa","version":"0.13.3-pre.2433","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.3-pre.2433","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"480a00649b18880aee13108d2f1939b8ee095cf5","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.3-pre.2433.tgz","fileCount":40,"integrity":"sha512-eZhPOb86ebFF8AhoHLpTYMV69ppSYs0wF4JQkvN73zfTDPs6rsb4ZmP9Lwpx4Q+Dr791e8D7q0N3lROEfWjk8g==","signatures":[{"sig":"MEUCIGGe/bybXE95Lmlgr+OLpSenBsKCUwn9BABt/7M3Z7BLAiEAjLTUz8xdo2Pbyj8rzXJJro8E0ciJPPZdSFEOyZuqdrk=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61144,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgkxHLCRA9TVsSAnZWagAARhEP/RqgtpqMZpHM5nHOdl7W\nlRanR4JUFWozhCol39B3Iegwx9olcLvbcSSd3wqxsyUdrshn8SKWF/ld/2GP\n+r196sOnGy57eYKY2dyDEr+AcOYIheeyBtfhVsY4YupmC172huNWfC5Kc+8e\nhmNZXf4HB3Z3SjyE6AoKYaV02uy0W05hqCDOw8AZG18iJiVgoOWEPC9nwWc6\nvGeyhNEu3W4BsEEsolE3Zca1uHmcIRieJrmPelxK7b/6l3Ct7mFPmL6RKNtl\nb8xyEgrHFBD55ioM43k/5wVJzwb9ZPIv3Vs84/e4HZq7EkAvOT97GI2hZvs9\njvAp2W75i3IybQ9SaGiPqhcd/V7Tpdf9ik40xhMCekBFW41o6UI4doX+h/Uk\nRTvdvJgUSoGTz6/p3qzaQUeerN/INyIHiVbtBqiRvUBt3cj/OzQ7kvldFknv\ngHEFB+dviTSUwUYUzmBFDQ3IzzkVgOVs+LneuwkxK5q9Fdgcjc00RMTQa1Gx\nJeziMXML1gniY2pCJlEr/IUVpQV8EwN18/sskxJKYaCTWxEvXiLF/FeEcg9E\nLuFrHY8EgoZcMQpTPzsXiJ/a/zmtiMRbUMUkUZEN050UAo+qvtBGZSDQQui2\naEouTIYNOUCZJAdBwe94JJlmgCsSw2t/N7PnX0Nn0zRCAjMdoFw0yO1q4Pvd\niHCF\r\n=Vu7Y\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"9007f25b9a69f1752c700b6d57d0757631ecc2e6","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.13.3-pre.2433"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.3-pre.2433_1620251082590_0.021468982370304257","host":"s3://npm-registry-packages"}},"0.13.3-pre.2435":{"name":"piral-pwa","version":"0.13.3-pre.2435","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.3-pre.2435","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"89af4295ecdf5913c6c96929b419dba7c87cbae2","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.3-pre.2435.tgz","fileCount":40,"integrity":"sha512-jPdA4+AcOFpiNKCl3bTbJVP460yKyQamyPmh5Cp3W5WsjtQgThtdlcL6VuB/1qsYQA1XhO9XZfUJTGiYBeArAA==","signatures":[{"sig":"MEUCIEXZGw7Omfo3Nz4E46LDqps8zGfPzbWCctuoPDHZxbTwAiEApNG/w1eXloNDxi8S9TJi7rvPnilLoRqUrRQeoSH4wC4=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61144,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJglFblCRA9TVsSAnZWagAAeaEP/jzcP5JGMMZiz/CGL1Br\nHQIlm/NtxFJkdRVPhGh9Tm/nSkLPNP+Ul2sYneABXEdy95nsEYad8Z7GaZw3\nLVdCxcLK9PwgooxfffJnQKXWrYqlSuN2AlswJ+gRFYrKLuT24mlGtD9wyDx+\nTaQ7Y8F7Nu4pq/Duy3EkhHZ30nMSdWjx6CcQGjgBFwftT3RjS1XOlENzCTF2\nJPIC8IjYmzbsEmSrDioRgwNtCNLqJg4ejKY9dSS6ki098+XrT46nlAI3Wole\nqrVVdltey28OsUt2/MdOzSPmc6uN97umCutRlb2RyLtn7kamyL1oljqPqSPZ\nkzkV03USd73sd718Fqqmh+ETuBnCajKkKcOS9TSfJeIA+K30Cn35blgPh4UD\np5s1XCsSE8rzuhCtJvwIKGsPGXBb2lizdiV/TZ5Q1EQmJx2Z+DKKY2fh0Plq\nhqZpDAhf9N77KVRRDxzoPtiauUo+JU8H88zixXiPyQKND4liDMAUcxyfb4tv\ngDdLoYJFlwHN4rKHJgGPRCJR/fcHZuoPFAQQI4rxWsjGJBKqMw6DO9JsfkoA\nqweBfHlxyjXZ+vQc5UkrQe8Wwa5OAx6qBY3bsF4WoJIMqJajNFs/vRsR80Ex\nNbcNm493/Y0+XjorHN1J00SQD0fc10/c7Xm3OG4NQoSV3aRxuhDRr5/ntA+3\nT3oD\r\n=ee1A\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"ee01fc6061cc9c99b2c4a8814a98a2e8151902df","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.13.3-pre.2435"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.3-pre.2435_1620334309424_0.0232295409328509","host":"s3://npm-registry-packages"}},"0.13.3-pre.2437":{"name":"piral-pwa","version":"0.13.3-pre.2437","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.3-pre.2437","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"2d94e62d9b1927871b7d7a54f7e60b2c860e10df","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.3-pre.2437.tgz","fileCount":40,"integrity":"sha512-NIcoJfiUl1ZpNdeEaJS427hSVbTcXRY85KrA0SPNq5RGx7KQziyspXbSy8xWzFMOijzZChIrnW7QeAjdm1RfdQ==","signatures":[{"sig":"MEUCIHH5rSiJPxQpTLBYMLV5crLpiUkphShUJ553TVhZm6aBAiEA5QvGzYwb32va33wAGpY0OPouqtyQrOClS5Vb2/kPJso=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61144,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJglzS4CRA9TVsSAnZWagAAzZkP/iswgCClHNPTzOz3ntel\njDWIWhDKnB8U9J3EQZwo5IGWlhHzCWWay7w0KSC9eZMKn5lfKP6fM3gNtJoL\nGKQwl62oGXXdTHgPFmcyD8hh2LDrNtka7VJgY+OCzZmirnZPN5Lp6WQk04Lu\n7Jh52TT0duIhPl8FFuYubYxtIxLEnSTn1kLHlp/soahuzg+KkttsHIYiUE7s\nkOU6q26uHmgl9L4rMQTGYFlGOM+Je+ZsGPsopVclSerdxJGUfbqhIi5rrETc\n79e5+kCt323eKt7YCJ5EChzMAV+/3WgZFt2/28mIy4ufpX6LOtlE7rXGkEYg\neQkIAAMD9yO12QO2rdfIwZGQQe5Fg/zBEWwcxZdYOLbiqo+tx2l8yziuw38z\nL0+wZIi4KoZJDl/g6WuvlDtujesdCzEG6CHEocS80558V4PaaI/716PWSvl4\nYcGFYoajA5P8Ylx6kX/ZAzH3VqeEe8Pf+z4H01VYeIL3bkUgb4Z/56xE16nm\nIx8mTgCciyiXhJB/pvSD8/8oeKPxgl1+nn+MP8mD638TXGA1fAWWV/tz7NrP\njpsac9ZKWCNwEerL0pOBjQo/NM3W+1nbTwVO0LNWMPZwDlq+tLNgMECUOiK2\nPXcJBuHOwFM8aw26PF9HD0W4rgM1UrCbLPdLdQp0lFc/66NvukhYUTzJSj8F\nOgda\r\n=qz2C\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"c66114d2d94ef4b00c2aa7c79c43444efdd9b953","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.13.3-pre.2437"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.3-pre.2437_1620522168411_0.6711200835831903","host":"s3://npm-registry-packages"}},"0.13.3-pre.2442":{"name":"piral-pwa","version":"0.13.3-pre.2442","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.3-pre.2442","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"20a780f30cc1f6101ded0e23182f1c2539219e3c","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.3-pre.2442.tgz","fileCount":40,"integrity":"sha512-rKeDow9CZxVSrLkAAuJJpBlSYejU7vE5vBZGz/O+5Wm8GWsi3ETqVqvxGUD1GaA2u+2p/Yq9Ogq4l9y3yCc/HA==","signatures":[{"sig":"MEQCIDvA6gHaq6VgEnTjvgAYPFeeh55000vsvaAM5jT6x1f7AiAqXmJnY2dZR8RLh56dvC8XPFiY8CDiximILDsaejmM0g==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61144,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgmEbHCRA9TVsSAnZWagAAteYP/jZaknK/cnC9HcQIDX7I\nQQOZ1KMU7zRbxzcVMAL3Vb+P25gqAyX83mpD+xU/9rRbK0vDft8TG+WaovQn\ng4+sxolbju+01wZN0lLQmInOw8FbnNomhsBAlf7qU2BNWjIFzVGivxZSdoej\nWNb+TZqV7oXCnaYDPk5+aASYXa8xWARdWyuYNi5FE9fsdEiNE6kqDAQmUtaD\nwbK0EBMyxjcSxkRxv7RB0gyogz5ERMod5QbmVHivGjLYEPR6+qo9e1hEBrsR\n4MtjMtIf+pX/SbpZnMGVPgHnkxCB5BL+nkVO5NPbO7lVtWRgOp5bdg9FqyPO\n927cPK69F6BdFROgLBulZEGH5AIV0QbblSTuQfFKEDL2O7WiJYvQZVfEGuox\nTIeH1CqQvogvZCdGXWFj9ftJ8Hu88Zedgl7VmwCc5JD7g/EJyrqietLrza5w\nqZERnM2trMuqfeQi61xRYpoijn8Cs7+6FKC34uGvwUtQL4FA9O50fpCiGqdP\nIcRDQ1p9i7xkOK5hdW8yFKXQ4A2cMOtWLO39DcNrHiRPcojc3YxVTex6HOfU\n9PmzbQp70nnYxSwG3LMQd8LcWby0OAYhABysANY9nEvskZ9LUHyLnjKAKqLk\nNDFSn7Hb8a2gYCR8zqDXug8xLe7O2yySzRj4/40Yc8GIcR+D2SadT7lKu7vg\nQCfB\r\n=jUZZ\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"aefa42440135d97abd710055953dd7f1f1f97cb1","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.13.3-pre.2442"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.3-pre.2442_1620592326682_0.700498071252601","host":"s3://npm-registry-packages"}},"0.13.3-pre.2460":{"name":"piral-pwa","version":"0.13.3-pre.2460","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.3-pre.2460","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"d15352eee59e824def5e07b2081633f5c8311ec5","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.3-pre.2460.tgz","fileCount":40,"integrity":"sha512-vPucEiBKrmsIOa+r5vRxF2RiJcTXwWFB8iomVJTBobnnDv6f1NCjMtIpP8hwM/5KhxKIDEs0fDkAi02KrXr+2g==","signatures":[{"sig":"MEYCIQCxIBCBgJKXwTBjGKADdhCPgUH91czwGiKsxNbUUKEh1AIhAP8W5Su1dWWXPslJT7org19NddV2Vu1wePzGsK4+BlL7","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61144,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgpRRjCRA9TVsSAnZWagAAH1YP/2LyKU8bTReZwVUZVddI\nY2hIfFAGzbxtBgWNDdv5BsOvkt2MPY9K6HQalcrXCp0j8j0ZtHIFI2/A25xv\nUrQN1AGXgz7rJoYv5R2+GVo2OywZz8dxslQ14bYkKXBDenqUhJWuV/dv7FIj\nTQs8LYdpZBDleIHn/ZL4DklzWdtlYbWrC2k0hYAiuioSV11nnsvvtRvodtMs\nU9+xK+olRv2j6Sf69Tm4nkYb9s5OepOS1QER5lzxQ/OX38OSgf4XQb1eO8TA\n9yRjCGo0or39cBoBbQ1rL0JJNESDsSjHn2Vcr6dpYd29emPdaruJbHL0CgIZ\nM9f8DMNUaqvriQnjbaVlncZE0QtsyUMMRi281KTUvHBTy2pGT4MtAnkaSdAL\nJ/MDSqpNnKJDtLFcGayfn5Zy5CD+B+wW+DGNeyASGSL+QKeDnQH5pWchWREI\n/hQZwd6yuXICSxcMS5NT10SvwASho4hZpbZTcUpXx1FNAcunrNvlbCMJv1lg\nHYxQ/ONGyIVxLRUI7Hz3cFyWAUtcfZGfrqP3HT3MO2WFX5pHVLQQfGciNSln\n6VzbIgkz25xngUYcW+6x2O9Qp2J+DS2F5KACDoGUDhV+fWyeQvGiy3bJCmxX\n0n8pR8xMHSW1yTKM19GjV3zEacdq+36vznw8FZjleu4hzmm/DN8iqs1EG2Lj\nB2BG\r\n=oNmm\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"11094c1d3de1aa4a7b07f4a7df9148efe825ffa4","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.13.3-pre.2460"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.3-pre.2460_1621431395564_0.7184425550267788","host":"s3://npm-registry-packages"}},"0.13.3-pre.2477":{"name":"piral-pwa","version":"0.13.3-pre.2477","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.3-pre.2477","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"a3e5d86cfc4b180731110e47ddaf2e9b4ecef157","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.3-pre.2477.tgz","fileCount":40,"integrity":"sha512-42K1EbPywqmSuNsmtJ0gksvVaX+ZErWsBI+Y+h0d92b4Jbq7lJ+kwJvphCn8bzm5LTDMlbfI9h5B4J8rZJunpA==","signatures":[{"sig":"MEUCIQDygFiOQwbW1TLR2zOO6A6P+Q43JNaUXdvHXbWCwmDsbAIgCwAyxvM7G0Alvu+FG5q2FkTtrxVmTPOQJe5YEhmD8g0=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61144,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgrQ3cCRA9TVsSAnZWagAAUvoP/RY5vMW36zMIgqG9Otqs\nXtIXZuKXXay4vW1wYoKntxCLxgTgH6XtMaHqaHBHV+BhWM8GoTNgaiKnKr1B\nVmTMIJhFTQbGwLZfHdo0lZ9N//y+y/5l05aTDYHV7EqQKVuUmFcT3kaO95G5\nXEDZSujwo+Rrtee7aUq/TaTG5ZhKRLufDPFKIT13K5utX7PAYY7qzue0Nn3F\nz7z8UKVaYaiXDU7bchO3LQb/5E6WnmMU9wuS4jlA9g8Rnr2TfXHeMi58QrBE\n33wcj18GZpkvv32QPVv5laaKplD+dOgeJayuIxF8pkE33T2mc1ydvkzwx6Ap\nwFR6qLDmTUZbMJ7GatnMYKVn2+2OG0/m1+bybdd2XxKXHWu5tt67hrWqXu/3\nsG4Dow+jheiCzK7PpYUSFi0ZAp29dI/GvOx/Yp2X/k2RRR0hkTU5uA8FN50r\n9893DP57mEcbcT0XLJR6IdIh2JUaN+LDUgLq+Kxd+Bi5qppUBxUW4QT7o48H\nkuGNubmiPrQpgutYthx4l0O+yCZ3jRUYgO2HHf5oTcLzYPmg7qoNb0gZZCEn\nCCouvu1+msQZjdroYwojMfh+J5yU4SxQBibnEQ0h7HyZjcsbRTByYn67ho7b\nqlc0WeJGCwMk6dQ/tJawpKu2DTxOM3SuG+h7bXl3MIO+GyOoppCS52XzqV0R\nELXO\r\n=gD/K\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"ef4f9c312742856e05815d1eef00504e9071d1e2","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.13.3-pre.2477"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.3-pre.2477_1621954011984_0.7248082016453274","host":"s3://npm-registry-packages"}},"0.13.3-pre.2480":{"name":"piral-pwa","version":"0.13.3-pre.2480","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.3-pre.2480","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"981c4fc281108bc4464dce1c2fcb1c3cc68c32a1","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.3-pre.2480.tgz","fileCount":40,"integrity":"sha512-XrM3Hpe2YEfpt3gGFY6c1FN3iIj62nHXGtQP9XqKnl0HQ8EfJa2CLqGA3ceozyBDgr0CWKwWzyi99rDHitbDlg==","signatures":[{"sig":"MEQCIAl9Qyiw9GAqPw4JD5jrYW3n8d61Hezgk/gCHUJdmzI6AiBybzE4bvuP4NfPG5pELY60rRAFeHw0hOpjcVz2bhcl7Q==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61144,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgsJxECRA9TVsSAnZWagAAZE0P/RA1doHV4fEH1neFa+R/\nEl1kq42eqU+KU5SduA62YU8c6mFIwQ7E0lbzdHaexYKGB30ZZWiAVSgXxmAa\nwnLZOkiwfirqjxftR6YC/ADM+4SU+46f70oqFTz5foIPAayoIMRzJUEDoMzi\nQruDIRoTZyAu4Opv+l7YJrV6rIWJgxv7+dXXUHpibtQ2df3FPOPKdlOSFkOc\nz1ZJxHI0gO/kcmhh/36mECtlDOHBW6jSOrxWqy+mkVRjV3WFZKeOdIqvbyEB\n/hrQQtC0w5nEGkWF1jc8vw3ZWXhT8lTa5LDGlko+AUPuF6jRBe0X+YUgoZKx\nquwitGODOmeh9w+0xc84h2+w+LalNGaXfpE+dQg3nmOQwGrUpQMcKiaEj3CQ\nVP1gDgdXuHoDZ2VxjXUGlJPxA5eqKW/kBcI1ckAIhtLhJq4ePc3iOBJ5Wrvd\nV6YTXdE98kH053x1jeJM5Kk0qCpCHYlOBCvJi4P4gIpXm/VpVLO3oMFv1/2m\nn19yuxBMcARo5kzLAQ9Q0vyr3+hc4Cbiee+omP8cU56GSZzRpspl5XKpzuyS\nPwOp5qr6XzQGrlNm3f/cBMSNi9PVURGOrQhl+KxSPNq2GWUO73mEsVJQ+HPB\nAQm6RrZu+nFSzThViGxJgI+Et79dQYpRkDPUOJaHURiK2amxDTJhhdP/AtKA\nYfDk\r\n=8Dc2\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"28679daf515684133859cf6f7c54d4bca57cbb13","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.13.3-pre.2480"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.3-pre.2480_1622187075927_0.9109432394419901","host":"s3://npm-registry-packages"}},"0.13.3-pre.2585":{"name":"piral-pwa","version":"0.13.3-pre.2585","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.3-pre.2585","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"75ff79b258b92a417b6c1b2d0a465e810317ea05","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.3-pre.2585.tgz","fileCount":40,"integrity":"sha512-yDjPbOpNWnXZBO3uTM8/V5+y1pBt/gn9iu43irAUPXiFNFPfzfcZJPDISp0vT+lIG9ntJc4k0j80hthRQDf1kQ==","signatures":[{"sig":"MEYCIQCCof+OEKy0o3ZZSUEbKCty2vuCUnpQwThc5TY6NAg8kQIhAOydTsSLdWGw/hf73OoGSdNRAx811f8EtsDLq0aYR9L+","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61144,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgyMiGCRA9TVsSAnZWagAAh7AP/ii9K+U4C76n2/ecHz+c\nuRoXBiY6i3w2intOwSMIg/+BDLAFZrQ6UQNC2Dl//PXmXHrFdXpnD9cWUL5o\nGANeW6Gz/ahdZVzlg+txwyfwDxR7Kxk/V2+s7+bBUIV5NCJ0DFZxXABebeeL\nbGP44z3QU73+LX8dhwsP38QrNQ8jjRRak0FQNoRrJQSCumojUNdfs76UptFu\nb3n5mhgEbCQC4pG2ewTwlKsMMM+14rWaV3M3JbxtU2T5GxFzcuEkO6mw4503\n4naz1LXCytoxE4qFTPcqCXUkctvT0Ba3WV5hjUfD+imSYFAz2ZbDbnsmDe/A\nyVugwOrVdOX/ayfpaHOQ8a1jHP5zRv4qZeJGWadvrCA5dZqXMVNZ/YNmAd/G\ndGdK8cvdUp9tRAom188rqB78x/7wWknfVR/64vEbfkcq1a1F6zt+3V2ucFPv\nKYIfMtDi8D9kCzJLEHKWIQdqEE78Q3Qfn3gbVCKLE5ScxkeeHeWSTlfvUg0y\n2bt2FYhpbGqqBJ8xnZMWdbJvFmy+0grwG+70HxYldrQrxEWJRCAtCzxMf9Ss\nztXxfDY0XFYnAyyHnGj52qdsV6wwUj9TlNgHvmfdtBuxrDfUQj/YN+i5Dt1a\ndNPVGyInu3fR7p6kOVx5l0W3zjJwJYFkyyH7g2pEXNMH+ZUJHrcYUi4o0yjY\nWYF/\r\n=F6X7\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/master/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"e19514643b1fd5873705dcef55dbbc65642d2a03","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.13.3-pre.2585"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.3-pre.2585_1623771270387_0.9508812576428256","host":"s3://npm-registry-packages"}},"0.13.3-pre.2783":{"name":"piral-pwa","version":"0.13.3-pre.2783","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.3-pre.2783","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"8b1f50232cc768e3bd5a929459f2a9b7799e1d65","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.3-pre.2783.tgz","fileCount":40,"integrity":"sha512-4RKqxDnblW9lb71ExNdeC+KmZ0WxS5MtYeDb/OedNr8g+S7n8bSzB3xKkJZmgzyw74Hi1RIEqlEBa/DJUK6Gug==","signatures":[{"sig":"MEYCIQDgsCL0NsqtI50f4gOB0u0I4bgJLFP8O3Bjj2irEH1lgwIhAL/Bvwr/c1/e91tfSlLVNZQ4GrhQtvbRaeWVPEUner0i","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61140,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJg2JTTCRA9TVsSAnZWagAADYoP/0hRTXlIXMe3+gFq7+od\nJ17UfWMus8Ey9y5dZbb8mnqoSZbU07TxSCO7KjqbCsAF8E49NtMGQVN1shJA\nm0tJ78ayFCK+wFNH3Two/eoFaIQLbDE5WA3DHa/vvuC2g1UofuloZINlqGQ6\n+Dup6223EF49gUfKBuTHHKdXYDbA3dTO9iFdT/OKkhljZ+OzJow2gPi2g3VO\nLvFfoacdKwZ8LvK2tzJIopSC9u4oge3Kk34eTgp9XYOqTMUt27UGLWZyjnNv\nWGiA3Fuq4tWzs9NOHn0SV/njSDjpbW+W/ogkCbFY2LEE4PYequgAx5SGrt0l\nUTBjbmLJQvjjxrp2YfmINFzGAoRGz/47/o4mwSsyta4bpCfP38cLj9T9bvYY\nt1Mvk1DxEMOOtXB/CZx7PQCA0bicIRhdADth9wrXoYAReMsaXIau6aWKTUv1\nlGS+SStG1dfFg2SBQqm2cJ8MG1RSDago0Fn6xE+SDHWiA0nC0cZKt86XX0em\nncRxgVqxdeSJq0pVXptLgKXaCDQLcGXjik5pqStdVdJg/BO4LUdUh+b4uCEA\n1hnoZERLH78ZFlIWAWb16P6dfKhHAIKUxjaxaEYc3njoPt6tFNFoNk7DzFPi\nHmMV8copWdFFGZT/I1YLH47j6EOYRmGjvTbg6pvgz1jMeOU9HX0sIjhQDClJ\nVy3L\r\n=qUyG\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"d5d27630af09caa06ec633f00be17b8ac98bdbf5","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.13.3-pre.2783"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.3-pre.2783_1624806610497_0.7526409496568165","host":"s3://npm-registry-packages"}},"0.13.3-pre.2928":{"name":"piral-pwa","version":"0.13.3-pre.2928","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.3-pre.2928","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"aa1afcbc75581a615e56e439e5f4dd9df295ca00","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.3-pre.2928.tgz","fileCount":40,"integrity":"sha512-iB5DYdDjVle28roIIhkZxnN0Jbt4dBraxXcWKZCTBtk7DHXFkFDQzxgo0l5aI5f4+d39AROJuHZYGF1bPWPwMg==","signatures":[{"sig":"MEQCIEeDsu9ASLxvRGVcGta5JYHYo1GwZYgz+GFM7kZtguMhAiAYEty9GvFvYne/Yib3i52Mne0fsMA92NcT8Q31E58eVg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61140,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJg9hLMCRA9TVsSAnZWagAAtYYP/R5JGh3G9z3smsomRkXU\np81gIn3xU2s688z3tcyG/rgLLh6HtzEZFMUouZ4j0GJO+gbnI4w/CnDgn4y6\nCfrjUYH2g9UcOH3W7X+kfRZ9lXgeAZDaH5H4F847jiyCBnW5RnpEG33cN1NU\nSzjRCvmbZJmHA4jRCWtF23l4z2w3ExJFEs9CcOtY8ed9x3VKAn88BH3yGYxT\n7OXWPkb0zkst6A9grTThJOl9vd6UOGXu3ug+L7RVSA5U5JmCK75Rr5q5ieBM\ni2hqK0G6XlfF0KIDGHJUVdpC3R7lB7Edhp7qolE7r2ltdQia/kjZKMFSSY24\n6C4412aO+yaGgm4dwXDyQlgSaM5CrXKMRVpHdBK0PBv1WW/8pl6epO9yselF\nLJvrpjKvqFU8RPSez1C+K8pR9k7/lGtMe4J2bDFEEMwQWEiZd1zVCwS/41+8\niQWj0IVAyrwhCEPn4bVBDy+xfTf2eglwl1qB6r30wkHGXm2u2on5FkNb/gTY\n+rN3YtEi382u7anB0hO3zCPgMGuOZa8Oi1fL3UyDIITKjNJH74pM+BExIbXn\nG2RMXvcg6gwiVc6SMG6cfjEk/f7l0gSaVVSjF21xT8QgNbSFmdnYftFnoJFk\nBe93YWyrUevAIshcCKg6VtpR+/4f9CjYSMPD3ZKfSVwB++S9cZX0yEESTXCp\nXEXn\r\n=pAhc\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"6b0e2084d9abd9ff80e319aa1119adf4c3adbac0","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.13.3-pre.2928"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.3-pre.2928_1626739404246_0.84967151635026","host":"s3://npm-registry-packages"}},"0.13.3-pre.2931":{"name":"piral-pwa","version":"0.13.3-pre.2931","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.3-pre.2931","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"818c76ed7cd85459c93fbf9f86cc7ac1e9e9243a","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.3-pre.2931.tgz","fileCount":40,"integrity":"sha512-6PFDIJws3KTHaLvb/nepyi365W0USI5gfBJ59LFUmFu2DpytlUrMGHtuAiQxwMxQ331bRFXZLErwP46N+t28jQ==","signatures":[{"sig":"MEQCICiVFKmCgg4Q9yZ6TgskNgLrb5uADzqoGLe33EAf0uzBAiB6d/i5wXRI6+Bn6G/dtpgVe852kcpFU/RnPVIxJzjtGg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61140,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJg9+i1CRA9TVsSAnZWagAA8SQQAKRjgX6c2L1tEmz6ellh\nJuvsIkbJvOFPjQXGEtUrUmSYQIUTxr8egicXFPneekg8NKKlG7DW0Oj8xx8N\nfpl+T3zAjLy2PDaiAENK5rvFH0NDUab7cIKJeNJ8o87BXMyqa8XJBN6JypKO\nsYcjSYaUW6xKV42lAv5fIyHxURFIn8lPQIN5M07OJ1ES6bpjWZqtiKpK2Vay\nBICn0RvYDUmRbYm8QIbme3KBRoZ/fBjJA8g6RvBmUrhkj4hApeUj69h4q1V7\nB/MnY/TQlo5DHGs31DgNKO3mGPsw9762wfuHXAOQ+0vhseD5FxRXNH8YWFdS\nflTFlxWlJQpMzMMS1g7AvuU0/ef2ugJcLh1tvQWdc7Vc9Hj38ID7vCx8p3Qh\nEwPxobzVssOpHn6wAvhuDuyLMccM3thcP14EfRF4TWv+BQzydY3CuYyKUt7V\nigBjKCoU2ptmGcFNw+yck33YEyyJCOF7NacgOXQ/ClGqZd5sqOsQIIQnnFzH\nBb6558ZI/q4WJKk3ocNc9II47nCx3B9SCw3iY3i7FooOo32K4TCq5D1Hl5aL\nkpNYxykdF2ZcUfPad+QNUxB6+WlSdwRgOKiZcpSW6dYUGt6vnju0on3ykM+M\nEWm2blnn3GjxZd+qNDscLXHy1BE1BpjhqUbzorT8heYI0buBFN2x58eGt8Jv\nFreK\r\n=Z5Ta\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"2c33e1b5cef25c3e3a3c75434b41d78053f86976","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.13.3-pre.2931"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.3-pre.2931_1626859701706_0.6924229712862775","host":"s3://npm-registry-packages"}},"0.13.3-pre.2936":{"name":"piral-pwa","version":"0.13.3-pre.2936","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.3-pre.2936","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"59e37db645f58633694fc939f32401c7010899d0","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.3-pre.2936.tgz","fileCount":40,"integrity":"sha512-LxtWPYqDwkilyiBJNPuE/UKq/AWt8Fa7XC5R7i0SXy+SHpesEFUzmcRkvtwFaWMQvRGVKSD5ttepW5XaMFxe/A==","signatures":[{"sig":"MEYCIQD4bbpmV3rJGZZdoxLsKLA4TuWhhU+EaLp5af2FpCjcKgIhAPafYGOJoUF2lPZxeGeW0wk0AAPWfzBrue3mBcMyYVBo","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61140,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJg/sGiCRA9TVsSAnZWagAAzX8P/RXHR/SvT38C3mlqX6GJ\n98opke5oQ8FheYJSSBf9dAxtY9JVhljm3NwT5JQUGpOpIc2ssCpgC9KpNofh\nNdV1z1a6MSWfjzv2WMEkyiS0b9rOA1Jm1LNwpxivheJkut3uKz5y6DZPNsWr\nRzVodAls+PZxCzoMTm3+dz4MY8KFb21V/lxvPcZhB0xvdhslGNfY4aWSgHAp\n/gtp3aEAx9ytC1jN+ByMBJoQvvnABGTwK7w36f5shwvrHqEjCbfJCpn1CYPw\nBMrDLnfbSxdDftEQtHIb6wyjAQQsLSDh5HQzXW/mY8QCh2lzsI284nZ94ibb\nROd2ewNJ8c6kSMrdUT65ZpS3shmnAXDqPeYMTnfLalIq5wCGWTvWOmX+ZLRw\nfzai4HC7DoErAbNUOMuMFrjSOHKMImZK93Pcx5//D9GPy8XUIaBPKTnSemNA\n0B+GpVyl4QswkMu9zm6o3vDAyfB/Tv4kC+kKz5XRq+tWamr3nEusQBwWPbpo\nF8cb+WraFvG9HKlEpof268eR+8BCQ2hOo9qfN3wzYPAxn8sMdWP/l+kQpRyM\n0LDFaIZW3EoZzlYx+X2jpA0nS7LkGlkWNez5DNGBsf5kpox9QKMY1WwnGDfJ\nh0cxVbKZWGsZFIB/BjNbx6equtA+pKo4ugteXoBG2P81uoRkf9vnXn66CD1g\n5FkP\r\n=5PuN\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"bc49c375ba6b43e8e945707cdabc90f0b8d69ec9","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.13.3-pre.2936"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.3-pre.2936_1627308450251_0.4153000326052647","host":"s3://npm-registry-packages"}},"0.13.3-pre.2937":{"name":"piral-pwa","version":"0.13.3-pre.2937","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.3-pre.2937","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"16a3617f9eb36756b31c640fbf503e5c0f30e6a3","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.3-pre.2937.tgz","fileCount":40,"integrity":"sha512-ub0EsN+31jr2DY4zaACTTWx9OUVA283JyICUBAqiZmBieIXBPyZOxZMEWRtcih8pb16kEl0TtuPo1dCQeoxfpg==","signatures":[{"sig":"MEUCIQDmTb5Njb7yuodxIUb2U/44yvadA/dJ+uSqZyPTGrS7RQIgRR1Ko8r07dAjeTXGUsDyTpvngthU7dUrAsajGvbZkqM=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61140,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhAU+LCRA9TVsSAnZWagAA3J4P/1oN3yjyPWU0YEVImeFI\nV09wSxLBVlZsBFdBuf61FWojJraxnqPAPXMfCu13BQhUWtsy+awMYOdJey0X\niLIi+v1WziUXMFDa4dfLZs42Z2hs4lEKlNW9v9cUpRz+7HcY5iILA75ikwhk\nbAjupGhSnO++qgQBpS+YkgXzcpZ7+eZ4Y/nK27RtD0/YikeIKXHW3X930HbQ\n8R8Cj0lC6dieKolUGnl8w14QBCup3N5y/AXeeZ1xtjsqi0wIXYyezwkULSLA\nz6Aj300eCdheLtquuVRAOtW92ioRoXx7Zg/LUGDlauMW8WX21mRDbfFXSNMt\nU8pgTSYdmp23kitHn5ue06V3jbTGaOPwJInYn72scmMroP53OVgxouOx9KNj\n7acFFMKW8tjwCbe3M/oAfPbBBXPV7c318XtSsTUQs0RJ3wGMVe05ZdCNt5WF\nHpIUDTxcwtIwih/EtDBfi/d0KpVnNCSoBgEtBW0floDt8me6opbzHIG4P9g6\nGI3AVp4H6U55aJmDVDrE86XxAWtszmiA/XI2YKrA/svP3rPucojd4IBFWP5t\nCxTHrVd6696c+33i2cSqDaHrtQXqSbPkcMESUz1YXN+EkVGyqXBjK7dEFmLw\nNAt8fvhvsfZOYxn2z3ff7H7B4teV9LhpXk0ix9KiIdq3j6sQHSecG36x5ErB\nyqBH\r\n=zC0r\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"625e6727a49d66ec5eb33dba0a7829f1f3d318d3","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.13.3-pre.2937"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.3-pre.2937_1627475851298_0.09268692329709904","host":"s3://npm-registry-packages"}},"0.13.3-pre.2940":{"name":"piral-pwa","version":"0.13.3-pre.2940","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.3-pre.2940","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"3f310791ce8cc3166509fc1ec357ab126aa56067","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.3-pre.2940.tgz","fileCount":40,"integrity":"sha512-rVt+uOCkzZkB7oenL9w5j1b9zQjZ3Kp50tvbqQ5q+KgzSi981sfkaTwje0PVh1PkYo6YyskWMSJMcNzpcmcyvQ==","signatures":[{"sig":"MEUCICvWEotpmI5HC6XRTgty5ZTztpmahkUyaM5KR+ynIKzsAiEA9a6PiqjTAyWKwRcmp4Lz/Y7KH59BIl4C6G3iXu8+n1c=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61140,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhAco5CRA9TVsSAnZWagAAvisP/3pqM1FDT5/f2AHhHN4g\nMEFOTH19ONDoHWMJT+Ea+bVVTXzyD2teKPuOu98dmeSBBTp8sOeJz1LOZYNc\nPm0ZdrqIYA9Qb4rp7uEMU0P7we8uq0Q2/836vuFglHI0PqKW1ejBqFiAmrjb\nZg/mopyoVwJCa3+mV4Gfm98eCEjhGx9hQxKDe/8lHaO3XsvUclhx0lwVDyuq\nQht/6BywrGkaj1zWIIrBaqQhRVHenMXGaMcBY+dSPUpybxd4Cuc4Nu6f1bXj\nwlEhMpKyZzeSTwjfzehJfeN9f6OTlbRVJOrkKsceErDAFLRZxn9ldvMXGBvV\nEnxskyeaGJEFPtJGOiRB+tnCd9B5CaNI9EmNw2ZaKQAtCrspX6EXuLwlrjpv\nLVcJdwFO7m4gSHSjga7F2e+vi8yYCCTtr61VAHXcx4L85U78NxgvYFb4TMbA\nNf/SA33loWlNAnnDrEujORmA5h1+xslz01ggcFB7vdUqpVG7F1Z4tPldEjb7\nsxYRMO63UIt7y/K+xYidAL3IF9pMvCw0r+D10yR2oJMRjxbUZ1/DurtJTAsJ\nPwdn5GvMf+ZDJjcreMSZGkAJbl0TxJzTAxSOoVB1TNUutxi/AUHsSuOXcKCD\n1z8TvmEJsaFfvGpXpCABbAVyVpnb2FYSHZuytHBSAzkgZQ5GXRRcmnRW/CxN\ntbS7\r\n=b9PX\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"9b949fd35ced6311b8c671dea19c099854df30f4","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.13.3-pre.2940"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.3-pre.2940_1627507257125_0.6651869491043081","host":"s3://npm-registry-packages"}},"0.13.3":{"name":"piral-pwa","version":"0.13.3","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.3","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"12ef6390821f4d5ff37483f75d8c7c1532f0c9ad","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.3.tgz","fileCount":40,"integrity":"sha512-xWEcZTE8/l/DENtQE+ddYQ1dzEoxfoiGceeO9a0lhxMZXg9ZddeAEApNLk25Af9kBkKhaTXfrKLTTgKXNyW2/w==","signatures":[{"sig":"MEUCIBUBhrKCDmrkVOCG/zuGE9VXtWnt5C/ZejOXjfXaTECjAiEA22sxKQfz6TJq87pxiveAwSF0idBz719hEkTUipyNXuI=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61122,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhAdUSCRA9TVsSAnZWagAAzi8P/RvRARK2zYRy2iL15eav\nBTDCDDSKjv2B2mNcJSgbcJ7kLPVkF/oaCBzm1zcR/H4tpicDHD+ML7aG3Frg\ndaamzEMVUv3zC80kalpHG9ik5rKIYGpPiwzUa8v7MIprcYDlK+NRWxszz/lo\nRpc44JG6khQTCkptW7w17Y5mts9CkHN7KglB9fM0VNgF8U1MRwhl3XPV7Tp9\n4k440BoFJyII7psMPHNK8fBTzj6SNETPniwM96s6ZkE2Au6fjQUKr5Z9w0QQ\njCCr/fM4VKfWFAUFaAmeH3/g3EGIqhSu10DVBwOmvjbUGuK2SVsG/HN8ioQL\n8FW58B7pZolfncexsMPOEODlDMynYsbzxKXVY2HqUFsha4i4Y47udWc1XRao\nyX19yv/XH/blx6EkN+dui3CMRVl8d+/3rR6P/Z2leYhrFaIHonJdx6NzeDQI\nsTbjmXgk89eX9YKmWftvadiWC6LkMVv+FLheVCElgYY6UMUw0eL34NrK5GUe\nbxxpzipOFAb8qgS6O6+3tGwYEjpm7d4xf0xgdqwgdJPvPRHOILyGV2citz0j\nN1z0Tpf4TT17+I7iST63RAvKWfiWjBODM4c+fjrO/gYumMHJFfzUU/z+mw1J\nz+58dueFX3Pp/od64lqcrldlOU/yAbWrLv6mmiPD0bdlRCI7IqGt+xDtb/YT\nhCKT\r\n=WQwp\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","gitHead":"3328ba36e4c1c743547222bebb60b196725c87b3","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.13.3"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.3_1627510033931_0.1455750736816519","host":"s3://npm-registry-packages"}},"0.13.4":{"name":"piral-pwa","version":"0.13.4","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.4","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"4706ca2fe8fd53274c0950bfb1881c64c11c3878","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.4.tgz","fileCount":40,"integrity":"sha512-6+HQgGuMJ2dZe9W8x9wztSC1R9GiTeDViCUFWIVGY1NTnFwPcDHjNmnBlN7YXXwOPLIwdmLSMhIvX8PXAYcbRw==","signatures":[{"sig":"MEYCIQCuj3abNX1bTwl4Z8S1qN4gJeuvxsVHBTYkHNxue+l2XAIhAMvt9bcOBo/uI+U6VZCj1rtC+WGNPzRUHgMFYYDuu+mm","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61122,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhCF9eCRA9TVsSAnZWagAAQZoP/jqFS3qC6ItWcK+OVAnM\n09W46sLAArzCRdsFFMhdVyI3pm9m6LezUuVWkSSOLVDgK9roiYLRWT+wjL9U\nfnZyqkjRmLobaEJFqzCjIgcX+S5abM+d3hwwea5J9JJV8eLkSVHSuQYZiSBG\niaFtDaHhrPR9lu8L5YUvOyxaV5bVYcctb47OJBHyIyijSzYm9CM2TrdUkdi6\nI3V07N9n1R5Lu/A37kb2CzhwN7vZjaityvyTGY8Iu9ZUF6zEB5AIgxnSLx3+\nRzd2etWa/66feN6Eky+6bbSFHGkAPGl5Y5s4GGykLYEa9A4BMO/MAHvGqHaY\nizh2lQkP7g7v2AFWHOlpHWKwjRRBmjCSAACOy0R6MMWKZ1Lv1GUuvEqaaYlu\nWxpBLx7kEIBjntKyRKti8KCM5VHyRGiKl8nMmmu5ajC54pTN2i2CqWs71cHA\n7HIce0/SwGs/DxBryEkB3J3I5dux6QWuF967S6NK6Ve/+mbJOueG/xZgY85g\nscOlljflYlguNMIGjDMluKKTQgUKvq0GZuYvVCu6pg43TZ2bGkAM4GA8u+PJ\nnSyFYAy8rEV6NtKzSqkbRlEayHwzFl9l2ntQmrQU8ZmmSbPY5AI09LPMiQnk\nQIvD5F8tKnygn98TKE8tO78Qpqmiw/Nm89/vFj1aFYT7OYzdR6xUySl91Hdc\nhSop\r\n=8bpn\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","gitHead":"f87a79fcf792eb8fa196f71d2e7a64840bedd167","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.13.4"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.4_1627938654360_0.5283331679509957","host":"s3://npm-registry-packages"}},"0.14.0-pre.2964":{"name":"piral-pwa","version":"0.14.0-pre.2964","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.0-pre.2964","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"6e0c16da1ca73a6b3b73d46adf2548d036e74e79","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.0-pre.2964.tgz","fileCount":40,"integrity":"sha512-dbPzTxwP1/xasSyk2dSEh189woNdHDkIYNqsg4JmaPBt4Qq11mhkQrP0rl/9jQyIaev5BZOXrNWa/K+Q2RcprQ==","signatures":[{"sig":"MEYCIQCQENKWjti95LSyFXBNQcDcCl+FlPyV0b7oUeHTEcwrcAIhAP8d/j1lfMH7c23vdQG//ff90nrrabuW5q0YGC0FyRCL","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61140,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhDS8xCRA9TVsSAnZWagAANk4P/2TSa5UyFR3PaDWiYp/L\nc//vpNzSC+JF8oHxScIVs2RE43AuCaqOCbtI64M5iGpnsRIql8Fa2hAAkTJp\nOdQw69bOxWTOdodlVruvj/DURkqsl5HaQPvxdPaQSmTa971aWuF5zUTpVGZ9\n9hh+zVU9WfhOKxmC7BlHMRp5KABY7D7Uu5uRgsI8vACbJTuXci08E2rHKxUg\nfhj5DSpPQx12xayzJGIjmfX27dEBl43Ciczj4qloiYt0qEiZd28rC0ufr1v4\nFaaHKe5PqZGZJDb6xN1dUs7NPfmW+x41z7F0P1D28uJ8R7ANQX/+ZSC11kTo\nAGBtr3ms8AH9vqrL1XXgzgrQxb6cCNkBnmjVs/o2Y37u+3YYrvmdEtjiRhVF\n+EGP//dntcbmE4H0G8nKya3ZdGfmRX4visCVF0Ab3fSRNpqTqMCXy4Ohvjfc\nMRhc3jK+aaOMn5f6V0BKIjPHtgBADPLPiav6iPZd3EYS17ZKQfSa4gud7wr2\nasV5VH4X1SQN8hU1k2IRv4U3bTc3ZqrB/ES5zeRlhM1oDonkdUp/vUwZxutC\nx/z2GQv2DRgrAIVucvdQVJmp7Yqdiq7/2+MXkGj6ZtEyw7Ge/Cmq428sKWDz\nJQrovo3tQs9cEBONRl1iBMpM9MX41c60izgbi8iiI+UClWG3QkaocN9B1uVx\nIUj3\r\n=aQfQ\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"58433516448eb268bfcaf45f7a47e1e337ad3fe5","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.14.0-pre.2964"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.0-pre.2964_1628254001745_0.25623272293666277","host":"s3://npm-registry-packages"}},"0.13.5":{"name":"piral-pwa","version":"0.13.5","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.5","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"ba3d0346e888db06ed6f348f6cf1d2a5bfa4f907","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.5.tgz","fileCount":40,"integrity":"sha512-NSpeCut9eU0QuE0JRsvdawF9D9ON+CslI8/fS24xhDXrCIF587qmiUKL839HUDbi8Ry5WD3/RLJTgwS0f34tWQ==","signatures":[{"sig":"MEQCIGNkdHTjTzGOgHfTAMQ8XemEJjM8GD9KCKgCqkgMhGkoAiA+iIaBoA8IQvR3n191YAmvSgVzNGnr7V/zkmTjNgg+mA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61122,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhHCwxCRA9TVsSAnZWagAAzK0P/3e3o65GJKFAG8I2+SiS\ngfYfa4WZ2kICLqRzcrX84kxFvd459kaCd+72TyjgoC+LDh3yuuH0N1r3FuVD\nPxWYW6gJQ5RvkooWtmZELl0k5R82MlzY7nZHSbDePQil7whUAZxFIM8bYm4a\nuMWC+iAERg7d62SCXixOs0bnAtz8VxT1wBINWjhryekNAlTZd3IRbgmQ9a0m\nhsisMEY7F+Cz+Q0ks5yvKfDqfbBTruQmydJ6r1p5tcK4m3I97jcLhv4feM65\nWZT3/KJUe5QORQM9/NmgglsLPQP7Puk0IhR76KAdps1a3ihLfWxsWb0Gq3OE\ncx9d8Q2scdnApRbqRfF3TPLR4LxU4ZJtAoI10XBYwJTy0Zj2/KVcUMrCoYnG\nKc8Ys+cQUqqQCKTUXeNdr3KhT+gkRWWN7EhcagMDATHKnl+huP35wWthgo1v\nkesPynTYY8rX2e6BHStiEdV1LjhSINwj11iJpN4nunG9kf6TjW9o7ycjiaxX\nUflrM1iLlmJHLoW+V9dGsMH3OOpePgW5B/wGQfC/B+R/Dilogbh7+QwXFU6Y\nOX5roabL8NmLzc6VQalhvEaeLYcWEqn/RW6P+OwbHGf5FCyAS287E/D3tujQ\nk13Xv3LqYmfqdin6Hda8m2lBvHhmywiBT+CV7TIIW2iCNVHgLdfP3zrRDM9/\nM+PQ\r\n=ZaNj\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","gitHead":"79c0410ffbaa50756b71db8adff639b55c98af1d","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.13.5"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.5_1629236273101_0.4677828866534761","host":"s3://npm-registry-packages"}},"0.13.6":{"name":"piral-pwa","version":"0.13.6","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.6","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"389a3ba1caf59a8243ea22f54abc430a5c1019b3","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.6.tgz","fileCount":40,"integrity":"sha512-bS+xre5m+YolHOKBA3GZyCIW+oWEJo+BO+gaZhYpn6dVWUjykOY5e8SmwXDg1jTlYDB9G6DC8d9f8QajLxn+3g==","signatures":[{"sig":"MEQCHxhvCBLQkaLuwLNopjLTJGAnH6B9tZ6krcSZfQEEKM8CIQC0wyMYt55LyMD1eq35H5DJnI2Cy3NBt51K0xt8oDFuJg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61122,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhKL/5CRA9TVsSAnZWagAAZM0QAIwc7BsXzhZBS09zcJcd\nfiqXkklQ7sge122CYUvy0JRPs5eUlLdTKSbR1ndkJwnISre9e1+AZPTfPJzE\nMjeFPFFp4cef4rJ+kelQv9whqlLrDgvjPrmihPcMPkFyffqUDkA0FBZAox+8\nsrQAf9vwSIzx3xDVOW5td9EJSQoFXx6pWskElPoAzUxjkeO01xmIkpryIo0C\n3Kh29t4eau9tmrH5h0lZ0bBRnaYChX+G1fEW7oLTHZG0YEWSTIJqVxj3gHMf\n3yqgE03HGRIjCvIbCBlNdujAdBHSO12HVNcnMKvS74JCEOPAM7xnwC8nKVYm\n3r2pSBotPB4UAUoNMsnHLj7v7s71xmWKruONiUvwT5AiHOSm6ovnUwCOVvvT\nxhTDw7Hesnzfq23KLxgu2qgJwgl4KA+WShIQ7IwLY577AJubIh7JbQ9Doohl\n1+MecfUAiZrQMaq7jj5tsu9ndQSFDp3alcqvKhNSwLwPdlCb/z+ujnk/hhLk\nlDrh3tLLYe4dXfnOy4OEdyaBF6kkj7aIHeRP2m3ctDg3IPD9r3HzKTqF6erl\n9tO4rfd6ETM8Y4xaCEK0axJu9VbT0C0HCFm+jWPgKkopFYOXsoWXnQRsC+8g\nX0Y+0CxkApR/TOkRzaFdKs4Vnw7J8QaVJ/4ZJyQNtvQZ2kV9GbbYk4+yiV8V\n9JlQ\r\n=Iul2\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","gitHead":"11c066bb86dcf097171236030d5aa1431588f537","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.13.6"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.6_1630060537029_0.18348015389691064","host":"s3://npm-registry-packages"}},"0.14.0-pre.3018":{"name":"piral-pwa","version":"0.14.0-pre.3018","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.0-pre.3018","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"3ffe3ed8000b6542b8e7e271409cf527b37b270b","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.0-pre.3018.tgz","fileCount":40,"integrity":"sha512-SCfjkvH+8E7a6drNFnVefFRm/rYmzgwbdTJ7sK4bxKFq5NWZ4TY5dvBH9oL6HjJyR2JiMmJV+7KYCR7K9lexfA==","signatures":[{"sig":"MEUCIEqywIzDDetPFjji9CLSKxNNHXu52VAaAQS3ei5t67+KAiEA+OrLu8b3iWOZtMUNAw5lbkc98wXpmTbcMB3lxD0GSuM=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61140,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhL0X9CRA9TVsSAnZWagAAunwP/0+mHvkWFkYyDnnwZXmb\nplsx9khnB9BOJphM0yVpIuPM8I8oAJ+PIcOZ3kxbduUc535+vjcSbGv6ND2N\nf2L6YLXPWHWeY4XmjsJx2CkvFx6OEOvq6ThuW0G13ZduuZ758NtadsKNkVxc\noCJSMGP/auQzm8YepRHz1d8csE5vJPsqmbwV1Q4sWBUf6SpkM9TvxFO5XaI+\ngaUyjWCzy4Rrb5bZTpTtUJeWimdLqyh9i36b2A0xO61EzlrNmn2xR8wJ5DL6\nwsswqrKAUTzLpWV3Z0rJnNIF/uSz4HOsUy6nfU1hSrD22xWF5GLXIuwHWNTq\nYSSoKfUsnoxyBjjbssmmk6lqu2ZL+GZ+kY96agJKxOhxLqR8ZgPKq6Jr8N0T\n0dU+3PuC6yD715KNYC1qLTfyArgSPBKrCh0sNMFp/49fw52wOnjDcCQSskNr\nhjrk+wghbJEY/YORq609kBE0i7bx8VE/m5bu5RqMGmiRBUCJlp/AdcQzQueN\n1bq++W7hSRwPzHEDw0bDSXCBiewJ+qaS7QLtlyZJlOXmgYnc6f8FRoVpGp6W\nA8CwL5k6n72eh1N0NuD3nCeH4cQq/qinDcmiuovmfpjlrQx3KPiX/Fel88zm\nowuRuNJSi1bWqJMOXb47Z7I7gjXbg4z+5oX3GTYng4YHFr0Tj06AYMAFPx0u\ng3+8\r\n=CCv1\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"3a4f0583993a705a5cfc103f8a673e906786af60","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.14.0-pre.3018"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.0-pre.3018_1630488061528_0.3521207153181487","host":"s3://npm-registry-packages"}},"0.13.7":{"name":"piral-pwa","version":"0.13.7","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.7","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"d346fdda07665d819e6226f5796f47d930da7f93","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.7.tgz","fileCount":40,"integrity":"sha512-aBv6sHdKwjcN/4jBmUDXd7O2QvhHF0+SsEBJA95p272lazpabD3B2Yc34R7hQFgUiDjIjfe36Vx05yp9AQst/A==","signatures":[{"sig":"MEYCIQDRb2nJQi1fbVdq/xGfkKw5n0k9dNJ+ZWU4Qgtcs9goWQIhAITZ6z68uI0R15GQ4eAV4desSn+r8xAoNv9IDyAe2fxY","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61122,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhL2jOCRA9TVsSAnZWagAAi6YP/j7SC68S+8aIRNvrYwOZ\nPbRK00RgAaYvbzTamEf6bTfAQaxHU8epHGJYcTANzT4ZcAjptvjZCUE+931O\nl5ZDIJ6N3skeloyKmnBhXMGKZec6jKDAZnVdnDkaouOqD7h8/5YcVGr3CG3X\nesSnlSy4b98QJHvgIomr4IrUt7eypVNUmeOpsGXeLHaXhuIDOckHVr5rfxmw\nTs+pF/r7QKuEaEvnsMzcuDtwn2VcgFL5ZMioMxpeRVBPuD39Lzf1ieFjn3PO\n8+zcy//ZbNBpLjBQLGj77IpvARbcV5CSd+OgHnnMPUFUZ1/lQQthRbMeny8z\nL2ifNcoSWv7l8TiICfHlGUez6LoQ/1O9+8DXgqzPNKwWNPhn3SLy4TuHSF+1\nqVB6kaYG9ysANdL243fJAbZEkN8g5b6q2rBj1CN/JlHOBzbSJbcY1L0d1h1x\nhEscUR8uF7+ekPeJy9l2WgkCW1L6oZGSgMFGPaYIOs6wwjbpDCbi3xukk0Dq\nZ6WsRZuFQewi2/dvVzcUbJjNrceieD0nFma3m76n5G443SWBnyGNl1mV/GU+\ntg7r9059NISCwnUTu0guVk3gHdU1g1UVRPQYTDdUY8GmrqNEMpftnfxfgYCk\nEhKp+58fNlsnacdqhKWhNrkEyOQkhw6du3ILHfuSk5y0Wl2cchmuKgxaQSfI\nk14K\r\n=AG6+\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","gitHead":"201de6c1cddaacb1e5f9646bdd17dc43acf09e8e","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.13.7"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.7_1630496974767_0.27980972008813754","host":"s3://npm-registry-packages"}},"0.14.0-unstable.3040":{"name":"piral-pwa","version":"0.14.0-unstable.3040","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.0-unstable.3040","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"01c70809f6c3fb2fb60df3113058fdf793e87b45","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.0-unstable.3040.tgz","fileCount":40,"integrity":"sha512-rR3Pv3ILIUw+skREtOVjr/uJlbabL/653Rp87h6rHvv89qINdkJtdSB4ovFmq+i3FF8x7yjiLBaKsxIOvkZjXw==","signatures":[{"sig":"MEUCIQDRudiPMMPKDjlM0dgJ7U0KzNNJcI3UbTrIx8m17cCdFgIgOHTxdnxMW2Qu3O/gDF6XSH/k+66V7zB261JMzZ/uBWo=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":60003,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhOyS0CRA9TVsSAnZWagAAE1EP/2Gw2gAIlUVpOYdc/rmP\nqY7HZPj+dx6TFr0reSQ8NDDLHzdPPYjVXZPsJ1xGiThUFtZpRy31HsTb0qA6\nLoKAQS4GlXyskQKEIt6h7bkDP7x6/sW3pgo96mK8co+w7iM4ZZcsJvEeDhP2\nJSBGzsi8zCXLN3DYHcVn/N6roYnSwuKBs2/FIeywFuOcDeHgQlBz/NYiYJ2R\nYOBVatjqSvG870hepU1MiwWVKAPMu4NokCqfaeFMREJGfunLFQDVJvm3ov7J\nkW77mb2+K1bDaYecq1jkj1WLd58MvnIGDaryyI4CiDH9q5EDc72Syi/EDzVQ\nV59QeAKPsV5UWUHKi+fpVRFPC7FapJZOkMEUkWKRQvummFXWAarK//BJlgC8\n6ElW1bqtgwXpojs5vQA4RXic6LwjxwzNq9/wEWhYAazY0ax3+7wzWeEXPhie\njklvqDug0++TGdoSbeiGkdINENWZ1hA67PxlWEz5SYX8XESs/Or0+or+K8Rm\n6SKGSk+x7qQ043JaIQvLO/GaiHiTvM+/mTMdBpgul8T3AzOBP9VGUMReZbn9\n5TD6L7OMRGyhxLdKdANjR5T7w5YTld7MM84ptkPxAepa+17RjY1TEwmZvDH1\no8uiZjjC/cvN+zDFZAo33auoTOw+hmStdVor4wOQ1uT+SCNryFuLy/cgxqaV\n+ZIl\r\n=kwpU\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"8ff4c5ca1610ed9b8e057bb717e23d97624093c0","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.14.0-unstable.3040"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.0-unstable.3040_1631265972446_0.026728751050504318","host":"s3://npm-registry-packages"}},"0.13.8":{"name":"piral-pwa","version":"0.13.8","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.8","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"a15ce104444a63c47d51f57c1c9902b726cfad45","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.8.tgz","fileCount":40,"integrity":"sha512-Wb5yZIzmBXXcxRkYAQjqwrGDAazwVuM9x1/ogEHimx2CZ4NTmk1pBqEaR1NwOnAQa4bpswo538L5F+pViMHDRA==","signatures":[{"sig":"MEQCIBav3yyHW877tq8TUWBKFtbrIqt1u28r31FQSgUV+EOkAiA0bO5m1Xe/NRQ4pSdzz6DkUqZRp8qwCGVJnr415GWjcw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61122,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhO0YxCRA9TVsSAnZWagAA0CMP/07ERflmVol1ixM2B/i2\nXpqg503yELfmmmsWXkfwX2fZFLBCiKvI6dMp0pSq7RsatR5UPySUmx/2fiw+\n5JmFVKUJBMqUrqxgFRKkHr4R9ZjMt0XDKBYwZi3mZM3Jpce5EPeRMNPqW8y/\nPd3Qf7PazZa7bGKYYLugvTzorAlN0+uIoaH6i2WWfC6TsRR8qIgihL3NF0N5\ncq1x7+z5qKtImdnm9yTpqAhjEpl5q54fd4TwHEpbwt0R2sDwhKABlvEVXeAe\nrTzJQxnaT050aTDKjIOaRYBZkCpvj01qEjNhmMRJUZ0B/0Q47XfdponVMRmG\nbnMH7BuOPPmm2RTlnpd1IM3JW5P8KhE5Y/LfcZso0+Jqyr1Is29nZZEII5RB\naflB+0NVCElZKDuj8uymYHfwauCiasb1/38xaNnV3bZLd29IGmAJsLEJqdPl\ncK2wqCJzR5MpNeeq/vga9Djd8AjgGFO4j4bV81z8UkIqx/2nBwqFvqkIqxmA\nf0n2f4hJiDTjZ60B33yxD4jLPfQ9o1857wDTQtLmwLG8D8QPgvKZesy4A5cN\nzxwhDzn0hZMiKvDIVYdZAj+RrQL0MjhOo6S0yIwggZj+gkgw/RCo02z4Asq2\ntUNS1ofVKZQGfwXVOsLaHJVqXQKBXM+Sq40ZQK22ozUuffQMK9RRuV6+u6ml\ni4+b\r\n=PMf8\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","gitHead":"26a9a75314886ad9d81ff9d17b5d05296af3d04f","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.13.8"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.8_1631274544863_0.2503679450119469","host":"s3://npm-registry-packages"}},"0.14.0-unstable.3058":{"name":"piral-pwa","version":"0.14.0-unstable.3058","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.0-unstable.3058","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"46d34ef88d41d7cf7cd3b573221171e1f470832b","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.0-unstable.3058.tgz","fileCount":40,"integrity":"sha512-4AozxfoJoaGPt/M5m2m1ib6chrtEeZONxs/x2u5eE52e18jf4sfZJL9tk++fm9134n+Is91zD2dzfoTx5mMr2w==","signatures":[{"sig":"MEUCIQDtUZDbmHE7NqyXWkseAvTzkYSp+DRvtioryHMJT9sh6QIgQJ06bqfil+46wVFYy5aIuz0Xkixfi2wwqocHtAwFCRs=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":60003,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhP0e4CRA9TVsSAnZWagAAtMMP/3SbmLB2zMvejjw2fEZM\nqx++2QpLsRgWRGKrwUPtzGYoRysr128k+13QISPLN3a32U/+F3NM2FyN8egf\n8ErZMYOgHYm5pMZzVaUoOJ8WBSI/+DSLUk0NBuEgQeD5Hrjryhjes6ieky+w\nM9UwDgSoip01Xz1vOGBzrYhKJzQbRqkziPKwSZrJIYI9pOPUo5g5VDWu56Qp\nPtmk0dsMunLr4Imd9CTuQnRb9Ji1EnBE/VA2AhMBp0fBcnkmqtRQW+NRW+RV\nI/CLPOdor4+xRgUWTc3VLf2XR4kjYhbPLrg3QOn78Z0LI96BhCZFGkYi+eTs\ntzeoAEoWapWCtQzpp6N7T73jqw0D2066fc2TTrc5hXteUdVSo98YKIKHC9ps\n4rQrEf4xrYuJ+BSkft/3zW++Zb2sI46IUD3yaLrKJhm705P4FJLPOxFstlYy\nWOEmn73EhZnYzJG/UgcAJPfcTZI3bYNiv26tqA5soPWrBlCdcSDc1nKeiQez\nTIykdeHPy8dOUhBy16VX2oJSBkbR0j9Y0/ej+y1n/05bgdfRDhGmDWLsHSDn\nH0lzMB0R3NM1ofQXZeQGEcxOjh/ppski1zudS7OgWXDT+S8RofvXKkftJM2b\nkGqjr1a0HuPtWl/niIS5p6ZSd+IZl8T+7PgISMFFYvrSbUedeEe83cOqgQf3\n4ww7\r\n=z498\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"a1153691ac7835bc7c8569ca65c56d8027f094d8","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.14.0-unstable.3058"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.0-unstable.3058_1631537080669_0.9988790842685842","host":"s3://npm-registry-packages"}},"0.14.0-unstable.3062":{"name":"piral-pwa","version":"0.14.0-unstable.3062","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.0-unstable.3062","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"d26e02439f784e17600a7824aeb9c3a90f62630b","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.0-unstable.3062.tgz","fileCount":40,"integrity":"sha512-jWUa2cPh2+i9ZoMXHIQ/xjokSlG+oCzesDMuZLe3XwdeoB15Iv6yBc7pfQt5P4XDW3vgWjUL/uUi4U5XiE+X/g==","signatures":[{"sig":"MEUCICunjzkdBlvdSBMTT59qn8GMd/9R8nwxWtZnWbNG1tlNAiEAuUXntdOoTseiAuTlm5OCKMwJHP2jWFJvOgny8GgSErw=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":60003,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhQaaUCRA9TVsSAnZWagAA93gP/3tARtWsS+asg25OlTUe\neZ4Ny67sUFaQ4JcdwxJLrMFF8oaJ/ZRR8xAmx1XiVo2+RghFwrOMAWoimI09\n0UY1mRwaU4V7QSCir93XVdW6duO54DoXLjq1Ww8a79yo9BQc6qC3tqER861j\ngxMzGhF3MM7Pm8wN4UsKmptjm8ea9z9iEzGYfkh6EyAAF+QZwPYMvkQybHU5\n0aX7DzyW8oNF2x0ufbsgaaqslwCgYHC8RqtG6JPuKK+rQ4+dQSpO6gYxfe3C\n4D1+v8yRoK36lRQbV7YuOHr/TVswNEzFgRGPl/YFFyxHPQNkIszQS1R8UhSt\n6CQqdUWVHos6l7pc4jrOfqzsv7dnk/XCqEZmVqrCXg1go6FLtOS+I/9laIy0\ntrdNdw7oNAlPK1RgEzrdXQqymPcSiQUut7oKPrtPl0XUoo0cfbYuh1LMz4Df\nhhKM5Eex3QQNgDGow3I33ELtrHfbnXemEPfn/mWJ2h5+8hlkcEDS74JBBLxC\nduSnJFGIZ9xrdi8HEeLVkIgdgohK+8EM/hE//QOC1jCTADoASI4ErmbmExGn\n8XkmxqDE55QUT8ezGjVNpfSjq4LwahGI/+Z6Bd1blOGxDqcZEcByIcAf+icl\n1IDs5C6VjDAPWMZKCXdxFH3ycDP7NNqL4tO88qE7bMa6Iip+06Hn2P2/LyQn\naR34\r\n=cmsy\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"3c02948f10b359bec03366022a5ed09c86003a7d","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.14.0-unstable.3062"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.0-unstable.3062_1631692436324_0.19971790799626943","host":"s3://npm-registry-packages"}},"0.14.0-unstable.3068":{"name":"piral-pwa","version":"0.14.0-unstable.3068","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.0-unstable.3068","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"af5e88d3611ac08738b7a6b59c97599e6dd78c3c","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.0-unstable.3068.tgz","fileCount":40,"integrity":"sha512-gv38AZB+Erjg0bDtmXPW+a81Mko0EFzLz+Sb30h/pfCB/fqeze6aZqxdV+d/5xi0whIgEVRzv1/L8rwNsU7Ajw==","signatures":[{"sig":"MEUCIBfX1bIi6XBHfbTSCsuWR36J56qIpHqk4Pe//fMSEWX5AiEA8HUCh5uy4o1goIJGpomv/jwHb939CyMHiumhTqZaUMw=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":60003,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhQzzpCRA9TVsSAnZWagAAZfgP/j3ykq6MS5h+Hs+pOhcy\nM8SWDodfgMOXF2HqIsUpc30uMYqudeS11PAtQFTBemxhBuH4Qaxmtk2ZTY9D\ntauO0lbnOh7Nbstbv9Huv7zyMwPEHhdVJIpmQsvz5GCGbEEReVWNj2a/PRS4\nDT7l1pWwcK7Ni9ZlaNuGnFPvXXIDHTjhfrozqXW8oc1o+2xA4yzzocy+JiXY\nDR2DNwl/CAMGwjy0YSnCHCd2Iv6Rvzu3DXQ44ykI4+R0VmOl1tuUf2QjiHZh\nMIM2Srwunp0mwPvJ4botOvS1tywexu3fqg0dlIQTvWoLRP4rWUDJoMSJnbbt\npD0Wf6HqDr36cBwiuGIdNr1AVsZBAJbiwH15uSlSRd9c+HhYL3Ha62zaRQYv\nvxSYGlKYJe0sedZt5ZlGyqPmdnWHFW3MPWG5zABa7dMA2PiVJSnpAjfuWLoL\nZbr2GSiSMfbVCNTNDd7zUGNfnY3ALJKXF6OtT1ml3M4JzNRZv6UgrInGz3e1\nCv7sdy4fbxKHqDLQlR68f2zlxK4kpd9U6BZYoDQAiMVJOFMCEn2g/pUKBvwg\n705SOGoYiqbjqjqMEzCL6EFSgrjD1RdcewSEGWlctI56B1w4XqKZPSv3b43h\nj1EgsFzMKruq1HwX/oUVqoL8eYpDTdGK0D5X+kpUJHj6PSt9VUT++ASm4g63\nG2TY\r\n=bL30\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"e47522b04552ba56fbdddcf8b53434d3329da1c1","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.14.0-unstable.3068"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.0-unstable.3068_1631796457353_0.9296293429829694","host":"s3://npm-registry-packages"}},"0.14.0-pre.3074":{"name":"piral-pwa","version":"0.14.0-pre.3074","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.0-pre.3074","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"02cfeeab36746e87f58b7a5d59d60b1617637a97","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.0-pre.3074.tgz","fileCount":40,"integrity":"sha512-zquotBBnCSRGi66mNlgmKPff9Aonz5ozOOBeklEjMmcnH6QzgpGRCKrsqxWV48+Hs8LtPHUqwX02gAwDm60Pvw==","signatures":[{"sig":"MEYCIQDbmivYStn6tixCQ6khQp+ML8d2R1SjZ6+l57nOgjAWqQIhAK/6YJbAH6ZcT4TgbsiKOPcqq384DtFYyFkOBKd+WdkL","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59993,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhQ9/uCRA9TVsSAnZWagAARB8QAJQjf4dfXM4gL6lol2NV\n7pdi755MEPFW+SnmHse/7ebt2mTIJsN6UJQffo9qwv6mvuksuANOhtNtyL99\nDW72K9SXa/1bS6c+zQslNOo5uCKQXj0qP+5UXCkeg7MJY0SEOG5sPDeCRfDa\nqp+mY1GHnzu4MvQ7cHcjONLPPwOR+H56JW6JyNpYzpvTl8XqYl26Ug896Ykq\nqnUdCkFzx7Ez2gBKe3xp0QX/vEh7TFeO3BJPmgJS287tIb1H24iZ0TNoM3Hq\nb5CQH8CCmTghrpXMpLDVc/TTrSu4rTu06MfyiW1tmq8wGgQ61/H63jsvDcGV\nrkoaC4G2o73+rr3i9KuL1zfUIiX0Wtwh0nppGeRJGtvVFaS2Skk1wslXceuo\n3H2T/bAJTGOCb6r++PM3A7SxgxrHy7ii/3USsAsl8LEMRSykM37lOP5xn5Sf\nwEoB8LPYEg3tr1CaD/uggYzOMy+WcQJtvulhPp77kNR2PQAjkPLLY1zqHtQy\nvLo5jidO4yimxm61LsU4yJZ0eQVDsk0WpbXQ7lr5xVDaTLc3AxsDJQubJf5N\nsCDUJkQXTozm4KS4sK1kMGVNqbPDSikPzj3zlX3n18kmK/tfVDVvCWaMengd\n/ci6ddx9yAUY8P7ql4flPxUwRmdkTj5PKRJShJLJw2BpB0G/cmHq35Cx4Mst\nHDhO\r\n=GOGJ\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"21675a37794efbd6ff700ba06821a67e840a0360","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.14.0-pre.3074"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.0-pre.3074_1631838190226_0.5364143326620179","host":"s3://npm-registry-packages"}},"0.13.9":{"name":"piral-pwa","version":"0.13.9","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.13.9","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"51cca32a4a95f33f4c2d18b2d602d729267a9a88","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.13.9.tgz","fileCount":40,"integrity":"sha512-DjX8BTVObiUBDdAcK2U4wA2NzWBJopx5SsW6jBAIlMb84LV5HTY2yZsKTZ3zsVkpLKwT3gd9wOJXqsw30w7QGw==","signatures":[{"sig":"MEYCIQCjwqm83n5TeaDVExAEYgZEA5DlEhMIr7/adZCIohIx3QIhAKHLRwh6TpCa1Du6/GVsAAhvXjNO6IJX3/ortUPeq816","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":61122},"main":"lib/index.js","module":"esm/index.js","gitHead":"80de9fb69430283bc90f380d3254e0e6aad4c6ad","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.13.9"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.13.x","parcel-bundler":"0.13.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.13.9_1632430150573_0.9711790411023551","host":"s3://npm-registry-packages"}},"0.14.0-pre.3098":{"name":"piral-pwa","version":"0.14.0-pre.3098","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.0-pre.3098","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"996aa266004ab9e8381e2532417d097f9e77e827","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.0-pre.3098.tgz","fileCount":40,"integrity":"sha512-rqYYajkRuvYP8u+Q9BRttRLUXLhOzGn4YaXMYlCFH/XlZH7zemJtpxTEp7oJBzbYcMA2t0abTiGheonPWlKqjQ==","signatures":[{"sig":"MEYCIQDyS0ycpP/UBWlESSiWkrhndRTQPiemkrQ/Reg/hCx3wQIhAPbT05Ismwkp3J5nGnEAD4mReHiFlY5CPsp9Y3CZuWP9","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59993},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"04745c29724e25e909abbae77d5d3b29461dad06","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.14.0-pre.3098"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.0-pre.3098_1633480703644_0.6562447477991613","host":"s3://npm-registry-packages"}},"0.14.0-pre.3122":{"name":"piral-pwa","version":"0.14.0-pre.3122","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.0-pre.3122","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"957cf089f5f653aff4181ef2c45615322bec3ee9","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.0-pre.3122.tgz","fileCount":40,"integrity":"sha512-/B8uRF+i7vpqKH3p9AJWtZZTxbuZeUyCbGl7TJAWQVLe1ANCEjLZqi8V2jn9cRowPOou0t8dqhkWCNHVZDuMMQ==","signatures":[{"sig":"MEQCIDpYLHb4JdflMUjxA+h+oVupk+IN4VlBkfLBRabfCYWiAiBWk2NL1blJJD7JpWNsCFWwWPYWdBlnqfWAd2Fn59oxOw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59993},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"b1a130c01e6f7a839ec44abbd3b98341ec55584f","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.16.3+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.14.0-pre.3122"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.0-pre.3122_1634549514464_0.14864421546014794","host":"s3://npm-registry-packages"}},"0.14.0-alpha.3152":{"name":"piral-pwa","version":"0.14.0-alpha.3152","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.0-alpha.3152","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"},{"name":"nmalyschkin","email":"nikitamalyschkin@googlemail.com"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"a4ec0ee0a15cd9aa925a129ba70f60c3096ce845","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.0-alpha.3152.tgz","fileCount":40,"integrity":"sha512-7vG550insuvebQ1K3OfoH48npHOF87KSpaFOoPE5m8E7VVAmPe7UKmCDMffFzqhAATx7ECF9w/vf0hXrWi5NNg==","signatures":[{"sig":"MEUCIFm9sx6O7ZKOBS4SQ+nHT+bvVt4Y4mabfTRxFbaMRYiCAiEA+TeNTrA8DUMEyGzQ7KsLAVksOaeGLLsn59ZGIJJf9AM=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59997},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"4ad88a8b8bcdee17f22e7e1e2e8feb41df6210e5","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.14.0-alpha.3152"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.0-alpha.3152_1634821940746_0.38943947899722153","host":"s3://npm-registry-packages"}},"0.14.0-alpha.3154":{"name":"piral-pwa","version":"0.14.0-alpha.3154","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.0-alpha.3154","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"e875472675423600df663b92318cb384f8963339","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.0-alpha.3154.tgz","fileCount":40,"integrity":"sha512-rMbnQpcxKMNGKdMKUI7UuPE7/T84WjLuK9UPmAvtGt0+FbH1wYoyKDVs8LWXDVtAHeBX+b7l/3HUrvIzArZZow==","signatures":[{"sig":"MEQCIFGlWN0b7KbwWxfF4xn777TsjhuosTvd73EvxT4zlw2JAiBl79kJLNTybkLCEcleczcwa5OwEOuxG15ats+cSGh86A==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59997},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"bc6cc60a59e6a8b1a154d187883cb794e8609939","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.14.0-alpha.3154"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.0-alpha.3154_1634893248401_0.5054786327877099","host":"s3://npm-registry-packages"}},"0.14.0-beta.3156":{"name":"piral-pwa","version":"0.14.0-beta.3156","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.0-beta.3156","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"52bbf9c02943a8f1e50387e6fa8c492d72c56a38","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.0-beta.3156.tgz","fileCount":40,"integrity":"sha512-SnkNB01+qGdphWm6GRbp4FOV9z25Et17CpSxVp9uDZEbgWa988ql8XiisAFC+8j8vtbYHEnoFHdK/snn1di7/Q==","signatures":[{"sig":"MEQCIGBZFcMixXCSVInj0dkKD20kGEHA5iuRcWKpES0tmTGfAiBpwAEvfNDu7hhr67UlO22CoJq1jVcqEqeHCLfOxIel/w==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59995},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"e368a181defdfca4722d7bd478a9dcd47d90a51b","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.14.0-beta.3156"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.0-beta.3156_1634904648203_0.6516351823272473","host":"s3://npm-registry-packages"}},"0.14.0-beta.3157":{"name":"piral-pwa","version":"0.14.0-beta.3157","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.0-beta.3157","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"c2ad7783686e04151411cd035f5a5dffa2c1f327","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.0-beta.3157.tgz","fileCount":40,"integrity":"sha512-tMCPONlwm3ubZvs8Te2eJVsYcHbecxS9JqcT1n3fDctMJuhb0Cu3EQfrPTwhlaRU3Y4sjO8fijFXYla2kieaNg==","signatures":[{"sig":"MEUCIQCIDkngv6ruwhbZA3fYwh+KYrDvJqOAaU4Fiw+TinAvggIgG2DIj4NUIyyuXwIIBXdo+SKr9Yfp96+47/kslEULHbk=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59995},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"1928e46becee1444f84df8e80a81aa12712d17e2","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.14.0-beta.3157"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.0-beta.3157_1634914094258_0.9807195015465062","host":"s3://npm-registry-packages"}},"0.14.0-beta.3163":{"name":"piral-pwa","version":"0.14.0-beta.3163","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.0-beta.3163","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"26e59868ebc2f5a16a3ee1b3ac9ce738c8131c6e","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.0-beta.3163.tgz","fileCount":40,"integrity":"sha512-jKzncnT3TrFvVazY9HW41ddT6REMkgO6ow7UojGZMdqX2QV/+L+zHmDKlEXKKhAHxdn7N2p73o41RUrFwV61lA==","signatures":[{"sig":"MEQCIEaGjSJe16hPKZR63YoCfNeaWf0zj4gVsUeu/QcdKprCAiAOO8wkiRbLOJ5fQ4RUb3d1NLppGKXW9W37LFGfnZ5GZQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59995},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"ac8a8f2d0a9be0be6267afa87521b90e98179859","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.14.0-beta.3163"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.0-beta.3163_1634943229956_0.8932911044134138","host":"s3://npm-registry-packages"}},"0.14.0-beta.3183":{"name":"piral-pwa","version":"0.14.0-beta.3183","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.0-beta.3183","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"df437eea058d6fdd58c38686cf2ea5b0ecc1d798","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.0-beta.3183.tgz","fileCount":40,"integrity":"sha512-GNejLPtsvk2ByVyVOx+tJTzSL+CTM7CY3h+znd6dxpx8lUqoC6M+fH33dshupUmC+qeosfq2jb4k0uA9qQm0BA==","signatures":[{"sig":"MEYCIQCLCXoibah8veHxim0pvTYS9iji+eNEqqVhvhnvfthrHQIhAMhgDrlUxfrBtamY7U+HqDnv/PgOYgaDBZltCaTIsbKI","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59995},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"4553e585d9cbb9ebd71d032a8fde55c305aaa268","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.14.0-beta.3183"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.0-beta.3183_1635349724521_0.2617057665777607","host":"s3://npm-registry-packages"}},"0.14.0-beta.3184":{"name":"piral-pwa","version":"0.14.0-beta.3184","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.0-beta.3184","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"7bcb2ebed49ccaa24f6a7e48e4d99269d02b025c","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.0-beta.3184.tgz","fileCount":40,"integrity":"sha512-GfdxbdMmYMxIdFeGzCGKCZfEMgC4+5oIwWfax46j0zqlXOdSbTwWXZhIW2wwtjTthn8I//zDX39z647geaTm7g==","signatures":[{"sig":"MEYCIQDHFjg8r7PfXW11h8gaP5z59v5eUwYRfjO9+O2mu9oRMwIhAN8QXeJf0FtDS/+/Io0ybG8vrj9uQ5C+ZQNbREMtNIQ5","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59995},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"2d00bfdcdf47c737ffb8d58f700945362ab9ac6d","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"^0.14.0-beta.3184"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.0-beta.3184_1635379934262_0.981029746091514","host":"s3://npm-registry-packages"}},"0.14.0-beta.3187":{"name":"piral-pwa","version":"0.14.0-beta.3187","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.0-beta.3187","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"39f13c544f9b599afe8bdfa52be01bc4f64d7ee7","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.0-beta.3187.tgz","fileCount":40,"integrity":"sha512-ZOcm9bs1SM4oNCdwfeTVXA7nccNGgFGSNdWnUr610744eHy2ERCcnCQvmYI03Pysc/2UqYszA0YL+f8A6Qa15g==","signatures":[{"sig":"MEQCICoBB54EMH/KF6x8EZncemnV3qMnsQjH6E4tuOLrSzUyAiADXfq0/xyixjjT3usqEKhtBfsffmahveGbhS8IG8rOlQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59994},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"8c7afcbb45ab9fcb2dde5d8377416ff3bc86d3c8","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"0.14.0-beta.3187"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.0-beta.3187_1635415810926_0.05668928107812787","host":"s3://npm-registry-packages"}},"0.14.0-beta.3203":{"name":"piral-pwa","version":"0.14.0-beta.3203","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.0-beta.3203","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"8c3920cdc769a38a570bb7325cef8983808314d6","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.0-beta.3203.tgz","fileCount":40,"integrity":"sha512-6KO7EYe0VdLlPxLAlVecO73ielJw3mid1GSY+1AghBUfj/6NCQjc7Z1D/iO/hKXRs52w/DfTQYeB4av9FxdQ1w==","signatures":[{"sig":"MEYCIQCLdIhQWCSBRKkK2A8Uug5KIv357wVTLvCrRHH641CJDAIhAJmssllXDIfc4cFfK5DVJJkiZppB56pMEaUJzdQyr6U/","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59994},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"dc0453924cdf43ee3f8049b47f6562fc295e9ef1","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"0.14.0-beta.3203"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.0-beta.3203_1635462616518_0.602062793438082","host":"s3://npm-registry-packages"}},"0.14.0-beta.3215":{"name":"piral-pwa","version":"0.14.0-beta.3215","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.0-beta.3215","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"484c0bf29aa83c0a32f6a5c739f6e24f944e9389","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.0-beta.3215.tgz","fileCount":40,"integrity":"sha512-x2D3ig+2NG1+sQGUB9qtDDAk+4HR6qVvTh6D9Bi4hmUvztuhUt/j+iiQ5fPRFuA+Nl8o6J2wSDSfe/H1C4guuQ==","signatures":[{"sig":"MEYCIQDsAfnSaPbxux9+ORavIaXrFRZLSWabJz1vtW8E2Af1GgIhAIdqHpqMRwihTY7i/U2MVbQLbJQ8JU34MFc2GKh1LNcy","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59994},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"876f3ed398a5452dc3eac3c030ab5af4048aff88","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"0.14.0-beta.3215"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.0-beta.3215_1635540008128_0.6444822921409756","host":"s3://npm-registry-packages"}},"0.14.0-beta.3216":{"name":"piral-pwa","version":"0.14.0-beta.3216","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.0-beta.3216","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"efd2944e397d712b6e1dc8325f801840a36b929f","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.0-beta.3216.tgz","fileCount":40,"integrity":"sha512-3IU8C617ekty7CcV8gQXhfesGhgZQ2Fn36u7sG0X/Zr3XYes/ZSuQws7sgZBa25hIgTAw10RFjDkx7skXT7+eA==","signatures":[{"sig":"MEUCIEFsA18B0LNOy6aVWIP4wpseQfVBY47SYfypeLw2NFZOAiEA0D4oNd+ubkndpvQK5jLsO7d2yM4gMBs1stwnWciC7ww=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59994},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"4ae646f90377893373f4ebc575eb0b8a707f8b94","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"0.14.0-beta.3216"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.0-beta.3216_1635549919992_0.789339023653095","host":"s3://npm-registry-packages"}},"0.14.0-beta.3217":{"name":"piral-pwa","version":"0.14.0-beta.3217","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.0-beta.3217","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"860ce5ba7db1e0ead1233c08ee0b66f3422d4bd3","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.0-beta.3217.tgz","fileCount":40,"integrity":"sha512-JlByVD+DbOxdAP4uwbFP4YzG9fbOhIppNkWyBTARB75drIQ0McWYplvbFNKmSgCfH1ub7c1tdu9ihJ+9AoeJRQ==","signatures":[{"sig":"MEUCID2zCRLSsorymfNwWQsEl0mBQyTMOLowCM+1QIxLu6uaAiEAix451I2jmCrTesto98LsRdwBaiqBroLsRnOf0tbC08U=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59994},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"e91cbf791838b7cc2feda16fd8965f1f99a1e2dd","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"0.14.0-beta.3217"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.0-beta.3217_1635647879910_0.7412759571915306","host":"s3://npm-registry-packages"}},"0.14.0-beta.3222":{"name":"piral-pwa","version":"0.14.0-beta.3222","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.0-beta.3222","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"94cf7e022dd6d94a2b6a00b2770b6aa903ed8060","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.0-beta.3222.tgz","fileCount":40,"integrity":"sha512-xRu+01hddJMa1O6fgz3eEOd6KYkZZFe/oCP4+VfuEu0F+rmPPqKnwB6866JmpCBchGh60KhztTTs2rJQFnaDeg==","signatures":[{"sig":"MEYCIQDoI1aqkEaF41vn2dBs1RcO+tmc3BL5Nmkf/WKir75D/gIhAKSnlR2MV3rHeMS1N4cBmTyM4Zmk17G4SoC/MeF+i+dd","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59994},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"c3cb8ee58b51d36fd310cfdf32672ce460157b13","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"0.14.0-beta.3222"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.0-beta.3222_1635938300313_0.803411081574158","host":"s3://npm-registry-packages"}},"0.14.0-beta.3226":{"name":"piral-pwa","version":"0.14.0-beta.3226","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.0-beta.3226","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"28e266c87bbd5999068852be7bd27996f421ae20","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.0-beta.3226.tgz","fileCount":40,"integrity":"sha512-iMZTyeQYhzXOnRH26X+Z1RsuAvYt37zLrQlXH8+B7LNWlo5x5hDyWs/9M7Cn2o4h7m2ghlu4Bbgheyu+a/46Og==","signatures":[{"sig":"MEYCIQCwXe22k0QXQfywaLKBqjFaP4cS1ApSnxHtv9dzDh0GdAIhANOfyPc5aTvxPClw/OKYVG63Nr857Kfj0toZwoHoaYpB","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59994},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"9e558ea7a0f0848aa40b1c43316c120f43863d10","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"0.14.0-beta.3226"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.0-beta.3226_1636161749190_0.9035277222879137","host":"s3://npm-registry-packages"}},"0.14.0-beta.3230":{"name":"piral-pwa","version":"0.14.0-beta.3230","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.0-beta.3230","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"017a7eb6922a6f87a97644730d61ed26865f5957","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.0-beta.3230.tgz","fileCount":40,"integrity":"sha512-gIKd6kHkrOeeCJdVMD5dRCqRKVjuBlGFkBh4/Crqx3lqMXW1mEBLVzgTuB5NaJGAodGHL1xcy0nORoCc0V6QUA==","signatures":[{"sig":"MEUCIA6Zm20pnMFqRlICKg3pTC1Zzoe38LCuEYx8Tm1xMBfzAiEA7aYDF0NdW68bIYJ2qBjzyCwn2UyMLIAFcqo9Q/tNyy0=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59994},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"ef69207205ff41122f0c536a111d0ca15048611b","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"0.14.0-beta.3230"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.0-beta.3230_1636377027483_0.2205391111338426","host":"s3://npm-registry-packages"}},"0.14.0":{"name":"piral-pwa","version":"0.14.0","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.0","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"6b479e8d60cf12123fff6078e871c5de397dfd04","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.0.tgz","fileCount":40,"integrity":"sha512-oSIbNNom9iWB7+yGSX0/fiFsYoO+j9qzkNOHWeG/UzWMlP2hn0+g6We1x8N+ljARLuZiPY1wB4xrg3FeR6IkWw==","signatures":[{"sig":"MEUCIDALfy7iaBIl6oNMX2Q5NrZhEivQmI1Ln2W4NS/BAv2NAiEAxsNa8UGLCQlKSLmhCriX/n8u67D8grzN6n6hKMYvyi8=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59975},"main":"lib/index.js","module":"esm/index.js","gitHead":"42d3691018d6fa49c2dd18a0b65e4f89961216b0","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.14.0"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.0_1636394573199_0.533665989136733","host":"s3://npm-registry-packages"}},"0.14.1-beta.3240":{"name":"piral-pwa","version":"0.14.1-beta.3240","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.1-beta.3240","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"12aef2d7646e59fa6e42e08705ee3b9eb02177be","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.1-beta.3240.tgz","fileCount":40,"integrity":"sha512-Zcbea5QkGCaawHRhQfOfkGGGUNG6UEvN0yaWRfBARyLUb9V6a/5P7rCJkunpPC5FeTK7YEE3sTxySY62354gXQ==","signatures":[{"sig":"MEQCIFQ+2jDy++J5fd5r5oQpoHECmJBsygKAIJaP6djQtE0OAiB4kumRP350cjNkvbHq+eaof8tywXp641+kl9mVuLdDOg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59994},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"d3a08ece776d0834721c52fcd7a71c769380bd7e","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"0.14.1-beta.3240"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.1-beta.3240_1636511661290_0.975267012076706","host":"s3://npm-registry-packages"}},"0.14.1-beta.3244":{"name":"piral-pwa","version":"0.14.1-beta.3244","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.1-beta.3244","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"60a939b46b1f5d70e71b56d017ebe7b20d6691ac","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.1-beta.3244.tgz","fileCount":40,"integrity":"sha512-mXcw8UllR6cXqXwMBUwr1PMu5sTj0j44EtPcY0nAP41a2gRb/22PWOywedl2aWaqTzUGLIzhIz6IH23hyTsE7Q==","signatures":[{"sig":"MEYCIQDFyQWtcHECw743oZVl/jajf6oqLV5sQXVbcmydu2690QIhAOhp8SHWCOTkscViTHhfzn6cIpvR+lEfkDYsWHCNBYoY","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59994},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"358d1d5a45743dac772d437b26a875b3d98c3008","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"0.14.1-beta.3244"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.1-beta.3244_1636545523248_0.8695238155917648","host":"s3://npm-registry-packages"}},"0.14.1-beta.3246":{"name":"piral-pwa","version":"0.14.1-beta.3246","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.1-beta.3246","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"03896bdcf552fabd693cb927031c7e5815440b0b","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.1-beta.3246.tgz","fileCount":40,"integrity":"sha512-XlPiP0x0w81C6ohjLRZjdU1FI26M8lXMhWz5NPCYbb5x8Jbkk+5iaAjbPrSESHdUpBmENyxPWmoR2/4/VZTeMw==","signatures":[{"sig":"MEQCIENPunv7sc+YnqygO9UvjrtAXHbhD20X3IvDeJps/lJRAiAJlA1CMQlZxWbPCxotrbgfL3rPCuY364IfH8iVQN2zRQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59994},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"66827dfddb356079be8538bc5e8da9f253f62ba1","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"0.14.1-beta.3246"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.1-beta.3246_1636667113211_0.6950816163367854","host":"s3://npm-registry-packages"}},"0.14.1-beta.3250":{"name":"piral-pwa","version":"0.14.1-beta.3250","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.1-beta.3250","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"efb7d4592455706dbef8278ec113501d359e262e","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.1-beta.3250.tgz","fileCount":40,"integrity":"sha512-+9yAxtaBJvk13ZYPwgoaQrUw14wih5yaOu17Ylna9f3k0PBaE+zBtz91L4L3bPLSYXUFF13hEUY332vIXDwtcA==","signatures":[{"sig":"MEUCIElrRu5UyTNn57nQb9TOGOPvC9ZvwmmPsm6s01kpmcfEAiEAtfKeabs21kPuHGY+ftIqOWXFp3WxtusIUzAAkY+RQsw=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59994},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"e6b329deaa798ea0b9287fbb57be8f39973eeac2","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"0.14.1-beta.3250"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.1-beta.3250_1636730508914_0.9872140291681095","host":"s3://npm-registry-packages"}},"0.14.1-beta.3256":{"name":"piral-pwa","version":"0.14.1-beta.3256","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.1-beta.3256","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"9c84dd748cde8f5cb001c0cd47b2e73993a9cf54","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.1-beta.3256.tgz","fileCount":40,"integrity":"sha512-Y4k3KY14mHGyUURHe8hFQfT91BkIFsLeKUr7hsAUst46dCgZiZOSV93o0vxMfTjUTCNUuEsZ/KHlGk3S53EAbQ==","signatures":[{"sig":"MEQCIFDiV6vkVxGmGoiUYwFyAu8hlMeaUuVl4GIxokAWoO2LAiAaVOVAETIRuNsQDMn0HDFb1sPUqiO7Pws8kDs16KDjog==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59994,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhk7lTCRA9TVsSAnZWagAAyOEP+QGi50NxKuvAWBMbior8\nC2k64agmMtP1XENDWDdLaQNFK9NitPWg+kb5FrgR55kJi1pWZ24DVzSLAsaB\nHHCGt2tABEV5CcQAu9QCouqm4UWp17L/gSIhDOArF36FPLc4wfAKTUOs1QSG\nDnNfr7Hv9php8piI7gLjbfzTkLBIVXm9YJ2SMeIQp/JURO/Ho16nEJY/FWId\nw4gaqz6mve7VexwqwWgQ1d6/eTebZddrgNlkBSolNDSBXnhIHOPZ8BCQ8o87\nqsOk3vCp2O2Du5E6w3aUgx/DhHr1e6McBbMmoj4lRIUwDIRcKKmHD/Ct3Yfg\nECHMekn78WRZfpP0gvIksLPTxlgIP+xQ3MMFDXA/3/fd2nElLHLCh+kqebm3\nEUk7poLZBDexvHmJiKt1ntIWuSlAHMhErnpZQodBMXJ6cZrXiC+2uBFbeklQ\ngOPj9UYsMRxBVzakILu1XLFWe6LyKeh0U1HPZT8PEVLIeUVSO/ZnaUTAc7Fr\nnK3gEkZ8TzqDGacQ1knsT7Wvhv1HpwSQGyjK8vQAanZUPC/AoTtYqRNOAaSW\nGjIyqdL2vZ4vjNf6ZbEMn0tI/vVWmzVtEwmTZyEHS993RCmrO/CYCiCBiu1C\n1g8b4BYJ3WX5hckMMvzKscQLeqyZaM6rKaMNNwjd5niuYNTq6FV7cio/DC7z\neZ2f\r\n=9Mxm\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"4fe700c9466e6c3920546713e911fef36c311b52","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"0.14.1-beta.3256"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.1-beta.3256_1637071187608_0.3330182788485745","host":"s3://npm-registry-packages"}},"0.14.1-beta.3266":{"name":"piral-pwa","version":"0.14.1-beta.3266","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.1-beta.3266","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"237750a1b885a77964ccb3280854e72196781b4a","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.1-beta.3266.tgz","fileCount":40,"integrity":"sha512-CFXjXAhhM26+b+eBDan4zPgg5/XhESaHvTpDdDFMMAHQ3olgJ0elRw2zfw2UCkRaOuSrRZTmsIX5ektxHrF8FA==","signatures":[{"sig":"MEUCICKCxuM8akbb2Hi1jksZons4HPtujk5bLz6rzjfdT9+FAiEAnjnQ6nvmERnUH7InkwbbrrwifzqDag9mV+HLmP3o4X8=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59994,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhlmjYCRA9TVsSAnZWagAA35YQAIOymK9bvB6KiXahdTCf\ntYCSQzLwB1I4z1Rap2ej0ju0nCQoOzZRc7OzAnqT8Z/8fLRd03bwDL6oH9dX\nZ8NkPZWFiJbnuOJvhUNakMoW2TdUHQljPWoTtdqmyNZY3GBxzz8Qqa2JltbU\n0IuzEVoi4rJ6haKOMPLC30+kfl5BlVNjwdbCGWJGngeUtCwHoXbsumEkgwac\nAHO88gfeK1SHQ0iRQZuNqfbP+DywkA4LPo8pvglxWR0Wb/5tlYmt9m8fpgVI\npHYgIvoGPKtoihcF/QQ2wnChBmh34lVNJAse45JB/bdPLLfD5gNwXLMiybrl\nLN+ge9Z2G3aw5SJeE0qmFBTsKgcd3htnZ+2TWO6MzBQ3klVj8ImYI2uzQ2jR\nXAjxIu/9fPy/7r49sQCD1GLJN0oenqoT7fOR/3pj8Wwpzvg+9Txy4jpv8d0C\nDk1e/dVV4PdE1GAJ9X3AvA19ne88+a04yPTNhUUKe9tF3qk1tc8AbzEjZXbH\nRmSnkuwBXfTNBevneMy0dH/zF6J2i5phINZXoBAK7E/Y14hMIVMstVDedxTM\nPaxD+6Fku/h08jVRkS9CaOYgIoNYCkD+0Qv8Q3mFtmn4dFIIySDTNtW7llHL\nNsC8z5ettqvyHa53VNfzTt85NAXaq70sT9y+Q0uoNeOt60/0+Os07kvghRX7\n96E8\r\n=hig1\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"9c4d208eb5947e34cc929ce1613a8cb2dee0cea0","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"0.14.1-beta.3266"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.1-beta.3266_1637247192335_0.13054210247927056","host":"s3://npm-registry-packages"}},"0.14.1":{"name":"piral-pwa","version":"0.14.1","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.1","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"690fa304e030441a3512f8e07f9ef66485e2c299","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.1.tgz","fileCount":40,"integrity":"sha512-eqXSprop93ulMaPexJ2wbAqPl1Qxw/BRVWSITvSpT7HoDfnujKGPdvfwnnwRkKNAL+FzlbrpjaUsDbii5iuEcg==","signatures":[{"sig":"MEQCIG1r7qTxBtknXCj+kXAC0MnzYanbUg0/pn9MbKEVQT6AAiAbqpetFsF00feachcr9TETyvm/BXRUwd6jou3mUJtqYQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhl6V9CRA9TVsSAnZWagAAdFUP/3A57XLCOenYo0sloQh1\nMAVfpUdEzMuuKJt03QVcTpY6pjUs6tyu9PN2J+Re/Ny69V3wCrAy0BlubC8a\n+ShUC7AIIgiAhWb/Y1SqGsrnT22jo14WviMpm36nDMLeitpxMr7WlG7vGN1N\nvmkCZPvzgY+K426Z8zWxRUxAOV/51HKz3tkq9bdonsUKQPmtJTy7kWgR91p7\nBGx1CD7fpa/G33Czr8O0U4yKCVfG3FQZU1cqDYb/XPycP7XBqmLJA2nCGr3+\n7x2QAtdK9oJjcLFjL6FWKezi2qdTV07THkEbDvmD7JQ9Wg1cmk2d6zSNse3B\na0PT89PF1QKJvOg4z2kY59IabbCVlpefqHeBxrZKi0ynvTza1kFEYMsP2Dh9\nyLs/ifuLIpFpn9cSanndHi10pF4lFZIdytXOUx9GuTPNrNZhy0xGR7tXrPgs\nIVuvPxxrb789MrIwLhwyem/1lcd9Mrf/KWrVhSiPc+9TauFlMKUkYdVicUPh\naccFHreV67PnwyORU2x/qpYX2xXL5L5b+5fQDYzA3XmRRaEUaniq4RoCbeKg\nPdgXgpJkD3BvhFBkCOIjmEYN2GINMZe8SGZ1cayyN3vNQSqUgwyErD6RZdI9\nAuzVVKrOt+7LcviAd8TqOWDb+/XuQwKMLS0HkLzsF/MhpweAuIQ6QT4k6u/T\n62Ab\r\n=KjVD\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","gitHead":"510c86441c19ffa3e8c862bfdcff73e93c730960","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.14.1"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.1_1637328253673_0.11231353165783653","host":"s3://npm-registry-packages"}},"0.14.2-beta.3272":{"name":"piral-pwa","version":"0.14.2-beta.3272","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.2-beta.3272","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"ea4310129fcbb8635dbf28f4918f522bc776f1ca","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.2-beta.3272.tgz","fileCount":40,"integrity":"sha512-QnHqI/WxBQ3SQ73hlHe1vH1mvV9mDYH/BvBTkg7YNfTPmjLguuf+JAuZwvMhi+IOswSi+x6jxUSXnGVyq54zRA==","signatures":[{"sig":"MEUCIQCzi1F3dY3RMY2Xum9Ax86UsuQcIDwMXvary8ZeNALPkwIgfZrkQslZP2sRioZ2Dut4nidOcLortpBrlRejoKTZ+vQ=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59994,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhmETxCRA9TVsSAnZWagAAMucP/Rta3TGKimdz1MoFO725\nPmLx7r+iMXXj/y6wkDwa+zqmPDNln9lvHnKykkL//JHElko9UFTXGGG1Ibmq\npJp2aDYOfw3ZnNNO9S4QN+1UtPLQvwO0DhD2wpqgLP9e0bq9oUoR054SJpWG\nIM9eOam8P3sd0LQk0zJjnNqTc52Vlk5NflwqLvfIi45YYoHz/GrI1SmbeK7j\nOL30xkGQIb9IJxrGxvAMQrbyA07vZ9mTtcyy/gXUdLgftqcHX6GMnOzQpdYi\n3pHb5DrKBjeN3aPw1np5ndxnpviAfJMloJboqpeYIxbOgnebVR5WfczgB0CB\nbNGTNs7jAjPXuy+VXQpkheE1kDJoWA9YhNPKUnoQu/JqytabwR+7AyOma5IA\n/ywD893wZX2Fmk7tUiSN9U4Ts1c8+/+a5puDo8cZnYs3UpMzw2LFhBPFgShe\nJdBdCSDzH2M4pckEw4qazCcVGTnFtzTZhYfQUec2dKSxEQWScmqFmWVitMpv\nuMXeuc15B+y21MyKYZDkQpXLEjKpEV4/G2/LAdjwCnP6tgEuHIkdnuU/0mz/\nhYvHgdKDoF4DL7PBfP5ynnizwqeTV2JQ4trBY/2JOs6BW9Hb7tK6q4EKriZb\n4bO99dpHSSgIWq6u9GH+Fr8rwrCXc1dxdv+w39fMfSyUbcb4yid30o33LRyj\nKyTP\r\n=eNe9\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"06d1e9fa163aade40f9aa1f0233ef1266c5115dd","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"0.14.2-beta.3272"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.2-beta.3272_1637369073427_0.1306213137885659","host":"s3://npm-registry-packages"}},"0.14.2":{"name":"piral-pwa","version":"0.14.2","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.2","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"2c41bb8a9a195d8906262eb7d08c599c82d494fc","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.2.tgz","fileCount":40,"integrity":"sha512-nv+RZbp+fNy8RdXwSjO+N3PMpEYXXOMbzGY8MAHI5sedZIgjeDOkPGSGC5JhXQztRTtMq69RjirejL12a09cUg==","signatures":[{"sig":"MEQCIAb24/LrjmmKkOZJbaThIcT1JM8H51dSVpREDvp2rWUHAiAR8E1V/1UFnqc60UN0tVIiskQg5mb32PODbcPnmG1MdA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhm6aeCRA9TVsSAnZWagAAhVYP/1GYKvM8U2xuy1iW2btk\nSsB6bOb+rV8Mej00mSKwOyO21pZYlyi55MNilIqHM/D6bCb2Pb+9Jh/kFBv5\n5Apf9Qy9/LxeZC+NouIZ++/bmlYGSq9bnLFjf2ScAt+5HeKB34H5wnfxSf2/\nqSWWcPmYKV0lhwj0rIwZXjASr20gXzqLU6hLp/c0nxlsBWWTiQlroj0WVqCZ\n76TAuvuJQTSImhBM7NRp3/xGGN0eUpy0WbfE1meKh6UmEJbI/+jZLRi4un6T\nUcqI6ZoEPofj+Rx8DGotMIEUIVZXYXTJy4hLTVF2kM0j9SI8ZK2enTFsO+9r\nVDJ2Splyz2tVF+iEcnux6VtWoHI6HchkL6qRQVoll4WfuIsf2GexzKPZIyBm\nh74grrHOkhEzIcQkrAkHrhZiBaD9BcuSCOVaPsF0XQ1iGNTBlzwGjy1plU4y\nT+bJYLtv6ihDPH/18pRvmSvR0x9EIVaXEPV9kc+A9YS3WUvLcLqWaeyf8dsj\n1wD3yoxh5snZvkLg4c2hPDD2sphYzWdDE9aAW72D8sqD5Gk66aopyXzB4G/f\nldK3hNRNZ/oNKn5C2HiUIjNBbfpn4uPD/xznEKRTBN6RjOZKQjnpxrOUWMiM\n37Oa8d+xg18bWMZBBDBRUsi2KqJ7iMrcB9sfuqagmki0C3h78AX2YytThBKn\n8dyo\r\n=k72c\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","gitHead":"eaaab0f56b872802a70d83de27a77911af37ed22","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.14.2"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.2_1637590686536_0.8787811930536924","host":"s3://npm-registry-packages"}},"0.14.3-beta.3295":{"name":"piral-pwa","version":"0.14.3-beta.3295","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.3-beta.3295","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"c273fad15f04294122daa8ded15a4f7b476c9221","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.3-beta.3295.tgz","fileCount":40,"integrity":"sha512-qJDX7aLRoZrJ+QdtHXDJ23j3jA4VGoORdQxBiN3w7vnjoGgykWnvalFA5osMYEy5hs8YYceVGyI66v+a8fdK3A==","signatures":[{"sig":"MEUCIQDQgssiJn3pdmihkz+LkVzXcEHTNN4sOidjMK2SDTCF/AIgAdS3iJrcoO0q6weLB08XO7WAPQTvGEf8Gfm2MhcNqh0=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59994,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhngtMCRA9TVsSAnZWagAA/70P/RUaPYjowbpbWfeRdPz2\ny73bjJjv+ePZhGYXG8oLYOVhG6+bAy8zUMTgYZcJFSxpysqp2vTAZW/mszKE\nX1176igLv0WaFy9xYPBEjQr+rfhU5hcOH0LNCbqomAFbEyNp20x51MlGUWjF\nV+oD7HcLRvzSPRJvdl37PnEMmzwQcFU5/ZX+QikNrpwflW6z5zjD5pBvYXv8\nbm57nCB2bjYVSYqAnTFMBHZhOmwT7EnY6Ly489DqxKNMKepQaeYl8ZTSmnox\nB3iNa64SHdiuhkvpV75G0vFYEfLZhFMVlf00QTeYiazh5K0p7ZfybEQsBCqL\naFiiQncvO22XSP/7NSeCKyA2U84dzsXK7vwmAKmzknNIQsclA62Y1kpx3fns\nqwz/Z8dMHEl0rroKiQXluv2bnsVZWANYh8uTDXF/4tgEAj0+pFGvCqaa8y8P\nKCrBjhoN41CoqCoVxWE8YVUvAUe/G9EhopWcR1g/wQjD4KuZepCd7C8FW/eQ\nvSwV3ajpSXNPjKqIy5cAmaNFl9KiV+O9PmPrd1zHrHJT1cpDNrvAHVtyawJ9\nECITX4LkRwZaZR+GwyJSLinT6YpBT3CwX6XsgLoE+1r0gDEp1kUyrYlOhX8Z\ng9A6/1efEQOsNK0IsBXxO2q5OnU1kE52VttKFuRerCdx4Ep/whFVZeD8VDt0\nCPIS\r\n=xUkB\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"699a617d9f89c76c277feba775da285b99cf370c","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"0.14.3-beta.3295"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.3-beta.3295_1637747532837_0.8144821980348569","host":"s3://npm-registry-packages"}},"0.14.3-beta.3296":{"name":"piral-pwa","version":"0.14.3-beta.3296","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.3-beta.3296","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"03ae67f50539f18208f39a26600953e85f533f05","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.3-beta.3296.tgz","fileCount":40,"integrity":"sha512-lmXHN9eMPE8LiHB4lNkSAA2JJRY/6KQoXUHwTyteWuAcLclTs15ekx1dj233yNTdMYoaBgsk503RE0Mp0I9D9A==","signatures":[{"sig":"MEQCIF86Q6szNKmRv8fi7Ps6wZw0RpMd1Tb3mIf4thRsDeMaAiAr3hKwSc25OVc+B3s9XuW8gJxUiAf3DOm4EQT0Wytskw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59994,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhnk0VCRA9TVsSAnZWagAA/RMQAIU2DVe8Zm6MVFQ2/SJR\nLjzZw2ItTr0xKzrppFBTb9p9z2jfzki2e9RP0gKYZPu3ry8YTVOQ54PF9WQE\nwE1ETzoZlDxvbkEE0FJh7SngYR94HJkAep8pHOwZVuN8ihQwsXuJH11OH8tP\n7KSKVJLGqHeQd/UUXhvTDqoxwZSHJeb8v1ibcvfFhTNlg1sibuXuK2OQDSNT\naYNFjOWLumEgp8bhmVFcmJnwSEz+na1tiW4p758o052Q5Ekmu7m1i6CR1Yqd\npY3gZly9DMo8zm6QvJXPrizZnu3Dq6JD32xEBLsRst9f7tuDofRFBLe7ozQ+\naxApDMrZTxMLVuiD8WxKcNRmar6/w1jEUb6mGQm5zTAam3Uq/MgJ1fWIKt64\ns57MktiXOXWvJDPoHI9lUxtd3zyBiP6weGAfsoHfQ0YfFuOMtZYqFJcUECc1\nX2MfMYfN3LsCL2WnYQOrM+RRDsezoB9yO6FXcnSyWOVD3iAagSUoF+4ux/nS\ncuYOmPMQ0v3DxAbXqA7lSp3+7TIfS98qI7Mgho+buslWb/548L7yyFdjsdEr\neMCtPCK2ghC6E1+5NxVeZYD5/RayK84nRfytnAMTwSzY1mau/eudziJmAc/1\nLTYTPRT0Xurjb+mYHooDtlHguqKyi3UT1FRd7Ql87jbu3PaLmsglIf33nCj1\ncMu9\r\n=nPdg\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"b8a8c6e0f21e4572f308f64299d1e520b5b553b8","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"0.14.3-beta.3296"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.3-beta.3296_1637764373536_0.020943647823999934","host":"s3://npm-registry-packages"}},"0.14.3-beta.3297":{"name":"piral-pwa","version":"0.14.3-beta.3297","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.3-beta.3297","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"831ab1e60ace62ef8e59edbf65ae8a479b642252","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.3-beta.3297.tgz","fileCount":40,"integrity":"sha512-IQkWuT+HmlyDw0L39F4eQ6Ni4qi+1hhsTwd98sGxjz5aCa4bgrqm09gbpi+MCItUex710zzDJKI92MWcUTSwZg==","signatures":[{"sig":"MEQCIFzGJaOnDmsMiD4ouRhDYRGBLuw16YEIDGxXD4dhO0gzAiAnFcRa5deV6kmZj50NjVfMutHdXqwFIsy/khBgvsyDNg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59994,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhnu6pCRA9TVsSAnZWagAAyooQAIz3ZOZVQkNUOdiPEN10\n9QtfSFHtVX8Xtjw0aZkssmRLGftI0Os/76KDdP3PaYCHVuwz//sSNjZYCO2S\n1y/Zfa6EVLjx1rlqAntFOEt3jRa6qd/dNpZA4V1yTkp/2XJlCKwmzm2Z8GBb\noaK+4iY58G+2/31QOOgOO8/xY3tJ2wqVFk1rp2+XGA5ALQtKblTPDRA7O0ck\n0X1Qh2VnjAFq0oHY+UbnkutrRbp3Wy2gDO3K9WcHlOqvgyPbi/CZ2pnltkrm\n5LXSWAgEnaGnjtdoREYnsQ+AJ25DYbywjNs0ffm1T5IHi+eGQOe/xp59Ggn5\nxNvsIhYyIGkH+cz5UEeEX3h+0GisbFNRR0RFZwyLSodl5DJrI/zfV6Ec858f\nV1vteN4MJ/9uQbwe2jkpA+EXuyfI6RNJO2u9Vx5OvKXnuN1yx9qFdVc0waXk\nUhKvZFVYum4fcOncU6Nz8qKZggyfif9ZrTBJPeuV4zEJzq0UakUvWb8TBp8G\n62O7u2bg9hPY/Jt1dwY+tLOOWpwSsUmYqb1AmMFGZ2TGj5gF7ky6IlYKLTH/\ncroP93Uth0JiIX0W/29PtZYpfqDr46aFQNqmE1SQA2TSzT9tjjeh6IAyxzKj\nXSeWDE9fVkDS8WWkbA6PZwgJMtezeZkoc+L1kj1+AkXlE8mjQbcpF2eoQVcB\nE2eL\r\n=Geed\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"42d5359bb0a4d0d9f3bf27e8acb205419bb4cc58","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"0.14.3-beta.3297"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.3-beta.3297_1637805737016_0.15105246937885086","host":"s3://npm-registry-packages"}},"0.14.3-beta.3299":{"name":"piral-pwa","version":"0.14.3-beta.3299","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.3-beta.3299","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"7a52f0189681400f715617f73019826a2071b04c","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.3-beta.3299.tgz","fileCount":40,"integrity":"sha512-+iGILVeQHTVMjEyzXMFIZEF60RCrhtM+i+0UO/sY9GRAcjGp2mSjc8hz8svApn3vHgU53EfHaSMeLwzd5FBvcA==","signatures":[{"sig":"MEUCIH7Gqlpd6xWlue3wjmJP806EejoeNc2k1oKb24GDuYvHAiEApsw8fwikep6DY3qQJ3pWQSEFJ7L7RI+Md+DTI5NgRF4=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59994,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhn6VxCRA9TVsSAnZWagAAzGcP/RXg5DfsOq7IFfILRkjr\nay6uIXcT0JCb8ZShJTfFjYGMdI2PdGsYyhIAlL5T6P+vt+iOgQsUxTzeVcbF\nhbnMhEiEAqX+WsWuKeEtg4/GJid/NXkkuGQNfRkOJT+jdICGsKuvrehX86W2\nY+4JnJUz78aQhHzCSJ/VM6Fv1yhc/F9Eg7DDcbgq88ChqpLQYxV8h6Hj8zlL\nif+si70Y9qzJxE3Qk59tnG2k6waug4jibHD8cesaJwqHaqMxpGLnhaimO5YZ\nG31/RDD1hjjre70k4xECaRq9KI0d9s2k4O4eTbORblXlm3dNtoDojBJ235H6\nYNS4FsZyLixRidh9Lw3siWZ1Uwon8Iw8k/8sAY8194I9/afFVCGyuXeHeLjs\n6haO8awAm2mNIHPeupQ7qQYJPlYEN1Im7HEU3TiFCMaWHCra7CVT270m4sd5\nWrgJi0g3p3Sq73B9emnl906LCzqIQOhybWA/AJPs/irefpiPx+H/Z1bGM+y+\nqFzBziK6Ls51zlk6w+60Ca7/r4fDj2mJxqgRdFmCxWrVkdoqGNbMqsb4SRnQ\nrg6KEpBs6HLdAyR/b37buophHjeuaLMkCCEPVV2hGTQruoRi5z/SuEKcGYDf\nsnoA3yKyyc+l6o8iyxAYfUBiNX0qlFHcCfKUDS/agJqP2Yh+IOAORijEXM5j\nsqdZ\r\n=7M3z\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"2329c97cbca23e133c1b432ead68964f6ea411f3","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"0.14.3-beta.3299"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.3-beta.3299_1637852529432_0.5530124533889369","host":"s3://npm-registry-packages"}},"0.14.3-beta.3303":{"name":"piral-pwa","version":"0.14.3-beta.3303","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.3-beta.3303","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"d3c9293fc3fe67d6237d447d062d423772cc4654","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.3-beta.3303.tgz","fileCount":40,"integrity":"sha512-piDe5WlV6ANE3IMSMJA994yaMcJp/3M3BCWWeCUv7H4xcvsl9oLAyCLmX0bKADYYDV/V1RA0mWm6WJGVHYNNZg==","signatures":[{"sig":"MEUCIHbPHKccv6OqaHPntF8dYlGPomSgTbt33RIx5Rkz1GaMAiEA+QHJKll4qrJHyEhmUfHLr9Rj6m2zKuXGzBKjSsITk8k=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59994,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhoDdZCRA9TVsSAnZWagAADJwP/jYuiPH5gowU07UMkyKe\nJpLwI+D3UBrOGPSHBS6+9NtHLWhdnhyI99JfRKl2F9fG+dey0PfmKIQrTt1P\nDuqm0/uYJpGYeijQQ1PBTKZGeMQ0zuiXMY1wQjzjMWAazW9dFE4oncbayYt2\nmQLGjGokWahz3TkClgoH43j5K0agepv5sUzbP4oCLbt9bJ1q/02a8koW4S5p\nvbyMK1iWuMWv7yofe7g4kNrHWeOyLUFhd0pVPltbM59GJsQaFALy0X6WxSZ9\nOu9WlubV4bj4nlvrNTaMhDyuIhEB7aGrc9f1Y0fySJ+oAlf2Vw2RlWvlYxFA\n1/oyXQeULKrs339/Nv0odUhgEAQo4WCG4SvNckSba4ldjg4Xofw9L1MBCBQ6\nxxXJ52/q9yHTUpNk4mXGG+JihTA2ir2XrB/NXo7hSXn25Ep2VnlHnXH4IBtG\n0zFOcd7iCE8BuZmEVwQetExHN8b6nhZD3AAyaRMhG6pJRKzb9dEcZhJtwYE3\nBDNF8Z2CxhekvGXwvWijYe6R2/C0zlb7Z3agUii5jROb85jUQVofs6Lvtq4i\n+/3+1q91uVuQMUcdQBl5Kr3mpKhokKf4jcqg1oIak4Yhdji5P0oWjCRVevRZ\n2Mt6VT98VjRSD8btxwb9H+PWNh9TQ3MGDv0PWFTS3216wa2VCBY8Gv9DjADR\nwYn7\r\n=XCzr\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"da89ec453fdcf613a0c68ff75d53d47a052ce356","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"0.14.3-beta.3303"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.3-beta.3303_1637889880930_0.49267391112178305","host":"s3://npm-registry-packages"}},"0.14.3":{"name":"piral-pwa","version":"0.14.3","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.3","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"def24e94189e89e31de72a7032390bfafc7ed734","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.3.tgz","fileCount":40,"integrity":"sha512-m07GavVxex3GdLJZHX96XxCp4tmzv0L5IQIcUTgDhXQuxy3LAw3Ty3cmZXcRasZxyPzHb+4P7ff8OzLEM9AE/Q==","signatures":[{"sig":"MEYCIQC5mWsKxIcox1sAmEXdGZ1xWhrkna5Q6pVGuEH3iGA4cAIhAO0UtpViRBQ/Pn8mbxfOpzYUcoLBKuHYBGuaoA4CYf8t","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59918,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhoLvHCRA9TVsSAnZWagAAMk8P/37lmP0MtSsJkiCGlyMW\n0mxYeaxZABE0HJuMC64anVE2qkQEPqcM58UNwKnkCj1ON4peIxrXT7Ew0XSM\n6z3yWZP1GmEU0Dpqo3GC0A92vLfSZ5/raBRkhdYaSFrvs5IpfSmC6w7x3Kpy\nLKDlwEHrS487GeaxTKE07Y2V+9WNBnJBo1BGhsibbIwjeTM4FLh6K5eKKLqC\nMl05FBABDUL3juaqOGN7BanW6YdGZnqFS7gFg2wvE49fW8W6QO7UAYV1bWBq\n34p5qgMC+hsR3zxb6HLNrOuPwXVyadQTVWCQljMKLSO+FzDd2DT3Fmck4iFJ\neLuzFus1/25+q4DpVlk9HqBLtEhN3RgTpw099bEu6s73cOvot/ak+A/bHWs1\nByik2dTKN5tcsb+YcIxELpLu2nDUvb4AYxRwUr2E3yxbTZSwFP9a6v/CEDa9\nMe0z0OYUM803OPmV5CtkryLNi1hzuR6mtuQ+yk7+URO0TVfI3yDk04LkzSb7\nCADtnctBg4JUkcJk0oOg03ASsomtLv4i0SX4q+Ozu4Mx7+9NxWej9PQYszZ3\nyioEz+vlUoMvvKQU20kZ/FHsJut0OkFBHY2NYuwheuPRpOMW5cC0yRD5Gl38\nD2wmjmog+FB3GZRs0Z+4qrOJHSsx0JPO385lKNt5nzeFVvuIBnRjYnpbKOYN\n1b/X\r\n=z5Ia\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"6.14.8","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.20.0","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.14.3"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.3_1637923783738_0.6034839209868565","host":"s3://npm-registry-packages"}},"0.14.4-beta.3311":{"name":"piral-pwa","version":"0.14.4-beta.3311","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.4-beta.3311","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"3f74ce9f9f28e7916a5528b4f47d0895856ae7c0","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.4-beta.3311.tgz","fileCount":40,"integrity":"sha512-WyIrOTMpYRyPunjw8lr0tLaS4VmToeRBfK7F18A4xIOtfE2BclpbTvrMryabHZ90F2nLVJC5+HIybV3UCj4KYA==","signatures":[{"sig":"MEQCIANF3Shtubi8K/Moogh9jvrY2uMQjUKnv542gYptzaNEAiBQYTQGXaWTYp/jAk8sqFIgfKQFY28yaZrhUcMOMNkmcQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59994,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJho6Y7CRA9TVsSAnZWagAArU0P/jCcRULsXMiB5Bl4HiYd\nArE8G6Rqh03av73YbflaugMCZMX0Ji0G7kCNmhH1vScdLnRGNBb2UvY4vqHM\n0OaQlqGMtZBbB7Wk4/t9cvBkayVq5MrqjmR3NUtVjfZXNq3HIKpvPshEKqeu\nUHwHyOOu8K0MdbtKYvCgD9X8CTI0BUQDcG6qzg9tBiA5kcqflkHIplO49SWo\nj6/n1GpHoJSx355q60gmxVVqtuQIiESdLDYI+ZHsdGOmJhegIYxaCuKFHDil\nTdZuIdEqnso6VVgdbH0Dwu/616MhQ2JGLkSr9p+0l12zEsyz/YAReNvzfZeG\nWJESnIzGtfxOwI7UyLygfH6EA/UA5yCvms/FWtNxQmWx6mZmHeA735cHfuCV\nANgaSMXn7GwiP75mc5OBtWIIX+Wu2h8WtogD1kmDXRFdp9D1SKyRexqV0akX\nxWeXgLZ0Fhs/6a3IAwm4MMkMTDU65LwvPzg/r9qCRX05uUr+5WI6Vw95aOTI\nU74NdcdwgfTE2rhkq4k0C4likBIvqaHoqmTWwSmR4mrSDWAWtmyXKE29msJk\nnIVk5O6RKYL2bBurE++kOf1qEeNI610f3s5hIwNPpnYuGDLsl3jN5zApJkpn\nLHTyDaFaBULdSWcLbm/qesBd15l92U5QTbPDZEd6xODSyjiQlGcDDjAlVmj4\n9ozA\r\n=IO1D\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"c2e4e413b6505da88b6296efa694b3b96c11f77b","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"0.14.4-beta.3311"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.4-beta.3311_1638114875632_0.3920557109522984","host":"s3://npm-registry-packages"}},"0.14.4-beta.3313":{"name":"piral-pwa","version":"0.14.4-beta.3313","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.4-beta.3313","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"b4e86239b5181fbb6dd17118ce7a155e0ba41e45","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.4-beta.3313.tgz","fileCount":40,"integrity":"sha512-jGNDSL1bwtRUs8hhuw/i4eXTGDc+s0qF7rHDvUOsbS600vmZuPb4KdzqkzKJdz4xCqGk+DBT5yJbV8Z2KRajbg==","signatures":[{"sig":"MEYCIQCdpwJhtHit/IJqgza1ouzN3+HwU09OdeXrc3a66imO5gIhAPGrh2SIKk1ufwICHemW1xr7GHfA6Qy4fipAhZ8G/M+A","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59994,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhpQ2yCRA9TVsSAnZWagAA4okQAIkHFpFuku8Rkw+CibQg\n2+5KIGb5lWAclXFnNq/b6BwhkPaNtrsK72y9PQ3FO80jKUuMKgY8XRIKhhQi\nMkJRD9qT7dqqCcLR89tAptGl2HARZCTWMZYYQD72gsLIasPUy8sj7Rt6TUP6\ngU4WSP85xiU9ipQojgATit83FWTrg2gkr+GA+Qc1tXRYcQK3p4TlguoHjy8A\nB/ArBOBLqidUl/dJtfD+KPOtglz+5RcjQOi3Xzu2U2hsdbQ7744rPsf6nZ2k\nb47zvasL2gPzlxatbpJuhNnU2gDKSmnu8p3/gH+5FhYbr8jFA88E9Bfx1i4w\nLLMpGetjll26qN5gt6iSEMBTPRVd9PdxFRVwwUA/J1gEO71pIDpLmmExwEsI\nf11i/e7GGV4cK3qAEDYPb6EnXjYYO4YgBPgIPIRBRggVHf4wYLa6ssn+jorA\n8CZ/rGvDaUKab3VDA08vNJcEgSGP7w1hXz4SImeYDHYXpYthbWU5xbPlzZmY\n+2ZDW847B7IVLePDXAjOetgySBsdrrqe56sw3axNO+L70o2FLSqG2hk3D+7L\nQgrwCJLBzC/o6dRwSOmQFXRVYk9JKG8MJ7lA/e8sAy6qVXUC49WhCIIsTyOU\nb/NgpA5ddxyyPCYuZ/pL+KZiXhDWbXxtOy8Du+W+7UXu4b/YP0JCzA/1J6E7\ngzWF\r\n=YDNV\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"ab1a8f12eecbe2824fc7fe9b7a9acae33a91c0fd","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"0.14.4-beta.3313"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.4-beta.3313_1638206898499_0.4975584094859218","host":"s3://npm-registry-packages"}},"0.14.4":{"name":"piral-pwa","version":"0.14.4","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.4","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"32d18ade06e49338d72e02822da403056a21c8d2","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.4.tgz","fileCount":40,"integrity":"sha512-0fuS+B+SC5Q4ujp3k9MkjGH7UJ0agIbVHdM5cmkF4do6st/hQhTw3Aqns2vGa7EPzJmewB8Ccmkit7XUO7bu0w==","signatures":[{"sig":"MEUCIQCpXYjc4oHvyrxGFsAKqlf4V37cc+PF4NjOMXw7HfyOOwIgFev6Jn5u4v1w7ydpZM53z09VJwnNyuaEc3EZZ5wlLEw=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59975,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhp0O4CRA9TVsSAnZWagAA+FoP/3WZYpap4ZzyzqPug8Qb\nxdgh69BV2gOLnERdEbqC/92NLNS9WzK41k81vWg33W5W1Wxs1Amo2jJ19DUf\nuNSSBWsdk4azTjIVTZmJMIwDUaelXkfKEKy3Bt9MgVz0+hWgY23IwC2MhK8Y\nV44IpXtBtvOREsUp5LwzgPhes2vKKPvgp3U3KoAPlwwSLcWhcFsMECbSLxX8\nF1uXokFAWWo2R4KYgyHWa5DlofA7+reFENSMbt5y49PGkNDYAPx/T+XexJ7c\n4k4nXy/PnwnVfeoEw6UECg1cnAo48LCCp6dhMrMgZp+N26kGwp4ItmjCf7Vk\neuTztKZdqtJ3/UBJTWlJx1mMxpkO3cxTU9GNSApYQYd3Nuk40JjbwyuNo2bq\neinjXEgB1mzz3KY7d3/ueFuQuKA6hWNkjuh84XAwnIu/ra7lPx5lMzZO4ZSB\nDn5TOuPJlk4at7mxA+0OJOV2CWq8eNjp+G59+WBlZrIE91qqEekmWuDlNczL\nhhHUbXsYfaiYbGsRd5ammJkLbTgIElUqG+mrO+h4Tiwu4UdyyR3+BSnQandg\nbS2EHrG+uDiDdk14zbu4HidfWVQS4GCE//VTb/VpjtxqF8pG0Fm2m1G7qFtC\njRsqzJm7TA5oRdCtLYszSCd0jysKAhiUCzHOGO3/Z/aP3Hf3NSpbJzQTrkqa\n8oYj\r\n=agKU\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","gitHead":"18c4b414ae4643486c44c057662fd5e4f04bf265","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"devDependencies":{"piral-core":"^0.14.4"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.4_1638351800693_0.017855350294421646","host":"s3://npm-registry-packages"}},"0.14.5-beta.3331":{"name":"piral-pwa","version":"0.14.5-beta.3331","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.5-beta.3331","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"16855f6b63de24bb20081c9bc8efe5623449201f","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.5-beta.3331.tgz","fileCount":40,"integrity":"sha512-s4hbnwizhDzB/rlvoT+f3HnGJM5eFxFINJtSlkEGAvP+uzDZ3g2B+BzwrXUCNAJ+V+6Lq5NDZXlrZnBNr46v3w==","signatures":[{"sig":"MEUCIHsqLNdJndHJN6GL1hmSrDfDR/Ck7G+3soa7/flrxYpNAiEAvrpHbNQD7pl071/TmIyhHG9gRy/M5MIANdscWfjj9JY=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59994,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhr5WJCRA9TVsSAnZWagAA0NUP/ArRMSxtbXJoqUGBFyiD\n1hMUN6/k0nGpD24oYMWBEofBNMxD/FaUrApQL7UZgGljNW+Lm2ulCGKglu/y\ntN6q5loU4jmp1r+l0IFeRPLxBBE5akbyyPMLFa7na9tuaPb1xLVB8YufAqaF\nQudyvfCAtgbHG0BzsE/Ei7322o2re6Va87rPgpXF2ANWcVZML32ROCQG/T/e\nUpnXwhZtvxs5OdTbmXcA2s5pLarPjRyEMm92O2zDaPLaj4F+MQ5deInirMmv\nuVOUArnpZAdo64F1+diGhMu4XogtmpfKlxXe5QCtjVbFOP5uT/dh2caHMMh6\nFh6ZU9+gduG+aXiyZnAUAMNttCufID/5r5vxzNzPQF0LsMwXlvECVl1TvnNF\nvm/rk2+FqFtG3cRQDs6C5na13ASB0NIrx94w3B1jBHwQ/gPSCC8HsFDp8qt5\ndmkI6WNMP80MTF+12YEvc4PC0c2WFJj0y0e/ZibjT1Lz3RrARV9kfFauFcaY\nH97Ybfhwcoop7nWZBKRapM7jbzwY/7pcsq2el9O6OCVX7X3py2t4cLZckMBY\nO1LhCg1cxjxtlzTSDfkI5qQtlHntNXn6u5VNZPODO1sY7PS4BuNX2CYSC7GJ\nwQGpwdT1L7/nzn1xNOmBrr4F3tkRbY1yKYXayfly3/i5hxg5XJJyJWNH6WNa\nZIvI\r\n=NCMu\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"3db5015a2dbe8d68b87244b4d5ea6c9f84633189","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"0.14.5-beta.3331"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.5-beta.3331_1638897033313_0.019563484722204594","host":"s3://npm-registry-packages"}},"0.14.5-beta.3335":{"name":"piral-pwa","version":"0.14.5-beta.3335","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.5-beta.3335","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"f2d36f97a6a16225d3048c4f9de3c08fce3a1e37","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.5-beta.3335.tgz","fileCount":40,"integrity":"sha512-TX7CQC5faBN154uqBuXTIB+br+jU/G9CiqzGcssioGOOLCD6595Ob+FkSFlSn4pm2M/RV9C9lWcwMCqJ/LO2CQ==","signatures":[{"sig":"MEYCIQDlrn31A7CpoNMfKoq5ftGBySxodjRsLX35+IaCNdzDDwIhAMETXrALM398IIz5Z8BpRXP/QqXGfz4AlNeSBfS/MqVu","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59994,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhskOrCRA9TVsSAnZWagAAwJkP/iSI11OQxIn/CAhQ90Uj\n3VOtIPersEb+oXjD8YgZZbKlB/QKyAInHojXxWqtXuD7ZNBiOWWmQkdHbECE\nfc3SFmlTm6Mmbp7ItS/vajDYBLMxMhD/owAYUMklpUrVUQiGSqxi+8ghZHUg\nIc26x37HhcCIrXyWEn2DNZ7B/AznyeKWiyUv1KRfUJ29vCghi8eppOnaOrEN\nTKkJVtifrZljqrv0tMObIfk70F/NkJVMsELTTV7S8RKOP4y8j3LF2FEFa/Wu\nqwe533Zachjeg6ul5mnwxDE+FVeUuNkbrIhRnRO54jfUXAMFYUeSuXOFMuzY\n275bPzBcHCSuDiB4VKaE4FXYcfCV/8jvqZ6yuWoARYeE9HSbbx6sl7pX1JTv\nzi5353l3YYVfhrjZIcGT+O5zczGWRfZWyd28zaUO/QEmg/ZMQ+mdJwGS5wi9\n2YVRx86XKrnUdv2vpUgLQORFv/gUcVOrX7863brGq/HWPRMDIOFB/4b+bZB2\nrmCp5xthEoGig2U2zZ7hiJ4K8rHkfpyHnBJ7TRrHvIMxE3bp/4vPFmXt9jOZ\npDvzxWULT3j/JeUNM310n9GvYtGt0LkbBj4q9rtv3jcVgZcQVwlEUNbOF647\nNJSPg4F4qlHEIGwMh0ffX/fawI3rOYVDzf7KjkdmR7BFbsU1kqCYreTnkJwR\nO8hE\r\n=2Lvx\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"e4d630fc1e08cd0b994791870e26fefe9e1a4d86","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"0.14.5-beta.3335"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.5-beta.3335_1639072683883_0.07197964704418491","host":"s3://npm-registry-packages"}},"0.14.5-beta.3336":{"name":"piral-pwa","version":"0.14.5-beta.3336","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.5-beta.3336","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"55f32da7c637a9627e05d30b33b3b2d22d9d52cc","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.5-beta.3336.tgz","fileCount":40,"integrity":"sha512-HFbBHh7VCSHmIfISXDQnbxSMbQlwuG/G1kWX1jxpUwB2+xDmyD/HGD0DJLfl1XDAjy5+seyVPcxBrbgU6+h5pA==","signatures":[{"sig":"MEUCIQCycaJfkLI0IrbzSl0TLn/+6JTtZoV6lvf5zar9SVWVLwIgDvBz7ncbv4rXLyDfrKvo6p0BWot8CoYah73FvIUDgaY=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59994,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhsoRdCRA9TVsSAnZWagAAK1YP/iYAnmAiakLA47bpPBrg\nd/3wVaopHWJ1r5tfm6AY/Gf9Lz63C7+FsrgTxC5CoH88NOAm2KoolIVcUHLE\nhpXjVcF4/WHiV9tCvSL+ksQKflBIR5mr+kwu32Y0m+MWr9GJ2PI5e82V6e6y\nPo/FKCeNwnxHyK0D4Q4DoEvSKu8ikpaIeTtB89WiOJEjwx6pDhwli7r5Sgp6\nUXrcxj70nP4OPK6+hY/mnmz6Rhg8xzX4bEI5SdJCxgPOZGpXRTuzwvD2VULZ\ngmFEmt/c9hXFzUCmxZuanpJD20rSsjM0FnU1c6eYshRBCvrScPD1jXTVu6oY\nIIhpF1gnEPujjmIaH2yhi1n4jgW+mimcfs2Gan3bC+bmETYoQ3QySiz9o2eT\nCxeACm9aJGAKy5gTZRY76+hz1IcuvV+icaMwZcJRRptN/T2PiYch0GGDo3dl\ngWqQGIhj6BIrzP2TLm0MsymdTXZ/5w14x6QFGtpLZmfM86EaZNFs7u5uaWoO\njJhPGI9yzkdAdg8zF98Beg+uyK3uaYOmPlhyfWUMSuN2rKy9T2gK64uyIS4o\nofUA/nrDX1oCqMrb4IOub1aJstSOVRtfIG3uGzYj36NbCnhmsEo5NX6jFOR9\nNUbKDFXNUI3qF4s7EY/7MuMGhMHd7Z8O2Reg0Z1MLEcCBzFXlvsAdVKFZkal\nilNv\r\n=SFFm\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n\n```\n\nFor the setup of the library itself you'll need to import `createPwaApi` from the `piral-pwa` package.\n\n```ts\nimport { createPwaApi } from 'piral-pwa';\n```\n\nThe integration looks like:\n\n```ts\nconst instance = createInstance({\n // important part\n plugins: [createPwaApi()],\n // ...\n});\n```\n\n### Customizing the Service Worker\n\nBy default, a service worker is generated for you. This behavior can be overridden if you place a file called `sw.js` in your `src` folder.\n\nThe server worker file is automatically enhanced with the following template variables:\n\n- `__PARAMS__`, defines general parameters such as the `responseStrategy` or the URLs from `externals` to consider\n- `__HELPERS__`, defines the `cacheMaps` for setting up the caching strategy and the `navigationPreload` property\n- `__DEBUG__`, which is either `true` or `false` depending on the runtime mode\n\nYou don't need to use them, but they can be quite helpful. For instance, on `__PARAMS__`, you'll find the fields for `name` and `version` of your app.\n\n**Remark**: How the parameters and helpers can be influenced (i.e., configured) is currently work in progress and should be figured out until v1.\n\n### Configuration of the Provided Options\n\nThe parameters for the generated service worker can be configured, too. All in all this follows the options known from Webpack's [offline-plugin](https://github.com/NekR/offline-plugin), see [options](https://github.com/NekR/offline-plugin/blob/master/docs/options.md) for explanations.\n\nIn a nutshell, in order to use the options you'll need a file called `.pwarc` in the root directory of your application (i.e., next to your `package.json`).\n\nThe `.pwarc` may look as follows:\n\n```js\n{\n updateStrategy: 'all',\n responseStrategy: 'network-first',\n externals: ['https://api.myhost.com/logo.png', '/static/image.jpg'],\n excludes: ['**/.*', '**/*.map', '**/*.gz'],\n cacheMaps: [],\n navigationPreload: false,\n caches: 'all',\n}\n```\n\nMore details on the configuration will follow. Further options will be integrated soon, too.\n\n:::\n\n## License\n\nPiral is released using the MIT license. For more information see the [license file](./LICENSE).\n","gitHead":"db950799d09a66f20f356adc35d3d6907630986e","scripts":{"test":"echo \"Error: run tests from root\" && exit 1","build":"yarn build:commonjs && yarn build:esnext","typedoc":"typedoc --json ../../../docs/types/piral-pwa.json src --exclude \"src/**/*.test.*\"","build:esnext":"tsc --project tsconfig.json --outDir esm --module esnext","build:commonjs":"tsc --project tsconfig.json --outDir lib --module commonjs"},"typings":"lib/index.d.ts","_npmUser":{"name":"florianrappl","email":"mail@florian-rappl.de"},"repository":{"url":"git+https://github.com/smapiot/piral.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v12.21.0+x64 (linux)","description":"Plugin for creating the Piral instance as a PWA shell.","directories":{},"sideEffects":false,"_nodeVersion":"12.21.0","_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"piral-core":"0.14.5-beta.3336"},"peerDependencies":{"minimatch":"^3.0.0","piral-core":"0.14.x","parcel-bundler":"0.14.x"},"_npmOperationalInternal":{"tmp":"tmp/piral-pwa_0.14.5-beta.3336_1639089244993_0.7143333956951561","host":"s3://npm-registry-packages"}},"0.14.5-beta.3339":{"name":"piral-pwa","version":"0.14.5-beta.3339","keywords":["piral","pilet-api","smapiot","portal","modules","api","plugin","plugin-content","pwa","progressive","app"],"author":{"name":"smapiot"},"license":"MIT","_id":"piral-pwa@0.14.5-beta.3339","maintainers":[{"name":"florianrappl","email":"mail@florian-rappl.de"}],"homepage":"https://piral.io","bugs":{"url":"https://github.com/smapiot/piral/issues"},"dist":{"shasum":"f7a0319bd83269bae13e2748cb242119e1c45e5d","tarball":"https://registry.npmjs.org/piral-pwa/-/piral-pwa-0.14.5-beta.3339.tgz","fileCount":40,"integrity":"sha512-Kndb+zvrpiykDDmFs8Ei5ehwjRtFx5t/DsHH5Jw/CMuenpLuTYSrlvUqif+7oOYX05zZBruXuGusmF6b/dd4Ow==","signatures":[{"sig":"MEUCIEgI+r/5mimFPhx5NEmzuiLokJ24QXw7ZSwgOrgscXpvAiEA6Hnd/Ute/atFBOcMKKczFuLj4lv/mbHF8ANtaRlcVJY=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":59994,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhs4W3CRA9TVsSAnZWagAAolgQAKSLGPNCot9h7SZChC92\nY3sQgU/xkQqiNkk2alFAtl1qHK09YMsWQoEBkSIvBZLfD2cU/qK35EFQ2vZ1\n1hxtEcj+TeUX/5DhK2cL+s6hpjzhU7CScqPKzHsiG4s2xE0pYEmaoVI3hYsZ\nCSEP8yNAZuqsX4fq0h/0eH9QFwmUbxMZ+y5029NRjUfALzoUBs/XzO2Hu2HQ\n8SqtnBd8jAQX3WpFPqd+xNYaEBrv/kL2bJwCKC6v1qLyr21FVNT0BgXRjdk7\niwGlTnb0Gj3Ic+KxgNialxJZIUOjYaPSgmhD1gRCmuZVRNi1KT2j5fNxgXbG\nz7P+hNSPjxlg89DpbUByH0N5n3pkcUoOJaNMtjQ2ZJlFsIUmLNPoaA/+fkis\nQlLlz1jv09+EFkHqbvbIwYFsw7MxvxzArAT6TxWWfU1sHU9MY3gLC1C0qD9u\n+MQa5DlWZCRzdbYUynL2uFDqDKjIzgpczYe9gsGpL+ccU6zx2PCGuGsfW21T\naC8R8WgDZ4zKdZMeOsJR42Qubjd2o0Mxj7MkjwkLAjGu9lePFiOdML6W4IHi\nFoAr6g4mamdz2bogjQTHQN2ieE++OTdmj7rtUb2gp1j+3/ZMp0ZRF0cc5rTA\n2P0Vhh7GKNC4bPWH7rjvpw0OwNMn3P/oL2LmwgukS4geOp4TNJNUBKmp39CN\nBw/D\r\n=9yr5\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","module":"esm/index.js","readme":"[](https://piral.io)\n\n# [Piral PWA](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-pwa) [](https://jestjs.io) [](https://gitter.im/piral-io/community)\n\nThis is a plugin that has a peer dependency to `piral-core` and **requires** `parcel-bundler` to work.\n\n::: warning: Only use with Parcel\n\nMost likely this plugin will only work with `piral-cli-parcel` as it depends on a codegen that assumes Parcel is in charge of bundling. If you need something similar for Webpack have a look [here](https://webpack.js.org/guides/progressive-web-application/), or even better [here](https://github.com/NekR/offline-plugin).\n\n:::\n\nWhat `piral-pwa` brings to the table is a simple way to expose your application as a PWA with the capability to use offline storage for pilets, too.\n\nBy default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.\n\n## Why and When\n\nA progressive web app (PWA) is the next step in the evolution of web applications. Quite naturally, a microfrontend solution should also be capable of being turned into a PWA. To use some of the PWA capabilities from pilets without further checks the pilet API has been extended with some PWA specific functions. The most important part of this plugin, however, is to fully integrate the `ServiceWorker` into the app shell.\n\nAlternatives: Set up a `ServiceWorker` yourself or use a known library (e.g., WorkBox) or bundler plugin to do this for you.\n\n## Documentation\n\nThe following functions are brought to the Pilet API.\n\n### `showAppNotification()`\n\nAllows pilets to present a \"native\" notification. The exact looks of this are platform dependent, e.g., on Chrome for Windows 10 an item as added to the notification bar. On Chrome for MacOS X a quick notification appears.\n\n## Usage\n\n::: summary: For pilet authors\n\nYou can use the `showAppNotification` function from the Pilet API to show a native notification in the host browser or operating system from the Piral instance.\n\nExample use:\n\n```ts\nimport { PiletApi } from '';\n\nexport function setup(piral: PiletApi) {\n piral.showAppNotification('Pilet started!', {\n body: 'The sample pilet was successfully set up...',\n });\n}\n```\n\n:::\n\n::: summary: For Piral instance developers\n\nThe provided library only brings API extensions for pilets to a Piral instance.\n\nIn order to get your Progressive Web App correctly running you'll also need a `manifest.webmanifest` file. You can locate it next to your `index.html` file.\n\nThe content of `manifest.webmanifest` can be as simple as:\n\n```json\n{\n \"name\": \"Example App\",\n \"short_name\": \"ExApp\",\n \"theme_color\": \"#2196f3\",\n \"background_color\": \"#2196f3\",\n \"display\": \"standalone\",\n \"scope\": \"/\",\n \"start_url\": \"/\",\n \"icons\": [\n {\n \"src\": \"images/icon-144x144.png\",\n \"sizes\": \"144x144\",\n \"type\": \"image/png\"\n }\n ]\n}\n```\n\n**Note**: You'll need at least a 144x144 pixels sized icon. This is not a requirement of `piral-pwa`, but rather of how PWAs work.\n\nThe `manifest.webmanifest` needs to be referenced by your `index.html` file. If both files are adjacent this can be done with the following code:\n\n```html\n