@rippling/rippling-sdk 0.2.0-alpha.53 → 0.2.0-alpha.55

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 (105) hide show
  1. package/client.d.mts +24 -0
  2. package/client.d.mts.map +1 -1
  3. package/client.d.ts +24 -0
  4. package/client.d.ts.map +1 -1
  5. package/client.js +24 -0
  6. package/client.js.map +1 -1
  7. package/client.mjs +24 -0
  8. package/client.mjs.map +1 -1
  9. package/examples/functions/durable.ts +6 -6
  10. package/examples/manifest/custom-object-creation-workflow/custom-object-creation-workflow.ts +85 -0
  11. package/lib/manifest/index.d.mts +1 -0
  12. package/lib/manifest/index.d.mts.map +1 -1
  13. package/lib/manifest/index.d.ts +1 -0
  14. package/lib/manifest/index.d.ts.map +1 -1
  15. package/lib/manifest/index.js +3 -1
  16. package/lib/manifest/index.js.map +1 -1
  17. package/lib/manifest/index.mjs +1 -0
  18. package/lib/manifest/index.mjs.map +1 -1
  19. package/lib/manifest/manifest-builder.d.mts +1 -1
  20. package/lib/manifest/manifest-builder.d.mts.map +1 -1
  21. package/lib/manifest/manifest-builder.d.ts +1 -1
  22. package/lib/manifest/manifest-builder.d.ts.map +1 -1
  23. package/lib/manifest/manifest-builder.js.map +1 -1
  24. package/lib/manifest/manifest-builder.mjs.map +1 -1
  25. package/lib/manifest/workflow.d.mts +155 -0
  26. package/lib/manifest/workflow.d.mts.map +1 -0
  27. package/lib/manifest/workflow.d.ts +155 -0
  28. package/lib/manifest/workflow.d.ts.map +1 -0
  29. package/lib/manifest/workflow.js +51 -0
  30. package/lib/manifest/workflow.js.map +1 -0
  31. package/lib/manifest/workflow.mjs +47 -0
  32. package/lib/manifest/workflow.mjs.map +1 -0
  33. package/package.json +1 -1
  34. package/resources/break-types.d.mts +85 -0
  35. package/resources/break-types.d.mts.map +1 -0
  36. package/resources/break-types.d.ts +85 -0
  37. package/resources/break-types.d.ts.map +1 -0
  38. package/resources/break-types.js +32 -0
  39. package/resources/break-types.js.map +1 -0
  40. package/resources/break-types.mjs +28 -0
  41. package/resources/break-types.mjs.map +1 -0
  42. package/resources/earnings-inputs.d.mts +33 -0
  43. package/resources/earnings-inputs.d.mts.map +1 -1
  44. package/resources/earnings-inputs.d.ts +33 -0
  45. package/resources/earnings-inputs.d.ts.map +1 -1
  46. package/resources/index.d.mts +4 -0
  47. package/resources/index.d.mts.map +1 -1
  48. package/resources/index.d.ts +4 -0
  49. package/resources/index.d.ts.map +1 -1
  50. package/resources/index.js +10 -2
  51. package/resources/index.js.map +1 -1
  52. package/resources/index.mjs +4 -0
  53. package/resources/index.mjs.map +1 -1
  54. package/resources/scheduled-job-assignments.d.mts +156 -0
  55. package/resources/scheduled-job-assignments.d.mts.map +1 -0
  56. package/resources/scheduled-job-assignments.d.ts +156 -0
  57. package/resources/scheduled-job-assignments.d.ts.map +1 -0
  58. package/resources/scheduled-job-assignments.js +39 -0
  59. package/resources/scheduled-job-assignments.js.map +1 -0
  60. package/resources/scheduled-job-assignments.mjs +35 -0
  61. package/resources/scheduled-job-assignments.mjs.map +1 -0
  62. package/resources/software-deployments.d.mts +468 -0
  63. package/resources/software-deployments.d.mts.map +1 -0
  64. package/resources/software-deployments.d.ts +468 -0
  65. package/resources/software-deployments.d.ts.map +1 -0
  66. package/resources/software-deployments.js +56 -0
  67. package/resources/software-deployments.js.map +1 -0
  68. package/resources/software-deployments.mjs +52 -0
  69. package/resources/software-deployments.mjs.map +1 -0
  70. package/resources/worker-time-splits.d.mts +371 -0
  71. package/resources/worker-time-splits.d.mts.map +1 -0
  72. package/resources/worker-time-splits.d.ts +371 -0
  73. package/resources/worker-time-splits.d.ts.map +1 -0
  74. package/resources/worker-time-splits.js +56 -0
  75. package/resources/worker-time-splits.js.map +1 -0
  76. package/resources/worker-time-splits.mjs +52 -0
  77. package/resources/worker-time-splits.mjs.map +1 -0
  78. package/resources/workers.d.mts +1 -1
  79. package/resources/workers.d.ts +1 -1
  80. package/resources/workers.js +1 -1
  81. package/resources/workers.mjs +1 -1
  82. package/resources/workflow-action-executions.d.mts +1483 -1263
  83. package/resources/workflow-action-executions.d.mts.map +1 -1
  84. package/resources/workflow-action-executions.d.ts +1483 -1263
  85. package/resources/workflow-action-executions.d.ts.map +1 -1
  86. package/src/client.ts +100 -0
  87. package/src/lib/manifest/index.ts +26 -0
  88. package/src/lib/manifest/manifest-builder.ts +2 -1
  89. package/src/lib/manifest/workflow.ts +244 -0
  90. package/src/resources/break-types.ts +120 -0
  91. package/src/resources/earnings-inputs.ts +39 -0
  92. package/src/resources/index.ts +38 -0
  93. package/src/resources/scheduled-job-assignments.ts +216 -0
  94. package/src/resources/software-deployments.ts +607 -0
  95. package/src/resources/worker-time-splits.ts +480 -0
  96. package/src/resources/workers.ts +1 -1
  97. package/src/resources/workflow-action-executions.ts +1730 -1445
  98. package/src/version.ts +1 -1
  99. package/version.d.mts +1 -1
  100. package/version.d.ts +1 -1
  101. package/version.js +1 -1
  102. package/version.mjs +1 -1
  103. package/examples/manifest/dental-practice-management/manifest.json +0 -1912
  104. package/examples/manifest/gym-membership-management/manifest.json +0 -1991
  105. package/examples/manifest/simple-todo-app/manifest.json +0 -429
@@ -1,429 +0,0 @@
1
- {
2
- "metadata": {
3
- "key": "simple_todo_app",
4
- "name": "Simple Todo",
5
- "description": "A minimal CRUD todo app: one Custom Object rendered as an SDUI ObjectListView"
6
- },
7
- "components": [
8
- {
9
- "type": "CUSTOM_CATEGORY",
10
- "api_name": "simple_todo__c",
11
- "name": "Tasks",
12
- "description": "Container for todo records"
13
- },
14
- {
15
- "type": "CUSTOM_OBJECT",
16
- "api_name": "simple_todo__c",
17
- "name": "Todo",
18
- "description": "A single task with status, priority, and due date",
19
- "category_api_name": "simple_todo__c",
20
- "icon": {
21
- "emoji": "✅"
22
- },
23
- "plural_label": "Todos"
24
- },
25
- {
26
- "type": "CUSTOM_OBJECT_FIELD",
27
- "custom_object_api_name": "simple_todo__c",
28
- "field_api_name": "id",
29
- "field_display_name": "ID",
30
- "data_type": {
31
- "options_list": [],
32
- "supported_types": [],
33
- "field_type": "TEXT"
34
- },
35
- "description": "The Rippling ID of a record",
36
- "is_required": true,
37
- "is_unique": true,
38
- "is_indexed": null,
39
- "rql_formula": null,
40
- "formula_attr_metas": null,
41
- "is_standard": true,
42
- "derived_aggregated_field": null,
43
- "derived_field_formula": null,
44
- "section": null
45
- },
46
- {
47
- "type": "CUSTOM_OBJECT_FIELD",
48
- "custom_object_api_name": "simple_todo__c",
49
- "field_api_name": "created_at",
50
- "field_display_name": "Created Date",
51
- "data_type": {
52
- "options_list": [],
53
- "supported_types": [],
54
- "field_type": "DATETIME"
55
- },
56
- "description": "The date and time a record was created",
57
- "is_required": false,
58
- "is_unique": false,
59
- "is_indexed": null,
60
- "rql_formula": null,
61
- "formula_attr_metas": null,
62
- "is_standard": true,
63
- "derived_aggregated_field": null,
64
- "derived_field_formula": null,
65
- "section": null
66
- },
67
- {
68
- "type": "CUSTOM_OBJECT_FIELD",
69
- "custom_object_api_name": "simple_todo__c",
70
- "field_api_name": "updated_at",
71
- "field_display_name": "Last Modified Date",
72
- "data_type": {
73
- "options_list": [],
74
- "supported_types": [],
75
- "field_type": "DATETIME"
76
- },
77
- "description": "The date and time a record was last updated",
78
- "is_required": false,
79
- "is_unique": false,
80
- "is_indexed": null,
81
- "rql_formula": null,
82
- "formula_attr_metas": null,
83
- "is_standard": true,
84
- "derived_aggregated_field": null,
85
- "derived_field_formula": null,
86
- "section": null
87
- },
88
- {
89
- "type": "CUSTOM_OBJECT_FIELD",
90
- "custom_object_api_name": "simple_todo__c",
91
- "field_api_name": "system_updated_at",
92
- "field_display_name": "System Modified At",
93
- "data_type": {
94
- "options_list": [],
95
- "supported_types": [],
96
- "field_type": "DATETIME"
97
- },
98
- "description": "The date and time a record was last updated by the system",
99
- "is_required": false,
100
- "is_unique": false,
101
- "is_indexed": null,
102
- "rql_formula": null,
103
- "formula_attr_metas": null,
104
- "is_standard": true,
105
- "derived_aggregated_field": null,
106
- "derived_field_formula": null,
107
- "section": null
108
- },
109
- {
110
- "type": "CUSTOM_OBJECT_FIELD",
111
- "custom_object_api_name": "simple_todo__c",
112
- "field_api_name": "external_id",
113
- "field_display_name": "External ID",
114
- "data_type": {
115
- "options_list": [],
116
- "supported_types": [],
117
- "field_type": "TEXT"
118
- },
119
- "description": "The external identifier for a record used in third party integrations",
120
- "is_required": false,
121
- "is_unique": true,
122
- "is_indexed": null,
123
- "rql_formula": null,
124
- "formula_attr_metas": null,
125
- "is_standard": true,
126
- "derived_aggregated_field": null,
127
- "derived_field_formula": null,
128
- "section": null
129
- },
130
- {
131
- "type": "CUSTOM_OBJECT_FIELD",
132
- "custom_object_api_name": "simple_todo__c",
133
- "field_api_name": "name",
134
- "field_display_name": "Name",
135
- "data_type": {
136
- "options_list": [],
137
- "supported_types": [],
138
- "field_type": "TEXT"
139
- },
140
- "description": "A string used to describe a record. This is used for display purposes as well as search",
141
- "is_required": true,
142
- "is_unique": false,
143
- "is_indexed": null,
144
- "rql_formula": null,
145
- "formula_attr_metas": null,
146
- "is_standard": true,
147
- "derived_aggregated_field": null,
148
- "derived_field_formula": null,
149
- "section": null
150
- },
151
- {
152
- "type": "CUSTOM_OBJECT_FIELD",
153
- "custom_object_api_name": "simple_todo__c",
154
- "field_api_name": "owner_role",
155
- "field_display_name": "Owner",
156
- "data_type": {
157
- "options_list": [],
158
- "supported_types": [],
159
- "field_type": "NATIVE_EDGE",
160
- "og_model_rql_name": "Employee",
161
- "db_model_name": "RoleWithCompany",
162
- "reference_column_storage_type": "STRING"
163
- },
164
- "description": "The Employee responsible for the record. This is used by Permissions to determine who has ability to view, edit, and delete data",
165
- "is_required": false,
166
- "is_unique": false,
167
- "is_indexed": null,
168
- "rql_formula": null,
169
- "formula_attr_metas": null,
170
- "is_standard": true,
171
- "derived_aggregated_field": null,
172
- "derived_field_formula": null,
173
- "section": null
174
- },
175
- {
176
- "type": "CUSTOM_OBJECT_FIELD",
177
- "custom_object_api_name": "simple_todo__c",
178
- "field_api_name": "last_modified_by",
179
- "field_display_name": "Last Modified by",
180
- "data_type": {
181
- "options_list": [],
182
- "supported_types": [],
183
- "field_type": "NATIVE_EDGE",
184
- "og_model_rql_name": "Employee",
185
- "db_model_name": "RoleWithCompany",
186
- "reference_column_storage_type": "STRING"
187
- },
188
- "description": "The Employee who made the latest change.",
189
- "is_required": false,
190
- "is_unique": false,
191
- "is_indexed": null,
192
- "rql_formula": null,
193
- "formula_attr_metas": null,
194
- "is_standard": true,
195
- "derived_aggregated_field": null,
196
- "derived_field_formula": null,
197
- "section": null
198
- },
199
- {
200
- "type": "CUSTOM_OBJECT_FIELD",
201
- "custom_object_api_name": "simple_todo__c",
202
- "field_api_name": "created_by",
203
- "field_display_name": "Created by",
204
- "data_type": {
205
- "options_list": [],
206
- "supported_types": [],
207
- "field_type": "NATIVE_EDGE",
208
- "og_model_rql_name": "Employee",
209
- "db_model_name": "RoleWithCompany",
210
- "reference_column_storage_type": "STRING"
211
- },
212
- "description": "The Employee who created the record",
213
- "is_required": false,
214
- "is_unique": false,
215
- "is_indexed": null,
216
- "rql_formula": null,
217
- "formula_attr_metas": null,
218
- "is_standard": true,
219
- "derived_aggregated_field": null,
220
- "derived_field_formula": null,
221
- "section": null
222
- },
223
- {
224
- "type": "CUSTOM_OBJECT_FIELD_SECTION",
225
- "section_id": "sec_todo_details",
226
- "model_name": "simple_todo__c",
227
- "name": "Details"
228
- },
229
- {
230
- "type": "CUSTOM_OBJECT_FIELD",
231
- "custom_object_api_name": "simple_todo__c",
232
- "field_api_name": "title__c",
233
- "field_display_name": "Title",
234
- "data_type": {
235
- "options_list": [],
236
- "supported_types": [],
237
- "field_type": "TEXT",
238
- "max_length": 200
239
- },
240
- "description": null,
241
- "is_required": true,
242
- "is_unique": null,
243
- "is_indexed": null,
244
- "rql_formula": null,
245
- "formula_attr_metas": null,
246
- "is_standard": false,
247
- "derived_aggregated_field": null,
248
- "derived_field_formula": null,
249
- "section": "sec_todo_details"
250
- },
251
- {
252
- "type": "CUSTOM_OBJECT_FIELD",
253
- "custom_object_api_name": "simple_todo__c",
254
- "field_api_name": "status__c",
255
- "field_display_name": "Status",
256
- "data_type": {
257
- "options_list": ["To Do", "In Progress", "Done"],
258
- "supported_types": [],
259
- "field_type": "SELECT"
260
- },
261
- "description": null,
262
- "is_required": true,
263
- "is_unique": null,
264
- "is_indexed": null,
265
- "rql_formula": null,
266
- "formula_attr_metas": null,
267
- "is_standard": false,
268
- "derived_aggregated_field": null,
269
- "derived_field_formula": null,
270
- "section": "sec_todo_details"
271
- },
272
- {
273
- "type": "CUSTOM_OBJECT_FIELD",
274
- "custom_object_api_name": "simple_todo__c",
275
- "field_api_name": "priority__c",
276
- "field_display_name": "Priority",
277
- "data_type": {
278
- "options_list": ["Low", "Medium", "High"],
279
- "supported_types": [],
280
- "field_type": "SELECT"
281
- },
282
- "description": null,
283
- "is_required": null,
284
- "is_unique": null,
285
- "is_indexed": null,
286
- "rql_formula": null,
287
- "formula_attr_metas": null,
288
- "is_standard": false,
289
- "derived_aggregated_field": null,
290
- "derived_field_formula": null,
291
- "section": "sec_todo_details"
292
- },
293
- {
294
- "type": "CUSTOM_OBJECT_FIELD",
295
- "custom_object_api_name": "simple_todo__c",
296
- "field_api_name": "due_date__c",
297
- "field_display_name": "Due date",
298
- "data_type": {
299
- "options_list": [],
300
- "supported_types": [],
301
- "field_type": "DATE"
302
- },
303
- "description": null,
304
- "is_required": null,
305
- "is_unique": null,
306
- "is_indexed": null,
307
- "rql_formula": null,
308
- "formula_attr_metas": null,
309
- "is_standard": false,
310
- "derived_aggregated_field": null,
311
- "derived_field_formula": null,
312
- "section": "sec_todo_details"
313
- },
314
- {
315
- "type": "CUSTOM_OBJECT_FIELD",
316
- "custom_object_api_name": "simple_todo__c",
317
- "field_api_name": "notes__c",
318
- "field_display_name": "Notes",
319
- "data_type": {
320
- "options_list": [],
321
- "supported_types": [],
322
- "field_type": "LONG_TEXT",
323
- "max_length": 4000
324
- },
325
- "description": null,
326
- "is_required": null,
327
- "is_unique": null,
328
- "is_indexed": null,
329
- "rql_formula": null,
330
- "formula_attr_metas": null,
331
- "is_standard": false,
332
- "derived_aggregated_field": null,
333
- "derived_field_formula": null,
334
- "section": "sec_todo_details"
335
- },
336
- {
337
- "type": "CUSTOM_OBJECT_LIST_VIEW",
338
- "object_rql_name": "simple_todo__c",
339
- "view_id": "view_simple_todo_open",
340
- "name": "Open todos",
341
- "public": true,
342
- "fields": ["title__c", "status__c", "priority__c", "due_date__c"],
343
- "description": "Everything that is not Done, ordered by due date",
344
- "object_scope": "all",
345
- "sort_order": "ASC",
346
- "order_by": "due_date__c",
347
- "rql_filter": "(status__c != 'Done')"
348
- },
349
- {
350
- "type": "CUSTOM_OBJECT_PAGE_LAYOUT",
351
- "layout_id": "layout_simple_todo",
352
- "api_name": "default",
353
- "object_rql_name": "simple_todo__c",
354
- "name": "Todo",
355
- "system_created": false,
356
- "tab_edits": {
357
- "tabsOrder": ["todo"],
358
- "newTabs": [
359
- {
360
- "key": "todo",
361
- "name": "Todo",
362
- "type": "tab_with_sections",
363
- "sections": [
364
- {
365
- "name": "Details",
366
- "type": "fields_section",
367
- "fields": [
368
- {
369
- "fieldRqlName": "title__c"
370
- },
371
- {
372
- "fieldRqlName": "status__c"
373
- },
374
- {
375
- "fieldRqlName": "priority__c"
376
- },
377
- {
378
- "fieldRqlName": "due_date__c"
379
- },
380
- {
381
- "fieldRqlName": "notes__c"
382
- }
383
- ],
384
- "key": "sec_todo_details"
385
- }
386
- ]
387
- }
388
- ],
389
- "systemTabEdits": {}
390
- },
391
- "header_edits": {
392
- "newTitleField": "title__c"
393
- },
394
- "visibility_conditions": {},
395
- "blueprint_key": "simple_todo__c"
396
- },
397
- {
398
- "type": "FUNCTION",
399
- "name": "Todos (SDUI)",
400
- "api_name": "simple_todo_list_fn",
401
- "description": "SDUI ObjectListView for todo records",
402
- "code_draft": "import { FunctionContext, FunctionEvent, FunctionResponse } from '@rippling/rippling-sdk';\nimport SDUI from '@rippling/rippling-sdk/lib/sdui';\n\nconst OBJECT = 'simple_todo__c';\n\nexport async function onRipplingEvent(\n event: FunctionEvent,\n context: FunctionContext,\n): Promise<FunctionResponse> {\n const action = event['parameters']?.action;\n\n if (!action || action === 'init') {\n const s = SDUI.createState({});\n const root = SDUI.components.VStack({\n children: [\n SDUI.components.ObjectListView({\n objectApiName: OBJECT,\n canSearchInGrid: true,\n }),\n ],\n });\n return new FunctionResponse({\n body: { spec: JSON.stringify(SDUI.render(s, root)) },\n statusCode: 200,\n headers: {},\n message: '',\n });\n }\n\n return new FunctionResponse({ body: {}, statusCode: 200, headers: {}, message: '' });\n}\n",
403
- "dependencies": {
404
- "@rippling/rippling-sdk": "^0.2.0-alpha.33"
405
- }
406
- },
407
- {
408
- "type": "SDUI_PAGE",
409
- "name": "Todos",
410
- "sdui_page_id": "simple_todo_page",
411
- "function_api_name": "simple_todo_list_fn",
412
- "description": "SDUI ObjectListView for todo records"
413
- },
414
- {
415
- "type": "CUSTOM_APP",
416
- "api_name": "simple_todo_app",
417
- "name": "Simple Todo",
418
- "description": "Minimal todo app: one Custom Object with an SDUI ObjectListView page",
419
- "app_type": "custom",
420
- "pages": [
421
- {
422
- "api_name": "simple_todo_page",
423
- "page_type": "sdui_page",
424
- "sdui_page_id": "simple_todo_page"
425
- }
426
- ]
427
- }
428
- ]
429
- }