@univerjs/sheets-conditional-formatting 0.5.3 → 0.5.4

package/lib/es/facade.js

@@ -1,12 +1,12 @@
 var N = Object.defineProperty;
 var q = (u, e, t) => e in u ? N(u, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : u[e] = t;
-var y = (u, e, t) => q(u, typeof e != "symbol" ? e + "" : e, t);
+var b = (u, e, t) => q(u, typeof e != "symbol" ? e + "" : e, t);
 import { ColorKit as c, Tools as _, BooleanNumber as a, Rectangle as U, ColorBuilder as B } from "@univerjs/core";
-import { CFRuleType as n, CFNumberOperator as l, CFValueType as C, EMPTY_ICON_TYPE as f, CFSubRuleType as o, CFTextOperator as g, createCfId as b, iconMap as M, ConditionalFormattingRuleModel as T, AddConditionalRuleMutation as x, DeleteConditionalRuleMutation as S, MoveConditionalRuleMutation as I, SetConditionalRuleMutation as E } from "@univerjs/sheets-conditional-formatting";
-import { FRange as v, FWorkbook as k, FWorksheet as F } from "@univerjs/sheets/facade";
+import { CFRuleType as n, CFNumberOperator as l, CFValueType as C, EMPTY_ICON_TYPE as f, CFSubRuleType as o, CFTextOperator as g, createCfId as T, iconMap as M, ConditionalFormattingRuleModel as x, AddConditionalRuleMutation as S, DeleteConditionalRuleMutation as I, MoveConditionalRuleMutation as E, SetConditionalRuleMutation as k } from "@univerjs/sheets-conditional-formatting";
+import { FRange as v, FWorkbook as F, FWorksheet as R } from "@univerjs/sheets/facade";
 class d {
   constructor(e = {}) {
-    y(this, "_rule", {});
+    b(this, "_rule", {});
     this._rule = e, this._ensureAttr(this._rule, ["rule"]);
   }
   get _ruleConfig() {
@@ -69,14 +69,13 @@ class d {
   }
   build() {
     var r;
-    this._rule.cfId || (this._rule.cfId = b()), this._rule.ranges || (this._rule.ranges = []), this._rule.stopIfTrue === void 0 && (this._rule.stopIfTrue = !1), (r = this._rule.rule) != null && r.type || (this._rule.rule.type = n.highlightCell, this._ensureAttr(this._rule, ["rule", "style"]));
+    this._rule.cfId || (this._rule.cfId = T()), this._rule.ranges || (this._rule.ranges = []), this._rule.stopIfTrue === void 0 && (this._rule.stopIfTrue = !1), (r = this._rule.rule) != null && r.type || (this._rule.rule.type = n.highlightCell, this._ensureAttr(this._rule, ["rule", "style"]));
     const e = this._getDefaultConfig(this._rule.rule.type);
     return { ...this._rule, rule: { ...e, ...this._rule.rule } };
   }
   /**
-   * deep clone a current builder.
-   *
-   * @return {*}
+   * Deep clone a current builder.
+   * @returns {*}
    * @memberof ConditionalFormatRuleBuilder
    */
   copy() {
@@ -84,7 +83,7 @@ class d {
   }
   /**
    * Gets the scope of the current conditional format
-   * @return {*}
+   * @returns {*}
    * @memberof ConditionalFormatRuleBuilder
    */
   getRanges() {
@@ -97,17 +96,17 @@ class d {
     return M;
   }
   /**
-   * create a conditional format ID.
-   * @return {*}
+   * Create a conditional format ID.
+   * @returns {*}
    * @memberof ConditionalFormatRuleBuilder
    */
   createCfId() {
-    return b();
+    return T();
   }
   /**
    * Sets the scope for conditional formatting
    * @param {IRange[]} ranges
-   * @return {*}
+   * @returns {*}
    * @memberof ConditionalFormatRuleBuilder
    */
   setRanges(e) {
@@ -123,7 +122,6 @@ class i extends d {
   }
   /**
    * Set average rule
-   *
    * @param {IAverageHighlightCell['operator']} operator
    * @memberof ConditionalFormatHighlightRuleBuilder
    */
@@ -133,7 +131,6 @@ class i extends d {
   }
   /**
    * Set uniqueValues rule
-   *
    * @memberof ConditionalFormatHighlightRuleBuilder
    */
   setUniqueValues() {
@@ -142,7 +139,6 @@ class i extends d {
   }
   /**
    * Set duplicateValues rule
-   *
    * @memberof ConditionalFormatHighlightRuleBuilder
    */
   setDuplicateValues() {
@@ -151,8 +147,10 @@ class i extends d {
   }
   /**
    * Set rank rule
-   *
    * @param {{ isBottom: boolean, isPercent: boolean, value: number }} config
+   * @param config.isBottom
+   * @param config.isPercent
+   * @param config.value
    * @memberof ConditionalFormatHighlightRuleBuilder
    */
   setRank(e) {
@@ -162,7 +160,7 @@ class i extends d {
   /**
    * Sets the background color
    * @param {string} [color]
-   * @return {*}
+   * @returns {*}
    * @memberof ConditionalFormatRuleBuilder
    */
   setBackground(e) {
@@ -179,7 +177,7 @@ class i extends d {
   /**
    * Set Bold
    * @param {boolean} isBold
-   * @return {*}
+   * @returns {*}
    * @memberof ConditionalFormatRuleBuilder
    */
   setBold(e) {
@@ -189,7 +187,7 @@ class i extends d {
   /**
    * Sets the font color
    * @param {string} [color]
-   * @return {*}
+   * @returns {*}
    * @memberof ConditionalFormatRuleBuilder
    */
   setFontColor(e) {
@@ -205,7 +203,7 @@ class i extends d {
   /**
    * Set the text to italic
    * @param {boolean} isItalic
-   * @return {*}
+   * @returns {*}
    * @memberof ConditionalFormatRuleBuilder
    */
   setItalic(e) {
@@ -215,7 +213,7 @@ class i extends d {
   /**
    * Set the strikethrough
    * @param {boolean} isStrikethrough
-   * @return {*}
+   * @returns {*}
    * @memberof ConditionalFormatRuleBuilder
    */
   setStrikethrough(e) {
@@ -225,7 +223,7 @@ class i extends d {
   /**
    * Set the underscore
    * @param {boolean} isUnderline
-   * @return {*}
+   * @returns {*}
    * @memberof ConditionalFormatRuleBuilder
    */
   setUnderline(e) {
@@ -241,7 +239,7 @@ class i extends d {
   }
   /**
    * Sets the conditional formatting rule to fire when the cell is not empty
-   * @return {*}
+   * @returns {*}
    * @memberof ConditionalFormatRuleBuilder
    */
   whenCellNotEmpty() {
@@ -250,9 +248,8 @@ class i extends d {
   }
   /**
    * Highlight when the date is in a time period, custom time is not supported.
-   *
    * @param {CFTimePeriodOperator} date
-   * @return {*}
+   * @returns {*}
    * @memberof ConditionalFormatRuleBuilder
    */
   whenDate(e) {
@@ -280,7 +277,6 @@ class i extends d {
   }
   /**
    * Sets the conditional formatting rule to fire when the number equals the given value
-   *
    * @param {number} value
    * @memberof ConditionalFormatRuleBuilder
    */
@@ -336,6 +332,7 @@ class i extends d {
   }
   /**
    * Sets the conditional formatting rule to fire when a number does not equal a given value.
+   * @param value
    * @memberof ConditionalFormatRuleBuilder
    */
   whenNumberNotEqualTo(e) {
@@ -388,13 +385,12 @@ class i extends d {
     return t.type = n.highlightCell, t.subType = o.text, t.value = e, t.operator = g.beginsWith, this;
   }
 }
-class m extends d {
+class w extends d {
   copy() {
-    return new m(_.deepClone(this._rule));
+    return new w(_.deepClone(this._rule));
   }
   /**
    * Data bar settings
-   *
    * @param {{
    *         min: IValueConfig;
    *         max: IValueConfig;
@@ -403,6 +399,12 @@ class m extends d {
    *         nativeColor: string;
    *         isShowValue?: boolean;
    *     }} config
+   * @param config.min
+   * @param config.max
+   * @param config.isGradient
+   * @param config.positiveColor
+   * @param config.nativeColor
+   * @param config.isShowValue
    * @memberof ConditionalFormatRuleBuilder
    */
   setDataBar(e) {
@@ -416,9 +418,9 @@ class m extends d {
     }, this;
   }
 }
-class w extends d {
+class p extends d {
   copy() {
-    return new w(_.deepClone(this._rule));
+    return new p(_.deepClone(this._rule));
   }
   /**
    * Color scale set
@@ -430,14 +432,16 @@ class w extends d {
     return t.type = n.colorScale, t.config = e, this;
   }
 }
-class p extends d {
+class y extends d {
   copy() {
-    return new p(_.deepClone(this._rule));
+    return new y(_.deepClone(this._rule));
   }
   /**
    *
    * Icon Set
    * @param {{ iconConfigs: IIconSet['config'], isShowValue: boolean }} config
+   * @param config.iconConfigs
+   * @param config.isShowValue
    * @memberof ConditionalFormatRuleBuilder
    */
   setIconSet(e) {
@@ -445,7 +449,7 @@ class p extends d {
     return t.type = n.iconSet, t.config = e.iconConfigs, t.isShowValue = e.isShowValue, this;
   }
 }
-class R {
+class m {
   constructor(e = {}) {
     this._initConfig = e;
   }
@@ -454,7 +458,6 @@ class R {
   }
   /**
    * Set average rule
-   *
    * @param {IAverageHighlightCell['operator']} operator
    * @memberof ConditionalFormatHighlightRuleBuilder
    */
@@ -463,7 +466,6 @@ class R {
   }
   /**
    * Set uniqueValues rule
-   *
    * @memberof ConditionalFormatHighlightRuleBuilder
    */
   setUniqueValues() {
@@ -471,7 +473,6 @@ class R {
   }
   /**
    * Set duplicateValues rule
-   *
    * @memberof ConditionalFormatHighlightRuleBuilder
    */
   setDuplicateValues() {
@@ -479,8 +480,10 @@ class R {
   }
   /**
    * Set rank rule
-   *
    * @param {{ isBottom: boolean, isPercent: boolean, value: number }} config
+   * @param config.isBottom
+   * @param config.isPercent
+   * @param config.value
    * @memberof ConditionalFormatHighlightRuleBuilder
    */
   setRank(e) {
@@ -490,10 +493,12 @@ class R {
    *
    * Set iconSet rule
    * @param {{ iconConfigs: IIconSet['config'], isShowValue: boolean }} config
+   * @param config.iconConfigs
+   * @param config.isShowValue
    * @memberof ConditionalFormatRuleBuilder
    */
   setIconSet(e) {
-    return new p(this._initConfig).setIconSet(e);
+    return new y(this._initConfig).setIconSet(e);
   }
   /**
    * Set colorScale rule
@@ -501,11 +506,10 @@ class R {
    * @memberof ConditionalFormatRuleBuilder
    */
   setColorScale(e) {
-    return new w(this._initConfig).setColorScale(e);
+    return new p(this._initConfig).setColorScale(e);
   }
   /**
    * Set dataBar rule
-   *
    * @param {{
    *         min: IValueConfig;
    *         max: IValueConfig;
@@ -514,15 +518,21 @@ class R {
    *         nativeColor: string;
    *         isShowValue?: boolean;
    *     }} config
+   * @param config.min
+   * @param config.max
+   * @param config.isGradient
+   * @param config.positiveColor
+   * @param config.nativeColor
+   * @param config.isShowValue
    * @memberof ConditionalFormatRuleBuilder
    */
   setDataBar(e) {
-    return new m(this._initConfig).setDataBar(e);
+    return new w(this._initConfig).setDataBar(e);
   }
   /**
    * Sets the background color
    * @param {string} [color]
-   * @return {*}
+   * @returns {*}
    * @memberof ConditionalFormatRuleBuilder
    */
   setBackground(e) {
@@ -531,7 +541,7 @@ class R {
   /**
    * Set Bold
    * @param {boolean} isBold
-   * @return {*}
+   * @returns {*}
    * @memberof ConditionalFormatRuleBuilder
    */
   setBold(e) {
@@ -540,7 +550,7 @@ class R {
   /**
    * Sets the font color
    * @param {string} [color]
-   * @return {*}
+   * @returns {*}
    * @memberof ConditionalFormatRuleBuilder
    */
   setFontColor(e) {
@@ -549,7 +559,7 @@ class R {
   /**
    * Set the text to italic
    * @param {boolean} isItalic
-   * @return {*}
+   * @returns {*}
    * @memberof ConditionalFormatRuleBuilder
    */
   setItalic(e) {
@@ -558,7 +568,7 @@ class R {
   /**
    * Set the strikethrough
    * @param {boolean} isStrikethrough
-   * @return {*}
+   * @returns {*}
    * @memberof ConditionalFormatRuleBuilder
    */
   setStrikethrough(e) {
@@ -567,7 +577,7 @@ class R {
   /**
    * Set the underscore
    * @param {boolean} isUnderline
-   * @return {*}
+   * @returns {*}
    * @memberof ConditionalFormatRuleBuilder
    */
   setUnderline(e) {
@@ -581,7 +591,7 @@ class R {
   }
   /**
    * Sets the conditional formatting rule to fire when the cell is not empty
-   * @return {*}
+   * @returns {*}
    * @memberof ConditionalFormatRuleBuilder
    */
   whenCellNotEmpty() {
@@ -589,9 +599,8 @@ class R {
   }
   /**
    * Highlight when the date is in a time period, custom time is not supported.
-   *
    * @param {CFTimePeriodOperator} date
-   * @return {*}
+   * @returns {*}
    * @memberof ConditionalFormatRuleBuilder
    */
   whenDate(e) {
@@ -616,7 +625,6 @@ class R {
   }
   /**
    * Sets the conditional formatting rule to fire when the number equals the given value
-   *
    * @param {number} value
    * @memberof ConditionalFormatRuleBuilder
    */
@@ -666,6 +674,7 @@ class R {
   }
   /**
    * Sets the conditional formatting rule to fire when a number does not equal a given value.
+   * @param value
    * @memberof ConditionalFormatRuleBuilder
    */
   whenNumberNotEqualTo(e) {
@@ -714,13 +723,13 @@ class R {
 }
 class A extends v {
   _getConditionalFormattingRuleModel() {
-    return this._injector.get(T);
+    return this._injector.get(x);
   }
   getConditionalFormattingRules() {
     return [...this._getConditionalFormattingRuleModel().getSubunitRules(this._workbook.getUnitId(), this._worksheet.getSheetId()) || []].filter((t) => t.ranges.some((r) => U.intersects(r, this._range)));
   }
   createConditionalFormattingRule() {
-    return new R({ ranges: [this._range] });
+    return new m({ ranges: [this._range] });
   }
   addConditionalFormattingRule(e) {
     const t = {
@@ -728,7 +737,7 @@ class A extends v {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId()
     };
-    return this._commandService.syncExecuteCommand(x.id, t), this;
+    return this._commandService.syncExecuteCommand(S.id, t), this;
   }
   deleteConditionalFormattingRule(e) {
     const t = {
@@ -736,7 +745,7 @@ class A extends v {
       subUnitId: this._worksheet.getSheetId(),
       cfId: e
     };
-    return this._commandService.syncExecuteCommand(S.id, t), this;
+    return this._commandService.syncExecuteCommand(I.id, t), this;
   }
   moveConditionalFormattingRule(e, t, r = "after") {
     const s = {
@@ -745,7 +754,7 @@ class A extends v {
       start: { id: e, type: "self" },
       end: { id: t, type: r }
     };
-    return this._commandService.syncExecuteCommand(I.id, s), this;
+    return this._commandService.syncExecuteCommand(E.id, s), this;
   }
   setConditionalFormattingRule(e, t) {
     const r = {
@@ -754,25 +763,28 @@ class A extends v {
       rule: t,
       cfId: e
     };
-    return this._commandService.syncExecuteCommand(E.id, r), this;
+    return this._commandService.syncExecuteCommand(k.id, r), this;
   }
 }
 v.extend(A);
-class D extends k {
+class D extends F {
   newColor() {
     return new B();
   }
 }
-k.extend(D);
-class V extends F {
+F.extend(D);
+class V extends R {
   _getConditionalFormattingRuleModel() {
-    return this._injector.get(T);
+    return this._injector.get(x);
   }
   getConditionalFormattingRules() {
     return [...this._getConditionalFormattingRuleModel().getSubunitRules(this._workbook.getUnitId(), this._worksheet.getSheetId()) || []];
   }
   createConditionalFormattingRule() {
-    return new R();
+    return new m();
+  }
+  newConditionalFormattingRule() {
+    return new m();
   }
   addConditionalFormattingRule(e) {
     const t = {
@@ -780,7 +792,7 @@ class V extends F {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId()
     };
-    return this._commandService.syncExecuteCommand(x.id, t), this;
+    return this._commandService.syncExecuteCommand(S.id, t), this;
   }
   deleteConditionalFormattingRule(e) {
     const t = {
@@ -788,7 +800,7 @@ class V extends F {
       subUnitId: this._worksheet.getSheetId(),
       cfId: e
     };
-    return this._commandService.syncExecuteCommand(S.id, t), this;
+    return this._commandService.syncExecuteCommand(I.id, t), this;
   }
   moveConditionalFormattingRule(e, t, r = "after") {
     const s = {
@@ -797,7 +809,7 @@ class V extends F {
       start: { id: e, type: "self" },
       end: { id: t, type: r }
     };
-    return this._commandService.syncExecuteCommand(I.id, s), this;
+    return this._commandService.syncExecuteCommand(E.id, s), this;
   }
   setConditionalFormattingRule(e, t) {
     const r = {
@@ -806,10 +818,10 @@ class V extends F {
       rule: t,
       cfId: e
     };
-    return this._commandService.syncExecuteCommand(E.id, r), this;
+    return this._commandService.syncExecuteCommand(k.id, r), this;
   }
 }
-F.extend(V);
+R.extend(V);
 export {
-  R as FConditionalFormattingBuilder
+  m as FConditionalFormattingBuilder
 };