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

package/__tests__/utils/auto-bind.spec.ts

@@ -0,0 +1,27 @@
+import { autoBind } from '~/utils/auto-bind'
+
+describe('test auto bind', () => {
+  it('should bind in class', () => {
+    class A {
+      constructor() {
+        autoBind(this)
+      }
+      name = 'A'
+      foo() {
+        return this?.name
+      }
+    }
+
+    expect(new A().foo()).toBe('A')
+
+    function tester(caller: any) {
+      return caller()
+    }
+    expect(tester(new A().foo)).toBe('A')
+
+    function tester2<T extends (...args: any) => any>(caller: T) {
+      return caller.call({})
+    }
+    expect(tester2(new A().foo)).toBe('A')
+  })
+})

package/__tests__/utils/camelcase-keys.spec.ts

@@ -0,0 +1,86 @@
+import camelcaseKeysLib from 'camelcase-keys'
+
+import { camelcaseKeys } from '~/utils/camelcase-keys'
+
+describe('test camelcase keys', () => {
+  it('case 1 normal', () => {
+    const obj = {
+      tool: 'too',
+      tool_name: 'too_name',
+
+      a_b: 1,
+      a: 1,
+      b: {
+        c_d: 1,
+      },
+    }
+
+    expect(camelcaseKeys(obj)).toStrictEqual(
+      camelcaseKeysLib(obj, {
+        deep: true,
+      }),
+    )
+  })
+
+  it('case 2: key has number', () => {
+    const obj = {
+      b147da0eaecbea00aeb62055: {
+        data: {},
+      },
+      a_c11ab_Ac: [
+        {
+          a_b: 1,
+        },
+        1,
+      ],
+    }
+
+    expect(camelcaseKeys(obj)).toStrictEqual({
+      b147da0eaecbea00aeb62055: {
+        data: {},
+      },
+      aC11abAc: [
+        {
+          aB: 1,
+        },
+        1,
+      ],
+    })
+  })
+
+  it('case 3: not a object', () => {
+    const value = 1
+    expect(camelcaseKeys(value)).toBe(value)
+  })
+
+  it('case 4: nullable value', () => {
+    let value = null
+    expect(camelcaseKeys(value)).toBe(value)
+
+    value = undefined
+    expect(camelcaseKeys(value)).toBe(value)
+
+    value = NaN
+    expect(camelcaseKeys(value)).toBe(value)
+  })
+
+  it('case 5: array', () => {
+    const arr = [
+      {
+        a_b: 1,
+      },
+      null,
+      undefined,
+      +0,
+      -0,
+      Infinity,
+      {
+        a_b: 1,
+      },
+    ]
+
+    expect(camelcaseKeys(arr)).toStrictEqual(
+      camelcaseKeysLib(arr, { deep: true }),
+    )
+  })
+})

package/__tests__/utils/index.test.ts

@@ -0,0 +1,33 @@
+import { destructureData } from '~/utils'
+
+describe('test utils', () => {
+  test('destructureData', () => {
+    const d = destructureData({ data: { a: 1, b: 2 } })
+    expect(d).toEqual({ a: 1, b: 2 })
+
+    const d2 = destructureData({ data: { a: 1, b: 2 }, c: 3 })
+    expect(d2).toEqual({ data: { a: 1, b: 2 }, c: 3 })
+
+    const d3 = destructureData({ data: [{ a: 1 }] })
+    expect(d3).toEqual({ data: [{ a: 1 }] })
+
+    const d4 = destructureData({ a: 1 })
+    expect(d4).toEqual({ a: 1 })
+
+    const d5 = destructureData([])
+    expect(d5).toEqual([])
+
+    const d6 = destructureData({ data: [] })
+    expect(d6).toEqual({ data: [] })
+
+    const d7 = destructureData(
+      (() => {
+        const d = { data: { a: 1 } }
+        Object.defineProperty(d, '$raw', { value: { a: 1 }, enumerable: false })
+        return d
+      })(),
+    )
+    expect(d7).toEqual({ a: 1 })
+    expect(d7.$raw).toBeTruthy()
+  })
+})

package/__tests__/utils/path.spec.ts

@@ -0,0 +1,8 @@
+import { resolveFullPath } from '~/utils/path'
+
+describe('TEST path.utils', () => {
+  it('should resolve full path', () => {
+    const path = resolveFullPath('http://localhost:3000', '/api/v1/users')
+    expect(path).toBe('http://localhost:3000/api/v1/users')
+  })
+})

package/adaptors/axios.ts

@@ -0,0 +1,44 @@
+import axios, { AxiosInstance, AxiosResponse } from 'axios'
+
+import { IRequestAdapter } from '~/interfaces/adapter'
+
+// eslint-disable-next-line spaced-comment
+const $http = /*#__PURE__*/ axios.create({})
+
+// ignore axios `method` declare not assignable to `Method`
+export const axiosAdaptor: IRequestAdapter<
+  AxiosInstance,
+  AxiosResponse<unknown>
+> = Object.preventExtensions({
+  get default() {
+    return $http
+  },
+  responseWrapper: {} as any as AxiosResponse<unknown>,
+  get(url, options) {
+    // @ts-ignore
+    return $http.get(url, options)
+  },
+  post(url, options) {
+    const { data, ...config } = options || {}
+    // @ts-ignore
+    return $http.post(url, data, config)
+  },
+  put(url, options) {
+    const { data, ...config } = options || {}
+    // @ts-ignore
+    return $http.put(url, data, config)
+  },
+  delete(url, options) {
+    const { ...config } = options || {}
+    // @ts-ignore
+    return $http.delete(url, config)
+  },
+  patch(url, options) {
+    const { data, ...config } = options || {}
+    // @ts-ignore
+    return $http.patch(url, data, config)
+  },
+})
+
+// eslint-disable-next-line import/no-default-export
+export default axiosAdaptor

package/adaptors/ky.ts

@@ -0,0 +1,76 @@
+import ky, { Options, ResponsePromise } from 'ky'
+import { KyInstance } from 'ky/distribution/types/ky'
+
+import { IRequestAdapter } from '~/interfaces/adapter'
+
+// eslint-disable-next-line spaced-comment
+const $http: KyInstance = /*#__PURE__*/ ky.create({})
+// TODO post data not only json,
+const getDataFromKyResponse = async (response: ResponsePromise) => {
+  const res = await response
+
+  const isJsonType = res.headers
+    .get('content-type')
+    ?.includes('application/json')
+  const json = isJsonType ? await res.clone().json() : null
+
+  const result: Awaited<ResponsePromise> & {
+    data: any
+  } = {
+    ...res,
+    data: json ?? (await res.clone().text()),
+  }
+  return result
+}
+
+export const createKyAdaptor = (ky: KyInstance) => {
+  const adaptor: IRequestAdapter<KyInstance, ResponsePromise> =
+    Object.preventExtensions({
+      get default() {
+        return ky
+      },
+
+      responseWrapper: {} as any as ResponsePromise,
+      get(url, options) {
+        return getDataFromKyResponse(ky.get(url, options))
+      },
+      post(url, options) {
+        const data = options.data
+        delete options.data
+        const kyOptions: Options = {
+          ...options,
+          json: data,
+        }
+
+        return getDataFromKyResponse(ky.post(url, kyOptions))
+      },
+      put(url, options) {
+        const data = options.data
+        delete options.data
+        const kyOptions: Options = {
+          ...options,
+          json: data,
+        }
+        return getDataFromKyResponse(ky.put(url, kyOptions))
+      },
+
+      patch(url, options) {
+        const data = options.data
+        delete options.data
+        const kyOptions: Options = {
+          ...options,
+          json: data,
+        }
+        return getDataFromKyResponse(ky.patch(url, kyOptions))
+      },
+      delete(url, options) {
+        return getDataFromKyResponse(ky.delete(url, options))
+      },
+    })
+  return adaptor
+}
+
+export const defaultKyAdaptor = createKyAdaptor($http)
+
+// eslint-disable-next-line import/no-default-export
+export default defaultKyAdaptor

package/adaptors/umi-request.ts

@@ -0,0 +1,38 @@
+import { RequestMethod, RequestResponse, extend } from 'umi-request'
+
+import { IRequestAdapter } from '~/interfaces/adapter'
+
+// eslint-disable-next-line spaced-comment
+const $http = /*#__PURE__*/ extend({
+  getResponse: true,
+  requestType: 'json',
+  responseType: 'json',
+})
+
+export const umiAdaptor: IRequestAdapter<
+  RequestMethod<true>,
+  RequestResponse
+> = Object.preventExtensions({
+  get default() {
+    return $http
+  },
+  responseWrapper: {} as any as RequestResponse,
+  get(url, options) {
+    return $http.get(url, options)
+  },
+  post(url, options) {
+    return $http.post(url, options)
+  },
+  put(url, options) {
+    return $http.put(url, options)
+  },
+  delete(url, options) {
+    return $http.delete(url, options)
+  },
+  patch(url, options) {
+    return $http.patch(url, options)
+  },
+})
+
+// eslint-disable-next-line import/no-default-export
+export default umiAdaptor

package/controllers/aggregate.ts

@@ -1,8 +1,8 @@
-import type { IRequestAdapter } from '~/interfaces/adapter'
-import type { IController } from '~/interfaces/controller'
-import type { SortOrder } from '~/interfaces/options'
-import type { IRequestHandler, RequestProxyResult } from '~/interfaces/request'
-import type {
+import { IRequestAdapter } from '~/interfaces/adapter'
+import { IController } from '~/interfaces/controller'
+import { SortOrder } from '~/interfaces/options'
+import { IRequestHandler, RequestProxyResult } from '~/interfaces/request'
+import {
   AggregateRoot,
   AggregateStat,
   AggregateTop,
@@ -12,7 +12,7 @@ import type {
 import { sortOrderToNumber } from '~/utils'
 import { autoBind } from '~/utils/auto-bind'
 
-import type { HTTPClient } from '../core'
+import { HTTPClient } from '../core'
 
 declare module '../core/client' {
   interface HTTPClient<

package/controllers/base.ts

@@ -1,8 +1,8 @@
-import type { IRequestHandler, RequestProxyResult } from '~/interfaces/request'
-import type { PaginateResult } from '~/models/base'
+import { IRequestHandler, RequestProxyResult } from '~/interfaces/request'
+import { PaginateResult } from '~/models/base'
 import { autoBind } from '~/utils/auto-bind'
 
-import type { HTTPClient } from '../core'
+import { HTTPClient } from '../core'
 
 export type SortOptions = {
   sortBy?: string

package/controllers/category.ts

@@ -1,6 +1,6 @@
-import type { IRequestAdapter } from '~/interfaces/adapter'
-import type { IController } from '~/interfaces/controller'
-import type {
+import { IRequestAdapter } from '~/interfaces/adapter'
+import { IController } from '~/interfaces/controller'
+import {
   IRequestHandler,
   RequestProxyResult,
   ResponseProxyExtraRaw,
@@ -8,16 +8,16 @@ import type {
 import { attachRawFromOneToAnthor, destructureData } from '~/utils'
 import { autoBind } from '~/utils/auto-bind'
 
-import type { HTTPClient } from '../core/client'
+import { HTTPClient } from '../core/client'
 import { RequestError } from '../core/error'
-import type {
+import {
   CategoryEntries,
   CategoryModel,
+  CategoryType,
   CategoryWithChildrenModel,
   TagModel,
 } from '../models/category'
-import { CategoryType } from '../models/category'
-import type { PostModel } from '../models/post'
+import { PostModel } from '../models/post'
 
 declare module '../core/client' {
   interface HTTPClient<

package/controllers/comment.ts

@@ -1,13 +1,13 @@
-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 { PaginateResult } from '~/models/base'
-import type { CommentModel } from '~/models/comment'
+import { IRequestAdapter } from '~/interfaces/adapter'
+import { IController } from '~/interfaces/controller'
+import { PaginationParams } from '~/interfaces/params'
+import { IRequestHandler } from '~/interfaces/request'
+import { PaginateResult } from '~/models/base'
+import { CommentModel } from '~/models/comment'
 import { autoBind } from '~/utils/auto-bind'
 
-import type { HTTPClient } from '../core'
-import type { CommentDto } from '../dtos/comment'
+import { HTTPClient } from '../core'
+import { CommentDto } from '../dtos/comment'
 
 declare module '../core/client' {
   interface HTTPClient<

package/controllers/link.ts

@@ -1,8 +1,8 @@
-import type { IRequestAdapter } from '~/interfaces/adapter'
-import type { LinkModel } from '~/models/link'
+import { IRequestAdapter } from '~/interfaces/adapter'
+import { LinkModel } from '~/models/link'
 import { autoBind } from '~/utils/auto-bind'
 
-import type { HTTPClient } from '../core'
+import { HTTPClient } from '../core'
 import { BaseCrudController } from './base'
 
 declare module '../core/client' {

package/controllers/note.ts

@@ -1,13 +1,17 @@
-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 } from '~/models/note'
+import { IRequestAdapter } from '~/interfaces/adapter'
+import { IController } from '~/interfaces/controller'
+import { IRequestHandler, RequestProxyResult } from '~/interfaces/request'
+import { SelectFields } from '~/interfaces/types'
+import { PaginateResult } from '~/models/base'
+import {
+  NoteModel,
+  NoteWrappedPayload,
+  NoteWrappedWithLikedPayload,
+} from '~/models/note'
 import { autoBind } from '~/utils/auto-bind'
 
-import type { HTTPClient } from '../core/client'
-import type { SortOptions } from './base'
+import { HTTPClient } from '../core/client'
+import { SortOptions } from './base'
 
 declare module '../core/client' {
   interface HTTPClient<
@@ -40,11 +44,11 @@ export class NoteController<ResponseWrapper> implements IController {
    * 最新日记
    */
   getLatest() {
-    return this.proxy.latest.get<NoteWrappedPayload>()
+    return this.proxy.latest.get<NoteWrappedWithLikedPayload>()
   }
 
   /**
-   * 获取一篇日记, 根据 Id 查询需要鉴权
+   * 获取一篇日记，根据 Id 查询需要鉴权
    * @param id id | nid
    * @param password 访问密码
    */
@@ -68,7 +72,7 @@ export class NoteController<ResponseWrapper> implements IController {
     const [id, password = undefined, singleResult = false] = rest
 
     if (typeof id === 'number') {
-      return this.proxy.nid(id.toString()).get<NoteWrappedPayload>({
+      return this.proxy.nid(id.toString()).get<NoteWrappedWithLikedPayload>({
         params: { password, single: singleResult ? '1' : undefined },
       })
     } else {

package/controllers/page.ts

@@ -1,12 +1,12 @@
-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 { IRequestAdapter } from '~/interfaces/adapter'
+import { IController } from '~/interfaces/controller'
+import { IRequestHandler } from '~/interfaces/request'
+import { SelectFields } from '~/interfaces/types'
+import { PaginateResult } from '~/models/base'
+import { PageModel } from '~/models/page'
 import { autoBind } from '~/utils/auto-bind'
 
-import type { HTTPClient } from '../core'
+import { HTTPClient } from '../core'
 
 declare module '../core/client' {
   interface HTTPClient<

package/controllers/post.ts

@@ -1,12 +1,12 @@
-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 { PostModel } from '~/models/post'
+import { IRequestAdapter } from '~/interfaces/adapter'
+import { IController } from '~/interfaces/controller'
+import { IRequestHandler, RequestProxyResult } from '~/interfaces/request'
+import { SelectFields } from '~/interfaces/types'
+import { ModelWithLiked, PaginateResult } from '~/models/base'
+import { PostModel } from '~/models/post'
 import { autoBind } from '~/utils/auto-bind'
 
-import type { HTTPClient } from '../core/client'
+import { HTTPClient } from '../core/client'
 
 declare module '../core/client' {
   interface HTTPClient<
@@ -65,7 +65,7 @@ export class PostController<ResponseWrapper> implements IController {
   getPost(
     categoryName: string,
     slug: string,
-  ): RequestProxyResult<PostModel, ResponseWrapper>
+  ): RequestProxyResult<ModelWithLiked<PostModel>, ResponseWrapper>
   /**
    * 根据 ID 查找文章
    * @param id
@@ -83,7 +83,7 @@ export class PostController<ResponseWrapper> implements IController {
    * 获取最新的文章
    */
   getLatest() {
-    return this.proxy.latest.get<PostModel>()
+    return this.proxy.latest.get<ModelWithLiked<PostModel>>()
   }
 
   /**

package/controllers/project.ts

@@ -1,8 +1,8 @@
-import type { IRequestAdapter } from '~/interfaces/adapter'
-import type { ProjectModel } from '~/models/project'
+import { IRequestAdapter } from '~/interfaces/adapter'
+import { ProjectModel } from '~/models/project'
 import { autoBind } from '~/utils/auto-bind'
 
-import type { HTTPClient } from '../core'
+import { HTTPClient } from '../core'
 import { BaseCrudController } from './base'
 
 declare module '../core/client' {

package/controllers/recently.ts

@@ -1,10 +1,10 @@
-import type { IRequestAdapter } from '~/interfaces/adapter'
-import type { IController } from '~/interfaces/controller'
-import type { IRequestHandler } from '~/interfaces/request'
-import type { RecentlyModel } from '~/models/recently'
+import { IRequestAdapter } from '~/interfaces/adapter'
+import { IController } from '~/interfaces/controller'
+import { IRequestHandler } from '~/interfaces/request'
+import { RecentlyModel } from '~/models/recently'
 import { autoBind } from '~/utils/auto-bind'
 
-import type { HTTPClient } from '../core'
+import { HTTPClient } from '../core'
 
 declare module '../core/client' {
   interface HTTPClient<

package/controllers/say.ts

@@ -1,10 +1,10 @@
-import type { IRequestAdapter } from '~/interfaces/adapter'
-import type { IController } from '~/interfaces/controller'
-import type { IRequestHandler } from '~/interfaces/request'
-import type { SayModel } from '~/models/say'
+import { IRequestAdapter } from '~/interfaces/adapter'
+import { IController } from '~/interfaces/controller'
+import { IRequestHandler } from '~/interfaces/request'
+import { SayModel } from '~/models/say'
 import { autoBind } from '~/utils/auto-bind'
 
-import type { HTTPClient } from '../core'
+import { HTTPClient } from '../core'
 import { BaseCrudController } from './base'
 
 declare module '../core/client' {

package/controllers/search.ts

@@ -1,13 +1,13 @@
-import type { IRequestAdapter } from '~/interfaces/adapter'
-import type { IController } from '~/interfaces/controller'
-import type { IRequestHandler, RequestProxyResult } from '~/interfaces/request'
-import type { PaginateResult } from '~/models/base'
-import type { NoteModel } from '~/models/note'
-import type { PostModel } from '~/models/post'
+import { IRequestAdapter } from '~/interfaces/adapter'
+import { IController } from '~/interfaces/controller'
+import { IRequestHandler, RequestProxyResult } from '~/interfaces/request'
+import { PaginateResult } from '~/models/base'
+import { NoteModel } from '~/models/note'
+import { PostModel } from '~/models/post'
 import { autoBind } from '~/utils/auto-bind'
 
-import type { PageModel } from '..'
-import type { HTTPClient } from '../core'
+import { PageModel } from '..'
+import { HTTPClient } from '../core'
 
 declare module '../core/client' {
   interface HTTPClient<

package/controllers/severless.ts

@@ -1,9 +1,9 @@
-import type { IRequestAdapter } from '~/interfaces/adapter'
-import type { IController } from '~/interfaces/controller'
-import type { IRequestHandler } from '~/interfaces/request'
+import { IRequestAdapter } from '~/interfaces/adapter'
+import { IController } from '~/interfaces/controller'
+import { IRequestHandler } from '~/interfaces/request'
 import { autoBind } from '~/utils/auto-bind'
 
-import type { HTTPClient } from '../core'
+import { HTTPClient } from '../core'
 
 declare module '../core/client' {
   interface HTTPClient<

package/controllers/snippet.ts

@@ -1,9 +1,9 @@
-import type { IRequestAdapter } from '~/interfaces/adapter'
-import type { IController } from '~/interfaces/controller'
-import type { IRequestHandler } from '~/interfaces/request'
+import { IRequestAdapter } from '~/interfaces/adapter'
+import { IController } from '~/interfaces/controller'
+import { IRequestHandler } from '~/interfaces/request'
 import { autoBind } from '~/utils/auto-bind'
 
-import type { HTTPClient } from '../core'
+import { HTTPClient } from '../core'
 
 declare module '../core/client' {
   interface HTTPClient<

package/controllers/topic.ts

@@ -1,10 +1,10 @@
-import type { IRequestAdapter } from '~/interfaces/adapter'
-import type { IController } from '~/interfaces/controller'
-import type { IRequestHandler } from '~/interfaces/request'
-import type { TopicModel } from '~/models/topic'
+import { IRequestAdapter } from '~/interfaces/adapter'
+import { IController } from '~/interfaces/controller'
+import { IRequestHandler } from '~/interfaces/request'
+import { TopicModel } from '~/models/topic'
 import { autoBind } from '~/utils/auto-bind'
 
-import type { HTTPClient } from '../core'
+import { HTTPClient } from '../core'
 import { BaseCrudController } from './base'
 
 declare module '../core/client' {

package/controllers/user.ts

@@ -1,10 +1,10 @@
-import type { IRequestAdapter } from '~/interfaces/adapter'
-import type { IController } from '~/interfaces/controller'
-import type { IRequestHandler } from '~/interfaces/request'
-import type { TLogin, UserModel } from '~/models/user'
+import { IRequestAdapter } from '~/interfaces/adapter'
+import { IController } from '~/interfaces/controller'
+import { IRequestHandler } from '~/interfaces/request'
+import { TLogin, UserModel } from '~/models/user'
 import { autoBind } from '~/utils/auto-bind'
 
-import type { HTTPClient } from '../core'
+import { HTTPClient } from '../core'
 
 declare module '../core/client' {
   interface HTTPClient<