@ibm/zapp-core 1.0.0

package/lib/index.d.ts

@@ -0,0 +1,539 @@
+import YAWM from "yawn-yaml/cjs";
+import { ValidateFunction } from "ajv";
+/**
+ * A meta-data representation of a schema file
+ * providing path and type.
+ */
+export interface SchemaFile {
+    path: string;
+    type: 'json' | 'yaml';
+}
+export abstract class SchemaDocumentInstance {
+    protected yawn: YAWM;
+    type: string;
+    /** If true the document was parsed and validated successfully.
+     *  If false then pasing or validation failed. Check the errorMessages members then.  */
+    isValid: boolean;
+    /** Provides meta-data for the file used to create the instance using the SchemaFile interface */
+    file: SchemaFile | undefined;
+    /** Error message resulting from IO errors, parsing, or validations. */
+    errorMessages: string | undefined;
+    protected static validationFunction: ValidateFunction | undefined;
+    /**
+     * Creates an instance of SchemaDocumentInstance. Protected, use factory methods instead.
+     * @param {string} schemaYamlString String representation of the yaml used to create the instance
+     * @param {string} [errorMessages] Optionally provide error messages to be preserved such as IO errors from reading a file
+     */
+    protected constructor(schemaYamlString: string, errorMessages?: string);
+    /**
+     * @returns {(Type | undefined)} returns the schema document as an instance of the IBMSchemaDocument interface
+     */
+    abstract getAsDocument<Type>(): Type | undefined;
+    /**
+     * @returns {(string | undefined)} returns the schema document as YAML string
+     */
+    getAsYaml(): string | undefined;
+    getAsJson(): string | undefined;
+    /**
+     * @returns {(Record<string, unknown> | undefined)} returns the schema document as untyped object
+     */
+    protected getAsObject(): Record<string, unknown> | undefined;
+    /**
+     * When running ZAPP in an editor then the editor will write file updates in a parallel process
+     * than the ZAPP code that runs in an extension host in a parallel node instance. We observed
+     * that sometime node's fs.readFile will then return an empty string. The theory is that the file is
+     * still locked by the write process because the file contents have not yet been fully flushed to
+     * the disk by the other process. As a work around we want to retry reading a file when it returns
+     * empty. When an exception is throw then it will not retry.
+     *
+     * @param filepath Absolute path to the file to read
+     * @returns the contents of the file read or throws an exception if multiple attempts failed
+     */
+    protected static readFileWithRetry(filepath: string): Promise<string>;
+    /**
+     * If the document instance was read from a file and/or the file is populated with path and type
+     * then write it back to the file system replacing the previous file.
+     */
+    write(): void;
+    /**
+     * Can be called to check that the document complies with the schema json-schema.
+     * If validation errors are found then they will added to the errorMessages member.
+     *
+     * @returns {boolean} false if validation errors were found
+     */
+    abstract validate(): boolean;
+    protected appendErrorMessage(message: string | undefined): void;
+    protected prependErrorMessage(message: string | undefined): void;
+}
+export abstract class SchemaDocumentCache {
+    protected type: string;
+    /** maps absolute path to a schema file to a cached document instance */
+    protected documentsCache: Map<string, SchemaDocumentInstance>;
+    /** maps absolute path to a workspace to the absolute path of a schema file */
+    protected workspacesMap: Map<string, string>;
+    protected constructor(type: string);
+    protected addDocument(filePath: string, workspacePath: string, document: SchemaDocumentInstance): void;
+    /**
+     * Removes a document from the cache.
+     * @param filePath absolute path to the schema file
+     */
+    clearSchemaDocument(filePath: string): void;
+    /**
+     * Clears the entire document cache.
+     * Call when restarting the client and reload all files to cache.
+     */
+    clearCache(): void;
+    protected numberDocsAdded: number;
+    protected numberDocsRemoved: number;
+    protected numberDocsFound: number;
+    /**
+     * Report on cache size and stats. Mainly used for testing.
+     */
+    getCacheStats(): Record<string, unknown>;
+    /**
+     * Checks for a given filename if it is valid filename that can be used with the
+     * currently associated schema. For example, an implementation could allow files
+     * with multiple extension such as zapp.yaml as well as zapp.yml and return true
+     * for both cases and false for ZAPP.YAML enforcing a case sensitive spelling.
+     *
+     * @param {string} filename
+     * @returns {boolean} true if the filename is matching
+     */
+    abstract isValidFilename(filename: string): boolean;
+    /**
+     * Normalization of absolute path names required as VS Code API returns path names
+     * with lower case drive letters on Windows, but end users can specify Schema
+     * path names with driver letter casing in the way they want. We therefore
+     * index the cache on Windows always with all uppercase pathNames.
+     * @param {string} absolutePath
+     * @returns {string} normalized code and if Window
+     * @memberof SchemaDocumentsCache
+     */
+    protected normalizePath(absolutePath: string): string;
+}
+/**
+ * JSON schema for zapp.json and zapp.yaml files. Version 1.0.0 -- Licensed Materials - Property of IBM - (c) Copyright IBM Corporation 2022. All Rights Reserved.
+ */
+export type IBMZappDocument = CoreProperties;
+/**
+ * A person who has been involved in creating or maintaining this package
+ */
+export type Person = {
+    name: string;
+    url?: string;
+    email?: string;
+    [k: string]: unknown;
+} | string;
+/**
+ * Profiles are additional groups of properties that should only should 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: DbbSettingsItem;
+} | {
+    name: string;
+    type: 'rseapi';
+    settings: RseapiSettingsItem;
+};
+export interface CoreProperties {
+    /**
+     * The name of the Z Project.
+     */
+    name: string;
+    /**
+     * This helps people understand your project as it would be used by tools.
+     */
+    description?: string;
+    /**
+     * Version is a string and it must be parsable for managing dependencies.
+     */
+    version?: string;
+    /**
+     * Defines a group name that is shared for each application part in case of applications composed of multiple parts. Allows to uniquely identify the parts by concatenating with the artifact id. For example a groupId `com.ibm.wazi` with an artifactId `service` would create the unique application identifier `com.ibm.wazi.service`.
+     */
+    groupId?: string;
+    /**
+     * Define id of the application artifact. Use it in combination with a groupId for multi-part applications.
+     */
+    artifactId?: string;
+    /**
+     * In case of a multi-part application defines the name of the parent application part. This zapp will inherit properties such as propertyGroups defined in the parent.
+     */
+    parentId?: string;
+    /**
+     * This helps people discover your project.
+     */
+    keywords?: string[];
+    /**
+     * The url to the project homepage.
+     */
+    homepage?: ({
+        [k: string]: unknown;
+    } | '.') & string;
+    /**
+     * You should specify a license for your package so that people know how they are permitted to use it and any restrictions you're placing on it.
+     */
+    license?: string;
+    author?: Person;
+    /**
+     * A list of people who contributed to this package.
+     */
+    contributors?: [Person, ...Person[]];
+    /**
+     * A list of people who maintain this package.
+     */
+    maintainers?: [Person, ...Person[]];
+    /**
+     * A list properties defining path names for resolving dependencies.
+     */
+    propertyGroups?: [PropertyGroupItem, ...PropertyGroupItem[]];
+    /**
+     * Profiles are additional groups of properties that should only should become valid under specific conditions such as running in a build job or as part of a debug session.
+     */
+    profiles?: [Profile, ...Profile[]];
+}
+export interface PropertyGroupItem {
+    /**
+     * The name of the property group, which is used in hovers and error messages.
+     */
+    name: string;
+    /**
+     * Limits the property group to one specific language.
+     */
+    language?: 'cobol' | 'pl1' | 'hlasm' | 'rexx' | 'jcl';
+    /**
+     * Global compiler options separated by a comma that impact the parsing of the programs for the editor. Requires that you specify a language. If there are multiple Property Groups for a language with compiler option then they will be concatenated.
+     */
+    compilerOptions?: string;
+    /**
+     * An array of potential library locations defining the search order for include files. Libraries with the name 'syslib' will be handled as default include locations. The list can contain many entries of the type 'local' or 'mvs'. It can contain items of the same type twice in case, for example, you want to search in remote locations first, then some local location, and if still not found more remote locations.
+     */
+    libraries?: [LibraryItem, ...LibraryItem[]];
+}
+export interface LibraryItem {
+    /**
+     * Name of the library. The default name should be `syslib` if using unamed libraries.
+     */
+    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.
+     */
+    type: 'mvs' | 'local';
+    /**
+     * An array of include file locations. For 'local' libraries values can be absolute and relative filename paths using GLOB patterns. For 'mvs' libraries value can be data set names. GLOB patterns for dat sets are currently not supported.
+     */
+    locations: [string, ...string[]];
+}
+/**
+ * DBB build script properties for running User Build on remote host.
+ */
+export interface DbbSettingsItem {
+    /**
+     * Defines the name of the application to build. Will be used to create a folder on USS to upload all files to.
+     */
+    application: string;
+    /**
+     * Command that the build script is executed with such as the path to groovyz and it's parameters.
+     */
+    command: string;
+    /**
+     * The full path of build script on the remote host that should be used with the command.
+     */
+    buildScriptPath?: string;
+    /**
+     * A list of strings that are the parameters for the build script. Check the documentation for built-in variables, such as the name of the program to build, that can be used here.
+     */
+    buildScriptArgs?: string[];
+    /**
+     * Lists of GLOB patterns that define the files that should be uploaded to USS for a build. Relative path names are interpreted relative to the location of the ZAPP file that is being used for the build, which is a ZAPP file in the same workspace as the program to be build.
+     */
+    additionalDependencies?: string[];
+    /**
+     * Lists of GLOB patterns that define the files that should be downloaded from USS after the build. Relative path names are interpreted relative to the DBB log directory user setting. If not provided then all files of the user setting location will be downloaded.
+     */
+    logFilePatterns?: string[];
+}
+/**
+ * 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.
+     */
+    mappings: RseapiSettingsItemMapping[];
+    /**
+     * The encoding to be used when no mapping can be found. If not provided then either the user or server default will be used.
+     */
+    'default.encoding': string;
+}
+/**
+ * One mapping that contains at least transfer and resource values.
+ */
+export interface RseapiSettingsItemMapping {
+    /**
+     * A local file extension such as cbl or pl1.
+     */
+    extension?: string;
+    /**
+     * The transfer mode to be used. Can be 'text' or 'binary'.
+     */
+    transfer?: 'text' | 'binary';
+    /**
+     * The data set name to be mapped to. Can use a wildcard such as '**CPY'.
+     */
+    resource?: string;
+    /**
+     * The encoding to be used for text transfer. See the RSE API documentation for the values allowed.
+     */
+    encoding?: string;
+    /**
+     * A nested mappings array with resource mappings to members of the data sets that were mapped by the parent mapping.
+     */
+    memberMappings?: {
+        /**
+         * A local file extension such as cbl or pl1.
+         */
+        extension?: string;
+        /**
+         * The transfer mode to be used. Can be 'text' or 'binary'.
+         */
+        transfer?: 'text' | 'binary';
+        /**
+         * The encoding to be used for text transfer. See the RSE API documentation for the values allowed.
+         */
+        encoding?: string;
+        /**
+         * The data set member name to be mapped to. Can use a wildcard such as '**CPY'.
+         */
+        resource?: string;
+    }[];
+}
+/**
+ * A meta-data representation of a zapp file
+ * providing path and type.
+ */
+export interface ZappFile {
+    path: string;
+    type: 'json' | 'yaml';
+}
+/**
+ * Represent ZAPP documents that are stored either as yaml or json files.
+ * Features various factory method to create instances for workspace locations or absolute file names.
+ */
+export class ZappDocumentInstance extends SchemaDocumentInstance {
+    type: string;
+    protected static validationFunction: ValidateFunction<unknown>;
+    /**
+     * Creates a ZappDocumentInstance with a yaml string.
+     * @param {string} zappYamlString
+     * @returns {ZappDocumentInstance}
+     */
+    static createFromYamlString(zappYamlString: string): ZappDocumentInstance;
+    /**
+     * Creates a ZappDocumentInstance with a json string.
+     * @param {string} zappJsonString
+     * @returns {ZappDocumentInstance}
+     */
+    static createFromJsonString(zappJsonString: string): ZappDocumentInstance;
+    /**
+     * Creates a ZappDocumentInstance with a yaml file path
+     * @param {string} filepath absolute path name
+     * @returns {Promise<ZappDocumentInstance>} promise that will resolve into an instantiated ZappDocumentInstance.
+     *          If no document was found or it contained errors then these errors will be populated in the object.
+     */
+    static createFromYamlFile(filepath: string): Promise<ZappDocumentInstance>;
+    /**
+     * Creates a ZappDocumentInstance with a json file path
+     * @param {string} filepath absolute path name
+     * @returns {Promise<ZappDocumentInstance>} promise that will resolve into an instantiated ZappDocumentInstance.
+     *          If no document was found or it contained errors then these errors will be populated in the object.
+     */
+    static createFromJsonFile(filepath: string): Promise<ZappDocumentInstance>;
+    /**
+     * Creates a ZappDocumentInstance from a file. Checks the file type automatically.
+     * @param {string} filepath absolute path name
+     * @returns {Promise<ZappDocumentInstance>} promise that will resolve into an instantiated ZappDocumentInstance.
+     *          If no document was found or it contained errors then these errors will be populated in the object.
+     */
+    static createFromFile(filepath: string): Promise<ZappDocumentInstance>;
+    /**
+     * Creates a ZappDocumentInstance by looking for a zapp file in a directory.
+     * Checks the file type automatically. Will always prioritize yaml over json.
+     * @param {string} workspacePath absolute path name
+     * @returns {Promise<ZappDocumentInstance>} promise that will resolve into an instantiated ZappDocumentInstance.
+     *          If no document was found or it contained errors then these errors will be populated in the object.
+     */
+    static loadFromWorkspace(workspacePath: string): Promise<ZappDocumentInstance>;
+    /**
+     * Looks for zapp files in a directory. Will always prioritize yaml over json.
+     * @param {string} workspacePath absolute path name
+     * @returns {(ZappFile | undefined)} An instance of ZappFile or undefined if not found
+     */
+    static findZappFile(workspacePath: string): ZappFile | undefined;
+    /**
+     * @param {string} filename string that represent a filename; not a path
+     * @returns {boolean} true if filename is either zapp.json, zapp.yml, or zapp.yaml
+     */
+    static isZappFileName(filename: string): boolean;
+    /**
+     * @returns {(IBMZappDocument | undefined)} returns the ZAPP document as an instance of the IBMZappDocument interface
+     */
+    getAsDocument<IBMZappDocument>(): IBMZappDocument | undefined;
+    /**
+     * Can be called to check that the document complies with the schema json-schema.
+     * If validation errors are found then they will added to the errorMessages member.
+     * @returns {boolean} false if validation errors were found
+     */
+    validate(): boolean;
+}
+/**
+ * Class that finds, loads, and caches instances of zapp files in memory.
+ */
+export class ZappDocumentsCache extends SchemaDocumentCache {
+    static cacheType: string;
+    protected static getInstance(): ZappDocumentsCache;
+    protected static resetInstance(): void;
+    /**
+     * Retrieves a zapp file from the cache. Although  the file to retrieve is provided to
+     * identify the file, it will not load it into the cache if not found to keep access to the
+     * cache synchronous. Undefined will return, which could then be used to call loadZappDocument()
+     * to load it an place it in the cache.
+     * @param filePath absolute path to the zapp file
+     * @returns {(Promise<ZappDocumentInstance | undefined>)} undefined if file was not cached, yet
+     */
+    static getZappDocument(filePath: string): ZappDocumentInstance | undefined;
+    /**
+     * Asynchronously loads a zapp file from the path provided.
+     * @param {string} filePath absolute path to the zapp file
+     * @returns {(Promise<ZappDocumentInstance | undefined>)} undefined if invalid path was provided.
+     *          In case of loading errors ZappDocumentInstance will contain error messages.
+     */
+    static loadZappDocument(filePath: string, workspacePath: string): Promise<ZappDocumentInstance | undefined>;
+    /**
+     * Removes a document from the cache.
+     * @param filePath absolute path to the zapp file
+     */
+    static clearZappDocument(filePath: string): void;
+    /**
+     * Gets the cached ZAPP document for the workspace path provided.
+     * Assumes that the document cache has been updated with the latest file, e.g. by a watcher.
+     * @param workspacePath absolute path to the workspace that contains a zapp file
+     * @returns {ZappDocumentInstance | undefined} undefined if invalid path was provided.
+     */
+    static getZappDocumentInWorkspace(workspacePath: string): ZappDocumentInstance | undefined;
+    /**
+     * Looks for a ZAPP file with various file extensions in the workspace directory and
+     * loads the best match into the cache.
+     * @param {string} workspacePath path to the workspace in which a zapp file resides
+     * @returns {(Promise<ZappDocumentInstance | undefined>)} undefined if invalid path was provided.
+     *          In case of loading errors ZappDocumentInstance will contain error messages.
+     */
+    static loadZappDocumentInWorkspace(workspacePath: string): Promise<ZappDocumentInstance | undefined>;
+    isValidFilename(filename: string): boolean;
+    static getCacheStats(): Record<string, unknown>;
+    static clearCache(): void;
+}
+/**
+ * A collection of business logic for accessing, manipulating, validating
+ * property groups in ZAPP documents.
+ */
+export class PropertyGroupsController {
+    /**
+     * Basic accessor method for reading property groups in a workspace.
+     * @param {string} workspacePath absolute path to the workspace that contains zapp.yaml or zapp.json
+     * @param {string} [language] optional filter by language which will include property groups without a language property
+     * @returns {zapp.PropertyGroupItem[]} an array of property groups found
+     */
+    static getPropertyGroups(workspacePath: string, language?: string): PropertyGroupItem[];
+}
+/**
+ * A collection of business logic for accessing, manipulating, validating
+ * user build data in ZAPP documents.
+ *
+ * Conventions used:
+ * - load methods are async and load from disk
+ * - get methods are sync as they assume zapp is in cache
+ * - workspacePath is the path to the zapp file folder; not the absolute path the file
+ */
+export class ZappProfilesController {
+    /**
+     * Gets all the profiles found in a ZAPP file loaded from the path specified.
+     * This call assumes that the ZAPP files was already loaded by the client, i.e.
+     * during editor startup or some other asynchronous call to loadZappProfiles().
+     *
+     * @param {string} workspacePath Path to a folder in which a zapp file can be found
+     * @returns {(zapp.Profile[] | undefined)}
+     */
+    static getZappProfiles(workspacePath: string): Profile[] | undefined;
+    /**
+     * Loads a ZAPP file from the path specified and returns all the profiles found in the doc.
+     *
+     * @param {string} workspacePath Path to a folder in which a zapp file can be found
+     * @returns {(Promise<zapp.Profile[] | undefined>)}
+     */
+    static loadZappProfiles(workspacePath: string): Promise<Profile[] | undefined>;
+}
+export const zappConstants: {
+    profileTypeDbb: string;
+    profileTypeRseApi: string;
+    propertyPropertyGroups: string;
+};
+/**
+ * A collection of business logic for accessing, manipulating, validating
+ * user build data in ZAPP documents.
+ */
+export class UserBuildController extends ZappProfilesController {
+    /**
+     * @param {string} workspacePath the location of the workspace with a zapp file
+     * @returns {(string[] | undefined)} a list of DBB profiles defined in the zapp file
+     */
+    static getUserBuildProfileNames(workspacePath: string): string[] | undefined;
+    /**
+     * @param {string} workspacePath the location of the workspace with a zapp file
+     * @param {string} [profileName] optional, if multiple DBB profiles are available then qualify by name
+     * @returns {(zapp.DbbSettingsItem | undefined)}
+     *          DbbSettingsItem object of the profile that matches the profileName
+     *          or if omitted the first one found. Undefined if not available.
+     */
+    static getUserBuildSettings(workspacePath: string, profileName?: string): DbbSettingsItem | undefined;
+}
+/**
+ * A collection of business logic for accessing, manipulating, validating
+ * rse api mappings in ZAPP documents.
+ *
+ * Conventions used:
+ * - load methods are async and load from disk
+ * - get methods are sync as they assume zapp is in cache
+ * - workspacePath is the path to the zapp file folder; not the absolute path the file
+ */
+export class RseApiController extends ZappProfilesController {
+    /**
+     * @param {string} workspacePath Path to a folder in which a zapp file can be found
+     * @returns {(string[] | undefined)} Returns the list of all the profiles founds in a currently caches ZAPP file
+     */
+    static getRseApiProfileNames(workspacePath: string): string[] | undefined;
+    /**
+     * Validation check to test if a ZAPP file only contains only one Mappings profile
+     *
+     * @param {string} workspacePath Path to a folder in which a zapp file can be found
+     * @returns {boolean} True if one entry was found
+     */
+    static onlyOneMappingsEntry(workspacePath: string): boolean;
+    /**
+     * Requires that the ZAPP file was already cached. If in doubt call loadRseApiSettings()
+     *
+     * @param {string} workspacePath Path to a folder in which a zapp file can be found
+     * @returns {(zapp.RseapiSettingsItem | undefined)} Returns the settings specified for an RSE API profile
+     */
+    static getRseApiSettings(workspacePath: string): RseapiSettingsItem | undefined;
+    /**
+     * Loads a ZAPP file from the specified path and return RSE API settings.
+     *
+     * @param {string} workspacePath Path to a folder in which a zapp file can be found
+     * @returns {(Promise<zapp.RseapiSettingsItem | undefined>)} Returns the settings specified for an RSE API profile
+     */
+    static loadRseApiSettings(workspacePath: string): Promise<RseapiSettingsItem | undefined>;
+}
+
+//# sourceMappingURL=index.d.ts.map

package/lib/index.js

@@ -0,0 +1 @@
+var e=require("fs"),t=require("yawn-yaml/cjs"),i=require("path"),s=require("os"),r=require("js-yaml"),a=require("ajv"),n=require("ajv-formats");function o(e,t){return Object.keys(t).forEach((function(i){"default"===i||"__esModule"===i||e.hasOwnProperty(i)||Object.defineProperty(e,i,{enumerable:!0,get:function(){return t[i]}})})),e}function p(e){return e&&e.__esModule?e.default:e}function c(e,t,i,s){Object.defineProperty(e,t,{get:i,set:s,enumerable:!0,configurable:!0})}var l={},d={},h={};c(h,"SchemaDocumentInstance",(()=>m));class m{isValid=!1;constructor(e,i){i&&this.prependErrorMessage(i);try{this.yawn=new(p(t))(e),this.validate()}catch(e){this.prependErrorMessage(e?.message)}}getAsYaml(){return this.yawn?.yaml}getAsJson(){return JSON.stringify(this.yawn?.json)}getAsObject(){return this.yawn?.json}static async readFileWithRetry(t){let i="";for(let s=0;s<10;s++){if(i=await e.promises.readFile(t,"utf8"),i)return i;await new Promise((e=>setTimeout(e,100)))}return i}write(){if(this.isValid){if(this.file?.path){let t="# Undefined "+this.type+" document.";"json"===this.file.type&&(t=JSON.stringify(this.getAsObject())),"yaml"===this.file.type&&(t=this.getAsYaml()||t),e.writeFileSync(this.file.path,t,{encoding:"utf-8"})}}else this.appendErrorMessage(`Tried to write invalid document "${this.file?.path}"`)}appendErrorMessage(e){const t=this.errorMessages?`${this.errorMessages}\n`:"";this.errorMessages=`${t}- ${e||"Unknown Error reading "+this.type+" file."}`}prependErrorMessage(e){const t=this.errorMessages?`\n${this.errorMessages}`:"";this.errorMessages=`- ${e||"Unknown Error reading "+this.type+" file."}${t}`}}var u={};c(u,"SchemaDocumentCache",(()=>f));class f{constructor(e){this.type=e,this.documentsCache=new Map,this.workspacesMap=new Map,this.numberDocsAdded=0,this.numberDocsRemoved=0,this.numberDocsFound=0}addDocument(e,t,i){this.documentsCache.set(e,i),this.workspacesMap.set(t,e)}clearSchemaDocument(e){if(!e)return;const t=this.normalizePath(e),s=i.dirname(t);this.workspacesMap.has(s)&&this.workspacesMap.delete(s),this.documentsCache.has(t)&&(this.documentsCache.delete(t),this.numberDocsRemoved++)}clearCache(){this.workspacesMap.clear(),this.documentsCache.clear()}getCacheStats(){return{documentsCacheSize:this.documentsCache.size,workspacesMapSize:this.workspacesMap.size,numberDocsAdded:this.numberDocsAdded,numberDocsRemoved:this.numberDocsRemoved,numberDocsFound:this.numberDocsFound}}normalizePath(e){if(!e||!i.isAbsolute(e))return e;let t=i.normalize(e);if("win32"===s.platform()){const e=i.basename(t);if(this.isValidFilename(e)){const s=i.dirname(t);t=i.join(s.toUpperCase(),e)}else t=t.toUpperCase()}return t}}o(d,h),o(d,u),o(l,d);var g={},y={},b={};c(b,"PropertyGroupsController",(()=>j));var w={};c(w,"ZappDocumentsCache",(()=>S));var v={};c(v,"ZappDocumentInstance",(()=>P));var I;I=JSON.parse('{"$schema":"http://json-schema.org/draft-07/schema#","title":"IBM Zapp Document","description":"JSON schema for zapp.json and zapp.yaml files. Version 1.0.0 -- Licensed Materials - Property of IBM - (c) Copyright IBM Corporation 2022. All Rights Reserved.","type":"object","definitions":{"coreProperties":{"type":"object","required":["name"],"additionalProperties":false,"properties":{"name":{"description":"The name of the Z Project.","type":"string","maxLength":214,"minLength":1},"description":{"description":"This helps people understand your project as it would be used by tools.","type":"string"},"version":{"description":"Version is a string and it must be parsable for managing dependencies.","type":"string","default":"1.0.0"},"groupId":{"description":"Defines a group name that is shared for each application part in case of applications composed of multiple parts. Allows to uniquely identify the parts by concatenating with the artifact id. For example a groupId `com.ibm.wazi` with an artifactId `service` would create the unique application identifier `com.ibm.wazi.service`.","type":"string","examples":["com.ibm.wazi","payments"]},"artifactId":{"description":"Define id of the application artifact. Use it in combination with a groupId for multi-part applications.","type":"string","default":"","examples":["sam"]},"parentId":{"description":"In case of a multi-part application defines the name of the parent application part. This zapp will inherit properties such as propertyGroups defined in the parent.","type":"string","default":"","examples":["com.ibm.wazi.parent"]},"keywords":{"description":"This helps people discover your project.","type":"array","items":{"type":"string"}},"homepage":{"description":"The url to the project homepage.","type":"string","oneOf":[{"format":"uri"},{"enum":["."]}]},"license":{"type":"string","description":"You should specify a license for your package so that people know how they are permitted to use it and any restrictions you\'re placing on it."},"author":{"$ref":"#/definitions/person"},"contributors":{"description":"A list of people who contributed to this package.","type":"array","items":{"$ref":"#/definitions/person"},"minItems":1},"maintainers":{"description":"A list of people who maintain this package.","type":"array","items":{"$ref":"#/definitions/person"},"minItems":1},"propertyGroups":{"description":"A list properties defining path names for resolving dependencies.","type":"array","items":{"$ref":"#/definitions/propertyGroupItem"},"minItems":1},"profiles":{"description":"Profiles are additional groups of properties that should only should become valid under specific conditions such as running in a build job or as part of a debug session.","type":"array","items":{"$ref":"#/definitions/profile"},"minItems":1}}},"propertyGroupItem":{"type":"object","additionalProperties":false,"required":["name"],"properties":{"name":{"type":"string","description":"The name of the property group, which is used in hovers and error messages.","examples":["sample-local"]},"language":{"type":"string","enum":["cobol","pl1","hlasm","rexx","jcl"],"description":"Limits the property group to one specific language."},"compilerOptions":{"type":"string","description":"Global compiler options separated by a comma that impact the parsing of the programs for the editor. Requires that you specify a language. If there are multiple Property Groups for a language with compiler option then they will be concatenated."},"libraries":{"type":"array","description":"An array of potential library locations defining the search order for include files. Libraries with the name \'syslib\' will be handled as default include locations. The list can contain many entries of the type \'local\' or \'mvs\'. It can contain items of the same type twice in case, for example, you want to search in remote locations first, then some local location, and if still not found more remote locations.","items":{"$ref":"#/definitions/libraryItem"},"minItems":1}}},"libraryItem":{"type":"object","additionalProperties":false,"required":["name","type","locations"],"properties":{"name":{"type":"string","description":"Name of the library. The default name should be `syslib` if using unamed libraries.","default":"syslib","examples":["syslib","currencylib"]},"type":{"type":"string","enum":["mvs","local"],"description":"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.","default":"local","examples":["local","mvs"]},"locations":{"type":"array","description":"An array of include file locations. For \'local\' libraries values can be absolute and relative filename paths using GLOB patterns. For \'mvs\' libraries value can be data set names. GLOB patterns for dat sets are currently not supported.","items":{"type":"string"},"minItems":1,"examples":["**/copybook","USER1.SAMPLE.COBCOPY"]}}},"person":{"description":"A person who has been involved in creating or maintaining this package","type":["object","string"],"required":["name"],"properties":{"name":{"type":"string"},"url":{"type":"string","format":"uri"},"email":{"type":"string","format":"email"}}},"profile":{"type":"object","description":"Profiles are additional groups of properties that should only should become valid under specific conditions such as running in a build job or as part of a debug session.","additionalProperties":false,"required":["name","type"],"properties":{"name":{"type":"string","description":"The name of the profile.","examples":["dbb-build"]},"type":{"type":"string","enum":["dbb","rseapi","debug"],"description":"The type of the profile.","default":"dbb","examples":["dbb","rseapi"]},"settings":{"description":"Settings objects specific to the type specified for the profile.","type":"object"}},"anyOf":[{"required":["name","type","settings"],"additionalProperties":false,"properties":{"name":{"type":"string"},"type":{"const":"dbb","type":"string"},"settings":{"$ref":"#/definitions/dbbSettingsItem"}}},{"required":["name","type","settings"],"additionalProperties":false,"properties":{"name":{"type":"string"},"type":{"const":"rseapi","type":"string"},"settings":{"$ref":"#/definitions/rseapiSettingsItem"}}}]},"dbbSettingsItem":{"type":"object","additionalProperties":false,"required":["application","command"],"description":"DBB build script properties for running User Build on remote host.","properties":{"application":{"type":"string","description":"Defines the name of the application to build. Will be used to create a folder on USS to upload all files to."},"command":{"type":"string","description":"Command that the build script is executed with such as the path to groovyz and it\'s parameters."},"buildScriptPath":{"type":"string","description":"The full path of build script on the remote host that should be used with the command."},"buildScriptArgs":{"type":"array","items":{"type":"string"},"description":"A list of strings that are the parameters for the build script. Check the documentation for built-in variables, such as the name of the program to build, that can be used here."},"additionalDependencies":{"type":"array","items":{"type":"string"},"description":"Lists of GLOB patterns that define the files that should be uploaded to USS for a build. Relative path names are interpreted relative to the location of the ZAPP file that is being used for the build, which is a ZAPP file in the same workspace as the program to be build."},"logFilePatterns":{"type":"array","items":{"type":"string"},"description":"Lists of GLOB patterns that define the files that should be downloaded from USS after the build. Relative path names are interpreted relative to the DBB log directory user setting. If not provided then all files of the user setting location will be downloaded."}}},"rseapiSettingsItem":{"type":"object","additionalProperties":false,"description":"RSE API client settings for interactions with a z/OS remote host running an RSE API server.","required":["mappings","default.encoding"],"properties":{"mappings":{"type":"array","description":"A list of mapping objects that map local file extensions to transfer modes and encodings to MVS datasets that can be specified using wildcards.","items":{"$ref":"#/definitions/rseapiSettingsItemMapping"}},"default.encoding":{"type":"string","description":"The encoding to be used when no mapping can be found. If not provided then either the user or server default will be used."}}},"rseapiSettingsItemMapping":{"type":"object","additionalProperties":false,"description":"One mapping that contains at least transfer and resource values.","properties":{"extension":{"type":"string","description":"A local file extension such as cbl or pl1."},"transfer":{"type":"string","enum":["text","binary"],"description":"The transfer mode to be used. Can be \'text\' or \'binary\'."},"resource":{"type":"string","description":"The data set name to be mapped to. Can use a wildcard such as \'**CPY\'."},"encoding":{"type":"string","description":"The encoding to be used for text transfer. See the RSE API documentation for the values allowed."},"memberMappings":{"type":"array","items":{"type":"object","additionalProperties":false,"description":"One member mapping that contains at least transfer and resource values.","properties":{"extension":{"type":"string","description":"A local file extension such as cbl or pl1."},"transfer":{"type":"string","enum":["text","binary"],"description":"The transfer mode to be used. Can be \'text\' or \'binary\'."},"encoding":{"type":"string","description":"The encoding to be used for text transfer. See the RSE API documentation for the values allowed."},"resource":{"type":"string","description":"The data set member name to be mapped to. Can use a wildcard such as \'**CPY\'."}}},"description":"A nested mappings array with resource mappings to members of the data sets that were mapped by the parent mapping."}}}},"anyOf":[{"$ref":"#/definitions/coreProperties"}]}');class P extends m{type="zapp";static validationFunction=P.initAjvValidator();static initAjvValidator(){const e=new(p(a))({allErrors:!0,strictTuples:!1,allowUnionTypes:!0});return p(n)(e),e.compile(I)}static createFromYamlString(e){return new P(e)}static createFromJsonString(e){let t="";try{const i=JSON.parse(e);return t=r.dump(i),this.createFromYamlString(t)}catch(e){return new P(t,e?.message||e)}}static async createFromYamlFile(e){let t="";try{t=await this.readFileWithRetry(e);const i=this.createFromYamlString(t);return i.file={path:e,type:"yaml"},i}catch(e){return new P(t,e?.message||e)}}static async createFromJsonFile(e){let t="";try{t=await this.readFileWithRetry(e);const i=this.createFromJsonString(t);return i.file={path:e,type:"json"},i}catch(e){return new P(t,e?.message||e)}}static async createFromFile(e){return e?.endsWith(".yaml")||e?.endsWith(".yml")?await this.createFromYamlFile(e):e?.endsWith(".json")?await this.createFromJsonFile(e):new P("","Invalid filename for reading a ZAPP file.")}static async loadFromWorkspace(e){const t=this.findZappFile(e);return"yaml"===t?.type?await this.createFromYamlFile(t.path):"json"===t?.type?await this.createFromJsonFile(t.path):new P("",`No ZAPP file was found in "${e}".`)}static findZappFile(t){if(!t)return;const s=i.normalize(t),r=i.join(s,"zapp.yaml");if(e.existsSync(r))return{path:r,type:"yaml"};const a=i.join(s,"zapp.yml");if(e.existsSync(a))return{path:a,type:"yaml"};const n=i.join(s,"zapp.json");return e.existsSync(n)?{path:n,type:"json"}:void 0}static isZappFileName(e){return/^(zapp\.)(yml|yaml|json)$/.test(e)}getAsDocument(){try{const e=this.yawn.json;if(e)return e}catch(e){this.prependErrorMessage(e?.message)}}validate(){if(this.yawn){if(this.isValid=P.validationFunction(this.getAsObject()),!this.isValid){const e=P.validationFunction.errors;return e?e.forEach((e=>{let t=e.message;if(e.params){const i=e.params;t=`${t}(${Object.keys(i).map((e=>`${e}:${i[e]}`))})`}this.appendErrorMessage(t)})):this.appendErrorMessage("Unknown validation error."),!1}return!0}return!1}}class S extends f{static cacheType="zapp";static getInstance(){return this.instance||(this.instance=new S(this.cacheType)),this.instance}static resetInstance(){this.instance=void 0}static getZappDocument(e){if(!e)return;const t=this.getInstance().normalizePath(e);return this.getInstance().documentsCache.has(t)?(this.getInstance().numberDocsFound++,this.getInstance().documentsCache.get(t)):void 0}static async loadZappDocument(e,t){if(!e)return;const i=this.getInstance().normalizePath(e);if(this.getInstance().documentsCache.has(i))return this.getInstance().numberDocsFound++,this.getInstance().documentsCache.get(i);const s=await P.createFromFile(i);return this.getInstance().addDocument(e,t,s),this.getInstance().numberDocsAdded++,s}static clearZappDocument(e){this.getInstance().clearSchemaDocument(e)}static getZappDocumentInWorkspace(e){if(!e)return;const t=this.getInstance().normalizePath(e),i=this.getInstance().workspacesMap.get(t);return i?this.getZappDocument(i):void 0}static async loadZappDocumentInWorkspace(e){const t=this.getInstance().normalizePath(e),i=P.findZappFile(t);if(i){const s=await this.loadZappDocument(i.path,e);return this.getInstance().workspacesMap.set(t,i.path),s}}isValidFilename(e){return P.isZappFileName(e)}static getCacheStats(){return this.getInstance().getCacheStats()}static clearCache(){this.getInstance().clearCache(),this.resetInstance()}}class j{static getPropertyGroups(e,t){let i=[];const s=S.getZappDocumentInWorkspace(e);if(s&&!s.errorMessages){const e=s.getAsDocument();if(e){const s=e.propertyGroups;s&&(i=s,t&&(i=s.filter((e=>!e.language||e.language===t))))}}return i}}var A={};c(A,"UserBuildController",(()=>x));var D={};c(D,"ZappProfilesController",(()=>F));class F{static getZappProfiles(e){const t=S.getZappDocumentInWorkspace(e);if(!t||t.errorMessages)return;const i=t.getAsDocument();return i&&i.profiles&&0!==i.profiles.length?i.profiles:void 0}static async loadZappProfiles(e){if(await S.loadZappDocumentInWorkspace(e))return this.getZappProfiles(e)}}var M={};c(M,"zappConstants",(()=>C));const C={profileTypeDbb:"dbb",profileTypeRseApi:"rseapi",propertyPropertyGroups:"propertyGroups"};class x extends F{static getUserBuildProfileNames(e){const t=this.getZappProfiles(e);if(t&&t.length>0)return t.filter((e=>e.type===C.profileTypeDbb)).map((e=>e.name))}static getUserBuildSettings(e,t){const i=this.getZappProfiles(e);if(i&&i.length>0){if(!t){return i.find((e=>e.type===C.profileTypeDbb))?.settings}{const e=i.find((e=>e.name===t));if(e?.type===C.profileTypeDbb)return e.settings}}}}var T={};c(T,"RseApiController",(()=>Z));class Z extends F{static getRseApiProfileNames(e){const t=this.getZappProfiles(e);if(t&&t.length>0)return t.filter((e=>e.type===C.profileTypeRseApi)).map((e=>e.name))}static onlyOneMappingsEntry(e){return 1===this.getRseApiProfileNames(e)?.length}static getRseApiSettings(e){const t=this.getZappProfiles(e);if(t&&t.length>0){return t.find((e=>e.type===C.profileTypeRseApi))?.settings}}static async loadRseApiSettings(e){if(await this.loadZappProfiles(e))return this.getRseApiSettings(e)}}o(y,b),o(y,A),o(y,T),o(y,D);var k={};o(k,{}),o(k,v),o(k,w),o(k,M),o(g,y),o(g,k),o(module.exports,l),o(module.exports,g);