@mx-space/api-client 1.19.0 → 1.20.0

package/controllers/category.ts

@@ -1,118 +0,0 @@
-import type { IRequestAdapter } from '~/interfaces/adapter'
-import type { IController } from '~/interfaces/controller'
-import type {
-  IRequestHandler,
-  RequestProxyResult,
-  ResponseProxyExtraRaw,
-} from '~/interfaces/request'
-import { attachRawFromOneToAnthor, destructureData } from '~/utils'
-import { autoBind } from '~/utils/auto-bind'
-import type { HTTPClient } from '../core/client'
-import { RequestError } from '../core/error'
-import type {
-  CategoryEntries,
-  CategoryModel,
-  CategoryWithChildrenModel,
-  TagModel,
-} from '../models/category'
-import { CategoryType } from '../models/category'
-import type { PostModel } from '../models/post'
-
-declare module '../core/client' {
-  interface HTTPClient<
-    T extends IRequestAdapter = IRequestAdapter,
-    ResponseWrapper = unknown,
-  > {
-    category: CategoryController<ResponseWrapper>
-  }
-}
-
-export class CategoryController<ResponseWrapper> implements IController {
-  name = 'category'
-  base = 'categories'
-  constructor(private client: HTTPClient) {
-    autoBind(this)
-  }
-
-  public get proxy(): IRequestHandler<ResponseWrapper> {
-    return this.client.proxy(this.base)
-  }
-
-  getAllCategories(): RequestProxyResult<
-    { data: CategoryModel[] },
-    ResponseWrapper
-  > {
-    return this.proxy.get({
-      params: {
-        type: CategoryType.Category,
-      },
-    })
-  }
-
-  getAllTags(): RequestProxyResult<{ data: TagModel[] }, ResponseWrapper> {
-    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,
-        },
-      })
-      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

@@ -1,71 +0,0 @@
-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 { autoBind } from '~/utils/auto-bind'
-import type { HTTPClient } from '../core'
-import type { CommentDto } from '../dtos/comment'
-
-declare module '../core/client' {
-  interface HTTPClient<
-    T extends IRequestAdapter = IRequestAdapter,
-    ResponseWrapper = unknown,
-  > {
-    comment: CommentController<ResponseWrapper>
-  }
-}
-
-export class CommentController<ResponseWrapper> implements IController {
-  base = 'comments'
-  name = 'comment'
-
-  constructor(private readonly client: HTTPClient) {
-    autoBind(this)
-  }
-
-  get proxy(): IRequestHandler<ResponseWrapper> {
-    return this.client.proxy(this.base)
-  }
-
-  /**
-   * 根据 comment id 获取评论，包括子评论
-   */
-  getById(id: string) {
-    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 }> & {
-        readers: Record<string, ReaderModel>
-      }
-    >({
-      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

@@ -1,97 +0,0 @@
-import { AckController } from './ack'
-import { ActivityController } from './activity'
-import { AggregateController } from './aggregate'
-import { AIController } from './ai'
-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 {
-  RecentlyAttitudeEnum,
-  RecentlyAttitudeResultEnum,
-  RecentlyController,
-} from './recently'
-import { SayController } from './say'
-import { SearchController } from './search'
-import { ServerlessController } from './severless'
-import { SnippetController } from './snippet'
-import { SubscribeController } from './subscribe'
-import { TopicController } from './topic'
-import { UserController } from './user'
-
-export const allControllers = [
-  AckController,
-  ActivityController,
-  AggregateController,
-  AIController,
-  CategoryController,
-  CommentController,
-  LinkController,
-  NoteController,
-  PageController,
-  PostController,
-  ProjectController,
-  RecentlyController,
-  SayController,
-  SearchController,
-  ServerlessController,
-  SnippetController,
-  SubscribeController,
-  TopicController,
-  UserController,
-]
-
-export const allControllerNames = [
-  'ai',
-  'ack',
-  'activity',
-  'aggregate',
-  'category',
-  'comment',
-  'link',
-  'note',
-  'page',
-  'post',
-  'project',
-  'topic',
-  'recently',
-  'say',
-  'search',
-  'snippet',
-  'serverless',
-  'subscribe',
-  'user',
-
-  // alias,
-  'friend',
-  'master',
-  'shorthand',
-] as const
-
-export {
-  AckController,
-  ActivityController,
-  AggregateController,
-  AIController,
-  CategoryController,
-  CommentController,
-  LinkController,
-  NoteController,
-  PageController,
-  PostController,
-  ProjectController,
-  // Enum
-  RecentlyAttitudeEnum,
-  RecentlyAttitudeResultEnum,
-  RecentlyController,
-  SayController,
-  SearchController,
-  ServerlessController,
-  SnippetController,
-  SubscribeController,
-  TopicController,
-  UserController,
-}

package/controllers/link.ts

@@ -1,46 +0,0 @@
-import type { IRequestAdapter } from '~/interfaces/adapter'
-import type { LinkModel } from '~/models/link'
-import { autoBind } from '~/utils/auto-bind'
-import type { HTTPClient } from '../core'
-import { BaseCrudController } from './base'
-
-declare module '../core/client' {
-  interface HTTPClient<
-    T extends IRequestAdapter = IRequestAdapter,
-    ResponseWrapper = unknown,
-  > {
-    link: LinkController<ResponseWrapper>
-    friend: LinkController<ResponseWrapper>
-  }
-}
-
-export class LinkController<ResponseWrapper> extends BaseCrudController<
-  LinkModel,
-  ResponseWrapper
-> {
-  constructor(protected readonly client: HTTPClient) {
-    super(client)
-    autoBind(this)
-  }
-
-  // 是否可以申请友链
-  async canApplyLink() {
-    const { can } = await this.proxy.audit.get<{ can: boolean }>()
-    return can
-  }
-
-  // 申请友链
-  async applyLink(
-    data: Pick<
-      LinkModel,
-      'avatar' | 'name' | 'description' | 'url' | 'email'
-    > & {
-      author: string
-    },
-  ) {
-    return await this.proxy.audit.post<never>({ data })
-  }
-
-  name = ['link', 'friend']
-  base = 'links'
-}

package/controllers/note.ts

@@ -1,128 +0,0 @@
-import type { IRequestAdapter } from '~/interfaces/adapter'
-import type { IController } from '~/interfaces/controller'
-import type { IRequestHandler, RequestProxyResult } from '~/interfaces/request'
-import type { SelectFields } from '~/interfaces/types'
-import type { PaginateResult } from '~/models/base'
-import type {
-  NoteModel,
-  NoteWrappedPayload,
-  NoteWrappedWithLikedPayload,
-} from '~/models/note'
-import { autoBind } from '~/utils/auto-bind'
-import type { HTTPClient } from '../core/client'
-import type { SortOptions } from './base'
-
-declare module '../core/client' {
-  interface HTTPClient<
-    T extends IRequestAdapter = IRequestAdapter,
-    ResponseWrapper = unknown,
-  > {
-    note: NoteController<ResponseWrapper>
-  }
-}
-
-export type NoteListOptions = {
-  select?: SelectFields<keyof NoteModel>
-  year?: number
-  sortBy?: 'weather' | 'mood' | 'title' | 'created' | 'modified'
-  sortOrder?: 1 | -1
-}
-
-export class NoteController<ResponseWrapper> implements IController {
-  base = 'notes'
-  name = 'note'
-
-  constructor(private client: HTTPClient) {
-    autoBind(this)
-  }
-  get proxy(): IRequestHandler<ResponseWrapper> {
-    return this.client.proxy(this.base)
-  }
-
-  /**
-   * 最新日记
-   */
-  getLatest() {
-    return this.proxy.latest.get<NoteWrappedWithLikedPayload>()
-  }
-
-  /**
-   * 获取一篇日记，根据 Id 查询需要鉴权
-   * @param id id | nid
-   * @param password 访问密码
-   */
-
-  getNoteById(
-    id: string,
-  ): Promise<RequestProxyResult<NoteModel, ResponseWrapper>>
-  getNoteById(id: number): Promise<NoteWrappedPayload>
-  getNoteById(id: number, password: string): Promise<NoteWrappedPayload>
-  getNoteById(
-    id: number,
-    password: undefined,
-    singleResult: true,
-  ): Promise<RequestProxyResult<NoteModel, ResponseWrapper>>
-  getNoteById(
-    id: number,
-    password: string,
-    singleResult: true,
-  ): Promise<RequestProxyResult<NoteModel, ResponseWrapper>>
-  getNoteById(...rest: any[]): any {
-    const [id, password = undefined, singleResult = false] = rest
-
-    if (typeof id === 'number') {
-      return this.proxy.nid(id.toString()).get<NoteWrappedWithLikedPayload>({
-        params: { password, single: singleResult ? '1' : undefined },
-      })
-    } else {
-      return this.proxy(id).get<NoteModel>()
-    }
-  }
-
-  /**
-   * 日记列表分页
-   */
-
-  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' | 'isPublished'
-      >[]
-      size: number
-    }>({
-      params: { size },
-    })
-  }
-
-  /**
-   * 获取专栏内的所有日记
-   */
-  getNoteByTopicId(
-    topicId: string,
-    page = 1,
-    size = 10,
-    sortOptions: SortOptions = {},
-  ) {
-    return this.proxy.topics(topicId).get<PaginateResult<NoteModel>>({
-      params: { page, size, ...sortOptions },
-    })
-  }
-}

package/controllers/page.ts

@@ -1,64 +0,0 @@
-import type { IRequestAdapter } from '~/interfaces/adapter'
-import type { IController } from '~/interfaces/controller'
-import type { IRequestHandler } from '~/interfaces/request'
-import type { SelectFields } from '~/interfaces/types'
-import type { PaginateResult } from '~/models/base'
-import type { PageModel } from '~/models/page'
-import { autoBind } from '~/utils/auto-bind'
-import type { HTTPClient } from '../core'
-
-declare module '../core/client' {
-  interface HTTPClient<
-    T extends IRequestAdapter = IRequestAdapter,
-    ResponseWrapper = unknown,
-  > {
-    page: PageController<ResponseWrapper>
-  }
-}
-
-export type PageListOptions = {
-  select?: SelectFields<keyof PageModel>
-  sortBy?: 'order' | 'subtitle' | 'title' | 'created' | 'modified'
-  sortOrder?: 1 | -1
-}
-
-export class PageController<ResponseWrapper> implements IController {
-  constructor(private readonly client: HTTPClient) {
-    autoBind(this)
-  }
-  base = 'pages'
-  name = 'page'
-  get proxy(): IRequestHandler<ResponseWrapper> {
-    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

@@ -1,93 +0,0 @@
-import type { IRequestAdapter } from '~/interfaces/adapter'
-import type { IController } from '~/interfaces/controller'
-import type { IRequestHandler, RequestProxyResult } from '~/interfaces/request'
-import type { SelectFields } from '~/interfaces/types'
-import type { ModelWithLiked, PaginateResult } from '~/models/base'
-import type { PostModel } from '~/models/post'
-import { autoBind } from '~/utils/auto-bind'
-import type { HTTPClient } from '../core/client'
-
-declare module '../core/client' {
-  interface HTTPClient<
-    T extends IRequestAdapter = IRequestAdapter,
-    ResponseWrapper = unknown,
-  > {
-    post: PostController<ResponseWrapper>
-  }
-}
-
-export type PostListOptions = {
-  select?: SelectFields<keyof PostModel>
-  year?: number
-  sortBy?: 'categoryId' | 'title' | 'created' | 'modified'
-  sortOrder?: 1 | -1
-  truncate?: number
-}
-
-export class PostController<ResponseWrapper> implements IController {
-  constructor(private client: HTTPClient) {
-    autoBind(this)
-  }
-
-  base = 'posts'
-
-  name = 'post'
-
-  public get proxy(): IRequestHandler<ResponseWrapper> {
-    return this.client.proxy(this.base)
-  }
-
-  /**
-   * 获取文章列表分页
-   * @param page
-   * @param perPage
-   * @returns
-   */
-  getList(page = 1, perPage = 10, options: PostListOptions = {}) {
-    const { select, sortBy, sortOrder, year, truncate } = options
-    return this.proxy.get<PaginateResult<PostModel>>({
-      params: {
-        page,
-        size: perPage,
-        select: select?.join(' '),
-        sortBy,
-        sortOrder,
-        year,
-        truncate,
-      },
-    })
-  }
-
-  /**
-   * 根据分类和路径查找文章
-   * @param categoryName
-   * @param slug
-   */
-  getPost(
-    categoryName: string,
-    slug: string,
-  ): RequestProxyResult<ModelWithLiked<PostModel>, ResponseWrapper>
-  /**
-   * 根据 ID 查找文章
-   * @param id
-   */
-  getPost(id: string): RequestProxyResult<PostModel, ResponseWrapper>
-  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<ModelWithLiked<PostModel>>()
-  }
-
-  getFullUrl(slug: string) {
-    return this.proxy('get-url')(slug).get<{ path: string }>()
-  }
-}

package/controllers/project.ts

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