@esri/solution-workflow 5.2.0

package/dist/esm/common/src/interfaces.js

@@ -0,0 +1,72 @@
+/** @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.
+ */
+//#region Re-exports -------------------------------------------------------------------------------------------------//
+export { UserSession } from "@esri/arcgis-rest-auth";
+export { queryRelated } from "@esri/arcgis-rest-feature-layer";
+//#endregion ---------------------------------------------------------------------------------------------------------//
+export const SolutionTemplateFormatVersion = 1;
+export const DeployedSolutionFormatVersion = 1;
+export const UNREACHABLE = "unreachable";
+//#region Enums ------------------------------------------------------------------------------------------------------//
+/**
+ * Flags for storing an item's binary resources.
+ */
+export var EFileType;
+(function (EFileType) {
+    EFileType[EFileType["Data"] = 0] = "Data";
+    EFileType[EFileType["Info"] = 1] = "Info";
+    EFileType[EFileType["Metadata"] = 2] = "Metadata";
+    EFileType[EFileType["Resource"] = 3] = "Resource";
+    EFileType[EFileType["Thumbnail"] = 4] = "Thumbnail";
+})(EFileType || (EFileType = {}));
+/**
+ * Text versions of flags for storing an item's binary resources.
+ */
+export var SFileType;
+(function (SFileType) {
+    SFileType[SFileType["Data"] = 0] = "Data";
+    SFileType[SFileType["Info"] = 1] = "Info";
+    SFileType[SFileType["Metadata"] = 2] = "Metadata";
+    SFileType[SFileType["Resource"] = 3] = "Resource";
+    SFileType[SFileType["Thumbnail"] = 4] = "Thumbnail";
+})(SFileType || (SFileType = {}));
+/**
+ * Flags for reporting the status of creating or deploying an item.
+ */
+export var EItemProgressStatus;
+(function (EItemProgressStatus) {
+    EItemProgressStatus[EItemProgressStatus["Started"] = 0] = "Started";
+    EItemProgressStatus[EItemProgressStatus["Created"] = 1] = "Created";
+    EItemProgressStatus[EItemProgressStatus["Cancelled"] = 2] = "Cancelled";
+    EItemProgressStatus[EItemProgressStatus["Finished"] = 3] = "Finished";
+    EItemProgressStatus[EItemProgressStatus["Ignored"] = 4] = "Ignored";
+    EItemProgressStatus[EItemProgressStatus["Failed"] = 5] = "Failed";
+    EItemProgressStatus[EItemProgressStatus["Unknown"] = 6] = "Unknown";
+})(EItemProgressStatus || (EItemProgressStatus = {}));
+/**
+ * Text versions of flags for reporting the status of creating or deploying an item.
+ */
+export const SItemProgressStatus = [
+    "1 Started",
+    "2 Created",
+    "3 Cancelled",
+    "3 Finished",
+    "3 Ignored",
+    "3 Failed",
+    "Unknown"
+];
+//#endregion ---------------------------------------------------------------------------------------------------------//
+//# sourceMappingURL=interfaces.js.map

package/dist/esm/common/src/interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../../../../common/src/interfaces.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAeH,wHAAwH;AAExH,OAAO,EAGL,WAAW,EACZ,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAKL,YAAY,EACb,MAAM,iCAAiC,CAAC;AAsBzC,wHAAwH;AAExH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC;AAC/C,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC;AAC/C,MAAM,CAAC,MAAM,WAAW,GAAG,aAAa,CAAC;AAEzC,wHAAwH;AAExH;;GAEG;AACH,MAAM,CAAN,IAAY,SAMX;AAND,WAAY,SAAS;IACnB,yCAAI,CAAA;IACJ,yCAAI,CAAA;IACJ,iDAAQ,CAAA;IACR,iDAAQ,CAAA;IACR,mDAAS,CAAA;AACX,CAAC,EANW,SAAS,KAAT,SAAS,QAMpB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,SAMX;AAND,WAAY,SAAS;IACnB,yCAAM,CAAA;IACN,yCAAM,CAAA;IACN,iDAAU,CAAA;IACV,iDAAU,CAAA;IACV,mDAAW,CAAA;AACb,CAAC,EANW,SAAS,KAAT,SAAS,QAMpB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,mBAQX;AARD,WAAY,mBAAmB;IAC7B,mEAAO,CAAA;IACP,mEAAO,CAAA;IACP,uEAAS,CAAA;IACT,qEAAQ,CAAA;IACR,mEAAO,CAAA;IACP,iEAAM,CAAA;IACN,mEAAO,CAAA;AACT,CAAC,EARW,mBAAmB,KAAnB,mBAAmB,QAQ9B;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,WAAW;IACX,WAAW;IACX,aAAa;IACb,YAAY;IACZ,WAAW;IACX,UAAU;IACV,SAAS;CACV,CAAC;AAogDF,wHAAwH"}

package/dist/esm/common/src/libConnectors.d.ts

@@ -0,0 +1,73 @@
+/** @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.
+ */
+/**
+ * Provides connectors to third-party helper functions.
+ */
+import { Sanitizer } from "@esri/arcgis-html-sanitizer";
+export { Sanitizer } from "@esri/arcgis-html-sanitizer";
+/**
+ * Creates a zip File from a collection of Files.
+ *
+ * @param zipFilename Name to use for zip File
+ * @param files List of files to add to zip File
+ * @param folder Folder to contain the files
+ * @returns Promise resolving to a zip File
+ */
+export declare function createZip(zipFilename: string, files: File[], folder?: string): Promise<File>;
+/**
+ * Result of checking if a string contains invalid HTML.
+ */
+export interface IValidationResult {
+    isValid: boolean;
+    sanitized: string;
+}
+/**
+ * Sanitizes html.
+ *
+ * @param HTML Text to sanitize
+ * @param sanitizer Instance of Sanitizer class
+ * @returns Sanitized version of `html`
+ * @see https://github.com/esri/arcgis-html-sanitizer#basic-usage
+ */
+export declare function sanitizeHTML(html: string, sanitizer?: Sanitizer): string;
+/**
+ * Sanitizes JSON.
+ *
+ * @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 sanitizeJSON(json: any, sanitizer?: Sanitizer): any;
+/**
+ * Sanitizes the protocol in a URL.
+ *
+ * @param url URL to sanitize
+ * @param sanitizer Instance of Sanitizer class
+ * @returns Sanitized version of `url`
+ * @see https://github.com/esri/arcgis-html-sanitizer#sanitize-urls
+ */
+export declare function sanitizeURLProtocol(url: string, sanitizer?: Sanitizer): string;
+/**
+ * Checks if a string contains invalid HTML.
+ *
+ * @param html HTML to check
+ * @param sanitizer Instance of Sanitizer class
+ * @returns An object containing a flag indicating if `html` is valid (i.e., contains no invalid HTML)
+ * as well as the sanitized version of `html`
+ * @see https://github.com/esri/arcgis-html-sanitizer#basic-usage
+ */
+export declare function validateHTML(html: string, sanitizer?: Sanitizer): IValidationResult;

package/dist/esm/common/src/libConnectors.js

@@ -0,0 +1,105 @@
+/** @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.
+ */
+/**
+ * Provides connectors to third-party helper functions.
+ */
+import JSZip from "jszip";
+import { blobToFile } from "./generalHelpers";
+import { Sanitizer } from "@esri/arcgis-html-sanitizer";
+export { Sanitizer } from "@esri/arcgis-html-sanitizer";
+//#region JSZip ----------------------------------------------------------------------------------------------------- //
+/**
+ * Creates a zip File from a collection of Files.
+ *
+ * @param zipFilename Name to use for zip File
+ * @param files List of files to add to zip File
+ * @param folder Folder to contain the files
+ * @returns Promise resolving to a zip File
+ */
+export function createZip(zipFilename, files, folder) {
+    return new Promise((resolve, reject) => {
+        const zip = new JSZip();
+        let container = zip;
+        if (folder) {
+            container = zip.folder(folder);
+        }
+        // Add the files
+        files.forEach(file => container.file(file.name, file, { binary: true }));
+        // Create the ZIP
+        zip
+            .generateAsync({ type: "blob" })
+            .then((content) => resolve(blobToFile(content, zipFilename, "application/zip")), reject);
+    });
+}
+/**
+ * Sanitizes html.
+ *
+ * @param HTML Text to sanitize
+ * @param sanitizer Instance of Sanitizer class
+ * @returns Sanitized version of `html`
+ * @see https://github.com/esri/arcgis-html-sanitizer#basic-usage
+ */
+export function sanitizeHTML(html, sanitizer) {
+    if (!sanitizer) {
+        sanitizer = new Sanitizer();
+    }
+    return sanitizer.sanitize(html);
+}
+/**
+ * Sanitizes JSON.
+ *
+ * @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 function sanitizeJSON(json, sanitizer) {
+    if (!sanitizer) {
+        sanitizer = new Sanitizer();
+    }
+    return sanitizer.sanitize(json);
+}
+/**
+ * Sanitizes the protocol in a URL.
+ *
+ * @param url URL to sanitize
+ * @param sanitizer Instance of Sanitizer class
+ * @returns Sanitized version of `url`
+ * @see https://github.com/esri/arcgis-html-sanitizer#sanitize-urls
+ */
+export function sanitizeURLProtocol(url, sanitizer) {
+    if (!sanitizer) {
+        sanitizer = new Sanitizer();
+    }
+    return sanitizer.sanitizeUrl(url);
+}
+/**
+ * Checks if a string contains invalid HTML.
+ *
+ * @param html HTML to check
+ * @param sanitizer Instance of Sanitizer class
+ * @returns An object containing a flag indicating if `html` is valid (i.e., contains no invalid HTML)
+ * as well as the sanitized version of `html`
+ * @see https://github.com/esri/arcgis-html-sanitizer#basic-usage
+ */
+export function validateHTML(html, sanitizer) {
+    if (!sanitizer) {
+        sanitizer = new Sanitizer();
+    }
+    return sanitizer.validate(html);
+}
+//#endregion ---------------------------------------------------------------------------------------------------------//
+//# sourceMappingURL=libConnectors.js.map

package/dist/esm/common/src/libConnectors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"libConnectors.js","sourceRoot":"","sources":["../../../../../common/src/libConnectors.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH;;GAEG;AAEH,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AACxD,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AAExD,wHAAwH;AAExH;;;;;;;GAOG;AACH,MAAM,UAAU,SAAS,CACvB,WAAmB,EACnB,KAAa,EACb,MAAe;IAEf,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC3C,MAAM,GAAG,GAAG,IAAI,KAAK,EAAE,CAAC;QACxB,IAAI,SAAS,GAAG,GAAG,CAAC;QACpB,IAAI,MAAM,EAAE;YACV,SAAS,GAAG,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;SAChC;QAED,gBAAgB;QAChB,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAEzE,iBAAiB;QACjB,GAAG;aACA,aAAa,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;aAC/B,IAAI,CACH,CAAC,OAAa,EAAE,EAAE,CAChB,OAAO,CAAC,UAAU,CAAC,OAAO,EAAE,WAAW,EAAE,iBAAiB,CAAC,CAAC,EAC9D,MAAM,CACP,CAAC;IACN,CAAC,CAAC,CAAC;AACL,CAAC;AAoBD;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAAC,IAAY,EAAE,SAAqB;IAC9D,IAAI,CAAC,SAAS,EAAE;QACd,SAAS,GAAG,IAAI,SAAS,EAAE,CAAC;KAC7B;IAED,OAAO,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAClC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAAC,IAAS,EAAE,SAAqB;IAC3D,IAAI,CAAC,SAAS,EAAE;QACd,SAAS,GAAG,IAAI,SAAS,EAAE,CAAC;KAC7B;IAED,OAAO,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAClC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,mBAAmB,CACjC,GAAW,EACX,SAAqB;IAErB,IAAI,CAAC,SAAS,EAAE;QACd,SAAS,GAAG,IAAI,SAAS,EAAE,CAAC;KAC7B;IAED,OAAO,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;AACpC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,YAAY,CAC1B,IAAY,EACZ,SAAqB;IAErB,IAAI,CAAC,SAAS,EAAE;QACd,SAAS,GAAG,IAAI,SAAS,EAAE,CAAC;KAC7B;IAED,OAAO,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAClC,CAAC;AAED,wHAAwH"}

package/dist/esm/common/test/mocks/templates.d.ts

@@ -0,0 +1,71 @@
+/** @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 interfaces from "../../src/interfaces";
+export declare function getEmptyGeneralizedItem(): interfaces.IItemGeneralized;
+export declare function getEmptyItem(): interfaces.IItem;
+export declare function getFailedDeployment(failedItemIds?: string[]): any;
+export declare function getFailedItem(itemType: string): interfaces.ICreateItemFromTemplateResponse;
+export declare function getSolutionTemplateItem(templates?: interfaces.IItemTemplate[]): interfaces.ISolutionItem;
+export declare function getItemTemplateSkeleton(): interfaces.IItemTemplate;
+export declare function getDeployedItemTemplate(itemId: string, type: string, dependencies?: string[]): any;
+export declare function getItemTemplate(type: string, dependencies?: string[], url?: string): interfaces.IItemTemplate;
+export declare function getDashboardTemplatePartNoWidgets(): any;
+export declare function getTemplatePartNoData(type: string): any;
+export declare function getTemplatePartNoExtent(type: string): any;
+export declare function getFeatureServiceTemplatePartNoRelationships(): any;
+export declare function getGroupTemplatePart(dependencies?: string[]): any;
+export declare function getWebMappingApplicationTemplate(): interfaces.IItemTemplate[];
+export declare function getWebMappingApplicationTemplateGroup(): interfaces.IItemTemplate[];
+export declare function getWebMappingApplicationTemplateNoWebmapOrGroup(): interfaces.IItemTemplate[];
+export declare function getItemTemplateData(type: string): any;
+export declare function getItemTemplateResources(type: string, itemId: string): string[];
+export declare function getItemTemplateResourcesAsSourceFiles(type: string, itemId: string): interfaces.ISourceFile[];
+export declare function getItemTemplateResourcesAsTemplatizedFiles(type: string): interfaces.IAssociatedFileInfo[];
+export declare function removeEditFieldsInfoField(layerOrTable: any): any;
+export declare const sampleInfoRootJson: {
+    resourceInfo: string[];
+};
+export declare const sampleStylesRootJson: {
+    version: number;
+    sprite: string;
+    glyphs: string;
+    sources: {
+        esri: {
+            type: string;
+            url: string;
+            tiles: string[];
+        };
+    };
+    layers: any[];
+    metadata: {};
+};
+export declare const sampleInfoRootTemplatizedJson: {
+    resourceInfo: string[];
+};
+export declare const sampleStylesRootTemplatizedJson: {
+    version: number;
+    sprite: string;
+    glyphs: string;
+    sources: {
+        esri: {
+            type: string;
+            url: string;
+            tiles: string[];
+        };
+    };
+    layers: any[];
+    metadata: {};
+};