@esri/hub-discussions - npm Package Compare versions

Comparing version 25.2.1 to 25.3.0

dist/esm/channels/channels.js

@@ -37,4 +37,4 @@ import { request } from "../request";
  * update channel
- * NOTE: only updates channel settings properties (softDelete, allowedReactions, etc). A Channel's
- * access and groups cannot be updated.
+ * NOTE: only updates channel settings properties and access (softDelete, allowedReactions, etc). A Channel's
+ * groups cannot be updated.
  *
@@ -41,0 +41,0 @@ * @export

dist/esm/discussion-settings/discussion-settings.js

 import { request } from "../request";
+/**
+ * create discussion settings
+ *
+ * @export
+ * @param {ICreateDiscussionSettingParams} options
+ * @return {*} {Promise<IDiscussionSetting>}
+ */
 export function createDiscussionSetting(options) {
@@ -6,2 +13,13 @@ options.httpMethod = "POST";
 }
+/**
+ * remove discussion settings
+ *
+ * @export
+ * @param {IRemoveDiscussionSettingParams} options
+ * @return {*} {Promise<IDiscussionSetting>}
+ */
+export function removeDiscussionSetting(options) {
+    options.httpMethod = "DELETE";
+    return request(`/discussion_settings/${options.id}`, options);
+}
 //# sourceMappingURL=discussion-settings.js.map

dist/esm/types.js

@@ -129,5 +129,5 @@ /**
 })(ChannelFilter || (ChannelFilter = {}));
-// sorting
 /**
- * Common sorting fields
+ * @export
+ * @enum {string}
  */
@@ -160,2 +160,3 @@ export var CommonSort;
  *
+ * @export
  * @enum {string}
@@ -180,2 +181,3 @@ */
  *
+ * @export
  * @enum{string}
@@ -216,2 +218,6 @@ */
 })(ChannelRelation || (ChannelRelation = {}));
+/**
+ * @export
+ * @enum {string}
+ */
 export var AclCategory;
@@ -225,2 +231,6 @@ (function (AclCategory) {
 })(AclCategory || (AclCategory = {}));
+/**
+ * @export
+ * @enum {string}
+ */
 export var AclSubCategory;
@@ -231,2 +241,6 @@ (function (AclSubCategory) {
 })(AclSubCategory || (AclSubCategory = {}));
+/**
+ * @export
+ * @enum {string}
+ */
 export var DiscussionSettingType;
@@ -233,0 +247,0 @@ (function (DiscussionSettingType) {

dist/node/channels/channels.js

@@ -43,4 +43,4 @@ "use strict";
  * update channel
- * NOTE: only updates channel settings properties (softDelete, allowedReactions, etc). A Channel's
- * access and groups cannot be updated.
+ * NOTE: only updates channel settings properties and access (softDelete, allowedReactions, etc). A Channel's
+ * groups cannot be updated.
  *
@@ -47,0 +47,0 @@ * @export

dist/node/discussion-settings/discussion-settings.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createDiscussionSetting = void 0;
+exports.removeDiscussionSetting = exports.createDiscussionSetting = void 0;
 const request_1 = require("../request");
+/**
+ * create discussion settings
+ *
+ * @export
+ * @param {ICreateDiscussionSettingParams} options
+ * @return {*} {Promise<IDiscussionSetting>}
+ */
 function createDiscussionSetting(options) {
@@ -10,2 +17,14 @@ options.httpMethod = "POST";
 exports.createDiscussionSetting = createDiscussionSetting;
+/**
+ * remove discussion settings
+ *
+ * @export
+ * @param {IRemoveDiscussionSettingParams} options
+ * @return {*} {Promise<IDiscussionSetting>}
+ */
+function removeDiscussionSetting(options) {
+    options.httpMethod = "DELETE";
+    return request_1.request(`/discussion_settings/${options.id}`, options);
+}
+exports.removeDiscussionSetting = removeDiscussionSetting;
 //# sourceMappingURL=discussion-settings.js.map

dist/node/types.js

@@ -132,5 +132,5 @@ "use strict";
 })(ChannelFilter = exports.ChannelFilter || (exports.ChannelFilter = {}));
-// sorting
 /**
- * Common sorting fields
+ * @export
+ * @enum {string}
  */
@@ -163,2 +163,3 @@ var CommonSort;
  *
+ * @export
  * @enum {string}
@@ -183,2 +184,3 @@ */
  *
+ * @export
  * @enum{string}
@@ -219,2 +221,6 @@ */
 })(ChannelRelation = exports.ChannelRelation || (exports.ChannelRelation = {}));
+/**
+ * @export
+ * @enum {string}
+ */
 var AclCategory;
@@ -228,2 +234,6 @@ (function (AclCategory) {
 })(AclCategory = exports.AclCategory || (exports.AclCategory = {}));
+/**
+ * @export
+ * @enum {string}
+ */
 var AclSubCategory;
@@ -234,2 +244,6 @@ (function (AclSubCategory) {
 })(AclSubCategory = exports.AclSubCategory || (exports.AclSubCategory = {}));
+/**
+ * @export
+ * @enum {string}
+ */
 var DiscussionSettingType;
@@ -236,0 +250,0 @@ (function (DiscussionSettingType) {

dist/types/channels/channels.d.ts

@@ -28,4 +28,4 @@ import { ISearchChannelsParams, ICreateChannelParams, IFetchChannelParams, IUpdateChannelParams, IRemoveChannelParams, IChannel, IRemoveChannelResponse, IFetchChannelNotificationOptOutParams, ICreateChannelNotificationOptOutParams, IRemoveChannelNotificationOptOutParams, IRemoveChannelActivityParams, IPagedResponse, IRemoveChannelNotificationOptOutResult, IRemoveChannelActivityResult, IChannelNotificationOptOut } from "../types";
  * update channel
- * NOTE: only updates channel settings properties (softDelete, allowedReactions, etc). A Channel's
- * access and groups cannot be updated.
+ * NOTE: only updates channel settings properties and access (softDelete, allowedReactions, etc). A Channel's
+ * groups cannot be updated.
  *
@@ -32,0 +32,0 @@ * @export

dist/types/discussion-settings/discussion-settings.d.ts

@@ -1,2 +0,17 @@
-import { ICreateDiscussionSettingParams, IDiscussionSetting } from "../types";
+import { ICreateDiscussionSettingParams, IDiscussionSetting, IRemoveDiscussionSettingParams } from "../types";
+/**
+ * create discussion settings
+ *
+ * @export
+ * @param {ICreateDiscussionSettingParams} options
+ * @return {*} {Promise<IDiscussionSetting>}
+ */
 export declare function createDiscussionSetting(options: ICreateDiscussionSettingParams): Promise<IDiscussionSetting>;
+/**
+ * remove discussion settings
+ *
+ * @export
+ * @param {IRemoveDiscussionSettingParams} options
+ * @return {*} {Promise<IDiscussionSetting>}
+ */
+export declare function removeDiscussionSetting(options: IRemoveDiscussionSettingParams): Promise<IDiscussionSetting>;

dist/types/types.d.ts

@@ -156,3 +156,4 @@ import { IPagingParams, IPagedResponse as IRestPagedResponse, IUser } from "@esri/arcgis-rest-types";
 /**
- * Common sorting fields
+ * @export
+ * @enum {string}
  */
@@ -272,3 +273,3 @@ export declare enum CommonSort {
  * @export
- * @interface IRequestOptions
+ * @interface IDiscussionsRequestOptions
  * @extends {RequestInit}
@@ -301,2 +302,5 @@ */
  * mention email
+ *
+ * @export
+ * @interface IDiscussionsMentionMeta
  */
@@ -309,2 +313,7 @@ export interface IDiscussionsMentionMeta {
 }
+/**
+ * @export
+ * @interface IDiscussionsUser
+ * @extends {IUser}
+ */
 export interface IDiscussionsUser extends IUser {
@@ -371,2 +380,3 @@ username?: string | null;
  *
+ * @export
  * @enum {string}
@@ -390,2 +400,3 @@ */
  *
+ * @export
  * @enum{string}
@@ -545,3 +556,3 @@ */
  * @interface ISearchPostsParams
- * @extends {IHubRequestOptions}
+ * @extends {IDiscussionsRequestOptions}
  */
@@ -556,3 +567,3 @@ export interface ISearchPostsParams extends IDiscussionsRequestOptions {
  * @interface IFetchPostParams
- * @extends {IHubRequestOptions}
+ * @extends {IDiscussionsRequestOptions}
  */
@@ -568,3 +579,3 @@ export interface IFetchPostParams extends IDiscussionsRequestOptions {
  * @interface IUpdatePostParams
- * @extends {IHubRequestOptions}
+ * @extends {IDiscussionsRequestOptions}
  */
@@ -581,3 +592,3 @@ export interface IUpdatePostParams extends IDiscussionsRequestOptions {
  * @interface IUpdatePostStatusParams
- * @extends {IHubRequestOptions}
+ * @extends {IDiscussionsRequestOptions}
  */
@@ -593,3 +604,3 @@ export interface IUpdatePostStatusParams extends IDiscussionsRequestOptions {
  * @interface IRemovePostParams
- * @extends {IHubRequestOptions}
+ * @extends {IDiscussionsRequestOptions}
  */
@@ -633,2 +644,6 @@ export interface IRemovePostParams extends IDiscussionsRequestOptions {
 }
+/**
+ * @export
+ * @enum {string}
+ */
 export declare enum AclCategory {
@@ -641,2 +656,6 @@ GROUP = "group",
 }
+/**
+ * @export
+ * @enum {string}
+ */
 export declare enum AclSubCategory {
@@ -648,2 +667,5 @@ ADMIN = "admin",
  * request option for creating a channel ACL permission
+ *
+ * @export
+ * @interface IChannelAclPermissionDefinition
  */
@@ -659,2 +681,6 @@ export interface IChannelAclPermissionDefinition {
  * request option for updating a channel ACL permission
+ *
+ * @export
+ * @interface IChannelAclPermissionUpdateDefinition
+ * @extends {IChannelAclPermissionDefinition}
  */
@@ -694,2 +720,6 @@ export interface IChannelAclPermissionUpdateDefinition extends IChannelAclPermissionDefinition {
 }
+/**
+ * @export
+ * @interface IChannelMetadata
+ */
 export interface IChannelMetadata {
@@ -912,5 +942,13 @@ guidelineUrl?: string | null;
 }
+/**
+ * @export
+ * @enum {string}
+ */
 export declare enum DiscussionSettingType {
     CONTENT = "content"
 }
+/**
+ * @export
+ * @interface ISettings
+ */
 export interface ISettings {
@@ -920,4 +958,13 @@ allowedChannelIds: string[] | null;
 /**
- * parameters for creating a discussionSetting
+ * @export
+ * @interface IRemoveDiscussionSettingResponse
  */
+export interface IRemoveDiscussionSettingResponse {
+    id: string;
+    success: boolean;
+}
+/**
+ * @export
+ * @interface ICreateDiscussionSetting
+ */
 export interface ICreateDiscussionSetting {
@@ -928,4 +975,21 @@ id: string;
 }
+/**
+ * parameters for creating a discussionSetting
+ *
+ * @export
+ * @interface ICreateDiscussionSettingParams
+ * @extends {IDiscussionsRequestOptions}
+ */
 export interface ICreateDiscussionSettingParams extends IDiscussionsRequestOptions {
     data: ICreateDiscussionSetting;
 }
+/**
+ * parameters for removing a discussionSetting
+ *
+ * @export
+ * @interface IRemoveDiscussionSettingParams
+ * @extends {IDiscussionsRequestOptions}
+ */
+export interface IRemoveDiscussionSettingParams extends IDiscussionsRequestOptions {
+    id: string;
+}

package.json

 {
   "name": "@esri/hub-discussions",
-  "version": "25.2.1",
+  "version": "25.3.0",
   "description": "Module to interact with ArcGIS Hub Discussions API in Node.js and modern browsers.",
@@ -5,0 +5,0 @@ "main": "dist/node/index.js",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

201969

increased by1.65%

Lines of code

4017

increased by3.72%

No dependency changes