@qlever-llc/trellis 0.10.8 → 0.10.10

package/src/sdk/_generated/state/types.ts

@@ -3,42 +3,246 @@ import type { RpcHandlerFn } from "../../../index.js";
 import type { API } from "./api.js";
 
 export const CONTRACT_ID = "trellis.state@v1" as const;
-export const CONTRACT_DIGEST = "XfWDYLTBlYFjDqMPBEXrTBccZbFvHp0MnqscehdRKT4" as const;
+export const CONTRACT_DIGEST =
+  "XfWDYLTBlYFjDqMPBEXrTBccZbFvHp0MnqscehdRKT4" as const;
 
-export type StateAdminDeleteInput = ({ contractDigest: string; contractId: string; expectedRevision?: string; key?: string; scope: "userApp"; store: string; user: { id: string; origin: string; userId?: string; }; } | { contractDigest: string; contractId: string; deviceId: string; expectedRevision?: string; key?: string; scope: "deviceApp"; store: string; });
-export type StateAdminDeleteOutput = { deleted: boolean; };
+export type StateAdminDeleteInput = {
+  contractDigest: string;
+  contractId: string;
+  expectedRevision?: string;
+  key?: string;
+  scope: "userApp";
+  store: string;
+  user: { id: string; origin: string; userId?: string };
+} | {
+  contractDigest: string;
+  contractId: string;
+  deviceId: string;
+  expectedRevision?: string;
+  key?: string;
+  scope: "deviceApp";
+  store: string;
+};
+export type StateAdminDeleteOutput = { deleted: boolean };
 
-export type StateAdminGetInput = ({ contractDigest: string; contractId: string; key?: string; scope: "userApp"; store: string; user: { id: string; origin: string; userId?: string; }; } | { contractDigest: string; contractId: string; deviceId: string; key?: string; scope: "deviceApp"; store: string; });
-export type StateAdminGetOutput = ({ found: false; } | { entry: { expiresAt?: string; key?: string; revision: string; updatedAt: string; value: unknown; }; found: true; } | { currentStateVersion: string; entry: { expiresAt?: string; key?: string; revision: string; updatedAt: string; value: unknown; }; migrationRequired: true; stateVersion: string; writerContractDigest: string; });
+export type StateAdminGetInput = {
+  contractDigest: string;
+  contractId: string;
+  key?: string;
+  scope: "userApp";
+  store: string;
+  user: { id: string; origin: string; userId?: string };
+} | {
+  contractDigest: string;
+  contractId: string;
+  deviceId: string;
+  key?: string;
+  scope: "deviceApp";
+  store: string;
+};
+export type StateAdminGetOutput = { found: false } | {
+  entry: {
+    expiresAt?: string;
+    key?: string;
+    revision: string;
+    updatedAt: string;
+    value: unknown;
+  };
+  found: true;
+} | {
+  currentStateVersion: string;
+  entry: {
+    expiresAt?: string;
+    key?: string;
+    revision: string;
+    updatedAt: string;
+    value: unknown;
+  };
+  migrationRequired: true;
+  stateVersion: string;
+  writerContractDigest: string;
+};
 
-export type StateAdminListInput = ({ contractDigest: string; contractId: string; limit: number; offset?: number; prefix?: string; scope: "userApp"; store: string; user: { id: string; origin: string; userId?: string; }; } | { contractDigest: string; contractId: string; deviceId: string; limit: number; offset?: number; prefix?: string; scope: "deviceApp"; store: string; });
-export type StateAdminListOutput = { count: number; entries: Array<({ expiresAt?: string; key?: string; revision: string; updatedAt: string; value: unknown; } | { currentStateVersion: string; entry: { expiresAt?: string; key?: string; revision: string; updatedAt: string; value: unknown; }; migrationRequired: true; stateVersion: string; writerContractDigest: string; })>; limit: number; nextOffset?: number; offset: number; };
+export type StateAdminListInput = {
+  contractDigest: string;
+  contractId: string;
+  limit: number;
+  offset?: number;
+  prefix?: string;
+  scope: "userApp";
+  store: string;
+  user: { id: string; origin: string; userId?: string };
+} | {
+  contractDigest: string;
+  contractId: string;
+  deviceId: string;
+  limit: number;
+  offset?: number;
+  prefix?: string;
+  scope: "deviceApp";
+  store: string;
+};
+export type StateAdminListOutput = {
+  count: number;
+  entries: Array<
+    ({
+      expiresAt?: string;
+      key?: string;
+      revision: string;
+      updatedAt: string;
+      value: unknown;
+    } | {
+      currentStateVersion: string;
+      entry: {
+        expiresAt?: string;
+        key?: string;
+        revision: string;
+        updatedAt: string;
+        value: unknown;
+      };
+      migrationRequired: true;
+      stateVersion: string;
+      writerContractDigest: string;
+    })
+  >;
+  limit: number;
+  nextOffset?: number;
+  offset: number;
+};
 
-export type StateDeleteInput = { expectedRevision?: string; key?: string; store: string; };
-export type StateDeleteOutput = { deleted: boolean; };
+export type StateDeleteInput = {
+  expectedRevision?: string;
+  key?: string;
+  store: string;
+};
+export type StateDeleteOutput = { deleted: boolean };
 
-export type StateGetInput = { key?: string; store: string; };
-export type StateGetOutput = ({ found: false; } | { entry: { expiresAt?: string; key?: string; revision: string; updatedAt: string; value: unknown; }; found: true; } | { currentStateVersion: string; entry: { expiresAt?: string; key?: string; revision: string; updatedAt: string; value: unknown; }; migrationRequired: true; stateVersion: string; writerContractDigest: string; });
+export type StateGetInput = { key?: string; store: string };
+export type StateGetOutput = { found: false } | {
+  entry: {
+    expiresAt?: string;
+    key?: string;
+    revision: string;
+    updatedAt: string;
+    value: unknown;
+  };
+  found: true;
+} | {
+  currentStateVersion: string;
+  entry: {
+    expiresAt?: string;
+    key?: string;
+    revision: string;
+    updatedAt: string;
+    value: unknown;
+  };
+  migrationRequired: true;
+  stateVersion: string;
+  writerContractDigest: string;
+};
 
-export type StateListInput = { limit: number; offset?: number; prefix?: string; store: string; };
-export type StateListOutput = { count: number; entries: Array<({ expiresAt?: string; key?: string; revision: string; updatedAt: string; value: unknown; } | { currentStateVersion: string; entry: { expiresAt?: string; key?: string; revision: string; updatedAt: string; value: unknown; }; migrationRequired: true; stateVersion: string; writerContractDigest: string; })>; limit: number; nextOffset?: number; offset: number; };
+export type StateListInput = {
+  limit: number;
+  offset?: number;
+  prefix?: string;
+  store: string;
+};
+export type StateListOutput = {
+  count: number;
+  entries: Array<
+    ({
+      expiresAt?: string;
+      key?: string;
+      revision: string;
+      updatedAt: string;
+      value: unknown;
+    } | {
+      currentStateVersion: string;
+      entry: {
+        expiresAt?: string;
+        key?: string;
+        revision: string;
+        updatedAt: string;
+        value: unknown;
+      };
+      migrationRequired: true;
+      stateVersion: string;
+      writerContractDigest: string;
+    })
+  >;
+  limit: number;
+  nextOffset?: number;
+  offset: number;
+};
 
-export type StatePutInput = { expectedRevision?: (string | null); key?: string; store: string; ttlMs?: number; value: unknown; };
-export type StatePutOutput = ({ applied: true; entry: { expiresAt?: string; key?: string; revision: string; updatedAt: string; value: unknown; }; } | { applied: false; entry?: ({ expiresAt?: string; key?: string; revision: string; updatedAt: string; value: unknown; } | { currentStateVersion: string; entry: { expiresAt?: string; key?: string; revision: string; updatedAt: string; value: unknown; }; migrationRequired: true; stateVersion: string; writerContractDigest: string; }); found: boolean; });
+export type StatePutInput = {
+  expectedRevision?: string | null;
+  key?: string;
+  store: string;
+  ttlMs?: number;
+  value: unknown;
+};
+export type StatePutOutput = {
+  applied: true;
+  entry: {
+    expiresAt?: string;
+    key?: string;
+    revision: string;
+    updatedAt: string;
+    value: unknown;
+  };
+} | {
+  applied: false;
+  entry?: {
+    expiresAt?: string;
+    key?: string;
+    revision: string;
+    updatedAt: string;
+    value: unknown;
+  } | {
+    currentStateVersion: string;
+    entry: {
+      expiresAt?: string;
+      key?: string;
+      revision: string;
+      updatedAt: string;
+      value: unknown;
+    };
+    migrationRequired: true;
+    stateVersion: string;
+    writerContractDigest: string;
+  };
+  found: boolean;
+};
 
 export interface RpcMap {
-  "State.Admin.Delete": { input: StateAdminDeleteInput; output: StateAdminDeleteOutput; };
-  "State.Admin.Get": { input: StateAdminGetInput; output: StateAdminGetOutput; };
-  "State.Admin.List": { input: StateAdminListInput; output: StateAdminListOutput; };
-  "State.Delete": { input: StateDeleteInput; output: StateDeleteOutput; };
-  "State.Get": { input: StateGetInput; output: StateGetOutput; };
-  "State.List": { input: StateListInput; output: StateListOutput; };
-  "State.Put": { input: StatePutInput; output: StatePutOutput; };
+  "State.Admin.Delete": {
+    input: StateAdminDeleteInput;
+    output: StateAdminDeleteOutput;
+  };
+  "State.Admin.Get": { input: StateAdminGetInput; output: StateAdminGetOutput };
+  "State.Admin.List": {
+    input: StateAdminListInput;
+    output: StateAdminListOutput;
+  };
+  "State.Delete": { input: StateDeleteInput; output: StateDeleteOutput };
+  "State.Get": { input: StateGetInput; output: StateGetOutput };
+  "State.List": { input: StateListInput; output: StateListOutput };
+  "State.Put": { input: StatePutInput; output: StatePutOutput };
 }
 
-export type StateAdminDeleteHandler = RpcHandlerFn<typeof API.owned, "State.Admin.Delete">;
-export type StateAdminGetHandler = RpcHandlerFn<typeof API.owned, "State.Admin.Get">;
-export type StateAdminListHandler = RpcHandlerFn<typeof API.owned, "State.Admin.List">;
+export type StateAdminDeleteHandler = RpcHandlerFn<
+  typeof API.owned,
+  "State.Admin.Delete"
+>;
+export type StateAdminGetHandler = RpcHandlerFn<
+  typeof API.owned,
+  "State.Admin.Get"
+>;
+export type StateAdminListHandler = RpcHandlerFn<
+  typeof API.owned,
+  "State.Admin.List"
+>;
 export type StateDeleteHandler = RpcHandlerFn<typeof API.owned, "State.Delete">;
 export type StateGetHandler = RpcHandlerFn<typeof API.owned, "State.Get">;
 export type StateListHandler = RpcHandlerFn<typeof API.owned, "State.List">;
@@ -52,4 +256,3 @@ export interface FeedMap {
 
 export interface SubjectMap {
 }
-

package/src/server/service.ts

@@ -49,7 +49,12 @@ import {
 } from "@qlever-llc/result";
 import { Type } from "typebox";
 import { Value } from "typebox/value";
-import { type HealthCheckFn, ServiceHealth } from "./health.js";
+import {
+  type HealthCheckFn,
+  ServiceHealth,
+  type ServiceHealthCheck,
+  type ServiceHealthInfo,
+} from "./health.js";
 import { mountStandardHealthRpc } from "./health_rpc.js";
 import type { EventDesc, RPCDesc } from "../contracts.js";
 import type {
@@ -951,6 +956,22 @@ type ContractJobName<
   >,
 > = keyof ContractJobsOf<TContract> & string;
 
+type ContractEventName<
+  TContract extends ServiceContract<
+    TrellisAPI,
+    TrellisAPI | undefined,
+    ContractJobsMetadata
+  >,
+> = ServiceEventName<ContractTrellisApi<TContract>>;
+
+type ContractFeedName<
+  TContract extends ServiceContract<
+    TrellisAPI,
+    TrellisAPI | undefined,
+    ContractJobsMetadata
+  >,
+> = keyof ContractOwnedApi<TContract>["feeds"] & string;
+
 type ContractOperationName<
   TContract extends ServiceContract<
     TrellisAPI,
@@ -986,6 +1007,7 @@ export type JobArgs<
     ContractKvMetadata
   >,
   TJob extends ContractJobName<TContract>,
+  TDeps = undefined,
 > = {
   job: PublicActiveJob<
     ContractJobPayload<TContract, TJob>,
@@ -996,7 +1018,7 @@ export type JobArgs<
     ContractKvOf<TContract>,
     ContractJobsOf<TContract>
   >;
-};
+} & WithDeps<TDeps>;
 
 /** Result returned by a typed Trellis service job handler. */
 export type JobResult<
@@ -1009,6 +1031,9 @@ export type JobResult<
   TJob extends ContractJobName<TContract>,
 > = Result<ContractJobResult<TContract, TJob>, BaseError>;
 
+type WithDeps<TDeps> = [TDeps] extends [undefined] ? {} : { deps: TDeps };
+
+/** Typed RPC handler function for an extracted Trellis service handler. */
 export type RpcHandler<
   TContract extends ServiceContract<
     TrellisAPI,
@@ -1017,6 +1042,7 @@ export type RpcHandler<
     ContractKvMetadata
   >,
   M extends RpcMethodName<ContractOwnedApi<TContract>>,
+  TDeps = undefined,
 > = ({
   input,
   context,
@@ -1029,7 +1055,7 @@ export type RpcHandler<
     ContractKvOf<TContract>,
     ContractJobsOf<TContract>
   >;
-}) =>
+} & WithDeps<TDeps>) =>
   | Promise<
     Result<
       RpcMethodOutput<ContractOwnedApi<TContract>, M>,
@@ -1041,6 +1067,55 @@ export type RpcHandler<
     RpcHandlerErrorOf<ContractOwnedApi<TContract>, M>
   >;
 
+/** Typed event listener function for an extracted Trellis service listener. */
+export type ServiceEventHandler<
+  TContract extends ServiceContract<
+    TrellisAPI,
+    TrellisAPI | undefined,
+    ContractJobsMetadata,
+    ContractKvMetadata
+  >,
+  E extends ContractEventName<TContract>,
+  TDeps = undefined,
+> = (
+  args: {
+    event: ServiceEventOf<ContractTrellisApi<TContract>, E>;
+    context: EventListenerContext;
+    client: Trellis<
+      ContractTrellisApi<TContract>,
+      ContractKvOf<TContract>,
+      ContractJobsOf<TContract>
+    >;
+  } & WithDeps<TDeps>,
+) => MaybeAsync<void, BaseError>;
+
+/** Typed feed handler function for an extracted Trellis service handler. */
+export type FeedHandler<
+  TContract extends ServiceContract<
+    TrellisAPI,
+    TrellisAPI | undefined,
+    ContractJobsMetadata,
+    ContractKvMetadata
+  >,
+  F extends ContractFeedName<TContract>,
+  TDeps = undefined,
+> = (
+  context: {
+    input: FeedInputOf<ContractOwnedApi<TContract>, F>;
+    caller: unknown;
+    signal: AbortSignal;
+    emit(
+      event: FeedEventOf<ContractOwnedApi<TContract>, F>,
+    ): AsyncResult<void, ValidationError | UnexpectedError>;
+    client: Trellis<
+      ContractTrellisApi<TContract>,
+      ContractKvOf<TContract>,
+      ContractJobsOf<TContract>
+    >;
+  } & WithDeps<TDeps>,
+) => unknown | Promise<unknown>;
+
+/** Typed job handler function for an extracted Trellis service job handler. */
 export type JobHandler<
   TContract extends ServiceContract<
     TrellisAPI,
@@ -1049,8 +1124,12 @@ export type JobHandler<
     ContractKvMetadata
   >,
   TJob extends ContractJobName<TContract>,
-> = (args: JobArgs<TContract, TJob>) => Promise<JobResult<TContract, TJob>>;
+  TDeps = undefined,
+> = (args: JobArgs<TContract, TJob, TDeps>) => Promise<
+  JobResult<TContract, TJob>
+>;
 
+/** Typed operation handler function for an extracted Trellis service handler. */
 export type OperationHandler<
   TContract extends ServiceContract<
     TrellisAPI,
@@ -1059,6 +1138,7 @@ export type OperationHandler<
     ContractKvMetadata
   >,
   O extends ContractOperationName<TContract>,
+  TDeps = undefined,
 > = (
   args:
     & OperationHandlerContext<
@@ -1073,9 +1153,20 @@ export type OperationHandler<
         ContractKvOf<TContract>,
         ContractJobsOf<TContract>
       >;
-    },
+    }
+    & WithDeps<TDeps>,
 ) => unknown | Promise<unknown>;
 
+/** Typed health info function for an extracted bound service health handler. */
+export type HealthInfoHandler<TDeps = undefined> = (
+  args: WithDeps<TDeps>,
+) => ServiceHealthInfo | undefined | Promise<ServiceHealthInfo | undefined>;
+
+/** Typed health check function for an extracted bound service health handler. */
+export type HealthCheckHandler<TDeps = undefined> = (
+  args: WithDeps<TDeps>,
+) => ServiceHealthCheck | Promise<ServiceHealthCheck>;
+
 export type JobQueue<
   TPayload,
   TResult,
@@ -1320,6 +1411,14 @@ type BoundJobsFacadeOf<
   >;
 };
 
+type BoundServiceHealth<TDeps> = Omit<ServiceHealth, "add" | "setInfo"> & {
+  setInfo(info: ServiceHealthInfo | HealthInfoHandler<TDeps>): void;
+  add(
+    name: string,
+    check: HealthCheckHandler<TDeps>,
+  ): () => void;
+};
+
 /** Service wrapper returned by `TrellisService.with(deps)`. */
 export type BoundTrellisService<
   TOwnedApi extends TrellisAPI = TrellisAPI,
@@ -1335,7 +1434,6 @@ export type BoundTrellisService<
     | "nc"
     | "kv"
     | "store"
-    | "health"
     | "connection"
     | "createTransfer"
     | "completeOperation"
@@ -1350,6 +1448,7 @@ export type BoundTrellisService<
       TJobs,
       TDeps
     >;
+    readonly health: BoundServiceHealth<TDeps>;
     readonly jobs: BoundJobsFacadeOf<TJobs, TTrellisApi, TKv, TDeps>;
     readonly handle: BoundTypedServiceHandleFacade<
       TOwnedApi,
@@ -2691,7 +2790,7 @@ export class TrellisService<
       kv: this.kv,
       store: this.store,
       jobs: createBoundJobsFacade({ jobs: this.jobs, deps }),
-      health: this.health,
+      health: this.#createBoundHealth(deps),
       handle: this.#createBoundHandleFacade(deps),
       connection: this.connection,
       createTransfer: (args) => this.createTransfer(args),
@@ -2703,6 +2802,33 @@ export class TrellisService<
     };
   }
 
+  #createBoundHealth<TDeps>(deps: TDeps): BoundServiceHealth<TDeps> {
+    const health = this.health;
+    return {
+      serviceName: health.serviceName,
+      kind: health.kind,
+      instanceId: health.instanceId,
+      contractId: health.contractId,
+      contractDigest: health.contractDigest,
+      startedAt: health.startedAt,
+      publishIntervalMs: health.publishIntervalMs,
+      setInfo(info) {
+        if (typeof info !== "function") {
+          health.setInfo(info);
+          return;
+        }
+
+        health.setInfo(() => info({ deps }));
+      },
+      add(name, check) {
+        return health.add(name, () => check({ deps }));
+      },
+      checks: () => health.checks(),
+      response: () => health.response(),
+      heartbeat: () => health.heartbeat(),
+    };
+  }
+
   #createBoundEventFacade<TDeps>(
     deps: TDeps,
   ): BoundActiveEventFacade<TTrellisApi, TTrellisApi, TKv, TJobs, TDeps> {

package/src/service/deno.ts

@@ -1,6 +1,9 @@
 import "../_dnt.polyfills.js";
 export {
   type BoundTrellisService,
+  type FeedHandler,
+  type HealthCheckHandler,
+  type HealthInfoHandler,
   type JobArgs,
   type JobHandler,
   type JobQueue,
@@ -10,6 +13,7 @@ export {
   type OperationRegistration,
   type RpcHandler,
   type ServiceContract,
+  type ServiceEventHandler,
   type Trellis,
   TrellisService,
   type TrellisServiceConnectOpts,

package/src/service/mod.ts

@@ -37,6 +37,9 @@ export {
 } from "../server/health_schemas.js";
 export {
   type BoundTrellisService,
+  type FeedHandler,
+  type HealthCheckHandler,
+  type HealthInfoHandler,
   type JobArgs,
   type JobHandler,
   type JobQueue,
@@ -46,6 +49,7 @@ export {
   type OperationRegistration,
   type RpcHandler,
   type ServiceContract,
+  type ServiceEventHandler,
   StoreHandle,
   type Trellis,
   TrellisService,

package/src/service/node.ts

@@ -1,6 +1,9 @@
 import "../_dnt.polyfills.js";
 export {
   type BoundTrellisService,
+  type FeedHandler,
+  type HealthCheckHandler,
+  type HealthInfoHandler,
   type JobArgs,
   type JobHandler,
   type JobQueue,
@@ -10,6 +13,7 @@ export {
   type OperationRegistration,
   type RpcHandler,
   type ServiceContract,
+  type ServiceEventHandler,
   type Trellis,
   TrellisService,
   type TrellisServiceConnectOpts,