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

package/lib/locale/ar-SA.js

@@ -0,0 +1,10 @@
+//#region src/locale/ar-SA.ts
+const locale = { "sheets-conditional-formatting": { iconSet: {
+	direction: "الاتجاه",
+	shape: "الشكل",
+	mark: "العلامة",
+	rank: "الترتيب"
+} } };
+
+//#endregion
+export { locale as default };

package/lib/locale/ca-ES.js

@@ -0,0 +1,10 @@
+//#region src/locale/ca-ES.ts
+const locale = { "sheets-conditional-formatting": { iconSet: {
+	direction: "Direcció",
+	shape: "Forma",
+	mark: "Marca",
+	rank: "Rang"
+} } };
+
+//#endregion
+export { locale as default };

package/lib/locale/de-DE.js

@@ -0,0 +1,10 @@
+//#region src/locale/de-DE.ts
+const locale = { "sheets-conditional-formatting": { iconSet: {
+	direction: "Richtung",
+	shape: "Form",
+	mark: "Zeichen",
+	rank: "Rang"
+} } };
+
+//#endregion
+export { locale as default };

package/lib/locale/en-US.js

@@ -0,0 +1,25 @@
+//#region src/locale/en-US.ts
+/**
+* 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.
+*/
+const locale = { "sheets-conditional-formatting": { iconSet: {
+	direction: "Direction",
+	shape: "Shape",
+	mark: "Mark",
+	rank: "Rank"
+} } };
+
+//#endregion
+export { locale as default };

package/lib/locale/es-ES.js

@@ -0,0 +1,10 @@
+//#region src/locale/es-ES.ts
+const locale = { "sheets-conditional-formatting": { iconSet: {
+	direction: "Dirección",
+	shape: "Forma",
+	mark: "Marca",
+	rank: "Rango"
+} } };
+
+//#endregion
+export { locale as default };

package/lib/locale/fa-IR.js

@@ -0,0 +1,10 @@
+//#region src/locale/fa-IR.ts
+const locale = { "sheets-conditional-formatting": { iconSet: {
+	direction: "جهت",
+	shape: "شکل",
+	mark: "علامت",
+	rank: "رتبه"
+} } };
+
+//#endregion
+export { locale as default };

package/lib/locale/fr-FR.js

@@ -0,0 +1,10 @@
+//#region src/locale/fr-FR.ts
+const locale = { "sheets-conditional-formatting": { iconSet: {
+	direction: "Direction",
+	shape: "Forme",
+	mark: "Marque",
+	rank: "Rang"
+} } };
+
+//#endregion
+export { locale as default };

package/lib/locale/id-ID.js

@@ -0,0 +1,10 @@
+//#region src/locale/id-ID.ts
+const locale = { "sheets-conditional-formatting": { iconSet: {
+	direction: "Arah",
+	shape: "Bentuk",
+	mark: "Tanda",
+	rank: "Peringkat"
+} } };
+
+//#endregion
+export { locale as default };

package/lib/locale/it-IT.js

@@ -0,0 +1,10 @@
+//#region src/locale/it-IT.ts
+const locale = { "sheets-conditional-formatting": { iconSet: {
+	direction: "Direzione",
+	shape: "Forma",
+	mark: "Marca",
+	rank: "Grado"
+} } };
+
+//#endregion
+export { locale as default };

package/lib/locale/ja-JP.js

@@ -0,0 +1,10 @@
+//#region src/locale/ja-JP.ts
+const locale = { "sheets-conditional-formatting": { iconSet: {
+	direction: "方向",
+	shape: "図形",
+	mark: "インジケーター",
+	rank: "評価"
+} } };
+
+//#endregion
+export { locale as default };

package/lib/locale/ko-KR.js

@@ -0,0 +1,10 @@
+//#region src/locale/ko-KR.ts
+const locale = { "sheets-conditional-formatting": { iconSet: {
+	direction: "방향",
+	shape: "모양",
+	mark: "표식",
+	rank: "순위"
+} } };
+
+//#endregion
+export { locale as default };

package/lib/locale/pl-PL.js

@@ -0,0 +1,10 @@
+//#region src/locale/pl-PL.ts
+const locale = { "sheets-conditional-formatting": { iconSet: {
+	direction: "Kierunek",
+	shape: "Kształt",
+	mark: "Znak",
+	rank: "Ranga"
+} } };
+
+//#endregion
+export { locale as default };

package/lib/locale/pt-BR.js

@@ -0,0 +1,10 @@
+//#region src/locale/pt-BR.ts
+const locale = { "sheets-conditional-formatting": { iconSet: {
+	direction: "Direção",
+	shape: "Forma",
+	mark: "Marca",
+	rank: "Classificação"
+} } };
+
+//#endregion
+export { locale as default };

package/lib/locale/ru-RU.js

@@ -0,0 +1,10 @@
+//#region src/locale/ru-RU.ts
+const locale = { "sheets-conditional-formatting": { iconSet: {
+	direction: "Направление",
+	shape: "Форма",
+	mark: "Знак",
+	rank: "Ранг"
+} } };
+
+//#endregion
+export { locale as default };

package/lib/locale/sk-SK.js

@@ -0,0 +1,10 @@
+//#region src/locale/sk-SK.ts
+const locale = { "sheets-conditional-formatting": { iconSet: {
+	direction: "Smer",
+	shape: "Tvar",
+	mark: "Značka",
+	rank: "Poradie"
+} } };
+
+//#endregion
+export { locale as default };

package/lib/locale/vi-VN.js

@@ -0,0 +1,10 @@
+//#region src/locale/vi-VN.ts
+const locale = { "sheets-conditional-formatting": { iconSet: {
+	direction: "Hướng",
+	shape: "Hình dạng",
+	mark: "Dấu",
+	rank: "Hạng"
+} } };
+
+//#endregion
+export { locale as default };

package/lib/locale/zh-CN.js

@@ -0,0 +1,10 @@
+//#region src/locale/zh-CN.ts
+const locale = { "sheets-conditional-formatting": { iconSet: {
+	direction: "方向",
+	shape: "形状",
+	mark: "标记",
+	rank: "等级"
+} } };
+
+//#endregion
+export { locale as default };

package/lib/locale/zh-HK.js

@@ -0,0 +1,10 @@
+//#region src/locale/zh-HK.ts
+const locale = { "sheets-conditional-formatting": { iconSet: {
+	direction: "方向",
+	shape: "形狀",
+	mark: "標記",
+	rank: "等級"
+} } };
+
+//#endregion
+export { locale as default };

package/lib/locale/zh-TW.js

@@ -0,0 +1,10 @@
+//#region src/locale/zh-TW.ts
+const locale = { "sheets-conditional-formatting": { iconSet: {
+	direction: "方向",
+	shape: "形狀",
+	mark: "標記",
+	rank: "等級"
+} } };
+
+//#endregion
+export { locale as default };

package/lib/types/assets/icon-map.d.ts

@@ -0,0 +1,79 @@
+export declare const ICON_MAP: {
+    feedback: {
+        mistake: string;
+        warn: string;
+        correct: string;
+    };
+    star: {
+        starEmpty: string;
+        starIncomplete: string;
+        starFull: string;
+    };
+    progress: {
+        progress0: string;
+        progress25: string;
+        progress50: string;
+        progress75: string;
+        progress100: string;
+    };
+    signal: {
+        signal0: string;
+        signal25: string;
+        signal50: string;
+        signal75: string;
+        signal100: string;
+    };
+    feeling: {
+        guffaw: string;
+        smile: string;
+        noninductive: string;
+        dissatisfied: string;
+        impatient: string;
+    };
+    arrow: {
+        "down-red": string;
+        "right-gold": string;
+        "up-green": string;
+        "rightAndDown-gold": string;
+        "rightAndUp-gold": string;
+        "down-gray": string;
+        "right-gray": string;
+        "up-gray": string;
+        "rightAndDown-gray": string;
+        "rightAndUp-gray": string;
+    };
+    shape: {
+        cross: string;
+        up: string;
+        down: string;
+        "rhomboid-red": string;
+        "rhomboid-gold": string;
+        "roundness-greed": string;
+        "roundness-gold": string;
+        "roundness-red": string;
+        "roundness-pink": string;
+        "roundness-gray": string;
+        "roundness-black": string;
+        "triangle-gold": string;
+        "indicate-greed": string;
+        "indicate-gold": string;
+        "indicate-red": string;
+    };
+    feedback2: {
+        mistake2: string;
+        warn2: string;
+        correct2: string;
+    };
+    flag: {
+        "flag-green": string;
+        "flag-gold": string;
+        "flag-red": string;
+    };
+    cell: {
+        "cell-0": string;
+        "cell-25": string;
+        "cell-50": string;
+        "cell-75": string;
+        "cell-100": string;
+    };
+};

package/lib/types/base/const.d.ts

@@ -0,0 +1,80 @@
+/**
+ * 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 { IConditionFormattingRule } from '../models/type';
+export declare const SHEET_CONDITIONAL_FORMATTING_PLUGIN = "SHEET_CONDITIONAL_FORMATTING_PLUGIN";
+export declare enum CFTextOperator {
+    beginsWith = "beginsWith",
+    endsWith = "endsWith",
+    containsText = "containsText",
+    notContainsText = "notContainsText",
+    equal = "equal",
+    notEqual = "notEqual",
+    containsBlanks = "containsBlanks",
+    notContainsBlanks = "notContainsBlanks",
+    containsErrors = "containsErrors",
+    notContainsErrors = "notContainsErrors"
+}
+export declare enum CFTimePeriodOperator {
+    today = "today",
+    yesterday = "yesterday",
+    tomorrow = "tomorrow",
+    last7Days = "last7Days",
+    thisMonth = "thisMonth",
+    lastMonth = "lastMonth",
+    nextMonth = "nextMonth",
+    thisWeek = "thisWeek",
+    lastWeek = "lastWeek",
+    nextWeek = "nextWeek"
+}
+export declare enum CFNumberOperator {
+    greaterThan = "greaterThan",
+    greaterThanOrEqual = "greaterThanOrEqual",
+    lessThan = "lessThan",
+    lessThanOrEqual = "lessThanOrEqual",
+    notBetween = "notBetween",
+    between = "between",
+    equal = "equal",
+    notEqual = "notEqual"
+}
+export declare enum CFRuleType {
+    highlightCell = "highlightCell",
+    dataBar = "dataBar",
+    colorScale = "colorScale",
+    iconSet = "iconSet"
+}
+export declare enum CFSubRuleType {
+    uniqueValues = "uniqueValues",
+    duplicateValues = "duplicateValues",
+    rank = "rank",
+    text = "text",
+    timePeriod = "timePeriod",
+    number = "number",
+    average = "average",
+    formula = "formula"
+}
+export declare enum CFValueType {
+    num = "num",
+    min = "min",
+    max = "max",
+    percent = "percent",
+    percentile = "percentile",
+    formula = "formula"
+}
+export declare const DEFAULT_BG_COLOR = "#fff";
+export declare const DEFAULT_FONT_COLOR = "#000000";
+export declare const createDefaultRule: () => IConditionFormattingRule;
+export declare const createDefaultValue: (subType: CFSubRuleType, operator: CFTextOperator | CFNumberOperator | CFTimePeriodOperator) => 10 | "" | [number, number];
+export declare const createDefaultValueByValueType: (type: CFValueType, defaultValue?: number) => number | "" | "=";

package/lib/types/commands/commands/add-cf.command.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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 { ICommand } from '@cool-office/core';
+import type { IConditionFormattingRule } from '../../models/type';
+import type { MakePropertyOptional } from '../../utils/type';
+export interface IAddCfCommandParams {
+    unitId?: string;
+    subUnitId?: string;
+    rule: MakePropertyOptional<IConditionFormattingRule, 'cfId'>;
+}
+export declare const AddCfCommand: ICommand<IAddCfCommandParams>;

package/lib/types/commands/commands/clear-range-cf.command.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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 { ICommand, IRange } from '@cool-office/core';
+import type { CFRuleType } from '../../base/const';
+export interface IClearRangeCfParams {
+    ranges?: IRange[];
+    unitId?: string;
+    subUnitId?: string;
+    types?: CFRuleType[];
+}
+export declare const ClearRangeCfCommand: ICommand<IClearRangeCfParams>;

package/lib/types/commands/commands/clear-worksheet-cf.command.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 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 { ICommand } from '@cool-office/core';
+export interface IClearWorksheetCfParams {
+    unitId?: string;
+    subUnitId?: string;
+}
+export declare const ClearWorksheetCfCommand: ICommand<IClearWorksheetCfParams>;

package/lib/types/commands/commands/delete-cf.command.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 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 { ICommand } from '@cool-office/core';
+export interface IDeleteCfCommandParams {
+    unitId?: string;
+    subUnitId?: string;
+    cfId: string;
+}
+export declare const DeleteCfCommand: ICommand<IDeleteCfCommandParams>;

package/lib/types/commands/commands/move-cf.command.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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 { ICommand } from '@cool-office/core';
+import type { IAnchor } from '../../utils/anchor';
+export interface IMoveCfCommandParams {
+    unitId?: string;
+    subUnitId?: string;
+    start: IAnchor;
+    end: IAnchor;
+}
+export declare const MoveCfCommand: ICommand<IMoveCfCommandParams>;

package/lib/types/commands/commands/set-cf.command.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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 { ICommand } from '@cool-office/core';
+import type { IConditionFormattingRule } from '../../models/type';
+export interface ISetCfCommandParams {
+    unitId?: string;
+    subUnitId?: string;
+    cfId?: string;
+    rule: IConditionFormattingRule;
+}
+export declare const SetCfCommand: ICommand<ISetCfCommandParams>;

package/lib/types/commands/mutations/add-conditional-rule.mutation.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 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 { IAccessor, IMutation } from '@cool-office/core';
+import type { IConditionFormattingRule } from '../../models/type';
+import type { IDeleteConditionalRuleMutationParams } from './delete-conditional-rule.mutation';
+export interface IAddConditionalRuleMutationParams {
+    unitId: string;
+    subUnitId: string;
+    rule: IConditionFormattingRule;
+}
+export declare const AddConditionalRuleMutationUndoFactory: (accessor: IAccessor, param: IAddConditionalRuleMutationParams) => {
+    id: string;
+    params: IDeleteConditionalRuleMutationParams;
+};
+export declare const AddConditionalRuleMutation: IMutation<IAddConditionalRuleMutationParams>;

package/lib/types/commands/mutations/delete-conditional-rule.mutation.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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 { IAccessor, IMutation, IMutationInfo } from '@cool-office/core';
+export interface IDeleteConditionalRuleMutationParams {
+    unitId: string;
+    subUnitId: string;
+    cfId: string;
+}
+export declare const DeleteConditionalRuleMutationUndoFactory: (accessor: IAccessor, param: IDeleteConditionalRuleMutationParams) => IMutationInfo<object>[];
+export declare const DeleteConditionalRuleMutation: IMutation<IDeleteConditionalRuleMutationParams>;

package/lib/types/commands/mutations/formula-mark-dirty.mutation.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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 { IMutation } from '@cool-office/core';
+export interface IConditionalFormattingFormulaMarkDirtyParams {
+    [unitId: string]: {
+        [sunUnitId: string]: {
+            [formulaId: string]: boolean;
+        };
+    };
+}
+export declare const ConditionalFormattingFormulaMarkDirty: IMutation<IConditionalFormattingFormulaMarkDirtyParams>;

package/lib/types/commands/mutations/move-conditional-rule.mutation.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 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 { IMutation } from '@cool-office/core';
+import type { IAnchor } from '../../utils/anchor';
+export interface IMoveConditionalRuleMutationParams {
+    unitId: string;
+    subUnitId: string;
+    start: IAnchor;
+    end: IAnchor;
+}
+export declare const MoveConditionalRuleMutation: IMutation<IMoveConditionalRuleMutationParams>;
+export declare const MoveConditionalRuleMutationUndoFactory: (param: IMoveConditionalRuleMutationParams) => {
+    id: string;
+    params: IMoveConditionalRuleMutationParams;
+}[];