@mx-space/api-client 1.0.0 → 1.0.2

package/lib/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../utils/index.ts"],"names":[],"mappings":";;;AAEO,MAAM,aAAa,GAAG,CAAC,GAAQ,EAAE,EAAE,CACxC,QAAQ,CAAC,GAAG,CAAC;IACb,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,iBAAiB;IACzD,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,MAAM,CAAC,SAAS,CAAA;AAHpC,QAAA,aAAa,iBAGuB;AAE1C,MAAM,iBAAiB,GAAG,CAAC,KAAgB,EAAE,EAAE;IACpD,OAAO,CACL;QACE,GAAG,EAAE,CAAC;QACN,IAAI,EAAE,CAAC,CAAC;KACT,CAAC,KAAK,CAAC,IAAI,CAAC,CACd,CAAA;AACH,CAAC,CAAA;AAPY,QAAA,iBAAiB,qBAO7B;AACD,MAAM,QAAQ,GAAG,CAAC,GAAQ,EAAE,EAAE,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,CAAA;AACtD,MAAM,eAAe,GAAG,CAAC,OAAY,EAAE,EAAE;IAC9C,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;QAC/B,OAAO,OAAO,CAAA;KACf;IACD,IAAI,OAAO,KAAK,IAAI,EAAE;QACpB,OAAO,OAAO,CAAA;KACf;IAED,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAA;IAEzB,MAAM,iBAAiB,GAAG,IAAA,qBAAa,EAAC,IAAI,CAAC,CAAA;IAE7C,IAAI,iBAAiB,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;QAC1D,MAAM,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,CAAA;QACjC,2BAA2B;QAC3B,IAAA,gCAAwB,EAAC,OAAO,EAAE,CAAC,CAAC,CAAA;QACpC,OAAO,CAAC,CAAA;KACT;IAED,OAAO,OAAO,CAAA;AAChB,CAAC,CAAA;AApBY,QAAA,eAAe,mBAoB3B;AAEM,MAAM,wBAAwB,GAAG,CAAC,IAAS,EAAE,EAAO,EAAE,EAAE;IAC7D,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE;QAC1B,OAAM;KACP;IACD,IAAI,CAAC,IAAI;QACP,MAAM,CAAC,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE;YAChC,KAAK,EAAE,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE;YACvB,UAAU,EAAE,KAAK;SAClB,CAAC,CAAA;IACJ,IAAI,CAAC,QAAQ;QACX,MAAM,CAAC,cAAc,CAAC,EAAE,EAAE,UAAU,EAAE;YACpC,KAAK,EAAE,EAAE,GAAG,IAAI,CAAC,QAAQ,EAAE;YAC3B,UAAU,EAAE,KAAK;SAClB,CAAC,CAAA;AACN,CAAC,CAAA;AAdY,QAAA,wBAAwB,4BAcpC"}

package/lib/utils/path.d.ts

@@ -0,0 +1 @@
+export declare const resolveFullPath: (endpoint: string, path: string) => string;

package/lib/utils/path.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveFullPath = void 0;
+const resolveFullPath = (endpoint, path) => {
+    if (!path.startsWith('/')) {
+        path = `/${path}`;
+    }
+    return `${endpoint}${path}`;
+};
+exports.resolveFullPath = resolveFullPath;
+//# sourceMappingURL=path.js.map

package/lib/utils/path.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"path.js","sourceRoot":"","sources":["../../utils/path.ts"],"names":[],"mappings":";;;AAAO,MAAM,eAAe,GAAG,CAAC,QAAgB,EAAE,IAAY,EAAE,EAAE;IAChE,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;QACzB,IAAI,GAAG,IAAI,IAAI,EAAE,CAAA;KAClB;IACD,OAAO,GAAG,QAAQ,GAAG,IAAI,EAAE,CAAA;AAC7B,CAAC,CAAA;AALY,QAAA,eAAe,mBAK3B"}

package/lib/vitest.config.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("vitest/dist/config").UserConfigExport;
+export default _default;

package/lib/vitest.config.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const vite_tsconfig_paths_1 = __importDefault(require("vite-tsconfig-paths"));
+const config_1 = require("vitest/config");
+// eslint-disable-next-line import/no-default-export
+exports.default = (0, config_1.defineConfig)({
+    test: {
+        globals: true,
+        include: ['__tests__/**/*.(spec|test).ts'],
+    },
+    // @ts-ignore
+    plugins: [(0, vite_tsconfig_paths_1.default)()],
+});
+//# sourceMappingURL=vitest.config.js.map

package/lib/vitest.config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vitest.config.js","sourceRoot":"","sources":["../vitest.config.ts"],"names":[],"mappings":";;;;;AAAA,8EAAwC;AACxC,0CAA4C;AAE5C,oDAAoD;AACpD,kBAAe,IAAA,qBAAY,EAAC;IAC1B,IAAI,EAAE;QACJ,OAAO,EAAE,IAAI;QAEb,OAAO,EAAE,CAAC,+BAA+B,CAAC;KAC3C;IAED,aAAa;IACb,OAAO,EAAE,CAAC,IAAA,6BAAM,GAAE,CAAC;CACpB,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mx-space/api-client",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "type": "module",
   "description": "A api client for mx-space server@next",
   "author": "Innei",
@@ -25,6 +25,19 @@
       "import": "./dist/index.js",
       "require": "./dist/index.cjs"
     },
+    "./dist/*": {
+      "types": "./types/*.d.ts",
+      "import": "./dist/*.js",
+      "require": "./dist/*.cjs"
+    },
+    "./dist/adaptors/*": {
+      "types": "./types/adaptors/*.d.ts",
+      "import": "./dist/adaptors/*.js",
+      "require": "./dist/adaptors/*.cjs"
+    },
+    "./types/*": {
+      "types": "./types/*.d.ts"
+    },
     "./package.json": "./package.json",
     "./adaptors/*": {
       "types": "./types/adaptors/*.d.ts",
@@ -64,16 +77,6 @@
   "engines": {
     "pnpm": ">=6"
   },
-  "scripts": {
-    "prebuild": "rm -rf lib && rm -rf esm",
-    "build": "tsc --build tsconfig.build.json && tsc --build tsconfig.cjs.json",
-    "postbuild": "tsc-alias -p tsconfig.build.json && tsc-alias -p tsconfig.cjs.json && npm run types",
-    "types": "rm -rf types && tsc --build tsconfig.types.json && tsc-alias -p tsconfig.types.json",
-    "package": "NODE_ENV=production npm run build && rollup -c",
-    "prepackage": "rm -rf dist",
-    "test": "vitest",
-    "dev": "vite"
-  },
   "devDependencies": {
     "@rollup/plugin-commonjs": "22.0.2",
     "@rollup/plugin-node-resolve": "14.0.1",
@@ -84,6 +87,7 @@
     "abort-controller": "3.0.0",
     "axios": "*",
     "camelcase-keys": "*",
+    "concurrently": "7.6.0",
     "cors": "2.8.5",
     "dts-bundle-generator": "7.0.0",
     "express": "4.18.2",
@@ -96,5 +100,15 @@
     "rollup-plugin-terser": "7.0.2",
     "tsc-alias": "1.7.0",
     "umi-request": "1.4.0"
+  },
+  "scripts": {
+    "prebuild": "rm -rf lib && rm -rf esm",
+    "build": "concurrently \"tsc --build tsconfig.build.json\" \"tsc --build tsconfig.cjs.json\"",
+    "postbuild": "concurrently \"tsc-alias -p tsconfig.build.json\" \"tsc-alias -p tsconfig.cjs.json\"  \"npm run types\"",
+    "types": "rm -rf types && tsc --build tsconfig.types.json && tsc-alias -p tsconfig.types.json",
+    "package": "NODE_ENV=production concurrently \"npm run build\" \"rollup -c\"",
+    "prepackage": "rm -rf dist",
+    "test": "vitest",
+    "dev": "vitest"
   }
-}
+}

package/types/adaptors/axios.d.ts

@@ -0,0 +1,4 @@
+import { AxiosInstance, AxiosResponse } from 'axios';
+import { IRequestAdapter } from '../interfaces/adapter';
+export declare const axiosAdaptor: IRequestAdapter<AxiosInstance, AxiosResponse<unknown>>;
+export default axiosAdaptor;

package/types/adaptors/ky.d.ts

@@ -0,0 +1,23 @@
+import { ResponsePromise } from 'ky';
+import { KyInstance } from 'ky/distribution/types/ky';
+export declare const createKyAdaptor: (ky: KyInstance) => Readonly<{
+    responseWrapper: ResponsePromise;
+} & {
+    default: KyInstance;
+    get<P = unknown>(url: string, options?: Omit<import("../interfaces/instance").RequestOptions, "data"> | undefined): import("../interfaces/adapter").IAdaptorRequestResponseType<P>;
+    post<P_1 = unknown>(url: string, options: Partial<import("../interfaces/instance").RequestOptions>): import("../interfaces/adapter").IAdaptorRequestResponseType<P_1>;
+    patch<P_2 = unknown>(url: string, options: Partial<import("../interfaces/instance").RequestOptions>): import("../interfaces/adapter").IAdaptorRequestResponseType<P_2>;
+    delete<P_3 = unknown>(url: string, options?: Omit<import("../interfaces/instance").RequestOptions, "data"> | undefined): import("../interfaces/adapter").IAdaptorRequestResponseType<P_3>;
+    put<P_4 = unknown>(url: string, options: Partial<import("../interfaces/instance").RequestOptions>): import("../interfaces/adapter").IAdaptorRequestResponseType<P_4>;
+}>;
+export declare const defaultKyAdaptor: Readonly<{
+    responseWrapper: ResponsePromise;
+} & {
+    default: KyInstance;
+    get<P = unknown>(url: string, options?: Omit<import("../interfaces/instance").RequestOptions, "data"> | undefined): import("../interfaces/adapter").IAdaptorRequestResponseType<P>;
+    post<P_1 = unknown>(url: string, options: Partial<import("../interfaces/instance").RequestOptions>): import("../interfaces/adapter").IAdaptorRequestResponseType<P_1>;
+    patch<P_2 = unknown>(url: string, options: Partial<import("../interfaces/instance").RequestOptions>): import("../interfaces/adapter").IAdaptorRequestResponseType<P_2>;
+    delete<P_3 = unknown>(url: string, options?: Omit<import("../interfaces/instance").RequestOptions, "data"> | undefined): import("../interfaces/adapter").IAdaptorRequestResponseType<P_3>;
+    put<P_4 = unknown>(url: string, options: Partial<import("../interfaces/instance").RequestOptions>): import("../interfaces/adapter").IAdaptorRequestResponseType<P_4>;
+}>;
+export default defaultKyAdaptor;

package/types/adaptors/umi-request.d.ts

@@ -0,0 +1,4 @@
+import { RequestMethod, RequestResponse } from 'umi-request';
+import { IRequestAdapter } from '../interfaces/adapter';
+export declare const umiAdaptor: IRequestAdapter<RequestMethod<true>, RequestResponse>;
+export default umiAdaptor;

package/types/controllers/aggregate.d.ts

@@ -0,0 +1,64 @@
+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, TimelineData, TimelineType } from '../models/aggregate';
+import { HTTPClient } from '../core';
+declare module '../core/client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        aggregate: AggregateController<ResponseWrapper>;
+    }
+}
+export declare class AggregateController<ResponseWrapper> implements IController {
+    private client;
+    base: string;
+    name: string;
+    constructor(client: HTTPClient);
+    get proxy(): IRequestHandler<ResponseWrapper>;
+    /**
+     * 获取聚合数据
+     */
+    getAggregateData(): RequestProxyResult<AggregateRoot, ResponseWrapper>;
+    /**
+     * 获取最新发布的内容
+     */
+    getTop(size?: number): RequestProxyResult<AggregateTop, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: AggregateTop;
+    } : ResponseWrapper extends {
+        data: AggregateTop;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: AggregateTop;
+    }>;
+    getTimeline(options?: {
+        sort?: SortOrder;
+        type?: TimelineType;
+        year?: number;
+    }): RequestProxyResult<{
+        data: TimelineData;
+    }, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: {
+            data: TimelineData;
+        };
+    } : ResponseWrapper extends {
+        data: {
+            data: TimelineData;
+        };
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: {
+            data: TimelineData;
+        };
+    }>;
+    /**
+     * 获取聚合数据统计
+     */
+    getStat(): RequestProxyResult<AggregateStat, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: AggregateStat;
+    } : ResponseWrapper extends {
+        data: AggregateStat;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: AggregateStat;
+    }>;
+}

package/types/controllers/base.d.ts

@@ -0,0 +1,43 @@
+import { IRequestHandler, RequestProxyResult } from '../interfaces/request';
+import { PaginateResult } from '../models/base';
+import { HTTPClient } from '../core';
+export type SortOptions = {
+    sortBy?: string;
+    sortOrder?: 1 | -1 | 'asc' | 'desc';
+};
+export declare abstract class BaseCrudController<T, ResponseWrapper> {
+    protected client: HTTPClient;
+    base: string;
+    constructor(client: HTTPClient);
+    get proxy(): IRequestHandler<ResponseWrapper>;
+    getById(id: string): RequestProxyResult<T, ResponseWrapper>;
+    getAll(): RequestProxyResult<{
+        data: T[];
+    }, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: {
+            data: T[];
+        };
+    } : ResponseWrapper extends {
+        data: {
+            data: T[];
+        };
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: {
+            data: T[];
+        };
+    }>;
+    /**
+     * 带分页的查询
+     * @param page
+     * @param perPage
+     */
+    getAllPaginated(page?: number, perPage?: number, sortOption?: SortOptions): RequestProxyResult<PaginateResult<T>, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: PaginateResult<T>;
+    } : ResponseWrapper extends {
+        data: PaginateResult<T>;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: PaginateResult<T>;
+    }>;
+}

package/types/controllers/category.d.ts

@@ -0,0 +1,114 @@
+import { IRequestAdapter } from '../interfaces/adapter';
+import { IController } from '../interfaces/controller';
+import { IRequestHandler, RequestProxyResult, ResponseProxyExtraRaw } from '../interfaces/request';
+import { HTTPClient } from '../core/client';
+import { CategoryModel, CategoryType, CategoryWithChildrenModel, TagModel } from '../models/category';
+import { PostModel } from '../models/post';
+declare module '../core/client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        category: CategoryController<ResponseWrapper>;
+    }
+}
+export declare class CategoryController<ResponseWrapper> implements IController {
+    private client;
+    name: string;
+    base: string;
+    constructor(client: HTTPClient);
+    get proxy(): IRequestHandler<ResponseWrapper>;
+    getAllCategories(): RequestProxyResult<{
+        data: CategoryModel[];
+    }, ResponseWrapper>;
+    getAllTags(): RequestProxyResult<{
+        data: TagModel[];
+    }, ResponseWrapper>;
+    getCategoryDetail(id: string): Promise<ResponseProxyExtraRaw<CategoryWithChildrenModel>>;
+    getCategoryDetail(ids: string[]): Promise<ResponseProxyExtraRaw<Map<string, CategoryWithChildrenModel>>>;
+    getCategoryByIdOrSlug(idOrSlug: string): Promise<CategoryModel & {
+        children: Pick<PostModel, "id" | "created" | "modified" | "title" | "slug">[];
+    } & {
+        $raw: ResponseWrapper extends {
+            data: infer T;
+        } ? ResponseWrapper : ResponseWrapper extends unknown ? {
+            [i: string]: any;
+            data: (ResponseWrapper extends unknown ? {
+                [key: string]: any;
+                data: CategoryWithChildrenModel;
+            } : ResponseWrapper extends {
+                data: CategoryWithChildrenModel;
+            } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+                data: CategoryWithChildrenModel;
+            }) extends infer T_1 ? T_1 extends (ResponseWrapper extends unknown ? {
+                [key: string]: any;
+                data: CategoryWithChildrenModel;
+            } : ResponseWrapper extends {
+                data: CategoryWithChildrenModel;
+            } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+                data: CategoryWithChildrenModel;
+            }) ? T_1 extends unknown ? {
+                type: CategoryType;
+                count: number;
+                slug: string;
+                name: string;
+                created: string;
+                id: string;
+                children: Pick<PostModel, "id" | "created" | "modified" | "title" | "slug">[];
+            } : T_1 : never : never;
+        } : ResponseWrapper;
+        $request: {
+            [k: string]: string;
+            path: string;
+            method: string;
+        };
+    }>;
+    getTagByName(name: string): Promise<{
+        tag: string;
+        data: Pick<PostModel, 'id' | 'title' | 'slug' | 'category' | 'created'>[];
+    } & {
+        $raw: ResponseWrapper extends {
+            data: infer T;
+        } ? ResponseWrapper : ResponseWrapper extends unknown ? {
+            [i: string]: any;
+            data: (ResponseWrapper extends unknown ? {
+                [key: string]: any;
+                data: {
+                    tag: string;
+                    data: Pick<PostModel, 'id' | 'title' | 'slug' | 'category' | 'created'>[];
+                };
+            } : ResponseWrapper extends {
+                data: {
+                    tag: string;
+                    data: Pick<PostModel, 'id' | 'title' | 'slug' | 'category' | 'created'>[];
+                };
+            } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+                data: {
+                    tag: string;
+                    data: Pick<PostModel, 'id' | 'title' | 'slug' | 'category' | 'created'>[];
+                };
+            }) extends infer T_1 ? T_1 extends (ResponseWrapper extends unknown ? {
+                [key: string]: any;
+                data: {
+                    tag: string;
+                    data: Pick<PostModel, 'id' | 'title' | 'slug' | 'category' | 'created'>[];
+                };
+            } : ResponseWrapper extends {
+                data: {
+                    tag: string;
+                    data: Pick<PostModel, 'id' | 'title' | 'slug' | 'category' | 'created'>[];
+                };
+            } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+                data: {
+                    tag: string;
+                    data: Pick<PostModel, 'id' | 'title' | 'slug' | 'category' | 'created'>[];
+                };
+            }) ? T_1 extends unknown ? {
+                tag: string;
+                data: Pick<PostModel, "id" | "category" | "created" | "title" | "slug">[];
+            } : T_1 : never : never;
+        } : ResponseWrapper;
+        $request: {
+            [k: string]: string;
+            path: string;
+            method: string;
+        };
+    }>;
+}

package/types/controllers/comment.d.ts

@@ -0,0 +1,81 @@
+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 { HTTPClient } from '../core';
+import { CommentDto } from '../dtos/comment';
+declare module '../core/client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        comment: CommentController<ResponseWrapper>;
+    }
+}
+export declare class CommentController<ResponseWrapper> implements IController {
+    private readonly client;
+    base: string;
+    name: string;
+    constructor(client: HTTPClient);
+    get proxy(): IRequestHandler<ResponseWrapper>;
+    /**
+     * 根据 comment id 获取评论, 包括子评论
+     */
+    getById(id: string): import("../interfaces/request").RequestProxyResult<CommentModel & {
+        ref: string;
+    }, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: CommentModel & {
+            ref: string;
+        };
+    } : ResponseWrapper extends {
+        data: CommentModel & {
+            ref: string;
+        };
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: CommentModel & {
+            ref: string;
+        };
+    }>;
+    /**
+     * 获取文章的评论列表
+     * @param refId 文章 Id
+     */
+    getByRefId(refId: string, pagination?: PaginationParams): import("../interfaces/request").RequestProxyResult<PaginateResult<CommentModel & {
+        ref: string;
+    }>, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: PaginateResult<CommentModel & {
+            ref: string;
+        }>;
+    } : ResponseWrapper extends {
+        data: PaginateResult<CommentModel & {
+            ref: string;
+        }>;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: PaginateResult<CommentModel & {
+            ref: string;
+        }>;
+    }>;
+    /**
+     * 评论
+     */
+    comment(refId: string, data: CommentDto): import("../interfaces/request").RequestProxyResult<CommentModel, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: CommentModel;
+    } : ResponseWrapper extends {
+        data: CommentModel;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: CommentModel;
+    }>;
+    /**
+     * 回复评论
+     */
+    reply(commentId: string, data: CommentDto): import("../interfaces/request").RequestProxyResult<CommentModel, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: CommentModel;
+    } : ResponseWrapper extends {
+        data: CommentModel;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: CommentModel;
+    }>;
+}

package/types/controllers/index.d.ts

@@ -0,0 +1,18 @@
+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 { ServerlessController } from './severless';
+import { SnippetController } from './snippet';
+import { TopicController } from './topic';
+import { UserController } from './user';
+export declare const allControllers: (typeof AggregateController | typeof CategoryController | typeof CommentController | typeof LinkController | typeof NoteController | typeof PageController | typeof PostController | typeof ProjectController | typeof RecentlyController | typeof SayController | typeof SearchController | typeof ServerlessController | typeof SnippetController | typeof TopicController | typeof UserController)[];
+export declare const allContollerNames: readonly ["aggregate", "category", "comment", "link", "note", "page", "post", "project", "topic", "recently", "say", "search", "snippet", "serverless", "user", "friend", "master", "shorthand"];
+export { AggregateController, CategoryController, CommentController, LinkController, NoteController, PageController, PostController, ProjectController, RecentlyController, SayController, SearchController, SnippetController, ServerlessController, UserController, TopicController, };

package/types/controllers/link.d.ts

@@ -0,0 +1,20 @@
+import { IRequestAdapter } from '../interfaces/adapter';
+import { LinkModel } from '../models/link';
+import { 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 declare class LinkController<ResponseWrapper> extends BaseCrudController<LinkModel, ResponseWrapper> {
+    protected readonly client: HTTPClient;
+    constructor(client: HTTPClient);
+    canApplyLink(): Promise<boolean>;
+    applyLink(data: Pick<LinkModel, 'avatar' | 'name' | 'description' | 'url' | 'email'> & {
+        author: string;
+    }): Promise<never>;
+    name: string[];
+    base: string;
+}

package/types/controllers/note.d.ts

@@ -0,0 +1,123 @@
+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 { HTTPClient } from '../core/client';
+import { 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 declare class NoteController<ResponseWrapper> implements IController {
+    private client;
+    base: string;
+    name: string;
+    constructor(client: HTTPClient);
+    get proxy(): IRequestHandler<ResponseWrapper>;
+    /**
+     * 最新日记
+     */
+    getLatest(): RequestProxyResult<NoteWrappedWithLikedPayload, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: NoteWrappedWithLikedPayload;
+    } : ResponseWrapper extends {
+        data: NoteWrappedWithLikedPayload; /**
+         * 获取一篇日记，根据 Id 查询需要鉴权
+         * @param id id | nid
+         * @param password 访问密码
+         */
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: 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>>;
+    /**
+     * 日记列表分页
+     */
+    getList(page?: number, perPage?: number, options?: NoteListOptions): RequestProxyResult<PaginateResult<NoteModel>, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: PaginateResult<NoteModel>;
+    } : ResponseWrapper extends {
+        data: PaginateResult<NoteModel>; /**
+         * 获取一篇日记，根据 Id 查询需要鉴权
+         * @param id id | nid
+         * @param password 访问密码
+         */
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: PaginateResult<NoteModel>;
+    }>;
+    /**
+     * 获取当前日记的上下各 n / 2 篇日记
+     */
+    getMiddleList(id: string, size?: number): RequestProxyResult<{
+        data: Pick<NoteModel, 'id' | 'title' | 'nid' | 'created'>[];
+        size: number;
+    }, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: {
+            data: Pick<NoteModel, 'id' | 'title' | 'nid' | 'created'>[];
+            size: number;
+        };
+    } : ResponseWrapper extends {
+        data: {
+            data: Pick<NoteModel, 'id' | 'title' | 'nid' | 'created'>[];
+            size: number;
+        }; /**
+         * 获取一篇日记，根据 Id 查询需要鉴权
+         * @param id id | nid
+         * @param password 访问密码
+         */
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: {
+            data: Pick<NoteModel, 'id' | 'title' | 'nid' | 'created'>[];
+            size: number;
+        };
+    }>;
+    /**
+     * 喜欢这篇日记
+     */
+    likeIt(id: string | number): RequestProxyResult<never, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: never;
+    } : ResponseWrapper extends {
+        data: never; /**
+         * 获取一篇日记，根据 Id 查询需要鉴权
+         * @param id id | nid
+         * @param password 访问密码
+         */
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: never;
+    }>;
+    /**
+     * 获取专栏内的所有日记
+     */
+    getNoteByTopicId(topicId: string, page?: number, size?: number, sortOptions?: SortOptions): RequestProxyResult<PaginateResult<NoteModel>, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: PaginateResult<NoteModel>;
+    } : ResponseWrapper extends {
+        data: PaginateResult<NoteModel>; /**
+         * 获取一篇日记，根据 Id 查询需要鉴权
+         * @param id id | nid
+         * @param password 访问密码
+         */
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: PaginateResult<NoteModel>;
+    }>;
+}