@builder6/docs 0.15.7 → 0.16.1

package/README.md

@@ -1,35 +1,17 @@
 # Builder6 Docs
 
-This is the documentation for the Builder6 Docs project.
+This is the documentation for the Builder6 Docs module.
 
-## Build Docspace
+## Env
 
-To get started, clone the repository and install the dependencies.
-
-```bash
-yarn
-yarn build
-```
-
-## Build Docs Server
-
-To build the client and server, run the following command:
-
-```bash
-cd builde6/docs-server
-yarn build:client
-yarn build
+```shell
+# 启用 Onlyoffice 插件
+B6_ONLYOFFICE_ENABLED=true
+B6_ONLYOFFICE_JWT_SECRET=
+# 启用默认编辑水印
+B6_ONLYOFFICE_WATERMARK_ENABLED=true
 ```
 
-## Start Docs Server
-
-To build the server, run the following command:
-
-```bash
-yarn start:dev
-```
-
-
-## Documentation
+## Onlyoffice Documentation
 
 - https://api.onlyoffice.com/docspace/api-backend/get-started/basic-concepts/

package/dist/docs/docs.controller.d.ts

@@ -6,6 +6,7 @@ import { SettingsService } from './settings.service';
 import { ConfigService } from '@nestjs/config';
 import { DocsService } from './docs.service';
 import { PermissionService } from './permission.service';
+import { DocsGateway } from './docs.gateway';
 export declare class DocsController {
     private readonly configService;
     private readonly authService;
@@ -14,7 +15,8 @@ export declare class DocsController {
     private readonly docsService;
     private readonly settingsService;
     private readonly permissionService;
-    constructor(configService: ConfigService, authService: AuthService, filesService: FilesService, foldersService: FoldersService, docsService: DocsService, settingsService: SettingsService, permissionService: PermissionService);
+    private readonly docsGateway;
+    constructor(configService: ConfigService, authService: AuthService, filesService: FilesService, foldersService: FoldersService, docsService: DocsService, settingsService: SettingsService, permissionService: PermissionService, docsGateway: DocsGateway);
     getFilesSettings(): Promise<{
         response: {
             extsImagePreviewed: string[];
@@ -150,118 +152,69 @@ export declare class DocsController {
         status: number;
         statusCode: number;
     }>;
-    getFilesRoot(req: Request): Promise<{
-        response: {
-            files: any[];
-            folders: any[];
-            current: {
-                id: any;
-                title: any;
-                fileEntryType: number;
-                access: import("./enums").ShareAccessRights;
-                shared: any;
-                created: any;
-                createdBy: {
-                    id: any;
-                    displayName: any;
-                    avatar: string;
-                    avatarOriginal: string;
-                    avatarMax: string;
-                    avatarMedium: string;
-                    avatarSmall: string;
-                    profileUrl: string;
-                    hasAvatar: boolean;
-                    isAnonim: boolean;
-                };
-                updated: any;
-                updatedBy: {
-                    id: any;
-                    displayName: any;
-                    avatar: string;
-                    avatarOriginal: string;
-                    avatarMax: string;
-                    avatarMedium: string;
-                    avatarSmall: string;
-                    profileUrl: string;
-                    hasAvatar: boolean;
-                    isAnonim: boolean;
-                };
-                parentId: any;
-                filesCount: number;
-                foldersCount: any;
-                parents: any;
-                rootFolderId: any;
-                rootFolderType: any;
-                roomType: any;
-                parentRoomType: any;
-                new: number;
-                mute: boolean;
-                pinned: boolean;
-                private: boolean;
-                inRoom: boolean;
-                indexing: any;
-                denyDownload: any;
-                canShare: any;
-                tags: any;
-                logo: {
-                    original: string;
-                    large: string;
-                    medium: string;
-                    small: string;
-                    color: any;
-                };
-                lifetime: any;
-                watermark: any;
-                security: {
-                    Read: boolean;
-                    Create: boolean;
-                    Delete: boolean;
-                    EditRoom: boolean;
-                    Rename: boolean;
-                    CopyTo: boolean;
-                    Copy: boolean;
-                    MoveTo: boolean;
-                    Move: boolean;
-                    Pin: boolean;
-                    Mute: boolean;
-                    EditAccess: boolean;
-                    Duplicate: boolean;
-                    Download: boolean;
-                    CopySharedLink: boolean;
-                    Reconnect: boolean;
-                    CreateRoomFrom: boolean;
-                    CopyLink: boolean;
-                    Embed: boolean;
-                    ChangeOwner: boolean;
-                    IndexExport: boolean;
-                };
-            };
-            pathParts: {
-                id: any;
-                title: string;
-            }[];
-            startIndex: number;
-            count: number;
-            total: number;
-            new: number;
-        }[];
-        count: number;
-        status: number;
-        statusCode: number;
-    }>;
     getFilesTags(): Promise<{
         response: any[];
         count: number;
         status: number;
         statusCode: number;
     }>;
-    GetFolder(req: Request, folderId: string): Promise<{
+    getFile(req: Request, fileId: string): Promise<{
         response: {
+            folderId: any;
+            version: number;
+            versionGroup: number;
+            contentLength: string;
+            pureContentLength: any;
+            fileStatus: number;
+            mute: boolean;
+            viewUrl: string;
+            webUrl: string;
+            fileType: import("./enums").FileType;
+            fileExst: string;
+            comment: any;
+            thumbnailStatus: number;
+            viewAccessibility: {
+                ImageView: boolean;
+                MediaView: boolean;
+                WebView: boolean;
+                WebEdit: boolean;
+                WebReview: boolean;
+                WebCustomFilterEditing: boolean;
+                WebRestrictedEditing: boolean;
+                WebComment: boolean;
+                CoAuhtoring: boolean;
+                CanConvert: boolean;
+                MustConvert: boolean;
+            };
+            fileEntryType: number;
             id: any;
+            rootFolderId: any;
+            canShare: boolean;
+            security: {
+                Read: boolean;
+                Comment: boolean;
+                FillForms: boolean;
+                Review: boolean;
+                Edit: boolean;
+                Delete: boolean;
+                CustomFilter: boolean;
+                Rename: boolean;
+                ReadHistory: boolean;
+                Lock: boolean;
+                EditHistory: boolean;
+                Copy: boolean;
+                Move: boolean;
+                Duplicate: boolean;
+                SubmitToFormGallery: boolean;
+                Download: boolean;
+                Convert: boolean;
+                CreateRoomFrom: boolean;
+                CopyLink: boolean;
+                Embed: boolean;
+            };
             title: any;
-            fileEntryType: number;
-            access: import("./enums").ShareAccessRights;
-            shared: any;
+            access: number;
+            shared: boolean;
             created: any;
             createdBy: {
                 id: any;
@@ -276,6 +229,7 @@ export declare class DocsController {
                 isAnonim: boolean;
             };
             updated: any;
+            rootFolderType: any;
             updatedBy: {
                 id: any;
                 displayName: any;
@@ -288,67 +242,70 @@ export declare class DocsController {
                 hasAvatar: boolean;
                 isAnonim: boolean;
             };
-            parentId: any;
-            filesCount: number;
-            foldersCount: any;
-            parents: any;
-            rootFolderId: any;
-            rootFolderType: any;
-            roomType: any;
-            parentRoomType: any;
-            new: number;
+            locked: any;
+            lockedBy: any;
+        };
+        count: number;
+        status: number;
+        statusCode: number;
+    }>;
+    updateFile(req: Request, fileId: string, record: Record<string, any>): Promise<{
+        response: {
+            folderId: any;
+            version: number;
+            versionGroup: number;
+            contentLength: string;
+            pureContentLength: any;
+            fileStatus: number;
             mute: boolean;
-            pinned: boolean;
-            private: boolean;
-            inRoom: boolean;
-            indexing: any;
-            denyDownload: any;
-            canShare: any;
-            tags: any;
-            logo: {
-                original: string;
-                large: string;
-                medium: string;
-                small: string;
-                color: any;
+            viewUrl: string;
+            webUrl: string;
+            fileType: import("./enums").FileType;
+            fileExst: string;
+            comment: any;
+            thumbnailStatus: number;
+            viewAccessibility: {
+                ImageView: boolean;
+                MediaView: boolean;
+                WebView: boolean;
+                WebEdit: boolean;
+                WebReview: boolean;
+                WebCustomFilterEditing: boolean;
+                WebRestrictedEditing: boolean;
+                WebComment: boolean;
+                CoAuhtoring: boolean;
+                CanConvert: boolean;
+                MustConvert: boolean;
             };
-            lifetime: any;
-            watermark: any;
+            fileEntryType: number;
+            id: any;
+            rootFolderId: any;
+            canShare: boolean;
             security: {
                 Read: boolean;
-                Create: boolean;
+                Comment: boolean;
+                FillForms: boolean;
+                Review: boolean;
+                Edit: boolean;
                 Delete: boolean;
-                EditRoom: boolean;
+                CustomFilter: boolean;
                 Rename: boolean;
-                CopyTo: boolean;
+                ReadHistory: boolean;
+                Lock: boolean;
+                EditHistory: boolean;
                 Copy: boolean;
-                MoveTo: boolean;
                 Move: boolean;
-                Pin: boolean;
-                Mute: boolean;
-                EditAccess: boolean;
                 Duplicate: boolean;
+                SubmitToFormGallery: boolean;
                 Download: boolean;
-                CopySharedLink: boolean;
-                Reconnect: boolean;
+                Convert: boolean;
                 CreateRoomFrom: boolean;
                 CopyLink: boolean;
                 Embed: boolean;
-                ChangeOwner: boolean;
-                IndexExport: boolean;
             };
-        };
-        count: number;
-        status: number;
-        statusCode: number;
-    }>;
-    CreateFolder(req: Request, folderId: string, record: Record<string, any>): Promise<{
-        response: {
-            id: any;
             title: any;
-            fileEntryType: number;
-            access: import("./enums").ShareAccessRights;
-            shared: any;
+            access: number;
+            shared: boolean;
             created: any;
             createdBy: {
                 id: any;
@@ -363,6 +320,7 @@ export declare class DocsController {
                 isAnonim: boolean;
             };
             updated: any;
+            rootFolderType: any;
             updatedBy: {
                 id: any;
                 displayName: any;
@@ -375,65 +333,30 @@ export declare class DocsController {
                 hasAvatar: boolean;
                 isAnonim: boolean;
             };
-            parentId: any;
-            filesCount: number;
-            foldersCount: any;
-            parents: any;
-            rootFolderId: any;
-            rootFolderType: any;
-            roomType: any;
-            parentRoomType: any;
-            new: number;
-            mute: boolean;
-            pinned: boolean;
-            private: boolean;
-            inRoom: boolean;
-            indexing: any;
-            denyDownload: any;
-            canShare: any;
-            tags: any;
-            logo: {
-                original: string;
-                large: string;
-                medium: string;
-                small: string;
-                color: any;
-            };
-            lifetime: any;
-            watermark: any;
-            security: {
-                Read: boolean;
-                Create: boolean;
-                Delete: boolean;
-                EditRoom: boolean;
-                Rename: boolean;
-                CopyTo: boolean;
-                Copy: boolean;
-                MoveTo: boolean;
-                Move: boolean;
-                Pin: boolean;
-                Mute: boolean;
-                EditAccess: boolean;
-                Duplicate: boolean;
-                Download: boolean;
-                CopySharedLink: boolean;
-                Reconnect: boolean;
-                CreateRoomFrom: boolean;
-                CopyLink: boolean;
-                Embed: boolean;
-                ChangeOwner: boolean;
-                IndexExport: boolean;
-            };
+            locked: any;
+            lockedBy: any;
         };
         count: number;
         status: number;
         statusCode: number;
     }>;
-    getFile(req: Request, fileId: string): Promise<{
+    getFileHistory(req: Request, fileId: string): Promise<{
+        response: any[];
+        count: number;
+        status: number;
+        statusCode: number;
+    }>;
+    setFileComment(req: Request, fileId: string, record: Record<string, any>): Promise<{
+        response: any;
+        count: number;
+        status: number;
+        statusCode: number;
+    }>;
+    setFileLock(req: Request, fileId: string, record: Record<string, any>): Promise<{
         response: {
             folderId: any;
-            version: any;
-            versionGroup: any;
+            version: number;
+            versionGroup: number;
             contentLength: string;
             pureContentLength: any;
             fileStatus: number;
@@ -442,7 +365,7 @@ export declare class DocsController {
             webUrl: string;
             fileType: import("./enums").FileType;
             fileExst: string;
-            comment: string;
+            comment: any;
             thumbnailStatus: number;
             viewAccessibility: {
                 ImageView: boolean;
@@ -513,13 +436,46 @@ export declare class DocsController {
                 hasAvatar: boolean;
                 isAnonim: boolean;
             };
+            locked: any;
+            lockedBy: any;
         };
         count: number;
         status: number;
         statusCode: number;
     }>;
-    fileHandler(req: Request, res: Response, fileId: string, action: string): Promise<Response<any, Record<string, any>>>;
+    checkMoveFile(req: Request, destFolderId: string, fileIds: string[]): Promise<{
+        response: any[];
+        count: number;
+        status: number;
+        statusCode: number;
+    }>;
+    moveFile(req: Request, record: Record<string, any>): Promise<{
+        response: {
+            id: string;
+            Operation: number;
+            progress: number;
+            error: string;
+            processed: string;
+            finished: boolean;
+            files: any[];
+        };
+        count: number;
+        status: number;
+        statusCode: number;
+    }>;
+    fileHandler(req: Request, res: Response, fileId: string, action: string, version?: number): Promise<Response<any, Record<string, any>>>;
     getFilesByFolderId(req: Request, folderId: string): Promise<{
+        error: {
+            message: string;
+            type: string;
+            stack: string;
+            hresult: number;
+        };
+        status: number;
+        statusCode: number;
+        response?: undefined;
+        count?: undefined;
+    } | {
         response: {
             files: any[];
             folders: any[];
@@ -527,7 +483,7 @@ export declare class DocsController {
                 id: any;
                 title: any;
                 fileEntryType: number;
-                access: import("./enums").ShareAccessRights;
+                access: any;
                 shared: any;
                 created: any;
                 createdBy: {
@@ -614,6 +570,7 @@ export declare class DocsController {
         count: number;
         status: number;
         statusCode: number;
+        error?: undefined;
     }>;
     uploadCheck(req: Request, folderId: string, record: Record<string, any>): Promise<{
         response: any[];
@@ -659,8 +616,8 @@ export declare class DocsController {
             uploaded: boolean;
             file: {
                 folderId: any;
-                version: any;
-                versionGroup: any;
+                version: number;
+                versionGroup: number;
                 contentLength: string;
                 pureContentLength: any;
                 fileStatus: number;
@@ -669,7 +626,7 @@ export declare class DocsController {
                 webUrl: string;
                 fileType: import("./enums").FileType;
                 fileExst: string;
-                comment: string;
+                comment: any;
                 thumbnailStatus: number;
                 viewAccessibility: {
                     ImageView: boolean;
@@ -740,6 +697,8 @@ export declare class DocsController {
                     hasAvatar: boolean;
                     isAnonim: boolean;
                 };
+                locked: any;
+                lockedBy: any;
             };
         };
         message: string;