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.

feat(facade): add `@hideconstructor` and `@ignore` annotations to various classes (#4530)

白熱fe6999dfa35a
diff --git a/common/shared/vite/cleanup-pkg-plugin.ts b/common/shared/vite/cleanup-pkg-plugin.ts
index d61ff23214..9d846dbcc1 100644
--- a/common/shared/vite/cleanup-pkg-plugin.ts
+++ b/common/shared/vite/cleanup-pkg-plugin.ts
@@ -112,7 +112,6 @@ export function cleanupPkgPlugin(): Plugin {
};
}
pkg.publishConfig.exports['./lib/*'] = './lib/*';
- delete pkg.space;
if (Object.keys(optionalDeps).length > 0) {
pkg.optionalDependencies = sortKeys(optionalDeps);
diff --git a/common/shared/vite/index.ts b/common/shared/vite/index.ts
index 893428dce3..04880e5617 100644
--- a/common/shared/vite/index.ts
+++ b/common/shared/vite/index.ts
@@ -37,10 +37,11 @@ interface IBuildExecuterOptions {
}
async function buildESM(sharedConfig: InlineConfig, options: IBuildExecuterOptions) {
- const { entry } = options;
+ const { pkg, entry } = options;
return Promise.all(Object.keys(entry).map((key) => {
const basicConfig: InlineConfig = {
+ esbuild: {},
build: {
emptyOutDir: false,
outDir: 'lib',
@@ -59,6 +60,13 @@ async function buildESM(sharedConfig: InlineConfig, options: IBuildExecuterOptio
},
};
+ if (pkg.name.startsWith('@univerjs/')) {
+ basicConfig.esbuild = {
+ minifyIdentifiers: false,
+ keepNames: true,
+ };
+ }
+
const config: InlineConfig = mergeConfig(sharedConfig, basicConfig);
if (key === 'index') {
diff --git a/packages/core/src/facade/f-base.ts b/packages/core/src/facade/f-base.ts
index f8c2ba655e..512e6e853f 100644
--- a/packages/core/src/facade/f-base.ts
+++ b/packages/core/src/facade/f-base.ts
@@ -21,9 +21,12 @@ import { Disposable } from '../shared';
* `FBase` is a base class for all facade classes.
* It provides a way to extend classes with static and instance methods.
* The `_initialize` as a special method that will be called after the constructor. You should never call it directly.
+ * @ignore
*/
-/** @ignore */
export abstract class FBase extends Disposable {
+ /**
+ * @ignore
+ */
static extend(source: any): void {
Object.getOwnPropertyNames(source.prototype).forEach((name) => {
if (name !== 'constructor') {
@@ -41,12 +44,20 @@ export abstract class FBase extends Disposable {
}
}
-/** @ignore */
+/**
+ * @ignore
+ */
const InitializerSymbol = Symbol('initializers');
+/**
+ * @ignore
+ */
type Initializers = Array<(injector: Injector) => void>;
-/** @ignore */
+/**
+ * @ignore
+ * @hideconstructor
+ */
export class FBaseInitialable extends Disposable {
declare private [InitializerSymbol]: Initializers | undefined;
@@ -66,8 +77,14 @@ export class FBaseInitialable extends Disposable {
}
}
+ /**
+ * @ignore
+ */
_initialize(injector: Injector) { }
+ /**
+ * @ignore
+ */
static extend(source: any): void {
Object.getOwnPropertyNames(source.prototype).forEach((name) => {
if (name === '_initialize') {
diff --git a/packages/core/src/facade/f-blob.ts b/packages/core/src/facade/f-blob.ts
index e84a2c4040..5869ddbb19 100644
--- a/packages/core/src/facade/f-blob.ts
+++ b/packages/core/src/facade/f-blob.ts
@@ -31,6 +31,9 @@ export interface IFBlobSource {
getAs(contentType: string): FBlob;
}
+/**
+ * @hideconstructor
+ */
export class FBlob extends FBase {
constructor(
private _blob: Nullable<Blob>,
diff --git a/packages/core/src/facade/f-doc.ts b/packages/core/src/facade/f-doc.ts
index 87ea21cf7d..9c5ffb77b8 100644
--- a/packages/core/src/facade/f-doc.ts
+++ b/packages/core/src/facade/f-doc.ts
@@ -18,6 +18,10 @@ import type { DocumentDataModel } from '../docs';
import { Inject, Injector } from '../common/di';
import { FBaseInitialable } from './f-base';
+/**
+ * @ignore
+ * @hideconstructor
+ */
export class FDoc extends FBaseInitialable {
constructor(
protected doc: DocumentDataModel,
diff --git a/packages/core/src/facade/f-enum.ts b/packages/core/src/facade/f-enum.ts
index 61ae769107..2f4193e2d5 100644
--- a/packages/core/src/facade/f-enum.ts
+++ b/packages/core/src/facade/f-enum.ts
@@ -39,6 +39,9 @@ import { RelativeDate } from '../types/enum/relative-date';
import { SheetTypes } from '../types/enum/sheet-types';
import { ThemeColorType } from '../types/enum/theme-color-type';
+/**
+ * @hideconstructor
+ */
export class FEnum {
static _instance: FEnum | null;
@@ -52,6 +55,9 @@ export class FEnum {
return instance;
}
+ /**
+ * @ignore
+ */
static extend(source: any): void {
Object.getOwnPropertyNames(source.prototype).forEach((name) => {
if (name !== 'constructor') {
diff --git a/packages/core/src/facade/f-event.ts b/packages/core/src/facade/f-event.ts
index 825977a03b..19100cd94a 100644
--- a/packages/core/src/facade/f-event.ts
+++ b/packages/core/src/facade/f-event.ts
@@ -83,6 +83,9 @@ export interface ICommandEvent extends IEventBase {
type: CommandType;
}
+/**
+ * @hideconstructor
+ */
export class FEventName {
static _instance: FEventName | null;
static get() {
@@ -95,6 +98,9 @@ export class FEventName {
return instance;
}
+ /**
+ * @ignore
+ */
static extend(source: any): void {
Object.getOwnPropertyNames(source.prototype).forEach((name) => {
if (name !== 'constructor') {
diff --git a/packages/core/src/facade/f-hooks.ts b/packages/core/src/facade/f-hooks.ts
index bb6c1ded89..4f4a13079f 100644
--- a/packages/core/src/facade/f-hooks.ts
+++ b/packages/core/src/facade/f-hooks.ts
@@ -25,6 +25,9 @@ import { IUndoRedoService, RedoCommand, UndoCommand } from '../services/undoredo
import { toDisposable } from '../shared/lifecycle';
import { FBase } from './f-base';
+/**
+ * @hideconstructor
+ */
export class FHooks extends FBase {
constructor(
@Inject(Injector) protected readonly _injector: Injector,
diff --git a/packages/core/src/facade/f-univer.ts b/packages/core/src/facade/f-univer.ts
index 28c15b0acc..33244e8a04 100644
--- a/packages/core/src/facade/f-univer.ts
+++ b/packages/core/src/facade/f-univer.ts
@@ -40,6 +40,9 @@ import { FHooks } from './f-hooks';
import { FUserManager } from './f-usermanager';
import { FUtil } from './f-util';
+/**
+ * @hideconstructor
+ */
export class FUniver extends FBaseInitialable {
/**
* Create an FUniver instance, if the injector is not provided, it will create a new Univer instance.
diff --git a/packages/core/src/facade/f-usermanager.ts b/packages/core/src/facade/f-usermanager.ts
index 151aa423cc..64d3841789 100644
--- a/packages/core/src/facade/f-usermanager.ts
+++ b/packages/core/src/facade/f-usermanager.ts
@@ -19,6 +19,9 @@ import { Inject, Injector } from '../common/di';
import { UserManagerService } from '../services/user-manager/user-manager.service';
import { FBase } from './f-base';
+/**
+ * @hideconstructor
+ */
export class FUserManager extends FBase {
constructor(
@Inject(Injector) protected readonly _injector: Injector,
diff --git a/packages/core/src/facade/f-util.ts b/packages/core/src/facade/f-util.ts
index e39a8ff84a..ca7521f422 100644
--- a/packages/core/src/facade/f-util.ts
+++ b/packages/core/src/facade/f-util.ts
@@ -16,6 +16,9 @@
import { numfmt, Rectangle, Tools } from '../shared';
+/**
+ * @ignore
+ */
export class FUtil {
static _instance: FUtil | null;
static get() {
@@ -28,6 +31,9 @@ export class FUtil {
return instance;
}
+ /**
+ * @ignore
+ */
static extend(source: any): void {
Object.getOwnPropertyNames(source.prototype).forEach((name) => {
if (name !== 'constructor') {
diff --git a/packages/docs-ui/src/facade/f-document.ts b/packages/docs-ui/src/facade/f-document.ts
index d3f5ae1371..5c6cfa32b5 100644
--- a/packages/docs-ui/src/facade/f-document.ts
+++ b/packages/docs-ui/src/facade/f-document.ts
@@ -27,6 +27,9 @@ import { DOC_RANGE_TYPE, ICommandService,
import { DocSelectionRenderService, InsertCommand } from '@univerjs/docs-ui';
import { IRenderManagerService } from '@univerjs/engine-render';
+/**
+ * @hideconstructor
+ */
export class FDocument {
readonly id: string;
diff --git a/packages/engine-formula/src/facade/f-formula.ts b/packages/engine-formula/src/facade/f-formula.ts
index 757513e196..292715dc4f 100644
--- a/packages/engine-formula/src/facade/f-formula.ts
+++ b/packages/engine-formula/src/facade/f-formula.ts
@@ -21,6 +21,7 @@ import { ENGINE_FORMULA_CYCLE_REFERENCE_COUNT, LexerTreeBuilder, SetFormulaCalcu
/**
* This interface class provides methods to modify the behavior of the operation formula.
+ * @hideconstructor
*/
export class FFormula extends FBase {
constructor(
@@ -33,6 +34,9 @@ export class FFormula extends FBase {
this._initialize();
}
+ /**
+ * @ignore
+ */
_initialize(): void {
// do nothing
}
diff --git a/packages/network/src/facade/f-network.ts b/packages/network/src/facade/f-network.ts
index 10cb9fca84..e1abe3bdb3 100644
--- a/packages/network/src/facade/f-network.ts
+++ b/packages/network/src/facade/f-network.ts
@@ -19,6 +19,9 @@ import type { Observable } from 'rxjs';
import { FBase, Inject, Injector } from '@univerjs/core';
import { HTTPService } from '@univerjs/network';
+/**
+ * @hideconstructor
+ */
export class FNetwork extends FBase {
constructor(
@Inject(Injector) protected readonly _injector: Injector,
diff --git a/packages/sheets-conditional-formatting/src/facade/conditional-formatting-builder.ts b/packages/sheets-conditional-formatting/src/facade/conditional-formatting-builder.ts
index d3ce209acf..e16b0359a8 100644
--- a/packages/sheets-conditional-formatting/src/facade/conditional-formatting-builder.ts
+++ b/packages/sheets-conditional-formatting/src/facade/conditional-formatting-builder.ts
@@ -21,6 +21,9 @@ import type { CFTimePeriodOperator, IAverageHighlightCell, IColorScale, IConditi
import { BooleanNumber, ColorKit, Tools } from '@univerjs/core';
import { CFNumberOperator, CFRuleType, CFSubRuleType, CFTextOperator, CFValueType, createCfId, EMPTY_ICON_TYPE, iconMap } from '@univerjs/sheets-conditional-formatting';
+/**
+ * @hideconstructor
+ */
class ConditionalFormatRuleBaseBuilder {
protected _rule: Partial<IConditionFormattingRule> = {};
@@ -155,6 +158,9 @@ class ConditionalFormatRuleBaseBuilder {
}
}
+/**
+ * @hideconstructor
+ */
class ConditionalFormatHighlightRuleBuilder extends ConditionalFormatRuleBaseBuilder {
constructor(initConfig: Partial<IConditionFormattingRule> = {}) {
super(initConfig);
@@ -639,6 +645,9 @@ class ConditionalFormatIconSetRuleBuilder extends ConditionalFormatRuleBaseBuild
}
}
+/**
+ * @hideconstructor
+ */
export class FConditionalFormattingBuilder {
constructor(private _initConfig: { ranges?: IRange[] } = {}) {
diff --git a/packages/sheets-crosshair-highlight/src/facade/f-univer.ts b/packages/sheets-crosshair-highlight/src/facade/f-univer.ts
index 88d474c432..be67a3adb8 100644
--- a/packages/sheets-crosshair-highlight/src/facade/f-univer.ts
+++ b/packages/sheets-crosshair-highlight/src/facade/f-univer.ts
@@ -142,6 +142,9 @@ export interface IFUniverCrosshairHighlightMixin {
}
export class FUniverCrosshairHighlightMixin extends FUniver implements IFUniverCrosshairHighlightMixin {
+ /**
+ * @ignore
+ */
override _initialize(injector: Injector): void {
const commandService = injector.get(ICommandService);
diff --git a/packages/sheets-data-validation/src/facade/f-data-validation-builder.ts b/packages/sheets-data-validation/src/facade/f-data-validation-builder.ts
index b1728314b1..829071d9fe 100644
--- a/packages/sheets-data-validation/src/facade/f-data-validation-builder.ts
+++ b/packages/sheets-data-validation/src/facade/f-data-validation-builder.ts
@@ -29,6 +29,7 @@ import { FDataValidation } from './f-data-validation';
* const rule = FUniver.newDataValidation().requireValueInRange(range).build();
* cell.setDataValidation(rule);
* ```
+ * @hideconstructor
*/
export class FDataValidationBuilder {
private _rule: IDataValidationRule;
diff --git a/packages/sheets-data-validation/src/facade/f-data-validation.ts b/packages/sheets-data-validation/src/facade/f-data-validation.ts
index 9d926825c0..c605a9094e 100644
--- a/packages/sheets-data-validation/src/facade/f-data-validation.ts
+++ b/packages/sheets-data-validation/src/facade/f-data-validation.ts
@@ -22,6 +22,9 @@ import { RemoveSheetDataValidationCommand, UpdateSheetDataValidationOptionsComma
import { FRange } from '@univerjs/sheets/facade';
import { FDataValidationBuilder } from './f-data-validation-builder';
+/**
+ * @hideconstructor
+ */
export class FDataValidation {
rule: IDataValidationRule;
private _worksheet: Worksheet | undefined;
diff --git a/packages/sheets-data-validation/src/facade/f-univer.ts b/packages/sheets-data-validation/src/facade/f-univer.ts
index 4c6eff11b5..7a61e4296e 100644
--- a/packages/sheets-data-validation/src/facade/f-univer.ts
+++ b/packages/sheets-data-validation/src/facade/f-univer.ts
@@ -45,6 +45,9 @@ export class FUnvierDataValidationMixin extends FUniver {
return new FDataValidationBuilder();
}
+ /**
+ * @ignore
+ */
// eslint-disable-next-line max-lines-per-function
override _initialize(injector: Injector): void {
if (!injector.has(SheetDataValidationModel)) return;
diff --git a/packages/sheets-drawing-ui/src/facade/f-over-grid-image.ts b/packages/sheets-drawing-ui/src/facade/f-over-grid-image.ts
index 916c0912e5..476f8616af 100644
--- a/packages/sheets-drawing-ui/src/facade/f-over-grid-image.ts
+++ b/packages/sheets-drawing-ui/src/facade/f-over-grid-image.ts
@@ -97,6 +97,9 @@ function convertFOverGridImageToSheetImage(fOverGridImage: IFOverGridImage, sele
};
}
+/**
+ * @hideconstructor
+ */
export class FOverGridImageBuilder {
private _image: IFOverGridImage;
constructor(
@@ -487,6 +490,9 @@ export class FOverGridImageBuilder {
}
}
+/**
+ * @hideconstructor
+ */
export class FOverGridImage extends FBase {
constructor(
private _image: ISheetImage,
diff --git a/packages/sheets-drawing-ui/src/facade/f-univer.ts b/packages/sheets-drawing-ui/src/facade/f-univer.ts
index a334d7dc33..38cf486ad3 100644
--- a/packages/sheets-drawing-ui/src/facade/f-univer.ts
+++ b/packages/sheets-drawing-ui/src/facade/f-univer.ts
@@ -45,7 +45,13 @@ interface IBeforeOverGridImageSelectParam extends IEventBase {
oldSelectedImages: FOverGridImage[];
}
+/**
+ * @ignore
+ */
export class FUniverDrawingMixin extends FUniver {
+ /**
+ * @ignore
+ */
override _initialize(injector: Injector): void {
const commandService = injector.get(ICommandService);
this.disposeWithMe(commandService.beforeCommandExecuted((commandInfo) => {
diff --git a/packages/sheets-filter/src/facade/f-event.ts b/packages/sheets-filter/src/facade/f-event.ts
index 811b1cb53e..6850de6c65 100644
--- a/packages/sheets-filter/src/facade/f-event.ts
+++ b/packages/sheets-filter/src/facade/f-event.ts
@@ -126,6 +126,9 @@ declare module '@univerjs/core' {
}
class FUniverSheetsFilterEventMixin extends FUniver {
+ /**
+ * @ignore
+ */
override _initialize(injector: Injector): void {
const commandService = injector.get(ICommandService);
diff --git a/packages/sheets-filter/src/facade/f-filter.ts b/packages/sheets-filter/src/facade/f-filter.ts
index 52cd3a74ea..43cdb6e935 100644
--- a/packages/sheets-filter/src/facade/f-filter.ts
+++ b/packages/sheets-filter/src/facade/f-filter.ts
@@ -24,6 +24,7 @@ import { FRange } from '@univerjs/sheets/facade';
/**
* This interface class provides methods to modify the filter settings of a worksheet.
+ * @hideconstructor
*/
export class FFilter {
constructor(
diff --git a/packages/sheets-find-replace/src/facade/f-text-finder.ts b/packages/sheets-find-replace/src/facade/f-text-finder.ts
index d37c890f7c..23a31349bc 100644
--- a/packages/sheets-find-replace/src/facade/f-text-finder.ts
+++ b/packages/sheets-find-replace/src/facade/f-text-finder.ts
@@ -154,6 +154,7 @@ export interface IFTextFinder {
/**
* This interface class provides methods to find and replace text in the univer.
+ * @hideconstructor
*/
export class FTextFinder extends Disposable implements IFTextFinder {
private readonly _state = new FindReplaceState();
diff --git a/packages/sheets-formula/src/facade/f-formula.ts b/packages/sheets-formula/src/facade/f-formula.ts
index e9273c81f5..a3ad7a4ce2 100644
--- a/packages/sheets-formula/src/facade/f-formula.ts
+++ b/packages/sheets-formula/src/facade/f-formula.ts
@@ -201,7 +201,7 @@ export class FFormulaSheetsMixin extends FFormula implements IFFormulaSheetsMixi
/**
* Initialize the FUniver instance.
- * @private
+ * @ignore
*/
override _initialize(): void {
this._debouncedFormulaCalculation = debounce(() => {
diff --git a/packages/sheets-formula/src/facade/f-univer.ts b/packages/sheets-formula/src/facade/f-univer.ts
index 374c835bf8..1aae40ff01 100644
--- a/packages/sheets-formula/src/facade/f-univer.ts
+++ b/packages/sheets-formula/src/facade/f-univer.ts
@@ -37,7 +37,7 @@ export class FUniverSheetsFormulaMixin extends FUniver implements IFUniverSheets
/**
* Initialize the FUniver instance.
- * @private
+ * @ignore
*/
override _initialize(): void {
this._debouncedFormulaCalculation = debounce(() => {
diff --git a/packages/sheets-hyper-link/src/facade/f-univer.ts b/packages/sheets-hyper-link/src/facade/f-univer.ts
index 6f97095416..f397c9e947 100644
--- a/packages/sheets-hyper-link/src/facade/f-univer.ts
+++ b/packages/sheets-hyper-link/src/facade/f-univer.ts
@@ -21,6 +21,9 @@ import { CanceledError, FUniver, ICommandService } from '@univerjs/core';
import { AddHyperLinkCommand, CancelHyperLinkCommand, UpdateHyperLinkCommand } from '@univerjs/sheets-hyper-link';
export class FSheetLinkUniver extends FUniver {
+ /**
+ * @ignore
+ */
override _initialize(injector: Injector): void {
const commandService = injector.get(ICommandService);
diff --git a/packages/sheets-hyper-link/src/facade/f-workbook.ts b/packages/sheets-hyper-link/src/facade/f-workbook.ts
index b28e6b88ff..9eed858a21 100644
--- a/packages/sheets-hyper-link/src/facade/f-workbook.ts
+++ b/packages/sheets-hyper-link/src/facade/f-workbook.ts
@@ -20,6 +20,9 @@ import { Inject, type IRange } from '@univerjs/core';
import { SheetsHyperLinkParserService } from '@univerjs/sheets-hyper-link';
import { FWorkbook } from '@univerjs/sheets/facade';
+/**
+ * @hideconstructor
+ */
export class SheetHyperLinkBuilder {
constructor(
private _workbook: FWorkbook,
diff --git a/packages/sheets-sort/src/facade/f-event.ts b/packages/sheets-sort/src/facade/f-event.ts
index 9ded2e8427..20f4b4ecca 100644
--- a/packages/sheets-sort/src/facade/f-event.ts
+++ b/packages/sheets-sort/src/facade/f-event.ts
@@ -81,6 +81,9 @@ declare module '@univerjs/core' {
}
class FUniverSheetsSortEventMixin extends FUniver {
+ /**
+ * @ignore
+ */
override _initialize(injector: Injector): void {
const commandService = injector.get(ICommandService);
diff --git a/packages/sheets-thread-comment/src/facade/f-thread-comment.ts b/packages/sheets-thread-comment/src/facade/f-thread-comment.ts
index fbf74e87d3..c83e66754a 100644
--- a/packages/sheets-thread-comment/src/facade/f-thread-comment.ts
+++ b/packages/sheets-thread-comment/src/facade/f-thread-comment.ts
@@ -244,6 +244,9 @@ export class FTheadCommentBuilder extends FTheadCommentItem {
}
}
+/**
+ * @hideconstructor
+ */
export class FThreadComment {
constructor(
private readonly _thread: IThreadComment | IBaseComment,
diff --git a/packages/sheets-thread-comment/src/facade/f-univer.ts b/packages/sheets-thread-comment/src/facade/f-univer.ts
index ad2d4df750..5a378e830e 100644
--- a/packages/sheets-thread-comment/src/facade/f-univer.ts
+++ b/packages/sheets-thread-comment/src/facade/f-univer.ts
@@ -232,6 +232,9 @@ export class FUniverCommentMixin extends FUniver implements IFUniverCommentMixin
}
}
+ /**
+ * @ignore
+ */
override _initialize(injector: Injector): void {
const commandService = injector.get(ICommandService);
this.disposeWithMe(
diff --git a/packages/sheets-thread-comment/src/facade/f-workbook.ts b/packages/sheets-thread-comment/src/facade/f-workbook.ts
index b632693e0a..44c17b1ceb 100644
--- a/packages/sheets-thread-comment/src/facade/f-workbook.ts
+++ b/packages/sheets-thread-comment/src/facade/f-workbook.ts
@@ -81,6 +81,9 @@ export interface IFWorkbookThreadCommentMixin {
export class FWorkbookThreadCommentMixin extends FWorkbook implements IFWorkbookThreadCommentMixin {
declare _threadCommentModel: ThreadCommentModel;
+ /**
+ * @ignore
+ */
override _initialize(): void {
Object.defineProperty(this, '_threadCommentModel', {
get() {
diff --git a/packages/sheets-ui/src/facade/f-univer.ts b/packages/sheets-ui/src/facade/f-univer.ts
index 28c8244bba..d650872473 100644
--- a/packages/sheets-ui/src/facade/f-univer.ts
+++ b/packages/sheets-ui/src/facade/f-univer.ts
@@ -583,6 +583,9 @@ export class FUniverSheetsUIMixin extends FUniver implements IFUniverSheetsUIMix
});
}
+ /**
+ * @ignore
+ */
override _initialize(injector: Injector): void {
this._initSheetUIEvent(injector);
const commandService = injector.get(ICommandService);
diff --git a/packages/sheets-zen-editor/src/facade/f-univer.ts b/packages/sheets-zen-editor/src/facade/f-univer.ts
index 9bd97989b3..b4a2bfb685 100644
--- a/packages/sheets-zen-editor/src/facade/f-univer.ts
+++ b/packages/sheets-zen-editor/src/facade/f-univer.ts
@@ -159,6 +159,9 @@ export class FUniverSheetsZenEditorMixin extends FUniver implements IFUniverShee
}));
}
+ /**
+ * @ignore
+ */
override _initialize(injector: Injector): void {
this._initSheetZenEditorEvent(injector);
}
diff --git a/packages/sheets/src/facade/f-defined-name.ts b/packages/sheets/src/facade/f-defined-name.ts
index 7412984536..29b272e77a 100644
--- a/packages/sheets/src/facade/f-defined-name.ts
+++ b/packages/sheets/src/facade/f-defined-name.ts
@@ -48,6 +48,9 @@ function getDefinedNameFieldName(unitId: string, localeService: LocaleService, d
}
}
+/**
+ * @hideconstructor
+ */
export class FDefinedNameBuilder {
private _definedNameParam: ISetDefinedNameMutationParam;
constructor() {
@@ -199,6 +202,9 @@ export class FDefinedNameBuilder {
}
}
+/**
+ * @hideconstructor
+ */
export class FDefinedName extends FBase {
constructor(
protected _definedNameParam: ISetDefinedNameMutationParam,
diff --git a/packages/sheets/src/facade/f-permission.ts b/packages/sheets/src/facade/f-permission.ts
index e6122524a5..59a2d7939e 100644
--- a/packages/sheets/src/facade/f-permission.ts
+++ b/packages/sheets/src/facade/f-permission.ts
@@ -19,6 +19,9 @@ import type { Observable } from 'rxjs';
import { FBase, generateRandomId, IAuthzIoService, ICommandService, Inject, Injector, IPermissionService, Rectangle } from '@univerjs/core';
import { AddRangeProtectionMutation, AddWorksheetProtectionMutation, DeleteRangeProtectionMutation, DeleteWorksheetProtectionMutation, getAllWorksheetPermissionPoint, getAllWorksheetPermissionPointByPointPanel, PermissionPointsDefinitions, RangeProtectionRuleModel, SetRangeProtectionMutation, SetWorksheetPermissionPointsMutation, UnitObject, WorkbookEditablePermission, WorksheetEditPermission, WorksheetProtectionPointModel, WorksheetProtectionRuleModel, WorksheetViewPermission } from '@univerjs/sheets';
+/**
+ * @hideconstructor
+ */
export class FPermission extends FBase {
public permissionPointsDefinition = PermissionPointsDefinitions;
public rangeRuleChangedAfterAuth$: Observable<unknown>;
diff --git a/packages/sheets/src/facade/f-range.ts b/packages/sheets/src/facade/f-range.ts
index c121405c17..864ba39175 100644
--- a/packages/sheets/src/facade/f-range.ts
+++ b/packages/sheets/src/facade/f-range.ts
@@ -27,6 +27,9 @@ export type FontLine = 'none' | 'underline' | 'line-through';
export type FontStyle = 'normal' | 'italic';
export type FontWeight = 'normal' | 'bold';
+/**
+ * @hideconstructor
+ */
export class FRange extends FBaseInitialable {
constructor(
protected readonly _workbook: Workbook,
diff --git a/packages/sheets/src/facade/f-selection.ts b/packages/sheets/src/facade/f-selection.ts
index 2dfc71ba74..b4188a2868 100644
--- a/packages/sheets/src/facade/f-selection.ts
+++ b/packages/sheets/src/facade/f-selection.ts
@@ -33,6 +33,7 @@ import { FWorksheet } from './f-worksheet';
* const activeRange = fSelection.getActiveRange();
* console.log(activeRange);
* ```
+ * @hideconstructor
*/
export class FSelection {
constructor(
diff --git a/packages/sheets/src/facade/f-sheet-hooks.ts b/packages/sheets/src/facade/f-sheet-hooks.ts
index c0b70ea111..f15ef3710e 100644
--- a/packages/sheets/src/facade/f-sheet-hooks.ts
+++ b/packages/sheets/src/facade/f-sheet-hooks.ts
@@ -16,6 +16,9 @@
import { FBase, Inject, Injector } from '@univerjs/core';
+/**
+ * @hideconstructor
+ */
export class FSheetHooks extends FBase {
constructor(
@Inject(Injector) protected readonly _injector: Injector
diff --git a/packages/sheets/src/facade/f-univer.ts b/packages/sheets/src/facade/f-univer.ts
index 9af28287b0..b150bceca5 100644
--- a/packages/sheets/src/facade/f-univer.ts
+++ b/packages/sheets/src/facade/f-univer.ts
@@ -196,6 +196,9 @@ export class FUniverSheetsMixin extends FUniver implements IFUniverSheetsMixin {
);
}
+ /**
+ * @ignore
+ */
// eslint-disable-next-line max-lines-per-function
override _initialize(injector: Injector): void {
const commandService = injector.get(ICommandService);
diff --git a/packages/sheets/src/facade/f-workbook.ts b/packages/sheets/src/facade/f-workbook.ts
index be1a8ce0e4..9db80b2b03 100644
--- a/packages/sheets/src/facade/f-workbook.ts
+++ b/packages/sheets/src/facade/f-workbook.ts
@@ -26,6 +26,9 @@ import { FPermission } from './f-permission';
import { FRange } from './f-range';
import { FWorksheet } from './f-worksheet';
+/**
+ * @hideconstructor
+ */
export class FWorkbook extends FBaseInitialable {
readonly id: string;
diff --git a/packages/sheets/src/facade/f-worksheet.ts b/packages/sheets/src/facade/f-worksheet.ts
index da1f51dca7..0f88fa4c47 100644
--- a/packages/sheets/src/facade/f-worksheet.ts
+++ b/packages/sheets/src/facade/f-worksheet.ts
@@ -33,6 +33,7 @@ interface IFacadeClearOptions {
/**
* Represents a worksheet facade api instance. Which provides a set of methods to interact with the worksheet.
+ * @hideconstructor
*/
export class FWorksheet extends FBaseInitialable {
/**
diff --git a/packages/ui/src/facade/f-menu-builder.ts b/packages/ui/src/facade/f-menu-builder.ts
index 631e2574b1..03d03a9b89 100644
--- a/packages/ui/src/facade/f-menu-builder.ts
+++ b/packages/ui/src/facade/f-menu-builder.ts
@@ -76,6 +76,7 @@ type FAllMenu = FMenu | FSubmenu;
* This is a build for adding a menu to Univer. Please notice that until the `appendTo` method is called,
* the menu item is not added to the UI. Please note that this menu cannot have submenus. If you want to
* have submenus, please use `FSubmenu`.
+ * @hideconstructor
*/
export class FMenu extends FBase {
static RibbonStartGroup = RibbonStartGroup;
@@ -145,6 +146,9 @@ export class FMenu extends FBase {
}
}
+/**
+ * @hideconstructor
+ */
export class FSubmenu extends FBase {
private _menuByGroups: FAllMenu[][] = [];
private _submenus: FAllMenu[] = [];
diff --git a/packages/ui/src/facade/f-shortcut.ts b/packages/ui/src/facade/f-shortcut.ts
index 927a3175be..2e5a9386a0 100644
--- a/packages/ui/src/facade/f-shortcut.ts
+++ b/packages/ui/src/facade/f-shortcut.ts
@@ -19,6 +19,9 @@ import type { IShortcutItem } from '@univerjs/ui';
import { FBase, Inject, Injector } from '@univerjs/core';
import { IShortcutService } from '@univerjs/ui';
+/**
+ * @hideconstructor
+ */
export class FShortcut extends FBase {
private _forceEscapeDisposable: IDisposable | null = null;