@noldova/desktop.protocol 0.0.0-stage → 0.0.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.
- package/LICENSE +21 -0
- package/README.md +35 -2
- package/api/index.d.ts +8228 -0
- package/api/index.js +121 -0
- package/api/index.js.map +1 -0
- package/api/testing.d.ts +601 -0
- package/api/testing.js +11 -0
- package/api/testing.js.map +1 -0
- package/enums/edit-action.js +17 -0
- package/enums/edit-action.js.map +1 -0
- package/enums/failure-code.js +27 -0
- package/enums/failure-code.js.map +1 -0
- package/enums/module-state.js +16 -0
- package/enums/module-state.js.map +1 -0
- package/enums/notification-severity.js +15 -0
- package/enums/notification-severity.js.map +1 -0
- package/enums/quit-answer.js +13 -0
- package/enums/quit-answer.js.map +1 -0
- package/enums/quit-result.js +13 -0
- package/enums/quit-result.js.map +1 -0
- package/enums/secret-action.js +14 -0
- package/enums/secret-action.js.map +1 -0
- package/enums/secret-failure-kind.js +14 -0
- package/enums/secret-failure-kind.js.map +1 -0
- package/enums/secret-failure-reason.js +15 -0
- package/enums/secret-failure-reason.js.map +1 -0
- package/enums/setting-kind.js +19 -0
- package/enums/setting-kind.js.map +1 -0
- package/enums/setting-locality.js +13 -0
- package/enums/setting-locality.js.map +1 -0
- package/enums/stop-policy.js +13 -0
- package/enums/stop-policy.js.map +1 -0
- package/enums/web-view-action.js +20 -0
- package/enums/web-view-action.js.map +1 -0
- package/enums/web-view-event-kind.js +25 -0
- package/enums/web-view-event-kind.js.map +1 -0
- package/enums/web-view-failure-kind.js +21 -0
- package/enums/web-view-failure-kind.js.map +1 -0
- package/enums/web-view-navigation-kind.js +14 -0
- package/enums/web-view-navigation-kind.js.map +1 -0
- package/enums/window-action.js +14 -0
- package/enums/window-action.js.map +1 -0
- package/enums/wire-message-kind.js +16 -0
- package/enums/wire-message-kind.js.map +1 -0
- package/exceptions/desktop-protocol.exception.js +14 -0
- package/exceptions/desktop-protocol.exception.js.map +1 -0
- package/exceptions/protocol.exception.js +20 -0
- package/exceptions/protocol.exception.js.map +1 -0
- package/interfaces/i-key-stroke.js +9 -0
- package/interfaces/i-key-stroke.js.map +1 -0
- package/models/agent-control-state.js +28 -0
- package/models/agent-control-state.js.map +1 -0
- package/models/app-shortcut-list.js +27 -0
- package/models/app-shortcut-list.js.map +1 -0
- package/models/app-shortcut.js +35 -0
- package/models/app-shortcut.js.map +1 -0
- package/models/app-window-list.js +27 -0
- package/models/app-window-list.js.map +1 -0
- package/models/app-window.js +34 -0
- package/models/app-window.js.map +1 -0
- package/models/build-identity.js +53 -0
- package/models/build-identity.js.map +1 -0
- package/models/cancel.js +30 -0
- package/models/cancel.js.map +1 -0
- package/models/command-info.js +49 -0
- package/models/command-info.js.map +1 -0
- package/models/command-list.js +31 -0
- package/models/command-list.js.map +1 -0
- package/models/command-run.js +29 -0
- package/models/command-run.js.map +1 -0
- package/models/date-pattern.js +64 -0
- package/models/date-pattern.js.map +1 -0
- package/models/event.js +38 -0
- package/models/event.js.map +1 -0
- package/models/failure.js +34 -0
- package/models/failure.js.map +1 -0
- package/models/file-grant.js +80 -0
- package/models/file-grant.js.map +1 -0
- package/models/file-grants-discard.js +32 -0
- package/models/file-grants-discard.js.map +1 -0
- package/models/file-grants-ended.js +33 -0
- package/models/file-grants-ended.js.map +1 -0
- package/models/file-share-resolve.js +29 -0
- package/models/file-share-resolve.js.map +1 -0
- package/models/handshake.js +47 -0
- package/models/handshake.js.map +1 -0
- package/models/kept-runtime.js +29 -0
- package/models/kept-runtime.js.map +1 -0
- package/models/key-chord.js +115 -0
- package/models/key-chord.js.map +1 -0
- package/models/key-name.js +59 -0
- package/models/key-name.js.map +1 -0
- package/models/main-window.js +30 -0
- package/models/main-window.js.map +1 -0
- package/models/module-status-list.js +25 -0
- package/models/module-status-list.js.map +1 -0
- package/models/module-status.js +80 -0
- package/models/module-status.js.map +1 -0
- package/models/notification-action.js +36 -0
- package/models/notification-action.js.map +1 -0
- package/models/notification-broadcast.js +50 -0
- package/models/notification-broadcast.js.map +1 -0
- package/models/notification-list.js +27 -0
- package/models/notification-list.js.map +1 -0
- package/models/notification-post.js +81 -0
- package/models/notification-post.js.map +1 -0
- package/models/notification-reference.js +30 -0
- package/models/notification-reference.js.map +1 -0
- package/models/notification-state.js +44 -0
- package/models/notification-state.js.map +1 -0
- package/models/notification.js +54 -0
- package/models/notification.js.map +1 -0
- package/models/notifications-query.js +28 -0
- package/models/notifications-query.js.map +1 -0
- package/models/pre-shell-data.js +28 -0
- package/models/pre-shell-data.js.map +1 -0
- package/models/program-status-list.js +32 -0
- package/models/program-status-list.js.map +1 -0
- package/models/program-status.js +48 -0
- package/models/program-status.js.map +1 -0
- package/models/qualified-name.js +44 -0
- package/models/qualified-name.js.map +1 -0
- package/models/quit-answered.js +28 -0
- package/models/quit-answered.js.map +1 -0
- package/models/quit-report.js +28 -0
- package/models/quit-report.js.map +1 -0
- package/models/recent-command-use.js +31 -0
- package/models/recent-command-use.js.map +1 -0
- package/models/recent-commands-query.js +28 -0
- package/models/recent-commands-query.js.map +1 -0
- package/models/recent-commands.js +39 -0
- package/models/recent-commands.js.map +1 -0
- package/models/request.js +55 -0
- package/models/request.js.map +1 -0
- package/models/response.js +62 -0
- package/models/response.js.map +1 -0
- package/models/running-work.js +30 -0
- package/models/running-work.js.map +1 -0
- package/models/runtime-handover.js +32 -0
- package/models/runtime-handover.js.map +1 -0
- package/models/secret-answered.js +42 -0
- package/models/secret-answered.js.map +1 -0
- package/models/secret-command.js +52 -0
- package/models/secret-command.js.map +1 -0
- package/models/secret-failures.js +25 -0
- package/models/secret-failures.js.map +1 -0
- package/models/secret-reference.js +30 -0
- package/models/secret-reference.js.map +1 -0
- package/models/secret-value.js +37 -0
- package/models/secret-value.js.map +1 -0
- package/models/setting-change.js +31 -0
- package/models/setting-change.js.map +1 -0
- package/models/setting-definition.js +71 -0
- package/models/setting-definition.js.map +1 -0
- package/models/setting-entry.js +31 -0
- package/models/setting-entry.js.map +1 -0
- package/models/setting-key.js +41 -0
- package/models/setting-key.js.map +1 -0
- package/models/setting-option.js +33 -0
- package/models/setting-option.js.map +1 -0
- package/models/setting-scope.js +36 -0
- package/models/setting-scope.js.map +1 -0
- package/models/setting-type.js +156 -0
- package/models/setting-type.js.map +1 -0
- package/models/setting-value.js +28 -0
- package/models/setting-value.js.map +1 -0
- package/models/settings-query.js +30 -0
- package/models/settings-query.js.map +1 -0
- package/models/settings-snapshot.js +37 -0
- package/models/settings-snapshot.js.map +1 -0
- package/models/shell-clients.js +14 -0
- package/models/shell-clients.js.map +1 -0
- package/models/shell-events.js +25 -0
- package/models/shell-events.js.map +1 -0
- package/models/shell-keys.js +26 -0
- package/models/shell-keys.js.map +1 -0
- package/models/shell-methods.js +54 -0
- package/models/shell-methods.js.map +1 -0
- package/models/shell-notifications.js +17 -0
- package/models/shell-notifications.js.map +1 -0
- package/models/stop-request.js +30 -0
- package/models/stop-request.js.map +1 -0
- package/models/update-process.js +42 -0
- package/models/update-process.js.map +1 -0
- package/models/update-ready.js +35 -0
- package/models/update-ready.js.map +1 -0
- package/models/update-request.js +28 -0
- package/models/update-request.js.map +1 -0
- package/models/update-saved.js +37 -0
- package/models/update-saved.js.map +1 -0
- package/models/web-view-answered.js +43 -0
- package/models/web-view-answered.js.map +1 -0
- package/models/web-view-command.js +79 -0
- package/models/web-view-command.js.map +1 -0
- package/models/web-view-declaration.js +64 -0
- package/models/web-view-declaration.js.map +1 -0
- package/models/web-view-event.js +98 -0
- package/models/web-view-event.js.map +1 -0
- package/models/web-view-events.js +31 -0
- package/models/web-view-events.js.map +1 -0
- package/models/web-view-failure.js +41 -0
- package/models/web-view-failure.js.map +1 -0
- package/models/web-view-info.js +41 -0
- package/models/web-view-info.js.map +1 -0
- package/models/web-view-key.js +58 -0
- package/models/web-view-key.js.map +1 -0
- package/models/web-view-method.js +47 -0
- package/models/web-view-method.js.map +1 -0
- package/models/web-view-navigation.js +34 -0
- package/models/web-view-navigation.js.map +1 -0
- package/models/web-view-pane.js +36 -0
- package/models/web-view-pane.js.map +1 -0
- package/models/web-view-parameter.js +96 -0
- package/models/web-view-parameter.js.map +1 -0
- package/models/window-closed.js +29 -0
- package/models/window-closed.js.map +1 -0
- package/models/window-state-key.js +31 -0
- package/models/window-state-key.js.map +1 -0
- package/models/window-state-value.js +26 -0
- package/models/window-state-value.js.map +1 -0
- package/models/window-state-write.js +30 -0
- package/models/window-state-write.js.map +1 -0
- package/models/wire-message.js +17 -0
- package/models/wire-message.js.map +1 -0
- package/models/work-report.js +35 -0
- package/models/work-report.js.map +1 -0
- package/package.json +40 -3
- package/resources.js +476 -0
- package/resources.js.map +1 -0
- package/services/frame-writer.js +24 -0
- package/services/frame-writer.js.map +1 -0
- package/services/frame.reader.js +47 -0
- package/services/frame.reader.js.map +1 -0
- package/services/link-policy.js +20 -0
- package/services/link-policy.js.map +1 -0
- package/services/wire-contract.js +30 -0
- package/services/wire-contract.js.map +1 -0
- package/services/wire-decoder.js +35 -0
- package/services/wire-decoder.js.map +1 -0
- package/testing/exceptions/unanswered-call.exception.js +17 -0
- package/testing/exceptions/unanswered-call.exception.js.map +1 -0
- package/testing/models/fake-call.js +16 -0
- package/testing/models/fake-call.js.map +1 -0
- package/testing/models/fake.js +122 -0
- package/testing/models/fake.js.map +1 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) Noldova
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,36 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Protocol
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
**Scope:** The local protocol, `src/noldova.desktop.protocol`, that an app's window, its main process, its runtime and its command line speak to each other, under the [runtime rules](../../documents/RUNTIME.md#messages).
|
|
4
|
+
|
|
5
|
+
## 1. Purpose
|
|
6
|
+
|
|
7
|
+
`@noldova/desktop.protocol` holds the messages that cross Noldova Desktop's local connections, their JSON forms and their checks, and nothing that sends them.
|
|
8
|
+
The runtime, the main process, the command line and the window import it, so each side reads and writes the same messages; a module's runtime and window parts import it for the names, settings, notifications, web views and keys they declare or receive.
|
|
9
|
+
It imports only context's core, exceptions and json packages and runs in Node.js and in the browser alike.
|
|
10
|
+
For that reason its source compiles without Node's types: `src/interfaces/url.d.ts` declares only the part of `URL` that `LinkPolicy` uses, which Node and the browser share, so a Node-only API fails to compile instead of failing in the window.
|
|
11
|
+
|
|
12
|
+
## 2. Use
|
|
13
|
+
|
|
14
|
+
An app or module installs it at the exact version its Noldova Desktop version pins, beside the context packages it peers on:
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
import { FrameReader, FrameWriter, Request, WireDecoder } from "@noldova/desktop.protocol";
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Every model checks its values when it is made, reads its JSON form with `fromJson`, which takes any value and names the path of the first field that is missing, invalid or unknown, and writes it with `toJson`.
|
|
21
|
+
The second entry, `@noldova/desktop.protocol/testing`, holds `Fake`, the base of the fakes a test answers member by member, and `UnansweredCallException`, which a fake throws for a member the test gave no answer for.
|
|
22
|
+
|
|
23
|
+
## 3. Contents
|
|
24
|
+
|
|
25
|
+
| Part | What it holds |
|
|
26
|
+
|---|---|
|
|
27
|
+
| Frames | `FrameWriter` writes one message a line and `FrameReader` splits the lines back, each refusing a frame over its maximum length, 16 MiB by default, with `ProtocolException` and `FailureCode.FrameTooLarge`. |
|
|
28
|
+
| Messages | `Handshake`, `Request`, `Response`, `Event` and `Cancel`, the envelopes `WireDecoder` reads from a frame, with `Failure` and its `FailureCode` for a request that fails. |
|
|
29
|
+
| Names | `QualifiedName`, a method's or event's owner and member, such as `desktop.handshake`, and `ShellMethods`, `ShellEvents`, `ShellNotifications` and `ShellClients`, Noldova Desktop's own. |
|
|
30
|
+
| Payloads | The models of Noldova Desktop's own methods and events: modules' status, commands, settings, notifications, file grants, secrets, web views, windows, keys, updates, quitting and agent control. |
|
|
31
|
+
| Checks | `WireContract`, which a module's own models use to refuse unknown fields and to name the field a model refused; `LinkPolicy`, which allows only the links a window may open. |
|
|
32
|
+
|
|
33
|
+
## 4. Failures
|
|
34
|
+
|
|
35
|
+
Every exception the package owns extends `DesktopProtocolException`, which a caller catches to handle any of them.
|
|
36
|
+
`ProtocolException` carries the `FailureCode` of a connection's frames that break the protocol, `FrameTooLarge`, and the maximum length the frame exceeded; a value that isn't valid is refused with context's `ArgumentException` when a model is made and `JsonException`, naming its path, when one is read.
|