@kuflow/kuflow-temporal-worker/lib/kuflow-temporal-connection.d.ts

Worker library used by KuFlow SDKs and Temporal.

/**
 * The MIT License
 * Copyright © 2021-present KuFlow S.L.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
import { NativeConnection, Worker } from '@temporalio/worker';
import type { KuFlowTemporalConnectionOptions } from './kuflow-temporal-connection-options';
/**
 * Configure a temporal client and worker with KuFlow requirements.
 */
export declare class KuFlowTemporalConnection {
    private readonly options;
    /**
     * Get the registered workflow types
     */
    get workflowTypes(): string[];
    /**
     * Get the registered activity types
     */
    get activityTypes(): string[];
    /**
     * Get the nativeConnection started
     */
    get nativeConnection(): NativeConnection | undefined;
    /**
     * Get the worker started
     */
    get worker(): Worker | undefined;
    private _workflowTypes;
    private _activityTypes;
    private _nativeConnection?;
    private _worker?;
    private _kuFlowAuthorizationTokenProvider?;
    private _kuflowWorkerInformationNotifier?;
    static instance(options: KuFlowTemporalConnectionOptions): Promise<KuFlowTemporalConnection>;
    private constructor();
    /**
     * Eagerly connect to the Temporal server and return a NativeConnection instance
     */
    connect(): Promise<NativeConnection>;
    private applyDefaultConfiguration;
    /**
     * Create a new Worker. This method initiates a connection to the server and will throw (asynchronously) on connection failure.
     */
    createWorker(): Promise<Worker>;
    /**
     * Start the temporal worker configured.
     */
    runWorker(): Promise<void>;
    /**
     * Shutdown the worker (if is started) and all related objects that need to be closed.
     */
    close(): Promise<void>;
}