@vzeta/camunda-api-zod-schemas
Version:
Zod schemas and TypeScript types for Camunda 8 unified API
198 lines (197 loc) • 8.48 kB
TypeScript
import { z } from 'zod';
import { Endpoint } from './common';
declare const decisionDefinitionTypeSchema: z.ZodEnum<{
UNSPECIFIED: "UNSPECIFIED";
UNKNOWN: "UNKNOWN";
DECISION_TABLE: "DECISION_TABLE";
LITERAL_EXPRESSION: "LITERAL_EXPRESSION";
}>;
type DecisionDefinitionType = z.infer<typeof decisionDefinitionTypeSchema>;
declare const decisionInstanceStateSchema: z.ZodEnum<{
UNSPECIFIED: "UNSPECIFIED";
UNKNOWN: "UNKNOWN";
FAILED: "FAILED";
EVALUATED: "EVALUATED";
}>;
type DecisionInstanceState = z.infer<typeof decisionInstanceStateSchema>;
declare const decisionInstanceSchema: z.ZodObject<{
decisionInstanceId: z.ZodString;
state: z.ZodEnum<{
UNSPECIFIED: "UNSPECIFIED";
UNKNOWN: "UNKNOWN";
FAILED: "FAILED";
EVALUATED: "EVALUATED";
}>;
evaluationDate: z.ZodString;
evaluationFailure: z.ZodString;
decisionDefinitionId: z.ZodString;
decisionDefinitionName: z.ZodString;
decisionDefinitionVersion: z.ZodNumber;
decisionDefinitionType: z.ZodEnum<{
UNSPECIFIED: "UNSPECIFIED";
UNKNOWN: "UNKNOWN";
DECISION_TABLE: "DECISION_TABLE";
LITERAL_EXPRESSION: "LITERAL_EXPRESSION";
}>;
result: z.ZodString;
tenantId: z.ZodString;
decisionInstanceKey: z.ZodString;
processDefinitionKey: z.ZodString;
processInstanceKey: z.ZodString;
decisionDefinitionKey: z.ZodString;
elementInstanceKey: z.ZodString;
}, z.core.$strip>;
type DecisionInstance = z.infer<typeof decisionInstanceSchema>;
declare const queryDecisionInstancesRequestBodySchema: z.ZodObject<{
sort: z.ZodOptional<z.ZodArray<z.ZodObject<{
field: z.ZodEnum<{
tenantId: "tenantId";
processDefinitionKey: "processDefinitionKey";
state: "state";
processInstanceKey: "processInstanceKey";
decisionDefinitionId: "decisionDefinitionId";
decisionDefinitionKey: "decisionDefinitionKey";
decisionDefinitionName: "decisionDefinitionName";
decisionDefinitionVersion: "decisionDefinitionVersion";
decisionDefinitionType: "decisionDefinitionType";
decisionInstanceKey: "decisionInstanceKey";
decisionInstanceId: "decisionInstanceId";
evaluationDate: "evaluationDate";
evaluationFailure: "evaluationFailure";
elementInstanceKey: "elementInstanceKey";
processInstanceId: "processInstanceId";
}>;
order: z.ZodOptional<z.ZodEnum<{
asc: "asc";
desc: "desc";
}>>;
}, z.core.$strip>>>;
page: z.ZodOptional<z.ZodObject<{
from: z.ZodOptional<z.ZodNumber>;
limit: z.ZodOptional<z.ZodNumber>;
before: z.ZodOptional<z.ZodOptional<z.ZodString>>;
after: z.ZodOptional<z.ZodOptional<z.ZodString>>;
}, z.core.$strip>>;
filter: z.ZodOptional<z.ZodObject<{
tenantId: z.ZodOptional<z.ZodString>;
processDefinitionKey: z.ZodOptional<z.ZodString>;
state: z.ZodOptional<z.ZodEnum<{
UNSPECIFIED: "UNSPECIFIED";
UNKNOWN: "UNKNOWN";
FAILED: "FAILED";
EVALUATED: "EVALUATED";
}>>;
processInstanceKey: z.ZodOptional<z.ZodString>;
decisionDefinitionId: z.ZodOptional<z.ZodString>;
decisionDefinitionName: z.ZodOptional<z.ZodString>;
decisionDefinitionVersion: z.ZodOptional<z.ZodNumber>;
decisionDefinitionType: z.ZodOptional<z.ZodEnum<{
UNSPECIFIED: "UNSPECIFIED";
UNKNOWN: "UNKNOWN";
DECISION_TABLE: "DECISION_TABLE";
LITERAL_EXPRESSION: "LITERAL_EXPRESSION";
}>>;
decisionInstanceKey: z.ZodOptional<z.ZodString>;
decisionInstanceId: z.ZodOptional<z.ZodString>;
evaluationFailure: z.ZodOptional<z.ZodString>;
elementInstanceKey: z.ZodOptional<z.ZodString>;
evaluationDate: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
$eq: z.ZodOptional<z.ZodString>;
$neq: z.ZodOptional<z.ZodString>;
$exists: z.ZodOptional<z.ZodBoolean>;
$gt: z.ZodOptional<z.ZodString>;
$gte: z.ZodOptional<z.ZodString>;
$lt: z.ZodOptional<z.ZodString>;
$lte: z.ZodOptional<z.ZodString>;
$in: z.ZodOptional<z.ZodArray<z.ZodString>>;
}, z.core.$strip>]>>;
decisionDefinitionKey: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
$eq: z.ZodOptional<z.ZodString>;
$neq: z.ZodOptional<z.ZodString>;
$exists: z.ZodOptional<z.ZodBoolean>;
$in: z.ZodOptional<z.ZodArray<z.ZodString>>;
$notIn: z.ZodOptional<z.ZodArray<z.ZodString>>;
}, z.core.$strip>, z.ZodString]>>;
}, z.core.$strip>>;
}, z.core.$strip>;
type QueryDecisionInstancesRequestBody = z.infer<typeof queryDecisionInstancesRequestBodySchema>;
declare const queryDecisionInstancesResponseBodySchema: z.ZodType<import('./common').QueryResponseBody<{
decisionInstanceId: string;
state: "UNSPECIFIED" | "UNKNOWN" | "FAILED" | "EVALUATED";
evaluationDate: string;
evaluationFailure: string;
decisionDefinitionId: string;
decisionDefinitionName: string;
decisionDefinitionVersion: number;
decisionDefinitionType: "UNSPECIFIED" | "UNKNOWN" | "DECISION_TABLE" | "LITERAL_EXPRESSION";
result: string;
tenantId: string;
decisionInstanceKey: string;
processDefinitionKey: string;
processInstanceKey: string;
decisionDefinitionKey: string;
elementInstanceKey: string;
}>, unknown, z.core.$ZodTypeInternals<import('./common').QueryResponseBody<{
decisionInstanceId: string;
state: "UNSPECIFIED" | "UNKNOWN" | "FAILED" | "EVALUATED";
evaluationDate: string;
evaluationFailure: string;
decisionDefinitionId: string;
decisionDefinitionName: string;
decisionDefinitionVersion: number;
decisionDefinitionType: "UNSPECIFIED" | "UNKNOWN" | "DECISION_TABLE" | "LITERAL_EXPRESSION";
result: string;
tenantId: string;
decisionInstanceKey: string;
processDefinitionKey: string;
processInstanceKey: string;
decisionDefinitionKey: string;
elementInstanceKey: string;
}>, unknown>>;
type QueryDecisionInstancesResponseBody = z.infer<typeof queryDecisionInstancesResponseBodySchema>;
declare const getDecisionInstanceResponseBodySchema: z.ZodObject<{
decisionInstanceId: z.ZodString;
state: z.ZodEnum<{
UNSPECIFIED: "UNSPECIFIED";
UNKNOWN: "UNKNOWN";
FAILED: "FAILED";
EVALUATED: "EVALUATED";
}>;
evaluationDate: z.ZodString;
evaluationFailure: z.ZodString;
decisionDefinitionId: z.ZodString;
decisionDefinitionName: z.ZodString;
decisionDefinitionVersion: z.ZodNumber;
decisionDefinitionType: z.ZodEnum<{
UNSPECIFIED: "UNSPECIFIED";
UNKNOWN: "UNKNOWN";
DECISION_TABLE: "DECISION_TABLE";
LITERAL_EXPRESSION: "LITERAL_EXPRESSION";
}>;
result: z.ZodString;
tenantId: z.ZodString;
decisionInstanceKey: z.ZodString;
processDefinitionKey: z.ZodString;
processInstanceKey: z.ZodString;
decisionDefinitionKey: z.ZodString;
elementInstanceKey: z.ZodString;
evaluatedInputs: z.ZodOptional<z.ZodArray<z.ZodObject<{
inputId: z.ZodString;
inputName: z.ZodString;
inputValue: z.ZodString;
}, z.core.$strip>>>;
matchedRules: z.ZodOptional<z.ZodArray<z.ZodObject<{
ruleId: z.ZodString;
ruleIndex: z.ZodNumber;
evaluatedOutputs: z.ZodArray<z.ZodObject<{
outputId: z.ZodString;
outputName: z.ZodString;
outputValue: z.ZodString;
}, z.core.$strip>>;
}, z.core.$strip>>>;
}, z.core.$strip>;
type GetDecisionInstanceResponseBody = z.infer<typeof getDecisionInstanceResponseBodySchema>;
declare const queryDecisionInstances: Endpoint;
declare const getDecisionInstance: Endpoint<Pick<DecisionInstance, 'decisionInstanceId'>>;
export { decisionDefinitionTypeSchema, decisionInstanceStateSchema, decisionInstanceSchema, queryDecisionInstancesRequestBodySchema, queryDecisionInstancesResponseBodySchema, getDecisionInstanceResponseBodySchema, queryDecisionInstances, getDecisionInstance, };
export type { DecisionDefinitionType, DecisionInstanceState, DecisionInstance, QueryDecisionInstancesRequestBody, QueryDecisionInstancesResponseBody, GetDecisionInstanceResponseBody, };