@allorc/a423-sdk 0.6.0 → 0.8.1

package/src/workflow.d.ts

@@ -19,7 +19,9 @@ export interface CancellationSubflow {
  id: string;kind: 'cancellation';parent_job_id: string;status: 'proposal_pending'|'proposal_rejected'|'negotiating'|'acceptance_pending'|'accepted'|'execution_pending'|'execution_failed'|'completed'|'disputed';started_at: string;updated_at: string;proposal_revision: number;instruction: CancellationInstruction | null;receipt: CancellationReceipt | null;events: Array<{sequence: number;type: string;actor_id: string;at: string;data: Json}>;accepted_at?: string;approved_by?: string[];completed_at?: string;execution_reference?: string | null;closing_action?: string;last_error?: string | null;
 }
 export interface CancellationApproval {expected_revision: number;proposal_hash: string;payer_signature: string;worker_signature: string}
+export interface PreFundingCancellation {id: string;epoch: number;action: 'cancel'|'decline';actor_id: string;prior_state: string;accepted_by: string[];agreement: Agreement | null;reason: string | null;at: string;reopen_approvals: string[];reopened_at: string | null}
 export interface WorkflowJob {
+  epoch?: number;agreement_revision?: number;pre_funding_cancellations?: PreFundingCancellation[];
   subflows?: CancellationSubflow[];active_subflow_id?: string | null;
   work_status?: string;negotiation?: Negotiation | null;escrow_ledger?: EscrowLedger | null;
   id: string; protocol: 'a423.workflow.v1'; version: number; state: string;
@@ -41,9 +43,10 @@ export type Effect = (context: AdapterContext) => Promise<AdapterResult>;
 export interface Transition { from: string[]; roles: string[]; to: string; effect?: boolean }
 export interface WorkflowOptions {
   store: WorkflowStore;
-  adapters?: Record<string, Effect | { execute: Effect; reconcile?: Effect }>;
+  adapters?: Record<string, Effect | { execute: Effect; reconcile?: Effect; rejectPending?: Effect }>;
   /** Return true to allow; authenticated actor ID must be supplied by your application. */
-  authorize?(context: { job: WorkflowJob; action: string; actor: string; input: Json }): boolean | Promise<boolean>;
+  authorize?(context: { job: WorkflowJob; action: string; actor: string; input: Json;phase?: 'execute'|'reconcile' }): boolean | Promise<boolean>;
+  prepareInput?(context: {job: WorkflowJob;action: string;actor: string;input: Json}): Promise<Json>;
   /** Throw to reject application-specific terms. */
   validateEvidence?(context: {job: WorkflowJob;action: string;evidence: {[key: string]: Json}}): void | Promise<void>;
   validateTerms?(terms: { [key: string]: Json }): void | Promise<void>;
@@ -55,13 +58,14 @@ export interface Workflow {
   get(id: string, actor: string): Promise<WorkflowJob>;
   assertSafe(id: string, actor: string): Promise<WorkflowJob>;
   act(id: string, action: string, input: Json, options: { actor: string; idempotencyKey: string }): Promise<WorkflowJob>;
+  rejectPendingOperation(id: string,input: {operation_id: string;reason: string},options: {actor: string}): Promise<WorkflowJob>;
   resume(id: string, actor: string): Promise<WorkflowJob>;
   reconcile(id: string, actor: string): Promise<WorkflowJob>;
   cancellation(id: string, actor: string): Promise<CancellationSubflow | null>;
   cancellationInstruction(id: string, actor: string): Promise<CancellationInstruction>;
   cancellationReceipt(id: string, actor: string): Promise<CancellationReceipt>;
   acceptCancellation(id: string,input: CancellationApproval,options: {actor: string;idempotencyKey: string;forward?: boolean}): Promise<WorkflowJob>;
-  receipts(id: string, actor: string): Promise<Pick<WorkflowJob, 'protocol' | 'state' | 'agreement' | 'submission' | 'evidence' | 'events' | 'pending' | 'work_status' | 'negotiation' | 'escrow_ledger' | 'subflows' | 'active_subflow_id'> & { job_id: string }>;
+  receipts(id: string, actor: string): Promise<Pick<WorkflowJob, 'epoch' | 'pre_funding_cancellations' | 'protocol' | 'state' | 'agreement' | 'submission' | 'evidence' | 'events' | 'pending' | 'work_status' | 'negotiation' | 'escrow_ledger' | 'subflows' | 'active_subflow_id'> & { job_id: string }>;
 }
 export function hashAgreement(terms: Json): string;
 export function createWorkflow(options: WorkflowOptions): Workflow;