@esri/solution-common 1.3.10 → 1.3.13

package/dist/esm/generalHelpers.js

@@ -27,7 +27,7 @@ import { new_File } from "./polyfills";
  *
  * @param url URL to append to
  * @param parameter Query parameter to append, prefixed with "?" or "&" as appropriate to what url already has
- * @return New URL combining url and parameter
+ * @returns New URL combining url and parameter
  */
 export function appendQueryParam(url, parameter) {
     return url + (url.indexOf("?") === -1 ? "?" : "&") + parameter;
@@ -36,7 +36,7 @@ export function appendQueryParam(url, parameter) {
  * Extracts JSON from a Blob.
  *
  * @param blob Blob to use as source
- * @return A promise that will resolve with JSON or null
+ * @returns A promise that will resolve with JSON or null
  */
 export function blobToJson(blob) {
     return new Promise(resolve => {
@@ -56,7 +56,7 @@ export function blobToJson(blob) {
  * @param blob Blob to use as source
  * @param filename Name to use for file
  * @param mimeType MIME type to override blob's MIME type
- * @return File created out of Blob and filename
+ * @returns File created out of Blob and filename
  */
 export function blobToFile(blob, filename, mimeType) {
     return blob
@@ -69,7 +69,7 @@ export function blobToFile(blob, filename, mimeType) {
  * Extracts text from a Blob.
  *
  * @param blob Blob to use as source
- * @return A promise that will resolve with text read from blob
+ * @returns A promise that will resolve with text read from blob
  */
 export function blobToText(blob) {
     return new Promise(resolve => {
@@ -87,7 +87,7 @@ export function blobToText(blob) {
  * Checks that a URL path ends with a slash.
  *
  * @param url URL to check
- * @return URL, appended with slash if missing
+ * @returns URL, appended with slash if missing
  */
 export function checkUrlPathTermination(url) {
     return url ? (url.endsWith("/") ? url : url + "/") : url;
@@ -95,7 +95,7 @@ export function checkUrlPathTermination(url) {
 /**
  * Creates a random 32-character alphanumeric string.
  *
- * @return A lowercase 32-char alphanumeric string
+ * @returns A lowercase 32-char alphanumeric string
  * @internal
  */
 export function createLongId() {
@@ -105,7 +105,7 @@ export function createLongId() {
 /**
  * Creates a random 8-character alphanumeric string that begins with an alphabetic character.
  *
- * @return An alphanumeric string in the range [a0000000..zzzzzzzz]
+ * @returns An alphanumeric string in the range [a0000000..zzzzzzzz]
  */
 export function createShortId() {
     // Return a random number, but beginning with an alphabetic character so that it can be used as a valid
@@ -135,7 +135,7 @@ export function dedupe(input = []) {
  *
  * @param itemType The AGO item type
  * @param id Item id to include in response
- * @return Empty creation response
+ * @returns Empty creation response
  */
 export function generateEmptyCreationResponse(itemType, id = "") {
     return {
@@ -149,7 +149,7 @@ export function generateEmptyCreationResponse(itemType, id = "") {
  * Converts JSON to a Blob.
  *
  * @param json JSON to use as source
- * @return A blob from the source JSON
+ * @returns A blob from the source JSON
  */
 export function jsonToBlob(json) {
     const _json = JSON.stringify(json);
@@ -166,7 +166,7 @@ export function jsonToBlob(json) {
  * @param json JSON to use as source
  * @param filename Name to use for file
  * @param mimeType MIME type to override blob's MIME type
- * @return File created out of JSON and filename
+ * @returns File created out of JSON and filename
  */
 export function jsonToFile(json, filename, mimeType = "application/json") {
     return blobToFile(jsonToBlob(json), filename, mimeType);
@@ -176,7 +176,7 @@ export function jsonToFile(json, filename, mimeType = "application/json") {
  *
  * @param filename Name to give file
  * @param blob Blob to save
- * @return Promise resolving when operation is complete
+ * @returns Promise resolving when operation is complete
  */
 // Function is only used for live testing, so excluding it from coverage for now
 /* istanbul ignore next */
@@ -200,7 +200,7 @@ export function saveBlobAsFile(filename, blob) {
  * Makes a deep clone, including arrays but not functions.
  *
  * @param obj Object to be cloned
- * @return Clone of obj
+ * @returns Clone of obj
  * @example
  * ```js
  * import { cloneObject } from "utils/object-helpers";
@@ -242,7 +242,7 @@ export function cloneObject(obj) {
  *
  * @param json1 First object
  * @param json2 Second object
- * @return True if objects are the same
+ * @returns True if objects are the same
  */
 export function compareJSON(json1, json2) {
     return JSON.stringify(json1) === JSON.stringify(json2);
@@ -252,7 +252,7 @@ export function compareJSON(json1, json2) {
  *
  * @param json1 First object
  * @param json2 Second object
- * @return True if objects are the same
+ * @returns True if objects are the same
  */
 export function compareJSONNoEmptyStrings(json1, json2) {
     const jsonStr1 = JSON.stringify(json1).replace(/":""/g, '":null');
@@ -264,7 +264,7 @@ export function compareJSONNoEmptyStrings(json1, json2) {
  *
  * @param json1 First object
  * @param json2 Second object
- * @return A list of mismatch report strings
+ * @returns A list of mismatch report strings
  */
 export function compareJSONProperties(json1, json2) {
     let mismatches = [];
@@ -328,7 +328,7 @@ export function compareJSONProperties(json1, json2) {
  *
  * @param json JSON to sanitize
  * @param sanitizer Instance of Sanitizer class
- * @return Sanitized version of `json`
+ * @returns Sanitized version of `json`
  * @see https://github.com/esri/arcgis-html-sanitizer#sanitize-json
  */
 export function sanitizeJSONAndReportChanges(json, sanitizer) {
@@ -413,7 +413,7 @@ export function deleteProps(obj, props) {
  * Creates an AGO-style JSON failure response with success property.
  *
  * @param e Optional error information
- * @return JSON structure with property success set to false and optionally including `e`
+ * @returns JSON structure with property success set to false and optionally including `e`
  */
 export function fail(e) {
     if (e) {
@@ -428,7 +428,7 @@ export function fail(e) {
  *
  * @param ids List of ids
  * @param e Optional error information
- * @return JSON structure with property success set to false and optionally including `e`
+ * @returns JSON structure with property success set to false and optionally including `e`
  */
 export function failWithIds(itemIds, e) {
     if (e) {
@@ -442,7 +442,7 @@ export function failWithIds(itemIds, e) {
  * Extracts the ids from a string
  *
  * @param v String to examine
- * @return List of id strings found
+ * @returns List of id strings found
  * @example
  * get id from
  *   bad3483e025c47338d43df308c117308
@@ -472,7 +472,7 @@ export function getIDs(v) {
  * @param obj Object to retrieve value from
  * @param path Path into an object, e.g., "data.values.webmap", where "data" is a top-level property
  *             in obj
- * @return Value at end of path
+ * @returns Value at end of path
  */
 export function getProp(obj, path) {
     return path.split(".").reduce(function (prev, curr) {
@@ -485,7 +485,7 @@ export function getProp(obj, path) {
  *
  * @param obj Object to retrieve values from
  * @param props Array of paths into the object e.g., "data.values.webmap", where "data" is a top-level property
- * @return Array of the values plucked from the object; only defined values are returned
+ * @returns Array of the values plucked from the object; only defined values are returned
  */
 export function getProps(obj, props) {
     return props.reduce((a, p) => {
@@ -504,7 +504,7 @@ export function getProps(obj, props) {
  * @param path Path into an object, e.g., "data.values.webmap", where "data" is a top-level property
  *             in obj
  * @param defaultV Optional value to use if any part of path--including final value--is undefined
- * @return Value at end of path
+ * @returns Value at end of path
  */
 export function getPropWithDefault(obj, path, defaultV) {
     const value = path.split(".").reduce(function (prev, curr) {
@@ -582,9 +582,9 @@ export function setProp(obj, path, value) {
 /**
  * Creates a timestamp string using the current UTC date and time.
  *
- * @return Timestamp formatted as YYYYMMDD_hhmm_ssmmm, with month one-based and all values padded with zeroes on the
+ * @returns Timestamp formatted as YYYYMMDD_hhmm_ssmmm, with month one-based and all values padded with zeroes on the
  * left as needed (`ssmmm` stands for seconds from 0..59 and milliseconds from 0..999)
- * @protected
+ * @private
  */
 export function getUTCTimestamp() {
     const now = new Date();
@@ -603,7 +603,7 @@ export function getUTCTimestamp() {
  *
  * @param jsonObj Object to test
  * @param keywords List of keywords to look for in jsonObj
- * @return Boolean indicating result
+ * @returns Boolean indicating result
  */
 export function hasAnyKeyword(jsonObj, keywords) {
     const typeKeywords = getProp(jsonObj, "item.typeKeywords") || jsonObj.typeKeywords || [];
@@ -619,7 +619,7 @@ export function hasAnyKeyword(jsonObj, keywords) {
  *
  * @param jsonObj Object to test
  * @param keyword Keyword to look for in jsonObj
- * @return Boolean indicating result
+ * @returns Boolean indicating result
  */
 export function hasTypeKeyword(jsonObj, keyword) {
     const typeKeywords = getProp(jsonObj, "item.typeKeywords") || jsonObj.typeKeywords || [];
@@ -633,7 +633,7 @@ export function hasTypeKeyword(jsonObj, keyword) {
  * @param title The root title to test
  * @param templateDictionary Hash of the facts
  * @param path to the objects to evaluate for potantial name clashes
- * @return string The unique title to use
+ * @returns string The unique title to use
  */
 export function getUniqueTitle(title, templateDictionary, path) {
     title = title ? title.trim() : "_";
@@ -655,7 +655,7 @@ export function getUniqueTitle(title, templateDictionary, path) {
  * @param obj Object to scan and to modify
  * @param pattern Search pattern in each string
  * @param replacement Replacement for matches to search pattern
- * @return Modified obj is returned
+ * @returns Modified obj is returned
  */
 export function globalStringReplace(obj, pattern, replacement) {
     if (obj) {
@@ -680,7 +680,7 @@ export function globalStringReplace(obj, pattern, replacement) {
  * @param datasourceInfos Array of DatasourceInfos to evaluate
  * @param itemId The items id to check for
  * @param layerId The layers id to check for
- * @return Boolean indicating result
+ * @returns Boolean indicating result
  */
 export function hasDatasource(datasourceInfos, itemId, layerId) {
     return datasourceInfos.some(ds => ds.itemId === itemId && ds.layerId === layerId);
@@ -725,7 +725,7 @@ export function cleanLayerId(id) {
  * @param templates Array of item templates to search
  * @param id of template we are searching for
  *
- * @return Template associated with the user provided id argument
+ * @returns Template associated with the user provided id argument
  */
 export function getTemplateById(templates, id) {
     let template;
@@ -743,7 +743,7 @@ export function getTemplateById(templates, id) {
  *
  * @param v a string value to test with the expression
  * @param ex the regular expresion to test with
- * @return an array of matches
+ * @returns an array of matches
  */
 export function regExTest(v, ex) {
     return v && ex.test(v) ? v.match(ex) : [];
@@ -754,7 +754,7 @@ export function regExTest(v, ex) {
  *
  * @param min Inclusive minimum desired value
  * @param max Non-inclusive maximum desired value
- * @return Random number in the range [min, max)
+ * @returns Random number in the range [min, max)
  */
 export function _getRandomNumberInRange(min, max) {
     // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/random#Getting_a_random_number_between_two_values
@@ -767,8 +767,8 @@ export function _getRandomNumberInRange(min, max) {
  *
  * @param n Number to pad
  * @param totalSize Desired *minimum* width of number after padding with zeroes
- * @return Number converted to string and padded on the left as needed
- * @protected
+ * @returns Number converted to string and padded on the left as needed
+ * @private
  */
 export function _padPositiveNum(n, totalSize) {
     let numStr = n.toString();
@@ -782,9 +782,9 @@ export function _padPositiveNum(n, totalSize) {
  * Implements rejected ECMA proposal to change `typeof null` from "object" to "null".
  *
  * @param value Value whose type is sought
- * @return "null" if `value` is null; `typeof value` otherwise
+ * @returns "null" if `value` is null; `typeof value` otherwise
  * @see https://web.archive.org/web/20160331031419/http://wiki.ecmascript.org:80/doku.php?id=harmony:typeof_null
- * @protected
+ * @private
  */
 function _typeof_null(value) {
     return value === null ? "null" : typeof value;

package/dist/esm/getDeletableSolutionInfo.d.ts

@@ -24,6 +24,6 @@ import { ISolutionPrecis, UserSession } from "./interfaces";
  *
  * @param solutionItemId Id of a deployed Solution
  * @param authentication Credentials for the request
- * @return Promise resolving to the list of items in the solution that would be deleted.
+ * @returns Promise resolving to the list of items in the solution that would be deleted.
  */
 export declare function getDeletableSolutionInfo(solutionItemId: string, authentication: UserSession): Promise<ISolutionPrecis>;

package/dist/esm/getDeletableSolutionInfo.js

@@ -23,7 +23,7 @@ import * as restHelpersGet from "./restHelpersGet";
  *
  * @param solutionItemId Id of a deployed Solution
  * @param authentication Credentials for the request
- * @return Promise resolving to the list of items in the solution that would be deleted.
+ * @returns Promise resolving to the list of items in the solution that would be deleted.
  */
 export function getDeletableSolutionInfo(solutionItemId, authentication) {
     let solutionSummary;

package/dist/esm/getSolutionSummary.d.ts

@@ -22,6 +22,6 @@ import { ISolutionPrecis, UserSession } from "./interfaces";
  *
  * @param solutionItemId Id of a deployed Solution
  * @param authentication Credentials for the request
- * @return Promise resolving to a summary of the deployed Solution
+ * @returns Promise resolving to a summary of the deployed Solution
  */
 export declare function getSolutionSummary(solutionItemId: string, authentication: UserSession): Promise<ISolutionPrecis>;

package/dist/esm/getSolutionSummary.js

@@ -26,7 +26,7 @@ import * as templatization from "./templatization";
  *
  * @param solutionItemId Id of a deployed Solution
  * @param authentication Credentials for the request
- * @return Promise resolving to a summary of the deployed Solution
+ * @returns Promise resolving to a summary of the deployed Solution
  */
 export function getSolutionSummary(solutionItemId, authentication) {
     const solutionSummary = {