@mx-space/api-client 1.0.3 → 1.2.0

package/types/controllers/severless.d.ts

@@ -1,24 +0,0 @@
-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

@@ -1,24 +0,0 @@
-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> {
-        snippet: SnippetController<ResponseWrapper>;
-    }
-}
-export declare class SnippetController<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/topic.d.ts

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

package/types/controllers/user.d.ts

@@ -1,70 +0,0 @@
-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;
-    }>;
-    loginWithToken(token?: string): import("../interfaces/request").RequestProxyResult<{
-        token: string;
-    }, ResponseWrapper, ResponseWrapper extends unknown ? {
-        [key: string]: any;
-        data: {
-            token: string;
-        };
-    } : ResponseWrapper extends {
-        data: {
-            token: string;
-        };
-    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
-        data: {
-            token: string;
-        };
-    }>;
-    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

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

package/types/core/client.d.ts

@@ -1,29 +0,0 @@
-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 readonly _endpoint;
-    private _adaptor;
-    private options;
-    private readonly _proxy;
-    constructor(_endpoint: string, _adaptor: T, options?: Omit<ClientOptions, 'controllers'>);
-    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 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) => HTTPClient<T, ResponseWrapper>;

package/types/core/error.d.ts

@@ -1,6 +0,0 @@
-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

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

package/types/dtos/comment.d.ts

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

package/types/index.d.ts

@@ -1,7 +0,0 @@
-import { createClient } from './core';
-export * from './controllers';
-export { createClient, RequestError } from './core';
-export type { HTTPClient } from './core';
-export * from './models';
-export { camelcaseKeys as simpleCamelcaseKeys } from './utils/camelcase-keys';
-export default createClient;

package/types/interfaces/client.d.ts

@@ -1,13 +0,0 @@
-import { IController } from './controller';
-import { Class } from './types';
-interface IClientOptions {
-    controllers: Class<IController>[];
-    getCodeMessageFromException: <T = Error>(error: T) => {
-        message?: string | undefined | null;
-        code?: number | undefined | null;
-    };
-    customThrowResponseError: <T extends Error = Error>(err: any) => T;
-    transformResponse: <T = any>(data: any) => T;
-}
-export type ClientOptions = Partial<IClientOptions>;
-export {};

package/types/interfaces/controller.d.ts

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

package/types/interfaces/instance.d.ts

@@ -1,7 +0,0 @@
-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

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

package/types/interfaces/params.d.ts

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

package/types/interfaces/request.d.ts

@@ -1,43 +0,0 @@
-import { RequestOptions } from './instance';
-type NoStringIndex<T> = {
-    [K in keyof T as string extends K ? never : K]: T[K];
-};
-export 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 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>>;
-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;
-type CamelKeysToSnake<T> = {
-    [K in keyof T as CamelToSnake<Extract<K, string>>]: T[K];
-};
-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 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

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

package/types/models/aggregate.d.ts

@@ -1,53 +0,0 @@
-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

@@ -1,41 +0,0 @@
-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;
-    meta?: Record<string, any>;
-}
-export type ModelWithLiked<T> = T & {
-    liked: boolean;
-};

package/types/models/category.d.ts

@@ -1,22 +0,0 @@
-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 type CategoryWithChildrenModel = CategoryModel & {
-    children: Pick<PostModel, 'id' | 'title' | 'slug' | 'modified' | 'created'>[];
-};
-export type CategoryEntries = {
-    entries: Record<string, CategoryWithChildrenModel>;
-};
-export interface TagModel {
-    count: number;
-    name: string;
-}

package/types/models/comment.d.ts

@@ -1,37 +0,0 @@
-import { BaseModel } from './base';
-import { CategoryModel } from './category';
-export declare enum RefType {
-    Page = "Page",
-    Post = "Post",
-    Note = "Note"
-}
-export interface CommentModel extends BaseModel {
-    refType: RefType;
-    ref: string;
-    state: number;
-    commentsIndex: number;
-    author: string;
-    text: string;
-    mail?: string;
-    url?: string;
-    ip?: string;
-    agent?: string;
-    key: string;
-    pin?: boolean;
-    avatar: string;
-    parent?: CommentModel | string;
-    children: CommentModel[];
-    isWhispers?: boolean;
-}
-export interface CommentRef {
-    id: string;
-    categoryId?: string;
-    slug: string;
-    title: string;
-    category?: CategoryModel;
-}
-export declare enum CommentState {
-    Unread = 0,
-    Read = 1,
-    Junk = 2
-}

package/types/models/index.d.ts

@@ -1,14 +0,0 @@
-export * from './aggregate';
-export * from './base';
-export * from './category';
-export * from './comment';
-export * from './link';
-export * from './note';
-export * from './page';
-export * from './post';
-export * from './project';
-export * from './recently';
-export * from './say';
-export * from './setting';
-export * from './snippet';
-export * from './user';

package/types/models/link.d.ts

@@ -1,22 +0,0 @@
-import { BaseModel } from './base';
-export declare enum LinkType {
-    Friend = 0,
-    Collection = 1
-}
-export declare enum LinkState {
-    Pass = 0,
-    Audit = 1,
-    Outdate = 2,
-    Banned = 3,
-    Reject = 4
-}
-export interface LinkModel extends BaseModel {
-    name: string;
-    url: string;
-    avatar: string;
-    description?: string;
-    type: LinkType;
-    state: LinkState;
-    hide: boolean;
-    email: string;
-}

package/types/models/note.d.ts

@@ -1,38 +0,0 @@
-import { ModelWithLiked, TextBaseModel } from './base';
-import { TopicModel } from './topic';
-export interface NoteModel extends TextBaseModel {
-    hide: boolean;
-    count: {
-        read: number;
-        like: number;
-    };
-    mood?: string;
-    weather?: string;
-    hasMemory?: boolean;
-    secret?: Date;
-    password?: string | null;
-    nid: number;
-    music?: NoteMusicRecord[];
-    location?: string;
-    coordinates?: Coordinate;
-    topic?: TopicModel;
-    topicId?: string;
-}
-export interface NoteMusicRecord {
-    type: string;
-    id: string;
-}
-export interface Coordinate {
-    latitude: number;
-    longitude: number;
-}
-export interface NoteWrappedPayload {
-    data: NoteModel;
-    next?: Partial<NoteModel>;
-    prev?: Partial<NoteModel>;
-}
-export interface NoteWrappedWithLikedPayload {
-    data: ModelWithLiked<NoteModel>;
-    next?: Partial<NoteModel>;
-    prev?: Partial<NoteModel>;
-}

package/types/models/page.d.ts

@@ -1,14 +0,0 @@
-import { TextBaseModel } from './base';
-export declare enum EnumPageType {
-    'md' = "md",
-    'html' = "html",
-    'frame' = "frame"
-}
-export interface PageModel extends TextBaseModel {
-    created: string;
-    slug: string;
-    subtitle?: string;
-    order?: number;
-    type?: EnumPageType;
-    options?: object;
-}

package/types/models/post.d.ts

@@ -1,17 +0,0 @@
-import { Count, Image, TextBaseModel } from './base';
-import { CategoryModel } from './category';
-export interface PostModel extends TextBaseModel {
-    summary?: string;
-    copyright: boolean;
-    tags: string[];
-    count: Count;
-    text: string;
-    title: string;
-    slug: string;
-    categoryId: string;
-    images: Image[];
-    category: CategoryModel;
-    pin?: string | null;
-    pinOrder?: number;
-    related?: Pick<PostModel, 'id' | 'category' | 'categoryId' | 'created' | 'modified' | 'title' | 'slug' | 'summary'>[];
-}

package/types/models/project.d.ts

@@ -1,11 +0,0 @@
-import { BaseModel } from './base';
-export interface ProjectModel extends BaseModel {
-    name: string;
-    previewUrl?: string;
-    docUrl?: string;
-    projectUrl?: string;
-    images?: string[];
-    description: string;
-    avatar?: string;
-    text: string;
-}

package/types/models/recently.d.ts

@@ -1,20 +0,0 @@
-import { BaseCommentIndexModel } from './base';
-export declare enum RecentlyRefTypes {
-    Post = "Post",
-    Note = "Note",
-    Page = "Page"
-}
-export type RecentlyRefType = {
-    title: string;
-    url: string;
-};
-export interface RecentlyModel extends BaseCommentIndexModel {
-    content: string;
-    ref?: RecentlyRefType & {
-        [key: string]: any;
-    };
-    refId?: string;
-    refType?: RecentlyRefTypes;
-    up: number;
-    down: number;
-}

package/types/models/say.d.ts

@@ -1,6 +0,0 @@
-import { BaseModel } from './base';
-export interface SayModel extends BaseModel {
-    text: string;
-    source?: string;
-    author?: string;
-}