@esri/solution-common 3.0.0 → 3.1.0

package/dist/umd/src/restHelpersGet.d.ts

@@ -1,288 +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 { IGroup, IItem, IPagingParams, IPortal, IRelatedItems, ItemRelationshipType, IUser, UserSession } from "./interfaces";
-import { IGetRelatedItemsResponse, IGroupCategorySchema } from "@esri/arcgis-rest-portal";
-export declare function checkJsonForError(json: any): boolean;
-export declare function getPortal(id: string, authentication: UserSession): Promise<IPortal>;
-export declare function getUser(authentication: UserSession): Promise<IUser>;
-export declare function getUsername(authentication: UserSession): Promise<string>;
-export declare function getFoldersAndGroups(authentication: UserSession): Promise<any>;
-/**
- * Gets a Blob from a web site and casts it as a file using the supplied name.
- *
- * @param url Address of Blob
- * @param filename Name to use for file
- * @param authentication Credentials for the request
- * @returns Promise that will resolve with a File, undefined if the Blob is null, or an AGO-style JSON failure response
- */
-export declare function getBlobAsFile(url: string, filename: string, authentication: UserSession, ignoreErrors?: number[], mimeType?: string): Promise<File>;
-/**
- * Gets a Blob from a web site and checks for a JSON error packet in the Blob.
- *
- * @param url Address of Blob
- * @param authentication Credentials for the request
- * @param ignoreErrors List of HTTP error codes that should be ignored
- * @returns Promise that will resolve with Blob or an AGO-REST JSON failure response
- */
-export declare function getBlobCheckForError(url: string, authentication: UserSession, ignoreErrors?: number[]): Promise<Blob>;
-/**
- * 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
- * @returns Text extracted; empty if url ends with a forward slash or has a "?" immediately after the last
- * forward slash
- */
-export declare function getFilenameFromUrl(url: string): string;
-/**
- * Gets the primary information of an AGO group.
- *
- * @param groupId Id of an group whose primary information is sought
- * @param authentication Credentials for the request to AGO
- * @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
- */
-export declare function getGroupBase(groupId: string, authentication: UserSession): Promise<IGroup>;
-/**
- * Gets the category schema set on a group.
- *
- * @param groupId Id of an group whose category schema information is sought
- * @param authentication Credentials for the request to AGO
- * @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
- */
-export declare function getGroupCategorySchema(groupId: string, authentication: UserSession): Promise<IGroupCategorySchema>;
-/**
- * Gets the ids of the dependencies (contents) of an AGO group.
- *
- * @param groupId Id of a group whose contents are sought
- * @param authentication Credentials for the request to AGO
- * @returns A promise that will resolve with list of dependent ids or an empty list
- */
-export declare function getGroupContents(groupId: string, authentication: UserSession): Promise<string[]>;
-/**
- * Gets the primary information of an AGO item.
- *
- * @param itemId Id of an item whose primary information is sought
- * @param authentication Credentials for the request to AGO
- * @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
- */
-export declare function getItemBase(itemId: string, authentication: UserSession): Promise<IItem>;
-/**
- * Gets the data information of an AGO item in its raw (Blob) form and casts it as a file using the supplied name.
- *
- * @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
- * @returns Promise that will resolve with a File, undefined if the Blob is null, or an AGO-style JSON failure response
- */
-export declare function getItemDataAsFile(itemId: string, filename: string, authentication: UserSession): Promise<File>;
-/**
- * Gets the data information of an AGO item in its JSON form.
- *
- * @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
- * @returns Promise that will resolve with JSON, or an AGO-style JSON failure response
- */
-export declare function getItemDataAsJson(itemId: string, authentication: UserSession): Promise<any>;
-/**
- * Gets the data information of an AGO item in its raw (Blob) form.
- *
- * @param itemId Id of an item whose data information is sought
- * @param authentication Credentials for the request to AGO
- * @returns A promise that will resolve with the data Blob or null if the item doesn't have a data section
- */
-export declare function getItemDataBlob(itemId: string, authentication: UserSession): Promise<Blob>;
-/**
- * Gets the URL to the data information of an AGO item in its raw (Blob) form.
- *
- * @param itemId Id of an item whose data information is sought
- * @param authentication Credentials for the request to AGO
- * @returns URL string
- */
-export declare function getItemDataBlobUrl(itemId: string, authentication: UserSession): string;
-/**
- * Gets the URL to an information item in an AGO item.
- *
- * @param itemId Id of an item whose data information is sought
- * @param authentication Credentials for the request to AGO
- * @returns URL string
- */
-export declare function getItemInfoFileUrlPrefix(itemId: string, authentication: UserSession): string;
-/**
- * Gets the metadata information of an AGO item.
- *
- * @param itemId Id of an item whose data information is sought
- * @param authentication Credentials for the request to AGO
- * @returns Promise that will resolve with `undefined` or a File containing the metadata
- */
-export declare function getItemMetadataAsFile(itemId: string, authentication: UserSession): Promise<File>;
-/**
- * Gets the metadata information of an AGO item.
- *
- * @param itemId Id of an item whose data information is sought
- * @param authentication Credentials for the request to AGO
- * @returns A promise that will resolve with the metadata Blob or null if the item doesn't have a metadata file
- */
-export declare function getItemMetadataBlob(itemId: string, authentication: UserSession): Promise<Blob>;
-/**
- * Gets the URL to the metadata information of an AGO item.
- *
- * @param itemId Id of an item whose data information is sought
- * @param authentication Credentials for the request to AGO
- * @returns URL string
- */
-export declare function getItemMetadataBlobUrl(itemId: string, authentication: UserSession): string;
-/**
- * Gets the related items of an AGO item.
- *
- * @param itemId Id of an item whose related items are sought
- * @param relationshipType Tag for relationship type, e.g., "Solution2Item"
- * @param direction Relationship direction
- * @param authentication Credentials for the request to AGO
- * @param num Number of related items to request per batch; maximum is 100
- * @returns A promise that will resolve with the list of related items
- */
-export declare function getItemRelatedItems(itemId: string, relationshipType: ItemRelationshipType | ItemRelationshipType[], direction: "forward" | "reverse", authentication: UserSession, num?: number): Promise<IGetRelatedItemsResponse>;
-/**
- * Gets all of the related items of an AGO item in the specified direction.
- *
- * @param itemId Id of an item whose related items are sought
- * @param direction
- * @param authentication Credentials for the request to AGO
- * @returns A promise that will resolve with a list of IRelatedItems
- */
-export declare function getItemRelatedItemsInSameDirection(itemId: string, direction: "forward" | "reverse", authentication: UserSession): Promise<IRelatedItems[]>;
-export declare function getItemResources(id: string, authentication: UserSession): Promise<any>;
-/**
- * Gets the resources of an AGO item.
- *
- * @param itemId Id of an item whose resources are sought
- * @param authentication Credentials for the request to AGO
- * @returns Promise that will resolve with a list of Files or an AGO-style JSON failure response
- */
-export declare function getItemResourcesFiles(itemId: string, authentication: UserSession): Promise<File[]>;
-/**
- * Gets all of the items associated with a Solution via a Solution2Item relationship.
- *
- * @param solutionItemId Id of a deployed Solution
- * @param authentication Credentials for the request
- * @returns Promise resolving to a list of detailed item information
- */
-export declare function getItemsRelatedToASolution(solutionItemId: string, authentication: UserSession): Promise<IItem[]>;
-/**
- * Gets the thumbnail of an AGO item.
- *
- * @param itemId Id of an item whose resources are sought
- * @param thumbnailUrlPart The partial name of the item's thumbnail as reported by the `thumbnail` property
- * in the item's base section
- * @param isGroup Switch indicating if the item is a group
- * @param authentication Credentials for the request to AGO
- * @returns Promise that will resolve with an image Blob or an AGO-style JSON failure response
- */
-export declare function getItemThumbnail(itemId: string, thumbnailUrlPart: string | null, isGroup: boolean, authentication: UserSession): Promise<Blob>;
-/**
- * Gets the thumbnail of an AGO item.
- *
- * @param itemId Id of an item whose resources are sought
- * @param thumbnailUrlPart The partial name of the item's thumbnail as reported by the `thumbnail` property
- * in the item's base section
- * @param isGroup Switch indicating if the item is a group
- * @param authentication Credentials for the request to AGO
- * @returns Promise that will resolve with an image Blob or an AGO-style JSON failure response
- */
-export declare function getItemThumbnailAsFile(itemId: string, thumbnailUrlPart: string | null, isGroup: boolean, authentication: UserSession): Promise<File>;
-/**
- * Gets the URL to the thumbnail of an AGO item.
- *
- * @param itemId Id of an item whose resources are sought
- * @param thumbnailUrlPart The partial name of the item's thumbnail as reported by the `thumbnail` property
- * in the item's base section
- * @param isGroup Switch indicating if the item is a group
- * @param authentication Credentials for the request to AGO
- * @returns URL string
- */
-export declare function getItemThumbnailUrl(itemId: string, thumbnailUrlPart: string, isGroup: boolean, authentication: UserSession): string;
-/**
- * Gets a JSON from a web site.
- *
- * @param url Address of JSON
- * @param authentication Credentials for the request
- * @returns Promise that will resolve with JSON
- */
-export declare function getJson(url: string, authentication?: UserSession): Promise<any>;
-/**
- * Extracts the portal sharing url from a supplied authentication.
- *
- * @param authentication Credentials for the request to AGO
- * @returns Portal sharing url to be used in API requests, defaulting to `https://www.arcgis.com/sharing/rest`
- */
-export declare function getPortalSharingUrlFromAuth(authentication: UserSession | undefined): string;
-/**
- * Extracts the portal url from a supplied authentication.
- *
- * @param authentication Credentials for the request to AGO
- * @returns Portal url to be used in API requests, defaulting to `https://www.arcgis.com`
- */
-export declare function getPortalUrlFromAuth(authentication: UserSession): string;
-/**
- * Gets the ids of all Solution items associated with an AGO item via a Solution2Item relationship.
- *
- * @param itemId Id of an AGO item to query
- * @param authentication Credentials for the request
- * @returns Promise resolving to a list of Solution item ids
- */
-export declare function getSolutionsRelatedToAnItem(itemId: string, authentication: UserSession): Promise<string[]>;
-export declare function getThumbnailFile(url: string, filename: string, authentication: UserSession): Promise<File>;
-/**
- * Fixes the types of Blobs incorrectly typed as text/plain.
- *
- * @param blob Blob to check
- * @returns Promise resolving to original Blob, unless it's originally typed as text/plain but is
- * really JSON, ZIP, or XML
- * @private
- */
-export declare function _fixTextBlobType(blob: Blob): Promise<Blob>;
-/**
- * Gets some of the ids of the dependencies (contents) of an AGO group.
- *
- * @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
- * @returns A promise that will resolve with list of dependent ids or an empty list
- * @private
- */
-export declare function _getGroupContentsTranche(groupId: string, pagingParams: IPagingParams, authentication: UserSession): Promise<string[]>;
-/**
- * Gets some of the resources of an AGO item.
- *
- * @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
- * @returns Promise that will resolve with a list of File promises or an AGO-style JSON failure response
- * @private
- */
-export declare function _getItemResourcesTranche(itemId: string, pagingParams: IPagingParams, authentication: UserSession): Promise<Array<Promise<File>>>;
-/**
- * Retrieves the default basemap for the given & basemapGalleryGroupQuery, basemapTitle
- *
- * @param {string} basemapGalleryGroupQuery The default basemap group query
- * @param {string} basemapTitle The default basemap title
- * @param {UserSession} authentication The session info
- * @returns {IItem}
- */
-export declare function getPortalDefaultBasemap(basemapGalleryGroupQuery: string, basemapTitle: string, authentication: UserSession): Promise<IItem>;

package/dist/umd/src/sharing/index.d.ts

@@ -1,16 +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.
- */
-export * from "./share-item-to-groups";

package/dist/umd/src/sharing/share-item-to-groups.d.ts

@@ -1,26 +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 { UserSession } from "../";
-/**
- * Share an item to one or more groups
- * Returns a promise for all the sharing calls
- *
- * @param groups Array of Group Ids
- * @param itemId Item Id
- * @param authentication UserSession
- * @param owner owner of the group when sharing tracking items (can be different from the deploying user)
- */
-export declare function shareItemToGroups(groupIds: string[], itemId: string, authentication: UserSession, owner?: string): Promise<any>;

package/dist/umd/src/templatization.d.ts

@@ -1,139 +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 { IItemTemplate, ISolutionItemData } from "./interfaces";
-/**
- * A parameterized server name to replace the organization URL in a Web Mapping Application's URL to
- * itself; name has to be acceptable to AGOL, otherwise it discards the URL, so substitution must be
- * made before attempting to create the item.
- *
- * @private
- */
-export declare const SERVER_NAME: string;
-/**
- * A parameterized geometry server name
- *
- * @private
- */
-export declare const GEOMETRY_SERVER_NAME: string;
-/**
- * A parameterized geocode server name
- *
- * @private
- */
-export declare const GEOCODE_SERVER_NAME: string;
-/**
- * A parameterized network analyst server name
- *
- * @private
- */
-export declare const NA_SERVER_NAME: string;
-/**
- * A parameterized network analyst server name
- *
- * @private
- */
-export declare const PRINT_SERVER_NAME: string;
-export declare const TRANSFORMS: any;
-/**
- * Wraps double brackets around the supplied term.
- *
- * @param term Term to be wrapped, e.g., SERVER_NAME's "portalBaseUrl"
- * @returns Wrapped term, e.g., "\{\{portalBaseUrl\}\}"
- */
-export declare function placeholder(term: string): string;
-export declare function createInitializedGroupTemplate(itemInfo: any): IItemTemplate;
-export declare function createInitializedItemTemplate(itemInfo: any): IItemTemplate;
-/**
- * Creates an empty template.
- *
- * @param id AGO id of item
- * @param type AGO item type; defaults to ""
- * @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
- * @returns Zero-based version number
- */
-export declare function extractSolutionVersion(itemData: ISolutionItemData): number;
-/**
- * Finds index of template by id in a list of templates.
- *
- * @param templates A collection of AGO item templates to search
- * @param id AGO id of template to find
- * @returns Offset of of matching template or -1 if not found
- * @private
- */
-export declare function findTemplateIndexInList(templates: IItemTemplate[], id: string): number;
-/**
- * Finds template by id in a list of templates.
- *
- * @param templates A collection of AGO item templates to search
- * @param id AGO id of template to find
- * @returns Matching template or null
- */
-export declare function findTemplateInList(templates: IItemTemplate[], id: string): IItemTemplate | null;
-export declare function hasUnresolvedVariables(data: any): boolean;
-export declare function getIdsInTemplatesList(templates: IItemTemplate[]): string[];
-export declare function getDefaultExtent(itemInfo: any): any;
-/**
- * Removes a template entry in a list of templates.
- *
- * @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
- * @private
- */
-export declare function removeTemplate(templates: IItemTemplate[], id: string): void;
-/**
- * Replaces symbols in a template.
- *
- * @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
- * @returns template is returned after updating it
- */
-export declare function replaceInTemplate(template: any, replacements: any): any;
-/**
- * Replaces a template entry in a list of templates.
- *
- * @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
- * @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;
-/**
- * Helper function to templatize value and make sure its converted to lowercase
- *
- * @param basePath path used to de-templatize while deploying
- * @param value to be converted to lower case for lookup while deploying
- */
-export declare function templatizeToLowerCase(basePath: string, value: string): string;
-/**
- * using each field from the datasource replace any occurances
- * of the field name with the templatized value
- * Needs to account for:
- * "NAME"
- * "NAME NAME2"
- * "NAME ASC"
- * "\{NAME\}"
- * "(NAME = value AND NAME2 = someOtherValue)"
- */
-export declare function templatizeFieldReferences(obj: any, fields: any[], basePath: string, templatizeKeys?: boolean): any;
-export declare function templatizeIds(obj: any): any;

package/dist/umd/src/trackingHelpers.d.ts

@@ -1,116 +0,0 @@
-/** @license
- * Copyright 2021 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 { IItemTemplate, UserSession } from "./interfaces";
-import { IItemUpdate } from "@esri/arcgis-rest-types";
-import { ICreateServiceParams } from "@esri/arcgis-rest-service-admin";
-/**
- * Used by deploy to evaluate if we have everything we need to deploy tracking views.
- *
- * This function will update the input templateDictionary with a boolean
- * indicating if tracking is enabled on the org and the user is an admin.
- *
- * @param portalResponse portal self response
- * @param userResponse portal user response
- * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
- * @param templates the list of IItemTemplates from the solution
- *
- * @private
- */
-export declare function setLocationTrackingEnabled(portalResponse: any, userResponse: any, templateDictionary: any, templates?: IItemTemplate[]): void;
-/**
- * Used by deploy to evaluate if we have everything we need to deploy tracking views.
- *
- * An error is thrown to prevent additional deployment work if we have Tracking items and tracking is
- * not enabled or the deployment user is not an admin in the organization.
- *
- * @param templates the list of IItemTemplates from the solution
- * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
- *
- * @private
- */
-export declare function _validateTrackingTemplates(templates: IItemTemplate[], templateDictionary: any): void;
-/**
- * Used by deploy to determine the owner of the tracking service.
- * Only one tracking service per org and all tracking views and tracking groups must be owned by the tracking service owner.
- *
- * This function will update the input templateDictionary with the owner as well as
- *  the item id for the source tracking service.
- *
- * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
- * @param authentication Credentials for the requests
- *
- * @private
- */
-export declare function getTackingServiceOwner(templateDictionary: any, authentication: UserSession): Promise<boolean>;
-/**
- * Check key properties to understand if we are dealing with a tracking template
- *
- * @param itemTemplate the template to evaluate
- * @param itemUpdate the item update to evaluate
- *
- * @private
- */
-export declare function isTrackingViewTemplate(itemTemplate?: IItemTemplate, itemUpdate?: IItemUpdate): boolean;
-/**
- * Check key properties to understand if we are dealing with a tracking group template
- *
- * @param itemTemplate the template to evaluate
- *
- * @private
- */
-export declare function isTrackingViewGroup(itemTemplate: IItemTemplate): boolean;
-/**
- * Templatize the tracker view group id and view name for location tracking views.
- * This function will update the itemTemplate that is passed in when it's a tracking view.
- *
- * @param itemTemplate Template for feature service item
- *
- * @private
- */
-export declare function templatizeTracker(itemTemplate: IItemTemplate): void;
-/**
- * Templatize the tracker view group id and view name for location tracking views.
- * This function will update the itemTemplate that is passed in when it's a tracking view.
- *
- * @param itemTemplate Template for the tracker view
- * @param path the path to the property that stores the current name
- * @param groupId the id of the associated tracker group
- * @param groupIdVar the variable to replace the existing name with
- *
- * @private
- */
-export declare function _setName(itemTemplate: IItemTemplate, path: string, groupId: string, groupIdVar: string): void;
-/**
- * Templatize the tracker view serviceItemId
- *
- * This function will update the input obj with the templatized variable
- *
- * @param obj the object that stores the serviceItemId
- * @param path the path to the property that stores the serviceItemId
- *
- * @private
- */
-export declare function templatizeServiceItemId(obj: any, path: string): void;
-/**
- * Used by deploy to update the request options with key details for deploying tracker views
- *
- * @param itemTemplate Template for feature service item
- * @param options the current request options to update
- * @param templateDictionary Hash of facts: org URL, adlib replacements, deferreds for dependencies
- *
- * @private
- */
-export declare function setTrackingOptions(itemTemplate: IItemTemplate, options: any, templateDictionary: any): ICreateServiceParams;

package/dist/umd/src/velocityHelpers.d.ts

@@ -1,57 +0,0 @@
-/** @license
- * Copyright 2021 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 { UserSession } from "./interfaces";
-export declare const BASE_NAMES: string[];
-export declare const PROP_NAMES: string[];
-/**
- * Get the base velocity url from the current orgs subscription info
- *
- * This function will update the input templateDictionary arg with the velocity url
- * so we can reuse it without pinging the org again for subsequent requests to the
- * velocity api.
- *
- * @param authentication Credentials for the requests
- * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
- *
- * @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>;
-/**
- * Update any velocity urls found in the data
- *
- * This function can be extended to support any item type specific functions such as
- * removing the itemId from operational layers in a webmap
- *
- * @param data The data object of the item
- * @param type The item type
- * @param templateDictionary Hash of facts: folder id, org URL, adlib replacements
- *
- * @returns an updated instance of the data object that was supplied.
- *
- */
-export declare function updateVelocityReferences(data: any, type: string, templateDictionary: any): any;
-/**
- * Helper function to update velocity urls found in the data
- *
- *
- * @param data The data object of the item
- * @param velocityUrl The velocity url from the current organization
- *
- * @returns an updated instance of the data object that was supplied.
- * @private
- */
-export declare function _replaceVelocityUrls(data: any, velocityUrl: string): any;