@valon-technologies/gestalt 0.0.1-alpha.36 → 0.0.1-alpha.37

package/src/workflow-access.ts

@@ -13,6 +13,7 @@ import {
   ENV_HOST_SERVICE_SOCKET,
   ENV_HOST_SERVICE_TOKEN,
 } from "./host-service.ts";
+import { hostInvocationContext } from "./invocation-context.ts";
 import type { Request, SubjectInput } from "./api.ts";
 import { jsonFromValue, structFromObject, type JsonObjectInput } from "./protocol.ts";
 import {
@@ -179,21 +180,22 @@ export interface Workflow {
 /**
  * Client for applying workflow definitions and controlling durable runs.
  *
- * The constructor accepts either a Gestalt request or an invocation token. Each
- * workflow call forwards that token to the workflow-provider facade. When
- * constructed from a request, mutating calls reuse the request idempotency key
- * unless the call provides one explicitly.
+ * Mutating calls reuse the request idempotency key unless the call provides one
+ * explicitly.
  */
 class WorkflowImpl implements Workflow {
   private readonly client: Client<typeof WorkflowProviderService>;
-  private readonly invocationToken: string;
+  private readonly invocationContext: ReturnType<typeof hostInvocationContext>;
   private readonly idempotencyKey: string;
 
   constructor(request: Request);
   constructor(invocationToken: string);
   constructor(requestOrToken: Request | string) {
-    this.invocationToken = normalizeInvocationToken(requestOrToken);
-    this.idempotencyKey = normalizeIdempotencyKey(requestOrToken);
+    this.invocationContext = hostInvocationContext(requestOrToken);
+    if (typeof requestOrToken === "string" && !this.invocationContext.invocationToken) {
+      throw new Error("workflow: invocation token is not available");
+    }
+    this.idempotencyKey = typeof requestOrToken === "string" ? "" : requestOrToken.idempotencyKey.trim();
 
     const target = process.env[ENV_HOST_SERVICE_SOCKET]?.trim();
     if (!target) {
@@ -220,7 +222,7 @@ class WorkflowImpl implements Workflow {
         await this.client.applyDefinition({
           providerName: request.providerName,
           spec: workflowDefinitionSpecToProto(request.spec),
-          invocationToken: this.invocationToken,
+          ...this.invocationContext,
           idempotencyKey: request.idempotencyKey?.trim() || this.idempotencyKey,
           requestedBySubjectId: request.requestedBySubjectId ?? "",
         }),
@@ -237,19 +239,19 @@ class WorkflowImpl implements Workflow {
       workflowDefinitionFromProto(
         await this.client.getDefinition({
           definitionId: request.definitionId,
-          invocationToken: this.invocationToken,
+          ...this.invocationContext,
         }),
       ),
       "Workflow.getDefinition returned no definition",
     );
   }
 
-  /** Lists workflow definitions visible to the current invocation token. */
+  /** Lists workflow definitions visible to the request context. */
   async listDefinitions(
     _request: WorkflowListDefinitions = {},
   ): Promise<readonly WorkflowDefinition[]> {
     const response = await this.client.listDefinitions({
-      invocationToken: this.invocationToken,
+      ...this.invocationContext,
     });
     return response.definitions.map((definition) =>
       requireDefinition(workflowDefinitionFromProto(definition), "Workflow.listDefinitions returned an empty definition")
@@ -265,7 +267,7 @@ class WorkflowImpl implements Workflow {
         await this.client.setDefinitionPaused({
           definitionId: request.definitionId,
           paused: request.paused,
-          invocationToken: this.invocationToken,
+          ...this.invocationContext,
           requestedBySubjectId: request.requestedBySubjectId ?? "",
         }),
       ),
@@ -283,7 +285,7 @@ class WorkflowImpl implements Workflow {
           definitionId: request.definitionId,
           activationId: request.activationId,
           paused: request.paused,
-          invocationToken: this.invocationToken,
+          ...this.invocationContext,
           requestedBySubjectId: request.requestedBySubjectId ?? "",
         }),
       ),
@@ -297,7 +299,7 @@ class WorkflowImpl implements Workflow {
   ): Promise<void> {
     await this.client.deleteDefinition({
       definitionId: request.definitionId,
-      invocationToken: this.invocationToken,
+      ...this.invocationContext,
     });
   }
 
@@ -314,7 +316,7 @@ class WorkflowImpl implements Workflow {
           input: structFromObject(request.input),
           idempotencyKey: request.idempotencyKey?.trim() || this.idempotencyKey,
           workflowKey: request.workflowKey ?? "",
-          invocationToken: this.invocationToken,
+          ...this.invocationContext,
           createdBySubjectId: request.createdBySubjectId ?? "",
           runAs: subjectToProto(request.runAs),
         }),
@@ -331,14 +333,14 @@ class WorkflowImpl implements Workflow {
       workflowRunFromProto(
         await this.client.getRun({
           runId: request.runId,
-          invocationToken: this.invocationToken,
+          ...this.invocationContext,
         }),
       ),
       "Workflow.getRun returned no run",
     );
   }
 
-  /** Lists workflow runs visible to the current invocation token. */
+  /** Lists workflow runs visible to the request context. */
   async listRuns(
     request: WorkflowListRuns = {},
   ): Promise<{ runs: readonly WorkflowRun[]; nextPageToken?: string | undefined }> {
@@ -347,7 +349,7 @@ class WorkflowImpl implements Workflow {
       pageToken: request.pageToken ?? "",
       status: request.status ?? 0,
       targetApp: request.targetApp ?? "",
-      invocationToken: this.invocationToken,
+      ...this.invocationContext,
     });
     return {
       runs: response.runs.map((run) => requireRun(workflowRunFromProto(run), "Workflow.listRuns returned an empty run")),
@@ -361,7 +363,7 @@ class WorkflowImpl implements Workflow {
   ): Promise<readonly WorkflowRunEvent[]> {
     const response = await this.client.getRunEvents({
       runId: request.runId,
-      invocationToken: this.invocationToken,
+      ...this.invocationContext,
     });
     return response.events.map((event) =>
       requireRunEvent(workflowRunEventFromProto(event), "Workflow.getRunEvents returned an empty event")
@@ -374,7 +376,7 @@ class WorkflowImpl implements Workflow {
   ): Promise<GetWorkflowProviderRunOutputResponse> {
     const response = await this.client.getRunOutput({
       runId: request.runId,
-      invocationToken: this.invocationToken,
+      ...this.invocationContext,
     });
     return {
       output: response.output === undefined
@@ -392,7 +394,7 @@ class WorkflowImpl implements Workflow {
         await this.client.cancelRun({
           runId: request.runId,
           reason: request.reason ?? "",
-          invocationToken: this.invocationToken,
+          ...this.invocationContext,
         }),
       ),
       "Workflow.cancelRun returned no run",
@@ -408,7 +410,7 @@ class WorkflowImpl implements Workflow {
         await this.client.signalRun({
           runId: request.runId,
           signal: workflowSignalToProto(request.signal),
-          invocationToken: this.invocationToken,
+          ...this.invocationContext,
         }),
       ),
       "Workflow.signalRun returned no response",
@@ -429,7 +431,7 @@ class WorkflowImpl implements Workflow {
           input: structFromObject(request.input),
           idempotencyKey: request.idempotencyKey?.trim() || this.idempotencyKey,
           signal: workflowSignalToProto(request.signal),
-          invocationToken: this.invocationToken,
+          ...this.invocationContext,
           createdBySubjectId: request.createdBySubjectId ?? "",
           runAs: subjectToProto(request.runAs),
         }),
@@ -448,7 +450,7 @@ class WorkflowImpl implements Workflow {
           appName: request.appName ?? "",
           event: workflowEventToProto(request.event),
           deliveredBySubjectId: request.deliveredBySubjectId ?? "",
-          invocationToken: this.invocationToken,
+          ...this.invocationContext,
           providerName: request.providerName ?? "",
         }),
       ),
@@ -459,25 +461,6 @@ class WorkflowImpl implements Workflow {
 
 export const Workflow = WorkflowImpl;
 
-function normalizeInvocationToken(requestOrToken: Request | string): string {
-  const invocationToken =
-    typeof requestOrToken === "string"
-      ? requestOrToken
-      : requestOrToken.invocationToken;
-  const trimmed = invocationToken.trim();
-  if (!trimmed) {
-    throw new Error("workflow: invocation token is not available");
-  }
-  return trimmed;
-}
-
-function normalizeIdempotencyKey(requestOrToken: Request | string): string {
-  if (typeof requestOrToken === "string") {
-    return "";
-  }
-  return requestOrToken.idempotencyKey.trim();
-}
-
 function generationToBigInt(value: bigint | number | undefined): bigint {
   if (value === undefined) {
     return 0n;

package/src/workflow.ts

@@ -18,9 +18,16 @@ import {
   type Request,
   type Subject,
   type SubjectInput,
+  type SubjectPermission,
   errorMessage,
 } from "./api.ts";
-import { SubjectContextSchema, type SubjectContext } from "./internal/gen/v1/app_pb.ts";
+import {
+  SubjectContextSchema,
+  SubjectPermissionContextSchema,
+  type RequestContext as ProtoRequestContext,
+  type SubjectContext,
+  type SubjectPermissionContext,
+} from "./internal/gen/v1/app_pb.ts";
 import {
   ApplyWorkflowProviderDefinitionRequestSchema,
   BoundWorkflowTargetSchema,
@@ -65,6 +72,7 @@ import {
   type ApplyWorkflowProviderDefinitionRequest as ProtoApplyWorkflowProviderDefinitionRequest,
   type BoundWorkflowTarget as ProtoBoundWorkflowTarget,
   type CancelWorkflowProviderRunRequest as ProtoCancelWorkflowProviderRunRequest,
+  type DeleteWorkflowProviderDefinitionRequest as ProtoDeleteWorkflowProviderDefinitionRequest,
   type DeliverWorkflowProviderEventRequest as ProtoDeliverWorkflowProviderEventRequest,
   type GetWorkflowProviderDefinitionRequest as ProtoGetWorkflowProviderDefinitionRequest,
   type GetWorkflowProviderRunEventsRequest as ProtoGetWorkflowProviderRunEventsRequest,
@@ -402,18 +410,27 @@ export interface ApplyWorkflowProviderDefinitionRequest {
   spec?: WorkflowDefinitionSpec | undefined;
   idempotencyKey?: string | undefined;
   requestedBySubjectId?: string | undefined;
+  invocationToken?: string | undefined;
+  context?: ProtoRequestContext | undefined;
 }
 
 export interface GetWorkflowProviderDefinitionRequest {
   definitionId: string;
+  invocationToken?: string | undefined;
+  context?: ProtoRequestContext | undefined;
 }
 
-export interface ListWorkflowProviderDefinitionsRequest {}
+export interface ListWorkflowProviderDefinitionsRequest {
+  invocationToken?: string | undefined;
+  context?: ProtoRequestContext | undefined;
+}
 
 export interface SetWorkflowProviderDefinitionPausedRequest {
   definitionId: string;
   paused: boolean;
   requestedBySubjectId?: string | undefined;
+  invocationToken?: string | undefined;
+  context?: ProtoRequestContext | undefined;
 }
 
 export interface SetWorkflowProviderActivationPausedRequest {
@@ -421,10 +438,14 @@ export interface SetWorkflowProviderActivationPausedRequest {
   activationId: string;
   paused: boolean;
   requestedBySubjectId?: string | undefined;
+  invocationToken?: string | undefined;
+  context?: ProtoRequestContext | undefined;
 }
 
 export interface DeleteWorkflowProviderDefinitionRequest {
   definitionId: string;
+  invocationToken?: string | undefined;
+  context?: ProtoRequestContext | undefined;
 }
 
 export interface StartWorkflowProviderRunRequest {
@@ -435,10 +456,14 @@ export interface StartWorkflowProviderRunRequest {
   createdBySubjectId?: string | undefined;
   runAs?: SubjectInput | undefined;
   workflowKey?: string | undefined;
+  invocationToken?: string | undefined;
+  context?: ProtoRequestContext | undefined;
 }
 
 export interface GetWorkflowProviderRunRequest {
   runId: string;
+  invocationToken?: string | undefined;
+  context?: ProtoRequestContext | undefined;
 }
 
 export interface ListWorkflowProviderRunsRequest {
@@ -446,24 +471,34 @@ export interface ListWorkflowProviderRunsRequest {
   pageToken?: string | undefined;
   status?: WorkflowRunStatus | undefined;
   targetApp?: string | undefined;
+  invocationToken?: string | undefined;
+  context?: ProtoRequestContext | undefined;
 }
 
 export interface GetWorkflowProviderRunEventsRequest {
   runId: string;
+  invocationToken?: string | undefined;
+  context?: ProtoRequestContext | undefined;
 }
 
 export interface GetWorkflowProviderRunOutputRequest {
   runId: string;
+  invocationToken?: string | undefined;
+  context?: ProtoRequestContext | undefined;
 }
 
 export interface CancelWorkflowProviderRunRequest {
   runId: string;
   reason: string;
+  invocationToken?: string | undefined;
+  context?: ProtoRequestContext | undefined;
 }
 
 export interface SignalWorkflowProviderRunRequest {
   runId: string;
   signal?: WorkflowSignal | undefined;
+  invocationToken?: string | undefined;
+  context?: ProtoRequestContext | undefined;
 }
 
 export interface SignalOrStartWorkflowProviderRunRequest {
@@ -475,6 +510,8 @@ export interface SignalOrStartWorkflowProviderRunRequest {
   createdBySubjectId?: string | undefined;
   runAs?: SubjectInput | undefined;
   signal?: WorkflowSignal | undefined;
+  invocationToken?: string | undefined;
+  context?: ProtoRequestContext | undefined;
 }
 
 export interface SignalWorkflowRunResponse {
@@ -488,6 +525,8 @@ export interface DeliverWorkflowProviderEventRequest {
   appName?: string | undefined;
   event?: WorkflowEvent | undefined;
   deliveredBySubjectId?: string | undefined;
+  invocationToken?: string | undefined;
+  context?: ProtoRequestContext | undefined;
 }
 
 export function workflowText(input: WorkflowText | string = {}): WorkflowText {
@@ -910,8 +949,7 @@ export function createWorkflowProviderService(provider: WorkflowProvider): Workf
       ));
     },
     async listDefinitions(request) {
-      const result = listDefinitionsResult(await invokeWorkflowProvider("list definitions", () => provider.listDefinitions({})));
-      void request;
+      const result = listDefinitionsResult(await invokeWorkflowProvider("list definitions", () => provider.listDefinitions(listWorkflowProviderDefinitionsRequestFromProto(request))));
       return create(ListWorkflowProviderDefinitionsResponseSchema, {
         definitions: result.definitions.map(workflowDefinitionToProto),
       });
@@ -1570,23 +1608,29 @@ function applyWorkflowProviderDefinitionRequestFromProto(input: ProtoApplyWorkfl
     spec: workflowDefinitionSpecFromProto(input.spec),
     idempotencyKey: input.idempotencyKey,
     requestedBySubjectId: input.requestedBySubjectId,
+    invocationToken: input.invocationToken,
+    context: input.context,
   };
 }
 
 function getWorkflowProviderDefinitionRequestFromProto(input: ProtoGetWorkflowProviderDefinitionRequest): GetWorkflowProviderDefinitionRequest {
-  return { definitionId: input.definitionId };
+  return { definitionId: input.definitionId, invocationToken: input.invocationToken, context: input.context };
+}
+
+function listWorkflowProviderDefinitionsRequestFromProto(input: ProtoListWorkflowProviderDefinitionsRequest): ListWorkflowProviderDefinitionsRequest {
+  return { invocationToken: input.invocationToken, context: input.context };
 }
 
 function setWorkflowProviderDefinitionPausedRequestFromProto(input: ProtoSetWorkflowProviderDefinitionPausedRequest): SetWorkflowProviderDefinitionPausedRequest {
-  return { definitionId: input.definitionId, paused: input.paused, requestedBySubjectId: input.requestedBySubjectId };
+  return { definitionId: input.definitionId, paused: input.paused, requestedBySubjectId: input.requestedBySubjectId, invocationToken: input.invocationToken, context: input.context };
 }
 
 function setWorkflowProviderActivationPausedRequestFromProto(input: ProtoSetWorkflowProviderActivationPausedRequest): SetWorkflowProviderActivationPausedRequest {
-  return { definitionId: input.definitionId, activationId: input.activationId, paused: input.paused, requestedBySubjectId: input.requestedBySubjectId };
+  return { definitionId: input.definitionId, activationId: input.activationId, paused: input.paused, requestedBySubjectId: input.requestedBySubjectId, invocationToken: input.invocationToken, context: input.context };
 }
 
-function deleteWorkflowProviderDefinitionRequestFromProto(input: { definitionId: string }): DeleteWorkflowProviderDefinitionRequest {
-  return { definitionId: input.definitionId };
+function deleteWorkflowProviderDefinitionRequestFromProto(input: ProtoDeleteWorkflowProviderDefinitionRequest): DeleteWorkflowProviderDefinitionRequest {
+  return { definitionId: input.definitionId, invocationToken: input.invocationToken, context: input.context };
 }
 
 function startWorkflowProviderRunRequestFromProto(input: ProtoStartWorkflowProviderRunRequest): StartWorkflowProviderRunRequest {
@@ -1598,11 +1642,13 @@ function startWorkflowProviderRunRequestFromProto(input: ProtoStartWorkflowProvi
     createdBySubjectId: input.createdBySubjectId,
     runAs: subjectInputFromProto(input.runAs),
     workflowKey: input.workflowKey,
+    invocationToken: input.invocationToken,
+    context: input.context,
   };
 }
 
 function getWorkflowProviderRunRequestFromProto(input: ProtoGetWorkflowProviderRunRequest): GetWorkflowProviderRunRequest {
-  return { runId: input.runId };
+  return { runId: input.runId, invocationToken: input.invocationToken, context: input.context };
 }
 
 function listWorkflowProviderRunsRequestFromProto(input: ProtoListWorkflowProviderRunsRequest): ListWorkflowProviderRunsRequest {
@@ -1611,23 +1657,25 @@ function listWorkflowProviderRunsRequestFromProto(input: ProtoListWorkflowProvid
     pageToken: input.pageToken,
     status: input.status as WorkflowRunStatus,
     targetApp: input.targetApp,
+    invocationToken: input.invocationToken,
+    context: input.context,
   };
 }
 
 function getWorkflowProviderRunEventsRequestFromProto(input: ProtoGetWorkflowProviderRunEventsRequest): GetWorkflowProviderRunEventsRequest {
-  return { runId: input.runId };
+  return { runId: input.runId, invocationToken: input.invocationToken, context: input.context };
 }
 
 function getWorkflowProviderRunOutputRequestFromProto(input: ProtoGetWorkflowProviderRunOutputRequest): GetWorkflowProviderRunOutputRequest {
-  return { runId: input.runId };
+  return { runId: input.runId, invocationToken: input.invocationToken, context: input.context };
 }
 
 function cancelWorkflowProviderRunRequestFromProto(input: ProtoCancelWorkflowProviderRunRequest): CancelWorkflowProviderRunRequest {
-  return { runId: input.runId, reason: input.reason };
+  return { runId: input.runId, reason: input.reason, invocationToken: input.invocationToken, context: input.context };
 }
 
 function signalWorkflowProviderRunRequestFromProto(input: ProtoSignalWorkflowProviderRunRequest): SignalWorkflowProviderRunRequest {
-  return { runId: input.runId, signal: workflowSignalFromProto(input.signal) };
+  return { runId: input.runId, signal: workflowSignalFromProto(input.signal), invocationToken: input.invocationToken, context: input.context };
 }
 
 function signalOrStartWorkflowProviderRunRequestFromProto(input: ProtoSignalOrStartWorkflowProviderRunRequest): SignalOrStartWorkflowProviderRunRequest {
@@ -1640,6 +1688,8 @@ function signalOrStartWorkflowProviderRunRequestFromProto(input: ProtoSignalOrSt
     createdBySubjectId: input.createdBySubjectId,
     runAs: subjectInputFromProto(input.runAs),
     signal: workflowSignalFromProto(input.signal),
+    invocationToken: input.invocationToken,
+    context: input.context,
   };
 }
 
@@ -1648,6 +1698,8 @@ function deliverWorkflowProviderEventRequestFromProto(input: ProtoDeliverWorkflo
     appName: input.appName,
     event: workflowEventFromProto(input.event),
     deliveredBySubjectId: input.deliveredBySubjectId,
+    invocationToken: input.invocationToken,
+    context: input.context,
   };
 }
 
@@ -1844,6 +1896,9 @@ export function subjectToProto(input?: SubjectInput | Subject): SubjectContext |
     id: input.id ?? "",
     credentialSubjectId: input.credentialSubjectId ?? "",
     email: input.email ?? "",
+    displayName: input.displayName ?? "",
+    scopes: [...(input.scopes ?? [])],
+    permissions: subjectPermissionsToProto(input.permissions),
   });
 }
 
@@ -1853,6 +1908,9 @@ export function subjectFromProto(input?: SubjectContext): Subject | undefined {
     id: input.id,
     credentialSubjectId: input.credentialSubjectId,
     email: input.email,
+    displayName: input.displayName,
+    scopes: [...input.scopes],
+    permissions: subjectPermissionsFromProto(input.permissions),
   };
 }
 
@@ -1862,9 +1920,31 @@ export function subjectInputFromProto(input?: SubjectContext): SubjectInput | un
     id: input.id,
     credentialSubjectId: input.credentialSubjectId,
     email: input.email,
+    displayName: input.displayName,
+    scopes: [...input.scopes],
+    permissions: subjectPermissionsFromProto(input.permissions),
   };
 }
 
+function subjectPermissionsFromProto(
+  permissions: readonly SubjectPermissionContext[],
+): SubjectPermission[] {
+  return permissions.map((permission) => ({
+    app: permission.app,
+    operations: permission.allOperations ? [] : [...permission.operations],
+  }));
+}
+
+function subjectPermissionsToProto(
+  permissions?: readonly SubjectPermission[] | undefined,
+): SubjectPermissionContext[] {
+  return permissions?.map((permission) => create(SubjectPermissionContextSchema, {
+    app: permission.app,
+    operations: [...permission.operations],
+    allOperations: permission.operations.length === 0,
+  })) ?? [];
+}
+
 function listDefinitionsResult(value: readonly WorkflowDefinition[] | ListWorkflowProviderDefinitionsResponse): ListWorkflowProviderDefinitionsResponse {
   return "definitions" in value ? value : { definitions: value };
 }