@esri/solution-hub-types 6.1.0-alpha.0 → 6.2.0-alpha.0

package/dist/cjs/helpers/_post-process-page.d.ts

@@ -0,0 +1,17 @@
+/** @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 { IModel, IHubUserRequestOptions } from "@esri/hub-common";
+export declare function _postProcessPage(pageModel: IModel, itemInfos: any[], templateDictionary: any, hubRequestOptions: IHubUserRequestOptions): Promise<boolean>;

package/dist/cjs/helpers/_post-process-page.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._postProcessPage = void 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.
+ */
+const hub_common_1 = require("@esri/hub-common");
+const hub_sites_1 = require("@esri/hub-sites");
+//TODO: function doc
+function _postProcessPage(pageModel, itemInfos, templateDictionary, hubRequestOptions) {
+    // re-interpolate the siteModel using the itemInfos; no patches supplied
+    pageModel = (0, hub_common_1.interpolate)(pageModel, templateDictionary, {});
+    return (0, hub_sites_1.updatePage)(pageModel, {
+        ...hubRequestOptions,
+        allowList: [],
+    }).then(() => {
+        return true;
+    });
+}
+exports._postProcessPage = _postProcessPage;
+//# sourceMappingURL=_post-process-page.js.map

package/dist/cjs/helpers/_post-process-page.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_post-process-page.js","sourceRoot":"","sources":["../../../src/helpers/_post-process-page.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;GAcG;AACH,iDAA+E;AAC/E,+CAA6C;AAE7C,oBAAoB;AACpB,SAAgB,gBAAgB,CAC9B,SAAiB,EACjB,SAAgB,EAChB,kBAAuB,EACvB,iBAAyC;IAEzC,wEAAwE;IACxE,SAAS,GAAG,IAAA,wBAAW,EAAC,SAAS,EAAE,kBAAkB,EAAE,EAAE,CAAC,CAAC;IAC3D,OAAO,IAAA,sBAAU,EAAC,SAAS,EAAE;QAC3B,GAAG,iBAAiB;QACpB,SAAS,EAAE,EAAE;KACd,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;QACX,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;AACL,CAAC;AAdD,4CAcC"}

package/dist/cjs/helpers/_post-process-site.d.ts

@@ -0,0 +1,29 @@
+/** @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 { IModel, IHubUserRequestOptions } from "@esri/hub-common";
+/**
+ * Post Process a Site
+ * - share all items to the Hub teams created as part of the site
+ * - link any created page to the site item
+ * - re-interpolate any remaining item ids that were not direct deps of the site
+ *
+ * @param siteModel
+ * @param itemInfos
+ * @param templateDictionary
+ * @param hubRequestOptions
+ * @private
+ */
+export declare function _postProcessSite(siteModel: IModel, itemInfos: any[], templateDictionary: any, hubRequestOptions: IHubUserRequestOptions): Promise<boolean>;

package/dist/cjs/helpers/_post-process-site.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._postProcessSite = void 0;
+const hub_sites_1 = require("@esri/hub-sites");
+const _update_site_pages_1 = require("./_update-site-pages");
+/**
+ * Post Process a Site
+ * - share all items to the Hub teams created as part of the site
+ * - link any created page to the site item
+ * - re-interpolate any remaining item ids that were not direct deps of the site
+ *
+ * @param siteModel
+ * @param itemInfos
+ * @param templateDictionary
+ * @param hubRequestOptions
+ * @private
+ */
+function _postProcessSite(siteModel, itemInfos, templateDictionary, hubRequestOptions) {
+    const infosWithoutSite = itemInfos.filter((info) => info.id !== siteModel.item.id);
+    // convert the itemInfo's into things that look enough like a model
+    // that we can call shareItemsToSiteGroups
+    const pseudoModels = infosWithoutSite.map((e) => {
+        return {
+            item: {
+                id: e.id,
+                type: e.type,
+            },
+        };
+    });
+    let secondPassPromises = [];
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+    secondPassPromises = secondPassPromises.concat((0, hub_sites_1.shareItemsToSiteGroups)(siteModel, pseudoModels, hubRequestOptions));
+    // we can't use that same trick w/ the page sharing
+    // because we really need the models themselves
+    // so we delegate to a local function
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+    secondPassPromises = secondPassPromises.concat((0, _update_site_pages_1._updateSitePages)(siteModel, infosWithoutSite, hubRequestOptions));
+    // need to get all the child items and add into site.item.properties.children
+    const childItemIds = infosWithoutSite.map((i) => i.id);
+    siteModel.item.properties.children = childItemIds;
+    // re-interpolate the siteModel using the itemInfos
+    siteModel = (0, hub_sites_1.interpolateSite)(siteModel, templateDictionary, {});
+    // and update the model
+    secondPassPromises.push((0, hub_sites_1.updateSite)(siteModel, {
+        ...hubRequestOptions,
+        allowList: undefined,
+    }));
+    return Promise.all(secondPassPromises).then(() => {
+        return true;
+    });
+}
+exports._postProcessSite = _postProcessSite;
+//# sourceMappingURL=_post-process-site.js.map

package/dist/cjs/helpers/_post-process-site.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_post-process-site.js","sourceRoot":"","sources":["../../../src/helpers/_post-process-site.ts"],"names":[],"mappings":";;;AAiBA,+CAAsF;AAEtF,6DAAwD;AAExD;;;;;;;;;;;GAWG;AACH,SAAgB,gBAAgB,CAC9B,SAAiB,EACjB,SAAgB,EAChB,kBAAuB,EACvB,iBAAyC;IAEzC,MAAM,gBAAgB,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEnF,mEAAmE;IACnE,0CAA0C;IAC1C,MAAM,YAAY,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QAC9C,OAAO;YACL,IAAI,EAAE;gBACJ,EAAE,EAAE,CAAC,CAAC,EAAE;gBACR,IAAI,EAAE,CAAC,CAAC,IAAI;aACb;SACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAI,kBAAkB,GAAwB,EAAE,CAAC;IAEjD,mEAAmE;IACnE,kBAAkB,GAAG,kBAAkB,CAAC,MAAM,CAC5C,IAAA,kCAAsB,EAAC,SAAS,EAAE,YAAmC,EAAE,iBAAiB,CAAC,CAC1F,CAAC;IAEF,mDAAmD;IACnD,+CAA+C;IAC/C,qCAAqC;IACrC,mEAAmE;IACnE,kBAAkB,GAAG,kBAAkB,CAAC,MAAM,CAAC,IAAA,qCAAgB,EAAC,SAAS,EAAE,gBAAgB,EAAE,iBAAiB,CAAC,CAAC,CAAC;IACjH,6EAA6E;IAC7E,MAAM,YAAY,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAEvD,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,GAAG,YAAY,CAAC;IAElD,mDAAmD;IACnD,SAAS,GAAG,IAAA,2BAAe,EAAC,SAAS,EAAE,kBAAkB,EAAE,EAAE,CAAC,CAAC;IAC/D,uBAAuB;IACvB,kBAAkB,CAAC,IAAI,CACrB,IAAA,sBAAU,EAAC,SAAS,EAAE;QACpB,GAAG,iBAAiB;QACpB,SAAS,EAAE,SAAS;KACrB,CAAC,CACH,CAAC;IAEF,OAAO,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;QAC/C,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;AACL,CAAC;AAjDD,4CAiDC"}

package/dist/cjs/helpers/_update-site-pages.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 { IModel, IHubUserRequestOptions } from "@esri/hub-common";
+/**
+ *
+ * @param siteModel
+ * @param itemInfos
+ * @param hubRequestOptions
+ * @private
+ */
+export declare function _updateSitePages(siteModel: IModel, itemInfos: any[], hubRequestOptions: IHubUserRequestOptions): Promise<any>;

package/dist/cjs/helpers/_update-site-pages.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._updateSitePages = void 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.
+ */
+const hub_common_1 = require("@esri/hub-common");
+const hub_sites_1 = require("@esri/hub-sites");
+/**
+ *
+ * @param siteModel
+ * @param itemInfos
+ * @param hubRequestOptions
+ * @private
+ */
+function _updateSitePages(siteModel, itemInfos, hubRequestOptions) {
+    const pageIds = itemInfos
+        .filter((e) => {
+        return e.type.indexOf("Page") > -1;
+    })
+        .map((e) => e.id);
+    // now get all those models
+    return Promise.all(pageIds.map((id) => {
+        return (0, hub_common_1.getModel)(id, hubRequestOptions);
+    })).then((pageModels) => {
+        // now delegate back to hub.js internal _updatePages fn
+        return (0, hub_sites_1._updatePages)(siteModel, pageModels, hubRequestOptions);
+    });
+}
+exports._updateSitePages = _updateSitePages;
+//# sourceMappingURL=_update-site-pages.js.map

package/dist/cjs/helpers/_update-site-pages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_update-site-pages.js","sourceRoot":"","sources":["../../../src/helpers/_update-site-pages.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;GAcG;AACH,iDAA4E;AAC5E,+CAA+C;AAC/C;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAC9B,SAAiB,EACjB,SAAgB,EAChB,iBAAyC;IAEzC,MAAM,OAAO,GAAG,SAAS;SACtB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE;QACZ,OAAO,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IACrC,CAAC,CAAC;SACD,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAEpB,2BAA2B;IAC3B,OAAO,OAAO,CAAC,GAAG,CAChB,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE;QACjB,OAAO,IAAA,qBAAQ,EAAC,EAAE,EAAE,iBAAiB,CAAC,CAAC;IACzC,CAAC,CAAC,CACH,CAAC,IAAI,CAAC,CAAC,UAAe,EAAE,EAAE;QACzB,uDAAuD;QACvD,OAAO,IAAA,wBAAY,EAAC,SAAS,EAAE,UAAU,EAAE,iBAAiB,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;AACL,CAAC;AApBD,4CAoBC"}

package/dist/cjs/helpers/move-model-to-folder.d.ts

@@ -0,0 +1,26 @@
+/** @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 { IModel } from "@esri/hub-common";
+import { UserSession } from "@esri/solution-common";
+/**
+ * Move the created site item, and optionally the Initiative, into
+ * the solution folder
+ *
+ * @param siteModel
+ * @param folderId
+ * @param authentication
+ */
+export declare function moveModelToFolder(siteModel: IModel, folderId: string, authentication: UserSession): Promise<any>;

package/dist/cjs/helpers/move-model-to-folder.js

@@ -0,0 +1,50 @@
+"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.moveModelToFolder = void 0;
+const hub_common_1 = require("@esri/hub-common");
+const solution_common_1 = require("@esri/solution-common");
+/**
+ * Move the created site item, and optionally the Initiative, into
+ * the solution folder
+ *
+ * @param siteModel
+ * @param folderId
+ * @param authentication
+ */
+function moveModelToFolder(siteModel, folderId, authentication) {
+    // Fail-Safe the move call as it's not critical if it fails
+    const failSafeMove = (0, hub_common_1.failSafe)(solution_common_1.moveItem, { success: true });
+    const movePromises = [
+        failSafeMove({
+            itemId: siteModel.item.id,
+            folderId,
+            authentication,
+        }),
+    ];
+    // if an initiative was created...
+    if ((0, hub_common_1.getProp)(siteModel, "item.properties.parentInitiativeId")) {
+        movePromises.push(failSafeMove({
+            itemId: siteModel.item.properties.parentInitiativeId,
+            folderId,
+            authentication,
+        }));
+    }
+    return Promise.all(movePromises);
+}
+exports.moveModelToFolder = moveModelToFolder;
+//# sourceMappingURL=move-model-to-folder.js.map

package/dist/cjs/helpers/move-model-to-folder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"move-model-to-folder.js","sourceRoot":"","sources":["../../../src/helpers/move-model-to-folder.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH,iDAA6D;AAC7D,2DAA8D;AAE9D;;;;;;;GAOG;AACH,SAAgB,iBAAiB,CAAC,SAAiB,EAAE,QAAgB,EAAE,cAA2B;IAChG,2DAA2D;IAC3D,MAAM,YAAY,GAAG,IAAA,qBAAQ,EAAC,0BAAQ,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAE3D,MAAM,YAAY,GAAG;QACnB,YAAY,CAAC;YACX,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC,EAAE;YACzB,QAAQ;YACR,cAAc;SACf,CAAC;KACH,CAAC;IACF,kCAAkC;IAClC,IAAI,IAAA,oBAAO,EAAC,SAAS,EAAE,oCAAoC,CAAC,EAAE;QAC5D,YAAY,CAAC,IAAI,CACf,YAAY,CAAC;YACX,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,kBAAkB;YACpD,QAAQ;YACR,cAAc;SACf,CAAC,CACH,CAAC;KACH;IAED,OAAO,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;AACnC,CAAC;AAvBD,8CAuBC"}

package/dist/cjs/helpers/replace-item-ids.d.ts

@@ -0,0 +1,17 @@
+/** @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 { IModelTemplate } from "@esri/hub-common";
+export declare function replaceItemIds(template: IModelTemplate): IModelTemplate;

package/dist/cjs/helpers/replace-item-ids.js

@@ -0,0 +1,37 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.replaceItemIds = void 0;
+const hub_common_1 = require("@esri/hub-common");
+function replaceItemIds(template) {
+    const clone = (0, hub_common_1.cloneObject)(template);
+    const deps = template.dependencies || [];
+    // iterate the dependencies
+    deps.forEach((depId) => {
+        const re = new RegExp(depId, "g");
+        const replacement = `{{${depId}.itemId}}`;
+        // we have to do this property-by-property or we would replace the `itemId` prop itself
+        clone.item = (0, hub_common_1.deepStringReplace)(clone.item, re, replacement);
+        clone.data = (0, hub_common_1.deepStringReplace)(clone.data, re, replacement);
+        if (template.properties) {
+            clone.properties = (0, hub_common_1.deepStringReplace)(clone.properties, re, replacement);
+        }
+    });
+    return clone;
+}
+exports.replaceItemIds = replaceItemIds;
+//# sourceMappingURL=replace-item-ids.js.map

package/dist/cjs/helpers/replace-item-ids.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"replace-item-ids.js","sourceRoot":"","sources":["../../../src/helpers/replace-item-ids.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH,iDAAkF;AAElF,SAAgB,cAAc,CAAC,QAAwB;IACrD,MAAM,KAAK,GAAG,IAAA,wBAAW,EAAC,QAAQ,CAAC,CAAC;IACpC,MAAM,IAAI,GAAG,QAAQ,CAAC,YAAY,IAAI,EAAE,CAAC;IACzC,2BAA2B;IAC3B,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QACrB,MAAM,EAAE,GAAG,IAAI,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QAClC,MAAM,WAAW,GAAG,KAAK,KAAK,WAAW,CAAC;QAC1C,uFAAuF;QACvF,KAAK,CAAC,IAAI,GAAG,IAAA,8BAAiB,EAAC,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,WAAW,CAAC,CAAC;QAC5D,KAAK,CAAC,IAAI,GAAG,IAAA,8BAAiB,EAAC,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,WAAW,CAAC,CAAC;QAC5D,IAAI,QAAQ,CAAC,UAAU,EAAE;YACvB,KAAK,CAAC,UAAU,GAAG,IAAA,8BAAiB,EAAC,KAAK,CAAC,UAAU,EAAE,EAAE,EAAE,WAAW,CAAC,CAAC;SACzE;IACH,CAAC,CAAC,CAAC;IACH,OAAO,KAAK,CAAC;AACf,CAAC;AAfD,wCAeC"}

package/dist/cjs/hub-page-processor.d.ts

@@ -0,0 +1,62 @@
+/** @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.
+ */
+/**
+ * Manages the creation and deployment of Hub Page item types.
+ *
+ * @module hub-page-processor
+ */
+import { IItemTemplate, IItemProgressCallback, ICreateItemFromTemplateResponse, UserSession } from "@esri/solution-common";
+/**
+ * Converts a Hub Page item into a template.
+ *
+ * @param itemInfo Info about the item
+ * @param destAuthentication Credentials for requests to the destination organization
+ * @param srcAuthentication Credentials for requests to source items (placeholder--not used)
+ * @returns A promise that will resolve when the template has been created
+ */
+export declare function convertItemToTemplate(itemInfo: any, destAuthentication: UserSession, srcAuthentication?: UserSession): Promise<IItemTemplate>;
+/**
+ * Handle deployment of Page item templates
+ *
+ * @export
+ * @param {IItemTemplate} template
+ * @param {*} templateDictionary
+ * @param {UserSession} destinationAuthentication
+ * @param {IItemProgressCallback} itemProgressCallback
+ * @returns {Promise<ICreateItemFromTemplateResponse>}
+ */
+export declare function createItemFromTemplate(template: IItemTemplate, templateDictionary: any, destinationAuthentication: UserSession, itemProgressCallback: IItemProgressCallback): Promise<ICreateItemFromTemplateResponse>;
+/**
+ * Post-Process a Page
+ * Re-interpolate the page item + data w/ the full template dictionary hash
+ *
+ * @param id
+ * @param type
+ * @param itemInfos
+ * @param template
+ * @param templates
+ * @param templateDictionary
+ * @param authentication
+ */
+export declare function postProcess(id: string, type: string, itemInfos: any[], template: any, templates: IItemTemplate[], templateDictionary: any, authentication: UserSession): Promise<boolean>;
+/**
+ * Check of an item type is a Page
+ * Hub Page is for ArcGIS Online
+ * Site Page is for ArcGIS Enterprise
+ *
+ * @param itemType
+ */
+export declare function isAPage(itemType: string): boolean;

package/dist/cjs/hub-page-processor.js

@@ -0,0 +1,225 @@
+"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.isAPage = exports.postProcess = exports.createItemFromTemplate = exports.convertItemToTemplate = void 0;
+/**
+ * Manages the creation and deployment of Hub Page item types.
+ *
+ * @module hub-page-processor
+ */
+const solution_common_1 = require("@esri/solution-common");
+const hub_common_1 = require("@esri/hub-common");
+const hub_sites_1 = require("@esri/hub-sites");
+const _post_process_page_1 = require("./helpers/_post-process-page");
+const replace_item_ids_1 = require("./helpers/replace-item-ids");
+const move_model_to_folder_1 = require("./helpers/move-model-to-folder");
+/**
+ * Converts a Hub Page item into a template.
+ *
+ * @param itemInfo Info about the item
+ * @param destAuthentication Credentials for requests to the destination organization
+ * @param srcAuthentication Credentials for requests to source items (placeholder--not used)
+ * @returns A promise that will resolve when the template has been created
+ */
+function convertItemToTemplate(itemInfo, destAuthentication, srcAuthentication = null) {
+    let created = 0;
+    let modified = 0;
+    // get the page model and hubRequestOptions
+    return Promise.all([
+        (0, hub_common_1.getModel)(itemInfo.id, { authentication: destAuthentication }),
+        (0, solution_common_1.createHubRequestOptions)(destAuthentication),
+    ])
+        .then(([pageModel, ro]) => {
+        // We need to save these properties in order to restore them after hub.js deletes them
+        created = pageModel.item.created;
+        modified = pageModel.item.modified;
+        return (0, hub_sites_1.convertPageToTemplate)(pageModel, ro);
+    })
+        .then((tmpl) => {
+        // add in some stuff Hub.js does not yet add
+        tmpl.item.created = created;
+        tmpl.item.modified = modified;
+        tmpl.item.typeKeywords = (0, hub_common_1.without)(tmpl.item.typeKeywords, "doNotDelete");
+        tmpl.groups = [];
+        tmpl.estimatedDeploymentCostFactor = 2;
+        tmpl.resources = [];
+        if (!(0, hub_common_1.getProp)(tmpl, "properties")) {
+            tmpl.properties = {};
+        }
+        // swap out dependency id's to {{<depid>.itemId}}
+        // so it will be re-interpolated
+        tmpl = (0, replace_item_ids_1.replaceItemIds)(tmpl);
+        // and return it
+        return tmpl;
+    });
+}
+exports.convertItemToTemplate = convertItemToTemplate;
+/**
+ * Handle deployment of Page item templates
+ *
+ * @export
+ * @param {IItemTemplate} template
+ * @param {*} templateDictionary
+ * @param {UserSession} destinationAuthentication
+ * @param {IItemProgressCallback} itemProgressCallback
+ * @returns {Promise<ICreateItemFromTemplateResponse>}
+ */
+function createItemFromTemplate(template, templateDictionary, destinationAuthentication, itemProgressCallback) {
+    // let the progress system know we've started...
+    const startStatus = itemProgressCallback(template.itemId, solution_common_1.EItemProgressStatus.Started, 0);
+    // and if it returned false, just resolve out
+    if (!startStatus) {
+        return Promise.resolve((0, solution_common_1.generateEmptyCreationResponse)(template.type));
+    }
+    // TODO: Reassess with resource unification
+    if (template.assets && template.resources) {
+        delete template.assets;
+    }
+    // solutionItemExtent is in geographic, but it's a string, and we want/need a bbox
+    // and Hub templates expect it in organization.defaultExtentBBox
+    if (templateDictionary.solutionItemExtent) {
+        const parts = templateDictionary.solutionItemExtent.split(",");
+        templateDictionary.organization.defaultExtentBBox = [
+            [parts[0], parts[1]],
+            [parts[2], parts[3]],
+        ];
+    }
+    // TODO: Determine if we need any transforms in this new env
+    const transforms = {};
+    // create an object to hold the created site through
+    // subsequent promise calls
+    let pageModel;
+    let hubRo;
+    const thumbnail = template.item.thumbnail; // createPageModelFromTemplate trashes thumbnail
+    return (0, solution_common_1.createHubRequestOptions)(destinationAuthentication, templateDictionary)
+        .then((ro) => {
+        hubRo = ro;
+        return (0, hub_sites_1.createPageModelFromTemplate)(template, templateDictionary, transforms, hubRo);
+    })
+        .then((interpolated) => {
+        // --------------------------------------------
+        // TODO: Update hub.js to take an IModel in createPage
+        // then remove this silliness
+        const modelTmpl = interpolated;
+        const options = {
+            assets: modelTmpl.assets || [],
+        };
+        // --------------------------------------------
+        return (0, hub_sites_1.createPage)(modelTmpl, options, hubRo);
+    })
+        .then((page) => {
+        pageModel = page;
+        // Move the site and initiative to the solution folder
+        // this is essentially fire and forget. We fail-safe the actual moveItem
+        // call since it's not critical to the outcome
+        return (0, move_model_to_folder_1.moveModelToFolder)(page, templateDictionary.folderId, destinationAuthentication);
+    })
+        .then(() => {
+        // Fix the thumbnail
+        const updateOptions = {
+            item: {
+                id: pageModel.item.id,
+            },
+            params: {
+                // Pass thumbnail in via params because item property is serialized, which discards a blob
+                thumbnail,
+            },
+            authentication: destinationAuthentication,
+        };
+        return (0, solution_common_1.restUpdateItem)(updateOptions);
+    })
+        .then(() => {
+        // Update the template dictionary
+        // TODO: This should be done in whatever recieves
+        // the outcome of this promise chain
+        templateDictionary[template.itemId] = {
+            itemId: pageModel.item.id,
+        };
+        // call the progress callback, which also mutates templateDictionary
+        const finalStatus = itemProgressCallback(template.itemId, solution_common_1.EItemProgressStatus.Finished, template.estimatedDeploymentCostFactor || 2, pageModel.item.id);
+        if (!finalStatus) {
+            // clean up the site we just created
+            const failSafeRemove = (0, hub_common_1.failSafe)(hub_sites_1.removePage, { success: true });
+            return failSafeRemove(pageModel, hubRo).then(() => {
+                return Promise.resolve((0, solution_common_1.generateEmptyCreationResponse)(template.type));
+            });
+        }
+        else {
+            // finally, return ICreateItemFromTemplateResponse
+            const response = {
+                item: {
+                    ...template,
+                    ...(0, solution_common_1.convertIModel)(pageModel),
+                },
+                id: pageModel.item.id,
+                type: template.type,
+                postProcess: true,
+            };
+            response.item.itemId = pageModel.item.id;
+            return response;
+        }
+    })
+        .catch((ex) => {
+        itemProgressCallback(template.itemId, solution_common_1.EItemProgressStatus.Failed, 0);
+        throw ex;
+    });
+}
+exports.createItemFromTemplate = createItemFromTemplate;
+/**
+ * Post-Process a Page
+ * Re-interpolate the page item + data w/ the full template dictionary hash
+ *
+ * @param id
+ * @param type
+ * @param itemInfos
+ * @param template
+ * @param templates
+ * @param templateDictionary
+ * @param authentication
+ */
+function postProcess(id, type, itemInfos, template, templates, templateDictionary, authentication) {
+    // create the requestOptions
+    let hubRo;
+    // get hubRequestOptions
+    return (0, solution_common_1.createHubRequestOptions)(authentication)
+        .then((ro) => {
+        hubRo = ro;
+        // get the site model
+        return (0, hub_common_1.getModel)(id, { authentication });
+    })
+        .then((pageModel) => {
+        // post process the page
+        return (0, _post_process_page_1._postProcessPage)(pageModel, itemInfos, templateDictionary, hubRo);
+    });
+}
+exports.postProcess = postProcess;
+/**
+ * Check of an item type is a Page
+ * Hub Page is for ArcGIS Online
+ * Site Page is for ArcGIS Enterprise
+ *
+ * @param itemType
+ */
+function isAPage(itemType) {
+    let result = false;
+    if (itemType === "Hub Page" || itemType === "Site Page") {
+        result = true;
+    }
+    return result;
+}
+exports.isAPage = isAPage;
+//# sourceMappingURL=hub-page-processor.js.map

package/dist/cjs/hub-page-processor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hub-page-processor.js","sourceRoot":"","sources":["../../src/hub-page-processor.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH;;;;GAIG;AAEH,2DAW+B;AAC/B,iDAAwH;AACxH,+CAA6G;AAE7G,qEAAgE;AAChE,iEAA4D;AAC5D,yEAAmE;AAEnE;;;;;;;GAOG;AACH,SAAgB,qBAAqB,CACnC,QAAa,EACb,kBAA+B,EAC/B,oBAAiC,IAAI;IAErC,IAAI,OAAO,GAAW,CAAC,CAAC;IACxB,IAAI,QAAQ,GAAW,CAAC,CAAC;IAEzB,2CAA2C;IAC3C,OAAO,OAAO,CAAC,GAAG,CAAC;QACjB,IAAA,qBAAQ,EAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE,CAAC;QAC7D,IAAA,yCAAuB,EAAC,kBAAkB,CAAC;KAC5C,CAAC;SACC,IAAI,CAAC,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,EAAE,EAAE;QACxB,sFAAsF;QACtF,OAAO,GAAG,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC;QACjC,QAAQ,GAAG,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC;QACnC,OAAO,IAAA,iCAAqB,EAAC,SAAS,EAAE,EAAE,CAAC,CAAC;IAC9C,CAAC,CAAC;SACD,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;QACb,4CAA4C;QAC5C,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAC5B,IAAI,CAAC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAC9B,IAAI,CAAC,IAAI,CAAC,YAAY,GAAG,IAAA,oBAAO,EAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC;QACxE,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QACjB,IAAI,CAAC,6BAA6B,GAAG,CAAC,CAAC;QACvC,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,IAAI,CAAC,IAAA,oBAAO,EAAC,IAAI,EAAE,YAAY,CAAC,EAAE;YAChC,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;SACtB;QACD,iDAAiD;QACjD,gCAAgC;QAChC,IAAI,GAAG,IAAA,iCAAc,EAAC,IAAI,CAAC,CAAC;QAC5B,gBAAgB;QAChB,OAAO,IAAqB,CAAC;IAC/B,CAAC,CAAC,CAAC;AACP,CAAC;AApCD,sDAoCC;AACD;;;;;;;;;GASG;AACH,SAAgB,sBAAsB,CACpC,QAAuB,EACvB,kBAAuB,EACvB,yBAAsC,EACtC,oBAA2C;IAE3C,gDAAgD;IAChD,MAAM,WAAW,GAAG,oBAAoB,CAAC,QAAQ,CAAC,MAAM,EAAE,qCAAmB,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;IAE1F,6CAA6C;IAC7C,IAAI,CAAC,WAAW,EAAE;QAChB,OAAO,OAAO,CAAC,OAAO,CAAC,IAAA,+CAA6B,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;KACtE;IAED,2CAA2C;IAC3C,IAAI,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,SAAS,EAAE;QACzC,OAAO,QAAQ,CAAC,MAAM,CAAC;KACxB;IAED,kFAAkF;IAClF,gEAAgE;IAChE,IAAI,kBAAkB,CAAC,kBAAkB,EAAE;QACzC,MAAM,KAAK,GAAG,kBAAkB,CAAC,kBAAkB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC/D,kBAAkB,CAAC,YAAY,CAAC,iBAAiB,GAAG;YAClD,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;YACpB,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;SACrB,CAAC;KACH;IAED,4DAA4D;IAC5D,MAAM,UAAU,GAAG,EAAE,CAAC;IAEtB,oDAAoD;IACpD,2BAA2B;IAC3B,IAAI,SAAiB,CAAC;IAEtB,IAAI,KAA6B,CAAC;IAClC,MAAM,SAAS,GAAS,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,gDAAgD;IACjG,OAAO,IAAA,yCAAuB,EAAC,yBAAyB,EAAE,kBAAkB,CAAC;SAC1E,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE;QACX,KAAK,GAAG,EAAE,CAAC;QACX,OAAO,IAAA,uCAA2B,EAAC,QAAQ,EAAE,kBAAkB,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;IACtF,CAAC,CAAC;SACD,IAAI,CAAC,CAAC,YAAqB,EAAE,EAAE;QAC9B,+CAA+C;QAC/C,sDAAsD;QACtD,6BAA6B;QAC7B,MAAM,SAAS,GAAG,YAA8B,CAAC;QACjD,MAAM,OAAO,GAAG;YACd,MAAM,EAAE,SAAS,CAAC,MAAM,IAAI,EAAE;SACpB,CAAC;QACb,+CAA+C;QAC/C,OAAO,IAAA,sBAAU,EAAC,SAAS,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;IAC/C,CAAC,CAAC;SACD,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;QACb,SAAS,GAAG,IAAI,CAAC;QACjB,sDAAsD;QACtD,wEAAwE;QACxE,8CAA8C;QAC9C,OAAO,IAAA,wCAAiB,EAAC,IAAI,EAAE,kBAAkB,CAAC,QAAQ,EAAE,yBAAyB,CAAC,CAAC;IACzF,CAAC,CAAC;SACD,IAAI,CAAC,GAAG,EAAE;QACT,oBAAoB;QACpB,MAAM,aAAa,GAAuB;YACxC,IAAI,EAAE;gBACJ,EAAE,EAAE,SAAS,CAAC,IAAI,CAAC,EAAE;aACtB;YACD,MAAM,EAAE;gBACN,0FAA0F;gBAC1F,SAAS;aACV;YACD,cAAc,EAAE,yBAAyB;SAC1C,CAAC;QACF,OAAO,IAAA,gCAAc,EAAC,aAAa,CAAC,CAAC;IACvC,CAAC,CAAC;SACD,IAAI,CAAC,GAAG,EAAE;QACT,iCAAiC;QACjC,iDAAiD;QACjD,oCAAoC;QACpC,kBAAkB,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG;YACpC,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC,EAAE;SAC1B,CAAC;QACF,oEAAoE;QACpE,MAAM,WAAW,GAAG,oBAAoB,CACtC,QAAQ,CAAC,MAAM,EACf,qCAAmB,CAAC,QAAQ,EAC5B,QAAQ,CAAC,6BAA6B,IAAI,CAAC,EAC3C,SAAS,CAAC,IAAI,CAAC,EAAE,CAClB,CAAC;QACF,IAAI,CAAC,WAAW,EAAE;YAChB,oCAAoC;YACpC,MAAM,cAAc,GAAG,IAAA,qBAAQ,EAAC,sBAAU,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;YAC/D,OAAO,cAAc,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;gBAChD,OAAO,OAAO,CAAC,OAAO,CAAC,IAAA,+CAA6B,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;YACvE,CAAC,CAAC,CAAC;SACJ;aAAM;YACL,kDAAkD;YAClD,MAAM,QAAQ,GAAoC;gBAChD,IAAI,EAAE;oBACJ,GAAG,QAAQ;oBACX,GAAG,IAAA,+BAAa,EAAC,SAAS,CAAC;iBAC5B;gBACD,EAAE,EAAE,SAAS,CAAC,IAAI,CAAC,EAAE;gBACrB,IAAI,EAAE,QAAQ,CAAC,IAAI;gBACnB,WAAW,EAAE,IAAI;aAClB,CAAC;YACF,QAAQ,CAAC,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;YACzC,OAAO,QAAQ,CAAC;SACjB;IACH,CAAC,CAAC;SACD,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE;QACZ,oBAAoB,CAAC,QAAQ,CAAC,MAAM,EAAE,qCAAmB,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QACrE,MAAM,EAAE,CAAC;IACX,CAAC,CAAC,CAAC;AACP,CAAC;AAlHD,wDAkHC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,WAAW,CACzB,EAAU,EACV,IAAY,EACZ,SAAgB,EAChB,QAAa,EACb,SAA0B,EAC1B,kBAAuB,EACvB,cAA2B;IAE3B,4BAA4B;IAC5B,IAAI,KAA6B,CAAC;IAClC,wBAAwB;IACxB,OAAO,IAAA,yCAAuB,EAAC,cAAc,CAAC;SAC3C,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE;QACX,KAAK,GAAG,EAAE,CAAC;QACX,qBAAqB;QACrB,OAAO,IAAA,qBAAQ,EAAC,EAAE,EAAE,EAAE,cAAc,EAAE,CAAC,CAAC;IAC1C,CAAC,CAAC;SACD,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE;QAClB,wBAAwB;QACxB,OAAO,IAAA,qCAAgB,EAAC,SAAS,EAAE,SAAS,EAAE,kBAAkB,EAAE,KAAK,CAAC,CAAC;IAC3E,CAAC,CAAC,CAAC;AACP,CAAC;AAtBD,kCAsBC;AAED;;;;;;GAMG;AACH,SAAgB,OAAO,CAAC,QAAgB;IACtC,IAAI,MAAM,GAAG,KAAK,CAAC;IAEnB,IAAI,QAAQ,KAAK,UAAU,IAAI,QAAQ,KAAK,WAAW,EAAE;QACvD,MAAM,GAAG,IAAI,CAAC;KACf;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAPD,0BAOC"}