{"_rev":"11-d7fb2ad7ee2d845e962b24869c7c35f9","time":{"created":"2023-11-19T19:59:13.828Z","0.1.0-alpha.1":"2023-11-08T01:48:04.044Z","modified":"2023-11-19T19:59:14.390Z","0.1.0-alpha.1a":"2023-11-13T10:43:57.730Z","0.1.0":"2023-11-13T10:52:12.359Z","0.1.0-alpha.1b":"2023-11-13T11:03:27.198Z","0.1.0-alpha.1c":"2023-11-13T11:33:29.064Z","0.1.0-alpha.1d":"2023-11-19T19:53:21.517Z","0.1.0-alpha.1e":"2023-11-19T19:55:52.814Z","0.1.0-alpha.1f":"2023-11-19T19:59:14.115Z"},"_id":"@byteassign/freshdesk-appclient","name":"@byteassign/freshdesk-appclient","dist-tags":{"latest":"0.1.0-alpha.1f"},"versions":{"0.1.0-alpha.1f":{"name":"@byteassign/freshdesk-appclient","version":"0.1.0-alpha.1f","private":false,"author":{"name":"ByteAssign"},"description":"A library declaring the types available within the Freshdesk application client.","types":"lib/index.d.ts","keywords":["appclient","freshdesk","freshdesk-appclient","freshdesk-client","freshdesk-api","types","typings","typescript"],"license":"MIT","repository":{"type":"git","url":"git+https://github.com/byteassign/freshworks.git","directory":"packages/freshdesk-appclient"},"scripts":{"build":"tsc --build"},"exports":{".":{"types":"./lib/index.d.ts"}},"sideEffects":false,"_id":"@byteassign/freshdesk-appclient@0.1.0-alpha.1f","gitHead":"3949e3fb00a70e75390ad3da478a2758a7fe999f","bugs":{"url":"https://github.com/byteassign/freshworks/issues"},"homepage":"https://github.com/byteassign/freshworks#readme","_nodeVersion":"18.17.1","_npmVersion":"10.2.3","dist":{"integrity":"sha512-TOfsE/DWlKUgl1LjFlSwa3AxmdC1Pz7kK9cdUZ2dsRQPkRXpFJ9ui1DtQZpqd9AZ7XwoJ4i58r7JkW7wd/Db7A==","shasum":"ca63235ab89043807ae37565ae40adeb27066d33","tarball":"https://registry.npmjs.org/@byteassign/freshdesk-appclient/-/freshdesk-appclient-0.1.0-alpha.1f.tgz","fileCount":47,"unpackedSize":44625,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIFOqIgOmzheD8Zjb43SO+LAeteMTNTvpqnE6r3UXIPN/AiAyXZIV1We6g3hnLzvHUoOawu8A983cwzPpDjlFKehLJw=="}]},"_npmUser":{"name":"jacqueline-noke","email":"jacqi.noke@gmail.com"},"directories":{},"maintainers":[{"name":"jacqueline-noke","email":"jacqi.noke@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/freshdesk-appclient_0.1.0-alpha.1f_1700423953914_0.17638174886929847"},"_hasShrinkwrap":false}},"maintainers":[{"name":"jacqueline-noke","email":"jacqi.noke@gmail.com"}],"description":"A library declaring the types available within the Freshdesk application client.","homepage":"https://github.com/byteassign/freshworks#readme","keywords":["appclient","freshdesk","freshdesk-appclient","freshdesk-client","freshdesk-api","types","typings","typescript"],"repository":{"type":"git","url":"git+https://github.com/byteassign/freshworks.git","directory":"packages/freshdesk-appclient"},"author":{"name":"ByteAssign"},"bugs":{"url":"https://github.com/byteassign/freshworks/issues"},"license":"MIT","readme":"<!-- markdownlint-disable-next-line -->\r\n<p align=\"center\">\r\n  <a href=\"https://mui.com/material-ui/\" rel=\"noopener\" target=\"_blank\"><img width=\"150\" height=\"133\" src=\"https://avatars.githubusercontent.com/u/149618618?s=400&u=cf62f9140145a9401cd04bbcdd1d1b4a3fd49dcf&v=4\" alt=\"Material UI logo\"></a>\r\n</p>\r\n\r\n<h1 align=\"center\">Byteassign\r\n<div style=\"font-size:60%\">freshdesk appclient</div></h1>\r\n\r\nByteassign's Freshdesk appclient is a library designed to assist in the development of front-end Freshdesk applications. It primarily provides types for the various components found within the Freshdesk eco-system.\r\n\r\n> **Important**  \r\n> @byteassign is not affiliated with Freshworks in any way.\r\n\r\n## Installation\r\n\r\nInstall the package in your project directory as a development dependency with:\r\n\r\n```bash\r\nnpm install @byteassign/freshdesk-appclient --save-dev\r\n```\r\n\r\n## Documentation\r\n\r\nVisit Freshdesk's [app-sdk page](https://developers.freshworks.com/docs/app-sdk/v2.3) to view the full documentation.\r\n\r\n## Examples\r\n\r\n**Subscribing to app.initialized**    \r\nApp initialization occurs when the page that contains your app is loaded for the first time.\r\n```typescript\r\nimport {ApplicationClient} from '@byteassign/Freshdesk';\r\n\r\nlet client: ApplicationClient;\r\ninit();\r\n\r\nasync function init() {\r\n    client = await app.initialized();\r\n    client.events.on(\"app.activated\", onAppActiveHandler);\r\n    client.events.on(\"app.deactivated\", onAppDeactiveHandler);\r\n}\r\n```\r\nUnless you are building an app that is completely isolated (independent of the data on the page), ensure that the core logic of the app is not placed within the `app.initialized()` method. Place the logic within the `app.activated()` method.\r\n\r\n[Click here  to see more.](https://developers.freshworks.com/docs/app-sdk/v2.3/freshdesk/front-end-apps/app-lifecycle-methods/)\r\n\r\n## Contributing\r\n\r\nWe welcome contributions to improve and expand this package. Please ensure that contributions align with the latest Freshdesk appclient specifications and best practices in TypeScript.\r\n\r\n## Related Packages\r\n\r\n- [@byteassign/Freshdesk-appclient-react](https://www.npmjs.com/package/@byteassign/freshdesk-appclient-react)","readmeFilename":"README.md"}