@uipath/case-tool 0.1.14 → 0.9.0
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 +84 -4
- package/dist/tool.js +208863 -102781
- package/package.json +13 -11
package/README.md
CHANGED
|
@@ -45,11 +45,12 @@ uip case registry pull [options]
|
|
|
45
45
|
| `api` | API workflows |
|
|
46
46
|
| `processOrchestration` | Agentic processes |
|
|
47
47
|
| `caseManagement` | Case management workflows |
|
|
48
|
-
| `typecache` |
|
|
48
|
+
| `typecache-activities` | Connector activities (Integration Service) |
|
|
49
|
+
| `typecache-triggers` | Connector triggers (Integration Service) |
|
|
49
50
|
| `action-apps` | Deployed human action apps |
|
|
50
51
|
| `solution` | Solution entities (requires `--solutionId`) |
|
|
51
52
|
|
|
52
|
-
**Cache behavior:** Results are cached for 30 minutes in `~/.
|
|
53
|
+
**Cache behavior:** Results are cached for 30 minutes in `~/.uip/case-resources/`. Subsequent `pull` calls within that window return cached data unless `--force` is passed.
|
|
53
54
|
|
|
54
55
|
**Example output:**
|
|
55
56
|
|
|
@@ -70,6 +71,84 @@ uip case registry pull [options]
|
|
|
70
71
|
|
|
71
72
|
---
|
|
72
73
|
|
|
74
|
+
### `registry search`
|
|
75
|
+
|
|
76
|
+
Search for resources by keyword and/or structured field filters.
|
|
77
|
+
|
|
78
|
+
```bash
|
|
79
|
+
uip case registry search [keyword] [options]
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
| Option | Description |
|
|
83
|
+
| :--- | :--- |
|
|
84
|
+
| `-t, --type <type>` | Limit search to a specific resource type (see types above) |
|
|
85
|
+
| `-f, --filter <filter>` | Field filters, e.g. `name:contains=Apple,category=Pipelines` |
|
|
86
|
+
| `--output <type>` | Output format: `json`, `table`, `yaml`, `plain` |
|
|
87
|
+
|
|
88
|
+
**Filter syntax:**
|
|
89
|
+
|
|
90
|
+
```
|
|
91
|
+
field=value equality (default)
|
|
92
|
+
field:contains=value field contains value
|
|
93
|
+
field:startsWith=value field starts with value
|
|
94
|
+
field:endsWith=value field ends with value
|
|
95
|
+
field:in=value1|value2 field matches any of the values
|
|
96
|
+
field1=v1,field2=v2 multiple conditions (AND logic)
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
Filterable fields: `name`, `description`, `category`, `tags`
|
|
100
|
+
|
|
101
|
+
**Examples:**
|
|
102
|
+
|
|
103
|
+
```bash
|
|
104
|
+
# Search connectors by keyword
|
|
105
|
+
uip case registry search outlook --type typecache-activities
|
|
106
|
+
|
|
107
|
+
# Filter by category
|
|
108
|
+
uip case registry search --filter "category:contains=Salesforce" --type typecache-activities
|
|
109
|
+
|
|
110
|
+
# Search across all resource types
|
|
111
|
+
uip case registry search "send email"
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
---
|
|
115
|
+
|
|
116
|
+
### `registry get`
|
|
117
|
+
|
|
118
|
+
Get a resource by its identifier. For connector activities and triggers, automatically enriches the result with input/output field metadata from Integration Service.
|
|
119
|
+
|
|
120
|
+
```bash
|
|
121
|
+
uip case registry get <identifier> [options]
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
| Argument/Option | Description |
|
|
125
|
+
| :--- | :--- |
|
|
126
|
+
| `<identifier>` | `entityKey` (process-types), `id` (action-apps), or `uiPathActivityTypeId` (connectors) |
|
|
127
|
+
| `--connection-id <id>` | Connection ID for connection-specific IS field metadata (custom fields). Only applies to `typecache-activities` / `typecache-triggers` results. |
|
|
128
|
+
| `--output <type>` | Output format: `json`, `table`, `yaml`, `plain` |
|
|
129
|
+
|
|
130
|
+
**Connector enrichment:** When the matched resource is a `typecache-activities` or `typecache-triggers` entry, the result is automatically enriched with `inputDefinition` and `outputDefinition` fields fetched from Integration Service. These describe the available input/output fields for that connector activity, including field types, required flags, descriptions, and enum values.
|
|
131
|
+
|
|
132
|
+
- Without `--connection-id`: returns standard/base fields for the connector object.
|
|
133
|
+
- With `--connection-id`: returns connection-specific fields including custom fields tied to that account.
|
|
134
|
+
|
|
135
|
+
If Integration Service is unavailable or the activity has no associated IS object (non-curated), the resource is returned as-is without enrichment.
|
|
136
|
+
|
|
137
|
+
**Examples:**
|
|
138
|
+
|
|
139
|
+
```bash
|
|
140
|
+
# Get a connector activity with IS field metadata
|
|
141
|
+
uip case registry get 696568b6-0a38-3a97-8831-38e3cf3588fa
|
|
142
|
+
|
|
143
|
+
# Get with connection-specific custom fields
|
|
144
|
+
uip case registry get 696568b6-0a38-3a97-8831-38e3cf3588fa --connection-id <your-connection-id>
|
|
145
|
+
|
|
146
|
+
# Get an agent by entityKey
|
|
147
|
+
uip case registry get my-agent-entity-key
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
---
|
|
151
|
+
|
|
73
152
|
### `registry list`
|
|
74
153
|
|
|
75
154
|
List all locally cached resources.
|
|
@@ -196,7 +275,7 @@ Edge type is inferred from the source node: Trigger → `TriggerEdge`, Stage →
|
|
|
196
275
|
|
|
197
276
|
## Local Cache
|
|
198
277
|
|
|
199
|
-
Resources are stored in `~/.
|
|
278
|
+
Resources are stored in `~/.uip/case-resources/` as JSON files:
|
|
200
279
|
|
|
201
280
|
| File | Contents |
|
|
202
281
|
| :--- | :--- |
|
|
@@ -211,5 +290,6 @@ Change detection uses SHA-256 hashing — if the fetched data is identical to th
|
|
|
211
290
|
| :--- | :--- |
|
|
212
291
|
| `agent`, `process`, `api`, `processOrchestration`, `caseManagement` | `/{accountId}/{tenantId}/resourcecatalog_/Entities/Process?entitySubType=<type>` |
|
|
213
292
|
| `action-apps` | `/{accountId}/apps_/default/api/v1/default/action-apps?state=deployed` |
|
|
214
|
-
| `typecache` | `/{accountId}/studio_/typecache/api/Activities/SearchActivities` |
|
|
293
|
+
| `typecache-activities` | `/{accountId}/studio_/typecache/api/Activities/SearchActivities` |
|
|
294
|
+
| `typecache-triggers` | `/{accountId}/studio_/typecache/api/Activities/SearchTriggers` |
|
|
215
295
|
| `solution` | `/{accountId}/studio_/backend/api/resourcebuilder/solutions/{solutionId}/entities` |
|