@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,302 +0,0 @@
1
- import type { CustomObjectFieldDerivedAggregatedField, CustomObjectFieldFormulaAttrMetas, CustomObjectFieldRqlDefinition, CustomObjectFieldSection as RestCustomObjectFieldSection } from "../../../resources/custom-objects/fields.mjs";
2
- import type { AnyCustomObjectDefinition, BooleanFieldDefinition, CurrencyFieldDefinition, CustomObjectIdentity, DateFieldDefinition, DatetimeFieldDefinition, EmailFieldDefinition, FileFieldDefinition, FormulaFieldDefinition, LongTextFieldDefinition, LookupFieldDefinition, LookupTarget, NativeModelTarget, NumberFieldDefinition, ParentChildFieldDefinition, PercentageFieldDefinition, PhoneFieldDefinition, RadioFieldDefinition, SectionDefinition, SelectFieldDefinition, TextFieldDefinition, TimeFieldDefinition, UrlFieldDefinition } from "./types.mjs";
3
- /**
4
- * Internal helper for field factories that expose `required` and `section`.
5
- *
6
- * @typeParam TRequired - Literal boolean carried through to derived input types.
7
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
8
- */
9
- interface BooleanLikeProps<TRequired extends boolean, TSectionKey extends string | undefined> {
10
- readonly required?: TRequired;
11
- readonly section?: TSectionKey;
12
- }
13
- /**
14
- * Internal helper for choice-based field factories.
15
- *
16
- * @typeParam TRequired - Literal boolean carried through to derived input types.
17
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
18
- */
19
- interface ChoiceProps<TRequired extends boolean, TSectionKey extends string | undefined> extends BooleanLikeProps<TRequired, TSectionKey> {
20
- readonly options: readonly string[];
21
- }
22
- /**
23
- * Internal helper for numeric field factories that support decimal-place metadata.
24
- *
25
- * @typeParam TRequired - Literal boolean carried through to derived input types.
26
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
27
- */
28
- interface NumericProps<TRequired extends boolean, TSectionKey extends string | undefined> extends BooleanLikeProps<TRequired, TSectionKey> {
29
- readonly decimalPlaces?: number;
30
- }
31
- /**
32
- * Internal presentation properties shared by every field factory.
33
- *
34
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
35
- */
36
- interface CommonFieldProps<TSectionKey extends string | undefined> {
37
- readonly displayName: string;
38
- readonly description: string;
39
- readonly section?: TSectionKey;
40
- readonly enableHistory?: boolean;
41
- readonly formulaAttributeMetas?: CustomObjectFieldFormulaAttrMetas;
42
- readonly derivedAggregatedField?: CustomObjectFieldDerivedAggregatedField;
43
- readonly rqlDefinition?: CustomObjectFieldRqlDefinition;
44
- readonly restSection?: RestCustomObjectFieldSection;
45
- }
46
- /**
47
- * Declares a native Rippling model target for lookup fields.
48
- *
49
- * @param apiName - Native model API name, for example `'Employee'`.
50
- * @returns Immutable native-model target descriptor for lookup fields.
51
- * @typeParam TApiName - Native model api name, for example `'Employee'`.
52
- */
53
- export declare function nativeModel<TApiName extends string>(apiName: TApiName): NativeModelTarget<TApiName>;
54
- /**
55
- * Defines a single-line text field.
56
- *
57
- * @param props - Text-field metadata and presentation properties.
58
- * @returns Immutable text field definition.
59
- * @typeParam TRequired - Whether the field is required during record creation.
60
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
61
- */
62
- export declare function text<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey> & {
63
- readonly unique?: boolean;
64
- readonly maxLength?: number;
65
- }): TextFieldDefinition<TRequired, TSectionKey>;
66
- /**
67
- * Defines a multi-line text field.
68
- *
69
- * @param props - Long-text field metadata and presentation properties.
70
- * @returns Immutable long-text field definition.
71
- * @typeParam TRequired - Whether the field is required during record creation.
72
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
73
- */
74
- export declare function longText<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey> & {
75
- readonly maxLength?: number;
76
- }): LongTextFieldDefinition<TRequired, TSectionKey>;
77
- /**
78
- * Defines an email-address field.
79
- *
80
- * @param props - Email-field metadata and presentation properties.
81
- * @returns Immutable email field definition.
82
- * @typeParam TRequired - Whether the field is required during record creation.
83
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
84
- */
85
- export declare function email<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey> & {
86
- readonly unique?: boolean;
87
- }): EmailFieldDefinition<TRequired, TSectionKey>;
88
- /**
89
- * Defines a URL field.
90
- *
91
- * @param props - URL-field metadata and presentation properties.
92
- * @returns Immutable URL field definition.
93
- * @typeParam TRequired - Whether the field is required during record creation.
94
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
95
- */
96
- export declare function url<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey>): UrlFieldDefinition<TRequired, TSectionKey>;
97
- /**
98
- * Defines a phone-number field.
99
- *
100
- * @param props - Phone-field metadata and presentation properties.
101
- * @returns Immutable phone field definition.
102
- * @typeParam TRequired - Whether the field is required during record creation.
103
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
104
- */
105
- export declare function phone<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey>): PhoneFieldDefinition<TRequired, TSectionKey>;
106
- /**
107
- * Defines a numeric field.
108
- *
109
- * @param props - Number-field metadata and presentation properties.
110
- * @returns Immutable number field definition.
111
- * @typeParam TRequired - Whether the field is required during record creation.
112
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
113
- */
114
- export declare function number<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & NumericProps<TRequired, TSectionKey> & {
115
- readonly unique?: boolean;
116
- }): NumberFieldDefinition<TRequired, TSectionKey>;
117
- /**
118
- * Defines a currency field.
119
- *
120
- * @param props - Currency-field metadata and presentation properties.
121
- * @returns Immutable currency field definition.
122
- * @typeParam TRequired - Whether the field is required during record creation.
123
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
124
- */
125
- export declare function currency<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & NumericProps<TRequired, TSectionKey> & {
126
- readonly currency?: string;
127
- }): CurrencyFieldDefinition<TRequired, TSectionKey>;
128
- /**
129
- * Defines a percentage field.
130
- *
131
- * @param props - Percentage-field metadata and presentation properties.
132
- * @returns Immutable percentage field definition.
133
- * @typeParam TRequired - Whether the field is required during record creation.
134
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
135
- */
136
- export declare function percentage<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey>): PercentageFieldDefinition<TRequired, TSectionKey>;
137
- /**
138
- * Defines a date-only field.
139
- *
140
- * @param props - Date-field metadata and presentation properties.
141
- * @returns Immutable date field definition.
142
- * @typeParam TRequired - Whether the field is required during record creation.
143
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
144
- */
145
- export declare function date<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey>): DateFieldDefinition<TRequired, TSectionKey>;
146
- /**
147
- * Defines a date-time field.
148
- *
149
- * @param props - Datetime-field metadata and presentation properties.
150
- * @returns Immutable datetime field definition.
151
- * @typeParam TRequired - Whether the field is required during record creation.
152
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
153
- */
154
- export declare function datetime<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey>): DatetimeFieldDefinition<TRequired, TSectionKey>;
155
- /**
156
- * Defines a time-of-day field.
157
- *
158
- * @param props - Time-field metadata and presentation properties.
159
- * @returns Immutable time field definition.
160
- * @typeParam TRequired - Whether the field is required during record creation.
161
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
162
- */
163
- export declare function time<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey>): TimeFieldDefinition<TRequired, TSectionKey>;
164
- /**
165
- * Defines a multi-select choice field.
166
- *
167
- * @param props - Multi-select field metadata and presentation properties.
168
- * @returns Immutable multi-select field definition.
169
- * @typeParam TRequired - Whether the field is required during record creation.
170
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
171
- */
172
- export declare function select<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & ChoiceProps<TRequired, TSectionKey>): SelectFieldDefinition<TRequired, TSectionKey>;
173
- /**
174
- * Defines a single-select radio field.
175
- *
176
- * @param props - Radio-field metadata and presentation properties.
177
- * @returns Immutable radio field definition.
178
- * @typeParam TRequired - Whether the field is required during record creation.
179
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
180
- */
181
- export declare function radio<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & ChoiceProps<TRequired, TSectionKey>): RadioFieldDefinition<TRequired, TSectionKey>;
182
- /**
183
- * Defines a boolean field.
184
- *
185
- * @param props - Boolean-field metadata and presentation properties.
186
- * @returns Immutable boolean field definition.
187
- * @typeParam TRequired - Whether the field is required during record creation.
188
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
189
- */
190
- export declare function boolean<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey>): BooleanFieldDefinition<TRequired, TSectionKey>;
191
- /**
192
- * Defines a file attachment field.
193
- *
194
- * @param props - File-field metadata and presentation properties.
195
- * @returns Immutable file field definition.
196
- * @typeParam TRequired - Whether the field is required during record creation.
197
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
198
- */
199
- export declare function file<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey> & {
200
- readonly allowedType: 'images' | 'documents' | 'any';
201
- }): FileFieldDefinition<TRequired, TSectionKey>;
202
- /**
203
- * Defines a many-to-one lookup field.
204
- *
205
- * @param target - Target object or native model referenced by the lookup.
206
- * @param props - Lookup-field metadata and presentation properties.
207
- * @returns Immutable lookup field definition.
208
- * @typeParam TTarget - Target object or native model referenced by the lookup.
209
- * @typeParam TRequired - Whether the lookup is required during record creation.
210
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
211
- */
212
- export declare function lookup<TTarget extends LookupTarget, TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(target: TTarget, props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey> & {
213
- readonly relatedDataLabel?: string;
214
- readonly lookupFilterRqlCondition?: string;
215
- }): LookupFieldDefinition<TTarget, TRequired, TSectionKey>;
216
- /**
217
- * Defines a parent-child relationship field.
218
- *
219
- * @param target - Parent object definition referenced by the relationship.
220
- * @param props - Parent-child field metadata and presentation properties.
221
- * @returns Immutable parent-child field definition.
222
- * @typeParam TTarget - Parent object definition referenced by the relationship.
223
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
224
- */
225
- export declare function parentChild<TTarget extends Pick<AnyCustomObjectDefinition, 'name' | 'apiName'>, TSectionKey extends string | undefined = string | undefined>(target: TTarget, props: CommonFieldProps<TSectionKey> & {
226
- readonly relatedDataLabel?: string;
227
- readonly parentChildType?: 'PRIMARY' | 'SECONDARY';
228
- readonly enableParentOwnerInheritance?: boolean;
229
- readonly section?: TSectionKey;
230
- }): ParentChildFieldDefinition<CustomObjectIdentity<TTarget['name']>, TSectionKey>;
231
- /** Public helper surface for read-only formula fields. */
232
- export interface FormulaHelpers {
233
- /**
234
- * Defines a text-valued formula field.
235
- *
236
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
237
- */
238
- text<TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & {
239
- readonly formula: string;
240
- readonly maxLength: number;
241
- }): FormulaFieldDefinition<'formula-text', string, TSectionKey>;
242
- /**
243
- * Defines a numeric formula field.
244
- *
245
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
246
- */
247
- number<TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & {
248
- readonly formula: string;
249
- }): FormulaFieldDefinition<'formula-number', number, TSectionKey>;
250
- /**
251
- * Defines a boolean formula field.
252
- *
253
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
254
- */
255
- boolean<TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & {
256
- readonly formula: string;
257
- }): FormulaFieldDefinition<'formula-boolean', boolean, TSectionKey>;
258
- /**
259
- * Defines a currency-valued formula field.
260
- *
261
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
262
- */
263
- currency<TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & {
264
- readonly formula: string;
265
- }): FormulaFieldDefinition<'formula-currency', number, TSectionKey>;
266
- /**
267
- * Defines a percentage-valued formula field.
268
- *
269
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
270
- */
271
- percentage<TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & {
272
- readonly formula: string;
273
- }): FormulaFieldDefinition<'formula-percentage', number, TSectionKey>;
274
- /**
275
- * Defines a date-valued formula field.
276
- *
277
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
278
- */
279
- date<TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & {
280
- readonly formula: string;
281
- }): FormulaFieldDefinition<'formula-date', string, TSectionKey>;
282
- /**
283
- * Defines a URL-valued formula field.
284
- *
285
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
286
- */
287
- url<TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & {
288
- readonly formula: string;
289
- }): FormulaFieldDefinition<'formula-url', string, TSectionKey>;
290
- }
291
- /** Typed helpers for read-only formula fields. */
292
- export declare const formula: FormulaHelpers;
293
- /**
294
- * Immutable helper for authoring section maps in reusable fragments.
295
- *
296
- * @param definitions - Section definitions to freeze and preserve as-is.
297
- * @returns Frozen section-definition map retaining the caller's key/value types.
298
- * @typeParam TSections - Concrete section map to preserve in the returned value.
299
- */
300
- export declare function sections<TSections extends Readonly<Record<string, SectionDefinition>>>(definitions: TSections): TSections;
301
- export {};
302
- //# sourceMappingURL=fields.d.mts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"fields.d.mts","sourceRoot":"","sources":["../../../src/core/platform/custom-objects/fields.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,uCAAuC,EACvC,iCAAiC,EACjC,8BAA8B,EAC9B,wBAAwB,IAAI,4BAA4B,EACzD,qDAAiD;AAClD,OAAO,KAAK,EACV,yBAAyB,EAEzB,sBAAsB,EACtB,uBAAuB,EACvB,oBAAoB,EACpB,mBAAmB,EACnB,uBAAuB,EACvB,oBAAoB,EACpB,mBAAmB,EACnB,sBAAsB,EAGtB,uBAAuB,EACvB,qBAAqB,EACrB,YAAY,EACZ,iBAAiB,EACjB,qBAAqB,EACrB,0BAA0B,EAC1B,yBAAyB,EACzB,oBAAoB,EACpB,oBAAoB,EACpB,iBAAiB,EACjB,qBAAqB,EAErB,mBAAmB,EACnB,mBAAmB,EACnB,kBAAkB,EACnB,oBAAgB;AAEjB;;;;;GAKG;AACH,UAAU,gBAAgB,CAAC,SAAS,SAAS,OAAO,EAAE,WAAW,SAAS,MAAM,GAAG,SAAS;IAC1F,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC;CAChC;AAED;;;;;GAKG;AACH,UAAU,WAAW,CAAC,SAAS,SAAS,OAAO,EAAE,WAAW,SAAS,MAAM,GAAG,SAAS,CACrF,SAAQ,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC;IAChD,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;CACrC;AAED;;;;;GAKG;AACH,UAAU,YAAY,CAAC,SAAS,SAAS,OAAO,EAAE,WAAW,SAAS,MAAM,GAAG,SAAS,CACtF,SAAQ,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC;IAChD,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;CACjC;AAED;;;;GAIG;AACH,UAAU,gBAAgB,CAAC,WAAW,SAAS,MAAM,GAAG,SAAS;IAC/D,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC;IAC/B,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC;IACjC,QAAQ,CAAC,qBAAqB,CAAC,EAAE,iCAAiC,CAAC;IACnE,QAAQ,CAAC,sBAAsB,CAAC,EAAE,uCAAuC,CAAC;IAC1E,QAAQ,CAAC,aAAa,CAAC,EAAE,8BAA8B,CAAC;IACxD,QAAQ,CAAC,WAAW,CAAC,EAAE,4BAA4B,CAAC;CACrD;AAkCD;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,QAAQ,SAAS,MAAM,EAAE,OAAO,EAAE,QAAQ,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAEnG;AAED;;;;;;;GAOG;AACH,wBAAgB,IAAI,CAClB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAClC,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG;IAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,GACtG,mBAAmB,CAAC,SAAS,EAAE,WAAW,CAAC,CAE7C;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CACtB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAClC,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG;IAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,GAC3E,uBAAuB,CAAC,SAAS,EAAE,WAAW,CAAC,CAOjD;AAED;;;;;;;GAOG;AACH,wBAAgB,KAAK,CACnB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAClC,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG;IAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAA;CAAE,GACzE,oBAAoB,CAAC,SAAS,EAAE,WAAW,CAAC,CAO9C;AAED;;;;;;;GAOG;AACH,wBAAgB,GAAG,CACjB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAC9E,kBAAkB,CAAC,SAAS,EAAE,WAAW,CAAC,CAE5C;AAED;;;;;;;GAOG;AACH,wBAAgB,KAAK,CACnB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAC9E,oBAAoB,CAAC,SAAS,EAAE,WAAW,CAAC,CAO9C;AAED;;;;;;;GAOG;AACH,wBAAgB,MAAM,CACpB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,YAAY,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG;IAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAA;CAAE,GAC1G,qBAAqB,CAAC,SAAS,EAAE,WAAW,CAAC,CAO/C;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CACtB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAClC,YAAY,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG;IAAE,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,GACtE,uBAAuB,CAAC,SAAS,EAAE,WAAW,CAAC,CAOjD;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CACxB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAC9E,yBAAyB,CAAC,SAAS,EAAE,WAAW,CAAC,CAOnD;AAED;;;;;;;GAOG;AACH,wBAAgB,IAAI,CAClB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAC9E,mBAAmB,CAAC,SAAS,EAAE,WAAW,CAAC,CAE7C;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CACtB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAC9E,uBAAuB,CAAC,SAAS,EAAE,WAAW,CAAC,CAOjD;AAED;;;;;;;GAOG;AACH,wBAAgB,IAAI,CAClB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAC9E,mBAAmB,CAAC,SAAS,EAAE,WAAW,CAAC,CAE7C;AAED;;;;;;;GAOG;AACH,wBAAgB,MAAM,CACpB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,WAAW,CAAC,SAAS,EAAE,WAAW,CAAC,GACzE,qBAAqB,CAAC,SAAS,EAAE,WAAW,CAAC,CAO/C;AAED;;;;;;;GAOG;AACH,wBAAgB,KAAK,CACnB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,WAAW,CAAC,SAAS,EAAE,WAAW,CAAC,GACzE,oBAAoB,CAAC,SAAS,EAAE,WAAW,CAAC,CAO9C;AAED;;;;;;;GAOG;AACH,wBAAgB,OAAO,CACrB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAC9E,sBAAsB,CAAC,SAAS,EAAE,WAAW,CAAC,CAOhD;AAED;;;;;;;GAOG;AACH,wBAAgB,IAAI,CAClB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAClC,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG;IAAE,QAAQ,CAAC,WAAW,EAAE,QAAQ,GAAG,WAAW,GAAG,KAAK,CAAA;CAAE,GACpG,mBAAmB,CAAC,SAAS,EAAE,WAAW,CAAC,CAE7C;AAED;;;;;;;;;GASG;AACH,wBAAgB,MAAM,CACpB,OAAO,SAAS,YAAY,EAC5B,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,MAAM,EAAE,OAAO,EACf,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAClC,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG;IACzC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,wBAAwB,CAAC,EAAE,MAAM,CAAC;CAC5C,GACF,qBAAqB,CAAC,OAAO,EAAE,SAAS,EAAE,WAAW,CAAC,CASxD;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CACzB,OAAO,SAAS,IAAI,CAAC,yBAAyB,EAAE,MAAM,GAAG,SAAS,CAAC,EACnE,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,MAAM,EAAE,OAAO,EACf,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG;IACrC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,eAAe,CAAC,EAAE,SAAS,GAAG,WAAW,CAAC;IACnD,QAAQ,CAAC,4BAA4B,CAAC,EAAE,OAAO,CAAC;IAChD,QAAQ,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC;CAChC,GACA,0BAA0B,CAAC,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,WAAW,CAAC,CAShF;AA+BD,0DAA0D;AAC1D,MAAM,WAAW,cAAc;IAC7B;;;;OAIG;IACH,IAAI,CAAC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAC9D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG;QAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;KAAE,GAC9F,sBAAsB,CAAC,cAAc,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAE/D;;;;OAIG;IACH,MAAM,CAAC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAChE,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG;QAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAClE,sBAAsB,CAAC,gBAAgB,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAEjE;;;;OAIG;IACH,OAAO,CAAC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EACjE,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG;QAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAClE,sBAAsB,CAAC,iBAAiB,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IAEnE;;;;OAIG;IACH,QAAQ,CAAC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAClE,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG;QAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAClE,sBAAsB,CAAC,kBAAkB,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAEnE;;;;OAIG;IACH,UAAU,CAAC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EACpE,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG;QAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAClE,sBAAsB,CAAC,oBAAoB,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAErE;;;;OAIG;IACH,IAAI,CAAC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAC9D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG;QAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAClE,sBAAsB,CAAC,cAAc,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAE/D;;;;OAIG;IACH,GAAG,CAAC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAC7D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG;QAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAClE,sBAAsB,CAAC,aAAa,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;CAC/D;AAED,kDAAkD;AAClD,eAAO,MAAM,OAAO,EAAE,cA0CpB,CAAC;AAEH;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,SAAS,SAAS,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC,EACpF,WAAW,EAAE,SAAS,GACrB,SAAS,CAEX"}
@@ -1,302 +0,0 @@
1
- import type { CustomObjectFieldDerivedAggregatedField, CustomObjectFieldFormulaAttrMetas, CustomObjectFieldRqlDefinition, CustomObjectFieldSection as RestCustomObjectFieldSection } from "../../../resources/custom-objects/fields.js";
2
- import type { AnyCustomObjectDefinition, BooleanFieldDefinition, CurrencyFieldDefinition, CustomObjectIdentity, DateFieldDefinition, DatetimeFieldDefinition, EmailFieldDefinition, FileFieldDefinition, FormulaFieldDefinition, LongTextFieldDefinition, LookupFieldDefinition, LookupTarget, NativeModelTarget, NumberFieldDefinition, ParentChildFieldDefinition, PercentageFieldDefinition, PhoneFieldDefinition, RadioFieldDefinition, SectionDefinition, SelectFieldDefinition, TextFieldDefinition, TimeFieldDefinition, UrlFieldDefinition } from "./types.js";
3
- /**
4
- * Internal helper for field factories that expose `required` and `section`.
5
- *
6
- * @typeParam TRequired - Literal boolean carried through to derived input types.
7
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
8
- */
9
- interface BooleanLikeProps<TRequired extends boolean, TSectionKey extends string | undefined> {
10
- readonly required?: TRequired;
11
- readonly section?: TSectionKey;
12
- }
13
- /**
14
- * Internal helper for choice-based field factories.
15
- *
16
- * @typeParam TRequired - Literal boolean carried through to derived input types.
17
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
18
- */
19
- interface ChoiceProps<TRequired extends boolean, TSectionKey extends string | undefined> extends BooleanLikeProps<TRequired, TSectionKey> {
20
- readonly options: readonly string[];
21
- }
22
- /**
23
- * Internal helper for numeric field factories that support decimal-place metadata.
24
- *
25
- * @typeParam TRequired - Literal boolean carried through to derived input types.
26
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
27
- */
28
- interface NumericProps<TRequired extends boolean, TSectionKey extends string | undefined> extends BooleanLikeProps<TRequired, TSectionKey> {
29
- readonly decimalPlaces?: number;
30
- }
31
- /**
32
- * Internal presentation properties shared by every field factory.
33
- *
34
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
35
- */
36
- interface CommonFieldProps<TSectionKey extends string | undefined> {
37
- readonly displayName: string;
38
- readonly description: string;
39
- readonly section?: TSectionKey;
40
- readonly enableHistory?: boolean;
41
- readonly formulaAttributeMetas?: CustomObjectFieldFormulaAttrMetas;
42
- readonly derivedAggregatedField?: CustomObjectFieldDerivedAggregatedField;
43
- readonly rqlDefinition?: CustomObjectFieldRqlDefinition;
44
- readonly restSection?: RestCustomObjectFieldSection;
45
- }
46
- /**
47
- * Declares a native Rippling model target for lookup fields.
48
- *
49
- * @param apiName - Native model API name, for example `'Employee'`.
50
- * @returns Immutable native-model target descriptor for lookup fields.
51
- * @typeParam TApiName - Native model api name, for example `'Employee'`.
52
- */
53
- export declare function nativeModel<TApiName extends string>(apiName: TApiName): NativeModelTarget<TApiName>;
54
- /**
55
- * Defines a single-line text field.
56
- *
57
- * @param props - Text-field metadata and presentation properties.
58
- * @returns Immutable text field definition.
59
- * @typeParam TRequired - Whether the field is required during record creation.
60
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
61
- */
62
- export declare function text<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey> & {
63
- readonly unique?: boolean;
64
- readonly maxLength?: number;
65
- }): TextFieldDefinition<TRequired, TSectionKey>;
66
- /**
67
- * Defines a multi-line text field.
68
- *
69
- * @param props - Long-text field metadata and presentation properties.
70
- * @returns Immutable long-text field definition.
71
- * @typeParam TRequired - Whether the field is required during record creation.
72
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
73
- */
74
- export declare function longText<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey> & {
75
- readonly maxLength?: number;
76
- }): LongTextFieldDefinition<TRequired, TSectionKey>;
77
- /**
78
- * Defines an email-address field.
79
- *
80
- * @param props - Email-field metadata and presentation properties.
81
- * @returns Immutable email field definition.
82
- * @typeParam TRequired - Whether the field is required during record creation.
83
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
84
- */
85
- export declare function email<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey> & {
86
- readonly unique?: boolean;
87
- }): EmailFieldDefinition<TRequired, TSectionKey>;
88
- /**
89
- * Defines a URL field.
90
- *
91
- * @param props - URL-field metadata and presentation properties.
92
- * @returns Immutable URL field definition.
93
- * @typeParam TRequired - Whether the field is required during record creation.
94
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
95
- */
96
- export declare function url<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey>): UrlFieldDefinition<TRequired, TSectionKey>;
97
- /**
98
- * Defines a phone-number field.
99
- *
100
- * @param props - Phone-field metadata and presentation properties.
101
- * @returns Immutable phone field definition.
102
- * @typeParam TRequired - Whether the field is required during record creation.
103
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
104
- */
105
- export declare function phone<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey>): PhoneFieldDefinition<TRequired, TSectionKey>;
106
- /**
107
- * Defines a numeric field.
108
- *
109
- * @param props - Number-field metadata and presentation properties.
110
- * @returns Immutable number field definition.
111
- * @typeParam TRequired - Whether the field is required during record creation.
112
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
113
- */
114
- export declare function number<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & NumericProps<TRequired, TSectionKey> & {
115
- readonly unique?: boolean;
116
- }): NumberFieldDefinition<TRequired, TSectionKey>;
117
- /**
118
- * Defines a currency field.
119
- *
120
- * @param props - Currency-field metadata and presentation properties.
121
- * @returns Immutable currency field definition.
122
- * @typeParam TRequired - Whether the field is required during record creation.
123
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
124
- */
125
- export declare function currency<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & NumericProps<TRequired, TSectionKey> & {
126
- readonly currency?: string;
127
- }): CurrencyFieldDefinition<TRequired, TSectionKey>;
128
- /**
129
- * Defines a percentage field.
130
- *
131
- * @param props - Percentage-field metadata and presentation properties.
132
- * @returns Immutable percentage field definition.
133
- * @typeParam TRequired - Whether the field is required during record creation.
134
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
135
- */
136
- export declare function percentage<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey>): PercentageFieldDefinition<TRequired, TSectionKey>;
137
- /**
138
- * Defines a date-only field.
139
- *
140
- * @param props - Date-field metadata and presentation properties.
141
- * @returns Immutable date field definition.
142
- * @typeParam TRequired - Whether the field is required during record creation.
143
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
144
- */
145
- export declare function date<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey>): DateFieldDefinition<TRequired, TSectionKey>;
146
- /**
147
- * Defines a date-time field.
148
- *
149
- * @param props - Datetime-field metadata and presentation properties.
150
- * @returns Immutable datetime field definition.
151
- * @typeParam TRequired - Whether the field is required during record creation.
152
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
153
- */
154
- export declare function datetime<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey>): DatetimeFieldDefinition<TRequired, TSectionKey>;
155
- /**
156
- * Defines a time-of-day field.
157
- *
158
- * @param props - Time-field metadata and presentation properties.
159
- * @returns Immutable time field definition.
160
- * @typeParam TRequired - Whether the field is required during record creation.
161
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
162
- */
163
- export declare function time<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey>): TimeFieldDefinition<TRequired, TSectionKey>;
164
- /**
165
- * Defines a multi-select choice field.
166
- *
167
- * @param props - Multi-select field metadata and presentation properties.
168
- * @returns Immutable multi-select field definition.
169
- * @typeParam TRequired - Whether the field is required during record creation.
170
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
171
- */
172
- export declare function select<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & ChoiceProps<TRequired, TSectionKey>): SelectFieldDefinition<TRequired, TSectionKey>;
173
- /**
174
- * Defines a single-select radio field.
175
- *
176
- * @param props - Radio-field metadata and presentation properties.
177
- * @returns Immutable radio field definition.
178
- * @typeParam TRequired - Whether the field is required during record creation.
179
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
180
- */
181
- export declare function radio<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & ChoiceProps<TRequired, TSectionKey>): RadioFieldDefinition<TRequired, TSectionKey>;
182
- /**
183
- * Defines a boolean field.
184
- *
185
- * @param props - Boolean-field metadata and presentation properties.
186
- * @returns Immutable boolean field definition.
187
- * @typeParam TRequired - Whether the field is required during record creation.
188
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
189
- */
190
- export declare function boolean<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey>): BooleanFieldDefinition<TRequired, TSectionKey>;
191
- /**
192
- * Defines a file attachment field.
193
- *
194
- * @param props - File-field metadata and presentation properties.
195
- * @returns Immutable file field definition.
196
- * @typeParam TRequired - Whether the field is required during record creation.
197
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
198
- */
199
- export declare function file<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey> & {
200
- readonly allowedType: 'images' | 'documents' | 'any';
201
- }): FileFieldDefinition<TRequired, TSectionKey>;
202
- /**
203
- * Defines a many-to-one lookup field.
204
- *
205
- * @param target - Target object or native model referenced by the lookup.
206
- * @param props - Lookup-field metadata and presentation properties.
207
- * @returns Immutable lookup field definition.
208
- * @typeParam TTarget - Target object or native model referenced by the lookup.
209
- * @typeParam TRequired - Whether the lookup is required during record creation.
210
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
211
- */
212
- export declare function lookup<TTarget extends LookupTarget, TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(target: TTarget, props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey> & {
213
- readonly relatedDataLabel?: string;
214
- readonly lookupFilterRqlCondition?: string;
215
- }): LookupFieldDefinition<TTarget, TRequired, TSectionKey>;
216
- /**
217
- * Defines a parent-child relationship field.
218
- *
219
- * @param target - Parent object definition referenced by the relationship.
220
- * @param props - Parent-child field metadata and presentation properties.
221
- * @returns Immutable parent-child field definition.
222
- * @typeParam TTarget - Parent object definition referenced by the relationship.
223
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
224
- */
225
- export declare function parentChild<TTarget extends Pick<AnyCustomObjectDefinition, 'name' | 'apiName'>, TSectionKey extends string | undefined = string | undefined>(target: TTarget, props: CommonFieldProps<TSectionKey> & {
226
- readonly relatedDataLabel?: string;
227
- readonly parentChildType?: 'PRIMARY' | 'SECONDARY';
228
- readonly enableParentOwnerInheritance?: boolean;
229
- readonly section?: TSectionKey;
230
- }): ParentChildFieldDefinition<CustomObjectIdentity<TTarget['name']>, TSectionKey>;
231
- /** Public helper surface for read-only formula fields. */
232
- export interface FormulaHelpers {
233
- /**
234
- * Defines a text-valued formula field.
235
- *
236
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
237
- */
238
- text<TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & {
239
- readonly formula: string;
240
- readonly maxLength: number;
241
- }): FormulaFieldDefinition<'formula-text', string, TSectionKey>;
242
- /**
243
- * Defines a numeric formula field.
244
- *
245
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
246
- */
247
- number<TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & {
248
- readonly formula: string;
249
- }): FormulaFieldDefinition<'formula-number', number, TSectionKey>;
250
- /**
251
- * Defines a boolean formula field.
252
- *
253
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
254
- */
255
- boolean<TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & {
256
- readonly formula: string;
257
- }): FormulaFieldDefinition<'formula-boolean', boolean, TSectionKey>;
258
- /**
259
- * Defines a currency-valued formula field.
260
- *
261
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
262
- */
263
- currency<TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & {
264
- readonly formula: string;
265
- }): FormulaFieldDefinition<'formula-currency', number, TSectionKey>;
266
- /**
267
- * Defines a percentage-valued formula field.
268
- *
269
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
270
- */
271
- percentage<TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & {
272
- readonly formula: string;
273
- }): FormulaFieldDefinition<'formula-percentage', number, TSectionKey>;
274
- /**
275
- * Defines a date-valued formula field.
276
- *
277
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
278
- */
279
- date<TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & {
280
- readonly formula: string;
281
- }): FormulaFieldDefinition<'formula-date', string, TSectionKey>;
282
- /**
283
- * Defines a URL-valued formula field.
284
- *
285
- * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
286
- */
287
- url<TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & {
288
- readonly formula: string;
289
- }): FormulaFieldDefinition<'formula-url', string, TSectionKey>;
290
- }
291
- /** Typed helpers for read-only formula fields. */
292
- export declare const formula: FormulaHelpers;
293
- /**
294
- * Immutable helper for authoring section maps in reusable fragments.
295
- *
296
- * @param definitions - Section definitions to freeze and preserve as-is.
297
- * @returns Frozen section-definition map retaining the caller's key/value types.
298
- * @typeParam TSections - Concrete section map to preserve in the returned value.
299
- */
300
- export declare function sections<TSections extends Readonly<Record<string, SectionDefinition>>>(definitions: TSections): TSections;
301
- export {};
302
- //# sourceMappingURL=fields.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"fields.d.ts","sourceRoot":"","sources":["../../../src/core/platform/custom-objects/fields.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,uCAAuC,EACvC,iCAAiC,EACjC,8BAA8B,EAC9B,wBAAwB,IAAI,4BAA4B,EACzD,oDAAiD;AAClD,OAAO,KAAK,EACV,yBAAyB,EAEzB,sBAAsB,EACtB,uBAAuB,EACvB,oBAAoB,EACpB,mBAAmB,EACnB,uBAAuB,EACvB,oBAAoB,EACpB,mBAAmB,EACnB,sBAAsB,EAGtB,uBAAuB,EACvB,qBAAqB,EACrB,YAAY,EACZ,iBAAiB,EACjB,qBAAqB,EACrB,0BAA0B,EAC1B,yBAAyB,EACzB,oBAAoB,EACpB,oBAAoB,EACpB,iBAAiB,EACjB,qBAAqB,EAErB,mBAAmB,EACnB,mBAAmB,EACnB,kBAAkB,EACnB,mBAAgB;AAEjB;;;;;GAKG;AACH,UAAU,gBAAgB,CAAC,SAAS,SAAS,OAAO,EAAE,WAAW,SAAS,MAAM,GAAG,SAAS;IAC1F,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC;CAChC;AAED;;;;;GAKG;AACH,UAAU,WAAW,CAAC,SAAS,SAAS,OAAO,EAAE,WAAW,SAAS,MAAM,GAAG,SAAS,CACrF,SAAQ,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC;IAChD,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;CACrC;AAED;;;;;GAKG;AACH,UAAU,YAAY,CAAC,SAAS,SAAS,OAAO,EAAE,WAAW,SAAS,MAAM,GAAG,SAAS,CACtF,SAAQ,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC;IAChD,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;CACjC;AAED;;;;GAIG;AACH,UAAU,gBAAgB,CAAC,WAAW,SAAS,MAAM,GAAG,SAAS;IAC/D,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC;IAC/B,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC;IACjC,QAAQ,CAAC,qBAAqB,CAAC,EAAE,iCAAiC,CAAC;IACnE,QAAQ,CAAC,sBAAsB,CAAC,EAAE,uCAAuC,CAAC;IAC1E,QAAQ,CAAC,aAAa,CAAC,EAAE,8BAA8B,CAAC;IACxD,QAAQ,CAAC,WAAW,CAAC,EAAE,4BAA4B,CAAC;CACrD;AAkCD;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,QAAQ,SAAS,MAAM,EAAE,OAAO,EAAE,QAAQ,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAEnG;AAED;;;;;;;GAOG;AACH,wBAAgB,IAAI,CAClB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAClC,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG;IAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,GACtG,mBAAmB,CAAC,SAAS,EAAE,WAAW,CAAC,CAE7C;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CACtB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAClC,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG;IAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,GAC3E,uBAAuB,CAAC,SAAS,EAAE,WAAW,CAAC,CAOjD;AAED;;;;;;;GAOG;AACH,wBAAgB,KAAK,CACnB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAClC,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG;IAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAA;CAAE,GACzE,oBAAoB,CAAC,SAAS,EAAE,WAAW,CAAC,CAO9C;AAED;;;;;;;GAOG;AACH,wBAAgB,GAAG,CACjB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAC9E,kBAAkB,CAAC,SAAS,EAAE,WAAW,CAAC,CAE5C;AAED;;;;;;;GAOG;AACH,wBAAgB,KAAK,CACnB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAC9E,oBAAoB,CAAC,SAAS,EAAE,WAAW,CAAC,CAO9C;AAED;;;;;;;GAOG;AACH,wBAAgB,MAAM,CACpB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,YAAY,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG;IAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAA;CAAE,GAC1G,qBAAqB,CAAC,SAAS,EAAE,WAAW,CAAC,CAO/C;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CACtB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAClC,YAAY,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG;IAAE,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,GACtE,uBAAuB,CAAC,SAAS,EAAE,WAAW,CAAC,CAOjD;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CACxB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAC9E,yBAAyB,CAAC,SAAS,EAAE,WAAW,CAAC,CAOnD;AAED;;;;;;;GAOG;AACH,wBAAgB,IAAI,CAClB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAC9E,mBAAmB,CAAC,SAAS,EAAE,WAAW,CAAC,CAE7C;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CACtB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAC9E,uBAAuB,CAAC,SAAS,EAAE,WAAW,CAAC,CAOjD;AAED;;;;;;;GAOG;AACH,wBAAgB,IAAI,CAClB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAC9E,mBAAmB,CAAC,SAAS,EAAE,WAAW,CAAC,CAE7C;AAED;;;;;;;GAOG;AACH,wBAAgB,MAAM,CACpB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,WAAW,CAAC,SAAS,EAAE,WAAW,CAAC,GACzE,qBAAqB,CAAC,SAAS,EAAE,WAAW,CAAC,CAO/C;AAED;;;;;;;GAOG;AACH,wBAAgB,KAAK,CACnB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,WAAW,CAAC,SAAS,EAAE,WAAW,CAAC,GACzE,oBAAoB,CAAC,SAAS,EAAE,WAAW,CAAC,CAO9C;AAED;;;;;;;GAOG;AACH,wBAAgB,OAAO,CACrB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAC9E,sBAAsB,CAAC,SAAS,EAAE,WAAW,CAAC,CAOhD;AAED;;;;;;;GAOG;AACH,wBAAgB,IAAI,CAClB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAClC,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG;IAAE,QAAQ,CAAC,WAAW,EAAE,QAAQ,GAAG,WAAW,GAAG,KAAK,CAAA;CAAE,GACpG,mBAAmB,CAAC,SAAS,EAAE,WAAW,CAAC,CAE7C;AAED;;;;;;;;;GASG;AACH,wBAAgB,MAAM,CACpB,OAAO,SAAS,YAAY,EAC5B,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,MAAM,EAAE,OAAO,EACf,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAClC,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG;IACzC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,wBAAwB,CAAC,EAAE,MAAM,CAAC;CAC5C,GACF,qBAAqB,CAAC,OAAO,EAAE,SAAS,EAAE,WAAW,CAAC,CASxD;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CACzB,OAAO,SAAS,IAAI,CAAC,yBAAyB,EAAE,MAAM,GAAG,SAAS,CAAC,EACnE,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,MAAM,EAAE,OAAO,EACf,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG;IACrC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,eAAe,CAAC,EAAE,SAAS,GAAG,WAAW,CAAC;IACnD,QAAQ,CAAC,4BAA4B,CAAC,EAAE,OAAO,CAAC;IAChD,QAAQ,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC;CAChC,GACA,0BAA0B,CAAC,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,WAAW,CAAC,CAShF;AA+BD,0DAA0D;AAC1D,MAAM,WAAW,cAAc;IAC7B;;;;OAIG;IACH,IAAI,CAAC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAC9D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG;QAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;KAAE,GAC9F,sBAAsB,CAAC,cAAc,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAE/D;;;;OAIG;IACH,MAAM,CAAC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAChE,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG;QAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAClE,sBAAsB,CAAC,gBAAgB,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAEjE;;;;OAIG;IACH,OAAO,CAAC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EACjE,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG;QAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAClE,sBAAsB,CAAC,iBAAiB,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IAEnE;;;;OAIG;IACH,QAAQ,CAAC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAClE,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG;QAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAClE,sBAAsB,CAAC,kBAAkB,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAEnE;;;;OAIG;IACH,UAAU,CAAC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EACpE,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG;QAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAClE,sBAAsB,CAAC,oBAAoB,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAErE;;;;OAIG;IACH,IAAI,CAAC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAC9D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG;QAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAClE,sBAAsB,CAAC,cAAc,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAE/D;;;;OAIG;IACH,GAAG,CAAC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAC7D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG;QAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAClE,sBAAsB,CAAC,aAAa,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;CAC/D;AAED,kDAAkD;AAClD,eAAO,MAAM,OAAO,EAAE,cA0CpB,CAAC;AAEH;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,SAAS,SAAS,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC,EACpF,WAAW,EAAE,SAAS,GACrB,SAAS,CAEX"}