import {z} from 'zod' export type GetApiApiV3MetaBasesBaseIdWorkflowsWorkflowIdArgs = {baseId: string, workflowId: string}; export type GetApiApiV3MetaBasesBaseIdWorkflowsWorkflowIdOptions = {baseUrl?: string | undefined, xcToken?: string | undefined, fetch?: typeof fetch | undefined}; export const workflowVariableDefinition: z.ZodType = z.object({key: z.string(), name: z.string(), type: z.enum(["string", "number", "integer", "boolean", "object", "array", "date", "datetime"]), groupKey: z.enum(["meta", "fields", "iteration"]).optional(), isArray: z.boolean().optional(), extra: z.object({entity_id: z.string().optional(), entity: z.enum(["column", "table", "view"]).optional(), icon: z.string().optional(), uiType: z.string().optional(), description: z.string().optional(), port: z.string().optional()}).optional(), children: z.array(z.lazy(() => workflowVariableDefinition)).optional()}); export const workflowNodeExecutionResult = z.object({nodeId: z.string(), nodeTitle: z.string(), status: z.enum(["pending", "running", "success", "error", "skipped"]), input: z.object({}).optional(), output: z.object({}).optional(), error: z.string().optional(), startTime: z.number(), endTime: z.number().optional(), nextNode: z.string().optional(), logs: z.array(z.object({level: z.enum(["info", "warn", "error"]), message: z.string(), ts: z.number().optional(), data: z.object({}).optional()})).optional(), metrics: z.object({}).optional(), inputVariables: z.array(workflowVariableDefinition).optional(), outputVariables: z.array(workflowVariableDefinition).optional(), loopContext: z.object({state: z.object({items: z.array(z.unknown()).optional(), currentIndex: z.number().optional(), totalItems: z.number().optional()}).optional(), bodyPort: z.string().optional(), exitPort: z.string().optional()}).optional(), isStale: z.boolean().optional()}); export const workflowNodeData = z.object({title: z.string(), description: z.string().optional(), config: z.object({}), testResult: workflowNodeExecutionResult.optional(), inputVariables: z.array(workflowVariableDefinition).optional(), outputVariables: z.array(workflowVariableDefinition).optional()}); export const workflowNode = z.object({id: z.string(), type: z.string(), position: z.object({x: z.number(), y: z.number()}), data: workflowNodeData, targetPosition: z.enum(["top", "bottom", "left", "right"]).optional(), sourcePosition: z.enum(["top", "bottom", "left", "right"]).optional()}); export const workflowEdge = z.object({id: z.string(), source: z.string(), target: z.string(), animated: z.boolean().optional(), label: z.string().optional(), sourcePortId: z.string().optional(), targetPortId: z.string().optional()}); export const workflowDraft = z.object({nodes: z.array(workflowNode).optional(), edges: z.array(workflowEdge).optional()}); export const workflowOptions = z.object({run_as: z.object({type: z.enum(["service_account", "role", "user"]), value: z.string().optional()}).optional(), icon: z.string().optional()}); export const workflowGetResponse = z.object({id: z.string(), title: z.string(), description: z.string().nullable().optional(), base_id: z.string(), workspace_id: z.string(), enabled: z.boolean().optional(), nodes: z.array(workflowNode).optional(), edges: z.array(workflowEdge).optional(), draft: workflowDraft.optional(), options: workflowOptions.optional(), created_at: z.string(), updated_at: z.string(), created_by: z.string().optional(), updated_by: z.string().optional()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Get Workflow * * GET /api/v3/meta/bases/{baseId}/workflows/{workflowId} * * Also accepts auth: bearerAuth */ export const getApiApiV3MetaBasesBaseIdWorkflowsWorkflowId = async (args: GetApiApiV3MetaBasesBaseIdWorkflowsWorkflowIdArgs, options?: GetApiApiV3MetaBasesBaseIdWorkflowsWorkflowIdOptions) => { const {baseUrl = "https://app.nocodb.com", fetch: fetchFn = fetch, xcToken} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (xcToken !== undefined) headers.set("xc-token", xcToken) const url = `${baseUrl.replace(/\/+$/, '')}/api/v3/meta/bases/${encodeURIComponent(String(args.baseId))}/workflows/${encodeURIComponent(String(args.workflowId))}${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(workflowGetResponse, await res.json()) };