@esri/hub-common 13.37.1 → 13.37.3

package/dist/node/groups/_internal/GroupUiSchemaEdit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GroupUiSchemaEdit.js","sourceRoot":"","sources":["../../../../src/groups/_internal/GroupUiSchemaEdit.ts"],"names":[],"mappings":";;;AAEA;;;;GAIG;AACU,QAAA,QAAQ,GAAc;IACjC,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE;QACR;YACE,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,wCAAwC;YAClD,QAAQ,EAAE;gBACR;oBACE,QAAQ,EAAE,iCAAiC;oBAC3C,KAAK,EAAE,kBAAkB;oBACzB,IAAI,EAAE,SAAS;oBACf,OAAO,EAAE;wBACP,QAAQ,EAAE;4BACR;gCACE,IAAI,EAAE,OAAO;gCACb,OAAO,EAAE,UAAU;gCACnB,IAAI,EAAE,IAAI;gCACV,QAAQ,EAAE,yCAAyC;6BACpD;yBACF;qBACF;iBACF;gBACD;oBACE,QAAQ,EAAE,oCAAoC;oBAC9C,KAAK,EAAE,qBAAqB;oBAC5B,IAAI,EAAE,SAAS;oBACf,OAAO,EAAE;wBACP,OAAO,EAAE,uBAAuB;wBAChC,IAAI,EAAE,UAAU;wBAChB,UAAU,EAAE;4BACV,QAAQ,EAAE,yCAAyC;yBACpD;qBACF;iBACF;gBACD;oBACE,QAAQ,EAAE,uCAAuC;oBACjD,KAAK,EAAE,wBAAwB;oBAC/B,IAAI,EAAE,SAAS;oBACf,OAAO,EAAE;wBACP,OAAO,EAAE,8BAA8B;wBACvC,QAAQ,EAAE,GAAG;wBACb,SAAS,EAAE,GAAG;wBACd,WAAW,EAAE,GAAG;wBAChB,UAAU,EAAE;4BACV,QAAQ,EAAE,4CAA4C;yBACvD;qBACF;iBACF;aACF;SACF;KACF;CACF,CAAC"}

package/dist/node/groups/_internal/convertGroupToHubGroup.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertGroupToHubGroup = void 0;
+const PropertyMapper_1 = require("../../core/_internal/PropertyMapper");
+const computeProps_1 = require("./computeProps");
+const getPropertyMap_1 = require("./getPropertyMap");
+/**
+ * Convert an IGroup to a Hub Group
+ * @param group
+ * @param requestOptions
+ */
+function convertGroupToHubGroup(group, requestOptions) {
+    const mapper = new PropertyMapper_1.PropertyMapper(getPropertyMap_1.getPropertyMap());
+    const hubGroup = mapper.storeToEntity(group, {});
+    return computeProps_1.computeProps(group, hubGroup, requestOptions);
+}
+exports.convertGroupToHubGroup = convertGroupToHubGroup;
+//# sourceMappingURL=convertGroupToHubGroup.js.map

package/dist/node/groups/_internal/convertGroupToHubGroup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"convertGroupToHubGroup.js","sourceRoot":"","sources":["../../../../src/groups/_internal/convertGroupToHubGroup.ts"],"names":[],"mappings":";;;AACA,wEAAqE;AAErE,iDAA8C;AAC9C,qDAAkD;AAGlD;;;;GAIG;AAEH,SAAgB,sBAAsB,CACpC,KAAa,EACb,cAAmC;IAEnC,MAAM,MAAM,GAAG,IAAI,+BAAc,CAC/B,+BAAc,EAAE,CACjB,CAAC;IACF,MAAM,QAAQ,GAAG,MAAM,CAAC,aAAa,CAAC,KAAK,EAAE,EAAE,CAAc,CAAC;IAC9D,OAAO,2BAAY,CAAC,KAAK,EAAE,QAAQ,EAAE,cAAc,CAAC,CAAC;AACvD,CAAC;AATD,wDASC"}

package/dist/node/groups/_internal/convertHubGroupToGroup.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertHubGroupToGroup = void 0;
+const PropertyMapper_1 = require("../../core/_internal/PropertyMapper");
+const getPropertyMap_1 = require("./getPropertyMap");
+/**
+ * Convert a Hub Group to an IGroup
+ * @param hubGroup
+ */
+function convertHubGroupToGroup(hubGroup) {
+    const mapper = new PropertyMapper_1.PropertyMapper(getPropertyMap_1.getPropertyMap());
+    const group = mapper.entityToStore(hubGroup, {});
+    // convert the values for membershipAccess back to
+    // the ones the API accepts
+    if (group.membershipAccess === "organization") {
+        group.membershipAccess = "org";
+    }
+    if (group.membershipAccess === "collaborators") {
+        group.membershipAccess = "collaboration";
+    }
+    // since we are setting null to a prop, we need to
+    // send clearEmptyFields: true to the updateGroup call
+    if (group.membershipAccess === "anyone") {
+        group.membershipAccess = null;
+        group._clearEmptyFields = true;
+    }
+    return group;
+}
+exports.convertHubGroupToGroup = convertHubGroupToGroup;
+//# sourceMappingURL=convertHubGroupToGroup.js.map

package/dist/node/groups/_internal/convertHubGroupToGroup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"convertHubGroupToGroup.js","sourceRoot":"","sources":["../../../../src/groups/_internal/convertHubGroupToGroup.ts"],"names":[],"mappings":";;;AACA,wEAAqE;AAErE,qDAAkD;AAElD;;;GAGG;AAEH,SAAgB,sBAAsB,CAAC,QAAmB;IACxD,MAAM,MAAM,GAAG,IAAI,+BAAc,CAC/B,+BAAc,EAAE,CACjB,CAAC;IACF,MAAM,KAAK,GAAG,MAAM,CAAC,aAAa,CAChC,QAAQ,EACR,EAAuB,CACd,CAAC;IACZ,kDAAkD;IAClD,2BAA2B;IAC3B,IAAI,KAAK,CAAC,gBAAgB,KAAK,cAAc,EAAE;QAC7C,KAAK,CAAC,gBAAgB,GAAG,KAAK,CAAC;KAChC;IACD,IAAI,KAAK,CAAC,gBAAgB,KAAK,eAAe,EAAE;QAC9C,KAAK,CAAC,gBAAgB,GAAG,eAAe,CAAC;KAC1C;IACD,kDAAkD;IAClD,sDAAsD;IACtD,IAAI,KAAK,CAAC,gBAAgB,KAAK,QAAQ,EAAE;QACvC,KAAK,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAC9B,KAAK,CAAC,iBAAiB,GAAG,IAAI,CAAC;KAChC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAvBD,wDAuBC"}

package/dist/node/groups/deleteGroupThumbnail.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteGroupThumbnail = void 0;
+const arcgis_rest_request_1 = require("@esri/arcgis-rest-request");
+/**
+ * Delete a group's thumbnail
+ * @param id
+ * @param owner
+ * @param requestOptions
+ * @returns
+ */
+async function deleteGroupThumbnail(id, requestOptions) {
+    const { portal } = requestOptions;
+    const urlPath = `${portal}/community/groups/${id}/deleteThumbnail`;
+    return arcgis_rest_request_1.request(urlPath, requestOptions);
+}
+exports.deleteGroupThumbnail = deleteGroupThumbnail;
+//# sourceMappingURL=deleteGroupThumbnail.js.map

package/dist/node/groups/deleteGroupThumbnail.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deleteGroupThumbnail.js","sourceRoot":"","sources":["../../../src/groups/deleteGroupThumbnail.ts"],"names":[],"mappings":";;;AACA,mEAAoD;AAEpD;;;;;;GAMG;AACI,KAAK,UAAU,oBAAoB,CACxC,EAAU,EACV,cAAmC;IAEnC,MAAM,EAAE,MAAM,EAAE,GAAG,cAAc,CAAC;IAClC,MAAM,OAAO,GAAG,GAAG,MAAM,qBAAqB,EAAE,kBAAkB,CAAC;IACnE,OAAO,6BAAO,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;AAC1C,CAAC;AAPD,oDAOC"}

package/dist/node/groups/setGroupThumbnail.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setGroupThumbnail = void 0;
+const arcgis_rest_portal_1 = require("@esri/arcgis-rest-portal");
+const HubError_1 = require("../HubError");
+/**
+ * Upload a file to be used as the thumbnail for a group
+ * @param id
+ * @param file
+ * @param filename
+ * @param requestOptions
+ */
+async function setGroupThumbnail(id, file, filename, requestOptions, owner) {
+    const opts = Object.assign({ group: {
+            id,
+        }, owner, params: {
+            thumbnail: file,
+            fileName: filename,
+        }, filename }, requestOptions);
+    try {
+        const response = await arcgis_rest_portal_1.updateGroup(opts);
+        if (!response.success) {
+            throw new HubError_1.default("Set Group Thumbnail", "Unknown error setting thumbnail.");
+        }
+    }
+    catch (err) {
+        if (err instanceof Error) {
+            throw new HubError_1.default("Set Group Thumbnail", err.message, err);
+        }
+        else {
+            throw new HubError_1.default("Set Group Thumbnail", "Unknown error setting thumbnail.");
+        }
+    }
+}
+exports.setGroupThumbnail = setGroupThumbnail;
+//# sourceMappingURL=setGroupThumbnail.js.map

package/dist/node/groups/setGroupThumbnail.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"setGroupThumbnail.js","sourceRoot":"","sources":["../../../src/groups/setGroupThumbnail.ts"],"names":[],"mappings":";;;AACA,iEAAuD;AACvD,0CAAmC;AAEnC;;;;;;GAMG;AACI,KAAK,UAAU,iBAAiB,CACrC,EAAU,EACV,IAAS,EACT,QAAgB,EAChB,cAAmC,EACnC,KAAa;IAEb,MAAM,IAAI,mBACR,KAAK,EAAE;YACL,EAAE;SACH,EACD,KAAK,EACL,MAAM,EAAE;YACN,SAAS,EAAE,IAAI;YACf,QAAQ,EAAE,QAAQ;SACnB,EACD,QAAQ,IACL,cAAc,CAClB,CAAC;IACF,IAAI;QACF,MAAM,QAAQ,GAAG,MAAM,gCAAW,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE;YACrB,MAAM,IAAI,kBAAQ,CAChB,qBAAqB,EACrB,kCAAkC,CACnC,CAAC;SACH;KACF;IAAC,OAAO,GAAG,EAAE;QACZ,IAAI,GAAG,YAAY,KAAK,EAAE;YACxB,MAAM,IAAI,kBAAQ,CAAC,qBAAqB,EAAE,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;SAC7D;aAAM;YACL,MAAM,IAAI,kBAAQ,CAChB,qBAAqB,EACrB,kCAAkC,CACnC,CAAC;SACH;KACF;AACH,CAAC;AArCD,8CAqCC"}

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

@@ -14,3 +14,5 @@ import { IHubLocationOption } from "../../types/IHubLocation";
  * location
  */
 export declare function getLocationOptions(entity: ConfigurableEntity, portalName: string, hubRequestOptions: IHubRequestOptions): Promise<IHubLocationOption[]>;
+export declare function getContentLocationOptions(entity: ConfigurableEntity): Promise<IHubLocationOption[]>;
+export declare function getDefaultLocationOptions(entity: ConfigurableEntity, portalName: string, hubRequestOptions: IHubRequestOptions): Promise<IHubLocationOption[]>;

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:initiative:edit", "hub:initiative:create", "hub:site:edit", "hub:discussion:edit", "hub:discussion:create", "hub:page:edit"];
+export declare const validEditorTypes: readonly ["hub:project:create", "hub:project:edit", "hub:content:edit", "hub:initiative:edit", "hub:initiative:create", "hub:site:edit", "hub:discussion:edit", "hub:discussion:create", "hub:page:edit", "hub:group:edit"];
 export declare enum UiSchemaRuleEffects {
     SHOW = "SHOW",
     HIDE = "HIDE",

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

@@ -1,6 +1,6 @@
 import { IWithPermissions } from "../traits";
 import { IHubEntityBase } from "./IHubEntityBase";
-import { GroupSortField, SettableAccessLevel, MemberType, MembershipAccess, PlatformSortOrder } from "./types";
+import { GroupSortField, MemberType, MembershipAccess, PlatformSortOrder, AccessLevel } from "./types";
 /**
  * Defines the properties of a Hub Group object
  * @internal
@@ -9,8 +9,11 @@ export interface IHubGroup extends IHubEntityBase, IWithPermissions {
     /**
      * Access level of the group
      * ("private" | "org" | "public")
+     * we are using AccessLevel instead of SettableAccessLevel
+     * intentionally due to the Portal API being inconsistent
+     * between .access on items vs groups
      */
-    access: SettableAccessLevel;
+    access: AccessLevel;
     /**
      * Whether members can auto join the group
      */
@@ -93,3 +96,14 @@ export interface IHubGroup extends IHubEntityBase, IWithPermissions {
      */
     _clearEmptyFields?: boolean;
 }
+/**
+ * This type redefines the IHubGroup interface in such a way
+ * that it can be consumed by the entity editor.
+ */
+export declare type IHubGroupEditor = IHubGroup & {
+    /**
+     * Thumbnail image. This is only used on the Editor and is
+     * persisted in the fromEditor method on the Class
+     */
+    _thumbnail?: any;
+};

package/dist/types/groups/HubGroup.d.ts

@@ -1,15 +1,22 @@
-import { IHubGroup } from "../core/types/IHubGroup";
+import { IHubGroup, IHubGroupEditor } from "../core/types/IHubGroup";
 import { IEntityPermissionPolicy, IPermissionAccessResponse, Permission } from "../permissions";
 import { IWithStoreBehavior } from "../core/behaviors/IWithStoreBehavior";
 import { IWithPermissionBehavior } from "../core/behaviors/IWithPermissionBehavior";
 import { IArcGISContext } from "../ArcGISContext";
+import { IEditorConfig, IWithEditorBehavior } from "../core/behaviors/IWithEditorBehavior";
+import { EditorType } from "../core/schemas/types";
 /**
  * Hub Group Class
  */
-export declare class HubGroup implements IWithStoreBehavior<IHubGroup>, IWithPermissionBehavior {
+export declare class HubGroup implements IWithStoreBehavior<IHubGroup>, IWithPermissionBehavior, IWithEditorBehavior {
     protected context: IArcGISContext;
     protected entity: IHubGroup;
     protected isDestroyed: boolean;
+    protected thumbnailCache: {
+        file?: any;
+        filename?: string;
+        clear?: boolean;
+    };
     private constructor();
     /**
      * Whether the user can edit the group,
@@ -92,4 +99,15 @@ export declare class HubGroup implements IWithStoreBehavior<IHubGroup>, IWithPer
      * @param id
      */
     removePermissionPolicy(permission: Permission, id: string): void;
+    getEditorConfig(i18nScope: string, type: EditorType): Promise<IEditorConfig>;
+    /**
+     * Return the group as an editor object
+     */
+    toEditor(): IHubGroupEditor;
+    /**
+     * Load the group from the editor object
+     * @param editor
+     * @returns
+     */
+    fromEditor(editor: IHubGroupEditor): Promise<IHubGroup>;
 }

package/dist/types/groups/_internal/GroupSchema.d.ts

@@ -0,0 +1,7 @@
+import { IConfigurationSchema } from "../../core";
+export declare type GroupEditorType = (typeof GroupEditorTypes)[number];
+export declare const GroupEditorTypes: readonly ["hub:group:edit"];
+/**
+ * Defines the JSON schema for a Hub Group's editable fields
+ */
+export declare const GroupSchema: IConfigurationSchema;

package/dist/types/groups/_internal/GroupUiSchemaEdit.d.ts

@@ -0,0 +1,7 @@
+import { IUiSchema } from "../../core";
+/**
+ * Complete edit uiSchema for Hub Groups - this defines
+ * how the schema properties should be rendered in the
+ * group editing experience
+ */
+export declare const uiSchema: IUiSchema;

package/dist/types/groups/_internal/convertGroupToHubGroup.d.ts

@@ -0,0 +1,9 @@
+import { IGroup } from "@esri/arcgis-rest-types";
+import { IHubGroup } from "../../core/types/IHubGroup";
+import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+/**
+ * Convert an IGroup to a Hub Group
+ * @param group
+ * @param requestOptions
+ */
+export declare function convertGroupToHubGroup(group: IGroup, requestOptions: IUserRequestOptions): IHubGroup;

package/dist/types/groups/_internal/convertHubGroupToGroup.d.ts

@@ -0,0 +1,7 @@
+import { IGroup } from "@esri/arcgis-rest-types";
+import { IHubGroup } from "../../core/types/IHubGroup";
+/**
+ * Convert a Hub Group to an IGroup
+ * @param hubGroup
+ */
+export declare function convertHubGroupToGroup(hubGroup: IHubGroup): IGroup;

package/dist/types/groups/deleteGroupThumbnail.d.ts

@@ -0,0 +1,9 @@
+import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+/**
+ * Delete a group's thumbnail
+ * @param id
+ * @param owner
+ * @param requestOptions
+ * @returns
+ */
+export declare function deleteGroupThumbnail(id: string, requestOptions: IUserRequestOptions): Promise<any>;

package/dist/types/groups/setGroupThumbnail.d.ts

@@ -0,0 +1,9 @@
+import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+/**
+ * Upload a file to be used as the thumbnail for a group
+ * @param id
+ * @param file
+ * @param filename
+ * @param requestOptions
+ */
+export declare function setGroupThumbnail(id: string, file: any, filename: string, requestOptions: IUserRequestOptions, owner: string): Promise<void>;

package/package.json

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