@rippling/rippling-sdk 0.2.0-alpha.83 → 0.2.0-alpha.85

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 (314) hide show
  1. package/examples/manifest/custom-object-creation-workflow/custom-object-creation-workflow.ts +44 -26
  2. package/examples/manifest/dental-practice-management/dental-practice-management.ts +470 -142
  3. package/examples/manifest/dental-practice-management/functions/chair-schedule.ts +23 -13
  4. package/examples/manifest/dental-practice-management/functions/complete-visit.ts +55 -32
  5. package/examples/manifest/dental-practice-management/functions/operatory-list.ts +23 -13
  6. package/examples/manifest/dental-practice-management/functions/patient-list.ts +23 -13
  7. package/examples/manifest/dental-practice-management/functions/treatment-plan-list.ts +23 -13
  8. package/examples/manifest/existing-manifest-mutations/existing-manifest-mutations.ts +23 -68
  9. package/examples/manifest/field-service-dispatch/field-service-dispatch.ts +375 -102
  10. package/examples/manifest/grant-program-management/grant-program-management.ts +419 -125
  11. package/examples/manifest/gym-membership-management/functions/check-in-desk.ts +23 -13
  12. package/examples/manifest/gym-membership-management/functions/member-list.ts +23 -13
  13. package/examples/manifest/gym-membership-management/functions/today-schedule.ts +23 -13
  14. package/examples/manifest/gym-membership-management/functions/trainer-list.ts +23 -13
  15. package/examples/manifest/gym-membership-management/gym-membership-management.ts +442 -92
  16. package/examples/manifest/procurement-approval-hub/procurement-approval-hub.ts +408 -122
  17. package/examples/manifest/simple-todo-app/functions/mark-done.ts +12 -16
  18. package/examples/manifest/simple-todo-app/functions/todo-list.ts +23 -13
  19. package/examples/manifest/simple-todo-app/simple-todo-app.ts +109 -40
  20. package/examples/manifest/todo-app-without-object-list-view/functions/todo-page.ts +193 -166
  21. package/examples/manifest/todo-app-without-object-list-view/todo-app-without-object-list-view.ts +47 -24
  22. package/package.json +13 -7
  23. package/resources/custom-objects/custom-objects.d.mts +0 -7
  24. package/resources/custom-objects/custom-objects.d.mts.map +1 -1
  25. package/resources/custom-objects/custom-objects.d.ts +0 -7
  26. package/resources/custom-objects/custom-objects.d.ts.map +1 -1
  27. package/resources/custom-objects/custom-objects.js.map +1 -1
  28. package/resources/custom-objects/custom-objects.mjs.map +1 -1
  29. package/resources/custom-objects/fields.d.mts +14 -128
  30. package/resources/custom-objects/fields.d.mts.map +1 -1
  31. package/resources/custom-objects/fields.d.ts +14 -128
  32. package/resources/custom-objects/fields.d.ts.map +1 -1
  33. package/src/resources/custom-objects/custom-objects.ts +0 -8
  34. package/src/resources/custom-objects/fields.ts +13 -191
  35. package/src/tsconfig.json +1 -1
  36. package/src/version.ts +1 -1
  37. package/version.d.mts +1 -1
  38. package/version.d.ts +1 -1
  39. package/version.js +1 -1
  40. package/version.mjs +1 -1
  41. package/core/platform/custom-objects/category.d.mts +0 -125
  42. package/core/platform/custom-objects/category.d.mts.map +0 -1
  43. package/core/platform/custom-objects/category.d.ts +0 -125
  44. package/core/platform/custom-objects/category.d.ts.map +0 -1
  45. package/core/platform/custom-objects/category.js +0 -188
  46. package/core/platform/custom-objects/category.js.map +0 -1
  47. package/core/platform/custom-objects/category.mjs +0 -178
  48. package/core/platform/custom-objects/category.mjs.map +0 -1
  49. package/core/platform/custom-objects/definition.d.mts +0 -147
  50. package/core/platform/custom-objects/definition.d.mts.map +0 -1
  51. package/core/platform/custom-objects/definition.d.ts +0 -147
  52. package/core/platform/custom-objects/definition.d.ts.map +0 -1
  53. package/core/platform/custom-objects/definition.js +0 -200
  54. package/core/platform/custom-objects/definition.js.map +0 -1
  55. package/core/platform/custom-objects/definition.mjs +0 -190
  56. package/core/platform/custom-objects/definition.mjs.map +0 -1
  57. package/core/platform/custom-objects/fields.d.mts +0 -302
  58. package/core/platform/custom-objects/fields.d.mts.map +0 -1
  59. package/core/platform/custom-objects/fields.d.ts +0 -302
  60. package/core/platform/custom-objects/fields.d.ts.map +0 -1
  61. package/core/platform/custom-objects/fields.js +0 -369
  62. package/core/platform/custom-objects/fields.js.map +0 -1
  63. package/core/platform/custom-objects/fields.mjs +0 -347
  64. package/core/platform/custom-objects/fields.mjs.map +0 -1
  65. package/core/platform/custom-objects/function-runtime.d.mts +0 -42
  66. package/core/platform/custom-objects/function-runtime.d.mts.map +0 -1
  67. package/core/platform/custom-objects/function-runtime.d.ts +0 -42
  68. package/core/platform/custom-objects/function-runtime.d.ts.map +0 -1
  69. package/core/platform/custom-objects/function-runtime.js +0 -38
  70. package/core/platform/custom-objects/function-runtime.js.map +0 -1
  71. package/core/platform/custom-objects/function-runtime.mjs +0 -35
  72. package/core/platform/custom-objects/function-runtime.mjs.map +0 -1
  73. package/core/platform/custom-objects/lifecycle.d.mts +0 -83
  74. package/core/platform/custom-objects/lifecycle.d.mts.map +0 -1
  75. package/core/platform/custom-objects/lifecycle.d.ts +0 -83
  76. package/core/platform/custom-objects/lifecycle.d.ts.map +0 -1
  77. package/core/platform/custom-objects/lifecycle.js +0 -372
  78. package/core/platform/custom-objects/lifecycle.js.map +0 -1
  79. package/core/platform/custom-objects/lifecycle.mjs +0 -367
  80. package/core/platform/custom-objects/lifecycle.mjs.map +0 -1
  81. package/core/platform/custom-objects/manager.d.mts +0 -354
  82. package/core/platform/custom-objects/manager.d.mts.map +0 -1
  83. package/core/platform/custom-objects/manager.d.ts +0 -354
  84. package/core/platform/custom-objects/manager.d.ts.map +0 -1
  85. package/core/platform/custom-objects/manager.js +0 -646
  86. package/core/platform/custom-objects/manager.js.map +0 -1
  87. package/core/platform/custom-objects/manager.mjs +0 -637
  88. package/core/platform/custom-objects/manager.mjs.map +0 -1
  89. package/core/platform/custom-objects/provisioning.d.mts +0 -138
  90. package/core/platform/custom-objects/provisioning.d.mts.map +0 -1
  91. package/core/platform/custom-objects/provisioning.d.ts +0 -138
  92. package/core/platform/custom-objects/provisioning.d.ts.map +0 -1
  93. package/core/platform/custom-objects/provisioning.js +0 -455
  94. package/core/platform/custom-objects/provisioning.js.map +0 -1
  95. package/core/platform/custom-objects/provisioning.mjs +0 -447
  96. package/core/platform/custom-objects/provisioning.mjs.map +0 -1
  97. package/core/platform/custom-objects/rql.d.mts +0 -122
  98. package/core/platform/custom-objects/rql.d.mts.map +0 -1
  99. package/core/platform/custom-objects/rql.d.ts +0 -122
  100. package/core/platform/custom-objects/rql.d.ts.map +0 -1
  101. package/core/platform/custom-objects/rql.js +0 -225
  102. package/core/platform/custom-objects/rql.js.map +0 -1
  103. package/core/platform/custom-objects/rql.mjs +0 -222
  104. package/core/platform/custom-objects/rql.mjs.map +0 -1
  105. package/core/platform/custom-objects/schema-manager.d.mts +0 -203
  106. package/core/platform/custom-objects/schema-manager.d.mts.map +0 -1
  107. package/core/platform/custom-objects/schema-manager.d.ts +0 -203
  108. package/core/platform/custom-objects/schema-manager.d.ts.map +0 -1
  109. package/core/platform/custom-objects/schema-manager.js +0 -256
  110. package/core/platform/custom-objects/schema-manager.js.map +0 -1
  111. package/core/platform/custom-objects/schema-manager.mjs +0 -249
  112. package/core/platform/custom-objects/schema-manager.mjs.map +0 -1
  113. package/core/platform/custom-objects/typed-rql.d.mts +0 -157
  114. package/core/platform/custom-objects/typed-rql.d.mts.map +0 -1
  115. package/core/platform/custom-objects/typed-rql.d.ts +0 -157
  116. package/core/platform/custom-objects/typed-rql.d.ts.map +0 -1
  117. package/core/platform/custom-objects/typed-rql.js +0 -583
  118. package/core/platform/custom-objects/typed-rql.js.map +0 -1
  119. package/core/platform/custom-objects/typed-rql.mjs +0 -580
  120. package/core/platform/custom-objects/typed-rql.mjs.map +0 -1
  121. package/core/platform/custom-objects/types.d.mts +0 -549
  122. package/core/platform/custom-objects/types.d.mts.map +0 -1
  123. package/core/platform/custom-objects/types.d.ts +0 -549
  124. package/core/platform/custom-objects/types.d.ts.map +0 -1
  125. package/core/platform/custom-objects/types.js +0 -20
  126. package/core/platform/custom-objects/types.js.map +0 -1
  127. package/core/platform/custom-objects/types.mjs +0 -17
  128. package/core/platform/custom-objects/types.mjs.map +0 -1
  129. package/core/platform/custom-objects/validation.d.mts +0 -97
  130. package/core/platform/custom-objects/validation.d.mts.map +0 -1
  131. package/core/platform/custom-objects/validation.d.ts +0 -97
  132. package/core/platform/custom-objects/validation.d.ts.map +0 -1
  133. package/core/platform/custom-objects/validation.js +0 -477
  134. package/core/platform/custom-objects/validation.js.map +0 -1
  135. package/core/platform/custom-objects/validation.mjs +0 -465
  136. package/core/platform/custom-objects/validation.mjs.map +0 -1
  137. package/core/platform/custom-objects.d.mts +0 -67
  138. package/core/platform/custom-objects.d.mts.map +0 -1
  139. package/core/platform/custom-objects.d.ts +0 -67
  140. package/core/platform/custom-objects.d.ts.map +0 -1
  141. package/core/platform/custom-objects.js +0 -118
  142. package/core/platform/custom-objects.js.map +0 -1
  143. package/core/platform/custom-objects.mjs +0 -45
  144. package/core/platform/custom-objects.mjs.map +0 -1
  145. package/core/platform/manifest/custom-objects/action.d.mts +0 -58
  146. package/core/platform/manifest/custom-objects/action.d.mts.map +0 -1
  147. package/core/platform/manifest/custom-objects/action.d.ts +0 -58
  148. package/core/platform/manifest/custom-objects/action.d.ts.map +0 -1
  149. package/core/platform/manifest/custom-objects/action.js +0 -44
  150. package/core/platform/manifest/custom-objects/action.js.map +0 -1
  151. package/core/platform/manifest/custom-objects/action.mjs +0 -40
  152. package/core/platform/manifest/custom-objects/action.mjs.map +0 -1
  153. package/core/platform/manifest/custom-objects/conditions.d.mts +0 -240
  154. package/core/platform/manifest/custom-objects/conditions.d.mts.map +0 -1
  155. package/core/platform/manifest/custom-objects/conditions.d.ts +0 -240
  156. package/core/platform/manifest/custom-objects/conditions.d.ts.map +0 -1
  157. package/core/platform/manifest/custom-objects/conditions.js +0 -326
  158. package/core/platform/manifest/custom-objects/conditions.js.map +0 -1
  159. package/core/platform/manifest/custom-objects/conditions.mjs +0 -321
  160. package/core/platform/manifest/custom-objects/conditions.mjs.map +0 -1
  161. package/core/platform/manifest/custom-objects/existing.d.mts +0 -87
  162. package/core/platform/manifest/custom-objects/existing.d.mts.map +0 -1
  163. package/core/platform/manifest/custom-objects/existing.d.ts +0 -87
  164. package/core/platform/manifest/custom-objects/existing.d.ts.map +0 -1
  165. package/core/platform/manifest/custom-objects/existing.js +0 -113
  166. package/core/platform/manifest/custom-objects/existing.js.map +0 -1
  167. package/core/platform/manifest/custom-objects/existing.mjs +0 -109
  168. package/core/platform/manifest/custom-objects/existing.mjs.map +0 -1
  169. package/core/platform/manifest/custom-objects/field-resolution.d.mts +0 -48
  170. package/core/platform/manifest/custom-objects/field-resolution.d.mts.map +0 -1
  171. package/core/platform/manifest/custom-objects/field-resolution.d.ts +0 -48
  172. package/core/platform/manifest/custom-objects/field-resolution.d.ts.map +0 -1
  173. package/core/platform/manifest/custom-objects/field-resolution.js +0 -61
  174. package/core/platform/manifest/custom-objects/field-resolution.js.map +0 -1
  175. package/core/platform/manifest/custom-objects/field-resolution.mjs +0 -58
  176. package/core/platform/manifest/custom-objects/field-resolution.mjs.map +0 -1
  177. package/core/platform/manifest/custom-objects/function-file.d.mts +0 -87
  178. package/core/platform/manifest/custom-objects/function-file.d.mts.map +0 -1
  179. package/core/platform/manifest/custom-objects/function-file.d.ts +0 -87
  180. package/core/platform/manifest/custom-objects/function-file.d.ts.map +0 -1
  181. package/core/platform/manifest/custom-objects/function-file.js +0 -76
  182. package/core/platform/manifest/custom-objects/function-file.js.map +0 -1
  183. package/core/platform/manifest/custom-objects/function-file.mjs +0 -69
  184. package/core/platform/manifest/custom-objects/function-file.mjs.map +0 -1
  185. package/core/platform/manifest/custom-objects/list-view.d.mts +0 -65
  186. package/core/platform/manifest/custom-objects/list-view.d.mts.map +0 -1
  187. package/core/platform/manifest/custom-objects/list-view.d.ts +0 -65
  188. package/core/platform/manifest/custom-objects/list-view.d.ts.map +0 -1
  189. package/core/platform/manifest/custom-objects/list-view.js +0 -33
  190. package/core/platform/manifest/custom-objects/list-view.js.map +0 -1
  191. package/core/platform/manifest/custom-objects/list-view.mjs +0 -30
  192. package/core/platform/manifest/custom-objects/list-view.mjs.map +0 -1
  193. package/core/platform/manifest/custom-objects/object-list-page.d.mts +0 -43
  194. package/core/platform/manifest/custom-objects/object-list-page.d.mts.map +0 -1
  195. package/core/platform/manifest/custom-objects/object-list-page.d.ts +0 -43
  196. package/core/platform/manifest/custom-objects/object-list-page.d.ts.map +0 -1
  197. package/core/platform/manifest/custom-objects/object-list-page.js +0 -54
  198. package/core/platform/manifest/custom-objects/object-list-page.js.map +0 -1
  199. package/core/platform/manifest/custom-objects/object-list-page.mjs +0 -50
  200. package/core/platform/manifest/custom-objects/object-list-page.mjs.map +0 -1
  201. package/core/platform/manifest/custom-objects/page-layout.d.mts +0 -142
  202. package/core/platform/manifest/custom-objects/page-layout.d.mts.map +0 -1
  203. package/core/platform/manifest/custom-objects/page-layout.d.ts +0 -142
  204. package/core/platform/manifest/custom-objects/page-layout.d.ts.map +0 -1
  205. package/core/platform/manifest/custom-objects/page-layout.js +0 -184
  206. package/core/platform/manifest/custom-objects/page-layout.js.map +0 -1
  207. package/core/platform/manifest/custom-objects/page-layout.mjs +0 -180
  208. package/core/platform/manifest/custom-objects/page-layout.mjs.map +0 -1
  209. package/core/platform/manifest/custom-objects/register.d.mts +0 -87
  210. package/core/platform/manifest/custom-objects/register.d.mts.map +0 -1
  211. package/core/platform/manifest/custom-objects/register.d.ts +0 -87
  212. package/core/platform/manifest/custom-objects/register.d.ts.map +0 -1
  213. package/core/platform/manifest/custom-objects/register.js +0 -395
  214. package/core/platform/manifest/custom-objects/register.js.map +0 -1
  215. package/core/platform/manifest/custom-objects/register.mjs +0 -391
  216. package/core/platform/manifest/custom-objects/register.mjs.map +0 -1
  217. package/core/platform/manifest/custom-objects/rule.d.mts +0 -113
  218. package/core/platform/manifest/custom-objects/rule.d.mts.map +0 -1
  219. package/core/platform/manifest/custom-objects/rule.d.ts +0 -113
  220. package/core/platform/manifest/custom-objects/rule.d.ts.map +0 -1
  221. package/core/platform/manifest/custom-objects/rule.js +0 -49
  222. package/core/platform/manifest/custom-objects/rule.js.map +0 -1
  223. package/core/platform/manifest/custom-objects/rule.mjs +0 -45
  224. package/core/platform/manifest/custom-objects/rule.mjs.map +0 -1
  225. package/core/platform/manifest/custom-objects/sdui-page.d.mts +0 -214
  226. package/core/platform/manifest/custom-objects/sdui-page.d.mts.map +0 -1
  227. package/core/platform/manifest/custom-objects/sdui-page.d.ts +0 -214
  228. package/core/platform/manifest/custom-objects/sdui-page.d.ts.map +0 -1
  229. package/core/platform/manifest/custom-objects/sdui-page.js +0 -194
  230. package/core/platform/manifest/custom-objects/sdui-page.js.map +0 -1
  231. package/core/platform/manifest/custom-objects/sdui-page.mjs +0 -182
  232. package/core/platform/manifest/custom-objects/sdui-page.mjs.map +0 -1
  233. package/core/platform/manifest/custom-objects/typed-condition.d.mts +0 -28
  234. package/core/platform/manifest/custom-objects/typed-condition.d.mts.map +0 -1
  235. package/core/platform/manifest/custom-objects/typed-condition.d.ts +0 -28
  236. package/core/platform/manifest/custom-objects/typed-condition.d.ts.map +0 -1
  237. package/core/platform/manifest/custom-objects/typed-condition.js +0 -434
  238. package/core/platform/manifest/custom-objects/typed-condition.js.map +0 -1
  239. package/core/platform/manifest/custom-objects/typed-condition.mjs +0 -431
  240. package/core/platform/manifest/custom-objects/typed-condition.mjs.map +0 -1
  241. package/core/platform/manifest/custom-objects/types.d.mts +0 -29
  242. package/core/platform/manifest/custom-objects/types.d.mts.map +0 -1
  243. package/core/platform/manifest/custom-objects/types.d.ts +0 -29
  244. package/core/platform/manifest/custom-objects/types.d.ts.map +0 -1
  245. package/core/platform/manifest/custom-objects/types.js +0 -3
  246. package/core/platform/manifest/custom-objects/types.js.map +0 -1
  247. package/core/platform/manifest/custom-objects/types.mjs +0 -2
  248. package/core/platform/manifest/custom-objects/types.mjs.map +0 -1
  249. package/core/platform/manifest/custom-objects/validation.d.mts +0 -44
  250. package/core/platform/manifest/custom-objects/validation.d.mts.map +0 -1
  251. package/core/platform/manifest/custom-objects/validation.d.ts +0 -44
  252. package/core/platform/manifest/custom-objects/validation.d.ts.map +0 -1
  253. package/core/platform/manifest/custom-objects/validation.js +0 -30
  254. package/core/platform/manifest/custom-objects/validation.js.map +0 -1
  255. package/core/platform/manifest/custom-objects/validation.mjs +0 -27
  256. package/core/platform/manifest/custom-objects/validation.mjs.map +0 -1
  257. package/core/platform/manifest/custom-objects/workflow.d.mts +0 -47
  258. package/core/platform/manifest/custom-objects/workflow.d.mts.map +0 -1
  259. package/core/platform/manifest/custom-objects/workflow.d.ts +0 -47
  260. package/core/platform/manifest/custom-objects/workflow.d.ts.map +0 -1
  261. package/core/platform/manifest/custom-objects/workflow.js +0 -38
  262. package/core/platform/manifest/custom-objects/workflow.js.map +0 -1
  263. package/core/platform/manifest/custom-objects/workflow.mjs +0 -34
  264. package/core/platform/manifest/custom-objects/workflow.mjs.map +0 -1
  265. package/core/platform/manifest/custom-objects.d.mts +0 -85
  266. package/core/platform/manifest/custom-objects.d.mts.map +0 -1
  267. package/core/platform/manifest/custom-objects.d.ts +0 -85
  268. package/core/platform/manifest/custom-objects.d.ts.map +0 -1
  269. package/core/platform/manifest/custom-objects.js +0 -84
  270. package/core/platform/manifest/custom-objects.js.map +0 -1
  271. package/core/platform/manifest/custom-objects.mjs +0 -55
  272. package/core/platform/manifest/custom-objects.mjs.map +0 -1
  273. package/examples/manifest/custom-object-creation-workflow/functions/intake-request-created.ts +0 -20
  274. package/examples/manifest/custom-object-creation-workflow/schema.ts +0 -29
  275. package/examples/manifest/dental-practice-management/schema.ts +0 -298
  276. package/examples/manifest/field-service-dispatch/schema.ts +0 -248
  277. package/examples/manifest/grant-program-management/schema.ts +0 -269
  278. package/examples/manifest/gym-membership-management/schema.ts +0 -266
  279. package/examples/manifest/procurement-approval-hub/functions/route-purchase-request.ts +0 -20
  280. package/examples/manifest/procurement-approval-hub/schema.ts +0 -256
  281. package/examples/manifest/simple-todo-app/schema.ts +0 -60
  282. package/examples/manifest/todo-app-without-object-list-view/schema.ts +0 -28
  283. package/src/core/platform/README.md +0 -20
  284. package/src/core/platform/custom-objects/category.ts +0 -294
  285. package/src/core/platform/custom-objects/definition.ts +0 -373
  286. package/src/core/platform/custom-objects/fields.ts +0 -653
  287. package/src/core/platform/custom-objects/function-runtime.ts +0 -76
  288. package/src/core/platform/custom-objects/lifecycle.ts +0 -557
  289. package/src/core/platform/custom-objects/manager.ts +0 -959
  290. package/src/core/platform/custom-objects/provisioning.ts +0 -672
  291. package/src/core/platform/custom-objects/rql.ts +0 -375
  292. package/src/core/platform/custom-objects/schema-manager.ts +0 -351
  293. package/src/core/platform/custom-objects/typed-rql.ts +0 -1273
  294. package/src/core/platform/custom-objects/types.ts +0 -753
  295. package/src/core/platform/custom-objects/validation.ts +0 -573
  296. package/src/core/platform/custom-objects.ts +0 -269
  297. package/src/core/platform/manifest/README.md +0 -26
  298. package/src/core/platform/manifest/custom-objects/action.ts +0 -87
  299. package/src/core/platform/manifest/custom-objects/conditions.ts +0 -762
  300. package/src/core/platform/manifest/custom-objects/existing.ts +0 -221
  301. package/src/core/platform/manifest/custom-objects/field-resolution.ts +0 -116
  302. package/src/core/platform/manifest/custom-objects/function-file.ts +0 -149
  303. package/src/core/platform/manifest/custom-objects/list-view.ts +0 -95
  304. package/src/core/platform/manifest/custom-objects/object-list-page.ts +0 -87
  305. package/src/core/platform/manifest/custom-objects/page-layout.ts +0 -380
  306. package/src/core/platform/manifest/custom-objects/register.ts +0 -555
  307. package/src/core/platform/manifest/custom-objects/rule.ts +0 -192
  308. package/src/core/platform/manifest/custom-objects/sdui-page.ts +0 -515
  309. package/src/core/platform/manifest/custom-objects/typed-condition.ts +0 -617
  310. package/src/core/platform/manifest/custom-objects/types.ts +0 -92
  311. package/src/core/platform/manifest/custom-objects/validation.ts +0 -70
  312. package/src/core/platform/manifest/custom-objects/workflow.ts +0 -71
  313. package/src/core/platform/manifest/custom-objects.ts +0 -203
  314. package/src/pebble-sdui-web-custom-apps-shim.d.ts +0 -3
@@ -1,43 +0,0 @@
1
- import { FunctionResponse, type FunctionContext, type SduiPageFunctionEvent } from "../../../../functions.mjs";
2
- import type { AnyCustomObjectDefinition } from "../../custom-objects/types.mjs";
3
- import type { ManifestCustomObjectTarget } from "./conditions.mjs";
4
- /**
5
- * Standard input shape for object-list page functions that only render their
6
- * initial SDUI page.
7
- */
8
- export type TypedObjectListPageInput = SduiPageFunctionEvent<{
9
- action: 'init';
10
- }>;
11
- /**
12
- * Standard output body for object-list page functions that return one rendered
13
- * SDUI spec.
14
- */
15
- export interface TypedObjectListPageOutput {
16
- /** JSON-serialized SDUI spec payload returned to the platform. */
17
- readonly spec: string;
18
- }
19
- /**
20
- * Builds the standard SDUI function response for a custom-object-backed object
21
- * list page.
22
- *
23
- * @param target - Typed custom-object definition or manifest registration that owns the object list page.
24
- * @returns Function response containing the rendered ObjectListView spec.
25
- * @typeParam TDefinition - Typed custom-object definition whose API name should back the list page.
26
- */
27
- export declare function createTypedObjectListPageResponse<TDefinition extends AnyCustomObjectDefinition>(target: ManifestCustomObjectTarget<TDefinition>): FunctionResponse<TypedObjectListPageOutput>;
28
- /**
29
- * Handles the standard custom-object object-list page event shape.
30
- *
31
- * The event and context are accepted so callers can keep an exported
32
- * `onRipplingEvent(event, context)` signature that matches backend IO-contract
33
- * derivation expectations, while delegating the repetitive response plumbing to
34
- * this helper.
35
- *
36
- * @param event - Incoming SDUI page event, expected to be the standard init-only object-list shape.
37
- * @param context - Function context supplied by the platform.
38
- * @param target - Typed custom-object definition or manifest registration that owns the object list page.
39
- * @returns Function response containing the rendered ObjectListView spec.
40
- * @typeParam TDefinition - Typed custom-object definition whose API name should back the list page.
41
- */
42
- export declare function handleTypedObjectListPageEvent<TDefinition extends AnyCustomObjectDefinition>(event: TypedObjectListPageInput, context: FunctionContext, target: ManifestCustomObjectTarget<TDefinition>): Promise<FunctionResponse<TypedObjectListPageOutput>>;
43
- //# sourceMappingURL=object-list-page.d.mts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"object-list-page.d.mts","sourceRoot":"","sources":["../../../../src/core/platform/manifest/custom-objects/object-list-page.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,KAAK,eAAe,EAAE,KAAK,qBAAqB,EAAE,kCAA8B;AAM3G,OAAO,KAAK,EAAE,yBAAyB,EAAE,uCAAmC;AAC5E,OAAO,KAAK,EAAE,0BAA0B,EAAE,yBAAqB;AAG/D;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,qBAAqB,CAAC;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAEjF;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,kEAAkE;IAClE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAcD;;;;;;;GAOG;AACH,wBAAgB,iCAAiC,CAAC,WAAW,SAAS,yBAAyB,EAC7F,MAAM,EAAE,0BAA0B,CAAC,WAAW,CAAC,GAC9C,gBAAgB,CAAC,yBAAyB,CAAC,CAc7C;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,8BAA8B,CAAC,WAAW,SAAS,yBAAyB,EAChG,KAAK,EAAE,wBAAwB,EAC/B,OAAO,EAAE,eAAe,EACxB,MAAM,EAAE,0BAA0B,CAAC,WAAW,CAAC,GAC9C,OAAO,CAAC,gBAAgB,CAAC,yBAAyB,CAAC,CAAC,CAItD"}
@@ -1,43 +0,0 @@
1
- import { FunctionResponse, type FunctionContext, type SduiPageFunctionEvent } from "../../../../functions.js";
2
- import type { AnyCustomObjectDefinition } from "../../custom-objects/types.js";
3
- import type { ManifestCustomObjectTarget } from "./conditions.js";
4
- /**
5
- * Standard input shape for object-list page functions that only render their
6
- * initial SDUI page.
7
- */
8
- export type TypedObjectListPageInput = SduiPageFunctionEvent<{
9
- action: 'init';
10
- }>;
11
- /**
12
- * Standard output body for object-list page functions that return one rendered
13
- * SDUI spec.
14
- */
15
- export interface TypedObjectListPageOutput {
16
- /** JSON-serialized SDUI spec payload returned to the platform. */
17
- readonly spec: string;
18
- }
19
- /**
20
- * Builds the standard SDUI function response for a custom-object-backed object
21
- * list page.
22
- *
23
- * @param target - Typed custom-object definition or manifest registration that owns the object list page.
24
- * @returns Function response containing the rendered ObjectListView spec.
25
- * @typeParam TDefinition - Typed custom-object definition whose API name should back the list page.
26
- */
27
- export declare function createTypedObjectListPageResponse<TDefinition extends AnyCustomObjectDefinition>(target: ManifestCustomObjectTarget<TDefinition>): FunctionResponse<TypedObjectListPageOutput>;
28
- /**
29
- * Handles the standard custom-object object-list page event shape.
30
- *
31
- * The event and context are accepted so callers can keep an exported
32
- * `onRipplingEvent(event, context)` signature that matches backend IO-contract
33
- * derivation expectations, while delegating the repetitive response plumbing to
34
- * this helper.
35
- *
36
- * @param event - Incoming SDUI page event, expected to be the standard init-only object-list shape.
37
- * @param context - Function context supplied by the platform.
38
- * @param target - Typed custom-object definition or manifest registration that owns the object list page.
39
- * @returns Function response containing the rendered ObjectListView spec.
40
- * @typeParam TDefinition - Typed custom-object definition whose API name should back the list page.
41
- */
42
- export declare function handleTypedObjectListPageEvent<TDefinition extends AnyCustomObjectDefinition>(event: TypedObjectListPageInput, context: FunctionContext, target: ManifestCustomObjectTarget<TDefinition>): Promise<FunctionResponse<TypedObjectListPageOutput>>;
43
- //# sourceMappingURL=object-list-page.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"object-list-page.d.ts","sourceRoot":"","sources":["../../../../src/core/platform/manifest/custom-objects/object-list-page.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,KAAK,eAAe,EAAE,KAAK,qBAAqB,EAAE,iCAA8B;AAM3G,OAAO,KAAK,EAAE,yBAAyB,EAAE,sCAAmC;AAC5E,OAAO,KAAK,EAAE,0BAA0B,EAAE,wBAAqB;AAG/D;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,qBAAqB,CAAC;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAEjF;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,kEAAkE;IAClE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAcD;;;;;;;GAOG;AACH,wBAAgB,iCAAiC,CAAC,WAAW,SAAS,yBAAyB,EAC7F,MAAM,EAAE,0BAA0B,CAAC,WAAW,CAAC,GAC9C,gBAAgB,CAAC,yBAAyB,CAAC,CAc7C;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,8BAA8B,CAAC,WAAW,SAAS,yBAAyB,EAChG,KAAK,EAAE,wBAAwB,EAC/B,OAAO,EAAE,eAAe,EACxB,MAAM,EAAE,0BAA0B,CAAC,WAAW,CAAC,GAC9C,OAAO,CAAC,gBAAgB,CAAC,yBAAyB,CAAC,CAAC,CAItD"}
@@ -1,54 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.createTypedObjectListPageResponse = createTypedObjectListPageResponse;
4
- exports.handleTypedObjectListPageEvent = handleTypedObjectListPageEvent;
5
- const custom_apps_1 = require("@rippling/pebble-sdui-web/catalogs/custom-apps");
6
- const functions_1 = require("../../../../functions.js");
7
- function isManifestRegistration(target) {
8
- return typeof target === 'object' && target != null && 'definition' in target && 'object' in target;
9
- }
10
- function resolveObjectApiName(target) {
11
- return isManifestRegistration(target) ? target.definition.apiName : target.apiName;
12
- }
13
- /**
14
- * Builds the standard SDUI function response for a custom-object-backed object
15
- * list page.
16
- *
17
- * @param target - Typed custom-object definition or manifest registration that owns the object list page.
18
- * @returns Function response containing the rendered ObjectListView spec.
19
- * @typeParam TDefinition - Typed custom-object definition whose API name should back the list page.
20
- */
21
- function createTypedObjectListPageResponse(target) {
22
- const spec = (0, custom_apps_1.render)({
23
- root: (0, custom_apps_1.ObjectListView)({
24
- props: { objectApiName: resolveObjectApiName(target) },
25
- }),
26
- state: {},
27
- });
28
- return new functions_1.FunctionResponse({
29
- body: { spec: JSON.stringify(spec) },
30
- statusCode: 200,
31
- headers: {},
32
- message: '',
33
- });
34
- }
35
- /**
36
- * Handles the standard custom-object object-list page event shape.
37
- *
38
- * The event and context are accepted so callers can keep an exported
39
- * `onRipplingEvent(event, context)` signature that matches backend IO-contract
40
- * derivation expectations, while delegating the repetitive response plumbing to
41
- * this helper.
42
- *
43
- * @param event - Incoming SDUI page event, expected to be the standard init-only object-list shape.
44
- * @param context - Function context supplied by the platform.
45
- * @param target - Typed custom-object definition or manifest registration that owns the object list page.
46
- * @returns Function response containing the rendered ObjectListView spec.
47
- * @typeParam TDefinition - Typed custom-object definition whose API name should back the list page.
48
- */
49
- async function handleTypedObjectListPageEvent(event, context, target) {
50
- void event;
51
- void context;
52
- return createTypedObjectListPageResponse(target);
53
- }
54
- //# sourceMappingURL=object-list-page.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"object-list-page.js","sourceRoot":"","sources":["../../../../src/core/platform/manifest/custom-objects/object-list-page.ts"],"names":[],"mappings":";;AA8CA,8EAgBC;AAgBD,wEAQC;AAtFD,gFAAwF;AACxF,wDAA2G;AAyB3G,SAAS,sBAAsB,CAC7B,MAA+C;IAE/C,OAAO,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,IAAI,IAAI,IAAI,YAAY,IAAI,MAAM,IAAI,QAAQ,IAAI,MAAM,CAAC;AACtG,CAAC;AAED,SAAS,oBAAoB,CAC3B,MAA+C;IAE/C,OAAO,sBAAsB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC;AACrF,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,iCAAiC,CAC/C,MAA+C;IAE/C,MAAM,IAAI,GAAG,IAAA,oBAAM,EAAC;QAClB,IAAI,EAAE,IAAA,4BAAc,EAAC;YACnB,KAAK,EAAE,EAAE,aAAa,EAAE,oBAAoB,CAAC,MAAM,CAAC,EAAE;SACvD,CAAC;QACF,KAAK,EAAE,EAAE;KACV,CAAC,CAAC;IAEH,OAAO,IAAI,4BAAgB,CAA4B;QACrD,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE;QACpC,UAAU,EAAE,GAAG;QACf,OAAO,EAAE,EAAE;QACX,OAAO,EAAE,EAAE;KACZ,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,8BAA8B,CAClD,KAA+B,EAC/B,OAAwB,EACxB,MAA+C;IAE/C,KAAK,KAAK,CAAC;IACX,KAAK,OAAO,CAAC;IACb,OAAO,iCAAiC,CAAC,MAAM,CAAC,CAAC;AACnD,CAAC"}
@@ -1,50 +0,0 @@
1
- import { ObjectListView, render } from '@rippling/pebble-sdui-web/catalogs/custom-apps';
2
- import { FunctionResponse } from "../../../../functions.mjs";
3
- function isManifestRegistration(target) {
4
- return typeof target === 'object' && target != null && 'definition' in target && 'object' in target;
5
- }
6
- function resolveObjectApiName(target) {
7
- return isManifestRegistration(target) ? target.definition.apiName : target.apiName;
8
- }
9
- /**
10
- * Builds the standard SDUI function response for a custom-object-backed object
11
- * list page.
12
- *
13
- * @param target - Typed custom-object definition or manifest registration that owns the object list page.
14
- * @returns Function response containing the rendered ObjectListView spec.
15
- * @typeParam TDefinition - Typed custom-object definition whose API name should back the list page.
16
- */
17
- export function createTypedObjectListPageResponse(target) {
18
- const spec = render({
19
- root: ObjectListView({
20
- props: { objectApiName: resolveObjectApiName(target) },
21
- }),
22
- state: {},
23
- });
24
- return new FunctionResponse({
25
- body: { spec: JSON.stringify(spec) },
26
- statusCode: 200,
27
- headers: {},
28
- message: '',
29
- });
30
- }
31
- /**
32
- * Handles the standard custom-object object-list page event shape.
33
- *
34
- * The event and context are accepted so callers can keep an exported
35
- * `onRipplingEvent(event, context)` signature that matches backend IO-contract
36
- * derivation expectations, while delegating the repetitive response plumbing to
37
- * this helper.
38
- *
39
- * @param event - Incoming SDUI page event, expected to be the standard init-only object-list shape.
40
- * @param context - Function context supplied by the platform.
41
- * @param target - Typed custom-object definition or manifest registration that owns the object list page.
42
- * @returns Function response containing the rendered ObjectListView spec.
43
- * @typeParam TDefinition - Typed custom-object definition whose API name should back the list page.
44
- */
45
- export async function handleTypedObjectListPageEvent(event, context, target) {
46
- void event;
47
- void context;
48
- return createTypedObjectListPageResponse(target);
49
- }
50
- //# sourceMappingURL=object-list-page.mjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"object-list-page.mjs","sourceRoot":"","sources":["../../../../src/core/platform/manifest/custom-objects/object-list-page.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,gDAAgD,CAAC;AACxF,OAAO,EAAE,gBAAgB,EAAoD,kCAA8B;AAyB3G,SAAS,sBAAsB,CAC7B,MAA+C;IAE/C,OAAO,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,IAAI,IAAI,IAAI,YAAY,IAAI,MAAM,IAAI,QAAQ,IAAI,MAAM,CAAC;AACtG,CAAC;AAED,SAAS,oBAAoB,CAC3B,MAA+C;IAE/C,OAAO,sBAAsB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC;AACrF,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,iCAAiC,CAC/C,MAA+C;IAE/C,MAAM,IAAI,GAAG,MAAM,CAAC;QAClB,IAAI,EAAE,cAAc,CAAC;YACnB,KAAK,EAAE,EAAE,aAAa,EAAE,oBAAoB,CAAC,MAAM,CAAC,EAAE;SACvD,CAAC;QACF,KAAK,EAAE,EAAE;KACV,CAAC,CAAC;IAEH,OAAO,IAAI,gBAAgB,CAA4B;QACrD,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE;QACpC,UAAU,EAAE,GAAG;QACf,OAAO,EAAE,EAAE;QACX,OAAO,EAAE,EAAE;KACZ,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,8BAA8B,CAClD,KAA+B,EAC/B,OAAwB,EACxB,MAA+C;IAE/C,KAAK,KAAK,CAAC;IACX,KAAK,OAAO,CAAC;IACb,OAAO,iCAAiC,CAAC,MAAM,CAAC,CAAC;AACnD,CAAC"}
@@ -1,142 +0,0 @@
1
- import { CustomObjectPageLayout, type CustomObjectFieldSection, type CustomObjectPageLayoutProps, type CustomTab, type FieldsSection, type PageLayoutSection, type SectionField, type SystemSectionEdit, type SystemTabEdit, type TabEdits, type TabWithSections } from "../../../../lib/manifest.mjs";
2
- import type { AnyCustomObjectDefinition } from "../../custom-objects/types.mjs";
3
- import type { ManifestRegistration } from "./types.mjs";
4
- import type { TypedManifestFieldInput } from "./field-resolution.mjs";
5
- /**
6
- * Field object accepted inside typed page-layout field arrays.
7
- *
8
- * @typeParam TDefinition - Object definition whose valid field inputs should be enforced.
9
- */
10
- export interface TypedSectionField<TDefinition extends AnyCustomObjectDefinition> extends Omit<SectionField, 'field'> {
11
- /** Field to display, expressed as a typed field-name string or manifest field reference. */
12
- readonly field: TypedManifestFieldInput<TDefinition>;
13
- }
14
- /**
15
- * Field-array entry accepted by typed page-layout helpers.
16
- *
17
- * @typeParam TDefinition - Object definition whose valid field inputs should be enforced.
18
- */
19
- export type TypedSectionFieldInput<TDefinition extends AnyCustomObjectDefinition> = TypedManifestFieldInput<TDefinition> | TypedSectionField<TDefinition>;
20
- /**
21
- * `fields_section` shape accepted by the typed page-layout helper.
22
- *
23
- * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
24
- */
25
- export interface TypedFieldsSection<TDefinition extends AnyCustomObjectDefinition> extends Omit<FieldsSection, 'fields'> {
26
- /** Fields to display in this section, expressed using typed field-name strings or manifest field refs. */
27
- readonly fields: readonly TypedSectionFieldInput<TDefinition>[];
28
- }
29
- /**
30
- * Page-layout section shape accepted by the typed page-layout helper.
31
- *
32
- * Only `fields_section.fields` is specialized in this first pass; other section
33
- * variants continue to use the low-level manifest shapes unchanged.
34
- *
35
- * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
36
- */
37
- export type TypedPageLayoutSection<TDefinition extends AnyCustomObjectDefinition> = TypedFieldsSection<TDefinition> | Exclude<PageLayoutSection, FieldsSection>;
38
- /**
39
- * Tab-with-sections shape accepted by the typed page-layout helper.
40
- *
41
- * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
42
- */
43
- export interface TypedTabWithSections<TDefinition extends AnyCustomObjectDefinition> extends Omit<TabWithSections, 'sections'> {
44
- /** Sections inside this tab. */
45
- readonly sections: readonly TypedPageLayoutSection<TDefinition>[];
46
- }
47
- /**
48
- * Tab shape accepted by the typed page-layout helper.
49
- *
50
- * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
51
- */
52
- export type TypedPageLayoutTab<TDefinition extends AnyCustomObjectDefinition> = TypedTabWithSections<TDefinition> | CustomTab;
53
- /**
54
- * System-section edit shape accepted by the typed page-layout helper.
55
- *
56
- * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
57
- */
58
- export interface TypedSystemSectionEdit<TDefinition extends AnyCustomObjectDefinition> extends Omit<SystemSectionEdit, 'newFields'> {
59
- /** Fields to append to the target system section. */
60
- readonly newFields?: readonly TypedSectionFieldInput<TDefinition>[];
61
- }
62
- /**
63
- * System-tab edit shape accepted by the typed page-layout helper.
64
- *
65
- * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
66
- */
67
- export interface TypedSystemTabEdit<TDefinition extends AnyCustomObjectDefinition> extends Omit<SystemTabEdit, 'newSections' | 'systemSectionEdits'> {
68
- /** New sections to add to the target system tab. */
69
- readonly newSections?: readonly TypedPageLayoutSection<TDefinition>[];
70
- /** Edits to built-in sections inside the target system tab. */
71
- readonly systemSectionEdits?: Readonly<Record<string, TypedSystemSectionEdit<TDefinition>>>;
72
- }
73
- /**
74
- * `tabEdits` shape accepted by the typed page-layout helper.
75
- *
76
- * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
77
- */
78
- export interface TypedTabEdits<TDefinition extends AnyCustomObjectDefinition> extends Omit<TabEdits, 'newTabs' | 'systemTabEdits'> {
79
- /** New tabs to add to the layout. */
80
- readonly newTabs?: readonly TypedPageLayoutTab<TDefinition>[];
81
- /** Edits to existing system tabs. */
82
- readonly systemTabEdits?: Readonly<Record<string, TypedSystemTabEdit<TDefinition>>>;
83
- }
84
- /**
85
- * Initialization properties for {@link defineTypedPageLayout}.
86
- *
87
- * This first pass focuses on the common field-array surfaces:
88
- * - `tabEdits.newTabs[].sections[].fields`
89
- * - `tabEdits.systemTabEdits.*.newSections[].fields`
90
- * - `tabEdits.systemTabEdits.*.systemSectionEdits.*.newFields`
91
- *
92
- * Other page-layout configuration remains identical to the low-level manifest API.
93
- *
94
- * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
95
- */
96
- export interface TypedCustomObjectPageLayoutProps<TDefinition extends AnyCustomObjectDefinition> extends Omit<CustomObjectPageLayoutProps, 'tabEdits'> {
97
- /** Typed page-layout tab edits. */
98
- readonly tabEdits?: TypedTabEdits<TDefinition>;
99
- }
100
- /**
101
- * Initialization properties for {@link defineBasicTypedPageLayout}.
102
- *
103
- * This is the typed equivalent of {@link CustomObjectPageLayout.basic}: a
104
- * single-tab, single-section layout for the common case where callers do not
105
- * need to customize tab structure.
106
- *
107
- * @typeParam TDefinition - Object definition whose valid field inputs should be enforced.
108
- */
109
- export interface TypedBasicPageLayoutProps<TDefinition extends AnyCustomObjectDefinition> {
110
- /** Optional existing manifest section that should own every listed field. */
111
- readonly section?: CustomObjectFieldSection;
112
- /** Optional fields to place in the generated General section. */
113
- readonly fields?: readonly TypedManifestFieldInput<TDefinition>[];
114
- }
115
- /**
116
- * Registers a typed page layout for a manifest custom object.
117
- *
118
- * This helper sits on top of the low-level {@link CustomObjectPageLayout}
119
- * manifest class. It preserves the runtime behavior of that class while adding
120
- * object-specific string-literal IntelliSense for the most common field-array
121
- * authoring surfaces.
122
- *
123
- * @param registration - Manifest registration produced from the typed object definition.
124
- * @param props - Typed page-layout properties to materialize into the manifest class.
125
- * @returns Low-level manifest page-layout instance with typed field arrays resolved.
126
- * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
127
- */
128
- export declare function defineTypedPageLayout<TDefinition extends AnyCustomObjectDefinition>(registration: ManifestRegistration<TDefinition>, props: TypedCustomObjectPageLayoutProps<TDefinition>): CustomObjectPageLayout;
129
- /**
130
- * Registers the common single-tab "basic" layout using typed field-name strings.
131
- *
132
- * Use this helper when the low-level {@link CustomObjectPageLayout.basic}
133
- * behavior is sufficient and you want the shortest typed path from schema to a
134
- * working page layout.
135
- *
136
- * @param registration - Manifest registration produced from the typed object definition.
137
- * @param props - Optional basic-layout properties.
138
- * @returns Low-level manifest page-layout instance created through `CustomObjectPageLayout.basic(...)`.
139
- * @typeParam TDefinition - Object definition whose valid field inputs should be enforced.
140
- */
141
- export declare function defineBasicTypedPageLayout<TDefinition extends AnyCustomObjectDefinition>(registration: ManifestRegistration<TDefinition>, props?: TypedBasicPageLayoutProps<TDefinition>): CustomObjectPageLayout;
142
- //# sourceMappingURL=page-layout.d.mts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"page-layout.d.mts","sourceRoot":"","sources":["../../../../src/core/platform/manifest/custom-objects/page-layout.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,sBAAsB,EACtB,KAAK,wBAAwB,EAC7B,KAAK,2BAA2B,EAChC,KAAK,SAAS,EACd,KAAK,aAAa,EAClB,KAAK,iBAAiB,EAEtB,KAAK,YAAY,EAEjB,KAAK,iBAAiB,EACtB,KAAK,aAAa,EAClB,KAAK,QAAQ,EACb,KAAK,eAAe,EACrB,qCAAiC;AAClC,OAAO,KAAK,EAAE,yBAAyB,EAAE,uCAAmC;AAC5E,OAAO,KAAK,EAAE,oBAAoB,EAAE,oBAAgB;AACpD,OAAO,KAAK,EAAE,uBAAuB,EAAE,+BAA2B;AAGlE;;;;GAIG;AACH,MAAM,WAAW,iBAAiB,CAAC,WAAW,SAAS,yBAAyB,CAC9E,SAAQ,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC;IACnC,4FAA4F;IAC5F,QAAQ,CAAC,KAAK,EAAE,uBAAuB,CAAC,WAAW,CAAC,CAAC;CACtD;AAED;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,CAAC,WAAW,SAAS,yBAAyB,IAC5E,uBAAuB,CAAC,WAAW,CAAC,GACpC,iBAAiB,CAAC,WAAW,CAAC,CAAC;AAEnC;;;;GAIG;AACH,MAAM,WAAW,kBAAkB,CAAC,WAAW,SAAS,yBAAyB,CAC/E,SAAQ,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC;IACrC,0GAA0G;IAC1G,QAAQ,CAAC,MAAM,EAAE,SAAS,sBAAsB,CAAC,WAAW,CAAC,EAAE,CAAC;CACjE;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,sBAAsB,CAAC,WAAW,SAAS,yBAAyB,IAC5E,kBAAkB,CAAC,WAAW,CAAC,GAC/B,OAAO,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;AAE9C;;;;GAIG;AACH,MAAM,WAAW,oBAAoB,CAAC,WAAW,SAAS,yBAAyB,CACjF,SAAQ,IAAI,CAAC,eAAe,EAAE,UAAU,CAAC;IACzC,gCAAgC;IAChC,QAAQ,CAAC,QAAQ,EAAE,SAAS,sBAAsB,CAAC,WAAW,CAAC,EAAE,CAAC;CACnE;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,CAAC,WAAW,SAAS,yBAAyB,IACxE,oBAAoB,CAAC,WAAW,CAAC,GACjC,SAAS,CAAC;AAEd;;;;GAIG;AACH,MAAM,WAAW,sBAAsB,CAAC,WAAW,SAAS,yBAAyB,CACnF,SAAQ,IAAI,CAAC,iBAAiB,EAAE,WAAW,CAAC;IAC5C,qDAAqD;IACrD,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,sBAAsB,CAAC,WAAW,CAAC,EAAE,CAAC;CACrE;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB,CAAC,WAAW,SAAS,yBAAyB,CAC/E,SAAQ,IAAI,CAAC,aAAa,EAAE,aAAa,GAAG,oBAAoB,CAAC;IACjE,oDAAoD;IACpD,QAAQ,CAAC,WAAW,CAAC,EAAE,SAAS,sBAAsB,CAAC,WAAW,CAAC,EAAE,CAAC;IACtE,+DAA+D;IAC/D,QAAQ,CAAC,kBAAkB,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;CAC7F;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa,CAAC,WAAW,SAAS,yBAAyB,CAC1E,SAAQ,IAAI,CAAC,QAAQ,EAAE,SAAS,GAAG,gBAAgB,CAAC;IACpD,qCAAqC;IACrC,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,kBAAkB,CAAC,WAAW,CAAC,EAAE,CAAC;IAC9D,qCAAqC;IACrC,QAAQ,CAAC,cAAc,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;CACrF;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,gCAAgC,CAAC,WAAW,SAAS,yBAAyB,CAC7F,SAAQ,IAAI,CAAC,2BAA2B,EAAE,UAAU,CAAC;IACrD,mCAAmC;IACnC,QAAQ,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC;CAChD;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,yBAAyB,CAAC,WAAW,SAAS,yBAAyB;IACtF,6EAA6E;IAC7E,QAAQ,CAAC,OAAO,CAAC,EAAE,wBAAwB,CAAC;IAC5C,iEAAiE;IACjE,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,uBAAuB,CAAC,WAAW,CAAC,EAAE,CAAC;CACnE;AAgLD;;;;;;;;;;;;GAYG;AACH,wBAAgB,qBAAqB,CAAC,WAAW,SAAS,yBAAyB,EACjF,YAAY,EAAE,oBAAoB,CAAC,WAAW,CAAC,EAC/C,KAAK,EAAE,gCAAgC,CAAC,WAAW,CAAC,GACnD,sBAAsB,CAWxB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,0BAA0B,CAAC,WAAW,SAAS,yBAAyB,EACtF,YAAY,EAAE,oBAAoB,CAAC,WAAW,CAAC,EAC/C,KAAK,GAAE,yBAAyB,CAAC,WAAW,CAAM,GACjD,sBAAsB,CAOxB"}
@@ -1,142 +0,0 @@
1
- import { CustomObjectPageLayout, type CustomObjectFieldSection, type CustomObjectPageLayoutProps, type CustomTab, type FieldsSection, type PageLayoutSection, type SectionField, type SystemSectionEdit, type SystemTabEdit, type TabEdits, type TabWithSections } from "../../../../lib/manifest.js";
2
- import type { AnyCustomObjectDefinition } from "../../custom-objects/types.js";
3
- import type { ManifestRegistration } from "./types.js";
4
- import type { TypedManifestFieldInput } from "./field-resolution.js";
5
- /**
6
- * Field object accepted inside typed page-layout field arrays.
7
- *
8
- * @typeParam TDefinition - Object definition whose valid field inputs should be enforced.
9
- */
10
- export interface TypedSectionField<TDefinition extends AnyCustomObjectDefinition> extends Omit<SectionField, 'field'> {
11
- /** Field to display, expressed as a typed field-name string or manifest field reference. */
12
- readonly field: TypedManifestFieldInput<TDefinition>;
13
- }
14
- /**
15
- * Field-array entry accepted by typed page-layout helpers.
16
- *
17
- * @typeParam TDefinition - Object definition whose valid field inputs should be enforced.
18
- */
19
- export type TypedSectionFieldInput<TDefinition extends AnyCustomObjectDefinition> = TypedManifestFieldInput<TDefinition> | TypedSectionField<TDefinition>;
20
- /**
21
- * `fields_section` shape accepted by the typed page-layout helper.
22
- *
23
- * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
24
- */
25
- export interface TypedFieldsSection<TDefinition extends AnyCustomObjectDefinition> extends Omit<FieldsSection, 'fields'> {
26
- /** Fields to display in this section, expressed using typed field-name strings or manifest field refs. */
27
- readonly fields: readonly TypedSectionFieldInput<TDefinition>[];
28
- }
29
- /**
30
- * Page-layout section shape accepted by the typed page-layout helper.
31
- *
32
- * Only `fields_section.fields` is specialized in this first pass; other section
33
- * variants continue to use the low-level manifest shapes unchanged.
34
- *
35
- * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
36
- */
37
- export type TypedPageLayoutSection<TDefinition extends AnyCustomObjectDefinition> = TypedFieldsSection<TDefinition> | Exclude<PageLayoutSection, FieldsSection>;
38
- /**
39
- * Tab-with-sections shape accepted by the typed page-layout helper.
40
- *
41
- * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
42
- */
43
- export interface TypedTabWithSections<TDefinition extends AnyCustomObjectDefinition> extends Omit<TabWithSections, 'sections'> {
44
- /** Sections inside this tab. */
45
- readonly sections: readonly TypedPageLayoutSection<TDefinition>[];
46
- }
47
- /**
48
- * Tab shape accepted by the typed page-layout helper.
49
- *
50
- * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
51
- */
52
- export type TypedPageLayoutTab<TDefinition extends AnyCustomObjectDefinition> = TypedTabWithSections<TDefinition> | CustomTab;
53
- /**
54
- * System-section edit shape accepted by the typed page-layout helper.
55
- *
56
- * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
57
- */
58
- export interface TypedSystemSectionEdit<TDefinition extends AnyCustomObjectDefinition> extends Omit<SystemSectionEdit, 'newFields'> {
59
- /** Fields to append to the target system section. */
60
- readonly newFields?: readonly TypedSectionFieldInput<TDefinition>[];
61
- }
62
- /**
63
- * System-tab edit shape accepted by the typed page-layout helper.
64
- *
65
- * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
66
- */
67
- export interface TypedSystemTabEdit<TDefinition extends AnyCustomObjectDefinition> extends Omit<SystemTabEdit, 'newSections' | 'systemSectionEdits'> {
68
- /** New sections to add to the target system tab. */
69
- readonly newSections?: readonly TypedPageLayoutSection<TDefinition>[];
70
- /** Edits to built-in sections inside the target system tab. */
71
- readonly systemSectionEdits?: Readonly<Record<string, TypedSystemSectionEdit<TDefinition>>>;
72
- }
73
- /**
74
- * `tabEdits` shape accepted by the typed page-layout helper.
75
- *
76
- * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
77
- */
78
- export interface TypedTabEdits<TDefinition extends AnyCustomObjectDefinition> extends Omit<TabEdits, 'newTabs' | 'systemTabEdits'> {
79
- /** New tabs to add to the layout. */
80
- readonly newTabs?: readonly TypedPageLayoutTab<TDefinition>[];
81
- /** Edits to existing system tabs. */
82
- readonly systemTabEdits?: Readonly<Record<string, TypedSystemTabEdit<TDefinition>>>;
83
- }
84
- /**
85
- * Initialization properties for {@link defineTypedPageLayout}.
86
- *
87
- * This first pass focuses on the common field-array surfaces:
88
- * - `tabEdits.newTabs[].sections[].fields`
89
- * - `tabEdits.systemTabEdits.*.newSections[].fields`
90
- * - `tabEdits.systemTabEdits.*.systemSectionEdits.*.newFields`
91
- *
92
- * Other page-layout configuration remains identical to the low-level manifest API.
93
- *
94
- * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
95
- */
96
- export interface TypedCustomObjectPageLayoutProps<TDefinition extends AnyCustomObjectDefinition> extends Omit<CustomObjectPageLayoutProps, 'tabEdits'> {
97
- /** Typed page-layout tab edits. */
98
- readonly tabEdits?: TypedTabEdits<TDefinition>;
99
- }
100
- /**
101
- * Initialization properties for {@link defineBasicTypedPageLayout}.
102
- *
103
- * This is the typed equivalent of {@link CustomObjectPageLayout.basic}: a
104
- * single-tab, single-section layout for the common case where callers do not
105
- * need to customize tab structure.
106
- *
107
- * @typeParam TDefinition - Object definition whose valid field inputs should be enforced.
108
- */
109
- export interface TypedBasicPageLayoutProps<TDefinition extends AnyCustomObjectDefinition> {
110
- /** Optional existing manifest section that should own every listed field. */
111
- readonly section?: CustomObjectFieldSection;
112
- /** Optional fields to place in the generated General section. */
113
- readonly fields?: readonly TypedManifestFieldInput<TDefinition>[];
114
- }
115
- /**
116
- * Registers a typed page layout for a manifest custom object.
117
- *
118
- * This helper sits on top of the low-level {@link CustomObjectPageLayout}
119
- * manifest class. It preserves the runtime behavior of that class while adding
120
- * object-specific string-literal IntelliSense for the most common field-array
121
- * authoring surfaces.
122
- *
123
- * @param registration - Manifest registration produced from the typed object definition.
124
- * @param props - Typed page-layout properties to materialize into the manifest class.
125
- * @returns Low-level manifest page-layout instance with typed field arrays resolved.
126
- * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
127
- */
128
- export declare function defineTypedPageLayout<TDefinition extends AnyCustomObjectDefinition>(registration: ManifestRegistration<TDefinition>, props: TypedCustomObjectPageLayoutProps<TDefinition>): CustomObjectPageLayout;
129
- /**
130
- * Registers the common single-tab "basic" layout using typed field-name strings.
131
- *
132
- * Use this helper when the low-level {@link CustomObjectPageLayout.basic}
133
- * behavior is sufficient and you want the shortest typed path from schema to a
134
- * working page layout.
135
- *
136
- * @param registration - Manifest registration produced from the typed object definition.
137
- * @param props - Optional basic-layout properties.
138
- * @returns Low-level manifest page-layout instance created through `CustomObjectPageLayout.basic(...)`.
139
- * @typeParam TDefinition - Object definition whose valid field inputs should be enforced.
140
- */
141
- export declare function defineBasicTypedPageLayout<TDefinition extends AnyCustomObjectDefinition>(registration: ManifestRegistration<TDefinition>, props?: TypedBasicPageLayoutProps<TDefinition>): CustomObjectPageLayout;
142
- //# sourceMappingURL=page-layout.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"page-layout.d.ts","sourceRoot":"","sources":["../../../../src/core/platform/manifest/custom-objects/page-layout.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,sBAAsB,EACtB,KAAK,wBAAwB,EAC7B,KAAK,2BAA2B,EAChC,KAAK,SAAS,EACd,KAAK,aAAa,EAClB,KAAK,iBAAiB,EAEtB,KAAK,YAAY,EAEjB,KAAK,iBAAiB,EACtB,KAAK,aAAa,EAClB,KAAK,QAAQ,EACb,KAAK,eAAe,EACrB,oCAAiC;AAClC,OAAO,KAAK,EAAE,yBAAyB,EAAE,sCAAmC;AAC5E,OAAO,KAAK,EAAE,oBAAoB,EAAE,mBAAgB;AACpD,OAAO,KAAK,EAAE,uBAAuB,EAAE,8BAA2B;AAGlE;;;;GAIG;AACH,MAAM,WAAW,iBAAiB,CAAC,WAAW,SAAS,yBAAyB,CAC9E,SAAQ,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC;IACnC,4FAA4F;IAC5F,QAAQ,CAAC,KAAK,EAAE,uBAAuB,CAAC,WAAW,CAAC,CAAC;CACtD;AAED;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,CAAC,WAAW,SAAS,yBAAyB,IAC5E,uBAAuB,CAAC,WAAW,CAAC,GACpC,iBAAiB,CAAC,WAAW,CAAC,CAAC;AAEnC;;;;GAIG;AACH,MAAM,WAAW,kBAAkB,CAAC,WAAW,SAAS,yBAAyB,CAC/E,SAAQ,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC;IACrC,0GAA0G;IAC1G,QAAQ,CAAC,MAAM,EAAE,SAAS,sBAAsB,CAAC,WAAW,CAAC,EAAE,CAAC;CACjE;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,sBAAsB,CAAC,WAAW,SAAS,yBAAyB,IAC5E,kBAAkB,CAAC,WAAW,CAAC,GAC/B,OAAO,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;AAE9C;;;;GAIG;AACH,MAAM,WAAW,oBAAoB,CAAC,WAAW,SAAS,yBAAyB,CACjF,SAAQ,IAAI,CAAC,eAAe,EAAE,UAAU,CAAC;IACzC,gCAAgC;IAChC,QAAQ,CAAC,QAAQ,EAAE,SAAS,sBAAsB,CAAC,WAAW,CAAC,EAAE,CAAC;CACnE;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,CAAC,WAAW,SAAS,yBAAyB,IACxE,oBAAoB,CAAC,WAAW,CAAC,GACjC,SAAS,CAAC;AAEd;;;;GAIG;AACH,MAAM,WAAW,sBAAsB,CAAC,WAAW,SAAS,yBAAyB,CACnF,SAAQ,IAAI,CAAC,iBAAiB,EAAE,WAAW,CAAC;IAC5C,qDAAqD;IACrD,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,sBAAsB,CAAC,WAAW,CAAC,EAAE,CAAC;CACrE;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB,CAAC,WAAW,SAAS,yBAAyB,CAC/E,SAAQ,IAAI,CAAC,aAAa,EAAE,aAAa,GAAG,oBAAoB,CAAC;IACjE,oDAAoD;IACpD,QAAQ,CAAC,WAAW,CAAC,EAAE,SAAS,sBAAsB,CAAC,WAAW,CAAC,EAAE,CAAC;IACtE,+DAA+D;IAC/D,QAAQ,CAAC,kBAAkB,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;CAC7F;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa,CAAC,WAAW,SAAS,yBAAyB,CAC1E,SAAQ,IAAI,CAAC,QAAQ,EAAE,SAAS,GAAG,gBAAgB,CAAC;IACpD,qCAAqC;IACrC,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,kBAAkB,CAAC,WAAW,CAAC,EAAE,CAAC;IAC9D,qCAAqC;IACrC,QAAQ,CAAC,cAAc,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;CACrF;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,gCAAgC,CAAC,WAAW,SAAS,yBAAyB,CAC7F,SAAQ,IAAI,CAAC,2BAA2B,EAAE,UAAU,CAAC;IACrD,mCAAmC;IACnC,QAAQ,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC;CAChD;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,yBAAyB,CAAC,WAAW,SAAS,yBAAyB;IACtF,6EAA6E;IAC7E,QAAQ,CAAC,OAAO,CAAC,EAAE,wBAAwB,CAAC;IAC5C,iEAAiE;IACjE,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,uBAAuB,CAAC,WAAW,CAAC,EAAE,CAAC;CACnE;AAgLD;;;;;;;;;;;;GAYG;AACH,wBAAgB,qBAAqB,CAAC,WAAW,SAAS,yBAAyB,EACjF,YAAY,EAAE,oBAAoB,CAAC,WAAW,CAAC,EAC/C,KAAK,EAAE,gCAAgC,CAAC,WAAW,CAAC,GACnD,sBAAsB,CAWxB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,0BAA0B,CAAC,WAAW,SAAS,yBAAyB,EACtF,YAAY,EAAE,oBAAoB,CAAC,WAAW,CAAC,EAC/C,KAAK,GAAE,yBAAyB,CAAC,WAAW,CAAM,GACjD,sBAAsB,CAOxB"}