Skip to content

Build your own AI office with Univer Office SDK. Bring editing, calculation, collaboration, and file processing into your product for people and AI agents. Built on an extensible open-source core.

7.5 KB
Raw Blame
/**
 * Copyright 2023-present DreamNum Co., Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import type { Dependency, ICommand } from '@univerjs/core';
import {
    ICommandService,
    IConfigService,
    Inject,
    Injector,
    IResourceManagerService,
    merge,
    ObjectPermissionService,
    Plugin,
    UniverInstanceType,
} from '@univerjs/core';
import { UnitObject } from '@univerjs/protocol';
import type { IUniverDocsConfig } from './config/config';
import pkg from '../package.json';
import { DeleteTextCommand, InsertTextCommand, UpdateTextCommand } from './commands/commands/core-editing.command';
import { CreateHeaderFooterCommand } from './commands/commands/create-header-footer.command';
import {
    SetDocumentDefaultParagraphStyleCommand,
} from './commands/commands/set-document-default-paragraph-style.command';
import { SetDocumentNameCommand } from './commands/commands/set-document-name.command';
import { SetDocumentPermissionCommand } from './commands/commands/set-document-permission.command';
import { SetDocumentPermissionsCommand } from './commands/commands/set-document-permissions.command';
import { SetHeadingCollapsedCommand } from './commands/commands/set-heading-collapsed.command';
import { SetSectionHeaderFooterLinkCommand } from './commands/commands/set-section-header-footer-link.command';
import { UpdateDocumentParagraphStyleCommand } from './commands/commands/update-document-paragraph-style.command';
import {
    DeleteDocumentSectionBreakCommand,
    InsertDocumentColumnBreakCommand,
    InsertDocumentSectionBreakCommand,
    UpdateDocumentSectionCommand,
} from './commands/commands/update-document-section.command';
import { RichTextEditingMutation } from './commands/mutations/core-editing.mutation';
import { DocsRenameMutation } from './commands/mutations/docs-rename.mutation';
import { SetDocumentPermissionRuleMutation } from './commands/mutations/set-document-permission-rule.mutation';
import { SetDocumentPermissionRulesMutation } from './commands/mutations/set-document-permission-rules.mutation';
import { SetTextSelectionsOperation } from './commands/operations/text-selection.operation';
import { defaultPluginConfig, DOCS_PLUGIN_CONFIG_KEY } from './config/config';
import { DocCustomRangeController } from './controllers/custom-range.controller';
import { DocPermissionController } from './controllers/doc-permission.controller';
import { DocBlockMoveValidatorService } from './services/doc-block-move-validator.service';
import { DocContentInsertService } from './services/doc-content-insert.service';
import { DocLayoutExecutorService } from './services/doc-layout-executor.service';
import { DocSelectionManagerService } from './services/doc-selection-manager.service';
import { DocStateChangeManagerService } from './services/doc-state-change-manager.service';
import { DocStateEmitService } from './services/doc-state-emit.service';
import { DocTextResolverService } from './services/doc-text-resolver.service';
import { DocumentPermissionRuleModel } from './services/permission/document-permission-rule.model';

export class UniverDocsPlugin extends Plugin {
    static override pluginName = 'DOCS_PLUGIN';
    static override packageName = pkg.name;
    static override version = pkg.version;
    // static override type = UniverInstanceType.UNIVER_DOC;

    constructor(
        private readonly _config: Partial<IUniverDocsConfig> = defaultPluginConfig,
        @Inject(Injector) override _injector: Injector,
        @IConfigService private readonly _configService: IConfigService
    ) {
        super();

        // Manage the plugin configuration.
        const { ...rest } = merge(
            {},
            defaultPluginConfig,
            this._config
        );
        this._configService.setConfig(DOCS_PLUGIN_CONFIG_KEY, rest);
    }

    override onStarting(): void {
        this._injector.add([DocumentPermissionRuleModel]);
        this.disposeWithMe(this._injector.get(ICommandService).registerCommand(SetDocumentPermissionRuleMutation));
        this.disposeWithMe(this._injector.get(ICommandService).registerCommand(SetDocumentPermissionRulesMutation));
        this.disposeWithMe(this._injector.get(ObjectPermissionService).registerRuleModel(
            UnitObject.Document,
            this._injector.get(DocumentPermissionRuleModel),
            SetDocumentPermissionRuleMutation.id,
            SetDocumentPermissionRulesMutation.id
        ));
        this._initializeDependencies();
        this._initializeCommands();
        this._initializeWordResources();
    }

    private _initializeWordResources(): void {
        // Imported Word package metadata is opaque to editing but must survive save().
        for (const pluginName of ['DOC_WORD_STYLES_PLUGIN', 'DOC_NOTE_PLUGIN'] as const) {
            const resources = new Map<string, string>();
            this.disposeWithMe({ dispose: () => resources.clear() });
            this.disposeWithMe(this._injector.get(IResourceManagerService).registerPluginResource({
                pluginName,
                businesses: [UniverInstanceType.UNIVER_DOC],
                parseJson: (data: string) => data,
                onLoad: (unitId, data) => { resources.set(unitId, data); },
                onUnLoad: (unitId) => { resources.delete(unitId); },
                toJson: (unitId) => resources.get(unitId) ?? '',
            }));
        }
    }

    private _initializeCommands(): void {
        (
            [
                InsertTextCommand,
                DeleteTextCommand,
                UpdateTextCommand,
                CreateHeaderFooterCommand,
                SetDocumentPermissionCommand,
                SetDocumentPermissionsCommand,
                SetDocumentDefaultParagraphStyleCommand,
                SetDocumentNameCommand,
                SetHeadingCollapsedCommand,
                SetSectionHeaderFooterLinkCommand,
                UpdateDocumentParagraphStyleCommand,
                UpdateDocumentSectionCommand,
                InsertDocumentSectionBreakCommand,
                InsertDocumentColumnBreakCommand,
                DeleteDocumentSectionBreakCommand,
                RichTextEditingMutation,
                DocsRenameMutation,
                SetTextSelectionsOperation,
            ] as ICommand[]
        ).forEach((command) => {
            this._injector.get(ICommandService).registerCommand(command);
        });
    }

    private _initializeDependencies() {
        (
            [
                [DocSelectionManagerService],
                [DocStateEmitService],
                [DocStateChangeManagerService],
                [DocBlockMoveValidatorService],
                [DocContentInsertService],
                [DocLayoutExecutorService],
                [DocTextResolverService],
                [DocCustomRangeController],
                [DocPermissionController],
            ] as Dependency[]
        ).forEach((d) => this._injector.add(d));
    }

    override onReady(): void {
        this._injector.get(DocStateChangeManagerService);
        this._injector.get(DocCustomRangeController);
        this._injector.get(DocPermissionController);
    }
}