Skip to content

An open-source, privacy-first, self-hosted knowledge workspace where humans and AI agents work together 开源、隐私优先、自托管的知识工作空间,让人与智能体在此协作

:recycle: Declare attribute view field capabilities in one place https://github.com/siyuan-note/siyuan/issues/20255

Daniel9e9d40057f2b
diff --git a/app/src/protyle/render/av/action.ts b/app/src/protyle/render/av/action.ts
index dcfa587077..8e39270073 100644
--- a/app/src/protyle/render/av/action.ts
+++ b/app/src/protyle/render/av/action.ts
@@ -254,7 +254,7 @@ const getAVEditFieldMenuItems = (protyle: IProtyle, blockElement: HTMLElement):
});
}
}];
- } else if (["mAsset", "relation"].includes(field.type) || (field.type === "mSelect" && !singleItem)) {
+ } else if ((field.type === "mAsset" || field.type === "relation") || (field.type === "mSelect" && !singleItem)) {
item.type = "submenu";
item.submenu = [{
iconHTML: "",
diff --git a/app/src/protyle/render/av/attributePanel.ts b/app/src/protyle/render/av/attributePanel.ts
index ea6a7032db..fbbb1ebf8f 100644
--- a/app/src/protyle/render/av/attributePanel.ts
+++ b/app/src/protyle/render/av/attributePanel.ts
@@ -204,12 +204,12 @@ export class AVAttributePanel {
return;
}
if (operation.action === "updateAttrViewCell" && operation.rowID && this.hasItem(operation.rowID) &&
- (["block", "number"].includes(operation.data?.type) || this.hasRenderTemplate(avID))) {
+ ((operation.data?.type === "block" || operation.data?.type === "number") || this.hasRenderTemplate(avID))) {
this.queueRefresh();
return;
}
if (operation.action === "updateAttrViewCells" && operation.cellUpdates?.some(cell =>
- this.hasItem(cell.rowID) && (["block", "number"].includes(cell.data?.type) ||
+ this.hasItem(cell.rowID) && ((cell.data?.type === "block" || cell.data?.type === "number") ||
this.hasRenderTemplate(avID)))) {
this.queueRefresh();
return;
diff --git a/app/src/protyle/render/av/attributePanelVisibility.test.ts b/app/src/protyle/render/av/attributePanelVisibility.test.ts
index 3e4f4a6ce5..09d19a839c 100644
--- a/app/src/protyle/render/av/attributePanelVisibility.test.ts
+++ b/app/src/protyle/render/av/attributePanelVisibility.test.ts
@@ -214,10 +214,14 @@ test("attribute panel field rules preserve global defaults and reveal hidden fie
.replace(/^import [\s\S]*?;\r?\n/gm, "").replace(/^export /gm, ""),
{compilerOptions: {target: ScriptTarget.ES2021}}).outputText;
const css = compileString(readFileSync("src/assets/scss/business/_custom.scss", "utf8")).css;
- const columnSource = transpileModule(readFileSync(path.resolve(__dirname, "col.ts"), "utf8")
+ const capabilitySource = transpileModule(["capabilities.generated.ts", "capabilities.ts"].map(file =>
+ readFileSync(path.resolve(__dirname, file), "utf8")
+ .replace(/^import [\s\S]*?;\r?\n/gm, "").replace(/^export /gm, "")).join("\n"),
+ {compilerOptions: {target: ScriptTarget.ES2021}}).outputText;
+ const columnSource = capabilitySource + transpileModule(readFileSync(path.resolve(__dirname, "col.ts"), "utf8")
.replace(/^import [\s\S]*?;\r?\n/gm, "").replace(/^export /gm, ""),
{compilerOptions: {target: ScriptTarget.ES2021}}).outputText;
- const blockSource = transpileModule(readFileSync(path.resolve(__dirname, "blockAttr.ts"), "utf8")
+ const blockSource = capabilitySource + transpileModule(readFileSync(path.resolve(__dirname, "blockAttr.ts"), "utf8")
.replace(/^import [\s\S]*?;\r?\n/gm, "").replace(/^export /gm, ""),
{compilerOptions: {target: ScriptTarget.ES2021}}).outputText;
const menuSource = transpileModule(readFileSync("src/menus/Menu.ts", "utf8")
diff --git a/app/src/protyle/render/av/attributeValue.ts b/app/src/protyle/render/av/attributeValue.ts
index 3813477ec7..dc0f1883a5 100644
--- a/app/src/protyle/render/av/attributeValue.ts
+++ b/app/src/protyle/render/av/attributeValue.ts
@@ -1,3 +1,4 @@
+import {hasAVAttributePlaceholder, isAVLinkType, isAVTimestampType, usesAVRollupCellRenderer} from "./capabilities";
import {escapeAriaLabel, escapeAttr, escapeHtml, escapeHtmlTextAndAttr} from "../../../util/escape";
import {unicode2Emoji} from "../../../emoji";
import {renderAVBlockIcon} from "./blockIcon";
@@ -213,7 +214,7 @@ export const genAVValueHTML = (value: IAVCellValue, dateFormat: TAVDateFormat =
break;
case "rollup":
value?.rollup?.contents?.forEach((item) => {
- const rollupText = ["template", "select", "mSelect", "mAsset", "checkbox", "relation"].includes(item.type) ?
+ const rollupText = (usesAVRollupCellRenderer(item.type) || item.type === "checkbox") ?
genAVValueHTML(item) : genAVRollupHTML(item);
if (rollupText) {
html += rollupText.replace("fn__flex-1", "") + ", ";
@@ -248,8 +249,8 @@ export const genAVAttributeRowHTML = (options: {
}) => {
const value = options.value;
const storedValue = cloneAVCellValueSnapshot(value);
- const textInputType = ["url", "email", "phone", "block"].includes(value.type);
- const hasOwnPlaceholder = ["text", "number", "date", "url", "phone", "template", "email"].includes(value.type);
+ const textInputType = isAVLinkType(value.type);
+ const hasOwnPlaceholder = hasAVAttributePlaceholder(value.type);
const checkClass = value.type === "checkbox" ? (value.checkbox.checked ? " av__cell-check" : " av__cell-uncheck") : "";
return `<div class="block__icons av__row" data-id="${options.nodeID}" data-col-id="${options.keyID}" data-empty="${options.empty}" data-panel-visibility="${escapeAttr(options.attributePanelVisibility || "")}"${options.type === "block" ? ' data-primary="true"' : ""}>
<div class="block__icon" draggable="true"><svg><use xlink:href="#iconDrag"></use></svg></div>
@@ -262,6 +263,6 @@ data-options="${options.selectOptions ? escapeAttr(JSON.stringify(options.select
data-date-format="${options.dateFormat || ""}"
${options.renderTemplate?.trim() ? 'data-render-template="true"' : ""}
${hasOwnPlaceholder ? "" : `placeholder="${window.siyuan.languages.empty}"`}
-class="fn__flex-1 fn__flex${textInputType ? "" : " custom-attr__avvalue"}${["created", "updated"].includes(value.type) ? " custom-attr__avvalue--readonly" : ""}${checkClass}">${genAVValueHTML(value, options.dateFormat, options.renderTemplate)}</div>
+class="fn__flex-1 fn__flex${textInputType ? "" : " custom-attr__avvalue"}${isAVTimestampType(value.type) ? " custom-attr__avvalue--readonly" : ""}${checkClass}">${genAVValueHTML(value, options.dateFormat, options.renderTemplate)}</div>
</div>`;
};
diff --git a/app/src/protyle/render/av/automation.test.ts b/app/src/protyle/render/av/automation.test.ts
index 170173ddd9..e6ac37cf9d 100644
--- a/app/src/protyle/render/av/automation.test.ts
+++ b/app/src/protyle/render/av/automation.test.ts
@@ -1,3 +1,4 @@
+import * as capabilities from "./capabilities";
import * as assert from "node:assert/strict";
import {readFileSync} from "node:fs";
import {test} from "node:test";
@@ -15,9 +16,9 @@ test("automation settings reject readonly, publishing and historical editors bef
runInNewContext(compiled, {
exports: methods,
window: {siyuan: {config: {readonly: mode === "readonly"}, isPublish: mode === "publish"}},
- require: (name: string) => name === "../../../util/fetch" ? {
+ require: (name: string) => name === "./capabilities" || name === "../capabilities" ? capabilities : (name === "../../../util/fetch" ? {
fetchSyncPost: () => assert.fail("protected editor fetched automation settings"),
- } : {},
+ } : {}),
});
await methods.openAutomationMenu({protyle: {disabled: mode === "disabled", options: {
history: {created: mode === "created" ? "history" : undefined, snapshot: mode === "snapshot" ? "snapshot" : undefined},
@@ -65,7 +66,7 @@ test("automation settings autosave changes with independent undo snapshots and k
exports: methods,
window: {siyuan: {config: {}, languages: {databaseAutomations: "Automations", fields: "Fields", automationIncomplete: "Incomplete: ${1}"},
menus: {menu: {remove() { menuVisible = false; }}}}},
- require: (name: string) => ({
+ require: (name: string) => name === "./capabilities" || name === "../capabilities" ? capabilities : (({
"../../../plugin/Menu": {Menu: class {
addItem() {}
open() { menuVisible = true; }
@@ -75,7 +76,7 @@ test("automation settings autosave changes with independent undo snapshots and k
"../../wysiwyg/transaction": {transaction: (_protyle: IProtyle, perform: IOperation[], undo: IOperation[]) => {
transactions.push({perform, undo});
}},
- })[name] || {},
+ })[name] || {}),
});
await methods.openAutomationMenu({protyle: {options: {}} as IProtyle,
blockElement: {dataset: {nodeId: "carrier"}} as unknown as HTMLElement, avID: "source",
@@ -152,13 +153,13 @@ test("empty automation settings persist an incomplete rule disabled on editing a
exports: methods,
Lute: {NewNodeID: () => "draft-rule"},
window: {siyuan: {config: {}, languages: {databaseAutomations: "Automations", fields: "Fields", automationIncomplete: "Incomplete: ${1}"}}},
- require: (name: string) => ({
+ require: (name: string) => name === "./capabilities" || name === "../capabilities" ? capabilities : (({
"../../../util/escape": {escapeAttr: String, escapeHtml: String},
"../../../util/fetch": {fetchSyncPost: async () => ({code: 0, data: {av: database}})},
"../../wysiwyg/transaction": {transaction: (_protyle: IProtyle, perform: IOperation[], undo: IOperation[]) => {
transactions.push({perform, undo});
}},
- })[name] || {},
+ })[name] || {}),
});
await methods.openAutomationMenu({protyle: {options: {}} as IProtyle,
blockElement: {dataset: {nodeId: "carrier"}} as unknown as HTMLElement, avID: "source",
@@ -210,10 +211,10 @@ test("leaving automation settings while loading does not replace the next page o
runInNewContext(compiled, {
exports: methods,
window: {siyuan: {config: {}, languages: {databaseAutomations: "Automations"}}},
- require: (name: string) => ({
+ require: (name: string) => name === "./capabilities" || name === "../capabilities" ? capabilities : (({
"../../../util/fetch": {fetchSyncPost: () => new Promise(resolve => { complete = resolve; })},
"../../wysiwyg/transaction": {transaction: () => assert.fail("cancel submitted a transaction")},
- })[name] || {},
+ })[name] || {}),
});
const pending = methods.openAutomationMenu({protyle: {options: {}} as IProtyle, blockElement: {} as HTMLElement,
avID: "database", menuElement: menu as unknown as HTMLElement, onResize() {}});
diff --git a/app/src/protyle/render/av/automation.ts b/app/src/protyle/render/av/automation.ts
index 06c35c1776..c4a831e32b 100644
--- a/app/src/protyle/render/av/automation.ts
+++ b/app/src/protyle/render/av/automation.ts
@@ -1,3 +1,4 @@
+import {hasAVCapability, isAVSelectType} from "./capabilities";
import type {AVAttributeViewData, AVAutomationActionInput, AVAutomationRuleInput, AVAutomationValueInput} from "../../../types/api";
import {Menu} from "../../../plugin/Menu";
import {escapeAttr, escapeHtml} from "../../../util/escape";
@@ -21,10 +22,9 @@ interface AutomationRule extends Omit<AVAutomationRuleInput, "actions" | "condit
actions: AutomationAction[];
}
-const editableTypes = ["block", "text", "number", "date", "select", "mSelect", "url", "email", "phone", "checkbox", "relation", "mAsset"];
const clone = <T>(value: T): T => JSON.parse(JSON.stringify(value));
const fieldsOf = (database: AVAttributeViewData): IAVColumn[] => (database?.keyValues || [])
- .filter(item => item?.key && editableTypes.includes(item.key.type))
+ .filter(item => item?.key && hasAVCapability(item.key.type, "editable"))
.map(item => ({...item.key, renderTemplate: ""}));
const compatibleFields = (database: AVAttributeViewData, field: IAVColumn): IAVColumn[] => fieldsOf(database)
@@ -241,7 +241,7 @@ export const openAutomationMenu = async (options: {
};
const mountValue = (host: HTMLElement, field: IAVColumn, value: AutomationValue) => {
const selected = value.value?.mSelect?.map(item => item.content) || [];
- host.innerHTML = ["select", "mSelect"].includes(field.type) ?
+ host.innerHTML = isAVSelectType(field.type) ?
`<button type="button" class="b3-button b3-button--cancel" data-role="field-value" data-value-type="${field.type}" data-selected="${escapeAttr(JSON.stringify(selected))}">${getSelectedOptionsHTML(field, selected) || lang.select}</button>` :
getValueInputHTML(field, {mode: "static", value: value.value});
const input = host.querySelector<HTMLElement>('[data-role="field-value"]');
@@ -269,7 +269,7 @@ export const openAutomationMenu = async (options: {
} else if (field.type === "relation") {
getRelationOptions(field, choices => renderRelationFieldValue(input, choices));
input.addEventListener("click", () => openFieldRelationMenu(input, field));
- } else if (["select", "mSelect"].includes(field.type)) {
+ } else if (isAVSelectType(field.type)) {
input.addEventListener("click", () => openFieldSelectMenu(input, field));
}
};
diff --git a/app/src/protyle/render/av/batchEdit.ts b/app/src/protyle/render/av/batchEdit.ts
index 033c0a4919..1c55730c5b 100644
--- a/app/src/protyle/render/av/batchEdit.ts
+++ b/app/src/protyle/render/av/batchEdit.ts
@@ -1,4 +1,5 @@
import {isTableLikeView} from "./viewType";
+import {hasAVCapability} from "./capabilities";
import {createEmptyAVValue} from "./attributeValue";
import {popTextCell, renderCell, renderCellAttr, updateCellsValue} from "./cell";
import {getAVData, getAVSelectedItemIDs} from "./virtualScroll";
@@ -8,27 +9,12 @@ import {cloneAVCellValueSnapshot} from "./cellValue";
import {renderAVRichTextElements} from "./richText";
import {openAVBindBlock} from "./bindBlock";
-const EDITABLE_FIELD_TYPES: TAVCol[] = [
- "block",
- "text",
- "number",
- "select",
- "mSelect",
- "date",
- "checkbox",
- "url",
- "email",
- "phone",
- "mAsset",
- "relation",
-];
-
export const getEditableAVFields = (blockElement: HTMLElement) => {
const data = getAVData(blockElement);
if (!data) {
return [];
}
- return getFieldsByData(data).filter((field) => EDITABLE_FIELD_TYPES.includes(field.type));
+ return getFieldsByData(data).filter((field) => hasAVCapability(field.type, "editable"));
};
const findItemCell = (view: IAVView, viewType: TAVView, itemID: string, fieldIndex: number): IAVCell | undefined => {
diff --git a/app/src/protyle/render/av/blockAttr.ts b/app/src/protyle/render/av/blockAttr.ts
index 244454d3c5..8e9a89d2a6 100644
--- a/app/src/protyle/render/av/blockAttr.ts
+++ b/app/src/protyle/render/av/blockAttr.ts
@@ -1,3 +1,4 @@
+import {isAVTextType} from "./capabilities";
import {fetchPost} from "../../../util/fetch";
import {addCol, getColIconByType} from "./col";
import {escapeAttr, escapeHtml} from "../../../util/escape";
@@ -714,7 +715,7 @@ const openEdit = (protyle: IProtyle, element: HTMLElement, event: MouseEvent) =>
event.stopPropagation();
event.preventDefault();
break;
- } else if (["text", "url", "email", "phone", "block"].includes(type) &&
+ } else if ((isAVTextType(type) && type !== "template") &&
(target.querySelector(":scope > .av__celltext--template, :scope > .av__cellprimary > .av__celltext--template") ||
(type === "text" && target.querySelector(":scope > .av__celltext")))) {
popTextCell(protyle, [target], type as TAVCol);
diff --git a/app/src/protyle/render/av/blockIcon.test.ts b/app/src/protyle/render/av/blockIcon.test.ts
index f85082b0d3..cdda67f692 100644
--- a/app/src/protyle/render/av/blockIcon.test.ts
+++ b/app/src/protyle/render/av/blockIcon.test.ts
@@ -1,3 +1,4 @@
+import * as capabilities from "./capabilities";
import {describe, it} from "node:test";
import * as assert from "node:assert/strict";
import {readFileSync} from "node:fs";
@@ -74,7 +75,7 @@ const createHarness = (layout: TAVView = "table", detached = true, icon?: string
runInNewContext(ts.transpileModule(readFileSync(join(__dirname, `${name}.ts`), "utf8"), {
compilerOptions: {module: ts.ModuleKind.CommonJS, target: ts.ScriptTarget.ES2022},
}).outputText, {
- module, exports: module.exports, require: (id: string) => mocks[id] || {},
+ module, exports: module.exports, require: (id: string) => id === "./capabilities" || id === "../capabilities" ? capabilities : (mocks[id] || {}),
window: {siyuan}, document: {querySelectorAll: (): HTMLElement[] => [], createElement: () => ({
matches: () => false, querySelector: (): HTMLElement => null, querySelectorAll: (): HTMLElement[] => [], textContent: "",
})},
diff --git a/app/src/protyle/render/av/calc.ts b/app/src/protyle/render/av/calc.ts
index 120322cbf7..0357c81a3c 100644
--- a/app/src/protyle/render/av/calc.ts
+++ b/app/src/protyle/render/av/calc.ts
@@ -1,3 +1,4 @@
+import {isAVDateType} from "./capabilities";
import {isAVRenderData} from "./renderData";
import {Menu} from "../../../plugin/Menu";
import {transaction} from "../../wysiwyg/transaction";
@@ -345,7 +346,7 @@ export const openCalcMenu = async (protyle: IProtyle, calcElement: HTMLElement,
}
}
}
- if (["number", "template"].includes(type) || rollupIsNumber) {
+ if ((type === "number" || type === "template") || rollupIsNumber) {
calcItem({
menu,
protyle,
@@ -412,7 +413,7 @@ export const openCalcMenu = async (protyle: IProtyle, calcElement: HTMLElement,
blockID,
target: calcElement
});
- } else if (["date", "created", "updated"].includes(type)) {
+ } else if (isAVDateType(type)) {
calcItem({
menu,
protyle,
@@ -524,7 +525,7 @@ export const getCalcValue = (column: IAVColumn) => {
}
let resultCalc: any = column.calc.result.number;
if (column.calc.operator === "Earliest" || column.calc.operator === "Latest" ||
- (column.calc.operator === "Range" && ["date", "created", "updated"].includes(column.type))) {
+ (column.calc.operator === "Range" && isAVDateType(column.type))) {
resultCalc = column.calc.result[column.type as "date"];
} else if (column.calc.operator === "Template") {
// 自定义模板统计:数字输出走 number,文本输出走 text
diff --git a/app/src/protyle/render/av/calendar/render.test.ts b/app/src/protyle/render/av/calendar/render.test.ts
index 4217afad2f..410c966b9c 100644
--- a/app/src/protyle/render/av/calendar/render.test.ts
+++ b/app/src/protyle/render/av/calendar/render.test.ts
@@ -1,3 +1,4 @@
+import * as capabilities from "../capabilities";
import * as assert from "node:assert/strict";
import {readFileSync} from "node:fs";
import {join} from "node:path";
@@ -62,7 +63,7 @@ test("calendar refreshes the current view after composition and captures the lat
runInNewContext(transpileModule(readFileSync(join(__dirname, "render.ts"), "utf8"), {
compilerOptions: {module: ModuleKind.CommonJS, target: ScriptTarget.ES2020},
}).outputText, {
- exports: api, require: (name: string) => modules[name] || {},
+ exports: api, require: (name: string) => name === "./capabilities" || name === "../capabilities" ? capabilities : (modules[name] || {}),
window: {siyuan: {config: {lang: "en"}, languages: {}}}, document: {activeElement: input},
});
await api.renderCalendar(block as unknown as HTMLElement, {disabled: true, options: {}} as IProtyle,
@@ -116,7 +117,7 @@ test("calendar omits empty fields while preserving zero, unchecked boxes and ren
runInNewContext(transpileModule(readFileSync(join(__dirname, "render.ts"), "utf8"), {
compilerOptions: {module: ModuleKind.CommonJS, target: ScriptTarget.ES2020},
}).outputText, {
- exports: api, require: (name: string) => modules[name] || {},
+ exports: api, require: (name: string) => name === "./capabilities" || name === "../capabilities" ? capabilities : (modules[name] || {}),
window: {siyuan: {config: {lang: "en"}, languages: {}}}, document: {activeElement: null},
});
await assert.rejects(api.renderCalendar({querySelector: (): null => null, removeAttribute() {}} as unknown as HTMLElement,
@@ -159,7 +160,7 @@ test("calendar without a date field renders its setup instead of reading an abse
runInNewContext(transpileModule(readFileSync(join(__dirname, "render.ts"), "utf8"), {
compilerOptions: {module: ModuleKind.CommonJS, target: ScriptTarget.ES2020},
}).outputText, {
- exports, require: (name: string) => modules[name] || {},
+ exports, require: (name: string) => name === "./capabilities" || name === "../capabilities" ? capabilities : (modules[name] || {}),
window: {siyuan: {config: {lang: "en"}, languages: {calendarSelectDateField: "Select date field"}}},
document: {activeElement: null},
});
@@ -212,7 +213,7 @@ test("calendar refresh keeps selected event segments and blank clicks dismiss th
runInNewContext(transpileModule(readFileSync(join(__dirname, "render.ts"), "utf8"), {
compilerOptions: {module: ModuleKind.CommonJS, target: ScriptTarget.ES2020},
}).outputText, {
- exports, require: (name: string) => modules[name] || {},
+ exports, require: (name: string) => name === "./capabilities" || name === "../capabilities" ? capabilities : (modules[name] || {}),
window: {siyuan: {config: {lang: "en"}, languages: {}, menus: {menu: {remove() { menuClosed++; }}}}},
document: {activeElement: null},
});
@@ -289,7 +290,7 @@ test("calendar checkbox clicks and keyboard activation update only the chosen fi
runInNewContext(transpileModule(readFileSync(join(__dirname, "render.ts"), "utf8"), {
compilerOptions: {module: ModuleKind.CommonJS, target: ScriptTarget.ES2020},
}).outputText, {
- exports, require: (name: string) => modules[name] || {},
+ exports, require: (name: string) => name === "./capabilities" || name === "../capabilities" ? capabilities : (modules[name] || {}),
window: {siyuan: {isPublish: mode === "publish", config: {lang: "en"}, languages: {},
menus: {menu: {remove() { menusClosed++; }}}},
setTimeout: (callback: () => void) => { startDrag = callback; return 1; }, addEventListener() {}},
@@ -401,7 +402,7 @@ test("calendar edit-mode changes refresh controls and stale actions cannot creat
"../../mobile/util/mobileBars": {pauseMobileBarsScroll: () => paused++},
};
const context = {
- require: (name: string) => modules[name] || {},
+ require: (name: string) => name === "./capabilities" || name === "../capabilities" ? capabilities : (modules[name] || {}),
window: {siyuan: {config: {lang: "en"}, languages: {}, menus: {menu: {remove() {}}},
mobile: {editor: mobile ? {protyle} : undefined}}},
document: {activeElement: null as Element | null},
diff --git a/app/src/protyle/render/av/calendar/render.ts b/app/src/protyle/render/av/calendar/render.ts
index 0e1e0b167e..4f9ff23f26 100644
--- a/app/src/protyle/render/av/calendar/render.ts
+++ b/app/src/protyle/render/av/calendar/render.ts
@@ -1,3 +1,4 @@
+import {AV_DATE_TYPES} from "../capabilities";
import {Constants} from "../../../../constants";
import {setStorageVal} from "../../../util/compatibility";
import * as dayjs from "dayjs";
@@ -405,7 +406,7 @@ export const renderCalendar = async (blockElement: HTMLElement, protyle: IProtyl
let body = "";
if (!dateColumn) {
body = `<div class="av__calendar-empty"><svg><use xlink:href="#iconCalendar"></use></svg><p>${window.siyuan.languages.calendarSelectDateField}</p>
- ${editable ? `<div class="av__calendar-setup">${getCalendarSettingsHTML(view)}</div><div class="av__calendar-create-fields">${(["date", "created", "updated"] as const).map(type => `<button class="b3-button b3-button--outline" data-calendar-create-field="${type}">${window.siyuan.languages.newCol} ${getColNameByType(type)}</button>`).join("")}</div>` : ""}</div>`;
+ ${editable ? `<div class="av__calendar-setup">${getCalendarSettingsHTML(view)}</div><div class="av__calendar-create-fields">${AV_DATE_TYPES.map(type => `<button class="b3-button b3-button--outline" data-calendar-create-field="${type}">${window.siyuan.languages.newCol} ${getColNameByType(type)}</button>`).join("")}</div>` : ""}</div>`;
} else {
for (let start = range.start; start < range.end; start = addCalendarDays(start, 7)) {
const isoWeek = getISOWeekForCalendarRow(start);
diff --git a/app/src/protyle/render/av/calendar/settings.test.ts b/app/src/protyle/render/av/calendar/settings.test.ts
index 4e5973d888..1a475f5134 100644
--- a/app/src/protyle/render/av/calendar/settings.test.ts
+++ b/app/src/protyle/render/av/calendar/settings.test.ts
@@ -1,3 +1,4 @@
+import * as capabilities from "../capabilities";
import * as assert from "node:assert/strict";
import {test} from "node:test";
import {readFileSync} from "node:fs";
@@ -14,7 +15,7 @@ const setup = () => {
compilerOptions: {module: ts.ModuleKind.CommonJS, target: ts.ScriptTarget.ES2022},
}).outputText, {
exports, window, Lute: {NewNodeID: () => "new-field"},
- require: (id: string) => ({
+ require: (id: string) => id === "./capabilities" || id === "../capabilities" ? capabilities : (({
"../../../wysiwyg/transaction": {transaction: (_protyle: IProtyle, perform: IOperation[], undo: IOperation[]) =>
transactions.push({do: perform, undo})},
"../../../../util/escape": {escapeAttr: (value: string) => value, escapeHtml: (value: string) => value},
@@ -26,7 +27,7 @@ const setup = () => {
addItem(item: {label: string; checked: boolean; click: () => void}) { this.items.push(item); }
open() { return; }
}},
- })[id],
+ })[id]),
});
return {methods: exports as typeof import("./settings"), transactions, window, menus};
};
diff --git a/app/src/protyle/render/av/calendar/settings.ts b/app/src/protyle/render/av/calendar/settings.ts
index c222cd070d..f1ae53be76 100644
--- a/app/src/protyle/render/av/calendar/settings.ts
+++ b/app/src/protyle/render/av/calendar/settings.ts
@@ -1,10 +1,11 @@
+import {isAVDateType} from "../capabilities";
import {transaction} from "../../../wysiwyg/transaction";
import {escapeAttr, escapeHtml} from "../../../../util/escape";
import {getColNameByType} from "../col";
import {Menu} from "../../../../plugin/Menu";
import {openViewSettingMenu} from "../viewSettingMenu";
-export const isCalendarDateColumn = (column: IAVColumn) => ["date", "created", "updated"].includes(column?.type);
+export const isCalendarDateColumn = (column: IAVColumn) => isAVDateType(column?.type);
const getCalendarSettingItems = (view: IAVTable): Array<{
key: keyof IAVCalendarSettings;
diff --git a/app/src/protyle/render/av/capabilities.generated.ts b/app/src/protyle/render/av/capabilities.generated.ts
new file mode 100644
index 0000000000..d778d272bc
--- /dev/null
+++ b/app/src/protyle/render/av/capabilities.generated.ts
@@ -0,0 +1,25 @@
+// 此文件由内核字段能力声明生成,请运行 pnpm run api:generate 更新。
+
+import type {AVKeyType, AVKeyCapability} from "../../../types/av";
+
+export const AV_KEY_TYPES: readonly AVKeyType[] = ["block","text","number","date","select","mSelect","url","email","phone","mAsset","template","created","updated","checkbox","relation","rollup","lineNumber"];
+
+export const AV_KEY_CAPABILITIES: Readonly<Record<AVKeyType, AVKeyCapability>> = {
+ "block": {"valueKind":"text","editable":true,"filterable":true,"sortable":true,"groupable":true,"defaultOperator":"Contains"},
+ "text": {"valueKind":"text","editable":true,"filterable":true,"sortable":true,"groupable":true,"defaultOperator":"Contains"},
+ "number": {"valueKind":"number","editable":true,"filterable":true,"sortable":true,"groupable":true,"defaultOperator":"="},
+ "date": {"valueKind":"date","editable":true,"filterable":true,"sortable":true,"groupable":true,"defaultOperator":"="},
+ "select": {"valueKind":"options","editable":true,"filterable":true,"sortable":true,"groupable":true,"defaultOperator":"="},
+ "mSelect": {"valueKind":"options","editable":true,"filterable":true,"sortable":true,"groupable":true,"defaultOperator":"Contains"},
+ "url": {"valueKind":"text","editable":true,"filterable":true,"sortable":true,"groupable":true,"defaultOperator":"Contains"},
+ "email": {"valueKind":"text","editable":true,"filterable":true,"sortable":true,"groupable":true,"defaultOperator":"Contains"},
+ "phone": {"valueKind":"text","editable":true,"filterable":true,"sortable":true,"groupable":true,"defaultOperator":"Contains"},
+ "mAsset": {"valueKind":"assets","editable":true,"filterable":true,"sortable":true,"groupable":true,"defaultOperator":"Contains"},
+ "template": {"valueKind":"text","editable":false,"filterable":true,"sortable":true,"groupable":true,"defaultOperator":"Contains"},
+ "created": {"valueKind":"timestamp","editable":false,"filterable":true,"sortable":true,"groupable":true,"defaultOperator":"="},
+ "updated": {"valueKind":"timestamp","editable":false,"filterable":true,"sortable":true,"groupable":true,"defaultOperator":"="},
+ "checkbox": {"valueKind":"checkbox","editable":true,"filterable":true,"sortable":true,"groupable":true,"defaultOperator":"="},
+ "relation": {"valueKind":"relation","editable":true,"filterable":true,"sortable":true,"groupable":true,"defaultOperator":"Contains any item"},
+ "rollup": {"valueKind":"rollup","editable":false,"filterable":true,"sortable":true,"groupable":false,"defaultOperator":"Contains"},
+ "lineNumber": {"valueKind":"lineNumber","editable":false,"filterable":false,"sortable":false,"groupable":false,"defaultOperator":""},
+};
diff --git a/app/src/protyle/render/av/capabilities.test.ts b/app/src/protyle/render/av/capabilities.test.ts
new file mode 100644
index 0000000000..08c2638a92
--- /dev/null
+++ b/app/src/protyle/render/av/capabilities.test.ts
@@ -0,0 +1,80 @@
+import * as assert from "node:assert/strict";
+import {readFileSync, readdirSync} from "node:fs";
+import * as path from "node:path";
+import {test} from "node:test";
+import * as ts from "typescript";
+import {AV_KEY_CAPABILITIES, AV_KEY_TYPES} from "./capabilities.generated";
+import {
+ AV_DATE_TYPES, getAVDefaultFilterOperator, getAVKeyCapability, hasAVAttributePlaceholder, hasAVCapability,
+ hasAVScalarContent, isAVDateType, isAVLinkType, isAVNewItemTemplateType, isAVReadonlyType, isAVRichTextType,
+ isAVSelectType, isAVTextType, isAVTimestampType, usesAVRollupCellRenderer,
+} from "./capabilities";
+
+test("field capability groups preserve supported field behavior", () => {
+ const groups: Array<[string, (type: string) => boolean, string[]]> = [
+ ["date", isAVDateType, ["date", "created", "updated"]],
+ ["select", isAVSelectType, ["select", "mSelect"]],
+ ["text", isAVTextType, ["text", "block", "url", "email", "phone", "template"]],
+ ["timestamp", isAVTimestampType, ["created", "updated"]],
+ ["readonly", isAVReadonlyType, ["created", "updated", "template", "rollup", "lineNumber"]],
+ ["rich text", isAVRichTextType, ["text", "block", "email", "phone", "template"]],
+ ["link", isAVLinkType, ["block", "url", "email", "phone"]],
+ ["scalar content", hasAVScalarContent, ["number", "text", "block", "url", "phone", "email", "template", "mAsset"]],
+ ["attribute placeholder", hasAVAttributePlaceholder, ["text", "number", "date", "url", "phone", "template", "email"]],
+ ["rollup cell", usesAVRollupCellRenderer, ["template", "select", "mSelect", "mAsset", "relation"]],
+ ["template fields", isAVNewItemTemplateType, ["text", "number", "date", "select", "mSelect", "url", "email", "phone", "mAsset", "checkbox", "relation"]],
+ ];
+ for (const [name, predicate, expected] of groups) {
+ for (const type of [...AV_KEY_TYPES, "unknown", undefined, null]) {
+ assert.equal(predicate(type), expected.includes(type), `${name}: ${type}`);
+ }
+ }
+ assert.deepEqual(AV_DATE_TYPES, ["date", "created", "updated"]);
+ for (const type of AV_KEY_TYPES) {
+ const computed = ["created", "updated", "template", "rollup", "lineNumber"].includes(type);
+ assert.equal(hasAVCapability(type, "editable"), !computed, type);
+ assert.equal(hasAVCapability(type, "filterable"), type !== "lineNumber", type);
+ assert.equal(hasAVCapability(type, "sortable"), type !== "lineNumber", type);
+ assert.equal(hasAVCapability(type, "groupable"), type !== "lineNumber" && type !== "rollup", type);
+ const expected = type === "lineNumber" ? undefined : type === "relation" ? "Contains any item" :
+ ["select", "number", "date", "created", "updated", "checkbox"].includes(type) ? "=" : "Contains";
+ assert.equal(getAVDefaultFilterOperator(type), expected, type);
+ }
+ assert.equal(getAVDefaultFilterOperator("relation", true), "Contains");
+ assert.equal(getAVKeyCapability("unknown"), undefined);
+ assert.equal(hasAVCapability(undefined, "editable"), false);
+ assert.equal(AV_KEY_TYPES.length, Object.keys(AV_KEY_CAPABILITIES).length);
+});
+
+test("field membership decisions use declared capabilities", () => {
+ const root = __dirname;
+ const fields = new Set<string>(AV_KEY_TYPES);
+ const violations: string[] = [];
+ const inspectDirectory = (dir: string) => {
+ for (const entry of readdirSync(dir, {withFileTypes: true})) {
+ const file = path.join(dir, entry.name);
+ if (entry.isDirectory()) {
+ inspectDirectory(file);
+ continue;
+ }
+ if (!file.endsWith(".ts") || file.endsWith(".test.ts") || file.endsWith(".generated.ts")) {
+ continue;
+ }
+ const source = ts.createSourceFile(file, readFileSync(file, "utf8"), ts.ScriptTarget.Latest, true);
+ const visit = (node: ts.Node) => {
+ if (ts.isArrayLiteralExpression(node) && node.elements.length &&
+ node.elements.every(item => ts.isStringLiteral(item) && fields.has(item.text))) {
+ // 菜单面板标识与字段类型独立,允许其按面板名称判断布局。
+ const menuPanel = entry.name === "openMenuPanel.ts" && node.parent.parent.getText(source).includes("options.type");
+ if (!menuPanel) {
+ violations.push(`${path.relative(root, file)}:${source.getLineAndCharacterOfPosition(node.getStart(source)).line + 1}`);
+ }
+ }
+ ts.forEachChild(node, visit);
+ };
+ visit(source);
+ }
+ };
+ inspectDirectory(root);
+ assert.deepEqual(violations, []);
+});
diff --git a/app/src/protyle/render/av/capabilities.ts b/app/src/protyle/render/av/capabilities.ts
new file mode 100644
index 0000000000..1c085e0ab9
--- /dev/null
+++ b/app/src/protyle/render/av/capabilities.ts
@@ -0,0 +1,58 @@
+import type {AVFilterOperator, AVKeyCapability, AVKeyType} from "../../../types/av";
+import {AV_KEY_CAPABILITIES, AV_KEY_TYPES} from "./capabilities.generated";
+
+export const isAVKeyType = (type: string): type is AVKeyType =>
+ Object.prototype.hasOwnProperty.call(AV_KEY_CAPABILITIES, type);
+
+export const getAVKeyCapability = (type: string | undefined | null): AVKeyCapability | undefined =>
+ typeof type === "string" && isAVKeyType(type) ? AV_KEY_CAPABILITIES[type] : undefined;
+
+export const hasAVCapability = (type: string | undefined | null,
+ capability: "editable" | "filterable" | "sortable" | "groupable") =>
+ getAVKeyCapability(type)?.[capability] === true;
+
+export const getAVTypesByCapability = (capability: "editable" | "filterable" | "sortable" | "groupable") =>
+ AV_KEY_TYPES.filter(type => hasAVCapability(type, capability));
+
+export const isAVDateType = (type: string | undefined | null) => {
+ const kind = getAVKeyCapability(type)?.valueKind;
+ return kind === "date" || kind === "timestamp";
+};
+
+export const isAVTimestampType = (type: string | undefined | null) =>
+ getAVKeyCapability(type)?.valueKind === "timestamp";
+
+export const isAVSelectType = (type: string | undefined | null) =>
+ getAVKeyCapability(type)?.valueKind === "options";
+
+export const isAVTextType = (type: string | undefined | null) =>
+ getAVKeyCapability(type)?.valueKind === "text";
+
+export const isAVReadonlyType = (type: string | undefined | null) =>
+ getAVKeyCapability(type)?.editable === false;
+
+export const isAVRichTextType = (type: string | undefined | null) => isAVTextType(type) && type !== "url";
+
+export const isAVLinkType = (type: string | undefined | null) =>
+ isAVTextType(type) && type !== "text" && type !== "template";
+
+export const hasAVScalarContent = (type: string | undefined | null) =>
+ isAVTextType(type) || type === "number" || type === "mAsset";
+
+export const hasAVAttributePlaceholder = (type: string | undefined | null) =>
+ isAVTextType(type) && type !== "block" || type === "number" || type === "date";
+
+export const usesAVRollupCellRenderer = (type: string | undefined | null) =>
+ isAVSelectType(type) || type === "template" || type === "mAsset" || type === "relation";
+
+export const isAVNewItemTemplateType = (type: string | undefined | null) =>
+ hasAVCapability(type, "editable") && type !== "block";
+
+export const getAVDefaultFilterOperator = (type: string, isRollup = false): AVFilterOperator | undefined => {
+ if (type === "relation" && isRollup) {
+ return "Contains";
+ }
+ return getAVKeyCapability(type)?.defaultOperator || undefined;
+};
+
+export const AV_DATE_TYPES = AV_KEY_TYPES.filter(isAVDateType);
diff --git a/app/src/protyle/render/av/cell.ts b/app/src/protyle/render/av/cell.ts
index fbc3605926..a363082c74 100644
--- a/app/src/protyle/render/av/cell.ts
+++ b/app/src/protyle/render/av/cell.ts
@@ -1,3 +1,4 @@
+import {hasAVScalarContent, isAVDateType, isAVReadonlyType, isAVRichTextType, isAVSelectType, isAVTextType, isAVTimestampType, usesAVRollupCellRenderer} from "./capabilities";
import {isTableLikeView} from "./viewType";
import {isAVRenderData} from "./renderData";
import {transaction} from "../../wysiwyg/transaction";
@@ -240,7 +241,7 @@ export const genCellValueByElement = (colType: TAVCol, cellElement: HTMLElement)
content: parseFloat(value) || 0,
isNotEmpty: !!value
};
- } else if (["text", "block", "url", "phone", "email", "template"].includes(colType)) {
+ } else if (isAVTextType(colType)) {
const inputElement = cellElement.querySelector("input, textarea") as HTMLInputElement | HTMLTextAreaElement;
const textElement = cellElement.querySelector(".av__celltext") as HTMLElement ||
cellElement.querySelector(":scope > .fn__flex-1") as HTMLElement;
@@ -263,7 +264,7 @@ export const genCellValueByElement = (colType: TAVCol, cellElement: HTMLElement)
});
});
cellValue.mSelect = mSelect;
- } else if (["date", "created", "updated"].includes(colType)) {
+ } else if (isAVDateType(colType)) {
cellValue[colType as "date"] = JSON.parse(cellElement.querySelector(".av__celltext").getAttribute("data-value"));
} else if (colType === "checkbox") {
cellValue.checkbox = {
@@ -314,10 +315,10 @@ export const genCellValueByElement = (colType: TAVCol, cellElement: HTMLElement)
};
const getCellValueContent = (value: IAVCellValue): string => {
- if (["number", "text", "block", "url", "phone", "email", "template", "mAsset"].includes(value.type)) {
+ if (hasAVScalarContent(value.type)) {
return value[value.type as "text"].content;
}
- if (["mSelect", "select"].includes(value.type)) {
+ if (isAVSelectType(value.type)) {
return value.mSelect[0].content;
}
if (value.type === "rollup") {
@@ -329,7 +330,7 @@ const getCellValueContent = (value: IAVCellValue): string => {
if (value.type === "relation") {
return getCellValueContent(value.relation.contents[0]);
}
- if (["date", "created", "updated"].includes(value.type)) {
+ if (isAVDateType(value.type)) {
return dayjs(value[value.type as "date"].content).format("YYYY-MM-DD HH:mm");
}
if (value.type === "lineNumber") {
@@ -349,7 +350,7 @@ const transformCellValue = (colType: TAVCol, value: IAVCellValue): IAVCellValue
type: colType,
};
if (colType === "number") {
- if (["date", "created", "updated"].includes(value.type)) {
+ if (isAVDateType(value.type)) {
newValue.number = {
content: value[value.type as "date"].content,
isNotEmpty: value[value.type as "date"].isNotEmpty
@@ -360,7 +361,7 @@ const transformCellValue = (colType: TAVCol, value: IAVCellValue): IAVCellValue
isNotEmpty: true
};
}
- } else if (["text", "block", "url", "phone", "email", "template"].includes(colType)) {
+ } else if (isAVTextType(colType)) {
newValue[colType as "text"] = {
content: getCellValueContent(value).toString()
};
@@ -388,8 +389,8 @@ const transformCellValue = (colType: TAVCol, value: IAVCellValue): IAVCellValue
content,
name: "",
}];
- } else if (["date", "created", "updated"].includes(colType)) {
- if (["date", "created", "updated"].includes(value.type)) {
+ } else if (isAVDateType(colType)) {
+ if (isAVDateType(value.type)) {
newValue[colType as "date"] = JSON.parse(JSON.stringify(value[value.type as "date"]));
} else {
newValue[colType as "date"] = {
@@ -423,7 +424,7 @@ export const genCellValue = (colType: TAVCol, value: string | any, dateFormat: T
isNotEmpty: true
}
};
- } else if (["text", "block", "url", "phone", "email", "template"].includes(colType)) {
+ } else if (isAVTextType(colType)) {
cellValue = {
type: colType,
[colType]: {
@@ -445,7 +446,7 @@ export const genCellValue = (colType: TAVCol, value: string | any, dateFormat: T
checked: true
}
};
- } else if (["date", "created", "updated"].includes(colType)) {
+ } else if (isAVDateType(colType)) {
cellValue = {
type: colType,
[colType]: parseDateValue(value, dateFormat)
@@ -664,7 +665,7 @@ export const popTextCell = (protyle: IProtyle, cellElements: HTMLElement[], type
}
style = `style='${style}'`;
- if (["text", "email", "phone", "block", "template"].includes(type)) {
+ if (isAVRichTextType(type)) {
html = `<textarea ${style} spellcheck="false" class="b3-text-field"></textarea>`;
} else if (type === "url") {
const content = storedCellValue?.url?.content ?? cellElements[0].firstElementChild.getAttribute("data-href") ?? "";
@@ -677,7 +678,7 @@ export const popTextCell = (protyle: IProtyle, cellElements: HTMLElement[], type
/// #if MOBILE
activeBlur(true);
/// #endif
- if (["select", "mSelect"].includes(type)) {
+ if (isAVSelectType(type)) {
if (blockElement.getAttribute("data-rendering") === "true") {
options?.destroyCallback?.();
return;
@@ -792,7 +793,7 @@ export const popTextCell = (protyle: IProtyle, cellElements: HTMLElement[], type
return cellElements[0];
}, contentElement || undefined);
}
- if (["text", "email", "phone", "block", "template"].includes(type)) {
+ if (isAVRichTextType(type)) {
const storedContent = type === "template" ? undefined :
storedCellValue?.[type as "text"]?.content;
inputElement.value = typeof storedContent === "string" ? storedContent :
@@ -1035,7 +1036,7 @@ export const updateCellsValue = async (protyle: IProtyle, nodeElement: HTMLEleme
if (!type) {
continue;
}
- const readonly = ["created", "updated", "template", "rollup", "lineNumber"].includes(type);
+ const readonly = isAVReadonlyType(type);
const cellId = source.selectedCell?.cell.id || item?.dataset.id || "";
const colId = source.selectedCell?.colID || (item ? getColId(item, viewType) : "");
const renderedOldValue = source.selectedCell?.cell.value ||
@@ -1392,7 +1393,7 @@ export const renderCell = (cellValue: IAVCellValue, rowIndex = 0, showIcon = tru
} else {
text = `<span class="av__celltext">${cellValue ? escapeHtmlTextAndAttr(cellValue.text.content || "") : ""}</span>`;
}
- } else if (["email", "phone"].includes(cellValue.type)) {
+ } else if ((cellValue.type === "email" || cellValue.type === "phone")) {
text = `<span class="av__celltext av__celltext--url" data-type="${cellValue.type}">${cellValue ? escapeHtmlTextAndAttr(cellValue[cellValue.type as "email"].content || "") : ""}</span>`;
} else if ("url" === cellValue.type) {
text = renderCellURL(cellValue?.url?.content || "");
@@ -1434,14 +1435,14 @@ export const renderCell = (cellValue: IAVCellValue, rowIndex = 0, showIcon = tru
text += `<svg class="av__cellicon"><use xlink:href="#iconForward"></use></svg>${escapeHtml(formatDateDisplay(dataValue.content2, dateFormat, dataValue.isNotTime))}`;
}
text += "</span>";
- } else if (["created", "updated"].includes(cellValue.type)) {
+ } else if (isAVTimestampType(cellValue.type)) {
const dataValue = cellValue ? cellValue[cellValue.type as "date"] : null;
text = `<span class="av__celltext" data-value='${JSON.stringify(dataValue)}'>`;
if (dataValue && dataValue.isNotEmpty) {
text += escapeHtml(dataValue.formattedContent || formatDateValue(dataValue, dateFormat));
}
text += "</span>";
- } else if (["lineNumber"].includes(cellValue.type)) {
+ } else if (cellValue.type === "lineNumber") {
// 渲染行号
text = `<span class="av__celltext" data-value='${rowIndex + 1}'>${rowIndex + 1}</span>`;
} else if (cellValue.type === "mAsset") {
@@ -1461,7 +1462,7 @@ export const renderCell = (cellValue: IAVCellValue, rowIndex = 0, showIcon = tru
} else if (cellValue.type === "rollup") {
let rollupType;
cellValue?.rollup?.contents?.forEach((item) => {
- const rollupText = ["template", "select", "mSelect", "mAsset", "relation"].includes(item.type) ? renderCell(item, rowIndex, showIcon, type, undefined, "", undefined, false) : renderRollup(item, showIcon);
+ const rollupText = usesAVRollupCellRenderer(item.type) ? renderCell(item, rowIndex, showIcon, type, undefined, "", undefined, false) : renderRollup(item, showIcon);
if (rollupText) {
text += rollupText + (item.type === "checkbox" ? "" : ", ");
}
@@ -1485,7 +1486,7 @@ export const renderCell = (cellValue: IAVCellValue, rowIndex = 0, showIcon = tru
if (showCopy && cellValue.type === "rollup" && text) {
text += `<button class="av__cell-action ariaLabel" type="button" data-position="4north" aria-label="${window.siyuan.languages.copy}" data-type="copy" data-rollup-value="${escapeAttr(encodeURIComponent(JSON.stringify(cellValue.rollup?.contents || [])))}"><svg><use xlink:href="#iconCopy"></use></svg></button>`;
- } else if (showCopy && ((["text", "template", "url", "email", "phone", "date", "created", "updated"].includes(cellValue.type) && cellValue[cellValue.type as "url"]?.content) ||
+ } else if (showCopy && ((((isAVTextType(cellValue.type) && cellValue.type !== "block") || isAVDateType(cellValue.type)) && cellValue[cellValue.type as "url"]?.content) ||
cellValue.type === "lineNumber" ||
(cellValue.type === "number" && cellValue.number?.isNotEmpty) ||
(cellValue.type === "block" && cellValue.block?.content))) {
@@ -1528,9 +1529,9 @@ export const getAVSelectedCellData = (blockElement: HTMLElement) => {
const renderRollup = (cellValue: IAVCellValue, showIcon: boolean) => {
let text = "";
- if (["text"].includes(cellValue.type)) {
+ if (cellValue.type === "text") {
text = cellValue ? escapeHtmlTextAndAttr(cellValue[cellValue.type as "text"].content || "") : "";
- } else if (["email", "phone"].includes(cellValue.type)) {
+ } else if ((cellValue.type === "email" || cellValue.type === "phone")) {
const emailContent = cellValue ? cellValue[cellValue.type as "email"].content : "";
if (emailContent) {
text = `<span class="av__celltext av__celltext--url" data-type="${cellValue.type}">${escapeHtmlTextAndAttr(emailContent)}</span>`;
@@ -1550,7 +1551,7 @@ const renderRollup = (cellValue: IAVCellValue, showIcon: boolean) => {
text = cellValue?.number.formattedContent || cellValue?.number.content.toString() || "";
} else if (cellValue.type === "checkbox") {
text += `<svg class="av__checkbox"><use xlink:href="#icon${cellValue?.checkbox?.checked ? "Check" : "Uncheck"}"></use></svg><span class="fn__space"></span>`;
- } else if (["date", "updated", "created"].includes(cellValue.type)) {
+ } else if (isAVDateType(cellValue.type)) {
const dataValue = cellValue ? cellValue[cellValue.type as "date"] : null;
if (dataValue.formattedContent) {
text = dataValue.formattedContent;
@@ -1642,7 +1643,7 @@ export const dragFillCellsValue = (protyle: IProtyle, nodeElement: HTMLElement,
const showIcon = activeElement.querySelector(".b3-menu__avemoji") ? true : false;
Object.keys(newData).forEach((rowID, index) => {
newData[rowID].forEach((item, cellIndex) => {
- if (["rollup", "template", "created", "updated", "lineNumber"].includes(item.type) ||
+ if (isAVReadonlyType(item.type) ||
(item.type === "block" && item.element.getAttribute("data-detached") !== "true")) {
return;
}
@@ -1699,7 +1700,7 @@ export const addDragFill = (cellElement: Element) => {
cellElement.classList.add("av__cell--active");
if (!cellElement.querySelector(".av__drag-fill")) {
const cellType = cellElement.getAttribute("data-dtype") as TAVCol;
- if (["template", "rollup", "lineNumber", "created", "updated"].includes(cellType)) {
+ if (isAVReadonlyType(cellType)) {
return;
}
cellElement.insertAdjacentHTML("beforeend", `<div aria-label="${window.siyuan.languages.dragFill}" class="av__drag-fill ariaLabel"></div>`);
diff --git a/app/src/protyle/render/av/cellInputPosition.test.ts b/app/src/protyle/render/av/cellInputPosition.test.ts
index 25ba42dd9a..2a716bda98 100644
--- a/app/src/protyle/render/av/cellInputPosition.test.ts
+++ b/app/src/protyle/render/av/cellInputPosition.test.ts
@@ -1,4 +1,5 @@
import * as assert from "node:assert/strict";
+import * as capabilities from "./capabilities";
import {readFileSync} from "node:fs";
import {test} from "node:test";
import {runInNewContext} from "node:vm";
@@ -204,6 +205,7 @@ const openInput = (positionByMenu = false) => {
};
const exports: {popTextCell?: (protyle: unknown, cells: unknown[], type: string, options: unknown) => void} = {};
runInNewContext(popCompiled, {
+ ...capabilities,
exports, isTableLikeView: () => true, hasClosestBlock: () => block, hasClosestByClassName: (): null => null,
getComputedStyle: () => ({}), getStoredCellValueByElement: (): undefined => undefined,
escapeAttr: (value: string) => value,
diff --git a/app/src/protyle/render/av/cellValue.ts b/app/src/protyle/render/av/cellValue.ts
index 6815e9918f..6b3d4f6c3b 100644
--- a/app/src/protyle/render/av/cellValue.ts
+++ b/app/src/protyle/render/av/cellValue.ts
@@ -1,3 +1,4 @@
+import {isAVDateType, isAVSelectType, isAVTextType} from "./capabilities";
import type {IAVSelectedCell} from "./selectionState";
// 按行和字段同步已加载的数据,供后续编辑读取,不依赖选区或单元格是否已渲染。
@@ -52,19 +53,19 @@ export const cellValueIsEmpty = (value: IAVCellValue, useRenderedContent = false
if (value.type === "checkbox") {
return false;
}
- if (["text", "block", "url", "phone", "email", "template"].includes(value.type)) {
+ if (isAVTextType(value.type)) {
return !value[value.type as "text"]?.content;
}
if (value.type === "number") {
return value.number ? !value.number.isNotEmpty : true;
}
- if (["mSelect", "mAsset", "select"].includes(value.type)) {
+ if ((isAVSelectType(value.type) || value.type === "mAsset")) {
if (value[(value.type === "select" ? "mSelect" : value.type) as "mSelect"]?.length > 0) {
return false;
}
return true;
}
- if (["date", "created", "updated"].includes(value.type)) {
+ if (isAVDateType(value.type)) {
return !value[value.type as "date"]?.isNotEmpty &&
!value[value.type as "date"]?.isNotEmpty2;
}
@@ -91,7 +92,7 @@ export const genEmptyAVCellValue = (colType: TAVCol): IAVCellValue => {
content: 0,
isNotEmpty: false,
};
- } else if (["text", "block", "url", "phone", "email", "template"].includes(colType)) {
+ } else if (isAVTextType(colType)) {
cellValue[colType as "text"] = {
content: "",
};
@@ -99,7 +100,7 @@ export const genEmptyAVCellValue = (colType: TAVCol): IAVCellValue => {
cellValue.mSelect = [];
} else if (colType === "mAsset") {
cellValue.mAsset = [];
- } else if (["date", "created", "updated"].includes(colType)) {
+ } else if (isAVDateType(colType)) {
cellValue[colType as "date"] = {
content: null,
isNotEmpty: false,
diff --git a/app/src/protyle/render/av/col.ts b/app/src/protyle/render/av/col.ts
index 90d23ddffc..c4fac08c41 100644
--- a/app/src/protyle/render/av/col.ts
+++ b/app/src/protyle/render/av/col.ts
@@ -1,3 +1,4 @@
+import {hasAVCapability, isAVReadonlyType, isAVSelectType, isAVTimestampType} from "./capabilities";
import {isTableLikeView} from "./viewType";
import {isAVRenderData} from "./renderData";
import {Menu} from "../../../plugin/Menu";
@@ -146,7 +147,7 @@ export const getEditHTML = (options: {
<span class="b3-menu__accelerator" style="margin-left: 0">${getColNameByType(colData.type)}</span>
<svg class="b3-menu__icon b3-menu__icon--small"><use xlink:href="#iconRight"></use></svg>
</button>`;
- if (["mSelect", "select"].includes(colData.type)) {
+ if (isAVSelectType(colData.type)) {
html += `<button class="b3-menu__separator" data-id="separator_2"></button>
<button class="b3-menu__item" data-type="nobg">
<svg class="b3-menu__icon"><use xlink:href="#iconAdd"></use></svg>
@@ -214,7 +215,7 @@ export const getEditHTML = (options: {
<span class="fn__space fn__flex-1"></span>
<input data-type="fillSpecificTime" type="checkbox" class="b3-switch b3-switch--menu" ${colData.date?.fillSpecificTime ? "checked" : ""}>
</label>`;
- } else if (["updated", "created"].includes(colData.type)) {
+ } else if (isAVTimestampType(colData.type)) {
html += `<button class="b3-menu__separator" data-id="separator_2"></button>
<button class="b3-menu__item" data-type="dateFormat" data-format="${colData.dateFormat || ""}">
<svg class="b3-menu__icon"><use xlink:href="#iconFormat"></use></svg>
@@ -227,7 +228,7 @@ export const getEditHTML = (options: {
<input data-type="includeTime" type="checkbox" class="b3-switch b3-switch--menu" ${(!colData[colData.type as "updated"] || colData[colData.type as "updated"].includeTime) ? "checked" : ""}>
</label>`;
}
- if (!["template", "rollup", "lineNumber", "created", "updated"].includes(colData.type)) {
+ if (!isAVReadonlyType(colData.type)) {
const renderTemplate = colData.renderTemplate || "";
html += `<button class="b3-menu__separator" data-id="separator_render_template"></button>
<button class="b3-menu__item" data-type="nobg">
@@ -1159,7 +1160,7 @@ export const showColMenu = (protyle: IProtyle, blockElement: Element, cellElemen
menu.addSeparator({id: "separator_1"});
// 行号类型不参与筛选和排序
- if (type !== "lineNumber") {
+ if (hasAVCapability(type, "filterable")) {
menu.addItem({
id: "filter",
icon: "iconFilter",
diff --git a/app/src/protyle/render/av/columnWidth.ts b/app/src/protyle/render/av/columnWidth.ts
index b7744b000a..2ff0d5dee7 100644
--- a/app/src/protyle/render/av/columnWidth.ts
+++ b/app/src/protyle/render/av/columnWidth.ts
@@ -1,3 +1,4 @@
+import {isAVSelectType} from "./capabilities";
import {hasAVRenderTemplateResult} from "./cellValue";
export const updateAVTableColumnWidths = (view: IAVTable, widths: Record<string, string>) => {
@@ -39,7 +40,7 @@ export const getAVColumnTextMeasurer = (blockElement: HTMLElement) => {
export const getAVColumnFitWidth = (name: string, type: TAVCol, values: string[],
measureText = getEstimatedTextWidth, extraWidths: number[] = []) => {
const headerWidth = measureText(name) + 42;
- const contentPadding = ["select", "mSelect"].includes(type) ? 32 : 20;
+ const contentPadding = isAVSelectType(type) ? 32 : 20;
const contentWidth = values.reduce((width, value, index) =>
Math.max(width, measureText(value) + contentPadding + (extraWidths[index] || 0)), 0);
return `${Math.ceil(Math.min(480, Math.max(64, headerWidth, contentWidth)))}px`;
@@ -63,7 +64,7 @@ export const getAVRelationColumnWidth = (fitWidth: string, type: TAVCol, primary
// 表头为字段图标、排序箭头和内边距预留空间。
const width = Math.max(parseFloat(fitWidth) || 64, nameWidth + 62);
const minWidth = primary ? 240 : 64;
- const maxWidth = primary ? 400 : ["relation", "rollup", "mAsset"].includes(type) ? 200 : 160;
+ const maxWidth = primary ? 400 : (type === "relation" || type === "rollup" || type === "mAsset") ? 200 : 160;
return `${Math.min(maxWidth, Math.max(minWidth, width))}px`;
};
diff --git a/app/src/protyle/render/av/conditionalColorMenu.test.ts b/app/src/protyle/render/av/conditionalColorMenu.test.ts
index 4636519c2e..fc2b48d745 100644
--- a/app/src/protyle/render/av/conditionalColorMenu.test.ts
+++ b/app/src/protyle/render/av/conditionalColorMenu.test.ts
@@ -1,3 +1,4 @@
+import * as capabilities from "./capabilities";
import * as assert from "node:assert/strict";
import {readFileSync} from "node:fs";
import {test} from "node:test";
@@ -24,7 +25,7 @@ test("returning from the color menu during field loading does not restore or bin
}).outputText, {
exports: methods,
window: {siyuan: {config: {}, languages: {conditionalColors: "Colors"}}},
- require: (name: string) => name === "./filter" ? {prepareFilterColumns: () => loading} : {},
+ require: (name: string) => name === "./capabilities" || name === "../capabilities" ? capabilities : (name === "./filter" ? {prepareFilterColumns: () => loading} : {}),
});
const pending = methods.openConditionalColorsMenu({
protyle: {options: {}} as IProtyle,
@@ -67,7 +68,7 @@ test("rule menus dismiss outside dropdowns, preserve selections, and support dra
compilerOptions: {module: ModuleKind.CommonJS, target: ScriptTarget.ES2022},
}).outputText, {
exports: methods, window,
- require: (name: string) => ({
+ require: (name: string) => name === "./capabilities" || name === "../capabilities" ? capabilities : (({
"./filter": {prepareFilterColumns: async () => {}},
"./view": {getFieldsByData: () => [{id: "text", type: "text"}]},
"../../../util/escape": {escapeAttr: String},
@@ -75,7 +76,7 @@ test("rule menus dismiss outside dropdowns, preserve selections, and support dra
"../../wysiwyg/transaction": {transaction: (_protyle: IProtyle, perform: IOperation[], undo: IOperation[]) => {
transactions.push({perform, undo});
}},
- })[name] || {},
+ })[name] || {}),
});
const rules: IAVConditionalColorRule[] = ["a", "b", "c"].map(id => ({id, target: "item", color: null,
matchOption: false, filter: {column: "text", operator: "Is not empty"}}));
diff --git a/app/src/protyle/render/av/conditionalColorMenu.ts b/app/src/protyle/render/av/conditionalColorMenu.ts
index 231d2c0fc0..7f7b7285b4 100644
--- a/app/src/protyle/render/av/conditionalColorMenu.ts
+++ b/app/src/protyle/render/av/conditionalColorMenu.ts
@@ -1,3 +1,4 @@
+import {isAVSelectType} from "./capabilities";
import {Menu} from "../../../plugin/Menu";
import {escapeAttr, escapeHtml} from "../../../util/escape";
import {transaction} from "../../wysiwyg/transaction";
@@ -84,7 +85,7 @@ ${data.viewType === "table" || rule.target === "property" ? `<select class="b3-s
save: filters => {
const field = fields.find(field => field.id === filters[0]?.column);
const current = rules.find(item => item.id === rule.id);
- const matchOption = current.matchOption && ["select", "mSelect"].includes(field?.type) &&
+ const matchOption = current.matchOption && isAVSelectType(field?.type) &&
filters[0]?.valueSource !== "rendered";
update(rule.id, {filter: filters[0], matchOption}, false);
if (current.matchOption !== matchOption) {
@@ -175,14 +176,14 @@ ${data.viewType === "table" || rule.target === "property" ? `<select class="b3-s
fields.forEach(field => menu.addItem({label: escapeHtml(field.name), click: () => {
const {value, operator} = genEmptyFilterValue(field);
save([...rules, {id: Lute.NewNodeID(), target: "item", color: null,
- matchOption: ["select", "mSelect"].includes(field.type),
+ matchOption: isAVSelectType(field.type),
filter: {column: field.id, operator: field.type === "checkbox" ? operator : "Is not empty", value}}]);
}}));
openViewSettingMenu(menu, target);
} else if (action === "color" && rule) {
const menu = new Menu();
const field = fields.find(field => field.id === rule.filter.column);
- if (["select", "mSelect"].includes(field?.type) && rule.filter.valueSource !== "rendered") {
+ if (isAVSelectType(field?.type) && rule.filter.valueSource !== "rendered") {
menu.addItem({iconHTML: "",
label: `<label class="fn__flex fn__pointer"><span>${lang.conditionalColorFirstOption}</span><span class="fn__space fn__flex-1"></span><input type="checkbox" class="b3-switch b3-switch--menu"${rule.matchOption ? " checked" : ""}></label>`,
bind(element) {
diff --git a/app/src/protyle/render/av/dateFormat.ts b/app/src/protyle/render/av/dateFormat.ts
index 652b86386d..afc755e226 100644
--- a/app/src/protyle/render/av/dateFormat.ts
+++ b/app/src/protyle/render/av/dateFormat.ts
@@ -1,9 +1,10 @@
+import {isAVDateType} from "./capabilities";
const pad = (value: number) => value.toString().padStart(2, "0");
const getMonths = (): string[] => window.siyuan.languages._attrView.dateMonths.split("|");
export const getDefaultDateFormat = (type: TAVCol): TAVDateFormat =>
- ["date", "created", "updated"].includes(type) ? "full" : "";
+ isAVDateType(type) ? "full" : "";
export const formatDateDisplay = (content: number, format: TAVDateFormat = "", isNotTime = true) => {
const date = new Date(content);
diff --git a/app/src/protyle/render/av/fieldValueEditor.test.ts b/app/src/protyle/render/av/fieldValueEditor.test.ts
index 0f41c839ee..5609995d3f 100644
--- a/app/src/protyle/render/av/fieldValueEditor.test.ts
+++ b/app/src/protyle/render/av/fieldValueEditor.test.ts
@@ -1,3 +1,4 @@
+import * as capabilities from "./capabilities";
import * as assert from "node:assert/strict";
import {readFileSync} from "node:fs";
import {test} from "node:test";
@@ -10,7 +11,7 @@ test("numeric field editors accept decimal steps and preserve decimal and empty
compilerOptions: {module: ModuleKind.CommonJS, target: ScriptTarget.ES2022},
}).outputText, {
exports: methods,
- require: (name: string) => name === "../../../util/escape" ? {escapeAttr: String} : {},
+ require: (name: string) => name === "./capabilities" || name === "../capabilities" ? capabilities : (name === "../../../util/escape" ? {escapeAttr: String} : {}),
});
const column = {type: "number"} as IAVColumn;
for (const content of ["1.25", "-0.125", "1e-7", "0", ""]) {
diff --git a/app/src/protyle/render/av/fieldValueEditor.ts b/app/src/protyle/render/av/fieldValueEditor.ts
index ce66ca1817..cc442eecba 100644
--- a/app/src/protyle/render/av/fieldValueEditor.ts
+++ b/app/src/protyle/render/av/fieldValueEditor.ts
@@ -1,3 +1,4 @@
+import {isAVSelectType} from "./capabilities";
import {Menu} from "../../../plugin/Menu";
import {escapeAttr, escapeHtml} from "../../../util/escape";
import {fetchPost} from "../../../util/fetch";
@@ -125,7 +126,7 @@ export const getValueInputHTML = (column: IAVColumn, fieldValue?: IAVNewItemFiel
const checked = value?.checkbox?.checked || false;
return `<button class="fn__flex-center" data-role="field-value" data-value-type="checkbox" aria-label="${escapeAttr(column.name || window.siyuan.languages.checkbox)}" aria-pressed="${checked}" type="button" style="background:transparent;border:0;color:inherit;padding:0"><svg class="av__checkbox"><use xlink:href="#icon${checked ? "Check" : "Uncheck"}"></use></svg></button>`;
}
- if (["select", "mSelect"].includes(column.type)) {
+ if (isAVSelectType(column.type)) {
const selected = value?.mSelect?.map(item => item.content) || [];
return getSelectedOptionsHTML(column, selected);
}
diff --git a/app/src/protyle/render/av/filter.ts b/app/src/protyle/render/av/filter.ts
index d63aa30fd2..24e7d654ca 100644
--- a/app/src/protyle/render/av/filter.ts
+++ b/app/src/protyle/render/av/filter.ts
@@ -1,3 +1,4 @@
+import {getAVDefaultFilterOperator, hasAVCapability, hasAVScalarContent, isAVDateType, isAVTextType} from "./capabilities";
import {Menu} from "../../../plugin/Menu";
import {transaction} from "../../wysiwyg/transaction";
import {escapeAttr, escapeHtml} from "../../../util/escape";
@@ -36,18 +37,7 @@ const getSetFiltersOperation = (avID: string, blockID: string, data: IAVFilter[]
};
export const getDefaultOperatorByType = (type: TAVCol, isRollup = false) => {
- if (type === "relation" && !isRollup) {
- return "Contains any item";
- }
- if (["select", "number", "date", "created", "updated"].includes(type)) {
- return "=";
- }
- if (["checkbox"].includes(type)) {
- return "=";
- }
- if (["rollup", "relation", "mAsset", "text", "mSelect", "url", "block", "email", "phone", "template"].includes(type)) {
- return "Contains";
- }
+ return getAVDefaultFilterOperator(type, isRollup);
};
// getEditableFilters 返回可直接增删改的叶子/分组数组。
@@ -189,7 +179,7 @@ export const addFilter = (options: {
}
getFieldsByData(options.data).forEach((column) => {
// 行号类型列不可筛选
- if (column.type !== "lineNumber") {
+ if (hasAVCapability(column.type, "filterable")) {
menu.addItem({
label: column.name,
iconHTML: column.icon ? unicode2Emoji(column.icon, "b3-menu__icon", true) : `<svg class="b3-menu__icon"><use xlink:href="#${getColIconByType(column.type)}"></use></svg>`,
@@ -295,7 +285,7 @@ export const getFiltersHTML = (data: IAV, single = false) => {
const iconHTML = colData.icon
? unicode2Emoji(colData.icon, "b3-menu__icon", true)
: `<svg class="b3-menu__icon"><use xlink:href="#${getColIconByType(colData.type)}"></use></svg>`;
- const fieldOptions = fields.filter((f: IAVColumn) => f.type !== "lineNumber").map((f: IAVColumn) =>
+ const fieldOptions = fields.filter((f: IAVColumn) => hasAVCapability(f.type, "filterable")).map((f: IAVColumn) =>
`<option value="${f.id}" ${f.id === node.column ? "selected" : ""}>${escapeHtml(f.name)}</option>`
).join("");
const fieldSelect = `<select class="b3-select fn__flex-1 av__filter-field" data-type="fieldSelect" data-path="${path}">${fieldOptions}</select>`;
@@ -627,7 +617,7 @@ const genInlineFilterHTML = (filter: IAVFilter, colData: IAVColumn, path: string
let valueHTML = "";
let extraHTML = ""; // 放在 valueContainer 外的附加 HTML(如 select 下拉面板,避免影响行宽)
const filterValue = getFilterCellValue(filter);
- if (["text", "url", "block", "email", "phone", "template"].includes(valueType)) {
+ if (isAVTextType(valueType)) {
const content = valueType === "template" && filterValue && filterValue.type !== "template" ?
getCellValueText(filterValue) : filterValue?.[valueType as "text"]?.content || "";
valueHTML = `<input class="b3-text-field b3-text-field--text fn__flex-1" value="${escapeFilterValue(content)}" data-type="filterValue" data-path="${path}">`;
@@ -640,7 +630,7 @@ const genInlineFilterHTML = (filter: IAVFilter, colData: IAVColumn, path: string
} else if (valueType === "checkbox") {
const isChecked = filterValue?.checkbox?.checked;
valueHTML = `<select class="b3-select" data-type="filterValue" data-path="${path}"><option value="true" ${isChecked ? "selected" : ""}>${window.siyuan.languages.checked}</option><option value="false" ${!isChecked ? "selected" : ""}>${window.siyuan.languages.unchecked}</option></select>`;
- } else if (["date", "created", "updated"].includes(valueType)) {
+ } else if (isAVDateType(valueType)) {
const dateHTML = genInlineDateHTML(filter, valueType, path);
valueHTML = dateHTML.valueHTML;
const endpointSelect = valueType === "date"
@@ -836,11 +826,11 @@ const readInlineValue = (rowElement: HTMLElement, valueType: TAVCol, operator: s
const input = rowElement.querySelector('[data-type="filterValue"]') as HTMLInputElement;
newValue = input?.value ? genCellValue("relation", input.value) : genEmptyCellValue("relation");
}
- } else if (["text", "url", "block", "email", "phone", "template", "mAsset", "number"].includes(valueType)) {
+ } else if (hasAVScalarContent(valueType)) {
const input = rowElement.querySelector('[data-type="filterValue"]') as HTMLInputElement;
const val = input?.value || "";
newValue = val ? genCellValue(valueType, val) : genEmptyCellValue(valueType);
- } else if (["date", "created", "updated"].includes(valueType)) {
+ } else if (isAVDateType(valueType)) {
// 修正点①:用 data-type 精确定位绝对日期 input
const dateTypeSel = rowElement.querySelector('[data-type="dateType"]') as HTMLSelectElement;
const isRelative = dateTypeSel?.value === "custom";
@@ -1148,7 +1138,7 @@ export const bindInlineFilterEvents = (panelElement: HTMLElement, data: IAV, pro
const {type: valueType, isRollup} = resolveFilterValueType(filter, colData);
const newOp = (target as HTMLSelectElement).value;
const oldOp = filter.operator;
- const structureChange = (["date", "created", "updated"].includes(valueType) &&
+ const structureChange = (isAVDateType(valueType) &&
((newOp === "Is between") !== (oldOp === "Is between"))) ||
((newOp === "Is empty" || newOp === "Is not empty") !== (oldOp === "Is empty" || oldOp === "Is not empty")) ||
(valueType === "relation" && (!isRollup || isRelationRollupColumn(colData)) &&
diff --git a/app/src/protyle/render/av/filterEditor.test.ts b/app/src/protyle/render/av/filterEditor.test.ts
index 779e20160d..cbbb5c4e65 100644
--- a/app/src/protyle/render/av/filterEditor.test.ts
+++ b/app/src/protyle/render/av/filterEditor.test.ts
@@ -1,3 +1,4 @@
+import * as capabilities from "./capabilities";
import * as assert from "node:assert/strict";
import {readFileSync} from "node:fs";
import {test} from "node:test";
@@ -11,10 +12,10 @@ test("selection conditions with the same path read only their own editor options
}).outputText, {
exports: methods,
document: {querySelector: () => assert.fail("must not read another condition's options")},
- require: (name: string) => ({
+ require: (name: string) => name === "./capabilities" || name === "../capabilities" ? capabilities : (({
"./view": {getFieldsByData: () => [{id: "choice", type: "mSelect"}]},
"./cell": {genCellValue: (type: string, mSelect: IAVCellSelectValue[]) => ({type, mSelect})},
- })[name] || {},
+ })[name] || {}),
});
for (const selected of [[], ["own option"]]) {
const listeners = new Map<string, (event: unknown) => void>();
@@ -48,7 +49,7 @@ test("nested color conditions do not change the parent view filter, including ca
compilerOptions: {module: ModuleKind.CommonJS, target: ScriptTarget.ES2022},
}).outputText, {
exports: methods,
- require: (name: string) => name === "./view" ? {getFieldsByData: () => fields} : {},
+ require: (name: string) => name === "./capabilities" || name === "../capabilities" ? capabilities : (name === "./view" ? {getFieldsByData: () => fields} : {}),
});
const createEditor = () => {
const listeners = new Map<string, Array<(event: unknown) => void>>();
diff --git a/app/src/protyle/render/av/filterRelationRollup.test.ts b/app/src/protyle/render/av/filterRelationRollup.test.ts
index 43927b5a85..aada781686 100644
--- a/app/src/protyle/render/av/filterRelationRollup.test.ts
+++ b/app/src/protyle/render/av/filterRelationRollup.test.ts
@@ -1,3 +1,4 @@
+import * as capabilities from "./capabilities";
import * as assert from "node:assert/strict";
import {readFileSync} from "node:fs";
import {test} from "node:test";
@@ -16,7 +17,7 @@ const createEditor = () => {
exports: methods,
window: {siyuan: {languages: new Proxy({}, {get: (_, name) => String(name)})}},
document: {createElement: () => ({style: {}, offsetWidth: 10}), body: {appendChild() {}, removeChild() {}}},
- require: (name: string) => ({
+ require: (name: string) => name === "./capabilities" || name === "../capabilities" ? capabilities : (({
"./view": {getFieldsByData: () => fields},
"./col": {getColIconByType: () => "iconDatabase"},
"../../../util/escape": {escapeAttr: String, escapeHtml: String},
@@ -27,7 +28,7 @@ const createEditor = () => {
id: "staff", type: "relation", relation: {avID: "employees-db"},
}}]}} : {rows: {values: [{blockID: "alice", block: {content: "Alice"}}]}}};
}},
- })[name] || {},
+ })[name] || {}),
});
const data = {view: {filters: [{column: rollup.id, operator: "Contains any item", value: {
type: "rollup", rollup: {contents: [{type: "relation", relation: {blockIDs: ["alice"], contents: []}}]},
diff --git a/app/src/protyle/render/av/gallery/item.ts b/app/src/protyle/render/av/gallery/item.ts
index 6bd3fdebe2..4b560e0e92 100644
--- a/app/src/protyle/render/av/gallery/item.ts
+++ b/app/src/protyle/render/av/gallery/item.ts
@@ -1,3 +1,4 @@
+import {isAVTimestampType} from "../capabilities";
import {genCellValue, getTypeByCellElement, renderCell, renderCellAttr} from "../cell";
import {fetchPost} from "../../../../util/fetch";
import {setPage} from "../row";
@@ -20,7 +21,7 @@ export const insertGalleryItemAnimation = (options: {
sideItemElement = options.blockElement.querySelector(groupQuery + ".av__gallery-add").previousElementSibling;
}
const bodyElement = options.blockElement.querySelector(`.av__body[data-group-id="${options.groupID}"] `);
- if (bodyElement && ["updated", "created"].includes(bodyElement.getAttribute("data-dtype")) &&
+ if (bodyElement && isAVTimestampType(bodyElement.getAttribute("data-dtype")) &&
bodyElement.getAttribute("data-content") !== "_@today@_") {
sideItemElement = options.blockElement.querySelector('.av__body[data-content="_@today@_"] .av__gallery-add')?.previousElementSibling;
if (!sideItemElement) {
diff --git a/app/src/protyle/render/av/groups.ts b/app/src/protyle/render/av/groups.ts
index 14c23c3cb7..553c2f6241 100644
--- a/app/src/protyle/render/av/groups.ts
+++ b/app/src/protyle/render/av/groups.ts
@@ -1,3 +1,4 @@
+import {hasAVCapability, isAVDateType, isAVSelectType} from "./capabilities";
import {unicode2Emoji} from "../../../emoji";
import {getColIconByType} from "./col";
import {escapeHtml} from "../../../util/escape";
@@ -41,7 +42,7 @@ export const setGroupMethod = async (options: {
const groupByRendered = column?.type === "mAsset" && Boolean(column.renderTemplate?.trim());
const data: Record<string, unknown> = column ? {
field: options.fieldId,
- method: column.type === "number" ? 1 : (["date", "updated", "created"].includes(column.type) ? 2 : 0),
+ method: column.type === "number" ? 1 : (isAVDateType(column.type) ? 2 : 0),
order: 0,
range: column.type === "number" ? {
numStart: 0,
@@ -79,7 +80,7 @@ export const getGroupsMethodHTML = (columns: IAVColumn[], group: IAVGroup, viewT
${(!group || !group.field) ? selectHTML : ""}
</button>`;
columns.forEach(item => {
- if (["rollup", "lineNumber"].includes(item.type) || (item.type === "mAsset" && !item.renderTemplate?.trim())) {
+ if (!hasAVCapability(item.type, "groupable") || (item.type === "mAsset" && !item.renderTemplate?.trim())) {
return;
}
html += `<button class="b3-menu__item" data-id="${item.id}" data-type="setGroupMethod">
@@ -201,7 +202,7 @@ export const getGroupsHTML = (columns: IAVColumn[], view: IAVView) => {
column = columns.find(item => item.id === view.group.field);
const groupByRendered = view.group.valueSource === "rendered";
if (view.groups?.length > 0) {
- const disabledDrag = !groupByRendered && ["date", "created", "updated"].includes(column.type);
+ const disabledDrag = !groupByRendered && isAVDateType(column.type);
let showCount = 0;
view.groups.forEach(item => {
if (item.groupHidden === 0) {
@@ -243,7 +244,7 @@ export const getGroupsHTML = (columns: IAVColumn[], view: IAVView) => {
<option value="rendered" ${groupByRendered ? "selected" : ""}>${window.siyuan.languages.templateRenderedValue}</option>
</select>
</label>` : "";
- html = `${valueSourceHTML}<button class="b3-menu__item${!groupByRendered && ["date", "updated", "created"].includes(column.type) ? "" : " fn__none"}" data-type="goGroupsDate">
+ html = `${valueSourceHTML}<button class="b3-menu__item${!groupByRendered && isAVDateType(column.type) ? "" : " fn__none"}" data-type="goGroupsDate">
<span class="b3-menu__label">${window.siyuan.languages.date}</span>
<span class="b3-menu__accelerator">${getLanguageByIndex(view.group.method, "date")}</span>
<svg class="b3-menu__icon b3-menu__icon--small"><use xlink:href="#iconRight"></use></svg>
@@ -253,7 +254,7 @@ export const getGroupsHTML = (columns: IAVColumn[], view: IAVView) => {
<span class="b3-menu__accelerator">${(view.group.range && typeof view.group.range.numStart === "number") ? `${view.group.range.numStart} - ${view.group.range.numEnd}` : ""}</span>
<svg class="b3-menu__icon b3-menu__icon--small"><use xlink:href="#iconRight"></use></svg>
</button>
-<button class="b3-menu__item${!groupByRendered && ["checkbox", "rollup", "mAsset"].includes(column.type) ? " fn__none" : ""}" data-type="goGroupsSort">
+<button class="b3-menu__item${!groupByRendered && (column.type === "checkbox" || column.type === "rollup" || column.type === "mAsset") ? " fn__none" : ""}" data-type="goGroupsSort">
<span class="b3-menu__label">${window.siyuan.languages.sort}</span>
<span class="b3-menu__accelerator">${getLanguageByIndex(view.group.order, "sort")}</span>
<svg class="b3-menu__icon b3-menu__icon--small"><use xlink:href="#iconRight"></use></svg>
@@ -333,15 +334,15 @@ export const bindGroupsEvent = (options: {
const column = getFieldsByData(options.data).find(item => item.id === options.data.view.group.field);
const columnType = column?.type || "text";
options.data.view.group.method = columnType === "number" ? 1 :
- (["date", "updated", "created"].includes(columnType) ? 2 : 0);
+ (isAVDateType(columnType) ? 2 : 0);
if (columnType === "number") {
options.data.view.group.range = {numStart: 0, numEnd: 1000, numStep: 100};
}
- if (["select", "mSelect"].includes(columnType)) {
+ if (isAVSelectType(columnType)) {
options.data.view.group.order = 3;
} else if (columnType === "checkbox") {
options.data.view.group.order = 2;
- } else if (["date", "updated", "created"].includes(columnType) &&
+ } else if (isAVDateType(columnType) &&
![0, 1].includes(options.data.view.group.order)) {
options.data.view.group.order = 0;
}
@@ -414,8 +415,8 @@ export const goGroupsSort = (options: {
}
const blockID = options.blockElement.getAttribute("data-node-id");
const column = getFieldsByData(options.data).find(item => item.id === options.data.view.group.field);
- (options.data.view.group.valueSource === "rendered" ? [2, 0, 1] : (["created", "date", "created", "updated"].includes(column.type) ? [0, 1] : (
- ["mSelect", "select"].includes(column.type) ? [3, 2, 0, 1] : [2, 0, 1]
+ (options.data.view.group.valueSource === "rendered" ? [2, 0, 1] : (isAVDateType(column.type) ? [0, 1] : (
+ isAVSelectType(column.type) ? [3, 2, 0, 1] : [2, 0, 1]
))).forEach((item) => {
const label = getLanguageByIndex(item, "sort");
menu.addItem({
diff --git a/app/src/protyle/render/av/kanban/render.ts b/app/src/protyle/render/av/kanban/render.ts
index 7a8beff143..cf04d17a63 100644
--- a/app/src/protyle/render/av/kanban/render.ts
+++ b/app/src/protyle/render/av/kanban/render.ts
@@ -1,3 +1,4 @@
+import {isAVDateType, isAVSelectType} from "../capabilities";
import {isTableLikeView} from "../viewType";
import {isAVRenderData} from "../renderData";
import {getPublishAVView} from "../publishState";
@@ -32,7 +33,7 @@ interface IIds {
const getKanbanTitleHTML = (group: IAVView, counter: number, draggable: boolean) => {
let nameHTML = "";
let optionMenuHTML = "";
- if (["mSelect", "select"].includes(group.groupValue.type)) {
+ if (isAVSelectType(group.groupValue.type)) {
group.groupValue.mSelect.forEach((item) => {
nameHTML += `<span class="b3-chip" style="${getAVColorStyle(item)}">${escapeHtml(item.content)}</span>`;
});
@@ -216,7 +217,7 @@ export const renderKanban = async (options: {
const groupOptions = groupKey?.options || [];
const queryEmbedElement = hasClosestByAttribute(options.blockElement, "data-type", "NodeBlockQueryEmbed");
const groupDraggable = !options.protyle.disabled && !created && !snapshot && !queryEmbedElement &&
- (view.group?.valueSource === "rendered" || !["created", "date", "updated"].includes(groupKey?.type));
+ (view.group?.valueSource === "rendered" || !isAVDateType(groupKey?.type));
const groupConfig = escapeAttr(JSON.stringify(view.group));
let bodyHTML = "";
let isSelectGroup = false;
@@ -224,7 +225,7 @@ export const renderKanban = async (options: {
if (group.groupHidden === 0) {
let selectBg = "";
if (group.fillColBackgroundColor) {
- if (["mSelect", "select"].includes(group.groupValue.type)) {
+ if (isAVSelectType(group.groupValue.type)) {
isSelectGroup = true;
}
if (isSelectGroup) {
diff --git a/app/src/protyle/render/av/layout.ts b/app/src/protyle/render/av/layout.ts
index fd33ca9dc7..a91a88f77d 100644
--- a/app/src/protyle/render/av/layout.ts
+++ b/app/src/protyle/render/av/layout.ts
@@ -1,3 +1,4 @@
+import {isAVSelectType} from "./capabilities";
import {bindCalendarSettings, getCalendarSettingsHTML} from "./calendar/settings";
import {isTableLikeView} from "./viewType";
import {isAVRenderData} from "./renderData";
@@ -163,7 +164,7 @@ export const getLayoutHTML = (data: IAV) => {
<span class="fn__space fn__flex-1"></span>
<input data-type="toggle-entries-wrap" type="checkbox" class="b3-switch b3-switch--menu" ${view.wrapField ? "checked" : ""}>
</label>`;
- if (data.viewType === "kanban" && ["select", "mSelect"].includes(data.view.groups?.[0]?.groupValue?.type)) {
+ if (data.viewType === "kanban" && isAVSelectType(data.view.groups?.[0]?.groupValue?.type)) {
html += `<label class="b3-menu__item">
<span class="fn__flex-center">${window.siyuan.languages.useBackground}</span>
<span class="fn__space fn__flex-1"></span>
diff --git a/app/src/protyle/render/av/listView.test.ts b/app/src/protyle/render/av/listView.test.ts
index b9669cea9b..8115559301 100644
--- a/app/src/protyle/render/av/listView.test.ts
+++ b/app/src/protyle/render/av/listView.test.ts
@@ -1,3 +1,4 @@
+import * as capabilities from "./capabilities";
import {describe, it} from "node:test";
import * as assert from "node:assert/strict";
import {readFileSync} from "node:fs";
@@ -23,7 +24,7 @@ const loadModule = (name: string) => {
runInNewContext(ts.transpileModule(readFileSync(join(__dirname, `${name}.ts`), "utf8"), {
compilerOptions: {module: ts.ModuleKind.CommonJS, target: ts.ScriptTarget.ES2022},
}).outputText, {
- module, exports: module.exports, require: (id: string) => mocks[id] || {},
+ module, exports: module.exports, require: (id: string) => id === "./capabilities" || id === "../capabilities" ? capabilities : (mocks[id] || {}),
window: {siyuan: {languages: {freezeDrag: "Freeze"}}},
});
return module.exports;
diff --git a/app/src/protyle/render/av/newItemTemplate.ts b/app/src/protyle/render/av/newItemTemplate.ts
index ad5a95d959..b830c71215 100644
--- a/app/src/protyle/render/av/newItemTemplate.ts
+++ b/app/src/protyle/render/av/newItemTemplate.ts
@@ -1,3 +1,4 @@
+import {isAVNewItemTemplateType, isAVSelectType} from "./capabilities";
import {genFieldValue, getValueInputHTML, openFieldSelectMenu, getRelationOptions, renderRelationFieldValue, openFieldRelationMenu} from "./fieldValueEditor";
import {getCalendarCreationDate} from "./calendar/state";
import {Constants} from "../../../constants";
@@ -45,7 +46,7 @@ const getFieldsHTML = (fields: IAVColumn[], itemTemplate: IAVNewItemTemplate) =>
const fieldValue = itemTemplate.fieldValues?.[column.id];
const icon = column.icon ? unicode2Emoji(column.icon, "block__logoicon", true) : `<svg class="block__logoicon"><use xlink:href="#${getColIconByType(column.type)}"></use></svg>`;
const selected = fieldValue?.value?.mSelect?.map(item => item.content) || [];
- const selectAttrs = ["select", "mSelect"].includes(column.type) ?
+ const selectAttrs = isAVSelectType(column.type) ?
` data-role="field-value" data-value-type="${column.type}" data-selected="${escapeAttr(JSON.stringify(selected))}"` : "";
return `<div class="block__icons av__row" data-field-id="${column.id}">
<div class="block__logo block__logo--icon" title="${escapeAttr(column.name)}">${icon}<span>${escapeHtml(column.name)}</span></div>
@@ -302,7 +303,7 @@ export const openNewItemTemplateDialog = (options: {
}) => {
const allFields = getFieldsByData(options.data);
const primaryKey = allFields.find(item => item.type === "block");
- const fields = allFields.filter(item => ["text", "number", "date", "select", "mSelect", "url", "email", "phone", "mAsset", "checkbox", "relation"].includes(item.type));
+ const fields = allFields.filter(item => isAVNewItemTemplateType(item.type));
const templates = cloneTemplates(options.data.newItemTemplates);
const fieldsByID = new Map(fields.map(item => [item.id, item]));
templates.forEach(itemTemplate => {
diff --git a/app/src/protyle/render/av/openMenuPanel.ts b/app/src/protyle/render/av/openMenuPanel.ts
index f780a97f82..8498d47012 100644
--- a/app/src/protyle/render/av/openMenuPanel.ts
+++ b/app/src/protyle/render/av/openMenuPanel.ts
@@ -1,4 +1,5 @@
import {openConditionalColorsMenu} from "./conditionalColorMenu";
+import {hasAVCapability} from "./capabilities";
import {openAutomationMenu} from "./automation";
import {isTableLikeView} from "./viewType";
import {transaction} from "../../wysiwyg/transaction";
@@ -1117,7 +1118,7 @@ export const openMenuPanel = (options: {
const oldFilters = JSON.parse(JSON.stringify(data.view.filters));
addFilterGroup(data, path);
const fields = getFieldsByData(data);
- const blockField = fields.find(f => f.type === "block") || fields.find(f => f.type !== "lineNumber");
+ const blockField = fields.find(f => f.type === "block") || fields.find(f => hasAVCapability(f.type, "filterable"));
if (blockField) {
let target: IAVFilter[];
if ("" === path) {
diff --git a/app/src/protyle/render/av/paste.ts b/app/src/protyle/render/av/paste.ts
index ba2d3b8c12..fb402cdda3 100644
--- a/app/src/protyle/render/av/paste.ts
+++ b/app/src/protyle/render/av/paste.ts
@@ -1,11 +1,3 @@
-export const AV_PASTE_READONLY_TYPES = new Set<TAVCol>([
- "created",
- "updated",
- "template",
- "rollup",
- "lineNumber",
-]);
-
const isStrictNumber = (value: string) => {
const trimmed = value.trim();
if (!/^[+-]?(?:\d+\.?\d*|\.\d+)(?:[eE][+-]?\d+)?$/.test(trimmed)) {
diff --git a/app/src/protyle/render/av/render.ts b/app/src/protyle/render/av/render.ts
index fad4090355..08335132cd 100644
--- a/app/src/protyle/render/av/render.ts
+++ b/app/src/protyle/render/av/render.ts
@@ -1,3 +1,4 @@
+import {isAVSelectType} from "./capabilities";
import {renderCalendar} from "./calendar/render";
import {isFoldedRenderContent} from "../foldedContent";
import {getCalendarRequestRange} from "./calendar/state";
@@ -303,7 +304,7 @@ style="width: ${escapeAttr(column.width) || "200px"}">${getCalcValue(column) ||
export const getGroupTitleHTML = (group: IAVView, counter: number) => {
let nameHTML = "";
- if (["mSelect", "select"].includes(group.groupValue.type)) {
+ if (isAVSelectType(group.groupValue.type)) {
group.groupValue.mSelect.forEach((item) => {
nameHTML += `<span class="b3-chip" style="${getAVColorStyle(item)}">${escapeHtml(item.content)}</span>`;
});
diff --git a/app/src/protyle/render/av/renderHeader.test.ts b/app/src/protyle/render/av/renderHeader.test.ts
index 2836abd5d9..651269f262 100644
--- a/app/src/protyle/render/av/renderHeader.test.ts
+++ b/app/src/protyle/render/av/renderHeader.test.ts
@@ -1,3 +1,4 @@
+import * as capabilities from "./capabilities";
import {before, describe, it} from "node:test";
import * as assert from "node:assert/strict";
import {readFileSync} from "node:fs";
@@ -57,7 +58,7 @@ describe("database default item templates", () => {
"./contextFilterState": {getContextFilterKeyID: () => ""},
};
runInNewContext(compiled, {
- module, exports: module.exports, require: (id: string) => mocks[id] || {},
+ module, exports: module.exports, require: (id: string) => id === "./capabilities" || id === "../capabilities" ? capabilities : (mocks[id] || {}),
window: {siyuan: {languages: {_kernel: {}}, config: {editor: {spellcheck: false}}}},
});
const data = {
diff --git a/app/src/protyle/render/av/row.ts b/app/src/protyle/render/av/row.ts
index 01d4130241..042badb732 100644
--- a/app/src/protyle/render/av/row.ts
+++ b/app/src/protyle/render/av/row.ts
@@ -1,3 +1,4 @@
+import {isAVTimestampType} from "./capabilities";
import {getConditionalItemStyle, getConditionalCellStyle} from "./conditionalColor";
import {isTableLikeView} from "./viewType";
import {updateFrozenColumns} from "./frozenColumns";
@@ -433,7 +434,7 @@ export const insertAttrViewBlockAnimation = (options: {
previousElement = getPreviousTableRow(options.blockElement.querySelector(groupQuery + ".av__row--util"));
}
const bodyElement = options.blockElement.querySelector(`.av__body[data-group-id="${options.groupID}"] `);
- if (bodyElement && ["updated", "created"].includes(bodyElement.getAttribute("data-dtype")) &&
+ if (bodyElement && isAVTimestampType(bodyElement.getAttribute("data-dtype")) &&
bodyElement.getAttribute("data-content") !== "_@today@_") {
previousElement = getPreviousTableRow(
options.blockElement.querySelector('.av__body[data-content="_@today@_"] .av__row--util'));
diff --git a/app/src/protyle/render/av/rowReadonly.test.ts b/app/src/protyle/render/av/rowReadonly.test.ts
index bfb5aef916..482d9936d9 100644
--- a/app/src/protyle/render/av/rowReadonly.test.ts
+++ b/app/src/protyle/render/av/rowReadonly.test.ts
@@ -1,3 +1,4 @@
+import * as capabilities from "./capabilities";
import * as assert from "node:assert/strict";
import {readFileSync} from "node:fs";
import {test} from "node:test";
@@ -65,6 +66,8 @@ const createPanel = (mobile: boolean) => {
constructor(public type: string, options: {detail: unknown}) { this.detail = options.detail; }
},
require: (name: string) => {
+ if (name === "./capabilities" || name === "../capabilities") { return capabilities; }
+
if (name.endsWith("/blockAttr")) {
return {renderAVAttribute: (_element: unknown, _id: string, protyle: IProtyle) => rendered.push(protyle.disabled)};
}
diff --git a/app/src/protyle/render/av/selectionState.ts b/app/src/protyle/render/av/selectionState.ts
index fe62f3cf55..ae7af9528d 100644
--- a/app/src/protyle/render/av/selectionState.ts
+++ b/app/src/protyle/render/av/selectionState.ts
@@ -1,3 +1,4 @@
+import {isAVReadonlyType} from "./capabilities";
export interface IAVCellPoint {
groupID: string;
rowID: string;
@@ -211,7 +212,7 @@ export const restoreAVCellSelection = (blockElement: HTMLElement) => {
}
if (groupID === selection.focus.groupID && rowElement.dataset.id === selection.focus.rowID &&
cellElement.dataset.colId === selection.focus.colID &&
- !["template", "rollup", "lineNumber", "created", "updated"].includes(cellElement.dataset.dtype)) {
+ !isAVReadonlyType(cellElement.dataset.dtype)) {
cellElement.insertAdjacentHTML("beforeend",
`<div aria-label="${window.siyuan.languages.dragFill}" class="av__drag-fill ariaLabel"></div>`);
}
diff --git a/app/src/protyle/render/av/sort.ts b/app/src/protyle/render/av/sort.ts
index d7aebfe35e..1f181accf4 100644
--- a/app/src/protyle/render/av/sort.ts
+++ b/app/src/protyle/render/av/sort.ts
@@ -1,4 +1,5 @@
import {Menu} from "../../../plugin/Menu";
+import {hasAVCapability} from "./capabilities";
import {getColIconByType} from "./col";
import {transaction} from "../../wysiwyg/transaction";
import {setPosition} from "../../../util/setPosition";
@@ -21,8 +22,8 @@ export const addSort = (options: {
fields.forEach((column) => {
let hasSort = false;
- // 如果该列是行号类型列,不允许添加排序
- if (column.type === "lineNumber") {
+ // 根据字段能力排除不支持排序的列。
+ if (!hasAVCapability(column.type, "sortable")) {
hasSort = true;
} else {
options.data.view.sorts.find((sort) => {
diff --git a/app/src/protyle/util/insertHTML.ts b/app/src/protyle/util/insertHTML.ts
index 74dd093da7..9926c81da4 100644
--- a/app/src/protyle/util/insertHTML.ts
+++ b/app/src/protyle/util/insertHTML.ts
@@ -40,7 +40,6 @@ import {getFieldIdByCellElement, getRowHTML} from "../render/av/row";
import {setFold} from "./blockFold";
import {removeFoldHeading} from "./heading";
import {
- AV_PASTE_READONLY_TYPES,
compactAVCellOperations,
getAVPasteCellValue,
getAVPasteContentRowCount,
@@ -53,6 +52,7 @@ import {
shouldShowAVPasteSkeleton,
showAVPasteSkeleton,
} from "../render/av/paste";
+import {isAVReadonlyType} from "../render/av/capabilities";
import {getAVColumnFitWidth, getAVColumnTextMeasurer} from "../render/av/columnWidth";
import {cloneAVCellValueSnapshot} from "../render/av/cellValue";
import {Dialog} from "../../dialog";
@@ -380,7 +380,7 @@ const pasteAVMatrix = async (options: {
const inferredType = options.header ? inferAVPasteColumnType(sourceCellValues) : "text";
const currentColumn = availableColumns[sourceIndex];
if (currentColumn) {
- const readonly = AV_PASTE_READONLY_TYPES.has(currentColumn.type);
+ const readonly = isAVReadonlyType(currentColumn.type);
const oldColumn = {...currentColumn};
const nextName = options.header && headerName && !readonly ? headerName : currentColumn.name;
const nextType = options.header && inferableKeyIDs.has(currentColumn.id) &&
diff --git a/app/src/types/av/index.d.ts b/app/src/types/av/index.d.ts
new file mode 100644
index 0000000000..5d6753d70a
--- /dev/null
+++ b/app/src/types/av/index.d.ts
@@ -0,0 +1,16 @@
+// 此文件由内核字段能力声明生成,请运行 pnpm run api:generate 更新。
+
+export type AVKeyType = "block" | "text" | "number" | "date" | "select" | "mSelect" | "url" | "email" | "phone" | "mAsset" | "template" | "created" | "updated" | "checkbox" | "relation" | "rollup" | "lineNumber";
+export type AVFilterOperator = "=" | "!=" | ">" | ">=" | "<" | "<=" | "Contains" | "Does not contains" | "Contains any item" | "Does not contain any item" | "Is empty" | "Is not empty" | "Starts with" | "Ends with" | "Is between" | "Is true" | "Is false";
+
+/** 字段基础能力仅用于类型分派,不属于 AV 持久化格式 */
+export interface AVKeyCapability {
+ readonly valueKind: "assets" | "checkbox" | "date" | "lineNumber" | "number" | "options" | "relation" | "rollup" | "text" | "timestamp";
+ readonly editable: boolean;
+ readonly filterable: boolean;
+ readonly sortable: boolean;
+ /** 资源字段分组还需要显示模板 */
+ readonly groupable: boolean;
+ /** 行号为空,关联的汇总取值使用 Contains */
+ readonly defaultOperator: AVFilterOperator | "";
+}
diff --git a/app/src/types/index.d.ts b/app/src/types/index.d.ts
index 86089d1256..7ea635d826 100644
--- a/app/src/types/index.d.ts
+++ b/app/src/types/index.d.ts
@@ -28,42 +28,8 @@ type TEventBus = "ws-main" | "sync-start" | "sync-end" | "sync-fail" |
type TAVView = "table" | "list" | "gallery" | "kanban" | "calendar";
type TAVAlign = "" | "left" | "center" | "right"
type TAVDateFormat = "" | "full" | "month-day-year" | "day-month-year" | "year-month-day"
-type TAVCol =
- "text"
- | "date"
- | "number"
- | "relation"
- | "rollup"
- | "select"
- | "block"
- | "mSelect"
- | "url"
- | "email"
- | "phone"
- | "mAsset"
- | "template"
- | "created"
- | "updated"
- | "checkbox"
- | "lineNumber"
-type TAVFilterOperator =
- "="
- | "!="
- | ">"
- | ">="
- | "<"
- | "<="
- | "Contains"
- | "Does not contains"
- | "Contains any item"
- | "Does not contain any item"
- | "Is empty"
- | "Is not empty"
- | "Starts with"
- | "Ends with"
- | "Is between"
- | "Is true"
- | "Is false"
+type TAVCol = import("./av").AVKeyType;
+type TAVFilterOperator = import("./av").AVFilterOperator;
type TRecentDocsSort = "viewedAt" | "closedAt" | "openAt" | "created" | "updated"
type TPublishAccessLevel = "public" | "protected" | "hidden" | "private" | "forbidden";
diff --git a/app/tests/avAttributeCarrier.test.js b/app/tests/avAttributeCarrier.test.js
index feea07de4f..a618d9d171 100644
--- a/app/tests/avAttributeCarrier.test.js
+++ b/app/tests/avAttributeCarrier.test.js
@@ -213,7 +213,7 @@ const runElectron = async () => {
const extract = (name, names) => {
const text = readFileSync(path.join(root, name + ".ts"), "utf8");
if (!names) {
- return text;
+ return text.replace(/^import [\s\S]*?;\r?\n/gm, "");
}
const source = ts.createSourceFile(name, text, ts.ScriptTarget.Latest, true);
const statements = source.statements.filter(statement => ts.isVariableStatement(statement) &&
@@ -222,7 +222,7 @@ const runElectron = async () => {
return statements.map(statement => "export " + statement.getText(source).replace(/^export /, "")).join("\n");
};
// 执行实际渲染、菜单请求和事务组装函数,仅隔离网络、富文本显示与编辑器外壳。
- const sources = [extract("cellValue"), extract("dragFillValue", ["rebindAVCellValue"]),
+ const sources = [extract("capabilities.generated"), extract("capabilities"), extract("cellValue"), extract("dragFillValue", ["rebindAVCellValue"]),
extract("blockAttr", ["renderAVAttribute", "renderAttributeViewBacklinks"]),
extract("openMenuPanel", ["openMenuPanel"]), extract("cell", ["updateCellsValue"]),
extract("primaryFocus", ["focusDatabasePrimary"]),
@@ -238,7 +238,9 @@ const runElectron = async () => {
Object.assign(window, exports);
}
})()`);
- await win.webContents.executeJavaScript(`(${runCases.toString()})()`);
+ const failure = await win.webContents.executeJavaScript(`Promise.resolve().then(() =>
+ (${runCases.toString()})()).then(() => null, error => error.stack || String(error))`);
+ assert.equal(failure, null);
console.log("Attribute carrier cases passed");
} catch (error) {
console.error(error);
diff --git a/app/tests/avAttributeNavigation.test.js b/app/tests/avAttributeNavigation.test.js
index dfd9d36098..d1d3a6d9e1 100644
--- a/app/tests/avAttributeNavigation.test.js
+++ b/app/tests/avAttributeNavigation.test.js
@@ -146,7 +146,7 @@ const runElectron = async () => {
let exitCode = 0;
try {
const ts = require("typescript");
- const sources = Object.fromEntries(["blockAttr", "attributeValue", "cellValue", "blockIcon", "../../util/hasClosest"].map(name => [
+ const sources = Object.fromEntries(["blockAttr", "attributeValue", "cellValue", "blockIcon", "capabilities", "capabilities.generated", "../../util/hasClosest"].map(name => [
name === "../../util/hasClosest" ? name : "./" + name,
ts.transpileModule(readFileSync(path.join(__dirname, `../src/protyle/render/av/${name}.ts`), "utf8"),
{compilerOptions: {module: ts.ModuleKind.CommonJS, target: ts.ScriptTarget.ES2020}}).outputText,
diff --git a/app/tests/avRelationTemplate.test.js b/app/tests/avRelationTemplate.test.js
index 8489f49c45..a24c599d4b 100644
--- a/app/tests/avRelationTemplate.test.js
+++ b/app/tests/avRelationTemplate.test.js
@@ -185,7 +185,7 @@ const runElectron = async () => {
let exitCode = 0;
try {
const ts = require("typescript");
- const sources = Object.fromEntries(["cell", "cellValue", "attributeValue", "blockIcon", "relationLayout"].map(name => ["./" + name,
+ const sources = Object.fromEntries(["cell", "cellValue", "attributeValue", "blockIcon", "relationLayout", "capabilities", "capabilities.generated"].map(name => ["./" + name,
ts.transpileModule(readFileSync(path.join(__dirname, `../src/protyle/render/av/${name}.ts`), "utf8"),
{compilerOptions: {module: ts.ModuleKind.CommonJS, target: ts.ScriptTarget.ES2020}}).outputText]));
const relationSource = readFileSync(path.join(__dirname, "../src/protyle/render/av/relation.ts"), "utf8");
diff --git a/app/tests/avRichTextEditor.test.js b/app/tests/avRichTextEditor.test.js
index 1a804a29b9..8ea75d34b3 100644
--- a/app/tests/avRichTextEditor.test.js
+++ b/app/tests/avRichTextEditor.test.js
@@ -29,6 +29,7 @@ const runCases = async (sources) => {
},
Lute: {UnEscapeHTMLStr: value => value, Caret: "caret"},
replaceFileName: value => value,
+ getDailyNoteHints: async () => [],
Constants: {ZWSP: "\u200b"},
};
const hintRef = new Function(...Object.keys(hintDependencies), "exports", sources.hintRef + "\nreturn exports.hintRef;")(
@@ -248,7 +249,7 @@ const runElectron = async () => {
let exitCode = 0;
try {
const ts = require("typescript");
- const sources = Object.fromEntries(["richTextEditor", "editorSession", "selectionState"].map(name => ["./" + name,
+ const sources = Object.fromEntries(["richTextEditor", "editorSession", "selectionState", "capabilities", "capabilities.generated"].map(name => ["./" + name,
ts.transpileModule(readFileSync(path.join(__dirname, `../src/protyle/render/av/${name}.ts`), "utf8"),
{compilerOptions: {module: ts.ModuleKind.CommonJS, target: ts.ScriptTarget.ES2020}}).outputText]));
const hintSource = ts.createSourceFile("extend.ts", readFileSync(path.join(__dirname,
diff --git a/app/tests/verticalNavigation.test.js b/app/tests/verticalNavigation.test.js
index 616cc336cb..bb25e15764 100644
--- a/app/tests/verticalNavigation.test.js
+++ b/app/tests/verticalNavigation.test.js
@@ -99,7 +99,7 @@ const rendererModules = () => {
const restoreListMindmapFocus = () => false;
const focusByOffset = element => { window.restoredFocusElement = element; return true; };\n` +
extract("util/selection", ["restoreFocusContext"]);
- for (const name of ["virtualScroll", "selectionState", "rangeSelect", "groupTableVirtual", "backlinkScroll", "viewType"]) {
+ for (const name of ["virtualScroll", "selectionState", "rangeSelect", "groupTableVirtual", "backlinkScroll", "viewType", "capabilities", "capabilities.generated"]) {
modules[`render/av/${name}`] = readFileSync(path.join(root, "render/av", `${name}.ts`), "utf8");
}
modules["../constants"] = "const SIYUAN_VERSION = 'test', NODE_ENV = 'test';\n" +
diff --git a/docs/API-CONTRACTS.md b/docs/API-CONTRACTS.md
index 72877af450..d42f459b97 100644
--- a/docs/API-CONTRACTS.md
+++ b/docs/API-CONTRACTS.md
@@ -205,6 +205,8 @@ pnpm test
The generation command updates both this repository and `petal`; a separate generation run without `--petal` is unnecessary. The `--petal` path is relative to the generator's working directory, `kernel/`; the example refers to a sibling repository. CI checks only this repository's artifacts. Local synchronization across repositories uses this option to verify plugin declarations.
+The same generator also reads the field capability declarations in `kernel/av/capabilities.go` and writes `app/src/protyle/render/av/capabilities.generated.ts`, `app/src/types/av/index.d.ts`, and the corresponding `petal/types/av/index.d.ts`. Maintain field capabilities and the filter operator registry in the kernel, then regenerate these artifacts; do not hand-edit the generated field type or operator unions. Tests enumerate the typed Go constants to reject missing declarations and verify generated artifacts through the existing commands and full kernel suite.
+
Run from `kernel/`:
```text
diff --git a/docs/API-CONTRACTS.zh-CN.md b/docs/API-CONTRACTS.zh-CN.md
index 1e6fffefc5..8844f71c38 100644
--- a/docs/API-CONTRACTS.zh-CN.md
+++ b/docs/API-CONTRACTS.zh-CN.md
@@ -189,6 +189,8 @@ pnpm test
上述生成命令同时更新本仓库与 `petal`,无须再单独执行不带 `--petal` 的生成命令。`--petal` 路径相对于生成器的工作目录 `kernel/`,示例对应同级仓库。CI 只检查本仓库产物,而本地跨仓库同步须使用该参数核对插件声明。
+同一生成器还读取 `kernel/av/capabilities.go` 中的字段能力声明,输出 `app/src/protyle/render/av/capabilities.generated.ts`、`app/src/types/av/index.d.ts` 和对应的 `petal/types/av/index.d.ts`。字段能力和筛选算子清单在内核维护,修改后重新生成产物,不手工编辑生成的字段类型或算子联合类型。测试枚举 Go 类型常量,拒绝遗漏声明,并通过现有生成检查命令和内核全量测试核对生成产物。
+
在 `kernel/` 下运行:
```text
diff --git a/kernel/apicontract/cmd/apigen/main.go b/kernel/apicontract/cmd/apigen/main.go
index fff9bf1277..9c11333c26 100644
--- a/kernel/apicontract/cmd/apigen/main.go
+++ b/kernel/apicontract/cmd/apigen/main.go
@@ -11,6 +11,7 @@ import (
"sort"
"github.com/siyuan-note/siyuan/kernel/apicontract"
+ "github.com/siyuan-note/siyuan/kernel/av"
)
func main() {
@@ -82,8 +83,12 @@ func run(root, petal, base string, check bool) error {
filepath.Join(root, "app", "src", "types", "api", "index.d.ts"): bundle.TypeScript(legacy),
filepath.Join(root, "kernel", "apicontract", "schema.json"): append(jsonData, '\n'),
}
+ capabilityRuntime, capabilityTypes := av.CapabilityTypeScript()
+ artifacts[filepath.Join(root, "app", "src", "protyle", "render", "av", "capabilities.generated.ts")] = capabilityRuntime
+ artifacts[filepath.Join(root, "app", "src", "types", "av", "index.d.ts")] = capabilityTypes
if petal != "" {
artifacts[filepath.Join(petal, "types", "api", "index.d.ts")] = bundle.TypeScript(legacy)
+ artifacts[filepath.Join(petal, "types", "av", "index.d.ts")] = capabilityTypes
}
var paths []string
for path := range artifacts {
diff --git a/kernel/av/automation.go b/kernel/av/automation.go
index 3458ac8e5a..7011fe3599 100644
--- a/kernel/av/automation.go
+++ b/kernel/av/automation.go
@@ -63,12 +63,7 @@ func (view *AttributeView) visitAutomationValues(visit func(*Value)) {
// AutomationEditableKey 排除依赖渲染计算的字段,触发器只观察实际存储的值。
func AutomationEditableKey(typ KeyType) bool {
- switch typ {
- case KeyTypeBlock, KeyTypeText, KeyTypeNumber, KeyTypeDate, KeyTypeSelect, KeyTypeMSelect,
- KeyTypeURL, KeyTypeEmail, KeyTypePhone, KeyTypeCheckbox, KeyTypeRelation, KeyTypeMAsset:
- return true
- }
- return false
+ return GetKeyCapability(typ).Editable
}
// MatchesAutomationFilters 按存储的关联 ID 判断空值,仅关键词条件需要读取关联条目的文本。
diff --git a/kernel/av/capabilities.go b/kernel/av/capabilities.go
new file mode 100644
index 0000000000..ae3e0dfcb9
--- /dev/null
+++ b/kernel/av/capabilities.go
@@ -0,0 +1,88 @@
+package av
+
+import "sort"
+
+// KeyCapability 描述字段的基础能力,不参与属性视图的持久化。
+// 资源字段仅在设置显示模板后支持分组,关联汇总的默认算子按取值来源调整。
+type KeyCapability struct {
+ ValueKind string `json:"valueKind"`
+ Editable bool `json:"editable"`
+ Filterable bool `json:"filterable"`
+ Sortable bool `json:"sortable"`
+ Groupable bool `json:"groupable"`
+ DefaultOperator FilterOperator `json:"defaultOperator"`
+ order int
+}
+
+var keyCapabilities = map[KeyType]KeyCapability{
+ KeyTypeBlock: {order: 0, ValueKind: "text", Editable: true, Filterable: true,
+ Sortable: true, Groupable: true, DefaultOperator: FilterOperatorContains},
+ KeyTypeText: {order: 1, ValueKind: "text", Editable: true, Filterable: true,
+ Sortable: true, Groupable: true, DefaultOperator: FilterOperatorContains},
+ KeyTypeNumber: {order: 2, ValueKind: "number", Editable: true, Filterable: true,
+ Sortable: true, Groupable: true, DefaultOperator: FilterOperatorIsEqual},
+ KeyTypeDate: {order: 3, ValueKind: "date", Editable: true, Filterable: true,
+ Sortable: true, Groupable: true, DefaultOperator: FilterOperatorIsEqual},
+ KeyTypeSelect: {order: 4, ValueKind: "options", Editable: true, Filterable: true,
+ Sortable: true, Groupable: true, DefaultOperator: FilterOperatorIsEqual},
+ KeyTypeMSelect: {order: 5, ValueKind: "options", Editable: true, Filterable: true,
+ Sortable: true, Groupable: true, DefaultOperator: FilterOperatorContains},
+ KeyTypeURL: {order: 6, ValueKind: "text", Editable: true, Filterable: true,
+ Sortable: true, Groupable: true, DefaultOperator: FilterOperatorContains},
+ KeyTypeEmail: {order: 7, ValueKind: "text", Editable: true, Filterable: true,
+ Sortable: true, Groupable: true, DefaultOperator: FilterOperatorContains},
+ KeyTypePhone: {order: 8, ValueKind: "text", Editable: true, Filterable: true,
+ Sortable: true, Groupable: true, DefaultOperator: FilterOperatorContains},
+ KeyTypeMAsset: {order: 9, ValueKind: "assets", Editable: true, Filterable: true,
+ Sortable: true, Groupable: true, DefaultOperator: FilterOperatorContains},
+ KeyTypeTemplate: {order: 10, ValueKind: "text", Editable: false, Filterable: true,
+ Sortable: true, Groupable: true, DefaultOperator: FilterOperatorContains},
+ KeyTypeCreated: {order: 11, ValueKind: "timestamp", Editable: false, Filterable: true,
+ Sortable: true, Groupable: true, DefaultOperator: FilterOperatorIsEqual},
+ KeyTypeUpdated: {order: 12, ValueKind: "timestamp", Editable: false, Filterable: true,
+ Sortable: true, Groupable: true, DefaultOperator: FilterOperatorIsEqual},
+ KeyTypeCheckbox: {order: 13, ValueKind: "checkbox", Editable: true, Filterable: true,
+ Sortable: true, Groupable: true, DefaultOperator: FilterOperatorIsEqual},
+ KeyTypeRelation: {order: 14, ValueKind: "relation", Editable: true, Filterable: true,
+ Sortable: true, Groupable: true, DefaultOperator: FilterOperatorContainsAnyItem},
+ KeyTypeRollup: {order: 15, ValueKind: "rollup", Editable: false, Filterable: true,
+ Sortable: true, Groupable: false, DefaultOperator: FilterOperatorContains},
+ KeyTypeLineNumber: {order: 16, ValueKind: "lineNumber", Editable: false, Filterable: false,
+ Sortable: false, Groupable: false, DefaultOperator: ""},
+}
+
+// GetKeyCapability 返回能力声明的副本,未知类型不具备任何基础能力。
+func GetKeyCapability(typ KeyType) KeyCapability {
+ return keyCapabilities[typ]
+}
+
+// KeyTypes 按字段声明顺序返回类型,供生成器和能力枚举使用。
+func KeyTypes() []KeyType {
+ ret := make([]KeyType, 0, len(keyCapabilities))
+ for typ := range keyCapabilities {
+ ret = append(ret, typ)
+ }
+ sort.Slice(ret, func(i, j int) bool { return keyCapabilities[ret[i]].order < keyCapabilities[ret[j]].order })
+ return ret
+}
+
+// 筛选算子清单用于生成联合类型,完整性测试会核对所有 FilterOperator 常量。
+var filterOperators = []FilterOperator{
+ FilterOperatorIsEqual, FilterOperatorIsNotEqual, FilterOperatorIsGreater, FilterOperatorIsGreaterOrEqual,
+ FilterOperatorIsLess, FilterOperatorIsLessOrEqual, FilterOperatorContains, FilterOperatorDoesNotContain,
+ FilterOperatorContainsAnyItem, FilterOperatorDoesNotContainAnyItem, FilterOperatorIsEmpty, FilterOperatorIsNotEmpty,
+ FilterOperatorStartsWith, FilterOperatorEndsWith, FilterOperatorIsBetween, FilterOperatorIsTrue, FilterOperatorIsFalse,
+}
+
+func FilterOperators() []FilterOperator {
+ return append([]FilterOperator(nil), filterOperators...)
+}
+
+func IsDateKeyType(typ KeyType) bool {
+ kind := GetKeyCapability(typ).ValueKind
+ return kind == "date" || kind == "timestamp"
+}
+
+func IsSelectKeyType(typ KeyType) bool {
+ return GetKeyCapability(typ).ValueKind == "options"
+}
diff --git a/kernel/av/capabilities_codegen.go b/kernel/av/capabilities_codegen.go
new file mode 100644
index 0000000000..58c4771363
--- /dev/null
+++ b/kernel/av/capabilities_codegen.go
@@ -0,0 +1,53 @@
+package av
+
+import (
+ "encoding/json"
+ "fmt"
+ "sort"
+ "strings"
+)
+
+// CapabilityTypeScript 生成运行时能力数据与前端、插件共用的类型声明。
+// 生成数据仅供类型分派使用,不写入文档、属性视图或加密信封。
+func CapabilityTypeScript() (runtime, declarations []byte) {
+ var source, types strings.Builder
+ header := "// 此文件由内核字段能力声明生成,请运行 pnpm run api:generate 更新。\n\n"
+ source.WriteString(header)
+ source.WriteString("import type {AVKeyType, AVKeyCapability} from \"../../../types/av\";\n\n")
+ keys := KeyTypes()
+ keyNames := make([]string, len(keys))
+ for i, key := range keys {
+ keyNames[i] = string(key)
+ }
+ keyJSON, _ := json.Marshal(keyNames)
+ fmt.Fprintf(&source, "export const AV_KEY_TYPES: readonly AVKeyType[] = %s;\n\n", keyJSON)
+ source.WriteString("export const AV_KEY_CAPABILITIES: Readonly<Record<AVKeyType, AVKeyCapability>> = {\n")
+ for _, key := range keys {
+ data, _ := json.Marshal(keyCapabilities[key])
+ fmt.Fprintf(&source, " %q: %s,\n", key, data)
+ }
+ source.WriteString("};\n")
+ types.WriteString(header)
+ var keyLiterals, operatorLiterals []string
+ kinds := map[string]bool{}
+ for _, name := range keyNames {
+ keyLiterals = append(keyLiterals, fmt.Sprintf("%q", name))
+ kinds[keyCapabilities[KeyType(name)].ValueKind] = true
+ }
+ for _, operator := range filterOperators {
+ operatorLiterals = append(operatorLiterals, fmt.Sprintf("%q", operator))
+ }
+ fmt.Fprintf(&types, "export type AVKeyType = %s;\n", strings.Join(keyLiterals, " | "))
+ fmt.Fprintf(&types, "export type AVFilterOperator = %s;\n\n", strings.Join(operatorLiterals, " | "))
+ types.WriteString("/** 字段基础能力仅用于类型分派,不属于 AV 持久化格式 */\nexport interface AVKeyCapability {\n")
+ var kindLiterals []string
+ for kind := range kinds {
+ kindLiterals = append(kindLiterals, fmt.Sprintf("%q", kind))
+ }
+ sort.Strings(kindLiterals)
+ fmt.Fprintf(&types, " readonly valueKind: %s;\n", strings.Join(kindLiterals, " | "))
+ types.WriteString(" readonly editable: boolean;\n readonly filterable: boolean;\n readonly sortable: boolean;\n")
+ types.WriteString(" /** 资源字段分组还需要显示模板 */\n readonly groupable: boolean;\n")
+ types.WriteString(" /** 行号为空,关联的汇总取值使用 Contains */\n readonly defaultOperator: AVFilterOperator | \"\";\n}\n")
+ return []byte(source.String()), []byte(types.String())
+}
diff --git a/kernel/av/capabilities_test.go b/kernel/av/capabilities_test.go
new file mode 100644
index 0000000000..0c45637198
--- /dev/null
+++ b/kernel/av/capabilities_test.go
@@ -0,0 +1,188 @@
+package av
+
+import (
+ "bytes"
+ "crypto/sha256"
+ "encoding/json"
+ "go/ast"
+ "go/parser"
+ "go/token"
+ "os"
+ "path/filepath"
+ "reflect"
+ "sort"
+ "strconv"
+ "strings"
+ "testing"
+
+ "github.com/siyuan-note/siyuan/kernel/util"
+)
+
+func declaredCapabilityConstants(t *testing.T, typeName string) []string {
+ t.Helper()
+ packages, err := parser.ParseDir(token.NewFileSet(), ".", func(file os.FileInfo) bool {
+ return !strings.HasSuffix(file.Name(), "_test.go")
+ }, 0)
+ if err != nil {
+ t.Fatal(err)
+ }
+ var values []string
+ for _, file := range packages["av"].Files {
+ for _, declaration := range file.Decls {
+ group, ok := declaration.(*ast.GenDecl)
+ if !ok || group.Tok != token.CONST {
+ continue
+ }
+ for _, spec := range group.Specs {
+ value := spec.(*ast.ValueSpec)
+ typ, ok := value.Type.(*ast.Ident)
+ matches := ok && typ.Name == typeName
+ for _, name := range value.Names {
+ matches = matches || strings.HasPrefix(name.Name, typeName)
+ }
+ if !matches {
+ continue
+ }
+ for _, expression := range value.Values {
+ literal, ok := expression.(*ast.BasicLit)
+ if !ok || literal.Kind != token.STRING {
+ t.Fatalf("%s constants must declare literal protocol values", typeName)
+ }
+ text, err := strconv.Unquote(literal.Value)
+ if err != nil {
+ t.Fatal(err)
+ }
+ values = append(values, text)
+ }
+ }
+ }
+ }
+ sort.Strings(values)
+ return values
+}
+
+func TestKeyCapabilityCompleteness(t *testing.T) {
+ var actual []string
+ orders := map[int]bool{}
+ for typ, capability := range keyCapabilities {
+ actual = append(actual, string(typ))
+ if orders[capability.order] || capability.ValueKind == "" {
+ t.Fatalf("invalid capability declaration for %s", typ)
+ }
+ orders[capability.order] = true
+ if capability.Filterable != (capability.DefaultOperator != "") {
+ t.Fatalf("filterable type %s must declare its default operator", typ)
+ }
+ if capability.DefaultOperator != "" {
+ found := false
+ for _, operator := range filterOperators {
+ found = found || operator == capability.DefaultOperator
+ }
+ if !found {
+ t.Fatalf("type %s uses an undeclared filter operator", typ)
+ }
+ }
+ }
+ sort.Strings(actual)
+ if expected := declaredCapabilityConstants(t, "KeyType"); !reflect.DeepEqual(actual, expected) {
+ t.Fatalf("field capabilities do not cover declared types: got %v want %v", actual, expected)
+ }
+ actual = nil
+ for _, operator := range filterOperators {
+ actual = append(actual, string(operator))
+ }
+ sort.Strings(actual)
+ if expected := declaredCapabilityConstants(t, "FilterOperator"); !reflect.DeepEqual(actual, expected) {
+ t.Fatalf("filter operator registry is incomplete: got %v want %v", actual, expected)
+ }
+}
+
+func TestKeyCapabilityBehavior(t *testing.T) {
+ for _, typ := range KeyTypes() {
+ capability := GetKeyCapability(typ)
+ computed := typ == KeyTypeCreated || typ == KeyTypeUpdated || typ == KeyTypeTemplate || typ == KeyTypeRollup || typ == KeyTypeLineNumber
+ if capability.Editable == computed || AutomationEditableKey(typ) == computed ||
+ isNewItemTemplateEditableKeyType(typ) != (!computed && typ != KeyTypeBlock) {
+ t.Fatalf("editable behavior changed for %s", typ)
+ }
+ date := typ == KeyTypeDate || typ == KeyTypeCreated || typ == KeyTypeUpdated
+ if IsCalendarDateType(typ) != date || IsDateKeyType(typ) != date {
+ t.Fatalf("date behavior changed for %s", typ)
+ }
+ if IsSelectKeyType(typ) != (typ == KeyTypeSelect || typ == KeyTypeMSelect) {
+ t.Fatalf("select behavior changed for %s", typ)
+ }
+ if capability.Filterable != (typ != KeyTypeLineNumber) || capability.Sortable != (typ != KeyTypeLineNumber) ||
+ capability.Groupable != (typ != KeyTypeLineNumber && typ != KeyTypeRollup) {
+ t.Fatalf("filter, sort, or group behavior changed for %s", typ)
+ }
+ }
+ if GetKeyCapability("unknown") != (KeyCapability{}) || AutomationEditableKey("unknown") || IsCalendarDateType("unknown") {
+ t.Fatal("unknown field type acquired capabilities")
+ }
+}
+
+func TestKeyCapabilityGeneratedArtifacts(t *testing.T) {
+ runtime, declarations := CapabilityTypeScript()
+ for file, expected := range map[string][]byte{
+ "../../app/src/protyle/render/av/capabilities.generated.ts": runtime,
+ "../../app/src/types/av/index.d.ts": declarations,
+ } {
+ data, err := os.ReadFile(file)
+ if err != nil || !bytes.Equal(bytes.ReplaceAll(data, []byte("\r\n"), []byte("\n")), expected) {
+ t.Fatalf("generated field capability artifact is out of date: %s (%v)", file, err)
+ }
+ }
+}
+
+func TestKeyCapabilityPersistenceFixture(t *testing.T) {
+ const fixture = "testdata/spec9-layouts.json"
+ data, err := os.ReadFile(fixture)
+ if err != nil {
+ t.Fatal(err)
+ }
+ view, err := ParseAttributeViewData("20260921000000-layouts", data)
+ if err != nil {
+ t.Fatal(err)
+ }
+ before, err := json.Marshal(view)
+ if err != nil {
+ t.Fatal(err)
+ }
+ previousProvider, previousAcquire, previousRelease := AVDEKProvider, AVLockAcquire, AVLockRelease
+ AVDEKProvider = func(string) ([]byte, error) { return bytes.Repeat([]byte{0x62}, 32), nil }
+ AVLockAcquire, AVLockRelease = nil, nil
+ t.Cleanup(func() {
+ AVDEKProvider, AVLockAcquire, AVLockRelease = previousProvider, previousAcquire, previousRelease
+ })
+ const boxID = "20261008000000-box0001"
+ ciphertext, err := EncryptAVData(boxID, view.ID, before)
+ if err != nil || !util.IsCiphertext(ciphertext) {
+ t.Fatalf("fixture encryption failed: %v", err)
+ }
+ preservedCiphertext := bytes.Clone(ciphertext)
+ domain := avAAD(boxID, view.ID)
+ for _, typ := range KeyTypes() {
+ AutomationEditableKey(typ)
+ isNewItemTemplateEditableKeyType(typ)
+ IsCalendarDateType(typ)
+ GetKeyCapability(typ)
+ }
+ after, err := json.Marshal(view)
+ if err != nil || !bytes.Equal(before, after) {
+ t.Fatalf("capability reads changed serialized AV data: %v", err)
+ }
+ decrypted, err := DecryptAVData(boxID, view.ID, ciphertext)
+ if err != nil || !bytes.Equal(decrypted, after) || !bytes.Equal(ciphertext, preservedCiphertext) || domain != avAAD(boxID, view.ID) {
+ t.Fatalf("capability reads changed ciphertext, plaintext, or encryption domain: %v", err)
+ }
+ if _, err = DecryptAVData("20261008000000-other01", view.ID, ciphertext); err == nil {
+ t.Fatal("encrypted fixture authenticated in a different notebook")
+ }
+ stored, err := os.ReadFile(filepath.Clean(fixture))
+ if err != nil || !bytes.Equal(data, stored) {
+ t.Fatalf("capability reads changed the fixture: %v", err)
+ }
+ t.Logf("AV_FIXTURE_BYTES %x", sha256.Sum256(after))
+ t.Logf("AV_FIXTURE_DOMAIN %s", domain)
+}
diff --git a/kernel/av/layout_calendar.go b/kernel/av/layout_calendar.go
index 52c18663c7..14b0abf65f 100644
--- a/kernel/av/layout_calendar.go
+++ b/kernel/av/layout_calendar.go
@@ -69,7 +69,7 @@ func (r *CalendarRange) Location() (*time.Location, error) {
}
func IsCalendarDateType(keyType KeyType) bool {
- return KeyTypeDate == keyType || KeyTypeCreated == keyType || KeyTypeUpdated == keyType
+ return IsDateKeyType(keyType)
}
var calendarTemplateTimePattern = regexp.MustCompile(`[ T](\d{2}):(\d{2})(?::(\d{2}))?$`)
diff --git a/kernel/av/new_item_template.go b/kernel/av/new_item_template.go
index 9495f9f8b9..3ec43d8f7e 100644
--- a/kernel/av/new_item_template.go
+++ b/kernel/av/new_item_template.go
@@ -456,12 +456,7 @@ func normalizeNewItemTemplateValue(value *Value, key *Key) (*Value, error) {
}
func isNewItemTemplateEditableKeyType(keyType KeyType) bool {
- switch keyType {
- case KeyTypeText, KeyTypeNumber, KeyTypeDate, KeyTypeSelect, KeyTypeMSelect, KeyTypeURL, KeyTypeEmail,
- KeyTypePhone, KeyTypeMAsset, KeyTypeCheckbox, KeyTypeRelation:
- return true
- }
- return false
+ return GetKeyCapability(keyType).Editable && keyType != KeyTypeBlock
}
func cloneNewItemTemplate(itemTemplate *NewItemTemplate) *NewItemTemplate {