@mx-space/api-client 0.7.0-alpha.1 → 0.7.2

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;
+    }>;
+}

package/types/controllers/post.d.ts

@@ -0,0 +1,72 @@
+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 { PostModel } from '../models/post';
+import { HTTPClient } from '../core/client';
+declare module '../core/client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        post: PostController<ResponseWrapper>;
+    }
+}
+export declare type PostListOptions = {
+    select?: SelectFields<keyof PostModel>;
+    year?: number;
+    sortBy?: 'categoryId' | 'title' | 'created' | 'modified';
+    sortOrder?: 1 | -1;
+};
+export declare class PostController<ResponseWrapper> implements IController {
+    private client;
+    constructor(client: HTTPClient);
+    base: string;
+    name: string;
+    get proxy(): IRequestHandler<ResponseWrapper>;
+    /**
+     * 获取文章列表分页
+     * @param page
+     * @param perPage
+     * @returns
+     */
+    getList(page?: number, perPage?: number, options?: PostListOptions): RequestProxyResult<PaginateResult<PostModel>, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: PaginateResult<PostModel>;
+    } : ResponseWrapper extends {
+        data: PaginateResult<PostModel>;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: PaginateResult<PostModel>;
+    }>;
+    /**
+     * 根据分类和路径查找文章
+     * @param categoryName
+     * @param slug
+     */
+    getPost(categoryName: string, slug: string): RequestProxyResult<PostModel, ResponseWrapper>;
+    /**
+     * 根据 ID 查找文章
+     * @param id
+     */
+    getPost(id: string): RequestProxyResult<PostModel, ResponseWrapper>;
+    /**
+     * 获取最新的文章
+     */
+    getLatest(): RequestProxyResult<PostModel, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: PostModel;
+    } : ResponseWrapper extends {
+        data: PostModel;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: PostModel;
+    }>;
+    /**
+     * 点赞
+     */
+    thumbsUp(id: string): RequestProxyResult<void, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: void;
+    } : ResponseWrapper extends {
+        data: void;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: void;
+    }>;
+}

package/types/controllers/project.d.ts

@@ -0,0 +1,15 @@
+import { IRequestAdapter } from '../interfaces/adapter';
+import { ProjectModel } from '../models/project';
+import { HTTPClient } from '../core';
+import { BaseCrudController } from './base';
+declare module '../core/client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        project: ProjectController<ResponseWrapper>;
+    }
+}
+export declare class ProjectController<ResponseWrapper> extends BaseCrudController<ProjectModel, ResponseWrapper> {
+    protected readonly client: HTTPClient;
+    constructor(client: HTTPClient);
+    base: string;
+    name: string;
+}

package/types/controllers/recently.d.ts

@@ -0,0 +1,61 @@
+import { IRequestAdapter } from '../interfaces/adapter';
+import { IController } from '../interfaces/controller';
+import { IRequestHandler } from '../interfaces/request';
+import { RecentlyModel } from '../models/recently';
+import { HTTPClient } from '../core';
+declare module '../core/client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        recently: RecentlyController<ResponseWrapper>;
+        shorthand: RecentlyController<ResponseWrapper>;
+    }
+}
+export declare class RecentlyController<ResponseWrapper> implements IController {
+    private readonly client;
+    base: string;
+    name: string[];
+    constructor(client: HTTPClient);
+    get proxy(): IRequestHandler<ResponseWrapper>;
+    /**
+     * 获取最新一条
+     */
+    getLatestOne(): import("../interfaces/request").RequestProxyResult<RecentlyModel, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: RecentlyModel;
+    } : ResponseWrapper extends {
+        data: RecentlyModel;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: RecentlyModel;
+    }>;
+    getAll(): import("../interfaces/request").RequestProxyResult<{
+        data: RecentlyModel[];
+    }, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: {
+            data: RecentlyModel[];
+        };
+    } : ResponseWrapper extends {
+        data: {
+            data: RecentlyModel[];
+        };
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: {
+            data: RecentlyModel[];
+        };
+    }>;
+    getList(before?: string | undefined, after?: string | undefined, size?: number | number): import("../interfaces/request").RequestProxyResult<{
+        data: RecentlyModel[];
+    }, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: {
+            data: RecentlyModel[];
+        };
+    } : ResponseWrapper extends {
+        data: {
+            data: RecentlyModel[];
+        };
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: {
+            data: RecentlyModel[];
+        };
+    }>;
+}

package/types/controllers/say.d.ts

@@ -0,0 +1,37 @@
+import { IRequestAdapter } from '../interfaces/adapter';
+import { IController } from '../interfaces/controller';
+import { IRequestHandler } from '../interfaces/request';
+import { SayModel } from '../models/say';
+import { HTTPClient } from '../core';
+import { BaseCrudController } from './base';
+declare module '../core/client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        say: SayController<ResponseWrapper>;
+    }
+}
+export declare class SayController<ResponseWrapper> extends BaseCrudController<SayModel, ResponseWrapper> implements IController {
+    protected client: HTTPClient;
+    base: string;
+    name: string;
+    constructor(client: HTTPClient);
+    get proxy(): IRequestHandler<ResponseWrapper>;
+    /**
+     * 获取随机一条
+     */
+    getRandom(): import("../interfaces/request").RequestProxyResult<{
+        data: SayModel | null;
+    }, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: {
+            data: SayModel | null;
+        };
+    } : ResponseWrapper extends {
+        data: {
+            data: SayModel | null;
+        };
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: {
+            data: SayModel | null;
+        };
+    }>;
+}

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/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<T = unknown>(id: string): import("../interfaces/request").RequestProxyResult<SnippetModel<T>, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: SnippetModel<T>;
+    } : ResponseWrapper extends {
+        data: SnippetModel<T>;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: SnippetModel<T>;
+    }>;
+    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;
+    }>;
+}