@esri/hub-common 14.24.0 → 14.25.0

package/dist/node/initiative-templates/fetch.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.enrichInitiativeTemplateSearchResult = exports.convertItemToInitiativeTemplate = exports.fetchInitiativeTemplate = void 0;
+const arcgis_rest_portal_1 = require("@esri/arcgis-rest-portal");
+const get_family_1 = require("../content/get-family");
+const PropertyMapper_1 = require("../core/_internal/PropertyMapper");
+const slugs_1 = require("../items/slugs");
+const models_1 = require("../models");
+const utils_1 = require("../utils");
+const computeProps_1 = require("./_internal/computeProps");
+const getPropertyMap_1 = require("./_internal/getPropertyMap");
+const computeLinks_1 = require("./_internal/computeLinks");
+async function fetchInitiativeTemplate(identifier, requestOptions) {
+    let getPrms;
+    if (utils_1.isGuid(identifier)) {
+        // get item by id
+        getPrms = arcgis_rest_portal_1.getItem(identifier, requestOptions);
+    }
+    else {
+        getPrms = slugs_1.getItemBySlug(identifier, requestOptions);
+    }
+    return getPrms.then((item) => {
+        if (!item)
+            return null;
+        return convertItemToInitiativeTemplate(item, requestOptions);
+    });
+}
+exports.fetchInitiativeTemplate = fetchInitiativeTemplate;
+/**
+ * @private
+ * Convert a Hub Initiative Template Item into a Hub Initiative Template, feching any additional
+ * information that may be required
+ * @param item
+ * @param requestOptions
+ * @returns
+ */
+async function convertItemToInitiativeTemplate(item, requestOptions) {
+    const model = await models_1.fetchModelFromItem(item, requestOptions);
+    const mapper = new PropertyMapper_1.PropertyMapper(getPropertyMap_1.getPropertyMap());
+    const it = mapper.storeToEntity(model, {});
+    return computeProps_1.computeProps(model, it, requestOptions);
+}
+exports.convertItemToInitiativeTemplate = convertItemToInitiativeTemplate;
+async function enrichInitiativeTemplateSearchResult(item, include, requestOptions) {
+    const result = {
+        access: item.access,
+        id: item.id,
+        type: item.type,
+        name: item.title,
+        owner: item.owner,
+        typeKeywords: item.typeKeywords,
+        tags: item.tags,
+        categories: item.categories,
+        summary: item.snippet || item.description,
+        createdDate: new Date(item.created),
+        createdDateSource: "item.created",
+        updatedDate: new Date(item.modified),
+        updatedDateSource: "item.modified",
+        family: get_family_1.getFamily(item.type),
+        links: {
+            self: "not-implemented",
+            siteRelative: "not-implemented",
+            thumbnail: "not-implemented",
+            workspaceRelative: "not-implemented",
+        },
+    };
+    // TODO: reimplement enrichment fetching when we know what enrichments we're looking for
+    // Handle links
+    // TODO: links should be an enrichment
+    result.links = computeLinks_1.computeLinks(item, requestOptions);
+    return result;
+}
+exports.enrichInitiativeTemplateSearchResult = enrichInitiativeTemplateSearchResult;
+//# sourceMappingURL=fetch.js.map

package/dist/node/initiative-templates/fetch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch.js","sourceRoot":"","sources":["../../../src/initiative-templates/fetch.ts"],"names":[],"mappings":";;;AACA,iEAA0D;AAE1D,sDAAkD;AAGlD,qEAAkE;AAClE,0CAA+C;AAE/C,sCAA+C;AAG/C,oCAAyC;AACzC,2DAAwD;AACxD,+DAA4D;AAK5D,2DAAwD;AAEjD,KAAK,UAAU,uBAAuB,CAC3C,UAAkB,EAClB,cAA+B;IAE/B,IAAI,OAAO,CAAC;IACZ,IAAI,cAAM,CAAC,UAAU,CAAC,EAAE;QACtB,iBAAiB;QACjB,OAAO,GAAG,4BAAO,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;KAC/C;SAAM;QACL,OAAO,GAAG,qBAAa,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;KACrD;IACD,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;QAC3B,IAAI,CAAC,IAAI;YAAE,OAAO,IAAI,CAAC;QACvB,OAAO,+BAA+B,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;AACL,CAAC;AAfD,0DAeC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,+BAA+B,CACnD,IAAW,EACX,cAA+B;IAE/B,MAAM,KAAK,GAAG,MAAM,2BAAkB,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;IAC7D,MAAM,MAAM,GAAG,IAAI,+BAAc,CAC/B,+BAAc,EAAE,CACjB,CAAC;IACF,MAAM,EAAE,GAAG,MAAM,CAAC,aAAa,CAAC,KAAK,EAAE,EAAE,CAA2B,CAAC;IACrE,OAAO,2BAAY,CAAC,KAAK,EAAE,EAAE,EAAE,cAAc,CAAC,CAAC;AACjD,CAAC;AAVD,0EAUC;AAEM,KAAK,UAAU,oCAAoC,CACxD,IAAW,EACX,OAAiB,EACjB,cAAkC;IAElC,MAAM,MAAM,GAAqB;QAC/B,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,EAAE,EAAE,IAAI,CAAC,EAAE;QACX,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,IAAI,EAAE,IAAI,CAAC,KAAK;QAChB,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,YAAY,EAAE,IAAI,CAAC,YAAY;QAC/B,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,OAAO,EAAE,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,WAAW;QACzC,WAAW,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;QACnC,iBAAiB,EAAE,cAAc;QACjC,WAAW,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;QACpC,iBAAiB,EAAE,eAAe;QAClC,MAAM,EAAE,sBAAS,CAAC,IAAI,CAAC,IAAI,CAAC;QAC5B,KAAK,EAAE;YACL,IAAI,EAAE,iBAAiB;YACvB,YAAY,EAAE,iBAAiB;YAC/B,SAAS,EAAE,iBAAiB;YAC5B,iBAAiB,EAAE,iBAAiB;SACrC;KACF,CAAC;IAEF,wFAAwF;IAExF,eAAe;IACf,sCAAsC;IACtC,MAAM,CAAC,KAAK,GAAG,2BAAY,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;IAElD,OAAO,MAAM,CAAC;AAChB,CAAC;AAnCD,oFAmCC"}

package/dist/node/initiative-templates/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./HubInitiativeTemplate"), exports);
+tslib_1.__exportStar(require("./edit"), exports);
+tslib_1.__exportStar(require("./fetch"), exports);
+tslib_1.__exportStar(require("./view"), exports);
+//# sourceMappingURL=index.js.map

package/dist/node/initiative-templates/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/initiative-templates/index.ts"],"names":[],"mappings":";;;AAAA,kEAAwC;AACxC,iDAAuB;AACvB,kDAAwB;AACxB,iDAAuB"}

package/dist/node/initiative-templates/view.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initiativeTemplateResultToCardModel = exports.initiativeTemplateToCardModel = void 0;
+const getCardModelUrl_1 = require("../urls/getCardModelUrl");
+const content_1 = require("../content");
+const internalContentUtils_1 = require("../content/_internal/internalContentUtils");
+/**
+ * Convert an initiative template entity into a card view model that can
+ * be consumed by the suite of hub gallery components
+ *
+ * @param initiativeTemplate initiative template entity
+ * @param context auth & portal information
+ * @param opts view model options
+ * @returns
+ */
+exports.initiativeTemplateToCardModel = (initiativeTemplate, context, opts) => {
+    const { actionLinks = [], baseUrl = "", locale = "en-US", target = "self", } = opts || {};
+    const titleUrl = getCardModelUrl_1.getCardModelUrlFromEntity(initiativeTemplate, context, target, baseUrl);
+    return Object.assign(Object.assign(Object.assign({}, getSharedInitiativeTemplateCardModel(initiativeTemplate, locale)), { actionLinks,
+        titleUrl }), (initiativeTemplate.thumbnailUrl && {
+        thumbnailUrl: initiativeTemplate.thumbnailUrl,
+    }));
+};
+/**
+ * Convert an initiative template hub search result into a card view model that
+ * can be consumed by the suite of hub gallery components
+ *
+ * @param searchResult hub initiative template search result
+ * @param opts view model options
+ */
+exports.initiativeTemplateResultToCardModel = (searchResult, opts) => {
+    const { actionLinks = [], baseUrl = "", locale = "en-US", target = "self", } = opts || {};
+    const titleUrl = getCardModelUrl_1.getCardModelUrlFromResult(searchResult, target, baseUrl);
+    return Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, getSharedInitiativeTemplateCardModel(searchResult, locale)), { actionLinks }), (!isNaN(searchResult.index) && { index: searchResult.index })), { titleUrl }), (searchResult.links.thumbnail && {
+        thumbnailUrl: searchResult.links.thumbnail,
+    }));
+};
+const getSharedInitiativeTemplateCardModel = (entityOrSearchResult, locale) => {
+    var _a, _b;
+    const additionalInfo = [
+        {
+            i18nKey: "type",
+            value: entityOrSearchResult.type,
+        },
+        {
+            i18nKey: "dateUpdated",
+            value: entityOrSearchResult.updatedDate.toLocaleDateString(locale),
+        },
+        ...(((_a = entityOrSearchResult.tags) === null || _a === void 0 ? void 0 : _a.length) ? [
+            {
+                i18nKey: "tags",
+                value: entityOrSearchResult.tags.join(", "),
+            },
+        ]
+            : []),
+        ...(((_b = entityOrSearchResult.categories) === null || _b === void 0 ? void 0 : _b.length) ? [
+            {
+                i18nKey: "categories",
+                value: internalContentUtils_1.getShortenedCategories(entityOrSearchResult.categories).join(", "),
+            },
+        ]
+            : []),
+        {
+            i18nKey: "dateCreated",
+            value: entityOrSearchResult.createdDate.toLocaleDateString(locale),
+        },
+    ];
+    return {
+        access: entityOrSearchResult.access,
+        badges: [],
+        id: entityOrSearchResult.id,
+        family: content_1.getFamily(entityOrSearchResult.type),
+        source: entityOrSearchResult.owner,
+        summary: entityOrSearchResult.summary,
+        title: entityOrSearchResult.name,
+        type: entityOrSearchResult.type,
+        additionalInfo,
+    };
+};
+//# sourceMappingURL=view.js.map

package/dist/node/initiative-templates/view.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"view.js","sourceRoot":"","sources":["../../../src/initiative-templates/view.ts"],"names":[],"mappings":";;;AAEA,6DAGiC;AAOjC,wCAAuC;AACvC,oFAAmF;AAEnF;;;;;;;;GAQG;AACU,QAAA,6BAA6B,GAEtC,CACF,kBAA0C,EAC1C,OAAuB,EACvB,IAA8B,EACX,EAAE;IACrB,MAAM,EACJ,WAAW,GAAG,EAAE,EAChB,OAAO,GAAG,EAAE,EACZ,MAAM,GAAG,OAAO,EAChB,MAAM,GAAG,MAAM,GAChB,GAAG,IAAI,IAAI,EAAE,CAAC;IAEf,MAAM,QAAQ,GAAG,2CAAyB,CACxC,kBAAkB,EAClB,OAAO,EACP,MAAM,EACN,OAAO,CACR,CAAC;IAEF,qDACK,oCAAoC,CAAC,kBAAkB,EAAE,MAAM,CAAC,KACnE,WAAW;QACX,QAAQ,KACL,CAAC,kBAAkB,CAAC,YAAY,IAAI;QACrC,YAAY,EAAE,kBAAkB,CAAC,YAAY;KAC9C,CAAC,EACF;AACJ,CAAC,CAAC;AAEF;;;;;;GAMG;AACU,QAAA,mCAAmC,GAAwB,CACtE,YAA8B,EAC9B,IAA8B,EACX,EAAE;IACrB,MAAM,EACJ,WAAW,GAAG,EAAE,EAChB,OAAO,GAAG,EAAE,EACZ,MAAM,GAAG,OAAO,EAChB,MAAM,GAAG,MAAM,GAChB,GAAG,IAAI,IAAI,EAAE,CAAC;IAEf,MAAM,QAAQ,GAAG,2CAAyB,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAE1E,iFACK,oCAAoC,CAAC,YAAY,EAAE,MAAM,CAAC,KAC7D,WAAW,KACR,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,YAAY,CAAC,KAAK,EAAE,CAAC,KAChE,QAAQ,KACL,CAAC,YAAY,CAAC,KAAK,CAAC,SAAS,IAAI;QAClC,YAAY,EAAE,YAAY,CAAC,KAAK,CAAC,SAAS;KAC3C,CAAC,EACF;AACJ,CAAC,CAAC;AAEF,MAAM,oCAAoC,GAAG,CAC3C,oBAA+D,EAC/D,MAAc,EACK,EAAE;;IACrB,MAAM,cAAc,GAAG;QACrB;YACE,OAAO,EAAE,MAAM;YACf,KAAK,EAAE,oBAAoB,CAAC,IAAI;SACjC;QACD;YACE,OAAO,EAAE,aAAa;YACtB,KAAK,EAAE,oBAAoB,CAAC,WAAW,CAAC,kBAAkB,CAAC,MAAM,CAAC;SACnE;QACD,GAAG,CAAC,OAAA,oBAAoB,CAAC,IAAI,0CAAE,MAAM,EACnC,CAAC,CAAC;YACE;gBACE,OAAO,EAAE,MAAM;gBACf,KAAK,EAAE,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;aAC5C;SACF;YACH,CAAC,CAAC,EAAE,CAAC;QACP,GAAG,CAAC,OAAA,oBAAoB,CAAC,UAAU,0CAAE,MAAM,EACzC,CAAC,CAAC;YACE;gBACE,OAAO,EAAE,YAAY;gBACrB,KAAK,EAAE,6CAAsB,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC,IAAI,CACjE,IAAI,CACL;aACF;SACF;YACH,CAAC,CAAC,EAAE,CAAC;QACP;YACE,OAAO,EAAE,aAAa;YACtB,KAAK,EAAE,oBAAoB,CAAC,WAAW,CAAC,kBAAkB,CAAC,MAAM,CAAC;SACnE;KACF,CAAC;IAEF,OAAO;QACL,MAAM,EAAE,oBAAoB,CAAC,MAAM;QACnC,MAAM,EAAE,EAAE;QACV,EAAE,EAAE,oBAAoB,CAAC,EAAE;QAC3B,MAAM,EAAE,mBAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC;QAC5C,MAAM,EAAE,oBAAoB,CAAC,KAAK;QAClC,OAAO,EAAE,oBAAoB,CAAC,OAAO;QACrC,KAAK,EAAE,oBAAoB,CAAC,IAAI;QAChC,IAAI,EAAE,oBAAoB,CAAC,IAAI;QAC/B,cAAc;KACf,CAAC;AACJ,CAAC,CAAC"}

package/dist/node/permissions/HubPermissionPolicies.js

@@ -9,6 +9,7 @@ const ContentBusinessRules_1 = require("../content/_internal/ContentBusinessRule
 const GroupBusinessRules_1 = require("../groups/_internal/GroupBusinessRules");
 const PageBusinessRules_1 = require("../pages/_internal/PageBusinessRules");
 const PlatformPermissionPolicies_1 = require("./PlatformPermissionPolicies");
+const InitiativeTemplateBusinessRules_1 = require("../initiative-templates/_internal/InitiativeTemplateBusinessRules");
 // Examples of possible Permission Policies
 // const DiscussionPermissionPolicies: IPermissionPolicy[] = [
 //   {
@@ -82,6 +83,7 @@ exports.HubPermissionsPolicies = [
     ...PageBusinessRules_1.PagePermissionPolicies,
     ...PlatformPermissionPolicies_1.PlatformPermissionPolicies,
     ...TempPermissionPolicies,
+    ...InitiativeTemplateBusinessRules_1.InitiativeTemplatePermissionPolicies,
 ];
 /**
  * Get the policies defined for a specific permission

package/dist/node/permissions/HubPermissionPolicies.js.map

@@ -1 +1 @@
-{"version":3,"file":"HubPermissionPolicies.js","sourceRoot":"","sources":["../../../src/permissions/HubPermissionPolicies.ts"],"names":[],"mappings":";;;AAAA,8FAAgG;AAChG,qFAAuF;AACvF,4EAA+E;AAC/E,8FAAgG;AAChG,oFAAsF;AAGtF,+EAAiF;AACjF,4EAA8E;AAC9E,6EAA0E;AAC1E,2CAA2C;AAC3C,8DAA8D;AAC9D,MAAM;AACN,gDAAgD;AAChD,2BAA2B;AAC3B,iCAAiC;AACjC,8CAA8C;AAC9C,OAAO;AACP,MAAM;AACN,uDAAuD;AACvD,2BAA2B;AAC3B,8CAA8C;AAC9C,oBAAoB;AACpB,UAAU;AACV,iDAAiD;AACjD,gCAAgC;AAChC,kCAAkC;AAClC,WAAW;AACX,UAAU;AACV,2CAA2C;AAC3C,uCAAuC;AACvC,oCAAoC;AACpC,WAAW;AACX,SAAS;AACT,OAAO;AACP,MAAM;AACN,gDAAgD;AAChD,iCAAiC;AACjC,2BAA2B;AAC3B,8CAA8C;AAC9C,oBAAoB;AACpB,UAAU;AACV,2CAA2C;AAC3C,gCAAgC;AAChC,kCAAkC;AAClC,WAAW;AACX,SAAS;AACT,OAAO;AACP,MAAM;AACN,6CAA6C;AAC7C,iCAAiC;AACjC,2BAA2B;AAC3B,8CAA8C;AAC9C,oBAAoB;AACpB,UAAU;AACV,2CAA2C;AAC3C,gCAAgC;AAChC,kCAAkC;AAClC,WAAW;AACX,SAAS;AACT,OAAO;AACP,KAAK;AAEL,MAAM,sBAAsB,GAAwB;IAClD;QACE,yBAAyB;QACzB,UAAU,EAAE,yBAAyB;QACrC,YAAY,EAAE,CAAC,OAAO,CAAC;QACvB,YAAY,EAAE,CAAC,QAAQ,EAAE,OAAO,CAAC;KAClC;CACF,CAAC;AAEF;;GAEG;AACU,QAAA,sBAAsB,GAAwB;IACzD,GAAG,2CAAuB;IAC1B,GAAG,gDAAyB;IAC5B,GAAG,sDAA4B;IAC/B,GAAG,sDAA4B;IAC/B,GAAG,gDAAyB;IAC5B,GAAG,4CAAuB;IAC1B,GAAG,0CAAsB;IACzB,GAAG,uDAA0B;IAC7B,GAAG,sBAAsB;CAC1B,CAAC;AAEF;;;;GAIG;AACH,SAAgB,mBAAmB,CAAC,UAAsB;IACxD,OAAO,8BAAsB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,KAAK,UAAU,CAAC,CAAC;AACzE,CAAC;AAFD,kDAEC"}
+{"version":3,"file":"HubPermissionPolicies.js","sourceRoot":"","sources":["../../../src/permissions/HubPermissionPolicies.ts"],"names":[],"mappings":";;;AAAA,8FAAgG;AAChG,qFAAuF;AACvF,4EAA+E;AAC/E,8FAAgG;AAChG,oFAAsF;AAGtF,+EAAiF;AACjF,4EAA8E;AAC9E,6EAA0E;AAC1E,uHAAyH;AACzH,2CAA2C;AAC3C,8DAA8D;AAC9D,MAAM;AACN,gDAAgD;AAChD,2BAA2B;AAC3B,iCAAiC;AACjC,8CAA8C;AAC9C,OAAO;AACP,MAAM;AACN,uDAAuD;AACvD,2BAA2B;AAC3B,8CAA8C;AAC9C,oBAAoB;AACpB,UAAU;AACV,iDAAiD;AACjD,gCAAgC;AAChC,kCAAkC;AAClC,WAAW;AACX,UAAU;AACV,2CAA2C;AAC3C,uCAAuC;AACvC,oCAAoC;AACpC,WAAW;AACX,SAAS;AACT,OAAO;AACP,MAAM;AACN,gDAAgD;AAChD,iCAAiC;AACjC,2BAA2B;AAC3B,8CAA8C;AAC9C,oBAAoB;AACpB,UAAU;AACV,2CAA2C;AAC3C,gCAAgC;AAChC,kCAAkC;AAClC,WAAW;AACX,SAAS;AACT,OAAO;AACP,MAAM;AACN,6CAA6C;AAC7C,iCAAiC;AACjC,2BAA2B;AAC3B,8CAA8C;AAC9C,oBAAoB;AACpB,UAAU;AACV,2CAA2C;AAC3C,gCAAgC;AAChC,kCAAkC;AAClC,WAAW;AACX,SAAS;AACT,OAAO;AACP,KAAK;AAEL,MAAM,sBAAsB,GAAwB;IAClD;QACE,yBAAyB;QACzB,UAAU,EAAE,yBAAyB;QACrC,YAAY,EAAE,CAAC,OAAO,CAAC;QACvB,YAAY,EAAE,CAAC,QAAQ,EAAE,OAAO,CAAC;KAClC;CACF,CAAC;AAEF;;GAEG;AACU,QAAA,sBAAsB,GAAwB;IACzD,GAAG,2CAAuB;IAC1B,GAAG,gDAAyB;IAC5B,GAAG,sDAA4B;IAC/B,GAAG,sDAA4B;IAC/B,GAAG,gDAAyB;IAC5B,GAAG,4CAAuB;IAC1B,GAAG,0CAAsB;IACzB,GAAG,uDAA0B;IAC7B,GAAG,sBAAsB;IACzB,GAAG,sEAAoC;CACxC,CAAC;AAEF;;;;GAIG;AACH,SAAgB,mBAAmB,CAAC,UAAsB;IACxD,OAAO,8BAAsB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,KAAK,UAAU,CAAC,CAAC;AACzE,CAAC;AAFD,kDAEC"}

package/dist/node/permissions/types/Permission.js

@@ -9,6 +9,7 @@ const ContentBusinessRules_1 = require("../../content/_internal/ContentBusinessR
 const GroupBusinessRules_1 = require("../../groups/_internal/GroupBusinessRules");
 const PageBusinessRules_1 = require("../../pages/_internal/PageBusinessRules");
 const PlatformPermissionPolicies_1 = require("../PlatformPermissionPolicies");
+const InitiativeTemplateBusinessRules_1 = require("../../initiative-templates/_internal/InitiativeTemplateBusinessRules");
 /**
  * Defines the values for Permissions
  * It's critical that the arrays defined in the modules use `as const`
@@ -27,6 +28,7 @@ const validPermissions = [
     ...PlatformPermissionPolicies_1.PlatformPermissions,
     ...TempPermissions,
     ...DiscussionBusinessRules_1.DiscussionPermissions,
+    ...InitiativeTemplateBusinessRules_1.InitiativeTemplatePermissions,
 ];
 /**
  * Validate a Permission

package/dist/node/permissions/types/Permission.js.map

@@ -1 +1 @@
-{"version":3,"file":"Permission.js","sourceRoot":"","sources":["../../../../src/permissions/types/Permission.ts"],"names":[],"mappings":";;;AAAA,wFAAmF;AACnF,+EAA0E;AAC1E,iGAA4F;AAC5F,iGAA4F;AAC5F,uFAAkF;AAClF,kFAA6E;AAC7E,+EAA0E;AAC1E,8EAAoE;AACpE;;;;GAIG;AACH,6EAA6E;AAC7E,kIAAkI;AAClI,MAAM,eAAe,GAAG,CAAC,yBAAyB,CAAC,CAAC;AAEpD,MAAM,gBAAgB,GAAG;IACvB,GAAG,mCAAe;IAClB,GAAG,yCAAkB;IACrB,GAAG,+CAAqB;IACxB,GAAG,yCAAkB;IACrB,GAAG,qCAAgB;IACnB,GAAG,mCAAe;IAClB,GAAG,gDAAmB;IACtB,GAAG,eAAe;IAClB,GAAG,+CAAqB;CAChB,CAAC;AAgBX;;;;GAIG;AACH,SAAgB,YAAY,CAAC,eAAuB;IAClD,OAAO,gBAAgB,CAAC,QAAQ,CAAC,eAA6B,CAAC,CAAC;AAClE,CAAC;AAFD,oCAEC"}
+{"version":3,"file":"Permission.js","sourceRoot":"","sources":["../../../../src/permissions/types/Permission.ts"],"names":[],"mappings":";;;AAAA,wFAAmF;AACnF,+EAA0E;AAC1E,iGAA4F;AAC5F,iGAA4F;AAC5F,uFAAkF;AAClF,kFAA6E;AAC7E,+EAA0E;AAC1E,8EAAoE;AACpE,0HAAqH;AACrH;;;;GAIG;AACH,6EAA6E;AAC7E,kIAAkI;AAClI,MAAM,eAAe,GAAG,CAAC,yBAAyB,CAAC,CAAC;AAEpD,MAAM,gBAAgB,GAAG;IACvB,GAAG,mCAAe;IAClB,GAAG,yCAAkB;IACrB,GAAG,+CAAqB;IACxB,GAAG,yCAAkB;IACrB,GAAG,qCAAgB;IACnB,GAAG,mCAAe;IAClB,GAAG,gDAAmB;IACtB,GAAG,eAAe;IAClB,GAAG,+CAAqB;IACxB,GAAG,+DAA6B;CACxB,CAAC;AAiBX;;;;GAIG;AACH,SAAgB,YAAY,CAAC,eAAuB;IAClD,OAAO,gBAAgB,CAAC,QAAQ,CAAC,eAA6B,CAAC,CAAC;AAClE,CAAC;AAFD,oCAEC"}

package/dist/node/projects/HubProject.js

@@ -111,7 +111,7 @@ class HubProject extends HubItemEntity_1.HubItemEntity {
     /*
      * Get a specific editor config for the HubProject entity.
      * @param i18nScope translation scope to be interpolated into the uiSchema
-     * @param type editor type - corresonds to the returned uiSchema
+     * @param type editor type - corresponds to the returned uiSchema
      * @param options optional hash of dynamic uiSchema element options
      */
     async getEditorConfig(i18nScope, type) {

package/dist/types/core/schemas/types.d.ts

@@ -5,7 +5,7 @@ import Ajv from "ajv";
  * to the supported/defined uiSchema configurations
  */
 export declare type EditorType = (typeof validEditorTypes)[number];
-export declare const validEditorTypes: readonly ["hub:project:create", "hub:project:edit", "hub:content:edit", "hub:content:settings", "hub:content:discussions", "hub:initiative:edit", "hub:initiative:create", "hub:site:edit", "hub:site:create", "hub:site:followers", "hub:site:discussions", "hub:discussion:edit", "hub:discussion:create", "hub:discussion:settings", "hub:page:edit", "hub:group:edit", "hub:group:settings", "hub:group:discussions"];
+export declare const validEditorTypes: readonly ["hub:project:create", "hub:project:edit", "hub:content:edit", "hub:content:settings", "hub:content:discussions", "hub:initiative:edit", "hub:initiative:create", "hub:site:edit", "hub:site:create", "hub:site:followers", "hub:site:discussions", "hub:discussion:edit", "hub:discussion:create", "hub:discussion:settings", "hub:page:edit", "hub:group:edit", "hub:group:settings", "hub:group:discussions", "hub:initiativeTemplate:edit"];
 export declare enum UiSchemaRuleEffects {
     SHOW = "SHOW",
     HIDE = "HIDE",

package/dist/types/core/types/HubEntityType.d.ts

@@ -1,2 +1,2 @@
-export declare const HUB_ENTITY_TYPES: readonly ["site", "project", "initiative", "page", "discussion", "content", "org", "group"];
+export declare const HUB_ENTITY_TYPES: readonly ["site", "project", "initiative", "initiativeTemplate", "page", "discussion", "content", "org", "group"];
 export declare type HubEntityType = (typeof HUB_ENTITY_TYPES)[number];

package/dist/types/core/types/IHubInitiativeTemplate.d.ts

@@ -0,0 +1,14 @@
+import { IHubItemEntity } from "./IHubItemEntity";
+import { IWithLayout, IWithSlug, IWithCatalog } from "../traits";
+import { IHubItemEntityEditor } from "./IHubItemEntity";
+/** Defines the properties of a Hub Initiative Template object */
+export interface IHubInitiativeTemplate extends IHubItemEntity, IWithSlug, IWithCatalog, IWithLayout {
+    previewUrl: string;
+    recommendedTemplates: string[];
+    siteSolutionId: string;
+}
+/**
+ * This type redefines the IHubInitiativeTemplate interface in such a way
+ * that it can be consumed by the entity editor.
+ */
+export declare type IHubInitiativeTemplateEditor = IHubItemEntityEditor<IHubInitiativeTemplate> & {};

package/dist/types/core/types/index.d.ts

@@ -11,6 +11,7 @@ export * from "./IHubEvent";
 export * from "./IHubGroup";
 export * from "./IHubImage";
 export * from "./IHubInitiative";
+export * from "./IHubInitiativeTemplate";
 export * from "./IHubItemEntity";
 export * from "./IHubLayout";
 export * from "./IHubLocation";

package/dist/types/index.d.ts

@@ -12,6 +12,7 @@ export * from "./extent";
 export * from "./groups";
 export * from "./i18n";
 export * from "./initiatives";
+export * from "./initiative-templates";
 export * from "./discussions";
 export * from "./items";
 export * from "./models";

package/dist/types/initiative-templates/HubInitiativeTemplate.d.ts

@@ -0,0 +1,82 @@
+import { HubItemEntity } from "../core/HubItemEntity";
+import { IHubInitiativeTemplate, IWithCatalogBehavior, IWithCardBehavior, IConvertToCardModelOpts, IHubCardViewModel, IEntityEditorContext, IHubInitiativeTemplateEditor, HubEntity } from "../core";
+import { IEditorConfig, IWithEditorBehavior } from "../core/behaviors/IWithEditorBehavior";
+import { EditorType } from "../core/schemas/types";
+import { IArcGISContext } from "..";
+import { Catalog } from "../search";
+/**
+ * Hub Initiative Template Class
+ */
+export declare class HubInitiativeTemplate extends HubItemEntity<IHubInitiativeTemplate> implements IWithCatalogBehavior, IWithEditorBehavior, IWithCardBehavior {
+    private _catalog;
+    private constructor();
+    get catalog(): Catalog;
+    /**
+     * Create an instance from an IHubInitiativeTemplate object
+     * @param json - JSON object to create a HubInitiativeTemplate from
+     * @param context - ArcGIS context
+     * @returns - instance of HubInitiativeTemplate
+     */
+    static fromJson(json: Partial<IHubInitiativeTemplate>, context: IArcGISContext): HubInitiativeTemplate;
+    /**
+     * Create a new HubInitiativeTemplate, returning a HubInitiativeTemplate instance.
+     * Note: This does not persist the HubInitiativeTemplate into the backing store
+     * @param partialInitiativeTemplate
+     * @param context
+     * @param save
+     * @returns
+     */
+    static create(partialInitiativeTemplate: Partial<IHubInitiativeTemplate>, context: IArcGISContext, save?: boolean): Promise<HubInitiativeTemplate>;
+    /**
+     * Fetch a HubInitiativeTemplate from the backing store and return a HubInitiativeTemplate instance.
+     * @param identifier - Identifier of the initiative template to load
+     * @param context
+     */
+    static fetch(identifier: string, context: IArcGISContext): Promise<HubInitiativeTemplate>;
+    /**
+     * Given a partial initiative template, apply defaults to it to ensure that a baseline of properties are set
+     * @param partialInitiativeTemplate
+     * @param context
+     * @returns
+     */
+    private static applyDefaults;
+    /**
+     * Convert the project entity into a card view model that can
+     * be consumed by the suite of hub gallery components
+     * @param opts - view model options
+     * @returns
+     */
+    convertToCardModel(opts?: IConvertToCardModelOpts): IHubCardViewModel;
+    /**
+     * Get the editor config for the HubInitiativeTemplate entity.
+     * @param i18nScope translation scope to be interpolated into the uiSchema
+     * @param type editor type -- corresponds to the returned uiSchema
+     */
+    getEditorConfig(i18nScope: string, type: EditorType): Promise<IEditorConfig>;
+    /**
+     * Return the initiative template as an editor object
+     * @param editorContext
+     */
+    toEditor(editorContext?: IEntityEditorContext, include?: string[]): Promise<IHubInitiativeTemplateEditor>;
+    /**
+     * Load the initiative template from the editor object
+     * @param editor
+     */
+    fromEditor(editor: IHubInitiativeTemplateEditor): Promise<HubEntity>;
+    /**
+     * Apply a new state to the instance
+     * @param changes
+     */
+    update(changes: Partial<IHubInitiativeTemplate>): void;
+    /**
+     * Save the HubInitiativeTemplate to the backing store.
+     * @returns
+     */
+    save(): Promise<void>;
+    /**
+     * Delete the HubInitiativeTemplate from the store
+     * set a flag to indicate that it is destroyed
+     * @returns
+     */
+    delete(): Promise<void>;
+}

package/dist/types/initiative-templates/_internal/InitiativeTemplateBusinessRules.d.ts

@@ -0,0 +1,16 @@
+import { IFeatureFlags, IPermissionPolicy } from "../../permissions";
+/**
+ * Default features for an Initiative Template. These are the features that can be enabled / disabled by the entity owner
+ */
+export declare const InitiativeTemplateDefaultFeatures: IFeatureFlags;
+/**
+ * Initiative Template Permission Policies
+ * These define the requirements any user must meet to perform related actions
+ * @private
+ */
+export declare const InitiativeTemplatePermissions: readonly ["hub:initiativeTemplate", "hub:initiativeTemplate:create", "hub:initiativeTemplate:delete", "hub:initiativeTemplate:edit", "hub:initiativeTemplate:view", "hub:initiativeTemplate:workspace:overview", "hub:initiativeTemplate:workspace:details", "hub:initiativeTemplate:workspace:collaborators", "hub:initiativeTemplate:workspace:settings", "hub:initiativeTemplate:manage"];
+/**
+ * Initiative Template policies
+ * @private
+ */
+export declare const InitiativeTemplatePermissionPolicies: IPermissionPolicy[];

package/dist/types/initiative-templates/_internal/InitiativeTemplateSchema.d.ts

@@ -0,0 +1,4 @@
+import { IConfigurationSchema } from "../../core";
+export declare type InitiativeTemplateEditorType = (typeof InitiativeTemplateEditorTypes)[number];
+export declare const InitiativeTemplateEditorTypes: readonly ["hub:initiativeTemplate:edit"];
+export declare const InitiativeTemplateSchema: IConfigurationSchema;

package/dist/types/initiative-templates/_internal/InitiativeTemplateUiSchemaEdit.d.ts

@@ -0,0 +1,15 @@
+import { IArcGISContext } from "../..";
+import { IHubInitiativeTemplate } from "../../core";
+import { IUiSchema } from "../../core/schemas/types";
+/**
+ * @private
+ * constructs the complete edit uiSchema for Hub Initiative Templates.
+ * This defines how the schema properties should be rendered
+ * in the initiative template editing experience.
+ *
+ * @param i18nScope
+ * @param entity
+ * @param context
+ * @returns
+ */
+export declare const buildUiSchema: (i18nScope: string, entity: IHubInitiativeTemplate, context: IArcGISContext) => Promise<IUiSchema>;

package/dist/types/initiative-templates/_internal/computeLinks.d.ts

@@ -0,0 +1,12 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IItem } from "@esri/arcgis-rest-types";
+import { IHubEntityLinks } from "../../core";
+/**
+ * Compute the links that get appended to a Hub Initiative Template
+ * search result and entity
+ *
+ * @param item
+ * @param requestOptions
+ * @returns
+ */
+export declare function computeLinks(item: IItem, requestOptions: IRequestOptions): IHubEntityLinks;

package/dist/types/initiative-templates/_internal/computeProps.d.ts

@@ -0,0 +1,12 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IHubInitiativeTemplate } from "../../core";
+import { IModel } from "../../types";
+/**
+ * Given a model and an initiative template, set various computed properties that can't be directly mapped
+ * @private
+ * @param model
+ * @param initiativeTemplate
+ * @param requestOptions
+ * @returns
+ */
+export declare function computeProps(model: IModel, initiativeTemplate: Partial<IHubInitiativeTemplate>, requestOptions: IRequestOptions): IHubInitiativeTemplate;

package/dist/types/initiative-templates/_internal/getPropertyMap.d.ts

@@ -0,0 +1,7 @@
+import { IPropertyMap } from "../../core/_internal/PropertyMapper";
+/**
+ * @private
+ * Returns an Array of IPropertyMap objects
+ * that define the projection of properties from an IModel to an IHubInitiativeTemplate
+ */
+export declare function getPropertyMap(): IPropertyMap[];

package/dist/types/initiative-templates/defaults.d.ts

@@ -0,0 +1,8 @@
+import { IHubInitiativeTemplate } from "../core/types/IHubInitiativeTemplate";
+import { IModel } from "../types";
+export declare const HUB_INITIATIVE_TEMPLATE_ITEM_TYPE = "Hub Initiative Template";
+/**
+ * Default values of a IHubInitiativeTemplate
+ */
+export declare const DEFAULT_INITIATIVE_TEMPLATE: Partial<IHubInitiativeTemplate>;
+export declare const DEFAULT_INITIATIVE_TEMPLATE_MODEL: IModel;

package/dist/types/initiative-templates/edit.d.ts

@@ -0,0 +1,32 @@
+import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import { IPortal } from "@esri/arcgis-rest-portal";
+import { IHubInitiativeTemplate, IHubInitiativeTemplateEditor } from "../core/types/IHubInitiativeTemplate";
+/**
+ * @private
+ * Create a new Hub Initiative Template item
+ * @param partialInitiativeTemplate
+ * @param requestOptions
+ * @returns
+ */
+export declare function createInitiativeTemplate(partialInitiativeTemplate: Partial<IHubInitiativeTemplate>, requestOptions: IUserRequestOptions): Promise<IHubInitiativeTemplate>;
+/**
+ * Convert an IHubInitiativeTemplateEditor back to an IHubInitiativeTemplate
+ * @param editor
+ * @param portal
+ * @returns
+ */
+export declare function editorToInitiativeTemplate(editor: IHubInitiativeTemplateEditor, portal: IPortal): IHubInitiativeTemplate;
+/**
+ * @private
+ * Update a Hub Initiative Template
+ * @param initiativeTemplate
+ * @param requestOptions
+ */
+export declare function updateInitiativeTemplate(initiativeTemplate: IHubInitiativeTemplate, requestOptions: IUserRequestOptions): Promise<IHubInitiativeTemplate>;
+/**
+ * @private
+ * Remove a Hub Initiative Template
+ * @param id
+ * @param requestOptions
+ */
+export declare function deleteInitiativeTemplate(id: string, requestOptions: IUserRequestOptions): Promise<void>;

package/dist/types/initiative-templates/fetch.d.ts

@@ -0,0 +1,16 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IItem } from "@esri/arcgis-rest-portal";
+import { IHubInitiativeTemplate } from "../core/types";
+import { IHubSearchResult } from "../search";
+import { IHubRequestOptions } from "../types";
+export declare function fetchInitiativeTemplate(identifier: string, requestOptions: IRequestOptions): Promise<IHubInitiativeTemplate>;
+/**
+ * @private
+ * Convert a Hub Initiative Template Item into a Hub Initiative Template, feching any additional
+ * information that may be required
+ * @param item
+ * @param requestOptions
+ * @returns
+ */
+export declare function convertItemToInitiativeTemplate(item: IItem, requestOptions: IRequestOptions): Promise<IHubInitiativeTemplate>;
+export declare function enrichInitiativeTemplateSearchResult(item: IItem, include: string[], requestOptions: IHubRequestOptions): Promise<IHubSearchResult>;

package/dist/types/initiative-templates/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./HubInitiativeTemplate";
+export * from "./edit";
+export * from "./fetch";
+export * from "./view";

package/dist/types/initiative-templates/view.d.ts

@@ -0,0 +1,20 @@
+import { IHubInitiativeTemplate } from "../core/types/IHubInitiativeTemplate";
+import { ResultToCardModelFn, EntityToCardModelFn } from "../core/types/IHubCardViewModel";
+/**
+ * Convert an initiative template entity into a card view model that can
+ * be consumed by the suite of hub gallery components
+ *
+ * @param initiativeTemplate initiative template entity
+ * @param context auth & portal information
+ * @param opts view model options
+ * @returns
+ */
+export declare const initiativeTemplateToCardModel: EntityToCardModelFn<IHubInitiativeTemplate>;
+/**
+ * Convert an initiative template hub search result into a card view model that
+ * can be consumed by the suite of hub gallery components
+ *
+ * @param searchResult hub initiative template search result
+ * @param opts view model options
+ */
+export declare const initiativeTemplateResultToCardModel: ResultToCardModelFn;

package/dist/types/permissions/types/Permission.d.ts

@@ -6,6 +6,7 @@ import { ContentPermissions } from "../../content/_internal/ContentBusinessRules
 import { GroupPermissions } from "../../groups/_internal/GroupBusinessRules";
 import { PagePermissions } from "../../pages/_internal/PageBusinessRules";
 import { PlatformPermissions } from "../PlatformPermissionPolicies";
+import { InitiativeTemplatePermissions } from "../../initiative-templates/_internal/InitiativeTemplateBusinessRules";
 /**
  * Defines the values for Permissions
  * It's critical that the arrays defined in the modules use `as const`
@@ -15,7 +16,7 @@ declare const TempPermissions: string[];
 /**
  * Defines the possible values for Permissions
  */
-export declare type Permission = (typeof SitePermissions)[number] | (typeof ProjectPermissions)[number] | (typeof InitiativePermissions)[number] | (typeof ContentPermissions)[number] | (typeof GroupPermissions)[number] | (typeof PagePermissions)[number] | (typeof PlatformPermissions)[number] | (typeof TempPermissions)[number] | (typeof DiscussionPermissions)[number];
+export declare type Permission = (typeof SitePermissions)[number] | (typeof ProjectPermissions)[number] | (typeof InitiativePermissions)[number] | (typeof ContentPermissions)[number] | (typeof GroupPermissions)[number] | (typeof PagePermissions)[number] | (typeof PlatformPermissions)[number] | (typeof TempPermissions)[number] | (typeof DiscussionPermissions)[number] | (typeof InitiativeTemplatePermissions)[number];
 /**
  * Validate a Permission
  * @param permission

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/hub-common",
-  "version": "14.24.0",
+  "version": "14.25.0",
   "description": "Common TypeScript types and utility functions for @esri/hub.js.",
   "main": "dist/node/index.js",
   "module": "dist/esm/index.js",