@esri/solution-common 1.3.10 → 1.3.13

package/dist/esm/interfaces.d.ts

@@ -26,7 +26,7 @@ import JSZip from "jszip";
 export declare const SolutionTemplateFormatVersion = 1;
 export declare const DeployedSolutionFormatVersion = 1;
 /**
- * Flag for storing an item's binary resources.
+ * Flags for storing an item's binary resources.
  */
 export declare enum EFileType {
     Data = 0,
@@ -35,6 +35,9 @@ export declare enum EFileType {
     Resource = 3,
     Thumbnail = 4
 }
+/**
+ * Text versions of flags for storing an item's binary resources.
+ */
 export declare enum SFileType {
     "Data" = 0,
     "Info" = 1,
@@ -54,21 +57,96 @@ export declare enum EItemProgressStatus {
     Failed = 5,
     Unknown = 6
 }
+/**
+ * Text versions of flags for reporting the status of creating or deploying an item.
+ */
 export declare const SItemProgressStatus: string[];
-export declare type IItemProgressCallback = (itemId: string, status: EItemProgressStatus, costUsed: number, createdItemId?: string) => boolean;
-export declare type ISolutionProgressCallback = (percentDone: number, jobId?: string, progressEvent?: ISolutionProgressEvent) => void;
+/**
+ * Function signature describing internal item-level progress to enable cancellation and rollback in case of failure
+ *
+ */
+export declare type IItemProgressCallback = (
+/**
+ * Id of item
+ */
+itemId: string, 
+/**
+ * Progress status code (e.g., Started, Created,...)
+ */
+status: EItemProgressStatus, 
+/**
+ * Accumulated "costs" of task, which can be divided by the total estimated cost to get percent done
+ */
+costUsed: number, 
+/**
+ * Id of created item, which is supplied when status is EItemProgressStatus.Created or .Finished
+ */
+createdItemId?: string) => boolean;
+/**
+ * Function signature describing progress to calling programs
+ */
+export declare type ISolutionProgressCallback = (
+/**
+ * Percent of total work done
+ */
+percentDone: number, 
+/**
+ * Calling-program-supplied id, perhaps used to distinguish between concurrent deployments or deletions
+ */
+jobId?: string, 
+/**
+ * Packet of supplemental information provided from certain progress states, e.g., Finished deleting an item
+ * or deploying a Solution item
+ */
+progressEvent?: ISolutionProgressEvent) => void;
 export declare type INoArgFunction = () => any;
+/**
+ * Result of creating a unique group
+ */
 export interface IAddGroupResponse {
+    /**
+     * Success or failure
+     */
     success: boolean;
+    /**
+     * Id of created group
+     */
     group: IGroup;
 }
-export interface IAdditionalSearchOptions {
+/**
+ * Additional info to be used when searching the contents of a group
+ */
+export interface IAdditionalGroupSearchOptions {
+    /**
+     * The number of the first entry requested. The index number is 1-based.
+     */
     start?: number;
+    /**
+     * The number of results requested.
+     */
     num?: number;
+    /**
+     * Sets sort field for group items. Values: title | owner | avgrating | numviews | created | modified
+     */
     sortField?: string;
+    /**
+     * Sets sort order for group items. Values: asc | desc
+     */
     sortOrder?: string;
+    /**
+     * The bounding box for a spatial search defined as minx, miny, maxx, or maxy. Spatial search is an
+     * overlaps/intersects function of the query bbox and the extent of the document. Documents that have
+     * no extent (for example, mxds, 3dds, lyr) will not be found when doing a bbox search. Document extent
+     * is assumed to be in the WGS84 geographic coordinate system. E.g.: "-118,32,-116,34"
+     */
     bbox?: string;
+    /**
+     * A list of desired categories; maximum of 8
+     */
     categories?: string[];
+    /**
+     * Generically definines remaining/unused properties
+     */
     [key: string]: any;
 }
 /**
@@ -105,6 +183,10 @@ export interface IAssociatedFileInfo {
      */
     file?: File;
 }
+/**
+ * Describes the results of topologically sorting items to be deployed so that dependencies are created before
+ * the items that depend on them.
+ */
 export interface IBuildOrdering {
     /**
      * Item ids in order in which items are to be built.
@@ -119,14 +201,41 @@ export interface IBuildOrdering {
      */
     itemsToBePatched: IKeyedListsOfStrings;
 }
+/**
+ * Holds a complete AGO item.
+ */
 export interface ICompleteItem {
+    /**
+     * The "base" information of an item as MIME format text/plain JSON
+     */
     base: IItem;
+    /**
+     * The data section of an item as a file even though it may be JSON
+     */
     data: File;
+    /**
+     * The item's thumbnail as MIME format image/*
+     */
     thumbnail: File;
+    /**
+     * The item's metadata as MIME format application/xml
+     */
     metadata: File;
+    /**
+     * The item's resource files
+     */
     resources: File[];
+    /**
+     * list of forward relationshipType/relatedItems[] pairs
+     */
     fwdRelatedItems: IRelatedItems[];
+    /**
+     * list of reverse relationshipType/relatedItems[] pairs
+     */
     revRelatedItems: IRelatedItems[];
+    /**
+     * Additional feature-service-only info
+     */
     featureServiceProperties?: IFeatureServiceProperties;
 }
 /**
@@ -164,28 +273,85 @@ export interface ICreateItemFromTemplateResponse {
  * Options for creating a solution item.
  */
 export interface ICreateSolutionOptions {
+    /**
+     * Calling-program-supplied id, perhaps used to distinguish between concurrent deployments or deletions;
+     * default: id of group used to create Solution
+     */
     jobId?: string;
+    /**
+     * Title to be given to created Solution item; defaults: for a group, group title;
+     * for an item, random string from common.createShortId()
+     */
     title?: string;
+    /**
+     * Snippet to be given to created Solution item; defaults: for a group, group snippet; for an item, ""
+     */
     snippet?: string;
+    /**
+     * Description to be given to created Solution item; defaults: for a group, group description; for an item, ""
+     */
     description?: string;
+    /**
+     * Tags to be given to created Solution item; defaults: for a group, group tags; for an item, []
+     */
     tags?: string[];
+    /**
+     * URL to thumbnail to be given to created Solution item, but see `thumbnail` property; default: ""
+     */
     thumbnailurl?: string;
+    /**
+     * Thumbnail file to be given to created Solution item; default: null; has priority over `thumbnailurl`
+     */
     thumbnail?: File;
+    /**
+     * Folder in which to place created Solution item; default is top level
+     */
     folderId?: string;
+    /**
+     * Facts to be used for creating the Solution item; default: {}
+     */
     templateDictionary?: any;
+    /**
+     * Should fields be templatized; default: false
+     */
     templatizeFields?: boolean;
+    /**
+     * Additional typeKeywords (beyond always-added ["Solution", "Template"]) to be added to Solution item; default: []
+     */
     additionalTypeKeywords?: string[];
+    /**
+     * Packet of supplemental information provided from certain progress states, e.g., Finished deleting an item
+     * or deploying a Solution item
+     */
     progressCallback?: ISolutionProgressCallback;
+    /**
+     * Should progress be echoed to the debugging console? default: false
+     */
     consoleProgress?: boolean;
+    /**
+     * Placeholder for ids of items to be placed into Solution. DO NOT USE--it is overwritten by function createSolution
+     */
     itemIds?: string[];
+    /**
+     * Credentials for the organization with the source items; default: solution item authentication
+     */
     sourceItemAuthentication?: UserSession;
 }
 /**
  * Result of creating a solution item.
  */
 export interface ICreateSolutionResult {
+    /**
+     * Success or failure
+     */
     success: boolean;
+    /**
+     * Id of created Solution template
+     */
     solutionTemplateItemId: string;
+    /**
+     * When true items with source-itemId type keyword will be reused; default: false
+     */
     enableItemReuse?: boolean;
 }
 /**
@@ -239,8 +405,19 @@ export interface IDatasourceInfo {
  * Options for deleting a deployed solution item and all of the items that were created as part of that deployment
  */
 export interface IDeleteSolutionOptions {
+    /**
+     * Calling-program-supplied id, perhaps used to distinguish between concurrent deployments or deletions;
+     * default: id of solution being deleted
+     */
     jobId?: string;
+    /**
+     * Packet of supplemental information provided from certain progress states, e.g., Finished deleting an item
+     * or deploying a Solution item
+     */
     progressCallback?: ISolutionProgressCallback;
+    /**
+     * Should progress be echoed to the debugging console? default: false
+     */
     consoleProgress?: boolean;
 }
 /**
@@ -275,28 +452,82 @@ export interface IDeployFilename {
  * Options for deploying a solution item and for creating the solution index item representing the deployment
  */
 export interface IDeploySolutionOptions {
+    /**
+     * Calling-program-supplied id, perhaps used to distinguish between concurrent deployments or deletions;
+     * default: id of solution being deployed
+     */
     jobId?: string;
+    /**
+     * Title to be given to deployed Solution item; default: copied from solution item
+     */
     title?: string;
+    /**
+     * Snippet to be given to created Solution item; default: copied from solution item
+     */
     snippet?: string;
+    /**
+     * Description to be given to created Solution item; default: copied from solution item
+     */
     description?: string;
+    /**
+     * Tags to be given to created Solution item; default: copied from solution item
+     */
     tags?: string[];
+    /**
+     * URL to thumbnail to be given to created Solution item, but see `thumbnail` property; default: copied from
+     * solution item
+     */
     thumbnailurl?: string;
+    /**
+     * Thumbnail file to be given to created Solution item; default: null; has priority over `thumbnailurl`
+     */
     thumbnail?: File;
+    /**
+     * Facts to be used for creating the Solution item; default: {}
+     */
     templateDictionary?: any;
+    /**
+     * Additional typeKeywords (beyond always-added ["Solution", "Deployed"]) to be added to Solution item; default: []
+     */
     additionalTypeKeywords?: string[];
+    /**
+     * When true items with source-itemId type keyword will be reused; default: false
+     */
     enableItemReuse?: boolean;
+    /**
+     * Packet of supplemental information provided from certain progress states, e.g., Finished deleting an item
+     * or deploying a Solution item
+     */
     progressCallback?: ISolutionProgressCallback;
+    /**
+     * Should progress be echoed to the debugging console? default: false
+     */
     consoleProgress?: boolean;
+    /**
+     * Credentials for the organization with the source items; default: authentication supplied for deployment destination
+     */
     storageAuthentication?: UserSession;
+    /**
+     * Version of storage read from Solution item. DO NOT USE--it is overwritten by function deploySolutionFromTemplate
+     */
     storageVersion?: number;
 }
 /**
  * Result of deploying a solution item.
  */
 export interface IDeploySolutionResult {
+    /**
+     * Success or failure
+     */
     success: boolean;
+    /**
+     * Id of deployed Solution
+     */
     deployedSolutionItemId: string;
 }
+/**
+ * Contains feature-service-specific properties.
+ */
 export interface IFeatureServiceProperties {
     service: any;
     layers: any[];
@@ -311,12 +542,21 @@ export interface IFile {
     filename: string;
     blob: Blob;
 }
+/**
+ * Filename, MIME type, and data.
+ */
 export interface IFileMimeTyped {
-    blob: Blob;
     filename: string;
     mimeType: string;
+    blob: Blob;
 }
+/**
+ * Response from removing a folder.
+ */
 export interface IFolderStatusResponse {
+    /**
+     * Success or failure
+     */
     success: boolean;
     folder: {
         username: string;
@@ -324,53 +564,165 @@ export interface IFolderStatusResponse {
         title: string;
     };
 }
+/**
+ * Response from getting the items related to a specified item, extended with paging properties
+ */
 export interface IGetRelatedItemsResponse extends IPortalGetRelatedItemsResponse {
+    /**
+     * Total number of responses (from IPortalGetRelatedItemsResponse)
+     */
     total: number;
+    /**
+     * Related items (from IPortalGetRelatedItemsResponse)
+     */
+    relatedItems: IItem[];
+    /**
+     * The number of the first entry requested. The index number is 1-based.
+     */
     start: number;
+    /**
+     * The number of results requested.
+     */
     num: number;
+    /**
+     *  The 1-based index of the start of the next batch of results; value is -1 if there are no more results
+     *  to be fetched
+     */
     nextStart: number;
-    relatedItems: IItem[];
 }
+/**
+ * Response from getting the resources of a specified item, extended with paging properties
+ */
 export interface IGetResourcesResponse {
+    /**
+     * Total number of responses
+     */
     total: number;
+    /**
+     * Resources
+     */
+    resources: IResource[];
+    /**
+     * The number of the first entry requested. The index number is 1-based.
+     */
     start: number;
+    /**
+     * The number of results requested.
+     */
     num: number;
+    /**
+     *  The 1-based index of the start of the next batch of results; value is -1 if there are no more results
+     *  to be fetched
+     */
     nextStart: number;
-    resources: IResource[];
 }
+/**
+ * Response from getting the category schema set on a group.
+ *
+ * @see https://developers.arcgis.com/rest/users-groups-and-items/group-category-schema.htm
+ */
 export interface IGroupCategorySchema {
     categorySchema: IGroupCategory[];
 }
+/**
+ * Nestable category schema descripion set on a group.
+ *
+ * @see https://developers.arcgis.com/rest/users-groups-and-items/group-category-schema.htm
+ */
 export interface IGroupCategory {
+    /**
+     * Category title
+     */
     title: string;
+    /**
+     * Category description
+     */
     description?: string;
+    /**
+     * Child categories of this category
+     */
     categories?: IGroupCategory[];
 }
 /**
  * Hierarchical arrangement of items and their dependencies.
  */
 export interface IHierarchyElement {
+    /**
+     * Item id
+     */
     id: string;
+    /**
+     * Items that this item depends on
+     */
     dependencies: IHierarchyElement[];
 }
 /**
  * Subset of portal.IItem containing just the properties that are stored in a template--the item's "base" section.
  */
 export interface IItemGeneralized {
+    /**
+     * Item categories
+     */
     categories?: string[];
+    /**
+     * Specifies the locale for which content is returned.
+     */
     culture?: string;
+    /**
+     * Item description
+     */
     description?: string;
+    /**
+     * _Undocumented AGO item property_
+     */
     documentation?: string;
+    /**
+     * An array that defines the bounding rectangle of the item as [[minx, miny], [maxx, maxy]]. Should always be in WGS84.
+     */
     extent?: number[][] | string;
+    /**
+     * The unique ID for this item.
+     */
     id: string;
+    /**
+     * A JSON object that primarily applies to system requirements, Terms and Conditions, version, supported platforms,
+     * YouTube video ID, etc., associated with the application.
+     */
     properties?: any;
+    /**
+     *  A short summary description of the item.
+     */
     snippet?: string;
+    /**
+     * The coordinate system of the item.
+     */
     spatialReference?: ISpatialReference;
+    /**
+     * An array of user defined tags that describe the item.
+     */
     tags?: string[];
+    /**
+     * The title of the item. This is the name that's displayed to users and by which they refer to the item.
+     */
     title?: string;
+    /**
+     * The GIS content type of this item. Example types include Web Map, Map Service, Shapefile, and
+     * Web Mapping Application.
+     */
     type: string;
+    /**
+     * An array of keywords that further describes the type of this item. Each item is tagged with a set of
+     * type keywords that are derived based on its primary type.
+     */
     typeKeywords?: string[];
+    /**
+     * The URL for the resource represented by the item. Applies only to items that represent web-accessible
+     * resources such as map services.
+     */
     url?: string;
+    /**
+     * Generically definines remaining/unused properties
+     */
     [key: string]: any;
 }
 /**
@@ -431,9 +783,14 @@ export interface IItemTemplate {
  * Function signatures for use in a function lookup array.
  */
 export interface IItemTemplateConversions {
+    /**
+     * Converts an item into a template for use in a Solution.
+     */
     convertItemToTemplate(solutionItemId: string, itemInfo: any, destAuthentication: UserSession, srcAuthentication: UserSession, templateDictionary?: any): Promise<IItemTemplate>;
+    /**
+     * Creates an item using templatized info in a Solution.
+     */
     createItemFromTemplate(template: IItemTemplate, templateDictionary: any, destinationAuthentication: UserSession, itemProgressCallback: IItemProgressCallback): Promise<ICreateItemFromTemplateResponse>;
-    postProcessDependencies?(templates: IItemTemplate[], clonedSolutionsResponse: ICreateItemFromTemplateResponse[], authentication: UserSession, templateDictionary: any): Promise<any>;
 }
 /**
  * Structure for mapping from item type to module with type-specific template-handling code
@@ -475,10 +832,27 @@ export interface INumberValuePair {
  * Subset of a esri/portal/Portal used by this library.
  */
 export interface IPortalSubset {
+    /**
+     * Name of the organization.
+     */
     name: string;
+    /**
+     * The id of the organization that owns this portal. If null then this is the default portal
+     * for anonymous and non-organizational users.
+     */
     id: string;
+    /**
+     * The REST URL for the portal, for example "https://www.arcgis.com/sharing/rest" for ArcGIS Online
+     * and "https://www.example.com/arcgis/sharing/rest" for your in-house portal.
+     */
     restUrl: string;
+    /**
+     * The URL to the portal instance.
+     */
     portalUrl: string;
+    /**
+     * The prefix selected by the organization's administrator to be used with the custom base URL for the portal.
+     */
     urlKey: string;
 }
 /**
@@ -523,15 +897,32 @@ export interface IQuickCaptureDatasource {
  * A mapping between a relationship type and the list of item ids using that relationship.
  */
 export interface IRelatedItems {
+    /**
+     * The type of relationship between the two items.
+     *
+     * @see https://developers.arcgis.com/rest/users-groups-and-items/relationship-types.htm
+     */
     relationshipType: string;
+    /**
+     * Ids of related items
+     */
     relatedItemIds: string[];
 }
 /**
  * Summary of a resource.
  */
 export interface IResource {
+    /**
+     * Name of resource
+     */
     resource: string;
+    /**
+     * The date the resource was created. Shown in UNIX time in milliseconds.
+     */
     created: number;
+    /**
+     * The size of the resource in bytes.
+     */
     size: number;
 }
 /**
@@ -550,6 +941,9 @@ export interface ISolutionItem {
      * Supplemental information
      */
     properties?: IStringValuePair;
+    /**
+     * Generically definines remaining/unused properties
+     */
     [key: string]: any;
 }
 /**
@@ -566,23 +960,54 @@ export interface ISolutionItemData {
     templates: IItemTemplate[];
 }
 /**
- * A brief form of an item in a solution.
+ * A brief form of an item in a deployed Solution item.
  */
 export interface ISolutionItemPrecis {
+    /**
+     * The unique ID for this item.
+     */
     id: string;
+    /**
+     * The GIS content type of this item. Example types include Web Map, Map Service, Shapefile, and
+     * Web Mapping Application.
+     */
     type: string;
+    /**
+     * The title of the item. This is the name that's displayed to users and by which they refer to the item.
+     */
     title: string;
+    /**
+     * The date the item was last modified. Shown in UNIX time in milliseconds.
+     */
     modified: number;
+    /**
+     * The username of the user who owns this item.
+     */
     owner: string;
 }
 /**
- * A brief form of a solution item.
+ * A brief form of a deployed Solution item.
  */
 export interface ISolutionPrecis {
+    /**
+     * The unique ID for this Solution item.
+     */
     id: string;
+    /**
+     * The title of the item. This is the name that's displayed to users and by which they refer to the item.
+     */
     title: string;
+    /**
+     * Folder containing the deployed Solution
+     */
     folder: string;
+    /**
+     * Items contained in this solution
+     */
     items: ISolutionItemPrecis[];
+    /**
+     * Ids of groups affiliated with this solution
+     */
     groups: string[];
 }
 /**
@@ -831,6 +1256,9 @@ export interface IZipInfo {
      */
     filelist: any[];
 }
+/**
+ * Title information for Velocity data.
+ */
 export interface IVelocityTitle {
     /**
      * The current label for the object