azure-pipelines-task-lib 3.2.0 → 3.2.1

package/mock-task.js

@@ -57,6 +57,7 @@ module.exports.setSecret = task.setSecret;
 module.exports.getTaskVariable = task.getTaskVariable;
 module.exports.setTaskVariable = task.setTaskVariable;
 module.exports.getInput = task.getInput;
+module.exports.getInputRequired = task.getInputRequired;
 module.exports.getBoolInput = task.getBoolInput;
 module.exports.getDelimitedInput = task.getDelimitedInput;
 module.exports.filePathSupplied = task.filePathSupplied;
@@ -70,13 +71,21 @@ function getPathInput(name, required, check) {
     return inval;
 }
 module.exports.getPathInput = getPathInput;
+function getPathInputRequired(name, check) {
+    return getPathInput(name, true, check);
+}
+module.exports.getPathInputRequired = getPathInputRequired;
 //-----------------------------------------------------
 // Endpoint Helpers
 //-----------------------------------------------------
 module.exports.getEndpointUrl = task.getEndpointUrl;
+module.exports.getEndpointUrlRequired = task.getEndpointUrlRequired;
 module.exports.getEndpointDataParameter = task.getEndpointDataParameter;
+module.exports.getEndpointDataParameterRequired = task.getEndpointDataParameterRequired;
 module.exports.getEndpointAuthorizationScheme = task.getEndpointAuthorizationScheme;
+module.exports.getEndpointAuthorizationSchemeRequired = task.getEndpointAuthorizationSchemeRequired;
 module.exports.getEndpointAuthorizationParameter = task.getEndpointAuthorizationParameter;
+module.exports.getEndpointAuthorizationParameterRequired = task.getEndpointAuthorizationParameterRequired;
 module.exports.getEndpointAuthorization = task.getEndpointAuthorization;
 //-----------------------------------------------------
 // SecureFile Helpers

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "azure-pipelines-task-lib",
-  "version": "3.2.0",
+  "version": "3.2.1",
   "description": "Azure Pipelines Task SDK",
   "main": "./task.js",
   "typings": "./task.d.ts",

package/task.d.ts

@@ -108,6 +108,14 @@ export interface VariableInfo {
  * @returns   string
  */
 export declare function getInput(name: string, required?: boolean): string | undefined;
+/**
+ * Gets the value of an input.
+ * If the value is not set, it will throw.
+ *
+ * @param     name     name of the input to get
+ * @returns   string
+ */
+export declare function getInputRequired(name: string): string;
 /**
  * Gets the value of an input and converts to a bool.  Convenience.
  * If required is true and the value is not set, it will throw.
@@ -153,6 +161,17 @@ export declare function filePathSupplied(name: string): boolean;
  * @returns   string
  */
 export declare function getPathInput(name: string, required?: boolean, check?: boolean): string | undefined;
+/**
+ * Gets the value of a path input
+ * It will be quoted for you if it isn't already and contains spaces
+ * If the value is not set, it will throw.
+ * If check is true and the path does not exist, it will throw.
+ *
+ * @param     name      name of the input to get
+ * @param     check     whether path is checked.  optional, defaults to false
+ * @returns   string
+ */
+export declare function getPathInputRequired(name: string, check?: boolean): string;
 /**
  * Gets the url for a service endpoint
  * If the url was not set and is not optional, it will throw.
@@ -162,7 +181,16 @@ export declare function getPathInput(name: string, required?: boolean, check?: b
  * @returns   string
  */
 export declare function getEndpointUrl(id: string, optional: boolean): string | undefined;
+/**
+ * Gets the url for a service endpoint
+ * If the url was not set, it will throw.
+ *
+ * @param     id        name of the service endpoint
+ * @returns   string
+ */
+export declare function getEndpointUrlRequired(id: string): string;
 export declare function getEndpointDataParameter(id: string, key: string, optional: boolean): string | undefined;
+export declare function getEndpointDataParameterRequired(id: string, key: string): string;
 /**
  * Gets the endpoint authorization scheme for a service endpoint
  * If the endpoint authorization scheme is not set and is not optional, it will throw.
@@ -172,6 +200,14 @@ export declare function getEndpointDataParameter(id: string, key: string, option
  * @returns {string} value of the endpoint authorization scheme
  */
 export declare function getEndpointAuthorizationScheme(id: string, optional: boolean): string | undefined;
+/**
+ * Gets the endpoint authorization scheme for a service endpoint
+ * If the endpoint authorization scheme is not set, it will throw.
+ *
+ * @param id name of the service endpoint
+ * @returns {string} value of the endpoint authorization scheme
+ */
+export declare function getEndpointAuthorizationSchemeRequired(id: string): string;
 /**
  * Gets the endpoint authorization parameter value for a service endpoint with specified key
  * If the endpoint authorization parameter is not set and is not optional, it will throw.
@@ -182,6 +218,15 @@ export declare function getEndpointAuthorizationScheme(id: string, optional: boo
  * @returns {string} value of the endpoint authorization parameter value
  */
 export declare function getEndpointAuthorizationParameter(id: string, key: string, optional: boolean): string | undefined;
+/**
+ * Gets the endpoint authorization parameter value for a service endpoint with specified key
+ * If the endpoint authorization parameter is not set, it will throw.
+ *
+ * @param id name of the service endpoint
+ * @param key key to find the endpoint authorization parameter
+ * @returns {string} value of the endpoint authorization parameter value
+ */
+export declare function getEndpointAuthorizationParameterRequired(id: string, key: string): string;
 /**
  * Interface for EndpointAuthorization
  * Contains a schema and a string/string dictionary of auth data

package/task.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateReleaseName = exports.addBuildTag = exports.updateBuildNumber = exports.uploadBuildLog = exports.associateArtifact = exports.uploadArtifact = exports.logIssue = exports.logDetail = exports.setProgress = exports.setEndpoint = exports.addAttachment = exports.uploadSummary = exports.prependPath = exports.uploadFile = exports.CodeCoverageEnabler = exports.CodeCoveragePublisher = exports.TestPublisher = exports.getHttpCertConfiguration = exports.getHttpProxyConfiguration = exports.findMatch = exports.filter = exports.match = exports.tool = exports.execSync = exports.exec = exports.rmRF = exports.legacyFindFiles = exports.find = exports.retry = exports.mv = exports.cp = exports.ls = exports.which = exports.resolve = exports.mkdirP = exports.popd = exports.pushd = exports.cd = exports.checkPath = exports.cwd = exports.getPlatform = exports.osType = exports.writeFile = exports.exist = exports.stats = exports.debug = exports.error = exports.warning = exports.command = exports.setTaskVariable = exports.getTaskVariable = exports.getSecureFileTicket = exports.getSecureFileName = exports.getEndpointAuthorization = exports.getEndpointAuthorizationParameter = exports.getEndpointAuthorizationScheme = exports.getEndpointDataParameter = exports.getEndpointUrl = exports.getPathInput = exports.filePathSupplied = exports.getDelimitedInput = exports.getBoolInput = exports.getInput = exports.setSecret = exports.setVariable = exports.getVariables = exports.assertAgent = exports.getVariable = exports.loc = exports.setResourcePath = exports.setResult = exports.setErrStream = exports.setStdStream = exports.Platform = exports.FieldType = exports.ArtifactType = exports.IssueType = exports.TaskState = exports.TaskResult = void 0;
+exports.updateReleaseName = exports.addBuildTag = exports.updateBuildNumber = exports.uploadBuildLog = exports.associateArtifact = exports.uploadArtifact = exports.logIssue = exports.logDetail = exports.setProgress = exports.setEndpoint = exports.addAttachment = exports.uploadSummary = exports.prependPath = exports.uploadFile = exports.CodeCoverageEnabler = exports.CodeCoveragePublisher = exports.TestPublisher = exports.getHttpCertConfiguration = exports.getHttpProxyConfiguration = exports.findMatch = exports.filter = exports.match = exports.tool = exports.execSync = exports.exec = exports.rmRF = exports.legacyFindFiles = exports.find = exports.retry = exports.mv = exports.cp = exports.ls = exports.which = exports.resolve = exports.mkdirP = exports.popd = exports.pushd = exports.cd = exports.checkPath = exports.cwd = exports.getPlatform = exports.osType = exports.writeFile = exports.exist = exports.stats = exports.debug = exports.error = exports.warning = exports.command = exports.setTaskVariable = exports.getTaskVariable = exports.getSecureFileTicket = exports.getSecureFileName = exports.getEndpointAuthorization = exports.getEndpointAuthorizationParameterRequired = exports.getEndpointAuthorizationParameter = exports.getEndpointAuthorizationSchemeRequired = exports.getEndpointAuthorizationScheme = exports.getEndpointDataParameterRequired = exports.getEndpointDataParameter = exports.getEndpointUrlRequired = exports.getEndpointUrl = exports.getPathInputRequired = exports.getPathInput = exports.filePathSupplied = exports.getDelimitedInput = exports.getBoolInput = exports.getInputRequired = exports.getInput = exports.setSecret = exports.setVariable = exports.getVariables = exports.assertAgent = exports.getVariable = exports.loc = exports.setResourcePath = exports.setResult = exports.setErrStream = exports.setStdStream = exports.Platform = exports.FieldType = exports.ArtifactType = exports.IssueType = exports.TaskState = exports.TaskResult = void 0;
 var shell = require("shelljs");
 var childProcess = require("child_process");
 var fs = require("fs");
@@ -208,6 +208,17 @@ function getInput(name, required) {
     return inval;
 }
 exports.getInput = getInput;
+/**
+ * Gets the value of an input.
+ * If the value is not set, it will throw.
+ *
+ * @param     name     name of the input to get
+ * @returns   string
+ */
+function getInputRequired(name) {
+    return getInput(name, true);
+}
+exports.getInputRequired = getInputRequired;
 /**
  * Gets the value of an input and converts to a bool.  Convenience.
  * If required is true and the value is not set, it will throw.
@@ -286,6 +297,20 @@ function getPathInput(name, required, check) {
     return inval;
 }
 exports.getPathInput = getPathInput;
+/**
+ * Gets the value of a path input
+ * It will be quoted for you if it isn't already and contains spaces
+ * If the value is not set, it will throw.
+ * If check is true and the path does not exist, it will throw.
+ *
+ * @param     name      name of the input to get
+ * @param     check     whether path is checked.  optional, defaults to false
+ * @returns   string
+ */
+function getPathInputRequired(name, check) {
+    return getPathInput(name, true, check);
+}
+exports.getPathInputRequired = getPathInputRequired;
 //-----------------------------------------------------
 // Endpoint Helpers
 //-----------------------------------------------------
@@ -306,6 +331,17 @@ function getEndpointUrl(id, optional) {
     return urlval;
 }
 exports.getEndpointUrl = getEndpointUrl;
+/**
+ * Gets the url for a service endpoint
+ * If the url was not set, it will throw.
+ *
+ * @param     id        name of the service endpoint
+ * @returns   string
+ */
+function getEndpointUrlRequired(id) {
+    return getEndpointUrl(id, false);
+}
+exports.getEndpointUrlRequired = getEndpointUrlRequired;
 /*
  * Gets the endpoint data parameter value with specified key for a service endpoint
  * If the endpoint data parameter was not set and is not optional, it will throw.
@@ -324,6 +360,18 @@ function getEndpointDataParameter(id, key, optional) {
     return dataParamVal;
 }
 exports.getEndpointDataParameter = getEndpointDataParameter;
+/*
+ * Gets the endpoint data parameter value with specified key for a service endpoint
+ * If the endpoint data parameter was not set, it will throw.
+ *
+ * @param id name of the service endpoint
+ * @param key of the parameter
+ * @returns {string} value of the endpoint data parameter
+ */
+function getEndpointDataParameterRequired(id, key) {
+    return getEndpointDataParameter(id, key, false);
+}
+exports.getEndpointDataParameterRequired = getEndpointDataParameterRequired;
 /**
  * Gets the endpoint authorization scheme for a service endpoint
  * If the endpoint authorization scheme is not set and is not optional, it will throw.
@@ -341,6 +389,17 @@ function getEndpointAuthorizationScheme(id, optional) {
     return authScheme;
 }
 exports.getEndpointAuthorizationScheme = getEndpointAuthorizationScheme;
+/**
+ * Gets the endpoint authorization scheme for a service endpoint
+ * If the endpoint authorization scheme is not set, it will throw.
+ *
+ * @param id name of the service endpoint
+ * @returns {string} value of the endpoint authorization scheme
+ */
+function getEndpointAuthorizationSchemeRequired(id) {
+    return getEndpointAuthorizationScheme(id, false);
+}
+exports.getEndpointAuthorizationSchemeRequired = getEndpointAuthorizationSchemeRequired;
 /**
  * Gets the endpoint authorization parameter value for a service endpoint with specified key
  * If the endpoint authorization parameter is not set and is not optional, it will throw.
@@ -359,6 +418,18 @@ function getEndpointAuthorizationParameter(id, key, optional) {
     return authParam;
 }
 exports.getEndpointAuthorizationParameter = getEndpointAuthorizationParameter;
+/**
+ * Gets the endpoint authorization parameter value for a service endpoint with specified key
+ * If the endpoint authorization parameter is not set, it will throw.
+ *
+ * @param id name of the service endpoint
+ * @param key key to find the endpoint authorization parameter
+ * @returns {string} value of the endpoint authorization parameter value
+ */
+function getEndpointAuthorizationParameterRequired(id, key) {
+    return getEndpointAuthorizationParameter(id, key, false);
+}
+exports.getEndpointAuthorizationParameterRequired = getEndpointAuthorizationParameterRequired;
 /**
  * Gets the authorization details for a service endpoint
  * If the authorization was not set and is not optional, it will set the task result to Failed.