Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .changeset/action-description-and-params-translation.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
---
"@objectstack/spec": patch
---

fix(spec): an action's `description` and its parameter dialog now honour the translation bundle

`translateAction` overlaid only `label`, `confirmText`, `successMessage` and
`resultDialog`. The keys for the rest were already there — the translation
schema declares `_actions.ACTION.description` and
`_actions.ACTION.params.PARAM.{label, helpText, placeholder, options}`, and the
translation linter validates both, reporting a parameter key the action does not
declare with a did-you-mean naming the ones it does. So the keys parsed, they
linted, and they resolved to nothing: a translated deployment rendered a
translated action button that opened an untranslated form, because an action's
`description` is the explanatory line under the dialog title and its
parameters' `label` / `helpText` / `placeholder` / option labels are the rest of
that dialog.

They are applied now, wherever the action is served — the REST metadata read,
OpenAPI, MCP — and through `globalActions` for an action that belongs to no
object, the same object-scoped-first order every other action key already used.

Parameters are matched by `name`, falling back to `field` for a field-backed
parameter that names no key of its own: the same rule the linter collects
parameters by, so a key the linter accepts is a key the resolver finds. Option
labels are matched on the stored option `value`, since the authored side is an
array of options while the translation side is a `value` to label map.

Nothing changes for a bundle that carries none of these keys: the authored text
is kept, the parameter array keeps its identity, and a bundle key naming a
parameter the action does not declare is ignored rather than invented into the
dialog. No schema, no validator and no accepted shape moves — every key applied
here was already declared and already validated.
1 change: 1 addition & 0 deletions packages/spec/api-surface/system.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
"AccessControlConfigParsed (type)",
"AccessControlConfigSchema (const)",
"ActionLike (interface)",
"ActionParamLike (interface)",
"ActionResultDialogTranslation (type)",
"ActionResultDialogTranslationSchema (const)",
"AddFieldOperation (const)",
Expand Down
1 change: 1 addition & 0 deletions packages/spec/export-origins/system.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
"AccessControlConfigParsed": "src/system/object-storage.zod.ts#AccessControlConfigParsed (type)",
"AccessControlConfigSchema": "src/system/object-storage.zod.ts#AccessControlConfigSchema (const)",
"ActionLike": "src/system/i18n-resolver.ts#ActionLike (interface)",
"ActionParamLike": "src/system/i18n-resolver.ts#ActionParamLike (interface)",
"ActionResultDialogTranslation": "src/system/translation.zod.ts#ActionResultDialogTranslation (type)",
"ActionResultDialogTranslationSchema": "src/system/translation.zod.ts#ActionResultDialogTranslationSchema (const)",
"AddFieldOperation": "src/system/migration.zod.ts#AddFieldOperation (const)",
Expand Down
167 changes: 167 additions & 0 deletions packages/spec/src/system/i18n-resolver.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -464,6 +464,173 @@ describe('resolveActionResultDialog + translateAction', () => {
});
});

describe('translateAction — description + params (the declared-and-linted keys)', () => {
// The card's own zh-CN fixture: `TranslationItemSchema` declares every key
// below and the translation linter validates them, so this bundle is what an
// author writes today and expects to render.
const bundle: TranslationBundle = {
'zh-CN': {
objects: {
duly_task: {
_actions: {
duly_task_skip: {
label: '跳过',
description: '动作描述',
confirmText: '确认',
successMessage: '已跳过',
params: {
skip_reason: {
label: '原因',
helpText: '帮助',
placeholder: '占位',
options: { too_late: '太晚了' },
},
// A key the action does NOT declare — the linter reports it
// (`checkActionParams`); the resolver must ignore it.
nonexistent_param: { label: '幽灵' },
},
},
},
},
},
globalActions: {
export_secrets: {
description: '导出所有密钥',
params: { format: { label: '格式', helpText: '导出格式' } },
},
},
},
};

const skip = {
name: 'duly_task_skip',
label: 'Skip',
description: 'D',
objectName: 'duly_task',
confirmText: 'Sure?',
successMessage: 'Skipped',
params: [
{
name: 'skip_reason',
label: 'Why skipped',
helpText: 'H',
placeholder: 'P',
options: [
{ value: 'too_late', label: 'Too late' },
{ value: 'duplicate', label: 'Duplicate' },
],
},
],
};

it('overlays the action description', () => {
expect(translateAction(skip, bundle, { locale: 'zh-CN' }).description).toBe('动作描述');
});

it('keeps the authored description when the bundle carries none', () => {
const out = translateAction(skip, bundle, { locale: 'ja-JP', fallbackChain: [] });
expect(out.description).toBe('D');
// Source document is not mutated.
expect(skip.description).toBe('D');
});

it('overlays a param label', () => {
expect(translateAction(skip, bundle, { locale: 'zh-CN' }).params?.[0].label).toBe('原因');
});

it('overlays a param helpText — the ACTION spelling, not the bulk `help`', () => {
const out = translateAction(skip, bundle, { locale: 'zh-CN' });
expect(out.params?.[0].helpText).toBe('帮助');
// The bulk-action spelling must not appear on an action param.
expect(out.params?.[0]).not.toHaveProperty('help');
});

it('overlays a param placeholder', () => {
expect(translateAction(skip, bundle, { locale: 'zh-CN' }).params?.[0].placeholder).toBe('占位');
});

it('overlays param options by stored value, leaving untranslated entries alone', () => {
const out = translateAction(skip, bundle, { locale: 'zh-CN' });
expect(out.params?.[0].options).toEqual([
{ value: 'too_late', label: '太晚了' },
{ value: 'duplicate', label: 'Duplicate' },
]);
// Source options are not mutated.
expect(skip.params[0].options[0].label).toBe('Too late');
});

it('keeps the authored param copy when the bundle carries none', () => {
const out = translateAction(skip, bundle, { locale: 'ja-JP', fallbackChain: [] });
expect(out.params?.[0]).toEqual(skip.params[0]);
// Nothing changed, so the array itself is the authored one (same reference).
expect(out.params).toBe(skip.params);
});

it('matches a field-backed param by `field` when it declares no `name`', () => {
const fieldBacked = {
name: 'duly_task_skip',
objectName: 'duly_task',
params: [{ field: 'skip_reason', label: 'Why skipped' }],
};
const out = translateAction(fieldBacked, bundle, { locale: 'zh-CN' });
expect(out.params?.[0].label).toBe('原因');
});

it('prefers `name` over `field` when both are present', () => {
const both = {
name: 'duly_task_skip',
objectName: 'duly_task',
// `field` names the translated param; `name` is the key the linter
// collects, so the untranslated `name` must win and nothing overlays.
params: [{ name: 'other_key', field: 'skip_reason', label: 'Why skipped' }],
};
const out = translateAction(both, bundle, { locale: 'zh-CN' });
expect(out.params?.[0].label).toBe('Why skipped');
});

it('ignores a bundle param the action does not declare', () => {
const out = translateAction(skip, bundle, { locale: 'zh-CN' });
expect(out.params).toHaveLength(1);
expect(JSON.stringify(out.params)).not.toContain('幽灵');
});

it('resolves description and params through globalActions for object-less actions', () => {
const out = translateAction(
{
name: 'export_secrets',
label: 'Export secrets',
description: 'Export every secret',
params: [{ name: 'format', label: 'Format', helpText: 'File format' }],
},
bundle,
{ locale: 'zh-CN' },
);
expect(out.description).toBe('导出所有密钥');
expect(out.params?.[0].label).toBe('格式');
expect(out.params?.[0].helpText).toBe('导出格式');
});

it('leaves an action with no params untouched', () => {
const out = translateAction(
{ name: 'duly_task_skip', objectName: 'duly_task', label: 'Skip' },
bundle,
{ locale: 'zh-CN' },
);
expect(out).not.toHaveProperty('params');
});

it('reaches an inline action through translateObject', () => {
const out = translateMetadataDocument(
'object',
{ name: 'duly_task', actions: [skip] },
bundle,
{ locale: 'zh-CN' },
);
expect(out.actions[0].description).toBe('动作描述');
expect(out.actions[0].params[0].placeholder).toBe('占位');
});
});

describe('translateMetadataDocument', () => {
it('translates a view document', () => {
const view = {
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .changeset/action-description-and-params-translation.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
---
"@objectstack/spec": patch
---

fix(spec): an action's `description` and its parameter dialog now honour the translation bundle

`translateAction` overlaid only `label`, `confirmText`, `successMessage` and
`resultDialog`. The keys for the rest were already there — the translation
schema declares `_actions.ACTION.description` and
`_actions.ACTION.params.PARAM.{label, helpText, placeholder, options}`, and the
translation linter validates both, reporting a parameter key the action does not
declare with a did-you-mean naming the ones it does. So the keys parsed, they
linted, and they resolved to nothing: a translated deployment rendered a
translated action button that opened an untranslated form, because an action's
`description` is the explanatory line under the dialog title and its
parameters' `label` / `helpText` / `placeholder` / option labels are the rest of
that dialog.

They are applied now, wherever the action is served — the REST metadata read,
OpenAPI, MCP — and through `globalActions` for an action that belongs to no
object, the same object-scoped-first order every other action key already used.

Parameters are matched by `name`, falling back to `field` for a field-backed
parameter that names no key of its own: the same rule the linter collects
parameters by, so a key the linter accepts is a key the resolver finds. Option
labels are matched on the stored option `value`, since the authored side is an
array of options while the translation side is a `value` to label map.

Nothing changes for a bundle that carries none of these keys: the authored text
is kept, the parameter array keeps its identity, and a bundle key naming a
parameter the action does not declare is ignored rather than invented into the
dialog. No schema, no validator and no accepted shape moves — every key applied
here was already declared and already validated.
1 change: 1 addition & 0 deletions packages/spec/api-surface/system.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
"AccessControlConfigParsed (type)",
"AccessControlConfigSchema (const)",
"ActionLike (interface)",
"ActionParamLike (interface)",
"ActionResultDialogTranslation (type)",
"ActionResultDialogTranslationSchema (const)",
"AddFieldOperation (const)",
Expand Down
1 change: 1 addition & 0 deletions packages/spec/export-origins/system.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
"AccessControlConfigParsed": "src/system/object-storage.zod.ts#AccessControlConfigParsed (type)",
"AccessControlConfigSchema": "src/system/object-storage.zod.ts#AccessControlConfigSchema (const)",
"ActionLike": "src/system/i18n-resolver.ts#ActionLike (interface)",
"ActionParamLike": "src/system/i18n-resolver.ts#ActionParamLike (interface)",
"ActionResultDialogTranslation": "src/system/translation.zod.ts#ActionResultDialogTranslation (type)",
"ActionResultDialogTranslationSchema": "src/system/translation.zod.ts#ActionResultDialogTranslationSchema (const)",
"AddFieldOperation": "src/system/migration.zod.ts#AddFieldOperation (const)",
Expand Down
167 changes: 167 additions & 0 deletions packages/spec/src/system/i18n-resolver.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -464,6 +464,173 @@ describe('resolveActionResultDialog + translateAction', () => {
});
});

describe('translateAction — description + params (the declared-and-linted keys)', () => {
// The card's own zh-CN fixture: `TranslationItemSchema` declares every key
// below and the translation linter validates them, so this bundle is what an
// author writes today and expects to render.
const bundle: TranslationBundle = {
'zh-CN': {
objects: {
duly_task: {
_actions: {
duly_task_skip: {
label: '跳过',
description: '动作描述',
confirmText: '确认',
successMessage: '已跳过',
params: {
skip_reason: {
label: '原因',
helpText: '帮助',
placeholder: '占位',
options: { too_late: '太晚了' },
},
// A key the action does NOT declare — the linter reports it
// (`checkActionParams`); the resolver must ignore it.
nonexistent_param: { label: '幽灵' },
},
},
},
},
},
globalActions: {
export_secrets: {
description: '导出所有密钥',
params: { format: { label: '格式', helpText: '导出格式' } },
},
},
},
};

const skip = {
name: 'duly_task_skip',
label: 'Skip',
description: 'D',
objectName: 'duly_task',
confirmText: 'Sure?',
successMessage: 'Skipped',
params: [
{
name: 'skip_reason',
label: 'Why skipped',
helpText: 'H',
placeholder: 'P',
options: [
{ value: 'too_late', label: 'Too late' },
{ value: 'duplicate', label: 'Duplicate' },
],
},
],
};

it('overlays the action description', () => {
expect(translateAction(skip, bundle, { locale: 'zh-CN' }).description).toBe('动作描述');
});

it('keeps the authored description when the bundle carries none', () => {
const out = translateAction(skip, bundle, { locale: 'ja-JP', fallbackChain: [] });
expect(out.description).toBe('D');
// Source document is not mutated.
expect(skip.description).toBe('D');
});

it('overlays a param label', () => {
expect(translateAction(skip, bundle, { locale: 'zh-CN' }).params?.[0].label).toBe('原因');
});

it('overlays a param helpText — the ACTION spelling, not the bulk `help`', () => {
const out = translateAction(skip, bundle, { locale: 'zh-CN' });
expect(out.params?.[0].helpText).toBe('帮助');
// The bulk-action spelling must not appear on an action param.
expect(out.params?.[0]).not.toHaveProperty('help');
});

it('overlays a param placeholder', () => {
expect(translateAction(skip, bundle, { locale: 'zh-CN' }).params?.[0].placeholder).toBe('占位');
});

it('overlays param options by stored value, leaving untranslated entries alone', () => {
const out = translateAction(skip, bundle, { locale: 'zh-CN' });
expect(out.params?.[0].options).toEqual([
{ value: 'too_late', label: '太晚了' },
{ value: 'duplicate', label: 'Duplicate' },
]);
// Source options are not mutated.
expect(skip.params[0].options[0].label).toBe('Too late');
});

it('keeps the authored param copy when the bundle carries none', () => {
const out = translateAction(skip, bundle, { locale: 'ja-JP', fallbackChain: [] });
expect(out.params?.[0]).toEqual(skip.params[0]);
// Nothing changed, so the array itself is the authored one (same reference).
expect(out.params).toBe(skip.params);
});

it('matches a field-backed param by `field` when it declares no `name`', () => {
const fieldBacked = {
name: 'duly_task_skip',
objectName: 'duly_task',
params: [{ field: 'skip_reason', label: 'Why skipped' }],
};
const out = translateAction(fieldBacked, bundle, { locale: 'zh-CN' });
expect(out.params?.[0].label).toBe('原因');
});

it('prefers `name` over `field` when both are present', () => {
const both = {
name: 'duly_task_skip',
objectName: 'duly_task',
// `field` names the translated param; `name` is the key the linter
// collects, so the untranslated `name` must win and nothing overlays.
params: [{ name: 'other_key', field: 'skip_reason', label: 'Why skipped' }],
};
const out = translateAction(both, bundle, { locale: 'zh-CN' });
expect(out.params?.[0].label).toBe('Why skipped');
});

it('ignores a bundle param the action does not declare', () => {
const out = translateAction(skip, bundle, { locale: 'zh-CN' });
expect(out.params).toHaveLength(1);
expect(JSON.stringify(out.params)).not.toContain('幽灵');
});

it('resolves description and params through globalActions for object-less actions', () => {
const out = translateAction(
{
name: 'export_secrets',
label: 'Export secrets',
description: 'Export every secret',
params: [{ name: 'format', label: 'Format', helpText: 'File format' }],
},
bundle,
{ locale: 'zh-CN' },
);
expect(out.description).toBe('导出所有密钥');
expect(out.params?.[0].label).toBe('格式');
expect(out.params?.[0].helpText).toBe('导出格式');
});

it('leaves an action with no params untouched', () => {
const out = translateAction(
{ name: 'duly_task_skip', objectName: 'duly_task', label: 'Skip' },
bundle,
{ locale: 'zh-CN' },
);
expect(out).not.toHaveProperty('params');
});

it('reaches an inline action through translateObject', () => {
const out = translateMetadataDocument(
'object',
{ name: 'duly_task', actions: [skip] },
bundle,
{ locale: 'zh-CN' },
);
expect(out.actions[0].description).toBe('动作描述');
expect(out.actions[0].params[0].placeholder).toBe('占位');
});
});

describe('translateMetadataDocument', () => {
it('translates a view document', () => {
const view = {
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .changeset/action-description-and-params-translation.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
---
"@objectstack/spec": patch
---

fix(spec): an action's `description` and its parameter dialog now honour the translation bundle

`translateAction` overlaid only `label`, `confirmText`, `successMessage` and
`resultDialog`. The keys for the rest were already there — the translation
schema declares `_actions.ACTION.description` and
`_actions.ACTION.params.PARAM.{label, helpText, placeholder, options}`, and the
translation linter validates both, reporting a parameter key the action does not
declare with a did-you-mean naming the ones it does. So the keys parsed, they
linted, and they resolved to nothing: a translated deployment rendered a
translated action button that opened an untranslated form, because an action's
`description` is the explanatory line under the dialog title and its
parameters' `label` / `helpText` / `placeholder` / option labels are the rest of
that dialog.

They are applied now, wherever the action is served — the REST metadata read,
OpenAPI, MCP — and through `globalActions` for an action that belongs to no
object, the same object-scoped-first order every other action key already used.

Parameters are matched by `name`, falling back to `field` for a field-backed
parameter that names no key of its own: the same rule the linter collects
parameters by, so a key the linter accepts is a key the resolver finds. Option
labels are matched on the stored option `value`, since the authored side is an
array of options while the translation side is a `value` to label map.

Nothing changes for a bundle that carries none of these keys: the authored text
is kept, the parameter array keeps its identity, and a bundle key naming a
parameter the action does not declare is ignored rather than invented into the
dialog. No schema, no validator and no accepted shape moves — every key applied
here was already declared and already validated.
1 change: 1 addition & 0 deletions packages/spec/api-surface/system.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
"AccessControlConfigParsed (type)",
"AccessControlConfigSchema (const)",
"ActionLike (interface)",
"ActionParamLike (interface)",
"ActionResultDialogTranslation (type)",
"ActionResultDialogTranslationSchema (const)",
"AddFieldOperation (const)",
Expand Down
1 change: 1 addition & 0 deletions packages/spec/export-origins/system.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
"AccessControlConfigParsed": "src/system/object-storage.zod.ts#AccessControlConfigParsed (type)",
"AccessControlConfigSchema": "src/system/object-storage.zod.ts#AccessControlConfigSchema (const)",
"ActionLike": "src/system/i18n-resolver.ts#ActionLike (interface)",
"ActionParamLike": "src/system/i18n-resolver.ts#ActionParamLike (interface)",
"ActionResultDialogTranslation": "src/system/translation.zod.ts#ActionResultDialogTranslation (type)",
"ActionResultDialogTranslationSchema": "src/system/translation.zod.ts#ActionResultDialogTranslationSchema (const)",
"AddFieldOperation": "src/system/migration.zod.ts#AddFieldOperation (const)",
Expand Down
167 changes: 167 additions & 0 deletions packages/spec/src/system/i18n-resolver.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -464,6 +464,173 @@ describe('resolveActionResultDialog + translateAction', () => {
});
});

describe('translateAction — description + params (the declared-and-linted keys)', () => {
// The card's own zh-CN fixture: `TranslationItemSchema` declares every key
// below and the translation linter validates them, so this bundle is what an
// author writes today and expects to render.
const bundle: TranslationBundle = {
'zh-CN': {
objects: {
duly_task: {
_actions: {
duly_task_skip: {
label: '跳过',
description: '动作描述',
confirmText: '确认',
successMessage: '已跳过',
params: {
skip_reason: {
label: '原因',
helpText: '帮助',
placeholder: '占位',
options: { too_late: '太晚了' },
},
// A key the action does NOT declare — the linter reports it
// (`checkActionParams`); the resolver must ignore it.
nonexistent_param: { label: '幽灵' },
},
},
},
},
},
globalActions: {
export_secrets: {
description: '导出所有密钥',
params: { format: { label: '格式', helpText: '导出格式' } },
},
},
},
};

const skip = {
name: 'duly_task_skip',
label: 'Skip',
description: 'D',
objectName: 'duly_task',
confirmText: 'Sure?',
successMessage: 'Skipped',
params: [
{
name: 'skip_reason',
label: 'Why skipped',
helpText: 'H',
placeholder: 'P',
options: [
{ value: 'too_late', label: 'Too late' },
{ value: 'duplicate', label: 'Duplicate' },
],
},
],
};

it('overlays the action description', () => {
expect(translateAction(skip, bundle, { locale: 'zh-CN' }).description).toBe('动作描述');
});

it('keeps the authored description when the bundle carries none', () => {
const out = translateAction(skip, bundle, { locale: 'ja-JP', fallbackChain: [] });
expect(out.description).toBe('D');
// Source document is not mutated.
expect(skip.description).toBe('D');
});

it('overlays a param label', () => {
expect(translateAction(skip, bundle, { locale: 'zh-CN' }).params?.[0].label).toBe('原因');
});

it('overlays a param helpText — the ACTION spelling, not the bulk `help`', () => {
const out = translateAction(skip, bundle, { locale: 'zh-CN' });
expect(out.params?.[0].helpText).toBe('帮助');
// The bulk-action spelling must not appear on an action param.
expect(out.params?.[0]).not.toHaveProperty('help');
});

it('overlays a param placeholder', () => {
expect(translateAction(skip, bundle, { locale: 'zh-CN' }).params?.[0].placeholder).toBe('占位');
});

it('overlays param options by stored value, leaving untranslated entries alone', () => {
const out = translateAction(skip, bundle, { locale: 'zh-CN' });
expect(out.params?.[0].options).toEqual([
{ value: 'too_late', label: '太晚了' },
{ value: 'duplicate', label: 'Duplicate' },
]);
// Source options are not mutated.
expect(skip.params[0].options[0].label).toBe('Too late');
});

it('keeps the authored param copy when the bundle carries none', () => {
const out = translateAction(skip, bundle, { locale: 'ja-JP', fallbackChain: [] });
expect(out.params?.[0]).toEqual(skip.params[0]);
// Nothing changed, so the array itself is the authored one (same reference).
expect(out.params).toBe(skip.params);
});

it('matches a field-backed param by `field` when it declares no `name`', () => {
const fieldBacked = {
name: 'duly_task_skip',
objectName: 'duly_task',
params: [{ field: 'skip_reason', label: 'Why skipped' }],
};
const out = translateAction(fieldBacked, bundle, { locale: 'zh-CN' });
expect(out.params?.[0].label).toBe('原因');
});

it('prefers `name` over `field` when both are present', () => {
const both = {
name: 'duly_task_skip',
objectName: 'duly_task',
// `field` names the translated param; `name` is the key the linter
// collects, so the untranslated `name` must win and nothing overlays.
params: [{ name: 'other_key', field: 'skip_reason', label: 'Why skipped' }],
};
const out = translateAction(both, bundle, { locale: 'zh-CN' });
expect(out.params?.[0].label).toBe('Why skipped');
});

it('ignores a bundle param the action does not declare', () => {
const out = translateAction(skip, bundle, { locale: 'zh-CN' });
expect(out.params).toHaveLength(1);
expect(JSON.stringify(out.params)).not.toContain('幽灵');
});

it('resolves description and params through globalActions for object-less actions', () => {
const out = translateAction(
{
name: 'export_secrets',
label: 'Export secrets',
description: 'Export every secret',
params: [{ name: 'format', label: 'Format', helpText: 'File format' }],
},
bundle,
{ locale: 'zh-CN' },
);
expect(out.description).toBe('导出所有密钥');
expect(out.params?.[0].label).toBe('格式');
expect(out.params?.[0].helpText).toBe('导出格式');
});

it('leaves an action with no params untouched', () => {
const out = translateAction(
{ name: 'duly_task_skip', objectName: 'duly_task', label: 'Skip' },
bundle,
{ locale: 'zh-CN' },
);
expect(out).not.toHaveProperty('params');
});

it('reaches an inline action through translateObject', () => {
const out = translateMetadataDocument(
'object',
{ name: 'duly_task', actions: [skip] },
bundle,
{ locale: 'zh-CN' },
);
expect(out.actions[0].description).toBe('动作描述');
expect(out.actions[0].params[0].placeholder).toBe('占位');
});
});

describe('translateMetadataDocument', () => {
it('translates a view document', () => {
const view = {
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .changeset/action-description-and-params-translation.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
---
"@objectstack/spec": patch
---

fix(spec): an action's `description` and its parameter dialog now honour the translation bundle

`translateAction` overlaid only `label`, `confirmText`, `successMessage` and
`resultDialog`. The keys for the rest were already there — the translation
schema declares `_actions.ACTION.description` and
`_actions.ACTION.params.PARAM.{label, helpText, placeholder, options}`, and the
translation linter validates both, reporting a parameter key the action does not
declare with a did-you-mean naming the ones it does. So the keys parsed, they
linted, and they resolved to nothing: a translated deployment rendered a
translated action button that opened an untranslated form, because an action's
`description` is the explanatory line under the dialog title and its
parameters' `label` / `helpText` / `placeholder` / option labels are the rest of
that dialog.

They are applied now, wherever the action is served — the REST metadata read,
OpenAPI, MCP — and through `globalActions` for an action that belongs to no
object, the same object-scoped-first order every other action key already used.

Parameters are matched by `name`, falling back to `field` for a field-backed
parameter that names no key of its own: the same rule the linter collects
parameters by, so a key the linter accepts is a key the resolver finds. Option
labels are matched on the stored option `value`, since the authored side is an
array of options while the translation side is a `value` to label map.

Nothing changes for a bundle that carries none of these keys: the authored text
is kept, the parameter array keeps its identity, and a bundle key naming a
parameter the action does not declare is ignored rather than invented into the
dialog. No schema, no validator and no accepted shape moves — every key applied
here was already declared and already validated.
1 change: 1 addition & 0 deletions packages/spec/api-surface/system.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
"AccessControlConfigParsed (type)",
"AccessControlConfigSchema (const)",
"ActionLike (interface)",
"ActionParamLike (interface)",
"ActionResultDialogTranslation (type)",
"ActionResultDialogTranslationSchema (const)",
"AddFieldOperation (const)",
Expand Down
1 change: 1 addition & 0 deletions packages/spec/export-origins/system.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
"AccessControlConfigParsed": "src/system/object-storage.zod.ts#AccessControlConfigParsed (type)",
"AccessControlConfigSchema": "src/system/object-storage.zod.ts#AccessControlConfigSchema (const)",
"ActionLike": "src/system/i18n-resolver.ts#ActionLike (interface)",
"ActionParamLike": "src/system/i18n-resolver.ts#ActionParamLike (interface)",
"ActionResultDialogTranslation": "src/system/translation.zod.ts#ActionResultDialogTranslation (type)",
"ActionResultDialogTranslationSchema": "src/system/translation.zod.ts#ActionResultDialogTranslationSchema (const)",
"AddFieldOperation": "src/system/migration.zod.ts#AddFieldOperation (const)",
Expand Down
167 changes: 167 additions & 0 deletions packages/spec/src/system/i18n-resolver.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -464,6 +464,173 @@ describe('resolveActionResultDialog + translateAction', () => {
});
});

describe('translateAction — description + params (the declared-and-linted keys)', () => {
// The card's own zh-CN fixture: `TranslationItemSchema` declares every key
// below and the translation linter validates them, so this bundle is what an
// author writes today and expects to render.
const bundle: TranslationBundle = {
'zh-CN': {
objects: {
duly_task: {
_actions: {
duly_task_skip: {
label: '跳过',
description: '动作描述',
confirmText: '确认',
successMessage: '已跳过',
params: {
skip_reason: {
label: '原因',
helpText: '帮助',
placeholder: '占位',
options: { too_late: '太晚了' },
},
// A key the action does NOT declare — the linter reports it
// (`checkActionParams`); the resolver must ignore it.
nonexistent_param: { label: '幽灵' },
},
},
},
},
},
globalActions: {
export_secrets: {
description: '导出所有密钥',
params: { format: { label: '格式', helpText: '导出格式' } },
},
},
},
};

const skip = {
name: 'duly_task_skip',
label: 'Skip',
description: 'D',
objectName: 'duly_task',
confirmText: 'Sure?',
successMessage: 'Skipped',
params: [
{
name: 'skip_reason',
label: 'Why skipped',
helpText: 'H',
placeholder: 'P',
options: [
{ value: 'too_late', label: 'Too late' },
{ value: 'duplicate', label: 'Duplicate' },
],
},
],
};

it('overlays the action description', () => {
expect(translateAction(skip, bundle, { locale: 'zh-CN' }).description).toBe('动作描述');
});

it('keeps the authored description when the bundle carries none', () => {
const out = translateAction(skip, bundle, { locale: 'ja-JP', fallbackChain: [] });
expect(out.description).toBe('D');
// Source document is not mutated.
expect(skip.description).toBe('D');
});

it('overlays a param label', () => {
expect(translateAction(skip, bundle, { locale: 'zh-CN' }).params?.[0].label).toBe('原因');
});

it('overlays a param helpText — the ACTION spelling, not the bulk `help`', () => {
const out = translateAction(skip, bundle, { locale: 'zh-CN' });
expect(out.params?.[0].helpText).toBe('帮助');
// The bulk-action spelling must not appear on an action param.
expect(out.params?.[0]).not.toHaveProperty('help');
});

it('overlays a param placeholder', () => {
expect(translateAction(skip, bundle, { locale: 'zh-CN' }).params?.[0].placeholder).toBe('占位');
});

it('overlays param options by stored value, leaving untranslated entries alone', () => {
const out = translateAction(skip, bundle, { locale: 'zh-CN' });
expect(out.params?.[0].options).toEqual([
{ value: 'too_late', label: '太晚了' },
{ value: 'duplicate', label: 'Duplicate' },
]);
// Source options are not mutated.
expect(skip.params[0].options[0].label).toBe('Too late');
});

it('keeps the authored param copy when the bundle carries none', () => {
const out = translateAction(skip, bundle, { locale: 'ja-JP', fallbackChain: [] });
expect(out.params?.[0]).toEqual(skip.params[0]);
// Nothing changed, so the array itself is the authored one (same reference).
expect(out.params).toBe(skip.params);
});

it('matches a field-backed param by `field` when it declares no `name`', () => {
const fieldBacked = {
name: 'duly_task_skip',
objectName: 'duly_task',
params: [{ field: 'skip_reason', label: 'Why skipped' }],
};
const out = translateAction(fieldBacked, bundle, { locale: 'zh-CN' });
expect(out.params?.[0].label).toBe('原因');
});

it('prefers `name` over `field` when both are present', () => {
const both = {
name: 'duly_task_skip',
objectName: 'duly_task',
// `field` names the translated param; `name` is the key the linter
// collects, so the untranslated `name` must win and nothing overlays.
params: [{ name: 'other_key', field: 'skip_reason', label: 'Why skipped' }],
};
const out = translateAction(both, bundle, { locale: 'zh-CN' });
expect(out.params?.[0].label).toBe('Why skipped');
});

it('ignores a bundle param the action does not declare', () => {
const out = translateAction(skip, bundle, { locale: 'zh-CN' });
expect(out.params).toHaveLength(1);
expect(JSON.stringify(out.params)).not.toContain('幽灵');
});

it('resolves description and params through globalActions for object-less actions', () => {
const out = translateAction(
{
name: 'export_secrets',
label: 'Export secrets',
description: 'Export every secret',
params: [{ name: 'format', label: 'Format', helpText: 'File format' }],
},
bundle,
{ locale: 'zh-CN' },
);
expect(out.description).toBe('导出所有密钥');
expect(out.params?.[0].label).toBe('格式');
expect(out.params?.[0].helpText).toBe('导出格式');
});

it('leaves an action with no params untouched', () => {
const out = translateAction(
{ name: 'duly_task_skip', objectName: 'duly_task', label: 'Skip' },
bundle,
{ locale: 'zh-CN' },
);
expect(out).not.toHaveProperty('params');
});

it('reaches an inline action through translateObject', () => {
const out = translateMetadataDocument(
'object',
{ name: 'duly_task', actions: [skip] },
bundle,
{ locale: 'zh-CN' },
);
expect(out.actions[0].description).toBe('动作描述');
expect(out.actions[0].params[0].placeholder).toBe('占位');
});
});

describe('translateMetadataDocument', () => {
it('translates a view document', () => {
const view = {
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .changeset/action-description-and-params-translation.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
---
"@objectstack/spec": patch
---

fix(spec): an action's `description` and its parameter dialog now honour the translation bundle

`translateAction` overlaid only `label`, `confirmText`, `successMessage` and
`resultDialog`. The keys for the rest were already there — the translation
schema declares `_actions.ACTION.description` and
`_actions.ACTION.params.PARAM.{label, helpText, placeholder, options}`, and the
translation linter validates both, reporting a parameter key the action does not
declare with a did-you-mean naming the ones it does. So the keys parsed, they
linted, and they resolved to nothing: a translated deployment rendered a
translated action button that opened an untranslated form, because an action's
`description` is the explanatory line under the dialog title and its
parameters' `label` / `helpText` / `placeholder` / option labels are the rest of
that dialog.

They are applied now, wherever the action is served — the REST metadata read,
OpenAPI, MCP — and through `globalActions` for an action that belongs to no
object, the same object-scoped-first order every other action key already used.

Parameters are matched by `name`, falling back to `field` for a field-backed
parameter that names no key of its own: the same rule the linter collects
parameters by, so a key the linter accepts is a key the resolver finds. Option
labels are matched on the stored option `value`, since the authored side is an
array of options while the translation side is a `value` to label map.

Nothing changes for a bundle that carries none of these keys: the authored text
is kept, the parameter array keeps its identity, and a bundle key naming a
parameter the action does not declare is ignored rather than invented into the
dialog. No schema, no validator and no accepted shape moves — every key applied
here was already declared and already validated.
1 change: 1 addition & 0 deletions packages/spec/api-surface/system.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
"AccessControlConfigParsed (type)",
"AccessControlConfigSchema (const)",
"ActionLike (interface)",
"ActionParamLike (interface)",
"ActionResultDialogTranslation (type)",
"ActionResultDialogTranslationSchema (const)",
"AddFieldOperation (const)",
Expand Down
1 change: 1 addition & 0 deletions packages/spec/export-origins/system.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
"AccessControlConfigParsed": "src/system/object-storage.zod.ts#AccessControlConfigParsed (type)",
"AccessControlConfigSchema": "src/system/object-storage.zod.ts#AccessControlConfigSchema (const)",
"ActionLike": "src/system/i18n-resolver.ts#ActionLike (interface)",
"ActionParamLike": "src/system/i18n-resolver.ts#ActionParamLike (interface)",
"ActionResultDialogTranslation": "src/system/translation.zod.ts#ActionResultDialogTranslation (type)",
"ActionResultDialogTranslationSchema": "src/system/translation.zod.ts#ActionResultDialogTranslationSchema (const)",
"AddFieldOperation": "src/system/migration.zod.ts#AddFieldOperation (const)",
Expand Down
167 changes: 167 additions & 0 deletions packages/spec/src/system/i18n-resolver.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -464,6 +464,173 @@ describe('resolveActionResultDialog + translateAction', () => {
});
});

describe('translateAction — description + params (the declared-and-linted keys)', () => {
// The card's own zh-CN fixture: `TranslationItemSchema` declares every key
// below and the translation linter validates them, so this bundle is what an
// author writes today and expects to render.
const bundle: TranslationBundle = {
'zh-CN': {
objects: {
duly_task: {
_actions: {
duly_task_skip: {
label: '跳过',
description: '动作描述',
confirmText: '确认',
successMessage: '已跳过',
params: {
skip_reason: {
label: '原因',
helpText: '帮助',
placeholder: '占位',
options: { too_late: '太晚了' },
},
// A key the action does NOT declare — the linter reports it
// (`checkActionParams`); the resolver must ignore it.
nonexistent_param: { label: '幽灵' },
},
},
},
},
},
globalActions: {
export_secrets: {
description: '导出所有密钥',
params: { format: { label: '格式', helpText: '导出格式' } },
},
},
},
};

const skip = {
name: 'duly_task_skip',
label: 'Skip',
description: 'D',
objectName: 'duly_task',
confirmText: 'Sure?',
successMessage: 'Skipped',
params: [
{
name: 'skip_reason',
label: 'Why skipped',
helpText: 'H',
placeholder: 'P',
options: [
{ value: 'too_late', label: 'Too late' },
{ value: 'duplicate', label: 'Duplicate' },
],
},
],
};

it('overlays the action description', () => {
expect(translateAction(skip, bundle, { locale: 'zh-CN' }).description).toBe('动作描述');
});

it('keeps the authored description when the bundle carries none', () => {
const out = translateAction(skip, bundle, { locale: 'ja-JP', fallbackChain: [] });
expect(out.description).toBe('D');
// Source document is not mutated.
expect(skip.description).toBe('D');
});

it('overlays a param label', () => {
expect(translateAction(skip, bundle, { locale: 'zh-CN' }).params?.[0].label).toBe('原因');
});

it('overlays a param helpText — the ACTION spelling, not the bulk `help`', () => {
const out = translateAction(skip, bundle, { locale: 'zh-CN' });
expect(out.params?.[0].helpText).toBe('帮助');
// The bulk-action spelling must not appear on an action param.
expect(out.params?.[0]).not.toHaveProperty('help');
});

it('overlays a param placeholder', () => {
expect(translateAction(skip, bundle, { locale: 'zh-CN' }).params?.[0].placeholder).toBe('占位');
});

it('overlays param options by stored value, leaving untranslated entries alone', () => {
const out = translateAction(skip, bundle, { locale: 'zh-CN' });
expect(out.params?.[0].options).toEqual([
{ value: 'too_late', label: '太晚了' },
{ value: 'duplicate', label: 'Duplicate' },
]);
// Source options are not mutated.
expect(skip.params[0].options[0].label).toBe('Too late');
});

it('keeps the authored param copy when the bundle carries none', () => {
const out = translateAction(skip, bundle, { locale: 'ja-JP', fallbackChain: [] });
expect(out.params?.[0]).toEqual(skip.params[0]);
// Nothing changed, so the array itself is the authored one (same reference).
expect(out.params).toBe(skip.params);
});

it('matches a field-backed param by `field` when it declares no `name`', () => {
const fieldBacked = {
name: 'duly_task_skip',
objectName: 'duly_task',
params: [{ field: 'skip_reason', label: 'Why skipped' }],
};
const out = translateAction(fieldBacked, bundle, { locale: 'zh-CN' });
expect(out.params?.[0].label).toBe('原因');
});

it('prefers `name` over `field` when both are present', () => {
const both = {
name: 'duly_task_skip',
objectName: 'duly_task',
// `field` names the translated param; `name` is the key the linter
// collects, so the untranslated `name` must win and nothing overlays.
params: [{ name: 'other_key', field: 'skip_reason', label: 'Why skipped' }],
};
const out = translateAction(both, bundle, { locale: 'zh-CN' });
expect(out.params?.[0].label).toBe('Why skipped');
});

it('ignores a bundle param the action does not declare', () => {
const out = translateAction(skip, bundle, { locale: 'zh-CN' });
expect(out.params).toHaveLength(1);
expect(JSON.stringify(out.params)).not.toContain('幽灵');
});

it('resolves description and params through globalActions for object-less actions', () => {
const out = translateAction(
{
name: 'export_secrets',
label: 'Export secrets',
description: 'Export every secret',
params: [{ name: 'format', label: 'Format', helpText: 'File format' }],
},
bundle,
{ locale: 'zh-CN' },
);
expect(out.description).toBe('导出所有密钥');
expect(out.params?.[0].label).toBe('格式');
expect(out.params?.[0].helpText).toBe('导出格式');
});

it('leaves an action with no params untouched', () => {
const out = translateAction(
{ name: 'duly_task_skip', objectName: 'duly_task', label: 'Skip' },
bundle,
{ locale: 'zh-CN' },
);
expect(out).not.toHaveProperty('params');
});

it('reaches an inline action through translateObject', () => {
const out = translateMetadataDocument(
'object',
{ name: 'duly_task', actions: [skip] },
bundle,
{ locale: 'zh-CN' },
);
expect(out.actions[0].description).toBe('动作描述');
expect(out.actions[0].params[0].placeholder).toBe('占位');
});
});

describe('translateMetadataDocument', () => {
it('translates a view document', () => {
const view = {
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .changeset/action-description-and-params-translation.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
---
"@objectstack/spec": patch
---

fix(spec): an action's `description` and its parameter dialog now honour the translation bundle

`translateAction` overlaid only `label`, `confirmText`, `successMessage` and
`resultDialog`. The keys for the rest were already there — the translation
schema declares `_actions.ACTION.description` and
`_actions.ACTION.params.PARAM.{label, helpText, placeholder, options}`, and the
translation linter validates both, reporting a parameter key the action does not
declare with a did-you-mean naming the ones it does. So the keys parsed, they
linted, and they resolved to nothing: a translated deployment rendered a
translated action button that opened an untranslated form, because an action's
`description` is the explanatory line under the dialog title and its
parameters' `label` / `helpText` / `placeholder` / option labels are the rest of
that dialog.

They are applied now, wherever the action is served — the REST metadata read,
OpenAPI, MCP — and through `globalActions` for an action that belongs to no
object, the same object-scoped-first order every other action key already used.

Parameters are matched by `name`, falling back to `field` for a field-backed
parameter that names no key of its own: the same rule the linter collects
parameters by, so a key the linter accepts is a key the resolver finds. Option
labels are matched on the stored option `value`, since the authored side is an
array of options while the translation side is a `value` to label map.

Nothing changes for a bundle that carries none of these keys: the authored text
is kept, the parameter array keeps its identity, and a bundle key naming a
parameter the action does not declare is ignored rather than invented into the
dialog. No schema, no validator and no accepted shape moves — every key applied
here was already declared and already validated.
1 change: 1 addition & 0 deletions packages/spec/api-surface/system.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
"AccessControlConfigParsed (type)",
"AccessControlConfigSchema (const)",
"ActionLike (interface)",
"ActionParamLike (interface)",
"ActionResultDialogTranslation (type)",
"ActionResultDialogTranslationSchema (const)",
"AddFieldOperation (const)",
Expand Down
1 change: 1 addition & 0 deletions packages/spec/export-origins/system.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
"AccessControlConfigParsed": "src/system/object-storage.zod.ts#AccessControlConfigParsed (type)",
"AccessControlConfigSchema": "src/system/object-storage.zod.ts#AccessControlConfigSchema (const)",
"ActionLike": "src/system/i18n-resolver.ts#ActionLike (interface)",
"ActionParamLike": "src/system/i18n-resolver.ts#ActionParamLike (interface)",
"ActionResultDialogTranslation": "src/system/translation.zod.ts#ActionResultDialogTranslation (type)",
"ActionResultDialogTranslationSchema": "src/system/translation.zod.ts#ActionResultDialogTranslationSchema (const)",
"AddFieldOperation": "src/system/migration.zod.ts#AddFieldOperation (const)",
Expand Down
167 changes: 167 additions & 0 deletions packages/spec/src/system/i18n-resolver.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -464,6 +464,173 @@ describe('resolveActionResultDialog + translateAction', () => {
});
});

describe('translateAction — description + params (the declared-and-linted keys)', () => {
// The card's own zh-CN fixture: `TranslationItemSchema` declares every key
// below and the translation linter validates them, so this bundle is what an
// author writes today and expects to render.
const bundle: TranslationBundle = {
'zh-CN': {
objects: {
duly_task: {
_actions: {
duly_task_skip: {
label: '跳过',
description: '动作描述',
confirmText: '确认',
successMessage: '已跳过',
params: {
skip_reason: {
label: '原因',
helpText: '帮助',
placeholder: '占位',
options: { too_late: '太晚了' },
},
// A key the action does NOT declare — the linter reports it
// (`checkActionParams`); the resolver must ignore it.
nonexistent_param: { label: '幽灵' },
},
},
},
},
},
globalActions: {
export_secrets: {
description: '导出所有密钥',
params: { format: { label: '格式', helpText: '导出格式' } },
},
},
},
};

const skip = {
name: 'duly_task_skip',
label: 'Skip',
description: 'D',
objectName: 'duly_task',
confirmText: 'Sure?',
successMessage: 'Skipped',
params: [
{
name: 'skip_reason',
label: 'Why skipped',
helpText: 'H',
placeholder: 'P',
options: [
{ value: 'too_late', label: 'Too late' },
{ value: 'duplicate', label: 'Duplicate' },
],
},
],
};

it('overlays the action description', () => {
expect(translateAction(skip, bundle, { locale: 'zh-CN' }).description).toBe('动作描述');
});

it('keeps the authored description when the bundle carries none', () => {
const out = translateAction(skip, bundle, { locale: 'ja-JP', fallbackChain: [] });
expect(out.description).toBe('D');
// Source document is not mutated.
expect(skip.description).toBe('D');
});

it('overlays a param label', () => {
expect(translateAction(skip, bundle, { locale: 'zh-CN' }).params?.[0].label).toBe('原因');
});

it('overlays a param helpText — the ACTION spelling, not the bulk `help`', () => {
const out = translateAction(skip, bundle, { locale: 'zh-CN' });
expect(out.params?.[0].helpText).toBe('帮助');
// The bulk-action spelling must not appear on an action param.
expect(out.params?.[0]).not.toHaveProperty('help');
});

it('overlays a param placeholder', () => {
expect(translateAction(skip, bundle, { locale: 'zh-CN' }).params?.[0].placeholder).toBe('占位');
});

it('overlays param options by stored value, leaving untranslated entries alone', () => {
const out = translateAction(skip, bundle, { locale: 'zh-CN' });
expect(out.params?.[0].options).toEqual([
{ value: 'too_late', label: '太晚了' },
{ value: 'duplicate', label: 'Duplicate' },
]);
// Source options are not mutated.
expect(skip.params[0].options[0].label).toBe('Too late');
});

it('keeps the authored param copy when the bundle carries none', () => {
const out = translateAction(skip, bundle, { locale: 'ja-JP', fallbackChain: [] });
expect(out.params?.[0]).toEqual(skip.params[0]);
// Nothing changed, so the array itself is the authored one (same reference).
expect(out.params).toBe(skip.params);
});

it('matches a field-backed param by `field` when it declares no `name`', () => {
const fieldBacked = {
name: 'duly_task_skip',
objectName: 'duly_task',
params: [{ field: 'skip_reason', label: 'Why skipped' }],
};
const out = translateAction(fieldBacked, bundle, { locale: 'zh-CN' });
expect(out.params?.[0].label).toBe('原因');
});

it('prefers `name` over `field` when both are present', () => {
const both = {
name: 'duly_task_skip',
objectName: 'duly_task',
// `field` names the translated param; `name` is the key the linter
// collects, so the untranslated `name` must win and nothing overlays.
params: [{ name: 'other_key', field: 'skip_reason', label: 'Why skipped' }],
};
const out = translateAction(both, bundle, { locale: 'zh-CN' });
expect(out.params?.[0].label).toBe('Why skipped');
});

it('ignores a bundle param the action does not declare', () => {
const out = translateAction(skip, bundle, { locale: 'zh-CN' });
expect(out.params).toHaveLength(1);
expect(JSON.stringify(out.params)).not.toContain('幽灵');
});

it('resolves description and params through globalActions for object-less actions', () => {
const out = translateAction(
{
name: 'export_secrets',
label: 'Export secrets',
description: 'Export every secret',
params: [{ name: 'format', label: 'Format', helpText: 'File format' }],
},
bundle,
{ locale: 'zh-CN' },
);
expect(out.description).toBe('导出所有密钥');
expect(out.params?.[0].label).toBe('格式');
expect(out.params?.[0].helpText).toBe('导出格式');
});

it('leaves an action with no params untouched', () => {
const out = translateAction(
{ name: 'duly_task_skip', objectName: 'duly_task', label: 'Skip' },
bundle,
{ locale: 'zh-CN' },
);
expect(out).not.toHaveProperty('params');
});

it('reaches an inline action through translateObject', () => {
const out = translateMetadataDocument(
'object',
{ name: 'duly_task', actions: [skip] },
bundle,
{ locale: 'zh-CN' },
);
expect(out.actions[0].description).toBe('动作描述');
expect(out.actions[0].params[0].placeholder).toBe('占位');
});
});

describe('translateMetadataDocument', () => {
it('translates a view document', () => {
const view = {
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .changeset/action-description-and-params-translation.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
---
"@objectstack/spec": patch
---

fix(spec): an action's `description` and its parameter dialog now honour the translation bundle

`translateAction` overlaid only `label`, `confirmText`, `successMessage` and
`resultDialog`. The keys for the rest were already there — the translation
schema declares `_actions.ACTION.description` and
`_actions.ACTION.params.PARAM.{label, helpText, placeholder, options}`, and the
translation linter validates both, reporting a parameter key the action does not
declare with a did-you-mean naming the ones it does. So the keys parsed, they
linted, and they resolved to nothing: a translated deployment rendered a
translated action button that opened an untranslated form, because an action's
`description` is the explanatory line under the dialog title and its
parameters' `label` / `helpText` / `placeholder` / option labels are the rest of
that dialog.

They are applied now, wherever the action is served — the REST metadata read,
OpenAPI, MCP — and through `globalActions` for an action that belongs to no
object, the same object-scoped-first order every other action key already used.

Parameters are matched by `name`, falling back to `field` for a field-backed
parameter that names no key of its own: the same rule the linter collects
parameters by, so a key the linter accepts is a key the resolver finds. Option
labels are matched on the stored option `value`, since the authored side is an
array of options while the translation side is a `value` to label map.

Nothing changes for a bundle that carries none of these keys: the authored text
is kept, the parameter array keeps its identity, and a bundle key naming a
parameter the action does not declare is ignored rather than invented into the
dialog. No schema, no validator and no accepted shape moves — every key applied
here was already declared and already validated.
1 change: 1 addition & 0 deletions packages/spec/api-surface/system.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
"AccessControlConfigParsed (type)",
"AccessControlConfigSchema (const)",
"ActionLike (interface)",
"ActionParamLike (interface)",
"ActionResultDialogTranslation (type)",
"ActionResultDialogTranslationSchema (const)",
"AddFieldOperation (const)",
Expand Down
1 change: 1 addition & 0 deletions packages/spec/export-origins/system.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
"AccessControlConfigParsed": "src/system/object-storage.zod.ts#AccessControlConfigParsed (type)",
"AccessControlConfigSchema": "src/system/object-storage.zod.ts#AccessControlConfigSchema (const)",
"ActionLike": "src/system/i18n-resolver.ts#ActionLike (interface)",
"ActionParamLike": "src/system/i18n-resolver.ts#ActionParamLike (interface)",
"ActionResultDialogTranslation": "src/system/translation.zod.ts#ActionResultDialogTranslation (type)",
"ActionResultDialogTranslationSchema": "src/system/translation.zod.ts#ActionResultDialogTranslationSchema (const)",
"AddFieldOperation": "src/system/migration.zod.ts#AddFieldOperation (const)",
Expand Down
167 changes: 167 additions & 0 deletions packages/spec/src/system/i18n-resolver.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -464,6 +464,173 @@ describe('resolveActionResultDialog + translateAction', () => {
});
});

describe('translateAction — description + params (the declared-and-linted keys)', () => {
// The card's own zh-CN fixture: `TranslationItemSchema` declares every key
// below and the translation linter validates them, so this bundle is what an
// author writes today and expects to render.
const bundle: TranslationBundle = {
'zh-CN': {
objects: {
duly_task: {
_actions: {
duly_task_skip: {
label: '跳过',
description: '动作描述',
confirmText: '确认',
successMessage: '已跳过',
params: {
skip_reason: {
label: '原因',
helpText: '帮助',
placeholder: '占位',
options: { too_late: '太晚了' },
},
// A key the action does NOT declare — the linter reports it
// (`checkActionParams`); the resolver must ignore it.
nonexistent_param: { label: '幽灵' },
},
},
},
},
},
globalActions: {
export_secrets: {
description: '导出所有密钥',
params: { format: { label: '格式', helpText: '导出格式' } },
},
},
},
};

const skip = {
name: 'duly_task_skip',
label: 'Skip',
description: 'D',
objectName: 'duly_task',
confirmText: 'Sure?',
successMessage: 'Skipped',
params: [
{
name: 'skip_reason',
label: 'Why skipped',
helpText: 'H',
placeholder: 'P',
options: [
{ value: 'too_late', label: 'Too late' },
{ value: 'duplicate', label: 'Duplicate' },
],
},
],
};

it('overlays the action description', () => {
expect(translateAction(skip, bundle, { locale: 'zh-CN' }).description).toBe('动作描述');
});

it('keeps the authored description when the bundle carries none', () => {
const out = translateAction(skip, bundle, { locale: 'ja-JP', fallbackChain: [] });
expect(out.description).toBe('D');
// Source document is not mutated.
expect(skip.description).toBe('D');
});

it('overlays a param label', () => {
expect(translateAction(skip, bundle, { locale: 'zh-CN' }).params?.[0].label).toBe('原因');
});

it('overlays a param helpText — the ACTION spelling, not the bulk `help`', () => {
const out = translateAction(skip, bundle, { locale: 'zh-CN' });
expect(out.params?.[0].helpText).toBe('帮助');
// The bulk-action spelling must not appear on an action param.
expect(out.params?.[0]).not.toHaveProperty('help');
});

it('overlays a param placeholder', () => {
expect(translateAction(skip, bundle, { locale: 'zh-CN' }).params?.[0].placeholder).toBe('占位');
});

it('overlays param options by stored value, leaving untranslated entries alone', () => {
const out = translateAction(skip, bundle, { locale: 'zh-CN' });
expect(out.params?.[0].options).toEqual([
{ value: 'too_late', label: '太晚了' },
{ value: 'duplicate', label: 'Duplicate' },
]);
// Source options are not mutated.
expect(skip.params[0].options[0].label).toBe('Too late');
});

it('keeps the authored param copy when the bundle carries none', () => {
const out = translateAction(skip, bundle, { locale: 'ja-JP', fallbackChain: [] });
expect(out.params?.[0]).toEqual(skip.params[0]);
// Nothing changed, so the array itself is the authored one (same reference).
expect(out.params).toBe(skip.params);
});

it('matches a field-backed param by `field` when it declares no `name`', () => {
const fieldBacked = {
name: 'duly_task_skip',
objectName: 'duly_task',
params: [{ field: 'skip_reason', label: 'Why skipped' }],
};
const out = translateAction(fieldBacked, bundle, { locale: 'zh-CN' });
expect(out.params?.[0].label).toBe('原因');
});

it('prefers `name` over `field` when both are present', () => {
const both = {
name: 'duly_task_skip',
objectName: 'duly_task',
// `field` names the translated param; `name` is the key the linter
// collects, so the untranslated `name` must win and nothing overlays.
params: [{ name: 'other_key', field: 'skip_reason', label: 'Why skipped' }],
};
const out = translateAction(both, bundle, { locale: 'zh-CN' });
expect(out.params?.[0].label).toBe('Why skipped');
});

it('ignores a bundle param the action does not declare', () => {
const out = translateAction(skip, bundle, { locale: 'zh-CN' });
expect(out.params).toHaveLength(1);
expect(JSON.stringify(out.params)).not.toContain('幽灵');
});

it('resolves description and params through globalActions for object-less actions', () => {
const out = translateAction(
{
name: 'export_secrets',
label: 'Export secrets',
description: 'Export every secret',
params: [{ name: 'format', label: 'Format', helpText: 'File format' }],
},
bundle,
{ locale: 'zh-CN' },
);
expect(out.description).toBe('导出所有密钥');
expect(out.params?.[0].label).toBe('格式');
expect(out.params?.[0].helpText).toBe('导出格式');
});

it('leaves an action with no params untouched', () => {
const out = translateAction(
{ name: 'duly_task_skip', objectName: 'duly_task', label: 'Skip' },
bundle,
{ locale: 'zh-CN' },
);
expect(out).not.toHaveProperty('params');
});

it('reaches an inline action through translateObject', () => {
const out = translateMetadataDocument(
'object',
{ name: 'duly_task', actions: [skip] },
bundle,
{ locale: 'zh-CN' },
);
expect(out.actions[0].description).toBe('动作描述');
expect(out.actions[0].params[0].placeholder).toBe('占位');
});
});

describe('translateMetadataDocument', () => {
it('translates a view document', () => {
const view = {
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .changeset/action-description-and-params-translation.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
---
"@objectstack/spec": patch
---

fix(spec): an action's `description` and its parameter dialog now honour the translation bundle

`translateAction` overlaid only `label`, `confirmText`, `successMessage` and
`resultDialog`. The keys for the rest were already there — the translation
schema declares `_actions.ACTION.description` and
`_actions.ACTION.params.PARAM.{label, helpText, placeholder, options}`, and the
translation linter validates both, reporting a parameter key the action does not
declare with a did-you-mean naming the ones it does. So the keys parsed, they
linted, and they resolved to nothing: a translated deployment rendered a
translated action button that opened an untranslated form, because an action's
`description` is the explanatory line under the dialog title and its
parameters' `label` / `helpText` / `placeholder` / option labels are the rest of
that dialog.

They are applied now, wherever the action is served — the REST metadata read,
OpenAPI, MCP — and through `globalActions` for an action that belongs to no
object, the same object-scoped-first order every other action key already used.

Parameters are matched by `name`, falling back to `field` for a field-backed
parameter that names no key of its own: the same rule the linter collects
parameters by, so a key the linter accepts is a key the resolver finds. Option
labels are matched on the stored option `value`, since the authored side is an
array of options while the translation side is a `value` to label map.

Nothing changes for a bundle that carries none of these keys: the authored text
is kept, the parameter array keeps its identity, and a bundle key naming a
parameter the action does not declare is ignored rather than invented into the
dialog. No schema, no validator and no accepted shape moves — every key applied
here was already declared and already validated.
1 change: 1 addition & 0 deletions packages/spec/api-surface/system.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
"AccessControlConfigParsed (type)",
"AccessControlConfigSchema (const)",
"ActionLike (interface)",
"ActionParamLike (interface)",
"ActionResultDialogTranslation (type)",
"ActionResultDialogTranslationSchema (const)",
"AddFieldOperation (const)",
Expand Down
1 change: 1 addition & 0 deletions packages/spec/export-origins/system.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@
"AccessControlConfigParsed": "src/system/object-storage.zod.ts#AccessControlConfigParsed (type)",
"AccessControlConfigSchema": "src/system/object-storage.zod.ts#AccessControlConfigSchema (const)",
"ActionLike": "src/system/i18n-resolver.ts#ActionLike (interface)",
"ActionParamLike": "src/system/i18n-resolver.ts#ActionParamLike (interface)",
"ActionResultDialogTranslation": "src/system/translation.zod.ts#ActionResultDialogTranslation (type)",
"ActionResultDialogTranslationSchema": "src/system/translation.zod.ts#ActionResultDialogTranslationSchema (const)",
"AddFieldOperation": "src/system/migration.zod.ts#AddFieldOperation (const)",
Expand Down
167 changes: 167 additions & 0 deletions packages/spec/src/system/i18n-resolver.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -464,6 +464,173 @@ describe('resolveActionResultDialog + translateAction', () => {
});
});

describe('translateAction — description + params (the declared-and-linted keys)', () => {
// The card's own zh-CN fixture: `TranslationItemSchema` declares every key
// below and the translation linter validates them, so this bundle is what an
// author writes today and expects to render.
const bundle: TranslationBundle = {
'zh-CN': {
objects: {
duly_task: {
_actions: {
duly_task_skip: {
label: '跳过',
description: '动作描述',
confirmText: '确认',
successMessage: '已跳过',
params: {
skip_reason: {
label: '原因',
helpText: '帮助',
placeholder: '占位',
options: { too_late: '太晚了' },
},
// A key the action does NOT declare — the linter reports it
// (`checkActionParams`); the resolver must ignore it.
nonexistent_param: { label: '幽灵' },
},
},
},
},
},
globalActions: {
export_secrets: {
description: '导出所有密钥',
params: { format: { label: '格式', helpText: '导出格式' } },
},
},
},
};

const skip = {
name: 'duly_task_skip',
label: 'Skip',
description: 'D',
objectName: 'duly_task',
confirmText: 'Sure?',
successMessage: 'Skipped',
params: [
{
name: 'skip_reason',
label: 'Why skipped',
helpText: 'H',
placeholder: 'P',
options: [
{ value: 'too_late', label: 'Too late' },
{ value: 'duplicate', label: 'Duplicate' },
],
},
],
};

it('overlays the action description', () => {
expect(translateAction(skip, bundle, { locale: 'zh-CN' }).description).toBe('动作描述');
});

it('keeps the authored description when the bundle carries none', () => {
const out = translateAction(skip, bundle, { locale: 'ja-JP', fallbackChain: [] });
expect(out.description).toBe('D');
// Source document is not mutated.
expect(skip.description).toBe('D');
});

it('overlays a param label', () => {
expect(translateAction(skip, bundle, { locale: 'zh-CN' }).params?.[0].label).toBe('原因');
});

it('overlays a param helpText — the ACTION spelling, not the bulk `help`', () => {
const out = translateAction(skip, bundle, { locale: 'zh-CN' });
expect(out.params?.[0].helpText).toBe('帮助');
// The bulk-action spelling must not appear on an action param.
expect(out.params?.[0]).not.toHaveProperty('help');
});

it('overlays a param placeholder', () => {
expect(translateAction(skip, bundle, { locale: 'zh-CN' }).params?.[0].placeholder).toBe('占位');
});

it('overlays param options by stored value, leaving untranslated entries alone', () => {
const out = translateAction(skip, bundle, { locale: 'zh-CN' });
expect(out.params?.[0].options).toEqual([
{ value: 'too_late', label: '太晚了' },
{ value: 'duplicate', label: 'Duplicate' },
]);
// Source options are not mutated.
expect(skip.params[0].options[0].label).toBe('Too late');
});

it('keeps the authored param copy when the bundle carries none', () => {
const out = translateAction(skip, bundle, { locale: 'ja-JP', fallbackChain: [] });
expect(out.params?.[0]).toEqual(skip.params[0]);
// Nothing changed, so the array itself is the authored one (same reference).
expect(out.params).toBe(skip.params);
});

it('matches a field-backed param by `field` when it declares no `name`', () => {
const fieldBacked = {
name: 'duly_task_skip',
objectName: 'duly_task',
params: [{ field: 'skip_reason', label: 'Why skipped' }],
};
const out = translateAction(fieldBacked, bundle, { locale: 'zh-CN' });
expect(out.params?.[0].label).toBe('原因');
});

it('prefers `name` over `field` when both are present', () => {
const both = {
name: 'duly_task_skip',
objectName: 'duly_task',
// `field` names the translated param; `name` is the key the linter
// collects, so the untranslated `name` must win and nothing overlays.
params: [{ name: 'other_key', field: 'skip_reason', label: 'Why skipped' }],
};
const out = translateAction(both, bundle, { locale: 'zh-CN' });
expect(out.params?.[0].label).toBe('Why skipped');
});

it('ignores a bundle param the action does not declare', () => {
const out = translateAction(skip, bundle, { locale: 'zh-CN' });
expect(out.params).toHaveLength(1);
expect(JSON.stringify(out.params)).not.toContain('幽灵');
});

it('resolves description and params through globalActions for object-less actions', () => {
const out = translateAction(
{
name: 'export_secrets',
label: 'Export secrets',
description: 'Export every secret',
params: [{ name: 'format', label: 'Format', helpText: 'File format' }],
},
bundle,
{ locale: 'zh-CN' },
);
expect(out.description).toBe('导出所有密钥');
expect(out.params?.[0].label).toBe('格式');
expect(out.params?.[0].helpText).toBe('导出格式');
});

it('leaves an action with no params untouched', () => {
const out = translateAction(
{ name: 'duly_task_skip', objectName: 'duly_task', label: 'Skip' },
bundle,
{ locale: 'zh-CN' },
);
expect(out).not.toHaveProperty('params');
});

it('reaches an inline action through translateObject', () => {
const out = translateMetadataDocument(
'object',
{ name: 'duly_task', actions: [skip] },
bundle,
{ locale: 'zh-CN' },
);
expect(out.actions[0].description).toBe('动作描述');
expect(out.actions[0].params[0].placeholder).toBe('占位');
});
});

describe('translateMetadataDocument', () => {
it('translates a view document', () => {
const view = {
Expand Down
Loading
Loading