@mx-space/api-client 1.0.0 → 1.0.1

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 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

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

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

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

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

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

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

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

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

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

package/types/models/setting.d.ts

@@ -0,0 +1,66 @@
+export declare class SeoOptionModel {
+    title: string;
+    description: string;
+    icon?: string;
+    keywords?: string[];
+}
+export declare class UrlOptionModel {
+    webUrl: string;
+    adminUrl: string;
+    serverUrl: string;
+    wsUrl: string;
+}
+declare class MailOptionModel {
+    port: number;
+    host: string;
+}
+export declare class MailOptionsModel {
+    enable: boolean;
+    user: string;
+    pass: string;
+    options?: MailOptionModel;
+}
+export declare class CommentOptionsModel {
+    antiSpam: boolean;
+    spamKeywords?: string[];
+    blockIps?: string[];
+    disableNoChinese?: boolean;
+}
+export declare class BackupOptionsModel {
+    enable: boolean;
+    secretId?: string;
+    secretKey?: string;
+    bucket?: string;
+    region: string;
+}
+export declare class BaiduSearchOptionsModel {
+    enable: boolean;
+    token?: string;
+}
+export declare class AlgoliaSearchOptionsModel {
+    enable: boolean;
+    apiKey?: string;
+    appId?: string;
+    indexName?: string;
+}
+export declare class AdminExtraModel {
+    background?: string;
+    gaodemapKey?: string;
+    title?: string;
+    /**
+     * 是否开启后台反代访问
+     */
+    enableAdminProxy?: boolean;
+}
+export interface IConfig {
+    seo: SeoOptionModel;
+    url: UrlOptionModel;
+    mailOptions: MailOptionsModel;
+    commentOptions: CommentOptionsModel;
+    backupOptions: BackupOptionsModel;
+    baiduSearchOptions: BaiduSearchOptionsModel;
+    algoliaSearchOptions: AlgoliaSearchOptionsModel;
+    adminExtra: AdminExtraModel;
+}
+export declare type IConfigKeys = keyof IConfig;
+export {};

package/types/models/snippet.d.ts

@@ -0,0 +1,18 @@
+import { BaseModel } from './base';
+export declare enum SnippetType {
+    JSON = "json",
+    Function = "function",
+    Text = "text",
+    YAML = "yaml"
+}
+export interface SnippetModel<T = unknown> extends BaseModel {
+    type: SnippetType;
+    private: boolean;
+    raw: string;
+    name: string;
+    reference: string;
+    comment?: string;
+    metatype?: string;
+    schema?: string;
+    data: T;
+}

package/types/models/topic.d.ts

@@ -0,0 +1,8 @@
+import { BaseModel } from './base';
+export interface TopicModel extends BaseModel {
+    description?: string;
+    introduce: string;
+    name: string;
+    slug: string;
+    icon?: string;
+}

package/types/models/user.d.ts

@@ -0,0 +1,21 @@
+import { BaseModel } from './base';
+export interface UserModel extends BaseModel {
+    introduce: string;
+    mail: string;
+    url: string;
+    name: string;
+    socialIds: Record<string, string>;
+    username: string;
+    modified: string;
+    v: number;
+    lastLoginTime: string;
+    lastLoginIp?: string;
+    avatar: string;
+    postID: string;
+}
+export type TLogin = {
+    token: string;
+    expiresIn: number;
+    lastLoginTime: null | string;
+    lastLoginIp?: null | string;
+} & Pick<UserModel, 'name' | 'username' | 'created' | 'url' | 'mail' | 'avatar' | 'id'>;

package/types/utils/auto-bind.d.ts

@@ -0,0 +1,4 @@
+export declare function autoBind(self: any, { include, exclude }?: {
+    include: any;
+    exclude: any;
+}): any;

package/types/utils/camelcase-keys.d.ts

@@ -0,0 +1,6 @@
+/**
+ * A simple camelCase function that only handles strings, but not handling symbol, date, or other complex case.
+ * If you need to handle more complex cases, please use camelcase-keys package.
+ */
+export declare const camelcaseKeys: <T = any>(obj: any) => T;
+export declare function camelcase(str: string): string;

package/types/utils/index.d.ts

@@ -0,0 +1,5 @@
+import { SortOrder } from '../interfaces/options';
+export declare const isPlainObject: (obj: any) => any;
+export declare const sortOrderToNumber: (order: SortOrder) => number;
+export declare const destructureData: (payload: any) => any;
+export declare const attachRawFromOneToAnthor: (from: any, to: any) => void;

package/types/utils/path.d.ts

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

package/types/vitest.config.d.ts

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

package/__tests__/adaptors/axios.spec.ts

@@ -1,7 +0,0 @@
-import { axiosAdaptor } from '~/adaptors/axios'
-
-import { testAdaptor } from '../helpers/adaptor-test'
-
-describe('test axios adaptor', () => {
-  testAdaptor(axiosAdaptor)
-})

package/__tests__/adaptors/ky.spec.ts

@@ -1,9 +0,0 @@
-import '../helpers/global-fetch'
-
-import { defaultKyAdaptor } from '~/adaptors/ky'
-
-import { testAdaptor } from '../helpers/adaptor-test'
-
-describe('test ky adaptor', () => {
-  testAdaptor(defaultKyAdaptor)
-})

package/__tests__/adaptors/umi-request.spec.ts

@@ -1,7 +0,0 @@
-import { umiAdaptor } from '~/adaptors/umi-request'
-
-import { testAdaptor } from '../helpers/adaptor-test'
-
-describe('test umi-request adaptor', () => {
-  testAdaptor(umiAdaptor)
-})