@uipath/cli 1.202.1-preview.158 → 1.203.0-preview.160
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +101 -5
- package/dist/THIRD-PARTY-NOTICES.md +64 -7
- package/dist/{cli-p3atfkg9.js → cli-q5zenmkd.js} +4 -4
- package/dist/{index-tqczrxct.js → index-7pvwjzsq.js} +297 -25
- package/dist/{index-8zkwndqj.js → index-b5yz26r1.js} +55 -32
- package/dist/{index-bhjtwzfa.js → index-hgvsratt.js} +14 -2
- package/dist/{index-v5cj0bhj.js → index-vmn69waj.js} +127 -12
- package/dist/{index-k01rr1z4.js → index-zxrjhe00.js} +331 -39
- package/dist/index.js +5 -5
- package/dist/{server-k8ew8mf3.js → server-cc9ad2d2.js} +6 -5
- package/dist/{telemetry-drain-wqmnr7t7.js → telemetry-drain-zkrm8xja.js} +1 -1
- package/dist/{updateService-8ndw67k7.js → updateService-9phkqmwg.js} +2 -2
- package/package.json +8 -12
- package/README.browser.md +0 -128
- package/dist/index.browser.js +0 -16410
- package/dist/services.feedback.browser.js +0 -90
- package/dist/services.markdown.browser.js +0 -4
package/package.json
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@uipath/cli",
|
|
3
|
+
"author": "UiPath",
|
|
3
4
|
"license": "SEE LICENSE IN LICENSE.txt",
|
|
4
|
-
"version": "1.
|
|
5
|
+
"version": "1.203.0-preview.160",
|
|
5
6
|
"description": "Cross platform CLI for UiPath",
|
|
6
7
|
"repository": {
|
|
7
8
|
"type": "git",
|
|
@@ -12,20 +13,15 @@
|
|
|
12
13
|
"registry": "https://registry.npmjs.org/"
|
|
13
14
|
},
|
|
14
15
|
"type": "module",
|
|
16
|
+
"engines": {
|
|
17
|
+
"node": ">=22"
|
|
18
|
+
},
|
|
15
19
|
"main": "./dist/index.js",
|
|
16
20
|
"exports": {
|
|
17
|
-
".":
|
|
18
|
-
"browser": "./dist/index.browser.js",
|
|
19
|
-
"default": "./dist/index.js"
|
|
20
|
-
},
|
|
21
|
-
"./browser": "./dist/index.browser.js",
|
|
22
|
-
"./services/markdown-to-jira-wiki": "./dist/services.markdown.browser.js",
|
|
23
|
-
"./services/feedback/browser": "./dist/services.feedback.browser.js"
|
|
21
|
+
".": "./dist/index.js"
|
|
24
22
|
},
|
|
25
23
|
"files": [
|
|
26
|
-
"dist"
|
|
27
|
-
"!dist/uip-browser.js",
|
|
28
|
-
"!dist/metafile.json"
|
|
24
|
+
"dist"
|
|
29
25
|
],
|
|
30
26
|
"bin": {
|
|
31
27
|
"uip": "./dist/index.js"
|
|
@@ -40,5 +36,5 @@
|
|
|
40
36
|
"kerberos": "7.0.0",
|
|
41
37
|
"node-expose-sspi": "0.1.60"
|
|
42
38
|
},
|
|
43
|
-
"gitHead": "
|
|
39
|
+
"gitHead": "3a42062ba731afca4595ba9aa8a80afc9667528d"
|
|
44
40
|
}
|
package/README.browser.md
DELETED
|
@@ -1,128 +0,0 @@
|
|
|
1
|
-
# UiPath CLI — Browser Bundle
|
|
2
|
-
|
|
3
|
-
A browser-runnable bundle of the UiPath CLI. Exposes a `UiPathCLI` global that host applications can load to run CLI commands without a Node.js backend.
|
|
4
|
-
|
|
5
|
-
## What's in the bundle
|
|
6
|
-
|
|
7
|
-
- **3 tools** (browser-compatible): `orchestrator-tool` (`or`), `integrationservice-tool` (`is`), `test-manager-tool` (`tm`)
|
|
8
|
-
- **Core framework**: Commander program, `--output-filter`, output formatting, telemetry, error handling
|
|
9
|
-
|
|
10
|
-
Each tool opts in by shipping a `browser.json` next to its `package.json` with `{ "compatible": true }`. At build time, `discover-browser-tools` scans `packages/*-tool/` and emits a virtual module importing each opted-in tool.
|
|
11
|
-
|
|
12
|
-
Authentication is **not** included in this bundle — commands will return "Not logged in" until the browser-auth PR lands (#701).
|
|
13
|
-
|
|
14
|
-
## Bundle
|
|
15
|
-
|
|
16
|
-
- **Build command**: `bun run browser:build` (from `packages/cli/`)
|
|
17
|
-
- **Output**: `packages/cli/dist/uip-browser.js`, plus `dist/metafile.json` for build-time assertions
|
|
18
|
-
- **Size**: ~3.3 MB unminified; ~1.4 MB / ~250 KB gzipped when `minify: true` is re-enabled in `build-browser.ts`
|
|
19
|
-
- **Format**: IIFE, exposes `UiPathCLI` global
|
|
20
|
-
|
|
21
|
-
## Loading the bundle
|
|
22
|
-
|
|
23
|
-
```html
|
|
24
|
-
<script src="/path/to/uip-browser.js"></script>
|
|
25
|
-
<script>
|
|
26
|
-
(async () => {
|
|
27
|
-
// Wait for filesystem (LightningFS over IndexedDB) to initialize
|
|
28
|
-
await UiPathCLI.ready;
|
|
29
|
-
|
|
30
|
-
// Run a CLI command
|
|
31
|
-
await UiPathCLI.run(['node', 'uip', '--help']);
|
|
32
|
-
})();
|
|
33
|
-
</script>
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
## API
|
|
37
|
-
|
|
38
|
-
### `UiPathCLI.run(args, options?)`
|
|
39
|
-
|
|
40
|
-
Parses and executes a CLI invocation.
|
|
41
|
-
|
|
42
|
-
```ts
|
|
43
|
-
UiPathCLI.run(
|
|
44
|
-
args: string[], // e.g. ['node', 'uip', 'or', 'folders', 'list']
|
|
45
|
-
options?: {
|
|
46
|
-
enabledTools?: string[]; // allowlist by command prefix: ['or', 'is']
|
|
47
|
-
}
|
|
48
|
-
): Promise<void>
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
**`enabledTools`** — allowlist of tool command prefixes that register with Commander. Omit to register all discovered browser-compatible tools.
|
|
52
|
-
|
|
53
|
-
### `UiPathCLI.ready`
|
|
54
|
-
|
|
55
|
-
A `Promise<void>` that resolves when the virtual filesystem (LightningFS over IndexedDB) has initialized. Await before the first `run()` call.
|
|
56
|
-
|
|
57
|
-
## Browser-compatible tools
|
|
58
|
-
|
|
59
|
-
| Command | Tool | What it does |
|
|
60
|
-
|---------|------|--------------|
|
|
61
|
-
| `uip or <subcommand>` | orchestrator-tool | Jobs, processes, packages, folders, machines, licenses, users, permissions |
|
|
62
|
-
| `uip is <subcommand>` | integrationservice-tool | Connectors, connections, triggers |
|
|
63
|
-
| `uip tm <subcommand>` | test-manager-tool | Test cases, sets, executions, results |
|
|
64
|
-
|
|
65
|
-
Use `uip or --help` (etc.) for the full subcommand tree.
|
|
66
|
-
|
|
67
|
-
## Reusing services without the CLI program
|
|
68
|
-
|
|
69
|
-
`@uipath/cli/browser` exports the CLI **runner** — the whole Commander program.
|
|
70
|
-
A host that only needs one of the CLI's services can import it directly:
|
|
71
|
-
|
|
72
|
-
```ts
|
|
73
|
-
// Dependency-free, ~3KB, no side effects.
|
|
74
|
-
const { markdownToJiraWiki } = await import(
|
|
75
|
-
"@uipath/cli/services/markdown-to-jira-wiki"
|
|
76
|
-
);
|
|
77
|
-
|
|
78
|
-
// ~178KB. Browser-only — @uipath/filesystem creates an IndexedDB store on
|
|
79
|
-
// import, so this crashes under Node. Hence the `/browser` suffix, matching
|
|
80
|
-
// `@uipath/cli/browser`.
|
|
81
|
-
const { createFeedbackIssue, uploadAttachment } = await import(
|
|
82
|
-
"@uipath/cli/services/feedback/browser"
|
|
83
|
-
);
|
|
84
|
-
```
|
|
85
|
-
|
|
86
|
-
These exist so embedding hosts stop duplicating service logic. Autopilot's Studio
|
|
87
|
-
Web MFE serves `uip feedback send` through a host interceptor — the command is
|
|
88
|
-
Node-only, registered in `cli.node.ts` — and had ported the markdown converter
|
|
89
|
-
and the issue-creation calls verbatim. Two copies of the tracker's
|
|
90
|
-
project/component/field ids is a drift hazard.
|
|
91
|
-
|
|
92
|
-
The two entries are split deliberately: the markdown converter is
|
|
93
|
-
dependency-free, so a host that only formats descriptions should not pay for a
|
|
94
|
-
filesystem it never touches.
|
|
95
|
-
|
|
96
|
-
**These bundles are browser-safe because of the build, not the dependency graph.**
|
|
97
|
-
`@uipath/common` resolves to its Node source and reaches `node:async_hooks`;
|
|
98
|
-
`build-browser.ts`'s alias map rewrites that to a throwing shim and routes
|
|
99
|
-
`@uipath/filesystem` to its browser entry. Importing the TypeScript sources
|
|
100
|
-
directly is not browser-safe.
|
|
101
|
-
|
|
102
|
-
Node-only services are deliberately absent: `send-feedback.ts`
|
|
103
|
-
(`@inquirer/prompts`, stdin) and `environmentInfo.ts` (`node:os`).
|
|
104
|
-
`services.browser.spec.ts` guards the surface and the exclusions.
|
|
105
|
-
|
|
106
|
-
No type declarations ship with this package, so declare the surface structurally
|
|
107
|
-
at the call site — the same way Autopilot already declares `run`/`ready`.
|
|
108
|
-
|
|
109
|
-
## Limitations
|
|
110
|
-
|
|
111
|
-
- **No authentication.** Wiring for credential injection ships in a follow-up (#701). Until then, any command that calls the UiPath Cloud API returns `Not logged in`.
|
|
112
|
-
- **No interactive prompts.** Commands that use `@inquirer/prompts` (e.g. `send-feedback`, `tools install --interactive`) are Node-only and not registered in the browser bundle.
|
|
113
|
-
- **No file-based auth.** `uip login` / `uip logout` are Node-only and excluded from the browser entry.
|
|
114
|
-
- **No subprocess spawning.** `child_process` is not available.
|
|
115
|
-
- **Filesystem is virtual.** All file I/O routes through `@uipath/filesystem`'s `BrowserFileSystem`, backed by LightningFS + IndexedDB. Host-app code that reads/writes files should use `getFileSystem()` / `getFileSystemAsync()` from `@uipath/filesystem`.
|
|
116
|
-
- **Direct `node:fs` / `node:path` imports fail at build time** for any non-commander caller — Rule 10 is enforced by the bundler.
|
|
117
|
-
|
|
118
|
-
## CORS
|
|
119
|
-
|
|
120
|
-
Once auth lands in #701, the bundle will make `fetch()` requests directly to the UiPath Cloud API. The host page's origin must be allow-listed by the target environment, or the host can proxy API calls through its own server to avoid cross-origin preflight.
|
|
121
|
-
|
|
122
|
-
## Troubleshooting
|
|
123
|
-
|
|
124
|
-
**`"Result": "Failure", "Instructions": "Not logged in..."`** — expected for now; auth wiring ships in #701.
|
|
125
|
-
|
|
126
|
-
**`UiPathCLI is not defined`** — bundle hasn't loaded or loaded at a different scope. Confirm the `<script>` tag fires before your init code, or listen for its `load` event.
|
|
127
|
-
|
|
128
|
-
**IndexedDB errors** — the bundle uses LightningFS for its virtual filesystem. Not available in headless environments without IndexedDB polyfills (e.g. `happy-dom` without `fake-indexeddb`).
|