@uipath/uipath-typescript 1.1.0 → 1.1.2

package/dist/core/index.d.ts

@@ -16,6 +16,9 @@ type UiPathSDKConfig = BaseConfig & ({
 } | ({
     secret?: never;
 } & OAuthFields));
+type PartialUiPathConfig = Partial<BaseConfig & OAuthFields & {
+    secret: string;
+}>;
 
 /**
  * IUiPath - Interface for UiPath SDK instance
@@ -56,6 +59,11 @@ interface IUiPath {
      * Get the current authentication token
      */
     getToken(): string | undefined;
+    /**
+     * Logout from the SDK, clearing all authentication state.
+     * After calling this method, the user will need to re-initialize to authenticate again.
+     */
+    logout(): void;
 }
 
 /**
@@ -64,12 +72,13 @@ interface IUiPath {
  * Handles authentication, configuration, and provides access to SDK internals
  * for service instantiation in the modular pattern.
  *
+ * Supports two usage patterns:
+ * 1. Full config in constructor — for server-side or explicit configuration
+ * 2. No config / partial config — loads from meta tags injected by @uipath/coded-apps plugin
+ *
  * @example
  * ```typescript
- * // Modular pattern
- * import { UiPath } from '@uipath/uipath-typescript/core';
- * import { Entities } from '@uipath/uipath-typescript/entities';
- *
+ * // Explicit config
  * const sdk = new UiPath({
  *   baseUrl: 'https://cloud.uipath.com',
  *   orgName: 'myorg',
@@ -78,22 +87,26 @@ interface IUiPath {
  *   redirectUri: 'http://localhost:3000/callback',
  *   scope: 'OR.Users OR.Robots'
  * });
- *
  * await sdk.initialize();
+ * ```
  *
- * const entitiesService = new Entities(sdk);
- * const allEntities = await entitiesService.getAll();
+ * @example
+ * ```typescript
+ * // Auto-load from meta tags (coded apps)
+ * const sdk = new UiPath();
+ * await sdk.initialize();
  * ```
  */
 declare class UiPath implements IUiPath {
     #private;
     /** Read-only config for user convenience */
     readonly config: Readonly<BaseConfig>;
-    constructor(config: UiPathSDKConfig);
+    constructor(config?: PartialUiPathConfig);
     /**
      * Initialize the SDK based on the provided configuration.
      * This method handles both OAuth flow initiation and completion automatically.
      * For secret-based authentication, initialization is automatic and this returns immediately.
+     * If no config was provided in constructor, loads from meta tags.
      */
     initialize(): Promise<void>;
     /**
@@ -116,6 +129,11 @@ declare class UiPath implements IUiPath {
      * Get the current authentication token
      */
     getToken(): string | undefined;
+    /**
+     * Logout from the SDK, clearing all authentication state.
+     * After calling this method, the user will need to re-initialize to authenticate again.
+     */
+    logout(): void;
 }
 
 /**
@@ -394,5 +412,103 @@ declare const DEFAULT_TOTAL_COUNT_FIELD = "@odata.count";
  */
 declare function getLimitedPageSize(pageSize?: number): number;
 
-export { AuthenticationError, AuthorizationError, DEFAULT_ITEMS_FIELD, DEFAULT_PAGE_SIZE, DEFAULT_TOTAL_COUNT_FIELD, ErrorType, HttpStatus, MAX_PAGE_SIZE, NetworkError, NotFoundError, RateLimitError, ServerError, UiPath, UiPathError, ValidationError, getErrorDetails, getLimitedPageSize, isAuthenticationError, isAuthorizationError, isNetworkError, isNotFoundError, isRateLimitError, isServerError, isUiPathError, isValidationError };
+/**
+ * Telemetry type definitions
+ */
+interface TelemetryAttributes {
+    [key: string]: string | number | boolean;
+}
+interface TelemetryConfig {
+    baseUrl?: string;
+    orgName?: string;
+    tenantName?: string;
+    clientId?: string;
+    redirectUri?: string;
+}
+interface TrackOptions {
+    condition?: boolean | ((...args: any[]) => boolean);
+    attributes?: TelemetryAttributes;
+}
+
+/**
+ * SDK Track decorator and function for telemetry
+ */
+
+/**
+ * Track decorator that can be used to automatically track function calls
+ *
+ * Usage:
+ * @track("Service.Method")
+ * function myFunction() { ... }
+ *
+ * @track("Queue.GetAll")
+ * async getAll() { ... }
+ *
+ * @track("Tasks.Create")
+ * async create() { ... }
+ *
+ * @track("Assets.Update", { condition: false })
+ * function myFunction() { ... }
+ *
+ * @track("Processes.Start", { attributes: { customProp: "value" } })
+ * function myFunction() { ... }
+ */
+declare function track(nameOrOptions?: string | TrackOptions, options?: TrackOptions): MethodDecorator | ((target: any) => any);
+/**
+ * Direct tracking function
+ */
+declare function trackEvent(eventName: string, name?: string, attributes?: TelemetryAttributes): void;
+
+/**
+ * Singleton telemetry client
+ */
+declare class TelemetryClient {
+    private static instance;
+    private isInitialized;
+    private logProvider?;
+    private logger?;
+    private telemetryContext?;
+    private constructor();
+    static getInstance(): TelemetryClient;
+    /**
+     * Initialize telemetry
+     */
+    initialize(config?: TelemetryConfig): void;
+    private getConnectionString;
+    private setupTelemetryProvider;
+    /**
+     * Track a telemetry event
+     */
+    track(eventName: string, name?: string, extraAttributes?: TelemetryAttributes): void;
+    /**
+     * Get enriched attributes for telemetry events
+     */
+    private getEnrichedAttributes;
+    /**
+     * Create cloud URL from base URL, organization ID, and tenant ID
+     */
+    private createCloudUrl;
+}
+declare const telemetryClient: TelemetryClient;
+
+/**
+ * SDK Telemetry constants
+ */
+declare const CONNECTION_STRING = "InstrumentationKey=a6efa11d-1feb-4508-9738-e13e12dcae5e;IngestionEndpoint=https://westeurope-5.in.applicationinsights.azure.com/;LiveEndpoint=https://westeurope.livediagnostics.monitor.azure.com/;ApplicationId=7c58eb1c-9581-4ba6-839e-11725848a037";
+declare const SDK_VERSION = "1.1.2";
+declare const VERSION = "Version";
+declare const SERVICE = "Service";
+declare const CLOUD_ORGANIZATION_NAME = "CloudOrganizationName";
+declare const CLOUD_TENANT_NAME = "CloudTenantName";
+declare const CLOUD_URL = "CloudUrl";
+declare const CLOUD_CLIENT_ID = "CloudClientId";
+declare const CLOUD_REDIRECT_URI = "CloudRedirectUri";
+declare const APP_NAME = "ApplicationName";
+declare const CLOUD_ROLE_NAME = "uipath-ts-sdk";
+declare const SDK_SERVICE_NAME = "UiPath.TypeScript.Sdk";
+declare const SDK_LOGGER_NAME = "uipath-ts-sdk-telemetry";
+declare const SDK_RUN_EVENT = "Sdk.Run";
+declare const UNKNOWN = "";
+
+export { APP_NAME, AuthenticationError, AuthorizationError, CLOUD_CLIENT_ID, CLOUD_ORGANIZATION_NAME, CLOUD_REDIRECT_URI, CLOUD_ROLE_NAME, CLOUD_TENANT_NAME, CLOUD_URL, CONNECTION_STRING, DEFAULT_ITEMS_FIELD, DEFAULT_PAGE_SIZE, DEFAULT_TOTAL_COUNT_FIELD, ErrorType, HttpStatus, MAX_PAGE_SIZE, NetworkError, NotFoundError, RateLimitError, SDK_LOGGER_NAME, SDK_RUN_EVENT, SDK_SERVICE_NAME, SDK_VERSION, SERVICE, ServerError, UNKNOWN, UiPath, UiPathError, VERSION, ValidationError, getErrorDetails, getLimitedPageSize, isAuthenticationError, isAuthorizationError, isNetworkError, isNotFoundError, isRateLimitError, isServerError, isUiPathError, isValidationError, telemetryClient, track, trackEvent };
 export type { HasPaginationOptions, NonPaginatedResponse, PaginatedResponse, PaginationCursor, PaginationMethodUnion, PaginationOptions, UiPathSDKConfig };