fix(hub-common): add CRUD functions for entity settings (#1275)

* fix(hub-common): add CRUD functions for entity settings

affects: @esri/hub-common

* fix(hub-common): rename setting interfaces

affects: @esri/hub-common, @esri/hub-discussions

* fix(hub-discussions): export updated setting interfaces from hub-common

affects: @esri/hub-discussions

packages/common/src/discussions/api/index.ts

@@ -1,2 +1,3 @@
 export * from "./channels";
+export * from "./settings";
 export * from "./types";

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

@@ -0,0 +1 @@
+export * from "./settings";

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

@@ -0,0 +1,65 @@
+import { request } from "../request";
+import {
+  ICreateSettingParams,
+  IEntitySetting,
+  IFetchSettingParams,
+  IRemoveSettingParams,
+  IRemoveSettingResponse,
+  IUpdateSettingParams,
+} from "../types";
+
+/**
+ * create setting
+ *
+ * @export
+ * @param {ICreateSettingParams} options
+ * @return {*} {Promise<IEntitySetting>}
+ */
+export function createSetting(
+  options: ICreateSettingParams
+): Promise<IEntitySetting> {
+  options.httpMethod = "POST";
+  return request(`/settings`, options);
+}
+
+/**
+ * fetch setting
+ *
+ * @export
+ * @param {IFetchSettingParams} options
+ * @return {*} {Promise<IEntitySetting>}
+ */
+export function fetchSetting(
+  options: IFetchSettingParams
+): Promise<IEntitySetting> {
+  options.httpMethod = "GET";
+  return request(`/settings/${options.id}`, options);
+}
+
+/**
+ * update setting
+ *
+ * @export
+ * @param {IUpdateSettingParams} options
+ * @return {*} {Promise<IEntitySetting>}
+ */
+export function updateSetting(
+  options: IUpdateSettingParams
+): Promise<IEntitySetting> {
+  options.httpMethod = "PATCH";
+  return request(`/settings/${options.id}`, options);
+}
+
+/**
+ * remove setting
+ *
+ * @export
+ * @param {IRemoveSettingParams} options
+ * @return {*} {Promise<IRemoveSettingResponse>}
+ */
+export function removeSetting(
+  options: IRemoveSettingParams
+): Promise<IRemoveSettingResponse> {
+  options.httpMethod = "DELETE";
+  return request(`/settings/${options.id}`, options);
+}

packages/common/src/discussions/api/types.ts

@@ -1022,33 +1022,36 @@ export interface IRemoveChannelActivityParams
 }
 
 /**
- * representation of a setting record from the service
+ * representation of an entity setting record from the service
  *
  * @export
- * @interface ISetting
+ * @interface IEntitySetting
  * @extends {IWithAuthor}
  * @extends {IWithEditor}
  * @extends {IWithTimestamps}
  */
-export interface ISetting extends IWithAuthor, IWithEditor, IWithTimestamps {
+export interface IEntitySetting
+  extends IWithAuthor,
+    IWithEditor,
+    IWithTimestamps {
   id: string;
-  type: SettingType;
-  settings: IContentSettings;
+  type: EntitySettingType;
+  settings: IEntityContentSettings;
 }
 
 /**
  * @export
  * @enum {string}
  */
-export enum SettingType {
+export enum EntitySettingType {
   CONTENT = "content",
 }
 
 /**
  * @export
- * @interface IContentSettings
+ * @interface IEntityContentSettings
  */
-export interface IContentSettings {
+export interface IEntityContentSettings {
   discussions?: IDiscussionsSettings;
 }
 
@@ -1076,16 +1079,16 @@ export interface IRemoveSettingResponse {
  */
 export interface ICreateSetting {
   id: string;
-  type: SettingType;
-  settings: IContentSettings;
+  type: EntitySettingType;
+  settings: IEntityContentSettings;
 }
 
 /**
  * @export
  * @interface IUpdateSetting
  */
 export interface IUpdateSetting {
-  settings: Partial<IContentSettings>;
+  settings: Partial<IEntityContentSettings>;
 }
 
 /**

packages/discussions/test/settings.test.ts → packages/common/test/discussions/api/settings.test.ts

@@ -1,20 +1,20 @@
-import * as req from "../src/request";
+import * as req from "../../../src/discussions/api/request";
 import {
   createSetting,
   fetchSetting,
   removeSetting,
   updateSetting,
-} from "../src/settings";
+} from "../../../src/discussions/api/settings";
 import {
-  SettingType,
+  EntitySettingType,
   ICreateSetting,
   ICreateSettingParams,
   IDiscussionsRequestOptions,
   IRemoveSettingParams,
   IUpdateSetting,
   IUpdateSettingParams,
   IFetchSettingParams,
-} from "../src/types";
+} from "../../../src/discussions/api/types";
 
 describe("settings", () => {
   let requestSpy: any;
@@ -33,7 +33,7 @@ describe("settings", () => {
   it("createSetting", async () => {
     const body: ICreateSetting = {
       id: "uuidv4",
-      type: SettingType.CONTENT,
+      type: EntitySettingType.CONTENT,
       settings: {
         discussions: {
           allowedChannelIds: ["aaa"],

packages/discussions/src/settings/settings.ts

@@ -1,63 +1,6 @@
-import { request } from "../request";
-import {
-  ICreateSettingParams,
-  ISetting,
-  IFetchSettingParams,
-  IRemoveSettingParams,
-  IRemoveSettingResponse,
-  IUpdateSettingParams,
-} from "../types";
-
-/**
- * create setting
- *
- * @export
- * @param {ICreateSettingParams} options
- * @return {*} {Promise<ISetting>}
- */
-export function createSetting(
-  options: ICreateSettingParams
-): Promise<ISetting> {
-  options.httpMethod = "POST";
-  return request(`/settings`, options);
-}
-
-/**
- * fetch setting
- *
- * @export
- * @param {IFetchSettingParams} options
- * @return {*} {Promise<ISetting>}
- */
-export function fetchSetting(options: IFetchSettingParams): Promise<ISetting> {
-  options.httpMethod = "GET";
-  return request(`/settings/${options.id}`, options);
-}
-
-/**
- * update setting
- *
- * @export
- * @param {IUpdateSettingParams} options
- * @return {*} {Promise<ISetting>}
- */
-export function updateSetting(
-  options: IUpdateSettingParams
-): Promise<ISetting> {
-  options.httpMethod = "PATCH";
-  return request(`/settings/${options.id}`, options);
-}
-
-/**
- * remove setting
- *
- * @export
- * @param {IRemoveSettingParams} options
- * @return {*} {Promise<IRemoveSettingResponse>}
- */
-export function removeSetting(
-  options: IRemoveSettingParams
-): Promise<IRemoveSettingResponse> {
-  options.httpMethod = "DELETE";
-  return request(`/settings/${options.id}`, options);
-}
+export {
+  createSetting,
+  fetchSetting,
+  updateSetting,
+  removeSetting,
+} from "@esri/hub-common";

packages/discussions/src/types.ts

@@ -74,9 +74,9 @@ export {
   ICreateChannelNotificationOptOutParams,
   IRemoveChannelNotificationOptOutParams,
   IRemoveChannelActivityParams,
-  ISetting,
-  SettingType,
-  IContentSettings,
+  IEntitySetting,
+  EntitySettingType,
+  IEntityContentSettings,
   IDiscussionsSettings,
   IRemoveSettingResponse,
   ICreateSetting,