@mx-space/api-client 0.6.3 → 0.7.1

package/models/link.ts

@@ -0,0 +1,23 @@
+import { BaseModel } from './base'
+
+export enum LinkType {
+  Friend,
+  Collection,
+}
+
+export enum LinkState {
+  Pass,
+  Audit,
+  Outdate,
+  Banned,
+}
+
+export interface LinkModel extends BaseModel {
+  name: string
+  url: string
+  avatar: string
+  description?: string
+  type: LinkType
+  state: LinkState
+  hide: boolean
+}

package/models/note.ts

@@ -0,0 +1,37 @@
+import { TextBaseModel } from './base'
+
+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
+}
+
+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>
+}

package/models/page.ts

@@ -0,0 +1,20 @@
+import { TextBaseModel } from './base'
+
+export 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/models/post.ts

@@ -0,0 +1,16 @@
+import { Count, Image, TextBaseModel } from './base'
+import { CategoryModel } from './category'
+
+export interface PostModel extends TextBaseModel {
+  summary?: string
+  hide: boolean
+  copyright: boolean
+  tags: string[]
+  count: Count
+  text: string
+  title: string
+  slug: string
+  categoryId: string
+  images: Image[]
+  category: CategoryModel
+}

package/models/project.ts

@@ -0,0 +1,12 @@
+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/models/recently.ts

@@ -0,0 +1,7 @@
+import { BaseModel } from './base'
+
+export interface RecentlyModel extends BaseModel {
+  content: string
+  project?: string
+  language?: string
+}

package/models/say.ts

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

package/models/setting.ts

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

package/models/snippet.ts

@@ -0,0 +1,18 @@
+import { BaseModel } from './base'
+export 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
+
+  data: T
+}

package/models/user.ts

@@ -0,0 +1,27 @@
+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/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@mx-space/api-client",
-  "version": "0.6.3",
+  "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": "build/index.d.ts",
+  "types": "types/index.d.ts",
   "unpkg": "build/index.umd.min.js",
   "husky": {
     "hooks": {
@@ -29,70 +29,36 @@
       "eslint --cache"
     ]
   },
-  "files": [
-    "build",
-    "lib",
-    "esm",
-    "readme.md",
-    "tsconfig.json"
-  ],
   "engines": {
     "pnpm": ">=6"
   },
   "scripts": {
-    "prepare": "husky install",
-    "predeploy": "rm -rf dist",
-    "prebuild": "rm -rf rm -rf lib && rm -rf esm",
-    "build": "ttsc --build src/tsconfig.build.json && ttsc --build src/tsconfig.cjs.json",
+    "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 && 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",
-    "postpackage": "dts-bundle-generator -o build/index.d.ts src/index.ts --project tsconfig.json  --no-check",
     "prepackage": "rm -rf build",
     "release": "vv",
-    "dev": "vite",
-    "build:vite": "vite build",
-    "preview": "vite preview --port 2323",
-    "deploy": "vite build && gh-pages -d dist",
     "test": "jest --env=jsdom --colors --coverage test",
-    "test:watch": "jest --env=jsdom --colors --coverage test --watch -i --detectOpenHandles"
+    "test:watch": "jest --env=jsdom --colors --coverage test --watch -i --detectOpenHandles",
+    "version": "vv"
   },
   "devDependencies": {
-    "@innei-util/eslint-config-ts": "latest",
-    "@innei-util/prettier": "latest",
-    "@innei/bump-version": "0.2.2",
     "@rollup/plugin-commonjs": "21.0.1",
     "@rollup/plugin-node-resolve": "13.1.3",
     "@rollup/plugin-typescript": "8.3.0",
-    "@types/express": "4.17.13",
     "@types/jest": "27.4.0",
     "@types/lodash": "4.14.178",
     "@types/node": "16.11.22",
-    "@types/react": "17.0.39",
-    "@types/react-dom": "17.0.11",
-    "@zerollup/ts-transform-paths": "1.7.18",
     "axios": "0.25.0",
-    "cors": "2.8.5",
-    "dts-bundle-generator": "6.4.0",
-    "esbuild": "0.14.18",
-    "express": "4.17.2",
     "gh-pages": "3.2.3",
-    "husky": "7.0.4",
-    "jest": "27.5.0",
-    "lint-staged": "12.2.2",
     "lodash": "4.17.21",
-    "prettier": "2.5.1",
-    "react": "18.0.0-rc.0-next-fe905f152-20220107",
-    "react-dom": "18.0.0-rc.0-next-fe905f152-20220107",
-    "react-json-view": "1.21.3",
     "rollup": "2.66.1",
     "rollup-plugin-peer-deps-external": "2.2.4",
     "rollup-plugin-terser": "7.0.2",
-    "ts-jest": "27.1.3",
-    "tslib": "2.3.1",
-    "ttypescript": "1.5.13",
-    "typescript": "4.4.4",
-    "umi-request": "1.4.0",
-    "vite": "2.7.13",
-    "vite-tsconfig-paths": "3.3.17"
+    "tsconfig-replace-paths": "0.0.11",
+    "umi-request": "1.4.0"
   },
   "dependencies": {
     "camelcase-keys": "7.0.2"

package/tsconfig.build.json

@@ -0,0 +1,6 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": [
+    "__tests__/**/*.ts"
+  ]
+}

package/tsconfig.cjs.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.build.json",
+  "compilerOptions": {
+    "module": "CommonJS",
+    "outDir": "./lib"
+  }
+}

package/tsconfig.json

@@ -1,6 +1,10 @@
 {
   "compilerOptions": {
-    "target": "ES2017",
+    "declaration": true,
+    "outDir": "./esm",
+    "baseUrl": ".",
+    "jsx": "react",
+    "target": "ES2020",
     "lib": [
       "ESNext",
       "DOM",
@@ -14,18 +18,16 @@
     "skipLibCheck": true,
     "forceConsistentCasingInFileNames": true,
     "sourceMap": true,
-    "declaration": true,
-    "outDir": "./dist",
-    "baseUrl": "./src",
     "paths": {
       "~/*": [
         "*"
       ]
-    },
-    "plugins": [
-      {
-        "transform": "@zerollup/ts-transform-paths",
-      }
-    ]
-  }
+    }
+  },
+  "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;
+        };
+    }>;
+}