@runic-artifex/angular 0.17.0 → 0.17.1

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.
Files changed (2) hide show
  1. package/README.md +21 -21
  2. package/package.json +5 -5
package/README.md CHANGED
@@ -140,7 +140,7 @@ export class CounterPage {
140
140
 
141
141
  Bind a text input to a member with `injectTextField(view, read, write, options?)`,
142
142
  which wraps the framework-neutral
143
- [text field controller](https://github.com/Runic-Artifex/runic-sdk/tree/v0.17.0/packages/web/views#text-inputs)
143
+ [text field controller](https://github.com/Runic-Artifex/runic-sdk/tree/v0.17.1/packages/web/views#text-inputs)
144
144
  for the lifetime of the injection context:
145
145
 
146
146
  ```ts
@@ -183,7 +183,7 @@ text at once and hides the race.
183
183
 
184
184
  For generated Views prefer `injectField(view, field, options?)`: pass a descriptor of the
185
185
  generated `{View}Fields`, such as `EditorFields.title`. It wraps the framework-neutral
186
- [field controller](https://github.com/Runic-Artifex/runic-sdk/tree/v0.17.0/packages/web/views#fields)
186
+ [field controller](https://github.com/Runic-Artifex/runic-sdk/tree/v0.17.1/packages/web/views#fields)
187
187
  for every kind (text, numbers, booleans, enums) and returns signals and actions:
188
188
 
189
189
  - `value`, `text` (what a text input shows: `1.` stays while typing `1.5`), `editing`,
@@ -232,7 +232,7 @@ A checked write's receipt is read: `rejected` keeps the draft with a `FieldError
232
232
  `reset()` (take the producer's value); `committed-with-error` keeps the committed value
233
233
  with a `FieldError`. A text that does not parse is a `FieldError` `invalid-text` with a `reason` and `arguments`:
234
234
  `{{ title.error() | runicText }}` shows your text for it after `configureFieldErrorText`, in the window's language
235
- ([Translating field errors](https://github.com/Runic-Artifex/runic-sdk/tree/v0.17.0/packages/web/views#translating-field-errors)).
235
+ ([Translating field errors](https://github.com/Runic-Artifex/runic-sdk/tree/v0.17.1/packages/web/views#translating-field-errors)).
236
236
  `errors` follows the member's validation in the View's state:
237
237
 
238
238
  ```html
@@ -249,7 +249,7 @@ Since 0.16, `InvoiceFields.address.street` and `InvoiceFields.lines.at(line.id).
249
249
  `injectField(view, InvoiceFields.lines.at(line.id).quantity)` in the row's component, or bind it with
250
250
  `[runicField]`; `at(key)` returns the same descriptor for the same key. Such a field always writes checked, conflicts
251
251
  only when another writer changed the same cell, and shows the messages .NET reports at the cell's validation path. See
252
- [Fields below a member and row cells](https://github.com/Runic-Artifex/runic-sdk/blob/v0.17.0/packages/web/angular/../views/README.md#fields-below-a-member-and-row-cells).
252
+ [Fields below a member and row cells](https://github.com/Runic-Artifex/runic-sdk/blob/v0.17.1/packages/web/angular/../views/README.md#fields-below-a-member-and-row-cells).
253
253
 
254
254
  ### Forms: `injectForm(fields, options?)`
255
255
 
@@ -380,7 +380,7 @@ reference; `injectView(this.page)` owns its connection and cleanup. Declare
380
380
  decorator `@Input() page` or an optional `input<DocumentReference>()` does not
381
381
  satisfy `ViewRegistry`. A component whose `page` input is a shared page
382
382
  reference, `input.required<ResultPagePageReference>()` for a .NET
383
- [`[RunicSharedClient]`](https://github.com/Runic-Artifex/runic-sdk/blob/v0.17.0/packages/web/angular/../../dotnet/Runic.Application.Views/README.md#shared-clients)
383
+ [`[RunicSharedClient]`](https://github.com/Runic-Artifex/runic-sdk/blob/v0.17.1/packages/web/angular/../../dotnet/Runic.Application.Views/README.md#shared-clients)
384
384
  interface, registers for each of its kinds without a cast:
385
385
  `{ ...registryEntries(resultPageKinds, ResultPage), settings: Settings }`. Missing kinds render an English `<p role="alert">` in a
386
386
  development build (`isDevMode()`); a production build renders nothing and
@@ -493,14 +493,14 @@ For example, a navigation command whose departure guard awaits a dialog's
493
493
  answer never completes while the answer waits behind it. Order such commands
494
494
  by dispatch instead: start the next one once the previous one has been sent,
495
495
  as the Notes example's
496
- [`WindowOperations.runDispatched`](https://github.com/Runic-Artifex/runic-sdk/tree/v0.17.0/examples/notes-view-first/Angular/src/app/window-operations.ts)
496
+ [`WindowOperations.runDispatched`](https://github.com/Runic-Artifex/runic-sdk/tree/v0.17.1/examples/notes-view-first/Angular/src/app/window-operations.ts)
497
497
  does for its navigation commands.
498
498
 
499
499
  ## Operations
500
500
 
501
501
  `injectOperation(start, options?)` observes a generated `start<Command>()` operation
502
502
  through the framework-neutral
503
- [operation controller](https://github.com/Runic-Artifex/runic-sdk/tree/v0.17.0/packages/web/views#operation-feedback-and-latest-selection)
503
+ [operation controller](https://github.com/Runic-Artifex/runic-sdk/tree/v0.17.1/packages/web/views#operation-feedback-and-latest-selection)
504
504
  for the lifetime of the injection context:
505
505
 
506
506
  ```ts
@@ -526,7 +526,7 @@ context.
526
526
 
527
527
  `injectLatestOperation(options?)` admits only the newest of several reads, for example
528
528
  loading the item the user selected last, through the framework-neutral
529
- [latest-operation controller](https://github.com/Runic-Artifex/runic-sdk/tree/v0.17.0/packages/web/views#operation-feedback-and-latest-selection).
529
+ [latest-operation controller](https://github.com/Runic-Artifex/runic-sdk/tree/v0.17.1/packages/web/views#operation-feedback-and-latest-selection).
530
530
  Each `run(intent)` replaces the queued intent and cancels the active read; the next
531
531
  read starts only after the previous one reaches its terminal status and the intent's
532
532
  optional `waitForCompletion` barrier:
@@ -558,7 +558,7 @@ from `@runic-artifex/views` (re-exported here since 0.11, with the
558
558
  `BridgeConnectionState` and `BridgeConnectionOptions` types) and returns `{ state }`, a signal of a
559
559
  `BridgeConnectionState`: `connecting`, `connected`, `reconnecting`, `lost` or `closed` (the
560
560
  application closed the window, since 0.15; a closed set, see
561
- [Connection state](https://github.com/Runic-Artifex/runic-sdk/tree/v0.17.0/packages/web/views#connection-state)):
561
+ [Connection state](https://github.com/Runic-Artifex/runic-sdk/tree/v0.17.1/packages/web/views#connection-state)):
562
562
 
563
563
  ```ts
564
564
  import { injectBridgeConnection } from "@runic-artifex/angular";
@@ -576,7 +576,7 @@ not observe and stays `connecting`. An invalid `lostAfter` throws a `RangeError`
576
576
  `injectMenuBar(options?)` follows the declared menu bar of a Runic Desktop
577
577
  window that leaves it to the page (`DesktopMenuBarPresentation.Page`) for the
578
578
  lifetime of the injection context. It wraps `createMenuBarController` from
579
- `@runic-artifex/views` (see [In-page menu bar](https://github.com/Runic-Artifex/runic-sdk/tree/v0.17.0/packages/web/views#in-page-menu-bar))
579
+ `@runic-artifex/views` (see [In-page menu bar](https://github.com/Runic-Artifex/runic-sdk/tree/v0.17.1/packages/web/views#in-page-menu-bar))
580
580
  and returns `{ state, invoke, handleKeyDown }`, where `state` is a signal of a
581
581
  `MenuBarState`. The bar is rendered by the application's own menubar, for
582
582
  example the CDK Menu's `cdkMenuBar`. Runic ships no menubar component.
@@ -601,7 +601,7 @@ it creates none and stays `connecting`.
601
601
  ### With the CDK Menu
602
602
 
603
603
  The CDK's `cdkMenuBar` with `CdkMenuTrigger.open()` for `open` requests; the
604
- [Notes example](https://github.com/Runic-Artifex/runic-sdk/tree/v0.17.0/examples/notes-view-first#in-page-menu-bar) adds submenus, check and radio
604
+ [Notes example](https://github.com/Runic-Artifex/runic-sdk/tree/v0.17.1/examples/notes-view-first#in-page-menu-bar) adds submenus, check and radio
605
605
  items (`cdkMenuItemCheckbox`, `cdkMenuItemRadio` in a `cdkMenuGroup`) and is
606
606
  tested with real keys:
607
607
 
@@ -655,7 +655,7 @@ export class AppMenuBar {
655
655
  `injectText(() => source, () => fallback?)` is a signal of a text reference in
656
656
  the window's language, and the `runicText` pipe does the same in templates; both
657
657
  follow a language switch. Connect the page's Translations runtime once with
658
- `configureTranslatedText` ([Translated text](https://github.com/Runic-Artifex/runic-sdk/blob/v0.17.0/packages/dotnet/Runic.Application.Views/README.md#translated-text)).
658
+ `configureTranslatedText` ([Translated text](https://github.com/Runic-Artifex/runic-sdk/blob/v0.17.1/packages/dotnet/Runic.Application.Views/README.md#translated-text)).
659
659
  `injectWindowLocale()` reads the window's locale. `textLocaleSignal()` is the
660
660
  locale that text is shown in, as one signal for the page that needs no injection
661
661
  context; when the locale resolver reads it, templates that call `m.*()`, also
@@ -688,7 +688,7 @@ with `resolveTextReference` and the request's locale.
688
688
  injection context: the colour scheme, contrast and reduced motion of the page's
689
689
  engine, combined with the desktop's text scale, accent colour, forced-colours
690
690
  palette, contrast and motion that a Runic host pushes
691
- ([Appearance](https://github.com/Runic-Artifex/runic-sdk/blob/v0.17.0/packages/web/views/README.md#appearance)). On the server every member is `null`.
691
+ ([Appearance](https://github.com/Runic-Artifex/runic-sdk/blob/v0.17.1/packages/web/views/README.md#appearance)). On the server every member is `null`.
692
692
 
693
693
  ```ts
694
694
  readonly appearance = injectAppearance();
@@ -712,7 +712,7 @@ readonly message = computed(() => describeBridgeError(this.view.error()));
712
712
  ```
713
713
 
714
714
  `instanceof` holds for errors from every copy of the package on the page.
715
- [Errors and diagnostics](https://github.com/Runic-Artifex/runic-sdk/tree/v0.17.0/packages/web/views#errors-and-diagnostics)
715
+ [Errors and diagnostics](https://github.com/Runic-Artifex/runic-sdk/tree/v0.17.1/packages/web/views#errors-and-diagnostics)
716
716
  lists the kinds. Any other value, such as an exception that your own connect
717
717
  function or command callback throws, arrives unchanged.
718
718
 
@@ -763,10 +763,10 @@ application's own dialog.
763
763
  departure before that is answered by the ViewModel's .NET fallback handler, or
764
764
  fails closed without one.
765
765
 
766
- The [ReactiveUI leave confirmation](https://github.com/Runic-Artifex/runic-sdk/blob/v0.17.0/packages/dotnet/Runic.Application.Views.ReactiveUI/README.md#leave-confirmation-in-a-web-view)
766
+ The [ReactiveUI leave confirmation](https://github.com/Runic-Artifex/runic-sdk/blob/v0.17.1/packages/dotnet/Runic.Application.Views.ReactiveUI/README.md#leave-confirmation-in-a-web-view)
767
767
  has the .NET side and which View answers which departure. In a frontend test,
768
768
  the generated mock's `interactions.<name>.request(input)` resolves with the
769
- registered handler's answer; see the [Testing guide](https://github.com/Runic-Artifex/runic-sdk/tree/v0.17.0/packages/web/views#testing).
769
+ registered handler's answer; see the [Testing guide](https://github.com/Runic-Artifex/runic-sdk/tree/v0.17.1/packages/web/views#testing).
770
770
 
771
771
  ## View requests
772
772
 
@@ -804,15 +804,15 @@ the page painted the state the request was raised with, so the field of that
804
804
  state is rendered; `signal` aborts when the handler is replaced or removed, the
805
805
  client is disposed or the connection is lost. A request is never replayed: one
806
806
  raised before the effect ran, or while the page is disconnected, is not
807
- delivered later. See [View requests](https://github.com/Runic-Artifex/runic-sdk/tree/v0.17.0/packages/web/views#view-requests) for the rules, and in a frontend
807
+ delivered later. See [View requests](https://github.com/Runic-Artifex/runic-sdk/tree/v0.17.1/packages/web/views#view-requests) for the rules, and in a frontend
808
808
  test raise one with the generated mock's `requests.<name>.raise(input)` (the
809
- [Testing guide](https://github.com/Runic-Artifex/runic-sdk/tree/v0.17.0/packages/web/views#testing)).
809
+ [Testing guide](https://github.com/Runic-Artifex/runic-sdk/tree/v0.17.1/packages/web/views#testing)).
810
810
 
811
811
  ## Collection viewports
812
812
 
813
813
  `injectCollectionViewport(element, options)` follows a fixed-row-height scroll
814
814
  container and returns a signal with its
815
- [`collectionViewport`](https://github.com/Runic-Artifex/runic-sdk/tree/v0.17.0/packages/web/views#collectionviewportoptions)
815
+ [`collectionViewport`](https://github.com/Runic-Artifex/runic-sdk/tree/v0.17.1/packages/web/views#collectionviewportoptions)
816
816
  range. Pass the container as a signal, such as a `viewChild`, and the options as
817
817
  a function or signal, then send the range to the ViewModel from an effect:
818
818
 
@@ -844,7 +844,7 @@ export class RowsPage {
844
844
  ## Query collections
845
845
 
846
846
  `injectQueryCollection(element, collection, options)` follows a scroll container for a
847
- [query collection](https://github.com/Runic-Artifex/runic-sdk/tree/v0.17.0/packages/web/views#query-collections) (`client.queries.{name}`), whose rows stay in .NET: it loads the rows the container shows,
847
+ [query collection](https://github.com/Runic-Artifex/runic-sdk/tree/v0.17.1/packages/web/views#query-collections) (`client.queries.{name}`), whose rows stay in .NET: it loads the rows the container shows,
848
848
  with placeholders until they arrive, and lays them out with variable heights. `viewport` is a signal of the
849
849
  `QueryViewport` (`items` with `top` and `size`, `totalSize`, `total`, `query`, `loading`, `error`); `observe(element,
850
850
  index)` measures a rendered row, and `scrollToKey`, `scrollToIndex`, `setQuery` and `retry` act on the collection.
@@ -861,4 +861,4 @@ The package re-exports `installBackNavigation`, `installNavigationPath`,
861
861
  `@runic-artifex/views` (since 0.16). Call the installs once where the page
862
862
  starts, before or after mounting: the mouse's Back button and Alt+Left then go
863
863
  back in the .NET window, and `#/customers/42` follows its path region. See
864
- [Back and the URL](https://github.com/Runic-Artifex/runic-sdk/blob/v0.17.0/packages/web/views/README.md#back-and-the-url).
864
+ [Back and the URL](https://github.com/Runic-Artifex/runic-sdk/blob/v0.17.1/packages/web/views/README.md#back-and-the-url).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@runic-artifex/angular",
3
- "version": "0.17.0",
3
+ "version": "0.17.1",
4
4
  "type": "module",
5
5
  "exports": {
6
6
  ".": {
@@ -18,7 +18,7 @@
18
18
  "peerDependencies": {
19
19
  "@angular/core": ">=22.0.0 <23",
20
20
  "@angular/forms": ">=22.0.0 <23",
21
- "@runic-artifex/views": "0.17.0"
21
+ "@runic-artifex/views": "0.17.1"
22
22
  },
23
23
  "peerDependenciesMeta": {
24
24
  "@angular/forms": {
@@ -32,7 +32,7 @@
32
32
  "url": "git+https://github.com/Runic-Artifex/runic-sdk.git",
33
33
  "directory": "packages/web/angular"
34
34
  },
35
- "homepage": "https://github.com/Runic-Artifex/runic-sdk/tree/v0.17.0/packages/web/angular#readme",
35
+ "homepage": "https://github.com/Runic-Artifex/runic-sdk/tree/v0.17.1/packages/web/angular#readme",
36
36
  "bugs": {
37
37
  "url": "https://github.com/Runic-Artifex/runic-sdk/issues"
38
38
  },
@@ -56,7 +56,7 @@
56
56
  "pack:check": "bun pm pack --dry-run"
57
57
  },
58
58
  "devDependencies": {
59
- "@runic-artifex/views": "0.17.0",
59
+ "@runic-artifex/views": "0.17.1",
60
60
  "@angular/common": "22.2.3",
61
61
  "@angular/compiler": "22.2.3",
62
62
  "@angular/compiler-cli": "22.2.3",
@@ -69,5 +69,5 @@
69
69
  "typescript": "6.0.3",
70
70
  "vitest": "5.0.3"
71
71
  },
72
- "gitHead": "daeb17e5c3fb0b625d5d988d359cd12ffa51f8c6"
72
+ "gitHead": "4f200eadd987eab9a2e38db6e8841849b743b615"
73
73
  }