@runic-artifex/vue 0.14.0 → 0.15.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/README.md +16 -15
- package/dist/index.d.ts +7 -6
- package/dist/index.js +3 -3
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -181,8 +181,9 @@ is written. A string set on `value` of a field that is not text is taken as its
|
|
|
181
181
|
|
|
182
182
|
- `commit: "pause"` writes the draft after `delay` milliseconds without input (700 by default) and at once on
|
|
183
183
|
`commit()`, which blur calls; use it where each write is an undo step or starts work in .NET. The default,
|
|
184
|
-
`commit: "input"`, writes each input. `commit()` resolves
|
|
185
|
-
depends on the field can follow them
|
|
184
|
+
`commit: "input"`, writes each input. `commit()` resolves with the field's state once its writes settled, so a
|
|
185
|
+
command that depends on the field can follow them and skip a failed write:
|
|
186
|
+
`if ((await title.commit()).error === undefined) await editor.save()`.
|
|
186
187
|
- `checked: true` writes with the member's checked write, so a change by another writer while the user edits is a
|
|
187
188
|
conflict instead of being overwritten. A `rejected` receipt keeps the draft and sets `error` to a `FieldError` with
|
|
188
189
|
the setter's message; a `conflict` keeps the draft, sets `conflict` to the producer's `{ value, version }` and
|
|
@@ -192,13 +193,13 @@ is written. A string set on `value` of a field that is not text is taken as its
|
|
|
192
193
|
`errors` holds the member's validation messages from the descriptor (`[]` when valid), `error` why the latest write
|
|
193
194
|
or text failed (a `BridgeError` or a `FieldError`, whose `kind` is `rejected`, `conflict`, `committed-with-error` or
|
|
194
195
|
`invalid-text`). `FieldError`, `FieldOptions`, `FieldState` and `BridgeField` are exported from this package. See the
|
|
195
|
-
[field controller](https://github.com/Runic-Artifex/runic-sdk/tree/v0.
|
|
196
|
+
[field controller](https://github.com/Runic-Artifex/runic-sdk/tree/v0.15.0/packages/web/views#fields) for the receipts
|
|
196
197
|
and text forms.
|
|
197
198
|
|
|
198
199
|
### Text inputs: `useTextField(view, read, write, options?)`
|
|
199
200
|
|
|
200
201
|
Binds a text input to a member through the framework-neutral
|
|
201
|
-
[text field controller](https://github.com/Runic-Artifex/runic-sdk/tree/v0.
|
|
202
|
+
[text field controller](https://github.com/Runic-Artifex/runic-sdk/tree/v0.15.0/packages/web/views#text-inputs)
|
|
202
203
|
while the effect scope is active. Each field is a ref, so the handle can be destructured:
|
|
203
204
|
|
|
204
205
|
```vue
|
|
@@ -300,7 +301,7 @@ neither.
|
|
|
300
301
|
## `useOperation(start, options?)`
|
|
301
302
|
|
|
302
303
|
Observes a generated `start<Command>()` operation through the framework-neutral
|
|
303
|
-
[operation controller](https://github.com/Runic-Artifex/runic-sdk/tree/v0.
|
|
304
|
+
[operation controller](https://github.com/Runic-Artifex/runic-sdk/tree/v0.15.0/packages/web/views#operation-feedback-and-latest-selection)
|
|
304
305
|
and returns each state field as a shallow ref, with `run`, `cancel` and `reset`:
|
|
305
306
|
|
|
306
307
|
```vue
|
|
@@ -332,7 +333,7 @@ Disposing the effect scope settles run promises without cancelling accepted work
|
|
|
332
333
|
|
|
333
334
|
Admits only the newest of several reads, for example loading the item the user
|
|
334
335
|
selected last, through the framework-neutral
|
|
335
|
-
[latest-operation controller](https://github.com/Runic-Artifex/runic-sdk/tree/v0.
|
|
336
|
+
[latest-operation controller](https://github.com/Runic-Artifex/runic-sdk/tree/v0.15.0/packages/web/views#operation-feedback-and-latest-selection),
|
|
336
337
|
and returns each state field as a shallow ref, with `run` and `clear`. Each
|
|
337
338
|
`run(intent)` replaces the queued intent and cancels the active read; the next read
|
|
338
339
|
starts only after the previous one reaches its terminal status and the intent's
|
|
@@ -367,9 +368,9 @@ accepted work.
|
|
|
367
368
|
Follows the page's connection to its .NET host. It wraps `onBridgeConnection`
|
|
368
369
|
from `@runic-artifex/views` (re-exported here since 0.11, with the
|
|
369
370
|
`BridgeConnectionState` and `BridgeConnectionOptions` types) and returns `{ state }`, a shallow ref holding a
|
|
370
|
-
`BridgeConnectionState`: `connecting`, `connected`, `reconnecting` or `
|
|
371
|
-
closed set, see
|
|
372
|
-
[Connection state](https://github.com/Runic-Artifex/runic-sdk/tree/v0.
|
|
371
|
+
`BridgeConnectionState`: `connecting`, `connected`, `reconnecting`, `lost` or `closed` (the
|
|
372
|
+
application closed the window, since 0.15; a closed set, see
|
|
373
|
+
[Connection state](https://github.com/Runic-Artifex/runic-sdk/tree/v0.15.0/packages/web/views#connection-state)):
|
|
373
374
|
|
|
374
375
|
```vue
|
|
375
376
|
<script setup lang="ts">
|
|
@@ -392,7 +393,7 @@ development builds warn. An invalid `lostAfter` throws a `RangeError`.
|
|
|
392
393
|
Follows the declared menu bar of a Runic Desktop window that leaves it to the
|
|
393
394
|
page (`DesktopMenuBarPresentation.Page`) until the current effect scope is
|
|
394
395
|
disposed. It wraps `createMenuBarController` from `@runic-artifex/views` (see
|
|
395
|
-
[In-page menu bar](https://github.com/Runic-Artifex/runic-sdk/tree/v0.
|
|
396
|
+
[In-page menu bar](https://github.com/Runic-Artifex/runic-sdk/tree/v0.15.0/packages/web/views#in-page-menu-bar)) and returns `{ state, invoke, handleKeyDown }`: `state` is a shallow ref
|
|
396
397
|
of a `MenuBarState`, and the bar is rendered by the menubar component of the
|
|
397
398
|
application's own UI library. Runic ships no menubar component.
|
|
398
399
|
|
|
@@ -423,7 +424,7 @@ rendering creates no controller: `state` stays `connecting`.
|
|
|
423
424
|
### With Reka UI
|
|
424
425
|
|
|
425
426
|
Reka UI's `MenubarRoot` with `v-model` of the open menu; the
|
|
426
|
-
[Notes example](https://github.com/Runic-Artifex/runic-sdk/tree/v0.
|
|
427
|
+
[Notes example](https://github.com/Runic-Artifex/runic-sdk/tree/v0.15.0/examples/notes-view-first#in-page-menu-bar) adds submenus, check and radio
|
|
427
428
|
items and is tested with real keys:
|
|
428
429
|
|
|
429
430
|
```vue
|
|
@@ -485,7 +486,7 @@ const message = computed(() => describeBridgeError(error.value));
|
|
|
485
486
|
```
|
|
486
487
|
|
|
487
488
|
`instanceof` holds for errors from every copy of the package on the page.
|
|
488
|
-
[Errors and diagnostics](https://github.com/Runic-Artifex/runic-sdk/tree/v0.
|
|
489
|
+
[Errors and diagnostics](https://github.com/Runic-Artifex/runic-sdk/tree/v0.15.0/packages/web/views#errors-and-diagnostics)
|
|
489
490
|
lists the kinds. Any other value, such as an exception that your own connect
|
|
490
491
|
function or command callback throws, arrives unchanged.
|
|
491
492
|
|
|
@@ -532,15 +533,15 @@ application's own dialog.
|
|
|
532
533
|
departure before that is answered by the ViewModel's .NET fallback handler, or
|
|
533
534
|
fails closed without one.
|
|
534
535
|
|
|
535
|
-
The [ReactiveUI leave confirmation](https://github.com/Runic-Artifex/runic-sdk/blob/v0.
|
|
536
|
+
The [ReactiveUI leave confirmation](https://github.com/Runic-Artifex/runic-sdk/blob/v0.15.0/packages/dotnet/Runic.Application.Views.ReactiveUI/README.md#leave-confirmation-in-a-web-view)
|
|
536
537
|
has the .NET side and which View answers which departure. In a frontend test,
|
|
537
538
|
the generated mock's `interactions.<name>.request(input)` resolves with the
|
|
538
|
-
registered handler's answer; see the [Testing guide](https://github.com/Runic-Artifex/runic-sdk/tree/v0.
|
|
539
|
+
registered handler's answer; see the [Testing guide](https://github.com/Runic-Artifex/runic-sdk/tree/v0.15.0/packages/web/views#testing).
|
|
539
540
|
|
|
540
541
|
## `useCollectionViewport(options)`
|
|
541
542
|
|
|
542
543
|
Follows a fixed-row-height scroll container and returns `{ viewport, attach }`.
|
|
543
|
-
`viewport` is a shallow ref with the [`collectionViewport`](https://github.com/Runic-Artifex/runic-sdk/tree/v0.
|
|
544
|
+
`viewport` is a shallow ref with the [`collectionViewport`](https://github.com/Runic-Artifex/runic-sdk/tree/v0.15.0/packages/web/views#collectionviewportoptions)
|
|
544
545
|
range; `attach` is a function ref for the container. Bind it to a native element
|
|
545
546
|
such as a `<div>`: a component instance (`:ref="attach"` on a component) or a
|
|
546
547
|
non-HTML element detaches the viewport, and development builds warn. Pass a getter for the
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { type Component, type MaybeRefOrGetter, type Ref, type WritableComputedRef } from "vue";
|
|
2
|
-
import { type BridgeConnectionOptions, type BridgeConnectionState, type BridgeField, type BridgeOperation, type BridgeOutcomeFailure, type FieldBaseline, type FieldDefinition, type FieldOptions, type LatestOperationController, type LatestOperationState, type OperationController, type OperationControllerOptions, type OperationState, type PageReference, type ViewClient, type ViewConnector, type ViewSource } from "@runic-artifex/views";
|
|
2
|
+
import { type BridgeConnectionOptions, type BridgeConnectionState, type BridgeField, type BridgeOperation, type BridgeOutcomeFailure, type FieldBaseline, type FieldDefinition, type FieldState, type FieldOptions, type LatestOperationController, type LatestOperationState, type OperationController, type OperationControllerOptions, type OperationState, type PageReference, type ViewClient, type ViewConnector, type ViewSource } from "@runic-artifex/views";
|
|
3
3
|
export interface ViewHandle<TClient extends ViewClient> {
|
|
4
4
|
/** The latest state, or undefined until the client connects. */
|
|
5
5
|
readonly state: Readonly<Ref<TClient["snapshot"] | undefined>>;
|
|
@@ -260,10 +260,11 @@ export interface FieldHandle<TValue> {
|
|
|
260
260
|
input(value: TValue): void;
|
|
261
261
|
/**
|
|
262
262
|
* The user is done with the field (`@blur="title.commit"`): with `commit: "pause"` the draft is written now.
|
|
263
|
-
* Resolves
|
|
264
|
-
* `await title.commit()
|
|
263
|
+
* Resolves with the field's state once its writes settled, so a command that depends on the field can run after it
|
|
264
|
+
* and skip a failed write: `if ((await title.commit()).error === undefined) await editor.save()`. Never rejects; a
|
|
265
|
+
* failure is `error`.
|
|
265
266
|
*/
|
|
266
|
-
commit(): Promise<
|
|
267
|
+
commit(): Promise<FieldState<TValue>>;
|
|
267
268
|
/** Writes the draft again after a failed write; after a `conflict`, over the producer's value. */
|
|
268
269
|
retry(): void;
|
|
269
270
|
/** Drops the draft, the error and a conflict and shows the View's value. Writes in flight still complete. */
|
|
@@ -294,8 +295,8 @@ export interface BridgeConnectionHandle {
|
|
|
294
295
|
readonly state: Readonly<Ref<BridgeConnectionState>>;
|
|
295
296
|
}
|
|
296
297
|
/**
|
|
297
|
-
* Follows the page's connection to its .NET host (`connecting`, `connected`, `reconnecting
|
|
298
|
-
* or `
|
|
298
|
+
* Follows the page's connection to its .NET host (`connecting`, `connected`, `reconnecting`,
|
|
299
|
+
* `lost` or `closed`) as a shallow ref through `onBridgeConnection`, until the current effect scope is
|
|
299
300
|
* disposed. Call it in `setup()` or `effectScope().run()`: outside an effect scope it is never
|
|
300
301
|
* released (development builds warn).
|
|
301
302
|
*
|
package/dist/index.js
CHANGED
|
@@ -260,14 +260,14 @@ export function useField(view, field, options = {}) {
|
|
|
260
260
|
errors: computed(() => current.value.errors),
|
|
261
261
|
conflict: computed(() => current.value.conflict),
|
|
262
262
|
input: (value) => controller.input(value),
|
|
263
|
-
commit:
|
|
263
|
+
commit: () => controller.commit(),
|
|
264
264
|
retry: () => controller.retry(),
|
|
265
265
|
reset: () => controller.reset(),
|
|
266
266
|
});
|
|
267
267
|
}
|
|
268
268
|
/**
|
|
269
|
-
* Follows the page's connection to its .NET host (`connecting`, `connected`, `reconnecting
|
|
270
|
-
* or `
|
|
269
|
+
* Follows the page's connection to its .NET host (`connecting`, `connected`, `reconnecting`,
|
|
270
|
+
* `lost` or `closed`) as a shallow ref through `onBridgeConnection`, until the current effect scope is
|
|
271
271
|
* disposed. Call it in `setup()` or `effectScope().run()`: outside an effect scope it is never
|
|
272
272
|
* released (development builds warn).
|
|
273
273
|
*
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@runic-artifex/vue",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.15.0",
|
|
4
4
|
"description": "Vue composables for generated Runic Views clients",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -30,10 +30,10 @@
|
|
|
30
30
|
},
|
|
31
31
|
"peerDependencies": {
|
|
32
32
|
"vue": ">=3.5.30 <4",
|
|
33
|
-
"@runic-artifex/views": "0.
|
|
33
|
+
"@runic-artifex/views": "0.15.0"
|
|
34
34
|
},
|
|
35
35
|
"devDependencies": {
|
|
36
|
-
"@runic-artifex/views": "0.
|
|
36
|
+
"@runic-artifex/views": "0.15.0",
|
|
37
37
|
"esbuild": "0.28.2",
|
|
38
38
|
"happy-dom": "21.0.4",
|
|
39
39
|
"playwright-core": "1.63.0",
|
|
@@ -50,7 +50,7 @@
|
|
|
50
50
|
"url": "git+https://github.com/Runic-Artifex/runic-sdk.git",
|
|
51
51
|
"directory": "packages/web/vue"
|
|
52
52
|
},
|
|
53
|
-
"homepage": "https://github.com/Runic-Artifex/runic-sdk/tree/v0.
|
|
53
|
+
"homepage": "https://github.com/Runic-Artifex/runic-sdk/tree/v0.15.0/packages/web/vue#readme",
|
|
54
54
|
"bugs": {
|
|
55
55
|
"url": "https://github.com/Runic-Artifex/runic-sdk/issues"
|
|
56
56
|
},
|
|
@@ -60,5 +60,5 @@
|
|
|
60
60
|
"views",
|
|
61
61
|
"vue"
|
|
62
62
|
],
|
|
63
|
-
"gitHead": "
|
|
63
|
+
"gitHead": "c94bda07cf363bad056eda86ae77c514b66e61dd"
|
|
64
64
|
}
|