@soxa-ui/setup 0.0.0-stage → 0.3.0-beta.1

package/dist/content/descriptors/components/stylable.descriptor.js

@@ -0,0 +1,52 @@
+import { defineComponent } from "../../../protected/define/component.js";
+import { defineDescriptor } from "../../../protected/define/descriptor.js";
+import { ComponentViewDescriptor } from "./component-view.descriptor.js";
+import { TStylable } from "@soxa-ui/core";
+//#region content/descriptors/components/stylable.descriptor.ts
+/**
+* Дескриптор Stylable (TStylable).
+*
+* Наследует ComponentViewDescriptor (rendered, visible, present, tag, classes, element, instance)
+* и добавляет size, variant.
+*/
+var StylableDescriptor = defineDescriptor(() => defineComponent({
+	ctor: TStylable,
+	extends: ComponentViewDescriptor(),
+	contribution: {
+		props: {
+			size: {
+				type: String,
+				triggers: ["change:size"]
+			},
+			variant: {
+				type: String,
+				triggers: ["change:variant"]
+			}
+		},
+		events: ["change:size", "change:variant"]
+	}
+}));
+/**
+* Размер и вид, снятые с разметки, — для того, кому их диктует владелец.
+*
+* У элемента коллекции значение `size` и `variant` всегда владельца, как
+* элемент ни наполняй (AGENTS.md, «`size` и `variant` элемента: владельца,
+* кроме варианта тега»). Вход разметки при этом обещал бы то, чего нет,
+* поэтому элементы подмешивают этот фрагмент: значение остаётся живым и
+* читаемым, задать его в разметке нельзя. Кроме тега: вариант у него свой, и
+* его дескриптор снимает только `size`.
+*
+* Переобъявлен один факт — `protected`. Тип и триггеры объявлены выше, в
+* `StylableDescriptor`, там и остаются: наследник пишет только то, что меняет
+* (см. `TComponentDescriptor`, «переобъявление пропа»).
+*
+* `as const satisfies`: с одной аннотацией `protected` вывелся бы `boolean`, и
+* вычитание защищённых имён из типа пропсов (`DescriptorProps`) их бы не
+* увидело — вход остался бы в типе, хотя в рантайме его уже нет.
+*/
+var OWNER_STYLE_PROPS = {
+	size: { protected: true },
+	variant: { protected: true }
+};
+//#endregion
+export { OWNER_STYLE_PROPS, StylableDescriptor };

package/dist/content/descriptors/components/switch.descriptor.d.ts

@@ -0,0 +1,217 @@
+/**
+ * Дескриптор Switch (TSwitch).
+ *
+ * Наследует InputControlDescriptor (readonly, required, value, name, disabled, focused, size, variant, ...),
+ * сужает value до булева и добавляет слоты ручки `on` и `off` + плагин InputBool.
+ */
+import { TSwitch } from '@soxa-ui/core';
+import type { ISwitch } from '@soxa-ui/core';
+export declare const SwitchDescriptor: () => import("../../..").IComponentDescriptor<import("../../../protected/define/inference.types").TContractFrom<{
+    readonly ctor: typeof TSwitch;
+    readonly extends: import("../../..").IComponentDescriptor<import("../../../protected/define/inference.types").TContractFrom<{
+        readonly ctor: typeof import("@soxa-ui/core").TInputControl;
+        readonly extends: import("../../..").IComponentDescriptor<import("../../../protected/define/inference.types").TContractFrom<{
+            readonly ctor: typeof import("@soxa-ui/core").TValueControl;
+            readonly extends: import("../../..").IComponentDescriptor<import("../../../protected/define/inference.types").TContractFrom<{
+                readonly ctor: typeof import("@soxa-ui/core").TControl;
+                readonly extends: import("../../..").IComponentDescriptor<import("../../../protected/define/inference.types").TContractFrom<{
+                    readonly ctor: typeof import("@soxa-ui/core").TStylable;
+                    readonly extends: import("../../..").IComponentDescriptor<import("../../../protected/define/inference.types").TContractFrom<{
+                        readonly ctor: typeof import("@soxa-ui/core").TComponentView;
+                        readonly extends: import("../../..").IComponentDescriptor<import("../../../protected/define/inference.types").TContractFrom<{
+                            readonly ctor: typeof import("@soxa-ui/core").TComponent;
+                            readonly extends: import("../../..").IComponentDescriptor<import("../../../protected/define/inference.types").TContractFrom<{
+                                readonly contribution: {
+                                    readonly props: {
+                                        readonly ctrl: {
+                                            readonly type: ObjectConstructor;
+                                        };
+                                        readonly embedded: {
+                                            readonly type: StringConstructor;
+                                        };
+                                        readonly pluginProps: {
+                                            readonly type: ObjectConstructor;
+                                        };
+                                    };
+                                    readonly events: readonly ["bundle:create", "plugin:event"];
+                                };
+                            }>>;
+                            readonly contribution: {};
+                        }>>;
+                        readonly contribution: {
+                            readonly slots: {
+                                readonly default: {
+                                    readonly description: "Содержимое компонента";
+                                };
+                            };
+                            readonly props: {
+                                readonly rendered: {
+                                    readonly type: BooleanConstructor;
+                                    readonly triggers: readonly ["change:rendered"];
+                                };
+                                readonly visible: {
+                                    readonly type: BooleanConstructor;
+                                    readonly triggers: readonly ["change:visible"];
+                                };
+                                readonly present: {
+                                    readonly type: BooleanConstructor;
+                                    readonly protected: true;
+                                    readonly triggers: readonly ["change:rendered", "change:visible"];
+                                };
+                                readonly tag: {
+                                    readonly type: readonly [StringConstructor, ObjectConstructor];
+                                    readonly triggers: readonly ["change:tag"];
+                                };
+                                readonly direction: {
+                                    readonly type: StringConstructor;
+                                    readonly triggers: readonly ["change:direction"];
+                                };
+                                readonly classes: {
+                                    readonly type: ObjectConstructor;
+                                    readonly protected: true;
+                                    readonly triggers: readonly ["change:classes"];
+                                };
+                                readonly aria: {
+                                    readonly type: ObjectConstructor;
+                                    readonly protected: true;
+                                    readonly triggers: readonly ["change:aria"];
+                                };
+                                readonly dataset: {
+                                    readonly type: ObjectConstructor;
+                                    readonly protected: true;
+                                    readonly triggers: readonly ["change:dataset"];
+                                };
+                                readonly attrs: {
+                                    readonly type: ObjectConstructor;
+                                    readonly protected: true;
+                                    readonly triggers: readonly ["change:attrs"];
+                                };
+                            };
+                            readonly events: readonly ["show", "hide", "show:before", "hide:before", "ready", "change:rendered", "change:visible", "change:tag", "change:direction"];
+                        };
+                        readonly plugins: readonly [import("../../..").IPluginDefinition<import("../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TElementPlugin, "element", {
+                            readonly events: readonly ["ready", "removed"];
+                        }>>, import("../../..").IPluginDefinition<import("../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TReadyPlugin, "ready", import("../../..").IContribution>>];
+                    }>>;
+                    readonly contribution: {
+                        readonly props: {
+                            readonly size: {
+                                readonly type: StringConstructor;
+                                readonly triggers: readonly ["change:size"];
+                            };
+                            readonly variant: {
+                                readonly type: StringConstructor;
+                                readonly triggers: readonly ["change:variant"];
+                            };
+                        };
+                        readonly events: readonly ["change:size", "change:variant"];
+                    };
+                }>>;
+                readonly contribution: {
+                    readonly props: {
+                        readonly disabled: {
+                            readonly type: BooleanConstructor;
+                            readonly triggers: readonly ["change:disabled"];
+                        };
+                        readonly focused: {
+                            readonly type: BooleanConstructor;
+                            readonly triggers: readonly ["change:focused"];
+                        };
+                    };
+                    readonly events: readonly ["change:disabled", "change:focused"];
+                };
+                readonly plugins: readonly [import("../../..").IPluginDefinition<import("../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TActionPlugin, "action", {
+                    readonly events: readonly ["press", "click", "focus", "blur"];
+                }>>, import("../../..").IPluginDefinition<import("../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TAriaPlugin, "aria", {
+                    readonly props: {
+                        readonly label: {
+                            readonly type: StringConstructor;
+                            readonly triggers: readonly ["change:label"];
+                        };
+                        readonly labelledBy: {
+                            readonly type: StringConstructor;
+                            readonly triggers: readonly ["change:labelledBy"];
+                        };
+                        readonly describedBy: {
+                            readonly type: StringConstructor;
+                            readonly triggers: readonly ["change:describedBy"];
+                        };
+                    };
+                    readonly events: readonly ["change:label", "change:labelledBy", "change:describedBy"];
+                }>>];
+            }>>;
+            readonly contribution: {
+                readonly props: {
+                    readonly value: {
+                        readonly type: readonly [StringConstructor, NumberConstructor, BooleanConstructor, ObjectConstructor, ArrayConstructor];
+                        readonly triggers: readonly ["change:value"];
+                    };
+                    readonly name: {
+                        readonly type: StringConstructor;
+                        readonly triggers: readonly ["change:name"];
+                    };
+                };
+                readonly events: readonly ["change:value", "change:name"];
+            };
+        }>>;
+        readonly contribution: {
+            readonly props: {
+                readonly readonly: {
+                    readonly type: BooleanConstructor;
+                    readonly triggers: readonly ["change:readonly"];
+                };
+                readonly required: {
+                    readonly type: BooleanConstructor;
+                    readonly triggers: readonly ["change:required"];
+                };
+            };
+            readonly events: readonly ["change:readonly", "change:required"];
+        };
+        readonly plugins: readonly [import("../../..").IPluginDefinition<import("../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TIdPlugin, undefined, {
+            readonly props: {
+                readonly id: {
+                    readonly type: StringConstructor;
+                    readonly triggers: readonly ["change:id"];
+                };
+            };
+            readonly events: readonly ["change:id"];
+        }>>];
+    }>>;
+    readonly contribution: {
+        /**
+         * Содержимое ручки по состоянию: рисуется один из двух слотов.
+         * Дорожка вокруг них остаётся за компонентом: она уносит содержимое
+         * из доступного имени, которое переключателю даёт подпись.
+         */
+        readonly slots: {
+            readonly on: {
+                readonly scope: {
+                    readonly value: import("../../..").TPropType<boolean | undefined>;
+                    readonly ctrl: import("../../..").TPropType<ISwitch>;
+                };
+                readonly description: "Содержимое ручки включённого переключателя";
+            };
+            readonly off: {
+                readonly scope: {
+                    readonly value: import("../../..").TPropType<boolean | undefined>;
+                    readonly ctrl: import("../../..").TPropType<ISwitch>;
+                };
+                readonly description: "Содержимое ручки выключенного переключателя";
+            };
+        };
+        readonly props: {
+            /**
+             * Значение переобъявлено типом: включён или нет, как у ядра. Тип
+             * полей (ValueControl) начинается со строки, и с ним атрибут
+             * `value` без значения оставался пустой строкой, а не включал
+             * переключатель. Триггер остаётся у ValueControl.
+             */
+            readonly value: {
+                readonly type: BooleanConstructor;
+            };
+        };
+    };
+    readonly plugins: readonly [import("../../..").IPluginDefinition<import("../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TActionPlugin, "action", {
+        readonly events: readonly ["press", "click", "focus", "blur"];
+    }>>, import("../../..").IPluginDefinition<import("../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TInputBoolPlugin, "input-bool", import("../../..").IContribution>>];
+}>>;

package/dist/content/descriptors/components/switch.descriptor.js

@@ -0,0 +1,53 @@
+import { defineComponent } from "../../../protected/define/component.js";
+import { defineDescriptor } from "../../../protected/define/descriptor.js";
+import { defineType } from "../../../protected/define/prop-type.js";
+import { ActionPluginDescriptor } from "../plugins/action.plugin.js";
+import { InputBoolPluginDescriptor } from "../plugins/input-bool.plugin.js";
+import { InputControlDescriptor } from "./input-control.descriptor.js";
+import { TSwitch } from "@soxa-ui/core";
+import { fieldOf } from "@soxa-ui/plugins";
+//#region content/descriptors/components/switch.descriptor.ts
+/**
+* Дескриптор Switch (TSwitch).
+*
+* Наследует InputControlDescriptor (readonly, required, value, name, disabled, focused, size, variant, ...),
+* сужает value до булева и добавляет слоты ручки `on` и `off` + плагин InputBool.
+*/
+var SwitchDescriptor = defineDescriptor(() => defineComponent({
+	ctor: TSwitch,
+	extends: InputControlDescriptor(),
+	contribution: {
+		/**
+		* Содержимое ручки по состоянию: рисуется один из двух слотов.
+		* Дорожка вокруг них остаётся за компонентом: она уносит содержимое
+		* из доступного имени, которое переключателю даёт подпись.
+		*/
+		slots: {
+			on: {
+				scope: {
+					value: defineType(Boolean),
+					ctrl: defineType(Object)
+				},
+				description: "Содержимое ручки включённого переключателя"
+			},
+			off: {
+				scope: {
+					value: defineType(Boolean),
+					ctrl: defineType(Object)
+				},
+				description: "Содержимое ручки выключенного переключателя"
+			}
+		},
+		props: { 
+		/**
+		* Значение переобъявлено типом: включён или нет, как у ядра. Тип
+		* полей (ValueControl) начинается со строки, и с ним атрибут
+		* `value` без значения оставался пустой строкой, а не включал
+		* переключатель. Триггер остаётся у ValueControl.
+		*/
+value: { type: Boolean } }
+	},
+	plugins: [ActionPluginDescriptor.with({ focusTarget: fieldOf }), InputBoolPluginDescriptor]
+}));
+//#endregion
+export { SwitchDescriptor };

package/dist/content/descriptors/components/table/collection.descriptor.d.ts

@@ -0,0 +1,183 @@
+/**
+ * Дескрипторы коллекционной части Table — фасады таблицы и строки.
+ *
+ * Членство в коллекции отделено от собственных пропсов компонента
+ * (`TableDescriptor`, `TableRowDescriptor`): адаптер собирает компонент из
+ * обоих рантайм-списков.
+ */
+import { TTableCollectionFacade, TTableRowCollectionFacade } from '@soxa-ui/core';
+export declare const TableCollectionDescriptor: () => import("../../../..").IComponentDescriptor<import("../../../../protected/define/inference.types").TContractFrom<{
+    readonly ctor: typeof TTableCollectionFacade;
+    readonly extends: import("../../../..").IComponentDescriptor<import("../../../../protected/define/inference.types").TContractFrom<{
+        readonly contribution: {
+            readonly props: {
+                readonly engine: {
+                    readonly type: ObjectConstructor;
+                };
+                readonly items: {
+                    readonly type: ArrayConstructor;
+                    readonly triggers: readonly ["change:items"];
+                };
+                readonly shown: {
+                    readonly type: ArrayConstructor;
+                    readonly protected: true;
+                    readonly triggers: readonly ["change:shown"];
+                };
+                readonly trackBy: {
+                    readonly type: FunctionConstructor;
+                    readonly triggers: readonly ["change:trackBy"];
+                };
+            };
+            readonly events: readonly ["engine:create", "item:add:before", "item:added", "item:remove:before", "item:removed", "item:update:before", "item:updated", "item:move:before", "item:moved", "items:clear:before", "change:count", "reset", "items:added", "items:removed", "change:shown", "change:items", "change:trackBy"];
+        };
+    }>>;
+    /**
+     * Коллекционные props таблицы — то, что выводит фасад
+     * `TTableCollectionFacade`: режим выбора строк, колонки данными,
+     * сортировка и режим сетки; выходы — колонки, выбор, набор ячейки
+     * выбора и строки шапки и что рисует тело; события — ширина и место,
+     * которые пользователь задал колонке. Окно — не проп: его ставит обёртка
+     * `Virtual`.
+     */
+    readonly contribution: {
+        readonly props: {
+            /** Режим выбора строк. `none` (по умолчанию) — колонки выбора нет */
+            readonly mode: {
+                readonly type: StringConstructor;
+                readonly triggers: readonly ["change:mode"];
+            };
+            /**
+             * Колонки данными: сверка по `field`. Читаются экземпляры колонок,
+             * пишутся данные — как `items` у строк
+             */
+            readonly columns: {
+                readonly type: ArrayConstructor;
+                readonly triggers: readonly ["change:shownColumns"];
+            };
+            readonly sort: {
+                readonly type: ArrayConstructor;
+                readonly triggers: readonly ["change:sort"];
+            };
+            readonly sortMode: {
+                readonly type: StringConstructor;
+                readonly triggers: readonly ["change:sortMode"];
+            };
+            readonly presorted: {
+                readonly type: BooleanConstructor;
+                readonly triggers: readonly ["change:presorted"];
+            };
+            /**
+             * Режим сетки (APG Data Grid): одна остановка Tab, стрелки по
+             * ячейкам, строку выбирают нажатием и пробелом
+             */
+            readonly grid: {
+                readonly type: BooleanConstructor;
+                readonly triggers: readonly ["change:grid"];
+            };
+            /**
+             * Что рисует тело по порядку: строки на своих местах и, в окне,
+             * распорки на месте пропущенных. Без окна — все показанные строки
+             */
+            readonly drawn: {
+                readonly type: ArrayConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:drawn"];
+            };
+            /** Набор строки шапки — у неё нет экземпляра. В окне — её номер */
+            readonly headRowAria: {
+                readonly type: ObjectConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:headRowAria"];
+            };
+            /**
+             * Набор ячейки колонки выбора в шапке — у неё нет экземпляра. В сетке
+             * ячейка принимает фокус, вне сетки набор пуст.
+             */
+            readonly cellAria: {
+                readonly type: ObjectConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:cellAria"];
+            };
+            readonly selected: {
+                readonly type: ArrayConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:selection"];
+            };
+            /** Заголовки шапки — по одному на показанную колонку, в её порядке */
+            readonly shownColumns: {
+                readonly type: ArrayConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:shownColumns"];
+            };
+            readonly shownSelection: {
+                readonly type: StringConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:shownSelection"];
+            };
+            /**
+             * Сколько колонок в строке вместе с колонкой выбора — `colspan`
+             * ячейки пустой таблицы. Посчитанное в разметке повторилось бы в
+             * каждом адаптере.
+             */
+            readonly columnCount: {
+                readonly type: NumberConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:shownColumns", "change:selecting"];
+            };
+        };
+        /**
+         * Пользователь задал ширину колонки ручкой — одно событие на действие,
+         * с колонкой и итогом её ширины; переставил колонку — одно событие на
+         * действие, с колонкой и новым порядком полей. По ним приложение
+         * сохраняет настройку.
+         */
+        readonly events: readonly ["column:resize", "column:move", "change:mode", "change:shownColumns", "change:sort", "change:sortMode", "change:presorted", "change:grid", "change:selection", "change:shownSelection"];
+    };
+}>>;
+export declare const TableCollectionRowDescriptor: () => import("../../../..").IComponentDescriptor<import("../../../../protected/define/inference.types").TContractFrom<{
+    readonly ctor: typeof TTableRowCollectionFacade;
+    /**
+     * Item-level пропсы строки — то, что выводит фасад
+     * `TTableRowCollectionFacade`: выбор, ячейки, имя строки, включён ли
+     * выбор строк и набор ячеек сетки.
+     */
+    readonly contribution: {
+        readonly props: {
+            readonly selected: {
+                readonly type: BooleanConstructor;
+                readonly triggers: readonly ["change:selected"];
+            };
+            /** Ячейки — по одной на показанную колонку, в её порядке */
+            readonly cells: {
+                readonly type: ArrayConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:cells"];
+            };
+            /**
+             * `id` заголовка строки — им называют чекбокс выбора строки. Пока
+             * колонки заголовка нет или она скрыта, ссылки нет.
+             */
+            readonly rowHeaderId: {
+                readonly type: StringConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:cells"];
+            };
+            /** Выбор строк включён — у строки ячейка выбора */
+            readonly selecting: {
+                readonly type: BooleanConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:selecting"];
+            };
+            /**
+             * Набор каждой ячейки строки, и ячейки выбора тоже: у ячеек нет
+             * экземпляра. В сетке ячейка принимает фокус, вне сетки набор пуст.
+             */
+            readonly cellAria: {
+                readonly type: ObjectConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:cellAria"];
+            };
+        };
+        readonly events: readonly ["change:selected"];
+    };
+}>>;