@opentap/runner-client 1.0.0-alpha.37.12

package/lib/RunnerClient.d.ts

@@ -0,0 +1,185 @@
+import { BaseClient } from './BaseClient';
+import { ComponentSettingsBase, ComponentSettingsIdentifier, ComponentSettingsListItem, DataGridControl, ErrorResponse, FileParameter, FileResponse, Image, Links, ListItemType, ProfileGroup, RepositoryPackageReference, RepositorySettingsPackageDefinition, Session, SettingsTapPackage } from './DTOs';
+export declare class RunnerClient extends BaseClient {
+    private http;
+    private baseUrl;
+    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
+    constructor(baseSubject: string, server: string);
+    /**
+     * Generic error callback function.
+     * @returns
+     */
+    private error;
+    /**
+     * Generic success callback function.
+     * @returns
+     */
+    private success;
+    /**
+     * Get the created image with the specified ID.
+     * @param imageId
+     * @returns {{Promise<Image>}}
+     */
+    getImage(imageId: string): Promise<Image>;
+    /**
+     * Get all created images
+     * @returns {{Promise<Image[]>}}
+     */
+    getImages(): Promise<Image[]>;
+    /**
+     * Create a OpenTAP package configuration image from a list image inputs consisting of user specified packages and repositories.
+     * @param images List of images
+     * @returns {{Promise<Image>}}
+     */
+    resolveImage(images: Image[]): Promise<Image>;
+    /**
+     * Shut down a session
+     * @param sessionId the ID of the session to shut down
+     * @returns {{Promise<void>}}
+     */
+    shutdownSession(sessionId: string): Promise<void>;
+    /**
+     * Start a session
+     * @returns {{Promise<Session>}}
+     */
+    startSession(): Promise<Session>;
+    /**
+     * Get the session manager image.
+     * @returns {{Promise<Image>}}
+     */
+    getSessionManagerImage(): Promise<Image>;
+    /**
+     * Start a session based on an image.
+     * @param imageId
+     * @returns {{Promise<Session>}}
+     */
+    startImageSession(image: Image): Promise<Session>;
+    /**
+     * Retrives the already running sessions
+     */
+    getSessions(): Promise<Session[]>;
+    protected processGetSessions(response: Response): Promise<Session[]>;
+    /**
+     * Register a self-started Session to a SessionManager.
+     */
+    registerSession(session: Session): Promise<Session>;
+    protected processRegisterSession(response: Response): Promise<Session>;
+    /**
+     * Shutdown Sessions and SessionManager
+     */
+    shutdown(): Promise<void>;
+    protected processShutdown(response: Response): Promise<void>;
+    /**
+     * Links to other applications or services
+     */
+    getLinks(): Promise<Links>;
+    protected processGetLinks(response: Response): Promise<Links>;
+    /**
+     * Retrieve component settings overview
+     */
+    getComponentSettingsOverview(): Promise<ComponentSettingsIdentifier[]>;
+    protected processGetComponentSettingsOverview(response: Response): Promise<ComponentSettingsIdentifier[]>;
+    /**
+     * Change componentsettings
+     */
+    setComponentSettings(groupName: string | null, name: string | null, returnedSettings: ComponentSettingsBase): Promise<ComponentSettingsBase>;
+    protected processSetComponentSettings(response: Response): Promise<ComponentSettingsBase>;
+    /**
+     * Retrieve componentsettings
+     */
+    getComponentSettings(groupName: string | null, name: string | null): Promise<ComponentSettingsBase>;
+    protected processGetComponentSettings(response: Response): Promise<ComponentSettingsBase>;
+    /**
+     * Retrieve componentsettings list item
+     */
+    getComponentSettingsListItem(groupName: string | null, name: string | null, index: number): Promise<ComponentSettingsListItem>;
+    protected processGetComponentSettingsListItem(response: Response): Promise<ComponentSettingsListItem>;
+    /**
+     * Set componentsettings list item settings
+     */
+    setComponentSettingsListItem(groupName: string | null, name: string | null, index: number, item: ComponentSettingsListItem): Promise<ComponentSettingsListItem>;
+    protected processSetComponentSettingsListItem(response: Response): Promise<ComponentSettingsListItem>;
+    /**
+     * Get component setting data grid
+     * @return Get component setting data grid
+     */
+    getComponentSettingDataGrid(groupName: string | null, name: string | null, index: number, propertyName: string | null): Promise<DataGridControl>;
+    protected processGetComponentSettingDataGrid(response: Response): Promise<DataGridControl>;
+    /**
+     * Set component setting data grid
+     * @return Set data grid
+     */
+    setComponentSettingDataGrid(groupName: string | null, name: string | null, index: number, propertyName: string | null, dataGridControl: DataGridControl): Promise<DataGridControl>;
+    protected processSetComponentSettingDataGrid(response: Response): Promise<DataGridControl>;
+    /**
+     * Add component setting item to data grid
+     * @return Add component setting data grid item
+     */
+    addComponentSettingDataGridItemType(groupName: string | null, name: string | null, index: number, propertyName: string | null, typeName: string | null): Promise<DataGridControl>;
+    protected processAddComponentSettingDataGridItemType(response: Response): Promise<DataGridControl>;
+    /**
+     * Add component setting item to data grid
+     * @return Add component setting data grid item
+     */
+    addComponentSettingDataGridItem(groupName: string | null, name: string | null, index: number, propertyName: string | null): Promise<DataGridControl>;
+    protected processAddComponentSettingDataGridItem(response: Response): Promise<DataGridControl>;
+    /**
+     * Get item types available in the component setting data grid
+     * @return Get component setting data grid types
+     */
+    getComponentSettingDataGridTypes(groupName: string | null, name: string | null, index: number, propertyName: string | null): Promise<ListItemType[]>;
+    protected processGetComponentSettingDataGridTypes(response: Response): Promise<ListItemType[]>;
+    /**
+     * Change componentsettings profiles
+     */
+    setComponentSettingsProfiles(returnedSettings: ProfileGroup[]): Promise<ProfileGroup[]>;
+    protected processSetComponentSettingsProfiles(response: Response): Promise<ProfileGroup[]>;
+    /**
+     * Get componentsettings profiles
+     */
+    getComponentSettingsProfiles(): Promise<ProfileGroup[]>;
+    protected processGetComponentSettingsProfiles(response: Response): Promise<ProfileGroup[]>;
+    /**
+     * Upload exported OpenTAP Settings files
+     * @param file (optional)
+     */
+    uploadComponentSettings(file: FileParameter | null | undefined): Promise<void>;
+    protected processUploadComponentSettings(response: Response): Promise<void>;
+    /**
+     * DEPRECATED: Use /componentsettings/load (LoadComponentSettingsFromRepository) instead
+     * @deprecated
+     */
+    loadComponentSettingsFromPackageReference(packageReference: RepositoryPackageReference): Promise<ErrorResponse[]>;
+    protected processLoadComponentSettingsFromPackageReference(response: Response): Promise<ErrorResponse[]>;
+    /**
+     * Load a component settings TapPackage by referencing a package in a package repository
+     */
+    loadComponentSettingsFromRepository(packageReference: RepositoryPackageReference): Promise<ErrorResponse[]>;
+    protected processLoadComponentSettingsFromRepository(response: Response): Promise<ErrorResponse[]>;
+    /**
+     * Save a TapPackage containing component settings in a package repository
+     * @return Settings TapPackage uploaded.
+     */
+    saveComponentSettingsToRepository(repositoryPackageDefinition: RepositorySettingsPackageDefinition): Promise<void>;
+    protected processSaveComponentSettingsToRepository(response: Response): Promise<void>;
+    /**
+     * Retrieve types available to be added to specified component settings list
+     */
+    getComponentSettingsListAvailableTypes(groupName: string | null, name: string | null): Promise<ListItemType[]>;
+    protected processGetComponentSettingsListAvailableTypes(response: Response): Promise<ListItemType[]>;
+    /**
+     * Adds a new item to a component settings list
+     */
+    addComponentSettingsListItem(groupName: string | null, name: string | null, typeName: string | null): Promise<ComponentSettingsBase>;
+    protected processAddComponentSettingsListItem(response: Response): Promise<ComponentSettingsBase>;
+    /**
+     * Retrieve settings types used in creating a Settings TapPackage
+     */
+    getSettingsTypes(): Promise<string[]>;
+    protected processGetSettingsTypes(response: Response): Promise<string[]>;
+    /**
+     * Download a TapPackage containing settings files
+     */
+    downloadSettingsPackage(settingsTapPackage: SettingsTapPackage): Promise<FileResponse>;
+    protected processDownloadSettingsPackage(response: Response): Promise<FileResponse>;
+}