@mx-space/api-client 1.0.0-beta.2 → 1.0.0

package/__tests__/contronllers/category.test.ts

@@ -0,0 +1,284 @@
+import camelcaseKeys from 'camelcase-keys'
+
+import { mockRequestInstance } from '~/__tests__/helpers/instance'
+import { mockResponse } from '~/__tests__/helpers/response'
+import { CategoryController } from '~/controllers'
+
+describe('test Category client', () => {
+  const client = mockRequestInstance(CategoryController)
+
+  test('GET /categories', async () => {
+    const mocked = mockResponse('/categories', {
+      data: [
+        {
+          id: '5eb2c62a613a5ab0642f1f7a',
+          type: 0,
+          count: 34,
+          name: '编程',
+          slug: 'programming',
+          created: '2020-05-06T14:14:02.339Z',
+        },
+      ],
+    })
+
+    const data = await client.category.getAllCategories()
+    expect(data.$raw.data).toEqual(mocked)
+    expect(data.data).toEqual(mocked.data)
+  })
+
+  describe('GET /categories/:id', () => {
+    test('get by slug', async () => {
+      const mocked = mockResponse('/categories/programming', {
+        data: {
+          id: '5eb2c62a613a5ab0642f1f7a',
+          type: 0,
+          count: 2,
+          name: '编程',
+          slug: 'programming',
+          created: '2020-05-06T14:14:02.339Z',
+          children: [
+            {
+              id: '611748895c2f6f4d3ba0d9b3',
+              title: 'pageproxy，为 spa 提供初始数据注入',
+              slug: 'pageproxy-spa-inject',
+              created: '2021-08-14T04:37:29.880Z',
+            },
+            {
+              id: '60cffff50ec52e0349cbb29f',
+              title: '曲折的 Vue 3 重构后台之路',
+              slug: 'mx-space-vue-3',
+              created: '2021-06-21T02:56:53.126Z',
+            },
+          ],
+        },
+      })
+
+      const data = await client.category.getCategoryByIdOrSlug('programming')
+      expect(data).toEqual(mocked.data)
+      expect(data.count).toEqual(mocked.data.count)
+    })
+
+    test('get by id', async () => {
+      const mocked = mockResponse('/categories/5eb2c62a613a5ab0642f1f7a', {
+        data: {
+          id: '5eb2c62a613a5ab0642f1f7a',
+          type: 0,
+          count: 2,
+          name: '编程',
+          slug: 'programming',
+          created: '2020-05-06T14:14:02.339Z',
+          children: [
+            {
+              id: '611748895c2f6f4d3ba0d9b3',
+              title: 'pageproxy，为 spa 提供初始数据注入',
+              slug: 'pageproxy-spa-inject',
+              created: '2021-08-14T04:37:29.880Z',
+            },
+            {
+              id: '60cffff50ec52e0349cbb29f',
+              title: '曲折的 Vue 3 重构后台之路',
+              slug: 'mx-space-vue-3',
+              created: '2021-06-21T02:56:53.126Z',
+            },
+          ],
+        },
+      })
+
+      const data = await client.category.getCategoryByIdOrSlug(
+        '5eb2c62a613a5ab0642f1f7a',
+      )
+      expect(data).toEqual(mocked.data)
+      expect(data.count).toEqual(mocked.data.count)
+    })
+  })
+
+  test('GET /categories/:tagName', async () => {
+    const mocked = mockResponse('/categories/react?tag=1', {
+      tag: 'react',
+      data: [
+        {
+          id: '607bfcedc98328a0d941a409',
+          title: '虚拟列表与 Scroll Restoration',
+          slug: 'visualize-list-scroll-restoration',
+          category: {
+            id: '5eb2c62a613a5ab0642f1f7a',
+            type: 0,
+            name: '编程',
+            slug: 'programming',
+          },
+          created: '2021-04-18T09:33:33.271Z',
+        },
+      ],
+    })
+
+    const data = await client.category.getTagByName('react')
+    expect(data.tag).toEqual('react')
+    expect(data.data).toEqual(mocked.data)
+  })
+
+  test('GET /categories?type=0', async () => {
+    const mocked = mockResponse('/categories?type=0', {
+      data: [
+        {
+          id: '5eb2c62a613a5ab0642f1f7a',
+          type: 0,
+          count: 34,
+          name: '编程',
+          slug: 'programming',
+          created: '2020-05-06T14:14:02.339Z',
+        },
+      ],
+    })
+
+    const data = await client.category.getAllCategories()
+    expect(data.data).toEqual(mocked.data)
+    expect(data.$raw.data).toEqual(mocked)
+  })
+
+  test('GET /categories?type=1', async () => {
+    const mocked = mockResponse('/categories?type=1', {
+      data: [
+        {
+          count: 2,
+          name: 'docker',
+        },
+        {
+          count: 1,
+          name: 'react',
+        },
+      ],
+    })
+    const data = await client.category.getAllTags()
+    expect(data.data).toEqual(mocked.data)
+    expect(data.$raw.data).toEqual(mocked)
+  })
+
+  describe('GET /categories?ids=', () => {
+    it('should get with ids array', async () => {
+      const mocked = mockResponse(
+        '/categories?ids=5ed5be418f3d6b6cb9ab7700,5eb2c62a613a5ab0642f1f7b',
+        {
+          entries: {
+            '5ed5be418f3d6b6cb9ab7700': {
+              id: '5ed5be418f3d6b6cb9ab7700',
+              type: 0,
+              count: 2,
+              slug: 'reprint',
+              name: '转载',
+              created: '2020-06-02T02:49:37.424Z',
+              children: [
+                {
+                  id: '6005562e6b14b33be8afc1c3',
+                  allow_comment: true,
+                  copyright: false,
+                  tags: [],
+                  count: {
+                    read: 221,
+                    like: 3,
+                  },
+                  title: '[reprint] Your Own Time Zone',
+                  slug: 'your-own-time-zone',
+                  category_id: '5ed5be418f3d6b6cb9ab7700',
+                  modified: '2021-01-18T09:41:37.380Z',
+                  created: '2021-01-18T09:34:38.550Z',
+                },
+              ],
+            },
+            '5eb2c62a613a5ab0642f1f7b': {
+              id: '5eb2c62a613a5ab0642f1f7b',
+              type: 0,
+              count: 19,
+              name: '折腾',
+              slug: 'Z-Turn',
+              created: '2020-05-06T14:14:02.356Z',
+              children: [
+                {
+                  id: '5eb2c62a613a5ab0642f1f95',
+                  title: '从零开始的 Redux',
+                  slug: 'learn-redux',
+                  created: '2020-01-08T08:24:00.000Z',
+                  modified: '2020-11-14T06:50:19.164Z',
+                  category_id: '5eb2c62a613a5ab0642f1f7b',
+                  copyright: true,
+                  count: {
+                    read: 309,
+                    like: 2,
+                  },
+                  allow_comment: true,
+                  tags: [],
+                },
+              ],
+            },
+          },
+        },
+      )
+
+      const data = await client.category.getCategoryDetail([
+        '5ed5be418f3d6b6cb9ab7700',
+        '5eb2c62a613a5ab0642f1f7b',
+      ])
+
+      expect(data).toEqual(
+        new Map([
+          [
+            '5ed5be418f3d6b6cb9ab7700',
+            camelcaseKeys(mocked.entries['5ed5be418f3d6b6cb9ab7700'], {
+              deep: true,
+            }),
+          ],
+          [
+            '5eb2c62a613a5ab0642f1f7b',
+            camelcaseKeys(mocked.entries['5eb2c62a613a5ab0642f1f7b'], {
+              deep: true,
+            }),
+          ],
+        ]),
+      )
+
+      expect(data.$raw.data).toEqual(mocked)
+    })
+
+    it('should get with single id', async () => {
+      const mocked = mockResponse('/categories?ids=5ed5be418f3d6b6cb9ab7700', {
+        entries: {
+          '5ed5be418f3d6b6cb9ab7700': {
+            id: '5ed5be418f3d6b6cb9ab7700',
+            type: 0,
+            count: 2,
+            slug: 'reprint',
+            name: '转载',
+            created: '2020-06-02T02:49:37.424Z',
+            children: [
+              {
+                id: '6005562e6b14b33be8afc1c3',
+                allow_comment: true,
+                copyright: false,
+                tags: [],
+                count: {
+                  read: 221,
+                  like: 3,
+                },
+                title: '[reprint] Your Own Time Zone',
+                slug: 'your-own-time-zone',
+                category_id: '5ed5be418f3d6b6cb9ab7700',
+                modified: '2021-01-18T09:41:37.380Z',
+                created: '2021-01-18T09:34:38.550Z',
+              },
+            ],
+          },
+        },
+      })
+
+      const data = await client.category.getCategoryDetail(
+        '5ed5be418f3d6b6cb9ab7700',
+      )
+      expect(data).toEqual(
+        camelcaseKeys(mocked.entries['5ed5be418f3d6b6cb9ab7700'], {
+          deep: true,
+        }),
+      )
+
+      expect(data.$raw.data).toEqual(mocked)
+    })
+  })
+})

package/__tests__/contronllers/comment.test.ts

@@ -0,0 +1,113 @@
+import camelcaseKeys from 'camelcase-keys'
+
+import { mockRequestInstance } from '~/__tests__/helpers/instance'
+import { mockResponse } from '~/__tests__/helpers/response'
+import { CommentController } from '~/controllers/comment'
+
+describe('test note client', () => {
+  const client = mockRequestInstance(CommentController)
+
+  test('get comment by id', async () => {
+    mockResponse('/comments/11111', {
+      ref_type: 'Page',
+      state: 1,
+      children: [],
+      comments_index: 1,
+      id: '6188b80b6290547080c9e1f3',
+      author: 'yss',
+      text: '做的框架模板不错. (•౪• ) ',
+      url: 'https://gitee.com/kmyss/',
+      key: '#26',
+      ref: '5e0318319332d06503619337',
+      created: '2021-11-08T05:39:23.010Z',
+      avatar:
+        'https://sdn.geekzu.org/avatar/8675fa376c044b0d93a23374549c4248?d=retro',
+    })
+
+    const data = await client.comment.getById('11111')
+    expect(data.children).toEqual([])
+    expect(data.text).toBeDefined()
+  })
+
+  test('get comment by ref id', async () => {
+    const comments = [
+      {
+        ref_type: 'Page',
+        state: 1,
+        children: [],
+        comments_index: 1,
+        id: '6188b80b6290547080c9e1f3',
+        author: 'yss',
+        text: '做的框架模板不错. (•౪• ) ',
+        url: 'https://gitee.com/kmyss/',
+        key: '#26',
+        ref: '5e0318319332d06503619337',
+        created: '2021-11-08T05:39:23.010Z',
+        avatar:
+          'https://sdn.geekzu.org/avatar/8675fa376c044b0d93a23374549c4248?d=retro',
+      },
+    ]
+    mockResponse(
+      '/comments/ref/5e0318319332d06503619337',
+      {
+        data: comments,
+        pagination: {
+          total: 23,
+          current_page: 1,
+          total_page: 3,
+          size: 10,
+          has_next_page: true,
+          has_prev_page: false,
+        },
+      },
+      'get',
+    )
+
+    const data = await client.comment.getByRefId('5e0318319332d06503619337')
+
+    expect(data.data).toEqual(camelcaseKeys(comments, { deep: true }))
+    expect(data.pagination.total).toEqual(23)
+    expect(data.pagination.hasNextPage).toEqual(true)
+  })
+
+  it('should comment successfully', async () => {
+    mockResponse(
+      '/comments/1',
+      {
+        id: '1',
+        text: 'bar',
+      },
+      'post',
+    )
+
+    const data = await client.comment.comment('1', {
+      author: 'foo',
+      text: 'bar',
+      mail: 'xx@aa.com',
+    })
+
+    expect(data).toEqual({
+      id: '1',
+      text: 'bar',
+    })
+  })
+
+  it('should reply comment successfully', async () => {
+    mockResponse(
+      '/comments/reply/1',
+      {
+        id: '1',
+        text: 'bar',
+      },
+      'post',
+    )
+
+    const data = await client.comment.reply('1', {
+      author: 'f',
+      text: 'bar',
+      mail: 'a@q.com',
+    })
+
+    expect(data).toEqual({ id: '1', text: 'bar' })
+  })
+})

package/__tests__/contronllers/link.test.ts

@@ -0,0 +1,95 @@
+import camelcaseKeys from 'camelcase-keys'
+
+import { mockRequestInstance } from '~/__tests__/helpers/instance'
+import { mockResponse } from '~/__tests__/helpers/response'
+import { LinkController } from '~/controllers'
+
+describe('test link client, /links', () => {
+  const client = mockRequestInstance(LinkController)
+
+  test('GET /', async () => {
+    const mocked = mockResponse('/links?size=10&page=1', {
+      data: [
+        {
+          type: 0,
+          state: 0,
+          id: '615c191ed5db15a1000e3ca6',
+          url: 'https://barry-flynn.github.io/',
+          avatar: 'https://i.loli.net/2021/09/09/5belKgmrkjN8ZQ7.jpg',
+          description: '星河滚烫，无问西东。',
+          name: '百里飞洋の博客',
+          created: '2021-10-05T09:21:34.257Z',
+          hide: false,
+        },
+        // ...
+      ],
+      pagination: {
+        total: 43,
+        current_page: 1,
+        total_page: 5,
+        size: 10,
+        has_next_page: true,
+        has_prev_page: false,
+      },
+    })
+
+    const data = await client.link.getAllPaginated(1, 10)
+    expect(data.$raw.data).toEqual(mocked)
+    expect(data).toEqual(camelcaseKeys(mocked, { deep: true }))
+  })
+
+  it('should `friend` == `link`', () => {
+    expect(client.link).toEqual(client.friend)
+  })
+
+  test('GET /all', async () => {
+    const mocked = mockResponse('/links/all', {
+      data: [],
+    })
+
+    const data = await client.link.getAll()
+    expect(data.$raw.data).toEqual(mocked)
+    expect(data).toEqual(camelcaseKeys(mocked, { deep: true }))
+  })
+
+  test('GET /:id', async () => {
+    const mocked = mockResponse('/links/5eaabe10cd5bca719652179d', {
+      id: '5eaabe10cd5bca719652179d',
+      name: '静かな森',
+      url: 'https://innei.ren',
+      avatar: 'https://cdn.innei.ren/avatar.png',
+      created: '2020-04-30T12:01:20.738Z',
+      type: 0,
+      description: '致虚极，守静笃。',
+      state: 0,
+    })
+    const data = await client.link.getById('5eaabe10cd5bca719652179d')
+    expect(data.$raw.data).toEqual(mocked)
+    expect(data).toEqual(camelcaseKeys(mocked, { deep: true }))
+  })
+
+  test('GET /audit', async () => {
+    const mocked = mockResponse('/links/audit', {
+      can: true,
+    })
+
+    const allowed = await client.link.canApplyLink()
+
+    expect(allowed).toEqual(mocked.can)
+  })
+
+  test('POST /audit', async () => {
+    const payload = {
+      author: '',
+      avatar: '',
+      name: '',
+      url: '',
+      description: '',
+      email: '',
+    }
+    mockResponse('/links/audit', 'OK', 'post', payload)
+    const res = await client.link.applyLink(payload)
+
+    expect(res).toEqual('OK')
+  })
+})

package/__tests__/contronllers/note.test.ts

@@ -0,0 +1,120 @@
+import { vi } from 'vitest'
+
+import { mockRequestInstance } from '~/__tests__/helpers/instance'
+import { mockResponse } from '~/__tests__/helpers/response'
+import { axiosAdaptor } from '~/adaptors/axios'
+import { NoteController } from '~/controllers'
+import { RequestError } from '~/core'
+
+const { spyOn } = vi
+
+describe('test note client', () => {
+  const client = mockRequestInstance(NoteController)
+
+  it('should get note list', async () => {
+    mockResponse('/notes', {
+      data: [],
+      pagination: {},
+    })
+
+    const data = await client.note.getList()
+    expect(data).toEqual({ data: [], pagination: {} })
+  })
+
+  it('should get post list filter filed', async () => {
+    const mocked = mockResponse('/notes?page=1&size=1&select=created+title', {
+      data: [{}],
+    })
+
+    const data = await client.note.getList(1, 1, {
+      select: ['created', 'title'],
+    })
+    expect(data).toEqual(mocked)
+  })
+
+  it('should get latest note', async () => {
+    mockResponse('/notes/latest', { data: { title: '1' } })
+    const data = await client.note.getLatest()
+    expect(data.data.title).toBe('1')
+  })
+
+  it('should get middle list of note', async () => {
+    mockResponse('/notes/list/1', {
+      data: [
+        {
+          id: '1',
+        },
+        {
+          id: '2',
+        },
+      ],
+      size: 2,
+    })
+    const data = await client.note.getMiddleList('1')
+    expect(data).toEqual({
+      data: [
+        {
+          id: '1',
+        },
+        {
+          id: '2',
+        },
+      ],
+      size: 2,
+    })
+  })
+
+  it('should get single note', async () => {
+    mockResponse('/notes/1', { title: '1' })
+
+    const data = await client.note.getNoteById('1')
+
+    expect(data).toStrictEqual({ title: '1' })
+    expect(data.$raw).toBeDefined()
+  })
+
+  it('should get note by nid', async () => {
+    mockResponse('/notes/nid/1', { data: { title: '1' } })
+
+    const data = await client.note.getNoteById(1)
+    expect(data.data.title).toBe('1')
+  })
+
+  it('should get note by nid query single result', async () => {
+    mockResponse('/notes/nid/1', { title: '1' })
+
+    const data = await client.note.getNoteById(1, undefined, true)
+    expect(data.title).toBe('1')
+  })
+
+  it('should like note', async () => {
+    mockResponse('/notes/like/1', null)
+
+    const data = await client.note.likeIt('1')
+
+    expect(data).toBeNull()
+  })
+
+  it('should forbidden if no password provide', async () => {
+    spyOn(axiosAdaptor, 'get').mockRejectedValue({
+      response: {
+        data: {
+          message: 'password required',
+        },
+        status: 403,
+      },
+    })
+
+    await expect(client.note.getNoteById('1')).rejects.toThrowError(
+      RequestError,
+    )
+  })
+
+  test('GET /notes/topics/:id', async () => {
+    mockResponse('/notes/topics/11111111', { data: [], pagination: {} })
+
+    const data = await client.note.getNoteByTopicId('11111111')
+
+    expect(data).toEqual({ data: [], pagination: {} })
+  })
+})

package/__tests__/contronllers/page.test.ts

@@ -0,0 +1,49 @@
+import { mockRequestInstance } from '~/__tests__/helpers/instance'
+import { mockResponse } from '~/__tests__/helpers/response'
+import { PageController } from '~/controllers/page'
+
+describe('test page client', () => {
+  const client = mockRequestInstance(PageController)
+
+  it('should get page list', async () => {
+    mockResponse('/pages?size=10&page=1', {
+      data: [],
+      pagination: {},
+    })
+    const data = await client.page.getList()
+    expect(data).toEqual({ data: [], pagination: {} })
+  })
+
+  it('should get post list filter filed', async () => {
+    const mocked = mockResponse('/pages?page=1&size=1&select=created+title', {
+      data: [{}],
+    })
+
+    const data = await client.page.getList(1, 1, {
+      select: ['created', 'title'],
+    })
+    expect(data).toEqual(mocked)
+  })
+
+  it('should get single page', async () => {
+    mockResponse('/pages/1', {
+      title: '1',
+    })
+
+    const data = await client.page.getById('1')
+
+    expect(data).toStrictEqual({ title: '1' })
+    expect(data.$raw).toBeDefined()
+  })
+
+  it('should get by slug', async () => {
+    mockResponse('/pages/slug/about', {
+      title: 'about',
+      text: 'about!',
+    })
+
+    const data = await client.page.getBySlug('about')
+    expect(data.title).toBe('about')
+    expect(data.text).toBe('about!')
+  })
+})