@koobiq/components 20.4.1 → 21.0.0

package/schematics/migrations/form-field-signals/schema.json

@@ -0,0 +1,20 @@
+{
+    "$schema": "http://json-schema.org/schema",
+    "$id": "koobiq-components-form-field-signals",
+    "title": "Koobiq components form field signals migration",
+    "type": "object",
+    "properties": {
+        "project": {
+            "type": "string",
+            "description": "Name of the project to migrate. If omitted, the migration runs over the whole tree.",
+            "$default": {
+                "$source": "projectName"
+            }
+        },
+        "fix": {
+            "type": "boolean",
+            "default": true,
+            "description": "When true, applies all auto-fix replacements. When false, prints what would change without writing."
+        }
+    }
+}

package/schematics/migrations/icon-semantics-and-api/README.md

@@ -0,0 +1,65 @@
+# icon-semantics-and-api
+
+Migration schematic invoked automatically by `ng update @koobiq/components@21`
+(registered for `21.0.0-0`). Reports the icon call sites the review reaches. It never writes to the
+tree.
+
+## Background
+
+The review gave the three components the semantics they never had, and closed the members that only
+recorded an internal decision.
+
+| Change                                | Before                    | After                                                    |
+| ------------------------------------- | ------------------------- | -------------------------------------------------------- |
+| `<i kbq-icon>`, `<i kbq-icon-item>`   | in the accessibility tree | `aria-hidden="true"` by default                          |
+| `kbq-icon-button` on a non-`<button>` | focusable, no semantics   | `role="button"`, `aria-disabled`; no keyboard activation |
+| `KbqIcon.small`                       | published input           | removed                                                  |
+| `KbqIcon.name`                        | `'KbqIcon'` string        | `appliesMaxHeight` boolean                               |
+| `KbqIconButton.tabindex`              | `any`                     | `number \| null`                                         |
+| `iconName`                            | `string`                  | `string \| undefined`                                    |
+
+`aria-hidden` deserves a note. An icon carries no text, and in nearly every place the library and its
+consumers use one it repeats a label that is already in the button, the link or the row beside it —
+so hidden is the right default and the hand-written `aria-hidden="true"` attributes on icons became
+redundant. An icon that is the only carrier of its meaning has to say so:
+
+```html
+<i kbq-icon="kbq-triangle-exclamation_16" role="img" aria-hidden="false" aria-label="Error"></i>
+```
+
+## What it does _not_ do
+
+Nothing is rewritten. Whether an icon is decorative and what an icon button should be called are both
+decisions the schematic cannot make. `small` on an icon button is rewritten to `size` by `v21-upgrade`,
+which also reports the uses it leaves, so this migration does not report it.
+
+| Pattern                                            | Manual migration                                                    |
+| -------------------------------------------------- | ------------------------------------------------------------------- |
+| `small` on a `[kbq-icon]` or a `[kbq-icon-item]`   | Drop it — nothing ever read it                                      |
+| `(click)` and no `(keydown…)` on a non-button host | Bind `(keydown.enter)` and `(keydown.space)`, or use a `<button>`   |
+| `tabindex` on an icon button, or written in code   | Pass a number (a numeric string is still transformed in a template) |
+| `override name` in a `KbqIcon` subclass            | Override the protected `appliesMaxHeight` instead                   |
+
+## Notes with no call site to point at
+
+- The SVG resolution no longer stops on the first name that does not resolve — which the documented
+  font-icon default guarantees on the very first frame. A stale `<svg>` is removed on the fallback
+  path and the inline `max-height` is cleared as well as set, so an element whose `[kbq-icon]` changes
+  renders the icon it was asked for at the size it was asked for.
+- `autoColor` takes effect when it is turned on after init and lets go of the error color when it is
+  turned off.
+- The `--kbq-icon-*-color` tokens are no longer declared on `.kbq-icon`; they are consumed with their
+  design token as the `var()` fallback, so a container can re-theme the icons inside it. A declaration
+  on `.kbq-icon` sat on the element the value is used on and beat everything inherited. Reading one
+  back with `getComputedStyle` now returns an empty string.
+- `KbqIconRegistry` looks sprite symbols up by id rather than through a `'#' + name` selector that a
+  name starting with a digit made invalid.
+- `kbqIconsDictProvider` maps names to URLs. Its `<`-prefixed inline branch is passed through
+  Angular's HTML sanitizer, which drops `<svg>` wholesale; register inline icons through
+  `KbqIconRegistry.addSvgIconLiteral()` with `bypassSecurityTrustHtml` instead.
+
+## Running it manually
+
+```bash
+ng g @koobiq/components:icon-semantics-and-api --project "<your project>"
+```

package/schematics/migrations/icon-semantics-and-api/data.js

@@ -0,0 +1,97 @@
+'use strict';
+
+var tagPatterns = require('../../tag-patterns-CNbEB0iT.js');
+
+/**
+ * Data for the `icon-semantics-and-api` migration.
+ *
+ * The icon review gave the three components the semantics they never had and closed the members that
+ * only documented an internal decision:
+ *
+ * - `<i kbq-icon>` renders `aria-hidden="true"` by default. A meaningful icon opts out with
+ *   `aria-hidden="false"` and then supplies its own `role="img"` and `aria-label`.
+ * - `kbq-icon-button` on anything but a native `<button>` gets `role="button"` and `aria-disabled`, and
+ *   warns in dev mode when it has no accessible name. It does not activate itself from the keyboard.
+ * - `KbqIcon.small` is removed — it was published but read by nothing.
+ * - `KbqIcon.name`, the string that stood in for an `instanceof`, is replaced by the protected
+ *   `appliesMaxHeight` flag.
+ * - `KbqIconButton.tabindex` is `number | null` instead of `any`, and `iconName` is `string | undefined`.
+ *
+ * Warn-only. Whether an icon is decorative and what an icon button should be called are both decisions
+ * the schematic cannot make. `small` on an icon button is `v21-upgrade`'s: it rewrites it to `size`.
+ */
+/** Import specifier that marks a file as an icon consumer. */
+const ICON_PACKAGE = '@koobiq/components/icon';
+/** Identifier and attribute shapes that mark a consumer without an import. */
+const ICON_TYPE = String.raw `\bKbqIcon\w*\b|\bkbq-icon(?:-button|-item)?\b`;
+const ICON_OR_ITEM_ATTRIBUTE = String.raw `[\s\[]kbq-icon(?:-item)?(?![\w-])`;
+const ICON_BUTTON_ATTRIBUTE = String.raw `[\s\[]kbq-icon-button(?![\w-])`;
+/** An opening tag that carries `attribute`, read up to the point the rest of the pattern continues from. */
+const tagWith = (attribute) => String.raw `<[a-zA-Z][\w-]*(?=${tagPatterns.TAG_BODY}*${attribute})${tagPatterns.TAG_BODY}*`;
+const warnPatterns = [
+    {
+        // A plain icon or an icon item only: `small` on an icon button is rewritten by `v21-upgrade`.
+        anchor: ICON_OR_ITEM_ATTRIBUTE,
+        pattern: String.raw `${tagWith(ICON_OR_ITEM_ATTRIBUTE)}[\s\[]small[\]\s=/>]`,
+        message: 'KbqIcon.small was removed, and with it the input KbqIconItem inherited. It was published but read ' +
+            'by nothing — not by the host block, not by icon.scss, not by _icon-theme.scss — so dropping the ' +
+            'binding from a [kbq-icon] or a [kbq-icon-item] changes nothing.'
+    },
+    {
+        // A host the browser does not activate from the keyboard on its own: not a <button>, an <input> or an <a>.
+        anchor: ICON_BUTTON_ATTRIBUTE,
+        pattern: String.raw `<(?!(?:button|input|a)(?![\w-]))[a-zA-Z][\w-]*(?=${tagPatterns.TAG_BODY}*${ICON_BUTTON_ATTRIBUTE})` +
+            String.raw `(?=${tagPatterns.TAG_BODY}*\s\(click\))(?!${tagPatterns.TAG_BODY}*\s\(keydown)`,
+        message: 'kbq-icon-button on a host that is not a native <button> is announced as a button now — ' +
+            'role="button" and aria-disabled — but it does not activate itself from Enter or Space, and this ' +
+            'one handles (click) only. Bind (keydown.enter) and (keydown.space) to the same handler, calling ' +
+            'preventDefault() on Space so the page does not scroll, or put the icon button on a <button>.'
+    },
+    {
+        anchor: ICON_BUTTON_ATTRIBUTE,
+        pattern: String.raw `${tagWith(ICON_BUTTON_ATTRIBUTE)}[\s\[]tabindex[\]\s=/>]`,
+        message: 'KbqIconButton.tabindex is number | null instead of any. A template binding still takes a number ' +
+            'or a numeric string, but a value that does not parse as a number renders no tabindex instead of ' +
+            'tabindex="NaN".'
+    },
+    {
+        anchor: String.raw `\bKbqIconButton\b`,
+        pattern: String.raw `\.tabindex\s*=(?!=)`,
+        message: 'KbqIconButton.tabindex is number | null instead of any: code that writes anything else to it no ' +
+            'longer type-checks.'
+    },
+    {
+        anchor: String.raw `\bKbqIcon\w*\b`,
+        // Only the `override` form. `.name` is far too common a property — `file.name`, `error.name`,
+        // `control.name` — and the anchor is any KbqIcon identifier in the file, so matching a bare
+        // member access reported the marker for code that never had anything to do with it.
+        pattern: String.raw `\boverride\s+name\s*(?:=(?!=)|[:;])`,
+        message: 'KbqIcon.name — the protected string that stood in for an instanceof and decided whether the ' +
+            'inline max-height is written — is replaced by the protected `appliesMaxHeight` boolean, which ' +
+            'a subclass overrides. Nothing outside the hierarchy could read it.'
+    }
+];
+/** Printed once per project, after the per-file reports. */
+const SUMMARY = [
+    '  <i kbq-icon> and <i kbq-icon-item> are aria-hidden="true" by default. That is right where the icon ' +
+        'repeats a label that is already there; an icon that carries meaning on its own needs ' +
+        'aria-hidden="false" plus role="img" and an aria-label. kbq-icon-button is not hidden by default.',
+    '  kbq-icon-button warns in dev mode when it has neither aria-label nor aria-labelledby: it renders ' +
+        'a glyph and has no accessible name at all without one (AXE button-name). On a host that is not a ' +
+        'native <button> it adds role="button" and aria-disabled, and leaves Enter and Space to the consumer.',
+    '  The --kbq-icon-*-color tokens are no longer declared on .kbq-icon. They are consumed with their ' +
+        'design token as the var() fallback instead, so a container can finally re-theme the icons inside ' +
+        'it — a declaration on .kbq-icon sat on the element the value is used on and beat everything ' +
+        'inherited. Reading one back with getComputedStyle now returns an empty string.',
+    '  The SVG resolution no longer dies on the first name that does not resolve, which the default ' +
+        'font-icon setup guarantees. A stale <svg> is removed on the fallback path and the inline ' +
+        'max-height is cleared as well as set, so an element whose [kbq-icon] changes renders the icon it ' +
+        'was asked for.',
+    '  KbqIconRegistry looks sprite symbols up by id rather than through a "#" + name selector that a ' +
+        'name starting with a digit made invalid.'
+];
+
+exports.ICON_PACKAGE = ICON_PACKAGE;
+exports.ICON_TYPE = ICON_TYPE;
+exports.SUMMARY = SUMMARY;
+exports.warnPatterns = warnPatterns;

package/schematics/migrations/icon-semantics-and-api/index.js

@@ -0,0 +1,64 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var utils_messages = require('../../utils/messages.js');
+var utils_packageConfig = require('../../package-config-BhU2TfC8.js');
+var migrations_iconSemanticsAndApi_data = require('./data.js');
+require('@angular-devkit/schematics');
+require('@schematics/angular/utility');
+require('../../tag-patterns-CNbEB0iT.js');
+
+const LABEL = '[icon-semantics-and-api]';
+const EXTENSIONS = ['.ts', '.html'];
+// Compiled once rather than per file. None carries the `g` flag, so a shared instance holds no `lastIndex`.
+const ICON_TYPE_REGEX = new RegExp(migrations_iconSemanticsAndApi_data.ICON_TYPE);
+const COMPILED_WARN_PATTERNS = migrations_iconSemanticsAndApi_data.warnPatterns.map(({ anchor, pattern, message }) => ({
+    anchor: new RegExp(anchor),
+    pattern: new RegExp(pattern),
+    message
+}));
+/** A file is an icon consumer if it imports the package, names a component, or renders one. */
+function referencesIcon(content) {
+    return content.includes(migrations_iconSemanticsAndApi_data.ICON_PACKAGE) || ICON_TYPE_REGEX.test(content);
+}
+/**
+ * Reports the icon call sites the review reaches: the removed `KbqIcon.small`, the icon buttons on a host
+ * that is not a native `<button>` that handle a click but no key, the retyped `tabindex` and the replaced
+ * `name` marker. Never writes: whether an icon is decorative and what an icon button is called are both
+ * decisions.
+ */
+function iconSemanticsAndApi(options) {
+    return async (tree, context) => {
+        const { project } = options;
+        const projectDefinition = await utils_packageConfig.setupOptions(project, tree);
+        const root = projectDefinition?.root ?? '';
+        const rootDir = root ? tree.getDir(root) : tree.root;
+        let consumers = 0;
+        let reported = 0;
+        utils_packageConfig.visitProjectFiles(rootDir, (filePath, entry) => {
+            if (!EXTENSIONS.some((extension) => filePath.endsWith(extension)))
+                return;
+            const content = entry.content.toString();
+            if (!content || !referencesIcon(content))
+                return;
+            consumers++;
+            for (const { anchor, pattern, message } of COMPILED_WARN_PATTERNS) {
+                if (!anchor.test(content) || !pattern.test(content))
+                    continue;
+                reported++;
+                utils_messages.logMessage(context.logger, [`${LABEL} ${filePath}`, `  ${message}`]);
+            }
+        });
+        // Nothing here renders an icon, so the summary would only be noise.
+        if (consumers === 0)
+            return;
+        utils_messages.logMessage(context.logger, [
+            `${LABEL} processed icons under "${root || '<workspace root>'}", ` +
+                `${consumers} file(s) reference the component, ${reported} call site(s) reported.`,
+            ...migrations_iconSemanticsAndApi_data.SUMMARY
+        ]);
+    };
+}
+
+exports.default = iconSemanticsAndApi;

package/schematics/migrations/icon-semantics-and-api/schema.json

@@ -0,0 +1,15 @@
+{
+    "$schema": "http://json-schema.org/schema",
+    "$id": "koobiq-components-icon-semantics-and-api",
+    "title": "Koobiq components icon review migration",
+    "type": "object",
+    "properties": {
+        "project": {
+            "type": "string",
+            "description": "Name of the project to inspect. If omitted, the migration runs over the whole tree.",
+            "$default": {
+                "$source": "projectName"
+            }
+        }
+    }
+}

package/schematics/migrations/icons-replacement/README.md

@@ -11,31 +11,31 @@ This schematic provides migration for new icons naming attribute. It includes:
 Apply for project and log file path and icon name should be replaced
 
 ```shell
-ng g @koobiq/components:icons-replacement --project <your project>
+ng g @koobiq/components:icons-replacement --project "<your project>"
 ```
 
 - with custom icon replacement mapping:
 
 ```shell
-ng g @koobiq/components:icons-replacement --project <your project> --replacement-data-path <path-as-json>
+ng g @koobiq/components:icons-replacement --project "<your project>" --replacement-data-path "<path-as-json>"
 ```
 
 Apply for project and replace icon name.
 
 ```shell
-ng g @koobiq/components:icons-replacement --project <your project>  --fix=true
+ng g @koobiq/components:icons-replacement --project "<your project>" --fix=true
 ```
 
 #### Usage for Nx:
 
 ```shell
-nx g @koobiq/components:icons-replacement --project <your project>
+nx g @koobiq/components:icons-replacement --project "<your project>"
 ```
 
 - with custom icon replacement mapping:
 
 ```shell
-nx g @koobiq/components:icons-replacement --project <your project> --replacement-data-path <path-as-json>
+nx g @koobiq/components:icons-replacement --project "<your project>" --replacement-data-path "<path-as-json>"
 ```
 
 ### Run locally

package/schematics/migrations/icons-replacement/index.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var path = require('path');
 var utils_messages = require('../../utils/messages.js');
-var utils_packageConfig = require('../../utils/package-config.js');
+var utils_packageConfig = require('../../package-config-BhU2TfC8.js');
 var migrations_iconsReplacement_data = require('./data.js');
 require('@angular-devkit/schematics');
 require('@schematics/angular/utility');

package/schematics/migrations/inline-edit-a11y-and-types/README.md

@@ -0,0 +1,82 @@
+# inline-edit-a11y-and-types
+
+Migration schematic invoked automatically by `ng update @koobiq/components@20`
+(registered for `21.0.0-0`). Reports what the inline-edit review broke, and rewrites the one change
+that has a single mechanical translation: `modeAsReadonly` → `mode`.
+
+## Background
+
+The edit overlay used to render two `<div class="cdk-visually-hidden" aria-hidden="true" tabindex="0">`
+sentinels around its panel to detect a Tab out of the editor. That is an axe `aria-hidden-focus`
+failure and two live tab stops that announce nothing, so the sentinels — and the
+`KbqFocusRegionItem` directive behind them — are gone; the boundary is resolved against the panel's
+own first and last tabbable control.
+
+The widget semantics moved with them. The host carried a `tabindex` and no ARIA at all, so a
+`<kbq-inline-edit>` was an unknown element that happened to be focusable. `role="button"`,
+`aria-expanded`, `aria-disabled` and the accessible name now live on
+`.kbq-inline-edit__view-content`, and on `.kbq-inline-edit__focus-anchor` while the view content is
+interactive — putting them on the host would nest the `kbqInlineEditMenu` button inside a widget role.
+
+`mode` moved in the same pass. It was a `protected signal()` fronted by a public `modeAsReadonly`
+`computed()`, with an explicit `modeChange` output fed by a hand-written `toObservable` subscription.
+All three are one `model()` now, which generates an output of the same name and the same type — so
+`(modeChange)` bindings are untouched — and makes the mode writable: `[(mode)]` opens and closes the
+editor programmatically. The alias had no purpose left and was removed.
+
+| Member                       | Before                       | After                               |
+| ---------------------------- | ---------------------------- | ----------------------------------- |
+| `KbqFocusRegionItem`         | exported directive           | removed                             |
+| `mode`                       | `protected WritableSignal`   | public `ModelSignal`                |
+| `modeAsReadonly`             | public `Signal`              | removed — use `mode`                |
+| `modeChange`                 | explicit `output()`          | generated by the `mode` model       |
+| `setValueHandler`            | `(value: any) => void`       | `(value: unknown) => void`          |
+| `validationTooltip`          | `string \| TemplateRef<any>` | `string \| TemplateRef<unknown>`    |
+| `saved`, `canceled`          | `protected`                  | public                              |
+| `KbqA11yLocaleConfiguration` | 15 keys                      | plus the required `edit`            |
+| host `tabindex` / `role`     | on `<kbq-inline-edit>`       | on `.kbq-inline-edit__view-content` |
+
+## What it rewrites
+
+`.modeAsReadonly` → `.mode`, in `.ts` and `.html`, in files that name the inline edit. The alias was a
+`computed()` wrapper over the mode signal, so the read translates unchanged. Matched as a property
+access: a bare identifier of the same name belongs to the host. Pass `--fix=false` to see what would
+change without writing.
+
+An index read (`edit['modeAsReadonly']`) or a destructuring is reported instead of rewritten.
+
+## What it does _not_ do
+
+Nothing else is rewritten. A removed export has no replacement expression, a narrowed handler parameter
+needs a cast only the host can choose, and a selector that matched the host by `tabindex` or `:focus`
+is a decision about which element it actually meant.
+
+| Pattern                                     | Manual migration                                                           |
+| ------------------------------------------- | -------------------------------------------------------------------------- |
+| `kbqFocusRegionItem` / `KbqFocusRegionItem` | Drop it — the Tab boundary is detected on the panel                        |
+| `[setValueHandler]` handler                 | Widen the parameter to `unknown` and narrow inside                         |
+| `KbqA11yLocaleConfiguration` literal        | Add the `edit` key, or switch to a partial override provider               |
+| `.kbq-inline-edit[tabindex]` / `:focus`     | Target `.kbq-inline-edit__view-content` / `.kbq-inline-edit__focus-anchor` |
+| `edit.modeChange.subscribe(...)`            | `toObservable(edit.mode)` — the output is the model's, not a class member  |
+
+## Notes with no call site to point at
+
+- The view mode is announced as a `button` with `aria-expanded`. Its name comes from the new `edit`
+  a11y locale key, or from an `aria-label` on the component — which is read as an input, so a
+  hand-rolled `aria-label` on the host is no longer just an attribute.
+- `saved` and `canceled` are public, so a `viewChild(KbqInlineEdit)` can subscribe to them.
+- `modeChange` now emits synchronously on the write, rather than one microtask later — the old
+  `toObservable(...).pipe(skip(1))` relay is gone. A test that awaited that gap can drop the wait.
+- `save()` marks the projected controls touched itself and gates on the control's validity rather than
+  on the `ErrorStateMatcher` verdict. Typing no longer flips a pristine `required` field into its error
+  look, and `commit()` on a never-touched invalid control keeps the editor open instead of writing the
+  value through — a workaround directive that reset `touched` on the first input can be deleted.
+- The panel shadow reads `--kbq-inline-edit-panel-shadow`, the token the panel used to declare and then
+  bypass, so setting it now changes the shadow. The private `.kbq-mask`, `.kbq-mask__fade` and
+  `.kbq-mask__container` classes were renamed to their `.kbq-inline-edit__menu-mask*` equivalents.
+
+## Running it manually
+
+```
+ng generate @koobiq/components:inline-edit-a11y-and-types --project my-app
+```

package/schematics/migrations/inline-edit-a11y-and-types/data.js

@@ -0,0 +1,117 @@
+'use strict';
+
+/**
+ * Data for the `inline-edit-a11y-and-types` migration.
+ *
+ * The inline-edit review moved the widget semantics off the host and closed the surface that only
+ * existed to serve the overlay:
+ *
+ * - `KbqFocusRegionItem` — removed. It existed to give the edit overlay two `aria-hidden` tab stops,
+ *   which is an `aria-hidden-focus` failure; the Tab boundary is detected on the panel now.
+ * - `setValueHandler` — `(value: any) => void` → `(value: unknown) => void`, and `validationTooltip`
+ *   accepts `TemplateRef<unknown>` instead of `TemplateRef<any>`.
+ * - `KbqA11yLocaleConfiguration` — gained a required `edit` key, the accessible name of the control
+ *   that opens the editor.
+ * - The host is no longer the tab stop: `role`, `tabindex` and the ARIA state live on
+ *   `.kbq-inline-edit__view-content` (or on `.kbq-inline-edit__focus-anchor` when the view content is
+ *   interactive).
+ * - `mode` — a `model()` now, so it is public, writable and two-way bindable. The `modeAsReadonly`
+ *   alias that existed only to expose the hidden `protected mode` is gone, and the explicit
+ *   `modeChange` output is generated by the model under the same name.
+ *
+ * Everything is warn-only except the `modeAsReadonly` → `mode` rename: a removed export has no
+ * replacement expression, a narrowed handler parameter needs a cast the component cannot choose, and a
+ * selector that targeted the host is a decision about which element the host actually meant. The rename
+ * is the one change with a single mechanical translation.
+ */
+/** Import specifier that marks a file as an inline-edit consumer. */
+const INLINE_EDIT_PACKAGE = '@koobiq/components/inline-edit';
+/** Identifier and attribute shapes that mark a consumer without an import. */
+const INLINE_EDIT_TYPE = '\\bKbqInlineEdit\\w*\\b|\\bkbqInlineEdit\\w*\\b|\\bkbq-inline-edit\\b';
+/** Anchor for the locale change, which reaches hosts that never name the inline edit. */
+const A11Y_LOCALE_TYPE = '\\bKbqA11yLocaleConfiguration\\b|\\bkbqA11yLocaleConfigurationProvider\\s*\\(';
+/**
+ * The one auto-fix: `modeAsReadonly` was a `computed()` wrapper whose only job was to expose the
+ * `protected mode` signal for reading, so a read of it translates to a read of `mode` unchanged.
+ * Matched as a property access — a bare identifier of the same name belongs to the host, not to us.
+ */
+const MODE_AS_READONLY_ACCESS = /\.modeAsReadonly\b/g;
+/** What {@link MODE_AS_READONLY_ACCESS} is replaced with. */
+const MODE_AS_READONLY_REPLACEMENT = '.mode';
+/** Cheap pre-check so a file without the member is never scanned. */
+const MODE_AS_READONLY_MEMBER = 'modeAsReadonly';
+const warnPatterns = [
+    {
+        anchor: `${INLINE_EDIT_TYPE}|KbqFocusRegionItem`,
+        pattern: '\\bKbqFocusRegionItem\\b|\\bkbqFocusRegionItem\\b',
+        message: 'KbqFocusRegionItem was removed. It marked the two `aria-hidden="true" tabindex="0"` sentinels ' +
+            'the edit overlay rendered around its panel — an axe `aria-hidden-focus` failure and two dead-end ' +
+            'tab stops. The Tab boundary is resolved on the panel itself now, so the directive has no ' +
+            'replacement: drop the import and the attribute.'
+    },
+    {
+        anchor: INLINE_EDIT_TYPE,
+        pattern: '\\bsetValueHandler\\b',
+        message: 'KbqInlineEdit.setValueHandler takes `(value: unknown) => void` instead of `(value: any) => void`. ' +
+            'A handler typed against the concrete value no longer assigns — widen the parameter to `unknown` ' +
+            'and narrow inside, which is what the component always handed over.'
+    },
+    {
+        anchor: A11Y_LOCALE_TYPE,
+        pattern: A11Y_LOCALE_TYPE,
+        message: 'KbqA11yLocaleConfiguration gained a required `edit` key — the accessible name of the control ' +
+            'that opens an inline edit. A complete configuration object has to supply it; a partial override ' +
+            'through kbqA11yLocaleConfigurationProvider() does not.'
+    },
+    {
+        anchor: INLINE_EDIT_TYPE,
+        pattern: '\\[\\s*[\'"`]modeAsReadonly[\'"`]\\s*\\]|\\{[^{}]*\\bmodeAsReadonly\\b[^{}]*\\}\\s*=',
+        message: 'KbqInlineEdit.modeAsReadonly is `mode` now, but this read is not a property access — an index ' +
+            'signature or a destructuring — so it was left untouched. Rewrite it as `mode` by hand.'
+    },
+    {
+        anchor: INLINE_EDIT_TYPE,
+        pattern: '\\.modeChange\\s*\\.\\s*(?:subscribe|pipe|emit)\\s*\\(',
+        message: '`mode` is a model() now, so `modeChange` is the output it generates rather than a member of the ' +
+            'class. The `(modeChange)` template binding is unaffected; a programmatic subscription has to go ' +
+            'through the signal instead — `toObservable(inlineEdit.mode)` from @angular/core/rxjs-interop.'
+    },
+    {
+        anchor: INLINE_EDIT_TYPE,
+        pattern: '\\.kbq-inline-edit\\b[^\\n]*(?:\\[tabindex|:focus)|kbq-inline-edit[^\\n]*\\[tabindex',
+        message: 'The inline edit is no longer the tab stop: `role`, `tabindex` and the ARIA state moved to ' +
+            '.kbq-inline-edit__view-content, and to .kbq-inline-edit__focus-anchor while the view content is ' +
+            'interactive. A selector matching the host by tabindex or focus has to target those instead — the ' +
+            'focus ring itself still lands on the host through `cdk-keyboard-focused`.'
+    }
+];
+/** Printed once per project, after the per-file reports. */
+const SUMMARY = [
+    '  The view mode is announced as a `button` with `aria-expanded`, named by the new `edit` a11y locale ' +
+        'key or by an `aria-label` on the component. Hand-rolled role or aria-* attributes on ' +
+        '<kbq-inline-edit> are duplicates now, and `aria-label` is read as an input.',
+    '  `mode` is a model() — public, writable and two-way bindable, so `[(mode)]` opens and closes the ' +
+        'editor programmatically. `modeAsReadonly` existed only to expose the hidden signal for reading and ' +
+        'was removed; its call sites are rewritten to `mode`.',
+    '  The `modeChange` output is generated by the model under the same name and carries the same value, so ' +
+        '`(modeChange)` bindings keep working. It emits synchronously on the write now, rather than one ' +
+        'microtask later — a test that awaited the old gap can drop the wait.',
+    '  `saved` and `canceled` are public, so a viewChild(KbqInlineEdit) can subscribe to them. Template ' +
+        'bindings are unaffected.',
+    '  save() marks the projected controls touched itself and gates on the control validity rather than on ' +
+        'the ErrorStateMatcher verdict. Typing no longer flips a pristine required field into its error look, ' +
+        'and commit() on a never-touched invalid control now keeps the editor open instead of writing the ' +
+        'value through — a workaround directive that reset `touched` on first input can be deleted.',
+    '  The panel shadow reads --kbq-inline-edit-panel-shadow, which the panel used to declare and then ' +
+        'bypass, and the private .kbq-mask / .kbq-mask__fade / .kbq-mask__container classes were renamed to ' +
+        'their .kbq-inline-edit__menu-mask* equivalents.'
+];
+
+exports.A11Y_LOCALE_TYPE = A11Y_LOCALE_TYPE;
+exports.INLINE_EDIT_PACKAGE = INLINE_EDIT_PACKAGE;
+exports.INLINE_EDIT_TYPE = INLINE_EDIT_TYPE;
+exports.MODE_AS_READONLY_ACCESS = MODE_AS_READONLY_ACCESS;
+exports.MODE_AS_READONLY_MEMBER = MODE_AS_READONLY_MEMBER;
+exports.MODE_AS_READONLY_REPLACEMENT = MODE_AS_READONLY_REPLACEMENT;
+exports.SUMMARY = SUMMARY;
+exports.warnPatterns = warnPatterns;

package/schematics/migrations/inline-edit-a11y-and-types/index.js

@@ -0,0 +1,97 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var utils_messages = require('../../utils/messages.js');
+var utils_packageConfig = require('../../package-config-BhU2TfC8.js');
+var migrations_inlineEditA11yAndTypes_data = require('./data.js');
+require('@angular-devkit/schematics');
+require('@schematics/angular/utility');
+
+const LABEL = '[inline-edit-a11y-and-types]';
+const EXTENSIONS = ['.ts', '.html', '.scss', '.css'];
+/** The rename lives in code and markup only; the `.scss`/`.css` pass stays report-only. */
+const FIXABLE_EXTENSIONS = ['.ts', '.html'];
+// Compiled once: the scope test runs against every file of the project, and the warn patterns against
+// every file that passes it. None carries the `g` flag, so a shared instance holds no `lastIndex`.
+const inlineEditType = new RegExp(migrations_inlineEditA11yAndTypes_data.INLINE_EDIT_TYPE);
+const a11yLocaleType = new RegExp(migrations_inlineEditA11yAndTypes_data.A11Y_LOCALE_TYPE);
+const compiledWarnPatterns = migrations_inlineEditA11yAndTypes_data.warnPatterns.map(({ anchor, pattern, message }) => ({
+    anchor: new RegExp(anchor),
+    pattern: new RegExp(pattern),
+    message
+}));
+/** A file is in scope if it names the inline edit, or if it configures the a11y locale section. */
+function referencesSubject(content) {
+    return content.includes(migrations_inlineEditA11yAndTypes_data.INLINE_EDIT_PACKAGE) || inlineEditType.test(content) || a11yLocaleType.test(content);
+}
+/**
+ * Rewrites `modeAsReadonly` reads to `mode`, and reports the rest of what the inline-edit review broke:
+ * the removed `KbqFocusRegionItem`, the handler and tooltip types narrowed from `any` to `unknown`, the
+ * new required `edit` key of `KbqA11yLocaleConfiguration`, and the tab stop that moved off the host onto
+ * the view content.
+ *
+ * The rename is the only write. `modeAsReadonly` was a `computed()` wrapper over the mode signal, so a
+ * read of it translates to a read of `mode` unchanged — every other change is reported instead: a removed
+ * export has no replacement expression, a narrowed parameter needs a cast only the host can choose, and a
+ * selector that matched the host is a decision about which element it meant. `.scss`/`.css` are visited
+ * as well, because the tab stop moved in the DOM rather than in the API.
+ */
+function inlineEditA11yAndTypes(options) {
+    return async (tree, context) => {
+        const { project } = options;
+        // `ng update` invokes migrations with no options at all, so the schema default never reaches us —
+        // applying the fix is the intended behaviour there.
+        const fix = options.fix ?? true;
+        const projectDefinition = await utils_packageConfig.setupOptions(project, tree);
+        const root = projectDefinition?.root ?? '';
+        const rootDir = root ? tree.getDir(root) : tree.root;
+        let consumers = 0;
+        let reported = 0;
+        /** Collected during the walk and applied after it, so the tree is not mutated while iterating. */
+        const renames = [];
+        utils_packageConfig.visitProjectFiles(rootDir, (filePath, entry) => {
+            if (!EXTENSIONS.some((extension) => filePath.endsWith(extension)))
+                return;
+            const originalContent = entry?.content.toString();
+            if (!originalContent || !referencesSubject(originalContent))
+                return;
+            consumers++;
+            let content = originalContent;
+            if (FIXABLE_EXTENSIONS.some((extension) => filePath.endsWith(extension)) &&
+                originalContent.includes(migrations_inlineEditA11yAndTypes_data.MODE_AS_READONLY_MEMBER)) {
+                content = originalContent.replace(migrations_inlineEditA11yAndTypes_data.MODE_AS_READONLY_ACCESS, migrations_inlineEditA11yAndTypes_data.MODE_AS_READONLY_REPLACEMENT);
+                if (content !== originalContent)
+                    renames.push({ filePath, content });
+            }
+            // Warn against the fixed content, so a rewritten call site does not also produce a
+            // "migrate by hand" note. In dry-run nothing is written, so report against the original.
+            const reportedContent = fix ? content : originalContent;
+            for (const { anchor, pattern, message } of compiledWarnPatterns) {
+                if (!anchor.test(reportedContent) || !pattern.test(reportedContent))
+                    continue;
+                reported++;
+                utils_messages.logMessage(context.logger, [`${LABEL} ${filePath}`, `  ${message}`]);
+            }
+        });
+        for (const { filePath, content } of renames) {
+            if (fix) {
+                tree.overwrite(filePath, content);
+            }
+            else {
+                utils_messages.logMessage(context.logger, [`${LABEL} would update ${filePath} (run with --fix to apply)`]);
+            }
+        }
+        // Nothing here renders an inline edit or touches the a11y locale, so the summary would only be noise.
+        if (consumers === 0)
+            return;
+        utils_messages.logMessage(context.logger, [
+            `${LABEL} processed kbq-inline-edit under "${root || '<workspace root>'}", ` +
+                `${consumers} file(s) reference the component, ${renames.length} file(s) ` +
+                `${fix ? 'updated' : 'would be updated'}, ${reported} call site(s) reported.`,
+            ...migrations_inlineEditA11yAndTypes_data.SUMMARY
+        ]);
+    };
+}
+
+exports.default = inlineEditA11yAndTypes;

package/schematics/migrations/inline-edit-a11y-and-types/schema.json

@@ -0,0 +1,20 @@
+{
+    "$schema": "http://json-schema.org/schema",
+    "$id": "koobiq-components-inline-edit-a11y-and-types",
+    "title": "Koobiq components inline-edit review migration",
+    "type": "object",
+    "properties": {
+        "project": {
+            "type": "string",
+            "description": "Name of the project to inspect. If omitted, the migration runs over the whole tree.",
+            "$default": {
+                "$source": "projectName"
+            }
+        },
+        "fix": {
+            "type": "boolean",
+            "default": true,
+            "description": "When true, applies the modeAsReadonly to mode rename. When false, prints what would change without writing."
+        }
+    }
+}