{"id":19977768,"url":"https://github.com/uipath/assistant-plugin-creator","last_synced_at":"2025-05-04T03:30:52.124Z","repository":{"id":38106551,"uuid":"246309070","full_name":"UiPath/assistant-plugin-creator","owner":"UiPath","description":null,"archived":false,"fork":false,"pushed_at":"2025-04-03T07:29:48.000Z","size":889,"stargazers_count":10,"open_issues_count":1,"forks_count":6,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-04-08T02:44:52.201Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/UiPath.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-03-10T13:32:08.000Z","updated_at":"2024-10-31T14:13:51.000Z","dependencies_parsed_at":"2024-11-13T03:29:44.436Z","dependency_job_id":"5965be6d-1c68-4f9b-8f8f-c6283b555646","html_url":"https://github.com/UiPath/assistant-plugin-creator","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UiPath%2Fassistant-plugin-creator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UiPath%2Fassistant-plugin-creator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UiPath%2Fassistant-plugin-creator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UiPath%2Fassistant-plugin-creator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/UiPath","download_url":"https://codeload.github.com/UiPath/assistant-plugin-creator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252283568,"owners_count":21723498,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T03:29:13.560Z","updated_at":"2025-05-04T03:30:51.416Z","avatar_url":"https://github.com/UiPath.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"This repository can be used as a starting point for developing custom widgets for UiPath Assistant.\nThe project is a Web Component library that contains the implementation of a sample widget.\n\n## Developing your widget\n\n1. Run `npm i`. For npm 7 or higher, use the `--legacy-peer-deps` flag.\n2. `npm run watch`. This will rebuild the widget every time a project file is saved.\n3. Find the `UiPathAssistant` folder in your [UiPath `Studio` / `Robot` install location](https://docs.uipath.com/installation-and-upgrade/docs/studio-install-studio).\n4. Close the Assistant if it is opened.\n5. Provide the path to your widget `.js` output to Assistant by running `UiPath.Assistant.exe` with the `--dbg` and `--dev-widget` flags (e.g. `UiPath.Assistant.exe --dbg --dev-widget=C:\\Users\\...\\Desktop\\assistant-plugin-creator\\dist\\sample-widget\\bundles\\sample-widget.umd.js`; The path may not contain spaces).\n6. You should see a new Assistant red tab that hosts your main widget component. The tab is always visible in dev mode, even if enabling `isTabHidden`.\n7. You may open dev tools via `Ctrl+Shift+I`.\n8. By default, the Assistant will read the sibling `sample-widget.umd.js.map` source map file and allow typescript debugging.\n\n## Widget API\n\n`@uipath/widget.sdk` exports reusable APIs (via the `WidgetApi` object) for interacting with Assistant.\n\nWhen creating widgets at runtime, UiPath Assistant, is looking for a `MainComponent` (for each widget). Make sure you add them to `projects\\sample-widget\\src\\public-api.ts`.\n\nTo force a package into the final bundle, add it to the `bundledDependencies` array in `projects/sample-widget/package.json`. You should do this for any runtime dependency.\n\n### Localization\n\nStarting with Assistant 21.4.x, i18n is supported via [ngx-translate](https://github.com/ngx-translate/core). `WidgetApi.translate` can be used to translate the keys found in `projects/sample-widge/src/lib/i18n`.\n\n## Building a widget\n\n1. Run `ng build --prod`\n2. The output is `dist\\sample-widget\\bundles\\sample-widget.umd.js` (or the minified version)\n3. Rename the output file. Each unpacked widget is uniquely identified by the file name.\n\n## Packing a widget\n\nAssistant widgets can be bundled into nuget packges that can be published to nuget feeds and then installed into Assistant. To bundle a widget, simply build the widget, write the appropriate metadata to the `widget.nuspec` file and run `npm run pack`. If not running on Windows, you need a .NET compiler (such as [Mono](https://www.mono-project.com/download/stable/)) to run nuget.exe.\n\n## Installing/updating a widget\n\nPlease check out the [official docs for Assistant Widgets](https://docs.uipath.com/robot/docs/widgets).\n\n\n## Changelog\n\nThe changelog for `@uipath/widget.sdk` can be found [here](https://www.npmjs.com/package/@uipath/widget.sdk).\n\n## License\n\nYou can use the contents of this repository/package subject to your license agreement with UiPath for the UiPath Platform.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuipath%2Fassistant-plugin-creator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fuipath%2Fassistant-plugin-creator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuipath%2Fassistant-plugin-creator/lists"}