@uipath/integrationservice-tool 0.1.12 → 0.9.1

package/README.md

@@ -345,6 +345,69 @@ uip is connectors list -t staging-tenant
 
 ---
 
+## Caching
+
+The tool caches metadata locally to reduce API calls and improve response times. Cache files are stored at:
+
+```
+~/.uipath/cache/integrationservice/{tenantId}/
+```
+
+### Tenant Isolation
+
+Cache is scoped by **tenant ID**, not tenant name. This means:
+- Switching between tenants (`--tenant`) or accounts (`uip login`) always reads/writes a separate cache directory.
+- No cross-tenant data leakage — tenant A's cached connectors are never served to tenant B.
+
+When `--tenant <name>` points to a different tenant than the current login, the tool resolves the tenant name to its ID via the UiPath API (once per invocation, then memoized).
+
+### TTL (Time-To-Live)
+
+Each cache type has a default TTL. After expiry, the next read returns a cache miss and the data is re-fetched from the API.
+
+| Cache type | TTL | File pattern |
+|---|---|---|
+| Connectors | 24 hours | `connectors.json` |
+| Activities | 24 hours | `{connector}/activities.json` |
+| Connections | 1 hour | `{connector}/connections.json` |
+| Resources | 4 hours | `{connector}/{connection}/resources.json` |
+| Schema | 4 hours | `{connector}/{connection}/{object}.schema.json` |
+| Trigger objects | 4 hours | `{connector}/{connection}/triggers/{op}/objects.json` |
+| Trigger metadata | 4 hours | `{connector}/{connection}/triggers/{op}/{object}.metadata.json` |
+
+### Cache Format
+
+Each cache file is wrapped in an envelope:
+
+```json
+{
+  "cachedAt": 1719000000000,
+  "data": [ ... ]
+}
+```
+
+Old cache files (without the `cachedAt` envelope) are treated as expired and automatically re-fetched.
+
+### Bypassing the Cache
+
+Use `--refresh` on any command that supports it to force a fresh API call, ignoring cached data:
+
+```bash
+# Force re-fetch connectors
+uip is connectors list --refresh
+
+# Force re-fetch connections
+uip is connections list uipath-salesforce-sfdc --refresh
+
+# Force re-fetch resources
+uip is resources list uipath-salesforce-sfdc --refresh
+
+# Force re-fetch schema
+uip is resources describe uipath-salesforce-sfdc Account --refresh
+```
+
+---
+
 ## Authentication
 
 All commands require authentication via `uip login`:
@@ -415,21 +478,5 @@ The tool interacts with these Integration Service APIs:
 
 ---
 
-## Versions
-
-### integrationservice-tool 0.0.1
-
-**Features:**
-- List and get connectors
-- List connections (with folder filtering and status warnings)
-- Create connections (OAuth flow with browser opening)
-- Ping connections (verify connection is active)
-- Edit/re-authenticate connections (OAuth re-auth flow)
-- List and describe resources (filtered by operation, with metadata caching)
-- List activities (non-trigger only)
-- Execute CRUD operations on resources (create, list, get, update, replace, delete)
-- File-based metadata caching for token optimization
-- Multi-format output (table, json, yaml, plain)
-- Multi-environment support
-- Query parameters and request body support
+See [RELEASE_NOTES.md](./RELEASE_NOTES.md) for version history.