feat(hub-common): create feedback entity

packages/common/src/core/fetchHubEntity.ts

@@ -10,6 +10,7 @@ import { HubEntityType } from "./types/HubEntityType";
 import { IArcGISContext } from "../ArcGISContext";
 import { fetchHubGroup } from "../groups/HubGroups";
 import { fetchInitiativeTemplate } from "../initiative-templates/fetch";
+import { fetchFeedback } from "../feedback/fetch";
 
 /**
  * Fetch a Hub entity by identifier (id or slug)
@@ -49,6 +50,9 @@ export async function fetchHubEntity(
     case "group":
       result = await fetchHubGroup(identifier, context.userRequestOptions);
       break;
+    case "feedback":
+      result = await fetchFeedback(identifier, context.hubRequestOptions);
+      break;
     case "initiativeTemplate":
       result = await fetchInitiativeTemplate(
         identifier,

packages/common/src/core/schemas/internal/getEditorSchemas.ts

@@ -23,6 +23,7 @@ import {
 import { IArcGISContext } from "../../../ArcGISContext";
 import { InitiativeTemplateEditorType } from "../../../initiative-templates/_internal/InitiativeTemplateSchema";
 import { getCardEditorSchemas } from "./getCardEditorSchemas";
+import { FeedbackEditorType } from "../../../feedback/_internal/FeedbackSchema";
 
 /**
  * get the editor schema and uiSchema defined for an editor (either an entity or a card).
@@ -221,6 +222,25 @@ export async function getEditorSchemas(
       );
 
       break;
+    // ----------------------------------------------------
+    case "feedback":
+      const { FeedbackSchema } = await import(
+        "../../../feedback/_internal/FeedbackSchema"
+      );
+      schema = cloneObject(FeedbackSchema);
+
+      const feedbackModule = await {
+        "hub:feedback:edit": () =>
+          import("../../../feedback/_internal/FeedbackUiSchemaEdit"),
+        "hub:feedback:settings": () =>
+          import("../../../feedback/_internal/FeedbackUiSchemaSettings"),
+      }[type as FeedbackEditorType]();
+      uiSchema = await feedbackModule.buildUiSchema(
+        i18nScope,
+        options as EntityEditorOptions,
+        context
+      );
+      break;
 
     case "initiativeTemplate":
       const { InitiativeTemplateSchema } = await import(

packages/common/src/core/schemas/types.ts

@@ -10,6 +10,7 @@ import { ContentEditorTypes } from "../../content/_internal/ContentSchema";
 import { TemplateEditorTypes } from "../../templates/_internal/TemplateSchema";
 import { GroupEditorTypes } from "../../groups/_internal/GroupSchema";
 import { InitiativeTemplateEditorTypes } from "../../initiative-templates/_internal/InitiativeTemplateSchema";
+import { FeedbackEditorTypes } from "../../feedback/_internal/FeedbackSchema";
 
 export interface IEditorConfig {
   schema: IConfigurationSchema;
@@ -31,6 +32,7 @@ export const validEntityEditorTypes = [
   ...TemplateEditorTypes,
   ...GroupEditorTypes,
   ...InitiativeTemplateEditorTypes,
+  ...FeedbackEditorTypes,
 ] as const;
 
 /** Defines the possible editor type values for a stat card. These

packages/common/src/core/types/HubEntity.ts

@@ -5,6 +5,7 @@ import { IHubSite } from "./IHubSite";
 import { IHubDiscussion } from "./IHubDiscussion";
 import { IHubGroup } from "./IHubGroup";
 import { IHubTemplate } from "./IHubTemplate";
+import { IHubFeedback } from "./IHubFeedback";
 
 export type HubEntity =
   | IHubSite
@@ -13,4 +14,5 @@ export type HubEntity =
   | IHubInitiative
   | IHubPage
   | IHubGroup
-  | IHubTemplate;
+  | IHubTemplate
+  | IHubFeedback;

packages/common/src/core/types/HubEntityType.ts

@@ -9,5 +9,6 @@ export const HUB_ENTITY_TYPES = [
   "org",
   "group",
   "template",
+  "feedback",
 ] as const;
 export type HubEntityType = (typeof HUB_ENTITY_TYPES)[number];

packages/common/src/core/types/IHubFeedback.ts

@@ -0,0 +1,10 @@
+import { IWithPermissions } from "../traits";
+import { IHubItemEntity, IHubItemEntityEditor } from "./IHubItemEntity";
+
+/**
+ * Defines properties of Hub Feedback object
+ * @internal
+ */
+export interface IHubFeedback extends IHubItemEntity, IWithPermissions {}
+
+export type IHubFeedbackEditor = IHubItemEntityEditor<IHubFeedback> & {};

packages/common/src/core/types/index.ts

@@ -9,6 +9,7 @@ export * from "./IHubDiscussion";
 export * from "./IHubEditableContent";
 export * from "./IHubEntityBase";
 export * from "./IHubEvent";
+export * from "./IHubFeedback";
 export * from "./IHubGroup";
 export * from "./IHubImage";
 export * from "./IHubInitiative";

packages/common/src/discussions/HubDiscussion.ts

@@ -157,7 +157,7 @@ export class HubDiscussion
   }
 
   /*
-   * Get the editor config for the HubProject entity.
+   * Get the editor config for the HubDiscussion entity.
    * @param i18nScope translation scope to be interpolated into the uiSchema
    * @param type editor type - corresonds to the returned uiSchema
    * @param options optional hash of dynamic uiSchema element options

packages/common/src/discussions/api/settings/getDefaultEntitySettings.ts

@@ -25,6 +25,7 @@ const DEFAULT_ENTITY_SETTINGS_BY_ENTITY_TYPE: Record<
   org: null,
   group: null,
   template: null,
+  feedback: null,
 };
 
 export function getDefaultEntitySettings(

packages/common/src/feedback/HubFeedback.ts

@@ -0,0 +1,149 @@
+import { HubItemEntity } from "../core/HubItemEntity";
+import { IWithEditorBehavior } from "../core/behaviors/IWithEditorBehavior";
+import { enrichEntity } from "../core/enrichEntity";
+import { getEditorConfig } from "../core/schemas/getEditorConfig";
+import { IEditorConfig } from "../core/schemas/types";
+import { HubEntity } from "../core/types/HubEntity";
+import {
+  HubEntityEditor,
+  IEntityEditorContext,
+} from "../core/types/HubEntityEditor";
+import { IHubFeedback, IHubFeedbackEditor } from "../core/types/IHubFeedback";
+import { cloneObject } from "../util";
+import { FeedbackEditorType } from "./_internal/FeedbackSchema";
+import { deleteFeedback, updateFeedback } from "./edit";
+
+/**
+ * Hub Feedback Class
+ */
+export class HubFeedback
+  extends HubItemEntity<IHubFeedback>
+  implements IWithEditorBehavior
+{
+  /**
+   * Apply a new state to the instance
+   * @param changes A partial IHubFeedback
+   */
+  update(changes: Partial<IHubFeedback>): void {
+    if (this.isDestroyed) {
+      throw new Error("HubFeedback is already destroyed.");
+    }
+    // merge partial onto existing entity
+    this.entity = { ...this.entity, ...changes };
+  }
+
+  /**
+   * Save the class instance
+   */
+  async save(): Promise<void> {
+    if (this.isDestroyed) {
+      throw new Error("HubFeedback is already destroyed.");
+    }
+
+    if (this.entity.id) {
+      // update it
+      this.entity = await updateFeedback(
+        this.entity,
+        this.context.userRequestOptions
+      );
+    }
+
+    // call the after save hook on superclass
+    await super.afterSave();
+
+    return;
+  }
+
+  /**
+   * Delete the HubFeedback object from the store
+   * set a flag to indicate that it is destroyed
+   * @returns a promise
+   */
+  async delete(): Promise<void> {
+    if (this.isDestroyed) {
+      throw new Error("HubFeedback is already destroyed.");
+    }
+    this.isDestroyed = true;
+    // Delegate to module fn
+    await deleteFeedback(this.entity.id, this.context.userRequestOptions);
+  }
+
+  /*
+   * Get the editor config for the HubFeedback entity.
+   * @param i18nScope translation scope to be interpolated into the uiSchema
+   * @param type editor type - corresonds to the returned uiSchema
+   */
+  getEditorConfig(
+    i18nScope: string,
+    type: FeedbackEditorType
+  ): Promise<IEditorConfig> {
+    // delegate to the schema subsystem
+    return getEditorConfig(i18nScope, type, this.entity, this.context);
+  }
+
+  /**
+   * Return the feedback object as an editor object
+   * @param editorContext
+   * @param include
+   * @returns
+   */
+  async toEditor(
+    editorContext: IEntityEditorContext,
+    include?: string[]
+  ): Promise<HubEntityEditor> {
+    // 1. optionally enrich entity and cast to editor
+    const editor = include.length
+      ? ((await enrichEntity(
+          cloneObject(this.entity),
+          include,
+          this.context.hubRequestOptions
+        )) as IHubFeedbackEditor)
+      : (cloneObject(this.entity) as IHubFeedbackEditor);
+
+    // 2. Apply transforms to relevant entity values so they
+    // can be consumed by the editor
+    return editor;
+  }
+
+  /**
+   * Load the feedback object from the editor object
+   * @param editor
+   * @param editorContext
+   * @returns IHubFeedback
+   */
+  async fromEditor(
+    editor: HubEntityEditor,
+    editorContext?: IEntityEditorContext
+  ): Promise<HubEntity> {
+    // Setting the thumbnailCache will ensure that
+    // the thumbnail is updated on 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;
+
+    // convert back to an entity. Apply any reverse transforms used in
+    // of the toEditor method
+    const entity = cloneObject(editor) as IHubFeedback;
+
+    // copy the location extent up one level
+    entity.extent = editor.location?.extent;
+
+    // Save, which will also create new content if new
+    this.entity = entity;
+    await this.save();
+
+    return this.entity;
+  }
+}

packages/common/src/feedback/_internal/FeedbackBusinessRules.ts

@@ -0,0 +1,75 @@
+import { IPermissionPolicy } from "../../permissions/types/IPermissionPolicy";
+
+/**
+ * Feedback Permission Policies
+ * These define the requirements any user must meet to perform related actions
+ * @private
+ */
+export const FeedbackPermissions = [
+  "hub:feedback",
+  "hub:feedback:create",
+  "hub:feedback:delete",
+  "hub:feedback:edit",
+  "hub:feedback:view",
+  "hub:feedback:workspace",
+  "hub:feedback:workspace:dashboard",
+  "hub:feedback:workspace:details",
+  "hub:feedback:workspace:settings",
+  "hub:feedback:manage",
+] as const;
+
+/**
+ * Feedback permission policies
+ * @private
+ */
+export const FeedbackPermissionPolicies: IPermissionPolicy[] = [
+  {
+    permission: "hub:feedback",
+    services: ["portal"],
+    // gated for now
+    availability: ["alpha"],
+    environments: ["devext", "qaext"],
+  },
+  {
+    permission: "hub:feedback:view",
+    dependencies: ["hub:feedback"],
+  },
+  {
+    permission: "hub:feedback:create",
+    authenticated: true,
+    dependencies: ["hub:feedback"],
+    entityEdit: true,
+  },
+  {
+    permission: "hub:feedback:edit",
+    authenticated: true,
+    dependencies: ["hub:feedback"],
+    entityEdit: true,
+  },
+  {
+    permission: "hub:feedback:delete",
+    authenticated: true,
+    dependencies: ["hub:feedback"],
+    entityOwner: true,
+  },
+  {
+    permission: "hub:feedback:workspace",
+    dependencies: ["hub:feature:workspace"],
+  },
+  {
+    permission: "hub:feedback:workspace:dashboard",
+    dependencies: ["hub:feedback:workspace", "hub:feedback:view"],
+  },
+  {
+    permission: "hub:feedback:workspace:details",
+    dependencies: ["hub:feedback:workspace", "hub:feedback:edit"],
+  },
+  {
+    permission: "hub:feedback:workspace:settings",
+    dependencies: ["hub:feedback:workspace", "hub:feedback:edit"],
+  },
+  {
+    permission: "hub:feedback:manage",
+    dependencies: ["hub:feedback:edit"],
+  },
+];

packages/common/src/feedback/_internal/FeedbackSchema.ts

@@ -0,0 +1,28 @@
+import { HubItemEntitySchema } from "../../core/schemas/shared/HubItemEntitySchema";
+import { IConfigurationSchema } from "../../core/schemas/types";
+
+export type FeedbackEditorType = (typeof FeedbackEditorTypes)[number];
+export const FeedbackEditorTypes = [
+  "hub:feedback:edit",
+  "hub:feedback:settings",
+] as const;
+
+/**
+ * defines the JSON schema for a Feedback entity's editable fields
+ */
+export const FeedbackSchema: IConfigurationSchema = {
+  ...HubItemEntitySchema,
+  properties: {
+    displayMap: {
+      type: "boolean",
+      enum: [true, false],
+      default: false,
+    },
+    hasMapQuestion: {
+      type: "boolean",
+      enum: [true, false],
+      default: false,
+    },
+    ...HubItemEntitySchema.properties,
+  },
+} as IConfigurationSchema;