@uipath/uipath-typescript 1.0.0-beta.12 → 1.0.0-beta.14

package/{Readme.md → README.md}

@@ -37,31 +37,32 @@ const tasks = await sdk.tasks.getAll();
 
 The SDK supports two authentication methods:
 
-### 1. Secret-based Authentication
+For OAuth, first create a non confidential [External App](https://docs.uipath.com/automation-cloud/automation-cloud/latest/admin-guide/managing-external-applications) with the required scopes and provide the clientId, redirectUri, and scope here.
+
+### 1. OAuth Authentication
 ```typescript
 const sdk = new UiPath({
   baseUrl: 'https://cloud.uipath.com',
   orgName: 'your-organization',
   tenantName: 'your-tenant',
-  secret: 'your-secret' //PAT Token or Bearer Token 
+  clientId: 'your-client-id',
+  redirectUri: 'your-redirect-uri',
+  scope: 'your-scopes'
 });
+
+// IMPORTANT: OAuth requires calling initialize()
+await sdk.initialize();
 ```
 
-For OAuth, first create a non confidential [External App](https://docs.uipath.com/automation-cloud/automation-cloud/latest/admin-guide/managing-external-applications) with the required scopes and provide the clientId, redirectUri, and scope here.
 
-### 2. OAuth Authentication
+### 2. Secret-based Authentication
 ```typescript
 const sdk = new UiPath({
   baseUrl: 'https://cloud.uipath.com',
   orgName: 'your-organization',
   tenantName: 'your-tenant',
-  clientId: 'your-client-id',
-  redirectUri: 'your-redirect-uri',
-  scope: 'your-scopes'
+  secret: 'your-secret' //PAT Token or Bearer Token 
 });
-
-// IMPORTANT: OAuth requires calling initialize()
-await sdk.initialize();
 ```
 
 ## SDK Initialization - The initialize() Method
@@ -109,6 +110,42 @@ try {
 }
 ```
 
+## OAuth Integration Patterns
+
+### Auto-login on App Load
+```typescript
+useEffect(() => {
+  const initSDK = async () => {
+    const sdk = new UiPath({...oauthConfig});
+    await sdk.initialize();
+  };
+  initSDK();
+}, []);
+```
+
+### User-Triggered Login
+```typescript
+const onLogin = async () => {
+  await sdk.initialize();
+};
+
+// Handle OAuth callback
+const oauthCompleted = useRef(false);
+useEffect(() => {
+  if (sdk.isInitialized() && !oauthCompleted.current) {
+    oauthCompleted.current = true;
+    sdk.completeOAuth();
+  }
+}, []);
+```
+
+### Available OAuth Methods
+- `sdk.initialize()` - Start OAuth flow (auto completes also based on callback state)
+- `sdk.isInitialized()` - Check if SDK initialization completed
+- `sdk.isAuthenticated()` - Check if user has valid token
+- `sdk.isInOAuthCallback()` - Check if processing OAuth redirect
+- `sdk.completeOAuth()` - Manually complete OAuth (advanced use)
+
 ## Available Services
 
 The SDK provides access to the following services through a consistent API:
@@ -255,6 +292,12 @@ if (page5.supportsPageJump) {
 }
 ```
 
+## Samples
+
+Check out the [`/samples`](./samples) folder to see sample applications built using the SDK:
+
+- **[process-app](./samples/process-app)**: A Maestro process management application demonstrating OAuth authentication and SDK usage
+
 ## Development
 
 Before submitting a pull request, please review our [Contribution Guidelines](https://uipath.github.io/uipath-typescript/CONTRIBUTING/).