@io-orkes/conductor-javascript 2.3.0 → 2.4.0

package/dist/index.d.ts

@@ -477,6 +477,15 @@ type EventMessage = {
     status?: 'RECEIVED' | 'HANDLED' | 'REJECTED';
     statusDescription?: string;
 };
+type ExtendedConductorApplication$1 = {
+    createTime?: number;
+    createdBy?: string;
+    id?: string;
+    name?: string;
+    tags?: Array<Tag>;
+    updateTime?: number;
+    updatedBy?: string;
+};
 type ExtendedEventExecution = {
     action?: 'start_workflow' | 'complete_task' | 'fail_task' | 'terminate_workflow' | 'update_workflow_variables';
     created?: number;
@@ -2775,6 +2784,19 @@ interface SignalResponse extends SignalResponse$1 {
     taskDefName?: string;
     workflowType?: string;
 }
+interface AccessKey {
+    id: string;
+    secret: string;
+}
+interface AccessKeyInfo {
+    id: string;
+    createdAt: number;
+    status: "ACTIVE" | "INACTIVE";
+}
+type ApplicationRole = "ADMIN" | "UNRESTRICTED_WORKER" | "METADATA_MANAGER" | "WORKFLOW_MANAGER" | "APPLICATION_MANAGER" | "USER" | "USER_READ_ONLY" | "WORKER" | "APPLICATION_CREATOR" | "METADATA_API" | "PROMPT_MANAGER";
+interface ExtendedConductorApplication extends Required<Omit<ExtendedConductorApplication$1, "tags">> {
+    tags?: Tag[];
+}
 
 type TimeoutPolicy = {
     type: string;
@@ -3831,6 +3853,238 @@ declare class EventClient {
     getEventMessages(event: string, from?: number): Promise<EventMessage[]>;
 }
 
+/**
+ * Client for interacting with the Service Registry API
+ */
+declare class ServiceRegistryClient {
+    readonly _client: Client;
+    constructor(client: Client);
+    /**
+     * Retrieve all registered services
+     * @returns Array of all registered services
+     */
+    getRegisteredServices(): Promise<ServiceRegistry[]>;
+    /**
+     * Remove a service by name
+     * @param name The name of the service to remove
+     * @returns Promise that resolves when service is removed
+     */
+    removeService(name: string): Promise<void>;
+    /**
+     * Get a service by name
+     * @param name The name of the service to retrieve
+     * @returns The requested service registry
+     */
+    getService(name: string): Promise<ServiceRegistry | undefined>;
+    /**
+     * Open the circuit breaker for a service
+     * @param name The name of the service
+     * @returns Response with circuit breaker status
+     */
+    openCircuitBreaker(name: string): Promise<CircuitBreakerTransitionResponse>;
+    /**
+     * Close the circuit breaker for a service
+     * @param name The name of the service
+     * @returns Response with circuit breaker status
+     */
+    closeCircuitBreaker(name: string): Promise<CircuitBreakerTransitionResponse>;
+    /**
+     * Get circuit breaker status for a service
+     * @param name The name of the service
+     * @returns Response with circuit breaker status
+     */
+    getCircuitBreakerStatus(name: string): Promise<CircuitBreakerTransitionResponse>;
+    /**
+     * Add or update a service registry
+     * @param serviceRegistry The service registry to add or update
+     * @returns Promise that resolves when service is added or updated
+     */
+    addOrUpdateService(serviceRegistry: ServiceRegistry): Promise<void>;
+    /**
+     * Add or update a service method
+     * @param registryName The name of the registry
+     * @param method The service method to add or update
+     * @returns Promise that resolves when method is added or updated
+     */
+    addOrUpdateServiceMethod(registryName: string, method: ServiceMethod): Promise<void>;
+    /**
+     * Remove a service method
+     * @param registryName The name of the registry
+     * @param serviceName The name of the service
+     * @param method The name of the method
+     * @param methodType The type of the method
+     * @returns Promise that resolves when method is removed
+     */
+    removeMethod(registryName: string, serviceName: string, method: string, methodType: string): Promise<void>;
+    /**
+     * Get proto data
+     * @param registryName The name of the registry
+     * @param filename The name of the proto file
+     * @returns The proto file data as a Blob
+     */
+    getProtoData(registryName: string, filename: string): Promise<Blob>;
+    /**
+     * Set proto data
+     * @param registryName The name of the registry
+     * @param filename The name of the proto file
+     * @param data The proto file data
+     * @returns Promise that resolves when proto data is set
+     */
+    setProtoData(registryName: string, filename: string, data: Blob): Promise<void>;
+    /**
+     * Delete a proto file
+     * @param registryName The name of the registry
+     * @param filename The name of the proto file
+     * @returns Promise that resolves when proto file is deleted
+     */
+    deleteProto(registryName: string, filename: string): Promise<void>;
+    /**
+     * Get all proto files for a registry
+     * @param registryName The name of the registry
+     * @returns List of proto registry entries
+     */
+    getAllProtos(registryName: string): Promise<ProtoRegistryEntry[]>;
+    /**
+     * Discover service methods
+     * @param name The name of the service
+     * @param create Whether to create the discovered methods (defaults to false)
+     * @returns The discovered service methods
+     */
+    discover(name: string, create?: boolean): Promise<ServiceMethod[]>;
+}
+
+declare class ApplicationClient {
+    readonly _client: Client;
+    constructor(client: Client);
+    /**
+     * Get all applications
+     * @returns {Promise<ExtendedConductorApplication[]>}
+     * @throws {ConductorSdkError}
+     */
+    getAllApplications(): Promise<ExtendedConductorApplication[]>;
+    /**
+     * Create an application
+     * @param {string} applicationName
+     * @returns {Promise<ExtendedConductorApplication>}
+     * @throws {ConductorSdkError}
+     */
+    createApplication(applicationName: string): Promise<ExtendedConductorApplication>;
+    /**
+     * Get application by access key id
+     * @param {string} accessKeyId
+     * @returns {Promise<ExtendedConductorApplication>}
+     * @throws {ConductorSdkError}
+     */
+    getAppByAccessKeyId(accessKeyId: string): Promise<ExtendedConductorApplication>;
+    /**
+     * Delete an access key
+     * @param {string} applicationId
+     * @param {string} keyId
+     * @returns {Promise<void>}
+     * @throws {ConductorSdkError}
+     */
+    deleteAccessKey(applicationId: string, keyId: string): Promise<void>;
+    /**
+     * Toggle the status of an access key
+     * @param {string} applicationId
+     * @param {string} keyId
+     * @returns {Promise<AccessKeyInfo>}
+     * @throws {ConductorSdkError}
+     */
+    toggleAccessKeyStatus(applicationId: string, keyId: string): Promise<AccessKeyInfo>;
+    /**
+     * Remove role from application user
+     * @param {string} applicationId
+     * @param {string} role
+     * @returns {Promise<void>}
+     * @throws {ConductorSdkError}
+     */
+    removeRoleFromApplicationUser(applicationId: string, role: string): Promise<void>;
+    /**
+     * Add role to application
+     * @param {string} applicationId
+     * @param {ApplicationRole} role
+     * @returns {Promise<void>}
+     * @throws {ConductorSdkError}
+     */
+    addApplicationRole(applicationId: string, role: ApplicationRole): Promise<void>;
+    /**
+     * Delete an application
+     * @param {string} applicationId
+     * @returns {Promise<void>}
+     * @throws {ConductorSdkError}
+     */
+    deleteApplication(applicationId: string): Promise<void>;
+    /**
+     * Get an application by id
+     * @param {string} applicationId
+     * @returns {Promise<ExtendedConductorApplication>}
+     * @throws {ConductorSdkError}
+     */
+    getApplication(applicationId: string): Promise<ExtendedConductorApplication>;
+    /**
+     * Update an application
+     * @param {string} applicationId
+     * @param {string} newApplicationName
+     * @returns {Promise<ExtendedConductorApplication>}
+     * @throws {ConductorSdkError}
+     */
+    updateApplication(applicationId: string, newApplicationName: string): Promise<ExtendedConductorApplication>;
+    /**
+     * Get application's access keys
+     * @param {string} applicationId
+     * @returns {Promise<AccessKeyInfo[]>}
+     * @throws {ConductorSdkError}
+     */
+    getAccessKeys(applicationId: string): Promise<AccessKeyInfo[]>;
+    /**
+     * Create an access key for an application
+     * @param {string} applicationId
+     * @returns {Promise<AccessKey>}
+     * @throws {ConductorSdkError}
+     */
+    createAccessKey(applicationId: string): Promise<AccessKey>;
+    /**
+     * Delete application tags
+     * @param {string} applicationId
+     * @param {Tag[]} tags
+     * @returns {Promise<void>}
+     * @throws {ConductorSdkError}
+     */
+    deleteApplicationTags(applicationId: string, tags: Tag[]): Promise<void>;
+    /**
+     * Delete a single application tag
+     * @param {string} applicationId
+     * @param {Tag} tag
+     * @returns {Promise<void>}
+     * @throws {ConductorSdkError}
+     */
+    deleteApplicationTag(applicationId: string, tag: Tag): Promise<void>;
+    /**
+     * Get application tags
+     * @param {string} applicationId
+     * @returns {Promise<Tag[]>}
+     * @throws {ConductorSdkError}
+     */
+    getApplicationTags(applicationId: string): Promise<Tag[]>;
+    /**
+     * Add application tags
+     * @param {string} applicationId
+     * @param {Tag[]} tags
+     * @returns {Promise<void>}
+     * @throws {ConductorSdkError}
+     */
+    addApplicationTags(applicationId: string, tags: Tag[]): Promise<void>;
+    /**
+     * Add a single application tag
+     * @param {string} applicationId
+     * @param {Tag} tag
+     * @returns {Promise<void>}
+     * @throws {ConductorSdkError}
+     */
+    addApplicationTag(applicationId: string, tag: Tag): Promise<void>;
+}
+
 interface OrkesApiConfig {
     serverUrl?: string;
     keyId?: string;
@@ -4050,4 +4304,4 @@ declare const orkesConductorClient: (config?: OrkesApiConfig, customFetch?: type
     interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>;
 }>;
 
-export { type Action, ApiError, type ApiRequestOptions, type ApiResult, type Auth, BaseHttpRequest, CancelError, CancelablePromise, type CircuitBreakerTransitionResponse, type Client, type ClientOptions, type CommonTaskDef, type ConductorClient, type ConductorLogLevel, type ConductorLogger, ConductorSdkError, type ConductorWorker, type Config, type ConnectivityTestInput, type ConnectivityTestResult, Consistency, DefaultLogger, type DefaultLoggerConfig, type DoWhileTaskDef, type EnhancedSignalResponse, EventClient, type EventHandler, type EventMessage, type EventTaskDef, type ExtendedEventExecution, type ExtendedTaskDef, type ExtendedWorkflowDef, type ExternalStorageLocation, type ForkJoinDynamicDef, type ForkJoinTaskDef, type GenerateTokenRequest, type HTScrollableSearchResultHumanTaskEntry, type HttpInputParameters, type HttpTaskDef, HumanExecutor, type HumanTaskAssignment, type HumanTaskDefinition, type HumanTaskEntry, type HumanTaskSearch, type HumanTaskSearchResult, type HumanTaskTemplate, type HumanTaskTrigger, type HumanTaskUser, type InlineTaskDef, type InlineTaskInputParameters, type JoinTaskDef, type JsonJQTransformTaskDef, type KafkaPublishInputParameters, type KafkaPublishTaskDef, MAX_RETRIES, MetadataClient, type Middleware, type OnCancel, type OpenAPIConfig, type OrkesApiConfig, type PollData, type ProtoRegistryEntry, type QuerySerializerOptions, type RequestOptions, type RerunWorkflowRequest, type ResolvedRequestOptions, type Response$1 as Response, ReturnStrategy, type RunnerArgs, type SaveScheduleRequest, SchedulerClient, type ScrollableSearchResultWorkflowSummary, type SearchResultHandledEventResponse, type SearchResultTask, type SearchResultTaskSummary, type SearchResultWorkflow, type SearchResultWorkflowScheduleExecutionModel, type SearchResultWorkflowSummary, type ServiceMethod, type ServiceRegistry, ServiceType, type SetVariableTaskDef, type SignalResponse, type SimpleTaskDef, type SkipTaskRequest, type StartWorkflow, type StartWorkflowRequest, type StreamEvent, type SubWorkflowParams, type SubWorkflowTaskDef, type SwitchTaskDef, type Tag, type Task, TaskClient, type TaskDef, type TaskDefTypes, type TaskDetails, type TaskErrorHandler, type TaskExecLog, type TaskFinderPredicate, type TaskListSearchResultSummary, TaskManager, type TaskManagerConfig, type TaskManagerOptions, type TaskResult, type TaskResultOutputData, type TaskResultStatus, TaskResultStatusEnum, TaskRunner, type TaskRunnerOptions, type TaskSummary, TaskType, TemplateClient, type Terminate, type TerminateTaskDef, type TimeoutPolicy, type UserFormTemplate, type WaitTaskDef, type Workflow, type WorkflowDef$1 as WorkflowDef, WorkflowExecutor, type WorkflowRun, type WorkflowSchedule, type WorkflowScheduleExecutionModel, type WorkflowScheduleModel, type WorkflowStatus, type WorkflowSummary, type WorkflowTask, completedTaskMatchingType, conductorEventTask, doWhileTask, dynamicForkTask, eventTask, forkTask, forkTaskJoin, generate, generateDoWhileTask, generateEventTask, generateForkJoinTask, generateHTTPTask, generateInlineTask, generateJQTransformTask, generateJoinTask, generateKafkaPublishTask, generateSetVariableTask, generateSimpleTask, generateSubWorkflowTask, generateSwitchTask, generateTerminateTask, generateWaitTask, httpTask, inlineTask, joinTask, jsonJqTask, kafkaPublishTask, newLoopTask, noopErrorHandler, noopLogger, orkesConductorClient, setVariableTask, simpleTask, sqsEventTask, subWorkflowTask, switchTask, taskDefinition, taskGenMapper, terminateTask, waitTaskDuration, waitTaskUntil, workflow };
+export { type AccessKey, type AccessKeyInfo, type Action, ApiError, type ApiRequestOptions, type ApiResult, ApplicationClient, type ApplicationRole, type Auth, BaseHttpRequest, CancelError, CancelablePromise, type CircuitBreakerTransitionResponse, type Client, type ClientOptions, type CommonTaskDef, type ConductorClient, type ConductorLogLevel, type ConductorLogger, ConductorSdkError, type ConductorWorker, type Config, type ConnectivityTestInput, type ConnectivityTestResult, Consistency, DefaultLogger, type DefaultLoggerConfig, type DoWhileTaskDef, type EnhancedSignalResponse, EventClient, type EventHandler, type EventMessage, type EventTaskDef, type ExtendedConductorApplication, type ExtendedEventExecution, type ExtendedTaskDef, type ExtendedWorkflowDef, type ExternalStorageLocation, type ForkJoinDynamicDef, type ForkJoinTaskDef, type GenerateTokenRequest, type HTScrollableSearchResultHumanTaskEntry, type HttpInputParameters, type HttpTaskDef, HumanExecutor, type HumanTaskAssignment, type HumanTaskDefinition, type HumanTaskEntry, type HumanTaskSearch, type HumanTaskSearchResult, type HumanTaskTemplate, type HumanTaskTrigger, type HumanTaskUser, type InlineTaskDef, type InlineTaskInputParameters, type JoinTaskDef, type JsonJQTransformTaskDef, type KafkaPublishInputParameters, type KafkaPublishTaskDef, MAX_RETRIES, MetadataClient, type Middleware, type OnCancel, type OpenAPIConfig, type OrkesApiConfig, type PollData, type ProtoRegistryEntry, type QuerySerializerOptions, type RequestOptions, type RerunWorkflowRequest, type ResolvedRequestOptions, type Response$1 as Response, ReturnStrategy, type RunnerArgs, type SaveScheduleRequest, SchedulerClient, type ScrollableSearchResultWorkflowSummary, type SearchResultHandledEventResponse, type SearchResultTask, type SearchResultTaskSummary, type SearchResultWorkflow, type SearchResultWorkflowScheduleExecutionModel, type SearchResultWorkflowSummary, type ServiceMethod, type ServiceRegistry, ServiceRegistryClient, ServiceType, type SetVariableTaskDef, type SignalResponse, type SimpleTaskDef, type SkipTaskRequest, type StartWorkflow, type StartWorkflowRequest, type StreamEvent, type SubWorkflowParams, type SubWorkflowTaskDef, type SwitchTaskDef, type Tag, type Task, TaskClient, type TaskDef, type TaskDefTypes, type TaskDetails, type TaskErrorHandler, type TaskExecLog, type TaskFinderPredicate, type TaskListSearchResultSummary, TaskManager, type TaskManagerConfig, type TaskManagerOptions, type TaskResult, type TaskResultOutputData, type TaskResultStatus, TaskResultStatusEnum, TaskRunner, type TaskRunnerOptions, type TaskSummary, TaskType, TemplateClient, type Terminate, type TerminateTaskDef, type TimeoutPolicy, type UserFormTemplate, type WaitTaskDef, type Workflow, type WorkflowDef$1 as WorkflowDef, WorkflowExecutor, type WorkflowRun, type WorkflowSchedule, type WorkflowScheduleExecutionModel, type WorkflowScheduleModel, type WorkflowStatus, type WorkflowSummary, type WorkflowTask, completedTaskMatchingType, conductorEventTask, doWhileTask, dynamicForkTask, eventTask, forkTask, forkTaskJoin, generate, generateDoWhileTask, generateEventTask, generateForkJoinTask, generateHTTPTask, generateInlineTask, generateJQTransformTask, generateJoinTask, generateKafkaPublishTask, generateSetVariableTask, generateSimpleTask, generateSubWorkflowTask, generateSwitchTask, generateTerminateTask, generateWaitTask, httpTask, inlineTask, joinTask, jsonJqTask, kafkaPublishTask, newLoopTask, noopErrorHandler, noopLogger, orkesConductorClient, setVariableTask, simpleTask, sqsEventTask, subWorkflowTask, switchTask, taskDefinition, taskGenMapper, terminateTask, waitTaskDuration, waitTaskUntil, workflow };