@mx-space/api-client 1.15.0 → 1.16.0

package/controllers/comment.ts

@@ -2,6 +2,7 @@ import type { IRequestAdapter } from '~/interfaces/adapter'
 import type { IController } from '~/interfaces/controller'
 import type { PaginationParams } from '~/interfaces/params'
 import type { IRequestHandler } from '~/interfaces/request'
+import type { ReaderModel } from '~/models'
 import type { PaginateResult } from '~/models/base'
 import type { CommentModel } from '~/models/comment'
 import type { HTTPClient } from '../core'
@@ -31,7 +32,7 @@ export class CommentController<ResponseWrapper> implements IController {
   }
 
   /**
-   * 根据 comment id 获取评论, 包括子评论
+   * 根据 comment id 获取评论，包括子评论
    */
   getById(id: string) {
     return this.proxy(id).get<CommentModel & { ref: string }>()
@@ -43,11 +44,13 @@ export class CommentController<ResponseWrapper> implements IController {
    */
   getByRefId(refId: string, pagination: PaginationParams = {}) {
     const { page, size } = pagination
-    return this.proxy
-      .ref(refId)
-      .get<PaginateResult<CommentModel & { ref: string }>>({
-        params: { page: page || 1, size: size || 10 },
-      })
+    return this.proxy.ref(refId).get<
+      PaginateResult<CommentModel & { ref: string }> & {
+        readers: Record<string, ReaderModel>
+      }
+    >({
+      params: { page: page || 1, size: size || 10 },
+    })
   }
   /**
    * 评论

package/controllers/index.ts

@@ -72,10 +72,10 @@ export const allControllerNames = [
 ] as const
 
 export {
-  AIController,
   AckController,
   ActivityController,
   AggregateController,
+  AIController,
   CategoryController,
   CommentController,
   LinkController,
@@ -83,16 +83,15 @@ export {
   PageController,
   PostController,
   ProjectController,
+  // Enum
+  RecentlyAttitudeEnum,
+  RecentlyAttitudeResultEnum,
   RecentlyController,
   SayController,
   SearchController,
-  SnippetController,
   ServerlessController,
+  SnippetController,
   SubscribeController,
-  UserController,
   TopicController,
-
-  // Enum
-  RecentlyAttitudeEnum,
-  RecentlyAttitudeResultEnum,
+  UserController,
 }

package/dist/index.cjs

@@ -438,7 +438,7 @@ var CommentController = class {
     return this.client.proxy(this.base);
   }
   /**
-   * 根据 comment id 获取评论, 包括子评论
+   * 根据 comment id 获取评论，包括子评论
    */
   getById(id) {
     return this.proxy(id).get();

package/dist/index.d.cts

@@ -571,6 +571,7 @@ interface CommentModel extends BaseModel {
     isWhispers?: boolean;
     location?: string;
     source?: string;
+    readerId?: string;
 }
 interface CommentRef {
     id: string;
@@ -618,6 +619,14 @@ interface ProjectModel extends BaseModel {
     text: string;
 }
 
+interface ReaderModel {
+    email: string;
+    name: string;
+    handle: string;
+    image: string;
+    isOwner: boolean;
+}
+
 declare enum RecentlyRefTypes {
     Post = "Post",
     Note = "Note",
@@ -1103,7 +1112,7 @@ declare class CommentController<ResponseWrapper> implements IController {
     constructor(client: HTTPClient);
     get proxy(): IRequestHandler<ResponseWrapper>;
     /**
-     * 根据 comment id 获取评论, 包括子评论
+     * 根据 comment id 获取评论，包括子评论
      */
     getById(id: string): RequestProxyResult<CommentModel & {
         ref: string;
@@ -1127,19 +1136,27 @@ declare class CommentController<ResponseWrapper> implements IController {
      */
     getByRefId(refId: string, pagination?: PaginationParams): RequestProxyResult<PaginateResult<CommentModel & {
         ref: string;
-    }>, ResponseWrapper, ResponseWrapper extends unknown ? {
+    }> & {
+        readers: Record<string, ReaderModel>;
+    }, ResponseWrapper, ResponseWrapper extends unknown ? {
         [key: string]: any;
         data: PaginateResult<CommentModel & {
             ref: string;
-        }>;
+        }> & {
+            readers: Record<string, ReaderModel>;
+        };
     } : ResponseWrapper extends {
         data: PaginateResult<CommentModel & {
             ref: string;
-        }>;
+        }> & {
+            readers: Record<string, ReaderModel>;
+        };
     } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
         data: PaginateResult<CommentModel & {
             ref: string;
-        }>;
+        }> & {
+            readers: Record<string, ReaderModel>;
+        };
     }>;
     /**
      * 评论
@@ -1880,4 +1897,4 @@ declare const allControllerNames: readonly ["ai", "ack", "activity", "aggregate"
  */
 declare const camelcaseKeys: <T = any>(obj: any) => T;
 
-export { AIController, type AISummaryModel, AckController, ActivityController, type ActivityPresence, AdminExtraModel, AggregateController, type AggregateRoot, type AggregateRootWithTheme, type AggregateStat, type AggregateTop, type AggregateTopNote, type AggregateTopPost, AlgoliaSearchOptionsModel, type AuthUser, BackupOptionsModel, BaiduSearchOptionsModel, type BaseCommentIndexModel, type BaseModel, CategoryController, type CategoryEntries, type CategoryModel, CategoryType, type CategoryWithChildrenModel, CollectionRefTypes, CommentController, type CommentDto, type CommentModel, CommentOptionsModel, type CommentRef, CommentState, type Coordinate, type Count, EnumPageType, HTTPClient, type IConfig, type IConfigKeys, IRequestAdapter, type Image, type LastYearPublication, LinkController, type LinkModel, LinkState, LinkType, MailOptionsModel, type ModelWithLiked, NoteController, type NoteModel, type NoteWrappedPayload, type NoteWrappedWithLikedPayload, PageController, type PageModel, type Pager, type PaginateResult, PostController, type PostModel, ProjectController, type ProjectModel, type RecentActivities, type RecentComment, type RecentLike, type RecentNote, type RecentPost, type RecentRecent, RecentlyAttitudeEnum, RecentlyAttitudeResultEnum, RecentlyController, type RecentlyModel, type RecentlyRefType, RecentlyRefTypes, RequestError, type RoomOmittedNote, type RoomOmittedPage, type RoomOmittedPost, type RoomsData, SayController, type SayModel, SearchController, SeoOptionModel, ServerlessController, SnippetController, type SnippetModel, SnippetType, SubscribeAllBit, SubscribeController, SubscribeNoteCreateBit, SubscribePostCreateBit, SubscribeRecentCreateBit, SubscribeSayCreateBit, type SubscribeType, SubscribeTypeToBitMap, type TLogin, type TagModel, type TextBaseModel, type TimelineData, TimelineType, TopicController, type TopicModel, type Url, UrlOptionModel, UserController, type UserModel, allControllerNames, allControllers, createClient, createClient as default, camelcaseKeys as simpleCamelcaseKeys };
+export { AIController, type AISummaryModel, AckController, ActivityController, type ActivityPresence, AdminExtraModel, AggregateController, type AggregateRoot, type AggregateRootWithTheme, type AggregateStat, type AggregateTop, type AggregateTopNote, type AggregateTopPost, AlgoliaSearchOptionsModel, type AuthUser, BackupOptionsModel, BaiduSearchOptionsModel, type BaseCommentIndexModel, type BaseModel, CategoryController, type CategoryEntries, type CategoryModel, CategoryType, type CategoryWithChildrenModel, CollectionRefTypes, CommentController, type CommentDto, type CommentModel, CommentOptionsModel, type CommentRef, CommentState, type Coordinate, type Count, EnumPageType, HTTPClient, type IConfig, type IConfigKeys, IRequestAdapter, type Image, type LastYearPublication, LinkController, type LinkModel, LinkState, LinkType, MailOptionsModel, type ModelWithLiked, NoteController, type NoteModel, type NoteWrappedPayload, type NoteWrappedWithLikedPayload, PageController, type PageModel, type Pager, type PaginateResult, PostController, type PostModel, ProjectController, type ProjectModel, type ReaderModel, type RecentActivities, type RecentComment, type RecentLike, type RecentNote, type RecentPost, type RecentRecent, RecentlyAttitudeEnum, RecentlyAttitudeResultEnum, RecentlyController, type RecentlyModel, type RecentlyRefType, RecentlyRefTypes, RequestError, type RoomOmittedNote, type RoomOmittedPage, type RoomOmittedPost, type RoomsData, SayController, type SayModel, SearchController, SeoOptionModel, ServerlessController, SnippetController, type SnippetModel, SnippetType, SubscribeAllBit, SubscribeController, SubscribeNoteCreateBit, SubscribePostCreateBit, SubscribeRecentCreateBit, SubscribeSayCreateBit, type SubscribeType, SubscribeTypeToBitMap, type TLogin, type TagModel, type TextBaseModel, type TimelineData, TimelineType, TopicController, type TopicModel, type Url, UrlOptionModel, UserController, type UserModel, allControllerNames, allControllers, createClient, createClient as default, camelcaseKeys as simpleCamelcaseKeys };

package/dist/index.d.ts

@@ -571,6 +571,7 @@ interface CommentModel extends BaseModel {
     isWhispers?: boolean;
     location?: string;
     source?: string;
+    readerId?: string;
 }
 interface CommentRef {
     id: string;
@@ -618,6 +619,14 @@ interface ProjectModel extends BaseModel {
     text: string;
 }
 
+interface ReaderModel {
+    email: string;
+    name: string;
+    handle: string;
+    image: string;
+    isOwner: boolean;
+}
+
 declare enum RecentlyRefTypes {
     Post = "Post",
     Note = "Note",
@@ -1103,7 +1112,7 @@ declare class CommentController<ResponseWrapper> implements IController {
     constructor(client: HTTPClient);
     get proxy(): IRequestHandler<ResponseWrapper>;
     /**
-     * 根据 comment id 获取评论, 包括子评论
+     * 根据 comment id 获取评论，包括子评论
      */
     getById(id: string): RequestProxyResult<CommentModel & {
         ref: string;
@@ -1127,19 +1136,27 @@ declare class CommentController<ResponseWrapper> implements IController {
      */
     getByRefId(refId: string, pagination?: PaginationParams): RequestProxyResult<PaginateResult<CommentModel & {
         ref: string;
-    }>, ResponseWrapper, ResponseWrapper extends unknown ? {
+    }> & {
+        readers: Record<string, ReaderModel>;
+    }, ResponseWrapper, ResponseWrapper extends unknown ? {
         [key: string]: any;
         data: PaginateResult<CommentModel & {
             ref: string;
-        }>;
+        }> & {
+            readers: Record<string, ReaderModel>;
+        };
     } : ResponseWrapper extends {
         data: PaginateResult<CommentModel & {
             ref: string;
-        }>;
+        }> & {
+            readers: Record<string, ReaderModel>;
+        };
     } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
         data: PaginateResult<CommentModel & {
             ref: string;
-        }>;
+        }> & {
+            readers: Record<string, ReaderModel>;
+        };
     }>;
     /**
      * 评论
@@ -1880,4 +1897,4 @@ declare const allControllerNames: readonly ["ai", "ack", "activity", "aggregate"
  */
 declare const camelcaseKeys: <T = any>(obj: any) => T;
 
-export { AIController, type AISummaryModel, AckController, ActivityController, type ActivityPresence, AdminExtraModel, AggregateController, type AggregateRoot, type AggregateRootWithTheme, type AggregateStat, type AggregateTop, type AggregateTopNote, type AggregateTopPost, AlgoliaSearchOptionsModel, type AuthUser, BackupOptionsModel, BaiduSearchOptionsModel, type BaseCommentIndexModel, type BaseModel, CategoryController, type CategoryEntries, type CategoryModel, CategoryType, type CategoryWithChildrenModel, CollectionRefTypes, CommentController, type CommentDto, type CommentModel, CommentOptionsModel, type CommentRef, CommentState, type Coordinate, type Count, EnumPageType, HTTPClient, type IConfig, type IConfigKeys, IRequestAdapter, type Image, type LastYearPublication, LinkController, type LinkModel, LinkState, LinkType, MailOptionsModel, type ModelWithLiked, NoteController, type NoteModel, type NoteWrappedPayload, type NoteWrappedWithLikedPayload, PageController, type PageModel, type Pager, type PaginateResult, PostController, type PostModel, ProjectController, type ProjectModel, type RecentActivities, type RecentComment, type RecentLike, type RecentNote, type RecentPost, type RecentRecent, RecentlyAttitudeEnum, RecentlyAttitudeResultEnum, RecentlyController, type RecentlyModel, type RecentlyRefType, RecentlyRefTypes, RequestError, type RoomOmittedNote, type RoomOmittedPage, type RoomOmittedPost, type RoomsData, SayController, type SayModel, SearchController, SeoOptionModel, ServerlessController, SnippetController, type SnippetModel, SnippetType, SubscribeAllBit, SubscribeController, SubscribeNoteCreateBit, SubscribePostCreateBit, SubscribeRecentCreateBit, SubscribeSayCreateBit, type SubscribeType, SubscribeTypeToBitMap, type TLogin, type TagModel, type TextBaseModel, type TimelineData, TimelineType, TopicController, type TopicModel, type Url, UrlOptionModel, UserController, type UserModel, allControllerNames, allControllers, createClient, createClient as default, camelcaseKeys as simpleCamelcaseKeys };
+export { AIController, type AISummaryModel, AckController, ActivityController, type ActivityPresence, AdminExtraModel, AggregateController, type AggregateRoot, type AggregateRootWithTheme, type AggregateStat, type AggregateTop, type AggregateTopNote, type AggregateTopPost, AlgoliaSearchOptionsModel, type AuthUser, BackupOptionsModel, BaiduSearchOptionsModel, type BaseCommentIndexModel, type BaseModel, CategoryController, type CategoryEntries, type CategoryModel, CategoryType, type CategoryWithChildrenModel, CollectionRefTypes, CommentController, type CommentDto, type CommentModel, CommentOptionsModel, type CommentRef, CommentState, type Coordinate, type Count, EnumPageType, HTTPClient, type IConfig, type IConfigKeys, IRequestAdapter, type Image, type LastYearPublication, LinkController, type LinkModel, LinkState, LinkType, MailOptionsModel, type ModelWithLiked, NoteController, type NoteModel, type NoteWrappedPayload, type NoteWrappedWithLikedPayload, PageController, type PageModel, type Pager, type PaginateResult, PostController, type PostModel, ProjectController, type ProjectModel, type ReaderModel, type RecentActivities, type RecentComment, type RecentLike, type RecentNote, type RecentPost, type RecentRecent, RecentlyAttitudeEnum, RecentlyAttitudeResultEnum, RecentlyController, type RecentlyModel, type RecentlyRefType, RecentlyRefTypes, RequestError, type RoomOmittedNote, type RoomOmittedPage, type RoomOmittedPost, type RoomsData, SayController, type SayModel, SearchController, SeoOptionModel, ServerlessController, SnippetController, type SnippetModel, SnippetType, SubscribeAllBit, SubscribeController, SubscribeNoteCreateBit, SubscribePostCreateBit, SubscribeRecentCreateBit, SubscribeSayCreateBit, type SubscribeType, SubscribeTypeToBitMap, type TLogin, type TagModel, type TextBaseModel, type TimelineData, TimelineType, TopicController, type TopicModel, type Url, UrlOptionModel, UserController, type UserModel, allControllerNames, allControllers, createClient, createClient as default, camelcaseKeys as simpleCamelcaseKeys };

package/dist/index.global.js

@@ -373,7 +373,7 @@
       return this.client.proxy(this.base);
     }
     /**
-     * 根据 comment id 获取评论, 包括子评论
+     * 根据 comment id 获取评论，包括子评论
      */
     getById(id) {
       return this.proxy(id).get();

package/dist/index.js

@@ -371,7 +371,7 @@ var CommentController = class {
     return this.client.proxy(this.base);
   }
   /**
-   * 根据 comment id 获取评论, 包括子评论
+   * 根据 comment id 获取评论，包括子评论
    */
   getById(id) {
     return this.proxy(id).get();

package/models/comment.ts

@@ -27,6 +27,7 @@ export interface CommentModel extends BaseModel {
   location?: string
 
   source?: string
+  readerId?: string
 }
 export interface CommentRef {
   id: string

package/models/index.ts

@@ -10,6 +10,7 @@ export * from './note'
 export * from './page'
 export * from './post'
 export * from './project'
+export * from './reader'
 export * from './recently'
 export * from './say'
 export * from './setting'

package/models/reader.ts

@@ -0,0 +1,9 @@
+export interface ReaderModel {
+  email: string
+  name: string
+  handle: string
+
+  image: string
+
+  isOwner: boolean
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mx-space/api-client",
-  "version": "1.15.0",
+  "version": "1.16.0",
   "type": "module",
   "description": "A api client for mx-space server@next",
   "author": "Innei",
@@ -51,7 +51,7 @@
     "axios": "^1.6.7",
     "camelcase-keys": "^9.1.3",
     "cors": "2.8.5",
-    "express": "4.19.2",
+    "express": "4.20.0",
     "form-data": "4.0.0",
     "lodash": "4.17.21",
     "tsup": "8.2.4",