@esri/solution-common 6.1.3 → 6.1.5

package/dist/cjs/interfaces.js

@@ -0,0 +1,72 @@
+"use strict";
+/** @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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SItemProgressStatus = exports.EItemProgressStatus = exports.SFileType = exports.EFileType = exports.UNREACHABLE = exports.DeployedSolutionFormatVersion = exports.SolutionTemplateFormatVersion = void 0;
+//#endregion ---------------------------------------------------------------------------------------------------------//
+exports.SolutionTemplateFormatVersion = 1;
+exports.DeployedSolutionFormatVersion = 1;
+exports.UNREACHABLE = "unreachable";
+//#region Enums ------------------------------------------------------------------------------------------------------//
+/**
+ * Flags for storing an item's binary resources.
+ */
+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 || (exports.EFileType = EFileType = {}));
+/**
+ * Text versions of flags for storing an item's binary resources.
+ */
+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 || (exports.SFileType = SFileType = {}));
+/**
+ * Flags for reporting the status of creating or deploying an item.
+ */
+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 || (exports.EItemProgressStatus = EItemProgressStatus = {}));
+/**
+ * Text versions of flags for reporting the status of creating or deploying an item.
+ */
+exports.SItemProgressStatus = [
+    "1 Started",
+    "2 Created",
+    "3 Cancelled",
+    "3 Finished",
+    "3 Ignored",
+    "3 Failed",
+    "Unknown",
+];
+//#endregion ---------------------------------------------------------------------------------------------------------//
+//# sourceMappingURL=interfaces.js.map

package/dist/cjs/interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../src/interfaces.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAoBH,wHAAwH;AAE3G,QAAA,6BAA6B,GAAG,CAAC,CAAC;AAClC,QAAA,6BAA6B,GAAG,CAAC,CAAC;AAClC,QAAA,WAAW,GAAG,aAAa,CAAC;AAEzC,wHAAwH;AAExH;;GAEG;AACH,IAAY,SAMX;AAND,WAAY,SAAS;IACnB,yCAAI,CAAA;IACJ,yCAAI,CAAA;IACJ,iDAAQ,CAAA;IACR,iDAAQ,CAAA;IACR,mDAAS,CAAA;AACX,CAAC,EANW,SAAS,yBAAT,SAAS,QAMpB;AAED;;GAEG;AACH,IAAY,SAMX;AAND,WAAY,SAAS;IACnB,yCAAM,CAAA;IACN,yCAAM,CAAA;IACN,iDAAU,CAAA;IACV,iDAAU,CAAA;IACV,mDAAW,CAAA;AACb,CAAC,EANW,SAAS,yBAAT,SAAS,QAMpB;AAED;;GAEG;AACH,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,mCAAnB,mBAAmB,QAQ9B;AAED;;GAEG;AACU,QAAA,mBAAmB,GAAG;IACjC,WAAW;IACX,WAAW;IACX,aAAa;IACb,YAAY;IACZ,WAAW;IACX,UAAU;IACV,SAAS;CACV,CAAC;AAgoDF,wHAAwH"}

package/dist/cjs/item-reuse.d.ts

@@ -0,0 +1,140 @@
+/** @license
+ * Copyright 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.
+ *
+ * @module item-reuse
+ */
+import { IItem, ISearchResult, UserSession } from "./arcgisRestJS";
+export interface ISourceItem {
+    /**
+     * The key is the id of the item as it is within the solution template that will be deployed
+     */
+    [key: string]: IReuseItem;
+}
+/**
+ * Object that contains key details for items that could be leveraged for reuse
+ */
+export interface IReuseItem {
+    /**
+     * The key is the id of the item as it is within the solution template that will be deployed
+     */
+    [key: string]: IReuseItemInfo;
+}
+/**
+ * Object that contains key details for an item that could be leveraged for reuse
+ */
+export interface IReuseItemInfo {
+    /**
+     *  The date/time the item was created
+     */
+    created: number;
+    /**
+     * A collection of key details from solutions that leverage this item
+     */
+    solutions: IReuseSolutions;
+    /**
+     * The title of the item that is already deployed
+     */
+    title: string;
+    /**
+     * The type of item that is already deployed
+     */
+    type: string;
+}
+/**
+ * A collection of key details from a solutions that leverage one or more reuse items
+ */
+export interface IReuseSolutions {
+    /**
+     * A collection of key details from a solution that leverages one or more reuse items
+     * The key is the id of the deployed solution.
+     */
+    [key: string]: IReuseSolution;
+}
+/**
+ * A collection of key details from a solution that leverages one or more reuse items
+ */
+export interface IReuseSolution {
+    /**
+     * The date/time the solution was created
+     */
+    created: number;
+    /**
+     * The title of the solution is already deployed
+     */
+    title: string;
+}
+/**
+ * Collection of key details about one or more solutions
+ */
+export interface ISolutionInfos {
+    /**
+     * Key details about a solution
+     * The key value is the solutions item id
+     */
+    [key: string]: ISolutionInfo;
+}
+/**
+ * Key details about a solution
+ */
+export interface ISolutionInfo {
+    /**
+     * Array of template ids from the solution
+     */
+    templates: string[];
+    /**
+     * A collection of key details from a solution that leverages one or more reuse items
+     */
+    solutionInfo: IReuseSolution;
+}
+/**
+ * Find all deployed solutions and their items from the current org for the current user
+ *
+ * @param authentication Credentials for the request
+ */
+export declare function getDeployedSolutionsAndItems(authentication: UserSession): Promise<ISolutionInfos>;
+/**
+ * Find all deployed solutions from the current org for the current user
+ *
+ * @param authentication Credentials for the request
+ */
+export declare function getDeployedSolutions(authentication: UserSession): Promise<ISearchResult<IItem>>;
+/**
+ * Find key details for the items from each of the deployed solutions
+ *
+ * @param authentication Credentials for the request
+ * @param searchResults key details of the deployed solutions
+ */
+export declare function getSolutionItemsFromDeployedSolutions(authentication: UserSession, searchResults: ISearchResult<IItem>): Promise<ISolutionInfos>;
+/**
+ * Get the ids for each template in a solution
+ *
+ * @param authentication Credentials for the request
+ */
+export declare function getIdsFromSolutionTemplates(id: string, authentication: UserSession): Promise<string[]>;
+/**
+ * Fetch key details for the solution that will be deployed and find any solutions
+ * that leverage any of the source items that exist in the solution to be deployed.
+ *
+ * @param id The id of the solution that will be deployed
+ * @param authentication Credentials for the request
+ */
+export declare function findReusableSolutionsAndItems(id: string, authentication: UserSession): Promise<ISourceItem>;
+/**
+ * Fetch key details for the solution that will be deployed
+ *
+ * @param id The id of the solution that will be deployed
+ * @param authentication Credentials for the request
+ */
+export declare function getItemHash(id: string, authentication: UserSession): Promise<ISourceItem>;

package/dist/cjs/item-reuse.js

@@ -0,0 +1,176 @@
+"use strict";
+/** @license
+ * Copyright 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.
+ *
+ * @module item-reuse
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getItemHash = exports.findReusableSolutionsAndItems = exports.getIdsFromSolutionTemplates = exports.getSolutionItemsFromDeployedSolutions = exports.getDeployedSolutions = exports.getDeployedSolutionsAndItems = void 0;
+const arcgisRestJS_1 = require("./arcgisRestJS");
+/**
+ * Find all deployed solutions and their items from the current org for the current user
+ *
+ * @param authentication Credentials for the request
+ */
+function getDeployedSolutionsAndItems(authentication) {
+    return getDeployedSolutions(authentication).then((searchResults) => {
+        return getSolutionItemsFromDeployedSolutions(authentication, searchResults);
+    });
+}
+exports.getDeployedSolutionsAndItems = getDeployedSolutionsAndItems;
+/**
+ * Find all deployed solutions from the current org for the current user
+ *
+ * @param authentication Credentials for the request
+ */
+function getDeployedSolutions(authentication) {
+    const query = new arcgisRestJS_1.SearchQueryBuilder()
+        .match(authentication.username)
+        .in("owner")
+        .and()
+        .match("Solution")
+        .in("type")
+        .and()
+        .match("Deployed")
+        .in("typekeywords");
+    return (0, arcgisRestJS_1.restSearchItems)({
+        q: query,
+        num: 100,
+        authentication,
+    }).then((searchResponse) => {
+        // Sort the results by title and then id
+        searchResponse.results.sort((e1, e2) => {
+            if (e1.title !== e2.title) {
+                return e1.title < e2.title ? -1 : 1;
+            }
+            else {
+                return e1.id < e2.id ? -1 : 1;
+            }
+        });
+        return searchResponse;
+    });
+}
+exports.getDeployedSolutions = getDeployedSolutions;
+/**
+ * Find key details for the items from each of the deployed solutions
+ *
+ * @param authentication Credentials for the request
+ * @param searchResults key details of the deployed solutions
+ */
+function getSolutionItemsFromDeployedSolutions(authentication, searchResults) {
+    const promises = [];
+    const itemIds = [];
+    const solutions = {};
+    if (searchResults.results.length > 0) {
+        searchResults.results.forEach((r) => {
+            const versionKeywords = r.typeKeywords.filter((v) => /solutionversion-.+/.exec(v));
+            const version = versionKeywords.length > 0 ? versionKeywords[0] : "";
+            itemIds.push(r.id);
+            solutions[r.id] = {
+                created: r.created,
+                title: r.title,
+                version,
+            };
+            promises.push((0, arcgisRestJS_1.getItemData)(r.id, { authentication }));
+        });
+    }
+    return Promise.all(promises).then((results) => {
+        return results.reduce((prev, cur, i) => {
+            const id = itemIds[i];
+            prev[id] = {
+                templates: cur.templates.map((template) => template.itemId),
+                solutionInfo: solutions[id],
+            };
+            return prev;
+        }, {});
+    });
+}
+exports.getSolutionItemsFromDeployedSolutions = getSolutionItemsFromDeployedSolutions;
+/**
+ * Get the ids for each template in a solution
+ *
+ * @param authentication Credentials for the request
+ */
+function getIdsFromSolutionTemplates(id, authentication) {
+    return (0, arcgisRestJS_1.getItemData)(id, { authentication }).then((data) => {
+        return data.templates.map((t) => t.itemId);
+    });
+}
+exports.getIdsFromSolutionTemplates = getIdsFromSolutionTemplates;
+/**
+ * Fetch key details for the solution that will be deployed and find any solutions
+ * that leverage any of the source items that exist in the solution to be deployed.
+ *
+ * @param id The id of the solution that will be deployed
+ * @param authentication Credentials for the request
+ */
+function findReusableSolutionsAndItems(id, authentication) {
+    return getItemHash(id, authentication).then((itemHash) => {
+        return getDeployedSolutionsAndItems(authentication).then((results) => {
+            const sourceIds = Object.keys(itemHash);
+            Object.keys(results).forEach((solutionId) => {
+                const solution = results[solutionId];
+                sourceIds.forEach((sourceId) => {
+                    const itemKeys = Object.keys(itemHash[sourceId]);
+                    itemKeys.forEach((deployedId) => {
+                        const item = itemHash[sourceId][deployedId];
+                        if (solution.templates.indexOf(deployedId) > -1 && Object.keys(item.solutions).indexOf(solutionId) < 0) {
+                            item.solutions[solutionId] = solution.solutionInfo;
+                        }
+                    });
+                });
+            });
+            return itemHash;
+        });
+    });
+}
+exports.findReusableSolutionsAndItems = findReusableSolutionsAndItems;
+/**
+ * Fetch key details for the solution that will be deployed
+ *
+ * @param id The id of the solution that will be deployed
+ * @param authentication Credentials for the request
+ */
+function getItemHash(id, authentication) {
+    return getIdsFromSolutionTemplates(id, authentication).then((ids) => {
+        // search for existing items that reference any of these ids in their typeKeywords
+        const promises = ids.map((id) => {
+            const q = `typekeywords:source-${id} owner:${authentication.username}`;
+            const searchOptions = {
+                q,
+                authentication,
+            };
+            return (0, arcgisRestJS_1.restSearchItems)(searchOptions);
+        });
+        return Promise.all(promises).then((results) => {
+            // if we have a result from the typeKeyword search we need to understand what solution it came from and what its id is
+            return results.reduce((prev, cur, i) => {
+                // key is source id and value is any ids for items that were deployed based on this source
+                prev[ids[i]] = cur.results.reduce((prev, cur) => {
+                    prev[cur.id] = {
+                        created: cur.created,
+                        solutions: {},
+                        title: cur.title,
+                        type: cur.type,
+                    };
+                    return prev;
+                }, {});
+                return prev;
+            }, {});
+        });
+    });
+}
+exports.getItemHash = getItemHash;
+//# sourceMappingURL=item-reuse.js.map

package/dist/cjs/item-reuse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"item-reuse.js","sourceRoot":"","sources":["../../src/item-reuse.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;GAgBG;;;AAEH,iDAAqH;AA+FrH;;;;GAIG;AACH,SAAgB,4BAA4B,CAAC,cAA2B;IACtE,OAAO,oBAAoB,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,aAAmC,EAAE,EAAE;QACvF,OAAO,qCAAqC,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;IAC9E,CAAC,CAAC,CAAC;AACL,CAAC;AAJD,oEAIC;AAED;;;;GAIG;AACH,SAAgB,oBAAoB,CAAC,cAA2B;IAC9D,MAAM,KAAK,GAAG,IAAI,iCAAkB,EAAE;SACnC,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC;SAC9B,EAAE,CAAC,OAAO,CAAC;SACX,GAAG,EAAE;SACL,KAAK,CAAC,UAAU,CAAC;SACjB,EAAE,CAAC,MAAM,CAAC;SACV,GAAG,EAAE;SACL,KAAK,CAAC,UAAU,CAAC;SACjB,EAAE,CAAC,cAAc,CAAC,CAAC;IACtB,OAAO,IAAA,8BAAe,EAAC;QACrB,CAAC,EAAE,KAAK;QACR,GAAG,EAAE,GAAG;QACR,cAAc;KACf,CAAC,CAAC,IAAI,CAAC,CAAC,cAAoC,EAAE,EAAE;QAC/C,wCAAwC;QACxC,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE;YACrC,IAAI,EAAE,CAAC,KAAK,KAAK,EAAE,CAAC,KAAK,EAAE;gBACzB,OAAO,EAAE,CAAC,KAAK,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;aACrC;iBAAM;gBACL,OAAO,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;aAC/B;QACH,CAAC,CAAC,CAAC;QACH,OAAO,cAAc,CAAC;IACxB,CAAC,CAAC,CAAC;AACL,CAAC;AAzBD,oDAyBC;AAED;;;;;GAKG;AACH,SAAgB,qCAAqC,CACnD,cAA2B,EAC3B,aAAmC;IAEnC,MAAM,QAAQ,GAAG,EAAE,CAAC;IACpB,MAAM,OAAO,GAAG,EAAE,CAAC;IACnB,MAAM,SAAS,GAAG,EAAE,CAAC;IACrB,IAAI,aAAa,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;QACpC,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YAClC,MAAM,eAAe,GAAG,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YACnF,MAAM,OAAO,GAAG,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACrE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YACnB,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG;gBAChB,OAAO,EAAE,CAAC,CAAC,OAAO;gBAClB,KAAK,EAAE,CAAC,CAAC,KAAK;gBACd,OAAO;aACR,CAAC;YACF,QAAQ,CAAC,IAAI,CAAC,IAAA,0BAAW,EAAC,CAAC,CAAC,EAAE,EAAE,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;KACJ;IAED,OAAO,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;QAC5C,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE;YACrC,MAAM,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;YACtB,IAAI,CAAC,EAAE,CAAC,GAAG;gBACT,SAAS,EAAE,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC;gBAC3D,YAAY,EAAE,SAAS,CAAC,EAAE,CAAC;aAC5B,CAAC;YACF,OAAO,IAAI,CAAC;QACd,CAAC,EAAE,EAAE,CAAC,CAAC;IACT,CAAC,CAAC,CAAC;AACL,CAAC;AA/BD,sFA+BC;AAED;;;;GAIG;AACH,SAAgB,2BAA2B,CAAC,EAAU,EAAE,cAA2B;IACjF,OAAO,IAAA,0BAAW,EAAC,EAAE,EAAE,EAAE,cAAc,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;QACvD,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;AACL,CAAC;AAJD,kEAIC;AAED;;;;;;GAMG;AACH,SAAgB,6BAA6B,CAAC,EAAU,EAAE,cAA2B;IACnF,OAAO,WAAW,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;QACvD,OAAO,4BAA4B,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;YACnE,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACxC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;gBAC1C,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;gBACrC,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;oBAC7B,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;oBACjD,QAAQ,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;wBAC9B,MAAM,IAAI,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC,UAAU,CAAC,CAAC;wBAC5C,IAAI,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;4BACtG,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,QAAQ,CAAC,YAAY,CAAC;yBACpD;oBACH,CAAC,CAAC,CAAC;gBACL,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC;QAClB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAnBD,sEAmBC;AAED;;;;;GAKG;AACH,SAAgB,WAAW,CAAC,EAAU,EAAE,cAA2B;IACjE,OAAO,2BAA2B,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE;QAClE,kFAAkF;QAClF,MAAM,QAAQ,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE;YAC9B,MAAM,CAAC,GAAG,uBAAuB,EAAE,UAAU,cAAc,CAAC,QAAQ,EAAE,CAAC;YACvE,MAAM,aAAa,GAAG;gBACpB,CAAC;gBACD,cAAc;aACf,CAAC;YACF,OAAO,IAAA,8BAAe,EAAC,aAAa,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,OAAO,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;YAC5C,sHAAsH;YACtH,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,IAAS,EAAE,GAAQ,EAAE,CAAS,EAAE,EAAE;gBACvD,0FAA0F;gBAC1F,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;oBAC9C,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG;wBACb,OAAO,EAAE,GAAG,CAAC,OAAO;wBACpB,SAAS,EAAE,EAAE;wBACb,KAAK,EAAE,GAAG,CAAC,KAAK;wBAChB,IAAI,EAAE,GAAG,CAAC,IAAI;qBACf,CAAC;oBACF,OAAO,IAAI,CAAC;gBACd,CAAC,EAAE,EAAE,CAAC,CAAC;gBACP,OAAO,IAAI,CAAC;YACd,CAAC,EAAE,EAAE,CAAC,CAAC;QACT,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AA7BD,kCA6BC"}

package/dist/cjs/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/cjs/libConnectors.js

@@ -0,0 +1,115 @@
+"use strict";
+/** @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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateHTML = exports.sanitizeURLProtocol = exports.sanitizeJSON = exports.sanitizeHTML = exports.createZip = exports.Sanitizer = void 0;
+const tslib_1 = require("tslib");
+const jszip_1 = tslib_1.__importDefault(require("jszip"));
+const generalHelpers_1 = require("./generalHelpers");
+const arcgis_html_sanitizer_1 = require("@esri/arcgis-html-sanitizer");
+var arcgis_html_sanitizer_2 = require("@esri/arcgis-html-sanitizer");
+Object.defineProperty(exports, "Sanitizer", { enumerable: true, get: function () { return arcgis_html_sanitizer_2.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
+ */
+function createZip(zipFilename, files, folder) {
+    return new Promise((resolve, reject) => {
+        const zip = new jszip_1.default();
+        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((0, generalHelpers_1.blobToFile)(content, zipFilename, "application/zip")), reject);
+    });
+}
+exports.createZip = createZip;
+/**
+ * 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
+ */
+function sanitizeHTML(html, sanitizer) {
+    if (!sanitizer) {
+        sanitizer = new arcgis_html_sanitizer_1.Sanitizer();
+    }
+    return sanitizer.sanitize(html);
+}
+exports.sanitizeHTML = sanitizeHTML;
+/**
+ * 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
+ */
+function sanitizeJSON(json, sanitizer) {
+    if (!sanitizer) {
+        sanitizer = new arcgis_html_sanitizer_1.Sanitizer();
+    }
+    return sanitizer.sanitize(json);
+}
+exports.sanitizeJSON = sanitizeJSON;
+/**
+ * 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
+ */
+function sanitizeURLProtocol(url, sanitizer) {
+    if (!sanitizer) {
+        sanitizer = new arcgis_html_sanitizer_1.Sanitizer();
+    }
+    return sanitizer.sanitizeUrl(url);
+}
+exports.sanitizeURLProtocol = sanitizeURLProtocol;
+/**
+ * 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
+ */
+function validateHTML(html, sanitizer) {
+    if (!sanitizer) {
+        sanitizer = new arcgis_html_sanitizer_1.Sanitizer();
+    }
+    return sanitizer.validate(html);
+}
+exports.validateHTML = validateHTML;
+//#endregion ---------------------------------------------------------------------------------------------------------//
+//# sourceMappingURL=libConnectors.js.map

package/dist/cjs/libConnectors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"libConnectors.js","sourceRoot":"","sources":["../../src/libConnectors.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;AACH;;GAEG;;;;AAEH,0DAA0B;AAC1B,qDAA8C;AAC9C,uEAAwD;AACxD,qEAAwD;AAA/C,kHAAA,SAAS,OAAA;AAElB,wHAAwH;AAExH;;;;;;;GAOG;AACH,SAAgB,SAAS,CAAC,WAAmB,EAAE,KAAa,EAAE,MAAe;IAC3E,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC3C,MAAM,GAAG,GAAG,IAAI,eAAK,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,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAE3E,iBAAiB;QACjB,GAAG;aACA,aAAa,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;aAC/B,IAAI,CAAC,CAAC,OAAa,EAAE,EAAE,CAAC,OAAO,CAAC,IAAA,2BAAU,EAAC,OAAO,EAAE,WAAW,EAAE,iBAAiB,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IACnG,CAAC,CAAC,CAAC;AACL,CAAC;AAhBD,8BAgBC;AAoBD;;;;;;;GAOG;AACH,SAAgB,YAAY,CAAC,IAAY,EAAE,SAAqB;IAC9D,IAAI,CAAC,SAAS,EAAE;QACd,SAAS,GAAG,IAAI,iCAAS,EAAE,CAAC;KAC7B;IAED,OAAO,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAClC,CAAC;AAND,oCAMC;AAED;;;;;;;GAOG;AACH,SAAgB,YAAY,CAAC,IAAS,EAAE,SAAqB;IAC3D,IAAI,CAAC,SAAS,EAAE;QACd,SAAS,GAAG,IAAI,iCAAS,EAAE,CAAC;KAC7B;IAED,OAAO,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAClC,CAAC;AAND,oCAMC;AAED;;;;;;;GAOG;AACH,SAAgB,mBAAmB,CAAC,GAAW,EAAE,SAAqB;IACpE,IAAI,CAAC,SAAS,EAAE;QACd,SAAS,GAAG,IAAI,iCAAS,EAAE,CAAC;KAC7B;IAED,OAAO,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;AACpC,CAAC;AAND,kDAMC;AAED;;;;;;;;GAQG;AACH,SAAgB,YAAY,CAAC,IAAY,EAAE,SAAqB;IAC9D,IAAI,CAAC,SAAS,EAAE;QACd,SAAS,GAAG,IAAI,iCAAS,EAAE,CAAC;KAC7B;IAED,OAAO,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAClC,CAAC;AAND,oCAMC;AAED,wHAAwH"}

package/dist/cjs/migrations/apply-schema.d.ts

@@ -0,0 +1,24 @@
+/** @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 { ISolutionItem } from "../interfaces";
+/**
+ * Apply the initial schema for old Hub Solutions
+ *
+ * @param model
+ * @param authentication
+ * @private
+ */
+export declare function _applySchema(model: ISolutionItem): ISolutionItem;

package/dist/cjs/migrations/apply-schema.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._applySchema = void 0;
+const hub_common_1 = require("@esri/hub-common");
+/**
+ * Apply the initial schema for old Hub Solutions
+ *
+ * @param model
+ * @param authentication
+ * @private
+ */
+function _applySchema(model) {
+    if ((0, hub_common_1.getProp)(model, "item.properties.schemaVersion") >= 1) {
+        return model;
+    }
+    const clone = (0, hub_common_1.cloneObject)(model);
+    if (!clone.item.properties) {
+        clone.item.properties = {};
+    }
+    // upgrade the schema of the Templates
+    const templates = (0, hub_common_1.getProp)(clone, "data.templates") || [];
+    clone.data.templates = templates.map((entry) => {
+        return {
+            key: entry.fieldName || entry.key,
+            type: entry.type,
+            item: entry.item,
+            data: entry.data,
+            itemId: entry.itemId || entry.fieldName || entry.key,
+            resources: entry.resources || [],
+        };
+    });
+    clone.item.properties.schemaVersion = 1;
+    return clone;
+}
+exports._applySchema = _applySchema;
+//# sourceMappingURL=apply-schema.js.map

package/dist/cjs/migrations/apply-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apply-schema.js","sourceRoot":"","sources":["../../../src/migrations/apply-schema.ts"],"names":[],"mappings":";;;AAgBA,iDAAwD;AAExD;;;;;;GAMG;AACH,SAAgB,YAAY,CAAC,KAAoB;IAC/C,IAAI,IAAA,oBAAO,EAAC,KAAK,EAAE,+BAA+B,CAAC,IAAI,CAAC,EAAE;QACxD,OAAO,KAAK,CAAC;KACd;IAED,MAAM,KAAK,GAAG,IAAA,wBAAW,EAAC,KAAK,CAAC,CAAC;IACjC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,EAAE;QAC1B,KAAK,CAAC,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;KAC5B;IAED,sCAAsC;IACtC,MAAM,SAAS,GAAG,IAAA,oBAAO,EAAC,KAAK,EAAE,gBAAgB,CAAC,IAAI,EAAE,CAAC;IACzD,KAAK,CAAC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,KAAU,EAAE,EAAE;QAClD,OAAO;YACL,GAAG,EAAE,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC,GAAG;YACjC,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,IAAI,EAAE,KAAK,CAAC,IAAwB;YACpC,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,MAAM,EAAE,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC,GAAG;YACpD,SAAS,EAAE,KAAK,CAAC,SAAS,IAAI,EAAE;SAChB,CAAC;IACrB,CAAC,CAAC,CAAC;IACH,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,aAAa,GAAG,CAAC,CAAC;IACxC,OAAO,KAAK,CAAC;AACf,CAAC;AAxBD,oCAwBC"}