@camunda/camunda-api-zod-schemas 0.0.34 → 0.0.35

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -21,6 +21,21 @@ declare const endpoints: {
21
21
  parentProcessInstanceKey?: string | undefined;
22
22
  parentElementInstanceKey?: string | undefined;
23
23
  }, "processInstanceKey">>;
24
+ readonly modifyProcessInstance: import('../common').Endpoint<Pick<{
25
+ processDefinitionId: string;
26
+ processDefinitionName: string;
27
+ processDefinitionVersion: number;
28
+ startDate: string;
29
+ state: "ACTIVE" | "COMPLETED" | "TERMINATED";
30
+ hasIncident: boolean;
31
+ tenantId: string;
32
+ processInstanceKey: string;
33
+ processDefinitionKey: string;
34
+ processDefinitionVersionTag?: string | undefined;
35
+ endDate?: string | undefined;
36
+ parentProcessInstanceKey?: string | undefined;
37
+ parentElementInstanceKey?: string | undefined;
38
+ }, "processInstanceKey">>;
24
39
  readonly createDeployment: import('../common').Endpoint<undefined>;
25
40
  readonly deleteResource: import('../common').Endpoint<{
26
41
  resourceKey: string;
@@ -37,6 +52,6 @@ declare const endpoints: {
37
52
  export { endpoints };
38
53
  export { auditLogEntityTypeSchema, auditLogOperationTypeSchema, auditLogActorTypeSchema, auditLogResultSchema, auditLogCategorySchema, auditLogSchema, auditLogFilterSchema, auditLogSortFieldEnum, queryAuditLogsRequestBodySchema, queryAuditLogsResponseBodySchema, getAuditLogResponseBodySchema, type AuditLog, type AuditLogEntityType, type AuditLogOperationType, type AuditLogActorType, type AuditLogResult, type AuditLogCategory, type AuditLogSortField, type QueryAuditLogsRequestBody, type QueryAuditLogsResponseBody, type GetAuditLogResponseBody, } from './audit-log';
39
54
  export { userTaskAuditLogFilterSchema, queryUserTaskAuditLogsRequestBodySchema, queryUserTaskAuditLogsResponseBodySchema, queryUserTaskAuditLogs, type UserTaskAuditLogFilter, type QueryUserTaskAuditLogsRequestBody, type QueryUserTaskAuditLogsResponseBody, } from './user-task';
40
- export { deleteProcessInstanceRequestBodySchema, type DeleteProcessInstanceRequestBody } from './process-instance';
55
+ export { deleteProcessInstanceRequestBodySchema, modifyProcessInstanceRequestBodySchema, type DeleteProcessInstanceRequestBody, type ModifyProcessInstanceRequestBody, } from './process-instance';
41
56
  export { createDeploymentResponseBodySchema, deleteResourceRequestBodySchema, deleteResourceResponseBodySchema, batchOperationCreatedResultSchema, resourceSchema, getResourceContentResponseBodySchema, processDeploymentSchema, decisionDeploymentSchema, decisionRequirementsDeploymentSchema, formDeploymentSchema, resourceDeploymentSchema, type CreateDeploymentResponseBody, type DeleteResourceRequestBody, type DeleteResourceResponseBody, type BatchOperationCreatedResult, type Resource, type GetResourceContentResponseBody, type ProcessDeployment, type DecisionDeployment, type DecisionRequirementsDeployment, type FormDeployment, type ResourceDeployment, } from './resource';
42
57
  export { getIncidentProcessInstanceStatisticsByErrorRequestBodySchema, getIncidentProcessInstanceStatisticsByErrorResponseBodySchema, incidentProcessInstanceStatisticsByErrorSchema, getIncidentProcessInstanceStatisticsByDefinitionRequestBodySchema, getIncidentProcessInstanceStatisticsByDefinitionResponseBodySchema, incidentProcessInstanceStatisticsByDefinitionSchema, type IncidentProcessInstanceStatisticsByError, type GetIncidentProcessInstanceStatisticsByErrorRequestBody, type GetIncidentProcessInstanceStatisticsByErrorResponseBody, type IncidentProcessInstanceStatisticsByDefinition, type GetIncidentProcessInstanceStatisticsByDefinitionRequestBody, type GetIncidentProcessInstanceStatisticsByDefinitionResponseBody, } from './incident';
package/dist/8.9/index.js CHANGED
@@ -1,6 +1,6 @@
1
1
  import { auditLogActorTypeSchema, auditLogCategorySchema, auditLogEntityTypeSchema, auditLogFilterSchema, auditLogOperationTypeSchema, auditLogResultSchema, auditLogSchema, auditLogSortFieldEnum, getAuditLogResponseBodySchema, queryAuditLogsRequestBodySchema, queryAuditLogsResponseBodySchema } from "./audit-log.js";
2
2
  import { queryUserTaskAuditLogs, queryUserTaskAuditLogsRequestBodySchema, queryUserTaskAuditLogsResponseBodySchema, userTaskAuditLogFilterSchema } from "./user-task.js";
3
- import { deleteProcessInstanceRequestBodySchema } from "./process-instance.js";
3
+ import { deleteProcessInstanceRequestBodySchema, modifyProcessInstanceRequestBodySchema } from "./process-instance.js";
4
4
  import { batchOperationCreatedResultSchema, createDeploymentResponseBodySchema, decisionDeploymentSchema, decisionRequirementsDeploymentSchema, deleteResourceRequestBodySchema, deleteResourceResponseBodySchema, formDeploymentSchema, getResourceContentResponseBodySchema, processDeploymentSchema, resourceDeploymentSchema, resourceSchema } from "./resource.js";
5
5
  import { getIncidentProcessInstanceStatisticsByDefinitionRequestBodySchema, getIncidentProcessInstanceStatisticsByDefinitionResponseBodySchema, getIncidentProcessInstanceStatisticsByErrorRequestBodySchema, getIncidentProcessInstanceStatisticsByErrorResponseBodySchema, incidentProcessInstanceStatisticsByDefinitionSchema, incidentProcessInstanceStatisticsByErrorSchema } from "./incident.js";
6
6
  import { endpoints } from "../8.9.js";
@@ -30,6 +30,7 @@ export {
30
30
  getResourceContentResponseBodySchema,
31
31
  incidentProcessInstanceStatisticsByDefinitionSchema,
32
32
  incidentProcessInstanceStatisticsByErrorSchema,
33
+ modifyProcessInstanceRequestBodySchema,
33
34
  processDeploymentSchema,
34
35
  queryAuditLogsRequestBodySchema,
35
36
  queryAuditLogsResponseBodySchema,
@@ -6,5 +6,45 @@ declare const deleteProcessInstanceRequestBodySchema: z.ZodOptional<z.ZodObject<
6
6
  }, z.core.$strip>>;
7
7
  type DeleteProcessInstanceRequestBody = z.infer<typeof deleteProcessInstanceRequestBodySchema>;
8
8
  declare const deleteProcessInstance: Endpoint<Pick<ProcessInstance, 'processInstanceKey'>>;
9
- export { deleteProcessInstanceRequestBodySchema, deleteProcessInstance };
10
- export type { DeleteProcessInstanceRequestBody };
9
+ declare const modifyProcessInstanceRequestBodySchema: z.ZodObject<{
10
+ operationReference: z.ZodOptional<z.ZodNumber>;
11
+ activateInstructions: z.ZodOptional<z.ZodArray<z.ZodObject<{
12
+ elementId: z.ZodString;
13
+ variableInstructions: z.ZodOptional<z.ZodArray<z.ZodObject<{
14
+ variables: z.ZodRecord<z.ZodString, z.ZodUnknown>;
15
+ scopeId: z.ZodOptional<z.ZodString>;
16
+ }, z.core.$strip>>>;
17
+ ancestorElementInstanceKey: z.ZodOptional<z.ZodString>;
18
+ }, z.core.$strip>>>;
19
+ moveInstructions: z.ZodOptional<z.ZodArray<z.ZodObject<{
20
+ sourceElementInstruction: z.ZodDiscriminatedUnion<[z.ZodObject<{
21
+ sourceType: z.ZodLiteral<"byId">;
22
+ sourceElementId: z.ZodString;
23
+ }, z.core.$strip>, z.ZodObject<{
24
+ sourceType: z.ZodLiteral<"byKey">;
25
+ sourceElementInstanceKey: z.ZodString;
26
+ }, z.core.$strip>], "sourceType">;
27
+ targetElementId: z.ZodString;
28
+ ancestorScopeInstruction: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
29
+ ancestorScopeType: z.ZodLiteral<"direct">;
30
+ ancestorElementInstanceKey: z.ZodString;
31
+ }, z.core.$strip>, z.ZodObject<{
32
+ ancestorScopeType: z.ZodLiteral<"inferred">;
33
+ }, z.core.$strip>, z.ZodObject<{
34
+ ancestorScopeType: z.ZodLiteral<"sourceParent">;
35
+ }, z.core.$strip>], "ancestorScopeType">>;
36
+ variableInstructions: z.ZodOptional<z.ZodArray<z.ZodObject<{
37
+ variables: z.ZodRecord<z.ZodString, z.ZodUnknown>;
38
+ scopeId: z.ZodOptional<z.ZodString>;
39
+ }, z.core.$strip>>>;
40
+ }, z.core.$strip>>>;
41
+ terminateInstructions: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
42
+ elementId: z.ZodString;
43
+ }, z.core.$strict>, z.ZodObject<{
44
+ elementInstanceKey: z.ZodString;
45
+ }, z.core.$strict>]>>>;
46
+ }, z.core.$strip>;
47
+ type ModifyProcessInstanceRequestBody = z.infer<typeof modifyProcessInstanceRequestBodySchema>;
48
+ declare const modifyProcessInstance: Endpoint<Pick<ProcessInstance, 'processInstanceKey'>>;
49
+ export { deleteProcessInstanceRequestBodySchema, deleteProcessInstance, modifyProcessInstanceRequestBodySchema, modifyProcessInstance, };
50
+ export type { DeleteProcessInstanceRequestBody, ModifyProcessInstanceRequestBody };
@@ -35,7 +35,50 @@ const deleteProcessInstance = {
35
35
  method: "POST",
36
36
  getUrl: ({ processInstanceKey }) => `/${API_VERSION}/process-instances/${processInstanceKey}/deletion`
37
37
  };
38
+ const variableInstructionSchema = z.object({
39
+ variables: z.record(z.string(), z.unknown()),
40
+ scopeId: z.string().optional()
41
+ });
42
+ const activateInstructionSchema = z.object({
43
+ elementId: z.string(),
44
+ variableInstructions: z.array(variableInstructionSchema).optional(),
45
+ ancestorElementInstanceKey: z.string().optional()
46
+ });
47
+ const moveInstructionSchema = z.object({
48
+ sourceElementInstruction: z.discriminatedUnion("sourceType", [
49
+ z.object({ sourceType: z.literal("byId"), sourceElementId: z.string() }),
50
+ z.object({ sourceType: z.literal("byKey"), sourceElementInstanceKey: z.string() })
51
+ ]),
52
+ targetElementId: z.string(),
53
+ ancestorScopeInstruction: z.discriminatedUnion("ancestorScopeType", [
54
+ z.object({ ancestorScopeType: z.literal("direct"), ancestorElementInstanceKey: z.string() }),
55
+ z.object({ ancestorScopeType: z.literal("inferred") }),
56
+ z.object({ ancestorScopeType: z.literal("sourceParent") })
57
+ ]).optional(),
58
+ variableInstructions: z.array(variableInstructionSchema).optional()
59
+ });
60
+ const terminateInstructionSchema = z.union([
61
+ z.object({ elementId: z.string() }).strict(),
62
+ z.object({ elementInstanceKey: z.string() }).strict()
63
+ ]);
64
+ const modifyProcessInstanceRequestBodySchema = z.object({
65
+ operationReference: z.number().optional(),
66
+ activateInstructions: z.array(activateInstructionSchema).optional(),
67
+ moveInstructions: z.array(moveInstructionSchema).optional(),
68
+ terminateInstructions: z.array(terminateInstructionSchema).optional()
69
+ }).refine(
70
+ ({ activateInstructions, moveInstructions, terminateInstructions }) => activateInstructions !== void 0 && activateInstructions.length > 0 || moveInstructions !== void 0 && moveInstructions.length > 0 || terminateInstructions !== void 0 && terminateInstructions.length > 0,
71
+ {
72
+ message: "At least one instruction (activateInstructions, moveInstructions, or terminateInstructions) must be provided with at least one element"
73
+ }
74
+ );
75
+ const modifyProcessInstance = {
76
+ method: "POST",
77
+ getUrl: ({ processInstanceKey }) => `/${API_VERSION}/process-instances/${processInstanceKey}/modification`
78
+ };
38
79
  export {
39
80
  deleteProcessInstance,
40
- deleteProcessInstanceRequestBodySchema
81
+ deleteProcessInstanceRequestBodySchema,
82
+ modifyProcessInstance,
83
+ modifyProcessInstanceRequestBodySchema
41
84
  };
@@ -83,7 +83,7 @@ declare const createDeploymentResponseBodySchema: z.ZodObject<{
83
83
  }, z.core.$strip>;
84
84
  type CreateDeploymentResponseBody = z.infer<typeof createDeploymentResponseBodySchema>;
85
85
  declare const deleteResourceRequestBodySchema: z.ZodOptional<z.ZodObject<{
86
- operationReference: z.ZodNumber;
86
+ operationReference: z.ZodOptional<z.ZodNumber>;
87
87
  deleteHistory: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
88
88
  }, z.core.$strip>>;
89
89
  type DeleteResourceRequestBody = z.infer<typeof deleteResourceRequestBodySchema>;
@@ -52,7 +52,7 @@ const createDeploymentResponseBodySchema = z.object({
52
52
  )
53
53
  });
54
54
  const deleteResourceRequestBodySchema = z.object({
55
- operationReference: z.number().int().min(1),
55
+ operationReference: z.number().int().min(1).optional(),
56
56
  deleteHistory: z.boolean().optional().default(false)
57
57
  }).optional();
58
58
  const batchOperationCreatedResultSchema = z.object({
package/dist/8.9.js CHANGED
@@ -2,8 +2,8 @@ import { getAuditLog, queryAuditLogs } from "./8.9/audit-log.js";
2
2
  import { auditLogActorTypeSchema, auditLogCategorySchema, auditLogEntityTypeSchema, auditLogFilterSchema, auditLogOperationTypeSchema, auditLogResultSchema, auditLogSchema, auditLogSortFieldEnum, getAuditLogResponseBodySchema, queryAuditLogsRequestBodySchema, queryAuditLogsResponseBodySchema } from "./8.9/audit-log.js";
3
3
  import { queryUserTaskAuditLogs } from "./8.9/user-task.js";
4
4
  import { queryUserTaskAuditLogsRequestBodySchema, queryUserTaskAuditLogsResponseBodySchema, userTaskAuditLogFilterSchema } from "./8.9/user-task.js";
5
- import { deleteProcessInstance } from "./8.9/process-instance.js";
6
- import { deleteProcessInstanceRequestBodySchema } from "./8.9/process-instance.js";
5
+ import { modifyProcessInstance, deleteProcessInstance } from "./8.9/process-instance.js";
6
+ import { deleteProcessInstanceRequestBodySchema, modifyProcessInstanceRequestBodySchema } from "./8.9/process-instance.js";
7
7
  import { getResourceContent, getResource, deleteResource, createDeployment } from "./8.9/resource.js";
8
8
  import { batchOperationCreatedResultSchema, createDeploymentResponseBodySchema, decisionDeploymentSchema, decisionRequirementsDeploymentSchema, deleteResourceRequestBodySchema, deleteResourceResponseBodySchema, formDeploymentSchema, getResourceContentResponseBodySchema, processDeploymentSchema, resourceDeploymentSchema, resourceSchema } from "./8.9/resource.js";
9
9
  import { getIncidentProcessInstanceStatisticsByDefinition, getIncidentProcessInstanceStatisticsByError } from "./8.9/incident.js";
@@ -13,6 +13,7 @@ const endpoints = {
13
13
  getAuditLog,
14
14
  queryUserTaskAuditLogs,
15
15
  deleteProcessInstance,
16
+ modifyProcessInstance,
16
17
  createDeployment,
17
18
  deleteResource,
18
19
  getResource,
@@ -46,6 +47,7 @@ export {
46
47
  getResourceContentResponseBodySchema,
47
48
  incidentProcessInstanceStatisticsByDefinitionSchema,
48
49
  incidentProcessInstanceStatisticsByErrorSchema,
50
+ modifyProcessInstanceRequestBodySchema,
49
51
  processDeploymentSchema,
50
52
  queryAuditLogsRequestBodySchema,
51
53
  queryAuditLogsResponseBodySchema,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@camunda/camunda-api-zod-schemas",
3
- "version": "0.0.34",
3
+ "version": "0.0.35",
4
4
  "license": "LicenseRef-Camunda-1.0",
5
5
  "description": "Zod schemas and TypeScript types for Camunda 8 unified API",
6
6
  "author": "Vinicius Goulart <vinicius.goulart@camunda.com>",
@@ -239,7 +239,7 @@
239
239
  "publishConfig": {
240
240
  "access": "public"
241
241
  },
242
- "packageManager": "npm@11.7.0",
242
+ "packageManager": "npm@11.8.0",
243
243
  "devDependencies": {
244
244
  "@types/node": "25.0.2",
245
245
  "changelogen": "0.6.2",