@rippling/rippling-sdk 0.2.0-alpha.103 → 0.2.0-alpha.104

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.
Files changed (180) hide show
  1. package/examples/manifest/workflow-creation/workflow-creation.ts +142 -0
  2. package/lib/manifest/index.d.mts +2 -1
  3. package/lib/manifest/index.d.mts.map +1 -1
  4. package/lib/manifest/index.d.ts +2 -1
  5. package/lib/manifest/index.d.ts.map +1 -1
  6. package/lib/manifest/index.js +5 -2
  7. package/lib/manifest/index.js.map +1 -1
  8. package/lib/manifest/index.mjs +2 -1
  9. package/lib/manifest/index.mjs.map +1 -1
  10. package/lib/manifest/workflow/actions/index.d.mts +365 -0
  11. package/lib/manifest/workflow/actions/index.d.mts.map +1 -0
  12. package/lib/manifest/workflow/actions/index.d.ts +365 -0
  13. package/lib/manifest/workflow/actions/index.d.ts.map +1 -0
  14. package/lib/manifest/workflow/actions/index.js +47 -0
  15. package/lib/manifest/workflow/actions/index.js.map +1 -0
  16. package/lib/manifest/workflow/actions/index.mjs +44 -0
  17. package/lib/manifest/workflow/actions/index.mjs.map +1 -0
  18. package/lib/manifest/workflow/index.d.mts +384 -0
  19. package/lib/manifest/workflow/index.d.mts.map +1 -0
  20. package/lib/manifest/workflow/index.d.ts +384 -0
  21. package/lib/manifest/workflow/index.d.ts.map +1 -0
  22. package/lib/manifest/workflow/index.js +447 -0
  23. package/lib/manifest/workflow/index.js.map +1 -0
  24. package/lib/manifest/workflow/index.mjs +442 -0
  25. package/lib/manifest/workflow/index.mjs.map +1 -0
  26. package/package.json +1 -1
  27. package/resources/departments.d.mts +3 -5
  28. package/resources/departments.d.mts.map +1 -1
  29. package/resources/departments.d.ts +3 -5
  30. package/resources/departments.d.ts.map +1 -1
  31. package/resources/departments.js +2 -4
  32. package/resources/departments.js.map +1 -1
  33. package/resources/departments.mjs +2 -4
  34. package/resources/departments.mjs.map +1 -1
  35. package/resources/hires.d.mts +4 -8
  36. package/resources/hires.d.mts.map +1 -1
  37. package/resources/hires.d.ts +4 -8
  38. package/resources/hires.d.ts.map +1 -1
  39. package/resources/hires.js +4 -4
  40. package/resources/hires.mjs +4 -4
  41. package/resources/job-assignments.d.mts +10 -13
  42. package/resources/job-assignments.d.mts.map +1 -1
  43. package/resources/job-assignments.d.ts +10 -13
  44. package/resources/job-assignments.d.ts.map +1 -1
  45. package/resources/job-assignments.js +2 -5
  46. package/resources/job-assignments.js.map +1 -1
  47. package/resources/job-assignments.mjs +2 -5
  48. package/resources/job-assignments.mjs.map +1 -1
  49. package/resources/job-codes.d.mts +10 -13
  50. package/resources/job-codes.d.mts.map +1 -1
  51. package/resources/job-codes.d.ts +10 -13
  52. package/resources/job-codes.d.ts.map +1 -1
  53. package/resources/job-codes.js +2 -5
  54. package/resources/job-codes.js.map +1 -1
  55. package/resources/job-codes.mjs +2 -5
  56. package/resources/job-codes.mjs.map +1 -1
  57. package/resources/job-dimensions.d.mts +6 -8
  58. package/resources/job-dimensions.d.mts.map +1 -1
  59. package/resources/job-dimensions.d.ts +6 -8
  60. package/resources/job-dimensions.d.ts.map +1 -1
  61. package/resources/job-dimensions.js +2 -4
  62. package/resources/job-dimensions.js.map +1 -1
  63. package/resources/job-dimensions.mjs +2 -4
  64. package/resources/job-dimensions.mjs.map +1 -1
  65. package/resources/kiosk-badges.d.mts +3 -5
  66. package/resources/kiosk-badges.d.mts.map +1 -1
  67. package/resources/kiosk-badges.d.ts +3 -5
  68. package/resources/kiosk-badges.d.ts.map +1 -1
  69. package/resources/kiosk-badges.js +2 -4
  70. package/resources/kiosk-badges.js.map +1 -1
  71. package/resources/kiosk-badges.mjs +2 -4
  72. package/resources/kiosk-badges.mjs.map +1 -1
  73. package/resources/leave-accruals.d.mts +4 -4
  74. package/resources/leave-accruals.d.mts.map +1 -1
  75. package/resources/leave-accruals.d.ts +4 -4
  76. package/resources/leave-accruals.d.ts.map +1 -1
  77. package/resources/leave-requests.d.mts +18 -23
  78. package/resources/leave-requests.d.mts.map +1 -1
  79. package/resources/leave-requests.d.ts +18 -23
  80. package/resources/leave-requests.d.ts.map +1 -1
  81. package/resources/leave-requests.js +2 -7
  82. package/resources/leave-requests.js.map +1 -1
  83. package/resources/leave-requests.mjs +2 -7
  84. package/resources/leave-requests.mjs.map +1 -1
  85. package/resources/packages/packages.d.mts +17 -17
  86. package/resources/packages/packages.d.mts.map +1 -1
  87. package/resources/packages/packages.d.ts +17 -17
  88. package/resources/packages/packages.d.ts.map +1 -1
  89. package/resources/packages/packages.js +5 -5
  90. package/resources/packages/packages.mjs +5 -5
  91. package/resources/sandboxes.d.mts +7 -5
  92. package/resources/sandboxes.d.mts.map +1 -1
  93. package/resources/sandboxes.d.ts +7 -5
  94. package/resources/sandboxes.d.ts.map +1 -1
  95. package/resources/sandboxes.js +3 -1
  96. package/resources/sandboxes.js.map +1 -1
  97. package/resources/sandboxes.mjs +3 -1
  98. package/resources/sandboxes.mjs.map +1 -1
  99. package/resources/shift-assignments.d.mts +11 -6
  100. package/resources/shift-assignments.d.mts.map +1 -1
  101. package/resources/shift-assignments.d.ts +11 -6
  102. package/resources/shift-assignments.d.ts.map +1 -1
  103. package/resources/shift-assignments.js +8 -4
  104. package/resources/shift-assignments.js.map +1 -1
  105. package/resources/shift-assignments.mjs +8 -4
  106. package/resources/shift-assignments.mjs.map +1 -1
  107. package/resources/shift-inputs.d.mts +10 -15
  108. package/resources/shift-inputs.d.mts.map +1 -1
  109. package/resources/shift-inputs.d.ts +10 -15
  110. package/resources/shift-inputs.d.ts.map +1 -1
  111. package/resources/shift-inputs.js +2 -7
  112. package/resources/shift-inputs.js.map +1 -1
  113. package/resources/shift-inputs.mjs +2 -7
  114. package/resources/shift-inputs.mjs.map +1 -1
  115. package/resources/sites.d.mts +19 -6
  116. package/resources/sites.d.mts.map +1 -1
  117. package/resources/sites.d.ts +19 -6
  118. package/resources/sites.d.ts.map +1 -1
  119. package/resources/software-deployments.d.mts +6 -8
  120. package/resources/software-deployments.d.mts.map +1 -1
  121. package/resources/software-deployments.d.ts +6 -8
  122. package/resources/software-deployments.d.ts.map +1 -1
  123. package/resources/software-deployments.js +2 -4
  124. package/resources/software-deployments.js.map +1 -1
  125. package/resources/software-deployments.mjs +2 -4
  126. package/resources/software-deployments.mjs.map +1 -1
  127. package/resources/unassigned-shifts.d.mts +11 -6
  128. package/resources/unassigned-shifts.d.mts.map +1 -1
  129. package/resources/unassigned-shifts.d.ts +11 -6
  130. package/resources/unassigned-shifts.d.ts.map +1 -1
  131. package/resources/unassigned-shifts.js +8 -4
  132. package/resources/unassigned-shifts.js.map +1 -1
  133. package/resources/unassigned-shifts.mjs +8 -4
  134. package/resources/unassigned-shifts.mjs.map +1 -1
  135. package/resources/variable-compensation-payouts.d.mts +4 -4
  136. package/resources/variable-compensation-payouts.d.mts.map +1 -1
  137. package/resources/variable-compensation-payouts.d.ts +4 -4
  138. package/resources/variable-compensation-payouts.d.ts.map +1 -1
  139. package/resources/work-locations.d.mts +4 -7
  140. package/resources/work-locations.d.mts.map +1 -1
  141. package/resources/work-locations.d.ts +4 -7
  142. package/resources/work-locations.d.ts.map +1 -1
  143. package/resources/work-locations.js +2 -5
  144. package/resources/work-locations.js.map +1 -1
  145. package/resources/work-locations.mjs +2 -5
  146. package/resources/work-locations.mjs.map +1 -1
  147. package/src/lib/manifest/index.ts +40 -0
  148. package/src/lib/manifest/workflow/actions/index.ts +338 -0
  149. package/src/lib/manifest/workflow/index.ts +953 -0
  150. package/src/resources/departments.ts +7 -5
  151. package/src/resources/hires.ts +4 -9
  152. package/src/resources/job-assignments.ts +16 -15
  153. package/src/resources/job-codes.ts +16 -15
  154. package/src/resources/job-dimensions.ts +11 -9
  155. package/src/resources/kiosk-badges.ts +3 -5
  156. package/src/resources/leave-accruals.ts +8 -4
  157. package/src/resources/leave-requests.ts +21 -26
  158. package/src/resources/packages/packages.ts +17 -17
  159. package/src/resources/sandboxes.ts +7 -5
  160. package/src/resources/shift-assignments.ts +11 -8
  161. package/src/resources/shift-inputs.ts +11 -16
  162. package/src/resources/sites.ts +19 -6
  163. package/src/resources/software-deployments.ts +7 -9
  164. package/src/resources/unassigned-shifts.ts +11 -8
  165. package/src/resources/variable-compensation-payouts.ts +0 -4
  166. package/src/resources/work-locations.ts +8 -7
  167. package/src/version.ts +1 -1
  168. package/version.d.mts +1 -1
  169. package/version.d.ts +1 -1
  170. package/version.js +1 -1
  171. package/version.mjs +1 -1
  172. package/lib/manifest/workflow.d.mts +0 -158
  173. package/lib/manifest/workflow.d.mts.map +0 -1
  174. package/lib/manifest/workflow.d.ts +0 -158
  175. package/lib/manifest/workflow.d.ts.map +0 -1
  176. package/lib/manifest/workflow.js +0 -51
  177. package/lib/manifest/workflow.js.map +0 -1
  178. package/lib/manifest/workflow.mjs +0 -47
  179. package/lib/manifest/workflow.mjs.map +0 -1
  180. package/src/lib/manifest/workflow.ts +0 -248
@@ -684,7 +684,10 @@ export namespace SiteUploadBatchesPresignResponse {
684
684
  client_ref?: string;
685
685
 
686
686
  /**
687
- * Staged upload identifier for use in create, update, or file operations.
687
+ * Staged upload identifier for use in create, update, or file operations after
688
+ * uploading bytes to S3. The id can be reused for 1 hour from presign, each attach
689
+ * copies the bytes into that site's bundle, a repeat attach before expiry creates
690
+ * another bundle, and the staged object is removed after expiry.
688
691
  */
689
692
  file_id?: string;
690
693
 
@@ -694,8 +697,9 @@ export namespace SiteUploadBatchesPresignResponse {
694
697
  file_name?: string;
695
698
 
696
699
  /**
697
- * Upload status. Presigned uploads return awaiting_upload until the file is
698
- * uploaded to S3 and consumed.
700
+ * Upload status. Returns awaiting_upload after presign until the file is uploaded
701
+ * to S3. After the object exists in S3, status becomes active on first use. Attach
702
+ * does not consume the staged upload; it is removed after expiry.
699
703
  */
700
704
  status?: string;
701
705
 
@@ -866,7 +870,10 @@ export interface SiteCreateParams {
866
870
 
867
871
  /**
868
872
  * Staged upload id from POST /sites/upload-batches/presign/ after uploading bytes
869
- * to S3. Required to create a site or replace the bundle.
873
+ * to S3. Required to create a site or replace the bundle. The id can be reused for
874
+ * 1 hour from presign, each attach copies the bytes into that site's bundle, a
875
+ * repeat attach before expiry creates another bundle, and the staged object is
876
+ * removed after expiry.
870
877
  */
871
878
  file_id: string;
872
879
 
@@ -911,7 +918,10 @@ export interface SiteUpdateParams {
911
918
 
912
919
  /**
913
920
  * Staged upload id from POST /sites/upload-batches/presign/ after uploading bytes
914
- * to S3. Required to create a site or replace the bundle.
921
+ * to S3. Required to create a site or replace the bundle. The id can be reused for
922
+ * 1 hour from presign, each attach copies the bytes into that site's bundle, a
923
+ * repeat attach before expiry creates another bundle, and the staged object is
924
+ * removed after expiry.
915
925
  */
916
926
  file_id?: string;
917
927
 
@@ -993,7 +1003,10 @@ export namespace SiteFileOperationsParams {
993
1003
 
994
1004
  /**
995
1005
  * Staged upload id from POST /sites/upload-batches/presign/ after uploading bytes
996
- * to S3. Required for put operations on files.
1006
+ * to S3. Required for put operations on files. The id can be reused for 1 hour
1007
+ * from presign, each attach copies the bytes into that site's bundle, a repeat
1008
+ * attach before expiry creates another bundle, and the staged object is removed
1009
+ * after expiry.
997
1010
  */
998
1011
  file_id?: string;
999
1012
 
@@ -173,9 +173,7 @@ export class SoftwareDeployments extends APIResource {
173
173
  * Accept: application/json
174
174
  * Rippling-Api-Version: 2024-08-01
175
175
  *
176
- * {
177
- * "software_id": "software_id"
178
- * }
176
+ * {}
179
177
  *
180
178
  * HTTP/1.1 200 OK
181
179
  * Content-Type: application/json
@@ -208,7 +206,7 @@ export class SoftwareDeployments extends APIResource {
208
206
  */
209
207
  update(
210
208
  id: string,
211
- body: SoftwareDeploymentUpdateParams,
209
+ body: SoftwareDeploymentUpdateParams | null | undefined = {},
212
210
  options?: RequestOptions,
213
211
  ): APIPromise<SoftwareDeploymentUpdateResponse> {
214
212
  return this._client.patch(path`/software-deployments/${id}/`, { body, ...options });
@@ -736,11 +734,6 @@ export interface SoftwareDeploymentRetrieveParams {
736
734
  }
737
735
 
738
736
  export interface SoftwareDeploymentUpdateParams {
739
- /**
740
- * The ID of the software to deploy.
741
- */
742
- software_id: string;
743
-
744
737
  /**
745
738
  * Type of group targeting: 'Role' or 'Device'.
746
739
  */
@@ -757,6 +750,11 @@ export interface SoftwareDeploymentUpdateParams {
757
750
  * 'Device'. Must be null if 'Role'.
758
751
  */
759
752
  ma_device_group_id?: string;
753
+
754
+ /**
755
+ * The ID of the software to deploy.
756
+ */
757
+ software_id?: string;
760
758
  }
761
759
 
762
760
  export declare namespace SoftwareDeployments {
@@ -20,7 +20,9 @@ export class UnassignedShifts extends APIResource {
20
20
  * @example SDK usage
21
21
  * ```ts
22
22
  * const response =
23
- * await client.unassignedShifts.updateCustomfields('id');
23
+ * await client.unassignedShifts.updateCustomfields('id', {
24
+ * body: { FieldName1: 'bar', FieldName2: 'bar' },
25
+ * });
24
26
  * ```
25
27
  *
26
28
  * @example HTTP
@@ -33,7 +35,8 @@ export class UnassignedShifts extends APIResource {
33
35
  * Rippling-Api-Version: 2024-08-01
34
36
  *
35
37
  * {
36
- * "FieldName1": "value1"
38
+ * "FieldName1": "value1",
39
+ * "FieldName2": "value2"
37
40
  * }
38
41
  *
39
42
  * HTTP/1.1 200 OK
@@ -50,10 +53,11 @@ export class UnassignedShifts extends APIResource {
50
53
  */
51
54
  updateCustomfields(
52
55
  id: string,
53
- body: UnassignedShiftUpdateCustomfieldsParams,
56
+ params: UnassignedShiftUpdateCustomfieldsParams,
54
57
  options?: RequestOptions,
55
58
  ): APIPromise<UnassignedShiftUpdateCustomfieldsResponse> {
56
- return this._client.patch(path`/unassignedshifts/${id}/customfields/`, { body, ...options });
59
+ const { body } = params;
60
+ return this._client.patch(path`/unassignedshifts/${id}/customfields/`, { body: body, ...options });
57
61
  }
58
62
 
59
63
  /**
@@ -445,11 +449,10 @@ export interface UnassignedShiftAssignResponse {
445
449
 
446
450
  export interface UnassignedShiftUpdateCustomfieldsParams {
447
451
  /**
448
- * Example custom field name. Replace with your actual custom field names.
452
+ * Dictionary mapping custom field names to their values. Field names are dynamic
453
+ * and depend on your company's custom field configuration.
449
454
  */
450
- FieldName1?: string;
451
-
452
- [k: string]: unknown;
455
+ body: { [key: string]: unknown };
453
456
  }
454
457
 
455
458
  export interface UnassignedShiftAssignParams {
@@ -261,7 +261,6 @@ export interface VariableCompensationPayoutListResponse {
261
261
  */
262
262
  status:
263
263
  | 'DRAFT'
264
- | 'STAGING'
265
264
  | 'PENDING_APPROVAL'
266
265
  | 'APPROVAL_REJECTED'
267
266
  | 'SCHEDULED'
@@ -415,7 +414,6 @@ export interface VariableCompensationPayoutCreateResponse {
415
414
  */
416
415
  status:
417
416
  | 'DRAFT'
418
- | 'STAGING'
419
417
  | 'PENDING_APPROVAL'
420
418
  | 'APPROVAL_REJECTED'
421
419
  | 'SCHEDULED'
@@ -572,7 +570,6 @@ export interface VariableCompensationPayoutRetrieveResponse extends BusinessPart
572
570
  */
573
571
  status:
574
572
  | 'DRAFT'
575
- | 'STAGING'
576
573
  | 'PENDING_APPROVAL'
577
574
  | 'APPROVAL_REJECTED'
578
575
  | 'SCHEDULED'
@@ -704,7 +701,6 @@ export interface VariableCompensationPayoutListParams {
704
701
  */
705
702
  status?:
706
703
  | 'DRAFT'
707
- | 'STAGING'
708
704
  | 'PENDING_APPROVAL'
709
705
  | 'APPROVAL_REJECTED'
710
706
  | 'SCHEDULED'
@@ -147,10 +147,7 @@ export class WorkLocations extends APIResource {
147
147
  * Accept: application/json
148
148
  * Rippling-Api-Version: 2024-08-01
149
149
  *
150
- * {
151
- * "address": {},
152
- * "name": "name"
153
- * }
150
+ * {}
154
151
  *
155
152
  * HTTP/1.1 200 OK
156
153
  * Content-Type: application/json
@@ -172,7 +169,11 @@ export class WorkLocations extends APIResource {
172
169
  * }
173
170
  * ```
174
171
  */
175
- update(id: string, body: WorkLocationUpdateParams, options?: RequestOptions): APIPromise<WorkLocation> {
172
+ update(
173
+ id: string,
174
+ body: WorkLocationUpdateParams | null | undefined = {},
175
+ options?: RequestOptions,
176
+ ): APIPromise<WorkLocation> {
176
177
  return this._client.patch(path`/work-locations/${id}/`, { body, ...options });
177
178
  }
178
179
 
@@ -297,12 +298,12 @@ export interface WorkLocationUpdateParams {
297
298
  /**
298
299
  * The address for the work location.
299
300
  */
300
- address: WorkLocationUpdateParams.Address;
301
+ address?: WorkLocationUpdateParams.Address;
301
302
 
302
303
  /**
303
304
  * The name of the work location.
304
305
  */
305
- name: string;
306
+ name?: string;
306
307
  }
307
308
 
308
309
  export namespace WorkLocationUpdateParams {
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '0.2.0-alpha.103'; // x-release-please-version
1
+ export const VERSION = '0.2.0-alpha.104'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.2.0-alpha.103";
1
+ export declare const VERSION = "0.2.0-alpha.104";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.2.0-alpha.103";
1
+ export declare const VERSION = "0.2.0-alpha.104";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '0.2.0-alpha.103'; // x-release-please-version
4
+ exports.VERSION = '0.2.0-alpha.104'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '0.2.0-alpha.103'; // x-release-please-version
1
+ export const VERSION = '0.2.0-alpha.104'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map
@@ -1,158 +0,0 @@
1
- import type { BusinessEventKey } from "./business-event.mjs";
2
- import type { ManifestFunction } from "./manifest-function.mjs";
3
- import type { ManifestComponentDeletion, ManifestScope } from "./manifest-builder.mjs";
4
- export type WorkflowAutomationEventType = 'AUTOMATION_EVENT_TYPE_BUSINESS' | 'AUTOMATION_EVENT_TYPE_RECORD_CHANGE' | 'AUTOMATION_EVENT_TYPE_SCHEDULED' | 'AUTOMATION_EVENT_TYPE_MANUAL' | 'AUTOMATION_EVENT_TYPE_DATE_RELATIVE';
5
- export type WorkflowRecordChangeOperationType = 'RECORD_CHANGE_OPERATION_TYPE_CREATE' | 'RECORD_CHANGE_OPERATION_TYPE_UPDATE' | 'RECORD_CHANGE_OPERATION_TYPE_DELETE' | 'RECORD_CHANGE_OPERATION_TYPE_CREATE_OR_UPDATE';
6
- export type WorkflowDateRelativeOperatorType = 'DATE_RELATIVE_TRIGGER_OPERATOR_TYPE_EQ' | 'DATE_RELATIVE_TRIGGER_OPERATOR_TYPE_WITHIN' | 'DATE_RELATIVE_TRIGGER_OPERATOR_TYPE_BETWEEN';
7
- export type WorkflowScheduledFrequencyType = 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_DAILY' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_WEEKDAY_DAILY' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_WEEKLY' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_BIWEEKLY' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_MONTHLY' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_MONTHLY_ON_DAY_OF_WEEK' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_ONE_TIME' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_QUARTERLY' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_ANNUALLY' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_CUSTOM' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_CRON';
8
- export type WorkflowCustomScheduleFrequencyUnit = 'CUSTOM_SCHEDULE_TRIGGER_FREQUENCY_UNIT_DAYS' | 'CUSTOM_SCHEDULE_TRIGGER_FREQUENCY_UNIT_WEEKS' | 'CUSTOM_SCHEDULE_TRIGGER_FREQUENCY_UNIT_MONTHS' | 'CUSTOM_SCHEDULE_TRIGGER_FREQUENCY_UNIT_YEARS' | 'CUSTOM_SCHEDULE_TRIGGER_FREQUENCY_UNIT_HOURS' | 'CUSTOM_SCHEDULE_TRIGGER_FREQUENCY_UNIT_MINUTES';
9
- export interface WorkflowTimeOfDaySchedule {
10
- hour_of_day: number;
11
- minute_of_hour?: number;
12
- }
13
- export interface WorkflowOneTimeSchedule extends WorkflowTimeOfDaySchedule {
14
- year: number;
15
- month_of_year: number;
16
- day_of_month: number;
17
- }
18
- export interface WorkflowWeeklySchedule extends WorkflowTimeOfDaySchedule {
19
- day_of_week: number[];
20
- }
21
- export interface WorkflowMonthlySchedule extends WorkflowTimeOfDaySchedule {
22
- day_of_month: number;
23
- start_month?: number;
24
- }
25
- export interface WorkflowMonthlyOnDayOfWeekSchedule extends WorkflowTimeOfDaySchedule {
26
- day_of_week: number;
27
- day_of_month: number;
28
- }
29
- export interface WorkflowQuarterlySchedule extends WorkflowTimeOfDaySchedule {
30
- day_of_month: number;
31
- month_of_year: number;
32
- }
33
- export interface WorkflowAnnualSchedule extends WorkflowTimeOfDaySchedule {
34
- day_of_month: number;
35
- month_of_year: number;
36
- start_month?: number;
37
- }
38
- export interface WorkflowCronSchedule {
39
- cron_expression: string;
40
- }
41
- export interface WorkflowCustomSchedule extends WorkflowTimeOfDaySchedule {
42
- custom_schedule_frequency: WorkflowCustomScheduleFrequencyUnit;
43
- custom_schedule_frequency_value: number;
44
- daily_schedule?: WorkflowTimeOfDaySchedule;
45
- weekly_schedule?: WorkflowWeeklySchedule;
46
- monthly_schedule?: WorkflowMonthlySchedule;
47
- annual_schedule?: WorkflowAnnualSchedule;
48
- }
49
- export interface WorkflowTriggerBase {
50
- automation_event_type: WorkflowAutomationEventType;
51
- og_module?: string;
52
- base_model?: string;
53
- rql_formula?: string;
54
- is_basic_workflow?: boolean;
55
- og_category?: string;
56
- condition_builder_mode?: string;
57
- conditions_tree?: string;
58
- }
59
- export interface WorkflowBusinessTrigger extends WorkflowTriggerBase {
60
- automation_event_type: 'AUTOMATION_EVENT_TYPE_BUSINESS';
61
- /** Business event to subscribe to. Availability is validated during installation. */
62
- event_name: BusinessEventKey;
63
- business_event_trigger?: {
64
- navigation_path?: string;
65
- };
66
- }
67
- export type WorkflowBusinessEventKey = BusinessEventKey;
68
- export interface WorkflowRecordChangeTrigger extends WorkflowTriggerBase {
69
- automation_event_type: 'AUTOMATION_EVENT_TYPE_RECORD_CHANGE';
70
- record_change_operation_type: WorkflowRecordChangeOperationType;
71
- }
72
- export interface WorkflowDateRelativeTrigger extends WorkflowTriggerBase {
73
- automation_event_type: 'AUTOMATION_EVENT_TYPE_DATE_RELATIVE';
74
- date_relative_trigger: {
75
- hour_of_day: number;
76
- minute_of_hour?: number;
77
- timezone?: string;
78
- base_model_date_field_rql_path?: string;
79
- trigger_on_anniversary?: boolean;
80
- date_range_operator?: WorkflowDateRelativeOperatorType;
81
- should_trigger_exactly_once_per_trigger_object?: boolean;
82
- operands?: Array<{
83
- time_delta?: {
84
- days: number;
85
- };
86
- }>;
87
- };
88
- }
89
- export interface WorkflowScheduledTrigger extends WorkflowTriggerBase {
90
- automation_event_type: 'AUTOMATION_EVENT_TYPE_SCHEDULED';
91
- scheduled_trigger: {
92
- frequency: WorkflowScheduledFrequencyType;
93
- timezone: string;
94
- daily_schedule?: WorkflowTimeOfDaySchedule;
95
- weekday_schedule?: WorkflowTimeOfDaySchedule;
96
- one_time_schedule?: WorkflowOneTimeSchedule;
97
- weekly_schedule?: WorkflowWeeklySchedule;
98
- bi_weekly_schedule?: WorkflowWeeklySchedule;
99
- monthly_schedule?: WorkflowMonthlySchedule;
100
- monthly_on_day_of_week_schedule?: WorkflowMonthlyOnDayOfWeekSchedule;
101
- quarterly_schedule?: WorkflowQuarterlySchedule;
102
- annual_schedule?: WorkflowAnnualSchedule;
103
- cron_schedule?: WorkflowCronSchedule;
104
- custom_schedule?: WorkflowCustomSchedule;
105
- };
106
- }
107
- export interface WorkflowManualTrigger extends WorkflowTriggerBase {
108
- automation_event_type: 'AUTOMATION_EVENT_TYPE_MANUAL';
109
- }
110
- export type WorkflowTrigger = WorkflowBusinessTrigger | WorkflowRecordChangeTrigger | WorkflowDateRelativeTrigger | WorkflowScheduledTrigger | WorkflowManualTrigger;
111
- export interface WorkflowDeletionIdentifier {
112
- definitionId: string;
113
- }
114
- export interface WorkflowProps {
115
- /**
116
- * Stable workflow definition id. Auto-generated when omitted.
117
- */
118
- definitionId?: string;
119
- /**
120
- * Workflow title shown to admins.
121
- */
122
- title: string;
123
- /**
124
- * Short workflow description shown to admins.
125
- */
126
- description: string;
127
- /**
128
- * The function this workflow runs. Pass a live {@link ManifestFunction} reference,
129
- * or a raw api_name string for functions defined outside this manifest.
130
- *
131
- * Required.
132
- */
133
- function: ManifestFunction | string;
134
- /**
135
- * Trigger definition in the workflows v2 proto JSON shape.
136
- */
137
- trigger: WorkflowTrigger;
138
- }
139
- /**
140
- * Defines a simple Workflow Studio workflow and registers it with the manifest.
141
- *
142
- * This intentionally models only the authoring inputs we need today: workflow
143
- * metadata, trigger JSON, and the function reference. The installer/backend can
144
- * derive the graph from these fields later.
145
- */
146
- export declare class Workflow {
147
- static readonly componentType: "WORKFLOW_DEFINITION";
148
- static toDeletionIdentifier(identifier: WorkflowDeletionIdentifier | string): ManifestComponentDeletion;
149
- private readonly _definitionId;
150
- private readonly _title;
151
- private readonly _description;
152
- private readonly _functionApiName;
153
- private readonly _trigger;
154
- constructor(scope: ManifestScope, props: WorkflowProps);
155
- getDefinitionId(): string;
156
- toDict(): Record<string, any>;
157
- }
158
- //# sourceMappingURL=workflow.d.mts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"workflow.d.mts","sourceRoot":"","sources":["../../src/lib/manifest/workflow.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,6BAAyB;AACzD,OAAO,KAAK,EAAE,gBAAgB,EAAE,gCAA4B;AAC5D,OAAO,KAAK,EAAE,yBAAyB,EAAE,aAAa,EAAE,+BAA2B;AAEnF,MAAM,MAAM,2BAA2B,GACnC,gCAAgC,GAChC,qCAAqC,GACrC,iCAAiC,GACjC,8BAA8B,GAC9B,qCAAqC,CAAC;AAE1C,MAAM,MAAM,iCAAiC,GACzC,qCAAqC,GACrC,qCAAqC,GACrC,qCAAqC,GACrC,+CAA+C,CAAC;AAEpD,MAAM,MAAM,gCAAgC,GACxC,wCAAwC,GACxC,4CAA4C,GAC5C,6CAA6C,CAAC;AAElD,MAAM,MAAM,8BAA8B,GACtC,wCAAwC,GACxC,gDAAgD,GAChD,yCAAyC,GACzC,2CAA2C,GAC3C,0CAA0C,GAC1C,yDAAyD,GACzD,2CAA2C,GAC3C,4CAA4C,GAC5C,2CAA2C,GAC3C,yCAAyC,GACzC,uCAAuC,CAAC;AAE5C,MAAM,MAAM,mCAAmC,GAC3C,6CAA6C,GAC7C,8CAA8C,GAC9C,+CAA+C,GAC/C,8CAA8C,GAC9C,8CAA8C,GAC9C,gDAAgD,CAAC;AAErD,MAAM,WAAW,yBAAyB;IACxC,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,uBAAwB,SAAQ,yBAAyB;IACxE,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,sBAAuB,SAAQ,yBAAyB;IACvE,WAAW,EAAE,MAAM,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,uBAAwB,SAAQ,yBAAyB;IACxE,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,kCAAmC,SAAQ,yBAAyB;IACnF,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,yBAA0B,SAAQ,yBAAyB;IAC1E,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,sBAAuB,SAAQ,yBAAyB;IACvE,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,oBAAoB;IACnC,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,sBAAuB,SAAQ,yBAAyB;IACvE,yBAAyB,EAAE,mCAAmC,CAAC;IAC/D,+BAA+B,EAAE,MAAM,CAAC;IACxC,cAAc,CAAC,EAAE,yBAAyB,CAAC;IAC3C,eAAe,CAAC,EAAE,sBAAsB,CAAC;IACzC,gBAAgB,CAAC,EAAE,uBAAuB,CAAC;IAC3C,eAAe,CAAC,EAAE,sBAAsB,CAAC;CAC1C;AAED,MAAM,WAAW,mBAAmB;IAClC,qBAAqB,EAAE,2BAA2B,CAAC;IACnD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,uBAAwB,SAAQ,mBAAmB;IAClE,qBAAqB,EAAE,gCAAgC,CAAC;IACxD,qFAAqF;IACrF,UAAU,EAAE,gBAAgB,CAAC;IAC7B,sBAAsB,CAAC,EAAE;QACvB,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B,CAAC;CACH;AAED,MAAM,MAAM,wBAAwB,GAAG,gBAAgB,CAAC;AAExD,MAAM,WAAW,2BAA4B,SAAQ,mBAAmB;IACtE,qBAAqB,EAAE,qCAAqC,CAAC;IAC7D,4BAA4B,EAAE,iCAAiC,CAAC;CACjE;AAED,MAAM,WAAW,2BAA4B,SAAQ,mBAAmB;IACtE,qBAAqB,EAAE,qCAAqC,CAAC;IAC7D,qBAAqB,EAAE;QACrB,WAAW,EAAE,MAAM,CAAC;QACpB,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,8BAA8B,CAAC,EAAE,MAAM,CAAC;QACxC,sBAAsB,CAAC,EAAE,OAAO,CAAC;QACjC,mBAAmB,CAAC,EAAE,gCAAgC,CAAC;QACvD,8CAA8C,CAAC,EAAE,OAAO,CAAC;QACzD,QAAQ,CAAC,EAAE,KAAK,CAAC;YAAE,UAAU,CAAC,EAAE;gBAAE,IAAI,EAAE,MAAM,CAAA;aAAE,CAAA;SAAE,CAAC,CAAC;KACrD,CAAC;CACH;AAED,MAAM,WAAW,wBAAyB,SAAQ,mBAAmB;IACnE,qBAAqB,EAAE,iCAAiC,CAAC;IACzD,iBAAiB,EAAE;QACjB,SAAS,EAAE,8BAA8B,CAAC;QAC1C,QAAQ,EAAE,MAAM,CAAC;QACjB,cAAc,CAAC,EAAE,yBAAyB,CAAC;QAC3C,gBAAgB,CAAC,EAAE,yBAAyB,CAAC;QAC7C,iBAAiB,CAAC,EAAE,uBAAuB,CAAC;QAC5C,eAAe,CAAC,EAAE,sBAAsB,CAAC;QACzC,kBAAkB,CAAC,EAAE,sBAAsB,CAAC;QAC5C,gBAAgB,CAAC,EAAE,uBAAuB,CAAC;QAC3C,+BAA+B,CAAC,EAAE,kCAAkC,CAAC;QACrE,kBAAkB,CAAC,EAAE,yBAAyB,CAAC;QAC/C,eAAe,CAAC,EAAE,sBAAsB,CAAC;QACzC,aAAa,CAAC,EAAE,oBAAoB,CAAC;QACrC,eAAe,CAAC,EAAE,sBAAsB,CAAC;KAC1C,CAAC;CACH;AAED,MAAM,WAAW,qBAAsB,SAAQ,mBAAmB;IAChE,qBAAqB,EAAE,8BAA8B,CAAC;CACvD;AAED,MAAM,MAAM,eAAe,GACvB,uBAAuB,GACvB,2BAA2B,GAC3B,2BAA2B,GAC3B,wBAAwB,GACxB,qBAAqB,CAAC;AAE1B,MAAM,WAAW,0BAA0B;IACzC,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;;OAKG;IACH,QAAQ,EAAE,gBAAgB,GAAG,MAAM,CAAC;IACpC;;OAEG;IACH,OAAO,EAAE,eAAe,CAAC;CAC1B;AAED;;;;;;GAMG;AACH,qBAAa,QAAQ;IACnB,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAG,qBAAqB,CAAU;IAE/D,MAAM,CAAC,oBAAoB,CAAC,UAAU,EAAE,0BAA0B,GAAG,MAAM,GAAG,yBAAyB;IAQvG,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IACvC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IACtC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAS;IAC1C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAkB;gBAE/B,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,aAAa;IAUtD,eAAe,IAAI,MAAM;IAIzB,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAe9B"}
@@ -1,158 +0,0 @@
1
- import type { BusinessEventKey } from "./business-event.js";
2
- import type { ManifestFunction } from "./manifest-function.js";
3
- import type { ManifestComponentDeletion, ManifestScope } from "./manifest-builder.js";
4
- export type WorkflowAutomationEventType = 'AUTOMATION_EVENT_TYPE_BUSINESS' | 'AUTOMATION_EVENT_TYPE_RECORD_CHANGE' | 'AUTOMATION_EVENT_TYPE_SCHEDULED' | 'AUTOMATION_EVENT_TYPE_MANUAL' | 'AUTOMATION_EVENT_TYPE_DATE_RELATIVE';
5
- export type WorkflowRecordChangeOperationType = 'RECORD_CHANGE_OPERATION_TYPE_CREATE' | 'RECORD_CHANGE_OPERATION_TYPE_UPDATE' | 'RECORD_CHANGE_OPERATION_TYPE_DELETE' | 'RECORD_CHANGE_OPERATION_TYPE_CREATE_OR_UPDATE';
6
- export type WorkflowDateRelativeOperatorType = 'DATE_RELATIVE_TRIGGER_OPERATOR_TYPE_EQ' | 'DATE_RELATIVE_TRIGGER_OPERATOR_TYPE_WITHIN' | 'DATE_RELATIVE_TRIGGER_OPERATOR_TYPE_BETWEEN';
7
- export type WorkflowScheduledFrequencyType = 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_DAILY' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_WEEKDAY_DAILY' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_WEEKLY' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_BIWEEKLY' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_MONTHLY' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_MONTHLY_ON_DAY_OF_WEEK' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_ONE_TIME' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_QUARTERLY' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_ANNUALLY' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_CUSTOM' | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_CRON';
8
- export type WorkflowCustomScheduleFrequencyUnit = 'CUSTOM_SCHEDULE_TRIGGER_FREQUENCY_UNIT_DAYS' | 'CUSTOM_SCHEDULE_TRIGGER_FREQUENCY_UNIT_WEEKS' | 'CUSTOM_SCHEDULE_TRIGGER_FREQUENCY_UNIT_MONTHS' | 'CUSTOM_SCHEDULE_TRIGGER_FREQUENCY_UNIT_YEARS' | 'CUSTOM_SCHEDULE_TRIGGER_FREQUENCY_UNIT_HOURS' | 'CUSTOM_SCHEDULE_TRIGGER_FREQUENCY_UNIT_MINUTES';
9
- export interface WorkflowTimeOfDaySchedule {
10
- hour_of_day: number;
11
- minute_of_hour?: number;
12
- }
13
- export interface WorkflowOneTimeSchedule extends WorkflowTimeOfDaySchedule {
14
- year: number;
15
- month_of_year: number;
16
- day_of_month: number;
17
- }
18
- export interface WorkflowWeeklySchedule extends WorkflowTimeOfDaySchedule {
19
- day_of_week: number[];
20
- }
21
- export interface WorkflowMonthlySchedule extends WorkflowTimeOfDaySchedule {
22
- day_of_month: number;
23
- start_month?: number;
24
- }
25
- export interface WorkflowMonthlyOnDayOfWeekSchedule extends WorkflowTimeOfDaySchedule {
26
- day_of_week: number;
27
- day_of_month: number;
28
- }
29
- export interface WorkflowQuarterlySchedule extends WorkflowTimeOfDaySchedule {
30
- day_of_month: number;
31
- month_of_year: number;
32
- }
33
- export interface WorkflowAnnualSchedule extends WorkflowTimeOfDaySchedule {
34
- day_of_month: number;
35
- month_of_year: number;
36
- start_month?: number;
37
- }
38
- export interface WorkflowCronSchedule {
39
- cron_expression: string;
40
- }
41
- export interface WorkflowCustomSchedule extends WorkflowTimeOfDaySchedule {
42
- custom_schedule_frequency: WorkflowCustomScheduleFrequencyUnit;
43
- custom_schedule_frequency_value: number;
44
- daily_schedule?: WorkflowTimeOfDaySchedule;
45
- weekly_schedule?: WorkflowWeeklySchedule;
46
- monthly_schedule?: WorkflowMonthlySchedule;
47
- annual_schedule?: WorkflowAnnualSchedule;
48
- }
49
- export interface WorkflowTriggerBase {
50
- automation_event_type: WorkflowAutomationEventType;
51
- og_module?: string;
52
- base_model?: string;
53
- rql_formula?: string;
54
- is_basic_workflow?: boolean;
55
- og_category?: string;
56
- condition_builder_mode?: string;
57
- conditions_tree?: string;
58
- }
59
- export interface WorkflowBusinessTrigger extends WorkflowTriggerBase {
60
- automation_event_type: 'AUTOMATION_EVENT_TYPE_BUSINESS';
61
- /** Business event to subscribe to. Availability is validated during installation. */
62
- event_name: BusinessEventKey;
63
- business_event_trigger?: {
64
- navigation_path?: string;
65
- };
66
- }
67
- export type WorkflowBusinessEventKey = BusinessEventKey;
68
- export interface WorkflowRecordChangeTrigger extends WorkflowTriggerBase {
69
- automation_event_type: 'AUTOMATION_EVENT_TYPE_RECORD_CHANGE';
70
- record_change_operation_type: WorkflowRecordChangeOperationType;
71
- }
72
- export interface WorkflowDateRelativeTrigger extends WorkflowTriggerBase {
73
- automation_event_type: 'AUTOMATION_EVENT_TYPE_DATE_RELATIVE';
74
- date_relative_trigger: {
75
- hour_of_day: number;
76
- minute_of_hour?: number;
77
- timezone?: string;
78
- base_model_date_field_rql_path?: string;
79
- trigger_on_anniversary?: boolean;
80
- date_range_operator?: WorkflowDateRelativeOperatorType;
81
- should_trigger_exactly_once_per_trigger_object?: boolean;
82
- operands?: Array<{
83
- time_delta?: {
84
- days: number;
85
- };
86
- }>;
87
- };
88
- }
89
- export interface WorkflowScheduledTrigger extends WorkflowTriggerBase {
90
- automation_event_type: 'AUTOMATION_EVENT_TYPE_SCHEDULED';
91
- scheduled_trigger: {
92
- frequency: WorkflowScheduledFrequencyType;
93
- timezone: string;
94
- daily_schedule?: WorkflowTimeOfDaySchedule;
95
- weekday_schedule?: WorkflowTimeOfDaySchedule;
96
- one_time_schedule?: WorkflowOneTimeSchedule;
97
- weekly_schedule?: WorkflowWeeklySchedule;
98
- bi_weekly_schedule?: WorkflowWeeklySchedule;
99
- monthly_schedule?: WorkflowMonthlySchedule;
100
- monthly_on_day_of_week_schedule?: WorkflowMonthlyOnDayOfWeekSchedule;
101
- quarterly_schedule?: WorkflowQuarterlySchedule;
102
- annual_schedule?: WorkflowAnnualSchedule;
103
- cron_schedule?: WorkflowCronSchedule;
104
- custom_schedule?: WorkflowCustomSchedule;
105
- };
106
- }
107
- export interface WorkflowManualTrigger extends WorkflowTriggerBase {
108
- automation_event_type: 'AUTOMATION_EVENT_TYPE_MANUAL';
109
- }
110
- export type WorkflowTrigger = WorkflowBusinessTrigger | WorkflowRecordChangeTrigger | WorkflowDateRelativeTrigger | WorkflowScheduledTrigger | WorkflowManualTrigger;
111
- export interface WorkflowDeletionIdentifier {
112
- definitionId: string;
113
- }
114
- export interface WorkflowProps {
115
- /**
116
- * Stable workflow definition id. Auto-generated when omitted.
117
- */
118
- definitionId?: string;
119
- /**
120
- * Workflow title shown to admins.
121
- */
122
- title: string;
123
- /**
124
- * Short workflow description shown to admins.
125
- */
126
- description: string;
127
- /**
128
- * The function this workflow runs. Pass a live {@link ManifestFunction} reference,
129
- * or a raw api_name string for functions defined outside this manifest.
130
- *
131
- * Required.
132
- */
133
- function: ManifestFunction | string;
134
- /**
135
- * Trigger definition in the workflows v2 proto JSON shape.
136
- */
137
- trigger: WorkflowTrigger;
138
- }
139
- /**
140
- * Defines a simple Workflow Studio workflow and registers it with the manifest.
141
- *
142
- * This intentionally models only the authoring inputs we need today: workflow
143
- * metadata, trigger JSON, and the function reference. The installer/backend can
144
- * derive the graph from these fields later.
145
- */
146
- export declare class Workflow {
147
- static readonly componentType: "WORKFLOW_DEFINITION";
148
- static toDeletionIdentifier(identifier: WorkflowDeletionIdentifier | string): ManifestComponentDeletion;
149
- private readonly _definitionId;
150
- private readonly _title;
151
- private readonly _description;
152
- private readonly _functionApiName;
153
- private readonly _trigger;
154
- constructor(scope: ManifestScope, props: WorkflowProps);
155
- getDefinitionId(): string;
156
- toDict(): Record<string, any>;
157
- }
158
- //# sourceMappingURL=workflow.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"workflow.d.ts","sourceRoot":"","sources":["../../src/lib/manifest/workflow.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,4BAAyB;AACzD,OAAO,KAAK,EAAE,gBAAgB,EAAE,+BAA4B;AAC5D,OAAO,KAAK,EAAE,yBAAyB,EAAE,aAAa,EAAE,8BAA2B;AAEnF,MAAM,MAAM,2BAA2B,GACnC,gCAAgC,GAChC,qCAAqC,GACrC,iCAAiC,GACjC,8BAA8B,GAC9B,qCAAqC,CAAC;AAE1C,MAAM,MAAM,iCAAiC,GACzC,qCAAqC,GACrC,qCAAqC,GACrC,qCAAqC,GACrC,+CAA+C,CAAC;AAEpD,MAAM,MAAM,gCAAgC,GACxC,wCAAwC,GACxC,4CAA4C,GAC5C,6CAA6C,CAAC;AAElD,MAAM,MAAM,8BAA8B,GACtC,wCAAwC,GACxC,gDAAgD,GAChD,yCAAyC,GACzC,2CAA2C,GAC3C,0CAA0C,GAC1C,yDAAyD,GACzD,2CAA2C,GAC3C,4CAA4C,GAC5C,2CAA2C,GAC3C,yCAAyC,GACzC,uCAAuC,CAAC;AAE5C,MAAM,MAAM,mCAAmC,GAC3C,6CAA6C,GAC7C,8CAA8C,GAC9C,+CAA+C,GAC/C,8CAA8C,GAC9C,8CAA8C,GAC9C,gDAAgD,CAAC;AAErD,MAAM,WAAW,yBAAyB;IACxC,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,uBAAwB,SAAQ,yBAAyB;IACxE,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,sBAAuB,SAAQ,yBAAyB;IACvE,WAAW,EAAE,MAAM,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,uBAAwB,SAAQ,yBAAyB;IACxE,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,kCAAmC,SAAQ,yBAAyB;IACnF,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,yBAA0B,SAAQ,yBAAyB;IAC1E,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,sBAAuB,SAAQ,yBAAyB;IACvE,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,oBAAoB;IACnC,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,sBAAuB,SAAQ,yBAAyB;IACvE,yBAAyB,EAAE,mCAAmC,CAAC;IAC/D,+BAA+B,EAAE,MAAM,CAAC;IACxC,cAAc,CAAC,EAAE,yBAAyB,CAAC;IAC3C,eAAe,CAAC,EAAE,sBAAsB,CAAC;IACzC,gBAAgB,CAAC,EAAE,uBAAuB,CAAC;IAC3C,eAAe,CAAC,EAAE,sBAAsB,CAAC;CAC1C;AAED,MAAM,WAAW,mBAAmB;IAClC,qBAAqB,EAAE,2BAA2B,CAAC;IACnD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,uBAAwB,SAAQ,mBAAmB;IAClE,qBAAqB,EAAE,gCAAgC,CAAC;IACxD,qFAAqF;IACrF,UAAU,EAAE,gBAAgB,CAAC;IAC7B,sBAAsB,CAAC,EAAE;QACvB,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B,CAAC;CACH;AAED,MAAM,MAAM,wBAAwB,GAAG,gBAAgB,CAAC;AAExD,MAAM,WAAW,2BAA4B,SAAQ,mBAAmB;IACtE,qBAAqB,EAAE,qCAAqC,CAAC;IAC7D,4BAA4B,EAAE,iCAAiC,CAAC;CACjE;AAED,MAAM,WAAW,2BAA4B,SAAQ,mBAAmB;IACtE,qBAAqB,EAAE,qCAAqC,CAAC;IAC7D,qBAAqB,EAAE;QACrB,WAAW,EAAE,MAAM,CAAC;QACpB,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,8BAA8B,CAAC,EAAE,MAAM,CAAC;QACxC,sBAAsB,CAAC,EAAE,OAAO,CAAC;QACjC,mBAAmB,CAAC,EAAE,gCAAgC,CAAC;QACvD,8CAA8C,CAAC,EAAE,OAAO,CAAC;QACzD,QAAQ,CAAC,EAAE,KAAK,CAAC;YAAE,UAAU,CAAC,EAAE;gBAAE,IAAI,EAAE,MAAM,CAAA;aAAE,CAAA;SAAE,CAAC,CAAC;KACrD,CAAC;CACH;AAED,MAAM,WAAW,wBAAyB,SAAQ,mBAAmB;IACnE,qBAAqB,EAAE,iCAAiC,CAAC;IACzD,iBAAiB,EAAE;QACjB,SAAS,EAAE,8BAA8B,CAAC;QAC1C,QAAQ,EAAE,MAAM,CAAC;QACjB,cAAc,CAAC,EAAE,yBAAyB,CAAC;QAC3C,gBAAgB,CAAC,EAAE,yBAAyB,CAAC;QAC7C,iBAAiB,CAAC,EAAE,uBAAuB,CAAC;QAC5C,eAAe,CAAC,EAAE,sBAAsB,CAAC;QACzC,kBAAkB,CAAC,EAAE,sBAAsB,CAAC;QAC5C,gBAAgB,CAAC,EAAE,uBAAuB,CAAC;QAC3C,+BAA+B,CAAC,EAAE,kCAAkC,CAAC;QACrE,kBAAkB,CAAC,EAAE,yBAAyB,CAAC;QAC/C,eAAe,CAAC,EAAE,sBAAsB,CAAC;QACzC,aAAa,CAAC,EAAE,oBAAoB,CAAC;QACrC,eAAe,CAAC,EAAE,sBAAsB,CAAC;KAC1C,CAAC;CACH;AAED,MAAM,WAAW,qBAAsB,SAAQ,mBAAmB;IAChE,qBAAqB,EAAE,8BAA8B,CAAC;CACvD;AAED,MAAM,MAAM,eAAe,GACvB,uBAAuB,GACvB,2BAA2B,GAC3B,2BAA2B,GAC3B,wBAAwB,GACxB,qBAAqB,CAAC;AAE1B,MAAM,WAAW,0BAA0B;IACzC,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;;OAKG;IACH,QAAQ,EAAE,gBAAgB,GAAG,MAAM,CAAC;IACpC;;OAEG;IACH,OAAO,EAAE,eAAe,CAAC;CAC1B;AAED;;;;;;GAMG;AACH,qBAAa,QAAQ;IACnB,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAG,qBAAqB,CAAU;IAE/D,MAAM,CAAC,oBAAoB,CAAC,UAAU,EAAE,0BAA0B,GAAG,MAAM,GAAG,yBAAyB;IAQvG,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IACvC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IACtC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAS;IAC1C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAkB;gBAE/B,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,aAAa;IAUtD,eAAe,IAAI,MAAM;IAIzB,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAe9B"}
@@ -1,51 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.Workflow = void 0;
4
- const _helpers_1 = require("./_helpers.js");
5
- /**
6
- * Defines a simple Workflow Studio workflow and registers it with the manifest.
7
- *
8
- * This intentionally models only the authoring inputs we need today: workflow
9
- * metadata, trigger JSON, and the function reference. The installer/backend can
10
- * derive the graph from these fields later.
11
- */
12
- class Workflow {
13
- static toDeletionIdentifier(identifier) {
14
- const definitionId = typeof identifier === 'string' ? identifier : identifier.definitionId;
15
- return {
16
- type: Workflow.componentType,
17
- definition_id: definitionId,
18
- };
19
- }
20
- constructor(scope, props) {
21
- if (!props.function)
22
- throw new Error('function is required');
23
- this._definitionId = props.definitionId ?? (0, _helpers_1.generateId)('workflow');
24
- this._title = props.title;
25
- this._description = props.description;
26
- this._functionApiName = typeof props.function === 'string' ? props.function : props.function.getApiName();
27
- this._trigger = props.trigger;
28
- scope._register(this);
29
- }
30
- getDefinitionId() {
31
- return this._definitionId;
32
- }
33
- toDict() {
34
- const component = {
35
- type: Workflow.componentType,
36
- definition_id: this._definitionId,
37
- version_status: 'VERSION_STATUS_DRAFT',
38
- trigger_status: 'TRIGGER_STATUS_INACTIVE',
39
- trigger: this._trigger,
40
- workflow_meta: {
41
- name: this._title,
42
- description: this._description,
43
- },
44
- function_api_name: this._functionApiName,
45
- };
46
- return component;
47
- }
48
- }
49
- exports.Workflow = Workflow;
50
- Workflow.componentType = 'WORKFLOW_DEFINITION';
51
- //# sourceMappingURL=workflow.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"workflow.js","sourceRoot":"","sources":["../../src/lib/manifest/workflow.ts"],"names":[],"mappings":";;;AAAA,4CAAwC;AAkMxC;;;;;;GAMG;AACH,MAAa,QAAQ;IAGnB,MAAM,CAAC,oBAAoB,CAAC,UAA+C;QACzE,MAAM,YAAY,GAAG,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,YAAY,CAAC;QAC3F,OAAO;YACL,IAAI,EAAE,QAAQ,CAAC,aAAa;YAC5B,aAAa,EAAE,YAAY;SAC5B,CAAC;IACJ,CAAC;IAQD,YAAY,KAAoB,EAAE,KAAoB;QACpD,IAAI,CAAC,KAAK,CAAC,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAC7D,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,IAAI,IAAA,qBAAU,EAAC,UAAU,CAAC,CAAC;QAClE,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC;QAC1B,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,gBAAgB,GAAG,OAAO,KAAK,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;QAC1G,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED,eAAe;QACb,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED,MAAM;QACJ,MAAM,SAAS,GAAwB;YACrC,IAAI,EAAE,QAAQ,CAAC,aAAa;YAC5B,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,cAAc,EAAE,sBAAsB;YACtC,cAAc,EAAE,yBAAyB;YACzC,OAAO,EAAE,IAAI,CAAC,QAAQ;YACtB,aAAa,EAAE;gBACb,IAAI,EAAE,IAAI,CAAC,MAAM;gBACjB,WAAW,EAAE,IAAI,CAAC,YAAY;aAC/B;YACD,iBAAiB,EAAE,IAAI,CAAC,gBAAgB;SACzC,CAAC;QACF,OAAO,SAAS,CAAC;IACnB,CAAC;;AA7CH,4BA8CC;AA7CiB,sBAAa,GAAG,qBAA8B,CAAC"}