@esri/hub-discussions - npm Package Compare versions

Comparing version 16.0.0 to 16.0.1

dist/esm/channels/index.js

 export * from "./channels";
-export * from "./types";
 //# sourceMappingURL=index.js.map

dist/esm/posts/index.js

 export * from "./posts";
-export * from "./types";
 //# sourceMappingURL=index.js.map

dist/esm/reactions/index.js

 export * from "./reactions";
-export * from "./types";
 //# sourceMappingURL=index.js.map

dist/esm/types.js

@@ -1,5 +0,195 @@
-export * from "./channels/types";
-export * from "./posts/types";
-export * from "./reactions/types";
-export * from "./shared/types";
+/**
+ * sort orders
+ *
+ * @export
+ * @enum {string}
+ */
+export var SortOrder;
+(function (SortOrder) {
+    SortOrder["ASC"] = "ASC";
+    SortOrder["DESC"] = "DESC";
+})(SortOrder || (SortOrder = {}));
+/**
+ * reactions to posts
+ *
+ * @export
+ * @enum {string}
+ */
+export var PostReaction;
+(function (PostReaction) {
+    PostReaction["THUMBS_UP"] = "thumbs_up";
+    PostReaction["THUMBS_DOWN"] = "thumbs_down";
+    PostReaction["THINKING"] = "thinking";
+    PostReaction["HEART"] = "heart";
+    PostReaction["ONE_HUNDRED"] = "one_hundred";
+    PostReaction["SAD"] = "sad";
+    PostReaction["LAUGH"] = "laugh";
+    PostReaction["SURPRISED"] = "surprised";
+})(PostReaction || (PostReaction = {}));
+/**
+ * platform sharing access values
+ *
+ * @export
+ * @enum {string}
+ */
+export var SharingAccess;
+(function (SharingAccess) {
+    SharingAccess["PUBLIC"] = "public";
+    SharingAccess["ORG"] = "org";
+    SharingAccess["PRIVATE"] = "private";
+})(SharingAccess || (SharingAccess = {}));
+/**
+ * possible statuses of a post
+ *
+ * @export
+ * @enum {string}
+ */
+export var PostStatus;
+(function (PostStatus) {
+    PostStatus["PENDING"] = "pending";
+    PostStatus["APPROVED"] = "approved";
+    PostStatus["REJECTED"] = "rejected";
+    PostStatus["DELETED"] = "deleted";
+    PostStatus["HIDDEN"] = "hidden";
+})(PostStatus || (PostStatus = {}));
+/**
+ * possible discussionn content types, i.e. a post can be about an item, dataset, or group
+ *
+ * @export
+ * @enum {string}
+ */
+export var DiscussionType;
+(function (DiscussionType) {
+    DiscussionType["GROUP"] = "group";
+    DiscussionType["CONTENT"] = "content";
+})(DiscussionType || (DiscussionType = {}));
+/**
+ * source of a post, i.e. app context
+ *
+ * @export
+ * @enum {string}
+ */
+export var DiscussionSource;
+(function (DiscussionSource) {
+    DiscussionSource["HUB"] = "hub";
+    DiscussionSource["AGO"] = "ago";
+    DiscussionSource["URBAN"] = "urban";
+})(DiscussionSource || (DiscussionSource = {}));
+/**
+ * relations of post entity
+ *
+ * @export
+ * @enum {string}
+ */
+export var PostRelation;
+(function (PostRelation) {
+    PostRelation["REPLIES"] = "replies";
+    PostRelation["REACTIONS"] = "reactions";
+    PostRelation["PARENT"] = "parent";
+    PostRelation["CHANNEL"] = "channel";
+})(PostRelation || (PostRelation = {}));
+/**
+ * relations of reaction entity
+ *
+ * @export
+ * @enum {string}
+ */
+export var ReactionRelation;
+(function (ReactionRelation) {
+    ReactionRelation["POST"] = "post";
+})(ReactionRelation || (ReactionRelation = {}));
+/**
+ * filters of channel entity
+ *
+ * @export
+ * @enum {string}
+ */
+export var ChannelFilter;
+(function (ChannelFilter) {
+    ChannelFilter["HAS_USER_POSTS"] = "has_user_posts";
+})(ChannelFilter || (ChannelFilter = {}));
+// sorting
+/**
+ * Common sorting fields
+ */
+export var CommonSort;
+(function (CommonSort) {
+    CommonSort["CREATED_AT"] = "createdAt";
+    CommonSort["CREATOR"] = "creator";
+    CommonSort["EDITOR"] = "editor";
+    CommonSort["ID"] = "id";
+    CommonSort["UPDATED_AT"] = "updatedAt";
+})(CommonSort || (CommonSort = {}));
+/**
+ * Role types
+ *
+ * @export
+ * @enum {string}
+ */
+export var Role;
+(function (Role) {
+    Role["READ"] = "read";
+    Role["WRITE"] = "write";
+    Role["READWRITE"] = "readWrite";
+    Role["MODERATE"] = "moderate";
+    Role["MANAGE"] = "manage";
+    Role["OWNER"] = "owner";
+})(Role || (Role = {}));
+/**
+ * Post sorting fields
+ *
+ * @enum {string}
+ */
+export var PostSort;
+(function (PostSort) {
+    PostSort["BODY"] = "body";
+    PostSort["CHANNEL_ID"] = "channelId";
+    PostSort["CREATED_AT"] = "createdAt";
+    PostSort["CREATOR"] = "creator";
+    PostSort["DISCUSSION"] = "discussion";
+    PostSort["EDITOR"] = "editor";
+    PostSort["ID"] = "id";
+    PostSort["PARENT_ID"] = "parentId";
+    PostSort["STATUS"] = "status";
+    PostSort["TITLE"] = "title";
+    PostSort["UPDATED_AT"] = "updatedAt";
+})(PostSort || (PostSort = {}));
+/**
+ * Post types
+ *
+ * @enum{string}
+ */
+export var PostType;
+(function (PostType) {
+    PostType["Text"] = "text";
+    PostType["Announcement"] = "announcement";
+    PostType["Poll"] = "poll";
+    PostType["Question"] = "question";
+})(PostType || (PostType = {}));
+/**
+ * Channel sorting fields
+ *
+ * @export
+ * @enum {string}
+ */
+export var ChannelSort;
+(function (ChannelSort) {
+    ChannelSort["ACCESS"] = "access";
+    ChannelSort["CREATED_AT"] = "createdAt";
+    ChannelSort["CREATOR"] = "creator";
+    ChannelSort["EDITOR"] = "editor";
+    ChannelSort["ID"] = "id";
+    ChannelSort["LAST_ACTIVITY"] = "last_activity";
+    ChannelSort["UPDATED_AT"] = "updatedAt";
+})(ChannelSort || (ChannelSort = {}));
+/**
+ * relations of channel entity
+ *
+ * @export
+ * @enum {string}
+ */
+export var ChannelRelation;
+(function (ChannelRelation) {
+    ChannelRelation["SETTINGS"] = "settings";
+})(ChannelRelation || (ChannelRelation = {}));
 //# sourceMappingURL=types.js.map

dist/esm/utils/channels/can-post-to-channel.js

@@ -1,2 +0,2 @@
-import { Role, SharingAccess } from "../../shared/types";
+import { Role, SharingAccess, } from "../../types";
 import { CANNOT_DISCUSS } from "../constants";
@@ -3,0 +3,0 @@ const ALLOWED_GROUP_ROLES = Object.freeze(["owner", "admin", "member"]);

dist/node/channels/index.js

@@ -5,3 +5,2 @@ "use strict";
 tslib_1.__exportStar(require("./channels"), exports);
-tslib_1.__exportStar(require("./types"), exports);
 //# sourceMappingURL=index.js.map

dist/node/posts/index.js

@@ -5,3 +5,2 @@ "use strict";
 tslib_1.__exportStar(require("./posts"), exports);
-tslib_1.__exportStar(require("./types"), exports);
 //# sourceMappingURL=index.js.map

dist/node/reactions/index.js

@@ -5,3 +5,2 @@ "use strict";
 tslib_1.__exportStar(require("./reactions"), exports);
-tslib_1.__exportStar(require("./types"), exports);
 //# sourceMappingURL=index.js.map

dist/node/types.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./channels/types"), exports);
-tslib_1.__exportStar(require("./posts/types"), exports);
-tslib_1.__exportStar(require("./reactions/types"), exports);
-tslib_1.__exportStar(require("./shared/types"), exports);
+exports.ChannelRelation = exports.ChannelSort = exports.PostType = exports.PostSort = exports.Role = exports.CommonSort = exports.ChannelFilter = exports.ReactionRelation = exports.PostRelation = exports.DiscussionSource = exports.DiscussionType = exports.PostStatus = exports.SharingAccess = exports.PostReaction = exports.SortOrder = void 0;
+/**
+ * sort orders
+ *
+ * @export
+ * @enum {string}
+ */
+var SortOrder;
+(function (SortOrder) {
+    SortOrder["ASC"] = "ASC";
+    SortOrder["DESC"] = "DESC";
+})(SortOrder = exports.SortOrder || (exports.SortOrder = {}));
+/**
+ * reactions to posts
+ *
+ * @export
+ * @enum {string}
+ */
+var PostReaction;
+(function (PostReaction) {
+    PostReaction["THUMBS_UP"] = "thumbs_up";
+    PostReaction["THUMBS_DOWN"] = "thumbs_down";
+    PostReaction["THINKING"] = "thinking";
+    PostReaction["HEART"] = "heart";
+    PostReaction["ONE_HUNDRED"] = "one_hundred";
+    PostReaction["SAD"] = "sad";
+    PostReaction["LAUGH"] = "laugh";
+    PostReaction["SURPRISED"] = "surprised";
+})(PostReaction = exports.PostReaction || (exports.PostReaction = {}));
+/**
+ * platform sharing access values
+ *
+ * @export
+ * @enum {string}
+ */
+var SharingAccess;
+(function (SharingAccess) {
+    SharingAccess["PUBLIC"] = "public";
+    SharingAccess["ORG"] = "org";
+    SharingAccess["PRIVATE"] = "private";
+})(SharingAccess = exports.SharingAccess || (exports.SharingAccess = {}));
+/**
+ * possible statuses of a post
+ *
+ * @export
+ * @enum {string}
+ */
+var PostStatus;
+(function (PostStatus) {
+    PostStatus["PENDING"] = "pending";
+    PostStatus["APPROVED"] = "approved";
+    PostStatus["REJECTED"] = "rejected";
+    PostStatus["DELETED"] = "deleted";
+    PostStatus["HIDDEN"] = "hidden";
+})(PostStatus = exports.PostStatus || (exports.PostStatus = {}));
+/**
+ * possible discussionn content types, i.e. a post can be about an item, dataset, or group
+ *
+ * @export
+ * @enum {string}
+ */
+var DiscussionType;
+(function (DiscussionType) {
+    DiscussionType["GROUP"] = "group";
+    DiscussionType["CONTENT"] = "content";
+})(DiscussionType = exports.DiscussionType || (exports.DiscussionType = {}));
+/**
+ * source of a post, i.e. app context
+ *
+ * @export
+ * @enum {string}
+ */
+var DiscussionSource;
+(function (DiscussionSource) {
+    DiscussionSource["HUB"] = "hub";
+    DiscussionSource["AGO"] = "ago";
+    DiscussionSource["URBAN"] = "urban";
+})(DiscussionSource = exports.DiscussionSource || (exports.DiscussionSource = {}));
+/**
+ * relations of post entity
+ *
+ * @export
+ * @enum {string}
+ */
+var PostRelation;
+(function (PostRelation) {
+    PostRelation["REPLIES"] = "replies";
+    PostRelation["REACTIONS"] = "reactions";
+    PostRelation["PARENT"] = "parent";
+    PostRelation["CHANNEL"] = "channel";
+})(PostRelation = exports.PostRelation || (exports.PostRelation = {}));
+/**
+ * relations of reaction entity
+ *
+ * @export
+ * @enum {string}
+ */
+var ReactionRelation;
+(function (ReactionRelation) {
+    ReactionRelation["POST"] = "post";
+})(ReactionRelation = exports.ReactionRelation || (exports.ReactionRelation = {}));
+/**
+ * filters of channel entity
+ *
+ * @export
+ * @enum {string}
+ */
+var ChannelFilter;
+(function (ChannelFilter) {
+    ChannelFilter["HAS_USER_POSTS"] = "has_user_posts";
+})(ChannelFilter = exports.ChannelFilter || (exports.ChannelFilter = {}));
+// sorting
+/**
+ * Common sorting fields
+ */
+var CommonSort;
+(function (CommonSort) {
+    CommonSort["CREATED_AT"] = "createdAt";
+    CommonSort["CREATOR"] = "creator";
+    CommonSort["EDITOR"] = "editor";
+    CommonSort["ID"] = "id";
+    CommonSort["UPDATED_AT"] = "updatedAt";
+})(CommonSort = exports.CommonSort || (exports.CommonSort = {}));
+/**
+ * Role types
+ *
+ * @export
+ * @enum {string}
+ */
+var Role;
+(function (Role) {
+    Role["READ"] = "read";
+    Role["WRITE"] = "write";
+    Role["READWRITE"] = "readWrite";
+    Role["MODERATE"] = "moderate";
+    Role["MANAGE"] = "manage";
+    Role["OWNER"] = "owner";
+})(Role = exports.Role || (exports.Role = {}));
+/**
+ * Post sorting fields
+ *
+ * @enum {string}
+ */
+var PostSort;
+(function (PostSort) {
+    PostSort["BODY"] = "body";
+    PostSort["CHANNEL_ID"] = "channelId";
+    PostSort["CREATED_AT"] = "createdAt";
+    PostSort["CREATOR"] = "creator";
+    PostSort["DISCUSSION"] = "discussion";
+    PostSort["EDITOR"] = "editor";
+    PostSort["ID"] = "id";
+    PostSort["PARENT_ID"] = "parentId";
+    PostSort["STATUS"] = "status";
+    PostSort["TITLE"] = "title";
+    PostSort["UPDATED_AT"] = "updatedAt";
+})(PostSort = exports.PostSort || (exports.PostSort = {}));
+/**
+ * Post types
+ *
+ * @enum{string}
+ */
+var PostType;
+(function (PostType) {
+    PostType["Text"] = "text";
+    PostType["Announcement"] = "announcement";
+    PostType["Poll"] = "poll";
+    PostType["Question"] = "question";
+})(PostType = exports.PostType || (exports.PostType = {}));
+/**
+ * Channel sorting fields
+ *
+ * @export
+ * @enum {string}
+ */
+var ChannelSort;
+(function (ChannelSort) {
+    ChannelSort["ACCESS"] = "access";
+    ChannelSort["CREATED_AT"] = "createdAt";
+    ChannelSort["CREATOR"] = "creator";
+    ChannelSort["EDITOR"] = "editor";
+    ChannelSort["ID"] = "id";
+    ChannelSort["LAST_ACTIVITY"] = "last_activity";
+    ChannelSort["UPDATED_AT"] = "updatedAt";
+})(ChannelSort = exports.ChannelSort || (exports.ChannelSort = {}));
+/**
+ * relations of channel entity
+ *
+ * @export
+ * @enum {string}
+ */
+var ChannelRelation;
+(function (ChannelRelation) {
+    ChannelRelation["SETTINGS"] = "settings";
+})(ChannelRelation = exports.ChannelRelation || (exports.ChannelRelation = {}));
 //# sourceMappingURL=types.js.map

dist/node/utils/channels/can-post-to-channel.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.canPostToChannel = void 0;
-const types_1 = require("../../shared/types");
+const types_1 = require("../../types");
 const constants_1 = require("../constants");
@@ -6,0 +6,0 @@ const ALLOWED_GROUP_ROLES = Object.freeze(["owner", "admin", "member"]);

dist/types/channels/channels.d.ts

@@ -1,3 +0,2 @@
-import { ISearchChannelsParams, ICreateChannelParams, IFetchChannelParams, IUpdateChannelParams, IRemoveChannelParams, IChannel, IRemoveChannelResponse, IFetchChannelNotificationOptOutParams, ICreateChannelNotificationOptOutParams, IRemoveChannelNotificationOptOutParams, IRemoveChannelActivityParams } from "./types";
-import { IPagedResponse, IRemoveChannelNotificationOptOutResult, IRemoveChannelActivityResult, IChannelNotificationOptOut } from "../shared/types";
+import { ISearchChannelsParams, ICreateChannelParams, IFetchChannelParams, IUpdateChannelParams, IRemoveChannelParams, IChannel, IRemoveChannelResponse, IFetchChannelNotificationOptOutParams, ICreateChannelNotificationOptOutParams, IRemoveChannelNotificationOptOutParams, IRemoveChannelActivityParams, IPagedResponse, IRemoveChannelNotificationOptOutResult, IRemoveChannelActivityResult, IChannelNotificationOptOut } from "../types";
 /**
@@ -4,0 +3,0 @@ * search channels

dist/types/channels/index.d.ts

 export * from "./channels";
-export * from "./types";

dist/types/posts/index.d.ts

 export * from "./posts";
-export * from "./types";

dist/types/posts/posts.d.ts

@@ -1,3 +0,2 @@
-import { IPagedResponse } from "../shared/types";
-import { ICreatePostParams, ICreateReplyParams, IPost, ISearchPostsParams, IFetchPostParams, IRemovePostParams, IRemovePostResponse, IUpdatePostSharingParams, IUpdatePostParams, IUpdatePostStatusParams } from "./types";
+import { ICreatePostParams, ICreateReplyParams, IPost, ISearchPostsParams, IFetchPostParams, IRemovePostParams, IRemovePostResponse, IUpdatePostSharingParams, IUpdatePostParams, IUpdatePostStatusParams, IPagedResponse } from "../types";
 /**
@@ -4,0 +3,0 @@ * search posts

dist/types/reactions/index.d.ts

 export * from "./reactions";
-export * from "./types";

dist/types/reactions/reactions.d.ts

@@ -1,2 +0,2 @@
-import { ICreateReactionOptions, IRemoveReactionOptions, IRemoveReactionResponse, IReaction } from "./types";
+import { ICreateReactionOptions, IRemoveReactionOptions, IRemoveReactionResponse, IReaction } from "../types";
 /**
@@ -3,0 +3,0 @@ * create reaction to post

dist/types/types.d.ts

@@ -1,4 +0,910 @@
-export * from "./channels/types";
-export * from "./posts/types";
-export * from "./reactions/types";
-export * from "./shared/types";
+import { IPagingParams, IPagedResponse as IRestPagedResponse, IUser } from "@esri/arcgis-rest-types";
+import { IHubRequestOptions } from "@esri/hub-common";
+import { Geometry } from "geojson";
+/**
+ * sort orders
+ *
+ * @export
+ * @enum {string}
+ */
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/**
+ * reactions to posts
+ *
+ * @export
+ * @enum {string}
+ */
+export declare enum PostReaction {
+    THUMBS_UP = "thumbs_up",
+    THUMBS_DOWN = "thumbs_down",
+    THINKING = "thinking",
+    HEART = "heart",
+    ONE_HUNDRED = "one_hundred",
+    SAD = "sad",
+    LAUGH = "laugh",
+    SURPRISED = "surprised"
+}
+/**
+ * platform sharing access values
+ *
+ * @export
+ * @enum {string}
+ */
+export declare enum SharingAccess {
+    PUBLIC = "public",
+    ORG = "org",
+    PRIVATE = "private"
+}
+/**
+ * representation of AGOL platform sharing ACL
+ * NOTE: orgs is an array to enable future org-org sharing/discussion
+ *
+ * @export
+ * @interface IPlatformSharing
+ */
+export interface IPlatformSharing {
+    groups: string[];
+    orgs: string[];
+    access: SharingAccess;
+}
+/**
+ * possible statuses of a post
+ *
+ * @export
+ * @enum {string}
+ */
+export declare enum PostStatus {
+    PENDING = "pending",
+    APPROVED = "approved",
+    REJECTED = "rejected",
+    DELETED = "deleted",
+    HIDDEN = "hidden"
+}
+/**
+ * possible discussionn content types, i.e. a post can be about an item, dataset, or group
+ *
+ * @export
+ * @enum {string}
+ */
+export declare enum DiscussionType {
+    GROUP = "group",
+    CONTENT = "content"
+}
+/**
+ * source of a post, i.e. app context
+ *
+ * @export
+ * @enum {string}
+ */
+export declare enum DiscussionSource {
+    HUB = "hub",
+    AGO = "ago",
+    URBAN = "urban"
+}
+/**
+ * named parts of a discussion URI, follows this convention:
+ * ${source}://${type}/${id}_${layer}?features=${...features}&attribute=${attribute}
+ *
+ * coarse-grained uri - hub://item/ab3 -- commenting from hub about item ab3
+ * --
+ * fine-grained uri - hub://dataset/3ef_0?features=10,32&attribute=species -- commenting from
+ * hub about species attribute of features id 10 & 32 in dataset 3ef layer 0
+ *
+ * @export
+ * @interface IDiscussionParams
+ */
+export interface IDiscussionParams {
+    source: string | null;
+    type: string | null;
+    id: string | null;
+    layer: string | null;
+    features: string[] | null;
+    attribute: string | null;
+}
+/**
+ * relations of post entity
+ *
+ * @export
+ * @enum {string}
+ */
+export declare enum PostRelation {
+    REPLIES = "replies",
+    REACTIONS = "reactions",
+    PARENT = "parent",
+    CHANNEL = "channel"
+}
+/**
+ * relations of reaction entity
+ *
+ * @export
+ * @enum {string}
+ */
+export declare enum ReactionRelation {
+    POST = "post"
+}
+/**
+ * filters of channel entity
+ *
+ * @export
+ * @enum {string}
+ */
+export declare enum ChannelFilter {
+    HAS_USER_POSTS = "has_user_posts"
+}
+/**
+ * Common sorting fields
+ */
+export declare enum CommonSort {
+    CREATED_AT = "createdAt",
+    CREATOR = "creator",
+    EDITOR = "editor",
+    ID = "id",
+    UPDATED_AT = "updatedAt"
+}
+/**
+ * creator property
+ *
+ * @export
+ * @interface IWithAuthor
+ */
+export interface IWithAuthor {
+    creator: string;
+}
+/**
+ * editor property
+ *
+ * @export
+ * @interface IWithEditor
+ */
+export interface IWithEditor {
+    editor: string;
+}
+/**
+ * sorting properties
+ *
+ * @export
+ * @interface IWithSorting
+ */
+export interface IWithSorting<SortEnum> {
+    sortBy: SortEnum;
+    sortOrder: SortOrder;
+}
+/**
+ * filtering properties
+ *
+ * @export
+ * @interface IWithFiltering
+ */
+export interface IWithFiltering<FilterEnum> {
+    filterBy: FilterEnum;
+}
+/**
+ * properties that enable temporal querying
+ *
+ * @export
+ * @interface IWithTimeQueries
+ */
+export interface IWithTimeQueries {
+    createdBefore: Date;
+    createdAfter: Date;
+    updatedBefore: Date;
+    updatedAfter: Date;
+}
+/**
+ * temporal properties
+ *
+ * @export
+ * @interface IWithTimestamps
+ */
+export interface IWithTimestamps {
+    createdAt: Date;
+    updatedAt: Date;
+}
+/**
+ * paginated response properties
+ *
+ * @export
+ * @interface IPagedResponse
+ * @extends {IRestPagedResponse}
+ * @template PaginationObject
+ */
+export interface IPagedResponse<PaginationObject> extends IRestPagedResponse {
+    items: PaginationObject[];
+}
+/**
+ * delete notifications opt out response properties
+ *
+ * @export
+ * @interface IRemoveChannelNotificationOptOutResult
+ */
+export interface IRemoveChannelNotificationOptOutResult {
+    success: boolean;
+    channelId: string;
+    username: string;
+}
+/**
+ * delete channel activity response properties
+ *
+ * @export
+ * @interface IRemoveChannelActivityResult
+ */
+export interface IRemoveChannelActivityResult {
+    success: boolean;
+    channelId: string;
+    username: string;
+}
+/**
+ * opt out response properties
+ *
+ * @export
+ * @interface IChannelNotificationOptOut
+ */
+export interface IChannelNotificationOptOut {
+    channelId: string;
+    username: string;
+}
+/**
+ * options for making requests against Discussion API
+ *
+ * @export
+ * @interface IRequestOptions
+ * @extends {RequestInit}
+ */
+export interface IDiscussionsRequestOptions extends Omit<IHubRequestOptions, "httpMethod" | "isPortal">, Pick<RequestInit, "mode" | "cache" | "credentials"> {
+    httpMethod?: "GET" | "POST" | "PATCH" | "DELETE";
+    isPortal?: boolean;
+    token?: string;
+    data?: {
+        [key: string]: any;
+    };
+}
+/**
+ * Role types
+ *
+ * @export
+ * @enum {string}
+ */
+export declare enum Role {
+    READ = "read",
+    WRITE = "write",
+    READWRITE = "readWrite",
+    MODERATE = "moderate",
+    MANAGE = "manage",
+    OWNER = "owner"
+}
+/**
+ * Interface representing the meta data associated with a discussions
+ * mention email
+ */
+export interface IDiscussionsMentionMeta {
+    channelId: string;
+    discussion: string;
+    postId: string;
+    replyId?: string;
+}
+export interface IDiscussionsUser extends IUser {
+    username?: string | null;
+}
+/**
+ * representation of reaction from the service
+ *
+ * @export
+ * @interface IReaction
+ * @extends {IWithAuthor}
+ * @extends {IWithEditor}
+ * @extends {IWithTimestamps}
+ */
+export interface IReaction extends IWithAuthor, IWithEditor, IWithTimestamps {
+    id: string;
+    value: PostReaction;
+    postId?: string;
+    post?: IPost;
+}
+/**
+ * dto for creating a reaction
+ *
+ * @export
+ * @interface ICreateReaction
+ */
+export interface ICreateReaction {
+    postId: string;
+    value: PostReaction;
+}
+/**
+ * request options for creating a reaction to a post
+ *
+ * @export
+ * @interface ICreateReactionOptions
+ * @extends {IHubRequestOptions}
+ */
+export interface ICreateReactionOptions extends IDiscussionsRequestOptions {
+    data: ICreateReaction;
+}
+/**
+ * request options for deleting a reaction
+ *
+ * @export
+ * @interface IRemoveReactionOptions
+ * @extends {IHubRequestOptions}
+ */
+export interface IRemoveReactionOptions extends IDiscussionsRequestOptions {
+    reactionId: string;
+}
+/**
+ * delete reaction response properties
+ *
+ * @export
+ * @interface IRemoveReactionResponse
+ */
+export interface IRemoveReactionResponse {
+    success: boolean;
+    reactionId: string;
+}
+/**
+ * Post sorting fields
+ *
+ * @enum {string}
+ */
+export declare enum PostSort {
+    BODY = "body",
+    CHANNEL_ID = "channelId",
+    CREATED_AT = "createdAt",
+    CREATOR = "creator",
+    DISCUSSION = "discussion",
+    EDITOR = "editor",
+    ID = "id",
+    PARENT_ID = "parentId",
+    STATUS = "status",
+    TITLE = "title",
+    UPDATED_AT = "updatedAt"
+}
+/**
+ * Post types
+ *
+ * @enum{string}
+ */
+export declare enum PostType {
+    Text = "text",
+    Announcement = "announcement",
+    Poll = "poll",
+    Question = "question"
+}
+export declare type PostReactionSummary = {
+    [key in PostReaction]: string[];
+};
+/**
+ * representation of post from service
+ *
+ * @export
+ * @interface IPost
+ * @extends {IWithAuthor}
+ * @extends {IWithEditor}
+ * @extends {IWithTimestamps}
+ */
+export interface IPost extends IWithAuthor, IWithEditor, IWithTimestamps {
+    id: string;
+    title: string | null;
+    body: string;
+    status: PostStatus;
+    appInfo: string | null;
+    discussion: string | null;
+    geometry: Geometry | null;
+    featureGeometry: Geometry | null;
+    postType: PostType;
+    channelId?: string;
+    channel?: IChannel;
+    parentId?: string;
+    parent?: IPost | null;
+    replies?: IPost[] | IPagedResponse<IPost>;
+    replyCount?: number;
+    reactions?: PostReactionSummary;
+    userReactions?: IReaction[];
+}
+/**
+ * base paramaters for creating a post
+ *
+ * @export
+ * @interface IPostOptions
+ */
+export interface IPostOptions {
+    body: string;
+    title?: string;
+    discussion?: string;
+    geometry?: Geometry;
+    featureGeometry?: Geometry;
+    appInfo?: string;
+}
+/**
+ * dto for creating a post in a known channel
+ *
+ * @export
+ * @interface ICreatePost
+ * @extends {IPostOptions}
+ */
+export interface ICreatePost extends IPostOptions {
+    channelId: string;
+}
+/**
+ * dto for creating a post in a unknown or not yet created channel
+ *
+ * @export
+ * @interface ICreateChannelPost
+ * @extends {IPostOptions}
+ * @extends {ICreateChannel}
+ */
+export interface ICreateChannelPost extends IPostOptions, ICreateChannel {
+}
+/**
+ * request options for creating post
+ *
+ * @export
+ * @interface ICreatePostParams
+ * @extends {IHubRequestOptions}
+ */
+export interface ICreatePostParams extends IDiscussionsRequestOptions {
+    data: ICreatePost | ICreateChannelPost;
+    mentionUrl?: string;
+}
+/**
+ * request options for creating reply to post
+ *
+ * @export
+ * @interface ICreateReplyParams
+ * @extends {IHubRequestOptions}
+ */
+export interface ICreateReplyParams extends IDiscussionsRequestOptions {
+    postId: string;
+    data: IPostOptions;
+    mentionUrl?: string;
+}
+/**
+ * dto for decorating found post with relations
+ *
+ * @export
+ * @interface IFetchPost
+ */
+export interface IFetchPost {
+    relations?: PostRelation[];
+}
+/**
+ * dto for querying posts in a single channel
+ *
+ * @export
+ * @interface ISearchChannelPosts
+ * @extends {Partial<IWithAuthor>}
+ * @extends {Partial<IWithEditor>}
+ * @extends {Partial<IPagingParams>}
+ * @extends {Partial<IWithSorting<PostSort>>}
+ * @extends {Partial<IWithTimeQueries>}
+ */
+export interface ISearchPosts extends Partial<IWithAuthor>, Partial<IWithEditor>, Partial<IPagingParams>, Partial<IWithSorting<PostSort>>, Partial<IWithTimeQueries> {
+    title?: string;
+    body?: string;
+    discussion?: string;
+    geometry?: Geometry;
+    featureGeometry?: Geometry;
+    parents?: Array<string | null>;
+    status?: PostStatus[];
+    relations?: PostRelation[];
+    groups?: string[];
+    access?: SharingAccess[];
+    channels?: string[];
+}
+/**
+ * dto for updating a post's channel
+ *
+ * @export
+ * @interface IUpdatePostSharing
+ * @extends {ICreateChannelPermissions}
+ */
+export interface IUpdatePostSharing extends ICreateChannelPermissions {
+    channelId?: string;
+}
+/**
+ * dto for updating a post's status
+ *
+ * @export
+ * @interface IUpdatePostStatus
+ */
+export interface IUpdatePostStatus {
+    status: PostStatus;
+}
+/**
+ * dto for updating a post's content
+ *
+ * @export
+ * @interface IUpdatePost
+ */
+export interface IUpdatePost {
+    title?: string;
+    body?: string;
+}
+/**
+ * request options for querying posts
+ *
+ * @export
+ * @interface ISearchPostsParams
+ * @extends {IHubRequestOptions}
+ */
+export interface ISearchPostsParams extends IDiscussionsRequestOptions {
+    data?: ISearchPosts;
+}
+/**
+ * request params for getting post
+ *
+ * @export
+ * @interface IFetchPostParams
+ * @extends {IHubRequestOptions}
+ */
+export interface IFetchPostParams extends IDiscussionsRequestOptions {
+    postId: string;
+    data?: IFetchPost;
+}
+/**
+ * request options for updating post
+ *
+ * @export
+ * @interface IUpdatePostParams
+ * @extends {IHubRequestOptions}
+ */
+export interface IUpdatePostParams extends IDiscussionsRequestOptions {
+    postId: string;
+    data: IUpdatePost;
+    mentionUrl?: string;
+}
+/**
+ * request options for updating a post's channel
+ *
+ * @export
+ * @interface IUpdatePostSharingParams
+ * @extends {IHubRequestOptions}
+ */
+export interface IUpdatePostSharingParams extends IDiscussionsRequestOptions {
+    postId: string;
+    data: IUpdatePostSharing;
+}
+/**
+ * request options for updating a post's status
+ *
+ * @export
+ * @interface IUpdatePostStatusParams
+ * @extends {IHubRequestOptions}
+ */
+export interface IUpdatePostStatusParams extends IDiscussionsRequestOptions {
+    postId: string;
+    data: IUpdatePostStatus;
+}
+/**
+ * request options for deleting a post
+ *
+ * @export
+ * @interface IRemovePostParams
+ * @extends {IHubRequestOptions}
+ */
+export interface IRemovePostParams extends IDiscussionsRequestOptions {
+    postId: string;
+}
+/**
+ * delete post response properties
+ *
+ * @export
+ * @interface IRemovePostResponse
+ */
+export interface IRemovePostResponse {
+    success: boolean;
+    postId: string;
+}
+/**
+ * Channel sorting fields
+ *
+ * @export
+ * @enum {string}
+ */
+export declare enum ChannelSort {
+    ACCESS = "access",
+    CREATED_AT = "createdAt",
+    CREATOR = "creator",
+    EDITOR = "editor",
+    ID = "id",
+    LAST_ACTIVITY = "last_activity",
+    UPDATED_AT = "updatedAt"
+}
+/**
+ * relations of channel entity
+ *
+ * @export
+ * @enum {string}
+ */
+export declare enum ChannelRelation {
+    SETTINGS = "settings"
+}
+/**
+ * permission object that will populate ACL interface
+ *
+ * @export
+ * @interface IAclPermissionDefinition
+ */
+export interface IAclPermissionDefinition {
+    role: Role;
+    accessibleAfter?: string;
+}
+/**
+ * ACL intra-group/org role definition
+ *
+ * @export
+ * @interface IAclGroupDefinition
+ */
+export interface IAclGroupDefinition {
+    admin?: IAclPermissionDefinition;
+    member?: IAclPermissionDefinition;
+}
+/**
+ * key-value lookup for ACL group/org permission definitions
+ * @export
+ */
+export declare type AclGroupDefinitionMap = Record<string, IAclGroupDefinition>;
+/**
+ * key-value lookup for ACL user permission definitions
+ * @export
+ */
+export declare type AclUserDefinitionMap = Record<string, IAclPermissionDefinition>;
+/**
+ * request options for creating channel with ACL
+ *
+ * @export
+ * @interface IChannelAclDefinition
+ */
+export interface IChannelAclDefinition {
+    anonymous?: IAclPermissionDefinition;
+    authenticated?: IAclPermissionDefinition;
+    groups?: AclGroupDefinitionMap;
+    orgs?: AclGroupDefinitionMap;
+    users: {
+        [key: string]: IAclPermissionDefinition;
+    };
+}
+/**
+ * permission object that will populate ACL interface
+ *
+ * @export
+ * @interface IAclPermission
+ * @extends {Omit<IAclPermissionDefinition, "accessibleAfter">}
+ */
+export interface IAclPermission extends Omit<IAclPermissionDefinition, "accessibleAfter">, IWithTimestamps {
+    accessibleAfter: string;
+}
+/**
+ * ACL intra-group/org roles
+ *
+ * @export
+ * @interface IAclGroup
+ */
+export interface IAclGroup {
+    admin?: IAclPermission;
+    member?: IAclPermission;
+}
+/**
+ * key-value lookup for ACL group/org permission definitions
+ * @export
+ */
+export declare type AclGroupMap = Record<string, IAclGroup>;
+/**
+ * key-value lookup for ACL user permissions
+ * @export
+ */
+export declare type AclUserMap = Record<string, IAclPermission>;
+/**
+ * channel access control list
+ *
+ * @export
+ * @interface IChannelAcl
+ */
+export interface IChannelAcl {
+    anonymous?: IAclPermission;
+    authenticated?: IAclPermission;
+    groups?: AclGroupMap;
+    orgs?: AclGroupMap;
+    users: AclUserMap;
+}
+/**
+ * parameters/options for creating a channel
+ *
+ * @export
+ * @interface ICreateChannelSettings
+ */
+export interface ICreateChannelSettings {
+    allowReply?: boolean;
+    allowAnonymous?: boolean;
+    softDelete?: boolean;
+    defaultPostStatus?: PostStatus;
+    allowReaction?: boolean;
+    name?: string;
+    allowedReactions?: PostReaction[];
+    blockWords?: string[];
+}
+/**
+ * parameters/options for creating a channel
+ *
+ * @export
+ * @interface ICreateChannelPermissions
+ */
+export interface ICreateChannelPermissions {
+    access?: SharingAccess;
+    groups?: string[];
+    orgs?: string[];
+    acl?: IChannelAclDefinition;
+}
+/**
+ * parameters/options for creating a channel
+ *
+ * @export
+ * @interface ICreateChannel
+ * @extends {ICreateChannelSettings}
+ * @extends {ICreateChannelPermissions}
+ */
+export interface ICreateChannel extends ICreateChannelSettings, ICreateChannelPermissions {
+}
+/**
+ * representation of channel entity
+ *
+ * @export
+ * @interface IChannel
+ * @extends {IWithAuthor}
+ * @extends {IWithEditor}
+ * @extends {IWithTimestamps}
+ */
+export interface IChannel extends IWithAuthor, IWithEditor, IWithTimestamps {
+    id: string;
+    posts?: IPost[];
+    allowReply: boolean;
+    allowAnonymous: boolean;
+    softDelete: boolean;
+    defaultPostStatus: PostStatus;
+    allowReaction: boolean;
+    allowedReactions: PostReaction[] | null;
+    blockWords: string[] | null;
+    name: string | null;
+    access: SharingAccess;
+    orgs: string[];
+    groups: string[];
+    acl: IChannelAcl;
+}
+/**
+ * parameters/options for updating channel settings
+ *
+ * @export
+ * @interface IUpdateChannel
+ * @extends {ICreateChannelSettings}
+ * @extends {Partial<IWithAuthor>}
+ */
+export interface IUpdateChannel extends ICreateChannelSettings, Partial<IWithAuthor> {
+}
+/**
+ * dto for decorating found channel with relations
+ *
+ * @export
+ * @interface IFetchChannel
+ */
+export interface IFetchChannel {
+    relations?: ChannelRelation[];
+}
+/**
+ * dto for querying channels
+ *
+ * @export
+ * @interface ISearchChannels
+ * @extends {Partial<IPagingParams>}
+ * @extends {Partial<IWithSorting<ChannelSort>>}
+ * @extends {Partial<IWithTimeQueries>}
+ * @extends {Partial<IWithFiltering<ChannelFilter>>}
+ */
+export interface ISearchChannels extends Partial<IPagingParams>, Partial<IWithSorting<ChannelSort>>, Partial<IWithTimeQueries>, Partial<IWithFiltering<ChannelFilter>> {
+    groups?: string[];
+    access?: SharingAccess[];
+    relations?: ChannelRelation[];
+}
+/**
+ * request params for creating a channel
+ *
+ * @export
+ * @interface ICreateChannelParams
+ * @extends {IDiscussionsRequestOptions}
+ */
+export interface ICreateChannelParams extends IDiscussionsRequestOptions {
+    data: ICreateChannel;
+}
+/**
+ * request params for getting a channel
+ *
+ * @export
+ * @interface IFetchChannelParams
+ * @extends {IDiscussionsRequestOptions}
+ */
+export interface IFetchChannelParams extends IDiscussionsRequestOptions {
+    channelId: string;
+    data?: IFetchChannel;
+}
+/**
+ * request params for searching channels
+ *
+ * @export
+ * @interface ISearchChannelsParams
+ * @extends {IDiscussionsRequestOptions}
+ */
+export interface ISearchChannelsParams extends IDiscussionsRequestOptions {
+    data?: ISearchChannels;
+}
+/**
+ * request params for updating a channel's settings
+ *
+ * @export
+ * @interface IUpdateChannelParams
+ * @extends {IDiscussionsRequestOptions}
+ */
+export interface IUpdateChannelParams extends IDiscussionsRequestOptions {
+    channelId: string;
+    data: IUpdateChannel;
+}
+/**
+ * request params for deleting a channel
+ *
+ * @export
+ * @interface IRemoveChannelParams
+ * @extends {IDiscussionsRequestOptions}
+ */
+export interface IRemoveChannelParams extends IDiscussionsRequestOptions {
+    channelId: string;
+}
+/**
+ * delete channel response properties
+ *
+ * @export
+ * @interface IRemoveChannelResponse
+ */
+export interface IRemoveChannelResponse {
+    success: boolean;
+    channelId: string;
+}
+/**
+ * request params for fetching opt out status
+ *
+ * @export
+ * @interface IFetchChannelNotificationOptOutParams
+ * @extends {IDiscussionsRequestOptions}
+ */
+export interface IFetchChannelNotificationOptOutParams extends IDiscussionsRequestOptions {
+    channelId: string;
+}
+/**
+ * request params for opting out
+ *
+ * @export
+ * @interface ICreateChannelNotificationOptOutParams
+ * @extends {IDiscussionsRequestOptions}
+ */
+export interface ICreateChannelNotificationOptOutParams extends IDiscussionsRequestOptions {
+    channelId: string;
+}
+/**
+ * request params for opting back in
+ *
+ * @export
+ * @interface IRemoveChannelNotificationOptOutParams
+ * @extends {IDiscussionsRequestOptions}
+ */
+export interface IRemoveChannelNotificationOptOutParams extends IDiscussionsRequestOptions {
+    channelId: string;
+}
+/**
+ * request params for deleting channel activity
+ *
+ * @export
+ * @interface IRemoveChannelActivityParams
+ * @extends {IDiscussionsRequestOptions}
+ */
+export interface IRemoveChannelActivityParams extends IDiscussionsRequestOptions {
+    channelId: string;
+}

dist/types/utils/channels/can-post-to-channel.d.ts

@@ -1,3 +0,2 @@
-import { IChannel } from "../../channels";
-import { IDiscussionsUser } from "../../shared/types";
+import { IChannel, IDiscussionsUser } from "../../types";
 export declare function canPostToChannel(channel: IChannel, user: IDiscussionsUser): boolean;

dist/types/utils/channels/index.d.ts

 import { IUser } from "@esri/arcgis-rest-auth";
-import { IChannel } from "../../channels";
-import { IPlatformSharing } from "../../shared/types";
+import { IChannel, IPlatformSharing } from "../../types";
 /**
@@ -5,0 +4,0 @@ * Utility to determine whether User can view posts belonging to Channel

dist/types/utils/posts.d.ts

 import { IGroup, IItem } from "@esri/arcgis-rest-portal";
-import { IDiscussionParams } from "../shared/types";
+import { IChannel, IDiscussionParams, IPost } from "../types";
 import { IHubContent } from "@esri/hub-common";
 import { IUser } from "@esri/arcgis-rest-auth";
-import { IPost } from "../posts";
-import { IChannel } from "../channels";
 /**
@@ -8,0 +6,0 @@ * Utility that parses a discussion URI string into its component parts

dist/types/utils/reactions.d.ts

@@ -1,3 +0,2 @@
-import { IChannel } from "../channels";
-import { PostReaction } from "../shared/types";
+import { PostReaction, IChannel } from "../types";
 /**
@@ -4,0 +3,0 @@ * Utility that determines whether a Channel allows a given PostReaction

dist/types/utils/request.d.ts

@@ -1,2 +0,2 @@
-import { IDiscussionsRequestOptions } from "../shared/types";
+import { IDiscussionsRequestOptions } from "../types";
 import { RemoteServerError as _RemoteServerError } from "@esri/hub-common";
@@ -3,0 +3,0 @@ export declare class RemoteServerError extends _RemoteServerError {

package.json

 {
   "name": "@esri/hub-discussions",
-  "version": "16.0.0",
+  "version": "16.0.1",
   "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

Worsened metrics

Total package byte prevSize

140561

decreased by-2.93%

Number of package files

82

decreased by-23.36%

Lines of code

3164

decreased by-1.65%

No dependency changes