@esri/hub-common 14.26.2 → 14.28.0

package/dist/node/templates/HubTemplate.js

@@ -0,0 +1,182 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HubTemplate = void 0;
+const getEditorConfig_1 = require("../core/schemas/getEditorConfig");
+const HubItemEntity_1 = require("../core/HubItemEntity");
+const defaults_1 = require("./defaults");
+const edit_1 = require("./edit");
+const fetch_1 = require("./fetch");
+const enrichEntity_1 = require("../core/enrichEntity");
+const util_1 = require("../util");
+/**
+ * Hub Template Class - this class encapsulates the standard
+ * operations for a "Solution" item despite the Hub team not
+ * "owning" this item type. Our primary goal is to allow
+ * editing of the item's meta information, manage sharing, etc.
+ */
+class HubTemplate extends HubItemEntity_1.HubItemEntity {
+    /**
+     * Private constructor to allow for future
+     * template-specific logic
+     * @param template
+     * @param context
+     */
+    constructor(template, context) {
+        super(template, context);
+    }
+    /**
+     * Create an HubTemplate instance from an IHubTemplate object
+     * @param json - JSON object to create a HubTemplate from
+     * @param context - ArcGIS context
+     * @returns
+     */
+    static fromJson(json, context) {
+        // merge what we have with the default values
+        const pojo = this.applyDefaults(json, context);
+        return new HubTemplate(pojo, context);
+    }
+    /**
+     * Create a new HubTemplate, returning a HubTemplate instance.
+     * This does not automatically persist the Template into
+     * the backing store unless save is set to true
+     *
+     * NOTE: we have no immediate plans to allow template creation
+     * from the context of the Hub application, but scaffolding this
+     * method for potential future implementation. The underlying
+     * createTemplate function will throw an error if attempted.
+     * @param partialTemplate
+     * @param context
+     * @param save
+     */
+    static async create(partialTemplate, context, save = false) {
+        const pojo = this.applyDefaults(partialTemplate, context);
+        const instance = HubTemplate.fromJson(pojo, context);
+        if (save) {
+            await instance.save();
+        }
+        return instance;
+    }
+    /**
+     * Fetch a HubTemplate from the backing store and return
+     * a HubTemplate instance
+     * @param identifier
+     * @param context
+     */
+    static async fetch(identifier, context) {
+        try {
+            const initiativeTemplate = await fetch_1.fetchTemplate(identifier, context.requestOptions);
+            return HubTemplate.fromJson(initiativeTemplate, context);
+        }
+        catch (ex) {
+            if (ex.message ===
+                "CONT_0001: Item does not exist or is inaccessible.") {
+                throw new Error(`Template ${identifier} not found.`);
+            }
+            else {
+                throw ex;
+            }
+        }
+    }
+    /**
+     * Given a partial Template, apply defaults to
+     * it to ensure that a baseline of properties are set
+     * @param partialTemplate
+     * @param context
+     */
+    static applyDefaults(partialTemplate, context) {
+        // ensure we have the orgUrlKey
+        if (!partialTemplate.orgUrlKey) {
+            partialTemplate.orgUrlKey = context.portal.urlKey;
+        }
+        // extend the partial over the defaults
+        const pojo = Object.assign(Object.assign({}, defaults_1.DEFAULT_TEMPLATE), partialTemplate);
+        return pojo;
+    }
+    /*
+     * Get a specific editor config for the HubTemplate entity.
+     * @param i18nScope
+     * @param type
+     */
+    async getEditorConfig(i18nScope, type) {
+        // delegate to the schema subsystem
+        return getEditorConfig_1.getEditorConfig(i18nScope, type, this.entity, this.context);
+    }
+    /**
+     * Transform template entity into an editor object
+     * @param editorContext
+     */
+    async toEditor(editorContext = {}, include = []) {
+        // 1. optionally enrich entity and cast to editor
+        const editor = include.length
+            ? (await enrichEntity_1.enrichEntity(util_1.cloneObject(this.entity), include, this.context.hubRequestOptions))
+            : util_1.cloneObject(this.entity);
+        // 2. Apply transforms to relevant entity values so they
+        // can be consumed by the editor
+        return editor;
+    }
+    /**
+     * Transform editor values into a template entity
+     * @param editor
+     */
+    async fromEditor(editor) {
+        // Setting the thumbnailCache will ensure that the
+        // thumbnail is updated on the next save
+        if (editor._thumbnail) {
+            if (editor._thumbnail.blob) {
+                this.thumbnailCache = {
+                    file: editor._thumbnail.blob,
+                    filename: editor._thumbnail.filename,
+                    clear: false,
+                };
+            }
+            else {
+                this.thumbnailCache = {
+                    clear: true,
+                };
+            }
+        }
+        delete editor._thumbnail;
+        const entity = edit_1.editorToTemplate(editor, this.context.portal);
+        // save, which will also create
+        this.entity = entity;
+        await this.save();
+        return this.entity;
+    }
+    /**
+     * Update the instance's internal entity state
+     * @param changes
+     */
+    update(changes) {
+        if (this.isDestroyed) {
+            throw new Error("HubTemplate is already destroyed.");
+        }
+        this.entity = Object.assign(Object.assign({}, this.entity), changes);
+    }
+    /** Save the HubTemplate to the backing store */
+    async save() {
+        if (this.isDestroyed) {
+            throw new Error("HubTemplate is already destroyed.");
+        }
+        // 1. create or update. Note: the underlying createTemplate
+        // function will throw an error because we don't currently
+        // allow for template creation from the context of Hub
+        this.entity = this.entity.id
+            ? await edit_1.updateTemplate(this.entity, this.context.userRequestOptions)
+            : await edit_1.createTemplate(this.entity, this.context.userRequestOptions);
+        // 2. call the after save hook on HubItemEntity superclass
+        await super.afterSave();
+    }
+    /**
+     * Delete the Hub Template's backing item and set a flag
+     * indicating it's been destroyed
+     */
+    async delete() {
+        if (this.isDestroyed) {
+            throw new Error("HubTemplate is already destroyed.");
+        }
+        this.isDestroyed = true;
+        await edit_1.deleteTemplate(this.entity.id, this.context.userRequestOptions);
+    }
+}
+exports.HubTemplate = HubTemplate;
+//# sourceMappingURL=HubTemplate.js.map

package/dist/node/templates/HubTemplate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HubTemplate.js","sourceRoot":"","sources":["../../../src/templates/HubTemplate.ts"],"names":[],"mappings":";;;AACA,qEAAkE;AAElE,yDAAsD;AAGtD,yCAA8C;AAC9C,iCAKgB;AAChB,mCAAwC;AAExC,uDAAoD;AACpD,kCAAsC;AAEtC;;;;;GAKG;AACH,MAAa,WAAY,SAAQ,6BAA2B;IAC1D;;;;;OAKG;IACH,YAAoB,QAAsB,EAAE,OAAuB;QACjE,KAAK,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CACb,IAA2B,EAC3B,OAAuB;QAEvB,6CAA6C;QAC7C,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC/C,OAAO,IAAI,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,KAAK,CAAC,MAAM,CACjB,eAAsC,EACtC,OAAuB,EACvB,OAAgB,KAAK;QAErB,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;QAC1D,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACrD,IAAI,IAAI,EAAE;YACR,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;SACvB;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,KAAK,CAChB,UAAkB,EAClB,OAAuB;QAEvB,IAAI;YACF,MAAM,kBAAkB,GAAG,MAAM,qBAAa,CAC5C,UAAU,EACV,OAAO,CAAC,cAAc,CACvB,CAAC;YACF,OAAO,WAAW,CAAC,QAAQ,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;SAC1D;QAAC,OAAO,EAAE,EAAE;YACX,IACG,EAAY,CAAC,OAAO;gBACrB,oDAAoD,EACpD;gBACA,MAAM,IAAI,KAAK,CAAC,YAAY,UAAU,aAAa,CAAC,CAAC;aACtD;iBAAM;gBACL,MAAM,EAAE,CAAC;aACV;SACF;IACH,CAAC;IAED;;;;;OAKG;IACK,MAAM,CAAC,aAAa,CAC1B,eAAsC,EACtC,OAAuB;QAEvB,+BAA+B;QAC/B,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE;YAC9B,eAAe,CAAC,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC;SACnD;QACD,uCAAuC;QACvC,MAAM,IAAI,GAAG,gCAAK,2BAAgB,GAAK,eAAe,CAAkB,CAAC;QACzE,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,eAAe,CACnB,SAAiB,EACjB,IAAwB;QAExB,mCAAmC;QACnC,OAAO,iCAAe,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACrE,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,QAAQ,CACZ,gBAAsC,EAAE,EACxC,UAAoB,EAAE;QAEtB,iDAAiD;QACjD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM;YAC3B,CAAC,CAAE,CAAC,MAAM,2BAAY,CAClB,kBAAW,CAAC,IAAI,CAAC,MAAM,CAAC,EACxB,OAAO,EACP,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAC/B,CAAwB;YAC3B,CAAC,CAAE,kBAAW,CAAC,IAAI,CAAC,MAAM,CAAwB,CAAC;QAErD,wDAAwD;QACxD,gCAAgC;QAEhC,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,UAAU,CAAC,MAA0B;QACzC,kDAAkD;QAClD,wCAAwC;QACxC,IAAI,MAAM,CAAC,UAAU,EAAE;YACrB,IAAI,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE;gBAC1B,IAAI,CAAC,cAAc,GAAG;oBACpB,IAAI,EAAE,MAAM,CAAC,UAAU,CAAC,IAAI;oBAC5B,QAAQ,EAAE,MAAM,CAAC,UAAU,CAAC,QAAQ;oBACpC,KAAK,EAAE,KAAK;iBACb,CAAC;aACH;iBAAM;gBACL,IAAI,CAAC,cAAc,GAAG;oBACpB,KAAK,EAAE,IAAI;iBACZ,CAAC;aACH;SACF;QAED,OAAO,MAAM,CAAC,UAAU,CAAC;QAEzB,MAAM,MAAM,GAAG,uBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAE7D,+BAA+B;QAC/B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QAElB,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,OAA8B;QACnC,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;SACtD;QAED,IAAI,CAAC,MAAM,mCAAQ,IAAI,CAAC,MAAM,GAAK,OAAO,CAAE,CAAC;IAC/C,CAAC;IAED,gDAAgD;IAChD,KAAK,CAAC,IAAI;QACR,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;SACtD;QAED,2DAA2D;QAC3D,0DAA0D;QAC1D,sDAAsD;QACtD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,EAAE;YAC1B,CAAC,CAAC,MAAM,qBAAc,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACpE,CAAC,CAAC,MAAM,qBAAc,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QAEvE,0DAA0D;QAC1D,MAAM,KAAK,CAAC,SAAS,EAAE,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM;QACV,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;SACtD;QAED,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,MAAM,qBAAc,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACxE,CAAC;CACF;AAhND,kCAgNC"}

package/dist/node/templates/_internal/TemplateBusinessRules.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TemplatePermissionPolicies = exports.TemplatePermissions = exports.TemplateDefaultFeatures = void 0;
+/**
+ * Default features for a Template. These are the features
+ * that can be enabled / disabled by the entity owner
+ */
+exports.TemplateDefaultFeatures = {};
+/**
+ * @private
+ * Template permissions: these define the requirements
+ * any user must meet to perform related actions
+ */
+exports.TemplatePermissions = [
+    "hub:template",
+    "hub:template:create",
+    "hub:template:delete",
+    "hub:template:edit",
+    "hub:template:manage",
+    "hub:template:view",
+    "hub:template:workspace:overview",
+    "hub:template:workspace:details",
+    "hub:template:workspace:dashboard",
+    "hub:template:workspace:collaborators",
+    "hub:template:workspace:settings",
+];
+/**
+ * @private
+ * Template permission policies
+ */
+exports.TemplatePermissionPolicies = [
+    {
+        permission: "hub:template",
+        availability: ["alpha"],
+        services: ["portal"],
+    },
+    {
+        permission: "hub:template:create",
+        dependencies: ["hub:template"],
+        authenticated: true,
+        privileges: ["portal:user:createItem"],
+    },
+    {
+        permission: "hub:template:delete",
+        dependencies: ["hub:template"],
+        authenticated: true,
+        entityOwner: true,
+    },
+    {
+        permission: "hub:template:view",
+        dependencies: ["hub:template"],
+    },
+    {
+        permission: "hub:template:edit",
+        dependencies: ["hub:template"],
+        authenticated: true,
+        entityEdit: true,
+    },
+    {
+        permission: "hub:template:manage",
+        dependencies: ["hub:template:edit"],
+    },
+    {
+        permission: "hub:template:workspace:overview",
+        dependencies: ["hub:template:view"],
+    },
+    {
+        permission: "hub:template:workspace:details",
+        dependencies: ["hub:template:manage"],
+    },
+    {
+        permission: "hub:template:workspace:dashboard",
+        dependencies: ["hub:template:manage"],
+    },
+    {
+        permission: "hub:template:workspace:collaborators",
+        dependencies: ["hub:template:manage"],
+    },
+    {
+        permission: "hub:template:workspace:settings",
+        dependencies: ["hub:template:manage"],
+        entityOwner: true,
+    },
+];
+//# sourceMappingURL=TemplateBusinessRules.js.map

package/dist/node/templates/_internal/TemplateBusinessRules.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TemplateBusinessRules.js","sourceRoot":"","sources":["../../../../src/templates/_internal/TemplateBusinessRules.ts"],"names":[],"mappings":";;;AAEA;;;GAGG;AACU,QAAA,uBAAuB,GAAkB,EAAE,CAAC;AAEzD;;;;GAIG;AACU,QAAA,mBAAmB,GAAG;IACjC,cAAc;IACd,qBAAqB;IACrB,qBAAqB;IACrB,mBAAmB;IACnB,qBAAqB;IACrB,mBAAmB;IACnB,iCAAiC;IACjC,gCAAgC;IAChC,kCAAkC;IAClC,sCAAsC;IACtC,iCAAiC;CACzB,CAAC;AAEX;;;GAGG;AACU,QAAA,0BAA0B,GAAwB;IAC7D;QACE,UAAU,EAAE,cAAc;QAC1B,YAAY,EAAE,CAAC,OAAO,CAAC;QACvB,QAAQ,EAAE,CAAC,QAAQ,CAAC;KACrB;IACD;QACE,UAAU,EAAE,qBAAqB;QACjC,YAAY,EAAE,CAAC,cAAc,CAAC;QAC9B,aAAa,EAAE,IAAI;QACnB,UAAU,EAAE,CAAC,wBAAwB,CAAC;KACvC;IACD;QACE,UAAU,EAAE,qBAAqB;QACjC,YAAY,EAAE,CAAC,cAAc,CAAC;QAC9B,aAAa,EAAE,IAAI;QACnB,WAAW,EAAE,IAAI;KAClB;IACD;QACE,UAAU,EAAE,mBAAmB;QAC/B,YAAY,EAAE,CAAC,cAAc,CAAC;KAC/B;IACD;QACE,UAAU,EAAE,mBAAmB;QAC/B,YAAY,EAAE,CAAC,cAAc,CAAC;QAC9B,aAAa,EAAE,IAAI;QACnB,UAAU,EAAE,IAAI;KACjB;IACD;QACE,UAAU,EAAE,qBAAqB;QACjC,YAAY,EAAE,CAAC,mBAAmB,CAAC;KACpC;IACD;QACE,UAAU,EAAE,iCAAiC;QAC7C,YAAY,EAAE,CAAC,mBAAmB,CAAC;KACpC;IACD;QACE,UAAU,EAAE,gCAAgC;QAC5C,YAAY,EAAE,CAAC,qBAAqB,CAAC;KACtC;IACD;QACE,UAAU,EAAE,kCAAkC;QAC9C,YAAY,EAAE,CAAC,qBAAqB,CAAC;KACtC;IACD;QACE,UAAU,EAAE,sCAAsC;QAClD,YAAY,EAAE,CAAC,qBAAqB,CAAC;KACtC;IACD;QACE,UAAU,EAAE,iCAAiC;QAC7C,YAAY,EAAE,CAAC,qBAAqB,CAAC;QACrC,WAAW,EAAE,IAAI;KAClB;CACF,CAAC"}

package/dist/node/templates/_internal/TemplateSchema.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TemplateSchema = exports.TemplateEditorTypes = void 0;
+const HubItemEntitySchema_1 = require("../../core/schemas/shared/HubItemEntitySchema");
+exports.TemplateEditorTypes = ["hub:template:edit"];
+exports.TemplateSchema = Object.assign(Object.assign({}, HubItemEntitySchema_1.HubItemEntitySchema), { properties: Object.assign(Object.assign({}, HubItemEntitySchema_1.HubItemEntitySchema.properties), { previewUrl: {
+            type: "string",
+            if: { minLength: 1 },
+            then: { format: "uri" },
+        } }) });
+//# sourceMappingURL=TemplateSchema.js.map

package/dist/node/templates/_internal/TemplateSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TemplateSchema.js","sourceRoot":"","sources":["../../../../src/templates/_internal/TemplateSchema.ts"],"names":[],"mappings":";;;AACA,uFAAoF;AAIvE,QAAA,mBAAmB,GAAG,CAAC,mBAAmB,CAAU,CAAC;AAErD,QAAA,cAAc,GAAyB,gCAC/C,yCAAmB,KACtB,UAAU,kCACL,yCAAmB,CAAC,UAAU,KACjC,UAAU,EAAE;YACV,IAAI,EAAE,QAAQ;YACd,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE;YACpB,IAAI,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE;SACxB,MAEoB,CAAC"}

package/dist/node/templates/_internal/TemplateUiSchemaEdit.js

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildUiSchema = void 0;
+const types_1 = require("../../core/schemas/types");
+/**
+ * @private
+ * constructs the complete edit uiSchema for Hub Templates.
+ * This defines how the schema properties should be rendered
+ * in the template editing experience.
+ *
+ * @param i18nScope
+ * @param entity
+ * @param context
+ * @returns
+ */
+exports.buildUiSchema = async (i18nScope, entity, context) => {
+    return {
+        type: "Layout",
+        elements: [
+            {
+                type: "Section",
+                labelKey: `${i18nScope}.sections.basicInfo.label`,
+                elements: [
+                    {
+                        type: "Control",
+                        scope: "/properties/name",
+                        labelKey: `${i18nScope}.fields.name.label`,
+                        options: {
+                            messages: [
+                                {
+                                    type: types_1.UiSchemaMessageTypes.error,
+                                    keyword: "required",
+                                    icon: true,
+                                    labelKey: `${i18nScope}.fields.name.requiredError`,
+                                },
+                            ],
+                        },
+                    },
+                    {
+                        type: "Control",
+                        scope: "/properties/previewUrl",
+                        labelKey: `${i18nScope}.fields.previewUrl.label`,
+                        options: {
+                            helperText: {
+                                labelKey: `${i18nScope}.fields.previewUrl.helperText`,
+                            },
+                            messages: [
+                                {
+                                    type: "ERROR",
+                                    keyword: "if",
+                                    hidden: true,
+                                },
+                            ],
+                        },
+                    },
+                    {
+                        labelKey: `${i18nScope}.fields.summary.label`,
+                        scope: "/properties/summary",
+                        type: "Control",
+                        options: {
+                            control: "hub-field-input-input",
+                            type: "textarea",
+                            helperText: {
+                                labelKey: `${i18nScope}.fields.summary.helperText`,
+                            },
+                        },
+                    },
+                    {
+                        labelKey: `${i18nScope}.fields.description.label`,
+                        scope: "/properties/description",
+                        type: "Control",
+                        options: {
+                            control: "hub-field-input-input",
+                            type: "textarea",
+                            helperText: {
+                                labelKey: `${i18nScope}.fields.description.helperText`,
+                            },
+                        },
+                    },
+                    {
+                        labelKey: `${i18nScope}.fields.thumbnail.label`,
+                        scope: "/properties/_thumbnail",
+                        type: "Control",
+                        options: {
+                            control: "hub-field-input-image-picker",
+                            imgSrc: entity.thumbnailUrl,
+                            maxWidth: 727,
+                            maxHeight: 484,
+                            aspectRatio: 1.5,
+                            helperText: {
+                                labelKey: `${i18nScope}.fields.thumbnail.helperText`,
+                            },
+                        },
+                    },
+                ],
+            },
+        ],
+    };
+};
+//# sourceMappingURL=TemplateUiSchemaEdit.js.map

package/dist/node/templates/_internal/TemplateUiSchemaEdit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TemplateUiSchemaEdit.js","sourceRoot":"","sources":["../../../../src/templates/_internal/TemplateUiSchemaEdit.ts"],"names":[],"mappings":";;;AACA,oDAA2E;AAG3E;;;;;;;;;;GAUG;AACU,QAAA,aAAa,GAAG,KAAK,EAChC,SAAiB,EACjB,MAAoB,EACpB,OAAuB,EACH,EAAE;IACtB,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE;YACR;gBACE,IAAI,EAAE,SAAS;gBACf,QAAQ,EAAE,GAAG,SAAS,2BAA2B;gBACjD,QAAQ,EAAE;oBACR;wBACE,IAAI,EAAE,SAAS;wBACf,KAAK,EAAE,kBAAkB;wBACzB,QAAQ,EAAE,GAAG,SAAS,oBAAoB;wBAC1C,OAAO,EAAE;4BACP,QAAQ,EAAE;gCACR;oCACE,IAAI,EAAE,4BAAoB,CAAC,KAAK;oCAChC,OAAO,EAAE,UAAU;oCACnB,IAAI,EAAE,IAAI;oCACV,QAAQ,EAAE,GAAG,SAAS,4BAA4B;iCACnD;6BACF;yBACF;qBACF;oBACD;wBACE,IAAI,EAAE,SAAS;wBACf,KAAK,EAAE,wBAAwB;wBAC/B,QAAQ,EAAE,GAAG,SAAS,0BAA0B;wBAChD,OAAO,EAAE;4BACP,UAAU,EAAE;gCACV,QAAQ,EAAE,GAAG,SAAS,+BAA+B;6BACtD;4BACD,QAAQ,EAAE;gCACR;oCACE,IAAI,EAAE,OAAO;oCACb,OAAO,EAAE,IAAI;oCACb,MAAM,EAAE,IAAI;iCACb;6BACF;yBACF;qBACF;oBACD;wBACE,QAAQ,EAAE,GAAG,SAAS,uBAAuB;wBAC7C,KAAK,EAAE,qBAAqB;wBAC5B,IAAI,EAAE,SAAS;wBACf,OAAO,EAAE;4BACP,OAAO,EAAE,uBAAuB;4BAChC,IAAI,EAAE,UAAU;4BAChB,UAAU,EAAE;gCACV,QAAQ,EAAE,GAAG,SAAS,4BAA4B;6BACnD;yBACF;qBACF;oBACD;wBACE,QAAQ,EAAE,GAAG,SAAS,2BAA2B;wBACjD,KAAK,EAAE,yBAAyB;wBAChC,IAAI,EAAE,SAAS;wBACf,OAAO,EAAE;4BACP,OAAO,EAAE,uBAAuB;4BAChC,IAAI,EAAE,UAAU;4BAChB,UAAU,EAAE;gCACV,QAAQ,EAAE,GAAG,SAAS,gCAAgC;6BACvD;yBACF;qBACF;oBACD;wBACE,QAAQ,EAAE,GAAG,SAAS,yBAAyB;wBAC/C,KAAK,EAAE,wBAAwB;wBAC/B,IAAI,EAAE,SAAS;wBACf,OAAO,EAAE;4BACP,OAAO,EAAE,8BAA8B;4BACvC,MAAM,EAAE,MAAM,CAAC,YAAY;4BAC3B,QAAQ,EAAE,GAAG;4BACb,SAAS,EAAE,GAAG;4BACd,WAAW,EAAE,GAAG;4BAChB,UAAU,EAAE;gCACV,QAAQ,EAAE,GAAG,SAAS,8BAA8B;6BACrD;yBACF;qBACF;iBACF;aACF;SACF;KACF,CAAC;AACJ,CAAC,CAAC"}

package/dist/node/templates/_internal/computeLinks.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.computeLinks = void 0;
+const urls_1 = require("../../urls");
+const items_1 = require("../../items");
+const internalContentUtils_1 = require("../../content/_internal/internalContentUtils");
+const getRelativeWorkspaceUrl_1 = require("../../core/getRelativeWorkspaceUrl");
+const get_item_thumbnail_url_1 = require("../../resources/get-item-thumbnail-url");
+/**
+ * Compute the links that get appended to a Hub Template
+ * search result and entity
+ *
+ * @param item
+ * @param requestOptions
+ */
+function computeLinks(item, requestOptions) {
+    let token;
+    if (requestOptions.authentication) {
+        const session = requestOptions.authentication;
+        token = session.token;
+    }
+    return {
+        self: urls_1.getItemHomeUrl(item.id, requestOptions),
+        siteRelative: internalContentUtils_1.getHubRelativeUrl(item.type, items_1.getItemIdentifier(item), item.typeKeywords),
+        workspaceRelative: getRelativeWorkspaceUrl_1.getRelativeWorkspaceUrl(item.type, items_1.getItemIdentifier(item)),
+        thumbnail: get_item_thumbnail_url_1.getItemThumbnailUrl(item, requestOptions, token),
+    };
+}
+exports.computeLinks = computeLinks;
+//# sourceMappingURL=computeLinks.js.map

package/dist/node/templates/_internal/computeLinks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"computeLinks.js","sourceRoot":"","sources":["../../../../src/templates/_internal/computeLinks.ts"],"names":[],"mappings":";;;AAGA,qCAA4C;AAE5C,uCAAgD;AAChD,uFAAiF;AACjF,gFAA6E;AAC7E,mFAA6E;AAE7E;;;;;;GAMG;AACH,SAAgB,YAAY,CAC1B,IAAW,EACX,cAA+B;IAE/B,IAAI,KAAa,CAAC;IAClB,IAAI,cAAc,CAAC,cAAc,EAAE;QACjC,MAAM,OAAO,GAAgB,cAAc,CAAC,cAA6B,CAAC;QAC1E,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;KACvB;IAED,OAAO;QACL,IAAI,EAAE,qBAAc,CAAC,IAAI,CAAC,EAAE,EAAE,cAAc,CAAC;QAC7C,YAAY,EAAE,wCAAiB,CAC7B,IAAI,CAAC,IAAI,EACT,yBAAiB,CAAC,IAAI,CAAC,EACvB,IAAI,CAAC,YAAY,CAClB;QACD,iBAAiB,EAAE,iDAAuB,CACxC,IAAI,CAAC,IAAI,EACT,yBAAiB,CAAC,IAAI,CAAC,CACxB;QACD,SAAS,EAAE,4CAAmB,CAAC,IAAI,EAAE,cAAc,EAAE,KAAK,CAAC;KAC5D,CAAC;AACJ,CAAC;AAvBD,oCAuBC"}

package/dist/node/templates/_internal/computeProps.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.computeProps = void 0;
+const utils_1 = require("../../discussions/utils");
+const processEntityFeatures_1 = require("../../permissions/_internal/processEntityFeatures");
+const TemplateBusinessRules_1 = require("./TemplateBusinessRules");
+const computeLinks_1 = require("./computeLinks");
+const objects_1 = require("../../objects");
+const utils_2 = require("../utils");
+/**
+ * @private
+ * Given a model and a template, set various computed
+ * properties on the template that can't be directly
+ * mapped from the model
+ * @param model
+ * @param template
+ * @param requestOptions
+ */
+function computeProps(model, template, requestOptions) {
+    // 1. compute relevant template links
+    template.links = computeLinks_1.computeLinks(model.item, requestOptions);
+    // 2. append the template's thumbnail url at the top-level
+    template.thumbnailUrl = template.links.thumbnail;
+    // 3. compute relevant template dates
+    template.createdDate = new Date(model.item.created);
+    template.createdDateSource = "item.created";
+    template.updatedDate = new Date(model.item.modified);
+    template.updatedDateSource = "item.modified";
+    // 4. determine whether the template is discussable
+    template.isDiscussable = utils_1.isDiscussable(template);
+    // 5. process features that can be disabled by the entity owner
+    template.features = processEntityFeatures_1.processEntityFeatures(objects_1.getProp(model, "data.settings.features") || {}, TemplateBusinessRules_1.TemplateDefaultFeatures);
+    // 6. compute additional template-specific properties
+    template.isDeployed = (objects_1.getProp(model, "item.typeKeywords") || []).includes("Deployed");
+    template.deployedType = utils_2.getDeployedTemplateType(model.item);
+    // 7. cast b/c this takes a partial but returns a full template
+    return template;
+}
+exports.computeProps = computeProps;
+//# sourceMappingURL=computeProps.js.map

package/dist/node/templates/_internal/computeProps.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"computeProps.js","sourceRoot":"","sources":["../../../../src/templates/_internal/computeProps.ts"],"names":[],"mappings":";;;AACA,mDAAwD;AACxD,6FAA0F;AAE1F,mEAAkE;AAElE,iDAA8C;AAC9C,2CAAwC;AACxC,oCAAmD;AAEnD;;;;;;;;GAQG;AACH,SAAgB,YAAY,CAC1B,KAAa,EACb,QAA+B,EAC/B,cAA+B;IAE/B,qCAAqC;IACrC,QAAQ,CAAC,KAAK,GAAG,2BAAY,CAAC,KAAK,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;IAE1D,0DAA0D;IAC1D,QAAQ,CAAC,YAAY,GAAG,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC;IAEjD,qCAAqC;IACrC,QAAQ,CAAC,WAAW,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACpD,QAAQ,CAAC,iBAAiB,GAAG,cAAc,CAAC;IAC5C,QAAQ,CAAC,WAAW,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACrD,QAAQ,CAAC,iBAAiB,GAAG,eAAe,CAAC;IAE7C,mDAAmD;IACnD,QAAQ,CAAC,aAAa,GAAG,qBAAa,CAAC,QAAQ,CAAC,CAAC;IAEjD,+DAA+D;IAC/D,QAAQ,CAAC,QAAQ,GAAG,6CAAqB,CACvC,iBAAO,CAAC,KAAK,EAAE,wBAAwB,CAAC,IAAI,EAAE,EAC9C,+CAAuB,CACxB,CAAC;IAEF,qDAAqD;IACrD,QAAQ,CAAC,UAAU,GAAG,CAAC,iBAAO,CAAC,KAAK,EAAE,mBAAmB,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,CACxE,UAAU,CACX,CAAC;IACF,QAAQ,CAAC,YAAY,GAAG,+BAAuB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAE5D,+DAA+D;IAC/D,OAAO,QAAwB,CAAC;AAClC,CAAC;AAlCD,oCAkCC"}

package/dist/node/templates/_internal/getPropertyMap.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPropertyMap = void 0;
+const getBasePropertyMap_1 = require("../../core/_internal/getBasePropertyMap");
+/**
+ * @private
+ * Returns an Array of IPropertyMap objects that
+ * define the projection of properties from an
+ * IModel to an IHubTemplate
+ */
+function getPropertyMap() {
+    const map = getBasePropertyMap_1.getBasePropertyMap();
+    // IHubTemplate specific mappings
+    map.push({ entityKey: "previewUrl", storeKey: "item.properties.previewUrl" });
+    return map;
+}
+exports.getPropertyMap = getPropertyMap;
+//# sourceMappingURL=getPropertyMap.js.map

package/dist/node/templates/_internal/getPropertyMap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getPropertyMap.js","sourceRoot":"","sources":["../../../../src/templates/_internal/getPropertyMap.ts"],"names":[],"mappings":";;;AAAA,gFAA6E;AAG7E;;;;;GAKG;AACH,SAAgB,cAAc;IAC5B,MAAM,GAAG,GAAG,uCAAkB,EAAE,CAAC;IAEjC,iCAAiC;IACjC,GAAG,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,YAAY,EAAE,QAAQ,EAAE,4BAA4B,EAAE,CAAC,CAAC;IAE9E,OAAO,GAAG,CAAC;AACb,CAAC;AAPD,wCAOC"}

package/dist/node/templates/defaults.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_TEMPLATE_MODEL = exports.DEFAULT_TEMPLATE = exports.HUB_TEMPLATE_ITEM_TYPE = void 0;
+const TemplateBusinessRules_1 = require("./_internal/TemplateBusinessRules");
+/**
+ * NOTE: this file provides default values for new
+ * Hub Template creation; however, we have no immediate
+ * plans to allow template creation from the context of
+ * our application. Scaffolding these defaults for
+ * potential future implementation
+ */
+exports.HUB_TEMPLATE_ITEM_TYPE = "Solution";
+/** Default values for a new IHubTemplate */
+exports.DEFAULT_TEMPLATE = {
+    schemaVersion: 1,
+    catalog: { schemaVersion: 0 },
+    name: "",
+    tags: [],
+    typeKeywords: [exports.HUB_TEMPLATE_ITEM_TYPE],
+    view: {},
+    permissions: [],
+    features: TemplateBusinessRules_1.TemplateDefaultFeatures,
+};
+/** Default values for a new HubTemplate Model (backing item) */
+exports.DEFAULT_TEMPLATE_MODEL = {
+    item: {
+        type: exports.HUB_TEMPLATE_ITEM_TYPE,
+        title: "",
+        description: "",
+        snippet: "",
+        tags: [],
+        typeKeywords: [exports.HUB_TEMPLATE_ITEM_TYPE],
+        properties: {
+            slug: "",
+            schemaVersion: 1,
+        },
+    },
+    data: {
+        permissions: [],
+        view: {},
+    },
+};
+//# sourceMappingURL=defaults.js.map

package/dist/node/templates/defaults.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaults.js","sourceRoot":"","sources":["../../../src/templates/defaults.ts"],"names":[],"mappings":";;;AACA,6EAA4E;AAG5E;;;;;;GAMG;AAEU,QAAA,sBAAsB,GAAG,UAAU,CAAC;AAEjD,4CAA4C;AAC/B,QAAA,gBAAgB,GAA0B;IACrD,aAAa,EAAE,CAAC;IAChB,OAAO,EAAE,EAAE,aAAa,EAAE,CAAC,EAAE;IAC7B,IAAI,EAAE,EAAE;IACR,IAAI,EAAE,EAAE;IACR,YAAY,EAAE,CAAC,8BAAsB,CAAC;IACtC,IAAI,EAAE,EAAE;IACR,WAAW,EAAE,EAAE;IACf,QAAQ,EAAE,+CAAuB;CAClC,CAAC;AAEF,gEAAgE;AACnD,QAAA,sBAAsB,GAAW;IAC5C,IAAI,EAAE;QACJ,IAAI,EAAE,8BAAsB;QAC5B,KAAK,EAAE,EAAE;QACT,WAAW,EAAE,EAAE;QACf,OAAO,EAAE,EAAE;QACX,IAAI,EAAE,EAAE;QACR,YAAY,EAAE,CAAC,8BAAsB,CAAC;QACtC,UAAU,EAAE;YACV,IAAI,EAAE,EAAE;YACR,aAAa,EAAE,CAAC;SACjB;KACF;IACD,IAAI,EAAE;QACJ,WAAW,EAAE,EAAE;QACf,IAAI,EAAE,EAAE;KACT;CACmB,CAAC"}

package/dist/node/templates/edit.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteTemplate = exports.editorToTemplate = exports.updateTemplate = exports.createTemplate = void 0;
+const slugs_1 = require("../items/slugs");
+const discussions_1 = require("../discussions");
+const PropertyMapper_1 = require("../core/_internal/PropertyMapper");
+const util_1 = require("../util");
+const models_1 = require("../models");
+const getPropertyMap_1 = require("./_internal/getPropertyMap");
+const computeProps_1 = require("./_internal/computeProps");
+const arcgis_rest_portal_1 = require("@esri/arcgis-rest-portal");
+/**
+ * @private
+ * Creates a Hub Template's backing Solution item and returns
+ * the created entity
+ *
+ * NOTE: We have no immediate plans to allow template creation
+ * from the context of the Hub application, but scaffolding
+ * this util for potential future implementation. For now,
+ * we will throw an error
+ * @param partialTemplate
+ * @param requestOptions
+ */
+function createTemplate(partialTemplate, requestOptions) {
+    throw new Error("Template creation is not currently supported from the context of Hub");
+}
+exports.createTemplate = createTemplate;
+/**
+ * @private
+ * Updates a Hub Template's backing item and returns
+ * the updated entity
+ * @param template
+ * @param requestOptions
+ */
+async function updateTemplate(template, requestOptions) {
+    // 1. Verify the slug is unique, excluding the current template
+    template.slug = await slugs_1.getUniqueSlug({ slug: template.slug, existingId: template.id }, requestOptions);
+    // 2. Update relevant typeKeywords
+    template.typeKeywords = discussions_1.setDiscussableKeyword(template.typeKeywords, template.isDiscussable);
+    // 3. Fetch the backing model (item + data)
+    const model = await models_1.getModel(template.id, requestOptions);
+    // 4. Create a property mapper between the template
+    // object and item model
+    const mapper = new PropertyMapper_1.PropertyMapper(getPropertyMap_1.getPropertyMap());
+    // 5. Create item model from updated template object, using
+    // the existing model as a starting point
+    const modelToUpdate = mapper.entityToStore(template, model);
+    // 6. Update the backing item
+    const updatedModel = await models_1.updateModel(modelToUpdate, requestOptions);
+    // 7. Map the item back into an IHubTemplate
+    const updatedTemplate = mapper.storeToEntity(updatedModel, template);
+    // 8. Compute + set various properties on the IHubTemplate
+    // that cannot be directly mapped from the item
+    template = computeProps_1.computeProps(model, updatedTemplate, requestOptions);
+    return updatedTemplate;
+}
+exports.updateTemplate = updateTemplate;
+/**
+ * Convert an IHubTemplateEditor back into a IHubTemplate
+ * @param editor
+ * @param portal
+ */
+function editorToTemplate(editor, portal) {
+    // 1. cast editor to IHubTemplate
+    const template = util_1.cloneObject(editor);
+    // 2. ensure there's an org url key
+    template.orgUrlKey = editor.orgUrlKey ? editor.orgUrlKey : portal.urlKey;
+    return template;
+}
+exports.editorToTemplate = editorToTemplate;
+/**
+ * @private
+ * Remove a Hub Template's backing item
+ * @param id
+ * @param requestOptions
+ */
+async function deleteTemplate(id, requestOptions) {
+    const ro = Object.assign(Object.assign({}, requestOptions), { id });
+    await arcgis_rest_portal_1.removeItem(ro);
+    return;
+}
+exports.deleteTemplate = deleteTemplate;
+//# sourceMappingURL=edit.js.map

package/dist/node/templates/edit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"edit.js","sourceRoot":"","sources":["../../../src/templates/edit.ts"],"names":[],"mappings":";;;AAEA,0CAA+C;AAC/C,gDAAuD;AACvD,qEAAkE;AAElE,kCAAsC;AACtC,sCAAkD;AAClD,+DAA4D;AAC5D,2DAAwD;AACxD,iEAIkC;AAElC;;;;;;;;;;;GAWG;AACH,SAAgB,cAAc,CAC5B,eAAsC,EACtC,cAAmC;IAEnC,MAAM,IAAI,KAAK,CACb,sEAAsE,CACvE,CAAC;AACJ,CAAC;AAPD,wCAOC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,cAAc,CAClC,QAAsB,EACtB,cAAmC;IAEnC,+DAA+D;IAC/D,QAAQ,CAAC,IAAI,GAAG,MAAM,qBAAa,CACjC,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,UAAU,EAAE,QAAQ,CAAC,EAAE,EAAE,EAChD,cAAc,CACf,CAAC;IAEF,kCAAkC;IAClC,QAAQ,CAAC,YAAY,GAAG,mCAAqB,CAC3C,QAAQ,CAAC,YAAY,EACrB,QAAQ,CAAC,aAAa,CACvB,CAAC;IAEF,2CAA2C;IAC3C,MAAM,KAAK,GAAG,MAAM,iBAAQ,CAAC,QAAQ,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;IAE1D,mDAAmD;IACnD,wBAAwB;IACxB,MAAM,MAAM,GAAG,IAAI,+BAAc,CAC/B,+BAAc,EAAE,CACjB,CAAC;IAEF,2DAA2D;IAC3D,yCAAyC;IACzC,MAAM,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IAE5D,6BAA6B;IAC7B,MAAM,YAAY,GAAG,MAAM,oBAAW,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC;IAEtE,4CAA4C;IAC5C,MAAM,eAAe,GAAG,MAAM,CAAC,aAAa,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;IAErE,0DAA0D;IAC1D,+CAA+C;IAC/C,QAAQ,GAAG,2BAAY,CAAC,KAAK,EAAE,eAAe,EAAE,cAAc,CAAC,CAAC;IAEhE,OAAO,eAA+B,CAAC;AACzC,CAAC;AAxCD,wCAwCC;AAED;;;;GAIG;AACH,SAAgB,gBAAgB,CAC9B,MAA0B,EAC1B,MAAe;IAEf,iCAAiC;IACjC,MAAM,QAAQ,GAAG,kBAAW,CAAC,MAAM,CAAiB,CAAC;IAErD,mCAAmC;IACnC,QAAQ,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC;IAEzE,OAAO,QAAQ,CAAC;AAClB,CAAC;AAXD,4CAWC;AAED;;;;;GAKG;AACI,KAAK,UAAU,cAAc,CAClC,EAAU,EACV,cAAmC;IAEnC,MAAM,EAAE,GAAG,gCAAK,cAAc,GAAK,EAAE,EAAE,EAAE,CAAsB,CAAC;IAChE,MAAM,+BAAU,CAAC,EAAE,CAAC,CAAC;IAErB,OAAO;AACT,CAAC;AARD,wCAQC"}