Extraction schema (#398)

packages/support/openapi/auth.ts

@@ -0,0 +1,32 @@
+import { ERROR_ENUM } from '@fastgpt/common/constant/errorCode';
+import { updateApiKeyUsedTime } from './tools';
+import { MongoOpenApi } from './schema';
+import { POST } from '@fastgpt/common/plusApi/request';
+import { OpenApiSchema } from './type.d';
+
+export type AuthOpenApiLimitProps = { openApi: OpenApiSchema };
+
+export async function authOpenApiKey({ apikey }: { apikey: string }) {
+  if (!apikey) {
+    return Promise.reject(ERROR_ENUM.unAuthApiKey);
+  }
+
+  try {
+    const openApi = await MongoOpenApi.findOne({ apiKey: apikey });
+    if (!openApi) {
+      return Promise.reject(ERROR_ENUM.unAuthApiKey);
+    }
+    const userId = String(openApi.userId);
+
+    // auth limit
+    if (global.feConfigs?.isPlus) {
+      await POST('/support/openapi/authLimit', { openApi } as AuthOpenApiLimitProps);
+    }
+
+    updateApiKeyUsedTime(openApi._id);
+
+    return { apikey, userId, appId: openApi.appId };
+  } catch (error) {
+    return Promise.reject(error);
+  }
+}

packages/support/openapi/schema.ts

@@ -0,0 +1,59 @@
+import { connectionMongo, type Model } from '@fastgpt/common/mongo';
+const { Schema, model, models } = connectionMongo;
+import { OpenApiSchema } from './type.d';
+import { PRICE_SCALE } from '@fastgpt/common/bill/constants';
+import { formatPrice } from '@fastgpt/common/bill/index';
+
+const OpenApiSchema = new Schema(
+  {
+    userId: {
+      type: Schema.Types.ObjectId,
+      ref: 'user',
+      required: true
+    },
+    apiKey: {
+      type: String,
+      required: true,
+      get: (val: string) => `******${val.substring(val.length - 4)}`
+    },
+    createTime: {
+      type: Date,
+      default: () => new Date()
+    },
+    lastUsedTime: {
+      type: Date
+    },
+    appId: {
+      type: String,
+      required: false
+    },
+    name: {
+      type: String,
+      default: 'Api Key'
+    },
+    usage: {
+      // total usage. value from bill total
+      type: Number,
+      default: 0,
+      get: (val: number) => formatPrice(val)
+    },
+    limit: {
+      expiredTime: {
+        type: Date
+      },
+      credit: {
+        // value from user settings
+        type: Number,
+        default: -1,
+        set: (val: number) => val * PRICE_SCALE,
+        get: (val: number) => formatPrice(val)
+      }
+    }
+  },
+  {
+    toObject: { getters: true }
+  }
+);
+
+export const MongoOpenApi: Model<OpenApiSchema> =
+  models['openapi'] || model('openapi', OpenApiSchema);

packages/support/openapi/tools.ts

@@ -0,0 +1,18 @@
+import { MongoOpenApi } from './schema';
+
+export async function updateApiKeyUsedTime(id: string) {
+  await MongoOpenApi.findByIdAndUpdate(id, {
+    lastUsedTime: new Date()
+  });
+}
+
+export async function updateApiKeyUsage({ apikey, usage }: { apikey: string; usage: number }) {
+  await MongoOpenApi.findOneAndUpdate(
+    { apiKey: apikey },
+    {
+      $inc: {
+        usage
+      }
+    }
+  );
+}

packages/support/openapi/type.d.ts

@@ -0,0 +1,14 @@
+export type OpenApiSchema = {
+  _id: string;
+  userId: string;
+  createTime: Date;
+  lastUsedTime?: Date;
+  apiKey: string;
+  appId?: string;
+  name: string;
+  usage: number;
+  limit?: {
+    expiredTime?: Date;
+    credit?: number;
+  };
+};

packages/support/outLink/auth.ts

@@ -0,0 +1,67 @@
+import { AuthUserTypeEnum, authBalanceByUid } from '../user/auth';
+import { MongoOutLink } from './schema';
+import { POST } from '@fastgpt/common/plusApi/request';
+import { OutLinkSchema } from './type.d';
+
+export type AuthLinkProps = { ip?: string | null; authToken?: string; question: string };
+export type AuthLinkLimitProps = AuthLinkProps & { outLink: OutLinkSchema };
+
+export async function authOutLinkChat({
+  shareId,
+  ip,
+  authToken,
+  question
+}: AuthLinkProps & {
+  shareId: string;
+}) {
+  // get outLink
+  const outLink = await MongoOutLink.findOne({
+    shareId
+  });
+
+  if (!outLink) {
+    return Promise.reject('分享链接无效');
+  }
+
+  const uid = String(outLink.userId);
+
+  const [user] = await Promise.all([
+    authBalanceByUid(uid), // authBalance
+    ...(global.feConfigs?.isPlus ? [authOutLinkLimit({ outLink, ip, authToken, question })] : []) // limit auth
+  ]);
+
+  return {
+    user,
+    userId: String(outLink.userId),
+    appId: String(outLink.appId),
+    authType: AuthUserTypeEnum.token,
+    responseDetail: outLink.responseDetail
+  };
+}
+
+export function authOutLinkLimit(data: AuthLinkLimitProps) {
+  return POST('/support/outLink/authLimit', data);
+}
+
+export async function authOutLinkId({ id }: { id: string }) {
+  const outLink = await MongoOutLink.findOne({
+    shareId: id
+  });
+
+  if (!outLink) {
+    return Promise.reject('分享链接无效');
+  }
+
+  return {
+    userId: String(outLink.userId)
+  };
+}
+
+export type AuthShareChatInitProps = {
+  authToken?: string;
+  tokenUrl?: string;
+};
+
+export function authShareChatInit(data: AuthShareChatInitProps) {
+  return POST('/support/outLink/authShareChatInit', data);
+}

packages/support/outLink/constant.ts

@@ -0,0 +1,5 @@
+export enum OutLinkTypeEnum {
+  'share' = 'share',
+  'iframe' = 'iframe',
+  apikey = 'apikey'
+}

packages/support/outLink/schema.ts

@@ -0,0 +1,60 @@
+import { connectionMongo, type Model } from '@fastgpt/common/mongo';
+const { Schema, model, models } = connectionMongo;
+import { OutLinkSchema as SchemaType } from './type.d';
+import { OutLinkTypeEnum } from './constant';
+
+const OutLinkSchema = new Schema({
+  shareId: {
+    type: String,
+    required: true
+  },
+  userId: {
+    type: Schema.Types.ObjectId,
+    ref: 'user',
+    required: true
+  },
+  appId: {
+    type: Schema.Types.ObjectId,
+    ref: 'model',
+    required: true
+  },
+  type: {
+    type: String,
+    default: OutLinkTypeEnum.share
+  },
+  name: {
+    type: String,
+    required: true
+  },
+  total: {
+    // total amount
+    type: Number,
+    default: 0
+  },
+  lastTime: {
+    type: Date
+  },
+  responseDetail: {
+    type: Boolean,
+    default: false
+  },
+  limit: {
+    expiredTime: {
+      type: Date
+    },
+    QPM: {
+      type: Number,
+      default: 1000
+    },
+    credit: {
+      type: Number,
+      default: -1
+    },
+    hookUrl: {
+      type: String
+    }
+  }
+});
+
+export const MongoOutLink: Model<SchemaType> =
+  models['outlinks'] || model('outlinks', OutLinkSchema);

packages/support/outLink/tools.ts

@@ -0,0 +1,50 @@
+import axios from 'axios';
+import { MongoOutLink } from './schema';
+
+export const updateOutLinkUsage = async ({
+  shareId,
+  total
+}: {
+  shareId: string;
+  total: number;
+}) => {
+  try {
+    await MongoOutLink.findOneAndUpdate(
+      { shareId },
+      {
+        $inc: { total },
+        lastTime: new Date()
+      }
+    );
+  } catch (err) {
+    console.log('update shareChat error', err);
+  }
+};
+
+export const pushResult2Remote = async ({
+  authToken,
+  shareId,
+  responseData
+}: {
+  authToken?: string;
+  shareId?: string;
+  responseData?: any[];
+}) => {
+  if (!shareId || !authToken) return;
+  try {
+    const outLink = await MongoOutLink.findOne({
+      shareId
+    });
+    if (!outLink?.limit?.hookUrl) return;
+
+    axios({
+      method: 'post',
+      baseURL: outLink.limit.hookUrl,
+      url: '/shareAuth/finish',
+      data: {
+        token: authToken,
+        responseData
+      }
+    });
+  } catch (error) {}
+};

packages/support/outLink/type.d.ts

@@ -0,0 +1,26 @@
+import { OutLinkTypeEnum } from './constant';
+
+export type OutLinkSchema = {
+  _id: string;
+  shareId: string;
+  userId: string;
+  appId: string;
+  name: string;
+  total: number;
+  lastTime: Date;
+  type: `${OutLinkTypeEnum}`;
+  responseDetail: boolean;
+  limit?: {
+    expiredTime?: Date;
+    QPM: number;
+    credit: number;
+    hookUrl?: string;
+  };
+};
+
+export type OutLinkEditType = {
+  _id?: string;
+  name: string;
+  responseDetail: OutLinkSchema['responseDetail'];
+  limit: OutLinkSchema['limit'];
+};

packages/support/package.json

@@ -2,6 +2,13 @@
   "name": "@fastgpt/support",
   "version": "1.0.0",
   "dependencies": {
-    "@fastgpt/common": "workspace:*"
+    "@fastgpt/common": "workspace:*",
+    "cookie": "^0.5.0",
+    "jsonwebtoken": "^9.0.2",
+    "axios": "^1.5.1"
+  },
+  "devDependencies": {
+    "@types/cookie": "^0.5.2",
+    "@types/jsonwebtoken": "^9.0.3"
   }
 }

packages/support/tsconfig.json

@@ -14,8 +14,11 @@
     "isolatedModules": true,
     "jsx": "preserve",
     "incremental": true,
-    "baseUrl": "."
+    "baseUrl": ".",
+    "paths": {
+      "@/*": ["./*"]
+    }
   },
-  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", "**/*.d.ts"],
+  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", "**/*.d.ts", "../**/*.d.ts"],
   "exclude": ["node_modules"]
 }

packages/support/user/auth.ts

@@ -0,0 +1,167 @@
+import Cookie from 'cookie';
+import { authJWT } from './tools';
+import { authOpenApiKey } from '../openapi/auth';
+import { authOutLinkId } from '../outLink/auth';
+
+import { MongoUser } from './schema';
+import type { UserModelSchema } from './type.d';
+import { ERROR_ENUM } from '@fastgpt/common/constant/errorCode';
+
+export enum AuthUserTypeEnum {
+  token = 'token',
+  root = 'root',
+  apikey = 'apikey',
+  outLink = 'outLink'
+}
+
+/* auth balance */
+export const authBalanceByUid = async (uid: string) => {
+  const user = await MongoUser.findById<UserModelSchema>(
+    uid,
+    '_id username balance openaiAccount timezone'
+  );
+  if (!user) {
+    return Promise.reject(ERROR_ENUM.unAuthorization);
+  }
+
+  if (user.balance <= 0) {
+    return Promise.reject(ERROR_ENUM.insufficientQuota);
+  }
+  return user;
+};
+
+/* uniform auth user */
+export const authUser = async ({
+  req,
+  authToken = false,
+  authRoot = false,
+  authApiKey = false,
+  authBalance = false,
+  authOutLink
+}: {
+  req: any;
+  authToken?: boolean;
+  authRoot?: boolean;
+  authApiKey?: boolean;
+  authBalance?: boolean;
+  authOutLink?: boolean;
+}) => {
+  const authCookieToken = async (cookie?: string, token?: string): Promise<string> => {
+    // 获取 cookie
+    const cookies = Cookie.parse(cookie || '');
+    const cookieToken = cookies.token || token;
+
+    if (!cookieToken) {
+      return Promise.reject(ERROR_ENUM.unAuthorization);
+    }
+
+    return await authJWT(cookieToken);
+  };
+  // from authorization get apikey
+  const parseAuthorization = async (authorization?: string) => {
+    if (!authorization) {
+      return Promise.reject(ERROR_ENUM.unAuthorization);
+    }
+
+    // Bearer fastgpt-xxxx-appId
+    const auth = authorization.split(' ')[1];
+    if (!auth) {
+      return Promise.reject(ERROR_ENUM.unAuthorization);
+    }
+
+    const { apikey, appId: authorizationAppid = '' } = await (async () => {
+      const arr = auth.split('-');
+      // abandon
+      if (arr.length === 3) {
+        return {
+          apikey: `${arr[0]}-${arr[1]}`,
+          appId: arr[2]
+        };
+      }
+      if (arr.length === 2) {
+        return {
+          apikey: auth
+        };
+      }
+      return Promise.reject(ERROR_ENUM.unAuthorization);
+    })();
+
+    // auth apikey
+    const { userId, appId: apiKeyAppId = '' } = await authOpenApiKey({ apikey });
+
+    return {
+      uid: userId,
+      apikey,
+      appId: apiKeyAppId || authorizationAppid
+    };
+  };
+  // root user
+  const parseRootKey = async (rootKey?: string, userId = '') => {
+    if (!rootKey || !process.env.ROOT_KEY || rootKey !== process.env.ROOT_KEY) {
+      return Promise.reject(ERROR_ENUM.unAuthorization);
+    }
+    return userId;
+  };
+
+  const { cookie, token, apikey, rootkey, userid, authorization } = (req.headers || {}) as {
+    cookie?: string;
+    token?: string;
+    apikey?: string;
+    rootkey?: string; // abandon
+    userid?: string;
+    authorization?: string;
+  };
+  const { shareId } = (req?.body || {}) as { shareId?: string };
+
+  let uid = '';
+  let appId = '';
+  let openApiKey = apikey;
+  let authType: `${AuthUserTypeEnum}` = AuthUserTypeEnum.token;
+
+  if (authOutLink && shareId) {
+    const res = await authOutLinkId({ id: shareId });
+    uid = res.userId;
+    authType = AuthUserTypeEnum.outLink;
+  } else if (authToken && (cookie || token)) {
+    // user token(from fastgpt web)
+    uid = await authCookieToken(cookie, token);
+    authType = AuthUserTypeEnum.token;
+  } else if (authRoot && rootkey) {
+    // root user
+    uid = await parseRootKey(rootkey, userid);
+    authType = AuthUserTypeEnum.root;
+  } else if (authApiKey && apikey) {
+    // apikey
+    const parseResult = await authOpenApiKey({ apikey });
+    uid = parseResult.userId;
+    authType = AuthUserTypeEnum.apikey;
+    openApiKey = parseResult.apikey;
+  } else if (authApiKey && authorization) {
+    // apikey from authorization
+    const authResponse = await parseAuthorization(authorization);
+    uid = authResponse.uid;
+    appId = authResponse.appId;
+    openApiKey = authResponse.apikey;
+    authType = AuthUserTypeEnum.apikey;
+  }
+
+  // not rootUser and no uid, reject request
+  if (!rootkey && !uid) {
+    return Promise.reject(ERROR_ENUM.unAuthorization);
+  }
+
+  // balance check
+  const user = await (() => {
+    if (authBalance) {
+      return authBalanceByUid(uid);
+    }
+  })();
+
+  return {
+    userId: String(uid),
+    appId,
+    authType,
+    user,
+    apikey: openApiKey
+  };
+};

packages/support/user/schema.ts

@@ -0,0 +1,63 @@
+import { connectionMongo, type Model } from '@fastgpt/common/mongo';
+const { Schema, model, models } = connectionMongo;
+import { hashStr } from '@fastgpt/common/tools/str';
+import { PRICE_SCALE } from '@fastgpt/common/bill/constants';
+import type { UserModelSchema } from './type.d';
+
+const UserSchema = new Schema({
+  username: {
+    // 可以是手机/邮箱，新的验证都只用手机
+    type: String,
+    required: true,
+    unique: true // 唯一
+  },
+  password: {
+    type: String,
+    required: true,
+    set: (val: string) => hashStr(val),
+    get: (val: string) => hashStr(val),
+    select: false
+  },
+  createTime: {
+    type: Date,
+    default: () => new Date()
+  },
+  avatar: {
+    type: String,
+    default: '/icon/human.svg'
+  },
+  balance: {
+    type: Number,
+    default: 2 * PRICE_SCALE
+  },
+  inviterId: {
+    // 谁邀请注册的
+    type: Schema.Types.ObjectId,
+    ref: 'user'
+  },
+  promotionRate: {
+    type: Number,
+    default: 15
+  },
+  limit: {
+    exportKbTime: {
+      // Every half hour
+      type: Date
+    },
+    datasetMaxCount: {
+      type: Number
+    }
+  },
+  openaiAccount: {
+    type: {
+      key: String,
+      baseUrl: String
+    }
+  },
+  timezone: {
+    type: String,
+    default: 'Asia/Shanghai'
+  }
+});
+
+export const MongoUser: Model<UserModelSchema> = models['user'] || model('user', UserSchema);

packages/support/user/tools.ts

@@ -0,0 +1,28 @@
+import jwt from 'jsonwebtoken';
+import { ERROR_ENUM } from '@fastgpt/common/constant/errorCode';
+
+/* 生成 token */
+export const generateToken = (userId: string) => {
+  const key = process.env.TOKEN_KEY as string;
+  const token = jwt.sign(
+    {
+      userId,
+      exp: Math.floor(Date.now() / 1000) + 60 * 60 * 24 * 7
+    },
+    key
+  );
+  return token;
+};
+// auth token
+export const authJWT = (token: string) =>
+  new Promise<string>((resolve, reject) => {
+    const key = process.env.TOKEN_KEY as string;
+
+    jwt.verify(token, key, function (err, decoded: any) {
+      if (err || !decoded?.userId) {
+        reject(ERROR_ENUM.unAuthorization);
+        return;
+      }
+      resolve(decoded.userId);
+    });
+  });

packages/support/user/type.d.ts

@@ -0,0 +1,20 @@
+export type UserModelSchema = {
+  _id: string;
+  username: string;
+  password: string;
+  avatar: string;
+  balance: number;
+  promotionRate: number;
+  inviterId?: string;
+  openaiKey: string;
+  createTime: number;
+  timezone: string;
+  openaiAccount?: {
+    key: string;
+    baseUrl: string;
+  };
+  limit: {
+    exportKbTime?: Date;
+    datasetMaxCount?: number;
+  };
+};