@mx-space/api-client 0.7.0 → 0.7.3

package/types/controllers/search.d.ts

@@ -0,0 +1,247 @@
+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 { PageModel } from '..';
+import { HTTPClient } from '../core';
+declare module '../core/client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        search: SearchController<ResponseWrapper>;
+    }
+}
+export declare type SearchType = 'post' | 'note';
+export declare type SearchOption = {
+    orderBy?: string;
+    order?: number;
+    rawAlgolia?: boolean;
+};
+export declare class SearchController<ResponseWrapper> implements IController {
+    private readonly client;
+    base: string;
+    name: string;
+    constructor(client: HTTPClient);
+    get proxy(): IRequestHandler<ResponseWrapper>;
+    search(type: 'note', keyword: string, options?: Omit<SearchOption, 'rawAlgolia'>): Promise<RequestProxyResult<PaginateResult<Pick<NoteModel, 'modified' | 'id' | 'title' | 'created' | 'nid'>>, ResponseWrapper>>;
+    search(type: 'post', keyword: string, options?: Omit<SearchOption, 'rawAlgolia'>): Promise<RequestProxyResult<PaginateResult<Pick<PostModel, 'modified' | 'id' | 'title' | 'created' | 'slug' | 'category'>>, ResponseWrapper>>;
+    /**
+     * 从 algolya 搜索
+     * https://www.algolia.com/doc/api-reference/api-methods/search/
+     * @param keyword
+     * @param options
+     * @returns
+     */
+    searchByAlgolia(keyword: string, options?: SearchOption): RequestProxyResult<RequestProxyResult<PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
+        type: 'post';
+    }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
+        type: 'note';
+    }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
+        type: 'page';
+    })> & {
+        /**
+         * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
+         */
+        raw?: any;
+    }, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
+            type: 'post';
+        }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
+            type: 'note';
+        }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
+            type: 'page';
+        })> & {
+            /**
+             * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
+             */
+            raw?: any;
+        };
+    } : ResponseWrapper extends {
+        data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
+            type: 'post';
+        }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
+            type: 'note';
+        }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
+            type: 'page';
+        })> & {
+            /**
+             * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
+             */
+            raw?: any;
+        };
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
+            type: 'post';
+        }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
+            type: 'note';
+        }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
+            type: 'page';
+        })> & {
+            /**
+             * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
+             */
+            raw?: any;
+        };
+    }>, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: RequestProxyResult<PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
+            type: 'post';
+        }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
+            type: 'note';
+        }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
+            type: 'page';
+        })> & {
+            /**
+             * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
+             */
+            raw?: any;
+        }, ResponseWrapper, ResponseWrapper extends unknown ? {
+            [key: string]: any;
+            data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
+                type: 'post';
+            }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
+                type: 'note';
+            }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
+                type: 'page';
+            })> & {
+                /**
+                 * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
+                 */
+                raw?: any;
+            };
+        } : ResponseWrapper extends {
+            data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
+                type: 'post';
+            }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
+                type: 'note';
+            }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
+                type: 'page';
+            })> & {
+                /**
+                 * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
+                 */
+                raw?: any;
+            };
+        } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+            data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
+                type: 'post';
+            }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
+                type: 'note';
+            }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
+                type: 'page';
+            })> & {
+                /**
+                 * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
+                 */
+                raw?: any;
+            };
+        }>;
+    } : ResponseWrapper extends {
+        data: RequestProxyResult<PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
+            type: 'post';
+        }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
+            type: 'note';
+        }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
+            type: 'page';
+        })> & {
+            /**
+             * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
+             */
+            raw?: any;
+        }, ResponseWrapper, ResponseWrapper extends unknown ? {
+            [key: string]: any;
+            data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
+                type: 'post';
+            }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
+                type: 'note';
+            }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
+                type: 'page';
+            })> & {
+                /**
+                 * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
+                 */
+                raw?: any;
+            };
+        } : ResponseWrapper extends {
+            data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
+                type: 'post';
+            }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
+                type: 'note';
+            }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
+                type: 'page';
+            })> & {
+                /**
+                 * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
+                 */
+                raw?: any;
+            };
+        } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+            data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
+                type: 'post';
+            }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
+                type: 'note';
+            }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
+                type: 'page';
+            })> & {
+                /**
+                 * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
+                 */
+                raw?: any;
+            };
+        }>;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: RequestProxyResult<PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
+            type: 'post';
+        }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
+            type: 'note';
+        }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
+            type: 'page';
+        })> & {
+            /**
+             * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
+             */
+            raw?: any;
+        }, ResponseWrapper, ResponseWrapper extends unknown ? {
+            [key: string]: any;
+            data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
+                type: 'post';
+            }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
+                type: 'note';
+            }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
+                type: 'page';
+            })> & {
+                /**
+                 * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
+                 */
+                raw?: any;
+            };
+        } : ResponseWrapper extends {
+            data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
+                type: 'post';
+            }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
+                type: 'note';
+            }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
+                type: 'page';
+            })> & {
+                /**
+                 * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
+                 */
+                raw?: any;
+            };
+        } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+            data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
+                type: 'post';
+            }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
+                type: 'note';
+            }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
+                type: 'page';
+            })> & {
+                /**
+                 * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
+                 */
+                raw?: any;
+            };
+        }>;
+    }>;
+}

package/types/controllers/severless.d.ts

@@ -0,0 +1,24 @@
+import { IRequestAdapter } from '../interfaces/adapter';
+import { IController } from '../interfaces/controller';
+import { IRequestHandler } from '../interfaces/request';
+import { HTTPClient } from '../core';
+declare module '../core/client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        serverless: ServerlessController<ResponseWrapper>;
+    }
+}
+export declare class ServerlessController<ResponseWrapper> implements IController {
+    protected client: HTTPClient;
+    base: string;
+    name: string;
+    constructor(client: HTTPClient);
+    get proxy(): IRequestHandler<ResponseWrapper>;
+    getByReferenceAndName<T = unknown>(reference: string, name: string): import("../interfaces/request").RequestProxyResult<T, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: T;
+    } : ResponseWrapper extends {
+        data: T;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: T;
+    }>;
+}

package/types/controllers/snippet.d.ts

@@ -0,0 +1,33 @@
+import { IRequestAdapter } from '../interfaces/adapter';
+import { IController } from '../interfaces/controller';
+import { IRequestHandler } from '../interfaces/request';
+import { SnippetModel } from '../models/snippet';
+import { HTTPClient } from '../core';
+declare module '../core/client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        snippet: SnippetController<ResponseWrapper>;
+    }
+}
+export declare class SnippetController<ResponseWrapper> implements IController {
+    protected client: HTTPClient;
+    base: string;
+    name: string;
+    constructor(client: HTTPClient);
+    get proxy(): IRequestHandler<ResponseWrapper>;
+    getById(id: string): import("../interfaces/request").RequestProxyResult<Omit<SnippetModel<unknown>, "data">, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: Omit<SnippetModel<unknown>, "data">;
+    } : ResponseWrapper extends {
+        data: Omit<SnippetModel<unknown>, "data">;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: Omit<SnippetModel<unknown>, "data">;
+    }>;
+    getByReferenceAndName<T = unknown>(reference: string, name: string): import("../interfaces/request").RequestProxyResult<T, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: T;
+    } : ResponseWrapper extends {
+        data: T;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: T;
+    }>;
+}

package/types/controllers/user.d.ts

@@ -0,0 +1,54 @@
+import { IRequestAdapter } from '../interfaces/adapter';
+import { IController } from '../interfaces/controller';
+import { IRequestHandler } from '../interfaces/request';
+import { TLogin, UserModel } from '../models/user';
+import { HTTPClient } from '../core';
+declare module '../core/client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        user: UserController<ResponseWrapper>;
+        master: UserController<ResponseWrapper>;
+    }
+}
+export declare class UserController<ResponseWrapper> implements IController {
+    private readonly client;
+    constructor(client: HTTPClient);
+    base: string;
+    name: string[];
+    get proxy(): IRequestHandler<ResponseWrapper>;
+    getMasterInfo(): import("../interfaces/request").RequestProxyResult<UserModel, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: UserModel;
+    } : ResponseWrapper extends {
+        data: UserModel;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: UserModel;
+    }>;
+    login(username: string, password: string): import("../interfaces/request").RequestProxyResult<TLogin, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: TLogin;
+    } : ResponseWrapper extends {
+        data: TLogin;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: TLogin;
+    }>;
+    checkTokenValid(token: string): import("../interfaces/request").RequestProxyResult<{
+        ok: number;
+        isGuest: boolean;
+    }, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: {
+            ok: number;
+            isGuest: boolean;
+        };
+    } : ResponseWrapper extends {
+        data: {
+            ok: number;
+            isGuest: boolean;
+        };
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: {
+            ok: number;
+            isGuest: boolean;
+        };
+    }>;
+}

package/types/core/attach-request.d.ts

@@ -0,0 +1,2 @@
+import type { HTTPClient } from '.';
+export declare function attachRequestMethod<T extends HTTPClient<any, any>>(target: T): void;

package/types/core/client.d.ts

@@ -0,0 +1,29 @@
+import { IAdaptorRequestResponseType, IRequestAdapter } from '../interfaces/adapter';
+import { ClientOptions } from '../interfaces/client';
+import { IController } from '../interfaces/controller';
+import { IRequestHandler } from '../interfaces/request';
+import { Class } from '../interfaces/types';
+export type { HTTPClient };
+declare class HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+    private _endpoint;
+    private _adaptor;
+    private _proxy;
+    constructor(_endpoint: string, _adaptor: T);
+    private initGetClient;
+    injectControllers(...Controller: Class<IController>[]): void;
+    injectControllers(Controller: Class<IController>[]): void;
+    get endpoint(): string;
+    get instance(): T;
+    request(options: {
+        url: string;
+        method?: string;
+        data?: any;
+        params?: any;
+    }): Promise<IAdaptorRequestResponseType<any>>;
+    get proxy(): IRequestHandler<ResponseWrapper>;
+    private resolveFullPath;
+    private buildRoute;
+}
+export declare function createClient<T extends IRequestAdapter>(adapter: T): <ResponseWrapper = T extends {
+    responseWrapper: infer Type;
+} ? Type extends undefined ? unknown : Type : unknown>(endpoint: string, options?: ClientOptions | undefined) => HTTPClient<T, ResponseWrapper>;

package/types/core/error.d.ts

@@ -0,0 +1,6 @@
+export declare class RequestError extends Error {
+    status: number;
+    path: string;
+    raw: any;
+    constructor(message: string, status: number, path: string, raw: any);
+}

package/types/core/index.d.ts

@@ -0,0 +1,2 @@
+export * from './client';
+export * from './error';

package/types/dtos/comment.d.ts

@@ -0,0 +1,6 @@
+export declare class CommentDto {
+    author: string;
+    text: string;
+    mail: string;
+    url?: string;
+}

package/types/index.d.ts

@@ -0,0 +1,7 @@
+import _camelcaseKeys from 'camelcase-keys';
+export * from './controllers';
+export { createClient, RequestError } from './core';
+export type { HTTPClient } from './core';
+export * from './models';
+export declare const camelcaseKeysDeep: <T>(obj: T) => T;
+export declare const camelcaseKeys: typeof _camelcaseKeys;

package/types/interfaces/adapter.d.ts

@@ -0,0 +1,14 @@
+import { RequestOptions } from './instance';
+export declare type IAdaptorRequestResponseType<P> = Promise<Record<string, any> & {
+    data: P;
+}>;
+export declare type IRequestAdapter<T = any, Response = undefined> = Readonly<(Response extends undefined ? {} : {
+    responseWrapper: Response;
+}) & {
+    default: T;
+    get<P = unknown>(url: string, options?: Omit<RequestOptions, 'data'>): IAdaptorRequestResponseType<P>;
+    post<P = unknown>(url: string, options: Partial<RequestOptions>): IAdaptorRequestResponseType<P>;
+    patch<P = unknown>(url: string, options: Partial<RequestOptions>): IAdaptorRequestResponseType<P>;
+    delete<P = unknown>(url: string, options?: Omit<RequestOptions, 'data'>): IAdaptorRequestResponseType<P>;
+    put<P = unknown>(url: string, options: Partial<RequestOptions>): IAdaptorRequestResponseType<P>;
+}>;

package/types/interfaces/client.d.ts

@@ -0,0 +1,5 @@
+import { IController } from './controller';
+import { Class } from './types';
+export declare type ClientOptions = {
+    controllers?: Class<IController>[];
+};

package/types/interfaces/controller.d.ts

@@ -0,0 +1,4 @@
+export interface IController {
+    base: string;
+    name: string | string[];
+}

package/types/interfaces/instance.d.ts

@@ -0,0 +1,7 @@
+export interface RequestOptions {
+    method?: string;
+    data?: Record<string, any>;
+    params?: Record<string, any> | URLSearchParams;
+    headers?: Record<string, string>;
+    [key: string]: any;
+}

package/types/interfaces/options.d.ts

@@ -0,0 +1 @@
+export declare type SortOrder = 'asc' | 'desc';

package/types/interfaces/params.d.ts

@@ -0,0 +1,4 @@
+export interface PaginationParams {
+    size?: number;
+    page?: number;
+}

package/types/interfaces/request.d.ts

@@ -0,0 +1,43 @@
+import type { RequestOptions } from './instance';
+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<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, ResponseWrapper, R = ResponseWrapper extends unknown ? {
+    data: T;
+    [key: string]: any;
+} : 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];
+};
+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;
+    $request: {
+        path: string;
+        method: string;
+        [k: string]: string;
+    };
+};
+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/types/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/types/models/aggregate.d.ts

@@ -0,0 +1,53 @@
+import { CategoryModel } from './category';
+import { NoteModel } from './note';
+import { PageModel } from './page';
+import { PostModel } from './post';
+import { SayModel } from './say';
+import { SeoOptionModel } from './setting';
+import { UserModel } from './user';
+export interface AggregateRoot {
+    user: UserModel;
+    seo: SeoOptionModel;
+    url: Url;
+    categories: CategoryModel[];
+    pageMeta: Pick<PageModel, 'title' | 'id' | 'slug' | 'order'>[] | null;
+}
+export interface Url {
+    wsUrl: string;
+    serverUrl: string;
+    webUrl: string;
+}
+export interface AggregateTop {
+    notes: Pick<NoteModel, 'id' | 'title' | 'created' | 'nid'>[];
+    posts: Pick<PostModel, 'id' | 'slug' | 'created' | 'title' | 'category'>[];
+    says: SayModel[];
+}
+export declare enum TimelineType {
+    Post = 0,
+    Note = 1
+}
+export interface TimelineData {
+    notes?: Pick<NoteModel, 'id' | 'nid' | 'title' | 'weather' | 'mood' | 'created' | 'modified' | 'hasMemory'>[];
+    posts?: (Pick<PostModel, 'id' | 'title' | 'slug' | 'created' | 'modified' | 'category'> & {
+        url: string;
+    })[];
+}
+export interface AggregateStat {
+    allComments: number;
+    categories: number;
+    comments: number;
+    linkApply: number;
+    links: number;
+    notes: number;
+    pages: number;
+    posts: number;
+    says: number;
+    recently: number;
+    unreadComments: number;
+    online: number;
+    todayMaxOnline: string;
+    todayOnlineTotal: string;
+    callTime: number;
+    uv: number;
+    todayIPAccessCount: number;
+}

package/types/models/base.d.ts

@@ -0,0 +1,37 @@
+export interface Count {
+    read: number;
+    like: number;
+}
+export interface Image {
+    height: number;
+    width: number;
+    type: string;
+    accent?: string;
+    src: string;
+}
+export interface Pager {
+    total: number;
+    size: number;
+    currentPage: number;
+    totalPage: number;
+    hasPrevPage: boolean;
+    hasNextPage: boolean;
+}
+export interface PaginateResult<T> {
+    data: T[];
+    pagination: Pager;
+}
+export interface BaseModel {
+    created: string;
+    id: string;
+}
+export interface BaseCommentIndexModel extends BaseModel {
+    commentsIndex?: number;
+    allowComment: boolean;
+}
+export interface TextBaseModel extends BaseCommentIndexModel {
+    title: string;
+    text: string;
+    images?: Image[];
+    modified: string | null;
+}

package/types/models/category.d.ts

@@ -0,0 +1,22 @@
+import { BaseModel } from './base';
+import { PostModel } from './post';
+export declare enum CategoryType {
+    Category = 0,
+    Tag = 1
+}
+export interface CategoryModel extends BaseModel {
+    type: CategoryType;
+    count: number;
+    slug: string;
+    name: string;
+}
+export declare type CategoryWithChildrenModel = CategoryModel & {
+    children: Pick<PostModel, 'id' | 'title' | 'slug' | 'modified' | 'created'>[];
+};
+export declare type CategoryEntries = {
+    entries: Record<string, CategoryWithChildrenModel>;
+};
+export interface TagModel {
+    count: number;
+    name: string;
+}