{"_id":"@bundeling/app-sdk","_rev":"7-0da675d2f1dda08317463f198fe6fd93","name":"@bundeling/app-sdk","dist-tags":{"latest":"2.0.0"},"versions":{"1.0.0":{"name":"@bundeling/app-sdk","version":"1.0.0","keywords":["Bundeling"],"author":{"name":"Bundeling Group B.V."},"license":"MIT","_id":"@bundeling/app-sdk@1.0.0","maintainers":[{"name":"erwinspierings","email":"e.spierings@bundeling.com"}],"homepage":"https://github.com/Bundeling/app-sdk#readme","bugs":{"url":"https://github.com/Bundeling/app-sdk/issues"},"dist":{"shasum":"68b3e7dc07c35f08e6424d06a00e5bd4708e3d46","tarball":"https://registry.npmjs.org/@bundeling/app-sdk/-/app-sdk-1.0.0.tgz","fileCount":7,"integrity":"sha512-qIEQEVy0/MRyKV+Csfhi25zpMdMZ9xbrmNjVYf4PjfMp0+kDtgfq0AYDWyTRX83KWOqdbP4zj8Y87INgfD6Wfg==","signatures":[{"sig":"MEUCIQC0g6vfmVzhu19VVHZ8ec2fFbWR0Y91SsKrDgo7NhWpXQIgJs59f3cllm0Egl3iLTtVfDy529c6cWfTSCLBEFWWlUc=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":10188},"main":"src/index.js","gitHead":"d2acea7b307b53ec7d543e3377e9ec0d1bdcbcc1","scripts":{"prepublish":"webpack"},"_npmUser":{"name":"erwinspierings","email":"e.spierings@bundeling.com"},"repository":{"url":"git+https://github.com/Bundeling/app-sdk.git","type":"git"},"_npmVersion":"8.19.4","description":"Bundeling App SDK provides functions used for creating plugins inside the app.","directories":{},"_nodeVersion":"16.20.2","_hasShrinkwrap":false,"devDependencies":{"webpack":"^5.92.1","webpack-cli":"^5.1.4"},"_npmOperationalInternal":{"tmp":"tmp/app-sdk_1.0.0_1720779612849_0.8194384206034029","host":"s3://npm-registry-packages"}},"1.0.1":{"name":"@bundeling/app-sdk","version":"1.0.1","keywords":["Bundeling"],"author":{"name":"Bundeling Group B.V."},"license":"MIT","_id":"@bundeling/app-sdk@1.0.1","maintainers":[{"name":"erwinspierings","email":"e.spierings@bundeling.com"}],"homepage":"https://github.com/Bundeling/app-sdk#readme","bugs":{"url":"https://github.com/Bundeling/app-sdk/issues"},"dist":{"shasum":"518798262baed65c6a682f9b4fc81d6d66855ae8","tarball":"https://registry.npmjs.org/@bundeling/app-sdk/-/app-sdk-1.0.1.tgz","fileCount":7,"integrity":"sha512-pVV08DOymnW+3BuD1M7MJKGc+D7K8HyE0dKKpkNW3tZzCXaamAOy7qXRNfshSsTOCNVR+tzzNDfxmLL14EVi5A==","signatures":[{"sig":"MEUCIAa0vfFWjsBAQMTJ2RwLgrHAMcM4GpJKrr6beESyO0xMAiEAg772pHR9PbVgXURK2hhzHdSj9dJyJNPdg6DRE9DfKNU=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":10373},"main":"src/index.js","gitHead":"a2fb2bd351dc11cd50004fa95b119d460e30f904","scripts":{"prepublish":"webpack"},"_npmUser":{"name":"erwinspierings","email":"e.spierings@bundeling.com"},"repository":{"url":"git+https://github.com/Bundeling/app-sdk.git","type":"git"},"_npmVersion":"8.19.4","description":"Bundeling App SDK provides functions used for creating plugins inside the app.","directories":{},"_nodeVersion":"16.20.2","_hasShrinkwrap":false,"devDependencies":{"webpack":"^5.92.1","webpack-cli":"^5.1.4"},"_npmOperationalInternal":{"tmp":"tmp/app-sdk_1.0.1_1721398864418_0.7850959509073676","host":"s3://npm-registry-packages"}},"1.0.2":{"name":"@bundeling/app-sdk","version":"1.0.2","keywords":["Bundeling"],"author":{"name":"Bundeling Group B.V."},"license":"MIT","_id":"@bundeling/app-sdk@1.0.2","maintainers":[{"name":"erwinspierings","email":"e.spierings@bundeling.com"}],"homepage":"https://github.com/Bundeling/app-sdk#readme","bugs":{"url":"https://github.com/Bundeling/app-sdk/issues"},"dist":{"shasum":"20747085f3cfaf282c6ceb3d51ad10fa2fb1ee61","tarball":"https://registry.npmjs.org/@bundeling/app-sdk/-/app-sdk-1.0.2.tgz","fileCount":7,"integrity":"sha512-GLLe26K6FVfc8lmX9R8YXMgAihkqbK1yEyqI/62XMs5rmt9jMiHfHCsdjl0NMbohXgWjq8zgDpNK1N1qOvQrdQ==","signatures":[{"sig":"MEUCIQDKsrDWLRa/QJABs8CdxbOs9acaq+XszjVIj25L/tvrZQIgXbpZdnnzDWAlXmOe5g4q14sU2FFqk9l3juwTIUHkqzI=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":10628},"main":"src/index.js","gitHead":"a29d9cf35210a359fbf79735d57ef608d3d65082","scripts":{"prepublish":"webpack"},"_npmUser":{"name":"erwinspierings","email":"e.spierings@bundeling.com"},"repository":{"url":"git+https://github.com/Bundeling/app-sdk.git","type":"git"},"_npmVersion":"8.19.4","description":"Bundeling App SDK provides functions used for creating plugins inside the app.","directories":{},"_nodeVersion":"16.20.2","_hasShrinkwrap":false,"devDependencies":{"webpack":"^5.92.1","webpack-cli":"^5.1.4"},"_npmOperationalInternal":{"tmp":"tmp/app-sdk_1.0.2_1721916822568_0.6424243643122256","host":"s3://npm-registry-packages"}},"1.0.3":{"name":"@bundeling/app-sdk","version":"1.0.3","keywords":["Bundeling"],"author":{"name":"Bundeling Group B.V."},"license":"MIT","_id":"@bundeling/app-sdk@1.0.3","maintainers":[{"name":"erwinspierings","email":"e.spierings@bundeling.com"}],"homepage":"https://github.com/Bundeling/app-sdk#readme","bugs":{"url":"https://github.com/Bundeling/app-sdk/issues"},"dist":{"shasum":"4d23a25c445b53021b0c96452c80138d3e9b790e","tarball":"https://registry.npmjs.org/@bundeling/app-sdk/-/app-sdk-1.0.3.tgz","fileCount":7,"integrity":"sha512-9pk4SNke53NwrVNPg5VgH4AHdT3K2NTZnhyaB0m4O6c/T1D+N7UPzsj42ljsHwm8mLxNeA3k4SBjSxeHkXZ5Gg==","signatures":[{"sig":"MEQCIEbYnCNY5pGGJ1rvoph+/eJBzlZ8UPqkOjW5dt66FW2HAiBgjTRdLXNw5EIE7t+QvLTZC61yJHkCURSTNNXGhrwvpg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":10776},"main":"src/index.js","gitHead":"95faf8b00c4cffb5bd994fb8fa3bf66904157c40","scripts":{"prepublish":"webpack"},"_npmUser":{"name":"erwinspierings","email":"e.spierings@bundeling.com"},"repository":{"url":"git+https://github.com/Bundeling/app-sdk.git","type":"git"},"_npmVersion":"8.19.4","description":"Bundeling App SDK provides functions used for creating plugins inside the app.","directories":{},"_nodeVersion":"16.20.2","_hasShrinkwrap":false,"devDependencies":{"webpack":"^5.92.1","webpack-cli":"^5.1.4"},"_npmOperationalInternal":{"tmp":"tmp/app-sdk_1.0.3_1721977566840_0.9451591403705619","host":"s3://npm-registry-packages"}},"1.0.4":{"name":"@bundeling/app-sdk","version":"1.0.4","keywords":["Bundeling"],"author":{"name":"Bundeling Group B.V."},"license":"MIT","_id":"@bundeling/app-sdk@1.0.4","maintainers":[{"name":"erwinspierings","email":"e.spierings@bundeling.com"}],"homepage":"https://github.com/Bundeling/app-sdk#readme","bugs":{"url":"https://github.com/Bundeling/app-sdk/issues"},"dist":{"shasum":"da28d8bb6d64fdc72668d43f262ee876f4a81799","tarball":"https://registry.npmjs.org/@bundeling/app-sdk/-/app-sdk-1.0.4.tgz","fileCount":7,"integrity":"sha512-T3yqQ+6tp1sC7rev13AaNLRmEDCQuJ+wirQh/KteQKOZxb7jRVu943lBPbegbL1sQJ1DJ/lFiV6AboWF2om1ww==","signatures":[{"sig":"MEUCIQDgj0HMIsr5tOi+sTutoguTFxfJ/+e2u5JpVbAF6grZGQIgHtTwCG5uLmhVwHDyow8QnriUwhX1DV08tW7h+aUfmgo=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":10782},"main":"src/index.js","gitHead":"b6f4bc03c11834c53a31b60fd1becedabc805390","scripts":{"prepublish":"webpack"},"_npmUser":{"name":"erwinspierings","email":"e.spierings@bundeling.com"},"repository":{"url":"git+https://github.com/Bundeling/app-sdk.git","type":"git"},"_npmVersion":"8.19.4","description":"Bundeling App SDK provides functions used for creating plugins inside the app.","directories":{},"_nodeVersion":"16.20.2","_hasShrinkwrap":false,"devDependencies":{"webpack":"^5.92.1","webpack-cli":"^5.1.4"},"_npmOperationalInternal":{"tmp":"tmp/app-sdk_1.0.4_1727871513841_0.8678886305410847","host":"s3://npm-registry-packages"}},"2.0.0":{"name":"@bundeling/app-sdk","version":"2.0.0","keywords":["Bundeling"],"author":{"name":"Bundeling Group B.V."},"license":"MIT","_id":"@bundeling/app-sdk@2.0.0","maintainers":[{"name":"erwinspierings","email":"e.spierings@bundeling.com"}],"homepage":"https://github.com/Bundeling/app-sdk#readme","bugs":{"url":"https://github.com/Bundeling/app-sdk/issues"},"dist":{"shasum":"8186698d726a6064881ee500b76b50c4d0e00db7","tarball":"https://registry.npmjs.org/@bundeling/app-sdk/-/app-sdk-2.0.0.tgz","fileCount":32,"integrity":"sha512-Ys2eSf4bzwRwaadwKK6EULFl8djyjNswMR3yiQw/kVdZ4TFNpaES/0/aFiePZDptch3IBNRT1N3GdLFofATgcA==","signatures":[{"sig":"MEQCIF02jNVzY6ECkKRh4l9GzIAwtCoDxKlOfy4MUnRbqY8EAiB3Eifj4D+JUNq26/7Gb5ehLEmbmKSTjg38TtGsqNlsyw==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":114709},"main":"src/index.js","gitHead":"445728e999794862596f1c40b252ef4f09ca0c02","scripts":{"test":"scripts/test.sh","prepublish":"webpack"},"_npmUser":{"name":"erwinspierings","email":"e.spierings@bundeling.com"},"repository":{"url":"git+https://github.com/Bundeling/app-sdk.git","type":"git"},"_npmVersion":"11.5.1","description":"Bundeling App SDK provides functions used for creating plugins inside the app.","directories":{},"_nodeVersion":"24.7.0","_hasShrinkwrap":false,"devDependencies":{"jest":"^29.7.0","eslint":"^9.19.0","globals":"^15.14.0","webpack":"^5.96.1","@eslint/js":"^9.19.0","babel-jest":"^29.7.0","@babel/core":"^7.26.7","webpack-cli":"^5.1.4","@babel/preset-env":"^7.26.7","jest-environment-jsdom":"^29.7.0"},"_npmOperationalInternal":{"tmp":"tmp/app-sdk_2.0.0_1778485449745_0.26898778841977466","host":"s3://npm-registry-packages-npm-production"}}},"time":{"created":"2024-07-12T10:20:12.684Z","modified":"2026-05-12T07:16:14.432Z","1.0.0":"2024-07-12T10:20:12.976Z","1.0.1":"2024-07-19T14:21:04.716Z","1.0.2":"2024-07-25T14:13:42.784Z","1.0.3":"2024-07-26T07:06:07.008Z","1.0.4":"2024-10-02T12:18:34.097Z","2.0.0":"2026-05-11T07:44:09.871Z"},"bugs":{"url":"https://github.com/Bundeling/app-sdk/issues"},"author":{"name":"Bundeling Group B.V."},"license":"MIT","homepage":"https://github.com/Bundeling/app-sdk#readme","keywords":["Bundeling"],"repository":{"url":"git+https://github.com/Bundeling/app-sdk.git","type":"git"},"description":"Bundeling App SDK provides functions used for creating plugins inside the app.","maintainers":[{"email":"e.spierings@bundeling.com","name":"erwinspierings"},{"email":"r.anker@bundeling.com","name":"remcoanker"}],"readme":"# Bundeling App SDK\nThe @bundeling/app-sdk is a powerful software development kit that allows developers to easily integrate Bundeling's features into their applications. This guide provides instructions on how to install and use the SDK through npm or by including the prebuilt JavaScript file in your HTML.\n\n## Installation\n\n### Using npm\nTo install the @bundeling/app-sdk via npm, follow these steps:\n\n1. Ensure you have Node.js installed on your machine. You can verify the installation by running the following commands:\n    ```bash\n    node -v\n    npm -v\n    ```\n2. Install the SDK by running the following command:\n    ```bash\n    npm install @bundeling/app-sdk\n    ```\n3. Import the SDK in your project:\n    ```javascript\n    import { navigate, openFile, shareUrl, openUrl, alert, toast } from '@bundeling/app-sdk';\n    ```\n\n### Including the Prebuilt JavaScript File in HTML\n\nIf you prefer not to use npm, you can include the prebuilt JavaScript file directly in your HTML file. Follow these steps:\n\n1. Download the latest prebuilt JavaScript file from the [Bundeling SDK GitHub repository](https://github.com/Bundeling/app-sdk/dist/).\n2. Add the following script tag to your HTML file, replacing path/to/bundeling-app-sdk.js with the path to the downloaded file:\n\n    ```html\n    <script src=\"path/to/bundeling-app-sdk.js\"></script>\n    ```\n\n## Usage\nWhen using the SDK through the prebuild JavaScript file, you can access the SDK methods through the window.bundeling object. For example, to navigate to the news page, you can use the following code:\n```javascript\nwindow.bundeling.openUrl('https://bundeling.com/contact');\n```\n\n### Available Methods\nThe @bundeling/app-sdk provides a variety of methods to interact with Bundeling services. Here are the available methods:\n\n| Method           | Parameters                      | Description                                                    |\n|------------------|---------------------------------|----------------------------------------------------------------|\n| navigate.push    | route: string, params?: object  | Pushes a named route onto the navigation stack.                |\n| navigate.replace | route: string, params?: object  | Replaces the current view with a named route.                  |\n| navigate.back    | -                               | Navigates back to the previous view.                           |\n| openFile         | url: string                     | Opens a file in the Bundeling app.                             |\n| shareUrl         | url: string                     | Shares a URL using the Bundeling app's sharing functionality.  |\n| openUrl          | url: string                     | Opens a URL in the Bundeling app's browser.                    |\n| alert            | title: string, content?: string | Displays an alert dialog with a message and an optional title. |\n| toast            | title: string, content?: string | Displays a toast message at the bottom of the screen.          |\n\n### Navigation\nNavigation is performed by calling `navigate.push(route, params)` to push a new view, or `navigate.replace(route, params)` to replace the current view. Path parameters in the underlying route (e.g. `:uuid`) are substituted from `params` by name.\n\nExample:\n```javascript\nimport { navigate } from '@bundeling/app-sdk';\n\n// Push the user detail page onto the stack\nnavigate.push('user', { uuid: '123' });\n\n// Replace the current view with a list\nnavigate.replace('userlist');\n\n// Go back\nnavigate.back();\n```\n\n#### Available routes\n\n| Route               | Path                              | Required params |\n|---------------------|-----------------------------------|-----------------|\n| user                | user/:uuid                        | uuid            |\n| userlist            | user                              | -               |\n| customer            | customer/:uuid                    | uuid            |\n| customerlist        | customer                          | -               |\n| news                | news/:uuid                        | uuid            |\n| newslist            | news                              | -               |\n| event               | event/:uuid                       | uuid            |\n| eventlist           | event                             | -               |\n| eventcalendar       | event/calendar                    | -               |\n| match               | match/:uuid                       | uuid            |\n| matchlist           | match                             | -               |\n| matchcalendar       | match/calendar                    | -               |\n| poll                | poll/:uuid                        | uuid            |\n| polllist            | poll                              | -               |\n| bulletinboard       | bulletinboard/:uuid               | uuid            |\n| bulletinboardlist   | bulletinboard/board/:boardId      | boardId         |\n| tickets             | tickets                           | -               |\n| ticketscanner       | ticketScanner                     | -               |\n| message             | message/:uuid                     | uuid            |\n| messagelist         | message                           | -               |\n| chat                | chat/:uuid                        | uuid            |\n| chatlist            | chat                              | -               |\n| form                | form/:form_uuid                   | form_uuid       |\n| appcms              | app_cms/:childUuid                | childUuid       |\n| appcmsmenu          | app_cms_menu/:menuUuid            | menuUuid        |\n| timeline            | timeline                          | -               |\n| search              | search                            | -               |\n| settings            | settings                          | -               |\n| connection          | connection                        | -               |\n| personalfiles       | personalfiles                     | -               |\n\n*Identifier values can be a numeric ID or UUID depending on the Bundeling App version.*\n\n## Support\nIf you encounter any issues or have questions, please check the [issues page](https://github.com/bundeling/app-sdk/issues) on the GitHub repository or contact Bundeling support at support@bundeling.com.\n\n## License\nThis project is licensed under the MIT License. See the LICENSE.TXT file for details.","readmeFilename":"README.md"}