fix: add ignore comments for facade

dream-num · Jan 23, 2025 · de6fd45 · de6fd45
1 parent bfd9ba4
commit de6fd45
Show file tree

Hide file tree

Showing 32 changed files with 232 additions and 143 deletions.
diff --git a/packages/core/src/facade/f-event.ts b/packages/core/src/facade/f-event.ts
@@ -23,6 +23,7 @@ import type { FDoc } from './f-doc';
 /**
  * Base interface for all event parameters
  * @interface IEventBase
+ * @ignore
  */
 export interface IEventBase {
     /** Flag to cancel the event if supported */

diff --git a/packages/docs-ui/src/facade/f-univer.ts b/packages/docs-ui/src/facade/f-univer.ts
@@ -18,6 +18,9 @@ import type { DocumentDataModel, IDocumentData } from '@univerjs/core';
 import { FUniver, UniverInstanceType } from '@univerjs/core';
 import { FDocument } from './f-document';
 
+/**
+ * @ignore
+ */
 export interface IFUniverDocsUIMixin {
     /**
      * Create a new document and get the API handler of that document.

diff --git a/packages/engine-formula/src/facade/f-univer.ts b/packages/engine-formula/src/facade/f-univer.ts
@@ -17,6 +17,9 @@
 import { FUniver } from '@univerjs/core';
 import { FFormula } from './f-formula';
 
+/**
+ * @ignore
+ */
 export interface IFUniverEngineFormulaMixin {
     getFormula(): FFormula;
 }

diff --git a/packages/network/src/facade/f-univer.ts b/packages/network/src/facade/f-univer.ts
@@ -17,7 +17,9 @@
 import { FUniver } from '@univerjs/core';
 import { FNetwork } from './f-network';
 
-/** @ignore */
+/**
+ * @ignore
+ */
 interface IFUniverNetworkMixin {
     /**
      * Get the network API of Univer, with the help of which you can send HTTP requests.

diff --git a/packages/sheets-conditional-formatting/src/facade/f-range.ts b/packages/sheets-conditional-formatting/src/facade/f-range.ts
@@ -34,6 +34,9 @@ import {
 import { FRange } from '@univerjs/sheets/facade';
 import { FConditionalFormattingBuilder } from './conditional-formatting-builder';
 
+/**
+ * @ignore
+ */
 export interface IFRangeConditionalFormattingMixin {
 
     /**

diff --git a/packages/sheets-conditional-formatting/src/facade/f-workbook.ts b/packages/sheets-conditional-formatting/src/facade/f-workbook.ts
@@ -17,6 +17,9 @@
 import { ColorBuilder } from '@univerjs/core';
 import { FWorkbook } from '@univerjs/sheets/facade';
 
+/**
+ * @ignore
+ */
 export interface IFWorkbookConditionalFormattingMixin {
     /**
      * @deprecated use `univerAPI.newColor()` as instead.

diff --git a/packages/sheets-conditional-formatting/src/facade/f-worksheet.ts b/packages/sheets-conditional-formatting/src/facade/f-worksheet.ts
@@ -32,6 +32,9 @@ import {
 import { FWorksheet } from '@univerjs/sheets/facade';
 import { FConditionalFormattingBuilder } from './conditional-formatting-builder';
 
+/**
+ * @ignore
+ */
 export interface IFWorksheetConditionalFormattingMixin {
 
     /**

diff --git a/packages/sheets-data-validation/src/facade/f-data-validation.ts b/packages/sheets-data-validation/src/facade/f-data-validation.ts
@@ -42,10 +42,10 @@ export class FDataValidation {
      * @example
      * ```typescript
      * const dataValidation = univerAPI
-     *  .getActiveWorkbook()
-     *  .getActiveWorksheet()
-     *  .getActiveRange()
-     *  .getDataValidation();
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
      * const allowsInvalid = dataValidation.getAllowInvalid();
      * ```
      */
@@ -59,10 +59,10 @@ export class FDataValidation {
      * @example
      * ```typescript
      * const dataValidation = univerAPI
-     *  .getActiveWorkbook()
-     *  .getActiveWorksheet()
-     *  .getActiveRange()
-     *  .getDataValidation();
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
      * const type = dataValidation.getCriteriaType();
      * ```
      */
@@ -76,10 +76,10 @@ export class FDataValidation {
      * @example
      * ```typescript
      * const dataValidation = univerAPI
-     *  .getActiveWorkbook()
-     *  .getActiveWorksheet()
-     *  .getActiveRange()
-     *  .getDataValidation();
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
      * const [operator, formula1, formula2] = dataValidation.getCriteriaValues();
      * ```
      */
@@ -93,10 +93,10 @@ export class FDataValidation {
      * @example
      * ```typescript
      * const dataValidation = univerAPI
-     *  .getActiveWorkbook()
-     *  .getActiveWorksheet()
-     *  .getActiveRange()
-     *  .getDataValidation();
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
      * const helpText = dataValidation.getHelpText();
      * ```
      */
@@ -110,10 +110,10 @@ export class FDataValidation {
      * @example
      * ```typescript
      * const dataValidation = univerAPI
-     *  .getActiveWorkbook()
-     *  .getActiveWorksheet()
-     *  .getActiveRange()
-     *  .getDataValidation();
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
      * const builder = dataValidation.copy();
      * const newRule = builder.setAllowInvalid(true).build();
      * ```
@@ -128,10 +128,10 @@ export class FDataValidation {
      * @example
      * ```typescript
      * const dataValidation = univerAPI
-     *  .getActiveWorkbook()
-     *  .getActiveWorksheet()
-     *  .getActiveRange()
-     *  .getDataValidation();
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
      * const isApplied = dataValidation.getApplied();
      * ```
      */
@@ -155,10 +155,10 @@ export class FDataValidation {
      * @example
      * ```typescript
      * const dataValidation = univerAPI
-     *  .getActiveWorkbook()
-     *  .getActiveWorksheet()
-     *  .getActiveRange()
-     *  .getDataValidation();
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
      * const ranges = dataValidation.getRanges();
      * ```
      */
@@ -177,10 +177,10 @@ export class FDataValidation {
      * @example
      * ```typescript
      * const dataValidation = univerAPI
-     *  .getActiveWorkbook()
-     *  .getActiveWorksheet()
-     *  .getActiveRange()
-     *  .getDataValidation();
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
      * const unitId = dataValidation.getUnitId();
      * ```
      */
@@ -194,10 +194,10 @@ export class FDataValidation {
      * @example
      * ```typescript
      * const dataValidation = univerAPI
-     *  .getActiveWorkbook()
-     *  .getActiveWorksheet()
-     *  .getActiveRange()
-     *  .getDataValidation();
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
      * const sheetId = dataValidation.getSheetId();
      * ```
      */
@@ -214,10 +214,10 @@ export class FDataValidation {
      * @example
      * ```typescript
      * const dataValidation = univerAPI
-     *  .getActiveWorkbook()
-     *  .getActiveWorksheet()
-     *  .getActiveRange()
-     *  .getDataValidation();
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
      * dataValidation.setCriteria(
      *   DataValidationType.DECIMAL,
      *   [DataValidationOperator.BETWEEN, '1', '10'],
@@ -262,10 +262,10 @@ export class FDataValidation {
      * @example
      * ```typescript
      * const dataValidation = univerAPI
-     *  .getActiveWorkbook()
-     *  .getActiveWorksheet()
-     *  .getActiveRange()
-     *  .getDataValidation();
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
      * dataValidation.setOptions({
      *   allowBlank: true,
      *   showErrorMessage: true,
@@ -302,10 +302,10 @@ export class FDataValidation {
      * @example
      * ```typescript
      * const dataValidation = univerAPI
-     *  .getActiveWorkbook()
-     *  .getActiveWorksheet()
-     *  .getActiveRange()
-     *  .getDataValidation();
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
      * const range = FRange.create('Sheet1', 'A1:B10');
      * dataValidation.setRanges([range]);
      * ```
@@ -335,10 +335,10 @@ export class FDataValidation {
      * @example
      * ```typescript
      * const dataValidation = univerAPI
-     *  .getActiveWorkbook()
-     *  .getActiveWorksheet()
-     *  .getActiveRange()
-     *  .getDataValidation();
+     *   .getActiveWorkbook()
+     *   .getActiveWorksheet()
+     *   .getActiveRange()
+     *   .getDataValidation();
      * const isDeleted = dataValidation.delete();
      * ```
      */

diff --git a/packages/sheets-data-validation/src/facade/f-univer.ts b/packages/sheets-data-validation/src/facade/f-univer.ts
@@ -25,14 +25,7 @@ import { FDataValidationBuilder } from './f-data-validation-builder';
 /**
  * @ignore
  */
-export class FUnvierDataValidationMixin extends FUniver {
-    /**
-     * @deprecated use `univerAPI.newDataValidation()` as instead.
-     */
-    static override newDataValidation(): FDataValidationBuilder {
-        return new FDataValidationBuilder();
-    }
-
+export interface IFUnvierDataValidationMixin {
     /**
      * Creates a new instance of FDataValidationBuilder
      * @returns {FDataValidationBuilder} A new instance of the FDataValidationBuilder class
@@ -42,7 +35,19 @@ export class FUnvierDataValidationMixin extends FUniver {
      * cell.setDataValidation(rule.requireValueInRange(range));
      * ```
      */
-    newDataValidation(): FDataValidationBuilder {
+    newDataValidation(): FDataValidationBuilder;
+}
+
+export class FUnvierDataValidationMixin extends FUniver implements IFUnvierDataValidationMixin {
+    /**
+     * @deprecated use `univerAPI.newDataValidation()` as instead.
+     * @returns {FDataValidationBuilder} A new instance of the FDataValidationBuilder class
+     */
+    static newDataValidation(): FDataValidationBuilder {
+        return new FDataValidationBuilder();
+    }
+
+    override newDataValidation(): FDataValidationBuilder {
         return new FDataValidationBuilder();
     }
 
@@ -245,11 +250,6 @@ export class FUnvierDataValidationMixin extends FUniver {
 
 FUniver.extend(FUnvierDataValidationMixin);
 declare module '@univerjs/core' {
-    /**
-     * @ignore
-     */
-    // eslint-disable-next-line ts/no-namespace
-    namespace FUniver {
-        function newDataValidation(): FDataValidationBuilder;
-    }
+    // eslint-disable-next-line ts/naming-convention
+    interface FUniver extends IFUnvierDataValidationMixin {}
 }
diff --git a/packages/sheets-filter/src/facade/f-enum.ts b/packages/sheets-filter/src/facade/f-enum.ts
@@ -17,6 +17,9 @@
 import { FEnum } from '@univerjs/core';
 import { CustomFilterOperator } from '@univerjs/sheets-filter';
 
+/**
+ * @ignore
+ */
 export interface IFSheetsFilterEnumMixin {
     /** Please refer to {@link CustomFilterOperator}. */
     CustomFilterOperator: typeof CustomFilterOperator;

diff --git a/packages/sheets-filter/src/facade/f-event.ts b/packages/sheets-filter/src/facade/f-event.ts
@@ -21,6 +21,9 @@ import { FEventName, FUniver, ICommandService } from '@univerjs/core';
 import { ClearSheetsFilterCriteriaCommand, SetSheetsFilterCriteriaCommand } from '@univerjs/sheets-filter';
 import { FSheetEventName } from '@univerjs/sheets/facade';
 
+/**
+ * @ignore
+ */
 export interface IFSheetFilterEventMixin {
     /**
      * This event will be emitted when the filter criteria on a column is changed.

diff --git a/packages/sheets-filter/src/facade/f-range.ts b/packages/sheets-filter/src/facade/f-range.ts
@@ -22,6 +22,9 @@ import { FFilter } from './f-filter';
 
 // TODO: add jsdoc comments for the following API
 
+/**
+ * @ignore
+ */
 export interface IFRangeFilter {
     /**
      * Create a filter for the current range. If the worksheet already has a filter, this method would return `null`.

diff --git a/packages/sheets-formula/src/facade/f-formula.ts b/packages/sheets-formula/src/facade/f-formula.ts
@@ -23,6 +23,9 @@ import { SetFormulaCalculationStartMutation } from '@univerjs/engine-formula';
 import { FFormula } from '@univerjs/engine-formula/facade';
 import { IRegisterFunctionService, PLUGIN_CONFIG_KEY_BASE, RegisterFunctionService } from '@univerjs/sheets-formula';
 
+/**
+ * @ignore
+ */
 export interface IFFormulaSheetsMixin {
     /**
      * Update the calculation mode of the formula.

diff --git a/packages/sheets-formula/src/facade/f-univer.ts b/packages/sheets-formula/src/facade/f-univer.ts
@@ -19,6 +19,9 @@ import { debounce, FUniver } from '@univerjs/core';
 import { SetFormulaCalculationStartMutation } from '@univerjs/engine-formula';
 import { type IRegisterFunctionParams, IRegisterFunctionService, RegisterFunctionService } from '@univerjs/sheets-formula';
 
+/**
+ * @ignore
+ */
 export interface IFUniverSheetsFormulaMixin {
     /**
      * Register a function to the spreadsheet.
@@ -29,6 +32,9 @@ export interface IFUniverSheetsFormulaMixin {
     registerFunction(config: IRegisterFunctionParams): IDisposable;
 }
 
+/**
+ * @ignore
+ */
 export class FUniverSheetsFormulaMixin extends FUniver implements IFUniverSheetsFormulaMixin {
     /**
      * RegisterFunction may be executed multiple times, triggering multiple formula forced refreshes.