@ldforge/editor 0.1.5 → 0.1.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/src/controls.ts CHANGED
@@ -7,8 +7,11 @@ export interface EditorControls {
7
7
  readonly prefixes?: boolean;
8
8
  readonly prefixFolding?: boolean;
9
9
  readonly format?: boolean;
10
+ readonly rendererWizard?: boolean;
11
+ readonly loadingIndicator?: boolean;
10
12
  readonly settings?: boolean;
11
13
  readonly language?: boolean;
14
+ readonly fontSize?: boolean;
12
15
  readonly tabs?: boolean;
13
16
  readonly addTab?: boolean;
14
17
  readonly renameTab?: boolean;
@@ -25,8 +28,11 @@ export function resolveControls(
25
28
  prefixes: true,
26
29
  prefixFolding: true,
27
30
  format: true,
31
+ rendererWizard: true,
32
+ loadingIndicator: true,
28
33
  settings: true,
29
34
  language: true,
35
+ fontSize: true,
30
36
  tabs: true,
31
37
  addTab: true,
32
38
  renameTab: true,
@@ -0,0 +1,57 @@
1
+ import type { Locale } from '@ldforge/core';
2
+ export const DEFAULT_FONT_SIZE = 12;
3
+ export function validateFontSize(value: number): void {
4
+ if (!Number.isInteger(value) || value < 10 || value > 24)
5
+ throw new RangeError('fontSize must be an integer from 10 to 24.');
6
+ }
7
+ export function createFontSizeControl(
8
+ doc: Document,
9
+ current: () => number,
10
+ locale: () => Locale,
11
+ onChange: (size: number) => void,
12
+ ) {
13
+ const element = doc.createElement('fieldset');
14
+ element.className = 'ldforge-font-size';
15
+ const legend = doc.createElement('legend');
16
+ const smaller = doc.createElement('button');
17
+ smaller.type = 'button';
18
+ smaller.textContent = 'A−';
19
+ const larger = doc.createElement('button');
20
+ larger.type = 'button';
21
+ larger.textContent = 'A+';
22
+ const reset = doc.createElement('button');
23
+ reset.type = 'button';
24
+ const select = doc.createElement('select');
25
+ for (let size = 10; size <= 24; size++)
26
+ select.append(new Option(`${size} px`, String(size)));
27
+ element.append(legend, smaller, select, larger, reset);
28
+ smaller.addEventListener('click', () =>
29
+ onChange(Math.max(10, current() - 1)),
30
+ );
31
+ larger.addEventListener('click', () => onChange(Math.min(24, current() + 1)));
32
+ reset.addEventListener('click', () => onChange(DEFAULT_FONT_SIZE));
33
+ select.addEventListener('change', () => onChange(Number(select.value)));
34
+ function refresh() {
35
+ const nl = locale() === 'nl';
36
+ legend.textContent = nl ? 'Tekstgrootte' : 'Text size';
37
+ select.setAttribute('aria-label', legend.textContent);
38
+ select.value = String(current());
39
+ smaller.setAttribute(
40
+ 'aria-label',
41
+ nl ? 'Tekst verkleinen' : 'Decrease text size',
42
+ );
43
+ larger.setAttribute(
44
+ 'aria-label',
45
+ nl ? 'Tekst vergroten' : 'Increase text size',
46
+ );
47
+ reset.textContent = nl ? 'Herstellen' : 'Reset';
48
+ reset.setAttribute(
49
+ 'aria-label',
50
+ nl ? 'Tekstgrootte herstellen' : 'Reset text size',
51
+ );
52
+ smaller.disabled = current() === 10;
53
+ larger.disabled = current() === 24;
54
+ }
55
+ refresh();
56
+ return { element, refresh };
57
+ }
package/src/index.ts CHANGED
@@ -1,3 +1,14 @@
1
+ import {
2
+ createFontSizeControl,
3
+ DEFAULT_FONT_SIZE,
4
+ validateFontSize,
5
+ } from './font-size.js';
6
+ import { createRendererWizard } from './renderer-wizard.js';
7
+ import type { RendererWizardApi } from './renderer-wizard.js';
8
+ export type {
9
+ RendererWizardApi,
10
+ RendererHeaderConfig,
11
+ } from './renderer-wizard.js';
1
12
  import {
2
13
  prefixFolding,
3
14
  prefixFoldRanges,
@@ -76,6 +87,9 @@ import type {
76
87
 
77
88
  export type {
78
89
  ResultRendererContext,
90
+ RendererWizardSchema,
91
+ RendererWizardOption,
92
+ RendererBindingContract,
79
93
  QueryViewDirectives,
80
94
  ButtonPlugin,
81
95
  PluginIcon,
@@ -104,7 +118,10 @@ export interface EditorOptions {
104
118
  /** Restored user choice, which takes precedence over the project preference. */
105
119
  readonly userLocale?: LocalePreference;
106
120
  readonly onLocaleChange?: (preference: LocalePreference) => void;
107
- /** Omit to use Run and Cancel; provide an array to replace the toolbar. */
121
+ /** CodeMirror query text size only, 10–24px. */
122
+ readonly fontSize?: number;
123
+ readonly onFontSizeChange?: (size: number) => void;
124
+ /** Omit to use the combined Run/Stop button; provide an array to replace the toolbar. */
108
125
  readonly buttons?: readonly ButtonPlugin[];
109
126
  /** Optional dropdown presentation and additional declarative button groups. */
110
127
  readonly toolbar?: ToolbarOptions;
@@ -121,6 +138,13 @@ export interface ForgeEditor extends EditorContext {
121
138
  /** Returns the resulting collapsed state. False when no PREFIX exists. */
122
139
  togglePrefixes(): boolean;
123
140
  getToolBar(): ToolbarApi;
141
+ /** Registered renderers only; does not load their external visual libraries. */
142
+ getRenderers(): readonly ResultRendererPlugin[];
143
+ getRendererWizard(): RendererWizardApi;
144
+ getFontSize(): number;
145
+ setFontSize(size: number): void;
146
+ isLoadingIndicatorEnabled(): boolean;
147
+ setLoadingIndicatorEnabled(enabled: boolean): void;
124
148
  getWorkspace(): QueryWorkspace;
125
149
  /** Live indexable collection; handles remain stable across edits and renaming. */
126
150
  getTabs(): TabCollection;
@@ -131,17 +155,35 @@ export interface ForgeEditor extends EditorContext {
131
155
  }
132
156
 
133
157
  export function createRunButton(): ButtonPlugin {
158
+ const label = { en: 'Run query', nl: 'Query uitvoeren' };
159
+ const stopLabel = { en: 'Stop query', nl: 'Query stoppen' };
160
+ const title = {
161
+ en: 'Run query (Ctrl/Cmd+Enter)',
162
+ nl: 'Query uitvoeren (Ctrl/Cmd+Enter)',
163
+ };
164
+ const icon = createSvgIcon(['m8 4 12 8-12 8z']);
165
+ const stopIcon = createSvgIcon(['M6 6h12v12H6z']);
134
166
  return {
135
167
  id: 'run',
136
- icon: createSvgIcon(['m8 4 12 8-12 8z']),
137
168
  group: 'query',
138
- label: { en: 'Run query', nl: 'Query uitvoeren' },
139
- title: {
140
- en: 'Run query (Ctrl/Cmd+Enter)',
141
- nl: 'Query uitvoeren (Ctrl/Cmd+Enter)',
169
+ label,
170
+ title,
171
+ icon,
172
+ getLabel(context) {
173
+ return context.getState().status === 'running' ? stopLabel : this.label;
174
+ },
175
+ getTitle(context) {
176
+ return context.getState().status === 'running'
177
+ ? stopLabel
178
+ : (this.title ?? this.label);
179
+ },
180
+ getIcon(context) {
181
+ return context.getState().status === 'running' ? stopIcon : this.icon;
182
+ },
183
+ execute(context) {
184
+ if (context.getState().status === 'running') context.cancel();
185
+ else return context.run();
142
186
  },
143
- isDisabled: (context) => context.getState().status === 'running',
144
- execute: (context) => context.run(),
145
187
  };
146
188
  }
147
189
  export function createCancelButton(): ButtonPlugin {
@@ -162,9 +204,12 @@ export function createEditor(
162
204
  container: HTMLElement,
163
205
  options: EditorOptions,
164
206
  ): ForgeEditor {
207
+ let fontSize = options.fontSize ?? DEFAULT_FONT_SIZE;
208
+ validateFontSize(fontSize);
165
209
  const controls = resolveControls(options.controls);
210
+ let loadingIndicatorEnabled = controls.loadingIndicator;
166
211
  const buttons = new PluginRegistry(
167
- (options.buttons ?? [createRunButton(), createCancelButton()]).filter(
212
+ (options.buttons ?? [createRunButton()]).filter(
168
213
  (button) =>
169
214
  (button.id !== 'run' || controls.run) &&
170
215
  (button.id !== 'cancel' || controls.cancel),
@@ -208,6 +253,7 @@ export function createEditor(
208
253
  tabBar.hidden = !controls.tabs;
209
254
  const editorHost = doc.createElement('div');
210
255
  editorHost.className = 'ldforge-code';
256
+ editorHost.style.setProperty('--ldforge-query-font-size', `${fontSize}px`);
211
257
  editorHost.id = `ldforge-query-${settingsPanelNumber + 1}`;
212
258
  editorHost.setAttribute('role', 'tabpanel');
213
259
  tabBar.dataset.panelId = editorHost.id;
@@ -226,6 +272,14 @@ export function createEditor(
226
272
  download.className = 'ldforge-result-download';
227
273
  appendIcon(download, createSvgIcon(['M12 3v12m-5-5 5 5 5-5M4 16v5h16v-5']));
228
274
  download.hidden = true;
275
+ const loadingIndicator = doc.createElement('div');
276
+ loadingIndicator.className = 'ldforge-loading-indicator';
277
+ loadingIndicator.setAttribute('role', 'status');
278
+ const spinner = doc.createElement('span');
279
+ spinner.className = 'ldforge-spinner';
280
+ spinner.setAttribute('aria-hidden', 'true');
281
+ const loadingLabel = doc.createElement('span');
282
+ loadingIndicator.append(spinner, loadingLabel);
229
283
  const rendererDocs = doc.createElement('a');
230
284
  rendererDocs.className = 'ldforge-renderer-docs';
231
285
  rendererDocs.target = '_blank';
@@ -270,6 +324,14 @@ export function createEditor(
270
324
  languageLabel.hidden = !controls.language;
271
325
  languageHelp.hidden = !controls.language;
272
326
  settingsPanel.append(languageLabel, languageHelp);
327
+ const fontSizeControl = createFontSizeControl(
328
+ doc,
329
+ () => fontSize,
330
+ () => locale,
331
+ (size) => context.setFontSize(size),
332
+ );
333
+ fontSizeControl.element.hidden = !controls.fontSize;
334
+ settingsPanel.append(fontSizeControl.element);
273
335
  const toggle = doc.createElement('button');
274
336
  root.append(
275
337
  toolbar,
@@ -306,6 +368,37 @@ export function createEditor(
306
368
  context.setPrefixesCollapsed(!context.arePrefixesCollapsed());
307
369
  return context.arePrefixesCollapsed();
308
370
  },
371
+ getFontSize() {
372
+ assertAlive();
373
+ return fontSize;
374
+ },
375
+ setFontSize(size) {
376
+ assertAlive();
377
+ validateFontSize(size);
378
+ if (size === fontSize) return;
379
+ fontSize = size;
380
+ editorHost.style.setProperty('--ldforge-query-font-size', `${size}px`);
381
+ fontSizeControl.refresh();
382
+ view.requestMeasure();
383
+ options.onFontSizeChange?.(size);
384
+ },
385
+ isLoadingIndicatorEnabled() {
386
+ assertAlive();
387
+ return loadingIndicatorEnabled;
388
+ },
389
+ setLoadingIndicatorEnabled(enabled) {
390
+ assertAlive();
391
+ loadingIndicatorEnabled = enabled;
392
+ refreshLoadingIndicator();
393
+ },
394
+ getRenderers() {
395
+ assertAlive();
396
+ return renderers.list();
397
+ },
398
+ getRendererWizard() {
399
+ assertAlive();
400
+ return rendererWizard.api;
401
+ },
309
402
  getToolBar() {
310
403
  assertAlive();
311
404
  return toolbarView.api;
@@ -348,6 +441,7 @@ export function createEditor(
348
441
  focus: () => view.focus(),
349
442
  destroy() {
350
443
  if (disposed) return;
444
+ rendererWizard.destroy();
351
445
  toolbarView.destroy();
352
446
  disposed = true;
353
447
  unsubscribe();
@@ -561,6 +655,22 @@ export function createEditor(
561
655
  prefixPicker.toggle.setAttribute('aria-controls', prefixPicker.panel.id);
562
656
  if (controls.prefixes) tools.append(prefixPicker.toggle);
563
657
  if (controls.format) tools.append(formatButton);
658
+ const rendererWizard = createRendererWizard({
659
+ root,
660
+ tools,
661
+ visible: controls.rendererWizard,
662
+ getLocale: () => locale,
663
+ getRenderers: () => renderers.list(),
664
+ getQuery: () => context.getQuery(),
665
+ setQuery: (query) => context.setQuery(query),
666
+ getTabId: () => queryTabs.snapshot().activeId,
667
+ assertAlive,
668
+ onOpen() {
669
+ prefixPicker.close();
670
+ settingsPanel.hidden = true;
671
+ toggle.setAttribute('aria-expanded', 'false');
672
+ },
673
+ });
564
674
  root.insertBefore(prefixPicker.panel, tabBar);
565
675
 
566
676
  function refreshButtons(): void {
@@ -571,6 +681,13 @@ export function createEditor(
571
681
  toolbarView.refresh();
572
682
  }
573
683
 
684
+ function refreshLoadingIndicator(): void {
685
+ loadingLabel.textContent = translate(locale, 'running');
686
+ if (loadingIndicatorEnabled && controller.state.status === 'running')
687
+ output.append(loadingIndicator);
688
+ else loadingIndicator.remove();
689
+ }
690
+
574
691
  function renderResult(): void {
575
692
  const previousCleanup = cleanup;
576
693
  cleanup = undefined;
@@ -585,7 +702,10 @@ export function createEditor(
585
702
  download.hidden =
586
703
  !controls.download || controller.state.status !== 'success';
587
704
  const state = controller.state;
588
- if (state.status !== 'success') return;
705
+ if (state.status !== 'success') {
706
+ refreshLoadingIndicator();
707
+ return;
708
+ }
589
709
  const available = renderers
590
710
  .list()
591
711
  .filter((renderer) => renderer.supports(state.result));
@@ -798,6 +918,8 @@ export function createEditor(
798
918
  }
799
919
 
800
920
  function refreshLocale(): void {
921
+ fontSizeControl.refresh();
922
+ rendererWizard.refreshLocale();
801
923
  prefixPicker.refreshLocale();
802
924
  tools.setAttribute('aria-label', translate(locale, 'coreTools'));
803
925
  customActions.setAttribute('aria-label', translate(locale, 'extraActions'));
@@ -0,0 +1,122 @@
1
+ import { localize, parseQueryViewDirectives } from '@ldforge/core';
2
+ import type { Locale, ResultRendererPlugin } from '@ldforge/core';
3
+ export interface RendererHeaderConfig {
4
+ readonly rendererId: string;
5
+ readonly options?: Readonly<Record<string, string>>;
6
+ readonly includeBindings?: boolean;
7
+ }
8
+ const start = '# ldforge-bindings:start';
9
+ const end = '# ldforge-bindings:end';
10
+ function quote(value: string): string {
11
+ if (typeof value !== 'string')
12
+ throw new Error('Header values must be strings.');
13
+ if (/[\r\n]/.test(value))
14
+ throw new Error('Header values must be a single line.');
15
+ return /^[\w.-]+$/.test(value) ? value : JSON.stringify(value);
16
+ }
17
+ export function generateRendererHeader(
18
+ renderers: readonly ResultRendererPlugin[],
19
+ config: RendererHeaderConfig,
20
+ locale: Locale,
21
+ ): string {
22
+ const renderer = renderers.find((item) => item.id === config.rendererId);
23
+ if (!renderer)
24
+ throw new Error(`Renderer is not registered: ${config.rendererId}`);
25
+ const options = renderer.wizard?.options ?? [];
26
+ for (const key of Object.keys(config.options ?? {}))
27
+ if (!options.some((option) => option.key === key))
28
+ throw new Error(`Unknown renderer option: ${key}`);
29
+ const parts = [`view=${quote(renderer.id)}`];
30
+ for (const option of options) {
31
+ if (
32
+ !/^[a-z][\w-]*$/.test(option.key) ||
33
+ ['view', 'css'].includes(option.key)
34
+ )
35
+ throw new Error('Invalid renderer option key.');
36
+ const value =
37
+ config.options?.[option.key] ??
38
+ option.defaultValue ??
39
+ option.choices?.[0]?.value ??
40
+ '';
41
+ if (
42
+ option.type === 'select' &&
43
+ !option.choices?.some((choice) => choice.value === value)
44
+ )
45
+ throw new Error(`Invalid option value: ${option.key}`);
46
+ if (value) parts.push(`${option.key}=${quote(value)}`);
47
+ }
48
+ const lines = [`# ${parts.join('; ')}`];
49
+ if (
50
+ config.includeBindings !== false &&
51
+ (renderer.wizard?.bindings.length || renderer.wizard?.description)
52
+ ) {
53
+ lines.push(start);
54
+ if (renderer.wizard?.description)
55
+ lines.push(
56
+ `# ${localize(renderer.wizard.description, locale).replace(/[\r\n]/g, ' ')}`,
57
+ );
58
+ for (const binding of renderer.wizard?.bindings ?? []) {
59
+ const required =
60
+ locale === 'nl'
61
+ ? binding.required
62
+ ? 'verplicht'
63
+ : 'optioneel'
64
+ : binding.required
65
+ ? 'required'
66
+ : 'optional';
67
+ lines.push(
68
+ `# ?${binding.variable.replace(/^\?/, '').replace(/[\r\n]/g, ' ')} (${required}): ${localize(binding.description, locale).replace(/[\r\n]/g, ' ')}`,
69
+ );
70
+ }
71
+ lines.push(end);
72
+ }
73
+ return lines.join('\n');
74
+ }
75
+ /** Replace only leading renderer directives/managed contracts; retain query body, CSS and host comments. */
76
+ export function applyRendererHeader(
77
+ query: string,
78
+ header: string,
79
+ renderers: readonly ResultRendererPlugin[],
80
+ ): string {
81
+ const keys = new Set([
82
+ 'view',
83
+ ...renderers.flatMap((renderer) =>
84
+ (renderer.wizard?.options ?? []).flatMap((option) => [
85
+ option.key,
86
+ ...(option.aliases ?? []),
87
+ ]),
88
+ ),
89
+ ]);
90
+ const lines = query.replace(/^\uFEFF/, '').split(/\r?\n/);
91
+ const kept: string[] = [];
92
+ let managed = false;
93
+ let leading = true;
94
+ for (const line of lines) {
95
+ if (leading && line.trim() && !line.trimStart().startsWith('#')) {
96
+ leading = false;
97
+ managed = false;
98
+ }
99
+ if (!leading) {
100
+ kept.push(line);
101
+ continue;
102
+ }
103
+ if (line.trim() === start) {
104
+ managed = true;
105
+ continue;
106
+ }
107
+ if (line.trim() === end) {
108
+ managed = false;
109
+ continue;
110
+ }
111
+ if (managed) continue;
112
+ const directives = parseQueryViewDirectives(line);
113
+ const entries = Object.entries(directives);
114
+ if (entries.some(([key]) => keys.has(key))) {
115
+ for (const [key, value] of entries)
116
+ if (!keys.has(key) && value !== undefined)
117
+ kept.push(`# ${key}=${quote(value)}`);
118
+ } else kept.push(line);
119
+ }
120
+ while (!kept[0]?.trim() && kept.length) kept.shift();
121
+ return `${header}\n\n${kept.join('\n')}`;
122
+ }