@esri/solution-common 1.3.10 → 1.3.13

package/dist/node/restHelpersGet.js

@@ -78,7 +78,7 @@ exports.getFoldersAndGroups = getFoldersAndGroups;
  * @param url Address of Blob
  * @param filename Name to use for file
  * @param authentication Credentials for the request
- * @return Promise that will resolve with a File, undefined if the Blob is null, or an AGO-style JSON failure response
+ * @returns Promise that will resolve with a File, undefined if the Blob is null, or an AGO-style JSON failure response
  */
 function getBlobAsFile(url, filename, authentication, ignoreErrors = [], mimeType) {
     return new Promise((resolve, reject) => {
@@ -93,7 +93,7 @@ exports.getBlobAsFile = getBlobAsFile;
  * @param url Address of Blob
  * @param authentication Credentials for the request
  * @param ignoreErrors List of HTTP error codes that should be ignored
- * @return Promise that will resolve with Blob or an AGO-REST JSON failure response
+ * @returns Promise that will resolve with Blob or an AGO-REST JSON failure response
  */
 function getBlobCheckForError(url, authentication, ignoreErrors = []) {
     return new Promise((resolve, reject) => {
@@ -132,7 +132,7 @@ exports.getBlobCheckForError = getBlobCheckForError;
  * Extracts the text in a url between the last forward slash and the beginning of the url's parameters.
  *
  * @param url URL to work with
- * @return Text extracted; empty if url ends with a forward slash or has a "?" immediately after the last
+ * @returns Text extracted; empty if url ends with a forward slash or has a "?" immediately after the last
  * forward slash
  */
 function getFilenameFromUrl(url) {
@@ -155,7 +155,7 @@ exports.getFilenameFromUrl = getFilenameFromUrl;
  *
  * @param groupId Id of an group whose primary information is sought
  * @param authentication Credentials for the request to AGO
- * @return A promise that will resolve with group's JSON or error JSON or throws ArcGISRequestError in case of HTTP error
+ * @returns A promise that will resolve with group's JSON or error JSON or throws ArcGISRequestError in case of HTTP error
  *         or response error code
  */
 function getGroupBase(groupId, authentication) {
@@ -170,7 +170,7 @@ exports.getGroupBase = getGroupBase;
  *
  * @param groupId Id of an group whose category schema information is sought
  * @param authentication Credentials for the request to AGO
- * @return A promise that will resolve with JSON of group's category schema
+ * @returns A promise that will resolve with JSON of group's category schema
  * @see https://developers.arcgis.com/rest/users-groups-and-items/group-category-schema.htm
  */
 function getGroupCategorySchema(groupId, authentication) {
@@ -185,7 +185,7 @@ exports.getGroupCategorySchema = getGroupCategorySchema;
  *
  * @param groupId Id of a group whose contents are sought
  * @param authentication Credentials for the request to AGO
- * @return A promise that will resolve with list of dependent ids or an empty list
+ * @returns A promise that will resolve with list of dependent ids or an empty list
  */
 function getGroupContents(groupId, authentication) {
     return new Promise((resolve, reject) => {
@@ -205,7 +205,7 @@ exports.getGroupContents = getGroupContents;
  *
  * @param itemId Id of an item whose primary information is sought
  * @param authentication Credentials for the request to AGO
- * @return A promise that will resolve with item's JSON or error JSON or throws ArcGISRequestError in case of HTTP error
+ * @returns A promise that will resolve with item's JSON or error JSON or throws ArcGISRequestError in case of HTTP error
  *         or response error code
  */
 function getItemBase(itemId, authentication) {
@@ -221,7 +221,7 @@ exports.getItemBase = getItemBase;
  * @param itemId Id of an item whose data information is sought
  * @param filename Name to use for file
  * @param authentication Credentials for the request to AGO
- * @return Promise that will resolve with a File, undefined if the Blob is null, or an AGO-style JSON failure response
+ * @returns Promise that will resolve with a File, undefined if the Blob is null, or an AGO-style JSON failure response
  */
 function getItemDataAsFile(itemId, filename, authentication) {
     return new Promise(resolve => {
@@ -235,7 +235,7 @@ exports.getItemDataAsFile = getItemDataAsFile;
  * @param itemId Id of an item whose data information is sought
  * @param filename Name to use for file
  * @param authentication Credentials for the request to AGO
- * @return Promise that will resolve with JSON, or an AGO-style JSON failure response
+ * @returns Promise that will resolve with JSON, or an AGO-style JSON failure response
  */
 function getItemDataAsJson(itemId, authentication) {
     return new Promise(resolve => {
@@ -248,7 +248,7 @@ exports.getItemDataAsJson = getItemDataAsJson;
  *
  * @param itemId Id of an item whose data information is sought
  * @param authentication Credentials for the request to AGO
- * @return A promise that will resolve with the data Blob or null if the item doesn't have a data section
+ * @returns A promise that will resolve with the data Blob or null if the item doesn't have a data section
  */
 function getItemDataBlob(itemId, authentication) {
     return new Promise(resolve => {
@@ -262,7 +262,7 @@ exports.getItemDataBlob = getItemDataBlob;
  *
  * @param itemId Id of an item whose data information is sought
  * @param authentication Credentials for the request to AGO
- * @return URL string
+ * @returns URL string
  */
 function getItemDataBlobUrl(itemId, authentication) {
     return `${getPortalSharingUrlFromAuth(authentication)}/content/items/${itemId}/data`;
@@ -273,7 +273,7 @@ exports.getItemDataBlobUrl = getItemDataBlobUrl;
  *
  * @param itemId Id of an item whose data information is sought
  * @param authentication Credentials for the request to AGO
- * @return URL string
+ * @returns URL string
  */
 function getItemInfoFileUrlPrefix(itemId, authentication) {
     return `${getPortalSharingUrlFromAuth(authentication)}/content/items/${itemId}/info/`;
@@ -284,7 +284,7 @@ exports.getItemInfoFileUrlPrefix = getItemInfoFileUrlPrefix;
  *
  * @param itemId Id of an item whose data information is sought
  * @param authentication Credentials for the request to AGO
- * @return Promise that will resolve with `undefined` or a File containing the metadata
+ * @returns Promise that will resolve with `undefined` or a File containing the metadata
  */
 function getItemMetadataAsFile(itemId, authentication) {
     return new Promise(resolve => {
@@ -304,7 +304,7 @@ exports.getItemMetadataAsFile = getItemMetadataAsFile;
  *
  * @param itemId Id of an item whose data information is sought
  * @param authentication Credentials for the request to AGO
- * @return A promise that will resolve with the metadata Blob or null if the item doesn't have a metadata file
+ * @returns A promise that will resolve with the metadata Blob or null if the item doesn't have a metadata file
  */
 function getItemMetadataBlob(itemId, authentication) {
     return new Promise((resolve, reject) => {
@@ -318,7 +318,7 @@ exports.getItemMetadataBlob = getItemMetadataBlob;
  *
  * @param itemId Id of an item whose data information is sought
  * @param authentication Credentials for the request to AGO
- * @return URL string
+ * @returns URL string
  */
 function getItemMetadataBlobUrl(itemId, authentication) {
     return (getItemInfoFileUrlPrefix(itemId, authentication) + "metadata/metadata.xml");
@@ -331,7 +331,7 @@ exports.getItemMetadataBlobUrl = getItemMetadataBlobUrl;
  * @param relationshipType
  * @param direction
  * @param authentication Credentials for the request to AGO
- * @return A promise that will resolve with an arcgis-rest-js `IGetRelatedItemsResponse` structure
+ * @returns A promise that will resolve with an arcgis-rest-js `IGetRelatedItemsResponse` structure
  */
 function getItemRelatedItems(itemId, relationshipType, direction, authentication) {
     return new Promise(resolve => {
@@ -361,7 +361,7 @@ exports.getItemRelatedItems = getItemRelatedItems;
  * @param itemId Id of an item whose related items are sought
  * @param direction
  * @param authentication Credentials for the request to AGO
- * @return A promise that will resolve with a list of IRelatedItems
+ * @returns A promise that will resolve with a list of IRelatedItems
  */
 function getItemRelatedItemsInSameDirection(itemId, direction, authentication) {
     return new Promise(resolve => {
@@ -433,7 +433,7 @@ exports.getItemResources = getItemResources;
  *
  * @param itemId Id of an item whose resources are sought
  * @param authentication Credentials for the request to AGO
- * @return Promise that will resolve with a list of Files or an AGO-style JSON failure response
+ * @returns Promise that will resolve with a list of Files or an AGO-style JSON failure response
  */
 function getItemResourcesFiles(itemId, authentication) {
     return new Promise((resolve, reject) => {
@@ -453,7 +453,7 @@ exports.getItemResourcesFiles = getItemResourcesFiles;
  *
  * @param solutionItemId Id of a deployed Solution
  * @param authentication Credentials for the request
- * @return Promise resolving to a list of detailed item information
+ * @returns Promise resolving to a list of detailed item information
  */
 function getItemsRelatedToASolution(solutionItemId, authentication) {
     // eslint-disable-next-line @typescript-eslint/no-floating-promises
@@ -470,7 +470,7 @@ exports.getItemsRelatedToASolution = getItemsRelatedToASolution;
  * in the item's base section
  * @param isGroup Switch indicating if the item is a group
  * @param authentication Credentials for the request to AGO
- * @return Promise that will resolve with an image Blob or an AGO-style JSON failure response
+ * @returns Promise that will resolve with an image Blob or an AGO-style JSON failure response
  */
 function getItemThumbnail(itemId, thumbnailUrlPart, isGroup, authentication) {
     return new Promise((resolve, reject) => {
@@ -491,7 +491,7 @@ exports.getItemThumbnail = getItemThumbnail;
  * in the item's base section
  * @param isGroup Switch indicating if the item is a group
  * @param authentication Credentials for the request to AGO
- * @return Promise that will resolve with an image Blob or an AGO-style JSON failure response
+ * @returns Promise that will resolve with an image Blob or an AGO-style JSON failure response
  */
 function getItemThumbnailAsFile(itemId, thumbnailUrlPart, isGroup, authentication) {
     return new Promise((resolve, reject) => {
@@ -515,7 +515,7 @@ exports.getItemThumbnailAsFile = getItemThumbnailAsFile;
  * in the item's base section
  * @param isGroup Switch indicating if the item is a group
  * @param authentication Credentials for the request to AGO
- * @return URL string
+ * @returns URL string
  */
 function getItemThumbnailUrl(itemId, thumbnailUrlPart, isGroup, authentication) {
     return ((0, generalHelpers_1.checkUrlPathTermination)(getPortalSharingUrlFromAuth(authentication)) +
@@ -530,7 +530,7 @@ exports.getItemThumbnailUrl = getItemThumbnailUrl;
  *
  * @param url Address of JSON
  * @param authentication Credentials for the request
- * @return Promise that will resolve with JSON
+ * @returns Promise that will resolve with JSON
  */
 function getJson(url, authentication) {
     // Get the blob from the URL
@@ -578,7 +578,7 @@ exports.getPortalUrlFromAuth = getPortalUrlFromAuth;
  *
  * @param itemId Id of an AGO item to query
  * @param authentication Credentials for the request
- * @return Promise resolving to a list of Solution item ids
+ * @returns Promise resolving to a list of Solution item ids
  */
 function getSolutionsRelatedToAnItem(itemId, authentication) {
     // eslint-disable-next-line @typescript-eslint/no-floating-promises
@@ -598,9 +598,9 @@ exports.getThumbnailFile = getThumbnailFile;
  * Fixes the types of Blobs incorrectly typed as text/plain.
  *
  * @param blob Blob to check
- * @return Promise resolving to original Blob, unless it's originally typed as text/plain but is
+ * @returns Promise resolving to original Blob, unless it's originally typed as text/plain but is
  * really JSON, ZIP, or XML
- * @protected
+ * @private
  */
 function _fixTextBlobType(blob) {
     return new Promise((resolve, reject) => {
@@ -654,8 +654,8 @@ exports._fixTextBlobType = _fixTextBlobType;
  * @param groupId Id of a group whose contents are sought
  * @param pagingParams Structure with start and num properties for the tranche to fetch
  * @param authentication Credentials for the request to AGO
- * @return A promise that will resolve with list of dependent ids or an empty list
- * @protected
+ * @returns A promise that will resolve with list of dependent ids or an empty list
+ * @private
  */
 function _getGroupContentsTranche(groupId, pagingParams, authentication) {
     return new Promise((resolve, reject) => {
@@ -693,8 +693,8 @@ exports._getGroupContentsTranche = _getGroupContentsTranche;
  * @param itemId Id of an item whose resources are sought
  * @param pagingParams Structure with start and num properties for the tranche to fetch
  * @param authentication Credentials for the request to AGO
- * @return Promise that will resolve with a list of File promises or an AGO-style JSON failure response
- * @protected
+ * @returns Promise that will resolve with a list of File promises or an AGO-style JSON failure response
+ * @private
  */
 function _getItemResourcesTranche(itemId, pagingParams, authentication) {
     return new Promise((resolve, reject) => {

package/dist/node/templatization.d.ts

@@ -19,31 +19,31 @@ import { IItemTemplate, ISolutionItemData } from "./interfaces";
  * itself; name has to be acceptable to AGOL, otherwise it discards the URL, so substitution must be
  * made before attempting to create the item.
  *
- * @protected
+ * @private
  */
 export declare const SERVER_NAME: string;
 /**
  * A parameterized geometry server name
  *
- * @protected
+ * @private
  */
 export declare const GEOMETRY_SERVER_NAME: string;
 /**
  * A parameterized geocode server name
  *
- * @protected
+ * @private
  */
 export declare const GEOCODE_SERVER_NAME: string;
 /**
  * A parameterized network analyst server name
  *
- * @protected
+ * @private
  */
 export declare const NA_SERVER_NAME: string;
 /**
  * A parameterized network analyst server name
  *
- * @protected
+ * @private
  */
 export declare const PRINT_SERVER_NAME: string;
 export declare const TRANSFORMS: any;
@@ -51,7 +51,7 @@ export declare const TRANSFORMS: any;
  * Wraps double brackets around the supplied term.
  *
  * @param term Term to be wrapped, e.g., SERVER_NAME's "portalBaseUrl"
- * @return Wrapped term, e.g., "{{portalBaseUrl}}"
+ * @returns Wrapped term, e.g., "{{portalBaseUrl}}"
  */
 export declare function placeholder(term: string): string;
 export declare function createInitializedGroupTemplate(itemInfo: any): IItemTemplate;
@@ -61,14 +61,14 @@ export declare function createInitializedItemTemplate(itemInfo: any): IItemTempl
  *
  * @param id AGO id of item
  * @param type AGO item type; defaults to ""
- * @return Empty template containing supplied id, optional type, and a key created using the function createShortId()
+ * @returns Empty template containing supplied id, optional type, and a key created using the function createShortId()
  */
 export declare function createPlaceholderTemplate(id: string, type?: string): IItemTemplate;
 /**
  * Extracts the version of a solution from its data section.
  *
  * @param itemData Data section of the solution as JSON
- * @return Zero-based version number
+ * @returns Zero-based version number
  */
 export declare function extractSolutionVersion(itemData: ISolutionItemData): number;
 /**
@@ -76,8 +76,8 @@ export declare function extractSolutionVersion(itemData: ISolutionItemData): num
  *
  * @param templates A collection of AGO item templates to search
  * @param id AGO id of template to find
- * @return Offset of of matching template or -1 if not found
- * @protected
+ * @returns Offset of of matching template or -1 if not found
+ * @private
  */
 export declare function findTemplateIndexInList(templates: IItemTemplate[], id: string): number;
 /**
@@ -85,7 +85,7 @@ export declare function findTemplateIndexInList(templates: IItemTemplate[], id:
  *
  * @param templates A collection of AGO item templates to search
  * @param id AGO id of template to find
- * @return Matching template or null
+ * @returns Matching template or null
  */
 export declare function findTemplateInList(templates: IItemTemplate[], id: string): IItemTemplate | null;
 export declare function hasUnresolvedVariables(data: any): boolean;
@@ -96,7 +96,7 @@ export declare function getDefaultExtent(itemInfo: any): any;
  *
  * @param templates A collection of AGO item templates
  * @param id Id of item in templates list to find; if not found, no replacement is done
- * @protected
+ * @private
  */
 export declare function removeTemplate(templates: IItemTemplate[], id: string): void;
 /**
@@ -104,7 +104,7 @@ export declare function removeTemplate(templates: IItemTemplate[], id: string):
  *
  * @param template Template to check for replacements; template is modified by this function
  * @param replacements Hash of facts: org URL, adlib replacements, deferreds for dependencies
- * @return template is returned after updating it
+ * @returns template is returned after updating it
  */
 export declare function replaceInTemplate(template: any, replacements: any): any;
 /**
@@ -113,8 +113,8 @@ export declare function replaceInTemplate(template: any, replacements: any): any
  * @param templates A collection of AGO item templates
  * @param id Id of item in templates list to find; if not found, no replacement is done
  * @param template Replacement template
- * @return True if replacement was made
- * @protected
+ * @returns True if replacement was made
+ * @private
  */
 export declare function replaceTemplate(templates: IItemTemplate[], id: string, template: IItemTemplate): boolean;
 export declare function templatizeTerm(context: string, term: string, suffix?: string): string;

package/dist/node/templatization.js

@@ -30,31 +30,31 @@ const generalHelpers_1 = require("./generalHelpers");
  * itself; name has to be acceptable to AGOL, otherwise it discards the URL, so substitution must be
  * made before attempting to create the item.
  *
- * @protected
+ * @private
  */
 exports.SERVER_NAME = "portalBaseUrl";
 /**
  * A parameterized geometry server name
  *
- * @protected
+ * @private
  */
 exports.GEOMETRY_SERVER_NAME = "organization.helperServices.geometry.url";
 /**
  * A parameterized geocode server name
  *
- * @protected
+ * @private
  */
 exports.GEOCODE_SERVER_NAME = "organization.helperServices.geocode:getDefaultLocatorURL";
 /**
  * A parameterized network analyst server name
  *
- * @protected
+ * @private
  */
 exports.NA_SERVER_NAME = "organization.helperServices.route.url";
 /**
  * A parameterized network analyst server name
  *
- * @protected
+ * @private
  */
 exports.PRINT_SERVER_NAME = "organization.helperServices.printTask.url";
 exports.TRANSFORMS = {
@@ -68,7 +68,7 @@ exports.TRANSFORMS = {
  * Wraps double brackets around the supplied term.
  *
  * @param term Term to be wrapped, e.g., SERVER_NAME's "portalBaseUrl"
- * @return Wrapped term, e.g., "{{portalBaseUrl}}"
+ * @returns Wrapped term, e.g., "{{portalBaseUrl}}"
  */
 function placeholder(term) {
     return "{{" + term + "}}";
@@ -120,7 +120,7 @@ exports.createInitializedItemTemplate = createInitializedItemTemplate;
  *
  * @param id AGO id of item
  * @param type AGO item type; defaults to ""
- * @return Empty template containing supplied id, optional type, and a key created using the function createShortId()
+ * @returns Empty template containing supplied id, optional type, and a key created using the function createShortId()
  */
 function createPlaceholderTemplate(id, type = "") {
     return {
@@ -144,7 +144,7 @@ exports.createPlaceholderTemplate = createPlaceholderTemplate;
  * Extracts the version of a solution from its data section.
  *
  * @param itemData Data section of the solution as JSON
- * @return Zero-based version number
+ * @returns Zero-based version number
  */
 function extractSolutionVersion(itemData) {
     let version = (0, generalHelpers_1.getProp)(itemData, "metadata.version");
@@ -163,8 +163,8 @@ exports.extractSolutionVersion = extractSolutionVersion;
  *
  * @param templates A collection of AGO item templates to search
  * @param id AGO id of template to find
- * @return Offset of of matching template or -1 if not found
- * @protected
+ * @returns Offset of of matching template or -1 if not found
+ * @private
  */
 function findTemplateIndexInList(templates, id) {
     const baseId = id;
@@ -178,7 +178,7 @@ exports.findTemplateIndexInList = findTemplateIndexInList;
  *
  * @param templates A collection of AGO item templates to search
  * @param id AGO id of template to find
- * @return Matching template or null
+ * @returns Matching template or null
  */
 function findTemplateInList(templates, id) {
     const iTemplate = findTemplateIndexInList(templates, id);
@@ -208,7 +208,7 @@ exports.getDefaultExtent = getDefaultExtent;
  *
  * @param templates A collection of AGO item templates
  * @param id Id of item in templates list to find; if not found, no replacement is done
- * @protected
+ * @private
  */
 function removeTemplate(templates, id) {
     const i = findTemplateIndexInList(templates, id);
@@ -222,7 +222,7 @@ exports.removeTemplate = removeTemplate;
  *
  * @param template Template to check for replacements; template is modified by this function
  * @param replacements Hash of facts: org URL, adlib replacements, deferreds for dependencies
- * @return template is returned after updating it
+ * @returns template is returned after updating it
  */
 function replaceInTemplate(template, replacements) {
     return (0, adlib_1.adlib)(template, replacements, exports.TRANSFORMS);
@@ -234,8 +234,8 @@ exports.replaceInTemplate = replaceInTemplate;
  * @param templates A collection of AGO item templates
  * @param id Id of item in templates list to find; if not found, no replacement is done
  * @param template Replacement template
- * @return True if replacement was made
- * @protected
+ * @returns True if replacement was made
+ * @private
  */
 function replaceTemplate(templates, id, template) {
     const i = findTemplateIndexInList(templates, id);

package/dist/node/trackingHelpers.d.ts

@@ -27,7 +27,7 @@ import { ICreateServiceParams } from "@esri/arcgis-rest-service-admin";
  * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
  * @param templates the list of IItemTemplates from the solution
  *
- * @protected
+ * @private
  */
 export declare function setLocationTrackingEnabled(portalResponse: any, userResponse: any, templateDictionary: any, templates?: IItemTemplate[]): void;
 /**
@@ -39,7 +39,7 @@ export declare function setLocationTrackingEnabled(portalResponse: any, userResp
  * @param templates the list of IItemTemplates from the solution
  * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
  *
- * @protected
+ * @private
  */
 export declare function _validateTrackingTemplates(templates: IItemTemplate[], templateDictionary: any): void;
 /**
@@ -52,7 +52,7 @@ export declare function _validateTrackingTemplates(templates: IItemTemplate[], t
  * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
  * @param authentication Credentials for the requests
  *
- * @protected
+ * @private
  */
 export declare function getTackingServiceOwner(templateDictionary: any, authentication: UserSession): Promise<boolean>;
 /**
@@ -61,7 +61,7 @@ export declare function getTackingServiceOwner(templateDictionary: any, authenti
  * @param itemTemplate the template to evaluate
  * @param itemUpdate the item update to evaluate
  *
- * @protected
+ * @private
  */
 export declare function isTrackingViewTemplate(itemTemplate?: IItemTemplate, itemUpdate?: IItemUpdate): boolean;
 /**
@@ -69,7 +69,7 @@ export declare function isTrackingViewTemplate(itemTemplate?: IItemTemplate, ite
  *
  * @param itemTemplate the template to evaluate
  *
- * @protected
+ * @private
  */
 export declare function isTrackingViewGroup(itemTemplate: IItemTemplate): boolean;
 /**
@@ -78,7 +78,7 @@ export declare function isTrackingViewGroup(itemTemplate: IItemTemplate): boolea
  *
  * @param itemTemplate Template for feature service item
  *
- * @protected
+ * @private
  */
 export declare function templatizeTracker(itemTemplate: IItemTemplate): void;
 /**
@@ -90,7 +90,7 @@ export declare function templatizeTracker(itemTemplate: IItemTemplate): void;
  * @param groupId the id of the associated tracker group
  * @param groupIdVar the variable to replace the existing name with
  *
- * @protected
+ * @private
  */
 export declare function _setName(itemTemplate: IItemTemplate, path: string, groupId: string, groupIdVar: string): void;
 /**
@@ -101,7 +101,7 @@ export declare function _setName(itemTemplate: IItemTemplate, path: string, grou
  * @param obj the object that stores the serviceItemId
  * @param path the path to the property that stores the serviceItemId
  *
- * @protected
+ * @private
  */
 export declare function templatizeServiceItemId(obj: any, path: string): void;
 /**
@@ -111,6 +111,6 @@ export declare function templatizeServiceItemId(obj: any, path: string): void;
  * @param options the current request options to update
  * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
  *
- * @protected
+ * @private
  */
 export declare function setTrackingOptions(itemTemplate: IItemTemplate, options: any, templateDictionary: any): ICreateServiceParams;

package/dist/node/trackingHelpers.js

@@ -30,7 +30,7 @@ const templatization_1 = require("./templatization");
  * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
  * @param templates the list of IItemTemplates from the solution
  *
- * @protected
+ * @private
  */
 function setLocationTrackingEnabled(portalResponse, userResponse, templateDictionary, templates) {
     // set locationTracking...contains service url and id
@@ -59,7 +59,7 @@ exports.setLocationTrackingEnabled = setLocationTrackingEnabled;
  * @param templates the list of IItemTemplates from the solution
  * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
  *
- * @protected
+ * @private
  */
 function _validateTrackingTemplates(templates, templateDictionary) {
     /* istanbul ignore else */
@@ -83,7 +83,7 @@ exports._validateTrackingTemplates = _validateTrackingTemplates;
  * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
  * @param authentication Credentials for the requests
  *
- * @protected
+ * @private
  */
 function getTackingServiceOwner(templateDictionary, authentication) {
     if (templateDictionary.locationTrackingEnabled) {
@@ -107,7 +107,7 @@ exports.getTackingServiceOwner = getTackingServiceOwner;
  * @param itemTemplate the template to evaluate
  * @param itemUpdate the item update to evaluate
  *
- * @protected
+ * @private
  */
 function isTrackingViewTemplate(itemTemplate, itemUpdate) {
     const typeKeywords = (0, generalHelpers_1.getProp)(itemTemplate, "item.typeKeywords") ||
@@ -122,7 +122,7 @@ exports.isTrackingViewTemplate = isTrackingViewTemplate;
  *
  * @param itemTemplate the template to evaluate
  *
- * @protected
+ * @private
  */
 function isTrackingViewGroup(itemTemplate) {
     const typeKeywords = (0, generalHelpers_1.getProp)(itemTemplate, "item.tags");
@@ -135,7 +135,7 @@ exports.isTrackingViewGroup = isTrackingViewGroup;
  *
  * @param itemTemplate Template for feature service item
  *
- * @protected
+ * @private
  */
 function templatizeTracker(itemTemplate) {
     /* istanbul ignore else */
@@ -163,7 +163,7 @@ exports.templatizeTracker = templatizeTracker;
  * @param groupId the id of the associated tracker group
  * @param groupIdVar the variable to replace the existing name with
  *
- * @protected
+ * @private
  */
 function _setName(itemTemplate, path, groupId, groupIdVar) {
     const name = (0, generalHelpers_1.getProp)(itemTemplate, path);
@@ -181,7 +181,7 @@ exports._setName = _setName;
  * @param obj the object that stores the serviceItemId
  * @param path the path to the property that stores the serviceItemId
  *
- * @protected
+ * @private
  */
 function templatizeServiceItemId(obj, path) {
     const serviceItemId = (0, generalHelpers_1.getProp)(obj, path);
@@ -198,7 +198,7 @@ exports.templatizeServiceItemId = templatizeServiceItemId;
  * @param options the current request options to update
  * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
  *
- * @protected
+ * @private
  */
 function setTrackingOptions(itemTemplate, options, templateDictionary) {
     /* istanbul ignore else */

package/dist/node/velocityHelpers.d.ts

@@ -26,7 +26,7 @@ export declare const PROP_NAMES: string[];
  * @param authentication Credentials for the requests
  * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
  *
- * @return a promise that will resolve with the velocity url or an empty string when the org does not support velocity
+ * @returns a promise that will resolve with the velocity url or an empty string when the org does not support velocity
  *
  */
 export declare function getVelocityUrlBase(authentication: UserSession, templateDictionary: any): Promise<string>;
@@ -40,7 +40,7 @@ export declare function getVelocityUrlBase(authentication: UserSession, template
  * @param type The item type
  * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
  *
- * @return an updated instance of the data object that was supplied.
+ * @returns an updated instance of the data object that was supplied.
  *
  */
 export declare function updateVelocityReferences(data: any, type: string, templateDictionary: any): any;
@@ -51,7 +51,7 @@ export declare function updateVelocityReferences(data: any, type: string, templa
  * @param data The data object of the item
  * @param velocityUrl The velocity url from the current organization
  *
- * @return an updated instance of the data object that was supplied.
- *
+ * @returns an updated instance of the data object that was supplied.
+ * @private
  */
 export declare function _replaceVelocityUrls(data: any, velocityUrl: string): any;