@esri/solution-simple-types 3.0.0 → 3.1.0

package/dist/umd/simple-types/src/webmap.d.ts

@@ -1,101 +0,0 @@
-/** @license
- * Copyright 2018 Esri
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import * as common from "@esri/solution-common";
-/**
- * Converts an AGOL webmap item to a template.
- *
- * @param itemTemplate Template for the webmap item
- * @param destAuthentication Credentials for requests to the destination organization
- * @param srcAuthentication Credentials for requests to source items
- * @param templateDictionary Hash of key details used for variable replacement
- * @returns Template for the solution item that contains key details for item reconstruction
- */
-export declare function convertItemToTemplate(itemTemplate: common.IItemTemplate, destAuthentication: common.UserSession, srcAuthentication: common.UserSession, templateDictionary: any): Promise<common.IItemTemplate>;
-/**
- * Gets the ids of the dependencies of an AGOL webmap item.
- *
- * @param itemTemplate A webmap item whose dependencies are sought
- * @param authentication Credentials for any requests
- * @returns List of dependencies ids and url/itemId hash
- * @private
- */
-export declare function _extractDependencies(itemTemplate: common.IItemTemplate, authentication: common.UserSession): Promise<any>;
-/**
- * Remove the initialState prop from webmaps saved from the new map viewer.
- * This allows the map to use the item extent property that we templatize.
- *
- * Added for issue #662
- *
- * @param data the data for the web maps item template
- * @returns void
- * @private
- */
-export declare function _excludeInitialState(data: any): void;
-/**
- * Extracts the AGOL itemId for each layer or table object in a list using the url.
- *
- * @param layerList List of map layers or tables
- * @param dependencies Current list of dependencies
- * @param authentication Credentials for any requests
- * @returns List of dependencies ids and url/itemId hash
- * @private
- */
-export declare function _getLayerIds(layerList: any[], dependencies: string[], authentication: common.UserSession): Promise<any>;
-/**
- * Templatizes the url and item id for layers or tables within the webmap.
- *
- * @param layerList List of map layers or tables
- * @param urlHash Lookup object for analysis layers
- * @param templateDictionary Hash of key details used for variable replacement
- * @returns void
- * @private
- */
-export declare function _templatizeWebmapLayerIdsAndUrls(layerList: any[], urlHash: any, templateDictionary: any): void;
-/**
- * Templatize field references.
- *
- * @param solutionTemplate The solution item template
- * @param datasourceInfos A list of datasource info objects that contain key values to templatize field references
- * @returns The solutionTemplate with templatized field references
- */
-export declare function postProcessFieldReferences(solutionTemplate: common.IItemTemplate, datasourceInfos: common.IDatasourceInfo[]): common.IItemTemplate;
-/**
- * Templatize field references.
- *
- * @param solutionTemplate The solution item template
- * @param datasourceInfos A list of datasource info objects that contain key values to templatize field references
- * @param path A string path to the object property to templatize
- * @private
- */
-export declare function _templatizeProperty(solutionTemplate: common.IItemTemplate, datasourceInfos: common.IDatasourceInfo[], path: string): void;
-/**
- * Templatize field references.
- *
- * @param objs Can be operationalLayers or tables or appProperties search layers
- * @param datasourceInfos A list of datasource info objects that contain key values to templatize field references
- * @returns updated instances of the objects
- * @private
- */
-export declare function _templatize(objs: any[], datasourceInfos: common.IDatasourceInfo[]): any[];
-/**
- * Get datasourceInfo by map layer id
- *
- * @param obj Can be operationalLayer or table or appProperties search layer
- * @param datasourceInfos A list of datasource info objects that contain key values to templatize field references
- * @returns datasourceInfo for the given object id
- * @private
- */
-export declare function _getDatasourceInfo(obj: any, datasourceInfos: common.IDatasourceInfo[]): any;

package/dist/umd/simple-types/src/webmappingapplication.d.ts

@@ -1,176 +0,0 @@
-/** @license
- * Copyright 2020 Esri
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import * as common from "@esri/solution-common";
-/**
- * Converts a web mapping application item into a template.
- *
- * @param itemInfo Info about the item
- * @param destAuthentication Credentials for requests to the destination organization
- * @param srcAuthentication Credentials for requests to source items
- * @param templateDictionary Hash of key details used for variable replacement
- * @returns A promise that will resolve when the template has been created
- */
-export declare function convertItemToTemplate(itemTemplate: common.IItemTemplate, destAuthentication: common.UserSession, srcAuthentication: common.UserSession, templateDictionary: any): Promise<common.IItemTemplate>;
-/**
- * Converts web mapping application datasources to variables for deployment
- *
- * @param itemTemplate The solution item template
- * @param authentication Credentials for requests
- * @param portalUrl Rest Url of the portal to perform the search
- * @param templateDictionary Hash of key details used for variable replacement
- * @returns A promise that will resolve with the created template
- */
-export declare function templatizeDatasources(itemTemplate: common.IItemTemplate, authentication: common.UserSession, portalUrl: string, templateDictionary: any): Promise<common.IItemTemplate>;
-export declare function templatizeWidgets(itemTemplate: common.IItemTemplate, authentication: common.UserSession, portalUrl: string, widgetPath: string, isOnScreen?: boolean): Promise<common.IItemTemplate>;
-export declare function templatizeValues(itemTemplate: common.IItemTemplate, authentication: common.UserSession, portalUrl: string, widgetPath: string): Promise<common.IItemTemplate>;
-export declare function handleServiceRequests(serviceRequests: any[], requestUrls: string[], objString: string): Promise<string>;
-export declare function findUrls(testString: string, portalUrl: string, requestUrls: string[], serviceRequests: any[], authentication: common.UserSession): {
-    testString: string;
-    requestUrls: string[];
-    serviceRequests: any[];
-};
-/**
- * Replace url with templatized url value
- *
- * @param obj can be a single url string or a stringified JSON object
- * @param url the current url we are testing for
- * @param newUrl the templatized url
- * @param validateFullUrl should only replace url when we have a full match.
- * This property is only relevant when the obj is a stringified JSON object.
- *
- * @returns the obj with any instances of the url replaced
- */
-export declare function replaceUrl(obj: string, url: string, newUrl: string, validateFullUrl?: boolean): string;
-export declare function setValues(itemTemplate: common.IItemTemplate, paths: string[], base: string): void;
-export declare function fineTuneCreatedItem(originalTemplate: common.IItemTemplate, newlyCreatedItem: common.IItemTemplate, templateDictionary: any, destinationAuthentication: common.UserSession): Promise<void>;
-/**
- * Gets the ids of the dependencies of an AGOL webapp item.
- *
- * @param fullItem A webapp item whose dependencies are sought
- * @returns A promise that will resolve with list of dependent ids
- * @private
- */
-export declare function _extractDependencies(model: any): string[];
-/**
- * Generic Web App Dependencies
- *
- * @private
- */
-export declare function _getGenericWebAppDependencies(model: any): any;
-export declare function _getWABDependencies(model: any): string[];
-/**
- * Templatizes id properties for the paths provided
- *
- * @param itemTemplate The solution item template
- * @param paths A list of property paths that contain ids
- * @private
- */
-export declare function _templatizeIdPaths(itemTemplate: common.IItemTemplate, paths: string[]): void;
-/**
- * Templatizes id property for the path provided
- *
- * @param itemTemplate The solution item template
- * @param path A path to an id property
- * @param id The base id to use when templatizing
- * @private
- */
-export declare function _templatizeIdPath(itemTemplate: common.IItemTemplate, path: string, id: string): void;
-/**
- * Templatize field references for datasources and widgets.
- *
- * @param solutionTemplate The solution item template
- * @param datasourceInfos A list of datasource info objects that contain key values to templatize field references
- * @returns The solutionTemplate with templatized field references
- */
-export declare function postProcessFieldReferences(solutionTemplate: common.IItemTemplate, datasourceInfos: common.IDatasourceInfo[]): common.IItemTemplate;
-/**
- * Templatize field references for given dataSource from the web application.
- *
- * @param obj The dataSource or widget object from the web application.
- * @param datasourceInfos A list of datasource info objects that contain key values to templatize field references
- * @returns The dataSource with templatized field references
- * @private
- */
-export declare function _templatizeObject(obj: any, datasourceInfos: common.IDatasourceInfo[], templatizeKeys?: boolean): any;
-/**
- * Templatize field references from an array of various objects from the web application.
- *
- * @param objects A list of widgets or objects from the web application that may contain field references.
- * @param datasourceInfos A list of datasource info objects that contain key values to templatize field references
- * @returns The widgets with templatized field references
- * @private
- */
-export declare function _templatizeObjectArray(objects: any[], datasourceInfos: common.IDatasourceInfo[]): any;
-/**
- * Gets an order for testing wit the various datasource info objects against the widget or dataSource.
- * A widget or dataSource that contain a layers url or webmap layer id are more likely
- * to have field references from that layer.
- *
- * @param obj The dataSource or widget object from the web application.
- * @param datasourceInfos A list of datasource info objects that contain key values to templatize field references
- * @returns A list of datasourceInfo objects sorted based on the presence of a layers url or id
- * @private
- */
-export declare function _getReplaceOrder(obj: any, datasourceInfos: common.IDatasourceInfo[]): common.IDatasourceInfo[];
-/**
- * Determine an order for checking field names against a dataSource or widget.
- * Sort order preference is set in this order: layer url, web map layer id, service url, agol itemId
- *
- * @param datasourceInfo The datasource object with key properties about the service.
- * @param testString A stringified version of a widget or dataSource
- * @returns The prioritized order for testing
- * @private
- */
-export declare function _getSortOrder(datasourceInfo: common.IDatasourceInfo, testString: string): number;
-/**
- * These tests will run prior to the tests associated with the higher level tests based on sort order.
- * The tests work more like cloning an object where we go through and review each individual property.
- * If we find a url or webmap layer id we will templatize the parent object that contains this property.
- * Many widgets will store one of these two properties in an object that will also contain various field references.
- *
- * @param obj The dataSource or widget object from the application
- * @param datasourceInfos A list of datasource info objects that contain key values to templatize field references
- * @returns An updated instance of the dataSource or widget with as many field references templatized as possible.
- * @private
- */
-export declare function _prioritizedTests(obj: any, datasourceInfos: common.IDatasourceInfo[], templatizeKeys: boolean): any;
-/**
- * This is very close to common.cloneObject but will test if an object
- * has one of the datasource urls as a property. If it finds one it will
- * templatize it's parent based on the fields from that datasource
- *
- * @param obj The dataSource or widget object from the application
- * @param ds A datasourceInfo object to use for testing against the current dataSource or widget
- * @returns The updated instance of the object with as many field references templatized as possible
- * @private
- */
-export declare function _templatizeParentByURL(obj: {
-    [index: string]: any;
-}, ds: common.IDatasourceInfo, templatizeKeys: boolean): any;
-/**
- * This is very close to common.cloneObject but will test if an object
- * has one of the datasource webmap layer ids as a property. If it finds one it will
- * templatize it's parent based on the fields from that datasource.
- *
- * @param obj The dataSource or widget object from the application
- * @param ds A datasourceInfo object to use for testing against the current dataSource or widget
- * @param id A webmap layer id to test with.
- * @returns The updated instance of the object with as many field references templatized as possible
- * @private
- */
-export declare function _templatizeParentByWebMapLayerId(obj: {
-    [index: string]: any;
-}, ds: common.IDatasourceInfo, id: string, templatizeKeys: boolean): any;

package/dist/umd/simple-types/src/workforce.d.ts

@@ -1,34 +0,0 @@
-/** @license
- * Copyright 2018 Esri
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import * as common from "@esri/solution-common";
-/**
- * Converts an workforce item to a template.
- *
- * @param itemTemplate template for the workforce project item
- * @param destAuthentication Credentials for requests to the destination organization
- * @param srcAuthentication Credentials for requests to source items
- * @param templateDictionary Hash of key details used for variable replacement
- * @returns templatized itemTemplate
- */
-export declare function convertItemToTemplate(itemTemplate: common.IItemTemplate, destAuthentication: common.UserSession, srcAuthentication: common.UserSession, templateDictionary: any): Promise<common.IItemTemplate>;
-/**
- * Gets the current user and updates the dispatchers service
- *
- * @param newlyCreatedItem Item to be created; n.b.: this item is modified
- * @param destinationAuthentication The session used to create the new item(s)
- * @returns A promise that will resolve with { "success" === true || false }
- */
-export declare function fineTuneCreatedItem(newlyCreatedItem: common.IItemTemplate, destinationAuthentication: common.UserSession, templateDictionary: any): Promise<any>;