@hydranium/protocol 1.0.0-next.7 → 1.0.0-next.71
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 +35 -1
- package/lib/client/data-connection.d.ts +103 -0
- package/lib/client/data-connection.d.ts.map +1 -0
- package/lib/client/data-connection.js +114 -0
- package/lib/client/data-connection.js.map +1 -0
- package/lib/client/data-events.d.ts +9 -1
- package/lib/client/data-events.d.ts.map +1 -1
- package/lib/client/data-events.js +14 -0
- package/lib/client/data-events.js.map +1 -1
- package/lib/client/data-port.d.ts +16 -21
- package/lib/client/data-port.d.ts.map +1 -1
- package/lib/client/data-session.d.ts +83 -78
- package/lib/client/data-session.d.ts.map +1 -1
- package/lib/client/data-session.js +81 -108
- package/lib/client/data-session.js.map +1 -1
- package/lib/client/index.d.ts +10 -7
- package/lib/client/index.d.ts.map +1 -1
- package/lib/client/index.js +10 -7
- package/lib/client/index.js.map +1 -1
- package/lib/client/message-relay.d.ts +8 -2
- package/lib/client/message-relay.d.ts.map +1 -1
- package/lib/client/message-relay.js +10 -4
- package/lib/client/message-relay.js.map +1 -1
- package/lib/client/rpc-connection.d.ts +139 -0
- package/lib/client/rpc-connection.d.ts.map +1 -0
- package/lib/client/rpc-connection.js +171 -0
- package/lib/client/rpc-connection.js.map +1 -0
- package/lib/client-ids.d.ts +41 -0
- package/lib/client-ids.d.ts.map +1 -0
- package/lib/client-ids.js +44 -0
- package/lib/client-ids.js.map +1 -0
- package/lib/data/data-protocol-methods.d.ts +2 -2
- package/lib/data/data-protocol-methods.d.ts.map +1 -1
- package/lib/data/data-protocol-methods.js +6 -1
- package/lib/data/data-protocol-methods.js.map +1 -1
- package/lib/data/data-server-protocol.d.ts +34 -1
- package/lib/data/data-server-protocol.d.ts.map +1 -1
- package/lib/data/events.d.ts +70 -3
- package/lib/data/events.d.ts.map +1 -1
- package/lib/errors.d.ts +25 -6
- package/lib/errors.d.ts.map +1 -1
- package/lib/errors.js +32 -12
- package/lib/errors.js.map +1 -1
- package/lib/index.d.ts +2 -0
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +5 -0
- package/lib/index.js.map +1 -1
- package/lib/messages/index.d.ts +28 -0
- package/lib/messages/index.d.ts.map +1 -0
- package/lib/messages/index.js +52 -0
- package/lib/messages/index.js.map +1 -0
- package/lib/messages/primitives.d.ts +141 -0
- package/lib/messages/primitives.d.ts.map +1 -0
- package/lib/messages/primitives.js +138 -0
- package/lib/messages/primitives.js.map +1 -0
- package/lib/model-server.d.ts +2 -2
- package/lib/model-server.d.ts.map +1 -1
- package/lib/rpc/bind-rpc-methods.d.ts +29 -3
- package/lib/rpc/bind-rpc-methods.d.ts.map +1 -1
- package/lib/rpc/bind-rpc-methods.js +22 -3
- package/lib/rpc/bind-rpc-methods.js.map +1 -1
- package/lib/rpc/create-rpc-proxy.d.ts +7 -0
- package/lib/rpc/create-rpc-proxy.d.ts.map +1 -1
- package/lib/rpc/create-rpc-proxy.js +6 -1
- package/lib/rpc/create-rpc-proxy.js.map +1 -1
- package/lib/testing/catalogue-audit.d.ts +80 -0
- package/lib/testing/catalogue-audit.d.ts.map +1 -0
- package/lib/testing/catalogue-audit.js +94 -0
- package/lib/testing/catalogue-audit.js.map +1 -0
- package/lib/testing/data-doubles.d.ts +11 -12
- package/lib/testing/data-doubles.d.ts.map +1 -1
- package/lib/testing/data-doubles.js +14 -5
- package/lib/testing/data-doubles.js.map +1 -1
- package/lib/testing/index.d.ts +1 -0
- package/lib/testing/index.d.ts.map +1 -1
- package/lib/testing/index.js +4 -1
- package/lib/testing/index.js.map +1 -1
- package/lib/transfer-diagnostic.d.ts +33 -0
- package/lib/transfer-diagnostic.d.ts.map +1 -1
- package/lib/transfer-diagnostic.js +23 -0
- package/lib/transfer-diagnostic.js.map +1 -1
- package/package.json +11 -2
- package/src/client/data-connection.ts +167 -0
- package/src/client/data-events.ts +24 -1
- package/src/client/data-port.ts +16 -22
- package/src/client/data-session.ts +138 -131
- package/src/client/index.ts +10 -7
- package/src/client/message-relay.ts +28 -6
- package/src/client/rpc-connection.ts +230 -0
- package/src/client-ids.ts +45 -0
- package/src/data/data-protocol-methods.ts +6 -3
- package/src/data/data-server-protocol.ts +45 -1
- package/src/data/events.ts +74 -3
- package/src/errors.ts +38 -14
- package/src/index.ts +5 -0
- package/src/messages/index.ts +35 -0
- package/src/messages/primitives.ts +215 -0
- package/src/model-server.ts +2 -2
- package/src/rpc/bind-rpc-methods.ts +49 -4
- package/src/rpc/create-rpc-proxy.ts +14 -1
- package/src/testing/catalogue-audit.ts +111 -0
- package/src/testing/data-doubles.ts +33 -17
- package/src/testing/index.ts +4 -1
- package/src/transfer-diagnostic.ts +40 -0
package/lib/data/events.d.ts
CHANGED
|
@@ -28,10 +28,14 @@ import type { TransferDocument } from '../transfer-document';
|
|
|
28
28
|
* from both `onDocumentUpdated` and `onDocumentSaved`. The framework's own
|
|
29
29
|
* `dispatchPhaseEvent` does NOT emit `'saved'` — saves take the dedicated
|
|
30
30
|
* `DataClientProtocol.onDocumentSaved` channel.
|
|
31
|
-
*
|
|
32
|
-
*
|
|
31
|
+
*
|
|
32
|
+
* Deletion is deliberately NOT a member. An update event carries a built
|
|
33
|
+
* document, which a deleted one has none of, and the phase-driven path that
|
|
34
|
+
* produces these events never runs for a deleted URI — the builder drops the
|
|
35
|
+
* document before deriving the rebuild set. It travels as
|
|
36
|
+
* {@link TransferDocumentDeletedEvent} on its own channel instead.
|
|
33
37
|
*/
|
|
34
|
-
export type TransferDocumentUpdateReason = 'changed' | 'rebuilt' | 'saved'
|
|
38
|
+
export type TransferDocumentUpdateReason = 'changed' | 'rebuilt' | 'saved';
|
|
35
39
|
/**
|
|
36
40
|
* Delivered on the data-server when a document's content (or existence)
|
|
37
41
|
* changed. Subscribers receive this via `DocumentServerProtocol.watchModelDocument`.
|
|
@@ -72,6 +76,69 @@ export interface TransferDocumentSavedEvent<TTransfer extends TransferElement, T
|
|
|
72
76
|
}
|
|
73
77
|
/** Callback shape for `DataClientProtocol.onDocumentSaved`. */
|
|
74
78
|
export type TransferDocumentSavedListener<TTransfer extends TransferElement, TDiagnostic extends TransferDiagnostic = TransferDiagnostic> = (event: TransferDocumentSavedEvent<TTransfer, TDiagnostic>) => void;
|
|
79
|
+
/**
|
|
80
|
+
* Delivered on the data-server when a document's backing file was removed.
|
|
81
|
+
* Carries no document, and cannot: the state a
|
|
82
|
+
* {@link TransferDocumentUpdatedEvent} would have to carry no longer exists by
|
|
83
|
+
* the time anyone can be told. That is also why deletion is not a `reason` on
|
|
84
|
+
* the update stream — `DocumentBuilder.update` drops the document before
|
|
85
|
+
* deriving the rebuild set, so the phase-driven path that produces update
|
|
86
|
+
* events never runs for it.
|
|
87
|
+
*
|
|
88
|
+
* **Delivered for EVERY document, not only watched ones**, unlike
|
|
89
|
+
* `onDocumentUpdated` and `onDocumentSaved`. The test that decides which
|
|
90
|
+
* channels are gated is whether any OTHER source can observe the fact on the
|
|
91
|
+
* least capable host: a browser-hosted client's workspace lives behind the
|
|
92
|
+
* head, so nothing there can see a file disappear, and gating the notification
|
|
93
|
+
* would leave it blind. (A Theia frontend's filesystem watcher would cover it,
|
|
94
|
+
* which is why this is a host argument and not a structure-versus-content one.)
|
|
95
|
+
* A watcher is told about its own document's deletion here too, the update
|
|
96
|
+
* channel being silent for deletions by construction. Filter on {@link uri} if
|
|
97
|
+
* the receiver only cares about documents it opened.
|
|
98
|
+
*
|
|
99
|
+
* A watch survives the deletion, so a file that comes back resumes delivering
|
|
100
|
+
* `onDocumentUpdated` to the same subscribers with no re-subscription. A
|
|
101
|
+
* client that responds by closing its editor releases the watch through
|
|
102
|
+
* `closeModelDocument` as usual.
|
|
103
|
+
*/
|
|
104
|
+
export interface TransferDocumentDeletedEvent {
|
|
105
|
+
/** Canonical URI of the removed document, keyed as the subscription is. */
|
|
106
|
+
readonly uri: string;
|
|
107
|
+
}
|
|
108
|
+
/** Callback shape for `DataClientProtocol.onDocumentDeleted`. */
|
|
109
|
+
export type TransferDocumentDeletedListener = (event: TransferDocumentDeletedEvent) => void;
|
|
110
|
+
/**
|
|
111
|
+
* Delivered on the data-server once per build, naming the documents that reached
|
|
112
|
+
* the configured subscription phase (`DataServerOptions.subscriptionPhase`,
|
|
113
|
+
* `Validated` by default) and that NO client on the connection is watching. Not
|
|
114
|
+
* the integrity-settled landmark, which is a different point and a different
|
|
115
|
+
* word in this framework.
|
|
116
|
+
*
|
|
117
|
+
* The complement of {@link TransferDocumentUpdatedEvent}, which is gated per
|
|
118
|
+
* URI: together the two cover every document a build touched. This one exists
|
|
119
|
+
* for the case no source outside the server can observe — a document rebuilt
|
|
120
|
+
* because something it DEPENDS ON changed. Its own file never changed, so a
|
|
121
|
+
* filesystem watcher cannot see it, and it has no subscriber, so the update
|
|
122
|
+
* channel does not report it. A consumer showing data derived from such a
|
|
123
|
+
* document (a tree label, a decorator) would otherwise hold a stale value with
|
|
124
|
+
* nothing to invalidate it.
|
|
125
|
+
*
|
|
126
|
+
* Carries URIs and no documents: a recipient re-reads what it displays, through
|
|
127
|
+
* `getModelDocument` or its own request. That keeps the bandwidth property the
|
|
128
|
+
* per-URI subscription exists for, without gating the message.
|
|
129
|
+
*
|
|
130
|
+
* Not sent when the set is empty, which is the normal case while editing — the
|
|
131
|
+
* document being edited is watched by its own editor and therefore excluded.
|
|
132
|
+
* Workspace initialisation sends nothing either: it does not build to the
|
|
133
|
+
* subscription phase. The largest message a workspace can produce is therefore
|
|
134
|
+
* a whole-workspace rebuild at that phase, which is one message of URIs.
|
|
135
|
+
*/
|
|
136
|
+
export interface TransferDocumentsBuiltEvent {
|
|
137
|
+
/** Canonical URIs, keyed as subscriptions are. Never empty. */
|
|
138
|
+
readonly uris: readonly string[];
|
|
139
|
+
}
|
|
140
|
+
/** Callback shape for `DataClientProtocol.onDocumentsBuilt`. */
|
|
141
|
+
export type TransferDocumentsBuiltListener = (event: TransferDocumentsBuiltEvent) => void;
|
|
75
142
|
/**
|
|
76
143
|
* Why a project-change event fired. `added` — the project was newly
|
|
77
144
|
* registered (descriptor discovered); `updated` — the project's
|
package/lib/data/events.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/data/events.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAE7D
|
|
1
|
+
{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/data/events.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAE7D;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,MAAM,4BAA4B,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC;AAE3E;;;;;;GAMG;AACH,MAAM,WAAW,4BAA4B,CAC1C,SAAS,SAAS,eAAe,EACjC,WAAW,SAAS,kBAAkB,GAAG,kBAAkB;IAE3D,QAAQ,EAAE,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IACnD,iEAAiE;IACjE,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,4BAA4B,CAAC;CACvC;AAED,iEAAiE;AACjE,MAAM,MAAM,+BAA+B,CACxC,SAAS,SAAS,eAAe,EACjC,WAAW,SAAS,kBAAkB,GAAG,kBAAkB,IAC1D,CAAC,KAAK,EAAE,4BAA4B,CAAC,SAAS,EAAE,WAAW,CAAC,KAAK,IAAI,CAAC;AAE1E;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,0BAA0B,CACxC,SAAS,SAAS,eAAe,EACjC,WAAW,SAAS,kBAAkB,GAAG,kBAAkB;IAE3D,QAAQ,EAAE,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IACnD;;;;;OAKG;IACH,cAAc,EAAE,MAAM,CAAC;CACzB;AAED,+DAA+D;AAC/D,MAAM,MAAM,6BAA6B,CACtC,SAAS,SAAS,eAAe,EACjC,WAAW,SAAS,kBAAkB,GAAG,kBAAkB,IAC1D,CAAC,KAAK,EAAE,0BAA0B,CAAC,SAAS,EAAE,WAAW,CAAC,KAAK,IAAI,CAAC;AAExE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,WAAW,4BAA4B;IAC1C,2EAA2E;IAC3E,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;CACvB;AAED,iEAAiE;AACjE,MAAM,MAAM,+BAA+B,GAAG,CAAC,KAAK,EAAE,4BAA4B,KAAK,IAAI,CAAC;AAE5F;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,WAAW,2BAA2B;IACzC,+DAA+D;IAC/D,QAAQ,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,CAAC;CACnC;AAED,gEAAgE;AAChE,MAAM,MAAM,8BAA8B,GAAG,CAAC,KAAK,EAAE,2BAA2B,KAAK,IAAI,CAAC;AAE1F;;;;;;;GAOG;AACH,MAAM,MAAM,mBAAmB,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,CAAC;AAElE;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,oBAAoB,CAAC,QAAQ,SAAS,OAAO,GAAG,OAAO;IACrE,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC;IAC3B,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAC;CACvC;AAED,iEAAiE;AACjE,MAAM,MAAM,uBAAuB,CAAC,QAAQ,SAAS,OAAO,GAAG,OAAO,IAAI,CAAC,KAAK,EAAE,oBAAoB,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC"}
|
package/lib/errors.d.ts
CHANGED
|
@@ -7,6 +7,16 @@
|
|
|
7
7
|
* SPDX-License-Identifier: MIT
|
|
8
8
|
********************************************************************************/
|
|
9
9
|
import { ResponseError } from 'vscode-jsonrpc';
|
|
10
|
+
import { type HydraniumMessageData } from './messages/primitives';
|
|
11
|
+
/**
|
|
12
|
+
* The catalogue declaration behind {@link ConflictError}'s sentence.
|
|
13
|
+
*
|
|
14
|
+
* Its English must keep containing {@link CONFLICT_ERROR_MESSAGE_MARKER}: the
|
|
15
|
+
* marker is tier 3 of {@link isConflictError}'s ladder, and it matches on text.
|
|
16
|
+
* That tier only ever works untranslated, which is why it is the last resort
|
|
17
|
+
* behind the numeric code rather than the primary check.
|
|
18
|
+
*/
|
|
19
|
+
export declare const STALE_BASED_UPDATE: import("./messages/primitives").MessageDefinition<"Stale-based update for {uri}: expected v{expectedVersion}, server is at v{actualVersion}">;
|
|
10
20
|
/**
|
|
11
21
|
* Application-specific JSON-RPC error code for {@link ConflictError}.
|
|
12
22
|
* Outside the reserved range (-32768 .. -32000) per JSON-RPC 2.0.
|
|
@@ -21,12 +31,12 @@ export declare const CONFLICT_ERROR_CODE = 1001;
|
|
|
21
31
|
* Structured payload carried in {@link ConflictError.data}, and the only place
|
|
22
32
|
* a post-RPC caller can read the version mismatch from.
|
|
23
33
|
*/
|
|
24
|
-
export interface ConflictErrorData {
|
|
34
|
+
export interface ConflictErrorData extends HydraniumMessageData {
|
|
25
35
|
readonly uri: string;
|
|
26
36
|
/** The based-on version the caller authored against. */
|
|
27
|
-
readonly
|
|
37
|
+
readonly expectedVersion: number;
|
|
28
38
|
/** The server's current text-document version at the time of the throw. */
|
|
29
|
-
readonly
|
|
39
|
+
readonly actualVersion: number;
|
|
30
40
|
}
|
|
31
41
|
/**
|
|
32
42
|
* Thrown by `ModelService.update` / `ModelService.save` when the caller-
|
|
@@ -60,10 +70,19 @@ export interface ConflictErrorData {
|
|
|
60
70
|
* No auto-retry or auto-merge ships by default.
|
|
61
71
|
*/
|
|
62
72
|
export declare class ConflictError extends ResponseError<ConflictErrorData> {
|
|
63
|
-
constructor(uri: string,
|
|
73
|
+
constructor(uri: string, expectedVersion: number, actualVersion: number);
|
|
64
74
|
get uri(): string;
|
|
65
|
-
|
|
66
|
-
|
|
75
|
+
/**
|
|
76
|
+
* The based-on version the caller authored against.
|
|
77
|
+
*
|
|
78
|
+
* Must not be renamed to `expected`, nor its sibling to `actual`: a test
|
|
79
|
+
* reporter reads an error carrying both as an assertion failure, and
|
|
80
|
+
* vitest's formatter then ASSIGNS to them, which throws on an accessor and
|
|
81
|
+
* replaces the real failure with a `TypeError`.
|
|
82
|
+
*/
|
|
83
|
+
get expectedVersion(): number;
|
|
84
|
+
/** The server's version at the time of the throw. Not `actual` — see {@link expectedVersion}. */
|
|
85
|
+
get actualVersion(): number;
|
|
67
86
|
}
|
|
68
87
|
/**
|
|
69
88
|
* Type guard for {@link ConflictError}. Detection ladder:
|
package/lib/errors.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;
|
|
1
|
+
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,EAAiB,KAAK,oBAAoB,EAAe,MAAM,uBAAuB,CAAC;AAE9F;;;;;;;GAOG;AACH,eAAO,MAAM,kBAAkB,+IAG9B,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB,OAAO,CAAC;AAExC;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,oBAAoB;IAC5D,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,wDAAwD;IACxD,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,2EAA2E;IAC3E,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;CACjC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,qBAAa,aAAc,SAAQ,aAAa,CAAC,iBAAiB,CAAC;gBACpD,GAAG,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM;IAgBvE,IAAI,GAAG,IAAI,MAAM,CAEhB;IAED;;;;;;;OAOG;IACH,IAAI,eAAe,IAAI,MAAM,CAE5B;IAED,iGAAiG;IACjG,IAAI,aAAa,IAAI,MAAM,CAE1B;CACH;AAOD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,aAAa,CAYtE"}
|
package/lib/errors.js
CHANGED
|
@@ -8,9 +8,19 @@
|
|
|
8
8
|
* SPDX-License-Identifier: MIT
|
|
9
9
|
********************************************************************************/
|
|
10
10
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
11
|
-
exports.ConflictError = exports.CONFLICT_ERROR_CODE = void 0;
|
|
11
|
+
exports.ConflictError = exports.CONFLICT_ERROR_CODE = exports.STALE_BASED_UPDATE = void 0;
|
|
12
12
|
exports.isConflictError = isConflictError;
|
|
13
13
|
const vscode_jsonrpc_1 = require("vscode-jsonrpc");
|
|
14
|
+
const primitives_1 = require("./messages/primitives");
|
|
15
|
+
/**
|
|
16
|
+
* The catalogue declaration behind {@link ConflictError}'s sentence.
|
|
17
|
+
*
|
|
18
|
+
* Its English must keep containing {@link CONFLICT_ERROR_MESSAGE_MARKER}: the
|
|
19
|
+
* marker is tier 3 of {@link isConflictError}'s ladder, and it matches on text.
|
|
20
|
+
* That tier only ever works untranslated, which is why it is the last resort
|
|
21
|
+
* behind the numeric code rather than the primary check.
|
|
22
|
+
*/
|
|
23
|
+
exports.STALE_BASED_UPDATE = (0, primitives_1.defineMessage)('hydranium/protocol/stale-based-update', 'Stale-based update for {uri}: expected v{expectedVersion}, server is at v{actualVersion}');
|
|
14
24
|
/**
|
|
15
25
|
* Application-specific JSON-RPC error code for {@link ConflictError}.
|
|
16
26
|
* Outside the reserved range (-32768 .. -32000) per JSON-RPC 2.0.
|
|
@@ -53,28 +63,38 @@ exports.CONFLICT_ERROR_CODE = 1001;
|
|
|
53
63
|
* No auto-retry or auto-merge ships by default.
|
|
54
64
|
*/
|
|
55
65
|
class ConflictError extends vscode_jsonrpc_1.ResponseError {
|
|
56
|
-
constructor(uri,
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
});
|
|
66
|
+
constructor(uri, expectedVersion, actualVersion) {
|
|
67
|
+
const params = { uri, expectedVersion, actualVersion };
|
|
68
|
+
// The identity rides alongside the typed payload rather than replacing
|
|
69
|
+
// it: `isConflictError`'s name check is surface an adopter may bind, so
|
|
70
|
+
// adding the identity widens the payload rather than reshaping it.
|
|
71
|
+
super(exports.CONFLICT_ERROR_CODE, exports.STALE_BASED_UPDATE.format(params), { ...params, ...(0, primitives_1.messageData)(exports.STALE_BASED_UPDATE, params) });
|
|
62
72
|
this.name = 'ConflictError';
|
|
63
73
|
// ResponseError's constructor calls `Object.setPrototypeOf(this,
|
|
64
74
|
// ResponseError.prototype)` to keep its own prototype chain intact across
|
|
65
75
|
// transpilation targets; that resets us to ResponseError, hiding the
|
|
66
76
|
// ConflictError-specific getters. Restore the prototype here so
|
|
67
|
-
// `err.uri` / `.
|
|
77
|
+
// `err.uri` / `.expectedVersion` / `.actualVersion` resolve through this
|
|
78
|
+
// class.
|
|
68
79
|
Object.setPrototypeOf(this, ConflictError.prototype);
|
|
69
80
|
}
|
|
70
81
|
get uri() {
|
|
71
82
|
return this.data.uri;
|
|
72
83
|
}
|
|
73
|
-
|
|
74
|
-
|
|
84
|
+
/**
|
|
85
|
+
* The based-on version the caller authored against.
|
|
86
|
+
*
|
|
87
|
+
* Must not be renamed to `expected`, nor its sibling to `actual`: a test
|
|
88
|
+
* reporter reads an error carrying both as an assertion failure, and
|
|
89
|
+
* vitest's formatter then ASSIGNS to them, which throws on an accessor and
|
|
90
|
+
* replaces the real failure with a `TypeError`.
|
|
91
|
+
*/
|
|
92
|
+
get expectedVersion() {
|
|
93
|
+
return this.data.expectedVersion;
|
|
75
94
|
}
|
|
76
|
-
|
|
77
|
-
|
|
95
|
+
/** The server's version at the time of the throw. Not `actual` — see {@link expectedVersion}. */
|
|
96
|
+
get actualVersion() {
|
|
97
|
+
return this.data.actualVersion;
|
|
78
98
|
}
|
|
79
99
|
}
|
|
80
100
|
exports.ConflictError = ConflictError;
|
package/lib/errors.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":";AAAA;;;;;;;kFAOkF;;;
|
|
1
|
+
{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":";AAAA;;;;;;;kFAOkF;;;AAmIlF,0CAYC;AA7ID,mDAA+C;AAC/C,sDAA8F;AAE9F;;;;;;;GAOG;AACU,QAAA,kBAAkB,GAAG,IAAA,0BAAa,EAC5C,uCAAuC,EACvC,0FAA0F,CAC5F,CAAC;AAEF;;;;;;;;GAQG;AACU,QAAA,mBAAmB,GAAG,IAAI,CAAC;AAcxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAa,aAAc,SAAQ,8BAAgC;IAChE,YAAY,GAAW,EAAE,eAAuB,EAAE,aAAqB;QACpE,MAAM,MAAM,GAAG,EAAE,GAAG,EAAE,eAAe,EAAE,aAAa,EAAE,CAAC;QACvD,uEAAuE;QACvE,wEAAwE;QACxE,mEAAmE;QACnE,KAAK,CAAC,2BAAmB,EAAE,0BAAkB,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,GAAG,MAAM,EAAE,GAAG,IAAA,wBAAW,EAAC,0BAAkB,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;QACzH,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAC5B,iEAAiE;QACjE,0EAA0E;QAC1E,qEAAqE;QACrE,gEAAgE;QAChE,yEAAyE;QACzE,SAAS;QACT,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;IACxD,CAAC;IAED,IAAI,GAAG;QACJ,OAAO,IAAI,CAAC,IAAK,CAAC,GAAG,CAAC;IACzB,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,eAAe;QAChB,OAAO,IAAI,CAAC,IAAK,CAAC,eAAe,CAAC;IACrC,CAAC;IAED,iGAAiG;IACjG,IAAI,aAAa;QACd,OAAO,IAAI,CAAC,IAAK,CAAC,aAAa,CAAC;IACnC,CAAC;CACH;AArCD,sCAqCC;AAED;;mCAEmC;AACnC,MAAM,6BAA6B,GAAG,yBAAyB,CAAC;AAEhE;;;;;;;;;;;;;;GAcG;AACH,SAAgB,eAAe,CAAC,KAAc;IAC3C,IAAI,CAAC,CAAC,KAAK,YAAY,KAAK,CAAC,EAAE,CAAC;QAC7B,OAAO,KAAK,CAAC;IAChB,CAAC;IACD,IAAI,KAAK,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;QAClC,OAAO,IAAI,CAAC;IACf,CAAC;IACD,MAAM,IAAI,GAAI,KAAyC,CAAC,IAAI,CAAC;IAC7D,IAAI,IAAI,KAAK,2BAAmB,EAAE,CAAC;QAChC,OAAO,IAAI,CAAC;IACf,CAAC;IACD,OAAO,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,6BAA6B,CAAC,CAAC;AACrG,CAAC"}
|
package/lib/index.d.ts
CHANGED
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
********************************************************************************/
|
|
9
9
|
export * from './abstract-logger';
|
|
10
10
|
export * from './client';
|
|
11
|
+
export * from './client-ids';
|
|
11
12
|
export * from './clock';
|
|
12
13
|
export * from './data';
|
|
13
14
|
export * from './browser-runtime';
|
|
@@ -16,6 +17,7 @@ export * from './errors';
|
|
|
16
17
|
export * from './host-diagnostics';
|
|
17
18
|
export * from './logger';
|
|
18
19
|
export * from './latency-collector';
|
|
20
|
+
export * from './messages/primitives';
|
|
19
21
|
export * from './patch-merge';
|
|
20
22
|
export * from './noop-logger';
|
|
21
23
|
export * from './observable-value';
|
package/lib/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AASlF,cAAc,mBAAmB,CAAC;AAClC,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,oBAAoB,CAAC;AACnC,cAAc,UAAU,CAAC;AACzB,cAAc,qBAAqB,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AASlF,cAAc,mBAAmB,CAAC;AAClC,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,oBAAoB,CAAC;AACnC,cAAc,UAAU,CAAC;AACzB,cAAc,qBAAqB,CAAC;AAIpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC;AAC1B,cAAc,OAAO,CAAC;AACtB,cAAc,OAAO,CAAC;AACtB,cAAc,QAAQ,CAAC"}
|
package/lib/index.js
CHANGED
|
@@ -30,6 +30,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
30
30
|
// every production bundle that imports the root.
|
|
31
31
|
__exportStar(require("./abstract-logger"), exports);
|
|
32
32
|
__exportStar(require("./client"), exports);
|
|
33
|
+
__exportStar(require("./client-ids"), exports);
|
|
33
34
|
__exportStar(require("./clock"), exports);
|
|
34
35
|
__exportStar(require("./data"), exports);
|
|
35
36
|
__exportStar(require("./browser-runtime"), exports);
|
|
@@ -38,6 +39,10 @@ __exportStar(require("./errors"), exports);
|
|
|
38
39
|
__exportStar(require("./host-diagnostics"), exports);
|
|
39
40
|
__exportStar(require("./logger"), exports);
|
|
40
41
|
__exportStar(require("./latency-collector"), exports);
|
|
42
|
+
// The primitives only. The `./messages` subpath additionally enumerates this
|
|
43
|
+
// package's own declarations, which the root barrel already re-exports through
|
|
44
|
+
// the modules that raise them.
|
|
45
|
+
__exportStar(require("./messages/primitives"), exports);
|
|
41
46
|
__exportStar(require("./patch-merge"), exports);
|
|
42
47
|
__exportStar(require("./noop-logger"), exports);
|
|
43
48
|
__exportStar(require("./observable-value"), exports);
|
package/lib/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;kFAOkF;;;;;;;;;;;;;;;;AAElF,kFAAkF;AAClF,+EAA+E;AAC/E,8EAA8E;AAC9E,+EAA+E;AAC/E,4EAA4E;AAC5E,iDAAiD;AAEjD,oDAAkC;AAClC,2CAAyB;AACzB,0CAAwB;AACxB,yCAAuB;AACvB,oDAAkC;AAClC,8CAA4B;AAC5B,2CAAyB;AACzB,qDAAmC;AACnC,2CAAyB;AACzB,sDAAoC;AACpC,gDAA8B;AAC9B,gDAA8B;AAC9B,qDAAmC;AACnC,oDAAkC;AAClC,8CAA4B;AAC5B,2CAAyB;AACzB,wDAAsC;AACtC,qDAAmC;AACnC,kDAAgC;AAChC,sDAAoC;AACpC,iDAA+B;AAC/B,4CAA0B;AAC1B,wCAAsB;AACtB,wCAAsB;AACtB,yCAAuB"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;kFAOkF;;;;;;;;;;;;;;;;AAElF,kFAAkF;AAClF,+EAA+E;AAC/E,8EAA8E;AAC9E,+EAA+E;AAC/E,4EAA4E;AAC5E,iDAAiD;AAEjD,oDAAkC;AAClC,2CAAyB;AACzB,+CAA6B;AAC7B,0CAAwB;AACxB,yCAAuB;AACvB,oDAAkC;AAClC,8CAA4B;AAC5B,2CAAyB;AACzB,qDAAmC;AACnC,2CAAyB;AACzB,sDAAoC;AACpC,6EAA6E;AAC7E,+EAA+E;AAC/E,+BAA+B;AAC/B,wDAAsC;AACtC,gDAA8B;AAC9B,gDAA8B;AAC9B,qDAAmC;AACnC,oDAAkC;AAClC,8CAA4B;AAC5B,2CAAyB;AACzB,wDAAsC;AACtC,qDAAmC;AACnC,kDAAgC;AAChC,sDAAoC;AACpC,iDAA+B;AAC/B,4CAA0B;AAC1B,wCAAsB;AACtB,wCAAsB;AACtB,yCAAuB"}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
/********************************************************************************
|
|
2
|
+
* Copyright (c) 2026 CrossBreeze, EclipseSource and others.
|
|
3
|
+
*
|
|
4
|
+
* This program and the accompanying materials are made available under the
|
|
5
|
+
* terms of the MIT License which is available in the project root.
|
|
6
|
+
*
|
|
7
|
+
* SPDX-License-Identifier: MIT
|
|
8
|
+
********************************************************************************/
|
|
9
|
+
/**
|
|
10
|
+
* The message-externalization mechanism, plus every user-facing message
|
|
11
|
+
* `@hydranium/protocol` itself raises.
|
|
12
|
+
*
|
|
13
|
+
* Declarations stay beside their call sites and are re-exported here, so this is
|
|
14
|
+
* enumeration rather than centralization: a code's package segment has to name
|
|
15
|
+
* the package that raises it, and a shared module would make that segment a lie
|
|
16
|
+
* for every message in it. Adding a message therefore touches the file that
|
|
17
|
+
* raises it and this list, and nothing else.
|
|
18
|
+
*
|
|
19
|
+
* A barrel makes every code and English default public API, so renaming a code
|
|
20
|
+
* is a breaking change. That was already true — an adopter's catalogue keys on
|
|
21
|
+
* these codes either way — but it is now in the type system rather than implicit.
|
|
22
|
+
* The English is a fallback, not a contract; the code is the contract.
|
|
23
|
+
*/
|
|
24
|
+
export * from './primitives';
|
|
25
|
+
export { STALE_BASED_UPDATE } from '../errors';
|
|
26
|
+
export { DATA_SERVER_CONNECT_FAILED, DATA_SERVER_NOT_READY } from '../client/rpc-connection';
|
|
27
|
+
export { RELAY_REPLAY_FAILED, RELAY_TRANSPORT_OPEN_FAILED, RELAY_TRANSPORT_READ_FAILED, RELAY_TRANSPORT_WRITE_FAILED } from '../client/message-relay';
|
|
28
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/messages/index.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF;;;;;;;;;;;;;;GAcG;AAEH,cAAc,cAAc,CAAC;AAE7B,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EAAE,0BAA0B,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AAC7F,OAAO,EACJ,mBAAmB,EACnB,2BAA2B,EAC3B,2BAA2B,EAC3B,4BAA4B,EAC9B,MAAM,yBAAyB,CAAC"}
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/********************************************************************************
|
|
3
|
+
* Copyright (c) 2026 CrossBreeze, EclipseSource and others.
|
|
4
|
+
*
|
|
5
|
+
* This program and the accompanying materials are made available under the
|
|
6
|
+
* terms of the MIT License which is available in the project root.
|
|
7
|
+
*
|
|
8
|
+
* SPDX-License-Identifier: MIT
|
|
9
|
+
********************************************************************************/
|
|
10
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
11
|
+
if (k2 === undefined) k2 = k;
|
|
12
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
13
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
14
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
15
|
+
}
|
|
16
|
+
Object.defineProperty(o, k2, desc);
|
|
17
|
+
}) : (function(o, m, k, k2) {
|
|
18
|
+
if (k2 === undefined) k2 = k;
|
|
19
|
+
o[k2] = m[k];
|
|
20
|
+
}));
|
|
21
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
22
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
23
|
+
};
|
|
24
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
+
exports.RELAY_TRANSPORT_WRITE_FAILED = exports.RELAY_TRANSPORT_READ_FAILED = exports.RELAY_TRANSPORT_OPEN_FAILED = exports.RELAY_REPLAY_FAILED = exports.DATA_SERVER_NOT_READY = exports.DATA_SERVER_CONNECT_FAILED = exports.STALE_BASED_UPDATE = void 0;
|
|
26
|
+
/**
|
|
27
|
+
* The message-externalization mechanism, plus every user-facing message
|
|
28
|
+
* `@hydranium/protocol` itself raises.
|
|
29
|
+
*
|
|
30
|
+
* Declarations stay beside their call sites and are re-exported here, so this is
|
|
31
|
+
* enumeration rather than centralization: a code's package segment has to name
|
|
32
|
+
* the package that raises it, and a shared module would make that segment a lie
|
|
33
|
+
* for every message in it. Adding a message therefore touches the file that
|
|
34
|
+
* raises it and this list, and nothing else.
|
|
35
|
+
*
|
|
36
|
+
* A barrel makes every code and English default public API, so renaming a code
|
|
37
|
+
* is a breaking change. That was already true — an adopter's catalogue keys on
|
|
38
|
+
* these codes either way — but it is now in the type system rather than implicit.
|
|
39
|
+
* The English is a fallback, not a contract; the code is the contract.
|
|
40
|
+
*/
|
|
41
|
+
__exportStar(require("./primitives"), exports);
|
|
42
|
+
var errors_1 = require("../errors");
|
|
43
|
+
Object.defineProperty(exports, "STALE_BASED_UPDATE", { enumerable: true, get: function () { return errors_1.STALE_BASED_UPDATE; } });
|
|
44
|
+
var rpc_connection_1 = require("../client/rpc-connection");
|
|
45
|
+
Object.defineProperty(exports, "DATA_SERVER_CONNECT_FAILED", { enumerable: true, get: function () { return rpc_connection_1.DATA_SERVER_CONNECT_FAILED; } });
|
|
46
|
+
Object.defineProperty(exports, "DATA_SERVER_NOT_READY", { enumerable: true, get: function () { return rpc_connection_1.DATA_SERVER_NOT_READY; } });
|
|
47
|
+
var message_relay_1 = require("../client/message-relay");
|
|
48
|
+
Object.defineProperty(exports, "RELAY_REPLAY_FAILED", { enumerable: true, get: function () { return message_relay_1.RELAY_REPLAY_FAILED; } });
|
|
49
|
+
Object.defineProperty(exports, "RELAY_TRANSPORT_OPEN_FAILED", { enumerable: true, get: function () { return message_relay_1.RELAY_TRANSPORT_OPEN_FAILED; } });
|
|
50
|
+
Object.defineProperty(exports, "RELAY_TRANSPORT_READ_FAILED", { enumerable: true, get: function () { return message_relay_1.RELAY_TRANSPORT_READ_FAILED; } });
|
|
51
|
+
Object.defineProperty(exports, "RELAY_TRANSPORT_WRITE_FAILED", { enumerable: true, get: function () { return message_relay_1.RELAY_TRANSPORT_WRITE_FAILED; } });
|
|
52
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/messages/index.ts"],"names":[],"mappings":";AAAA;;;;;;;kFAOkF;;;;;;;;;;;;;;;;;AAElF;;;;;;;;;;;;;;GAcG;AAEH,+CAA6B;AAE7B,oCAA+C;AAAtC,4GAAA,kBAAkB,OAAA;AAC3B,2DAA6F;AAApF,4HAAA,0BAA0B,OAAA;AAAE,uHAAA,qBAAqB,OAAA;AAC1D,yDAKiC;AAJ9B,oHAAA,mBAAmB,OAAA;AACnB,4HAAA,2BAA2B,OAAA;AAC3B,4HAAA,2BAA2B,OAAA;AAC3B,6HAAA,4BAA4B,OAAA"}
|
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
/********************************************************************************
|
|
2
|
+
* Copyright (c) 2026 CrossBreeze, EclipseSource and others.
|
|
3
|
+
*
|
|
4
|
+
* This program and the accompanying materials are made available under the
|
|
5
|
+
* terms of the MIT License which is available in the project root.
|
|
6
|
+
*
|
|
7
|
+
* SPDX-License-Identifier: MIT
|
|
8
|
+
********************************************************************************/
|
|
9
|
+
import { ResponseError } from 'vscode-jsonrpc';
|
|
10
|
+
/**
|
|
11
|
+
* The framework externalizes user-facing strings and SELECTS no locale: it
|
|
12
|
+
* relays the one its client declared and renders with whatever templates the
|
|
13
|
+
* adopter installed, defaulting to its English. Every such string carries a
|
|
14
|
+
* stable code beside that English, and exactly one side renders it — the side
|
|
15
|
+
* that knows the reading user's language.
|
|
16
|
+
*
|
|
17
|
+
* Which side that is depends on the message, not on the package. A server
|
|
18
|
+
* message is rendered by the server, at the one seam every carrier passes
|
|
19
|
+
* through, in the locale it was handed at init. A message the client tier raises
|
|
20
|
+
* is rendered there, because those fire when the server is unreachable. Nothing
|
|
21
|
+
* is rendered twice: two renders of one sentence are two authorities over it,
|
|
22
|
+
* and they diverge on the first reword.
|
|
23
|
+
*
|
|
24
|
+
* Codes are `hydranium/<unscoped-package>/<name>`. The package segment locates
|
|
25
|
+
* the declaration, so a message is declared in the package that raises it and a
|
|
26
|
+
* code never names a package it does not live in. `.` and `:` are forbidden in a
|
|
27
|
+
* segment: they are i18next's default key and namespace separators, where either
|
|
28
|
+
* silently becomes a nested lookup that misses.
|
|
29
|
+
*/
|
|
30
|
+
export type MessageParams = Readonly<Record<string, string | number>>;
|
|
31
|
+
type Placeholder<S extends string> = S extends `${string}{${infer Name}}${infer Rest}` ? Name | Placeholder<Rest> : never;
|
|
32
|
+
export type ParamsOf<S extends string> = [Placeholder<S>] extends [never] ? Record<never, never> : Readonly<Record<Placeholder<S>, string | number>>;
|
|
33
|
+
/** Required exactly when the text has placeholders, absent when it does not. */
|
|
34
|
+
export type ParamsArg<S extends string> = [Placeholder<S>] extends [never] ? [] : [params: ParamsOf<S>];
|
|
35
|
+
/**
|
|
36
|
+
* Rejects a text argument already widened to `string`. Load-bearing rather than
|
|
37
|
+
* defensive: the whole compile-time guarantee is conditional on `S` inferring a
|
|
38
|
+
* literal, and for a concatenated or pre-widened text the placeholder set
|
|
39
|
+
* silently becomes empty, `format()` accepts no arguments, and the missing
|
|
40
|
+
* substitution surfaces only at runtime.
|
|
41
|
+
*/
|
|
42
|
+
export type LiteralText<S extends string> = string extends S ? never : S;
|
|
43
|
+
export interface MessageDefinition<S extends string> {
|
|
44
|
+
readonly code: string;
|
|
45
|
+
readonly text: S;
|
|
46
|
+
format(...args: ParamsArg<S>): string;
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* Declare a message. Placeholder names are inferred from `text` rather than
|
|
50
|
+
* declared again in a type argument: a second spelling of every name is the
|
|
51
|
+
* repetition that drifts, since adding a placeholder to the sentence and not to
|
|
52
|
+
* the type compiles.
|
|
53
|
+
*/
|
|
54
|
+
export declare function defineMessage<S extends string>(code: string, text: LiteralText<S>): MessageDefinition<S>;
|
|
55
|
+
/**
|
|
56
|
+
* Substitute `{name}` tokens, leaving an unfilled token in place.
|
|
57
|
+
*
|
|
58
|
+
* It must not throw. This runs over an adopter's translation as well as our own
|
|
59
|
+
* text, so a typo in a foreign catalogue has to degrade to a slightly wrong
|
|
60
|
+
* sentence rather than raise inside a toast render. Re-scanning the result to
|
|
61
|
+
* detect an unfilled token is what an earlier form did, and it cannot work:
|
|
62
|
+
* `String.replace` does not rescan replacement text, so the check could not tell
|
|
63
|
+
* an unfilled placeholder from user data shaped like one — an element literally
|
|
64
|
+
* named `{separator}` crashed at the authoring site.
|
|
65
|
+
*/
|
|
66
|
+
export declare function interpolate(template: string, params: MessageParams): string;
|
|
67
|
+
export interface MessageIdentity {
|
|
68
|
+
readonly code: string;
|
|
69
|
+
readonly params: MessageParams;
|
|
70
|
+
}
|
|
71
|
+
/**
|
|
72
|
+
* Envelope for a protocol `data` field. Namespaced under one key so it co-exists
|
|
73
|
+
* with a carrier's own `data` conventions rather than occupying `data` itself.
|
|
74
|
+
*/
|
|
75
|
+
export interface HydraniumMessageData {
|
|
76
|
+
readonly hydranium: MessageIdentity;
|
|
77
|
+
}
|
|
78
|
+
/** An identity plus its resolved English — everything a renderer needs, on any carrier. */
|
|
79
|
+
export interface ResolvedMessage extends MessageIdentity {
|
|
80
|
+
readonly text: string;
|
|
81
|
+
}
|
|
82
|
+
export declare function messageData<S extends string>(message: MessageDefinition<S>, ...args: ParamsArg<S>): HydraniumMessageData;
|
|
83
|
+
/**
|
|
84
|
+
* Identity plus resolved English, for a hand-off carrying a value rather than a
|
|
85
|
+
* protocol field. The result is structured-clone safe, so it survives a process
|
|
86
|
+
* hop where one intervenes and costs nothing where none does.
|
|
87
|
+
*/
|
|
88
|
+
export declare function resolve<S extends string>(message: MessageDefinition<S>, ...args: ParamsArg<S>): ResolvedMessage;
|
|
89
|
+
/**
|
|
90
|
+
* Validates every field {@link MessageIdentity} declares, `params` included.
|
|
91
|
+
* A guard over foreign input that checks only `code` while declaring `params`
|
|
92
|
+
* non-optional hands `undefined` to the renderer, which fails with the worst
|
|
93
|
+
* polarity available: invisible in English, crashing only once a translation is
|
|
94
|
+
* loaded.
|
|
95
|
+
*/
|
|
96
|
+
export declare function hasMessageIdentity(data: unknown): data is HydraniumMessageData;
|
|
97
|
+
/**
|
|
98
|
+
* A type alias rather than a subclass. Only `code`, `message` and `data` cross
|
|
99
|
+
* the wire, so a subclass buys nothing there: `instanceof` does not survive
|
|
100
|
+
* reconstruction, and the subclass costs an `Object.setPrototypeOf` in every
|
|
101
|
+
* constructor purely to undo what `ResponseError`'s own constructor does.
|
|
102
|
+
*/
|
|
103
|
+
export type HydraniumResponseError = ResponseError<HydraniumMessageData>;
|
|
104
|
+
/**
|
|
105
|
+
* The numeric `code` and the message's catalogue code are unrelated and both are
|
|
106
|
+
* needed: `ResponseError.code` is an `integer`, so it cannot hold a
|
|
107
|
+
* `hydranium/…` key, and it is what a caller switches on after reconstruction.
|
|
108
|
+
*/
|
|
109
|
+
export declare function messageError<S extends string>(code: number, message: MessageDefinition<S>, ...params: ParamsArg<S>): HydraniumResponseError;
|
|
110
|
+
/**
|
|
111
|
+
* Render on the side that knows the reading user's locale. `translations` is
|
|
112
|
+
* whatever flat `code → template` map the host exposes; omitting it is how an
|
|
113
|
+
* adopter without i18n opts out, and yields the English.
|
|
114
|
+
*/
|
|
115
|
+
export declare function renderFrameworkMessage(message: ResolvedMessage, translations?: Record<string, string>): string;
|
|
116
|
+
export declare function resolvedFromResponseError(error: ResponseError<unknown>): ResolvedMessage | undefined;
|
|
117
|
+
/**
|
|
118
|
+
* The detail half of a `{detail}` placeholder. A technical error string is safe
|
|
119
|
+
* to pass as a parameter for the same reason a number is: it is not itself
|
|
120
|
+
* translatable text, so it needs no code of its own. A PROSE fragment is not,
|
|
121
|
+
* and must become one code per value instead.
|
|
122
|
+
*/
|
|
123
|
+
export declare function describeError(error: unknown): string;
|
|
124
|
+
/**
|
|
125
|
+
* Recognises a declaration among a barrel's exports. The `format` check is what
|
|
126
|
+
* discriminates: a `code` + `text` pair alone admits any object that happens to
|
|
127
|
+
* carry both.
|
|
128
|
+
*/
|
|
129
|
+
export declare function isMessageDeclaration(value: unknown): value is MessageDefinition<string>;
|
|
130
|
+
/**
|
|
131
|
+
* Every declaration a `./messages` barrel exports.
|
|
132
|
+
*
|
|
133
|
+
* A caller cannot get there with `Object.values(barrel).filter(isMessageDeclaration)`:
|
|
134
|
+
* a barrel's value type is a union of its declarations AND its functions, and
|
|
135
|
+
* `filter` will not narrow a function type down to a `MessageDefinition`, so the
|
|
136
|
+
* result stays the union and reading `.code` off it does not compile. Taking the
|
|
137
|
+
* barrel as an opaque object is what makes the one-liner work.
|
|
138
|
+
*/
|
|
139
|
+
export declare function collectMessages(barrel: object): MessageDefinition<string>[];
|
|
140
|
+
export {};
|
|
141
|
+
//# sourceMappingURL=primitives.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"primitives.d.ts","sourceRoot":"","sources":["../../src/messages/primitives.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAE/C;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,aAAa,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC;AAEtE,KAAK,WAAW,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,SAAS,GAAG,MAAM,IAAI,MAAM,IAAI,IAAI,MAAM,IAAI,EAAE,GAAG,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;AAE1H,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GACpE,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,GACpB,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC;AAEvD,gFAAgF;AAChF,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;AAExG;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,MAAM,IAAI,MAAM,SAAS,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;AAEzE,MAAM,WAAW,iBAAiB,CAAC,CAAC,SAAS,MAAM;IAChD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;IACjB,MAAM,CAAC,GAAG,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;CACxC;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAGxG;AAID;;;;;;;;;;GAUG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,GAAG,MAAM,CAS3E;AAED,MAAM,WAAW,eAAe;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IAClC,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC;CACtC;AAED,2FAA2F;AAC3F,MAAM,WAAW,eAAgB,SAAQ,eAAe;IACrD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACxB;AAED,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,EAAE,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,oBAAoB,CAExH;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,CAAC,SAAS,MAAM,EAAE,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,eAAe,CAE/G;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,oBAAoB,CAU9E;AAED;;;;;GAKG;AACH,MAAM,MAAM,sBAAsB,GAAG,aAAa,CAAC,oBAAoB,CAAC,CAAC;AAEzE;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,MAAM,EAC1C,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC,EAC7B,GAAG,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,GACvB,sBAAsB,CAExB;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,eAAe,EAAE,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,CAG9G;AAED,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,aAAa,CAAC,OAAO,CAAC,GAAG,eAAe,GAAG,SAAS,CAEpG;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAEpD;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,iBAAiB,CAAC,MAAM,CAAC,CASvF;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,iBAAiB,CAAC,MAAM,CAAC,EAAE,CAE3E"}
|