@ibm/zapp-core 1.4.0 → 1.6.0

package/lib/index.d.ts

@@ -126,7 +126,7 @@ export abstract class SchemaDocumentCache {
     protected normalizePath(inputPath: string): string;
 }
 /**
- * JSON schema for zapp.json and zapp.yaml files. Version 1.3.0 -- Licensed Materials - Property of IBM - (c) Copyright IBM Corporation 2022, 2024. All Rights Reserved.
+ * JSON schema for zapp.json and zapp.yaml files. Version 1.6.0 -- Licensed Materials - Property of IBM - (c) Copyright IBM Corporation 2022, 2025. All Rights Reserved.
  */
 export type IBMZappDocument = CoreProperties;
 /**
@@ -141,25 +141,11 @@ export type Person = {
 /**
  * Profiles are additional groups of properties that should only become valid under specific conditions such as running in a build job or as part of a debug session.
  */
-export type Profile = {
-    name: string;
-    type: 'dbb';
-    settings: DbbBuilderSettings | DbbGroovySettings;
-} | {
-    name: string;
-    type: 'rseapi';
-    settings: RseapiSettingsItem;
-} | {
-    name: string;
-    language: string;
-    type: 'preprocessor';
-    location: string;
-    settings: LocalPreprocessorSettingsItem | MvsPreprocessorSettingsItem;
-} | {
-    name: string;
-    type: 'test';
-    settings: TestSettingsItem;
-};
+export type Profile = DependencyBasedBuildProfile | RSEAPIProfile | PreprocessorProfile | TestProfile | GalasaPropertiesProfile;
+/**
+ * Specify which application load modules correspond to application source files.
+ */
+export type TestSourceMaps = TestSourceMap[];
 export interface CoreProperties {
     /**
      * The name of the Z Project.
@@ -241,7 +227,7 @@ export interface LibraryItem {
      */
     name: string;
     /**
-     * The type of the property group defining where dependencies should be located. Allowed values are 'local' for using a local workspace and 'mvs' for dependencies located in MVS Datasets.
+     * The type of the property group defining where dependencies should be located. Allowed values are 'local' for using a local workspace and 'mvs' for dependencies located in MVS data sets.
      */
     type: 'mvs' | 'local';
     /**
@@ -249,6 +235,11 @@ export interface LibraryItem {
      */
     locations?: string[];
 }
+export interface DependencyBasedBuildProfile {
+    name: string;
+    type: 'dbb';
+    settings: DbbBuilderSettings | DbbGroovySettings;
+}
 /**
  * zBuilder user build properties for running user build on remote host.
  */
@@ -303,12 +294,17 @@ export interface DbbGroovySettings {
      */
     logFilePatterns?: string[];
 }
+export interface RSEAPIProfile {
+    name: string;
+    type: 'rseapi';
+    settings: RseapiSettingsItem;
+}
 /**
  * RSE API client settings for interactions with a z/OS remote host running an RSE API server.
  */
 export interface RseapiSettingsItem {
     /**
-     * A list of mapping objects that map local file extensions to transfer modes and encodings to MVS datasets that can be specified using wildcards.
+     * A list of mapping objects that map local file extensions to transfer modes and encodings to MVS data sets that can be specified using wildcards.
      */
     mappings: RseapiSettingsItemMapping[];
     /**
@@ -358,6 +354,13 @@ export interface RseapiSettingsItemMapping {
         resource?: string;
     }[];
 }
+export interface PreprocessorProfile {
+    name: string;
+    language: string;
+    type: 'preprocessor';
+    location: string;
+    settings: LocalPreprocessorSettingsItem | MvsPreprocessorSettingsItem;
+}
 /**
  * Preprocessor properties for preprocessing COBOL/PL/I files.
  */
@@ -405,66 +408,492 @@ export interface MvsPreprocessorSettingsItem {
      * Specifies the high-level qualifier used for data sets created by plug-in requests to export observation files.
      */
     tempDataHLQ: string;
+    /**
+     * Specifies the data set where local programs will be uploaded for preprocessing.
+     */
+    programDataSet?: string;
+}
+export interface TestProfile {
+    name: string;
+    type: 'test';
+    settings: TestSettingsItem;
 }
 /**
  * Test properties for a test case.
  */
 export interface TestSettingsItem {
+    recording?: TestRecordingSettings;
+    unitTest?: UnitTestSettings;
+    functionalTest?: FunctionalTestSettings;
+}
+/**
+ * Specify settings for the recording application tool.
+ */
+export interface TestRecordingSettings {
+    applicationToCapture?: TestApplicationToCapture;
+    hostRecordingSettings?: TestHostRecordingSettings;
+    sourceMaps?: TestSourceMaps;
+}
+/**
+ * Specify what to capture in an application.
+ */
+export interface TestApplicationToCapture {
     /**
-     * Properties to run a unit test case.
+     * Type of application that will be recorded.
      */
-    unitTest: {
-        /**
-         * Specifies the list of Procedure libraries.
-         */
-        procLib: string[];
-        /**
-         *  If this option is selected, the data set for the working file is allocated automatically with the allocation options.
-         */
-        allocateWorkingDs?: boolean;
-        /**
-         * Options to allocate a working file.
-         */
-        ioDataSetAllocation?: {
-            /**
-             * The unit of primary and secondary space to be allocated.
-             */
-            ioSpaceUnit?: 'TRACKS' | 'BLOCKS' | 'CYLINDERS';
-            /**
-             * The amount of DASD space to be used for primary space allocation (PRIMARY).
-             */
-            ioQuant1?: number;
-            /**
-             * The amount of DASD space to be used for secondary space allocation (SECONDARY).
-             */
-            ioQuant2?: number;
-            /**
-             * The high-level qualifier for the VSAM or QSAM data files for file I/O simulation. These files are allocated when running a Unit test case.
-             */
-            ioHLQ?: string;
-            [k: string]: unknown;
-        };
-        /**
-         * Runner configuration destination container.
-         */
-        configDS?: string;
+    recordingType?: 'CICS' | 'Batch' | 'IMS';
+    /**
+     * Provide a path to a JCL file that runs the application to be recorded.
+     */
+    jclSteps?: string;
+    /**
+     * Provide name of the program to capture.
+     */
+    programs?: string[];
+    /**
+     * Provide a transaction id to capture in the recording.
+     */
+    transactionId?: string;
+}
+/**
+ * Specify host settings for the recording tool.
+ */
+export interface TestHostRecordingSettings {
+    /**
+     * Required if recording and replaying DB2 statements.
+     */
+    applicationDbrmLibrary?: string;
+    /**
+     * If recording a CICS application, specify a CICS region where the application is running.
+     */
+    cicsRegion?: string;
+    /**
+     * If recording a batch application, specify the data set where Debug Test Engine load library is located.
+     */
+    dteEngineLocation?: string;
+    /**
+     * If recording an IMS application, specify the subsystem id.
+     */
+    imsSubsystemId?: string;
+}
+export interface TestSourceMap {
+    /**
+     * The workspace-relative path to an application source file.
+     */
+    source?: string;
+    /**
+     * The z/OS load module name that corresponds to the specified source file.
+     */
+    module?: string;
+}
+/**
+ * Properties to run a unit test case.
+ */
+export interface UnitTestSettings {
+    /**
+     * Specifies the list of Procedure libraries.
+     */
+    procLib: string[];
+    /**
+     * If this option is selected, the data set for the working file is allocated automatically with the allocation options.
+     */
+    allocateWorkingDs?: boolean;
+    /**
+     * Options to allocate a working file.
+     */
+    ioDataSetAllocation?: {
         /**
-         * Runner result destination container.
+         * The unit of primary and secondary space to be allocated.
          */
-        resultDS?: string;
+        ioSpaceUnit?: 'TRACKS' | 'BLOCKS' | 'CYLINDERS';
         /**
-         * The datat set of the application under test
+         * The amount of DASD space to be used for primary space allocation (PRIMARY).
          */
-        userLibraries?: string[];
+        ioQuant1?: number;
         /**
-         * The default local folder to create the test case artifacts.
+         * The amount of DASD space to be used for secondary space allocation (SECONDARY).
          */
-        defaultTestCaseFolder?: string;
+        ioQuant2?: number;
         /**
-         * The job card to run a unit test
+         * The high-level qualifier for the VSAM or QSAM data files for file I/O simulation. These files are allocated when running a Unit test case.
          */
-        jobcard?: string;
+        ioHLQ?: string;
+        [k: string]: unknown;
     };
+    /**
+     * Runner configuration destination container.
+     */
+    configDS?: string;
+    /**
+     * Runner result destination container.
+     */
+    resultDS?: string;
+    /**
+     * The datat set of the application under test.
+     */
+    userLibraries?: string[];
+    /**
+     * The default local folder to create the test case artifacts.
+     */
+    defaultTestCaseFolder?: string;
+    /**
+     * The job card to run a unit test.
+     */
+    jobcard?: string;
+}
+/**
+ * Specify settings for the functional test.
+ */
+export interface FunctionalTestSettings {
+    /**
+     * Specify the path to the default test case folder.
+     */
+    defaultTestCaseFolder?: string;
+    /**
+     * Specify the code pages to be used.
+     */
+    codePages?: string;
+    /**
+     * Specify an array of local BMS files.
+     */
+    localBmsMapNames?: string[];
+    /**
+     * Specify an array of local MFS files from the mfs-maps directory to be used for generating accurate test files. Ex: sample.mfs.
+     */
+    localMfsFiles?: string[];
+    /**
+     * Specify an array of local IMS DBD files from the config-files directory to be used for generating accurate test files. Ex: imsDbd.txt.
+     */
+    localImsDbdFiles?: string[];
+    /**
+     * Specify an array of local Db2 Config files.
+     */
+    localDb2Config?: string[];
+    substitutionMap?: SubstitutionMapSettings;
+}
+/**
+ * Specify settings for the functional test substitution map.
+ */
+export interface SubstitutionMapSettings {
+    /**
+     * If recording a CICS application, specify the cicsts.dse.tag from the .galasa/cps.properties file.
+     */
+    cicsTag?: string;
+    /**
+     * If recording a CICS or IMS application, specify the zos.dse.tag from the .galasa/cps.properties file.
+     */
+    imageTag?: string;
+    /**
+     * If recording a CICS application, specify the Db2 DB ID that was established when the Db2 instance was created.
+     */
+    dbPrefix?: string;
+    /**
+     * If recording a CICS application, specify the db2.dse.schema.PRIMARY.name from the .galasa/cps.properties.
+     */
+    dbSchema?: string;
+    /**
+     * If recording a CICS or IMS application, specify the zos.image.x.credentials value from the .galasa/cps.properties.
+     */
+    loginCredentialsTag?: string;
+    /**
+     * If recording an IMS application, specify the imstm.dse.tag from the .galasa/cps.properties.
+     */
+    imsTag?: string;
+    /**
+     * If recording an IMS application, specify the dli.database.tag.{imsTag}.datastore value from the .galasa/cps.properties.
+     */
+    dliTag?: string;
+}
+export interface GalasaPropertiesProfile {
+    name: string;
+    type: 'galasa';
+    settings: GalasaSettingsItem;
+}
+/**
+ * Galasa properties for executing a functional test galasa test file
+ */
+export interface GalasaSettingsItem {
+    /**
+     * Specify the galasa home directory on local machine
+     */
+    galasaHome?: string;
+    zos?: ZosGalasaSettings;
+    cicsts?: CicstsGalasaSettings;
+    db2?: Db2GalasaSettings;
+    /**
+     * Configuration properties used by the IMS TM manager for the DSE provisioner for a specific tag
+     */
+    imstmDseTags?: ImstmDseTagItemsGalasaSettings[];
+    dli?: DliGalasaSettings;
+    /**
+     * Configuration properties used by the TOTP Manager for MFA
+     */
+    totpMfas?: TotpMfaItemsGalasaSettings[];
+    /**
+     * Specify additional properties to be added to the cps.properties file
+     */
+    additionalProperties?: AdditionalPropertiesItemsGalasaSettings[];
+}
+/**
+ * The configuration for a z/OS system
+ */
+export interface ZosGalasaSettings {
+    /**
+     * The configuration for a z/OS DSE tag
+     */
+    dseTags?: ZosDseTagItemsGalasaSettings[];
+    /**
+     * The configuration for a z/OS image
+     */
+    images?: ZosImageItemsGalasaSettings[];
+}
+/**
+ * The configuration for a z/OS DSE tag
+ */
+export interface ZosDseTagItemsGalasaSettings {
+    /**
+     * User-defined identifier for the z/OS DSE tag
+     */
+    tag?: string;
+    /**
+     * The z/OS Image ID
+     */
+    imageid?: string;
+}
+/**
+ * Specify the characteristics of a particular z/OS environment that your Galasa tests will target
+ */
+export interface ZosImageItemsGalasaSettings {
+    /**
+     * User-defined identifier for the z/OS Image tag
+     */
+    tag?: string;
+    /**
+     * Hostname of the target z/OS system
+     */
+    ipv4Hostname?: string;
+    telnet?: ZosImageTelnetGalasaSettings;
+    /**
+     * Credentials tag for logging onto a z/OS system
+     */
+    credentials?: string;
+    /**
+     * A string representing the VTAM logon command
+     */
+    vtamLogon?: string;
+    /**
+     * This property defines the first input that will be provided to the z/OS system after a connection is established
+     */
+    logonInitialText?: string;
+}
+/**
+ * The telnet details for the target z/OS system
+ */
+export interface ZosImageTelnetGalasaSettings {
+    /**
+     * Specify the telnet port for the target z/OS system
+     */
+    port?: number;
+    /**
+     * Specify if TLS is enabled on the target z/OS system
+     */
+    tls?: boolean;
+}
+/**
+ * Configuration properties used by the Galasa CICS TS Manager
+ */
+export interface CicstsGalasaSettings {
+    /**
+     * User-defined identifier for the CICS tag
+     */
+    dseTags?: CicstsDseTagItemsGalasaSettings[];
+    /**
+     * Property specifying text used for testing a specific CICS login good morning screen
+     */
+    defaultLogonGmText?: string;
+    /**
+     * Provides the type of the CICS TS region for the DSE provisioner
+     */
+    provisionType?: string;
+}
+/**
+ * Configuration properties used by the Galasa CICS TS Manager for the specific tag
+ */
+export interface CicstsDseTagItemsGalasaSettings {
+    /**
+     * User-defined identifier for the CICS tag
+     */
+    tag?: string;
+    /**
+     * User-defined identifier for the z/OS Image tag
+     */
+    imageid?: string;
+    /**
+     * Application Identifier of a CICS TS region for the DSE provisioner
+     */
+    applid?: string;
+}
+/**
+ * Configuration properties used by the Galasa Db2 Manager
+ */
+export interface Db2GalasaSettings {
+    /**
+     * Db2 DSE Instance configuration properties used by the Galasa Db2 Manager
+     */
+    dseInstances?: Db2DseInstanceItemsGalasaSettings[];
+    /**
+     * Db2 Schema configuration properties used by the Galasa Db2 Manager
+     */
+    schemas?: Db2SchemaItemsGalasaSettings[];
+    /**
+     * Db2 Instance configuration properties used by the Galasa Db2 Manager
+     */
+    instances?: Db2InstanceItemsGalasaSettings[];
+}
+/**
+ * Db2 DSE Instance configuration properties used by the Galasa Db2 Manager
+ */
+export interface Db2DseInstanceItemsGalasaSettings {
+    /**
+     * User-defined identifier for the z/OS Image tag
+     */
+    tag?: string;
+    /**
+     * User-defined identifier for the Db2 tag
+     */
+    name?: string;
+}
+/**
+ * This property specifies the name of the primary Db2 schema that Galasa will use when interacting with a Db2 database
+ */
+export interface Db2SchemaItemsGalasaSettings {
+    /**
+     * User-defined identifier for the primary Db2 Schema
+     */
+    tag?: string;
+    /**
+     * User-defined identifier for the Db2 schema tag
+     */
+    name?: string;
+}
+/**
+ * Configuration properties for the Db2 instance for use within Galasa tests
+ */
+export interface Db2InstanceItemsGalasaSettings {
+    /**
+     * User-defined identifier for the Db2 tag
+     */
+    tag?: string;
+    /**
+     * Specify the JDBC connection URL for a Db2 database instance
+     */
+    url?: string;
+    /**
+     * User-defined identifier for the Db2 credentials tag
+     */
+    credentials?: string;
+}
+/**
+ * Configuration properties used by the IMS TM manager for the DSE provisioner for a specific tag
+ */
+export interface ImstmDseTagItemsGalasaSettings {
+    /**
+     * User-defined identifier for the IMS tag
+     */
+    tag?: string;
+    /**
+     * Application Identifier of an IMS TM region for the DSE provisioner
+     */
+    applid?: string;
+}
+/**
+ * Configuration properties used by the Galasa DLI Manager
+ */
+export interface DliGalasaSettings {
+    /**
+     * User-defined identifier for the DLI Datastore tag
+     */
+    datastoreTags?: DliDatastoreTagItemsGalasaSettings[];
+    /**
+     * User-defined identifier for the DLI Database tag
+     */
+    databaseTags?: DliDatabaseTagItemsGalasaSettings[];
+}
+/**
+ * Configuration properties used by the Galasa DLI Manager for datastore access for a specific tag
+ */
+export interface DliDatastoreTagItemsGalasaSettings {
+    /**
+     * User-defined identifier for the DLI Datastore tag
+     */
+    tag?: string;
+    /**
+     * Specify the Datastore name
+     */
+    name?: string;
+    /**
+     * Specify the hostname or IP address of the Datastore
+     */
+    server?: string;
+    /**
+     * Specify the port of the Datastore
+     */
+    port?: number;
+    /**
+     * Specify if SSL is enabled on the Datastore
+     */
+    ssl?: boolean;
+}
+/**
+ * Configuration properties used by the Galasa DLI Manager for database access for a specific tag
+ */
+export interface DliDatabaseTagItemsGalasaSettings {
+    /**
+     * User-defined identifier for the DLI Database tag
+     */
+    tag?: string;
+    /**
+     * User-defined identifier for the DLI datastore tag
+     */
+    datastore?: string;
+    /**
+     * Provide the name of the database
+     */
+    name?: string;
+}
+/**
+ * Configuration properties used by the TOTP Manager for MFA
+ */
+export interface TotpMfaItemsGalasaSettings {
+    /**
+     * User-defined identifier for the TOTP MFA tag
+     */
+    tag?: string;
+    /**
+     * The number of digits required in each generated one time password
+     */
+    digits?: number;
+    /**
+     * The hash algorithm used when generating each one time password
+     */
+    digest?: string;
+    /**
+     * The number of seconds that each generated one time password will be valid for
+     */
+    interval?: number;
+}
+/**
+ * Additional properties to be used
+ */
+export interface AdditionalPropertiesItemsGalasaSettings {
+    /**
+     * The key of the additional property
+     */
+    name?: string;
+    /**
+     * The value of the additional property
+     */
+    value?: string;
 }
 /**
  * A meta-data representation of a zapp file
@@ -695,6 +1124,8 @@ export const zappConstants: {
     profileTypeRseApi: string;
     propertyPropertyGroups: string;
     profileTypePreprocessor: string;
+    profileTypeTest: string;
+    profileTypeGalasa: string;
 };
 /**
  * A collection of business logic for accessing, manipulating, validating
@@ -773,7 +1204,7 @@ export class PreprocessorController extends ZappProfilesController {
      */
     static getPreprocessorProfileNamesBasedOnLocation(workspacePath: string, location: string, language?: string): string[] | undefined;
     /**
-     * Requires that the ZAPP file was already cached. If in doubt call loadPreprocessorSettings()
+     * Requires that the ZAPP file was already cached.
      *
      * @param {string} workspacePath Path to a folder in which a zapp file can be found
      * @param {string} [language] optional filter by language
@@ -781,7 +1212,7 @@ export class PreprocessorController extends ZappProfilesController {
      */
     static getLocalPreprocessorSettings(workspacePath: string, language?: string): LocalPreprocessorSettingsItem | undefined;
     /**
-     * Requires that the ZAPP file was already cached. If in doubt call loadPreprocessorSettings()
+     * Requires that the ZAPP file was already cached.
      *
      * @param {string} workspacePath Path to a folder in which a zapp file can be found
      * @param {string} [language] optional filter by language
@@ -789,7 +1220,7 @@ export class PreprocessorController extends ZappProfilesController {
      */
     static getMvsPreprocessorSettings(workspacePath: string, language?: string): MvsPreprocessorSettingsItem | undefined;
     /**
-     * Requires that the ZAPP file was already cached. If in doubt call loadPreprocessorSettings()
+     * Requires that the ZAPP file was already cached.
      *
      * @param {string} workspacePath Path to a folder in which a zapp file can be found
      * @param {string} name Name of the preprocessor profile
@@ -798,7 +1229,7 @@ export class PreprocessorController extends ZappProfilesController {
      */
     static getLocalPreprocessorProfileNamesBasedOnName(workspacePath: string, name: string, language?: string): LocalPreprocessorSettingsItem | undefined;
     /**
-     * Requires that the ZAPP file was already cached. If in doubt call loadPreprocessorSettings()
+     * Requires that the ZAPP file was already cached.
      *
      * @param {string} workspacePath Path to a folder in which a zapp file can be found
      * @param {string} name Name of the preprocessor profile
@@ -806,6 +1237,23 @@ export class PreprocessorController extends ZappProfilesController {
      * @returns {(zapp.MvsPreprocessorSettingsItem | undefined)} Returns the settings specified for Remote Preprocessor
      */
     static getMvsPreprocessorProfileNamesBasedOnName(workspacePath: string, name: string, language?: string): MvsPreprocessorSettingsItem | undefined;
+    /**
+     * Requires that the ZAPP file was already cached.
+     *
+     * @param {string} workspacePath Path to a folder in which a zapp file can be found
+     * @param {string} [language] optional filter by language
+     * @param {string} [location] optional Location for which the preprocessor needs to be run
+     * @returns {(zapp.Profile | undefined)} Returns the preprocessor profile specified on the basis of filter provided
+     */
+    static getPreprocessorProfile(workspacePath: string, language?: string, location?: string): Profile[] | undefined;
+}
+export class TestController extends ZappProfilesController {
+    static getTestProfileNames(workspacePath: string): string[] | undefined;
+    static getTestSettings(workspacePath: string, profileName?: string): TestSettingsItem | undefined;
+}
+export class GalasaController extends ZappProfilesController {
+    static getGalasaProfileNames(workspacePath: string): string[] | undefined;
+    static getGalasaSettings(workspacePath: string, profileName?: string): GalasaSettingsItem | undefined;
 }
 
 //# sourceMappingURL=index.d.ts.map