@mx-space/api-client 0.6.2 → 0.7.0

package/controllers/aggregate.ts

@@ -0,0 +1,65 @@
+import { IController } from '~/interfaces/controller'
+import { SortOrder } from '~/interfaces/options'
+import { IRequestHandler, RequestProxyResult } from '~/interfaces/request'
+import {
+  AggregateRoot,
+  AggregateStat,
+  AggregateTop,
+  TimelineData,
+  TimelineType,
+} from '~/models/aggregate'
+import { sortOrderToNumber } from '~/utils'
+import { autoBind } from '~/utils/auto-bind'
+import { HTTPClient } from '../core'
+
+declare module '../core/client' {
+  interface HTTPClient {
+    aggregate: AggregateController
+  }
+}
+
+export class AggregateController implements IController {
+  base = 'aggregate'
+  name = 'aggregate'
+  constructor(private client: HTTPClient) {
+    autoBind(this)
+  }
+  public get proxy(): IRequestHandler {
+    return this.client.proxy(this.base)
+  }
+
+  /**
+   * 获取聚合数据
+   */
+  getAggregateData(): RequestProxyResult<AggregateRoot> {
+    return this.proxy.get<AggregateRoot>()
+  }
+
+  /**
+   * 获取最新发布的内容
+   */
+  getTop(size = 5) {
+    return this.proxy.top.get<AggregateTop>({ params: { size } })
+  }
+
+  getTimeline(options?: {
+    sort?: SortOrder
+    type?: TimelineType
+    year?: number
+  }) {
+    const { sort, type, year } = options || {}
+    return this.proxy.timeline.get<{ data: TimelineData }>({
+      params: {
+        sort: sort && sortOrderToNumber(sort),
+        type,
+        year,
+      },
+    })
+  }
+  /**
+   * 获取聚合数据统计
+   */
+  getStat() {
+    return this.proxy.stat.get<AggregateStat>()
+  }
+}

package/controllers/base.ts

@@ -0,0 +1,32 @@
+import { IRequestHandler, RequestProxyResult } from '~/interfaces/request'
+import { PaginateResult } from '~/models/base'
+import { autoBind } from '~/utils/auto-bind'
+import { HTTPClient } from '../core'
+
+export abstract class BaseCrudController<T> {
+  base!: string
+  constructor(protected client: HTTPClient) {
+    autoBind(this)
+  }
+  public get proxy(): IRequestHandler {
+    return this.client.proxy(this.base)
+  }
+
+  getById(id: string): RequestProxyResult<T> {
+    return this.proxy(id).get<T>()
+  }
+
+  getAll() {
+    return this.proxy.all.get<{ data: T[] }>()
+  }
+  /**
+   * 带分页的查询
+   * @param page
+   * @param perPage
+   */
+  getAllPaginated(page?: number, perPage?: number) {
+    return this.proxy.get<PaginateResult<T>>({
+      params: { page, size: perPage },
+    })
+  }
+}

package/controllers/category.ts

@@ -0,0 +1,107 @@
+import { IController } from '~/interfaces/controller'
+import { RequestProxyResult, ResponseProxyExtraRaw } from '~/interfaces/request'
+import { attachRawFromOneToAnthor, destructureData } from '~/utils'
+import { autoBind } from '~/utils/auto-bind'
+import { HTTPClient } from '../core/client'
+import { RequestError } from '../core/error'
+import {
+  CategoryEntries,
+  CategoryModel,
+  CategoryType,
+  CategoryWithChildrenModel,
+  TagModel,
+} from '../models/category'
+import { PostModel } from '../models/post'
+
+declare module '../core/client' {
+  interface HTTPClient {
+    category: CategoryController
+  }
+}
+
+export class CategoryController implements IController {
+  name = 'category'
+  base = 'categories'
+  constructor(private client: HTTPClient) {
+    autoBind(this)
+  }
+
+  public get proxy() {
+    return this.client.proxy(this.base)
+  }
+
+  getAllCategories(): RequestProxyResult<{ data: CategoryModel[] }> {
+    return this.proxy.get({
+      params: {
+        type: CategoryType.Category,
+      },
+    })
+  }
+
+  getAllTags(): RequestProxyResult<{ data: TagModel[] }> {
+    return this.proxy.get<{ data: TagModel[] }>({
+      params: {
+        type: CategoryType.Tag,
+      },
+    })
+  }
+
+  async getCategoryDetail(
+    id: string,
+  ): Promise<ResponseProxyExtraRaw<CategoryWithChildrenModel>>
+  async getCategoryDetail(
+    ids: string[],
+  ): Promise<ResponseProxyExtraRaw<Map<string, CategoryWithChildrenModel>>>
+  async getCategoryDetail(ids: string | string[]): Promise<any> {
+    if (typeof ids === 'string') {
+      const data = await this.proxy.get<CategoryEntries>({
+        params: {
+          ids: ids,
+        },
+      })
+      const result = Object.values(data.entries)[0]
+      attachRawFromOneToAnthor(data, result)
+      return result
+    } else if (Array.isArray(ids)) {
+      const data = await this.proxy.get<CategoryEntries>({
+        params: {
+          ids: ids.join(','),
+        },
+      })
+      const entries = data?.entries
+      if (!entries) {
+        throw new RequestError(
+          'data structure error',
+          500,
+          data.$request.path,
+          data,
+        )
+      }
+
+      const map = new Map<string, CategoryWithChildrenModel>(
+        Object.entries(entries).map(([id, value]) => [id.toLowerCase(), value]),
+      )
+
+      attachRawFromOneToAnthor(data, map)
+      return map
+    }
+  }
+
+  async getCategoryByIdOrSlug(idOrSlug: string) {
+    const res = await this.proxy(idOrSlug).get<CategoryWithChildrenModel>()
+    return destructureData(res) as typeof res
+  }
+
+  async getTagByName(name: string) {
+    const res = await this.proxy(name).get<{
+      tag: string
+      data: Pick<PostModel, 'id' | 'title' | 'slug' | 'category' | 'created'>[]
+    }>({
+      params: {
+        tag: 1,
+      },
+    })
+
+    return res
+  }
+}

package/controllers/comment.ts

@@ -0,0 +1,64 @@
+import { IController } from '~/interfaces/controller'
+import { PaginationParams } from '~/interfaces/params'
+import { IRequestHandler, RequestProxyResult } from '~/interfaces/request'
+import { PaginateResult } from '~/models/base'
+import { CommentModel } from '~/models/comment'
+import { autoBind } from '~/utils/auto-bind'
+import { HTTPClient } from '../core'
+import { CommentDto } from '../dtos/comment'
+
+declare module '../core/client' {
+  interface HTTPClient {
+    comment: CommentController
+  }
+}
+
+export class CommentController implements IController {
+  base = 'comments'
+  name = 'comment'
+
+  constructor(private readonly client: HTTPClient) {
+    autoBind(this)
+  }
+
+  get proxy(): IRequestHandler {
+    return this.client.proxy(this.base)
+  }
+
+  /**
+   * 根据 comment id 获取评论, 包括子评论
+   */
+  getById(id: string): RequestProxyResult<CommentModel> {
+    return this.proxy(id).get<CommentModel & { ref: string }>()
+  }
+
+  /**
+   * 获取文章的评论列表
+   * @param refId 文章 Id
+   */
+  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 },
+      })
+  }
+  /**
+   * 评论
+   */
+  comment(refId: string, data: CommentDto) {
+    return this.proxy(refId).post<CommentModel>({
+      data,
+    })
+  }
+
+  /**
+   * 回复评论
+   */
+  reply(commentId: string, data: CommentDto) {
+    return this.proxy.reply(commentId).post<CommentModel>({
+      data,
+    })
+  }
+}

package/controllers/index.ts

@@ -0,0 +1,66 @@
+import { AggregateController } from './aggregate'
+import { CategoryController } from './category'
+import { CommentController } from './comment'
+import { LinkController } from './link'
+import { NoteController } from './note'
+import { PageController } from './page'
+import { PostController } from './post'
+import { ProjectController } from './project'
+import { RecentlyController } from './recently'
+import { SayController } from './say'
+import { SearchController } from './search'
+import { SnippetController } from './snippet'
+import { UserController } from './user'
+
+export const allControllers = [
+  AggregateController,
+  CategoryController,
+  CommentController,
+  LinkController,
+  NoteController,
+  PageController,
+  PostController,
+  ProjectController,
+  RecentlyController,
+  SayController,
+  SearchController,
+  SnippetController,
+  UserController,
+]
+
+export const allContollerNames = [
+  'aggregate',
+  'category',
+  'comment',
+  'link',
+  'note',
+  'page',
+  'post',
+  'project',
+  'recently',
+  'say',
+  'search',
+  'snippet',
+  'user',
+
+  // alias,
+  'friend',
+  'master',
+  'shorthand',
+] as const
+
+export {
+  AggregateController,
+  CategoryController,
+  CommentController,
+  LinkController,
+  NoteController,
+  PageController,
+  PostController,
+  ProjectController,
+  RecentlyController,
+  SayController,
+  SearchController,
+  SnippetController,
+  UserController,
+}

package/controllers/link.ts

@@ -0,0 +1,21 @@
+import { LinkModel } from '~/models/link'
+import { autoBind } from '~/utils/auto-bind'
+import { HTTPClient } from '../core'
+import { BaseCrudController } from './base'
+
+declare module '../core/client' {
+  interface HTTPClient {
+    link: LinkController
+    friend: LinkController
+  }
+}
+
+export class LinkController extends BaseCrudController<LinkModel> {
+  constructor(protected readonly client: HTTPClient) {
+    super(client)
+    autoBind(this)
+  }
+
+  name = ['link', 'friend']
+  base = 'links'
+}

package/controllers/note.ts

@@ -0,0 +1,92 @@
+import { IController } from '~/interfaces/controller'
+import { IRequestHandler, RequestProxyResult } from '~/interfaces/request'
+import { PaginateResult } from '~/models/base'
+import { NoteModel, NoteWrappedPayload } from '~/models/note'
+import { SelectFields } from '~/types/helper'
+import { autoBind } from '~/utils/auto-bind'
+import { HTTPClient } from '../core/client'
+
+declare module '../core/client' {
+  interface HTTPClient {
+    note: NoteController
+  }
+}
+
+export type NoteListOptions = {
+  select?: SelectFields<keyof NoteModel>
+  year?: number
+  sortBy?: 'weather' | 'mood' | 'title' | 'created' | 'modified'
+  sortOrder?: 1 | -1
+}
+
+export class NoteController implements IController {
+  base = 'notes'
+  name = 'note'
+
+  constructor(private client: HTTPClient) {
+    autoBind(this)
+  }
+  get proxy(): IRequestHandler {
+    return this.client.proxy(this.base)
+  }
+
+  /**
+   * 最新日记
+   */
+  getLatest(): RequestProxyResult<NoteWrappedPayload> {
+    return this.proxy.latest.get<NoteWrappedPayload>()
+  }
+
+  /**
+   * 获取一篇日记
+   * @param id id | nid
+   * @param password 访问密码
+   */
+
+  getNoteById(id: string | number, password?: string) {
+    if (typeof id === 'number') {
+      return this.proxy.nid(id.toString()).get<NoteWrappedPayload>({
+        params: { password },
+      })
+    } else {
+      return this.proxy(id).get<NoteWrappedPayload>({ params: { password } })
+    }
+  }
+
+  /**
+   * 日记列表分页
+   */
+
+  getList(page = 1, perPage = 10, options: NoteListOptions = {}) {
+    const { select, sortBy, sortOrder, year } = options
+    return this.proxy.get<PaginateResult<NoteModel>>({
+      params: {
+        page,
+        size: perPage,
+        select: select?.join(' '),
+        sortBy,
+        sortOrder,
+        year,
+      },
+    })
+  }
+
+  /**
+   * 获取当前日记的上下各 n / 2 篇日记
+   */
+  getMiddleList(id: string, size = 5) {
+    return this.proxy.list(id).get<{
+      data: Pick<NoteModel, 'id' | 'title' | 'nid' | 'created'>[]
+      size: number
+    }>({
+      params: { size },
+    })
+  }
+
+  /**
+   * 喜欢这篇日记
+   */
+  likeIt(id: string | number) {
+    return this.proxy.like(id).get<never>()
+  }
+}

package/controllers/page.ts

@@ -0,0 +1,59 @@
+import { IController } from '~/interfaces/controller'
+import { PaginateResult } from '~/models/base'
+import { PageModel } from '~/models/page'
+import { SelectFields } from '~/types/helper'
+import { autoBind } from '~/utils/auto-bind'
+import { HTTPClient } from '../core'
+
+declare module '../core/client' {
+  interface HTTPClient {
+    page: PageController
+  }
+}
+
+export type PageListOptions = {
+  select?: SelectFields<keyof PageModel>
+  sortBy?: 'order' | 'subtitle' | 'title' | 'created' | 'modified'
+  sortOrder?: 1 | -1
+}
+
+export class PageController implements IController {
+  constructor(private readonly client: HTTPClient) {
+    autoBind(this)
+  }
+  base = 'pages'
+  name = 'page'
+  get proxy() {
+    return this.client.proxy(this.base)
+  }
+  /**
+   * 页面列表
+   */
+  getList(page = 1, perPage = 10, options: PageListOptions = {}) {
+    const { select, sortBy, sortOrder } = options
+    return this.proxy.get<PaginateResult<PageModel>>({
+      params: {
+        page,
+        size: perPage,
+        select: select?.join(' '),
+        sortBy,
+        sortOrder,
+      },
+    })
+  }
+
+  /**
+   * 页面详情
+   */
+  getById(id: string) {
+    return this.proxy(id).get<PageModel>()
+  }
+  /**
+   * 根据路径获取页面
+   * @param slug 路径
+   * @returns
+   */
+  getBySlug(slug: string) {
+    return this.proxy.slug(slug).get<PageModel>({})
+  }
+}

package/controllers/post.ts

@@ -0,0 +1,87 @@
+import { IController } from '~/interfaces/controller'
+import { RequestProxyResult } from '~/interfaces/request'
+import { PaginateResult } from '~/models/base'
+import { PostModel } from '~/models/post'
+import { SelectFields } from '~/types/helper'
+import { autoBind } from '~/utils/auto-bind'
+import { HTTPClient } from '../core/client'
+
+declare module '../core/client' {
+  interface HTTPClient {
+    post: PostController
+  }
+}
+
+export type PostListOptions = {
+  select?: SelectFields<keyof PostModel>
+  year?: number
+  sortBy?: 'categoryId' | 'title' | 'created' | 'modified'
+  sortOrder?: 1 | -1
+}
+
+export class PostController implements IController {
+  constructor(private client: HTTPClient) {
+    autoBind(this)
+  }
+
+  base = 'posts'
+
+  name = 'post'
+
+  public get proxy() {
+    return this.client.proxy(this.base)
+  }
+
+  /**
+   * 获取文章列表分页
+   * @param page
+   * @param perPage
+   * @returns
+   */
+  getList(page = 1, perPage = 10, options: PostListOptions = {}) {
+    const { select, sortBy, sortOrder, year } = options
+    return this.proxy.get<PaginateResult<PostModel>>({
+      params: {
+        page,
+        size: perPage,
+        select: select?.join(' '),
+        sortBy,
+        sortOrder,
+        year,
+      },
+    })
+  }
+
+  /**
+   * 根据分类和路径查找文章
+   * @param categoryName
+   * @param slug
+   */
+  getPost(categoryName: string, slug: string): RequestProxyResult<PostModel>
+  /**
+   * 根据 ID 查找文章
+   * @param id
+   */
+  getPost(id: string): RequestProxyResult<PostModel>
+  getPost(idOrCategoryName: string, slug?: string): any {
+    if (arguments.length == 1) {
+      return this.proxy(idOrCategoryName).get<PostModel>()
+    } else {
+      return this.proxy(idOrCategoryName)(slug).get<PostModel>()
+    }
+  }
+
+  /**
+   * 获取最新的文章
+   */
+  getLatest() {
+    return this.proxy.latest.get<PostModel>()
+  }
+
+  /**
+   * 点赞
+   */
+  thumbsUp(id: string) {
+    return this.proxy('_thumbs-up').get<void>({ params: { id } })
+  }
+}

package/controllers/project.ts

@@ -0,0 +1,20 @@
+import { ProjectModel } from '~/models/project'
+import { autoBind } from '~/utils/auto-bind'
+import { HTTPClient } from '../core'
+import { BaseCrudController } from './base'
+
+declare module '../core/client' {
+  interface HTTPClient {
+    project: ProjectController
+  }
+}
+
+export class ProjectController extends BaseCrudController<ProjectModel> {
+  constructor(protected readonly client: HTTPClient) {
+    super(client)
+    autoBind(this)
+  }
+
+  base = 'projects'
+  name = 'project'
+}

package/controllers/recently.ts

@@ -0,0 +1,48 @@
+import { IController } from '~/interfaces/controller'
+import { RecentlyModel } from '~/models/recently'
+import { autoBind } from '~/utils/auto-bind'
+import { HTTPClient } from '../core'
+
+declare module '../core/client' {
+  interface HTTPClient {
+    recently: RecentlyController
+    shorthand: RecentlyController
+  }
+}
+
+export class RecentlyController implements IController {
+  base = 'recently'
+  name = ['recently', 'shorthand']
+
+  constructor(private readonly client: HTTPClient) {
+    autoBind(this)
+  }
+
+  get proxy() {
+    return this.client.proxy(this.base)
+  }
+  /**
+   * 获取最新一条
+   */
+  getLatestOne() {
+    return this.proxy.latest.get<RecentlyModel>()
+  }
+
+  getAll() {
+    return this.proxy.all.get<{ data: RecentlyModel[] }>()
+  }
+
+  getList(
+    before?: string | undefined,
+    after?: string | undefined,
+    size?: number | number,
+  ) {
+    return this.proxy.get<{ data: RecentlyModel[] }>({
+      params: {
+        before,
+        after,
+        size,
+      },
+    })
+  }
+}

package/controllers/say.ts

@@ -0,0 +1,35 @@
+import { IController } from '~/interfaces/controller'
+import { SayModel } from '~/models/say'
+import { autoBind } from '~/utils/auto-bind'
+import { HTTPClient } from '../core'
+import { BaseCrudController } from './base'
+
+declare module '../core/client' {
+  interface HTTPClient {
+    say: SayController
+  }
+}
+
+export class SayController
+  extends BaseCrudController<SayModel>
+  implements IController
+{
+  base = 'says'
+  name = 'say'
+
+  constructor(protected client: HTTPClient) {
+    super(client)
+    autoBind(this)
+  }
+
+  public get proxy() {
+    return this.client.proxy(this.base)
+  }
+
+  /**
+   * 获取随机一条
+   */
+  getRandom() {
+    return this.proxy.random.get<{ data: SayModel | null }>()
+  }
+}