PersistentAI API Documentation / @persistentai/fireflow-executor / client / useTRPCClient

Variable: useTRPCClient()

useTRPCClient: () => TRPCClient<BuiltRouter<{ ctx: ExecutorContext; errorShape: { code: TRPC_ERROR_CODE_NUMBER; data: { code: "PARSE_ERROR" | "BAD_REQUEST" | "INTERNAL_SERVER_ERROR" | "NOT_IMPLEMENTED" | "BAD_GATEWAY" | "SERVICE_UNAVAILABLE" | "GATEWAY_TIMEOUT" | "UNAUTHORIZED" | "PAYMENT_REQUIRED" | "FORBIDDEN" | "NOT_FOUND" | "METHOD_NOT_SUPPORTED" | "TIMEOUT" | "CONFLICT" | "PRECONDITION_FAILED" | "PAYLOAD_TOO_LARGE" | "UNSUPPORTED_MEDIA_TYPE" | "UNPROCESSABLE_CONTENT" | "PRECONDITION_REQUIRED" | "TOO_MANY_REQUESTS" | "CLIENT_CLOSED_REQUEST"; httpStatus: number; path?: string; stack?: string; zodError: typeToFlattenedError<any, string> | null; }; message: string; }; meta: object; transformer: true; }, DecorateCreateRouterOptions<{ create: MutationProcedure<{ input: { events?: object[]; flowId: string; integration?: objectInputType<{ external: ...; persistentai: ...; wallet: ...; }, ZodAny, "strip">; options?: { breakpoints?: ... | ...; debug?: ... | ... | ...; execution?: ... | ...; }; }; meta: object; output: { executionId: string; }; }>; getEvent: QueryProcedure<{ input: { flowId: string; key: string; timeoutSeconds?: number; workflowId: string; }; meta: object; output: { found: boolean; value: unknown; }; }>; getExecutionDetails: QueryProcedure<{ input: { executionId: string; }; meta: object; output: { completedAt: Date | null; createdAt: Date; errorMessage: string | null; errorNodeId: string | null; executionDepth: number; externalEvents: object[] | null; failureCount: number; flowId: string; id: string; integration: object & object | null; lastFailureAt: Date | null; lastFailureReason: string | null; options: { breakpoints?: ... | ...; debug?: ... | ... | ...; execution?: ... | ...; } | null; ownerId: string; parentExecutionId: string | null; processingStartedAt: Date | null; processingWorkerId: string | null; rootExecutionId: string | null; startedAt: Date | null; status: ExecutionStatus; updatedAt: Date; }; }>; getExecutionsTree: QueryProcedure<{ input: { executionId: string; }; meta: object; output: ExecutionTreeNode[]; }>; getRootExecutions: QueryProcedure<{ input: { after?: Date; flowId: string; limit?: number; }; meta: object; output: RootExecution[]; }>; getWorkflowStatus: QueryProcedure<{ input: { flowId: string; workflowId: string; }; meta: object; output: WorkflowStatus; }>; pause: MutationProcedure<{ input: { executionId: string; reason?: string; }; meta: object; output: { success: boolean; }; }>; resume: MutationProcedure<{ input: { executionId: string; }; meta: object; output: { success: boolean; }; }>; sendMessage: MutationProcedure<{ input: { flowId: string; message?: any; topic?: string; workflowId: string; }; meta: object; output: { success: boolean; }; }>; start: MutationProcedure<{ input: { executionId: string; }; meta: object; output: { success: boolean; }; }>; stop: MutationProcedure<{ input: { executionId: string; reason?: string; }; meta: object; output: { success: boolean; }; }>; subscribeToExecutionEvents: SubscriptionProcedure<{ input: { batchSize?: number; batchTimeoutMs?: number; eventTypes?: string[]; executionId: string; fromIndex?: number; }; meta: object; output: AsyncIterable<ExecutionEventImpl<ExecutionEventEnum>[]>; }>; subscribeToPortStream: SubscriptionProcedure<{ input: { batchSize?: number; batchTimeoutMs?: number; executionId: string; fromOffset?: number; streamKey: string; workflowId: string; }; meta: object; output: AsyncIterable<string[]>; }>; subscribeToStream: SubscriptionProcedure<{ input: { batchSize?: number; batchTimeoutMs?: number; flowId: string; fromOffset?: number; streamKey: string; workflowId: string; }; meta: object; output: AsyncIterable<unknown[]>; }>; }>>>

Defined in: packages/fireflow-executor/client/trpc.ts:111

Returns

TRPCClient<BuiltRouter<{ ctx: ExecutorContext; errorShape: { code: TRPC_ERROR_CODE_NUMBER; data: { code: "PARSE_ERROR" | "BAD_REQUEST" | "INTERNAL_SERVER_ERROR" | "NOT_IMPLEMENTED" | "BAD_GATEWAY" | "SERVICE_UNAVAILABLE" | "GATEWAY_TIMEOUT" | "UNAUTHORIZED" | "PAYMENT_REQUIRED" | "FORBIDDEN" | "NOT_FOUND" | "METHOD_NOT_SUPPORTED" | "TIMEOUT" | "CONFLICT" | "PRECONDITION_FAILED" | "PAYLOAD_TOO_LARGE" | "UNSUPPORTED_MEDIA_TYPE" | "UNPROCESSABLE_CONTENT" | "PRECONDITION_REQUIRED" | "TOO_MANY_REQUESTS" | "CLIENT_CLOSED_REQUEST"; httpStatus: number; path?: string; stack?: string; zodError: typeToFlattenedError<any, string> | null; }; message: string; }; meta: object; transformer: true; }, DecorateCreateRouterOptions<{ create: MutationProcedure<{ input: { events?: object[]; flowId: string; integration?: objectInputType<{ external: ...; persistentai: ...; wallet: ...; }, ZodAny, "strip">; options?: { breakpoints?: ... | ...; debug?: ... | ... | ...; execution?: ... | ...; }; }; meta: object; output: { executionId: string; }; }>; getEvent: QueryProcedure<{ input: { flowId: string; key: string; timeoutSeconds?: number; workflowId: string; }; meta: object; output: { found: boolean; value: unknown; }; }>; getExecutionDetails: QueryProcedure<{ input: { executionId: string; }; meta: object; output: { completedAt: Date | null; createdAt: Date; errorMessage: string | null; errorNodeId: string | null; executionDepth: number; externalEvents: object[] | null; failureCount: number; flowId: string; id: string; integration: object & object | null; lastFailureAt: Date | null; lastFailureReason: string | null; options: { breakpoints?: ... | ...; debug?: ... | ... | ...; execution?: ... | ...; } | null; ownerId: string; parentExecutionId: string | null; processingStartedAt: Date | null; processingWorkerId: string | null; rootExecutionId: string | null; startedAt: Date | null; status: ExecutionStatus; updatedAt: Date; }; }>; getExecutionsTree: QueryProcedure<{ input: { executionId: string; }; meta: object; output: ExecutionTreeNode[]; }>; getRootExecutions: QueryProcedure<{ input: { after?: Date; flowId: string; limit?: number; }; meta: object; output: RootExecution[]; }>; getWorkflowStatus: QueryProcedure<{ input: { flowId: string; workflowId: string; }; meta: object; output: WorkflowStatus; }>; pause: MutationProcedure<{ input: { executionId: string; reason?: string; }; meta: object; output: { success: boolean; }; }>; resume: MutationProcedure<{ input: { executionId: string; }; meta: object; output: { success: boolean; }; }>; sendMessage: MutationProcedure<{ input: { flowId: string; message?: any; topic?: string; workflowId: string; }; meta: object; output: { success: boolean; }; }>; start: MutationProcedure<{ input: { executionId: string; }; meta: object; output: { success: boolean; }; }>; stop: MutationProcedure<{ input: { executionId: string; reason?: string; }; meta: object; output: { success: boolean; }; }>; subscribeToExecutionEvents: SubscriptionProcedure<{ input: { batchSize?: number; batchTimeoutMs?: number; eventTypes?: string[]; executionId: string; fromIndex?: number; }; meta: object; output: AsyncIterable<ExecutionEventImpl<ExecutionEventEnum>[]>; }>; subscribeToPortStream: SubscriptionProcedure<{ input: { batchSize?: number; batchTimeoutMs?: number; executionId: string; fromOffset?: number; streamKey: string; workflowId: string; }; meta: object; output: AsyncIterable<string[]>; }>; subscribeToStream: SubscriptionProcedure<{ input: { batchSize?: number; batchTimeoutMs?: number; flowId: string; fromOffset?: number; streamKey: string; workflowId: string; }; meta: object; output: AsyncIterable<unknown[]>; }>; }>>>