Dataset Permission (#1786)

* feat: dataset controllers

feat: dataset schema

fix: add missing type to dataset schema
Signed-off-by: FinleyGe <m13203533462@163.com>

* feat: dataset list api

Signed-off-by: FinleyGe <m13203533462@163.com>

* chore: all dataset api

Signed-off-by: FinleyGe <m13203533462@163.com>

* feat: new auth dataset method

Signed-off-by: FinleyGe <m13203533462@163.com>

* chore: use new auth method in detail, paths.
feat: add new param defaultPermission to create api

Signed-off-by: FinleyGe <m13203533462@163.com>

* chore: app auth params

Signed-off-by: FinleyGe <m13203533462@163.com>

* chore: use new auth method

Signed-off-by: FinleyGe <m13203533462@163.com>

* feat: new auth collection and file method

Signed-off-by: FinleyGe <m13203533462@163.com>

* chore: dataset collection api new auth

Signed-off-by: FinleyGe <m13203533462@163.com>

* chore: create/*.ts auth

Signed-off-by: FinleyGe <m13203533462@163.com>

* chore: dataset auth

Signed-off-by: FinleyGe <m13203533462@163.com>

* fix: import paths

Signed-off-by: FinleyGe <m13203533462@163.com>

* feat: dataset collaborator

Signed-off-by: FinleyGe <m13203533462@163.com>

* chore: dataset frontend

feat: dataset list frontend

feat: dataset detail
Signed-off-by: FinleyGe <m13203533462@163.com>

* feat: finish the dataset permission

fix: ts errors
Signed-off-by: FinleyGe <m13203533462@163.com>

* fix: empty response of collection api

Signed-off-by: FinleyGe <m13203533462@163.com>

* chore: adjust the code

* chore: adjust the code

* chore: i18n

* fix: ts error

* fix: fe CollectionCard permission

---------

Signed-off-by: FinleyGe <m13203533462@163.com>

packages/global/common/error/code/common.ts

@@ -4,7 +4,8 @@ import { ErrType } from '../errorCode';
 const startCode = 507000;
 export enum CommonErrEnum {
   fileNotFound = 'fileNotFound',
-  unAuthFile = 'unAuthFile'
+  unAuthFile = 'unAuthFile',
+  missingParams = 'missingParams'
 }
 const datasetErr = [
   {
@@ -14,6 +15,10 @@ const datasetErr = [
   {
     statusText: CommonErrEnum.unAuthFile,
     message: 'error.unAuthFile'
+  },
+  {
+    statusText: CommonErrEnum.missingParams,
+    message: 'error.missingParams'
   }
 ];
 export default datasetErr.reduce((acc, cur, index) => {

packages/global/common/error/code/dataset.ts

@@ -2,6 +2,7 @@ import { ErrType } from '../errorCode';
 
 /* dataset: 501000 */
 export enum DatasetErrEnum {
+  unExist = 'unExistDataset',
   unAuthDataset = 'unAuthDataset',
   unCreateCollection = 'unCreateCollection',
   unAuthDatasetCollection = 'unAuthDatasetCollection',
@@ -11,6 +12,10 @@ export enum DatasetErrEnum {
   unLinkCollection = 'unLinkCollection'
 }
 const datasetErr = [
+  {
+    statusText: DatasetErrEnum.unExist,
+    message: 'core.dataset.error.unExistDataset'
+  },
   {
     statusText: DatasetErrEnum.unAuthDataset,
     message: 'core.dataset.error.unAuthDataset'

packages/global/core/dataset/api.d.ts

@@ -9,12 +9,13 @@ export type DatasetUpdateBody = {
   name?: string;
   avatar?: string;
   intro?: string;
-  permission?: DatasetSchemaType['permission'];
+  permission?: DatasetSchemaType['permission']; // TODO: Should be deleted.
   agentModel?: LLMModelItemType;
   status?: DatasetSchemaType['status'];
 
   websiteConfig?: DatasetSchemaType['websiteConfig'];
   externalReadUrl?: DatasetSchemaType['externalReadUrl'];
+  defaultPermission?: DatasetSchemaType['defaultPermission'];
 };
 
 /* ================= collection ===================== */

packages/global/core/dataset/collaborator.d.ts

@@ -0,0 +1,11 @@
+import { UpdateClbPermissionProps } from '../../support/permission/collaborator';
+import { PermissionValueType } from '../../support/permission/type';
+
+export type UpdateDatasetCollaboratorBody = UpdateClbPermissionProps & {
+  datasetId: string;
+};
+
+export type DatasetCollaboratorDeleteParams = {
+  datasetId: string;
+  tmbId: string;
+};

packages/global/core/dataset/type.d.ts

@@ -1,3 +1,4 @@
+import { PermissionValueType } from 'support/permission/type';
 import type { LLMModelItemType, VectorModelItemType } from '../../core/ai/model.d';
 import { PermissionTypeEnum } from '../../support/permission/constant';
 import { PushDatasetDataChunkProps } from './api';
@@ -8,6 +9,8 @@ import {
   SearchScoreTypeEnum,
   TrainingModeEnum
 } from './constants';
+import { DatasetPermission } from '../../support/permission/dataset/controller';
+import { Permission } from '../../support/permission/controller';
 
 /* schema */
 export type DatasetSchemaType = {
@@ -24,7 +27,7 @@ export type DatasetSchemaType = {
   intro: string;
   type: DatasetTypeEnum;
   status: `${DatasetStatusEnum}`;
-  permission: `${PermissionTypeEnum}`;
+  permission: DatasetPermission;
 
   // metadata
   websiteConfig?: {
@@ -32,6 +35,7 @@ export type DatasetSchemaType = {
     selector: string;
   };
   externalReadUrl?: string;
+  defaultPermission: PermissionValueType;
 };
 
 export type DatasetCollectionSchemaType = {
@@ -132,24 +136,22 @@ export type DatasetListItemType = {
   name: string;
   intro: string;
   type: DatasetTypeEnum;
-  isOwner: boolean;
-  canWrite: boolean;
-  permission: `${PermissionTypeEnum}`;
+  permission: DatasetPermission;
   vectorModel: VectorModelItemType;
+  defaultPermission: PermissionValueType;
 };
+
 export type DatasetItemType = Omit<DatasetSchemaType, 'vectorModel' | 'agentModel'> & {
   vectorModel: VectorModelItemType;
   agentModel: LLMModelItemType;
-  isOwner: boolean;
-  canWrite: boolean;
 };
 
 /* ================= collection ===================== */
 export type DatasetCollectionItemType = CollectionWithDatasetType & {
-  canWrite: boolean;
   sourceName: string;
   sourceId?: string;
   file?: DatasetFileSchema;
+  permission: DatasetPermission;
 };
 
 /* ================= data ===================== */

packages/global/support/permission/dataset/constant.ts

@@ -0,0 +1,20 @@
+import { NullPermission, PermissionKeyEnum, PermissionList } from '../constant';
+
+export enum DatasetPermissionKeyEnum {}
+
+export const DatasetPermissionList = {
+  [PermissionKeyEnum.read]: {
+    ...PermissionList[PermissionKeyEnum.read],
+    description: '可查看知识库内容'
+  },
+  [PermissionKeyEnum.write]: {
+    ...PermissionList[PermissionKeyEnum.write],
+    description: '可增加和变更知识库内容'
+  },
+  [PermissionKeyEnum.manage]: {
+    ...PermissionList[PermissionKeyEnum.manage],
+    description: '可管理整个知识库数据和信息'
+  }
+};
+
+export const DatasetDefaultPermission = NullPermission;

packages/global/support/permission/dataset/controller.ts

@@ -0,0 +1,14 @@
+import { NullPermission } from '../constant';
+import { PerConstructPros, Permission } from '../controller';
+export class DatasetPermission extends Permission {
+  constructor(props?: PerConstructPros) {
+    if (!props) {
+      props = {
+        per: NullPermission
+      };
+    } else if (!props?.per) {
+      props.per = NullPermission;
+    }
+    super(props);
+  }
+}