@esri/solution-common 1.3.13 → 1.3.16

package/dist/umd/featureServiceHelpers.d.ts

@@ -19,7 +19,7 @@
  * @module featureServiceHelpers
  */
 export { queryFeatures as rest_queryFeatures, addFeatures as rest_addFeatures } from "@esri/arcgis-rest-feature-layer";
-import { IDependency, IItemTemplate, INumberValuePair, UserSession } from "./interfaces";
+import { IDependency, IFeatureServiceProperties, IItemTemplate, INumberValuePair, UserSession } from "./interfaces";
 /**
  * Templatize the ID, url, field references ect
  *
@@ -46,10 +46,18 @@ export declare function deleteViewProps(layer: any): void;
  *
  * @param layer The data layer instance with field name references within
  * @param fieldInfos the object that stores the cached field infos
- * @param isPortal Controls what properties should be removed.
  * @returns An updated instance of the fieldInfos
  */
-export declare function cacheFieldInfos(layer: any, fieldInfos: any, isPortal: boolean): any;
+export declare function cacheFieldInfos(layer: any, fieldInfos: any): any;
+/**
+ * Cache the stored contingent values so we can add them in subsequent addToDef calls
+ *
+ * @param id The layer id for the associated values to be stored with
+ * @param fieldInfos The object that stores the cached field infos
+ * @param itemTemplate The current itemTemplate being processed
+ * @returns An updated instance of the fieldInfos
+ */
+export declare function cacheContingentValues(id: string, fieldInfos: any, itemTemplate: IItemTemplate): any;
 /**
  * Helper function to cache a single property into the fieldInfos object
  * This property will be removed from the layer instance.
@@ -139,6 +147,18 @@ export declare function updateSettingsFieldInfos(itemTemplate: IItemTemplate, se
  * @private
  */
 export declare function updateTemplateForInvalidDesignations(template: IItemTemplate, authentication: UserSession): Promise<IItemTemplate>;
+/**
+ * Get the contingent values for each layer in the service.
+ * Remove key props that cannot be included with the addToDef call on deploy.
+ * Store the values alongside other key feature service properties in the template
+ *
+ * @param properties the current feature services properties
+ * @param adminUrl the current feature service url
+ * @param authentication Credentials for the request to AGOL
+ * @returns A promise that will resolve when the contingent values have been fetched.
+ * This function will update the provided properties argument when contingent values are found.
+ */
+export declare function processContingentValues(properties: IFeatureServiceProperties, adminUrl: string, authentication: UserSession): Promise<void>;
 /**
  * Replace the field name reference templates with the new field names after deployment.
  *
@@ -332,73 +352,35 @@ export declare function updateLayerFieldReferences(itemTemplate: IItemTemplate,
  */
 export declare function postProcessFields(itemTemplate: IItemTemplate, layerInfos: any, popupInfos: any, adminLayerInfos: any, templateDictionary: any): Promise<any>;
 /**
- * when deploying to portal if a view has a different typeIdField than what it being set on the source service
- *  we need to pass it via an updateDef call or it will be set as the typeIdField of the source service
- *
- * @param item current layer or table
- * @returns name of field to set for typeIdField in the update call
- * @private
- */
-export declare function _getTypeIdField(item: any): string;
-/**
- * Update a views field visibility to match that of the source
- *  Fields that are marked as visible false on a view are all set to
- *  visible true when added with the layer definition
+ * View field domain, alias, editable, and visible props can contain
+ * different values from the source.
  *
- * @param fieldInfo current layers or tables fieldInfo
- * @returns Array of fields that should not be visible in the view
- * @private
- */
-export declare function _getFieldVisibilityUpdates(fieldInfo: any): any[];
-/**
- *  view field domains can contain different values than the source feature service field domains
- *  use the cached domain when it differs from the source view field domain
+ * We need to check and set isFieldOverride to true when this occurs and false when it does not
  *
  * @param fieldInfo current view layer or table fieldInfo
- * @param fieldUpdates any existing field updates
- * @returns Array of fields to be updated
- * @private
- */
-export declare function _validateDomains(fieldInfo: any, fieldUpdates: any[]): any[];
-/**
- *  Get portal field updates to be added with an updateDefinition call after the
- * initial addToDef
+ * @param item that stores the view fields
  *
- * @param field the current field instance
- * @param names the alias of domain field names
- * @param fields the alias or domain fields
- * @param key the field key to evaluate
- * @param fieldUpdates any existing field updates
- * @private
- */
-export declare function _getPortalViewFieldUpdates(field: any, names: string[], fields: any[], key: string, fieldUpdates: any[]): void;
-/**
- *  view field domains can contain different values than the source feature service field domains
- *  use the cached domain when it differs from the source view field domain
- *
- * @param fieldInfo current view layer or table fieldInfo
- * @param fieldUpdates any existing field updates
- * @returns Array of fields to be updated
+ * This function will update the item that is provided
  * @private
  */
-export declare function _validateViewDomainsAndAlias(fieldInfo: any, item: any): void;
+export declare function _validateViewFieldInfos(fieldInfo: any, item: any): void;
 /**
- *  Get array of domain fields and names and alias fields and names
+ *  Get arrays of fields and names for domain, alias, and editable props
  *
  * @param fieldInfo current view layer or table fieldInfo
  * @private
  */
-export declare function _getDomainAndAliasInfos(fieldInfo: any): any;
+export declare function _getViewFieldInfos(fieldInfo: any): any;
 /**
  * Set isViewOverride for view fields when they have differences from the source FS field
  *
  * @param field the field instance we are testing
  * @param names array of field names
- * @param fields array of fields
+ * @param vals array of values
  * @param key the field key to compare
  * @private
  */
-export declare function _isViewFieldOverride(field: any, names: string[], fields: any[], key: string): void;
+export declare function _isViewFieldOverride(field: any, names: string[], vals: any[], key: string): void;
 /**
  * Add popup info back to the layer item
  *

package/dist/umd/interfaces.d.ts

@@ -533,6 +533,7 @@ export interface IFeatureServiceProperties {
     layers: any[];
     tables: any[];
     workforceInfos?: any;
+    contingentValues?: any;
 }
 /**
  * File folder, filename, and data.

package/dist/umd/restHelpers.d.ts

@@ -217,18 +217,6 @@ export declare function getLayerUpdates(args: IPostProcessArgs, isPortal: boolea
  * @private
  */
 export declare function _sortRelationships(layers: any[], tables: any[], relUpdates: any): any[];
-/**
- * Update view service when sourceSchemaChangesAllowed is true.
- *
- * This property needs to be set after the fact when deploying to portal as it does not honor
- *  when set during service creation.
- *
- * @param itemTemplate Template of item being deployed
- * @param authentication Credentials for the request
- * @param updates An array of update instructions
- * @returns An array of update instructions
- */
-export declare function getFinalServiceUpdates(itemTemplate: IItemTemplate, authentication: UserSession, updates: IUpdate[]): IUpdate[];
 /**
  * Add additional options to a layers definition
  *
@@ -527,6 +515,14 @@ export declare function _getFallbackExtent(serviceInfo: any, templateDictionary:
  * @private
  */
 export declare function _getRelationshipUpdates(args: IPostProcessArgs): any;
+/**
+ * Get the stored contingent values and structure them to be added to the services layers.
+ *
+ * @param args The IPostProcessArgs for the request(s)
+ * @returns Any contingent values that should be added to the service.
+ * @private
+ */
+export declare function _getContingentValuesUpdates(args: IPostProcessArgs): any;
 /**
  * Get refresh, add, update, or delete definition info
  *
@@ -539,6 +535,15 @@ export declare function _getRelationshipUpdates(args: IPostProcessArgs): any;
  * @private
  */
 export declare function _getUpdate(url: string, id: any, obj: any, args: any, type: "delete" | "update" | "add" | "refresh"): IUpdate;
+/**
+ * Changes just the domain part of a URL to lowercase.
+ *
+ * @param url URL to modify
+ * @return Adjusted URL
+ * @see From `getServerRootUrl` in arcgis-rest-js' ArcGISIdentityManager.ts
+ * @private
+ */
+export declare function _lowercaseDomain(url: string): string;
 /**
  * Checks the two main parts of an item for unresolved variables and reports any found.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/solution-common",
-  "version": "1.3.13",
+  "version": "1.3.16",
   "description": "Provides general helper functions for @esri/solution.js.",
   "main": "dist/node/index.js",
   "unpkg": "dist/umd/common.umd.min.js",
@@ -23,7 +23,7 @@
     "@esri/hub-sites": "9.29.0",
     "@esri/hub-teams": "9.29.0",
     "@types/adlib": "^3.0.1",
-    "rollup": "2.70.2"
+    "rollup": "2.66.1"
   },
   "peerDependencies": {
     "@esri/arcgis-rest-auth": "3.4.3",
@@ -96,5 +96,5 @@
     "esri",
     "ES6"
   ],
-  "gitHead": "ee404319048f8e0323933d69c4eb5bbf33c438ec"
+  "gitHead": "c87f04e58c80558f19a6d79086b69a965b17db93"
 }