@cool-office/sheets-conditional-formatting 0.0.0-stage → 1.2.0

package/lib/types/models/type.d.ts

@@ -0,0 +1,106 @@
+/**
+ * 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 { IRange, IStyleBase } from '@cool-office/core';
+import type { CFNumberOperator, CFRuleType, CFSubRuleType, CFTextOperator, CFTimePeriodOperator, CFValueType } from '../base/const';
+import type { IIconSetType } from './icon-map';
+export interface IBaseCfRule {
+    type: string;
+}
+export interface IHighlightCell extends IBaseCfRule {
+    style: IStyleBase;
+    type: CFRuleType.highlightCell;
+    subType: CFSubRuleType;
+}
+export interface IValueConfig {
+    type: CFValueType;
+    value?: number | string;
+}
+export interface IUniqueValuesHighlightCell extends IHighlightCell {
+    subType: CFSubRuleType.uniqueValues;
+}
+export interface IDuplicateValuesHighlightCell extends IHighlightCell {
+    subType: CFSubRuleType.duplicateValues;
+}
+export interface IRankHighlightCell extends IHighlightCell {
+    subType: CFSubRuleType.rank;
+    isBottom: boolean;
+    isPercent: boolean;
+    value: number;
+}
+export interface ITextHighlightCell extends IHighlightCell {
+    subType: CFSubRuleType.text;
+    operator: CFTextOperator;
+    value?: string;
+}
+export interface ITimePeriodHighlightCell extends IHighlightCell {
+    subType: CFSubRuleType.timePeriod;
+    operator: CFTimePeriodOperator;
+}
+export interface IFormulaHighlightCell extends IHighlightCell {
+    subType: CFSubRuleType.formula;
+    value: string;
+}
+export type INumberHighlightCell = ({
+    subType: CFSubRuleType.number;
+    operator: CFNumberOperator.between | CFNumberOperator.notBetween;
+    value: [number, number];
+} & IHighlightCell) | ({
+    subType: CFSubRuleType.number;
+    operator: CFNumberOperator.equal | CFNumberOperator.notEqual | CFNumberOperator.greaterThan | CFNumberOperator.greaterThanOrEqual | CFNumberOperator.lessThanOrEqual | CFNumberOperator.lessThan;
+    value?: number;
+} & IHighlightCell);
+export interface IAverageHighlightCell extends IHighlightCell {
+    subType: CFSubRuleType.average;
+    operator: CFNumberOperator.greaterThan | CFNumberOperator.greaterThanOrEqual | CFNumberOperator.lessThan | CFNumberOperator.lessThanOrEqual | CFNumberOperator.equal | CFNumberOperator.notEqual;
+}
+export interface IDataBar extends IBaseCfRule {
+    type: CFRuleType.dataBar;
+    isShowValue: boolean;
+    config: {
+        min: IValueConfig;
+        max: IValueConfig;
+        isGradient: boolean;
+        positiveColor: string;
+        nativeColor: string;
+    };
+}
+export interface IColorScale extends IBaseCfRule {
+    type: CFRuleType.colorScale;
+    config: {
+        index: number;
+        color: string;
+        value: IValueConfig;
+    }[];
+}
+export interface IIconSet extends IBaseCfRule {
+    type: CFRuleType.iconSet;
+    isShowValue: boolean;
+    config: {
+        operator: CFNumberOperator;
+        value: IValueConfig;
+        iconType: IIconSetType;
+        iconId: string;
+    }[];
+}
+export type IConditionalFormattingRuleConfig = IColorScale | IDataBar | IUniqueValuesHighlightCell | IDuplicateValuesHighlightCell | IRankHighlightCell | ITextHighlightCell | ITimePeriodHighlightCell | INumberHighlightCell | IAverageHighlightCell | IFormulaHighlightCell | IIconSet;
+export interface IConditionFormattingRule<C = IConditionalFormattingRuleConfig> {
+    ranges: IRange[];
+    cfId: string;
+    stopIfTrue: boolean;
+    rule: C;
+}
+export type IRuleModel = Map<string, Map<string, IConditionFormattingRule[]>>;
+export type IRuleModelJson = Record<string, Record<string, IConditionFormattingRule[]>>;

package/lib/types/plugin.d.ts

@@ -0,0 +1,29 @@
+/**
+ * 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 { IUniverSheetsConditionalFormattingConfig } from './config/config';
+import { ICommandService, IConfigService, Injector, Plugin, UniverInstanceType } from '@cool-office/core';
+export declare class UniverSheetsConditionalFormattingPlugin extends Plugin {
+    private readonly _config;
+    readonly _injector: Injector;
+    private _commandService;
+    private readonly _configService;
+    static pluginName: string;
+    static packageName: string;
+    static version: string;
+    static type: UniverInstanceType;
+    constructor(_config: Partial<IUniverSheetsConditionalFormattingConfig> | undefined, _injector: Injector, _commandService: ICommandService, _configService: IConfigService);
+    onStarting(): void;
+}

package/lib/types/render/data-bar.render.d.ts

@@ -0,0 +1,35 @@
+/**
+ * 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 { IRange, IScale } from '@cool-office/core';
+import type { SpreadsheetSkeleton, UniverRenderingContext } from '@cool-office/engine-render';
+import type { IConditionalFormattingRenderRangeResolver } from './type';
+import { SheetExtension } from '@cool-office/engine-render';
+export declare const dataBarUKey = "sheet-conditional-rule-data-bar";
+export declare const defaultDataBarPositiveColor = "#ffbe38";
+export declare const defaultDataBarNativeColor = "#abd91a";
+export declare const defaultPlaceholderColor = "#000";
+export declare class DataBar extends SheetExtension {
+    private _paddingRightAndLeft;
+    private _paddingTopAndBottom;
+    private _renderRangeResolver;
+    uKey: string;
+    Z_INDEX: number;
+    _radius: number;
+    setRenderRangeResolver(resolver: IConditionalFormattingRenderRangeResolver | null): void;
+    draw(ctx: UniverRenderingContext, _parentScale: IScale, spreadsheetSkeleton: SpreadsheetSkeleton, diffRanges: IRange[]): false | undefined;
+    dispose(): void;
+    private _drawRectWithRoundedCorner;
+}

package/lib/types/render/icon.render.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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 { IRange, IScale } from '@cool-office/core';
+import type { SpreadsheetSkeleton, UniverRenderingContext } from '@cool-office/engine-render';
+import type { IConditionalFormattingRenderRangeResolver } from './type';
+import { SheetExtension } from '@cool-office/engine-render';
+export declare const IconUKey = "sheet-conditional-rule-icon";
+export declare const DEFAULT_WIDTH = 15;
+export declare const DEFAULT_PADDING = 2;
+export declare class ConditionalFormattingIcon extends SheetExtension {
+    private _paddingRightAndLeft;
+    private _width;
+    private _imageMap;
+    private _renderRangeResolver;
+    uKey: string;
+    Z_INDEX: number;
+    _radius: number;
+    constructor();
+    setRenderRangeResolver(resolver: IConditionalFormattingRenderRangeResolver | null): void;
+    draw(ctx: UniverRenderingContext, _parentScale: IScale, spreadsheetSkeleton: SpreadsheetSkeleton, diffRanges: IRange[]): false | undefined;
+    dispose(): void;
+    private _init;
+    private _createKey;
+}

package/lib/types/render/type.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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 { ICellData, IRange } from '@cool-office/core';
+import type { IIconSetType } from '../models/icon-map';
+export type IConditionalFormattingRenderRangeResolver = (unitId: string, subUnitId: string, ranges: IRange[]) => IRange[] | null;
+export interface IDataBarRenderParams {
+    color: string;
+    value: number;
+    startPoint: number;
+    isGradient: boolean;
+    isShowValue: boolean;
+}
+export interface IDataBarCellData extends ICellData {
+    dataBar?: IDataBarRenderParams;
+}
+export interface IIconSetRenderParams {
+    iconId: string;
+    iconType: IIconSetType;
+    isShowValue: boolean;
+}
+export interface IIconSetCellData extends ICellData {
+    iconSet?: IIconSetRenderParams;
+    _originV?: ICellData['v'];
+}
+export type IConditionalFormattingCellData = IDataBarCellData & IIconSetCellData;

package/lib/types/services/conditional-formatting-formula.service.d.ts

@@ -0,0 +1,73 @@
+/**
+ * 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 { IRange } from '@cool-office/core';
+import { Disposable, IUniverInstanceService, ObjectMatrix, RefAlias } from '@cool-office/core';
+import { FormulaResultStatus, RegisterOtherFormulaService } from '@cool-office/engine-formula';
+import { ConditionalFormattingRuleModel } from '../models/conditional-formatting-rule-model';
+type IFormulaItem = {
+    formulaText: string;
+    cfId: string;
+    id: string;
+    unitId: string;
+    subUnitId: string;
+    formulaId: string;
+};
+export declare class ConditionalFormattingFormulaService extends Disposable {
+    private _registerOtherFormulaService;
+    private _conditionalFormattingRuleModel;
+    private readonly _univerInstanceService;
+    private _formulaMap;
+    private _result$;
+    result$: import("rxjs").Observable<IFormulaItem & {
+        isAllFinished: boolean;
+    }>;
+    constructor(_registerOtherFormulaService: RegisterOtherFormulaService, _conditionalFormattingRuleModel: ConditionalFormattingRuleModel, _univerInstanceService: IUniverInstanceService);
+    private _initRuleChange;
+    /**
+     * Register formulas for a specific rule based on its type
+     */
+    private _registerRuleFormulas;
+    private _initFormulaResultChange;
+    private _ensureSubunitFormulaMap;
+    getSubUnitFormulaMap(unitId: string, subUnitId: string): RefAlias<IFormulaItem, "id" | "formulaId"> | undefined;
+    registerFormulaWithRange(unitId: string, subUnitId: string, cfId: string, formulaText: string, ranges?: IRange[]): void;
+    private _removeFormulaByCfId;
+    getFormulaResultWithCoords(unitId: string, subUnitId: string, cfId: string, formulaText: string, row?: number, col?: number): {
+        status: FormulaResultStatus;
+        result?: undefined;
+    } | {
+        result: string | number | boolean | void | null | undefined;
+        status: FormulaResultStatus;
+    };
+    getFormulaMatrix(unitId: string, subUnitId: string, cfId: string, formulaText: string): {
+        status: FormulaResultStatus;
+        result?: undefined;
+    } | {
+        result: ObjectMatrix<string | number | boolean | void | null | undefined>;
+        status: FormulaResultStatus;
+    };
+    private _getCellValue;
+    /**
+     * If `formulaText` is not provided, then all caches related to `cfId` will be deleted.
+     */
+    deleteCache(unitId: string, subUnitId: string, cfId: string, formulaText?: string): IFormulaItem[];
+    private _getAllFormulaResultByCfId;
+    /**
+     * A conditional formatting may have multiple formulas;if the formulas are identical,then the results will be consistent.
+     */
+    createCFormulaId(cfId: string, formulaText: string): string;
+}
+export {};

package/lib/types/services/conditional-formatting-range-transform.service.d.ts

@@ -0,0 +1,27 @@
+/**
+ * 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 { IRange } from '@cool-office/core';
+export interface IRangeAnchor {
+    row: number;
+    col: number;
+}
+export declare class ConditionalFormattingRangeTransformService {
+    subtractRanges(sourceRanges: IRange[], rangesToSubtract: IRange[]): IRange[];
+    addRanges(sourceRanges: IRange[], rangesToAdd: IRange[]): IRange[];
+    applyRangeDelta(sourceRanges: IRange[], rangesToSubtract: IRange[], rangesToAdd: IRange[]): IRange[];
+    copyIntersectingRanges(sourceRanges: IRange[], sourceRange: IRange, targetAnchor: IRangeAnchor): IRange[];
+    translateRange(range: IRange, offset: IRangeAnchor): IRange;
+}

package/lib/types/services/conditional-formatting-style-composer.service.d.ts

@@ -0,0 +1,35 @@
+/**
+ * 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 { Disposable } from '@cool-office/core';
+import type { IHighlightCell } from '../models/type';
+import type { IDataBarCellData, IIconSetCellData } from '../render/type';
+import { ConditionalFormattingRuleModel } from '../models/conditional-formatting-rule-model';
+import { ConditionalFormattingViewModel } from '../models/conditional-formatting-view-model';
+type IComposedStyle = {
+    style?: IHighlightCell['style'];
+} & IDataBarCellData & IIconSetCellData & {
+    isShowValue: boolean;
+};
+export declare class ConditionalFormattingStyleComposer extends Disposable {
+    private _conditionalFormattingRuleModel;
+    private _conditionalFormattingViewModel;
+    private _cache;
+    constructor(_conditionalFormattingRuleModel: ConditionalFormattingRuleModel, _conditionalFormattingViewModel: ConditionalFormattingViewModel);
+    dispose(): void;
+    composeStyle(unitId: string, subUnitId: string, row: number, col: number): IComposedStyle | null;
+    private _mergeComposeResult;
+}
+export {};

package/lib/types/services/conditional-formatting.service.d.ts

@@ -0,0 +1,41 @@
+/**
+ * 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 { Disposable, ICommandService, Injector, IResourceManagerService, IUniverInstanceService } from '@cool-office/core';
+import { SheetInterceptorService } from '@cool-office/sheets';
+import { ConditionalFormattingRangeIndexModel } from '../models/conditional-formatting-range-index-model';
+import { ConditionalFormattingRuleModel } from '../models/conditional-formatting-rule-model';
+import { ConditionalFormattingViewModel } from '../models/conditional-formatting-view-model';
+import { ConditionalFormattingStyleComposer } from './conditional-formatting-style-composer.service';
+export declare class ConditionalFormattingService extends Disposable {
+    private _conditionalFormattingRuleModel;
+    private _conditionalFormattingRangeIndexModel;
+    private _conditionalFormattingStyleComposer;
+    private _injector;
+    private _univerInstanceService;
+    private _resourceManagerService;
+    private _sheetInterceptorService;
+    private _commandService;
+    get _conditionalFormattingViewModelV2(): ConditionalFormattingViewModel;
+    constructor(_conditionalFormattingRuleModel: ConditionalFormattingRuleModel, _conditionalFormattingRangeIndexModel: ConditionalFormattingRangeIndexModel, _conditionalFormattingStyleComposer: ConditionalFormattingStyleComposer, _injector: Injector, _univerInstanceService: IUniverInstanceService, _resourceManagerService: IResourceManagerService, _sheetInterceptorService: SheetInterceptorService, _commandService: ICommandService);
+    composeStyle(unitId: string, subUnitId: string, row: number, col: number): ({
+        style?: import("..").IHighlightCell["style"];
+    } & import("..").IDataBarCellData & import("..").IIconSetCellData & {
+        isShowValue: boolean;
+    }) | null;
+    private _initSnapshot;
+    private _initSheetChange;
+    private _initCellChange;
+}

package/lib/types/utils/anchor.d.ts

@@ -0,0 +1,34 @@
+/**
+ * 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.
+ */
+export interface IAnchor {
+    id: string;
+    type: 'before' | 'after' | 'self';
+}
+export declare const findIndexByAnchor: <T = unknown[]>(anchor: IAnchor, ruleList: T[], get: (v: T) => string) => number | null;
+/**
+ * This function has side effects that modify the ruleList
+ * @param {IAnchor} start
+ * @param {IAnchor} end
+ * @param {ReturnType<ConditionalFormattingRuleModel['getSubunitRules']>} ruleList
+ * @return {*}
+ */
+export declare const moveByAnchor: <T = unknown[]>(start: IAnchor, end: IAnchor, ruleList: T[], get: (v: T) => string) => null | undefined;
+/**
+ * Only [after,after] and [after,before] can support symmetric operations
+ */
+export declare const transformSupportSymmetryAnchor: <T = unknown[]>(start: IAnchor, end: IAnchor, ruleList: T[], get: (v: T) => string) => [IAnchor, IAnchor] | null;
+export declare const anchorUndoFactory: (start: IAnchor, end: IAnchor) => [IAnchor, IAnchor] | null;
+export declare const isAnchorEqual: (anchor1: IAnchor, anchor2: IAnchor) => boolean;

package/lib/types/utils/create-cf-id.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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.
+ */
+export declare const createCfId: () => string;

package/lib/types/utils/range.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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 { IRange, Nullable, Worksheet } from '@cool-office/core';
+export declare function getRangeInWorksheet(range: IRange, worksheet: Worksheet): Nullable<IRange>;
+export declare function getRangesInWorksheet(ranges: IRange[], worksheet: Worksheet): IRange[];

package/lib/types/utils/remove-undefined-attr.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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.
+ */
+export declare function removeUndefinedAttr<T = unknown>(obj: T): T;

package/lib/types/utils/type.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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.
+ */
+export type MakePropertyOptional<T, K extends keyof T> = {
+    [P in keyof T]: P extends K ? T[P] | undefined : T[P];
+};

package/lib/umd/facade.js

@@ -0,0 +1 @@
+(function(e,t){typeof exports==`object`&&typeof module<`u`?t(exports,require("@cool-office/core"),require("@cool-office/sheets-conditional-formatting"),require("@cool-office/sheets/facade"),require("@cool-office/core/facade")):typeof define==`function`&&define.amd?define([`exports`,`@cool-office/core`,`@cool-office/sheets-conditional-formatting`,`@cool-office/sheets/facade`,`@cool-office/core/facade`],t):(e=typeof globalThis<`u`?globalThis:e||self,t(e.CoolOfficeSheetsConditionalFormattingFacade={},e.CoolOfficeCore,e.CoolOfficeSheetsConditionalFormatting,e.CoolOfficeSheetsFacade,e.CoolOfficeCoreFacade))})(this,function(e,t,n,r,i){Object.defineProperty(e,Symbol.toStringTag,{value:`Module`});function a(e){"@babel/helpers - typeof";return a=typeof Symbol==`function`&&typeof Symbol.iterator==`symbol`?function(e){return typeof e}:function(e){return e&&typeof Symbol==`function`&&e.constructor===Symbol&&e!==Symbol.prototype?`symbol`:typeof e},a(e)}function o(e,t){if(a(e)!=`object`||!e)return e;var n=e[Symbol.toPrimitive];if(n!==void 0){var r=n.call(e,t||`default`);if(a(r)!=`object`)return r;throw TypeError(`@@toPrimitive must return a primitive value.`)}return(t===`string`?String:Number)(e)}function s(e){var t=o(e,`string`);return a(t)==`symbol`?t:t+``}function c(e,t,n){return(t=s(t))in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}var l=class e{get _ruleConfig(){return this._rule.rule||null}_getDefaultConfig(e=n.CFRuleType.highlightCell){switch(e){case n.CFRuleType.colorScale:return{type:e,config:[{index:0,color:new t.ColorKit(``).toRgbString(),value:{type:n.CFValueType.min}},{index:0,color:new t.ColorKit(`green`).toRgbString(),value:{type:n.CFValueType.max}}]};case n.CFRuleType.dataBar:return{type:e,isShowValue:!0,config:{min:{type:n.CFValueType.min},max:{type:n.CFValueType.max},positiveColor:new t.ColorKit(`green`).toRgbString(),nativeColor:new t.ColorKit(``).toRgbString(),isGradient:!1}};case n.CFRuleType.highlightCell:return{type:e,subType:n.CFSubRuleType.text,operator:n.CFTextOperator.containsText,value:`abc`,style:{}};case n.CFRuleType.iconSet:return{type:e,isShowValue:!0,config:[{operator:n.CFNumberOperator.greaterThanOrEqual,value:{type:n.CFValueType.min},iconType:n.IIconSetType.empty,iconId:``},{operator:n.CFNumberOperator.greaterThanOrEqual,value:{type:n.CFValueType.percentile,value:.5},iconType:n.IIconSetType.empty,iconId:``},{operator:n.CFNumberOperator.lessThanOrEqual,value:{type:n.CFValueType.max},iconType:n.IIconSetType.empty,iconId:``}]}}}constructor(e={}){c(this,`_rule`,{}),this._rule=e,this._ensureAttr(this._rule,[`rule`])}_ensureAttr(e,t){return t.reduce((e,t)=>(e[t]||(e[t]={}),e[t]),e),e}build(){var e;this._rule.cfId||(this._rule.cfId=(0,n.createCfId)()),this._rule.ranges||(this._rule.ranges=[]),this._rule.stopIfTrue===void 0&&(this._rule.stopIfTrue=!1),(e=this._rule.rule)!=null&&e.type||(this._rule.rule.type=n.CFRuleType.highlightCell,this._ensureAttr(this._rule,[`rule`,`style`]));let t=this._getDefaultConfig(this._rule.rule.type);return{...this._rule,rule:{...t,...this._rule.rule}}}copy(){let r=t.Tools.deepClone(this._rule);return r.cfId&&=(0,n.createCfId)(),new e(r)}getRanges(){return this._rule.ranges||[]}getIconMap(){return n.iconMap}createCfId(){return(0,n.createCfId)()}setRanges(e){return this._rule.ranges=e,this}},u=class e extends l{constructor(e={}){super(e),this._ensureAttr(this._rule,[`rule`,`style`])}copy(){let r=t.Tools.deepClone(this._rule);return r.cfId&&=(0,n.createCfId)(),new e(r)}setAverage(e){let t=this._ruleConfig;return t.type=n.CFRuleType.highlightCell,t.subType=n.CFSubRuleType.average,t.operator=e,this}setUniqueValues(){let e=this._ruleConfig;return e.type=n.CFRuleType.highlightCell,e.subType=n.CFSubRuleType.uniqueValues,this}setDuplicateValues(){let e=this._ruleConfig;return e.type=n.CFRuleType.highlightCell,e.subType=n.CFSubRuleType.duplicateValues,this}setRank(e){let t=this._ruleConfig;return t.type=n.CFRuleType.highlightCell,t.subType=n.CFSubRuleType.rank,t.isBottom=e.isBottom,t.isPercent=e.isPercent,t.value=e.value,this}setBackground(e){var r;if(((r=this._ruleConfig)==null?void 0:r.type)===n.CFRuleType.highlightCell){if(e){this._ensureAttr(this._ruleConfig,[`style`,`bg`]);let n=new t.ColorKit(e);this._ruleConfig.style.bg.rgb=n.toRgbString()}else delete this._ruleConfig.style.bg}return this}setBold(e){var r;return((r=this._ruleConfig)==null?void 0:r.type)===n.CFRuleType.highlightCell&&(this._ensureAttr(this._ruleConfig,[`style`]),this._ruleConfig.style.bl=e?t.BooleanNumber.TRUE:t.BooleanNumber.FALSE),this}setFontColor(e){var r;if(((r=this._ruleConfig)==null?void 0:r.type)===n.CFRuleType.highlightCell){if(e){let n=new t.ColorKit(e);this._ensureAttr(this._ruleConfig,[`style`,`cl`]),this._ruleConfig.style.cl.rgb=n.toRgbString()}else delete this._ruleConfig.style.cl}return this}setItalic(e){var r;return((r=this._ruleConfig)==null?void 0:r.type)===n.CFRuleType.highlightCell&&(this._ensureAttr(this._ruleConfig,[`style`]),this._ruleConfig.style.it=e?t.BooleanNumber.TRUE:t.BooleanNumber.FALSE),this}setStrikethrough(e){var r;return((r=this._ruleConfig)==null?void 0:r.type)===n.CFRuleType.highlightCell&&(this._ensureAttr(this._ruleConfig,[`style`,`st`]),this._ruleConfig.style.st.s=e?t.BooleanNumber.TRUE:t.BooleanNumber.FALSE),this}setUnderline(e){var r;return((r=this._ruleConfig)==null?void 0:r.type)===n.CFRuleType.highlightCell&&(this._ensureAttr(this._ruleConfig,[`style`,`ul`]),this._ruleConfig.style.ul.s=e?t.BooleanNumber.TRUE:t.BooleanNumber.FALSE),this}whenCellEmpty(){let e=this._ruleConfig;return e.type=n.CFRuleType.highlightCell,e.subType=n.CFSubRuleType.text,e.value=``,e.operator=n.CFTextOperator.equal,this}whenCellNotEmpty(){let e=this._ruleConfig;return e.type=n.CFRuleType.highlightCell,e.subType=n.CFSubRuleType.text,e.value=``,e.operator=n.CFTextOperator.notEqual,this}whenDate(e){let t=this._ruleConfig;return t.type=n.CFRuleType.highlightCell,t.subType=n.CFSubRuleType.timePeriod,t.operator=e,this}whenFormulaSatisfied(e){let t=this._ruleConfig;return t.type=n.CFRuleType.highlightCell,t.subType=n.CFSubRuleType.formula,t.value=e,this}whenNumberBetween(e,t){let r=Math.min(e,t),i=Math.max(e,t),a=this._ruleConfig;return a.type=n.CFRuleType.highlightCell,a.subType=n.CFSubRuleType.number,a.value=[r,i],a.operator=n.CFNumberOperator.between,this}whenNumberEqualTo(e){let t=this._ruleConfig;return t.type=n.CFRuleType.highlightCell,t.subType=n.CFSubRuleType.number,t.value=e,t.operator=n.CFNumberOperator.equal,this}whenNumberGreaterThan(e){let t=this._ruleConfig;return t.type=n.CFRuleType.highlightCell,t.subType=n.CFSubRuleType.number,t.value=e,t.operator=n.CFNumberOperator.greaterThan,this}whenNumberGreaterThanOrEqualTo(e){let t=this._ruleConfig;return t.type=n.CFRuleType.highlightCell,t.subType=n.CFSubRuleType.number,t.value=e,t.operator=n.CFNumberOperator.greaterThanOrEqual,this}whenNumberLessThan(e){let t=this._ruleConfig;return t.type=n.CFRuleType.highlightCell,t.subType=n.CFSubRuleType.number,t.value=e,t.operator=n.CFNumberOperator.lessThan,this}whenNumberLessThanOrEqualTo(e){let t=this._ruleConfig;return t.type=n.CFRuleType.highlightCell,t.subType=n.CFSubRuleType.number,t.value=e,t.operator=n.CFNumberOperator.lessThanOrEqual,this}whenNumberNotBetween(e,t){let r=Math.min(e,t),i=Math.max(e,t),a=this._ruleConfig;return a.type=n.CFRuleType.highlightCell,a.subType=n.CFSubRuleType.number,a.value=[r,i],a.operator=n.CFNumberOperator.notBetween,this}whenNumberNotEqualTo(e){let t=this._ruleConfig;return t.type=n.CFRuleType.highlightCell,t.subType=n.CFSubRuleType.number,t.value=e,t.operator=n.CFNumberOperator.notEqual,this}whenTextContains(e){let t=this._ruleConfig;return t.type=n.CFRuleType.highlightCell,t.subType=n.CFSubRuleType.text,t.value=e,t.operator=n.CFTextOperator.containsText,this}whenTextDoesNotContain(e){let t=this._ruleConfig;return t.type=n.CFRuleType.highlightCell,t.subType=n.CFSubRuleType.text,t.value=e,t.operator=n.CFTextOperator.notContainsText,this}whenTextEndsWith(e){let t=this._ruleConfig;return t.type=n.CFRuleType.highlightCell,t.subType=n.CFSubRuleType.text,t.value=e,t.operator=n.CFTextOperator.endsWith,this}whenTextEqualTo(e){let t=this._ruleConfig;return t.type=n.CFRuleType.highlightCell,t.subType=n.CFSubRuleType.text,t.value=e,t.operator=n.CFTextOperator.equal,this}whenTextStartsWith(e){let t=this._ruleConfig;return t.type=n.CFRuleType.highlightCell,t.subType=n.CFSubRuleType.text,t.value=e,t.operator=n.CFTextOperator.beginsWith,this}},d=class e extends l{copy(){let r=t.Tools.deepClone(this._rule);return r.cfId&&=(0,n.createCfId)(),new e(r)}setDataBar(e){let t=this._ruleConfig;return t.type=n.CFRuleType.dataBar,t.isShowValue=!!e.isShowValue,t.config={min:e.min,max:e.max,positiveColor:e.positiveColor,nativeColor:e.nativeColor,isGradient:!!e.isGradient},this}},f=class e extends l{copy(){let r=t.Tools.deepClone(this._rule);return r.cfId&&=(0,n.createCfId)(),new e(r)}setColorScale(e){let t=this._ruleConfig;return t.type=n.CFRuleType.colorScale,t.config=e,this}},p=class e extends l{copy(){let r=t.Tools.deepClone(this._rule);return r.cfId&&=(0,n.createCfId)(),new e(r)}setIconSet(e){let t=this._ruleConfig;return t.type=n.CFRuleType.iconSet,t.config=e.iconConfigs,t.isShowValue=e.isShowValue,this}},m=class{constructor(e={}){this._initConfig=e}build(){return new l(this._initConfig).build()}setAverage(e){return new u(this._initConfig).setAverage(e)}setUniqueValues(){return new u(this._initConfig).setUniqueValues()}setDuplicateValues(){return new u(this._initConfig).setDuplicateValues()}setRank(e){return new u(this._initConfig).setRank(e)}getIconMap(){return n.iconMap}setIconSet(e){return new p(this._initConfig).setIconSet(e)}setColorScale(e){return new f(this._initConfig).setColorScale(e)}setDataBar(e){return new d(this._initConfig).setDataBar(e)}setBackground(e){return new u(this._initConfig).setBackground(e)}setBold(e){return new u(this._initConfig).setBold(e)}setFontColor(e){return new u(this._initConfig).setFontColor(e)}setItalic(e){return new u(this._initConfig).setItalic(e)}setStrikethrough(e){return new u(this._initConfig).setStrikethrough(e)}setUnderline(e){return new u(this._initConfig).setUnderline(e)}whenCellEmpty(){return new u(this._initConfig).whenCellEmpty()}whenCellNotEmpty(){return new u(this._initConfig).whenCellNotEmpty()}whenDate(e){return new u(this._initConfig).whenDate(e)}whenFormulaSatisfied(e){return new u(this._initConfig).whenFormulaSatisfied(e)}whenNumberBetween(e,t){return new u(this._initConfig).whenNumberBetween(e,t)}whenNumberEqualTo(e){return new u(this._initConfig).whenNumberEqualTo(e)}whenNumberGreaterThan(e){return new u(this._initConfig).whenNumberGreaterThan(e)}whenNumberGreaterThanOrEqualTo(e){return new u(this._initConfig).whenNumberGreaterThanOrEqualTo(e)}whenNumberLessThan(e){return new u(this._initConfig).whenNumberLessThan(e)}whenNumberLessThanOrEqualTo(e){return new u(this._initConfig).whenNumberLessThanOrEqualTo(e)}whenNumberNotBetween(e,t){return new u(this._initConfig).whenNumberNotBetween(e,t)}whenNumberNotEqualTo(e){return new u(this._initConfig).whenNumberNotEqualTo(e)}whenTextContains(e){return new u(this._initConfig).whenTextContains(e)}whenTextDoesNotContain(e){return new u(this._initConfig).whenTextDoesNotContain(e)}whenTextEndsWith(e){return new u(this._initConfig).whenTextEndsWith(e)}whenTextEqualTo(e){return new u(this._initConfig).whenTextEqualTo(e)}whenTextStartsWith(e){return new u(this._initConfig).whenTextStartsWith(e)}},h=class extends r.FRange{_getConditionalFormattingRuleModel(){return this._injector.get(n.ConditionalFormattingRuleModel)}getConditionalFormattingRules(){return[...this._getConditionalFormattingRuleModel().getSubunitRules(this._workbook.getUnitId(),this._worksheet.getSheetId())||[]].filter(e=>e.ranges.some(e=>t.Rectangle.intersects(e,this._range)))}createConditionalFormattingRule(){return new m({ranges:[this._range]})}clearConditionalFormatRules(){let e={unitId:this._workbook.getUnitId(),subUnitId:this._worksheet.getSheetId(),ranges:[this._range]};return this._commandService.syncExecuteCommand(n.ClearRangeCfCommand.id,e),this}};r.FRange.extend(h);var g=class extends r.FWorksheet{_getConditionalFormattingRuleModel(){return this._injector.get(n.ConditionalFormattingRuleModel)}getConditionalFormattingRules(){return[...this._getConditionalFormattingRuleModel().getSubunitRules(this._workbook.getUnitId(),this._worksheet.getSheetId())||[]]}newConditionalFormattingRule(){return new m}addConditionalFormattingRule(e){let t={unitId:this._workbook.getUnitId(),subUnitId:this._worksheet.getSheetId(),rule:e};return this._commandService.syncExecuteCommand(n.AddCfCommand.id,t),this}deleteConditionalFormattingRule(e){let t={unitId:this._workbook.getUnitId(),subUnitId:this._worksheet.getSheetId(),cfId:e};return this._commandService.syncExecuteCommand(n.DeleteCfCommand.id,t),this}moveConditionalFormattingRule(e,t,r=`after`){let i={unitId:this._workbook.getUnitId(),subUnitId:this._worksheet.getSheetId(),start:{id:e,type:`self`},end:{id:t,type:r}};return this._commandService.syncExecuteCommand(n.MoveCfCommand.id,i),this}setConditionalFormattingRule(e,t){let r={unitId:this._workbook.getUnitId(),subUnitId:this._worksheet.getSheetId(),cfId:e,rule:t};return this._commandService.syncExecuteCommand(n.SetCfCommand.id,r),this}clearConditionalFormatRules(){let e={unitId:this._workbook.getUnitId(),subUnitId:this._worksheet.getSheetId()};return this._commandService.syncExecuteCommand(n.ClearWorksheetCfCommand.id,e),this}};r.FWorksheet.extend(g);var _=class extends i.FEnum{get ConditionFormatNumberOperatorEnum(){return n.CFNumberOperator}get ConditionFormatTimePeriodOperatorEnum(){return n.CFTimePeriodOperator}get ConditionFormatIconSetTypeEnum(){return n.IIconSetType}get ConditionFormatValueTypeEnum(){return n.CFValueType}};i.FEnum.extend(_),e.FConditionalFormattingBuilder=m});