@esri/solution-common 1.3.10 → 1.3.13

package/dist/umd/libConnectors.d.ts

@@ -24,7 +24,7 @@ export { Sanitizer } from "@esri/arcgis-html-sanitizer";
  * @param zipFilename Name to use for zip File
  * @param files List of files to add to zip File
  * @param folder Folder to contain the files
- * @return Promise resolving to a zip File
+ * @returns Promise resolving to a zip File
  */
 export declare function createZip(zipFilename: string, files: File[], folder?: string): Promise<File>;
 /**
@@ -39,7 +39,7 @@ export interface IValidationResult {
  *
  * @param HTML Text to sanitize
  * @param sanitizer Instance of Sanitizer class
- * @return Sanitized version of `html`
+ * @returns Sanitized version of `html`
  * @see https://github.com/esri/arcgis-html-sanitizer#basic-usage
  */
 export declare function sanitizeHTML(html: string, sanitizer?: Sanitizer): string;
@@ -48,7 +48,7 @@ export declare function sanitizeHTML(html: string, sanitizer?: Sanitizer): strin
  *
  * @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 declare function sanitizeJSON(json: any, sanitizer?: Sanitizer): any;
@@ -57,7 +57,7 @@ export declare function sanitizeJSON(json: any, sanitizer?: Sanitizer): any;
  *
  * @param url URL to sanitize
  * @param sanitizer Instance of Sanitizer class
- * @return Sanitized version of `url`
+ * @returns Sanitized version of `url`
  * @see https://github.com/esri/arcgis-html-sanitizer#sanitize-urls
  */
 export declare function sanitizeURLProtocol(url: string, sanitizer?: Sanitizer): string;
@@ -66,7 +66,7 @@ export declare function sanitizeURLProtocol(url: string, sanitizer?: Sanitizer):
  *
  * @param html HTML to check
  * @param sanitizer Instance of Sanitizer class
- * @return An object containing a flag indicating if `html` is valid (i.e., contains no invalid HTML)
+ * @returns An object containing a flag indicating if `html` is valid (i.e., contains no invalid HTML)
  * as well as the sanitized version of `html`
  * @see https://github.com/esri/arcgis-html-sanitizer#basic-usage
  */

package/dist/umd/migrations/apply-schema.d.ts

@@ -19,5 +19,6 @@ import { ISolutionItem } from "../interfaces";
  *
  * @param model
  * @param authentication
+ * @private
  */
 export declare function _applySchema(model: ISolutionItem): ISolutionItem;

package/dist/umd/migrations/upgrade-three-dot-one.d.ts

@@ -22,5 +22,6 @@ import { ISolutionItem } from "../interfaces";
  *
  * @param model ISolutionItem
  * @param authentication UserSession
+ * @private
  */
 export declare function _upgradeThreeDotOne(model: ISolutionItem): ISolutionItem;

package/dist/umd/migrations/upgrade-two-dot-seven.d.ts

@@ -13,4 +13,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+/**
+ * Updates schema to 2.7.
+ *
+ * @param model Model to be updated
+ * @returns Updated model
+ * @private
+ */
 export declare function _upgradeTwoDotSeven(model: any): any;

package/dist/umd/polyfills.d.ts

@@ -22,7 +22,7 @@
  * Supplies Blob.text for Microsoft Legacy Edge
  *
  * @param blob Blob to read
- * @return Promise resolving to blob's text
+ * @returns Promise resolving to blob's text
  * @see https://developer.mozilla.org/en-US/docs/Web/API/Blob/Blob
  * @see https://developer.mozilla.org/en-US/docs/Web/API/FileReader
  */
@@ -33,7 +33,7 @@ export declare function getBlobText(blob: Blob): Promise<string>;
  * @param fileBits Contents for file
  * @param fileName Name for file
  * @param options Bucket of options, euch as `type` for the MIME type; defaults to empty string for `type`
- * @return File or, for Microsoft Legacy Edge, Blob
+ * @returns File or, for Microsoft Legacy Edge, Blob
  * @see https://developer.mozilla.org/en-US/docs/Web/API/File/File
  * @see https://developer.mozilla.org/en-US/docs/Web/API/Blob/Blob
  */

package/dist/umd/resourceHelpers.d.ts

@@ -59,7 +59,7 @@ export declare function convertBlobToSupportableResource(blob: Blob, filename?:
  * @param destinationItemId Id of item to receive copy of resource/metadata
  * @param destinationAuthentication Credentials for the request to the destination
  * @param template Template for using its itemId and properties for fine-tuning the filename for Hub
- * @return A promise which resolves to a boolean indicating if the copies were successful
+ * @returns A promise which resolves to a boolean indicating if the copies were successful
  */
 export declare function copyFilesFromStorageItem(storageAuthentication: UserSession, filePaths: IDeployFileCopyPath[], destinationFolderId: string, destinationItemId: string, destinationAuthentication: UserSession, template?: any): Promise<boolean>;
 /**
@@ -69,14 +69,14 @@ export declare function copyFilesFromStorageItem(storageAuthentication: UserSess
  * @param files List of item files and paths for storing the files
  * @param storageItemId Id of item to receive copy of resource/metadata
  * @param storageAuthentication Credentials for the request to the storage
- * @return A promise which resolves to a list of the filenames under which the resource/metadata are stored
+ * @returns A promise which resolves to a list of the filenames under which the resource/metadata are stored
  */
 export declare function copyFilesToStorageItem(files: ISourceFile[], storageItemId: string, storageAuthentication: UserSession): Promise<string[]>;
 /**
  * Generates a folder and filename for storing a copy of an item's metadata in a storage item.
  *
  * @param itemId Id of item
- * @return Folder and filename for storage; folder is the itemID suffixed with "_info_metadata"
+ * @returns Folder and filename for storage; folder is the itemID suffixed with "_info_metadata"
  * @see convertStorageResourceToItemResource
  */
 export declare function generateMetadataStorageFilename(itemId: string): {
@@ -93,7 +93,7 @@ export declare function generateMetadataStorageFilename(itemId: string): {
  * @param resourceFilenames List of resource filenames for an item, e.g., ["file1", "myFolder/file2"]
  * @param isGroup Boolean to indicate if the files are associated with a group or item
  * @param storageVersion Version of the Solution template
- * @return List of item files' URLs and folder/filenames for storing the files
+ * @returns List of item files' URLs and folder/filenames for storing the files
  */
 export declare function generateSourceFilePaths(portalSharingUrl: string, itemId: string, thumbnailUrlPart: string, resourceFilenames: string[], isGroup?: boolean, storageVersion?: number): ISourceFileCopyPath[];
 /**
@@ -102,7 +102,7 @@ export declare function generateSourceFilePaths(portalSharingUrl: string, itemId
  * @param sourcePortalSharingUrl Server/sharing
  * @param itemId Id of item
  * @param isGroup Boolean to indicate if the files are associated with a group or item
- * @return URL string
+ * @returns URL string
  */
 export declare function generateSourceMetadataUrl(sourcePortalSharingUrl: string, itemId: string, isGroup?: boolean): string;
 /**
@@ -111,7 +111,7 @@ export declare function generateSourceMetadataUrl(sourcePortalSharingUrl: string
  * @param sourcePortalSharingUrl Server/sharing
  * @param itemId Id of item
  * @param sourceResourceFilename Either filename or folder/filename to resource
- * @return URL string
+ * @returns URL string
  */
 export declare function generateSourceResourceUrl(sourcePortalSharingUrl: string, itemId: string, sourceResourceFilename: string): string;
 /**
@@ -121,7 +121,7 @@ export declare function generateSourceResourceUrl(sourcePortalSharingUrl: string
  * @param itemId Id of item
  * @param thumbnailUrlPart Partial path to the thumbnail held in an item's JSON
  * @param isGroup Boolean to indicate if the files are associated with a group or item
- * @return URL string
+ * @returns URL string
  */
 export declare function generateSourceThumbnailUrl(sourcePortalSharingUrl: string, itemId: string, thumbnailUrlPart: string, isGroup?: boolean): string;
 /**
@@ -132,7 +132,7 @@ export declare function generateSourceThumbnailUrl(sourcePortalSharingUrl: strin
  * @param storageItemId Id of storage item
  * @param resourceFilenames List of resource filenames for an item, e.g., ["file1", "myFolder/file2"]
  * @param storageVersion Version of the Solution template
- * @return List of item files' URLs and folder/filenames for storing the files
+ * @returns List of item files' URLs and folder/filenames for storing the files
  */
 export declare function generateStorageFilePaths(portalSharingUrl: string, storageItemId: string, resourceFilenames?: string[], storageVersion?: number): IDeployFileCopyPath[];
 /**
@@ -140,7 +140,7 @@ export declare function generateStorageFilePaths(portalSharingUrl: string, stora
  *
  * @param itemId Id of item
  * @param thumbnailUrlPart Partial path to the thumbnail held in an item's JSON
- * @return Folder and filename for storage; folder is the itemID suffixed with "_info_thumbnail";
+ * @returns Folder and filename for storage; folder is the itemID suffixed with "_info_thumbnail";
  * file is URI-encoded thumbnailUrlPart
  * @see convertStorageResourceToItemResource
  */
@@ -154,7 +154,7 @@ export declare function isSupportedFileType(filename: string): boolean;
  *
  * @param authentication Credentials for the request to the storage
  * @param filePaths List of item files' URLs and folder/filenames for storing the files
- * @return A promise which resolves to a boolean indicating if the copies were successful
+ * @returns A promise which resolves to a boolean indicating if the copies were successful
  */
 export declare function getThumbnailFromStorageItem(authentication: UserSession, filePaths: IDeployFileCopyPath[]): Promise<File>;
 /**
@@ -164,6 +164,6 @@ export declare function getThumbnailFromStorageItem(authentication: UserSession,
  * @param filename Name of the resource file to update
  * @param content The new content to update the resource with
  * @param authentication Credentials for the request to the storage
- * @return A promise which resolves with a success true/false response
+ * @returns A promise which resolves with a success true/false response
  */
 export declare function updateItemResourceText(itemId: string, filename: string, content: string, authentication: UserSession): Promise<IItemResourceResponse>;

package/dist/umd/resources/addMetadataFromBlob.d.ts

@@ -20,6 +20,6 @@ import { UserSession } from "../interfaces";
  * @param blob Blob containing metadata
  * @param itemId Item to receive metadata
  * @param authentication Credentials for the request
- * @return Promise resolving to JSON containing success boolean
+ * @returns Promise resolving to JSON containing success boolean
  */
 export declare function addMetadataFromBlob(blob: Blob, itemId: string, authentication: UserSession): Promise<any>;

package/dist/umd/resources/convert-item-resource-to-storage-resource.d.ts

@@ -21,7 +21,7 @@ import { SolutionResourceType } from "./solution-resource";
  * @param sourceResourceFilename Either filename or folder/filename to resource
  * @param storageVersion Version of the Solution template
  * @param storageFileType Optional argument that when supplied will control the how the prefix is created
- * @return Folder and filename for storage; folder is the itemID plus ("_" + storageFolder) if storageFolder
+ * @returns Folder and filename for storage; folder is the itemID plus ("_" + storageFolder) if storageFolder
  * exists plus ("_" + part of sourceResourceFilename before "/" if that separator exists);
  * file is sourceResourceFilename
  * @see convertStorageResourceToItemResource

package/dist/umd/resources/convert-storage-resource-to-item-resource.d.ts

@@ -19,7 +19,7 @@ import { IDeployFilename } from "../interfaces";
  *
  * @param storageResourceFilename Filename used to store the resource, metadata, or thumbnail of an item
  * @param storageVersion Version of the Solution template
- * @return Folder and filename for storing information in an item, as well as the type (resource, metadata,
+ * @returns Folder and filename for storing information in an item, as well as the type (resource, metadata,
  * or thumbnail) of the information; the folder property is only meaningful for the resource type
  * @see generateResourceStorageFilename
  * @see generateMetadataStorageFilename

package/dist/umd/resources/copyAssociatedFiles.d.ts

@@ -25,7 +25,7 @@ import { IAssociatedFileCopyResults, IAssociatedFileInfo, ISourceFile, IZipInfo,
  * @param destinationItemId Id of item to receive copy of resource/metadata/thumbnail
  * @param destinationAuthentication Credentials for the request to the storage
  * @param filesPerZip Number of files to include per zip file; AGO limits zips to 50 files
- * @return A promise which resolves to a list of the result of the copies
+ * @returns A promise which resolves to a list of the result of the copies
  */
 export declare function copyFilesAsResources(files: ISourceFile[], destinationItemId: string, destinationAuthentication: UserSession, filesPerZip?: number): Promise<IAssociatedFileCopyResults[]>;
 /**
@@ -37,7 +37,7 @@ export declare function copyFilesAsResources(files: ISourceFile[], destinationIt
  * @param sourceAuthentication Credentials for the request to the source
  * @param destinationItemId Id of item to receive copy of resource/metadata/thumbnail
  * @param destinationAuthentication Credentials for the request to the storage
- * @return A promise which resolves to a list of the result of the copies
+ * @returns A promise which resolves to a list of the result of the copies
  */
 export declare function copyAssociatedFilesByType(fileInfos: IAssociatedFileInfo[], sourceAuthentication: UserSession, destinationItemId: string, destinationAuthentication: UserSession): Promise<IAssociatedFileCopyResults[]>;
 /**
@@ -46,6 +46,7 @@ export declare function copyAssociatedFilesByType(fileInfos: IAssociatedFileInfo
  * @param zipInfos List of zip files containing files to store
  * @param destinationItemId Id of item to receive copy of resource/metadata/thumbnail
  * @param destinationAuthentication Credentials for the request to the storage
- * @return A promise which resolves to a list of the result of the copies
+ * @returns A promise which resolves to a list of the result of the copies
+ * @private
  */
 export declare function _copyAssociatedFileZips(zipInfos: IZipInfo[], destinationItemId: string, destinationAuthentication: UserSession): Promise<IAssociatedFileCopyResults[]>;

package/dist/umd/resources/copyDataIntoItem.d.ts

@@ -21,13 +21,13 @@ import { IAssociatedFileCopyResults, IAssociatedFileInfo, IFileMimeTyped, UserSe
  * @param sourceAuthentication Credentials for the request to the source
  * @param destinationItemId Id of item to receive copy of resource/metadata/thumbnail
  * @param destinationAuthentication Credentials for the request to the storage
- * @return A promise which resolves to the result of the copy
+ * @returns A promise which resolves to the result of the copy
  */
 export declare function copyDataIntoItem(fileInfo: IAssociatedFileInfo, sourceAuthentication: UserSession, destinationItemId: string, destinationAuthentication: UserSession): Promise<IAssociatedFileCopyResults>;
 /**
  * Creates a file with a specified mime type.
  *
  * @param fileDescription Structure containing a file and the desired mime type
- * @return Created file
+ * @returns Created file
  */
 export declare function createMimeTypedFile(fileDescription: IFileMimeTyped): File;

package/dist/umd/resources/copyMetadataIntoItem.d.ts

@@ -21,6 +21,6 @@ import { IAssociatedFileCopyResults, IAssociatedFileInfo, UserSession } from "..
  * @param sourceAuthentication Credentials for the request to the source
  * @param destinationItemId Id of item to receive copy of resource/metadata/thumbnail
  * @param destinationAuthentication Credentials for the request to the storage
- * @return A promise which resolves to the result of the copy
+ * @returns A promise which resolves to the result of the copy
  */
 export declare function copyMetadataIntoItem(fileInfo: IAssociatedFileInfo, sourceAuthentication: UserSession, destinationItemId: string, destinationAuthentication: UserSession): Promise<IAssociatedFileCopyResults>;

package/dist/umd/resources/copyResourceIntoZip.d.ts

@@ -19,7 +19,7 @@ import { IAssociatedFileCopyResults, IAssociatedFileInfo, ISourceFile, IZipInfo,
  *
  * @param file Information about the source and destination of the file such as its URL, folder, filename
  * @param zipInfo Information about a zipfile such as its name and its zip object
- * @return The result of the copy
+ * @returns The result of the copy
  */
 export declare function copyResourceIntoZip(file: ISourceFile, zipInfo: IZipInfo): IAssociatedFileCopyResults;
 /**
@@ -28,6 +28,6 @@ export declare function copyResourceIntoZip(file: ISourceFile, zipInfo: IZipInfo
  * @param fileInfo Information about the source and destination of the file such as its URL, folder, filename
  * @param sourceAuthentication Credentials for the request to the source
  * @param zipInfo Information about a zipfile such as its name and its zip object
- * @return A promise which resolves to the result of the copy
+ * @returns A promise which resolves to the result of the copy
  */
 export declare function copyResourceIntoZipFromInfo(fileInfo: IAssociatedFileInfo, sourceAuthentication: UserSession, zipInfo: IZipInfo): Promise<IAssociatedFileCopyResults>;

package/dist/umd/resources/copyZipIntoItem.d.ts

@@ -20,6 +20,6 @@ import { IZipCopyResults, IZipInfo, UserSession } from "../interfaces";
  * @param zipInfo Information about a zipfile such as its name and its zip object
  * @param destinationItemId Id of item to receive copy of resource/metadata/thumbnail
  * @param destinationAuthentication Credentials for the request to the storage
- * @return A promise which resolves to the result of the copy
+ * @returns A promise which resolves to the result of the copy
  */
 export declare function copyZipIntoItem(zipInfo: IZipInfo, destinationItemId: string, destinationAuthentication: UserSession): Promise<IZipCopyResults>;

package/dist/umd/resources/createCopyResults.d.ts

@@ -20,6 +20,6 @@ import { IAssociatedFileCopyResults, IZipCopyResults } from "../interfaces";
  * @param fileInfo Info about item that was to be copied
  * @param fetchedFromSource Status of fetching item from source
  * @param copiedToDestination Status of copying item to destination
- * @return IAssociatedFileCopyResults object
+ * @returns IAssociatedFileCopyResults object
  */
 export declare function createCopyResults(fileInfo: any, fetchedFromSource: boolean, copiedToDestination?: boolean): IAssociatedFileCopyResults | IZipCopyResults;

package/dist/umd/resources/get-blob.d.ts

@@ -21,6 +21,6 @@ import { IRequestOptions } from "@esri/arcgis-rest-request";
  * @param url Address of Blob
  * @param authentication Credentials for the request
  * @param requestOptions - Options for the request, including parameters relevant to the endpoint.
- * @return Promise that will resolve with Blob or an AGO-style JSON failure response
+ * @returns Promise that will resolve with Blob or an AGO-style JSON failure response
  */
 export declare function getBlob(url: string, authentication: UserSession, requestOptions?: IRequestOptions): Promise<Blob>;

package/dist/umd/resources/getItemResourcesFilesFromPaths.d.ts

@@ -19,6 +19,6 @@ import { ISourceFile, ISourceFileCopyPath, UserSession } from "../interfaces";
  *
  * @param resourceItemFilePaths Paths to resources in source
  * @param authentication Credentials for the request to the source
- * @return A promise which resolves with an array of resource files
+ * @returns A promise which resolves with an array of resource files
  */
 export declare function getItemResourcesFilesFromPaths(resourceItemFilePaths: ISourceFileCopyPath[], authentication: UserSession): Promise<ISourceFile[]>;

package/dist/umd/resources/getItemResourcesPaths.d.ts

@@ -21,6 +21,6 @@ import { IItemTemplate, ISourceFileCopyPath, UserSession } from "../interfaces";
  * @param solutionItemId item id for the solution
  * @param authentication Credentials for the request to the storage
  * @param storageVersion Version of the Solution template
- * @return A promise which resolves with an array of paths to resources for the item
+ * @returns A promise which resolves with an array of paths to resources for the item
  */
 export declare function getItemResourcesPaths(itemTemplate: IItemTemplate, solutionItemId: string, authentication: UserSession, storageVersion?: number): Promise<ISourceFileCopyPath[]>;

package/dist/umd/resources/transform-resource-paths-to-solution-resources.d.ts

@@ -32,6 +32,7 @@ export declare function transformResourcePathToSolutionResource(resourcePath: st
  * Convert a resource path to a SolutionResourceType
  *
  * @param resourcePath String
+ * @private
  */
 export declare function _getSolutionResourceTypeFromResourcePath(resourcePath: string): SolutionResourceType;
 /**