@esri/hub-common 11.0.0 → 11.3.0

package/dist/esm/core/HubItemEntity.js

@@ -0,0 +1,202 @@
+import { getUser, setItemAccess, shareItemWithGroup, unshareItemWithGroup, } from "@esri/arcgis-rest-portal";
+import { setItemThumbnail } from "../items/setItemThumbnail";
+import { getItemThumbnailUrl } from "../resources";
+import { cloneObject } from "../util";
+import { mapBy } from "../utils";
+import { sharedWith } from "./_internal/sharedWith";
+/**
+ * Base class for all Hub Entities backed by items
+ */
+export class HubItemEntity {
+    constructor(entity, context) {
+        this.isDestroyed = false;
+        this.thumbnailCache = null;
+        this.context = context;
+        this.entity = entity;
+    }
+    // Although we don't expose all the properties, we do expose a few for convenience
+    /**
+     * Return the entity id
+     */
+    get id() {
+        return this.entity.id;
+    }
+    /**
+     * Return the entity owner
+     */
+    get owner() {
+        return this.entity.owner;
+    }
+    //#region IWithStoreBehavior
+    /**
+     * Return the backing entity as an object literal
+     * @returns
+     */
+    toJson() {
+        if (this.isDestroyed) {
+            throw new Error("Entity is already destroyed.");
+        }
+        return cloneObject(this.entity);
+    }
+    /**
+     * Can the current user edit the Entity?
+     * In order to edit an item, the user must be the owner of the item
+     * or be a member of a shared editing group, to which the item is shared.
+     * @returns
+     */
+    async canEdit() {
+        const user = this.context.currentUser;
+        // owner can always edit
+        if (user.username === this.entity.owner) {
+            return Promise.resolve(true);
+        }
+        // Fetch the user's groups by fetching the user
+        // we do this each time to ensure we have the latest groups
+        const u = await getUser(user.username);
+        const usersGroups = u.groups;
+        if (!usersGroups.length) {
+            // if user is not owner and not in any groups they can't have edit access
+            return Promise.resolve(false);
+        }
+        // get the groups the entity is shared to
+        const entityGroups = await this.sharedWith();
+        // filter to shared edit groups
+        const editGroupIds = entityGroups
+            .filter((g) => {
+            const caps = g.capabilities || [];
+            return caps.includes("updateitemcontrol");
+        })
+            .map((g) => g.id);
+        // get the user's groups ids
+        const usersGroupsIds = mapBy("id", usersGroups);
+        // check for any overlap
+        let isMemberOfEditGroup = false;
+        for (const id of usersGroupsIds) {
+            isMemberOfEditGroup = editGroupIds.includes(id);
+            if (isMemberOfEditGroup) {
+                break;
+            }
+        }
+        return Promise.resolve(isMemberOfEditGroup);
+    }
+    /**
+     * Can the current user delete the Entity?
+     * In order to delete an item, the user must be the owner of the item or a full org_admin
+     * in the owner's organization.
+     * @returns
+     */
+    async canDelete() {
+        const user = this.context.currentUser;
+        // owner can always delete
+        if (user.username === this.entity.owner) {
+            return Promise.resolve(true);
+        }
+        // if not owner, check if user is org_admin in same org as owner
+        if (user.role === "org_admin" && !user.roleId) {
+            // need to get the owner, and see if the orgid matches
+            const ownerUser = await getUser({
+                username: this.entity.owner,
+                authentication: this.context.session,
+            });
+            // ensure owner orgId is not null and matched current user
+            const adminCanDelete = ownerUser.orgId && ownerUser.orgId === user.orgId;
+            return Promise.resolve(adminCanDelete);
+        }
+        else {
+            // not org admin, can't edit
+            return Promise.resolve(false);
+        }
+    }
+    //#endregion IWithStoreBehavior
+    //#region IWithSharingBehavior
+    /**
+     * Share the Entity with the specified group id
+     * @param groupId
+     */
+    async shareWithGroup(groupId) {
+        await shareItemWithGroup({
+            id: this.entity.id,
+            groupId,
+            owner: this.entity.owner,
+            authentication: this.context.session,
+        });
+    }
+    /**
+     * Unshare the Entity with the specified group id
+     * @param groupId
+     */
+    async unshareWithGroup(groupId) {
+        await unshareItemWithGroup({
+            id: this.entity.id,
+            groupId,
+            owner: this.entity.owner,
+            authentication: this.context.session,
+        });
+    }
+    /**
+     * Set the access level of the backing item
+     * @param access
+     */
+    async setAccess(access) {
+        await setItemAccess({
+            id: this.entity.id,
+            access,
+            authentication: this.context.session,
+        });
+        // if this succeeded, update the entity
+        this.entity.access = access;
+    }
+    /**
+     * Return a list of groups the Entity is shared to.
+     * @returns
+     */
+    async sharedWith() {
+        // delegate to a util that merges the three arrays returned from the api, into a single array
+        return sharedWith(this.entity.id, this.context.requestOptions);
+    }
+    //#endregion
+    /**
+     * Hook that subclasses should call to invoke shared post-save behavior
+     */
+    async afterSave() {
+        // Handle Thumbnails
+        // check if there is a thumbnail in the cache
+        if (this.thumbnailCache) {
+            // save the thumbnail
+            await setItemThumbnail(this.entity.id, this.thumbnailCache.file, this.thumbnailCache.filename, this.context.userRequestOptions);
+            // Note: updating the thumbnail alone does not update the modified date of the item
+            // thus we can just set props on the entity w/o re-fetching
+            this.entity.thumbnail = `thumbnail/${this.thumbnailCache.filename}`;
+            this.entity.thumbnailUrl = this.getThumbnailUrl();
+            // clear the thumbnail cache
+            this.thumbnailCache = null;
+        }
+    }
+    //#region IWithThumbnailBehavior
+    /**
+     * Store thumbnail information to be sent with the next `.save()` call
+     * @param file
+     * @param filename
+     */
+    setThumbnail(file, filename) {
+        // subclass is responsible for handling the implementation during the `.save()` call
+        this.thumbnailCache = { file, filename };
+    }
+    /**
+     * Return the full url to the thumbnail, optionally with a width parameter
+     * @param width
+     */
+    getThumbnailUrl(width = 200) {
+        const minimalItem = {
+            id: this.entity.id,
+            access: this.entity.access,
+            thumbnail: this.entity.thumbnail,
+        };
+        const opts = {
+            token: this.context.session.token,
+            width,
+        };
+        return getItemThumbnailUrl(minimalItem, this.context.requestOptions, opts);
+    }
+}
+//# sourceMappingURL=HubItemEntity.js.map

package/dist/esm/core/HubItemEntity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HubItemEntity.js","sourceRoot":"","sources":["../../../src/core/HubItemEntity.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EAGP,aAAa,EACb,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,mBAAmB,EAAqB,MAAM,cAAc,CAAC;AACtE,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACtC,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAIjC,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAEpD;;GAEG;AACH,MAAM,OAAgB,aAAa;IAWjC,YAAY,MAAS,EAAE,OAAuB;QAHpC,gBAAW,GAAY,KAAK,CAAC;QAC7B,mBAAc,GAAoC,IAAI,CAAC;QAG/D,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,kFAAkF;IAClF;;OAEG;IACH,IAAI,EAAE;QACJ,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC3B,CAAC;IAED,4BAA4B;IAE5B;;;OAGG;IACH,MAAM;QACJ,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;SACjD;QACD,OAAO,WAAW,CAAC,IAAI,CAAC,MAAM,CAAiB,CAAC;IAClD,CAAC;IAKD;;;;;OAKG;IACH,KAAK,CAAC,OAAO;QACX,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC;QACtC,wBAAwB;QACxB,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE;YACvC,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;SAC9B;QAED,+CAA+C;QAC/C,2DAA2D;QAC3D,MAAM,CAAC,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC;QAE7B,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE;YACvB,yEAAyE;YACzE,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;SAC/B;QACD,yCAAyC;QACzC,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QAC7C,+BAA+B;QAC/B,MAAM,YAAY,GAAG,YAAY;aAC9B,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE;YACZ,MAAM,IAAI,GAAI,CAAC,CAAC,YAAyB,IAAI,EAAE,CAAC;YAChD,OAAO,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;QAC5C,CAAC,CAAC;aACD,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QACpB,4BAA4B;QAC5B,MAAM,cAAc,GAAG,KAAK,CAAC,IAAI,EAAE,WAAW,CAAa,CAAC;QAC5D,wBAAwB;QACxB,IAAI,mBAAmB,GAAG,KAAK,CAAC;QAChC,KAAK,MAAM,EAAE,IAAI,cAAc,EAAE;YAC/B,mBAAmB,GAAG,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YAChD,IAAI,mBAAmB,EAAE;gBACvB,MAAM;aACP;SACF;QACD,OAAO,OAAO,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,SAAS;QACb,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC;QACtC,0BAA0B;QAC1B,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE;YACvC,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;SAC9B;QACD,gEAAgE;QAChE,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YAC7C,sDAAsD;YACtD,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC;gBAC9B,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK;gBAC3B,cAAc,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO;aACrC,CAAC,CAAC;YACH,0DAA0D;YAC1D,MAAM,cAAc,GAAG,SAAS,CAAC,KAAK,IAAI,SAAS,CAAC,KAAK,KAAK,IAAI,CAAC,KAAK,CAAC;YACzE,OAAO,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;SACxC;aAAM;YACL,4BAA4B;YAC5B,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;SAC/B;IACH,CAAC;IAED,+BAA+B;IAE/B,8BAA8B;IAC9B;;;OAGG;IACH,KAAK,CAAC,cAAc,CAAC,OAAe;QAClC,MAAM,kBAAkB,CAAC;YACvB,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE;YAClB,OAAO;YACP,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK;YACxB,cAAc,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO;SACrC,CAAC,CAAC;IACL,CAAC;IACD;;;OAGG;IACH,KAAK,CAAC,gBAAgB,CAAC,OAAe;QACpC,MAAM,oBAAoB,CAAC;YACzB,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE;YAClB,OAAO;YACP,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK;YACxB,cAAc,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO;SACrC,CAAC,CAAC;IACL,CAAC;IACD;;;OAGG;IACH,KAAK,CAAC,SAAS,CAAC,MAA2B;QACzC,MAAM,aAAa,CAAC;YAClB,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE;YAClB,MAAM;YACN,cAAc,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO;SACrC,CAAC,CAAC;QACH,uCAAuC;QACvC,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,UAAU;QACd,6FAA6F;QAC7F,OAAO,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IACjE,CAAC;IAED,YAAY;IAEZ;;OAEG;IACH,KAAK,CAAC,SAAS;QACb,oBAAoB;QACpB,6CAA6C;QAC7C,IAAI,IAAI,CAAC,cAAc,EAAE;YACvB,qBAAqB;YACrB,MAAM,gBAAgB,CACpB,IAAI,CAAC,MAAM,CAAC,EAAE,EACd,IAAI,CAAC,cAAc,CAAC,IAAI,EACxB,IAAI,CAAC,cAAc,CAAC,QAAQ,EAC5B,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAChC,CAAC;YAEF,mFAAmF;YACnF,2DAA2D;YAC3D,IAAI,CAAC,MAAM,CAAC,SAAS,GAAG,aAAa,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC;YACpE,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;YAClD,4BAA4B;YAC5B,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;SAC5B;IACH,CAAC;IAED,gCAAgC;IAEhC;;;;OAIG;IACH,YAAY,CAAC,IAAS,EAAE,QAAgB;QACtC,oFAAoF;QACpF,IAAI,CAAC,cAAc,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;IAC3C,CAAC;IACD;;;OAGG;IACH,eAAe,CAAC,QAAgB,GAAG;QACjC,MAAM,WAAW,GAAG;YAClB,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE;YAClB,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM;YAC1B,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS;SACb,CAAC;QAEtB,MAAM,IAAI,GAAsB;YAC9B,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK;YACjC,KAAK;SACN,CAAC;QAEF,OAAO,mBAAmB,CAAC,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;IAC7E,CAAC;CAEF"}

package/dist/esm/core/_internal/getBasePropertyMap.js

@@ -0,0 +1,57 @@
+/**
+ * Returns an Array of IPropertyMap objects
+ * that define the standard projection of properties from a IModel an entity interface
+ * @returns
+ */
+export function getBasePropertyMap() {
+    const itemProps = [
+        "access",
+        "created",
+        "culture",
+        "description",
+        "extent",
+        "id",
+        "modified",
+        "owner",
+        "tags",
+        "type",
+        "typeKeywords",
+        "thumbnail",
+        "url",
+    ];
+    const dataProps = ["display", "geometry", "location"];
+    const map = [];
+    itemProps.forEach((entry) => {
+        map.push({ objectKey: entry, modelKey: `item.${entry}` });
+    });
+    dataProps.forEach((entry) => {
+        map.push({ objectKey: entry, modelKey: `data.${entry}` });
+    });
+    // Deeper mappings
+    map.push({
+        objectKey: "slug",
+        modelKey: "item.properties.slug",
+    });
+    map.push({
+        objectKey: "summary",
+        modelKey: "item.snippet",
+    });
+    map.push({
+        objectKey: "schemaVersion",
+        modelKey: "item.properties.schemaVersion",
+    });
+    map.push({
+        objectKey: "orgUrlKey",
+        modelKey: "item.properties.orgUrlKey",
+    });
+    map.push({
+        objectKey: "name",
+        modelKey: "item.title",
+    });
+    map.push({
+        objectKey: "boundary",
+        modelKey: "item.properties.boundary",
+    });
+    return map;
+}
+//# sourceMappingURL=getBasePropertyMap.js.map

package/dist/esm/core/_internal/getBasePropertyMap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getBasePropertyMap.js","sourceRoot":"","sources":["../../../../src/core/_internal/getBasePropertyMap.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,UAAU,kBAAkB;IAChC,MAAM,SAAS,GAAG;QAChB,QAAQ;QACR,SAAS;QACT,SAAS;QACT,aAAa;QACb,QAAQ;QACR,IAAI;QACJ,UAAU;QACV,OAAO;QACP,MAAM;QACN,MAAM;QACN,cAAc;QACd,WAAW;QACX,KAAK;KACN,CAAC;IACF,MAAM,SAAS,GAAG,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;IACtD,MAAM,GAAG,GAAmB,EAAE,CAAC;IAC/B,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QAC1B,GAAG,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,KAAK,EAAE,EAAE,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;IACH,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QAC1B,GAAG,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,KAAK,EAAE,EAAE,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;IACH,kBAAkB;IAClB,GAAG,CAAC,IAAI,CAAC;QACP,SAAS,EAAE,MAAM;QACjB,QAAQ,EAAE,sBAAsB;KACjC,CAAC,CAAC;IACH,GAAG,CAAC,IAAI,CAAC;QACP,SAAS,EAAE,SAAS;QACpB,QAAQ,EAAE,cAAc;KACzB,CAAC,CAAC;IACH,GAAG,CAAC,IAAI,CAAC;QACP,SAAS,EAAE,eAAe;QAC1B,QAAQ,EAAE,+BAA+B;KAC1C,CAAC,CAAC;IACH,GAAG,CAAC,IAAI,CAAC;QACP,SAAS,EAAE,WAAW;QACtB,QAAQ,EAAE,2BAA2B;KACtC,CAAC,CAAC;IACH,GAAG,CAAC,IAAI,CAAC;QACP,SAAS,EAAE,MAAM;QACjB,QAAQ,EAAE,YAAY;KACvB,CAAC,CAAC;IACH,GAAG,CAAC,IAAI,CAAC;QACP,SAAS,EAAE,UAAU;QACrB,QAAQ,EAAE,0BAA0B;KACrC,CAAC,CAAC;IACH,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/esm/core/behaviors/IWithThumbnailBehavior.js

@@ -0,0 +1 @@
+//# sourceMappingURL=IWithThumbnailBehavior.js.map

package/dist/esm/core/behaviors/IWithThumbnailBehavior.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IWithThumbnailBehavior.js","sourceRoot":"","sources":["../../../../src/core/behaviors/IWithThumbnailBehavior.ts"],"names":[],"mappings":""}

package/dist/esm/core/traits/IWithCatalog.js

@@ -0,0 +1 @@
+//# sourceMappingURL=IWithCatalog.js.map

package/dist/esm/core/traits/IWithCatalog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IWithCatalog.js","sourceRoot":"","sources":["../../../../src/core/traits/IWithCatalog.ts"],"names":[],"mappings":""}

package/dist/esm/core/traits/index.js

@@ -2,4 +2,5 @@ export * from "./IWithBannerImage";
 export * from "./IWithLayout";
 export * from "./IWithSlug";
 export * from "./IWithPermissions";
+export * from "./IWithCatalog";
 //# sourceMappingURL=index.js.map

package/dist/esm/core/traits/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/core/traits/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/core/traits/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC"}

package/dist/esm/core/types/IEntityResource.js

@@ -0,0 +1 @@
+//# sourceMappingURL=IEntityResource.js.map

package/dist/esm/core/types/IEntityResource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IEntityResource.js","sourceRoot":"","sources":["../../../../src/core/types/IEntityResource.ts"],"names":[],"mappings":""}

package/dist/esm/core/types/IItemResource.js

@@ -0,0 +1 @@
+//# sourceMappingURL=IItemResource.js.map

package/dist/esm/core/types/IItemResource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IItemResource.js","sourceRoot":"","sources":["../../../../src/core/types/IItemResource.ts"],"names":[],"mappings":""}

package/dist/esm/core/types/index.js

@@ -1,12 +1,10 @@
 export * from "./IHubContent";
 export * from "./IHubContentEnrichments";
 export * from "./IHubEntityBase";
-export * from "./IHubEntityManager";
 export * from "./IHubEvent";
 export * from "./IHubImage";
 export * from "./IHubInitiative";
 export * from "./IHubItemEntity";
-export * from "./IHubItemEntityManager";
 export * from "./IHubLayout";
 export * from "./IHubPage";
 export * from "./IHubProject";

package/dist/esm/core/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/core/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,0BAA0B,CAAC;AACzC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,yBAAyB,CAAC;AACxC,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,SAAS,CAAC;AACxB,cAAc,kBAAkB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/core/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,0BAA0B,CAAC;AACzC,cAAc,kBAAkB,CAAC;AAEjC,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AAEjC,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,SAAS,CAAC;AACxB,cAAc,kBAAkB,CAAC"}

package/dist/esm/index.js

@@ -17,6 +17,7 @@ export * from "./items";
 export * from "./models";
 export * from "./objects";
 export * from "./projects";
+export * from "./initiatives";
 export * from "./request";
 export * from "./resources";
 export * from "./search";
@@ -36,6 +37,4 @@ import HubError from "./HubError";
 // Re-exports
 export { OperationStack, OperationError, HubError };
 export { btoa, atob } from "abab";
-// This will be moved to another package
-// export * from "./Hub";
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;gBACgB;AAChB,0BAA0B;AAE1B,cAAc,UAAU,CAAC;AACzB,cAAc,OAAO,CAAC;AACtB,cAAc,iBAAiB,CAAC;AAChC,cAAc,wBAAwB,CAAC;AACvC,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC;AAC1B,cAAc,QAAQ,CAAC;AACvB,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AAExB,cAAc,SAAS,CAAC;AACxB,cAAc,OAAO,CAAC;AACtB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AAExB,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,QAAQ,MAAM,YAAY,CAAC;AAElC,aAAa;AACb,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,QAAQ,EAAE,CAAC;AACpD,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAElC,wCAAwC;AACxC,yBAAyB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;gBACgB;AAChB,0BAA0B;AAE1B,cAAc,UAAU,CAAC;AACzB,cAAc,OAAO,CAAC;AACtB,cAAc,iBAAiB,CAAC;AAChC,cAAc,wBAAwB,CAAC;AACvC,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC;AAC1B,cAAc,QAAQ,CAAC;AACvB,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AAExB,cAAc,SAAS,CAAC;AACxB,cAAc,OAAO,CAAC;AACtB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AAExB,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,QAAQ,MAAM,YAAY,CAAC;AAElC,aAAa;AACb,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,QAAQ,EAAE,CAAC;AACpD,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC"}

package/dist/esm/initiatives/HubInitiative.js

@@ -0,0 +1,149 @@
+import { DEFAULT_INITIATIVE } from "./defaults";
+import { PermissionManager, } from "../core";
+import { createInitiative, deleteInitiative, fetchInitiative, updateInitiative, } from "./HubInitiatives";
+import { Catalog } from "../search/Catalog";
+import { HubItemEntity } from "../core/HubItemEntity";
+/**
+ * Hub Initiative Class
+ */
+export class HubInitiative extends HubItemEntity {
+    /**
+     * Private constructor so we don't have `new` all over the place. Allows for
+     * more flexibility in how we create the HubInitiativeManager over time.
+     * @param context
+     */
+    constructor(entity, context) {
+        super(entity, context);
+        this._catalog = Catalog.fromJson(entity.catalog, this.context);
+        this._permissionManager = PermissionManager.fromJson(entity.permissions, this.context);
+    }
+    /**
+     * Catalog instance for this Initiative. Note: Do not hold direct references to this object; always access it from the Initiative.
+     * @returns Catalog
+     */
+    get catalog() {
+        return this._catalog;
+    }
+    /**
+     * PermissionManager instance for this Initiative. Note: Do not hold direct references to this object; always access it from the Initiative.
+     * @returns PermissionManager
+     */
+    get permissions() {
+        return this._permissionManager;
+    }
+    /**
+     * Create an instance from an IHubInitiative object
+     * @param json - JSON object to create a HubInitiative 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 HubInitiative(pojo, context);
+    }
+    /**
+     * Create a new HubInitiative, returning a HubInitiative instance.
+     * Note: This does not persist the Initiative into the backing store
+     * @param partialInitiative
+     * @param context
+     * @returns
+     */
+    static async create(partialInitiative, context, save = false) {
+        const pojo = this.applyDefaults(partialInitiative, context);
+        // return an instance of HubInitiative
+        const instance = HubInitiative.fromJson(pojo, context);
+        if (save) {
+            await instance.save();
+        }
+        return instance;
+    }
+    /**
+     * Fetch an Initiative from the backing store and return a HubInitiative instance.
+     * @param identifier - slug or item id
+     * @param context
+     * @returns
+     */
+    static async fetch(identifier, context) {
+        // fetch by id or slug
+        try {
+            const entity = await fetchInitiative(identifier, context.requestOptions);
+            // create an instance of HubInitiative from the entity
+            return HubInitiative.fromJson(entity, context);
+        }
+        catch (ex) {
+            if (ex.message ===
+                "CONT_0001: Item does not exist or is inaccessible.") {
+                throw new Error(`Initiative not found.`);
+            }
+            else {
+                throw ex;
+            }
+        }
+    }
+    static applyDefaults(partialInitiative, context) {
+        // ensure we have the orgUrlKey
+        if (!partialInitiative.orgUrlKey) {
+            partialInitiative.orgUrlKey = context.portal.urlKey;
+        }
+        // extend the partial over the defaults
+        const pojo = Object.assign(Object.assign({}, DEFAULT_INITIATIVE), partialInitiative);
+        return pojo;
+    }
+    /**
+     * Apply a new state to the instance
+     * @param changes
+     */
+    update(changes) {
+        if (this.isDestroyed) {
+            throw new Error("HubInitiative is already destroyed.");
+        }
+        // merge partial onto existing entity
+        this.entity = Object.assign(Object.assign({}, this.entity), changes);
+        // update internal instances
+        if (changes.catalog) {
+            this._catalog = Catalog.fromJson(this.entity.catalog, this.context);
+        }
+        if (changes.permissions) {
+            this._permissionManager = PermissionManager.fromJson(this.entity.permissions, this.context);
+        }
+    }
+    /**
+     * Save the HubInitiative to the backing store.
+     * Currently Initiatives are stored as Items in Portal
+     * @returns
+     */
+    async save() {
+        if (this.isDestroyed) {
+            throw new Error("HubInitiative is already destroyed.");
+        }
+        // get the catalog, and permission configs
+        this.entity.catalog = this._catalog.toJson();
+        this.entity.permissions = this._permissionManager.toJson();
+        if (this.entity.id) {
+            // update it
+            this.entity = await updateInitiative(this.entity, this.context.userRequestOptions);
+        }
+        else {
+            // create it
+            this.entity = await createInitiative(this.entity, this.context.userRequestOptions);
+        }
+        // call the after save hook on superclass
+        await super.afterSave();
+        return;
+    }
+    /**
+     * Delete the HubInitiative from the store
+     * set a flag to indicate that it is destroyed
+     * @returns
+     */
+    async delete() {
+        if (this.isDestroyed) {
+            throw new Error("HubInitiative is already destroyed.");
+        }
+        this.isDestroyed = true;
+        // Delegate to module fn
+        await deleteInitiative(this.entity.id, this.context.userRequestOptions);
+    }
+}
+//# sourceMappingURL=HubInitiative.js.map

package/dist/esm/initiatives/HubInitiative.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HubInitiative.js","sourceRoot":"","sources":["../../../src/initiatives/HubInitiative.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAEhD,OAAO,EAIL,iBAAiB,GAGlB,MAAM,SAAS,CAAC;AAEjB,OAAO,EACL,gBAAgB,EAChB,gBAAgB,EAChB,eAAe,EACf,gBAAgB,GACjB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAE5C,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAEtD;;GAEG;AACH,MAAM,OAAO,aACX,SAAQ,aAA6B;IASrC;;;;OAIG;IACH,YAAoB,MAAsB,EAAE,OAAuB;QACjE,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/D,IAAI,CAAC,kBAAkB,GAAG,iBAAiB,CAAC,QAAQ,CAClD,MAAM,CAAC,WAAW,EAClB,IAAI,CAAC,OAAO,CACb,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;OAGG;IACH,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,kBAAkB,CAAC;IACjC,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CACb,IAA6B,EAC7B,OAAuB;QAEvB,6CAA6C;QAC7C,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC/C,OAAO,IAAI,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,CAAC,MAAM,CACjB,iBAA0C,EAC1C,OAAuB,EACvB,OAAgB,KAAK;QAErB,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC;QAC5D,sCAAsC;QACtC,MAAM,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACvD,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,sBAAsB;QACtB,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,eAAe,CAAC,UAAU,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;YACzE,sDAAsD;YACtD,OAAO,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;SAChD;QAAC,OAAO,EAAE,EAAE;YACX,IACG,EAAY,CAAC,OAAO;gBACrB,oDAAoD,EACpD;gBACA,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;aAC1C;iBAAM;gBACL,MAAM,EAAE,CAAC;aACV;SACF;IACH,CAAC;IAEO,MAAM,CAAC,aAAa,CAC1B,iBAA0C,EAC1C,OAAuB;QAEvB,+BAA+B;QAC/B,IAAI,CAAC,iBAAiB,CAAC,SAAS,EAAE;YAChC,iBAAiB,CAAC,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC;SACrD;QACD,uCAAuC;QACvC,MAAM,IAAI,GAAG,gCACR,kBAAkB,GAClB,iBAAiB,CACH,CAAC;QACpB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,OAAgC;QACrC,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;SACxD;QACD,qCAAqC;QACrC,IAAI,CAAC,MAAM,mCAAQ,IAAI,CAAC,MAAM,GAAK,OAAO,CAAE,CAAC;QAE7C,4BAA4B;QAC5B,IAAI,OAAO,CAAC,OAAO,EAAE;YACnB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;SACrE;QACD,IAAI,OAAO,CAAC,WAAW,EAAE;YACvB,IAAI,CAAC,kBAAkB,GAAG,iBAAiB,CAAC,QAAQ,CAClD,IAAI,CAAC,MAAM,CAAC,WAAW,EACvB,IAAI,CAAC,OAAO,CACb,CAAC;SACH;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,IAAI;QACR,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;SACxD;QACD,0CAA0C;QAC1C,IAAI,CAAC,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QAC7C,IAAI,CAAC,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAC;QAE3D,IAAI,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE;YAClB,YAAY;YACZ,IAAI,CAAC,MAAM,GAAG,MAAM,gBAAgB,CAClC,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAChC,CAAC;SACH;aAAM;YACL,YAAY;YACZ,IAAI,CAAC,MAAM,GAAG,MAAM,gBAAgB,CAClC,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAChC,CAAC;SACH;QAED,yCAAyC;QACzC,MAAM,KAAK,CAAC,SAAS,EAAE,CAAC;QAExB,OAAO;IACT,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM;QACV,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;SACxD;QACD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,wBAAwB;QACxB,MAAM,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAC1E,CAAC;CACF"}