@mx-space/api-client 0.7.0 → 0.7.1

package/lib/interfaces/request.d.ts

@@ -3,25 +3,33 @@ declare type NoStringIndex<T> = {
     [K in keyof T as string extends K ? never : K]: T[K];
 };
 export declare type Method = 'get' | 'delete' | 'post' | 'put' | 'patch';
-export interface IRequestHandler {
-    (path?: string | number): IRequestHandler;
-    get<P = unknown>(options?: Omit<NoStringIndex<RequestOptions>, 'data'>): RequestProxyResult<P>;
-    post<P = unknown>(options?: RequestOptions): RequestProxyResult<P>;
-    patch<P = unknown>(options?: RequestOptions): RequestProxyResult<P>;
-    delete<P = unknown>(options?: Omit<NoStringIndex<RequestOptions>, 'data'>): RequestProxyResult<P>;
-    put<P = unknown>(options?: RequestOptions): RequestProxyResult<P>;
-    [key: string]: IRequestHandler;
+export interface IRequestHandler<ResponseWrapper> {
+    (path?: string | number): IRequestHandler<ResponseWrapper>;
+    get<P = unknown>(options?: Omit<NoStringIndex<RequestOptions>, 'data'>): RequestProxyResult<P, ResponseWrapper>;
+    post<P = unknown>(options?: RequestOptions): RequestProxyResult<P, ResponseWrapper>;
+    patch<P = unknown>(options?: RequestOptions): RequestProxyResult<P, ResponseWrapper>;
+    delete<P = unknown>(options?: Omit<NoStringIndex<RequestOptions>, 'data'>): RequestProxyResult<P, ResponseWrapper>;
+    put<P = unknown>(options?: RequestOptions): RequestProxyResult<P, ResponseWrapper>;
+    toString(withBase?: boolean): string;
+    valueOf(withBase?: boolean): string;
+    [key: string]: IRequestHandler<ResponseWrapper>;
 }
-export declare type RequestProxyResult<T, R = {
+export declare type RequestProxyResult<T, ResponseWrapper, R = ResponseWrapper extends unknown ? {
     data: T;
     [key: string]: any;
-}> = Promise<ResponseProxyExtraRaw<T, R>>;
+} : ResponseWrapper extends {
+    data: T;
+} ? ResponseWrapper : Omit<ResponseWrapper, 'data'> & {
+    data: T;
+}> = Promise<ResponseProxyExtraRaw<T, R, ResponseWrapper>>;
 declare type CamelToSnake<T extends string, P extends string = ''> = string extends T ? string : T extends `${infer C0}${infer R}` ? CamelToSnake<R, `${P}${C0 extends Lowercase<C0> ? '' : '_'}${Lowercase<C0>}`> : P;
 declare type CamelKeysToSnake<T> = {
     [K in keyof T as CamelToSnake<Extract<K, string>>]: T[K];
 };
-export declare type ResponseProxyExtraRaw<T, RawData = unknown, Response = unknown> = T extends object ? T & {
-    $raw: Response extends unknown ? {
+declare type ResponseWrapperType<Response, RawData, T> = {
+    $raw: Response extends {
+        data: infer T;
+    } ? Response : Response extends unknown ? {
         [i: string]: any;
         data: RawData extends unknown ? CamelKeysToSnake<T> : RawData;
     } : Response;
@@ -30,5 +38,6 @@ export declare type ResponseProxyExtraRaw<T, RawData = unknown, Response = unkno
         method: string;
         [k: string]: string;
     };
-} : T;
+};
+export declare type ResponseProxyExtraRaw<T, RawData = unknown, Response = unknown> = T extends object ? T & ResponseWrapperType<Response, RawData, T> : T extends unknown ? T & ResponseWrapperType<Response, RawData, T> : unknown;
 export {};

package/lib/interfaces/types.d.ts

@@ -0,0 +1,2 @@
+export declare type Class<T> = new (...args: any[]) => T;
+export declare type SelectFields<T extends string> = `${'+' | '-' | ''}${T}`[];

package/lib/interfaces/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/lib/interfaces/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../interfaces/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@mx-space/api-client",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "description": "A api client for mx-space server@next",
   "author": "Innei",
   "license": "MIT",
   "main": "build/index.cjs.js",
   "module": "build/index.esm.js",
-  "types": "index.ts",
+  "types": "types/index.d.ts",
   "unpkg": "build/index.umd.min.js",
   "husky": {
     "hooks": {
@@ -33,10 +33,10 @@
     "pnpm": ">=6"
   },
   "scripts": {
-    "predeploy": "rm -rf dist",
-    "prebuild": "rm -rf rm -rf lib && rm -rf esm",
+    "prebuild": "rm -rf lib && rm -rf esm",
     "build": "tsc --build tsconfig.build.json && tsc --build tsconfig.cjs.json",
-    "postbuild": "tsconfig-replace-paths -p tsconfig.build.json && tsconfig-replace-paths -p tsconfig.cjs.json",
+    "postbuild": "tsconfig-replace-paths -p tsconfig.build.json && tsconfig-replace-paths -p tsconfig.cjs.json && npm run types",
+    "types": "rm -rf types && tsc --build tsconfig.types.json && tsconfig-replace-paths -p tsconfig.types.json",
     "package": "NODE_ENV=production npm run build && rollup -c",
     "prepackage": "rm -rf build",
     "release": "vv",

package/tsconfig.json

@@ -1,12 +1,33 @@
 {
-  "extends": "../tsconfig.json",
   "compilerOptions": {
     "declaration": true,
     "outDir": "./esm",
     "baseUrl": ".",
-    "jsx": "react"
+    "jsx": "react",
+    "target": "ES2020",
+    "lib": [
+      "ESNext",
+      "DOM",
+      "DOM.Iterable"
+    ],
+    "module": "ESNext",
+    "moduleResolution": "node",
+    "strict": true,
+    "resolveJsonModule": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "sourceMap": true,
+    "paths": {
+      "~/*": [
+        "*"
+      ]
+    }
   },
-  "include": [
-    "./**/*.ts"
+  "exclude": [
+    "esm/*",
+    "build/*",
+    "node_modules/*",
+    "lib/*"
   ]
 }

package/tsconfig.types.json

@@ -0,0 +1,18 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "rootDir": ".",
+    "outDir": "types",
+    "declaration": true,
+    "declarationMap": false,
+    "isolatedModules": false,
+    "noEmit": false,
+    "allowJs": false,
+    "emitDeclarationOnly": true
+  },
+  "exclude": [
+    "__tests__/**/*",
+    "**/*.test.ts"
+  ]
+}

package/types/adaptors/axios.d.ts

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

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

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

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,39 @@
+import { IRequestHandler, RequestProxyResult } from '../interfaces/request';
+import { PaginateResult } from '../models/base';
+import { HTTPClient } from '../core';
+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): 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" | "title" | "slug" | "modified" | "created">[];
+    } & {
+        $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 unknown ? {
+                type: CategoryType;
+                count: number;
+                slug: string;
+                name: string;
+                created: string;
+                id: string;
+                children: Pick<PostModel, "id" | "title" | "slug" | "modified" | "created">[];
+            } : ResponseWrapper extends unknown ? {
+                [key: string]: any;
+                data: CategoryWithChildrenModel;
+            } : ResponseWrapper extends {
+                data: CategoryWithChildrenModel;
+            } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+                data: CategoryWithChildrenModel;
+            };
+        } : 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 unknown ? {
+                tag: string;
+                data: Pick<PostModel, "id" | "title" | "slug" | "created" | "category">[];
+            } : 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'>[];
+                };
+            };
+        } : 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,16 @@
+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 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 SnippetController | typeof UserController)[];
+export declare const allContollerNames: readonly ["aggregate", "category", "comment", "link", "note", "page", "post", "project", "recently", "say", "search", "snippet", "user", "friend", "master", "shorthand"];
+export { AggregateController, CategoryController, CommentController, LinkController, NoteController, PageController, PostController, ProjectController, RecentlyController, SayController, SearchController, SnippetController, UserController, };

package/types/controllers/link.d.ts

@@ -0,0 +1,16 @@
+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);
+    name: string[];
+    base: string;
+}

package/types/controllers/note.d.ts

@@ -0,0 +1,94 @@
+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 { NoteModel, NoteWrappedPayload } from '../models/note';
+import { HTTPClient } from '../core/client';
+declare module '../core/client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        note: NoteController<ResponseWrapper>;
+    }
+}
+export declare 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(): import("../interfaces/request").RequestProxyResult<NoteWrappedPayload, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: NoteWrappedPayload;
+    } : ResponseWrapper extends {
+        data: NoteWrappedPayload;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: NoteWrappedPayload;
+    }>;
+    /**
+     * 获取一篇日记
+     * @param id id | nid
+     * @param password 访问密码
+     */
+    getNoteById(id: string | number, password?: string): import("../interfaces/request").RequestProxyResult<NoteWrappedPayload, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: NoteWrappedPayload;
+    } : ResponseWrapper extends {
+        data: NoteWrappedPayload;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: NoteWrappedPayload;
+    }>;
+    /**
+     * 日记列表分页
+     */
+    getList(page?: number, perPage?: number, options?: NoteListOptions): import("../interfaces/request").RequestProxyResult<PaginateResult<NoteModel>, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: PaginateResult<NoteModel>;
+    } : ResponseWrapper extends {
+        data: PaginateResult<NoteModel>;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: PaginateResult<NoteModel>;
+    }>;
+    /**
+     * 获取当前日记的上下各 n / 2 篇日记
+     */
+    getMiddleList(id: string, size?: number): import("../interfaces/request").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;
+        };
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: {
+            data: Pick<NoteModel, 'id' | 'title' | 'nid' | 'created'>[];
+            size: number;
+        };
+    }>;
+    /**
+     * 喜欢这篇日记
+     */
+    likeIt(id: string | number): import("../interfaces/request").RequestProxyResult<never, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: never;
+    } : ResponseWrapper extends {
+        data: never;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: never;
+    }>;
+}

package/types/controllers/page.d.ts

@@ -0,0 +1,59 @@
+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 { HTTPClient } from '../core';
+declare module '../core/client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        page: PageController<ResponseWrapper>;
+    }
+}
+export declare type PageListOptions = {
+    select?: SelectFields<keyof PageModel>;
+    sortBy?: 'order' | 'subtitle' | 'title' | 'created' | 'modified';
+    sortOrder?: 1 | -1;
+};
+export declare class PageController<ResponseWrapper> implements IController {
+    private readonly client;
+    constructor(client: HTTPClient);
+    base: string;
+    name: string;
+    get proxy(): IRequestHandler<ResponseWrapper>;
+    /**
+     * 页面列表
+     */
+    getList(page?: number, perPage?: number, options?: PageListOptions): import("../interfaces/request").RequestProxyResult<PaginateResult<PageModel>, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: PaginateResult<PageModel>;
+    } : ResponseWrapper extends {
+        data: PaginateResult<PageModel>;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: PaginateResult<PageModel>;
+    }>;
+    /**
+     * 页面详情
+     */
+    getById(id: string): import("../interfaces/request").RequestProxyResult<PageModel, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: PageModel;
+    } : ResponseWrapper extends {
+        data: PageModel;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: PageModel;
+    }>;
+    /**
+     * 根据路径获取页面
+     * @param slug 路径
+     * @returns
+     */
+    getBySlug(slug: string): import("../interfaces/request").RequestProxyResult<PageModel, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: PageModel;
+    } : ResponseWrapper extends {
+        data: PageModel;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: PageModel;
+    }>;
+}