@kubun/plugin-service-api 0.17.0 → 0.18.0

package/lib/index.d.ts

@@ -49,6 +49,13 @@ export type ServiceHandlerContext = {
      * comes from the handler. With no `subject`, the caller acts only for itself.
      */
     authorize: (subject?: string) => Promise<boolean>;
+    /**
+     * Server-derived group ID for this serve, when the transport is bound to a
+     * group tunnel. Injected per-serve as a constant (never read from the wire
+     * message/param), so a handler cannot spoof it. `undefined` outside a group
+     * context.
+     */
+    groupID?: string;
 };
 /** A single namespaced procedure handler, e.g. the impl behind `echo/ping`. */
 export type ServiceHandler = (context: ServiceHandlerContext) => unknown | Promise<unknown>;
@@ -68,6 +75,17 @@ export type ServiceProviderImpl = {
     name: string;
     handlers: Handlers;
     accessRules?: AccessRules;
+    /**
+     * Procedures whose calls stay open for as long as the caller wants them, such as
+     * subscriptions. The host does not expire them, and bounds how many each caller
+     * holds open instead (see {@link ServiceServerLimits}).
+     */
+    longLivedProcedures?: ReadonlyArray<string>;
+    /**
+     * The wire definition of this service's procedures. When every served service
+     * declares one, the host validates incoming messages against their union.
+     */
+    protocol?: ServiceProtocol;
 };
 /**
  * Per-service configuration, keyed by service NAME. Discriminated by explicit
@@ -83,9 +101,26 @@ export type ServiceProviderImpl = {
 export type ServiceConfig = boolean | {
     rules?: AccessRules;
     handlers?: Handlers;
+    longLivedProcedures?: ReadonlyArray<string>;
+    /** Wire definition of a custom service's procedures; see {@link ServiceProviderImpl.protocol}. */
+    protocol?: ServiceProtocol;
+};
+/** Per-serve limits on the calls a host `serve()` runs. Every field is optional. */
+export type ServiceServerLimits = {
+    /**
+     * How long a call that is not long-lived may stay open before the server fails it
+     * with `EK05`. Enkaku's default (300 s) when omitted.
+     */
+    callTimeoutMs?: number;
+    /** Long-lived calls one caller may hold open on this serve. Defaults to 64. */
+    maxLongLivedCallsPerCaller?: number;
+    /** Long-lived calls all callers together may hold open on this serve. Defaults to 1000. */
+    maxLongLivedCalls?: number;
 };
 /** Parameters for a single host `serve()` call. */
 export type ServiceServerServeParams = {
+    /** Limits on this serve's calls. See {@link ServiceServerLimits}. */
+    limits?: ServiceServerLimits;
     /** Server-side transport this server reads and writes. */
     transport: ServiceServerTransport;
     /** Which services to serve, keyed by service name. See {@link ServiceConfig}. */
@@ -106,4 +141,10 @@ export type ServiceServerServeParams = {
     cache?: DIDCache;
     /** Aborts the server when signalled. */
     signal?: AbortSignal;
+    /**
+     * Server-derived group ID for this serve, plumbed into each served handler's
+     * context as {@link ServiceHandlerContext.groupID}. Set when the transport is
+     * bound to a group tunnel; omitted outside a group context.
+     */
+    groupID?: string;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubun/plugin-service-api",
-  "version": "0.17.0",
+  "version": "0.18.0",
   "keywords": [],
   "license": "see LICENSE.md",
   "sideEffects": false,
@@ -15,9 +15,9 @@
     "LICENSE.md"
   ],
   "dependencies": {
-    "@enkaku/protocol": "^0.21.1",
-    "@enkaku/server": "^0.21.2",
-    "@kokuin/token": "^0.5.0"
+    "@enkaku/protocol": "^0.21.5",
+    "@enkaku/server": "^0.21.5",
+    "@kokuin/token": "^0.5.1"
   },
   "publishConfig": {
     "access": "public"