@mndw/sdk 0.1.6 → 0.3.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 +2 -1
- package/dist/angular/create-translator-signals.js +1 -1
- package/dist/angular/mount-plugin-instance.d.ts +1 -1
- package/dist/angular/mount-plugin-instance.d.ts.map +1 -1
- package/dist/angular/mount-plugin-instance.js +20 -28
- package/dist/angular/mount-plugin-instance.js.map +1 -1
- package/dist/backend-client.d.ts +81 -39
- package/dist/backend-client.d.ts.map +1 -1
- package/dist/backend-client.js +195 -77
- package/dist/backend-client.js.map +1 -1
- package/dist/bind-locale.d.ts.map +1 -1
- package/dist/bind-locale.js +1 -2
- package/dist/bind-locale.js.map +1 -1
- package/dist/capabilities.d.ts +19 -0
- package/dist/capabilities.d.ts.map +1 -0
- package/dist/capabilities.js +15 -0
- package/dist/capabilities.js.map +1 -0
- package/dist/context.d.ts +74 -29
- package/dist/context.d.ts.map +1 -1
- package/dist/context.js.map +1 -1
- package/dist/event-schema.d.ts +19 -5
- package/dist/event-schema.d.ts.map +1 -1
- package/dist/event-schema.js +6 -5
- package/dist/event-schema.js.map +1 -1
- package/dist/i18n.d.ts +4 -7
- package/dist/i18n.d.ts.map +1 -1
- package/dist/index.d.ts +12 -7
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +5 -3
- package/dist/index.js.map +1 -1
- package/dist/load-state.d.ts +6 -0
- package/dist/load-state.d.ts.map +1 -1
- package/dist/manifest.schema.json +39 -24
- package/dist/rci.d.ts +22 -2
- package/dist/rci.d.ts.map +1 -1
- package/dist/rci.js +37 -0
- package/dist/rci.js.map +1 -1
- package/dist/storage.d.ts +14 -0
- package/dist/storage.d.ts.map +1 -1
- package/dist/svelte/create-translator.d.ts +1 -4
- package/dist/svelte/create-translator.d.ts.map +1 -1
- package/dist/svelte/create-translator.js +1 -18
- package/dist/svelte/create-translator.js.map +1 -1
- package/dist/svelte/index.d.ts +9 -1
- package/dist/svelte/index.d.ts.map +1 -1
- package/dist/svelte/index.js +34 -1
- package/dist/svelte/index.js.map +1 -1
- package/dist/svelte/warning-filter.d.ts +2 -0
- package/dist/svelte/warning-filter.d.ts.map +1 -0
- package/dist/svelte/warning-filter.js +2 -0
- package/dist/svelte/warning-filter.js.map +1 -0
- package/dist/telemetry-client.d.ts +8 -0
- package/dist/telemetry-client.d.ts.map +1 -1
- package/dist/telemetry-client.js.map +1 -1
- package/dist/testing/i18n.js +4 -4
- package/dist/testing/i18n.js.map +1 -1
- package/dist/testing/plugin-context.d.ts +26 -9
- package/dist/testing/plugin-context.d.ts.map +1 -1
- package/dist/testing/plugin-context.js +124 -36
- package/dist/testing/plugin-context.js.map +1 -1
- package/dist/timers.d.ts +24 -0
- package/dist/timers.d.ts.map +1 -0
- package/dist/timers.js +125 -0
- package/dist/timers.js.map +1 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/dist/vue/use-observable.d.ts +2 -2
- package/dist/vue/use-observable.d.ts.map +1 -1
- package/dist/vue/use-observable.js +2 -2
- package/dist/vue/use-observable.js.map +1 -1
- package/dist/vue/use-translator.d.ts.map +1 -1
- package/dist/vue/use-translator.js +13 -1
- package/dist/vue/use-translator.js.map +1 -1
- package/package.json +4 -8
- package/dist/permissions.d.ts +0 -19
- package/dist/permissions.d.ts.map +0 -1
- package/dist/permissions.js +0 -15
- package/dist/permissions.js.map +0 -1
- package/dist/refresh.d.ts +0 -16
- package/dist/refresh.d.ts.map +0 -1
- package/dist/refresh.js +0 -77
- package/dist/refresh.js.map +0 -1
package/README.md
CHANGED
|
@@ -17,6 +17,8 @@ npm i -D @mndw/sdk
|
|
|
17
17
|
## Plugin entry
|
|
18
18
|
|
|
19
19
|
The host calls `createInstance` with a container and `PluginContext`; return `unmount` to release framework work.
|
|
20
|
+
Context services are grouped under `device`, `storage`, `appearance`, and `timers`. The live plugin locale is available
|
|
21
|
+
as `ctx.i18n.locale` and `ctx.i18n.locale$`; see the [context API](https://eralde.github.io/mndw/api/sdk#plugincontext).
|
|
20
22
|
|
|
21
23
|
```ts
|
|
22
24
|
import {mount, unmount} from 'svelte';
|
|
@@ -49,7 +51,6 @@ coordinated upgrade of all `@mndw/*` packages. See [project setup](https://erald
|
|
|
49
51
|
| `@mndw/sdk/testing` | [Test helpers](https://eralde.github.io/mndw/api/sdk/testing) |
|
|
50
52
|
| `@mndw/sdk/testing/vitest-project` | [Vitest project helper](https://eralde.github.io/mndw/api/sdk/testing/vitest-project) |
|
|
51
53
|
| `@mndw/sdk/bind-locale` | [Locale binding](https://eralde.github.io/mndw/api/sdk/bind-locale) |
|
|
52
|
-
| `@mndw/sdk/refresh` | [Refresh loop](https://eralde.github.io/mndw/api/sdk/refresh) |
|
|
53
54
|
| `@mndw/sdk/rrd` | [RRD helpers](https://eralde.github.io/mndw/api/sdk/rrd) |
|
|
54
55
|
| `@mndw/sdk/manifest.schema.json` | [Manifest guide](https://eralde.github.io/mndw/guides/manifest) |
|
|
55
56
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { signal } from '@angular/core';
|
|
2
2
|
export function createTranslatorSignals(i18n, destroyRef) {
|
|
3
3
|
const revision = signal(0);
|
|
4
|
-
const subscription = i18n.
|
|
4
|
+
const subscription = i18n.locale$.subscribe(() => revision.update((value) => value + 1));
|
|
5
5
|
destroyRef.onDestroy(() => subscription.unsubscribe());
|
|
6
6
|
return {
|
|
7
7
|
t: (key, values) => {
|
|
@@ -10,5 +10,5 @@ export interface AngularPluginInstanceOptions {
|
|
|
10
10
|
}) => void;
|
|
11
11
|
onUnmount?: () => void;
|
|
12
12
|
}
|
|
13
|
-
export declare function createAngularPluginInstance(el: HTMLElement, options: AngularPluginInstanceOptions): PluginInstance
|
|
13
|
+
export declare function createAngularPluginInstance(el: HTMLElement, options: AngularPluginInstanceOptions): Promise<PluginInstance>;
|
|
14
14
|
//# sourceMappingURL=mount-plugin-instance.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"mount-plugin-instance.d.ts","sourceRoot":"","sources":["../../src/angular/mount-plugin-instance.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,YAAY,EACjB,mBAAmB,EACnB,KAAK,QAAQ,EACb,KAAK,IAAI,EAEV,MAAM,eAAe,CAAC;AAEvB,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,cAAc,CAAC;AAEjD,MAAM,WAAW,4BAA4B;IAC3C,aAAa,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IAC7B,SAAS,EAAE,QAAQ,EAAE,CAAC;IACtB,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE;QACpB,MAAM,EAAE,cAAc,CAAC;QACvB,QAAQ,EAAE,mBAAmB,CAAC;QAC9B,SAAS,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;KAClC,KAAK,IAAI,CAAC;IACX,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;CACxB;AAwBD,
|
|
1
|
+
{"version":3,"file":"mount-plugin-instance.d.ts","sourceRoot":"","sources":["../../src/angular/mount-plugin-instance.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,YAAY,EACjB,mBAAmB,EACnB,KAAK,QAAQ,EACb,KAAK,IAAI,EAEV,MAAM,eAAe,CAAC;AAEvB,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,cAAc,CAAC;AAEjD,MAAM,WAAW,4BAA4B;IAC3C,aAAa,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IAC7B,SAAS,EAAE,QAAQ,EAAE,CAAC;IACtB,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE;QACpB,MAAM,EAAE,cAAc,CAAC;QACvB,QAAQ,EAAE,mBAAmB,CAAC;QAC9B,SAAS,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;KAClC,KAAK,IAAI,CAAC;IACX,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;CACxB;AAwBD,wBAAsB,2BAA2B,CAC/C,EAAE,EAAE,WAAW,EACf,OAAO,EAAE,4BAA4B,GACpC,OAAO,CAAC,cAAc,CAAC,CAkDzB"}
|
|
@@ -21,7 +21,7 @@ const runTeardown = (actions) => {
|
|
|
21
21
|
throw firstError;
|
|
22
22
|
}
|
|
23
23
|
};
|
|
24
|
-
export function createAngularPluginInstance(el, options) {
|
|
24
|
+
export async function createAngularPluginInstance(el, options) {
|
|
25
25
|
let appRef = null;
|
|
26
26
|
let component = null;
|
|
27
27
|
let disposed = false;
|
|
@@ -39,40 +39,32 @@ export function createAngularPluginInstance(el, options) {
|
|
|
39
39
|
appRef = null;
|
|
40
40
|
}
|
|
41
41
|
};
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
return;
|
|
47
|
-
}
|
|
48
|
-
appRef = ref;
|
|
49
|
-
const injector = ref.injector.get(EnvironmentInjector);
|
|
50
|
-
el.innerHTML = '';
|
|
42
|
+
try {
|
|
43
|
+
appRef = await createApplication({ providers: options.providers });
|
|
44
|
+
const injector = appRef.injector.get(EnvironmentInjector);
|
|
45
|
+
el.replaceChildren();
|
|
51
46
|
component = createComponent(options.rootComponent, { hostElement: el, environmentInjector: injector });
|
|
52
|
-
options.configure?.({ appRef
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
47
|
+
options.configure?.({ appRef, injector, component });
|
|
48
|
+
appRef.attachView(component.hostView);
|
|
49
|
+
return {
|
|
50
|
+
unmount() {
|
|
51
|
+
if (disposed) {
|
|
52
|
+
return;
|
|
53
|
+
}
|
|
54
|
+
disposed = true;
|
|
55
|
+
teardown();
|
|
56
|
+
},
|
|
57
|
+
};
|
|
58
|
+
}
|
|
59
|
+
catch (err) {
|
|
59
60
|
disposed = true;
|
|
60
|
-
console.error('[mndw] Angular plugin mount failed:', err);
|
|
61
61
|
try {
|
|
62
62
|
teardown();
|
|
63
63
|
}
|
|
64
64
|
catch (teardownErr) {
|
|
65
65
|
console.error('[mndw] Angular plugin mount-failure teardown failed:', teardownErr);
|
|
66
66
|
}
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
unmount() {
|
|
70
|
-
if (disposed) {
|
|
71
|
-
return;
|
|
72
|
-
}
|
|
73
|
-
disposed = true;
|
|
74
|
-
teardown();
|
|
75
|
-
},
|
|
76
|
-
};
|
|
67
|
+
throw err;
|
|
68
|
+
}
|
|
77
69
|
}
|
|
78
70
|
//# sourceMappingURL=mount-plugin-instance.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"mount-plugin-instance.js","sourceRoot":"","sources":["../../src/angular/mount-plugin-instance.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,mBAAmB,EAGnB,eAAe,GAChB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAC,iBAAiB,EAAC,MAAM,2BAA2B,CAAC;AAc5D,MAAM,WAAW,GAAG,CAAC,OAA0B,EAAQ,EAAE;IACvD,IAAI,UAAmB,CAAC;IACxB,IAAI,MAAM,GAAG,KAAK,CAAC;IAEnB,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,IAAI,CAAC;YACH,MAAM,EAAE,CAAC;QACX,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,UAAU,GAAG,GAAG,CAAC;gBACjB,MAAM,GAAG,IAAI,CAAC;YAChB,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,kDAAkD,EAAE,GAAG,CAAC,CAAC;YACzE,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,MAAM,EAAE,CAAC;QACX,MAAM,UAAU,CAAC;IACnB,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,UAAU,2BAA2B,
|
|
1
|
+
{"version":3,"file":"mount-plugin-instance.js","sourceRoot":"","sources":["../../src/angular/mount-plugin-instance.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,mBAAmB,EAGnB,eAAe,GAChB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAC,iBAAiB,EAAC,MAAM,2BAA2B,CAAC;AAc5D,MAAM,WAAW,GAAG,CAAC,OAA0B,EAAQ,EAAE;IACvD,IAAI,UAAmB,CAAC;IACxB,IAAI,MAAM,GAAG,KAAK,CAAC;IAEnB,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,IAAI,CAAC;YACH,MAAM,EAAE,CAAC;QACX,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,UAAU,GAAG,GAAG,CAAC;gBACjB,MAAM,GAAG,IAAI,CAAC;YAChB,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,kDAAkD,EAAE,GAAG,CAAC,CAAC;YACzE,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,MAAM,EAAE,CAAC;QACX,MAAM,UAAU,CAAC;IACnB,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,KAAK,UAAU,2BAA2B,CAC/C,EAAe,EACf,OAAqC;IAErC,IAAI,MAAM,GAA0B,IAAI,CAAC;IACzC,IAAI,SAAS,GAAiC,IAAI,CAAC;IACnD,IAAI,QAAQ,GAAG,KAAK,CAAC;IAErB,MAAM,QAAQ,GAAG,GAAS,EAAE;QAC1B,IAAI,CAAC;YACH,WAAW,CAAC;gBACV,GAAG,EAAE,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE;gBAC3B,GAAG,EAAE,CAAC,SAAS,EAAE,OAAO,EAAE;gBAC1B,GAAG,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE;gBACvB,GAAG,EAAE,CAAC,EAAE,CAAC,eAAe,EAAE;aAC3B,CAAC,CAAC;QACL,CAAC;gBAAS,CAAC;YACT,SAAS,GAAG,IAAI,CAAC;YACjB,MAAM,GAAG,IAAI,CAAC;QAChB,CAAC;IACH,CAAC,CAAC;IAEF,IAAI,CAAC;QACH,MAAM,GAAG,MAAM,iBAAiB,CAAC,EAAC,SAAS,EAAE,OAAO,CAAC,SAAS,EAAC,CAAC,CAAC;QAEjE,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;QAE1D,EAAE,CAAC,eAAe,EAAE,CAAC;QACrB,SAAS,GAAG,eAAe,CAAC,OAAO,CAAC,aAAa,EAAE,EAAC,WAAW,EAAE,EAAE,EAAE,mBAAmB,EAAE,QAAQ,EAAC,CAAC,CAAC;QACrG,OAAO,CAAC,SAAS,EAAE,CAAC,EAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAC,CAAC,CAAC;QACnD,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QAEtC,OAAO;YACL,OAAO;gBACL,IAAI,QAAQ,EAAE,CAAC;oBACb,OAAO;gBACT,CAAC;gBAED,QAAQ,GAAG,IAAI,CAAC;gBAChB,QAAQ,EAAE,CAAC;YACb,CAAC;SACF,CAAC;IACJ,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,QAAQ,GAAG,IAAI,CAAC;QAEhB,IAAI,CAAC;YACH,QAAQ,EAAE,CAAC;QACb,CAAC;QAAC,OAAO,WAAW,EAAE,CAAC;YACrB,OAAO,CAAC,KAAK,CAAC,sDAAsD,EAAE,WAAW,CAAC,CAAC;QACrF,CAAC;QAED,MAAM,GAAG,CAAC;IACZ,CAAC;AACH,CAAC"}
|
package/dist/backend-client.d.ts
CHANGED
|
@@ -1,14 +1,18 @@
|
|
|
1
1
|
import { z } from 'zod';
|
|
2
|
+
import { type PersistentRciCapability } from './capabilities.js';
|
|
2
3
|
/**
|
|
3
4
|
* Typed backend client handed to plugins as `context.backend`.
|
|
4
5
|
* It resolves HTTP and WebSocket route ids from the daemon's capability snapshot and
|
|
5
6
|
* applies the same approval and enabled checks before issuing a request.
|
|
6
7
|
*
|
|
7
8
|
* Ids resolve locally from a descriptor snapshot taken from `GET /api/mgmt/list`,
|
|
8
|
-
* no per-call lookup.
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
9
|
+
* no per-call lookup. `fetch()`, `call()`, and `status()` reject for author errors,
|
|
10
|
+
* including an undeclared backend, unknown ids, and wrong transports. `socket()` throws
|
|
11
|
+
* those author errors synchronously. A known-unapproved or disabled socket route returns
|
|
12
|
+
* an already-closed WebSocket-like object with an application close code and readable reason.
|
|
13
|
+
* Two error layers:
|
|
14
|
+
* - HTTP client-side pre-checks from the snapshot reject with typed author errors;
|
|
15
|
+
* - the daemon is authoritative for responses it marks as platform errors - its structured error envelope codes
|
|
12
16
|
* `NOT_APPROVED`, `DISABLED`, `ROUTE_NOT_FOUND`, `BACKEND_STARTING`,
|
|
13
17
|
* `BACKEND_UNAVAILABLE`, `BACKEND_INCOMPATIBLE`, `BACKEND_MAINTENANCE`,
|
|
14
18
|
* `BACKEND_BLOCKED`, and `BAD_GATEWAY` map onto the same typed errors when
|
|
@@ -18,15 +22,17 @@ import { z } from 'zod';
|
|
|
18
22
|
* live, passive, bound-plugin query and is not a readiness probe.
|
|
19
23
|
*/
|
|
20
24
|
export type BackendApprovalStatus = 'approved' | 'pending' | 'denied';
|
|
21
|
-
|
|
22
|
-
|
|
25
|
+
/** @internal Exposed to SDK type tests; not re-exported from the package entry. */
|
|
26
|
+
export declare const backendBlockerSchema: z.ZodObject<{
|
|
27
|
+
capability: z.ZodEnum<{
|
|
23
28
|
"persistent-rci-session:read": "persistent-rci-session:read";
|
|
24
29
|
"persistent-rci-session:write": "persistent-rci-session:write";
|
|
25
30
|
}>;
|
|
26
31
|
reason: z.ZodString;
|
|
27
32
|
prerequisite: z.ZodOptional<z.ZodString>;
|
|
28
33
|
}, z.core.$strip>;
|
|
29
|
-
|
|
34
|
+
/** @internal Exposed to SDK type tests; not re-exported from the package entry. */
|
|
35
|
+
export declare const backendStatusSchema: z.ZodPreprocess<z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
30
36
|
kind: z.ZodEnum<{
|
|
31
37
|
exec: "exec";
|
|
32
38
|
service: "service";
|
|
@@ -34,7 +40,7 @@ declare const backendStatusSchema: z.ZodPreprocess<z.ZodDiscriminatedUnion<[z.Zo
|
|
|
34
40
|
state: z.ZodLiteral<"blocked">;
|
|
35
41
|
retryAfterSeconds: z.ZodNullable<z.ZodNumber>;
|
|
36
42
|
blockers: z.ZodArray<z.ZodObject<{
|
|
37
|
-
|
|
43
|
+
capability: z.ZodEnum<{
|
|
38
44
|
"persistent-rci-session:read": "persistent-rci-session:read";
|
|
39
45
|
"persistent-rci-session:write": "persistent-rci-session:write";
|
|
40
46
|
}>;
|
|
@@ -65,8 +71,27 @@ declare const backendStatusSchema: z.ZodPreprocess<z.ZodDiscriminatedUnion<[z.Zo
|
|
|
65
71
|
}>;
|
|
66
72
|
retryAfterSeconds: z.ZodNullable<z.ZodNumber>;
|
|
67
73
|
}, z.core.$strip>], "state">>;
|
|
68
|
-
export
|
|
69
|
-
|
|
74
|
+
export interface BackendBlocker {
|
|
75
|
+
capability: PersistentRciCapability;
|
|
76
|
+
reason: string;
|
|
77
|
+
prerequisite?: string;
|
|
78
|
+
}
|
|
79
|
+
export type BackendStatus = {
|
|
80
|
+
kind: 'exec' | 'service';
|
|
81
|
+
state: 'blocked';
|
|
82
|
+
retryAfterSeconds: number | null;
|
|
83
|
+
blockers: BackendBlocker[];
|
|
84
|
+
} | {
|
|
85
|
+
kind: 'exec' | 'service';
|
|
86
|
+
state: 'incompatible';
|
|
87
|
+
retryAfterSeconds: number | null;
|
|
88
|
+
requiredProtocol: number;
|
|
89
|
+
supportedProtocols: number[];
|
|
90
|
+
} | {
|
|
91
|
+
kind: 'exec' | 'service';
|
|
92
|
+
state: 'ready' | 'starting' | 'unavailable' | 'maintenance' | 'disabled' | 'not-approved';
|
|
93
|
+
retryAfterSeconds: number | null;
|
|
94
|
+
};
|
|
70
95
|
export type BackendStatusState = BackendStatus['state'];
|
|
71
96
|
export type BackendRouteTransport = 'http' | 'websocket';
|
|
72
97
|
export interface BackendRouteDescriptor {
|
|
@@ -94,82 +119,99 @@ export interface BackendFetchOptions {
|
|
|
94
119
|
headers?: HeadersInit;
|
|
95
120
|
signal?: AbortSignal;
|
|
96
121
|
}
|
|
122
|
+
export interface BackendCallOptions extends BackendFetchOptions {
|
|
123
|
+
as?: 'json' | 'text' | 'blob';
|
|
124
|
+
}
|
|
97
125
|
export interface BackendSocketOptions {
|
|
98
126
|
protocols?: string[];
|
|
99
127
|
}
|
|
100
128
|
export interface BackendClient {
|
|
101
|
-
/** Resolve
|
|
129
|
+
/** Resolve and issue the request. Returns plugin responses, including non-OK; rejects for author and platform errors. */
|
|
102
130
|
fetch(id: string, options?: BackendFetchOptions): Promise<Response>;
|
|
103
|
-
/**
|
|
131
|
+
/** Fetch and decode a route response; rejects for author errors and plugin-owned or platform response errors. */
|
|
132
|
+
call<T = unknown>(id: string, options: BackendCallOptions & {
|
|
133
|
+
as: 'json';
|
|
134
|
+
}): Promise<T>;
|
|
135
|
+
call(id: string, options: BackendCallOptions & {
|
|
136
|
+
as: 'text';
|
|
137
|
+
}): Promise<string>;
|
|
138
|
+
call(id: string, options: BackendCallOptions & {
|
|
139
|
+
as: 'blob';
|
|
140
|
+
}): Promise<Blob>;
|
|
141
|
+
call<T = unknown>(id: string, options?: BackendCallOptions): Promise<T | string | Blob>;
|
|
142
|
+
/** Open a websocket. Author errors throw synchronously; blocked routes return a closed socket with a readable reason. */
|
|
104
143
|
socket(id: string, options?: BackendSocketOptions): WebSocket;
|
|
105
|
-
/** Query live daemon-owned backend availability
|
|
144
|
+
/** Query live daemon-owned backend availability; rejects if no backend is declared or the query fails. */
|
|
106
145
|
status(options?: BackendStatusOptions): Promise<BackendStatus>;
|
|
107
146
|
}
|
|
108
147
|
/** Returns true for an intentional daemon maintenance close; callers must show
|
|
109
148
|
* an explicit reconnect affordance and never silently recreate the socket. */
|
|
110
149
|
export declare const isBackendMaintenanceClose: (event: Pick<CloseEvent, "code" | "reason">) => boolean;
|
|
111
|
-
|
|
150
|
+
/** Application close codes used when a declared WebSocket route cannot open. */
|
|
151
|
+
export declare const BackendSocketCloseCode: Readonly<{
|
|
152
|
+
readonly notApproved: 4001;
|
|
153
|
+
readonly disabled: 4002;
|
|
154
|
+
}>;
|
|
155
|
+
export type BackendErrorCode = 'UNKNOWN_ID' | 'BACKEND_NOT_DECLARED' | 'NOT_APPROVED' | 'DISABLED' | 'TRANSPORT_MISMATCH' | 'BACKEND_STARTING' | 'BACKEND_UNAVAILABLE' | 'BACKEND_INCOMPATIBLE' | 'BACKEND_MAINTENANCE' | 'BACKEND_BLOCKED' | 'BAD_GATEWAY' | 'STATUS_QUERY_FAILED' | 'ROUTE_NOT_FOUND' | 'BAD_REQUEST' | 'INTERNAL' | 'SERVER_BUSY' | 'REQUEST_TIMEOUT' | 'SCRIPT_FAILED' | 'SCRIPT_TIMEOUT' | 'BACKEND_BUSY' | 'BACKEND_BODY_TOO_LARGE' | 'BACKEND_OUTPUT_TOO_LARGE' | 'CSRF_REQUIRED' | 'UNAUTHORIZED' | 'HTTP_ERROR' | 'INVALID_RESPONSE';
|
|
156
|
+
interface BackendErrorOptions {
|
|
157
|
+
status?: number;
|
|
158
|
+
retryable?: boolean;
|
|
159
|
+
details?: unknown;
|
|
160
|
+
}
|
|
112
161
|
export declare class BackendError extends Error {
|
|
113
162
|
readonly id: string | undefined;
|
|
114
163
|
readonly code: BackendErrorCode;
|
|
115
|
-
|
|
164
|
+
readonly status: number | undefined;
|
|
165
|
+
readonly retryable: boolean;
|
|
166
|
+
readonly details: unknown;
|
|
167
|
+
constructor(message: string, code: BackendErrorCode, id?: string, options?: BackendErrorOptions);
|
|
116
168
|
}
|
|
117
169
|
export declare class BackendUnknownId extends BackendError {
|
|
118
|
-
readonly code
|
|
119
|
-
constructor(id: string
|
|
170
|
+
readonly code: 'UNKNOWN_ID' | 'ROUTE_NOT_FOUND';
|
|
171
|
+
constructor(id: string, options?: BackendErrorOptions & {
|
|
172
|
+
code?: 'UNKNOWN_ID' | 'ROUTE_NOT_FOUND';
|
|
173
|
+
});
|
|
120
174
|
}
|
|
121
175
|
export declare class BackendNotApproved extends BackendError {
|
|
122
176
|
readonly code = "NOT_APPROVED";
|
|
123
|
-
constructor(id: string);
|
|
177
|
+
constructor(id: string, options?: BackendErrorOptions);
|
|
124
178
|
}
|
|
125
179
|
export declare class BackendDisabled extends BackendError {
|
|
126
180
|
readonly code = "DISABLED";
|
|
127
|
-
constructor(id: string);
|
|
181
|
+
constructor(id: string, options?: BackendErrorOptions);
|
|
128
182
|
}
|
|
129
183
|
export declare class BackendTransportMismatch extends BackendError {
|
|
130
184
|
readonly expected: BackendRouteTransport;
|
|
131
185
|
readonly code = "TRANSPORT_MISMATCH";
|
|
132
|
-
constructor(id: string, expected: BackendRouteTransport);
|
|
186
|
+
constructor(id: string, expected: BackendRouteTransport, options?: BackendErrorOptions);
|
|
133
187
|
}
|
|
134
188
|
export declare class BackendStarting extends BackendError {
|
|
135
189
|
readonly retryAfterSeconds: number | null;
|
|
136
190
|
readonly code = "BACKEND_STARTING";
|
|
137
|
-
|
|
138
|
-
readonly daemonCode = "BACKEND_STARTING";
|
|
139
|
-
constructor(id: string, retryAfterSeconds: number | null);
|
|
191
|
+
constructor(id: string, retryAfterSeconds: number | null, options?: BackendErrorOptions);
|
|
140
192
|
}
|
|
141
193
|
export declare class BackendUnavailable extends BackendError {
|
|
142
194
|
readonly code = "BACKEND_UNAVAILABLE";
|
|
143
|
-
|
|
144
|
-
readonly daemonCode = "BACKEND_UNAVAILABLE";
|
|
145
|
-
constructor(id: string);
|
|
195
|
+
constructor(id: string, options?: BackendErrorOptions);
|
|
146
196
|
}
|
|
147
197
|
export declare class BackendIncompatible extends BackendError {
|
|
148
198
|
readonly code = "BACKEND_INCOMPATIBLE";
|
|
149
|
-
|
|
150
|
-
readonly daemonCode = "BACKEND_INCOMPATIBLE";
|
|
151
|
-
constructor(id: string);
|
|
199
|
+
constructor(id: string, options?: BackendErrorOptions);
|
|
152
200
|
}
|
|
153
201
|
export declare class BackendMaintenance extends BackendError {
|
|
154
202
|
readonly retryAfterSeconds: number | null;
|
|
155
203
|
readonly code = "BACKEND_MAINTENANCE";
|
|
156
|
-
|
|
157
|
-
readonly daemonCode = "BACKEND_MAINTENANCE";
|
|
158
|
-
constructor(id: string, retryAfterSeconds: number | null);
|
|
204
|
+
constructor(id: string, retryAfterSeconds: number | null, options?: BackendErrorOptions);
|
|
159
205
|
}
|
|
160
206
|
export declare class BackendBlocked extends BackendError {
|
|
161
207
|
readonly blockers: BackendBlocker[];
|
|
162
208
|
readonly retryAfterSeconds: number | null;
|
|
163
209
|
readonly code = "BACKEND_BLOCKED";
|
|
164
|
-
|
|
165
|
-
readonly daemonCode = "BACKEND_BLOCKED";
|
|
166
|
-
constructor(id: string, blockers: BackendBlocker[], retryAfterSeconds: number | null);
|
|
210
|
+
constructor(id: string, blockers: BackendBlocker[], retryAfterSeconds: number | null, options?: BackendErrorOptions);
|
|
167
211
|
}
|
|
168
212
|
export declare class BackendBadGateway extends BackendError {
|
|
169
213
|
readonly code = "BAD_GATEWAY";
|
|
170
|
-
|
|
171
|
-
readonly daemonCode = "BAD_GATEWAY";
|
|
172
|
-
constructor(id: string);
|
|
214
|
+
constructor(id: string, options?: BackendErrorOptions);
|
|
173
215
|
}
|
|
174
216
|
export declare class BackendStatusQueryError extends BackendError {
|
|
175
217
|
readonly httpStatus: number | null;
|
|
@@ -183,6 +225,6 @@ export interface BackendClientDeps {
|
|
|
183
225
|
/** Absolute origin (e.g. `https://host:99`) used to derive the ws:// scheme and host. */
|
|
184
226
|
origin?: string;
|
|
185
227
|
}
|
|
186
|
-
export declare function createBackendClient(pluginName: string, descriptor: BackendDescriptor, deps?: BackendClientDeps): BackendClient;
|
|
228
|
+
export declare function createBackendClient(pluginName: string, descriptor: BackendDescriptor | undefined, deps?: BackendClientDeps): BackendClient;
|
|
187
229
|
export {};
|
|
188
230
|
//# sourceMappingURL=backend-client.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"backend-client.d.ts","sourceRoot":"","sources":["../src/backend-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,CAAC,EAAC,MAAM,KAAK,CAAC;
|
|
1
|
+
{"version":3,"file":"backend-client.d.ts","sourceRoot":"","sources":["../src/backend-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,CAAC,EAAC,MAAM,KAAK,CAAC;AACtB,OAAO,EAAC,KAAK,uBAAuB,EAAgC,MAAM,mBAAmB,CAAC;AAE9F;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,MAAM,MAAM,qBAAqB,GAAG,UAAU,GAAG,SAAS,GAAG,QAAQ,CAAC;AAMtE,mFAAmF;AACnF,eAAO,MAAM,oBAAoB;;;;;;;iBAK/B,CAAC;AAiDH,mFAAmF;AACnF,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;6BAG/B,CAAC;AAEF,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE,uBAAuB,CAAC;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,MAAM,aAAa,GACrB;IACA,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,KAAK,EAAE,SAAS,CAAC;IACjB,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,QAAQ,EAAE,cAAc,EAAE,CAAC;CAC5B,GACC;IACA,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,KAAK,EAAE,cAAc,CAAC;IACtB,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,gBAAgB,EAAE,MAAM,CAAC;IACzB,kBAAkB,EAAE,MAAM,EAAE,CAAC;CAC9B,GACC;IACA,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,KAAK,EAAE,OAAO,GAAG,UAAU,GAAG,aAAa,GAAG,aAAa,GAAG,UAAU,GAAG,cAAc,CAAC;IAC1F,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC,CAAC;AACJ,MAAM,MAAM,kBAAkB,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;AAExD,MAAM,MAAM,qBAAqB,GAAG,MAAM,GAAG,WAAW,CAAC;AAEzD,MAAM,WAAW,sBAAsB;IACrC,SAAS,EAAE,qBAAqB,CAAC;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;IAC9D,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,sEAAsE;IACtE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC;IAC/C,QAAQ,EAAE,qBAAqB,CAAC;IAChC,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;IAClD,IAAI,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,EAAE,GAAG,IAAI,CAAC;IAC7D,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC7D,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CAC/B;AAED,MAAM,WAAW,oBAAoB;IACnC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AAED,MAAM,WAAW,aAAa;IAC5B,yHAAyH;IACzH,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IACpE,iHAAiH;IACjH,IAAI,CAAC,CAAC,GAAG,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,kBAAkB,GAAG;QAAC,EAAE,EAAE,MAAM,CAAA;KAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACtF,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,kBAAkB,GAAG;QAAC,EAAE,EAAE,MAAM,CAAA;KAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9E,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,kBAAkB,GAAG;QAAC,EAAE,EAAE,MAAM,CAAA;KAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5E,IAAI,CAAC,CAAC,GAAG,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,CAAC,GAAG,MAAM,GAAG,IAAI,CAAC,CAAC;IACxF,yHAAyH;IACzH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,SAAS,CAAC;IAC9D,0GAA0G;IAC1G,MAAM,CAAC,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;CAChE;AAED;8EAC8E;AAC9E,eAAO,MAAM,yBAAyB,GAAI,OAAO,IAAI,CAAC,UAAU,EAAE,MAAM,GAAG,QAAQ,CAAC,KAAG,OAEtF,CAAC;AAEF,gFAAgF;AAChF,eAAO,MAAM,sBAAsB;;;EAKlC,CAAC;AAMF,MAAM,MAAM,gBAAgB,GACxB,YAAY,GACZ,sBAAsB,GACtB,cAAc,GACd,UAAU,GACV,oBAAoB,GACpB,kBAAkB,GAClB,qBAAqB,GACrB,sBAAsB,GACtB,qBAAqB,GACrB,iBAAiB,GACjB,aAAa,GACb,qBAAqB,GACrB,iBAAiB,GACjB,aAAa,GACb,UAAU,GACV,aAAa,GACb,iBAAiB,GACjB,eAAe,GACf,gBAAgB,GAChB,cAAc,GACd,wBAAwB,GACxB,0BAA0B,GAC1B,eAAe,GACf,cAAc,GACd,YAAY,GACZ,kBAAkB,CAAC;AAEvB,UAAU,mBAAmB;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAsBD,qBAAa,YAAa,SAAQ,KAAK;IACrC,SAAgB,EAAE,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,SAAgB,IAAI,EAAE,gBAAgB,CAAC;IACvC,SAAgB,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3C,SAAgB,SAAS,EAAE,OAAO,CAAC;IACnC,SAAgB,OAAO,EAAE,OAAO,CAAC;gBAErB,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,GAAE,mBAAwB;CASpG;AAED,qBAAa,gBAAiB,SAAQ,YAAY;IAChD,SAAyB,IAAI,EAAE,YAAY,GAAG,iBAAiB,CAAC;gBAEpD,EAAE,EAAE,MAAM,EAAE,OAAO,GAAE,mBAAmB,GAAG;QAAC,IAAI,CAAC,EAAE,YAAY,GAAG,iBAAiB,CAAA;KAAM;CAOtG;AAED,qBAAa,kBAAmB,SAAQ,YAAY;IAClD,SAAyB,IAAI,kBAAkB;gBAEnC,EAAE,EAAE,MAAM,EAAE,OAAO,GAAE,mBAAwB;CAI1D;AAED,qBAAa,eAAgB,SAAQ,YAAY;IAC/C,SAAyB,IAAI,cAAc;gBAE/B,EAAE,EAAE,MAAM,EAAE,OAAO,GAAE,mBAAwB;CAI1D;AAED,qBAAa,wBAAyB,SAAQ,YAAY;aAGhB,QAAQ,EAAE,qBAAqB;IAFvE,SAAyB,IAAI,wBAAwB;gBAEzC,EAAE,EAAE,MAAM,EAAkB,QAAQ,EAAE,qBAAqB,EAAE,OAAO,GAAE,mBAAwB;CAI3G;AAED,qBAAa,eAAgB,SAAQ,YAAY;aAK7B,iBAAiB,EAAE,MAAM,GAAG,IAAI;IAJlD,SAAyB,IAAI,sBAAsB;gBAGjD,EAAE,EAAE,MAAM,EACM,iBAAiB,EAAE,MAAM,GAAG,IAAI,EAChD,OAAO,GAAE,mBAAwB;CAKpC;AAED,qBAAa,kBAAmB,SAAQ,YAAY;IAClD,SAAyB,IAAI,yBAAyB;gBAE1C,EAAE,EAAE,MAAM,EAAE,OAAO,GAAE,mBAAwB;CAI1D;AAED,qBAAa,mBAAoB,SAAQ,YAAY;IACnD,SAAyB,IAAI,0BAA0B;gBAE3C,EAAE,EAAE,MAAM,EAAE,OAAO,GAAE,mBAAwB;CAI1D;AAED,qBAAa,kBAAmB,SAAQ,YAAY;aAKhC,iBAAiB,EAAE,MAAM,GAAG,IAAI;IAJlD,SAAyB,IAAI,yBAAyB;gBAGpD,EAAE,EAAE,MAAM,EACM,iBAAiB,EAAE,MAAM,GAAG,IAAI,EAChD,OAAO,GAAE,mBAAwB;CAKpC;AAED,qBAAa,cAAe,SAAQ,YAAY;aAK5B,QAAQ,EAAE,cAAc,EAAE;aAC1B,iBAAiB,EAAE,MAAM,GAAG,IAAI;IALlD,SAAyB,IAAI,qBAAqB;gBAGhD,EAAE,EAAE,MAAM,EACM,QAAQ,EAAE,cAAc,EAAE,EAC1B,iBAAiB,EAAE,MAAM,GAAG,IAAI,EAChD,OAAO,GAAE,mBAAwB;CAKpC;AAED,qBAAa,iBAAkB,SAAQ,YAAY;IACjD,SAAyB,IAAI,iBAAiB;gBAElC,EAAE,EAAE,MAAM,EAAE,OAAO,GAAE,mBAAwB;CAI1D;AAED,qBAAa,uBAAwB,SAAQ,YAAY;aAG3B,UAAU,EAAE,MAAM,GAAG,IAAI;IAFrD,SAAyB,IAAI,yBAAyB;gBAE1B,UAAU,EAAE,MAAM,GAAG,IAAI,EAAE,OAAO,EAAE,MAAM;CAIvE;AAMD,6EAA6E;AAC7E,MAAM,WAAW,iBAAiB;IAChC,KAAK,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,CAAC;IAChC,aAAa,CAAC,EAAE,OAAO,SAAS,CAAC;IACjC,yFAAyF;IACzF,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AA2OD,wBAAgB,mBAAmB,CACjC,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,iBAAiB,GAAG,SAAS,EACzC,IAAI,GAAE,iBAAsB,GAC3B,aAAa,CA4Jf"}
|