@esri/solution-workflow 5.2.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2017 Esri Inc.
+
+   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.

package/README.md

@@ -0,0 +1,53 @@
+[![npm status][npm-img]][npm-url]
+[![Build status][travis-img]][travis-url]
+[![gzip bundle size][gzip-img]][npm-url]
+[![Coverage status][coverage-img]][coverage-url]
+[![Apache 2.0 licensed][license-img]][license-url]
+
+[npm-img]: https://img.shields.io/npm/v/@esri/solution-workflow.svg?style=round-square&color=blue
+[npm-url]: https://www.npmjs.com/package/@esri/solution-workflow
+[travis-img]: https://img.shields.io/travis/Esri/solution.js/develop.svg
+[travis-url]: https://travis-ci.org/Esri/solution.js
+[gzip-img]: https://img.badgesize.io/https://unpkg.com/@esri/solution-storymap/dist/umd/workflow.umd.min.js?compression=gzip
+[coverage-img]: https://coveralls.io/repos/github/Esri/solution.js/badge.svg
+[coverage-url]: https://coveralls.io/github/Esri/solution.js
+[license-img]: https://img.shields.io/badge/license-Apache%202.0-blue.svg
+[license-url]: #license
+
+# @esri/solution-workflow
+
+> Manages the creation and deployment of Workflow Manager item types for [`@esri/solution-*`](https://github.com/Esri/solution.js).
+
+### [API Reference](https://esri.github.io/solution.js/api/workflow/)
+
+### Issues
+
+Found a bug or want to request a new feature? Please take a look at [previously logged issues](https://github.com/Esri/solution.js/issues); if you don't see your concern, please let us know by [submitting an issue](https://github.com/Esri/solution.js/issues/new).
+
+### [Changelog](https://github.com/Esri/solution.js/blob/develop/CHANGELOG.md)
+
+##### Versioning
+
+For transparency into the release cycle and in striving to maintain backward compatibility, @esri/solution.js is maintained under Semantic Versioning guidelines and will adhere to these rules whenever possible. For more information on SemVer, please visit <http://semver.org/>.
+
+### Contributing
+
+Esri welcomes contributions from anyone and everyone. Please see our [guidelines for contributing](CONTRIBUTING.md).
+
+### License
+
+Copyright &copy; 2024 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.
+
+A copy of the license is available in the repository's [LICENSE](./LICENSE) file.

package/dist/cjs/common/src/generalHelpers.d.ts

@@ -0,0 +1,400 @@
+/** @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.
+ */
+/**
+ * Provides general helper functions.
+ *
+ * @module generalHelpers
+ */
+import { IModel } from "@esri/hub-common";
+import { ICreateItemFromTemplateResponse, IDatasourceInfo, IItemTemplate, IStringValuePair } from "./interfaces";
+import { Sanitizer } from "./libConnectors";
+/**
+ * Returns a URL with a query parameter appended
+ *
+ * @param url URL to append to
+ * @param parameter Query parameter to append, prefixed with "?" or "&" as appropriate to what url already has
+ * @returns New URL combining url and parameter
+ */
+export declare function appendQueryParam(url: string, parameter: string): string;
+/**
+ * Extracts JSON from a Blob.
+ *
+ * @param blob Blob to use as source
+ * @returns A promise that will resolve with JSON or null
+ */
+export declare function blobToJson(blob: Blob): Promise<any>;
+/**
+ * Converts a Blob to a File.
+ *
+ * @param blob Blob to use as source
+ * @param filename Name to use for file
+ * @param mimeType MIME type to override blob's MIME type
+ * @returns File created out of Blob and filename
+ */
+export declare function blobToFile(blob: Blob, filename: string, mimeType?: string): File;
+/**
+ * Extracts text from a Blob.
+ *
+ * @param blob Blob to use as source
+ * @returns A promise that will resolve with text read from blob
+ */
+export declare function blobToText(blob: Blob): Promise<string>;
+/**
+ * Checks that a URL path ends with a slash.
+ *
+ * @param url URL to check
+ * @returns URL, appended with slash if missing
+ */
+export declare function checkUrlPathTermination(url: string): string;
+/**
+ * Converts a hub-style item into a solutions-style item, the difference being handling of resources.
+ *
+ * @param hubModel Hub-style item
+ * @return solutions-style item
+ */
+export declare function convertIModel(hubModel: IModel | undefined): IItemTemplate;
+/**
+ * Creates a random 32-character alphanumeric string.
+ *
+ * @returns A lowercase 32-char alphanumeric string
+ * @internal
+ */
+export declare function createLongId(): string;
+/**
+ * Creates a random 8-character alphanumeric string that begins with an alphabetic character.
+ *
+ * @returns An alphanumeric string in the range [a0000000..zzzzzzzz]
+ */
+export declare function createShortId(): string;
+/**
+ * Copies an input list removing duplicates.
+ *
+ * @param input List to be deduped
+ * @returns Deduped list; order of items in input is not maintained
+ */
+export declare function dedupe(input?: string[]): string[];
+/**
+ * Flags a failure to create an item from a template.
+ *
+ * @param itemType The AGO item type
+ * @param id Item id to include in response
+ * @returns Empty creation response
+ */
+export declare function generateEmptyCreationResponse(itemType: string, id?: string): ICreateItemFromTemplateResponse;
+/**
+ * Converts JSON to a Blob.
+ *
+ * @param json JSON to use as source
+ * @returns A blob from the source JSON
+ */
+export declare function jsonToBlob(json: any): Blob;
+/**
+ * Converts JSON to a File.
+ *
+ * @param json JSON to use as source
+ * @param filename Name to use for file
+ * @param mimeType MIME type to override blob's MIME type
+ * @returns File created out of JSON and filename
+ */
+export declare function jsonToFile(json: any, filename: string, mimeType?: string): File;
+/**
+ * Makes a unique copy of JSON by stringifying and parsing.
+ *
+ * @param json JSON to use as source
+ * @returns A JSON object from the source JSON
+ */
+export declare function jsonToJson(json: any): any;
+/**
+ * Saves a blob to a file.
+ *
+ * @param filename Name to give file
+ * @param blob Blob to save
+ * @returns Promise resolving when operation is complete
+ */
+export declare function saveBlobAsFile(filename: string, blob: Blob): Promise<void>;
+/**
+ * Makes a deep clone, including arrays but not functions.
+ *
+ * @param obj Object to be cloned
+ * @returns Clone of obj
+ * @example
+ * ```js
+ * import { cloneObject } from "utils/object-helpers";
+ * const original = { foo: "bar" }
+ * const copy = cloneObject(original)
+ * copy.foo // "bar"
+ * copy === original // false
+ * ```
+ */
+export declare function cloneObject(obj: {
+    [index: string]: any;
+}): any;
+/**
+ * Compares two JSON objects using JSON.stringify.
+ *
+ * @param json1 First object
+ * @param json2 Second object
+ * @returns True if objects are the same
+ */
+export declare function compareJSON(json1: any, json2: any): boolean;
+/**
+ * Compares two JSON objects using JSON.stringify, converting empty strings to nulls.
+ *
+ * @param json1 First object
+ * @param json2 Second object
+ * @returns True if objects are the same
+ */
+export declare function compareJSONNoEmptyStrings(json1: any, json2: any): boolean;
+/**
+ *  Compares two JSON objects property by property and reports each mismatch.
+ *
+ * @param json1 First object
+ * @param json2 Second object
+ * @returns A list of mismatch report strings
+ */
+export declare function compareJSONProperties(json1: any, json2: any): string[];
+/**
+ * Sanitizes JSON and echoes changes to console.
+ *
+ * @param json JSON to sanitize
+ * @param sanitizer Instance of Sanitizer class
+ * @returns Sanitized version of `json`
+ * @see https://github.com/esri/arcgis-html-sanitizer#sanitize-json
+ */
+export declare function sanitizeJSONAndReportChanges(json: any, sanitizer?: Sanitizer): any;
+export declare function deleteItemProps(itemTemplate: any): any;
+/**
+ * Deletes a property from an object.
+ *
+ * @param obj Object with property to delete
+ * @param path Path into an object to property, e.g., "data.values.webmap", where "data" is a top-level property
+ *             in obj
+ */
+export declare function deleteProp(obj: any, path: string): void;
+/**
+ * Deletes properties from an object.
+ *
+ * @param obj Object with properties to delete
+ * @param props Array of properties on object that should be deleted
+ */
+export declare function deleteProps(obj: any, props: string[]): void;
+/**
+ * Creates an AGO-style JSON failure response with success property.
+ *
+ * @param e Optional error information
+ * @returns JSON structure with property success set to false and optionally including `e`
+ */
+export declare function fail(e?: any): any;
+/**
+ * Creates an AGO-style JSON failure response with success property and extended with ids list.
+ *
+ * @param ids List of ids
+ * @param e Optional error information
+ * @returns JSON structure with property success set to false and optionally including `e`
+ */
+export declare function failWithIds(itemIds: string[], e?: any): any;
+/**
+ * Extracts subgroup ids from item tags
+ *
+ * @param tags Tags in an item
+ * @returns List of subgroup ids; subgroups are identified using tags that begin with "group." and end with a group id,
+ * e.g., "group.8d515625ee9f49d7b4f6c6cb2a389151"; non-matching tags are ignored
+ */
+export declare function getSubgroupIds(tags: string[]): string[];
+/**
+ * Extracts the ids from a string
+ *
+ * @param v String to examine
+ * @returns List of id strings found
+ * @example
+ * get id from
+ *   bad3483e025c47338d43df308c117308
+ *   {bad3483e025c47338d43df308c117308
+ *   =bad3483e025c47338d43df308c117308
+ * do not get id from
+ *   http: *something/name_bad3483e025c47338d43df308c117308
+ *   {{bad3483e025c47338d43df308c117308.itemId}}
+ *   bad3483e025c47338d43df308c117308bad3483e025c47338d43df308c117308
+ */
+export declare function getIDs(v: string): string[];
+/**
+ * Gets a property out of a deeply nested object.
+ * Does not handle anything but nested object graph
+ *
+ * @param obj Object to retrieve value from
+ * @param path Path into an object, e.g., "data.values.webmap", where "data" is a top-level property
+ *             in obj
+ * @returns Value at end of path
+ */
+export declare function getProp(obj: {
+    [index: string]: any;
+}, path: string): any;
+/**
+ * Returns an array of values from an object based on an array of property paths.
+ *
+ * @param obj Object to retrieve values from
+ * @param props Array of paths into the object e.g., "data.values.webmap", where "data" is a top-level property
+ * @returns Array of the values plucked from the object; only defined values are returned
+ */
+export declare function getProps(obj: any, props: string[]): any;
+/**
+ * Get a property out of a deeply nested object
+ * Does not handle anything but nested object graph
+ *
+ * @param obj Object to retrieve value from
+ * @param path Path into an object, e.g., "data.values.webmap", where "data" is a top-level property
+ *             in obj
+ * @param defaultV Optional value to use if any part of path--including final value--is undefined
+ * @returns Value at end of path
+ */
+export declare function getPropWithDefault(obj: IStringValuePair, path: string, defaultV?: any): any;
+/**
+ * Updates a list of the items dependencies if more are found in the
+ * provided value.
+ *
+ * @param v a string value to check for ids
+ * @param deps a list of the items dependencies
+ */
+export declare function idTest(v: any, deps: string[]): void;
+/**
+ * Sets a deeply nested property of an object.
+ * Creates the full path if it does not exist.
+ *
+ * @param obj Object to set value of
+ * @param path Path into an object, e.g., "data.values.webmap", where "data" is a top-level property in obj
+ * @param value The value to set at the end of the path
+ */
+export declare function setCreateProp(obj: any, path: string, value: any): void;
+/**
+ * Sets a deeply nested property of an object.
+ * Does nothing if the full path does not exist.
+ *
+ * @param obj Object to set value of
+ * @param path Path into an object, e.g., "data.values.webmap", where "data" is a top-level property in obj
+ * @param value The value to set at the end of the path
+ */
+export declare function setProp(obj: any, path: string, value: any): void;
+/**
+ * Creates a timestamp string using the current UTC date and time.
+ *
+ * @returns Timestamp formatted as YYYYMMDD_hhmm_ssmmm, with month one-based and all values padded with zeroes on the
+ * left as needed (`ssmmm` stands for seconds from 0..59 and milliseconds from 0..999)
+ * @private
+ */
+export declare function getUTCTimestamp(): string;
+/**
+ * Tests if an object's `item.typeKeywords` or `typeKeywords` properties has any of a set of keywords.
+ *
+ * @param jsonObj Object to test
+ * @param keywords List of keywords to look for in jsonObj
+ * @returns Boolean indicating result
+ */
+export declare function hasAnyKeyword(jsonObj: any, keywords: string[]): boolean;
+/**
+ * Tests if an object's `item.typeKeywords` or `typeKeywords` properties has a specific keyword.
+ *
+ * @param jsonObj Object to test
+ * @param keyword Keyword to look for in jsonObj
+ * @returns Boolean indicating result
+ */
+export declare function hasTypeKeyword(jsonObj: any, keyword: string): boolean;
+/**
+ * Will return the provided title if it does not exist as a property
+ * in one of the objects at the defined path. Otherwise the title will
+ * have a numerical value attached.
+ *
+ * @param title The root title to test
+ * @param templateDictionary Hash of the facts
+ * @param path to the objects to evaluate for potantial name clashes
+ * @returns string The unique title to use
+ */
+export declare function getUniqueTitle(title: string, templateDictionary: any, path: string): string;
+/**
+ * Performs string replacement on every string in an object.
+ *
+ * @param obj Object to scan and to modify
+ * @param pattern Search pattern in each string
+ * @param replacement Replacement for matches to search pattern
+ * @returns Modified obj is returned
+ */
+export declare function globalStringReplace(obj: any, pattern: RegExp, replacement: string): any;
+/**
+ * Tests if an array of DatasourceInfos has a given item and layer id already.
+ *
+ * @param datasourceInfos Array of DatasourceInfos to evaluate
+ * @param itemId The items id to check for
+ * @param layerId The layers id to check for
+ * @returns Boolean indicating result
+ */
+export declare function hasDatasource(datasourceInfos: IDatasourceInfo[], itemId: string, layerId: number): boolean;
+/**
+ * remove templatization from item id to compare
+ *
+ * @example
+ * \{\{934a9ef8efa7448fa8ddf7b13cef0240.itemId\}\}
+ * returns 934a9ef8efa7448fa8ddf7b13cef0240
+ */
+export declare function cleanItemId(id: any): any;
+/**
+ * remove templatization from layer based item id to compare
+ *
+ * @example
+ * \{\{934a9ef8efa7448fa8ddf7b13cef0240.layer0.itemId\}\}
+ * returns 934a9ef8efa7448fa8ddf7b13cef0240
+ */
+export declare function cleanLayerBasedItemId(id: any): any;
+/**
+ * remove templatization from layer id to compare
+ *
+ * @example
+ * \{\{934a9ef8efa7448fa8ddf7b13cef0240.layer0.layerId\}\}
+ * returns 0
+ */
+export declare function cleanLayerId(id: any): any;
+/**
+ * Get template from list of templates by ID
+ *
+ * @param templates Array of item templates to search
+ * @param id of template we are searching for
+ *
+ * @returns Template associated with the user provided id argument
+ */
+export declare function getTemplateById(templates: IItemTemplate[], id: string): any;
+/**
+ * Evaluates a value with a regular expression
+ *
+ * @param v a string value to test with the expression
+ * @param ex the regular expresion to test with
+ * @returns an array of matches
+ */
+export declare function regExTest(v: any, ex: RegExp): any[];
+/**
+ * Creates a random number between two values.
+ *
+ * @param min Inclusive minimum desired value
+ * @param max Non-inclusive maximum desired value
+ * @returns Random number in the range [min, max)
+ */
+export declare function _getRandomNumberInRange(min: number, max: number): number;
+/**
+ * Pads the string representation of a number to a minimum width. Requires modern browser.
+ *
+ * @param n Number to pad
+ * @param totalSize Desired *minimum* width of number after padding with zeroes
+ * @returns Number converted to string and padded on the left as needed
+ * @private
+ */
+export declare function _padPositiveNum(n: number, totalSize: number): string;