@zeyos/zx 5.7.1 → 5.8.0
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/CHANGELOG.md +296 -0
- package/README.md +47 -9
- package/dist/types/components/activity-item/activity-item.d.ts +14 -3
- package/dist/types/components/agent-avatar/agent-avatar.d.ts +165 -0
- package/dist/types/components/agent-avatar/agent-face.d.ts +93 -0
- package/dist/types/components/agent-thread/ag-ui.d.ts +21 -9
- package/dist/types/components/agent-thread/agent-thread.d.ts +26 -0
- package/dist/types/components/agent-thread/ui-message-stream.d.ts +3 -1
- package/dist/types/components/approval-card/approval-card.d.ts +31 -2
- package/dist/types/components/aurora/aurora.d.ts +31 -5
- package/dist/types/components/calendar/calendar.d.ts +39 -26
- package/dist/types/components/chart/chart.d.ts +250 -20
- package/dist/types/components/chart/color.d.ts +66 -0
- package/dist/types/components/chart/svg-adapter.d.ts +103 -0
- package/dist/types/components/chart/svg-geometry.d.ts +203 -0
- package/dist/types/components/check-button/check-button.d.ts +1 -4
- package/dist/types/components/checklist/checklist.d.ts +19 -5
- package/dist/types/components/code-editor/code-editor.d.ts +55 -1
- package/dist/types/components/composer/composer.d.ts +41 -6
- package/dist/types/components/context-menu/context-menu.d.ts +36 -8
- package/dist/types/components/copy/copy-button.d.ts +6 -0
- package/dist/types/components/copy/copy-input.d.ts +1 -0
- package/dist/types/components/date-picker/date-picker.d.ts +14 -0
- package/dist/types/components/date-picker/time-picker.d.ts +26 -17
- package/dist/types/components/datebox/datebox.d.ts +8 -4
- package/dist/types/components/dialog/dialog.d.ts +13 -2
- package/dist/types/components/empty-state/empty-state.d.ts +10 -1
- package/dist/types/components/field/field.d.ts +4 -2
- package/dist/types/components/form/form.d.ts +2 -1
- package/dist/types/components/kanban-view/kanban-card.d.ts +7 -0
- package/dist/types/components/kanban-view/kanban-view.d.ts +15 -3
- package/dist/types/components/launcher/launcher.d.ts +26 -0
- package/dist/types/components/master-panel/master-panel.d.ts +9 -4
- package/dist/types/components/menu-button/menu-button.d.ts +29 -5
- package/dist/types/components/message/message.d.ts +308 -5
- package/dist/types/components/modal/modal.d.ts +11 -0
- package/dist/types/components/modal/native-dialog.d.ts +40 -0
- package/dist/types/components/module-bar/module-bar.d.ts +9 -2
- package/dist/types/components/multi-value-editor/multi-value-editor.d.ts +5 -4
- package/dist/types/components/number-field/number-field.d.ts +7 -0
- package/dist/types/components/pagination/pagination.d.ts +341 -19
- package/dist/types/components/run-status/run-status.d.ts +26 -0
- package/dist/types/components/run-trace/run-trace.d.ts +10 -6
- package/dist/types/components/search/search.d.ts +16 -4
- package/dist/types/components/select/select.d.ts +19 -1
- package/dist/types/components/sheet/sheet.d.ts +18 -4
- package/dist/types/components/slider/slider.d.ts +2 -1
- package/dist/types/components/stat-tile/stat-tile.d.ts +20 -3
- package/dist/types/components/stepper/stepper.d.ts +17 -4
- package/dist/types/components/surface/catalog.d.ts +61 -17
- package/dist/types/components/surface/surface.d.ts +6 -4
- package/dist/types/components/table/table.d.ts +207 -5
- package/dist/types/components/table/window.d.ts +25 -1
- package/dist/types/components/toggle/toggle.d.ts +38 -6
- package/dist/types/components/tooltip/tooltip.d.ts +5 -4
- package/dist/types/components/tree/tree.d.ts +43 -6
- package/dist/types/components/truncate/truncate.d.ts +4 -2
- package/dist/types/components/value-list/value-list.d.ts +9 -2
- package/dist/types/core/date.d.ts +2 -1
- package/dist/types/core/drag-axis.d.ts +10 -5
- package/dist/types/core/export.d.ts +2 -2
- package/dist/types/core/format.d.ts +3 -1
- package/dist/types/core/icons.d.ts +36 -3
- package/dist/types/core/keyboard.d.ts +7 -3
- package/dist/types/core/messages.d.ts +3 -0
- package/dist/types/core/storage.d.ts +4 -3
- package/dist/types/core/util.d.ts +3 -1
- package/dist/types/elements/define.d.ts +5 -2
- package/dist/types/index.d.ts +6 -4
- package/dist/types/internal/agent-model.d.ts +99 -0
- package/dist/types/internal/app-rail.d.ts +37 -2
- package/dist/types/internal/collections.d.ts +18 -0
- package/dist/types/internal/menu-items.d.ts +27 -0
- package/dist/types/internal/overlay-content.d.ts +23 -0
- package/dist/types/internal/presence-loop.d.ts +5 -2
- package/dist/types/locales/index.d.ts +3 -0
- package/dist/types/zeyos/calendar.d.ts +43 -7
- package/dist/types/zeyos/connect.d.ts +4 -0
- package/dist/types/zeyos/form.d.ts +13 -5
- package/dist/types/zeyos/select.d.ts +5 -2
- package/dist/types/zeyos/table.d.ts +16 -8
- package/dist/types/zeyos/view.d.ts +2 -1
- package/dist/zx-zeyos.esm.js +2998 -451
- package/dist/zx-zeyos.esm.min.js +4 -4
- package/dist/zx.core.css +4 -0
- package/dist/zx.core.min.css +1 -1
- package/dist/zx.css +948 -48
- package/dist/zx.esm.js +7432 -3408
- package/dist/zx.esm.min.js +26 -26
- package/dist/zx.global.js +7432 -3408
- package/dist/zx.global.min.js +26 -26
- package/dist/zx.layered.css +950 -48
- package/dist/zx.layered.min.css +1 -1
- package/dist/zx.min.css +1 -1
- package/docs/agent-catalog.json +159 -1
- package/docs/agent-surfaces.md +21 -21
- package/docs/api.json +3122 -528
- package/docs/components/account-menu.md +24 -0
- package/docs/components/activity-item.md +23 -0
- package/docs/components/activity-list.md +28 -0
- package/docs/components/agent-avatar.md +59 -0
- package/docs/components/agent-thread.md +275 -0
- package/docs/components/app-icon.md +36 -0
- package/docs/components/app-sidebar.md +92 -0
- package/docs/components/approval-card.md +71 -0
- package/docs/components/aurora.md +34 -0
- package/docs/components/avatar.md +37 -0
- package/docs/components/badge.md +36 -0
- package/docs/components/block-view.md +34 -0
- package/docs/components/breadcrumb.md +20 -0
- package/docs/components/button.md +23 -0
- package/docs/components/calendar.md +68 -0
- package/docs/components/card-view.md +73 -0
- package/docs/components/card.md +25 -0
- package/docs/components/chart.md +109 -0
- package/docs/components/check-button.md +16 -0
- package/docs/components/checklist.md +19 -0
- package/docs/components/code-editor.md +38 -0
- package/docs/components/composer.md +107 -0
- package/docs/components/context-menu.md +32 -0
- package/docs/components/copy.md +37 -0
- package/docs/components/data-filter.md +16 -0
- package/docs/components/date-picker.md +31 -0
- package/docs/components/date-range.md +21 -0
- package/docs/components/datebox.md +31 -0
- package/docs/components/dialog.md +25 -0
- package/docs/components/dock.md +57 -0
- package/docs/components/dropdown.md +39 -0
- package/docs/components/elements.md +63 -0
- package/docs/components/empty-state.md +17 -0
- package/docs/components/entity-ref.md +26 -0
- package/docs/components/field-upload.md +18 -0
- package/docs/components/file-item.md +27 -0
- package/docs/components/file-list.md +23 -0
- package/docs/components/filter-panel.md +45 -0
- package/docs/components/filter.md +47 -0
- package/docs/components/finder.md +25 -0
- package/docs/components/form-widgets.md +42 -0
- package/docs/components/form.md +80 -0
- package/docs/components/grid.md +26 -0
- package/docs/components/groupbox.md +11 -0
- package/docs/components/helpers.md +359 -0
- package/docs/components/icons.md +87 -0
- package/docs/components/index.md +99 -0
- package/docs/components/kanban-view.md +42 -0
- package/docs/components/kbd.md +23 -0
- package/docs/components/kernel.md +41 -0
- package/docs/components/launcher.md +66 -0
- package/docs/components/layout.md +33 -0
- package/docs/components/list-toolbar.md +38 -0
- package/docs/components/loading.md +48 -0
- package/docs/components/menu-button.md +47 -0
- package/docs/components/message.md +76 -0
- package/docs/components/modal.md +27 -0
- package/docs/components/module-bar.md +71 -0
- package/docs/components/multi-value-editor.md +16 -0
- package/docs/components/navigation-bar.md +22 -0
- package/docs/components/number-field.md +34 -0
- package/docs/components/pagination.md +73 -0
- package/docs/components/panel.md +28 -0
- package/docs/components/prompt-starters.md +40 -0
- package/docs/components/prose.md +38 -0
- package/docs/components/questionnaire.md +115 -0
- package/docs/components/rating.md +19 -0
- package/docs/components/run-status.md +50 -0
- package/docs/components/run-trace.md +72 -0
- package/docs/components/search.md +11 -0
- package/docs/components/select.md +129 -0
- package/docs/components/sheet-stack.md +39 -0
- package/docs/components/sheet.md +77 -0
- package/docs/components/skeleton.md +27 -0
- package/docs/components/slider.md +29 -0
- package/docs/components/sort-control.md +21 -0
- package/docs/components/source-list.md +30 -0
- package/docs/components/split-view.md +12 -0
- package/docs/components/stat-tile.md +49 -0
- package/docs/components/stepper.md +27 -0
- package/docs/components/surface.md +152 -0
- package/docs/components/tabbox.md +33 -0
- package/docs/components/table-view.md +43 -0
- package/docs/components/table.md +232 -0
- package/docs/components/tag-picker.md +39 -0
- package/docs/components/timebox.md +16 -0
- package/docs/components/toggle.md +21 -0
- package/docs/components/tokens.md +82 -0
- package/docs/components/toolbar.md +26 -0
- package/docs/components/tooltip.md +16 -0
- package/docs/components/tree.md +48 -0
- package/docs/components/truncate.md +21 -0
- package/docs/components/value-list.md +14 -0
- package/docs/components/view-settings.md +56 -0
- package/docs/components/workspace-switcher.md +42 -0
- package/docs/components/zeyos.md +196 -0
- package/docs/llms-small.txt +299 -0
- package/docs/llms.md +697 -100
- package/docs/llms.txt +46 -19
- package/package.json +9 -4
- package/src/components/activity-item/activity-item.js +21 -2
- package/src/components/agent-avatar/agent-avatar.css +195 -0
- package/src/components/agent-avatar/agent-avatar.js +333 -0
- package/src/components/agent-avatar/agent-face.js +292 -0
- package/src/components/agent-thread/ag-ui.js +44 -11
- package/src/components/agent-thread/agent-thread.js +103 -11
- package/src/components/agent-thread/ui-message-stream.js +3 -1
- package/src/components/app-rail/app-rail.css +5 -0
- package/src/components/app-sidebar/app-sidebar.css +3 -0
- package/src/components/app-sidebar/app-sidebar.js +4 -3
- package/src/components/approval-card/approval-card.css +6 -0
- package/src/components/approval-card/approval-card.js +55 -7
- package/src/components/aurora/aurora.css +149 -14
- package/src/components/aurora/aurora.js +49 -6
- package/src/components/calendar/calendar.css +6 -2
- package/src/components/calendar/calendar.js +127 -47
- package/src/components/card-view/card-view.js +5 -6
- package/src/components/chart/chart.css +159 -1
- package/src/components/chart/chart.js +450 -62
- package/src/components/chart/color.js +297 -0
- package/src/components/chart/svg-adapter.js +576 -0
- package/src/components/chart/svg-geometry.js +323 -0
- package/src/components/check-button/check-button.js +3 -18
- package/src/components/checklist/checklist.js +46 -17
- package/src/components/checklist/field-adapter.js +4 -1
- package/src/components/code-editor/code-editor.css +33 -0
- package/src/components/code-editor/code-editor.js +97 -8
- package/src/components/code-editor/field-adapter.js +3 -0
- package/src/components/composer/composer.css +3 -0
- package/src/components/composer/composer.js +100 -22
- package/src/components/context-menu/context-menu.js +41 -5
- package/src/components/copy/copy-button.js +9 -1
- package/src/components/copy/copy-input.js +5 -0
- package/src/components/data-filter/filter-core.js +0 -1
- package/src/components/date-picker/date-picker.css +8 -0
- package/src/components/date-picker/date-picker.js +47 -8
- package/src/components/date-picker/date-range-picker.js +1 -1
- package/src/components/date-picker/month-picker.js +19 -3
- package/src/components/date-picker/time-picker.js +54 -19
- package/src/components/datebox/date-range-box.js +7 -3
- package/src/components/datebox/datebox.js +32 -6
- package/src/components/dialog/dialog.css +6 -0
- package/src/components/dialog/dialog.js +22 -30
- package/src/components/dropdown/dropdown.js +1 -18
- package/src/components/empty-state/empty-state.js +21 -2
- package/src/components/field/field.js +19 -3
- package/src/components/fieldset/fieldset.js +3 -1
- package/src/components/filter/filter.js +9 -0
- package/src/components/form/form.js +19 -2
- package/src/components/kanban-view/kanban-card.js +15 -2
- package/src/components/kanban-view/kanban-view.css +21 -0
- package/src/components/kanban-view/kanban-view.js +29 -16
- package/src/components/launcher/launcher.css +14 -0
- package/src/components/launcher/launcher.js +54 -9
- package/src/components/master-panel/master-panel.js +24 -22
- package/src/components/menu-button/menu-button.js +26 -4
- package/src/components/message/message.css +228 -29
- package/src/components/message/message.js +664 -30
- package/src/components/modal/modal.js +70 -25
- package/src/components/modal/native-dialog.js +91 -0
- package/src/components/module-bar/module-bar.css +3 -0
- package/src/components/module-bar/module-bar.js +17 -4
- package/src/components/multi-value-editor/multi-value-editor.css +7 -2
- package/src/components/multi-value-editor/multi-value-editor.js +3 -2
- package/src/components/navigation-bar/navigation-bar.js +13 -1
- package/src/components/number-field/field-adapter.js +3 -0
- package/src/components/number-field/number-field.js +2 -1
- package/src/components/pagination/pagination.css +26 -2
- package/src/components/pagination/pagination.js +551 -65
- package/src/components/prose/prose.js +7 -1
- package/src/components/rating/field-adapter.js +3 -0
- package/src/components/run-status/run-status.js +43 -3
- package/src/components/run-trace/run-trace.js +15 -7
- package/src/components/search/search.js +3 -18
- package/src/components/select/field-adapter.js +8 -1
- package/src/components/select/select.js +68 -13
- package/src/components/sheet/sheet.js +27 -8
- package/src/components/slider/field-adapter.js +3 -0
- package/src/components/slider/slider.js +4 -6
- package/src/components/stat-tile/stat-tile.js +24 -9
- package/src/components/stepper/stepper.css +15 -0
- package/src/components/stepper/stepper.js +34 -2
- package/src/components/surface/catalog.js +185 -28
- package/src/components/surface/surface.js +10 -5
- package/src/components/tabbox/tabbox.js +13 -1
- package/src/components/table/table.css +160 -2
- package/src/components/table/table.js +479 -52
- package/src/components/table/window.js +46 -4
- package/src/components/table-view/table-view.js +1 -10
- package/src/components/tag-picker/field-adapter.js +3 -0
- package/src/components/tag-picker/tag-picker.js +2 -0
- package/src/components/timebox/field-adapter.js +3 -0
- package/src/components/toggle/toggle.js +51 -27
- package/src/components/tooltip/tooltip.js +21 -14
- package/src/components/tree/tree.js +87 -14
- package/src/components/truncate/truncate.js +21 -5
- package/src/components/value-list/value-list.js +37 -9
- package/src/components/view-settings/view-settings.js +1 -5
- package/src/core/component.js +34 -2
- package/src/core/date.js +5 -4
- package/src/core/drag-axis.js +24 -7
- package/src/core/export.js +4 -4
- package/src/core/fontawesome.js +34 -3
- package/src/core/format.js +3 -1
- package/src/core/http.js +23 -11
- package/src/core/icons.js +51 -10
- package/src/core/keyboard.js +83 -9
- package/src/core/messages.js +3 -0
- package/src/core/position.js +2 -2
- package/src/core/storage.js +80 -31
- package/src/core/util.js +16 -5
- package/src/elements/define.js +82 -47
- package/src/elements/kit.js +46 -35
- package/src/index.js +8 -4
- package/src/internal/agent-model.js +152 -0
- package/src/internal/app-rail.js +53 -2
- package/src/internal/collections.js +25 -0
- package/src/internal/menu-items.js +59 -0
- package/src/internal/overlay-content.js +35 -0
- package/src/internal/presence-loop.js +61 -14
- package/src/locales/de.js +3 -0
- package/src/zeyos/calendar.js +81 -19
- package/src/zeyos/connect.js +5 -1
- package/src/zeyos/form.js +29 -10
- package/src/zeyos/select.js +36 -12
- package/src/zeyos/table.js +43 -11
- package/src/zeyos/view.js +2 -1
- package/styles/tokens/semantic.css +7 -1
- package/styles/zx.css +1 -0
|
@@ -209,6 +209,23 @@ export type Author = {
|
|
|
209
209
|
* A glyph drawn in a tinted tile instead of initials — a model's mark.
|
|
210
210
|
*/
|
|
211
211
|
icon?: string;
|
|
212
|
+
/**
|
|
213
|
+
* Draws an agent as a generated AgentAvatar face instead of
|
|
214
|
+
* initials or an `icon` tile: its options, or `true` to derive everything from the name. A person
|
|
215
|
+
* ignores it.
|
|
216
|
+
*/
|
|
217
|
+
face?: AuthorFace | true;
|
|
218
|
+
};
|
|
219
|
+
export type AuthorFace = {
|
|
220
|
+
seed?: string | number;
|
|
221
|
+
tone?: string;
|
|
222
|
+
body?: string;
|
|
223
|
+
eyes?: string;
|
|
224
|
+
material?: 'flat' | 'soft';
|
|
225
|
+
spacing?: 0 | 1 | 2;
|
|
226
|
+
};
|
|
227
|
+
export type AgentFace = AuthorFace & {
|
|
228
|
+
name?: string;
|
|
212
229
|
};
|
|
213
230
|
export type Attachment = {
|
|
214
231
|
name: string;
|
|
@@ -399,6 +416,24 @@ export type StateEntry = {
|
|
|
399
416
|
* @property {AgentActivity|null} [activity] What an agent is doing now.
|
|
400
417
|
* @property {string} [via] The model an agent answers through, shown in the byline.
|
|
401
418
|
* @property {string} [icon] A glyph drawn in a tinted tile instead of initials — a model's mark.
|
|
419
|
+
* @property {AuthorFace|true} [face] Draws an agent as a generated AgentAvatar face instead of
|
|
420
|
+
* initials or an `icon` tile: its options, or `true` to derive everything from the name. A person
|
|
421
|
+
* ignores it.
|
|
422
|
+
*/
|
|
423
|
+
/**
|
|
424
|
+
* The AgentAvatar options an author's face takes; name, size, label and activity come from the
|
|
425
|
+
* author and the place it is drawn. `seed` is what keeps the face — the agent's stable id; a
|
|
426
|
+
* number is read as text, so `42` and `'42'` are one face. `spacing` is the trait
|
|
427
|
+
* `AgentAvatar.getTraits()` reports, for a look stored once.
|
|
428
|
+
* @typedef {{seed?: string|number, tone?: string, body?: string, eyes?: string, material?: 'flat'|'soft',
|
|
429
|
+
* spacing?: 0|1|2}} AuthorFace
|
|
430
|
+
*/
|
|
431
|
+
/**
|
|
432
|
+
* An agent drawn as its AgentAvatar face where a component would otherwise draw an icon: the
|
|
433
|
+
* face's traits and the agent's name. Size, label, activity and motion come from the place it is
|
|
434
|
+
* drawn. The face is keyed by `seed`, else by `name`; give one of them, since a face drawn without
|
|
435
|
+
* either is named after the place it stands in.
|
|
436
|
+
* @typedef {AuthorFace & {name?: string}} AgentFace
|
|
402
437
|
*/
|
|
403
438
|
/** @typedef {{name: string, size?: number, type?: string}} Attachment */
|
|
404
439
|
/**
|
|
@@ -447,6 +482,12 @@ export declare const ACTIVITY: Readonly<Record<AgentActivity, {
|
|
|
447
482
|
tone: StateTone;
|
|
448
483
|
key: string;
|
|
449
484
|
}>>;
|
|
485
|
+
/**
|
|
486
|
+
* The expression an agent's face takes while its run stands in each state: working while it runs,
|
|
487
|
+
* needs-you while it waits for a person, blocked when blocked or failed, and at rest otherwise.
|
|
488
|
+
* @type {Readonly<Record<RunState, AgentActivity>>}
|
|
489
|
+
*/
|
|
490
|
+
export declare const RUN_ACTIVITY: Readonly<Record<RunState, AgentActivity>>;
|
|
450
491
|
/**
|
|
451
492
|
* The English words for `STATUS` and `ACTIVITY`, for a component's `msg` defaults.
|
|
452
493
|
* @type {Readonly<Record<string, string>>}
|
|
@@ -585,3 +626,61 @@ export declare function runCost(tokens: [number, number] | null | undefined, pri
|
|
|
585
626
|
* @returns {string}
|
|
586
627
|
*/
|
|
587
628
|
export declare function initialsOf(name: string): string;
|
|
629
|
+
/**
|
|
630
|
+
* What an item's `agent` may set beyond its face where navigation, the Composer and the Launcher
|
|
631
|
+
* draw it: what the agent is doing and how that shows. Size, label and motion stay the place's.
|
|
632
|
+
* @type {ReadonlyArray<string>}
|
|
633
|
+
*/
|
|
634
|
+
export declare const AGENT_ITEM_KEYS: ReadonlyArray<string>;
|
|
635
|
+
/**
|
|
636
|
+
* The face an author asks for, reduced to the traits it may set, or null for none: `face: true`
|
|
637
|
+
* derives everything, a plain object contributes its `seed`, `tone`, `body`, `eyes`, `material`
|
|
638
|
+
* and `spacing`, and anything else — a person, another value — means initials. Authors may come
|
|
639
|
+
* from an agent's own data, so how the face is drawn and named is never read from it.
|
|
640
|
+
* @param {Partial<Author>|null|undefined} author
|
|
641
|
+
* @returns {AuthorFace|null}
|
|
642
|
+
*/
|
|
643
|
+
export declare function authorFace(author: Partial<Author> | null | undefined): AuthorFace | null;
|
|
644
|
+
/**
|
|
645
|
+
* What an `agent` option asks for, read as {@link authorFace} reads a `face` — `true` derives
|
|
646
|
+
* everything, a plain object contributes its traits and its `name`, anything else is no face.
|
|
647
|
+
* Size, label, activity and motion always belong to the place the face is drawn.
|
|
648
|
+
* @param {unknown} agent
|
|
649
|
+
* @returns {AgentFace|null}
|
|
650
|
+
*/
|
|
651
|
+
export declare function agentFaceTraits(agent: unknown): AgentFace | null;
|
|
652
|
+
/**
|
|
653
|
+
* The options of the AgentAvatar a component draws for an agent: the one way every component
|
|
654
|
+
* builds one, so an agent described the same way has the same face wherever it is drawn.
|
|
655
|
+
*
|
|
656
|
+
* Only what says which face it is comes from `source` — its `seed` (a string, or a finite number
|
|
657
|
+
* read as text), its `tone`, `body`, `eyes`, `material` and `name` strings and its `spacing` —
|
|
658
|
+
* plus the `carry` keys a place lets its data set, as navigation lets an item show what its agent
|
|
659
|
+
* is doing ({@link AGENT_ITEM_KEYS}). Nothing else in it is read, so data never decides how a face
|
|
660
|
+
* is sized, labelled or moved. `fallback` fills in what the source leaves out, such as the name of
|
|
661
|
+
* the row it stands in; `fixed` always wins: the place's size, label and motion.
|
|
662
|
+
*
|
|
663
|
+
* The seed keeps a face. A component reads a fallback name once, when it builds the avatar, and
|
|
664
|
+
* keeps that avatar while the source asks for the same traits, so a summary or a title that
|
|
665
|
+
* changes later never changes the face.
|
|
666
|
+
* @param {unknown} source `true`, or a plain object: an `agent` option, an item's `agent`, or an
|
|
667
|
+
* author's face as {@link authorFace} reads it.
|
|
668
|
+
* @param {Record<string, unknown>} [fixed={}] What the place decides; it wins over everything.
|
|
669
|
+
* @param {{fallback?: Record<string, unknown>, carry?: ReadonlyArray<string>}} [options={}]
|
|
670
|
+
* @returns {Record<string, any>|null} The options, or null when the source asks for no face.
|
|
671
|
+
*/
|
|
672
|
+
export declare function agentAvatarOptions(source: unknown, fixed?: Record<string, unknown>, options?: {
|
|
673
|
+
fallback?: Record<string, unknown>;
|
|
674
|
+
carry?: ReadonlyArray<string>;
|
|
675
|
+
}): Record<string, any> | null;
|
|
676
|
+
/**
|
|
677
|
+
* A pattern that finds each `@name` of `names` in a text as a whole mention: the trigger not right
|
|
678
|
+
* after a letter, mark, digit or underscore of any script, so `ann@ledger.example` mentions
|
|
679
|
+
* nobody, and the name not right before one, so `@Annabel` does not mention Ann. Where names
|
|
680
|
+
* overlap the longest one is found. The Composer reads mentions back from its text and AgentThread
|
|
681
|
+
* marks them by this one rule.
|
|
682
|
+
* @param {Iterable<unknown>} names Names without the trigger.
|
|
683
|
+
* @param {string} [trigger='@']
|
|
684
|
+
* @returns {RegExp|null} A global pattern, or null without a name.
|
|
685
|
+
*/
|
|
686
|
+
export declare function mentionPattern(names: Iterable<unknown>, trigger?: string): RegExp | null;
|
|
@@ -15,6 +15,14 @@ export type AppNavItem = {
|
|
|
15
15
|
icon?: string | Node | {
|
|
16
16
|
toElement: () => Node | null;
|
|
17
17
|
} | ((context: Record<string, any>, item: AppNavItem) => Node | null);
|
|
18
|
+
/**
|
|
19
|
+
* Draws the item as an agent: an AgentAvatar built from these
|
|
20
|
+
* options (`true` for none) in place of `icon`, sized by the slot it sits in. `name` defaults to
|
|
21
|
+
* the item's label. The face shows the agent's `activity` at rest — navigation does not animate —
|
|
22
|
+
* at the small level of detail and flat, whatever the slot measures, and the activity's word
|
|
23
|
+
* joins the control's accessible name ("Ledger, Needs you").
|
|
24
|
+
*/
|
|
25
|
+
agent?: AppNavAgent | true;
|
|
18
26
|
/**
|
|
19
27
|
* Count or status badge.
|
|
20
28
|
*/
|
|
@@ -58,6 +66,7 @@ export type AppNavItem = {
|
|
|
58
66
|
toElement: () => Node | null;
|
|
59
67
|
} | Array<import('./row-actions.js').RowAction | Node>;
|
|
60
68
|
};
|
|
69
|
+
export type AppNavAgent = Omit<import('../components/agent-avatar/agent-avatar.js').AgentAvatarOptions, 'size' | 'label' | 'animate' | 'phase'>;
|
|
61
70
|
export type AppRailPresenterOptions = {
|
|
62
71
|
/**
|
|
63
72
|
* Application navigation tree.
|
|
@@ -136,6 +145,11 @@ export type RailFlyout = {
|
|
|
136
145
|
* @property {string|number} id Stable item identifier.
|
|
137
146
|
* @property {string} label Visible/accessibility label.
|
|
138
147
|
* @property {string|Node|{toElement: () => Node|null}|((context: Record<string, any>, item: AppNavItem) => Node|null)} [icon] Icon name, node, component, or factory.
|
|
148
|
+
* @property {AppNavAgent|true} [agent] Draws the item as an agent: an AgentAvatar built from these
|
|
149
|
+
* options (`true` for none) in place of `icon`, sized by the slot it sits in. `name` defaults to
|
|
150
|
+
* the item's label. The face shows the agent's `activity` at rest — navigation does not animate —
|
|
151
|
+
* at the small level of detail and flat, whatever the slot measures, and the activity's word
|
|
152
|
+
* joins the control's accessible name ("Ledger, Needs you").
|
|
139
153
|
* @property {string|number} [badge] Count or status badge.
|
|
140
154
|
* @property {unknown} [value] Emitted value; defaults to `id`.
|
|
141
155
|
* @property {string} [href] Native navigation target; executable/data schemes are disabled.
|
|
@@ -151,6 +165,10 @@ export type RailFlyout = {
|
|
|
151
165
|
* danger?}` descriptors or nodes, revealed with the row, in its context menu, and after its
|
|
152
166
|
* control in the Tab order while it holds focus. Minimized flyouts show destinations only.
|
|
153
167
|
*/
|
|
168
|
+
/**
|
|
169
|
+
* The AgentAvatar options a navigation item may carry. Size, label and motion belong to the slot.
|
|
170
|
+
* @typedef {Omit<import('../components/agent-avatar/agent-avatar.js').AgentAvatarOptions, 'size'|'label'|'animate'|'phase'>} AppNavAgent
|
|
171
|
+
*/
|
|
154
172
|
/**
|
|
155
173
|
* @typedef {Object} AppRailPresenterOptions
|
|
156
174
|
* @property {AppNavItem[]} [items=[]] Application navigation tree.
|
|
@@ -226,8 +244,8 @@ export declare class AppRailPresenter extends Component<AppRailPresenterOptions>
|
|
|
226
244
|
isFlyoutOpen(id: string | number): boolean;
|
|
227
245
|
/** Focuses the first top-level rail item. @returns {this} */
|
|
228
246
|
focus(): this;
|
|
229
|
-
/** Reports whether a node belongs to this rail, including detached flyout panels. @param {Node|null} node @returns {boolean} @
|
|
230
|
-
|
|
247
|
+
/** Reports whether a node belongs to this rail, including detached flyout panels. @param {Node|null} node @returns {boolean} @protected */
|
|
248
|
+
protected _containsNode(node: Node | null): boolean;
|
|
231
249
|
/** Destroys body popovers/tooltips and restores or removes the root. @returns {void} */
|
|
232
250
|
destroy(): void;
|
|
233
251
|
/** @returns {void} */
|
|
@@ -315,6 +333,23 @@ export declare function normalizeAppItems(items: unknown): AppNavItem[];
|
|
|
315
333
|
* @returns {Node|null}
|
|
316
334
|
*/
|
|
317
335
|
export declare function appNavIcon(item: AppNavItem, renderer: unknown, context: Record<string, any>): Node | null;
|
|
336
|
+
/**
|
|
337
|
+
* The word for what an agent drawn by {@link appNavIcon} is doing, or null for any other visual.
|
|
338
|
+
* @param {Node|null|undefined} visual
|
|
339
|
+
* @returns {string|null}
|
|
340
|
+
*/
|
|
341
|
+
export declare function appNavAgentWord(visual: Node | null | undefined): string | null;
|
|
342
|
+
/**
|
|
343
|
+
* A navigation control's accessible name: its label, followed by an agent's activity when the
|
|
344
|
+
* visual is one. The visible label stays first, so the name still starts with what is shown.
|
|
345
|
+
* A control whose badge is printed inside it, and which this name replaces, passes `withBadge` so
|
|
346
|
+
* the count is not lost: "Ledger, Needs you (2)".
|
|
347
|
+
* @param {AppNavItem} item
|
|
348
|
+
* @param {Node|null|undefined} visual
|
|
349
|
+
* @param {boolean} [withBadge=false] Whether to end the name with the item's badge.
|
|
350
|
+
* @returns {string}
|
|
351
|
+
*/
|
|
352
|
+
export declare function appNavName(item: AppNavItem, visual: Node | null | undefined, withBadge?: boolean): string;
|
|
318
353
|
export {};
|
|
319
354
|
/** Fired when a destination/action is activated. @event AppRailPresenter#select @type {CustomEvent<AppNavSelectDetail>} */
|
|
320
355
|
/** Fired when a flyout opens or closes. @event AppRailPresenter#flyoutchange @type {CustomEvent<{item: AppNavItem, id: string|number, open: boolean}>} */
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Equality checks over the small collections components keep for their state — selections,
|
|
3
|
+
* hidden fields, orders — so a setter can tell a real change from a repeat and stay silent.
|
|
4
|
+
*/
|
|
5
|
+
/**
|
|
6
|
+
* Whether two sets hold the same members, in any order.
|
|
7
|
+
* @param {Set<unknown>} left One set.
|
|
8
|
+
* @param {Set<unknown>} right The other.
|
|
9
|
+
* @returns {boolean}
|
|
10
|
+
*/
|
|
11
|
+
export declare function sameSet(left: Set<unknown>, right: Set<unknown>): boolean;
|
|
12
|
+
/**
|
|
13
|
+
* Whether two arrays hold the same entries in the same order, compared with `Object.is`.
|
|
14
|
+
* @param {unknown[]} left One array.
|
|
15
|
+
* @param {unknown[]} right The other.
|
|
16
|
+
* @returns {boolean}
|
|
17
|
+
*/
|
|
18
|
+
export declare function sameArray(left: unknown[], right: unknown[]): boolean;
|
|
@@ -189,6 +189,33 @@ export declare function isMenuItem(entry: MenuEntry | unknown): entry is MenuIte
|
|
|
189
189
|
* @returns {MenuItemRole}
|
|
190
190
|
*/
|
|
191
191
|
export declare function menuItemRole(item: MenuItem): MenuItemRole;
|
|
192
|
+
/**
|
|
193
|
+
* The checked state choosing an item leaves it in: a `menuitemcheckbox` toggles, a `menuitemradio`
|
|
194
|
+
* becomes checked, and a plain `menuitem` has none.
|
|
195
|
+
* @param {MenuItem} item Chosen item.
|
|
196
|
+
* @param {boolean} current Whether it is checked now.
|
|
197
|
+
* @returns {boolean|undefined}
|
|
198
|
+
*/
|
|
199
|
+
export declare function nextCheckedState(item: MenuItem, current: boolean): boolean | undefined;
|
|
200
|
+
/**
|
|
201
|
+
* The indices of the `menuitemradio` items in the same group as the entry at `index`: the section
|
|
202
|
+
* of the menu it sits in, between the nearest separators or headings. Empty for any other entry.
|
|
203
|
+
* @param {MenuEntry[]} entries The menu's entries.
|
|
204
|
+
* @param {number} index Index of a radio item.
|
|
205
|
+
* @returns {number[]}
|
|
206
|
+
*/
|
|
207
|
+
export declare function radioGroupIndices(entries: MenuEntry[], index: number): number[];
|
|
208
|
+
/**
|
|
209
|
+
* Shows a chosen checkbox or radio item's new state in a menu rendered by `renderMenuEntries()`:
|
|
210
|
+
* its `aria-checked`, and for a radio item that it is now the only checked one of its group. The
|
|
211
|
+
* entries themselves are left as the application gave them.
|
|
212
|
+
* @param {HTMLElement} panel Menu panel holding the rendered entries.
|
|
213
|
+
* @param {MenuEntry[]} entries The entries it was rendered from.
|
|
214
|
+
* @param {number} index Index of the chosen entry.
|
|
215
|
+
* @param {boolean} checked The chosen item's new state.
|
|
216
|
+
* @returns {void}
|
|
217
|
+
*/
|
|
218
|
+
export declare function applyCheckedState(panel: HTMLElement, entries: MenuEntry[], index: number, checked: boolean): void;
|
|
192
219
|
/**
|
|
193
220
|
* Builds one menu's entries with shared structure and link safety.
|
|
194
221
|
* @param {MenuEntry[]} entries Entry definitions.
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Content an overlay accepts: text, a node, or anything exposing `toElement()`. Strings are never
|
|
3
|
+
* parsed as HTML.
|
|
4
|
+
* @typedef {Node|string|number|{toElement: () => Node|null}|null|undefined} OverlayContent
|
|
5
|
+
*/
|
|
6
|
+
export type OverlayContent = Node | string | number | {
|
|
7
|
+
toElement: () => Node | null;
|
|
8
|
+
} | null | undefined;
|
|
9
|
+
/**
|
|
10
|
+
* Replaces a container's children with overlay content.
|
|
11
|
+
* @param {Element} target Container to fill.
|
|
12
|
+
* @param {OverlayContent} content Content to display; null or undefined leaves it empty.
|
|
13
|
+
* @returns {void}
|
|
14
|
+
*/
|
|
15
|
+
export declare function replaceContent(target: Element, content: OverlayContent): void;
|
|
16
|
+
/**
|
|
17
|
+
* Appends overlay content to a container: a string or number as a text node, the result of
|
|
18
|
+
* `toElement()`, or the node itself. Anything else is ignored.
|
|
19
|
+
* @param {Element} target Container to append to.
|
|
20
|
+
* @param {OverlayContent} content Content to append.
|
|
21
|
+
* @returns {void}
|
|
22
|
+
*/
|
|
23
|
+
export declare function appendContent(target: Element, content: OverlayContent): void;
|
|
@@ -105,12 +105,15 @@ export type Entry = {
|
|
|
105
105
|
* Whether the loop has written a transform it has not cleared.
|
|
106
106
|
*/
|
|
107
107
|
moved: boolean;
|
|
108
|
-
unwatch: () => void;
|
|
109
108
|
};
|
|
110
109
|
export type Loop = {
|
|
111
110
|
document: Document;
|
|
112
111
|
entries: Map<HTMLElement, Entry>;
|
|
113
112
|
observer: IntersectionObserver;
|
|
113
|
+
/**
|
|
114
|
+
* The one watcher of `data-zx-motion` regions.
|
|
115
|
+
*/
|
|
116
|
+
motion: MutationObserver | null;
|
|
114
117
|
abort: AbortController;
|
|
115
118
|
frame: number;
|
|
116
119
|
last: number;
|
|
@@ -124,13 +127,13 @@ export type Loop = {
|
|
|
124
127
|
* @property {boolean} visible
|
|
125
128
|
* @property {boolean} reduced
|
|
126
129
|
* @property {boolean} moved Whether the loop has written a transform it has not cleared.
|
|
127
|
-
* @property {() => void} unwatch
|
|
128
130
|
*/
|
|
129
131
|
/**
|
|
130
132
|
* @typedef {Object} Loop
|
|
131
133
|
* @property {Document} document
|
|
132
134
|
* @property {Map<HTMLElement, Entry>} entries
|
|
133
135
|
* @property {IntersectionObserver} observer
|
|
136
|
+
* @property {MutationObserver|null} motion The one watcher of `data-zx-motion` regions.
|
|
134
137
|
* @property {AbortController} abort
|
|
135
138
|
* @property {number} frame
|
|
136
139
|
* @property {number} last
|
|
@@ -522,6 +522,9 @@ export declare const locales: Readonly<{
|
|
|
522
522
|
'navigationBar.more': "More";
|
|
523
523
|
'navigationBar.primary': "Primary navigation";
|
|
524
524
|
'numberField.empty': "Empty";
|
|
525
|
+
'pagination.auto': "Auto";
|
|
526
|
+
'pagination.autoLoad': "Auto-load";
|
|
527
|
+
'pagination.autoSize': "Auto (%1)";
|
|
525
528
|
'pagination.empty': "0 of 0";
|
|
526
529
|
'pagination.label': "Pagination";
|
|
527
530
|
'pagination.loaded': "%1 of %2";
|
|
@@ -36,6 +36,19 @@ export type ZeyosCalendarOptions = {
|
|
|
36
36
|
* Persistence listener.
|
|
37
37
|
*/
|
|
38
38
|
oneventchange?: (event: CustomEvent<Record<string, any>>) => void;
|
|
39
|
+
/**
|
|
40
|
+
* IANA time zone of the ZeyOS instance. An appointment running from
|
|
41
|
+
* midnight to midnight in this zone is all-day and shows on the calendar days it names there, for a
|
|
42
|
+
* viewer in any zone; defaults to the runtime's own zone.
|
|
43
|
+
*/
|
|
44
|
+
timeZone?: string;
|
|
45
|
+
};
|
|
46
|
+
export type ZeyosCalendarZoneOptions = {
|
|
47
|
+
/**
|
|
48
|
+
* IANA time zone of the ZeyOS instance; the runtime's own zone when
|
|
49
|
+
* omitted.
|
|
50
|
+
*/
|
|
51
|
+
timeZone?: string;
|
|
39
52
|
};
|
|
40
53
|
/**
|
|
41
54
|
* @typedef {Object} ZeyosCalendarOptions
|
|
@@ -48,29 +61,52 @@ export type ZeyosCalendarOptions = {
|
|
|
48
61
|
* @property {number} [weekStart=1] User-preferred first weekday.
|
|
49
62
|
* @property {boolean} [workweek=false] Show five days in week view.
|
|
50
63
|
* @property {(event: CustomEvent<Record<string, any>>) => void} [oneventchange] Persistence listener.
|
|
64
|
+
* @property {string} [timeZone] IANA time zone of the ZeyOS instance. An appointment running from
|
|
65
|
+
* midnight to midnight in this zone is all-day and shows on the calendar days it names there, for a
|
|
66
|
+
* viewer in any zone; defaults to the runtime's own zone.
|
|
67
|
+
*/
|
|
68
|
+
/**
|
|
69
|
+
* @typedef {Object} ZeyosCalendarZoneOptions
|
|
70
|
+
* @property {string} [timeZone] IANA time zone of the ZeyOS instance; the runtime's own zone when
|
|
71
|
+
* omitted.
|
|
51
72
|
*/
|
|
52
73
|
/**
|
|
53
74
|
* Maps one expanded ZeyOS appointment/event row to the product-neutral Calendar shape. Occurrence
|
|
54
75
|
* identity includes the start timestamp because recurring rows intentionally share their base ID;
|
|
55
|
-
* persistence callers keep using `event.data.ID`.
|
|
76
|
+
* persistence callers keep using `event.data.ID`. A row without an `allDay` flag is all-day when it
|
|
77
|
+
* runs from midnight to midnight, at least a day apart, in `options.timeZone`; with a zone given,
|
|
78
|
+
* an all-day row's start and end become local midnight of the calendar days they name there.
|
|
56
79
|
* @param {Record<string, any>} record ZeyOS row.
|
|
80
|
+
* @param {ZeyosCalendarZoneOptions} [options={}] Instance time zone.
|
|
57
81
|
* @returns {Record<string, any>} Generic Calendar event.
|
|
82
|
+
* @throws {RangeError} When `options.timeZone` names a zone the runtime does not know.
|
|
83
|
+
*/
|
|
84
|
+
export declare function zeyosAppointmentToEvent(record: Record<string, any>, options?: ZeyosCalendarZoneOptions): Record<string, any>;
|
|
85
|
+
/**
|
|
86
|
+
* Maps expanded ZeyOS appointment/event rows with {@link zeyosAppointmentToEvent}.
|
|
87
|
+
* @param {Record<string, any>[]} records ZeyOS rows.
|
|
88
|
+
* @param {ZeyosCalendarZoneOptions} [options={}] Instance time zone.
|
|
89
|
+
* @returns {Record<string, any>[]} Generic Calendar events.
|
|
58
90
|
*/
|
|
59
|
-
export declare function
|
|
60
|
-
/** @param {Record<string, any>[]} records @returns {Record<string, any>[]} */
|
|
61
|
-
export declare function zeyosAppointmentsToEvents(records: Record<string, any>[]): Record<string, any>[];
|
|
91
|
+
export declare function zeyosAppointmentsToEvents(records: Record<string, any>[], options?: ZeyosCalendarZoneOptions): Record<string, any>[];
|
|
62
92
|
/**
|
|
63
93
|
* Converts a proposed Calendar occurrence back to the current ZeyOS appointment update fields.
|
|
64
94
|
* The base appointment identifier remains the source record's `ID`; date values become Unix
|
|
65
|
-
* seconds and the adapter never adds recurrence or DAV fields.
|
|
66
|
-
*
|
|
95
|
+
* seconds and the adapter never adds recurrence or DAV fields. With `options.timeZone`, an all-day
|
|
96
|
+
* event's days are stored as midnight in that zone, the way {@link zeyosAppointmentToEvent} reads
|
|
97
|
+
* them.
|
|
98
|
+
* @param {{start: Date, end: Date, allDay?: boolean, data?: Record<string, any>}} event Calendar event proposal.
|
|
99
|
+
* @param {ZeyosCalendarZoneOptions} [options={}] Instance time zone.
|
|
67
100
|
* @returns {{ID?: unknown, datefrom: number|null, dateto: number|null}}
|
|
101
|
+
* @throws {RangeError} When the event is all-day and `options.timeZone` names a zone the runtime
|
|
102
|
+
* does not know.
|
|
68
103
|
*/
|
|
69
104
|
export declare function calendarEventToZeyosPatch(event: {
|
|
70
105
|
start: Date;
|
|
71
106
|
end: Date;
|
|
107
|
+
allDay?: boolean;
|
|
72
108
|
data?: Record<string, any>;
|
|
73
|
-
}): {
|
|
109
|
+
}, options?: ZeyosCalendarZoneOptions): {
|
|
74
110
|
ID?: unknown;
|
|
75
111
|
datefrom: number | null;
|
|
76
112
|
dateto: number | null;
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
export type ConnectOptions = {
|
|
2
2
|
/**
|
|
3
3
|
* Error reporter.
|
|
4
|
+
* Every failed helper call reaches it, including one for a resource with no matching operation;
|
|
5
|
+
* `context.operation` is the operation id, or the action (`list`, `get`, …) when none was found.
|
|
4
6
|
*/
|
|
5
7
|
onError?: (error: unknown, context?: {
|
|
6
8
|
operation?: string;
|
|
@@ -43,6 +45,8 @@ export type ZeyosFacade = {
|
|
|
43
45
|
/**
|
|
44
46
|
* @typedef {Object} ConnectOptions
|
|
45
47
|
* @property {(error: unknown, context?: {operation?: string, resource?: string}) => unknown} [onError] Error reporter.
|
|
48
|
+
* Every failed helper call reaches it, including one for a resource with no matching operation;
|
|
49
|
+
* `context.operation` is the operation id, or the action (`list`, `get`, …) when none was found.
|
|
46
50
|
* @property {string} [locale] BCP 47 locale applied to Zx i18n/date formatting.
|
|
47
51
|
*/
|
|
48
52
|
/**
|
|
@@ -92,11 +92,15 @@ export type ZeyosFormBinding = {
|
|
|
92
92
|
*/
|
|
93
93
|
form: Form;
|
|
94
94
|
/**
|
|
95
|
-
* Initial value/load readiness.
|
|
95
|
+
* Initial value/load readiness. It rejects
|
|
96
|
+
* when the initial load fails (reported like any failed request); left unawaited, that rejection is
|
|
97
|
+
* not reported a second time as unhandled.
|
|
96
98
|
*/
|
|
97
99
|
ready: Promise<Record<string, unknown> | null>;
|
|
98
100
|
/**
|
|
99
|
-
* Loads and maps one record.
|
|
101
|
+
* Loads and maps one record. Only
|
|
102
|
+
* the latest call shows its record and becomes the one `save()` updates: an earlier call that
|
|
103
|
+
* settles later still resolves with its record, but leaves the form alone.
|
|
100
104
|
*/
|
|
101
105
|
load: (id: unknown) => Promise<Record<string, unknown>>;
|
|
102
106
|
/**
|
|
@@ -148,8 +152,12 @@ export type ZeyosFormBinding = {
|
|
|
148
152
|
/**
|
|
149
153
|
* @typedef {Object} ZeyosFormBinding
|
|
150
154
|
* @property {Form} form Generated Zx form.
|
|
151
|
-
* @property {Promise<Record<string, unknown>|null>} ready Initial value/load readiness.
|
|
152
|
-
*
|
|
155
|
+
* @property {Promise<Record<string, unknown>|null>} ready Initial value/load readiness. It rejects
|
|
156
|
+
* when the initial load fails (reported like any failed request); left unawaited, that rejection is
|
|
157
|
+
* not reported a second time as unhandled.
|
|
158
|
+
* @property {(id: unknown) => Promise<Record<string, unknown>>} load Loads and maps one record. Only
|
|
159
|
+
* the latest call shows its record and becomes the one `save()` updates: an earlier call that
|
|
160
|
+
* settles later still resolves with its record, but leaves the form alone.
|
|
153
161
|
* @property {() => Promise<Record<string, unknown>|null>} save Validates and creates or updates the
|
|
154
162
|
* record, then confirms with a toast in the form's scope unless `notify` is false.
|
|
155
163
|
* @property {() => Form} getForm Returns the generated Zx Form.
|
|
@@ -169,7 +177,7 @@ export declare function buildZeyosFormConfig(client: Record<string, any>, resour
|
|
|
169
177
|
/**
|
|
170
178
|
* Generates a schema-driven Zx Form and a small async binding object. `load(id)` hydrates entity
|
|
171
179
|
* labels and converts Unix seconds to Date objects. `save()` validates, maps values back to API
|
|
172
|
-
* storage types, calls create/update through the
|
|
180
|
+
* storage types, calls create/update through the `connect()` facade, invokes
|
|
173
181
|
* `onSaved(record)`, and shows a success toast. Its toasts — that confirmation and the report of a
|
|
174
182
|
* failed request — appear in the theme scope of `opts.scope` or of the form itself, and
|
|
175
183
|
* `notify: false` silences them. Await `ready` when `opts.id` or `opts.value` is supplied.
|
|
@@ -147,7 +147,10 @@ export declare function buildZeyosSelectConfig(client: Record<string, any>, reso
|
|
|
147
147
|
/**
|
|
148
148
|
* Creates an async Zx Select backed by the injected client's generated list operation. A non-null
|
|
149
149
|
* initial id is hydrated through the resource get operation; await `select.ready` when code must
|
|
150
|
-
* wait for that label before presenting the control.
|
|
150
|
+
* wait for that label before presenting the control. A selection made while that lookup runs wins
|
|
151
|
+
* over the initial id, and a select destroyed meanwhile is left alone. `ready` rejects when the
|
|
152
|
+
* lookup fails (reported through `connect()` like any failed request); left unawaited, that
|
|
153
|
+
* rejection is not reported a second time as unhandled.
|
|
151
154
|
* @param {Record<string, any>} client Injected ZeyOS client instance.
|
|
152
155
|
* @param {string} resource Resource name such as `accounts`.
|
|
153
156
|
* @param {ZeyosSelectOptions} [opts={}] Query and Select options.
|
|
@@ -188,7 +191,7 @@ export declare function buildZeyosEntitySelectConfig(client: Record<string, any>
|
|
|
188
191
|
}): Record<string, any>;
|
|
189
192
|
/**
|
|
190
193
|
* Creates a ZeyOS Entity-box preset. Await `select.ready` when a non-null initial ID must be
|
|
191
|
-
* hydrated before presentation.
|
|
194
|
+
* hydrated before presentation; it settles like {@link zeyosSelect}'s.
|
|
192
195
|
* @param {Record<string, any>} client Injected ZeyOS client instance.
|
|
193
196
|
* @param {string} resource Resource name.
|
|
194
197
|
* @param {Record<string, any>} [opts={}] Entity Select options.
|
|
@@ -224,7 +224,8 @@ export type ZeyosTableBinding = {
|
|
|
224
224
|
*/
|
|
225
225
|
setFilters: (filters: Record<string, unknown>) => Promise<ZeyosTableLoadResult>;
|
|
226
226
|
/**
|
|
227
|
-
* Appends the next page when available
|
|
227
|
+
* Appends the next page when available;
|
|
228
|
+
* sends nothing while a page-zero reload (a new search, filter, or sort) is still in flight.
|
|
228
229
|
*/
|
|
229
230
|
loadMore: () => Promise<ZeyosTableLoadResult>;
|
|
230
231
|
/**
|
|
@@ -330,7 +331,8 @@ export type ServerPager = {
|
|
|
330
331
|
};
|
|
331
332
|
/**
|
|
332
333
|
* Appends the next page when available,
|
|
333
|
-
* else resolves without a request
|
|
334
|
+
* else resolves without a request — also while a page-zero or `replace` load is still in flight,
|
|
335
|
+
* whose rows the next page of the old query would otherwise land on.
|
|
334
336
|
*/
|
|
335
337
|
loadMore: () => Promise<ZeyosTableLoadResult>;
|
|
336
338
|
/**
|
|
@@ -350,7 +352,8 @@ export type ServerPager = {
|
|
|
350
352
|
search?: unknown;
|
|
351
353
|
}) => void;
|
|
352
354
|
/**
|
|
353
|
-
* Forgets the loaded page, count, and `hasMore`.
|
|
355
|
+
* Forgets the loaded page, count, and `hasMore`. A request still in
|
|
356
|
+
* flight is returned to its caller but no longer renders, and the loading state is cleared.
|
|
354
357
|
*/
|
|
355
358
|
reset: () => void;
|
|
356
359
|
/**
|
|
@@ -425,7 +428,8 @@ export type ServerPager = {
|
|
|
425
428
|
* @property {(options?: ZeyosTableLoadOptions) => Promise<ZeyosTableLoadResult>} load Loads/reloads a server page.
|
|
426
429
|
* @property {(search: string) => Promise<ZeyosTableLoadResult>} setSearch Replaces search and reloads page zero.
|
|
427
430
|
* @property {(filters: Record<string, unknown>) => Promise<ZeyosTableLoadResult>} setFilters Replaces predicates and reloads page zero.
|
|
428
|
-
* @property {() => Promise<ZeyosTableLoadResult>} loadMore Appends the next page when available
|
|
431
|
+
* @property {() => Promise<ZeyosTableLoadResult>} loadMore Appends the next page when available;
|
|
432
|
+
* sends nothing while a page-zero reload (a new search, filter, or sort) is still in flight.
|
|
429
433
|
* @property {number|null} count Current server count.
|
|
430
434
|
* @property {number} page Current zero-based page.
|
|
431
435
|
* @property {number} pageSize Current server page size.
|
|
@@ -461,12 +465,14 @@ export type ServerPager = {
|
|
|
461
465
|
* @property {(options?: ZeyosTableLoadOptions) => {page: number, pageSize: number, filters: Record<string, unknown>, search: string}} check
|
|
462
466
|
* Validates load options without applying them; throws what `load()` would reject with.
|
|
463
467
|
* @property {() => Promise<ZeyosTableLoadResult>} loadMore Appends the next page when available,
|
|
464
|
-
* else resolves without a request
|
|
468
|
+
* else resolves without a request — also while a page-zero or `replace` load is still in flight,
|
|
469
|
+
* whose rows the next page of the old query would otherwise land on.
|
|
465
470
|
* @property {(sort: {id: string, dir: 'asc'|'desc'}|null) => void} setSort Replaces the sort used
|
|
466
471
|
* by the next load.
|
|
467
472
|
* @property {(state: {filters?: unknown, search?: unknown}) => void} setQuery Replaces filters and
|
|
468
473
|
* search without loading.
|
|
469
|
-
* @property {() => void} reset Forgets the loaded page, count, and `hasMore`.
|
|
474
|
+
* @property {() => void} reset Forgets the loaded page, count, and `hasMore`. A request still in
|
|
475
|
+
* flight is returned to its caller but no longer renders, and the loading state is cleared.
|
|
470
476
|
* @property {() => void} destroy Stops rendering: in-flight responses are ignored, later loads reject.
|
|
471
477
|
* @property {boolean} destroyed Whether `destroy()` ran.
|
|
472
478
|
* @property {number|null} count Current server count.
|
|
@@ -480,7 +486,7 @@ export type ServerPager = {
|
|
|
480
486
|
/**
|
|
481
487
|
* Builds the DOM-free schema-derived columns and Table options used by {@link zeyosTable}. Entity
|
|
482
488
|
* projections include an `<field>_label` alias from a real label field on the referenced resource.
|
|
483
|
-
* Amount fields use each row's real `currency` value for display while retaining the
|
|
489
|
+
* Amount fields use each row's real `currency` value for display while retaining the typed
|
|
484
490
|
* column strategy and right alignment. Enum columns show labels, date-only columns calendar days in
|
|
485
491
|
* `timeZone`, and Table presentation options and listeners pass through to `tableOptions`.
|
|
486
492
|
* @param {Record<string, any>} client Injected ZeyOS client instance.
|
|
@@ -514,7 +520,9 @@ export declare function zeyosTable(client: Record<string, any>, resource: string
|
|
|
514
520
|
* the rows, a higher page appends them — and keeps `count`, `page`, and `hasMore`.
|
|
515
521
|
*
|
|
516
522
|
* Only the newest request may render: an older one that resolves late is returned to its caller
|
|
517
|
-
* but never touches the target
|
|
523
|
+
* but never touches the target, and `reset()` retires every request in flight the same way. While
|
|
524
|
+
* a page-zero or `replace` load is pending, `loadMore()` sends nothing: the rows on screen belong to
|
|
525
|
+
* the previous query. After `destroy()` nothing renders at all — a response that arrives
|
|
518
526
|
* afterwards is ignored, the loading state is left alone — and further loads reject.
|
|
519
527
|
*
|
|
520
528
|
* Validation is strict and the same for both bindings: a page must be a non-negative integer and a
|
|
@@ -261,7 +261,8 @@ export type ZeyosViewBinding = {
|
|
|
261
261
|
*/
|
|
262
262
|
setFilters: (filters: Record<string, unknown>) => Promise<ZeyosViewLoadResult>;
|
|
263
263
|
/**
|
|
264
|
-
* Loads the next page when available
|
|
264
|
+
* Loads the next page when available; sends
|
|
265
|
+
* nothing while a page-zero reload (a new search, filter, or sort) is still in flight.
|
|
265
266
|
*/
|
|
266
267
|
loadMore: () => Promise<ZeyosViewLoadResult>;
|
|
267
268
|
/**
|