add new data type from doc to ts v2

Author: pmax-x

src/resources/Posts.ts

@@ -13,8 +13,8 @@ export interface IPosts {
  body: Object,
  id: number | null,
  }): Promise<PostsData>;
- like(params: { id: number | null }): Promise<string>;
- unlike(params: { id: number | null }): Promise<string>;
+ like(params: { id: number | null }): Promise<PostsData>;
+ unlike(params: { id: number | null }): Promise<PostsData>;
  flag(params: {
  id: number | null,
  post_action_type_id: number,

src/resources/Tags.ts

@@ -1,5 +1,6 @@
 import { buildQueryString } from '../utils';
 import { DiscourseInterface } from '../index';
+import { TagsListData } from '../types/Tags';
 
 interface TopicParams {
  tag?: string;
@@ -9,8 +10,8 @@ interface TopicParams {
 }
 
 export interface ITags {
- getTopic(params: TopicParams): Promise<unknown>;
- getTopicsForCategory(params: TopicParams): Promise<unknown>;
+ getTopic(params: TopicParams): Promise<TagsListData>;
+ getTopicsForCategory(params: TopicParams): Promise<TagsListData>;
 }
 export default function Tags(discourse: DiscourseInterface) {
  this.getTopic = async ({ tag, ...inputs }: { tag?: string } = {}) => {

src/resources/Topics.ts

@@ -1,6 +1,6 @@
 import { buildQueryString } from '../utils';
 import { DiscourseInterface } from '../index';
-import { GetTopicData, GetTopicsData } from '../types/Topics';
+import { GetTopicData, GetTopicsData, TopicByUserName } from '../types/Topics';
 import { PostsData } from '../types/Posts';
 
 interface TopicParams {
@@ -15,7 +15,7 @@ export interface ITopics {
  getTopic(params: TopicParams): Promise<GetTopicsData>;
  getTopicPosts(params: TopicParams): Promise<GetTopicData>;
  deleteTopic(params: TopicParams): Promise<string>;
- getTopicsByUsername(params: TopicParams): Promise<unknown>;
+ getTopicsByUsername(params: TopicParams): Promise<TopicByUserName>;
  createTopic(params: TopicParams): Promise<PostsData>;
 }
 

src/types/Tags.ts

@@ -0,0 +1,30 @@
+export interface TagsGroupData {
+ tag_groups: [
+ {
+ id: number,
+ name: string,
+ tag_names: string[],
+ parent_tag_name: string,
+ one_per_topic: boolean,
+ },
+ ];
+}
+
+export interface TagsListData {
+ topic_list: {
+ can_create_topic: boolean,
+ draft: null,
+ draft_key: string,
+ draft_sequence: number,
+ per_page: number,
+ tags: TagData[],
+ topics: [],
+ };
+}
+
+export interface TagData {
+ id: number;
+ name: string;
+ topic_count: number;
+ staff: boolean;
+}

src/types/Topics.ts

@@ -1,4 +1,5 @@
 import { PostsData } from './Posts';
+import { DiscourseUser } from './Users';
 
 // ToDo clean up
 
@@ -294,7 +295,7 @@ export type DiscourseTopicSummaryType = {
  user_id: number,
  primary_group_id: {},
  }>,
- participants: Array<{
+ participants?: Array<{
  extras: string,
  description: string,
  user_id: number,
@@ -311,3 +312,16 @@ export type DiscourseTopicList = {
  more_topics_url: string, // If more than 1 page
  topics: Array<DiscourseTopicSummaryType>,
 };
+
+export type TopicByUserName = {
+ users: DiscourseUser[],
+ primary_groups: [],
+ topic_list: {
+ can_create_topic: true,
+ draft: null,
+ draft_key: 'new_topic',
+ draft_sequence: 1,
+ per_page: 30,
+ topics: DiscourseTopicSummaryType[],
+ },
+};